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"
34 #include "oslib/getopt.h"
35 #include "oslib/strcasestr.h"
39 #include "lib/memcpy.h"
41 const char fio_version_string[] = FIO_VERSION;
43 #define FIO_RANDSEED (0xb1899bedUL)
45 static char **ini_file;
46 static int max_jobs = FIO_MAX_JOBS;
47 static int dump_cmdline;
48 static int parse_only;
50 static struct thread_data def_thread;
51 struct thread_data *threads = NULL;
52 static char **job_sections;
53 static int nr_job_sections;
55 int exitall_on_terminate = 0;
56 int output_format = FIO_OUTPUT_NORMAL;
57 int eta_print = FIO_ETA_AUTO;
58 unsigned int eta_interval_msec = 1000;
62 char *exec_profile = NULL;
63 int warnings_fatal = 0;
64 int terse_version = 3;
71 int status_interval = 0;
73 char *trigger_file = NULL;
74 long long trigger_timeout = 0;
75 char *trigger_cmd = NULL;
76 char *trigger_remote_cmd = NULL;
78 char *aux_path = NULL;
80 static int prev_group_jobs;
82 unsigned long fio_debug = 0;
83 unsigned int fio_debug_jobno = -1;
84 unsigned int *fio_debug_jobp = NULL;
85 unsigned int *fio_warned = NULL;
87 static char cmd_optstr[256];
90 #define FIO_CLIENT_FLAG (1 << 16)
93 * Command line options. These will contain the above, plus a few
94 * extra that only pertain to fio itself and not jobs.
96 static struct option l_opts[FIO_NR_OPTIONS] = {
98 .name = (char *) "output",
99 .has_arg = required_argument,
100 .val = 'o' | FIO_CLIENT_FLAG,
103 .name = (char *) "latency-log",
104 .has_arg = required_argument,
105 .val = 'l' | FIO_CLIENT_FLAG,
108 .name = (char *) "bandwidth-log",
109 .has_arg = no_argument,
110 .val = 'b' | FIO_CLIENT_FLAG,
113 .name = (char *) "minimal",
114 .has_arg = no_argument,
115 .val = 'm' | FIO_CLIENT_FLAG,
118 .name = (char *) "output-format",
119 .has_arg = required_argument,
120 .val = 'F' | FIO_CLIENT_FLAG,
123 .name = (char *) "append-terse",
124 .has_arg = optional_argument,
128 .name = (char *) "version",
129 .has_arg = no_argument,
130 .val = 'v' | FIO_CLIENT_FLAG,
133 .name = (char *) "help",
134 .has_arg = no_argument,
135 .val = 'h' | FIO_CLIENT_FLAG,
138 .name = (char *) "cmdhelp",
139 .has_arg = optional_argument,
140 .val = 'c' | FIO_CLIENT_FLAG,
143 .name = (char *) "enghelp",
144 .has_arg = optional_argument,
145 .val = 'i' | FIO_CLIENT_FLAG,
148 .name = (char *) "showcmd",
149 .has_arg = no_argument,
150 .val = 's' | FIO_CLIENT_FLAG,
153 .name = (char *) "readonly",
154 .has_arg = no_argument,
155 .val = 'r' | FIO_CLIENT_FLAG,
158 .name = (char *) "eta",
159 .has_arg = required_argument,
160 .val = 'e' | FIO_CLIENT_FLAG,
163 .name = (char *) "eta-interval",
164 .has_arg = required_argument,
165 .val = 'O' | FIO_CLIENT_FLAG,
168 .name = (char *) "eta-newline",
169 .has_arg = required_argument,
170 .val = 'E' | FIO_CLIENT_FLAG,
173 .name = (char *) "debug",
174 .has_arg = required_argument,
175 .val = 'd' | FIO_CLIENT_FLAG,
178 .name = (char *) "parse-only",
179 .has_arg = no_argument,
180 .val = 'P' | FIO_CLIENT_FLAG,
183 .name = (char *) "section",
184 .has_arg = required_argument,
185 .val = 'x' | FIO_CLIENT_FLAG,
189 .name = (char *) "inflate-log",
190 .has_arg = required_argument,
191 .val = 'X' | FIO_CLIENT_FLAG,
195 .name = (char *) "alloc-size",
196 .has_arg = required_argument,
197 .val = 'a' | FIO_CLIENT_FLAG,
200 .name = (char *) "profile",
201 .has_arg = required_argument,
202 .val = 'p' | FIO_CLIENT_FLAG,
205 .name = (char *) "warnings-fatal",
206 .has_arg = no_argument,
207 .val = 'w' | FIO_CLIENT_FLAG,
210 .name = (char *) "max-jobs",
211 .has_arg = required_argument,
212 .val = 'j' | FIO_CLIENT_FLAG,
215 .name = (char *) "terse-version",
216 .has_arg = required_argument,
217 .val = 'V' | FIO_CLIENT_FLAG,
220 .name = (char *) "server",
221 .has_arg = optional_argument,
224 { .name = (char *) "daemonize",
225 .has_arg = required_argument,
229 .name = (char *) "client",
230 .has_arg = required_argument,
234 .name = (char *) "remote-config",
235 .has_arg = required_argument,
239 .name = (char *) "cpuclock-test",
240 .has_arg = no_argument,
244 .name = (char *) "crctest",
245 .has_arg = optional_argument,
249 .name = (char *) "memcpytest",
250 .has_arg = optional_argument,
254 .name = (char *) "idle-prof",
255 .has_arg = required_argument,
259 .name = (char *) "status-interval",
260 .has_arg = required_argument,
264 .name = (char *) "trigger-file",
265 .has_arg = required_argument,
269 .name = (char *) "trigger-timeout",
270 .has_arg = required_argument,
274 .name = (char *) "trigger",
275 .has_arg = required_argument,
279 .name = (char *) "trigger-remote",
280 .has_arg = required_argument,
284 .name = (char *) "aux-path",
285 .has_arg = required_argument,
293 void free_threads_shm(void)
297 #ifndef CONFIG_NO_SHM
298 struct shmid_ds sbuf;
302 shmctl(shm_id, IPC_RMID, &sbuf);
311 static void free_shm(void)
315 fio_debug_jobp = NULL;
322 free(trigger_remote_cmd);
323 trigger_file = trigger_cmd = trigger_remote_cmd = NULL;
325 options_free(fio_options, &def_thread.o);
332 * The thread area is shared between the main process and the job
333 * threads/processes. So setup a shared memory segment that will hold
334 * all the job info. We use the end of the region for keeping track of
335 * open files across jobs, for file sharing.
337 static int setup_thread_area(void)
345 * 1024 is too much on some machines, scale max_jobs if
346 * we get a failure that looks like too large a shm segment
349 size_t size = max_jobs * sizeof(struct thread_data);
351 size += 2 * sizeof(unsigned int);
353 #ifndef CONFIG_NO_SHM
354 shm_id = shmget(0, size, IPC_CREAT | 0600);
357 if (errno != EINVAL && errno != ENOMEM && errno != ENOSPC) {
362 threads = malloc(size);
370 #ifndef CONFIG_NO_SHM
374 threads = shmat(shm_id, NULL, 0);
375 if (threads == (void *) -1) {
379 if (shm_attach_to_open_removed())
380 shmctl(shm_id, IPC_RMID, NULL);
383 memset(threads, 0, max_jobs * sizeof(struct thread_data));
384 for (i = 0; i < max_jobs; i++)
385 DRD_IGNORE_VAR(threads[i]);
386 fio_debug_jobp = (unsigned int *)(threads + max_jobs);
387 *fio_debug_jobp = -1;
388 fio_warned = fio_debug_jobp + 1;
396 static void dump_print_option(struct print_option *p)
400 if (!strcmp("description", p->name))
405 log_info("--%s%s", p->name, p->value ? "" : " ");
407 log_info("=%s%s%s ", delim, p->value, delim);
410 static void dump_opt_list(struct thread_data *td)
412 struct flist_head *entry;
413 struct print_option *p;
415 if (flist_empty(&td->opt_list))
418 flist_for_each(entry, &td->opt_list) {
419 p = flist_entry(entry, struct print_option, list);
420 dump_print_option(p);
424 static void fio_dump_options_free(struct thread_data *td)
426 while (!flist_empty(&td->opt_list)) {
427 struct print_option *p;
429 p = flist_first_entry(&td->opt_list, struct print_option, list);
430 flist_del_init(&p->list);
437 static void copy_opt_list(struct thread_data *dst, struct thread_data *src)
439 struct flist_head *entry;
441 if (flist_empty(&src->opt_list))
444 flist_for_each(entry, &src->opt_list) {
445 struct print_option *srcp, *dstp;
447 srcp = flist_entry(entry, struct print_option, list);
448 dstp = malloc(sizeof(*dstp));
449 dstp->name = strdup(srcp->name);
451 dstp->value = strdup(srcp->value);
454 flist_add_tail(&dstp->list, &dst->opt_list);
459 * Return a free job structure.
461 static struct thread_data *get_new_job(bool global, struct thread_data *parent,
462 bool preserve_eo, const char *jobname)
464 struct thread_data *td;
468 if (setup_thread_area()) {
469 log_err("error: failed to setup shm segment\n");
472 if (thread_number >= max_jobs) {
473 log_err("error: maximum number of jobs (%d) reached.\n",
478 td = &threads[thread_number++];
481 INIT_FLIST_HEAD(&td->opt_list);
482 if (parent != &def_thread)
483 copy_opt_list(td, parent);
490 td->o.uid = td->o.gid = -1U;
492 dup_files(td, parent);
493 fio_options_mem_dupe(td);
495 profile_add_hooks(td);
497 td->thread_number = thread_number;
498 td->subjob_number = 0;
501 td->o.name = strdup(jobname);
503 if (!parent->o.group_reporting || parent == &def_thread)
509 static void put_job(struct thread_data *td)
511 if (td == &def_thread)
518 log_info("fio: %s\n", td->verror);
520 fio_options_free(td);
521 fio_dump_options_free(td);
528 memset(&threads[td->thread_number - 1], 0, sizeof(*td));
532 static int __setup_rate(struct thread_data *td, enum fio_ddir ddir)
534 unsigned int bs = td->o.min_bs[ddir];
536 assert(ddir_rw(ddir));
538 if (td->o.rate[ddir])
539 td->rate_bps[ddir] = td->o.rate[ddir];
541 td->rate_bps[ddir] = (uint64_t) td->o.rate_iops[ddir] * bs;
543 if (!td->rate_bps[ddir]) {
544 log_err("rate lower than supported\n");
548 td->rate_next_io_time[ddir] = 0;
549 td->rate_io_issue_bytes[ddir] = 0;
550 td->last_usec[ddir] = 0;
554 static int setup_rate(struct thread_data *td)
558 if (td->o.rate[DDIR_READ] || td->o.rate_iops[DDIR_READ])
559 ret = __setup_rate(td, DDIR_READ);
560 if (td->o.rate[DDIR_WRITE] || td->o.rate_iops[DDIR_WRITE])
561 ret |= __setup_rate(td, DDIR_WRITE);
562 if (td->o.rate[DDIR_TRIM] || td->o.rate_iops[DDIR_TRIM])
563 ret |= __setup_rate(td, DDIR_TRIM);
568 static int fixed_block_size(struct thread_options *o)
570 return o->min_bs[DDIR_READ] == o->max_bs[DDIR_READ] &&
571 o->min_bs[DDIR_WRITE] == o->max_bs[DDIR_WRITE] &&
572 o->min_bs[DDIR_TRIM] == o->max_bs[DDIR_TRIM] &&
573 o->min_bs[DDIR_READ] == o->min_bs[DDIR_WRITE] &&
574 o->min_bs[DDIR_READ] == o->min_bs[DDIR_TRIM];
578 static unsigned long long get_rand_start_delay(struct thread_data *td)
580 unsigned long long delayrange;
581 uint64_t r, frand_max;
583 delayrange = td->o.start_delay_high - td->o.start_delay;
585 frand_max = rand_max(&td->delay_state);
586 r = __rand(&td->delay_state);
587 delayrange = (unsigned long long) ((double) delayrange * (r / (frand_max + 1.0)));
589 delayrange += td->o.start_delay_orig;
596 static unsigned int gcd(unsigned int m, unsigned int n)
601 return gcd(n, m % n);
605 * Lazy way of fixing up options that depend on each other. We could also
606 * define option callback handlers, but this is easier.
608 static int fixup_options(struct thread_data *td)
610 struct thread_options *o = &td->o;
613 #ifndef CONFIG_PSHARED
614 if (!o->use_thread) {
615 log_info("fio: this platform does not support process shared"
616 " mutexes, forcing use of threads. Use the 'thread'"
617 " option to get rid of this warning.\n");
619 ret = warnings_fatal;
623 if (o->write_iolog_file && o->read_iolog_file) {
624 log_err("fio: read iolog overrides write_iolog\n");
625 free(o->write_iolog_file);
626 o->write_iolog_file = NULL;
627 ret = warnings_fatal;
631 * only really works with 1 file
633 if (o->zone_size && o->open_files > 1)
637 * If zone_range isn't specified, backward compatibility dictates it
638 * should be made equal to zone_size.
640 if (o->zone_size && !o->zone_range)
641 o->zone_range = o->zone_size;
644 * Reads can do overwrites, we always need to pre-create the file
649 if (!o->min_bs[DDIR_READ])
650 o->min_bs[DDIR_READ] = o->bs[DDIR_READ];
651 if (!o->max_bs[DDIR_READ])
652 o->max_bs[DDIR_READ] = o->bs[DDIR_READ];
653 if (!o->min_bs[DDIR_WRITE])
654 o->min_bs[DDIR_WRITE] = o->bs[DDIR_WRITE];
655 if (!o->max_bs[DDIR_WRITE])
656 o->max_bs[DDIR_WRITE] = o->bs[DDIR_WRITE];
657 if (!o->min_bs[DDIR_TRIM])
658 o->min_bs[DDIR_TRIM] = o->bs[DDIR_TRIM];
659 if (!o->max_bs[DDIR_TRIM])
660 o->max_bs[DDIR_TRIM] = o->bs[DDIR_TRIM];
662 o->rw_min_bs = min(o->min_bs[DDIR_READ], o->min_bs[DDIR_WRITE]);
663 o->rw_min_bs = min(o->min_bs[DDIR_TRIM], o->rw_min_bs);
666 * For random IO, allow blockalign offset other than min_bs.
668 if (!o->ba[DDIR_READ] || !td_random(td))
669 o->ba[DDIR_READ] = o->min_bs[DDIR_READ];
670 if (!o->ba[DDIR_WRITE] || !td_random(td))
671 o->ba[DDIR_WRITE] = o->min_bs[DDIR_WRITE];
672 if (!o->ba[DDIR_TRIM] || !td_random(td))
673 o->ba[DDIR_TRIM] = o->min_bs[DDIR_TRIM];
675 if ((o->ba[DDIR_READ] != o->min_bs[DDIR_READ] ||
676 o->ba[DDIR_WRITE] != o->min_bs[DDIR_WRITE] ||
677 o->ba[DDIR_TRIM] != o->min_bs[DDIR_TRIM]) &&
679 log_err("fio: Any use of blockalign= turns off randommap\n");
681 ret = warnings_fatal;
684 if (!o->file_size_high)
685 o->file_size_high = o->file_size_low;
687 if (o->start_delay_high) {
688 if (!o->start_delay_orig)
689 o->start_delay_orig = o->start_delay;
690 o->start_delay = get_rand_start_delay(td);
693 if (o->norandommap && o->verify != VERIFY_NONE
694 && !fixed_block_size(o)) {
695 log_err("fio: norandommap given for variable block sizes, "
697 ret = warnings_fatal;
699 if (o->bs_unaligned && (o->odirect || td_ioengine_flagged(td, FIO_RAWIO)))
700 log_err("fio: bs_unaligned may not work with raw io\n");
703 * thinktime_spin must be less than thinktime
705 if (o->thinktime_spin > o->thinktime)
706 o->thinktime_spin = o->thinktime;
709 * The low water mark cannot be bigger than the iodepth
711 if (o->iodepth_low > o->iodepth || !o->iodepth_low)
712 o->iodepth_low = o->iodepth;
715 * If batch number isn't set, default to the same as iodepth
717 if (o->iodepth_batch > o->iodepth || !o->iodepth_batch)
718 o->iodepth_batch = o->iodepth;
721 * If max batch complete number isn't set or set incorrectly,
722 * default to the same as iodepth_batch_complete_min
724 if (o->iodepth_batch_complete_min > o->iodepth_batch_complete_max)
725 o->iodepth_batch_complete_max = o->iodepth_batch_complete_min;
728 * There's no need to check for in-flight overlapping IOs if the job
729 * isn't changing data or the maximum iodepth is guaranteed to be 1
731 if (o->serialize_overlap && !(td->flags & TD_F_READ_IOLOG) &&
732 (!(td_write(td) || td_trim(td)) || o->iodepth == 1))
733 o->serialize_overlap = 0;
735 * Currently can't check for overlaps in offload mode
737 if (o->serialize_overlap && o->io_submit_mode == IO_MODE_OFFLOAD) {
738 log_err("fio: checking for in-flight overlaps when the "
739 "io_submit_mode is offload is not supported\n");
740 o->serialize_overlap = 0;
741 ret = warnings_fatal;
744 if (o->nr_files > td->files_index)
745 o->nr_files = td->files_index;
747 if (o->open_files > o->nr_files || !o->open_files)
748 o->open_files = o->nr_files;
750 if (((o->rate[DDIR_READ] + o->rate[DDIR_WRITE] + o->rate[DDIR_TRIM]) &&
751 (o->rate_iops[DDIR_READ] + o->rate_iops[DDIR_WRITE] + o->rate_iops[DDIR_TRIM])) ||
752 ((o->ratemin[DDIR_READ] + o->ratemin[DDIR_WRITE] + o->ratemin[DDIR_TRIM]) &&
753 (o->rate_iops_min[DDIR_READ] + o->rate_iops_min[DDIR_WRITE] + o->rate_iops_min[DDIR_TRIM]))) {
754 log_err("fio: rate and rate_iops are mutually exclusive\n");
757 if ((o->rate[DDIR_READ] && (o->rate[DDIR_READ] < o->ratemin[DDIR_READ])) ||
758 (o->rate[DDIR_WRITE] && (o->rate[DDIR_WRITE] < o->ratemin[DDIR_WRITE])) ||
759 (o->rate[DDIR_TRIM] && (o->rate[DDIR_TRIM] < o->ratemin[DDIR_TRIM])) ||
760 (o->rate_iops[DDIR_READ] && (o->rate_iops[DDIR_READ] < o->rate_iops_min[DDIR_READ])) ||
761 (o->rate_iops[DDIR_WRITE] && (o->rate_iops[DDIR_WRITE] < o->rate_iops_min[DDIR_WRITE])) ||
762 (o->rate_iops[DDIR_TRIM] && (o->rate_iops[DDIR_TRIM] < o->rate_iops_min[DDIR_TRIM]))) {
763 log_err("fio: minimum rate exceeds rate\n");
767 if (!o->timeout && o->time_based) {
768 log_err("fio: time_based requires a runtime/timeout setting\n");
770 ret = warnings_fatal;
773 if (o->fill_device && !o->size)
776 if (o->verify != VERIFY_NONE) {
777 if (td_write(td) && o->do_verify && o->numjobs > 1 &&
779 !(o->unique_filename &&
780 strstr(o->filename_format, "$jobname") &&
781 strstr(o->filename_format, "$jobnum") &&
782 strstr(o->filename_format, "$filenum")))) {
783 log_info("fio: multiple writers may overwrite blocks "
784 "that belong to other jobs. This can cause "
785 "verification failures.\n");
786 ret = warnings_fatal;
790 * Warn if verification is requested but no verification of any
791 * kind can be started due to time constraints
793 if (td_write(td) && o->do_verify && o->timeout &&
794 o->time_based && !td_read(td) && !o->verify_backlog) {
795 log_info("fio: verification read phase will never "
796 "start because write phase uses all of "
798 ret = warnings_fatal;
801 if (!fio_option_is_set(o, refill_buffers))
802 o->refill_buffers = 1;
804 if (o->max_bs[DDIR_WRITE] != o->min_bs[DDIR_WRITE] &&
806 o->verify_interval = o->min_bs[DDIR_WRITE];
809 * Verify interval must be smaller or equal to the
812 if (o->verify_interval > o->min_bs[DDIR_WRITE])
813 o->verify_interval = o->min_bs[DDIR_WRITE];
814 else if (td_read(td) && o->verify_interval > o->min_bs[DDIR_READ])
815 o->verify_interval = o->min_bs[DDIR_READ];
818 * Verify interval must be a factor of both min and max
821 if (!o->verify_interval ||
822 (o->min_bs[DDIR_WRITE] % o->verify_interval) ||
823 (o->max_bs[DDIR_WRITE] % o->verify_interval))
824 o->verify_interval = gcd(o->min_bs[DDIR_WRITE],
825 o->max_bs[DDIR_WRITE]);
829 if (o->invalidate_cache)
830 o->invalidate_cache = 0;
831 if (td_ioengine_flagged(td, FIO_PIPEIO)) {
832 log_info("fio: cannot pre-read files with an IO engine"
833 " that isn't seekable. Pre-read disabled.\n");
834 ret = warnings_fatal;
838 if (o->unit_base == N2S_NONE) {
839 if (td_ioengine_flagged(td, FIO_BIT_BASED))
840 o->unit_base = N2S_BITPERSEC;
842 o->unit_base = N2S_BYTEPERSEC;
845 #ifndef FIO_HAVE_ANY_FALLOCATE
846 /* Platform doesn't support any fallocate so force it to none */
847 o->fallocate_mode = FIO_FALLOCATE_NONE;
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 < %u\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);
941 if (fio_option_is_set(o, clat_percentiles) &&
942 !fio_option_is_set(o, lat_percentiles)) {
943 o->lat_percentiles = !o->clat_percentiles;
944 } else if (fio_option_is_set(o, lat_percentiles) &&
945 !fio_option_is_set(o, clat_percentiles)) {
946 o->clat_percentiles = !o->lat_percentiles;
947 } else if (fio_option_is_set(o, lat_percentiles) &&
948 fio_option_is_set(o, clat_percentiles) &&
949 o->lat_percentiles && o->clat_percentiles) {
950 log_err("fio: lat_percentiles and clat_percentiles are "
951 "mutually exclusive\n");
956 o->lat_percentiles = 0;
958 o->clat_percentiles = 0;
961 * Fix these up to be nsec internally
963 o->max_latency *= 1000ULL;
964 o->latency_target *= 1000ULL;
965 o->latency_window *= 1000ULL;
970 static void init_rand_file_service(struct thread_data *td)
972 unsigned long nranges = td->o.nr_files << FIO_FSERVICE_SHIFT;
973 const unsigned int seed = td->rand_seeds[FIO_RAND_FILE_OFF];
975 if (td->o.file_service_type == FIO_FSERVICE_ZIPF) {
976 zipf_init(&td->next_file_zipf, nranges, td->zipf_theta, seed);
977 zipf_disable_hash(&td->next_file_zipf);
978 } else if (td->o.file_service_type == FIO_FSERVICE_PARETO) {
979 pareto_init(&td->next_file_zipf, nranges, td->pareto_h, seed);
980 zipf_disable_hash(&td->next_file_zipf);
981 } else if (td->o.file_service_type == FIO_FSERVICE_GAUSS) {
982 gauss_init(&td->next_file_gauss, nranges, td->gauss_dev, seed);
983 gauss_disable_hash(&td->next_file_gauss);
987 void td_fill_verify_state_seed(struct thread_data *td)
991 if (td->o.random_generator == FIO_RAND_GEN_TAUSWORTHE64)
996 init_rand_seed(&td->verify_state, td->rand_seeds[FIO_RAND_VER_OFF],
1000 static void td_fill_rand_seeds_internal(struct thread_data *td, bool use64)
1002 unsigned int read_seed = td->rand_seeds[FIO_RAND_BS_OFF];
1003 unsigned int write_seed = td->rand_seeds[FIO_RAND_BS1_OFF];
1004 unsigned int trim_seed = td->rand_seeds[FIO_RAND_BS2_OFF];
1008 * trimwrite is special in that we need to generate the same
1009 * offsets to get the "write after trim" effect. If we are
1010 * using bssplit to set buffer length distributions, ensure that
1011 * we seed the trim and write generators identically. Ditto for
1012 * verify, read and writes must have the same seed, if we are doing
1015 if (td->o.verify != VERIFY_NONE)
1016 write_seed = read_seed;
1017 if (td_trimwrite(td))
1018 trim_seed = write_seed;
1019 init_rand_seed(&td->bsrange_state[DDIR_READ], read_seed, use64);
1020 init_rand_seed(&td->bsrange_state[DDIR_WRITE], write_seed, use64);
1021 init_rand_seed(&td->bsrange_state[DDIR_TRIM], trim_seed, use64);
1023 td_fill_verify_state_seed(td);
1024 init_rand_seed(&td->rwmix_state, td->rand_seeds[FIO_RAND_MIX_OFF], false);
1026 if (td->o.file_service_type == FIO_FSERVICE_RANDOM)
1027 init_rand_seed(&td->next_file_state, td->rand_seeds[FIO_RAND_FILE_OFF], use64);
1028 else if (td->o.file_service_type & __FIO_FSERVICE_NONUNIFORM)
1029 init_rand_file_service(td);
1031 init_rand_seed(&td->file_size_state, td->rand_seeds[FIO_RAND_FILE_SIZE_OFF], use64);
1032 init_rand_seed(&td->trim_state, td->rand_seeds[FIO_RAND_TRIM_OFF], use64);
1033 init_rand_seed(&td->delay_state, td->rand_seeds[FIO_RAND_START_DELAY], use64);
1034 init_rand_seed(&td->poisson_state[0], td->rand_seeds[FIO_RAND_POISSON_OFF], 0);
1035 init_rand_seed(&td->poisson_state[1], td->rand_seeds[FIO_RAND_POISSON2_OFF], 0);
1036 init_rand_seed(&td->poisson_state[2], td->rand_seeds[FIO_RAND_POISSON3_OFF], 0);
1037 init_rand_seed(&td->dedupe_state, td->rand_seeds[FIO_DEDUPE_OFF], false);
1038 init_rand_seed(&td->zone_state, td->rand_seeds[FIO_RAND_ZONE_OFF], false);
1043 if (td->o.rand_repeatable)
1044 td->rand_seeds[FIO_RAND_BLOCK_OFF] = FIO_RANDSEED * td->thread_number;
1046 init_rand_seed(&td->random_state, td->rand_seeds[FIO_RAND_BLOCK_OFF], use64);
1048 for (i = 0; i < DDIR_RWDIR_CNT; i++) {
1049 struct frand_state *s = &td->seq_rand_state[i];
1051 init_rand_seed(s, td->rand_seeds[FIO_RAND_SEQ_RAND_READ_OFF], false);
1055 void td_fill_rand_seeds(struct thread_data *td)
1059 if (td->o.allrand_repeatable) {
1062 for (i = 0; i < FIO_RAND_NR_OFFS; i++)
1063 td->rand_seeds[i] = FIO_RANDSEED * td->thread_number
1067 if (td->o.random_generator == FIO_RAND_GEN_TAUSWORTHE64)
1072 td_fill_rand_seeds_internal(td, use64);
1074 init_rand_seed(&td->buf_state, td->rand_seeds[FIO_RAND_BUF_OFF], use64);
1075 frand_copy(&td->buf_state_prev, &td->buf_state);
1079 * Initializes the ioengine configured for a job, if it has not been done so
1082 int ioengine_load(struct thread_data *td)
1084 if (!td->o.ioengine) {
1085 log_err("fio: internal fault, no IO engine specified\n");
1090 struct ioengine_ops *ops;
1093 /* An engine is loaded, but the requested ioengine
1096 if (!strcmp(td->io_ops->name, td->o.ioengine)) {
1097 /* The right engine is already loaded */
1102 * Name of file and engine may be different, load ops
1103 * for this name and see if they match. If they do, then
1104 * the engine is unchanged.
1106 dlhandle = td->io_ops_dlhandle;
1107 ops = load_ioengine(td);
1108 if (ops == td->io_ops && dlhandle == td->io_ops_dlhandle) {
1114 if (dlhandle && dlhandle != td->io_ops_dlhandle)
1117 /* Unload the old engine. */
1121 td->io_ops = load_ioengine(td);
1123 log_err("fio: failed to load engine\n");
1127 if (td->io_ops->option_struct_size && td->io_ops->options) {
1129 * In cases where td->eo is set, clone it for a child thread.
1130 * This requires that the parent thread has the same ioengine,
1131 * but that requirement must be enforced by the code which
1132 * cloned the thread.
1134 void *origeo = td->eo;
1136 * Otherwise use the default thread options.
1138 if (!origeo && td != &def_thread && def_thread.eo &&
1139 def_thread.io_ops->options == td->io_ops->options)
1140 origeo = def_thread.eo;
1142 options_init(td->io_ops->options);
1143 td->eo = malloc(td->io_ops->option_struct_size);
1145 * Use the default thread as an option template if this uses the
1146 * same options structure and there are non-default options
1150 memcpy(td->eo, origeo, td->io_ops->option_struct_size);
1151 options_mem_dupe(td->io_ops->options, td->eo);
1153 memset(td->eo, 0, td->io_ops->option_struct_size);
1154 fill_default_options(td->eo, td->io_ops->options);
1156 *(struct thread_data **)td->eo = td;
1160 td->io_ops->flags |= FIO_RAWIO;
1162 td_set_ioengine_flags(td);
1166 static void init_flags(struct thread_data *td)
1168 struct thread_options *o = &td->o;
1171 if (o->verify_backlog)
1172 td->flags |= TD_F_VER_BACKLOG;
1173 if (o->trim_backlog)
1174 td->flags |= TD_F_TRIM_BACKLOG;
1175 if (o->read_iolog_file)
1176 td->flags |= TD_F_READ_IOLOG;
1177 if (o->refill_buffers)
1178 td->flags |= TD_F_REFILL_BUFFERS;
1180 * Always scramble buffers if asked to
1182 if (o->scramble_buffers && fio_option_is_set(o, scramble_buffers))
1183 td->flags |= TD_F_SCRAMBLE_BUFFERS;
1185 * But also scramble buffers, unless we were explicitly asked
1188 if (o->scramble_buffers && !(o->zero_buffers &&
1189 fio_option_is_set(o, zero_buffers)))
1190 td->flags |= TD_F_SCRAMBLE_BUFFERS;
1191 if (o->verify != VERIFY_NONE)
1192 td->flags |= TD_F_DO_VERIFY;
1194 if (o->verify_async || o->io_submit_mode == IO_MODE_OFFLOAD)
1195 td->flags |= TD_F_NEED_LOCK;
1197 if (o->mem_type == MEM_CUDA_MALLOC)
1198 td->flags &= ~TD_F_SCRAMBLE_BUFFERS;
1200 for (i = 0; i < DDIR_RWDIR_CNT; i++) {
1201 if (option_check_rate(td, i)) {
1202 td->flags |= TD_F_CHECK_RATE;
1208 static int setup_random_seeds(struct thread_data *td)
1213 if (!td->o.rand_repeatable && !fio_option_is_set(&td->o, rand_seed)) {
1214 int ret = init_random_seeds(td->rand_seeds, sizeof(td->rand_seeds));
1216 td_fill_rand_seeds(td);
1220 seed = td->o.rand_seed;
1221 for (i = 0; i < 4; i++)
1222 seed *= 0x9e370001UL;
1224 for (i = 0; i < FIO_RAND_NR_OFFS; i++) {
1225 td->rand_seeds[i] = seed * td->thread_number + i;
1226 seed *= 0x9e370001UL;
1229 td_fill_rand_seeds(td);
1240 static struct fpre_keyword {
1241 const char *keyword;
1244 } fpre_keywords[] = {
1245 { .keyword = "$jobname", .key = FPRE_JOBNAME, },
1246 { .keyword = "$jobnum", .key = FPRE_JOBNUM, },
1247 { .keyword = "$filenum", .key = FPRE_FILENUM, },
1248 { .keyword = NULL, },
1251 static char *make_filename(char *buf, size_t buf_size,struct thread_options *o,
1252 const char *jobname, int jobnum, int filenum)
1254 struct fpre_keyword *f;
1255 char copy[PATH_MAX];
1256 size_t dst_left = PATH_MAX - 1;
1258 if (!o->filename_format || !strlen(o->filename_format)) {
1259 sprintf(buf, "%s.%d.%d", jobname, jobnum, filenum);
1263 for (f = &fpre_keywords[0]; f->keyword; f++)
1264 f->strlen = strlen(f->keyword);
1266 buf[buf_size - 1] = '\0';
1267 strncpy(buf, o->filename_format, buf_size - 1);
1269 memset(copy, 0, sizeof(copy));
1270 for (f = &fpre_keywords[0]; f->keyword; f++) {
1272 size_t pre_len, post_start = 0;
1273 char *str, *dst = copy;
1275 str = strcasestr(buf, f->keyword);
1279 pre_len = str - buf;
1280 if (strlen(str) != f->strlen)
1281 post_start = pre_len + f->strlen;
1284 strncpy(dst, buf, pre_len);
1286 dst_left -= pre_len;
1290 case FPRE_JOBNAME: {
1293 ret = snprintf(dst, dst_left, "%s", jobname);
1296 else if (ret > dst_left) {
1297 log_err("fio: truncated filename\n");
1309 ret = snprintf(dst, dst_left, "%d", jobnum);
1312 else if (ret > dst_left) {
1313 log_err("fio: truncated filename\n");
1322 case FPRE_FILENUM: {
1325 ret = snprintf(dst, dst_left, "%d", filenum);
1328 else if (ret > dst_left) {
1329 log_err("fio: truncated filename\n");
1344 strncpy(dst, buf + post_start, dst_left);
1346 strncpy(buf, copy, buf_size - 1);
1353 bool parse_dryrun(void)
1355 return dump_cmdline || parse_only;
1358 static void gen_log_name(char *name, size_t size, const char *logtype,
1359 const char *logname, unsigned int num,
1360 const char *suf, int per_job)
1363 snprintf(name, size, "%s_%s.%d.%s", logname, logtype, num, suf);
1365 snprintf(name, size, "%s_%s.%s", logname, logtype, suf);
1368 static int check_waitees(char *waitee)
1370 struct thread_data *td;
1373 for_each_td(td, i) {
1374 if (td->subjob_number)
1377 ret += !strcmp(td->o.name, waitee);
1383 static bool wait_for_ok(const char *jobname, struct thread_options *o)
1390 if (!strcmp(jobname, o->wait_for)) {
1391 log_err("%s: a job cannot wait for itself (wait_for=%s).\n",
1392 jobname, o->wait_for);
1396 if (!(nw = check_waitees(o->wait_for))) {
1397 log_err("%s: waitee job %s unknown.\n", jobname, o->wait_for);
1402 log_err("%s: multiple waitees %s found,\n"
1403 "please avoid duplicates when using wait_for option.\n",
1404 jobname, o->wait_for);
1412 * Adds a job to the list of things todo. Sanitizes the various options
1413 * to make sure we don't have conflicts, and initializes various
1416 static int add_job(struct thread_data *td, const char *jobname, int job_add_num,
1417 int recursed, int client_type)
1420 char fname[PATH_MAX];
1421 int numjobs, file_alloced;
1422 struct thread_options *o = &td->o;
1423 char logname[PATH_MAX + 32];
1426 * the def_thread is just for options, it's not a real job
1428 if (td == &def_thread)
1434 * if we are just dumping the output command line, don't add the job
1436 if (parse_dryrun()) {
1441 td->client_type = client_type;
1443 if (profile_td_init(td))
1446 if (ioengine_load(td))
1450 if (!o->filename && !td->files_index && !o->read_iolog_file) {
1453 if (o->nr_files == 1 && exists_and_not_regfile(jobname))
1454 add_file(td, jobname, job_add_num, 0);
1456 for (i = 0; i < o->nr_files; i++)
1457 add_file(td, make_filename(fname, sizeof(fname), o, jobname, job_add_num, i), job_add_num, 0);
1461 if (setup_random_seeds(td)) {
1462 td_verror(td, errno, "setup_random_seeds");
1466 if (fixup_options(td))
1470 * Belongs to fixup_options, but o->name is not necessarily set as yet
1472 if (!wait_for_ok(jobname, o))
1478 * IO engines only need this for option callbacks, and the address may
1479 * change in subprocesses.
1482 *(struct thread_data **)td->eo = NULL;
1484 if (td_ioengine_flagged(td, FIO_DISKLESSIO)) {
1487 for_each_file(td, f, i)
1488 f->real_file_size = -1ULL;
1491 td->sem = fio_sem_init(FIO_SEM_LOCKED);
1493 td->ts.clat_percentiles = o->clat_percentiles;
1494 td->ts.lat_percentiles = o->lat_percentiles;
1495 td->ts.percentile_precision = o->percentile_precision;
1496 memcpy(td->ts.percentile_list, o->percentile_list, sizeof(o->percentile_list));
1497 td->ts.sig_figs = o->sig_figs;
1499 for (i = 0; i < DDIR_RWDIR_CNT; i++) {
1500 td->ts.clat_stat[i].min_val = ULONG_MAX;
1501 td->ts.slat_stat[i].min_val = ULONG_MAX;
1502 td->ts.lat_stat[i].min_val = ULONG_MAX;
1503 td->ts.bw_stat[i].min_val = ULONG_MAX;
1504 td->ts.iops_stat[i].min_val = ULONG_MAX;
1506 td->ts.sync_stat.min_val = ULONG_MAX;
1507 td->ddir_seq_nr = o->ddir_seq_nr;
1509 if ((o->stonewall || o->new_group) && prev_group_jobs) {
1510 prev_group_jobs = 0;
1512 if (groupid == INT_MAX) {
1513 log_err("fio: too many groups defined\n");
1518 td->groupid = groupid;
1524 if (o->write_lat_log) {
1525 struct log_params p = {
1527 .avg_msec = o->log_avg_msec,
1528 .hist_msec = o->log_hist_msec,
1529 .hist_coarseness = o->log_hist_coarseness,
1530 .log_type = IO_LOG_TYPE_LAT,
1531 .log_offset = o->log_offset,
1532 .log_gz = o->log_gz,
1533 .log_gz_store = o->log_gz_store,
1535 const char *pre = o->lat_log_file ? o->lat_log_file : o->name;
1543 gen_log_name(logname, sizeof(logname), "lat", pre,
1544 td->thread_number, suf, o->per_job_logs);
1545 setup_log(&td->lat_log, &p, logname);
1547 gen_log_name(logname, sizeof(logname), "slat", pre,
1548 td->thread_number, suf, o->per_job_logs);
1549 setup_log(&td->slat_log, &p, logname);
1551 gen_log_name(logname, sizeof(logname), "clat", pre,
1552 td->thread_number, suf, o->per_job_logs);
1553 setup_log(&td->clat_log, &p, logname);
1556 if (o->write_hist_log) {
1557 struct log_params p = {
1559 .avg_msec = o->log_avg_msec,
1560 .hist_msec = o->log_hist_msec,
1561 .hist_coarseness = o->log_hist_coarseness,
1562 .log_type = IO_LOG_TYPE_HIST,
1563 .log_offset = o->log_offset,
1564 .log_gz = o->log_gz,
1565 .log_gz_store = o->log_gz_store,
1567 const char *pre = o->hist_log_file ? o->hist_log_file : o->name;
1571 if (td->client_type) {
1572 log_err("fio: --write_hist_log requires zlib in client/server mode\n");
1582 gen_log_name(logname, sizeof(logname), "clat_hist", pre,
1583 td->thread_number, suf, o->per_job_logs);
1584 setup_log(&td->clat_hist_log, &p, logname);
1587 if (o->write_bw_log) {
1588 struct log_params p = {
1590 .avg_msec = o->log_avg_msec,
1591 .hist_msec = o->log_hist_msec,
1592 .hist_coarseness = o->log_hist_coarseness,
1593 .log_type = IO_LOG_TYPE_BW,
1594 .log_offset = o->log_offset,
1595 .log_gz = o->log_gz,
1596 .log_gz_store = o->log_gz_store,
1598 const char *pre = o->bw_log_file ? o->bw_log_file : o->name;
1601 if (fio_option_is_set(o, bw_avg_time))
1602 p.avg_msec = min(o->log_avg_msec, o->bw_avg_time);
1604 o->bw_avg_time = p.avg_msec;
1606 p.hist_msec = o->log_hist_msec;
1607 p.hist_coarseness = o->log_hist_coarseness;
1614 gen_log_name(logname, sizeof(logname), "bw", pre,
1615 td->thread_number, suf, o->per_job_logs);
1616 setup_log(&td->bw_log, &p, logname);
1618 if (o->write_iops_log) {
1619 struct log_params p = {
1621 .avg_msec = o->log_avg_msec,
1622 .hist_msec = o->log_hist_msec,
1623 .hist_coarseness = o->log_hist_coarseness,
1624 .log_type = IO_LOG_TYPE_IOPS,
1625 .log_offset = o->log_offset,
1626 .log_gz = o->log_gz,
1627 .log_gz_store = o->log_gz_store,
1629 const char *pre = o->iops_log_file ? o->iops_log_file : o->name;
1632 if (fio_option_is_set(o, iops_avg_time))
1633 p.avg_msec = min(o->log_avg_msec, o->iops_avg_time);
1635 o->iops_avg_time = p.avg_msec;
1637 p.hist_msec = o->log_hist_msec;
1638 p.hist_coarseness = o->log_hist_coarseness;
1645 gen_log_name(logname, sizeof(logname), "iops", pre,
1646 td->thread_number, suf, o->per_job_logs);
1647 setup_log(&td->iops_log, &p, logname);
1651 o->name = strdup(jobname);
1653 if (output_format & FIO_OUTPUT_NORMAL) {
1655 if (is_backend && !recursed)
1656 fio_server_send_add_job(td);
1658 if (!td_ioengine_flagged(td, FIO_NOIO)) {
1659 char *c1, *c2, *c3, *c4;
1660 char *c5 = NULL, *c6 = NULL;
1661 int i2p = is_power_of_2(o->kb_base);
1663 c1 = num2str(o->min_bs[DDIR_READ], o->sig_figs, 1, i2p, N2S_BYTE);
1664 c2 = num2str(o->max_bs[DDIR_READ], o->sig_figs, 1, i2p, N2S_BYTE);
1665 c3 = num2str(o->min_bs[DDIR_WRITE], o->sig_figs, 1, i2p, N2S_BYTE);
1666 c4 = num2str(o->max_bs[DDIR_WRITE], o->sig_figs, 1, i2p, N2S_BYTE);
1668 if (!o->bs_is_seq_rand) {
1669 c5 = num2str(o->min_bs[DDIR_TRIM], o->sig_figs, 1, i2p, N2S_BYTE);
1670 c6 = num2str(o->max_bs[DDIR_TRIM], o->sig_figs, 1, i2p, N2S_BYTE);
1673 log_info("%s: (g=%d): rw=%s, ", td->o.name,
1675 ddir_str(o->td_ddir));
1677 if (o->bs_is_seq_rand)
1678 log_info("bs=(R) %s-%s, (W) %s-%s, bs_is_seq_rand, ",
1681 log_info("bs=(R) %s-%s, (W) %s-%s, (T) %s-%s, ",
1682 c1, c2, c3, c4, c5, c6);
1684 log_info("ioengine=%s, iodepth=%u\n",
1685 td->io_ops->name, o->iodepth);
1694 } else if (job_add_num == 1)
1698 if (td_steadystate_init(td))
1702 * recurse add identical jobs, clear numjobs and stonewall options
1703 * as they don't apply to sub-jobs
1705 numjobs = o->numjobs;
1707 struct thread_data *td_new = get_new_job(false, td, true, jobname);
1712 td_new->o.numjobs = 1;
1713 td_new->o.stonewall = 0;
1714 td_new->o.new_group = 0;
1715 td_new->subjob_number = numjobs;
1716 td_new->o.ss_dur = o->ss_dur * 1000000l;
1717 td_new->o.ss_limit = o->ss_limit;
1720 if (td_new->files) {
1722 for_each_file(td_new, f, i) {
1724 sfree(f->file_name);
1727 free(td_new->files);
1728 td_new->files = NULL;
1730 td_new->files_index = 0;
1731 td_new->files_size = 0;
1732 if (td_new->o.filename) {
1733 free(td_new->o.filename);
1734 td_new->o.filename = NULL;
1738 if (add_job(td_new, jobname, numjobs, 1, client_type))
1749 * Parse as if 'o' was a command line
1751 void add_job_opts(const char **o, int client_type)
1753 struct thread_data *td, *td_parent;
1754 int i, in_global = 1;
1758 td_parent = td = NULL;
1760 if (!strncmp(o[i], "name", 4)) {
1763 add_job(td, jobname, 0, 0, client_type);
1765 sprintf(jobname, "%s", o[i] + 5);
1767 if (in_global && !td_parent)
1768 td_parent = get_new_job(true, &def_thread, false, jobname);
1769 else if (!in_global && !td) {
1771 td_parent = &def_thread;
1772 td = get_new_job(false, td_parent, false, jobname);
1775 fio_options_parse(td_parent, (char **) &o[i], 1);
1777 fio_options_parse(td, (char **) &o[i], 1);
1782 add_job(td, jobname, 0, 0, client_type);
1785 static int skip_this_section(const char *name)
1789 if (!nr_job_sections)
1791 if (!strncmp(name, "global", 6))
1794 for (i = 0; i < nr_job_sections; i++)
1795 if (!strcmp(job_sections[i], name))
1801 static int is_empty_or_comment(char *line)
1805 for (i = 0; i < strlen(line); i++) {
1810 if (!isspace((int) line[i]) && !iscntrl((int) line[i]))
1818 * This is our [ini] type file parser.
1820 static int __parse_jobs_ini(struct thread_data *td,
1821 char *file, int is_buf, int stonewall_flag, int type,
1822 int nested, char *name, char ***popts, int *aopts, int *nopts)
1824 bool global = false;
1828 int ret = 0, stonewall;
1831 int inside_skip = 0;
1833 int i, alloc_opts, num_opts;
1835 dprint(FD_PARSE, "Parsing ini file %s\n", file);
1836 assert(td || !nested);
1841 if (!strcmp(file, "-"))
1844 f = fopen(file, "r");
1849 log_err("fio: unable to open '%s' job file\n", file);
1851 td_verror(td, __err, "job file open");
1856 string = malloc(4096);
1859 * it's really 256 + small bit, 280 should suffice
1863 memset(name, 0, 280);
1867 if (nested && popts) {
1869 alloc_opts = *aopts;
1875 opts = malloc(sizeof(char *) * alloc_opts);
1879 stonewall = stonewall_flag;
1882 * if skip_fgets is set, we already have loaded a line we
1887 p = strsep(&file, "\n");
1889 p = fgets(string, 4096, f);
1895 strip_blank_front(&p);
1898 dprint(FD_PARSE, "%s\n", p);
1899 if (is_empty_or_comment(p))
1903 if (sscanf(p, "[%255[^\n]]", name) != 1) {
1907 log_err("fio: option <%s> outside of "
1908 "[] job section\n", p);
1913 name[strlen(name) - 1] = '\0';
1915 if (skip_this_section(name)) {
1921 dprint(FD_PARSE, "Parsing section [%s]\n", name);
1923 global = !strncmp(name, "global", 6);
1929 log_info("--name=%s ", name);
1933 td = get_new_job(global, &def_thread, false, name);
1940 * Separate multiple job files by a stonewall
1942 if (!global && stonewall) {
1943 td->o.stonewall = stonewall;
1948 memset(opts, 0, alloc_opts * sizeof(char *));
1956 p = strsep(&file, "\n");
1958 p = fgets(string, 4096, f);
1961 dprint(FD_PARSE, "%s", p);
1966 if (is_empty_or_comment(p))
1969 strip_blank_front(&p);
1972 * new section, break out and make sure we don't
1973 * fgets() a new line at the top.
1977 log_err("No new sections in included files\n");
1988 if (!strncmp(p, "include", strlen("include"))) {
1989 char *filename = p + strlen("include") + 1,
1990 *ts, *full_fn = NULL;
1993 * Allow for the include filename
1994 * specification to be relative.
1996 if (access(filename, F_OK) &&
1997 (ts = strrchr(file, '/'))) {
1998 int len = ts - file +
1999 strlen(filename) + 2;
2001 if (!(full_fn = calloc(1, len))) {
2007 file, (ts - file) + 1);
2008 strncpy(full_fn + (ts - file) + 1,
2009 filename, strlen(filename));
2010 full_fn[len - 1] = 0;
2014 ret = __parse_jobs_ini(td, filename, is_buf,
2015 stonewall_flag, type, 1,
2017 &alloc_opts, &num_opts);
2020 log_err("Error %d while parsing "
2021 "include file %s\n",
2034 if (num_opts == alloc_opts) {
2036 opts = realloc(opts,
2037 alloc_opts * sizeof(char *));
2040 opts[num_opts] = strdup(p);
2046 *aopts = alloc_opts;
2051 ret = fio_options_parse(td, opts, num_opts);
2056 ret = add_job(td, name, 0, 0, type);
2058 log_err("fio: job %s dropped\n", name);
2062 for (i = 0; i < num_opts; i++)
2071 while (i < nr_job_sections) {
2072 free(job_sections[i]);
2081 if (!is_buf && f != stdin)
2086 int parse_jobs_ini(char *file, int is_buf, int stonewall_flag, int type)
2088 return __parse_jobs_ini(NULL, file, is_buf, stonewall_flag, type,
2089 0, NULL, NULL, NULL, NULL);
2092 static int fill_def_thread(void)
2094 memset(&def_thread, 0, sizeof(def_thread));
2095 INIT_FLIST_HEAD(&def_thread.opt_list);
2097 fio_getaffinity(getpid(), &def_thread.o.cpumask);
2098 def_thread.o.error_dump = 1;
2101 * fill default options
2103 fio_fill_default_options(&def_thread);
2107 static void show_debug_categories(void)
2109 #ifdef FIO_INC_DEBUG
2110 const struct debug_level *dl = &debug_levels[0];
2111 int curlen, first = 1;
2115 int has_next = (dl + 1)->name != NULL;
2117 if (first || curlen + strlen(dl->name) >= 80) {
2122 curlen += printf("\t\t\t%s", dl->name);
2123 curlen += 3 * (8 - 1);
2125 curlen += printf(",");
2127 curlen += printf("%s", dl->name);
2129 curlen += printf(",");
2139 * Following options aren't printed by usage().
2140 * --append-terse - Equivalent to --output-format=terse, see f6a7df53.
2141 * --latency-log - Deprecated option.
2143 static void usage(const char *name)
2145 printf("%s\n", fio_version_string);
2146 printf("%s [options] [job options] <job file(s)>\n", name);
2147 printf(" --debug=options\tEnable debug logging. May be one/more of:\n");
2148 show_debug_categories();
2149 printf(" --parse-only\t\tParse options only, don't start any IO\n");
2150 printf(" --output\t\tWrite output to file\n");
2151 printf(" --bandwidth-log\tGenerate aggregate bandwidth logs\n");
2152 printf(" --minimal\t\tMinimal (terse) output\n");
2153 printf(" --output-format=type\tOutput format (terse,json,json+,normal)\n");
2154 printf(" --terse-version=type\tSet terse version output format"
2155 " (default 3, or 2 or 4)\n");
2156 printf(" --version\t\tPrint version info and exit\n");
2157 printf(" --help\t\tPrint this page\n");
2158 printf(" --cpuclock-test\tPerform test/validation of CPU clock\n");
2159 printf(" --crctest=[type]\tTest speed of checksum functions\n");
2160 printf(" --cmdhelp=cmd\t\tPrint command help, \"all\" for all of"
2162 printf(" --enghelp=engine\tPrint ioengine help, or list"
2163 " available ioengines\n");
2164 printf(" --enghelp=engine,cmd\tPrint help for an ioengine"
2166 printf(" --showcmd\t\tTurn a job file into command line options\n");
2167 printf(" --eta=when\t\tWhen ETA estimate should be printed\n");
2168 printf(" \t\tMay be \"always\", \"never\" or \"auto\"\n");
2169 printf(" --eta-newline=time\tForce a new line for every 'time'");
2170 printf(" period passed\n");
2171 printf(" --status-interval=t\tForce full status dump every");
2172 printf(" 't' period passed\n");
2173 printf(" --readonly\t\tTurn on safety read-only checks, preventing"
2175 printf(" --section=name\tOnly run specified section in job file,"
2176 " multiple sections can be specified\n");
2177 printf(" --alloc-size=kb\tSet smalloc pool to this size in kb"
2179 printf(" --warnings-fatal\tFio parser warnings are fatal\n");
2180 printf(" --max-jobs=nr\t\tMaximum number of threads/processes to support\n");
2181 printf(" --server=args\t\tStart a backend fio server\n");
2182 printf(" --daemonize=pidfile\tBackground fio server, write pid to file\n");
2183 printf(" --client=hostname\tTalk to remote backend(s) fio server at hostname\n");
2184 printf(" --remote-config=file\tTell fio server to load this local job file\n");
2185 printf(" --idle-prof=option\tReport cpu idleness on a system or percpu basis\n"
2186 "\t\t\t(option=system,percpu) or run unit work\n"
2187 "\t\t\tcalibration only (option=calibrate)\n");
2189 printf(" --inflate-log=log\tInflate and output compressed log\n");
2191 printf(" --trigger-file=file\tExecute trigger cmd when file exists\n");
2192 printf(" --trigger-timeout=t\tExecute trigger at this time\n");
2193 printf(" --trigger=cmd\t\tSet this command as local trigger\n");
2194 printf(" --trigger-remote=cmd\tSet this command as remote trigger\n");
2195 printf(" --aux-path=path\tUse this path for fio state generated files\n");
2196 printf("\nFio was written by Jens Axboe <axboe@kernel.dk>\n");
2199 #ifdef FIO_INC_DEBUG
2200 const struct debug_level debug_levels[] = {
2201 { .name = "process",
2202 .help = "Process creation/exit logging",
2203 .shift = FD_PROCESS,
2206 .help = "File related action logging",
2210 .help = "IO and IO engine action logging (offsets, queue, completions, etc)",
2214 .help = "Memory allocation/freeing logging",
2217 { .name = "blktrace",
2218 .help = "blktrace action logging",
2219 .shift = FD_BLKTRACE,
2222 .help = "IO verification action logging",
2226 .help = "Random generation logging",
2230 .help = "Parser logging",
2233 { .name = "diskutil",
2234 .help = "Disk utility logging actions",
2235 .shift = FD_DISKUTIL,
2238 .help = "Logging related to creating/destroying jobs",
2242 .help = "Mutex logging",
2245 { .name = "profile",
2246 .help = "Logging related to profiles",
2247 .shift = FD_PROFILE,
2250 .help = "Logging related to time keeping functions",
2254 .help = "Network logging",
2258 .help = "Rate logging",
2261 { .name = "compress",
2262 .help = "Log compression logging",
2263 .shift = FD_COMPRESS,
2265 { .name = "steadystate",
2266 .help = "Steady state detection logging",
2267 .shift = FD_STEADYSTATE,
2269 { .name = "helperthread",
2270 .help = "Helper thread logging",
2271 .shift = FD_HELPERTHREAD,
2276 static int set_debug(const char *string)
2278 const struct debug_level *dl;
2279 char *p = (char *) string;
2286 if (!strcmp(string, "?") || !strcmp(string, "help")) {
2287 log_info("fio: dumping debug options:");
2288 for (i = 0; debug_levels[i].name; i++) {
2289 dl = &debug_levels[i];
2290 log_info("%s,", dl->name);
2296 while ((opt = strsep(&p, ",")) != NULL) {
2299 if (!strncmp(opt, "all", 3)) {
2300 log_info("fio: set all debug options\n");
2305 for (i = 0; debug_levels[i].name; i++) {
2306 dl = &debug_levels[i];
2307 found = !strncmp(opt, dl->name, strlen(dl->name));
2311 if (dl->shift == FD_JOB) {
2312 opt = strchr(opt, ':');
2314 log_err("fio: missing job number\n");
2318 fio_debug_jobno = atoi(opt);
2319 log_info("fio: set debug jobno %d\n",
2322 log_info("fio: set debug option %s\n", opt);
2323 fio_debug |= (1UL << dl->shift);
2329 log_err("fio: debug mask %s not found\n", opt);
2334 static int set_debug(const char *string)
2336 log_err("fio: debug tracing not included in build\n");
2341 static void fio_options_fill_optstring(void)
2343 char *ostr = cmd_optstr;
2347 while (l_opts[i].name) {
2348 ostr[c++] = l_opts[i].val;
2349 if (l_opts[i].has_arg == required_argument)
2351 else if (l_opts[i].has_arg == optional_argument) {
2360 static int client_flag_set(char c)
2365 while (l_opts[i].name) {
2366 int val = l_opts[i].val;
2368 if (c == (val & 0xff))
2369 return (val & FIO_CLIENT_FLAG);
2377 static void parse_cmd_client(void *client, char *opt)
2379 fio_client_add_cmd_option(client, opt);
2382 static void show_closest_option(const char *name)
2384 int best_option, best_distance;
2387 while (*name == '-')
2391 best_distance = INT_MAX;
2393 while (l_opts[i].name) {
2394 distance = string_distance(name, l_opts[i].name);
2395 if (distance < best_distance) {
2396 best_distance = distance;
2402 if (best_option != -1 && string_distance_ok(name, best_distance))
2403 log_err("Did you mean %s?\n", l_opts[best_option].name);
2406 static int parse_output_format(const char *optarg)
2408 char *p, *orig, *opt;
2411 p = orig = strdup(optarg);
2415 while ((opt = strsep(&p, ",")) != NULL) {
2416 if (!strcmp(opt, "minimal") ||
2417 !strcmp(opt, "terse") ||
2418 !strcmp(opt, "csv"))
2419 output_format |= FIO_OUTPUT_TERSE;
2420 else if (!strcmp(opt, "json"))
2421 output_format |= FIO_OUTPUT_JSON;
2422 else if (!strcmp(opt, "json+"))
2423 output_format |= (FIO_OUTPUT_JSON | FIO_OUTPUT_JSON_PLUS);
2424 else if (!strcmp(opt, "normal"))
2425 output_format |= FIO_OUTPUT_NORMAL;
2427 log_err("fio: invalid output format %s\n", opt);
2437 int parse_cmd_line(int argc, char *argv[], int client_type)
2439 struct thread_data *td = NULL;
2440 int c, ini_idx = 0, lidx, ret = 0, do_exit = 0, exit_val = 0;
2441 char *ostr = cmd_optstr;
2442 char *pid_file = NULL;
2443 void *cur_client = NULL;
2447 * Reset optind handling, since we may call this multiple times
2452 while ((c = getopt_long_only(argc, argv, ostr, l_opts, &lidx)) != -1) {
2453 if ((c & FIO_CLIENT_FLAG) || client_flag_set(c)) {
2454 parse_cmd_client(cur_client, argv[optind - 1]);
2455 c &= ~FIO_CLIENT_FLAG;
2460 smalloc_pool_size = atoi(optarg);
2461 smalloc_pool_size <<= 10;
2465 log_err("fio: --latency-log is deprecated. Use per-job latency log options.\n");
2475 if (f_out && f_out != stdout)
2478 tmp = fopen(optarg, "w+");
2480 log_err("fio: output file open error: %s\n", strerror(errno));
2485 f_err = f_out = tmp;
2489 output_format = FIO_OUTPUT_TERSE;
2492 if (parse_output_format(optarg)) {
2493 log_err("fio: failed parsing output-format\n");
2500 output_format |= FIO_OUTPUT_TERSE;
2512 fio_show_option_help(optarg);
2519 fio_show_ioengine_help(optarg);
2533 log_info("%s\n", fio_version_string);
2538 terse_version = atoi(optarg);
2539 if (!(terse_version >= 2 && terse_version <= 5)) {
2540 log_err("fio: bad terse version format\n");
2546 if (!strcmp("always", optarg))
2547 eta_print = FIO_ETA_ALWAYS;
2548 else if (!strcmp("never", optarg))
2549 eta_print = FIO_ETA_NEVER;
2554 if (check_str_time(optarg, &t, 1)) {
2555 log_err("fio: failed parsing eta time %s\n", optarg);
2560 eta_new_line = t / 1000;
2561 if (!eta_new_line) {
2562 log_err("fio: eta new line time too short\n");
2571 if (check_str_time(optarg, &t, 1)) {
2572 log_err("fio: failed parsing eta interval %s\n", optarg);
2577 eta_interval_msec = t / 1000;
2578 if (eta_interval_msec < DISK_UTIL_MSEC) {
2579 log_err("fio: eta interval time too short (%umsec min)\n", DISK_UTIL_MSEC);
2586 if (set_debug(optarg))
2596 if (!strcmp(optarg, "global")) {
2597 log_err("fio: can't use global as only "
2603 new_size = (nr_job_sections + 1) * sizeof(char *);
2604 job_sections = realloc(job_sections, new_size);
2605 job_sections[nr_job_sections] = strdup(optarg);
2611 exit_val = iolog_file_inflate(optarg);
2620 exec_profile = strdup(optarg);
2622 case FIO_GETOPT_JOB: {
2623 const char *opt = l_opts[lidx].name;
2626 if (!strncmp(opt, "name", 4) && td) {
2627 ret = add_job(td, td->o.name ?: "fio", 0, 0, client_type);
2634 int is_section = !strncmp(opt, "name", 4);
2637 if (!is_section || !strncmp(val, "global", 6))
2640 if (is_section && skip_this_section(val))
2643 td = get_new_job(global, &def_thread, true, NULL);
2644 if (!td || ioengine_load(td)) {
2653 fio_options_set_ioengine_opts(l_opts, td);
2656 if ((!val || !strlen(val)) &&
2657 l_opts[lidx].has_arg == required_argument) {
2658 log_err("fio: option %s requires an argument\n", opt);
2661 ret = fio_cmd_option_parse(td, opt, val);
2672 if (!ret && !strcmp(opt, "ioengine")) {
2673 if (ioengine_load(td)) {
2680 fio_options_set_ioengine_opts(l_opts, td);
2684 case FIO_GETOPT_IOENGINE: {
2685 const char *opt = l_opts[lidx].name;
2691 ret = fio_cmd_ioengine_option_parse(td, opt, val);
2698 max_jobs = atoi(optarg);
2699 if (!max_jobs || max_jobs > REAL_MAX_JOBS) {
2700 log_err("fio: invalid max jobs: %d\n", max_jobs);
2707 #ifndef CONFIG_NO_SHM
2709 log_err("fio: can't be both client and server\n");
2715 fio_server_set_arg(optarg);
2719 log_err("fio: client/server requires SHM support\n");
2727 pid_file = strdup(optarg);
2730 if ((ret = fio_idle_prof_parse_opt(optarg))) {
2731 /* exit on error and calibration only */
2741 log_err("fio: can't be both client and server\n");
2746 /* if --client parameter contains a pathname */
2747 if (0 == access(optarg, R_OK)) {
2748 /* file contains a list of host addrs or names */
2749 char hostaddr[PATH_MAX] = {0};
2751 FILE * hostf = fopen(optarg, "r");
2753 log_err("fio: could not open client list file %s for read\n", optarg);
2758 sprintf(formatstr, "%%%ds", PATH_MAX - 1);
2760 * read at most PATH_MAX-1 chars from each
2761 * record in this file
2763 while (fscanf(hostf, formatstr, hostaddr) == 1) {
2764 /* expect EVERY host in file to be valid */
2765 if (fio_client_add(&fio_client_ops, hostaddr, &cur_client)) {
2766 log_err("fio: failed adding client %s from file %s\n", hostaddr, optarg);
2773 break; /* no possibility of job file for "this client only" */
2775 if (fio_client_add(&fio_client_ops, optarg, &cur_client)) {
2776 log_err("fio: failed adding client %s\n", optarg);
2782 * If the next argument exists and isn't an option,
2783 * assume it's a job file for this client only.
2785 while (optind < argc) {
2786 if (!strncmp(argv[optind], "--", 2) ||
2787 !strncmp(argv[optind], "-", 1))
2790 if (fio_client_add_ini_file(cur_client, argv[optind], false))
2797 if (fio_client_add_ini_file(cur_client, optarg, true)) {
2805 exit_val = fio_monotonic_clocktest(1);
2810 exit_val = fio_crctest(optarg);
2815 exit_val = fio_memcpy_test(optarg);
2820 if (check_str_time(optarg, &val, 1)) {
2821 log_err("fio: failed parsing time %s\n", optarg);
2827 log_err("fio: status interval too small\n");
2831 status_interval = val / 1000;
2837 trigger_file = strdup(optarg);
2842 trigger_cmd = strdup(optarg);
2845 if (trigger_remote_cmd)
2846 free(trigger_remote_cmd);
2847 trigger_remote_cmd = strdup(optarg);
2852 aux_path = strdup(optarg);
2855 if (check_str_time(optarg, &trigger_timeout, 1)) {
2856 log_err("fio: failed parsing time %s\n", optarg);
2860 trigger_timeout /= 1000000;
2863 log_err("%s: unrecognized option '%s'\n", argv[0],
2865 show_closest_option(argv[optind - 1]);
2875 if (do_exit && !(is_backend || nr_clients))
2878 if (nr_clients && fio_clients_connect())
2881 if (is_backend && backend)
2882 return fio_start_server(pid_file);
2888 ret = add_job(td, td->o.name ?: "fio", 0, 0, client_type);
2894 while (!ret && optind < argc) {
2896 ini_file = realloc(ini_file, ini_idx * sizeof(char *));
2897 ini_file[ini_idx - 1] = strdup(argv[optind]);
2905 int fio_init_options(void)
2910 fio_options_fill_optstring();
2911 fio_options_dup_and_init(l_opts);
2915 if (fill_def_thread())
2921 extern int fio_check_options(struct thread_options *);
2923 int parse_options(int argc, char *argv[])
2925 const int type = FIO_CLIENT_TYPE_CLI;
2928 if (fio_init_options())
2930 if (fio_test_cconv(&def_thread.o))
2931 log_err("fio: failed internal cconv test\n");
2933 job_files = parse_cmd_line(argc, argv, type);
2935 if (job_files > 0) {
2936 for (i = 0; i < job_files; i++) {
2937 if (i && fill_def_thread())
2940 if (fio_clients_send_ini(ini_file[i]))
2943 } else if (!is_backend) {
2944 if (parse_jobs_ini(ini_file[i], 0, i, type))
2949 } else if (nr_clients) {
2950 if (fill_def_thread())
2952 if (fio_clients_send_ini(NULL))
2957 fio_options_free(&def_thread);
2958 filesetup_mem_free();
2960 if (!thread_number) {
2965 if (is_backend || nr_clients)
2970 log_err("No job(s) defined\n\n");
2975 if (output_format & FIO_OUTPUT_NORMAL)
2976 log_info("%s\n", fio_version_string);
2981 void options_default_fill(struct thread_options *o)
2983 memcpy(o, &def_thread.o, sizeof(*o));
2986 struct thread_data *get_global_options(void)