2 * This file contains job initialization and setup functions.
12 #include <sys/types.h>
16 #ifndef FIO_NO_HAVE_SHM_H
28 #include "lib/getopt.h"
29 #include "lib/strcasestr.h"
31 const char fio_version_string[] = FIO_VERSION;
33 #define FIO_RANDSEED (0xb1899bedUL)
35 static char **ini_file;
36 static int max_jobs = FIO_MAX_JOBS;
37 static int dump_cmdline;
38 static int def_timeout;
39 static int parse_only;
41 static struct thread_data def_thread;
42 struct thread_data *threads = NULL;
44 int exitall_on_terminate = 0;
45 int output_format = FIO_OUTPUT_NORMAL;
46 int append_terse_output = 0;
47 int eta_print = FIO_ETA_AUTO;
51 char **job_sections = NULL;
52 int nr_job_sections = 0;
53 char *exec_profile = NULL;
54 int warnings_fatal = 0;
55 int terse_version = 3;
62 int status_interval = 0;
64 static int write_lat_log;
66 static int prev_group_jobs;
68 unsigned long fio_debug = 0;
69 unsigned int fio_debug_jobno = -1;
70 unsigned int *fio_debug_jobp = NULL;
72 static char cmd_optstr[256];
75 #define FIO_CLIENT_FLAG (1 << 16)
78 * Command line options. These will contain the above, plus a few
79 * extra that only pertain to fio itself and not jobs.
81 static struct option l_opts[FIO_NR_OPTIONS] = {
83 .name = (char *) "output",
84 .has_arg = required_argument,
85 .val = 'o' | FIO_CLIENT_FLAG,
88 .name = (char *) "timeout",
89 .has_arg = required_argument,
90 .val = 't' | FIO_CLIENT_FLAG,
93 .name = (char *) "latency-log",
94 .has_arg = required_argument,
95 .val = 'l' | FIO_CLIENT_FLAG,
98 .name = (char *) "bandwidth-log",
99 .has_arg = required_argument,
100 .val = 'b' | FIO_CLIENT_FLAG,
103 .name = (char *) "minimal",
104 .has_arg = no_argument,
105 .val = 'm' | FIO_CLIENT_FLAG,
108 .name = (char *) "output-format",
109 .has_arg = optional_argument,
110 .val = 'F' | FIO_CLIENT_FLAG,
113 .name = (char *) "append-terse",
114 .has_arg = optional_argument,
118 .name = (char *) "version",
119 .has_arg = no_argument,
120 .val = 'v' | FIO_CLIENT_FLAG,
123 .name = (char *) "help",
124 .has_arg = no_argument,
125 .val = 'h' | FIO_CLIENT_FLAG,
128 .name = (char *) "cmdhelp",
129 .has_arg = optional_argument,
130 .val = 'c' | FIO_CLIENT_FLAG,
133 .name = (char *) "enghelp",
134 .has_arg = optional_argument,
135 .val = 'i' | FIO_CLIENT_FLAG,
138 .name = (char *) "showcmd",
139 .has_arg = no_argument,
140 .val = 's' | FIO_CLIENT_FLAG,
143 .name = (char *) "readonly",
144 .has_arg = no_argument,
145 .val = 'r' | FIO_CLIENT_FLAG,
148 .name = (char *) "eta",
149 .has_arg = required_argument,
150 .val = 'e' | FIO_CLIENT_FLAG,
153 .name = (char *) "eta-newline",
154 .has_arg = required_argument,
155 .val = 'E' | FIO_CLIENT_FLAG,
158 .name = (char *) "debug",
159 .has_arg = required_argument,
160 .val = 'd' | FIO_CLIENT_FLAG,
163 .name = (char *) "parse-only",
164 .has_arg = no_argument,
165 .val = 'P' | FIO_CLIENT_FLAG,
168 .name = (char *) "section",
169 .has_arg = required_argument,
170 .val = 'x' | FIO_CLIENT_FLAG,
173 .name = (char *) "alloc-size",
174 .has_arg = required_argument,
175 .val = 'a' | FIO_CLIENT_FLAG,
178 .name = (char *) "profile",
179 .has_arg = required_argument,
180 .val = 'p' | FIO_CLIENT_FLAG,
183 .name = (char *) "warnings-fatal",
184 .has_arg = no_argument,
185 .val = 'w' | FIO_CLIENT_FLAG,
188 .name = (char *) "max-jobs",
189 .has_arg = required_argument,
190 .val = 'j' | FIO_CLIENT_FLAG,
193 .name = (char *) "terse-version",
194 .has_arg = required_argument,
195 .val = 'V' | FIO_CLIENT_FLAG,
198 .name = (char *) "server",
199 .has_arg = optional_argument,
202 { .name = (char *) "daemonize",
203 .has_arg = required_argument,
207 .name = (char *) "client",
208 .has_arg = required_argument,
212 .name = (char *) "cpuclock-test",
213 .has_arg = no_argument,
217 .name = (char *) "crctest",
218 .has_arg = optional_argument,
222 .name = (char *) "idle-prof",
223 .has_arg = required_argument,
227 .name = (char *) "status-interval",
228 .has_arg = required_argument,
236 void free_threads_shm(void)
238 struct shmid_ds sbuf;
245 shmctl(shm_id, IPC_RMID, &sbuf);
255 fio_debug_jobp = NULL;
259 options_free(fio_options, &def_thread);
264 * The thread area is shared between the main process and the job
265 * threads/processes. So setup a shared memory segment that will hold
266 * all the job info. We use the end of the region for keeping track of
267 * open files across jobs, for file sharing.
269 static int setup_thread_area(void)
277 * 1024 is too much on some machines, scale max_jobs if
278 * we get a failure that looks like too large a shm segment
281 size_t size = max_jobs * sizeof(struct thread_data);
283 size += file_hash_size;
284 size += sizeof(unsigned int);
286 shm_id = shmget(0, size, IPC_CREAT | 0600);
289 if (errno != EINVAL && errno != ENOMEM && errno != ENOSPC) {
300 threads = shmat(shm_id, NULL, 0);
301 if (threads == (void *) -1) {
306 memset(threads, 0, max_jobs * sizeof(struct thread_data));
307 hash = (void *) threads + max_jobs * sizeof(struct thread_data);
308 fio_debug_jobp = (void *) hash + file_hash_size;
309 *fio_debug_jobp = -1;
310 file_hash_init(hash);
318 * Return a free job structure.
320 static struct thread_data *get_new_job(int global, struct thread_data *parent,
323 struct thread_data *td;
327 if (setup_thread_area()) {
328 log_err("error: failed to setup shm segment\n");
331 if (thread_number >= max_jobs) {
332 log_err("error: maximum number of jobs (%d) reached.\n",
337 td = &threads[thread_number++];
344 td->o.uid = td->o.gid = -1U;
346 dup_files(td, parent);
347 fio_options_mem_dupe(td);
349 profile_add_hooks(td);
351 td->thread_number = thread_number;
353 if (!parent || !parent->o.group_reporting)
359 static void put_job(struct thread_data *td)
361 if (td == &def_thread)
368 log_info("fio: %s\n", td->verror);
370 fio_options_free(td);
374 memset(&threads[td->thread_number - 1], 0, sizeof(*td));
378 static int __setup_rate(struct thread_data *td, enum fio_ddir ddir)
380 unsigned int bs = td->o.min_bs[ddir];
382 assert(ddir_rw(ddir));
384 if (td->o.rate[ddir])
385 td->rate_bps[ddir] = td->o.rate[ddir];
387 td->rate_bps[ddir] = td->o.rate_iops[ddir] * bs;
389 if (!td->rate_bps[ddir]) {
390 log_err("rate lower than supported\n");
394 td->rate_pending_usleep[ddir] = 0;
398 static int setup_rate(struct thread_data *td)
402 if (td->o.rate[DDIR_READ] || td->o.rate_iops[DDIR_READ])
403 ret = __setup_rate(td, DDIR_READ);
404 if (td->o.rate[DDIR_WRITE] || td->o.rate_iops[DDIR_WRITE])
405 ret |= __setup_rate(td, DDIR_WRITE);
406 if (td->o.rate[DDIR_TRIM] || td->o.rate_iops[DDIR_TRIM])
407 ret |= __setup_rate(td, DDIR_TRIM);
412 static int fixed_block_size(struct thread_options *o)
414 return o->min_bs[DDIR_READ] == o->max_bs[DDIR_READ] &&
415 o->min_bs[DDIR_WRITE] == o->max_bs[DDIR_WRITE] &&
416 o->min_bs[DDIR_TRIM] == o->max_bs[DDIR_TRIM] &&
417 o->min_bs[DDIR_READ] == o->min_bs[DDIR_WRITE] &&
418 o->min_bs[DDIR_READ] == o->min_bs[DDIR_TRIM];
422 static unsigned long long get_rand_start_delay(struct thread_data *td)
424 unsigned long long delayrange;
427 delayrange = td->o.start_delay_high - td->o.start_delay;
429 if (td->o.use_os_rand) {
430 r = os_random_long(&td->delay_state);
431 delayrange = (unsigned long long) ((double) delayrange * (r / (OS_RAND_MAX + 1.0)));
433 r = __rand(&td->__delay_state);
434 delayrange = (unsigned long long) ((double) delayrange * (r / (FRAND_MAX + 1.0)));
437 delayrange += td->o.start_delay;
442 * Lazy way of fixing up options that depend on each other. We could also
443 * define option callback handlers, but this is easier.
445 static int fixup_options(struct thread_data *td)
447 struct thread_options *o = &td->o;
450 #ifndef FIO_HAVE_PSHARED_MUTEX
451 if (!o->use_thread) {
452 log_info("fio: this platform does not support process shared"
453 " mutexes, forcing use of threads. Use the 'thread'"
454 " option to get rid of this warning.\n");
456 ret = warnings_fatal;
460 if (o->write_iolog_file && o->read_iolog_file) {
461 log_err("fio: read iolog overrides write_iolog\n");
462 free(o->write_iolog_file);
463 o->write_iolog_file = NULL;
464 ret = warnings_fatal;
468 * only really works with 1 file
470 if (o->zone_size && o->open_files > 1)
474 * If zone_range isn't specified, backward compatibility dictates it
475 * should be made equal to zone_size.
477 if (o->zone_size && !o->zone_range)
478 o->zone_range = o->zone_size;
481 * Reads can do overwrites, we always need to pre-create the file
483 if (td_read(td) || td_rw(td))
486 if (!o->min_bs[DDIR_READ])
487 o->min_bs[DDIR_READ] = o->bs[DDIR_READ];
488 if (!o->max_bs[DDIR_READ])
489 o->max_bs[DDIR_READ] = o->bs[DDIR_READ];
490 if (!o->min_bs[DDIR_WRITE])
491 o->min_bs[DDIR_WRITE] = o->bs[DDIR_WRITE];
492 if (!o->max_bs[DDIR_WRITE])
493 o->max_bs[DDIR_WRITE] = o->bs[DDIR_WRITE];
494 if (!o->min_bs[DDIR_TRIM])
495 o->min_bs[DDIR_TRIM] = o->bs[DDIR_TRIM];
496 if (!o->max_bs[DDIR_TRIM])
497 o->max_bs[DDIR_TRIM] = o->bs[DDIR_TRIM];
500 o->rw_min_bs = min(o->min_bs[DDIR_READ], o->min_bs[DDIR_WRITE]);
501 o->rw_min_bs = min(o->min_bs[DDIR_TRIM], o->rw_min_bs);
504 * For random IO, allow blockalign offset other than min_bs.
506 if (!o->ba[DDIR_READ] || !td_random(td))
507 o->ba[DDIR_READ] = o->min_bs[DDIR_READ];
508 if (!o->ba[DDIR_WRITE] || !td_random(td))
509 o->ba[DDIR_WRITE] = o->min_bs[DDIR_WRITE];
510 if (!o->ba[DDIR_TRIM] || !td_random(td))
511 o->ba[DDIR_TRIM] = o->min_bs[DDIR_TRIM];
513 if ((o->ba[DDIR_READ] != o->min_bs[DDIR_READ] ||
514 o->ba[DDIR_WRITE] != o->min_bs[DDIR_WRITE] ||
515 o->ba[DDIR_TRIM] != o->min_bs[DDIR_TRIM]) &&
517 log_err("fio: Any use of blockalign= turns off randommap\n");
519 ret = warnings_fatal;
522 if (!o->file_size_high)
523 o->file_size_high = o->file_size_low;
525 if (o->start_delay_high)
526 o->start_delay = get_rand_start_delay(td);
528 if (o->norandommap && o->verify != VERIFY_NONE
529 && !fixed_block_size(o)) {
530 log_err("fio: norandommap given for variable block sizes, "
531 "verify disabled\n");
532 o->verify = VERIFY_NONE;
533 ret = warnings_fatal;
535 if (o->bs_unaligned && (o->odirect || td->io_ops->flags & FIO_RAWIO))
536 log_err("fio: bs_unaligned may not work with raw io\n");
539 * thinktime_spin must be less than thinktime
541 if (o->thinktime_spin > o->thinktime)
542 o->thinktime_spin = o->thinktime;
545 * The low water mark cannot be bigger than the iodepth
547 if (o->iodepth_low > o->iodepth || !o->iodepth_low)
548 o->iodepth_low = o->iodepth;
551 * If batch number isn't set, default to the same as iodepth
553 if (o->iodepth_batch > o->iodepth || !o->iodepth_batch)
554 o->iodepth_batch = o->iodepth;
556 if (o->nr_files > td->files_index)
557 o->nr_files = td->files_index;
559 if (o->open_files > o->nr_files || !o->open_files)
560 o->open_files = o->nr_files;
562 if (((o->rate[DDIR_READ] + o->rate[DDIR_WRITE] + o->rate[DDIR_TRIM]) &&
563 (o->rate_iops[DDIR_READ] + o->rate_iops[DDIR_WRITE] + o->rate_iops[DDIR_TRIM])) ||
564 ((o->ratemin[DDIR_READ] + o->ratemin[DDIR_WRITE] + o->ratemin[DDIR_TRIM]) &&
565 (o->rate_iops_min[DDIR_READ] + o->rate_iops_min[DDIR_WRITE] + o->rate_iops_min[DDIR_TRIM]))) {
566 log_err("fio: rate and rate_iops are mutually exclusive\n");
569 if ((o->rate[DDIR_READ] < o->ratemin[DDIR_READ]) ||
570 (o->rate[DDIR_WRITE] < o->ratemin[DDIR_WRITE]) ||
571 (o->rate[DDIR_TRIM] < o->ratemin[DDIR_TRIM]) ||
572 (o->rate_iops[DDIR_READ] < o->rate_iops_min[DDIR_READ]) ||
573 (o->rate_iops[DDIR_WRITE] < o->rate_iops_min[DDIR_WRITE]) ||
574 (o->rate_iops[DDIR_TRIM] < o->rate_iops_min[DDIR_TRIM])) {
575 log_err("fio: minimum rate exceeds rate\n");
579 if (!o->timeout && o->time_based) {
580 log_err("fio: time_based requires a runtime/timeout setting\n");
582 ret = warnings_fatal;
585 if (o->fill_device && !o->size)
588 if (o->verify != VERIFY_NONE) {
589 if (td_write(td) && o->do_verify && o->numjobs > 1) {
590 log_info("Multiple writers may overwrite blocks that "
591 "belong to other jobs. This can cause "
592 "verification failures.\n");
593 ret = warnings_fatal;
596 o->refill_buffers = 1;
597 if (o->max_bs[DDIR_WRITE] != o->min_bs[DDIR_WRITE] &&
599 o->verify_interval = o->min_bs[DDIR_WRITE];
603 o->invalidate_cache = 0;
604 if (td->io_ops->flags & FIO_PIPEIO) {
605 log_info("fio: cannot pre-read files with an IO engine"
606 " that isn't seekable. Pre-read disabled.\n");
607 ret = warnings_fatal;
612 if (td->io_ops->flags & FIO_BIT_BASED)
618 #ifndef CONFIG_FDATASYNC
619 if (o->fdatasync_blocks) {
620 log_info("fio: this platform does not support fdatasync()"
621 " falling back to using fsync(). Use the 'fsync'"
622 " option instead of 'fdatasync' to get rid of"
624 o->fsync_blocks = o->fdatasync_blocks;
625 o->fdatasync_blocks = 0;
626 ret = warnings_fatal;
632 * Windows doesn't support O_DIRECT or O_SYNC with the _open interface,
633 * so fail if we're passed those flags
635 if ((td->io_ops->flags & FIO_SYNCIO) && (td->o.odirect || td->o.sync_io)) {
636 log_err("fio: Windows does not support direct or non-buffered io with"
637 " the synchronous ioengines. Use the 'windowsaio' ioengine"
638 " with 'direct=1' and 'iodepth=1' instead.\n");
644 * For fully compressible data, just zero them at init time.
645 * It's faster than repeatedly filling it.
647 if (td->o.compress_percentage == 100) {
648 td->o.zero_buffers = 1;
649 td->o.compress_percentage = 0;
653 * Using a non-uniform random distribution excludes usage of
656 if (td->o.random_distribution != FIO_RAND_DIST_RANDOM)
657 td->o.norandommap = 1;
660 * If size is set but less than the min block size, complain
662 if (o->size && o->size < td_min_bs(td)) {
663 log_err("fio: size too small, must be larger than the IO size: %llu\n", (unsigned long long) o->size);
668 * O_ATOMIC implies O_DIRECT
674 * If randseed is set, that overrides randrepeat
677 td->o.rand_repeatable = 0;
683 * This function leaks the buffer
685 char *fio_uint_to_kmg(unsigned int val)
687 char *buf = malloc(32);
688 char post[] = { 0, 'K', 'M', 'G', 'P', 'E', 0 };
699 snprintf(buf, 32, "%u%c", val, *p);
703 /* External engines are specified by "external:name.o") */
704 static const char *get_engine_name(const char *str)
706 char *p = strstr(str, ":");
712 strip_blank_front(&p);
717 static int exists_and_not_file(const char *filename)
721 if (lstat(filename, &sb) == -1)
724 /* \\.\ is the device namespace in Windows, where every file
725 * is a device node */
726 if (S_ISREG(sb.st_mode) && strncmp(filename, "\\\\.\\", 4) != 0)
732 static void td_fill_rand_seeds_os(struct thread_data *td)
734 os_random_seed(td->rand_seeds[FIO_RAND_BS_OFF], &td->bsrange_state);
735 os_random_seed(td->rand_seeds[FIO_RAND_VER_OFF], &td->verify_state);
736 os_random_seed(td->rand_seeds[FIO_RAND_MIX_OFF], &td->rwmix_state);
738 if (td->o.file_service_type == FIO_FSERVICE_RANDOM)
739 os_random_seed(td->rand_seeds[FIO_RAND_FILE_OFF], &td->next_file_state);
741 os_random_seed(td->rand_seeds[FIO_RAND_FILE_SIZE_OFF], &td->file_size_state);
742 os_random_seed(td->rand_seeds[FIO_RAND_TRIM_OFF], &td->trim_state);
743 os_random_seed(td->rand_seeds[FIO_RAND_START_DELAY], &td->delay_state);
748 if (td->o.rand_repeatable)
749 td->rand_seeds[FIO_RAND_BLOCK_OFF] = FIO_RANDSEED * td->thread_number;
751 os_random_seed(td->rand_seeds[FIO_RAND_BLOCK_OFF], &td->random_state);
753 os_random_seed(td->rand_seeds[FIO_RAND_SEQ_RAND_READ_OFF], &td->seq_rand_state[DDIR_READ]);
754 os_random_seed(td->rand_seeds[FIO_RAND_SEQ_RAND_WRITE_OFF], &td->seq_rand_state[DDIR_WRITE]);
755 os_random_seed(td->rand_seeds[FIO_RAND_SEQ_RAND_TRIM_OFF], &td->seq_rand_state[DDIR_TRIM]);
758 static void td_fill_rand_seeds_internal(struct thread_data *td)
760 init_rand_seed(&td->__bsrange_state, td->rand_seeds[FIO_RAND_BS_OFF]);
761 init_rand_seed(&td->__verify_state, td->rand_seeds[FIO_RAND_VER_OFF]);
762 init_rand_seed(&td->__rwmix_state, td->rand_seeds[FIO_RAND_MIX_OFF]);
764 if (td->o.file_service_type == FIO_FSERVICE_RANDOM)
765 init_rand_seed(&td->__next_file_state, td->rand_seeds[FIO_RAND_FILE_OFF]);
767 init_rand_seed(&td->__file_size_state, td->rand_seeds[FIO_RAND_FILE_SIZE_OFF]);
768 init_rand_seed(&td->__trim_state, td->rand_seeds[FIO_RAND_TRIM_OFF]);
769 init_rand_seed(&td->__delay_state, td->rand_seeds[FIO_RAND_START_DELAY]);
774 if (td->o.rand_repeatable)
775 td->rand_seeds[FIO_RAND_BLOCK_OFF] = FIO_RANDSEED * td->thread_number;
777 init_rand_seed(&td->__random_state, td->rand_seeds[FIO_RAND_BLOCK_OFF]);
778 init_rand_seed(&td->__seq_rand_state[DDIR_READ], td->rand_seeds[FIO_RAND_SEQ_RAND_READ_OFF]);
779 init_rand_seed(&td->__seq_rand_state[DDIR_WRITE], td->rand_seeds[FIO_RAND_SEQ_RAND_WRITE_OFF]);
780 init_rand_seed(&td->__seq_rand_state[DDIR_TRIM], td->rand_seeds[FIO_RAND_SEQ_RAND_TRIM_OFF]);
783 void td_fill_rand_seeds(struct thread_data *td)
785 if (td->o.allrand_repeatable) {
786 for (int i = 0; i < FIO_RAND_NR_OFFS; i++)
787 td->rand_seeds[i] = FIO_RANDSEED * td->thread_number
791 if (td->o.use_os_rand)
792 td_fill_rand_seeds_os(td);
794 td_fill_rand_seeds_internal(td);
796 init_rand_seed(&td->buf_state, td->rand_seeds[FIO_RAND_BUF_OFF]);
800 * Initializes the ioengine configured for a job, if it has not been done so
803 int ioengine_load(struct thread_data *td)
808 * Engine has already been loaded.
812 if (!td->o.ioengine) {
813 log_err("fio: internal fault, no IO engine specified\n");
817 engine = get_engine_name(td->o.ioengine);
818 td->io_ops = load_ioengine(td, engine);
820 log_err("fio: failed to load engine %s\n", engine);
824 if (td->io_ops->option_struct_size && td->io_ops->options) {
826 * In cases where td->eo is set, clone it for a child thread.
827 * This requires that the parent thread has the same ioengine,
828 * but that requirement must be enforced by the code which
831 void *origeo = td->eo;
833 * Otherwise use the default thread options.
835 if (!origeo && td != &def_thread && def_thread.eo &&
836 def_thread.io_ops->options == td->io_ops->options)
837 origeo = def_thread.eo;
839 options_init(td->io_ops->options);
840 td->eo = malloc(td->io_ops->option_struct_size);
842 * Use the default thread as an option template if this uses the
843 * same options structure and there are non-default options
847 memcpy(td->eo, origeo, td->io_ops->option_struct_size);
848 options_mem_dupe(td->eo, td->io_ops->options);
850 memset(td->eo, 0, td->io_ops->option_struct_size);
851 fill_default_options(td->eo, td->io_ops->options);
853 *(struct thread_data **)td->eo = td;
859 static void init_flags(struct thread_data *td)
861 struct thread_options *o = &td->o;
863 if (o->verify_backlog)
864 td->flags |= TD_F_VER_BACKLOG;
866 td->flags |= TD_F_TRIM_BACKLOG;
867 if (o->read_iolog_file)
868 td->flags |= TD_F_READ_IOLOG;
869 if (o->refill_buffers)
870 td->flags |= TD_F_REFILL_BUFFERS;
871 if (o->scramble_buffers)
872 td->flags |= TD_F_SCRAMBLE_BUFFERS;
873 if (o->verify != VERIFY_NONE)
874 td->flags |= TD_F_VER_NONE;
877 static int setup_random_seeds(struct thread_data *td)
882 if (!td->o.rand_repeatable && !td->o.rand_seed)
883 return init_random_state(td, td->rand_seeds, sizeof(td->rand_seeds));
885 if (!td->o.rand_seed)
888 seed = td->o.rand_seed;
890 for (i = 0; i < 4; i++)
891 seed *= 0x9e370001UL;
893 for (i = 0; i < FIO_RAND_NR_OFFS; i++) {
894 td->rand_seeds[i] = seed;
895 seed *= 0x9e370001UL;
898 td_fill_rand_seeds(td);
909 static struct fpre_keyword {
913 } fpre_keywords[] = {
914 { .keyword = "$jobname", .key = FPRE_JOBNAME, },
915 { .keyword = "$jobnum", .key = FPRE_JOBNUM, },
916 { .keyword = "$filenum", .key = FPRE_FILENUM, },
917 { .keyword = NULL, },
920 static char *make_filename(char *buf, struct thread_options *o,
921 const char *jobname, int jobnum, int filenum)
923 struct fpre_keyword *f;
926 if (!o->filename_format || !strlen(o->filename_format)) {
927 sprintf(buf, "%s.%d.%d", jobname, jobnum, filenum);
931 for (f = &fpre_keywords[0]; f->keyword; f++)
932 f->strlen = strlen(f->keyword);
934 strcpy(buf, o->filename_format);
935 memset(copy, 0, sizeof(copy));
936 for (f = &fpre_keywords[0]; f->keyword; f++) {
938 size_t pre_len, post_start = 0;
939 char *str, *dst = copy;
941 str = strcasestr(buf, f->keyword);
946 if (strlen(str) != f->strlen)
947 post_start = pre_len + f->strlen;
950 strncpy(dst, buf, pre_len);
956 dst += sprintf(dst, "%s", jobname);
959 dst += sprintf(dst, "%d", jobnum);
962 dst += sprintf(dst, "%d", filenum);
970 strcpy(dst, buf + post_start);
979 int parse_dryrun(void)
981 return dump_cmdline || parse_only;
985 * Adds a job to the list of things todo. Sanitizes the various options
986 * to make sure we don't have conflicts, and initializes various
989 static int add_job(struct thread_data *td, const char *jobname, int job_add_num,
990 int recursed, int client_type)
993 char fname[PATH_MAX];
994 int numjobs, file_alloced;
995 struct thread_options *o = &td->o;
998 * the def_thread is just for options, it's not a real job
1000 if (td == &def_thread)
1006 * if we are just dumping the output command line, don't add the job
1008 if (parse_dryrun()) {
1013 td->client_type = client_type;
1015 if (profile_td_init(td))
1018 if (ioengine_load(td))
1022 td->io_ops->flags |= FIO_RAWIO;
1025 if (!o->filename && !td->files_index && !o->read_iolog_file) {
1028 if (o->nr_files == 1 && exists_and_not_file(jobname))
1029 add_file(td, jobname, job_add_num, 0);
1031 for (i = 0; i < o->nr_files; i++)
1032 add_file(td, make_filename(fname, o, jobname, job_add_num, i), job_add_num, 0);
1036 if (fixup_options(td))
1042 * IO engines only need this for option callbacks, and the address may
1043 * change in subprocesses.
1046 *(struct thread_data **)td->eo = NULL;
1048 if (td->io_ops->flags & FIO_DISKLESSIO) {
1051 for_each_file(td, f, i)
1052 f->real_file_size = -1ULL;
1055 td->mutex = fio_mutex_init(FIO_MUTEX_LOCKED);
1057 td->ts.clat_percentiles = o->clat_percentiles;
1058 td->ts.percentile_precision = o->percentile_precision;
1059 memcpy(td->ts.percentile_list, o->percentile_list, sizeof(o->percentile_list));
1061 for (i = 0; i < DDIR_RWDIR_CNT; i++) {
1062 td->ts.clat_stat[i].min_val = ULONG_MAX;
1063 td->ts.slat_stat[i].min_val = ULONG_MAX;
1064 td->ts.lat_stat[i].min_val = ULONG_MAX;
1065 td->ts.bw_stat[i].min_val = ULONG_MAX;
1067 td->ddir_seq_nr = o->ddir_seq_nr;
1069 if ((o->stonewall || o->new_group) && prev_group_jobs) {
1070 prev_group_jobs = 0;
1074 td->groupid = groupid;
1077 if (setup_random_seeds(td)) {
1078 td_verror(td, errno, "init_random_state");
1085 if (o->lat_log_file) {
1086 setup_log(&td->lat_log, o->log_avg_msec, IO_LOG_TYPE_LAT);
1087 setup_log(&td->slat_log, o->log_avg_msec, IO_LOG_TYPE_SLAT);
1088 setup_log(&td->clat_log, o->log_avg_msec, IO_LOG_TYPE_CLAT);
1091 setup_log(&td->bw_log, o->log_avg_msec, IO_LOG_TYPE_BW);
1092 if (o->iops_log_file)
1093 setup_log(&td->iops_log, o->log_avg_msec, IO_LOG_TYPE_IOPS);
1096 o->name = strdup(jobname);
1098 if (output_format == FIO_OUTPUT_NORMAL) {
1100 if (is_backend && !recursed)
1101 fio_server_send_add_job(td);
1103 if (!(td->io_ops->flags & FIO_NOIO)) {
1104 char *c1, *c2, *c3, *c4;
1105 char *c5 = NULL, *c6 = NULL;
1107 c1 = fio_uint_to_kmg(o->min_bs[DDIR_READ]);
1108 c2 = fio_uint_to_kmg(o->max_bs[DDIR_READ]);
1109 c3 = fio_uint_to_kmg(o->min_bs[DDIR_WRITE]);
1110 c4 = fio_uint_to_kmg(o->max_bs[DDIR_WRITE]);
1112 if (!o->bs_is_seq_rand) {
1113 c5 = fio_uint_to_kmg(o->min_bs[DDIR_TRIM]);
1114 c6 = fio_uint_to_kmg(o->max_bs[DDIR_TRIM]);
1117 log_info("%s: (g=%d): rw=%s, ", td->o.name,
1119 ddir_str(o->td_ddir));
1121 if (o->bs_is_seq_rand)
1122 log_info("bs(seq/rand)=%s-%s/%s-%s, ",
1125 log_info("bs=%s-%s/%s-%s/%s-%s, ",
1126 c1, c2, c3, c4, c5, c6);
1128 log_info("ioengine=%s, iodepth=%u\n",
1129 td->io_ops->name, o->iodepth);
1138 } else if (job_add_num == 1)
1143 * recurse add identical jobs, clear numjobs and stonewall options
1144 * as they don't apply to sub-jobs
1146 numjobs = o->numjobs;
1148 struct thread_data *td_new = get_new_job(0, td, 1);
1153 td_new->o.numjobs = 1;
1154 td_new->o.stonewall = 0;
1155 td_new->o.new_group = 0;
1158 td_new->files_index = 0;
1159 td_new->files_size = 0;
1160 if (td_new->files) {
1162 for_each_file(td_new, f, i) {
1167 td_new->files = NULL;
1169 if (td_new->o.filename) {
1170 free(td_new->o.filename);
1171 td_new->o.filename = NULL;
1175 if (add_job(td_new, jobname, numjobs, 1, client_type))
1186 * Parse as if 'o' was a command line
1188 void add_job_opts(const char **o, int client_type)
1190 struct thread_data *td, *td_parent;
1191 int i, in_global = 1;
1195 td_parent = td = NULL;
1197 if (!strncmp(o[i], "name", 4)) {
1200 add_job(td, jobname, 0, 0, client_type);
1202 sprintf(jobname, "%s", o[i] + 5);
1204 if (in_global && !td_parent)
1205 td_parent = get_new_job(1, &def_thread, 0);
1206 else if (!in_global && !td) {
1208 td_parent = &def_thread;
1209 td = get_new_job(0, td_parent, 0);
1212 fio_options_parse(td_parent, (char **) &o[i], 1, 0);
1214 fio_options_parse(td, (char **) &o[i], 1, 0);
1219 add_job(td, jobname, 0, 0, client_type);
1222 static int skip_this_section(const char *name)
1226 if (!nr_job_sections)
1228 if (!strncmp(name, "global", 6))
1231 for (i = 0; i < nr_job_sections; i++)
1232 if (!strcmp(job_sections[i], name))
1238 static int is_empty_or_comment(char *line)
1242 for (i = 0; i < strlen(line); i++) {
1247 if (!isspace((int) line[i]) && !iscntrl((int) line[i]))
1255 * This is our [ini] type file parser.
1257 int parse_jobs_ini(char *file, int is_buf, int stonewall_flag, int type)
1259 unsigned int global;
1260 struct thread_data *td;
1261 char *string, *name;
1264 int ret = 0, stonewall;
1267 int inside_skip = 0;
1269 int i, alloc_opts, num_opts;
1274 if (!strcmp(file, "-"))
1277 f = fopen(file, "r");
1280 perror("fopen job file");
1285 string = malloc(4096);
1288 * it's really 256 + small bit, 280 should suffice
1291 memset(name, 0, 280);
1294 opts = malloc(sizeof(char *) * alloc_opts);
1297 stonewall = stonewall_flag;
1300 * if skip_fgets is set, we already have loaded a line we
1305 p = strsep(&file, "\n");
1307 p = fgets(string, 4096, f);
1313 strip_blank_front(&p);
1316 if (is_empty_or_comment(p))
1318 if (sscanf(p, "[%255[^\n]]", name) != 1) {
1321 log_err("fio: option <%s> outside of [] job section\n",
1326 name[strlen(name) - 1] = '\0';
1328 if (skip_this_section(name)) {
1334 global = !strncmp(name, "global", 6);
1340 log_info("--name=%s ", name);
1344 td = get_new_job(global, &def_thread, 0);
1351 * Separate multiple job files by a stonewall
1353 if (!global && stonewall) {
1354 td->o.stonewall = stonewall;
1359 memset(opts, 0, alloc_opts * sizeof(char *));
1363 p = strsep(&file, "\n");
1365 p = fgets(string, 4096, f);
1369 if (is_empty_or_comment(p))
1372 strip_blank_front(&p);
1375 * new section, break out and make sure we don't
1376 * fgets() a new line at the top.
1385 if (num_opts == alloc_opts) {
1387 opts = realloc(opts,
1388 alloc_opts * sizeof(char *));
1391 opts[num_opts] = strdup(p);
1395 ret = fio_options_parse(td, opts, num_opts, dump_cmdline);
1397 ret = add_job(td, name, 0, 0, type);
1399 log_err("fio: job %s dropped\n", name);
1403 for (i = 0; i < num_opts; i++)
1412 while (i < nr_job_sections) {
1413 free(job_sections[i]);
1417 for (i = 0; i < num_opts; i++)
1423 if (!is_buf && f != stdin)
1428 static int fill_def_thread(void)
1430 memset(&def_thread, 0, sizeof(def_thread));
1432 fio_getaffinity(getpid(), &def_thread.o.cpumask);
1433 def_thread.o.timeout = def_timeout;
1434 def_thread.o.error_dump = 1;
1436 * fill default options
1438 fio_fill_default_options(&def_thread);
1442 static void usage(const char *name)
1444 printf("%s\n", fio_version_string);
1445 printf("%s [options] [job options] <job file(s)>\n", name);
1446 printf(" --debug=options\tEnable debug logging. May be one/more of:\n"
1447 "\t\t\tprocess,file,io,mem,blktrace,verify,random,parse,\n"
1448 "\t\t\tdiskutil,job,mutex,profile,time,net,rate\n");
1449 printf(" --parse-only\t\tParse options only, don't start any IO\n");
1450 printf(" --output\t\tWrite output to file\n");
1451 printf(" --runtime\t\tRuntime in seconds\n");
1452 printf(" --latency-log\t\tGenerate per-job latency logs\n");
1453 printf(" --bandwidth-log\tGenerate per-job bandwidth logs\n");
1454 printf(" --minimal\t\tMinimal (terse) output\n");
1455 printf(" --output-format=x\tOutput format (terse,json,normal)\n");
1456 printf(" --terse-version=x\tSet terse version output format to 'x'\n");
1457 printf(" --version\t\tPrint version info and exit\n");
1458 printf(" --help\t\tPrint this page\n");
1459 printf(" --cpuclock-test\tPerform test/validation of CPU clock\n");
1460 printf(" --crctest\t\tTest speed of checksum functions\n");
1461 printf(" --cmdhelp=cmd\t\tPrint command help, \"all\" for all of"
1463 printf(" --enghelp=engine\tPrint ioengine help, or list"
1464 " available ioengines\n");
1465 printf(" --enghelp=engine,cmd\tPrint help for an ioengine"
1467 printf(" --showcmd\t\tTurn a job file into command line options\n");
1468 printf(" --eta=when\t\tWhen ETA estimate should be printed\n");
1469 printf(" \t\tMay be \"always\", \"never\" or \"auto\"\n");
1470 printf(" --eta-newline=time\tForce a new line for every 'time'");
1471 printf(" period passed\n");
1472 printf(" --status-interval=t\tForce full status dump every");
1473 printf(" 't' period passed\n");
1474 printf(" --readonly\t\tTurn on safety read-only checks, preventing"
1476 printf(" --section=name\tOnly run specified section in job file\n");
1477 printf(" --alloc-size=kb\tSet smalloc pool to this size in kb"
1479 printf(" --warnings-fatal\tFio parser warnings are fatal\n");
1480 printf(" --max-jobs=nr\t\tMaximum number of threads/processes to support\n");
1481 printf(" --server=args\t\tStart a backend fio server\n");
1482 printf(" --daemonize=pidfile\tBackground fio server, write pid to file\n");
1483 printf(" --client=hostname\tTalk to remote backend fio server at hostname\n");
1484 printf(" --idle-prof=option\tReport cpu idleness on a system or percpu basis\n"
1485 "\t\t\t(option=system,percpu) or run unit work\n"
1486 "\t\t\tcalibration only (option=calibrate)\n");
1487 printf("\nFio was written by Jens Axboe <jens.axboe@oracle.com>");
1488 printf("\n Jens Axboe <jaxboe@fusionio.com>");
1489 printf("\n Jens Axboe <axboe@fb.com>\n");
1492 #ifdef FIO_INC_DEBUG
1493 struct debug_level debug_levels[] = {
1494 { .name = "process",
1495 .help = "Process creation/exit logging",
1496 .shift = FD_PROCESS,
1499 .help = "File related action logging",
1503 .help = "IO and IO engine action logging (offsets, queue, completions, etc)",
1507 .help = "Memory allocation/freeing logging",
1510 { .name = "blktrace",
1511 .help = "blktrace action logging",
1512 .shift = FD_BLKTRACE,
1515 .help = "IO verification action logging",
1519 .help = "Random generation logging",
1523 .help = "Parser logging",
1526 { .name = "diskutil",
1527 .help = "Disk utility logging actions",
1528 .shift = FD_DISKUTIL,
1531 .help = "Logging related to creating/destroying jobs",
1535 .help = "Mutex logging",
1538 { .name = "profile",
1539 .help = "Logging related to profiles",
1540 .shift = FD_PROFILE,
1543 .help = "Logging related to time keeping functions",
1547 .help = "Network logging",
1551 .help = "Rate logging",
1557 static int set_debug(const char *string)
1559 struct debug_level *dl;
1560 char *p = (char *) string;
1564 if (!strcmp(string, "?") || !strcmp(string, "help")) {
1565 log_info("fio: dumping debug options:");
1566 for (i = 0; debug_levels[i].name; i++) {
1567 dl = &debug_levels[i];
1568 log_info("%s,", dl->name);
1574 while ((opt = strsep(&p, ",")) != NULL) {
1577 if (!strncmp(opt, "all", 3)) {
1578 log_info("fio: set all debug options\n");
1583 for (i = 0; debug_levels[i].name; i++) {
1584 dl = &debug_levels[i];
1585 found = !strncmp(opt, dl->name, strlen(dl->name));
1589 if (dl->shift == FD_JOB) {
1590 opt = strchr(opt, ':');
1592 log_err("fio: missing job number\n");
1596 fio_debug_jobno = atoi(opt);
1597 log_info("fio: set debug jobno %d\n",
1600 log_info("fio: set debug option %s\n", opt);
1601 fio_debug |= (1UL << dl->shift);
1607 log_err("fio: debug mask %s not found\n", opt);
1612 static int set_debug(const char *string)
1614 log_err("fio: debug tracing not included in build\n");
1619 static void fio_options_fill_optstring(void)
1621 char *ostr = cmd_optstr;
1625 while (l_opts[i].name) {
1626 ostr[c++] = l_opts[i].val;
1627 if (l_opts[i].has_arg == required_argument)
1629 else if (l_opts[i].has_arg == optional_argument) {
1638 static int client_flag_set(char c)
1643 while (l_opts[i].name) {
1644 int val = l_opts[i].val;
1646 if (c == (val & 0xff))
1647 return (val & FIO_CLIENT_FLAG);
1655 void parse_cmd_client(void *client, char *opt)
1657 fio_client_add_cmd_option(client, opt);
1660 extern int fio_crctest(const char *);
1662 int parse_cmd_line(int argc, char *argv[], int client_type)
1664 struct thread_data *td = NULL;
1665 int c, ini_idx = 0, lidx, ret = 0, do_exit = 0, exit_val = 0;
1666 char *ostr = cmd_optstr;
1667 void *pid_file = NULL;
1668 void *cur_client = NULL;
1672 * Reset optind handling, since we may call this multiple times
1677 while ((c = getopt_long_only(argc, argv, ostr, l_opts, &lidx)) != -1) {
1680 if ((c & FIO_CLIENT_FLAG) || client_flag_set(c)) {
1681 parse_cmd_client(cur_client, argv[optind - 1]);
1682 c &= ~FIO_CLIENT_FLAG;
1687 smalloc_pool_size = atoi(optarg);
1690 def_timeout = atoi(optarg);
1699 f_out = fopen(optarg, "w+");
1701 perror("fopen output");
1707 output_format = FIO_OUTPUT_TERSE;
1711 log_err("fio: missing --output-format argument\n");
1716 if (!strcmp(optarg, "minimal") ||
1717 !strcmp(optarg, "terse") ||
1718 !strcmp(optarg, "csv"))
1719 output_format = FIO_OUTPUT_TERSE;
1720 else if (!strcmp(optarg, "json"))
1721 output_format = FIO_OUTPUT_JSON;
1723 output_format = FIO_OUTPUT_NORMAL;
1726 append_terse_output = 1;
1736 fio_show_option_help(optarg);
1742 fio_show_ioengine_help(optarg);
1754 log_info("%s\n", fio_version_string);
1759 terse_version = atoi(optarg);
1760 if (!(terse_version == 2 || terse_version == 3 ||
1761 terse_version == 4)) {
1762 log_err("fio: bad terse version format\n");
1768 if (!strcmp("always", optarg))
1769 eta_print = FIO_ETA_ALWAYS;
1770 else if (!strcmp("never", optarg))
1771 eta_print = FIO_ETA_NEVER;
1776 if (str_to_decimal(optarg, &t, 0, NULL, 1)) {
1777 log_err("fio: failed parsing eta time %s\n", optarg);
1785 if (set_debug(optarg))
1794 if (!strcmp(optarg, "global")) {
1795 log_err("fio: can't use global as only "
1801 new_size = (nr_job_sections + 1) * sizeof(char *);
1802 job_sections = realloc(job_sections, new_size);
1803 job_sections[nr_job_sections] = strdup(optarg);
1808 exec_profile = strdup(optarg);
1810 case FIO_GETOPT_JOB: {
1811 const char *opt = l_opts[lidx].name;
1814 if (!strncmp(opt, "name", 4) && td) {
1815 ret = add_job(td, td->o.name ?: "fio", 0, 0, client_type);
1821 int is_section = !strncmp(opt, "name", 4);
1824 if (!is_section || !strncmp(val, "global", 6))
1827 if (is_section && skip_this_section(val))
1830 td = get_new_job(global, &def_thread, 1);
1831 if (!td || ioengine_load(td))
1833 fio_options_set_ioengine_opts(l_opts, td);
1836 if ((!val || !strlen(val)) &&
1837 l_opts[lidx].has_arg == required_argument) {
1838 log_err("fio: option %s requires an argument\n", opt);
1841 ret = fio_cmd_option_parse(td, opt, val);
1851 if (!ret && !strcmp(opt, "ioengine")) {
1853 if (ioengine_load(td))
1855 fio_options_set_ioengine_opts(l_opts, td);
1859 case FIO_GETOPT_IOENGINE: {
1860 const char *opt = l_opts[lidx].name;
1862 ret = fio_cmd_ioengine_option_parse(td, opt, val);
1869 max_jobs = atoi(optarg);
1870 if (!max_jobs || max_jobs > REAL_MAX_JOBS) {
1871 log_err("fio: invalid max jobs: %d\n", max_jobs);
1878 log_err("fio: can't be both client and server\n");
1884 fio_server_set_arg(optarg);
1889 pid_file = strdup(optarg);
1892 if ((ret = fio_idle_prof_parse_opt(optarg))) {
1893 /* exit on error and calibration only */
1901 log_err("fio: can't be both client and server\n");
1906 if (fio_client_add(&fio_client_ops, optarg, &cur_client)) {
1907 log_err("fio: failed adding client %s\n", optarg);
1913 * If the next argument exists and isn't an option,
1914 * assume it's a job file for this client only.
1916 while (optind < argc) {
1917 if (!strncmp(argv[optind], "--", 2) ||
1918 !strncmp(argv[optind], "-", 1))
1921 fio_client_add_ini_file(cur_client, argv[optind]);
1927 exit_val = fio_monotonic_clocktest();
1931 exit_val = fio_crctest(optarg);
1936 if (check_str_time(optarg, &val, 1)) {
1937 log_err("fio: failed parsing time %s\n", optarg);
1942 status_interval = val * 1000;
1946 log_err("%s: unrecognized option '%s'\n", argv[0],
1957 if (do_exit && !(is_backend || nr_clients))
1960 if (nr_clients && fio_clients_connect()) {
1966 if (is_backend && backend)
1967 return fio_start_server(pid_file);
1971 ret = add_job(td, td->o.name ?: "fio", 0, 0, client_type);
1974 while (!ret && optind < argc) {
1976 ini_file = realloc(ini_file, ini_idx * sizeof(char *));
1977 ini_file[ini_idx - 1] = strdup(argv[optind]);
1984 int fio_init_options(void)
1989 fio_options_fill_optstring();
1990 fio_options_dup_and_init(l_opts);
1994 if (fill_def_thread())
2000 extern int fio_check_options(struct thread_options *);
2002 int parse_options(int argc, char *argv[])
2004 const int type = FIO_CLIENT_TYPE_CLI;
2007 if (fio_init_options())
2009 if (fio_test_cconv(&def_thread.o))
2010 log_err("fio: failed internal cconv test\n");
2012 job_files = parse_cmd_line(argc, argv, type);
2014 if (job_files > 0) {
2015 for (i = 0; i < job_files; i++) {
2016 if (fill_def_thread())
2019 if (fio_clients_send_ini(ini_file[i]))
2022 } else if (!is_backend) {
2023 if (parse_jobs_ini(ini_file[i], 0, i, type))
2028 } else if (nr_clients) {
2029 if (fill_def_thread())
2031 if (fio_clients_send_ini(NULL))
2036 fio_options_free(&def_thread);
2037 filesetup_mem_free();
2039 if (!thread_number) {
2044 if (is_backend || nr_clients)
2049 log_err("No jobs(s) defined\n\n");
2059 if (def_thread.o.gtod_offload) {
2061 fio_gtod_offload = 1;
2062 fio_gtod_cpu = def_thread.o.gtod_cpu;
2065 if (output_format == FIO_OUTPUT_NORMAL)
2066 log_info("%s\n", fio_version_string);
2071 void options_default_fill(struct thread_options *o)
2073 memcpy(o, &def_thread.o, sizeof(*o));