2 * This file contains job initialization and setup functions.
12 #include <sys/types.h>
16 #ifndef FIO_NO_HAVE_SHM_H
29 #include "oslib/getopt.h"
30 #include "oslib/strcasestr.h"
34 const char fio_version_string[] = FIO_VERSION;
36 #define FIO_RANDSEED (0xb1899bedUL)
38 static char **ini_file;
39 static int max_jobs = FIO_MAX_JOBS;
40 static int dump_cmdline;
41 static long long def_timeout;
42 static int parse_only;
44 static struct thread_data def_thread;
45 struct thread_data *threads = NULL;
46 static char **job_sections;
47 static int nr_job_sections;
49 int exitall_on_terminate = 0;
50 int output_format = FIO_OUTPUT_NORMAL;
51 int eta_print = FIO_ETA_AUTO;
55 char *exec_profile = NULL;
56 int warnings_fatal = 0;
57 int terse_version = 3;
64 int status_interval = 0;
66 char *trigger_file = NULL;
67 long long trigger_timeout = 0;
68 char *trigger_cmd = NULL;
69 char *trigger_remote_cmd = NULL;
71 char *aux_path = NULL;
73 static int prev_group_jobs;
75 unsigned long fio_debug = 0;
76 unsigned int fio_debug_jobno = -1;
77 unsigned int *fio_debug_jobp = NULL;
79 static char cmd_optstr[256];
82 #define FIO_CLIENT_FLAG (1 << 16)
85 * Command line options. These will contain the above, plus a few
86 * extra that only pertain to fio itself and not jobs.
88 static struct option l_opts[FIO_NR_OPTIONS] = {
90 .name = (char *) "output",
91 .has_arg = required_argument,
92 .val = 'o' | FIO_CLIENT_FLAG,
95 .name = (char *) "timeout",
96 .has_arg = required_argument,
97 .val = 't' | FIO_CLIENT_FLAG,
100 .name = (char *) "latency-log",
101 .has_arg = required_argument,
102 .val = 'l' | FIO_CLIENT_FLAG,
105 .name = (char *) "bandwidth-log",
106 .has_arg = required_argument,
107 .val = 'b' | FIO_CLIENT_FLAG,
110 .name = (char *) "minimal",
111 .has_arg = no_argument,
112 .val = 'm' | FIO_CLIENT_FLAG,
115 .name = (char *) "output-format",
116 .has_arg = required_argument,
117 .val = 'F' | FIO_CLIENT_FLAG,
120 .name = (char *) "append-terse",
121 .has_arg = optional_argument,
125 .name = (char *) "version",
126 .has_arg = no_argument,
127 .val = 'v' | FIO_CLIENT_FLAG,
130 .name = (char *) "help",
131 .has_arg = no_argument,
132 .val = 'h' | FIO_CLIENT_FLAG,
135 .name = (char *) "cmdhelp",
136 .has_arg = optional_argument,
137 .val = 'c' | FIO_CLIENT_FLAG,
140 .name = (char *) "enghelp",
141 .has_arg = optional_argument,
142 .val = 'i' | FIO_CLIENT_FLAG,
145 .name = (char *) "showcmd",
146 .has_arg = no_argument,
147 .val = 's' | FIO_CLIENT_FLAG,
150 .name = (char *) "readonly",
151 .has_arg = no_argument,
152 .val = 'r' | FIO_CLIENT_FLAG,
155 .name = (char *) "eta",
156 .has_arg = required_argument,
157 .val = 'e' | FIO_CLIENT_FLAG,
160 .name = (char *) "eta-newline",
161 .has_arg = required_argument,
162 .val = 'E' | FIO_CLIENT_FLAG,
165 .name = (char *) "debug",
166 .has_arg = required_argument,
167 .val = 'd' | FIO_CLIENT_FLAG,
170 .name = (char *) "parse-only",
171 .has_arg = no_argument,
172 .val = 'P' | FIO_CLIENT_FLAG,
175 .name = (char *) "section",
176 .has_arg = required_argument,
177 .val = 'x' | FIO_CLIENT_FLAG,
181 .name = (char *) "inflate-log",
182 .has_arg = required_argument,
183 .val = 'X' | FIO_CLIENT_FLAG,
187 .name = (char *) "alloc-size",
188 .has_arg = required_argument,
189 .val = 'a' | FIO_CLIENT_FLAG,
192 .name = (char *) "profile",
193 .has_arg = required_argument,
194 .val = 'p' | FIO_CLIENT_FLAG,
197 .name = (char *) "warnings-fatal",
198 .has_arg = no_argument,
199 .val = 'w' | FIO_CLIENT_FLAG,
202 .name = (char *) "max-jobs",
203 .has_arg = required_argument,
204 .val = 'j' | FIO_CLIENT_FLAG,
207 .name = (char *) "terse-version",
208 .has_arg = required_argument,
209 .val = 'V' | FIO_CLIENT_FLAG,
212 .name = (char *) "server",
213 .has_arg = optional_argument,
216 { .name = (char *) "daemonize",
217 .has_arg = required_argument,
221 .name = (char *) "client",
222 .has_arg = required_argument,
226 .name = (char *) "remote-config",
227 .has_arg = required_argument,
231 .name = (char *) "cpuclock-test",
232 .has_arg = no_argument,
236 .name = (char *) "crctest",
237 .has_arg = optional_argument,
241 .name = (char *) "idle-prof",
242 .has_arg = required_argument,
246 .name = (char *) "status-interval",
247 .has_arg = required_argument,
251 .name = (char *) "trigger-file",
252 .has_arg = required_argument,
256 .name = (char *) "trigger-timeout",
257 .has_arg = required_argument,
261 .name = (char *) "trigger",
262 .has_arg = required_argument,
266 .name = (char *) "trigger-remote",
267 .has_arg = required_argument,
271 .name = (char *) "aux-path",
272 .has_arg = required_argument,
280 void free_threads_shm(void)
284 #ifndef CONFIG_NO_SHM
285 struct shmid_ds sbuf;
289 shmctl(shm_id, IPC_RMID, &sbuf);
298 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);
318 * The thread area is shared between the main process and the job
319 * threads/processes. So setup a shared memory segment that will hold
320 * all the job info. We use the end of the region for keeping track of
321 * open files across jobs, for file sharing.
323 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 += file_hash_size;
338 size += sizeof(unsigned int);
340 #ifndef CONFIG_NO_SHM
341 shm_id = shmget(0, size, IPC_CREAT | 0600);
344 if (errno != EINVAL && errno != ENOMEM && errno != ENOSPC) {
349 threads = malloc(size);
357 #ifndef CONFIG_NO_SHM
361 threads = shmat(shm_id, NULL, 0);
362 if (threads == (void *) -1) {
368 memset(threads, 0, max_jobs * sizeof(struct thread_data));
369 hash = (void *) threads + max_jobs * sizeof(struct thread_data);
370 fio_debug_jobp = (void *) hash + file_hash_size;
371 *fio_debug_jobp = -1;
372 file_hash_init(hash);
379 static void set_cmd_options(struct thread_data *td)
381 struct thread_options *o = &td->o;
384 o->timeout = def_timeout;
387 static void dump_print_option(struct print_option *p)
391 if (!strcmp("description", p->name))
396 log_info("--%s%s", p->name, p->value ? "" : " ");
398 log_info("=%s%s%s ", delim, p->value, delim);
401 static void dump_opt_list(struct thread_data *td)
403 struct flist_head *entry;
404 struct print_option *p;
406 if (flist_empty(&td->opt_list))
409 flist_for_each(entry, &td->opt_list) {
410 p = flist_entry(entry, struct print_option, list);
411 dump_print_option(p);
415 static void fio_dump_options_free(struct thread_data *td)
417 while (!flist_empty(&td->opt_list)) {
418 struct print_option *p;
420 p = flist_first_entry(&td->opt_list, struct print_option, list);
421 flist_del_init(&p->list);
428 static void copy_opt_list(struct thread_data *dst, struct thread_data *src)
430 struct flist_head *entry;
432 if (flist_empty(&src->opt_list))
435 flist_for_each(entry, &src->opt_list) {
436 struct print_option *srcp, *dstp;
438 srcp = flist_entry(entry, struct print_option, list);
439 dstp = malloc(sizeof(*dstp));
440 dstp->name = strdup(srcp->name);
442 dstp->value = strdup(srcp->value);
445 flist_add_tail(&dstp->list, &dst->opt_list);
450 * Return a free job structure.
452 static struct thread_data *get_new_job(int global, struct thread_data *parent,
453 int preserve_eo, const char *jobname)
455 struct thread_data *td;
458 set_cmd_options(&def_thread);
461 if (setup_thread_area()) {
462 log_err("error: failed to setup shm segment\n");
465 if (thread_number >= max_jobs) {
466 log_err("error: maximum number of jobs (%d) reached.\n",
471 td = &threads[thread_number++];
474 INIT_FLIST_HEAD(&td->opt_list);
475 if (parent != &def_thread)
476 copy_opt_list(td, parent);
482 td->o.uid = td->o.gid = -1U;
484 dup_files(td, parent);
485 fio_options_mem_dupe(td);
487 profile_add_hooks(td);
489 td->thread_number = thread_number;
490 td->subjob_number = 0;
493 td->o.name = strdup(jobname);
495 if (!parent->o.group_reporting || parent == &def_thread)
502 static void put_job(struct thread_data *td)
504 if (td == &def_thread)
511 log_info("fio: %s\n", td->verror);
513 fio_options_free(td);
514 fio_dump_options_free(td);
521 memset(&threads[td->thread_number - 1], 0, sizeof(*td));
525 static int __setup_rate(struct thread_data *td, enum fio_ddir ddir)
527 unsigned int bs = td->o.min_bs[ddir];
529 assert(ddir_rw(ddir));
531 if (td->o.rate[ddir])
532 td->rate_bps[ddir] = td->o.rate[ddir];
534 td->rate_bps[ddir] = (uint64_t) td->o.rate_iops[ddir] * bs;
536 if (!td->rate_bps[ddir]) {
537 log_err("rate lower than supported\n");
541 td->rate_next_io_time[ddir] = 0;
542 td->rate_io_issue_bytes[ddir] = 0;
547 static int setup_rate(struct thread_data *td)
551 if (td->o.rate[DDIR_READ] || td->o.rate_iops[DDIR_READ])
552 ret = __setup_rate(td, DDIR_READ);
553 if (td->o.rate[DDIR_WRITE] || td->o.rate_iops[DDIR_WRITE])
554 ret |= __setup_rate(td, DDIR_WRITE);
555 if (td->o.rate[DDIR_TRIM] || td->o.rate_iops[DDIR_TRIM])
556 ret |= __setup_rate(td, DDIR_TRIM);
561 static int fixed_block_size(struct thread_options *o)
563 return o->min_bs[DDIR_READ] == o->max_bs[DDIR_READ] &&
564 o->min_bs[DDIR_WRITE] == o->max_bs[DDIR_WRITE] &&
565 o->min_bs[DDIR_TRIM] == o->max_bs[DDIR_TRIM] &&
566 o->min_bs[DDIR_READ] == o->min_bs[DDIR_WRITE] &&
567 o->min_bs[DDIR_READ] == o->min_bs[DDIR_TRIM];
571 static unsigned long long get_rand_start_delay(struct thread_data *td)
573 unsigned long long delayrange;
577 delayrange = td->o.start_delay_high - td->o.start_delay;
579 frand_max = rand_max(&td->delay_state);
580 r = __rand(&td->delay_state);
581 delayrange = (unsigned long long) ((double) delayrange * (r / (frand_max + 1.0)));
583 delayrange += td->o.start_delay;
588 * Lazy way of fixing up options that depend on each other. We could also
589 * define option callback handlers, but this is easier.
591 static int fixup_options(struct thread_data *td)
593 struct thread_options *o = &td->o;
596 #ifndef FIO_HAVE_PSHARED_MUTEX
597 if (!o->use_thread) {
598 log_info("fio: this platform does not support process shared"
599 " mutexes, forcing use of threads. Use the 'thread'"
600 " option to get rid of this warning.\n");
602 ret = warnings_fatal;
606 if (o->write_iolog_file && o->read_iolog_file) {
607 log_err("fio: read iolog overrides write_iolog\n");
608 free(o->write_iolog_file);
609 o->write_iolog_file = NULL;
610 ret = warnings_fatal;
614 * only really works with 1 file
616 if (o->zone_size && o->open_files > 1)
620 * If zone_range isn't specified, backward compatibility dictates it
621 * should be made equal to zone_size.
623 if (o->zone_size && !o->zone_range)
624 o->zone_range = o->zone_size;
627 * Reads can do overwrites, we always need to pre-create the file
629 if (td_read(td) || td_rw(td))
632 if (!o->min_bs[DDIR_READ])
633 o->min_bs[DDIR_READ] = o->bs[DDIR_READ];
634 if (!o->max_bs[DDIR_READ])
635 o->max_bs[DDIR_READ] = o->bs[DDIR_READ];
636 if (!o->min_bs[DDIR_WRITE])
637 o->min_bs[DDIR_WRITE] = o->bs[DDIR_WRITE];
638 if (!o->max_bs[DDIR_WRITE])
639 o->max_bs[DDIR_WRITE] = o->bs[DDIR_WRITE];
640 if (!o->min_bs[DDIR_TRIM])
641 o->min_bs[DDIR_TRIM] = o->bs[DDIR_TRIM];
642 if (!o->max_bs[DDIR_TRIM])
643 o->max_bs[DDIR_TRIM] = o->bs[DDIR_TRIM];
645 o->rw_min_bs = min(o->min_bs[DDIR_READ], o->min_bs[DDIR_WRITE]);
646 o->rw_min_bs = min(o->min_bs[DDIR_TRIM], o->rw_min_bs);
649 * For random IO, allow blockalign offset other than min_bs.
651 if (!o->ba[DDIR_READ] || !td_random(td))
652 o->ba[DDIR_READ] = o->min_bs[DDIR_READ];
653 if (!o->ba[DDIR_WRITE] || !td_random(td))
654 o->ba[DDIR_WRITE] = o->min_bs[DDIR_WRITE];
655 if (!o->ba[DDIR_TRIM] || !td_random(td))
656 o->ba[DDIR_TRIM] = o->min_bs[DDIR_TRIM];
658 if ((o->ba[DDIR_READ] != o->min_bs[DDIR_READ] ||
659 o->ba[DDIR_WRITE] != o->min_bs[DDIR_WRITE] ||
660 o->ba[DDIR_TRIM] != o->min_bs[DDIR_TRIM]) &&
662 log_err("fio: Any use of blockalign= turns off randommap\n");
664 ret = warnings_fatal;
667 if (!o->file_size_high)
668 o->file_size_high = o->file_size_low;
670 if (o->start_delay_high)
671 o->start_delay = get_rand_start_delay(td);
673 if (o->norandommap && o->verify != VERIFY_NONE
674 && !fixed_block_size(o)) {
675 log_err("fio: norandommap given for variable block sizes, "
677 ret = warnings_fatal;
679 if (o->bs_unaligned && (o->odirect || td_ioengine_flagged(td, FIO_RAWIO)))
680 log_err("fio: bs_unaligned may not work with raw io\n");
683 * thinktime_spin must be less than thinktime
685 if (o->thinktime_spin > o->thinktime)
686 o->thinktime_spin = o->thinktime;
689 * The low water mark cannot be bigger than the iodepth
691 if (o->iodepth_low > o->iodepth || !o->iodepth_low)
692 o->iodepth_low = o->iodepth;
695 * If batch number isn't set, default to the same as iodepth
697 if (o->iodepth_batch > o->iodepth || !o->iodepth_batch)
698 o->iodepth_batch = o->iodepth;
701 * If max batch complete number isn't set or set incorrectly,
702 * default to the same as iodepth_batch_complete_min
704 if (o->iodepth_batch_complete_min > o->iodepth_batch_complete_max)
705 o->iodepth_batch_complete_max = o->iodepth_batch_complete_min;
707 if (o->nr_files > td->files_index)
708 o->nr_files = td->files_index;
710 if (o->open_files > o->nr_files || !o->open_files)
711 o->open_files = o->nr_files;
713 if (((o->rate[DDIR_READ] + o->rate[DDIR_WRITE] + o->rate[DDIR_TRIM]) &&
714 (o->rate_iops[DDIR_READ] + o->rate_iops[DDIR_WRITE] + o->rate_iops[DDIR_TRIM])) ||
715 ((o->ratemin[DDIR_READ] + o->ratemin[DDIR_WRITE] + o->ratemin[DDIR_TRIM]) &&
716 (o->rate_iops_min[DDIR_READ] + o->rate_iops_min[DDIR_WRITE] + o->rate_iops_min[DDIR_TRIM]))) {
717 log_err("fio: rate and rate_iops are mutually exclusive\n");
720 if ((o->rate[DDIR_READ] && (o->rate[DDIR_READ] < o->ratemin[DDIR_READ])) ||
721 (o->rate[DDIR_WRITE] && (o->rate[DDIR_WRITE] < o->ratemin[DDIR_WRITE])) ||
722 (o->rate[DDIR_TRIM] && (o->rate[DDIR_TRIM] < o->ratemin[DDIR_TRIM])) ||
723 (o->rate_iops[DDIR_READ] && (o->rate_iops[DDIR_READ] < o->rate_iops_min[DDIR_READ])) ||
724 (o->rate_iops[DDIR_WRITE] && (o->rate_iops[DDIR_WRITE] < o->rate_iops_min[DDIR_WRITE])) ||
725 (o->rate_iops[DDIR_TRIM] && (o->rate_iops[DDIR_TRIM] < o->rate_iops_min[DDIR_TRIM]))) {
726 log_err("fio: minimum rate exceeds rate\n");
730 if (!o->timeout && o->time_based) {
731 log_err("fio: time_based requires a runtime/timeout setting\n");
733 ret = warnings_fatal;
736 if (o->fill_device && !o->size)
739 if (o->verify != VERIFY_NONE) {
740 if (td_write(td) && o->do_verify && o->numjobs > 1) {
741 log_info("Multiple writers may overwrite blocks that "
742 "belong to other jobs. This can cause "
743 "verification failures.\n");
744 ret = warnings_fatal;
747 if (!fio_option_is_set(o, refill_buffers))
748 o->refill_buffers = 1;
750 if (o->max_bs[DDIR_WRITE] != o->min_bs[DDIR_WRITE] &&
752 o->verify_interval = o->min_bs[DDIR_WRITE];
755 * Verify interval must be smaller or equal to the
758 if (o->verify_interval > o->min_bs[DDIR_WRITE])
759 o->verify_interval = o->min_bs[DDIR_WRITE];
760 else if (td_read(td) && o->verify_interval > o->min_bs[DDIR_READ])
761 o->verify_interval = o->min_bs[DDIR_READ];
765 o->invalidate_cache = 0;
766 if (td_ioengine_flagged(td, FIO_PIPEIO)) {
767 log_info("fio: cannot pre-read files with an IO engine"
768 " that isn't seekable. Pre-read disabled.\n");
769 ret = warnings_fatal;
774 if (td_ioengine_flagged(td, FIO_BIT_BASED))
780 #ifndef CONFIG_FDATASYNC
781 if (o->fdatasync_blocks) {
782 log_info("fio: this platform does not support fdatasync()"
783 " falling back to using fsync(). Use the 'fsync'"
784 " option instead of 'fdatasync' to get rid of"
786 o->fsync_blocks = o->fdatasync_blocks;
787 o->fdatasync_blocks = 0;
788 ret = warnings_fatal;
794 * Windows doesn't support O_DIRECT or O_SYNC with the _open interface,
795 * so fail if we're passed those flags
797 if (td_ioengine_flagged(td, FIO_SYNCIO) && (td->o.odirect || td->o.sync_io)) {
798 log_err("fio: Windows does not support direct or non-buffered io with"
799 " the synchronous ioengines. Use the 'windowsaio' ioengine"
800 " with 'direct=1' and 'iodepth=1' instead.\n");
806 * For fully compressible data, just zero them at init time.
807 * It's faster than repeatedly filling it. For non-zero
808 * compression, we should have refill_buffers set. Set it, unless
809 * the job file already changed it.
811 if (o->compress_percentage) {
812 if (o->compress_percentage == 100) {
814 o->compress_percentage = 0;
815 } else if (!fio_option_is_set(o, refill_buffers))
816 o->refill_buffers = 1;
820 * Using a non-uniform random distribution excludes usage of
823 if (td->o.random_distribution != FIO_RAND_DIST_RANDOM)
824 td->o.norandommap = 1;
827 * If size is set but less than the min block size, complain
829 if (o->size && o->size < td_min_bs(td)) {
830 log_err("fio: size too small, must be larger than the IO size: %llu\n", (unsigned long long) o->size);
835 * O_ATOMIC implies O_DIRECT
841 * If randseed is set, that overrides randrepeat
843 if (fio_option_is_set(&td->o, rand_seed))
844 td->o.rand_repeatable = 0;
846 if (td_ioengine_flagged(td, FIO_NOEXTEND) && td->o.file_append) {
847 log_err("fio: can't append/extent with IO engine %s\n", td->io_ops->name);
851 if (fio_option_is_set(o, gtod_cpu)) {
853 fio_gtod_set_cpu(o->gtod_cpu);
854 fio_gtod_offload = 1;
857 td->loops = o->loops;
861 if (td->o.block_error_hist && td->o.nr_files != 1) {
862 log_err("fio: block error histogram only available "
863 "with a single file per job, but %d files "
864 "provided\n", td->o.nr_files);
872 * This function leaks the buffer
874 char *fio_uint_to_kmg(unsigned int val)
876 char *buf = malloc(32);
877 char post[] = { 0, 'K', 'M', 'G', 'P', 'E', 0 };
888 snprintf(buf, 32, "%u%c", val, *p);
892 /* External engines are specified by "external:name.o") */
893 static const char *get_engine_name(const char *str)
895 char *p = strstr(str, ":");
901 strip_blank_front(&p);
906 static void init_rand_file_service(struct thread_data *td)
908 unsigned long nranges = td->o.nr_files << FIO_FSERVICE_SHIFT;
909 const unsigned int seed = td->rand_seeds[FIO_RAND_FILE_OFF];
911 if (td->o.file_service_type == FIO_FSERVICE_ZIPF) {
912 zipf_init(&td->next_file_zipf, nranges, td->zipf_theta, seed);
913 zipf_disable_hash(&td->next_file_zipf);
914 } else if (td->o.file_service_type == FIO_FSERVICE_PARETO) {
915 pareto_init(&td->next_file_zipf, nranges, td->pareto_h, seed);
916 zipf_disable_hash(&td->next_file_zipf);
917 } else if (td->o.file_service_type == FIO_FSERVICE_GAUSS) {
918 gauss_init(&td->next_file_gauss, nranges, td->gauss_dev, seed);
919 gauss_disable_hash(&td->next_file_gauss);
923 void td_fill_verify_state_seed(struct thread_data *td)
927 if (td->o.random_generator == FIO_RAND_GEN_TAUSWORTHE64)
932 init_rand_seed(&td->verify_state, td->rand_seeds[FIO_RAND_VER_OFF],
936 static void td_fill_rand_seeds_internal(struct thread_data *td, bool use64)
940 init_rand_seed(&td->bsrange_state, td->rand_seeds[FIO_RAND_BS_OFF], use64);
941 td_fill_verify_state_seed(td);
942 init_rand_seed(&td->rwmix_state, td->rand_seeds[FIO_RAND_MIX_OFF], false);
944 if (td->o.file_service_type == FIO_FSERVICE_RANDOM)
945 init_rand_seed(&td->next_file_state, td->rand_seeds[FIO_RAND_FILE_OFF], use64);
946 else if (td->o.file_service_type & __FIO_FSERVICE_NONUNIFORM)
947 init_rand_file_service(td);
949 init_rand_seed(&td->file_size_state, td->rand_seeds[FIO_RAND_FILE_SIZE_OFF], use64);
950 init_rand_seed(&td->trim_state, td->rand_seeds[FIO_RAND_TRIM_OFF], use64);
951 init_rand_seed(&td->delay_state, td->rand_seeds[FIO_RAND_START_DELAY], use64);
952 init_rand_seed(&td->poisson_state, td->rand_seeds[FIO_RAND_POISSON_OFF], 0);
953 init_rand_seed(&td->dedupe_state, td->rand_seeds[FIO_DEDUPE_OFF], false);
954 init_rand_seed(&td->zone_state, td->rand_seeds[FIO_RAND_ZONE_OFF], false);
959 if (td->o.rand_repeatable)
960 td->rand_seeds[FIO_RAND_BLOCK_OFF] = FIO_RANDSEED * td->thread_number;
962 init_rand_seed(&td->random_state, td->rand_seeds[FIO_RAND_BLOCK_OFF], use64);
964 for (i = 0; i < DDIR_RWDIR_CNT; i++) {
965 struct frand_state *s = &td->seq_rand_state[i];
967 init_rand_seed(s, td->rand_seeds[FIO_RAND_SEQ_RAND_READ_OFF], false);
971 void td_fill_rand_seeds(struct thread_data *td)
975 if (td->o.allrand_repeatable) {
978 for (i = 0; i < FIO_RAND_NR_OFFS; i++)
979 td->rand_seeds[i] = FIO_RANDSEED * td->thread_number
983 if (td->o.random_generator == FIO_RAND_GEN_TAUSWORTHE64)
988 td_fill_rand_seeds_internal(td, use64);
990 init_rand_seed(&td->buf_state, td->rand_seeds[FIO_RAND_BUF_OFF], use64);
991 frand_copy(&td->buf_state_prev, &td->buf_state);
995 * Initializes the ioengine configured for a job, if it has not been done so
998 int ioengine_load(struct thread_data *td)
1003 * Engine has already been loaded.
1007 if (!td->o.ioengine) {
1008 log_err("fio: internal fault, no IO engine specified\n");
1012 engine = get_engine_name(td->o.ioengine);
1013 td->io_ops = load_ioengine(td, engine);
1015 log_err("fio: failed to load engine %s\n", engine);
1019 if (td->io_ops->option_struct_size && td->io_ops->options) {
1021 * In cases where td->eo is set, clone it for a child thread.
1022 * This requires that the parent thread has the same ioengine,
1023 * but that requirement must be enforced by the code which
1024 * cloned the thread.
1026 void *origeo = td->eo;
1028 * Otherwise use the default thread options.
1030 if (!origeo && td != &def_thread && def_thread.eo &&
1031 def_thread.io_ops->options == td->io_ops->options)
1032 origeo = def_thread.eo;
1034 options_init(td->io_ops->options);
1035 td->eo = malloc(td->io_ops->option_struct_size);
1037 * Use the default thread as an option template if this uses the
1038 * same options structure and there are non-default options
1042 memcpy(td->eo, origeo, td->io_ops->option_struct_size);
1043 options_mem_dupe(td->eo, td->io_ops->options);
1045 memset(td->eo, 0, td->io_ops->option_struct_size);
1046 fill_default_options(td->eo, td->io_ops->options);
1048 *(struct thread_data **)td->eo = td;
1052 td->io_ops->flags |= FIO_RAWIO;
1054 td_set_ioengine_flags(td);
1058 static void init_flags(struct thread_data *td)
1060 struct thread_options *o = &td->o;
1062 if (o->verify_backlog)
1063 td->flags |= TD_F_VER_BACKLOG;
1064 if (o->trim_backlog)
1065 td->flags |= TD_F_TRIM_BACKLOG;
1066 if (o->read_iolog_file)
1067 td->flags |= TD_F_READ_IOLOG;
1068 if (o->refill_buffers)
1069 td->flags |= TD_F_REFILL_BUFFERS;
1071 * Always scramble buffers if asked to
1073 if (o->scramble_buffers && fio_option_is_set(o, scramble_buffers))
1074 td->flags |= TD_F_SCRAMBLE_BUFFERS;
1076 * But also scramble buffers, unless we were explicitly asked
1079 if (o->scramble_buffers && !(o->zero_buffers &&
1080 fio_option_is_set(o, zero_buffers)))
1081 td->flags |= TD_F_SCRAMBLE_BUFFERS;
1082 if (o->verify != VERIFY_NONE)
1083 td->flags |= TD_F_VER_NONE;
1085 if (o->verify_async || o->io_submit_mode == IO_MODE_OFFLOAD)
1086 td->flags |= TD_F_NEED_LOCK;
1089 static int setup_random_seeds(struct thread_data *td)
1094 if (!td->o.rand_repeatable && !fio_option_is_set(&td->o, rand_seed))
1095 return init_random_state(td, td->rand_seeds, sizeof(td->rand_seeds));
1097 seed = td->o.rand_seed;
1098 for (i = 0; i < 4; i++)
1099 seed *= 0x9e370001UL;
1101 for (i = 0; i < FIO_RAND_NR_OFFS; i++) {
1102 td->rand_seeds[i] = seed * td->thread_number + i;
1103 seed *= 0x9e370001UL;
1106 td_fill_rand_seeds(td);
1117 static struct fpre_keyword {
1118 const char *keyword;
1121 } fpre_keywords[] = {
1122 { .keyword = "$jobname", .key = FPRE_JOBNAME, },
1123 { .keyword = "$jobnum", .key = FPRE_JOBNUM, },
1124 { .keyword = "$filenum", .key = FPRE_FILENUM, },
1125 { .keyword = NULL, },
1128 static char *make_filename(char *buf, size_t buf_size,struct thread_options *o,
1129 const char *jobname, int jobnum, int filenum)
1131 struct fpre_keyword *f;
1132 char copy[PATH_MAX];
1133 size_t dst_left = PATH_MAX - 1;
1135 if (!o->filename_format || !strlen(o->filename_format)) {
1136 sprintf(buf, "%s.%d.%d", jobname, jobnum, filenum);
1140 for (f = &fpre_keywords[0]; f->keyword; f++)
1141 f->strlen = strlen(f->keyword);
1143 buf[buf_size - 1] = '\0';
1144 strncpy(buf, o->filename_format, buf_size - 1);
1146 memset(copy, 0, sizeof(copy));
1147 for (f = &fpre_keywords[0]; f->keyword; f++) {
1149 size_t pre_len, post_start = 0;
1150 char *str, *dst = copy;
1152 str = strcasestr(buf, f->keyword);
1156 pre_len = str - buf;
1157 if (strlen(str) != f->strlen)
1158 post_start = pre_len + f->strlen;
1161 strncpy(dst, buf, pre_len);
1163 dst_left -= pre_len;
1167 case FPRE_JOBNAME: {
1170 ret = snprintf(dst, dst_left, "%s", jobname);
1173 else if (ret > dst_left) {
1174 log_err("fio: truncated filename\n");
1186 ret = snprintf(dst, dst_left, "%d", jobnum);
1189 else if (ret > dst_left) {
1190 log_err("fio: truncated filename\n");
1199 case FPRE_FILENUM: {
1202 ret = snprintf(dst, dst_left, "%d", filenum);
1205 else if (ret > dst_left) {
1206 log_err("fio: truncated filename\n");
1221 strncpy(dst, buf + post_start, dst_left);
1223 strncpy(buf, copy, buf_size - 1);
1230 bool parse_dryrun(void)
1232 return dump_cmdline || parse_only;
1235 static void gen_log_name(char *name, size_t size, const char *logtype,
1236 const char *logname, unsigned int num,
1237 const char *suf, int per_job)
1240 snprintf(name, size, "%s_%s.%d.%s", logname, logtype, num, suf);
1242 snprintf(name, size, "%s_%s.%s", logname, logtype, suf);
1245 static int check_waitees(char *waitee)
1247 struct thread_data *td;
1250 for_each_td(td, i) {
1251 if (td->subjob_number)
1254 ret += !strcmp(td->o.name, waitee);
1260 static bool wait_for_ok(const char *jobname, struct thread_options *o)
1267 if (!strcmp(jobname, o->wait_for)) {
1268 log_err("%s: a job cannot wait for itself (wait_for=%s).\n",
1269 jobname, o->wait_for);
1273 if (!(nw = check_waitees(o->wait_for))) {
1274 log_err("%s: waitee job %s unknown.\n", jobname, o->wait_for);
1279 log_err("%s: multiple waitees %s found,\n"
1280 "please avoid duplicates when using wait_for option.\n",
1281 jobname, o->wait_for);
1289 * Adds a job to the list of things todo. Sanitizes the various options
1290 * to make sure we don't have conflicts, and initializes various
1293 static int add_job(struct thread_data *td, const char *jobname, int job_add_num,
1294 int recursed, int client_type)
1297 char fname[PATH_MAX];
1298 int numjobs, file_alloced;
1299 struct thread_options *o = &td->o;
1300 char logname[PATH_MAX + 32];
1303 * the def_thread is just for options, it's not a real job
1305 if (td == &def_thread)
1311 * if we are just dumping the output command line, don't add the job
1313 if (parse_dryrun()) {
1318 td->client_type = client_type;
1320 if (profile_td_init(td))
1323 if (ioengine_load(td))
1327 if (!o->filename && !td->files_index && !o->read_iolog_file) {
1330 if (o->nr_files == 1 && exists_and_not_regfile(jobname))
1331 add_file(td, jobname, job_add_num, 0);
1333 for (i = 0; i < o->nr_files; i++)
1334 add_file(td, make_filename(fname, sizeof(fname), o, jobname, job_add_num, i), job_add_num, 0);
1338 if (fixup_options(td))
1342 * Belongs to fixup_options, but o->name is not necessarily set as yet
1344 if (!wait_for_ok(jobname, o))
1350 * IO engines only need this for option callbacks, and the address may
1351 * change in subprocesses.
1354 *(struct thread_data **)td->eo = NULL;
1356 if (td_ioengine_flagged(td, FIO_DISKLESSIO)) {
1359 for_each_file(td, f, i)
1360 f->real_file_size = -1ULL;
1363 td->mutex = fio_mutex_init(FIO_MUTEX_LOCKED);
1365 td->ts.clat_percentiles = o->clat_percentiles;
1366 td->ts.percentile_precision = o->percentile_precision;
1367 memcpy(td->ts.percentile_list, o->percentile_list, sizeof(o->percentile_list));
1369 for (i = 0; i < DDIR_RWDIR_CNT; i++) {
1370 td->ts.clat_stat[i].min_val = ULONG_MAX;
1371 td->ts.slat_stat[i].min_val = ULONG_MAX;
1372 td->ts.lat_stat[i].min_val = ULONG_MAX;
1373 td->ts.bw_stat[i].min_val = ULONG_MAX;
1375 td->ddir_seq_nr = o->ddir_seq_nr;
1377 if ((o->stonewall || o->new_group) && prev_group_jobs) {
1378 prev_group_jobs = 0;
1380 if (groupid == INT_MAX) {
1381 log_err("fio: too many groups defined\n");
1386 td->groupid = groupid;
1389 if (setup_random_seeds(td)) {
1390 td_verror(td, errno, "init_random_state");
1397 if (o->lat_log_file) {
1398 struct log_params p = {
1400 .avg_msec = o->log_avg_msec,
1401 .hist_msec = o->log_hist_msec,
1402 .hist_coarseness = o->log_hist_coarseness,
1403 .log_type = IO_LOG_TYPE_LAT,
1404 .log_offset = o->log_offset,
1405 .log_gz = o->log_gz,
1406 .log_gz_store = o->log_gz_store,
1415 gen_log_name(logname, sizeof(logname), "lat", o->lat_log_file,
1416 td->thread_number, suf, o->per_job_logs);
1417 setup_log(&td->lat_log, &p, logname);
1419 gen_log_name(logname, sizeof(logname), "slat", o->lat_log_file,
1420 td->thread_number, suf, o->per_job_logs);
1421 setup_log(&td->slat_log, &p, logname);
1423 gen_log_name(logname, sizeof(logname), "clat", o->lat_log_file,
1424 td->thread_number, suf, o->per_job_logs);
1425 setup_log(&td->clat_log, &p, logname);
1428 if (o->hist_log_file) {
1430 if (td->client_type) {
1431 log_err("fio: --write_hist_log requires zlib in client/server mode\n");
1435 struct log_params p = {
1437 .avg_msec = o->log_avg_msec,
1438 .hist_msec = o->log_hist_msec,
1439 .hist_coarseness = o->log_hist_coarseness,
1440 .log_type = IO_LOG_TYPE_HIST,
1441 .log_offset = o->log_offset,
1442 .log_gz = o->log_gz,
1443 .log_gz_store = o->log_gz_store,
1452 gen_log_name(logname, sizeof(logname), "clat_hist", o->hist_log_file,
1453 td->thread_number, suf, o->per_job_logs);
1454 setup_log(&td->clat_hist_log, &p, logname);
1457 if (o->bw_log_file) {
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,
1470 if (fio_option_is_set(o, bw_avg_time))
1471 p.avg_msec = min(o->log_avg_msec, o->bw_avg_time);
1473 o->bw_avg_time = p.avg_msec;
1475 p.hist_msec = o->log_hist_msec;
1476 p.hist_coarseness = o->log_hist_coarseness;
1483 gen_log_name(logname, sizeof(logname), "bw", o->bw_log_file,
1484 td->thread_number, suf, o->per_job_logs);
1485 setup_log(&td->bw_log, &p, logname);
1487 if (o->iops_log_file) {
1488 struct log_params p = {
1490 .avg_msec = o->log_avg_msec,
1491 .hist_msec = o->log_hist_msec,
1492 .hist_coarseness = o->log_hist_coarseness,
1493 .log_type = IO_LOG_TYPE_IOPS,
1494 .log_offset = o->log_offset,
1495 .log_gz = o->log_gz,
1496 .log_gz_store = o->log_gz_store,
1500 if (fio_option_is_set(o, iops_avg_time))
1501 p.avg_msec = min(o->log_avg_msec, o->iops_avg_time);
1503 o->iops_avg_time = p.avg_msec;
1505 p.hist_msec = o->log_hist_msec;
1506 p.hist_coarseness = o->log_hist_coarseness;
1513 gen_log_name(logname, sizeof(logname), "iops", o->iops_log_file,
1514 td->thread_number, suf, o->per_job_logs);
1515 setup_log(&td->iops_log, &p, logname);
1519 o->name = strdup(jobname);
1521 if (output_format & FIO_OUTPUT_NORMAL) {
1523 if (is_backend && !recursed)
1524 fio_server_send_add_job(td);
1526 if (!td_ioengine_flagged(td, FIO_NOIO)) {
1527 char *c1, *c2, *c3, *c4;
1528 char *c5 = NULL, *c6 = NULL;
1530 c1 = fio_uint_to_kmg(o->min_bs[DDIR_READ]);
1531 c2 = fio_uint_to_kmg(o->max_bs[DDIR_READ]);
1532 c3 = fio_uint_to_kmg(o->min_bs[DDIR_WRITE]);
1533 c4 = fio_uint_to_kmg(o->max_bs[DDIR_WRITE]);
1535 if (!o->bs_is_seq_rand) {
1536 c5 = fio_uint_to_kmg(o->min_bs[DDIR_TRIM]);
1537 c6 = fio_uint_to_kmg(o->max_bs[DDIR_TRIM]);
1540 log_info("%s: (g=%d): rw=%s, ", td->o.name,
1542 ddir_str(o->td_ddir));
1544 if (o->bs_is_seq_rand)
1545 log_info("bs(seq/rand)=%s-%s/%s-%s, ",
1548 log_info("bs=%s-%s/%s-%s/%s-%s, ",
1549 c1, c2, c3, c4, c5, c6);
1551 log_info("ioengine=%s, iodepth=%u\n",
1552 td->io_ops->name, o->iodepth);
1561 } else if (job_add_num == 1)
1566 * recurse add identical jobs, clear numjobs and stonewall options
1567 * as they don't apply to sub-jobs
1569 numjobs = o->numjobs;
1571 struct thread_data *td_new = get_new_job(0, td, 1, jobname);
1576 td_new->o.numjobs = 1;
1577 td_new->o.stonewall = 0;
1578 td_new->o.new_group = 0;
1579 td_new->subjob_number = numjobs;
1582 if (td_new->files) {
1584 for_each_file(td_new, f, i) {
1586 sfree(f->file_name);
1589 free(td_new->files);
1590 td_new->files = NULL;
1592 td_new->files_index = 0;
1593 td_new->files_size = 0;
1594 if (td_new->o.filename) {
1595 free(td_new->o.filename);
1596 td_new->o.filename = NULL;
1600 if (add_job(td_new, jobname, numjobs, 1, client_type))
1611 * Parse as if 'o' was a command line
1613 void add_job_opts(const char **o, int client_type)
1615 struct thread_data *td, *td_parent;
1616 int i, in_global = 1;
1620 td_parent = td = NULL;
1622 if (!strncmp(o[i], "name", 4)) {
1625 add_job(td, jobname, 0, 0, client_type);
1627 sprintf(jobname, "%s", o[i] + 5);
1629 if (in_global && !td_parent)
1630 td_parent = get_new_job(1, &def_thread, 0, jobname);
1631 else if (!in_global && !td) {
1633 td_parent = &def_thread;
1634 td = get_new_job(0, td_parent, 0, jobname);
1637 fio_options_parse(td_parent, (char **) &o[i], 1);
1639 fio_options_parse(td, (char **) &o[i], 1);
1644 add_job(td, jobname, 0, 0, client_type);
1647 static int skip_this_section(const char *name)
1651 if (!nr_job_sections)
1653 if (!strncmp(name, "global", 6))
1656 for (i = 0; i < nr_job_sections; i++)
1657 if (!strcmp(job_sections[i], name))
1663 static int is_empty_or_comment(char *line)
1667 for (i = 0; i < strlen(line); i++) {
1672 if (!isspace((int) line[i]) && !iscntrl((int) line[i]))
1680 * This is our [ini] type file parser.
1682 int __parse_jobs_ini(struct thread_data *td,
1683 char *file, int is_buf, int stonewall_flag, int type,
1684 int nested, char *name, char ***popts, int *aopts, int *nopts)
1686 unsigned int global = 0;
1690 int ret = 0, stonewall;
1693 int inside_skip = 0;
1695 int i, alloc_opts, num_opts;
1697 dprint(FD_PARSE, "Parsing ini file %s\n", file);
1698 assert(td || !nested);
1703 if (!strcmp(file, "-"))
1706 f = fopen(file, "r");
1711 log_err("fio: unable to open '%s' job file\n", file);
1713 td_verror(td, __err, "job file open");
1718 string = malloc(4096);
1721 * it's really 256 + small bit, 280 should suffice
1725 memset(name, 0, 280);
1729 if (nested && popts) {
1731 alloc_opts = *aopts;
1737 opts = malloc(sizeof(char *) * alloc_opts);
1741 stonewall = stonewall_flag;
1744 * if skip_fgets is set, we already have loaded a line we
1749 p = strsep(&file, "\n");
1751 p = fgets(string, 4096, f);
1757 strip_blank_front(&p);
1760 dprint(FD_PARSE, "%s\n", p);
1761 if (is_empty_or_comment(p))
1765 if (sscanf(p, "[%255[^\n]]", name) != 1) {
1769 log_err("fio: option <%s> outside of "
1770 "[] job section\n", p);
1775 name[strlen(name) - 1] = '\0';
1777 if (skip_this_section(name)) {
1783 dprint(FD_PARSE, "Parsing section [%s]\n", name);
1785 global = !strncmp(name, "global", 6);
1791 log_info("--name=%s ", name);
1795 td = get_new_job(global, &def_thread, 0, name);
1802 * Separate multiple job files by a stonewall
1804 if (!global && stonewall) {
1805 td->o.stonewall = stonewall;
1810 memset(opts, 0, alloc_opts * sizeof(char *));
1818 p = strsep(&file, "\n");
1820 p = fgets(string, 4096, f);
1823 dprint(FD_PARSE, "%s", p);
1828 if (is_empty_or_comment(p))
1831 strip_blank_front(&p);
1834 * new section, break out and make sure we don't
1835 * fgets() a new line at the top.
1839 log_err("No new sections in included files\n");
1849 if (!strncmp(p, "include", strlen("include"))) {
1850 char *filename = p + strlen("include") + 1,
1851 *ts, *full_fn = NULL;
1854 * Allow for the include filename
1855 * specification to be relative.
1857 if (access(filename, F_OK) &&
1858 (ts = strrchr(file, '/'))) {
1859 int len = ts - file +
1860 strlen(filename) + 2;
1862 if (!(full_fn = calloc(1, len))) {
1868 file, (ts - file) + 1);
1869 strncpy(full_fn + (ts - file) + 1,
1870 filename, strlen(filename));
1871 full_fn[len - 1] = 0;
1875 ret = __parse_jobs_ini(td, filename, is_buf,
1876 stonewall_flag, type, 1,
1878 &alloc_opts, &num_opts);
1881 log_err("Error %d while parsing "
1882 "include file %s\n",
1895 if (num_opts == alloc_opts) {
1897 opts = realloc(opts,
1898 alloc_opts * sizeof(char *));
1901 opts[num_opts] = strdup(p);
1907 *aopts = alloc_opts;
1912 ret = fio_options_parse(td, opts, num_opts);
1917 ret = add_job(td, name, 0, 0, type);
1919 log_err("fio: job %s dropped\n", name);
1923 for (i = 0; i < num_opts; i++)
1932 while (i < nr_job_sections) {
1933 free(job_sections[i]);
1942 if (!is_buf && f != stdin)
1947 int parse_jobs_ini(char *file, int is_buf, int stonewall_flag, int type)
1949 return __parse_jobs_ini(NULL, file, is_buf, stonewall_flag, type,
1950 0, NULL, NULL, NULL, NULL);
1953 static int fill_def_thread(void)
1955 memset(&def_thread, 0, sizeof(def_thread));
1956 INIT_FLIST_HEAD(&def_thread.opt_list);
1958 fio_getaffinity(getpid(), &def_thread.o.cpumask);
1959 def_thread.o.error_dump = 1;
1962 * fill default options
1964 fio_fill_default_options(&def_thread);
1968 static void show_debug_categories(void)
1970 #ifdef FIO_INC_DEBUG
1971 struct debug_level *dl = &debug_levels[0];
1972 int curlen, first = 1;
1976 int has_next = (dl + 1)->name != NULL;
1978 if (first || curlen + strlen(dl->name) >= 80) {
1983 curlen += printf("\t\t\t%s", dl->name);
1984 curlen += 3 * (8 - 1);
1986 curlen += printf(",");
1988 curlen += printf("%s", dl->name);
1990 curlen += printf(",");
1999 static void usage(const char *name)
2001 printf("%s\n", fio_version_string);
2002 printf("%s [options] [job options] <job file(s)>\n", name);
2003 printf(" --debug=options\tEnable debug logging. May be one/more of:\n");
2004 show_debug_categories();
2005 printf(" --parse-only\t\tParse options only, don't start any IO\n");
2006 printf(" --output\t\tWrite output to file\n");
2007 printf(" --runtime\t\tRuntime in seconds\n");
2008 printf(" --bandwidth-log\tGenerate per-job bandwidth logs\n");
2009 printf(" --minimal\t\tMinimal (terse) output\n");
2010 printf(" --output-format=x\tOutput format (terse,json,json+,normal)\n");
2011 printf(" --terse-version=x\tSet terse version output format to 'x'\n");
2012 printf(" --version\t\tPrint version info and exit\n");
2013 printf(" --help\t\tPrint this page\n");
2014 printf(" --cpuclock-test\tPerform test/validation of CPU clock\n");
2015 printf(" --crctest\t\tTest speed of checksum functions\n");
2016 printf(" --cmdhelp=cmd\t\tPrint command help, \"all\" for all of"
2018 printf(" --enghelp=engine\tPrint ioengine help, or list"
2019 " available ioengines\n");
2020 printf(" --enghelp=engine,cmd\tPrint help for an ioengine"
2022 printf(" --showcmd\t\tTurn a job file into command line options\n");
2023 printf(" --eta=when\t\tWhen ETA estimate should be printed\n");
2024 printf(" \t\tMay be \"always\", \"never\" or \"auto\"\n");
2025 printf(" --eta-newline=time\tForce a new line for every 'time'");
2026 printf(" period passed\n");
2027 printf(" --status-interval=t\tForce full status dump every");
2028 printf(" 't' period passed\n");
2029 printf(" --readonly\t\tTurn on safety read-only checks, preventing"
2031 printf(" --section=name\tOnly run specified section in job file\n");
2032 printf(" --alloc-size=kb\tSet smalloc pool to this size in kb"
2034 printf(" --warnings-fatal\tFio parser warnings are fatal\n");
2035 printf(" --max-jobs=nr\t\tMaximum number of threads/processes to support\n");
2036 printf(" --server=args\t\tStart a backend fio server\n");
2037 printf(" --daemonize=pidfile\tBackground fio server, write pid to file\n");
2038 printf(" --client=hostname\tTalk to remote backend fio server at hostname\n");
2039 printf(" --remote-config=file\tTell fio server to load this local job file\n");
2040 printf(" --idle-prof=option\tReport cpu idleness on a system or percpu basis\n"
2041 "\t\t\t(option=system,percpu) or run unit work\n"
2042 "\t\t\tcalibration only (option=calibrate)\n");
2044 printf(" --inflate-log=log\tInflate and output compressed log\n");
2046 printf(" --trigger-file=file\tExecute trigger cmd when file exists\n");
2047 printf(" --trigger-timeout=t\tExecute trigger af this time\n");
2048 printf(" --trigger=cmd\t\tSet this command as local trigger\n");
2049 printf(" --trigger-remote=cmd\tSet this command as remote trigger\n");
2050 printf(" --aux-path=path\tUse this path for fio state generated files\n");
2051 printf("\nFio was written by Jens Axboe <jens.axboe@oracle.com>");
2052 printf("\n Jens Axboe <jaxboe@fusionio.com>");
2053 printf("\n Jens Axboe <axboe@fb.com>\n");
2056 #ifdef FIO_INC_DEBUG
2057 struct debug_level debug_levels[] = {
2058 { .name = "process",
2059 .help = "Process creation/exit logging",
2060 .shift = FD_PROCESS,
2063 .help = "File related action logging",
2067 .help = "IO and IO engine action logging (offsets, queue, completions, etc)",
2071 .help = "Memory allocation/freeing logging",
2074 { .name = "blktrace",
2075 .help = "blktrace action logging",
2076 .shift = FD_BLKTRACE,
2079 .help = "IO verification action logging",
2083 .help = "Random generation logging",
2087 .help = "Parser logging",
2090 { .name = "diskutil",
2091 .help = "Disk utility logging actions",
2092 .shift = FD_DISKUTIL,
2095 .help = "Logging related to creating/destroying jobs",
2099 .help = "Mutex logging",
2102 { .name = "profile",
2103 .help = "Logging related to profiles",
2104 .shift = FD_PROFILE,
2107 .help = "Logging related to time keeping functions",
2111 .help = "Network logging",
2115 .help = "Rate logging",
2118 { .name = "compress",
2119 .help = "Log compression logging",
2120 .shift = FD_COMPRESS,
2125 static int set_debug(const char *string)
2127 struct debug_level *dl;
2128 char *p = (char *) string;
2135 if (!strcmp(string, "?") || !strcmp(string, "help")) {
2136 log_info("fio: dumping debug options:");
2137 for (i = 0; debug_levels[i].name; i++) {
2138 dl = &debug_levels[i];
2139 log_info("%s,", dl->name);
2145 while ((opt = strsep(&p, ",")) != NULL) {
2148 if (!strncmp(opt, "all", 3)) {
2149 log_info("fio: set all debug options\n");
2154 for (i = 0; debug_levels[i].name; i++) {
2155 dl = &debug_levels[i];
2156 found = !strncmp(opt, dl->name, strlen(dl->name));
2160 if (dl->shift == FD_JOB) {
2161 opt = strchr(opt, ':');
2163 log_err("fio: missing job number\n");
2167 fio_debug_jobno = atoi(opt);
2168 log_info("fio: set debug jobno %d\n",
2171 log_info("fio: set debug option %s\n", opt);
2172 fio_debug |= (1UL << dl->shift);
2178 log_err("fio: debug mask %s not found\n", opt);
2183 static int set_debug(const char *string)
2185 log_err("fio: debug tracing not included in build\n");
2190 static void fio_options_fill_optstring(void)
2192 char *ostr = cmd_optstr;
2196 while (l_opts[i].name) {
2197 ostr[c++] = l_opts[i].val;
2198 if (l_opts[i].has_arg == required_argument)
2200 else if (l_opts[i].has_arg == optional_argument) {
2209 static int client_flag_set(char c)
2214 while (l_opts[i].name) {
2215 int val = l_opts[i].val;
2217 if (c == (val & 0xff))
2218 return (val & FIO_CLIENT_FLAG);
2226 static void parse_cmd_client(void *client, char *opt)
2228 fio_client_add_cmd_option(client, opt);
2231 static void show_closest_option(const char *name)
2233 int best_option, best_distance;
2236 while (*name == '-')
2240 best_distance = INT_MAX;
2242 while (l_opts[i].name) {
2243 distance = string_distance(name, l_opts[i].name);
2244 if (distance < best_distance) {
2245 best_distance = distance;
2251 if (best_option != -1 && string_distance_ok(name, best_distance))
2252 log_err("Did you mean %s?\n", l_opts[best_option].name);
2255 static int parse_output_format(const char *optarg)
2257 char *p, *orig, *opt;
2260 p = orig = strdup(optarg);
2264 while ((opt = strsep(&p, ",")) != NULL) {
2265 if (!strcmp(opt, "minimal") ||
2266 !strcmp(opt, "terse") ||
2267 !strcmp(opt, "csv"))
2268 output_format |= FIO_OUTPUT_TERSE;
2269 else if (!strcmp(opt, "json"))
2270 output_format |= FIO_OUTPUT_JSON;
2271 else if (!strcmp(opt, "json+"))
2272 output_format |= (FIO_OUTPUT_JSON | FIO_OUTPUT_JSON_PLUS);
2273 else if (!strcmp(opt, "normal"))
2274 output_format |= FIO_OUTPUT_NORMAL;
2276 log_err("fio: invalid output format %s\n", opt);
2286 int parse_cmd_line(int argc, char *argv[], int client_type)
2288 struct thread_data *td = NULL;
2289 int c, ini_idx = 0, lidx, ret = 0, do_exit = 0, exit_val = 0;
2290 char *ostr = cmd_optstr;
2291 char *pid_file = NULL;
2292 void *cur_client = NULL;
2296 * Reset optind handling, since we may call this multiple times
2301 while ((c = getopt_long_only(argc, argv, ostr, l_opts, &lidx)) != -1) {
2302 if ((c & FIO_CLIENT_FLAG) || client_flag_set(c)) {
2303 parse_cmd_client(cur_client, argv[optind - 1]);
2304 c &= ~FIO_CLIENT_FLAG;
2309 smalloc_pool_size = atoi(optarg);
2312 if (check_str_time(optarg, &def_timeout, 1)) {
2313 log_err("fio: failed parsing time %s\n", optarg);
2319 log_err("fio: --latency-log is deprecated. Use per-job latency log options.\n");
2327 if (f_out && f_out != stdout)
2330 f_out = fopen(optarg, "w+");
2332 perror("fopen output");
2338 output_format = FIO_OUTPUT_TERSE;
2341 if (parse_output_format(optarg)) {
2342 log_err("fio: failed parsing output-format\n");
2349 output_format |= FIO_OUTPUT_TERSE;
2361 fio_show_option_help(optarg);
2368 fio_show_ioengine_help(optarg);
2382 log_info("%s\n", fio_version_string);
2387 terse_version = atoi(optarg);
2388 if (!(terse_version == 2 || terse_version == 3 ||
2389 terse_version == 4)) {
2390 log_err("fio: bad terse version format\n");
2396 if (!strcmp("always", optarg))
2397 eta_print = FIO_ETA_ALWAYS;
2398 else if (!strcmp("never", optarg))
2399 eta_print = FIO_ETA_NEVER;
2404 if (check_str_time(optarg, &t, 1)) {
2405 log_err("fio: failed parsing eta time %s\n", optarg);
2409 eta_new_line = t / 1000;
2413 if (set_debug(optarg))
2423 if (!strcmp(optarg, "global")) {
2424 log_err("fio: can't use global as only "
2430 new_size = (nr_job_sections + 1) * sizeof(char *);
2431 job_sections = realloc(job_sections, new_size);
2432 job_sections[nr_job_sections] = strdup(optarg);
2438 exit_val = iolog_file_inflate(optarg);
2447 exec_profile = strdup(optarg);
2449 case FIO_GETOPT_JOB: {
2450 const char *opt = l_opts[lidx].name;
2453 if (!strncmp(opt, "name", 4) && td) {
2454 ret = add_job(td, td->o.name ?: "fio", 0, 0, client_type);
2461 int is_section = !strncmp(opt, "name", 4);
2464 if (!is_section || !strncmp(val, "global", 6))
2467 if (is_section && skip_this_section(val))
2470 td = get_new_job(global, &def_thread, 1, NULL);
2471 if (!td || ioengine_load(td)) {
2480 fio_options_set_ioengine_opts(l_opts, td);
2483 if ((!val || !strlen(val)) &&
2484 l_opts[lidx].has_arg == required_argument) {
2485 log_err("fio: option %s requires an argument\n", opt);
2488 ret = fio_cmd_option_parse(td, opt, val);
2499 if (!ret && !strcmp(opt, "ioengine")) {
2501 if (ioengine_load(td)) {
2508 fio_options_set_ioengine_opts(l_opts, td);
2512 case FIO_GETOPT_IOENGINE: {
2513 const char *opt = l_opts[lidx].name;
2519 ret = fio_cmd_ioengine_option_parse(td, opt, val);
2526 max_jobs = atoi(optarg);
2527 if (!max_jobs || max_jobs > REAL_MAX_JOBS) {
2528 log_err("fio: invalid max jobs: %d\n", max_jobs);
2535 #ifndef CONFIG_NO_SHM
2537 log_err("fio: can't be both client and server\n");
2543 fio_server_set_arg(optarg);
2547 log_err("fio: client/server requires SHM support\n");
2555 pid_file = strdup(optarg);
2558 if ((ret = fio_idle_prof_parse_opt(optarg))) {
2559 /* exit on error and calibration only */
2569 log_err("fio: can't be both client and server\n");
2574 /* if --client parameter contains a pathname */
2575 if (0 == access(optarg, R_OK)) {
2576 /* file contains a list of host addrs or names */
2577 char hostaddr[PATH_MAX] = {0};
2579 FILE * hostf = fopen(optarg, "r");
2581 log_err("fio: could not open client list file %s for read\n", optarg);
2586 sprintf(formatstr, "%%%ds", PATH_MAX - 1);
2588 * read at most PATH_MAX-1 chars from each
2589 * record in this file
2591 while (fscanf(hostf, formatstr, hostaddr) == 1) {
2592 /* expect EVERY host in file to be valid */
2593 if (fio_client_add(&fio_client_ops, hostaddr, &cur_client)) {
2594 log_err("fio: failed adding client %s from file %s\n", hostaddr, optarg);
2601 break; /* no possibility of job file for "this client only" */
2603 if (fio_client_add(&fio_client_ops, optarg, &cur_client)) {
2604 log_err("fio: failed adding client %s\n", optarg);
2610 * If the next argument exists and isn't an option,
2611 * assume it's a job file for this client only.
2613 while (optind < argc) {
2614 if (!strncmp(argv[optind], "--", 2) ||
2615 !strncmp(argv[optind], "-", 1))
2618 if (fio_client_add_ini_file(cur_client, argv[optind], false))
2625 if (fio_client_add_ini_file(cur_client, optarg, true)) {
2633 exit_val = fio_monotonic_clocktest(1);
2638 exit_val = fio_crctest(optarg);
2643 if (check_str_time(optarg, &val, 1)) {
2644 log_err("fio: failed parsing time %s\n", optarg);
2649 status_interval = val / 1000;
2655 trigger_file = strdup(optarg);
2660 trigger_cmd = strdup(optarg);
2663 if (trigger_remote_cmd)
2664 free(trigger_remote_cmd);
2665 trigger_remote_cmd = strdup(optarg);
2670 aux_path = strdup(optarg);
2673 if (check_str_time(optarg, &trigger_timeout, 1)) {
2674 log_err("fio: failed parsing time %s\n", optarg);
2678 trigger_timeout /= 1000000;
2681 log_err("%s: unrecognized option '%s'\n", argv[0],
2683 show_closest_option(argv[optind - 1]);
2693 if (do_exit && !(is_backend || nr_clients))
2696 if (nr_clients && fio_clients_connect())
2699 if (is_backend && backend)
2700 return fio_start_server(pid_file);
2706 ret = add_job(td, td->o.name ?: "fio", 0, 0, client_type);
2712 while (!ret && optind < argc) {
2714 ini_file = realloc(ini_file, ini_idx * sizeof(char *));
2715 ini_file[ini_idx - 1] = strdup(argv[optind]);
2726 int fio_init_options(void)
2731 fio_options_fill_optstring();
2732 fio_options_dup_and_init(l_opts);
2736 if (fill_def_thread())
2742 extern int fio_check_options(struct thread_options *);
2744 int parse_options(int argc, char *argv[])
2746 const int type = FIO_CLIENT_TYPE_CLI;
2749 if (fio_init_options())
2751 if (fio_test_cconv(&def_thread.o))
2752 log_err("fio: failed internal cconv test\n");
2754 job_files = parse_cmd_line(argc, argv, type);
2756 if (job_files > 0) {
2757 for (i = 0; i < job_files; i++) {
2758 if (i && fill_def_thread())
2761 if (fio_clients_send_ini(ini_file[i]))
2764 } else if (!is_backend) {
2765 if (parse_jobs_ini(ini_file[i], 0, i, type))
2770 } else if (nr_clients) {
2771 if (fill_def_thread())
2773 if (fio_clients_send_ini(NULL))
2778 fio_options_free(&def_thread);
2779 filesetup_mem_free();
2781 if (!thread_number) {
2786 if (is_backend || nr_clients)
2791 log_err("No jobs(s) defined\n\n");
2801 if (output_format & FIO_OUTPUT_NORMAL)
2802 log_info("%s\n", fio_version_string);
2807 void options_default_fill(struct thread_options *o)
2809 memcpy(o, &def_thread.o, sizeof(*o));
2812 struct thread_data *get_global_options(void)