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"
34 #include "oslib/getopt.h"
35 #include "oslib/strcasestr.h"
39 #include "lib/memcpy.h"
41 const char fio_version_string[] = FIO_VERSION;
43 #define FIO_RANDSEED (0xb1899bedUL)
45 static char **ini_file;
46 static int max_jobs = FIO_MAX_JOBS;
47 static int dump_cmdline;
48 static int parse_only;
50 static struct thread_data def_thread;
51 struct thread_data *threads = NULL;
52 static char **job_sections;
53 static int nr_job_sections;
55 int exitall_on_terminate = 0;
56 int output_format = FIO_OUTPUT_NORMAL;
57 int eta_print = FIO_ETA_AUTO;
58 unsigned int eta_interval_msec = 1000;
62 char *exec_profile = NULL;
63 int warnings_fatal = 0;
64 int terse_version = 3;
66 int is_local_backend = 0;
72 int status_interval = 0;
74 char *trigger_file = NULL;
75 long long trigger_timeout = 0;
76 char *trigger_cmd = NULL;
77 char *trigger_remote_cmd = NULL;
79 char *aux_path = NULL;
81 static int prev_group_jobs;
83 unsigned long fio_debug = 0;
84 unsigned int fio_debug_jobno = -1;
85 unsigned int *fio_debug_jobp = NULL;
86 unsigned int *fio_warned = NULL;
88 static char cmd_optstr[256];
91 #define FIO_CLIENT_FLAG (1 << 16)
94 * Command line options. These will contain the above, plus a few
95 * extra that only pertain to fio itself and not jobs.
97 static struct option l_opts[FIO_NR_OPTIONS] = {
99 .name = (char *) "output",
100 .has_arg = required_argument,
101 .val = 'o' | FIO_CLIENT_FLAG,
104 .name = (char *) "latency-log",
105 .has_arg = required_argument,
106 .val = 'l' | FIO_CLIENT_FLAG,
109 .name = (char *) "bandwidth-log",
110 .has_arg = no_argument,
111 .val = 'b' | FIO_CLIENT_FLAG,
114 .name = (char *) "minimal",
115 .has_arg = no_argument,
116 .val = 'm' | FIO_CLIENT_FLAG,
119 .name = (char *) "output-format",
120 .has_arg = required_argument,
121 .val = 'F' | FIO_CLIENT_FLAG,
124 .name = (char *) "append-terse",
125 .has_arg = optional_argument,
129 .name = (char *) "version",
130 .has_arg = no_argument,
131 .val = 'v' | FIO_CLIENT_FLAG,
134 .name = (char *) "help",
135 .has_arg = no_argument,
136 .val = 'h' | FIO_CLIENT_FLAG,
139 .name = (char *) "cmdhelp",
140 .has_arg = optional_argument,
141 .val = 'c' | FIO_CLIENT_FLAG,
144 .name = (char *) "enghelp",
145 .has_arg = optional_argument,
146 .val = 'i' | FIO_CLIENT_FLAG,
149 .name = (char *) "showcmd",
150 .has_arg = no_argument,
151 .val = 's' | FIO_CLIENT_FLAG,
154 .name = (char *) "readonly",
155 .has_arg = no_argument,
156 .val = 'r' | FIO_CLIENT_FLAG,
159 .name = (char *) "eta",
160 .has_arg = required_argument,
161 .val = 'e' | FIO_CLIENT_FLAG,
164 .name = (char *) "eta-interval",
165 .has_arg = required_argument,
166 .val = 'O' | FIO_CLIENT_FLAG,
169 .name = (char *) "eta-newline",
170 .has_arg = required_argument,
171 .val = 'E' | FIO_CLIENT_FLAG,
174 .name = (char *) "debug",
175 .has_arg = required_argument,
176 .val = 'd' | FIO_CLIENT_FLAG,
179 .name = (char *) "parse-only",
180 .has_arg = no_argument,
181 .val = 'P' | FIO_CLIENT_FLAG,
184 .name = (char *) "section",
185 .has_arg = required_argument,
186 .val = 'x' | FIO_CLIENT_FLAG,
190 .name = (char *) "inflate-log",
191 .has_arg = required_argument,
192 .val = 'X' | FIO_CLIENT_FLAG,
196 .name = (char *) "alloc-size",
197 .has_arg = required_argument,
198 .val = 'a' | FIO_CLIENT_FLAG,
201 .name = (char *) "profile",
202 .has_arg = required_argument,
203 .val = 'p' | FIO_CLIENT_FLAG,
206 .name = (char *) "warnings-fatal",
207 .has_arg = no_argument,
208 .val = 'w' | FIO_CLIENT_FLAG,
211 .name = (char *) "max-jobs",
212 .has_arg = required_argument,
213 .val = 'j' | FIO_CLIENT_FLAG,
216 .name = (char *) "terse-version",
217 .has_arg = required_argument,
218 .val = 'V' | FIO_CLIENT_FLAG,
221 .name = (char *) "server",
222 .has_arg = optional_argument,
225 { .name = (char *) "daemonize",
226 .has_arg = required_argument,
230 .name = (char *) "client",
231 .has_arg = required_argument,
235 .name = (char *) "remote-config",
236 .has_arg = required_argument,
240 .name = (char *) "cpuclock-test",
241 .has_arg = no_argument,
245 .name = (char *) "crctest",
246 .has_arg = optional_argument,
250 .name = (char *) "memcpytest",
251 .has_arg = optional_argument,
255 .name = (char *) "idle-prof",
256 .has_arg = required_argument,
260 .name = (char *) "status-interval",
261 .has_arg = required_argument,
262 .val = 'L' | FIO_CLIENT_FLAG,
265 .name = (char *) "trigger-file",
266 .has_arg = required_argument,
270 .name = (char *) "trigger-timeout",
271 .has_arg = required_argument,
275 .name = (char *) "trigger",
276 .has_arg = required_argument,
280 .name = (char *) "trigger-remote",
281 .has_arg = required_argument,
285 .name = (char *) "aux-path",
286 .has_arg = required_argument,
294 void free_threads_shm(void)
298 #ifndef CONFIG_NO_SHM
299 struct shmid_ds sbuf;
303 shmctl(shm_id, IPC_RMID, &sbuf);
312 static void free_shm(void)
316 fio_debug_jobp = NULL;
323 free(trigger_remote_cmd);
324 trigger_file = trigger_cmd = trigger_remote_cmd = NULL;
326 options_free(fio_options, &def_thread.o);
333 * The thread area is shared between the main process and the job
334 * threads/processes. So setup a shared memory segment that will hold
335 * all the job info. We use the end of the region for keeping track of
336 * open files across jobs, for file sharing.
338 static int setup_thread_area(void)
346 * 1024 is too much on some machines, scale max_jobs if
347 * we get a failure that looks like too large a shm segment
350 size_t size = max_jobs * sizeof(struct thread_data);
352 size += 2 * sizeof(unsigned int);
354 #ifndef CONFIG_NO_SHM
355 shm_id = shmget(0, size, IPC_CREAT | 0600);
358 if (errno != EINVAL && errno != ENOMEM && errno != ENOSPC) {
363 threads = malloc(size);
371 #ifndef CONFIG_NO_SHM
375 threads = shmat(shm_id, NULL, 0);
376 if (threads == (void *) -1) {
380 if (shm_attach_to_open_removed())
381 shmctl(shm_id, IPC_RMID, NULL);
384 memset(threads, 0, max_jobs * sizeof(struct thread_data));
385 for (i = 0; i < max_jobs; i++)
386 DRD_IGNORE_VAR(threads[i]);
387 fio_debug_jobp = (unsigned int *)(threads + max_jobs);
388 *fio_debug_jobp = -1;
389 fio_warned = fio_debug_jobp + 1;
397 static void dump_print_option(struct print_option *p)
401 if (!strcmp("description", p->name))
406 log_info("--%s%s", p->name, p->value ? "" : " ");
408 log_info("=%s%s%s ", delim, p->value, delim);
411 static void dump_opt_list(struct thread_data *td)
413 struct flist_head *entry;
414 struct print_option *p;
416 if (flist_empty(&td->opt_list))
419 flist_for_each(entry, &td->opt_list) {
420 p = flist_entry(entry, struct print_option, list);
421 dump_print_option(p);
425 static void fio_dump_options_free(struct thread_data *td)
427 while (!flist_empty(&td->opt_list)) {
428 struct print_option *p;
430 p = flist_first_entry(&td->opt_list, struct print_option, list);
431 flist_del_init(&p->list);
438 static void copy_opt_list(struct thread_data *dst, struct thread_data *src)
440 struct flist_head *entry;
442 if (flist_empty(&src->opt_list))
445 flist_for_each(entry, &src->opt_list) {
446 struct print_option *srcp, *dstp;
448 srcp = flist_entry(entry, struct print_option, list);
449 dstp = malloc(sizeof(*dstp));
450 dstp->name = strdup(srcp->name);
452 dstp->value = strdup(srcp->value);
455 flist_add_tail(&dstp->list, &dst->opt_list);
460 * Return a free job structure.
462 static struct thread_data *get_new_job(bool global, struct thread_data *parent,
463 bool preserve_eo, const char *jobname)
465 struct thread_data *td;
469 if (setup_thread_area()) {
470 log_err("error: failed to setup shm segment\n");
473 if (thread_number >= max_jobs) {
474 log_err("error: maximum number of jobs (%d) reached.\n",
479 td = &threads[thread_number++];
482 INIT_FLIST_HEAD(&td->opt_list);
483 if (parent != &def_thread)
484 copy_opt_list(td, parent);
491 td->o.uid = td->o.gid = -1U;
493 dup_files(td, parent);
494 fio_options_mem_dupe(td);
496 profile_add_hooks(td);
498 td->thread_number = thread_number;
499 td->subjob_number = 0;
502 td->o.name = strdup(jobname);
504 if (!parent->o.group_reporting || parent == &def_thread)
510 static void put_job(struct thread_data *td)
512 if (td == &def_thread)
519 log_info("fio: %s\n", td->verror);
521 fio_options_free(td);
522 fio_dump_options_free(td);
529 memset(&threads[td->thread_number - 1], 0, sizeof(*td));
533 static int __setup_rate(struct thread_data *td, enum fio_ddir ddir)
535 unsigned long long bs = td->o.min_bs[ddir];
537 assert(ddir_rw(ddir));
539 if (td->o.rate[ddir])
540 td->rate_bps[ddir] = td->o.rate[ddir];
542 td->rate_bps[ddir] = (uint64_t) td->o.rate_iops[ddir] * bs;
544 if (!td->rate_bps[ddir]) {
545 log_err("rate lower than supported\n");
549 td->rate_next_io_time[ddir] = 0;
550 td->rate_io_issue_bytes[ddir] = 0;
551 td->last_usec[ddir] = 0;
555 static int setup_rate(struct thread_data *td)
559 if (td->o.rate[DDIR_READ] || td->o.rate_iops[DDIR_READ])
560 ret = __setup_rate(td, DDIR_READ);
561 if (td->o.rate[DDIR_WRITE] || td->o.rate_iops[DDIR_WRITE])
562 ret |= __setup_rate(td, DDIR_WRITE);
563 if (td->o.rate[DDIR_TRIM] || td->o.rate_iops[DDIR_TRIM])
564 ret |= __setup_rate(td, DDIR_TRIM);
569 static int fixed_block_size(struct thread_options *o)
571 return o->min_bs[DDIR_READ] == o->max_bs[DDIR_READ] &&
572 o->min_bs[DDIR_WRITE] == o->max_bs[DDIR_WRITE] &&
573 o->min_bs[DDIR_TRIM] == o->max_bs[DDIR_TRIM] &&
574 o->min_bs[DDIR_READ] == o->min_bs[DDIR_WRITE] &&
575 o->min_bs[DDIR_READ] == o->min_bs[DDIR_TRIM];
581 static unsigned int gcd(unsigned int m, unsigned int n)
586 return gcd(n, m % n);
590 * Lazy way of fixing up options that depend on each other. We could also
591 * define option callback handlers, but this is easier.
593 static int fixup_options(struct thread_data *td)
595 struct thread_options *o = &td->o;
598 if (read_only && (td_write(td) || td_trim(td))) {
599 log_err("fio: trim and write operations are not allowed"
600 " with the --readonly parameter.\n");
604 #ifndef CONFIG_PSHARED
605 if (!o->use_thread) {
606 log_info("fio: this platform does not support process shared"
607 " mutexes, forcing use of threads. Use the 'thread'"
608 " option to get rid of this warning.\n");
610 ret |= warnings_fatal;
614 if (o->write_iolog_file && o->read_iolog_file) {
615 log_err("fio: read iolog overrides write_iolog\n");
616 free(o->write_iolog_file);
617 o->write_iolog_file = NULL;
618 ret |= warnings_fatal;
621 if (o->zone_mode == ZONE_MODE_NONE && o->zone_size) {
622 log_err("fio: --zonemode=none and --zonesize are not compatible.\n");
626 if (o->zone_mode == ZONE_MODE_STRIDED && !o->zone_size) {
627 log_err("fio: --zonesize must be specified when using --zonemode=strided.\n");
631 if (o->zone_mode == ZONE_MODE_NOT_SPECIFIED) {
633 o->zone_mode = ZONE_MODE_STRIDED;
635 o->zone_mode = ZONE_MODE_NONE;
639 * Strided zone mode only really works with 1 file.
641 if (o->zone_mode == ZONE_MODE_STRIDED && o->open_files > 1)
642 o->zone_mode = ZONE_MODE_NONE;
645 * If zone_range isn't specified, backward compatibility dictates it
646 * should be made equal to zone_size.
648 if (o->zone_mode == ZONE_MODE_STRIDED && !o->zone_range)
649 o->zone_range = o->zone_size;
652 * Reads can do overwrites, we always need to pre-create the file
657 if (!o->min_bs[DDIR_READ])
658 o->min_bs[DDIR_READ] = o->bs[DDIR_READ];
659 if (!o->max_bs[DDIR_READ])
660 o->max_bs[DDIR_READ] = o->bs[DDIR_READ];
661 if (!o->min_bs[DDIR_WRITE])
662 o->min_bs[DDIR_WRITE] = o->bs[DDIR_WRITE];
663 if (!o->max_bs[DDIR_WRITE])
664 o->max_bs[DDIR_WRITE] = o->bs[DDIR_WRITE];
665 if (!o->min_bs[DDIR_TRIM])
666 o->min_bs[DDIR_TRIM] = o->bs[DDIR_TRIM];
667 if (!o->max_bs[DDIR_TRIM])
668 o->max_bs[DDIR_TRIM] = o->bs[DDIR_TRIM];
670 o->rw_min_bs = min(o->min_bs[DDIR_READ], o->min_bs[DDIR_WRITE]);
671 o->rw_min_bs = min(o->min_bs[DDIR_TRIM], o->rw_min_bs);
674 * For random IO, allow blockalign offset other than min_bs.
676 if (!o->ba[DDIR_READ] || !td_random(td))
677 o->ba[DDIR_READ] = o->min_bs[DDIR_READ];
678 if (!o->ba[DDIR_WRITE] || !td_random(td))
679 o->ba[DDIR_WRITE] = o->min_bs[DDIR_WRITE];
680 if (!o->ba[DDIR_TRIM] || !td_random(td))
681 o->ba[DDIR_TRIM] = o->min_bs[DDIR_TRIM];
683 if ((o->ba[DDIR_READ] != o->min_bs[DDIR_READ] ||
684 o->ba[DDIR_WRITE] != o->min_bs[DDIR_WRITE] ||
685 o->ba[DDIR_TRIM] != o->min_bs[DDIR_TRIM]) &&
687 log_err("fio: Any use of blockalign= turns off randommap\n");
689 ret |= warnings_fatal;
692 if (!o->file_size_high)
693 o->file_size_high = o->file_size_low;
695 if (o->start_delay_high) {
696 if (!o->start_delay_orig)
697 o->start_delay_orig = o->start_delay;
698 o->start_delay = rand_between(&td->delay_state,
700 o->start_delay_high);
703 if (o->norandommap && o->verify != VERIFY_NONE
704 && !fixed_block_size(o)) {
705 log_err("fio: norandommap given for variable block sizes, "
707 ret |= warnings_fatal;
709 if (o->bs_unaligned && (o->odirect || td_ioengine_flagged(td, FIO_RAWIO)))
710 log_err("fio: bs_unaligned may not work with raw io\n");
713 * thinktime_spin must be less than thinktime
715 if (o->thinktime_spin > o->thinktime)
716 o->thinktime_spin = o->thinktime;
719 * The low water mark cannot be bigger than the iodepth
721 if (o->iodepth_low > o->iodepth || !o->iodepth_low)
722 o->iodepth_low = o->iodepth;
725 * If batch number isn't set, default to the same as iodepth
727 if (o->iodepth_batch > o->iodepth || !o->iodepth_batch)
728 o->iodepth_batch = o->iodepth;
731 * If max batch complete number isn't set or set incorrectly,
732 * default to the same as iodepth_batch_complete_min
734 if (o->iodepth_batch_complete_min > o->iodepth_batch_complete_max)
735 o->iodepth_batch_complete_max = o->iodepth_batch_complete_min;
738 * There's no need to check for in-flight overlapping IOs if the job
739 * isn't changing data or the maximum iodepth is guaranteed to be 1
741 if (o->serialize_overlap && !(td->flags & TD_F_READ_IOLOG) &&
742 (!(td_write(td) || td_trim(td)) || o->iodepth == 1))
743 o->serialize_overlap = 0;
745 * Currently can't check for overlaps in offload mode
747 if (o->serialize_overlap && o->io_submit_mode == IO_MODE_OFFLOAD) {
748 log_err("fio: checking for in-flight overlaps when the "
749 "io_submit_mode is offload is not supported\n");
750 o->serialize_overlap = 0;
751 ret |= warnings_fatal;
754 if (o->nr_files > td->files_index)
755 o->nr_files = td->files_index;
757 if (o->open_files > o->nr_files || !o->open_files)
758 o->open_files = o->nr_files;
760 if (((o->rate[DDIR_READ] + o->rate[DDIR_WRITE] + o->rate[DDIR_TRIM]) &&
761 (o->rate_iops[DDIR_READ] + o->rate_iops[DDIR_WRITE] + o->rate_iops[DDIR_TRIM])) ||
762 ((o->ratemin[DDIR_READ] + o->ratemin[DDIR_WRITE] + o->ratemin[DDIR_TRIM]) &&
763 (o->rate_iops_min[DDIR_READ] + o->rate_iops_min[DDIR_WRITE] + o->rate_iops_min[DDIR_TRIM]))) {
764 log_err("fio: rate and rate_iops are mutually exclusive\n");
767 if ((o->rate[DDIR_READ] && (o->rate[DDIR_READ] < o->ratemin[DDIR_READ])) ||
768 (o->rate[DDIR_WRITE] && (o->rate[DDIR_WRITE] < o->ratemin[DDIR_WRITE])) ||
769 (o->rate[DDIR_TRIM] && (o->rate[DDIR_TRIM] < o->ratemin[DDIR_TRIM])) ||
770 (o->rate_iops[DDIR_READ] && (o->rate_iops[DDIR_READ] < o->rate_iops_min[DDIR_READ])) ||
771 (o->rate_iops[DDIR_WRITE] && (o->rate_iops[DDIR_WRITE] < o->rate_iops_min[DDIR_WRITE])) ||
772 (o->rate_iops[DDIR_TRIM] && (o->rate_iops[DDIR_TRIM] < o->rate_iops_min[DDIR_TRIM]))) {
773 log_err("fio: minimum rate exceeds rate\n");
777 if (!o->timeout && o->time_based) {
778 log_err("fio: time_based requires a runtime/timeout setting\n");
780 ret |= warnings_fatal;
783 if (o->fill_device && !o->size)
786 if (o->verify != VERIFY_NONE) {
787 if (td_write(td) && o->do_verify && o->numjobs > 1 &&
789 !(o->unique_filename &&
790 strstr(o->filename_format, "$jobname") &&
791 strstr(o->filename_format, "$jobnum") &&
792 strstr(o->filename_format, "$filenum")))) {
793 log_info("fio: multiple writers may overwrite blocks "
794 "that belong to other jobs. This can cause "
795 "verification failures.\n");
796 ret |= warnings_fatal;
800 * Warn if verification is requested but no verification of any
801 * kind can be started due to time constraints
803 if (td_write(td) && o->do_verify && o->timeout &&
804 o->time_based && !td_read(td) && !o->verify_backlog) {
805 log_info("fio: verification read phase will never "
806 "start because write phase uses all of "
808 ret |= warnings_fatal;
811 if (!fio_option_is_set(o, refill_buffers))
812 o->refill_buffers = 1;
814 if (o->max_bs[DDIR_WRITE] != o->min_bs[DDIR_WRITE] &&
816 o->verify_interval = o->min_bs[DDIR_WRITE];
819 * Verify interval must be smaller or equal to the
822 if (o->verify_interval > o->min_bs[DDIR_WRITE])
823 o->verify_interval = o->min_bs[DDIR_WRITE];
824 else if (td_read(td) && o->verify_interval > o->min_bs[DDIR_READ])
825 o->verify_interval = o->min_bs[DDIR_READ];
828 * Verify interval must be a factor of both min and max
831 if (!o->verify_interval ||
832 (o->min_bs[DDIR_WRITE] % o->verify_interval) ||
833 (o->max_bs[DDIR_WRITE] % o->verify_interval))
834 o->verify_interval = gcd(o->min_bs[DDIR_WRITE],
835 o->max_bs[DDIR_WRITE]);
839 if (o->invalidate_cache)
840 o->invalidate_cache = 0;
841 if (td_ioengine_flagged(td, FIO_PIPEIO)) {
842 log_info("fio: cannot pre-read files with an IO engine"
843 " that isn't seekable. Pre-read disabled.\n");
844 ret |= warnings_fatal;
848 if (o->unit_base == N2S_NONE) {
849 if (td_ioengine_flagged(td, FIO_BIT_BASED))
850 o->unit_base = N2S_BITPERSEC;
852 o->unit_base = N2S_BYTEPERSEC;
855 #ifndef FIO_HAVE_ANY_FALLOCATE
856 /* Platform doesn't support any fallocate so force it to none */
857 o->fallocate_mode = FIO_FALLOCATE_NONE;
860 #ifndef CONFIG_FDATASYNC
861 if (o->fdatasync_blocks) {
862 log_info("fio: this platform does not support fdatasync()"
863 " falling back to using fsync(). Use the 'fsync'"
864 " option instead of 'fdatasync' to get rid of"
866 o->fsync_blocks = o->fdatasync_blocks;
867 o->fdatasync_blocks = 0;
868 ret |= warnings_fatal;
874 * Windows doesn't support O_DIRECT or O_SYNC with the _open interface,
875 * so fail if we're passed those flags
877 if (td_ioengine_flagged(td, FIO_SYNCIO) && (o->odirect || o->sync_io)) {
878 log_err("fio: Windows does not support direct or non-buffered io with"
879 " the synchronous ioengines. Use the 'windowsaio' ioengine"
880 " with 'direct=1' and 'iodepth=1' instead.\n");
886 * For fully compressible data, just zero them at init time.
887 * It's faster than repeatedly filling it. For non-zero
888 * compression, we should have refill_buffers set. Set it, unless
889 * the job file already changed it.
891 if (o->compress_percentage) {
892 if (o->compress_percentage == 100) {
894 o->compress_percentage = 0;
895 } else if (!fio_option_is_set(o, refill_buffers)) {
896 o->refill_buffers = 1;
897 td->flags |= TD_F_REFILL_BUFFERS;
902 * Using a non-uniform random distribution excludes usage of
905 if (o->random_distribution != FIO_RAND_DIST_RANDOM)
909 * If size is set but less than the min block size, complain
911 if (o->size && o->size < td_min_bs(td)) {
912 log_err("fio: size too small, must not be less than minimum block size: %llu < %llu\n",
913 (unsigned long long) o->size, td_min_bs(td));
918 * O_ATOMIC implies O_DIRECT
924 * If randseed is set, that overrides randrepeat
926 if (fio_option_is_set(o, rand_seed))
927 o->rand_repeatable = 0;
929 if (td_ioengine_flagged(td, FIO_NOEXTEND) && o->file_append) {
930 log_err("fio: can't append/extent with IO engine %s\n", td->io_ops->name);
934 if (fio_option_is_set(o, gtod_cpu)) {
936 fio_gtod_set_cpu(o->gtod_cpu);
937 fio_gtod_offload = 1;
940 td->loops = o->loops;
944 if (o->block_error_hist && o->nr_files != 1) {
945 log_err("fio: block error histogram only available "
946 "with a single file per job, but %d files "
947 "provided\n", o->nr_files);
951 if (fio_option_is_set(o, clat_percentiles) &&
952 !fio_option_is_set(o, lat_percentiles)) {
953 o->lat_percentiles = !o->clat_percentiles;
954 } else if (fio_option_is_set(o, lat_percentiles) &&
955 !fio_option_is_set(o, clat_percentiles)) {
956 o->clat_percentiles = !o->lat_percentiles;
957 } else if (fio_option_is_set(o, lat_percentiles) &&
958 fio_option_is_set(o, clat_percentiles) &&
959 o->lat_percentiles && o->clat_percentiles) {
960 log_err("fio: lat_percentiles and clat_percentiles are "
961 "mutually exclusive\n");
966 o->lat_percentiles = 0;
968 o->clat_percentiles = 0;
971 * Fix these up to be nsec internally
973 o->max_latency *= 1000ULL;
974 o->latency_target *= 1000ULL;
975 o->latency_window *= 1000ULL;
980 static void init_rand_file_service(struct thread_data *td)
982 unsigned long nranges = td->o.nr_files << FIO_FSERVICE_SHIFT;
983 const unsigned int seed = td->rand_seeds[FIO_RAND_FILE_OFF];
985 if (td->o.file_service_type == FIO_FSERVICE_ZIPF) {
986 zipf_init(&td->next_file_zipf, nranges, td->zipf_theta, seed);
987 zipf_disable_hash(&td->next_file_zipf);
988 } else if (td->o.file_service_type == FIO_FSERVICE_PARETO) {
989 pareto_init(&td->next_file_zipf, nranges, td->pareto_h, seed);
990 zipf_disable_hash(&td->next_file_zipf);
991 } else if (td->o.file_service_type == FIO_FSERVICE_GAUSS) {
992 gauss_init(&td->next_file_gauss, nranges, td->gauss_dev, seed);
993 gauss_disable_hash(&td->next_file_gauss);
997 void td_fill_verify_state_seed(struct thread_data *td)
1001 if (td->o.random_generator == FIO_RAND_GEN_TAUSWORTHE64)
1006 init_rand_seed(&td->verify_state, td->rand_seeds[FIO_RAND_VER_OFF],
1010 static void td_fill_rand_seeds_internal(struct thread_data *td, bool use64)
1012 unsigned int read_seed = td->rand_seeds[FIO_RAND_BS_OFF];
1013 unsigned int write_seed = td->rand_seeds[FIO_RAND_BS1_OFF];
1014 unsigned int trim_seed = td->rand_seeds[FIO_RAND_BS2_OFF];
1018 * trimwrite is special in that we need to generate the same
1019 * offsets to get the "write after trim" effect. If we are
1020 * using bssplit to set buffer length distributions, ensure that
1021 * we seed the trim and write generators identically. Ditto for
1022 * verify, read and writes must have the same seed, if we are doing
1025 if (td->o.verify != VERIFY_NONE)
1026 write_seed = read_seed;
1027 if (td_trimwrite(td))
1028 trim_seed = write_seed;
1029 init_rand_seed(&td->bsrange_state[DDIR_READ], read_seed, use64);
1030 init_rand_seed(&td->bsrange_state[DDIR_WRITE], write_seed, use64);
1031 init_rand_seed(&td->bsrange_state[DDIR_TRIM], trim_seed, use64);
1033 td_fill_verify_state_seed(td);
1034 init_rand_seed(&td->rwmix_state, td->rand_seeds[FIO_RAND_MIX_OFF], false);
1036 if (td->o.file_service_type == FIO_FSERVICE_RANDOM)
1037 init_rand_seed(&td->next_file_state, td->rand_seeds[FIO_RAND_FILE_OFF], use64);
1038 else if (td->o.file_service_type & __FIO_FSERVICE_NONUNIFORM)
1039 init_rand_file_service(td);
1041 init_rand_seed(&td->file_size_state, td->rand_seeds[FIO_RAND_FILE_SIZE_OFF], use64);
1042 init_rand_seed(&td->trim_state, td->rand_seeds[FIO_RAND_TRIM_OFF], use64);
1043 init_rand_seed(&td->delay_state, td->rand_seeds[FIO_RAND_START_DELAY], use64);
1044 init_rand_seed(&td->poisson_state[0], td->rand_seeds[FIO_RAND_POISSON_OFF], 0);
1045 init_rand_seed(&td->poisson_state[1], td->rand_seeds[FIO_RAND_POISSON2_OFF], 0);
1046 init_rand_seed(&td->poisson_state[2], td->rand_seeds[FIO_RAND_POISSON3_OFF], 0);
1047 init_rand_seed(&td->dedupe_state, td->rand_seeds[FIO_DEDUPE_OFF], false);
1048 init_rand_seed(&td->zone_state, td->rand_seeds[FIO_RAND_ZONE_OFF], false);
1053 if (td->o.rand_repeatable)
1054 td->rand_seeds[FIO_RAND_BLOCK_OFF] = FIO_RANDSEED * td->thread_number;
1056 init_rand_seed(&td->random_state, td->rand_seeds[FIO_RAND_BLOCK_OFF], use64);
1058 for (i = 0; i < DDIR_RWDIR_CNT; i++) {
1059 struct frand_state *s = &td->seq_rand_state[i];
1061 init_rand_seed(s, td->rand_seeds[FIO_RAND_SEQ_RAND_READ_OFF], false);
1065 void td_fill_rand_seeds(struct thread_data *td)
1069 if (td->o.allrand_repeatable) {
1072 for (i = 0; i < FIO_RAND_NR_OFFS; i++)
1073 td->rand_seeds[i] = FIO_RANDSEED * td->thread_number
1077 if (td->o.random_generator == FIO_RAND_GEN_TAUSWORTHE64)
1082 td_fill_rand_seeds_internal(td, use64);
1084 init_rand_seed(&td->buf_state, td->rand_seeds[FIO_RAND_BUF_OFF], use64);
1085 frand_copy(&td->buf_state_prev, &td->buf_state);
1089 * Initializes the ioengine configured for a job, if it has not been done so
1092 int ioengine_load(struct thread_data *td)
1094 if (!td->o.ioengine) {
1095 log_err("fio: internal fault, no IO engine specified\n");
1100 struct ioengine_ops *ops;
1103 /* An engine is loaded, but the requested ioengine
1106 if (!strcmp(td->io_ops->name, td->o.ioengine)) {
1107 /* The right engine is already loaded */
1112 * Name of file and engine may be different, load ops
1113 * for this name and see if they match. If they do, then
1114 * the engine is unchanged.
1116 dlhandle = td->io_ops_dlhandle;
1117 ops = load_ioengine(td);
1118 if (ops == td->io_ops && dlhandle == td->io_ops_dlhandle) {
1124 if (dlhandle && dlhandle != td->io_ops_dlhandle)
1127 /* Unload the old engine. */
1131 td->io_ops = load_ioengine(td);
1133 log_err("fio: failed to load engine\n");
1137 if (td->io_ops->option_struct_size && td->io_ops->options) {
1139 * In cases where td->eo is set, clone it for a child thread.
1140 * This requires that the parent thread has the same ioengine,
1141 * but that requirement must be enforced by the code which
1142 * cloned the thread.
1144 void *origeo = td->eo;
1146 * Otherwise use the default thread options.
1148 if (!origeo && td != &def_thread && def_thread.eo &&
1149 def_thread.io_ops->options == td->io_ops->options)
1150 origeo = def_thread.eo;
1152 options_init(td->io_ops->options);
1153 td->eo = malloc(td->io_ops->option_struct_size);
1155 * Use the default thread as an option template if this uses the
1156 * same options structure and there are non-default options
1160 memcpy(td->eo, origeo, td->io_ops->option_struct_size);
1161 options_mem_dupe(td->io_ops->options, td->eo);
1163 memset(td->eo, 0, td->io_ops->option_struct_size);
1164 fill_default_options(td->eo, td->io_ops->options);
1166 *(struct thread_data **)td->eo = td;
1170 td->io_ops->flags |= FIO_RAWIO;
1172 td_set_ioengine_flags(td);
1176 static void init_flags(struct thread_data *td)
1178 struct thread_options *o = &td->o;
1181 if (o->verify_backlog)
1182 td->flags |= TD_F_VER_BACKLOG;
1183 if (o->trim_backlog)
1184 td->flags |= TD_F_TRIM_BACKLOG;
1185 if (o->read_iolog_file)
1186 td->flags |= TD_F_READ_IOLOG;
1187 if (o->refill_buffers)
1188 td->flags |= TD_F_REFILL_BUFFERS;
1190 * Always scramble buffers if asked to
1192 if (o->scramble_buffers && fio_option_is_set(o, scramble_buffers))
1193 td->flags |= TD_F_SCRAMBLE_BUFFERS;
1195 * But also scramble buffers, unless we were explicitly asked
1198 if (o->scramble_buffers && !(o->zero_buffers &&
1199 fio_option_is_set(o, zero_buffers)))
1200 td->flags |= TD_F_SCRAMBLE_BUFFERS;
1201 if (o->verify != VERIFY_NONE)
1202 td->flags |= TD_F_DO_VERIFY;
1204 if (o->verify_async || o->io_submit_mode == IO_MODE_OFFLOAD)
1205 td->flags |= TD_F_NEED_LOCK;
1207 if (o->mem_type == MEM_CUDA_MALLOC)
1208 td->flags &= ~TD_F_SCRAMBLE_BUFFERS;
1210 for (i = 0; i < DDIR_RWDIR_CNT; i++) {
1211 if (option_check_rate(td, i)) {
1212 td->flags |= TD_F_CHECK_RATE;
1218 static int setup_random_seeds(struct thread_data *td)
1223 if (!td->o.rand_repeatable && !fio_option_is_set(&td->o, rand_seed)) {
1224 int ret = init_random_seeds(td->rand_seeds, sizeof(td->rand_seeds));
1226 td_fill_rand_seeds(td);
1230 seed = td->o.rand_seed;
1231 for (i = 0; i < 4; i++)
1232 seed *= 0x9e370001UL;
1234 for (i = 0; i < FIO_RAND_NR_OFFS; i++) {
1235 td->rand_seeds[i] = seed * td->thread_number + i;
1236 seed *= 0x9e370001UL;
1239 td_fill_rand_seeds(td);
1250 static struct fpre_keyword {
1251 const char *keyword;
1254 } fpre_keywords[] = {
1255 { .keyword = "$jobname", .key = FPRE_JOBNAME, },
1256 { .keyword = "$jobnum", .key = FPRE_JOBNUM, },
1257 { .keyword = "$filenum", .key = FPRE_FILENUM, },
1258 { .keyword = NULL, },
1261 static char *make_filename(char *buf, size_t buf_size,struct thread_options *o,
1262 const char *jobname, int jobnum, int filenum)
1264 struct fpre_keyword *f;
1265 char copy[PATH_MAX];
1266 size_t dst_left = PATH_MAX - 1;
1268 if (!o->filename_format || !strlen(o->filename_format)) {
1269 sprintf(buf, "%s.%d.%d", jobname, jobnum, filenum);
1273 for (f = &fpre_keywords[0]; f->keyword; f++)
1274 f->strlen = strlen(f->keyword);
1276 buf[buf_size - 1] = '\0';
1277 strncpy(buf, o->filename_format, buf_size - 1);
1279 memset(copy, 0, sizeof(copy));
1280 for (f = &fpre_keywords[0]; f->keyword; f++) {
1282 size_t pre_len, post_start = 0;
1283 char *str, *dst = copy;
1285 str = strcasestr(buf, f->keyword);
1289 pre_len = str - buf;
1290 if (strlen(str) != f->strlen)
1291 post_start = pre_len + f->strlen;
1294 strncpy(dst, buf, pre_len);
1296 dst_left -= pre_len;
1300 case FPRE_JOBNAME: {
1303 ret = snprintf(dst, dst_left, "%s", jobname);
1306 else if (ret > dst_left) {
1307 log_err("fio: truncated filename\n");
1319 ret = snprintf(dst, dst_left, "%d", jobnum);
1322 else if (ret > dst_left) {
1323 log_err("fio: truncated filename\n");
1332 case FPRE_FILENUM: {
1335 ret = snprintf(dst, dst_left, "%d", filenum);
1338 else if (ret > dst_left) {
1339 log_err("fio: truncated filename\n");
1354 strncpy(dst, buf + post_start, dst_left);
1356 strncpy(buf, copy, buf_size - 1);
1363 bool parse_dryrun(void)
1365 return dump_cmdline || parse_only;
1368 static void gen_log_name(char *name, size_t size, const char *logtype,
1369 const char *logname, unsigned int num,
1370 const char *suf, int per_job)
1373 snprintf(name, size, "%s_%s.%d.%s", logname, logtype, num, suf);
1375 snprintf(name, size, "%s_%s.%s", logname, logtype, suf);
1378 static int check_waitees(char *waitee)
1380 struct thread_data *td;
1383 for_each_td(td, i) {
1384 if (td->subjob_number)
1387 ret += !strcmp(td->o.name, waitee);
1393 static bool wait_for_ok(const char *jobname, struct thread_options *o)
1400 if (!strcmp(jobname, o->wait_for)) {
1401 log_err("%s: a job cannot wait for itself (wait_for=%s).\n",
1402 jobname, o->wait_for);
1406 if (!(nw = check_waitees(o->wait_for))) {
1407 log_err("%s: waitee job %s unknown.\n", jobname, o->wait_for);
1412 log_err("%s: multiple waitees %s found,\n"
1413 "please avoid duplicates when using wait_for option.\n",
1414 jobname, o->wait_for);
1422 * Treat an empty log file name the same as a one not given
1424 static const char *make_log_name(const char *logname, const char *jobname)
1426 if (logname && strcmp(logname, ""))
1433 * Adds a job to the list of things todo. Sanitizes the various options
1434 * to make sure we don't have conflicts, and initializes various
1437 static int add_job(struct thread_data *td, const char *jobname, int job_add_num,
1438 int recursed, int client_type)
1441 char fname[PATH_MAX];
1442 int numjobs, file_alloced;
1443 struct thread_options *o = &td->o;
1444 char logname[PATH_MAX + 32];
1447 * the def_thread is just for options, it's not a real job
1449 if (td == &def_thread)
1455 * if we are just dumping the output command line, don't add the job
1457 if (parse_dryrun()) {
1462 td->client_type = client_type;
1464 if (profile_td_init(td))
1467 if (ioengine_load(td))
1471 if (!o->filename && !td->files_index && !o->read_iolog_file) {
1474 if (o->nr_files == 1 && exists_and_not_regfile(jobname))
1475 add_file(td, jobname, job_add_num, 0);
1477 for (i = 0; i < o->nr_files; i++)
1478 add_file(td, make_filename(fname, sizeof(fname), o, jobname, job_add_num, i), job_add_num, 0);
1482 if (setup_random_seeds(td)) {
1483 td_verror(td, errno, "setup_random_seeds");
1487 if (fixup_options(td))
1491 * Belongs to fixup_options, but o->name is not necessarily set as yet
1493 if (!wait_for_ok(jobname, o))
1499 * IO engines only need this for option callbacks, and the address may
1500 * change in subprocesses.
1503 *(struct thread_data **)td->eo = NULL;
1505 if (td_ioengine_flagged(td, FIO_DISKLESSIO)) {
1508 for_each_file(td, f, i)
1509 f->real_file_size = -1ULL;
1512 td->sem = fio_sem_init(FIO_SEM_LOCKED);
1514 td->ts.clat_percentiles = o->clat_percentiles;
1515 td->ts.lat_percentiles = o->lat_percentiles;
1516 td->ts.percentile_precision = o->percentile_precision;
1517 memcpy(td->ts.percentile_list, o->percentile_list, sizeof(o->percentile_list));
1518 td->ts.sig_figs = o->sig_figs;
1520 for (i = 0; i < DDIR_RWDIR_CNT; i++) {
1521 td->ts.clat_stat[i].min_val = ULONG_MAX;
1522 td->ts.slat_stat[i].min_val = ULONG_MAX;
1523 td->ts.lat_stat[i].min_val = ULONG_MAX;
1524 td->ts.bw_stat[i].min_val = ULONG_MAX;
1525 td->ts.iops_stat[i].min_val = ULONG_MAX;
1527 td->ts.sync_stat.min_val = ULONG_MAX;
1528 td->ddir_seq_nr = o->ddir_seq_nr;
1530 if ((o->stonewall || o->new_group) && prev_group_jobs) {
1531 prev_group_jobs = 0;
1533 if (groupid == INT_MAX) {
1534 log_err("fio: too many groups defined\n");
1539 td->groupid = groupid;
1545 if (o->write_lat_log) {
1546 struct log_params p = {
1548 .avg_msec = o->log_avg_msec,
1549 .hist_msec = o->log_hist_msec,
1550 .hist_coarseness = o->log_hist_coarseness,
1551 .log_type = IO_LOG_TYPE_LAT,
1552 .log_offset = o->log_offset,
1553 .log_gz = o->log_gz,
1554 .log_gz_store = o->log_gz_store,
1556 const char *pre = make_log_name(o->lat_log_file, o->name);
1564 gen_log_name(logname, sizeof(logname), "lat", pre,
1565 td->thread_number, suf, o->per_job_logs);
1566 setup_log(&td->lat_log, &p, logname);
1568 gen_log_name(logname, sizeof(logname), "slat", pre,
1569 td->thread_number, suf, o->per_job_logs);
1570 setup_log(&td->slat_log, &p, logname);
1572 gen_log_name(logname, sizeof(logname), "clat", pre,
1573 td->thread_number, suf, o->per_job_logs);
1574 setup_log(&td->clat_log, &p, logname);
1578 if (o->write_hist_log) {
1579 struct log_params p = {
1581 .avg_msec = o->log_avg_msec,
1582 .hist_msec = o->log_hist_msec,
1583 .hist_coarseness = o->log_hist_coarseness,
1584 .log_type = IO_LOG_TYPE_HIST,
1585 .log_offset = o->log_offset,
1586 .log_gz = o->log_gz,
1587 .log_gz_store = o->log_gz_store,
1589 const char *pre = make_log_name(o->hist_log_file, o->name);
1593 if (td->client_type) {
1594 log_err("fio: --write_hist_log requires zlib in client/server mode\n");
1604 gen_log_name(logname, sizeof(logname), "clat_hist", pre,
1605 td->thread_number, suf, o->per_job_logs);
1606 setup_log(&td->clat_hist_log, &p, logname);
1609 if (o->write_bw_log) {
1610 struct log_params p = {
1612 .avg_msec = o->log_avg_msec,
1613 .hist_msec = o->log_hist_msec,
1614 .hist_coarseness = o->log_hist_coarseness,
1615 .log_type = IO_LOG_TYPE_BW,
1616 .log_offset = o->log_offset,
1617 .log_gz = o->log_gz,
1618 .log_gz_store = o->log_gz_store,
1620 const char *pre = make_log_name(o->bw_log_file, o->name);
1623 if (fio_option_is_set(o, bw_avg_time))
1624 p.avg_msec = min(o->log_avg_msec, o->bw_avg_time);
1626 o->bw_avg_time = p.avg_msec;
1628 p.hist_msec = o->log_hist_msec;
1629 p.hist_coarseness = o->log_hist_coarseness;
1636 gen_log_name(logname, sizeof(logname), "bw", pre,
1637 td->thread_number, suf, o->per_job_logs);
1638 setup_log(&td->bw_log, &p, logname);
1640 if (o->write_iops_log) {
1641 struct log_params p = {
1643 .avg_msec = o->log_avg_msec,
1644 .hist_msec = o->log_hist_msec,
1645 .hist_coarseness = o->log_hist_coarseness,
1646 .log_type = IO_LOG_TYPE_IOPS,
1647 .log_offset = o->log_offset,
1648 .log_gz = o->log_gz,
1649 .log_gz_store = o->log_gz_store,
1651 const char *pre = make_log_name(o->iops_log_file, o->name);
1654 if (fio_option_is_set(o, iops_avg_time))
1655 p.avg_msec = min(o->log_avg_msec, o->iops_avg_time);
1657 o->iops_avg_time = p.avg_msec;
1659 p.hist_msec = o->log_hist_msec;
1660 p.hist_coarseness = o->log_hist_coarseness;
1667 gen_log_name(logname, sizeof(logname), "iops", pre,
1668 td->thread_number, suf, o->per_job_logs);
1669 setup_log(&td->iops_log, &p, logname);
1673 o->name = strdup(jobname);
1675 if (output_format & FIO_OUTPUT_NORMAL) {
1677 if (is_backend && !recursed)
1678 fio_server_send_add_job(td);
1680 if (!td_ioengine_flagged(td, FIO_NOIO)) {
1681 char *c1, *c2, *c3, *c4;
1682 char *c5 = NULL, *c6 = NULL;
1683 int i2p = is_power_of_2(o->kb_base);
1684 struct buf_output out;
1686 c1 = num2str(o->min_bs[DDIR_READ], o->sig_figs, 1, i2p, N2S_BYTE);
1687 c2 = num2str(o->max_bs[DDIR_READ], o->sig_figs, 1, i2p, N2S_BYTE);
1688 c3 = num2str(o->min_bs[DDIR_WRITE], o->sig_figs, 1, i2p, N2S_BYTE);
1689 c4 = num2str(o->max_bs[DDIR_WRITE], o->sig_figs, 1, i2p, N2S_BYTE);
1691 if (!o->bs_is_seq_rand) {
1692 c5 = num2str(o->min_bs[DDIR_TRIM], o->sig_figs, 1, i2p, N2S_BYTE);
1693 c6 = num2str(o->max_bs[DDIR_TRIM], o->sig_figs, 1, i2p, N2S_BYTE);
1696 buf_output_init(&out);
1697 log_buf(&out, "%s: (g=%d): rw=%s, ", td->o.name,
1699 ddir_str(o->td_ddir));
1701 if (o->bs_is_seq_rand)
1702 log_buf(&out, "bs=(R) %s-%s, (W) %s-%s, bs_is_seq_rand, ",
1705 log_buf(&out, "bs=(R) %s-%s, (W) %s-%s, (T) %s-%s, ",
1706 c1, c2, c3, c4, c5, c6);
1708 log_buf(&out, "ioengine=%s, iodepth=%u\n",
1709 td->io_ops->name, o->iodepth);
1710 log_info_buf(out.buf, out.buflen);
1719 } else if (job_add_num == 1)
1723 if (td_steadystate_init(td))
1727 * recurse add identical jobs, clear numjobs and stonewall options
1728 * as they don't apply to sub-jobs
1730 numjobs = o->numjobs;
1732 struct thread_data *td_new = get_new_job(false, td, true, jobname);
1737 td_new->o.numjobs = 1;
1738 td_new->o.stonewall = 0;
1739 td_new->o.new_group = 0;
1740 td_new->subjob_number = numjobs;
1741 td_new->o.ss_dur = o->ss_dur * 1000000l;
1742 td_new->o.ss_limit = o->ss_limit;
1745 if (td_new->files) {
1747 for_each_file(td_new, f, i) {
1749 sfree(f->file_name);
1752 free(td_new->files);
1753 td_new->files = NULL;
1755 td_new->files_index = 0;
1756 td_new->files_size = 0;
1757 if (td_new->o.filename) {
1758 free(td_new->o.filename);
1759 td_new->o.filename = NULL;
1763 if (add_job(td_new, jobname, numjobs, 1, client_type))
1774 * Parse as if 'o' was a command line
1776 void add_job_opts(const char **o, int client_type)
1778 struct thread_data *td, *td_parent;
1779 int i, in_global = 1;
1783 td_parent = td = NULL;
1785 if (!strncmp(o[i], "name", 4)) {
1788 add_job(td, jobname, 0, 0, client_type);
1790 sprintf(jobname, "%s", o[i] + 5);
1792 if (in_global && !td_parent)
1793 td_parent = get_new_job(true, &def_thread, false, jobname);
1794 else if (!in_global && !td) {
1796 td_parent = &def_thread;
1797 td = get_new_job(false, td_parent, false, jobname);
1800 fio_options_parse(td_parent, (char **) &o[i], 1);
1802 fio_options_parse(td, (char **) &o[i], 1);
1807 add_job(td, jobname, 0, 0, client_type);
1810 static int skip_this_section(const char *name)
1814 if (!nr_job_sections)
1816 if (!strncmp(name, "global", 6))
1819 for (i = 0; i < nr_job_sections; i++)
1820 if (!strcmp(job_sections[i], name))
1826 static int is_empty_or_comment(char *line)
1830 for (i = 0; i < strlen(line); i++) {
1835 if (!isspace((int) line[i]) && !iscntrl((int) line[i]))
1843 * This is our [ini] type file parser.
1845 static int __parse_jobs_ini(struct thread_data *td,
1846 char *file, int is_buf, int stonewall_flag, int type,
1847 int nested, char *name, char ***popts, int *aopts, int *nopts)
1849 bool global = false;
1853 int ret = 0, stonewall;
1856 int inside_skip = 0;
1858 int i, alloc_opts, num_opts;
1860 dprint(FD_PARSE, "Parsing ini file %s\n", file);
1861 assert(td || !nested);
1866 if (!strcmp(file, "-"))
1869 f = fopen(file, "r");
1874 log_err("fio: unable to open '%s' job file\n", file);
1876 td_verror(td, __err, "job file open");
1881 string = malloc(4096);
1884 * it's really 256 + small bit, 280 should suffice
1888 memset(name, 0, 280);
1892 if (nested && popts) {
1894 alloc_opts = *aopts;
1900 opts = malloc(sizeof(char *) * alloc_opts);
1904 stonewall = stonewall_flag;
1907 * if skip_fgets is set, we already have loaded a line we
1912 p = strsep(&file, "\n");
1914 p = fgets(string, 4096, f);
1920 strip_blank_front(&p);
1923 dprint(FD_PARSE, "%s\n", p);
1924 if (is_empty_or_comment(p))
1928 if (sscanf(p, "[%255[^\n]]", name) != 1) {
1932 log_err("fio: option <%s> outside of "
1933 "[] job section\n", p);
1938 name[strlen(name) - 1] = '\0';
1940 if (skip_this_section(name)) {
1946 dprint(FD_PARSE, "Parsing section [%s]\n", name);
1948 global = !strncmp(name, "global", 6);
1954 log_info("--name=%s ", name);
1958 td = get_new_job(global, &def_thread, false, name);
1965 * Separate multiple job files by a stonewall
1967 if (!global && stonewall) {
1968 td->o.stonewall = stonewall;
1973 memset(opts, 0, alloc_opts * sizeof(char *));
1981 p = strsep(&file, "\n");
1983 p = fgets(string, 4096, f);
1986 dprint(FD_PARSE, "%s", p);
1991 if (is_empty_or_comment(p))
1994 strip_blank_front(&p);
1997 * new section, break out and make sure we don't
1998 * fgets() a new line at the top.
2002 log_err("No new sections in included files\n");
2013 if (!strncmp(p, "include", strlen("include"))) {
2014 char *filename = p + strlen("include") + 1,
2015 *ts, *full_fn = NULL;
2018 * Allow for the include filename
2019 * specification to be relative.
2021 if (access(filename, F_OK) &&
2022 (ts = strrchr(file, '/'))) {
2023 int len = ts - file +
2024 strlen(filename) + 2;
2026 if (!(full_fn = calloc(1, len))) {
2032 file, (ts - file) + 1);
2033 strncpy(full_fn + (ts - file) + 1,
2034 filename, strlen(filename));
2035 full_fn[len - 1] = 0;
2039 ret = __parse_jobs_ini(td, filename, is_buf,
2040 stonewall_flag, type, 1,
2042 &alloc_opts, &num_opts);
2045 log_err("Error %d while parsing "
2046 "include file %s\n",
2059 if (num_opts == alloc_opts) {
2061 opts = realloc(opts,
2062 alloc_opts * sizeof(char *));
2065 opts[num_opts] = strdup(p);
2071 *aopts = alloc_opts;
2076 ret = fio_options_parse(td, opts, num_opts);
2081 ret = add_job(td, name, 0, 0, type);
2083 log_err("fio: job %s dropped\n", name);
2087 for (i = 0; i < num_opts; i++)
2096 while (i < nr_job_sections) {
2097 free(job_sections[i]);
2106 if (!is_buf && f != stdin)
2111 int parse_jobs_ini(char *file, int is_buf, int stonewall_flag, int type)
2113 return __parse_jobs_ini(NULL, file, is_buf, stonewall_flag, type,
2114 0, NULL, NULL, NULL, NULL);
2117 static int fill_def_thread(void)
2119 memset(&def_thread, 0, sizeof(def_thread));
2120 INIT_FLIST_HEAD(&def_thread.opt_list);
2122 fio_getaffinity(getpid(), &def_thread.o.cpumask);
2123 def_thread.o.error_dump = 1;
2126 * fill default options
2128 fio_fill_default_options(&def_thread);
2132 static void show_debug_categories(void)
2134 #ifdef FIO_INC_DEBUG
2135 const struct debug_level *dl = &debug_levels[0];
2136 int curlen, first = 1;
2140 int has_next = (dl + 1)->name != NULL;
2142 if (first || curlen + strlen(dl->name) >= 80) {
2147 curlen += printf("\t\t\t%s", dl->name);
2148 curlen += 3 * (8 - 1);
2150 curlen += printf(",");
2152 curlen += printf("%s", dl->name);
2154 curlen += printf(",");
2164 * Following options aren't printed by usage().
2165 * --append-terse - Equivalent to --output-format=terse, see f6a7df53.
2166 * --latency-log - Deprecated option.
2168 static void usage(const char *name)
2170 printf("%s\n", fio_version_string);
2171 printf("%s [options] [job options] <job file(s)>\n", name);
2172 printf(" --debug=options\tEnable debug logging. May be one/more of:\n");
2173 show_debug_categories();
2174 printf(" --parse-only\t\tParse options only, don't start any IO\n");
2175 printf(" --output\t\tWrite output to file\n");
2176 printf(" --bandwidth-log\tGenerate aggregate bandwidth logs\n");
2177 printf(" --minimal\t\tMinimal (terse) output\n");
2178 printf(" --output-format=type\tOutput format (terse,json,json+,normal)\n");
2179 printf(" --terse-version=type\tSet terse version output format"
2180 " (default 3, or 2 or 4)\n");
2181 printf(" --version\t\tPrint version info and exit\n");
2182 printf(" --help\t\tPrint this page\n");
2183 printf(" --cpuclock-test\tPerform test/validation of CPU clock\n");
2184 printf(" --crctest=[type]\tTest speed of checksum functions\n");
2185 printf(" --cmdhelp=cmd\t\tPrint command help, \"all\" for all of"
2187 printf(" --enghelp=engine\tPrint ioengine help, or list"
2188 " available ioengines\n");
2189 printf(" --enghelp=engine,cmd\tPrint help for an ioengine"
2191 printf(" --showcmd\t\tTurn a job file into command line options\n");
2192 printf(" --eta=when\t\tWhen ETA estimate should be printed\n");
2193 printf(" \t\tMay be \"always\", \"never\" or \"auto\"\n");
2194 printf(" --eta-newline=t\tForce a new line for every 't'");
2195 printf(" period passed\n");
2196 printf(" --status-interval=t\tForce full status dump every");
2197 printf(" 't' period passed\n");
2198 printf(" --readonly\t\tTurn on safety read-only checks, preventing"
2200 printf(" --section=name\tOnly run specified section in job file,"
2201 " multiple sections can be specified\n");
2202 printf(" --alloc-size=kb\tSet smalloc pool to this size in kb"
2204 printf(" --warnings-fatal\tFio parser warnings are fatal\n");
2205 printf(" --max-jobs=nr\t\tMaximum number of threads/processes to support\n");
2206 printf(" --server=args\t\tStart a backend fio server\n");
2207 printf(" --daemonize=pidfile\tBackground fio server, write pid to file\n");
2208 printf(" --client=hostname\tTalk to remote backend(s) fio server at hostname\n");
2209 printf(" --remote-config=file\tTell fio server to load this local job file\n");
2210 printf(" --idle-prof=option\tReport cpu idleness on a system or percpu basis\n"
2211 "\t\t\t(option=system,percpu) or run unit work\n"
2212 "\t\t\tcalibration only (option=calibrate)\n");
2214 printf(" --inflate-log=log\tInflate and output compressed log\n");
2216 printf(" --trigger-file=file\tExecute trigger cmd when file exists\n");
2217 printf(" --trigger-timeout=t\tExecute trigger at this time\n");
2218 printf(" --trigger=cmd\t\tSet this command as local trigger\n");
2219 printf(" --trigger-remote=cmd\tSet this command as remote trigger\n");
2220 printf(" --aux-path=path\tUse this path for fio state generated files\n");
2221 printf("\nFio was written by Jens Axboe <axboe@kernel.dk>\n");
2224 #ifdef FIO_INC_DEBUG
2225 const struct debug_level debug_levels[] = {
2226 { .name = "process",
2227 .help = "Process creation/exit logging",
2228 .shift = FD_PROCESS,
2231 .help = "File related action logging",
2235 .help = "IO and IO engine action logging (offsets, queue, completions, etc)",
2239 .help = "Memory allocation/freeing logging",
2242 { .name = "blktrace",
2243 .help = "blktrace action logging",
2244 .shift = FD_BLKTRACE,
2247 .help = "IO verification action logging",
2251 .help = "Random generation logging",
2255 .help = "Parser logging",
2258 { .name = "diskutil",
2259 .help = "Disk utility logging actions",
2260 .shift = FD_DISKUTIL,
2263 .help = "Logging related to creating/destroying jobs",
2267 .help = "Mutex logging",
2270 { .name = "profile",
2271 .help = "Logging related to profiles",
2272 .shift = FD_PROFILE,
2275 .help = "Logging related to time keeping functions",
2279 .help = "Network logging",
2283 .help = "Rate logging",
2286 { .name = "compress",
2287 .help = "Log compression logging",
2288 .shift = FD_COMPRESS,
2290 { .name = "steadystate",
2291 .help = "Steady state detection logging",
2292 .shift = FD_STEADYSTATE,
2294 { .name = "helperthread",
2295 .help = "Helper thread logging",
2296 .shift = FD_HELPERTHREAD,
2299 .help = "Zoned Block Device logging",
2305 static int set_debug(const char *string)
2307 const struct debug_level *dl;
2308 char *p = (char *) string;
2315 if (!strcmp(string, "?") || !strcmp(string, "help")) {
2316 log_info("fio: dumping debug options:");
2317 for (i = 0; debug_levels[i].name; i++) {
2318 dl = &debug_levels[i];
2319 log_info("%s,", dl->name);
2325 while ((opt = strsep(&p, ",")) != NULL) {
2328 if (!strncmp(opt, "all", 3)) {
2329 log_info("fio: set all debug options\n");
2334 for (i = 0; debug_levels[i].name; i++) {
2335 dl = &debug_levels[i];
2336 found = !strncmp(opt, dl->name, strlen(dl->name));
2340 if (dl->shift == FD_JOB) {
2341 opt = strchr(opt, ':');
2343 log_err("fio: missing job number\n");
2347 fio_debug_jobno = atoi(opt);
2348 log_info("fio: set debug jobno %d\n",
2351 log_info("fio: set debug option %s\n", opt);
2352 fio_debug |= (1UL << dl->shift);
2358 log_err("fio: debug mask %s not found\n", opt);
2363 static int set_debug(const char *string)
2365 log_err("fio: debug tracing not included in build\n");
2370 static void fio_options_fill_optstring(void)
2372 char *ostr = cmd_optstr;
2376 while (l_opts[i].name) {
2377 ostr[c++] = l_opts[i].val;
2378 if (l_opts[i].has_arg == required_argument)
2380 else if (l_opts[i].has_arg == optional_argument) {
2389 static int client_flag_set(char c)
2394 while (l_opts[i].name) {
2395 int val = l_opts[i].val;
2397 if (c == (val & 0xff))
2398 return (val & FIO_CLIENT_FLAG);
2406 static void parse_cmd_client(void *client, char *opt)
2408 fio_client_add_cmd_option(client, opt);
2411 static void show_closest_option(const char *name)
2413 int best_option, best_distance;
2416 while (*name == '-')
2420 best_distance = INT_MAX;
2422 while (l_opts[i].name) {
2423 distance = string_distance(name, l_opts[i].name);
2424 if (distance < best_distance) {
2425 best_distance = distance;
2431 if (best_option != -1 && string_distance_ok(name, best_distance))
2432 log_err("Did you mean %s?\n", l_opts[best_option].name);
2435 static int parse_output_format(const char *optarg)
2437 char *p, *orig, *opt;
2440 p = orig = strdup(optarg);
2444 while ((opt = strsep(&p, ",")) != NULL) {
2445 if (!strcmp(opt, "minimal") ||
2446 !strcmp(opt, "terse") ||
2447 !strcmp(opt, "csv"))
2448 output_format |= FIO_OUTPUT_TERSE;
2449 else if (!strcmp(opt, "json"))
2450 output_format |= FIO_OUTPUT_JSON;
2451 else if (!strcmp(opt, "json+"))
2452 output_format |= (FIO_OUTPUT_JSON | FIO_OUTPUT_JSON_PLUS);
2453 else if (!strcmp(opt, "normal"))
2454 output_format |= FIO_OUTPUT_NORMAL;
2456 log_err("fio: invalid output format %s\n", opt);
2466 int parse_cmd_line(int argc, char *argv[], int client_type)
2468 struct thread_data *td = NULL;
2469 int c, ini_idx = 0, lidx, ret = 0, do_exit = 0, exit_val = 0;
2470 char *ostr = cmd_optstr;
2471 char *pid_file = NULL;
2472 void *cur_client = NULL;
2476 * Reset optind handling, since we may call this multiple times
2481 while ((c = getopt_long_only(argc, argv, ostr, l_opts, &lidx)) != -1) {
2482 if ((c & FIO_CLIENT_FLAG) || client_flag_set(c)) {
2483 parse_cmd_client(cur_client, argv[optind - 1]);
2484 c &= ~FIO_CLIENT_FLAG;
2489 smalloc_pool_size = atoi(optarg);
2490 smalloc_pool_size <<= 10;
2494 log_err("fio: --latency-log is deprecated. Use per-job latency log options.\n");
2504 if (f_out && f_out != stdout)
2507 tmp = fopen(optarg, "w+");
2509 log_err("fio: output file open error: %s\n", strerror(errno));
2514 f_err = f_out = tmp;
2518 output_format = FIO_OUTPUT_TERSE;
2521 if (parse_output_format(optarg)) {
2522 log_err("fio: failed parsing output-format\n");
2529 output_format |= FIO_OUTPUT_TERSE;
2541 fio_show_option_help(optarg);
2548 fio_show_ioengine_help(optarg);
2562 log_info("%s\n", fio_version_string);
2567 terse_version = atoi(optarg);
2568 if (!(terse_version >= 2 && terse_version <= 5)) {
2569 log_err("fio: bad terse version format\n");
2575 if (!strcmp("always", optarg))
2576 eta_print = FIO_ETA_ALWAYS;
2577 else if (!strcmp("never", optarg))
2578 eta_print = FIO_ETA_NEVER;
2583 if (check_str_time(optarg, &t, 1)) {
2584 log_err("fio: failed parsing eta time %s\n", optarg);
2589 eta_new_line = t / 1000;
2590 if (!eta_new_line) {
2591 log_err("fio: eta new line time too short\n");
2600 if (check_str_time(optarg, &t, 1)) {
2601 log_err("fio: failed parsing eta interval %s\n", optarg);
2606 eta_interval_msec = t / 1000;
2607 if (eta_interval_msec < DISK_UTIL_MSEC) {
2608 log_err("fio: eta interval time too short (%umsec min)\n", DISK_UTIL_MSEC);
2615 if (set_debug(optarg))
2625 if (!strcmp(optarg, "global")) {
2626 log_err("fio: can't use global as only "
2632 new_size = (nr_job_sections + 1) * sizeof(char *);
2633 job_sections = realloc(job_sections, new_size);
2634 job_sections[nr_job_sections] = strdup(optarg);
2640 exit_val = iolog_file_inflate(optarg);
2649 exec_profile = strdup(optarg);
2651 case FIO_GETOPT_JOB: {
2652 const char *opt = l_opts[lidx].name;
2655 if (!strncmp(opt, "name", 4) && td) {
2656 ret = add_job(td, td->o.name ?: "fio", 0, 0, client_type);
2663 int is_section = !strncmp(opt, "name", 4);
2666 if (!is_section || !strncmp(val, "global", 6))
2669 if (is_section && skip_this_section(val))
2672 td = get_new_job(global, &def_thread, true, NULL);
2673 if (!td || ioengine_load(td)) {
2682 fio_options_set_ioengine_opts(l_opts, td);
2685 if ((!val || !strlen(val)) &&
2686 l_opts[lidx].has_arg == required_argument) {
2687 log_err("fio: option %s requires an argument\n", opt);
2690 ret = fio_cmd_option_parse(td, opt, val);
2701 if (!ret && !strcmp(opt, "ioengine")) {
2702 if (ioengine_load(td)) {
2709 fio_options_set_ioengine_opts(l_opts, td);
2713 case FIO_GETOPT_IOENGINE: {
2714 const char *opt = l_opts[lidx].name;
2720 ret = fio_cmd_ioengine_option_parse(td, opt, val);
2727 max_jobs = atoi(optarg);
2728 if (!max_jobs || max_jobs > REAL_MAX_JOBS) {
2729 log_err("fio: invalid max jobs: %d\n", max_jobs);
2736 #ifndef CONFIG_NO_SHM
2738 log_err("fio: can't be both client and server\n");
2744 fio_server_set_arg(optarg);
2748 log_err("fio: client/server requires SHM support\n");
2756 pid_file = strdup(optarg);
2759 if ((ret = fio_idle_prof_parse_opt(optarg))) {
2760 /* exit on error and calibration only */
2770 log_err("fio: can't be both client and server\n");
2775 /* if --client parameter contains a pathname */
2776 if (0 == access(optarg, R_OK)) {
2777 /* file contains a list of host addrs or names */
2778 char hostaddr[PATH_MAX] = {0};
2780 FILE * hostf = fopen(optarg, "r");
2782 log_err("fio: could not open client list file %s for read\n", optarg);
2787 sprintf(formatstr, "%%%ds", PATH_MAX - 1);
2789 * read at most PATH_MAX-1 chars from each
2790 * record in this file
2792 while (fscanf(hostf, formatstr, hostaddr) == 1) {
2793 /* expect EVERY host in file to be valid */
2794 if (fio_client_add(&fio_client_ops, hostaddr, &cur_client)) {
2795 log_err("fio: failed adding client %s from file %s\n", hostaddr, optarg);
2802 break; /* no possibility of job file for "this client only" */
2804 if (fio_client_add(&fio_client_ops, optarg, &cur_client)) {
2805 log_err("fio: failed adding client %s\n", optarg);
2811 * If the next argument exists and isn't an option,
2812 * assume it's a job file for this client only.
2814 while (optind < argc) {
2815 if (!strncmp(argv[optind], "--", 2) ||
2816 !strncmp(argv[optind], "-", 1))
2819 if (fio_client_add_ini_file(cur_client, argv[optind], false))
2826 if (fio_client_add_ini_file(cur_client, optarg, true)) {
2834 exit_val = fio_monotonic_clocktest(1);
2839 exit_val = fio_crctest(optarg);
2844 exit_val = fio_memcpy_test(optarg);
2849 if (check_str_time(optarg, &val, 1)) {
2850 log_err("fio: failed parsing time %s\n", optarg);
2856 log_err("fio: status interval too small\n");
2860 status_interval = val / 1000;
2866 trigger_file = strdup(optarg);
2871 trigger_cmd = strdup(optarg);
2874 if (trigger_remote_cmd)
2875 free(trigger_remote_cmd);
2876 trigger_remote_cmd = strdup(optarg);
2881 aux_path = strdup(optarg);
2884 if (check_str_time(optarg, &trigger_timeout, 1)) {
2885 log_err("fio: failed parsing time %s\n", optarg);
2889 trigger_timeout /= 1000000;
2892 log_err("%s: unrecognized option '%s'\n", argv[0],
2894 show_closest_option(argv[optind - 1]);
2904 if (do_exit && !(is_backend || nr_clients))
2907 if (nr_clients && fio_clients_connect())
2910 if (is_backend && backend)
2911 return fio_start_server(pid_file);
2917 ret = add_job(td, td->o.name ?: "fio", 0, 0, client_type);
2923 while (!ret && optind < argc) {
2925 ini_file = realloc(ini_file, ini_idx * sizeof(char *));
2926 ini_file[ini_idx - 1] = strdup(argv[optind]);
2934 int fio_init_options(void)
2939 fio_options_fill_optstring();
2940 fio_options_dup_and_init(l_opts);
2944 if (fill_def_thread())
2950 extern int fio_check_options(struct thread_options *);
2952 int parse_options(int argc, char *argv[])
2954 const int type = FIO_CLIENT_TYPE_CLI;
2957 if (fio_init_options())
2959 if (fio_test_cconv(&def_thread.o))
2960 log_err("fio: failed internal cconv test\n");
2962 job_files = parse_cmd_line(argc, argv, type);
2964 if (job_files > 0) {
2965 for (i = 0; i < job_files; i++) {
2966 if (i && fill_def_thread())
2969 if (fio_clients_send_ini(ini_file[i]))
2972 } else if (!is_backend) {
2973 if (parse_jobs_ini(ini_file[i], 0, i, type))
2978 } else if (nr_clients) {
2979 if (fill_def_thread())
2981 if (fio_clients_send_ini(NULL))
2986 fio_options_free(&def_thread);
2987 filesetup_mem_free();
2989 if (!thread_number) {
2994 if (is_backend || nr_clients)
2999 log_err("No job(s) defined\n\n");
3004 if (output_format & FIO_OUTPUT_NORMAL)
3005 log_info("%s\n", fio_version_string);
3010 void options_default_fill(struct thread_options *o)
3012 memcpy(o, &def_thread.o, sizeof(*o));
3015 struct thread_data *get_global_options(void)