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 * O_ATOMIC implies O_DIRECT
926 * If randseed is set, that overrides randrepeat
928 if (fio_option_is_set(o, rand_seed))
929 o->rand_repeatable = 0;
931 if (td_ioengine_flagged(td, FIO_NOEXTEND) && o->file_append) {
932 log_err("fio: can't append/extent with IO engine %s\n", td->io_ops->name);
936 if (fio_option_is_set(o, gtod_cpu)) {
938 fio_gtod_set_cpu(o->gtod_cpu);
939 fio_gtod_offload = 1;
942 td->loops = o->loops;
946 if (o->block_error_hist && o->nr_files != 1) {
947 log_err("fio: block error histogram only available "
948 "with a single file per job, but %d files "
949 "provided\n", o->nr_files);
954 o->lat_percentiles = 0;
956 o->clat_percentiles = 0;
958 o->slat_percentiles = 0;
961 * Fix these up to be nsec internally
963 for_each_rw_ddir(ddir)
964 o->max_latency[ddir] *= 1000ULL;
966 o->latency_target *= 1000ULL;
969 * Dedupe working set verifications
971 if (o->dedupe_percentage && o->dedupe_mode == DEDUPE_MODE_WORKING_SET) {
972 if (!fio_option_is_set(o, size)) {
973 log_err("fio: pregenerated dedupe working set "
974 "requires size to be set\n");
976 } else if (o->nr_files != 1) {
977 log_err("fio: dedupe working set mode supported with "
978 "single file per job, but %d files "
979 "provided\n", o->nr_files);
981 } else if (o->dedupe_working_set_percentage + o->dedupe_percentage > 100) {
982 log_err("fio: impossible to reach expected dedupe percentage %u "
983 "since %u percentage of size is reserved to dedupe working set "
984 "(those are unique pages)\n",
985 o->dedupe_percentage, o->dedupe_working_set_percentage);
993 static void init_rand_file_service(struct thread_data *td)
995 unsigned long nranges = td->o.nr_files << FIO_FSERVICE_SHIFT;
996 const unsigned int seed = td->rand_seeds[FIO_RAND_FILE_OFF];
998 if (td->o.file_service_type == FIO_FSERVICE_ZIPF) {
999 zipf_init(&td->next_file_zipf, nranges, td->zipf_theta, td->random_center, seed);
1000 zipf_disable_hash(&td->next_file_zipf);
1001 } else if (td->o.file_service_type == FIO_FSERVICE_PARETO) {
1002 pareto_init(&td->next_file_zipf, nranges, td->pareto_h, td->random_center, seed);
1003 zipf_disable_hash(&td->next_file_zipf);
1004 } else if (td->o.file_service_type == FIO_FSERVICE_GAUSS) {
1005 gauss_init(&td->next_file_gauss, nranges, td->gauss_dev, td->random_center, seed);
1006 gauss_disable_hash(&td->next_file_gauss);
1010 void td_fill_verify_state_seed(struct thread_data *td)
1014 if (td->o.random_generator == FIO_RAND_GEN_TAUSWORTHE64)
1019 init_rand_seed(&td->verify_state, td->rand_seeds[FIO_RAND_VER_OFF],
1023 static void td_fill_rand_seeds_internal(struct thread_data *td, bool use64)
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 * trimwrite is special in that we need to generate the same
1032 * offsets to get the "write after trim" effect. If we are
1033 * using bssplit to set buffer length distributions, ensure that
1034 * we seed the trim and write generators identically. Ditto for
1035 * verify, read and writes must have the same seed, if we are doing
1038 if (td->o.verify != VERIFY_NONE)
1039 write_seed = read_seed;
1040 if (td_trimwrite(td))
1041 trim_seed = write_seed;
1042 init_rand_seed(&td->bsrange_state[DDIR_READ], read_seed, use64);
1043 init_rand_seed(&td->bsrange_state[DDIR_WRITE], write_seed, use64);
1044 init_rand_seed(&td->bsrange_state[DDIR_TRIM], trim_seed, use64);
1046 td_fill_verify_state_seed(td);
1047 init_rand_seed(&td->rwmix_state, td->rand_seeds[FIO_RAND_MIX_OFF], false);
1049 if (td->o.file_service_type == FIO_FSERVICE_RANDOM)
1050 init_rand_seed(&td->next_file_state, td->rand_seeds[FIO_RAND_FILE_OFF], use64);
1051 else if (td->o.file_service_type & __FIO_FSERVICE_NONUNIFORM)
1052 init_rand_file_service(td);
1054 init_rand_seed(&td->file_size_state, td->rand_seeds[FIO_RAND_FILE_SIZE_OFF], use64);
1055 init_rand_seed(&td->trim_state, td->rand_seeds[FIO_RAND_TRIM_OFF], use64);
1056 init_rand_seed(&td->delay_state, td->rand_seeds[FIO_RAND_START_DELAY], use64);
1057 init_rand_seed(&td->poisson_state[0], td->rand_seeds[FIO_RAND_POISSON_OFF], 0);
1058 init_rand_seed(&td->poisson_state[1], td->rand_seeds[FIO_RAND_POISSON2_OFF], 0);
1059 init_rand_seed(&td->poisson_state[2], td->rand_seeds[FIO_RAND_POISSON3_OFF], 0);
1060 init_rand_seed(&td->dedupe_state, td->rand_seeds[FIO_DEDUPE_OFF], false);
1061 init_rand_seed(&td->zone_state, td->rand_seeds[FIO_RAND_ZONE_OFF], false);
1062 init_rand_seed(&td->prio_state, td->rand_seeds[FIO_RAND_PRIO_CMDS], false);
1063 init_rand_seed(&td->dedupe_working_set_index_state, td->rand_seeds[FIO_RAND_DEDUPE_WORKING_SET_IX], use64);
1068 if (td->o.rand_repeatable)
1069 td->rand_seeds[FIO_RAND_BLOCK_OFF] = FIO_RANDSEED * td->thread_number;
1071 init_rand_seed(&td->random_state, td->rand_seeds[FIO_RAND_BLOCK_OFF], use64);
1073 for (i = 0; i < DDIR_RWDIR_CNT; i++) {
1074 struct frand_state *s = &td->seq_rand_state[i];
1076 init_rand_seed(s, td->rand_seeds[FIO_RAND_SEQ_RAND_READ_OFF], false);
1080 void td_fill_rand_seeds(struct thread_data *td)
1084 if (td->o.allrand_repeatable) {
1087 for (i = 0; i < FIO_RAND_NR_OFFS; i++)
1088 td->rand_seeds[i] = FIO_RANDSEED * td->thread_number
1092 if (td->o.random_generator == FIO_RAND_GEN_TAUSWORTHE64)
1097 td_fill_rand_seeds_internal(td, use64);
1099 init_rand_seed(&td->buf_state, td->rand_seeds[FIO_RAND_BUF_OFF], use64);
1100 frand_copy(&td->buf_state_prev, &td->buf_state);
1104 * Initializes the ioengine configured for a job, if it has not been done so
1107 int ioengine_load(struct thread_data *td)
1109 if (!td->o.ioengine) {
1110 log_err("fio: internal fault, no IO engine specified\n");
1115 struct ioengine_ops *ops;
1118 /* An engine is loaded, but the requested ioengine
1121 if (!strcmp(td->io_ops->name, td->o.ioengine)) {
1122 /* The right engine is already loaded */
1127 * Name of file and engine may be different, load ops
1128 * for this name and see if they match. If they do, then
1129 * the engine is unchanged.
1131 dlhandle = td->io_ops->dlhandle;
1132 ops = load_ioengine(td);
1136 if (ops == td->io_ops && dlhandle == td->io_ops->dlhandle)
1139 if (dlhandle && dlhandle != td->io_ops->dlhandle)
1142 /* Unload the old engine. */
1146 td->io_ops = load_ioengine(td);
1150 if (td->io_ops->option_struct_size && td->io_ops->options) {
1152 * In cases where td->eo is set, clone it for a child thread.
1153 * This requires that the parent thread has the same ioengine,
1154 * but that requirement must be enforced by the code which
1155 * cloned the thread.
1157 void *origeo = td->eo;
1159 * Otherwise use the default thread options.
1161 if (!origeo && td != &def_thread && def_thread.eo &&
1162 def_thread.io_ops->options == td->io_ops->options)
1163 origeo = def_thread.eo;
1165 options_init(td->io_ops->options);
1166 td->eo = malloc(td->io_ops->option_struct_size);
1168 * Use the default thread as an option template if this uses the
1169 * same options structure and there are non-default options
1173 memcpy(td->eo, origeo, td->io_ops->option_struct_size);
1174 options_mem_dupe(td->io_ops->options, td->eo);
1176 memset(td->eo, 0, td->io_ops->option_struct_size);
1177 fill_default_options(td->eo, td->io_ops->options);
1179 *(struct thread_data **)td->eo = td;
1183 td->io_ops->flags |= FIO_RAWIO;
1185 td_set_ioengine_flags(td);
1189 log_err("fio: failed to load engine\n");
1194 static void init_flags(struct thread_data *td)
1196 struct thread_options *o = &td->o;
1199 if (o->verify_backlog)
1200 td->flags |= TD_F_VER_BACKLOG;
1201 if (o->trim_backlog)
1202 td->flags |= TD_F_TRIM_BACKLOG;
1203 if (o->read_iolog_file)
1204 td->flags |= TD_F_READ_IOLOG;
1205 if (o->refill_buffers)
1206 td->flags |= TD_F_REFILL_BUFFERS;
1208 * Always scramble buffers if asked to
1210 if (o->scramble_buffers && fio_option_is_set(o, scramble_buffers))
1211 td->flags |= TD_F_SCRAMBLE_BUFFERS;
1213 * But also scramble buffers, unless we were explicitly asked
1216 if (o->scramble_buffers && !(o->zero_buffers &&
1217 fio_option_is_set(o, zero_buffers)))
1218 td->flags |= TD_F_SCRAMBLE_BUFFERS;
1219 if (o->verify != VERIFY_NONE)
1220 td->flags |= TD_F_DO_VERIFY;
1222 if (o->verify_async || o->io_submit_mode == IO_MODE_OFFLOAD)
1223 td->flags |= TD_F_NEED_LOCK;
1225 if (o->mem_type == MEM_CUDA_MALLOC)
1226 td->flags &= ~TD_F_SCRAMBLE_BUFFERS;
1228 for (i = 0; i < DDIR_RWDIR_CNT; i++) {
1229 if (option_check_rate(td, i)) {
1230 td->flags |= TD_F_CHECK_RATE;
1236 static int setup_random_seeds(struct thread_data *td)
1241 if (!td->o.rand_repeatable && !fio_option_is_set(&td->o, rand_seed)) {
1242 int ret = init_random_seeds(td->rand_seeds, sizeof(td->rand_seeds));
1244 td_fill_rand_seeds(td);
1248 seed = td->o.rand_seed;
1249 for (i = 0; i < 4; i++)
1250 seed *= 0x9e370001UL;
1252 for (i = 0; i < FIO_RAND_NR_OFFS; i++) {
1253 td->rand_seeds[i] = seed * td->thread_number + i;
1254 seed *= 0x9e370001UL;
1257 td_fill_rand_seeds(td);
1269 static struct fpre_keyword {
1270 const char *keyword;
1273 } fpre_keywords[] = {
1274 { .keyword = "$jobname", .key = FPRE_JOBNAME, },
1275 { .keyword = "$jobnum", .key = FPRE_JOBNUM, },
1276 { .keyword = "$filenum", .key = FPRE_FILENUM, },
1277 { .keyword = "$clientuid", .key = FPRE_CLIENTUID, },
1278 { .keyword = NULL, },
1281 static char *make_filename(char *buf, size_t buf_size,struct thread_options *o,
1282 const char *jobname, int jobnum, int filenum)
1284 struct fpre_keyword *f;
1285 char copy[PATH_MAX];
1286 size_t dst_left = PATH_MAX - 1;
1288 if (!o->filename_format || !strlen(o->filename_format)) {
1289 sprintf(buf, "%s.%d.%d", jobname, jobnum, filenum);
1293 for (f = &fpre_keywords[0]; f->keyword; f++)
1294 f->strlen = strlen(f->keyword);
1296 snprintf(buf, buf_size, "%s", o->filename_format);
1298 memset(copy, 0, sizeof(copy));
1299 for (f = &fpre_keywords[0]; f->keyword; f++) {
1301 size_t pre_len, post_start = 0;
1302 char *str, *dst = copy;
1304 str = strcasestr(buf, f->keyword);
1308 pre_len = str - buf;
1309 if (strlen(str) != f->strlen)
1310 post_start = pre_len + f->strlen;
1313 strncpy(dst, buf, pre_len);
1315 dst_left -= pre_len;
1319 case FPRE_JOBNAME: {
1322 ret = snprintf(dst, dst_left, "%s", jobname);
1325 else if (ret > dst_left) {
1326 log_err("fio: truncated filename\n");
1338 ret = snprintf(dst, dst_left, "%d", jobnum);
1341 else if (ret > dst_left) {
1342 log_err("fio: truncated filename\n");
1351 case FPRE_FILENUM: {
1354 ret = snprintf(dst, dst_left, "%d", filenum);
1357 else if (ret > dst_left) {
1358 log_err("fio: truncated filename\n");
1367 case FPRE_CLIENTUID: {
1369 ret = snprintf(dst, dst_left, "%s", client_sockaddr_str);
1372 else if (ret > dst_left) {
1373 log_err("fio: truncated filename\n");
1388 strncpy(dst, buf + post_start, dst_left);
1390 snprintf(buf, buf_size, "%s", copy);
1397 bool parse_dryrun(void)
1399 return dump_cmdline || parse_only;
1402 static void gen_log_name(char *name, size_t size, const char *logtype,
1403 const char *logname, unsigned int num,
1404 const char *suf, int per_job)
1407 snprintf(name, size, "%s_%s.%d.%s", logname, logtype, num, suf);
1409 snprintf(name, size, "%s_%s.%s", logname, logtype, suf);
1412 static int check_waitees(char *waitee)
1414 struct thread_data *td;
1417 for_each_td(td, i) {
1418 if (td->subjob_number)
1421 ret += !strcmp(td->o.name, waitee);
1427 static bool wait_for_ok(const char *jobname, struct thread_options *o)
1434 if (!strcmp(jobname, o->wait_for)) {
1435 log_err("%s: a job cannot wait for itself (wait_for=%s).\n",
1436 jobname, o->wait_for);
1440 if (!(nw = check_waitees(o->wait_for))) {
1441 log_err("%s: waitee job %s unknown.\n", jobname, o->wait_for);
1446 log_err("%s: multiple waitees %s found,\n"
1447 "please avoid duplicates when using wait_for option.\n",
1448 jobname, o->wait_for);
1455 static int verify_per_group_options(struct thread_data *td, const char *jobname)
1457 struct thread_data *td2;
1460 for_each_td(td2, i) {
1461 if (td->groupid != td2->groupid)
1465 td->o.lat_percentiles != td2->o.lat_percentiles) {
1466 log_err("fio: lat_percentiles in job: %s differs from group\n",
1476 * Treat an empty log file name the same as a one not given
1478 static const char *make_log_name(const char *logname, const char *jobname)
1480 if (logname && strcmp(logname, ""))
1487 * Adds a job to the list of things todo. Sanitizes the various options
1488 * to make sure we don't have conflicts, and initializes various
1491 static int add_job(struct thread_data *td, const char *jobname, int job_add_num,
1492 int recursed, int client_type)
1495 char fname[PATH_MAX + 1];
1496 int numjobs, file_alloced;
1497 struct thread_options *o = &td->o;
1498 char logname[PATH_MAX + 32];
1501 * the def_thread is just for options, it's not a real job
1503 if (td == &def_thread)
1509 * if we are just dumping the output command line, don't add the job
1511 if (parse_dryrun()) {
1516 td->client_type = client_type;
1518 if (profile_td_init(td))
1521 if (ioengine_load(td))
1525 if (!o->filename && !td->files_index && !o->read_iolog_file) {
1528 if (o->nr_files == 1 && exists_and_not_regfile(jobname))
1529 add_file(td, jobname, job_add_num, 0);
1531 for (i = 0; i < o->nr_files; i++)
1532 add_file(td, make_filename(fname, sizeof(fname), o, jobname, job_add_num, i), job_add_num, 0);
1536 if (setup_random_seeds(td)) {
1537 td_verror(td, errno, "setup_random_seeds");
1541 if (fixup_options(td))
1544 if (!td->o.dedupe_global && init_dedupe_working_set_seeds(td, 0))
1548 * Belongs to fixup_options, but o->name is not necessarily set as yet
1550 if (!wait_for_ok(jobname, o))
1556 * IO engines only need this for option callbacks, and the address may
1557 * change in subprocesses.
1560 *(struct thread_data **)td->eo = NULL;
1562 if (td_ioengine_flagged(td, FIO_DISKLESSIO)) {
1565 for_each_file(td, f, i)
1566 f->real_file_size = -1ULL;
1569 td->sem = fio_sem_init(FIO_SEM_LOCKED);
1571 td->ts.clat_percentiles = o->clat_percentiles;
1572 td->ts.lat_percentiles = o->lat_percentiles;
1573 td->ts.slat_percentiles = o->slat_percentiles;
1574 td->ts.percentile_precision = o->percentile_precision;
1575 memcpy(td->ts.percentile_list, o->percentile_list, sizeof(o->percentile_list));
1576 td->ts.sig_figs = o->sig_figs;
1578 init_thread_stat_min_vals(&td->ts);
1581 * td->>ddir_seq_nr needs to be initialized to 1, NOT o->ddir_seq_nr,
1582 * so that get_next_offset gets a new random offset the first time it
1583 * is called, instead of keeping an initial offset of 0 for the first
1586 td->ddir_seq_nr = 1;
1588 if ((o->stonewall || o->new_group) && prev_group_jobs) {
1589 prev_group_jobs = 0;
1591 if (groupid == INT_MAX) {
1592 log_err("fio: too many groups defined\n");
1597 td->groupid = groupid;
1600 if (td->o.group_reporting && prev_group_jobs > 1 &&
1601 verify_per_group_options(td, jobname))
1607 if (o->write_lat_log) {
1608 struct log_params p = {
1610 .avg_msec = o->log_avg_msec,
1611 .hist_msec = o->log_hist_msec,
1612 .hist_coarseness = o->log_hist_coarseness,
1613 .log_type = IO_LOG_TYPE_LAT,
1614 .log_offset = o->log_offset,
1615 .log_prio = o->log_prio,
1616 .log_gz = o->log_gz,
1617 .log_gz_store = o->log_gz_store,
1619 const char *pre = make_log_name(o->lat_log_file, o->name);
1627 if (!o->disable_lat) {
1628 gen_log_name(logname, sizeof(logname), "lat", pre,
1629 td->thread_number, suf, o->per_job_logs);
1630 setup_log(&td->lat_log, &p, logname);
1633 if (!o->disable_slat) {
1634 gen_log_name(logname, sizeof(logname), "slat", pre,
1635 td->thread_number, suf, o->per_job_logs);
1636 setup_log(&td->slat_log, &p, logname);
1639 if (!o->disable_clat) {
1640 gen_log_name(logname, sizeof(logname), "clat", pre,
1641 td->thread_number, suf, o->per_job_logs);
1642 setup_log(&td->clat_log, &p, logname);
1647 if (o->write_hist_log) {
1648 struct log_params p = {
1650 .avg_msec = o->log_avg_msec,
1651 .hist_msec = o->log_hist_msec,
1652 .hist_coarseness = o->log_hist_coarseness,
1653 .log_type = IO_LOG_TYPE_HIST,
1654 .log_offset = o->log_offset,
1655 .log_prio = o->log_prio,
1656 .log_gz = o->log_gz,
1657 .log_gz_store = o->log_gz_store,
1659 const char *pre = make_log_name(o->hist_log_file, o->name);
1663 if (td->client_type) {
1664 log_err("fio: --write_hist_log requires zlib in client/server mode\n");
1674 gen_log_name(logname, sizeof(logname), "clat_hist", pre,
1675 td->thread_number, suf, o->per_job_logs);
1676 setup_log(&td->clat_hist_log, &p, logname);
1679 if (o->write_bw_log) {
1680 struct log_params p = {
1682 .avg_msec = o->log_avg_msec,
1683 .hist_msec = o->log_hist_msec,
1684 .hist_coarseness = o->log_hist_coarseness,
1685 .log_type = IO_LOG_TYPE_BW,
1686 .log_offset = o->log_offset,
1687 .log_prio = o->log_prio,
1688 .log_gz = o->log_gz,
1689 .log_gz_store = o->log_gz_store,
1691 const char *pre = make_log_name(o->bw_log_file, o->name);
1694 if (fio_option_is_set(o, bw_avg_time))
1695 p.avg_msec = min(o->log_avg_msec, o->bw_avg_time);
1697 o->bw_avg_time = p.avg_msec;
1699 p.hist_msec = o->log_hist_msec;
1700 p.hist_coarseness = o->log_hist_coarseness;
1707 gen_log_name(logname, sizeof(logname), "bw", pre,
1708 td->thread_number, suf, o->per_job_logs);
1709 setup_log(&td->bw_log, &p, logname);
1711 if (o->write_iops_log) {
1712 struct log_params p = {
1714 .avg_msec = o->log_avg_msec,
1715 .hist_msec = o->log_hist_msec,
1716 .hist_coarseness = o->log_hist_coarseness,
1717 .log_type = IO_LOG_TYPE_IOPS,
1718 .log_offset = o->log_offset,
1719 .log_prio = o->log_prio,
1720 .log_gz = o->log_gz,
1721 .log_gz_store = o->log_gz_store,
1723 const char *pre = make_log_name(o->iops_log_file, o->name);
1726 if (fio_option_is_set(o, iops_avg_time))
1727 p.avg_msec = min(o->log_avg_msec, o->iops_avg_time);
1729 o->iops_avg_time = p.avg_msec;
1731 p.hist_msec = o->log_hist_msec;
1732 p.hist_coarseness = o->log_hist_coarseness;
1739 gen_log_name(logname, sizeof(logname), "iops", pre,
1740 td->thread_number, suf, o->per_job_logs);
1741 setup_log(&td->iops_log, &p, logname);
1745 o->name = strdup(jobname);
1747 if (output_format & FIO_OUTPUT_NORMAL) {
1749 if (is_backend && !recursed)
1750 fio_server_send_add_job(td);
1752 if (!td_ioengine_flagged(td, FIO_NOIO)) {
1753 char *c1, *c2, *c3, *c4;
1754 char *c5 = NULL, *c6 = NULL;
1755 int i2p = is_power_of_2(o->kb_base);
1756 struct buf_output out;
1758 c1 = num2str(o->min_bs[DDIR_READ], o->sig_figs, 1, i2p, N2S_BYTE);
1759 c2 = num2str(o->max_bs[DDIR_READ], o->sig_figs, 1, i2p, N2S_BYTE);
1760 c3 = num2str(o->min_bs[DDIR_WRITE], o->sig_figs, 1, i2p, N2S_BYTE);
1761 c4 = num2str(o->max_bs[DDIR_WRITE], o->sig_figs, 1, i2p, N2S_BYTE);
1763 if (!o->bs_is_seq_rand) {
1764 c5 = num2str(o->min_bs[DDIR_TRIM], o->sig_figs, 1, i2p, N2S_BYTE);
1765 c6 = num2str(o->max_bs[DDIR_TRIM], o->sig_figs, 1, i2p, N2S_BYTE);
1768 buf_output_init(&out);
1769 __log_buf(&out, "%s: (g=%d): rw=%s, ", td->o.name,
1771 ddir_str(o->td_ddir));
1773 if (o->bs_is_seq_rand)
1774 __log_buf(&out, "bs=(R) %s-%s, (W) %s-%s, bs_is_seq_rand, ",
1777 __log_buf(&out, "bs=(R) %s-%s, (W) %s-%s, (T) %s-%s, ",
1778 c1, c2, c3, c4, c5, c6);
1780 __log_buf(&out, "ioengine=%s, iodepth=%u\n",
1781 td->io_ops->name, o->iodepth);
1782 log_info_buf(out.buf, out.buflen);
1783 buf_output_free(&out);
1792 } else if (job_add_num == 1)
1796 if (td_steadystate_init(td))
1799 if (o->merge_blktrace_file && !merge_blktrace_iologs(td))
1802 if (merge_blktrace_only) {
1808 * recurse add identical jobs, clear numjobs and stonewall options
1809 * as they don't apply to sub-jobs
1811 numjobs = o->numjobs;
1813 struct thread_data *td_new = get_new_job(false, td, true, jobname);
1818 td_new->o.numjobs = 1;
1819 td_new->o.stonewall = 0;
1820 td_new->o.new_group = 0;
1821 td_new->subjob_number = numjobs;
1822 td_new->o.ss_dur = o->ss_dur * 1000000l;
1823 td_new->o.ss_limit = o->ss_limit;
1826 if (td_new->files) {
1828 for_each_file(td_new, f, i)
1830 free(td_new->files);
1831 td_new->files = NULL;
1833 td_new->files_index = 0;
1834 td_new->files_size = 0;
1835 if (td_new->o.filename) {
1836 free(td_new->o.filename);
1837 td_new->o.filename = NULL;
1841 if (add_job(td_new, jobname, numjobs, 1, client_type))
1852 * Parse as if 'o' was a command line
1854 void add_job_opts(const char **o, int client_type)
1856 struct thread_data *td, *td_parent;
1857 int i, in_global = 1;
1861 td_parent = td = NULL;
1863 if (!strncmp(o[i], "name", 4)) {
1866 add_job(td, jobname, 0, 0, client_type);
1868 sprintf(jobname, "%s", o[i] + 5);
1870 if (in_global && !td_parent)
1871 td_parent = get_new_job(true, &def_thread, false, jobname);
1872 else if (!in_global && !td) {
1874 td_parent = &def_thread;
1875 td = get_new_job(false, td_parent, false, jobname);
1878 fio_options_parse(td_parent, (char **) &o[i], 1);
1880 fio_options_parse(td, (char **) &o[i], 1);
1885 add_job(td, jobname, 0, 0, client_type);
1888 static int skip_this_section(const char *name)
1892 if (!nr_job_sections)
1894 if (!strncmp(name, "global", 6))
1897 for (i = 0; i < nr_job_sections; i++)
1898 if (!strcmp(job_sections[i], name))
1904 static int is_empty_or_comment(char *line)
1908 for (i = 0; i < strlen(line); i++) {
1913 if (!isspace((int) line[i]) && !iscntrl((int) line[i]))
1921 * This is our [ini] type file parser.
1923 static int __parse_jobs_ini(struct thread_data *td,
1924 char *file, int is_buf, int stonewall_flag, int type,
1925 int nested, char *name, char ***popts, int *aopts, int *nopts)
1927 bool global = false;
1928 bool stdin_occupied = false;
1932 int ret = 0, stonewall;
1935 int inside_skip = 0;
1937 int i, alloc_opts, num_opts;
1939 dprint(FD_PARSE, "Parsing ini file %s\n", file);
1940 assert(td || !nested);
1945 if (!strcmp(file, "-")) {
1947 stdin_occupied = true;
1949 f = fopen(file, "r");
1954 log_err("fio: unable to open '%s' job file\n", file);
1956 td_verror(td, __err, "job file open");
1961 string = malloc(OPT_LEN_MAX);
1964 * it's really 256 + small bit, 280 should suffice
1968 memset(name, 0, 280);
1972 if (nested && popts) {
1974 alloc_opts = *aopts;
1980 opts = malloc(sizeof(char *) * alloc_opts);
1984 stonewall = stonewall_flag;
1987 * if skip_fgets is set, we already have loaded a line we
1992 p = strsep(&file, "\n");
1994 p = fgets(string, OPT_LEN_MAX, f);
2000 strip_blank_front(&p);
2003 dprint(FD_PARSE, "%s\n", p);
2004 if (is_empty_or_comment(p))
2008 if (sscanf(p, "[%255[^\n]]", name) != 1) {
2012 log_err("fio: option <%s> outside of "
2013 "[] job section\n", p);
2018 name[strlen(name) - 1] = '\0';
2020 if (skip_this_section(name)) {
2026 dprint(FD_PARSE, "Parsing section [%s]\n", name);
2028 global = !strncmp(name, "global", 6);
2034 log_info("--name=%s ", name);
2038 td = get_new_job(global, &def_thread, false, name);
2045 * Separate multiple job files by a stonewall
2047 if (!global && stonewall) {
2048 td->o.stonewall = stonewall;
2053 memset(opts, 0, alloc_opts * sizeof(char *));
2061 p = strsep(&file, "\n");
2063 p = fgets(string, OPT_LEN_MAX, f);
2066 dprint(FD_PARSE, "%s", p);
2071 if (is_empty_or_comment(p))
2074 strip_blank_front(&p);
2077 * new section, break out and make sure we don't
2078 * fgets() a new line at the top.
2082 log_err("No new sections in included files\n");
2093 if (!strncmp(p, "include", strlen("include"))) {
2094 char *filename = p + strlen("include") + 1,
2095 *ts, *full_fn = NULL;
2098 * Allow for the include filename
2099 * specification to be relative.
2101 if (access(filename, F_OK) &&
2102 (ts = strrchr(file, '/'))) {
2103 if (asprintf(&full_fn, "%.*s%s",
2104 (int)(ts - file + 1), file,
2112 ret = __parse_jobs_ini(td, filename, is_buf,
2113 stonewall_flag, type, 1,
2115 &alloc_opts, &num_opts);
2118 log_err("Error %d while parsing "
2119 "include file %s\n",
2132 if (num_opts == alloc_opts) {
2134 opts = realloc(opts,
2135 alloc_opts * sizeof(char *));
2138 opts[num_opts] = strdup(p);
2144 *aopts = alloc_opts;
2149 ret = fio_options_parse(td, opts, num_opts);
2151 if (!ret && td->o.read_iolog_file != NULL) {
2152 char *fname = get_name_by_idx(td->o.read_iolog_file,
2154 if (!strcmp(fname, "-")) {
2155 if (stdin_occupied) {
2156 log_err("fio: only one user (read_iolog_file/job "
2157 "file) of stdin is permitted at once but "
2158 "more than one was found.\n");
2161 stdin_occupied = true;
2168 ret = add_job(td, name, 0, 0, type);
2170 log_err("fio: job %s dropped\n", name);
2174 for (i = 0; i < num_opts; i++)
2183 while (i < nr_job_sections) {
2184 free(job_sections[i]);
2189 job_sections = NULL;
2190 nr_job_sections = 0;
2197 if (!is_buf && f != stdin)
2202 int parse_jobs_ini(char *file, int is_buf, int stonewall_flag, int type)
2204 return __parse_jobs_ini(NULL, file, is_buf, stonewall_flag, type,
2205 0, NULL, NULL, NULL, NULL);
2208 static int fill_def_thread(void)
2210 memset(&def_thread, 0, sizeof(def_thread));
2211 INIT_FLIST_HEAD(&def_thread.opt_list);
2213 fio_getaffinity(getpid(), &def_thread.o.cpumask);
2214 def_thread.o.error_dump = 1;
2217 * fill default options
2219 fio_fill_default_options(&def_thread);
2223 static void show_debug_categories(void)
2225 #ifdef FIO_INC_DEBUG
2226 const struct debug_level *dl = &debug_levels[0];
2227 int curlen, first = 1;
2231 int has_next = (dl + 1)->name != NULL;
2233 if (first || curlen + strlen(dl->name) >= 80) {
2238 curlen += printf("\t\t\t%s", dl->name);
2239 curlen += 3 * (8 - 1);
2241 curlen += printf(",");
2243 curlen += printf("%s", dl->name);
2245 curlen += printf(",");
2255 * Following options aren't printed by usage().
2256 * --append-terse - Equivalent to --output-format=terse, see f6a7df53.
2257 * --latency-log - Deprecated option.
2259 static void usage(const char *name)
2261 printf("%s\n", fio_version_string);
2262 printf("%s [options] [job options] <job file(s)>\n", name);
2263 printf(" --debug=options\tEnable debug logging. May be one/more of:\n");
2264 show_debug_categories();
2265 printf(" --parse-only\t\tParse options only, don't start any IO\n");
2266 printf(" --merge-blktrace-only\tMerge blktraces only, don't start any IO\n");
2267 printf(" --output\t\tWrite output to file\n");
2268 printf(" --bandwidth-log\tGenerate aggregate bandwidth logs\n");
2269 printf(" --minimal\t\tMinimal (terse) output\n");
2270 printf(" --output-format=type\tOutput format (terse,json,json+,normal)\n");
2271 printf(" --terse-version=type\tSet terse version output format"
2272 " (default 3, or 2 or 4 or 5)\n");
2273 printf(" --version\t\tPrint version info and exit\n");
2274 printf(" --help\t\tPrint this page\n");
2275 printf(" --cpuclock-test\tPerform test/validation of CPU clock\n");
2276 printf(" --crctest=[type]\tTest speed of checksum functions\n");
2277 printf(" --cmdhelp=cmd\t\tPrint command help, \"all\" for all of"
2279 printf(" --enghelp=engine\tPrint ioengine help, or list"
2280 " available ioengines\n");
2281 printf(" --enghelp=engine,cmd\tPrint help for an ioengine"
2283 printf(" --showcmd\t\tTurn a job file into command line options\n");
2284 printf(" --eta=when\t\tWhen ETA estimate should be printed\n");
2285 printf(" \t\tMay be \"always\", \"never\" or \"auto\"\n");
2286 printf(" --eta-newline=t\tForce a new line for every 't'");
2287 printf(" period passed\n");
2288 printf(" --status-interval=t\tForce full status dump every");
2289 printf(" 't' period passed\n");
2290 printf(" --readonly\t\tTurn on safety read-only checks, preventing"
2292 printf(" --section=name\tOnly run specified section in job file,"
2293 " multiple sections can be specified\n");
2294 printf(" --alloc-size=kb\tSet smalloc pool to this size in kb"
2296 printf(" --warnings-fatal\tFio parser warnings are fatal\n");
2297 printf(" --max-jobs=nr\t\tMaximum number of threads/processes to support\n");
2298 printf(" --server=args\t\tStart a backend fio server\n");
2299 printf(" --daemonize=pidfile\tBackground fio server, write pid to file\n");
2300 printf(" --client=hostname\tTalk to remote backend(s) fio server at hostname\n");
2301 printf(" --remote-config=file\tTell fio server to load this local job file\n");
2302 printf(" --idle-prof=option\tReport cpu idleness on a system or percpu basis\n"
2303 "\t\t\t(option=system,percpu) or run unit work\n"
2304 "\t\t\tcalibration only (option=calibrate)\n");
2306 printf(" --inflate-log=log\tInflate and output compressed log\n");
2308 printf(" --trigger-file=file\tExecute trigger cmd when file exists\n");
2309 printf(" --trigger-timeout=t\tExecute trigger at this time\n");
2310 printf(" --trigger=cmd\t\tSet this command as local trigger\n");
2311 printf(" --trigger-remote=cmd\tSet this command as remote trigger\n");
2312 printf(" --aux-path=path\tUse this path for fio state generated files\n");
2313 printf("\nFio was written by Jens Axboe <axboe@kernel.dk>\n");
2316 #ifdef FIO_INC_DEBUG
2317 const struct debug_level debug_levels[] = {
2318 { .name = "process",
2319 .help = "Process creation/exit logging",
2320 .shift = FD_PROCESS,
2323 .help = "File related action logging",
2327 .help = "IO and IO engine action logging (offsets, queue, completions, etc)",
2331 .help = "Memory allocation/freeing logging",
2334 { .name = "blktrace",
2335 .help = "blktrace action logging",
2336 .shift = FD_BLKTRACE,
2339 .help = "IO verification action logging",
2343 .help = "Random generation logging",
2347 .help = "Parser logging",
2350 { .name = "diskutil",
2351 .help = "Disk utility logging actions",
2352 .shift = FD_DISKUTIL,
2355 .help = "Logging related to creating/destroying jobs",
2359 .help = "Mutex logging",
2362 { .name = "profile",
2363 .help = "Logging related to profiles",
2364 .shift = FD_PROFILE,
2367 .help = "Logging related to time keeping functions",
2371 .help = "Network logging",
2375 .help = "Rate logging",
2378 { .name = "compress",
2379 .help = "Log compression logging",
2380 .shift = FD_COMPRESS,
2382 { .name = "steadystate",
2383 .help = "Steady state detection logging",
2384 .shift = FD_STEADYSTATE,
2386 { .name = "helperthread",
2387 .help = "Helper thread logging",
2388 .shift = FD_HELPERTHREAD,
2391 .help = "Zoned Block Device logging",
2397 static int set_debug(const char *string)
2399 const struct debug_level *dl;
2400 char *p = (char *) string;
2407 if (!strcmp(string, "?") || !strcmp(string, "help")) {
2408 log_info("fio: dumping debug options:");
2409 for (i = 0; debug_levels[i].name; i++) {
2410 dl = &debug_levels[i];
2411 log_info("%s,", dl->name);
2417 while ((opt = strsep(&p, ",")) != NULL) {
2420 if (!strncmp(opt, "all", 3)) {
2421 log_info("fio: set all debug options\n");
2426 for (i = 0; debug_levels[i].name; i++) {
2427 dl = &debug_levels[i];
2428 found = !strncmp(opt, dl->name, strlen(dl->name));
2432 if (dl->shift == FD_JOB) {
2433 opt = strchr(opt, ':');
2435 log_err("fio: missing job number\n");
2439 fio_debug_jobno = atoi(opt);
2440 log_info("fio: set debug jobno %d\n",
2443 log_info("fio: set debug option %s\n", opt);
2444 fio_debug |= (1UL << dl->shift);
2450 log_err("fio: debug mask %s not found\n", opt);
2455 static int set_debug(const char *string)
2457 log_err("fio: debug tracing not included in build\n");
2462 static void fio_options_fill_optstring(void)
2464 char *ostr = cmd_optstr;
2468 while (l_opts[i].name) {
2469 ostr[c++] = l_opts[i].val;
2470 if (l_opts[i].has_arg == required_argument)
2472 else if (l_opts[i].has_arg == optional_argument) {
2481 static int client_flag_set(char c)
2486 while (l_opts[i].name) {
2487 int val = l_opts[i].val;
2489 if (c == (val & 0xff))
2490 return (val & FIO_CLIENT_FLAG);
2498 static void parse_cmd_client(void *client, char *opt)
2500 fio_client_add_cmd_option(client, opt);
2503 static void show_closest_option(const char *name)
2505 int best_option, best_distance;
2508 while (*name == '-')
2512 best_distance = INT_MAX;
2514 while (l_opts[i].name) {
2515 distance = string_distance(name, l_opts[i].name);
2516 if (distance < best_distance) {
2517 best_distance = distance;
2523 if (best_option != -1 && string_distance_ok(name, best_distance))
2524 log_err("Did you mean %s?\n", l_opts[best_option].name);
2527 static int parse_output_format(const char *optarg)
2529 char *p, *orig, *opt;
2532 p = orig = strdup(optarg);
2536 while ((opt = strsep(&p, ",")) != NULL) {
2537 if (!strcmp(opt, "minimal") ||
2538 !strcmp(opt, "terse") ||
2539 !strcmp(opt, "csv"))
2540 output_format |= FIO_OUTPUT_TERSE;
2541 else if (!strcmp(opt, "json"))
2542 output_format |= FIO_OUTPUT_JSON;
2543 else if (!strcmp(opt, "json+"))
2544 output_format |= (FIO_OUTPUT_JSON | FIO_OUTPUT_JSON_PLUS);
2545 else if (!strcmp(opt, "normal"))
2546 output_format |= FIO_OUTPUT_NORMAL;
2548 log_err("fio: invalid output format %s\n", opt);
2558 int parse_cmd_line(int argc, char *argv[], int client_type)
2560 struct thread_data *td = NULL;
2561 int c, ini_idx = 0, lidx, ret = 0, do_exit = 0, exit_val = 0;
2562 char *ostr = cmd_optstr;
2563 char *pid_file = NULL;
2564 void *cur_client = NULL;
2565 bool backend = false;
2568 * Reset optind handling, since we may call this multiple times
2573 while ((c = getopt_long_only(argc, argv, ostr, l_opts, &lidx)) != -1) {
2574 if ((c & FIO_CLIENT_FLAG) || client_flag_set(c)) {
2575 parse_cmd_client(cur_client, argv[optind - 1]);
2576 c &= ~FIO_CLIENT_FLAG;
2581 smalloc_pool_size = atoi(optarg);
2582 smalloc_pool_size <<= 10;
2586 log_err("fio: --latency-log is deprecated. Use per-job latency log options.\n");
2591 write_bw_log = true;
2596 if (f_out && f_out != stdout)
2599 tmp = fopen(optarg, "w+");
2601 log_err("fio: output file open error: %s\n", strerror(errno));
2606 f_err = f_out = tmp;
2610 output_format = FIO_OUTPUT_TERSE;
2613 if (parse_output_format(optarg)) {
2614 log_err("fio: failed parsing output-format\n");
2621 output_format |= FIO_OUTPUT_TERSE;
2633 fio_show_option_help(optarg);
2640 exit_val = fio_show_ioengine_help(optarg);
2646 dump_cmdline = true;
2654 log_info("%s\n", fio_version_string);
2659 terse_version = atoi(optarg);
2660 if (!(terse_version >= 2 && terse_version <= 5)) {
2661 log_err("fio: bad terse version format\n");
2667 if (!strcmp("always", optarg))
2668 eta_print = FIO_ETA_ALWAYS;
2669 else if (!strcmp("never", optarg))
2670 eta_print = FIO_ETA_NEVER;
2675 if (check_str_time(optarg, &t, 1)) {
2676 log_err("fio: failed parsing eta time %s\n", optarg);
2681 eta_new_line = t / 1000;
2682 if (!eta_new_line) {
2683 log_err("fio: eta new line time too short\n");
2692 if (check_str_time(optarg, &t, 1)) {
2693 log_err("fio: failed parsing eta interval %s\n", optarg);
2698 eta_interval_msec = t / 1000;
2699 if (eta_interval_msec < DISK_UTIL_MSEC) {
2700 log_err("fio: eta interval time too short (%umsec min)\n", DISK_UTIL_MSEC);
2707 if (set_debug(optarg))
2717 if (!strcmp(optarg, "global")) {
2718 log_err("fio: can't use global as only "
2724 new_size = (nr_job_sections + 1) * sizeof(char *);
2725 job_sections = realloc(job_sections, new_size);
2726 job_sections[nr_job_sections] = strdup(optarg);
2732 exit_val = iolog_file_inflate(optarg);
2741 exec_profile = strdup(optarg);
2743 case FIO_GETOPT_JOB: {
2744 const char *opt = l_opts[lidx].name;
2747 if (!strncmp(opt, "name", 4) && td) {
2748 ret = add_job(td, td->o.name ?: "fio", 0, 0, client_type);
2755 int is_section = !strncmp(opt, "name", 4);
2758 if (!is_section || !strncmp(val, "global", 6))
2761 if (is_section && skip_this_section(val))
2764 td = get_new_job(global, &def_thread, true, NULL);
2765 if (!td || ioengine_load(td)) {
2774 fio_options_set_ioengine_opts(l_opts, td);
2777 if ((!val || !strlen(val)) &&
2778 l_opts[lidx].has_arg == required_argument) {
2779 log_err("fio: option %s requires an argument\n", opt);
2782 ret = fio_cmd_option_parse(td, opt, val);
2793 if (!ret && !strcmp(opt, "ioengine")) {
2794 if (ioengine_load(td)) {
2801 fio_options_set_ioengine_opts(l_opts, td);
2805 case FIO_GETOPT_IOENGINE: {
2806 const char *opt = l_opts[lidx].name;
2812 ret = fio_cmd_ioengine_option_parse(td, opt, val);
2828 /* we don't track/need this anymore, ignore it */
2832 #ifndef CONFIG_NO_SHM
2834 log_err("fio: can't be both client and server\n");
2840 fio_server_set_arg(optarg);
2844 log_err("fio: client/server requires SHM support\n");
2852 fio_server_internal_set(optarg);
2858 pid_file = strdup(optarg);
2861 if ((ret = fio_idle_prof_parse_opt(optarg))) {
2862 /* exit on error and calibration only */
2872 log_err("fio: can't be both client and server\n");
2877 /* if --client parameter contains a pathname */
2878 if (0 == access(optarg, R_OK)) {
2879 /* file contains a list of host addrs or names */
2880 char hostaddr[PATH_MAX] = {0};
2882 FILE * hostf = fopen(optarg, "r");
2884 log_err("fio: could not open client list file %s for read\n", optarg);
2889 sprintf(formatstr, "%%%ds", PATH_MAX - 1);
2891 * read at most PATH_MAX-1 chars from each
2892 * record in this file
2894 while (fscanf(hostf, formatstr, hostaddr) == 1) {
2895 /* expect EVERY host in file to be valid */
2896 if (fio_client_add(&fio_client_ops, hostaddr, &cur_client)) {
2897 log_err("fio: failed adding client %s from file %s\n", hostaddr, optarg);
2904 break; /* no possibility of job file for "this client only" */
2906 if (fio_client_add(&fio_client_ops, optarg, &cur_client)) {
2907 log_err("fio: failed adding client %s\n", optarg);
2913 * If the next argument exists and isn't an option,
2914 * assume it's a job file for this client only.
2916 while (optind < argc) {
2917 if (!strncmp(argv[optind], "--", 2) ||
2918 !strncmp(argv[optind], "-", 1))
2921 if (fio_client_add_ini_file(cur_client, argv[optind], false))
2928 if (fio_client_add_ini_file(cur_client, optarg, true)) {
2936 exit_val = fio_monotonic_clocktest(1);
2941 exit_val = fio_crctest(optarg);
2946 exit_val = fio_memcpy_test(optarg);
2951 if (check_str_time(optarg, &val, 1)) {
2952 log_err("fio: failed parsing time %s\n", optarg);
2958 log_err("fio: status interval too small\n");
2962 status_interval = val / 1000;
2968 trigger_file = strdup(optarg);
2973 trigger_cmd = strdup(optarg);
2976 if (trigger_remote_cmd)
2977 free(trigger_remote_cmd);
2978 trigger_remote_cmd = strdup(optarg);
2983 aux_path = strdup(optarg);
2986 if (check_str_time(optarg, &trigger_timeout, 1)) {
2987 log_err("fio: failed parsing time %s\n", optarg);
2991 trigger_timeout /= 1000000;
2996 merge_blktrace_only = true;
2999 log_err("%s: unrecognized option '%s'\n", argv[0],
3001 show_closest_option(argv[optind - 1]);
3012 if (do_exit && !(is_backend || nr_clients))
3015 if (nr_clients && fio_clients_connect())
3018 if (is_backend && backend)
3019 return fio_start_server(pid_file);
3025 ret = add_job(td, td->o.name ?: "fio", 0, 0, client_type);
3031 while (!ret && optind < argc) {
3033 ini_file = realloc(ini_file, ini_idx * sizeof(char *));
3034 ini_file[ini_idx - 1] = strdup(argv[optind]);
3042 int fio_init_options(void)
3047 fio_options_fill_optstring();
3048 fio_options_dup_and_init(l_opts);
3052 if (fill_def_thread())
3058 extern int fio_check_options(struct thread_options *);
3060 int parse_options(int argc, char *argv[])
3062 const int type = FIO_CLIENT_TYPE_CLI;
3065 if (fio_init_options())
3067 if (fio_test_cconv(&def_thread.o))
3068 log_err("fio: failed internal cconv test\n");
3070 job_files = parse_cmd_line(argc, argv, type);
3072 if (job_files > 0) {
3073 for (i = 0; i < job_files; i++) {
3074 if (i && fill_def_thread())
3077 if (fio_clients_send_ini(ini_file[i]))
3080 } else if (!is_backend) {
3081 if (parse_jobs_ini(ini_file[i], 0, i, type))
3086 } else if (nr_clients) {
3087 if (fill_def_thread())
3089 if (fio_clients_send_ini(NULL))
3094 fio_options_free(&def_thread);
3095 filesetup_mem_free();
3097 if (!thread_number) {
3102 if (is_backend || nr_clients)
3107 log_err("No job(s) defined\n\n");
3112 if (output_format & FIO_OUTPUT_NORMAL)
3113 log_info("%s\n", fio_version_string);
3118 void options_default_fill(struct thread_options *o)
3120 memcpy(o, &def_thread.o, sizeof(*o));
3123 struct thread_data *get_global_options(void)