2 * This file contains job initialization and setup functions.
11 #include <sys/types.h>
13 #ifdef CONFIG_VALGRIND_DEV
14 #include <valgrind/drd.h>
16 #define DRD_IGNORE_VAR(x) do { } while (0)
20 #ifndef FIO_NO_HAVE_SHM_H
32 #include "steadystate.h"
35 #include "oslib/asprintf.h"
36 #include "oslib/getopt.h"
37 #include "oslib/strcasestr.h"
41 #include "lib/memcpy.h"
43 const char fio_version_string[] = FIO_VERSION;
45 #define FIO_RANDSEED (0xb1899bedUL)
47 static char **ini_file;
48 static int max_jobs = FIO_MAX_JOBS;
49 static bool dump_cmdline;
50 static bool parse_only;
51 static bool merge_blktrace_only;
53 static struct thread_data def_thread;
54 struct thread_segment segments[REAL_MAX_SEG];
55 static char **job_sections;
56 static int nr_job_sections;
58 bool exitall_on_terminate = false;
59 int output_format = FIO_OUTPUT_NORMAL;
60 int eta_print = FIO_ETA_AUTO;
61 unsigned int eta_interval_msec = 1000;
65 char *exec_profile = NULL;
66 int warnings_fatal = 0;
67 int terse_version = 3;
68 bool is_backend = false;
69 bool is_local_backend = false;
71 bool log_syslog = false;
73 bool write_bw_log = false;
74 bool read_only = false;
75 int status_interval = 0;
77 char *trigger_file = NULL;
78 long long trigger_timeout = 0;
79 char *trigger_cmd = NULL;
80 char *trigger_remote_cmd = NULL;
82 char *aux_path = NULL;
84 static int prev_group_jobs;
86 unsigned long fio_debug = 0;
87 unsigned int fio_debug_jobno = -1;
88 unsigned int *fio_debug_jobp = NULL;
89 unsigned int *fio_warned = NULL;
91 static char cmd_optstr[256];
94 #define FIO_CLIENT_FLAG (1 << 16)
97 * Command line options. These will contain the above, plus a few
98 * extra that only pertain to fio itself and not jobs.
100 static struct option l_opts[FIO_NR_OPTIONS] = {
102 .name = (char *) "output",
103 .has_arg = required_argument,
104 .val = 'o' | FIO_CLIENT_FLAG,
107 .name = (char *) "latency-log",
108 .has_arg = required_argument,
109 .val = 'l' | FIO_CLIENT_FLAG,
112 .name = (char *) "bandwidth-log",
113 .has_arg = no_argument,
114 .val = 'b' | FIO_CLIENT_FLAG,
117 .name = (char *) "minimal",
118 .has_arg = no_argument,
119 .val = 'm' | FIO_CLIENT_FLAG,
122 .name = (char *) "output-format",
123 .has_arg = required_argument,
124 .val = 'F' | FIO_CLIENT_FLAG,
127 .name = (char *) "append-terse",
128 .has_arg = optional_argument,
132 .name = (char *) "version",
133 .has_arg = no_argument,
134 .val = 'v' | FIO_CLIENT_FLAG,
137 .name = (char *) "help",
138 .has_arg = no_argument,
139 .val = 'h' | FIO_CLIENT_FLAG,
142 .name = (char *) "cmdhelp",
143 .has_arg = optional_argument,
144 .val = 'c' | FIO_CLIENT_FLAG,
147 .name = (char *) "enghelp",
148 .has_arg = optional_argument,
149 .val = 'i' | FIO_CLIENT_FLAG,
152 .name = (char *) "showcmd",
153 .has_arg = no_argument,
154 .val = 's' | FIO_CLIENT_FLAG,
157 .name = (char *) "readonly",
158 .has_arg = no_argument,
159 .val = 'r' | FIO_CLIENT_FLAG,
162 .name = (char *) "eta",
163 .has_arg = required_argument,
164 .val = 'e' | FIO_CLIENT_FLAG,
167 .name = (char *) "eta-interval",
168 .has_arg = required_argument,
169 .val = 'O' | FIO_CLIENT_FLAG,
172 .name = (char *) "eta-newline",
173 .has_arg = required_argument,
174 .val = 'E' | FIO_CLIENT_FLAG,
177 .name = (char *) "debug",
178 .has_arg = required_argument,
179 .val = 'd' | FIO_CLIENT_FLAG,
182 .name = (char *) "parse-only",
183 .has_arg = no_argument,
184 .val = 'P' | FIO_CLIENT_FLAG,
187 .name = (char *) "section",
188 .has_arg = required_argument,
189 .val = 'x' | FIO_CLIENT_FLAG,
193 .name = (char *) "inflate-log",
194 .has_arg = required_argument,
195 .val = 'X' | FIO_CLIENT_FLAG,
199 .name = (char *) "alloc-size",
200 .has_arg = required_argument,
201 .val = 'a' | FIO_CLIENT_FLAG,
204 .name = (char *) "profile",
205 .has_arg = required_argument,
206 .val = 'p' | FIO_CLIENT_FLAG,
209 .name = (char *) "warnings-fatal",
210 .has_arg = no_argument,
211 .val = 'w' | FIO_CLIENT_FLAG,
214 .name = (char *) "max-jobs",
215 .has_arg = required_argument,
216 .val = 'j' | FIO_CLIENT_FLAG,
219 .name = (char *) "terse-version",
220 .has_arg = required_argument,
221 .val = 'V' | FIO_CLIENT_FLAG,
224 .name = (char *) "server",
225 .has_arg = optional_argument,
228 { .name = (char *) "daemonize",
229 .has_arg = required_argument,
233 .name = (char *) "client",
234 .has_arg = required_argument,
238 .name = (char *) "remote-config",
239 .has_arg = required_argument,
243 .name = (char *) "cpuclock-test",
244 .has_arg = no_argument,
248 .name = (char *) "crctest",
249 .has_arg = optional_argument,
253 .name = (char *) "memcpytest",
254 .has_arg = optional_argument,
258 .name = (char *) "idle-prof",
259 .has_arg = required_argument,
263 .name = (char *) "status-interval",
264 .has_arg = required_argument,
265 .val = 'L' | FIO_CLIENT_FLAG,
268 .name = (char *) "trigger-file",
269 .has_arg = required_argument,
273 .name = (char *) "trigger-timeout",
274 .has_arg = required_argument,
278 .name = (char *) "trigger",
279 .has_arg = required_argument,
283 .name = (char *) "trigger-remote",
284 .has_arg = required_argument,
288 .name = (char *) "aux-path",
289 .has_arg = required_argument,
293 .name = (char *) "merge-blktrace-only",
294 .has_arg = no_argument,
295 .val = 'A' | FIO_CLIENT_FLAG,
302 void free_threads_shm(void)
304 if (segments[0].threads) {
305 void *tp = segments[0].threads;
306 #ifndef CONFIG_NO_SHM
307 struct shmid_ds sbuf;
309 segments[0].threads = NULL;
311 shmctl(segments[0].shm_id, IPC_RMID, &sbuf);
312 segments[0].shm_id = -1;
314 segments[0].threads = NULL;
320 static void free_shm(void)
322 if (segments[0].threads) {
324 fio_debug_jobp = NULL;
331 free(trigger_remote_cmd);
332 trigger_file = trigger_cmd = trigger_remote_cmd = NULL;
334 options_free(fio_options, &def_thread.o);
341 * The thread area is shared between the main process and the job
342 * threads/processes. So setup a shared memory segment that will hold
343 * all the job info. We use the end of the region for keeping track of
344 * open files across jobs, for file sharing.
346 static int setup_thread_area(void)
348 struct thread_segment *seg = &segments[0];
355 * 1024 is too much on some machines, scale max_jobs if
356 * we get a failure that looks like too large a shm segment
359 size_t size = max_jobs * sizeof(struct thread_data);
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)
367 if (errno != EINVAL && errno != ENOMEM && errno != ENOSPC) {
372 seg->threads = malloc(size);
380 #ifndef CONFIG_NO_SHM
381 if (seg->shm_id == -1)
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);
393 memset(seg->threads, 0, max_jobs * sizeof(struct thread_data));
394 for (i = 0; i < max_jobs; i++)
395 DRD_IGNORE_VAR(seg->threads[i]);
396 fio_debug_jobp = (unsigned int *)(seg->threads + max_jobs);
397 *fio_debug_jobp = -1;
398 fio_warned = fio_debug_jobp + 1;
406 static void dump_print_option(struct print_option *p)
410 if (!strcmp("description", p->name))
415 log_info("--%s%s", p->name, p->value ? "" : " ");
417 log_info("=%s%s%s ", delim, p->value, delim);
420 static void dump_opt_list(struct thread_data *td)
422 struct flist_head *entry;
423 struct print_option *p;
425 if (flist_empty(&td->opt_list))
428 flist_for_each(entry, &td->opt_list) {
429 p = flist_entry(entry, struct print_option, list);
430 dump_print_option(p);
434 static void fio_dump_options_free(struct thread_data *td)
436 while (!flist_empty(&td->opt_list)) {
437 struct print_option *p;
439 p = flist_first_entry(&td->opt_list, struct print_option, list);
440 flist_del_init(&p->list);
447 static void copy_opt_list(struct thread_data *dst, struct thread_data *src)
449 struct flist_head *entry;
451 if (flist_empty(&src->opt_list))
454 flist_for_each(entry, &src->opt_list) {
455 struct print_option *srcp, *dstp;
457 srcp = flist_entry(entry, struct print_option, list);
458 dstp = malloc(sizeof(*dstp));
459 dstp->name = strdup(srcp->name);
461 dstp->value = strdup(srcp->value);
464 flist_add_tail(&dstp->list, &dst->opt_list);
469 * Return a free job structure.
471 static struct thread_data *get_new_job(bool global, struct thread_data *parent,
472 bool preserve_eo, const char *jobname)
474 struct thread_data *td;
478 if (setup_thread_area()) {
479 log_err("error: failed to setup shm segment\n");
482 if (thread_number >= max_jobs) {
483 log_err("error: maximum number of jobs (%d) reached.\n",
488 td = &segments[0].threads[thread_number++];
491 INIT_FLIST_HEAD(&td->opt_list);
492 if (parent != &def_thread)
493 copy_opt_list(td, parent);
500 td->o.uid = td->o.gid = -1U;
502 dup_files(td, parent);
503 fio_options_mem_dupe(td);
505 profile_add_hooks(td);
507 td->thread_number = thread_number;
508 td->subjob_number = 0;
511 td->o.name = strdup(jobname);
513 if (!parent->o.group_reporting || parent == &def_thread)
519 static void put_job(struct thread_data *td)
521 if (td == &def_thread)
528 log_info("fio: %s\n", td->verror);
530 fio_options_free(td);
531 fio_dump_options_free(td);
538 memset(td, 0, sizeof(*td));
542 static int __setup_rate(struct thread_data *td, enum fio_ddir ddir)
544 unsigned long long bs = td->o.min_bs[ddir];
546 assert(ddir_rw(ddir));
548 if (td->o.rate[ddir])
549 td->rate_bps[ddir] = td->o.rate[ddir];
551 td->rate_bps[ddir] = (uint64_t) td->o.rate_iops[ddir] * bs;
553 if (!td->rate_bps[ddir]) {
554 log_err("rate lower than supported\n");
558 td->rate_next_io_time[ddir] = 0;
559 td->rate_io_issue_bytes[ddir] = 0;
560 td->last_usec[ddir] = 0;
564 static int setup_rate(struct thread_data *td)
568 for_each_rw_ddir(ddir) {
569 if (td->o.rate[ddir] || td->o.rate_iops[ddir]) {
570 ret |= __setup_rate(td, ddir);
576 static int fixed_block_size(struct thread_options *o)
578 return o->min_bs[DDIR_READ] == o->max_bs[DDIR_READ] &&
579 o->min_bs[DDIR_WRITE] == o->max_bs[DDIR_WRITE] &&
580 o->min_bs[DDIR_TRIM] == o->max_bs[DDIR_TRIM] &&
581 o->min_bs[DDIR_READ] == o->min_bs[DDIR_WRITE] &&
582 o->min_bs[DDIR_READ] == o->min_bs[DDIR_TRIM];
588 static unsigned int gcd(unsigned int m, unsigned int n)
593 return gcd(n, m % n);
597 * Lazy way of fixing up options that depend on each other. We could also
598 * define option callback handlers, but this is easier.
600 static int fixup_options(struct thread_data *td)
602 struct thread_options *o = &td->o;
605 if (read_only && (td_write(td) || td_trim(td))) {
606 log_err("fio: trim and write operations are not allowed"
607 " with the --readonly parameter.\n");
611 #ifndef CONFIG_PSHARED
612 if (!o->use_thread) {
613 log_info("fio: this platform does not support process shared"
614 " mutexes, forcing use of threads. Use the 'thread'"
615 " option to get rid of this warning.\n");
617 ret |= warnings_fatal;
621 if (o->write_iolog_file && o->read_iolog_file) {
622 log_err("fio: read iolog overrides write_iolog\n");
623 free(o->write_iolog_file);
624 o->write_iolog_file = NULL;
625 ret |= warnings_fatal;
628 if (o->zone_mode == ZONE_MODE_NONE && o->zone_size) {
629 log_err("fio: --zonemode=none and --zonesize are not compatible.\n");
633 if (o->zone_mode == ZONE_MODE_STRIDED && !o->zone_size) {
634 log_err("fio: --zonesize must be specified when using --zonemode=strided.\n");
638 if (o->zone_mode == ZONE_MODE_NOT_SPECIFIED) {
640 o->zone_mode = ZONE_MODE_STRIDED;
642 o->zone_mode = ZONE_MODE_NONE;
646 * Strided zone mode only really works with 1 file.
648 if (o->zone_mode == ZONE_MODE_STRIDED && o->open_files > 1)
649 o->zone_mode = ZONE_MODE_NONE;
652 * If zone_range isn't specified, backward compatibility dictates it
653 * should be made equal to zone_size.
655 if (o->zone_mode == ZONE_MODE_STRIDED && !o->zone_range)
656 o->zone_range = o->zone_size;
659 * Reads can do overwrites, we always need to pre-create the file
664 for_each_rw_ddir(ddir) {
665 if (!o->min_bs[ddir])
666 o->min_bs[ddir] = o->bs[ddir];
667 if (!o->max_bs[ddir])
668 o->max_bs[ddir] = o->bs[ddir];
672 for_each_rw_ddir(ddir) {
673 o->rw_min_bs = min(o->rw_min_bs, o->min_bs[ddir]);
677 * For random IO, allow blockalign offset other than min_bs.
679 for_each_rw_ddir(ddir) {
680 if (!o->ba[ddir] || !td_random(td))
681 o->ba[ddir] = o->min_bs[ddir];
684 if ((o->ba[DDIR_READ] != o->min_bs[DDIR_READ] ||
685 o->ba[DDIR_WRITE] != o->min_bs[DDIR_WRITE] ||
686 o->ba[DDIR_TRIM] != o->min_bs[DDIR_TRIM]) &&
688 log_err("fio: Any use of blockalign= turns off randommap\n");
690 ret |= warnings_fatal;
693 if (!o->file_size_high)
694 o->file_size_high = o->file_size_low;
696 if (o->start_delay_high) {
697 if (!o->start_delay_orig)
698 o->start_delay_orig = o->start_delay;
699 o->start_delay = rand_between(&td->delay_state,
701 o->start_delay_high);
704 if (o->norandommap && o->verify != VERIFY_NONE
705 && !fixed_block_size(o)) {
706 log_err("fio: norandommap given for variable block sizes, "
708 ret |= warnings_fatal;
710 if (o->bs_unaligned && (o->odirect || td_ioengine_flagged(td, FIO_RAWIO)))
711 log_err("fio: bs_unaligned may not work with raw io\n");
714 * thinktime_spin must be less than thinktime
716 if (o->thinktime_spin > o->thinktime)
717 o->thinktime_spin = o->thinktime;
720 * The low water mark cannot be bigger than the iodepth
722 if (o->iodepth_low > o->iodepth || !o->iodepth_low)
723 o->iodepth_low = o->iodepth;
726 * If batch number isn't set, default to the same as iodepth
728 if (o->iodepth_batch > o->iodepth || !o->iodepth_batch)
729 o->iodepth_batch = o->iodepth;
732 * If max batch complete number isn't set or set incorrectly,
733 * default to the same as iodepth_batch_complete_min
735 if (o->iodepth_batch_complete_min > o->iodepth_batch_complete_max)
736 o->iodepth_batch_complete_max = o->iodepth_batch_complete_min;
739 * There's no need to check for in-flight overlapping IOs if the job
740 * isn't changing data or the maximum iodepth is guaranteed to be 1
741 * when we are not in offload mode
743 if (o->serialize_overlap && !(td->flags & TD_F_READ_IOLOG) &&
744 (!(td_write(td) || td_trim(td)) || o->iodepth == 1) &&
745 o->io_submit_mode != IO_MODE_OFFLOAD)
746 o->serialize_overlap = 0;
748 if (o->nr_files > td->files_index)
749 o->nr_files = td->files_index;
751 if (o->open_files > o->nr_files || !o->open_files)
752 o->open_files = o->nr_files;
754 if (((o->rate[DDIR_READ] + o->rate[DDIR_WRITE] + o->rate[DDIR_TRIM]) &&
755 (o->rate_iops[DDIR_READ] + o->rate_iops[DDIR_WRITE] + o->rate_iops[DDIR_TRIM])) ||
756 ((o->ratemin[DDIR_READ] + o->ratemin[DDIR_WRITE] + o->ratemin[DDIR_TRIM]) &&
757 (o->rate_iops_min[DDIR_READ] + o->rate_iops_min[DDIR_WRITE] + o->rate_iops_min[DDIR_TRIM]))) {
758 log_err("fio: rate and rate_iops are mutually exclusive\n");
761 for_each_rw_ddir(ddir) {
762 if ((o->rate[ddir] && (o->rate[ddir] < o->ratemin[ddir])) ||
763 (o->rate_iops[ddir] && (o->rate_iops[ddir] < o->rate_iops_min[ddir]))) {
764 log_err("fio: minimum rate exceeds rate, ddir %d\n", +ddir);
769 if (!o->timeout && o->time_based) {
770 log_err("fio: time_based requires a runtime/timeout setting\n");
772 ret |= warnings_fatal;
775 if (o->fill_device && !o->size)
778 if (o->verify != VERIFY_NONE) {
779 if (td_write(td) && o->do_verify && o->numjobs > 1 &&
781 !(o->unique_filename &&
782 strstr(o->filename_format, "$jobname") &&
783 strstr(o->filename_format, "$jobnum") &&
784 strstr(o->filename_format, "$filenum")))) {
785 log_info("fio: multiple writers may overwrite blocks "
786 "that belong to other jobs. This can cause "
787 "verification failures.\n");
788 ret |= warnings_fatal;
792 * Warn if verification is requested but no verification of any
793 * kind can be started due to time constraints
795 if (td_write(td) && o->do_verify && o->timeout &&
796 o->time_based && !td_read(td) && !o->verify_backlog) {
797 log_info("fio: verification read phase will never "
798 "start because write phase uses all of "
800 ret |= warnings_fatal;
803 if (!fio_option_is_set(o, refill_buffers))
804 o->refill_buffers = 1;
806 if (o->max_bs[DDIR_WRITE] != o->min_bs[DDIR_WRITE] &&
808 o->verify_interval = o->min_bs[DDIR_WRITE];
811 * Verify interval must be smaller or equal to the
814 if (o->verify_interval > o->min_bs[DDIR_WRITE])
815 o->verify_interval = o->min_bs[DDIR_WRITE];
816 else if (td_read(td) && o->verify_interval > o->min_bs[DDIR_READ])
817 o->verify_interval = o->min_bs[DDIR_READ];
820 * Verify interval must be a factor of both min and max
823 if (!o->verify_interval ||
824 (o->min_bs[DDIR_WRITE] % o->verify_interval) ||
825 (o->max_bs[DDIR_WRITE] % o->verify_interval))
826 o->verify_interval = gcd(o->min_bs[DDIR_WRITE],
827 o->max_bs[DDIR_WRITE]);
831 if (o->invalidate_cache)
832 o->invalidate_cache = 0;
833 if (td_ioengine_flagged(td, FIO_PIPEIO)) {
834 log_info("fio: cannot pre-read files with an IO engine"
835 " that isn't seekable. Pre-read disabled.\n");
836 ret |= warnings_fatal;
840 if (o->unit_base == N2S_NONE) {
841 if (td_ioengine_flagged(td, FIO_BIT_BASED))
842 o->unit_base = N2S_BITPERSEC;
844 o->unit_base = N2S_BYTEPERSEC;
847 #ifndef CONFIG_FDATASYNC
848 if (o->fdatasync_blocks) {
849 log_info("fio: this platform does not support fdatasync()"
850 " falling back to using fsync(). Use the 'fsync'"
851 " option instead of 'fdatasync' to get rid of"
853 o->fsync_blocks = o->fdatasync_blocks;
854 o->fdatasync_blocks = 0;
855 ret |= warnings_fatal;
861 * Windows doesn't support O_DIRECT or O_SYNC with the _open interface,
862 * so fail if we're passed those flags
864 if (td_ioengine_flagged(td, FIO_SYNCIO) && (o->odirect || o->sync_io)) {
865 log_err("fio: Windows does not support direct or non-buffered io with"
866 " the synchronous ioengines. Use the 'windowsaio' ioengine"
867 " with 'direct=1' and 'iodepth=1' instead.\n");
873 * For fully compressible data, just zero them at init time.
874 * It's faster than repeatedly filling it. For non-zero
875 * compression, we should have refill_buffers set. Set it, unless
876 * the job file already changed it.
878 if (o->compress_percentage) {
879 if (o->compress_percentage == 100) {
881 o->compress_percentage = 0;
882 } else if (!fio_option_is_set(o, refill_buffers)) {
883 o->refill_buffers = 1;
884 td->flags |= TD_F_REFILL_BUFFERS;
889 * Using a non-uniform random distribution excludes usage of
892 if (o->random_distribution != FIO_RAND_DIST_RANDOM)
896 * If size is set but less than the min block size, complain
898 if (o->size && o->size < td_min_bs(td)) {
899 log_err("fio: size too small, must not be less than minimum block size: %llu < %llu\n",
900 (unsigned long long) o->size, td_min_bs(td));
905 * O_ATOMIC implies O_DIRECT
911 * If randseed is set, that overrides randrepeat
913 if (fio_option_is_set(o, rand_seed))
914 o->rand_repeatable = 0;
916 if (td_ioengine_flagged(td, FIO_NOEXTEND) && o->file_append) {
917 log_err("fio: can't append/extent with IO engine %s\n", td->io_ops->name);
921 if (fio_option_is_set(o, gtod_cpu)) {
923 fio_gtod_set_cpu(o->gtod_cpu);
924 fio_gtod_offload = 1;
927 td->loops = o->loops;
931 if (o->block_error_hist && o->nr_files != 1) {
932 log_err("fio: block error histogram only available "
933 "with a single file per job, but %d files "
934 "provided\n", o->nr_files);
939 o->lat_percentiles = 0;
941 o->clat_percentiles = 0;
943 o->slat_percentiles = 0;
946 * Fix these up to be nsec internally
948 o->max_latency *= 1000ULL;
949 o->latency_target *= 1000ULL;
954 static void init_rand_file_service(struct thread_data *td)
956 unsigned long nranges = td->o.nr_files << FIO_FSERVICE_SHIFT;
957 const unsigned int seed = td->rand_seeds[FIO_RAND_FILE_OFF];
959 if (td->o.file_service_type == FIO_FSERVICE_ZIPF) {
960 zipf_init(&td->next_file_zipf, nranges, td->zipf_theta, seed);
961 zipf_disable_hash(&td->next_file_zipf);
962 } else if (td->o.file_service_type == FIO_FSERVICE_PARETO) {
963 pareto_init(&td->next_file_zipf, nranges, td->pareto_h, seed);
964 zipf_disable_hash(&td->next_file_zipf);
965 } else if (td->o.file_service_type == FIO_FSERVICE_GAUSS) {
966 gauss_init(&td->next_file_gauss, nranges, td->gauss_dev, seed);
967 gauss_disable_hash(&td->next_file_gauss);
971 void td_fill_verify_state_seed(struct thread_data *td)
975 if (td->o.random_generator == FIO_RAND_GEN_TAUSWORTHE64)
980 init_rand_seed(&td->verify_state, td->rand_seeds[FIO_RAND_VER_OFF],
984 static void td_fill_rand_seeds_internal(struct thread_data *td, bool use64)
986 uint64_t read_seed = td->rand_seeds[FIO_RAND_BS_OFF];
987 uint64_t write_seed = td->rand_seeds[FIO_RAND_BS1_OFF];
988 uint64_t trim_seed = td->rand_seeds[FIO_RAND_BS2_OFF];
992 * trimwrite is special in that we need to generate the same
993 * offsets to get the "write after trim" effect. If we are
994 * using bssplit to set buffer length distributions, ensure that
995 * we seed the trim and write generators identically. Ditto for
996 * verify, read and writes must have the same seed, if we are doing
999 if (td->o.verify != VERIFY_NONE)
1000 write_seed = read_seed;
1001 if (td_trimwrite(td))
1002 trim_seed = write_seed;
1003 init_rand_seed(&td->bsrange_state[DDIR_READ], read_seed, use64);
1004 init_rand_seed(&td->bsrange_state[DDIR_WRITE], write_seed, use64);
1005 init_rand_seed(&td->bsrange_state[DDIR_TRIM], trim_seed, use64);
1007 td_fill_verify_state_seed(td);
1008 init_rand_seed(&td->rwmix_state, td->rand_seeds[FIO_RAND_MIX_OFF], false);
1010 if (td->o.file_service_type == FIO_FSERVICE_RANDOM)
1011 init_rand_seed(&td->next_file_state, td->rand_seeds[FIO_RAND_FILE_OFF], use64);
1012 else if (td->o.file_service_type & __FIO_FSERVICE_NONUNIFORM)
1013 init_rand_file_service(td);
1015 init_rand_seed(&td->file_size_state, td->rand_seeds[FIO_RAND_FILE_SIZE_OFF], use64);
1016 init_rand_seed(&td->trim_state, td->rand_seeds[FIO_RAND_TRIM_OFF], use64);
1017 init_rand_seed(&td->delay_state, td->rand_seeds[FIO_RAND_START_DELAY], use64);
1018 init_rand_seed(&td->poisson_state[0], td->rand_seeds[FIO_RAND_POISSON_OFF], 0);
1019 init_rand_seed(&td->poisson_state[1], td->rand_seeds[FIO_RAND_POISSON2_OFF], 0);
1020 init_rand_seed(&td->poisson_state[2], td->rand_seeds[FIO_RAND_POISSON3_OFF], 0);
1021 init_rand_seed(&td->dedupe_state, td->rand_seeds[FIO_DEDUPE_OFF], false);
1022 init_rand_seed(&td->zone_state, td->rand_seeds[FIO_RAND_ZONE_OFF], false);
1023 init_rand_seed(&td->prio_state, td->rand_seeds[FIO_RAND_PRIO_CMDS], false);
1028 if (td->o.rand_repeatable)
1029 td->rand_seeds[FIO_RAND_BLOCK_OFF] = FIO_RANDSEED * td->thread_number;
1031 init_rand_seed(&td->random_state, td->rand_seeds[FIO_RAND_BLOCK_OFF], use64);
1033 for (i = 0; i < DDIR_RWDIR_CNT; i++) {
1034 struct frand_state *s = &td->seq_rand_state[i];
1036 init_rand_seed(s, td->rand_seeds[FIO_RAND_SEQ_RAND_READ_OFF], false);
1040 void td_fill_rand_seeds(struct thread_data *td)
1044 if (td->o.allrand_repeatable) {
1047 for (i = 0; i < FIO_RAND_NR_OFFS; i++)
1048 td->rand_seeds[i] = FIO_RANDSEED * td->thread_number
1052 if (td->o.random_generator == FIO_RAND_GEN_TAUSWORTHE64)
1057 td_fill_rand_seeds_internal(td, use64);
1059 init_rand_seed(&td->buf_state, td->rand_seeds[FIO_RAND_BUF_OFF], use64);
1060 frand_copy(&td->buf_state_prev, &td->buf_state);
1064 * Initializes the ioengine configured for a job, if it has not been done so
1067 int ioengine_load(struct thread_data *td)
1069 if (!td->o.ioengine) {
1070 log_err("fio: internal fault, no IO engine specified\n");
1075 struct ioengine_ops *ops;
1078 /* An engine is loaded, but the requested ioengine
1081 if (!strcmp(td->io_ops->name, td->o.ioengine)) {
1082 /* The right engine is already loaded */
1087 * Name of file and engine may be different, load ops
1088 * for this name and see if they match. If they do, then
1089 * the engine is unchanged.
1091 dlhandle = td->io_ops_dlhandle;
1092 ops = load_ioengine(td);
1096 if (ops == td->io_ops && dlhandle == td->io_ops_dlhandle) {
1102 if (dlhandle && dlhandle != td->io_ops_dlhandle)
1105 /* Unload the old engine. */
1109 td->io_ops = load_ioengine(td);
1113 if (td->io_ops->option_struct_size && td->io_ops->options) {
1115 * In cases where td->eo is set, clone it for a child thread.
1116 * This requires that the parent thread has the same ioengine,
1117 * but that requirement must be enforced by the code which
1118 * cloned the thread.
1120 void *origeo = td->eo;
1122 * Otherwise use the default thread options.
1124 if (!origeo && td != &def_thread && def_thread.eo &&
1125 def_thread.io_ops->options == td->io_ops->options)
1126 origeo = def_thread.eo;
1128 options_init(td->io_ops->options);
1129 td->eo = malloc(td->io_ops->option_struct_size);
1131 * Use the default thread as an option template if this uses the
1132 * same options structure and there are non-default options
1136 memcpy(td->eo, origeo, td->io_ops->option_struct_size);
1137 options_mem_dupe(td->io_ops->options, td->eo);
1139 memset(td->eo, 0, td->io_ops->option_struct_size);
1140 fill_default_options(td->eo, td->io_ops->options);
1142 *(struct thread_data **)td->eo = td;
1146 td->io_ops->flags |= FIO_RAWIO;
1148 td_set_ioengine_flags(td);
1152 log_err("fio: failed to load engine\n");
1157 static void init_flags(struct thread_data *td)
1159 struct thread_options *o = &td->o;
1162 if (o->verify_backlog)
1163 td->flags |= TD_F_VER_BACKLOG;
1164 if (o->trim_backlog)
1165 td->flags |= TD_F_TRIM_BACKLOG;
1166 if (o->read_iolog_file)
1167 td->flags |= TD_F_READ_IOLOG;
1168 if (o->refill_buffers)
1169 td->flags |= TD_F_REFILL_BUFFERS;
1171 * Always scramble buffers if asked to
1173 if (o->scramble_buffers && fio_option_is_set(o, scramble_buffers))
1174 td->flags |= TD_F_SCRAMBLE_BUFFERS;
1176 * But also scramble buffers, unless we were explicitly asked
1179 if (o->scramble_buffers && !(o->zero_buffers &&
1180 fio_option_is_set(o, zero_buffers)))
1181 td->flags |= TD_F_SCRAMBLE_BUFFERS;
1182 if (o->verify != VERIFY_NONE)
1183 td->flags |= TD_F_DO_VERIFY;
1185 if (o->verify_async || o->io_submit_mode == IO_MODE_OFFLOAD)
1186 td->flags |= TD_F_NEED_LOCK;
1188 if (o->mem_type == MEM_CUDA_MALLOC)
1189 td->flags &= ~TD_F_SCRAMBLE_BUFFERS;
1191 for (i = 0; i < DDIR_RWDIR_CNT; i++) {
1192 if (option_check_rate(td, i)) {
1193 td->flags |= TD_F_CHECK_RATE;
1199 static int setup_random_seeds(struct thread_data *td)
1204 if (!td->o.rand_repeatable && !fio_option_is_set(&td->o, rand_seed)) {
1205 int ret = init_random_seeds(td->rand_seeds, sizeof(td->rand_seeds));
1207 td_fill_rand_seeds(td);
1211 seed = td->o.rand_seed;
1212 for (i = 0; i < 4; i++)
1213 seed *= 0x9e370001UL;
1215 for (i = 0; i < FIO_RAND_NR_OFFS; i++) {
1216 td->rand_seeds[i] = seed * td->thread_number + i;
1217 seed *= 0x9e370001UL;
1220 td_fill_rand_seeds(td);
1231 static struct fpre_keyword {
1232 const char *keyword;
1235 } fpre_keywords[] = {
1236 { .keyword = "$jobname", .key = FPRE_JOBNAME, },
1237 { .keyword = "$jobnum", .key = FPRE_JOBNUM, },
1238 { .keyword = "$filenum", .key = FPRE_FILENUM, },
1239 { .keyword = NULL, },
1242 static char *make_filename(char *buf, size_t buf_size,struct thread_options *o,
1243 const char *jobname, int jobnum, int filenum)
1245 struct fpre_keyword *f;
1246 char copy[PATH_MAX];
1247 size_t dst_left = PATH_MAX - 1;
1249 if (!o->filename_format || !strlen(o->filename_format)) {
1250 sprintf(buf, "%s.%d.%d", jobname, jobnum, filenum);
1254 for (f = &fpre_keywords[0]; f->keyword; f++)
1255 f->strlen = strlen(f->keyword);
1257 snprintf(buf, buf_size, "%s", o->filename_format);
1259 memset(copy, 0, sizeof(copy));
1260 for (f = &fpre_keywords[0]; f->keyword; f++) {
1262 size_t pre_len, post_start = 0;
1263 char *str, *dst = copy;
1265 str = strcasestr(buf, f->keyword);
1269 pre_len = str - buf;
1270 if (strlen(str) != f->strlen)
1271 post_start = pre_len + f->strlen;
1274 strncpy(dst, buf, pre_len);
1276 dst_left -= pre_len;
1280 case FPRE_JOBNAME: {
1283 ret = snprintf(dst, dst_left, "%s", jobname);
1286 else if (ret > dst_left) {
1287 log_err("fio: truncated filename\n");
1299 ret = snprintf(dst, dst_left, "%d", jobnum);
1302 else if (ret > dst_left) {
1303 log_err("fio: truncated filename\n");
1312 case FPRE_FILENUM: {
1315 ret = snprintf(dst, dst_left, "%d", filenum);
1318 else if (ret > dst_left) {
1319 log_err("fio: truncated filename\n");
1334 strncpy(dst, buf + post_start, dst_left);
1336 snprintf(buf, buf_size, "%s", copy);
1343 bool parse_dryrun(void)
1345 return dump_cmdline || parse_only;
1348 static void gen_log_name(char *name, size_t size, const char *logtype,
1349 const char *logname, unsigned int num,
1350 const char *suf, int per_job)
1353 snprintf(name, size, "%s_%s.%d.%s", logname, logtype, num, suf);
1355 snprintf(name, size, "%s_%s.%s", logname, logtype, suf);
1358 static int check_waitees(char *waitee)
1360 struct thread_data *td;
1363 for_each_td(td, i) {
1364 if (td->subjob_number)
1367 ret += !strcmp(td->o.name, waitee);
1373 static bool wait_for_ok(const char *jobname, struct thread_options *o)
1380 if (!strcmp(jobname, o->wait_for)) {
1381 log_err("%s: a job cannot wait for itself (wait_for=%s).\n",
1382 jobname, o->wait_for);
1386 if (!(nw = check_waitees(o->wait_for))) {
1387 log_err("%s: waitee job %s unknown.\n", jobname, o->wait_for);
1392 log_err("%s: multiple waitees %s found,\n"
1393 "please avoid duplicates when using wait_for option.\n",
1394 jobname, o->wait_for);
1402 * Treat an empty log file name the same as a one not given
1404 static const char *make_log_name(const char *logname, const char *jobname)
1406 if (logname && strcmp(logname, ""))
1413 * Adds a job to the list of things todo. Sanitizes the various options
1414 * to make sure we don't have conflicts, and initializes various
1417 static int add_job(struct thread_data *td, const char *jobname, int job_add_num,
1418 int recursed, int client_type)
1421 char fname[PATH_MAX + 1];
1422 int numjobs, file_alloced;
1423 struct thread_options *o = &td->o;
1424 char logname[PATH_MAX + 32];
1427 * the def_thread is just for options, it's not a real job
1429 if (td == &def_thread)
1435 * if we are just dumping the output command line, don't add the job
1437 if (parse_dryrun()) {
1442 td->client_type = client_type;
1444 if (profile_td_init(td))
1447 if (ioengine_load(td))
1451 if (!o->filename && !td->files_index && !o->read_iolog_file) {
1454 if (o->nr_files == 1 && exists_and_not_regfile(jobname))
1455 add_file(td, jobname, job_add_num, 0);
1457 for (i = 0; i < o->nr_files; i++)
1458 add_file(td, make_filename(fname, sizeof(fname), o, jobname, job_add_num, i), job_add_num, 0);
1462 if (setup_random_seeds(td)) {
1463 td_verror(td, errno, "setup_random_seeds");
1467 if (fixup_options(td))
1471 * Belongs to fixup_options, but o->name is not necessarily set as yet
1473 if (!wait_for_ok(jobname, o))
1479 * IO engines only need this for option callbacks, and the address may
1480 * change in subprocesses.
1483 *(struct thread_data **)td->eo = NULL;
1485 if (td_ioengine_flagged(td, FIO_DISKLESSIO)) {
1488 for_each_file(td, f, i)
1489 f->real_file_size = -1ULL;
1492 td->sem = fio_sem_init(FIO_SEM_LOCKED);
1494 td->ts.clat_percentiles = o->clat_percentiles;
1495 td->ts.lat_percentiles = o->lat_percentiles;
1496 td->ts.slat_percentiles = o->slat_percentiles;
1497 td->ts.percentile_precision = o->percentile_precision;
1498 memcpy(td->ts.percentile_list, o->percentile_list, sizeof(o->percentile_list));
1499 td->ts.sig_figs = o->sig_figs;
1501 for (i = 0; i < DDIR_RWDIR_CNT; i++) {
1502 td->ts.clat_stat[i].min_val = ULONG_MAX;
1503 td->ts.slat_stat[i].min_val = ULONG_MAX;
1504 td->ts.lat_stat[i].min_val = ULONG_MAX;
1505 td->ts.bw_stat[i].min_val = ULONG_MAX;
1506 td->ts.iops_stat[i].min_val = ULONG_MAX;
1507 td->ts.clat_high_prio_stat[i].min_val = ULONG_MAX;
1508 td->ts.clat_low_prio_stat[i].min_val = ULONG_MAX;
1510 td->ts.sync_stat.min_val = ULONG_MAX;
1511 td->ddir_seq_nr = o->ddir_seq_nr;
1513 if ((o->stonewall || o->new_group) && prev_group_jobs) {
1514 prev_group_jobs = 0;
1516 if (groupid == INT_MAX) {
1517 log_err("fio: too many groups defined\n");
1522 td->groupid = groupid;
1528 if (o->write_lat_log) {
1529 struct log_params p = {
1531 .avg_msec = o->log_avg_msec,
1532 .hist_msec = o->log_hist_msec,
1533 .hist_coarseness = o->log_hist_coarseness,
1534 .log_type = IO_LOG_TYPE_LAT,
1535 .log_offset = o->log_offset,
1536 .log_gz = o->log_gz,
1537 .log_gz_store = o->log_gz_store,
1539 const char *pre = make_log_name(o->lat_log_file, o->name);
1547 gen_log_name(logname, sizeof(logname), "lat", pre,
1548 td->thread_number, suf, o->per_job_logs);
1549 setup_log(&td->lat_log, &p, logname);
1551 gen_log_name(logname, sizeof(logname), "slat", pre,
1552 td->thread_number, suf, o->per_job_logs);
1553 setup_log(&td->slat_log, &p, logname);
1555 gen_log_name(logname, sizeof(logname), "clat", pre,
1556 td->thread_number, suf, o->per_job_logs);
1557 setup_log(&td->clat_log, &p, logname);
1561 if (o->write_hist_log) {
1562 struct log_params p = {
1564 .avg_msec = o->log_avg_msec,
1565 .hist_msec = o->log_hist_msec,
1566 .hist_coarseness = o->log_hist_coarseness,
1567 .log_type = IO_LOG_TYPE_HIST,
1568 .log_offset = o->log_offset,
1569 .log_gz = o->log_gz,
1570 .log_gz_store = o->log_gz_store,
1572 const char *pre = make_log_name(o->hist_log_file, o->name);
1576 if (td->client_type) {
1577 log_err("fio: --write_hist_log requires zlib in client/server mode\n");
1587 gen_log_name(logname, sizeof(logname), "clat_hist", pre,
1588 td->thread_number, suf, o->per_job_logs);
1589 setup_log(&td->clat_hist_log, &p, logname);
1592 if (o->write_bw_log) {
1593 struct log_params p = {
1595 .avg_msec = o->log_avg_msec,
1596 .hist_msec = o->log_hist_msec,
1597 .hist_coarseness = o->log_hist_coarseness,
1598 .log_type = IO_LOG_TYPE_BW,
1599 .log_offset = o->log_offset,
1600 .log_gz = o->log_gz,
1601 .log_gz_store = o->log_gz_store,
1603 const char *pre = make_log_name(o->bw_log_file, o->name);
1606 if (fio_option_is_set(o, bw_avg_time))
1607 p.avg_msec = min(o->log_avg_msec, o->bw_avg_time);
1609 o->bw_avg_time = p.avg_msec;
1611 p.hist_msec = o->log_hist_msec;
1612 p.hist_coarseness = o->log_hist_coarseness;
1619 gen_log_name(logname, sizeof(logname), "bw", pre,
1620 td->thread_number, suf, o->per_job_logs);
1621 setup_log(&td->bw_log, &p, logname);
1623 if (o->write_iops_log) {
1624 struct log_params p = {
1626 .avg_msec = o->log_avg_msec,
1627 .hist_msec = o->log_hist_msec,
1628 .hist_coarseness = o->log_hist_coarseness,
1629 .log_type = IO_LOG_TYPE_IOPS,
1630 .log_offset = o->log_offset,
1631 .log_gz = o->log_gz,
1632 .log_gz_store = o->log_gz_store,
1634 const char *pre = make_log_name(o->iops_log_file, o->name);
1637 if (fio_option_is_set(o, iops_avg_time))
1638 p.avg_msec = min(o->log_avg_msec, o->iops_avg_time);
1640 o->iops_avg_time = p.avg_msec;
1642 p.hist_msec = o->log_hist_msec;
1643 p.hist_coarseness = o->log_hist_coarseness;
1650 gen_log_name(logname, sizeof(logname), "iops", pre,
1651 td->thread_number, suf, o->per_job_logs);
1652 setup_log(&td->iops_log, &p, logname);
1656 o->name = strdup(jobname);
1658 if (output_format & FIO_OUTPUT_NORMAL) {
1660 if (is_backend && !recursed)
1661 fio_server_send_add_job(td);
1663 if (!td_ioengine_flagged(td, FIO_NOIO)) {
1664 char *c1, *c2, *c3, *c4;
1665 char *c5 = NULL, *c6 = NULL;
1666 int i2p = is_power_of_2(o->kb_base);
1667 struct buf_output out;
1669 c1 = num2str(o->min_bs[DDIR_READ], o->sig_figs, 1, i2p, N2S_BYTE);
1670 c2 = num2str(o->max_bs[DDIR_READ], o->sig_figs, 1, i2p, N2S_BYTE);
1671 c3 = num2str(o->min_bs[DDIR_WRITE], o->sig_figs, 1, i2p, N2S_BYTE);
1672 c4 = num2str(o->max_bs[DDIR_WRITE], o->sig_figs, 1, i2p, N2S_BYTE);
1674 if (!o->bs_is_seq_rand) {
1675 c5 = num2str(o->min_bs[DDIR_TRIM], o->sig_figs, 1, i2p, N2S_BYTE);
1676 c6 = num2str(o->max_bs[DDIR_TRIM], o->sig_figs, 1, i2p, N2S_BYTE);
1679 buf_output_init(&out);
1680 __log_buf(&out, "%s: (g=%d): rw=%s, ", td->o.name,
1682 ddir_str(o->td_ddir));
1684 if (o->bs_is_seq_rand)
1685 __log_buf(&out, "bs=(R) %s-%s, (W) %s-%s, bs_is_seq_rand, ",
1688 __log_buf(&out, "bs=(R) %s-%s, (W) %s-%s, (T) %s-%s, ",
1689 c1, c2, c3, c4, c5, c6);
1691 __log_buf(&out, "ioengine=%s, iodepth=%u\n",
1692 td->io_ops->name, o->iodepth);
1693 log_info_buf(out.buf, out.buflen);
1694 buf_output_free(&out);
1703 } else if (job_add_num == 1)
1707 if (td_steadystate_init(td))
1710 if (o->merge_blktrace_file && !merge_blktrace_iologs(td))
1713 if (merge_blktrace_only) {
1719 * recurse add identical jobs, clear numjobs and stonewall options
1720 * as they don't apply to sub-jobs
1722 numjobs = o->numjobs;
1724 struct thread_data *td_new = get_new_job(false, td, true, jobname);
1729 td_new->o.numjobs = 1;
1730 td_new->o.stonewall = 0;
1731 td_new->o.new_group = 0;
1732 td_new->subjob_number = numjobs;
1733 td_new->o.ss_dur = o->ss_dur * 1000000l;
1734 td_new->o.ss_limit = o->ss_limit;
1737 if (td_new->files) {
1739 for_each_file(td_new, f, i)
1741 free(td_new->files);
1742 td_new->files = NULL;
1744 td_new->files_index = 0;
1745 td_new->files_size = 0;
1746 if (td_new->o.filename) {
1747 free(td_new->o.filename);
1748 td_new->o.filename = NULL;
1752 if (add_job(td_new, jobname, numjobs, 1, client_type))
1763 * Parse as if 'o' was a command line
1765 void add_job_opts(const char **o, int client_type)
1767 struct thread_data *td, *td_parent;
1768 int i, in_global = 1;
1772 td_parent = td = NULL;
1774 if (!strncmp(o[i], "name", 4)) {
1777 add_job(td, jobname, 0, 0, client_type);
1779 sprintf(jobname, "%s", o[i] + 5);
1781 if (in_global && !td_parent)
1782 td_parent = get_new_job(true, &def_thread, false, jobname);
1783 else if (!in_global && !td) {
1785 td_parent = &def_thread;
1786 td = get_new_job(false, td_parent, false, jobname);
1789 fio_options_parse(td_parent, (char **) &o[i], 1);
1791 fio_options_parse(td, (char **) &o[i], 1);
1796 add_job(td, jobname, 0, 0, client_type);
1799 static int skip_this_section(const char *name)
1803 if (!nr_job_sections)
1805 if (!strncmp(name, "global", 6))
1808 for (i = 0; i < nr_job_sections; i++)
1809 if (!strcmp(job_sections[i], name))
1815 static int is_empty_or_comment(char *line)
1819 for (i = 0; i < strlen(line); i++) {
1824 if (!isspace((int) line[i]) && !iscntrl((int) line[i]))
1832 * This is our [ini] type file parser.
1834 static int __parse_jobs_ini(struct thread_data *td,
1835 char *file, int is_buf, int stonewall_flag, int type,
1836 int nested, char *name, char ***popts, int *aopts, int *nopts)
1838 bool global = false;
1839 bool stdin_occupied = false;
1843 int ret = 0, stonewall;
1846 int inside_skip = 0;
1848 int i, alloc_opts, num_opts;
1850 dprint(FD_PARSE, "Parsing ini file %s\n", file);
1851 assert(td || !nested);
1856 if (!strcmp(file, "-")) {
1858 stdin_occupied = true;
1860 f = fopen(file, "r");
1865 log_err("fio: unable to open '%s' job file\n", file);
1867 td_verror(td, __err, "job file open");
1872 string = malloc(OPT_LEN_MAX);
1875 * it's really 256 + small bit, 280 should suffice
1879 memset(name, 0, 280);
1883 if (nested && popts) {
1885 alloc_opts = *aopts;
1891 opts = malloc(sizeof(char *) * alloc_opts);
1895 stonewall = stonewall_flag;
1898 * if skip_fgets is set, we already have loaded a line we
1903 p = strsep(&file, "\n");
1905 p = fgets(string, OPT_LEN_MAX, f);
1911 strip_blank_front(&p);
1914 dprint(FD_PARSE, "%s\n", p);
1915 if (is_empty_or_comment(p))
1919 if (sscanf(p, "[%255[^\n]]", name) != 1) {
1923 log_err("fio: option <%s> outside of "
1924 "[] job section\n", p);
1929 name[strlen(name) - 1] = '\0';
1931 if (skip_this_section(name)) {
1937 dprint(FD_PARSE, "Parsing section [%s]\n", name);
1939 global = !strncmp(name, "global", 6);
1945 log_info("--name=%s ", name);
1949 td = get_new_job(global, &def_thread, false, name);
1956 * Separate multiple job files by a stonewall
1958 if (!global && stonewall) {
1959 td->o.stonewall = stonewall;
1964 memset(opts, 0, alloc_opts * sizeof(char *));
1972 p = strsep(&file, "\n");
1974 p = fgets(string, OPT_LEN_MAX, f);
1977 dprint(FD_PARSE, "%s", p);
1982 if (is_empty_or_comment(p))
1985 strip_blank_front(&p);
1988 * new section, break out and make sure we don't
1989 * fgets() a new line at the top.
1993 log_err("No new sections in included files\n");
2004 if (!strncmp(p, "include", strlen("include"))) {
2005 char *filename = p + strlen("include") + 1,
2006 *ts, *full_fn = NULL;
2009 * Allow for the include filename
2010 * specification to be relative.
2012 if (access(filename, F_OK) &&
2013 (ts = strrchr(file, '/'))) {
2014 if (asprintf(&full_fn, "%.*s%s",
2015 (int)(ts - file + 1), file,
2023 ret = __parse_jobs_ini(td, filename, is_buf,
2024 stonewall_flag, type, 1,
2026 &alloc_opts, &num_opts);
2029 log_err("Error %d while parsing "
2030 "include file %s\n",
2043 if (num_opts == alloc_opts) {
2045 opts = realloc(opts,
2046 alloc_opts * sizeof(char *));
2049 opts[num_opts] = strdup(p);
2055 *aopts = alloc_opts;
2060 ret = fio_options_parse(td, opts, num_opts);
2062 if (!ret && td->o.read_iolog_file != NULL) {
2063 char *fname = get_name_by_idx(td->o.read_iolog_file,
2065 if (!strcmp(fname, "-")) {
2066 if (stdin_occupied) {
2067 log_err("fio: only one user (read_iolog_file/job "
2068 "file) of stdin is permitted at once but "
2069 "more than one was found.\n");
2072 stdin_occupied = true;
2079 ret = add_job(td, name, 0, 0, type);
2081 log_err("fio: job %s dropped\n", name);
2085 for (i = 0; i < num_opts; i++)
2094 while (i < nr_job_sections) {
2095 free(job_sections[i]);
2104 if (!is_buf && f != stdin)
2109 int parse_jobs_ini(char *file, int is_buf, int stonewall_flag, int type)
2111 return __parse_jobs_ini(NULL, file, is_buf, stonewall_flag, type,
2112 0, NULL, NULL, NULL, NULL);
2115 static int fill_def_thread(void)
2117 memset(&def_thread, 0, sizeof(def_thread));
2118 INIT_FLIST_HEAD(&def_thread.opt_list);
2120 fio_getaffinity(getpid(), &def_thread.o.cpumask);
2121 def_thread.o.error_dump = 1;
2124 * fill default options
2126 fio_fill_default_options(&def_thread);
2130 static void show_debug_categories(void)
2132 #ifdef FIO_INC_DEBUG
2133 const struct debug_level *dl = &debug_levels[0];
2134 int curlen, first = 1;
2138 int has_next = (dl + 1)->name != NULL;
2140 if (first || curlen + strlen(dl->name) >= 80) {
2145 curlen += printf("\t\t\t%s", dl->name);
2146 curlen += 3 * (8 - 1);
2148 curlen += printf(",");
2150 curlen += printf("%s", dl->name);
2152 curlen += printf(",");
2162 * Following options aren't printed by usage().
2163 * --append-terse - Equivalent to --output-format=terse, see f6a7df53.
2164 * --latency-log - Deprecated option.
2166 static void usage(const char *name)
2168 printf("%s\n", fio_version_string);
2169 printf("%s [options] [job options] <job file(s)>\n", name);
2170 printf(" --debug=options\tEnable debug logging. May be one/more of:\n");
2171 show_debug_categories();
2172 printf(" --parse-only\t\tParse options only, don't start any IO\n");
2173 printf(" --merge-blktrace-only\tMerge blktraces only, don't start any IO\n");
2174 printf(" --output\t\tWrite output to file\n");
2175 printf(" --bandwidth-log\tGenerate aggregate bandwidth logs\n");
2176 printf(" --minimal\t\tMinimal (terse) output\n");
2177 printf(" --output-format=type\tOutput format (terse,json,json+,normal)\n");
2178 printf(" --terse-version=type\tSet terse version output format"
2179 " (default 3, or 2 or 4)\n");
2180 printf(" --version\t\tPrint version info and exit\n");
2181 printf(" --help\t\tPrint this page\n");
2182 printf(" --cpuclock-test\tPerform test/validation of CPU clock\n");
2183 printf(" --crctest=[type]\tTest speed of checksum functions\n");
2184 printf(" --cmdhelp=cmd\t\tPrint command help, \"all\" for all of"
2186 printf(" --enghelp=engine\tPrint ioengine help, or list"
2187 " available ioengines\n");
2188 printf(" --enghelp=engine,cmd\tPrint help for an ioengine"
2190 printf(" --showcmd\t\tTurn a job file into command line options\n");
2191 printf(" --eta=when\t\tWhen ETA estimate should be printed\n");
2192 printf(" \t\tMay be \"always\", \"never\" or \"auto\"\n");
2193 printf(" --eta-newline=t\tForce a new line for every 't'");
2194 printf(" period passed\n");
2195 printf(" --status-interval=t\tForce full status dump every");
2196 printf(" 't' period passed\n");
2197 printf(" --readonly\t\tTurn on safety read-only checks, preventing"
2199 printf(" --section=name\tOnly run specified section in job file,"
2200 " multiple sections can be specified\n");
2201 printf(" --alloc-size=kb\tSet smalloc pool to this size in kb"
2203 printf(" --warnings-fatal\tFio parser warnings are fatal\n");
2204 printf(" --max-jobs=nr\t\tMaximum number of threads/processes to support\n");
2205 printf(" --server=args\t\tStart a backend fio server\n");
2206 printf(" --daemonize=pidfile\tBackground fio server, write pid to file\n");
2207 printf(" --client=hostname\tTalk to remote backend(s) fio server at hostname\n");
2208 printf(" --remote-config=file\tTell fio server to load this local job file\n");
2209 printf(" --idle-prof=option\tReport cpu idleness on a system or percpu basis\n"
2210 "\t\t\t(option=system,percpu) or run unit work\n"
2211 "\t\t\tcalibration only (option=calibrate)\n");
2213 printf(" --inflate-log=log\tInflate and output compressed log\n");
2215 printf(" --trigger-file=file\tExecute trigger cmd when file exists\n");
2216 printf(" --trigger-timeout=t\tExecute trigger at this time\n");
2217 printf(" --trigger=cmd\t\tSet this command as local trigger\n");
2218 printf(" --trigger-remote=cmd\tSet this command as remote trigger\n");
2219 printf(" --aux-path=path\tUse this path for fio state generated files\n");
2220 printf("\nFio was written by Jens Axboe <axboe@kernel.dk>\n");
2223 #ifdef FIO_INC_DEBUG
2224 const struct debug_level debug_levels[] = {
2225 { .name = "process",
2226 .help = "Process creation/exit logging",
2227 .shift = FD_PROCESS,
2230 .help = "File related action logging",
2234 .help = "IO and IO engine action logging (offsets, queue, completions, etc)",
2238 .help = "Memory allocation/freeing logging",
2241 { .name = "blktrace",
2242 .help = "blktrace action logging",
2243 .shift = FD_BLKTRACE,
2246 .help = "IO verification action logging",
2250 .help = "Random generation logging",
2254 .help = "Parser logging",
2257 { .name = "diskutil",
2258 .help = "Disk utility logging actions",
2259 .shift = FD_DISKUTIL,
2262 .help = "Logging related to creating/destroying jobs",
2266 .help = "Mutex logging",
2269 { .name = "profile",
2270 .help = "Logging related to profiles",
2271 .shift = FD_PROFILE,
2274 .help = "Logging related to time keeping functions",
2278 .help = "Network logging",
2282 .help = "Rate logging",
2285 { .name = "compress",
2286 .help = "Log compression logging",
2287 .shift = FD_COMPRESS,
2289 { .name = "steadystate",
2290 .help = "Steady state detection logging",
2291 .shift = FD_STEADYSTATE,
2293 { .name = "helperthread",
2294 .help = "Helper thread logging",
2295 .shift = FD_HELPERTHREAD,
2298 .help = "Zoned Block Device logging",
2304 static int set_debug(const char *string)
2306 const struct debug_level *dl;
2307 char *p = (char *) string;
2314 if (!strcmp(string, "?") || !strcmp(string, "help")) {
2315 log_info("fio: dumping debug options:");
2316 for (i = 0; debug_levels[i].name; i++) {
2317 dl = &debug_levels[i];
2318 log_info("%s,", dl->name);
2324 while ((opt = strsep(&p, ",")) != NULL) {
2327 if (!strncmp(opt, "all", 3)) {
2328 log_info("fio: set all debug options\n");
2333 for (i = 0; debug_levels[i].name; i++) {
2334 dl = &debug_levels[i];
2335 found = !strncmp(opt, dl->name, strlen(dl->name));
2339 if (dl->shift == FD_JOB) {
2340 opt = strchr(opt, ':');
2342 log_err("fio: missing job number\n");
2346 fio_debug_jobno = atoi(opt);
2347 log_info("fio: set debug jobno %d\n",
2350 log_info("fio: set debug option %s\n", opt);
2351 fio_debug |= (1UL << dl->shift);
2357 log_err("fio: debug mask %s not found\n", opt);
2362 static int set_debug(const char *string)
2364 log_err("fio: debug tracing not included in build\n");
2369 static void fio_options_fill_optstring(void)
2371 char *ostr = cmd_optstr;
2375 while (l_opts[i].name) {
2376 ostr[c++] = l_opts[i].val;
2377 if (l_opts[i].has_arg == required_argument)
2379 else if (l_opts[i].has_arg == optional_argument) {
2388 static int client_flag_set(char c)
2393 while (l_opts[i].name) {
2394 int val = l_opts[i].val;
2396 if (c == (val & 0xff))
2397 return (val & FIO_CLIENT_FLAG);
2405 static void parse_cmd_client(void *client, char *opt)
2407 fio_client_add_cmd_option(client, opt);
2410 static void show_closest_option(const char *name)
2412 int best_option, best_distance;
2415 while (*name == '-')
2419 best_distance = INT_MAX;
2421 while (l_opts[i].name) {
2422 distance = string_distance(name, l_opts[i].name);
2423 if (distance < best_distance) {
2424 best_distance = distance;
2430 if (best_option != -1 && string_distance_ok(name, best_distance))
2431 log_err("Did you mean %s?\n", l_opts[best_option].name);
2434 static int parse_output_format(const char *optarg)
2436 char *p, *orig, *opt;
2439 p = orig = strdup(optarg);
2443 while ((opt = strsep(&p, ",")) != NULL) {
2444 if (!strcmp(opt, "minimal") ||
2445 !strcmp(opt, "terse") ||
2446 !strcmp(opt, "csv"))
2447 output_format |= FIO_OUTPUT_TERSE;
2448 else if (!strcmp(opt, "json"))
2449 output_format |= FIO_OUTPUT_JSON;
2450 else if (!strcmp(opt, "json+"))
2451 output_format |= (FIO_OUTPUT_JSON | FIO_OUTPUT_JSON_PLUS);
2452 else if (!strcmp(opt, "normal"))
2453 output_format |= FIO_OUTPUT_NORMAL;
2455 log_err("fio: invalid output format %s\n", opt);
2465 int parse_cmd_line(int argc, char *argv[], int client_type)
2467 struct thread_data *td = NULL;
2468 int c, ini_idx = 0, lidx, ret = 0, do_exit = 0, exit_val = 0;
2469 char *ostr = cmd_optstr;
2470 char *pid_file = NULL;
2471 void *cur_client = NULL;
2472 bool backend = false;
2475 * Reset optind handling, since we may call this multiple times
2480 while ((c = getopt_long_only(argc, argv, ostr, l_opts, &lidx)) != -1) {
2481 if ((c & FIO_CLIENT_FLAG) || client_flag_set(c)) {
2482 parse_cmd_client(cur_client, argv[optind - 1]);
2483 c &= ~FIO_CLIENT_FLAG;
2488 smalloc_pool_size = atoi(optarg);
2489 smalloc_pool_size <<= 10;
2493 log_err("fio: --latency-log is deprecated. Use per-job latency log options.\n");
2498 write_bw_log = true;
2503 if (f_out && f_out != stdout)
2506 tmp = fopen(optarg, "w+");
2508 log_err("fio: output file open error: %s\n", strerror(errno));
2513 f_err = f_out = tmp;
2517 output_format = FIO_OUTPUT_TERSE;
2520 if (parse_output_format(optarg)) {
2521 log_err("fio: failed parsing output-format\n");
2528 output_format |= FIO_OUTPUT_TERSE;
2540 fio_show_option_help(optarg);
2547 exit_val = fio_show_ioengine_help(optarg);
2553 dump_cmdline = true;
2561 log_info("%s\n", fio_version_string);
2566 terse_version = atoi(optarg);
2567 if (!(terse_version >= 2 && terse_version <= 5)) {
2568 log_err("fio: bad terse version format\n");
2574 if (!strcmp("always", optarg))
2575 eta_print = FIO_ETA_ALWAYS;
2576 else if (!strcmp("never", optarg))
2577 eta_print = FIO_ETA_NEVER;
2582 if (check_str_time(optarg, &t, 1)) {
2583 log_err("fio: failed parsing eta time %s\n", optarg);
2588 eta_new_line = t / 1000;
2589 if (!eta_new_line) {
2590 log_err("fio: eta new line time too short\n");
2599 if (check_str_time(optarg, &t, 1)) {
2600 log_err("fio: failed parsing eta interval %s\n", optarg);
2605 eta_interval_msec = t / 1000;
2606 if (eta_interval_msec < DISK_UTIL_MSEC) {
2607 log_err("fio: eta interval time too short (%umsec min)\n", DISK_UTIL_MSEC);
2614 if (set_debug(optarg))
2624 if (!strcmp(optarg, "global")) {
2625 log_err("fio: can't use global as only "
2631 new_size = (nr_job_sections + 1) * sizeof(char *);
2632 job_sections = realloc(job_sections, new_size);
2633 job_sections[nr_job_sections] = strdup(optarg);
2639 exit_val = iolog_file_inflate(optarg);
2648 exec_profile = strdup(optarg);
2650 case FIO_GETOPT_JOB: {
2651 const char *opt = l_opts[lidx].name;
2654 if (!strncmp(opt, "name", 4) && td) {
2655 ret = add_job(td, td->o.name ?: "fio", 0, 0, client_type);
2662 int is_section = !strncmp(opt, "name", 4);
2665 if (!is_section || !strncmp(val, "global", 6))
2668 if (is_section && skip_this_section(val))
2671 td = get_new_job(global, &def_thread, true, NULL);
2672 if (!td || ioengine_load(td)) {
2681 fio_options_set_ioengine_opts(l_opts, td);
2684 if ((!val || !strlen(val)) &&
2685 l_opts[lidx].has_arg == required_argument) {
2686 log_err("fio: option %s requires an argument\n", opt);
2689 ret = fio_cmd_option_parse(td, opt, val);
2700 if (!ret && !strcmp(opt, "ioengine")) {
2701 if (ioengine_load(td)) {
2708 fio_options_set_ioengine_opts(l_opts, td);
2712 case FIO_GETOPT_IOENGINE: {
2713 const char *opt = l_opts[lidx].name;
2719 ret = fio_cmd_ioengine_option_parse(td, opt, val);
2726 max_jobs = atoi(optarg);
2727 if (!max_jobs || max_jobs > REAL_MAX_JOBS) {
2728 log_err("fio: invalid max jobs: %d\n", max_jobs);
2735 #ifndef CONFIG_NO_SHM
2737 log_err("fio: can't be both client and server\n");
2743 fio_server_set_arg(optarg);
2747 log_err("fio: client/server requires SHM support\n");
2755 pid_file = strdup(optarg);
2758 if ((ret = fio_idle_prof_parse_opt(optarg))) {
2759 /* exit on error and calibration only */
2769 log_err("fio: can't be both client and server\n");
2774 /* if --client parameter contains a pathname */
2775 if (0 == access(optarg, R_OK)) {
2776 /* file contains a list of host addrs or names */
2777 char hostaddr[PATH_MAX] = {0};
2779 FILE * hostf = fopen(optarg, "r");
2781 log_err("fio: could not open client list file %s for read\n", optarg);
2786 sprintf(formatstr, "%%%ds", PATH_MAX - 1);
2788 * read at most PATH_MAX-1 chars from each
2789 * record in this file
2791 while (fscanf(hostf, formatstr, hostaddr) == 1) {
2792 /* expect EVERY host in file to be valid */
2793 if (fio_client_add(&fio_client_ops, hostaddr, &cur_client)) {
2794 log_err("fio: failed adding client %s from file %s\n", hostaddr, optarg);
2801 break; /* no possibility of job file for "this client only" */
2803 if (fio_client_add(&fio_client_ops, optarg, &cur_client)) {
2804 log_err("fio: failed adding client %s\n", optarg);
2810 * If the next argument exists and isn't an option,
2811 * assume it's a job file for this client only.
2813 while (optind < argc) {
2814 if (!strncmp(argv[optind], "--", 2) ||
2815 !strncmp(argv[optind], "-", 1))
2818 if (fio_client_add_ini_file(cur_client, argv[optind], false))
2825 if (fio_client_add_ini_file(cur_client, optarg, true)) {
2833 exit_val = fio_monotonic_clocktest(1);
2838 exit_val = fio_crctest(optarg);
2843 exit_val = fio_memcpy_test(optarg);
2848 if (check_str_time(optarg, &val, 1)) {
2849 log_err("fio: failed parsing time %s\n", optarg);
2855 log_err("fio: status interval too small\n");
2859 status_interval = val / 1000;
2865 trigger_file = strdup(optarg);
2870 trigger_cmd = strdup(optarg);
2873 if (trigger_remote_cmd)
2874 free(trigger_remote_cmd);
2875 trigger_remote_cmd = strdup(optarg);
2880 aux_path = strdup(optarg);
2883 if (check_str_time(optarg, &trigger_timeout, 1)) {
2884 log_err("fio: failed parsing time %s\n", optarg);
2888 trigger_timeout /= 1000000;
2893 merge_blktrace_only = true;
2896 log_err("%s: unrecognized option '%s'\n", argv[0],
2898 show_closest_option(argv[optind - 1]);
2909 if (do_exit && !(is_backend || nr_clients))
2912 if (nr_clients && fio_clients_connect())
2915 if (is_backend && backend)
2916 return fio_start_server(pid_file);
2922 ret = add_job(td, td->o.name ?: "fio", 0, 0, client_type);
2928 while (!ret && optind < argc) {
2930 ini_file = realloc(ini_file, ini_idx * sizeof(char *));
2931 ini_file[ini_idx - 1] = strdup(argv[optind]);
2939 int fio_init_options(void)
2944 fio_options_fill_optstring();
2945 fio_options_dup_and_init(l_opts);
2949 if (fill_def_thread())
2955 extern int fio_check_options(struct thread_options *);
2957 int parse_options(int argc, char *argv[])
2959 const int type = FIO_CLIENT_TYPE_CLI;
2962 if (fio_init_options())
2964 if (fio_test_cconv(&def_thread.o))
2965 log_err("fio: failed internal cconv test\n");
2967 job_files = parse_cmd_line(argc, argv, type);
2969 if (job_files > 0) {
2970 for (i = 0; i < job_files; i++) {
2971 if (i && fill_def_thread())
2974 if (fio_clients_send_ini(ini_file[i]))
2977 } else if (!is_backend) {
2978 if (parse_jobs_ini(ini_file[i], 0, i, type))
2983 } else if (nr_clients) {
2984 if (fill_def_thread())
2986 if (fio_clients_send_ini(NULL))
2991 fio_options_free(&def_thread);
2992 filesetup_mem_free();
2994 if (!thread_number) {
2999 if (is_backend || nr_clients)
3004 log_err("No job(s) defined\n\n");
3009 if (output_format & FIO_OUTPUT_NORMAL)
3010 log_info("%s\n", fio_version_string);
3015 void options_default_fill(struct thread_options *o)
3017 memcpy(o, &def_thread.o, sizeof(*o));
3020 struct thread_data *get_global_options(void)