2 * This file contains job initialization and setup functions.
12 #include <sys/types.h>
16 #ifndef FIO_NO_HAVE_SHM_H
28 #include "steadystate.h"
30 #include "oslib/getopt.h"
31 #include "oslib/strcasestr.h"
36 const char fio_version_string[] = FIO_VERSION;
38 #define FIO_RANDSEED (0xb1899bedUL)
40 static char **ini_file;
41 static int max_jobs = FIO_MAX_JOBS;
42 static int dump_cmdline;
43 static int parse_only;
45 static struct thread_data def_thread;
46 struct thread_data *threads = NULL;
47 static char **job_sections;
48 static int nr_job_sections;
50 int exitall_on_terminate = 0;
51 int output_format = FIO_OUTPUT_NORMAL;
52 int eta_print = FIO_ETA_AUTO;
56 char *exec_profile = NULL;
57 int warnings_fatal = 0;
58 int terse_version = 3;
65 int status_interval = 0;
67 char *trigger_file = NULL;
68 long long trigger_timeout = 0;
69 char *trigger_cmd = NULL;
70 char *trigger_remote_cmd = NULL;
72 char *aux_path = NULL;
74 static int prev_group_jobs;
76 unsigned long fio_debug = 0;
77 unsigned int fio_debug_jobno = -1;
78 unsigned int *fio_debug_jobp = NULL;
80 static char cmd_optstr[256];
83 #define FIO_CLIENT_FLAG (1 << 16)
86 * Command line options. These will contain the above, plus a few
87 * extra that only pertain to fio itself and not jobs.
89 static struct option l_opts[FIO_NR_OPTIONS] = {
91 .name = (char *) "output",
92 .has_arg = required_argument,
93 .val = 'o' | FIO_CLIENT_FLAG,
96 .name = (char *) "latency-log",
97 .has_arg = required_argument,
98 .val = 'l' | FIO_CLIENT_FLAG,
101 .name = (char *) "bandwidth-log",
102 .has_arg = no_argument,
103 .val = 'b' | FIO_CLIENT_FLAG,
106 .name = (char *) "minimal",
107 .has_arg = no_argument,
108 .val = 'm' | FIO_CLIENT_FLAG,
111 .name = (char *) "output-format",
112 .has_arg = required_argument,
113 .val = 'F' | FIO_CLIENT_FLAG,
116 .name = (char *) "append-terse",
117 .has_arg = optional_argument,
121 .name = (char *) "version",
122 .has_arg = no_argument,
123 .val = 'v' | FIO_CLIENT_FLAG,
126 .name = (char *) "help",
127 .has_arg = no_argument,
128 .val = 'h' | FIO_CLIENT_FLAG,
131 .name = (char *) "cmdhelp",
132 .has_arg = optional_argument,
133 .val = 'c' | FIO_CLIENT_FLAG,
136 .name = (char *) "enghelp",
137 .has_arg = optional_argument,
138 .val = 'i' | FIO_CLIENT_FLAG,
141 .name = (char *) "showcmd",
142 .has_arg = no_argument,
143 .val = 's' | FIO_CLIENT_FLAG,
146 .name = (char *) "readonly",
147 .has_arg = no_argument,
148 .val = 'r' | FIO_CLIENT_FLAG,
151 .name = (char *) "eta",
152 .has_arg = required_argument,
153 .val = 'e' | FIO_CLIENT_FLAG,
156 .name = (char *) "eta-newline",
157 .has_arg = required_argument,
158 .val = 'E' | FIO_CLIENT_FLAG,
161 .name = (char *) "debug",
162 .has_arg = required_argument,
163 .val = 'd' | FIO_CLIENT_FLAG,
166 .name = (char *) "parse-only",
167 .has_arg = no_argument,
168 .val = 'P' | FIO_CLIENT_FLAG,
171 .name = (char *) "section",
172 .has_arg = required_argument,
173 .val = 'x' | FIO_CLIENT_FLAG,
177 .name = (char *) "inflate-log",
178 .has_arg = required_argument,
179 .val = 'X' | FIO_CLIENT_FLAG,
183 .name = (char *) "alloc-size",
184 .has_arg = required_argument,
185 .val = 'a' | FIO_CLIENT_FLAG,
188 .name = (char *) "profile",
189 .has_arg = required_argument,
190 .val = 'p' | FIO_CLIENT_FLAG,
193 .name = (char *) "warnings-fatal",
194 .has_arg = no_argument,
195 .val = 'w' | FIO_CLIENT_FLAG,
198 .name = (char *) "max-jobs",
199 .has_arg = required_argument,
200 .val = 'j' | FIO_CLIENT_FLAG,
203 .name = (char *) "terse-version",
204 .has_arg = required_argument,
205 .val = 'V' | FIO_CLIENT_FLAG,
208 .name = (char *) "server",
209 .has_arg = optional_argument,
212 { .name = (char *) "daemonize",
213 .has_arg = required_argument,
217 .name = (char *) "client",
218 .has_arg = required_argument,
222 .name = (char *) "remote-config",
223 .has_arg = required_argument,
227 .name = (char *) "cpuclock-test",
228 .has_arg = no_argument,
232 .name = (char *) "crctest",
233 .has_arg = optional_argument,
237 .name = (char *) "idle-prof",
238 .has_arg = required_argument,
242 .name = (char *) "status-interval",
243 .has_arg = required_argument,
247 .name = (char *) "trigger-file",
248 .has_arg = required_argument,
252 .name = (char *) "trigger-timeout",
253 .has_arg = required_argument,
257 .name = (char *) "trigger",
258 .has_arg = required_argument,
262 .name = (char *) "trigger-remote",
263 .has_arg = required_argument,
267 .name = (char *) "aux-path",
268 .has_arg = required_argument,
276 void free_threads_shm(void)
280 #ifndef CONFIG_NO_SHM
281 struct shmid_ds sbuf;
285 shmctl(shm_id, IPC_RMID, &sbuf);
294 static void free_shm(void)
298 fio_debug_jobp = NULL;
304 free(trigger_remote_cmd);
305 trigger_file = trigger_cmd = trigger_remote_cmd = NULL;
307 options_free(fio_options, &def_thread.o);
314 * The thread area is shared between the main process and the job
315 * threads/processes. So setup a shared memory segment that will hold
316 * all the job info. We use the end of the region for keeping track of
317 * open files across jobs, for file sharing.
319 static int setup_thread_area(void)
325 * 1024 is too much on some machines, scale max_jobs if
326 * we get a failure that looks like too large a shm segment
329 size_t size = max_jobs * sizeof(struct thread_data);
331 size += sizeof(unsigned int);
333 #ifndef CONFIG_NO_SHM
334 shm_id = shmget(0, size, IPC_CREAT | 0600);
337 if (errno != EINVAL && errno != ENOMEM && errno != ENOSPC) {
342 threads = malloc(size);
350 #ifndef CONFIG_NO_SHM
354 threads = shmat(shm_id, NULL, 0);
355 if (threads == (void *) -1) {
359 if (shm_attach_to_open_removed())
360 shmctl(shm_id, IPC_RMID, NULL);
363 memset(threads, 0, max_jobs * sizeof(struct thread_data));
364 fio_debug_jobp = (unsigned int *)(threads + max_jobs);
365 *fio_debug_jobp = -1;
372 static void dump_print_option(struct print_option *p)
376 if (!strcmp("description", p->name))
381 log_info("--%s%s", p->name, p->value ? "" : " ");
383 log_info("=%s%s%s ", delim, p->value, delim);
386 static void dump_opt_list(struct thread_data *td)
388 struct flist_head *entry;
389 struct print_option *p;
391 if (flist_empty(&td->opt_list))
394 flist_for_each(entry, &td->opt_list) {
395 p = flist_entry(entry, struct print_option, list);
396 dump_print_option(p);
400 static void fio_dump_options_free(struct thread_data *td)
402 while (!flist_empty(&td->opt_list)) {
403 struct print_option *p;
405 p = flist_first_entry(&td->opt_list, struct print_option, list);
406 flist_del_init(&p->list);
413 static void copy_opt_list(struct thread_data *dst, struct thread_data *src)
415 struct flist_head *entry;
417 if (flist_empty(&src->opt_list))
420 flist_for_each(entry, &src->opt_list) {
421 struct print_option *srcp, *dstp;
423 srcp = flist_entry(entry, struct print_option, list);
424 dstp = malloc(sizeof(*dstp));
425 dstp->name = strdup(srcp->name);
427 dstp->value = strdup(srcp->value);
430 flist_add_tail(&dstp->list, &dst->opt_list);
435 * Return a free job structure.
437 static struct thread_data *get_new_job(bool global, struct thread_data *parent,
438 bool preserve_eo, const char *jobname)
440 struct thread_data *td;
444 if (setup_thread_area()) {
445 log_err("error: failed to setup shm segment\n");
448 if (thread_number >= max_jobs) {
449 log_err("error: maximum number of jobs (%d) reached.\n",
454 td = &threads[thread_number++];
457 INIT_FLIST_HEAD(&td->opt_list);
458 if (parent != &def_thread)
459 copy_opt_list(td, parent);
466 td->o.uid = td->o.gid = -1U;
468 dup_files(td, parent);
469 fio_options_mem_dupe(td);
471 profile_add_hooks(td);
473 td->thread_number = thread_number;
474 td->subjob_number = 0;
477 td->o.name = strdup(jobname);
479 if (!parent->o.group_reporting || parent == &def_thread)
485 static void put_job(struct thread_data *td)
487 if (td == &def_thread)
494 log_info("fio: %s\n", td->verror);
496 fio_options_free(td);
497 fio_dump_options_free(td);
504 memset(&threads[td->thread_number - 1], 0, sizeof(*td));
508 static int __setup_rate(struct thread_data *td, enum fio_ddir ddir)
510 unsigned int bs = td->o.min_bs[ddir];
512 assert(ddir_rw(ddir));
514 if (td->o.rate[ddir])
515 td->rate_bps[ddir] = td->o.rate[ddir];
517 td->rate_bps[ddir] = (uint64_t) td->o.rate_iops[ddir] * bs;
519 if (!td->rate_bps[ddir]) {
520 log_err("rate lower than supported\n");
524 td->rate_next_io_time[ddir] = 0;
525 td->rate_io_issue_bytes[ddir] = 0;
526 td->last_usec[ddir] = 0;
530 static int setup_rate(struct thread_data *td)
534 if (td->o.rate[DDIR_READ] || td->o.rate_iops[DDIR_READ])
535 ret = __setup_rate(td, DDIR_READ);
536 if (td->o.rate[DDIR_WRITE] || td->o.rate_iops[DDIR_WRITE])
537 ret |= __setup_rate(td, DDIR_WRITE);
538 if (td->o.rate[DDIR_TRIM] || td->o.rate_iops[DDIR_TRIM])
539 ret |= __setup_rate(td, DDIR_TRIM);
544 static int fixed_block_size(struct thread_options *o)
546 return o->min_bs[DDIR_READ] == o->max_bs[DDIR_READ] &&
547 o->min_bs[DDIR_WRITE] == o->max_bs[DDIR_WRITE] &&
548 o->min_bs[DDIR_TRIM] == o->max_bs[DDIR_TRIM] &&
549 o->min_bs[DDIR_READ] == o->min_bs[DDIR_WRITE] &&
550 o->min_bs[DDIR_READ] == o->min_bs[DDIR_TRIM];
554 static unsigned long long get_rand_start_delay(struct thread_data *td)
556 unsigned long long delayrange;
560 delayrange = td->o.start_delay_high - td->o.start_delay;
562 frand_max = rand_max(&td->delay_state);
563 r = __rand(&td->delay_state);
564 delayrange = (unsigned long long) ((double) delayrange * (r / (frand_max + 1.0)));
566 delayrange += td->o.start_delay;
573 static unsigned int gcd(unsigned int m, unsigned int n)
578 return gcd(n, m % n);
582 * Lazy way of fixing up options that depend on each other. We could also
583 * define option callback handlers, but this is easier.
585 static int fixup_options(struct thread_data *td)
587 struct thread_options *o = &td->o;
590 #ifndef CONFIG_PSHARED
591 if (!o->use_thread) {
592 log_info("fio: this platform does not support process shared"
593 " mutexes, forcing use of threads. Use the 'thread'"
594 " option to get rid of this warning.\n");
596 ret = warnings_fatal;
600 if (o->write_iolog_file && o->read_iolog_file) {
601 log_err("fio: read iolog overrides write_iolog\n");
602 free(o->write_iolog_file);
603 o->write_iolog_file = NULL;
604 ret = warnings_fatal;
608 * only really works with 1 file
610 if (o->zone_size && o->open_files > 1)
614 * If zone_range isn't specified, backward compatibility dictates it
615 * should be made equal to zone_size.
617 if (o->zone_size && !o->zone_range)
618 o->zone_range = o->zone_size;
621 * Reads can do overwrites, we always need to pre-create the file
626 if (!o->min_bs[DDIR_READ])
627 o->min_bs[DDIR_READ] = o->bs[DDIR_READ];
628 if (!o->max_bs[DDIR_READ])
629 o->max_bs[DDIR_READ] = o->bs[DDIR_READ];
630 if (!o->min_bs[DDIR_WRITE])
631 o->min_bs[DDIR_WRITE] = o->bs[DDIR_WRITE];
632 if (!o->max_bs[DDIR_WRITE])
633 o->max_bs[DDIR_WRITE] = o->bs[DDIR_WRITE];
634 if (!o->min_bs[DDIR_TRIM])
635 o->min_bs[DDIR_TRIM] = o->bs[DDIR_TRIM];
636 if (!o->max_bs[DDIR_TRIM])
637 o->max_bs[DDIR_TRIM] = o->bs[DDIR_TRIM];
639 o->rw_min_bs = min(o->min_bs[DDIR_READ], o->min_bs[DDIR_WRITE]);
640 o->rw_min_bs = min(o->min_bs[DDIR_TRIM], o->rw_min_bs);
643 * For random IO, allow blockalign offset other than min_bs.
645 if (!o->ba[DDIR_READ] || !td_random(td))
646 o->ba[DDIR_READ] = o->min_bs[DDIR_READ];
647 if (!o->ba[DDIR_WRITE] || !td_random(td))
648 o->ba[DDIR_WRITE] = o->min_bs[DDIR_WRITE];
649 if (!o->ba[DDIR_TRIM] || !td_random(td))
650 o->ba[DDIR_TRIM] = o->min_bs[DDIR_TRIM];
652 if ((o->ba[DDIR_READ] != o->min_bs[DDIR_READ] ||
653 o->ba[DDIR_WRITE] != o->min_bs[DDIR_WRITE] ||
654 o->ba[DDIR_TRIM] != o->min_bs[DDIR_TRIM]) &&
656 log_err("fio: Any use of blockalign= turns off randommap\n");
658 ret = warnings_fatal;
661 if (!o->file_size_high)
662 o->file_size_high = o->file_size_low;
664 if (o->start_delay_high)
665 o->start_delay = get_rand_start_delay(td);
667 if (o->norandommap && o->verify != VERIFY_NONE
668 && !fixed_block_size(o)) {
669 log_err("fio: norandommap given for variable block sizes, "
671 ret = warnings_fatal;
673 if (o->bs_unaligned && (o->odirect || td_ioengine_flagged(td, FIO_RAWIO)))
674 log_err("fio: bs_unaligned may not work with raw io\n");
677 * thinktime_spin must be less than thinktime
679 if (o->thinktime_spin > o->thinktime)
680 o->thinktime_spin = o->thinktime;
683 * The low water mark cannot be bigger than the iodepth
685 if (o->iodepth_low > o->iodepth || !o->iodepth_low)
686 o->iodepth_low = o->iodepth;
689 * If batch number isn't set, default to the same as iodepth
691 if (o->iodepth_batch > o->iodepth || !o->iodepth_batch)
692 o->iodepth_batch = o->iodepth;
695 * If max batch complete number isn't set or set incorrectly,
696 * default to the same as iodepth_batch_complete_min
698 if (o->iodepth_batch_complete_min > o->iodepth_batch_complete_max)
699 o->iodepth_batch_complete_max = o->iodepth_batch_complete_min;
701 if (o->nr_files > td->files_index)
702 o->nr_files = td->files_index;
704 if (o->open_files > o->nr_files || !o->open_files)
705 o->open_files = o->nr_files;
707 if (((o->rate[DDIR_READ] + o->rate[DDIR_WRITE] + o->rate[DDIR_TRIM]) &&
708 (o->rate_iops[DDIR_READ] + o->rate_iops[DDIR_WRITE] + o->rate_iops[DDIR_TRIM])) ||
709 ((o->ratemin[DDIR_READ] + o->ratemin[DDIR_WRITE] + o->ratemin[DDIR_TRIM]) &&
710 (o->rate_iops_min[DDIR_READ] + o->rate_iops_min[DDIR_WRITE] + o->rate_iops_min[DDIR_TRIM]))) {
711 log_err("fio: rate and rate_iops are mutually exclusive\n");
714 if ((o->rate[DDIR_READ] && (o->rate[DDIR_READ] < o->ratemin[DDIR_READ])) ||
715 (o->rate[DDIR_WRITE] && (o->rate[DDIR_WRITE] < o->ratemin[DDIR_WRITE])) ||
716 (o->rate[DDIR_TRIM] && (o->rate[DDIR_TRIM] < o->ratemin[DDIR_TRIM])) ||
717 (o->rate_iops[DDIR_READ] && (o->rate_iops[DDIR_READ] < o->rate_iops_min[DDIR_READ])) ||
718 (o->rate_iops[DDIR_WRITE] && (o->rate_iops[DDIR_WRITE] < o->rate_iops_min[DDIR_WRITE])) ||
719 (o->rate_iops[DDIR_TRIM] && (o->rate_iops[DDIR_TRIM] < o->rate_iops_min[DDIR_TRIM]))) {
720 log_err("fio: minimum rate exceeds rate\n");
724 if (!o->timeout && o->time_based) {
725 log_err("fio: time_based requires a runtime/timeout setting\n");
727 ret = warnings_fatal;
730 if (o->fill_device && !o->size)
733 if (o->verify != VERIFY_NONE) {
734 if (td_write(td) && o->do_verify && o->numjobs > 1) {
735 log_info("Multiple writers may overwrite blocks that "
736 "belong to other jobs. This can cause "
737 "verification failures.\n");
738 ret = warnings_fatal;
741 if (!fio_option_is_set(o, refill_buffers))
742 o->refill_buffers = 1;
744 if (o->max_bs[DDIR_WRITE] != o->min_bs[DDIR_WRITE] &&
746 o->verify_interval = o->min_bs[DDIR_WRITE];
749 * Verify interval must be smaller or equal to the
752 if (o->verify_interval > o->min_bs[DDIR_WRITE])
753 o->verify_interval = o->min_bs[DDIR_WRITE];
754 else if (td_read(td) && o->verify_interval > o->min_bs[DDIR_READ])
755 o->verify_interval = o->min_bs[DDIR_READ];
758 * Verify interval must be a factor or both min and max
761 if (o->verify_interval % o->min_bs[DDIR_WRITE] ||
762 o->verify_interval % o->max_bs[DDIR_WRITE])
763 o->verify_interval = gcd(o->min_bs[DDIR_WRITE],
764 o->max_bs[DDIR_WRITE]);
768 if (o->invalidate_cache)
769 o->invalidate_cache = 0;
770 if (td_ioengine_flagged(td, FIO_PIPEIO)) {
771 log_info("fio: cannot pre-read files with an IO engine"
772 " that isn't seekable. Pre-read disabled.\n");
773 ret = warnings_fatal;
778 if (td_ioengine_flagged(td, FIO_BIT_BASED))
784 #ifndef CONFIG_FDATASYNC
785 if (o->fdatasync_blocks) {
786 log_info("fio: this platform does not support fdatasync()"
787 " falling back to using fsync(). Use the 'fsync'"
788 " option instead of 'fdatasync' to get rid of"
790 o->fsync_blocks = o->fdatasync_blocks;
791 o->fdatasync_blocks = 0;
792 ret = warnings_fatal;
798 * Windows doesn't support O_DIRECT or O_SYNC with the _open interface,
799 * so fail if we're passed those flags
801 if (td_ioengine_flagged(td, FIO_SYNCIO) && (td->o.odirect || td->o.sync_io)) {
802 log_err("fio: Windows does not support direct or non-buffered io with"
803 " the synchronous ioengines. Use the 'windowsaio' ioengine"
804 " with 'direct=1' and 'iodepth=1' instead.\n");
810 * For fully compressible data, just zero them at init time.
811 * It's faster than repeatedly filling it. For non-zero
812 * compression, we should have refill_buffers set. Set it, unless
813 * the job file already changed it.
815 if (o->compress_percentage) {
816 if (o->compress_percentage == 100) {
818 o->compress_percentage = 0;
819 } else if (!fio_option_is_set(o, refill_buffers))
820 o->refill_buffers = 1;
824 * Using a non-uniform random distribution excludes usage of
827 if (td->o.random_distribution != FIO_RAND_DIST_RANDOM)
828 td->o.norandommap = 1;
831 * If size is set but less than the min block size, complain
833 if (o->size && o->size < td_min_bs(td)) {
834 log_err("fio: size too small, must not be less than minimum block size: %llu < %u\n",
835 (unsigned long long) o->size, td_min_bs(td));
840 * O_ATOMIC implies O_DIRECT
846 * If randseed is set, that overrides randrepeat
848 if (fio_option_is_set(&td->o, rand_seed))
849 td->o.rand_repeatable = 0;
851 if (td_ioengine_flagged(td, FIO_NOEXTEND) && td->o.file_append) {
852 log_err("fio: can't append/extent with IO engine %s\n", td->io_ops->name);
856 if (fio_option_is_set(o, gtod_cpu)) {
858 fio_gtod_set_cpu(o->gtod_cpu);
859 fio_gtod_offload = 1;
862 td->loops = o->loops;
866 if (td->o.block_error_hist && td->o.nr_files != 1) {
867 log_err("fio: block error histogram only available "
868 "with a single file per job, but %d files "
869 "provided\n", td->o.nr_files);
876 /* External engines are specified by "external:name.o") */
877 static const char *get_engine_name(const char *str)
879 char *p = strstr(str, ":");
885 strip_blank_front(&p);
890 static void init_rand_file_service(struct thread_data *td)
892 unsigned long nranges = td->o.nr_files << FIO_FSERVICE_SHIFT;
893 const unsigned int seed = td->rand_seeds[FIO_RAND_FILE_OFF];
895 if (td->o.file_service_type == FIO_FSERVICE_ZIPF) {
896 zipf_init(&td->next_file_zipf, nranges, td->zipf_theta, seed);
897 zipf_disable_hash(&td->next_file_zipf);
898 } else if (td->o.file_service_type == FIO_FSERVICE_PARETO) {
899 pareto_init(&td->next_file_zipf, nranges, td->pareto_h, seed);
900 zipf_disable_hash(&td->next_file_zipf);
901 } else if (td->o.file_service_type == FIO_FSERVICE_GAUSS) {
902 gauss_init(&td->next_file_gauss, nranges, td->gauss_dev, seed);
903 gauss_disable_hash(&td->next_file_gauss);
907 void td_fill_verify_state_seed(struct thread_data *td)
911 if (td->o.random_generator == FIO_RAND_GEN_TAUSWORTHE64)
916 init_rand_seed(&td->verify_state, td->rand_seeds[FIO_RAND_VER_OFF],
920 static void td_fill_rand_seeds_internal(struct thread_data *td, bool use64)
924 init_rand_seed(&td->bsrange_state, td->rand_seeds[FIO_RAND_BS_OFF], use64);
925 td_fill_verify_state_seed(td);
926 init_rand_seed(&td->rwmix_state, td->rand_seeds[FIO_RAND_MIX_OFF], false);
928 if (td->o.file_service_type == FIO_FSERVICE_RANDOM)
929 init_rand_seed(&td->next_file_state, td->rand_seeds[FIO_RAND_FILE_OFF], use64);
930 else if (td->o.file_service_type & __FIO_FSERVICE_NONUNIFORM)
931 init_rand_file_service(td);
933 init_rand_seed(&td->file_size_state, td->rand_seeds[FIO_RAND_FILE_SIZE_OFF], use64);
934 init_rand_seed(&td->trim_state, td->rand_seeds[FIO_RAND_TRIM_OFF], use64);
935 init_rand_seed(&td->delay_state, td->rand_seeds[FIO_RAND_START_DELAY], use64);
936 init_rand_seed(&td->poisson_state[0], td->rand_seeds[FIO_RAND_POISSON_OFF], 0);
937 init_rand_seed(&td->poisson_state[1], td->rand_seeds[FIO_RAND_POISSON2_OFF], 0);
938 init_rand_seed(&td->poisson_state[2], td->rand_seeds[FIO_RAND_POISSON3_OFF], 0);
939 init_rand_seed(&td->dedupe_state, td->rand_seeds[FIO_DEDUPE_OFF], false);
940 init_rand_seed(&td->zone_state, td->rand_seeds[FIO_RAND_ZONE_OFF], false);
945 if (td->o.rand_repeatable)
946 td->rand_seeds[FIO_RAND_BLOCK_OFF] = FIO_RANDSEED * td->thread_number;
948 init_rand_seed(&td->random_state, td->rand_seeds[FIO_RAND_BLOCK_OFF], use64);
950 for (i = 0; i < DDIR_RWDIR_CNT; i++) {
951 struct frand_state *s = &td->seq_rand_state[i];
953 init_rand_seed(s, td->rand_seeds[FIO_RAND_SEQ_RAND_READ_OFF], false);
957 void td_fill_rand_seeds(struct thread_data *td)
961 if (td->o.allrand_repeatable) {
964 for (i = 0; i < FIO_RAND_NR_OFFS; i++)
965 td->rand_seeds[i] = FIO_RANDSEED * td->thread_number
969 if (td->o.random_generator == FIO_RAND_GEN_TAUSWORTHE64)
974 td_fill_rand_seeds_internal(td, use64);
976 init_rand_seed(&td->buf_state, td->rand_seeds[FIO_RAND_BUF_OFF], use64);
977 frand_copy(&td->buf_state_prev, &td->buf_state);
981 * Initializes the ioengine configured for a job, if it has not been done so
984 int ioengine_load(struct thread_data *td)
989 * Engine has already been loaded.
993 if (!td->o.ioengine) {
994 log_err("fio: internal fault, no IO engine specified\n");
998 engine = get_engine_name(td->o.ioengine);
999 td->io_ops = load_ioengine(td, engine);
1001 log_err("fio: failed to load engine %s\n", engine);
1005 if (td->io_ops->option_struct_size && td->io_ops->options) {
1007 * In cases where td->eo is set, clone it for a child thread.
1008 * This requires that the parent thread has the same ioengine,
1009 * but that requirement must be enforced by the code which
1010 * cloned the thread.
1012 void *origeo = td->eo;
1014 * Otherwise use the default thread options.
1016 if (!origeo && td != &def_thread && def_thread.eo &&
1017 def_thread.io_ops->options == td->io_ops->options)
1018 origeo = def_thread.eo;
1020 options_init(td->io_ops->options);
1021 td->eo = malloc(td->io_ops->option_struct_size);
1023 * Use the default thread as an option template if this uses the
1024 * same options structure and there are non-default options
1028 memcpy(td->eo, origeo, td->io_ops->option_struct_size);
1029 options_mem_dupe(td->io_ops->options, td->eo);
1031 memset(td->eo, 0, td->io_ops->option_struct_size);
1032 fill_default_options(td->eo, td->io_ops->options);
1034 *(struct thread_data **)td->eo = td;
1038 td->io_ops->flags |= FIO_RAWIO;
1040 td_set_ioengine_flags(td);
1044 static void init_flags(struct thread_data *td)
1046 struct thread_options *o = &td->o;
1048 if (o->verify_backlog)
1049 td->flags |= TD_F_VER_BACKLOG;
1050 if (o->trim_backlog)
1051 td->flags |= TD_F_TRIM_BACKLOG;
1052 if (o->read_iolog_file)
1053 td->flags |= TD_F_READ_IOLOG;
1054 if (o->refill_buffers)
1055 td->flags |= TD_F_REFILL_BUFFERS;
1057 * Always scramble buffers if asked to
1059 if (o->scramble_buffers && fio_option_is_set(o, scramble_buffers))
1060 td->flags |= TD_F_SCRAMBLE_BUFFERS;
1062 * But also scramble buffers, unless we were explicitly asked
1065 if (o->scramble_buffers && !(o->zero_buffers &&
1066 fio_option_is_set(o, zero_buffers)))
1067 td->flags |= TD_F_SCRAMBLE_BUFFERS;
1068 if (o->verify != VERIFY_NONE)
1069 td->flags |= TD_F_VER_NONE;
1071 if (o->verify_async || o->io_submit_mode == IO_MODE_OFFLOAD)
1072 td->flags |= TD_F_NEED_LOCK;
1074 if (o->mem_type == MEM_CUDA_MALLOC)
1075 td->flags &= ~TD_F_SCRAMBLE_BUFFERS;
1078 static int setup_random_seeds(struct thread_data *td)
1083 if (!td->o.rand_repeatable && !fio_option_is_set(&td->o, rand_seed)) {
1084 int ret = init_random_seeds(td->rand_seeds, sizeof(td->rand_seeds));
1086 td_fill_rand_seeds(td);
1090 seed = td->o.rand_seed;
1091 for (i = 0; i < 4; i++)
1092 seed *= 0x9e370001UL;
1094 for (i = 0; i < FIO_RAND_NR_OFFS; i++) {
1095 td->rand_seeds[i] = seed * td->thread_number + i;
1096 seed *= 0x9e370001UL;
1099 td_fill_rand_seeds(td);
1110 static struct fpre_keyword {
1111 const char *keyword;
1114 } fpre_keywords[] = {
1115 { .keyword = "$jobname", .key = FPRE_JOBNAME, },
1116 { .keyword = "$jobnum", .key = FPRE_JOBNUM, },
1117 { .keyword = "$filenum", .key = FPRE_FILENUM, },
1118 { .keyword = NULL, },
1121 static char *make_filename(char *buf, size_t buf_size,struct thread_options *o,
1122 const char *jobname, int jobnum, int filenum)
1124 struct fpre_keyword *f;
1125 char copy[PATH_MAX];
1126 size_t dst_left = PATH_MAX - 1;
1128 if (!o->filename_format || !strlen(o->filename_format)) {
1129 sprintf(buf, "%s.%d.%d", jobname, jobnum, filenum);
1133 for (f = &fpre_keywords[0]; f->keyword; f++)
1134 f->strlen = strlen(f->keyword);
1136 buf[buf_size - 1] = '\0';
1137 strncpy(buf, o->filename_format, buf_size - 1);
1139 memset(copy, 0, sizeof(copy));
1140 for (f = &fpre_keywords[0]; f->keyword; f++) {
1142 size_t pre_len, post_start = 0;
1143 char *str, *dst = copy;
1145 str = strcasestr(buf, f->keyword);
1149 pre_len = str - buf;
1150 if (strlen(str) != f->strlen)
1151 post_start = pre_len + f->strlen;
1154 strncpy(dst, buf, pre_len);
1156 dst_left -= pre_len;
1160 case FPRE_JOBNAME: {
1163 ret = snprintf(dst, dst_left, "%s", jobname);
1166 else if (ret > dst_left) {
1167 log_err("fio: truncated filename\n");
1179 ret = snprintf(dst, dst_left, "%d", jobnum);
1182 else if (ret > dst_left) {
1183 log_err("fio: truncated filename\n");
1192 case FPRE_FILENUM: {
1195 ret = snprintf(dst, dst_left, "%d", filenum);
1198 else if (ret > dst_left) {
1199 log_err("fio: truncated filename\n");
1214 strncpy(dst, buf + post_start, dst_left);
1216 strncpy(buf, copy, buf_size - 1);
1223 bool parse_dryrun(void)
1225 return dump_cmdline || parse_only;
1228 static void gen_log_name(char *name, size_t size, const char *logtype,
1229 const char *logname, unsigned int num,
1230 const char *suf, int per_job)
1233 snprintf(name, size, "%s_%s.%d.%s", logname, logtype, num, suf);
1235 snprintf(name, size, "%s_%s.%s", logname, logtype, suf);
1238 static int check_waitees(char *waitee)
1240 struct thread_data *td;
1243 for_each_td(td, i) {
1244 if (td->subjob_number)
1247 ret += !strcmp(td->o.name, waitee);
1253 static bool wait_for_ok(const char *jobname, struct thread_options *o)
1260 if (!strcmp(jobname, o->wait_for)) {
1261 log_err("%s: a job cannot wait for itself (wait_for=%s).\n",
1262 jobname, o->wait_for);
1266 if (!(nw = check_waitees(o->wait_for))) {
1267 log_err("%s: waitee job %s unknown.\n", jobname, o->wait_for);
1272 log_err("%s: multiple waitees %s found,\n"
1273 "please avoid duplicates when using wait_for option.\n",
1274 jobname, o->wait_for);
1282 * Adds a job to the list of things todo. Sanitizes the various options
1283 * to make sure we don't have conflicts, and initializes various
1286 static int add_job(struct thread_data *td, const char *jobname, int job_add_num,
1287 int recursed, int client_type)
1290 char fname[PATH_MAX];
1291 int numjobs, file_alloced;
1292 struct thread_options *o = &td->o;
1293 char logname[PATH_MAX + 32];
1296 * the def_thread is just for options, it's not a real job
1298 if (td == &def_thread)
1304 * if we are just dumping the output command line, don't add the job
1306 if (parse_dryrun()) {
1311 td->client_type = client_type;
1313 if (profile_td_init(td))
1316 if (ioengine_load(td))
1320 if (!o->filename && !td->files_index && !o->read_iolog_file) {
1323 if (o->nr_files == 1 && exists_and_not_regfile(jobname))
1324 add_file(td, jobname, job_add_num, 0);
1326 for (i = 0; i < o->nr_files; i++)
1327 add_file(td, make_filename(fname, sizeof(fname), o, jobname, job_add_num, i), job_add_num, 0);
1331 if (fixup_options(td))
1335 * Belongs to fixup_options, but o->name is not necessarily set as yet
1337 if (!wait_for_ok(jobname, o))
1343 * IO engines only need this for option callbacks, and the address may
1344 * change in subprocesses.
1347 *(struct thread_data **)td->eo = NULL;
1349 if (td_ioengine_flagged(td, FIO_DISKLESSIO)) {
1352 for_each_file(td, f, i)
1353 f->real_file_size = -1ULL;
1356 td->mutex = fio_mutex_init(FIO_MUTEX_LOCKED);
1358 td->ts.clat_percentiles = o->clat_percentiles;
1359 td->ts.percentile_precision = o->percentile_precision;
1360 memcpy(td->ts.percentile_list, o->percentile_list, sizeof(o->percentile_list));
1362 for (i = 0; i < DDIR_RWDIR_CNT; i++) {
1363 td->ts.clat_stat[i].min_val = ULONG_MAX;
1364 td->ts.slat_stat[i].min_val = ULONG_MAX;
1365 td->ts.lat_stat[i].min_val = ULONG_MAX;
1366 td->ts.bw_stat[i].min_val = ULONG_MAX;
1367 td->ts.iops_stat[i].min_val = ULONG_MAX;
1369 td->ddir_seq_nr = o->ddir_seq_nr;
1371 if ((o->stonewall || o->new_group) && prev_group_jobs) {
1372 prev_group_jobs = 0;
1374 if (groupid == INT_MAX) {
1375 log_err("fio: too many groups defined\n");
1380 td->groupid = groupid;
1383 if (setup_random_seeds(td)) {
1384 td_verror(td, errno, "setup_random_seeds");
1391 if (o->write_lat_log) {
1392 struct log_params p = {
1394 .avg_msec = o->log_avg_msec,
1395 .hist_msec = o->log_hist_msec,
1396 .hist_coarseness = o->log_hist_coarseness,
1397 .log_type = IO_LOG_TYPE_LAT,
1398 .log_offset = o->log_offset,
1399 .log_gz = o->log_gz,
1400 .log_gz_store = o->log_gz_store,
1402 const char *pre = o->lat_log_file ? o->lat_log_file : o->name;
1410 gen_log_name(logname, sizeof(logname), "lat", pre,
1411 td->thread_number, suf, o->per_job_logs);
1412 setup_log(&td->lat_log, &p, logname);
1414 gen_log_name(logname, sizeof(logname), "slat", pre,
1415 td->thread_number, suf, o->per_job_logs);
1416 setup_log(&td->slat_log, &p, logname);
1418 gen_log_name(logname, sizeof(logname), "clat", pre,
1419 td->thread_number, suf, o->per_job_logs);
1420 setup_log(&td->clat_log, &p, logname);
1423 if (o->write_hist_log) {
1424 struct log_params p = {
1426 .avg_msec = o->log_avg_msec,
1427 .hist_msec = o->log_hist_msec,
1428 .hist_coarseness = o->log_hist_coarseness,
1429 .log_type = IO_LOG_TYPE_HIST,
1430 .log_offset = o->log_offset,
1431 .log_gz = o->log_gz,
1432 .log_gz_store = o->log_gz_store,
1434 const char *pre = o->hist_log_file ? o->hist_log_file : o->name;
1438 if (td->client_type) {
1439 log_err("fio: --write_hist_log requires zlib in client/server mode\n");
1449 gen_log_name(logname, sizeof(logname), "clat_hist", pre,
1450 td->thread_number, suf, o->per_job_logs);
1451 setup_log(&td->clat_hist_log, &p, logname);
1454 if (o->write_bw_log) {
1455 struct log_params p = {
1457 .avg_msec = o->log_avg_msec,
1458 .hist_msec = o->log_hist_msec,
1459 .hist_coarseness = o->log_hist_coarseness,
1460 .log_type = IO_LOG_TYPE_BW,
1461 .log_offset = o->log_offset,
1462 .log_gz = o->log_gz,
1463 .log_gz_store = o->log_gz_store,
1465 const char *pre = o->bw_log_file ? o->bw_log_file : o->name;
1468 if (fio_option_is_set(o, bw_avg_time))
1469 p.avg_msec = min(o->log_avg_msec, o->bw_avg_time);
1471 o->bw_avg_time = p.avg_msec;
1473 p.hist_msec = o->log_hist_msec;
1474 p.hist_coarseness = o->log_hist_coarseness;
1481 gen_log_name(logname, sizeof(logname), "bw", pre,
1482 td->thread_number, suf, o->per_job_logs);
1483 setup_log(&td->bw_log, &p, logname);
1485 if (o->write_iops_log) {
1486 struct log_params p = {
1488 .avg_msec = o->log_avg_msec,
1489 .hist_msec = o->log_hist_msec,
1490 .hist_coarseness = o->log_hist_coarseness,
1491 .log_type = IO_LOG_TYPE_IOPS,
1492 .log_offset = o->log_offset,
1493 .log_gz = o->log_gz,
1494 .log_gz_store = o->log_gz_store,
1496 const char *pre = o->iops_log_file ? o->iops_log_file : o->name;
1499 if (fio_option_is_set(o, iops_avg_time))
1500 p.avg_msec = min(o->log_avg_msec, o->iops_avg_time);
1502 o->iops_avg_time = p.avg_msec;
1504 p.hist_msec = o->log_hist_msec;
1505 p.hist_coarseness = o->log_hist_coarseness;
1512 gen_log_name(logname, sizeof(logname), "iops", pre,
1513 td->thread_number, suf, o->per_job_logs);
1514 setup_log(&td->iops_log, &p, logname);
1518 o->name = strdup(jobname);
1520 if (output_format & FIO_OUTPUT_NORMAL) {
1522 if (is_backend && !recursed)
1523 fio_server_send_add_job(td);
1525 if (!td_ioengine_flagged(td, FIO_NOIO)) {
1526 char *c1, *c2, *c3, *c4;
1527 char *c5 = NULL, *c6 = NULL;
1528 int i2p = is_power_of_2(o->kb_base);
1530 c1 = num2str(o->min_bs[DDIR_READ], 4, 1, i2p, N2S_BYTE);
1531 c2 = num2str(o->max_bs[DDIR_READ], 4, 1, i2p, N2S_BYTE);
1532 c3 = num2str(o->min_bs[DDIR_WRITE], 4, 1, i2p, N2S_BYTE);
1533 c4 = num2str(o->max_bs[DDIR_WRITE], 4, 1, i2p, N2S_BYTE);
1535 if (!o->bs_is_seq_rand) {
1536 c5 = num2str(o->min_bs[DDIR_TRIM], 4, 1, i2p, N2S_BYTE);
1537 c6 = num2str(o->max_bs[DDIR_TRIM], 4, 1, i2p, N2S_BYTE);
1540 log_info("%s: (g=%d): rw=%s, ", td->o.name,
1542 ddir_str(o->td_ddir));
1544 if (o->bs_is_seq_rand)
1545 log_info("bs=(R) %s-%s, (W) %s-%s, bs_is_seq_rand, ",
1548 log_info("bs=(R) %s-%s, (W) %s-%s, (T) %s-%s, ",
1549 c1, c2, c3, c4, c5, c6);
1551 log_info("ioengine=%s, iodepth=%u\n",
1552 td->io_ops->name, o->iodepth);
1561 } else if (job_add_num == 1)
1565 if (td_steadystate_init(td))
1569 * recurse add identical jobs, clear numjobs and stonewall options
1570 * as they don't apply to sub-jobs
1572 numjobs = o->numjobs;
1574 struct thread_data *td_new = get_new_job(false, td, true, jobname);
1579 td_new->o.numjobs = 1;
1580 td_new->o.stonewall = 0;
1581 td_new->o.new_group = 0;
1582 td_new->subjob_number = numjobs;
1583 td_new->o.ss_dur = o->ss_dur * 1000000l;
1584 td_new->o.ss_limit = o->ss_limit;
1587 if (td_new->files) {
1589 for_each_file(td_new, f, i) {
1591 sfree(f->file_name);
1594 free(td_new->files);
1595 td_new->files = NULL;
1597 td_new->files_index = 0;
1598 td_new->files_size = 0;
1599 if (td_new->o.filename) {
1600 free(td_new->o.filename);
1601 td_new->o.filename = NULL;
1605 if (add_job(td_new, jobname, numjobs, 1, client_type))
1616 * Parse as if 'o' was a command line
1618 void add_job_opts(const char **o, int client_type)
1620 struct thread_data *td, *td_parent;
1621 int i, in_global = 1;
1625 td_parent = td = NULL;
1627 if (!strncmp(o[i], "name", 4)) {
1630 add_job(td, jobname, 0, 0, client_type);
1632 sprintf(jobname, "%s", o[i] + 5);
1634 if (in_global && !td_parent)
1635 td_parent = get_new_job(true, &def_thread, false, jobname);
1636 else if (!in_global && !td) {
1638 td_parent = &def_thread;
1639 td = get_new_job(false, td_parent, false, jobname);
1642 fio_options_parse(td_parent, (char **) &o[i], 1);
1644 fio_options_parse(td, (char **) &o[i], 1);
1649 add_job(td, jobname, 0, 0, client_type);
1652 static int skip_this_section(const char *name)
1656 if (!nr_job_sections)
1658 if (!strncmp(name, "global", 6))
1661 for (i = 0; i < nr_job_sections; i++)
1662 if (!strcmp(job_sections[i], name))
1668 static int is_empty_or_comment(char *line)
1672 for (i = 0; i < strlen(line); i++) {
1677 if (!isspace((int) line[i]) && !iscntrl((int) line[i]))
1685 * This is our [ini] type file parser.
1687 static int __parse_jobs_ini(struct thread_data *td,
1688 char *file, int is_buf, int stonewall_flag, int type,
1689 int nested, char *name, char ***popts, int *aopts, int *nopts)
1691 bool global = false;
1695 int ret = 0, stonewall;
1698 int inside_skip = 0;
1700 int i, alloc_opts, num_opts;
1702 dprint(FD_PARSE, "Parsing ini file %s\n", file);
1703 assert(td || !nested);
1708 if (!strcmp(file, "-"))
1711 f = fopen(file, "r");
1716 log_err("fio: unable to open '%s' job file\n", file);
1718 td_verror(td, __err, "job file open");
1723 string = malloc(4096);
1726 * it's really 256 + small bit, 280 should suffice
1730 memset(name, 0, 280);
1734 if (nested && popts) {
1736 alloc_opts = *aopts;
1742 opts = malloc(sizeof(char *) * alloc_opts);
1746 stonewall = stonewall_flag;
1749 * if skip_fgets is set, we already have loaded a line we
1754 p = strsep(&file, "\n");
1756 p = fgets(string, 4096, f);
1762 strip_blank_front(&p);
1765 dprint(FD_PARSE, "%s\n", p);
1766 if (is_empty_or_comment(p))
1770 if (sscanf(p, "[%255[^\n]]", name) != 1) {
1774 log_err("fio: option <%s> outside of "
1775 "[] job section\n", p);
1780 name[strlen(name) - 1] = '\0';
1782 if (skip_this_section(name)) {
1788 dprint(FD_PARSE, "Parsing section [%s]\n", name);
1790 global = !strncmp(name, "global", 6);
1796 log_info("--name=%s ", name);
1800 td = get_new_job(global, &def_thread, false, name);
1807 * Separate multiple job files by a stonewall
1809 if (!global && stonewall) {
1810 td->o.stonewall = stonewall;
1815 memset(opts, 0, alloc_opts * sizeof(char *));
1823 p = strsep(&file, "\n");
1825 p = fgets(string, 4096, f);
1828 dprint(FD_PARSE, "%s", p);
1833 if (is_empty_or_comment(p))
1836 strip_blank_front(&p);
1839 * new section, break out and make sure we don't
1840 * fgets() a new line at the top.
1844 log_err("No new sections in included files\n");
1854 if (!strncmp(p, "include", strlen("include"))) {
1855 char *filename = p + strlen("include") + 1,
1856 *ts, *full_fn = NULL;
1859 * Allow for the include filename
1860 * specification to be relative.
1862 if (access(filename, F_OK) &&
1863 (ts = strrchr(file, '/'))) {
1864 int len = ts - file +
1865 strlen(filename) + 2;
1867 if (!(full_fn = calloc(1, len))) {
1873 file, (ts - file) + 1);
1874 strncpy(full_fn + (ts - file) + 1,
1875 filename, strlen(filename));
1876 full_fn[len - 1] = 0;
1880 ret = __parse_jobs_ini(td, filename, is_buf,
1881 stonewall_flag, type, 1,
1883 &alloc_opts, &num_opts);
1886 log_err("Error %d while parsing "
1887 "include file %s\n",
1900 if (num_opts == alloc_opts) {
1902 opts = realloc(opts,
1903 alloc_opts * sizeof(char *));
1906 opts[num_opts] = strdup(p);
1912 *aopts = alloc_opts;
1917 ret = fio_options_parse(td, opts, num_opts);
1922 ret = add_job(td, name, 0, 0, type);
1924 log_err("fio: job %s dropped\n", name);
1928 for (i = 0; i < num_opts; i++)
1937 while (i < nr_job_sections) {
1938 free(job_sections[i]);
1947 if (!is_buf && f != stdin)
1952 int parse_jobs_ini(char *file, int is_buf, int stonewall_flag, int type)
1954 return __parse_jobs_ini(NULL, file, is_buf, stonewall_flag, type,
1955 0, NULL, NULL, NULL, NULL);
1958 static int fill_def_thread(void)
1960 memset(&def_thread, 0, sizeof(def_thread));
1961 INIT_FLIST_HEAD(&def_thread.opt_list);
1963 fio_getaffinity(getpid(), &def_thread.o.cpumask);
1964 def_thread.o.error_dump = 1;
1967 * fill default options
1969 fio_fill_default_options(&def_thread);
1973 static void show_debug_categories(void)
1975 #ifdef FIO_INC_DEBUG
1976 struct debug_level *dl = &debug_levels[0];
1977 int curlen, first = 1;
1981 int has_next = (dl + 1)->name != NULL;
1983 if (first || curlen + strlen(dl->name) >= 80) {
1988 curlen += printf("\t\t\t%s", dl->name);
1989 curlen += 3 * (8 - 1);
1991 curlen += printf(",");
1993 curlen += printf("%s", dl->name);
1995 curlen += printf(",");
2005 * Following options aren't printed by usage().
2006 * --append-terse - Equivalent to --output-format=terse, see f6a7df53.
2007 * --latency-log - Deprecated option.
2009 static void usage(const char *name)
2011 printf("%s\n", fio_version_string);
2012 printf("%s [options] [job options] <job file(s)>\n", name);
2013 printf(" --debug=options\tEnable debug logging. May be one/more of:\n");
2014 show_debug_categories();
2015 printf(" --parse-only\t\tParse options only, don't start any IO\n");
2016 printf(" --output\t\tWrite output to file\n");
2017 printf(" --bandwidth-log\tGenerate aggregate bandwidth logs\n");
2018 printf(" --minimal\t\tMinimal (terse) output\n");
2019 printf(" --output-format=type\tOutput format (terse,json,json+,normal)\n");
2020 printf(" --terse-version=type\tSet terse version output format"
2021 " (default 3, or 2 or 4)\n");
2022 printf(" --version\t\tPrint version info and exit\n");
2023 printf(" --help\t\tPrint this page\n");
2024 printf(" --cpuclock-test\tPerform test/validation of CPU clock\n");
2025 printf(" --crctest=[type]\tTest speed of checksum functions\n");
2026 printf(" --cmdhelp=cmd\t\tPrint command help, \"all\" for all of"
2028 printf(" --enghelp=engine\tPrint ioengine help, or list"
2029 " available ioengines\n");
2030 printf(" --enghelp=engine,cmd\tPrint help for an ioengine"
2032 printf(" --showcmd\t\tTurn a job file into command line options\n");
2033 printf(" --eta=when\t\tWhen ETA estimate should be printed\n");
2034 printf(" \t\tMay be \"always\", \"never\" or \"auto\"\n");
2035 printf(" --eta-newline=time\tForce a new line for every 'time'");
2036 printf(" period passed\n");
2037 printf(" --status-interval=t\tForce full status dump every");
2038 printf(" 't' period passed\n");
2039 printf(" --readonly\t\tTurn on safety read-only checks, preventing"
2041 printf(" --section=name\tOnly run specified section in job file,"
2042 " multiple sections can be specified\n");
2043 printf(" --alloc-size=kb\tSet smalloc pool to this size in kb"
2045 printf(" --warnings-fatal\tFio parser warnings are fatal\n");
2046 printf(" --max-jobs=nr\t\tMaximum number of threads/processes to support\n");
2047 printf(" --server=args\t\tStart a backend fio server\n");
2048 printf(" --daemonize=pidfile\tBackground fio server, write pid to file\n");
2049 printf(" --client=hostname\tTalk to remote backend(s) fio server at hostname\n");
2050 printf(" --remote-config=file\tTell fio server to load this local job file\n");
2051 printf(" --idle-prof=option\tReport cpu idleness on a system or percpu basis\n"
2052 "\t\t\t(option=system,percpu) or run unit work\n"
2053 "\t\t\tcalibration only (option=calibrate)\n");
2055 printf(" --inflate-log=log\tInflate and output compressed log\n");
2057 printf(" --trigger-file=file\tExecute trigger cmd when file exists\n");
2058 printf(" --trigger-timeout=t\tExecute trigger af this time\n");
2059 printf(" --trigger=cmd\t\tSet this command as local trigger\n");
2060 printf(" --trigger-remote=cmd\tSet this command as remote trigger\n");
2061 printf(" --aux-path=path\tUse this path for fio state generated files\n");
2062 printf("\nFio was written by Jens Axboe <jens.axboe@oracle.com>");
2063 printf("\n Jens Axboe <jaxboe@fusionio.com>");
2064 printf("\n Jens Axboe <axboe@fb.com>\n");
2067 #ifdef FIO_INC_DEBUG
2068 struct debug_level debug_levels[] = {
2069 { .name = "process",
2070 .help = "Process creation/exit logging",
2071 .shift = FD_PROCESS,
2074 .help = "File related action logging",
2078 .help = "IO and IO engine action logging (offsets, queue, completions, etc)",
2082 .help = "Memory allocation/freeing logging",
2085 { .name = "blktrace",
2086 .help = "blktrace action logging",
2087 .shift = FD_BLKTRACE,
2090 .help = "IO verification action logging",
2094 .help = "Random generation logging",
2098 .help = "Parser logging",
2101 { .name = "diskutil",
2102 .help = "Disk utility logging actions",
2103 .shift = FD_DISKUTIL,
2106 .help = "Logging related to creating/destroying jobs",
2110 .help = "Mutex logging",
2113 { .name = "profile",
2114 .help = "Logging related to profiles",
2115 .shift = FD_PROFILE,
2118 .help = "Logging related to time keeping functions",
2122 .help = "Network logging",
2126 .help = "Rate logging",
2129 { .name = "compress",
2130 .help = "Log compression logging",
2131 .shift = FD_COMPRESS,
2133 { .name = "steadystate",
2134 .help = "Steady state detection logging",
2135 .shift = FD_STEADYSTATE,
2137 { .name = "helperthread",
2138 .help = "Helper thread logging",
2139 .shift = FD_HELPERTHREAD,
2144 static int set_debug(const char *string)
2146 struct debug_level *dl;
2147 char *p = (char *) string;
2154 if (!strcmp(string, "?") || !strcmp(string, "help")) {
2155 log_info("fio: dumping debug options:");
2156 for (i = 0; debug_levels[i].name; i++) {
2157 dl = &debug_levels[i];
2158 log_info("%s,", dl->name);
2164 while ((opt = strsep(&p, ",")) != NULL) {
2167 if (!strncmp(opt, "all", 3)) {
2168 log_info("fio: set all debug options\n");
2173 for (i = 0; debug_levels[i].name; i++) {
2174 dl = &debug_levels[i];
2175 found = !strncmp(opt, dl->name, strlen(dl->name));
2179 if (dl->shift == FD_JOB) {
2180 opt = strchr(opt, ':');
2182 log_err("fio: missing job number\n");
2186 fio_debug_jobno = atoi(opt);
2187 log_info("fio: set debug jobno %d\n",
2190 log_info("fio: set debug option %s\n", opt);
2191 fio_debug |= (1UL << dl->shift);
2197 log_err("fio: debug mask %s not found\n", opt);
2202 static int set_debug(const char *string)
2204 log_err("fio: debug tracing not included in build\n");
2209 static void fio_options_fill_optstring(void)
2211 char *ostr = cmd_optstr;
2215 while (l_opts[i].name) {
2216 ostr[c++] = l_opts[i].val;
2217 if (l_opts[i].has_arg == required_argument)
2219 else if (l_opts[i].has_arg == optional_argument) {
2228 static int client_flag_set(char c)
2233 while (l_opts[i].name) {
2234 int val = l_opts[i].val;
2236 if (c == (val & 0xff))
2237 return (val & FIO_CLIENT_FLAG);
2245 static void parse_cmd_client(void *client, char *opt)
2247 fio_client_add_cmd_option(client, opt);
2250 static void show_closest_option(const char *name)
2252 int best_option, best_distance;
2255 while (*name == '-')
2259 best_distance = INT_MAX;
2261 while (l_opts[i].name) {
2262 distance = string_distance(name, l_opts[i].name);
2263 if (distance < best_distance) {
2264 best_distance = distance;
2270 if (best_option != -1 && string_distance_ok(name, best_distance))
2271 log_err("Did you mean %s?\n", l_opts[best_option].name);
2274 static int parse_output_format(const char *optarg)
2276 char *p, *orig, *opt;
2279 p = orig = strdup(optarg);
2283 while ((opt = strsep(&p, ",")) != NULL) {
2284 if (!strcmp(opt, "minimal") ||
2285 !strcmp(opt, "terse") ||
2286 !strcmp(opt, "csv"))
2287 output_format |= FIO_OUTPUT_TERSE;
2288 else if (!strcmp(opt, "json"))
2289 output_format |= FIO_OUTPUT_JSON;
2290 else if (!strcmp(opt, "json+"))
2291 output_format |= (FIO_OUTPUT_JSON | FIO_OUTPUT_JSON_PLUS);
2292 else if (!strcmp(opt, "normal"))
2293 output_format |= FIO_OUTPUT_NORMAL;
2295 log_err("fio: invalid output format %s\n", opt);
2305 int parse_cmd_line(int argc, char *argv[], int client_type)
2307 struct thread_data *td = NULL;
2308 int c, ini_idx = 0, lidx, ret = 0, do_exit = 0, exit_val = 0;
2309 char *ostr = cmd_optstr;
2310 char *pid_file = NULL;
2311 void *cur_client = NULL;
2315 * Reset optind handling, since we may call this multiple times
2320 while ((c = getopt_long_only(argc, argv, ostr, l_opts, &lidx)) != -1) {
2321 if ((c & FIO_CLIENT_FLAG) || client_flag_set(c)) {
2322 parse_cmd_client(cur_client, argv[optind - 1]);
2323 c &= ~FIO_CLIENT_FLAG;
2328 smalloc_pool_size = atoi(optarg);
2329 smalloc_pool_size <<= 10;
2333 log_err("fio: --latency-log is deprecated. Use per-job latency log options.\n");
2343 if (f_out && f_out != stdout)
2346 tmp = fopen(optarg, "w+");
2348 log_err("fio: output file open error: %s\n", strerror(errno));
2353 f_err = f_out = tmp;
2357 output_format = FIO_OUTPUT_TERSE;
2360 if (parse_output_format(optarg)) {
2361 log_err("fio: failed parsing output-format\n");
2368 output_format |= FIO_OUTPUT_TERSE;
2380 fio_show_option_help(optarg);
2387 fio_show_ioengine_help(optarg);
2401 log_info("%s\n", fio_version_string);
2406 terse_version = atoi(optarg);
2407 if (!(terse_version >= 2 && terse_version <= 5)) {
2408 log_err("fio: bad terse version format\n");
2414 if (!strcmp("always", optarg))
2415 eta_print = FIO_ETA_ALWAYS;
2416 else if (!strcmp("never", optarg))
2417 eta_print = FIO_ETA_NEVER;
2422 if (check_str_time(optarg, &t, 1)) {
2423 log_err("fio: failed parsing eta time %s\n", optarg);
2427 eta_new_line = t / 1000;
2431 if (set_debug(optarg))
2441 if (!strcmp(optarg, "global")) {
2442 log_err("fio: can't use global as only "
2448 new_size = (nr_job_sections + 1) * sizeof(char *);
2449 job_sections = realloc(job_sections, new_size);
2450 job_sections[nr_job_sections] = strdup(optarg);
2456 exit_val = iolog_file_inflate(optarg);
2465 exec_profile = strdup(optarg);
2467 case FIO_GETOPT_JOB: {
2468 const char *opt = l_opts[lidx].name;
2471 if (!strncmp(opt, "name", 4) && td) {
2472 ret = add_job(td, td->o.name ?: "fio", 0, 0, client_type);
2479 int is_section = !strncmp(opt, "name", 4);
2482 if (!is_section || !strncmp(val, "global", 6))
2485 if (is_section && skip_this_section(val))
2488 td = get_new_job(global, &def_thread, true, NULL);
2489 if (!td || ioengine_load(td)) {
2498 fio_options_set_ioengine_opts(l_opts, td);
2501 if ((!val || !strlen(val)) &&
2502 l_opts[lidx].has_arg == required_argument) {
2503 log_err("fio: option %s requires an argument\n", opt);
2506 ret = fio_cmd_option_parse(td, opt, val);
2517 if (!ret && !strcmp(opt, "ioengine")) {
2519 if (ioengine_load(td)) {
2526 fio_options_set_ioengine_opts(l_opts, td);
2530 case FIO_GETOPT_IOENGINE: {
2531 const char *opt = l_opts[lidx].name;
2537 ret = fio_cmd_ioengine_option_parse(td, opt, val);
2544 max_jobs = atoi(optarg);
2545 if (!max_jobs || max_jobs > REAL_MAX_JOBS) {
2546 log_err("fio: invalid max jobs: %d\n", max_jobs);
2553 #ifndef CONFIG_NO_SHM
2555 log_err("fio: can't be both client and server\n");
2561 fio_server_set_arg(optarg);
2565 log_err("fio: client/server requires SHM support\n");
2573 pid_file = strdup(optarg);
2576 if ((ret = fio_idle_prof_parse_opt(optarg))) {
2577 /* exit on error and calibration only */
2587 log_err("fio: can't be both client and server\n");
2592 /* if --client parameter contains a pathname */
2593 if (0 == access(optarg, R_OK)) {
2594 /* file contains a list of host addrs or names */
2595 char hostaddr[PATH_MAX] = {0};
2597 FILE * hostf = fopen(optarg, "r");
2599 log_err("fio: could not open client list file %s for read\n", optarg);
2604 sprintf(formatstr, "%%%ds", PATH_MAX - 1);
2606 * read at most PATH_MAX-1 chars from each
2607 * record in this file
2609 while (fscanf(hostf, formatstr, hostaddr) == 1) {
2610 /* expect EVERY host in file to be valid */
2611 if (fio_client_add(&fio_client_ops, hostaddr, &cur_client)) {
2612 log_err("fio: failed adding client %s from file %s\n", hostaddr, optarg);
2619 break; /* no possibility of job file for "this client only" */
2621 if (fio_client_add(&fio_client_ops, optarg, &cur_client)) {
2622 log_err("fio: failed adding client %s\n", optarg);
2628 * If the next argument exists and isn't an option,
2629 * assume it's a job file for this client only.
2631 while (optind < argc) {
2632 if (!strncmp(argv[optind], "--", 2) ||
2633 !strncmp(argv[optind], "-", 1))
2636 if (fio_client_add_ini_file(cur_client, argv[optind], false))
2643 if (fio_client_add_ini_file(cur_client, optarg, true)) {
2651 exit_val = fio_monotonic_clocktest(1);
2656 exit_val = fio_crctest(optarg);
2661 if (check_str_time(optarg, &val, 1)) {
2662 log_err("fio: failed parsing time %s\n", optarg);
2667 status_interval = val / 1000;
2673 trigger_file = strdup(optarg);
2678 trigger_cmd = strdup(optarg);
2681 if (trigger_remote_cmd)
2682 free(trigger_remote_cmd);
2683 trigger_remote_cmd = strdup(optarg);
2688 aux_path = strdup(optarg);
2691 if (check_str_time(optarg, &trigger_timeout, 1)) {
2692 log_err("fio: failed parsing time %s\n", optarg);
2696 trigger_timeout /= 1000000;
2699 log_err("%s: unrecognized option '%s'\n", argv[0],
2701 show_closest_option(argv[optind - 1]);
2711 if (do_exit && !(is_backend || nr_clients))
2714 if (nr_clients && fio_clients_connect())
2717 if (is_backend && backend)
2718 return fio_start_server(pid_file);
2724 ret = add_job(td, td->o.name ?: "fio", 0, 0, client_type);
2730 while (!ret && optind < argc) {
2732 ini_file = realloc(ini_file, ini_idx * sizeof(char *));
2733 ini_file[ini_idx - 1] = strdup(argv[optind]);
2741 int fio_init_options(void)
2746 fio_options_fill_optstring();
2747 fio_options_dup_and_init(l_opts);
2751 if (fill_def_thread())
2757 extern int fio_check_options(struct thread_options *);
2759 int parse_options(int argc, char *argv[])
2761 const int type = FIO_CLIENT_TYPE_CLI;
2764 if (fio_init_options())
2766 if (fio_test_cconv(&def_thread.o))
2767 log_err("fio: failed internal cconv test\n");
2769 job_files = parse_cmd_line(argc, argv, type);
2771 if (job_files > 0) {
2772 for (i = 0; i < job_files; i++) {
2773 if (i && fill_def_thread())
2776 if (fio_clients_send_ini(ini_file[i]))
2779 } else if (!is_backend) {
2780 if (parse_jobs_ini(ini_file[i], 0, i, type))
2785 } else if (nr_clients) {
2786 if (fill_def_thread())
2788 if (fio_clients_send_ini(NULL))
2793 fio_options_free(&def_thread);
2794 filesetup_mem_free();
2796 if (!thread_number) {
2801 if (is_backend || nr_clients)
2806 log_err("No job(s) defined\n\n");
2816 if (output_format & FIO_OUTPUT_NORMAL)
2817 log_info("%s\n", fio_version_string);
2822 void options_default_fill(struct thread_options *o)
2824 memcpy(o, &def_thread.o, sizeof(*o));
2827 struct thread_data *get_global_options(void)