2 * This file contains job initialization and setup functions.
12 #include <sys/types.h>
16 #ifndef FIO_NO_HAVE_SHM_H
29 #include "lib/getopt.h"
30 #include "lib/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 = optional_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);
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;
388 * Return a free job structure.
390 static struct thread_data *get_new_job(int global, struct thread_data *parent,
391 int preserve_eo, const char *jobname)
393 struct thread_data *td;
396 set_cmd_options(&def_thread);
399 if (setup_thread_area()) {
400 log_err("error: failed to setup shm segment\n");
403 if (thread_number >= max_jobs) {
404 log_err("error: maximum number of jobs (%d) reached.\n",
409 td = &threads[thread_number++];
416 td->o.uid = td->o.gid = -1U;
418 dup_files(td, parent);
419 fio_options_mem_dupe(td);
421 profile_add_hooks(td);
423 td->thread_number = thread_number;
424 td->subjob_number = 0;
427 td->o.name = strdup(jobname);
429 if (!parent->o.group_reporting)
436 static void put_job(struct thread_data *td)
438 if (td == &def_thread)
445 log_info("fio: %s\n", td->verror);
447 fio_options_free(td);
454 memset(&threads[td->thread_number - 1], 0, sizeof(*td));
458 static int __setup_rate(struct thread_data *td, enum fio_ddir ddir)
460 unsigned int bs = td->o.min_bs[ddir];
462 assert(ddir_rw(ddir));
464 if (td->o.rate[ddir])
465 td->rate_bps[ddir] = td->o.rate[ddir];
467 td->rate_bps[ddir] = (uint64_t) td->o.rate_iops[ddir] * bs;
469 if (!td->rate_bps[ddir]) {
470 log_err("rate lower than supported\n");
474 td->rate_next_io_time[ddir] = 0;
475 td->rate_io_issue_bytes[ddir] = 0;
480 static int setup_rate(struct thread_data *td)
484 if (td->o.rate[DDIR_READ] || td->o.rate_iops[DDIR_READ])
485 ret = __setup_rate(td, DDIR_READ);
486 if (td->o.rate[DDIR_WRITE] || td->o.rate_iops[DDIR_WRITE])
487 ret |= __setup_rate(td, DDIR_WRITE);
488 if (td->o.rate[DDIR_TRIM] || td->o.rate_iops[DDIR_TRIM])
489 ret |= __setup_rate(td, DDIR_TRIM);
494 static int fixed_block_size(struct thread_options *o)
496 return o->min_bs[DDIR_READ] == o->max_bs[DDIR_READ] &&
497 o->min_bs[DDIR_WRITE] == o->max_bs[DDIR_WRITE] &&
498 o->min_bs[DDIR_TRIM] == o->max_bs[DDIR_TRIM] &&
499 o->min_bs[DDIR_READ] == o->min_bs[DDIR_WRITE] &&
500 o->min_bs[DDIR_READ] == o->min_bs[DDIR_TRIM];
504 static unsigned long long get_rand_start_delay(struct thread_data *td)
506 unsigned long long delayrange;
510 delayrange = td->o.start_delay_high - td->o.start_delay;
512 frand_max = rand_max(&td->delay_state);
513 r = __rand(&td->delay_state);
514 delayrange = (unsigned long long) ((double) delayrange * (r / (frand_max + 1.0)));
516 delayrange += td->o.start_delay;
521 * Lazy way of fixing up options that depend on each other. We could also
522 * define option callback handlers, but this is easier.
524 static int fixup_options(struct thread_data *td)
526 struct thread_options *o = &td->o;
529 #ifndef FIO_HAVE_PSHARED_MUTEX
530 if (!o->use_thread) {
531 log_info("fio: this platform does not support process shared"
532 " mutexes, forcing use of threads. Use the 'thread'"
533 " option to get rid of this warning.\n");
535 ret = warnings_fatal;
539 if (o->write_iolog_file && o->read_iolog_file) {
540 log_err("fio: read iolog overrides write_iolog\n");
541 free(o->write_iolog_file);
542 o->write_iolog_file = NULL;
543 ret = warnings_fatal;
547 * only really works with 1 file
549 if (o->zone_size && o->open_files > 1)
553 * If zone_range isn't specified, backward compatibility dictates it
554 * should be made equal to zone_size.
556 if (o->zone_size && !o->zone_range)
557 o->zone_range = o->zone_size;
560 * Reads can do overwrites, we always need to pre-create the file
562 if (td_read(td) || td_rw(td))
565 if (!o->min_bs[DDIR_READ])
566 o->min_bs[DDIR_READ] = o->bs[DDIR_READ];
567 if (!o->max_bs[DDIR_READ])
568 o->max_bs[DDIR_READ] = o->bs[DDIR_READ];
569 if (!o->min_bs[DDIR_WRITE])
570 o->min_bs[DDIR_WRITE] = o->bs[DDIR_WRITE];
571 if (!o->max_bs[DDIR_WRITE])
572 o->max_bs[DDIR_WRITE] = o->bs[DDIR_WRITE];
573 if (!o->min_bs[DDIR_TRIM])
574 o->min_bs[DDIR_TRIM] = o->bs[DDIR_TRIM];
575 if (!o->max_bs[DDIR_TRIM])
576 o->max_bs[DDIR_TRIM] = o->bs[DDIR_TRIM];
578 o->rw_min_bs = min(o->min_bs[DDIR_READ], o->min_bs[DDIR_WRITE]);
579 o->rw_min_bs = min(o->min_bs[DDIR_TRIM], o->rw_min_bs);
582 * For random IO, allow blockalign offset other than min_bs.
584 if (!o->ba[DDIR_READ] || !td_random(td))
585 o->ba[DDIR_READ] = o->min_bs[DDIR_READ];
586 if (!o->ba[DDIR_WRITE] || !td_random(td))
587 o->ba[DDIR_WRITE] = o->min_bs[DDIR_WRITE];
588 if (!o->ba[DDIR_TRIM] || !td_random(td))
589 o->ba[DDIR_TRIM] = o->min_bs[DDIR_TRIM];
591 if ((o->ba[DDIR_READ] != o->min_bs[DDIR_READ] ||
592 o->ba[DDIR_WRITE] != o->min_bs[DDIR_WRITE] ||
593 o->ba[DDIR_TRIM] != o->min_bs[DDIR_TRIM]) &&
595 log_err("fio: Any use of blockalign= turns off randommap\n");
597 ret = warnings_fatal;
600 if (!o->file_size_high)
601 o->file_size_high = o->file_size_low;
603 if (o->start_delay_high)
604 o->start_delay = get_rand_start_delay(td);
606 if (o->norandommap && o->verify != VERIFY_NONE
607 && !fixed_block_size(o)) {
608 log_err("fio: norandommap given for variable block sizes, "
610 ret = warnings_fatal;
612 if (o->bs_unaligned && (o->odirect || td->io_ops->flags & FIO_RAWIO))
613 log_err("fio: bs_unaligned may not work with raw io\n");
616 * thinktime_spin must be less than thinktime
618 if (o->thinktime_spin > o->thinktime)
619 o->thinktime_spin = o->thinktime;
622 * The low water mark cannot be bigger than the iodepth
624 if (o->iodepth_low > o->iodepth || !o->iodepth_low)
625 o->iodepth_low = o->iodepth;
628 * If batch number isn't set, default to the same as iodepth
630 if (o->iodepth_batch > o->iodepth || !o->iodepth_batch)
631 o->iodepth_batch = o->iodepth;
634 * If max batch complete number isn't set or set incorrectly,
635 * default to the same as iodepth_batch_complete_min
637 if (o->iodepth_batch_complete_min > o->iodepth_batch_complete_max)
638 o->iodepth_batch_complete_max = o->iodepth_batch_complete_min;
640 if (o->nr_files > td->files_index)
641 o->nr_files = td->files_index;
643 if (o->open_files > o->nr_files || !o->open_files)
644 o->open_files = o->nr_files;
646 if (((o->rate[DDIR_READ] + o->rate[DDIR_WRITE] + o->rate[DDIR_TRIM]) &&
647 (o->rate_iops[DDIR_READ] + o->rate_iops[DDIR_WRITE] + o->rate_iops[DDIR_TRIM])) ||
648 ((o->ratemin[DDIR_READ] + o->ratemin[DDIR_WRITE] + o->ratemin[DDIR_TRIM]) &&
649 (o->rate_iops_min[DDIR_READ] + o->rate_iops_min[DDIR_WRITE] + o->rate_iops_min[DDIR_TRIM]))) {
650 log_err("fio: rate and rate_iops are mutually exclusive\n");
653 if ((o->rate[DDIR_READ] && (o->rate[DDIR_READ] < o->ratemin[DDIR_READ])) ||
654 (o->rate[DDIR_WRITE] && (o->rate[DDIR_WRITE] < o->ratemin[DDIR_WRITE])) ||
655 (o->rate[DDIR_TRIM] && (o->rate[DDIR_TRIM] < o->ratemin[DDIR_TRIM])) ||
656 (o->rate_iops[DDIR_READ] && (o->rate_iops[DDIR_READ] < o->rate_iops_min[DDIR_READ])) ||
657 (o->rate_iops[DDIR_WRITE] && (o->rate_iops[DDIR_WRITE] < o->rate_iops_min[DDIR_WRITE])) ||
658 (o->rate_iops[DDIR_TRIM] && (o->rate_iops[DDIR_TRIM] < o->rate_iops_min[DDIR_TRIM]))) {
659 log_err("fio: minimum rate exceeds rate\n");
663 if (!o->timeout && o->time_based) {
664 log_err("fio: time_based requires a runtime/timeout setting\n");
666 ret = warnings_fatal;
669 if (o->fill_device && !o->size)
672 if (o->verify != VERIFY_NONE) {
673 if (td_write(td) && o->do_verify && o->numjobs > 1) {
674 log_info("Multiple writers may overwrite blocks that "
675 "belong to other jobs. This can cause "
676 "verification failures.\n");
677 ret = warnings_fatal;
680 if (!fio_option_is_set(o, refill_buffers))
681 o->refill_buffers = 1;
683 if (o->max_bs[DDIR_WRITE] != o->min_bs[DDIR_WRITE] &&
685 o->verify_interval = o->min_bs[DDIR_WRITE];
688 * Verify interval must be smaller or equal to the
691 if (o->verify_interval > o->min_bs[DDIR_WRITE])
692 o->verify_interval = o->min_bs[DDIR_WRITE];
693 else if (td_read(td) && o->verify_interval > o->min_bs[DDIR_READ])
694 o->verify_interval = o->min_bs[DDIR_READ];
698 o->invalidate_cache = 0;
699 if (td->io_ops->flags & FIO_PIPEIO) {
700 log_info("fio: cannot pre-read files with an IO engine"
701 " that isn't seekable. Pre-read disabled.\n");
702 ret = warnings_fatal;
707 if (td->io_ops->flags & FIO_BIT_BASED)
713 #ifndef CONFIG_FDATASYNC
714 if (o->fdatasync_blocks) {
715 log_info("fio: this platform does not support fdatasync()"
716 " falling back to using fsync(). Use the 'fsync'"
717 " option instead of 'fdatasync' to get rid of"
719 o->fsync_blocks = o->fdatasync_blocks;
720 o->fdatasync_blocks = 0;
721 ret = warnings_fatal;
727 * Windows doesn't support O_DIRECT or O_SYNC with the _open interface,
728 * so fail if we're passed those flags
730 if ((td->io_ops->flags & FIO_SYNCIO) && (td->o.odirect || td->o.sync_io)) {
731 log_err("fio: Windows does not support direct or non-buffered io with"
732 " the synchronous ioengines. Use the 'windowsaio' ioengine"
733 " with 'direct=1' and 'iodepth=1' instead.\n");
739 * For fully compressible data, just zero them at init time.
740 * It's faster than repeatedly filling it.
742 if (td->o.compress_percentage == 100) {
743 td->o.zero_buffers = 1;
744 td->o.compress_percentage = 0;
748 * Using a non-uniform random distribution excludes usage of
751 if (td->o.random_distribution != FIO_RAND_DIST_RANDOM)
752 td->o.norandommap = 1;
755 * If size is set but less than the min block size, complain
757 if (o->size && o->size < td_min_bs(td)) {
758 log_err("fio: size too small, must be larger than the IO size: %llu\n", (unsigned long long) o->size);
763 * O_ATOMIC implies O_DIRECT
769 * If randseed is set, that overrides randrepeat
771 if (fio_option_is_set(&td->o, rand_seed))
772 td->o.rand_repeatable = 0;
774 if ((td->io_ops->flags & FIO_NOEXTEND) && td->o.file_append) {
775 log_err("fio: can't append/extent with IO engine %s\n", td->io_ops->name);
779 if (fio_option_is_set(o, gtod_cpu)) {
781 fio_gtod_set_cpu(o->gtod_cpu);
782 fio_gtod_offload = 1;
785 td->loops = o->loops;
789 if (td->o.block_error_hist && td->o.nr_files != 1) {
790 log_err("fio: block error histogram only available with "
791 "with a single file per job, but %d files "
792 "provided\n", td->o.nr_files);
800 * This function leaks the buffer
802 char *fio_uint_to_kmg(unsigned int val)
804 char *buf = malloc(32);
805 char post[] = { 0, 'K', 'M', 'G', 'P', 'E', 0 };
816 snprintf(buf, 32, "%u%c", val, *p);
820 /* External engines are specified by "external:name.o") */
821 static const char *get_engine_name(const char *str)
823 char *p = strstr(str, ":");
829 strip_blank_front(&p);
834 static int exists_and_not_file(const char *filename)
838 if (lstat(filename, &sb) == -1)
841 /* \\.\ is the device namespace in Windows, where every file
842 * is a device node */
843 if (S_ISREG(sb.st_mode) && strncmp(filename, "\\\\.\\", 4) != 0)
849 static void td_fill_rand_seeds_internal(struct thread_data *td, int use64)
851 init_rand_seed(&td->bsrange_state, td->rand_seeds[FIO_RAND_BS_OFF], use64);
852 init_rand_seed(&td->verify_state, td->rand_seeds[FIO_RAND_VER_OFF], use64);
853 init_rand_seed(&td->rwmix_state, td->rand_seeds[FIO_RAND_MIX_OFF], use64);
855 if (td->o.file_service_type == FIO_FSERVICE_RANDOM)
856 init_rand_seed(&td->next_file_state, td->rand_seeds[FIO_RAND_FILE_OFF], use64);
858 init_rand_seed(&td->file_size_state, td->rand_seeds[FIO_RAND_FILE_SIZE_OFF], use64);
859 init_rand_seed(&td->trim_state, td->rand_seeds[FIO_RAND_TRIM_OFF], use64);
860 init_rand_seed(&td->delay_state, td->rand_seeds[FIO_RAND_START_DELAY], use64);
861 init_rand_seed(&td->poisson_state, td->rand_seeds[FIO_RAND_POISSON_OFF], 0);
866 if (td->o.rand_repeatable)
867 td->rand_seeds[FIO_RAND_BLOCK_OFF] = FIO_RANDSEED * td->thread_number;
869 init_rand_seed(&td->random_state, td->rand_seeds[FIO_RAND_BLOCK_OFF], use64);
870 init_rand_seed(&td->seq_rand_state[DDIR_READ], td->rand_seeds[FIO_RAND_SEQ_RAND_READ_OFF], use64);
871 init_rand_seed(&td->seq_rand_state[DDIR_WRITE], td->rand_seeds[FIO_RAND_SEQ_RAND_WRITE_OFF], use64);
872 init_rand_seed(&td->seq_rand_state[DDIR_TRIM], td->rand_seeds[FIO_RAND_SEQ_RAND_TRIM_OFF], use64);
875 void td_fill_rand_seeds(struct thread_data *td)
879 if (td->o.allrand_repeatable) {
882 for (i = 0; i < FIO_RAND_NR_OFFS; i++)
883 td->rand_seeds[i] = FIO_RANDSEED * td->thread_number
887 if (td->o.random_generator == FIO_RAND_GEN_TAUSWORTHE64)
892 td_fill_rand_seeds_internal(td, use64);
894 init_rand_seed(&td->buf_state, td->rand_seeds[FIO_RAND_BUF_OFF], use64);
895 frand_copy(&td->buf_state_prev, &td->buf_state);
897 init_rand_seed(&td->dedupe_state, td->rand_seeds[FIO_DEDUPE_OFF], use64);
901 * Initializes the ioengine configured for a job, if it has not been done so
904 int ioengine_load(struct thread_data *td)
909 * Engine has already been loaded.
913 if (!td->o.ioengine) {
914 log_err("fio: internal fault, no IO engine specified\n");
918 engine = get_engine_name(td->o.ioengine);
919 td->io_ops = load_ioengine(td, engine);
921 log_err("fio: failed to load engine %s\n", engine);
925 if (td->io_ops->option_struct_size && td->io_ops->options) {
927 * In cases where td->eo is set, clone it for a child thread.
928 * This requires that the parent thread has the same ioengine,
929 * but that requirement must be enforced by the code which
932 void *origeo = td->eo;
934 * Otherwise use the default thread options.
936 if (!origeo && td != &def_thread && def_thread.eo &&
937 def_thread.io_ops->options == td->io_ops->options)
938 origeo = def_thread.eo;
940 options_init(td->io_ops->options);
941 td->eo = malloc(td->io_ops->option_struct_size);
943 * Use the default thread as an option template if this uses the
944 * same options structure and there are non-default options
948 memcpy(td->eo, origeo, td->io_ops->option_struct_size);
949 options_mem_dupe(td->eo, td->io_ops->options);
951 memset(td->eo, 0, td->io_ops->option_struct_size);
952 fill_default_options(td->eo, td->io_ops->options);
954 *(struct thread_data **)td->eo = td;
960 static void init_flags(struct thread_data *td)
962 struct thread_options *o = &td->o;
964 if (o->verify_backlog)
965 td->flags |= TD_F_VER_BACKLOG;
967 td->flags |= TD_F_TRIM_BACKLOG;
968 if (o->read_iolog_file)
969 td->flags |= TD_F_READ_IOLOG;
970 if (o->refill_buffers)
971 td->flags |= TD_F_REFILL_BUFFERS;
973 * Always scramble buffers if asked to
975 if (o->scramble_buffers && fio_option_is_set(o, scramble_buffers))
976 td->flags |= TD_F_SCRAMBLE_BUFFERS;
978 * But also scramble buffers, unless we were explicitly asked
981 if (o->scramble_buffers && !(o->zero_buffers &&
982 fio_option_is_set(o, zero_buffers)))
983 td->flags |= TD_F_SCRAMBLE_BUFFERS;
984 if (o->verify != VERIFY_NONE)
985 td->flags |= TD_F_VER_NONE;
987 if (o->verify_async || o->io_submit_mode == IO_MODE_OFFLOAD)
988 td->flags |= TD_F_NEED_LOCK;
991 static int setup_random_seeds(struct thread_data *td)
996 if (!td->o.rand_repeatable && !fio_option_is_set(&td->o, rand_seed))
997 return init_random_state(td, td->rand_seeds, sizeof(td->rand_seeds));
999 seed = td->o.rand_seed;
1000 for (i = 0; i < 4; i++)
1001 seed *= 0x9e370001UL;
1003 for (i = 0; i < FIO_RAND_NR_OFFS; i++) {
1004 td->rand_seeds[i] = seed;
1005 seed *= 0x9e370001UL;
1008 td_fill_rand_seeds(td);
1019 static struct fpre_keyword {
1020 const char *keyword;
1023 } fpre_keywords[] = {
1024 { .keyword = "$jobname", .key = FPRE_JOBNAME, },
1025 { .keyword = "$jobnum", .key = FPRE_JOBNUM, },
1026 { .keyword = "$filenum", .key = FPRE_FILENUM, },
1027 { .keyword = NULL, },
1030 static char *make_filename(char *buf, size_t buf_size,struct thread_options *o,
1031 const char *jobname, int jobnum, int filenum)
1033 struct fpre_keyword *f;
1034 char copy[PATH_MAX];
1035 size_t dst_left = PATH_MAX - 1;
1037 if (!o->filename_format || !strlen(o->filename_format)) {
1038 sprintf(buf, "%s.%d.%d", jobname, jobnum, filenum);
1042 for (f = &fpre_keywords[0]; f->keyword; f++)
1043 f->strlen = strlen(f->keyword);
1045 buf[buf_size - 1] = '\0';
1046 strncpy(buf, o->filename_format, buf_size - 1);
1048 memset(copy, 0, sizeof(copy));
1049 for (f = &fpre_keywords[0]; f->keyword; f++) {
1051 size_t pre_len, post_start = 0;
1052 char *str, *dst = copy;
1054 str = strcasestr(buf, f->keyword);
1058 pre_len = str - buf;
1059 if (strlen(str) != f->strlen)
1060 post_start = pre_len + f->strlen;
1063 strncpy(dst, buf, pre_len);
1065 dst_left -= pre_len;
1069 case FPRE_JOBNAME: {
1072 ret = snprintf(dst, dst_left, "%s", jobname);
1075 else if (ret > dst_left) {
1076 log_err("fio: truncated filename\n");
1088 ret = snprintf(dst, dst_left, "%d", jobnum);
1091 else if (ret > dst_left) {
1092 log_err("fio: truncated filename\n");
1101 case FPRE_FILENUM: {
1104 ret = snprintf(dst, dst_left, "%d", filenum);
1107 else if (ret > dst_left) {
1108 log_err("fio: truncated filename\n");
1123 strncpy(dst, buf + post_start, dst_left);
1125 strncpy(buf, copy, buf_size - 1);
1132 int parse_dryrun(void)
1134 return dump_cmdline || parse_only;
1137 static void gen_log_name(char *name, size_t size, const char *logtype,
1138 const char *logname, unsigned int num,
1139 const char *suf, int per_job)
1142 snprintf(name, size, "%s_%s.%d.%s", logname, logtype, num, suf);
1144 snprintf(name, size, "%s_%s.%s", logname, logtype, suf);
1148 * Adds a job to the list of things todo. Sanitizes the various options
1149 * to make sure we don't have conflicts, and initializes various
1152 static int add_job(struct thread_data *td, const char *jobname, int job_add_num,
1153 int recursed, int client_type)
1156 char fname[PATH_MAX];
1157 int numjobs, file_alloced;
1158 struct thread_options *o = &td->o;
1159 char logname[PATH_MAX + 32];
1162 * the def_thread is just for options, it's not a real job
1164 if (td == &def_thread)
1170 * if we are just dumping the output command line, don't add the job
1172 if (parse_dryrun()) {
1177 td->client_type = client_type;
1179 if (profile_td_init(td))
1182 if (ioengine_load(td))
1186 td->io_ops->flags |= FIO_RAWIO;
1189 if (!o->filename && !td->files_index && !o->read_iolog_file) {
1192 if (o->nr_files == 1 && exists_and_not_file(jobname))
1193 add_file(td, jobname, job_add_num, 0);
1195 for (i = 0; i < o->nr_files; i++)
1196 add_file(td, make_filename(fname, sizeof(fname), o, jobname, job_add_num, i), job_add_num, 0);
1200 if (fixup_options(td))
1206 * IO engines only need this for option callbacks, and the address may
1207 * change in subprocesses.
1210 *(struct thread_data **)td->eo = NULL;
1212 if (td->io_ops->flags & FIO_DISKLESSIO) {
1215 for_each_file(td, f, i)
1216 f->real_file_size = -1ULL;
1219 td->mutex = fio_mutex_init(FIO_MUTEX_LOCKED);
1221 td->ts.clat_percentiles = o->clat_percentiles;
1222 td->ts.percentile_precision = o->percentile_precision;
1223 memcpy(td->ts.percentile_list, o->percentile_list, sizeof(o->percentile_list));
1225 for (i = 0; i < DDIR_RWDIR_CNT; i++) {
1226 td->ts.clat_stat[i].min_val = ULONG_MAX;
1227 td->ts.slat_stat[i].min_val = ULONG_MAX;
1228 td->ts.lat_stat[i].min_val = ULONG_MAX;
1229 td->ts.bw_stat[i].min_val = ULONG_MAX;
1231 td->ddir_seq_nr = o->ddir_seq_nr;
1233 if ((o->stonewall || o->new_group) && prev_group_jobs) {
1234 prev_group_jobs = 0;
1236 if (groupid == INT_MAX) {
1237 log_err("fio: too many groups defined\n");
1242 td->groupid = groupid;
1245 if (setup_random_seeds(td)) {
1246 td_verror(td, errno, "init_random_state");
1253 if (o->lat_log_file) {
1254 struct log_params p = {
1256 .avg_msec = o->log_avg_msec,
1257 .log_type = IO_LOG_TYPE_LAT,
1258 .log_offset = o->log_offset,
1259 .log_gz = o->log_gz,
1260 .log_gz_store = o->log_gz_store,
1269 gen_log_name(logname, sizeof(logname), "lat", o->lat_log_file,
1270 td->thread_number, suf, o->per_job_logs);
1271 setup_log(&td->lat_log, &p, logname);
1273 gen_log_name(logname, sizeof(logname), "slat", o->lat_log_file,
1274 td->thread_number, suf, o->per_job_logs);
1275 setup_log(&td->slat_log, &p, logname);
1277 gen_log_name(logname, sizeof(logname), "clat", o->lat_log_file,
1278 td->thread_number, suf, o->per_job_logs);
1279 setup_log(&td->clat_log, &p, logname);
1281 if (o->bw_log_file) {
1282 struct log_params p = {
1284 .avg_msec = o->log_avg_msec,
1285 .log_type = IO_LOG_TYPE_BW,
1286 .log_offset = o->log_offset,
1287 .log_gz = o->log_gz,
1288 .log_gz_store = o->log_gz_store,
1297 gen_log_name(logname, sizeof(logname), "bw", o->bw_log_file,
1298 td->thread_number, suf, o->per_job_logs);
1299 setup_log(&td->bw_log, &p, logname);
1301 if (o->iops_log_file) {
1302 struct log_params p = {
1304 .avg_msec = o->log_avg_msec,
1305 .log_type = IO_LOG_TYPE_IOPS,
1306 .log_offset = o->log_offset,
1307 .log_gz = o->log_gz,
1308 .log_gz_store = o->log_gz_store,
1317 gen_log_name(logname, sizeof(logname), "iops", o->iops_log_file,
1318 td->thread_number, suf, o->per_job_logs);
1319 setup_log(&td->iops_log, &p, logname);
1323 o->name = strdup(jobname);
1325 if (output_format & FIO_OUTPUT_NORMAL) {
1327 if (is_backend && !recursed)
1328 fio_server_send_add_job(td);
1330 if (!(td->io_ops->flags & FIO_NOIO)) {
1331 char *c1, *c2, *c3, *c4;
1332 char *c5 = NULL, *c6 = NULL;
1334 c1 = fio_uint_to_kmg(o->min_bs[DDIR_READ]);
1335 c2 = fio_uint_to_kmg(o->max_bs[DDIR_READ]);
1336 c3 = fio_uint_to_kmg(o->min_bs[DDIR_WRITE]);
1337 c4 = fio_uint_to_kmg(o->max_bs[DDIR_WRITE]);
1339 if (!o->bs_is_seq_rand) {
1340 c5 = fio_uint_to_kmg(o->min_bs[DDIR_TRIM]);
1341 c6 = fio_uint_to_kmg(o->max_bs[DDIR_TRIM]);
1344 log_info("%s: (g=%d): rw=%s, ", td->o.name,
1346 ddir_str(o->td_ddir));
1348 if (o->bs_is_seq_rand)
1349 log_info("bs(seq/rand)=%s-%s/%s-%s, ",
1352 log_info("bs=%s-%s/%s-%s/%s-%s, ",
1353 c1, c2, c3, c4, c5, c6);
1355 log_info("ioengine=%s, iodepth=%u\n",
1356 td->io_ops->name, o->iodepth);
1365 } else if (job_add_num == 1)
1370 * recurse add identical jobs, clear numjobs and stonewall options
1371 * as they don't apply to sub-jobs
1373 numjobs = o->numjobs;
1375 struct thread_data *td_new = get_new_job(0, td, 1, jobname);
1380 td_new->o.numjobs = 1;
1381 td_new->o.stonewall = 0;
1382 td_new->o.new_group = 0;
1383 td_new->subjob_number = numjobs;
1386 if (td_new->files) {
1388 for_each_file(td_new, f, i) {
1390 sfree(f->file_name);
1393 free(td_new->files);
1394 td_new->files = NULL;
1396 td_new->files_index = 0;
1397 td_new->files_size = 0;
1398 if (td_new->o.filename) {
1399 free(td_new->o.filename);
1400 td_new->o.filename = NULL;
1404 if (add_job(td_new, jobname, numjobs, 1, client_type))
1415 * Parse as if 'o' was a command line
1417 void add_job_opts(const char **o, int client_type)
1419 struct thread_data *td, *td_parent;
1420 int i, in_global = 1;
1424 td_parent = td = NULL;
1426 if (!strncmp(o[i], "name", 4)) {
1429 add_job(td, jobname, 0, 0, client_type);
1431 sprintf(jobname, "%s", o[i] + 5);
1433 if (in_global && !td_parent)
1434 td_parent = get_new_job(1, &def_thread, 0, jobname);
1435 else if (!in_global && !td) {
1437 td_parent = &def_thread;
1438 td = get_new_job(0, td_parent, 0, jobname);
1441 fio_options_parse(td_parent, (char **) &o[i], 1, 0);
1443 fio_options_parse(td, (char **) &o[i], 1, 0);
1448 add_job(td, jobname, 0, 0, client_type);
1451 static int skip_this_section(const char *name)
1455 if (!nr_job_sections)
1457 if (!strncmp(name, "global", 6))
1460 for (i = 0; i < nr_job_sections; i++)
1461 if (!strcmp(job_sections[i], name))
1467 static int is_empty_or_comment(char *line)
1471 for (i = 0; i < strlen(line); i++) {
1476 if (!isspace((int) line[i]) && !iscntrl((int) line[i]))
1484 * This is our [ini] type file parser.
1486 int __parse_jobs_ini(struct thread_data *td,
1487 char *file, int is_buf, int stonewall_flag, int type,
1488 int nested, char *name, char ***popts, int *aopts, int *nopts)
1490 unsigned int global = 0;
1494 int ret = 0, stonewall;
1497 int inside_skip = 0;
1499 int i, alloc_opts, num_opts;
1501 dprint(FD_PARSE, "Parsing ini file %s\n", file);
1502 assert(td || !nested);
1507 if (!strcmp(file, "-"))
1510 f = fopen(file, "r");
1515 log_err("fio: unable to open '%s' job file\n", file);
1517 td_verror(td, __err, "job file open");
1522 string = malloc(4096);
1525 * it's really 256 + small bit, 280 should suffice
1529 memset(name, 0, 280);
1533 if (nested && popts) {
1535 alloc_opts = *aopts;
1541 opts = malloc(sizeof(char *) * alloc_opts);
1545 stonewall = stonewall_flag;
1548 * if skip_fgets is set, we already have loaded a line we
1553 p = strsep(&file, "\n");
1555 p = fgets(string, 4096, f);
1561 strip_blank_front(&p);
1564 dprint(FD_PARSE, "%s\n", p);
1565 if (is_empty_or_comment(p))
1569 if (sscanf(p, "[%255[^\n]]", name) != 1) {
1573 log_err("fio: option <%s> outside of "
1574 "[] job section\n", p);
1579 name[strlen(name) - 1] = '\0';
1581 if (skip_this_section(name)) {
1587 dprint(FD_PARSE, "Parsing section [%s]\n", name);
1589 global = !strncmp(name, "global", 6);
1595 log_info("--name=%s ", name);
1599 td = get_new_job(global, &def_thread, 0, name);
1606 * Separate multiple job files by a stonewall
1608 if (!global && stonewall) {
1609 td->o.stonewall = stonewall;
1614 memset(opts, 0, alloc_opts * sizeof(char *));
1622 p = strsep(&file, "\n");
1624 p = fgets(string, 4096, f);
1627 dprint(FD_PARSE, "%s", p);
1632 if (is_empty_or_comment(p))
1635 strip_blank_front(&p);
1638 * new section, break out and make sure we don't
1639 * fgets() a new line at the top.
1643 log_err("No new sections in included files\n");
1653 if (!strncmp(p, "include", strlen("include"))) {
1654 char *filename = p + strlen("include") + 1;
1656 if ((ret = __parse_jobs_ini(td, filename,
1657 is_buf, stonewall_flag, type, 1,
1658 name, &opts, &alloc_opts, &num_opts))) {
1659 log_err("Error %d while parsing include file %s\n",
1666 if (num_opts == alloc_opts) {
1668 opts = realloc(opts,
1669 alloc_opts * sizeof(char *));
1672 opts[num_opts] = strdup(p);
1678 *aopts = alloc_opts;
1683 ret = fio_options_parse(td, opts, num_opts, dump_cmdline);
1685 ret = add_job(td, name, 0, 0, type);
1687 log_err("fio: job %s dropped\n", name);
1691 for (i = 0; i < num_opts; i++)
1700 while (i < nr_job_sections) {
1701 free(job_sections[i]);
1710 if (!is_buf && f != stdin)
1715 int parse_jobs_ini(char *file, int is_buf, int stonewall_flag, int type)
1717 return __parse_jobs_ini(NULL, file, is_buf, stonewall_flag, type,
1718 0, NULL, NULL, NULL, NULL);
1721 static int fill_def_thread(void)
1723 memset(&def_thread, 0, sizeof(def_thread));
1725 fio_getaffinity(getpid(), &def_thread.o.cpumask);
1726 def_thread.o.error_dump = 1;
1729 * fill default options
1731 fio_fill_default_options(&def_thread);
1735 static void show_debug_categories(void)
1737 struct debug_level *dl = &debug_levels[0];
1738 int curlen, first = 1;
1742 int has_next = (dl + 1)->name != NULL;
1744 if (first || curlen + strlen(dl->name) >= 80) {
1749 curlen += printf("\t\t\t%s", dl->name);
1750 curlen += 3 * (8 - 1);
1752 curlen += printf(",");
1754 curlen += printf("%s", dl->name);
1756 curlen += printf(",");
1764 static void usage(const char *name)
1766 printf("%s\n", fio_version_string);
1767 printf("%s [options] [job options] <job file(s)>\n", name);
1768 printf(" --debug=options\tEnable debug logging. May be one/more of:\n");
1769 show_debug_categories();
1770 printf(" --parse-only\t\tParse options only, don't start any IO\n");
1771 printf(" --output\t\tWrite output to file\n");
1772 printf(" --runtime\t\tRuntime in seconds\n");
1773 printf(" --bandwidth-log\tGenerate per-job bandwidth logs\n");
1774 printf(" --minimal\t\tMinimal (terse) output\n");
1775 printf(" --output-format=x\tOutput format (terse,json,json+,normal)\n");
1776 printf(" --terse-version=x\tSet terse version output format to 'x'\n");
1777 printf(" --version\t\tPrint version info and exit\n");
1778 printf(" --help\t\tPrint this page\n");
1779 printf(" --cpuclock-test\tPerform test/validation of CPU clock\n");
1780 printf(" --crctest\t\tTest speed of checksum functions\n");
1781 printf(" --cmdhelp=cmd\t\tPrint command help, \"all\" for all of"
1783 printf(" --enghelp=engine\tPrint ioengine help, or list"
1784 " available ioengines\n");
1785 printf(" --enghelp=engine,cmd\tPrint help for an ioengine"
1787 printf(" --showcmd\t\tTurn a job file into command line options\n");
1788 printf(" --eta=when\t\tWhen ETA estimate should be printed\n");
1789 printf(" \t\tMay be \"always\", \"never\" or \"auto\"\n");
1790 printf(" --eta-newline=time\tForce a new line for every 'time'");
1791 printf(" period passed\n");
1792 printf(" --status-interval=t\tForce full status dump every");
1793 printf(" 't' period passed\n");
1794 printf(" --readonly\t\tTurn on safety read-only checks, preventing"
1796 printf(" --section=name\tOnly run specified section in job file\n");
1797 printf(" --alloc-size=kb\tSet smalloc pool to this size in kb"
1799 printf(" --warnings-fatal\tFio parser warnings are fatal\n");
1800 printf(" --max-jobs=nr\t\tMaximum number of threads/processes to support\n");
1801 printf(" --server=args\t\tStart a backend fio server\n");
1802 printf(" --daemonize=pidfile\tBackground fio server, write pid to file\n");
1803 printf(" --client=hostname\tTalk to remote backend fio server at hostname\n");
1804 printf(" --remote-config=file\tTell fio server to load this local job file\n");
1805 printf(" --idle-prof=option\tReport cpu idleness on a system or percpu basis\n"
1806 "\t\t\t(option=system,percpu) or run unit work\n"
1807 "\t\t\tcalibration only (option=calibrate)\n");
1809 printf(" --inflate-log=log\tInflate and output compressed log\n");
1811 printf(" --trigger-file=file\tExecute trigger cmd when file exists\n");
1812 printf(" --trigger-timeout=t\tExecute trigger af this time\n");
1813 printf(" --trigger=cmd\t\tSet this command as local trigger\n");
1814 printf(" --trigger-remote=cmd\tSet this command as remote trigger\n");
1815 printf(" --aux-path=path\tUse this path for fio state generated files\n");
1816 printf("\nFio was written by Jens Axboe <jens.axboe@oracle.com>");
1817 printf("\n Jens Axboe <jaxboe@fusionio.com>");
1818 printf("\n Jens Axboe <axboe@fb.com>\n");
1821 #ifdef FIO_INC_DEBUG
1822 struct debug_level debug_levels[] = {
1823 { .name = "process",
1824 .help = "Process creation/exit logging",
1825 .shift = FD_PROCESS,
1828 .help = "File related action logging",
1832 .help = "IO and IO engine action logging (offsets, queue, completions, etc)",
1836 .help = "Memory allocation/freeing logging",
1839 { .name = "blktrace",
1840 .help = "blktrace action logging",
1841 .shift = FD_BLKTRACE,
1844 .help = "IO verification action logging",
1848 .help = "Random generation logging",
1852 .help = "Parser logging",
1855 { .name = "diskutil",
1856 .help = "Disk utility logging actions",
1857 .shift = FD_DISKUTIL,
1860 .help = "Logging related to creating/destroying jobs",
1864 .help = "Mutex logging",
1867 { .name = "profile",
1868 .help = "Logging related to profiles",
1869 .shift = FD_PROFILE,
1872 .help = "Logging related to time keeping functions",
1876 .help = "Network logging",
1880 .help = "Rate logging",
1883 { .name = "compress",
1884 .help = "Log compression logging",
1885 .shift = FD_COMPRESS,
1890 static int set_debug(const char *string)
1892 struct debug_level *dl;
1893 char *p = (char *) string;
1897 if (!strcmp(string, "?") || !strcmp(string, "help")) {
1898 log_info("fio: dumping debug options:");
1899 for (i = 0; debug_levels[i].name; i++) {
1900 dl = &debug_levels[i];
1901 log_info("%s,", dl->name);
1907 while ((opt = strsep(&p, ",")) != NULL) {
1910 if (!strncmp(opt, "all", 3)) {
1911 log_info("fio: set all debug options\n");
1916 for (i = 0; debug_levels[i].name; i++) {
1917 dl = &debug_levels[i];
1918 found = !strncmp(opt, dl->name, strlen(dl->name));
1922 if (dl->shift == FD_JOB) {
1923 opt = strchr(opt, ':');
1925 log_err("fio: missing job number\n");
1929 fio_debug_jobno = atoi(opt);
1930 log_info("fio: set debug jobno %d\n",
1933 log_info("fio: set debug option %s\n", opt);
1934 fio_debug |= (1UL << dl->shift);
1940 log_err("fio: debug mask %s not found\n", opt);
1945 static int set_debug(const char *string)
1947 log_err("fio: debug tracing not included in build\n");
1952 static void fio_options_fill_optstring(void)
1954 char *ostr = cmd_optstr;
1958 while (l_opts[i].name) {
1959 ostr[c++] = l_opts[i].val;
1960 if (l_opts[i].has_arg == required_argument)
1962 else if (l_opts[i].has_arg == optional_argument) {
1971 static int client_flag_set(char c)
1976 while (l_opts[i].name) {
1977 int val = l_opts[i].val;
1979 if (c == (val & 0xff))
1980 return (val & FIO_CLIENT_FLAG);
1988 static void parse_cmd_client(void *client, char *opt)
1990 fio_client_add_cmd_option(client, opt);
1993 static void show_closest_option(const char *name)
1995 int best_option, best_distance;
1998 while (*name == '-')
2002 best_distance = INT_MAX;
2004 while (l_opts[i].name) {
2005 distance = string_distance(name, l_opts[i].name);
2006 if (distance < best_distance) {
2007 best_distance = distance;
2013 if (best_option != -1 && string_distance_ok(name, best_distance))
2014 log_err("Did you mean %s?\n", l_opts[best_option].name);
2017 static int parse_output_format(const char *optarg)
2019 char *p, *orig, *opt;
2022 p = orig = strdup(optarg);
2026 while ((opt = strsep(&p, ",")) != NULL) {
2027 if (!strcmp(opt, "minimal") ||
2028 !strcmp(opt, "terse") ||
2029 !strcmp(opt, "csv"))
2030 output_format |= FIO_OUTPUT_TERSE;
2031 else if (!strcmp(opt, "json"))
2032 output_format |= FIO_OUTPUT_JSON;
2033 else if (!strcmp(opt, "json+"))
2034 output_format |= (FIO_OUTPUT_JSON | FIO_OUTPUT_JSON_PLUS);
2035 else if (!strcmp(opt, "normal"))
2036 output_format |= FIO_OUTPUT_NORMAL;
2038 log_err("fio: invalid output format %s\n", opt);
2048 int parse_cmd_line(int argc, char *argv[], int client_type)
2050 struct thread_data *td = NULL;
2051 int c, ini_idx = 0, lidx, ret = 0, do_exit = 0, exit_val = 0;
2052 char *ostr = cmd_optstr;
2053 void *pid_file = NULL;
2054 void *cur_client = NULL;
2058 * Reset optind handling, since we may call this multiple times
2063 while ((c = getopt_long_only(argc, argv, ostr, l_opts, &lidx)) != -1) {
2064 if ((c & FIO_CLIENT_FLAG) || client_flag_set(c)) {
2065 parse_cmd_client(cur_client, argv[optind - 1]);
2066 c &= ~FIO_CLIENT_FLAG;
2071 smalloc_pool_size = atoi(optarg);
2074 if (check_str_time(optarg, &def_timeout, 1)) {
2075 log_err("fio: failed parsing time %s\n", optarg);
2081 log_err("fio: --latency-log is deprecated. Use per-job latency log options.\n");
2089 if (f_out && f_out != stdout)
2092 f_out = fopen(optarg, "w+");
2094 perror("fopen output");
2100 output_format = FIO_OUTPUT_TERSE;
2104 log_err("fio: missing --output-format argument\n");
2109 if (parse_output_format(optarg)) {
2110 log_err("fio: failed parsing output-format\n");
2117 output_format |= FIO_OUTPUT_TERSE;
2129 fio_show_option_help(optarg);
2136 fio_show_ioengine_help(optarg);
2150 log_info("%s\n", fio_version_string);
2155 terse_version = atoi(optarg);
2156 if (!(terse_version == 2 || terse_version == 3 ||
2157 terse_version == 4)) {
2158 log_err("fio: bad terse version format\n");
2164 if (!strcmp("always", optarg))
2165 eta_print = FIO_ETA_ALWAYS;
2166 else if (!strcmp("never", optarg))
2167 eta_print = FIO_ETA_NEVER;
2172 if (check_str_time(optarg, &t, 1)) {
2173 log_err("fio: failed parsing eta time %s\n", optarg);
2177 eta_new_line = t / 1000;
2181 if (set_debug(optarg))
2191 if (!strcmp(optarg, "global")) {
2192 log_err("fio: can't use global as only "
2198 new_size = (nr_job_sections + 1) * sizeof(char *);
2199 job_sections = realloc(job_sections, new_size);
2200 job_sections[nr_job_sections] = strdup(optarg);
2206 exit_val = iolog_file_inflate(optarg);
2215 exec_profile = strdup(optarg);
2217 case FIO_GETOPT_JOB: {
2218 const char *opt = l_opts[lidx].name;
2221 if (!strncmp(opt, "name", 4) && td) {
2222 ret = add_job(td, td->o.name ?: "fio", 0, 0, client_type);
2229 int is_section = !strncmp(opt, "name", 4);
2232 if (!is_section || !strncmp(val, "global", 6))
2235 if (is_section && skip_this_section(val))
2238 td = get_new_job(global, &def_thread, 1, NULL);
2239 if (!td || ioengine_load(td)) {
2248 fio_options_set_ioengine_opts(l_opts, td);
2251 if ((!val || !strlen(val)) &&
2252 l_opts[lidx].has_arg == required_argument) {
2253 log_err("fio: option %s requires an argument\n", opt);
2256 ret = fio_cmd_option_parse(td, opt, val);
2267 if (!ret && !strcmp(opt, "ioengine")) {
2269 if (ioengine_load(td)) {
2276 fio_options_set_ioengine_opts(l_opts, td);
2280 case FIO_GETOPT_IOENGINE: {
2281 const char *opt = l_opts[lidx].name;
2287 ret = fio_cmd_ioengine_option_parse(td, opt, val);
2294 max_jobs = atoi(optarg);
2295 if (!max_jobs || max_jobs > REAL_MAX_JOBS) {
2296 log_err("fio: invalid max jobs: %d\n", max_jobs);
2303 #ifndef CONFIG_NO_SHM
2305 log_err("fio: can't be both client and server\n");
2311 fio_server_set_arg(optarg);
2315 log_err("fio: client/server requires SHM support\n");
2323 pid_file = strdup(optarg);
2326 if ((ret = fio_idle_prof_parse_opt(optarg))) {
2327 /* exit on error and calibration only */
2337 log_err("fio: can't be both client and server\n");
2342 /* if --client parameter contains a pathname */
2343 if (0 == access(optarg, R_OK)) {
2344 /* file contains a list of host addrs or names */
2345 char hostaddr[PATH_MAX] = {0};
2347 FILE * hostf = fopen(optarg, "r");
2349 log_err("fio: could not open client list file %s for read\n", optarg);
2354 sprintf(formatstr, "%%%ds", PATH_MAX - 1);
2356 * read at most PATH_MAX-1 chars from each
2357 * record in this file
2359 while (fscanf(hostf, formatstr, hostaddr) == 1) {
2360 /* expect EVERY host in file to be valid */
2361 if (fio_client_add(&fio_client_ops, hostaddr, &cur_client)) {
2362 log_err("fio: failed adding client %s from file %s\n", hostaddr, optarg);
2369 break; /* no possibility of job file for "this client only" */
2371 if (fio_client_add(&fio_client_ops, optarg, &cur_client)) {
2372 log_err("fio: failed adding client %s\n", optarg);
2378 * If the next argument exists and isn't an option,
2379 * assume it's a job file for this client only.
2381 while (optind < argc) {
2382 if (!strncmp(argv[optind], "--", 2) ||
2383 !strncmp(argv[optind], "-", 1))
2386 if (fio_client_add_ini_file(cur_client, argv[optind], 0))
2393 if (fio_client_add_ini_file(cur_client, optarg, 1)) {
2401 exit_val = fio_monotonic_clocktest(1);
2406 exit_val = fio_crctest(optarg);
2411 if (check_str_time(optarg, &val, 1)) {
2412 log_err("fio: failed parsing time %s\n", optarg);
2417 status_interval = val / 1000;
2423 trigger_file = strdup(optarg);
2428 trigger_cmd = strdup(optarg);
2431 if (trigger_remote_cmd)
2432 free(trigger_remote_cmd);
2433 trigger_remote_cmd = strdup(optarg);
2438 aux_path = strdup(optarg);
2441 if (check_str_time(optarg, &trigger_timeout, 1)) {
2442 log_err("fio: failed parsing time %s\n", optarg);
2446 trigger_timeout /= 1000000;
2449 log_err("%s: unrecognized option '%s'\n", argv[0],
2451 show_closest_option(argv[optind - 1]);
2461 if (do_exit && !(is_backend || nr_clients))
2464 if (nr_clients && fio_clients_connect())
2467 if (is_backend && backend)
2468 return fio_start_server(pid_file);
2474 ret = add_job(td, td->o.name ?: "fio", 0, 0, client_type);
2480 while (!ret && optind < argc) {
2482 ini_file = realloc(ini_file, ini_idx * sizeof(char *));
2483 ini_file[ini_idx - 1] = strdup(argv[optind]);
2494 int fio_init_options(void)
2499 fio_options_fill_optstring();
2500 fio_options_dup_and_init(l_opts);
2504 if (fill_def_thread())
2510 extern int fio_check_options(struct thread_options *);
2512 int parse_options(int argc, char *argv[])
2514 const int type = FIO_CLIENT_TYPE_CLI;
2517 if (fio_init_options())
2519 if (fio_test_cconv(&def_thread.o))
2520 log_err("fio: failed internal cconv test\n");
2522 job_files = parse_cmd_line(argc, argv, type);
2524 if (job_files > 0) {
2525 for (i = 0; i < job_files; i++) {
2526 if (i && fill_def_thread())
2529 if (fio_clients_send_ini(ini_file[i]))
2532 } else if (!is_backend) {
2533 if (parse_jobs_ini(ini_file[i], 0, i, type))
2538 } else if (nr_clients) {
2539 if (fill_def_thread())
2541 if (fio_clients_send_ini(NULL))
2546 fio_options_free(&def_thread);
2547 filesetup_mem_free();
2549 if (!thread_number) {
2554 if (is_backend || nr_clients)
2559 log_err("No jobs(s) defined\n\n");
2569 if (output_format & FIO_OUTPUT_NORMAL)
2570 log_info("%s\n", fio_version_string);
2575 void options_default_fill(struct thread_options *o)
2577 memcpy(o, &def_thread.o, sizeof(*o));