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)
241 struct shmid_ds sbuf;
248 shmctl(shm_id, IPC_RMID, &sbuf);
253 static void free_shm(void)
258 fio_debug_jobp = NULL;
262 options_free(fio_options, &def_thread);
268 * The thread area is shared between the main process and the job
269 * threads/processes. So setup a shared memory segment that will hold
270 * all the job info. We use the end of the region for keeping track of
271 * open files across jobs, for file sharing.
273 static int setup_thread_area(void)
281 * 1024 is too much on some machines, scale max_jobs if
282 * we get a failure that looks like too large a shm segment
285 size_t size = max_jobs * sizeof(struct thread_data);
287 size += file_hash_size;
288 size += sizeof(unsigned int);
290 shm_id = shmget(0, size, IPC_CREAT | 0600);
293 if (errno != EINVAL && errno != ENOMEM && errno != ENOSPC) {
304 threads = shmat(shm_id, NULL, 0);
305 if (threads == (void *) -1) {
310 memset(threads, 0, max_jobs * sizeof(struct thread_data));
311 hash = (void *) threads + max_jobs * sizeof(struct thread_data);
312 fio_debug_jobp = (void *) hash + file_hash_size;
313 *fio_debug_jobp = -1;
314 file_hash_init(hash);
321 static void set_cmd_options(struct thread_data *td)
323 struct thread_options *o = &td->o;
326 o->timeout = def_timeout;
330 * Return a free job structure.
332 static struct thread_data *get_new_job(int global, struct thread_data *parent,
335 struct thread_data *td;
338 set_cmd_options(&def_thread);
341 if (setup_thread_area()) {
342 log_err("error: failed to setup shm segment\n");
345 if (thread_number >= max_jobs) {
346 log_err("error: maximum number of jobs (%d) reached.\n",
351 td = &threads[thread_number++];
358 td->o.uid = td->o.gid = -1U;
360 dup_files(td, parent);
361 fio_options_mem_dupe(td);
363 profile_add_hooks(td);
365 td->thread_number = thread_number;
367 if (!parent || !parent->o.group_reporting)
374 static void put_job(struct thread_data *td)
376 if (td == &def_thread)
383 log_info("fio: %s\n", td->verror);
385 fio_options_free(td);
389 memset(&threads[td->thread_number - 1], 0, sizeof(*td));
393 static int __setup_rate(struct thread_data *td, enum fio_ddir ddir)
395 unsigned int bs = td->o.min_bs[ddir];
397 assert(ddir_rw(ddir));
399 if (td->o.rate[ddir])
400 td->rate_bps[ddir] = td->o.rate[ddir];
402 td->rate_bps[ddir] = td->o.rate_iops[ddir] * bs;
404 if (!td->rate_bps[ddir]) {
405 log_err("rate lower than supported\n");
409 td->rate_pending_usleep[ddir] = 0;
413 static int setup_rate(struct thread_data *td)
417 if (td->o.rate[DDIR_READ] || td->o.rate_iops[DDIR_READ])
418 ret = __setup_rate(td, DDIR_READ);
419 if (td->o.rate[DDIR_WRITE] || td->o.rate_iops[DDIR_WRITE])
420 ret |= __setup_rate(td, DDIR_WRITE);
421 if (td->o.rate[DDIR_TRIM] || td->o.rate_iops[DDIR_TRIM])
422 ret |= __setup_rate(td, DDIR_TRIM);
427 static int fixed_block_size(struct thread_options *o)
429 return o->min_bs[DDIR_READ] == o->max_bs[DDIR_READ] &&
430 o->min_bs[DDIR_WRITE] == o->max_bs[DDIR_WRITE] &&
431 o->min_bs[DDIR_TRIM] == o->max_bs[DDIR_TRIM] &&
432 o->min_bs[DDIR_READ] == o->min_bs[DDIR_WRITE] &&
433 o->min_bs[DDIR_READ] == o->min_bs[DDIR_TRIM];
437 static unsigned long long get_rand_start_delay(struct thread_data *td)
439 unsigned long long delayrange;
442 delayrange = td->o.start_delay_high - td->o.start_delay;
444 if (td->o.use_os_rand) {
445 r = os_random_long(&td->delay_state);
446 delayrange = (unsigned long long) ((double) delayrange * (r / (OS_RAND_MAX + 1.0)));
448 r = __rand(&td->__delay_state);
449 delayrange = (unsigned long long) ((double) delayrange * (r / (FRAND_MAX + 1.0)));
452 delayrange += td->o.start_delay;
457 * Lazy way of fixing up options that depend on each other. We could also
458 * define option callback handlers, but this is easier.
460 static int fixup_options(struct thread_data *td)
462 struct thread_options *o = &td->o;
465 #ifndef FIO_HAVE_PSHARED_MUTEX
466 if (!o->use_thread) {
467 log_info("fio: this platform does not support process shared"
468 " mutexes, forcing use of threads. Use the 'thread'"
469 " option to get rid of this warning.\n");
471 ret = warnings_fatal;
475 if (o->write_iolog_file && o->read_iolog_file) {
476 log_err("fio: read iolog overrides write_iolog\n");
477 free(o->write_iolog_file);
478 o->write_iolog_file = NULL;
479 ret = warnings_fatal;
483 * only really works with 1 file
485 if (o->zone_size && o->open_files > 1)
489 * If zone_range isn't specified, backward compatibility dictates it
490 * should be made equal to zone_size.
492 if (o->zone_size && !o->zone_range)
493 o->zone_range = o->zone_size;
496 * Reads can do overwrites, we always need to pre-create the file
498 if (td_read(td) || td_rw(td))
501 if (!o->min_bs[DDIR_READ])
502 o->min_bs[DDIR_READ] = o->bs[DDIR_READ];
503 if (!o->max_bs[DDIR_READ])
504 o->max_bs[DDIR_READ] = o->bs[DDIR_READ];
505 if (!o->min_bs[DDIR_WRITE])
506 o->min_bs[DDIR_WRITE] = o->bs[DDIR_WRITE];
507 if (!o->max_bs[DDIR_WRITE])
508 o->max_bs[DDIR_WRITE] = o->bs[DDIR_WRITE];
509 if (!o->min_bs[DDIR_TRIM])
510 o->min_bs[DDIR_TRIM] = o->bs[DDIR_TRIM];
511 if (!o->max_bs[DDIR_TRIM])
512 o->max_bs[DDIR_TRIM] = o->bs[DDIR_TRIM];
515 o->rw_min_bs = min(o->min_bs[DDIR_READ], o->min_bs[DDIR_WRITE]);
516 o->rw_min_bs = min(o->min_bs[DDIR_TRIM], o->rw_min_bs);
519 * For random IO, allow blockalign offset other than min_bs.
521 if (!o->ba[DDIR_READ] || !td_random(td))
522 o->ba[DDIR_READ] = o->min_bs[DDIR_READ];
523 if (!o->ba[DDIR_WRITE] || !td_random(td))
524 o->ba[DDIR_WRITE] = o->min_bs[DDIR_WRITE];
525 if (!o->ba[DDIR_TRIM] || !td_random(td))
526 o->ba[DDIR_TRIM] = o->min_bs[DDIR_TRIM];
528 if ((o->ba[DDIR_READ] != o->min_bs[DDIR_READ] ||
529 o->ba[DDIR_WRITE] != o->min_bs[DDIR_WRITE] ||
530 o->ba[DDIR_TRIM] != o->min_bs[DDIR_TRIM]) &&
532 log_err("fio: Any use of blockalign= turns off randommap\n");
534 ret = warnings_fatal;
537 if (!o->file_size_high)
538 o->file_size_high = o->file_size_low;
540 if (o->start_delay_high)
541 o->start_delay = get_rand_start_delay(td);
543 if (o->norandommap && o->verify != VERIFY_NONE
544 && !fixed_block_size(o)) {
545 log_err("fio: norandommap given for variable block sizes, "
546 "verify disabled\n");
547 o->verify = VERIFY_NONE;
548 ret = warnings_fatal;
550 if (o->bs_unaligned && (o->odirect || td->io_ops->flags & FIO_RAWIO))
551 log_err("fio: bs_unaligned may not work with raw io\n");
554 * thinktime_spin must be less than thinktime
556 if (o->thinktime_spin > o->thinktime)
557 o->thinktime_spin = o->thinktime;
560 * The low water mark cannot be bigger than the iodepth
562 if (o->iodepth_low > o->iodepth || !o->iodepth_low)
563 o->iodepth_low = o->iodepth;
566 * If batch number isn't set, default to the same as iodepth
568 if (o->iodepth_batch > o->iodepth || !o->iodepth_batch)
569 o->iodepth_batch = o->iodepth;
571 if (o->nr_files > td->files_index)
572 o->nr_files = td->files_index;
574 if (o->open_files > o->nr_files || !o->open_files)
575 o->open_files = o->nr_files;
577 if (((o->rate[DDIR_READ] + o->rate[DDIR_WRITE] + o->rate[DDIR_TRIM]) &&
578 (o->rate_iops[DDIR_READ] + o->rate_iops[DDIR_WRITE] + o->rate_iops[DDIR_TRIM])) ||
579 ((o->ratemin[DDIR_READ] + o->ratemin[DDIR_WRITE] + o->ratemin[DDIR_TRIM]) &&
580 (o->rate_iops_min[DDIR_READ] + o->rate_iops_min[DDIR_WRITE] + o->rate_iops_min[DDIR_TRIM]))) {
581 log_err("fio: rate and rate_iops are mutually exclusive\n");
584 if ((o->rate[DDIR_READ] < o->ratemin[DDIR_READ]) ||
585 (o->rate[DDIR_WRITE] < o->ratemin[DDIR_WRITE]) ||
586 (o->rate[DDIR_TRIM] < o->ratemin[DDIR_TRIM]) ||
587 (o->rate_iops[DDIR_READ] < o->rate_iops_min[DDIR_READ]) ||
588 (o->rate_iops[DDIR_WRITE] < o->rate_iops_min[DDIR_WRITE]) ||
589 (o->rate_iops[DDIR_TRIM] < o->rate_iops_min[DDIR_TRIM])) {
590 log_err("fio: minimum rate exceeds rate\n");
594 if (!o->timeout && o->time_based) {
595 log_err("fio: time_based requires a runtime/timeout setting\n");
597 ret = warnings_fatal;
600 if (o->fill_device && !o->size)
603 if (o->verify != VERIFY_NONE) {
604 if (td_write(td) && o->do_verify && o->numjobs > 1) {
605 log_info("Multiple writers may overwrite blocks that "
606 "belong to other jobs. This can cause "
607 "verification failures.\n");
608 ret = warnings_fatal;
611 o->refill_buffers = 1;
612 if (o->max_bs[DDIR_WRITE] != o->min_bs[DDIR_WRITE] &&
614 o->verify_interval = o->min_bs[DDIR_WRITE];
618 o->invalidate_cache = 0;
619 if (td->io_ops->flags & FIO_PIPEIO) {
620 log_info("fio: cannot pre-read files with an IO engine"
621 " that isn't seekable. Pre-read disabled.\n");
622 ret = warnings_fatal;
627 if (td->io_ops->flags & FIO_BIT_BASED)
633 #ifndef CONFIG_FDATASYNC
634 if (o->fdatasync_blocks) {
635 log_info("fio: this platform does not support fdatasync()"
636 " falling back to using fsync(). Use the 'fsync'"
637 " option instead of 'fdatasync' to get rid of"
639 o->fsync_blocks = o->fdatasync_blocks;
640 o->fdatasync_blocks = 0;
641 ret = warnings_fatal;
647 * Windows doesn't support O_DIRECT or O_SYNC with the _open interface,
648 * so fail if we're passed those flags
650 if ((td->io_ops->flags & FIO_SYNCIO) && (td->o.odirect || td->o.sync_io)) {
651 log_err("fio: Windows does not support direct or non-buffered io with"
652 " the synchronous ioengines. Use the 'windowsaio' ioengine"
653 " with 'direct=1' and 'iodepth=1' instead.\n");
659 * For fully compressible data, just zero them at init time.
660 * It's faster than repeatedly filling it.
662 if (td->o.compress_percentage == 100) {
663 td->o.zero_buffers = 1;
664 td->o.compress_percentage = 0;
668 * Using a non-uniform random distribution excludes usage of
671 if (td->o.random_distribution != FIO_RAND_DIST_RANDOM)
672 td->o.norandommap = 1;
675 * If size is set but less than the min block size, complain
677 if (o->size && o->size < td_min_bs(td)) {
678 log_err("fio: size too small, must be larger than the IO size: %llu\n", (unsigned long long) o->size);
683 * O_ATOMIC implies O_DIRECT
689 * If randseed is set, that overrides randrepeat
692 td->o.rand_repeatable = 0;
694 if ((td->io_ops->flags & FIO_NOEXTEND) && td->o.file_append) {
695 log_err("fio: can't append/extent with IO engine %s\n", td->io_ops->name);
703 * This function leaks the buffer
705 char *fio_uint_to_kmg(unsigned int val)
707 char *buf = malloc(32);
708 char post[] = { 0, 'K', 'M', 'G', 'P', 'E', 0 };
719 snprintf(buf, 32, "%u%c", val, *p);
723 /* External engines are specified by "external:name.o") */
724 static const char *get_engine_name(const char *str)
726 char *p = strstr(str, ":");
732 strip_blank_front(&p);
737 static int exists_and_not_file(const char *filename)
741 if (lstat(filename, &sb) == -1)
744 /* \\.\ is the device namespace in Windows, where every file
745 * is a device node */
746 if (S_ISREG(sb.st_mode) && strncmp(filename, "\\\\.\\", 4) != 0)
752 static void td_fill_rand_seeds_os(struct thread_data *td)
754 os_random_seed(td->rand_seeds[FIO_RAND_BS_OFF], &td->bsrange_state);
755 os_random_seed(td->rand_seeds[FIO_RAND_VER_OFF], &td->verify_state);
756 os_random_seed(td->rand_seeds[FIO_RAND_MIX_OFF], &td->rwmix_state);
758 if (td->o.file_service_type == FIO_FSERVICE_RANDOM)
759 os_random_seed(td->rand_seeds[FIO_RAND_FILE_OFF], &td->next_file_state);
761 os_random_seed(td->rand_seeds[FIO_RAND_FILE_SIZE_OFF], &td->file_size_state);
762 os_random_seed(td->rand_seeds[FIO_RAND_TRIM_OFF], &td->trim_state);
763 os_random_seed(td->rand_seeds[FIO_RAND_START_DELAY], &td->delay_state);
768 if (td->o.rand_repeatable)
769 td->rand_seeds[FIO_RAND_BLOCK_OFF] = FIO_RANDSEED * td->thread_number;
771 os_random_seed(td->rand_seeds[FIO_RAND_BLOCK_OFF], &td->random_state);
773 os_random_seed(td->rand_seeds[FIO_RAND_SEQ_RAND_READ_OFF], &td->seq_rand_state[DDIR_READ]);
774 os_random_seed(td->rand_seeds[FIO_RAND_SEQ_RAND_WRITE_OFF], &td->seq_rand_state[DDIR_WRITE]);
775 os_random_seed(td->rand_seeds[FIO_RAND_SEQ_RAND_TRIM_OFF], &td->seq_rand_state[DDIR_TRIM]);
778 static void td_fill_rand_seeds_internal(struct thread_data *td)
780 init_rand_seed(&td->__bsrange_state, td->rand_seeds[FIO_RAND_BS_OFF]);
781 init_rand_seed(&td->__verify_state, td->rand_seeds[FIO_RAND_VER_OFF]);
782 init_rand_seed(&td->__rwmix_state, td->rand_seeds[FIO_RAND_MIX_OFF]);
784 if (td->o.file_service_type == FIO_FSERVICE_RANDOM)
785 init_rand_seed(&td->__next_file_state, td->rand_seeds[FIO_RAND_FILE_OFF]);
787 init_rand_seed(&td->__file_size_state, td->rand_seeds[FIO_RAND_FILE_SIZE_OFF]);
788 init_rand_seed(&td->__trim_state, td->rand_seeds[FIO_RAND_TRIM_OFF]);
789 init_rand_seed(&td->__delay_state, td->rand_seeds[FIO_RAND_START_DELAY]);
794 if (td->o.rand_repeatable)
795 td->rand_seeds[FIO_RAND_BLOCK_OFF] = FIO_RANDSEED * td->thread_number;
797 init_rand_seed(&td->__random_state, td->rand_seeds[FIO_RAND_BLOCK_OFF]);
798 init_rand_seed(&td->__seq_rand_state[DDIR_READ], td->rand_seeds[FIO_RAND_SEQ_RAND_READ_OFF]);
799 init_rand_seed(&td->__seq_rand_state[DDIR_WRITE], td->rand_seeds[FIO_RAND_SEQ_RAND_WRITE_OFF]);
800 init_rand_seed(&td->__seq_rand_state[DDIR_TRIM], td->rand_seeds[FIO_RAND_SEQ_RAND_TRIM_OFF]);
803 void td_fill_rand_seeds(struct thread_data *td)
805 if (td->o.allrand_repeatable) {
806 for (int i = 0; i < FIO_RAND_NR_OFFS; i++)
807 td->rand_seeds[i] = FIO_RANDSEED * td->thread_number
811 if (td->o.use_os_rand)
812 td_fill_rand_seeds_os(td);
814 td_fill_rand_seeds_internal(td);
816 init_rand_seed(&td->buf_state, td->rand_seeds[FIO_RAND_BUF_OFF]);
820 * Initializes the ioengine configured for a job, if it has not been done so
823 int ioengine_load(struct thread_data *td)
828 * Engine has already been loaded.
832 if (!td->o.ioengine) {
833 log_err("fio: internal fault, no IO engine specified\n");
837 engine = get_engine_name(td->o.ioengine);
838 td->io_ops = load_ioengine(td, engine);
840 log_err("fio: failed to load engine %s\n", engine);
844 if (td->io_ops->option_struct_size && td->io_ops->options) {
846 * In cases where td->eo is set, clone it for a child thread.
847 * This requires that the parent thread has the same ioengine,
848 * but that requirement must be enforced by the code which
851 void *origeo = td->eo;
853 * Otherwise use the default thread options.
855 if (!origeo && td != &def_thread && def_thread.eo &&
856 def_thread.io_ops->options == td->io_ops->options)
857 origeo = def_thread.eo;
859 options_init(td->io_ops->options);
860 td->eo = malloc(td->io_ops->option_struct_size);
862 * Use the default thread as an option template if this uses the
863 * same options structure and there are non-default options
867 memcpy(td->eo, origeo, td->io_ops->option_struct_size);
868 options_mem_dupe(td->eo, td->io_ops->options);
870 memset(td->eo, 0, td->io_ops->option_struct_size);
871 fill_default_options(td->eo, td->io_ops->options);
873 *(struct thread_data **)td->eo = td;
879 static void init_flags(struct thread_data *td)
881 struct thread_options *o = &td->o;
883 if (o->verify_backlog)
884 td->flags |= TD_F_VER_BACKLOG;
886 td->flags |= TD_F_TRIM_BACKLOG;
887 if (o->read_iolog_file)
888 td->flags |= TD_F_READ_IOLOG;
889 if (o->refill_buffers)
890 td->flags |= TD_F_REFILL_BUFFERS;
891 if (o->scramble_buffers)
892 td->flags |= TD_F_SCRAMBLE_BUFFERS;
893 if (o->verify != VERIFY_NONE)
894 td->flags |= TD_F_VER_NONE;
897 static int setup_random_seeds(struct thread_data *td)
902 if (!td->o.rand_repeatable && !td->o.rand_seed)
903 return init_random_state(td, td->rand_seeds, sizeof(td->rand_seeds));
905 if (!td->o.rand_seed)
908 seed = td->o.rand_seed;
910 for (i = 0; i < 4; i++)
911 seed *= 0x9e370001UL;
913 for (i = 0; i < FIO_RAND_NR_OFFS; i++) {
914 td->rand_seeds[i] = seed;
915 seed *= 0x9e370001UL;
918 td_fill_rand_seeds(td);
929 static struct fpre_keyword {
933 } fpre_keywords[] = {
934 { .keyword = "$jobname", .key = FPRE_JOBNAME, },
935 { .keyword = "$jobnum", .key = FPRE_JOBNUM, },
936 { .keyword = "$filenum", .key = FPRE_FILENUM, },
937 { .keyword = NULL, },
940 static char *make_filename(char *buf, struct thread_options *o,
941 const char *jobname, int jobnum, int filenum)
943 struct fpre_keyword *f;
946 if (!o->filename_format || !strlen(o->filename_format)) {
947 sprintf(buf, "%s.%d.%d", jobname, jobnum, filenum);
951 for (f = &fpre_keywords[0]; f->keyword; f++)
952 f->strlen = strlen(f->keyword);
954 strcpy(buf, o->filename_format);
955 memset(copy, 0, sizeof(copy));
956 for (f = &fpre_keywords[0]; f->keyword; f++) {
958 size_t pre_len, post_start = 0;
959 char *str, *dst = copy;
961 str = strcasestr(buf, f->keyword);
966 if (strlen(str) != f->strlen)
967 post_start = pre_len + f->strlen;
970 strncpy(dst, buf, pre_len);
976 dst += sprintf(dst, "%s", jobname);
979 dst += sprintf(dst, "%d", jobnum);
982 dst += sprintf(dst, "%d", filenum);
990 strcpy(dst, buf + post_start);
999 int parse_dryrun(void)
1001 return dump_cmdline || parse_only;
1005 * Adds a job to the list of things todo. Sanitizes the various options
1006 * to make sure we don't have conflicts, and initializes various
1009 static int add_job(struct thread_data *td, const char *jobname, int job_add_num,
1010 int recursed, int client_type)
1013 char fname[PATH_MAX];
1014 int numjobs, file_alloced;
1015 struct thread_options *o = &td->o;
1018 * the def_thread is just for options, it's not a real job
1020 if (td == &def_thread)
1026 * if we are just dumping the output command line, don't add the job
1028 if (parse_dryrun()) {
1033 td->client_type = client_type;
1035 if (profile_td_init(td))
1038 if (ioengine_load(td))
1042 td->io_ops->flags |= FIO_RAWIO;
1045 if (!o->filename && !td->files_index && !o->read_iolog_file) {
1048 if (o->nr_files == 1 && exists_and_not_file(jobname))
1049 add_file(td, jobname, job_add_num, 0);
1051 for (i = 0; i < o->nr_files; i++)
1052 add_file(td, make_filename(fname, o, jobname, job_add_num, i), job_add_num, 0);
1056 if (fixup_options(td))
1062 * IO engines only need this for option callbacks, and the address may
1063 * change in subprocesses.
1066 *(struct thread_data **)td->eo = NULL;
1068 if (td->io_ops->flags & FIO_DISKLESSIO) {
1071 for_each_file(td, f, i)
1072 f->real_file_size = -1ULL;
1075 td->mutex = fio_mutex_init(FIO_MUTEX_LOCKED);
1077 td->ts.clat_percentiles = o->clat_percentiles;
1078 td->ts.percentile_precision = o->percentile_precision;
1079 memcpy(td->ts.percentile_list, o->percentile_list, sizeof(o->percentile_list));
1081 for (i = 0; i < DDIR_RWDIR_CNT; i++) {
1082 td->ts.clat_stat[i].min_val = ULONG_MAX;
1083 td->ts.slat_stat[i].min_val = ULONG_MAX;
1084 td->ts.lat_stat[i].min_val = ULONG_MAX;
1085 td->ts.bw_stat[i].min_val = ULONG_MAX;
1087 td->ddir_seq_nr = o->ddir_seq_nr;
1089 if ((o->stonewall || o->new_group) && prev_group_jobs) {
1090 prev_group_jobs = 0;
1094 td->groupid = groupid;
1097 if (setup_random_seeds(td)) {
1098 td_verror(td, errno, "init_random_state");
1105 if (o->lat_log_file || write_lat_log) {
1106 setup_log(&td->lat_log, o->log_avg_msec, IO_LOG_TYPE_LAT);
1107 setup_log(&td->slat_log, o->log_avg_msec, IO_LOG_TYPE_SLAT);
1108 setup_log(&td->clat_log, o->log_avg_msec, IO_LOG_TYPE_CLAT);
1110 if (o->bw_log_file || write_bw_log)
1111 setup_log(&td->bw_log, o->log_avg_msec, IO_LOG_TYPE_BW);
1112 if (o->iops_log_file)
1113 setup_log(&td->iops_log, o->log_avg_msec, IO_LOG_TYPE_IOPS);
1116 o->name = strdup(jobname);
1118 if (output_format == FIO_OUTPUT_NORMAL) {
1120 if (is_backend && !recursed)
1121 fio_server_send_add_job(td);
1123 if (!(td->io_ops->flags & FIO_NOIO)) {
1124 char *c1, *c2, *c3, *c4;
1125 char *c5 = NULL, *c6 = NULL;
1127 c1 = fio_uint_to_kmg(o->min_bs[DDIR_READ]);
1128 c2 = fio_uint_to_kmg(o->max_bs[DDIR_READ]);
1129 c3 = fio_uint_to_kmg(o->min_bs[DDIR_WRITE]);
1130 c4 = fio_uint_to_kmg(o->max_bs[DDIR_WRITE]);
1132 if (!o->bs_is_seq_rand) {
1133 c5 = fio_uint_to_kmg(o->min_bs[DDIR_TRIM]);
1134 c6 = fio_uint_to_kmg(o->max_bs[DDIR_TRIM]);
1137 log_info("%s: (g=%d): rw=%s, ", td->o.name,
1139 ddir_str(o->td_ddir));
1141 if (o->bs_is_seq_rand)
1142 log_info("bs(seq/rand)=%s-%s/%s-%s, ",
1145 log_info("bs=%s-%s/%s-%s/%s-%s, ",
1146 c1, c2, c3, c4, c5, c6);
1148 log_info("ioengine=%s, iodepth=%u\n",
1149 td->io_ops->name, o->iodepth);
1158 } else if (job_add_num == 1)
1163 * recurse add identical jobs, clear numjobs and stonewall options
1164 * as they don't apply to sub-jobs
1166 numjobs = o->numjobs;
1168 struct thread_data *td_new = get_new_job(0, td, 1);
1173 td_new->o.numjobs = 1;
1174 td_new->o.stonewall = 0;
1175 td_new->o.new_group = 0;
1178 if (td_new->files) {
1180 for_each_file(td_new, f, i) {
1182 sfree(f->file_name);
1185 free(td_new->files);
1186 td_new->files = NULL;
1188 td_new->files_index = 0;
1189 td_new->files_size = 0;
1190 if (td_new->o.filename) {
1191 free(td_new->o.filename);
1192 td_new->o.filename = NULL;
1196 if (add_job(td_new, jobname, numjobs, 1, client_type))
1207 * Parse as if 'o' was a command line
1209 void add_job_opts(const char **o, int client_type)
1211 struct thread_data *td, *td_parent;
1212 int i, in_global = 1;
1216 td_parent = td = NULL;
1218 if (!strncmp(o[i], "name", 4)) {
1221 add_job(td, jobname, 0, 0, client_type);
1223 sprintf(jobname, "%s", o[i] + 5);
1225 if (in_global && !td_parent)
1226 td_parent = get_new_job(1, &def_thread, 0);
1227 else if (!in_global && !td) {
1229 td_parent = &def_thread;
1230 td = get_new_job(0, td_parent, 0);
1233 fio_options_parse(td_parent, (char **) &o[i], 1, 0);
1235 fio_options_parse(td, (char **) &o[i], 1, 0);
1240 add_job(td, jobname, 0, 0, client_type);
1243 static int skip_this_section(const char *name)
1247 if (!nr_job_sections)
1249 if (!strncmp(name, "global", 6))
1252 for (i = 0; i < nr_job_sections; i++)
1253 if (!strcmp(job_sections[i], name))
1259 static int is_empty_or_comment(char *line)
1263 for (i = 0; i < strlen(line); i++) {
1268 if (!isspace((int) line[i]) && !iscntrl((int) line[i]))
1276 * This is our [ini] type file parser.
1278 int parse_jobs_ini(char *file, int is_buf, int stonewall_flag, int type)
1280 unsigned int global;
1281 struct thread_data *td;
1282 char *string, *name;
1285 int ret = 0, stonewall;
1288 int inside_skip = 0;
1290 int i, alloc_opts, num_opts;
1295 if (!strcmp(file, "-"))
1298 f = fopen(file, "r");
1301 perror("fopen job file");
1306 string = malloc(4096);
1309 * it's really 256 + small bit, 280 should suffice
1312 memset(name, 0, 280);
1315 opts = malloc(sizeof(char *) * alloc_opts);
1318 stonewall = stonewall_flag;
1321 * if skip_fgets is set, we already have loaded a line we
1326 p = strsep(&file, "\n");
1328 p = fgets(string, 4096, f);
1334 strip_blank_front(&p);
1337 if (is_empty_or_comment(p))
1339 if (sscanf(p, "[%255[^\n]]", name) != 1) {
1342 log_err("fio: option <%s> outside of [] job section\n",
1347 name[strlen(name) - 1] = '\0';
1349 if (skip_this_section(name)) {
1355 global = !strncmp(name, "global", 6);
1361 log_info("--name=%s ", name);
1365 td = get_new_job(global, &def_thread, 0);
1372 * Separate multiple job files by a stonewall
1374 if (!global && stonewall) {
1375 td->o.stonewall = stonewall;
1380 memset(opts, 0, alloc_opts * sizeof(char *));
1384 p = strsep(&file, "\n");
1386 p = fgets(string, 4096, f);
1390 if (is_empty_or_comment(p))
1393 strip_blank_front(&p);
1396 * new section, break out and make sure we don't
1397 * fgets() a new line at the top.
1406 if (num_opts == alloc_opts) {
1408 opts = realloc(opts,
1409 alloc_opts * sizeof(char *));
1412 opts[num_opts] = strdup(p);
1416 ret = fio_options_parse(td, opts, num_opts, dump_cmdline);
1418 ret = add_job(td, name, 0, 0, type);
1420 log_err("fio: job %s dropped\n", name);
1424 for (i = 0; i < num_opts; i++)
1433 while (i < nr_job_sections) {
1434 free(job_sections[i]);
1438 for (i = 0; i < num_opts; i++)
1444 if (!is_buf && f != stdin)
1449 static int fill_def_thread(void)
1451 memset(&def_thread, 0, sizeof(def_thread));
1453 fio_getaffinity(getpid(), &def_thread.o.cpumask);
1454 def_thread.o.error_dump = 1;
1457 * fill default options
1459 fio_fill_default_options(&def_thread);
1463 static void usage(const char *name)
1465 printf("%s\n", fio_version_string);
1466 printf("%s [options] [job options] <job file(s)>\n", name);
1467 printf(" --debug=options\tEnable debug logging. May be one/more of:\n"
1468 "\t\t\tprocess,file,io,mem,blktrace,verify,random,parse,\n"
1469 "\t\t\tdiskutil,job,mutex,profile,time,net,rate\n");
1470 printf(" --parse-only\t\tParse options only, don't start any IO\n");
1471 printf(" --output\t\tWrite output to file\n");
1472 printf(" --runtime\t\tRuntime in seconds\n");
1473 printf(" --latency-log\t\tGenerate per-job latency logs\n");
1474 printf(" --bandwidth-log\tGenerate per-job bandwidth logs\n");
1475 printf(" --minimal\t\tMinimal (terse) output\n");
1476 printf(" --output-format=x\tOutput format (terse,json,normal)\n");
1477 printf(" --terse-version=x\tSet terse version output format to 'x'\n");
1478 printf(" --version\t\tPrint version info and exit\n");
1479 printf(" --help\t\tPrint this page\n");
1480 printf(" --cpuclock-test\tPerform test/validation of CPU clock\n");
1481 printf(" --crctest\t\tTest speed of checksum functions\n");
1482 printf(" --cmdhelp=cmd\t\tPrint command help, \"all\" for all of"
1484 printf(" --enghelp=engine\tPrint ioengine help, or list"
1485 " available ioengines\n");
1486 printf(" --enghelp=engine,cmd\tPrint help for an ioengine"
1488 printf(" --showcmd\t\tTurn a job file into command line options\n");
1489 printf(" --eta=when\t\tWhen ETA estimate should be printed\n");
1490 printf(" \t\tMay be \"always\", \"never\" or \"auto\"\n");
1491 printf(" --eta-newline=time\tForce a new line for every 'time'");
1492 printf(" period passed\n");
1493 printf(" --status-interval=t\tForce full status dump every");
1494 printf(" 't' period passed\n");
1495 printf(" --readonly\t\tTurn on safety read-only checks, preventing"
1497 printf(" --section=name\tOnly run specified section in job file\n");
1498 printf(" --alloc-size=kb\tSet smalloc pool to this size in kb"
1500 printf(" --warnings-fatal\tFio parser warnings are fatal\n");
1501 printf(" --max-jobs=nr\t\tMaximum number of threads/processes to support\n");
1502 printf(" --server=args\t\tStart a backend fio server\n");
1503 printf(" --daemonize=pidfile\tBackground fio server, write pid to file\n");
1504 printf(" --client=hostname\tTalk to remote backend fio server at hostname\n");
1505 printf(" --idle-prof=option\tReport cpu idleness on a system or percpu basis\n"
1506 "\t\t\t(option=system,percpu) or run unit work\n"
1507 "\t\t\tcalibration only (option=calibrate)\n");
1508 printf("\nFio was written by Jens Axboe <jens.axboe@oracle.com>");
1509 printf("\n Jens Axboe <jaxboe@fusionio.com>");
1510 printf("\n Jens Axboe <axboe@fb.com>\n");
1513 #ifdef FIO_INC_DEBUG
1514 struct debug_level debug_levels[] = {
1515 { .name = "process",
1516 .help = "Process creation/exit logging",
1517 .shift = FD_PROCESS,
1520 .help = "File related action logging",
1524 .help = "IO and IO engine action logging (offsets, queue, completions, etc)",
1528 .help = "Memory allocation/freeing logging",
1531 { .name = "blktrace",
1532 .help = "blktrace action logging",
1533 .shift = FD_BLKTRACE,
1536 .help = "IO verification action logging",
1540 .help = "Random generation logging",
1544 .help = "Parser logging",
1547 { .name = "diskutil",
1548 .help = "Disk utility logging actions",
1549 .shift = FD_DISKUTIL,
1552 .help = "Logging related to creating/destroying jobs",
1556 .help = "Mutex logging",
1559 { .name = "profile",
1560 .help = "Logging related to profiles",
1561 .shift = FD_PROFILE,
1564 .help = "Logging related to time keeping functions",
1568 .help = "Network logging",
1572 .help = "Rate logging",
1578 static int set_debug(const char *string)
1580 struct debug_level *dl;
1581 char *p = (char *) string;
1585 if (!strcmp(string, "?") || !strcmp(string, "help")) {
1586 log_info("fio: dumping debug options:");
1587 for (i = 0; debug_levels[i].name; i++) {
1588 dl = &debug_levels[i];
1589 log_info("%s,", dl->name);
1595 while ((opt = strsep(&p, ",")) != NULL) {
1598 if (!strncmp(opt, "all", 3)) {
1599 log_info("fio: set all debug options\n");
1604 for (i = 0; debug_levels[i].name; i++) {
1605 dl = &debug_levels[i];
1606 found = !strncmp(opt, dl->name, strlen(dl->name));
1610 if (dl->shift == FD_JOB) {
1611 opt = strchr(opt, ':');
1613 log_err("fio: missing job number\n");
1617 fio_debug_jobno = atoi(opt);
1618 log_info("fio: set debug jobno %d\n",
1621 log_info("fio: set debug option %s\n", opt);
1622 fio_debug |= (1UL << dl->shift);
1628 log_err("fio: debug mask %s not found\n", opt);
1633 static int set_debug(const char *string)
1635 log_err("fio: debug tracing not included in build\n");
1640 static void fio_options_fill_optstring(void)
1642 char *ostr = cmd_optstr;
1646 while (l_opts[i].name) {
1647 ostr[c++] = l_opts[i].val;
1648 if (l_opts[i].has_arg == required_argument)
1650 else if (l_opts[i].has_arg == optional_argument) {
1659 static int client_flag_set(char c)
1664 while (l_opts[i].name) {
1665 int val = l_opts[i].val;
1667 if (c == (val & 0xff))
1668 return (val & FIO_CLIENT_FLAG);
1676 static void parse_cmd_client(void *client, char *opt)
1678 fio_client_add_cmd_option(client, opt);
1681 int parse_cmd_line(int argc, char *argv[], int client_type)
1683 struct thread_data *td = NULL;
1684 int c, ini_idx = 0, lidx, ret = 0, do_exit = 0, exit_val = 0;
1685 char *ostr = cmd_optstr;
1686 void *pid_file = NULL;
1687 void *cur_client = NULL;
1691 * Reset optind handling, since we may call this multiple times
1696 while ((c = getopt_long_only(argc, argv, ostr, l_opts, &lidx)) != -1) {
1699 if ((c & FIO_CLIENT_FLAG) || client_flag_set(c)) {
1700 parse_cmd_client(cur_client, argv[optind - 1]);
1701 c &= ~FIO_CLIENT_FLAG;
1706 smalloc_pool_size = atoi(optarg);
1709 if (check_str_time(optarg, &def_timeout, 1)) {
1710 log_err("fio: failed parsing time %s\n", optarg);
1722 f_out = fopen(optarg, "w+");
1724 perror("fopen output");
1730 output_format = FIO_OUTPUT_TERSE;
1734 log_err("fio: missing --output-format argument\n");
1739 if (!strcmp(optarg, "minimal") ||
1740 !strcmp(optarg, "terse") ||
1741 !strcmp(optarg, "csv"))
1742 output_format = FIO_OUTPUT_TERSE;
1743 else if (!strcmp(optarg, "json"))
1744 output_format = FIO_OUTPUT_JSON;
1746 output_format = FIO_OUTPUT_NORMAL;
1749 append_terse_output = 1;
1759 fio_show_option_help(optarg);
1765 fio_show_ioengine_help(optarg);
1777 log_info("%s\n", fio_version_string);
1782 terse_version = atoi(optarg);
1783 if (!(terse_version == 2 || terse_version == 3 ||
1784 terse_version == 4)) {
1785 log_err("fio: bad terse version format\n");
1791 if (!strcmp("always", optarg))
1792 eta_print = FIO_ETA_ALWAYS;
1793 else if (!strcmp("never", optarg))
1794 eta_print = FIO_ETA_NEVER;
1799 if (str_to_decimal(optarg, &t, 0, NULL, 1)) {
1800 log_err("fio: failed parsing eta time %s\n", optarg);
1808 if (set_debug(optarg))
1817 if (!strcmp(optarg, "global")) {
1818 log_err("fio: can't use global as only "
1824 new_size = (nr_job_sections + 1) * sizeof(char *);
1825 job_sections = realloc(job_sections, new_size);
1826 job_sections[nr_job_sections] = strdup(optarg);
1831 exec_profile = strdup(optarg);
1833 case FIO_GETOPT_JOB: {
1834 const char *opt = l_opts[lidx].name;
1837 if (!strncmp(opt, "name", 4) && td) {
1838 ret = add_job(td, td->o.name ?: "fio", 0, 0, client_type);
1844 int is_section = !strncmp(opt, "name", 4);
1847 if (!is_section || !strncmp(val, "global", 6))
1850 if (is_section && skip_this_section(val))
1853 td = get_new_job(global, &def_thread, 1);
1854 if (!td || ioengine_load(td))
1856 fio_options_set_ioengine_opts(l_opts, td);
1859 if ((!val || !strlen(val)) &&
1860 l_opts[lidx].has_arg == required_argument) {
1861 log_err("fio: option %s requires an argument\n", opt);
1864 ret = fio_cmd_option_parse(td, opt, val);
1874 if (!ret && !strcmp(opt, "ioengine")) {
1876 if (ioengine_load(td))
1878 fio_options_set_ioengine_opts(l_opts, td);
1882 case FIO_GETOPT_IOENGINE: {
1883 const char *opt = l_opts[lidx].name;
1885 ret = fio_cmd_ioengine_option_parse(td, opt, val);
1892 max_jobs = atoi(optarg);
1893 if (!max_jobs || max_jobs > REAL_MAX_JOBS) {
1894 log_err("fio: invalid max jobs: %d\n", max_jobs);
1901 log_err("fio: can't be both client and server\n");
1907 fio_server_set_arg(optarg);
1912 pid_file = strdup(optarg);
1915 if ((ret = fio_idle_prof_parse_opt(optarg))) {
1916 /* exit on error and calibration only */
1924 log_err("fio: can't be both client and server\n");
1929 if (fio_client_add(&fio_client_ops, optarg, &cur_client)) {
1930 log_err("fio: failed adding client %s\n", optarg);
1936 * If the next argument exists and isn't an option,
1937 * assume it's a job file for this client only.
1939 while (optind < argc) {
1940 if (!strncmp(argv[optind], "--", 2) ||
1941 !strncmp(argv[optind], "-", 1))
1944 fio_client_add_ini_file(cur_client, argv[optind]);
1950 exit_val = fio_monotonic_clocktest();
1954 exit_val = fio_crctest(optarg);
1959 if (check_str_time(optarg, &val, 0)) {
1960 log_err("fio: failed parsing time %s\n", optarg);
1965 status_interval = val * 1000;
1969 log_err("%s: unrecognized option '%s'\n", argv[0],
1980 if (do_exit && !(is_backend || nr_clients))
1983 if (nr_clients && fio_clients_connect())
1986 if (is_backend && backend)
1987 return fio_start_server(pid_file);
1991 ret = add_job(td, td->o.name ?: "fio", 0, 0, client_type);
1994 while (!ret && optind < argc) {
1996 ini_file = realloc(ini_file, ini_idx * sizeof(char *));
1997 ini_file[ini_idx - 1] = strdup(argv[optind]);
2004 int fio_init_options(void)
2009 fio_options_fill_optstring();
2010 fio_options_dup_and_init(l_opts);
2014 if (fill_def_thread())
2020 extern int fio_check_options(struct thread_options *);
2022 int parse_options(int argc, char *argv[])
2024 const int type = FIO_CLIENT_TYPE_CLI;
2027 if (fio_init_options())
2029 if (fio_test_cconv(&def_thread.o))
2030 log_err("fio: failed internal cconv test\n");
2032 job_files = parse_cmd_line(argc, argv, type);
2034 if (job_files > 0) {
2035 for (i = 0; i < job_files; i++) {
2036 if (i && fill_def_thread())
2039 if (fio_clients_send_ini(ini_file[i]))
2042 } else if (!is_backend) {
2043 if (parse_jobs_ini(ini_file[i], 0, i, type))
2048 } else if (nr_clients) {
2049 if (fill_def_thread())
2051 if (fio_clients_send_ini(NULL))
2056 fio_options_free(&def_thread);
2057 filesetup_mem_free();
2059 if (!thread_number) {
2064 if (is_backend || nr_clients)
2069 log_err("No jobs(s) defined\n\n");
2079 if (def_thread.o.gtod_offload) {
2081 fio_gtod_offload = 1;
2082 fio_gtod_cpu = def_thread.o.gtod_cpu;
2085 if (output_format == FIO_OUTPUT_NORMAL)
2086 log_info("%s\n", fio_version_string);
2091 void options_default_fill(struct thread_options *o)
2093 memcpy(o, &def_thread.o, sizeof(*o));