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 static int write_lat_log;
69 static int prev_group_jobs;
71 unsigned long fio_debug = 0;
72 unsigned int fio_debug_jobno = -1;
73 unsigned int *fio_debug_jobp = NULL;
75 static char cmd_optstr[256];
78 #define FIO_CLIENT_FLAG (1 << 16)
81 * Command line options. These will contain the above, plus a few
82 * extra that only pertain to fio itself and not jobs.
84 static struct option l_opts[FIO_NR_OPTIONS] = {
86 .name = (char *) "output",
87 .has_arg = required_argument,
88 .val = 'o' | FIO_CLIENT_FLAG,
91 .name = (char *) "timeout",
92 .has_arg = required_argument,
93 .val = 't' | FIO_CLIENT_FLAG,
96 .name = (char *) "latency-log",
97 .has_arg = required_argument,
98 .val = 'l' | FIO_CLIENT_FLAG,
101 .name = (char *) "bandwidth-log",
102 .has_arg = required_argument,
103 .val = 'b' | FIO_CLIENT_FLAG,
106 .name = (char *) "minimal",
107 .has_arg = no_argument,
108 .val = 'm' | FIO_CLIENT_FLAG,
111 .name = (char *) "output-format",
112 .has_arg = optional_argument,
113 .val = 'F' | FIO_CLIENT_FLAG,
116 .name = (char *) "append-terse",
117 .has_arg = optional_argument,
121 .name = (char *) "version",
122 .has_arg = no_argument,
123 .val = 'v' | FIO_CLIENT_FLAG,
126 .name = (char *) "help",
127 .has_arg = no_argument,
128 .val = 'h' | FIO_CLIENT_FLAG,
131 .name = (char *) "cmdhelp",
132 .has_arg = optional_argument,
133 .val = 'c' | FIO_CLIENT_FLAG,
136 .name = (char *) "enghelp",
137 .has_arg = optional_argument,
138 .val = 'i' | FIO_CLIENT_FLAG,
141 .name = (char *) "showcmd",
142 .has_arg = no_argument,
143 .val = 's' | FIO_CLIENT_FLAG,
146 .name = (char *) "readonly",
147 .has_arg = no_argument,
148 .val = 'r' | FIO_CLIENT_FLAG,
151 .name = (char *) "eta",
152 .has_arg = required_argument,
153 .val = 'e' | FIO_CLIENT_FLAG,
156 .name = (char *) "eta-newline",
157 .has_arg = required_argument,
158 .val = 'E' | FIO_CLIENT_FLAG,
161 .name = (char *) "debug",
162 .has_arg = required_argument,
163 .val = 'd' | FIO_CLIENT_FLAG,
166 .name = (char *) "parse-only",
167 .has_arg = no_argument,
168 .val = 'P' | FIO_CLIENT_FLAG,
171 .name = (char *) "section",
172 .has_arg = required_argument,
173 .val = 'x' | FIO_CLIENT_FLAG,
176 .name = (char *) "alloc-size",
177 .has_arg = required_argument,
178 .val = 'a' | FIO_CLIENT_FLAG,
181 .name = (char *) "profile",
182 .has_arg = required_argument,
183 .val = 'p' | FIO_CLIENT_FLAG,
186 .name = (char *) "warnings-fatal",
187 .has_arg = no_argument,
188 .val = 'w' | FIO_CLIENT_FLAG,
191 .name = (char *) "max-jobs",
192 .has_arg = required_argument,
193 .val = 'j' | FIO_CLIENT_FLAG,
196 .name = (char *) "terse-version",
197 .has_arg = required_argument,
198 .val = 'V' | FIO_CLIENT_FLAG,
201 .name = (char *) "server",
202 .has_arg = optional_argument,
205 { .name = (char *) "daemonize",
206 .has_arg = required_argument,
210 .name = (char *) "client",
211 .has_arg = required_argument,
215 .name = (char *) "cpuclock-test",
216 .has_arg = no_argument,
220 .name = (char *) "crctest",
221 .has_arg = optional_argument,
225 .name = (char *) "idle-prof",
226 .has_arg = required_argument,
230 .name = (char *) "status-interval",
231 .has_arg = required_argument,
239 void free_threads_shm(void)
243 #ifndef CONFIG_NO_SHM
244 struct shmid_ds sbuf;
248 shmctl(shm_id, IPC_RMID, &sbuf);
257 static void free_shm(void)
262 fio_debug_jobp = NULL;
266 options_free(fio_options, &def_thread);
272 * The thread area is shared between the main process and the job
273 * threads/processes. So setup a shared memory segment that will hold
274 * all the job info. We use the end of the region for keeping track of
275 * open files across jobs, for file sharing.
277 static int setup_thread_area(void)
285 * 1024 is too much on some machines, scale max_jobs if
286 * we get a failure that looks like too large a shm segment
289 size_t size = max_jobs * sizeof(struct thread_data);
291 size += file_hash_size;
292 size += sizeof(unsigned int);
294 #ifndef CONFIG_NO_SHM
295 shm_id = shmget(0, size, IPC_CREAT | 0600);
298 if (errno != EINVAL && errno != ENOMEM && errno != ENOSPC) {
303 threads = malloc(size);
311 #ifndef CONFIG_NO_SHM
315 threads = shmat(shm_id, NULL, 0);
316 if (threads == (void *) -1) {
322 memset(threads, 0, max_jobs * sizeof(struct thread_data));
323 hash = (void *) threads + max_jobs * sizeof(struct thread_data);
324 fio_debug_jobp = (void *) hash + file_hash_size;
325 *fio_debug_jobp = -1;
326 file_hash_init(hash);
333 static void set_cmd_options(struct thread_data *td)
335 struct thread_options *o = &td->o;
338 o->timeout = def_timeout;
342 * Return a free job structure.
344 static struct thread_data *get_new_job(int global, struct thread_data *parent,
345 int preserve_eo, const char *jobname)
347 struct thread_data *td;
350 set_cmd_options(&def_thread);
353 if (setup_thread_area()) {
354 log_err("error: failed to setup shm segment\n");
357 if (thread_number >= max_jobs) {
358 log_err("error: maximum number of jobs (%d) reached.\n",
363 td = &threads[thread_number++];
370 td->o.uid = td->o.gid = -1U;
372 dup_files(td, parent);
373 fio_options_mem_dupe(td);
375 profile_add_hooks(td);
377 td->thread_number = thread_number;
380 td->o.name = strdup(jobname);
382 if (!parent->o.group_reporting)
389 static void put_job(struct thread_data *td)
391 if (td == &def_thread)
398 log_info("fio: %s\n", td->verror);
400 fio_options_free(td);
407 memset(&threads[td->thread_number - 1], 0, sizeof(*td));
411 static int __setup_rate(struct thread_data *td, enum fio_ddir ddir)
413 unsigned int bs = td->o.min_bs[ddir];
415 assert(ddir_rw(ddir));
417 if (td->o.rate[ddir])
418 td->rate_bps[ddir] = td->o.rate[ddir];
420 td->rate_bps[ddir] = td->o.rate_iops[ddir] * bs;
422 if (!td->rate_bps[ddir]) {
423 log_err("rate lower than supported\n");
427 td->rate_pending_usleep[ddir] = 0;
431 static int setup_rate(struct thread_data *td)
435 if (td->o.rate[DDIR_READ] || td->o.rate_iops[DDIR_READ])
436 ret = __setup_rate(td, DDIR_READ);
437 if (td->o.rate[DDIR_WRITE] || td->o.rate_iops[DDIR_WRITE])
438 ret |= __setup_rate(td, DDIR_WRITE);
439 if (td->o.rate[DDIR_TRIM] || td->o.rate_iops[DDIR_TRIM])
440 ret |= __setup_rate(td, DDIR_TRIM);
445 static int fixed_block_size(struct thread_options *o)
447 return o->min_bs[DDIR_READ] == o->max_bs[DDIR_READ] &&
448 o->min_bs[DDIR_WRITE] == o->max_bs[DDIR_WRITE] &&
449 o->min_bs[DDIR_TRIM] == o->max_bs[DDIR_TRIM] &&
450 o->min_bs[DDIR_READ] == o->min_bs[DDIR_WRITE] &&
451 o->min_bs[DDIR_READ] == o->min_bs[DDIR_TRIM];
455 static unsigned long long get_rand_start_delay(struct thread_data *td)
457 unsigned long long delayrange;
460 delayrange = td->o.start_delay_high - td->o.start_delay;
462 if (td->o.use_os_rand) {
463 r = os_random_long(&td->delay_state);
464 delayrange = (unsigned long long) ((double) delayrange * (r / (OS_RAND_MAX + 1.0)));
466 r = __rand(&td->__delay_state);
467 delayrange = (unsigned long long) ((double) delayrange * (r / (FRAND_MAX + 1.0)));
470 delayrange += td->o.start_delay;
475 * Lazy way of fixing up options that depend on each other. We could also
476 * define option callback handlers, but this is easier.
478 static int fixup_options(struct thread_data *td)
480 struct thread_options *o = &td->o;
483 #ifndef FIO_HAVE_PSHARED_MUTEX
484 if (!o->use_thread) {
485 log_info("fio: this platform does not support process shared"
486 " mutexes, forcing use of threads. Use the 'thread'"
487 " option to get rid of this warning.\n");
489 ret = warnings_fatal;
493 if (o->write_iolog_file && o->read_iolog_file) {
494 log_err("fio: read iolog overrides write_iolog\n");
495 free(o->write_iolog_file);
496 o->write_iolog_file = NULL;
497 ret = warnings_fatal;
501 * only really works with 1 file
503 if (o->zone_size && o->open_files > 1)
507 * If zone_range isn't specified, backward compatibility dictates it
508 * should be made equal to zone_size.
510 if (o->zone_size && !o->zone_range)
511 o->zone_range = o->zone_size;
514 * Reads can do overwrites, we always need to pre-create the file
516 if (td_read(td) || td_rw(td))
519 if (!o->min_bs[DDIR_READ])
520 o->min_bs[DDIR_READ] = o->bs[DDIR_READ];
521 if (!o->max_bs[DDIR_READ])
522 o->max_bs[DDIR_READ] = o->bs[DDIR_READ];
523 if (!o->min_bs[DDIR_WRITE])
524 o->min_bs[DDIR_WRITE] = o->bs[DDIR_WRITE];
525 if (!o->max_bs[DDIR_WRITE])
526 o->max_bs[DDIR_WRITE] = o->bs[DDIR_WRITE];
527 if (!o->min_bs[DDIR_TRIM])
528 o->min_bs[DDIR_TRIM] = o->bs[DDIR_TRIM];
529 if (!o->max_bs[DDIR_TRIM])
530 o->max_bs[DDIR_TRIM] = o->bs[DDIR_TRIM];
533 o->rw_min_bs = min(o->min_bs[DDIR_READ], o->min_bs[DDIR_WRITE]);
534 o->rw_min_bs = min(o->min_bs[DDIR_TRIM], o->rw_min_bs);
537 * For random IO, allow blockalign offset other than min_bs.
539 if (!o->ba[DDIR_READ] || !td_random(td))
540 o->ba[DDIR_READ] = o->min_bs[DDIR_READ];
541 if (!o->ba[DDIR_WRITE] || !td_random(td))
542 o->ba[DDIR_WRITE] = o->min_bs[DDIR_WRITE];
543 if (!o->ba[DDIR_TRIM] || !td_random(td))
544 o->ba[DDIR_TRIM] = o->min_bs[DDIR_TRIM];
546 if ((o->ba[DDIR_READ] != o->min_bs[DDIR_READ] ||
547 o->ba[DDIR_WRITE] != o->min_bs[DDIR_WRITE] ||
548 o->ba[DDIR_TRIM] != o->min_bs[DDIR_TRIM]) &&
550 log_err("fio: Any use of blockalign= turns off randommap\n");
552 ret = warnings_fatal;
555 if (!o->file_size_high)
556 o->file_size_high = o->file_size_low;
558 if (o->start_delay_high)
559 o->start_delay = get_rand_start_delay(td);
561 if (o->norandommap && o->verify != VERIFY_NONE
562 && !fixed_block_size(o)) {
563 log_err("fio: norandommap given for variable block sizes, "
564 "verify disabled\n");
565 o->verify = VERIFY_NONE;
566 ret = warnings_fatal;
568 if (o->bs_unaligned && (o->odirect || td->io_ops->flags & FIO_RAWIO))
569 log_err("fio: bs_unaligned may not work with raw io\n");
572 * thinktime_spin must be less than thinktime
574 if (o->thinktime_spin > o->thinktime)
575 o->thinktime_spin = o->thinktime;
578 * The low water mark cannot be bigger than the iodepth
580 if (o->iodepth_low > o->iodepth || !o->iodepth_low)
581 o->iodepth_low = o->iodepth;
584 * If batch number isn't set, default to the same as iodepth
586 if (o->iodepth_batch > o->iodepth || !o->iodepth_batch)
587 o->iodepth_batch = o->iodepth;
589 if (o->nr_files > td->files_index)
590 o->nr_files = td->files_index;
592 if (o->open_files > o->nr_files || !o->open_files)
593 o->open_files = o->nr_files;
595 if (((o->rate[DDIR_READ] + o->rate[DDIR_WRITE] + o->rate[DDIR_TRIM]) &&
596 (o->rate_iops[DDIR_READ] + o->rate_iops[DDIR_WRITE] + o->rate_iops[DDIR_TRIM])) ||
597 ((o->ratemin[DDIR_READ] + o->ratemin[DDIR_WRITE] + o->ratemin[DDIR_TRIM]) &&
598 (o->rate_iops_min[DDIR_READ] + o->rate_iops_min[DDIR_WRITE] + o->rate_iops_min[DDIR_TRIM]))) {
599 log_err("fio: rate and rate_iops are mutually exclusive\n");
602 if ((o->rate[DDIR_READ] < o->ratemin[DDIR_READ]) ||
603 (o->rate[DDIR_WRITE] < o->ratemin[DDIR_WRITE]) ||
604 (o->rate[DDIR_TRIM] < o->ratemin[DDIR_TRIM]) ||
605 (o->rate_iops[DDIR_READ] < o->rate_iops_min[DDIR_READ]) ||
606 (o->rate_iops[DDIR_WRITE] < o->rate_iops_min[DDIR_WRITE]) ||
607 (o->rate_iops[DDIR_TRIM] < o->rate_iops_min[DDIR_TRIM])) {
608 log_err("fio: minimum rate exceeds rate\n");
612 if (!o->timeout && o->time_based) {
613 log_err("fio: time_based requires a runtime/timeout setting\n");
615 ret = warnings_fatal;
618 if (o->fill_device && !o->size)
621 if (o->verify != VERIFY_NONE) {
622 if (td_write(td) && o->do_verify && o->numjobs > 1) {
623 log_info("Multiple writers may overwrite blocks that "
624 "belong to other jobs. This can cause "
625 "verification failures.\n");
626 ret = warnings_fatal;
629 o->refill_buffers = 1;
630 if (o->max_bs[DDIR_WRITE] != o->min_bs[DDIR_WRITE] &&
632 o->verify_interval = o->min_bs[DDIR_WRITE];
636 o->invalidate_cache = 0;
637 if (td->io_ops->flags & FIO_PIPEIO) {
638 log_info("fio: cannot pre-read files with an IO engine"
639 " that isn't seekable. Pre-read disabled.\n");
640 ret = warnings_fatal;
645 if (td->io_ops->flags & FIO_BIT_BASED)
651 #ifndef CONFIG_FDATASYNC
652 if (o->fdatasync_blocks) {
653 log_info("fio: this platform does not support fdatasync()"
654 " falling back to using fsync(). Use the 'fsync'"
655 " option instead of 'fdatasync' to get rid of"
657 o->fsync_blocks = o->fdatasync_blocks;
658 o->fdatasync_blocks = 0;
659 ret = warnings_fatal;
665 * Windows doesn't support O_DIRECT or O_SYNC with the _open interface,
666 * so fail if we're passed those flags
668 if ((td->io_ops->flags & FIO_SYNCIO) && (td->o.odirect || td->o.sync_io)) {
669 log_err("fio: Windows does not support direct or non-buffered io with"
670 " the synchronous ioengines. Use the 'windowsaio' ioengine"
671 " with 'direct=1' and 'iodepth=1' instead.\n");
677 * For fully compressible data, just zero them at init time.
678 * It's faster than repeatedly filling it.
680 if (td->o.compress_percentage == 100) {
681 td->o.zero_buffers = 1;
682 td->o.compress_percentage = 0;
686 * Using a non-uniform random distribution excludes usage of
689 if (td->o.random_distribution != FIO_RAND_DIST_RANDOM)
690 td->o.norandommap = 1;
693 * If size is set but less than the min block size, complain
695 if (o->size && o->size < td_min_bs(td)) {
696 log_err("fio: size too small, must be larger than the IO size: %llu\n", (unsigned long long) o->size);
701 * O_ATOMIC implies O_DIRECT
707 * If randseed is set, that overrides randrepeat
710 td->o.rand_repeatable = 0;
712 if ((td->io_ops->flags & FIO_NOEXTEND) && td->o.file_append) {
713 log_err("fio: can't append/extent with IO engine %s\n", td->io_ops->name);
721 * This function leaks the buffer
723 char *fio_uint_to_kmg(unsigned int val)
725 char *buf = malloc(32);
726 char post[] = { 0, 'K', 'M', 'G', 'P', 'E', 0 };
737 snprintf(buf, 32, "%u%c", val, *p);
741 /* External engines are specified by "external:name.o") */
742 static const char *get_engine_name(const char *str)
744 char *p = strstr(str, ":");
750 strip_blank_front(&p);
755 static int exists_and_not_file(const char *filename)
759 if (lstat(filename, &sb) == -1)
762 /* \\.\ is the device namespace in Windows, where every file
763 * is a device node */
764 if (S_ISREG(sb.st_mode) && strncmp(filename, "\\\\.\\", 4) != 0)
770 static void td_fill_rand_seeds_os(struct thread_data *td)
772 os_random_seed(td->rand_seeds[FIO_RAND_BS_OFF], &td->bsrange_state);
773 os_random_seed(td->rand_seeds[FIO_RAND_VER_OFF], &td->verify_state);
774 os_random_seed(td->rand_seeds[FIO_RAND_MIX_OFF], &td->rwmix_state);
776 if (td->o.file_service_type == FIO_FSERVICE_RANDOM)
777 os_random_seed(td->rand_seeds[FIO_RAND_FILE_OFF], &td->next_file_state);
779 os_random_seed(td->rand_seeds[FIO_RAND_FILE_SIZE_OFF], &td->file_size_state);
780 os_random_seed(td->rand_seeds[FIO_RAND_TRIM_OFF], &td->trim_state);
781 os_random_seed(td->rand_seeds[FIO_RAND_START_DELAY], &td->delay_state);
786 if (td->o.rand_repeatable)
787 td->rand_seeds[FIO_RAND_BLOCK_OFF] = FIO_RANDSEED * td->thread_number;
789 os_random_seed(td->rand_seeds[FIO_RAND_BLOCK_OFF], &td->random_state);
791 os_random_seed(td->rand_seeds[FIO_RAND_SEQ_RAND_READ_OFF], &td->seq_rand_state[DDIR_READ]);
792 os_random_seed(td->rand_seeds[FIO_RAND_SEQ_RAND_WRITE_OFF], &td->seq_rand_state[DDIR_WRITE]);
793 os_random_seed(td->rand_seeds[FIO_RAND_SEQ_RAND_TRIM_OFF], &td->seq_rand_state[DDIR_TRIM]);
796 static void td_fill_rand_seeds_internal(struct thread_data *td)
798 init_rand_seed(&td->__bsrange_state, td->rand_seeds[FIO_RAND_BS_OFF]);
799 init_rand_seed(&td->__verify_state, td->rand_seeds[FIO_RAND_VER_OFF]);
800 init_rand_seed(&td->__rwmix_state, td->rand_seeds[FIO_RAND_MIX_OFF]);
802 if (td->o.file_service_type == FIO_FSERVICE_RANDOM)
803 init_rand_seed(&td->__next_file_state, td->rand_seeds[FIO_RAND_FILE_OFF]);
805 init_rand_seed(&td->__file_size_state, td->rand_seeds[FIO_RAND_FILE_SIZE_OFF]);
806 init_rand_seed(&td->__trim_state, td->rand_seeds[FIO_RAND_TRIM_OFF]);
807 init_rand_seed(&td->__delay_state, td->rand_seeds[FIO_RAND_START_DELAY]);
812 if (td->o.rand_repeatable)
813 td->rand_seeds[FIO_RAND_BLOCK_OFF] = FIO_RANDSEED * td->thread_number;
815 init_rand_seed(&td->__random_state, td->rand_seeds[FIO_RAND_BLOCK_OFF]);
816 init_rand_seed(&td->__seq_rand_state[DDIR_READ], td->rand_seeds[FIO_RAND_SEQ_RAND_READ_OFF]);
817 init_rand_seed(&td->__seq_rand_state[DDIR_WRITE], td->rand_seeds[FIO_RAND_SEQ_RAND_WRITE_OFF]);
818 init_rand_seed(&td->__seq_rand_state[DDIR_TRIM], td->rand_seeds[FIO_RAND_SEQ_RAND_TRIM_OFF]);
821 void td_fill_rand_seeds(struct thread_data *td)
823 if (td->o.allrand_repeatable) {
824 for (int i = 0; i < FIO_RAND_NR_OFFS; i++)
825 td->rand_seeds[i] = FIO_RANDSEED * td->thread_number
829 if (td->o.use_os_rand)
830 td_fill_rand_seeds_os(td);
832 td_fill_rand_seeds_internal(td);
834 init_rand_seed(&td->buf_state, td->rand_seeds[FIO_RAND_BUF_OFF]);
838 * Initializes the ioengine configured for a job, if it has not been done so
841 int ioengine_load(struct thread_data *td)
846 * Engine has already been loaded.
850 if (!td->o.ioengine) {
851 log_err("fio: internal fault, no IO engine specified\n");
855 engine = get_engine_name(td->o.ioengine);
856 td->io_ops = load_ioengine(td, engine);
858 log_err("fio: failed to load engine %s\n", engine);
862 if (td->io_ops->option_struct_size && td->io_ops->options) {
864 * In cases where td->eo is set, clone it for a child thread.
865 * This requires that the parent thread has the same ioengine,
866 * but that requirement must be enforced by the code which
869 void *origeo = td->eo;
871 * Otherwise use the default thread options.
873 if (!origeo && td != &def_thread && def_thread.eo &&
874 def_thread.io_ops->options == td->io_ops->options)
875 origeo = def_thread.eo;
877 options_init(td->io_ops->options);
878 td->eo = malloc(td->io_ops->option_struct_size);
880 * Use the default thread as an option template if this uses the
881 * same options structure and there are non-default options
885 memcpy(td->eo, origeo, td->io_ops->option_struct_size);
886 options_mem_dupe(td->eo, td->io_ops->options);
888 memset(td->eo, 0, td->io_ops->option_struct_size);
889 fill_default_options(td->eo, td->io_ops->options);
891 *(struct thread_data **)td->eo = td;
897 static void init_flags(struct thread_data *td)
899 struct thread_options *o = &td->o;
901 if (o->verify_backlog)
902 td->flags |= TD_F_VER_BACKLOG;
904 td->flags |= TD_F_TRIM_BACKLOG;
905 if (o->read_iolog_file)
906 td->flags |= TD_F_READ_IOLOG;
907 if (o->refill_buffers)
908 td->flags |= TD_F_REFILL_BUFFERS;
909 if (o->scramble_buffers)
910 td->flags |= TD_F_SCRAMBLE_BUFFERS;
911 if (o->verify != VERIFY_NONE)
912 td->flags |= TD_F_VER_NONE;
915 static int setup_random_seeds(struct thread_data *td)
920 if (!td->o.rand_repeatable && !td->o.rand_seed)
921 return init_random_state(td, td->rand_seeds, sizeof(td->rand_seeds));
923 if (!td->o.rand_seed)
926 seed = td->o.rand_seed;
928 for (i = 0; i < 4; i++)
929 seed *= 0x9e370001UL;
931 for (i = 0; i < FIO_RAND_NR_OFFS; i++) {
932 td->rand_seeds[i] = seed;
933 seed *= 0x9e370001UL;
936 td_fill_rand_seeds(td);
947 static struct fpre_keyword {
951 } fpre_keywords[] = {
952 { .keyword = "$jobname", .key = FPRE_JOBNAME, },
953 { .keyword = "$jobnum", .key = FPRE_JOBNUM, },
954 { .keyword = "$filenum", .key = FPRE_FILENUM, },
955 { .keyword = NULL, },
958 static char *make_filename(char *buf, size_t buf_size,struct thread_options *o,
959 const char *jobname, int jobnum, int filenum)
961 struct fpre_keyword *f;
963 size_t dst_left = PATH_MAX - 1;
965 if (!o->filename_format || !strlen(o->filename_format)) {
966 sprintf(buf, "%s.%d.%d", jobname, jobnum, filenum);
970 for (f = &fpre_keywords[0]; f->keyword; f++)
971 f->strlen = strlen(f->keyword);
973 buf[buf_size - 1] = '\0';
974 strncpy(buf, o->filename_format, buf_size - 1);
976 memset(copy, 0, sizeof(copy));
977 for (f = &fpre_keywords[0]; f->keyword; f++) {
979 size_t pre_len, post_start = 0;
980 char *str, *dst = copy;
982 str = strcasestr(buf, f->keyword);
987 if (strlen(str) != f->strlen)
988 post_start = pre_len + f->strlen;
991 strncpy(dst, buf, pre_len);
1000 ret = snprintf(dst, dst_left, "%s", jobname);
1010 ret = snprintf(dst, dst_left, "%d", jobnum);
1017 case FPRE_FILENUM: {
1020 ret = snprintf(dst, dst_left, "%d", filenum);
1033 strncpy(dst, buf + post_start, dst_left);
1035 strncpy(buf, copy, buf_size - 1);
1042 int parse_dryrun(void)
1044 return dump_cmdline || parse_only;
1048 * Adds a job to the list of things todo. Sanitizes the various options
1049 * to make sure we don't have conflicts, and initializes various
1052 static int add_job(struct thread_data *td, const char *jobname, int job_add_num,
1053 int recursed, int client_type)
1056 char fname[PATH_MAX];
1057 int numjobs, file_alloced;
1058 struct thread_options *o = &td->o;
1061 * the def_thread is just for options, it's not a real job
1063 if (td == &def_thread)
1069 * if we are just dumping the output command line, don't add the job
1071 if (parse_dryrun()) {
1076 td->client_type = client_type;
1078 if (profile_td_init(td))
1081 if (ioengine_load(td))
1085 td->io_ops->flags |= FIO_RAWIO;
1088 if (!o->filename && !td->files_index && !o->read_iolog_file) {
1091 if (o->nr_files == 1 && exists_and_not_file(jobname))
1092 add_file(td, jobname, job_add_num, 0);
1094 for (i = 0; i < o->nr_files; i++)
1095 add_file(td, make_filename(fname, sizeof(fname), o, jobname, job_add_num, i), job_add_num, 0);
1099 if (fixup_options(td))
1105 * IO engines only need this for option callbacks, and the address may
1106 * change in subprocesses.
1109 *(struct thread_data **)td->eo = NULL;
1111 if (td->io_ops->flags & FIO_DISKLESSIO) {
1114 for_each_file(td, f, i)
1115 f->real_file_size = -1ULL;
1118 td->mutex = fio_mutex_init(FIO_MUTEX_LOCKED);
1120 td->ts.clat_percentiles = o->clat_percentiles;
1121 td->ts.percentile_precision = o->percentile_precision;
1122 memcpy(td->ts.percentile_list, o->percentile_list, sizeof(o->percentile_list));
1124 for (i = 0; i < DDIR_RWDIR_CNT; i++) {
1125 td->ts.clat_stat[i].min_val = ULONG_MAX;
1126 td->ts.slat_stat[i].min_val = ULONG_MAX;
1127 td->ts.lat_stat[i].min_val = ULONG_MAX;
1128 td->ts.bw_stat[i].min_val = ULONG_MAX;
1130 td->ddir_seq_nr = o->ddir_seq_nr;
1132 if ((o->stonewall || o->new_group) && prev_group_jobs) {
1133 prev_group_jobs = 0;
1137 td->groupid = groupid;
1140 if (setup_random_seeds(td)) {
1141 td_verror(td, errno, "init_random_state");
1148 if (o->lat_log_file || write_lat_log) {
1149 setup_log(&td->lat_log, o->log_avg_msec, IO_LOG_TYPE_LAT);
1150 setup_log(&td->slat_log, o->log_avg_msec, IO_LOG_TYPE_SLAT);
1151 setup_log(&td->clat_log, o->log_avg_msec, IO_LOG_TYPE_CLAT);
1153 if (o->bw_log_file || write_bw_log)
1154 setup_log(&td->bw_log, o->log_avg_msec, IO_LOG_TYPE_BW);
1155 if (o->iops_log_file)
1156 setup_log(&td->iops_log, o->log_avg_msec, IO_LOG_TYPE_IOPS);
1159 o->name = strdup(jobname);
1161 if (output_format == FIO_OUTPUT_NORMAL) {
1163 if (is_backend && !recursed)
1164 fio_server_send_add_job(td);
1166 if (!(td->io_ops->flags & FIO_NOIO)) {
1167 char *c1, *c2, *c3, *c4;
1168 char *c5 = NULL, *c6 = NULL;
1170 c1 = fio_uint_to_kmg(o->min_bs[DDIR_READ]);
1171 c2 = fio_uint_to_kmg(o->max_bs[DDIR_READ]);
1172 c3 = fio_uint_to_kmg(o->min_bs[DDIR_WRITE]);
1173 c4 = fio_uint_to_kmg(o->max_bs[DDIR_WRITE]);
1175 if (!o->bs_is_seq_rand) {
1176 c5 = fio_uint_to_kmg(o->min_bs[DDIR_TRIM]);
1177 c6 = fio_uint_to_kmg(o->max_bs[DDIR_TRIM]);
1180 log_info("%s: (g=%d): rw=%s, ", td->o.name,
1182 ddir_str(o->td_ddir));
1184 if (o->bs_is_seq_rand)
1185 log_info("bs(seq/rand)=%s-%s/%s-%s, ",
1188 log_info("bs=%s-%s/%s-%s/%s-%s, ",
1189 c1, c2, c3, c4, c5, c6);
1191 log_info("ioengine=%s, iodepth=%u\n",
1192 td->io_ops->name, o->iodepth);
1201 } else if (job_add_num == 1)
1206 * recurse add identical jobs, clear numjobs and stonewall options
1207 * as they don't apply to sub-jobs
1209 numjobs = o->numjobs;
1211 struct thread_data *td_new = get_new_job(0, td, 1, jobname);
1216 td_new->o.numjobs = 1;
1217 td_new->o.stonewall = 0;
1218 td_new->o.new_group = 0;
1221 if (td_new->files) {
1223 for_each_file(td_new, f, i) {
1225 sfree(f->file_name);
1228 free(td_new->files);
1229 td_new->files = NULL;
1231 td_new->files_index = 0;
1232 td_new->files_size = 0;
1233 if (td_new->o.filename) {
1234 free(td_new->o.filename);
1235 td_new->o.filename = NULL;
1239 if (add_job(td_new, jobname, numjobs, 1, client_type))
1250 * Parse as if 'o' was a command line
1252 void add_job_opts(const char **o, int client_type)
1254 struct thread_data *td, *td_parent;
1255 int i, in_global = 1;
1259 td_parent = td = NULL;
1261 if (!strncmp(o[i], "name", 4)) {
1264 add_job(td, jobname, 0, 0, client_type);
1266 sprintf(jobname, "%s", o[i] + 5);
1268 if (in_global && !td_parent)
1269 td_parent = get_new_job(1, &def_thread, 0, jobname);
1270 else if (!in_global && !td) {
1272 td_parent = &def_thread;
1273 td = get_new_job(0, td_parent, 0, jobname);
1276 fio_options_parse(td_parent, (char **) &o[i], 1, 0);
1278 fio_options_parse(td, (char **) &o[i], 1, 0);
1283 add_job(td, jobname, 0, 0, client_type);
1286 static int skip_this_section(const char *name)
1290 if (!nr_job_sections)
1292 if (!strncmp(name, "global", 6))
1295 for (i = 0; i < nr_job_sections; i++)
1296 if (!strcmp(job_sections[i], name))
1302 static int is_empty_or_comment(char *line)
1306 for (i = 0; i < strlen(line); i++) {
1311 if (!isspace((int) line[i]) && !iscntrl((int) line[i]))
1319 * This is our [ini] type file parser.
1321 int parse_jobs_ini(char *file, int is_buf, int stonewall_flag, int type)
1323 unsigned int global;
1324 struct thread_data *td;
1325 char *string, *name;
1328 int ret = 0, stonewall;
1331 int inside_skip = 0;
1333 int i, alloc_opts, num_opts;
1338 if (!strcmp(file, "-"))
1341 f = fopen(file, "r");
1344 perror("fopen job file");
1349 string = malloc(4096);
1352 * it's really 256 + small bit, 280 should suffice
1355 memset(name, 0, 280);
1358 opts = malloc(sizeof(char *) * alloc_opts);
1361 stonewall = stonewall_flag;
1364 * if skip_fgets is set, we already have loaded a line we
1369 p = strsep(&file, "\n");
1371 p = fgets(string, 4096, f);
1377 strip_blank_front(&p);
1380 if (is_empty_or_comment(p))
1382 if (sscanf(p, "[%255[^\n]]", name) != 1) {
1385 log_err("fio: option <%s> outside of [] job section\n",
1390 name[strlen(name) - 1] = '\0';
1392 if (skip_this_section(name)) {
1398 global = !strncmp(name, "global", 6);
1404 log_info("--name=%s ", name);
1408 td = get_new_job(global, &def_thread, 0, name);
1415 * Separate multiple job files by a stonewall
1417 if (!global && stonewall) {
1418 td->o.stonewall = stonewall;
1423 memset(opts, 0, alloc_opts * sizeof(char *));
1427 p = strsep(&file, "\n");
1429 p = fgets(string, 4096, f);
1433 if (is_empty_or_comment(p))
1436 strip_blank_front(&p);
1439 * new section, break out and make sure we don't
1440 * fgets() a new line at the top.
1449 if (num_opts == alloc_opts) {
1451 opts = realloc(opts,
1452 alloc_opts * sizeof(char *));
1455 opts[num_opts] = strdup(p);
1459 ret = fio_options_parse(td, opts, num_opts, dump_cmdline);
1461 ret = add_job(td, name, 0, 0, type);
1463 log_err("fio: job %s dropped\n", name);
1467 for (i = 0; i < num_opts; i++)
1476 while (i < nr_job_sections) {
1477 free(job_sections[i]);
1484 if (!is_buf && f != stdin)
1489 static int fill_def_thread(void)
1491 memset(&def_thread, 0, sizeof(def_thread));
1493 fio_getaffinity(getpid(), &def_thread.o.cpumask);
1494 def_thread.o.error_dump = 1;
1497 * fill default options
1499 fio_fill_default_options(&def_thread);
1503 static void usage(const char *name)
1505 printf("%s\n", fio_version_string);
1506 printf("%s [options] [job options] <job file(s)>\n", name);
1507 printf(" --debug=options\tEnable debug logging. May be one/more of:\n"
1508 "\t\t\tprocess,file,io,mem,blktrace,verify,random,parse,\n"
1509 "\t\t\tdiskutil,job,mutex,profile,time,net,rate\n");
1510 printf(" --parse-only\t\tParse options only, don't start any IO\n");
1511 printf(" --output\t\tWrite output to file\n");
1512 printf(" --runtime\t\tRuntime in seconds\n");
1513 printf(" --latency-log\t\tGenerate per-job latency logs\n");
1514 printf(" --bandwidth-log\tGenerate per-job bandwidth logs\n");
1515 printf(" --minimal\t\tMinimal (terse) output\n");
1516 printf(" --output-format=x\tOutput format (terse,json,normal)\n");
1517 printf(" --terse-version=x\tSet terse version output format to 'x'\n");
1518 printf(" --version\t\tPrint version info and exit\n");
1519 printf(" --help\t\tPrint this page\n");
1520 printf(" --cpuclock-test\tPerform test/validation of CPU clock\n");
1521 printf(" --crctest\t\tTest speed of checksum functions\n");
1522 printf(" --cmdhelp=cmd\t\tPrint command help, \"all\" for all of"
1524 printf(" --enghelp=engine\tPrint ioengine help, or list"
1525 " available ioengines\n");
1526 printf(" --enghelp=engine,cmd\tPrint help for an ioengine"
1528 printf(" --showcmd\t\tTurn a job file into command line options\n");
1529 printf(" --eta=when\t\tWhen ETA estimate should be printed\n");
1530 printf(" \t\tMay be \"always\", \"never\" or \"auto\"\n");
1531 printf(" --eta-newline=time\tForce a new line for every 'time'");
1532 printf(" period passed\n");
1533 printf(" --status-interval=t\tForce full status dump every");
1534 printf(" 't' period passed\n");
1535 printf(" --readonly\t\tTurn on safety read-only checks, preventing"
1537 printf(" --section=name\tOnly run specified section in job file\n");
1538 printf(" --alloc-size=kb\tSet smalloc pool to this size in kb"
1540 printf(" --warnings-fatal\tFio parser warnings are fatal\n");
1541 printf(" --max-jobs=nr\t\tMaximum number of threads/processes to support\n");
1542 printf(" --server=args\t\tStart a backend fio server\n");
1543 printf(" --daemonize=pidfile\tBackground fio server, write pid to file\n");
1544 printf(" --client=hostname\tTalk to remote backend fio server at hostname\n");
1545 printf(" --idle-prof=option\tReport cpu idleness on a system or percpu basis\n"
1546 "\t\t\t(option=system,percpu) or run unit work\n"
1547 "\t\t\tcalibration only (option=calibrate)\n");
1548 printf("\nFio was written by Jens Axboe <jens.axboe@oracle.com>");
1549 printf("\n Jens Axboe <jaxboe@fusionio.com>");
1550 printf("\n Jens Axboe <axboe@fb.com>\n");
1553 #ifdef FIO_INC_DEBUG
1554 struct debug_level debug_levels[] = {
1555 { .name = "process",
1556 .help = "Process creation/exit logging",
1557 .shift = FD_PROCESS,
1560 .help = "File related action logging",
1564 .help = "IO and IO engine action logging (offsets, queue, completions, etc)",
1568 .help = "Memory allocation/freeing logging",
1571 { .name = "blktrace",
1572 .help = "blktrace action logging",
1573 .shift = FD_BLKTRACE,
1576 .help = "IO verification action logging",
1580 .help = "Random generation logging",
1584 .help = "Parser logging",
1587 { .name = "diskutil",
1588 .help = "Disk utility logging actions",
1589 .shift = FD_DISKUTIL,
1592 .help = "Logging related to creating/destroying jobs",
1596 .help = "Mutex logging",
1599 { .name = "profile",
1600 .help = "Logging related to profiles",
1601 .shift = FD_PROFILE,
1604 .help = "Logging related to time keeping functions",
1608 .help = "Network logging",
1612 .help = "Rate logging",
1618 static int set_debug(const char *string)
1620 struct debug_level *dl;
1621 char *p = (char *) string;
1625 if (!strcmp(string, "?") || !strcmp(string, "help")) {
1626 log_info("fio: dumping debug options:");
1627 for (i = 0; debug_levels[i].name; i++) {
1628 dl = &debug_levels[i];
1629 log_info("%s,", dl->name);
1635 while ((opt = strsep(&p, ",")) != NULL) {
1638 if (!strncmp(opt, "all", 3)) {
1639 log_info("fio: set all debug options\n");
1644 for (i = 0; debug_levels[i].name; i++) {
1645 dl = &debug_levels[i];
1646 found = !strncmp(opt, dl->name, strlen(dl->name));
1650 if (dl->shift == FD_JOB) {
1651 opt = strchr(opt, ':');
1653 log_err("fio: missing job number\n");
1657 fio_debug_jobno = atoi(opt);
1658 log_info("fio: set debug jobno %d\n",
1661 log_info("fio: set debug option %s\n", opt);
1662 fio_debug |= (1UL << dl->shift);
1668 log_err("fio: debug mask %s not found\n", opt);
1673 static int set_debug(const char *string)
1675 log_err("fio: debug tracing not included in build\n");
1680 static void fio_options_fill_optstring(void)
1682 char *ostr = cmd_optstr;
1686 while (l_opts[i].name) {
1687 ostr[c++] = l_opts[i].val;
1688 if (l_opts[i].has_arg == required_argument)
1690 else if (l_opts[i].has_arg == optional_argument) {
1699 static int client_flag_set(char c)
1704 while (l_opts[i].name) {
1705 int val = l_opts[i].val;
1707 if (c == (val & 0xff))
1708 return (val & FIO_CLIENT_FLAG);
1716 static void parse_cmd_client(void *client, char *opt)
1718 fio_client_add_cmd_option(client, opt);
1721 int parse_cmd_line(int argc, char *argv[], int client_type)
1723 struct thread_data *td = NULL;
1724 int c, ini_idx = 0, lidx, ret = 0, do_exit = 0, exit_val = 0;
1725 char *ostr = cmd_optstr;
1726 void *pid_file = NULL;
1727 void *cur_client = NULL;
1731 * Reset optind handling, since we may call this multiple times
1736 while ((c = getopt_long_only(argc, argv, ostr, l_opts, &lidx)) != -1) {
1737 if ((c & FIO_CLIENT_FLAG) || client_flag_set(c)) {
1738 parse_cmd_client(cur_client, argv[optind - 1]);
1739 c &= ~FIO_CLIENT_FLAG;
1744 smalloc_pool_size = atoi(optarg);
1747 if (check_str_time(optarg, &def_timeout, 1)) {
1748 log_err("fio: failed parsing time %s\n", optarg);
1760 if (f_out && f_out != stdout)
1763 f_out = fopen(optarg, "w+");
1765 perror("fopen output");
1771 output_format = FIO_OUTPUT_TERSE;
1775 log_err("fio: missing --output-format argument\n");
1780 if (!strcmp(optarg, "minimal") ||
1781 !strcmp(optarg, "terse") ||
1782 !strcmp(optarg, "csv"))
1783 output_format = FIO_OUTPUT_TERSE;
1784 else if (!strcmp(optarg, "json"))
1785 output_format = FIO_OUTPUT_JSON;
1787 output_format = FIO_OUTPUT_NORMAL;
1790 append_terse_output = 1;
1802 fio_show_option_help(optarg);
1809 fio_show_ioengine_help(optarg);
1823 log_info("%s\n", fio_version_string);
1828 terse_version = atoi(optarg);
1829 if (!(terse_version == 2 || terse_version == 3 ||
1830 terse_version == 4)) {
1831 log_err("fio: bad terse version format\n");
1837 if (!strcmp("always", optarg))
1838 eta_print = FIO_ETA_ALWAYS;
1839 else if (!strcmp("never", optarg))
1840 eta_print = FIO_ETA_NEVER;
1845 if (str_to_decimal(optarg, &t, 0, NULL, 1)) {
1846 log_err("fio: failed parsing eta time %s\n", optarg);
1854 if (set_debug(optarg))
1864 if (!strcmp(optarg, "global")) {
1865 log_err("fio: can't use global as only "
1871 new_size = (nr_job_sections + 1) * sizeof(char *);
1872 job_sections = realloc(job_sections, new_size);
1873 job_sections[nr_job_sections] = strdup(optarg);
1881 exec_profile = strdup(optarg);
1883 case FIO_GETOPT_JOB: {
1884 const char *opt = l_opts[lidx].name;
1887 if (!strncmp(opt, "name", 4) && td) {
1888 ret = add_job(td, td->o.name ?: "fio", 0, 0, client_type);
1895 int is_section = !strncmp(opt, "name", 4);
1898 if (!is_section || !strncmp(val, "global", 6))
1901 if (is_section && skip_this_section(val))
1904 td = get_new_job(global, &def_thread, 1, NULL);
1905 if (!td || ioengine_load(td)) {
1913 fio_options_set_ioengine_opts(l_opts, td);
1916 if ((!val || !strlen(val)) &&
1917 l_opts[lidx].has_arg == required_argument) {
1918 log_err("fio: option %s requires an argument\n", opt);
1921 ret = fio_cmd_option_parse(td, opt, val);
1931 if (!ret && !strcmp(opt, "ioengine")) {
1933 if (ioengine_load(td)) {
1941 fio_options_set_ioengine_opts(l_opts, td);
1945 case FIO_GETOPT_IOENGINE: {
1946 const char *opt = l_opts[lidx].name;
1952 ret = fio_cmd_ioengine_option_parse(td, opt, val);
1959 max_jobs = atoi(optarg);
1960 if (!max_jobs || max_jobs > REAL_MAX_JOBS) {
1961 log_err("fio: invalid max jobs: %d\n", max_jobs);
1968 #ifndef CONFIG_NO_SHM
1970 log_err("fio: can't be both client and server\n");
1976 fio_server_set_arg(optarg);
1980 log_err("fio: client/server requires SHM support\n");
1988 pid_file = strdup(optarg);
1991 if ((ret = fio_idle_prof_parse_opt(optarg))) {
1992 /* exit on error and calibration only */
2002 log_err("fio: can't be both client and server\n");
2007 if (fio_client_add(&fio_client_ops, optarg, &cur_client)) {
2008 log_err("fio: failed adding client %s\n", optarg);
2014 * If the next argument exists and isn't an option,
2015 * assume it's a job file for this client only.
2017 while (optind < argc) {
2018 if (!strncmp(argv[optind], "--", 2) ||
2019 !strncmp(argv[optind], "-", 1))
2022 fio_client_add_ini_file(cur_client, argv[optind]);
2029 exit_val = fio_monotonic_clocktest();
2034 exit_val = fio_crctest(optarg);
2039 if (check_str_time(optarg, &val, 0)) {
2040 log_err("fio: failed parsing time %s\n", optarg);
2045 status_interval = val * 1000;
2049 log_err("%s: unrecognized option '%s'\n", argv[0],
2060 if (do_exit && !(is_backend || nr_clients))
2063 if (nr_clients && fio_clients_connect())
2066 if (is_backend && backend)
2067 return fio_start_server(pid_file);
2073 ret = add_job(td, td->o.name ?: "fio", 0, 0, client_type);
2079 while (!ret && optind < argc) {
2081 ini_file = realloc(ini_file, ini_idx * sizeof(char *));
2082 ini_file[ini_idx - 1] = strdup(argv[optind]);
2093 int fio_init_options(void)
2098 fio_options_fill_optstring();
2099 fio_options_dup_and_init(l_opts);
2103 if (fill_def_thread())
2109 extern int fio_check_options(struct thread_options *);
2111 int parse_options(int argc, char *argv[])
2113 const int type = FIO_CLIENT_TYPE_CLI;
2116 if (fio_init_options())
2118 if (fio_test_cconv(&def_thread.o))
2119 log_err("fio: failed internal cconv test\n");
2121 job_files = parse_cmd_line(argc, argv, type);
2123 if (job_files > 0) {
2124 for (i = 0; i < job_files; i++) {
2125 if (i && fill_def_thread())
2128 if (fio_clients_send_ini(ini_file[i]))
2131 } else if (!is_backend) {
2132 if (parse_jobs_ini(ini_file[i], 0, i, type))
2137 } else if (nr_clients) {
2138 if (fill_def_thread())
2140 if (fio_clients_send_ini(NULL))
2145 fio_options_free(&def_thread);
2146 filesetup_mem_free();
2148 if (!thread_number) {
2153 if (is_backend || nr_clients)
2158 log_err("No jobs(s) defined\n\n");
2168 if (def_thread.o.gtod_offload) {
2170 fio_gtod_offload = 1;
2171 fio_gtod_cpu = def_thread.o.gtod_cpu;
2174 if (output_format == FIO_OUTPUT_NORMAL)
2175 log_info("%s\n", fio_version_string);
2180 void options_default_fill(struct thread_options *o)
2182 memcpy(o, &def_thread.o, sizeof(*o));