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 bool dump_cmdline;
49 static bool parse_only;
50 static bool merge_blktrace_only;
52 static struct thread_data def_thread;
53 struct thread_segment segments[REAL_MAX_SEG];
54 static char **job_sections;
55 static int nr_job_sections;
57 bool exitall_on_terminate = false;
58 int output_format = FIO_OUTPUT_NORMAL;
59 int eta_print = FIO_ETA_AUTO;
60 unsigned int eta_interval_msec = 1000;
64 char *exec_profile = NULL;
65 int warnings_fatal = 0;
66 int terse_version = 3;
67 bool is_backend = false;
68 bool is_local_backend = false;
70 bool log_syslog = false;
72 bool write_bw_log = false;
73 bool read_only = false;
74 int status_interval = 0;
76 char *trigger_file = NULL;
77 long long trigger_timeout = 0;
78 char *trigger_cmd = NULL;
79 char *trigger_remote_cmd = NULL;
81 char *aux_path = NULL;
83 static int prev_group_jobs;
85 unsigned long fio_debug = 0;
86 unsigned int fio_debug_jobno = -1;
87 unsigned int *fio_debug_jobp = NULL;
88 unsigned int *fio_warned = NULL;
90 static char cmd_optstr[256];
93 #define FIO_CLIENT_FLAG (1 << 16)
96 * Command line options. These will contain the above, plus a few
97 * extra that only pertain to fio itself and not jobs.
99 static struct option l_opts[FIO_NR_OPTIONS] = {
101 .name = (char *) "output",
102 .has_arg = required_argument,
103 .val = 'o' | FIO_CLIENT_FLAG,
106 .name = (char *) "latency-log",
107 .has_arg = required_argument,
108 .val = 'l' | FIO_CLIENT_FLAG,
111 .name = (char *) "bandwidth-log",
112 .has_arg = no_argument,
113 .val = 'b' | FIO_CLIENT_FLAG,
116 .name = (char *) "minimal",
117 .has_arg = no_argument,
118 .val = 'm' | FIO_CLIENT_FLAG,
121 .name = (char *) "output-format",
122 .has_arg = required_argument,
123 .val = 'F' | FIO_CLIENT_FLAG,
126 .name = (char *) "append-terse",
127 .has_arg = optional_argument,
131 .name = (char *) "version",
132 .has_arg = no_argument,
133 .val = 'v' | FIO_CLIENT_FLAG,
136 .name = (char *) "help",
137 .has_arg = no_argument,
138 .val = 'h' | FIO_CLIENT_FLAG,
141 .name = (char *) "cmdhelp",
142 .has_arg = optional_argument,
143 .val = 'c' | FIO_CLIENT_FLAG,
146 .name = (char *) "enghelp",
147 .has_arg = optional_argument,
148 .val = 'i' | FIO_CLIENT_FLAG,
151 .name = (char *) "showcmd",
152 .has_arg = no_argument,
153 .val = 's' | FIO_CLIENT_FLAG,
156 .name = (char *) "readonly",
157 .has_arg = no_argument,
158 .val = 'r' | FIO_CLIENT_FLAG,
161 .name = (char *) "eta",
162 .has_arg = required_argument,
163 .val = 'e' | FIO_CLIENT_FLAG,
166 .name = (char *) "eta-interval",
167 .has_arg = required_argument,
168 .val = 'O' | FIO_CLIENT_FLAG,
171 .name = (char *) "eta-newline",
172 .has_arg = required_argument,
173 .val = 'E' | FIO_CLIENT_FLAG,
176 .name = (char *) "debug",
177 .has_arg = required_argument,
178 .val = 'd' | FIO_CLIENT_FLAG,
181 .name = (char *) "parse-only",
182 .has_arg = no_argument,
183 .val = 'P' | FIO_CLIENT_FLAG,
186 .name = (char *) "section",
187 .has_arg = required_argument,
188 .val = 'x' | FIO_CLIENT_FLAG,
192 .name = (char *) "inflate-log",
193 .has_arg = required_argument,
194 .val = 'X' | FIO_CLIENT_FLAG,
198 .name = (char *) "alloc-size",
199 .has_arg = required_argument,
200 .val = 'a' | FIO_CLIENT_FLAG,
203 .name = (char *) "profile",
204 .has_arg = required_argument,
205 .val = 'p' | FIO_CLIENT_FLAG,
208 .name = (char *) "warnings-fatal",
209 .has_arg = no_argument,
210 .val = 'w' | FIO_CLIENT_FLAG,
213 .name = (char *) "max-jobs",
214 .has_arg = required_argument,
215 .val = 'j' | FIO_CLIENT_FLAG,
218 .name = (char *) "terse-version",
219 .has_arg = required_argument,
220 .val = 'V' | FIO_CLIENT_FLAG,
223 .name = (char *) "server",
224 .has_arg = optional_argument,
229 .name = (char *) "server-internal",
230 .has_arg = required_argument,
234 { .name = (char *) "daemonize",
235 .has_arg = required_argument,
239 .name = (char *) "client",
240 .has_arg = required_argument,
244 .name = (char *) "remote-config",
245 .has_arg = required_argument,
249 .name = (char *) "cpuclock-test",
250 .has_arg = no_argument,
254 .name = (char *) "crctest",
255 .has_arg = optional_argument,
259 .name = (char *) "memcpytest",
260 .has_arg = optional_argument,
264 .name = (char *) "idle-prof",
265 .has_arg = required_argument,
269 .name = (char *) "status-interval",
270 .has_arg = required_argument,
271 .val = 'L' | FIO_CLIENT_FLAG,
274 .name = (char *) "trigger-file",
275 .has_arg = required_argument,
279 .name = (char *) "trigger-timeout",
280 .has_arg = required_argument,
284 .name = (char *) "trigger",
285 .has_arg = required_argument,
289 .name = (char *) "trigger-remote",
290 .has_arg = required_argument,
294 .name = (char *) "aux-path",
295 .has_arg = required_argument,
299 .name = (char *) "merge-blktrace-only",
300 .has_arg = no_argument,
301 .val = 'A' | FIO_CLIENT_FLAG,
308 void free_threads_shm(void)
312 for (i = 0; i < nr_segments; i++) {
313 struct thread_segment *seg = &segments[i];
316 void *tp = seg->threads;
317 #ifndef CONFIG_NO_SHM
318 struct shmid_ds sbuf;
322 shmctl(seg->shm_id, IPC_RMID, &sbuf);
335 static void free_shm(void)
337 #ifndef FUZZING_BUILD_MODE_UNSAFE_FOR_PRODUCTION
340 fio_debug_jobp = NULL;
347 free(trigger_remote_cmd);
348 trigger_file = trigger_cmd = trigger_remote_cmd = NULL;
350 options_free(fio_options, &def_thread.o);
357 static int add_thread_segment(void)
359 struct thread_segment *seg = &segments[nr_segments];
360 size_t size = JOBS_PER_SEG * sizeof(struct thread_data);
363 if (nr_segments + 1 >= REAL_MAX_SEG) {
364 log_err("error: maximum number of jobs reached.\n");
368 size += 2 * sizeof(unsigned int);
370 #ifndef CONFIG_NO_SHM
371 seg->shm_id = shmget(0, size, IPC_CREAT | 0600);
372 if (seg->shm_id == -1) {
373 if (errno != EINVAL && errno != ENOMEM && errno != ENOSPC)
378 seg->threads = malloc(size);
383 #ifndef CONFIG_NO_SHM
384 seg->threads = shmat(seg->shm_id, NULL, 0);
385 if (seg->threads == (void *) -1) {
389 if (shm_attach_to_open_removed())
390 shmctl(seg->shm_id, IPC_RMID, NULL);
395 memset(seg->threads, 0, JOBS_PER_SEG * sizeof(struct thread_data));
396 for (i = 0; i < JOBS_PER_SEG; i++)
397 DRD_IGNORE_VAR(seg->threads[i]);
400 /* Not first segment, we're done */
401 if (nr_segments != 1) {
406 fio_debug_jobp = (unsigned int *)(seg->threads + JOBS_PER_SEG);
407 *fio_debug_jobp = -1;
408 fio_warned = fio_debug_jobp + 1;
416 * The thread areas are shared between the main process and the job
417 * threads/processes, and is split into chunks of JOBS_PER_SEG. If the current
418 * segment has no more room, add a new chunk.
420 static int expand_thread_area(void)
422 struct thread_segment *seg = &segments[cur_segment];
424 if (nr_segments && seg->nr_threads < JOBS_PER_SEG)
427 return add_thread_segment();
430 static void dump_print_option(struct print_option *p)
434 if (!strcmp("description", p->name))
439 log_info("--%s%s", p->name, p->value ? "" : " ");
441 log_info("=%s%s%s ", delim, p->value, delim);
444 static void dump_opt_list(struct thread_data *td)
446 struct flist_head *entry;
447 struct print_option *p;
449 if (flist_empty(&td->opt_list))
452 flist_for_each(entry, &td->opt_list) {
453 p = flist_entry(entry, struct print_option, list);
454 dump_print_option(p);
458 static void copy_opt_list(struct thread_data *dst, struct thread_data *src)
460 struct flist_head *entry;
462 if (flist_empty(&src->opt_list))
465 flist_for_each(entry, &src->opt_list) {
466 struct print_option *srcp, *dstp;
468 srcp = flist_entry(entry, struct print_option, list);
469 dstp = malloc(sizeof(*dstp));
470 dstp->name = strdup(srcp->name);
472 dstp->value = strdup(srcp->value);
475 flist_add_tail(&dstp->list, &dst->opt_list);
480 * Return a free job structure.
482 static struct thread_data *get_new_job(bool global, struct thread_data *parent,
483 bool preserve_eo, const char *jobname)
485 struct thread_segment *seg;
486 struct thread_data *td;
490 if (expand_thread_area()) {
491 log_err("error: failed to setup shm segment\n");
495 seg = &segments[cur_segment];
496 td = &seg->threads[seg->nr_threads++];
500 INIT_FLIST_HEAD(&td->opt_list);
501 if (parent != &def_thread)
502 copy_opt_list(td, parent);
509 td->o.uid = td->o.gid = -1U;
511 dup_files(td, parent);
512 fio_options_mem_dupe(td);
514 profile_add_hooks(td);
516 td->thread_number = thread_number;
517 td->subjob_number = 0;
520 td->o.name = strdup(jobname);
522 if (!parent->o.group_reporting || parent == &def_thread)
528 static void put_job(struct thread_data *td)
530 if (td == &def_thread)
537 log_info("fio: %s\n", td->verror);
539 fio_options_free(td);
540 fio_dump_options_free(td);
547 memset(td, 0, sizeof(*td));
548 segments[cur_segment].nr_threads--;
552 static int __setup_rate(struct thread_data *td, enum fio_ddir ddir)
554 unsigned long long bs = td->o.min_bs[ddir];
556 assert(ddir_rw(ddir));
558 if (td->o.rate[ddir])
559 td->rate_bps[ddir] = td->o.rate[ddir];
561 td->rate_bps[ddir] = (uint64_t) td->o.rate_iops[ddir] * bs;
563 if (!td->rate_bps[ddir]) {
564 log_err("rate lower than supported\n");
568 td->rate_next_io_time[ddir] = 0;
569 td->rate_io_issue_bytes[ddir] = 0;
570 td->last_usec[ddir] = 0;
574 static int setup_rate(struct thread_data *td)
578 for_each_rw_ddir(ddir) {
579 if (td->o.rate[ddir] || td->o.rate_iops[ddir]) {
580 ret |= __setup_rate(td, ddir);
586 static int fixed_block_size(struct thread_options *o)
588 return o->min_bs[DDIR_READ] == o->max_bs[DDIR_READ] &&
589 o->min_bs[DDIR_WRITE] == o->max_bs[DDIR_WRITE] &&
590 o->min_bs[DDIR_TRIM] == o->max_bs[DDIR_TRIM] &&
591 o->min_bs[DDIR_READ] == o->min_bs[DDIR_WRITE] &&
592 o->min_bs[DDIR_READ] == o->min_bs[DDIR_TRIM];
598 static unsigned int gcd(unsigned int m, unsigned int n)
603 return gcd(n, m % n);
607 * Lazy way of fixing up options that depend on each other. We could also
608 * define option callback handlers, but this is easier.
610 static int fixup_options(struct thread_data *td)
612 struct thread_options *o = &td->o;
615 if (read_only && (td_write(td) || td_trim(td))) {
616 log_err("fio: trim and write operations are not allowed"
617 " with the --readonly parameter.\n");
621 #ifndef CONFIG_PSHARED
622 if (!o->use_thread) {
623 log_info("fio: this platform does not support process shared"
624 " mutexes, forcing use of threads. Use the 'thread'"
625 " option to get rid of this warning.\n");
627 ret |= warnings_fatal;
631 if (o->write_iolog_file && o->read_iolog_file) {
632 log_err("fio: read iolog overrides write_iolog\n");
633 free(o->write_iolog_file);
634 o->write_iolog_file = NULL;
635 ret |= warnings_fatal;
638 if (o->zone_mode == ZONE_MODE_NONE && o->zone_size) {
639 log_err("fio: --zonemode=none and --zonesize are not compatible.\n");
643 if (o->zone_mode == ZONE_MODE_ZBD && !o->create_serialize) {
644 log_err("fio: --zonemode=zbd and --create_serialize=0 are not compatible.\n");
648 if (o->zone_mode == ZONE_MODE_STRIDED && !o->zone_size) {
649 log_err("fio: --zonesize must be specified when using --zonemode=strided.\n");
653 if (o->zone_mode == ZONE_MODE_NOT_SPECIFIED) {
655 o->zone_mode = ZONE_MODE_STRIDED;
657 o->zone_mode = ZONE_MODE_NONE;
661 * Strided zone mode only really works with 1 file.
663 if (o->zone_mode == ZONE_MODE_STRIDED && o->open_files > 1)
664 o->zone_mode = ZONE_MODE_NONE;
667 * If zone_range isn't specified, backward compatibility dictates it
668 * should be made equal to zone_size.
670 if (o->zone_mode == ZONE_MODE_STRIDED && !o->zone_range)
671 o->zone_range = o->zone_size;
674 * Reads can do overwrites, we always need to pre-create the file
679 for_each_rw_ddir(ddir) {
680 if (!o->min_bs[ddir])
681 o->min_bs[ddir] = o->bs[ddir];
682 if (!o->max_bs[ddir])
683 o->max_bs[ddir] = o->bs[ddir];
687 for_each_rw_ddir(ddir) {
688 o->rw_min_bs = min(o->rw_min_bs, o->min_bs[ddir]);
692 * For random IO, allow blockalign offset other than min_bs.
694 for_each_rw_ddir(ddir) {
695 if (!o->ba[ddir] || !td_random(td))
696 o->ba[ddir] = o->min_bs[ddir];
699 if ((o->ba[DDIR_READ] != o->min_bs[DDIR_READ] ||
700 o->ba[DDIR_WRITE] != o->min_bs[DDIR_WRITE] ||
701 o->ba[DDIR_TRIM] != o->min_bs[DDIR_TRIM]) &&
703 log_err("fio: Any use of blockalign= turns off randommap\n");
705 ret |= warnings_fatal;
708 if (!o->file_size_high)
709 o->file_size_high = o->file_size_low;
711 if (o->start_delay_high) {
712 if (!o->start_delay_orig)
713 o->start_delay_orig = o->start_delay;
714 o->start_delay = rand_between(&td->delay_state,
716 o->start_delay_high);
719 if (o->norandommap && o->verify != VERIFY_NONE
720 && !fixed_block_size(o)) {
721 log_err("fio: norandommap given for variable block sizes, "
723 ret |= warnings_fatal;
725 if (o->bs_unaligned && (o->odirect || td_ioengine_flagged(td, FIO_RAWIO)))
726 log_err("fio: bs_unaligned may not work with raw io\n");
729 * thinktime_spin must be less than thinktime
731 if (o->thinktime_spin > o->thinktime)
732 o->thinktime_spin = o->thinktime;
735 * The low water mark cannot be bigger than the iodepth
737 if (o->iodepth_low > o->iodepth || !o->iodepth_low)
738 o->iodepth_low = o->iodepth;
741 * If batch number isn't set, default to the same as iodepth
743 if (o->iodepth_batch > o->iodepth || !o->iodepth_batch)
744 o->iodepth_batch = o->iodepth;
747 * If max batch complete number isn't set or set incorrectly,
748 * default to the same as iodepth_batch_complete_min
750 if (o->iodepth_batch_complete_min > o->iodepth_batch_complete_max)
751 o->iodepth_batch_complete_max = o->iodepth_batch_complete_min;
754 * There's no need to check for in-flight overlapping IOs if the job
755 * isn't changing data or the maximum iodepth is guaranteed to be 1
756 * when we are not in offload mode
758 if (o->serialize_overlap && !(td->flags & TD_F_READ_IOLOG) &&
759 (!(td_write(td) || td_trim(td)) || o->iodepth == 1) &&
760 o->io_submit_mode != IO_MODE_OFFLOAD)
761 o->serialize_overlap = 0;
763 if (o->nr_files > td->files_index)
764 o->nr_files = td->files_index;
766 if (o->open_files > o->nr_files || !o->open_files)
767 o->open_files = o->nr_files;
769 if (((o->rate[DDIR_READ] + o->rate[DDIR_WRITE] + o->rate[DDIR_TRIM]) &&
770 (o->rate_iops[DDIR_READ] + o->rate_iops[DDIR_WRITE] + o->rate_iops[DDIR_TRIM])) ||
771 ((o->ratemin[DDIR_READ] + o->ratemin[DDIR_WRITE] + o->ratemin[DDIR_TRIM]) &&
772 (o->rate_iops_min[DDIR_READ] + o->rate_iops_min[DDIR_WRITE] + o->rate_iops_min[DDIR_TRIM]))) {
773 log_err("fio: rate and rate_iops are mutually exclusive\n");
776 for_each_rw_ddir(ddir) {
777 if ((o->rate[ddir] && (o->rate[ddir] < o->ratemin[ddir])) ||
778 (o->rate_iops[ddir] && (o->rate_iops[ddir] < o->rate_iops_min[ddir]))) {
779 log_err("fio: minimum rate exceeds rate, ddir %d\n", +ddir);
784 if (!o->timeout && o->time_based) {
785 log_err("fio: time_based requires a runtime/timeout setting\n");
787 ret |= warnings_fatal;
790 if (o->fill_device && !o->size)
793 if (o->verify != VERIFY_NONE) {
794 if (td_write(td) && o->do_verify && o->numjobs > 1 &&
796 !(o->unique_filename &&
797 strstr(o->filename_format, "$jobname") &&
798 strstr(o->filename_format, "$jobnum") &&
799 strstr(o->filename_format, "$filenum")))) {
800 log_info("fio: multiple writers may overwrite blocks "
801 "that belong to other jobs. This can cause "
802 "verification failures.\n");
803 ret |= warnings_fatal;
807 * Warn if verification is requested but no verification of any
808 * kind can be started due to time constraints
810 if (td_write(td) && o->do_verify && o->timeout &&
811 o->time_based && !td_read(td) && !o->verify_backlog) {
812 log_info("fio: verification read phase will never "
813 "start because write phase uses all of "
815 ret |= warnings_fatal;
818 if (!fio_option_is_set(o, refill_buffers))
819 o->refill_buffers = 1;
821 if (o->max_bs[DDIR_WRITE] != o->min_bs[DDIR_WRITE] &&
823 o->verify_interval = o->min_bs[DDIR_WRITE];
826 * Verify interval must be smaller or equal to the
829 if (o->verify_interval > o->min_bs[DDIR_WRITE])
830 o->verify_interval = o->min_bs[DDIR_WRITE];
831 else if (td_read(td) && o->verify_interval > o->min_bs[DDIR_READ])
832 o->verify_interval = o->min_bs[DDIR_READ];
835 * Verify interval must be a factor of both min and max
838 if (!o->verify_interval ||
839 (o->min_bs[DDIR_WRITE] % o->verify_interval) ||
840 (o->max_bs[DDIR_WRITE] % o->verify_interval))
841 o->verify_interval = gcd(o->min_bs[DDIR_WRITE],
842 o->max_bs[DDIR_WRITE]);
846 if (o->invalidate_cache)
847 o->invalidate_cache = 0;
848 if (td_ioengine_flagged(td, FIO_PIPEIO)) {
849 log_info("fio: cannot pre-read files with an IO engine"
850 " that isn't seekable. Pre-read disabled.\n");
851 ret |= warnings_fatal;
855 if (o->unit_base == N2S_NONE) {
856 if (td_ioengine_flagged(td, FIO_BIT_BASED))
857 o->unit_base = N2S_BITPERSEC;
859 o->unit_base = N2S_BYTEPERSEC;
862 #ifndef CONFIG_FDATASYNC
863 if (o->fdatasync_blocks) {
864 log_info("fio: this platform does not support fdatasync()"
865 " falling back to using fsync(). Use the 'fsync'"
866 " option instead of 'fdatasync' to get rid of"
868 o->fsync_blocks = o->fdatasync_blocks;
869 o->fdatasync_blocks = 0;
870 ret |= warnings_fatal;
876 * Windows doesn't support O_DIRECT or O_SYNC with the _open interface,
877 * so fail if we're passed those flags
879 if (td_ioengine_flagged(td, FIO_SYNCIO) && (o->odirect || o->sync_io)) {
880 log_err("fio: Windows does not support direct or non-buffered io with"
881 " the synchronous ioengines. Use the 'windowsaio' ioengine"
882 " with 'direct=1' and 'iodepth=1' instead.\n");
888 * For fully compressible data, just zero them at init time.
889 * It's faster than repeatedly filling it. For non-zero
890 * compression, we should have refill_buffers set. Set it, unless
891 * the job file already changed it.
893 if (o->compress_percentage) {
894 if (o->compress_percentage == 100) {
896 o->compress_percentage = 0;
897 } else if (!fio_option_is_set(o, refill_buffers)) {
898 o->refill_buffers = 1;
899 td->flags |= TD_F_REFILL_BUFFERS;
904 * Using a non-uniform random distribution excludes usage of
907 if (o->random_distribution != FIO_RAND_DIST_RANDOM)
911 * If size is set but less than the min block size, complain
913 if (o->size && o->size < td_min_bs(td)) {
914 log_err("fio: size too small, must not be less than minimum block size: %llu < %llu\n",
915 (unsigned long long) o->size, td_min_bs(td));
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);
948 o->lat_percentiles = 0;
950 o->clat_percentiles = 0;
952 o->slat_percentiles = 0;
955 * Fix these up to be nsec internally
957 for_each_rw_ddir(ddir)
958 o->max_latency[ddir] *= 1000ULL;
960 o->latency_target *= 1000ULL;
963 * Dedupe working set verifications
965 if (o->dedupe_percentage && o->dedupe_mode == DEDUPE_MODE_WORKING_SET) {
966 if (!fio_option_is_set(o, size)) {
967 log_err("fio: pregenerated dedupe working set "
968 "requires size to be set\n");
970 } else if (o->nr_files != 1) {
971 log_err("fio: dedupe working set mode supported with "
972 "single file per job, but %d files "
973 "provided\n", o->nr_files);
975 } else if (o->dedupe_working_set_percentage + o->dedupe_percentage > 100) {
976 log_err("fio: impossible to reach expected dedupe percentage %u "
977 "since %u percentage of size is reserved to dedupe working set "
978 "(those are unique pages)\n",
979 o->dedupe_percentage, o->dedupe_working_set_percentage);
985 if (td->o.ss_check_interval != td2->o.ss_check_interval) {
986 log_err("fio: conflicting ss_check_interval: %llu and %llu, must be globally equal\n",
987 td->o.ss_check_interval, td2->o.ss_check_interval);
991 if (td->o.ss_dur && td->o.ss_check_interval / 1000L < 1000) {
992 log_err("fio: ss_check_interval must be at least 1s\n");
996 if (td->o.ss_dur && (td->o.ss_dur % td->o.ss_check_interval != 0 || td->o.ss_dur <= td->o.ss_check_interval)) {
997 log_err("fio: ss_duration %lluus must be multiple of ss_check_interval %lluus\n",
998 td->o.ss_dur, td->o.ss_check_interval);
1006 static void init_rand_file_service(struct thread_data *td)
1008 unsigned long nranges = td->o.nr_files << FIO_FSERVICE_SHIFT;
1009 const unsigned int seed = td->rand_seeds[FIO_RAND_FILE_OFF];
1011 if (td->o.file_service_type == FIO_FSERVICE_ZIPF) {
1012 zipf_init(&td->next_file_zipf, nranges, td->zipf_theta, td->random_center, seed);
1013 zipf_disable_hash(&td->next_file_zipf);
1014 } else if (td->o.file_service_type == FIO_FSERVICE_PARETO) {
1015 pareto_init(&td->next_file_zipf, nranges, td->pareto_h, td->random_center, seed);
1016 zipf_disable_hash(&td->next_file_zipf);
1017 } else if (td->o.file_service_type == FIO_FSERVICE_GAUSS) {
1018 gauss_init(&td->next_file_gauss, nranges, td->gauss_dev, td->random_center, seed);
1019 gauss_disable_hash(&td->next_file_gauss);
1023 void td_fill_rand_seeds(struct thread_data *td)
1025 uint64_t read_seed = td->rand_seeds[FIO_RAND_BS_OFF];
1026 uint64_t write_seed = td->rand_seeds[FIO_RAND_BS1_OFF];
1027 uint64_t trim_seed = td->rand_seeds[FIO_RAND_BS2_OFF];
1031 if (td->o.random_generator == FIO_RAND_GEN_TAUSWORTHE64)
1037 * trimwrite is special in that we need to generate the same
1038 * offsets to get the "write after trim" effect. If we are
1039 * using bssplit to set buffer length distributions, ensure that
1040 * we seed the trim and write generators identically. Ditto for
1041 * verify, read and writes must have the same seed, if we are doing
1044 if (td->o.verify != VERIFY_NONE)
1045 write_seed = read_seed;
1046 if (td_trimwrite(td))
1047 trim_seed = write_seed;
1048 init_rand_seed(&td->bsrange_state[DDIR_READ], read_seed, use64);
1049 init_rand_seed(&td->bsrange_state[DDIR_WRITE], write_seed, use64);
1050 init_rand_seed(&td->bsrange_state[DDIR_TRIM], trim_seed, use64);
1052 init_rand_seed(&td->verify_state, td->rand_seeds[FIO_RAND_VER_OFF],
1054 init_rand_seed(&td->rwmix_state, td->rand_seeds[FIO_RAND_MIX_OFF], false);
1056 if (td->o.file_service_type == FIO_FSERVICE_RANDOM)
1057 init_rand_seed(&td->next_file_state, td->rand_seeds[FIO_RAND_FILE_OFF], use64);
1058 else if (td->o.file_service_type & __FIO_FSERVICE_NONUNIFORM)
1059 init_rand_file_service(td);
1061 init_rand_seed(&td->file_size_state, td->rand_seeds[FIO_RAND_FILE_SIZE_OFF], use64);
1062 init_rand_seed(&td->trim_state, td->rand_seeds[FIO_RAND_TRIM_OFF], use64);
1063 init_rand_seed(&td->delay_state, td->rand_seeds[FIO_RAND_START_DELAY], use64);
1064 init_rand_seed(&td->poisson_state[0], td->rand_seeds[FIO_RAND_POISSON_OFF], 0);
1065 init_rand_seed(&td->poisson_state[1], td->rand_seeds[FIO_RAND_POISSON2_OFF], 0);
1066 init_rand_seed(&td->poisson_state[2], td->rand_seeds[FIO_RAND_POISSON3_OFF], 0);
1067 init_rand_seed(&td->dedupe_state, td->rand_seeds[FIO_DEDUPE_OFF], false);
1068 init_rand_seed(&td->zone_state, td->rand_seeds[FIO_RAND_ZONE_OFF], false);
1069 init_rand_seed(&td->prio_state, td->rand_seeds[FIO_RAND_PRIO_CMDS], false);
1070 init_rand_seed(&td->dedupe_working_set_index_state, td->rand_seeds[FIO_RAND_DEDUPE_WORKING_SET_IX], use64);
1072 init_rand_seed(&td->random_state, td->rand_seeds[FIO_RAND_BLOCK_OFF], use64);
1074 for (i = 0; i < DDIR_RWDIR_CNT; i++) {
1075 struct frand_state *s = &td->seq_rand_state[i];
1077 init_rand_seed(s, td->rand_seeds[FIO_RAND_SEQ_RAND_READ_OFF], false);
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);
1084 static int setup_random_seeds(struct thread_data *td)
1089 if (!td->o.rand_repeatable && !fio_option_is_set(&td->o, rand_seed)) {
1090 int ret = init_random_seeds(td->rand_seeds, sizeof(td->rand_seeds));
1091 dprint(FD_RANDOM, "using system RNG for random seeds\n");
1095 seed = td->o.rand_seed;
1096 for (i = 0; i < 4; i++)
1097 seed *= 0x9e370001UL;
1099 for (i = 0; i < FIO_RAND_NR_OFFS; i++) {
1100 td->rand_seeds[i] = seed * td->thread_number + i;
1101 seed *= 0x9e370001UL;
1105 td_fill_rand_seeds(td);
1107 dprint(FD_RANDOM, "FIO_RAND_NR_OFFS=%d\n", FIO_RAND_NR_OFFS);
1108 for (int i = 0; i < FIO_RAND_NR_OFFS; i++)
1109 dprint(FD_RANDOM, "rand_seeds[%d]=%" PRIu64 "\n", i, td->rand_seeds[i]);
1115 * Initializes the ioengine configured for a job, if it has not been done so
1118 int ioengine_load(struct thread_data *td)
1120 if (!td->o.ioengine) {
1121 log_err("fio: internal fault, no IO engine specified\n");
1126 struct ioengine_ops *ops;
1129 /* An engine is loaded, but the requested ioengine
1132 if (!strcmp(td->io_ops->name, td->o.ioengine)) {
1133 /* The right engine is already loaded */
1138 * Name of file and engine may be different, load ops
1139 * for this name and see if they match. If they do, then
1140 * the engine is unchanged.
1142 dlhandle = td->io_ops->dlhandle;
1143 ops = load_ioengine(td);
1147 if (ops == td->io_ops && dlhandle == td->io_ops->dlhandle)
1150 if (dlhandle && dlhandle != td->io_ops->dlhandle)
1153 /* Unload the old engine. */
1157 td->io_ops = load_ioengine(td);
1161 if (td->io_ops->option_struct_size && td->io_ops->options) {
1163 * In cases where td->eo is set, clone it for a child thread.
1164 * This requires that the parent thread has the same ioengine,
1165 * but that requirement must be enforced by the code which
1166 * cloned the thread.
1168 void *origeo = td->eo;
1170 * Otherwise use the default thread options.
1172 if (!origeo && td != &def_thread && def_thread.eo &&
1173 def_thread.io_ops->options == td->io_ops->options)
1174 origeo = def_thread.eo;
1176 options_init(td->io_ops->options);
1177 td->eo = malloc(td->io_ops->option_struct_size);
1179 * Use the default thread as an option template if this uses the
1180 * same options structure and there are non-default options
1184 memcpy(td->eo, origeo, td->io_ops->option_struct_size);
1185 options_mem_dupe(td->io_ops->options, td->eo);
1187 memset(td->eo, 0, td->io_ops->option_struct_size);
1188 fill_default_options(td->eo, td->io_ops->options);
1190 *(struct thread_data **)td->eo = td;
1194 td->io_ops->flags |= FIO_RAWIO;
1196 td_set_ioengine_flags(td);
1200 log_err("fio: failed to load engine\n");
1205 static void init_flags(struct thread_data *td)
1207 struct thread_options *o = &td->o;
1210 if (o->verify_backlog)
1211 td->flags |= TD_F_VER_BACKLOG;
1212 if (o->trim_backlog)
1213 td->flags |= TD_F_TRIM_BACKLOG;
1214 if (o->read_iolog_file)
1215 td->flags |= TD_F_READ_IOLOG;
1216 if (o->refill_buffers)
1217 td->flags |= TD_F_REFILL_BUFFERS;
1219 * Always scramble buffers if asked to
1221 if (o->scramble_buffers && fio_option_is_set(o, scramble_buffers))
1222 td->flags |= TD_F_SCRAMBLE_BUFFERS;
1224 * But also scramble buffers, unless we were explicitly asked
1227 if (o->scramble_buffers && !(o->zero_buffers &&
1228 fio_option_is_set(o, zero_buffers)))
1229 td->flags |= TD_F_SCRAMBLE_BUFFERS;
1230 if (o->verify != VERIFY_NONE)
1231 td->flags |= TD_F_DO_VERIFY;
1233 if (o->verify_async || o->io_submit_mode == IO_MODE_OFFLOAD)
1234 td->flags |= TD_F_NEED_LOCK;
1236 if (o->mem_type == MEM_CUDA_MALLOC)
1237 td->flags &= ~TD_F_SCRAMBLE_BUFFERS;
1239 for (i = 0; i < DDIR_RWDIR_CNT; i++) {
1240 if (option_check_rate(td, i)) {
1241 td->flags |= TD_F_CHECK_RATE;
1255 static struct fpre_keyword {
1256 const char *keyword;
1259 } fpre_keywords[] = {
1260 { .keyword = "$jobname", .key = FPRE_JOBNAME, },
1261 { .keyword = "$jobnum", .key = FPRE_JOBNUM, },
1262 { .keyword = "$filenum", .key = FPRE_FILENUM, },
1263 { .keyword = "$clientuid", .key = FPRE_CLIENTUID, },
1264 { .keyword = NULL, },
1267 static char *make_filename(char *buf, size_t buf_size,struct thread_options *o,
1268 const char *jobname, int jobnum, int filenum)
1270 struct fpre_keyword *f;
1271 char copy[PATH_MAX];
1272 size_t dst_left = PATH_MAX - 1;
1274 if (!o->filename_format || !strlen(o->filename_format)) {
1275 sprintf(buf, "%s.%d.%d", jobname, jobnum, filenum);
1279 for (f = &fpre_keywords[0]; f->keyword; f++)
1280 f->strlen = strlen(f->keyword);
1282 snprintf(buf, buf_size, "%s", o->filename_format);
1284 memset(copy, 0, sizeof(copy));
1285 for (f = &fpre_keywords[0]; f->keyword; f++) {
1287 size_t pre_len, post_start = 0;
1288 char *str, *dst = copy;
1290 str = strcasestr(buf, f->keyword);
1294 pre_len = str - buf;
1295 if (strlen(str) != f->strlen)
1296 post_start = pre_len + f->strlen;
1299 strncpy(dst, buf, pre_len);
1301 dst_left -= pre_len;
1305 case FPRE_JOBNAME: {
1308 ret = snprintf(dst, dst_left, "%s", jobname);
1311 else if (ret > dst_left) {
1312 log_err("fio: truncated filename\n");
1324 ret = snprintf(dst, dst_left, "%d", jobnum);
1327 else if (ret > dst_left) {
1328 log_err("fio: truncated filename\n");
1337 case FPRE_FILENUM: {
1340 ret = snprintf(dst, dst_left, "%d", filenum);
1343 else if (ret > dst_left) {
1344 log_err("fio: truncated filename\n");
1353 case FPRE_CLIENTUID: {
1355 ret = snprintf(dst, dst_left, "%s", client_sockaddr_str);
1358 else if (ret > dst_left) {
1359 log_err("fio: truncated filename\n");
1374 strncpy(dst, buf + post_start, dst_left);
1376 snprintf(buf, buf_size, "%s", copy);
1383 bool parse_dryrun(void)
1385 return dump_cmdline || parse_only;
1388 static void gen_log_name(char *name, size_t size, const char *logtype,
1389 const char *logname, unsigned int num,
1390 const char *suf, int per_job)
1393 snprintf(name, size, "%s_%s.%d.%s", logname, logtype, num, suf);
1395 snprintf(name, size, "%s_%s.%s", logname, logtype, suf);
1398 static int check_waitees(char *waitee)
1403 if (td->subjob_number)
1406 ret += !strcmp(td->o.name, waitee);
1412 static bool wait_for_ok(const char *jobname, struct thread_options *o)
1419 if (!strcmp(jobname, o->wait_for)) {
1420 log_err("%s: a job cannot wait for itself (wait_for=%s).\n",
1421 jobname, o->wait_for);
1425 if (!(nw = check_waitees(o->wait_for))) {
1426 log_err("%s: waitee job %s unknown.\n", jobname, o->wait_for);
1431 log_err("%s: multiple waitees %s found,\n"
1432 "please avoid duplicates when using wait_for option.\n",
1433 jobname, o->wait_for);
1440 static int verify_per_group_options(struct thread_data *td, const char *jobname)
1443 if (td->groupid != td2->groupid)
1447 td->o.lat_percentiles != td2->o.lat_percentiles) {
1448 log_err("fio: lat_percentiles in job: %s differs from group\n",
1458 * Treat an empty log file name the same as a one not given
1460 static const char *make_log_name(const char *logname, const char *jobname)
1462 if (logname && strcmp(logname, ""))
1469 * Adds a job to the list of things todo. Sanitizes the various options
1470 * to make sure we don't have conflicts, and initializes various
1473 static int add_job(struct thread_data *td, const char *jobname, int job_add_num,
1474 int recursed, int client_type)
1477 char fname[PATH_MAX + 1];
1478 int numjobs, file_alloced;
1479 struct thread_options *o = &td->o;
1480 char logname[PATH_MAX + 32];
1483 * the def_thread is just for options, it's not a real job
1485 if (td == &def_thread)
1491 * if we are just dumping the output command line, don't add the job
1493 if (parse_dryrun()) {
1498 td->client_type = client_type;
1500 if (profile_td_init(td))
1503 if (ioengine_load(td))
1507 if (!o->filename && !td->files_index && !o->read_iolog_file) {
1510 if (o->nr_files == 1 && exists_and_not_regfile(jobname))
1511 add_file(td, jobname, job_add_num, 0);
1513 for (i = 0; i < o->nr_files; i++)
1514 add_file(td, make_filename(fname, sizeof(fname), o, jobname, job_add_num, i), job_add_num, 0);
1518 if (setup_random_seeds(td)) {
1519 td_verror(td, errno, "setup_random_seeds");
1523 if (fixup_options(td))
1526 if (!td->o.dedupe_global && init_dedupe_working_set_seeds(td, 0))
1530 * Belongs to fixup_options, but o->name is not necessarily set as yet
1532 if (!wait_for_ok(jobname, o))
1538 * IO engines only need this for option callbacks, and the address may
1539 * change in subprocesses.
1542 *(struct thread_data **)td->eo = NULL;
1544 if (td_ioengine_flagged(td, FIO_DISKLESSIO)) {
1547 for_each_file(td, f, i)
1548 f->real_file_size = -1ULL;
1551 td->sem = fio_sem_init(FIO_SEM_LOCKED);
1553 td->ts.clat_percentiles = o->clat_percentiles;
1554 td->ts.lat_percentiles = o->lat_percentiles;
1555 td->ts.slat_percentiles = o->slat_percentiles;
1556 td->ts.percentile_precision = o->percentile_precision;
1557 memcpy(td->ts.percentile_list, o->percentile_list, sizeof(o->percentile_list));
1558 td->ts.sig_figs = o->sig_figs;
1560 init_thread_stat_min_vals(&td->ts);
1563 * td->>ddir_seq_nr needs to be initialized to 1, NOT o->ddir_seq_nr,
1564 * so that get_next_offset gets a new random offset the first time it
1565 * is called, instead of keeping an initial offset of 0 for the first
1568 td->ddir_seq_nr = 1;
1570 if ((o->stonewall || o->new_group) && prev_group_jobs) {
1571 prev_group_jobs = 0;
1573 if (groupid == INT_MAX) {
1574 log_err("fio: too many groups defined\n");
1579 td->groupid = groupid;
1582 if (td->o.group_reporting && prev_group_jobs > 1 &&
1583 verify_per_group_options(td, jobname))
1589 if (o->write_lat_log) {
1590 struct log_params p = {
1592 .avg_msec = o->log_avg_msec,
1593 .hist_msec = o->log_hist_msec,
1594 .hist_coarseness = o->log_hist_coarseness,
1595 .log_type = IO_LOG_TYPE_LAT,
1596 .log_offset = o->log_offset,
1597 .log_prio = o->log_prio,
1598 .log_gz = o->log_gz,
1599 .log_gz_store = o->log_gz_store,
1601 const char *pre = make_log_name(o->lat_log_file, o->name);
1609 if (!o->disable_lat) {
1610 gen_log_name(logname, sizeof(logname), "lat", pre,
1611 td->thread_number, suf, o->per_job_logs);
1612 setup_log(&td->lat_log, &p, logname);
1615 if (!o->disable_slat) {
1616 gen_log_name(logname, sizeof(logname), "slat", pre,
1617 td->thread_number, suf, o->per_job_logs);
1618 setup_log(&td->slat_log, &p, logname);
1621 if (!o->disable_clat) {
1622 gen_log_name(logname, sizeof(logname), "clat", pre,
1623 td->thread_number, suf, o->per_job_logs);
1624 setup_log(&td->clat_log, &p, logname);
1629 if (o->write_hist_log) {
1630 struct log_params p = {
1632 .avg_msec = o->log_avg_msec,
1633 .hist_msec = o->log_hist_msec,
1634 .hist_coarseness = o->log_hist_coarseness,
1635 .log_type = IO_LOG_TYPE_HIST,
1636 .log_offset = o->log_offset,
1637 .log_prio = o->log_prio,
1638 .log_gz = o->log_gz,
1639 .log_gz_store = o->log_gz_store,
1641 const char *pre = make_log_name(o->hist_log_file, o->name);
1645 if (td->client_type) {
1646 log_err("fio: --write_hist_log requires zlib in client/server mode\n");
1656 gen_log_name(logname, sizeof(logname), "clat_hist", pre,
1657 td->thread_number, suf, o->per_job_logs);
1658 setup_log(&td->clat_hist_log, &p, logname);
1661 if (o->write_bw_log) {
1662 struct log_params p = {
1664 .avg_msec = o->log_avg_msec,
1665 .hist_msec = o->log_hist_msec,
1666 .hist_coarseness = o->log_hist_coarseness,
1667 .log_type = IO_LOG_TYPE_BW,
1668 .log_offset = o->log_offset,
1669 .log_prio = o->log_prio,
1670 .log_gz = o->log_gz,
1671 .log_gz_store = o->log_gz_store,
1673 const char *pre = make_log_name(o->bw_log_file, o->name);
1676 if (fio_option_is_set(o, bw_avg_time))
1677 p.avg_msec = min(o->log_avg_msec, o->bw_avg_time);
1679 o->bw_avg_time = p.avg_msec;
1681 p.hist_msec = o->log_hist_msec;
1682 p.hist_coarseness = o->log_hist_coarseness;
1689 gen_log_name(logname, sizeof(logname), "bw", pre,
1690 td->thread_number, suf, o->per_job_logs);
1691 setup_log(&td->bw_log, &p, logname);
1693 if (o->write_iops_log) {
1694 struct log_params p = {
1696 .avg_msec = o->log_avg_msec,
1697 .hist_msec = o->log_hist_msec,
1698 .hist_coarseness = o->log_hist_coarseness,
1699 .log_type = IO_LOG_TYPE_IOPS,
1700 .log_offset = o->log_offset,
1701 .log_prio = o->log_prio,
1702 .log_gz = o->log_gz,
1703 .log_gz_store = o->log_gz_store,
1705 const char *pre = make_log_name(o->iops_log_file, o->name);
1708 if (fio_option_is_set(o, iops_avg_time))
1709 p.avg_msec = min(o->log_avg_msec, o->iops_avg_time);
1711 o->iops_avg_time = p.avg_msec;
1713 p.hist_msec = o->log_hist_msec;
1714 p.hist_coarseness = o->log_hist_coarseness;
1721 gen_log_name(logname, sizeof(logname), "iops", pre,
1722 td->thread_number, suf, o->per_job_logs);
1723 setup_log(&td->iops_log, &p, logname);
1727 o->name = strdup(jobname);
1729 if (output_format & FIO_OUTPUT_NORMAL) {
1731 if (is_backend && !recursed)
1732 fio_server_send_add_job(td);
1734 if (!td_ioengine_flagged(td, FIO_NOIO)) {
1735 char *c1, *c2, *c3, *c4;
1736 char *c5 = NULL, *c6 = NULL;
1737 int i2p = is_power_of_2(o->kb_base);
1738 struct buf_output out;
1740 c1 = num2str(o->min_bs[DDIR_READ], o->sig_figs, 1, i2p, N2S_BYTE);
1741 c2 = num2str(o->max_bs[DDIR_READ], o->sig_figs, 1, i2p, N2S_BYTE);
1742 c3 = num2str(o->min_bs[DDIR_WRITE], o->sig_figs, 1, i2p, N2S_BYTE);
1743 c4 = num2str(o->max_bs[DDIR_WRITE], o->sig_figs, 1, i2p, N2S_BYTE);
1745 if (!o->bs_is_seq_rand) {
1746 c5 = num2str(o->min_bs[DDIR_TRIM], o->sig_figs, 1, i2p, N2S_BYTE);
1747 c6 = num2str(o->max_bs[DDIR_TRIM], o->sig_figs, 1, i2p, N2S_BYTE);
1750 buf_output_init(&out);
1751 __log_buf(&out, "%s: (g=%d): rw=%s, ", td->o.name,
1753 ddir_str(o->td_ddir));
1755 if (o->bs_is_seq_rand)
1756 __log_buf(&out, "bs=(R) %s-%s, (W) %s-%s, bs_is_seq_rand, ",
1759 __log_buf(&out, "bs=(R) %s-%s, (W) %s-%s, (T) %s-%s, ",
1760 c1, c2, c3, c4, c5, c6);
1762 __log_buf(&out, "ioengine=%s, iodepth=%u\n",
1763 td->io_ops->name, o->iodepth);
1764 log_info_buf(out.buf, out.buflen);
1765 buf_output_free(&out);
1774 } else if (job_add_num == 1)
1778 if (td_steadystate_init(td))
1781 if (o->merge_blktrace_file && !merge_blktrace_iologs(td))
1784 if (merge_blktrace_only) {
1790 * recurse add identical jobs, clear numjobs and stonewall options
1791 * as they don't apply to sub-jobs
1793 numjobs = o->numjobs;
1795 struct thread_data *td_new = get_new_job(false, td, true, jobname);
1800 td_new->o.numjobs = 1;
1801 td_new->o.stonewall = 0;
1802 td_new->o.new_group = 0;
1803 td_new->subjob_number = numjobs;
1804 td_new->o.ss_dur = o->ss_dur * 1000000l;
1805 td_new->o.ss_limit = o->ss_limit;
1808 if (td_new->files) {
1810 for_each_file(td_new, f, i)
1812 free(td_new->files);
1813 td_new->files = NULL;
1815 td_new->files_index = 0;
1816 td_new->files_size = 0;
1817 if (td_new->o.filename) {
1818 free(td_new->o.filename);
1819 td_new->o.filename = NULL;
1823 if (add_job(td_new, jobname, numjobs, 1, client_type))
1834 * Parse as if 'o' was a command line
1836 void add_job_opts(const char **o, int client_type)
1838 struct thread_data *td, *td_parent;
1839 int i, in_global = 1;
1843 td_parent = td = NULL;
1845 if (!strncmp(o[i], "name", 4)) {
1848 add_job(td, jobname, 0, 0, client_type);
1850 sprintf(jobname, "%s", o[i] + 5);
1852 if (in_global && !td_parent)
1853 td_parent = get_new_job(true, &def_thread, false, jobname);
1854 else if (!in_global && !td) {
1856 td_parent = &def_thread;
1857 td = get_new_job(false, td_parent, false, jobname);
1860 fio_options_parse(td_parent, (char **) &o[i], 1);
1862 fio_options_parse(td, (char **) &o[i], 1);
1867 add_job(td, jobname, 0, 0, client_type);
1870 static int skip_this_section(const char *name)
1874 if (!nr_job_sections)
1876 if (!strncmp(name, "global", 6))
1879 for (i = 0; i < nr_job_sections; i++)
1880 if (!strcmp(job_sections[i], name))
1886 static int is_empty_or_comment(char *line)
1890 for (i = 0; i < strlen(line); i++) {
1895 if (!isspace((int) line[i]) && !iscntrl((int) line[i]))
1903 * This is our [ini] type file parser.
1905 static int __parse_jobs_ini(struct thread_data *td,
1906 char *file, int is_buf, int stonewall_flag, int type,
1907 int nested, char *name, char ***popts, int *aopts, int *nopts)
1909 bool global = false;
1910 bool stdin_occupied = false;
1914 int ret = 0, stonewall;
1917 int inside_skip = 0;
1919 int i, alloc_opts, num_opts;
1921 dprint(FD_PARSE, "Parsing ini file %s\n", file);
1922 assert(td || !nested);
1927 if (!strcmp(file, "-")) {
1929 stdin_occupied = true;
1931 f = fopen(file, "r");
1936 log_err("fio: unable to open '%s' job file\n", file);
1938 td_verror(td, __err, "job file open");
1943 string = malloc(OPT_LEN_MAX);
1946 * it's really 256 + small bit, 280 should suffice
1950 memset(name, 0, 280);
1954 if (nested && popts) {
1956 alloc_opts = *aopts;
1962 opts = malloc(sizeof(char *) * alloc_opts);
1966 stonewall = stonewall_flag;
1969 * if skip_fgets is set, we already have loaded a line we
1974 p = strsep(&file, "\n");
1976 p = fgets(string, OPT_LEN_MAX, f);
1982 strip_blank_front(&p);
1985 dprint(FD_PARSE, "%s\n", p);
1986 if (is_empty_or_comment(p))
1990 if (sscanf(p, "[%255[^\n]]", name) != 1) {
1994 log_err("fio: option <%s> outside of "
1995 "[] job section\n", p);
2000 name[strlen(name) - 1] = '\0';
2002 if (skip_this_section(name)) {
2008 dprint(FD_PARSE, "Parsing section [%s]\n", name);
2010 global = !strncmp(name, "global", 6);
2016 log_info("--name=%s ", name);
2020 td = get_new_job(global, &def_thread, false, name);
2027 * Separate multiple job files by a stonewall
2029 if (!global && stonewall) {
2030 td->o.stonewall = stonewall;
2035 memset(opts, 0, alloc_opts * sizeof(char *));
2043 p = strsep(&file, "\n");
2045 p = fgets(string, OPT_LEN_MAX, f);
2048 dprint(FD_PARSE, "%s", p);
2053 if (is_empty_or_comment(p))
2056 strip_blank_front(&p);
2059 * new section, break out and make sure we don't
2060 * fgets() a new line at the top.
2064 log_err("No new sections in included files\n");
2075 if (!strncmp(p, "include", strlen("include"))) {
2076 char *filename = p + strlen("include") + 1,
2077 *ts, *full_fn = NULL;
2080 * Allow for the include filename
2081 * specification to be relative.
2083 if (access(filename, F_OK) &&
2084 (ts = strrchr(file, '/'))) {
2085 if (asprintf(&full_fn, "%.*s%s",
2086 (int)(ts - file + 1), file,
2094 ret = __parse_jobs_ini(td, filename, is_buf,
2095 stonewall_flag, type, 1,
2097 &alloc_opts, &num_opts);
2100 log_err("Error %d while parsing "
2101 "include file %s\n",
2114 if (num_opts == alloc_opts) {
2116 opts = realloc(opts,
2117 alloc_opts * sizeof(char *));
2120 opts[num_opts] = strdup(p);
2126 *aopts = alloc_opts;
2131 ret = fio_options_parse(td, opts, num_opts);
2133 if (!ret && td->o.read_iolog_file != NULL) {
2134 char *fname = get_name_by_idx(td->o.read_iolog_file,
2136 if (!strcmp(fname, "-")) {
2137 if (stdin_occupied) {
2138 log_err("fio: only one user (read_iolog_file/job "
2139 "file) of stdin is permitted at once but "
2140 "more than one was found.\n");
2143 stdin_occupied = true;
2150 ret = add_job(td, name, 0, 0, type);
2152 log_err("fio: job %s dropped\n", name);
2156 for (i = 0; i < num_opts; i++)
2165 while (i < nr_job_sections) {
2166 free(job_sections[i]);
2171 job_sections = NULL;
2172 nr_job_sections = 0;
2179 if (!is_buf && f != stdin)
2184 int parse_jobs_ini(char *file, int is_buf, int stonewall_flag, int type)
2186 return __parse_jobs_ini(NULL, file, is_buf, stonewall_flag, type,
2187 0, NULL, NULL, NULL, NULL);
2190 static int fill_def_thread(void)
2192 memset(&def_thread, 0, sizeof(def_thread));
2193 INIT_FLIST_HEAD(&def_thread.opt_list);
2195 fio_getaffinity(getpid(), &def_thread.o.cpumask);
2196 def_thread.o.error_dump = 1;
2199 * fill default options
2201 fio_fill_default_options(&def_thread);
2205 static void show_debug_categories(void)
2207 #ifdef FIO_INC_DEBUG
2208 const struct debug_level *dl = &debug_levels[0];
2209 int curlen, first = 1;
2213 int has_next = (dl + 1)->name != NULL;
2215 if (first || curlen + strlen(dl->name) >= 80) {
2220 curlen += printf("\t\t\t%s", dl->name);
2221 curlen += 3 * (8 - 1);
2223 curlen += printf(",");
2225 curlen += printf("%s", dl->name);
2227 curlen += printf(",");
2237 * Following options aren't printed by usage().
2238 * --append-terse - Equivalent to --output-format=terse, see f6a7df53.
2239 * --latency-log - Deprecated option.
2241 static void usage(const char *name)
2243 printf("%s\n", fio_version_string);
2244 printf("%s [options] [job options] <job file(s)>\n", name);
2245 printf(" --debug=options\tEnable debug logging. May be one/more of:\n");
2246 show_debug_categories();
2247 printf(" --parse-only\t\tParse options only, don't start any IO\n");
2248 printf(" --merge-blktrace-only\tMerge blktraces only, don't start any IO\n");
2249 printf(" --output\t\tWrite output to file\n");
2250 printf(" --bandwidth-log\tGenerate aggregate bandwidth logs\n");
2251 printf(" --minimal\t\tMinimal (terse) output\n");
2252 printf(" --output-format=type\tOutput format (terse,json,json+,normal)\n");
2253 printf(" --terse-version=type\tSet terse version output format"
2254 " (default 3, or 2 or 4 or 5)\n");
2255 printf(" --version\t\tPrint version info and exit\n");
2256 printf(" --help\t\tPrint this page\n");
2257 printf(" --cpuclock-test\tPerform test/validation of CPU clock\n");
2258 printf(" --crctest=[type]\tTest speed of checksum functions\n");
2259 printf(" --cmdhelp=cmd\t\tPrint command help, \"all\" for all of"
2261 printf(" --enghelp=engine\tPrint ioengine help, or list"
2262 " available ioengines\n");
2263 printf(" --enghelp=engine,cmd\tPrint help for an ioengine"
2265 printf(" --showcmd\t\tTurn a job file into command line options\n");
2266 printf(" --eta=when\t\tWhen ETA estimate should be printed\n");
2267 printf(" \t\tMay be \"always\", \"never\" or \"auto\"\n");
2268 printf(" --eta-newline=t\tForce a new line for every 't'");
2269 printf(" period passed\n");
2270 printf(" --status-interval=t\tForce full status dump every");
2271 printf(" 't' period passed\n");
2272 printf(" --readonly\t\tTurn on safety read-only checks, preventing"
2274 printf(" --section=name\tOnly run specified section in job file,"
2275 " multiple sections can be specified\n");
2276 printf(" --alloc-size=kb\tSet smalloc pool to this size in kb"
2278 printf(" --warnings-fatal\tFio parser warnings are fatal\n");
2279 printf(" --max-jobs=nr\t\tMaximum number of threads/processes to support\n");
2280 printf(" --server=args\t\tStart a backend fio server\n");
2281 printf(" --daemonize=pidfile\tBackground fio server, write pid to file\n");
2282 printf(" --client=hostname\tTalk to remote backend(s) fio server at hostname\n");
2283 printf(" --remote-config=file\tTell fio server to load this local job file\n");
2284 printf(" --idle-prof=option\tReport cpu idleness on a system or percpu basis\n"
2285 "\t\t\t(option=system,percpu) or run unit work\n"
2286 "\t\t\tcalibration only (option=calibrate)\n");
2288 printf(" --inflate-log=log\tInflate and output compressed log\n");
2290 printf(" --trigger-file=file\tExecute trigger cmd when file exists\n");
2291 printf(" --trigger-timeout=t\tExecute trigger at this time\n");
2292 printf(" --trigger=cmd\t\tSet this command as local trigger\n");
2293 printf(" --trigger-remote=cmd\tSet this command as remote trigger\n");
2294 printf(" --aux-path=path\tUse this path for fio state generated files\n");
2295 printf("\nFio was written by Jens Axboe <axboe@kernel.dk>\n");
2298 #ifdef FIO_INC_DEBUG
2299 const struct debug_level debug_levels[] = {
2300 { .name = "process",
2301 .help = "Process creation/exit logging",
2302 .shift = FD_PROCESS,
2305 .help = "File related action logging",
2309 .help = "IO and IO engine action logging (offsets, queue, completions, etc)",
2313 .help = "Memory allocation/freeing logging",
2316 { .name = "blktrace",
2317 .help = "blktrace action logging",
2318 .shift = FD_BLKTRACE,
2321 .help = "IO verification action logging",
2325 .help = "Random generation logging",
2329 .help = "Parser logging",
2332 { .name = "diskutil",
2333 .help = "Disk utility logging actions",
2334 .shift = FD_DISKUTIL,
2337 .help = "Logging related to creating/destroying jobs",
2341 .help = "Mutex logging",
2344 { .name = "profile",
2345 .help = "Logging related to profiles",
2346 .shift = FD_PROFILE,
2349 .help = "Logging related to time keeping functions",
2353 .help = "Network logging",
2357 .help = "Rate logging",
2360 { .name = "compress",
2361 .help = "Log compression logging",
2362 .shift = FD_COMPRESS,
2364 { .name = "steadystate",
2365 .help = "Steady state detection logging",
2366 .shift = FD_STEADYSTATE,
2368 { .name = "helperthread",
2369 .help = "Helper thread logging",
2370 .shift = FD_HELPERTHREAD,
2373 .help = "Zoned Block Device logging",
2379 static int set_debug(const char *string)
2381 const struct debug_level *dl;
2382 char *p = (char *) string;
2389 if (!strcmp(string, "?") || !strcmp(string, "help")) {
2390 log_info("fio: dumping debug options:");
2391 for (i = 0; debug_levels[i].name; i++) {
2392 dl = &debug_levels[i];
2393 log_info("%s,", dl->name);
2399 while ((opt = strsep(&p, ",")) != NULL) {
2402 if (!strncmp(opt, "all", 3)) {
2403 log_info("fio: set all debug options\n");
2408 for (i = 0; debug_levels[i].name; i++) {
2409 dl = &debug_levels[i];
2410 found = !strncmp(opt, dl->name, strlen(dl->name));
2414 if (dl->shift == FD_JOB) {
2415 opt = strchr(opt, ':');
2417 log_err("fio: missing job number\n");
2421 fio_debug_jobno = atoi(opt);
2422 log_info("fio: set debug jobno %d\n",
2425 log_info("fio: set debug option %s\n", opt);
2426 fio_debug |= (1UL << dl->shift);
2432 log_err("fio: debug mask %s not found\n", opt);
2437 static int set_debug(const char *string)
2439 log_err("fio: debug tracing not included in build\n");
2444 static void fio_options_fill_optstring(void)
2446 char *ostr = cmd_optstr;
2450 while (l_opts[i].name) {
2451 ostr[c++] = l_opts[i].val;
2452 if (l_opts[i].has_arg == required_argument)
2454 else if (l_opts[i].has_arg == optional_argument) {
2463 static int client_flag_set(char c)
2468 while (l_opts[i].name) {
2469 int val = l_opts[i].val;
2471 if (c == (val & 0xff))
2472 return (val & FIO_CLIENT_FLAG);
2480 static void parse_cmd_client(void *client, char *opt)
2482 fio_client_add_cmd_option(client, opt);
2485 static void show_closest_option(const char *name)
2487 int best_option, best_distance;
2490 while (*name == '-')
2494 best_distance = INT_MAX;
2496 while (l_opts[i].name) {
2497 distance = string_distance(name, l_opts[i].name);
2498 if (distance < best_distance) {
2499 best_distance = distance;
2505 if (best_option != -1 && string_distance_ok(name, best_distance))
2506 log_err("Did you mean %s?\n", l_opts[best_option].name);
2509 static int parse_output_format(const char *optarg)
2511 char *p, *orig, *opt;
2514 p = orig = strdup(optarg);
2518 while ((opt = strsep(&p, ",")) != NULL) {
2519 if (!strcmp(opt, "minimal") ||
2520 !strcmp(opt, "terse") ||
2521 !strcmp(opt, "csv"))
2522 output_format |= FIO_OUTPUT_TERSE;
2523 else if (!strcmp(opt, "json"))
2524 output_format |= FIO_OUTPUT_JSON;
2525 else if (!strcmp(opt, "json+"))
2526 output_format |= (FIO_OUTPUT_JSON | FIO_OUTPUT_JSON_PLUS);
2527 else if (!strcmp(opt, "normal"))
2528 output_format |= FIO_OUTPUT_NORMAL;
2530 log_err("fio: invalid output format %s\n", opt);
2540 int parse_cmd_line(int argc, char *argv[], int client_type)
2542 struct thread_data *td = NULL;
2543 int c, ini_idx = 0, lidx, ret = 0, do_exit = 0, exit_val = 0;
2544 char *ostr = cmd_optstr;
2545 char *pid_file = NULL;
2546 void *cur_client = NULL;
2547 bool backend = false;
2550 * Reset optind handling, since we may call this multiple times
2555 while ((c = getopt_long_only(argc, argv, ostr, l_opts, &lidx)) != -1) {
2556 if ((c & FIO_CLIENT_FLAG) || client_flag_set(c)) {
2557 parse_cmd_client(cur_client, argv[optind - 1]);
2558 c &= ~FIO_CLIENT_FLAG;
2563 smalloc_pool_size = atoi(optarg);
2564 smalloc_pool_size <<= 10;
2568 log_err("fio: --latency-log is deprecated. Use per-job latency log options.\n");
2573 write_bw_log = true;
2578 if (f_out && f_out != stdout)
2581 tmp = fopen(optarg, "w+");
2583 log_err("fio: output file open error: %s\n", strerror(errno));
2588 f_err = f_out = tmp;
2592 output_format = FIO_OUTPUT_TERSE;
2595 if (parse_output_format(optarg)) {
2596 log_err("fio: failed parsing output-format\n");
2603 output_format |= FIO_OUTPUT_TERSE;
2615 fio_show_option_help(optarg);
2622 exit_val = fio_show_ioengine_help(optarg);
2628 dump_cmdline = true;
2636 log_info("%s\n", fio_version_string);
2641 terse_version = atoi(optarg);
2642 if (!(terse_version >= 2 && terse_version <= 5)) {
2643 log_err("fio: bad terse version format\n");
2649 if (!strcmp("always", optarg))
2650 eta_print = FIO_ETA_ALWAYS;
2651 else if (!strcmp("never", optarg))
2652 eta_print = FIO_ETA_NEVER;
2657 if (check_str_time(optarg, &t, 1)) {
2658 log_err("fio: failed parsing eta time %s\n", optarg);
2663 eta_new_line = t / 1000;
2664 if (!eta_new_line) {
2665 log_err("fio: eta new line time too short\n");
2674 if (check_str_time(optarg, &t, 1)) {
2675 log_err("fio: failed parsing eta interval %s\n", optarg);
2680 eta_interval_msec = t / 1000;
2681 if (eta_interval_msec < DISK_UTIL_MSEC) {
2682 log_err("fio: eta interval time too short (%umsec min)\n", DISK_UTIL_MSEC);
2689 if (set_debug(optarg))
2699 if (!strcmp(optarg, "global")) {
2700 log_err("fio: can't use global as only "
2706 new_size = (nr_job_sections + 1) * sizeof(char *);
2707 job_sections = realloc(job_sections, new_size);
2708 job_sections[nr_job_sections] = strdup(optarg);
2714 exit_val = iolog_file_inflate(optarg);
2723 exec_profile = strdup(optarg);
2725 case FIO_GETOPT_JOB: {
2726 const char *opt = l_opts[lidx].name;
2729 if (!strncmp(opt, "name", 4) && td) {
2730 ret = add_job(td, td->o.name ?: "fio", 0, 0, client_type);
2737 int is_section = !strncmp(opt, "name", 4);
2740 if (!is_section || !strncmp(val, "global", 6))
2743 if (is_section && skip_this_section(val))
2746 td = get_new_job(global, &def_thread, true, NULL);
2747 if (!td || ioengine_load(td)) {
2756 fio_options_set_ioengine_opts(l_opts, td);
2759 if ((!val || !strlen(val)) &&
2760 l_opts[lidx].has_arg == required_argument) {
2761 log_err("fio: option %s requires an argument\n", opt);
2764 ret = fio_cmd_option_parse(td, opt, val);
2775 if (!ret && !strcmp(opt, "ioengine")) {
2776 if (ioengine_load(td)) {
2783 fio_options_set_ioengine_opts(l_opts, td);
2787 case FIO_GETOPT_IOENGINE: {
2788 const char *opt = l_opts[lidx].name;
2794 ret = fio_cmd_ioengine_option_parse(td, opt, val);
2810 /* we don't track/need this anymore, ignore it */
2814 #ifndef CONFIG_NO_SHM
2816 log_err("fio: can't be both client and server\n");
2822 fio_server_set_arg(optarg);
2826 log_err("fio: client/server requires SHM support\n");
2834 fio_server_internal_set(optarg);
2840 pid_file = strdup(optarg);
2843 if ((ret = fio_idle_prof_parse_opt(optarg))) {
2844 /* exit on error and calibration only */
2854 log_err("fio: can't be both client and server\n");
2859 /* if --client parameter contains a pathname */
2860 if (0 == access(optarg, R_OK)) {
2861 /* file contains a list of host addrs or names */
2862 char hostaddr[PATH_MAX] = {0};
2864 FILE * hostf = fopen(optarg, "r");
2866 log_err("fio: could not open client list file %s for read\n", optarg);
2871 sprintf(formatstr, "%%%ds", PATH_MAX - 1);
2873 * read at most PATH_MAX-1 chars from each
2874 * record in this file
2876 while (fscanf(hostf, formatstr, hostaddr) == 1) {
2877 /* expect EVERY host in file to be valid */
2878 if (fio_client_add(&fio_client_ops, hostaddr, &cur_client)) {
2879 log_err("fio: failed adding client %s from file %s\n", hostaddr, optarg);
2886 break; /* no possibility of job file for "this client only" */
2888 if (fio_client_add(&fio_client_ops, optarg, &cur_client)) {
2889 log_err("fio: failed adding client %s\n", optarg);
2895 * If the next argument exists and isn't an option,
2896 * assume it's a job file for this client only.
2898 while (optind < argc) {
2899 if (!strncmp(argv[optind], "--", 2) ||
2900 !strncmp(argv[optind], "-", 1))
2903 if (fio_client_add_ini_file(cur_client, argv[optind], false))
2910 if (fio_client_add_ini_file(cur_client, optarg, true)) {
2918 exit_val = fio_monotonic_clocktest(1);
2923 exit_val = fio_crctest(optarg);
2928 exit_val = fio_memcpy_test(optarg);
2933 if (check_str_time(optarg, &val, 1)) {
2934 log_err("fio: failed parsing time %s\n", optarg);
2940 log_err("fio: status interval too small\n");
2944 status_interval = val / 1000;
2950 trigger_file = strdup(optarg);
2955 trigger_cmd = strdup(optarg);
2958 if (trigger_remote_cmd)
2959 free(trigger_remote_cmd);
2960 trigger_remote_cmd = strdup(optarg);
2965 aux_path = strdup(optarg);
2968 if (check_str_time(optarg, &trigger_timeout, 1)) {
2969 log_err("fio: failed parsing time %s\n", optarg);
2973 trigger_timeout /= 1000000;
2978 merge_blktrace_only = true;
2981 log_err("%s: unrecognized option '%s'\n", argv[0],
2983 show_closest_option(argv[optind - 1]);
2994 if (do_exit && !(is_backend || nr_clients))
2997 if (nr_clients && fio_clients_connect())
3000 if (is_backend && backend)
3001 return fio_start_server(pid_file);
3007 ret = add_job(td, td->o.name ?: "fio", 0, 0, client_type);
3013 while (!ret && optind < argc) {
3015 ini_file = realloc(ini_file, ini_idx * sizeof(char *));
3016 ini_file[ini_idx - 1] = strdup(argv[optind]);
3024 int fio_init_options(void)
3029 fio_options_fill_optstring();
3030 fio_options_dup_and_init(l_opts);
3034 if (fill_def_thread())
3040 extern int fio_check_options(struct thread_options *);
3042 int parse_options(int argc, char *argv[])
3044 const int type = FIO_CLIENT_TYPE_CLI;
3047 if (fio_init_options())
3049 if (fio_test_cconv(&def_thread.o))
3050 log_err("fio: failed internal cconv test\n");
3052 job_files = parse_cmd_line(argc, argv, type);
3054 if (job_files > 0) {
3055 for (i = 0; i < job_files; i++) {
3056 if (i && fill_def_thread())
3059 if (fio_clients_send_ini(ini_file[i]))
3062 } else if (!is_backend) {
3063 if (parse_jobs_ini(ini_file[i], 0, i, type))
3068 } else if (nr_clients) {
3069 if (fill_def_thread())
3071 if (fio_clients_send_ini(NULL))
3076 fio_options_free(&def_thread);
3077 filesetup_mem_free();
3079 if (!thread_number) {
3084 if (is_backend || nr_clients)
3089 log_err("No job(s) defined\n\n");
3094 if (output_format & FIO_OUTPUT_NORMAL)
3095 log_info("%s\n", fio_version_string);
3100 void options_default_fill(struct thread_options *o)
3102 memcpy(o, &def_thread.o, sizeof(*o));
3105 struct thread_data *get_global_options(void)