2 * This file contains job initialization and setup functions.
12 #include <sys/types.h>
15 #ifdef CONFIG_VALGRIND_DEV
16 #include <valgrind/drd.h>
18 #define DRD_IGNORE_VAR(x) do { } while (0)
22 #ifndef FIO_NO_HAVE_SHM_H
34 #include "steadystate.h"
36 #include "oslib/getopt.h"
37 #include "oslib/strcasestr.h"
41 #include "lib/memcpy.h"
43 const char fio_version_string[] = FIO_VERSION;
45 #define FIO_RANDSEED (0xb1899bedUL)
47 static char **ini_file;
48 static int max_jobs = FIO_MAX_JOBS;
49 static int dump_cmdline;
50 static int parse_only;
52 static struct thread_data def_thread;
53 struct thread_data *threads = NULL;
54 static char **job_sections;
55 static int nr_job_sections;
57 int exitall_on_terminate = 0;
58 int output_format = FIO_OUTPUT_NORMAL;
59 int eta_print = FIO_ETA_AUTO;
60 unsigned int eta_interval_msec = 1000;
64 char *exec_profile = NULL;
65 int warnings_fatal = 0;
66 int terse_version = 3;
73 int status_interval = 0;
75 char *trigger_file = NULL;
76 long long trigger_timeout = 0;
77 char *trigger_cmd = NULL;
78 char *trigger_remote_cmd = NULL;
80 char *aux_path = NULL;
82 static int prev_group_jobs;
84 unsigned long fio_debug = 0;
85 unsigned int fio_debug_jobno = -1;
86 unsigned int *fio_debug_jobp = NULL;
87 unsigned int *fio_warned = NULL;
89 static char cmd_optstr[256];
92 #define FIO_CLIENT_FLAG (1 << 16)
95 * Command line options. These will contain the above, plus a few
96 * extra that only pertain to fio itself and not jobs.
98 static struct option l_opts[FIO_NR_OPTIONS] = {
100 .name = (char *) "output",
101 .has_arg = required_argument,
102 .val = 'o' | FIO_CLIENT_FLAG,
105 .name = (char *) "latency-log",
106 .has_arg = required_argument,
107 .val = 'l' | FIO_CLIENT_FLAG,
110 .name = (char *) "bandwidth-log",
111 .has_arg = no_argument,
112 .val = 'b' | FIO_CLIENT_FLAG,
115 .name = (char *) "minimal",
116 .has_arg = no_argument,
117 .val = 'm' | FIO_CLIENT_FLAG,
120 .name = (char *) "output-format",
121 .has_arg = required_argument,
122 .val = 'F' | FIO_CLIENT_FLAG,
125 .name = (char *) "append-terse",
126 .has_arg = optional_argument,
130 .name = (char *) "version",
131 .has_arg = no_argument,
132 .val = 'v' | FIO_CLIENT_FLAG,
135 .name = (char *) "help",
136 .has_arg = no_argument,
137 .val = 'h' | FIO_CLIENT_FLAG,
140 .name = (char *) "cmdhelp",
141 .has_arg = optional_argument,
142 .val = 'c' | FIO_CLIENT_FLAG,
145 .name = (char *) "enghelp",
146 .has_arg = optional_argument,
147 .val = 'i' | FIO_CLIENT_FLAG,
150 .name = (char *) "showcmd",
151 .has_arg = no_argument,
152 .val = 's' | FIO_CLIENT_FLAG,
155 .name = (char *) "readonly",
156 .has_arg = no_argument,
157 .val = 'r' | FIO_CLIENT_FLAG,
160 .name = (char *) "eta",
161 .has_arg = required_argument,
162 .val = 'e' | FIO_CLIENT_FLAG,
165 .name = (char *) "eta-interval",
166 .has_arg = required_argument,
167 .val = 'O' | FIO_CLIENT_FLAG,
170 .name = (char *) "eta-newline",
171 .has_arg = required_argument,
172 .val = 'E' | FIO_CLIENT_FLAG,
175 .name = (char *) "debug",
176 .has_arg = required_argument,
177 .val = 'd' | FIO_CLIENT_FLAG,
180 .name = (char *) "parse-only",
181 .has_arg = no_argument,
182 .val = 'P' | FIO_CLIENT_FLAG,
185 .name = (char *) "section",
186 .has_arg = required_argument,
187 .val = 'x' | FIO_CLIENT_FLAG,
191 .name = (char *) "inflate-log",
192 .has_arg = required_argument,
193 .val = 'X' | FIO_CLIENT_FLAG,
197 .name = (char *) "alloc-size",
198 .has_arg = required_argument,
199 .val = 'a' | FIO_CLIENT_FLAG,
202 .name = (char *) "profile",
203 .has_arg = required_argument,
204 .val = 'p' | FIO_CLIENT_FLAG,
207 .name = (char *) "warnings-fatal",
208 .has_arg = no_argument,
209 .val = 'w' | FIO_CLIENT_FLAG,
212 .name = (char *) "max-jobs",
213 .has_arg = required_argument,
214 .val = 'j' | FIO_CLIENT_FLAG,
217 .name = (char *) "terse-version",
218 .has_arg = required_argument,
219 .val = 'V' | FIO_CLIENT_FLAG,
222 .name = (char *) "server",
223 .has_arg = optional_argument,
226 { .name = (char *) "daemonize",
227 .has_arg = required_argument,
231 .name = (char *) "client",
232 .has_arg = required_argument,
236 .name = (char *) "remote-config",
237 .has_arg = required_argument,
241 .name = (char *) "cpuclock-test",
242 .has_arg = no_argument,
246 .name = (char *) "crctest",
247 .has_arg = optional_argument,
251 .name = (char *) "memcpytest",
252 .has_arg = optional_argument,
256 .name = (char *) "idle-prof",
257 .has_arg = required_argument,
261 .name = (char *) "status-interval",
262 .has_arg = required_argument,
266 .name = (char *) "trigger-file",
267 .has_arg = required_argument,
271 .name = (char *) "trigger-timeout",
272 .has_arg = required_argument,
276 .name = (char *) "trigger",
277 .has_arg = required_argument,
281 .name = (char *) "trigger-remote",
282 .has_arg = required_argument,
286 .name = (char *) "aux-path",
287 .has_arg = required_argument,
295 void free_threads_shm(void)
299 #ifndef CONFIG_NO_SHM
300 struct shmid_ds sbuf;
304 shmctl(shm_id, IPC_RMID, &sbuf);
313 static void free_shm(void)
317 fio_debug_jobp = NULL;
324 free(trigger_remote_cmd);
325 trigger_file = trigger_cmd = trigger_remote_cmd = NULL;
327 options_free(fio_options, &def_thread.o);
334 * The thread area is shared between the main process and the job
335 * threads/processes. So setup a shared memory segment that will hold
336 * all the job info. We use the end of the region for keeping track of
337 * open files across jobs, for file sharing.
339 static int setup_thread_area(void)
347 * 1024 is too much on some machines, scale max_jobs if
348 * we get a failure that looks like too large a shm segment
351 size_t size = max_jobs * sizeof(struct thread_data);
353 size += 2 * sizeof(unsigned int);
355 #ifndef CONFIG_NO_SHM
356 shm_id = shmget(0, size, IPC_CREAT | 0600);
359 if (errno != EINVAL && errno != ENOMEM && errno != ENOSPC) {
364 threads = malloc(size);
372 #ifndef CONFIG_NO_SHM
376 threads = shmat(shm_id, NULL, 0);
377 if (threads == (void *) -1) {
381 if (shm_attach_to_open_removed())
382 shmctl(shm_id, IPC_RMID, NULL);
385 memset(threads, 0, max_jobs * sizeof(struct thread_data));
386 for (i = 0; i < max_jobs; i++)
387 DRD_IGNORE_VAR(threads[i]);
388 fio_debug_jobp = (unsigned int *)(threads + max_jobs);
389 *fio_debug_jobp = -1;
390 fio_warned = fio_debug_jobp + 1;
398 static void dump_print_option(struct print_option *p)
402 if (!strcmp("description", p->name))
407 log_info("--%s%s", p->name, p->value ? "" : " ");
409 log_info("=%s%s%s ", delim, p->value, delim);
412 static void dump_opt_list(struct thread_data *td)
414 struct flist_head *entry;
415 struct print_option *p;
417 if (flist_empty(&td->opt_list))
420 flist_for_each(entry, &td->opt_list) {
421 p = flist_entry(entry, struct print_option, list);
422 dump_print_option(p);
426 static void fio_dump_options_free(struct thread_data *td)
428 while (!flist_empty(&td->opt_list)) {
429 struct print_option *p;
431 p = flist_first_entry(&td->opt_list, struct print_option, list);
432 flist_del_init(&p->list);
439 static void copy_opt_list(struct thread_data *dst, struct thread_data *src)
441 struct flist_head *entry;
443 if (flist_empty(&src->opt_list))
446 flist_for_each(entry, &src->opt_list) {
447 struct print_option *srcp, *dstp;
449 srcp = flist_entry(entry, struct print_option, list);
450 dstp = malloc(sizeof(*dstp));
451 dstp->name = strdup(srcp->name);
453 dstp->value = strdup(srcp->value);
456 flist_add_tail(&dstp->list, &dst->opt_list);
461 * Return a free job structure.
463 static struct thread_data *get_new_job(bool global, struct thread_data *parent,
464 bool preserve_eo, const char *jobname)
466 struct thread_data *td;
470 if (setup_thread_area()) {
471 log_err("error: failed to setup shm segment\n");
474 if (thread_number >= max_jobs) {
475 log_err("error: maximum number of jobs (%d) reached.\n",
480 td = &threads[thread_number++];
483 INIT_FLIST_HEAD(&td->opt_list);
484 if (parent != &def_thread)
485 copy_opt_list(td, parent);
492 td->o.uid = td->o.gid = -1U;
494 dup_files(td, parent);
495 fio_options_mem_dupe(td);
497 profile_add_hooks(td);
499 td->thread_number = thread_number;
500 td->subjob_number = 0;
503 td->o.name = strdup(jobname);
505 if (!parent->o.group_reporting || parent == &def_thread)
511 static void put_job(struct thread_data *td)
513 if (td == &def_thread)
520 log_info("fio: %s\n", td->verror);
522 fio_options_free(td);
523 fio_dump_options_free(td);
530 memset(&threads[td->thread_number - 1], 0, sizeof(*td));
534 static int __setup_rate(struct thread_data *td, enum fio_ddir ddir)
536 unsigned int bs = td->o.min_bs[ddir];
538 assert(ddir_rw(ddir));
540 if (td->o.rate[ddir])
541 td->rate_bps[ddir] = td->o.rate[ddir];
543 td->rate_bps[ddir] = (uint64_t) td->o.rate_iops[ddir] * bs;
545 if (!td->rate_bps[ddir]) {
546 log_err("rate lower than supported\n");
550 td->rate_next_io_time[ddir] = 0;
551 td->rate_io_issue_bytes[ddir] = 0;
552 td->last_usec[ddir] = 0;
556 static int setup_rate(struct thread_data *td)
560 if (td->o.rate[DDIR_READ] || td->o.rate_iops[DDIR_READ])
561 ret = __setup_rate(td, DDIR_READ);
562 if (td->o.rate[DDIR_WRITE] || td->o.rate_iops[DDIR_WRITE])
563 ret |= __setup_rate(td, DDIR_WRITE);
564 if (td->o.rate[DDIR_TRIM] || td->o.rate_iops[DDIR_TRIM])
565 ret |= __setup_rate(td, DDIR_TRIM);
570 static int fixed_block_size(struct thread_options *o)
572 return o->min_bs[DDIR_READ] == o->max_bs[DDIR_READ] &&
573 o->min_bs[DDIR_WRITE] == o->max_bs[DDIR_WRITE] &&
574 o->min_bs[DDIR_TRIM] == o->max_bs[DDIR_TRIM] &&
575 o->min_bs[DDIR_READ] == o->min_bs[DDIR_WRITE] &&
576 o->min_bs[DDIR_READ] == o->min_bs[DDIR_TRIM];
580 static unsigned long long get_rand_start_delay(struct thread_data *td)
582 unsigned long long delayrange;
586 delayrange = td->o.start_delay_high - td->o.start_delay;
588 frand_max = rand_max(&td->delay_state);
589 r = __rand(&td->delay_state);
590 delayrange = (unsigned long long) ((double) delayrange * (r / (frand_max + 1.0)));
592 delayrange += td->o.start_delay;
599 static unsigned int gcd(unsigned int m, unsigned int n)
604 return gcd(n, m % n);
608 * Lazy way of fixing up options that depend on each other. We could also
609 * define option callback handlers, but this is easier.
611 static int fixup_options(struct thread_data *td)
613 struct thread_options *o = &td->o;
616 #ifndef CONFIG_PSHARED
617 if (!o->use_thread) {
618 log_info("fio: this platform does not support process shared"
619 " mutexes, forcing use of threads. Use the 'thread'"
620 " option to get rid of this warning.\n");
622 ret = warnings_fatal;
626 if (o->write_iolog_file && o->read_iolog_file) {
627 log_err("fio: read iolog overrides write_iolog\n");
628 free(o->write_iolog_file);
629 o->write_iolog_file = NULL;
630 ret = warnings_fatal;
634 * only really works with 1 file
636 if (o->zone_size && o->open_files > 1)
640 * If zone_range isn't specified, backward compatibility dictates it
641 * should be made equal to zone_size.
643 if (o->zone_size && !o->zone_range)
644 o->zone_range = o->zone_size;
647 * Reads can do overwrites, we always need to pre-create the file
652 if (!o->min_bs[DDIR_READ])
653 o->min_bs[DDIR_READ] = o->bs[DDIR_READ];
654 if (!o->max_bs[DDIR_READ])
655 o->max_bs[DDIR_READ] = o->bs[DDIR_READ];
656 if (!o->min_bs[DDIR_WRITE])
657 o->min_bs[DDIR_WRITE] = o->bs[DDIR_WRITE];
658 if (!o->max_bs[DDIR_WRITE])
659 o->max_bs[DDIR_WRITE] = o->bs[DDIR_WRITE];
660 if (!o->min_bs[DDIR_TRIM])
661 o->min_bs[DDIR_TRIM] = o->bs[DDIR_TRIM];
662 if (!o->max_bs[DDIR_TRIM])
663 o->max_bs[DDIR_TRIM] = o->bs[DDIR_TRIM];
665 o->rw_min_bs = min(o->min_bs[DDIR_READ], o->min_bs[DDIR_WRITE]);
666 o->rw_min_bs = min(o->min_bs[DDIR_TRIM], o->rw_min_bs);
669 * For random IO, allow blockalign offset other than min_bs.
671 if (!o->ba[DDIR_READ] || !td_random(td))
672 o->ba[DDIR_READ] = o->min_bs[DDIR_READ];
673 if (!o->ba[DDIR_WRITE] || !td_random(td))
674 o->ba[DDIR_WRITE] = o->min_bs[DDIR_WRITE];
675 if (!o->ba[DDIR_TRIM] || !td_random(td))
676 o->ba[DDIR_TRIM] = o->min_bs[DDIR_TRIM];
678 if ((o->ba[DDIR_READ] != o->min_bs[DDIR_READ] ||
679 o->ba[DDIR_WRITE] != o->min_bs[DDIR_WRITE] ||
680 o->ba[DDIR_TRIM] != o->min_bs[DDIR_TRIM]) &&
682 log_err("fio: Any use of blockalign= turns off randommap\n");
684 ret = warnings_fatal;
687 if (!o->file_size_high)
688 o->file_size_high = o->file_size_low;
690 if (o->start_delay_high)
691 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;
839 if (td_ioengine_flagged(td, FIO_BIT_BASED))
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)
1005 * trimwrite is special in that we need to generate the same
1006 * offsets to get the "write after trim" effect. If we are
1007 * using bssplit to set buffer length distributions, ensure that
1008 * we seed the trim and write generators identically.
1010 if (td_trimwrite(td)) {
1011 init_rand_seed(&td->bsrange_state[DDIR_READ], td->rand_seeds[FIO_RAND_BS_OFF], use64);
1012 init_rand_seed(&td->bsrange_state[DDIR_WRITE], td->rand_seeds[FIO_RAND_BS1_OFF], use64);
1013 init_rand_seed(&td->bsrange_state[DDIR_TRIM], td->rand_seeds[FIO_RAND_BS1_OFF], use64);
1015 init_rand_seed(&td->bsrange_state[DDIR_READ], td->rand_seeds[FIO_RAND_BS_OFF], use64);
1016 init_rand_seed(&td->bsrange_state[DDIR_WRITE], td->rand_seeds[FIO_RAND_BS1_OFF], use64);
1017 init_rand_seed(&td->bsrange_state[DDIR_TRIM], td->rand_seeds[FIO_RAND_BS2_OFF], use64);
1020 td_fill_verify_state_seed(td);
1021 init_rand_seed(&td->rwmix_state, td->rand_seeds[FIO_RAND_MIX_OFF], false);
1023 if (td->o.file_service_type == FIO_FSERVICE_RANDOM)
1024 init_rand_seed(&td->next_file_state, td->rand_seeds[FIO_RAND_FILE_OFF], use64);
1025 else if (td->o.file_service_type & __FIO_FSERVICE_NONUNIFORM)
1026 init_rand_file_service(td);
1028 init_rand_seed(&td->file_size_state, td->rand_seeds[FIO_RAND_FILE_SIZE_OFF], use64);
1029 init_rand_seed(&td->trim_state, td->rand_seeds[FIO_RAND_TRIM_OFF], use64);
1030 init_rand_seed(&td->delay_state, td->rand_seeds[FIO_RAND_START_DELAY], use64);
1031 init_rand_seed(&td->poisson_state[0], td->rand_seeds[FIO_RAND_POISSON_OFF], 0);
1032 init_rand_seed(&td->poisson_state[1], td->rand_seeds[FIO_RAND_POISSON2_OFF], 0);
1033 init_rand_seed(&td->poisson_state[2], td->rand_seeds[FIO_RAND_POISSON3_OFF], 0);
1034 init_rand_seed(&td->dedupe_state, td->rand_seeds[FIO_DEDUPE_OFF], false);
1035 init_rand_seed(&td->zone_state, td->rand_seeds[FIO_RAND_ZONE_OFF], false);
1040 if (td->o.rand_repeatable)
1041 td->rand_seeds[FIO_RAND_BLOCK_OFF] = FIO_RANDSEED * td->thread_number;
1043 init_rand_seed(&td->random_state, td->rand_seeds[FIO_RAND_BLOCK_OFF], use64);
1045 for (i = 0; i < DDIR_RWDIR_CNT; i++) {
1046 struct frand_state *s = &td->seq_rand_state[i];
1048 init_rand_seed(s, td->rand_seeds[FIO_RAND_SEQ_RAND_READ_OFF], false);
1052 void td_fill_rand_seeds(struct thread_data *td)
1056 if (td->o.allrand_repeatable) {
1059 for (i = 0; i < FIO_RAND_NR_OFFS; i++)
1060 td->rand_seeds[i] = FIO_RANDSEED * td->thread_number
1064 if (td->o.random_generator == FIO_RAND_GEN_TAUSWORTHE64)
1069 td_fill_rand_seeds_internal(td, use64);
1071 init_rand_seed(&td->buf_state, td->rand_seeds[FIO_RAND_BUF_OFF], use64);
1072 frand_copy(&td->buf_state_prev, &td->buf_state);
1076 * Initializes the ioengine configured for a job, if it has not been done so
1079 int ioengine_load(struct thread_data *td)
1081 if (!td->o.ioengine) {
1082 log_err("fio: internal fault, no IO engine specified\n");
1087 struct ioengine_ops *ops;
1090 /* An engine is loaded, but the requested ioengine
1093 if (!strcmp(td->io_ops->name, td->o.ioengine)) {
1094 /* The right engine is already loaded */
1099 * Name of file and engine may be different, load ops
1100 * for this name and see if they match. If they do, then
1101 * the engine is unchanged.
1103 dlhandle = td->io_ops_dlhandle;
1104 ops = load_ioengine(td);
1105 if (ops == td->io_ops && dlhandle == td->io_ops_dlhandle) {
1111 if (dlhandle && dlhandle != td->io_ops_dlhandle)
1114 /* Unload the old engine. */
1118 td->io_ops = load_ioengine(td);
1120 log_err("fio: failed to load engine\n");
1124 if (td->io_ops->option_struct_size && td->io_ops->options) {
1126 * In cases where td->eo is set, clone it for a child thread.
1127 * This requires that the parent thread has the same ioengine,
1128 * but that requirement must be enforced by the code which
1129 * cloned the thread.
1131 void *origeo = td->eo;
1133 * Otherwise use the default thread options.
1135 if (!origeo && td != &def_thread && def_thread.eo &&
1136 def_thread.io_ops->options == td->io_ops->options)
1137 origeo = def_thread.eo;
1139 options_init(td->io_ops->options);
1140 td->eo = malloc(td->io_ops->option_struct_size);
1142 * Use the default thread as an option template if this uses the
1143 * same options structure and there are non-default options
1147 memcpy(td->eo, origeo, td->io_ops->option_struct_size);
1148 options_mem_dupe(td->io_ops->options, td->eo);
1150 memset(td->eo, 0, td->io_ops->option_struct_size);
1151 fill_default_options(td->eo, td->io_ops->options);
1153 *(struct thread_data **)td->eo = td;
1157 td->io_ops->flags |= FIO_RAWIO;
1159 td_set_ioengine_flags(td);
1163 static void init_flags(struct thread_data *td)
1165 struct thread_options *o = &td->o;
1168 if (o->verify_backlog)
1169 td->flags |= TD_F_VER_BACKLOG;
1170 if (o->trim_backlog)
1171 td->flags |= TD_F_TRIM_BACKLOG;
1172 if (o->read_iolog_file)
1173 td->flags |= TD_F_READ_IOLOG;
1174 if (o->refill_buffers)
1175 td->flags |= TD_F_REFILL_BUFFERS;
1177 * Always scramble buffers if asked to
1179 if (o->scramble_buffers && fio_option_is_set(o, scramble_buffers))
1180 td->flags |= TD_F_SCRAMBLE_BUFFERS;
1182 * But also scramble buffers, unless we were explicitly asked
1185 if (o->scramble_buffers && !(o->zero_buffers &&
1186 fio_option_is_set(o, zero_buffers)))
1187 td->flags |= TD_F_SCRAMBLE_BUFFERS;
1188 if (o->verify != VERIFY_NONE)
1189 td->flags |= TD_F_VER_NONE;
1191 if (o->verify_async || o->io_submit_mode == IO_MODE_OFFLOAD)
1192 td->flags |= TD_F_NEED_LOCK;
1194 if (o->mem_type == MEM_CUDA_MALLOC)
1195 td->flags &= ~TD_F_SCRAMBLE_BUFFERS;
1197 for (i = 0; i < DDIR_RWDIR_CNT; i++) {
1198 if (option_check_rate(td, i)) {
1199 td->flags |= TD_F_CHECK_RATE;
1205 static int setup_random_seeds(struct thread_data *td)
1210 if (!td->o.rand_repeatable && !fio_option_is_set(&td->o, rand_seed)) {
1211 int ret = init_random_seeds(td->rand_seeds, sizeof(td->rand_seeds));
1213 td_fill_rand_seeds(td);
1217 seed = td->o.rand_seed;
1218 for (i = 0; i < 4; i++)
1219 seed *= 0x9e370001UL;
1221 for (i = 0; i < FIO_RAND_NR_OFFS; i++) {
1222 td->rand_seeds[i] = seed * td->thread_number + i;
1223 seed *= 0x9e370001UL;
1226 td_fill_rand_seeds(td);
1237 static struct fpre_keyword {
1238 const char *keyword;
1241 } fpre_keywords[] = {
1242 { .keyword = "$jobname", .key = FPRE_JOBNAME, },
1243 { .keyword = "$jobnum", .key = FPRE_JOBNUM, },
1244 { .keyword = "$filenum", .key = FPRE_FILENUM, },
1245 { .keyword = NULL, },
1248 static char *make_filename(char *buf, size_t buf_size,struct thread_options *o,
1249 const char *jobname, int jobnum, int filenum)
1251 struct fpre_keyword *f;
1252 char copy[PATH_MAX];
1253 size_t dst_left = PATH_MAX - 1;
1255 if (!o->filename_format || !strlen(o->filename_format)) {
1256 sprintf(buf, "%s.%d.%d", jobname, jobnum, filenum);
1260 for (f = &fpre_keywords[0]; f->keyword; f++)
1261 f->strlen = strlen(f->keyword);
1263 buf[buf_size - 1] = '\0';
1264 strncpy(buf, o->filename_format, buf_size - 1);
1266 memset(copy, 0, sizeof(copy));
1267 for (f = &fpre_keywords[0]; f->keyword; f++) {
1269 size_t pre_len, post_start = 0;
1270 char *str, *dst = copy;
1272 str = strcasestr(buf, f->keyword);
1276 pre_len = str - buf;
1277 if (strlen(str) != f->strlen)
1278 post_start = pre_len + f->strlen;
1281 strncpy(dst, buf, pre_len);
1283 dst_left -= pre_len;
1287 case FPRE_JOBNAME: {
1290 ret = snprintf(dst, dst_left, "%s", jobname);
1293 else if (ret > dst_left) {
1294 log_err("fio: truncated filename\n");
1306 ret = snprintf(dst, dst_left, "%d", jobnum);
1309 else if (ret > dst_left) {
1310 log_err("fio: truncated filename\n");
1319 case FPRE_FILENUM: {
1322 ret = snprintf(dst, dst_left, "%d", filenum);
1325 else if (ret > dst_left) {
1326 log_err("fio: truncated filename\n");
1341 strncpy(dst, buf + post_start, dst_left);
1343 strncpy(buf, copy, buf_size - 1);
1350 bool parse_dryrun(void)
1352 return dump_cmdline || parse_only;
1355 static void gen_log_name(char *name, size_t size, const char *logtype,
1356 const char *logname, unsigned int num,
1357 const char *suf, int per_job)
1360 snprintf(name, size, "%s_%s.%d.%s", logname, logtype, num, suf);
1362 snprintf(name, size, "%s_%s.%s", logname, logtype, suf);
1365 static int check_waitees(char *waitee)
1367 struct thread_data *td;
1370 for_each_td(td, i) {
1371 if (td->subjob_number)
1374 ret += !strcmp(td->o.name, waitee);
1380 static bool wait_for_ok(const char *jobname, struct thread_options *o)
1387 if (!strcmp(jobname, o->wait_for)) {
1388 log_err("%s: a job cannot wait for itself (wait_for=%s).\n",
1389 jobname, o->wait_for);
1393 if (!(nw = check_waitees(o->wait_for))) {
1394 log_err("%s: waitee job %s unknown.\n", jobname, o->wait_for);
1399 log_err("%s: multiple waitees %s found,\n"
1400 "please avoid duplicates when using wait_for option.\n",
1401 jobname, o->wait_for);
1409 * Adds a job to the list of things todo. Sanitizes the various options
1410 * to make sure we don't have conflicts, and initializes various
1413 static int add_job(struct thread_data *td, const char *jobname, int job_add_num,
1414 int recursed, int client_type)
1417 char fname[PATH_MAX];
1418 int numjobs, file_alloced;
1419 struct thread_options *o = &td->o;
1420 char logname[PATH_MAX + 32];
1423 * the def_thread is just for options, it's not a real job
1425 if (td == &def_thread)
1431 * if we are just dumping the output command line, don't add the job
1433 if (parse_dryrun()) {
1438 td->client_type = client_type;
1440 if (profile_td_init(td))
1443 if (ioengine_load(td))
1447 if (!o->filename && !td->files_index && !o->read_iolog_file) {
1450 if (o->nr_files == 1 && exists_and_not_regfile(jobname))
1451 add_file(td, jobname, job_add_num, 0);
1453 for (i = 0; i < o->nr_files; i++)
1454 add_file(td, make_filename(fname, sizeof(fname), o, jobname, job_add_num, i), job_add_num, 0);
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;
1513 if (setup_random_seeds(td)) {
1514 td_verror(td, errno, "setup_random_seeds");
1521 if (o->write_lat_log) {
1522 struct log_params p = {
1524 .avg_msec = o->log_avg_msec,
1525 .hist_msec = o->log_hist_msec,
1526 .hist_coarseness = o->log_hist_coarseness,
1527 .log_type = IO_LOG_TYPE_LAT,
1528 .log_offset = o->log_offset,
1529 .log_gz = o->log_gz,
1530 .log_gz_store = o->log_gz_store,
1532 const char *pre = o->lat_log_file ? o->lat_log_file : o->name;
1540 gen_log_name(logname, sizeof(logname), "lat", pre,
1541 td->thread_number, suf, o->per_job_logs);
1542 setup_log(&td->lat_log, &p, logname);
1544 gen_log_name(logname, sizeof(logname), "slat", pre,
1545 td->thread_number, suf, o->per_job_logs);
1546 setup_log(&td->slat_log, &p, logname);
1548 gen_log_name(logname, sizeof(logname), "clat", pre,
1549 td->thread_number, suf, o->per_job_logs);
1550 setup_log(&td->clat_log, &p, logname);
1553 if (o->write_hist_log) {
1554 struct log_params p = {
1556 .avg_msec = o->log_avg_msec,
1557 .hist_msec = o->log_hist_msec,
1558 .hist_coarseness = o->log_hist_coarseness,
1559 .log_type = IO_LOG_TYPE_HIST,
1560 .log_offset = o->log_offset,
1561 .log_gz = o->log_gz,
1562 .log_gz_store = o->log_gz_store,
1564 const char *pre = o->hist_log_file ? o->hist_log_file : o->name;
1568 if (td->client_type) {
1569 log_err("fio: --write_hist_log requires zlib in client/server mode\n");
1579 gen_log_name(logname, sizeof(logname), "clat_hist", pre,
1580 td->thread_number, suf, o->per_job_logs);
1581 setup_log(&td->clat_hist_log, &p, logname);
1584 if (o->write_bw_log) {
1585 struct log_params p = {
1587 .avg_msec = o->log_avg_msec,
1588 .hist_msec = o->log_hist_msec,
1589 .hist_coarseness = o->log_hist_coarseness,
1590 .log_type = IO_LOG_TYPE_BW,
1591 .log_offset = o->log_offset,
1592 .log_gz = o->log_gz,
1593 .log_gz_store = o->log_gz_store,
1595 const char *pre = o->bw_log_file ? o->bw_log_file : o->name;
1598 if (fio_option_is_set(o, bw_avg_time))
1599 p.avg_msec = min(o->log_avg_msec, o->bw_avg_time);
1601 o->bw_avg_time = p.avg_msec;
1603 p.hist_msec = o->log_hist_msec;
1604 p.hist_coarseness = o->log_hist_coarseness;
1611 gen_log_name(logname, sizeof(logname), "bw", pre,
1612 td->thread_number, suf, o->per_job_logs);
1613 setup_log(&td->bw_log, &p, logname);
1615 if (o->write_iops_log) {
1616 struct log_params p = {
1618 .avg_msec = o->log_avg_msec,
1619 .hist_msec = o->log_hist_msec,
1620 .hist_coarseness = o->log_hist_coarseness,
1621 .log_type = IO_LOG_TYPE_IOPS,
1622 .log_offset = o->log_offset,
1623 .log_gz = o->log_gz,
1624 .log_gz_store = o->log_gz_store,
1626 const char *pre = o->iops_log_file ? o->iops_log_file : o->name;
1629 if (fio_option_is_set(o, iops_avg_time))
1630 p.avg_msec = min(o->log_avg_msec, o->iops_avg_time);
1632 o->iops_avg_time = p.avg_msec;
1634 p.hist_msec = o->log_hist_msec;
1635 p.hist_coarseness = o->log_hist_coarseness;
1642 gen_log_name(logname, sizeof(logname), "iops", pre,
1643 td->thread_number, suf, o->per_job_logs);
1644 setup_log(&td->iops_log, &p, logname);
1648 o->name = strdup(jobname);
1650 if (output_format & FIO_OUTPUT_NORMAL) {
1652 if (is_backend && !recursed)
1653 fio_server_send_add_job(td);
1655 if (!td_ioengine_flagged(td, FIO_NOIO)) {
1656 char *c1, *c2, *c3, *c4;
1657 char *c5 = NULL, *c6 = NULL;
1658 int i2p = is_power_of_2(o->kb_base);
1660 c1 = num2str(o->min_bs[DDIR_READ], o->sig_figs, 1, i2p, N2S_BYTE);
1661 c2 = num2str(o->max_bs[DDIR_READ], o->sig_figs, 1, i2p, N2S_BYTE);
1662 c3 = num2str(o->min_bs[DDIR_WRITE], o->sig_figs, 1, i2p, N2S_BYTE);
1663 c4 = num2str(o->max_bs[DDIR_WRITE], o->sig_figs, 1, i2p, N2S_BYTE);
1665 if (!o->bs_is_seq_rand) {
1666 c5 = num2str(o->min_bs[DDIR_TRIM], o->sig_figs, 1, i2p, N2S_BYTE);
1667 c6 = num2str(o->max_bs[DDIR_TRIM], o->sig_figs, 1, i2p, N2S_BYTE);
1670 log_info("%s: (g=%d): rw=%s, ", td->o.name,
1672 ddir_str(o->td_ddir));
1674 if (o->bs_is_seq_rand)
1675 log_info("bs=(R) %s-%s, (W) %s-%s, bs_is_seq_rand, ",
1678 log_info("bs=(R) %s-%s, (W) %s-%s, (T) %s-%s, ",
1679 c1, c2, c3, c4, c5, c6);
1681 log_info("ioengine=%s, iodepth=%u\n",
1682 td->io_ops->name, o->iodepth);
1691 } else if (job_add_num == 1)
1695 if (td_steadystate_init(td))
1699 * recurse add identical jobs, clear numjobs and stonewall options
1700 * as they don't apply to sub-jobs
1702 numjobs = o->numjobs;
1704 struct thread_data *td_new = get_new_job(false, td, true, jobname);
1709 td_new->o.numjobs = 1;
1710 td_new->o.stonewall = 0;
1711 td_new->o.new_group = 0;
1712 td_new->subjob_number = numjobs;
1713 td_new->o.ss_dur = o->ss_dur * 1000000l;
1714 td_new->o.ss_limit = o->ss_limit;
1717 if (td_new->files) {
1719 for_each_file(td_new, f, i) {
1721 sfree(f->file_name);
1724 free(td_new->files);
1725 td_new->files = NULL;
1727 td_new->files_index = 0;
1728 td_new->files_size = 0;
1729 if (td_new->o.filename) {
1730 free(td_new->o.filename);
1731 td_new->o.filename = NULL;
1735 if (add_job(td_new, jobname, numjobs, 1, client_type))
1746 * Parse as if 'o' was a command line
1748 void add_job_opts(const char **o, int client_type)
1750 struct thread_data *td, *td_parent;
1751 int i, in_global = 1;
1755 td_parent = td = NULL;
1757 if (!strncmp(o[i], "name", 4)) {
1760 add_job(td, jobname, 0, 0, client_type);
1762 sprintf(jobname, "%s", o[i] + 5);
1764 if (in_global && !td_parent)
1765 td_parent = get_new_job(true, &def_thread, false, jobname);
1766 else if (!in_global && !td) {
1768 td_parent = &def_thread;
1769 td = get_new_job(false, td_parent, false, jobname);
1772 fio_options_parse(td_parent, (char **) &o[i], 1);
1774 fio_options_parse(td, (char **) &o[i], 1);
1779 add_job(td, jobname, 0, 0, client_type);
1782 static int skip_this_section(const char *name)
1786 if (!nr_job_sections)
1788 if (!strncmp(name, "global", 6))
1791 for (i = 0; i < nr_job_sections; i++)
1792 if (!strcmp(job_sections[i], name))
1798 static int is_empty_or_comment(char *line)
1802 for (i = 0; i < strlen(line); i++) {
1807 if (!isspace((int) line[i]) && !iscntrl((int) line[i]))
1815 * This is our [ini] type file parser.
1817 static int __parse_jobs_ini(struct thread_data *td,
1818 char *file, int is_buf, int stonewall_flag, int type,
1819 int nested, char *name, char ***popts, int *aopts, int *nopts)
1821 bool global = false;
1825 int ret = 0, stonewall;
1828 int inside_skip = 0;
1830 int i, alloc_opts, num_opts;
1832 dprint(FD_PARSE, "Parsing ini file %s\n", file);
1833 assert(td || !nested);
1838 if (!strcmp(file, "-"))
1841 f = fopen(file, "r");
1846 log_err("fio: unable to open '%s' job file\n", file);
1848 td_verror(td, __err, "job file open");
1853 string = malloc(4096);
1856 * it's really 256 + small bit, 280 should suffice
1860 memset(name, 0, 280);
1864 if (nested && popts) {
1866 alloc_opts = *aopts;
1872 opts = malloc(sizeof(char *) * alloc_opts);
1876 stonewall = stonewall_flag;
1879 * if skip_fgets is set, we already have loaded a line we
1884 p = strsep(&file, "\n");
1886 p = fgets(string, 4096, f);
1892 strip_blank_front(&p);
1895 dprint(FD_PARSE, "%s\n", p);
1896 if (is_empty_or_comment(p))
1900 if (sscanf(p, "[%255[^\n]]", name) != 1) {
1904 log_err("fio: option <%s> outside of "
1905 "[] job section\n", p);
1910 name[strlen(name) - 1] = '\0';
1912 if (skip_this_section(name)) {
1918 dprint(FD_PARSE, "Parsing section [%s]\n", name);
1920 global = !strncmp(name, "global", 6);
1926 log_info("--name=%s ", name);
1930 td = get_new_job(global, &def_thread, false, name);
1937 * Separate multiple job files by a stonewall
1939 if (!global && stonewall) {
1940 td->o.stonewall = stonewall;
1945 memset(opts, 0, alloc_opts * sizeof(char *));
1953 p = strsep(&file, "\n");
1955 p = fgets(string, 4096, f);
1958 dprint(FD_PARSE, "%s", p);
1963 if (is_empty_or_comment(p))
1966 strip_blank_front(&p);
1969 * new section, break out and make sure we don't
1970 * fgets() a new line at the top.
1974 log_err("No new sections in included files\n");
1984 if (!strncmp(p, "include", strlen("include"))) {
1985 char *filename = p + strlen("include") + 1,
1986 *ts, *full_fn = NULL;
1989 * Allow for the include filename
1990 * specification to be relative.
1992 if (access(filename, F_OK) &&
1993 (ts = strrchr(file, '/'))) {
1994 int len = ts - file +
1995 strlen(filename) + 2;
1997 if (!(full_fn = calloc(1, len))) {
2003 file, (ts - file) + 1);
2004 strncpy(full_fn + (ts - file) + 1,
2005 filename, strlen(filename));
2006 full_fn[len - 1] = 0;
2010 ret = __parse_jobs_ini(td, filename, is_buf,
2011 stonewall_flag, type, 1,
2013 &alloc_opts, &num_opts);
2016 log_err("Error %d while parsing "
2017 "include file %s\n",
2030 if (num_opts == alloc_opts) {
2032 opts = realloc(opts,
2033 alloc_opts * sizeof(char *));
2036 opts[num_opts] = strdup(p);
2042 *aopts = alloc_opts;
2047 ret = fio_options_parse(td, opts, num_opts);
2052 ret = add_job(td, name, 0, 0, type);
2054 log_err("fio: job %s dropped\n", name);
2058 for (i = 0; i < num_opts; i++)
2067 while (i < nr_job_sections) {
2068 free(job_sections[i]);
2077 if (!is_buf && f != stdin)
2082 int parse_jobs_ini(char *file, int is_buf, int stonewall_flag, int type)
2084 return __parse_jobs_ini(NULL, file, is_buf, stonewall_flag, type,
2085 0, NULL, NULL, NULL, NULL);
2088 static int fill_def_thread(void)
2090 memset(&def_thread, 0, sizeof(def_thread));
2091 INIT_FLIST_HEAD(&def_thread.opt_list);
2093 fio_getaffinity(getpid(), &def_thread.o.cpumask);
2094 def_thread.o.error_dump = 1;
2097 * fill default options
2099 fio_fill_default_options(&def_thread);
2103 static void show_debug_categories(void)
2105 #ifdef FIO_INC_DEBUG
2106 const struct debug_level *dl = &debug_levels[0];
2107 int curlen, first = 1;
2111 int has_next = (dl + 1)->name != NULL;
2113 if (first || curlen + strlen(dl->name) >= 80) {
2118 curlen += printf("\t\t\t%s", dl->name);
2119 curlen += 3 * (8 - 1);
2121 curlen += printf(",");
2123 curlen += printf("%s", dl->name);
2125 curlen += printf(",");
2135 * Following options aren't printed by usage().
2136 * --append-terse - Equivalent to --output-format=terse, see f6a7df53.
2137 * --latency-log - Deprecated option.
2139 static void usage(const char *name)
2141 printf("%s\n", fio_version_string);
2142 printf("%s [options] [job options] <job file(s)>\n", name);
2143 printf(" --debug=options\tEnable debug logging. May be one/more of:\n");
2144 show_debug_categories();
2145 printf(" --parse-only\t\tParse options only, don't start any IO\n");
2146 printf(" --output\t\tWrite output to file\n");
2147 printf(" --bandwidth-log\tGenerate aggregate bandwidth logs\n");
2148 printf(" --minimal\t\tMinimal (terse) output\n");
2149 printf(" --output-format=type\tOutput format (terse,json,json+,normal)\n");
2150 printf(" --terse-version=type\tSet terse version output format"
2151 " (default 3, or 2 or 4)\n");
2152 printf(" --version\t\tPrint version info and exit\n");
2153 printf(" --help\t\tPrint this page\n");
2154 printf(" --cpuclock-test\tPerform test/validation of CPU clock\n");
2155 printf(" --crctest=[type]\tTest speed of checksum functions\n");
2156 printf(" --cmdhelp=cmd\t\tPrint command help, \"all\" for all of"
2158 printf(" --enghelp=engine\tPrint ioengine help, or list"
2159 " available ioengines\n");
2160 printf(" --enghelp=engine,cmd\tPrint help for an ioengine"
2162 printf(" --showcmd\t\tTurn a job file into command line options\n");
2163 printf(" --eta=when\t\tWhen ETA estimate should be printed\n");
2164 printf(" \t\tMay be \"always\", \"never\" or \"auto\"\n");
2165 printf(" --eta-newline=time\tForce a new line for every 'time'");
2166 printf(" period passed\n");
2167 printf(" --status-interval=t\tForce full status dump every");
2168 printf(" 't' period passed\n");
2169 printf(" --readonly\t\tTurn on safety read-only checks, preventing"
2171 printf(" --section=name\tOnly run specified section in job file,"
2172 " multiple sections can be specified\n");
2173 printf(" --alloc-size=kb\tSet smalloc pool to this size in kb"
2175 printf(" --warnings-fatal\tFio parser warnings are fatal\n");
2176 printf(" --max-jobs=nr\t\tMaximum number of threads/processes to support\n");
2177 printf(" --server=args\t\tStart a backend fio server\n");
2178 printf(" --daemonize=pidfile\tBackground fio server, write pid to file\n");
2179 printf(" --client=hostname\tTalk to remote backend(s) fio server at hostname\n");
2180 printf(" --remote-config=file\tTell fio server to load this local job file\n");
2181 printf(" --idle-prof=option\tReport cpu idleness on a system or percpu basis\n"
2182 "\t\t\t(option=system,percpu) or run unit work\n"
2183 "\t\t\tcalibration only (option=calibrate)\n");
2185 printf(" --inflate-log=log\tInflate and output compressed log\n");
2187 printf(" --trigger-file=file\tExecute trigger cmd when file exists\n");
2188 printf(" --trigger-timeout=t\tExecute trigger at this time\n");
2189 printf(" --trigger=cmd\t\tSet this command as local trigger\n");
2190 printf(" --trigger-remote=cmd\tSet this command as remote trigger\n");
2191 printf(" --aux-path=path\tUse this path for fio state generated files\n");
2192 printf("\nFio was written by Jens Axboe <axboe@kernel.dk>\n");
2195 #ifdef FIO_INC_DEBUG
2196 const struct debug_level debug_levels[] = {
2197 { .name = "process",
2198 .help = "Process creation/exit logging",
2199 .shift = FD_PROCESS,
2202 .help = "File related action logging",
2206 .help = "IO and IO engine action logging (offsets, queue, completions, etc)",
2210 .help = "Memory allocation/freeing logging",
2213 { .name = "blktrace",
2214 .help = "blktrace action logging",
2215 .shift = FD_BLKTRACE,
2218 .help = "IO verification action logging",
2222 .help = "Random generation logging",
2226 .help = "Parser logging",
2229 { .name = "diskutil",
2230 .help = "Disk utility logging actions",
2231 .shift = FD_DISKUTIL,
2234 .help = "Logging related to creating/destroying jobs",
2238 .help = "Mutex logging",
2241 { .name = "profile",
2242 .help = "Logging related to profiles",
2243 .shift = FD_PROFILE,
2246 .help = "Logging related to time keeping functions",
2250 .help = "Network logging",
2254 .help = "Rate logging",
2257 { .name = "compress",
2258 .help = "Log compression logging",
2259 .shift = FD_COMPRESS,
2261 { .name = "steadystate",
2262 .help = "Steady state detection logging",
2263 .shift = FD_STEADYSTATE,
2265 { .name = "helperthread",
2266 .help = "Helper thread logging",
2267 .shift = FD_HELPERTHREAD,
2272 static int set_debug(const char *string)
2274 const struct debug_level *dl;
2275 char *p = (char *) string;
2282 if (!strcmp(string, "?") || !strcmp(string, "help")) {
2283 log_info("fio: dumping debug options:");
2284 for (i = 0; debug_levels[i].name; i++) {
2285 dl = &debug_levels[i];
2286 log_info("%s,", dl->name);
2292 while ((opt = strsep(&p, ",")) != NULL) {
2295 if (!strncmp(opt, "all", 3)) {
2296 log_info("fio: set all debug options\n");
2301 for (i = 0; debug_levels[i].name; i++) {
2302 dl = &debug_levels[i];
2303 found = !strncmp(opt, dl->name, strlen(dl->name));
2307 if (dl->shift == FD_JOB) {
2308 opt = strchr(opt, ':');
2310 log_err("fio: missing job number\n");
2314 fio_debug_jobno = atoi(opt);
2315 log_info("fio: set debug jobno %d\n",
2318 log_info("fio: set debug option %s\n", opt);
2319 fio_debug |= (1UL << dl->shift);
2325 log_err("fio: debug mask %s not found\n", opt);
2330 static int set_debug(const char *string)
2332 log_err("fio: debug tracing not included in build\n");
2337 static void fio_options_fill_optstring(void)
2339 char *ostr = cmd_optstr;
2343 while (l_opts[i].name) {
2344 ostr[c++] = l_opts[i].val;
2345 if (l_opts[i].has_arg == required_argument)
2347 else if (l_opts[i].has_arg == optional_argument) {
2356 static int client_flag_set(char c)
2361 while (l_opts[i].name) {
2362 int val = l_opts[i].val;
2364 if (c == (val & 0xff))
2365 return (val & FIO_CLIENT_FLAG);
2373 static void parse_cmd_client(void *client, char *opt)
2375 fio_client_add_cmd_option(client, opt);
2378 static void show_closest_option(const char *name)
2380 int best_option, best_distance;
2383 while (*name == '-')
2387 best_distance = INT_MAX;
2389 while (l_opts[i].name) {
2390 distance = string_distance(name, l_opts[i].name);
2391 if (distance < best_distance) {
2392 best_distance = distance;
2398 if (best_option != -1 && string_distance_ok(name, best_distance))
2399 log_err("Did you mean %s?\n", l_opts[best_option].name);
2402 static int parse_output_format(const char *optarg)
2404 char *p, *orig, *opt;
2407 p = orig = strdup(optarg);
2411 while ((opt = strsep(&p, ",")) != NULL) {
2412 if (!strcmp(opt, "minimal") ||
2413 !strcmp(opt, "terse") ||
2414 !strcmp(opt, "csv"))
2415 output_format |= FIO_OUTPUT_TERSE;
2416 else if (!strcmp(opt, "json"))
2417 output_format |= FIO_OUTPUT_JSON;
2418 else if (!strcmp(opt, "json+"))
2419 output_format |= (FIO_OUTPUT_JSON | FIO_OUTPUT_JSON_PLUS);
2420 else if (!strcmp(opt, "normal"))
2421 output_format |= FIO_OUTPUT_NORMAL;
2423 log_err("fio: invalid output format %s\n", opt);
2433 int parse_cmd_line(int argc, char *argv[], int client_type)
2435 struct thread_data *td = NULL;
2436 int c, ini_idx = 0, lidx, ret = 0, do_exit = 0, exit_val = 0;
2437 char *ostr = cmd_optstr;
2438 char *pid_file = NULL;
2439 void *cur_client = NULL;
2443 * Reset optind handling, since we may call this multiple times
2448 while ((c = getopt_long_only(argc, argv, ostr, l_opts, &lidx)) != -1) {
2449 if ((c & FIO_CLIENT_FLAG) || client_flag_set(c)) {
2450 parse_cmd_client(cur_client, argv[optind - 1]);
2451 c &= ~FIO_CLIENT_FLAG;
2456 smalloc_pool_size = atoi(optarg);
2457 smalloc_pool_size <<= 10;
2461 log_err("fio: --latency-log is deprecated. Use per-job latency log options.\n");
2471 if (f_out && f_out != stdout)
2474 tmp = fopen(optarg, "w+");
2476 log_err("fio: output file open error: %s\n", strerror(errno));
2481 f_err = f_out = tmp;
2485 output_format = FIO_OUTPUT_TERSE;
2488 if (parse_output_format(optarg)) {
2489 log_err("fio: failed parsing output-format\n");
2496 output_format |= FIO_OUTPUT_TERSE;
2508 fio_show_option_help(optarg);
2515 fio_show_ioengine_help(optarg);
2529 log_info("%s\n", fio_version_string);
2534 terse_version = atoi(optarg);
2535 if (!(terse_version >= 2 && terse_version <= 5)) {
2536 log_err("fio: bad terse version format\n");
2542 if (!strcmp("always", optarg))
2543 eta_print = FIO_ETA_ALWAYS;
2544 else if (!strcmp("never", optarg))
2545 eta_print = FIO_ETA_NEVER;
2550 if (check_str_time(optarg, &t, 1)) {
2551 log_err("fio: failed parsing eta time %s\n", optarg);
2556 eta_new_line = t / 1000;
2557 if (!eta_new_line) {
2558 log_err("fio: eta new line time too short\n");
2567 if (check_str_time(optarg, &t, 1)) {
2568 log_err("fio: failed parsing eta interval %s\n", optarg);
2573 eta_interval_msec = t / 1000;
2574 if (eta_interval_msec < DISK_UTIL_MSEC) {
2575 log_err("fio: eta interval time too short (%umsec min)\n", DISK_UTIL_MSEC);
2582 if (set_debug(optarg))
2592 if (!strcmp(optarg, "global")) {
2593 log_err("fio: can't use global as only "
2599 new_size = (nr_job_sections + 1) * sizeof(char *);
2600 job_sections = realloc(job_sections, new_size);
2601 job_sections[nr_job_sections] = strdup(optarg);
2607 exit_val = iolog_file_inflate(optarg);
2616 exec_profile = strdup(optarg);
2618 case FIO_GETOPT_JOB: {
2619 const char *opt = l_opts[lidx].name;
2622 if (!strncmp(opt, "name", 4) && td) {
2623 ret = add_job(td, td->o.name ?: "fio", 0, 0, client_type);
2630 int is_section = !strncmp(opt, "name", 4);
2633 if (!is_section || !strncmp(val, "global", 6))
2636 if (is_section && skip_this_section(val))
2639 td = get_new_job(global, &def_thread, true, NULL);
2640 if (!td || ioengine_load(td)) {
2649 fio_options_set_ioengine_opts(l_opts, td);
2652 if ((!val || !strlen(val)) &&
2653 l_opts[lidx].has_arg == required_argument) {
2654 log_err("fio: option %s requires an argument\n", opt);
2657 ret = fio_cmd_option_parse(td, opt, val);
2668 if (!ret && !strcmp(opt, "ioengine")) {
2669 if (ioengine_load(td)) {
2676 fio_options_set_ioengine_opts(l_opts, td);
2680 case FIO_GETOPT_IOENGINE: {
2681 const char *opt = l_opts[lidx].name;
2687 ret = fio_cmd_ioengine_option_parse(td, opt, val);
2694 max_jobs = atoi(optarg);
2695 if (!max_jobs || max_jobs > REAL_MAX_JOBS) {
2696 log_err("fio: invalid max jobs: %d\n", max_jobs);
2703 #ifndef CONFIG_NO_SHM
2705 log_err("fio: can't be both client and server\n");
2711 fio_server_set_arg(optarg);
2715 log_err("fio: client/server requires SHM support\n");
2723 pid_file = strdup(optarg);
2726 if ((ret = fio_idle_prof_parse_opt(optarg))) {
2727 /* exit on error and calibration only */
2737 log_err("fio: can't be both client and server\n");
2742 /* if --client parameter contains a pathname */
2743 if (0 == access(optarg, R_OK)) {
2744 /* file contains a list of host addrs or names */
2745 char hostaddr[PATH_MAX] = {0};
2747 FILE * hostf = fopen(optarg, "r");
2749 log_err("fio: could not open client list file %s for read\n", optarg);
2754 sprintf(formatstr, "%%%ds", PATH_MAX - 1);
2756 * read at most PATH_MAX-1 chars from each
2757 * record in this file
2759 while (fscanf(hostf, formatstr, hostaddr) == 1) {
2760 /* expect EVERY host in file to be valid */
2761 if (fio_client_add(&fio_client_ops, hostaddr, &cur_client)) {
2762 log_err("fio: failed adding client %s from file %s\n", hostaddr, optarg);
2769 break; /* no possibility of job file for "this client only" */
2771 if (fio_client_add(&fio_client_ops, optarg, &cur_client)) {
2772 log_err("fio: failed adding client %s\n", optarg);
2778 * If the next argument exists and isn't an option,
2779 * assume it's a job file for this client only.
2781 while (optind < argc) {
2782 if (!strncmp(argv[optind], "--", 2) ||
2783 !strncmp(argv[optind], "-", 1))
2786 if (fio_client_add_ini_file(cur_client, argv[optind], false))
2793 if (fio_client_add_ini_file(cur_client, optarg, true)) {
2801 exit_val = fio_monotonic_clocktest(1);
2806 exit_val = fio_crctest(optarg);
2811 exit_val = fio_memcpy_test(optarg);
2816 if (check_str_time(optarg, &val, 1)) {
2817 log_err("fio: failed parsing time %s\n", optarg);
2823 log_err("fio: status interval too small\n");
2827 status_interval = val / 1000;
2833 trigger_file = strdup(optarg);
2838 trigger_cmd = strdup(optarg);
2841 if (trigger_remote_cmd)
2842 free(trigger_remote_cmd);
2843 trigger_remote_cmd = strdup(optarg);
2848 aux_path = strdup(optarg);
2851 if (check_str_time(optarg, &trigger_timeout, 1)) {
2852 log_err("fio: failed parsing time %s\n", optarg);
2856 trigger_timeout /= 1000000;
2859 log_err("%s: unrecognized option '%s'\n", argv[0],
2861 show_closest_option(argv[optind - 1]);
2871 if (do_exit && !(is_backend || nr_clients))
2874 if (nr_clients && fio_clients_connect())
2877 if (is_backend && backend)
2878 return fio_start_server(pid_file);
2884 ret = add_job(td, td->o.name ?: "fio", 0, 0, client_type);
2890 while (!ret && optind < argc) {
2892 ini_file = realloc(ini_file, ini_idx * sizeof(char *));
2893 ini_file[ini_idx - 1] = strdup(argv[optind]);
2901 int fio_init_options(void)
2906 fio_options_fill_optstring();
2907 fio_options_dup_and_init(l_opts);
2911 if (fill_def_thread())
2917 extern int fio_check_options(struct thread_options *);
2919 int parse_options(int argc, char *argv[])
2921 const int type = FIO_CLIENT_TYPE_CLI;
2924 if (fio_init_options())
2926 if (fio_test_cconv(&def_thread.o))
2927 log_err("fio: failed internal cconv test\n");
2929 job_files = parse_cmd_line(argc, argv, type);
2931 if (job_files > 0) {
2932 for (i = 0; i < job_files; i++) {
2933 if (i && fill_def_thread())
2936 if (fio_clients_send_ini(ini_file[i]))
2939 } else if (!is_backend) {
2940 if (parse_jobs_ini(ini_file[i], 0, i, type))
2945 } else if (nr_clients) {
2946 if (fill_def_thread())
2948 if (fio_clients_send_ini(NULL))
2953 fio_options_free(&def_thread);
2954 filesetup_mem_free();
2956 if (!thread_number) {
2961 if (is_backend || nr_clients)
2966 log_err("No job(s) defined\n\n");
2971 if (output_format & FIO_OUTPUT_NORMAL)
2972 log_info("%s\n", fio_version_string);
2977 void options_default_fill(struct thread_options *o)
2979 memcpy(o, &def_thread.o, sizeof(*o));
2982 struct thread_data *get_global_options(void)