Convert group_run_stats to use bytes instead of KiB/KB
[fio.git] / init.c
... / ...
CommitLineData
1/*
2 * This file contains job initialization and setup functions.
3 */
4#include <stdio.h>
5#include <stdlib.h>
6#include <unistd.h>
7#include <fcntl.h>
8#include <ctype.h>
9#include <string.h>
10#include <errno.h>
11#include <sys/ipc.h>
12#include <sys/types.h>
13#include <sys/stat.h>
14
15#include "fio.h"
16#ifndef FIO_NO_HAVE_SHM_H
17#include <sys/shm.h>
18#endif
19
20#include "parse.h"
21#include "smalloc.h"
22#include "filehash.h"
23#include "verify.h"
24#include "profile.h"
25#include "server.h"
26#include "idletime.h"
27#include "filelock.h"
28#include "steadystate.h"
29
30#include "oslib/getopt.h"
31#include "oslib/strcasestr.h"
32
33#include "crc/test.h"
34
35const char fio_version_string[] = FIO_VERSION;
36
37#define FIO_RANDSEED (0xb1899bedUL)
38
39static char **ini_file;
40static int max_jobs = FIO_MAX_JOBS;
41static int dump_cmdline;
42static long long def_timeout;
43static int parse_only;
44
45static struct thread_data def_thread;
46struct thread_data *threads = NULL;
47static char **job_sections;
48static int nr_job_sections;
49
50int exitall_on_terminate = 0;
51int output_format = FIO_OUTPUT_NORMAL;
52int eta_print = FIO_ETA_AUTO;
53int eta_new_line = 0;
54FILE *f_out = NULL;
55FILE *f_err = NULL;
56char *exec_profile = NULL;
57int warnings_fatal = 0;
58int terse_version = 3;
59int is_backend = 0;
60int nr_clients = 0;
61int log_syslog = 0;
62
63int write_bw_log = 0;
64int read_only = 0;
65int status_interval = 0;
66
67char *trigger_file = NULL;
68long long trigger_timeout = 0;
69char *trigger_cmd = NULL;
70char *trigger_remote_cmd = NULL;
71
72char *aux_path = NULL;
73
74static int prev_group_jobs;
75
76unsigned long fio_debug = 0;
77unsigned int fio_debug_jobno = -1;
78unsigned int *fio_debug_jobp = NULL;
79
80static char cmd_optstr[256];
81static int did_arg;
82
83#define FIO_CLIENT_FLAG (1 << 16)
84
85/*
86 * Command line options. These will contain the above, plus a few
87 * extra that only pertain to fio itself and not jobs.
88 */
89static struct option l_opts[FIO_NR_OPTIONS] = {
90 {
91 .name = (char *) "output",
92 .has_arg = required_argument,
93 .val = 'o' | FIO_CLIENT_FLAG,
94 },
95 {
96 .name = (char *) "timeout",
97 .has_arg = required_argument,
98 .val = 't' | FIO_CLIENT_FLAG,
99 },
100 {
101 .name = (char *) "latency-log",
102 .has_arg = required_argument,
103 .val = 'l' | FIO_CLIENT_FLAG,
104 },
105 {
106 .name = (char *) "bandwidth-log",
107 .has_arg = no_argument,
108 .val = 'b' | FIO_CLIENT_FLAG,
109 },
110 {
111 .name = (char *) "minimal",
112 .has_arg = no_argument,
113 .val = 'm' | FIO_CLIENT_FLAG,
114 },
115 {
116 .name = (char *) "output-format",
117 .has_arg = required_argument,
118 .val = 'F' | FIO_CLIENT_FLAG,
119 },
120 {
121 .name = (char *) "append-terse",
122 .has_arg = optional_argument,
123 .val = 'f',
124 },
125 {
126 .name = (char *) "version",
127 .has_arg = no_argument,
128 .val = 'v' | FIO_CLIENT_FLAG,
129 },
130 {
131 .name = (char *) "help",
132 .has_arg = no_argument,
133 .val = 'h' | FIO_CLIENT_FLAG,
134 },
135 {
136 .name = (char *) "cmdhelp",
137 .has_arg = optional_argument,
138 .val = 'c' | FIO_CLIENT_FLAG,
139 },
140 {
141 .name = (char *) "enghelp",
142 .has_arg = optional_argument,
143 .val = 'i' | FIO_CLIENT_FLAG,
144 },
145 {
146 .name = (char *) "showcmd",
147 .has_arg = no_argument,
148 .val = 's' | FIO_CLIENT_FLAG,
149 },
150 {
151 .name = (char *) "readonly",
152 .has_arg = no_argument,
153 .val = 'r' | FIO_CLIENT_FLAG,
154 },
155 {
156 .name = (char *) "eta",
157 .has_arg = required_argument,
158 .val = 'e' | FIO_CLIENT_FLAG,
159 },
160 {
161 .name = (char *) "eta-newline",
162 .has_arg = required_argument,
163 .val = 'E' | FIO_CLIENT_FLAG,
164 },
165 {
166 .name = (char *) "debug",
167 .has_arg = required_argument,
168 .val = 'd' | FIO_CLIENT_FLAG,
169 },
170 {
171 .name = (char *) "parse-only",
172 .has_arg = no_argument,
173 .val = 'P' | FIO_CLIENT_FLAG,
174 },
175 {
176 .name = (char *) "section",
177 .has_arg = required_argument,
178 .val = 'x' | FIO_CLIENT_FLAG,
179 },
180#ifdef CONFIG_ZLIB
181 {
182 .name = (char *) "inflate-log",
183 .has_arg = required_argument,
184 .val = 'X' | FIO_CLIENT_FLAG,
185 },
186#endif
187 {
188 .name = (char *) "alloc-size",
189 .has_arg = required_argument,
190 .val = 'a' | FIO_CLIENT_FLAG,
191 },
192 {
193 .name = (char *) "profile",
194 .has_arg = required_argument,
195 .val = 'p' | FIO_CLIENT_FLAG,
196 },
197 {
198 .name = (char *) "warnings-fatal",
199 .has_arg = no_argument,
200 .val = 'w' | FIO_CLIENT_FLAG,
201 },
202 {
203 .name = (char *) "max-jobs",
204 .has_arg = required_argument,
205 .val = 'j' | FIO_CLIENT_FLAG,
206 },
207 {
208 .name = (char *) "terse-version",
209 .has_arg = required_argument,
210 .val = 'V' | FIO_CLIENT_FLAG,
211 },
212 {
213 .name = (char *) "server",
214 .has_arg = optional_argument,
215 .val = 'S',
216 },
217 { .name = (char *) "daemonize",
218 .has_arg = required_argument,
219 .val = 'D',
220 },
221 {
222 .name = (char *) "client",
223 .has_arg = required_argument,
224 .val = 'C',
225 },
226 {
227 .name = (char *) "remote-config",
228 .has_arg = required_argument,
229 .val = 'R',
230 },
231 {
232 .name = (char *) "cpuclock-test",
233 .has_arg = no_argument,
234 .val = 'T',
235 },
236 {
237 .name = (char *) "crctest",
238 .has_arg = optional_argument,
239 .val = 'G',
240 },
241 {
242 .name = (char *) "idle-prof",
243 .has_arg = required_argument,
244 .val = 'I',
245 },
246 {
247 .name = (char *) "status-interval",
248 .has_arg = required_argument,
249 .val = 'L',
250 },
251 {
252 .name = (char *) "trigger-file",
253 .has_arg = required_argument,
254 .val = 'W',
255 },
256 {
257 .name = (char *) "trigger-timeout",
258 .has_arg = required_argument,
259 .val = 'B',
260 },
261 {
262 .name = (char *) "trigger",
263 .has_arg = required_argument,
264 .val = 'H',
265 },
266 {
267 .name = (char *) "trigger-remote",
268 .has_arg = required_argument,
269 .val = 'J',
270 },
271 {
272 .name = (char *) "aux-path",
273 .has_arg = required_argument,
274 .val = 'K',
275 },
276 {
277 .name = NULL,
278 },
279};
280
281void free_threads_shm(void)
282{
283 if (threads) {
284 void *tp = threads;
285#ifndef CONFIG_NO_SHM
286 struct shmid_ds sbuf;
287
288 threads = NULL;
289 shmdt(tp);
290 shmctl(shm_id, IPC_RMID, &sbuf);
291 shm_id = -1;
292#else
293 threads = NULL;
294 free(tp);
295#endif
296 }
297}
298
299static void free_shm(void)
300{
301 if (threads) {
302 flow_exit();
303 fio_debug_jobp = NULL;
304 free_threads_shm();
305 }
306
307 free(trigger_file);
308 free(trigger_cmd);
309 free(trigger_remote_cmd);
310 trigger_file = trigger_cmd = trigger_remote_cmd = NULL;
311
312 options_free(fio_options, &def_thread.o);
313 fio_filelock_exit();
314 file_hash_exit();
315 scleanup();
316}
317
318/*
319 * The thread area is shared between the main process and the job
320 * threads/processes. So setup a shared memory segment that will hold
321 * all the job info. We use the end of the region for keeping track of
322 * open files across jobs, for file sharing.
323 */
324static int setup_thread_area(void)
325{
326 if (threads)
327 return 0;
328
329 /*
330 * 1024 is too much on some machines, scale max_jobs if
331 * we get a failure that looks like too large a shm segment
332 */
333 do {
334 size_t size = max_jobs * sizeof(struct thread_data);
335
336 size += sizeof(unsigned int);
337
338#ifndef CONFIG_NO_SHM
339 shm_id = shmget(0, size, IPC_CREAT | 0600);
340 if (shm_id != -1)
341 break;
342 if (errno != EINVAL && errno != ENOMEM && errno != ENOSPC) {
343 perror("shmget");
344 break;
345 }
346#else
347 threads = malloc(size);
348 if (threads)
349 break;
350#endif
351
352 max_jobs >>= 1;
353 } while (max_jobs);
354
355#ifndef CONFIG_NO_SHM
356 if (shm_id == -1)
357 return 1;
358
359 threads = shmat(shm_id, NULL, 0);
360 if (threads == (void *) -1) {
361 perror("shmat");
362 return 1;
363 }
364#endif
365
366 memset(threads, 0, max_jobs * sizeof(struct thread_data));
367 fio_debug_jobp = (void *) threads + max_jobs * sizeof(struct thread_data);
368 *fio_debug_jobp = -1;
369
370 flow_init();
371
372 return 0;
373}
374
375static void set_cmd_options(struct thread_data *td)
376{
377 struct thread_options *o = &td->o;
378
379 if (!o->timeout)
380 o->timeout = def_timeout;
381}
382
383static void dump_print_option(struct print_option *p)
384{
385 const char *delim;
386
387 if (!strcmp("description", p->name))
388 delim = "\"";
389 else
390 delim = "";
391
392 log_info("--%s%s", p->name, p->value ? "" : " ");
393 if (p->value)
394 log_info("=%s%s%s ", delim, p->value, delim);
395}
396
397static void dump_opt_list(struct thread_data *td)
398{
399 struct flist_head *entry;
400 struct print_option *p;
401
402 if (flist_empty(&td->opt_list))
403 return;
404
405 flist_for_each(entry, &td->opt_list) {
406 p = flist_entry(entry, struct print_option, list);
407 dump_print_option(p);
408 }
409}
410
411static void fio_dump_options_free(struct thread_data *td)
412{
413 while (!flist_empty(&td->opt_list)) {
414 struct print_option *p;
415
416 p = flist_first_entry(&td->opt_list, struct print_option, list);
417 flist_del_init(&p->list);
418 free(p->name);
419 free(p->value);
420 free(p);
421 }
422}
423
424static void copy_opt_list(struct thread_data *dst, struct thread_data *src)
425{
426 struct flist_head *entry;
427
428 if (flist_empty(&src->opt_list))
429 return;
430
431 flist_for_each(entry, &src->opt_list) {
432 struct print_option *srcp, *dstp;
433
434 srcp = flist_entry(entry, struct print_option, list);
435 dstp = malloc(sizeof(*dstp));
436 dstp->name = strdup(srcp->name);
437 if (srcp->value)
438 dstp->value = strdup(srcp->value);
439 else
440 dstp->value = NULL;
441 flist_add_tail(&dstp->list, &dst->opt_list);
442 }
443}
444
445/*
446 * Return a free job structure.
447 */
448static struct thread_data *get_new_job(int global, struct thread_data *parent,
449 int preserve_eo, const char *jobname)
450{
451 struct thread_data *td;
452
453 if (global) {
454 set_cmd_options(&def_thread);
455 return &def_thread;
456 }
457 if (setup_thread_area()) {
458 log_err("error: failed to setup shm segment\n");
459 return NULL;
460 }
461 if (thread_number >= max_jobs) {
462 log_err("error: maximum number of jobs (%d) reached.\n",
463 max_jobs);
464 return NULL;
465 }
466
467 td = &threads[thread_number++];
468 *td = *parent;
469
470 INIT_FLIST_HEAD(&td->opt_list);
471 if (parent != &def_thread)
472 copy_opt_list(td, parent);
473
474 td->io_ops = NULL;
475 if (!preserve_eo)
476 td->eo = NULL;
477
478 td->o.uid = td->o.gid = -1U;
479
480 dup_files(td, parent);
481 fio_options_mem_dupe(td);
482
483 profile_add_hooks(td);
484
485 td->thread_number = thread_number;
486 td->subjob_number = 0;
487
488 if (jobname)
489 td->o.name = strdup(jobname);
490
491 if (!parent->o.group_reporting || parent == &def_thread)
492 stat_number++;
493
494 set_cmd_options(td);
495 return td;
496}
497
498static void put_job(struct thread_data *td)
499{
500 if (td == &def_thread)
501 return;
502
503 profile_td_exit(td);
504 flow_exit_job(td);
505
506 if (td->error)
507 log_info("fio: %s\n", td->verror);
508
509 fio_options_free(td);
510 fio_dump_options_free(td);
511 if (td->io_ops)
512 free_ioengine(td);
513
514 if (td->o.name)
515 free(td->o.name);
516
517 memset(&threads[td->thread_number - 1], 0, sizeof(*td));
518 thread_number--;
519}
520
521static int __setup_rate(struct thread_data *td, enum fio_ddir ddir)
522{
523 unsigned int bs = td->o.min_bs[ddir];
524
525 assert(ddir_rw(ddir));
526
527 if (td->o.rate[ddir])
528 td->rate_bps[ddir] = td->o.rate[ddir];
529 else
530 td->rate_bps[ddir] = (uint64_t) td->o.rate_iops[ddir] * bs;
531
532 if (!td->rate_bps[ddir]) {
533 log_err("rate lower than supported\n");
534 return -1;
535 }
536
537 td->rate_next_io_time[ddir] = 0;
538 td->rate_io_issue_bytes[ddir] = 0;
539 td->last_usec = 0;
540 return 0;
541}
542
543static int setup_rate(struct thread_data *td)
544{
545 int ret = 0;
546
547 if (td->o.rate[DDIR_READ] || td->o.rate_iops[DDIR_READ])
548 ret = __setup_rate(td, DDIR_READ);
549 if (td->o.rate[DDIR_WRITE] || td->o.rate_iops[DDIR_WRITE])
550 ret |= __setup_rate(td, DDIR_WRITE);
551 if (td->o.rate[DDIR_TRIM] || td->o.rate_iops[DDIR_TRIM])
552 ret |= __setup_rate(td, DDIR_TRIM);
553
554 return ret;
555}
556
557static int fixed_block_size(struct thread_options *o)
558{
559 return o->min_bs[DDIR_READ] == o->max_bs[DDIR_READ] &&
560 o->min_bs[DDIR_WRITE] == o->max_bs[DDIR_WRITE] &&
561 o->min_bs[DDIR_TRIM] == o->max_bs[DDIR_TRIM] &&
562 o->min_bs[DDIR_READ] == o->min_bs[DDIR_WRITE] &&
563 o->min_bs[DDIR_READ] == o->min_bs[DDIR_TRIM];
564}
565
566
567static unsigned long long get_rand_start_delay(struct thread_data *td)
568{
569 unsigned long long delayrange;
570 uint64_t frand_max;
571 unsigned long r;
572
573 delayrange = td->o.start_delay_high - td->o.start_delay;
574
575 frand_max = rand_max(&td->delay_state);
576 r = __rand(&td->delay_state);
577 delayrange = (unsigned long long) ((double) delayrange * (r / (frand_max + 1.0)));
578
579 delayrange += td->o.start_delay;
580 return delayrange;
581}
582
583/*
584 * Lazy way of fixing up options that depend on each other. We could also
585 * define option callback handlers, but this is easier.
586 */
587static int fixup_options(struct thread_data *td)
588{
589 struct thread_options *o = &td->o;
590 int ret = 0;
591
592#ifndef FIO_HAVE_PSHARED_MUTEX
593 if (!o->use_thread) {
594 log_info("fio: this platform does not support process shared"
595 " mutexes, forcing use of threads. Use the 'thread'"
596 " option to get rid of this warning.\n");
597 o->use_thread = 1;
598 ret = warnings_fatal;
599 }
600#endif
601
602 if (o->write_iolog_file && o->read_iolog_file) {
603 log_err("fio: read iolog overrides write_iolog\n");
604 free(o->write_iolog_file);
605 o->write_iolog_file = NULL;
606 ret = warnings_fatal;
607 }
608
609 /*
610 * only really works with 1 file
611 */
612 if (o->zone_size && o->open_files > 1)
613 o->zone_size = 0;
614
615 /*
616 * If zone_range isn't specified, backward compatibility dictates it
617 * should be made equal to zone_size.
618 */
619 if (o->zone_size && !o->zone_range)
620 o->zone_range = o->zone_size;
621
622 /*
623 * Reads can do overwrites, we always need to pre-create the file
624 */
625 if (td_read(td) || td_rw(td))
626 o->overwrite = 1;
627
628 if (!o->min_bs[DDIR_READ])
629 o->min_bs[DDIR_READ] = o->bs[DDIR_READ];
630 if (!o->max_bs[DDIR_READ])
631 o->max_bs[DDIR_READ] = o->bs[DDIR_READ];
632 if (!o->min_bs[DDIR_WRITE])
633 o->min_bs[DDIR_WRITE] = o->bs[DDIR_WRITE];
634 if (!o->max_bs[DDIR_WRITE])
635 o->max_bs[DDIR_WRITE] = o->bs[DDIR_WRITE];
636 if (!o->min_bs[DDIR_TRIM])
637 o->min_bs[DDIR_TRIM] = o->bs[DDIR_TRIM];
638 if (!o->max_bs[DDIR_TRIM])
639 o->max_bs[DDIR_TRIM] = o->bs[DDIR_TRIM];
640
641 o->rw_min_bs = min(o->min_bs[DDIR_READ], o->min_bs[DDIR_WRITE]);
642 o->rw_min_bs = min(o->min_bs[DDIR_TRIM], o->rw_min_bs);
643
644 /*
645 * For random IO, allow blockalign offset other than min_bs.
646 */
647 if (!o->ba[DDIR_READ] || !td_random(td))
648 o->ba[DDIR_READ] = o->min_bs[DDIR_READ];
649 if (!o->ba[DDIR_WRITE] || !td_random(td))
650 o->ba[DDIR_WRITE] = o->min_bs[DDIR_WRITE];
651 if (!o->ba[DDIR_TRIM] || !td_random(td))
652 o->ba[DDIR_TRIM] = o->min_bs[DDIR_TRIM];
653
654 if ((o->ba[DDIR_READ] != o->min_bs[DDIR_READ] ||
655 o->ba[DDIR_WRITE] != o->min_bs[DDIR_WRITE] ||
656 o->ba[DDIR_TRIM] != o->min_bs[DDIR_TRIM]) &&
657 !o->norandommap) {
658 log_err("fio: Any use of blockalign= turns off randommap\n");
659 o->norandommap = 1;
660 ret = warnings_fatal;
661 }
662
663 if (!o->file_size_high)
664 o->file_size_high = o->file_size_low;
665
666 if (o->start_delay_high)
667 o->start_delay = get_rand_start_delay(td);
668
669 if (o->norandommap && o->verify != VERIFY_NONE
670 && !fixed_block_size(o)) {
671 log_err("fio: norandommap given for variable block sizes, "
672 "verify limited\n");
673 ret = warnings_fatal;
674 }
675 if (o->bs_unaligned && (o->odirect || td_ioengine_flagged(td, FIO_RAWIO)))
676 log_err("fio: bs_unaligned may not work with raw io\n");
677
678 /*
679 * thinktime_spin must be less than thinktime
680 */
681 if (o->thinktime_spin > o->thinktime)
682 o->thinktime_spin = o->thinktime;
683
684 /*
685 * The low water mark cannot be bigger than the iodepth
686 */
687 if (o->iodepth_low > o->iodepth || !o->iodepth_low)
688 o->iodepth_low = o->iodepth;
689
690 /*
691 * If batch number isn't set, default to the same as iodepth
692 */
693 if (o->iodepth_batch > o->iodepth || !o->iodepth_batch)
694 o->iodepth_batch = o->iodepth;
695
696 /*
697 * If max batch complete number isn't set or set incorrectly,
698 * default to the same as iodepth_batch_complete_min
699 */
700 if (o->iodepth_batch_complete_min > o->iodepth_batch_complete_max)
701 o->iodepth_batch_complete_max = o->iodepth_batch_complete_min;
702
703 if (o->nr_files > td->files_index)
704 o->nr_files = td->files_index;
705
706 if (o->open_files > o->nr_files || !o->open_files)
707 o->open_files = o->nr_files;
708
709 if (((o->rate[DDIR_READ] + o->rate[DDIR_WRITE] + o->rate[DDIR_TRIM]) &&
710 (o->rate_iops[DDIR_READ] + o->rate_iops[DDIR_WRITE] + o->rate_iops[DDIR_TRIM])) ||
711 ((o->ratemin[DDIR_READ] + o->ratemin[DDIR_WRITE] + o->ratemin[DDIR_TRIM]) &&
712 (o->rate_iops_min[DDIR_READ] + o->rate_iops_min[DDIR_WRITE] + o->rate_iops_min[DDIR_TRIM]))) {
713 log_err("fio: rate and rate_iops are mutually exclusive\n");
714 ret = 1;
715 }
716 if ((o->rate[DDIR_READ] && (o->rate[DDIR_READ] < o->ratemin[DDIR_READ])) ||
717 (o->rate[DDIR_WRITE] && (o->rate[DDIR_WRITE] < o->ratemin[DDIR_WRITE])) ||
718 (o->rate[DDIR_TRIM] && (o->rate[DDIR_TRIM] < o->ratemin[DDIR_TRIM])) ||
719 (o->rate_iops[DDIR_READ] && (o->rate_iops[DDIR_READ] < o->rate_iops_min[DDIR_READ])) ||
720 (o->rate_iops[DDIR_WRITE] && (o->rate_iops[DDIR_WRITE] < o->rate_iops_min[DDIR_WRITE])) ||
721 (o->rate_iops[DDIR_TRIM] && (o->rate_iops[DDIR_TRIM] < o->rate_iops_min[DDIR_TRIM]))) {
722 log_err("fio: minimum rate exceeds rate\n");
723 ret = 1;
724 }
725
726 if (!o->timeout && o->time_based) {
727 log_err("fio: time_based requires a runtime/timeout setting\n");
728 o->time_based = 0;
729 ret = warnings_fatal;
730 }
731
732 if (o->fill_device && !o->size)
733 o->size = -1ULL;
734
735 if (o->verify != VERIFY_NONE) {
736 if (td_write(td) && o->do_verify && o->numjobs > 1) {
737 log_info("Multiple writers may overwrite blocks that "
738 "belong to other jobs. This can cause "
739 "verification failures.\n");
740 ret = warnings_fatal;
741 }
742
743 if (!fio_option_is_set(o, refill_buffers))
744 o->refill_buffers = 1;
745
746 if (o->max_bs[DDIR_WRITE] != o->min_bs[DDIR_WRITE] &&
747 !o->verify_interval)
748 o->verify_interval = o->min_bs[DDIR_WRITE];
749
750 /*
751 * Verify interval must be smaller or equal to the
752 * write size.
753 */
754 if (o->verify_interval > o->min_bs[DDIR_WRITE])
755 o->verify_interval = o->min_bs[DDIR_WRITE];
756 else if (td_read(td) && o->verify_interval > o->min_bs[DDIR_READ])
757 o->verify_interval = o->min_bs[DDIR_READ];
758 }
759
760 if (o->pre_read) {
761 o->invalidate_cache = 0;
762 if (td_ioengine_flagged(td, FIO_PIPEIO)) {
763 log_info("fio: cannot pre-read files with an IO engine"
764 " that isn't seekable. Pre-read disabled.\n");
765 ret = warnings_fatal;
766 }
767 }
768
769 if (!o->unit_base) {
770 if (td_ioengine_flagged(td, FIO_BIT_BASED))
771 o->unit_base = 1;
772 else
773 o->unit_base = 8;
774 }
775
776#ifndef CONFIG_FDATASYNC
777 if (o->fdatasync_blocks) {
778 log_info("fio: this platform does not support fdatasync()"
779 " falling back to using fsync(). Use the 'fsync'"
780 " option instead of 'fdatasync' to get rid of"
781 " this warning\n");
782 o->fsync_blocks = o->fdatasync_blocks;
783 o->fdatasync_blocks = 0;
784 ret = warnings_fatal;
785 }
786#endif
787
788#ifdef WIN32
789 /*
790 * Windows doesn't support O_DIRECT or O_SYNC with the _open interface,
791 * so fail if we're passed those flags
792 */
793 if (td_ioengine_flagged(td, FIO_SYNCIO) && (td->o.odirect || td->o.sync_io)) {
794 log_err("fio: Windows does not support direct or non-buffered io with"
795 " the synchronous ioengines. Use the 'windowsaio' ioengine"
796 " with 'direct=1' and 'iodepth=1' instead.\n");
797 ret = 1;
798 }
799#endif
800
801 /*
802 * For fully compressible data, just zero them at init time.
803 * It's faster than repeatedly filling it. For non-zero
804 * compression, we should have refill_buffers set. Set it, unless
805 * the job file already changed it.
806 */
807 if (o->compress_percentage) {
808 if (o->compress_percentage == 100) {
809 o->zero_buffers = 1;
810 o->compress_percentage = 0;
811 } else if (!fio_option_is_set(o, refill_buffers))
812 o->refill_buffers = 1;
813 }
814
815 /*
816 * Using a non-uniform random distribution excludes usage of
817 * a random map
818 */
819 if (td->o.random_distribution != FIO_RAND_DIST_RANDOM)
820 td->o.norandommap = 1;
821
822 /*
823 * If size is set but less than the min block size, complain
824 */
825 if (o->size && o->size < td_min_bs(td)) {
826 log_err("fio: size too small, must not be less than minimum block size: %llu < %u\n",
827 (unsigned long long) o->size, td_min_bs(td));
828 ret = 1;
829 }
830
831 /*
832 * O_ATOMIC implies O_DIRECT
833 */
834 if (td->o.oatomic)
835 td->o.odirect = 1;
836
837 /*
838 * If randseed is set, that overrides randrepeat
839 */
840 if (fio_option_is_set(&td->o, rand_seed))
841 td->o.rand_repeatable = 0;
842
843 if (td_ioengine_flagged(td, FIO_NOEXTEND) && td->o.file_append) {
844 log_err("fio: can't append/extent with IO engine %s\n", td->io_ops->name);
845 ret = 1;
846 }
847
848 if (fio_option_is_set(o, gtod_cpu)) {
849 fio_gtod_init();
850 fio_gtod_set_cpu(o->gtod_cpu);
851 fio_gtod_offload = 1;
852 }
853
854 td->loops = o->loops;
855 if (!td->loops)
856 td->loops = 1;
857
858 if (td->o.block_error_hist && td->o.nr_files != 1) {
859 log_err("fio: block error histogram only available "
860 "with a single file per job, but %d files "
861 "provided\n", td->o.nr_files);
862 ret = 1;
863 }
864
865 return ret;
866}
867
868/*
869 * This function leaks the buffer
870 */
871char *fio_uint_to_kmg(unsigned int val)
872{
873 char *buf = malloc(32);
874 char post[] = { 0, 'K', 'M', 'G', 'P', 'E', 0 };
875 char *p = post;
876
877 do {
878 if (val & 1023)
879 break;
880
881 val >>= 10;
882 p++;
883 } while (*p);
884
885 snprintf(buf, 32, "%u%c", val, *p);
886 return buf;
887}
888
889/* External engines are specified by "external:name.o") */
890static const char *get_engine_name(const char *str)
891{
892 char *p = strstr(str, ":");
893
894 if (!p)
895 return str;
896
897 p++;
898 strip_blank_front(&p);
899 strip_blank_end(p);
900 return p;
901}
902
903static void init_rand_file_service(struct thread_data *td)
904{
905 unsigned long nranges = td->o.nr_files << FIO_FSERVICE_SHIFT;
906 const unsigned int seed = td->rand_seeds[FIO_RAND_FILE_OFF];
907
908 if (td->o.file_service_type == FIO_FSERVICE_ZIPF) {
909 zipf_init(&td->next_file_zipf, nranges, td->zipf_theta, seed);
910 zipf_disable_hash(&td->next_file_zipf);
911 } else if (td->o.file_service_type == FIO_FSERVICE_PARETO) {
912 pareto_init(&td->next_file_zipf, nranges, td->pareto_h, seed);
913 zipf_disable_hash(&td->next_file_zipf);
914 } else if (td->o.file_service_type == FIO_FSERVICE_GAUSS) {
915 gauss_init(&td->next_file_gauss, nranges, td->gauss_dev, seed);
916 gauss_disable_hash(&td->next_file_gauss);
917 }
918}
919
920void td_fill_verify_state_seed(struct thread_data *td)
921{
922 bool use64;
923
924 if (td->o.random_generator == FIO_RAND_GEN_TAUSWORTHE64)
925 use64 = 1;
926 else
927 use64 = 0;
928
929 init_rand_seed(&td->verify_state, td->rand_seeds[FIO_RAND_VER_OFF],
930 use64);
931}
932
933static void td_fill_rand_seeds_internal(struct thread_data *td, bool use64)
934{
935 int i;
936
937 init_rand_seed(&td->bsrange_state, td->rand_seeds[FIO_RAND_BS_OFF], use64);
938 td_fill_verify_state_seed(td);
939 init_rand_seed(&td->rwmix_state, td->rand_seeds[FIO_RAND_MIX_OFF], false);
940
941 if (td->o.file_service_type == FIO_FSERVICE_RANDOM)
942 init_rand_seed(&td->next_file_state, td->rand_seeds[FIO_RAND_FILE_OFF], use64);
943 else if (td->o.file_service_type & __FIO_FSERVICE_NONUNIFORM)
944 init_rand_file_service(td);
945
946 init_rand_seed(&td->file_size_state, td->rand_seeds[FIO_RAND_FILE_SIZE_OFF], use64);
947 init_rand_seed(&td->trim_state, td->rand_seeds[FIO_RAND_TRIM_OFF], use64);
948 init_rand_seed(&td->delay_state, td->rand_seeds[FIO_RAND_START_DELAY], use64);
949 init_rand_seed(&td->poisson_state, td->rand_seeds[FIO_RAND_POISSON_OFF], 0);
950 init_rand_seed(&td->dedupe_state, td->rand_seeds[FIO_DEDUPE_OFF], false);
951 init_rand_seed(&td->zone_state, td->rand_seeds[FIO_RAND_ZONE_OFF], false);
952
953 if (!td_random(td))
954 return;
955
956 if (td->o.rand_repeatable)
957 td->rand_seeds[FIO_RAND_BLOCK_OFF] = FIO_RANDSEED * td->thread_number;
958
959 init_rand_seed(&td->random_state, td->rand_seeds[FIO_RAND_BLOCK_OFF], use64);
960
961 for (i = 0; i < DDIR_RWDIR_CNT; i++) {
962 struct frand_state *s = &td->seq_rand_state[i];
963
964 init_rand_seed(s, td->rand_seeds[FIO_RAND_SEQ_RAND_READ_OFF], false);
965 }
966}
967
968void td_fill_rand_seeds(struct thread_data *td)
969{
970 bool use64;
971
972 if (td->o.allrand_repeatable) {
973 unsigned int i;
974
975 for (i = 0; i < FIO_RAND_NR_OFFS; i++)
976 td->rand_seeds[i] = FIO_RANDSEED * td->thread_number
977 + i;
978 }
979
980 if (td->o.random_generator == FIO_RAND_GEN_TAUSWORTHE64)
981 use64 = 1;
982 else
983 use64 = 0;
984
985 td_fill_rand_seeds_internal(td, use64);
986
987 init_rand_seed(&td->buf_state, td->rand_seeds[FIO_RAND_BUF_OFF], use64);
988 frand_copy(&td->buf_state_prev, &td->buf_state);
989}
990
991/*
992 * Initializes the ioengine configured for a job, if it has not been done so
993 * already.
994 */
995int ioengine_load(struct thread_data *td)
996{
997 const char *engine;
998
999 /*
1000 * Engine has already been loaded.
1001 */
1002 if (td->io_ops)
1003 return 0;
1004 if (!td->o.ioengine) {
1005 log_err("fio: internal fault, no IO engine specified\n");
1006 return 1;
1007 }
1008
1009 engine = get_engine_name(td->o.ioengine);
1010 td->io_ops = load_ioengine(td, engine);
1011 if (!td->io_ops) {
1012 log_err("fio: failed to load engine %s\n", engine);
1013 return 1;
1014 }
1015
1016 if (td->io_ops->option_struct_size && td->io_ops->options) {
1017 /*
1018 * In cases where td->eo is set, clone it for a child thread.
1019 * This requires that the parent thread has the same ioengine,
1020 * but that requirement must be enforced by the code which
1021 * cloned the thread.
1022 */
1023 void *origeo = td->eo;
1024 /*
1025 * Otherwise use the default thread options.
1026 */
1027 if (!origeo && td != &def_thread && def_thread.eo &&
1028 def_thread.io_ops->options == td->io_ops->options)
1029 origeo = def_thread.eo;
1030
1031 options_init(td->io_ops->options);
1032 td->eo = malloc(td->io_ops->option_struct_size);
1033 /*
1034 * Use the default thread as an option template if this uses the
1035 * same options structure and there are non-default options
1036 * used.
1037 */
1038 if (origeo) {
1039 memcpy(td->eo, origeo, td->io_ops->option_struct_size);
1040 options_mem_dupe(td->eo, td->io_ops->options);
1041 } else {
1042 memset(td->eo, 0, td->io_ops->option_struct_size);
1043 fill_default_options(td->eo, td->io_ops->options);
1044 }
1045 *(struct thread_data **)td->eo = td;
1046 }
1047
1048 if (td->o.odirect)
1049 td->io_ops->flags |= FIO_RAWIO;
1050
1051 td_set_ioengine_flags(td);
1052 return 0;
1053}
1054
1055static void init_flags(struct thread_data *td)
1056{
1057 struct thread_options *o = &td->o;
1058
1059 if (o->verify_backlog)
1060 td->flags |= TD_F_VER_BACKLOG;
1061 if (o->trim_backlog)
1062 td->flags |= TD_F_TRIM_BACKLOG;
1063 if (o->read_iolog_file)
1064 td->flags |= TD_F_READ_IOLOG;
1065 if (o->refill_buffers)
1066 td->flags |= TD_F_REFILL_BUFFERS;
1067 /*
1068 * Always scramble buffers if asked to
1069 */
1070 if (o->scramble_buffers && fio_option_is_set(o, scramble_buffers))
1071 td->flags |= TD_F_SCRAMBLE_BUFFERS;
1072 /*
1073 * But also scramble buffers, unless we were explicitly asked
1074 * to zero them.
1075 */
1076 if (o->scramble_buffers && !(o->zero_buffers &&
1077 fio_option_is_set(o, zero_buffers)))
1078 td->flags |= TD_F_SCRAMBLE_BUFFERS;
1079 if (o->verify != VERIFY_NONE)
1080 td->flags |= TD_F_VER_NONE;
1081
1082 if (o->verify_async || o->io_submit_mode == IO_MODE_OFFLOAD)
1083 td->flags |= TD_F_NEED_LOCK;
1084}
1085
1086static int setup_random_seeds(struct thread_data *td)
1087{
1088 unsigned long seed;
1089 unsigned int i;
1090
1091 if (!td->o.rand_repeatable && !fio_option_is_set(&td->o, rand_seed))
1092 return init_random_state(td, td->rand_seeds, sizeof(td->rand_seeds));
1093
1094 seed = td->o.rand_seed;
1095 for (i = 0; i < 4; i++)
1096 seed *= 0x9e370001UL;
1097
1098 for (i = 0; i < FIO_RAND_NR_OFFS; i++) {
1099 td->rand_seeds[i] = seed * td->thread_number + i;
1100 seed *= 0x9e370001UL;
1101 }
1102
1103 td_fill_rand_seeds(td);
1104 return 0;
1105}
1106
1107enum {
1108 FPRE_NONE = 0,
1109 FPRE_JOBNAME,
1110 FPRE_JOBNUM,
1111 FPRE_FILENUM
1112};
1113
1114static struct fpre_keyword {
1115 const char *keyword;
1116 size_t strlen;
1117 int key;
1118} fpre_keywords[] = {
1119 { .keyword = "$jobname", .key = FPRE_JOBNAME, },
1120 { .keyword = "$jobnum", .key = FPRE_JOBNUM, },
1121 { .keyword = "$filenum", .key = FPRE_FILENUM, },
1122 { .keyword = NULL, },
1123 };
1124
1125static char *make_filename(char *buf, size_t buf_size,struct thread_options *o,
1126 const char *jobname, int jobnum, int filenum)
1127{
1128 struct fpre_keyword *f;
1129 char copy[PATH_MAX];
1130 size_t dst_left = PATH_MAX - 1;
1131
1132 if (!o->filename_format || !strlen(o->filename_format)) {
1133 sprintf(buf, "%s.%d.%d", jobname, jobnum, filenum);
1134 return NULL;
1135 }
1136
1137 for (f = &fpre_keywords[0]; f->keyword; f++)
1138 f->strlen = strlen(f->keyword);
1139
1140 buf[buf_size - 1] = '\0';
1141 strncpy(buf, o->filename_format, buf_size - 1);
1142
1143 memset(copy, 0, sizeof(copy));
1144 for (f = &fpre_keywords[0]; f->keyword; f++) {
1145 do {
1146 size_t pre_len, post_start = 0;
1147 char *str, *dst = copy;
1148
1149 str = strcasestr(buf, f->keyword);
1150 if (!str)
1151 break;
1152
1153 pre_len = str - buf;
1154 if (strlen(str) != f->strlen)
1155 post_start = pre_len + f->strlen;
1156
1157 if (pre_len) {
1158 strncpy(dst, buf, pre_len);
1159 dst += pre_len;
1160 dst_left -= pre_len;
1161 }
1162
1163 switch (f->key) {
1164 case FPRE_JOBNAME: {
1165 int ret;
1166
1167 ret = snprintf(dst, dst_left, "%s", jobname);
1168 if (ret < 0)
1169 break;
1170 else if (ret > dst_left) {
1171 log_err("fio: truncated filename\n");
1172 dst += dst_left;
1173 dst_left = 0;
1174 } else {
1175 dst += ret;
1176 dst_left -= ret;
1177 }
1178 break;
1179 }
1180 case FPRE_JOBNUM: {
1181 int ret;
1182
1183 ret = snprintf(dst, dst_left, "%d", jobnum);
1184 if (ret < 0)
1185 break;
1186 else if (ret > dst_left) {
1187 log_err("fio: truncated filename\n");
1188 dst += dst_left;
1189 dst_left = 0;
1190 } else {
1191 dst += ret;
1192 dst_left -= ret;
1193 }
1194 break;
1195 }
1196 case FPRE_FILENUM: {
1197 int ret;
1198
1199 ret = snprintf(dst, dst_left, "%d", filenum);
1200 if (ret < 0)
1201 break;
1202 else if (ret > dst_left) {
1203 log_err("fio: truncated filename\n");
1204 dst += dst_left;
1205 dst_left = 0;
1206 } else {
1207 dst += ret;
1208 dst_left -= ret;
1209 }
1210 break;
1211 }
1212 default:
1213 assert(0);
1214 break;
1215 }
1216
1217 if (post_start)
1218 strncpy(dst, buf + post_start, dst_left);
1219
1220 strncpy(buf, copy, buf_size - 1);
1221 } while (1);
1222 }
1223
1224 return buf;
1225}
1226
1227bool parse_dryrun(void)
1228{
1229 return dump_cmdline || parse_only;
1230}
1231
1232static void gen_log_name(char *name, size_t size, const char *logtype,
1233 const char *logname, unsigned int num,
1234 const char *suf, int per_job)
1235{
1236 if (per_job)
1237 snprintf(name, size, "%s_%s.%d.%s", logname, logtype, num, suf);
1238 else
1239 snprintf(name, size, "%s_%s.%s", logname, logtype, suf);
1240}
1241
1242static int check_waitees(char *waitee)
1243{
1244 struct thread_data *td;
1245 int i, ret = 0;
1246
1247 for_each_td(td, i) {
1248 if (td->subjob_number)
1249 continue;
1250
1251 ret += !strcmp(td->o.name, waitee);
1252 }
1253
1254 return ret;
1255}
1256
1257static bool wait_for_ok(const char *jobname, struct thread_options *o)
1258{
1259 int nw;
1260
1261 if (!o->wait_for)
1262 return true;
1263
1264 if (!strcmp(jobname, o->wait_for)) {
1265 log_err("%s: a job cannot wait for itself (wait_for=%s).\n",
1266 jobname, o->wait_for);
1267 return false;
1268 }
1269
1270 if (!(nw = check_waitees(o->wait_for))) {
1271 log_err("%s: waitee job %s unknown.\n", jobname, o->wait_for);
1272 return false;
1273 }
1274
1275 if (nw > 1) {
1276 log_err("%s: multiple waitees %s found,\n"
1277 "please avoid duplicates when using wait_for option.\n",
1278 jobname, o->wait_for);
1279 return false;
1280 }
1281
1282 return true;
1283}
1284
1285/*
1286 * Adds a job to the list of things todo. Sanitizes the various options
1287 * to make sure we don't have conflicts, and initializes various
1288 * members of td.
1289 */
1290static int add_job(struct thread_data *td, const char *jobname, int job_add_num,
1291 int recursed, int client_type)
1292{
1293 unsigned int i;
1294 char fname[PATH_MAX];
1295 int numjobs, file_alloced;
1296 struct thread_options *o = &td->o;
1297 char logname[PATH_MAX + 32];
1298
1299 /*
1300 * the def_thread is just for options, it's not a real job
1301 */
1302 if (td == &def_thread)
1303 return 0;
1304
1305 init_flags(td);
1306
1307 /*
1308 * if we are just dumping the output command line, don't add the job
1309 */
1310 if (parse_dryrun()) {
1311 put_job(td);
1312 return 0;
1313 }
1314
1315 td->client_type = client_type;
1316
1317 if (profile_td_init(td))
1318 goto err;
1319
1320 if (ioengine_load(td))
1321 goto err;
1322
1323 file_alloced = 0;
1324 if (!o->filename && !td->files_index && !o->read_iolog_file) {
1325 file_alloced = 1;
1326
1327 if (o->nr_files == 1 && exists_and_not_regfile(jobname))
1328 add_file(td, jobname, job_add_num, 0);
1329 else {
1330 for (i = 0; i < o->nr_files; i++)
1331 add_file(td, make_filename(fname, sizeof(fname), o, jobname, job_add_num, i), job_add_num, 0);
1332 }
1333 }
1334
1335 if (fixup_options(td))
1336 goto err;
1337
1338 /*
1339 * Belongs to fixup_options, but o->name is not necessarily set as yet
1340 */
1341 if (!wait_for_ok(jobname, o))
1342 goto err;
1343
1344 flow_init_job(td);
1345
1346 /*
1347 * IO engines only need this for option callbacks, and the address may
1348 * change in subprocesses.
1349 */
1350 if (td->eo)
1351 *(struct thread_data **)td->eo = NULL;
1352
1353 if (td_ioengine_flagged(td, FIO_DISKLESSIO)) {
1354 struct fio_file *f;
1355
1356 for_each_file(td, f, i)
1357 f->real_file_size = -1ULL;
1358 }
1359
1360 td->mutex = fio_mutex_init(FIO_MUTEX_LOCKED);
1361
1362 td->ts.clat_percentiles = o->clat_percentiles;
1363 td->ts.percentile_precision = o->percentile_precision;
1364 memcpy(td->ts.percentile_list, o->percentile_list, sizeof(o->percentile_list));
1365
1366 for (i = 0; i < DDIR_RWDIR_CNT; i++) {
1367 td->ts.clat_stat[i].min_val = ULONG_MAX;
1368 td->ts.slat_stat[i].min_val = ULONG_MAX;
1369 td->ts.lat_stat[i].min_val = ULONG_MAX;
1370 td->ts.bw_stat[i].min_val = ULONG_MAX;
1371 }
1372 td->ddir_seq_nr = o->ddir_seq_nr;
1373
1374 if ((o->stonewall || o->new_group) && prev_group_jobs) {
1375 prev_group_jobs = 0;
1376 groupid++;
1377 if (groupid == INT_MAX) {
1378 log_err("fio: too many groups defined\n");
1379 goto err;
1380 }
1381 }
1382
1383 td->groupid = groupid;
1384 prev_group_jobs++;
1385
1386 if (setup_random_seeds(td)) {
1387 td_verror(td, errno, "init_random_state");
1388 goto err;
1389 }
1390
1391 if (setup_rate(td))
1392 goto err;
1393
1394 if (o->write_lat_log) {
1395 struct log_params p = {
1396 .td = td,
1397 .avg_msec = o->log_avg_msec,
1398 .hist_msec = o->log_hist_msec,
1399 .hist_coarseness = o->log_hist_coarseness,
1400 .log_type = IO_LOG_TYPE_LAT,
1401 .log_offset = o->log_offset,
1402 .log_gz = o->log_gz,
1403 .log_gz_store = o->log_gz_store,
1404 };
1405 const char *pre = o->lat_log_file ? o->lat_log_file : o->name;
1406 const char *suf;
1407
1408 if (p.log_gz_store)
1409 suf = "log.fz";
1410 else
1411 suf = "log";
1412
1413 gen_log_name(logname, sizeof(logname), "lat", pre,
1414 td->thread_number, suf, o->per_job_logs);
1415 setup_log(&td->lat_log, &p, logname);
1416
1417 gen_log_name(logname, sizeof(logname), "slat", pre,
1418 td->thread_number, suf, o->per_job_logs);
1419 setup_log(&td->slat_log, &p, logname);
1420
1421 gen_log_name(logname, sizeof(logname), "clat", pre,
1422 td->thread_number, suf, o->per_job_logs);
1423 setup_log(&td->clat_log, &p, logname);
1424 }
1425
1426 if (o->write_hist_log) {
1427 struct log_params p = {
1428 .td = td,
1429 .avg_msec = o->log_avg_msec,
1430 .hist_msec = o->log_hist_msec,
1431 .hist_coarseness = o->log_hist_coarseness,
1432 .log_type = IO_LOG_TYPE_HIST,
1433 .log_offset = o->log_offset,
1434 .log_gz = o->log_gz,
1435 .log_gz_store = o->log_gz_store,
1436 };
1437 const char *pre = o->hist_log_file ? o->hist_log_file : o->name;
1438 const char *suf;
1439
1440#ifndef CONFIG_ZLIB
1441 if (td->client_type) {
1442 log_err("fio: --write_hist_log requires zlib in client/server mode\n");
1443 goto err;
1444 }
1445#endif
1446
1447 if (p.log_gz_store)
1448 suf = "log.fz";
1449 else
1450 suf = "log";
1451
1452 gen_log_name(logname, sizeof(logname), "clat_hist", pre,
1453 td->thread_number, suf, o->per_job_logs);
1454 setup_log(&td->clat_hist_log, &p, logname);
1455 }
1456
1457 if (o->write_bw_log) {
1458 struct log_params p = {
1459 .td = td,
1460 .avg_msec = o->log_avg_msec,
1461 .hist_msec = o->log_hist_msec,
1462 .hist_coarseness = o->log_hist_coarseness,
1463 .log_type = IO_LOG_TYPE_BW,
1464 .log_offset = o->log_offset,
1465 .log_gz = o->log_gz,
1466 .log_gz_store = o->log_gz_store,
1467 };
1468 const char *pre = o->bw_log_file ? o->bw_log_file : o->name;
1469 const char *suf;
1470
1471 if (fio_option_is_set(o, bw_avg_time))
1472 p.avg_msec = min(o->log_avg_msec, o->bw_avg_time);
1473 else
1474 o->bw_avg_time = p.avg_msec;
1475
1476 p.hist_msec = o->log_hist_msec;
1477 p.hist_coarseness = o->log_hist_coarseness;
1478
1479 if (p.log_gz_store)
1480 suf = "log.fz";
1481 else
1482 suf = "log";
1483
1484 gen_log_name(logname, sizeof(logname), "bw", pre,
1485 td->thread_number, suf, o->per_job_logs);
1486 setup_log(&td->bw_log, &p, logname);
1487 }
1488 if (o->write_iops_log) {
1489 struct log_params p = {
1490 .td = td,
1491 .avg_msec = o->log_avg_msec,
1492 .hist_msec = o->log_hist_msec,
1493 .hist_coarseness = o->log_hist_coarseness,
1494 .log_type = IO_LOG_TYPE_IOPS,
1495 .log_offset = o->log_offset,
1496 .log_gz = o->log_gz,
1497 .log_gz_store = o->log_gz_store,
1498 };
1499 const char *pre = o->iops_log_file ? o->iops_log_file : o->name;
1500 const char *suf;
1501
1502 if (fio_option_is_set(o, iops_avg_time))
1503 p.avg_msec = min(o->log_avg_msec, o->iops_avg_time);
1504 else
1505 o->iops_avg_time = p.avg_msec;
1506
1507 p.hist_msec = o->log_hist_msec;
1508 p.hist_coarseness = o->log_hist_coarseness;
1509
1510 if (p.log_gz_store)
1511 suf = "log.fz";
1512 else
1513 suf = "log";
1514
1515 gen_log_name(logname, sizeof(logname), "iops", pre,
1516 td->thread_number, suf, o->per_job_logs);
1517 setup_log(&td->iops_log, &p, logname);
1518 }
1519
1520 if (!o->name)
1521 o->name = strdup(jobname);
1522
1523 if (output_format & FIO_OUTPUT_NORMAL) {
1524 if (!job_add_num) {
1525 if (is_backend && !recursed)
1526 fio_server_send_add_job(td);
1527
1528 if (!td_ioengine_flagged(td, FIO_NOIO)) {
1529 char *c1, *c2, *c3, *c4;
1530 char *c5 = NULL, *c6 = NULL;
1531
1532 c1 = fio_uint_to_kmg(o->min_bs[DDIR_READ]);
1533 c2 = fio_uint_to_kmg(o->max_bs[DDIR_READ]);
1534 c3 = fio_uint_to_kmg(o->min_bs[DDIR_WRITE]);
1535 c4 = fio_uint_to_kmg(o->max_bs[DDIR_WRITE]);
1536
1537 if (!o->bs_is_seq_rand) {
1538 c5 = fio_uint_to_kmg(o->min_bs[DDIR_TRIM]);
1539 c6 = fio_uint_to_kmg(o->max_bs[DDIR_TRIM]);
1540 }
1541
1542 log_info("%s: (g=%d): rw=%s, ", td->o.name,
1543 td->groupid,
1544 ddir_str(o->td_ddir));
1545
1546 if (o->bs_is_seq_rand)
1547 log_info("bs(seq/rand)=%s-%s/%s-%s, ",
1548 c1, c2, c3, c4);
1549 else
1550 log_info("bs=%s-%s/%s-%s/%s-%s, ",
1551 c1, c2, c3, c4, c5, c6);
1552
1553 log_info("ioengine=%s, iodepth=%u\n",
1554 td->io_ops->name, o->iodepth);
1555
1556 free(c1);
1557 free(c2);
1558 free(c3);
1559 free(c4);
1560 free(c5);
1561 free(c6);
1562 }
1563 } else if (job_add_num == 1)
1564 log_info("...\n");
1565 }
1566
1567 if (td_steadystate_init(td))
1568 goto err;
1569
1570 /*
1571 * recurse add identical jobs, clear numjobs and stonewall options
1572 * as they don't apply to sub-jobs
1573 */
1574 numjobs = o->numjobs;
1575 while (--numjobs) {
1576 struct thread_data *td_new = get_new_job(0, td, 1, jobname);
1577
1578 if (!td_new)
1579 goto err;
1580
1581 td_new->o.numjobs = 1;
1582 td_new->o.stonewall = 0;
1583 td_new->o.new_group = 0;
1584 td_new->subjob_number = numjobs;
1585 td_new->o.ss_dur = o->ss_dur * 1000000l;
1586 td_new->o.ss_limit = o->ss_limit;
1587
1588 if (file_alloced) {
1589 if (td_new->files) {
1590 struct fio_file *f;
1591 for_each_file(td_new, f, i) {
1592 if (f->file_name)
1593 sfree(f->file_name);
1594 sfree(f);
1595 }
1596 free(td_new->files);
1597 td_new->files = NULL;
1598 }
1599 td_new->files_index = 0;
1600 td_new->files_size = 0;
1601 if (td_new->o.filename) {
1602 free(td_new->o.filename);
1603 td_new->o.filename = NULL;
1604 }
1605 }
1606
1607 if (add_job(td_new, jobname, numjobs, 1, client_type))
1608 goto err;
1609 }
1610
1611 return 0;
1612err:
1613 put_job(td);
1614 return -1;
1615}
1616
1617/*
1618 * Parse as if 'o' was a command line
1619 */
1620void add_job_opts(const char **o, int client_type)
1621{
1622 struct thread_data *td, *td_parent;
1623 int i, in_global = 1;
1624 char jobname[32];
1625
1626 i = 0;
1627 td_parent = td = NULL;
1628 while (o[i]) {
1629 if (!strncmp(o[i], "name", 4)) {
1630 in_global = 0;
1631 if (td)
1632 add_job(td, jobname, 0, 0, client_type);
1633 td = NULL;
1634 sprintf(jobname, "%s", o[i] + 5);
1635 }
1636 if (in_global && !td_parent)
1637 td_parent = get_new_job(1, &def_thread, 0, jobname);
1638 else if (!in_global && !td) {
1639 if (!td_parent)
1640 td_parent = &def_thread;
1641 td = get_new_job(0, td_parent, 0, jobname);
1642 }
1643 if (in_global)
1644 fio_options_parse(td_parent, (char **) &o[i], 1);
1645 else
1646 fio_options_parse(td, (char **) &o[i], 1);
1647 i++;
1648 }
1649
1650 if (td)
1651 add_job(td, jobname, 0, 0, client_type);
1652}
1653
1654static int skip_this_section(const char *name)
1655{
1656 int i;
1657
1658 if (!nr_job_sections)
1659 return 0;
1660 if (!strncmp(name, "global", 6))
1661 return 0;
1662
1663 for (i = 0; i < nr_job_sections; i++)
1664 if (!strcmp(job_sections[i], name))
1665 return 0;
1666
1667 return 1;
1668}
1669
1670static int is_empty_or_comment(char *line)
1671{
1672 unsigned int i;
1673
1674 for (i = 0; i < strlen(line); i++) {
1675 if (line[i] == ';')
1676 return 1;
1677 if (line[i] == '#')
1678 return 1;
1679 if (!isspace((int) line[i]) && !iscntrl((int) line[i]))
1680 return 0;
1681 }
1682
1683 return 1;
1684}
1685
1686/*
1687 * This is our [ini] type file parser.
1688 */
1689static int __parse_jobs_ini(struct thread_data *td,
1690 char *file, int is_buf, int stonewall_flag, int type,
1691 int nested, char *name, char ***popts, int *aopts, int *nopts)
1692{
1693 unsigned int global = 0;
1694 char *string;
1695 FILE *f;
1696 char *p;
1697 int ret = 0, stonewall;
1698 int first_sect = 1;
1699 int skip_fgets = 0;
1700 int inside_skip = 0;
1701 char **opts;
1702 int i, alloc_opts, num_opts;
1703
1704 dprint(FD_PARSE, "Parsing ini file %s\n", file);
1705 assert(td || !nested);
1706
1707 if (is_buf)
1708 f = NULL;
1709 else {
1710 if (!strcmp(file, "-"))
1711 f = stdin;
1712 else
1713 f = fopen(file, "r");
1714
1715 if (!f) {
1716 int __err = errno;
1717
1718 log_err("fio: unable to open '%s' job file\n", file);
1719 if (td)
1720 td_verror(td, __err, "job file open");
1721 return 1;
1722 }
1723 }
1724
1725 string = malloc(4096);
1726
1727 /*
1728 * it's really 256 + small bit, 280 should suffice
1729 */
1730 if (!nested) {
1731 name = malloc(280);
1732 memset(name, 0, 280);
1733 }
1734
1735 opts = NULL;
1736 if (nested && popts) {
1737 opts = *popts;
1738 alloc_opts = *aopts;
1739 num_opts = *nopts;
1740 }
1741
1742 if (!opts) {
1743 alloc_opts = 8;
1744 opts = malloc(sizeof(char *) * alloc_opts);
1745 num_opts = 0;
1746 }
1747
1748 stonewall = stonewall_flag;
1749 do {
1750 /*
1751 * if skip_fgets is set, we already have loaded a line we
1752 * haven't handled.
1753 */
1754 if (!skip_fgets) {
1755 if (is_buf)
1756 p = strsep(&file, "\n");
1757 else
1758 p = fgets(string, 4096, f);
1759 if (!p)
1760 break;
1761 }
1762
1763 skip_fgets = 0;
1764 strip_blank_front(&p);
1765 strip_blank_end(p);
1766
1767 dprint(FD_PARSE, "%s\n", p);
1768 if (is_empty_or_comment(p))
1769 continue;
1770
1771 if (!nested) {
1772 if (sscanf(p, "[%255[^\n]]", name) != 1) {
1773 if (inside_skip)
1774 continue;
1775
1776 log_err("fio: option <%s> outside of "
1777 "[] job section\n", p);
1778 ret = 1;
1779 break;
1780 }
1781
1782 name[strlen(name) - 1] = '\0';
1783
1784 if (skip_this_section(name)) {
1785 inside_skip = 1;
1786 continue;
1787 } else
1788 inside_skip = 0;
1789
1790 dprint(FD_PARSE, "Parsing section [%s]\n", name);
1791
1792 global = !strncmp(name, "global", 6);
1793
1794 if (dump_cmdline) {
1795 if (first_sect)
1796 log_info("fio ");
1797 if (!global)
1798 log_info("--name=%s ", name);
1799 first_sect = 0;
1800 }
1801
1802 td = get_new_job(global, &def_thread, 0, name);
1803 if (!td) {
1804 ret = 1;
1805 break;
1806 }
1807
1808 /*
1809 * Separate multiple job files by a stonewall
1810 */
1811 if (!global && stonewall) {
1812 td->o.stonewall = stonewall;
1813 stonewall = 0;
1814 }
1815
1816 num_opts = 0;
1817 memset(opts, 0, alloc_opts * sizeof(char *));
1818 }
1819 else
1820 skip_fgets = 1;
1821
1822 while (1) {
1823 if (!skip_fgets) {
1824 if (is_buf)
1825 p = strsep(&file, "\n");
1826 else
1827 p = fgets(string, 4096, f);
1828 if (!p)
1829 break;
1830 dprint(FD_PARSE, "%s", p);
1831 }
1832 else
1833 skip_fgets = 0;
1834
1835 if (is_empty_or_comment(p))
1836 continue;
1837
1838 strip_blank_front(&p);
1839
1840 /*
1841 * new section, break out and make sure we don't
1842 * fgets() a new line at the top.
1843 */
1844 if (p[0] == '[') {
1845 if (nested) {
1846 log_err("No new sections in included files\n");
1847 return 1;
1848 }
1849
1850 skip_fgets = 1;
1851 break;
1852 }
1853
1854 strip_blank_end(p);
1855
1856 if (!strncmp(p, "include", strlen("include"))) {
1857 char *filename = p + strlen("include") + 1,
1858 *ts, *full_fn = NULL;
1859
1860 /*
1861 * Allow for the include filename
1862 * specification to be relative.
1863 */
1864 if (access(filename, F_OK) &&
1865 (ts = strrchr(file, '/'))) {
1866 int len = ts - file +
1867 strlen(filename) + 2;
1868
1869 if (!(full_fn = calloc(1, len))) {
1870 ret = ENOMEM;
1871 break;
1872 }
1873
1874 strncpy(full_fn,
1875 file, (ts - file) + 1);
1876 strncpy(full_fn + (ts - file) + 1,
1877 filename, strlen(filename));
1878 full_fn[len - 1] = 0;
1879 filename = full_fn;
1880 }
1881
1882 ret = __parse_jobs_ini(td, filename, is_buf,
1883 stonewall_flag, type, 1,
1884 name, &opts,
1885 &alloc_opts, &num_opts);
1886
1887 if (ret) {
1888 log_err("Error %d while parsing "
1889 "include file %s\n",
1890 ret, filename);
1891 }
1892
1893 if (full_fn)
1894 free(full_fn);
1895
1896 if (ret)
1897 break;
1898
1899 continue;
1900 }
1901
1902 if (num_opts == alloc_opts) {
1903 alloc_opts <<= 1;
1904 opts = realloc(opts,
1905 alloc_opts * sizeof(char *));
1906 }
1907
1908 opts[num_opts] = strdup(p);
1909 num_opts++;
1910 }
1911
1912 if (nested) {
1913 *popts = opts;
1914 *aopts = alloc_opts;
1915 *nopts = num_opts;
1916 goto out;
1917 }
1918
1919 ret = fio_options_parse(td, opts, num_opts);
1920 if (!ret) {
1921 if (dump_cmdline)
1922 dump_opt_list(td);
1923
1924 ret = add_job(td, name, 0, 0, type);
1925 } else {
1926 log_err("fio: job %s dropped\n", name);
1927 put_job(td);
1928 }
1929
1930 for (i = 0; i < num_opts; i++)
1931 free(opts[i]);
1932 num_opts = 0;
1933 } while (!ret);
1934
1935 if (dump_cmdline)
1936 log_info("\n");
1937
1938 i = 0;
1939 while (i < nr_job_sections) {
1940 free(job_sections[i]);
1941 i++;
1942 }
1943
1944 free(opts);
1945out:
1946 free(string);
1947 if (!nested)
1948 free(name);
1949 if (!is_buf && f != stdin)
1950 fclose(f);
1951 return ret;
1952}
1953
1954int parse_jobs_ini(char *file, int is_buf, int stonewall_flag, int type)
1955{
1956 return __parse_jobs_ini(NULL, file, is_buf, stonewall_flag, type,
1957 0, NULL, NULL, NULL, NULL);
1958}
1959
1960static int fill_def_thread(void)
1961{
1962 memset(&def_thread, 0, sizeof(def_thread));
1963 INIT_FLIST_HEAD(&def_thread.opt_list);
1964
1965 fio_getaffinity(getpid(), &def_thread.o.cpumask);
1966 def_thread.o.error_dump = 1;
1967
1968 /*
1969 * fill default options
1970 */
1971 fio_fill_default_options(&def_thread);
1972 return 0;
1973}
1974
1975static void show_debug_categories(void)
1976{
1977#ifdef FIO_INC_DEBUG
1978 struct debug_level *dl = &debug_levels[0];
1979 int curlen, first = 1;
1980
1981 curlen = 0;
1982 while (dl->name) {
1983 int has_next = (dl + 1)->name != NULL;
1984
1985 if (first || curlen + strlen(dl->name) >= 80) {
1986 if (!first) {
1987 printf("\n");
1988 curlen = 0;
1989 }
1990 curlen += printf("\t\t\t%s", dl->name);
1991 curlen += 3 * (8 - 1);
1992 if (has_next)
1993 curlen += printf(",");
1994 } else {
1995 curlen += printf("%s", dl->name);
1996 if (has_next)
1997 curlen += printf(",");
1998 }
1999 dl++;
2000 first = 0;
2001 }
2002 printf("\n");
2003#endif
2004}
2005
2006static void usage(const char *name)
2007{
2008 printf("%s\n", fio_version_string);
2009 printf("%s [options] [job options] <job file(s)>\n", name);
2010 printf(" --debug=options\tEnable debug logging. May be one/more of:\n");
2011 show_debug_categories();
2012 printf(" --parse-only\t\tParse options only, don't start any IO\n");
2013 printf(" --output\t\tWrite output to file\n");
2014 printf(" --runtime\t\tRuntime in seconds\n");
2015 printf(" --bandwidth-log\tGenerate aggregate bandwidth logs\n");
2016 printf(" --minimal\t\tMinimal (terse) output\n");
2017 printf(" --output-format=x\tOutput format (terse,json,json+,normal)\n");
2018 printf(" --terse-version=x\tSet terse version output format to 'x'\n");
2019 printf(" --version\t\tPrint version info and exit\n");
2020 printf(" --help\t\tPrint this page\n");
2021 printf(" --cpuclock-test\tPerform test/validation of CPU clock\n");
2022 printf(" --crctest\t\tTest speed of checksum functions\n");
2023 printf(" --cmdhelp=cmd\t\tPrint command help, \"all\" for all of"
2024 " them\n");
2025 printf(" --enghelp=engine\tPrint ioengine help, or list"
2026 " available ioengines\n");
2027 printf(" --enghelp=engine,cmd\tPrint help for an ioengine"
2028 " cmd\n");
2029 printf(" --showcmd\t\tTurn a job file into command line options\n");
2030 printf(" --eta=when\t\tWhen ETA estimate should be printed\n");
2031 printf(" \t\tMay be \"always\", \"never\" or \"auto\"\n");
2032 printf(" --eta-newline=time\tForce a new line for every 'time'");
2033 printf(" period passed\n");
2034 printf(" --status-interval=t\tForce full status dump every");
2035 printf(" 't' period passed\n");
2036 printf(" --readonly\t\tTurn on safety read-only checks, preventing"
2037 " writes\n");
2038 printf(" --section=name\tOnly run specified section in job file\n");
2039 printf(" --alloc-size=kb\tSet smalloc pool to this size in kb"
2040 " (def 1024)\n");
2041 printf(" --warnings-fatal\tFio parser warnings are fatal\n");
2042 printf(" --max-jobs=nr\t\tMaximum number of threads/processes to support\n");
2043 printf(" --server=args\t\tStart a backend fio server\n");
2044 printf(" --daemonize=pidfile\tBackground fio server, write pid to file\n");
2045 printf(" --client=hostname\tTalk to remote backend fio server at hostname\n");
2046 printf(" --remote-config=file\tTell fio server to load this local job file\n");
2047 printf(" --idle-prof=option\tReport cpu idleness on a system or percpu basis\n"
2048 "\t\t\t(option=system,percpu) or run unit work\n"
2049 "\t\t\tcalibration only (option=calibrate)\n");
2050#ifdef CONFIG_ZLIB
2051 printf(" --inflate-log=log\tInflate and output compressed log\n");
2052#endif
2053 printf(" --trigger-file=file\tExecute trigger cmd when file exists\n");
2054 printf(" --trigger-timeout=t\tExecute trigger af this time\n");
2055 printf(" --trigger=cmd\t\tSet this command as local trigger\n");
2056 printf(" --trigger-remote=cmd\tSet this command as remote trigger\n");
2057 printf(" --aux-path=path\tUse this path for fio state generated files\n");
2058 printf("\nFio was written by Jens Axboe <jens.axboe@oracle.com>");
2059 printf("\n Jens Axboe <jaxboe@fusionio.com>");
2060 printf("\n Jens Axboe <axboe@fb.com>\n");
2061}
2062
2063#ifdef FIO_INC_DEBUG
2064struct debug_level debug_levels[] = {
2065 { .name = "process",
2066 .help = "Process creation/exit logging",
2067 .shift = FD_PROCESS,
2068 },
2069 { .name = "file",
2070 .help = "File related action logging",
2071 .shift = FD_FILE,
2072 },
2073 { .name = "io",
2074 .help = "IO and IO engine action logging (offsets, queue, completions, etc)",
2075 .shift = FD_IO,
2076 },
2077 { .name = "mem",
2078 .help = "Memory allocation/freeing logging",
2079 .shift = FD_MEM,
2080 },
2081 { .name = "blktrace",
2082 .help = "blktrace action logging",
2083 .shift = FD_BLKTRACE,
2084 },
2085 { .name = "verify",
2086 .help = "IO verification action logging",
2087 .shift = FD_VERIFY,
2088 },
2089 { .name = "random",
2090 .help = "Random generation logging",
2091 .shift = FD_RANDOM,
2092 },
2093 { .name = "parse",
2094 .help = "Parser logging",
2095 .shift = FD_PARSE,
2096 },
2097 { .name = "diskutil",
2098 .help = "Disk utility logging actions",
2099 .shift = FD_DISKUTIL,
2100 },
2101 { .name = "job",
2102 .help = "Logging related to creating/destroying jobs",
2103 .shift = FD_JOB,
2104 },
2105 { .name = "mutex",
2106 .help = "Mutex logging",
2107 .shift = FD_MUTEX
2108 },
2109 { .name = "profile",
2110 .help = "Logging related to profiles",
2111 .shift = FD_PROFILE,
2112 },
2113 { .name = "time",
2114 .help = "Logging related to time keeping functions",
2115 .shift = FD_TIME,
2116 },
2117 { .name = "net",
2118 .help = "Network logging",
2119 .shift = FD_NET,
2120 },
2121 { .name = "rate",
2122 .help = "Rate logging",
2123 .shift = FD_RATE,
2124 },
2125 { .name = "compress",
2126 .help = "Log compression logging",
2127 .shift = FD_COMPRESS,
2128 },
2129 { .name = "steadystate",
2130 .help = "Steady state detection logging",
2131 .shift = FD_STEADYSTATE,
2132 },
2133 { .name = "helperthread",
2134 .help = "Helper thread logging",
2135 .shift = FD_HELPERTHREAD,
2136 },
2137 { .name = NULL, },
2138};
2139
2140static int set_debug(const char *string)
2141{
2142 struct debug_level *dl;
2143 char *p = (char *) string;
2144 char *opt;
2145 int i;
2146
2147 if (!string)
2148 return 0;
2149
2150 if (!strcmp(string, "?") || !strcmp(string, "help")) {
2151 log_info("fio: dumping debug options:");
2152 for (i = 0; debug_levels[i].name; i++) {
2153 dl = &debug_levels[i];
2154 log_info("%s,", dl->name);
2155 }
2156 log_info("all\n");
2157 return 1;
2158 }
2159
2160 while ((opt = strsep(&p, ",")) != NULL) {
2161 int found = 0;
2162
2163 if (!strncmp(opt, "all", 3)) {
2164 log_info("fio: set all debug options\n");
2165 fio_debug = ~0UL;
2166 continue;
2167 }
2168
2169 for (i = 0; debug_levels[i].name; i++) {
2170 dl = &debug_levels[i];
2171 found = !strncmp(opt, dl->name, strlen(dl->name));
2172 if (!found)
2173 continue;
2174
2175 if (dl->shift == FD_JOB) {
2176 opt = strchr(opt, ':');
2177 if (!opt) {
2178 log_err("fio: missing job number\n");
2179 break;
2180 }
2181 opt++;
2182 fio_debug_jobno = atoi(opt);
2183 log_info("fio: set debug jobno %d\n",
2184 fio_debug_jobno);
2185 } else {
2186 log_info("fio: set debug option %s\n", opt);
2187 fio_debug |= (1UL << dl->shift);
2188 }
2189 break;
2190 }
2191
2192 if (!found)
2193 log_err("fio: debug mask %s not found\n", opt);
2194 }
2195 return 0;
2196}
2197#else
2198static int set_debug(const char *string)
2199{
2200 log_err("fio: debug tracing not included in build\n");
2201 return 1;
2202}
2203#endif
2204
2205static void fio_options_fill_optstring(void)
2206{
2207 char *ostr = cmd_optstr;
2208 int i, c;
2209
2210 c = i = 0;
2211 while (l_opts[i].name) {
2212 ostr[c++] = l_opts[i].val;
2213 if (l_opts[i].has_arg == required_argument)
2214 ostr[c++] = ':';
2215 else if (l_opts[i].has_arg == optional_argument) {
2216 ostr[c++] = ':';
2217 ostr[c++] = ':';
2218 }
2219 i++;
2220 }
2221 ostr[c] = '\0';
2222}
2223
2224static int client_flag_set(char c)
2225{
2226 int i;
2227
2228 i = 0;
2229 while (l_opts[i].name) {
2230 int val = l_opts[i].val;
2231
2232 if (c == (val & 0xff))
2233 return (val & FIO_CLIENT_FLAG);
2234
2235 i++;
2236 }
2237
2238 return 0;
2239}
2240
2241static void parse_cmd_client(void *client, char *opt)
2242{
2243 fio_client_add_cmd_option(client, opt);
2244}
2245
2246static void show_closest_option(const char *name)
2247{
2248 int best_option, best_distance;
2249 int i, distance;
2250
2251 while (*name == '-')
2252 name++;
2253
2254 best_option = -1;
2255 best_distance = INT_MAX;
2256 i = 0;
2257 while (l_opts[i].name) {
2258 distance = string_distance(name, l_opts[i].name);
2259 if (distance < best_distance) {
2260 best_distance = distance;
2261 best_option = i;
2262 }
2263 i++;
2264 }
2265
2266 if (best_option != -1 && string_distance_ok(name, best_distance))
2267 log_err("Did you mean %s?\n", l_opts[best_option].name);
2268}
2269
2270static int parse_output_format(const char *optarg)
2271{
2272 char *p, *orig, *opt;
2273 int ret = 0;
2274
2275 p = orig = strdup(optarg);
2276
2277 output_format = 0;
2278
2279 while ((opt = strsep(&p, ",")) != NULL) {
2280 if (!strcmp(opt, "minimal") ||
2281 !strcmp(opt, "terse") ||
2282 !strcmp(opt, "csv"))
2283 output_format |= FIO_OUTPUT_TERSE;
2284 else if (!strcmp(opt, "json"))
2285 output_format |= FIO_OUTPUT_JSON;
2286 else if (!strcmp(opt, "json+"))
2287 output_format |= (FIO_OUTPUT_JSON | FIO_OUTPUT_JSON_PLUS);
2288 else if (!strcmp(opt, "normal"))
2289 output_format |= FIO_OUTPUT_NORMAL;
2290 else {
2291 log_err("fio: invalid output format %s\n", opt);
2292 ret = 1;
2293 break;
2294 }
2295 }
2296
2297 free(orig);
2298 return ret;
2299}
2300
2301int parse_cmd_line(int argc, char *argv[], int client_type)
2302{
2303 struct thread_data *td = NULL;
2304 int c, ini_idx = 0, lidx, ret = 0, do_exit = 0, exit_val = 0;
2305 char *ostr = cmd_optstr;
2306 char *pid_file = NULL;
2307 void *cur_client = NULL;
2308 int backend = 0;
2309
2310 /*
2311 * Reset optind handling, since we may call this multiple times
2312 * for the backend.
2313 */
2314 optind = 1;
2315
2316 while ((c = getopt_long_only(argc, argv, ostr, l_opts, &lidx)) != -1) {
2317 if ((c & FIO_CLIENT_FLAG) || client_flag_set(c)) {
2318 parse_cmd_client(cur_client, argv[optind - 1]);
2319 c &= ~FIO_CLIENT_FLAG;
2320 }
2321
2322 switch (c) {
2323 case 'a':
2324 smalloc_pool_size = atoi(optarg);
2325 smalloc_pool_size <<= 10;
2326 sinit();
2327 break;
2328 case 't':
2329 if (check_str_time(optarg, &def_timeout, 1)) {
2330 log_err("fio: failed parsing time %s\n", optarg);
2331 do_exit++;
2332 exit_val = 1;
2333 }
2334 break;
2335 case 'l':
2336 log_err("fio: --latency-log is deprecated. Use per-job latency log options.\n");
2337 do_exit++;
2338 exit_val = 1;
2339 break;
2340 case 'b':
2341 write_bw_log = 1;
2342 break;
2343 case 'o':
2344 if (f_out && f_out != stdout)
2345 fclose(f_out);
2346
2347 f_out = fopen(optarg, "w+");
2348 if (!f_out) {
2349 perror("fopen output");
2350 exit(1);
2351 }
2352 f_err = f_out;
2353 break;
2354 case 'm':
2355 output_format = FIO_OUTPUT_TERSE;
2356 break;
2357 case 'F':
2358 if (parse_output_format(optarg)) {
2359 log_err("fio: failed parsing output-format\n");
2360 exit_val = 1;
2361 do_exit++;
2362 break;
2363 }
2364 break;
2365 case 'f':
2366 output_format |= FIO_OUTPUT_TERSE;
2367 break;
2368 case 'h':
2369 did_arg = 1;
2370 if (!cur_client) {
2371 usage(argv[0]);
2372 do_exit++;
2373 }
2374 break;
2375 case 'c':
2376 did_arg = 1;
2377 if (!cur_client) {
2378 fio_show_option_help(optarg);
2379 do_exit++;
2380 }
2381 break;
2382 case 'i':
2383 did_arg = 1;
2384 if (!cur_client) {
2385 fio_show_ioengine_help(optarg);
2386 do_exit++;
2387 }
2388 break;
2389 case 's':
2390 did_arg = 1;
2391 dump_cmdline = 1;
2392 break;
2393 case 'r':
2394 read_only = 1;
2395 break;
2396 case 'v':
2397 did_arg = 1;
2398 if (!cur_client) {
2399 log_info("%s\n", fio_version_string);
2400 do_exit++;
2401 }
2402 break;
2403 case 'V':
2404 terse_version = atoi(optarg);
2405 if (!(terse_version == 2 || terse_version == 3 ||
2406 terse_version == 4)) {
2407 log_err("fio: bad terse version format\n");
2408 exit_val = 1;
2409 do_exit++;
2410 }
2411 break;
2412 case 'e':
2413 if (!strcmp("always", optarg))
2414 eta_print = FIO_ETA_ALWAYS;
2415 else if (!strcmp("never", optarg))
2416 eta_print = FIO_ETA_NEVER;
2417 break;
2418 case 'E': {
2419 long long t = 0;
2420
2421 if (check_str_time(optarg, &t, 1)) {
2422 log_err("fio: failed parsing eta time %s\n", optarg);
2423 exit_val = 1;
2424 do_exit++;
2425 }
2426 eta_new_line = t / 1000;
2427 break;
2428 }
2429 case 'd':
2430 if (set_debug(optarg))
2431 do_exit++;
2432 break;
2433 case 'P':
2434 did_arg = 1;
2435 parse_only = 1;
2436 break;
2437 case 'x': {
2438 size_t new_size;
2439
2440 if (!strcmp(optarg, "global")) {
2441 log_err("fio: can't use global as only "
2442 "section\n");
2443 do_exit++;
2444 exit_val = 1;
2445 break;
2446 }
2447 new_size = (nr_job_sections + 1) * sizeof(char *);
2448 job_sections = realloc(job_sections, new_size);
2449 job_sections[nr_job_sections] = strdup(optarg);
2450 nr_job_sections++;
2451 break;
2452 }
2453#ifdef CONFIG_ZLIB
2454 case 'X':
2455 exit_val = iolog_file_inflate(optarg);
2456 did_arg++;
2457 do_exit++;
2458 break;
2459#endif
2460 case 'p':
2461 did_arg = 1;
2462 if (exec_profile)
2463 free(exec_profile);
2464 exec_profile = strdup(optarg);
2465 break;
2466 case FIO_GETOPT_JOB: {
2467 const char *opt = l_opts[lidx].name;
2468 char *val = optarg;
2469
2470 if (!strncmp(opt, "name", 4) && td) {
2471 ret = add_job(td, td->o.name ?: "fio", 0, 0, client_type);
2472 if (ret)
2473 goto out_free;
2474 td = NULL;
2475 did_arg = 1;
2476 }
2477 if (!td) {
2478 int is_section = !strncmp(opt, "name", 4);
2479 int global = 0;
2480
2481 if (!is_section || !strncmp(val, "global", 6))
2482 global = 1;
2483
2484 if (is_section && skip_this_section(val))
2485 continue;
2486
2487 td = get_new_job(global, &def_thread, 1, NULL);
2488 if (!td || ioengine_load(td)) {
2489 if (td) {
2490 put_job(td);
2491 td = NULL;
2492 }
2493 do_exit++;
2494 exit_val = 1;
2495 break;
2496 }
2497 fio_options_set_ioengine_opts(l_opts, td);
2498 }
2499
2500 if ((!val || !strlen(val)) &&
2501 l_opts[lidx].has_arg == required_argument) {
2502 log_err("fio: option %s requires an argument\n", opt);
2503 ret = 1;
2504 } else
2505 ret = fio_cmd_option_parse(td, opt, val);
2506
2507 if (ret) {
2508 if (td) {
2509 put_job(td);
2510 td = NULL;
2511 }
2512 do_exit++;
2513 exit_val = 1;
2514 }
2515
2516 if (!ret && !strcmp(opt, "ioengine")) {
2517 free_ioengine(td);
2518 if (ioengine_load(td)) {
2519 put_job(td);
2520 td = NULL;
2521 do_exit++;
2522 exit_val = 1;
2523 break;
2524 }
2525 fio_options_set_ioengine_opts(l_opts, td);
2526 }
2527 break;
2528 }
2529 case FIO_GETOPT_IOENGINE: {
2530 const char *opt = l_opts[lidx].name;
2531 char *val = optarg;
2532
2533 if (!td)
2534 break;
2535
2536 ret = fio_cmd_ioengine_option_parse(td, opt, val);
2537 break;
2538 }
2539 case 'w':
2540 warnings_fatal = 1;
2541 break;
2542 case 'j':
2543 max_jobs = atoi(optarg);
2544 if (!max_jobs || max_jobs > REAL_MAX_JOBS) {
2545 log_err("fio: invalid max jobs: %d\n", max_jobs);
2546 do_exit++;
2547 exit_val = 1;
2548 }
2549 break;
2550 case 'S':
2551 did_arg = 1;
2552#ifndef CONFIG_NO_SHM
2553 if (nr_clients) {
2554 log_err("fio: can't be both client and server\n");
2555 do_exit++;
2556 exit_val = 1;
2557 break;
2558 }
2559 if (optarg)
2560 fio_server_set_arg(optarg);
2561 is_backend = 1;
2562 backend = 1;
2563#else
2564 log_err("fio: client/server requires SHM support\n");
2565 do_exit++;
2566 exit_val = 1;
2567#endif
2568 break;
2569 case 'D':
2570 if (pid_file)
2571 free(pid_file);
2572 pid_file = strdup(optarg);
2573 break;
2574 case 'I':
2575 if ((ret = fio_idle_prof_parse_opt(optarg))) {
2576 /* exit on error and calibration only */
2577 did_arg = 1;
2578 do_exit++;
2579 if (ret == -1)
2580 exit_val = 1;
2581 }
2582 break;
2583 case 'C':
2584 did_arg = 1;
2585 if (is_backend) {
2586 log_err("fio: can't be both client and server\n");
2587 do_exit++;
2588 exit_val = 1;
2589 break;
2590 }
2591 /* if --client parameter contains a pathname */
2592 if (0 == access(optarg, R_OK)) {
2593 /* file contains a list of host addrs or names */
2594 char hostaddr[PATH_MAX] = {0};
2595 char formatstr[8];
2596 FILE * hostf = fopen(optarg, "r");
2597 if (!hostf) {
2598 log_err("fio: could not open client list file %s for read\n", optarg);
2599 do_exit++;
2600 exit_val = 1;
2601 break;
2602 }
2603 sprintf(formatstr, "%%%ds", PATH_MAX - 1);
2604 /*
2605 * read at most PATH_MAX-1 chars from each
2606 * record in this file
2607 */
2608 while (fscanf(hostf, formatstr, hostaddr) == 1) {
2609 /* expect EVERY host in file to be valid */
2610 if (fio_client_add(&fio_client_ops, hostaddr, &cur_client)) {
2611 log_err("fio: failed adding client %s from file %s\n", hostaddr, optarg);
2612 do_exit++;
2613 exit_val = 1;
2614 break;
2615 }
2616 }
2617 fclose(hostf);
2618 break; /* no possibility of job file for "this client only" */
2619 }
2620 if (fio_client_add(&fio_client_ops, optarg, &cur_client)) {
2621 log_err("fio: failed adding client %s\n", optarg);
2622 do_exit++;
2623 exit_val = 1;
2624 break;
2625 }
2626 /*
2627 * If the next argument exists and isn't an option,
2628 * assume it's a job file for this client only.
2629 */
2630 while (optind < argc) {
2631 if (!strncmp(argv[optind], "--", 2) ||
2632 !strncmp(argv[optind], "-", 1))
2633 break;
2634
2635 if (fio_client_add_ini_file(cur_client, argv[optind], false))
2636 break;
2637 optind++;
2638 }
2639 break;
2640 case 'R':
2641 did_arg = 1;
2642 if (fio_client_add_ini_file(cur_client, optarg, true)) {
2643 do_exit++;
2644 exit_val = 1;
2645 }
2646 break;
2647 case 'T':
2648 did_arg = 1;
2649 do_exit++;
2650 exit_val = fio_monotonic_clocktest(1);
2651 break;
2652 case 'G':
2653 did_arg = 1;
2654 do_exit++;
2655 exit_val = fio_crctest(optarg);
2656 break;
2657 case 'L': {
2658 long long val;
2659
2660 if (check_str_time(optarg, &val, 1)) {
2661 log_err("fio: failed parsing time %s\n", optarg);
2662 do_exit++;
2663 exit_val = 1;
2664 break;
2665 }
2666 status_interval = val / 1000;
2667 break;
2668 }
2669 case 'W':
2670 if (trigger_file)
2671 free(trigger_file);
2672 trigger_file = strdup(optarg);
2673 break;
2674 case 'H':
2675 if (trigger_cmd)
2676 free(trigger_cmd);
2677 trigger_cmd = strdup(optarg);
2678 break;
2679 case 'J':
2680 if (trigger_remote_cmd)
2681 free(trigger_remote_cmd);
2682 trigger_remote_cmd = strdup(optarg);
2683 break;
2684 case 'K':
2685 if (aux_path)
2686 free(aux_path);
2687 aux_path = strdup(optarg);
2688 break;
2689 case 'B':
2690 if (check_str_time(optarg, &trigger_timeout, 1)) {
2691 log_err("fio: failed parsing time %s\n", optarg);
2692 do_exit++;
2693 exit_val = 1;
2694 }
2695 trigger_timeout /= 1000000;
2696 break;
2697 case '?':
2698 log_err("%s: unrecognized option '%s'\n", argv[0],
2699 argv[optind - 1]);
2700 show_closest_option(argv[optind - 1]);
2701 default:
2702 do_exit++;
2703 exit_val = 1;
2704 break;
2705 }
2706 if (do_exit)
2707 break;
2708 }
2709
2710 if (do_exit && !(is_backend || nr_clients))
2711 exit(exit_val);
2712
2713 if (nr_clients && fio_clients_connect())
2714 exit(1);
2715
2716 if (is_backend && backend)
2717 return fio_start_server(pid_file);
2718 else if (pid_file)
2719 free(pid_file);
2720
2721 if (td) {
2722 if (!ret) {
2723 ret = add_job(td, td->o.name ?: "fio", 0, 0, client_type);
2724 if (ret)
2725 did_arg = 1;
2726 }
2727 }
2728
2729 while (!ret && optind < argc) {
2730 ini_idx++;
2731 ini_file = realloc(ini_file, ini_idx * sizeof(char *));
2732 ini_file[ini_idx - 1] = strdup(argv[optind]);
2733 optind++;
2734 }
2735
2736out_free:
2737 if (pid_file)
2738 free(pid_file);
2739
2740 return ini_idx;
2741}
2742
2743int fio_init_options(void)
2744{
2745 f_out = stdout;
2746 f_err = stderr;
2747
2748 fio_options_fill_optstring();
2749 fio_options_dup_and_init(l_opts);
2750
2751 atexit(free_shm);
2752
2753 if (fill_def_thread())
2754 return 1;
2755
2756 return 0;
2757}
2758
2759extern int fio_check_options(struct thread_options *);
2760
2761int parse_options(int argc, char *argv[])
2762{
2763 const int type = FIO_CLIENT_TYPE_CLI;
2764 int job_files, i;
2765
2766 if (fio_init_options())
2767 return 1;
2768 if (fio_test_cconv(&def_thread.o))
2769 log_err("fio: failed internal cconv test\n");
2770
2771 job_files = parse_cmd_line(argc, argv, type);
2772
2773 if (job_files > 0) {
2774 for (i = 0; i < job_files; i++) {
2775 if (i && fill_def_thread())
2776 return 1;
2777 if (nr_clients) {
2778 if (fio_clients_send_ini(ini_file[i]))
2779 return 1;
2780 free(ini_file[i]);
2781 } else if (!is_backend) {
2782 if (parse_jobs_ini(ini_file[i], 0, i, type))
2783 return 1;
2784 free(ini_file[i]);
2785 }
2786 }
2787 } else if (nr_clients) {
2788 if (fill_def_thread())
2789 return 1;
2790 if (fio_clients_send_ini(NULL))
2791 return 1;
2792 }
2793
2794 free(ini_file);
2795 fio_options_free(&def_thread);
2796 filesetup_mem_free();
2797
2798 if (!thread_number) {
2799 if (parse_dryrun())
2800 return 0;
2801 if (exec_profile)
2802 return 0;
2803 if (is_backend || nr_clients)
2804 return 0;
2805 if (did_arg)
2806 return 0;
2807
2808 log_err("No jobs(s) defined\n\n");
2809
2810 if (!did_arg) {
2811 usage(argv[0]);
2812 return 1;
2813 }
2814
2815 return 0;
2816 }
2817
2818 if (output_format & FIO_OUTPUT_NORMAL)
2819 log_info("%s\n", fio_version_string);
2820
2821 return 0;
2822}
2823
2824void options_default_fill(struct thread_options *o)
2825{
2826 memcpy(o, &def_thread.o, sizeof(*o));
2827}
2828
2829struct thread_data *get_global_options(void)
2830{
2831 return &def_thread;
2832}