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 eta_print = FIO_ETA_AUTO;
50 char **job_sections = NULL;
51 int nr_job_sections = 0;
52 char *exec_profile = NULL;
53 int warnings_fatal = 0;
54 int terse_version = 3;
61 int status_interval = 0;
63 static int write_lat_log;
65 static int prev_group_jobs;
67 unsigned long fio_debug = 0;
68 unsigned int fio_debug_jobno = -1;
69 unsigned int *fio_debug_jobp = NULL;
71 static char cmd_optstr[256];
74 #define FIO_CLIENT_FLAG (1 << 16)
77 * Command line options. These will contain the above, plus a few
78 * extra that only pertain to fio itself and not jobs.
80 static struct option l_opts[FIO_NR_OPTIONS] = {
82 .name = (char *) "output",
83 .has_arg = required_argument,
84 .val = 'o' | FIO_CLIENT_FLAG,
87 .name = (char *) "timeout",
88 .has_arg = required_argument,
89 .val = 't' | FIO_CLIENT_FLAG,
92 .name = (char *) "latency-log",
93 .has_arg = required_argument,
94 .val = 'l' | FIO_CLIENT_FLAG,
97 .name = (char *) "bandwidth-log",
98 .has_arg = required_argument,
99 .val = 'b' | FIO_CLIENT_FLAG,
102 .name = (char *) "minimal",
103 .has_arg = no_argument,
104 .val = 'm' | FIO_CLIENT_FLAG,
107 .name = (char *) "output-format",
108 .has_arg = optional_argument,
109 .val = 'F' | FIO_CLIENT_FLAG,
112 .name = (char *) "version",
113 .has_arg = no_argument,
114 .val = 'v' | FIO_CLIENT_FLAG,
117 .name = (char *) "help",
118 .has_arg = no_argument,
119 .val = 'h' | FIO_CLIENT_FLAG,
122 .name = (char *) "cmdhelp",
123 .has_arg = optional_argument,
124 .val = 'c' | FIO_CLIENT_FLAG,
127 .name = (char *) "enghelp",
128 .has_arg = optional_argument,
129 .val = 'i' | FIO_CLIENT_FLAG,
132 .name = (char *) "showcmd",
133 .has_arg = no_argument,
134 .val = 's' | FIO_CLIENT_FLAG,
137 .name = (char *) "readonly",
138 .has_arg = no_argument,
139 .val = 'r' | FIO_CLIENT_FLAG,
142 .name = (char *) "eta",
143 .has_arg = required_argument,
144 .val = 'e' | FIO_CLIENT_FLAG,
147 .name = (char *) "eta-newline",
148 .has_arg = required_argument,
149 .val = 'E' | FIO_CLIENT_FLAG,
152 .name = (char *) "debug",
153 .has_arg = required_argument,
154 .val = 'd' | FIO_CLIENT_FLAG,
157 .name = (char *) "parse-only",
158 .has_arg = no_argument,
159 .val = 'P' | FIO_CLIENT_FLAG,
162 .name = (char *) "section",
163 .has_arg = required_argument,
164 .val = 'x' | FIO_CLIENT_FLAG,
167 .name = (char *) "alloc-size",
168 .has_arg = required_argument,
169 .val = 'a' | FIO_CLIENT_FLAG,
172 .name = (char *) "profile",
173 .has_arg = required_argument,
174 .val = 'p' | FIO_CLIENT_FLAG,
177 .name = (char *) "warnings-fatal",
178 .has_arg = no_argument,
179 .val = 'w' | FIO_CLIENT_FLAG,
182 .name = (char *) "max-jobs",
183 .has_arg = required_argument,
184 .val = 'j' | FIO_CLIENT_FLAG,
187 .name = (char *) "terse-version",
188 .has_arg = required_argument,
189 .val = 'V' | FIO_CLIENT_FLAG,
192 .name = (char *) "server",
193 .has_arg = optional_argument,
196 { .name = (char *) "daemonize",
197 .has_arg = required_argument,
201 .name = (char *) "client",
202 .has_arg = required_argument,
206 .name = (char *) "cpuclock-test",
207 .has_arg = no_argument,
211 .name = (char *) "crctest",
212 .has_arg = optional_argument,
216 .name = (char *) "idle-prof",
217 .has_arg = required_argument,
221 .name = (char *) "status-interval",
222 .has_arg = required_argument,
230 void free_threads_shm(void)
232 struct shmid_ds sbuf;
239 shmctl(shm_id, IPC_RMID, &sbuf);
249 fio_debug_jobp = NULL;
253 options_free(fio_options, &def_thread);
258 * The thread area is shared between the main process and the job
259 * threads/processes. So setup a shared memory segment that will hold
260 * all the job info. We use the end of the region for keeping track of
261 * open files across jobs, for file sharing.
263 static int setup_thread_area(void)
271 * 1024 is too much on some machines, scale max_jobs if
272 * we get a failure that looks like too large a shm segment
275 size_t size = max_jobs * sizeof(struct thread_data);
277 size += file_hash_size;
278 size += sizeof(unsigned int);
280 shm_id = shmget(0, size, IPC_CREAT | 0600);
283 if (errno != EINVAL && errno != ENOMEM && errno != ENOSPC) {
294 threads = shmat(shm_id, NULL, 0);
295 if (threads == (void *) -1) {
300 memset(threads, 0, max_jobs * sizeof(struct thread_data));
301 hash = (void *) threads + max_jobs * sizeof(struct thread_data);
302 fio_debug_jobp = (void *) hash + file_hash_size;
303 *fio_debug_jobp = -1;
304 file_hash_init(hash);
312 * Return a free job structure.
314 static struct thread_data *get_new_job(int global, struct thread_data *parent,
317 struct thread_data *td;
321 if (setup_thread_area()) {
322 log_err("error: failed to setup shm segment\n");
325 if (thread_number >= max_jobs) {
326 log_err("error: maximum number of jobs (%d) reached.\n",
331 td = &threads[thread_number++];
338 td->o.uid = td->o.gid = -1U;
340 dup_files(td, parent);
341 fio_options_mem_dupe(td);
343 profile_add_hooks(td);
345 td->thread_number = thread_number;
347 if (!parent || !parent->o.group_reporting)
353 static void put_job(struct thread_data *td)
355 if (td == &def_thread)
362 log_info("fio: %s\n", td->verror);
364 fio_options_free(td);
368 memset(&threads[td->thread_number - 1], 0, sizeof(*td));
372 static int __setup_rate(struct thread_data *td, enum fio_ddir ddir)
374 unsigned int bs = td->o.min_bs[ddir];
376 assert(ddir_rw(ddir));
378 if (td->o.rate[ddir])
379 td->rate_bps[ddir] = td->o.rate[ddir];
381 td->rate_bps[ddir] = td->o.rate_iops[ddir] * bs;
383 if (!td->rate_bps[ddir]) {
384 log_err("rate lower than supported\n");
388 td->rate_pending_usleep[ddir] = 0;
392 static int setup_rate(struct thread_data *td)
396 if (td->o.rate[DDIR_READ] || td->o.rate_iops[DDIR_READ])
397 ret = __setup_rate(td, DDIR_READ);
398 if (td->o.rate[DDIR_WRITE] || td->o.rate_iops[DDIR_WRITE])
399 ret |= __setup_rate(td, DDIR_WRITE);
400 if (td->o.rate[DDIR_TRIM] || td->o.rate_iops[DDIR_TRIM])
401 ret |= __setup_rate(td, DDIR_TRIM);
406 static int fixed_block_size(struct thread_options *o)
408 return o->min_bs[DDIR_READ] == o->max_bs[DDIR_READ] &&
409 o->min_bs[DDIR_WRITE] == o->max_bs[DDIR_WRITE] &&
410 o->min_bs[DDIR_TRIM] == o->max_bs[DDIR_TRIM] &&
411 o->min_bs[DDIR_READ] == o->min_bs[DDIR_WRITE] &&
412 o->min_bs[DDIR_READ] == o->min_bs[DDIR_TRIM];
416 static unsigned long long get_rand_start_delay(struct thread_data *td)
418 unsigned long long delayrange;
421 delayrange = td->o.start_delay_high - td->o.start_delay;
423 if (td->o.use_os_rand) {
424 r = os_random_long(&td->delay_state);
425 delayrange = (unsigned long long) ((double) delayrange * (r / (OS_RAND_MAX + 1.0)));
427 r = __rand(&td->__delay_state);
428 delayrange = (unsigned long long) ((double) delayrange * (r / (FRAND_MAX + 1.0)));
431 delayrange += td->o.start_delay;
436 * Lazy way of fixing up options that depend on each other. We could also
437 * define option callback handlers, but this is easier.
439 static int fixup_options(struct thread_data *td)
441 struct thread_options *o = &td->o;
444 #ifndef FIO_HAVE_PSHARED_MUTEX
445 if (!o->use_thread) {
446 log_info("fio: this platform does not support process shared"
447 " mutexes, forcing use of threads. Use the 'thread'"
448 " option to get rid of this warning.\n");
450 ret = warnings_fatal;
454 if (o->write_iolog_file && o->read_iolog_file) {
455 log_err("fio: read iolog overrides write_iolog\n");
456 free(o->write_iolog_file);
457 o->write_iolog_file = NULL;
458 ret = warnings_fatal;
462 * only really works with 1 file
464 if (o->zone_size && o->open_files > 1)
468 * If zone_range isn't specified, backward compatibility dictates it
469 * should be made equal to zone_size.
471 if (o->zone_size && !o->zone_range)
472 o->zone_range = o->zone_size;
475 * Reads can do overwrites, we always need to pre-create the file
477 if (td_read(td) || td_rw(td))
480 if (!o->min_bs[DDIR_READ])
481 o->min_bs[DDIR_READ] = o->bs[DDIR_READ];
482 if (!o->max_bs[DDIR_READ])
483 o->max_bs[DDIR_READ] = o->bs[DDIR_READ];
484 if (!o->min_bs[DDIR_WRITE])
485 o->min_bs[DDIR_WRITE] = o->bs[DDIR_WRITE];
486 if (!o->max_bs[DDIR_WRITE])
487 o->max_bs[DDIR_WRITE] = o->bs[DDIR_WRITE];
488 if (!o->min_bs[DDIR_TRIM])
489 o->min_bs[DDIR_TRIM] = o->bs[DDIR_TRIM];
490 if (!o->max_bs[DDIR_TRIM])
491 o->max_bs[DDIR_TRIM] = o->bs[DDIR_TRIM];
494 o->rw_min_bs = min(o->min_bs[DDIR_READ], o->min_bs[DDIR_WRITE]);
495 o->rw_min_bs = min(o->min_bs[DDIR_TRIM], o->rw_min_bs);
498 * For random IO, allow blockalign offset other than min_bs.
500 if (!o->ba[DDIR_READ] || !td_random(td))
501 o->ba[DDIR_READ] = o->min_bs[DDIR_READ];
502 if (!o->ba[DDIR_WRITE] || !td_random(td))
503 o->ba[DDIR_WRITE] = o->min_bs[DDIR_WRITE];
504 if (!o->ba[DDIR_TRIM] || !td_random(td))
505 o->ba[DDIR_TRIM] = o->min_bs[DDIR_TRIM];
507 if ((o->ba[DDIR_READ] != o->min_bs[DDIR_READ] ||
508 o->ba[DDIR_WRITE] != o->min_bs[DDIR_WRITE] ||
509 o->ba[DDIR_TRIM] != o->min_bs[DDIR_TRIM]) &&
511 log_err("fio: Any use of blockalign= turns off randommap\n");
513 ret = warnings_fatal;
516 if (!o->file_size_high)
517 o->file_size_high = o->file_size_low;
519 if (o->start_delay_high)
520 o->start_delay = get_rand_start_delay(td);
522 if (o->norandommap && o->verify != VERIFY_NONE
523 && !fixed_block_size(o)) {
524 log_err("fio: norandommap given for variable block sizes, "
525 "verify disabled\n");
526 o->verify = VERIFY_NONE;
527 ret = warnings_fatal;
529 if (o->bs_unaligned && (o->odirect || td->io_ops->flags & FIO_RAWIO))
530 log_err("fio: bs_unaligned may not work with raw io\n");
533 * thinktime_spin must be less than thinktime
535 if (o->thinktime_spin > o->thinktime)
536 o->thinktime_spin = o->thinktime;
539 * The low water mark cannot be bigger than the iodepth
541 if (o->iodepth_low > o->iodepth || !o->iodepth_low)
542 o->iodepth_low = o->iodepth;
545 * If batch number isn't set, default to the same as iodepth
547 if (o->iodepth_batch > o->iodepth || !o->iodepth_batch)
548 o->iodepth_batch = o->iodepth;
550 if (o->nr_files > td->files_index)
551 o->nr_files = td->files_index;
553 if (o->open_files > o->nr_files || !o->open_files)
554 o->open_files = o->nr_files;
556 if (((o->rate[DDIR_READ] + o->rate[DDIR_WRITE] + o->rate[DDIR_TRIM]) &&
557 (o->rate_iops[DDIR_READ] + o->rate_iops[DDIR_WRITE] + o->rate_iops[DDIR_TRIM])) ||
558 ((o->ratemin[DDIR_READ] + o->ratemin[DDIR_WRITE] + o->ratemin[DDIR_TRIM]) &&
559 (o->rate_iops_min[DDIR_READ] + o->rate_iops_min[DDIR_WRITE] + o->rate_iops_min[DDIR_TRIM]))) {
560 log_err("fio: rate and rate_iops are mutually exclusive\n");
563 if ((o->rate[DDIR_READ] < o->ratemin[DDIR_READ]) ||
564 (o->rate[DDIR_WRITE] < o->ratemin[DDIR_WRITE]) ||
565 (o->rate[DDIR_TRIM] < o->ratemin[DDIR_TRIM]) ||
566 (o->rate_iops[DDIR_READ] < o->rate_iops_min[DDIR_READ]) ||
567 (o->rate_iops[DDIR_WRITE] < o->rate_iops_min[DDIR_WRITE]) ||
568 (o->rate_iops[DDIR_TRIM] < o->rate_iops_min[DDIR_TRIM])) {
569 log_err("fio: minimum rate exceeds rate\n");
573 if (!o->timeout && o->time_based) {
574 log_err("fio: time_based requires a runtime/timeout setting\n");
576 ret = warnings_fatal;
579 if (o->fill_device && !o->size)
582 if (o->verify != VERIFY_NONE) {
583 if (td_write(td) && o->do_verify && o->numjobs > 1) {
584 log_info("Multiple writers may overwrite blocks that "
585 "belong to other jobs. This can cause "
586 "verification failures.\n");
587 ret = warnings_fatal;
590 o->refill_buffers = 1;
591 if (o->max_bs[DDIR_WRITE] != o->min_bs[DDIR_WRITE] &&
593 o->verify_interval = o->min_bs[DDIR_WRITE];
597 o->invalidate_cache = 0;
598 if (td->io_ops->flags & FIO_PIPEIO) {
599 log_info("fio: cannot pre-read files with an IO engine"
600 " that isn't seekable. Pre-read disabled.\n");
601 ret = warnings_fatal;
606 if (td->io_ops->flags & FIO_BIT_BASED)
612 #ifndef CONFIG_FDATASYNC
613 if (o->fdatasync_blocks) {
614 log_info("fio: this platform does not support fdatasync()"
615 " falling back to using fsync(). Use the 'fsync'"
616 " option instead of 'fdatasync' to get rid of"
618 o->fsync_blocks = o->fdatasync_blocks;
619 o->fdatasync_blocks = 0;
620 ret = warnings_fatal;
626 * Windows doesn't support O_DIRECT or O_SYNC with the _open interface,
627 * so fail if we're passed those flags
629 if ((td->io_ops->flags & FIO_SYNCIO) && (td->o.odirect || td->o.sync_io)) {
630 log_err("fio: Windows does not support direct or non-buffered io with"
631 " the synchronous ioengines. Use the 'windowsaio' ioengine"
632 " with 'direct=1' and 'iodepth=1' instead.\n");
638 * For fully compressible data, just zero them at init time.
639 * It's faster than repeatedly filling it.
641 if (td->o.compress_percentage == 100) {
642 td->o.zero_buffers = 1;
643 td->o.compress_percentage = 0;
647 * Using a non-uniform random distribution excludes usage of
650 if (td->o.random_distribution != FIO_RAND_DIST_RANDOM)
651 td->o.norandommap = 1;
654 * If size is set but less than the min block size, complain
656 if (o->size && o->size < td_min_bs(td)) {
657 log_err("fio: size too small, must be larger than the IO size: %llu\n", (unsigned long long) o->size);
662 * O_ATOMIC implies O_DIRECT
668 * If randseed is set, that overrides randrepeat
671 td->o.rand_repeatable = 0;
677 * This function leaks the buffer
679 char *fio_uint_to_kmg(unsigned int val)
681 char *buf = malloc(32);
682 char post[] = { 0, 'K', 'M', 'G', 'P', 'E', 0 };
693 snprintf(buf, 32, "%u%c", val, *p);
697 /* External engines are specified by "external:name.o") */
698 static const char *get_engine_name(const char *str)
700 char *p = strstr(str, ":");
706 strip_blank_front(&p);
711 static int exists_and_not_file(const char *filename)
715 if (lstat(filename, &sb) == -1)
718 /* \\.\ is the device namespace in Windows, where every file
719 * is a device node */
720 if (S_ISREG(sb.st_mode) && strncmp(filename, "\\\\.\\", 4) != 0)
726 static void td_fill_rand_seeds_os(struct thread_data *td)
728 os_random_seed(td->rand_seeds[FIO_RAND_BS_OFF], &td->bsrange_state);
729 os_random_seed(td->rand_seeds[FIO_RAND_VER_OFF], &td->verify_state);
730 os_random_seed(td->rand_seeds[FIO_RAND_MIX_OFF], &td->rwmix_state);
732 if (td->o.file_service_type == FIO_FSERVICE_RANDOM)
733 os_random_seed(td->rand_seeds[FIO_RAND_FILE_OFF], &td->next_file_state);
735 os_random_seed(td->rand_seeds[FIO_RAND_FILE_SIZE_OFF], &td->file_size_state);
736 os_random_seed(td->rand_seeds[FIO_RAND_TRIM_OFF], &td->trim_state);
737 os_random_seed(td->rand_seeds[FIO_RAND_START_DELAY], &td->delay_state);
742 if (td->o.rand_repeatable)
743 td->rand_seeds[FIO_RAND_BLOCK_OFF] = FIO_RANDSEED * td->thread_number;
745 os_random_seed(td->rand_seeds[FIO_RAND_BLOCK_OFF], &td->random_state);
747 os_random_seed(td->rand_seeds[FIO_RAND_SEQ_RAND_READ_OFF], &td->seq_rand_state[DDIR_READ]);
748 os_random_seed(td->rand_seeds[FIO_RAND_SEQ_RAND_WRITE_OFF], &td->seq_rand_state[DDIR_WRITE]);
749 os_random_seed(td->rand_seeds[FIO_RAND_SEQ_RAND_TRIM_OFF], &td->seq_rand_state[DDIR_TRIM]);
752 static void td_fill_rand_seeds_internal(struct thread_data *td)
754 init_rand_seed(&td->__bsrange_state, td->rand_seeds[FIO_RAND_BS_OFF]);
755 init_rand_seed(&td->__verify_state, td->rand_seeds[FIO_RAND_VER_OFF]);
756 init_rand_seed(&td->__rwmix_state, td->rand_seeds[FIO_RAND_MIX_OFF]);
758 if (td->o.file_service_type == FIO_FSERVICE_RANDOM)
759 init_rand_seed(&td->__next_file_state, td->rand_seeds[FIO_RAND_FILE_OFF]);
761 init_rand_seed(&td->__file_size_state, td->rand_seeds[FIO_RAND_FILE_SIZE_OFF]);
762 init_rand_seed(&td->__trim_state, td->rand_seeds[FIO_RAND_TRIM_OFF]);
763 init_rand_seed(&td->__delay_state, td->rand_seeds[FIO_RAND_START_DELAY]);
768 if (td->o.rand_repeatable)
769 td->rand_seeds[FIO_RAND_BLOCK_OFF] = FIO_RANDSEED * td->thread_number;
771 init_rand_seed(&td->__random_state, td->rand_seeds[FIO_RAND_BLOCK_OFF]);
772 init_rand_seed(&td->__seq_rand_state[DDIR_READ], td->rand_seeds[FIO_RAND_SEQ_RAND_READ_OFF]);
773 init_rand_seed(&td->__seq_rand_state[DDIR_WRITE], td->rand_seeds[FIO_RAND_SEQ_RAND_WRITE_OFF]);
774 init_rand_seed(&td->__seq_rand_state[DDIR_TRIM], td->rand_seeds[FIO_RAND_SEQ_RAND_TRIM_OFF]);
777 void td_fill_rand_seeds(struct thread_data *td)
779 if (td->o.allrand_repeatable) {
780 for (int i = 0; i < FIO_RAND_NR_OFFS; i++)
781 td->rand_seeds[i] = FIO_RANDSEED * td->thread_number
785 if (td->o.use_os_rand)
786 td_fill_rand_seeds_os(td);
788 td_fill_rand_seeds_internal(td);
790 init_rand_seed(&td->buf_state, td->rand_seeds[FIO_RAND_BUF_OFF]);
794 * Initializes the ioengine configured for a job, if it has not been done so
797 int ioengine_load(struct thread_data *td)
802 * Engine has already been loaded.
806 if (!td->o.ioengine) {
807 log_err("fio: internal fault, no IO engine specified\n");
811 engine = get_engine_name(td->o.ioengine);
812 td->io_ops = load_ioengine(td, engine);
814 log_err("fio: failed to load engine %s\n", engine);
818 if (td->io_ops->option_struct_size && td->io_ops->options) {
820 * In cases where td->eo is set, clone it for a child thread.
821 * This requires that the parent thread has the same ioengine,
822 * but that requirement must be enforced by the code which
825 void *origeo = td->eo;
827 * Otherwise use the default thread options.
829 if (!origeo && td != &def_thread && def_thread.eo &&
830 def_thread.io_ops->options == td->io_ops->options)
831 origeo = def_thread.eo;
833 options_init(td->io_ops->options);
834 td->eo = malloc(td->io_ops->option_struct_size);
836 * Use the default thread as an option template if this uses the
837 * same options structure and there are non-default options
841 memcpy(td->eo, origeo, td->io_ops->option_struct_size);
842 options_mem_dupe(td->eo, td->io_ops->options);
844 memset(td->eo, 0, td->io_ops->option_struct_size);
845 fill_default_options(td->eo, td->io_ops->options);
847 *(struct thread_data **)td->eo = td;
853 static void init_flags(struct thread_data *td)
855 struct thread_options *o = &td->o;
857 if (o->verify_backlog)
858 td->flags |= TD_F_VER_BACKLOG;
860 td->flags |= TD_F_TRIM_BACKLOG;
861 if (o->read_iolog_file)
862 td->flags |= TD_F_READ_IOLOG;
863 if (o->refill_buffers)
864 td->flags |= TD_F_REFILL_BUFFERS;
865 if (o->scramble_buffers)
866 td->flags |= TD_F_SCRAMBLE_BUFFERS;
867 if (o->verify != VERIFY_NONE)
868 td->flags |= TD_F_VER_NONE;
871 static int setup_random_seeds(struct thread_data *td)
876 if (!td->o.rand_repeatable && !td->o.rand_seed)
877 return init_random_state(td, td->rand_seeds, sizeof(td->rand_seeds));
879 if (!td->o.rand_seed)
882 seed = td->o.rand_seed;
884 for (i = 0; i < 4; i++)
885 seed *= 0x9e370001UL;
887 for (i = 0; i < FIO_RAND_NR_OFFS; i++) {
888 td->rand_seeds[i] = seed;
889 seed *= 0x9e370001UL;
892 td_fill_rand_seeds(td);
903 static struct fpre_keyword {
907 } fpre_keywords[] = {
908 { .keyword = "$jobname", .key = FPRE_JOBNAME, },
909 { .keyword = "$jobnum", .key = FPRE_JOBNUM, },
910 { .keyword = "$filenum", .key = FPRE_FILENUM, },
911 { .keyword = NULL, },
914 static char *make_filename(char *buf, struct thread_options *o,
915 const char *jobname, int jobnum, int filenum)
917 struct fpre_keyword *f;
920 if (!o->filename_format || !strlen(o->filename_format)) {
921 sprintf(buf, "%s.%d.%d", jobname, jobnum, filenum);
925 for (f = &fpre_keywords[0]; f->keyword; f++)
926 f->strlen = strlen(f->keyword);
928 strcpy(buf, o->filename_format);
929 memset(copy, 0, sizeof(copy));
930 for (f = &fpre_keywords[0]; f->keyword; f++) {
932 size_t pre_len, post_start = 0;
933 char *str, *dst = copy;
935 str = strcasestr(buf, f->keyword);
940 if (strlen(str) != f->strlen)
941 post_start = pre_len + f->strlen;
944 strncpy(dst, buf, pre_len);
950 dst += sprintf(dst, "%s", jobname);
953 dst += sprintf(dst, "%d", jobnum);
956 dst += sprintf(dst, "%d", filenum);
964 strcpy(dst, buf + post_start);
973 int parse_dryrun(void)
975 return dump_cmdline || parse_only;
979 * Adds a job to the list of things todo. Sanitizes the various options
980 * to make sure we don't have conflicts, and initializes various
983 static int add_job(struct thread_data *td, const char *jobname, int job_add_num,
984 int recursed, int client_type)
987 char fname[PATH_MAX];
988 int numjobs, file_alloced;
989 struct thread_options *o = &td->o;
992 * the def_thread is just for options, it's not a real job
994 if (td == &def_thread)
1000 * if we are just dumping the output command line, don't add the job
1002 if (parse_dryrun()) {
1007 td->client_type = client_type;
1009 if (profile_td_init(td))
1012 if (ioengine_load(td))
1016 td->io_ops->flags |= FIO_RAWIO;
1019 if (!o->filename && !td->files_index && !o->read_iolog_file) {
1022 if (o->nr_files == 1 && exists_and_not_file(jobname))
1023 add_file(td, jobname, job_add_num);
1025 for (i = 0; i < o->nr_files; i++)
1026 add_file(td, make_filename(fname, o, jobname, job_add_num, i), job_add_num);
1030 if (fixup_options(td))
1036 * IO engines only need this for option callbacks, and the address may
1037 * change in subprocesses.
1040 *(struct thread_data **)td->eo = NULL;
1042 if (td->io_ops->flags & FIO_DISKLESSIO) {
1045 for_each_file(td, f, i)
1046 f->real_file_size = -1ULL;
1049 td->mutex = fio_mutex_init(FIO_MUTEX_LOCKED);
1051 td->ts.clat_percentiles = o->clat_percentiles;
1052 td->ts.percentile_precision = o->percentile_precision;
1053 memcpy(td->ts.percentile_list, o->percentile_list, sizeof(o->percentile_list));
1055 for (i = 0; i < DDIR_RWDIR_CNT; i++) {
1056 td->ts.clat_stat[i].min_val = ULONG_MAX;
1057 td->ts.slat_stat[i].min_val = ULONG_MAX;
1058 td->ts.lat_stat[i].min_val = ULONG_MAX;
1059 td->ts.bw_stat[i].min_val = ULONG_MAX;
1061 td->ddir_seq_nr = o->ddir_seq_nr;
1063 if ((o->stonewall || o->new_group) && prev_group_jobs) {
1064 prev_group_jobs = 0;
1068 td->groupid = groupid;
1071 if (setup_random_seeds(td)) {
1072 td_verror(td, errno, "init_random_state");
1079 if (o->lat_log_file) {
1080 setup_log(&td->lat_log, o->log_avg_msec, IO_LOG_TYPE_LAT);
1081 setup_log(&td->slat_log, o->log_avg_msec, IO_LOG_TYPE_SLAT);
1082 setup_log(&td->clat_log, o->log_avg_msec, IO_LOG_TYPE_CLAT);
1085 setup_log(&td->bw_log, o->log_avg_msec, IO_LOG_TYPE_BW);
1086 if (o->iops_log_file)
1087 setup_log(&td->iops_log, o->log_avg_msec, IO_LOG_TYPE_IOPS);
1090 o->name = strdup(jobname);
1092 if (output_format == FIO_OUTPUT_NORMAL) {
1094 if (is_backend && !recursed)
1095 fio_server_send_add_job(td);
1097 if (!(td->io_ops->flags & FIO_NOIO)) {
1098 char *c1, *c2, *c3, *c4;
1099 char *c5 = NULL, *c6 = NULL;
1101 c1 = fio_uint_to_kmg(o->min_bs[DDIR_READ]);
1102 c2 = fio_uint_to_kmg(o->max_bs[DDIR_READ]);
1103 c3 = fio_uint_to_kmg(o->min_bs[DDIR_WRITE]);
1104 c4 = fio_uint_to_kmg(o->max_bs[DDIR_WRITE]);
1106 if (!o->bs_is_seq_rand) {
1107 c5 = fio_uint_to_kmg(o->min_bs[DDIR_TRIM]);
1108 c6 = fio_uint_to_kmg(o->max_bs[DDIR_TRIM]);
1111 log_info("%s: (g=%d): rw=%s, ", td->o.name,
1113 ddir_str(o->td_ddir));
1115 if (o->bs_is_seq_rand)
1116 log_info("bs(seq/rand)=%s-%s/%s-%s, ",
1119 log_info("bs=%s-%s/%s-%s/%s-%s, ",
1120 c1, c2, c3, c4, c5, c6);
1122 log_info("ioengine=%s, iodepth=%u\n",
1123 td->io_ops->name, o->iodepth);
1132 } else if (job_add_num == 1)
1137 * recurse add identical jobs, clear numjobs and stonewall options
1138 * as they don't apply to sub-jobs
1140 numjobs = o->numjobs;
1142 struct thread_data *td_new = get_new_job(0, td, 1);
1147 td_new->o.numjobs = 1;
1148 td_new->o.stonewall = 0;
1149 td_new->o.new_group = 0;
1152 td_new->files_index = 0;
1153 td_new->files_size = 0;
1154 if (td_new->files) {
1156 for_each_file(td_new, f, i) {
1161 td_new->files = NULL;
1163 if (td_new->o.filename) {
1164 free(td_new->o.filename);
1165 td_new->o.filename = NULL;
1169 if (add_job(td_new, jobname, numjobs, 1, client_type))
1180 * Parse as if 'o' was a command line
1182 void add_job_opts(const char **o, int client_type)
1184 struct thread_data *td, *td_parent;
1185 int i, in_global = 1;
1189 td_parent = td = NULL;
1191 if (!strncmp(o[i], "name", 4)) {
1194 add_job(td, jobname, 0, 0, client_type);
1196 sprintf(jobname, "%s", o[i] + 5);
1198 if (in_global && !td_parent)
1199 td_parent = get_new_job(1, &def_thread, 0);
1200 else if (!in_global && !td) {
1202 td_parent = &def_thread;
1203 td = get_new_job(0, td_parent, 0);
1206 fio_options_parse(td_parent, (char **) &o[i], 1, 0);
1208 fio_options_parse(td, (char **) &o[i], 1, 0);
1213 add_job(td, jobname, 0, 0, client_type);
1216 static int skip_this_section(const char *name)
1220 if (!nr_job_sections)
1222 if (!strncmp(name, "global", 6))
1225 for (i = 0; i < nr_job_sections; i++)
1226 if (!strcmp(job_sections[i], name))
1232 static int is_empty_or_comment(char *line)
1236 for (i = 0; i < strlen(line); i++) {
1241 if (!isspace((int) line[i]) && !iscntrl((int) line[i]))
1249 * This is our [ini] type file parser.
1251 int parse_jobs_ini(char *file, int is_buf, int stonewall_flag, int type)
1253 unsigned int global;
1254 struct thread_data *td;
1255 char *string, *name;
1258 int ret = 0, stonewall;
1261 int inside_skip = 0;
1263 int i, alloc_opts, num_opts;
1268 if (!strcmp(file, "-"))
1271 f = fopen(file, "r");
1274 perror("fopen job file");
1279 string = malloc(4096);
1282 * it's really 256 + small bit, 280 should suffice
1285 memset(name, 0, 280);
1288 opts = malloc(sizeof(char *) * alloc_opts);
1291 stonewall = stonewall_flag;
1294 * if skip_fgets is set, we already have loaded a line we
1299 p = strsep(&file, "\n");
1301 p = fgets(string, 4096, f);
1307 strip_blank_front(&p);
1310 if (is_empty_or_comment(p))
1312 if (sscanf(p, "[%255[^\n]]", name) != 1) {
1315 log_err("fio: option <%s> outside of [] job section\n",
1320 name[strlen(name) - 1] = '\0';
1322 if (skip_this_section(name)) {
1328 global = !strncmp(name, "global", 6);
1334 log_info("--name=%s ", name);
1338 td = get_new_job(global, &def_thread, 0);
1345 * Separate multiple job files by a stonewall
1347 if (!global && stonewall) {
1348 td->o.stonewall = stonewall;
1353 memset(opts, 0, alloc_opts * sizeof(char *));
1357 p = strsep(&file, "\n");
1359 p = fgets(string, 4096, f);
1363 if (is_empty_or_comment(p))
1366 strip_blank_front(&p);
1369 * new section, break out and make sure we don't
1370 * fgets() a new line at the top.
1379 if (num_opts == alloc_opts) {
1381 opts = realloc(opts,
1382 alloc_opts * sizeof(char *));
1385 opts[num_opts] = strdup(p);
1389 ret = fio_options_parse(td, opts, num_opts, dump_cmdline);
1391 ret = add_job(td, name, 0, 0, type);
1393 log_err("fio: job %s dropped\n", name);
1397 for (i = 0; i < num_opts; i++)
1406 while (i < nr_job_sections) {
1407 free(job_sections[i]);
1411 for (i = 0; i < num_opts; i++)
1417 if (!is_buf && f != stdin)
1422 static int fill_def_thread(void)
1424 memset(&def_thread, 0, sizeof(def_thread));
1426 fio_getaffinity(getpid(), &def_thread.o.cpumask);
1427 def_thread.o.timeout = def_timeout;
1428 def_thread.o.error_dump = 1;
1430 * fill default options
1432 fio_fill_default_options(&def_thread);
1436 static void usage(const char *name)
1438 printf("%s\n", fio_version_string);
1439 printf("%s [options] [job options] <job file(s)>\n", name);
1440 printf(" --debug=options\tEnable debug logging. May be one/more of:\n"
1441 "\t\t\tprocess,file,io,mem,blktrace,verify,random,parse,\n"
1442 "\t\t\tdiskutil,job,mutex,profile,time,net,rate\n");
1443 printf(" --parse-only\t\tParse options only, don't start any IO\n");
1444 printf(" --output\t\tWrite output to file\n");
1445 printf(" --runtime\t\tRuntime in seconds\n");
1446 printf(" --latency-log\t\tGenerate per-job latency logs\n");
1447 printf(" --bandwidth-log\tGenerate per-job bandwidth logs\n");
1448 printf(" --minimal\t\tMinimal (terse) output\n");
1449 printf(" --output-format=x\tOutput format (terse,json,normal)\n");
1450 printf(" --terse-version=x\tSet terse version output format to 'x'\n");
1451 printf(" --version\t\tPrint version info and exit\n");
1452 printf(" --help\t\tPrint this page\n");
1453 printf(" --cpuclock-test\tPerform test/validation of CPU clock\n");
1454 printf(" --crctest\t\tTest speed of checksum functions\n");
1455 printf(" --cmdhelp=cmd\t\tPrint command help, \"all\" for all of"
1457 printf(" --enghelp=engine\tPrint ioengine help, or list"
1458 " available ioengines\n");
1459 printf(" --enghelp=engine,cmd\tPrint help for an ioengine"
1461 printf(" --showcmd\t\tTurn a job file into command line options\n");
1462 printf(" --eta=when\t\tWhen ETA estimate should be printed\n");
1463 printf(" \t\tMay be \"always\", \"never\" or \"auto\"\n");
1464 printf(" --eta-newline=time\tForce a new line for every 'time'");
1465 printf(" period passed\n");
1466 printf(" --status-interval=t\tForce full status dump every");
1467 printf(" 't' period passed\n");
1468 printf(" --readonly\t\tTurn on safety read-only checks, preventing"
1470 printf(" --section=name\tOnly run specified section in job file\n");
1471 printf(" --alloc-size=kb\tSet smalloc pool to this size in kb"
1473 printf(" --warnings-fatal\tFio parser warnings are fatal\n");
1474 printf(" --max-jobs=nr\t\tMaximum number of threads/processes to support\n");
1475 printf(" --server=args\t\tStart a backend fio server\n");
1476 printf(" --daemonize=pidfile\tBackground fio server, write pid to file\n");
1477 printf(" --client=hostname\tTalk to remote backend fio server at hostname\n");
1478 printf(" --idle-prof=option\tReport cpu idleness on a system or percpu basis\n"
1479 "\t\t\t(option=system,percpu) or run unit work\n"
1480 "\t\t\tcalibration only (option=calibrate)\n");
1481 printf("\nFio was written by Jens Axboe <jens.axboe@oracle.com>");
1482 printf("\n Jens Axboe <jaxboe@fusionio.com>");
1483 printf("\n Jens Axboe <axboe@fb.com>\n");
1486 #ifdef FIO_INC_DEBUG
1487 struct debug_level debug_levels[] = {
1488 { .name = "process",
1489 .help = "Process creation/exit logging",
1490 .shift = FD_PROCESS,
1493 .help = "File related action logging",
1497 .help = "IO and IO engine action logging (offsets, queue, completions, etc)",
1501 .help = "Memory allocation/freeing logging",
1504 { .name = "blktrace",
1505 .help = "blktrace action logging",
1506 .shift = FD_BLKTRACE,
1509 .help = "IO verification action logging",
1513 .help = "Random generation logging",
1517 .help = "Parser logging",
1520 { .name = "diskutil",
1521 .help = "Disk utility logging actions",
1522 .shift = FD_DISKUTIL,
1525 .help = "Logging related to creating/destroying jobs",
1529 .help = "Mutex logging",
1532 { .name = "profile",
1533 .help = "Logging related to profiles",
1534 .shift = FD_PROFILE,
1537 .help = "Logging related to time keeping functions",
1541 .help = "Network logging",
1545 .help = "Rate logging",
1551 static int set_debug(const char *string)
1553 struct debug_level *dl;
1554 char *p = (char *) string;
1558 if (!strcmp(string, "?") || !strcmp(string, "help")) {
1559 log_info("fio: dumping debug options:");
1560 for (i = 0; debug_levels[i].name; i++) {
1561 dl = &debug_levels[i];
1562 log_info("%s,", dl->name);
1568 while ((opt = strsep(&p, ",")) != NULL) {
1571 if (!strncmp(opt, "all", 3)) {
1572 log_info("fio: set all debug options\n");
1577 for (i = 0; debug_levels[i].name; i++) {
1578 dl = &debug_levels[i];
1579 found = !strncmp(opt, dl->name, strlen(dl->name));
1583 if (dl->shift == FD_JOB) {
1584 opt = strchr(opt, ':');
1586 log_err("fio: missing job number\n");
1590 fio_debug_jobno = atoi(opt);
1591 log_info("fio: set debug jobno %d\n",
1594 log_info("fio: set debug option %s\n", opt);
1595 fio_debug |= (1UL << dl->shift);
1601 log_err("fio: debug mask %s not found\n", opt);
1606 static int set_debug(const char *string)
1608 log_err("fio: debug tracing not included in build\n");
1613 static void fio_options_fill_optstring(void)
1615 char *ostr = cmd_optstr;
1619 while (l_opts[i].name) {
1620 ostr[c++] = l_opts[i].val;
1621 if (l_opts[i].has_arg == required_argument)
1623 else if (l_opts[i].has_arg == optional_argument) {
1632 static int client_flag_set(char c)
1637 while (l_opts[i].name) {
1638 int val = l_opts[i].val;
1640 if (c == (val & 0xff))
1641 return (val & FIO_CLIENT_FLAG);
1649 void parse_cmd_client(void *client, char *opt)
1651 fio_client_add_cmd_option(client, opt);
1654 extern int fio_crctest(const char *);
1656 int parse_cmd_line(int argc, char *argv[], int client_type)
1658 struct thread_data *td = NULL;
1659 int c, ini_idx = 0, lidx, ret = 0, do_exit = 0, exit_val = 0;
1660 char *ostr = cmd_optstr;
1661 void *pid_file = NULL;
1662 void *cur_client = NULL;
1666 * Reset optind handling, since we may call this multiple times
1671 while ((c = getopt_long_only(argc, argv, ostr, l_opts, &lidx)) != -1) {
1674 if ((c & FIO_CLIENT_FLAG) || client_flag_set(c)) {
1675 parse_cmd_client(cur_client, argv[optind - 1]);
1676 c &= ~FIO_CLIENT_FLAG;
1681 smalloc_pool_size = atoi(optarg);
1684 def_timeout = atoi(optarg);
1693 f_out = fopen(optarg, "w+");
1695 perror("fopen output");
1701 output_format = FIO_OUTPUT_TERSE;
1705 log_err("fio: missing --output-format argument\n");
1710 if (!strcmp(optarg, "minimal") ||
1711 !strcmp(optarg, "terse") ||
1712 !strcmp(optarg, "csv"))
1713 output_format = FIO_OUTPUT_TERSE;
1714 else if (!strcmp(optarg, "json"))
1715 output_format = FIO_OUTPUT_JSON;
1717 output_format = FIO_OUTPUT_NORMAL;
1727 fio_show_option_help(optarg);
1733 fio_show_ioengine_help(optarg);
1745 log_info("%s\n", fio_version_string);
1750 terse_version = atoi(optarg);
1751 if (!(terse_version == 2 || terse_version == 3 ||
1752 terse_version == 4)) {
1753 log_err("fio: bad terse version format\n");
1759 if (!strcmp("always", optarg))
1760 eta_print = FIO_ETA_ALWAYS;
1761 else if (!strcmp("never", optarg))
1762 eta_print = FIO_ETA_NEVER;
1767 if (str_to_decimal(optarg, &t, 0, NULL)) {
1768 log_err("fio: failed parsing eta time %s\n", optarg);
1776 if (set_debug(optarg))
1785 if (!strcmp(optarg, "global")) {
1786 log_err("fio: can't use global as only "
1792 new_size = (nr_job_sections + 1) * sizeof(char *);
1793 job_sections = realloc(job_sections, new_size);
1794 job_sections[nr_job_sections] = strdup(optarg);
1799 exec_profile = strdup(optarg);
1801 case FIO_GETOPT_JOB: {
1802 const char *opt = l_opts[lidx].name;
1805 if (!strncmp(opt, "name", 4) && td) {
1806 ret = add_job(td, td->o.name ?: "fio", 0, 0, client_type);
1812 int is_section = !strncmp(opt, "name", 4);
1815 if (!is_section || !strncmp(val, "global", 6))
1818 if (is_section && skip_this_section(val))
1821 td = get_new_job(global, &def_thread, 1);
1822 if (!td || ioengine_load(td))
1824 fio_options_set_ioengine_opts(l_opts, td);
1827 if ((!val || !strlen(val)) &&
1828 l_opts[lidx].has_arg == required_argument) {
1829 log_err("fio: option %s requires an argument\n", opt);
1832 ret = fio_cmd_option_parse(td, opt, val);
1842 if (!ret && !strcmp(opt, "ioengine")) {
1844 if (ioengine_load(td))
1846 fio_options_set_ioengine_opts(l_opts, td);
1850 case FIO_GETOPT_IOENGINE: {
1851 const char *opt = l_opts[lidx].name;
1853 ret = fio_cmd_ioengine_option_parse(td, opt, val);
1860 max_jobs = atoi(optarg);
1861 if (!max_jobs || max_jobs > REAL_MAX_JOBS) {
1862 log_err("fio: invalid max jobs: %d\n", max_jobs);
1869 log_err("fio: can't be both client and server\n");
1875 fio_server_set_arg(optarg);
1880 pid_file = strdup(optarg);
1883 if ((ret = fio_idle_prof_parse_opt(optarg))) {
1884 /* exit on error and calibration only */
1892 log_err("fio: can't be both client and server\n");
1897 if (fio_client_add(&fio_client_ops, optarg, &cur_client)) {
1898 log_err("fio: failed adding client %s\n", optarg);
1904 * If the next argument exists and isn't an option,
1905 * assume it's a job file for this client only.
1907 while (optind < argc) {
1908 if (!strncmp(argv[optind], "--", 2) ||
1909 !strncmp(argv[optind], "-", 1))
1912 fio_client_add_ini_file(cur_client, argv[optind]);
1918 exit_val = fio_monotonic_clocktest();
1922 exit_val = fio_crctest(optarg);
1927 if (check_str_time(optarg, &val)) {
1928 log_err("fio: failed parsing time %s\n", optarg);
1933 status_interval = val * 1000;
1937 log_err("%s: unrecognized option '%s'\n", argv[0],
1948 if (do_exit && !(is_backend || nr_clients))
1951 if (nr_clients && fio_clients_connect()) {
1957 if (is_backend && backend)
1958 return fio_start_server(pid_file);
1962 ret = add_job(td, td->o.name ?: "fio", 0, 0, client_type);
1965 while (!ret && optind < argc) {
1967 ini_file = realloc(ini_file, ini_idx * sizeof(char *));
1968 ini_file[ini_idx - 1] = strdup(argv[optind]);
1975 int fio_init_options(void)
1980 fio_options_fill_optstring();
1981 fio_options_dup_and_init(l_opts);
1985 if (fill_def_thread())
1991 extern int fio_check_options(struct thread_options *);
1993 int parse_options(int argc, char *argv[])
1995 const int type = FIO_CLIENT_TYPE_CLI;
1998 if (fio_init_options())
2000 if (fio_test_cconv(&def_thread.o))
2001 log_err("fio: failed internal cconv test\n");
2003 job_files = parse_cmd_line(argc, argv, type);
2005 if (job_files > 0) {
2006 for (i = 0; i < job_files; i++) {
2007 if (fill_def_thread())
2010 if (fio_clients_send_ini(ini_file[i]))
2013 } else if (!is_backend) {
2014 if (parse_jobs_ini(ini_file[i], 0, i, type))
2019 } else if (nr_clients) {
2020 if (fill_def_thread())
2022 if (fio_clients_send_ini(NULL))
2027 fio_options_free(&def_thread);
2028 filesetup_mem_free();
2030 if (!thread_number) {
2035 if (is_backend || nr_clients)
2040 log_err("No jobs(s) defined\n\n");
2050 if (def_thread.o.gtod_offload) {
2052 fio_gtod_offload = 1;
2053 fio_gtod_cpu = def_thread.o.gtod_cpu;
2056 if (output_format == FIO_OUTPUT_NORMAL)
2057 log_info("%s\n", fio_version_string);
2062 void options_default_fill(struct thread_options *o)
2064 memcpy(o, &def_thread.o, sizeof(*o));