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 long long def_timeout;
44 static int parse_only;
46 static struct thread_data def_thread;
47 struct thread_data *threads = NULL;
48 static char **job_sections;
49 static int nr_job_sections;
51 int exitall_on_terminate = 0;
52 int output_format = FIO_OUTPUT_NORMAL;
53 int eta_print = FIO_ETA_AUTO;
57 char *exec_profile = NULL;
58 int warnings_fatal = 0;
59 int terse_version = 3;
66 int status_interval = 0;
68 char *trigger_file = NULL;
69 long long trigger_timeout = 0;
70 char *trigger_cmd = NULL;
71 char *trigger_remote_cmd = NULL;
73 char *aux_path = NULL;
75 static int prev_group_jobs;
77 unsigned long fio_debug = 0;
78 unsigned int fio_debug_jobno = -1;
79 unsigned int *fio_debug_jobp = NULL;
81 static char cmd_optstr[256];
84 #define FIO_CLIENT_FLAG (1 << 16)
87 * Command line options. These will contain the above, plus a few
88 * extra that only pertain to fio itself and not jobs.
90 static struct option l_opts[FIO_NR_OPTIONS] = {
92 .name = (char *) "output",
93 .has_arg = required_argument,
94 .val = 'o' | FIO_CLIENT_FLAG,
97 .name = (char *) "runtime",
98 .has_arg = required_argument,
99 .val = 't' | FIO_CLIENT_FLAG,
102 .name = (char *) "latency-log",
103 .has_arg = required_argument,
104 .val = 'l' | FIO_CLIENT_FLAG,
107 .name = (char *) "bandwidth-log",
108 .has_arg = no_argument,
109 .val = 'b' | FIO_CLIENT_FLAG,
112 .name = (char *) "minimal",
113 .has_arg = no_argument,
114 .val = 'm' | FIO_CLIENT_FLAG,
117 .name = (char *) "output-format",
118 .has_arg = required_argument,
119 .val = 'F' | FIO_CLIENT_FLAG,
122 .name = (char *) "append-terse",
123 .has_arg = optional_argument,
127 .name = (char *) "version",
128 .has_arg = no_argument,
129 .val = 'v' | FIO_CLIENT_FLAG,
132 .name = (char *) "help",
133 .has_arg = no_argument,
134 .val = 'h' | FIO_CLIENT_FLAG,
137 .name = (char *) "cmdhelp",
138 .has_arg = optional_argument,
139 .val = 'c' | FIO_CLIENT_FLAG,
142 .name = (char *) "enghelp",
143 .has_arg = optional_argument,
144 .val = 'i' | FIO_CLIENT_FLAG,
147 .name = (char *) "showcmd",
148 .has_arg = no_argument,
149 .val = 's' | FIO_CLIENT_FLAG,
152 .name = (char *) "readonly",
153 .has_arg = no_argument,
154 .val = 'r' | FIO_CLIENT_FLAG,
157 .name = (char *) "eta",
158 .has_arg = required_argument,
159 .val = 'e' | FIO_CLIENT_FLAG,
162 .name = (char *) "eta-newline",
163 .has_arg = required_argument,
164 .val = 'E' | FIO_CLIENT_FLAG,
167 .name = (char *) "debug",
168 .has_arg = required_argument,
169 .val = 'd' | FIO_CLIENT_FLAG,
172 .name = (char *) "parse-only",
173 .has_arg = no_argument,
174 .val = 'P' | FIO_CLIENT_FLAG,
177 .name = (char *) "section",
178 .has_arg = required_argument,
179 .val = 'x' | FIO_CLIENT_FLAG,
183 .name = (char *) "inflate-log",
184 .has_arg = required_argument,
185 .val = 'X' | FIO_CLIENT_FLAG,
189 .name = (char *) "alloc-size",
190 .has_arg = required_argument,
191 .val = 'a' | FIO_CLIENT_FLAG,
194 .name = (char *) "profile",
195 .has_arg = required_argument,
196 .val = 'p' | FIO_CLIENT_FLAG,
199 .name = (char *) "warnings-fatal",
200 .has_arg = no_argument,
201 .val = 'w' | FIO_CLIENT_FLAG,
204 .name = (char *) "max-jobs",
205 .has_arg = required_argument,
206 .val = 'j' | FIO_CLIENT_FLAG,
209 .name = (char *) "terse-version",
210 .has_arg = required_argument,
211 .val = 'V' | FIO_CLIENT_FLAG,
214 .name = (char *) "server",
215 .has_arg = optional_argument,
218 { .name = (char *) "daemonize",
219 .has_arg = required_argument,
223 .name = (char *) "client",
224 .has_arg = required_argument,
228 .name = (char *) "remote-config",
229 .has_arg = required_argument,
233 .name = (char *) "cpuclock-test",
234 .has_arg = no_argument,
238 .name = (char *) "crctest",
239 .has_arg = optional_argument,
243 .name = (char *) "idle-prof",
244 .has_arg = required_argument,
248 .name = (char *) "status-interval",
249 .has_arg = required_argument,
253 .name = (char *) "trigger-file",
254 .has_arg = required_argument,
258 .name = (char *) "trigger-timeout",
259 .has_arg = required_argument,
263 .name = (char *) "trigger",
264 .has_arg = required_argument,
268 .name = (char *) "trigger-remote",
269 .has_arg = required_argument,
273 .name = (char *) "aux-path",
274 .has_arg = required_argument,
282 void free_threads_shm(void)
286 #ifndef CONFIG_NO_SHM
287 struct shmid_ds sbuf;
291 shmctl(shm_id, IPC_RMID, &sbuf);
300 static void free_shm(void)
304 fio_debug_jobp = NULL;
310 free(trigger_remote_cmd);
311 trigger_file = trigger_cmd = trigger_remote_cmd = NULL;
313 options_free(fio_options, &def_thread.o);
320 * The thread area is shared between the main process and the job
321 * threads/processes. So setup a shared memory segment that will hold
322 * all the job info. We use the end of the region for keeping track of
323 * open files across jobs, for file sharing.
325 static int setup_thread_area(void)
331 * 1024 is too much on some machines, scale max_jobs if
332 * we get a failure that looks like too large a shm segment
335 size_t size = max_jobs * sizeof(struct thread_data);
337 size += sizeof(unsigned int);
339 #ifndef CONFIG_NO_SHM
340 shm_id = shmget(0, size, IPC_CREAT | 0600);
343 if (errno != EINVAL && errno != ENOMEM && errno != ENOSPC) {
348 threads = malloc(size);
356 #ifndef CONFIG_NO_SHM
360 threads = shmat(shm_id, NULL, 0);
361 if (threads == (void *) -1) {
367 memset(threads, 0, max_jobs * sizeof(struct thread_data));
368 fio_debug_jobp = (void *) threads + max_jobs * sizeof(struct thread_data);
369 *fio_debug_jobp = -1;
376 static void set_cmd_options(struct thread_data *td)
378 struct thread_options *o = &td->o;
381 o->timeout = def_timeout;
384 static void dump_print_option(struct print_option *p)
388 if (!strcmp("description", p->name))
393 log_info("--%s%s", p->name, p->value ? "" : " ");
395 log_info("=%s%s%s ", delim, p->value, delim);
398 static void dump_opt_list(struct thread_data *td)
400 struct flist_head *entry;
401 struct print_option *p;
403 if (flist_empty(&td->opt_list))
406 flist_for_each(entry, &td->opt_list) {
407 p = flist_entry(entry, struct print_option, list);
408 dump_print_option(p);
412 static void fio_dump_options_free(struct thread_data *td)
414 while (!flist_empty(&td->opt_list)) {
415 struct print_option *p;
417 p = flist_first_entry(&td->opt_list, struct print_option, list);
418 flist_del_init(&p->list);
425 static void copy_opt_list(struct thread_data *dst, struct thread_data *src)
427 struct flist_head *entry;
429 if (flist_empty(&src->opt_list))
432 flist_for_each(entry, &src->opt_list) {
433 struct print_option *srcp, *dstp;
435 srcp = flist_entry(entry, struct print_option, list);
436 dstp = malloc(sizeof(*dstp));
437 dstp->name = strdup(srcp->name);
439 dstp->value = strdup(srcp->value);
442 flist_add_tail(&dstp->list, &dst->opt_list);
447 * Return a free job structure.
449 static struct thread_data *get_new_job(int global, struct thread_data *parent,
450 int preserve_eo, const char *jobname)
452 struct thread_data *td;
455 set_cmd_options(&def_thread);
458 if (setup_thread_area()) {
459 log_err("error: failed to setup shm segment\n");
462 if (thread_number >= max_jobs) {
463 log_err("error: maximum number of jobs (%d) reached.\n",
468 td = &threads[thread_number++];
471 INIT_FLIST_HEAD(&td->opt_list);
472 if (parent != &def_thread)
473 copy_opt_list(td, parent);
479 td->o.uid = td->o.gid = -1U;
481 dup_files(td, parent);
482 fio_options_mem_dupe(td);
484 profile_add_hooks(td);
486 td->thread_number = thread_number;
487 td->subjob_number = 0;
490 td->o.name = strdup(jobname);
492 if (!parent->o.group_reporting || parent == &def_thread)
499 static void put_job(struct thread_data *td)
501 if (td == &def_thread)
508 log_info("fio: %s\n", td->verror);
510 fio_options_free(td);
511 fio_dump_options_free(td);
518 memset(&threads[td->thread_number - 1], 0, sizeof(*td));
522 static int __setup_rate(struct thread_data *td, enum fio_ddir ddir)
524 unsigned int bs = td->o.min_bs[ddir];
526 assert(ddir_rw(ddir));
528 if (td->o.rate[ddir])
529 td->rate_bps[ddir] = td->o.rate[ddir];
531 td->rate_bps[ddir] = (uint64_t) td->o.rate_iops[ddir] * bs;
533 if (!td->rate_bps[ddir]) {
534 log_err("rate lower than supported\n");
538 td->rate_next_io_time[ddir] = 0;
539 td->rate_io_issue_bytes[ddir] = 0;
544 static int setup_rate(struct thread_data *td)
548 if (td->o.rate[DDIR_READ] || td->o.rate_iops[DDIR_READ])
549 ret = __setup_rate(td, DDIR_READ);
550 if (td->o.rate[DDIR_WRITE] || td->o.rate_iops[DDIR_WRITE])
551 ret |= __setup_rate(td, DDIR_WRITE);
552 if (td->o.rate[DDIR_TRIM] || td->o.rate_iops[DDIR_TRIM])
553 ret |= __setup_rate(td, DDIR_TRIM);
558 static int fixed_block_size(struct thread_options *o)
560 return o->min_bs[DDIR_READ] == o->max_bs[DDIR_READ] &&
561 o->min_bs[DDIR_WRITE] == o->max_bs[DDIR_WRITE] &&
562 o->min_bs[DDIR_TRIM] == o->max_bs[DDIR_TRIM] &&
563 o->min_bs[DDIR_READ] == o->min_bs[DDIR_WRITE] &&
564 o->min_bs[DDIR_READ] == o->min_bs[DDIR_TRIM];
568 static unsigned long long get_rand_start_delay(struct thread_data *td)
570 unsigned long long delayrange;
574 delayrange = td->o.start_delay_high - td->o.start_delay;
576 frand_max = rand_max(&td->delay_state);
577 r = __rand(&td->delay_state);
578 delayrange = (unsigned long long) ((double) delayrange * (r / (frand_max + 1.0)));
580 delayrange += td->o.start_delay;
585 * Lazy way of fixing up options that depend on each other. We could also
586 * define option callback handlers, but this is easier.
588 static int fixup_options(struct thread_data *td)
590 struct thread_options *o = &td->o;
593 #ifndef FIO_HAVE_PSHARED_MUTEX
594 if (!o->use_thread) {
595 log_info("fio: this platform does not support process shared"
596 " mutexes, forcing use of threads. Use the 'thread'"
597 " option to get rid of this warning.\n");
599 ret = warnings_fatal;
603 if (o->write_iolog_file && o->read_iolog_file) {
604 log_err("fio: read iolog overrides write_iolog\n");
605 free(o->write_iolog_file);
606 o->write_iolog_file = NULL;
607 ret = warnings_fatal;
611 * only really works with 1 file
613 if (o->zone_size && o->open_files > 1)
617 * If zone_range isn't specified, backward compatibility dictates it
618 * should be made equal to zone_size.
620 if (o->zone_size && !o->zone_range)
621 o->zone_range = o->zone_size;
624 * Reads can do overwrites, we always need to pre-create the file
626 if (td_read(td) || td_rw(td))
629 if (!o->min_bs[DDIR_READ])
630 o->min_bs[DDIR_READ] = o->bs[DDIR_READ];
631 if (!o->max_bs[DDIR_READ])
632 o->max_bs[DDIR_READ] = o->bs[DDIR_READ];
633 if (!o->min_bs[DDIR_WRITE])
634 o->min_bs[DDIR_WRITE] = o->bs[DDIR_WRITE];
635 if (!o->max_bs[DDIR_WRITE])
636 o->max_bs[DDIR_WRITE] = o->bs[DDIR_WRITE];
637 if (!o->min_bs[DDIR_TRIM])
638 o->min_bs[DDIR_TRIM] = o->bs[DDIR_TRIM];
639 if (!o->max_bs[DDIR_TRIM])
640 o->max_bs[DDIR_TRIM] = o->bs[DDIR_TRIM];
642 o->rw_min_bs = min(o->min_bs[DDIR_READ], o->min_bs[DDIR_WRITE]);
643 o->rw_min_bs = min(o->min_bs[DDIR_TRIM], o->rw_min_bs);
646 * For random IO, allow blockalign offset other than min_bs.
648 if (!o->ba[DDIR_READ] || !td_random(td))
649 o->ba[DDIR_READ] = o->min_bs[DDIR_READ];
650 if (!o->ba[DDIR_WRITE] || !td_random(td))
651 o->ba[DDIR_WRITE] = o->min_bs[DDIR_WRITE];
652 if (!o->ba[DDIR_TRIM] || !td_random(td))
653 o->ba[DDIR_TRIM] = o->min_bs[DDIR_TRIM];
655 if ((o->ba[DDIR_READ] != o->min_bs[DDIR_READ] ||
656 o->ba[DDIR_WRITE] != o->min_bs[DDIR_WRITE] ||
657 o->ba[DDIR_TRIM] != o->min_bs[DDIR_TRIM]) &&
659 log_err("fio: Any use of blockalign= turns off randommap\n");
661 ret = warnings_fatal;
664 if (!o->file_size_high)
665 o->file_size_high = o->file_size_low;
667 if (o->start_delay_high)
668 o->start_delay = get_rand_start_delay(td);
670 if (o->norandommap && o->verify != VERIFY_NONE
671 && !fixed_block_size(o)) {
672 log_err("fio: norandommap given for variable block sizes, "
674 ret = warnings_fatal;
676 if (o->bs_unaligned && (o->odirect || td_ioengine_flagged(td, FIO_RAWIO)))
677 log_err("fio: bs_unaligned may not work with raw io\n");
680 * thinktime_spin must be less than thinktime
682 if (o->thinktime_spin > o->thinktime)
683 o->thinktime_spin = o->thinktime;
686 * The low water mark cannot be bigger than the iodepth
688 if (o->iodepth_low > o->iodepth || !o->iodepth_low)
689 o->iodepth_low = o->iodepth;
692 * If batch number isn't set, default to the same as iodepth
694 if (o->iodepth_batch > o->iodepth || !o->iodepth_batch)
695 o->iodepth_batch = o->iodepth;
698 * If max batch complete number isn't set or set incorrectly,
699 * default to the same as iodepth_batch_complete_min
701 if (o->iodepth_batch_complete_min > o->iodepth_batch_complete_max)
702 o->iodepth_batch_complete_max = o->iodepth_batch_complete_min;
704 if (o->nr_files > td->files_index)
705 o->nr_files = td->files_index;
707 if (o->open_files > o->nr_files || !o->open_files)
708 o->open_files = o->nr_files;
710 if (((o->rate[DDIR_READ] + o->rate[DDIR_WRITE] + o->rate[DDIR_TRIM]) &&
711 (o->rate_iops[DDIR_READ] + o->rate_iops[DDIR_WRITE] + o->rate_iops[DDIR_TRIM])) ||
712 ((o->ratemin[DDIR_READ] + o->ratemin[DDIR_WRITE] + o->ratemin[DDIR_TRIM]) &&
713 (o->rate_iops_min[DDIR_READ] + o->rate_iops_min[DDIR_WRITE] + o->rate_iops_min[DDIR_TRIM]))) {
714 log_err("fio: rate and rate_iops are mutually exclusive\n");
717 if ((o->rate[DDIR_READ] && (o->rate[DDIR_READ] < o->ratemin[DDIR_READ])) ||
718 (o->rate[DDIR_WRITE] && (o->rate[DDIR_WRITE] < o->ratemin[DDIR_WRITE])) ||
719 (o->rate[DDIR_TRIM] && (o->rate[DDIR_TRIM] < o->ratemin[DDIR_TRIM])) ||
720 (o->rate_iops[DDIR_READ] && (o->rate_iops[DDIR_READ] < o->rate_iops_min[DDIR_READ])) ||
721 (o->rate_iops[DDIR_WRITE] && (o->rate_iops[DDIR_WRITE] < o->rate_iops_min[DDIR_WRITE])) ||
722 (o->rate_iops[DDIR_TRIM] && (o->rate_iops[DDIR_TRIM] < o->rate_iops_min[DDIR_TRIM]))) {
723 log_err("fio: minimum rate exceeds rate\n");
727 if (!o->timeout && o->time_based) {
728 log_err("fio: time_based requires a runtime/timeout setting\n");
730 ret = warnings_fatal;
733 if (o->fill_device && !o->size)
736 if (o->verify != VERIFY_NONE) {
737 if (td_write(td) && o->do_verify && o->numjobs > 1) {
738 log_info("Multiple writers may overwrite blocks that "
739 "belong to other jobs. This can cause "
740 "verification failures.\n");
741 ret = warnings_fatal;
744 if (!fio_option_is_set(o, refill_buffers))
745 o->refill_buffers = 1;
747 if (o->max_bs[DDIR_WRITE] != o->min_bs[DDIR_WRITE] &&
749 o->verify_interval = o->min_bs[DDIR_WRITE];
752 * Verify interval must be smaller or equal to the
755 if (o->verify_interval > o->min_bs[DDIR_WRITE])
756 o->verify_interval = o->min_bs[DDIR_WRITE];
757 else if (td_read(td) && o->verify_interval > o->min_bs[DDIR_READ])
758 o->verify_interval = o->min_bs[DDIR_READ];
762 o->invalidate_cache = 0;
763 if (td_ioengine_flagged(td, FIO_PIPEIO)) {
764 log_info("fio: cannot pre-read files with an IO engine"
765 " that isn't seekable. Pre-read disabled.\n");
766 ret = warnings_fatal;
771 if (td_ioengine_flagged(td, FIO_BIT_BASED))
777 #ifndef CONFIG_FDATASYNC
778 if (o->fdatasync_blocks) {
779 log_info("fio: this platform does not support fdatasync()"
780 " falling back to using fsync(). Use the 'fsync'"
781 " option instead of 'fdatasync' to get rid of"
783 o->fsync_blocks = o->fdatasync_blocks;
784 o->fdatasync_blocks = 0;
785 ret = warnings_fatal;
791 * Windows doesn't support O_DIRECT or O_SYNC with the _open interface,
792 * so fail if we're passed those flags
794 if (td_ioengine_flagged(td, FIO_SYNCIO) && (td->o.odirect || td->o.sync_io)) {
795 log_err("fio: Windows does not support direct or non-buffered io with"
796 " the synchronous ioengines. Use the 'windowsaio' ioengine"
797 " with 'direct=1' and 'iodepth=1' instead.\n");
803 * For fully compressible data, just zero them at init time.
804 * It's faster than repeatedly filling it. For non-zero
805 * compression, we should have refill_buffers set. Set it, unless
806 * the job file already changed it.
808 if (o->compress_percentage) {
809 if (o->compress_percentage == 100) {
811 o->compress_percentage = 0;
812 } else if (!fio_option_is_set(o, refill_buffers))
813 o->refill_buffers = 1;
817 * Using a non-uniform random distribution excludes usage of
820 if (td->o.random_distribution != FIO_RAND_DIST_RANDOM)
821 td->o.norandommap = 1;
824 * If size is set but less than the min block size, complain
826 if (o->size && o->size < td_min_bs(td)) {
827 log_err("fio: size too small, must not be less than minimum block size: %llu < %u\n",
828 (unsigned long long) o->size, td_min_bs(td));
833 * O_ATOMIC implies O_DIRECT
839 * If randseed is set, that overrides randrepeat
841 if (fio_option_is_set(&td->o, rand_seed))
842 td->o.rand_repeatable = 0;
844 if (td_ioengine_flagged(td, FIO_NOEXTEND) && td->o.file_append) {
845 log_err("fio: can't append/extent with IO engine %s\n", td->io_ops->name);
849 if (fio_option_is_set(o, gtod_cpu)) {
851 fio_gtod_set_cpu(o->gtod_cpu);
852 fio_gtod_offload = 1;
855 td->loops = o->loops;
859 if (td->o.block_error_hist && td->o.nr_files != 1) {
860 log_err("fio: block error histogram only available "
861 "with a single file per job, but %d files "
862 "provided\n", td->o.nr_files);
869 /* External engines are specified by "external:name.o") */
870 static const char *get_engine_name(const char *str)
872 char *p = strstr(str, ":");
878 strip_blank_front(&p);
883 static void init_rand_file_service(struct thread_data *td)
885 unsigned long nranges = td->o.nr_files << FIO_FSERVICE_SHIFT;
886 const unsigned int seed = td->rand_seeds[FIO_RAND_FILE_OFF];
888 if (td->o.file_service_type == FIO_FSERVICE_ZIPF) {
889 zipf_init(&td->next_file_zipf, nranges, td->zipf_theta, seed);
890 zipf_disable_hash(&td->next_file_zipf);
891 } else if (td->o.file_service_type == FIO_FSERVICE_PARETO) {
892 pareto_init(&td->next_file_zipf, nranges, td->pareto_h, seed);
893 zipf_disable_hash(&td->next_file_zipf);
894 } else if (td->o.file_service_type == FIO_FSERVICE_GAUSS) {
895 gauss_init(&td->next_file_gauss, nranges, td->gauss_dev, seed);
896 gauss_disable_hash(&td->next_file_gauss);
900 void td_fill_verify_state_seed(struct thread_data *td)
904 if (td->o.random_generator == FIO_RAND_GEN_TAUSWORTHE64)
909 init_rand_seed(&td->verify_state, td->rand_seeds[FIO_RAND_VER_OFF],
913 static void td_fill_rand_seeds_internal(struct thread_data *td, bool use64)
917 init_rand_seed(&td->bsrange_state, td->rand_seeds[FIO_RAND_BS_OFF], use64);
918 td_fill_verify_state_seed(td);
919 init_rand_seed(&td->rwmix_state, td->rand_seeds[FIO_RAND_MIX_OFF], false);
921 if (td->o.file_service_type == FIO_FSERVICE_RANDOM)
922 init_rand_seed(&td->next_file_state, td->rand_seeds[FIO_RAND_FILE_OFF], use64);
923 else if (td->o.file_service_type & __FIO_FSERVICE_NONUNIFORM)
924 init_rand_file_service(td);
926 init_rand_seed(&td->file_size_state, td->rand_seeds[FIO_RAND_FILE_SIZE_OFF], use64);
927 init_rand_seed(&td->trim_state, td->rand_seeds[FIO_RAND_TRIM_OFF], use64);
928 init_rand_seed(&td->delay_state, td->rand_seeds[FIO_RAND_START_DELAY], use64);
929 init_rand_seed(&td->poisson_state, td->rand_seeds[FIO_RAND_POISSON_OFF], 0);
930 init_rand_seed(&td->dedupe_state, td->rand_seeds[FIO_DEDUPE_OFF], false);
931 init_rand_seed(&td->zone_state, td->rand_seeds[FIO_RAND_ZONE_OFF], false);
936 if (td->o.rand_repeatable)
937 td->rand_seeds[FIO_RAND_BLOCK_OFF] = FIO_RANDSEED * td->thread_number;
939 init_rand_seed(&td->random_state, td->rand_seeds[FIO_RAND_BLOCK_OFF], use64);
941 for (i = 0; i < DDIR_RWDIR_CNT; i++) {
942 struct frand_state *s = &td->seq_rand_state[i];
944 init_rand_seed(s, td->rand_seeds[FIO_RAND_SEQ_RAND_READ_OFF], false);
948 void td_fill_rand_seeds(struct thread_data *td)
952 if (td->o.allrand_repeatable) {
955 for (i = 0; i < FIO_RAND_NR_OFFS; i++)
956 td->rand_seeds[i] = FIO_RANDSEED * td->thread_number
960 if (td->o.random_generator == FIO_RAND_GEN_TAUSWORTHE64)
965 td_fill_rand_seeds_internal(td, use64);
967 init_rand_seed(&td->buf_state, td->rand_seeds[FIO_RAND_BUF_OFF], use64);
968 frand_copy(&td->buf_state_prev, &td->buf_state);
972 * Initializes the ioengine configured for a job, if it has not been done so
975 int ioengine_load(struct thread_data *td)
980 * Engine has already been loaded.
984 if (!td->o.ioengine) {
985 log_err("fio: internal fault, no IO engine specified\n");
989 engine = get_engine_name(td->o.ioengine);
990 td->io_ops = load_ioengine(td, engine);
992 log_err("fio: failed to load engine %s\n", engine);
996 if (td->io_ops->option_struct_size && td->io_ops->options) {
998 * In cases where td->eo is set, clone it for a child thread.
999 * This requires that the parent thread has the same ioengine,
1000 * but that requirement must be enforced by the code which
1001 * cloned the thread.
1003 void *origeo = td->eo;
1005 * Otherwise use the default thread options.
1007 if (!origeo && td != &def_thread && def_thread.eo &&
1008 def_thread.io_ops->options == td->io_ops->options)
1009 origeo = def_thread.eo;
1011 options_init(td->io_ops->options);
1012 td->eo = malloc(td->io_ops->option_struct_size);
1014 * Use the default thread as an option template if this uses the
1015 * same options structure and there are non-default options
1019 memcpy(td->eo, origeo, td->io_ops->option_struct_size);
1020 options_mem_dupe(td->eo, td->io_ops->options);
1022 memset(td->eo, 0, td->io_ops->option_struct_size);
1023 fill_default_options(td->eo, td->io_ops->options);
1025 *(struct thread_data **)td->eo = td;
1029 td->io_ops->flags |= FIO_RAWIO;
1031 td_set_ioengine_flags(td);
1035 static void init_flags(struct thread_data *td)
1037 struct thread_options *o = &td->o;
1039 if (o->verify_backlog)
1040 td->flags |= TD_F_VER_BACKLOG;
1041 if (o->trim_backlog)
1042 td->flags |= TD_F_TRIM_BACKLOG;
1043 if (o->read_iolog_file)
1044 td->flags |= TD_F_READ_IOLOG;
1045 if (o->refill_buffers)
1046 td->flags |= TD_F_REFILL_BUFFERS;
1048 * Always scramble buffers if asked to
1050 if (o->scramble_buffers && fio_option_is_set(o, scramble_buffers))
1051 td->flags |= TD_F_SCRAMBLE_BUFFERS;
1053 * But also scramble buffers, unless we were explicitly asked
1056 if (o->scramble_buffers && !(o->zero_buffers &&
1057 fio_option_is_set(o, zero_buffers)))
1058 td->flags |= TD_F_SCRAMBLE_BUFFERS;
1059 if (o->verify != VERIFY_NONE)
1060 td->flags |= TD_F_VER_NONE;
1062 if (o->verify_async || o->io_submit_mode == IO_MODE_OFFLOAD)
1063 td->flags |= TD_F_NEED_LOCK;
1066 static int setup_random_seeds(struct thread_data *td)
1071 if (!td->o.rand_repeatable && !fio_option_is_set(&td->o, rand_seed))
1072 return init_random_state(td, td->rand_seeds, sizeof(td->rand_seeds));
1074 seed = td->o.rand_seed;
1075 for (i = 0; i < 4; i++)
1076 seed *= 0x9e370001UL;
1078 for (i = 0; i < FIO_RAND_NR_OFFS; i++) {
1079 td->rand_seeds[i] = seed * td->thread_number + i;
1080 seed *= 0x9e370001UL;
1083 td_fill_rand_seeds(td);
1094 static struct fpre_keyword {
1095 const char *keyword;
1098 } fpre_keywords[] = {
1099 { .keyword = "$jobname", .key = FPRE_JOBNAME, },
1100 { .keyword = "$jobnum", .key = FPRE_JOBNUM, },
1101 { .keyword = "$filenum", .key = FPRE_FILENUM, },
1102 { .keyword = NULL, },
1105 static char *make_filename(char *buf, size_t buf_size,struct thread_options *o,
1106 const char *jobname, int jobnum, int filenum)
1108 struct fpre_keyword *f;
1109 char copy[PATH_MAX];
1110 size_t dst_left = PATH_MAX - 1;
1112 if (!o->filename_format || !strlen(o->filename_format)) {
1113 sprintf(buf, "%s.%d.%d", jobname, jobnum, filenum);
1117 for (f = &fpre_keywords[0]; f->keyword; f++)
1118 f->strlen = strlen(f->keyword);
1120 buf[buf_size - 1] = '\0';
1121 strncpy(buf, o->filename_format, buf_size - 1);
1123 memset(copy, 0, sizeof(copy));
1124 for (f = &fpre_keywords[0]; f->keyword; f++) {
1126 size_t pre_len, post_start = 0;
1127 char *str, *dst = copy;
1129 str = strcasestr(buf, f->keyword);
1133 pre_len = str - buf;
1134 if (strlen(str) != f->strlen)
1135 post_start = pre_len + f->strlen;
1138 strncpy(dst, buf, pre_len);
1140 dst_left -= pre_len;
1144 case FPRE_JOBNAME: {
1147 ret = snprintf(dst, dst_left, "%s", jobname);
1150 else if (ret > dst_left) {
1151 log_err("fio: truncated filename\n");
1163 ret = snprintf(dst, dst_left, "%d", jobnum);
1166 else if (ret > dst_left) {
1167 log_err("fio: truncated filename\n");
1176 case FPRE_FILENUM: {
1179 ret = snprintf(dst, dst_left, "%d", filenum);
1182 else if (ret > dst_left) {
1183 log_err("fio: truncated filename\n");
1198 strncpy(dst, buf + post_start, dst_left);
1200 strncpy(buf, copy, buf_size - 1);
1207 bool parse_dryrun(void)
1209 return dump_cmdline || parse_only;
1212 static void gen_log_name(char *name, size_t size, const char *logtype,
1213 const char *logname, unsigned int num,
1214 const char *suf, int per_job)
1217 snprintf(name, size, "%s_%s.%d.%s", logname, logtype, num, suf);
1219 snprintf(name, size, "%s_%s.%s", logname, logtype, suf);
1222 static int check_waitees(char *waitee)
1224 struct thread_data *td;
1227 for_each_td(td, i) {
1228 if (td->subjob_number)
1231 ret += !strcmp(td->o.name, waitee);
1237 static bool wait_for_ok(const char *jobname, struct thread_options *o)
1244 if (!strcmp(jobname, o->wait_for)) {
1245 log_err("%s: a job cannot wait for itself (wait_for=%s).\n",
1246 jobname, o->wait_for);
1250 if (!(nw = check_waitees(o->wait_for))) {
1251 log_err("%s: waitee job %s unknown.\n", jobname, o->wait_for);
1256 log_err("%s: multiple waitees %s found,\n"
1257 "please avoid duplicates when using wait_for option.\n",
1258 jobname, o->wait_for);
1266 * Adds a job to the list of things todo. Sanitizes the various options
1267 * to make sure we don't have conflicts, and initializes various
1270 static int add_job(struct thread_data *td, const char *jobname, int job_add_num,
1271 int recursed, int client_type)
1274 char fname[PATH_MAX];
1275 int numjobs, file_alloced;
1276 struct thread_options *o = &td->o;
1277 char logname[PATH_MAX + 32];
1280 * the def_thread is just for options, it's not a real job
1282 if (td == &def_thread)
1288 * if we are just dumping the output command line, don't add the job
1290 if (parse_dryrun()) {
1295 td->client_type = client_type;
1297 if (profile_td_init(td))
1300 if (ioengine_load(td))
1304 if (!o->filename && !td->files_index && !o->read_iolog_file) {
1307 if (o->nr_files == 1 && exists_and_not_regfile(jobname))
1308 add_file(td, jobname, job_add_num, 0);
1310 for (i = 0; i < o->nr_files; i++)
1311 add_file(td, make_filename(fname, sizeof(fname), o, jobname, job_add_num, i), job_add_num, 0);
1315 if (fixup_options(td))
1319 * Belongs to fixup_options, but o->name is not necessarily set as yet
1321 if (!wait_for_ok(jobname, o))
1327 * IO engines only need this for option callbacks, and the address may
1328 * change in subprocesses.
1331 *(struct thread_data **)td->eo = NULL;
1333 if (td_ioengine_flagged(td, FIO_DISKLESSIO)) {
1336 for_each_file(td, f, i)
1337 f->real_file_size = -1ULL;
1340 td->mutex = fio_mutex_init(FIO_MUTEX_LOCKED);
1342 td->ts.clat_percentiles = o->clat_percentiles;
1343 td->ts.percentile_precision = o->percentile_precision;
1344 memcpy(td->ts.percentile_list, o->percentile_list, sizeof(o->percentile_list));
1346 for (i = 0; i < DDIR_RWDIR_CNT; i++) {
1347 td->ts.clat_stat[i].min_val = ULONG_MAX;
1348 td->ts.slat_stat[i].min_val = ULONG_MAX;
1349 td->ts.lat_stat[i].min_val = ULONG_MAX;
1350 td->ts.bw_stat[i].min_val = ULONG_MAX;
1352 td->ddir_seq_nr = o->ddir_seq_nr;
1354 if ((o->stonewall || o->new_group) && prev_group_jobs) {
1355 prev_group_jobs = 0;
1357 if (groupid == INT_MAX) {
1358 log_err("fio: too many groups defined\n");
1363 td->groupid = groupid;
1366 if (setup_random_seeds(td)) {
1367 td_verror(td, errno, "init_random_state");
1374 if (o->write_lat_log) {
1375 struct log_params p = {
1377 .avg_msec = o->log_avg_msec,
1378 .hist_msec = o->log_hist_msec,
1379 .hist_coarseness = o->log_hist_coarseness,
1380 .log_type = IO_LOG_TYPE_LAT,
1381 .log_offset = o->log_offset,
1382 .log_gz = o->log_gz,
1383 .log_gz_store = o->log_gz_store,
1385 const char *pre = o->lat_log_file ? o->lat_log_file : o->name;
1393 gen_log_name(logname, sizeof(logname), "lat", pre,
1394 td->thread_number, suf, o->per_job_logs);
1395 setup_log(&td->lat_log, &p, logname);
1397 gen_log_name(logname, sizeof(logname), "slat", pre,
1398 td->thread_number, suf, o->per_job_logs);
1399 setup_log(&td->slat_log, &p, logname);
1401 gen_log_name(logname, sizeof(logname), "clat", pre,
1402 td->thread_number, suf, o->per_job_logs);
1403 setup_log(&td->clat_log, &p, logname);
1406 if (o->write_hist_log) {
1407 struct log_params p = {
1409 .avg_msec = o->log_avg_msec,
1410 .hist_msec = o->log_hist_msec,
1411 .hist_coarseness = o->log_hist_coarseness,
1412 .log_type = IO_LOG_TYPE_HIST,
1413 .log_offset = o->log_offset,
1414 .log_gz = o->log_gz,
1415 .log_gz_store = o->log_gz_store,
1417 const char *pre = o->hist_log_file ? o->hist_log_file : o->name;
1421 if (td->client_type) {
1422 log_err("fio: --write_hist_log requires zlib in client/server mode\n");
1432 gen_log_name(logname, sizeof(logname), "clat_hist", pre,
1433 td->thread_number, suf, o->per_job_logs);
1434 setup_log(&td->clat_hist_log, &p, logname);
1437 if (o->write_bw_log) {
1438 struct log_params p = {
1440 .avg_msec = o->log_avg_msec,
1441 .hist_msec = o->log_hist_msec,
1442 .hist_coarseness = o->log_hist_coarseness,
1443 .log_type = IO_LOG_TYPE_BW,
1444 .log_offset = o->log_offset,
1445 .log_gz = o->log_gz,
1446 .log_gz_store = o->log_gz_store,
1448 const char *pre = o->bw_log_file ? o->bw_log_file : o->name;
1451 if (fio_option_is_set(o, bw_avg_time))
1452 p.avg_msec = min(o->log_avg_msec, o->bw_avg_time);
1454 o->bw_avg_time = p.avg_msec;
1456 p.hist_msec = o->log_hist_msec;
1457 p.hist_coarseness = o->log_hist_coarseness;
1464 gen_log_name(logname, sizeof(logname), "bw", pre,
1465 td->thread_number, suf, o->per_job_logs);
1466 setup_log(&td->bw_log, &p, logname);
1468 if (o->write_iops_log) {
1469 struct log_params p = {
1471 .avg_msec = o->log_avg_msec,
1472 .hist_msec = o->log_hist_msec,
1473 .hist_coarseness = o->log_hist_coarseness,
1474 .log_type = IO_LOG_TYPE_IOPS,
1475 .log_offset = o->log_offset,
1476 .log_gz = o->log_gz,
1477 .log_gz_store = o->log_gz_store,
1479 const char *pre = o->iops_log_file ? o->iops_log_file : o->name;
1482 if (fio_option_is_set(o, iops_avg_time))
1483 p.avg_msec = min(o->log_avg_msec, o->iops_avg_time);
1485 o->iops_avg_time = p.avg_msec;
1487 p.hist_msec = o->log_hist_msec;
1488 p.hist_coarseness = o->log_hist_coarseness;
1495 gen_log_name(logname, sizeof(logname), "iops", pre,
1496 td->thread_number, suf, o->per_job_logs);
1497 setup_log(&td->iops_log, &p, logname);
1501 o->name = strdup(jobname);
1503 if (output_format & FIO_OUTPUT_NORMAL) {
1505 if (is_backend && !recursed)
1506 fio_server_send_add_job(td);
1508 if (!td_ioengine_flagged(td, FIO_NOIO)) {
1509 char *c1, *c2, *c3, *c4;
1510 char *c5 = NULL, *c6 = NULL;
1511 int i2p = is_power_of_2(o->kb_base);
1513 c1 = num2str(o->min_bs[DDIR_READ], 4, 1, i2p, N2S_BYTE);
1514 c2 = num2str(o->max_bs[DDIR_READ], 4, 1, i2p, N2S_BYTE);
1515 c3 = num2str(o->min_bs[DDIR_WRITE], 4, 1, i2p, N2S_BYTE);
1516 c4 = num2str(o->max_bs[DDIR_WRITE], 4, 1, i2p, N2S_BYTE);
1518 if (!o->bs_is_seq_rand) {
1519 c5 = num2str(o->min_bs[DDIR_TRIM], 4, 1, i2p, N2S_BYTE);
1520 c6 = num2str(o->max_bs[DDIR_TRIM], 4, 1, i2p, N2S_BYTE);
1523 log_info("%s: (g=%d): rw=%s, ", td->o.name,
1525 ddir_str(o->td_ddir));
1527 if (o->bs_is_seq_rand)
1528 log_info("bs=%s-%s,%s-%s, bs_is_seq_rand, ",
1531 log_info("bs=%s-%s,%s-%s,%s-%s, ",
1532 c1, c2, c3, c4, c5, c6);
1534 log_info("ioengine=%s, iodepth=%u\n",
1535 td->io_ops->name, o->iodepth);
1544 } else if (job_add_num == 1)
1548 if (td_steadystate_init(td))
1552 * recurse add identical jobs, clear numjobs and stonewall options
1553 * as they don't apply to sub-jobs
1555 numjobs = o->numjobs;
1557 struct thread_data *td_new = get_new_job(0, td, 1, jobname);
1562 td_new->o.numjobs = 1;
1563 td_new->o.stonewall = 0;
1564 td_new->o.new_group = 0;
1565 td_new->subjob_number = numjobs;
1566 td_new->o.ss_dur = o->ss_dur * 1000000l;
1567 td_new->o.ss_limit = o->ss_limit;
1570 if (td_new->files) {
1572 for_each_file(td_new, f, i) {
1574 sfree(f->file_name);
1577 free(td_new->files);
1578 td_new->files = NULL;
1580 td_new->files_index = 0;
1581 td_new->files_size = 0;
1582 if (td_new->o.filename) {
1583 free(td_new->o.filename);
1584 td_new->o.filename = NULL;
1588 if (add_job(td_new, jobname, numjobs, 1, client_type))
1599 * Parse as if 'o' was a command line
1601 void add_job_opts(const char **o, int client_type)
1603 struct thread_data *td, *td_parent;
1604 int i, in_global = 1;
1608 td_parent = td = NULL;
1610 if (!strncmp(o[i], "name", 4)) {
1613 add_job(td, jobname, 0, 0, client_type);
1615 sprintf(jobname, "%s", o[i] + 5);
1617 if (in_global && !td_parent)
1618 td_parent = get_new_job(1, &def_thread, 0, jobname);
1619 else if (!in_global && !td) {
1621 td_parent = &def_thread;
1622 td = get_new_job(0, td_parent, 0, jobname);
1625 fio_options_parse(td_parent, (char **) &o[i], 1);
1627 fio_options_parse(td, (char **) &o[i], 1);
1632 add_job(td, jobname, 0, 0, client_type);
1635 static int skip_this_section(const char *name)
1639 if (!nr_job_sections)
1641 if (!strncmp(name, "global", 6))
1644 for (i = 0; i < nr_job_sections; i++)
1645 if (!strcmp(job_sections[i], name))
1651 static int is_empty_or_comment(char *line)
1655 for (i = 0; i < strlen(line); i++) {
1660 if (!isspace((int) line[i]) && !iscntrl((int) line[i]))
1668 * This is our [ini] type file parser.
1670 static int __parse_jobs_ini(struct thread_data *td,
1671 char *file, int is_buf, int stonewall_flag, int type,
1672 int nested, char *name, char ***popts, int *aopts, int *nopts)
1674 unsigned int global = 0;
1678 int ret = 0, stonewall;
1681 int inside_skip = 0;
1683 int i, alloc_opts, num_opts;
1685 dprint(FD_PARSE, "Parsing ini file %s\n", file);
1686 assert(td || !nested);
1691 if (!strcmp(file, "-"))
1694 f = fopen(file, "r");
1699 log_err("fio: unable to open '%s' job file\n", file);
1701 td_verror(td, __err, "job file open");
1706 string = malloc(4096);
1709 * it's really 256 + small bit, 280 should suffice
1713 memset(name, 0, 280);
1717 if (nested && popts) {
1719 alloc_opts = *aopts;
1725 opts = malloc(sizeof(char *) * alloc_opts);
1729 stonewall = stonewall_flag;
1732 * if skip_fgets is set, we already have loaded a line we
1737 p = strsep(&file, "\n");
1739 p = fgets(string, 4096, f);
1745 strip_blank_front(&p);
1748 dprint(FD_PARSE, "%s\n", p);
1749 if (is_empty_or_comment(p))
1753 if (sscanf(p, "[%255[^\n]]", name) != 1) {
1757 log_err("fio: option <%s> outside of "
1758 "[] job section\n", p);
1763 name[strlen(name) - 1] = '\0';
1765 if (skip_this_section(name)) {
1771 dprint(FD_PARSE, "Parsing section [%s]\n", name);
1773 global = !strncmp(name, "global", 6);
1779 log_info("--name=%s ", name);
1783 td = get_new_job(global, &def_thread, 0, name);
1790 * Separate multiple job files by a stonewall
1792 if (!global && stonewall) {
1793 td->o.stonewall = stonewall;
1798 memset(opts, 0, alloc_opts * sizeof(char *));
1806 p = strsep(&file, "\n");
1808 p = fgets(string, 4096, f);
1811 dprint(FD_PARSE, "%s", p);
1816 if (is_empty_or_comment(p))
1819 strip_blank_front(&p);
1822 * new section, break out and make sure we don't
1823 * fgets() a new line at the top.
1827 log_err("No new sections in included files\n");
1837 if (!strncmp(p, "include", strlen("include"))) {
1838 char *filename = p + strlen("include") + 1,
1839 *ts, *full_fn = NULL;
1842 * Allow for the include filename
1843 * specification to be relative.
1845 if (access(filename, F_OK) &&
1846 (ts = strrchr(file, '/'))) {
1847 int len = ts - file +
1848 strlen(filename) + 2;
1850 if (!(full_fn = calloc(1, len))) {
1856 file, (ts - file) + 1);
1857 strncpy(full_fn + (ts - file) + 1,
1858 filename, strlen(filename));
1859 full_fn[len - 1] = 0;
1863 ret = __parse_jobs_ini(td, filename, is_buf,
1864 stonewall_flag, type, 1,
1866 &alloc_opts, &num_opts);
1869 log_err("Error %d while parsing "
1870 "include file %s\n",
1883 if (num_opts == alloc_opts) {
1885 opts = realloc(opts,
1886 alloc_opts * sizeof(char *));
1889 opts[num_opts] = strdup(p);
1895 *aopts = alloc_opts;
1900 ret = fio_options_parse(td, opts, num_opts);
1905 ret = add_job(td, name, 0, 0, type);
1907 log_err("fio: job %s dropped\n", name);
1911 for (i = 0; i < num_opts; i++)
1920 while (i < nr_job_sections) {
1921 free(job_sections[i]);
1930 if (!is_buf && f != stdin)
1935 int parse_jobs_ini(char *file, int is_buf, int stonewall_flag, int type)
1937 return __parse_jobs_ini(NULL, file, is_buf, stonewall_flag, type,
1938 0, NULL, NULL, NULL, NULL);
1941 static int fill_def_thread(void)
1943 memset(&def_thread, 0, sizeof(def_thread));
1944 INIT_FLIST_HEAD(&def_thread.opt_list);
1946 fio_getaffinity(getpid(), &def_thread.o.cpumask);
1947 def_thread.o.error_dump = 1;
1950 * fill default options
1952 fio_fill_default_options(&def_thread);
1956 static void show_debug_categories(void)
1958 #ifdef FIO_INC_DEBUG
1959 struct debug_level *dl = &debug_levels[0];
1960 int curlen, first = 1;
1964 int has_next = (dl + 1)->name != NULL;
1966 if (first || curlen + strlen(dl->name) >= 80) {
1971 curlen += printf("\t\t\t%s", dl->name);
1972 curlen += 3 * (8 - 1);
1974 curlen += printf(",");
1976 curlen += printf("%s", dl->name);
1978 curlen += printf(",");
1988 * Following options aren't printed by usage().
1989 * --append-terse - Equivalent to --output-format=terse, see f6a7df53.
1990 * --latency-log - Deprecated option.
1992 static void usage(const char *name)
1994 printf("%s\n", fio_version_string);
1995 printf("%s [options] [job options] <job file(s)>\n", name);
1996 printf(" --debug=options\tEnable debug logging. May be one/more of:\n");
1997 show_debug_categories();
1998 printf(" --parse-only\t\tParse options only, don't start any IO\n");
1999 printf(" --output\t\tWrite output to file\n");
2000 printf(" --runtime\t\tRuntime in seconds\n");
2001 printf(" --bandwidth-log\tGenerate aggregate bandwidth logs\n");
2002 printf(" --minimal\t\tMinimal (terse) output\n");
2003 printf(" --output-format=type\tOutput format (terse,json,json+,normal)\n");
2004 printf(" --terse-version=type\tSet terse version output format"
2005 " (default 3, or 2 or 4)\n");
2006 printf(" --version\t\tPrint version info and exit\n");
2007 printf(" --help\t\tPrint this page\n");
2008 printf(" --cpuclock-test\tPerform test/validation of CPU clock\n");
2009 printf(" --crctest=type\tTest speed of checksum functions\n");
2010 printf(" --cmdhelp=cmd\t\tPrint command help, \"all\" for all of"
2012 printf(" --enghelp=engine\tPrint ioengine help, or list"
2013 " available ioengines\n");
2014 printf(" --enghelp=engine,cmd\tPrint help for an ioengine"
2016 printf(" --showcmd\t\tTurn a job file into command line options\n");
2017 printf(" --eta=when\t\tWhen ETA estimate should be printed\n");
2018 printf(" \t\tMay be \"always\", \"never\" or \"auto\"\n");
2019 printf(" --eta-newline=time\tForce a new line for every 'time'");
2020 printf(" period passed\n");
2021 printf(" --status-interval=t\tForce full status dump every");
2022 printf(" 't' period passed\n");
2023 printf(" --readonly\t\tTurn on safety read-only checks, preventing"
2025 printf(" --section=name\tOnly run specified section in job file,"
2026 " multiple sections can be specified\n");
2027 printf(" --alloc-size=kb\tSet smalloc pool to this size in kb"
2029 printf(" --warnings-fatal\tFio parser warnings are fatal\n");
2030 printf(" --max-jobs=nr\t\tMaximum number of threads/processes to support\n");
2031 printf(" --server=args\t\tStart a backend fio server\n");
2032 printf(" --daemonize=pidfile\tBackground fio server, write pid to file\n");
2033 printf(" --client=hostname\tTalk to remote backend(s) fio server at hostname\n");
2034 printf(" --remote-config=file\tTell fio server to load this local job file\n");
2035 printf(" --idle-prof=option\tReport cpu idleness on a system or percpu basis\n"
2036 "\t\t\t(option=system,percpu) or run unit work\n"
2037 "\t\t\tcalibration only (option=calibrate)\n");
2039 printf(" --inflate-log=log\tInflate and output compressed log\n");
2041 printf(" --trigger-file=file\tExecute trigger cmd when file exists\n");
2042 printf(" --trigger-timeout=t\tExecute trigger af this time\n");
2043 printf(" --trigger=cmd\t\tSet this command as local trigger\n");
2044 printf(" --trigger-remote=cmd\tSet this command as remote trigger\n");
2045 printf(" --aux-path=path\tUse this path for fio state generated files\n");
2046 printf("\nFio was written by Jens Axboe <jens.axboe@oracle.com>");
2047 printf("\n Jens Axboe <jaxboe@fusionio.com>");
2048 printf("\n Jens Axboe <axboe@fb.com>\n");
2051 #ifdef FIO_INC_DEBUG
2052 struct debug_level debug_levels[] = {
2053 { .name = "process",
2054 .help = "Process creation/exit logging",
2055 .shift = FD_PROCESS,
2058 .help = "File related action logging",
2062 .help = "IO and IO engine action logging (offsets, queue, completions, etc)",
2066 .help = "Memory allocation/freeing logging",
2069 { .name = "blktrace",
2070 .help = "blktrace action logging",
2071 .shift = FD_BLKTRACE,
2074 .help = "IO verification action logging",
2078 .help = "Random generation logging",
2082 .help = "Parser logging",
2085 { .name = "diskutil",
2086 .help = "Disk utility logging actions",
2087 .shift = FD_DISKUTIL,
2090 .help = "Logging related to creating/destroying jobs",
2094 .help = "Mutex logging",
2097 { .name = "profile",
2098 .help = "Logging related to profiles",
2099 .shift = FD_PROFILE,
2102 .help = "Logging related to time keeping functions",
2106 .help = "Network logging",
2110 .help = "Rate logging",
2113 { .name = "compress",
2114 .help = "Log compression logging",
2115 .shift = FD_COMPRESS,
2117 { .name = "steadystate",
2118 .help = "Steady state detection logging",
2119 .shift = FD_STEADYSTATE,
2121 { .name = "helperthread",
2122 .help = "Helper thread logging",
2123 .shift = FD_HELPERTHREAD,
2128 static int set_debug(const char *string)
2130 struct debug_level *dl;
2131 char *p = (char *) string;
2138 if (!strcmp(string, "?") || !strcmp(string, "help")) {
2139 log_info("fio: dumping debug options:");
2140 for (i = 0; debug_levels[i].name; i++) {
2141 dl = &debug_levels[i];
2142 log_info("%s,", dl->name);
2148 while ((opt = strsep(&p, ",")) != NULL) {
2151 if (!strncmp(opt, "all", 3)) {
2152 log_info("fio: set all debug options\n");
2157 for (i = 0; debug_levels[i].name; i++) {
2158 dl = &debug_levels[i];
2159 found = !strncmp(opt, dl->name, strlen(dl->name));
2163 if (dl->shift == FD_JOB) {
2164 opt = strchr(opt, ':');
2166 log_err("fio: missing job number\n");
2170 fio_debug_jobno = atoi(opt);
2171 log_info("fio: set debug jobno %d\n",
2174 log_info("fio: set debug option %s\n", opt);
2175 fio_debug |= (1UL << dl->shift);
2181 log_err("fio: debug mask %s not found\n", opt);
2186 static int set_debug(const char *string)
2188 log_err("fio: debug tracing not included in build\n");
2193 static void fio_options_fill_optstring(void)
2195 char *ostr = cmd_optstr;
2199 while (l_opts[i].name) {
2200 ostr[c++] = l_opts[i].val;
2201 if (l_opts[i].has_arg == required_argument)
2203 else if (l_opts[i].has_arg == optional_argument) {
2212 static int client_flag_set(char c)
2217 while (l_opts[i].name) {
2218 int val = l_opts[i].val;
2220 if (c == (val & 0xff))
2221 return (val & FIO_CLIENT_FLAG);
2229 static void parse_cmd_client(void *client, char *opt)
2231 fio_client_add_cmd_option(client, opt);
2234 static void show_closest_option(const char *name)
2236 int best_option, best_distance;
2239 while (*name == '-')
2243 best_distance = INT_MAX;
2245 while (l_opts[i].name) {
2246 distance = string_distance(name, l_opts[i].name);
2247 if (distance < best_distance) {
2248 best_distance = distance;
2254 if (best_option != -1 && string_distance_ok(name, best_distance))
2255 log_err("Did you mean %s?\n", l_opts[best_option].name);
2258 static int parse_output_format(const char *optarg)
2260 char *p, *orig, *opt;
2263 p = orig = strdup(optarg);
2267 while ((opt = strsep(&p, ",")) != NULL) {
2268 if (!strcmp(opt, "minimal") ||
2269 !strcmp(opt, "terse") ||
2270 !strcmp(opt, "csv"))
2271 output_format |= FIO_OUTPUT_TERSE;
2272 else if (!strcmp(opt, "json"))
2273 output_format |= FIO_OUTPUT_JSON;
2274 else if (!strcmp(opt, "json+"))
2275 output_format |= (FIO_OUTPUT_JSON | FIO_OUTPUT_JSON_PLUS);
2276 else if (!strcmp(opt, "normal"))
2277 output_format |= FIO_OUTPUT_NORMAL;
2279 log_err("fio: invalid output format %s\n", opt);
2289 int parse_cmd_line(int argc, char *argv[], int client_type)
2291 struct thread_data *td = NULL;
2292 int c, ini_idx = 0, lidx, ret = 0, do_exit = 0, exit_val = 0;
2293 char *ostr = cmd_optstr;
2294 char *pid_file = NULL;
2295 void *cur_client = NULL;
2299 * Reset optind handling, since we may call this multiple times
2304 while ((c = getopt_long_only(argc, argv, ostr, l_opts, &lidx)) != -1) {
2305 if ((c & FIO_CLIENT_FLAG) || client_flag_set(c)) {
2306 parse_cmd_client(cur_client, argv[optind - 1]);
2307 c &= ~FIO_CLIENT_FLAG;
2312 smalloc_pool_size = atoi(optarg);
2313 smalloc_pool_size <<= 10;
2317 if (check_str_time(optarg, &def_timeout, 1)) {
2318 log_err("fio: failed parsing time %s\n", optarg);
2324 log_err("fio: --latency-log is deprecated. Use per-job latency log options.\n");
2332 if (f_out && f_out != stdout)
2335 f_out = fopen(optarg, "w+");
2337 perror("fopen output");
2343 output_format = FIO_OUTPUT_TERSE;
2346 if (parse_output_format(optarg)) {
2347 log_err("fio: failed parsing output-format\n");
2354 output_format |= FIO_OUTPUT_TERSE;
2366 fio_show_option_help(optarg);
2373 fio_show_ioengine_help(optarg);
2387 log_info("%s\n", fio_version_string);
2392 terse_version = atoi(optarg);
2393 if (!(terse_version == 2 || terse_version == 3 ||
2394 terse_version == 4)) {
2395 log_err("fio: bad terse version format\n");
2401 if (!strcmp("always", optarg))
2402 eta_print = FIO_ETA_ALWAYS;
2403 else if (!strcmp("never", optarg))
2404 eta_print = FIO_ETA_NEVER;
2409 if (check_str_time(optarg, &t, 1)) {
2410 log_err("fio: failed parsing eta time %s\n", optarg);
2414 eta_new_line = t / 1000;
2418 if (set_debug(optarg))
2428 if (!strcmp(optarg, "global")) {
2429 log_err("fio: can't use global as only "
2435 new_size = (nr_job_sections + 1) * sizeof(char *);
2436 job_sections = realloc(job_sections, new_size);
2437 job_sections[nr_job_sections] = strdup(optarg);
2443 exit_val = iolog_file_inflate(optarg);
2452 exec_profile = strdup(optarg);
2454 case FIO_GETOPT_JOB: {
2455 const char *opt = l_opts[lidx].name;
2458 if (!strncmp(opt, "name", 4) && td) {
2459 ret = add_job(td, td->o.name ?: "fio", 0, 0, client_type);
2466 int is_section = !strncmp(opt, "name", 4);
2469 if (!is_section || !strncmp(val, "global", 6))
2472 if (is_section && skip_this_section(val))
2475 td = get_new_job(global, &def_thread, 1, NULL);
2476 if (!td || ioengine_load(td)) {
2485 fio_options_set_ioengine_opts(l_opts, td);
2488 if ((!val || !strlen(val)) &&
2489 l_opts[lidx].has_arg == required_argument) {
2490 log_err("fio: option %s requires an argument\n", opt);
2493 ret = fio_cmd_option_parse(td, opt, val);
2504 if (!ret && !strcmp(opt, "ioengine")) {
2506 if (ioengine_load(td)) {
2513 fio_options_set_ioengine_opts(l_opts, td);
2517 case FIO_GETOPT_IOENGINE: {
2518 const char *opt = l_opts[lidx].name;
2524 ret = fio_cmd_ioengine_option_parse(td, opt, val);
2531 max_jobs = atoi(optarg);
2532 if (!max_jobs || max_jobs > REAL_MAX_JOBS) {
2533 log_err("fio: invalid max jobs: %d\n", max_jobs);
2540 #ifndef CONFIG_NO_SHM
2542 log_err("fio: can't be both client and server\n");
2548 fio_server_set_arg(optarg);
2552 log_err("fio: client/server requires SHM support\n");
2560 pid_file = strdup(optarg);
2563 if ((ret = fio_idle_prof_parse_opt(optarg))) {
2564 /* exit on error and calibration only */
2574 log_err("fio: can't be both client and server\n");
2579 /* if --client parameter contains a pathname */
2580 if (0 == access(optarg, R_OK)) {
2581 /* file contains a list of host addrs or names */
2582 char hostaddr[PATH_MAX] = {0};
2584 FILE * hostf = fopen(optarg, "r");
2586 log_err("fio: could not open client list file %s for read\n", optarg);
2591 sprintf(formatstr, "%%%ds", PATH_MAX - 1);
2593 * read at most PATH_MAX-1 chars from each
2594 * record in this file
2596 while (fscanf(hostf, formatstr, hostaddr) == 1) {
2597 /* expect EVERY host in file to be valid */
2598 if (fio_client_add(&fio_client_ops, hostaddr, &cur_client)) {
2599 log_err("fio: failed adding client %s from file %s\n", hostaddr, optarg);
2606 break; /* no possibility of job file for "this client only" */
2608 if (fio_client_add(&fio_client_ops, optarg, &cur_client)) {
2609 log_err("fio: failed adding client %s\n", optarg);
2615 * If the next argument exists and isn't an option,
2616 * assume it's a job file for this client only.
2618 while (optind < argc) {
2619 if (!strncmp(argv[optind], "--", 2) ||
2620 !strncmp(argv[optind], "-", 1))
2623 if (fio_client_add_ini_file(cur_client, argv[optind], false))
2630 if (fio_client_add_ini_file(cur_client, optarg, true)) {
2638 exit_val = fio_monotonic_clocktest(1);
2643 exit_val = fio_crctest(optarg);
2648 if (check_str_time(optarg, &val, 1)) {
2649 log_err("fio: failed parsing time %s\n", optarg);
2654 status_interval = val / 1000;
2660 trigger_file = strdup(optarg);
2665 trigger_cmd = strdup(optarg);
2668 if (trigger_remote_cmd)
2669 free(trigger_remote_cmd);
2670 trigger_remote_cmd = strdup(optarg);
2675 aux_path = strdup(optarg);
2678 if (check_str_time(optarg, &trigger_timeout, 1)) {
2679 log_err("fio: failed parsing time %s\n", optarg);
2683 trigger_timeout /= 1000000;
2686 log_err("%s: unrecognized option '%s'\n", argv[0],
2688 show_closest_option(argv[optind - 1]);
2698 if (do_exit && !(is_backend || nr_clients))
2701 if (nr_clients && fio_clients_connect())
2704 if (is_backend && backend)
2705 return fio_start_server(pid_file);
2711 ret = add_job(td, td->o.name ?: "fio", 0, 0, client_type);
2717 while (!ret && optind < argc) {
2719 ini_file = realloc(ini_file, ini_idx * sizeof(char *));
2720 ini_file[ini_idx - 1] = strdup(argv[optind]);
2731 int fio_init_options(void)
2736 fio_options_fill_optstring();
2737 fio_options_dup_and_init(l_opts);
2741 if (fill_def_thread())
2747 extern int fio_check_options(struct thread_options *);
2749 int parse_options(int argc, char *argv[])
2751 const int type = FIO_CLIENT_TYPE_CLI;
2754 if (fio_init_options())
2756 if (fio_test_cconv(&def_thread.o))
2757 log_err("fio: failed internal cconv test\n");
2759 job_files = parse_cmd_line(argc, argv, type);
2761 if (job_files > 0) {
2762 for (i = 0; i < job_files; i++) {
2763 if (i && fill_def_thread())
2766 if (fio_clients_send_ini(ini_file[i]))
2769 } else if (!is_backend) {
2770 if (parse_jobs_ini(ini_file[i], 0, i, type))
2775 } else if (nr_clients) {
2776 if (fill_def_thread())
2778 if (fio_clients_send_ini(NULL))
2783 fio_options_free(&def_thread);
2784 filesetup_mem_free();
2786 if (!thread_number) {
2791 if (is_backend || nr_clients)
2796 log_err("No jobs(s) defined\n\n");
2806 if (output_format & FIO_OUTPUT_NORMAL)
2807 log_info("%s\n", fio_version_string);
2812 void options_default_fill(struct thread_options *o)
2814 memcpy(o, &def_thread.o, sizeof(*o));
2817 struct thread_data *get_global_options(void)