2 * This file contains job initialization and setup functions.
12 #include <sys/types.h>
17 #ifndef FIO_NO_HAVE_SHM_H
29 #include "steadystate.h"
31 #include "oslib/getopt.h"
32 #include "oslib/strcasestr.h"
36 #include "lib/memcpy.h"
38 const char fio_version_string[] = FIO_VERSION;
40 #define FIO_RANDSEED (0xb1899bedUL)
42 static char **ini_file;
43 static int max_jobs = FIO_MAX_JOBS;
44 static int dump_cmdline;
45 static int parse_only;
47 static struct thread_data def_thread;
48 struct thread_data *threads = NULL;
49 static char **job_sections;
50 static int nr_job_sections;
52 int exitall_on_terminate = 0;
53 int output_format = FIO_OUTPUT_NORMAL;
54 int eta_print = FIO_ETA_AUTO;
55 unsigned int eta_interval_msec = 1000;
59 char *exec_profile = NULL;
60 int warnings_fatal = 0;
61 int terse_version = 3;
68 int status_interval = 0;
70 char *trigger_file = NULL;
71 long long trigger_timeout = 0;
72 char *trigger_cmd = NULL;
73 char *trigger_remote_cmd = NULL;
75 char *aux_path = NULL;
77 static int prev_group_jobs;
79 unsigned long fio_debug = 0;
80 unsigned int fio_debug_jobno = -1;
81 unsigned int *fio_debug_jobp = NULL;
82 unsigned int *fio_warned = NULL;
84 static char cmd_optstr[256];
87 #define FIO_CLIENT_FLAG (1 << 16)
90 * Command line options. These will contain the above, plus a few
91 * extra that only pertain to fio itself and not jobs.
93 static struct option l_opts[FIO_NR_OPTIONS] = {
95 .name = (char *) "output",
96 .has_arg = required_argument,
97 .val = 'o' | FIO_CLIENT_FLAG,
100 .name = (char *) "latency-log",
101 .has_arg = required_argument,
102 .val = 'l' | FIO_CLIENT_FLAG,
105 .name = (char *) "bandwidth-log",
106 .has_arg = no_argument,
107 .val = 'b' | FIO_CLIENT_FLAG,
110 .name = (char *) "minimal",
111 .has_arg = no_argument,
112 .val = 'm' | FIO_CLIENT_FLAG,
115 .name = (char *) "output-format",
116 .has_arg = required_argument,
117 .val = 'F' | FIO_CLIENT_FLAG,
120 .name = (char *) "append-terse",
121 .has_arg = optional_argument,
125 .name = (char *) "version",
126 .has_arg = no_argument,
127 .val = 'v' | FIO_CLIENT_FLAG,
130 .name = (char *) "help",
131 .has_arg = no_argument,
132 .val = 'h' | FIO_CLIENT_FLAG,
135 .name = (char *) "cmdhelp",
136 .has_arg = optional_argument,
137 .val = 'c' | FIO_CLIENT_FLAG,
140 .name = (char *) "enghelp",
141 .has_arg = optional_argument,
142 .val = 'i' | FIO_CLIENT_FLAG,
145 .name = (char *) "showcmd",
146 .has_arg = no_argument,
147 .val = 's' | FIO_CLIENT_FLAG,
150 .name = (char *) "readonly",
151 .has_arg = no_argument,
152 .val = 'r' | FIO_CLIENT_FLAG,
155 .name = (char *) "eta",
156 .has_arg = required_argument,
157 .val = 'e' | FIO_CLIENT_FLAG,
160 .name = (char *) "eta-interval",
161 .has_arg = required_argument,
162 .val = 'O' | FIO_CLIENT_FLAG,
165 .name = (char *) "eta-newline",
166 .has_arg = required_argument,
167 .val = 'E' | FIO_CLIENT_FLAG,
170 .name = (char *) "debug",
171 .has_arg = required_argument,
172 .val = 'd' | FIO_CLIENT_FLAG,
175 .name = (char *) "parse-only",
176 .has_arg = no_argument,
177 .val = 'P' | FIO_CLIENT_FLAG,
180 .name = (char *) "section",
181 .has_arg = required_argument,
182 .val = 'x' | FIO_CLIENT_FLAG,
186 .name = (char *) "inflate-log",
187 .has_arg = required_argument,
188 .val = 'X' | FIO_CLIENT_FLAG,
192 .name = (char *) "alloc-size",
193 .has_arg = required_argument,
194 .val = 'a' | FIO_CLIENT_FLAG,
197 .name = (char *) "profile",
198 .has_arg = required_argument,
199 .val = 'p' | FIO_CLIENT_FLAG,
202 .name = (char *) "warnings-fatal",
203 .has_arg = no_argument,
204 .val = 'w' | FIO_CLIENT_FLAG,
207 .name = (char *) "max-jobs",
208 .has_arg = required_argument,
209 .val = 'j' | FIO_CLIENT_FLAG,
212 .name = (char *) "terse-version",
213 .has_arg = required_argument,
214 .val = 'V' | FIO_CLIENT_FLAG,
217 .name = (char *) "server",
218 .has_arg = optional_argument,
221 { .name = (char *) "daemonize",
222 .has_arg = required_argument,
226 .name = (char *) "client",
227 .has_arg = required_argument,
231 .name = (char *) "remote-config",
232 .has_arg = required_argument,
236 .name = (char *) "cpuclock-test",
237 .has_arg = no_argument,
241 .name = (char *) "crctest",
242 .has_arg = optional_argument,
246 .name = (char *) "memcpytest",
247 .has_arg = optional_argument,
251 .name = (char *) "idle-prof",
252 .has_arg = required_argument,
256 .name = (char *) "status-interval",
257 .has_arg = required_argument,
261 .name = (char *) "trigger-file",
262 .has_arg = required_argument,
266 .name = (char *) "trigger-timeout",
267 .has_arg = required_argument,
271 .name = (char *) "trigger",
272 .has_arg = required_argument,
276 .name = (char *) "trigger-remote",
277 .has_arg = required_argument,
281 .name = (char *) "aux-path",
282 .has_arg = required_argument,
290 void free_threads_shm(void)
294 #ifndef CONFIG_NO_SHM
295 struct shmid_ds sbuf;
299 shmctl(shm_id, IPC_RMID, &sbuf);
308 static void free_shm(void)
312 fio_debug_jobp = NULL;
319 free(trigger_remote_cmd);
320 trigger_file = trigger_cmd = trigger_remote_cmd = NULL;
322 options_free(fio_options, &def_thread.o);
329 * The thread area is shared between the main process and the job
330 * threads/processes. So setup a shared memory segment that will hold
331 * all the job info. We use the end of the region for keeping track of
332 * open files across jobs, for file sharing.
334 static int setup_thread_area(void)
340 * 1024 is too much on some machines, scale max_jobs if
341 * we get a failure that looks like too large a shm segment
344 size_t size = max_jobs * sizeof(struct thread_data);
346 size += 2 * sizeof(unsigned int);
348 #ifndef CONFIG_NO_SHM
349 shm_id = shmget(0, size, IPC_CREAT | 0600);
352 if (errno != EINVAL && errno != ENOMEM && errno != ENOSPC) {
357 threads = malloc(size);
365 #ifndef CONFIG_NO_SHM
369 threads = shmat(shm_id, NULL, 0);
370 if (threads == (void *) -1) {
374 if (shm_attach_to_open_removed())
375 shmctl(shm_id, IPC_RMID, NULL);
378 memset(threads, 0, max_jobs * sizeof(struct thread_data));
379 fio_debug_jobp = (unsigned int *)(threads + max_jobs);
380 *fio_debug_jobp = -1;
381 fio_warned = fio_debug_jobp + 1;
389 static void dump_print_option(struct print_option *p)
393 if (!strcmp("description", p->name))
398 log_info("--%s%s", p->name, p->value ? "" : " ");
400 log_info("=%s%s%s ", delim, p->value, delim);
403 static void dump_opt_list(struct thread_data *td)
405 struct flist_head *entry;
406 struct print_option *p;
408 if (flist_empty(&td->opt_list))
411 flist_for_each(entry, &td->opt_list) {
412 p = flist_entry(entry, struct print_option, list);
413 dump_print_option(p);
417 static void fio_dump_options_free(struct thread_data *td)
419 while (!flist_empty(&td->opt_list)) {
420 struct print_option *p;
422 p = flist_first_entry(&td->opt_list, struct print_option, list);
423 flist_del_init(&p->list);
430 static void copy_opt_list(struct thread_data *dst, struct thread_data *src)
432 struct flist_head *entry;
434 if (flist_empty(&src->opt_list))
437 flist_for_each(entry, &src->opt_list) {
438 struct print_option *srcp, *dstp;
440 srcp = flist_entry(entry, struct print_option, list);
441 dstp = malloc(sizeof(*dstp));
442 dstp->name = strdup(srcp->name);
444 dstp->value = strdup(srcp->value);
447 flist_add_tail(&dstp->list, &dst->opt_list);
452 * Return a free job structure.
454 static struct thread_data *get_new_job(bool global, struct thread_data *parent,
455 bool preserve_eo, const char *jobname)
457 struct thread_data *td;
461 if (setup_thread_area()) {
462 log_err("error: failed to setup shm segment\n");
465 if (thread_number >= max_jobs) {
466 log_err("error: maximum number of jobs (%d) reached.\n",
471 td = &threads[thread_number++];
474 INIT_FLIST_HEAD(&td->opt_list);
475 if (parent != &def_thread)
476 copy_opt_list(td, parent);
483 td->o.uid = td->o.gid = -1U;
485 dup_files(td, parent);
486 fio_options_mem_dupe(td);
488 profile_add_hooks(td);
490 td->thread_number = thread_number;
491 td->subjob_number = 0;
494 td->o.name = strdup(jobname);
496 if (!parent->o.group_reporting || parent == &def_thread)
502 static void put_job(struct thread_data *td)
504 if (td == &def_thread)
511 log_info("fio: %s\n", td->verror);
513 fio_options_free(td);
514 fio_dump_options_free(td);
521 memset(&threads[td->thread_number - 1], 0, sizeof(*td));
525 static int __setup_rate(struct thread_data *td, enum fio_ddir ddir)
527 unsigned int bs = td->o.min_bs[ddir];
529 assert(ddir_rw(ddir));
531 if (td->o.rate[ddir])
532 td->rate_bps[ddir] = td->o.rate[ddir];
534 td->rate_bps[ddir] = (uint64_t) td->o.rate_iops[ddir] * bs;
536 if (!td->rate_bps[ddir]) {
537 log_err("rate lower than supported\n");
541 td->rate_next_io_time[ddir] = 0;
542 td->rate_io_issue_bytes[ddir] = 0;
543 td->last_usec[ddir] = 0;
547 static int setup_rate(struct thread_data *td)
551 if (td->o.rate[DDIR_READ] || td->o.rate_iops[DDIR_READ])
552 ret = __setup_rate(td, DDIR_READ);
553 if (td->o.rate[DDIR_WRITE] || td->o.rate_iops[DDIR_WRITE])
554 ret |= __setup_rate(td, DDIR_WRITE);
555 if (td->o.rate[DDIR_TRIM] || td->o.rate_iops[DDIR_TRIM])
556 ret |= __setup_rate(td, DDIR_TRIM);
561 static int fixed_block_size(struct thread_options *o)
563 return o->min_bs[DDIR_READ] == o->max_bs[DDIR_READ] &&
564 o->min_bs[DDIR_WRITE] == o->max_bs[DDIR_WRITE] &&
565 o->min_bs[DDIR_TRIM] == o->max_bs[DDIR_TRIM] &&
566 o->min_bs[DDIR_READ] == o->min_bs[DDIR_WRITE] &&
567 o->min_bs[DDIR_READ] == o->min_bs[DDIR_TRIM];
571 static unsigned long long get_rand_start_delay(struct thread_data *td)
573 unsigned long long delayrange;
577 delayrange = td->o.start_delay_high - td->o.start_delay;
579 frand_max = rand_max(&td->delay_state);
580 r = __rand(&td->delay_state);
581 delayrange = (unsigned long long) ((double) delayrange * (r / (frand_max + 1.0)));
583 delayrange += td->o.start_delay;
590 static unsigned int gcd(unsigned int m, unsigned int n)
595 return gcd(n, m % n);
599 * Lazy way of fixing up options that depend on each other. We could also
600 * define option callback handlers, but this is easier.
602 static int fixup_options(struct thread_data *td)
604 struct thread_options *o = &td->o;
607 #ifndef CONFIG_PSHARED
608 if (!o->use_thread) {
609 log_info("fio: this platform does not support process shared"
610 " mutexes, forcing use of threads. Use the 'thread'"
611 " option to get rid of this warning.\n");
613 ret = warnings_fatal;
617 if (o->write_iolog_file && o->read_iolog_file) {
618 log_err("fio: read iolog overrides write_iolog\n");
619 free(o->write_iolog_file);
620 o->write_iolog_file = NULL;
621 ret = warnings_fatal;
625 * only really works with 1 file
627 if (o->zone_size && o->open_files > 1)
631 * If zone_range isn't specified, backward compatibility dictates it
632 * should be made equal to zone_size.
634 if (o->zone_size && !o->zone_range)
635 o->zone_range = o->zone_size;
638 * Reads can do overwrites, we always need to pre-create the file
643 if (!o->min_bs[DDIR_READ])
644 o->min_bs[DDIR_READ] = o->bs[DDIR_READ];
645 if (!o->max_bs[DDIR_READ])
646 o->max_bs[DDIR_READ] = o->bs[DDIR_READ];
647 if (!o->min_bs[DDIR_WRITE])
648 o->min_bs[DDIR_WRITE] = o->bs[DDIR_WRITE];
649 if (!o->max_bs[DDIR_WRITE])
650 o->max_bs[DDIR_WRITE] = o->bs[DDIR_WRITE];
651 if (!o->min_bs[DDIR_TRIM])
652 o->min_bs[DDIR_TRIM] = o->bs[DDIR_TRIM];
653 if (!o->max_bs[DDIR_TRIM])
654 o->max_bs[DDIR_TRIM] = o->bs[DDIR_TRIM];
656 o->rw_min_bs = min(o->min_bs[DDIR_READ], o->min_bs[DDIR_WRITE]);
657 o->rw_min_bs = min(o->min_bs[DDIR_TRIM], o->rw_min_bs);
660 * For random IO, allow blockalign offset other than min_bs.
662 if (!o->ba[DDIR_READ] || !td_random(td))
663 o->ba[DDIR_READ] = o->min_bs[DDIR_READ];
664 if (!o->ba[DDIR_WRITE] || !td_random(td))
665 o->ba[DDIR_WRITE] = o->min_bs[DDIR_WRITE];
666 if (!o->ba[DDIR_TRIM] || !td_random(td))
667 o->ba[DDIR_TRIM] = o->min_bs[DDIR_TRIM];
669 if ((o->ba[DDIR_READ] != o->min_bs[DDIR_READ] ||
670 o->ba[DDIR_WRITE] != o->min_bs[DDIR_WRITE] ||
671 o->ba[DDIR_TRIM] != o->min_bs[DDIR_TRIM]) &&
673 log_err("fio: Any use of blockalign= turns off randommap\n");
675 ret = warnings_fatal;
678 if (!o->file_size_high)
679 o->file_size_high = o->file_size_low;
681 if (o->start_delay_high)
682 o->start_delay = get_rand_start_delay(td);
684 if (o->norandommap && o->verify != VERIFY_NONE
685 && !fixed_block_size(o)) {
686 log_err("fio: norandommap given for variable block sizes, "
688 ret = warnings_fatal;
690 if (o->bs_unaligned && (o->odirect || td_ioengine_flagged(td, FIO_RAWIO)))
691 log_err("fio: bs_unaligned may not work with raw io\n");
694 * thinktime_spin must be less than thinktime
696 if (o->thinktime_spin > o->thinktime)
697 o->thinktime_spin = o->thinktime;
700 * The low water mark cannot be bigger than the iodepth
702 if (o->iodepth_low > o->iodepth || !o->iodepth_low)
703 o->iodepth_low = o->iodepth;
706 * If batch number isn't set, default to the same as iodepth
708 if (o->iodepth_batch > o->iodepth || !o->iodepth_batch)
709 o->iodepth_batch = o->iodepth;
712 * If max batch complete number isn't set or set incorrectly,
713 * default to the same as iodepth_batch_complete_min
715 if (o->iodepth_batch_complete_min > o->iodepth_batch_complete_max)
716 o->iodepth_batch_complete_max = o->iodepth_batch_complete_min;
719 * There's no need to check for in-flight overlapping IOs if the job
720 * isn't changing data or the maximum iodepth is guaranteed to be 1
722 if (o->serialize_overlap && !(td->flags & TD_F_READ_IOLOG) &&
723 (!(td_write(td) || td_trim(td)) || o->iodepth == 1))
724 o->serialize_overlap = 0;
726 * Currently can't check for overlaps in offload mode
728 if (o->serialize_overlap && o->io_submit_mode == IO_MODE_OFFLOAD) {
729 log_err("fio: checking for in-flight overlaps when the "
730 "io_submit_mode is offload is not supported\n");
731 o->serialize_overlap = 0;
732 ret = warnings_fatal;
735 if (o->nr_files > td->files_index)
736 o->nr_files = td->files_index;
738 if (o->open_files > o->nr_files || !o->open_files)
739 o->open_files = o->nr_files;
741 if (((o->rate[DDIR_READ] + o->rate[DDIR_WRITE] + o->rate[DDIR_TRIM]) &&
742 (o->rate_iops[DDIR_READ] + o->rate_iops[DDIR_WRITE] + o->rate_iops[DDIR_TRIM])) ||
743 ((o->ratemin[DDIR_READ] + o->ratemin[DDIR_WRITE] + o->ratemin[DDIR_TRIM]) &&
744 (o->rate_iops_min[DDIR_READ] + o->rate_iops_min[DDIR_WRITE] + o->rate_iops_min[DDIR_TRIM]))) {
745 log_err("fio: rate and rate_iops are mutually exclusive\n");
748 if ((o->rate[DDIR_READ] && (o->rate[DDIR_READ] < o->ratemin[DDIR_READ])) ||
749 (o->rate[DDIR_WRITE] && (o->rate[DDIR_WRITE] < o->ratemin[DDIR_WRITE])) ||
750 (o->rate[DDIR_TRIM] && (o->rate[DDIR_TRIM] < o->ratemin[DDIR_TRIM])) ||
751 (o->rate_iops[DDIR_READ] && (o->rate_iops[DDIR_READ] < o->rate_iops_min[DDIR_READ])) ||
752 (o->rate_iops[DDIR_WRITE] && (o->rate_iops[DDIR_WRITE] < o->rate_iops_min[DDIR_WRITE])) ||
753 (o->rate_iops[DDIR_TRIM] && (o->rate_iops[DDIR_TRIM] < o->rate_iops_min[DDIR_TRIM]))) {
754 log_err("fio: minimum rate exceeds rate\n");
758 if (!o->timeout && o->time_based) {
759 log_err("fio: time_based requires a runtime/timeout setting\n");
761 ret = warnings_fatal;
764 if (o->fill_device && !o->size)
767 if (o->verify != VERIFY_NONE) {
768 if (td_write(td) && o->do_verify && o->numjobs > 1 &&
770 !(o->unique_filename &&
771 strstr(o->filename_format, "$jobname") &&
772 strstr(o->filename_format, "$jobnum") &&
773 strstr(o->filename_format, "$filenum")))) {
774 log_info("fio: multiple writers may overwrite blocks "
775 "that belong to other jobs. This can cause "
776 "verification failures.\n");
777 ret = warnings_fatal;
781 * Warn if verification is requested but no verification of any
782 * kind can be started due to time constraints
784 if (td_write(td) && o->do_verify && o->timeout &&
785 o->time_based && !td_read(td) && !o->verify_backlog) {
786 log_info("fio: verification read phase will never "
787 "start because write phase uses all of "
789 ret = warnings_fatal;
792 if (!fio_option_is_set(o, refill_buffers))
793 o->refill_buffers = 1;
795 if (o->max_bs[DDIR_WRITE] != o->min_bs[DDIR_WRITE] &&
797 o->verify_interval = o->min_bs[DDIR_WRITE];
800 * Verify interval must be smaller or equal to the
803 if (o->verify_interval > o->min_bs[DDIR_WRITE])
804 o->verify_interval = o->min_bs[DDIR_WRITE];
805 else if (td_read(td) && o->verify_interval > o->min_bs[DDIR_READ])
806 o->verify_interval = o->min_bs[DDIR_READ];
809 * Verify interval must be a factor of both min and max
812 if (!o->verify_interval ||
813 (o->min_bs[DDIR_WRITE] % o->verify_interval) ||
814 (o->max_bs[DDIR_WRITE] % o->verify_interval))
815 o->verify_interval = gcd(o->min_bs[DDIR_WRITE],
816 o->max_bs[DDIR_WRITE]);
820 if (o->invalidate_cache)
821 o->invalidate_cache = 0;
822 if (td_ioengine_flagged(td, FIO_PIPEIO)) {
823 log_info("fio: cannot pre-read files with an IO engine"
824 " that isn't seekable. Pre-read disabled.\n");
825 ret = warnings_fatal;
830 if (td_ioengine_flagged(td, FIO_BIT_BASED))
836 #ifndef FIO_HAVE_ANY_FALLOCATE
837 /* Platform doesn't support any fallocate so force it to none */
838 o->fallocate_mode = FIO_FALLOCATE_NONE;
841 #ifndef CONFIG_FDATASYNC
842 if (o->fdatasync_blocks) {
843 log_info("fio: this platform does not support fdatasync()"
844 " falling back to using fsync(). Use the 'fsync'"
845 " option instead of 'fdatasync' to get rid of"
847 o->fsync_blocks = o->fdatasync_blocks;
848 o->fdatasync_blocks = 0;
849 ret = warnings_fatal;
855 * Windows doesn't support O_DIRECT or O_SYNC with the _open interface,
856 * so fail if we're passed those flags
858 if (td_ioengine_flagged(td, FIO_SYNCIO) && (o->odirect || o->sync_io)) {
859 log_err("fio: Windows does not support direct or non-buffered io with"
860 " the synchronous ioengines. Use the 'windowsaio' ioengine"
861 " with 'direct=1' and 'iodepth=1' instead.\n");
867 * For fully compressible data, just zero them at init time.
868 * It's faster than repeatedly filling it. For non-zero
869 * compression, we should have refill_buffers set. Set it, unless
870 * the job file already changed it.
872 if (o->compress_percentage) {
873 if (o->compress_percentage == 100) {
875 o->compress_percentage = 0;
876 } else if (!fio_option_is_set(o, refill_buffers)) {
877 o->refill_buffers = 1;
878 td->flags |= TD_F_REFILL_BUFFERS;
883 * Using a non-uniform random distribution excludes usage of
886 if (o->random_distribution != FIO_RAND_DIST_RANDOM)
890 * If size is set but less than the min block size, complain
892 if (o->size && o->size < td_min_bs(td)) {
893 log_err("fio: size too small, must not be less than minimum block size: %llu < %u\n",
894 (unsigned long long) o->size, td_min_bs(td));
899 * O_ATOMIC implies O_DIRECT
905 * If randseed is set, that overrides randrepeat
907 if (fio_option_is_set(o, rand_seed))
908 o->rand_repeatable = 0;
910 if (td_ioengine_flagged(td, FIO_NOEXTEND) && o->file_append) {
911 log_err("fio: can't append/extent with IO engine %s\n", td->io_ops->name);
915 if (fio_option_is_set(o, gtod_cpu)) {
917 fio_gtod_set_cpu(o->gtod_cpu);
918 fio_gtod_offload = 1;
921 td->loops = o->loops;
925 if (o->block_error_hist && o->nr_files != 1) {
926 log_err("fio: block error histogram only available "
927 "with a single file per job, but %d files "
928 "provided\n", o->nr_files);
932 if (fio_option_is_set(o, clat_percentiles) &&
933 !fio_option_is_set(o, lat_percentiles)) {
934 o->lat_percentiles = !o->clat_percentiles;
935 } else if (fio_option_is_set(o, lat_percentiles) &&
936 !fio_option_is_set(o, clat_percentiles)) {
937 o->clat_percentiles = !o->lat_percentiles;
938 } else if (fio_option_is_set(o, lat_percentiles) &&
939 fio_option_is_set(o, clat_percentiles) &&
940 o->lat_percentiles && o->clat_percentiles) {
941 log_err("fio: lat_percentiles and clat_percentiles are "
942 "mutually exclusive\n");
947 o->lat_percentiles = 0;
949 o->clat_percentiles = 0;
952 * Fix these up to be nsec internally
954 o->max_latency *= 1000ULL;
955 o->latency_target *= 1000ULL;
956 o->latency_window *= 1000ULL;
961 static void init_rand_file_service(struct thread_data *td)
963 unsigned long nranges = td->o.nr_files << FIO_FSERVICE_SHIFT;
964 const unsigned int seed = td->rand_seeds[FIO_RAND_FILE_OFF];
966 if (td->o.file_service_type == FIO_FSERVICE_ZIPF) {
967 zipf_init(&td->next_file_zipf, nranges, td->zipf_theta, seed);
968 zipf_disable_hash(&td->next_file_zipf);
969 } else if (td->o.file_service_type == FIO_FSERVICE_PARETO) {
970 pareto_init(&td->next_file_zipf, nranges, td->pareto_h, seed);
971 zipf_disable_hash(&td->next_file_zipf);
972 } else if (td->o.file_service_type == FIO_FSERVICE_GAUSS) {
973 gauss_init(&td->next_file_gauss, nranges, td->gauss_dev, seed);
974 gauss_disable_hash(&td->next_file_gauss);
978 void td_fill_verify_state_seed(struct thread_data *td)
982 if (td->o.random_generator == FIO_RAND_GEN_TAUSWORTHE64)
987 init_rand_seed(&td->verify_state, td->rand_seeds[FIO_RAND_VER_OFF],
991 static void td_fill_rand_seeds_internal(struct thread_data *td, bool use64)
996 * trimwrite is special in that we need to generate the same
997 * offsets to get the "write after trim" effect. If we are
998 * using bssplit to set buffer length distributions, ensure that
999 * we seed the trim and write generators identically.
1001 if (td_trimwrite(td)) {
1002 init_rand_seed(&td->bsrange_state[DDIR_READ], td->rand_seeds[FIO_RAND_BS_OFF], use64);
1003 init_rand_seed(&td->bsrange_state[DDIR_WRITE], td->rand_seeds[FIO_RAND_BS1_OFF], use64);
1004 init_rand_seed(&td->bsrange_state[DDIR_TRIM], td->rand_seeds[FIO_RAND_BS1_OFF], use64);
1006 init_rand_seed(&td->bsrange_state[DDIR_READ], td->rand_seeds[FIO_RAND_BS_OFF], use64);
1007 init_rand_seed(&td->bsrange_state[DDIR_WRITE], td->rand_seeds[FIO_RAND_BS1_OFF], use64);
1008 init_rand_seed(&td->bsrange_state[DDIR_TRIM], td->rand_seeds[FIO_RAND_BS2_OFF], use64);
1011 td_fill_verify_state_seed(td);
1012 init_rand_seed(&td->rwmix_state, td->rand_seeds[FIO_RAND_MIX_OFF], false);
1014 if (td->o.file_service_type == FIO_FSERVICE_RANDOM)
1015 init_rand_seed(&td->next_file_state, td->rand_seeds[FIO_RAND_FILE_OFF], use64);
1016 else if (td->o.file_service_type & __FIO_FSERVICE_NONUNIFORM)
1017 init_rand_file_service(td);
1019 init_rand_seed(&td->file_size_state, td->rand_seeds[FIO_RAND_FILE_SIZE_OFF], use64);
1020 init_rand_seed(&td->trim_state, td->rand_seeds[FIO_RAND_TRIM_OFF], use64);
1021 init_rand_seed(&td->delay_state, td->rand_seeds[FIO_RAND_START_DELAY], use64);
1022 init_rand_seed(&td->poisson_state[0], td->rand_seeds[FIO_RAND_POISSON_OFF], 0);
1023 init_rand_seed(&td->poisson_state[1], td->rand_seeds[FIO_RAND_POISSON2_OFF], 0);
1024 init_rand_seed(&td->poisson_state[2], td->rand_seeds[FIO_RAND_POISSON3_OFF], 0);
1025 init_rand_seed(&td->dedupe_state, td->rand_seeds[FIO_DEDUPE_OFF], false);
1026 init_rand_seed(&td->zone_state, td->rand_seeds[FIO_RAND_ZONE_OFF], false);
1031 if (td->o.rand_repeatable)
1032 td->rand_seeds[FIO_RAND_BLOCK_OFF] = FIO_RANDSEED * td->thread_number;
1034 init_rand_seed(&td->random_state, td->rand_seeds[FIO_RAND_BLOCK_OFF], use64);
1036 for (i = 0; i < DDIR_RWDIR_CNT; i++) {
1037 struct frand_state *s = &td->seq_rand_state[i];
1039 init_rand_seed(s, td->rand_seeds[FIO_RAND_SEQ_RAND_READ_OFF], false);
1043 void td_fill_rand_seeds(struct thread_data *td)
1047 if (td->o.allrand_repeatable) {
1050 for (i = 0; i < FIO_RAND_NR_OFFS; i++)
1051 td->rand_seeds[i] = FIO_RANDSEED * td->thread_number
1055 if (td->o.random_generator == FIO_RAND_GEN_TAUSWORTHE64)
1060 td_fill_rand_seeds_internal(td, use64);
1062 init_rand_seed(&td->buf_state, td->rand_seeds[FIO_RAND_BUF_OFF], use64);
1063 frand_copy(&td->buf_state_prev, &td->buf_state);
1067 * Initializes the ioengine configured for a job, if it has not been done so
1070 int ioengine_load(struct thread_data *td)
1072 if (!td->o.ioengine) {
1073 log_err("fio: internal fault, no IO engine specified\n");
1078 struct ioengine_ops *ops;
1081 /* An engine is loaded, but the requested ioengine
1084 if (!strcmp(td->io_ops->name, td->o.ioengine)) {
1085 /* The right engine is already loaded */
1090 * Name of file and engine may be different, load ops
1091 * for this name and see if they match. If they do, then
1092 * the engine is unchanged.
1094 dlhandle = td->io_ops_dlhandle;
1095 ops = load_ioengine(td);
1096 if (ops == td->io_ops && dlhandle == td->io_ops_dlhandle) {
1102 if (dlhandle && dlhandle != td->io_ops_dlhandle)
1105 /* Unload the old engine. */
1109 td->io_ops = load_ioengine(td);
1111 log_err("fio: failed to load engine\n");
1115 if (td->io_ops->option_struct_size && td->io_ops->options) {
1117 * In cases where td->eo is set, clone it for a child thread.
1118 * This requires that the parent thread has the same ioengine,
1119 * but that requirement must be enforced by the code which
1120 * cloned the thread.
1122 void *origeo = td->eo;
1124 * Otherwise use the default thread options.
1126 if (!origeo && td != &def_thread && def_thread.eo &&
1127 def_thread.io_ops->options == td->io_ops->options)
1128 origeo = def_thread.eo;
1130 options_init(td->io_ops->options);
1131 td->eo = malloc(td->io_ops->option_struct_size);
1133 * Use the default thread as an option template if this uses the
1134 * same options structure and there are non-default options
1138 memcpy(td->eo, origeo, td->io_ops->option_struct_size);
1139 options_mem_dupe(td->io_ops->options, td->eo);
1141 memset(td->eo, 0, td->io_ops->option_struct_size);
1142 fill_default_options(td->eo, td->io_ops->options);
1144 *(struct thread_data **)td->eo = td;
1148 td->io_ops->flags |= FIO_RAWIO;
1150 td_set_ioengine_flags(td);
1154 static void init_flags(struct thread_data *td)
1156 struct thread_options *o = &td->o;
1159 if (o->verify_backlog)
1160 td->flags |= TD_F_VER_BACKLOG;
1161 if (o->trim_backlog)
1162 td->flags |= TD_F_TRIM_BACKLOG;
1163 if (o->read_iolog_file)
1164 td->flags |= TD_F_READ_IOLOG;
1165 if (o->refill_buffers)
1166 td->flags |= TD_F_REFILL_BUFFERS;
1168 * Always scramble buffers if asked to
1170 if (o->scramble_buffers && fio_option_is_set(o, scramble_buffers))
1171 td->flags |= TD_F_SCRAMBLE_BUFFERS;
1173 * But also scramble buffers, unless we were explicitly asked
1176 if (o->scramble_buffers && !(o->zero_buffers &&
1177 fio_option_is_set(o, zero_buffers)))
1178 td->flags |= TD_F_SCRAMBLE_BUFFERS;
1179 if (o->verify != VERIFY_NONE)
1180 td->flags |= TD_F_VER_NONE;
1182 if (o->verify_async || o->io_submit_mode == IO_MODE_OFFLOAD)
1183 td->flags |= TD_F_NEED_LOCK;
1185 if (o->mem_type == MEM_CUDA_MALLOC)
1186 td->flags &= ~TD_F_SCRAMBLE_BUFFERS;
1188 for (i = 0; i < DDIR_RWDIR_CNT; i++) {
1189 if (option_check_rate(td, i)) {
1190 td->flags |= TD_F_CHECK_RATE;
1196 static int setup_random_seeds(struct thread_data *td)
1201 if (!td->o.rand_repeatable && !fio_option_is_set(&td->o, rand_seed)) {
1202 int ret = init_random_seeds(td->rand_seeds, sizeof(td->rand_seeds));
1204 td_fill_rand_seeds(td);
1208 seed = td->o.rand_seed;
1209 for (i = 0; i < 4; i++)
1210 seed *= 0x9e370001UL;
1212 for (i = 0; i < FIO_RAND_NR_OFFS; i++) {
1213 td->rand_seeds[i] = seed * td->thread_number + i;
1214 seed *= 0x9e370001UL;
1217 td_fill_rand_seeds(td);
1228 static struct fpre_keyword {
1229 const char *keyword;
1232 } fpre_keywords[] = {
1233 { .keyword = "$jobname", .key = FPRE_JOBNAME, },
1234 { .keyword = "$jobnum", .key = FPRE_JOBNUM, },
1235 { .keyword = "$filenum", .key = FPRE_FILENUM, },
1236 { .keyword = NULL, },
1239 static char *make_filename(char *buf, size_t buf_size,struct thread_options *o,
1240 const char *jobname, int jobnum, int filenum)
1242 struct fpre_keyword *f;
1243 char copy[PATH_MAX];
1244 size_t dst_left = PATH_MAX - 1;
1246 if (!o->filename_format || !strlen(o->filename_format)) {
1247 sprintf(buf, "%s.%d.%d", jobname, jobnum, filenum);
1251 for (f = &fpre_keywords[0]; f->keyword; f++)
1252 f->strlen = strlen(f->keyword);
1254 buf[buf_size - 1] = '\0';
1255 strncpy(buf, o->filename_format, buf_size - 1);
1257 memset(copy, 0, sizeof(copy));
1258 for (f = &fpre_keywords[0]; f->keyword; f++) {
1260 size_t pre_len, post_start = 0;
1261 char *str, *dst = copy;
1263 str = strcasestr(buf, f->keyword);
1267 pre_len = str - buf;
1268 if (strlen(str) != f->strlen)
1269 post_start = pre_len + f->strlen;
1272 strncpy(dst, buf, pre_len);
1274 dst_left -= pre_len;
1278 case FPRE_JOBNAME: {
1281 ret = snprintf(dst, dst_left, "%s", jobname);
1284 else if (ret > dst_left) {
1285 log_err("fio: truncated filename\n");
1297 ret = snprintf(dst, dst_left, "%d", jobnum);
1300 else if (ret > dst_left) {
1301 log_err("fio: truncated filename\n");
1310 case FPRE_FILENUM: {
1313 ret = snprintf(dst, dst_left, "%d", filenum);
1316 else if (ret > dst_left) {
1317 log_err("fio: truncated filename\n");
1332 strncpy(dst, buf + post_start, dst_left);
1334 strncpy(buf, copy, buf_size - 1);
1341 bool parse_dryrun(void)
1343 return dump_cmdline || parse_only;
1346 static void gen_log_name(char *name, size_t size, const char *logtype,
1347 const char *logname, unsigned int num,
1348 const char *suf, int per_job)
1351 snprintf(name, size, "%s_%s.%d.%s", logname, logtype, num, suf);
1353 snprintf(name, size, "%s_%s.%s", logname, logtype, suf);
1356 static int check_waitees(char *waitee)
1358 struct thread_data *td;
1361 for_each_td(td, i) {
1362 if (td->subjob_number)
1365 ret += !strcmp(td->o.name, waitee);
1371 static bool wait_for_ok(const char *jobname, struct thread_options *o)
1378 if (!strcmp(jobname, o->wait_for)) {
1379 log_err("%s: a job cannot wait for itself (wait_for=%s).\n",
1380 jobname, o->wait_for);
1384 if (!(nw = check_waitees(o->wait_for))) {
1385 log_err("%s: waitee job %s unknown.\n", jobname, o->wait_for);
1390 log_err("%s: multiple waitees %s found,\n"
1391 "please avoid duplicates when using wait_for option.\n",
1392 jobname, o->wait_for);
1400 * Adds a job to the list of things todo. Sanitizes the various options
1401 * to make sure we don't have conflicts, and initializes various
1404 static int add_job(struct thread_data *td, const char *jobname, int job_add_num,
1405 int recursed, int client_type)
1408 char fname[PATH_MAX];
1409 int numjobs, file_alloced;
1410 struct thread_options *o = &td->o;
1411 char logname[PATH_MAX + 32];
1414 * the def_thread is just for options, it's not a real job
1416 if (td == &def_thread)
1422 * if we are just dumping the output command line, don't add the job
1424 if (parse_dryrun()) {
1429 td->client_type = client_type;
1431 if (profile_td_init(td))
1434 if (ioengine_load(td))
1438 if (!o->filename && !td->files_index && !o->read_iolog_file) {
1441 if (o->nr_files == 1 && exists_and_not_regfile(jobname))
1442 add_file(td, jobname, job_add_num, 0);
1444 for (i = 0; i < o->nr_files; i++)
1445 add_file(td, make_filename(fname, sizeof(fname), o, jobname, job_add_num, i), job_add_num, 0);
1449 if (fixup_options(td))
1453 * Belongs to fixup_options, but o->name is not necessarily set as yet
1455 if (!wait_for_ok(jobname, o))
1461 * IO engines only need this for option callbacks, and the address may
1462 * change in subprocesses.
1465 *(struct thread_data **)td->eo = NULL;
1467 if (td_ioengine_flagged(td, FIO_DISKLESSIO)) {
1470 for_each_file(td, f, i)
1471 f->real_file_size = -1ULL;
1474 td->mutex = fio_mutex_init(FIO_MUTEX_LOCKED);
1476 td->ts.clat_percentiles = o->clat_percentiles;
1477 td->ts.lat_percentiles = o->lat_percentiles;
1478 td->ts.percentile_precision = o->percentile_precision;
1479 memcpy(td->ts.percentile_list, o->percentile_list, sizeof(o->percentile_list));
1480 td->ts.sig_figs = o->sig_figs;
1482 for (i = 0; i < DDIR_RWDIR_CNT; i++) {
1483 td->ts.clat_stat[i].min_val = ULONG_MAX;
1484 td->ts.slat_stat[i].min_val = ULONG_MAX;
1485 td->ts.lat_stat[i].min_val = ULONG_MAX;
1486 td->ts.bw_stat[i].min_val = ULONG_MAX;
1487 td->ts.iops_stat[i].min_val = ULONG_MAX;
1489 td->ts.sync_stat.min_val = ULONG_MAX;
1490 td->ddir_seq_nr = o->ddir_seq_nr;
1492 if ((o->stonewall || o->new_group) && prev_group_jobs) {
1493 prev_group_jobs = 0;
1495 if (groupid == INT_MAX) {
1496 log_err("fio: too many groups defined\n");
1501 td->groupid = groupid;
1504 if (setup_random_seeds(td)) {
1505 td_verror(td, errno, "setup_random_seeds");
1512 if (o->write_lat_log) {
1513 struct log_params p = {
1515 .avg_msec = o->log_avg_msec,
1516 .hist_msec = o->log_hist_msec,
1517 .hist_coarseness = o->log_hist_coarseness,
1518 .log_type = IO_LOG_TYPE_LAT,
1519 .log_offset = o->log_offset,
1520 .log_gz = o->log_gz,
1521 .log_gz_store = o->log_gz_store,
1523 const char *pre = o->lat_log_file ? o->lat_log_file : o->name;
1531 gen_log_name(logname, sizeof(logname), "lat", pre,
1532 td->thread_number, suf, o->per_job_logs);
1533 setup_log(&td->lat_log, &p, logname);
1535 gen_log_name(logname, sizeof(logname), "slat", pre,
1536 td->thread_number, suf, o->per_job_logs);
1537 setup_log(&td->slat_log, &p, logname);
1539 gen_log_name(logname, sizeof(logname), "clat", pre,
1540 td->thread_number, suf, o->per_job_logs);
1541 setup_log(&td->clat_log, &p, logname);
1544 if (o->write_hist_log) {
1545 struct log_params p = {
1547 .avg_msec = o->log_avg_msec,
1548 .hist_msec = o->log_hist_msec,
1549 .hist_coarseness = o->log_hist_coarseness,
1550 .log_type = IO_LOG_TYPE_HIST,
1551 .log_offset = o->log_offset,
1552 .log_gz = o->log_gz,
1553 .log_gz_store = o->log_gz_store,
1555 const char *pre = o->hist_log_file ? o->hist_log_file : o->name;
1559 if (td->client_type) {
1560 log_err("fio: --write_hist_log requires zlib in client/server mode\n");
1570 gen_log_name(logname, sizeof(logname), "clat_hist", pre,
1571 td->thread_number, suf, o->per_job_logs);
1572 setup_log(&td->clat_hist_log, &p, logname);
1575 if (o->write_bw_log) {
1576 struct log_params p = {
1578 .avg_msec = o->log_avg_msec,
1579 .hist_msec = o->log_hist_msec,
1580 .hist_coarseness = o->log_hist_coarseness,
1581 .log_type = IO_LOG_TYPE_BW,
1582 .log_offset = o->log_offset,
1583 .log_gz = o->log_gz,
1584 .log_gz_store = o->log_gz_store,
1586 const char *pre = o->bw_log_file ? o->bw_log_file : o->name;
1589 if (fio_option_is_set(o, bw_avg_time))
1590 p.avg_msec = min(o->log_avg_msec, o->bw_avg_time);
1592 o->bw_avg_time = p.avg_msec;
1594 p.hist_msec = o->log_hist_msec;
1595 p.hist_coarseness = o->log_hist_coarseness;
1602 gen_log_name(logname, sizeof(logname), "bw", pre,
1603 td->thread_number, suf, o->per_job_logs);
1604 setup_log(&td->bw_log, &p, logname);
1606 if (o->write_iops_log) {
1607 struct log_params p = {
1609 .avg_msec = o->log_avg_msec,
1610 .hist_msec = o->log_hist_msec,
1611 .hist_coarseness = o->log_hist_coarseness,
1612 .log_type = IO_LOG_TYPE_IOPS,
1613 .log_offset = o->log_offset,
1614 .log_gz = o->log_gz,
1615 .log_gz_store = o->log_gz_store,
1617 const char *pre = o->iops_log_file ? o->iops_log_file : o->name;
1620 if (fio_option_is_set(o, iops_avg_time))
1621 p.avg_msec = min(o->log_avg_msec, o->iops_avg_time);
1623 o->iops_avg_time = p.avg_msec;
1625 p.hist_msec = o->log_hist_msec;
1626 p.hist_coarseness = o->log_hist_coarseness;
1633 gen_log_name(logname, sizeof(logname), "iops", pre,
1634 td->thread_number, suf, o->per_job_logs);
1635 setup_log(&td->iops_log, &p, logname);
1639 o->name = strdup(jobname);
1641 if (output_format & FIO_OUTPUT_NORMAL) {
1643 if (is_backend && !recursed)
1644 fio_server_send_add_job(td);
1646 if (!td_ioengine_flagged(td, FIO_NOIO)) {
1647 char *c1, *c2, *c3, *c4;
1648 char *c5 = NULL, *c6 = NULL;
1649 int i2p = is_power_of_2(o->kb_base);
1651 c1 = num2str(o->min_bs[DDIR_READ], o->sig_figs, 1, i2p, N2S_BYTE);
1652 c2 = num2str(o->max_bs[DDIR_READ], o->sig_figs, 1, i2p, N2S_BYTE);
1653 c3 = num2str(o->min_bs[DDIR_WRITE], o->sig_figs, 1, i2p, N2S_BYTE);
1654 c4 = num2str(o->max_bs[DDIR_WRITE], o->sig_figs, 1, i2p, N2S_BYTE);
1656 if (!o->bs_is_seq_rand) {
1657 c5 = num2str(o->min_bs[DDIR_TRIM], o->sig_figs, 1, i2p, N2S_BYTE);
1658 c6 = num2str(o->max_bs[DDIR_TRIM], o->sig_figs, 1, i2p, N2S_BYTE);
1661 log_info("%s: (g=%d): rw=%s, ", td->o.name,
1663 ddir_str(o->td_ddir));
1665 if (o->bs_is_seq_rand)
1666 log_info("bs=(R) %s-%s, (W) %s-%s, bs_is_seq_rand, ",
1669 log_info("bs=(R) %s-%s, (W) %s-%s, (T) %s-%s, ",
1670 c1, c2, c3, c4, c5, c6);
1672 log_info("ioengine=%s, iodepth=%u\n",
1673 td->io_ops->name, o->iodepth);
1682 } else if (job_add_num == 1)
1686 if (td_steadystate_init(td))
1690 * recurse add identical jobs, clear numjobs and stonewall options
1691 * as they don't apply to sub-jobs
1693 numjobs = o->numjobs;
1695 struct thread_data *td_new = get_new_job(false, td, true, jobname);
1700 td_new->o.numjobs = 1;
1701 td_new->o.stonewall = 0;
1702 td_new->o.new_group = 0;
1703 td_new->subjob_number = numjobs;
1704 td_new->o.ss_dur = o->ss_dur * 1000000l;
1705 td_new->o.ss_limit = o->ss_limit;
1708 if (td_new->files) {
1710 for_each_file(td_new, f, i) {
1712 sfree(f->file_name);
1715 free(td_new->files);
1716 td_new->files = NULL;
1718 td_new->files_index = 0;
1719 td_new->files_size = 0;
1720 if (td_new->o.filename) {
1721 free(td_new->o.filename);
1722 td_new->o.filename = NULL;
1726 if (add_job(td_new, jobname, numjobs, 1, client_type))
1737 * Parse as if 'o' was a command line
1739 void add_job_opts(const char **o, int client_type)
1741 struct thread_data *td, *td_parent;
1742 int i, in_global = 1;
1746 td_parent = td = NULL;
1748 if (!strncmp(o[i], "name", 4)) {
1751 add_job(td, jobname, 0, 0, client_type);
1753 sprintf(jobname, "%s", o[i] + 5);
1755 if (in_global && !td_parent)
1756 td_parent = get_new_job(true, &def_thread, false, jobname);
1757 else if (!in_global && !td) {
1759 td_parent = &def_thread;
1760 td = get_new_job(false, td_parent, false, jobname);
1763 fio_options_parse(td_parent, (char **) &o[i], 1);
1765 fio_options_parse(td, (char **) &o[i], 1);
1770 add_job(td, jobname, 0, 0, client_type);
1773 static int skip_this_section(const char *name)
1777 if (!nr_job_sections)
1779 if (!strncmp(name, "global", 6))
1782 for (i = 0; i < nr_job_sections; i++)
1783 if (!strcmp(job_sections[i], name))
1789 static int is_empty_or_comment(char *line)
1793 for (i = 0; i < strlen(line); i++) {
1798 if (!isspace((int) line[i]) && !iscntrl((int) line[i]))
1806 * This is our [ini] type file parser.
1808 static int __parse_jobs_ini(struct thread_data *td,
1809 char *file, int is_buf, int stonewall_flag, int type,
1810 int nested, char *name, char ***popts, int *aopts, int *nopts)
1812 bool global = false;
1816 int ret = 0, stonewall;
1819 int inside_skip = 0;
1821 int i, alloc_opts, num_opts;
1823 dprint(FD_PARSE, "Parsing ini file %s\n", file);
1824 assert(td || !nested);
1829 if (!strcmp(file, "-"))
1832 f = fopen(file, "r");
1837 log_err("fio: unable to open '%s' job file\n", file);
1839 td_verror(td, __err, "job file open");
1844 string = malloc(4096);
1847 * it's really 256 + small bit, 280 should suffice
1851 memset(name, 0, 280);
1855 if (nested && popts) {
1857 alloc_opts = *aopts;
1863 opts = malloc(sizeof(char *) * alloc_opts);
1867 stonewall = stonewall_flag;
1870 * if skip_fgets is set, we already have loaded a line we
1875 p = strsep(&file, "\n");
1877 p = fgets(string, 4096, f);
1883 strip_blank_front(&p);
1886 dprint(FD_PARSE, "%s\n", p);
1887 if (is_empty_or_comment(p))
1891 if (sscanf(p, "[%255[^\n]]", name) != 1) {
1895 log_err("fio: option <%s> outside of "
1896 "[] job section\n", p);
1901 name[strlen(name) - 1] = '\0';
1903 if (skip_this_section(name)) {
1909 dprint(FD_PARSE, "Parsing section [%s]\n", name);
1911 global = !strncmp(name, "global", 6);
1917 log_info("--name=%s ", name);
1921 td = get_new_job(global, &def_thread, false, name);
1928 * Separate multiple job files by a stonewall
1930 if (!global && stonewall) {
1931 td->o.stonewall = stonewall;
1936 memset(opts, 0, alloc_opts * sizeof(char *));
1944 p = strsep(&file, "\n");
1946 p = fgets(string, 4096, f);
1949 dprint(FD_PARSE, "%s", p);
1954 if (is_empty_or_comment(p))
1957 strip_blank_front(&p);
1960 * new section, break out and make sure we don't
1961 * fgets() a new line at the top.
1965 log_err("No new sections in included files\n");
1975 if (!strncmp(p, "include", strlen("include"))) {
1976 char *filename = p + strlen("include") + 1,
1977 *ts, *full_fn = NULL;
1980 * Allow for the include filename
1981 * specification to be relative.
1983 if (access(filename, F_OK) &&
1984 (ts = strrchr(file, '/'))) {
1985 int len = ts - file +
1986 strlen(filename) + 2;
1988 if (!(full_fn = calloc(1, len))) {
1994 file, (ts - file) + 1);
1995 strncpy(full_fn + (ts - file) + 1,
1996 filename, strlen(filename));
1997 full_fn[len - 1] = 0;
2001 ret = __parse_jobs_ini(td, filename, is_buf,
2002 stonewall_flag, type, 1,
2004 &alloc_opts, &num_opts);
2007 log_err("Error %d while parsing "
2008 "include file %s\n",
2021 if (num_opts == alloc_opts) {
2023 opts = realloc(opts,
2024 alloc_opts * sizeof(char *));
2027 opts[num_opts] = strdup(p);
2033 *aopts = alloc_opts;
2038 ret = fio_options_parse(td, opts, num_opts);
2043 ret = add_job(td, name, 0, 0, type);
2045 log_err("fio: job %s dropped\n", name);
2049 for (i = 0; i < num_opts; i++)
2058 while (i < nr_job_sections) {
2059 free(job_sections[i]);
2068 if (!is_buf && f != stdin)
2073 int parse_jobs_ini(char *file, int is_buf, int stonewall_flag, int type)
2075 return __parse_jobs_ini(NULL, file, is_buf, stonewall_flag, type,
2076 0, NULL, NULL, NULL, NULL);
2079 static int fill_def_thread(void)
2081 memset(&def_thread, 0, sizeof(def_thread));
2082 INIT_FLIST_HEAD(&def_thread.opt_list);
2084 fio_getaffinity(getpid(), &def_thread.o.cpumask);
2085 def_thread.o.error_dump = 1;
2088 * fill default options
2090 fio_fill_default_options(&def_thread);
2094 static void show_debug_categories(void)
2096 #ifdef FIO_INC_DEBUG
2097 struct debug_level *dl = &debug_levels[0];
2098 int curlen, first = 1;
2102 int has_next = (dl + 1)->name != NULL;
2104 if (first || curlen + strlen(dl->name) >= 80) {
2109 curlen += printf("\t\t\t%s", dl->name);
2110 curlen += 3 * (8 - 1);
2112 curlen += printf(",");
2114 curlen += printf("%s", dl->name);
2116 curlen += printf(",");
2126 * Following options aren't printed by usage().
2127 * --append-terse - Equivalent to --output-format=terse, see f6a7df53.
2128 * --latency-log - Deprecated option.
2130 static void usage(const char *name)
2132 printf("%s\n", fio_version_string);
2133 printf("%s [options] [job options] <job file(s)>\n", name);
2134 printf(" --debug=options\tEnable debug logging. May be one/more of:\n");
2135 show_debug_categories();
2136 printf(" --parse-only\t\tParse options only, don't start any IO\n");
2137 printf(" --output\t\tWrite output to file\n");
2138 printf(" --bandwidth-log\tGenerate aggregate bandwidth logs\n");
2139 printf(" --minimal\t\tMinimal (terse) output\n");
2140 printf(" --output-format=type\tOutput format (terse,json,json+,normal)\n");
2141 printf(" --terse-version=type\tSet terse version output format"
2142 " (default 3, or 2 or 4)\n");
2143 printf(" --version\t\tPrint version info and exit\n");
2144 printf(" --help\t\tPrint this page\n");
2145 printf(" --cpuclock-test\tPerform test/validation of CPU clock\n");
2146 printf(" --crctest=[type]\tTest speed of checksum functions\n");
2147 printf(" --cmdhelp=cmd\t\tPrint command help, \"all\" for all of"
2149 printf(" --enghelp=engine\tPrint ioengine help, or list"
2150 " available ioengines\n");
2151 printf(" --enghelp=engine,cmd\tPrint help for an ioengine"
2153 printf(" --showcmd\t\tTurn a job file into command line options\n");
2154 printf(" --eta=when\t\tWhen ETA estimate should be printed\n");
2155 printf(" \t\tMay be \"always\", \"never\" or \"auto\"\n");
2156 printf(" --eta-newline=time\tForce a new line for every 'time'");
2157 printf(" period passed\n");
2158 printf(" --status-interval=t\tForce full status dump every");
2159 printf(" 't' period passed\n");
2160 printf(" --readonly\t\tTurn on safety read-only checks, preventing"
2162 printf(" --section=name\tOnly run specified section in job file,"
2163 " multiple sections can be specified\n");
2164 printf(" --alloc-size=kb\tSet smalloc pool to this size in kb"
2166 printf(" --warnings-fatal\tFio parser warnings are fatal\n");
2167 printf(" --max-jobs=nr\t\tMaximum number of threads/processes to support\n");
2168 printf(" --server=args\t\tStart a backend fio server\n");
2169 printf(" --daemonize=pidfile\tBackground fio server, write pid to file\n");
2170 printf(" --client=hostname\tTalk to remote backend(s) fio server at hostname\n");
2171 printf(" --remote-config=file\tTell fio server to load this local job file\n");
2172 printf(" --idle-prof=option\tReport cpu idleness on a system or percpu basis\n"
2173 "\t\t\t(option=system,percpu) or run unit work\n"
2174 "\t\t\tcalibration only (option=calibrate)\n");
2176 printf(" --inflate-log=log\tInflate and output compressed log\n");
2178 printf(" --trigger-file=file\tExecute trigger cmd when file exists\n");
2179 printf(" --trigger-timeout=t\tExecute trigger at this time\n");
2180 printf(" --trigger=cmd\t\tSet this command as local trigger\n");
2181 printf(" --trigger-remote=cmd\tSet this command as remote trigger\n");
2182 printf(" --aux-path=path\tUse this path for fio state generated files\n");
2183 printf("\nFio was written by Jens Axboe <axboe@kernel.dk>\n");
2186 #ifdef FIO_INC_DEBUG
2187 struct debug_level debug_levels[] = {
2188 { .name = "process",
2189 .help = "Process creation/exit logging",
2190 .shift = FD_PROCESS,
2193 .help = "File related action logging",
2197 .help = "IO and IO engine action logging (offsets, queue, completions, etc)",
2201 .help = "Memory allocation/freeing logging",
2204 { .name = "blktrace",
2205 .help = "blktrace action logging",
2206 .shift = FD_BLKTRACE,
2209 .help = "IO verification action logging",
2213 .help = "Random generation logging",
2217 .help = "Parser logging",
2220 { .name = "diskutil",
2221 .help = "Disk utility logging actions",
2222 .shift = FD_DISKUTIL,
2225 .help = "Logging related to creating/destroying jobs",
2229 .help = "Mutex logging",
2232 { .name = "profile",
2233 .help = "Logging related to profiles",
2234 .shift = FD_PROFILE,
2237 .help = "Logging related to time keeping functions",
2241 .help = "Network logging",
2245 .help = "Rate logging",
2248 { .name = "compress",
2249 .help = "Log compression logging",
2250 .shift = FD_COMPRESS,
2252 { .name = "steadystate",
2253 .help = "Steady state detection logging",
2254 .shift = FD_STEADYSTATE,
2256 { .name = "helperthread",
2257 .help = "Helper thread logging",
2258 .shift = FD_HELPERTHREAD,
2263 static int set_debug(const char *string)
2265 struct debug_level *dl;
2266 char *p = (char *) string;
2273 if (!strcmp(string, "?") || !strcmp(string, "help")) {
2274 log_info("fio: dumping debug options:");
2275 for (i = 0; debug_levels[i].name; i++) {
2276 dl = &debug_levels[i];
2277 log_info("%s,", dl->name);
2283 while ((opt = strsep(&p, ",")) != NULL) {
2286 if (!strncmp(opt, "all", 3)) {
2287 log_info("fio: set all debug options\n");
2292 for (i = 0; debug_levels[i].name; i++) {
2293 dl = &debug_levels[i];
2294 found = !strncmp(opt, dl->name, strlen(dl->name));
2298 if (dl->shift == FD_JOB) {
2299 opt = strchr(opt, ':');
2301 log_err("fio: missing job number\n");
2305 fio_debug_jobno = atoi(opt);
2306 log_info("fio: set debug jobno %d\n",
2309 log_info("fio: set debug option %s\n", opt);
2310 fio_debug |= (1UL << dl->shift);
2316 log_err("fio: debug mask %s not found\n", opt);
2321 static int set_debug(const char *string)
2323 log_err("fio: debug tracing not included in build\n");
2328 static void fio_options_fill_optstring(void)
2330 char *ostr = cmd_optstr;
2334 while (l_opts[i].name) {
2335 ostr[c++] = l_opts[i].val;
2336 if (l_opts[i].has_arg == required_argument)
2338 else if (l_opts[i].has_arg == optional_argument) {
2347 static int client_flag_set(char c)
2352 while (l_opts[i].name) {
2353 int val = l_opts[i].val;
2355 if (c == (val & 0xff))
2356 return (val & FIO_CLIENT_FLAG);
2364 static void parse_cmd_client(void *client, char *opt)
2366 fio_client_add_cmd_option(client, opt);
2369 static void show_closest_option(const char *name)
2371 int best_option, best_distance;
2374 while (*name == '-')
2378 best_distance = INT_MAX;
2380 while (l_opts[i].name) {
2381 distance = string_distance(name, l_opts[i].name);
2382 if (distance < best_distance) {
2383 best_distance = distance;
2389 if (best_option != -1 && string_distance_ok(name, best_distance))
2390 log_err("Did you mean %s?\n", l_opts[best_option].name);
2393 static int parse_output_format(const char *optarg)
2395 char *p, *orig, *opt;
2398 p = orig = strdup(optarg);
2402 while ((opt = strsep(&p, ",")) != NULL) {
2403 if (!strcmp(opt, "minimal") ||
2404 !strcmp(opt, "terse") ||
2405 !strcmp(opt, "csv"))
2406 output_format |= FIO_OUTPUT_TERSE;
2407 else if (!strcmp(opt, "json"))
2408 output_format |= FIO_OUTPUT_JSON;
2409 else if (!strcmp(opt, "json+"))
2410 output_format |= (FIO_OUTPUT_JSON | FIO_OUTPUT_JSON_PLUS);
2411 else if (!strcmp(opt, "normal"))
2412 output_format |= FIO_OUTPUT_NORMAL;
2414 log_err("fio: invalid output format %s\n", opt);
2424 int parse_cmd_line(int argc, char *argv[], int client_type)
2426 struct thread_data *td = NULL;
2427 int c, ini_idx = 0, lidx, ret = 0, do_exit = 0, exit_val = 0;
2428 char *ostr = cmd_optstr;
2429 char *pid_file = NULL;
2430 void *cur_client = NULL;
2434 * Reset optind handling, since we may call this multiple times
2439 while ((c = getopt_long_only(argc, argv, ostr, l_opts, &lidx)) != -1) {
2440 if ((c & FIO_CLIENT_FLAG) || client_flag_set(c)) {
2441 parse_cmd_client(cur_client, argv[optind - 1]);
2442 c &= ~FIO_CLIENT_FLAG;
2447 smalloc_pool_size = atoi(optarg);
2448 smalloc_pool_size <<= 10;
2452 log_err("fio: --latency-log is deprecated. Use per-job latency log options.\n");
2462 if (f_out && f_out != stdout)
2465 tmp = fopen(optarg, "w+");
2467 log_err("fio: output file open error: %s\n", strerror(errno));
2472 f_err = f_out = tmp;
2476 output_format = FIO_OUTPUT_TERSE;
2479 if (parse_output_format(optarg)) {
2480 log_err("fio: failed parsing output-format\n");
2487 output_format |= FIO_OUTPUT_TERSE;
2499 fio_show_option_help(optarg);
2506 fio_show_ioengine_help(optarg);
2520 log_info("%s\n", fio_version_string);
2525 terse_version = atoi(optarg);
2526 if (!(terse_version >= 2 && terse_version <= 5)) {
2527 log_err("fio: bad terse version format\n");
2533 if (!strcmp("always", optarg))
2534 eta_print = FIO_ETA_ALWAYS;
2535 else if (!strcmp("never", optarg))
2536 eta_print = FIO_ETA_NEVER;
2541 if (check_str_time(optarg, &t, 1)) {
2542 log_err("fio: failed parsing eta time %s\n", optarg);
2547 eta_new_line = t / 1000;
2548 if (!eta_new_line) {
2549 log_err("fio: eta new line time too short\n");
2558 if (check_str_time(optarg, &t, 1)) {
2559 log_err("fio: failed parsing eta interval %s\n", optarg);
2564 eta_interval_msec = t / 1000;
2565 if (eta_interval_msec < DISK_UTIL_MSEC) {
2566 log_err("fio: eta interval time too short (%umsec min)\n", DISK_UTIL_MSEC);
2573 if (set_debug(optarg))
2583 if (!strcmp(optarg, "global")) {
2584 log_err("fio: can't use global as only "
2590 new_size = (nr_job_sections + 1) * sizeof(char *);
2591 job_sections = realloc(job_sections, new_size);
2592 job_sections[nr_job_sections] = strdup(optarg);
2598 exit_val = iolog_file_inflate(optarg);
2607 exec_profile = strdup(optarg);
2609 case FIO_GETOPT_JOB: {
2610 const char *opt = l_opts[lidx].name;
2613 if (!strncmp(opt, "name", 4) && td) {
2614 ret = add_job(td, td->o.name ?: "fio", 0, 0, client_type);
2621 int is_section = !strncmp(opt, "name", 4);
2624 if (!is_section || !strncmp(val, "global", 6))
2627 if (is_section && skip_this_section(val))
2630 td = get_new_job(global, &def_thread, true, NULL);
2631 if (!td || ioengine_load(td)) {
2640 fio_options_set_ioengine_opts(l_opts, td);
2643 if ((!val || !strlen(val)) &&
2644 l_opts[lidx].has_arg == required_argument) {
2645 log_err("fio: option %s requires an argument\n", opt);
2648 ret = fio_cmd_option_parse(td, opt, val);
2659 if (!ret && !strcmp(opt, "ioengine")) {
2660 if (ioengine_load(td)) {
2667 fio_options_set_ioengine_opts(l_opts, td);
2671 case FIO_GETOPT_IOENGINE: {
2672 const char *opt = l_opts[lidx].name;
2678 ret = fio_cmd_ioengine_option_parse(td, opt, val);
2685 max_jobs = atoi(optarg);
2686 if (!max_jobs || max_jobs > REAL_MAX_JOBS) {
2687 log_err("fio: invalid max jobs: %d\n", max_jobs);
2694 #ifndef CONFIG_NO_SHM
2696 log_err("fio: can't be both client and server\n");
2702 fio_server_set_arg(optarg);
2706 log_err("fio: client/server requires SHM support\n");
2714 pid_file = strdup(optarg);
2717 if ((ret = fio_idle_prof_parse_opt(optarg))) {
2718 /* exit on error and calibration only */
2728 log_err("fio: can't be both client and server\n");
2733 /* if --client parameter contains a pathname */
2734 if (0 == access(optarg, R_OK)) {
2735 /* file contains a list of host addrs or names */
2736 char hostaddr[PATH_MAX] = {0};
2738 FILE * hostf = fopen(optarg, "r");
2740 log_err("fio: could not open client list file %s for read\n", optarg);
2745 sprintf(formatstr, "%%%ds", PATH_MAX - 1);
2747 * read at most PATH_MAX-1 chars from each
2748 * record in this file
2750 while (fscanf(hostf, formatstr, hostaddr) == 1) {
2751 /* expect EVERY host in file to be valid */
2752 if (fio_client_add(&fio_client_ops, hostaddr, &cur_client)) {
2753 log_err("fio: failed adding client %s from file %s\n", hostaddr, optarg);
2760 break; /* no possibility of job file for "this client only" */
2762 if (fio_client_add(&fio_client_ops, optarg, &cur_client)) {
2763 log_err("fio: failed adding client %s\n", optarg);
2769 * If the next argument exists and isn't an option,
2770 * assume it's a job file for this client only.
2772 while (optind < argc) {
2773 if (!strncmp(argv[optind], "--", 2) ||
2774 !strncmp(argv[optind], "-", 1))
2777 if (fio_client_add_ini_file(cur_client, argv[optind], false))
2784 if (fio_client_add_ini_file(cur_client, optarg, true)) {
2792 exit_val = fio_monotonic_clocktest(1);
2797 exit_val = fio_crctest(optarg);
2802 exit_val = fio_memcpy_test(optarg);
2807 if (check_str_time(optarg, &val, 1)) {
2808 log_err("fio: failed parsing time %s\n", optarg);
2814 log_err("fio: status interval too small\n");
2818 status_interval = val / 1000;
2824 trigger_file = strdup(optarg);
2829 trigger_cmd = strdup(optarg);
2832 if (trigger_remote_cmd)
2833 free(trigger_remote_cmd);
2834 trigger_remote_cmd = strdup(optarg);
2839 aux_path = strdup(optarg);
2842 if (check_str_time(optarg, &trigger_timeout, 1)) {
2843 log_err("fio: failed parsing time %s\n", optarg);
2847 trigger_timeout /= 1000000;
2850 log_err("%s: unrecognized option '%s'\n", argv[0],
2852 show_closest_option(argv[optind - 1]);
2862 if (do_exit && !(is_backend || nr_clients))
2865 if (nr_clients && fio_clients_connect())
2868 if (is_backend && backend)
2869 return fio_start_server(pid_file);
2875 ret = add_job(td, td->o.name ?: "fio", 0, 0, client_type);
2881 while (!ret && optind < argc) {
2883 ini_file = realloc(ini_file, ini_idx * sizeof(char *));
2884 ini_file[ini_idx - 1] = strdup(argv[optind]);
2892 int fio_init_options(void)
2897 fio_options_fill_optstring();
2898 fio_options_dup_and_init(l_opts);
2902 if (fill_def_thread())
2908 extern int fio_check_options(struct thread_options *);
2910 int parse_options(int argc, char *argv[])
2912 const int type = FIO_CLIENT_TYPE_CLI;
2915 if (fio_init_options())
2917 if (fio_test_cconv(&def_thread.o))
2918 log_err("fio: failed internal cconv test\n");
2920 job_files = parse_cmd_line(argc, argv, type);
2922 if (job_files > 0) {
2923 for (i = 0; i < job_files; i++) {
2924 if (i && fill_def_thread())
2927 if (fio_clients_send_ini(ini_file[i]))
2930 } else if (!is_backend) {
2931 if (parse_jobs_ini(ini_file[i], 0, i, type))
2936 } else if (nr_clients) {
2937 if (fill_def_thread())
2939 if (fio_clients_send_ini(NULL))
2944 fio_options_free(&def_thread);
2945 filesetup_mem_free();
2947 if (!thread_number) {
2952 if (is_backend || nr_clients)
2957 log_err("No job(s) defined\n\n");
2962 if (output_format & FIO_OUTPUT_NORMAL)
2963 log_info("%s\n", fio_version_string);
2968 void options_default_fill(struct thread_options *o)
2970 memcpy(o, &def_thread.o, sizeof(*o));
2973 struct thread_data *get_global_options(void)