2 * This file contains job initialization and setup functions.
12 #include <sys/types.h>
16 #ifndef FIO_NO_HAVE_SHM_H
28 #include "steadystate.h"
30 #include "oslib/getopt.h"
31 #include "oslib/strcasestr.h"
36 const char fio_version_string[] = FIO_VERSION;
38 #define FIO_RANDSEED (0xb1899bedUL)
40 static char **ini_file;
41 static int max_jobs = FIO_MAX_JOBS;
42 static int dump_cmdline;
43 static int parse_only;
45 static struct thread_data def_thread;
46 struct thread_data *threads = NULL;
47 static char **job_sections;
48 static int nr_job_sections;
50 int exitall_on_terminate = 0;
51 int output_format = FIO_OUTPUT_NORMAL;
52 int eta_print = FIO_ETA_AUTO;
56 char *exec_profile = NULL;
57 int warnings_fatal = 0;
58 int terse_version = 3;
65 int status_interval = 0;
67 char *trigger_file = NULL;
68 long long trigger_timeout = 0;
69 char *trigger_cmd = NULL;
70 char *trigger_remote_cmd = NULL;
72 char *aux_path = NULL;
74 static int prev_group_jobs;
76 unsigned long fio_debug = 0;
77 unsigned int fio_debug_jobno = -1;
78 unsigned int *fio_debug_jobp = NULL;
80 static char cmd_optstr[256];
83 #define FIO_CLIENT_FLAG (1 << 16)
86 * Command line options. These will contain the above, plus a few
87 * extra that only pertain to fio itself and not jobs.
89 static struct option l_opts[FIO_NR_OPTIONS] = {
91 .name = (char *) "output",
92 .has_arg = required_argument,
93 .val = 'o' | FIO_CLIENT_FLAG,
96 .name = (char *) "latency-log",
97 .has_arg = required_argument,
98 .val = 'l' | FIO_CLIENT_FLAG,
101 .name = (char *) "bandwidth-log",
102 .has_arg = no_argument,
103 .val = 'b' | FIO_CLIENT_FLAG,
106 .name = (char *) "minimal",
107 .has_arg = no_argument,
108 .val = 'm' | FIO_CLIENT_FLAG,
111 .name = (char *) "output-format",
112 .has_arg = required_argument,
113 .val = 'F' | FIO_CLIENT_FLAG,
116 .name = (char *) "append-terse",
117 .has_arg = optional_argument,
121 .name = (char *) "version",
122 .has_arg = no_argument,
123 .val = 'v' | FIO_CLIENT_FLAG,
126 .name = (char *) "help",
127 .has_arg = no_argument,
128 .val = 'h' | FIO_CLIENT_FLAG,
131 .name = (char *) "cmdhelp",
132 .has_arg = optional_argument,
133 .val = 'c' | FIO_CLIENT_FLAG,
136 .name = (char *) "enghelp",
137 .has_arg = optional_argument,
138 .val = 'i' | FIO_CLIENT_FLAG,
141 .name = (char *) "showcmd",
142 .has_arg = no_argument,
143 .val = 's' | FIO_CLIENT_FLAG,
146 .name = (char *) "readonly",
147 .has_arg = no_argument,
148 .val = 'r' | FIO_CLIENT_FLAG,
151 .name = (char *) "eta",
152 .has_arg = required_argument,
153 .val = 'e' | FIO_CLIENT_FLAG,
156 .name = (char *) "eta-newline",
157 .has_arg = required_argument,
158 .val = 'E' | FIO_CLIENT_FLAG,
161 .name = (char *) "debug",
162 .has_arg = required_argument,
163 .val = 'd' | FIO_CLIENT_FLAG,
166 .name = (char *) "parse-only",
167 .has_arg = no_argument,
168 .val = 'P' | FIO_CLIENT_FLAG,
171 .name = (char *) "section",
172 .has_arg = required_argument,
173 .val = 'x' | FIO_CLIENT_FLAG,
177 .name = (char *) "inflate-log",
178 .has_arg = required_argument,
179 .val = 'X' | FIO_CLIENT_FLAG,
183 .name = (char *) "alloc-size",
184 .has_arg = required_argument,
185 .val = 'a' | FIO_CLIENT_FLAG,
188 .name = (char *) "profile",
189 .has_arg = required_argument,
190 .val = 'p' | FIO_CLIENT_FLAG,
193 .name = (char *) "warnings-fatal",
194 .has_arg = no_argument,
195 .val = 'w' | FIO_CLIENT_FLAG,
198 .name = (char *) "max-jobs",
199 .has_arg = required_argument,
200 .val = 'j' | FIO_CLIENT_FLAG,
203 .name = (char *) "terse-version",
204 .has_arg = required_argument,
205 .val = 'V' | FIO_CLIENT_FLAG,
208 .name = (char *) "server",
209 .has_arg = optional_argument,
212 { .name = (char *) "daemonize",
213 .has_arg = required_argument,
217 .name = (char *) "client",
218 .has_arg = required_argument,
222 .name = (char *) "remote-config",
223 .has_arg = required_argument,
227 .name = (char *) "cpuclock-test",
228 .has_arg = no_argument,
232 .name = (char *) "crctest",
233 .has_arg = optional_argument,
237 .name = (char *) "idle-prof",
238 .has_arg = required_argument,
242 .name = (char *) "status-interval",
243 .has_arg = required_argument,
247 .name = (char *) "trigger-file",
248 .has_arg = required_argument,
252 .name = (char *) "trigger-timeout",
253 .has_arg = required_argument,
257 .name = (char *) "trigger",
258 .has_arg = required_argument,
262 .name = (char *) "trigger-remote",
263 .has_arg = required_argument,
267 .name = (char *) "aux-path",
268 .has_arg = required_argument,
276 void free_threads_shm(void)
280 #ifndef CONFIG_NO_SHM
281 struct shmid_ds sbuf;
285 shmctl(shm_id, IPC_RMID, &sbuf);
294 static void free_shm(void)
298 fio_debug_jobp = NULL;
304 free(trigger_remote_cmd);
305 trigger_file = trigger_cmd = trigger_remote_cmd = NULL;
307 options_free(fio_options, &def_thread.o);
314 * The thread area is shared between the main process and the job
315 * threads/processes. So setup a shared memory segment that will hold
316 * all the job info. We use the end of the region for keeping track of
317 * open files across jobs, for file sharing.
319 static int setup_thread_area(void)
325 * 1024 is too much on some machines, scale max_jobs if
326 * we get a failure that looks like too large a shm segment
329 size_t size = max_jobs * sizeof(struct thread_data);
331 size += sizeof(unsigned int);
333 #ifndef CONFIG_NO_SHM
334 shm_id = shmget(0, size, IPC_CREAT | 0600);
337 if (errno != EINVAL && errno != ENOMEM && errno != ENOSPC) {
342 threads = malloc(size);
350 #ifndef CONFIG_NO_SHM
354 threads = shmat(shm_id, NULL, 0);
355 if (threads == (void *) -1) {
359 if (shm_attach_to_open_removed())
360 shmctl(shm_id, IPC_RMID, NULL);
363 memset(threads, 0, max_jobs * sizeof(struct thread_data));
364 fio_debug_jobp = (unsigned int *)(threads + max_jobs);
365 *fio_debug_jobp = -1;
372 static void dump_print_option(struct print_option *p)
376 if (!strcmp("description", p->name))
381 log_info("--%s%s", p->name, p->value ? "" : " ");
383 log_info("=%s%s%s ", delim, p->value, delim);
386 static void dump_opt_list(struct thread_data *td)
388 struct flist_head *entry;
389 struct print_option *p;
391 if (flist_empty(&td->opt_list))
394 flist_for_each(entry, &td->opt_list) {
395 p = flist_entry(entry, struct print_option, list);
396 dump_print_option(p);
400 static void fio_dump_options_free(struct thread_data *td)
402 while (!flist_empty(&td->opt_list)) {
403 struct print_option *p;
405 p = flist_first_entry(&td->opt_list, struct print_option, list);
406 flist_del_init(&p->list);
413 static void copy_opt_list(struct thread_data *dst, struct thread_data *src)
415 struct flist_head *entry;
417 if (flist_empty(&src->opt_list))
420 flist_for_each(entry, &src->opt_list) {
421 struct print_option *srcp, *dstp;
423 srcp = flist_entry(entry, struct print_option, list);
424 dstp = malloc(sizeof(*dstp));
425 dstp->name = strdup(srcp->name);
427 dstp->value = strdup(srcp->value);
430 flist_add_tail(&dstp->list, &dst->opt_list);
435 * Return a free job structure.
437 static struct thread_data *get_new_job(bool global, struct thread_data *parent,
438 bool preserve_eo, const char *jobname)
440 struct thread_data *td;
444 if (setup_thread_area()) {
445 log_err("error: failed to setup shm segment\n");
448 if (thread_number >= max_jobs) {
449 log_err("error: maximum number of jobs (%d) reached.\n",
454 td = &threads[thread_number++];
457 INIT_FLIST_HEAD(&td->opt_list);
458 if (parent != &def_thread)
459 copy_opt_list(td, parent);
466 td->o.uid = td->o.gid = -1U;
468 dup_files(td, parent);
469 fio_options_mem_dupe(td);
471 profile_add_hooks(td);
473 td->thread_number = thread_number;
474 td->subjob_number = 0;
477 td->o.name = strdup(jobname);
479 if (!parent->o.group_reporting || parent == &def_thread)
485 static void put_job(struct thread_data *td)
487 if (td == &def_thread)
494 log_info("fio: %s\n", td->verror);
496 fio_options_free(td);
497 fio_dump_options_free(td);
504 memset(&threads[td->thread_number - 1], 0, sizeof(*td));
508 static int __setup_rate(struct thread_data *td, enum fio_ddir ddir)
510 unsigned int bs = td->o.min_bs[ddir];
512 assert(ddir_rw(ddir));
514 if (td->o.rate[ddir])
515 td->rate_bps[ddir] = td->o.rate[ddir];
517 td->rate_bps[ddir] = (uint64_t) td->o.rate_iops[ddir] * bs;
519 if (!td->rate_bps[ddir]) {
520 log_err("rate lower than supported\n");
524 td->rate_next_io_time[ddir] = 0;
525 td->rate_io_issue_bytes[ddir] = 0;
526 td->last_usec[ddir] = 0;
530 static int setup_rate(struct thread_data *td)
534 if (td->o.rate[DDIR_READ] || td->o.rate_iops[DDIR_READ])
535 ret = __setup_rate(td, DDIR_READ);
536 if (td->o.rate[DDIR_WRITE] || td->o.rate_iops[DDIR_WRITE])
537 ret |= __setup_rate(td, DDIR_WRITE);
538 if (td->o.rate[DDIR_TRIM] || td->o.rate_iops[DDIR_TRIM])
539 ret |= __setup_rate(td, DDIR_TRIM);
544 static int fixed_block_size(struct thread_options *o)
546 return o->min_bs[DDIR_READ] == o->max_bs[DDIR_READ] &&
547 o->min_bs[DDIR_WRITE] == o->max_bs[DDIR_WRITE] &&
548 o->min_bs[DDIR_TRIM] == o->max_bs[DDIR_TRIM] &&
549 o->min_bs[DDIR_READ] == o->min_bs[DDIR_WRITE] &&
550 o->min_bs[DDIR_READ] == o->min_bs[DDIR_TRIM];
554 static unsigned long long get_rand_start_delay(struct thread_data *td)
556 unsigned long long delayrange;
560 delayrange = td->o.start_delay_high - td->o.start_delay;
562 frand_max = rand_max(&td->delay_state);
563 r = __rand(&td->delay_state);
564 delayrange = (unsigned long long) ((double) delayrange * (r / (frand_max + 1.0)));
566 delayrange += td->o.start_delay;
573 static unsigned int gcd(unsigned int m, unsigned int n)
578 return gcd(n, m % n);
582 * Lazy way of fixing up options that depend on each other. We could also
583 * define option callback handlers, but this is easier.
585 static int fixup_options(struct thread_data *td)
587 struct thread_options *o = &td->o;
590 #ifndef CONFIG_PSHARED
591 if (!o->use_thread) {
592 log_info("fio: this platform does not support process shared"
593 " mutexes, forcing use of threads. Use the 'thread'"
594 " option to get rid of this warning.\n");
596 ret = warnings_fatal;
600 if (o->write_iolog_file && o->read_iolog_file) {
601 log_err("fio: read iolog overrides write_iolog\n");
602 free(o->write_iolog_file);
603 o->write_iolog_file = NULL;
604 ret = warnings_fatal;
608 * only really works with 1 file
610 if (o->zone_size && o->open_files > 1)
614 * If zone_range isn't specified, backward compatibility dictates it
615 * should be made equal to zone_size.
617 if (o->zone_size && !o->zone_range)
618 o->zone_range = o->zone_size;
621 * Reads can do overwrites, we always need to pre-create the file
626 if (!o->min_bs[DDIR_READ])
627 o->min_bs[DDIR_READ] = o->bs[DDIR_READ];
628 if (!o->max_bs[DDIR_READ])
629 o->max_bs[DDIR_READ] = o->bs[DDIR_READ];
630 if (!o->min_bs[DDIR_WRITE])
631 o->min_bs[DDIR_WRITE] = o->bs[DDIR_WRITE];
632 if (!o->max_bs[DDIR_WRITE])
633 o->max_bs[DDIR_WRITE] = o->bs[DDIR_WRITE];
634 if (!o->min_bs[DDIR_TRIM])
635 o->min_bs[DDIR_TRIM] = o->bs[DDIR_TRIM];
636 if (!o->max_bs[DDIR_TRIM])
637 o->max_bs[DDIR_TRIM] = o->bs[DDIR_TRIM];
639 o->rw_min_bs = min(o->min_bs[DDIR_READ], o->min_bs[DDIR_WRITE]);
640 o->rw_min_bs = min(o->min_bs[DDIR_TRIM], o->rw_min_bs);
643 * For random IO, allow blockalign offset other than min_bs.
645 if (!o->ba[DDIR_READ] || !td_random(td))
646 o->ba[DDIR_READ] = o->min_bs[DDIR_READ];
647 if (!o->ba[DDIR_WRITE] || !td_random(td))
648 o->ba[DDIR_WRITE] = o->min_bs[DDIR_WRITE];
649 if (!o->ba[DDIR_TRIM] || !td_random(td))
650 o->ba[DDIR_TRIM] = o->min_bs[DDIR_TRIM];
652 if ((o->ba[DDIR_READ] != o->min_bs[DDIR_READ] ||
653 o->ba[DDIR_WRITE] != o->min_bs[DDIR_WRITE] ||
654 o->ba[DDIR_TRIM] != o->min_bs[DDIR_TRIM]) &&
656 log_err("fio: Any use of blockalign= turns off randommap\n");
658 ret = warnings_fatal;
661 if (!o->file_size_high)
662 o->file_size_high = o->file_size_low;
664 if (o->start_delay_high)
665 o->start_delay = get_rand_start_delay(td);
667 if (o->norandommap && o->verify != VERIFY_NONE
668 && !fixed_block_size(o)) {
669 log_err("fio: norandommap given for variable block sizes, "
671 ret = warnings_fatal;
673 if (o->bs_unaligned && (o->odirect || td_ioengine_flagged(td, FIO_RAWIO)))
674 log_err("fio: bs_unaligned may not work with raw io\n");
677 * thinktime_spin must be less than thinktime
679 if (o->thinktime_spin > o->thinktime)
680 o->thinktime_spin = o->thinktime;
683 * The low water mark cannot be bigger than the iodepth
685 if (o->iodepth_low > o->iodepth || !o->iodepth_low)
686 o->iodepth_low = o->iodepth;
689 * If batch number isn't set, default to the same as iodepth
691 if (o->iodepth_batch > o->iodepth || !o->iodepth_batch)
692 o->iodepth_batch = o->iodepth;
695 * If max batch complete number isn't set or set incorrectly,
696 * default to the same as iodepth_batch_complete_min
698 if (o->iodepth_batch_complete_min > o->iodepth_batch_complete_max)
699 o->iodepth_batch_complete_max = o->iodepth_batch_complete_min;
701 if (o->nr_files > td->files_index)
702 o->nr_files = td->files_index;
704 if (o->open_files > o->nr_files || !o->open_files)
705 o->open_files = o->nr_files;
707 if (((o->rate[DDIR_READ] + o->rate[DDIR_WRITE] + o->rate[DDIR_TRIM]) &&
708 (o->rate_iops[DDIR_READ] + o->rate_iops[DDIR_WRITE] + o->rate_iops[DDIR_TRIM])) ||
709 ((o->ratemin[DDIR_READ] + o->ratemin[DDIR_WRITE] + o->ratemin[DDIR_TRIM]) &&
710 (o->rate_iops_min[DDIR_READ] + o->rate_iops_min[DDIR_WRITE] + o->rate_iops_min[DDIR_TRIM]))) {
711 log_err("fio: rate and rate_iops are mutually exclusive\n");
714 if ((o->rate[DDIR_READ] && (o->rate[DDIR_READ] < o->ratemin[DDIR_READ])) ||
715 (o->rate[DDIR_WRITE] && (o->rate[DDIR_WRITE] < o->ratemin[DDIR_WRITE])) ||
716 (o->rate[DDIR_TRIM] && (o->rate[DDIR_TRIM] < o->ratemin[DDIR_TRIM])) ||
717 (o->rate_iops[DDIR_READ] && (o->rate_iops[DDIR_READ] < o->rate_iops_min[DDIR_READ])) ||
718 (o->rate_iops[DDIR_WRITE] && (o->rate_iops[DDIR_WRITE] < o->rate_iops_min[DDIR_WRITE])) ||
719 (o->rate_iops[DDIR_TRIM] && (o->rate_iops[DDIR_TRIM] < o->rate_iops_min[DDIR_TRIM]))) {
720 log_err("fio: minimum rate exceeds rate\n");
724 if (!o->timeout && o->time_based) {
725 log_err("fio: time_based requires a runtime/timeout setting\n");
727 ret = warnings_fatal;
730 if (o->fill_device && !o->size)
733 if (o->verify != VERIFY_NONE) {
734 if (td_write(td) && o->do_verify && o->numjobs > 1 &&
736 !(o->unique_filename &&
737 strstr(o->filename_format, "$jobname") &&
738 strstr(o->filename_format, "$jobnum") &&
739 strstr(o->filename_format, "$filenum")))) {
740 log_info("fio: multiple writers may overwrite blocks "
741 "that belong to other jobs. This can cause "
742 "verification failures.\n");
743 ret = warnings_fatal;
746 if (!fio_option_is_set(o, refill_buffers))
747 o->refill_buffers = 1;
749 if (o->max_bs[DDIR_WRITE] != o->min_bs[DDIR_WRITE] &&
751 o->verify_interval = o->min_bs[DDIR_WRITE];
754 * Verify interval must be smaller or equal to the
757 if (o->verify_interval > o->min_bs[DDIR_WRITE])
758 o->verify_interval = o->min_bs[DDIR_WRITE];
759 else if (td_read(td) && o->verify_interval > o->min_bs[DDIR_READ])
760 o->verify_interval = o->min_bs[DDIR_READ];
763 * Verify interval must be a factor or both min and max
766 if (o->verify_interval % o->min_bs[DDIR_WRITE] ||
767 o->verify_interval % o->max_bs[DDIR_WRITE])
768 o->verify_interval = gcd(o->min_bs[DDIR_WRITE],
769 o->max_bs[DDIR_WRITE]);
773 if (o->invalidate_cache)
774 o->invalidate_cache = 0;
775 if (td_ioengine_flagged(td, FIO_PIPEIO)) {
776 log_info("fio: cannot pre-read files with an IO engine"
777 " that isn't seekable. Pre-read disabled.\n");
778 ret = warnings_fatal;
783 if (td_ioengine_flagged(td, FIO_BIT_BASED))
789 #ifndef FIO_HAVE_ANY_FALLOCATE
790 /* Platform doesn't support any fallocate so force it to none */
791 o->fallocate_mode = FIO_FALLOCATE_NONE;
794 #ifndef CONFIG_FDATASYNC
795 if (o->fdatasync_blocks) {
796 log_info("fio: this platform does not support fdatasync()"
797 " falling back to using fsync(). Use the 'fsync'"
798 " option instead of 'fdatasync' to get rid of"
800 o->fsync_blocks = o->fdatasync_blocks;
801 o->fdatasync_blocks = 0;
802 ret = warnings_fatal;
808 * Windows doesn't support O_DIRECT or O_SYNC with the _open interface,
809 * so fail if we're passed those flags
811 if (td_ioengine_flagged(td, FIO_SYNCIO) && (td->o.odirect || td->o.sync_io)) {
812 log_err("fio: Windows does not support direct or non-buffered io with"
813 " the synchronous ioengines. Use the 'windowsaio' ioengine"
814 " with 'direct=1' and 'iodepth=1' instead.\n");
820 * For fully compressible data, just zero them at init time.
821 * It's faster than repeatedly filling it. For non-zero
822 * compression, we should have refill_buffers set. Set it, unless
823 * the job file already changed it.
825 if (o->compress_percentage) {
826 if (o->compress_percentage == 100) {
828 o->compress_percentage = 0;
829 } else if (!fio_option_is_set(o, refill_buffers))
830 o->refill_buffers = 1;
834 * Using a non-uniform random distribution excludes usage of
837 if (td->o.random_distribution != FIO_RAND_DIST_RANDOM)
838 td->o.norandommap = 1;
841 * If size is set but less than the min block size, complain
843 if (o->size && o->size < td_min_bs(td)) {
844 log_err("fio: size too small, must not be less than minimum block size: %llu < %u\n",
845 (unsigned long long) o->size, td_min_bs(td));
850 * O_ATOMIC implies O_DIRECT
856 * If randseed is set, that overrides randrepeat
858 if (fio_option_is_set(&td->o, rand_seed))
859 td->o.rand_repeatable = 0;
861 if (td_ioengine_flagged(td, FIO_NOEXTEND) && td->o.file_append) {
862 log_err("fio: can't append/extent with IO engine %s\n", td->io_ops->name);
866 if (fio_option_is_set(o, gtod_cpu)) {
868 fio_gtod_set_cpu(o->gtod_cpu);
869 fio_gtod_offload = 1;
872 td->loops = o->loops;
876 if (td->o.block_error_hist && td->o.nr_files != 1) {
877 log_err("fio: block error histogram only available "
878 "with a single file per job, but %d files "
879 "provided\n", td->o.nr_files);
886 /* External engines are specified by "external:name.o") */
887 static const char *get_engine_name(const char *str)
889 char *p = strstr(str, ":");
895 strip_blank_front(&p);
900 static void init_rand_file_service(struct thread_data *td)
902 unsigned long nranges = td->o.nr_files << FIO_FSERVICE_SHIFT;
903 const unsigned int seed = td->rand_seeds[FIO_RAND_FILE_OFF];
905 if (td->o.file_service_type == FIO_FSERVICE_ZIPF) {
906 zipf_init(&td->next_file_zipf, nranges, td->zipf_theta, seed);
907 zipf_disable_hash(&td->next_file_zipf);
908 } else if (td->o.file_service_type == FIO_FSERVICE_PARETO) {
909 pareto_init(&td->next_file_zipf, nranges, td->pareto_h, seed);
910 zipf_disable_hash(&td->next_file_zipf);
911 } else if (td->o.file_service_type == FIO_FSERVICE_GAUSS) {
912 gauss_init(&td->next_file_gauss, nranges, td->gauss_dev, seed);
913 gauss_disable_hash(&td->next_file_gauss);
917 void td_fill_verify_state_seed(struct thread_data *td)
921 if (td->o.random_generator == FIO_RAND_GEN_TAUSWORTHE64)
926 init_rand_seed(&td->verify_state, td->rand_seeds[FIO_RAND_VER_OFF],
930 static void td_fill_rand_seeds_internal(struct thread_data *td, bool use64)
935 * trimwrite is special in that we need to generate the same
936 * offsets to get the "write after trim" effect. If we are
937 * using bssplit to set buffer length distributions, ensure that
938 * we seed the trim and write generators identically.
940 if (td_trimwrite(td)) {
941 init_rand_seed(&td->bsrange_state[DDIR_READ], td->rand_seeds[FIO_RAND_BS_OFF], use64);
942 init_rand_seed(&td->bsrange_state[DDIR_WRITE], td->rand_seeds[FIO_RAND_BS1_OFF], use64);
943 init_rand_seed(&td->bsrange_state[DDIR_TRIM], td->rand_seeds[FIO_RAND_BS1_OFF], use64);
945 init_rand_seed(&td->bsrange_state[DDIR_READ], td->rand_seeds[FIO_RAND_BS_OFF], use64);
946 init_rand_seed(&td->bsrange_state[DDIR_WRITE], td->rand_seeds[FIO_RAND_BS1_OFF], use64);
947 init_rand_seed(&td->bsrange_state[DDIR_TRIM], td->rand_seeds[FIO_RAND_BS2_OFF], use64);
950 td_fill_verify_state_seed(td);
951 init_rand_seed(&td->rwmix_state, td->rand_seeds[FIO_RAND_MIX_OFF], false);
953 if (td->o.file_service_type == FIO_FSERVICE_RANDOM)
954 init_rand_seed(&td->next_file_state, td->rand_seeds[FIO_RAND_FILE_OFF], use64);
955 else if (td->o.file_service_type & __FIO_FSERVICE_NONUNIFORM)
956 init_rand_file_service(td);
958 init_rand_seed(&td->file_size_state, td->rand_seeds[FIO_RAND_FILE_SIZE_OFF], use64);
959 init_rand_seed(&td->trim_state, td->rand_seeds[FIO_RAND_TRIM_OFF], use64);
960 init_rand_seed(&td->delay_state, td->rand_seeds[FIO_RAND_START_DELAY], use64);
961 init_rand_seed(&td->poisson_state[0], td->rand_seeds[FIO_RAND_POISSON_OFF], 0);
962 init_rand_seed(&td->poisson_state[1], td->rand_seeds[FIO_RAND_POISSON2_OFF], 0);
963 init_rand_seed(&td->poisson_state[2], td->rand_seeds[FIO_RAND_POISSON3_OFF], 0);
964 init_rand_seed(&td->dedupe_state, td->rand_seeds[FIO_DEDUPE_OFF], false);
965 init_rand_seed(&td->zone_state, td->rand_seeds[FIO_RAND_ZONE_OFF], false);
970 if (td->o.rand_repeatable)
971 td->rand_seeds[FIO_RAND_BLOCK_OFF] = FIO_RANDSEED * td->thread_number;
973 init_rand_seed(&td->random_state, td->rand_seeds[FIO_RAND_BLOCK_OFF], use64);
975 for (i = 0; i < DDIR_RWDIR_CNT; i++) {
976 struct frand_state *s = &td->seq_rand_state[i];
978 init_rand_seed(s, td->rand_seeds[FIO_RAND_SEQ_RAND_READ_OFF], false);
982 void td_fill_rand_seeds(struct thread_data *td)
986 if (td->o.allrand_repeatable) {
989 for (i = 0; i < FIO_RAND_NR_OFFS; i++)
990 td->rand_seeds[i] = FIO_RANDSEED * td->thread_number
994 if (td->o.random_generator == FIO_RAND_GEN_TAUSWORTHE64)
999 td_fill_rand_seeds_internal(td, use64);
1001 init_rand_seed(&td->buf_state, td->rand_seeds[FIO_RAND_BUF_OFF], use64);
1002 frand_copy(&td->buf_state_prev, &td->buf_state);
1006 * Initializes the ioengine configured for a job, if it has not been done so
1009 int ioengine_load(struct thread_data *td)
1013 if (!td->o.ioengine) {
1014 log_err("fio: internal fault, no IO engine specified\n");
1019 /* An engine is loaded, but the requested ioengine
1022 if (!strcmp(td->io_ops->name, td->o.ioengine)) {
1023 /* The right engine is already loaded */
1027 /* Unload the old engine. */
1031 engine = get_engine_name(td->o.ioengine);
1032 td->io_ops = load_ioengine(td, engine);
1034 log_err("fio: failed to load engine %s\n", engine);
1038 if (td->io_ops->option_struct_size && td->io_ops->options) {
1040 * In cases where td->eo is set, clone it for a child thread.
1041 * This requires that the parent thread has the same ioengine,
1042 * but that requirement must be enforced by the code which
1043 * cloned the thread.
1045 void *origeo = td->eo;
1047 * Otherwise use the default thread options.
1049 if (!origeo && td != &def_thread && def_thread.eo &&
1050 def_thread.io_ops->options == td->io_ops->options)
1051 origeo = def_thread.eo;
1053 options_init(td->io_ops->options);
1054 td->eo = malloc(td->io_ops->option_struct_size);
1056 * Use the default thread as an option template if this uses the
1057 * same options structure and there are non-default options
1061 memcpy(td->eo, origeo, td->io_ops->option_struct_size);
1062 options_mem_dupe(td->io_ops->options, td->eo);
1064 memset(td->eo, 0, td->io_ops->option_struct_size);
1065 fill_default_options(td->eo, td->io_ops->options);
1067 *(struct thread_data **)td->eo = td;
1071 td->io_ops->flags |= FIO_RAWIO;
1073 td_set_ioengine_flags(td);
1077 static void init_flags(struct thread_data *td)
1079 struct thread_options *o = &td->o;
1081 if (o->verify_backlog)
1082 td->flags |= TD_F_VER_BACKLOG;
1083 if (o->trim_backlog)
1084 td->flags |= TD_F_TRIM_BACKLOG;
1085 if (o->read_iolog_file)
1086 td->flags |= TD_F_READ_IOLOG;
1087 if (o->refill_buffers)
1088 td->flags |= TD_F_REFILL_BUFFERS;
1090 * Always scramble buffers if asked to
1092 if (o->scramble_buffers && fio_option_is_set(o, scramble_buffers))
1093 td->flags |= TD_F_SCRAMBLE_BUFFERS;
1095 * But also scramble buffers, unless we were explicitly asked
1098 if (o->scramble_buffers && !(o->zero_buffers &&
1099 fio_option_is_set(o, zero_buffers)))
1100 td->flags |= TD_F_SCRAMBLE_BUFFERS;
1101 if (o->verify != VERIFY_NONE)
1102 td->flags |= TD_F_VER_NONE;
1104 if (o->verify_async || o->io_submit_mode == IO_MODE_OFFLOAD)
1105 td->flags |= TD_F_NEED_LOCK;
1107 if (o->mem_type == MEM_CUDA_MALLOC)
1108 td->flags &= ~TD_F_SCRAMBLE_BUFFERS;
1111 static int setup_random_seeds(struct thread_data *td)
1116 if (!td->o.rand_repeatable && !fio_option_is_set(&td->o, rand_seed)) {
1117 int ret = init_random_seeds(td->rand_seeds, sizeof(td->rand_seeds));
1119 td_fill_rand_seeds(td);
1123 seed = td->o.rand_seed;
1124 for (i = 0; i < 4; i++)
1125 seed *= 0x9e370001UL;
1127 for (i = 0; i < FIO_RAND_NR_OFFS; i++) {
1128 td->rand_seeds[i] = seed * td->thread_number + i;
1129 seed *= 0x9e370001UL;
1132 td_fill_rand_seeds(td);
1143 static struct fpre_keyword {
1144 const char *keyword;
1147 } fpre_keywords[] = {
1148 { .keyword = "$jobname", .key = FPRE_JOBNAME, },
1149 { .keyword = "$jobnum", .key = FPRE_JOBNUM, },
1150 { .keyword = "$filenum", .key = FPRE_FILENUM, },
1151 { .keyword = NULL, },
1154 static char *make_filename(char *buf, size_t buf_size,struct thread_options *o,
1155 const char *jobname, int jobnum, int filenum)
1157 struct fpre_keyword *f;
1158 char copy[PATH_MAX];
1159 size_t dst_left = PATH_MAX - 1;
1161 if (!o->filename_format || !strlen(o->filename_format)) {
1162 sprintf(buf, "%s.%d.%d", jobname, jobnum, filenum);
1166 for (f = &fpre_keywords[0]; f->keyword; f++)
1167 f->strlen = strlen(f->keyword);
1169 buf[buf_size - 1] = '\0';
1170 strncpy(buf, o->filename_format, buf_size - 1);
1172 memset(copy, 0, sizeof(copy));
1173 for (f = &fpre_keywords[0]; f->keyword; f++) {
1175 size_t pre_len, post_start = 0;
1176 char *str, *dst = copy;
1178 str = strcasestr(buf, f->keyword);
1182 pre_len = str - buf;
1183 if (strlen(str) != f->strlen)
1184 post_start = pre_len + f->strlen;
1187 strncpy(dst, buf, pre_len);
1189 dst_left -= pre_len;
1193 case FPRE_JOBNAME: {
1196 ret = snprintf(dst, dst_left, "%s", jobname);
1199 else if (ret > dst_left) {
1200 log_err("fio: truncated filename\n");
1212 ret = snprintf(dst, dst_left, "%d", jobnum);
1215 else if (ret > dst_left) {
1216 log_err("fio: truncated filename\n");
1225 case FPRE_FILENUM: {
1228 ret = snprintf(dst, dst_left, "%d", filenum);
1231 else if (ret > dst_left) {
1232 log_err("fio: truncated filename\n");
1247 strncpy(dst, buf + post_start, dst_left);
1249 strncpy(buf, copy, buf_size - 1);
1256 bool parse_dryrun(void)
1258 return dump_cmdline || parse_only;
1261 static void gen_log_name(char *name, size_t size, const char *logtype,
1262 const char *logname, unsigned int num,
1263 const char *suf, int per_job)
1266 snprintf(name, size, "%s_%s.%d.%s", logname, logtype, num, suf);
1268 snprintf(name, size, "%s_%s.%s", logname, logtype, suf);
1271 static int check_waitees(char *waitee)
1273 struct thread_data *td;
1276 for_each_td(td, i) {
1277 if (td->subjob_number)
1280 ret += !strcmp(td->o.name, waitee);
1286 static bool wait_for_ok(const char *jobname, struct thread_options *o)
1293 if (!strcmp(jobname, o->wait_for)) {
1294 log_err("%s: a job cannot wait for itself (wait_for=%s).\n",
1295 jobname, o->wait_for);
1299 if (!(nw = check_waitees(o->wait_for))) {
1300 log_err("%s: waitee job %s unknown.\n", jobname, o->wait_for);
1305 log_err("%s: multiple waitees %s found,\n"
1306 "please avoid duplicates when using wait_for option.\n",
1307 jobname, o->wait_for);
1315 * Adds a job to the list of things todo. Sanitizes the various options
1316 * to make sure we don't have conflicts, and initializes various
1319 static int add_job(struct thread_data *td, const char *jobname, int job_add_num,
1320 int recursed, int client_type)
1323 char fname[PATH_MAX];
1324 int numjobs, file_alloced;
1325 struct thread_options *o = &td->o;
1326 char logname[PATH_MAX + 32];
1329 * the def_thread is just for options, it's not a real job
1331 if (td == &def_thread)
1337 * if we are just dumping the output command line, don't add the job
1339 if (parse_dryrun()) {
1344 td->client_type = client_type;
1346 if (profile_td_init(td))
1349 if (ioengine_load(td))
1353 if (!o->filename && !td->files_index && !o->read_iolog_file) {
1356 if (o->nr_files == 1 && exists_and_not_regfile(jobname))
1357 add_file(td, jobname, job_add_num, 0);
1359 for (i = 0; i < o->nr_files; i++)
1360 add_file(td, make_filename(fname, sizeof(fname), o, jobname, job_add_num, i), job_add_num, 0);
1364 if (fixup_options(td))
1368 * Belongs to fixup_options, but o->name is not necessarily set as yet
1370 if (!wait_for_ok(jobname, o))
1376 * IO engines only need this for option callbacks, and the address may
1377 * change in subprocesses.
1380 *(struct thread_data **)td->eo = NULL;
1382 if (td_ioengine_flagged(td, FIO_DISKLESSIO)) {
1385 for_each_file(td, f, i)
1386 f->real_file_size = -1ULL;
1389 td->mutex = fio_mutex_init(FIO_MUTEX_LOCKED);
1391 td->ts.clat_percentiles = o->clat_percentiles;
1392 td->ts.percentile_precision = o->percentile_precision;
1393 memcpy(td->ts.percentile_list, o->percentile_list, sizeof(o->percentile_list));
1395 for (i = 0; i < DDIR_RWDIR_CNT; i++) {
1396 td->ts.clat_stat[i].min_val = ULONG_MAX;
1397 td->ts.slat_stat[i].min_val = ULONG_MAX;
1398 td->ts.lat_stat[i].min_val = ULONG_MAX;
1399 td->ts.bw_stat[i].min_val = ULONG_MAX;
1400 td->ts.iops_stat[i].min_val = ULONG_MAX;
1402 td->ddir_seq_nr = o->ddir_seq_nr;
1404 if ((o->stonewall || o->new_group) && prev_group_jobs) {
1405 prev_group_jobs = 0;
1407 if (groupid == INT_MAX) {
1408 log_err("fio: too many groups defined\n");
1413 td->groupid = groupid;
1416 if (setup_random_seeds(td)) {
1417 td_verror(td, errno, "setup_random_seeds");
1424 if (o->write_lat_log) {
1425 struct log_params p = {
1427 .avg_msec = o->log_avg_msec,
1428 .hist_msec = o->log_hist_msec,
1429 .hist_coarseness = o->log_hist_coarseness,
1430 .log_type = IO_LOG_TYPE_LAT,
1431 .log_offset = o->log_offset,
1432 .log_gz = o->log_gz,
1433 .log_gz_store = o->log_gz_store,
1435 const char *pre = o->lat_log_file ? o->lat_log_file : o->name;
1443 gen_log_name(logname, sizeof(logname), "lat", pre,
1444 td->thread_number, suf, o->per_job_logs);
1445 setup_log(&td->lat_log, &p, logname);
1447 gen_log_name(logname, sizeof(logname), "slat", pre,
1448 td->thread_number, suf, o->per_job_logs);
1449 setup_log(&td->slat_log, &p, logname);
1451 gen_log_name(logname, sizeof(logname), "clat", pre,
1452 td->thread_number, suf, o->per_job_logs);
1453 setup_log(&td->clat_log, &p, logname);
1456 if (o->write_hist_log) {
1457 struct log_params p = {
1459 .avg_msec = o->log_avg_msec,
1460 .hist_msec = o->log_hist_msec,
1461 .hist_coarseness = o->log_hist_coarseness,
1462 .log_type = IO_LOG_TYPE_HIST,
1463 .log_offset = o->log_offset,
1464 .log_gz = o->log_gz,
1465 .log_gz_store = o->log_gz_store,
1467 const char *pre = o->hist_log_file ? o->hist_log_file : o->name;
1471 if (td->client_type) {
1472 log_err("fio: --write_hist_log requires zlib in client/server mode\n");
1482 gen_log_name(logname, sizeof(logname), "clat_hist", pre,
1483 td->thread_number, suf, o->per_job_logs);
1484 setup_log(&td->clat_hist_log, &p, logname);
1487 if (o->write_bw_log) {
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_BW,
1494 .log_offset = o->log_offset,
1495 .log_gz = o->log_gz,
1496 .log_gz_store = o->log_gz_store,
1498 const char *pre = o->bw_log_file ? o->bw_log_file : o->name;
1501 if (fio_option_is_set(o, bw_avg_time))
1502 p.avg_msec = min(o->log_avg_msec, o->bw_avg_time);
1504 o->bw_avg_time = p.avg_msec;
1506 p.hist_msec = o->log_hist_msec;
1507 p.hist_coarseness = o->log_hist_coarseness;
1514 gen_log_name(logname, sizeof(logname), "bw", pre,
1515 td->thread_number, suf, o->per_job_logs);
1516 setup_log(&td->bw_log, &p, logname);
1518 if (o->write_iops_log) {
1519 struct log_params p = {
1521 .avg_msec = o->log_avg_msec,
1522 .hist_msec = o->log_hist_msec,
1523 .hist_coarseness = o->log_hist_coarseness,
1524 .log_type = IO_LOG_TYPE_IOPS,
1525 .log_offset = o->log_offset,
1526 .log_gz = o->log_gz,
1527 .log_gz_store = o->log_gz_store,
1529 const char *pre = o->iops_log_file ? o->iops_log_file : o->name;
1532 if (fio_option_is_set(o, iops_avg_time))
1533 p.avg_msec = min(o->log_avg_msec, o->iops_avg_time);
1535 o->iops_avg_time = p.avg_msec;
1537 p.hist_msec = o->log_hist_msec;
1538 p.hist_coarseness = o->log_hist_coarseness;
1545 gen_log_name(logname, sizeof(logname), "iops", pre,
1546 td->thread_number, suf, o->per_job_logs);
1547 setup_log(&td->iops_log, &p, logname);
1551 o->name = strdup(jobname);
1553 if (output_format & FIO_OUTPUT_NORMAL) {
1555 if (is_backend && !recursed)
1556 fio_server_send_add_job(td);
1558 if (!td_ioengine_flagged(td, FIO_NOIO)) {
1559 char *c1, *c2, *c3, *c4;
1560 char *c5 = NULL, *c6 = NULL;
1561 int i2p = is_power_of_2(o->kb_base);
1563 c1 = num2str(o->min_bs[DDIR_READ], 4, 1, i2p, N2S_BYTE);
1564 c2 = num2str(o->max_bs[DDIR_READ], 4, 1, i2p, N2S_BYTE);
1565 c3 = num2str(o->min_bs[DDIR_WRITE], 4, 1, i2p, N2S_BYTE);
1566 c4 = num2str(o->max_bs[DDIR_WRITE], 4, 1, i2p, N2S_BYTE);
1568 if (!o->bs_is_seq_rand) {
1569 c5 = num2str(o->min_bs[DDIR_TRIM], 4, 1, i2p, N2S_BYTE);
1570 c6 = num2str(o->max_bs[DDIR_TRIM], 4, 1, i2p, N2S_BYTE);
1573 log_info("%s: (g=%d): rw=%s, ", td->o.name,
1575 ddir_str(o->td_ddir));
1577 if (o->bs_is_seq_rand)
1578 log_info("bs=(R) %s-%s, (W) %s-%s, bs_is_seq_rand, ",
1581 log_info("bs=(R) %s-%s, (W) %s-%s, (T) %s-%s, ",
1582 c1, c2, c3, c4, c5, c6);
1584 log_info("ioengine=%s, iodepth=%u\n",
1585 td->io_ops->name, o->iodepth);
1594 } else if (job_add_num == 1)
1598 if (td_steadystate_init(td))
1602 * recurse add identical jobs, clear numjobs and stonewall options
1603 * as they don't apply to sub-jobs
1605 numjobs = o->numjobs;
1607 struct thread_data *td_new = get_new_job(false, td, true, jobname);
1612 td_new->o.numjobs = 1;
1613 td_new->o.stonewall = 0;
1614 td_new->o.new_group = 0;
1615 td_new->subjob_number = numjobs;
1616 td_new->o.ss_dur = o->ss_dur * 1000000l;
1617 td_new->o.ss_limit = o->ss_limit;
1620 if (td_new->files) {
1622 for_each_file(td_new, f, i) {
1624 sfree(f->file_name);
1627 free(td_new->files);
1628 td_new->files = NULL;
1630 td_new->files_index = 0;
1631 td_new->files_size = 0;
1632 if (td_new->o.filename) {
1633 free(td_new->o.filename);
1634 td_new->o.filename = NULL;
1638 if (add_job(td_new, jobname, numjobs, 1, client_type))
1649 * Parse as if 'o' was a command line
1651 void add_job_opts(const char **o, int client_type)
1653 struct thread_data *td, *td_parent;
1654 int i, in_global = 1;
1658 td_parent = td = NULL;
1660 if (!strncmp(o[i], "name", 4)) {
1663 add_job(td, jobname, 0, 0, client_type);
1665 sprintf(jobname, "%s", o[i] + 5);
1667 if (in_global && !td_parent)
1668 td_parent = get_new_job(true, &def_thread, false, jobname);
1669 else if (!in_global && !td) {
1671 td_parent = &def_thread;
1672 td = get_new_job(false, td_parent, false, jobname);
1675 fio_options_parse(td_parent, (char **) &o[i], 1);
1677 fio_options_parse(td, (char **) &o[i], 1);
1682 add_job(td, jobname, 0, 0, client_type);
1685 static int skip_this_section(const char *name)
1689 if (!nr_job_sections)
1691 if (!strncmp(name, "global", 6))
1694 for (i = 0; i < nr_job_sections; i++)
1695 if (!strcmp(job_sections[i], name))
1701 static int is_empty_or_comment(char *line)
1705 for (i = 0; i < strlen(line); i++) {
1710 if (!isspace((int) line[i]) && !iscntrl((int) line[i]))
1718 * This is our [ini] type file parser.
1720 static int __parse_jobs_ini(struct thread_data *td,
1721 char *file, int is_buf, int stonewall_flag, int type,
1722 int nested, char *name, char ***popts, int *aopts, int *nopts)
1724 bool global = false;
1728 int ret = 0, stonewall;
1731 int inside_skip = 0;
1733 int i, alloc_opts, num_opts;
1735 dprint(FD_PARSE, "Parsing ini file %s\n", file);
1736 assert(td || !nested);
1741 if (!strcmp(file, "-"))
1744 f = fopen(file, "r");
1749 log_err("fio: unable to open '%s' job file\n", file);
1751 td_verror(td, __err, "job file open");
1756 string = malloc(4096);
1759 * it's really 256 + small bit, 280 should suffice
1763 memset(name, 0, 280);
1767 if (nested && popts) {
1769 alloc_opts = *aopts;
1775 opts = malloc(sizeof(char *) * alloc_opts);
1779 stonewall = stonewall_flag;
1782 * if skip_fgets is set, we already have loaded a line we
1787 p = strsep(&file, "\n");
1789 p = fgets(string, 4096, f);
1795 strip_blank_front(&p);
1798 dprint(FD_PARSE, "%s\n", p);
1799 if (is_empty_or_comment(p))
1803 if (sscanf(p, "[%255[^\n]]", name) != 1) {
1807 log_err("fio: option <%s> outside of "
1808 "[] job section\n", p);
1813 name[strlen(name) - 1] = '\0';
1815 if (skip_this_section(name)) {
1821 dprint(FD_PARSE, "Parsing section [%s]\n", name);
1823 global = !strncmp(name, "global", 6);
1829 log_info("--name=%s ", name);
1833 td = get_new_job(global, &def_thread, false, name);
1840 * Separate multiple job files by a stonewall
1842 if (!global && stonewall) {
1843 td->o.stonewall = stonewall;
1848 memset(opts, 0, alloc_opts * sizeof(char *));
1856 p = strsep(&file, "\n");
1858 p = fgets(string, 4096, f);
1861 dprint(FD_PARSE, "%s", p);
1866 if (is_empty_or_comment(p))
1869 strip_blank_front(&p);
1872 * new section, break out and make sure we don't
1873 * fgets() a new line at the top.
1877 log_err("No new sections in included files\n");
1887 if (!strncmp(p, "include", strlen("include"))) {
1888 char *filename = p + strlen("include") + 1,
1889 *ts, *full_fn = NULL;
1892 * Allow for the include filename
1893 * specification to be relative.
1895 if (access(filename, F_OK) &&
1896 (ts = strrchr(file, '/'))) {
1897 int len = ts - file +
1898 strlen(filename) + 2;
1900 if (!(full_fn = calloc(1, len))) {
1906 file, (ts - file) + 1);
1907 strncpy(full_fn + (ts - file) + 1,
1908 filename, strlen(filename));
1909 full_fn[len - 1] = 0;
1913 ret = __parse_jobs_ini(td, filename, is_buf,
1914 stonewall_flag, type, 1,
1916 &alloc_opts, &num_opts);
1919 log_err("Error %d while parsing "
1920 "include file %s\n",
1933 if (num_opts == alloc_opts) {
1935 opts = realloc(opts,
1936 alloc_opts * sizeof(char *));
1939 opts[num_opts] = strdup(p);
1945 *aopts = alloc_opts;
1950 ret = fio_options_parse(td, opts, num_opts);
1955 ret = add_job(td, name, 0, 0, type);
1957 log_err("fio: job %s dropped\n", name);
1961 for (i = 0; i < num_opts; i++)
1970 while (i < nr_job_sections) {
1971 free(job_sections[i]);
1980 if (!is_buf && f != stdin)
1985 int parse_jobs_ini(char *file, int is_buf, int stonewall_flag, int type)
1987 return __parse_jobs_ini(NULL, file, is_buf, stonewall_flag, type,
1988 0, NULL, NULL, NULL, NULL);
1991 static int fill_def_thread(void)
1993 memset(&def_thread, 0, sizeof(def_thread));
1994 INIT_FLIST_HEAD(&def_thread.opt_list);
1996 fio_getaffinity(getpid(), &def_thread.o.cpumask);
1997 def_thread.o.error_dump = 1;
2000 * fill default options
2002 fio_fill_default_options(&def_thread);
2006 static void show_debug_categories(void)
2008 #ifdef FIO_INC_DEBUG
2009 struct debug_level *dl = &debug_levels[0];
2010 int curlen, first = 1;
2014 int has_next = (dl + 1)->name != NULL;
2016 if (first || curlen + strlen(dl->name) >= 80) {
2021 curlen += printf("\t\t\t%s", dl->name);
2022 curlen += 3 * (8 - 1);
2024 curlen += printf(",");
2026 curlen += printf("%s", dl->name);
2028 curlen += printf(",");
2038 * Following options aren't printed by usage().
2039 * --append-terse - Equivalent to --output-format=terse, see f6a7df53.
2040 * --latency-log - Deprecated option.
2042 static void usage(const char *name)
2044 printf("%s\n", fio_version_string);
2045 printf("%s [options] [job options] <job file(s)>\n", name);
2046 printf(" --debug=options\tEnable debug logging. May be one/more of:\n");
2047 show_debug_categories();
2048 printf(" --parse-only\t\tParse options only, don't start any IO\n");
2049 printf(" --output\t\tWrite output to file\n");
2050 printf(" --bandwidth-log\tGenerate aggregate bandwidth logs\n");
2051 printf(" --minimal\t\tMinimal (terse) output\n");
2052 printf(" --output-format=type\tOutput format (terse,json,json+,normal)\n");
2053 printf(" --terse-version=type\tSet terse version output format"
2054 " (default 3, or 2 or 4)\n");
2055 printf(" --version\t\tPrint version info and exit\n");
2056 printf(" --help\t\tPrint this page\n");
2057 printf(" --cpuclock-test\tPerform test/validation of CPU clock\n");
2058 printf(" --crctest=[type]\tTest speed of checksum functions\n");
2059 printf(" --cmdhelp=cmd\t\tPrint command help, \"all\" for all of"
2061 printf(" --enghelp=engine\tPrint ioengine help, or list"
2062 " available ioengines\n");
2063 printf(" --enghelp=engine,cmd\tPrint help for an ioengine"
2065 printf(" --showcmd\t\tTurn a job file into command line options\n");
2066 printf(" --eta=when\t\tWhen ETA estimate should be printed\n");
2067 printf(" \t\tMay be \"always\", \"never\" or \"auto\"\n");
2068 printf(" --eta-newline=time\tForce a new line for every 'time'");
2069 printf(" period passed\n");
2070 printf(" --status-interval=t\tForce full status dump every");
2071 printf(" 't' period passed\n");
2072 printf(" --readonly\t\tTurn on safety read-only checks, preventing"
2074 printf(" --section=name\tOnly run specified section in job file,"
2075 " multiple sections can be specified\n");
2076 printf(" --alloc-size=kb\tSet smalloc pool to this size in kb"
2078 printf(" --warnings-fatal\tFio parser warnings are fatal\n");
2079 printf(" --max-jobs=nr\t\tMaximum number of threads/processes to support\n");
2080 printf(" --server=args\t\tStart a backend fio server\n");
2081 printf(" --daemonize=pidfile\tBackground fio server, write pid to file\n");
2082 printf(" --client=hostname\tTalk to remote backend(s) fio server at hostname\n");
2083 printf(" --remote-config=file\tTell fio server to load this local job file\n");
2084 printf(" --idle-prof=option\tReport cpu idleness on a system or percpu basis\n"
2085 "\t\t\t(option=system,percpu) or run unit work\n"
2086 "\t\t\tcalibration only (option=calibrate)\n");
2088 printf(" --inflate-log=log\tInflate and output compressed log\n");
2090 printf(" --trigger-file=file\tExecute trigger cmd when file exists\n");
2091 printf(" --trigger-timeout=t\tExecute trigger af this time\n");
2092 printf(" --trigger=cmd\t\tSet this command as local trigger\n");
2093 printf(" --trigger-remote=cmd\tSet this command as remote trigger\n");
2094 printf(" --aux-path=path\tUse this path for fio state generated files\n");
2095 printf("\nFio was written by Jens Axboe <jens.axboe@oracle.com>");
2096 printf("\n Jens Axboe <jaxboe@fusionio.com>");
2097 printf("\n Jens Axboe <axboe@fb.com>\n");
2100 #ifdef FIO_INC_DEBUG
2101 struct debug_level debug_levels[] = {
2102 { .name = "process",
2103 .help = "Process creation/exit logging",
2104 .shift = FD_PROCESS,
2107 .help = "File related action logging",
2111 .help = "IO and IO engine action logging (offsets, queue, completions, etc)",
2115 .help = "Memory allocation/freeing logging",
2118 { .name = "blktrace",
2119 .help = "blktrace action logging",
2120 .shift = FD_BLKTRACE,
2123 .help = "IO verification action logging",
2127 .help = "Random generation logging",
2131 .help = "Parser logging",
2134 { .name = "diskutil",
2135 .help = "Disk utility logging actions",
2136 .shift = FD_DISKUTIL,
2139 .help = "Logging related to creating/destroying jobs",
2143 .help = "Mutex logging",
2146 { .name = "profile",
2147 .help = "Logging related to profiles",
2148 .shift = FD_PROFILE,
2151 .help = "Logging related to time keeping functions",
2155 .help = "Network logging",
2159 .help = "Rate logging",
2162 { .name = "compress",
2163 .help = "Log compression logging",
2164 .shift = FD_COMPRESS,
2166 { .name = "steadystate",
2167 .help = "Steady state detection logging",
2168 .shift = FD_STEADYSTATE,
2170 { .name = "helperthread",
2171 .help = "Helper thread logging",
2172 .shift = FD_HELPERTHREAD,
2177 static int set_debug(const char *string)
2179 struct debug_level *dl;
2180 char *p = (char *) string;
2187 if (!strcmp(string, "?") || !strcmp(string, "help")) {
2188 log_info("fio: dumping debug options:");
2189 for (i = 0; debug_levels[i].name; i++) {
2190 dl = &debug_levels[i];
2191 log_info("%s,", dl->name);
2197 while ((opt = strsep(&p, ",")) != NULL) {
2200 if (!strncmp(opt, "all", 3)) {
2201 log_info("fio: set all debug options\n");
2206 for (i = 0; debug_levels[i].name; i++) {
2207 dl = &debug_levels[i];
2208 found = !strncmp(opt, dl->name, strlen(dl->name));
2212 if (dl->shift == FD_JOB) {
2213 opt = strchr(opt, ':');
2215 log_err("fio: missing job number\n");
2219 fio_debug_jobno = atoi(opt);
2220 log_info("fio: set debug jobno %d\n",
2223 log_info("fio: set debug option %s\n", opt);
2224 fio_debug |= (1UL << dl->shift);
2230 log_err("fio: debug mask %s not found\n", opt);
2235 static int set_debug(const char *string)
2237 log_err("fio: debug tracing not included in build\n");
2242 static void fio_options_fill_optstring(void)
2244 char *ostr = cmd_optstr;
2248 while (l_opts[i].name) {
2249 ostr[c++] = l_opts[i].val;
2250 if (l_opts[i].has_arg == required_argument)
2252 else if (l_opts[i].has_arg == optional_argument) {
2261 static int client_flag_set(char c)
2266 while (l_opts[i].name) {
2267 int val = l_opts[i].val;
2269 if (c == (val & 0xff))
2270 return (val & FIO_CLIENT_FLAG);
2278 static void parse_cmd_client(void *client, char *opt)
2280 fio_client_add_cmd_option(client, opt);
2283 static void show_closest_option(const char *name)
2285 int best_option, best_distance;
2288 while (*name == '-')
2292 best_distance = INT_MAX;
2294 while (l_opts[i].name) {
2295 distance = string_distance(name, l_opts[i].name);
2296 if (distance < best_distance) {
2297 best_distance = distance;
2303 if (best_option != -1 && string_distance_ok(name, best_distance))
2304 log_err("Did you mean %s?\n", l_opts[best_option].name);
2307 static int parse_output_format(const char *optarg)
2309 char *p, *orig, *opt;
2312 p = orig = strdup(optarg);
2316 while ((opt = strsep(&p, ",")) != NULL) {
2317 if (!strcmp(opt, "minimal") ||
2318 !strcmp(opt, "terse") ||
2319 !strcmp(opt, "csv"))
2320 output_format |= FIO_OUTPUT_TERSE;
2321 else if (!strcmp(opt, "json"))
2322 output_format |= FIO_OUTPUT_JSON;
2323 else if (!strcmp(opt, "json+"))
2324 output_format |= (FIO_OUTPUT_JSON | FIO_OUTPUT_JSON_PLUS);
2325 else if (!strcmp(opt, "normal"))
2326 output_format |= FIO_OUTPUT_NORMAL;
2328 log_err("fio: invalid output format %s\n", opt);
2338 int parse_cmd_line(int argc, char *argv[], int client_type)
2340 struct thread_data *td = NULL;
2341 int c, ini_idx = 0, lidx, ret = 0, do_exit = 0, exit_val = 0;
2342 char *ostr = cmd_optstr;
2343 char *pid_file = NULL;
2344 void *cur_client = NULL;
2348 * Reset optind handling, since we may call this multiple times
2353 while ((c = getopt_long_only(argc, argv, ostr, l_opts, &lidx)) != -1) {
2354 if ((c & FIO_CLIENT_FLAG) || client_flag_set(c)) {
2355 parse_cmd_client(cur_client, argv[optind - 1]);
2356 c &= ~FIO_CLIENT_FLAG;
2361 smalloc_pool_size = atoi(optarg);
2362 smalloc_pool_size <<= 10;
2366 log_err("fio: --latency-log is deprecated. Use per-job latency log options.\n");
2376 if (f_out && f_out != stdout)
2379 tmp = fopen(optarg, "w+");
2381 log_err("fio: output file open error: %s\n", strerror(errno));
2386 f_err = f_out = tmp;
2390 output_format = FIO_OUTPUT_TERSE;
2393 if (parse_output_format(optarg)) {
2394 log_err("fio: failed parsing output-format\n");
2401 output_format |= FIO_OUTPUT_TERSE;
2413 fio_show_option_help(optarg);
2420 fio_show_ioengine_help(optarg);
2434 log_info("%s\n", fio_version_string);
2439 terse_version = atoi(optarg);
2440 if (!(terse_version >= 2 && terse_version <= 5)) {
2441 log_err("fio: bad terse version format\n");
2447 if (!strcmp("always", optarg))
2448 eta_print = FIO_ETA_ALWAYS;
2449 else if (!strcmp("never", optarg))
2450 eta_print = FIO_ETA_NEVER;
2455 if (check_str_time(optarg, &t, 1)) {
2456 log_err("fio: failed parsing eta time %s\n", optarg);
2460 eta_new_line = t / 1000;
2464 if (set_debug(optarg))
2474 if (!strcmp(optarg, "global")) {
2475 log_err("fio: can't use global as only "
2481 new_size = (nr_job_sections + 1) * sizeof(char *);
2482 job_sections = realloc(job_sections, new_size);
2483 job_sections[nr_job_sections] = strdup(optarg);
2489 exit_val = iolog_file_inflate(optarg);
2498 exec_profile = strdup(optarg);
2500 case FIO_GETOPT_JOB: {
2501 const char *opt = l_opts[lidx].name;
2504 if (!strncmp(opt, "name", 4) && td) {
2505 ret = add_job(td, td->o.name ?: "fio", 0, 0, client_type);
2512 int is_section = !strncmp(opt, "name", 4);
2515 if (!is_section || !strncmp(val, "global", 6))
2518 if (is_section && skip_this_section(val))
2521 td = get_new_job(global, &def_thread, true, NULL);
2522 if (!td || ioengine_load(td)) {
2531 fio_options_set_ioengine_opts(l_opts, td);
2534 if ((!val || !strlen(val)) &&
2535 l_opts[lidx].has_arg == required_argument) {
2536 log_err("fio: option %s requires an argument\n", opt);
2539 ret = fio_cmd_option_parse(td, opt, val);
2550 if (!ret && !strcmp(opt, "ioengine")) {
2551 if (ioengine_load(td)) {
2558 fio_options_set_ioengine_opts(l_opts, td);
2562 case FIO_GETOPT_IOENGINE: {
2563 const char *opt = l_opts[lidx].name;
2569 ret = fio_cmd_ioengine_option_parse(td, opt, val);
2576 max_jobs = atoi(optarg);
2577 if (!max_jobs || max_jobs > REAL_MAX_JOBS) {
2578 log_err("fio: invalid max jobs: %d\n", max_jobs);
2585 #ifndef CONFIG_NO_SHM
2587 log_err("fio: can't be both client and server\n");
2593 fio_server_set_arg(optarg);
2597 log_err("fio: client/server requires SHM support\n");
2605 pid_file = strdup(optarg);
2608 if ((ret = fio_idle_prof_parse_opt(optarg))) {
2609 /* exit on error and calibration only */
2619 log_err("fio: can't be both client and server\n");
2624 /* if --client parameter contains a pathname */
2625 if (0 == access(optarg, R_OK)) {
2626 /* file contains a list of host addrs or names */
2627 char hostaddr[PATH_MAX] = {0};
2629 FILE * hostf = fopen(optarg, "r");
2631 log_err("fio: could not open client list file %s for read\n", optarg);
2636 sprintf(formatstr, "%%%ds", PATH_MAX - 1);
2638 * read at most PATH_MAX-1 chars from each
2639 * record in this file
2641 while (fscanf(hostf, formatstr, hostaddr) == 1) {
2642 /* expect EVERY host in file to be valid */
2643 if (fio_client_add(&fio_client_ops, hostaddr, &cur_client)) {
2644 log_err("fio: failed adding client %s from file %s\n", hostaddr, optarg);
2651 break; /* no possibility of job file for "this client only" */
2653 if (fio_client_add(&fio_client_ops, optarg, &cur_client)) {
2654 log_err("fio: failed adding client %s\n", optarg);
2660 * If the next argument exists and isn't an option,
2661 * assume it's a job file for this client only.
2663 while (optind < argc) {
2664 if (!strncmp(argv[optind], "--", 2) ||
2665 !strncmp(argv[optind], "-", 1))
2668 if (fio_client_add_ini_file(cur_client, argv[optind], false))
2675 if (fio_client_add_ini_file(cur_client, optarg, true)) {
2683 exit_val = fio_monotonic_clocktest(1);
2688 exit_val = fio_crctest(optarg);
2693 if (check_str_time(optarg, &val, 1)) {
2694 log_err("fio: failed parsing time %s\n", optarg);
2699 status_interval = val / 1000;
2705 trigger_file = strdup(optarg);
2710 trigger_cmd = strdup(optarg);
2713 if (trigger_remote_cmd)
2714 free(trigger_remote_cmd);
2715 trigger_remote_cmd = strdup(optarg);
2720 aux_path = strdup(optarg);
2723 if (check_str_time(optarg, &trigger_timeout, 1)) {
2724 log_err("fio: failed parsing time %s\n", optarg);
2728 trigger_timeout /= 1000000;
2731 log_err("%s: unrecognized option '%s'\n", argv[0],
2733 show_closest_option(argv[optind - 1]);
2743 if (do_exit && !(is_backend || nr_clients))
2746 if (nr_clients && fio_clients_connect())
2749 if (is_backend && backend)
2750 return fio_start_server(pid_file);
2756 ret = add_job(td, td->o.name ?: "fio", 0, 0, client_type);
2762 while (!ret && optind < argc) {
2764 ini_file = realloc(ini_file, ini_idx * sizeof(char *));
2765 ini_file[ini_idx - 1] = strdup(argv[optind]);
2773 int fio_init_options(void)
2778 fio_options_fill_optstring();
2779 fio_options_dup_and_init(l_opts);
2783 if (fill_def_thread())
2789 extern int fio_check_options(struct thread_options *);
2791 int parse_options(int argc, char *argv[])
2793 const int type = FIO_CLIENT_TYPE_CLI;
2796 if (fio_init_options())
2798 if (fio_test_cconv(&def_thread.o))
2799 log_err("fio: failed internal cconv test\n");
2801 job_files = parse_cmd_line(argc, argv, type);
2803 if (job_files > 0) {
2804 for (i = 0; i < job_files; i++) {
2805 if (i && fill_def_thread())
2808 if (fio_clients_send_ini(ini_file[i]))
2811 } else if (!is_backend) {
2812 if (parse_jobs_ini(ini_file[i], 0, i, type))
2817 } else if (nr_clients) {
2818 if (fill_def_thread())
2820 if (fio_clients_send_ini(NULL))
2825 fio_options_free(&def_thread);
2826 filesetup_mem_free();
2828 if (!thread_number) {
2833 if (is_backend || nr_clients)
2838 log_err("No job(s) defined\n\n");
2848 if (output_format & FIO_OUTPUT_NORMAL)
2849 log_info("%s\n", fio_version_string);
2854 void options_default_fill(struct thread_options *o)
2856 memcpy(o, &def_thread.o, sizeof(*o));
2859 struct thread_data *get_global_options(void)