2 * This file contains job initialization and setup functions.
11 #include <sys/types.h>
13 #ifdef CONFIG_VALGRIND_DEV
14 #include <valgrind/drd.h>
16 #define DRD_IGNORE_VAR(x) do { } while (0)
20 #ifndef FIO_NO_HAVE_SHM_H
32 #include "steadystate.h"
35 #include "oslib/asprintf.h"
36 #include "oslib/getopt.h"
37 #include "oslib/strcasestr.h"
41 #include "lib/memcpy.h"
43 const char fio_version_string[] = FIO_VERSION;
45 #define FIO_RANDSEED (0xb1899bedUL)
47 static char **ini_file;
48 static int max_jobs = FIO_MAX_JOBS;
49 static bool dump_cmdline;
50 static bool parse_only;
51 static bool merge_blktrace_only;
53 static struct thread_data def_thread;
54 struct thread_data *threads = NULL;
55 static char **job_sections;
56 static int nr_job_sections;
58 bool exitall_on_terminate = false;
59 int output_format = FIO_OUTPUT_NORMAL;
60 int eta_print = FIO_ETA_AUTO;
61 unsigned int eta_interval_msec = 1000;
65 char *exec_profile = NULL;
66 int warnings_fatal = 0;
67 int terse_version = 3;
68 bool is_backend = false;
69 bool is_local_backend = false;
71 bool log_syslog = false;
73 bool write_bw_log = false;
74 bool read_only = false;
75 int status_interval = 0;
77 char *trigger_file = NULL;
78 long long trigger_timeout = 0;
79 char *trigger_cmd = NULL;
80 char *trigger_remote_cmd = NULL;
82 char *aux_path = NULL;
84 static int prev_group_jobs;
86 unsigned long fio_debug = 0;
87 unsigned int fio_debug_jobno = -1;
88 unsigned int *fio_debug_jobp = NULL;
89 unsigned int *fio_warned = NULL;
91 static char cmd_optstr[256];
94 #define FIO_CLIENT_FLAG (1 << 16)
97 * Command line options. These will contain the above, plus a few
98 * extra that only pertain to fio itself and not jobs.
100 static struct option l_opts[FIO_NR_OPTIONS] = {
102 .name = (char *) "output",
103 .has_arg = required_argument,
104 .val = 'o' | FIO_CLIENT_FLAG,
107 .name = (char *) "latency-log",
108 .has_arg = required_argument,
109 .val = 'l' | FIO_CLIENT_FLAG,
112 .name = (char *) "bandwidth-log",
113 .has_arg = no_argument,
114 .val = 'b' | FIO_CLIENT_FLAG,
117 .name = (char *) "minimal",
118 .has_arg = no_argument,
119 .val = 'm' | FIO_CLIENT_FLAG,
122 .name = (char *) "output-format",
123 .has_arg = required_argument,
124 .val = 'F' | FIO_CLIENT_FLAG,
127 .name = (char *) "append-terse",
128 .has_arg = optional_argument,
132 .name = (char *) "version",
133 .has_arg = no_argument,
134 .val = 'v' | FIO_CLIENT_FLAG,
137 .name = (char *) "help",
138 .has_arg = no_argument,
139 .val = 'h' | FIO_CLIENT_FLAG,
142 .name = (char *) "cmdhelp",
143 .has_arg = optional_argument,
144 .val = 'c' | FIO_CLIENT_FLAG,
147 .name = (char *) "enghelp",
148 .has_arg = optional_argument,
149 .val = 'i' | FIO_CLIENT_FLAG,
152 .name = (char *) "showcmd",
153 .has_arg = no_argument,
154 .val = 's' | FIO_CLIENT_FLAG,
157 .name = (char *) "readonly",
158 .has_arg = no_argument,
159 .val = 'r' | FIO_CLIENT_FLAG,
162 .name = (char *) "eta",
163 .has_arg = required_argument,
164 .val = 'e' | FIO_CLIENT_FLAG,
167 .name = (char *) "eta-interval",
168 .has_arg = required_argument,
169 .val = 'O' | FIO_CLIENT_FLAG,
172 .name = (char *) "eta-newline",
173 .has_arg = required_argument,
174 .val = 'E' | FIO_CLIENT_FLAG,
177 .name = (char *) "debug",
178 .has_arg = required_argument,
179 .val = 'd' | FIO_CLIENT_FLAG,
182 .name = (char *) "parse-only",
183 .has_arg = no_argument,
184 .val = 'P' | FIO_CLIENT_FLAG,
187 .name = (char *) "section",
188 .has_arg = required_argument,
189 .val = 'x' | FIO_CLIENT_FLAG,
193 .name = (char *) "inflate-log",
194 .has_arg = required_argument,
195 .val = 'X' | FIO_CLIENT_FLAG,
199 .name = (char *) "alloc-size",
200 .has_arg = required_argument,
201 .val = 'a' | FIO_CLIENT_FLAG,
204 .name = (char *) "profile",
205 .has_arg = required_argument,
206 .val = 'p' | FIO_CLIENT_FLAG,
209 .name = (char *) "warnings-fatal",
210 .has_arg = no_argument,
211 .val = 'w' | FIO_CLIENT_FLAG,
214 .name = (char *) "max-jobs",
215 .has_arg = required_argument,
216 .val = 'j' | FIO_CLIENT_FLAG,
219 .name = (char *) "terse-version",
220 .has_arg = required_argument,
221 .val = 'V' | FIO_CLIENT_FLAG,
224 .name = (char *) "server",
225 .has_arg = optional_argument,
228 { .name = (char *) "daemonize",
229 .has_arg = required_argument,
233 .name = (char *) "client",
234 .has_arg = required_argument,
238 .name = (char *) "remote-config",
239 .has_arg = required_argument,
243 .name = (char *) "cpuclock-test",
244 .has_arg = no_argument,
248 .name = (char *) "crctest",
249 .has_arg = optional_argument,
253 .name = (char *) "memcpytest",
254 .has_arg = optional_argument,
258 .name = (char *) "idle-prof",
259 .has_arg = required_argument,
263 .name = (char *) "status-interval",
264 .has_arg = required_argument,
265 .val = 'L' | FIO_CLIENT_FLAG,
268 .name = (char *) "trigger-file",
269 .has_arg = required_argument,
273 .name = (char *) "trigger-timeout",
274 .has_arg = required_argument,
278 .name = (char *) "trigger",
279 .has_arg = required_argument,
283 .name = (char *) "trigger-remote",
284 .has_arg = required_argument,
288 .name = (char *) "aux-path",
289 .has_arg = required_argument,
293 .name = (char *) "merge-blktrace-only",
294 .has_arg = no_argument,
295 .val = 'A' | FIO_CLIENT_FLAG,
302 void free_threads_shm(void)
306 #ifndef CONFIG_NO_SHM
307 struct shmid_ds sbuf;
311 shmctl(shm_id, IPC_RMID, &sbuf);
320 static void free_shm(void)
324 fio_debug_jobp = NULL;
331 free(trigger_remote_cmd);
332 trigger_file = trigger_cmd = trigger_remote_cmd = NULL;
334 options_free(fio_options, &def_thread.o);
341 * The thread area is shared between the main process and the job
342 * threads/processes. So setup a shared memory segment that will hold
343 * all the job info. We use the end of the region for keeping track of
344 * open files across jobs, for file sharing.
346 static int setup_thread_area(void)
354 * 1024 is too much on some machines, scale max_jobs if
355 * we get a failure that looks like too large a shm segment
358 size_t size = max_jobs * sizeof(struct thread_data);
360 size += 2 * sizeof(unsigned int);
362 #ifndef CONFIG_NO_SHM
363 shm_id = shmget(0, size, IPC_CREAT | 0600);
366 if (errno != EINVAL && errno != ENOMEM && errno != ENOSPC) {
371 threads = malloc(size);
379 #ifndef CONFIG_NO_SHM
383 threads = shmat(shm_id, NULL, 0);
384 if (threads == (void *) -1) {
388 if (shm_attach_to_open_removed())
389 shmctl(shm_id, IPC_RMID, NULL);
392 memset(threads, 0, max_jobs * sizeof(struct thread_data));
393 for (i = 0; i < max_jobs; i++)
394 DRD_IGNORE_VAR(threads[i]);
395 fio_debug_jobp = (unsigned int *)(threads + max_jobs);
396 *fio_debug_jobp = -1;
397 fio_warned = fio_debug_jobp + 1;
405 static void dump_print_option(struct print_option *p)
409 if (!strcmp("description", p->name))
414 log_info("--%s%s", p->name, p->value ? "" : " ");
416 log_info("=%s%s%s ", delim, p->value, delim);
419 static void dump_opt_list(struct thread_data *td)
421 struct flist_head *entry;
422 struct print_option *p;
424 if (flist_empty(&td->opt_list))
427 flist_for_each(entry, &td->opt_list) {
428 p = flist_entry(entry, struct print_option, list);
429 dump_print_option(p);
433 static void fio_dump_options_free(struct thread_data *td)
435 while (!flist_empty(&td->opt_list)) {
436 struct print_option *p;
438 p = flist_first_entry(&td->opt_list, struct print_option, list);
439 flist_del_init(&p->list);
446 static void copy_opt_list(struct thread_data *dst, struct thread_data *src)
448 struct flist_head *entry;
450 if (flist_empty(&src->opt_list))
453 flist_for_each(entry, &src->opt_list) {
454 struct print_option *srcp, *dstp;
456 srcp = flist_entry(entry, struct print_option, list);
457 dstp = malloc(sizeof(*dstp));
458 dstp->name = strdup(srcp->name);
460 dstp->value = strdup(srcp->value);
463 flist_add_tail(&dstp->list, &dst->opt_list);
468 * Return a free job structure.
470 static struct thread_data *get_new_job(bool global, struct thread_data *parent,
471 bool preserve_eo, const char *jobname)
473 struct thread_data *td;
477 if (setup_thread_area()) {
478 log_err("error: failed to setup shm segment\n");
481 if (thread_number >= max_jobs) {
482 log_err("error: maximum number of jobs (%d) reached.\n",
487 td = &threads[thread_number++];
490 INIT_FLIST_HEAD(&td->opt_list);
491 if (parent != &def_thread)
492 copy_opt_list(td, parent);
499 td->o.uid = td->o.gid = -1U;
501 dup_files(td, parent);
502 fio_options_mem_dupe(td);
504 profile_add_hooks(td);
506 td->thread_number = thread_number;
507 td->subjob_number = 0;
510 td->o.name = strdup(jobname);
512 if (!parent->o.group_reporting || parent == &def_thread)
518 static void put_job(struct thread_data *td)
520 if (td == &def_thread)
527 log_info("fio: %s\n", td->verror);
529 fio_options_free(td);
530 fio_dump_options_free(td);
537 memset(&threads[td->thread_number - 1], 0, sizeof(*td));
541 static int __setup_rate(struct thread_data *td, enum fio_ddir ddir)
543 unsigned long long bs = td->o.min_bs[ddir];
545 assert(ddir_rw(ddir));
547 if (td->o.rate[ddir])
548 td->rate_bps[ddir] = td->o.rate[ddir];
550 td->rate_bps[ddir] = (uint64_t) td->o.rate_iops[ddir] * bs;
552 if (!td->rate_bps[ddir]) {
553 log_err("rate lower than supported\n");
557 td->rate_next_io_time[ddir] = 0;
558 td->rate_io_issue_bytes[ddir] = 0;
559 td->last_usec[ddir] = 0;
563 static int setup_rate(struct thread_data *td)
567 if (td->o.rate[DDIR_READ] || td->o.rate_iops[DDIR_READ])
568 ret = __setup_rate(td, DDIR_READ);
569 if (td->o.rate[DDIR_WRITE] || td->o.rate_iops[DDIR_WRITE])
570 ret |= __setup_rate(td, DDIR_WRITE);
571 if (td->o.rate[DDIR_TRIM] || td->o.rate_iops[DDIR_TRIM])
572 ret |= __setup_rate(td, DDIR_TRIM);
577 static int fixed_block_size(struct thread_options *o)
579 return o->min_bs[DDIR_READ] == o->max_bs[DDIR_READ] &&
580 o->min_bs[DDIR_WRITE] == o->max_bs[DDIR_WRITE] &&
581 o->min_bs[DDIR_TRIM] == o->max_bs[DDIR_TRIM] &&
582 o->min_bs[DDIR_READ] == o->min_bs[DDIR_WRITE] &&
583 o->min_bs[DDIR_READ] == o->min_bs[DDIR_TRIM];
589 static unsigned int gcd(unsigned int m, unsigned int n)
594 return gcd(n, m % n);
598 * Lazy way of fixing up options that depend on each other. We could also
599 * define option callback handlers, but this is easier.
601 static int fixup_options(struct thread_data *td)
603 struct thread_options *o = &td->o;
606 if (read_only && (td_write(td) || td_trim(td))) {
607 log_err("fio: trim and write operations are not allowed"
608 " with the --readonly parameter.\n");
612 #ifndef CONFIG_PSHARED
613 if (!o->use_thread) {
614 log_info("fio: this platform does not support process shared"
615 " mutexes, forcing use of threads. Use the 'thread'"
616 " option to get rid of this warning.\n");
618 ret |= warnings_fatal;
622 if (o->write_iolog_file && o->read_iolog_file) {
623 log_err("fio: read iolog overrides write_iolog\n");
624 free(o->write_iolog_file);
625 o->write_iolog_file = NULL;
626 ret |= warnings_fatal;
629 if (o->zone_mode == ZONE_MODE_NONE && o->zone_size) {
630 log_err("fio: --zonemode=none and --zonesize are not compatible.\n");
634 if (o->zone_mode == ZONE_MODE_STRIDED && !o->zone_size) {
635 log_err("fio: --zonesize must be specified when using --zonemode=strided.\n");
639 if (o->zone_mode == ZONE_MODE_NOT_SPECIFIED) {
641 o->zone_mode = ZONE_MODE_STRIDED;
643 o->zone_mode = ZONE_MODE_NONE;
647 * Strided zone mode only really works with 1 file.
649 if (o->zone_mode == ZONE_MODE_STRIDED && o->open_files > 1)
650 o->zone_mode = ZONE_MODE_NONE;
653 * If zone_range isn't specified, backward compatibility dictates it
654 * should be made equal to zone_size.
656 if (o->zone_mode == ZONE_MODE_STRIDED && !o->zone_range)
657 o->zone_range = o->zone_size;
660 * Reads can do overwrites, we always need to pre-create the file
665 if (!o->min_bs[DDIR_READ])
666 o->min_bs[DDIR_READ] = o->bs[DDIR_READ];
667 if (!o->max_bs[DDIR_READ])
668 o->max_bs[DDIR_READ] = o->bs[DDIR_READ];
669 if (!o->min_bs[DDIR_WRITE])
670 o->min_bs[DDIR_WRITE] = o->bs[DDIR_WRITE];
671 if (!o->max_bs[DDIR_WRITE])
672 o->max_bs[DDIR_WRITE] = o->bs[DDIR_WRITE];
673 if (!o->min_bs[DDIR_TRIM])
674 o->min_bs[DDIR_TRIM] = o->bs[DDIR_TRIM];
675 if (!o->max_bs[DDIR_TRIM])
676 o->max_bs[DDIR_TRIM] = o->bs[DDIR_TRIM];
678 o->rw_min_bs = min(o->min_bs[DDIR_READ], o->min_bs[DDIR_WRITE]);
679 o->rw_min_bs = min(o->min_bs[DDIR_TRIM], o->rw_min_bs);
682 * For random IO, allow blockalign offset other than min_bs.
684 if (!o->ba[DDIR_READ] || !td_random(td))
685 o->ba[DDIR_READ] = o->min_bs[DDIR_READ];
686 if (!o->ba[DDIR_WRITE] || !td_random(td))
687 o->ba[DDIR_WRITE] = o->min_bs[DDIR_WRITE];
688 if (!o->ba[DDIR_TRIM] || !td_random(td))
689 o->ba[DDIR_TRIM] = o->min_bs[DDIR_TRIM];
691 if ((o->ba[DDIR_READ] != o->min_bs[DDIR_READ] ||
692 o->ba[DDIR_WRITE] != o->min_bs[DDIR_WRITE] ||
693 o->ba[DDIR_TRIM] != o->min_bs[DDIR_TRIM]) &&
695 log_err("fio: Any use of blockalign= turns off randommap\n");
697 ret |= warnings_fatal;
700 if (!o->file_size_high)
701 o->file_size_high = o->file_size_low;
703 if (o->start_delay_high) {
704 if (!o->start_delay_orig)
705 o->start_delay_orig = o->start_delay;
706 o->start_delay = rand_between(&td->delay_state,
708 o->start_delay_high);
711 if (o->norandommap && o->verify != VERIFY_NONE
712 && !fixed_block_size(o)) {
713 log_err("fio: norandommap given for variable block sizes, "
715 ret |= warnings_fatal;
717 if (o->bs_unaligned && (o->odirect || td_ioengine_flagged(td, FIO_RAWIO)))
718 log_err("fio: bs_unaligned may not work with raw io\n");
721 * thinktime_spin must be less than thinktime
723 if (o->thinktime_spin > o->thinktime)
724 o->thinktime_spin = o->thinktime;
727 * The low water mark cannot be bigger than the iodepth
729 if (o->iodepth_low > o->iodepth || !o->iodepth_low)
730 o->iodepth_low = o->iodepth;
733 * If batch number isn't set, default to the same as iodepth
735 if (o->iodepth_batch > o->iodepth || !o->iodepth_batch)
736 o->iodepth_batch = o->iodepth;
739 * If max batch complete number isn't set or set incorrectly,
740 * default to the same as iodepth_batch_complete_min
742 if (o->iodepth_batch_complete_min > o->iodepth_batch_complete_max)
743 o->iodepth_batch_complete_max = o->iodepth_batch_complete_min;
746 * There's no need to check for in-flight overlapping IOs if the job
747 * isn't changing data or the maximum iodepth is guaranteed to be 1
748 * when we are not in offload mode
750 if (o->serialize_overlap && !(td->flags & TD_F_READ_IOLOG) &&
751 (!(td_write(td) || td_trim(td)) || o->iodepth == 1) &&
752 o->io_submit_mode != IO_MODE_OFFLOAD)
753 o->serialize_overlap = 0;
755 if (o->nr_files > td->files_index)
756 o->nr_files = td->files_index;
758 if (o->open_files > o->nr_files || !o->open_files)
759 o->open_files = o->nr_files;
761 if (((o->rate[DDIR_READ] + o->rate[DDIR_WRITE] + o->rate[DDIR_TRIM]) &&
762 (o->rate_iops[DDIR_READ] + o->rate_iops[DDIR_WRITE] + o->rate_iops[DDIR_TRIM])) ||
763 ((o->ratemin[DDIR_READ] + o->ratemin[DDIR_WRITE] + o->ratemin[DDIR_TRIM]) &&
764 (o->rate_iops_min[DDIR_READ] + o->rate_iops_min[DDIR_WRITE] + o->rate_iops_min[DDIR_TRIM]))) {
765 log_err("fio: rate and rate_iops are mutually exclusive\n");
768 if ((o->rate[DDIR_READ] && (o->rate[DDIR_READ] < o->ratemin[DDIR_READ])) ||
769 (o->rate[DDIR_WRITE] && (o->rate[DDIR_WRITE] < o->ratemin[DDIR_WRITE])) ||
770 (o->rate[DDIR_TRIM] && (o->rate[DDIR_TRIM] < o->ratemin[DDIR_TRIM])) ||
771 (o->rate_iops[DDIR_READ] && (o->rate_iops[DDIR_READ] < o->rate_iops_min[DDIR_READ])) ||
772 (o->rate_iops[DDIR_WRITE] && (o->rate_iops[DDIR_WRITE] < o->rate_iops_min[DDIR_WRITE])) ||
773 (o->rate_iops[DDIR_TRIM] && (o->rate_iops[DDIR_TRIM] < o->rate_iops_min[DDIR_TRIM]))) {
774 log_err("fio: minimum rate exceeds rate\n");
778 if (!o->timeout && o->time_based) {
779 log_err("fio: time_based requires a runtime/timeout setting\n");
781 ret |= warnings_fatal;
784 if (o->fill_device && !o->size)
787 if (o->verify != VERIFY_NONE) {
788 if (td_write(td) && o->do_verify && o->numjobs > 1 &&
790 !(o->unique_filename &&
791 strstr(o->filename_format, "$jobname") &&
792 strstr(o->filename_format, "$jobnum") &&
793 strstr(o->filename_format, "$filenum")))) {
794 log_info("fio: multiple writers may overwrite blocks "
795 "that belong to other jobs. This can cause "
796 "verification failures.\n");
797 ret |= warnings_fatal;
801 * Warn if verification is requested but no verification of any
802 * kind can be started due to time constraints
804 if (td_write(td) && o->do_verify && o->timeout &&
805 o->time_based && !td_read(td) && !o->verify_backlog) {
806 log_info("fio: verification read phase will never "
807 "start because write phase uses all of "
809 ret |= warnings_fatal;
812 if (!fio_option_is_set(o, refill_buffers))
813 o->refill_buffers = 1;
815 if (o->max_bs[DDIR_WRITE] != o->min_bs[DDIR_WRITE] &&
817 o->verify_interval = o->min_bs[DDIR_WRITE];
820 * Verify interval must be smaller or equal to the
823 if (o->verify_interval > o->min_bs[DDIR_WRITE])
824 o->verify_interval = o->min_bs[DDIR_WRITE];
825 else if (td_read(td) && o->verify_interval > o->min_bs[DDIR_READ])
826 o->verify_interval = o->min_bs[DDIR_READ];
829 * Verify interval must be a factor of both min and max
832 if (!o->verify_interval ||
833 (o->min_bs[DDIR_WRITE] % o->verify_interval) ||
834 (o->max_bs[DDIR_WRITE] % o->verify_interval))
835 o->verify_interval = gcd(o->min_bs[DDIR_WRITE],
836 o->max_bs[DDIR_WRITE]);
840 if (o->invalidate_cache)
841 o->invalidate_cache = 0;
842 if (td_ioengine_flagged(td, FIO_PIPEIO)) {
843 log_info("fio: cannot pre-read files with an IO engine"
844 " that isn't seekable. Pre-read disabled.\n");
845 ret |= warnings_fatal;
849 if (o->unit_base == N2S_NONE) {
850 if (td_ioengine_flagged(td, FIO_BIT_BASED))
851 o->unit_base = N2S_BITPERSEC;
853 o->unit_base = N2S_BYTEPERSEC;
856 #ifndef CONFIG_FDATASYNC
857 if (o->fdatasync_blocks) {
858 log_info("fio: this platform does not support fdatasync()"
859 " falling back to using fsync(). Use the 'fsync'"
860 " option instead of 'fdatasync' to get rid of"
862 o->fsync_blocks = o->fdatasync_blocks;
863 o->fdatasync_blocks = 0;
864 ret |= warnings_fatal;
870 * Windows doesn't support O_DIRECT or O_SYNC with the _open interface,
871 * so fail if we're passed those flags
873 if (td_ioengine_flagged(td, FIO_SYNCIO) && (o->odirect || o->sync_io)) {
874 log_err("fio: Windows does not support direct or non-buffered io with"
875 " the synchronous ioengines. Use the 'windowsaio' ioengine"
876 " with 'direct=1' and 'iodepth=1' instead.\n");
882 * For fully compressible data, just zero them at init time.
883 * It's faster than repeatedly filling it. For non-zero
884 * compression, we should have refill_buffers set. Set it, unless
885 * the job file already changed it.
887 if (o->compress_percentage) {
888 if (o->compress_percentage == 100) {
890 o->compress_percentage = 0;
891 } else if (!fio_option_is_set(o, refill_buffers)) {
892 o->refill_buffers = 1;
893 td->flags |= TD_F_REFILL_BUFFERS;
898 * Using a non-uniform random distribution excludes usage of
901 if (o->random_distribution != FIO_RAND_DIST_RANDOM)
905 * If size is set but less than the min block size, complain
907 if (o->size && o->size < td_min_bs(td)) {
908 log_err("fio: size too small, must not be less than minimum block size: %llu < %llu\n",
909 (unsigned long long) o->size, td_min_bs(td));
914 * O_ATOMIC implies O_DIRECT
920 * If randseed is set, that overrides randrepeat
922 if (fio_option_is_set(o, rand_seed))
923 o->rand_repeatable = 0;
925 if (td_ioengine_flagged(td, FIO_NOEXTEND) && o->file_append) {
926 log_err("fio: can't append/extent with IO engine %s\n", td->io_ops->name);
930 if (fio_option_is_set(o, gtod_cpu)) {
932 fio_gtod_set_cpu(o->gtod_cpu);
933 fio_gtod_offload = 1;
936 td->loops = o->loops;
940 if (o->block_error_hist && o->nr_files != 1) {
941 log_err("fio: block error histogram only available "
942 "with a single file per job, but %d files "
943 "provided\n", o->nr_files);
947 if (fio_option_is_set(o, clat_percentiles) &&
948 !fio_option_is_set(o, lat_percentiles)) {
949 o->lat_percentiles = !o->clat_percentiles;
950 } else if (fio_option_is_set(o, lat_percentiles) &&
951 !fio_option_is_set(o, clat_percentiles)) {
952 o->clat_percentiles = !o->lat_percentiles;
953 } else if (fio_option_is_set(o, lat_percentiles) &&
954 fio_option_is_set(o, clat_percentiles) &&
955 o->lat_percentiles && o->clat_percentiles) {
956 log_err("fio: lat_percentiles and clat_percentiles are "
957 "mutually exclusive\n");
962 o->lat_percentiles = 0;
964 o->clat_percentiles = 0;
967 * Fix these up to be nsec internally
969 o->max_latency *= 1000ULL;
970 o->latency_target *= 1000ULL;
971 o->latency_window *= 1000ULL;
976 static void init_rand_file_service(struct thread_data *td)
978 unsigned long nranges = td->o.nr_files << FIO_FSERVICE_SHIFT;
979 const unsigned int seed = td->rand_seeds[FIO_RAND_FILE_OFF];
981 if (td->o.file_service_type == FIO_FSERVICE_ZIPF) {
982 zipf_init(&td->next_file_zipf, nranges, td->zipf_theta, seed);
983 zipf_disable_hash(&td->next_file_zipf);
984 } else if (td->o.file_service_type == FIO_FSERVICE_PARETO) {
985 pareto_init(&td->next_file_zipf, nranges, td->pareto_h, seed);
986 zipf_disable_hash(&td->next_file_zipf);
987 } else if (td->o.file_service_type == FIO_FSERVICE_GAUSS) {
988 gauss_init(&td->next_file_gauss, nranges, td->gauss_dev, seed);
989 gauss_disable_hash(&td->next_file_gauss);
993 void td_fill_verify_state_seed(struct thread_data *td)
997 if (td->o.random_generator == FIO_RAND_GEN_TAUSWORTHE64)
1002 init_rand_seed(&td->verify_state, td->rand_seeds[FIO_RAND_VER_OFF],
1006 static void td_fill_rand_seeds_internal(struct thread_data *td, bool use64)
1008 unsigned int read_seed = td->rand_seeds[FIO_RAND_BS_OFF];
1009 unsigned int write_seed = td->rand_seeds[FIO_RAND_BS1_OFF];
1010 unsigned int trim_seed = td->rand_seeds[FIO_RAND_BS2_OFF];
1014 * trimwrite is special in that we need to generate the same
1015 * offsets to get the "write after trim" effect. If we are
1016 * using bssplit to set buffer length distributions, ensure that
1017 * we seed the trim and write generators identically. Ditto for
1018 * verify, read and writes must have the same seed, if we are doing
1021 if (td->o.verify != VERIFY_NONE)
1022 write_seed = read_seed;
1023 if (td_trimwrite(td))
1024 trim_seed = write_seed;
1025 init_rand_seed(&td->bsrange_state[DDIR_READ], read_seed, use64);
1026 init_rand_seed(&td->bsrange_state[DDIR_WRITE], write_seed, use64);
1027 init_rand_seed(&td->bsrange_state[DDIR_TRIM], trim_seed, use64);
1029 td_fill_verify_state_seed(td);
1030 init_rand_seed(&td->rwmix_state, td->rand_seeds[FIO_RAND_MIX_OFF], false);
1032 if (td->o.file_service_type == FIO_FSERVICE_RANDOM)
1033 init_rand_seed(&td->next_file_state, td->rand_seeds[FIO_RAND_FILE_OFF], use64);
1034 else if (td->o.file_service_type & __FIO_FSERVICE_NONUNIFORM)
1035 init_rand_file_service(td);
1037 init_rand_seed(&td->file_size_state, td->rand_seeds[FIO_RAND_FILE_SIZE_OFF], use64);
1038 init_rand_seed(&td->trim_state, td->rand_seeds[FIO_RAND_TRIM_OFF], use64);
1039 init_rand_seed(&td->delay_state, td->rand_seeds[FIO_RAND_START_DELAY], use64);
1040 init_rand_seed(&td->poisson_state[0], td->rand_seeds[FIO_RAND_POISSON_OFF], 0);
1041 init_rand_seed(&td->poisson_state[1], td->rand_seeds[FIO_RAND_POISSON2_OFF], 0);
1042 init_rand_seed(&td->poisson_state[2], td->rand_seeds[FIO_RAND_POISSON3_OFF], 0);
1043 init_rand_seed(&td->dedupe_state, td->rand_seeds[FIO_DEDUPE_OFF], false);
1044 init_rand_seed(&td->zone_state, td->rand_seeds[FIO_RAND_ZONE_OFF], false);
1049 if (td->o.rand_repeatable)
1050 td->rand_seeds[FIO_RAND_BLOCK_OFF] = FIO_RANDSEED * td->thread_number;
1052 init_rand_seed(&td->random_state, td->rand_seeds[FIO_RAND_BLOCK_OFF], use64);
1054 for (i = 0; i < DDIR_RWDIR_CNT; i++) {
1055 struct frand_state *s = &td->seq_rand_state[i];
1057 init_rand_seed(s, td->rand_seeds[FIO_RAND_SEQ_RAND_READ_OFF], false);
1061 void td_fill_rand_seeds(struct thread_data *td)
1065 if (td->o.allrand_repeatable) {
1068 for (i = 0; i < FIO_RAND_NR_OFFS; i++)
1069 td->rand_seeds[i] = FIO_RANDSEED * td->thread_number
1073 if (td->o.random_generator == FIO_RAND_GEN_TAUSWORTHE64)
1078 td_fill_rand_seeds_internal(td, use64);
1080 init_rand_seed(&td->buf_state, td->rand_seeds[FIO_RAND_BUF_OFF], use64);
1081 frand_copy(&td->buf_state_prev, &td->buf_state);
1085 * Initializes the ioengine configured for a job, if it has not been done so
1088 int ioengine_load(struct thread_data *td)
1090 if (!td->o.ioengine) {
1091 log_err("fio: internal fault, no IO engine specified\n");
1096 struct ioengine_ops *ops;
1099 /* An engine is loaded, but the requested ioengine
1102 if (!strcmp(td->io_ops->name, td->o.ioengine)) {
1103 /* The right engine is already loaded */
1108 * Name of file and engine may be different, load ops
1109 * for this name and see if they match. If they do, then
1110 * the engine is unchanged.
1112 dlhandle = td->io_ops_dlhandle;
1113 ops = load_ioengine(td);
1114 if (ops == td->io_ops && dlhandle == td->io_ops_dlhandle) {
1120 if (dlhandle && dlhandle != td->io_ops_dlhandle)
1123 /* Unload the old engine. */
1127 td->io_ops = load_ioengine(td);
1129 log_err("fio: failed to load engine\n");
1133 if (td->io_ops->option_struct_size && td->io_ops->options) {
1135 * In cases where td->eo is set, clone it for a child thread.
1136 * This requires that the parent thread has the same ioengine,
1137 * but that requirement must be enforced by the code which
1138 * cloned the thread.
1140 void *origeo = td->eo;
1142 * Otherwise use the default thread options.
1144 if (!origeo && td != &def_thread && def_thread.eo &&
1145 def_thread.io_ops->options == td->io_ops->options)
1146 origeo = def_thread.eo;
1148 options_init(td->io_ops->options);
1149 td->eo = malloc(td->io_ops->option_struct_size);
1151 * Use the default thread as an option template if this uses the
1152 * same options structure and there are non-default options
1156 memcpy(td->eo, origeo, td->io_ops->option_struct_size);
1157 options_mem_dupe(td->io_ops->options, td->eo);
1159 memset(td->eo, 0, td->io_ops->option_struct_size);
1160 fill_default_options(td->eo, td->io_ops->options);
1162 *(struct thread_data **)td->eo = td;
1166 td->io_ops->flags |= FIO_RAWIO;
1168 td_set_ioengine_flags(td);
1172 static void init_flags(struct thread_data *td)
1174 struct thread_options *o = &td->o;
1177 if (o->verify_backlog)
1178 td->flags |= TD_F_VER_BACKLOG;
1179 if (o->trim_backlog)
1180 td->flags |= TD_F_TRIM_BACKLOG;
1181 if (o->read_iolog_file)
1182 td->flags |= TD_F_READ_IOLOG;
1183 if (o->refill_buffers)
1184 td->flags |= TD_F_REFILL_BUFFERS;
1186 * Always scramble buffers if asked to
1188 if (o->scramble_buffers && fio_option_is_set(o, scramble_buffers))
1189 td->flags |= TD_F_SCRAMBLE_BUFFERS;
1191 * But also scramble buffers, unless we were explicitly asked
1194 if (o->scramble_buffers && !(o->zero_buffers &&
1195 fio_option_is_set(o, zero_buffers)))
1196 td->flags |= TD_F_SCRAMBLE_BUFFERS;
1197 if (o->verify != VERIFY_NONE)
1198 td->flags |= TD_F_DO_VERIFY;
1200 if (o->verify_async || o->io_submit_mode == IO_MODE_OFFLOAD)
1201 td->flags |= TD_F_NEED_LOCK;
1203 if (o->mem_type == MEM_CUDA_MALLOC)
1204 td->flags &= ~TD_F_SCRAMBLE_BUFFERS;
1206 for (i = 0; i < DDIR_RWDIR_CNT; i++) {
1207 if (option_check_rate(td, i)) {
1208 td->flags |= TD_F_CHECK_RATE;
1214 static int setup_random_seeds(struct thread_data *td)
1219 if (!td->o.rand_repeatable && !fio_option_is_set(&td->o, rand_seed)) {
1220 int ret = init_random_seeds(td->rand_seeds, sizeof(td->rand_seeds));
1222 td_fill_rand_seeds(td);
1226 seed = td->o.rand_seed;
1227 for (i = 0; i < 4; i++)
1228 seed *= 0x9e370001UL;
1230 for (i = 0; i < FIO_RAND_NR_OFFS; i++) {
1231 td->rand_seeds[i] = seed * td->thread_number + i;
1232 seed *= 0x9e370001UL;
1235 td_fill_rand_seeds(td);
1246 static struct fpre_keyword {
1247 const char *keyword;
1250 } fpre_keywords[] = {
1251 { .keyword = "$jobname", .key = FPRE_JOBNAME, },
1252 { .keyword = "$jobnum", .key = FPRE_JOBNUM, },
1253 { .keyword = "$filenum", .key = FPRE_FILENUM, },
1254 { .keyword = NULL, },
1257 static char *make_filename(char *buf, size_t buf_size,struct thread_options *o,
1258 const char *jobname, int jobnum, int filenum)
1260 struct fpre_keyword *f;
1261 char copy[PATH_MAX];
1262 size_t dst_left = PATH_MAX - 1;
1264 if (!o->filename_format || !strlen(o->filename_format)) {
1265 sprintf(buf, "%s.%d.%d", jobname, jobnum, filenum);
1269 for (f = &fpre_keywords[0]; f->keyword; f++)
1270 f->strlen = strlen(f->keyword);
1272 snprintf(buf, buf_size, "%s", o->filename_format);
1274 memset(copy, 0, sizeof(copy));
1275 for (f = &fpre_keywords[0]; f->keyword; f++) {
1277 size_t pre_len, post_start = 0;
1278 char *str, *dst = copy;
1280 str = strcasestr(buf, f->keyword);
1284 pre_len = str - buf;
1285 if (strlen(str) != f->strlen)
1286 post_start = pre_len + f->strlen;
1289 strncpy(dst, buf, pre_len);
1291 dst_left -= pre_len;
1295 case FPRE_JOBNAME: {
1298 ret = snprintf(dst, dst_left, "%s", jobname);
1301 else if (ret > dst_left) {
1302 log_err("fio: truncated filename\n");
1314 ret = snprintf(dst, dst_left, "%d", jobnum);
1317 else if (ret > dst_left) {
1318 log_err("fio: truncated filename\n");
1327 case FPRE_FILENUM: {
1330 ret = snprintf(dst, dst_left, "%d", filenum);
1333 else if (ret > dst_left) {
1334 log_err("fio: truncated filename\n");
1349 strncpy(dst, buf + post_start, dst_left);
1351 snprintf(buf, buf_size, "%s", copy);
1358 bool parse_dryrun(void)
1360 return dump_cmdline || parse_only;
1363 static void gen_log_name(char *name, size_t size, const char *logtype,
1364 const char *logname, unsigned int num,
1365 const char *suf, int per_job)
1368 snprintf(name, size, "%s_%s.%d.%s", logname, logtype, num, suf);
1370 snprintf(name, size, "%s_%s.%s", logname, logtype, suf);
1373 static int check_waitees(char *waitee)
1375 struct thread_data *td;
1378 for_each_td(td, i) {
1379 if (td->subjob_number)
1382 ret += !strcmp(td->o.name, waitee);
1388 static bool wait_for_ok(const char *jobname, struct thread_options *o)
1395 if (!strcmp(jobname, o->wait_for)) {
1396 log_err("%s: a job cannot wait for itself (wait_for=%s).\n",
1397 jobname, o->wait_for);
1401 if (!(nw = check_waitees(o->wait_for))) {
1402 log_err("%s: waitee job %s unknown.\n", jobname, o->wait_for);
1407 log_err("%s: multiple waitees %s found,\n"
1408 "please avoid duplicates when using wait_for option.\n",
1409 jobname, o->wait_for);
1417 * Treat an empty log file name the same as a one not given
1419 static const char *make_log_name(const char *logname, const char *jobname)
1421 if (logname && strcmp(logname, ""))
1428 * Adds a job to the list of things todo. Sanitizes the various options
1429 * to make sure we don't have conflicts, and initializes various
1432 static int add_job(struct thread_data *td, const char *jobname, int job_add_num,
1433 int recursed, int client_type)
1436 char fname[PATH_MAX + 1];
1437 int numjobs, file_alloced;
1438 struct thread_options *o = &td->o;
1439 char logname[PATH_MAX + 32];
1442 * the def_thread is just for options, it's not a real job
1444 if (td == &def_thread)
1450 * if we are just dumping the output command line, don't add the job
1452 if (parse_dryrun()) {
1457 td->client_type = client_type;
1459 if (profile_td_init(td))
1462 if (ioengine_load(td))
1466 if (!o->filename && !td->files_index && !o->read_iolog_file) {
1469 if (o->nr_files == 1 && exists_and_not_regfile(jobname))
1470 add_file(td, jobname, job_add_num, 0);
1472 for (i = 0; i < o->nr_files; i++)
1473 add_file(td, make_filename(fname, sizeof(fname), o, jobname, job_add_num, i), job_add_num, 0);
1477 if (setup_random_seeds(td)) {
1478 td_verror(td, errno, "setup_random_seeds");
1482 if (fixup_options(td))
1486 * Belongs to fixup_options, but o->name is not necessarily set as yet
1488 if (!wait_for_ok(jobname, o))
1494 * IO engines only need this for option callbacks, and the address may
1495 * change in subprocesses.
1498 *(struct thread_data **)td->eo = NULL;
1500 if (td_ioengine_flagged(td, FIO_DISKLESSIO)) {
1503 for_each_file(td, f, i)
1504 f->real_file_size = -1ULL;
1507 td->sem = fio_sem_init(FIO_SEM_LOCKED);
1509 td->ts.clat_percentiles = o->clat_percentiles;
1510 td->ts.lat_percentiles = o->lat_percentiles;
1511 td->ts.percentile_precision = o->percentile_precision;
1512 memcpy(td->ts.percentile_list, o->percentile_list, sizeof(o->percentile_list));
1513 td->ts.sig_figs = o->sig_figs;
1515 for (i = 0; i < DDIR_RWDIR_CNT; i++) {
1516 td->ts.clat_stat[i].min_val = ULONG_MAX;
1517 td->ts.slat_stat[i].min_val = ULONG_MAX;
1518 td->ts.lat_stat[i].min_val = ULONG_MAX;
1519 td->ts.bw_stat[i].min_val = ULONG_MAX;
1520 td->ts.iops_stat[i].min_val = ULONG_MAX;
1522 td->ts.sync_stat.min_val = ULONG_MAX;
1523 td->ddir_seq_nr = o->ddir_seq_nr;
1525 if ((o->stonewall || o->new_group) && prev_group_jobs) {
1526 prev_group_jobs = 0;
1528 if (groupid == INT_MAX) {
1529 log_err("fio: too many groups defined\n");
1534 td->groupid = groupid;
1540 if (o->write_lat_log) {
1541 struct log_params p = {
1543 .avg_msec = o->log_avg_msec,
1544 .hist_msec = o->log_hist_msec,
1545 .hist_coarseness = o->log_hist_coarseness,
1546 .log_type = IO_LOG_TYPE_LAT,
1547 .log_offset = o->log_offset,
1548 .log_gz = o->log_gz,
1549 .log_gz_store = o->log_gz_store,
1551 const char *pre = make_log_name(o->lat_log_file, o->name);
1559 gen_log_name(logname, sizeof(logname), "lat", pre,
1560 td->thread_number, suf, o->per_job_logs);
1561 setup_log(&td->lat_log, &p, logname);
1563 gen_log_name(logname, sizeof(logname), "slat", pre,
1564 td->thread_number, suf, o->per_job_logs);
1565 setup_log(&td->slat_log, &p, logname);
1567 gen_log_name(logname, sizeof(logname), "clat", pre,
1568 td->thread_number, suf, o->per_job_logs);
1569 setup_log(&td->clat_log, &p, logname);
1573 if (o->write_hist_log) {
1574 struct log_params p = {
1576 .avg_msec = o->log_avg_msec,
1577 .hist_msec = o->log_hist_msec,
1578 .hist_coarseness = o->log_hist_coarseness,
1579 .log_type = IO_LOG_TYPE_HIST,
1580 .log_offset = o->log_offset,
1581 .log_gz = o->log_gz,
1582 .log_gz_store = o->log_gz_store,
1584 const char *pre = make_log_name(o->hist_log_file, o->name);
1588 if (td->client_type) {
1589 log_err("fio: --write_hist_log requires zlib in client/server mode\n");
1599 gen_log_name(logname, sizeof(logname), "clat_hist", pre,
1600 td->thread_number, suf, o->per_job_logs);
1601 setup_log(&td->clat_hist_log, &p, logname);
1604 if (o->write_bw_log) {
1605 struct log_params p = {
1607 .avg_msec = o->log_avg_msec,
1608 .hist_msec = o->log_hist_msec,
1609 .hist_coarseness = o->log_hist_coarseness,
1610 .log_type = IO_LOG_TYPE_BW,
1611 .log_offset = o->log_offset,
1612 .log_gz = o->log_gz,
1613 .log_gz_store = o->log_gz_store,
1615 const char *pre = make_log_name(o->bw_log_file, o->name);
1618 if (fio_option_is_set(o, bw_avg_time))
1619 p.avg_msec = min(o->log_avg_msec, o->bw_avg_time);
1621 o->bw_avg_time = p.avg_msec;
1623 p.hist_msec = o->log_hist_msec;
1624 p.hist_coarseness = o->log_hist_coarseness;
1631 gen_log_name(logname, sizeof(logname), "bw", pre,
1632 td->thread_number, suf, o->per_job_logs);
1633 setup_log(&td->bw_log, &p, logname);
1635 if (o->write_iops_log) {
1636 struct log_params p = {
1638 .avg_msec = o->log_avg_msec,
1639 .hist_msec = o->log_hist_msec,
1640 .hist_coarseness = o->log_hist_coarseness,
1641 .log_type = IO_LOG_TYPE_IOPS,
1642 .log_offset = o->log_offset,
1643 .log_gz = o->log_gz,
1644 .log_gz_store = o->log_gz_store,
1646 const char *pre = make_log_name(o->iops_log_file, o->name);
1649 if (fio_option_is_set(o, iops_avg_time))
1650 p.avg_msec = min(o->log_avg_msec, o->iops_avg_time);
1652 o->iops_avg_time = p.avg_msec;
1654 p.hist_msec = o->log_hist_msec;
1655 p.hist_coarseness = o->log_hist_coarseness;
1662 gen_log_name(logname, sizeof(logname), "iops", pre,
1663 td->thread_number, suf, o->per_job_logs);
1664 setup_log(&td->iops_log, &p, logname);
1668 o->name = strdup(jobname);
1670 if (output_format & FIO_OUTPUT_NORMAL) {
1672 if (is_backend && !recursed)
1673 fio_server_send_add_job(td);
1675 if (!td_ioengine_flagged(td, FIO_NOIO)) {
1676 char *c1, *c2, *c3, *c4;
1677 char *c5 = NULL, *c6 = NULL;
1678 int i2p = is_power_of_2(o->kb_base);
1679 struct buf_output out;
1681 c1 = num2str(o->min_bs[DDIR_READ], o->sig_figs, 1, i2p, N2S_BYTE);
1682 c2 = num2str(o->max_bs[DDIR_READ], o->sig_figs, 1, i2p, N2S_BYTE);
1683 c3 = num2str(o->min_bs[DDIR_WRITE], o->sig_figs, 1, i2p, N2S_BYTE);
1684 c4 = num2str(o->max_bs[DDIR_WRITE], o->sig_figs, 1, i2p, N2S_BYTE);
1686 if (!o->bs_is_seq_rand) {
1687 c5 = num2str(o->min_bs[DDIR_TRIM], o->sig_figs, 1, i2p, N2S_BYTE);
1688 c6 = num2str(o->max_bs[DDIR_TRIM], o->sig_figs, 1, i2p, N2S_BYTE);
1691 buf_output_init(&out);
1692 __log_buf(&out, "%s: (g=%d): rw=%s, ", td->o.name,
1694 ddir_str(o->td_ddir));
1696 if (o->bs_is_seq_rand)
1697 __log_buf(&out, "bs=(R) %s-%s, (W) %s-%s, bs_is_seq_rand, ",
1700 __log_buf(&out, "bs=(R) %s-%s, (W) %s-%s, (T) %s-%s, ",
1701 c1, c2, c3, c4, c5, c6);
1703 __log_buf(&out, "ioengine=%s, iodepth=%u\n",
1704 td->io_ops->name, o->iodepth);
1705 log_info_buf(out.buf, out.buflen);
1706 buf_output_free(&out);
1715 } else if (job_add_num == 1)
1719 if (td_steadystate_init(td))
1722 if (o->merge_blktrace_file && !merge_blktrace_iologs(td))
1725 if (merge_blktrace_only) {
1731 * recurse add identical jobs, clear numjobs and stonewall options
1732 * as they don't apply to sub-jobs
1734 numjobs = o->numjobs;
1736 struct thread_data *td_new = get_new_job(false, td, true, jobname);
1741 td_new->o.numjobs = 1;
1742 td_new->o.stonewall = 0;
1743 td_new->o.new_group = 0;
1744 td_new->subjob_number = numjobs;
1745 td_new->o.ss_dur = o->ss_dur * 1000000l;
1746 td_new->o.ss_limit = o->ss_limit;
1749 if (td_new->files) {
1751 for_each_file(td_new, f, i) {
1753 sfree(f->file_name);
1756 free(td_new->files);
1757 td_new->files = NULL;
1759 td_new->files_index = 0;
1760 td_new->files_size = 0;
1761 if (td_new->o.filename) {
1762 free(td_new->o.filename);
1763 td_new->o.filename = NULL;
1767 if (add_job(td_new, jobname, numjobs, 1, client_type))
1778 * Parse as if 'o' was a command line
1780 void add_job_opts(const char **o, int client_type)
1782 struct thread_data *td, *td_parent;
1783 int i, in_global = 1;
1787 td_parent = td = NULL;
1789 if (!strncmp(o[i], "name", 4)) {
1792 add_job(td, jobname, 0, 0, client_type);
1794 sprintf(jobname, "%s", o[i] + 5);
1796 if (in_global && !td_parent)
1797 td_parent = get_new_job(true, &def_thread, false, jobname);
1798 else if (!in_global && !td) {
1800 td_parent = &def_thread;
1801 td = get_new_job(false, td_parent, false, jobname);
1804 fio_options_parse(td_parent, (char **) &o[i], 1);
1806 fio_options_parse(td, (char **) &o[i], 1);
1811 add_job(td, jobname, 0, 0, client_type);
1814 static int skip_this_section(const char *name)
1818 if (!nr_job_sections)
1820 if (!strncmp(name, "global", 6))
1823 for (i = 0; i < nr_job_sections; i++)
1824 if (!strcmp(job_sections[i], name))
1830 static int is_empty_or_comment(char *line)
1834 for (i = 0; i < strlen(line); i++) {
1839 if (!isspace((int) line[i]) && !iscntrl((int) line[i]))
1847 * This is our [ini] type file parser.
1849 static int __parse_jobs_ini(struct thread_data *td,
1850 char *file, int is_buf, int stonewall_flag, int type,
1851 int nested, char *name, char ***popts, int *aopts, int *nopts)
1853 bool global = false;
1857 int ret = 0, stonewall;
1860 int inside_skip = 0;
1862 int i, alloc_opts, num_opts;
1864 dprint(FD_PARSE, "Parsing ini file %s\n", file);
1865 assert(td || !nested);
1870 if (!strcmp(file, "-"))
1873 f = fopen(file, "r");
1878 log_err("fio: unable to open '%s' job file\n", file);
1880 td_verror(td, __err, "job file open");
1885 string = malloc(OPT_LEN_MAX);
1888 * it's really 256 + small bit, 280 should suffice
1892 memset(name, 0, 280);
1896 if (nested && popts) {
1898 alloc_opts = *aopts;
1904 opts = malloc(sizeof(char *) * alloc_opts);
1908 stonewall = stonewall_flag;
1911 * if skip_fgets is set, we already have loaded a line we
1916 p = strsep(&file, "\n");
1918 p = fgets(string, OPT_LEN_MAX, f);
1924 strip_blank_front(&p);
1927 dprint(FD_PARSE, "%s\n", p);
1928 if (is_empty_or_comment(p))
1932 if (sscanf(p, "[%255[^\n]]", name) != 1) {
1936 log_err("fio: option <%s> outside of "
1937 "[] job section\n", p);
1942 name[strlen(name) - 1] = '\0';
1944 if (skip_this_section(name)) {
1950 dprint(FD_PARSE, "Parsing section [%s]\n", name);
1952 global = !strncmp(name, "global", 6);
1958 log_info("--name=%s ", name);
1962 td = get_new_job(global, &def_thread, false, name);
1969 * Separate multiple job files by a stonewall
1971 if (!global && stonewall) {
1972 td->o.stonewall = stonewall;
1977 memset(opts, 0, alloc_opts * sizeof(char *));
1985 p = strsep(&file, "\n");
1987 p = fgets(string, OPT_LEN_MAX, f);
1990 dprint(FD_PARSE, "%s", p);
1995 if (is_empty_or_comment(p))
1998 strip_blank_front(&p);
2001 * new section, break out and make sure we don't
2002 * fgets() a new line at the top.
2006 log_err("No new sections in included files\n");
2017 if (!strncmp(p, "include", strlen("include"))) {
2018 char *filename = p + strlen("include") + 1,
2019 *ts, *full_fn = NULL;
2022 * Allow for the include filename
2023 * specification to be relative.
2025 if (access(filename, F_OK) &&
2026 (ts = strrchr(file, '/'))) {
2027 if (asprintf(&full_fn, "%.*s%s",
2028 (int)(ts - file + 1), file,
2036 ret = __parse_jobs_ini(td, filename, is_buf,
2037 stonewall_flag, type, 1,
2039 &alloc_opts, &num_opts);
2042 log_err("Error %d while parsing "
2043 "include file %s\n",
2056 if (num_opts == alloc_opts) {
2058 opts = realloc(opts,
2059 alloc_opts * sizeof(char *));
2062 opts[num_opts] = strdup(p);
2068 *aopts = alloc_opts;
2073 ret = fio_options_parse(td, opts, num_opts);
2078 ret = add_job(td, name, 0, 0, type);
2080 log_err("fio: job %s dropped\n", name);
2084 for (i = 0; i < num_opts; i++)
2093 while (i < nr_job_sections) {
2094 free(job_sections[i]);
2103 if (!is_buf && f != stdin)
2108 int parse_jobs_ini(char *file, int is_buf, int stonewall_flag, int type)
2110 return __parse_jobs_ini(NULL, file, is_buf, stonewall_flag, type,
2111 0, NULL, NULL, NULL, NULL);
2114 static int fill_def_thread(void)
2116 memset(&def_thread, 0, sizeof(def_thread));
2117 INIT_FLIST_HEAD(&def_thread.opt_list);
2119 fio_getaffinity(getpid(), &def_thread.o.cpumask);
2120 def_thread.o.error_dump = 1;
2123 * fill default options
2125 fio_fill_default_options(&def_thread);
2129 static void show_debug_categories(void)
2131 #ifdef FIO_INC_DEBUG
2132 const struct debug_level *dl = &debug_levels[0];
2133 int curlen, first = 1;
2137 int has_next = (dl + 1)->name != NULL;
2139 if (first || curlen + strlen(dl->name) >= 80) {
2144 curlen += printf("\t\t\t%s", dl->name);
2145 curlen += 3 * (8 - 1);
2147 curlen += printf(",");
2149 curlen += printf("%s", dl->name);
2151 curlen += printf(",");
2161 * Following options aren't printed by usage().
2162 * --append-terse - Equivalent to --output-format=terse, see f6a7df53.
2163 * --latency-log - Deprecated option.
2165 static void usage(const char *name)
2167 printf("%s\n", fio_version_string);
2168 printf("%s [options] [job options] <job file(s)>\n", name);
2169 printf(" --debug=options\tEnable debug logging. May be one/more of:\n");
2170 show_debug_categories();
2171 printf(" --parse-only\t\tParse options only, don't start any IO\n");
2172 printf(" --merge-blktrace-only\tMerge blktraces only, don't start any IO\n");
2173 printf(" --output\t\tWrite output to file\n");
2174 printf(" --bandwidth-log\tGenerate aggregate bandwidth logs\n");
2175 printf(" --minimal\t\tMinimal (terse) output\n");
2176 printf(" --output-format=type\tOutput format (terse,json,json+,normal)\n");
2177 printf(" --terse-version=type\tSet terse version output format"
2178 " (default 3, or 2 or 4)\n");
2179 printf(" --version\t\tPrint version info and exit\n");
2180 printf(" --help\t\tPrint this page\n");
2181 printf(" --cpuclock-test\tPerform test/validation of CPU clock\n");
2182 printf(" --crctest=[type]\tTest speed of checksum functions\n");
2183 printf(" --cmdhelp=cmd\t\tPrint command help, \"all\" for all of"
2185 printf(" --enghelp=engine\tPrint ioengine help, or list"
2186 " available ioengines\n");
2187 printf(" --enghelp=engine,cmd\tPrint help for an ioengine"
2189 printf(" --showcmd\t\tTurn a job file into command line options\n");
2190 printf(" --eta=when\t\tWhen ETA estimate should be printed\n");
2191 printf(" \t\tMay be \"always\", \"never\" or \"auto\"\n");
2192 printf(" --eta-newline=t\tForce a new line for every 't'");
2193 printf(" period passed\n");
2194 printf(" --status-interval=t\tForce full status dump every");
2195 printf(" 't' period passed\n");
2196 printf(" --readonly\t\tTurn on safety read-only checks, preventing"
2198 printf(" --section=name\tOnly run specified section in job file,"
2199 " multiple sections can be specified\n");
2200 printf(" --alloc-size=kb\tSet smalloc pool to this size in kb"
2202 printf(" --warnings-fatal\tFio parser warnings are fatal\n");
2203 printf(" --max-jobs=nr\t\tMaximum number of threads/processes to support\n");
2204 printf(" --server=args\t\tStart a backend fio server\n");
2205 printf(" --daemonize=pidfile\tBackground fio server, write pid to file\n");
2206 printf(" --client=hostname\tTalk to remote backend(s) fio server at hostname\n");
2207 printf(" --remote-config=file\tTell fio server to load this local job file\n");
2208 printf(" --idle-prof=option\tReport cpu idleness on a system or percpu basis\n"
2209 "\t\t\t(option=system,percpu) or run unit work\n"
2210 "\t\t\tcalibration only (option=calibrate)\n");
2212 printf(" --inflate-log=log\tInflate and output compressed log\n");
2214 printf(" --trigger-file=file\tExecute trigger cmd when file exists\n");
2215 printf(" --trigger-timeout=t\tExecute trigger at this time\n");
2216 printf(" --trigger=cmd\t\tSet this command as local trigger\n");
2217 printf(" --trigger-remote=cmd\tSet this command as remote trigger\n");
2218 printf(" --aux-path=path\tUse this path for fio state generated files\n");
2219 printf("\nFio was written by Jens Axboe <axboe@kernel.dk>\n");
2222 #ifdef FIO_INC_DEBUG
2223 const struct debug_level debug_levels[] = {
2224 { .name = "process",
2225 .help = "Process creation/exit logging",
2226 .shift = FD_PROCESS,
2229 .help = "File related action logging",
2233 .help = "IO and IO engine action logging (offsets, queue, completions, etc)",
2237 .help = "Memory allocation/freeing logging",
2240 { .name = "blktrace",
2241 .help = "blktrace action logging",
2242 .shift = FD_BLKTRACE,
2245 .help = "IO verification action logging",
2249 .help = "Random generation logging",
2253 .help = "Parser logging",
2256 { .name = "diskutil",
2257 .help = "Disk utility logging actions",
2258 .shift = FD_DISKUTIL,
2261 .help = "Logging related to creating/destroying jobs",
2265 .help = "Mutex logging",
2268 { .name = "profile",
2269 .help = "Logging related to profiles",
2270 .shift = FD_PROFILE,
2273 .help = "Logging related to time keeping functions",
2277 .help = "Network logging",
2281 .help = "Rate logging",
2284 { .name = "compress",
2285 .help = "Log compression logging",
2286 .shift = FD_COMPRESS,
2288 { .name = "steadystate",
2289 .help = "Steady state detection logging",
2290 .shift = FD_STEADYSTATE,
2292 { .name = "helperthread",
2293 .help = "Helper thread logging",
2294 .shift = FD_HELPERTHREAD,
2297 .help = "Zoned Block Device logging",
2303 static int set_debug(const char *string)
2305 const struct debug_level *dl;
2306 char *p = (char *) string;
2313 if (!strcmp(string, "?") || !strcmp(string, "help")) {
2314 log_info("fio: dumping debug options:");
2315 for (i = 0; debug_levels[i].name; i++) {
2316 dl = &debug_levels[i];
2317 log_info("%s,", dl->name);
2323 while ((opt = strsep(&p, ",")) != NULL) {
2326 if (!strncmp(opt, "all", 3)) {
2327 log_info("fio: set all debug options\n");
2332 for (i = 0; debug_levels[i].name; i++) {
2333 dl = &debug_levels[i];
2334 found = !strncmp(opt, dl->name, strlen(dl->name));
2338 if (dl->shift == FD_JOB) {
2339 opt = strchr(opt, ':');
2341 log_err("fio: missing job number\n");
2345 fio_debug_jobno = atoi(opt);
2346 log_info("fio: set debug jobno %d\n",
2349 log_info("fio: set debug option %s\n", opt);
2350 fio_debug |= (1UL << dl->shift);
2356 log_err("fio: debug mask %s not found\n", opt);
2361 static int set_debug(const char *string)
2363 log_err("fio: debug tracing not included in build\n");
2368 static void fio_options_fill_optstring(void)
2370 char *ostr = cmd_optstr;
2374 while (l_opts[i].name) {
2375 ostr[c++] = l_opts[i].val;
2376 if (l_opts[i].has_arg == required_argument)
2378 else if (l_opts[i].has_arg == optional_argument) {
2387 static int client_flag_set(char c)
2392 while (l_opts[i].name) {
2393 int val = l_opts[i].val;
2395 if (c == (val & 0xff))
2396 return (val & FIO_CLIENT_FLAG);
2404 static void parse_cmd_client(void *client, char *opt)
2406 fio_client_add_cmd_option(client, opt);
2409 static void show_closest_option(const char *name)
2411 int best_option, best_distance;
2414 while (*name == '-')
2418 best_distance = INT_MAX;
2420 while (l_opts[i].name) {
2421 distance = string_distance(name, l_opts[i].name);
2422 if (distance < best_distance) {
2423 best_distance = distance;
2429 if (best_option != -1 && string_distance_ok(name, best_distance))
2430 log_err("Did you mean %s?\n", l_opts[best_option].name);
2433 static int parse_output_format(const char *optarg)
2435 char *p, *orig, *opt;
2438 p = orig = strdup(optarg);
2442 while ((opt = strsep(&p, ",")) != NULL) {
2443 if (!strcmp(opt, "minimal") ||
2444 !strcmp(opt, "terse") ||
2445 !strcmp(opt, "csv"))
2446 output_format |= FIO_OUTPUT_TERSE;
2447 else if (!strcmp(opt, "json"))
2448 output_format |= FIO_OUTPUT_JSON;
2449 else if (!strcmp(opt, "json+"))
2450 output_format |= (FIO_OUTPUT_JSON | FIO_OUTPUT_JSON_PLUS);
2451 else if (!strcmp(opt, "normal"))
2452 output_format |= FIO_OUTPUT_NORMAL;
2454 log_err("fio: invalid output format %s\n", opt);
2464 int parse_cmd_line(int argc, char *argv[], int client_type)
2466 struct thread_data *td = NULL;
2467 int c, ini_idx = 0, lidx, ret = 0, do_exit = 0, exit_val = 0;
2468 char *ostr = cmd_optstr;
2469 char *pid_file = NULL;
2470 void *cur_client = NULL;
2471 bool backend = false;
2474 * Reset optind handling, since we may call this multiple times
2479 while ((c = getopt_long_only(argc, argv, ostr, l_opts, &lidx)) != -1) {
2480 if ((c & FIO_CLIENT_FLAG) || client_flag_set(c)) {
2481 parse_cmd_client(cur_client, argv[optind - 1]);
2482 c &= ~FIO_CLIENT_FLAG;
2487 smalloc_pool_size = atoi(optarg);
2488 smalloc_pool_size <<= 10;
2492 log_err("fio: --latency-log is deprecated. Use per-job latency log options.\n");
2497 write_bw_log = true;
2502 if (f_out && f_out != stdout)
2505 tmp = fopen(optarg, "w+");
2507 log_err("fio: output file open error: %s\n", strerror(errno));
2512 f_err = f_out = tmp;
2516 output_format = FIO_OUTPUT_TERSE;
2519 if (parse_output_format(optarg)) {
2520 log_err("fio: failed parsing output-format\n");
2527 output_format |= FIO_OUTPUT_TERSE;
2539 fio_show_option_help(optarg);
2546 fio_show_ioengine_help(optarg);
2552 dump_cmdline = true;
2560 log_info("%s\n", fio_version_string);
2565 terse_version = atoi(optarg);
2566 if (!(terse_version >= 2 && terse_version <= 5)) {
2567 log_err("fio: bad terse version format\n");
2573 if (!strcmp("always", optarg))
2574 eta_print = FIO_ETA_ALWAYS;
2575 else if (!strcmp("never", optarg))
2576 eta_print = FIO_ETA_NEVER;
2581 if (check_str_time(optarg, &t, 1)) {
2582 log_err("fio: failed parsing eta time %s\n", optarg);
2587 eta_new_line = t / 1000;
2588 if (!eta_new_line) {
2589 log_err("fio: eta new line time too short\n");
2598 if (check_str_time(optarg, &t, 1)) {
2599 log_err("fio: failed parsing eta interval %s\n", optarg);
2604 eta_interval_msec = t / 1000;
2605 if (eta_interval_msec < DISK_UTIL_MSEC) {
2606 log_err("fio: eta interval time too short (%umsec min)\n", DISK_UTIL_MSEC);
2613 if (set_debug(optarg))
2623 if (!strcmp(optarg, "global")) {
2624 log_err("fio: can't use global as only "
2630 new_size = (nr_job_sections + 1) * sizeof(char *);
2631 job_sections = realloc(job_sections, new_size);
2632 job_sections[nr_job_sections] = strdup(optarg);
2638 exit_val = iolog_file_inflate(optarg);
2647 exec_profile = strdup(optarg);
2649 case FIO_GETOPT_JOB: {
2650 const char *opt = l_opts[lidx].name;
2653 if (!strncmp(opt, "name", 4) && td) {
2654 ret = add_job(td, td->o.name ?: "fio", 0, 0, client_type);
2661 int is_section = !strncmp(opt, "name", 4);
2664 if (!is_section || !strncmp(val, "global", 6))
2667 if (is_section && skip_this_section(val))
2670 td = get_new_job(global, &def_thread, true, NULL);
2671 if (!td || ioengine_load(td)) {
2680 fio_options_set_ioengine_opts(l_opts, td);
2683 if ((!val || !strlen(val)) &&
2684 l_opts[lidx].has_arg == required_argument) {
2685 log_err("fio: option %s requires an argument\n", opt);
2688 ret = fio_cmd_option_parse(td, opt, val);
2699 if (!ret && !strcmp(opt, "ioengine")) {
2700 if (ioengine_load(td)) {
2707 fio_options_set_ioengine_opts(l_opts, td);
2711 case FIO_GETOPT_IOENGINE: {
2712 const char *opt = l_opts[lidx].name;
2718 ret = fio_cmd_ioengine_option_parse(td, opt, val);
2725 max_jobs = atoi(optarg);
2726 if (!max_jobs || max_jobs > REAL_MAX_JOBS) {
2727 log_err("fio: invalid max jobs: %d\n", max_jobs);
2734 #ifndef CONFIG_NO_SHM
2736 log_err("fio: can't be both client and server\n");
2742 fio_server_set_arg(optarg);
2746 log_err("fio: client/server requires SHM support\n");
2754 pid_file = strdup(optarg);
2757 if ((ret = fio_idle_prof_parse_opt(optarg))) {
2758 /* exit on error and calibration only */
2768 log_err("fio: can't be both client and server\n");
2773 /* if --client parameter contains a pathname */
2774 if (0 == access(optarg, R_OK)) {
2775 /* file contains a list of host addrs or names */
2776 char hostaddr[PATH_MAX] = {0};
2778 FILE * hostf = fopen(optarg, "r");
2780 log_err("fio: could not open client list file %s for read\n", optarg);
2785 sprintf(formatstr, "%%%ds", PATH_MAX - 1);
2787 * read at most PATH_MAX-1 chars from each
2788 * record in this file
2790 while (fscanf(hostf, formatstr, hostaddr) == 1) {
2791 /* expect EVERY host in file to be valid */
2792 if (fio_client_add(&fio_client_ops, hostaddr, &cur_client)) {
2793 log_err("fio: failed adding client %s from file %s\n", hostaddr, optarg);
2800 break; /* no possibility of job file for "this client only" */
2802 if (fio_client_add(&fio_client_ops, optarg, &cur_client)) {
2803 log_err("fio: failed adding client %s\n", optarg);
2809 * If the next argument exists and isn't an option,
2810 * assume it's a job file for this client only.
2812 while (optind < argc) {
2813 if (!strncmp(argv[optind], "--", 2) ||
2814 !strncmp(argv[optind], "-", 1))
2817 if (fio_client_add_ini_file(cur_client, argv[optind], false))
2824 if (fio_client_add_ini_file(cur_client, optarg, true)) {
2832 exit_val = fio_monotonic_clocktest(1);
2837 exit_val = fio_crctest(optarg);
2842 exit_val = fio_memcpy_test(optarg);
2847 if (check_str_time(optarg, &val, 1)) {
2848 log_err("fio: failed parsing time %s\n", optarg);
2854 log_err("fio: status interval too small\n");
2858 status_interval = val / 1000;
2864 trigger_file = strdup(optarg);
2869 trigger_cmd = strdup(optarg);
2872 if (trigger_remote_cmd)
2873 free(trigger_remote_cmd);
2874 trigger_remote_cmd = strdup(optarg);
2879 aux_path = strdup(optarg);
2882 if (check_str_time(optarg, &trigger_timeout, 1)) {
2883 log_err("fio: failed parsing time %s\n", optarg);
2887 trigger_timeout /= 1000000;
2892 merge_blktrace_only = true;
2895 log_err("%s: unrecognized option '%s'\n", argv[0],
2897 show_closest_option(argv[optind - 1]);
2908 if (do_exit && !(is_backend || nr_clients))
2911 if (nr_clients && fio_clients_connect())
2914 if (is_backend && backend)
2915 return fio_start_server(pid_file);
2921 ret = add_job(td, td->o.name ?: "fio", 0, 0, client_type);
2927 while (!ret && optind < argc) {
2929 ini_file = realloc(ini_file, ini_idx * sizeof(char *));
2930 ini_file[ini_idx - 1] = strdup(argv[optind]);
2938 int fio_init_options(void)
2943 fio_options_fill_optstring();
2944 fio_options_dup_and_init(l_opts);
2948 if (fill_def_thread())
2954 extern int fio_check_options(struct thread_options *);
2956 int parse_options(int argc, char *argv[])
2958 const int type = FIO_CLIENT_TYPE_CLI;
2961 if (fio_init_options())
2963 if (fio_test_cconv(&def_thread.o))
2964 log_err("fio: failed internal cconv test\n");
2966 job_files = parse_cmd_line(argc, argv, type);
2968 if (job_files > 0) {
2969 for (i = 0; i < job_files; i++) {
2970 if (i && fill_def_thread())
2973 if (fio_clients_send_ini(ini_file[i]))
2976 } else if (!is_backend) {
2977 if (parse_jobs_ini(ini_file[i], 0, i, type))
2982 } else if (nr_clients) {
2983 if (fill_def_thread())
2985 if (fio_clients_send_ini(NULL))
2990 fio_options_free(&def_thread);
2991 filesetup_mem_free();
2993 if (!thread_number) {
2998 if (is_backend || nr_clients)
3003 log_err("No job(s) defined\n\n");
3008 if (output_format & FIO_OUTPUT_NORMAL)
3009 log_info("%s\n", fio_version_string);
3014 void options_default_fill(struct thread_options *o)
3016 memcpy(o, &def_thread.o, sizeof(*o));
3019 struct thread_data *get_global_options(void)