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 long long 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];
580 static unsigned int gcd(unsigned int m, unsigned int n)
585 return gcd(n, m % n);
589 * Lazy way of fixing up options that depend on each other. We could also
590 * define option callback handlers, but this is easier.
592 static int fixup_options(struct thread_data *td)
594 struct thread_options *o = &td->o;
597 if (read_only && (td_write(td) || td_trim(td))) {
598 log_err("fio: trim and write operations are not allowed"
599 " with the --readonly parameter.\n");
603 #ifndef CONFIG_PSHARED
604 if (!o->use_thread) {
605 log_info("fio: this platform does not support process shared"
606 " mutexes, forcing use of threads. Use the 'thread'"
607 " option to get rid of this warning.\n");
609 ret |= warnings_fatal;
613 if (o->write_iolog_file && o->read_iolog_file) {
614 log_err("fio: read iolog overrides write_iolog\n");
615 free(o->write_iolog_file);
616 o->write_iolog_file = NULL;
617 ret |= warnings_fatal;
621 * only really works with 1 file
623 if (o->zone_size && o->open_files > 1)
627 * If zone_range isn't specified, backward compatibility dictates it
628 * should be made equal to zone_size.
630 if (o->zone_size && !o->zone_range)
631 o->zone_range = o->zone_size;
634 * Reads can do overwrites, we always need to pre-create the file
639 if (!o->min_bs[DDIR_READ])
640 o->min_bs[DDIR_READ] = o->bs[DDIR_READ];
641 if (!o->max_bs[DDIR_READ])
642 o->max_bs[DDIR_READ] = o->bs[DDIR_READ];
643 if (!o->min_bs[DDIR_WRITE])
644 o->min_bs[DDIR_WRITE] = o->bs[DDIR_WRITE];
645 if (!o->max_bs[DDIR_WRITE])
646 o->max_bs[DDIR_WRITE] = o->bs[DDIR_WRITE];
647 if (!o->min_bs[DDIR_TRIM])
648 o->min_bs[DDIR_TRIM] = o->bs[DDIR_TRIM];
649 if (!o->max_bs[DDIR_TRIM])
650 o->max_bs[DDIR_TRIM] = o->bs[DDIR_TRIM];
652 o->rw_min_bs = min(o->min_bs[DDIR_READ], o->min_bs[DDIR_WRITE]);
653 o->rw_min_bs = min(o->min_bs[DDIR_TRIM], o->rw_min_bs);
656 * For random IO, allow blockalign offset other than min_bs.
658 if (!o->ba[DDIR_READ] || !td_random(td))
659 o->ba[DDIR_READ] = o->min_bs[DDIR_READ];
660 if (!o->ba[DDIR_WRITE] || !td_random(td))
661 o->ba[DDIR_WRITE] = o->min_bs[DDIR_WRITE];
662 if (!o->ba[DDIR_TRIM] || !td_random(td))
663 o->ba[DDIR_TRIM] = o->min_bs[DDIR_TRIM];
665 if ((o->ba[DDIR_READ] != o->min_bs[DDIR_READ] ||
666 o->ba[DDIR_WRITE] != o->min_bs[DDIR_WRITE] ||
667 o->ba[DDIR_TRIM] != o->min_bs[DDIR_TRIM]) &&
669 log_err("fio: Any use of blockalign= turns off randommap\n");
671 ret |= warnings_fatal;
674 if (!o->file_size_high)
675 o->file_size_high = o->file_size_low;
677 if (o->start_delay_high) {
678 if (!o->start_delay_orig)
679 o->start_delay_orig = o->start_delay;
680 o->start_delay = rand_between(&td->delay_state,
682 o->start_delay_high);
685 if (o->norandommap && o->verify != VERIFY_NONE
686 && !fixed_block_size(o)) {
687 log_err("fio: norandommap given for variable block sizes, "
689 ret |= warnings_fatal;
691 if (o->bs_unaligned && (o->odirect || td_ioengine_flagged(td, FIO_RAWIO)))
692 log_err("fio: bs_unaligned may not work with raw io\n");
695 * thinktime_spin must be less than thinktime
697 if (o->thinktime_spin > o->thinktime)
698 o->thinktime_spin = o->thinktime;
701 * The low water mark cannot be bigger than the iodepth
703 if (o->iodepth_low > o->iodepth || !o->iodepth_low)
704 o->iodepth_low = o->iodepth;
707 * If batch number isn't set, default to the same as iodepth
709 if (o->iodepth_batch > o->iodepth || !o->iodepth_batch)
710 o->iodepth_batch = o->iodepth;
713 * If max batch complete number isn't set or set incorrectly,
714 * default to the same as iodepth_batch_complete_min
716 if (o->iodepth_batch_complete_min > o->iodepth_batch_complete_max)
717 o->iodepth_batch_complete_max = o->iodepth_batch_complete_min;
720 * There's no need to check for in-flight overlapping IOs if the job
721 * isn't changing data or the maximum iodepth is guaranteed to be 1
723 if (o->serialize_overlap && !(td->flags & TD_F_READ_IOLOG) &&
724 (!(td_write(td) || td_trim(td)) || o->iodepth == 1))
725 o->serialize_overlap = 0;
727 * Currently can't check for overlaps in offload mode
729 if (o->serialize_overlap && o->io_submit_mode == IO_MODE_OFFLOAD) {
730 log_err("fio: checking for in-flight overlaps when the "
731 "io_submit_mode is offload is not supported\n");
732 o->serialize_overlap = 0;
733 ret |= warnings_fatal;
736 if (o->nr_files > td->files_index)
737 o->nr_files = td->files_index;
739 if (o->open_files > o->nr_files || !o->open_files)
740 o->open_files = o->nr_files;
742 if (((o->rate[DDIR_READ] + o->rate[DDIR_WRITE] + o->rate[DDIR_TRIM]) &&
743 (o->rate_iops[DDIR_READ] + o->rate_iops[DDIR_WRITE] + o->rate_iops[DDIR_TRIM])) ||
744 ((o->ratemin[DDIR_READ] + o->ratemin[DDIR_WRITE] + o->ratemin[DDIR_TRIM]) &&
745 (o->rate_iops_min[DDIR_READ] + o->rate_iops_min[DDIR_WRITE] + o->rate_iops_min[DDIR_TRIM]))) {
746 log_err("fio: rate and rate_iops are mutually exclusive\n");
749 if ((o->rate[DDIR_READ] && (o->rate[DDIR_READ] < o->ratemin[DDIR_READ])) ||
750 (o->rate[DDIR_WRITE] && (o->rate[DDIR_WRITE] < o->ratemin[DDIR_WRITE])) ||
751 (o->rate[DDIR_TRIM] && (o->rate[DDIR_TRIM] < o->ratemin[DDIR_TRIM])) ||
752 (o->rate_iops[DDIR_READ] && (o->rate_iops[DDIR_READ] < o->rate_iops_min[DDIR_READ])) ||
753 (o->rate_iops[DDIR_WRITE] && (o->rate_iops[DDIR_WRITE] < o->rate_iops_min[DDIR_WRITE])) ||
754 (o->rate_iops[DDIR_TRIM] && (o->rate_iops[DDIR_TRIM] < o->rate_iops_min[DDIR_TRIM]))) {
755 log_err("fio: minimum rate exceeds rate\n");
759 if (!o->timeout && o->time_based) {
760 log_err("fio: time_based requires a runtime/timeout setting\n");
762 ret |= warnings_fatal;
765 if (o->fill_device && !o->size)
768 if (o->verify != VERIFY_NONE) {
769 if (td_write(td) && o->do_verify && o->numjobs > 1 &&
771 !(o->unique_filename &&
772 strstr(o->filename_format, "$jobname") &&
773 strstr(o->filename_format, "$jobnum") &&
774 strstr(o->filename_format, "$filenum")))) {
775 log_info("fio: multiple writers may overwrite blocks "
776 "that belong to other jobs. This can cause "
777 "verification failures.\n");
778 ret |= warnings_fatal;
782 * Warn if verification is requested but no verification of any
783 * kind can be started due to time constraints
785 if (td_write(td) && o->do_verify && o->timeout &&
786 o->time_based && !td_read(td) && !o->verify_backlog) {
787 log_info("fio: verification read phase will never "
788 "start because write phase uses all of "
790 ret |= warnings_fatal;
793 if (!fio_option_is_set(o, refill_buffers))
794 o->refill_buffers = 1;
796 if (o->max_bs[DDIR_WRITE] != o->min_bs[DDIR_WRITE] &&
798 o->verify_interval = o->min_bs[DDIR_WRITE];
801 * Verify interval must be smaller or equal to the
804 if (o->verify_interval > o->min_bs[DDIR_WRITE])
805 o->verify_interval = o->min_bs[DDIR_WRITE];
806 else if (td_read(td) && o->verify_interval > o->min_bs[DDIR_READ])
807 o->verify_interval = o->min_bs[DDIR_READ];
810 * Verify interval must be a factor of both min and max
813 if (!o->verify_interval ||
814 (o->min_bs[DDIR_WRITE] % o->verify_interval) ||
815 (o->max_bs[DDIR_WRITE] % o->verify_interval))
816 o->verify_interval = gcd(o->min_bs[DDIR_WRITE],
817 o->max_bs[DDIR_WRITE]);
821 if (o->invalidate_cache)
822 o->invalidate_cache = 0;
823 if (td_ioengine_flagged(td, FIO_PIPEIO)) {
824 log_info("fio: cannot pre-read files with an IO engine"
825 " that isn't seekable. Pre-read disabled.\n");
826 ret |= warnings_fatal;
830 if (o->unit_base == N2S_NONE) {
831 if (td_ioengine_flagged(td, FIO_BIT_BASED))
832 o->unit_base = N2S_BITPERSEC;
834 o->unit_base = N2S_BYTEPERSEC;
837 #ifndef FIO_HAVE_ANY_FALLOCATE
838 /* Platform doesn't support any fallocate so force it to none */
839 o->fallocate_mode = FIO_FALLOCATE_NONE;
842 #ifndef CONFIG_FDATASYNC
843 if (o->fdatasync_blocks) {
844 log_info("fio: this platform does not support fdatasync()"
845 " falling back to using fsync(). Use the 'fsync'"
846 " option instead of 'fdatasync' to get rid of"
848 o->fsync_blocks = o->fdatasync_blocks;
849 o->fdatasync_blocks = 0;
850 ret |= warnings_fatal;
856 * Windows doesn't support O_DIRECT or O_SYNC with the _open interface,
857 * so fail if we're passed those flags
859 if (td_ioengine_flagged(td, FIO_SYNCIO) && (o->odirect || o->sync_io)) {
860 log_err("fio: Windows does not support direct or non-buffered io with"
861 " the synchronous ioengines. Use the 'windowsaio' ioengine"
862 " with 'direct=1' and 'iodepth=1' instead.\n");
868 * For fully compressible data, just zero them at init time.
869 * It's faster than repeatedly filling it. For non-zero
870 * compression, we should have refill_buffers set. Set it, unless
871 * the job file already changed it.
873 if (o->compress_percentage) {
874 if (o->compress_percentage == 100) {
876 o->compress_percentage = 0;
877 } else if (!fio_option_is_set(o, refill_buffers)) {
878 o->refill_buffers = 1;
879 td->flags |= TD_F_REFILL_BUFFERS;
884 * Using a non-uniform random distribution excludes usage of
887 if (o->random_distribution != FIO_RAND_DIST_RANDOM)
891 * If size is set but less than the min block size, complain
893 if (o->size && o->size < td_min_bs(td)) {
894 log_err("fio: size too small, must not be less than minimum block size: %llu < %llu\n",
895 (unsigned long long) o->size, td_min_bs(td));
900 * O_ATOMIC implies O_DIRECT
906 * If randseed is set, that overrides randrepeat
908 if (fio_option_is_set(o, rand_seed))
909 o->rand_repeatable = 0;
911 if (td_ioengine_flagged(td, FIO_NOEXTEND) && o->file_append) {
912 log_err("fio: can't append/extent with IO engine %s\n", td->io_ops->name);
916 if (fio_option_is_set(o, gtod_cpu)) {
918 fio_gtod_set_cpu(o->gtod_cpu);
919 fio_gtod_offload = 1;
922 td->loops = o->loops;
926 if (o->block_error_hist && o->nr_files != 1) {
927 log_err("fio: block error histogram only available "
928 "with a single file per job, but %d files "
929 "provided\n", o->nr_files);
933 if (fio_option_is_set(o, clat_percentiles) &&
934 !fio_option_is_set(o, lat_percentiles)) {
935 o->lat_percentiles = !o->clat_percentiles;
936 } else if (fio_option_is_set(o, lat_percentiles) &&
937 !fio_option_is_set(o, clat_percentiles)) {
938 o->clat_percentiles = !o->lat_percentiles;
939 } else if (fio_option_is_set(o, lat_percentiles) &&
940 fio_option_is_set(o, clat_percentiles) &&
941 o->lat_percentiles && o->clat_percentiles) {
942 log_err("fio: lat_percentiles and clat_percentiles are "
943 "mutually exclusive\n");
948 o->lat_percentiles = 0;
950 o->clat_percentiles = 0;
953 * Fix these up to be nsec internally
955 o->max_latency *= 1000ULL;
956 o->latency_target *= 1000ULL;
957 o->latency_window *= 1000ULL;
962 static void init_rand_file_service(struct thread_data *td)
964 unsigned long nranges = td->o.nr_files << FIO_FSERVICE_SHIFT;
965 const unsigned int seed = td->rand_seeds[FIO_RAND_FILE_OFF];
967 if (td->o.file_service_type == FIO_FSERVICE_ZIPF) {
968 zipf_init(&td->next_file_zipf, nranges, td->zipf_theta, seed);
969 zipf_disable_hash(&td->next_file_zipf);
970 } else if (td->o.file_service_type == FIO_FSERVICE_PARETO) {
971 pareto_init(&td->next_file_zipf, nranges, td->pareto_h, seed);
972 zipf_disable_hash(&td->next_file_zipf);
973 } else if (td->o.file_service_type == FIO_FSERVICE_GAUSS) {
974 gauss_init(&td->next_file_gauss, nranges, td->gauss_dev, seed);
975 gauss_disable_hash(&td->next_file_gauss);
979 void td_fill_verify_state_seed(struct thread_data *td)
983 if (td->o.random_generator == FIO_RAND_GEN_TAUSWORTHE64)
988 init_rand_seed(&td->verify_state, td->rand_seeds[FIO_RAND_VER_OFF],
992 static void td_fill_rand_seeds_internal(struct thread_data *td, bool use64)
994 unsigned int read_seed = td->rand_seeds[FIO_RAND_BS_OFF];
995 unsigned int write_seed = td->rand_seeds[FIO_RAND_BS1_OFF];
996 unsigned int trim_seed = td->rand_seeds[FIO_RAND_BS2_OFF];
1000 * trimwrite is special in that we need to generate the same
1001 * offsets to get the "write after trim" effect. If we are
1002 * using bssplit to set buffer length distributions, ensure that
1003 * we seed the trim and write generators identically. Ditto for
1004 * verify, read and writes must have the same seed, if we are doing
1007 if (td->o.verify != VERIFY_NONE)
1008 write_seed = read_seed;
1009 if (td_trimwrite(td))
1010 trim_seed = write_seed;
1011 init_rand_seed(&td->bsrange_state[DDIR_READ], read_seed, use64);
1012 init_rand_seed(&td->bsrange_state[DDIR_WRITE], write_seed, use64);
1013 init_rand_seed(&td->bsrange_state[DDIR_TRIM], trim_seed, use64);
1015 td_fill_verify_state_seed(td);
1016 init_rand_seed(&td->rwmix_state, td->rand_seeds[FIO_RAND_MIX_OFF], false);
1018 if (td->o.file_service_type == FIO_FSERVICE_RANDOM)
1019 init_rand_seed(&td->next_file_state, td->rand_seeds[FIO_RAND_FILE_OFF], use64);
1020 else if (td->o.file_service_type & __FIO_FSERVICE_NONUNIFORM)
1021 init_rand_file_service(td);
1023 init_rand_seed(&td->file_size_state, td->rand_seeds[FIO_RAND_FILE_SIZE_OFF], use64);
1024 init_rand_seed(&td->trim_state, td->rand_seeds[FIO_RAND_TRIM_OFF], use64);
1025 init_rand_seed(&td->delay_state, td->rand_seeds[FIO_RAND_START_DELAY], use64);
1026 init_rand_seed(&td->poisson_state[0], td->rand_seeds[FIO_RAND_POISSON_OFF], 0);
1027 init_rand_seed(&td->poisson_state[1], td->rand_seeds[FIO_RAND_POISSON2_OFF], 0);
1028 init_rand_seed(&td->poisson_state[2], td->rand_seeds[FIO_RAND_POISSON3_OFF], 0);
1029 init_rand_seed(&td->dedupe_state, td->rand_seeds[FIO_DEDUPE_OFF], false);
1030 init_rand_seed(&td->zone_state, td->rand_seeds[FIO_RAND_ZONE_OFF], false);
1035 if (td->o.rand_repeatable)
1036 td->rand_seeds[FIO_RAND_BLOCK_OFF] = FIO_RANDSEED * td->thread_number;
1038 init_rand_seed(&td->random_state, td->rand_seeds[FIO_RAND_BLOCK_OFF], use64);
1040 for (i = 0; i < DDIR_RWDIR_CNT; i++) {
1041 struct frand_state *s = &td->seq_rand_state[i];
1043 init_rand_seed(s, td->rand_seeds[FIO_RAND_SEQ_RAND_READ_OFF], false);
1047 void td_fill_rand_seeds(struct thread_data *td)
1051 if (td->o.allrand_repeatable) {
1054 for (i = 0; i < FIO_RAND_NR_OFFS; i++)
1055 td->rand_seeds[i] = FIO_RANDSEED * td->thread_number
1059 if (td->o.random_generator == FIO_RAND_GEN_TAUSWORTHE64)
1064 td_fill_rand_seeds_internal(td, use64);
1066 init_rand_seed(&td->buf_state, td->rand_seeds[FIO_RAND_BUF_OFF], use64);
1067 frand_copy(&td->buf_state_prev, &td->buf_state);
1071 * Initializes the ioengine configured for a job, if it has not been done so
1074 int ioengine_load(struct thread_data *td)
1076 if (!td->o.ioengine) {
1077 log_err("fio: internal fault, no IO engine specified\n");
1082 struct ioengine_ops *ops;
1085 /* An engine is loaded, but the requested ioengine
1088 if (!strcmp(td->io_ops->name, td->o.ioengine)) {
1089 /* The right engine is already loaded */
1094 * Name of file and engine may be different, load ops
1095 * for this name and see if they match. If they do, then
1096 * the engine is unchanged.
1098 dlhandle = td->io_ops_dlhandle;
1099 ops = load_ioengine(td);
1100 if (ops == td->io_ops && dlhandle == td->io_ops_dlhandle) {
1106 if (dlhandle && dlhandle != td->io_ops_dlhandle)
1109 /* Unload the old engine. */
1113 td->io_ops = load_ioengine(td);
1115 log_err("fio: failed to load engine\n");
1119 if (td->io_ops->option_struct_size && td->io_ops->options) {
1121 * In cases where td->eo is set, clone it for a child thread.
1122 * This requires that the parent thread has the same ioengine,
1123 * but that requirement must be enforced by the code which
1124 * cloned the thread.
1126 void *origeo = td->eo;
1128 * Otherwise use the default thread options.
1130 if (!origeo && td != &def_thread && def_thread.eo &&
1131 def_thread.io_ops->options == td->io_ops->options)
1132 origeo = def_thread.eo;
1134 options_init(td->io_ops->options);
1135 td->eo = malloc(td->io_ops->option_struct_size);
1137 * Use the default thread as an option template if this uses the
1138 * same options structure and there are non-default options
1142 memcpy(td->eo, origeo, td->io_ops->option_struct_size);
1143 options_mem_dupe(td->io_ops->options, td->eo);
1145 memset(td->eo, 0, td->io_ops->option_struct_size);
1146 fill_default_options(td->eo, td->io_ops->options);
1148 *(struct thread_data **)td->eo = td;
1152 td->io_ops->flags |= FIO_RAWIO;
1154 td_set_ioengine_flags(td);
1158 static void init_flags(struct thread_data *td)
1160 struct thread_options *o = &td->o;
1163 if (o->verify_backlog)
1164 td->flags |= TD_F_VER_BACKLOG;
1165 if (o->trim_backlog)
1166 td->flags |= TD_F_TRIM_BACKLOG;
1167 if (o->read_iolog_file)
1168 td->flags |= TD_F_READ_IOLOG;
1169 if (o->refill_buffers)
1170 td->flags |= TD_F_REFILL_BUFFERS;
1172 * Always scramble buffers if asked to
1174 if (o->scramble_buffers && fio_option_is_set(o, scramble_buffers))
1175 td->flags |= TD_F_SCRAMBLE_BUFFERS;
1177 * But also scramble buffers, unless we were explicitly asked
1180 if (o->scramble_buffers && !(o->zero_buffers &&
1181 fio_option_is_set(o, zero_buffers)))
1182 td->flags |= TD_F_SCRAMBLE_BUFFERS;
1183 if (o->verify != VERIFY_NONE)
1184 td->flags |= TD_F_DO_VERIFY;
1186 if (o->verify_async || o->io_submit_mode == IO_MODE_OFFLOAD)
1187 td->flags |= TD_F_NEED_LOCK;
1189 if (o->mem_type == MEM_CUDA_MALLOC)
1190 td->flags &= ~TD_F_SCRAMBLE_BUFFERS;
1192 for (i = 0; i < DDIR_RWDIR_CNT; i++) {
1193 if (option_check_rate(td, i)) {
1194 td->flags |= TD_F_CHECK_RATE;
1200 static int setup_random_seeds(struct thread_data *td)
1205 if (!td->o.rand_repeatable && !fio_option_is_set(&td->o, rand_seed)) {
1206 int ret = init_random_seeds(td->rand_seeds, sizeof(td->rand_seeds));
1208 td_fill_rand_seeds(td);
1212 seed = td->o.rand_seed;
1213 for (i = 0; i < 4; i++)
1214 seed *= 0x9e370001UL;
1216 for (i = 0; i < FIO_RAND_NR_OFFS; i++) {
1217 td->rand_seeds[i] = seed * td->thread_number + i;
1218 seed *= 0x9e370001UL;
1221 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 = NULL, },
1243 static char *make_filename(char *buf, size_t buf_size,struct thread_options *o,
1244 const char *jobname, int jobnum, int filenum)
1246 struct fpre_keyword *f;
1247 char copy[PATH_MAX];
1248 size_t dst_left = PATH_MAX - 1;
1250 if (!o->filename_format || !strlen(o->filename_format)) {
1251 sprintf(buf, "%s.%d.%d", jobname, jobnum, filenum);
1255 for (f = &fpre_keywords[0]; f->keyword; f++)
1256 f->strlen = strlen(f->keyword);
1258 buf[buf_size - 1] = '\0';
1259 strncpy(buf, o->filename_format, buf_size - 1);
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");
1336 strncpy(dst, buf + post_start, dst_left);
1338 strncpy(buf, copy, buf_size - 1);
1345 bool parse_dryrun(void)
1347 return dump_cmdline || parse_only;
1350 static void gen_log_name(char *name, size_t size, const char *logtype,
1351 const char *logname, unsigned int num,
1352 const char *suf, int per_job)
1355 snprintf(name, size, "%s_%s.%d.%s", logname, logtype, num, suf);
1357 snprintf(name, size, "%s_%s.%s", logname, logtype, suf);
1360 static int check_waitees(char *waitee)
1362 struct thread_data *td;
1365 for_each_td(td, i) {
1366 if (td->subjob_number)
1369 ret += !strcmp(td->o.name, waitee);
1375 static bool wait_for_ok(const char *jobname, struct thread_options *o)
1382 if (!strcmp(jobname, o->wait_for)) {
1383 log_err("%s: a job cannot wait for itself (wait_for=%s).\n",
1384 jobname, o->wait_for);
1388 if (!(nw = check_waitees(o->wait_for))) {
1389 log_err("%s: waitee job %s unknown.\n", jobname, o->wait_for);
1394 log_err("%s: multiple waitees %s found,\n"
1395 "please avoid duplicates when using wait_for option.\n",
1396 jobname, o->wait_for);
1404 * Adds a job to the list of things todo. Sanitizes the various options
1405 * to make sure we don't have conflicts, and initializes various
1408 static int add_job(struct thread_data *td, const char *jobname, int job_add_num,
1409 int recursed, int client_type)
1412 char fname[PATH_MAX];
1413 int numjobs, file_alloced;
1414 struct thread_options *o = &td->o;
1415 char logname[PATH_MAX + 32];
1418 * the def_thread is just for options, it's not a real job
1420 if (td == &def_thread)
1426 * if we are just dumping the output command line, don't add the job
1428 if (parse_dryrun()) {
1433 td->client_type = client_type;
1435 if (profile_td_init(td))
1438 if (ioengine_load(td))
1442 if (!o->filename && !td->files_index && !o->read_iolog_file) {
1445 if (o->nr_files == 1 && exists_and_not_regfile(jobname))
1446 add_file(td, jobname, job_add_num, 0);
1448 for (i = 0; i < o->nr_files; i++)
1449 add_file(td, make_filename(fname, sizeof(fname), o, jobname, job_add_num, i), job_add_num, 0);
1453 if (setup_random_seeds(td)) {
1454 td_verror(td, errno, "setup_random_seeds");
1458 if (fixup_options(td))
1462 * Belongs to fixup_options, but o->name is not necessarily set as yet
1464 if (!wait_for_ok(jobname, o))
1470 * IO engines only need this for option callbacks, and the address may
1471 * change in subprocesses.
1474 *(struct thread_data **)td->eo = NULL;
1476 if (td_ioengine_flagged(td, FIO_DISKLESSIO)) {
1479 for_each_file(td, f, i)
1480 f->real_file_size = -1ULL;
1483 td->sem = fio_sem_init(FIO_SEM_LOCKED);
1485 td->ts.clat_percentiles = o->clat_percentiles;
1486 td->ts.lat_percentiles = o->lat_percentiles;
1487 td->ts.percentile_precision = o->percentile_precision;
1488 memcpy(td->ts.percentile_list, o->percentile_list, sizeof(o->percentile_list));
1489 td->ts.sig_figs = o->sig_figs;
1491 for (i = 0; i < DDIR_RWDIR_CNT; i++) {
1492 td->ts.clat_stat[i].min_val = ULONG_MAX;
1493 td->ts.slat_stat[i].min_val = ULONG_MAX;
1494 td->ts.lat_stat[i].min_val = ULONG_MAX;
1495 td->ts.bw_stat[i].min_val = ULONG_MAX;
1496 td->ts.iops_stat[i].min_val = ULONG_MAX;
1498 td->ts.sync_stat.min_val = ULONG_MAX;
1499 td->ddir_seq_nr = o->ddir_seq_nr;
1501 if ((o->stonewall || o->new_group) && prev_group_jobs) {
1502 prev_group_jobs = 0;
1504 if (groupid == INT_MAX) {
1505 log_err("fio: too many groups defined\n");
1510 td->groupid = groupid;
1516 if (o->write_lat_log) {
1517 struct log_params p = {
1519 .avg_msec = o->log_avg_msec,
1520 .hist_msec = o->log_hist_msec,
1521 .hist_coarseness = o->log_hist_coarseness,
1522 .log_type = IO_LOG_TYPE_LAT,
1523 .log_offset = o->log_offset,
1524 .log_gz = o->log_gz,
1525 .log_gz_store = o->log_gz_store,
1527 const char *pre = o->lat_log_file ? o->lat_log_file : o->name;
1535 gen_log_name(logname, sizeof(logname), "lat", pre,
1536 td->thread_number, suf, o->per_job_logs);
1537 setup_log(&td->lat_log, &p, logname);
1539 gen_log_name(logname, sizeof(logname), "slat", pre,
1540 td->thread_number, suf, o->per_job_logs);
1541 setup_log(&td->slat_log, &p, logname);
1543 gen_log_name(logname, sizeof(logname), "clat", pre,
1544 td->thread_number, suf, o->per_job_logs);
1545 setup_log(&td->clat_log, &p, logname);
1548 if (o->write_hist_log) {
1549 struct log_params p = {
1551 .avg_msec = o->log_avg_msec,
1552 .hist_msec = o->log_hist_msec,
1553 .hist_coarseness = o->log_hist_coarseness,
1554 .log_type = IO_LOG_TYPE_HIST,
1555 .log_offset = o->log_offset,
1556 .log_gz = o->log_gz,
1557 .log_gz_store = o->log_gz_store,
1559 const char *pre = o->hist_log_file ? o->hist_log_file : o->name;
1563 if (td->client_type) {
1564 log_err("fio: --write_hist_log requires zlib in client/server mode\n");
1574 gen_log_name(logname, sizeof(logname), "clat_hist", pre,
1575 td->thread_number, suf, o->per_job_logs);
1576 setup_log(&td->clat_hist_log, &p, logname);
1579 if (o->write_bw_log) {
1580 struct log_params p = {
1582 .avg_msec = o->log_avg_msec,
1583 .hist_msec = o->log_hist_msec,
1584 .hist_coarseness = o->log_hist_coarseness,
1585 .log_type = IO_LOG_TYPE_BW,
1586 .log_offset = o->log_offset,
1587 .log_gz = o->log_gz,
1588 .log_gz_store = o->log_gz_store,
1590 const char *pre = o->bw_log_file ? o->bw_log_file : o->name;
1593 if (fio_option_is_set(o, bw_avg_time))
1594 p.avg_msec = min(o->log_avg_msec, o->bw_avg_time);
1596 o->bw_avg_time = p.avg_msec;
1598 p.hist_msec = o->log_hist_msec;
1599 p.hist_coarseness = o->log_hist_coarseness;
1606 gen_log_name(logname, sizeof(logname), "bw", pre,
1607 td->thread_number, suf, o->per_job_logs);
1608 setup_log(&td->bw_log, &p, logname);
1610 if (o->write_iops_log) {
1611 struct log_params p = {
1613 .avg_msec = o->log_avg_msec,
1614 .hist_msec = o->log_hist_msec,
1615 .hist_coarseness = o->log_hist_coarseness,
1616 .log_type = IO_LOG_TYPE_IOPS,
1617 .log_offset = o->log_offset,
1618 .log_gz = o->log_gz,
1619 .log_gz_store = o->log_gz_store,
1621 const char *pre = o->iops_log_file ? o->iops_log_file : o->name;
1624 if (fio_option_is_set(o, iops_avg_time))
1625 p.avg_msec = min(o->log_avg_msec, o->iops_avg_time);
1627 o->iops_avg_time = p.avg_msec;
1629 p.hist_msec = o->log_hist_msec;
1630 p.hist_coarseness = o->log_hist_coarseness;
1637 gen_log_name(logname, sizeof(logname), "iops", pre,
1638 td->thread_number, suf, o->per_job_logs);
1639 setup_log(&td->iops_log, &p, logname);
1643 o->name = strdup(jobname);
1645 if (output_format & FIO_OUTPUT_NORMAL) {
1647 if (is_backend && !recursed)
1648 fio_server_send_add_job(td);
1650 if (!td_ioengine_flagged(td, FIO_NOIO)) {
1651 char *c1, *c2, *c3, *c4;
1652 char *c5 = NULL, *c6 = NULL;
1653 int i2p = is_power_of_2(o->kb_base);
1655 c1 = num2str(o->min_bs[DDIR_READ], o->sig_figs, 1, i2p, N2S_BYTE);
1656 c2 = num2str(o->max_bs[DDIR_READ], o->sig_figs, 1, i2p, N2S_BYTE);
1657 c3 = num2str(o->min_bs[DDIR_WRITE], o->sig_figs, 1, i2p, N2S_BYTE);
1658 c4 = num2str(o->max_bs[DDIR_WRITE], o->sig_figs, 1, i2p, N2S_BYTE);
1660 if (!o->bs_is_seq_rand) {
1661 c5 = num2str(o->min_bs[DDIR_TRIM], o->sig_figs, 1, i2p, N2S_BYTE);
1662 c6 = num2str(o->max_bs[DDIR_TRIM], o->sig_figs, 1, i2p, N2S_BYTE);
1665 log_info("%s: (g=%d): rw=%s, ", td->o.name,
1667 ddir_str(o->td_ddir));
1669 if (o->bs_is_seq_rand)
1670 log_info("bs=(R) %s-%s, (W) %s-%s, bs_is_seq_rand, ",
1673 log_info("bs=(R) %s-%s, (W) %s-%s, (T) %s-%s, ",
1674 c1, c2, c3, c4, c5, c6);
1676 log_info("ioengine=%s, iodepth=%u\n",
1677 td->io_ops->name, o->iodepth);
1686 } else if (job_add_num == 1)
1690 if (td_steadystate_init(td))
1694 * recurse add identical jobs, clear numjobs and stonewall options
1695 * as they don't apply to sub-jobs
1697 numjobs = o->numjobs;
1699 struct thread_data *td_new = get_new_job(false, td, true, jobname);
1704 td_new->o.numjobs = 1;
1705 td_new->o.stonewall = 0;
1706 td_new->o.new_group = 0;
1707 td_new->subjob_number = numjobs;
1708 td_new->o.ss_dur = o->ss_dur * 1000000l;
1709 td_new->o.ss_limit = o->ss_limit;
1712 if (td_new->files) {
1714 for_each_file(td_new, f, i) {
1716 sfree(f->file_name);
1719 free(td_new->files);
1720 td_new->files = NULL;
1722 td_new->files_index = 0;
1723 td_new->files_size = 0;
1724 if (td_new->o.filename) {
1725 free(td_new->o.filename);
1726 td_new->o.filename = NULL;
1730 if (add_job(td_new, jobname, numjobs, 1, client_type))
1741 * Parse as if 'o' was a command line
1743 void add_job_opts(const char **o, int client_type)
1745 struct thread_data *td, *td_parent;
1746 int i, in_global = 1;
1750 td_parent = td = NULL;
1752 if (!strncmp(o[i], "name", 4)) {
1755 add_job(td, jobname, 0, 0, client_type);
1757 sprintf(jobname, "%s", o[i] + 5);
1759 if (in_global && !td_parent)
1760 td_parent = get_new_job(true, &def_thread, false, jobname);
1761 else if (!in_global && !td) {
1763 td_parent = &def_thread;
1764 td = get_new_job(false, td_parent, false, jobname);
1767 fio_options_parse(td_parent, (char **) &o[i], 1);
1769 fio_options_parse(td, (char **) &o[i], 1);
1774 add_job(td, jobname, 0, 0, client_type);
1777 static int skip_this_section(const char *name)
1781 if (!nr_job_sections)
1783 if (!strncmp(name, "global", 6))
1786 for (i = 0; i < nr_job_sections; i++)
1787 if (!strcmp(job_sections[i], name))
1793 static int is_empty_or_comment(char *line)
1797 for (i = 0; i < strlen(line); i++) {
1802 if (!isspace((int) line[i]) && !iscntrl((int) line[i]))
1810 * This is our [ini] type file parser.
1812 static int __parse_jobs_ini(struct thread_data *td,
1813 char *file, int is_buf, int stonewall_flag, int type,
1814 int nested, char *name, char ***popts, int *aopts, int *nopts)
1816 bool global = false;
1820 int ret = 0, stonewall;
1823 int inside_skip = 0;
1825 int i, alloc_opts, num_opts;
1827 dprint(FD_PARSE, "Parsing ini file %s\n", file);
1828 assert(td || !nested);
1833 if (!strcmp(file, "-"))
1836 f = fopen(file, "r");
1841 log_err("fio: unable to open '%s' job file\n", file);
1843 td_verror(td, __err, "job file open");
1848 string = malloc(4096);
1851 * it's really 256 + small bit, 280 should suffice
1855 memset(name, 0, 280);
1859 if (nested && popts) {
1861 alloc_opts = *aopts;
1867 opts = malloc(sizeof(char *) * alloc_opts);
1871 stonewall = stonewall_flag;
1874 * if skip_fgets is set, we already have loaded a line we
1879 p = strsep(&file, "\n");
1881 p = fgets(string, 4096, f);
1887 strip_blank_front(&p);
1890 dprint(FD_PARSE, "%s\n", p);
1891 if (is_empty_or_comment(p))
1895 if (sscanf(p, "[%255[^\n]]", name) != 1) {
1899 log_err("fio: option <%s> outside of "
1900 "[] job section\n", p);
1905 name[strlen(name) - 1] = '\0';
1907 if (skip_this_section(name)) {
1913 dprint(FD_PARSE, "Parsing section [%s]\n", name);
1915 global = !strncmp(name, "global", 6);
1921 log_info("--name=%s ", name);
1925 td = get_new_job(global, &def_thread, false, name);
1932 * Separate multiple job files by a stonewall
1934 if (!global && stonewall) {
1935 td->o.stonewall = stonewall;
1940 memset(opts, 0, alloc_opts * sizeof(char *));
1948 p = strsep(&file, "\n");
1950 p = fgets(string, 4096, f);
1953 dprint(FD_PARSE, "%s", p);
1958 if (is_empty_or_comment(p))
1961 strip_blank_front(&p);
1964 * new section, break out and make sure we don't
1965 * fgets() a new line at the top.
1969 log_err("No new sections in included files\n");
1980 if (!strncmp(p, "include", strlen("include"))) {
1981 char *filename = p + strlen("include") + 1,
1982 *ts, *full_fn = NULL;
1985 * Allow for the include filename
1986 * specification to be relative.
1988 if (access(filename, F_OK) &&
1989 (ts = strrchr(file, '/'))) {
1990 int len = ts - file +
1991 strlen(filename) + 2;
1993 if (!(full_fn = calloc(1, len))) {
1999 file, (ts - file) + 1);
2000 strncpy(full_fn + (ts - file) + 1,
2001 filename, strlen(filename));
2002 full_fn[len - 1] = 0;
2006 ret = __parse_jobs_ini(td, filename, is_buf,
2007 stonewall_flag, type, 1,
2009 &alloc_opts, &num_opts);
2012 log_err("Error %d while parsing "
2013 "include file %s\n",
2026 if (num_opts == alloc_opts) {
2028 opts = realloc(opts,
2029 alloc_opts * sizeof(char *));
2032 opts[num_opts] = strdup(p);
2038 *aopts = alloc_opts;
2043 ret = fio_options_parse(td, opts, num_opts);
2048 ret = add_job(td, name, 0, 0, type);
2050 log_err("fio: job %s dropped\n", name);
2054 for (i = 0; i < num_opts; i++)
2063 while (i < nr_job_sections) {
2064 free(job_sections[i]);
2073 if (!is_buf && f != stdin)
2078 int parse_jobs_ini(char *file, int is_buf, int stonewall_flag, int type)
2080 return __parse_jobs_ini(NULL, file, is_buf, stonewall_flag, type,
2081 0, NULL, NULL, NULL, NULL);
2084 static int fill_def_thread(void)
2086 memset(&def_thread, 0, sizeof(def_thread));
2087 INIT_FLIST_HEAD(&def_thread.opt_list);
2089 fio_getaffinity(getpid(), &def_thread.o.cpumask);
2090 def_thread.o.error_dump = 1;
2093 * fill default options
2095 fio_fill_default_options(&def_thread);
2099 static void show_debug_categories(void)
2101 #ifdef FIO_INC_DEBUG
2102 const struct debug_level *dl = &debug_levels[0];
2103 int curlen, first = 1;
2107 int has_next = (dl + 1)->name != NULL;
2109 if (first || curlen + strlen(dl->name) >= 80) {
2114 curlen += printf("\t\t\t%s", dl->name);
2115 curlen += 3 * (8 - 1);
2117 curlen += printf(",");
2119 curlen += printf("%s", dl->name);
2121 curlen += printf(",");
2131 * Following options aren't printed by usage().
2132 * --append-terse - Equivalent to --output-format=terse, see f6a7df53.
2133 * --latency-log - Deprecated option.
2135 static void usage(const char *name)
2137 printf("%s\n", fio_version_string);
2138 printf("%s [options] [job options] <job file(s)>\n", name);
2139 printf(" --debug=options\tEnable debug logging. May be one/more of:\n");
2140 show_debug_categories();
2141 printf(" --parse-only\t\tParse options only, don't start any IO\n");
2142 printf(" --output\t\tWrite output to file\n");
2143 printf(" --bandwidth-log\tGenerate aggregate bandwidth logs\n");
2144 printf(" --minimal\t\tMinimal (terse) output\n");
2145 printf(" --output-format=type\tOutput format (terse,json,json+,normal)\n");
2146 printf(" --terse-version=type\tSet terse version output format"
2147 " (default 3, or 2 or 4)\n");
2148 printf(" --version\t\tPrint version info and exit\n");
2149 printf(" --help\t\tPrint this page\n");
2150 printf(" --cpuclock-test\tPerform test/validation of CPU clock\n");
2151 printf(" --crctest=[type]\tTest speed of checksum functions\n");
2152 printf(" --cmdhelp=cmd\t\tPrint command help, \"all\" for all of"
2154 printf(" --enghelp=engine\tPrint ioengine help, or list"
2155 " available ioengines\n");
2156 printf(" --enghelp=engine,cmd\tPrint help for an ioengine"
2158 printf(" --showcmd\t\tTurn a job file into command line options\n");
2159 printf(" --eta=when\t\tWhen ETA estimate should be printed\n");
2160 printf(" \t\tMay be \"always\", \"never\" or \"auto\"\n");
2161 printf(" --eta-newline=time\tForce a new line for every 'time'");
2162 printf(" period passed\n");
2163 printf(" --status-interval=t\tForce full status dump every");
2164 printf(" 't' period passed\n");
2165 printf(" --readonly\t\tTurn on safety read-only checks, preventing"
2167 printf(" --section=name\tOnly run specified section in job file,"
2168 " multiple sections can be specified\n");
2169 printf(" --alloc-size=kb\tSet smalloc pool to this size in kb"
2171 printf(" --warnings-fatal\tFio parser warnings are fatal\n");
2172 printf(" --max-jobs=nr\t\tMaximum number of threads/processes to support\n");
2173 printf(" --server=args\t\tStart a backend fio server\n");
2174 printf(" --daemonize=pidfile\tBackground fio server, write pid to file\n");
2175 printf(" --client=hostname\tTalk to remote backend(s) fio server at hostname\n");
2176 printf(" --remote-config=file\tTell fio server to load this local job file\n");
2177 printf(" --idle-prof=option\tReport cpu idleness on a system or percpu basis\n"
2178 "\t\t\t(option=system,percpu) or run unit work\n"
2179 "\t\t\tcalibration only (option=calibrate)\n");
2181 printf(" --inflate-log=log\tInflate and output compressed log\n");
2183 printf(" --trigger-file=file\tExecute trigger cmd when file exists\n");
2184 printf(" --trigger-timeout=t\tExecute trigger at this time\n");
2185 printf(" --trigger=cmd\t\tSet this command as local trigger\n");
2186 printf(" --trigger-remote=cmd\tSet this command as remote trigger\n");
2187 printf(" --aux-path=path\tUse this path for fio state generated files\n");
2188 printf("\nFio was written by Jens Axboe <axboe@kernel.dk>\n");
2191 #ifdef FIO_INC_DEBUG
2192 const struct debug_level debug_levels[] = {
2193 { .name = "process",
2194 .help = "Process creation/exit logging",
2195 .shift = FD_PROCESS,
2198 .help = "File related action logging",
2202 .help = "IO and IO engine action logging (offsets, queue, completions, etc)",
2206 .help = "Memory allocation/freeing logging",
2209 { .name = "blktrace",
2210 .help = "blktrace action logging",
2211 .shift = FD_BLKTRACE,
2214 .help = "IO verification action logging",
2218 .help = "Random generation logging",
2222 .help = "Parser logging",
2225 { .name = "diskutil",
2226 .help = "Disk utility logging actions",
2227 .shift = FD_DISKUTIL,
2230 .help = "Logging related to creating/destroying jobs",
2234 .help = "Mutex logging",
2237 { .name = "profile",
2238 .help = "Logging related to profiles",
2239 .shift = FD_PROFILE,
2242 .help = "Logging related to time keeping functions",
2246 .help = "Network logging",
2250 .help = "Rate logging",
2253 { .name = "compress",
2254 .help = "Log compression logging",
2255 .shift = FD_COMPRESS,
2257 { .name = "steadystate",
2258 .help = "Steady state detection logging",
2259 .shift = FD_STEADYSTATE,
2261 { .name = "helperthread",
2262 .help = "Helper thread logging",
2263 .shift = FD_HELPERTHREAD,
2268 static int set_debug(const char *string)
2270 const struct debug_level *dl;
2271 char *p = (char *) string;
2278 if (!strcmp(string, "?") || !strcmp(string, "help")) {
2279 log_info("fio: dumping debug options:");
2280 for (i = 0; debug_levels[i].name; i++) {
2281 dl = &debug_levels[i];
2282 log_info("%s,", dl->name);
2288 while ((opt = strsep(&p, ",")) != NULL) {
2291 if (!strncmp(opt, "all", 3)) {
2292 log_info("fio: set all debug options\n");
2297 for (i = 0; debug_levels[i].name; i++) {
2298 dl = &debug_levels[i];
2299 found = !strncmp(opt, dl->name, strlen(dl->name));
2303 if (dl->shift == FD_JOB) {
2304 opt = strchr(opt, ':');
2306 log_err("fio: missing job number\n");
2310 fio_debug_jobno = atoi(opt);
2311 log_info("fio: set debug jobno %d\n",
2314 log_info("fio: set debug option %s\n", opt);
2315 fio_debug |= (1UL << dl->shift);
2321 log_err("fio: debug mask %s not found\n", opt);
2326 static int set_debug(const char *string)
2328 log_err("fio: debug tracing not included in build\n");
2333 static void fio_options_fill_optstring(void)
2335 char *ostr = cmd_optstr;
2339 while (l_opts[i].name) {
2340 ostr[c++] = l_opts[i].val;
2341 if (l_opts[i].has_arg == required_argument)
2343 else if (l_opts[i].has_arg == optional_argument) {
2352 static int client_flag_set(char c)
2357 while (l_opts[i].name) {
2358 int val = l_opts[i].val;
2360 if (c == (val & 0xff))
2361 return (val & FIO_CLIENT_FLAG);
2369 static void parse_cmd_client(void *client, char *opt)
2371 fio_client_add_cmd_option(client, opt);
2374 static void show_closest_option(const char *name)
2376 int best_option, best_distance;
2379 while (*name == '-')
2383 best_distance = INT_MAX;
2385 while (l_opts[i].name) {
2386 distance = string_distance(name, l_opts[i].name);
2387 if (distance < best_distance) {
2388 best_distance = distance;
2394 if (best_option != -1 && string_distance_ok(name, best_distance))
2395 log_err("Did you mean %s?\n", l_opts[best_option].name);
2398 static int parse_output_format(const char *optarg)
2400 char *p, *orig, *opt;
2403 p = orig = strdup(optarg);
2407 while ((opt = strsep(&p, ",")) != NULL) {
2408 if (!strcmp(opt, "minimal") ||
2409 !strcmp(opt, "terse") ||
2410 !strcmp(opt, "csv"))
2411 output_format |= FIO_OUTPUT_TERSE;
2412 else if (!strcmp(opt, "json"))
2413 output_format |= FIO_OUTPUT_JSON;
2414 else if (!strcmp(opt, "json+"))
2415 output_format |= (FIO_OUTPUT_JSON | FIO_OUTPUT_JSON_PLUS);
2416 else if (!strcmp(opt, "normal"))
2417 output_format |= FIO_OUTPUT_NORMAL;
2419 log_err("fio: invalid output format %s\n", opt);
2429 int parse_cmd_line(int argc, char *argv[], int client_type)
2431 struct thread_data *td = NULL;
2432 int c, ini_idx = 0, lidx, ret = 0, do_exit = 0, exit_val = 0;
2433 char *ostr = cmd_optstr;
2434 char *pid_file = NULL;
2435 void *cur_client = NULL;
2439 * Reset optind handling, since we may call this multiple times
2444 while ((c = getopt_long_only(argc, argv, ostr, l_opts, &lidx)) != -1) {
2445 if ((c & FIO_CLIENT_FLAG) || client_flag_set(c)) {
2446 parse_cmd_client(cur_client, argv[optind - 1]);
2447 c &= ~FIO_CLIENT_FLAG;
2452 smalloc_pool_size = atoi(optarg);
2453 smalloc_pool_size <<= 10;
2457 log_err("fio: --latency-log is deprecated. Use per-job latency log options.\n");
2467 if (f_out && f_out != stdout)
2470 tmp = fopen(optarg, "w+");
2472 log_err("fio: output file open error: %s\n", strerror(errno));
2477 f_err = f_out = tmp;
2481 output_format = FIO_OUTPUT_TERSE;
2484 if (parse_output_format(optarg)) {
2485 log_err("fio: failed parsing output-format\n");
2492 output_format |= FIO_OUTPUT_TERSE;
2504 fio_show_option_help(optarg);
2511 fio_show_ioengine_help(optarg);
2525 log_info("%s\n", fio_version_string);
2530 terse_version = atoi(optarg);
2531 if (!(terse_version >= 2 && terse_version <= 5)) {
2532 log_err("fio: bad terse version format\n");
2538 if (!strcmp("always", optarg))
2539 eta_print = FIO_ETA_ALWAYS;
2540 else if (!strcmp("never", optarg))
2541 eta_print = FIO_ETA_NEVER;
2546 if (check_str_time(optarg, &t, 1)) {
2547 log_err("fio: failed parsing eta time %s\n", optarg);
2552 eta_new_line = t / 1000;
2553 if (!eta_new_line) {
2554 log_err("fio: eta new line time too short\n");
2563 if (check_str_time(optarg, &t, 1)) {
2564 log_err("fio: failed parsing eta interval %s\n", optarg);
2569 eta_interval_msec = t / 1000;
2570 if (eta_interval_msec < DISK_UTIL_MSEC) {
2571 log_err("fio: eta interval time too short (%umsec min)\n", DISK_UTIL_MSEC);
2578 if (set_debug(optarg))
2588 if (!strcmp(optarg, "global")) {
2589 log_err("fio: can't use global as only "
2595 new_size = (nr_job_sections + 1) * sizeof(char *);
2596 job_sections = realloc(job_sections, new_size);
2597 job_sections[nr_job_sections] = strdup(optarg);
2603 exit_val = iolog_file_inflate(optarg);
2612 exec_profile = strdup(optarg);
2614 case FIO_GETOPT_JOB: {
2615 const char *opt = l_opts[lidx].name;
2618 if (!strncmp(opt, "name", 4) && td) {
2619 ret = add_job(td, td->o.name ?: "fio", 0, 0, client_type);
2626 int is_section = !strncmp(opt, "name", 4);
2629 if (!is_section || !strncmp(val, "global", 6))
2632 if (is_section && skip_this_section(val))
2635 td = get_new_job(global, &def_thread, true, NULL);
2636 if (!td || ioengine_load(td)) {
2645 fio_options_set_ioengine_opts(l_opts, td);
2648 if ((!val || !strlen(val)) &&
2649 l_opts[lidx].has_arg == required_argument) {
2650 log_err("fio: option %s requires an argument\n", opt);
2653 ret = fio_cmd_option_parse(td, opt, val);
2664 if (!ret && !strcmp(opt, "ioengine")) {
2665 if (ioengine_load(td)) {
2672 fio_options_set_ioengine_opts(l_opts, td);
2676 case FIO_GETOPT_IOENGINE: {
2677 const char *opt = l_opts[lidx].name;
2683 ret = fio_cmd_ioengine_option_parse(td, opt, val);
2690 max_jobs = atoi(optarg);
2691 if (!max_jobs || max_jobs > REAL_MAX_JOBS) {
2692 log_err("fio: invalid max jobs: %d\n", max_jobs);
2699 #ifndef CONFIG_NO_SHM
2701 log_err("fio: can't be both client and server\n");
2707 fio_server_set_arg(optarg);
2711 log_err("fio: client/server requires SHM support\n");
2719 pid_file = strdup(optarg);
2722 if ((ret = fio_idle_prof_parse_opt(optarg))) {
2723 /* exit on error and calibration only */
2733 log_err("fio: can't be both client and server\n");
2738 /* if --client parameter contains a pathname */
2739 if (0 == access(optarg, R_OK)) {
2740 /* file contains a list of host addrs or names */
2741 char hostaddr[PATH_MAX] = {0};
2743 FILE * hostf = fopen(optarg, "r");
2745 log_err("fio: could not open client list file %s for read\n", optarg);
2750 sprintf(formatstr, "%%%ds", PATH_MAX - 1);
2752 * read at most PATH_MAX-1 chars from each
2753 * record in this file
2755 while (fscanf(hostf, formatstr, hostaddr) == 1) {
2756 /* expect EVERY host in file to be valid */
2757 if (fio_client_add(&fio_client_ops, hostaddr, &cur_client)) {
2758 log_err("fio: failed adding client %s from file %s\n", hostaddr, optarg);
2765 break; /* no possibility of job file for "this client only" */
2767 if (fio_client_add(&fio_client_ops, optarg, &cur_client)) {
2768 log_err("fio: failed adding client %s\n", optarg);
2774 * If the next argument exists and isn't an option,
2775 * assume it's a job file for this client only.
2777 while (optind < argc) {
2778 if (!strncmp(argv[optind], "--", 2) ||
2779 !strncmp(argv[optind], "-", 1))
2782 if (fio_client_add_ini_file(cur_client, argv[optind], false))
2789 if (fio_client_add_ini_file(cur_client, optarg, true)) {
2797 exit_val = fio_monotonic_clocktest(1);
2802 exit_val = fio_crctest(optarg);
2807 exit_val = fio_memcpy_test(optarg);
2812 if (check_str_time(optarg, &val, 1)) {
2813 log_err("fio: failed parsing time %s\n", optarg);
2819 log_err("fio: status interval too small\n");
2823 status_interval = val / 1000;
2829 trigger_file = strdup(optarg);
2834 trigger_cmd = strdup(optarg);
2837 if (trigger_remote_cmd)
2838 free(trigger_remote_cmd);
2839 trigger_remote_cmd = strdup(optarg);
2844 aux_path = strdup(optarg);
2847 if (check_str_time(optarg, &trigger_timeout, 1)) {
2848 log_err("fio: failed parsing time %s\n", optarg);
2852 trigger_timeout /= 1000000;
2855 log_err("%s: unrecognized option '%s'\n", argv[0],
2857 show_closest_option(argv[optind - 1]);
2867 if (do_exit && !(is_backend || nr_clients))
2870 if (nr_clients && fio_clients_connect())
2873 if (is_backend && backend)
2874 return fio_start_server(pid_file);
2880 ret = add_job(td, td->o.name ?: "fio", 0, 0, client_type);
2886 while (!ret && optind < argc) {
2888 ini_file = realloc(ini_file, ini_idx * sizeof(char *));
2889 ini_file[ini_idx - 1] = strdup(argv[optind]);
2897 int fio_init_options(void)
2902 fio_options_fill_optstring();
2903 fio_options_dup_and_init(l_opts);
2907 if (fill_def_thread())
2913 extern int fio_check_options(struct thread_options *);
2915 int parse_options(int argc, char *argv[])
2917 const int type = FIO_CLIENT_TYPE_CLI;
2920 if (fio_init_options())
2922 if (fio_test_cconv(&def_thread.o))
2923 log_err("fio: failed internal cconv test\n");
2925 job_files = parse_cmd_line(argc, argv, type);
2927 if (job_files > 0) {
2928 for (i = 0; i < job_files; i++) {
2929 if (i && fill_def_thread())
2932 if (fio_clients_send_ini(ini_file[i]))
2935 } else if (!is_backend) {
2936 if (parse_jobs_ini(ini_file[i], 0, i, type))
2941 } else if (nr_clients) {
2942 if (fill_def_thread())
2944 if (fio_clients_send_ini(NULL))
2949 fio_options_free(&def_thread);
2950 filesetup_mem_free();
2952 if (!thread_number) {
2957 if (is_backend || nr_clients)
2962 log_err("No job(s) defined\n\n");
2967 if (output_format & FIO_OUTPUT_NORMAL)
2968 log_info("%s\n", fio_version_string);
2973 void options_default_fill(struct thread_options *o)
2975 memcpy(o, &def_thread.o, sizeof(*o));
2978 struct thread_data *get_global_options(void)