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 append_terse_output = 0;
52 int eta_print = FIO_ETA_AUTO;
56 char *exec_profile = NULL;
57 int warnings_fatal = 0;
58 int terse_version = 3;
65 int status_interval = 0;
67 char *trigger_file = NULL;
68 long long trigger_timeout = 0;
69 char *trigger_cmd = NULL;
70 char *trigger_remote_cmd = NULL;
72 char *aux_path = NULL;
74 static int prev_group_jobs;
76 unsigned long fio_debug = 0;
77 unsigned int fio_debug_jobno = -1;
78 unsigned int *fio_debug_jobp = NULL;
80 static char cmd_optstr[256];
83 #define FIO_CLIENT_FLAG (1 << 16)
86 * Command line options. These will contain the above, plus a few
87 * extra that only pertain to fio itself and not jobs.
89 static struct option l_opts[FIO_NR_OPTIONS] = {
91 .name = (char *) "output",
92 .has_arg = required_argument,
93 .val = 'o' | FIO_CLIENT_FLAG,
96 .name = (char *) "timeout",
97 .has_arg = required_argument,
98 .val = 't' | FIO_CLIENT_FLAG,
101 .name = (char *) "latency-log",
102 .has_arg = required_argument,
103 .val = 'l' | FIO_CLIENT_FLAG,
106 .name = (char *) "bandwidth-log",
107 .has_arg = required_argument,
108 .val = 'b' | FIO_CLIENT_FLAG,
111 .name = (char *) "minimal",
112 .has_arg = no_argument,
113 .val = 'm' | FIO_CLIENT_FLAG,
116 .name = (char *) "output-format",
117 .has_arg = optional_argument,
118 .val = 'F' | FIO_CLIENT_FLAG,
121 .name = (char *) "append-terse",
122 .has_arg = optional_argument,
126 .name = (char *) "version",
127 .has_arg = no_argument,
128 .val = 'v' | FIO_CLIENT_FLAG,
131 .name = (char *) "help",
132 .has_arg = no_argument,
133 .val = 'h' | FIO_CLIENT_FLAG,
136 .name = (char *) "cmdhelp",
137 .has_arg = optional_argument,
138 .val = 'c' | FIO_CLIENT_FLAG,
141 .name = (char *) "enghelp",
142 .has_arg = optional_argument,
143 .val = 'i' | FIO_CLIENT_FLAG,
146 .name = (char *) "showcmd",
147 .has_arg = no_argument,
148 .val = 's' | FIO_CLIENT_FLAG,
151 .name = (char *) "readonly",
152 .has_arg = no_argument,
153 .val = 'r' | FIO_CLIENT_FLAG,
156 .name = (char *) "eta",
157 .has_arg = required_argument,
158 .val = 'e' | FIO_CLIENT_FLAG,
161 .name = (char *) "eta-newline",
162 .has_arg = required_argument,
163 .val = 'E' | FIO_CLIENT_FLAG,
166 .name = (char *) "debug",
167 .has_arg = required_argument,
168 .val = 'd' | FIO_CLIENT_FLAG,
171 .name = (char *) "parse-only",
172 .has_arg = no_argument,
173 .val = 'P' | FIO_CLIENT_FLAG,
176 .name = (char *) "section",
177 .has_arg = required_argument,
178 .val = 'x' | FIO_CLIENT_FLAG,
182 .name = (char *) "inflate-log",
183 .has_arg = required_argument,
184 .val = 'X' | FIO_CLIENT_FLAG,
188 .name = (char *) "alloc-size",
189 .has_arg = required_argument,
190 .val = 'a' | FIO_CLIENT_FLAG,
193 .name = (char *) "profile",
194 .has_arg = required_argument,
195 .val = 'p' | FIO_CLIENT_FLAG,
198 .name = (char *) "warnings-fatal",
199 .has_arg = no_argument,
200 .val = 'w' | FIO_CLIENT_FLAG,
203 .name = (char *) "max-jobs",
204 .has_arg = required_argument,
205 .val = 'j' | FIO_CLIENT_FLAG,
208 .name = (char *) "terse-version",
209 .has_arg = required_argument,
210 .val = 'V' | FIO_CLIENT_FLAG,
213 .name = (char *) "server",
214 .has_arg = optional_argument,
217 { .name = (char *) "daemonize",
218 .has_arg = required_argument,
222 .name = (char *) "client",
223 .has_arg = required_argument,
227 .name = (char *) "remote-config",
228 .has_arg = required_argument,
232 .name = (char *) "cpuclock-test",
233 .has_arg = no_argument,
237 .name = (char *) "crctest",
238 .has_arg = optional_argument,
242 .name = (char *) "idle-prof",
243 .has_arg = required_argument,
247 .name = (char *) "status-interval",
248 .has_arg = required_argument,
252 .name = (char *) "trigger-file",
253 .has_arg = required_argument,
257 .name = (char *) "trigger-timeout",
258 .has_arg = required_argument,
262 .name = (char *) "trigger",
263 .has_arg = required_argument,
267 .name = (char *) "trigger-remote",
268 .has_arg = required_argument,
272 .name = (char *) "aux-path",
273 .has_arg = required_argument,
281 void free_threads_shm(void)
285 #ifndef CONFIG_NO_SHM
286 struct shmid_ds sbuf;
290 shmctl(shm_id, IPC_RMID, &sbuf);
299 static void free_shm(void)
304 fio_debug_jobp = NULL;
310 free(trigger_remote_cmd);
311 trigger_file = trigger_cmd = trigger_remote_cmd = NULL;
313 options_free(fio_options, &def_thread);
319 * The thread area is shared between the main process and the job
320 * threads/processes. So setup a shared memory segment that will hold
321 * all the job info. We use the end of the region for keeping track of
322 * open files across jobs, for file sharing.
324 static int setup_thread_area(void)
332 * 1024 is too much on some machines, scale max_jobs if
333 * we get a failure that looks like too large a shm segment
336 size_t size = max_jobs * sizeof(struct thread_data);
338 size += file_hash_size;
339 size += sizeof(unsigned int);
341 #ifndef CONFIG_NO_SHM
342 shm_id = shmget(0, size, IPC_CREAT | 0600);
345 if (errno != EINVAL && errno != ENOMEM && errno != ENOSPC) {
350 threads = malloc(size);
358 #ifndef CONFIG_NO_SHM
362 threads = shmat(shm_id, NULL, 0);
363 if (threads == (void *) -1) {
369 memset(threads, 0, max_jobs * sizeof(struct thread_data));
370 hash = (void *) threads + max_jobs * sizeof(struct thread_data);
371 fio_debug_jobp = (void *) hash + file_hash_size;
372 *fio_debug_jobp = -1;
373 file_hash_init(hash);
380 static void set_cmd_options(struct thread_data *td)
382 struct thread_options *o = &td->o;
385 o->timeout = def_timeout;
389 * Return a free job structure.
391 static struct thread_data *get_new_job(int global, struct thread_data *parent,
392 int preserve_eo, const char *jobname)
394 struct thread_data *td;
397 set_cmd_options(&def_thread);
400 if (setup_thread_area()) {
401 log_err("error: failed to setup shm segment\n");
404 if (thread_number >= max_jobs) {
405 log_err("error: maximum number of jobs (%d) reached.\n",
410 td = &threads[thread_number++];
417 td->o.uid = td->o.gid = -1U;
419 dup_files(td, parent);
420 fio_options_mem_dupe(td);
422 profile_add_hooks(td);
424 td->thread_number = thread_number;
425 td->subjob_number = 0;
428 td->o.name = strdup(jobname);
430 if (!parent->o.group_reporting)
437 static void put_job(struct thread_data *td)
439 if (td == &def_thread)
446 log_info("fio: %s\n", td->verror);
448 fio_options_free(td);
455 memset(&threads[td->thread_number - 1], 0, sizeof(*td));
459 static int __setup_rate(struct thread_data *td, enum fio_ddir ddir)
461 unsigned int bs = td->o.min_bs[ddir];
463 assert(ddir_rw(ddir));
465 if (td->o.rate[ddir])
466 td->rate_bps[ddir] = td->o.rate[ddir];
468 td->rate_bps[ddir] = td->o.rate_iops[ddir] * bs;
470 if (!td->rate_bps[ddir]) {
471 log_err("rate lower than supported\n");
475 td->rate_next_io_time[ddir] = 0;
476 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;
633 if (o->nr_files > td->files_index)
634 o->nr_files = td->files_index;
636 if (o->open_files > o->nr_files || !o->open_files)
637 o->open_files = o->nr_files;
639 if (((o->rate[DDIR_READ] + o->rate[DDIR_WRITE] + o->rate[DDIR_TRIM]) &&
640 (o->rate_iops[DDIR_READ] + o->rate_iops[DDIR_WRITE] + o->rate_iops[DDIR_TRIM])) ||
641 ((o->ratemin[DDIR_READ] + o->ratemin[DDIR_WRITE] + o->ratemin[DDIR_TRIM]) &&
642 (o->rate_iops_min[DDIR_READ] + o->rate_iops_min[DDIR_WRITE] + o->rate_iops_min[DDIR_TRIM]))) {
643 log_err("fio: rate and rate_iops are mutually exclusive\n");
646 if ((o->rate[DDIR_READ] && (o->rate[DDIR_READ] < o->ratemin[DDIR_READ])) ||
647 (o->rate[DDIR_WRITE] && (o->rate[DDIR_WRITE] < o->ratemin[DDIR_WRITE])) ||
648 (o->rate[DDIR_TRIM] && (o->rate[DDIR_TRIM] < o->ratemin[DDIR_TRIM])) ||
649 (o->rate_iops[DDIR_READ] && (o->rate_iops[DDIR_READ] < o->rate_iops_min[DDIR_READ])) ||
650 (o->rate_iops[DDIR_WRITE] && (o->rate_iops[DDIR_WRITE] < o->rate_iops_min[DDIR_WRITE])) ||
651 (o->rate_iops[DDIR_TRIM] && (o->rate_iops[DDIR_TRIM] < o->rate_iops_min[DDIR_TRIM]))) {
652 log_err("fio: minimum rate exceeds rate\n");
656 if (!o->timeout && o->time_based) {
657 log_err("fio: time_based requires a runtime/timeout setting\n");
659 ret = warnings_fatal;
662 if (o->fill_device && !o->size)
665 if (o->verify != VERIFY_NONE) {
666 if (td_write(td) && o->do_verify && o->numjobs > 1) {
667 log_info("Multiple writers may overwrite blocks that "
668 "belong to other jobs. This can cause "
669 "verification failures.\n");
670 ret = warnings_fatal;
673 if (!fio_option_is_set(o, refill_buffers))
674 o->refill_buffers = 1;
676 if (o->max_bs[DDIR_WRITE] != o->min_bs[DDIR_WRITE] &&
678 o->verify_interval = o->min_bs[DDIR_WRITE];
681 * Verify interval must be smaller or equal to the
684 if (o->verify_interval > o->min_bs[DDIR_WRITE])
685 o->verify_interval = o->min_bs[DDIR_WRITE];
686 else if (td_read(td) && o->verify_interval > o->min_bs[DDIR_READ])
687 o->verify_interval = o->min_bs[DDIR_READ];
691 o->invalidate_cache = 0;
692 if (td->io_ops->flags & FIO_PIPEIO) {
693 log_info("fio: cannot pre-read files with an IO engine"
694 " that isn't seekable. Pre-read disabled.\n");
695 ret = warnings_fatal;
700 if (td->io_ops->flags & FIO_BIT_BASED)
706 #ifndef CONFIG_FDATASYNC
707 if (o->fdatasync_blocks) {
708 log_info("fio: this platform does not support fdatasync()"
709 " falling back to using fsync(). Use the 'fsync'"
710 " option instead of 'fdatasync' to get rid of"
712 o->fsync_blocks = o->fdatasync_blocks;
713 o->fdatasync_blocks = 0;
714 ret = warnings_fatal;
720 * Windows doesn't support O_DIRECT or O_SYNC with the _open interface,
721 * so fail if we're passed those flags
723 if ((td->io_ops->flags & FIO_SYNCIO) && (td->o.odirect || td->o.sync_io)) {
724 log_err("fio: Windows does not support direct or non-buffered io with"
725 " the synchronous ioengines. Use the 'windowsaio' ioengine"
726 " with 'direct=1' and 'iodepth=1' instead.\n");
732 * For fully compressible data, just zero them at init time.
733 * It's faster than repeatedly filling it.
735 if (td->o.compress_percentage == 100) {
736 td->o.zero_buffers = 1;
737 td->o.compress_percentage = 0;
741 * Using a non-uniform random distribution excludes usage of
744 if (td->o.random_distribution != FIO_RAND_DIST_RANDOM)
745 td->o.norandommap = 1;
748 * If size is set but less than the min block size, complain
750 if (o->size && o->size < td_min_bs(td)) {
751 log_err("fio: size too small, must be larger than the IO size: %llu\n", (unsigned long long) o->size);
756 * O_ATOMIC implies O_DIRECT
762 * If randseed is set, that overrides randrepeat
764 if (fio_option_is_set(&td->o, rand_seed))
765 td->o.rand_repeatable = 0;
767 if ((td->io_ops->flags & FIO_NOEXTEND) && td->o.file_append) {
768 log_err("fio: can't append/extent with IO engine %s\n", td->io_ops->name);
772 if (fio_option_is_set(o, gtod_cpu)) {
774 fio_gtod_set_cpu(o->gtod_cpu);
775 fio_gtod_offload = 1;
778 td->loops = o->loops;
782 if (td->o.block_error_hist && td->o.nr_files != 1) {
783 log_err("fio: block error histogram only available with "
784 "with a single file per job, but %d files "
785 "provided\n", td->o.nr_files);
793 * This function leaks the buffer
795 char *fio_uint_to_kmg(unsigned int val)
797 char *buf = malloc(32);
798 char post[] = { 0, 'K', 'M', 'G', 'P', 'E', 0 };
809 snprintf(buf, 32, "%u%c", val, *p);
813 /* External engines are specified by "external:name.o") */
814 static const char *get_engine_name(const char *str)
816 char *p = strstr(str, ":");
822 strip_blank_front(&p);
827 static int exists_and_not_file(const char *filename)
831 if (lstat(filename, &sb) == -1)
834 /* \\.\ is the device namespace in Windows, where every file
835 * is a device node */
836 if (S_ISREG(sb.st_mode) && strncmp(filename, "\\\\.\\", 4) != 0)
842 static void td_fill_rand_seeds_internal(struct thread_data *td, int use64)
844 init_rand_seed(&td->bsrange_state, td->rand_seeds[FIO_RAND_BS_OFF], use64);
845 init_rand_seed(&td->verify_state, td->rand_seeds[FIO_RAND_VER_OFF], use64);
846 init_rand_seed(&td->rwmix_state, td->rand_seeds[FIO_RAND_MIX_OFF], use64);
848 if (td->o.file_service_type == FIO_FSERVICE_RANDOM)
849 init_rand_seed(&td->next_file_state, td->rand_seeds[FIO_RAND_FILE_OFF], use64);
851 init_rand_seed(&td->file_size_state, td->rand_seeds[FIO_RAND_FILE_SIZE_OFF], use64);
852 init_rand_seed(&td->trim_state, td->rand_seeds[FIO_RAND_TRIM_OFF], use64);
853 init_rand_seed(&td->delay_state, td->rand_seeds[FIO_RAND_START_DELAY], use64);
858 if (td->o.rand_repeatable)
859 td->rand_seeds[FIO_RAND_BLOCK_OFF] = FIO_RANDSEED * td->thread_number;
861 init_rand_seed(&td->random_state, td->rand_seeds[FIO_RAND_BLOCK_OFF], use64);
862 init_rand_seed(&td->seq_rand_state[DDIR_READ], td->rand_seeds[FIO_RAND_SEQ_RAND_READ_OFF], use64);
863 init_rand_seed(&td->seq_rand_state[DDIR_WRITE], td->rand_seeds[FIO_RAND_SEQ_RAND_WRITE_OFF], use64);
864 init_rand_seed(&td->seq_rand_state[DDIR_TRIM], td->rand_seeds[FIO_RAND_SEQ_RAND_TRIM_OFF], use64);
867 void td_fill_rand_seeds(struct thread_data *td)
871 if (td->o.allrand_repeatable) {
874 for (i = 0; i < FIO_RAND_NR_OFFS; i++)
875 td->rand_seeds[i] = FIO_RANDSEED * td->thread_number
879 if (td->o.random_generator == FIO_RAND_GEN_TAUSWORTHE64)
884 td_fill_rand_seeds_internal(td, use64);
886 init_rand_seed(&td->buf_state, td->rand_seeds[FIO_RAND_BUF_OFF], use64);
887 frand_copy(&td->buf_state_prev, &td->buf_state);
889 init_rand_seed(&td->dedupe_state, td->rand_seeds[FIO_DEDUPE_OFF], use64);
893 * Initializes the ioengine configured for a job, if it has not been done so
896 int ioengine_load(struct thread_data *td)
901 * Engine has already been loaded.
905 if (!td->o.ioengine) {
906 log_err("fio: internal fault, no IO engine specified\n");
910 engine = get_engine_name(td->o.ioengine);
911 td->io_ops = load_ioengine(td, engine);
913 log_err("fio: failed to load engine %s\n", engine);
917 if (td->io_ops->option_struct_size && td->io_ops->options) {
919 * In cases where td->eo is set, clone it for a child thread.
920 * This requires that the parent thread has the same ioengine,
921 * but that requirement must be enforced by the code which
924 void *origeo = td->eo;
926 * Otherwise use the default thread options.
928 if (!origeo && td != &def_thread && def_thread.eo &&
929 def_thread.io_ops->options == td->io_ops->options)
930 origeo = def_thread.eo;
932 options_init(td->io_ops->options);
933 td->eo = malloc(td->io_ops->option_struct_size);
935 * Use the default thread as an option template if this uses the
936 * same options structure and there are non-default options
940 memcpy(td->eo, origeo, td->io_ops->option_struct_size);
941 options_mem_dupe(td->eo, td->io_ops->options);
943 memset(td->eo, 0, td->io_ops->option_struct_size);
944 fill_default_options(td->eo, td->io_ops->options);
946 *(struct thread_data **)td->eo = td;
952 static void init_flags(struct thread_data *td)
954 struct thread_options *o = &td->o;
956 if (o->verify_backlog)
957 td->flags |= TD_F_VER_BACKLOG;
959 td->flags |= TD_F_TRIM_BACKLOG;
960 if (o->read_iolog_file)
961 td->flags |= TD_F_READ_IOLOG;
962 if (o->refill_buffers)
963 td->flags |= TD_F_REFILL_BUFFERS;
965 * Always scramble buffers if asked to
967 if (o->scramble_buffers && fio_option_is_set(o, scramble_buffers))
968 td->flags |= TD_F_SCRAMBLE_BUFFERS;
970 * But also scramble buffers, unless we were explicitly asked
973 if (o->scramble_buffers && !(o->zero_buffers &&
974 fio_option_is_set(o, zero_buffers)))
975 td->flags |= TD_F_SCRAMBLE_BUFFERS;
976 if (o->verify != VERIFY_NONE)
977 td->flags |= TD_F_VER_NONE;
979 if (o->verify_async || o->io_submit_mode == IO_MODE_OFFLOAD)
980 td->flags |= TD_F_NEED_LOCK;
983 static int setup_random_seeds(struct thread_data *td)
988 if (!td->o.rand_repeatable && !fio_option_is_set(&td->o, rand_seed))
989 return init_random_state(td, td->rand_seeds, sizeof(td->rand_seeds));
991 seed = td->o.rand_seed;
992 for (i = 0; i < 4; i++)
993 seed *= 0x9e370001UL;
995 for (i = 0; i < FIO_RAND_NR_OFFS; i++) {
996 td->rand_seeds[i] = seed;
997 seed *= 0x9e370001UL;
1000 td_fill_rand_seeds(td);
1011 static struct fpre_keyword {
1012 const char *keyword;
1015 } fpre_keywords[] = {
1016 { .keyword = "$jobname", .key = FPRE_JOBNAME, },
1017 { .keyword = "$jobnum", .key = FPRE_JOBNUM, },
1018 { .keyword = "$filenum", .key = FPRE_FILENUM, },
1019 { .keyword = NULL, },
1022 static char *make_filename(char *buf, size_t buf_size,struct thread_options *o,
1023 const char *jobname, int jobnum, int filenum)
1025 struct fpre_keyword *f;
1026 char copy[PATH_MAX];
1027 size_t dst_left = PATH_MAX - 1;
1029 if (!o->filename_format || !strlen(o->filename_format)) {
1030 sprintf(buf, "%s.%d.%d", jobname, jobnum, filenum);
1034 for (f = &fpre_keywords[0]; f->keyword; f++)
1035 f->strlen = strlen(f->keyword);
1037 buf[buf_size - 1] = '\0';
1038 strncpy(buf, o->filename_format, buf_size - 1);
1040 memset(copy, 0, sizeof(copy));
1041 for (f = &fpre_keywords[0]; f->keyword; f++) {
1043 size_t pre_len, post_start = 0;
1044 char *str, *dst = copy;
1046 str = strcasestr(buf, f->keyword);
1050 pre_len = str - buf;
1051 if (strlen(str) != f->strlen)
1052 post_start = pre_len + f->strlen;
1055 strncpy(dst, buf, pre_len);
1057 dst_left -= pre_len;
1061 case FPRE_JOBNAME: {
1064 ret = snprintf(dst, dst_left, "%s", jobname);
1067 else if (ret > dst_left) {
1068 log_err("fio: truncated filename\n");
1080 ret = snprintf(dst, dst_left, "%d", jobnum);
1083 else if (ret > dst_left) {
1084 log_err("fio: truncated filename\n");
1093 case FPRE_FILENUM: {
1096 ret = snprintf(dst, dst_left, "%d", filenum);
1099 else if (ret > dst_left) {
1100 log_err("fio: truncated filename\n");
1115 strncpy(dst, buf + post_start, dst_left);
1117 strncpy(buf, copy, buf_size - 1);
1124 int parse_dryrun(void)
1126 return dump_cmdline || parse_only;
1129 static void gen_log_name(char *name, size_t size, const char *logtype,
1130 const char *logname, unsigned int num,
1131 const char *suf, int per_job)
1134 snprintf(name, size, "%s_%s.%d.%s", logname, logtype, num, suf);
1136 snprintf(name, size, "%s_%s.%s", logname, logtype, suf);
1140 * Adds a job to the list of things todo. Sanitizes the various options
1141 * to make sure we don't have conflicts, and initializes various
1144 static int add_job(struct thread_data *td, const char *jobname, int job_add_num,
1145 int recursed, int client_type)
1148 char fname[PATH_MAX];
1149 int numjobs, file_alloced;
1150 struct thread_options *o = &td->o;
1151 char logname[PATH_MAX + 32];
1154 * the def_thread is just for options, it's not a real job
1156 if (td == &def_thread)
1162 * if we are just dumping the output command line, don't add the job
1164 if (parse_dryrun()) {
1169 td->client_type = client_type;
1171 if (profile_td_init(td))
1174 if (ioengine_load(td))
1178 td->io_ops->flags |= FIO_RAWIO;
1181 if (!o->filename && !td->files_index && !o->read_iolog_file) {
1184 if (o->nr_files == 1 && exists_and_not_file(jobname))
1185 add_file(td, jobname, job_add_num, 0);
1187 for (i = 0; i < o->nr_files; i++)
1188 add_file(td, make_filename(fname, sizeof(fname), o, jobname, job_add_num, i), job_add_num, 0);
1192 if (fixup_options(td))
1198 * IO engines only need this for option callbacks, and the address may
1199 * change in subprocesses.
1202 *(struct thread_data **)td->eo = NULL;
1204 if (td->io_ops->flags & FIO_DISKLESSIO) {
1207 for_each_file(td, f, i)
1208 f->real_file_size = -1ULL;
1211 td->mutex = fio_mutex_init(FIO_MUTEX_LOCKED);
1213 td->ts.clat_percentiles = o->clat_percentiles;
1214 td->ts.percentile_precision = o->percentile_precision;
1215 memcpy(td->ts.percentile_list, o->percentile_list, sizeof(o->percentile_list));
1217 for (i = 0; i < DDIR_RWDIR_CNT; i++) {
1218 td->ts.clat_stat[i].min_val = ULONG_MAX;
1219 td->ts.slat_stat[i].min_val = ULONG_MAX;
1220 td->ts.lat_stat[i].min_val = ULONG_MAX;
1221 td->ts.bw_stat[i].min_val = ULONG_MAX;
1223 td->ddir_seq_nr = o->ddir_seq_nr;
1225 if ((o->stonewall || o->new_group) && prev_group_jobs) {
1226 prev_group_jobs = 0;
1230 td->groupid = groupid;
1233 if (setup_random_seeds(td)) {
1234 td_verror(td, errno, "init_random_state");
1241 if (o->lat_log_file) {
1242 struct log_params p = {
1244 .avg_msec = o->log_avg_msec,
1245 .log_type = IO_LOG_TYPE_LAT,
1246 .log_offset = o->log_offset,
1247 .log_gz = o->log_gz,
1248 .log_gz_store = o->log_gz_store,
1257 gen_log_name(logname, sizeof(logname), "lat", o->lat_log_file,
1258 td->thread_number, suf, o->per_job_logs);
1259 setup_log(&td->lat_log, &p, logname);
1261 gen_log_name(logname, sizeof(logname), "slat", o->lat_log_file,
1262 td->thread_number, suf, o->per_job_logs);
1263 setup_log(&td->slat_log, &p, logname);
1265 gen_log_name(logname, sizeof(logname), "clat", o->lat_log_file,
1266 td->thread_number, suf, o->per_job_logs);
1267 setup_log(&td->clat_log, &p, logname);
1269 if (o->bw_log_file) {
1270 struct log_params p = {
1272 .avg_msec = o->log_avg_msec,
1273 .log_type = IO_LOG_TYPE_BW,
1274 .log_offset = o->log_offset,
1275 .log_gz = o->log_gz,
1276 .log_gz_store = o->log_gz_store,
1285 gen_log_name(logname, sizeof(logname), "bw", o->bw_log_file,
1286 td->thread_number, suf, o->per_job_logs);
1287 setup_log(&td->bw_log, &p, logname);
1289 if (o->iops_log_file) {
1290 struct log_params p = {
1292 .avg_msec = o->log_avg_msec,
1293 .log_type = IO_LOG_TYPE_IOPS,
1294 .log_offset = o->log_offset,
1295 .log_gz = o->log_gz,
1296 .log_gz_store = o->log_gz_store,
1305 gen_log_name(logname, sizeof(logname), "iops", o->iops_log_file,
1306 td->thread_number, suf, o->per_job_logs);
1307 setup_log(&td->iops_log, &p, logname);
1311 o->name = strdup(jobname);
1313 if (output_format == FIO_OUTPUT_NORMAL) {
1315 if (is_backend && !recursed)
1316 fio_server_send_add_job(td);
1318 if (!(td->io_ops->flags & FIO_NOIO)) {
1319 char *c1, *c2, *c3, *c4;
1320 char *c5 = NULL, *c6 = NULL;
1322 c1 = fio_uint_to_kmg(o->min_bs[DDIR_READ]);
1323 c2 = fio_uint_to_kmg(o->max_bs[DDIR_READ]);
1324 c3 = fio_uint_to_kmg(o->min_bs[DDIR_WRITE]);
1325 c4 = fio_uint_to_kmg(o->max_bs[DDIR_WRITE]);
1327 if (!o->bs_is_seq_rand) {
1328 c5 = fio_uint_to_kmg(o->min_bs[DDIR_TRIM]);
1329 c6 = fio_uint_to_kmg(o->max_bs[DDIR_TRIM]);
1332 log_info("%s: (g=%d): rw=%s, ", td->o.name,
1334 ddir_str(o->td_ddir));
1336 if (o->bs_is_seq_rand)
1337 log_info("bs(seq/rand)=%s-%s/%s-%s, ",
1340 log_info("bs=%s-%s/%s-%s/%s-%s, ",
1341 c1, c2, c3, c4, c5, c6);
1343 log_info("ioengine=%s, iodepth=%u\n",
1344 td->io_ops->name, o->iodepth);
1353 } else if (job_add_num == 1)
1358 * recurse add identical jobs, clear numjobs and stonewall options
1359 * as they don't apply to sub-jobs
1361 numjobs = o->numjobs;
1363 struct thread_data *td_new = get_new_job(0, td, 1, jobname);
1368 td_new->o.numjobs = 1;
1369 td_new->o.stonewall = 0;
1370 td_new->o.new_group = 0;
1371 td_new->subjob_number = numjobs;
1374 if (td_new->files) {
1376 for_each_file(td_new, f, i) {
1378 sfree(f->file_name);
1381 free(td_new->files);
1382 td_new->files = NULL;
1384 td_new->files_index = 0;
1385 td_new->files_size = 0;
1386 if (td_new->o.filename) {
1387 free(td_new->o.filename);
1388 td_new->o.filename = NULL;
1392 if (add_job(td_new, jobname, numjobs, 1, client_type))
1403 * Parse as if 'o' was a command line
1405 void add_job_opts(const char **o, int client_type)
1407 struct thread_data *td, *td_parent;
1408 int i, in_global = 1;
1412 td_parent = td = NULL;
1414 if (!strncmp(o[i], "name", 4)) {
1417 add_job(td, jobname, 0, 0, client_type);
1419 sprintf(jobname, "%s", o[i] + 5);
1421 if (in_global && !td_parent)
1422 td_parent = get_new_job(1, &def_thread, 0, jobname);
1423 else if (!in_global && !td) {
1425 td_parent = &def_thread;
1426 td = get_new_job(0, td_parent, 0, jobname);
1429 fio_options_parse(td_parent, (char **) &o[i], 1, 0);
1431 fio_options_parse(td, (char **) &o[i], 1, 0);
1436 add_job(td, jobname, 0, 0, client_type);
1439 static int skip_this_section(const char *name)
1443 if (!nr_job_sections)
1445 if (!strncmp(name, "global", 6))
1448 for (i = 0; i < nr_job_sections; i++)
1449 if (!strcmp(job_sections[i], name))
1455 static int is_empty_or_comment(char *line)
1459 for (i = 0; i < strlen(line); i++) {
1464 if (!isspace((int) line[i]) && !iscntrl((int) line[i]))
1472 * This is our [ini] type file parser.
1474 int __parse_jobs_ini(struct thread_data *td,
1475 char *file, int is_buf, int stonewall_flag, int type,
1476 int nested, char *name, char ***popts, int *aopts, int *nopts)
1478 unsigned int global = 0;
1482 int ret = 0, stonewall;
1485 int inside_skip = 0;
1487 int i, alloc_opts, num_opts;
1489 dprint(FD_PARSE, "Parsing ini file %s\n", file);
1490 assert(td || !nested);
1495 if (!strcmp(file, "-"))
1498 f = fopen(file, "r");
1503 log_err("fio: unable to open '%s' job file\n", file);
1505 td_verror(td, __err, "job file open");
1510 string = malloc(4096);
1513 * it's really 256 + small bit, 280 should suffice
1517 memset(name, 0, 280);
1521 if (nested && popts) {
1523 alloc_opts = *aopts;
1529 opts = malloc(sizeof(char *) * alloc_opts);
1533 stonewall = stonewall_flag;
1536 * if skip_fgets is set, we already have loaded a line we
1541 p = strsep(&file, "\n");
1543 p = fgets(string, 4096, f);
1549 strip_blank_front(&p);
1552 dprint(FD_PARSE, "%s\n", p);
1553 if (is_empty_or_comment(p))
1557 if (sscanf(p, "[%255[^\n]]", name) != 1) {
1561 log_err("fio: option <%s> outside of "
1562 "[] job section\n", p);
1567 name[strlen(name) - 1] = '\0';
1569 if (skip_this_section(name)) {
1575 dprint(FD_PARSE, "Parsing section [%s]\n", name);
1577 global = !strncmp(name, "global", 6);
1583 log_info("--name=%s ", name);
1587 td = get_new_job(global, &def_thread, 0, name);
1594 * Separate multiple job files by a stonewall
1596 if (!global && stonewall) {
1597 td->o.stonewall = stonewall;
1602 memset(opts, 0, alloc_opts * sizeof(char *));
1610 p = strsep(&file, "\n");
1612 p = fgets(string, 4096, f);
1615 dprint(FD_PARSE, "%s", p);
1620 if (is_empty_or_comment(p))
1623 strip_blank_front(&p);
1626 * new section, break out and make sure we don't
1627 * fgets() a new line at the top.
1631 log_err("No new sections in included files\n");
1641 if (!strncmp(p, "include", strlen("include"))) {
1642 char *filename = p + strlen("include") + 1;
1644 if ((ret = __parse_jobs_ini(td, filename,
1645 is_buf, stonewall_flag, type, 1,
1646 name, &opts, &alloc_opts, &num_opts))) {
1647 log_err("Error %d while parsing include file %s\n",
1654 if (num_opts == alloc_opts) {
1656 opts = realloc(opts,
1657 alloc_opts * sizeof(char *));
1660 opts[num_opts] = strdup(p);
1666 *aopts = alloc_opts;
1671 ret = fio_options_parse(td, opts, num_opts, dump_cmdline);
1673 ret = add_job(td, name, 0, 0, type);
1675 log_err("fio: job %s dropped\n", name);
1679 for (i = 0; i < num_opts; i++)
1688 while (i < nr_job_sections) {
1689 free(job_sections[i]);
1698 if (!is_buf && f != stdin)
1703 int parse_jobs_ini(char *file, int is_buf, int stonewall_flag, int type)
1705 return __parse_jobs_ini(NULL, file, is_buf, stonewall_flag, type,
1706 0, NULL, NULL, NULL, NULL);
1709 static int fill_def_thread(void)
1711 memset(&def_thread, 0, sizeof(def_thread));
1713 fio_getaffinity(getpid(), &def_thread.o.cpumask);
1714 def_thread.o.error_dump = 1;
1717 * fill default options
1719 fio_fill_default_options(&def_thread);
1723 static void show_debug_categories(void)
1725 struct debug_level *dl = &debug_levels[0];
1726 int curlen, first = 1;
1730 int has_next = (dl + 1)->name != NULL;
1732 if (first || curlen + strlen(dl->name) >= 80) {
1737 curlen += printf("\t\t\t%s", dl->name);
1738 curlen += 3 * (8 - 1);
1740 curlen += printf(",");
1742 curlen += printf("%s", dl->name);
1744 curlen += printf(",");
1752 static void usage(const char *name)
1754 printf("%s\n", fio_version_string);
1755 printf("%s [options] [job options] <job file(s)>\n", name);
1756 printf(" --debug=options\tEnable debug logging. May be one/more of:\n");
1757 show_debug_categories();
1758 printf(" --parse-only\t\tParse options only, don't start any IO\n");
1759 printf(" --output\t\tWrite output to file\n");
1760 printf(" --runtime\t\tRuntime in seconds\n");
1761 printf(" --bandwidth-log\tGenerate per-job bandwidth logs\n");
1762 printf(" --minimal\t\tMinimal (terse) output\n");
1763 printf(" --output-format=x\tOutput format (terse,json,normal)\n");
1764 printf(" --terse-version=x\tSet terse version output format to 'x'\n");
1765 printf(" --version\t\tPrint version info and exit\n");
1766 printf(" --help\t\tPrint this page\n");
1767 printf(" --cpuclock-test\tPerform test/validation of CPU clock\n");
1768 printf(" --crctest\t\tTest speed of checksum functions\n");
1769 printf(" --cmdhelp=cmd\t\tPrint command help, \"all\" for all of"
1771 printf(" --enghelp=engine\tPrint ioengine help, or list"
1772 " available ioengines\n");
1773 printf(" --enghelp=engine,cmd\tPrint help for an ioengine"
1775 printf(" --showcmd\t\tTurn a job file into command line options\n");
1776 printf(" --eta=when\t\tWhen ETA estimate should be printed\n");
1777 printf(" \t\tMay be \"always\", \"never\" or \"auto\"\n");
1778 printf(" --eta-newline=time\tForce a new line for every 'time'");
1779 printf(" period passed\n");
1780 printf(" --status-interval=t\tForce full status dump every");
1781 printf(" 't' period passed\n");
1782 printf(" --readonly\t\tTurn on safety read-only checks, preventing"
1784 printf(" --section=name\tOnly run specified section in job file\n");
1785 printf(" --alloc-size=kb\tSet smalloc pool to this size in kb"
1787 printf(" --warnings-fatal\tFio parser warnings are fatal\n");
1788 printf(" --max-jobs=nr\t\tMaximum number of threads/processes to support\n");
1789 printf(" --server=args\t\tStart a backend fio server\n");
1790 printf(" --daemonize=pidfile\tBackground fio server, write pid to file\n");
1791 printf(" --client=hostname\tTalk to remote backend fio server at hostname\n");
1792 printf(" --remote-config=file\tTell fio server to load this local job file\n");
1793 printf(" --idle-prof=option\tReport cpu idleness on a system or percpu basis\n"
1794 "\t\t\t(option=system,percpu) or run unit work\n"
1795 "\t\t\tcalibration only (option=calibrate)\n");
1797 printf(" --inflate-log=log\tInflate and output compressed log\n");
1799 printf(" --trigger-file=file\tExecute trigger cmd when file exists\n");
1800 printf(" --trigger-timeout=t\tExecute trigger af this time\n");
1801 printf(" --trigger=cmd\t\tSet this command as local trigger\n");
1802 printf(" --trigger-remote=cmd\tSet this command as remote trigger\n");
1803 printf(" --aux-path=path\tUse this path for fio state generated files\n");
1804 printf("\nFio was written by Jens Axboe <jens.axboe@oracle.com>");
1805 printf("\n Jens Axboe <jaxboe@fusionio.com>");
1806 printf("\n Jens Axboe <axboe@fb.com>\n");
1809 #ifdef FIO_INC_DEBUG
1810 struct debug_level debug_levels[] = {
1811 { .name = "process",
1812 .help = "Process creation/exit logging",
1813 .shift = FD_PROCESS,
1816 .help = "File related action logging",
1820 .help = "IO and IO engine action logging (offsets, queue, completions, etc)",
1824 .help = "Memory allocation/freeing logging",
1827 { .name = "blktrace",
1828 .help = "blktrace action logging",
1829 .shift = FD_BLKTRACE,
1832 .help = "IO verification action logging",
1836 .help = "Random generation logging",
1840 .help = "Parser logging",
1843 { .name = "diskutil",
1844 .help = "Disk utility logging actions",
1845 .shift = FD_DISKUTIL,
1848 .help = "Logging related to creating/destroying jobs",
1852 .help = "Mutex logging",
1855 { .name = "profile",
1856 .help = "Logging related to profiles",
1857 .shift = FD_PROFILE,
1860 .help = "Logging related to time keeping functions",
1864 .help = "Network logging",
1868 .help = "Rate logging",
1871 { .name = "compress",
1872 .help = "Log compression logging",
1873 .shift = FD_COMPRESS,
1878 static int set_debug(const char *string)
1880 struct debug_level *dl;
1881 char *p = (char *) string;
1885 if (!strcmp(string, "?") || !strcmp(string, "help")) {
1886 log_info("fio: dumping debug options:");
1887 for (i = 0; debug_levels[i].name; i++) {
1888 dl = &debug_levels[i];
1889 log_info("%s,", dl->name);
1895 while ((opt = strsep(&p, ",")) != NULL) {
1898 if (!strncmp(opt, "all", 3)) {
1899 log_info("fio: set all debug options\n");
1904 for (i = 0; debug_levels[i].name; i++) {
1905 dl = &debug_levels[i];
1906 found = !strncmp(opt, dl->name, strlen(dl->name));
1910 if (dl->shift == FD_JOB) {
1911 opt = strchr(opt, ':');
1913 log_err("fio: missing job number\n");
1917 fio_debug_jobno = atoi(opt);
1918 log_info("fio: set debug jobno %d\n",
1921 log_info("fio: set debug option %s\n", opt);
1922 fio_debug |= (1UL << dl->shift);
1928 log_err("fio: debug mask %s not found\n", opt);
1933 static int set_debug(const char *string)
1935 log_err("fio: debug tracing not included in build\n");
1940 static void fio_options_fill_optstring(void)
1942 char *ostr = cmd_optstr;
1946 while (l_opts[i].name) {
1947 ostr[c++] = l_opts[i].val;
1948 if (l_opts[i].has_arg == required_argument)
1950 else if (l_opts[i].has_arg == optional_argument) {
1959 static int client_flag_set(char c)
1964 while (l_opts[i].name) {
1965 int val = l_opts[i].val;
1967 if (c == (val & 0xff))
1968 return (val & FIO_CLIENT_FLAG);
1976 static void parse_cmd_client(void *client, char *opt)
1978 fio_client_add_cmd_option(client, opt);
1981 static void show_closest_option(const char *name)
1983 int best_option, best_distance;
1986 while (*name == '-')
1990 best_distance = INT_MAX;
1992 while (l_opts[i].name) {
1993 distance = string_distance(name, l_opts[i].name);
1994 if (distance < best_distance) {
1995 best_distance = distance;
2001 if (best_option != -1 && string_distance_ok(name, best_distance))
2002 log_err("Did you mean %s?\n", l_opts[best_option].name);
2005 int parse_cmd_line(int argc, char *argv[], int client_type)
2007 struct thread_data *td = NULL;
2008 int c, ini_idx = 0, lidx, ret = 0, do_exit = 0, exit_val = 0;
2009 char *ostr = cmd_optstr;
2010 void *pid_file = NULL;
2011 void *cur_client = NULL;
2015 * Reset optind handling, since we may call this multiple times
2020 while ((c = getopt_long_only(argc, argv, ostr, l_opts, &lidx)) != -1) {
2021 if ((c & FIO_CLIENT_FLAG) || client_flag_set(c)) {
2022 parse_cmd_client(cur_client, argv[optind - 1]);
2023 c &= ~FIO_CLIENT_FLAG;
2028 smalloc_pool_size = atoi(optarg);
2031 if (check_str_time(optarg, &def_timeout, 1)) {
2032 log_err("fio: failed parsing time %s\n", optarg);
2038 log_err("fio: --latency-log is deprecated. Use per-job latency log options.\n");
2046 if (f_out && f_out != stdout)
2049 f_out = fopen(optarg, "w+");
2051 perror("fopen output");
2057 output_format = FIO_OUTPUT_TERSE;
2061 log_err("fio: missing --output-format argument\n");
2066 if (!strcmp(optarg, "minimal") ||
2067 !strcmp(optarg, "terse") ||
2068 !strcmp(optarg, "csv"))
2069 output_format = FIO_OUTPUT_TERSE;
2070 else if (!strcmp(optarg, "json"))
2071 output_format = FIO_OUTPUT_JSON;
2073 output_format = FIO_OUTPUT_NORMAL;
2076 append_terse_output = 1;
2088 fio_show_option_help(optarg);
2095 fio_show_ioengine_help(optarg);
2109 log_info("%s\n", fio_version_string);
2114 terse_version = atoi(optarg);
2115 if (!(terse_version == 2 || terse_version == 3 ||
2116 terse_version == 4)) {
2117 log_err("fio: bad terse version format\n");
2123 if (!strcmp("always", optarg))
2124 eta_print = FIO_ETA_ALWAYS;
2125 else if (!strcmp("never", optarg))
2126 eta_print = FIO_ETA_NEVER;
2131 if (check_str_time(optarg, &t, 1)) {
2132 log_err("fio: failed parsing eta time %s\n", optarg);
2136 eta_new_line = t / 1000;
2140 if (set_debug(optarg))
2150 if (!strcmp(optarg, "global")) {
2151 log_err("fio: can't use global as only "
2157 new_size = (nr_job_sections + 1) * sizeof(char *);
2158 job_sections = realloc(job_sections, new_size);
2159 job_sections[nr_job_sections] = strdup(optarg);
2165 exit_val = iolog_file_inflate(optarg);
2174 exec_profile = strdup(optarg);
2176 case FIO_GETOPT_JOB: {
2177 const char *opt = l_opts[lidx].name;
2180 if (!strncmp(opt, "name", 4) && td) {
2181 ret = add_job(td, td->o.name ?: "fio", 0, 0, client_type);
2188 int is_section = !strncmp(opt, "name", 4);
2191 if (!is_section || !strncmp(val, "global", 6))
2194 if (is_section && skip_this_section(val))
2197 td = get_new_job(global, &def_thread, 1, NULL);
2198 if (!td || ioengine_load(td)) {
2207 fio_options_set_ioengine_opts(l_opts, td);
2210 if ((!val || !strlen(val)) &&
2211 l_opts[lidx].has_arg == required_argument) {
2212 log_err("fio: option %s requires an argument\n", opt);
2215 ret = fio_cmd_option_parse(td, opt, val);
2226 if (!ret && !strcmp(opt, "ioengine")) {
2228 if (ioengine_load(td)) {
2235 fio_options_set_ioengine_opts(l_opts, td);
2239 case FIO_GETOPT_IOENGINE: {
2240 const char *opt = l_opts[lidx].name;
2246 ret = fio_cmd_ioengine_option_parse(td, opt, val);
2253 max_jobs = atoi(optarg);
2254 if (!max_jobs || max_jobs > REAL_MAX_JOBS) {
2255 log_err("fio: invalid max jobs: %d\n", max_jobs);
2262 #ifndef CONFIG_NO_SHM
2264 log_err("fio: can't be both client and server\n");
2270 fio_server_set_arg(optarg);
2274 log_err("fio: client/server requires SHM support\n");
2282 pid_file = strdup(optarg);
2285 if ((ret = fio_idle_prof_parse_opt(optarg))) {
2286 /* exit on error and calibration only */
2296 log_err("fio: can't be both client and server\n");
2301 /* if --client parameter contains a pathname */
2302 if (0 == access(optarg, R_OK)) {
2303 /* file contains a list of host addrs or names */
2304 char hostaddr[PATH_MAX] = {0};
2306 FILE * hostf = fopen(optarg, "r");
2308 log_err("fio: could not open client list file %s for read\n", optarg);
2313 sprintf(formatstr, "%%%ds", PATH_MAX - 1);
2315 * read at most PATH_MAX-1 chars from each
2316 * record in this file
2318 while (fscanf(hostf, formatstr, hostaddr) == 1) {
2319 /* expect EVERY host in file to be valid */
2320 if (fio_client_add(&fio_client_ops, hostaddr, &cur_client)) {
2321 log_err("fio: failed adding client %s from file %s\n", hostaddr, optarg);
2328 break; /* no possibility of job file for "this client only" */
2330 if (fio_client_add(&fio_client_ops, optarg, &cur_client)) {
2331 log_err("fio: failed adding client %s\n", optarg);
2337 * If the next argument exists and isn't an option,
2338 * assume it's a job file for this client only.
2340 while (optind < argc) {
2341 if (!strncmp(argv[optind], "--", 2) ||
2342 !strncmp(argv[optind], "-", 1))
2345 if (fio_client_add_ini_file(cur_client, argv[optind], 0))
2352 if (fio_client_add_ini_file(cur_client, optarg, 1)) {
2360 exit_val = fio_monotonic_clocktest(1);
2365 exit_val = fio_crctest(optarg);
2370 if (check_str_time(optarg, &val, 1)) {
2371 log_err("fio: failed parsing time %s\n", optarg);
2376 status_interval = val / 1000;
2382 trigger_file = strdup(optarg);
2387 trigger_cmd = strdup(optarg);
2390 if (trigger_remote_cmd)
2391 free(trigger_remote_cmd);
2392 trigger_remote_cmd = strdup(optarg);
2397 aux_path = strdup(optarg);
2400 if (check_str_time(optarg, &trigger_timeout, 1)) {
2401 log_err("fio: failed parsing time %s\n", optarg);
2405 trigger_timeout /= 1000000;
2408 log_err("%s: unrecognized option '%s'\n", argv[0],
2410 show_closest_option(argv[optind - 1]);
2420 if (do_exit && !(is_backend || nr_clients))
2423 if (nr_clients && fio_clients_connect())
2426 if (is_backend && backend)
2427 return fio_start_server(pid_file);
2433 ret = add_job(td, td->o.name ?: "fio", 0, 0, client_type);
2439 while (!ret && optind < argc) {
2441 ini_file = realloc(ini_file, ini_idx * sizeof(char *));
2442 ini_file[ini_idx - 1] = strdup(argv[optind]);
2453 int fio_init_options(void)
2458 fio_options_fill_optstring();
2459 fio_options_dup_and_init(l_opts);
2463 if (fill_def_thread())
2469 extern int fio_check_options(struct thread_options *);
2471 int parse_options(int argc, char *argv[])
2473 const int type = FIO_CLIENT_TYPE_CLI;
2476 if (fio_init_options())
2478 if (fio_test_cconv(&def_thread.o))
2479 log_err("fio: failed internal cconv test\n");
2481 job_files = parse_cmd_line(argc, argv, type);
2483 if (job_files > 0) {
2484 for (i = 0; i < job_files; i++) {
2485 if (i && fill_def_thread())
2488 if (fio_clients_send_ini(ini_file[i]))
2491 } else if (!is_backend) {
2492 if (parse_jobs_ini(ini_file[i], 0, i, type))
2497 } else if (nr_clients) {
2498 if (fill_def_thread())
2500 if (fio_clients_send_ini(NULL))
2505 fio_options_free(&def_thread);
2506 filesetup_mem_free();
2508 if (!thread_number) {
2513 if (is_backend || nr_clients)
2518 log_err("No jobs(s) defined\n\n");
2528 if (output_format == FIO_OUTPUT_NORMAL)
2529 log_info("%s\n", fio_version_string);
2534 void options_default_fill(struct thread_options *o)
2536 memcpy(o, &def_thread.o, sizeof(*o));