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,
227 { .name = (char *) "daemonize",
228 .has_arg = required_argument,
232 .name = (char *) "client",
233 .has_arg = required_argument,
237 .name = (char *) "remote-config",
238 .has_arg = required_argument,
242 .name = (char *) "cpuclock-test",
243 .has_arg = no_argument,
247 .name = (char *) "crctest",
248 .has_arg = optional_argument,
252 .name = (char *) "memcpytest",
253 .has_arg = optional_argument,
257 .name = (char *) "idle-prof",
258 .has_arg = required_argument,
262 .name = (char *) "status-interval",
263 .has_arg = required_argument,
264 .val = 'L' | FIO_CLIENT_FLAG,
267 .name = (char *) "trigger-file",
268 .has_arg = required_argument,
272 .name = (char *) "trigger-timeout",
273 .has_arg = required_argument,
277 .name = (char *) "trigger",
278 .has_arg = required_argument,
282 .name = (char *) "trigger-remote",
283 .has_arg = required_argument,
287 .name = (char *) "aux-path",
288 .has_arg = required_argument,
292 .name = (char *) "merge-blktrace-only",
293 .has_arg = no_argument,
294 .val = 'A' | FIO_CLIENT_FLAG,
301 void free_threads_shm(void)
305 for (i = 0; i < nr_segments; i++) {
306 struct thread_segment *seg = &segments[i];
309 void *tp = seg->threads;
310 #ifndef CONFIG_NO_SHM
311 struct shmid_ds sbuf;
315 shmctl(seg->shm_id, IPC_RMID, &sbuf);
328 static void free_shm(void)
330 #ifndef FUZZING_BUILD_MODE_UNSAFE_FOR_PRODUCTION
333 fio_debug_jobp = NULL;
340 free(trigger_remote_cmd);
341 trigger_file = trigger_cmd = trigger_remote_cmd = NULL;
343 options_free(fio_options, &def_thread.o);
350 static int add_thread_segment(void)
352 struct thread_segment *seg = &segments[nr_segments];
353 size_t size = JOBS_PER_SEG * sizeof(struct thread_data);
356 if (nr_segments + 1 >= REAL_MAX_SEG) {
357 log_err("error: maximum number of jobs reached.\n");
361 size += 2 * sizeof(unsigned int);
363 #ifndef CONFIG_NO_SHM
364 seg->shm_id = shmget(0, size, IPC_CREAT | 0600);
365 if (seg->shm_id == -1) {
366 if (errno != EINVAL && errno != ENOMEM && errno != ENOSPC)
371 seg->threads = malloc(size);
376 #ifndef CONFIG_NO_SHM
377 seg->threads = shmat(seg->shm_id, NULL, 0);
378 if (seg->threads == (void *) -1) {
382 if (shm_attach_to_open_removed())
383 shmctl(seg->shm_id, IPC_RMID, NULL);
388 memset(seg->threads, 0, JOBS_PER_SEG * sizeof(struct thread_data));
389 for (i = 0; i < JOBS_PER_SEG; i++)
390 DRD_IGNORE_VAR(seg->threads[i]);
393 /* Not first segment, we're done */
394 if (nr_segments != 1) {
399 fio_debug_jobp = (unsigned int *)(seg->threads + JOBS_PER_SEG);
400 *fio_debug_jobp = -1;
401 fio_warned = fio_debug_jobp + 1;
409 * The thread areas are shared between the main process and the job
410 * threads/processes, and is split into chunks of JOBS_PER_SEG. If the current
411 * segment has no more room, add a new chunk.
413 static int expand_thread_area(void)
415 struct thread_segment *seg = &segments[cur_segment];
417 if (nr_segments && seg->nr_threads < JOBS_PER_SEG)
420 return add_thread_segment();
423 static void dump_print_option(struct print_option *p)
427 if (!strcmp("description", p->name))
432 log_info("--%s%s", p->name, p->value ? "" : " ");
434 log_info("=%s%s%s ", delim, p->value, delim);
437 static void dump_opt_list(struct thread_data *td)
439 struct flist_head *entry;
440 struct print_option *p;
442 if (flist_empty(&td->opt_list))
445 flist_for_each(entry, &td->opt_list) {
446 p = flist_entry(entry, struct print_option, list);
447 dump_print_option(p);
451 static void copy_opt_list(struct thread_data *dst, struct thread_data *src)
453 struct flist_head *entry;
455 if (flist_empty(&src->opt_list))
458 flist_for_each(entry, &src->opt_list) {
459 struct print_option *srcp, *dstp;
461 srcp = flist_entry(entry, struct print_option, list);
462 dstp = malloc(sizeof(*dstp));
463 dstp->name = strdup(srcp->name);
465 dstp->value = strdup(srcp->value);
468 flist_add_tail(&dstp->list, &dst->opt_list);
473 * Return a free job structure.
475 static struct thread_data *get_new_job(bool global, struct thread_data *parent,
476 bool preserve_eo, const char *jobname)
478 struct thread_segment *seg;
479 struct thread_data *td;
483 if (expand_thread_area()) {
484 log_err("error: failed to setup shm segment\n");
488 seg = &segments[cur_segment];
489 td = &seg->threads[seg->nr_threads++];
493 INIT_FLIST_HEAD(&td->opt_list);
494 if (parent != &def_thread)
495 copy_opt_list(td, parent);
502 td->o.uid = td->o.gid = -1U;
504 dup_files(td, parent);
505 fio_options_mem_dupe(td);
507 profile_add_hooks(td);
509 td->thread_number = thread_number;
510 td->subjob_number = 0;
513 td->o.name = strdup(jobname);
515 if (!parent->o.group_reporting || parent == &def_thread)
521 static void put_job(struct thread_data *td)
523 if (td == &def_thread)
530 log_info("fio: %s\n", td->verror);
532 fio_options_free(td);
533 fio_dump_options_free(td);
540 memset(td, 0, sizeof(*td));
541 segments[cur_segment].nr_threads--;
545 static int __setup_rate(struct thread_data *td, enum fio_ddir ddir)
547 unsigned long long bs = td->o.min_bs[ddir];
549 assert(ddir_rw(ddir));
551 if (td->o.rate[ddir])
552 td->rate_bps[ddir] = td->o.rate[ddir];
554 td->rate_bps[ddir] = (uint64_t) td->o.rate_iops[ddir] * bs;
556 if (!td->rate_bps[ddir]) {
557 log_err("rate lower than supported\n");
561 td->rate_next_io_time[ddir] = 0;
562 td->rate_io_issue_bytes[ddir] = 0;
563 td->last_usec[ddir] = 0;
567 static int setup_rate(struct thread_data *td)
571 for_each_rw_ddir(ddir) {
572 if (td->o.rate[ddir] || td->o.rate_iops[ddir]) {
573 ret |= __setup_rate(td, ddir);
579 static int fixed_block_size(struct thread_options *o)
581 return o->min_bs[DDIR_READ] == o->max_bs[DDIR_READ] &&
582 o->min_bs[DDIR_WRITE] == o->max_bs[DDIR_WRITE] &&
583 o->min_bs[DDIR_TRIM] == o->max_bs[DDIR_TRIM] &&
584 o->min_bs[DDIR_READ] == o->min_bs[DDIR_WRITE] &&
585 o->min_bs[DDIR_READ] == o->min_bs[DDIR_TRIM];
591 static unsigned int gcd(unsigned int m, unsigned int n)
596 return gcd(n, m % n);
600 * Lazy way of fixing up options that depend on each other. We could also
601 * define option callback handlers, but this is easier.
603 static int fixup_options(struct thread_data *td)
605 struct thread_options *o = &td->o;
608 if (read_only && (td_write(td) || td_trim(td))) {
609 log_err("fio: trim and write operations are not allowed"
610 " with the --readonly parameter.\n");
614 #ifndef CONFIG_PSHARED
615 if (!o->use_thread) {
616 log_info("fio: this platform does not support process shared"
617 " mutexes, forcing use of threads. Use the 'thread'"
618 " option to get rid of this warning.\n");
620 ret |= warnings_fatal;
624 if (o->write_iolog_file && o->read_iolog_file) {
625 log_err("fio: read iolog overrides write_iolog\n");
626 free(o->write_iolog_file);
627 o->write_iolog_file = NULL;
628 ret |= warnings_fatal;
631 if (o->zone_mode == ZONE_MODE_NONE && o->zone_size) {
632 log_err("fio: --zonemode=none and --zonesize are not compatible.\n");
636 if (o->zone_mode == ZONE_MODE_ZBD && !o->create_serialize) {
637 log_err("fio: --zonemode=zbd and --create_serialize=0 are not compatible.\n");
641 if (o->zone_mode == ZONE_MODE_STRIDED && !o->zone_size) {
642 log_err("fio: --zonesize must be specified when using --zonemode=strided.\n");
646 if (o->zone_mode == ZONE_MODE_NOT_SPECIFIED) {
648 o->zone_mode = ZONE_MODE_STRIDED;
650 o->zone_mode = ZONE_MODE_NONE;
654 * Strided zone mode only really works with 1 file.
656 if (o->zone_mode == ZONE_MODE_STRIDED && o->open_files > 1)
657 o->zone_mode = ZONE_MODE_NONE;
660 * If zone_range isn't specified, backward compatibility dictates it
661 * should be made equal to zone_size.
663 if (o->zone_mode == ZONE_MODE_STRIDED && !o->zone_range)
664 o->zone_range = o->zone_size;
667 * Reads can do overwrites, we always need to pre-create the file
672 for_each_rw_ddir(ddir) {
673 if (!o->min_bs[ddir])
674 o->min_bs[ddir] = o->bs[ddir];
675 if (!o->max_bs[ddir])
676 o->max_bs[ddir] = o->bs[ddir];
680 for_each_rw_ddir(ddir) {
681 o->rw_min_bs = min(o->rw_min_bs, o->min_bs[ddir]);
685 * For random IO, allow blockalign offset other than min_bs.
687 for_each_rw_ddir(ddir) {
688 if (!o->ba[ddir] || !td_random(td))
689 o->ba[ddir] = o->min_bs[ddir];
692 if ((o->ba[DDIR_READ] != o->min_bs[DDIR_READ] ||
693 o->ba[DDIR_WRITE] != o->min_bs[DDIR_WRITE] ||
694 o->ba[DDIR_TRIM] != o->min_bs[DDIR_TRIM]) &&
696 log_err("fio: Any use of blockalign= turns off randommap\n");
698 ret |= warnings_fatal;
701 if (!o->file_size_high)
702 o->file_size_high = o->file_size_low;
704 if (o->start_delay_high) {
705 if (!o->start_delay_orig)
706 o->start_delay_orig = o->start_delay;
707 o->start_delay = rand_between(&td->delay_state,
709 o->start_delay_high);
712 if (o->norandommap && o->verify != VERIFY_NONE
713 && !fixed_block_size(o)) {
714 log_err("fio: norandommap given for variable block sizes, "
716 ret |= warnings_fatal;
718 if (o->bs_unaligned && (o->odirect || td_ioengine_flagged(td, FIO_RAWIO)))
719 log_err("fio: bs_unaligned may not work with raw io\n");
722 * thinktime_spin must be less than thinktime
724 if (o->thinktime_spin > o->thinktime)
725 o->thinktime_spin = o->thinktime;
728 * The low water mark cannot be bigger than the iodepth
730 if (o->iodepth_low > o->iodepth || !o->iodepth_low)
731 o->iodepth_low = o->iodepth;
734 * If batch number isn't set, default to the same as iodepth
736 if (o->iodepth_batch > o->iodepth || !o->iodepth_batch)
737 o->iodepth_batch = o->iodepth;
740 * If max batch complete number isn't set or set incorrectly,
741 * default to the same as iodepth_batch_complete_min
743 if (o->iodepth_batch_complete_min > o->iodepth_batch_complete_max)
744 o->iodepth_batch_complete_max = o->iodepth_batch_complete_min;
747 * There's no need to check for in-flight overlapping IOs if the job
748 * isn't changing data or the maximum iodepth is guaranteed to be 1
749 * when we are not in offload mode
751 if (o->serialize_overlap && !(td->flags & TD_F_READ_IOLOG) &&
752 (!(td_write(td) || td_trim(td)) || o->iodepth == 1) &&
753 o->io_submit_mode != IO_MODE_OFFLOAD)
754 o->serialize_overlap = 0;
756 if (o->nr_files > td->files_index)
757 o->nr_files = td->files_index;
759 if (o->open_files > o->nr_files || !o->open_files)
760 o->open_files = o->nr_files;
762 if (((o->rate[DDIR_READ] + o->rate[DDIR_WRITE] + o->rate[DDIR_TRIM]) &&
763 (o->rate_iops[DDIR_READ] + o->rate_iops[DDIR_WRITE] + o->rate_iops[DDIR_TRIM])) ||
764 ((o->ratemin[DDIR_READ] + o->ratemin[DDIR_WRITE] + o->ratemin[DDIR_TRIM]) &&
765 (o->rate_iops_min[DDIR_READ] + o->rate_iops_min[DDIR_WRITE] + o->rate_iops_min[DDIR_TRIM]))) {
766 log_err("fio: rate and rate_iops are mutually exclusive\n");
769 for_each_rw_ddir(ddir) {
770 if ((o->rate[ddir] && (o->rate[ddir] < o->ratemin[ddir])) ||
771 (o->rate_iops[ddir] && (o->rate_iops[ddir] < o->rate_iops_min[ddir]))) {
772 log_err("fio: minimum rate exceeds rate, ddir %d\n", +ddir);
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 CONFIG_FDATASYNC
856 if (o->fdatasync_blocks) {
857 log_info("fio: this platform does not support fdatasync()"
858 " falling back to using fsync(). Use the 'fsync'"
859 " option instead of 'fdatasync' to get rid of"
861 o->fsync_blocks = o->fdatasync_blocks;
862 o->fdatasync_blocks = 0;
863 ret |= warnings_fatal;
869 * Windows doesn't support O_DIRECT or O_SYNC with the _open interface,
870 * so fail if we're passed those flags
872 if (td_ioengine_flagged(td, FIO_SYNCIO) && (o->odirect || o->sync_io)) {
873 log_err("fio: Windows does not support direct or non-buffered io with"
874 " the synchronous ioengines. Use the 'windowsaio' ioengine"
875 " with 'direct=1' and 'iodepth=1' instead.\n");
881 * For fully compressible data, just zero them at init time.
882 * It's faster than repeatedly filling it. For non-zero
883 * compression, we should have refill_buffers set. Set it, unless
884 * the job file already changed it.
886 if (o->compress_percentage) {
887 if (o->compress_percentage == 100) {
889 o->compress_percentage = 0;
890 } else if (!fio_option_is_set(o, refill_buffers)) {
891 o->refill_buffers = 1;
892 td->flags |= TD_F_REFILL_BUFFERS;
897 * Using a non-uniform random distribution excludes usage of
900 if (o->random_distribution != FIO_RAND_DIST_RANDOM)
904 * If size is set but less than the min block size, complain
906 if (o->size && o->size < td_min_bs(td)) {
907 log_err("fio: size too small, must not be less than minimum block size: %llu < %llu\n",
908 (unsigned long long) o->size, td_min_bs(td));
913 * O_ATOMIC implies O_DIRECT
919 * If randseed is set, that overrides randrepeat
921 if (fio_option_is_set(o, rand_seed))
922 o->rand_repeatable = 0;
924 if (td_ioengine_flagged(td, FIO_NOEXTEND) && o->file_append) {
925 log_err("fio: can't append/extent with IO engine %s\n", td->io_ops->name);
929 if (fio_option_is_set(o, gtod_cpu)) {
931 fio_gtod_set_cpu(o->gtod_cpu);
932 fio_gtod_offload = 1;
935 td->loops = o->loops;
939 if (o->block_error_hist && o->nr_files != 1) {
940 log_err("fio: block error histogram only available "
941 "with a single file per job, but %d files "
942 "provided\n", o->nr_files);
947 o->lat_percentiles = 0;
949 o->clat_percentiles = 0;
951 o->slat_percentiles = 0;
954 * Fix these up to be nsec internally
956 for_each_rw_ddir(ddir)
957 o->max_latency[ddir] *= 1000ULL;
959 o->latency_target *= 1000ULL;
962 * Dedupe working set verifications
964 if (o->dedupe_percentage && o->dedupe_mode == DEDUPE_MODE_WORKING_SET) {
965 if (!fio_option_is_set(o, size)) {
966 log_err("fio: pregenerated dedupe working set "
967 "requires size to be set\n");
969 } else if (o->nr_files != 1) {
970 log_err("fio: dedupe working set mode supported with "
971 "single file per job, but %d files "
972 "provided\n", o->nr_files);
974 } else if (o->dedupe_working_set_percentage + o->dedupe_percentage > 100) {
975 log_err("fio: impossible to reach expected dedupe percentage %u "
976 "since %u percentage of size is reserved to dedupe working set "
977 "(those are unique pages)\n",
978 o->dedupe_percentage, o->dedupe_working_set_percentage);
986 static void init_rand_file_service(struct thread_data *td)
988 unsigned long nranges = td->o.nr_files << FIO_FSERVICE_SHIFT;
989 const unsigned int seed = td->rand_seeds[FIO_RAND_FILE_OFF];
991 if (td->o.file_service_type == FIO_FSERVICE_ZIPF) {
992 zipf_init(&td->next_file_zipf, nranges, td->zipf_theta, td->random_center, seed);
993 zipf_disable_hash(&td->next_file_zipf);
994 } else if (td->o.file_service_type == FIO_FSERVICE_PARETO) {
995 pareto_init(&td->next_file_zipf, nranges, td->pareto_h, td->random_center, seed);
996 zipf_disable_hash(&td->next_file_zipf);
997 } else if (td->o.file_service_type == FIO_FSERVICE_GAUSS) {
998 gauss_init(&td->next_file_gauss, nranges, td->gauss_dev, td->random_center, seed);
999 gauss_disable_hash(&td->next_file_gauss);
1003 void td_fill_verify_state_seed(struct thread_data *td)
1007 if (td->o.random_generator == FIO_RAND_GEN_TAUSWORTHE64)
1012 init_rand_seed(&td->verify_state, td->rand_seeds[FIO_RAND_VER_OFF],
1016 static void td_fill_rand_seeds_internal(struct thread_data *td, bool use64)
1018 uint64_t read_seed = td->rand_seeds[FIO_RAND_BS_OFF];
1019 uint64_t write_seed = td->rand_seeds[FIO_RAND_BS1_OFF];
1020 uint64_t trim_seed = td->rand_seeds[FIO_RAND_BS2_OFF];
1024 * trimwrite is special in that we need to generate the same
1025 * offsets to get the "write after trim" effect. If we are
1026 * using bssplit to set buffer length distributions, ensure that
1027 * we seed the trim and write generators identically. Ditto for
1028 * verify, read and writes must have the same seed, if we are doing
1031 if (td->o.verify != VERIFY_NONE)
1032 write_seed = read_seed;
1033 if (td_trimwrite(td))
1034 trim_seed = write_seed;
1035 init_rand_seed(&td->bsrange_state[DDIR_READ], read_seed, use64);
1036 init_rand_seed(&td->bsrange_state[DDIR_WRITE], write_seed, use64);
1037 init_rand_seed(&td->bsrange_state[DDIR_TRIM], trim_seed, use64);
1039 td_fill_verify_state_seed(td);
1040 init_rand_seed(&td->rwmix_state, td->rand_seeds[FIO_RAND_MIX_OFF], false);
1042 if (td->o.file_service_type == FIO_FSERVICE_RANDOM)
1043 init_rand_seed(&td->next_file_state, td->rand_seeds[FIO_RAND_FILE_OFF], use64);
1044 else if (td->o.file_service_type & __FIO_FSERVICE_NONUNIFORM)
1045 init_rand_file_service(td);
1047 init_rand_seed(&td->file_size_state, td->rand_seeds[FIO_RAND_FILE_SIZE_OFF], use64);
1048 init_rand_seed(&td->trim_state, td->rand_seeds[FIO_RAND_TRIM_OFF], use64);
1049 init_rand_seed(&td->delay_state, td->rand_seeds[FIO_RAND_START_DELAY], use64);
1050 init_rand_seed(&td->poisson_state[0], td->rand_seeds[FIO_RAND_POISSON_OFF], 0);
1051 init_rand_seed(&td->poisson_state[1], td->rand_seeds[FIO_RAND_POISSON2_OFF], 0);
1052 init_rand_seed(&td->poisson_state[2], td->rand_seeds[FIO_RAND_POISSON3_OFF], 0);
1053 init_rand_seed(&td->dedupe_state, td->rand_seeds[FIO_DEDUPE_OFF], false);
1054 init_rand_seed(&td->zone_state, td->rand_seeds[FIO_RAND_ZONE_OFF], false);
1055 init_rand_seed(&td->prio_state, td->rand_seeds[FIO_RAND_PRIO_CMDS], false);
1056 init_rand_seed(&td->dedupe_working_set_index_state, td->rand_seeds[FIO_RAND_DEDUPE_WORKING_SET_IX], use64);
1061 if (td->o.rand_repeatable)
1062 td->rand_seeds[FIO_RAND_BLOCK_OFF] = FIO_RANDSEED * td->thread_number;
1064 init_rand_seed(&td->random_state, td->rand_seeds[FIO_RAND_BLOCK_OFF], use64);
1066 for (i = 0; i < DDIR_RWDIR_CNT; i++) {
1067 struct frand_state *s = &td->seq_rand_state[i];
1069 init_rand_seed(s, td->rand_seeds[FIO_RAND_SEQ_RAND_READ_OFF], false);
1073 void td_fill_rand_seeds(struct thread_data *td)
1077 if (td->o.allrand_repeatable) {
1080 for (i = 0; i < FIO_RAND_NR_OFFS; i++)
1081 td->rand_seeds[i] = FIO_RANDSEED * td->thread_number
1085 if (td->o.random_generator == FIO_RAND_GEN_TAUSWORTHE64)
1090 td_fill_rand_seeds_internal(td, use64);
1092 init_rand_seed(&td->buf_state, td->rand_seeds[FIO_RAND_BUF_OFF], use64);
1093 frand_copy(&td->buf_state_prev, &td->buf_state);
1097 * Initializes the ioengine configured for a job, if it has not been done so
1100 int ioengine_load(struct thread_data *td)
1102 if (!td->o.ioengine) {
1103 log_err("fio: internal fault, no IO engine specified\n");
1108 struct ioengine_ops *ops;
1111 /* An engine is loaded, but the requested ioengine
1114 if (!strcmp(td->io_ops->name, td->o.ioengine)) {
1115 /* The right engine is already loaded */
1120 * Name of file and engine may be different, load ops
1121 * for this name and see if they match. If they do, then
1122 * the engine is unchanged.
1124 dlhandle = td->io_ops->dlhandle;
1125 ops = load_ioengine(td);
1129 if (ops == td->io_ops && dlhandle == td->io_ops->dlhandle)
1132 if (dlhandle && dlhandle != td->io_ops->dlhandle)
1135 /* Unload the old engine. */
1139 td->io_ops = load_ioengine(td);
1143 if (td->io_ops->option_struct_size && td->io_ops->options) {
1145 * In cases where td->eo is set, clone it for a child thread.
1146 * This requires that the parent thread has the same ioengine,
1147 * but that requirement must be enforced by the code which
1148 * cloned the thread.
1150 void *origeo = td->eo;
1152 * Otherwise use the default thread options.
1154 if (!origeo && td != &def_thread && def_thread.eo &&
1155 def_thread.io_ops->options == td->io_ops->options)
1156 origeo = def_thread.eo;
1158 options_init(td->io_ops->options);
1159 td->eo = malloc(td->io_ops->option_struct_size);
1161 * Use the default thread as an option template if this uses the
1162 * same options structure and there are non-default options
1166 memcpy(td->eo, origeo, td->io_ops->option_struct_size);
1167 options_mem_dupe(td->io_ops->options, td->eo);
1169 memset(td->eo, 0, td->io_ops->option_struct_size);
1170 fill_default_options(td->eo, td->io_ops->options);
1172 *(struct thread_data **)td->eo = td;
1176 td->io_ops->flags |= FIO_RAWIO;
1178 td_set_ioengine_flags(td);
1182 log_err("fio: failed to load engine\n");
1187 static void init_flags(struct thread_data *td)
1189 struct thread_options *o = &td->o;
1192 if (o->verify_backlog)
1193 td->flags |= TD_F_VER_BACKLOG;
1194 if (o->trim_backlog)
1195 td->flags |= TD_F_TRIM_BACKLOG;
1196 if (o->read_iolog_file)
1197 td->flags |= TD_F_READ_IOLOG;
1198 if (o->refill_buffers)
1199 td->flags |= TD_F_REFILL_BUFFERS;
1201 * Always scramble buffers if asked to
1203 if (o->scramble_buffers && fio_option_is_set(o, scramble_buffers))
1204 td->flags |= TD_F_SCRAMBLE_BUFFERS;
1206 * But also scramble buffers, unless we were explicitly asked
1209 if (o->scramble_buffers && !(o->zero_buffers &&
1210 fio_option_is_set(o, zero_buffers)))
1211 td->flags |= TD_F_SCRAMBLE_BUFFERS;
1212 if (o->verify != VERIFY_NONE)
1213 td->flags |= TD_F_DO_VERIFY;
1215 if (o->verify_async || o->io_submit_mode == IO_MODE_OFFLOAD)
1216 td->flags |= TD_F_NEED_LOCK;
1218 if (o->mem_type == MEM_CUDA_MALLOC)
1219 td->flags &= ~TD_F_SCRAMBLE_BUFFERS;
1221 for (i = 0; i < DDIR_RWDIR_CNT; i++) {
1222 if (option_check_rate(td, i)) {
1223 td->flags |= TD_F_CHECK_RATE;
1229 static int setup_random_seeds(struct thread_data *td)
1234 if (!td->o.rand_repeatable && !fio_option_is_set(&td->o, rand_seed)) {
1235 int ret = init_random_seeds(td->rand_seeds, sizeof(td->rand_seeds));
1237 td_fill_rand_seeds(td);
1241 seed = td->o.rand_seed;
1242 for (i = 0; i < 4; i++)
1243 seed *= 0x9e370001UL;
1245 for (i = 0; i < FIO_RAND_NR_OFFS; i++) {
1246 td->rand_seeds[i] = seed * td->thread_number + i;
1247 seed *= 0x9e370001UL;
1250 td_fill_rand_seeds(td);
1262 static struct fpre_keyword {
1263 const char *keyword;
1266 } fpre_keywords[] = {
1267 { .keyword = "$jobname", .key = FPRE_JOBNAME, },
1268 { .keyword = "$jobnum", .key = FPRE_JOBNUM, },
1269 { .keyword = "$filenum", .key = FPRE_FILENUM, },
1270 { .keyword = "$clientuid", .key = FPRE_CLIENTUID, },
1271 { .keyword = NULL, },
1274 static char *make_filename(char *buf, size_t buf_size,struct thread_options *o,
1275 const char *jobname, int jobnum, int filenum)
1277 struct fpre_keyword *f;
1278 char copy[PATH_MAX];
1279 size_t dst_left = PATH_MAX - 1;
1281 if (!o->filename_format || !strlen(o->filename_format)) {
1282 sprintf(buf, "%s.%d.%d", jobname, jobnum, filenum);
1286 for (f = &fpre_keywords[0]; f->keyword; f++)
1287 f->strlen = strlen(f->keyword);
1289 snprintf(buf, buf_size, "%s", o->filename_format);
1291 memset(copy, 0, sizeof(copy));
1292 for (f = &fpre_keywords[0]; f->keyword; f++) {
1294 size_t pre_len, post_start = 0;
1295 char *str, *dst = copy;
1297 str = strcasestr(buf, f->keyword);
1301 pre_len = str - buf;
1302 if (strlen(str) != f->strlen)
1303 post_start = pre_len + f->strlen;
1306 strncpy(dst, buf, pre_len);
1308 dst_left -= pre_len;
1312 case FPRE_JOBNAME: {
1315 ret = snprintf(dst, dst_left, "%s", jobname);
1318 else if (ret > dst_left) {
1319 log_err("fio: truncated filename\n");
1331 ret = snprintf(dst, dst_left, "%d", jobnum);
1334 else if (ret > dst_left) {
1335 log_err("fio: truncated filename\n");
1344 case FPRE_FILENUM: {
1347 ret = snprintf(dst, dst_left, "%d", filenum);
1350 else if (ret > dst_left) {
1351 log_err("fio: truncated filename\n");
1360 case FPRE_CLIENTUID: {
1362 ret = snprintf(dst, dst_left, "%s", client_sockaddr_str);
1365 else if (ret > dst_left) {
1366 log_err("fio: truncated filename\n");
1381 strncpy(dst, buf + post_start, dst_left);
1383 snprintf(buf, buf_size, "%s", copy);
1390 bool parse_dryrun(void)
1392 return dump_cmdline || parse_only;
1395 static void gen_log_name(char *name, size_t size, const char *logtype,
1396 const char *logname, unsigned int num,
1397 const char *suf, int per_job)
1400 snprintf(name, size, "%s_%s.%d.%s", logname, logtype, num, suf);
1402 snprintf(name, size, "%s_%s.%s", logname, logtype, suf);
1405 static int check_waitees(char *waitee)
1407 struct thread_data *td;
1410 for_each_td(td, i) {
1411 if (td->subjob_number)
1414 ret += !strcmp(td->o.name, waitee);
1420 static bool wait_for_ok(const char *jobname, struct thread_options *o)
1427 if (!strcmp(jobname, o->wait_for)) {
1428 log_err("%s: a job cannot wait for itself (wait_for=%s).\n",
1429 jobname, o->wait_for);
1433 if (!(nw = check_waitees(o->wait_for))) {
1434 log_err("%s: waitee job %s unknown.\n", jobname, o->wait_for);
1439 log_err("%s: multiple waitees %s found,\n"
1440 "please avoid duplicates when using wait_for option.\n",
1441 jobname, o->wait_for);
1449 * Treat an empty log file name the same as a one not given
1451 static const char *make_log_name(const char *logname, const char *jobname)
1453 if (logname && strcmp(logname, ""))
1460 * Adds a job to the list of things todo. Sanitizes the various options
1461 * to make sure we don't have conflicts, and initializes various
1464 static int add_job(struct thread_data *td, const char *jobname, int job_add_num,
1465 int recursed, int client_type)
1468 char fname[PATH_MAX + 1];
1469 int numjobs, file_alloced;
1470 struct thread_options *o = &td->o;
1471 char logname[PATH_MAX + 32];
1474 * the def_thread is just for options, it's not a real job
1476 if (td == &def_thread)
1482 * if we are just dumping the output command line, don't add the job
1484 if (parse_dryrun()) {
1489 td->client_type = client_type;
1491 if (profile_td_init(td))
1494 if (ioengine_load(td))
1498 if (!o->filename && !td->files_index && !o->read_iolog_file) {
1501 if (o->nr_files == 1 && exists_and_not_regfile(jobname))
1502 add_file(td, jobname, job_add_num, 0);
1504 for (i = 0; i < o->nr_files; i++)
1505 add_file(td, make_filename(fname, sizeof(fname), o, jobname, job_add_num, i), job_add_num, 0);
1509 if (setup_random_seeds(td)) {
1510 td_verror(td, errno, "setup_random_seeds");
1514 if (fixup_options(td))
1517 if (init_dedupe_working_set_seeds(td))
1521 * Belongs to fixup_options, but o->name is not necessarily set as yet
1523 if (!wait_for_ok(jobname, o))
1529 * IO engines only need this for option callbacks, and the address may
1530 * change in subprocesses.
1533 *(struct thread_data **)td->eo = NULL;
1535 if (td_ioengine_flagged(td, FIO_DISKLESSIO)) {
1538 for_each_file(td, f, i)
1539 f->real_file_size = -1ULL;
1542 td->sem = fio_sem_init(FIO_SEM_LOCKED);
1544 td->ts.clat_percentiles = o->clat_percentiles;
1545 td->ts.lat_percentiles = o->lat_percentiles;
1546 td->ts.slat_percentiles = o->slat_percentiles;
1547 td->ts.percentile_precision = o->percentile_precision;
1548 memcpy(td->ts.percentile_list, o->percentile_list, sizeof(o->percentile_list));
1549 td->ts.sig_figs = o->sig_figs;
1551 for (i = 0; i < DDIR_RWDIR_CNT; i++) {
1552 td->ts.clat_stat[i].min_val = ULONG_MAX;
1553 td->ts.slat_stat[i].min_val = ULONG_MAX;
1554 td->ts.lat_stat[i].min_val = ULONG_MAX;
1555 td->ts.bw_stat[i].min_val = ULONG_MAX;
1556 td->ts.iops_stat[i].min_val = ULONG_MAX;
1557 td->ts.clat_high_prio_stat[i].min_val = ULONG_MAX;
1558 td->ts.clat_low_prio_stat[i].min_val = ULONG_MAX;
1560 td->ts.sync_stat.min_val = ULONG_MAX;
1561 td->ddir_seq_nr = o->ddir_seq_nr;
1563 if ((o->stonewall || o->new_group) && prev_group_jobs) {
1564 prev_group_jobs = 0;
1566 if (groupid == INT_MAX) {
1567 log_err("fio: too many groups defined\n");
1572 td->groupid = groupid;
1578 if (o->write_lat_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_LAT,
1585 .log_offset = o->log_offset,
1586 .log_prio = o->log_prio,
1587 .log_gz = o->log_gz,
1588 .log_gz_store = o->log_gz_store,
1590 const char *pre = make_log_name(o->lat_log_file, o->name);
1598 gen_log_name(logname, sizeof(logname), "lat", pre,
1599 td->thread_number, suf, o->per_job_logs);
1600 setup_log(&td->lat_log, &p, logname);
1602 gen_log_name(logname, sizeof(logname), "slat", pre,
1603 td->thread_number, suf, o->per_job_logs);
1604 setup_log(&td->slat_log, &p, logname);
1606 gen_log_name(logname, sizeof(logname), "clat", pre,
1607 td->thread_number, suf, o->per_job_logs);
1608 setup_log(&td->clat_log, &p, logname);
1612 if (o->write_hist_log) {
1613 struct log_params p = {
1615 .avg_msec = o->log_avg_msec,
1616 .hist_msec = o->log_hist_msec,
1617 .hist_coarseness = o->log_hist_coarseness,
1618 .log_type = IO_LOG_TYPE_HIST,
1619 .log_offset = o->log_offset,
1620 .log_prio = o->log_prio,
1621 .log_gz = o->log_gz,
1622 .log_gz_store = o->log_gz_store,
1624 const char *pre = make_log_name(o->hist_log_file, o->name);
1628 if (td->client_type) {
1629 log_err("fio: --write_hist_log requires zlib in client/server mode\n");
1639 gen_log_name(logname, sizeof(logname), "clat_hist", pre,
1640 td->thread_number, suf, o->per_job_logs);
1641 setup_log(&td->clat_hist_log, &p, logname);
1644 if (o->write_bw_log) {
1645 struct log_params p = {
1647 .avg_msec = o->log_avg_msec,
1648 .hist_msec = o->log_hist_msec,
1649 .hist_coarseness = o->log_hist_coarseness,
1650 .log_type = IO_LOG_TYPE_BW,
1651 .log_offset = o->log_offset,
1652 .log_prio = o->log_prio,
1653 .log_gz = o->log_gz,
1654 .log_gz_store = o->log_gz_store,
1656 const char *pre = make_log_name(o->bw_log_file, o->name);
1659 if (fio_option_is_set(o, bw_avg_time))
1660 p.avg_msec = min(o->log_avg_msec, o->bw_avg_time);
1662 o->bw_avg_time = p.avg_msec;
1664 p.hist_msec = o->log_hist_msec;
1665 p.hist_coarseness = o->log_hist_coarseness;
1672 gen_log_name(logname, sizeof(logname), "bw", pre,
1673 td->thread_number, suf, o->per_job_logs);
1674 setup_log(&td->bw_log, &p, logname);
1676 if (o->write_iops_log) {
1677 struct log_params p = {
1679 .avg_msec = o->log_avg_msec,
1680 .hist_msec = o->log_hist_msec,
1681 .hist_coarseness = o->log_hist_coarseness,
1682 .log_type = IO_LOG_TYPE_IOPS,
1683 .log_offset = o->log_offset,
1684 .log_prio = o->log_prio,
1685 .log_gz = o->log_gz,
1686 .log_gz_store = o->log_gz_store,
1688 const char *pre = make_log_name(o->iops_log_file, o->name);
1691 if (fio_option_is_set(o, iops_avg_time))
1692 p.avg_msec = min(o->log_avg_msec, o->iops_avg_time);
1694 o->iops_avg_time = p.avg_msec;
1696 p.hist_msec = o->log_hist_msec;
1697 p.hist_coarseness = o->log_hist_coarseness;
1704 gen_log_name(logname, sizeof(logname), "iops", pre,
1705 td->thread_number, suf, o->per_job_logs);
1706 setup_log(&td->iops_log, &p, logname);
1710 o->name = strdup(jobname);
1712 if (output_format & FIO_OUTPUT_NORMAL) {
1714 if (is_backend && !recursed)
1715 fio_server_send_add_job(td);
1717 if (!td_ioengine_flagged(td, FIO_NOIO)) {
1718 char *c1, *c2, *c3, *c4;
1719 char *c5 = NULL, *c6 = NULL;
1720 int i2p = is_power_of_2(o->kb_base);
1721 struct buf_output out;
1723 c1 = num2str(o->min_bs[DDIR_READ], o->sig_figs, 1, i2p, N2S_BYTE);
1724 c2 = num2str(o->max_bs[DDIR_READ], o->sig_figs, 1, i2p, N2S_BYTE);
1725 c3 = num2str(o->min_bs[DDIR_WRITE], o->sig_figs, 1, i2p, N2S_BYTE);
1726 c4 = num2str(o->max_bs[DDIR_WRITE], o->sig_figs, 1, i2p, N2S_BYTE);
1728 if (!o->bs_is_seq_rand) {
1729 c5 = num2str(o->min_bs[DDIR_TRIM], o->sig_figs, 1, i2p, N2S_BYTE);
1730 c6 = num2str(o->max_bs[DDIR_TRIM], o->sig_figs, 1, i2p, N2S_BYTE);
1733 buf_output_init(&out);
1734 __log_buf(&out, "%s: (g=%d): rw=%s, ", td->o.name,
1736 ddir_str(o->td_ddir));
1738 if (o->bs_is_seq_rand)
1739 __log_buf(&out, "bs=(R) %s-%s, (W) %s-%s, bs_is_seq_rand, ",
1742 __log_buf(&out, "bs=(R) %s-%s, (W) %s-%s, (T) %s-%s, ",
1743 c1, c2, c3, c4, c5, c6);
1745 __log_buf(&out, "ioengine=%s, iodepth=%u\n",
1746 td->io_ops->name, o->iodepth);
1747 log_info_buf(out.buf, out.buflen);
1748 buf_output_free(&out);
1757 } else if (job_add_num == 1)
1761 if (td_steadystate_init(td))
1764 if (o->merge_blktrace_file && !merge_blktrace_iologs(td))
1767 if (merge_blktrace_only) {
1773 * recurse add identical jobs, clear numjobs and stonewall options
1774 * as they don't apply to sub-jobs
1776 numjobs = o->numjobs;
1778 struct thread_data *td_new = get_new_job(false, td, true, jobname);
1783 td_new->o.numjobs = 1;
1784 td_new->o.stonewall = 0;
1785 td_new->o.new_group = 0;
1786 td_new->subjob_number = numjobs;
1787 td_new->o.ss_dur = o->ss_dur * 1000000l;
1788 td_new->o.ss_limit = o->ss_limit;
1791 if (td_new->files) {
1793 for_each_file(td_new, f, i)
1795 free(td_new->files);
1796 td_new->files = NULL;
1798 td_new->files_index = 0;
1799 td_new->files_size = 0;
1800 if (td_new->o.filename) {
1801 free(td_new->o.filename);
1802 td_new->o.filename = NULL;
1806 if (add_job(td_new, jobname, numjobs, 1, client_type))
1817 * Parse as if 'o' was a command line
1819 void add_job_opts(const char **o, int client_type)
1821 struct thread_data *td, *td_parent;
1822 int i, in_global = 1;
1826 td_parent = td = NULL;
1828 if (!strncmp(o[i], "name", 4)) {
1831 add_job(td, jobname, 0, 0, client_type);
1833 sprintf(jobname, "%s", o[i] + 5);
1835 if (in_global && !td_parent)
1836 td_parent = get_new_job(true, &def_thread, false, jobname);
1837 else if (!in_global && !td) {
1839 td_parent = &def_thread;
1840 td = get_new_job(false, td_parent, false, jobname);
1843 fio_options_parse(td_parent, (char **) &o[i], 1);
1845 fio_options_parse(td, (char **) &o[i], 1);
1850 add_job(td, jobname, 0, 0, client_type);
1853 static int skip_this_section(const char *name)
1857 if (!nr_job_sections)
1859 if (!strncmp(name, "global", 6))
1862 for (i = 0; i < nr_job_sections; i++)
1863 if (!strcmp(job_sections[i], name))
1869 static int is_empty_or_comment(char *line)
1873 for (i = 0; i < strlen(line); i++) {
1878 if (!isspace((int) line[i]) && !iscntrl((int) line[i]))
1886 * This is our [ini] type file parser.
1888 static int __parse_jobs_ini(struct thread_data *td,
1889 char *file, int is_buf, int stonewall_flag, int type,
1890 int nested, char *name, char ***popts, int *aopts, int *nopts)
1892 bool global = false;
1893 bool stdin_occupied = false;
1897 int ret = 0, stonewall;
1900 int inside_skip = 0;
1902 int i, alloc_opts, num_opts;
1904 dprint(FD_PARSE, "Parsing ini file %s\n", file);
1905 assert(td || !nested);
1910 if (!strcmp(file, "-")) {
1912 stdin_occupied = true;
1914 f = fopen(file, "r");
1919 log_err("fio: unable to open '%s' job file\n", file);
1921 td_verror(td, __err, "job file open");
1926 string = malloc(OPT_LEN_MAX);
1929 * it's really 256 + small bit, 280 should suffice
1933 memset(name, 0, 280);
1937 if (nested && popts) {
1939 alloc_opts = *aopts;
1945 opts = malloc(sizeof(char *) * alloc_opts);
1949 stonewall = stonewall_flag;
1952 * if skip_fgets is set, we already have loaded a line we
1957 p = strsep(&file, "\n");
1959 p = fgets(string, OPT_LEN_MAX, f);
1965 strip_blank_front(&p);
1968 dprint(FD_PARSE, "%s\n", p);
1969 if (is_empty_or_comment(p))
1973 if (sscanf(p, "[%255[^\n]]", name) != 1) {
1977 log_err("fio: option <%s> outside of "
1978 "[] job section\n", p);
1983 name[strlen(name) - 1] = '\0';
1985 if (skip_this_section(name)) {
1991 dprint(FD_PARSE, "Parsing section [%s]\n", name);
1993 global = !strncmp(name, "global", 6);
1999 log_info("--name=%s ", name);
2003 td = get_new_job(global, &def_thread, false, name);
2010 * Separate multiple job files by a stonewall
2012 if (!global && stonewall) {
2013 td->o.stonewall = stonewall;
2018 memset(opts, 0, alloc_opts * sizeof(char *));
2026 p = strsep(&file, "\n");
2028 p = fgets(string, OPT_LEN_MAX, f);
2031 dprint(FD_PARSE, "%s", p);
2036 if (is_empty_or_comment(p))
2039 strip_blank_front(&p);
2042 * new section, break out and make sure we don't
2043 * fgets() a new line at the top.
2047 log_err("No new sections in included files\n");
2058 if (!strncmp(p, "include", strlen("include"))) {
2059 char *filename = p + strlen("include") + 1,
2060 *ts, *full_fn = NULL;
2063 * Allow for the include filename
2064 * specification to be relative.
2066 if (access(filename, F_OK) &&
2067 (ts = strrchr(file, '/'))) {
2068 if (asprintf(&full_fn, "%.*s%s",
2069 (int)(ts - file + 1), file,
2077 ret = __parse_jobs_ini(td, filename, is_buf,
2078 stonewall_flag, type, 1,
2080 &alloc_opts, &num_opts);
2083 log_err("Error %d while parsing "
2084 "include file %s\n",
2097 if (num_opts == alloc_opts) {
2099 opts = realloc(opts,
2100 alloc_opts * sizeof(char *));
2103 opts[num_opts] = strdup(p);
2109 *aopts = alloc_opts;
2114 ret = fio_options_parse(td, opts, num_opts);
2116 if (!ret && td->o.read_iolog_file != NULL) {
2117 char *fname = get_name_by_idx(td->o.read_iolog_file,
2119 if (!strcmp(fname, "-")) {
2120 if (stdin_occupied) {
2121 log_err("fio: only one user (read_iolog_file/job "
2122 "file) of stdin is permitted at once but "
2123 "more than one was found.\n");
2126 stdin_occupied = true;
2133 ret = add_job(td, name, 0, 0, type);
2135 log_err("fio: job %s dropped\n", name);
2139 for (i = 0; i < num_opts; i++)
2148 while (i < nr_job_sections) {
2149 free(job_sections[i]);
2158 if (!is_buf && f != stdin)
2163 int parse_jobs_ini(char *file, int is_buf, int stonewall_flag, int type)
2165 return __parse_jobs_ini(NULL, file, is_buf, stonewall_flag, type,
2166 0, NULL, NULL, NULL, NULL);
2169 static int fill_def_thread(void)
2171 memset(&def_thread, 0, sizeof(def_thread));
2172 INIT_FLIST_HEAD(&def_thread.opt_list);
2174 fio_getaffinity(getpid(), &def_thread.o.cpumask);
2175 def_thread.o.error_dump = 1;
2178 * fill default options
2180 fio_fill_default_options(&def_thread);
2184 static void show_debug_categories(void)
2186 #ifdef FIO_INC_DEBUG
2187 const struct debug_level *dl = &debug_levels[0];
2188 int curlen, first = 1;
2192 int has_next = (dl + 1)->name != NULL;
2194 if (first || curlen + strlen(dl->name) >= 80) {
2199 curlen += printf("\t\t\t%s", dl->name);
2200 curlen += 3 * (8 - 1);
2202 curlen += printf(",");
2204 curlen += printf("%s", dl->name);
2206 curlen += printf(",");
2216 * Following options aren't printed by usage().
2217 * --append-terse - Equivalent to --output-format=terse, see f6a7df53.
2218 * --latency-log - Deprecated option.
2220 static void usage(const char *name)
2222 printf("%s\n", fio_version_string);
2223 printf("%s [options] [job options] <job file(s)>\n", name);
2224 printf(" --debug=options\tEnable debug logging. May be one/more of:\n");
2225 show_debug_categories();
2226 printf(" --parse-only\t\tParse options only, don't start any IO\n");
2227 printf(" --merge-blktrace-only\tMerge blktraces only, don't start any IO\n");
2228 printf(" --output\t\tWrite output to file\n");
2229 printf(" --bandwidth-log\tGenerate aggregate bandwidth logs\n");
2230 printf(" --minimal\t\tMinimal (terse) output\n");
2231 printf(" --output-format=type\tOutput format (terse,json,json+,normal)\n");
2232 printf(" --terse-version=type\tSet terse version output format"
2233 " (default 3, or 2 or 4)\n");
2234 printf(" --version\t\tPrint version info and exit\n");
2235 printf(" --help\t\tPrint this page\n");
2236 printf(" --cpuclock-test\tPerform test/validation of CPU clock\n");
2237 printf(" --crctest=[type]\tTest speed of checksum functions\n");
2238 printf(" --cmdhelp=cmd\t\tPrint command help, \"all\" for all of"
2240 printf(" --enghelp=engine\tPrint ioengine help, or list"
2241 " available ioengines\n");
2242 printf(" --enghelp=engine,cmd\tPrint help for an ioengine"
2244 printf(" --showcmd\t\tTurn a job file into command line options\n");
2245 printf(" --eta=when\t\tWhen ETA estimate should be printed\n");
2246 printf(" \t\tMay be \"always\", \"never\" or \"auto\"\n");
2247 printf(" --eta-newline=t\tForce a new line for every 't'");
2248 printf(" period passed\n");
2249 printf(" --status-interval=t\tForce full status dump every");
2250 printf(" 't' period passed\n");
2251 printf(" --readonly\t\tTurn on safety read-only checks, preventing"
2253 printf(" --section=name\tOnly run specified section in job file,"
2254 " multiple sections can be specified\n");
2255 printf(" --alloc-size=kb\tSet smalloc pool to this size in kb"
2257 printf(" --warnings-fatal\tFio parser warnings are fatal\n");
2258 printf(" --max-jobs=nr\t\tMaximum number of threads/processes to support\n");
2259 printf(" --server=args\t\tStart a backend fio server\n");
2260 printf(" --daemonize=pidfile\tBackground fio server, write pid to file\n");
2261 printf(" --client=hostname\tTalk to remote backend(s) fio server at hostname\n");
2262 printf(" --remote-config=file\tTell fio server to load this local job file\n");
2263 printf(" --idle-prof=option\tReport cpu idleness on a system or percpu basis\n"
2264 "\t\t\t(option=system,percpu) or run unit work\n"
2265 "\t\t\tcalibration only (option=calibrate)\n");
2267 printf(" --inflate-log=log\tInflate and output compressed log\n");
2269 printf(" --trigger-file=file\tExecute trigger cmd when file exists\n");
2270 printf(" --trigger-timeout=t\tExecute trigger at this time\n");
2271 printf(" --trigger=cmd\t\tSet this command as local trigger\n");
2272 printf(" --trigger-remote=cmd\tSet this command as remote trigger\n");
2273 printf(" --aux-path=path\tUse this path for fio state generated files\n");
2274 printf("\nFio was written by Jens Axboe <axboe@kernel.dk>\n");
2277 #ifdef FIO_INC_DEBUG
2278 const struct debug_level debug_levels[] = {
2279 { .name = "process",
2280 .help = "Process creation/exit logging",
2281 .shift = FD_PROCESS,
2284 .help = "File related action logging",
2288 .help = "IO and IO engine action logging (offsets, queue, completions, etc)",
2292 .help = "Memory allocation/freeing logging",
2295 { .name = "blktrace",
2296 .help = "blktrace action logging",
2297 .shift = FD_BLKTRACE,
2300 .help = "IO verification action logging",
2304 .help = "Random generation logging",
2308 .help = "Parser logging",
2311 { .name = "diskutil",
2312 .help = "Disk utility logging actions",
2313 .shift = FD_DISKUTIL,
2316 .help = "Logging related to creating/destroying jobs",
2320 .help = "Mutex logging",
2323 { .name = "profile",
2324 .help = "Logging related to profiles",
2325 .shift = FD_PROFILE,
2328 .help = "Logging related to time keeping functions",
2332 .help = "Network logging",
2336 .help = "Rate logging",
2339 { .name = "compress",
2340 .help = "Log compression logging",
2341 .shift = FD_COMPRESS,
2343 { .name = "steadystate",
2344 .help = "Steady state detection logging",
2345 .shift = FD_STEADYSTATE,
2347 { .name = "helperthread",
2348 .help = "Helper thread logging",
2349 .shift = FD_HELPERTHREAD,
2352 .help = "Zoned Block Device logging",
2358 static int set_debug(const char *string)
2360 const struct debug_level *dl;
2361 char *p = (char *) string;
2368 if (!strcmp(string, "?") || !strcmp(string, "help")) {
2369 log_info("fio: dumping debug options:");
2370 for (i = 0; debug_levels[i].name; i++) {
2371 dl = &debug_levels[i];
2372 log_info("%s,", dl->name);
2378 while ((opt = strsep(&p, ",")) != NULL) {
2381 if (!strncmp(opt, "all", 3)) {
2382 log_info("fio: set all debug options\n");
2387 for (i = 0; debug_levels[i].name; i++) {
2388 dl = &debug_levels[i];
2389 found = !strncmp(opt, dl->name, strlen(dl->name));
2393 if (dl->shift == FD_JOB) {
2394 opt = strchr(opt, ':');
2396 log_err("fio: missing job number\n");
2400 fio_debug_jobno = atoi(opt);
2401 log_info("fio: set debug jobno %d\n",
2404 log_info("fio: set debug option %s\n", opt);
2405 fio_debug |= (1UL << dl->shift);
2411 log_err("fio: debug mask %s not found\n", opt);
2416 static int set_debug(const char *string)
2418 log_err("fio: debug tracing not included in build\n");
2423 static void fio_options_fill_optstring(void)
2425 char *ostr = cmd_optstr;
2429 while (l_opts[i].name) {
2430 ostr[c++] = l_opts[i].val;
2431 if (l_opts[i].has_arg == required_argument)
2433 else if (l_opts[i].has_arg == optional_argument) {
2442 static int client_flag_set(char c)
2447 while (l_opts[i].name) {
2448 int val = l_opts[i].val;
2450 if (c == (val & 0xff))
2451 return (val & FIO_CLIENT_FLAG);
2459 static void parse_cmd_client(void *client, char *opt)
2461 fio_client_add_cmd_option(client, opt);
2464 static void show_closest_option(const char *name)
2466 int best_option, best_distance;
2469 while (*name == '-')
2473 best_distance = INT_MAX;
2475 while (l_opts[i].name) {
2476 distance = string_distance(name, l_opts[i].name);
2477 if (distance < best_distance) {
2478 best_distance = distance;
2484 if (best_option != -1 && string_distance_ok(name, best_distance))
2485 log_err("Did you mean %s?\n", l_opts[best_option].name);
2488 static int parse_output_format(const char *optarg)
2490 char *p, *orig, *opt;
2493 p = orig = strdup(optarg);
2497 while ((opt = strsep(&p, ",")) != NULL) {
2498 if (!strcmp(opt, "minimal") ||
2499 !strcmp(opt, "terse") ||
2500 !strcmp(opt, "csv"))
2501 output_format |= FIO_OUTPUT_TERSE;
2502 else if (!strcmp(opt, "json"))
2503 output_format |= FIO_OUTPUT_JSON;
2504 else if (!strcmp(opt, "json+"))
2505 output_format |= (FIO_OUTPUT_JSON | FIO_OUTPUT_JSON_PLUS);
2506 else if (!strcmp(opt, "normal"))
2507 output_format |= FIO_OUTPUT_NORMAL;
2509 log_err("fio: invalid output format %s\n", opt);
2519 int parse_cmd_line(int argc, char *argv[], int client_type)
2521 struct thread_data *td = NULL;
2522 int c, ini_idx = 0, lidx, ret = 0, do_exit = 0, exit_val = 0;
2523 char *ostr = cmd_optstr;
2524 char *pid_file = NULL;
2525 void *cur_client = NULL;
2526 bool backend = false;
2529 * Reset optind handling, since we may call this multiple times
2534 while ((c = getopt_long_only(argc, argv, ostr, l_opts, &lidx)) != -1) {
2535 if ((c & FIO_CLIENT_FLAG) || client_flag_set(c)) {
2536 parse_cmd_client(cur_client, argv[optind - 1]);
2537 c &= ~FIO_CLIENT_FLAG;
2542 smalloc_pool_size = atoi(optarg);
2543 smalloc_pool_size <<= 10;
2547 log_err("fio: --latency-log is deprecated. Use per-job latency log options.\n");
2552 write_bw_log = true;
2557 if (f_out && f_out != stdout)
2560 tmp = fopen(optarg, "w+");
2562 log_err("fio: output file open error: %s\n", strerror(errno));
2567 f_err = f_out = tmp;
2571 output_format = FIO_OUTPUT_TERSE;
2574 if (parse_output_format(optarg)) {
2575 log_err("fio: failed parsing output-format\n");
2582 output_format |= FIO_OUTPUT_TERSE;
2594 fio_show_option_help(optarg);
2601 exit_val = fio_show_ioengine_help(optarg);
2607 dump_cmdline = true;
2615 log_info("%s\n", fio_version_string);
2620 terse_version = atoi(optarg);
2621 if (!(terse_version >= 2 && terse_version <= 5)) {
2622 log_err("fio: bad terse version format\n");
2628 if (!strcmp("always", optarg))
2629 eta_print = FIO_ETA_ALWAYS;
2630 else if (!strcmp("never", optarg))
2631 eta_print = FIO_ETA_NEVER;
2636 if (check_str_time(optarg, &t, 1)) {
2637 log_err("fio: failed parsing eta time %s\n", optarg);
2642 eta_new_line = t / 1000;
2643 if (!eta_new_line) {
2644 log_err("fio: eta new line time too short\n");
2653 if (check_str_time(optarg, &t, 1)) {
2654 log_err("fio: failed parsing eta interval %s\n", optarg);
2659 eta_interval_msec = t / 1000;
2660 if (eta_interval_msec < DISK_UTIL_MSEC) {
2661 log_err("fio: eta interval time too short (%umsec min)\n", DISK_UTIL_MSEC);
2668 if (set_debug(optarg))
2678 if (!strcmp(optarg, "global")) {
2679 log_err("fio: can't use global as only "
2685 new_size = (nr_job_sections + 1) * sizeof(char *);
2686 job_sections = realloc(job_sections, new_size);
2687 job_sections[nr_job_sections] = strdup(optarg);
2693 exit_val = iolog_file_inflate(optarg);
2702 exec_profile = strdup(optarg);
2704 case FIO_GETOPT_JOB: {
2705 const char *opt = l_opts[lidx].name;
2708 if (!strncmp(opt, "name", 4) && td) {
2709 ret = add_job(td, td->o.name ?: "fio", 0, 0, client_type);
2716 int is_section = !strncmp(opt, "name", 4);
2719 if (!is_section || !strncmp(val, "global", 6))
2722 if (is_section && skip_this_section(val))
2725 td = get_new_job(global, &def_thread, true, NULL);
2726 if (!td || ioengine_load(td)) {
2735 fio_options_set_ioengine_opts(l_opts, td);
2738 if ((!val || !strlen(val)) &&
2739 l_opts[lidx].has_arg == required_argument) {
2740 log_err("fio: option %s requires an argument\n", opt);
2743 ret = fio_cmd_option_parse(td, opt, val);
2754 if (!ret && !strcmp(opt, "ioengine")) {
2755 if (ioengine_load(td)) {
2762 fio_options_set_ioengine_opts(l_opts, td);
2766 case FIO_GETOPT_IOENGINE: {
2767 const char *opt = l_opts[lidx].name;
2773 ret = fio_cmd_ioengine_option_parse(td, opt, val);
2780 /* we don't track/need this anymore, ignore it */
2784 #ifndef CONFIG_NO_SHM
2786 log_err("fio: can't be both client and server\n");
2792 fio_server_set_arg(optarg);
2796 log_err("fio: client/server requires SHM support\n");
2804 pid_file = strdup(optarg);
2807 if ((ret = fio_idle_prof_parse_opt(optarg))) {
2808 /* exit on error and calibration only */
2818 log_err("fio: can't be both client and server\n");
2823 /* if --client parameter contains a pathname */
2824 if (0 == access(optarg, R_OK)) {
2825 /* file contains a list of host addrs or names */
2826 char hostaddr[PATH_MAX] = {0};
2828 FILE * hostf = fopen(optarg, "r");
2830 log_err("fio: could not open client list file %s for read\n", optarg);
2835 sprintf(formatstr, "%%%ds", PATH_MAX - 1);
2837 * read at most PATH_MAX-1 chars from each
2838 * record in this file
2840 while (fscanf(hostf, formatstr, hostaddr) == 1) {
2841 /* expect EVERY host in file to be valid */
2842 if (fio_client_add(&fio_client_ops, hostaddr, &cur_client)) {
2843 log_err("fio: failed adding client %s from file %s\n", hostaddr, optarg);
2850 break; /* no possibility of job file for "this client only" */
2852 if (fio_client_add(&fio_client_ops, optarg, &cur_client)) {
2853 log_err("fio: failed adding client %s\n", optarg);
2859 * If the next argument exists and isn't an option,
2860 * assume it's a job file for this client only.
2862 while (optind < argc) {
2863 if (!strncmp(argv[optind], "--", 2) ||
2864 !strncmp(argv[optind], "-", 1))
2867 if (fio_client_add_ini_file(cur_client, argv[optind], false))
2874 if (fio_client_add_ini_file(cur_client, optarg, true)) {
2882 exit_val = fio_monotonic_clocktest(1);
2887 exit_val = fio_crctest(optarg);
2892 exit_val = fio_memcpy_test(optarg);
2897 if (check_str_time(optarg, &val, 1)) {
2898 log_err("fio: failed parsing time %s\n", optarg);
2904 log_err("fio: status interval too small\n");
2908 status_interval = val / 1000;
2914 trigger_file = strdup(optarg);
2919 trigger_cmd = strdup(optarg);
2922 if (trigger_remote_cmd)
2923 free(trigger_remote_cmd);
2924 trigger_remote_cmd = strdup(optarg);
2929 aux_path = strdup(optarg);
2932 if (check_str_time(optarg, &trigger_timeout, 1)) {
2933 log_err("fio: failed parsing time %s\n", optarg);
2937 trigger_timeout /= 1000000;
2942 merge_blktrace_only = true;
2945 log_err("%s: unrecognized option '%s'\n", argv[0],
2947 show_closest_option(argv[optind - 1]);
2958 if (do_exit && !(is_backend || nr_clients))
2961 if (nr_clients && fio_clients_connect())
2964 if (is_backend && backend)
2965 return fio_start_server(pid_file);
2971 ret = add_job(td, td->o.name ?: "fio", 0, 0, client_type);
2977 while (!ret && optind < argc) {
2979 ini_file = realloc(ini_file, ini_idx * sizeof(char *));
2980 ini_file[ini_idx - 1] = strdup(argv[optind]);
2988 int fio_init_options(void)
2993 fio_options_fill_optstring();
2994 fio_options_dup_and_init(l_opts);
2998 if (fill_def_thread())
3004 extern int fio_check_options(struct thread_options *);
3006 int parse_options(int argc, char *argv[])
3008 const int type = FIO_CLIENT_TYPE_CLI;
3011 if (fio_init_options())
3013 if (fio_test_cconv(&def_thread.o))
3014 log_err("fio: failed internal cconv test\n");
3016 job_files = parse_cmd_line(argc, argv, type);
3018 if (job_files > 0) {
3019 for (i = 0; i < job_files; i++) {
3020 if (i && fill_def_thread())
3023 if (fio_clients_send_ini(ini_file[i]))
3026 } else if (!is_backend) {
3027 if (parse_jobs_ini(ini_file[i], 0, i, type))
3032 } else if (nr_clients) {
3033 if (fill_def_thread())
3035 if (fio_clients_send_ini(NULL))
3040 fio_options_free(&def_thread);
3041 filesetup_mem_free();
3043 if (!thread_number) {
3048 if (is_backend || nr_clients)
3053 log_err("No job(s) defined\n\n");
3058 if (output_format & FIO_OUTPUT_NORMAL)
3059 log_info("%s\n", fio_version_string);
3064 void options_default_fill(struct thread_options *o)
3066 memcpy(o, &def_thread.o, sizeof(*o));
3069 struct thread_data *get_global_options(void)