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 static int prev_group_jobs;
74 unsigned long fio_debug = 0;
75 unsigned int fio_debug_jobno = -1;
76 unsigned int *fio_debug_jobp = NULL;
78 static char cmd_optstr[256];
81 #define FIO_CLIENT_FLAG (1 << 16)
84 * Command line options. These will contain the above, plus a few
85 * extra that only pertain to fio itself and not jobs.
87 static struct option l_opts[FIO_NR_OPTIONS] = {
89 .name = (char *) "output",
90 .has_arg = required_argument,
91 .val = 'o' | FIO_CLIENT_FLAG,
94 .name = (char *) "timeout",
95 .has_arg = required_argument,
96 .val = 't' | FIO_CLIENT_FLAG,
99 .name = (char *) "latency-log",
100 .has_arg = required_argument,
101 .val = 'l' | FIO_CLIENT_FLAG,
104 .name = (char *) "bandwidth-log",
105 .has_arg = required_argument,
106 .val = 'b' | FIO_CLIENT_FLAG,
109 .name = (char *) "minimal",
110 .has_arg = no_argument,
111 .val = 'm' | FIO_CLIENT_FLAG,
114 .name = (char *) "output-format",
115 .has_arg = optional_argument,
116 .val = 'F' | FIO_CLIENT_FLAG,
119 .name = (char *) "append-terse",
120 .has_arg = optional_argument,
124 .name = (char *) "version",
125 .has_arg = no_argument,
126 .val = 'v' | FIO_CLIENT_FLAG,
129 .name = (char *) "help",
130 .has_arg = no_argument,
131 .val = 'h' | FIO_CLIENT_FLAG,
134 .name = (char *) "cmdhelp",
135 .has_arg = optional_argument,
136 .val = 'c' | FIO_CLIENT_FLAG,
139 .name = (char *) "enghelp",
140 .has_arg = optional_argument,
141 .val = 'i' | FIO_CLIENT_FLAG,
144 .name = (char *) "showcmd",
145 .has_arg = no_argument,
146 .val = 's' | FIO_CLIENT_FLAG,
149 .name = (char *) "readonly",
150 .has_arg = no_argument,
151 .val = 'r' | FIO_CLIENT_FLAG,
154 .name = (char *) "eta",
155 .has_arg = required_argument,
156 .val = 'e' | FIO_CLIENT_FLAG,
159 .name = (char *) "eta-newline",
160 .has_arg = required_argument,
161 .val = 'E' | FIO_CLIENT_FLAG,
164 .name = (char *) "debug",
165 .has_arg = required_argument,
166 .val = 'd' | FIO_CLIENT_FLAG,
169 .name = (char *) "parse-only",
170 .has_arg = no_argument,
171 .val = 'P' | FIO_CLIENT_FLAG,
174 .name = (char *) "section",
175 .has_arg = required_argument,
176 .val = 'x' | FIO_CLIENT_FLAG,
180 .name = (char *) "inflate-log",
181 .has_arg = required_argument,
182 .val = 'X' | FIO_CLIENT_FLAG,
186 .name = (char *) "alloc-size",
187 .has_arg = required_argument,
188 .val = 'a' | FIO_CLIENT_FLAG,
191 .name = (char *) "profile",
192 .has_arg = required_argument,
193 .val = 'p' | FIO_CLIENT_FLAG,
196 .name = (char *) "warnings-fatal",
197 .has_arg = no_argument,
198 .val = 'w' | FIO_CLIENT_FLAG,
201 .name = (char *) "max-jobs",
202 .has_arg = required_argument,
203 .val = 'j' | FIO_CLIENT_FLAG,
206 .name = (char *) "terse-version",
207 .has_arg = required_argument,
208 .val = 'V' | FIO_CLIENT_FLAG,
211 .name = (char *) "server",
212 .has_arg = optional_argument,
215 { .name = (char *) "daemonize",
216 .has_arg = required_argument,
220 .name = (char *) "client",
221 .has_arg = required_argument,
225 .name = (char *) "remote-config",
226 .has_arg = required_argument,
230 .name = (char *) "cpuclock-test",
231 .has_arg = no_argument,
235 .name = (char *) "crctest",
236 .has_arg = optional_argument,
240 .name = (char *) "idle-prof",
241 .has_arg = required_argument,
245 .name = (char *) "status-interval",
246 .has_arg = required_argument,
250 .name = (char *) "trigger-file",
251 .has_arg = required_argument,
255 .name = (char *) "trigger-timeout",
256 .has_arg = required_argument,
260 .name = (char *) "trigger",
261 .has_arg = required_argument,
265 .name = (char *) "trigger-remote",
266 .has_arg = required_argument,
274 void free_threads_shm(void)
278 #ifndef CONFIG_NO_SHM
279 struct shmid_ds sbuf;
283 shmctl(shm_id, IPC_RMID, &sbuf);
292 static void free_shm(void)
297 fio_debug_jobp = NULL;
303 free(trigger_remote_cmd);
304 trigger_file = trigger_cmd = trigger_remote_cmd = NULL;
306 options_free(fio_options, &def_thread);
312 * The thread area is shared between the main process and the job
313 * threads/processes. So setup a shared memory segment that will hold
314 * all the job info. We use the end of the region for keeping track of
315 * open files across jobs, for file sharing.
317 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 += file_hash_size;
332 size += sizeof(unsigned int);
334 #ifndef CONFIG_NO_SHM
335 shm_id = shmget(0, size, IPC_CREAT | 0600);
338 if (errno != EINVAL && errno != ENOMEM && errno != ENOSPC) {
343 threads = malloc(size);
351 #ifndef CONFIG_NO_SHM
355 threads = shmat(shm_id, NULL, 0);
356 if (threads == (void *) -1) {
362 memset(threads, 0, max_jobs * sizeof(struct thread_data));
363 hash = (void *) threads + max_jobs * sizeof(struct thread_data);
364 fio_debug_jobp = (void *) hash + file_hash_size;
365 *fio_debug_jobp = -1;
366 file_hash_init(hash);
373 static void set_cmd_options(struct thread_data *td)
375 struct thread_options *o = &td->o;
378 o->timeout = def_timeout;
382 * Return a free job structure.
384 static struct thread_data *get_new_job(int global, struct thread_data *parent,
385 int preserve_eo, const char *jobname)
387 struct thread_data *td;
390 set_cmd_options(&def_thread);
393 if (setup_thread_area()) {
394 log_err("error: failed to setup shm segment\n");
397 if (thread_number >= max_jobs) {
398 log_err("error: maximum number of jobs (%d) reached.\n",
403 td = &threads[thread_number++];
410 td->o.uid = td->o.gid = -1U;
412 dup_files(td, parent);
413 fio_options_mem_dupe(td);
415 profile_add_hooks(td);
417 td->thread_number = thread_number;
418 td->subjob_number = 0;
421 td->o.name = strdup(jobname);
423 if (!parent->o.group_reporting)
430 static void put_job(struct thread_data *td)
432 if (td == &def_thread)
439 log_info("fio: %s\n", td->verror);
441 fio_options_free(td);
448 memset(&threads[td->thread_number - 1], 0, sizeof(*td));
452 static int __setup_rate(struct thread_data *td, enum fio_ddir ddir)
454 unsigned int bs = td->o.min_bs[ddir];
456 assert(ddir_rw(ddir));
458 if (td->o.rate[ddir])
459 td->rate_bps[ddir] = td->o.rate[ddir];
461 td->rate_bps[ddir] = td->o.rate_iops[ddir] * bs;
463 if (!td->rate_bps[ddir]) {
464 log_err("rate lower than supported\n");
468 td->rate_next_io_time[ddir] = 0;
469 td->rate_io_issue_bytes[ddir] = 0;
473 static int setup_rate(struct thread_data *td)
477 if (td->o.rate[DDIR_READ] || td->o.rate_iops[DDIR_READ])
478 ret = __setup_rate(td, DDIR_READ);
479 if (td->o.rate[DDIR_WRITE] || td->o.rate_iops[DDIR_WRITE])
480 ret |= __setup_rate(td, DDIR_WRITE);
481 if (td->o.rate[DDIR_TRIM] || td->o.rate_iops[DDIR_TRIM])
482 ret |= __setup_rate(td, DDIR_TRIM);
487 static int fixed_block_size(struct thread_options *o)
489 return o->min_bs[DDIR_READ] == o->max_bs[DDIR_READ] &&
490 o->min_bs[DDIR_WRITE] == o->max_bs[DDIR_WRITE] &&
491 o->min_bs[DDIR_TRIM] == o->max_bs[DDIR_TRIM] &&
492 o->min_bs[DDIR_READ] == o->min_bs[DDIR_WRITE] &&
493 o->min_bs[DDIR_READ] == o->min_bs[DDIR_TRIM];
497 static unsigned long long get_rand_start_delay(struct thread_data *td)
499 unsigned long long delayrange;
503 delayrange = td->o.start_delay_high - td->o.start_delay;
505 frand_max = rand_max(&td->delay_state);
506 r = __rand(&td->delay_state);
507 delayrange = (unsigned long long) ((double) delayrange * (r / (frand_max + 1.0)));
509 delayrange += td->o.start_delay;
514 * Lazy way of fixing up options that depend on each other. We could also
515 * define option callback handlers, but this is easier.
517 static int fixup_options(struct thread_data *td)
519 struct thread_options *o = &td->o;
522 #ifndef FIO_HAVE_PSHARED_MUTEX
523 if (!o->use_thread) {
524 log_info("fio: this platform does not support process shared"
525 " mutexes, forcing use of threads. Use the 'thread'"
526 " option to get rid of this warning.\n");
528 ret = warnings_fatal;
532 if (o->write_iolog_file && o->read_iolog_file) {
533 log_err("fio: read iolog overrides write_iolog\n");
534 free(o->write_iolog_file);
535 o->write_iolog_file = NULL;
536 ret = warnings_fatal;
540 * only really works with 1 file
542 if (o->zone_size && o->open_files > 1)
546 * If zone_range isn't specified, backward compatibility dictates it
547 * should be made equal to zone_size.
549 if (o->zone_size && !o->zone_range)
550 o->zone_range = o->zone_size;
553 * Reads can do overwrites, we always need to pre-create the file
555 if (td_read(td) || td_rw(td))
558 if (!o->min_bs[DDIR_READ])
559 o->min_bs[DDIR_READ] = o->bs[DDIR_READ];
560 if (!o->max_bs[DDIR_READ])
561 o->max_bs[DDIR_READ] = o->bs[DDIR_READ];
562 if (!o->min_bs[DDIR_WRITE])
563 o->min_bs[DDIR_WRITE] = o->bs[DDIR_WRITE];
564 if (!o->max_bs[DDIR_WRITE])
565 o->max_bs[DDIR_WRITE] = o->bs[DDIR_WRITE];
566 if (!o->min_bs[DDIR_TRIM])
567 o->min_bs[DDIR_TRIM] = o->bs[DDIR_TRIM];
568 if (!o->max_bs[DDIR_TRIM])
569 o->max_bs[DDIR_TRIM] = o->bs[DDIR_TRIM];
571 o->rw_min_bs = min(o->min_bs[DDIR_READ], o->min_bs[DDIR_WRITE]);
572 o->rw_min_bs = min(o->min_bs[DDIR_TRIM], o->rw_min_bs);
575 * For random IO, allow blockalign offset other than min_bs.
577 if (!o->ba[DDIR_READ] || !td_random(td))
578 o->ba[DDIR_READ] = o->min_bs[DDIR_READ];
579 if (!o->ba[DDIR_WRITE] || !td_random(td))
580 o->ba[DDIR_WRITE] = o->min_bs[DDIR_WRITE];
581 if (!o->ba[DDIR_TRIM] || !td_random(td))
582 o->ba[DDIR_TRIM] = o->min_bs[DDIR_TRIM];
584 if ((o->ba[DDIR_READ] != o->min_bs[DDIR_READ] ||
585 o->ba[DDIR_WRITE] != o->min_bs[DDIR_WRITE] ||
586 o->ba[DDIR_TRIM] != o->min_bs[DDIR_TRIM]) &&
588 log_err("fio: Any use of blockalign= turns off randommap\n");
590 ret = warnings_fatal;
593 if (!o->file_size_high)
594 o->file_size_high = o->file_size_low;
596 if (o->start_delay_high)
597 o->start_delay = get_rand_start_delay(td);
599 if (o->norandommap && o->verify != VERIFY_NONE
600 && !fixed_block_size(o)) {
601 log_err("fio: norandommap given for variable block sizes, "
603 ret = warnings_fatal;
605 if (o->bs_unaligned && (o->odirect || td->io_ops->flags & FIO_RAWIO))
606 log_err("fio: bs_unaligned may not work with raw io\n");
609 * thinktime_spin must be less than thinktime
611 if (o->thinktime_spin > o->thinktime)
612 o->thinktime_spin = o->thinktime;
615 * The low water mark cannot be bigger than the iodepth
617 if (o->iodepth_low > o->iodepth || !o->iodepth_low)
618 o->iodepth_low = o->iodepth;
621 * If batch number isn't set, default to the same as iodepth
623 if (o->iodepth_batch > o->iodepth || !o->iodepth_batch)
624 o->iodepth_batch = o->iodepth;
626 if (o->nr_files > td->files_index)
627 o->nr_files = td->files_index;
629 if (o->open_files > o->nr_files || !o->open_files)
630 o->open_files = o->nr_files;
632 if (((o->rate[DDIR_READ] + o->rate[DDIR_WRITE] + o->rate[DDIR_TRIM]) &&
633 (o->rate_iops[DDIR_READ] + o->rate_iops[DDIR_WRITE] + o->rate_iops[DDIR_TRIM])) ||
634 ((o->ratemin[DDIR_READ] + o->ratemin[DDIR_WRITE] + o->ratemin[DDIR_TRIM]) &&
635 (o->rate_iops_min[DDIR_READ] + o->rate_iops_min[DDIR_WRITE] + o->rate_iops_min[DDIR_TRIM]))) {
636 log_err("fio: rate and rate_iops are mutually exclusive\n");
639 if ((o->rate[DDIR_READ] && (o->rate[DDIR_READ] < o->ratemin[DDIR_READ])) ||
640 (o->rate[DDIR_WRITE] && (o->rate[DDIR_WRITE] < o->ratemin[DDIR_WRITE])) ||
641 (o->rate[DDIR_TRIM] && (o->rate[DDIR_TRIM] < o->ratemin[DDIR_TRIM])) ||
642 (o->rate_iops[DDIR_READ] && (o->rate_iops[DDIR_READ] < o->rate_iops_min[DDIR_READ])) ||
643 (o->rate_iops[DDIR_WRITE] && (o->rate_iops[DDIR_WRITE] < o->rate_iops_min[DDIR_WRITE])) ||
644 (o->rate_iops[DDIR_TRIM] && (o->rate_iops[DDIR_TRIM] < o->rate_iops_min[DDIR_TRIM]))) {
645 log_err("fio: minimum rate exceeds rate\n");
649 if (!o->timeout && o->time_based) {
650 log_err("fio: time_based requires a runtime/timeout setting\n");
652 ret = warnings_fatal;
655 if (o->fill_device && !o->size)
658 if (o->verify != VERIFY_NONE) {
659 if (td_write(td) && o->do_verify && o->numjobs > 1) {
660 log_info("Multiple writers may overwrite blocks that "
661 "belong to other jobs. This can cause "
662 "verification failures.\n");
663 ret = warnings_fatal;
666 if (!fio_option_is_set(o, refill_buffers))
667 o->refill_buffers = 1;
669 if (o->max_bs[DDIR_WRITE] != o->min_bs[DDIR_WRITE] &&
671 o->verify_interval = o->min_bs[DDIR_WRITE];
674 * Verify interval must be smaller or equal to the
677 if (o->verify_interval > o->min_bs[DDIR_WRITE])
678 o->verify_interval = o->min_bs[DDIR_WRITE];
679 else if (td_read(td) && o->verify_interval > o->min_bs[DDIR_READ])
680 o->verify_interval = o->min_bs[DDIR_READ];
684 o->invalidate_cache = 0;
685 if (td->io_ops->flags & FIO_PIPEIO) {
686 log_info("fio: cannot pre-read files with an IO engine"
687 " that isn't seekable. Pre-read disabled.\n");
688 ret = warnings_fatal;
693 if (td->io_ops->flags & FIO_BIT_BASED)
699 #ifndef CONFIG_FDATASYNC
700 if (o->fdatasync_blocks) {
701 log_info("fio: this platform does not support fdatasync()"
702 " falling back to using fsync(). Use the 'fsync'"
703 " option instead of 'fdatasync' to get rid of"
705 o->fsync_blocks = o->fdatasync_blocks;
706 o->fdatasync_blocks = 0;
707 ret = warnings_fatal;
713 * Windows doesn't support O_DIRECT or O_SYNC with the _open interface,
714 * so fail if we're passed those flags
716 if ((td->io_ops->flags & FIO_SYNCIO) && (td->o.odirect || td->o.sync_io)) {
717 log_err("fio: Windows does not support direct or non-buffered io with"
718 " the synchronous ioengines. Use the 'windowsaio' ioengine"
719 " with 'direct=1' and 'iodepth=1' instead.\n");
725 * For fully compressible data, just zero them at init time.
726 * It's faster than repeatedly filling it.
728 if (td->o.compress_percentage == 100) {
729 td->o.zero_buffers = 1;
730 td->o.compress_percentage = 0;
734 * Using a non-uniform random distribution excludes usage of
737 if (td->o.random_distribution != FIO_RAND_DIST_RANDOM)
738 td->o.norandommap = 1;
741 * If size is set but less than the min block size, complain
743 if (o->size && o->size < td_min_bs(td)) {
744 log_err("fio: size too small, must be larger than the IO size: %llu\n", (unsigned long long) o->size);
749 * O_ATOMIC implies O_DIRECT
755 * If randseed is set, that overrides randrepeat
757 if (fio_option_is_set(&td->o, rand_seed))
758 td->o.rand_repeatable = 0;
760 if ((td->io_ops->flags & FIO_NOEXTEND) && td->o.file_append) {
761 log_err("fio: can't append/extent with IO engine %s\n", td->io_ops->name);
765 if (fio_option_is_set(o, gtod_cpu)) {
767 fio_gtod_set_cpu(o->gtod_cpu);
768 fio_gtod_offload = 1;
771 td->loops = o->loops;
775 if (td->o.block_error_hist && td->o.nr_files != 1) {
776 log_err("fio: block error histogram only available with "
777 "with a single file per job, but %d files "
778 "provided\n", td->o.nr_files);
786 * This function leaks the buffer
788 char *fio_uint_to_kmg(unsigned int val)
790 char *buf = malloc(32);
791 char post[] = { 0, 'K', 'M', 'G', 'P', 'E', 0 };
802 snprintf(buf, 32, "%u%c", val, *p);
806 /* External engines are specified by "external:name.o") */
807 static const char *get_engine_name(const char *str)
809 char *p = strstr(str, ":");
815 strip_blank_front(&p);
820 static int exists_and_not_file(const char *filename)
824 if (lstat(filename, &sb) == -1)
827 /* \\.\ is the device namespace in Windows, where every file
828 * is a device node */
829 if (S_ISREG(sb.st_mode) && strncmp(filename, "\\\\.\\", 4) != 0)
835 static void td_fill_rand_seeds_internal(struct thread_data *td, int use64)
837 init_rand_seed(&td->bsrange_state, td->rand_seeds[FIO_RAND_BS_OFF], use64);
838 init_rand_seed(&td->verify_state, td->rand_seeds[FIO_RAND_VER_OFF], use64);
839 init_rand_seed(&td->rwmix_state, td->rand_seeds[FIO_RAND_MIX_OFF], use64);
841 if (td->o.file_service_type == FIO_FSERVICE_RANDOM)
842 init_rand_seed(&td->next_file_state, td->rand_seeds[FIO_RAND_FILE_OFF], use64);
844 init_rand_seed(&td->file_size_state, td->rand_seeds[FIO_RAND_FILE_SIZE_OFF], use64);
845 init_rand_seed(&td->trim_state, td->rand_seeds[FIO_RAND_TRIM_OFF], use64);
846 init_rand_seed(&td->delay_state, td->rand_seeds[FIO_RAND_START_DELAY], use64);
851 if (td->o.rand_repeatable)
852 td->rand_seeds[FIO_RAND_BLOCK_OFF] = FIO_RANDSEED * td->thread_number;
854 init_rand_seed(&td->random_state, td->rand_seeds[FIO_RAND_BLOCK_OFF], use64);
855 init_rand_seed(&td->seq_rand_state[DDIR_READ], td->rand_seeds[FIO_RAND_SEQ_RAND_READ_OFF], use64);
856 init_rand_seed(&td->seq_rand_state[DDIR_WRITE], td->rand_seeds[FIO_RAND_SEQ_RAND_WRITE_OFF], use64);
857 init_rand_seed(&td->seq_rand_state[DDIR_TRIM], td->rand_seeds[FIO_RAND_SEQ_RAND_TRIM_OFF], use64);
860 void td_fill_rand_seeds(struct thread_data *td)
864 if (td->o.allrand_repeatable) {
867 for (i = 0; i < FIO_RAND_NR_OFFS; i++)
868 td->rand_seeds[i] = FIO_RANDSEED * td->thread_number
872 if (td->o.random_generator == FIO_RAND_GEN_TAUSWORTHE64)
877 td_fill_rand_seeds_internal(td, use64);
879 init_rand_seed(&td->buf_state, td->rand_seeds[FIO_RAND_BUF_OFF], use64);
880 frand_copy(&td->buf_state_prev, &td->buf_state);
882 init_rand_seed(&td->dedupe_state, td->rand_seeds[FIO_DEDUPE_OFF], use64);
886 * Initializes the ioengine configured for a job, if it has not been done so
889 int ioengine_load(struct thread_data *td)
894 * Engine has already been loaded.
898 if (!td->o.ioengine) {
899 log_err("fio: internal fault, no IO engine specified\n");
903 engine = get_engine_name(td->o.ioengine);
904 td->io_ops = load_ioengine(td, engine);
906 log_err("fio: failed to load engine %s\n", engine);
910 if (td->io_ops->option_struct_size && td->io_ops->options) {
912 * In cases where td->eo is set, clone it for a child thread.
913 * This requires that the parent thread has the same ioengine,
914 * but that requirement must be enforced by the code which
917 void *origeo = td->eo;
919 * Otherwise use the default thread options.
921 if (!origeo && td != &def_thread && def_thread.eo &&
922 def_thread.io_ops->options == td->io_ops->options)
923 origeo = def_thread.eo;
925 options_init(td->io_ops->options);
926 td->eo = malloc(td->io_ops->option_struct_size);
928 * Use the default thread as an option template if this uses the
929 * same options structure and there are non-default options
933 memcpy(td->eo, origeo, td->io_ops->option_struct_size);
934 options_mem_dupe(td->eo, td->io_ops->options);
936 memset(td->eo, 0, td->io_ops->option_struct_size);
937 fill_default_options(td->eo, td->io_ops->options);
939 *(struct thread_data **)td->eo = td;
945 static void init_flags(struct thread_data *td)
947 struct thread_options *o = &td->o;
949 if (o->verify_backlog)
950 td->flags |= TD_F_VER_BACKLOG;
952 td->flags |= TD_F_TRIM_BACKLOG;
953 if (o->read_iolog_file)
954 td->flags |= TD_F_READ_IOLOG;
955 if (o->refill_buffers)
956 td->flags |= TD_F_REFILL_BUFFERS;
958 * Always scramble buffers if asked to
960 if (o->scramble_buffers && fio_option_is_set(o, scramble_buffers))
961 td->flags |= TD_F_SCRAMBLE_BUFFERS;
963 * But also scramble buffers, unless we were explicitly asked
966 if (o->scramble_buffers && !(o->zero_buffers &&
967 fio_option_is_set(o, zero_buffers)))
968 td->flags |= TD_F_SCRAMBLE_BUFFERS;
969 if (o->verify != VERIFY_NONE)
970 td->flags |= TD_F_VER_NONE;
972 if (o->verify_async || o->io_submit_mode == IO_MODE_OFFLOAD)
973 td->flags |= TD_F_NEED_LOCK;
976 static int setup_random_seeds(struct thread_data *td)
981 if (!td->o.rand_repeatable && !fio_option_is_set(&td->o, rand_seed))
982 return init_random_state(td, td->rand_seeds, sizeof(td->rand_seeds));
984 seed = td->o.rand_seed;
985 for (i = 0; i < 4; i++)
986 seed *= 0x9e370001UL;
988 for (i = 0; i < FIO_RAND_NR_OFFS; i++) {
989 td->rand_seeds[i] = seed;
990 seed *= 0x9e370001UL;
993 td_fill_rand_seeds(td);
1004 static struct fpre_keyword {
1005 const char *keyword;
1008 } fpre_keywords[] = {
1009 { .keyword = "$jobname", .key = FPRE_JOBNAME, },
1010 { .keyword = "$jobnum", .key = FPRE_JOBNUM, },
1011 { .keyword = "$filenum", .key = FPRE_FILENUM, },
1012 { .keyword = NULL, },
1015 static char *make_filename(char *buf, size_t buf_size,struct thread_options *o,
1016 const char *jobname, int jobnum, int filenum)
1018 struct fpre_keyword *f;
1019 char copy[PATH_MAX];
1020 size_t dst_left = PATH_MAX - 1;
1022 if (!o->filename_format || !strlen(o->filename_format)) {
1023 sprintf(buf, "%s.%d.%d", jobname, jobnum, filenum);
1027 for (f = &fpre_keywords[0]; f->keyword; f++)
1028 f->strlen = strlen(f->keyword);
1030 buf[buf_size - 1] = '\0';
1031 strncpy(buf, o->filename_format, buf_size - 1);
1033 memset(copy, 0, sizeof(copy));
1034 for (f = &fpre_keywords[0]; f->keyword; f++) {
1036 size_t pre_len, post_start = 0;
1037 char *str, *dst = copy;
1039 str = strcasestr(buf, f->keyword);
1043 pre_len = str - buf;
1044 if (strlen(str) != f->strlen)
1045 post_start = pre_len + f->strlen;
1048 strncpy(dst, buf, pre_len);
1050 dst_left -= pre_len;
1054 case FPRE_JOBNAME: {
1057 ret = snprintf(dst, dst_left, "%s", jobname);
1060 else if (ret > dst_left) {
1061 log_err("fio: truncated filename\n");
1073 ret = snprintf(dst, dst_left, "%d", jobnum);
1076 else if (ret > dst_left) {
1077 log_err("fio: truncated filename\n");
1086 case FPRE_FILENUM: {
1089 ret = snprintf(dst, dst_left, "%d", filenum);
1092 else if (ret > dst_left) {
1093 log_err("fio: truncated filename\n");
1108 strncpy(dst, buf + post_start, dst_left);
1110 strncpy(buf, copy, buf_size - 1);
1117 int parse_dryrun(void)
1119 return dump_cmdline || parse_only;
1122 static void gen_log_name(char *name, size_t size, const char *logtype,
1123 const char *logname, unsigned int num,
1124 const char *suf, int per_job)
1127 snprintf(name, size, "%s_%s.%d.%s", logname, logtype, num, suf);
1129 snprintf(name, size, "%s_%s.%s", logname, logtype, suf);
1133 * Adds a job to the list of things todo. Sanitizes the various options
1134 * to make sure we don't have conflicts, and initializes various
1137 static int add_job(struct thread_data *td, const char *jobname, int job_add_num,
1138 int recursed, int client_type)
1141 char fname[PATH_MAX];
1142 int numjobs, file_alloced;
1143 struct thread_options *o = &td->o;
1144 char logname[PATH_MAX + 32];
1147 * the def_thread is just for options, it's not a real job
1149 if (td == &def_thread)
1155 * if we are just dumping the output command line, don't add the job
1157 if (parse_dryrun()) {
1162 td->client_type = client_type;
1164 if (profile_td_init(td))
1167 if (ioengine_load(td))
1171 td->io_ops->flags |= FIO_RAWIO;
1174 if (!o->filename && !td->files_index && !o->read_iolog_file) {
1177 if (o->nr_files == 1 && exists_and_not_file(jobname))
1178 add_file(td, jobname, job_add_num, 0);
1180 for (i = 0; i < o->nr_files; i++)
1181 add_file(td, make_filename(fname, sizeof(fname), o, jobname, job_add_num, i), job_add_num, 0);
1185 if (fixup_options(td))
1191 * IO engines only need this for option callbacks, and the address may
1192 * change in subprocesses.
1195 *(struct thread_data **)td->eo = NULL;
1197 if (td->io_ops->flags & FIO_DISKLESSIO) {
1200 for_each_file(td, f, i)
1201 f->real_file_size = -1ULL;
1204 td->mutex = fio_mutex_init(FIO_MUTEX_LOCKED);
1206 td->ts.clat_percentiles = o->clat_percentiles;
1207 td->ts.percentile_precision = o->percentile_precision;
1208 memcpy(td->ts.percentile_list, o->percentile_list, sizeof(o->percentile_list));
1210 for (i = 0; i < DDIR_RWDIR_CNT; i++) {
1211 td->ts.clat_stat[i].min_val = ULONG_MAX;
1212 td->ts.slat_stat[i].min_val = ULONG_MAX;
1213 td->ts.lat_stat[i].min_val = ULONG_MAX;
1214 td->ts.bw_stat[i].min_val = ULONG_MAX;
1216 td->ddir_seq_nr = o->ddir_seq_nr;
1218 if ((o->stonewall || o->new_group) && prev_group_jobs) {
1219 prev_group_jobs = 0;
1223 td->groupid = groupid;
1226 if (setup_random_seeds(td)) {
1227 td_verror(td, errno, "init_random_state");
1234 if (o->lat_log_file) {
1235 struct log_params p = {
1237 .avg_msec = o->log_avg_msec,
1238 .log_type = IO_LOG_TYPE_LAT,
1239 .log_offset = o->log_offset,
1240 .log_gz = o->log_gz,
1241 .log_gz_store = o->log_gz_store,
1250 gen_log_name(logname, sizeof(logname), "lat", o->lat_log_file,
1251 td->thread_number, suf, o->per_job_logs);
1252 setup_log(&td->lat_log, &p, logname);
1254 gen_log_name(logname, sizeof(logname), "slat", o->lat_log_file,
1255 td->thread_number, suf, o->per_job_logs);
1256 setup_log(&td->slat_log, &p, logname);
1258 gen_log_name(logname, sizeof(logname), "clat", o->lat_log_file,
1259 td->thread_number, suf, o->per_job_logs);
1260 setup_log(&td->clat_log, &p, logname);
1262 if (o->bw_log_file) {
1263 struct log_params p = {
1265 .avg_msec = o->log_avg_msec,
1266 .log_type = IO_LOG_TYPE_BW,
1267 .log_offset = o->log_offset,
1268 .log_gz = o->log_gz,
1269 .log_gz_store = o->log_gz_store,
1278 gen_log_name(logname, sizeof(logname), "bw", o->bw_log_file,
1279 td->thread_number, suf, o->per_job_logs);
1280 setup_log(&td->bw_log, &p, logname);
1282 if (o->iops_log_file) {
1283 struct log_params p = {
1285 .avg_msec = o->log_avg_msec,
1286 .log_type = IO_LOG_TYPE_IOPS,
1287 .log_offset = o->log_offset,
1288 .log_gz = o->log_gz,
1289 .log_gz_store = o->log_gz_store,
1298 gen_log_name(logname, sizeof(logname), "iops", o->iops_log_file,
1299 td->thread_number, suf, o->per_job_logs);
1300 setup_log(&td->iops_log, &p, logname);
1304 o->name = strdup(jobname);
1306 if (output_format == FIO_OUTPUT_NORMAL) {
1308 if (is_backend && !recursed)
1309 fio_server_send_add_job(td);
1311 if (!(td->io_ops->flags & FIO_NOIO)) {
1312 char *c1, *c2, *c3, *c4;
1313 char *c5 = NULL, *c6 = NULL;
1315 c1 = fio_uint_to_kmg(o->min_bs[DDIR_READ]);
1316 c2 = fio_uint_to_kmg(o->max_bs[DDIR_READ]);
1317 c3 = fio_uint_to_kmg(o->min_bs[DDIR_WRITE]);
1318 c4 = fio_uint_to_kmg(o->max_bs[DDIR_WRITE]);
1320 if (!o->bs_is_seq_rand) {
1321 c5 = fio_uint_to_kmg(o->min_bs[DDIR_TRIM]);
1322 c6 = fio_uint_to_kmg(o->max_bs[DDIR_TRIM]);
1325 log_info("%s: (g=%d): rw=%s, ", td->o.name,
1327 ddir_str(o->td_ddir));
1329 if (o->bs_is_seq_rand)
1330 log_info("bs(seq/rand)=%s-%s/%s-%s, ",
1333 log_info("bs=%s-%s/%s-%s/%s-%s, ",
1334 c1, c2, c3, c4, c5, c6);
1336 log_info("ioengine=%s, iodepth=%u\n",
1337 td->io_ops->name, o->iodepth);
1346 } else if (job_add_num == 1)
1351 * recurse add identical jobs, clear numjobs and stonewall options
1352 * as they don't apply to sub-jobs
1354 numjobs = o->numjobs;
1356 struct thread_data *td_new = get_new_job(0, td, 1, jobname);
1361 td_new->o.numjobs = 1;
1362 td_new->o.stonewall = 0;
1363 td_new->o.new_group = 0;
1364 td_new->subjob_number = numjobs;
1367 if (td_new->files) {
1369 for_each_file(td_new, f, i) {
1371 sfree(f->file_name);
1374 free(td_new->files);
1375 td_new->files = NULL;
1377 td_new->files_index = 0;
1378 td_new->files_size = 0;
1379 if (td_new->o.filename) {
1380 free(td_new->o.filename);
1381 td_new->o.filename = NULL;
1385 if (add_job(td_new, jobname, numjobs, 1, client_type))
1396 * Parse as if 'o' was a command line
1398 void add_job_opts(const char **o, int client_type)
1400 struct thread_data *td, *td_parent;
1401 int i, in_global = 1;
1405 td_parent = td = NULL;
1407 if (!strncmp(o[i], "name", 4)) {
1410 add_job(td, jobname, 0, 0, client_type);
1412 sprintf(jobname, "%s", o[i] + 5);
1414 if (in_global && !td_parent)
1415 td_parent = get_new_job(1, &def_thread, 0, jobname);
1416 else if (!in_global && !td) {
1418 td_parent = &def_thread;
1419 td = get_new_job(0, td_parent, 0, jobname);
1422 fio_options_parse(td_parent, (char **) &o[i], 1, 0);
1424 fio_options_parse(td, (char **) &o[i], 1, 0);
1429 add_job(td, jobname, 0, 0, client_type);
1432 static int skip_this_section(const char *name)
1436 if (!nr_job_sections)
1438 if (!strncmp(name, "global", 6))
1441 for (i = 0; i < nr_job_sections; i++)
1442 if (!strcmp(job_sections[i], name))
1448 static int is_empty_or_comment(char *line)
1452 for (i = 0; i < strlen(line); i++) {
1457 if (!isspace((int) line[i]) && !iscntrl((int) line[i]))
1465 * This is our [ini] type file parser.
1467 int __parse_jobs_ini(struct thread_data *td,
1468 char *file, int is_buf, int stonewall_flag, int type,
1469 int nested, char *name, char ***popts, int *aopts, int *nopts)
1471 unsigned int global = 0;
1475 int ret = 0, stonewall;
1478 int inside_skip = 0;
1480 int i, alloc_opts, num_opts;
1482 dprint(FD_PARSE, "Parsing ini file %s\n", file);
1483 assert(td || !nested);
1488 if (!strcmp(file, "-"))
1491 f = fopen(file, "r");
1496 log_err("fio: unable to open '%s' job file\n", file);
1498 td_verror(td, __err, "job file open");
1503 string = malloc(4096);
1506 * it's really 256 + small bit, 280 should suffice
1510 memset(name, 0, 280);
1514 if (nested && popts) {
1516 alloc_opts = *aopts;
1522 opts = malloc(sizeof(char *) * alloc_opts);
1526 stonewall = stonewall_flag;
1529 * if skip_fgets is set, we already have loaded a line we
1534 p = strsep(&file, "\n");
1536 p = fgets(string, 4096, f);
1542 strip_blank_front(&p);
1545 dprint(FD_PARSE, "%s\n", p);
1546 if (is_empty_or_comment(p))
1550 if (sscanf(p, "[%255[^\n]]", name) != 1) {
1554 log_err("fio: option <%s> outside of "
1555 "[] job section\n", p);
1560 name[strlen(name) - 1] = '\0';
1562 if (skip_this_section(name)) {
1568 dprint(FD_PARSE, "Parsing section [%s]\n", name);
1570 global = !strncmp(name, "global", 6);
1576 log_info("--name=%s ", name);
1580 td = get_new_job(global, &def_thread, 0, name);
1587 * Separate multiple job files by a stonewall
1589 if (!global && stonewall) {
1590 td->o.stonewall = stonewall;
1595 memset(opts, 0, alloc_opts * sizeof(char *));
1603 p = strsep(&file, "\n");
1605 p = fgets(string, 4096, f);
1608 dprint(FD_PARSE, "%s", p);
1613 if (is_empty_or_comment(p))
1616 strip_blank_front(&p);
1619 * new section, break out and make sure we don't
1620 * fgets() a new line at the top.
1624 log_err("No new sections in included files\n");
1634 if (!strncmp(p, "include", strlen("include"))) {
1635 char *filename = p + strlen("include") + 1;
1637 if ((ret = __parse_jobs_ini(td, filename,
1638 is_buf, stonewall_flag, type, 1,
1639 name, &opts, &alloc_opts, &num_opts))) {
1640 log_err("Error %d while parsing include file %s\n",
1647 if (num_opts == alloc_opts) {
1649 opts = realloc(opts,
1650 alloc_opts * sizeof(char *));
1653 opts[num_opts] = strdup(p);
1659 *aopts = alloc_opts;
1664 ret = fio_options_parse(td, opts, num_opts, dump_cmdline);
1666 ret = add_job(td, name, 0, 0, type);
1668 log_err("fio: job %s dropped\n", name);
1672 for (i = 0; i < num_opts; i++)
1681 while (i < nr_job_sections) {
1682 free(job_sections[i]);
1691 if (!is_buf && f != stdin)
1696 int parse_jobs_ini(char *file, int is_buf, int stonewall_flag, int type)
1698 return __parse_jobs_ini(NULL, file, is_buf, stonewall_flag, type,
1699 0, NULL, NULL, NULL, NULL);
1702 static int fill_def_thread(void)
1704 memset(&def_thread, 0, sizeof(def_thread));
1706 fio_getaffinity(getpid(), &def_thread.o.cpumask);
1707 def_thread.o.error_dump = 1;
1710 * fill default options
1712 fio_fill_default_options(&def_thread);
1716 static void show_debug_categories(void)
1718 struct debug_level *dl = &debug_levels[0];
1719 int curlen, first = 1;
1723 int has_next = (dl + 1)->name != NULL;
1725 if (first || curlen + strlen(dl->name) >= 80) {
1730 curlen += printf("\t\t\t%s", dl->name);
1731 curlen += 3 * (8 - 1);
1733 curlen += printf(",");
1735 curlen += printf("%s", dl->name);
1737 curlen += printf(",");
1745 static void usage(const char *name)
1747 printf("%s\n", fio_version_string);
1748 printf("%s [options] [job options] <job file(s)>\n", name);
1749 printf(" --debug=options\tEnable debug logging. May be one/more of:\n");
1750 show_debug_categories();
1751 printf(" --parse-only\t\tParse options only, don't start any IO\n");
1752 printf(" --output\t\tWrite output to file\n");
1753 printf(" --runtime\t\tRuntime in seconds\n");
1754 printf(" --bandwidth-log\tGenerate per-job bandwidth logs\n");
1755 printf(" --minimal\t\tMinimal (terse) output\n");
1756 printf(" --output-format=x\tOutput format (terse,json,normal)\n");
1757 printf(" --terse-version=x\tSet terse version output format to 'x'\n");
1758 printf(" --version\t\tPrint version info and exit\n");
1759 printf(" --help\t\tPrint this page\n");
1760 printf(" --cpuclock-test\tPerform test/validation of CPU clock\n");
1761 printf(" --crctest\t\tTest speed of checksum functions\n");
1762 printf(" --cmdhelp=cmd\t\tPrint command help, \"all\" for all of"
1764 printf(" --enghelp=engine\tPrint ioengine help, or list"
1765 " available ioengines\n");
1766 printf(" --enghelp=engine,cmd\tPrint help for an ioengine"
1768 printf(" --showcmd\t\tTurn a job file into command line options\n");
1769 printf(" --eta=when\t\tWhen ETA estimate should be printed\n");
1770 printf(" \t\tMay be \"always\", \"never\" or \"auto\"\n");
1771 printf(" --eta-newline=time\tForce a new line for every 'time'");
1772 printf(" period passed\n");
1773 printf(" --status-interval=t\tForce full status dump every");
1774 printf(" 't' period passed\n");
1775 printf(" --readonly\t\tTurn on safety read-only checks, preventing"
1777 printf(" --section=name\tOnly run specified section in job file\n");
1778 printf(" --alloc-size=kb\tSet smalloc pool to this size in kb"
1780 printf(" --warnings-fatal\tFio parser warnings are fatal\n");
1781 printf(" --max-jobs=nr\t\tMaximum number of threads/processes to support\n");
1782 printf(" --server=args\t\tStart a backend fio server\n");
1783 printf(" --daemonize=pidfile\tBackground fio server, write pid to file\n");
1784 printf(" --client=hostname\tTalk to remote backend fio server at hostname\n");
1785 printf(" --remote-config=file\tTell fio server to load this local job file\n");
1786 printf(" --idle-prof=option\tReport cpu idleness on a system or percpu basis\n"
1787 "\t\t\t(option=system,percpu) or run unit work\n"
1788 "\t\t\tcalibration only (option=calibrate)\n");
1790 printf(" --inflate-log=log\tInflate and output compressed log\n");
1792 printf(" --trigger-file=file\tExecute trigger cmd when file exists\n");
1793 printf(" --trigger-timeout=t\tExecute trigger af this time\n");
1794 printf(" --trigger=cmd\t\tSet this command as local trigger\n");
1795 printf(" --trigger-remote=cmd\tSet this command as remote trigger\n");
1796 printf("\nFio was written by Jens Axboe <jens.axboe@oracle.com>");
1797 printf("\n Jens Axboe <jaxboe@fusionio.com>");
1798 printf("\n Jens Axboe <axboe@fb.com>\n");
1801 #ifdef FIO_INC_DEBUG
1802 struct debug_level debug_levels[] = {
1803 { .name = "process",
1804 .help = "Process creation/exit logging",
1805 .shift = FD_PROCESS,
1808 .help = "File related action logging",
1812 .help = "IO and IO engine action logging (offsets, queue, completions, etc)",
1816 .help = "Memory allocation/freeing logging",
1819 { .name = "blktrace",
1820 .help = "blktrace action logging",
1821 .shift = FD_BLKTRACE,
1824 .help = "IO verification action logging",
1828 .help = "Random generation logging",
1832 .help = "Parser logging",
1835 { .name = "diskutil",
1836 .help = "Disk utility logging actions",
1837 .shift = FD_DISKUTIL,
1840 .help = "Logging related to creating/destroying jobs",
1844 .help = "Mutex logging",
1847 { .name = "profile",
1848 .help = "Logging related to profiles",
1849 .shift = FD_PROFILE,
1852 .help = "Logging related to time keeping functions",
1856 .help = "Network logging",
1860 .help = "Rate logging",
1863 { .name = "compress",
1864 .help = "Log compression logging",
1865 .shift = FD_COMPRESS,
1870 static int set_debug(const char *string)
1872 struct debug_level *dl;
1873 char *p = (char *) string;
1877 if (!strcmp(string, "?") || !strcmp(string, "help")) {
1878 log_info("fio: dumping debug options:");
1879 for (i = 0; debug_levels[i].name; i++) {
1880 dl = &debug_levels[i];
1881 log_info("%s,", dl->name);
1887 while ((opt = strsep(&p, ",")) != NULL) {
1890 if (!strncmp(opt, "all", 3)) {
1891 log_info("fio: set all debug options\n");
1896 for (i = 0; debug_levels[i].name; i++) {
1897 dl = &debug_levels[i];
1898 found = !strncmp(opt, dl->name, strlen(dl->name));
1902 if (dl->shift == FD_JOB) {
1903 opt = strchr(opt, ':');
1905 log_err("fio: missing job number\n");
1909 fio_debug_jobno = atoi(opt);
1910 log_info("fio: set debug jobno %d\n",
1913 log_info("fio: set debug option %s\n", opt);
1914 fio_debug |= (1UL << dl->shift);
1920 log_err("fio: debug mask %s not found\n", opt);
1925 static int set_debug(const char *string)
1927 log_err("fio: debug tracing not included in build\n");
1932 static void fio_options_fill_optstring(void)
1934 char *ostr = cmd_optstr;
1938 while (l_opts[i].name) {
1939 ostr[c++] = l_opts[i].val;
1940 if (l_opts[i].has_arg == required_argument)
1942 else if (l_opts[i].has_arg == optional_argument) {
1951 static int client_flag_set(char c)
1956 while (l_opts[i].name) {
1957 int val = l_opts[i].val;
1959 if (c == (val & 0xff))
1960 return (val & FIO_CLIENT_FLAG);
1968 static void parse_cmd_client(void *client, char *opt)
1970 fio_client_add_cmd_option(client, opt);
1973 static void show_closest_option(const char *name)
1975 int best_option, best_distance;
1978 while (*name == '-')
1982 best_distance = INT_MAX;
1984 while (l_opts[i].name) {
1985 distance = string_distance(name, l_opts[i].name);
1986 if (distance < best_distance) {
1987 best_distance = distance;
1993 if (best_option != -1)
1994 log_err("Did you mean %s?\n", l_opts[best_option].name);
1997 int parse_cmd_line(int argc, char *argv[], int client_type)
1999 struct thread_data *td = NULL;
2000 int c, ini_idx = 0, lidx, ret = 0, do_exit = 0, exit_val = 0;
2001 char *ostr = cmd_optstr;
2002 void *pid_file = NULL;
2003 void *cur_client = NULL;
2007 * Reset optind handling, since we may call this multiple times
2012 while ((c = getopt_long_only(argc, argv, ostr, l_opts, &lidx)) != -1) {
2013 if ((c & FIO_CLIENT_FLAG) || client_flag_set(c)) {
2014 parse_cmd_client(cur_client, argv[optind - 1]);
2015 c &= ~FIO_CLIENT_FLAG;
2020 smalloc_pool_size = atoi(optarg);
2023 if (check_str_time(optarg, &def_timeout, 1)) {
2024 log_err("fio: failed parsing time %s\n", optarg);
2030 log_err("fio: --latency-log is deprecated. Use per-job latency log options.\n");
2038 if (f_out && f_out != stdout)
2041 f_out = fopen(optarg, "w+");
2043 perror("fopen output");
2049 output_format = FIO_OUTPUT_TERSE;
2053 log_err("fio: missing --output-format argument\n");
2058 if (!strcmp(optarg, "minimal") ||
2059 !strcmp(optarg, "terse") ||
2060 !strcmp(optarg, "csv"))
2061 output_format = FIO_OUTPUT_TERSE;
2062 else if (!strcmp(optarg, "json"))
2063 output_format = FIO_OUTPUT_JSON;
2065 output_format = FIO_OUTPUT_NORMAL;
2068 append_terse_output = 1;
2080 fio_show_option_help(optarg);
2087 fio_show_ioengine_help(optarg);
2101 log_info("%s\n", fio_version_string);
2106 terse_version = atoi(optarg);
2107 if (!(terse_version == 2 || terse_version == 3 ||
2108 terse_version == 4)) {
2109 log_err("fio: bad terse version format\n");
2115 if (!strcmp("always", optarg))
2116 eta_print = FIO_ETA_ALWAYS;
2117 else if (!strcmp("never", optarg))
2118 eta_print = FIO_ETA_NEVER;
2123 if (check_str_time(optarg, &t, 1)) {
2124 log_err("fio: failed parsing eta time %s\n", optarg);
2128 eta_new_line = t / 1000;
2132 if (set_debug(optarg))
2142 if (!strcmp(optarg, "global")) {
2143 log_err("fio: can't use global as only "
2149 new_size = (nr_job_sections + 1) * sizeof(char *);
2150 job_sections = realloc(job_sections, new_size);
2151 job_sections[nr_job_sections] = strdup(optarg);
2157 exit_val = iolog_file_inflate(optarg);
2166 exec_profile = strdup(optarg);
2168 case FIO_GETOPT_JOB: {
2169 const char *opt = l_opts[lidx].name;
2172 if (!strncmp(opt, "name", 4) && td) {
2173 ret = add_job(td, td->o.name ?: "fio", 0, 0, client_type);
2180 int is_section = !strncmp(opt, "name", 4);
2183 if (!is_section || !strncmp(val, "global", 6))
2186 if (is_section && skip_this_section(val))
2189 td = get_new_job(global, &def_thread, 1, NULL);
2190 if (!td || ioengine_load(td)) {
2199 fio_options_set_ioengine_opts(l_opts, td);
2202 if ((!val || !strlen(val)) &&
2203 l_opts[lidx].has_arg == required_argument) {
2204 log_err("fio: option %s requires an argument\n", opt);
2207 ret = fio_cmd_option_parse(td, opt, val);
2218 if (!ret && !strcmp(opt, "ioengine")) {
2220 if (ioengine_load(td)) {
2227 fio_options_set_ioengine_opts(l_opts, td);
2231 case FIO_GETOPT_IOENGINE: {
2232 const char *opt = l_opts[lidx].name;
2238 ret = fio_cmd_ioengine_option_parse(td, opt, val);
2245 max_jobs = atoi(optarg);
2246 if (!max_jobs || max_jobs > REAL_MAX_JOBS) {
2247 log_err("fio: invalid max jobs: %d\n", max_jobs);
2254 #ifndef CONFIG_NO_SHM
2256 log_err("fio: can't be both client and server\n");
2262 fio_server_set_arg(optarg);
2266 log_err("fio: client/server requires SHM support\n");
2274 pid_file = strdup(optarg);
2277 if ((ret = fio_idle_prof_parse_opt(optarg))) {
2278 /* exit on error and calibration only */
2288 log_err("fio: can't be both client and server\n");
2293 /* if --client parameter contains a pathname */
2294 if (0 == access(optarg, R_OK)) {
2295 /* file contains a list of host addrs or names */
2296 char hostaddr[PATH_MAX] = {0};
2298 FILE * hostf = fopen(optarg, "r");
2300 log_err("fio: could not open client list file %s for read\n", optarg);
2305 sprintf(formatstr, "%%%ds", PATH_MAX - 1);
2307 * read at most PATH_MAX-1 chars from each
2308 * record in this file
2310 while (fscanf(hostf, formatstr, hostaddr) == 1) {
2311 /* expect EVERY host in file to be valid */
2312 if (fio_client_add(&fio_client_ops, hostaddr, &cur_client)) {
2313 log_err("fio: failed adding client %s from file %s\n", hostaddr, optarg);
2320 break; /* no possibility of job file for "this client only" */
2322 if (fio_client_add(&fio_client_ops, optarg, &cur_client)) {
2323 log_err("fio: failed adding client %s\n", optarg);
2329 * If the next argument exists and isn't an option,
2330 * assume it's a job file for this client only.
2332 while (optind < argc) {
2333 if (!strncmp(argv[optind], "--", 2) ||
2334 !strncmp(argv[optind], "-", 1))
2337 if (fio_client_add_ini_file(cur_client, argv[optind], 0))
2344 if (fio_client_add_ini_file(cur_client, optarg, 1)) {
2352 exit_val = fio_monotonic_clocktest(1);
2357 exit_val = fio_crctest(optarg);
2362 if (check_str_time(optarg, &val, 1)) {
2363 log_err("fio: failed parsing time %s\n", optarg);
2368 status_interval = val / 1000;
2374 trigger_file = strdup(optarg);
2379 trigger_cmd = strdup(optarg);
2382 if (trigger_remote_cmd)
2383 free(trigger_remote_cmd);
2384 trigger_remote_cmd = strdup(optarg);
2387 if (check_str_time(optarg, &trigger_timeout, 1)) {
2388 log_err("fio: failed parsing time %s\n", optarg);
2392 trigger_timeout /= 1000000;
2395 log_err("%s: unrecognized option '%s'\n", argv[0],
2397 show_closest_option(argv[optind - 1]);
2407 if (do_exit && !(is_backend || nr_clients))
2410 if (nr_clients && fio_clients_connect())
2413 if (is_backend && backend)
2414 return fio_start_server(pid_file);
2420 ret = add_job(td, td->o.name ?: "fio", 0, 0, client_type);
2426 while (!ret && optind < argc) {
2428 ini_file = realloc(ini_file, ini_idx * sizeof(char *));
2429 ini_file[ini_idx - 1] = strdup(argv[optind]);
2440 int fio_init_options(void)
2445 fio_options_fill_optstring();
2446 fio_options_dup_and_init(l_opts);
2450 if (fill_def_thread())
2456 extern int fio_check_options(struct thread_options *);
2458 int parse_options(int argc, char *argv[])
2460 const int type = FIO_CLIENT_TYPE_CLI;
2463 if (fio_init_options())
2465 if (fio_test_cconv(&def_thread.o))
2466 log_err("fio: failed internal cconv test\n");
2468 job_files = parse_cmd_line(argc, argv, type);
2470 if (job_files > 0) {
2471 for (i = 0; i < job_files; i++) {
2472 if (i && fill_def_thread())
2475 if (fio_clients_send_ini(ini_file[i]))
2478 } else if (!is_backend) {
2479 if (parse_jobs_ini(ini_file[i], 0, i, type))
2484 } else if (nr_clients) {
2485 if (fill_def_thread())
2487 if (fio_clients_send_ini(NULL))
2492 fio_options_free(&def_thread);
2493 filesetup_mem_free();
2495 if (!thread_number) {
2500 if (is_backend || nr_clients)
2505 log_err("No jobs(s) defined\n\n");
2515 if (output_format == FIO_OUTPUT_NORMAL)
2516 log_info("%s\n", fio_version_string);
2521 void options_default_fill(struct thread_options *o)
2523 memcpy(o, &def_thread.o, sizeof(*o));