2 * This file contains job initialization and setup functions.
11 #include <sys/types.h>
13 #ifdef CONFIG_VALGRIND_DEV
14 #include <valgrind/drd.h>
16 #define DRD_IGNORE_VAR(x) do { } while (0)
20 #ifndef FIO_NO_HAVE_SHM_H
32 #include "steadystate.h"
35 #include "oslib/asprintf.h"
36 #include "oslib/getopt.h"
37 #include "oslib/strcasestr.h"
41 #include "lib/memcpy.h"
43 const char fio_version_string[] = FIO_VERSION;
45 #define FIO_RANDSEED (0xb1899bedUL)
47 static char **ini_file;
48 static bool dump_cmdline;
49 static bool parse_only;
50 static bool merge_blktrace_only;
52 static struct thread_data def_thread;
53 struct thread_segment segments[REAL_MAX_SEG];
54 static char **job_sections;
55 static int nr_job_sections;
57 bool exitall_on_terminate = false;
58 int output_format = FIO_OUTPUT_NORMAL;
59 int eta_print = FIO_ETA_AUTO;
60 unsigned int eta_interval_msec = 1000;
64 char *exec_profile = NULL;
65 int warnings_fatal = 0;
66 int terse_version = 3;
67 bool is_backend = false;
68 bool is_local_backend = false;
70 bool log_syslog = false;
72 bool write_bw_log = false;
73 bool read_only = false;
74 int status_interval = 0;
76 char *trigger_file = NULL;
77 long long trigger_timeout = 0;
78 char *trigger_cmd = NULL;
79 char *trigger_remote_cmd = NULL;
81 char *aux_path = NULL;
83 static int prev_group_jobs;
85 unsigned long fio_debug = 0;
86 unsigned int fio_debug_jobno = -1;
87 unsigned int *fio_debug_jobp = NULL;
88 unsigned int *fio_warned = NULL;
90 static char cmd_optstr[256];
93 #define FIO_CLIENT_FLAG (1 << 16)
96 * Command line options. These will contain the above, plus a few
97 * extra that only pertain to fio itself and not jobs.
99 static struct option l_opts[FIO_NR_OPTIONS] = {
101 .name = (char *) "output",
102 .has_arg = required_argument,
103 .val = 'o' | FIO_CLIENT_FLAG,
106 .name = (char *) "latency-log",
107 .has_arg = required_argument,
108 .val = 'l' | FIO_CLIENT_FLAG,
111 .name = (char *) "bandwidth-log",
112 .has_arg = no_argument,
113 .val = 'b' | FIO_CLIENT_FLAG,
116 .name = (char *) "minimal",
117 .has_arg = no_argument,
118 .val = 'm' | FIO_CLIENT_FLAG,
121 .name = (char *) "output-format",
122 .has_arg = required_argument,
123 .val = 'F' | FIO_CLIENT_FLAG,
126 .name = (char *) "append-terse",
127 .has_arg = optional_argument,
131 .name = (char *) "version",
132 .has_arg = no_argument,
133 .val = 'v' | FIO_CLIENT_FLAG,
136 .name = (char *) "help",
137 .has_arg = no_argument,
138 .val = 'h' | FIO_CLIENT_FLAG,
141 .name = (char *) "cmdhelp",
142 .has_arg = optional_argument,
143 .val = 'c' | FIO_CLIENT_FLAG,
146 .name = (char *) "enghelp",
147 .has_arg = optional_argument,
148 .val = 'i' | FIO_CLIENT_FLAG,
151 .name = (char *) "showcmd",
152 .has_arg = no_argument,
153 .val = 's' | FIO_CLIENT_FLAG,
156 .name = (char *) "readonly",
157 .has_arg = no_argument,
158 .val = 'r' | FIO_CLIENT_FLAG,
161 .name = (char *) "eta",
162 .has_arg = required_argument,
163 .val = 'e' | FIO_CLIENT_FLAG,
166 .name = (char *) "eta-interval",
167 .has_arg = required_argument,
168 .val = 'O' | FIO_CLIENT_FLAG,
171 .name = (char *) "eta-newline",
172 .has_arg = required_argument,
173 .val = 'E' | FIO_CLIENT_FLAG,
176 .name = (char *) "debug",
177 .has_arg = required_argument,
178 .val = 'd' | FIO_CLIENT_FLAG,
181 .name = (char *) "parse-only",
182 .has_arg = no_argument,
183 .val = 'P' | FIO_CLIENT_FLAG,
186 .name = (char *) "section",
187 .has_arg = required_argument,
188 .val = 'x' | FIO_CLIENT_FLAG,
192 .name = (char *) "inflate-log",
193 .has_arg = required_argument,
194 .val = 'X' | FIO_CLIENT_FLAG,
198 .name = (char *) "alloc-size",
199 .has_arg = required_argument,
200 .val = 'a' | FIO_CLIENT_FLAG,
203 .name = (char *) "profile",
204 .has_arg = required_argument,
205 .val = 'p' | FIO_CLIENT_FLAG,
208 .name = (char *) "warnings-fatal",
209 .has_arg = no_argument,
210 .val = 'w' | FIO_CLIENT_FLAG,
213 .name = (char *) "max-jobs",
214 .has_arg = required_argument,
215 .val = 'j' | FIO_CLIENT_FLAG,
218 .name = (char *) "terse-version",
219 .has_arg = required_argument,
220 .val = 'V' | FIO_CLIENT_FLAG,
223 .name = (char *) "server",
224 .has_arg = optional_argument,
227 { .name = (char *) "daemonize",
228 .has_arg = required_argument,
232 .name = (char *) "client",
233 .has_arg = required_argument,
237 .name = (char *) "remote-config",
238 .has_arg = required_argument,
242 .name = (char *) "cpuclock-test",
243 .has_arg = no_argument,
247 .name = (char *) "crctest",
248 .has_arg = optional_argument,
252 .name = (char *) "memcpytest",
253 .has_arg = optional_argument,
257 .name = (char *) "idle-prof",
258 .has_arg = required_argument,
262 .name = (char *) "status-interval",
263 .has_arg = required_argument,
264 .val = 'L' | FIO_CLIENT_FLAG,
267 .name = (char *) "trigger-file",
268 .has_arg = required_argument,
272 .name = (char *) "trigger-timeout",
273 .has_arg = required_argument,
277 .name = (char *) "trigger",
278 .has_arg = required_argument,
282 .name = (char *) "trigger-remote",
283 .has_arg = required_argument,
287 .name = (char *) "aux-path",
288 .has_arg = required_argument,
292 .name = (char *) "merge-blktrace-only",
293 .has_arg = no_argument,
294 .val = 'A' | FIO_CLIENT_FLAG,
301 void free_threads_shm(void)
305 for (i = 0; i < nr_segments; i++) {
306 struct thread_segment *seg = &segments[i];
309 void *tp = seg->threads;
310 #ifndef CONFIG_NO_SHM
311 struct shmid_ds sbuf;
315 shmctl(seg->shm_id, IPC_RMID, &sbuf);
328 static void free_shm(void)
330 #ifndef FUZZING_BUILD_MODE_UNSAFE_FOR_PRODUCTION
333 fio_debug_jobp = NULL;
340 free(trigger_remote_cmd);
341 trigger_file = trigger_cmd = trigger_remote_cmd = NULL;
343 options_free(fio_options, &def_thread.o);
350 static int add_thread_segment(void)
352 struct thread_segment *seg = &segments[nr_segments];
353 size_t size = JOBS_PER_SEG * sizeof(struct thread_data);
356 if (nr_segments + 1 >= REAL_MAX_SEG) {
357 log_err("error: maximum number of jobs reached.\n");
361 size += 2 * sizeof(unsigned int);
363 #ifndef CONFIG_NO_SHM
364 seg->shm_id = shmget(0, size, IPC_CREAT | 0600);
365 if (seg->shm_id == -1) {
366 if (errno != EINVAL && errno != ENOMEM && errno != ENOSPC)
371 seg->threads = malloc(size);
376 #ifndef CONFIG_NO_SHM
377 seg->threads = shmat(seg->shm_id, NULL, 0);
378 if (seg->threads == (void *) -1) {
382 if (shm_attach_to_open_removed())
383 shmctl(seg->shm_id, IPC_RMID, NULL);
388 memset(seg->threads, 0, JOBS_PER_SEG * sizeof(struct thread_data));
389 for (i = 0; i < JOBS_PER_SEG; i++)
390 DRD_IGNORE_VAR(seg->threads[i]);
393 /* Not first segment, we're done */
394 if (nr_segments != 1) {
399 fio_debug_jobp = (unsigned int *)(seg->threads + JOBS_PER_SEG);
400 *fio_debug_jobp = -1;
401 fio_warned = fio_debug_jobp + 1;
409 * The thread areas are shared between the main process and the job
410 * threads/processes, and is split into chunks of JOBS_PER_SEG. If the current
411 * segment has no more room, add a new chunk.
413 static int expand_thread_area(void)
415 struct thread_segment *seg = &segments[cur_segment];
417 if (nr_segments && seg->nr_threads < JOBS_PER_SEG)
420 return add_thread_segment();
423 static void dump_print_option(struct print_option *p)
427 if (!strcmp("description", p->name))
432 log_info("--%s%s", p->name, p->value ? "" : " ");
434 log_info("=%s%s%s ", delim, p->value, delim);
437 static void dump_opt_list(struct thread_data *td)
439 struct flist_head *entry;
440 struct print_option *p;
442 if (flist_empty(&td->opt_list))
445 flist_for_each(entry, &td->opt_list) {
446 p = flist_entry(entry, struct print_option, list);
447 dump_print_option(p);
451 static void copy_opt_list(struct thread_data *dst, struct thread_data *src)
453 struct flist_head *entry;
455 if (flist_empty(&src->opt_list))
458 flist_for_each(entry, &src->opt_list) {
459 struct print_option *srcp, *dstp;
461 srcp = flist_entry(entry, struct print_option, list);
462 dstp = malloc(sizeof(*dstp));
463 dstp->name = strdup(srcp->name);
465 dstp->value = strdup(srcp->value);
468 flist_add_tail(&dstp->list, &dst->opt_list);
473 * Return a free job structure.
475 static struct thread_data *get_new_job(bool global, struct thread_data *parent,
476 bool preserve_eo, const char *jobname)
478 struct thread_segment *seg;
479 struct thread_data *td;
483 if (expand_thread_area()) {
484 log_err("error: failed to setup shm segment\n");
488 seg = &segments[cur_segment];
489 td = &seg->threads[seg->nr_threads++];
493 INIT_FLIST_HEAD(&td->opt_list);
494 if (parent != &def_thread)
495 copy_opt_list(td, parent);
502 td->o.uid = td->o.gid = -1U;
504 dup_files(td, parent);
505 fio_options_mem_dupe(td);
507 profile_add_hooks(td);
509 td->thread_number = thread_number;
510 td->subjob_number = 0;
513 td->o.name = strdup(jobname);
515 if (!parent->o.group_reporting || parent == &def_thread)
521 static void put_job(struct thread_data *td)
523 if (td == &def_thread)
530 log_info("fio: %s\n", td->verror);
532 fio_options_free(td);
533 fio_dump_options_free(td);
540 memset(td, 0, sizeof(*td));
541 segments[cur_segment].nr_threads--;
545 static int __setup_rate(struct thread_data *td, enum fio_ddir ddir)
547 unsigned long long bs = td->o.min_bs[ddir];
549 assert(ddir_rw(ddir));
551 if (td->o.rate[ddir])
552 td->rate_bps[ddir] = td->o.rate[ddir];
554 td->rate_bps[ddir] = (uint64_t) td->o.rate_iops[ddir] * bs;
556 if (!td->rate_bps[ddir]) {
557 log_err("rate lower than supported\n");
561 td->rate_next_io_time[ddir] = 0;
562 td->rate_io_issue_bytes[ddir] = 0;
563 td->last_usec[ddir] = 0;
567 static int setup_rate(struct thread_data *td)
571 for_each_rw_ddir(ddir) {
572 if (td->o.rate[ddir] || td->o.rate_iops[ddir]) {
573 ret |= __setup_rate(td, ddir);
579 static int fixed_block_size(struct thread_options *o)
581 return o->min_bs[DDIR_READ] == o->max_bs[DDIR_READ] &&
582 o->min_bs[DDIR_WRITE] == o->max_bs[DDIR_WRITE] &&
583 o->min_bs[DDIR_TRIM] == o->max_bs[DDIR_TRIM] &&
584 o->min_bs[DDIR_READ] == o->min_bs[DDIR_WRITE] &&
585 o->min_bs[DDIR_READ] == o->min_bs[DDIR_TRIM];
591 static unsigned int gcd(unsigned int m, unsigned int n)
596 return gcd(n, m % n);
600 * Lazy way of fixing up options that depend on each other. We could also
601 * define option callback handlers, but this is easier.
603 static int fixup_options(struct thread_data *td)
605 struct thread_options *o = &td->o;
608 if (read_only && (td_write(td) || td_trim(td))) {
609 log_err("fio: trim and write operations are not allowed"
610 " with the --readonly parameter.\n");
614 #ifndef CONFIG_PSHARED
615 if (!o->use_thread) {
616 log_info("fio: this platform does not support process shared"
617 " mutexes, forcing use of threads. Use the 'thread'"
618 " option to get rid of this warning.\n");
620 ret |= warnings_fatal;
624 if (o->write_iolog_file && o->read_iolog_file) {
625 log_err("fio: read iolog overrides write_iolog\n");
626 free(o->write_iolog_file);
627 o->write_iolog_file = NULL;
628 ret |= warnings_fatal;
631 if (o->zone_mode == ZONE_MODE_NONE && o->zone_size) {
632 log_err("fio: --zonemode=none and --zonesize are not compatible.\n");
636 if (o->zone_mode == ZONE_MODE_STRIDED && !o->zone_size) {
637 log_err("fio: --zonesize must be specified when using --zonemode=strided.\n");
641 if (o->zone_mode == ZONE_MODE_NOT_SPECIFIED) {
643 o->zone_mode = ZONE_MODE_STRIDED;
645 o->zone_mode = ZONE_MODE_NONE;
649 * Strided zone mode only really works with 1 file.
651 if (o->zone_mode == ZONE_MODE_STRIDED && o->open_files > 1)
652 o->zone_mode = ZONE_MODE_NONE;
655 * If zone_range isn't specified, backward compatibility dictates it
656 * should be made equal to zone_size.
658 if (o->zone_mode == ZONE_MODE_STRIDED && !o->zone_range)
659 o->zone_range = o->zone_size;
662 * Reads can do overwrites, we always need to pre-create the file
667 for_each_rw_ddir(ddir) {
668 if (!o->min_bs[ddir])
669 o->min_bs[ddir] = o->bs[ddir];
670 if (!o->max_bs[ddir])
671 o->max_bs[ddir] = o->bs[ddir];
675 for_each_rw_ddir(ddir) {
676 o->rw_min_bs = min(o->rw_min_bs, o->min_bs[ddir]);
680 * For random IO, allow blockalign offset other than min_bs.
682 for_each_rw_ddir(ddir) {
683 if (!o->ba[ddir] || !td_random(td))
684 o->ba[ddir] = o->min_bs[ddir];
687 if ((o->ba[DDIR_READ] != o->min_bs[DDIR_READ] ||
688 o->ba[DDIR_WRITE] != o->min_bs[DDIR_WRITE] ||
689 o->ba[DDIR_TRIM] != o->min_bs[DDIR_TRIM]) &&
691 log_err("fio: Any use of blockalign= turns off randommap\n");
693 ret |= warnings_fatal;
696 if (!o->file_size_high)
697 o->file_size_high = o->file_size_low;
699 if (o->start_delay_high) {
700 if (!o->start_delay_orig)
701 o->start_delay_orig = o->start_delay;
702 o->start_delay = rand_between(&td->delay_state,
704 o->start_delay_high);
707 if (o->norandommap && o->verify != VERIFY_NONE
708 && !fixed_block_size(o)) {
709 log_err("fio: norandommap given for variable block sizes, "
711 ret |= warnings_fatal;
713 if (o->bs_unaligned && (o->odirect || td_ioengine_flagged(td, FIO_RAWIO)))
714 log_err("fio: bs_unaligned may not work with raw io\n");
717 * thinktime_spin must be less than thinktime
719 if (o->thinktime_spin > o->thinktime)
720 o->thinktime_spin = o->thinktime;
723 * The low water mark cannot be bigger than the iodepth
725 if (o->iodepth_low > o->iodepth || !o->iodepth_low)
726 o->iodepth_low = o->iodepth;
729 * If batch number isn't set, default to the same as iodepth
731 if (o->iodepth_batch > o->iodepth || !o->iodepth_batch)
732 o->iodepth_batch = o->iodepth;
735 * If max batch complete number isn't set or set incorrectly,
736 * default to the same as iodepth_batch_complete_min
738 if (o->iodepth_batch_complete_min > o->iodepth_batch_complete_max)
739 o->iodepth_batch_complete_max = o->iodepth_batch_complete_min;
742 * There's no need to check for in-flight overlapping IOs if the job
743 * isn't changing data or the maximum iodepth is guaranteed to be 1
744 * when we are not in offload mode
746 if (o->serialize_overlap && !(td->flags & TD_F_READ_IOLOG) &&
747 (!(td_write(td) || td_trim(td)) || o->iodepth == 1) &&
748 o->io_submit_mode != IO_MODE_OFFLOAD)
749 o->serialize_overlap = 0;
751 if (o->nr_files > td->files_index)
752 o->nr_files = td->files_index;
754 if (o->open_files > o->nr_files || !o->open_files)
755 o->open_files = o->nr_files;
757 if (((o->rate[DDIR_READ] + o->rate[DDIR_WRITE] + o->rate[DDIR_TRIM]) &&
758 (o->rate_iops[DDIR_READ] + o->rate_iops[DDIR_WRITE] + o->rate_iops[DDIR_TRIM])) ||
759 ((o->ratemin[DDIR_READ] + o->ratemin[DDIR_WRITE] + o->ratemin[DDIR_TRIM]) &&
760 (o->rate_iops_min[DDIR_READ] + o->rate_iops_min[DDIR_WRITE] + o->rate_iops_min[DDIR_TRIM]))) {
761 log_err("fio: rate and rate_iops are mutually exclusive\n");
764 for_each_rw_ddir(ddir) {
765 if ((o->rate[ddir] && (o->rate[ddir] < o->ratemin[ddir])) ||
766 (o->rate_iops[ddir] && (o->rate_iops[ddir] < o->rate_iops_min[ddir]))) {
767 log_err("fio: minimum rate exceeds rate, ddir %d\n", +ddir);
772 if (!o->timeout && o->time_based) {
773 log_err("fio: time_based requires a runtime/timeout setting\n");
775 ret |= warnings_fatal;
778 if (o->fill_device && !o->size)
781 if (o->verify != VERIFY_NONE) {
782 if (td_write(td) && o->do_verify && o->numjobs > 1 &&
784 !(o->unique_filename &&
785 strstr(o->filename_format, "$jobname") &&
786 strstr(o->filename_format, "$jobnum") &&
787 strstr(o->filename_format, "$filenum")))) {
788 log_info("fio: multiple writers may overwrite blocks "
789 "that belong to other jobs. This can cause "
790 "verification failures.\n");
791 ret |= warnings_fatal;
795 * Warn if verification is requested but no verification of any
796 * kind can be started due to time constraints
798 if (td_write(td) && o->do_verify && o->timeout &&
799 o->time_based && !td_read(td) && !o->verify_backlog) {
800 log_info("fio: verification read phase will never "
801 "start because write phase uses all of "
803 ret |= warnings_fatal;
806 if (!fio_option_is_set(o, refill_buffers))
807 o->refill_buffers = 1;
809 if (o->max_bs[DDIR_WRITE] != o->min_bs[DDIR_WRITE] &&
811 o->verify_interval = o->min_bs[DDIR_WRITE];
814 * Verify interval must be smaller or equal to the
817 if (o->verify_interval > o->min_bs[DDIR_WRITE])
818 o->verify_interval = o->min_bs[DDIR_WRITE];
819 else if (td_read(td) && o->verify_interval > o->min_bs[DDIR_READ])
820 o->verify_interval = o->min_bs[DDIR_READ];
823 * Verify interval must be a factor of both min and max
826 if (!o->verify_interval ||
827 (o->min_bs[DDIR_WRITE] % o->verify_interval) ||
828 (o->max_bs[DDIR_WRITE] % o->verify_interval))
829 o->verify_interval = gcd(o->min_bs[DDIR_WRITE],
830 o->max_bs[DDIR_WRITE]);
834 if (o->invalidate_cache)
835 o->invalidate_cache = 0;
836 if (td_ioengine_flagged(td, FIO_PIPEIO)) {
837 log_info("fio: cannot pre-read files with an IO engine"
838 " that isn't seekable. Pre-read disabled.\n");
839 ret |= warnings_fatal;
843 if (o->unit_base == N2S_NONE) {
844 if (td_ioengine_flagged(td, FIO_BIT_BASED))
845 o->unit_base = N2S_BITPERSEC;
847 o->unit_base = N2S_BYTEPERSEC;
850 #ifndef CONFIG_FDATASYNC
851 if (o->fdatasync_blocks) {
852 log_info("fio: this platform does not support fdatasync()"
853 " falling back to using fsync(). Use the 'fsync'"
854 " option instead of 'fdatasync' to get rid of"
856 o->fsync_blocks = o->fdatasync_blocks;
857 o->fdatasync_blocks = 0;
858 ret |= warnings_fatal;
864 * Windows doesn't support O_DIRECT or O_SYNC with the _open interface,
865 * so fail if we're passed those flags
867 if (td_ioengine_flagged(td, FIO_SYNCIO) && (o->odirect || o->sync_io)) {
868 log_err("fio: Windows does not support direct or non-buffered io with"
869 " the synchronous ioengines. Use the 'windowsaio' ioengine"
870 " with 'direct=1' and 'iodepth=1' instead.\n");
876 * For fully compressible data, just zero them at init time.
877 * It's faster than repeatedly filling it. For non-zero
878 * compression, we should have refill_buffers set. Set it, unless
879 * the job file already changed it.
881 if (o->compress_percentage) {
882 if (o->compress_percentage == 100) {
884 o->compress_percentage = 0;
885 } else if (!fio_option_is_set(o, refill_buffers)) {
886 o->refill_buffers = 1;
887 td->flags |= TD_F_REFILL_BUFFERS;
892 * Using a non-uniform random distribution excludes usage of
895 if (o->random_distribution != FIO_RAND_DIST_RANDOM)
899 * If size is set but less than the min block size, complain
901 if (o->size && o->size < td_min_bs(td)) {
902 log_err("fio: size too small, must not be less than minimum block size: %llu < %llu\n",
903 (unsigned long long) o->size, td_min_bs(td));
908 * O_ATOMIC implies O_DIRECT
914 * If randseed is set, that overrides randrepeat
916 if (fio_option_is_set(o, rand_seed))
917 o->rand_repeatable = 0;
919 if (td_ioengine_flagged(td, FIO_NOEXTEND) && o->file_append) {
920 log_err("fio: can't append/extent with IO engine %s\n", td->io_ops->name);
924 if (fio_option_is_set(o, gtod_cpu)) {
926 fio_gtod_set_cpu(o->gtod_cpu);
927 fio_gtod_offload = 1;
930 td->loops = o->loops;
934 if (o->block_error_hist && o->nr_files != 1) {
935 log_err("fio: block error histogram only available "
936 "with a single file per job, but %d files "
937 "provided\n", o->nr_files);
942 o->lat_percentiles = 0;
944 o->clat_percentiles = 0;
946 o->slat_percentiles = 0;
949 * Fix these up to be nsec internally
951 o->max_latency *= 1000ULL;
952 o->latency_target *= 1000ULL;
957 static void init_rand_file_service(struct thread_data *td)
959 unsigned long nranges = td->o.nr_files << FIO_FSERVICE_SHIFT;
960 const unsigned int seed = td->rand_seeds[FIO_RAND_FILE_OFF];
962 if (td->o.file_service_type == FIO_FSERVICE_ZIPF) {
963 zipf_init(&td->next_file_zipf, nranges, td->zipf_theta, td->random_center, seed);
964 zipf_disable_hash(&td->next_file_zipf);
965 } else if (td->o.file_service_type == FIO_FSERVICE_PARETO) {
966 pareto_init(&td->next_file_zipf, nranges, td->pareto_h, td->random_center, seed);
967 zipf_disable_hash(&td->next_file_zipf);
968 } else if (td->o.file_service_type == FIO_FSERVICE_GAUSS) {
969 gauss_init(&td->next_file_gauss, nranges, td->gauss_dev, td->random_center, seed);
970 gauss_disable_hash(&td->next_file_gauss);
974 void td_fill_verify_state_seed(struct thread_data *td)
978 if (td->o.random_generator == FIO_RAND_GEN_TAUSWORTHE64)
983 init_rand_seed(&td->verify_state, td->rand_seeds[FIO_RAND_VER_OFF],
987 static void td_fill_rand_seeds_internal(struct thread_data *td, bool use64)
989 uint64_t read_seed = td->rand_seeds[FIO_RAND_BS_OFF];
990 uint64_t write_seed = td->rand_seeds[FIO_RAND_BS1_OFF];
991 uint64_t trim_seed = td->rand_seeds[FIO_RAND_BS2_OFF];
995 * trimwrite is special in that we need to generate the same
996 * offsets to get the "write after trim" effect. If we are
997 * using bssplit to set buffer length distributions, ensure that
998 * we seed the trim and write generators identically. Ditto for
999 * verify, read and writes must have the same seed, if we are doing
1002 if (td->o.verify != VERIFY_NONE)
1003 write_seed = read_seed;
1004 if (td_trimwrite(td))
1005 trim_seed = write_seed;
1006 init_rand_seed(&td->bsrange_state[DDIR_READ], read_seed, use64);
1007 init_rand_seed(&td->bsrange_state[DDIR_WRITE], write_seed, use64);
1008 init_rand_seed(&td->bsrange_state[DDIR_TRIM], trim_seed, use64);
1010 td_fill_verify_state_seed(td);
1011 init_rand_seed(&td->rwmix_state, td->rand_seeds[FIO_RAND_MIX_OFF], false);
1013 if (td->o.file_service_type == FIO_FSERVICE_RANDOM)
1014 init_rand_seed(&td->next_file_state, td->rand_seeds[FIO_RAND_FILE_OFF], use64);
1015 else if (td->o.file_service_type & __FIO_FSERVICE_NONUNIFORM)
1016 init_rand_file_service(td);
1018 init_rand_seed(&td->file_size_state, td->rand_seeds[FIO_RAND_FILE_SIZE_OFF], use64);
1019 init_rand_seed(&td->trim_state, td->rand_seeds[FIO_RAND_TRIM_OFF], use64);
1020 init_rand_seed(&td->delay_state, td->rand_seeds[FIO_RAND_START_DELAY], use64);
1021 init_rand_seed(&td->poisson_state[0], td->rand_seeds[FIO_RAND_POISSON_OFF], 0);
1022 init_rand_seed(&td->poisson_state[1], td->rand_seeds[FIO_RAND_POISSON2_OFF], 0);
1023 init_rand_seed(&td->poisson_state[2], td->rand_seeds[FIO_RAND_POISSON3_OFF], 0);
1024 init_rand_seed(&td->dedupe_state, td->rand_seeds[FIO_DEDUPE_OFF], false);
1025 init_rand_seed(&td->zone_state, td->rand_seeds[FIO_RAND_ZONE_OFF], false);
1026 init_rand_seed(&td->prio_state, td->rand_seeds[FIO_RAND_PRIO_CMDS], false);
1031 if (td->o.rand_repeatable)
1032 td->rand_seeds[FIO_RAND_BLOCK_OFF] = FIO_RANDSEED * td->thread_number;
1034 init_rand_seed(&td->random_state, td->rand_seeds[FIO_RAND_BLOCK_OFF], use64);
1036 for (i = 0; i < DDIR_RWDIR_CNT; i++) {
1037 struct frand_state *s = &td->seq_rand_state[i];
1039 init_rand_seed(s, td->rand_seeds[FIO_RAND_SEQ_RAND_READ_OFF], false);
1043 void td_fill_rand_seeds(struct thread_data *td)
1047 if (td->o.allrand_repeatable) {
1050 for (i = 0; i < FIO_RAND_NR_OFFS; i++)
1051 td->rand_seeds[i] = FIO_RANDSEED * td->thread_number
1055 if (td->o.random_generator == FIO_RAND_GEN_TAUSWORTHE64)
1060 td_fill_rand_seeds_internal(td, use64);
1062 init_rand_seed(&td->buf_state, td->rand_seeds[FIO_RAND_BUF_OFF], use64);
1063 frand_copy(&td->buf_state_prev, &td->buf_state);
1067 * Initializes the ioengine configured for a job, if it has not been done so
1070 int ioengine_load(struct thread_data *td)
1072 if (!td->o.ioengine) {
1073 log_err("fio: internal fault, no IO engine specified\n");
1078 struct ioengine_ops *ops;
1081 /* An engine is loaded, but the requested ioengine
1084 if (!strcmp(td->io_ops->name, td->o.ioengine)) {
1085 /* The right engine is already loaded */
1090 * Name of file and engine may be different, load ops
1091 * for this name and see if they match. If they do, then
1092 * the engine is unchanged.
1094 dlhandle = td->io_ops->dlhandle;
1095 ops = load_ioengine(td);
1099 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);
1232 static struct fpre_keyword {
1233 const char *keyword;
1236 } fpre_keywords[] = {
1237 { .keyword = "$jobname", .key = FPRE_JOBNAME, },
1238 { .keyword = "$jobnum", .key = FPRE_JOBNUM, },
1239 { .keyword = "$filenum", .key = FPRE_FILENUM, },
1240 { .keyword = "$clientuid", .key = FPRE_CLIENTUID, },
1241 { .keyword = NULL, },
1244 static char *make_filename(char *buf, size_t buf_size,struct thread_options *o,
1245 const char *jobname, int jobnum, int filenum)
1247 struct fpre_keyword *f;
1248 char copy[PATH_MAX];
1249 size_t dst_left = PATH_MAX - 1;
1251 if (!o->filename_format || !strlen(o->filename_format)) {
1252 sprintf(buf, "%s.%d.%d", jobname, jobnum, filenum);
1256 for (f = &fpre_keywords[0]; f->keyword; f++)
1257 f->strlen = strlen(f->keyword);
1259 snprintf(buf, buf_size, "%s", o->filename_format);
1261 memset(copy, 0, sizeof(copy));
1262 for (f = &fpre_keywords[0]; f->keyword; f++) {
1264 size_t pre_len, post_start = 0;
1265 char *str, *dst = copy;
1267 str = strcasestr(buf, f->keyword);
1271 pre_len = str - buf;
1272 if (strlen(str) != f->strlen)
1273 post_start = pre_len + f->strlen;
1276 strncpy(dst, buf, pre_len);
1278 dst_left -= pre_len;
1282 case FPRE_JOBNAME: {
1285 ret = snprintf(dst, dst_left, "%s", jobname);
1288 else if (ret > dst_left) {
1289 log_err("fio: truncated filename\n");
1301 ret = snprintf(dst, dst_left, "%d", jobnum);
1304 else if (ret > dst_left) {
1305 log_err("fio: truncated filename\n");
1314 case FPRE_FILENUM: {
1317 ret = snprintf(dst, dst_left, "%d", filenum);
1320 else if (ret > dst_left) {
1321 log_err("fio: truncated filename\n");
1330 case FPRE_CLIENTUID: {
1332 ret = snprintf(dst, dst_left, "%s", client_sockaddr_str);
1335 else if (ret > dst_left) {
1336 log_err("fio: truncated filename\n");
1351 strncpy(dst, buf + post_start, dst_left);
1353 snprintf(buf, buf_size, "%s", copy);
1360 bool parse_dryrun(void)
1362 return dump_cmdline || parse_only;
1365 static void gen_log_name(char *name, size_t size, const char *logtype,
1366 const char *logname, unsigned int num,
1367 const char *suf, int per_job)
1370 snprintf(name, size, "%s_%s.%d.%s", logname, logtype, num, suf);
1372 snprintf(name, size, "%s_%s.%s", logname, logtype, suf);
1375 static int check_waitees(char *waitee)
1377 struct thread_data *td;
1380 for_each_td(td, i) {
1381 if (td->subjob_number)
1384 ret += !strcmp(td->o.name, waitee);
1390 static bool wait_for_ok(const char *jobname, struct thread_options *o)
1397 if (!strcmp(jobname, o->wait_for)) {
1398 log_err("%s: a job cannot wait for itself (wait_for=%s).\n",
1399 jobname, o->wait_for);
1403 if (!(nw = check_waitees(o->wait_for))) {
1404 log_err("%s: waitee job %s unknown.\n", jobname, o->wait_for);
1409 log_err("%s: multiple waitees %s found,\n"
1410 "please avoid duplicates when using wait_for option.\n",
1411 jobname, o->wait_for);
1419 * Treat an empty log file name the same as a one not given
1421 static const char *make_log_name(const char *logname, const char *jobname)
1423 if (logname && strcmp(logname, ""))
1430 * Adds a job to the list of things todo. Sanitizes the various options
1431 * to make sure we don't have conflicts, and initializes various
1434 static int add_job(struct thread_data *td, const char *jobname, int job_add_num,
1435 int recursed, int client_type)
1438 char fname[PATH_MAX + 1];
1439 int numjobs, file_alloced;
1440 struct thread_options *o = &td->o;
1441 char logname[PATH_MAX + 32];
1444 * the def_thread is just for options, it's not a real job
1446 if (td == &def_thread)
1452 * if we are just dumping the output command line, don't add the job
1454 if (parse_dryrun()) {
1459 td->client_type = client_type;
1461 if (profile_td_init(td))
1464 if (ioengine_load(td))
1468 if (!o->filename && !td->files_index && !o->read_iolog_file) {
1471 if (o->nr_files == 1 && exists_and_not_regfile(jobname))
1472 add_file(td, jobname, job_add_num, 0);
1474 for (i = 0; i < o->nr_files; i++)
1475 add_file(td, make_filename(fname, sizeof(fname), o, jobname, job_add_num, i), job_add_num, 0);
1479 if (setup_random_seeds(td)) {
1480 td_verror(td, errno, "setup_random_seeds");
1484 if (fixup_options(td))
1488 * Belongs to fixup_options, but o->name is not necessarily set as yet
1490 if (!wait_for_ok(jobname, o))
1496 * IO engines only need this for option callbacks, and the address may
1497 * change in subprocesses.
1500 *(struct thread_data **)td->eo = NULL;
1502 if (td_ioengine_flagged(td, FIO_DISKLESSIO)) {
1505 for_each_file(td, f, i)
1506 f->real_file_size = -1ULL;
1509 td->sem = fio_sem_init(FIO_SEM_LOCKED);
1511 td->ts.clat_percentiles = o->clat_percentiles;
1512 td->ts.lat_percentiles = o->lat_percentiles;
1513 td->ts.slat_percentiles = o->slat_percentiles;
1514 td->ts.percentile_precision = o->percentile_precision;
1515 memcpy(td->ts.percentile_list, o->percentile_list, sizeof(o->percentile_list));
1516 td->ts.sig_figs = o->sig_figs;
1518 for (i = 0; i < DDIR_RWDIR_CNT; i++) {
1519 td->ts.clat_stat[i].min_val = ULONG_MAX;
1520 td->ts.slat_stat[i].min_val = ULONG_MAX;
1521 td->ts.lat_stat[i].min_val = ULONG_MAX;
1522 td->ts.bw_stat[i].min_val = ULONG_MAX;
1523 td->ts.iops_stat[i].min_val = ULONG_MAX;
1524 td->ts.clat_high_prio_stat[i].min_val = ULONG_MAX;
1525 td->ts.clat_low_prio_stat[i].min_val = ULONG_MAX;
1527 td->ts.sync_stat.min_val = ULONG_MAX;
1528 td->ddir_seq_nr = o->ddir_seq_nr;
1530 if ((o->stonewall || o->new_group) && prev_group_jobs) {
1531 prev_group_jobs = 0;
1533 if (groupid == INT_MAX) {
1534 log_err("fio: too many groups defined\n");
1539 td->groupid = groupid;
1545 if (o->write_lat_log) {
1546 struct log_params p = {
1548 .avg_msec = o->log_avg_msec,
1549 .hist_msec = o->log_hist_msec,
1550 .hist_coarseness = o->log_hist_coarseness,
1551 .log_type = IO_LOG_TYPE_LAT,
1552 .log_offset = o->log_offset,
1553 .log_gz = o->log_gz,
1554 .log_gz_store = o->log_gz_store,
1556 const char *pre = make_log_name(o->lat_log_file, o->name);
1564 gen_log_name(logname, sizeof(logname), "lat", pre,
1565 td->thread_number, suf, o->per_job_logs);
1566 setup_log(&td->lat_log, &p, logname);
1568 gen_log_name(logname, sizeof(logname), "slat", pre,
1569 td->thread_number, suf, o->per_job_logs);
1570 setup_log(&td->slat_log, &p, logname);
1572 gen_log_name(logname, sizeof(logname), "clat", pre,
1573 td->thread_number, suf, o->per_job_logs);
1574 setup_log(&td->clat_log, &p, logname);
1578 if (o->write_hist_log) {
1579 struct log_params p = {
1581 .avg_msec = o->log_avg_msec,
1582 .hist_msec = o->log_hist_msec,
1583 .hist_coarseness = o->log_hist_coarseness,
1584 .log_type = IO_LOG_TYPE_HIST,
1585 .log_offset = o->log_offset,
1586 .log_gz = o->log_gz,
1587 .log_gz_store = o->log_gz_store,
1589 const char *pre = make_log_name(o->hist_log_file, o->name);
1593 if (td->client_type) {
1594 log_err("fio: --write_hist_log requires zlib in client/server mode\n");
1604 gen_log_name(logname, sizeof(logname), "clat_hist", pre,
1605 td->thread_number, suf, o->per_job_logs);
1606 setup_log(&td->clat_hist_log, &p, logname);
1609 if (o->write_bw_log) {
1610 struct log_params p = {
1612 .avg_msec = o->log_avg_msec,
1613 .hist_msec = o->log_hist_msec,
1614 .hist_coarseness = o->log_hist_coarseness,
1615 .log_type = IO_LOG_TYPE_BW,
1616 .log_offset = o->log_offset,
1617 .log_gz = o->log_gz,
1618 .log_gz_store = o->log_gz_store,
1620 const char *pre = make_log_name(o->bw_log_file, o->name);
1623 if (fio_option_is_set(o, bw_avg_time))
1624 p.avg_msec = min(o->log_avg_msec, o->bw_avg_time);
1626 o->bw_avg_time = p.avg_msec;
1628 p.hist_msec = o->log_hist_msec;
1629 p.hist_coarseness = o->log_hist_coarseness;
1636 gen_log_name(logname, sizeof(logname), "bw", pre,
1637 td->thread_number, suf, o->per_job_logs);
1638 setup_log(&td->bw_log, &p, logname);
1640 if (o->write_iops_log) {
1641 struct log_params p = {
1643 .avg_msec = o->log_avg_msec,
1644 .hist_msec = o->log_hist_msec,
1645 .hist_coarseness = o->log_hist_coarseness,
1646 .log_type = IO_LOG_TYPE_IOPS,
1647 .log_offset = o->log_offset,
1648 .log_gz = o->log_gz,
1649 .log_gz_store = o->log_gz_store,
1651 const char *pre = make_log_name(o->iops_log_file, o->name);
1654 if (fio_option_is_set(o, iops_avg_time))
1655 p.avg_msec = min(o->log_avg_msec, o->iops_avg_time);
1657 o->iops_avg_time = p.avg_msec;
1659 p.hist_msec = o->log_hist_msec;
1660 p.hist_coarseness = o->log_hist_coarseness;
1667 gen_log_name(logname, sizeof(logname), "iops", pre,
1668 td->thread_number, suf, o->per_job_logs);
1669 setup_log(&td->iops_log, &p, logname);
1673 o->name = strdup(jobname);
1675 if (output_format & FIO_OUTPUT_NORMAL) {
1677 if (is_backend && !recursed)
1678 fio_server_send_add_job(td);
1680 if (!td_ioengine_flagged(td, FIO_NOIO)) {
1681 char *c1, *c2, *c3, *c4;
1682 char *c5 = NULL, *c6 = NULL;
1683 int i2p = is_power_of_2(o->kb_base);
1684 struct buf_output out;
1686 c1 = num2str(o->min_bs[DDIR_READ], o->sig_figs, 1, i2p, N2S_BYTE);
1687 c2 = num2str(o->max_bs[DDIR_READ], o->sig_figs, 1, i2p, N2S_BYTE);
1688 c3 = num2str(o->min_bs[DDIR_WRITE], o->sig_figs, 1, i2p, N2S_BYTE);
1689 c4 = num2str(o->max_bs[DDIR_WRITE], o->sig_figs, 1, i2p, N2S_BYTE);
1691 if (!o->bs_is_seq_rand) {
1692 c5 = num2str(o->min_bs[DDIR_TRIM], o->sig_figs, 1, i2p, N2S_BYTE);
1693 c6 = num2str(o->max_bs[DDIR_TRIM], o->sig_figs, 1, i2p, N2S_BYTE);
1696 buf_output_init(&out);
1697 __log_buf(&out, "%s: (g=%d): rw=%s, ", td->o.name,
1699 ddir_str(o->td_ddir));
1701 if (o->bs_is_seq_rand)
1702 __log_buf(&out, "bs=(R) %s-%s, (W) %s-%s, bs_is_seq_rand, ",
1705 __log_buf(&out, "bs=(R) %s-%s, (W) %s-%s, (T) %s-%s, ",
1706 c1, c2, c3, c4, c5, c6);
1708 __log_buf(&out, "ioengine=%s, iodepth=%u\n",
1709 td->io_ops->name, o->iodepth);
1710 log_info_buf(out.buf, out.buflen);
1711 buf_output_free(&out);
1720 } else if (job_add_num == 1)
1724 if (td_steadystate_init(td))
1727 if (o->merge_blktrace_file && !merge_blktrace_iologs(td))
1730 if (merge_blktrace_only) {
1736 * recurse add identical jobs, clear numjobs and stonewall options
1737 * as they don't apply to sub-jobs
1739 numjobs = o->numjobs;
1741 struct thread_data *td_new = get_new_job(false, td, true, jobname);
1746 td_new->o.numjobs = 1;
1747 td_new->o.stonewall = 0;
1748 td_new->o.new_group = 0;
1749 td_new->subjob_number = numjobs;
1750 td_new->o.ss_dur = o->ss_dur * 1000000l;
1751 td_new->o.ss_limit = o->ss_limit;
1754 if (td_new->files) {
1756 for_each_file(td_new, f, i)
1758 free(td_new->files);
1759 td_new->files = NULL;
1761 td_new->files_index = 0;
1762 td_new->files_size = 0;
1763 if (td_new->o.filename) {
1764 free(td_new->o.filename);
1765 td_new->o.filename = NULL;
1769 if (add_job(td_new, jobname, numjobs, 1, client_type))
1780 * Parse as if 'o' was a command line
1782 void add_job_opts(const char **o, int client_type)
1784 struct thread_data *td, *td_parent;
1785 int i, in_global = 1;
1789 td_parent = td = NULL;
1791 if (!strncmp(o[i], "name", 4)) {
1794 add_job(td, jobname, 0, 0, client_type);
1796 sprintf(jobname, "%s", o[i] + 5);
1798 if (in_global && !td_parent)
1799 td_parent = get_new_job(true, &def_thread, false, jobname);
1800 else if (!in_global && !td) {
1802 td_parent = &def_thread;
1803 td = get_new_job(false, td_parent, false, jobname);
1806 fio_options_parse(td_parent, (char **) &o[i], 1);
1808 fio_options_parse(td, (char **) &o[i], 1);
1813 add_job(td, jobname, 0, 0, client_type);
1816 static int skip_this_section(const char *name)
1820 if (!nr_job_sections)
1822 if (!strncmp(name, "global", 6))
1825 for (i = 0; i < nr_job_sections; i++)
1826 if (!strcmp(job_sections[i], name))
1832 static int is_empty_or_comment(char *line)
1836 for (i = 0; i < strlen(line); i++) {
1841 if (!isspace((int) line[i]) && !iscntrl((int) line[i]))
1849 * This is our [ini] type file parser.
1851 static int __parse_jobs_ini(struct thread_data *td,
1852 char *file, int is_buf, int stonewall_flag, int type,
1853 int nested, char *name, char ***popts, int *aopts, int *nopts)
1855 bool global = false;
1856 bool stdin_occupied = false;
1860 int ret = 0, stonewall;
1863 int inside_skip = 0;
1865 int i, alloc_opts, num_opts;
1867 dprint(FD_PARSE, "Parsing ini file %s\n", file);
1868 assert(td || !nested);
1873 if (!strcmp(file, "-")) {
1875 stdin_occupied = true;
1877 f = fopen(file, "r");
1882 log_err("fio: unable to open '%s' job file\n", file);
1884 td_verror(td, __err, "job file open");
1889 string = malloc(OPT_LEN_MAX);
1892 * it's really 256 + small bit, 280 should suffice
1896 memset(name, 0, 280);
1900 if (nested && popts) {
1902 alloc_opts = *aopts;
1908 opts = malloc(sizeof(char *) * alloc_opts);
1912 stonewall = stonewall_flag;
1915 * if skip_fgets is set, we already have loaded a line we
1920 p = strsep(&file, "\n");
1922 p = fgets(string, OPT_LEN_MAX, f);
1928 strip_blank_front(&p);
1931 dprint(FD_PARSE, "%s\n", p);
1932 if (is_empty_or_comment(p))
1936 if (sscanf(p, "[%255[^\n]]", name) != 1) {
1940 log_err("fio: option <%s> outside of "
1941 "[] job section\n", p);
1946 name[strlen(name) - 1] = '\0';
1948 if (skip_this_section(name)) {
1954 dprint(FD_PARSE, "Parsing section [%s]\n", name);
1956 global = !strncmp(name, "global", 6);
1962 log_info("--name=%s ", name);
1966 td = get_new_job(global, &def_thread, false, name);
1973 * Separate multiple job files by a stonewall
1975 if (!global && stonewall) {
1976 td->o.stonewall = stonewall;
1981 memset(opts, 0, alloc_opts * sizeof(char *));
1989 p = strsep(&file, "\n");
1991 p = fgets(string, OPT_LEN_MAX, f);
1994 dprint(FD_PARSE, "%s", p);
1999 if (is_empty_or_comment(p))
2002 strip_blank_front(&p);
2005 * new section, break out and make sure we don't
2006 * fgets() a new line at the top.
2010 log_err("No new sections in included files\n");
2021 if (!strncmp(p, "include", strlen("include"))) {
2022 char *filename = p + strlen("include") + 1,
2023 *ts, *full_fn = NULL;
2026 * Allow for the include filename
2027 * specification to be relative.
2029 if (access(filename, F_OK) &&
2030 (ts = strrchr(file, '/'))) {
2031 if (asprintf(&full_fn, "%.*s%s",
2032 (int)(ts - file + 1), file,
2040 ret = __parse_jobs_ini(td, filename, is_buf,
2041 stonewall_flag, type, 1,
2043 &alloc_opts, &num_opts);
2046 log_err("Error %d while parsing "
2047 "include file %s\n",
2060 if (num_opts == alloc_opts) {
2062 opts = realloc(opts,
2063 alloc_opts * sizeof(char *));
2066 opts[num_opts] = strdup(p);
2072 *aopts = alloc_opts;
2077 ret = fio_options_parse(td, opts, num_opts);
2079 if (!ret && td->o.read_iolog_file != NULL) {
2080 char *fname = get_name_by_idx(td->o.read_iolog_file,
2082 if (!strcmp(fname, "-")) {
2083 if (stdin_occupied) {
2084 log_err("fio: only one user (read_iolog_file/job "
2085 "file) of stdin is permitted at once but "
2086 "more than one was found.\n");
2089 stdin_occupied = true;
2096 ret = add_job(td, name, 0, 0, type);
2098 log_err("fio: job %s dropped\n", name);
2102 for (i = 0; i < num_opts; i++)
2111 while (i < nr_job_sections) {
2112 free(job_sections[i]);
2121 if (!is_buf && f != stdin)
2126 int parse_jobs_ini(char *file, int is_buf, int stonewall_flag, int type)
2128 return __parse_jobs_ini(NULL, file, is_buf, stonewall_flag, type,
2129 0, NULL, NULL, NULL, NULL);
2132 static int fill_def_thread(void)
2134 memset(&def_thread, 0, sizeof(def_thread));
2135 INIT_FLIST_HEAD(&def_thread.opt_list);
2137 fio_getaffinity(getpid(), &def_thread.o.cpumask);
2138 def_thread.o.error_dump = 1;
2141 * fill default options
2143 fio_fill_default_options(&def_thread);
2147 static void show_debug_categories(void)
2149 #ifdef FIO_INC_DEBUG
2150 const struct debug_level *dl = &debug_levels[0];
2151 int curlen, first = 1;
2155 int has_next = (dl + 1)->name != NULL;
2157 if (first || curlen + strlen(dl->name) >= 80) {
2162 curlen += printf("\t\t\t%s", dl->name);
2163 curlen += 3 * (8 - 1);
2165 curlen += printf(",");
2167 curlen += printf("%s", dl->name);
2169 curlen += printf(",");
2179 * Following options aren't printed by usage().
2180 * --append-terse - Equivalent to --output-format=terse, see f6a7df53.
2181 * --latency-log - Deprecated option.
2183 static void usage(const char *name)
2185 printf("%s\n", fio_version_string);
2186 printf("%s [options] [job options] <job file(s)>\n", name);
2187 printf(" --debug=options\tEnable debug logging. May be one/more of:\n");
2188 show_debug_categories();
2189 printf(" --parse-only\t\tParse options only, don't start any IO\n");
2190 printf(" --merge-blktrace-only\tMerge blktraces only, don't start any IO\n");
2191 printf(" --output\t\tWrite output to file\n");
2192 printf(" --bandwidth-log\tGenerate aggregate bandwidth logs\n");
2193 printf(" --minimal\t\tMinimal (terse) output\n");
2194 printf(" --output-format=type\tOutput format (terse,json,json+,normal)\n");
2195 printf(" --terse-version=type\tSet terse version output format"
2196 " (default 3, or 2 or 4)\n");
2197 printf(" --version\t\tPrint version info and exit\n");
2198 printf(" --help\t\tPrint this page\n");
2199 printf(" --cpuclock-test\tPerform test/validation of CPU clock\n");
2200 printf(" --crctest=[type]\tTest speed of checksum functions\n");
2201 printf(" --cmdhelp=cmd\t\tPrint command help, \"all\" for all of"
2203 printf(" --enghelp=engine\tPrint ioengine help, or list"
2204 " available ioengines\n");
2205 printf(" --enghelp=engine,cmd\tPrint help for an ioengine"
2207 printf(" --showcmd\t\tTurn a job file into command line options\n");
2208 printf(" --eta=when\t\tWhen ETA estimate should be printed\n");
2209 printf(" \t\tMay be \"always\", \"never\" or \"auto\"\n");
2210 printf(" --eta-newline=t\tForce a new line for every 't'");
2211 printf(" period passed\n");
2212 printf(" --status-interval=t\tForce full status dump every");
2213 printf(" 't' period passed\n");
2214 printf(" --readonly\t\tTurn on safety read-only checks, preventing"
2216 printf(" --section=name\tOnly run specified section in job file,"
2217 " multiple sections can be specified\n");
2218 printf(" --alloc-size=kb\tSet smalloc pool to this size in kb"
2220 printf(" --warnings-fatal\tFio parser warnings are fatal\n");
2221 printf(" --max-jobs=nr\t\tMaximum number of threads/processes to support\n");
2222 printf(" --server=args\t\tStart a backend fio server\n");
2223 printf(" --daemonize=pidfile\tBackground fio server, write pid to file\n");
2224 printf(" --client=hostname\tTalk to remote backend(s) fio server at hostname\n");
2225 printf(" --remote-config=file\tTell fio server to load this local job file\n");
2226 printf(" --idle-prof=option\tReport cpu idleness on a system or percpu basis\n"
2227 "\t\t\t(option=system,percpu) or run unit work\n"
2228 "\t\t\tcalibration only (option=calibrate)\n");
2230 printf(" --inflate-log=log\tInflate and output compressed log\n");
2232 printf(" --trigger-file=file\tExecute trigger cmd when file exists\n");
2233 printf(" --trigger-timeout=t\tExecute trigger at this time\n");
2234 printf(" --trigger=cmd\t\tSet this command as local trigger\n");
2235 printf(" --trigger-remote=cmd\tSet this command as remote trigger\n");
2236 printf(" --aux-path=path\tUse this path for fio state generated files\n");
2237 printf("\nFio was written by Jens Axboe <axboe@kernel.dk>\n");
2240 #ifdef FIO_INC_DEBUG
2241 const struct debug_level debug_levels[] = {
2242 { .name = "process",
2243 .help = "Process creation/exit logging",
2244 .shift = FD_PROCESS,
2247 .help = "File related action logging",
2251 .help = "IO and IO engine action logging (offsets, queue, completions, etc)",
2255 .help = "Memory allocation/freeing logging",
2258 { .name = "blktrace",
2259 .help = "blktrace action logging",
2260 .shift = FD_BLKTRACE,
2263 .help = "IO verification action logging",
2267 .help = "Random generation logging",
2271 .help = "Parser logging",
2274 { .name = "diskutil",
2275 .help = "Disk utility logging actions",
2276 .shift = FD_DISKUTIL,
2279 .help = "Logging related to creating/destroying jobs",
2283 .help = "Mutex logging",
2286 { .name = "profile",
2287 .help = "Logging related to profiles",
2288 .shift = FD_PROFILE,
2291 .help = "Logging related to time keeping functions",
2295 .help = "Network logging",
2299 .help = "Rate logging",
2302 { .name = "compress",
2303 .help = "Log compression logging",
2304 .shift = FD_COMPRESS,
2306 { .name = "steadystate",
2307 .help = "Steady state detection logging",
2308 .shift = FD_STEADYSTATE,
2310 { .name = "helperthread",
2311 .help = "Helper thread logging",
2312 .shift = FD_HELPERTHREAD,
2315 .help = "Zoned Block Device logging",
2321 static int set_debug(const char *string)
2323 const struct debug_level *dl;
2324 char *p = (char *) string;
2331 if (!strcmp(string, "?") || !strcmp(string, "help")) {
2332 log_info("fio: dumping debug options:");
2333 for (i = 0; debug_levels[i].name; i++) {
2334 dl = &debug_levels[i];
2335 log_info("%s,", dl->name);
2341 while ((opt = strsep(&p, ",")) != NULL) {
2344 if (!strncmp(opt, "all", 3)) {
2345 log_info("fio: set all debug options\n");
2350 for (i = 0; debug_levels[i].name; i++) {
2351 dl = &debug_levels[i];
2352 found = !strncmp(opt, dl->name, strlen(dl->name));
2356 if (dl->shift == FD_JOB) {
2357 opt = strchr(opt, ':');
2359 log_err("fio: missing job number\n");
2363 fio_debug_jobno = atoi(opt);
2364 log_info("fio: set debug jobno %d\n",
2367 log_info("fio: set debug option %s\n", opt);
2368 fio_debug |= (1UL << dl->shift);
2374 log_err("fio: debug mask %s not found\n", opt);
2379 static int set_debug(const char *string)
2381 log_err("fio: debug tracing not included in build\n");
2386 static void fio_options_fill_optstring(void)
2388 char *ostr = cmd_optstr;
2392 while (l_opts[i].name) {
2393 ostr[c++] = l_opts[i].val;
2394 if (l_opts[i].has_arg == required_argument)
2396 else if (l_opts[i].has_arg == optional_argument) {
2405 static int client_flag_set(char c)
2410 while (l_opts[i].name) {
2411 int val = l_opts[i].val;
2413 if (c == (val & 0xff))
2414 return (val & FIO_CLIENT_FLAG);
2422 static void parse_cmd_client(void *client, char *opt)
2424 fio_client_add_cmd_option(client, opt);
2427 static void show_closest_option(const char *name)
2429 int best_option, best_distance;
2432 while (*name == '-')
2436 best_distance = INT_MAX;
2438 while (l_opts[i].name) {
2439 distance = string_distance(name, l_opts[i].name);
2440 if (distance < best_distance) {
2441 best_distance = distance;
2447 if (best_option != -1 && string_distance_ok(name, best_distance))
2448 log_err("Did you mean %s?\n", l_opts[best_option].name);
2451 static int parse_output_format(const char *optarg)
2453 char *p, *orig, *opt;
2456 p = orig = strdup(optarg);
2460 while ((opt = strsep(&p, ",")) != NULL) {
2461 if (!strcmp(opt, "minimal") ||
2462 !strcmp(opt, "terse") ||
2463 !strcmp(opt, "csv"))
2464 output_format |= FIO_OUTPUT_TERSE;
2465 else if (!strcmp(opt, "json"))
2466 output_format |= FIO_OUTPUT_JSON;
2467 else if (!strcmp(opt, "json+"))
2468 output_format |= (FIO_OUTPUT_JSON | FIO_OUTPUT_JSON_PLUS);
2469 else if (!strcmp(opt, "normal"))
2470 output_format |= FIO_OUTPUT_NORMAL;
2472 log_err("fio: invalid output format %s\n", opt);
2482 int parse_cmd_line(int argc, char *argv[], int client_type)
2484 struct thread_data *td = NULL;
2485 int c, ini_idx = 0, lidx, ret = 0, do_exit = 0, exit_val = 0;
2486 char *ostr = cmd_optstr;
2487 char *pid_file = NULL;
2488 void *cur_client = NULL;
2489 bool backend = false;
2492 * Reset optind handling, since we may call this multiple times
2497 while ((c = getopt_long_only(argc, argv, ostr, l_opts, &lidx)) != -1) {
2498 if ((c & FIO_CLIENT_FLAG) || client_flag_set(c)) {
2499 parse_cmd_client(cur_client, argv[optind - 1]);
2500 c &= ~FIO_CLIENT_FLAG;
2505 smalloc_pool_size = atoi(optarg);
2506 smalloc_pool_size <<= 10;
2510 log_err("fio: --latency-log is deprecated. Use per-job latency log options.\n");
2515 write_bw_log = true;
2520 if (f_out && f_out != stdout)
2523 tmp = fopen(optarg, "w+");
2525 log_err("fio: output file open error: %s\n", strerror(errno));
2530 f_err = f_out = tmp;
2534 output_format = FIO_OUTPUT_TERSE;
2537 if (parse_output_format(optarg)) {
2538 log_err("fio: failed parsing output-format\n");
2545 output_format |= FIO_OUTPUT_TERSE;
2557 fio_show_option_help(optarg);
2564 exit_val = fio_show_ioengine_help(optarg);
2570 dump_cmdline = true;
2578 log_info("%s\n", fio_version_string);
2583 terse_version = atoi(optarg);
2584 if (!(terse_version >= 2 && terse_version <= 5)) {
2585 log_err("fio: bad terse version format\n");
2591 if (!strcmp("always", optarg))
2592 eta_print = FIO_ETA_ALWAYS;
2593 else if (!strcmp("never", optarg))
2594 eta_print = FIO_ETA_NEVER;
2599 if (check_str_time(optarg, &t, 1)) {
2600 log_err("fio: failed parsing eta time %s\n", optarg);
2605 eta_new_line = t / 1000;
2606 if (!eta_new_line) {
2607 log_err("fio: eta new line time too short\n");
2616 if (check_str_time(optarg, &t, 1)) {
2617 log_err("fio: failed parsing eta interval %s\n", optarg);
2622 eta_interval_msec = t / 1000;
2623 if (eta_interval_msec < DISK_UTIL_MSEC) {
2624 log_err("fio: eta interval time too short (%umsec min)\n", DISK_UTIL_MSEC);
2631 if (set_debug(optarg))
2641 if (!strcmp(optarg, "global")) {
2642 log_err("fio: can't use global as only "
2648 new_size = (nr_job_sections + 1) * sizeof(char *);
2649 job_sections = realloc(job_sections, new_size);
2650 job_sections[nr_job_sections] = strdup(optarg);
2656 exit_val = iolog_file_inflate(optarg);
2665 exec_profile = strdup(optarg);
2667 case FIO_GETOPT_JOB: {
2668 const char *opt = l_opts[lidx].name;
2671 if (!strncmp(opt, "name", 4) && td) {
2672 ret = add_job(td, td->o.name ?: "fio", 0, 0, client_type);
2679 int is_section = !strncmp(opt, "name", 4);
2682 if (!is_section || !strncmp(val, "global", 6))
2685 if (is_section && skip_this_section(val))
2688 td = get_new_job(global, &def_thread, true, NULL);
2689 if (!td || ioengine_load(td)) {
2698 fio_options_set_ioengine_opts(l_opts, td);
2701 if ((!val || !strlen(val)) &&
2702 l_opts[lidx].has_arg == required_argument) {
2703 log_err("fio: option %s requires an argument\n", opt);
2706 ret = fio_cmd_option_parse(td, opt, val);
2717 if (!ret && !strcmp(opt, "ioengine")) {
2718 if (ioengine_load(td)) {
2725 fio_options_set_ioengine_opts(l_opts, td);
2729 case FIO_GETOPT_IOENGINE: {
2730 const char *opt = l_opts[lidx].name;
2736 ret = fio_cmd_ioengine_option_parse(td, opt, val);
2743 /* we don't track/need this anymore, ignore it */
2747 #ifndef CONFIG_NO_SHM
2749 log_err("fio: can't be both client and server\n");
2755 fio_server_set_arg(optarg);
2759 log_err("fio: client/server requires SHM support\n");
2767 pid_file = strdup(optarg);
2770 if ((ret = fio_idle_prof_parse_opt(optarg))) {
2771 /* exit on error and calibration only */
2781 log_err("fio: can't be both client and server\n");
2786 /* if --client parameter contains a pathname */
2787 if (0 == access(optarg, R_OK)) {
2788 /* file contains a list of host addrs or names */
2789 char hostaddr[PATH_MAX] = {0};
2791 FILE * hostf = fopen(optarg, "r");
2793 log_err("fio: could not open client list file %s for read\n", optarg);
2798 sprintf(formatstr, "%%%ds", PATH_MAX - 1);
2800 * read at most PATH_MAX-1 chars from each
2801 * record in this file
2803 while (fscanf(hostf, formatstr, hostaddr) == 1) {
2804 /* expect EVERY host in file to be valid */
2805 if (fio_client_add(&fio_client_ops, hostaddr, &cur_client)) {
2806 log_err("fio: failed adding client %s from file %s\n", hostaddr, optarg);
2813 break; /* no possibility of job file for "this client only" */
2815 if (fio_client_add(&fio_client_ops, optarg, &cur_client)) {
2816 log_err("fio: failed adding client %s\n", optarg);
2822 * If the next argument exists and isn't an option,
2823 * assume it's a job file for this client only.
2825 while (optind < argc) {
2826 if (!strncmp(argv[optind], "--", 2) ||
2827 !strncmp(argv[optind], "-", 1))
2830 if (fio_client_add_ini_file(cur_client, argv[optind], false))
2837 if (fio_client_add_ini_file(cur_client, optarg, true)) {
2845 exit_val = fio_monotonic_clocktest(1);
2850 exit_val = fio_crctest(optarg);
2855 exit_val = fio_memcpy_test(optarg);
2860 if (check_str_time(optarg, &val, 1)) {
2861 log_err("fio: failed parsing time %s\n", optarg);
2867 log_err("fio: status interval too small\n");
2871 status_interval = val / 1000;
2877 trigger_file = strdup(optarg);
2882 trigger_cmd = strdup(optarg);
2885 if (trigger_remote_cmd)
2886 free(trigger_remote_cmd);
2887 trigger_remote_cmd = strdup(optarg);
2892 aux_path = strdup(optarg);
2895 if (check_str_time(optarg, &trigger_timeout, 1)) {
2896 log_err("fio: failed parsing time %s\n", optarg);
2900 trigger_timeout /= 1000000;
2905 merge_blktrace_only = true;
2908 log_err("%s: unrecognized option '%s'\n", argv[0],
2910 show_closest_option(argv[optind - 1]);
2921 if (do_exit && !(is_backend || nr_clients))
2924 if (nr_clients && fio_clients_connect())
2927 if (is_backend && backend)
2928 return fio_start_server(pid_file);
2934 ret = add_job(td, td->o.name ?: "fio", 0, 0, client_type);
2940 while (!ret && optind < argc) {
2942 ini_file = realloc(ini_file, ini_idx * sizeof(char *));
2943 ini_file[ini_idx - 1] = strdup(argv[optind]);
2951 int fio_init_options(void)
2956 fio_options_fill_optstring();
2957 fio_options_dup_and_init(l_opts);
2961 if (fill_def_thread())
2967 extern int fio_check_options(struct thread_options *);
2969 int parse_options(int argc, char *argv[])
2971 const int type = FIO_CLIENT_TYPE_CLI;
2974 if (fio_init_options())
2976 if (fio_test_cconv(&def_thread.o))
2977 log_err("fio: failed internal cconv test\n");
2979 job_files = parse_cmd_line(argc, argv, type);
2981 if (job_files > 0) {
2982 for (i = 0; i < job_files; i++) {
2983 if (i && fill_def_thread())
2986 if (fio_clients_send_ini(ini_file[i]))
2989 } else if (!is_backend) {
2990 if (parse_jobs_ini(ini_file[i], 0, i, type))
2995 } else if (nr_clients) {
2996 if (fill_def_thread())
2998 if (fio_clients_send_ini(NULL))
3003 fio_options_free(&def_thread);
3004 filesetup_mem_free();
3006 if (!thread_number) {
3011 if (is_backend || nr_clients)
3016 log_err("No job(s) defined\n\n");
3021 if (output_format & FIO_OUTPUT_NORMAL)
3022 log_info("%s\n", fio_version_string);
3027 void options_default_fill(struct thread_options *o)
3029 memcpy(o, &def_thread.o, sizeof(*o));
3032 struct thread_data *get_global_options(void)