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"
35 const char fio_version_string[] = FIO_VERSION;
37 #define FIO_RANDSEED (0xb1899bedUL)
39 static char **ini_file;
40 static int max_jobs = FIO_MAX_JOBS;
41 static int dump_cmdline;
42 static long long def_timeout;
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 *) "timeout",
97 .has_arg = required_argument,
98 .val = 't' | FIO_CLIENT_FLAG,
101 .name = (char *) "latency-log",
102 .has_arg = required_argument,
103 .val = 'l' | FIO_CLIENT_FLAG,
106 .name = (char *) "bandwidth-log",
107 .has_arg = no_argument,
108 .val = 'b' | FIO_CLIENT_FLAG,
111 .name = (char *) "minimal",
112 .has_arg = no_argument,
113 .val = 'm' | FIO_CLIENT_FLAG,
116 .name = (char *) "output-format",
117 .has_arg = required_argument,
118 .val = 'F' | FIO_CLIENT_FLAG,
121 .name = (char *) "append-terse",
122 .has_arg = optional_argument,
126 .name = (char *) "version",
127 .has_arg = no_argument,
128 .val = 'v' | FIO_CLIENT_FLAG,
131 .name = (char *) "help",
132 .has_arg = no_argument,
133 .val = 'h' | FIO_CLIENT_FLAG,
136 .name = (char *) "cmdhelp",
137 .has_arg = optional_argument,
138 .val = 'c' | FIO_CLIENT_FLAG,
141 .name = (char *) "enghelp",
142 .has_arg = optional_argument,
143 .val = 'i' | FIO_CLIENT_FLAG,
146 .name = (char *) "showcmd",
147 .has_arg = no_argument,
148 .val = 's' | FIO_CLIENT_FLAG,
151 .name = (char *) "readonly",
152 .has_arg = no_argument,
153 .val = 'r' | FIO_CLIENT_FLAG,
156 .name = (char *) "eta",
157 .has_arg = required_argument,
158 .val = 'e' | FIO_CLIENT_FLAG,
161 .name = (char *) "eta-newline",
162 .has_arg = required_argument,
163 .val = 'E' | FIO_CLIENT_FLAG,
166 .name = (char *) "debug",
167 .has_arg = required_argument,
168 .val = 'd' | FIO_CLIENT_FLAG,
171 .name = (char *) "parse-only",
172 .has_arg = no_argument,
173 .val = 'P' | FIO_CLIENT_FLAG,
176 .name = (char *) "section",
177 .has_arg = required_argument,
178 .val = 'x' | FIO_CLIENT_FLAG,
182 .name = (char *) "inflate-log",
183 .has_arg = required_argument,
184 .val = 'X' | FIO_CLIENT_FLAG,
188 .name = (char *) "alloc-size",
189 .has_arg = required_argument,
190 .val = 'a' | FIO_CLIENT_FLAG,
193 .name = (char *) "profile",
194 .has_arg = required_argument,
195 .val = 'p' | FIO_CLIENT_FLAG,
198 .name = (char *) "warnings-fatal",
199 .has_arg = no_argument,
200 .val = 'w' | FIO_CLIENT_FLAG,
203 .name = (char *) "max-jobs",
204 .has_arg = required_argument,
205 .val = 'j' | FIO_CLIENT_FLAG,
208 .name = (char *) "terse-version",
209 .has_arg = required_argument,
210 .val = 'V' | FIO_CLIENT_FLAG,
213 .name = (char *) "server",
214 .has_arg = optional_argument,
217 { .name = (char *) "daemonize",
218 .has_arg = required_argument,
222 .name = (char *) "client",
223 .has_arg = required_argument,
227 .name = (char *) "remote-config",
228 .has_arg = required_argument,
232 .name = (char *) "cpuclock-test",
233 .has_arg = no_argument,
237 .name = (char *) "crctest",
238 .has_arg = optional_argument,
242 .name = (char *) "idle-prof",
243 .has_arg = required_argument,
247 .name = (char *) "status-interval",
248 .has_arg = required_argument,
252 .name = (char *) "trigger-file",
253 .has_arg = required_argument,
257 .name = (char *) "trigger-timeout",
258 .has_arg = required_argument,
262 .name = (char *) "trigger",
263 .has_arg = required_argument,
267 .name = (char *) "trigger-remote",
268 .has_arg = required_argument,
272 .name = (char *) "aux-path",
273 .has_arg = required_argument,
281 void free_threads_shm(void)
285 #ifndef CONFIG_NO_SHM
286 struct shmid_ds sbuf;
290 shmctl(shm_id, IPC_RMID, &sbuf);
299 static void free_shm(void)
303 fio_debug_jobp = NULL;
309 free(trigger_remote_cmd);
310 trigger_file = trigger_cmd = trigger_remote_cmd = NULL;
312 options_free(fio_options, &def_thread.o);
319 * The thread area is shared between the main process and the job
320 * threads/processes. So setup a shared memory segment that will hold
321 * all the job info. We use the end of the region for keeping track of
322 * open files across jobs, for file sharing.
324 static int setup_thread_area(void)
330 * 1024 is too much on some machines, scale max_jobs if
331 * we get a failure that looks like too large a shm segment
334 size_t size = max_jobs * sizeof(struct thread_data);
336 size += sizeof(unsigned int);
338 #ifndef CONFIG_NO_SHM
339 shm_id = shmget(0, size, IPC_CREAT | 0600);
342 if (errno != EINVAL && errno != ENOMEM && errno != ENOSPC) {
347 threads = malloc(size);
355 #ifndef CONFIG_NO_SHM
359 threads = shmat(shm_id, NULL, 0);
360 if (threads == (void *) -1) {
366 memset(threads, 0, max_jobs * sizeof(struct thread_data));
367 fio_debug_jobp = (void *) threads + max_jobs * sizeof(struct thread_data);
368 *fio_debug_jobp = -1;
375 static void set_cmd_options(struct thread_data *td)
377 struct thread_options *o = &td->o;
380 o->timeout = def_timeout;
383 static void dump_print_option(struct print_option *p)
387 if (!strcmp("description", p->name))
392 log_info("--%s%s", p->name, p->value ? "" : " ");
394 log_info("=%s%s%s ", delim, p->value, delim);
397 static void dump_opt_list(struct thread_data *td)
399 struct flist_head *entry;
400 struct print_option *p;
402 if (flist_empty(&td->opt_list))
405 flist_for_each(entry, &td->opt_list) {
406 p = flist_entry(entry, struct print_option, list);
407 dump_print_option(p);
411 static void fio_dump_options_free(struct thread_data *td)
413 while (!flist_empty(&td->opt_list)) {
414 struct print_option *p;
416 p = flist_first_entry(&td->opt_list, struct print_option, list);
417 flist_del_init(&p->list);
424 static void copy_opt_list(struct thread_data *dst, struct thread_data *src)
426 struct flist_head *entry;
428 if (flist_empty(&src->opt_list))
431 flist_for_each(entry, &src->opt_list) {
432 struct print_option *srcp, *dstp;
434 srcp = flist_entry(entry, struct print_option, list);
435 dstp = malloc(sizeof(*dstp));
436 dstp->name = strdup(srcp->name);
438 dstp->value = strdup(srcp->value);
441 flist_add_tail(&dstp->list, &dst->opt_list);
446 * Return a free job structure.
448 static struct thread_data *get_new_job(int global, struct thread_data *parent,
449 int preserve_eo, const char *jobname)
451 struct thread_data *td;
454 set_cmd_options(&def_thread);
457 if (setup_thread_area()) {
458 log_err("error: failed to setup shm segment\n");
461 if (thread_number >= max_jobs) {
462 log_err("error: maximum number of jobs (%d) reached.\n",
467 td = &threads[thread_number++];
470 INIT_FLIST_HEAD(&td->opt_list);
471 if (parent != &def_thread)
472 copy_opt_list(td, parent);
478 td->o.uid = td->o.gid = -1U;
480 dup_files(td, parent);
481 fio_options_mem_dupe(td);
483 profile_add_hooks(td);
485 td->thread_number = thread_number;
486 td->subjob_number = 0;
489 td->o.name = strdup(jobname);
491 if (!parent->o.group_reporting || parent == &def_thread)
498 static void put_job(struct thread_data *td)
500 if (td == &def_thread)
507 log_info("fio: %s\n", td->verror);
509 fio_options_free(td);
510 fio_dump_options_free(td);
517 memset(&threads[td->thread_number - 1], 0, sizeof(*td));
521 static int __setup_rate(struct thread_data *td, enum fio_ddir ddir)
523 unsigned int bs = td->o.min_bs[ddir];
525 assert(ddir_rw(ddir));
527 if (td->o.rate[ddir])
528 td->rate_bps[ddir] = td->o.rate[ddir];
530 td->rate_bps[ddir] = (uint64_t) td->o.rate_iops[ddir] * bs;
532 if (!td->rate_bps[ddir]) {
533 log_err("rate lower than supported\n");
537 td->rate_next_io_time[ddir] = 0;
538 td->rate_io_issue_bytes[ddir] = 0;
543 static int setup_rate(struct thread_data *td)
547 if (td->o.rate[DDIR_READ] || td->o.rate_iops[DDIR_READ])
548 ret = __setup_rate(td, DDIR_READ);
549 if (td->o.rate[DDIR_WRITE] || td->o.rate_iops[DDIR_WRITE])
550 ret |= __setup_rate(td, DDIR_WRITE);
551 if (td->o.rate[DDIR_TRIM] || td->o.rate_iops[DDIR_TRIM])
552 ret |= __setup_rate(td, DDIR_TRIM);
557 static int fixed_block_size(struct thread_options *o)
559 return o->min_bs[DDIR_READ] == o->max_bs[DDIR_READ] &&
560 o->min_bs[DDIR_WRITE] == o->max_bs[DDIR_WRITE] &&
561 o->min_bs[DDIR_TRIM] == o->max_bs[DDIR_TRIM] &&
562 o->min_bs[DDIR_READ] == o->min_bs[DDIR_WRITE] &&
563 o->min_bs[DDIR_READ] == o->min_bs[DDIR_TRIM];
567 static unsigned long long get_rand_start_delay(struct thread_data *td)
569 unsigned long long delayrange;
573 delayrange = td->o.start_delay_high - td->o.start_delay;
575 frand_max = rand_max(&td->delay_state);
576 r = __rand(&td->delay_state);
577 delayrange = (unsigned long long) ((double) delayrange * (r / (frand_max + 1.0)));
579 delayrange += td->o.start_delay;
584 * Lazy way of fixing up options that depend on each other. We could also
585 * define option callback handlers, but this is easier.
587 static int fixup_options(struct thread_data *td)
589 struct thread_options *o = &td->o;
592 #ifndef FIO_HAVE_PSHARED_MUTEX
593 if (!o->use_thread) {
594 log_info("fio: this platform does not support process shared"
595 " mutexes, forcing use of threads. Use the 'thread'"
596 " option to get rid of this warning.\n");
598 ret = warnings_fatal;
602 if (o->write_iolog_file && o->read_iolog_file) {
603 log_err("fio: read iolog overrides write_iolog\n");
604 free(o->write_iolog_file);
605 o->write_iolog_file = NULL;
606 ret = warnings_fatal;
610 * only really works with 1 file
612 if (o->zone_size && o->open_files > 1)
616 * If zone_range isn't specified, backward compatibility dictates it
617 * should be made equal to zone_size.
619 if (o->zone_size && !o->zone_range)
620 o->zone_range = o->zone_size;
623 * Reads can do overwrites, we always need to pre-create the file
625 if (td_read(td) || td_rw(td))
628 if (!o->min_bs[DDIR_READ])
629 o->min_bs[DDIR_READ] = o->bs[DDIR_READ];
630 if (!o->max_bs[DDIR_READ])
631 o->max_bs[DDIR_READ] = o->bs[DDIR_READ];
632 if (!o->min_bs[DDIR_WRITE])
633 o->min_bs[DDIR_WRITE] = o->bs[DDIR_WRITE];
634 if (!o->max_bs[DDIR_WRITE])
635 o->max_bs[DDIR_WRITE] = o->bs[DDIR_WRITE];
636 if (!o->min_bs[DDIR_TRIM])
637 o->min_bs[DDIR_TRIM] = o->bs[DDIR_TRIM];
638 if (!o->max_bs[DDIR_TRIM])
639 o->max_bs[DDIR_TRIM] = o->bs[DDIR_TRIM];
641 o->rw_min_bs = min(o->min_bs[DDIR_READ], o->min_bs[DDIR_WRITE]);
642 o->rw_min_bs = min(o->min_bs[DDIR_TRIM], o->rw_min_bs);
645 * For random IO, allow blockalign offset other than min_bs.
647 if (!o->ba[DDIR_READ] || !td_random(td))
648 o->ba[DDIR_READ] = o->min_bs[DDIR_READ];
649 if (!o->ba[DDIR_WRITE] || !td_random(td))
650 o->ba[DDIR_WRITE] = o->min_bs[DDIR_WRITE];
651 if (!o->ba[DDIR_TRIM] || !td_random(td))
652 o->ba[DDIR_TRIM] = o->min_bs[DDIR_TRIM];
654 if ((o->ba[DDIR_READ] != o->min_bs[DDIR_READ] ||
655 o->ba[DDIR_WRITE] != o->min_bs[DDIR_WRITE] ||
656 o->ba[DDIR_TRIM] != o->min_bs[DDIR_TRIM]) &&
658 log_err("fio: Any use of blockalign= turns off randommap\n");
660 ret = warnings_fatal;
663 if (!o->file_size_high)
664 o->file_size_high = o->file_size_low;
666 if (o->start_delay_high)
667 o->start_delay = get_rand_start_delay(td);
669 if (o->norandommap && o->verify != VERIFY_NONE
670 && !fixed_block_size(o)) {
671 log_err("fio: norandommap given for variable block sizes, "
673 ret = warnings_fatal;
675 if (o->bs_unaligned && (o->odirect || td_ioengine_flagged(td, FIO_RAWIO)))
676 log_err("fio: bs_unaligned may not work with raw io\n");
679 * thinktime_spin must be less than thinktime
681 if (o->thinktime_spin > o->thinktime)
682 o->thinktime_spin = o->thinktime;
685 * The low water mark cannot be bigger than the iodepth
687 if (o->iodepth_low > o->iodepth || !o->iodepth_low)
688 o->iodepth_low = o->iodepth;
691 * If batch number isn't set, default to the same as iodepth
693 if (o->iodepth_batch > o->iodepth || !o->iodepth_batch)
694 o->iodepth_batch = o->iodepth;
697 * If max batch complete number isn't set or set incorrectly,
698 * default to the same as iodepth_batch_complete_min
700 if (o->iodepth_batch_complete_min > o->iodepth_batch_complete_max)
701 o->iodepth_batch_complete_max = o->iodepth_batch_complete_min;
703 if (o->nr_files > td->files_index)
704 o->nr_files = td->files_index;
706 if (o->open_files > o->nr_files || !o->open_files)
707 o->open_files = o->nr_files;
709 if (((o->rate[DDIR_READ] + o->rate[DDIR_WRITE] + o->rate[DDIR_TRIM]) &&
710 (o->rate_iops[DDIR_READ] + o->rate_iops[DDIR_WRITE] + o->rate_iops[DDIR_TRIM])) ||
711 ((o->ratemin[DDIR_READ] + o->ratemin[DDIR_WRITE] + o->ratemin[DDIR_TRIM]) &&
712 (o->rate_iops_min[DDIR_READ] + o->rate_iops_min[DDIR_WRITE] + o->rate_iops_min[DDIR_TRIM]))) {
713 log_err("fio: rate and rate_iops are mutually exclusive\n");
716 if ((o->rate[DDIR_READ] && (o->rate[DDIR_READ] < o->ratemin[DDIR_READ])) ||
717 (o->rate[DDIR_WRITE] && (o->rate[DDIR_WRITE] < o->ratemin[DDIR_WRITE])) ||
718 (o->rate[DDIR_TRIM] && (o->rate[DDIR_TRIM] < o->ratemin[DDIR_TRIM])) ||
719 (o->rate_iops[DDIR_READ] && (o->rate_iops[DDIR_READ] < o->rate_iops_min[DDIR_READ])) ||
720 (o->rate_iops[DDIR_WRITE] && (o->rate_iops[DDIR_WRITE] < o->rate_iops_min[DDIR_WRITE])) ||
721 (o->rate_iops[DDIR_TRIM] && (o->rate_iops[DDIR_TRIM] < o->rate_iops_min[DDIR_TRIM]))) {
722 log_err("fio: minimum rate exceeds rate\n");
726 if (!o->timeout && o->time_based) {
727 log_err("fio: time_based requires a runtime/timeout setting\n");
729 ret = warnings_fatal;
732 if (o->fill_device && !o->size)
735 if (o->verify != VERIFY_NONE) {
736 if (td_write(td) && o->do_verify && o->numjobs > 1) {
737 log_info("Multiple writers may overwrite blocks that "
738 "belong to other jobs. This can cause "
739 "verification failures.\n");
740 ret = warnings_fatal;
743 if (!fio_option_is_set(o, refill_buffers))
744 o->refill_buffers = 1;
746 if (o->max_bs[DDIR_WRITE] != o->min_bs[DDIR_WRITE] &&
748 o->verify_interval = o->min_bs[DDIR_WRITE];
751 * Verify interval must be smaller or equal to the
754 if (o->verify_interval > o->min_bs[DDIR_WRITE])
755 o->verify_interval = o->min_bs[DDIR_WRITE];
756 else if (td_read(td) && o->verify_interval > o->min_bs[DDIR_READ])
757 o->verify_interval = o->min_bs[DDIR_READ];
761 o->invalidate_cache = 0;
762 if (td_ioengine_flagged(td, FIO_PIPEIO)) {
763 log_info("fio: cannot pre-read files with an IO engine"
764 " that isn't seekable. Pre-read disabled.\n");
765 ret = warnings_fatal;
770 if (td_ioengine_flagged(td, FIO_BIT_BASED))
776 #ifndef CONFIG_FDATASYNC
777 if (o->fdatasync_blocks) {
778 log_info("fio: this platform does not support fdatasync()"
779 " falling back to using fsync(). Use the 'fsync'"
780 " option instead of 'fdatasync' to get rid of"
782 o->fsync_blocks = o->fdatasync_blocks;
783 o->fdatasync_blocks = 0;
784 ret = warnings_fatal;
790 * Windows doesn't support O_DIRECT or O_SYNC with the _open interface,
791 * so fail if we're passed those flags
793 if (td_ioengine_flagged(td, FIO_SYNCIO) && (td->o.odirect || td->o.sync_io)) {
794 log_err("fio: Windows does not support direct or non-buffered io with"
795 " the synchronous ioengines. Use the 'windowsaio' ioengine"
796 " with 'direct=1' and 'iodepth=1' instead.\n");
802 * For fully compressible data, just zero them at init time.
803 * It's faster than repeatedly filling it. For non-zero
804 * compression, we should have refill_buffers set. Set it, unless
805 * the job file already changed it.
807 if (o->compress_percentage) {
808 if (o->compress_percentage == 100) {
810 o->compress_percentage = 0;
811 } else if (!fio_option_is_set(o, refill_buffers))
812 o->refill_buffers = 1;
816 * Using a non-uniform random distribution excludes usage of
819 if (td->o.random_distribution != FIO_RAND_DIST_RANDOM)
820 td->o.norandommap = 1;
823 * If size is set but less than the min block size, complain
825 if (o->size && o->size < td_min_bs(td)) {
826 log_err("fio: size too small, must not be less than minimum block size: %llu < %u\n",
827 (unsigned long long) o->size, td_min_bs(td));
832 * O_ATOMIC implies O_DIRECT
838 * If randseed is set, that overrides randrepeat
840 if (fio_option_is_set(&td->o, rand_seed))
841 td->o.rand_repeatable = 0;
843 if (td_ioengine_flagged(td, FIO_NOEXTEND) && td->o.file_append) {
844 log_err("fio: can't append/extent with IO engine %s\n", td->io_ops->name);
848 if (fio_option_is_set(o, gtod_cpu)) {
850 fio_gtod_set_cpu(o->gtod_cpu);
851 fio_gtod_offload = 1;
854 td->loops = o->loops;
858 if (td->o.block_error_hist && td->o.nr_files != 1) {
859 log_err("fio: block error histogram only available "
860 "with a single file per job, but %d files "
861 "provided\n", td->o.nr_files);
869 * This function leaks the buffer
871 char *fio_uint_to_kmg(unsigned int val)
873 char *buf = malloc(32);
874 char post[] = { 0, 'K', 'M', 'G', 'P', 'E', 0 };
885 snprintf(buf, 32, "%u%c", val, *p);
889 /* External engines are specified by "external:name.o") */
890 static const char *get_engine_name(const char *str)
892 char *p = strstr(str, ":");
898 strip_blank_front(&p);
903 static void init_rand_file_service(struct thread_data *td)
905 unsigned long nranges = td->o.nr_files << FIO_FSERVICE_SHIFT;
906 const unsigned int seed = td->rand_seeds[FIO_RAND_FILE_OFF];
908 if (td->o.file_service_type == FIO_FSERVICE_ZIPF) {
909 zipf_init(&td->next_file_zipf, nranges, td->zipf_theta, seed);
910 zipf_disable_hash(&td->next_file_zipf);
911 } else if (td->o.file_service_type == FIO_FSERVICE_PARETO) {
912 pareto_init(&td->next_file_zipf, nranges, td->pareto_h, seed);
913 zipf_disable_hash(&td->next_file_zipf);
914 } else if (td->o.file_service_type == FIO_FSERVICE_GAUSS) {
915 gauss_init(&td->next_file_gauss, nranges, td->gauss_dev, seed);
916 gauss_disable_hash(&td->next_file_gauss);
920 void td_fill_verify_state_seed(struct thread_data *td)
924 if (td->o.random_generator == FIO_RAND_GEN_TAUSWORTHE64)
929 init_rand_seed(&td->verify_state, td->rand_seeds[FIO_RAND_VER_OFF],
933 static void td_fill_rand_seeds_internal(struct thread_data *td, bool use64)
937 init_rand_seed(&td->bsrange_state, td->rand_seeds[FIO_RAND_BS_OFF], use64);
938 td_fill_verify_state_seed(td);
939 init_rand_seed(&td->rwmix_state, td->rand_seeds[FIO_RAND_MIX_OFF], false);
941 if (td->o.file_service_type == FIO_FSERVICE_RANDOM)
942 init_rand_seed(&td->next_file_state, td->rand_seeds[FIO_RAND_FILE_OFF], use64);
943 else if (td->o.file_service_type & __FIO_FSERVICE_NONUNIFORM)
944 init_rand_file_service(td);
946 init_rand_seed(&td->file_size_state, td->rand_seeds[FIO_RAND_FILE_SIZE_OFF], use64);
947 init_rand_seed(&td->trim_state, td->rand_seeds[FIO_RAND_TRIM_OFF], use64);
948 init_rand_seed(&td->delay_state, td->rand_seeds[FIO_RAND_START_DELAY], use64);
949 init_rand_seed(&td->poisson_state, td->rand_seeds[FIO_RAND_POISSON_OFF], 0);
950 init_rand_seed(&td->dedupe_state, td->rand_seeds[FIO_DEDUPE_OFF], false);
951 init_rand_seed(&td->zone_state, td->rand_seeds[FIO_RAND_ZONE_OFF], false);
956 if (td->o.rand_repeatable)
957 td->rand_seeds[FIO_RAND_BLOCK_OFF] = FIO_RANDSEED * td->thread_number;
959 init_rand_seed(&td->random_state, td->rand_seeds[FIO_RAND_BLOCK_OFF], use64);
961 for (i = 0; i < DDIR_RWDIR_CNT; i++) {
962 struct frand_state *s = &td->seq_rand_state[i];
964 init_rand_seed(s, td->rand_seeds[FIO_RAND_SEQ_RAND_READ_OFF], false);
968 void td_fill_rand_seeds(struct thread_data *td)
972 if (td->o.allrand_repeatable) {
975 for (i = 0; i < FIO_RAND_NR_OFFS; i++)
976 td->rand_seeds[i] = FIO_RANDSEED * td->thread_number
980 if (td->o.random_generator == FIO_RAND_GEN_TAUSWORTHE64)
985 td_fill_rand_seeds_internal(td, use64);
987 init_rand_seed(&td->buf_state, td->rand_seeds[FIO_RAND_BUF_OFF], use64);
988 frand_copy(&td->buf_state_prev, &td->buf_state);
992 * Initializes the ioengine configured for a job, if it has not been done so
995 int ioengine_load(struct thread_data *td)
1000 * Engine has already been loaded.
1004 if (!td->o.ioengine) {
1005 log_err("fio: internal fault, no IO engine specified\n");
1009 engine = get_engine_name(td->o.ioengine);
1010 td->io_ops = load_ioengine(td, engine);
1012 log_err("fio: failed to load engine %s\n", engine);
1016 if (td->io_ops->option_struct_size && td->io_ops->options) {
1018 * In cases where td->eo is set, clone it for a child thread.
1019 * This requires that the parent thread has the same ioengine,
1020 * but that requirement must be enforced by the code which
1021 * cloned the thread.
1023 void *origeo = td->eo;
1025 * Otherwise use the default thread options.
1027 if (!origeo && td != &def_thread && def_thread.eo &&
1028 def_thread.io_ops->options == td->io_ops->options)
1029 origeo = def_thread.eo;
1031 options_init(td->io_ops->options);
1032 td->eo = malloc(td->io_ops->option_struct_size);
1034 * Use the default thread as an option template if this uses the
1035 * same options structure and there are non-default options
1039 memcpy(td->eo, origeo, td->io_ops->option_struct_size);
1040 options_mem_dupe(td->eo, td->io_ops->options);
1042 memset(td->eo, 0, td->io_ops->option_struct_size);
1043 fill_default_options(td->eo, td->io_ops->options);
1045 *(struct thread_data **)td->eo = td;
1049 td->io_ops->flags |= FIO_RAWIO;
1051 td_set_ioengine_flags(td);
1055 static void init_flags(struct thread_data *td)
1057 struct thread_options *o = &td->o;
1059 if (o->verify_backlog)
1060 td->flags |= TD_F_VER_BACKLOG;
1061 if (o->trim_backlog)
1062 td->flags |= TD_F_TRIM_BACKLOG;
1063 if (o->read_iolog_file)
1064 td->flags |= TD_F_READ_IOLOG;
1065 if (o->refill_buffers)
1066 td->flags |= TD_F_REFILL_BUFFERS;
1068 * Always scramble buffers if asked to
1070 if (o->scramble_buffers && fio_option_is_set(o, scramble_buffers))
1071 td->flags |= TD_F_SCRAMBLE_BUFFERS;
1073 * But also scramble buffers, unless we were explicitly asked
1076 if (o->scramble_buffers && !(o->zero_buffers &&
1077 fio_option_is_set(o, zero_buffers)))
1078 td->flags |= TD_F_SCRAMBLE_BUFFERS;
1079 if (o->verify != VERIFY_NONE)
1080 td->flags |= TD_F_VER_NONE;
1082 if (o->verify_async || o->io_submit_mode == IO_MODE_OFFLOAD)
1083 td->flags |= TD_F_NEED_LOCK;
1086 static int setup_random_seeds(struct thread_data *td)
1091 if (!td->o.rand_repeatable && !fio_option_is_set(&td->o, rand_seed))
1092 return init_random_state(td, td->rand_seeds, sizeof(td->rand_seeds));
1094 seed = td->o.rand_seed;
1095 for (i = 0; i < 4; i++)
1096 seed *= 0x9e370001UL;
1098 for (i = 0; i < FIO_RAND_NR_OFFS; i++) {
1099 td->rand_seeds[i] = seed * td->thread_number + i;
1100 seed *= 0x9e370001UL;
1103 td_fill_rand_seeds(td);
1114 static struct fpre_keyword {
1115 const char *keyword;
1118 } fpre_keywords[] = {
1119 { .keyword = "$jobname", .key = FPRE_JOBNAME, },
1120 { .keyword = "$jobnum", .key = FPRE_JOBNUM, },
1121 { .keyword = "$filenum", .key = FPRE_FILENUM, },
1122 { .keyword = NULL, },
1125 static char *make_filename(char *buf, size_t buf_size,struct thread_options *o,
1126 const char *jobname, int jobnum, int filenum)
1128 struct fpre_keyword *f;
1129 char copy[PATH_MAX];
1130 size_t dst_left = PATH_MAX - 1;
1132 if (!o->filename_format || !strlen(o->filename_format)) {
1133 sprintf(buf, "%s.%d.%d", jobname, jobnum, filenum);
1137 for (f = &fpre_keywords[0]; f->keyword; f++)
1138 f->strlen = strlen(f->keyword);
1140 buf[buf_size - 1] = '\0';
1141 strncpy(buf, o->filename_format, buf_size - 1);
1143 memset(copy, 0, sizeof(copy));
1144 for (f = &fpre_keywords[0]; f->keyword; f++) {
1146 size_t pre_len, post_start = 0;
1147 char *str, *dst = copy;
1149 str = strcasestr(buf, f->keyword);
1153 pre_len = str - buf;
1154 if (strlen(str) != f->strlen)
1155 post_start = pre_len + f->strlen;
1158 strncpy(dst, buf, pre_len);
1160 dst_left -= pre_len;
1164 case FPRE_JOBNAME: {
1167 ret = snprintf(dst, dst_left, "%s", jobname);
1170 else if (ret > dst_left) {
1171 log_err("fio: truncated filename\n");
1183 ret = snprintf(dst, dst_left, "%d", jobnum);
1186 else if (ret > dst_left) {
1187 log_err("fio: truncated filename\n");
1196 case FPRE_FILENUM: {
1199 ret = snprintf(dst, dst_left, "%d", filenum);
1202 else if (ret > dst_left) {
1203 log_err("fio: truncated filename\n");
1218 strncpy(dst, buf + post_start, dst_left);
1220 strncpy(buf, copy, buf_size - 1);
1227 bool parse_dryrun(void)
1229 return dump_cmdline || parse_only;
1232 static void gen_log_name(char *name, size_t size, const char *logtype,
1233 const char *logname, unsigned int num,
1234 const char *suf, int per_job)
1237 snprintf(name, size, "%s_%s.%d.%s", logname, logtype, num, suf);
1239 snprintf(name, size, "%s_%s.%s", logname, logtype, suf);
1242 static int check_waitees(char *waitee)
1244 struct thread_data *td;
1247 for_each_td(td, i) {
1248 if (td->subjob_number)
1251 ret += !strcmp(td->o.name, waitee);
1257 static bool wait_for_ok(const char *jobname, struct thread_options *o)
1264 if (!strcmp(jobname, o->wait_for)) {
1265 log_err("%s: a job cannot wait for itself (wait_for=%s).\n",
1266 jobname, o->wait_for);
1270 if (!(nw = check_waitees(o->wait_for))) {
1271 log_err("%s: waitee job %s unknown.\n", jobname, o->wait_for);
1276 log_err("%s: multiple waitees %s found,\n"
1277 "please avoid duplicates when using wait_for option.\n",
1278 jobname, o->wait_for);
1286 * Adds a job to the list of things todo. Sanitizes the various options
1287 * to make sure we don't have conflicts, and initializes various
1290 static int add_job(struct thread_data *td, const char *jobname, int job_add_num,
1291 int recursed, int client_type)
1294 char fname[PATH_MAX];
1295 int numjobs, file_alloced;
1296 struct thread_options *o = &td->o;
1297 char logname[PATH_MAX + 32];
1300 * the def_thread is just for options, it's not a real job
1302 if (td == &def_thread)
1308 * if we are just dumping the output command line, don't add the job
1310 if (parse_dryrun()) {
1315 td->client_type = client_type;
1317 if (profile_td_init(td))
1320 if (ioengine_load(td))
1324 if (!o->filename && !td->files_index && !o->read_iolog_file) {
1327 if (o->nr_files == 1 && exists_and_not_regfile(jobname))
1328 add_file(td, jobname, job_add_num, 0);
1330 for (i = 0; i < o->nr_files; i++)
1331 add_file(td, make_filename(fname, sizeof(fname), o, jobname, job_add_num, i), job_add_num, 0);
1335 if (fixup_options(td))
1339 * Belongs to fixup_options, but o->name is not necessarily set as yet
1341 if (!wait_for_ok(jobname, o))
1347 * IO engines only need this for option callbacks, and the address may
1348 * change in subprocesses.
1351 *(struct thread_data **)td->eo = NULL;
1353 if (td_ioengine_flagged(td, FIO_DISKLESSIO)) {
1356 for_each_file(td, f, i)
1357 f->real_file_size = -1ULL;
1360 td->mutex = fio_mutex_init(FIO_MUTEX_LOCKED);
1362 td->ts.clat_percentiles = o->clat_percentiles;
1363 td->ts.percentile_precision = o->percentile_precision;
1364 memcpy(td->ts.percentile_list, o->percentile_list, sizeof(o->percentile_list));
1366 for (i = 0; i < DDIR_RWDIR_CNT; i++) {
1367 td->ts.clat_stat[i].min_val = ULONG_MAX;
1368 td->ts.slat_stat[i].min_val = ULONG_MAX;
1369 td->ts.lat_stat[i].min_val = ULONG_MAX;
1370 td->ts.bw_stat[i].min_val = ULONG_MAX;
1372 td->ddir_seq_nr = o->ddir_seq_nr;
1374 if ((o->stonewall || o->new_group) && prev_group_jobs) {
1375 prev_group_jobs = 0;
1377 if (groupid == INT_MAX) {
1378 log_err("fio: too many groups defined\n");
1383 td->groupid = groupid;
1386 if (setup_random_seeds(td)) {
1387 td_verror(td, errno, "init_random_state");
1394 if (o->write_lat_log) {
1395 struct log_params p = {
1397 .avg_msec = o->log_avg_msec,
1398 .hist_msec = o->log_hist_msec,
1399 .hist_coarseness = o->log_hist_coarseness,
1400 .log_type = IO_LOG_TYPE_LAT,
1401 .log_offset = o->log_offset,
1402 .log_gz = o->log_gz,
1403 .log_gz_store = o->log_gz_store,
1405 const char *pre = o->lat_log_file ? o->lat_log_file : o->name;
1413 gen_log_name(logname, sizeof(logname), "lat", pre,
1414 td->thread_number, suf, o->per_job_logs);
1415 setup_log(&td->lat_log, &p, logname);
1417 gen_log_name(logname, sizeof(logname), "slat", pre,
1418 td->thread_number, suf, o->per_job_logs);
1419 setup_log(&td->slat_log, &p, logname);
1421 gen_log_name(logname, sizeof(logname), "clat", pre,
1422 td->thread_number, suf, o->per_job_logs);
1423 setup_log(&td->clat_log, &p, logname);
1426 if (o->write_hist_log) {
1427 struct log_params p = {
1429 .avg_msec = o->log_avg_msec,
1430 .hist_msec = o->log_hist_msec,
1431 .hist_coarseness = o->log_hist_coarseness,
1432 .log_type = IO_LOG_TYPE_HIST,
1433 .log_offset = o->log_offset,
1434 .log_gz = o->log_gz,
1435 .log_gz_store = o->log_gz_store,
1437 const char *pre = o->hist_log_file ? o->hist_log_file : o->name;
1441 if (td->client_type) {
1442 log_err("fio: --write_hist_log requires zlib in client/server mode\n");
1452 gen_log_name(logname, sizeof(logname), "clat_hist", pre,
1453 td->thread_number, suf, o->per_job_logs);
1454 setup_log(&td->clat_hist_log, &p, logname);
1457 if (o->write_bw_log) {
1458 struct log_params p = {
1460 .avg_msec = o->log_avg_msec,
1461 .hist_msec = o->log_hist_msec,
1462 .hist_coarseness = o->log_hist_coarseness,
1463 .log_type = IO_LOG_TYPE_BW,
1464 .log_offset = o->log_offset,
1465 .log_gz = o->log_gz,
1466 .log_gz_store = o->log_gz_store,
1468 const char *pre = o->bw_log_file ? o->bw_log_file : o->name;
1471 if (fio_option_is_set(o, bw_avg_time))
1472 p.avg_msec = min(o->log_avg_msec, o->bw_avg_time);
1474 o->bw_avg_time = p.avg_msec;
1476 p.hist_msec = o->log_hist_msec;
1477 p.hist_coarseness = o->log_hist_coarseness;
1484 gen_log_name(logname, sizeof(logname), "bw", pre,
1485 td->thread_number, suf, o->per_job_logs);
1486 setup_log(&td->bw_log, &p, logname);
1488 if (o->write_iops_log) {
1489 struct log_params p = {
1491 .avg_msec = o->log_avg_msec,
1492 .hist_msec = o->log_hist_msec,
1493 .hist_coarseness = o->log_hist_coarseness,
1494 .log_type = IO_LOG_TYPE_IOPS,
1495 .log_offset = o->log_offset,
1496 .log_gz = o->log_gz,
1497 .log_gz_store = o->log_gz_store,
1499 const char *pre = o->iops_log_file ? o->iops_log_file : o->name;
1502 if (fio_option_is_set(o, iops_avg_time))
1503 p.avg_msec = min(o->log_avg_msec, o->iops_avg_time);
1505 o->iops_avg_time = p.avg_msec;
1507 p.hist_msec = o->log_hist_msec;
1508 p.hist_coarseness = o->log_hist_coarseness;
1515 gen_log_name(logname, sizeof(logname), "iops", pre,
1516 td->thread_number, suf, o->per_job_logs);
1517 setup_log(&td->iops_log, &p, logname);
1521 o->name = strdup(jobname);
1523 if (output_format & FIO_OUTPUT_NORMAL) {
1525 if (is_backend && !recursed)
1526 fio_server_send_add_job(td);
1528 if (!td_ioengine_flagged(td, FIO_NOIO)) {
1529 char *c1, *c2, *c3, *c4;
1530 char *c5 = NULL, *c6 = NULL;
1532 c1 = fio_uint_to_kmg(o->min_bs[DDIR_READ]);
1533 c2 = fio_uint_to_kmg(o->max_bs[DDIR_READ]);
1534 c3 = fio_uint_to_kmg(o->min_bs[DDIR_WRITE]);
1535 c4 = fio_uint_to_kmg(o->max_bs[DDIR_WRITE]);
1537 if (!o->bs_is_seq_rand) {
1538 c5 = fio_uint_to_kmg(o->min_bs[DDIR_TRIM]);
1539 c6 = fio_uint_to_kmg(o->max_bs[DDIR_TRIM]);
1542 log_info("%s: (g=%d): rw=%s, ", td->o.name,
1544 ddir_str(o->td_ddir));
1546 if (o->bs_is_seq_rand)
1547 log_info("bs(seq/rand)=%s-%s/%s-%s, ",
1550 log_info("bs=%s-%s/%s-%s/%s-%s, ",
1551 c1, c2, c3, c4, c5, c6);
1553 log_info("ioengine=%s, iodepth=%u\n",
1554 td->io_ops->name, o->iodepth);
1563 } else if (job_add_num == 1)
1567 if (td_steadystate_init(td))
1571 * recurse add identical jobs, clear numjobs and stonewall options
1572 * as they don't apply to sub-jobs
1574 numjobs = o->numjobs;
1576 struct thread_data *td_new = get_new_job(0, td, 1, jobname);
1581 td_new->o.numjobs = 1;
1582 td_new->o.stonewall = 0;
1583 td_new->o.new_group = 0;
1584 td_new->subjob_number = numjobs;
1585 td_new->o.ss_dur = o->ss_dur * 1000000l;
1586 td_new->o.ss_limit = o->ss_limit;
1589 if (td_new->files) {
1591 for_each_file(td_new, f, i) {
1593 sfree(f->file_name);
1596 free(td_new->files);
1597 td_new->files = NULL;
1599 td_new->files_index = 0;
1600 td_new->files_size = 0;
1601 if (td_new->o.filename) {
1602 free(td_new->o.filename);
1603 td_new->o.filename = NULL;
1607 if (add_job(td_new, jobname, numjobs, 1, client_type))
1618 * Parse as if 'o' was a command line
1620 void add_job_opts(const char **o, int client_type)
1622 struct thread_data *td, *td_parent;
1623 int i, in_global = 1;
1627 td_parent = td = NULL;
1629 if (!strncmp(o[i], "name", 4)) {
1632 add_job(td, jobname, 0, 0, client_type);
1634 sprintf(jobname, "%s", o[i] + 5);
1636 if (in_global && !td_parent)
1637 td_parent = get_new_job(1, &def_thread, 0, jobname);
1638 else if (!in_global && !td) {
1640 td_parent = &def_thread;
1641 td = get_new_job(0, td_parent, 0, jobname);
1644 fio_options_parse(td_parent, (char **) &o[i], 1);
1646 fio_options_parse(td, (char **) &o[i], 1);
1651 add_job(td, jobname, 0, 0, client_type);
1654 static int skip_this_section(const char *name)
1658 if (!nr_job_sections)
1660 if (!strncmp(name, "global", 6))
1663 for (i = 0; i < nr_job_sections; i++)
1664 if (!strcmp(job_sections[i], name))
1670 static int is_empty_or_comment(char *line)
1674 for (i = 0; i < strlen(line); i++) {
1679 if (!isspace((int) line[i]) && !iscntrl((int) line[i]))
1687 * This is our [ini] type file parser.
1689 static int __parse_jobs_ini(struct thread_data *td,
1690 char *file, int is_buf, int stonewall_flag, int type,
1691 int nested, char *name, char ***popts, int *aopts, int *nopts)
1693 unsigned int global = 0;
1697 int ret = 0, stonewall;
1700 int inside_skip = 0;
1702 int i, alloc_opts, num_opts;
1704 dprint(FD_PARSE, "Parsing ini file %s\n", file);
1705 assert(td || !nested);
1710 if (!strcmp(file, "-"))
1713 f = fopen(file, "r");
1718 log_err("fio: unable to open '%s' job file\n", file);
1720 td_verror(td, __err, "job file open");
1725 string = malloc(4096);
1728 * it's really 256 + small bit, 280 should suffice
1732 memset(name, 0, 280);
1736 if (nested && popts) {
1738 alloc_opts = *aopts;
1744 opts = malloc(sizeof(char *) * alloc_opts);
1748 stonewall = stonewall_flag;
1751 * if skip_fgets is set, we already have loaded a line we
1756 p = strsep(&file, "\n");
1758 p = fgets(string, 4096, f);
1764 strip_blank_front(&p);
1767 dprint(FD_PARSE, "%s\n", p);
1768 if (is_empty_or_comment(p))
1772 if (sscanf(p, "[%255[^\n]]", name) != 1) {
1776 log_err("fio: option <%s> outside of "
1777 "[] job section\n", p);
1782 name[strlen(name) - 1] = '\0';
1784 if (skip_this_section(name)) {
1790 dprint(FD_PARSE, "Parsing section [%s]\n", name);
1792 global = !strncmp(name, "global", 6);
1798 log_info("--name=%s ", name);
1802 td = get_new_job(global, &def_thread, 0, name);
1809 * Separate multiple job files by a stonewall
1811 if (!global && stonewall) {
1812 td->o.stonewall = stonewall;
1817 memset(opts, 0, alloc_opts * sizeof(char *));
1825 p = strsep(&file, "\n");
1827 p = fgets(string, 4096, f);
1830 dprint(FD_PARSE, "%s", p);
1835 if (is_empty_or_comment(p))
1838 strip_blank_front(&p);
1841 * new section, break out and make sure we don't
1842 * fgets() a new line at the top.
1846 log_err("No new sections in included files\n");
1856 if (!strncmp(p, "include", strlen("include"))) {
1857 char *filename = p + strlen("include") + 1,
1858 *ts, *full_fn = NULL;
1861 * Allow for the include filename
1862 * specification to be relative.
1864 if (access(filename, F_OK) &&
1865 (ts = strrchr(file, '/'))) {
1866 int len = ts - file +
1867 strlen(filename) + 2;
1869 if (!(full_fn = calloc(1, len))) {
1875 file, (ts - file) + 1);
1876 strncpy(full_fn + (ts - file) + 1,
1877 filename, strlen(filename));
1878 full_fn[len - 1] = 0;
1882 ret = __parse_jobs_ini(td, filename, is_buf,
1883 stonewall_flag, type, 1,
1885 &alloc_opts, &num_opts);
1888 log_err("Error %d while parsing "
1889 "include file %s\n",
1902 if (num_opts == alloc_opts) {
1904 opts = realloc(opts,
1905 alloc_opts * sizeof(char *));
1908 opts[num_opts] = strdup(p);
1914 *aopts = alloc_opts;
1919 ret = fio_options_parse(td, opts, num_opts);
1924 ret = add_job(td, name, 0, 0, type);
1926 log_err("fio: job %s dropped\n", name);
1930 for (i = 0; i < num_opts; i++)
1939 while (i < nr_job_sections) {
1940 free(job_sections[i]);
1949 if (!is_buf && f != stdin)
1954 int parse_jobs_ini(char *file, int is_buf, int stonewall_flag, int type)
1956 return __parse_jobs_ini(NULL, file, is_buf, stonewall_flag, type,
1957 0, NULL, NULL, NULL, NULL);
1960 static int fill_def_thread(void)
1962 memset(&def_thread, 0, sizeof(def_thread));
1963 INIT_FLIST_HEAD(&def_thread.opt_list);
1965 fio_getaffinity(getpid(), &def_thread.o.cpumask);
1966 def_thread.o.error_dump = 1;
1969 * fill default options
1971 fio_fill_default_options(&def_thread);
1975 static void show_debug_categories(void)
1977 #ifdef FIO_INC_DEBUG
1978 struct debug_level *dl = &debug_levels[0];
1979 int curlen, first = 1;
1983 int has_next = (dl + 1)->name != NULL;
1985 if (first || curlen + strlen(dl->name) >= 80) {
1990 curlen += printf("\t\t\t%s", dl->name);
1991 curlen += 3 * (8 - 1);
1993 curlen += printf(",");
1995 curlen += printf("%s", dl->name);
1997 curlen += printf(",");
2006 static void usage(const char *name)
2008 printf("%s\n", fio_version_string);
2009 printf("%s [options] [job options] <job file(s)>\n", name);
2010 printf(" --debug=options\tEnable debug logging. May be one/more of:\n");
2011 show_debug_categories();
2012 printf(" --parse-only\t\tParse options only, don't start any IO\n");
2013 printf(" --output\t\tWrite output to file\n");
2014 printf(" --runtime\t\tRuntime in seconds\n");
2015 printf(" --bandwidth-log\tGenerate aggregate bandwidth logs\n");
2016 printf(" --minimal\t\tMinimal (terse) output\n");
2017 printf(" --output-format=x\tOutput format (terse,json,json+,normal)\n");
2018 printf(" --terse-version=x\tSet terse version output format to 'x'\n");
2019 printf(" --version\t\tPrint version info and exit\n");
2020 printf(" --help\t\tPrint this page\n");
2021 printf(" --cpuclock-test\tPerform test/validation of CPU clock\n");
2022 printf(" --crctest\t\tTest speed of checksum functions\n");
2023 printf(" --cmdhelp=cmd\t\tPrint command help, \"all\" for all of"
2025 printf(" --enghelp=engine\tPrint ioengine help, or list"
2026 " available ioengines\n");
2027 printf(" --enghelp=engine,cmd\tPrint help for an ioengine"
2029 printf(" --showcmd\t\tTurn a job file into command line options\n");
2030 printf(" --eta=when\t\tWhen ETA estimate should be printed\n");
2031 printf(" \t\tMay be \"always\", \"never\" or \"auto\"\n");
2032 printf(" --eta-newline=time\tForce a new line for every 'time'");
2033 printf(" period passed\n");
2034 printf(" --status-interval=t\tForce full status dump every");
2035 printf(" 't' period passed\n");
2036 printf(" --readonly\t\tTurn on safety read-only checks, preventing"
2038 printf(" --section=name\tOnly run specified section in job file\n");
2039 printf(" --alloc-size=kb\tSet smalloc pool to this size in kb"
2041 printf(" --warnings-fatal\tFio parser warnings are fatal\n");
2042 printf(" --max-jobs=nr\t\tMaximum number of threads/processes to support\n");
2043 printf(" --server=args\t\tStart a backend fio server\n");
2044 printf(" --daemonize=pidfile\tBackground fio server, write pid to file\n");
2045 printf(" --client=hostname\tTalk to remote backend fio server at hostname\n");
2046 printf(" --remote-config=file\tTell fio server to load this local job file\n");
2047 printf(" --idle-prof=option\tReport cpu idleness on a system or percpu basis\n"
2048 "\t\t\t(option=system,percpu) or run unit work\n"
2049 "\t\t\tcalibration only (option=calibrate)\n");
2051 printf(" --inflate-log=log\tInflate and output compressed log\n");
2053 printf(" --trigger-file=file\tExecute trigger cmd when file exists\n");
2054 printf(" --trigger-timeout=t\tExecute trigger af this time\n");
2055 printf(" --trigger=cmd\t\tSet this command as local trigger\n");
2056 printf(" --trigger-remote=cmd\tSet this command as remote trigger\n");
2057 printf(" --aux-path=path\tUse this path for fio state generated files\n");
2058 printf("\nFio was written by Jens Axboe <jens.axboe@oracle.com>");
2059 printf("\n Jens Axboe <jaxboe@fusionio.com>");
2060 printf("\n Jens Axboe <axboe@fb.com>\n");
2063 #ifdef FIO_INC_DEBUG
2064 struct debug_level debug_levels[] = {
2065 { .name = "process",
2066 .help = "Process creation/exit logging",
2067 .shift = FD_PROCESS,
2070 .help = "File related action logging",
2074 .help = "IO and IO engine action logging (offsets, queue, completions, etc)",
2078 .help = "Memory allocation/freeing logging",
2081 { .name = "blktrace",
2082 .help = "blktrace action logging",
2083 .shift = FD_BLKTRACE,
2086 .help = "IO verification action logging",
2090 .help = "Random generation logging",
2094 .help = "Parser logging",
2097 { .name = "diskutil",
2098 .help = "Disk utility logging actions",
2099 .shift = FD_DISKUTIL,
2102 .help = "Logging related to creating/destroying jobs",
2106 .help = "Mutex logging",
2109 { .name = "profile",
2110 .help = "Logging related to profiles",
2111 .shift = FD_PROFILE,
2114 .help = "Logging related to time keeping functions",
2118 .help = "Network logging",
2122 .help = "Rate logging",
2125 { .name = "compress",
2126 .help = "Log compression logging",
2127 .shift = FD_COMPRESS,
2129 { .name = "steadystate",
2130 .help = "Steady state detection logging",
2131 .shift = FD_STEADYSTATE,
2133 { .name = "helperthread",
2134 .help = "Helper thread logging",
2135 .shift = FD_HELPERTHREAD,
2140 static int set_debug(const char *string)
2142 struct debug_level *dl;
2143 char *p = (char *) string;
2150 if (!strcmp(string, "?") || !strcmp(string, "help")) {
2151 log_info("fio: dumping debug options:");
2152 for (i = 0; debug_levels[i].name; i++) {
2153 dl = &debug_levels[i];
2154 log_info("%s,", dl->name);
2160 while ((opt = strsep(&p, ",")) != NULL) {
2163 if (!strncmp(opt, "all", 3)) {
2164 log_info("fio: set all debug options\n");
2169 for (i = 0; debug_levels[i].name; i++) {
2170 dl = &debug_levels[i];
2171 found = !strncmp(opt, dl->name, strlen(dl->name));
2175 if (dl->shift == FD_JOB) {
2176 opt = strchr(opt, ':');
2178 log_err("fio: missing job number\n");
2182 fio_debug_jobno = atoi(opt);
2183 log_info("fio: set debug jobno %d\n",
2186 log_info("fio: set debug option %s\n", opt);
2187 fio_debug |= (1UL << dl->shift);
2193 log_err("fio: debug mask %s not found\n", opt);
2198 static int set_debug(const char *string)
2200 log_err("fio: debug tracing not included in build\n");
2205 static void fio_options_fill_optstring(void)
2207 char *ostr = cmd_optstr;
2211 while (l_opts[i].name) {
2212 ostr[c++] = l_opts[i].val;
2213 if (l_opts[i].has_arg == required_argument)
2215 else if (l_opts[i].has_arg == optional_argument) {
2224 static int client_flag_set(char c)
2229 while (l_opts[i].name) {
2230 int val = l_opts[i].val;
2232 if (c == (val & 0xff))
2233 return (val & FIO_CLIENT_FLAG);
2241 static void parse_cmd_client(void *client, char *opt)
2243 fio_client_add_cmd_option(client, opt);
2246 static void show_closest_option(const char *name)
2248 int best_option, best_distance;
2251 while (*name == '-')
2255 best_distance = INT_MAX;
2257 while (l_opts[i].name) {
2258 distance = string_distance(name, l_opts[i].name);
2259 if (distance < best_distance) {
2260 best_distance = distance;
2266 if (best_option != -1 && string_distance_ok(name, best_distance))
2267 log_err("Did you mean %s?\n", l_opts[best_option].name);
2270 static int parse_output_format(const char *optarg)
2272 char *p, *orig, *opt;
2275 p = orig = strdup(optarg);
2279 while ((opt = strsep(&p, ",")) != NULL) {
2280 if (!strcmp(opt, "minimal") ||
2281 !strcmp(opt, "terse") ||
2282 !strcmp(opt, "csv"))
2283 output_format |= FIO_OUTPUT_TERSE;
2284 else if (!strcmp(opt, "json"))
2285 output_format |= FIO_OUTPUT_JSON;
2286 else if (!strcmp(opt, "json+"))
2287 output_format |= (FIO_OUTPUT_JSON | FIO_OUTPUT_JSON_PLUS);
2288 else if (!strcmp(opt, "normal"))
2289 output_format |= FIO_OUTPUT_NORMAL;
2291 log_err("fio: invalid output format %s\n", opt);
2301 int parse_cmd_line(int argc, char *argv[], int client_type)
2303 struct thread_data *td = NULL;
2304 int c, ini_idx = 0, lidx, ret = 0, do_exit = 0, exit_val = 0;
2305 char *ostr = cmd_optstr;
2306 char *pid_file = NULL;
2307 void *cur_client = NULL;
2311 * Reset optind handling, since we may call this multiple times
2316 while ((c = getopt_long_only(argc, argv, ostr, l_opts, &lidx)) != -1) {
2317 if ((c & FIO_CLIENT_FLAG) || client_flag_set(c)) {
2318 parse_cmd_client(cur_client, argv[optind - 1]);
2319 c &= ~FIO_CLIENT_FLAG;
2324 smalloc_pool_size = atoi(optarg);
2325 smalloc_pool_size <<= 10;
2329 if (check_str_time(optarg, &def_timeout, 1)) {
2330 log_err("fio: failed parsing time %s\n", optarg);
2336 log_err("fio: --latency-log is deprecated. Use per-job latency log options.\n");
2344 if (f_out && f_out != stdout)
2347 f_out = fopen(optarg, "w+");
2349 perror("fopen output");
2355 output_format = FIO_OUTPUT_TERSE;
2358 if (parse_output_format(optarg)) {
2359 log_err("fio: failed parsing output-format\n");
2366 output_format |= FIO_OUTPUT_TERSE;
2378 fio_show_option_help(optarg);
2385 fio_show_ioengine_help(optarg);
2399 log_info("%s\n", fio_version_string);
2404 terse_version = atoi(optarg);
2405 if (!(terse_version == 2 || terse_version == 3 ||
2406 terse_version == 4)) {
2407 log_err("fio: bad terse version format\n");
2413 if (!strcmp("always", optarg))
2414 eta_print = FIO_ETA_ALWAYS;
2415 else if (!strcmp("never", optarg))
2416 eta_print = FIO_ETA_NEVER;
2421 if (check_str_time(optarg, &t, 1)) {
2422 log_err("fio: failed parsing eta time %s\n", optarg);
2426 eta_new_line = t / 1000;
2430 if (set_debug(optarg))
2440 if (!strcmp(optarg, "global")) {
2441 log_err("fio: can't use global as only "
2447 new_size = (nr_job_sections + 1) * sizeof(char *);
2448 job_sections = realloc(job_sections, new_size);
2449 job_sections[nr_job_sections] = strdup(optarg);
2455 exit_val = iolog_file_inflate(optarg);
2464 exec_profile = strdup(optarg);
2466 case FIO_GETOPT_JOB: {
2467 const char *opt = l_opts[lidx].name;
2470 if (!strncmp(opt, "name", 4) && td) {
2471 ret = add_job(td, td->o.name ?: "fio", 0, 0, client_type);
2478 int is_section = !strncmp(opt, "name", 4);
2481 if (!is_section || !strncmp(val, "global", 6))
2484 if (is_section && skip_this_section(val))
2487 td = get_new_job(global, &def_thread, 1, NULL);
2488 if (!td || ioengine_load(td)) {
2497 fio_options_set_ioengine_opts(l_opts, td);
2500 if ((!val || !strlen(val)) &&
2501 l_opts[lidx].has_arg == required_argument) {
2502 log_err("fio: option %s requires an argument\n", opt);
2505 ret = fio_cmd_option_parse(td, opt, val);
2516 if (!ret && !strcmp(opt, "ioengine")) {
2518 if (ioengine_load(td)) {
2525 fio_options_set_ioengine_opts(l_opts, td);
2529 case FIO_GETOPT_IOENGINE: {
2530 const char *opt = l_opts[lidx].name;
2536 ret = fio_cmd_ioengine_option_parse(td, opt, val);
2543 max_jobs = atoi(optarg);
2544 if (!max_jobs || max_jobs > REAL_MAX_JOBS) {
2545 log_err("fio: invalid max jobs: %d\n", max_jobs);
2552 #ifndef CONFIG_NO_SHM
2554 log_err("fio: can't be both client and server\n");
2560 fio_server_set_arg(optarg);
2564 log_err("fio: client/server requires SHM support\n");
2572 pid_file = strdup(optarg);
2575 if ((ret = fio_idle_prof_parse_opt(optarg))) {
2576 /* exit on error and calibration only */
2586 log_err("fio: can't be both client and server\n");
2591 /* if --client parameter contains a pathname */
2592 if (0 == access(optarg, R_OK)) {
2593 /* file contains a list of host addrs or names */
2594 char hostaddr[PATH_MAX] = {0};
2596 FILE * hostf = fopen(optarg, "r");
2598 log_err("fio: could not open client list file %s for read\n", optarg);
2603 sprintf(formatstr, "%%%ds", PATH_MAX - 1);
2605 * read at most PATH_MAX-1 chars from each
2606 * record in this file
2608 while (fscanf(hostf, formatstr, hostaddr) == 1) {
2609 /* expect EVERY host in file to be valid */
2610 if (fio_client_add(&fio_client_ops, hostaddr, &cur_client)) {
2611 log_err("fio: failed adding client %s from file %s\n", hostaddr, optarg);
2618 break; /* no possibility of job file for "this client only" */
2620 if (fio_client_add(&fio_client_ops, optarg, &cur_client)) {
2621 log_err("fio: failed adding client %s\n", optarg);
2627 * If the next argument exists and isn't an option,
2628 * assume it's a job file for this client only.
2630 while (optind < argc) {
2631 if (!strncmp(argv[optind], "--", 2) ||
2632 !strncmp(argv[optind], "-", 1))
2635 if (fio_client_add_ini_file(cur_client, argv[optind], false))
2642 if (fio_client_add_ini_file(cur_client, optarg, true)) {
2650 exit_val = fio_monotonic_clocktest(1);
2655 exit_val = fio_crctest(optarg);
2660 if (check_str_time(optarg, &val, 1)) {
2661 log_err("fio: failed parsing time %s\n", optarg);
2666 status_interval = val / 1000;
2672 trigger_file = strdup(optarg);
2677 trigger_cmd = strdup(optarg);
2680 if (trigger_remote_cmd)
2681 free(trigger_remote_cmd);
2682 trigger_remote_cmd = strdup(optarg);
2687 aux_path = strdup(optarg);
2690 if (check_str_time(optarg, &trigger_timeout, 1)) {
2691 log_err("fio: failed parsing time %s\n", optarg);
2695 trigger_timeout /= 1000000;
2698 log_err("%s: unrecognized option '%s'\n", argv[0],
2700 show_closest_option(argv[optind - 1]);
2710 if (do_exit && !(is_backend || nr_clients))
2713 if (nr_clients && fio_clients_connect())
2716 if (is_backend && backend)
2717 return fio_start_server(pid_file);
2723 ret = add_job(td, td->o.name ?: "fio", 0, 0, client_type);
2729 while (!ret && optind < argc) {
2731 ini_file = realloc(ini_file, ini_idx * sizeof(char *));
2732 ini_file[ini_idx - 1] = strdup(argv[optind]);
2743 int fio_init_options(void)
2748 fio_options_fill_optstring();
2749 fio_options_dup_and_init(l_opts);
2753 if (fill_def_thread())
2759 extern int fio_check_options(struct thread_options *);
2761 int parse_options(int argc, char *argv[])
2763 const int type = FIO_CLIENT_TYPE_CLI;
2766 if (fio_init_options())
2768 if (fio_test_cconv(&def_thread.o))
2769 log_err("fio: failed internal cconv test\n");
2771 job_files = parse_cmd_line(argc, argv, type);
2773 if (job_files > 0) {
2774 for (i = 0; i < job_files; i++) {
2775 if (i && fill_def_thread())
2778 if (fio_clients_send_ini(ini_file[i]))
2781 } else if (!is_backend) {
2782 if (parse_jobs_ini(ini_file[i], 0, i, type))
2787 } else if (nr_clients) {
2788 if (fill_def_thread())
2790 if (fio_clients_send_ini(NULL))
2795 fio_options_free(&def_thread);
2796 filesetup_mem_free();
2798 if (!thread_number) {
2803 if (is_backend || nr_clients)
2808 log_err("No jobs(s) defined\n\n");
2818 if (output_format & FIO_OUTPUT_NORMAL)
2819 log_info("%s\n", fio_version_string);
2824 void options_default_fill(struct thread_options *o)
2826 memcpy(o, &def_thread.o, sizeof(*o));
2829 struct thread_data *get_global_options(void)