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;
257 * The thread area is shared between the main process and the job
258 * threads/processes. So setup a shared memory segment that will hold
259 * all the job info. We use the end of the region for keeping track of
260 * open files across jobs, for file sharing.
262 static int setup_thread_area(void)
270 * 1024 is too much on some machines, scale max_jobs if
271 * we get a failure that looks like too large a shm segment
274 size_t size = max_jobs * sizeof(struct thread_data);
276 size += file_hash_size;
277 size += sizeof(unsigned int);
279 shm_id = shmget(0, size, IPC_CREAT | 0600);
282 if (errno != EINVAL && errno != ENOMEM && errno != ENOSPC) {
293 threads = shmat(shm_id, NULL, 0);
294 if (threads == (void *) -1) {
299 memset(threads, 0, max_jobs * sizeof(struct thread_data));
300 hash = (void *) threads + max_jobs * sizeof(struct thread_data);
301 fio_debug_jobp = (void *) hash + file_hash_size;
302 *fio_debug_jobp = -1;
303 file_hash_init(hash);
311 * Return a free job structure.
313 static struct thread_data *get_new_job(int global, struct thread_data *parent,
316 struct thread_data *td;
320 if (setup_thread_area()) {
321 log_err("error: failed to setup shm segment\n");
324 if (thread_number >= max_jobs) {
325 log_err("error: maximum number of jobs (%d) reached.\n",
330 td = &threads[thread_number++];
337 td->o.uid = td->o.gid = -1U;
339 dup_files(td, parent);
340 fio_options_mem_dupe(td);
342 profile_add_hooks(td);
344 td->thread_number = thread_number;
346 if (!parent || !parent->o.group_reporting)
352 static void put_job(struct thread_data *td)
354 if (td == &def_thread)
361 log_info("fio: %s\n", td->verror);
363 fio_options_free(td);
367 memset(&threads[td->thread_number - 1], 0, sizeof(*td));
371 static int __setup_rate(struct thread_data *td, enum fio_ddir ddir)
373 unsigned int bs = td->o.min_bs[ddir];
375 assert(ddir_rw(ddir));
377 if (td->o.rate[ddir])
378 td->rate_bps[ddir] = td->o.rate[ddir];
380 td->rate_bps[ddir] = td->o.rate_iops[ddir] * bs;
382 if (!td->rate_bps[ddir]) {
383 log_err("rate lower than supported\n");
387 td->rate_pending_usleep[ddir] = 0;
391 static int setup_rate(struct thread_data *td)
395 if (td->o.rate[DDIR_READ] || td->o.rate_iops[DDIR_READ])
396 ret = __setup_rate(td, DDIR_READ);
397 if (td->o.rate[DDIR_WRITE] || td->o.rate_iops[DDIR_WRITE])
398 ret |= __setup_rate(td, DDIR_WRITE);
399 if (td->o.rate[DDIR_TRIM] || td->o.rate_iops[DDIR_TRIM])
400 ret |= __setup_rate(td, DDIR_TRIM);
405 static int fixed_block_size(struct thread_options *o)
407 return o->min_bs[DDIR_READ] == o->max_bs[DDIR_READ] &&
408 o->min_bs[DDIR_WRITE] == o->max_bs[DDIR_WRITE] &&
409 o->min_bs[DDIR_TRIM] == o->max_bs[DDIR_TRIM] &&
410 o->min_bs[DDIR_READ] == o->min_bs[DDIR_WRITE] &&
411 o->min_bs[DDIR_READ] == o->min_bs[DDIR_TRIM];
415 * Lazy way of fixing up options that depend on each other. We could also
416 * define option callback handlers, but this is easier.
418 static int fixup_options(struct thread_data *td)
420 struct thread_options *o = &td->o;
423 #ifndef FIO_HAVE_PSHARED_MUTEX
424 if (!o->use_thread) {
425 log_info("fio: this platform does not support process shared"
426 " mutexes, forcing use of threads. Use the 'thread'"
427 " option to get rid of this warning.\n");
429 ret = warnings_fatal;
433 if (o->write_iolog_file && o->read_iolog_file) {
434 log_err("fio: read iolog overrides write_iolog\n");
435 free(o->write_iolog_file);
436 o->write_iolog_file = NULL;
437 ret = warnings_fatal;
441 * only really works with 1 file
443 if (o->zone_size && o->open_files > 1)
447 * If zone_range isn't specified, backward compatibility dictates it
448 * should be made equal to zone_size.
450 if (o->zone_size && !o->zone_range)
451 o->zone_range = o->zone_size;
454 * Reads can do overwrites, we always need to pre-create the file
456 if (td_read(td) || td_rw(td))
459 if (!o->min_bs[DDIR_READ])
460 o->min_bs[DDIR_READ] = o->bs[DDIR_READ];
461 if (!o->max_bs[DDIR_READ])
462 o->max_bs[DDIR_READ] = o->bs[DDIR_READ];
463 if (!o->min_bs[DDIR_WRITE])
464 o->min_bs[DDIR_WRITE] = o->bs[DDIR_WRITE];
465 if (!o->max_bs[DDIR_WRITE])
466 o->max_bs[DDIR_WRITE] = o->bs[DDIR_WRITE];
467 if (!o->min_bs[DDIR_TRIM])
468 o->min_bs[DDIR_TRIM] = o->bs[DDIR_TRIM];
469 if (!o->max_bs[DDIR_TRIM])
470 o->max_bs[DDIR_TRIM] = o->bs[DDIR_TRIM];
473 o->rw_min_bs = min(o->min_bs[DDIR_READ], o->min_bs[DDIR_WRITE]);
474 o->rw_min_bs = min(o->min_bs[DDIR_TRIM], o->rw_min_bs);
477 * For random IO, allow blockalign offset other than min_bs.
479 if (!o->ba[DDIR_READ] || !td_random(td))
480 o->ba[DDIR_READ] = o->min_bs[DDIR_READ];
481 if (!o->ba[DDIR_WRITE] || !td_random(td))
482 o->ba[DDIR_WRITE] = o->min_bs[DDIR_WRITE];
483 if (!o->ba[DDIR_TRIM] || !td_random(td))
484 o->ba[DDIR_TRIM] = o->min_bs[DDIR_TRIM];
486 if ((o->ba[DDIR_READ] != o->min_bs[DDIR_READ] ||
487 o->ba[DDIR_WRITE] != o->min_bs[DDIR_WRITE] ||
488 o->ba[DDIR_TRIM] != o->min_bs[DDIR_TRIM]) &&
490 log_err("fio: Any use of blockalign= turns off randommap\n");
492 ret = warnings_fatal;
495 if (!o->file_size_high)
496 o->file_size_high = o->file_size_low;
498 if (o->norandommap && o->verify != VERIFY_NONE
499 && !fixed_block_size(o)) {
500 log_err("fio: norandommap given for variable block sizes, "
501 "verify disabled\n");
502 o->verify = VERIFY_NONE;
503 ret = warnings_fatal;
505 if (o->bs_unaligned && (o->odirect || td->io_ops->flags & FIO_RAWIO))
506 log_err("fio: bs_unaligned may not work with raw io\n");
509 * thinktime_spin must be less than thinktime
511 if (o->thinktime_spin > o->thinktime)
512 o->thinktime_spin = o->thinktime;
515 * The low water mark cannot be bigger than the iodepth
517 if (o->iodepth_low > o->iodepth || !o->iodepth_low)
518 o->iodepth_low = o->iodepth;
521 * If batch number isn't set, default to the same as iodepth
523 if (o->iodepth_batch > o->iodepth || !o->iodepth_batch)
524 o->iodepth_batch = o->iodepth;
526 if (o->nr_files > td->files_index)
527 o->nr_files = td->files_index;
529 if (o->open_files > o->nr_files || !o->open_files)
530 o->open_files = o->nr_files;
532 if (((o->rate[DDIR_READ] + o->rate[DDIR_WRITE] + o->rate[DDIR_TRIM]) &&
533 (o->rate_iops[DDIR_READ] + o->rate_iops[DDIR_WRITE] + o->rate_iops[DDIR_TRIM])) ||
534 ((o->ratemin[DDIR_READ] + o->ratemin[DDIR_WRITE] + o->ratemin[DDIR_TRIM]) &&
535 (o->rate_iops_min[DDIR_READ] + o->rate_iops_min[DDIR_WRITE] + o->rate_iops_min[DDIR_TRIM]))) {
536 log_err("fio: rate and rate_iops are mutually exclusive\n");
539 if ((o->rate[DDIR_READ] < o->ratemin[DDIR_READ]) ||
540 (o->rate[DDIR_WRITE] < o->ratemin[DDIR_WRITE]) ||
541 (o->rate[DDIR_TRIM] < o->ratemin[DDIR_TRIM]) ||
542 (o->rate_iops[DDIR_READ] < o->rate_iops_min[DDIR_READ]) ||
543 (o->rate_iops[DDIR_WRITE] < o->rate_iops_min[DDIR_WRITE]) ||
544 (o->rate_iops[DDIR_TRIM] < o->rate_iops_min[DDIR_TRIM])) {
545 log_err("fio: minimum rate exceeds rate\n");
549 if (!o->timeout && o->time_based) {
550 log_err("fio: time_based requires a runtime/timeout setting\n");
552 ret = warnings_fatal;
555 if (o->fill_device && !o->size)
558 if (o->verify != VERIFY_NONE) {
559 if (td_write(td) && o->do_verify && o->numjobs > 1) {
560 log_info("Multiple writers may overwrite blocks that "
561 "belong to other jobs. This can cause "
562 "verification failures.\n");
563 ret = warnings_fatal;
566 o->refill_buffers = 1;
567 if (o->max_bs[DDIR_WRITE] != o->min_bs[DDIR_WRITE] &&
569 o->verify_interval = o->min_bs[DDIR_WRITE];
573 o->invalidate_cache = 0;
574 if (td->io_ops->flags & FIO_PIPEIO) {
575 log_info("fio: cannot pre-read files with an IO engine"
576 " that isn't seekable. Pre-read disabled.\n");
577 ret = warnings_fatal;
582 if (td->io_ops->flags & FIO_BIT_BASED)
588 #ifndef CONFIG_FDATASYNC
589 if (o->fdatasync_blocks) {
590 log_info("fio: this platform does not support fdatasync()"
591 " falling back to using fsync(). Use the 'fsync'"
592 " option instead of 'fdatasync' to get rid of"
594 o->fsync_blocks = o->fdatasync_blocks;
595 o->fdatasync_blocks = 0;
596 ret = warnings_fatal;
602 * Windows doesn't support O_DIRECT or O_SYNC with the _open interface,
603 * so fail if we're passed those flags
605 if ((td->io_ops->flags & FIO_SYNCIO) && (td->o.odirect || td->o.sync_io)) {
606 log_err("fio: Windows does not support direct or non-buffered io with"
607 " the synchronous ioengines. Use the 'windowsaio' ioengine"
608 " with 'direct=1' and 'iodepth=1' instead.\n");
614 * For fully compressible data, just zero them at init time.
615 * It's faster than repeatedly filling it.
617 if (td->o.compress_percentage == 100) {
618 td->o.zero_buffers = 1;
619 td->o.compress_percentage = 0;
623 * Using a non-uniform random distribution excludes usage of
626 if (td->o.random_distribution != FIO_RAND_DIST_RANDOM)
627 td->o.norandommap = 1;
630 * If size is set but less than the min block size, complain
632 if (o->size && o->size < td_min_bs(td)) {
633 log_err("fio: size too small, must be larger than the IO size: %llu\n", (unsigned long long) o->size);
638 * O_ATOMIC implies O_DIRECT
644 * If randseed is set, that overrides randrepeat
647 td->o.rand_repeatable = 0;
653 * This function leaks the buffer
655 char *fio_uint_to_kmg(unsigned int val)
657 char *buf = malloc(32);
658 char post[] = { 0, 'K', 'M', 'G', 'P', 'E', 0 };
669 snprintf(buf, 32, "%u%c", val, *p);
673 /* External engines are specified by "external:name.o") */
674 static const char *get_engine_name(const char *str)
676 char *p = strstr(str, ":");
682 strip_blank_front(&p);
687 static int exists_and_not_file(const char *filename)
691 if (lstat(filename, &sb) == -1)
694 /* \\.\ is the device namespace in Windows, where every file
695 * is a device node */
696 if (S_ISREG(sb.st_mode) && strncmp(filename, "\\\\.\\", 4) != 0)
702 static void td_fill_rand_seeds_os(struct thread_data *td)
704 os_random_seed(td->rand_seeds[FIO_RAND_BS_OFF], &td->bsrange_state);
705 os_random_seed(td->rand_seeds[FIO_RAND_VER_OFF], &td->verify_state);
706 os_random_seed(td->rand_seeds[FIO_RAND_MIX_OFF], &td->rwmix_state);
708 if (td->o.file_service_type == FIO_FSERVICE_RANDOM)
709 os_random_seed(td->rand_seeds[FIO_RAND_FILE_OFF], &td->next_file_state);
711 os_random_seed(td->rand_seeds[FIO_RAND_FILE_SIZE_OFF], &td->file_size_state);
712 os_random_seed(td->rand_seeds[FIO_RAND_TRIM_OFF], &td->trim_state);
717 if (td->o.rand_repeatable)
718 td->rand_seeds[FIO_RAND_BLOCK_OFF] = FIO_RANDSEED * td->thread_number;
720 os_random_seed(td->rand_seeds[FIO_RAND_BLOCK_OFF], &td->random_state);
722 os_random_seed(td->rand_seeds[FIO_RAND_SEQ_RAND_READ_OFF], &td->seq_rand_state[DDIR_READ]);
723 os_random_seed(td->rand_seeds[FIO_RAND_SEQ_RAND_WRITE_OFF], &td->seq_rand_state[DDIR_WRITE]);
724 os_random_seed(td->rand_seeds[FIO_RAND_SEQ_RAND_TRIM_OFF], &td->seq_rand_state[DDIR_TRIM]);
727 static void td_fill_rand_seeds_internal(struct thread_data *td)
729 init_rand_seed(&td->__bsrange_state, td->rand_seeds[FIO_RAND_BS_OFF]);
730 init_rand_seed(&td->__verify_state, td->rand_seeds[FIO_RAND_VER_OFF]);
731 init_rand_seed(&td->__rwmix_state, td->rand_seeds[FIO_RAND_MIX_OFF]);
733 if (td->o.file_service_type == FIO_FSERVICE_RANDOM)
734 init_rand_seed(&td->__next_file_state, td->rand_seeds[FIO_RAND_FILE_OFF]);
736 init_rand_seed(&td->__file_size_state, td->rand_seeds[FIO_RAND_FILE_SIZE_OFF]);
737 init_rand_seed(&td->__trim_state, td->rand_seeds[FIO_RAND_TRIM_OFF]);
742 if (td->o.rand_repeatable)
743 td->rand_seeds[FIO_RAND_BLOCK_OFF] = FIO_RANDSEED * td->thread_number;
745 init_rand_seed(&td->__random_state, td->rand_seeds[FIO_RAND_BLOCK_OFF]);
746 init_rand_seed(&td->__seq_rand_state[DDIR_READ], td->rand_seeds[FIO_RAND_SEQ_RAND_READ_OFF]);
747 init_rand_seed(&td->__seq_rand_state[DDIR_WRITE], td->rand_seeds[FIO_RAND_SEQ_RAND_WRITE_OFF]);
748 init_rand_seed(&td->__seq_rand_state[DDIR_TRIM], td->rand_seeds[FIO_RAND_SEQ_RAND_TRIM_OFF]);
751 void td_fill_rand_seeds(struct thread_data *td)
753 if (td->o.use_os_rand)
754 td_fill_rand_seeds_os(td);
756 td_fill_rand_seeds_internal(td);
758 init_rand_seed(&td->buf_state, td->rand_seeds[FIO_RAND_BUF_OFF]);
762 * Initializes the ioengine configured for a job, if it has not been done so
765 int ioengine_load(struct thread_data *td)
770 * Engine has already been loaded.
774 if (!td->o.ioengine) {
775 log_err("fio: internal fault, no IO engine specified\n");
779 engine = get_engine_name(td->o.ioengine);
780 td->io_ops = load_ioengine(td, engine);
782 log_err("fio: failed to load engine %s\n", engine);
786 if (td->io_ops->option_struct_size && td->io_ops->options) {
788 * In cases where td->eo is set, clone it for a child thread.
789 * This requires that the parent thread has the same ioengine,
790 * but that requirement must be enforced by the code which
793 void *origeo = td->eo;
795 * Otherwise use the default thread options.
797 if (!origeo && td != &def_thread && def_thread.eo &&
798 def_thread.io_ops->options == td->io_ops->options)
799 origeo = def_thread.eo;
801 options_init(td->io_ops->options);
802 td->eo = malloc(td->io_ops->option_struct_size);
804 * Use the default thread as an option template if this uses the
805 * same options structure and there are non-default options
809 memcpy(td->eo, origeo, td->io_ops->option_struct_size);
810 options_mem_dupe(td->eo, td->io_ops->options);
812 memset(td->eo, 0, td->io_ops->option_struct_size);
813 fill_default_options(td->eo, td->io_ops->options);
815 *(struct thread_data **)td->eo = td;
821 static void init_flags(struct thread_data *td)
823 struct thread_options *o = &td->o;
825 if (o->verify_backlog)
826 td->flags |= TD_F_VER_BACKLOG;
828 td->flags |= TD_F_TRIM_BACKLOG;
829 if (o->read_iolog_file)
830 td->flags |= TD_F_READ_IOLOG;
831 if (o->refill_buffers)
832 td->flags |= TD_F_REFILL_BUFFERS;
833 if (o->scramble_buffers)
834 td->flags |= TD_F_SCRAMBLE_BUFFERS;
835 if (o->verify != VERIFY_NONE)
836 td->flags |= TD_F_VER_NONE;
839 static int setup_random_seeds(struct thread_data *td)
844 if (!td->o.rand_repeatable && !td->o.rand_seed)
845 return init_random_state(td, td->rand_seeds, sizeof(td->rand_seeds));
847 if (!td->o.rand_seed)
850 seed = td->o.rand_seed;
852 for (i = 0; i < 4; i++)
853 seed *= 0x9e370001UL;
855 for (i = 0; i < FIO_RAND_NR_OFFS; i++) {
856 td->rand_seeds[i] = seed;
857 seed *= 0x9e370001UL;
860 td_fill_rand_seeds(td);
871 static struct fpre_keyword {
875 } fpre_keywords[] = {
876 { .keyword = "$jobname", .key = FPRE_JOBNAME, },
877 { .keyword = "$jobnum", .key = FPRE_JOBNUM, },
878 { .keyword = "$filenum", .key = FPRE_FILENUM, },
879 { .keyword = NULL, },
882 static char *make_filename(char *buf, struct thread_options *o,
883 const char *jobname, int jobnum, int filenum)
885 struct fpre_keyword *f;
888 if (!o->filename_format || !strlen(o->filename_format)) {
889 sprintf(buf, "%s.%d.%d", jobname, jobnum, filenum);
893 for (f = &fpre_keywords[0]; f->keyword; f++)
894 f->strlen = strlen(f->keyword);
896 strcpy(buf, o->filename_format);
897 memset(copy, 0, sizeof(copy));
898 for (f = &fpre_keywords[0]; f->keyword; f++) {
900 size_t pre_len, post_start = 0;
901 char *str, *dst = copy;
903 str = strcasestr(buf, f->keyword);
908 if (strlen(str) != f->strlen)
909 post_start = pre_len + f->strlen;
912 strncpy(dst, buf, pre_len);
918 dst += sprintf(dst, "%s", jobname);
921 dst += sprintf(dst, "%d", jobnum);
924 dst += sprintf(dst, "%d", filenum);
932 strcpy(dst, buf + post_start);
941 int parse_dryrun(void)
943 return dump_cmdline || parse_only;
947 * Adds a job to the list of things todo. Sanitizes the various options
948 * to make sure we don't have conflicts, and initializes various
951 static int add_job(struct thread_data *td, const char *jobname, int job_add_num,
952 int recursed, int client_type)
955 char fname[PATH_MAX];
956 int numjobs, file_alloced;
957 struct thread_options *o = &td->o;
960 * the def_thread is just for options, it's not a real job
962 if (td == &def_thread)
968 * if we are just dumping the output command line, don't add the job
970 if (parse_dryrun()) {
975 td->client_type = client_type;
977 if (profile_td_init(td))
980 if (ioengine_load(td))
984 td->io_ops->flags |= FIO_RAWIO;
987 if (!o->filename && !td->files_index && !o->read_iolog_file) {
990 if (o->nr_files == 1 && exists_and_not_file(jobname))
991 add_file(td, jobname);
993 for (i = 0; i < o->nr_files; i++)
994 add_file(td, make_filename(fname, o, jobname, td->thread_number, i));
998 if (fixup_options(td))
1004 * IO engines only need this for option callbacks, and the address may
1005 * change in subprocesses.
1008 *(struct thread_data **)td->eo = NULL;
1010 if (td->io_ops->flags & FIO_DISKLESSIO) {
1013 for_each_file(td, f, i)
1014 f->real_file_size = -1ULL;
1017 td->mutex = fio_mutex_init(FIO_MUTEX_LOCKED);
1019 td->ts.clat_percentiles = o->clat_percentiles;
1020 td->ts.percentile_precision = o->percentile_precision;
1021 memcpy(td->ts.percentile_list, o->percentile_list, sizeof(o->percentile_list));
1023 for (i = 0; i < DDIR_RWDIR_CNT; i++) {
1024 td->ts.clat_stat[i].min_val = ULONG_MAX;
1025 td->ts.slat_stat[i].min_val = ULONG_MAX;
1026 td->ts.lat_stat[i].min_val = ULONG_MAX;
1027 td->ts.bw_stat[i].min_val = ULONG_MAX;
1029 td->ddir_seq_nr = o->ddir_seq_nr;
1031 if ((o->stonewall || o->new_group) && prev_group_jobs) {
1032 prev_group_jobs = 0;
1036 td->groupid = groupid;
1039 if (setup_random_seeds(td)) {
1040 td_verror(td, errno, "init_random_state");
1047 if (o->lat_log_file) {
1048 setup_log(&td->lat_log, o->log_avg_msec, IO_LOG_TYPE_LAT);
1049 setup_log(&td->slat_log, o->log_avg_msec, IO_LOG_TYPE_SLAT);
1050 setup_log(&td->clat_log, o->log_avg_msec, IO_LOG_TYPE_CLAT);
1053 setup_log(&td->bw_log, o->log_avg_msec, IO_LOG_TYPE_BW);
1054 if (o->iops_log_file)
1055 setup_log(&td->iops_log, o->log_avg_msec, IO_LOG_TYPE_IOPS);
1058 o->name = strdup(jobname);
1060 if (output_format == FIO_OUTPUT_NORMAL) {
1062 if (is_backend && !recursed)
1063 fio_server_send_add_job(td);
1065 if (!(td->io_ops->flags & FIO_NOIO)) {
1066 char *c1, *c2, *c3, *c4;
1067 char *c5 = NULL, *c6 = NULL;
1069 c1 = fio_uint_to_kmg(o->min_bs[DDIR_READ]);
1070 c2 = fio_uint_to_kmg(o->max_bs[DDIR_READ]);
1071 c3 = fio_uint_to_kmg(o->min_bs[DDIR_WRITE]);
1072 c4 = fio_uint_to_kmg(o->max_bs[DDIR_WRITE]);
1074 if (!o->bs_is_seq_rand) {
1075 c5 = fio_uint_to_kmg(o->min_bs[DDIR_TRIM]);
1076 c6 = fio_uint_to_kmg(o->max_bs[DDIR_TRIM]);
1079 log_info("%s: (g=%d): rw=%s, ", td->o.name,
1081 ddir_str(o->td_ddir));
1083 if (o->bs_is_seq_rand)
1084 log_info("bs(seq/rand)=%s-%s/%s-%s, ",
1087 log_info("bs=%s-%s/%s-%s/%s-%s, ",
1088 c1, c2, c3, c4, c5, c6);
1090 log_info("ioengine=%s, iodepth=%u\n",
1091 td->io_ops->name, o->iodepth);
1100 } else if (job_add_num == 1)
1105 * recurse add identical jobs, clear numjobs and stonewall options
1106 * as they don't apply to sub-jobs
1108 numjobs = o->numjobs;
1110 struct thread_data *td_new = get_new_job(0, td, 1);
1115 td_new->o.numjobs = 1;
1116 td_new->o.stonewall = 0;
1117 td_new->o.new_group = 0;
1120 td_new->o.filename = NULL;
1121 td_new->files_index = 0;
1122 td_new->files_size = 0;
1123 td_new->files = NULL;
1126 job_add_num = numjobs - 1;
1128 if (add_job(td_new, jobname, job_add_num, 1, client_type))
1139 * Parse as if 'o' was a command line
1141 void add_job_opts(const char **o, int client_type)
1143 struct thread_data *td, *td_parent;
1144 int i, in_global = 1;
1148 td_parent = td = NULL;
1150 if (!strncmp(o[i], "name", 4)) {
1153 add_job(td, jobname, 0, 0, client_type);
1155 sprintf(jobname, "%s", o[i] + 5);
1157 if (in_global && !td_parent)
1158 td_parent = get_new_job(1, &def_thread, 0);
1159 else if (!in_global && !td) {
1161 td_parent = &def_thread;
1162 td = get_new_job(0, td_parent, 0);
1165 fio_options_parse(td_parent, (char **) &o[i], 1, 0);
1167 fio_options_parse(td, (char **) &o[i], 1, 0);
1172 add_job(td, jobname, 0, 0, client_type);
1175 static int skip_this_section(const char *name)
1179 if (!nr_job_sections)
1181 if (!strncmp(name, "global", 6))
1184 for (i = 0; i < nr_job_sections; i++)
1185 if (!strcmp(job_sections[i], name))
1191 static int is_empty_or_comment(char *line)
1195 for (i = 0; i < strlen(line); i++) {
1200 if (!isspace((int) line[i]) && !iscntrl((int) line[i]))
1208 * This is our [ini] type file parser.
1210 int parse_jobs_ini(char *file, int is_buf, int stonewall_flag, int type)
1212 unsigned int global;
1213 struct thread_data *td;
1214 char *string, *name;
1217 int ret = 0, stonewall;
1220 int inside_skip = 0;
1222 int i, alloc_opts, num_opts;
1227 if (!strcmp(file, "-"))
1230 f = fopen(file, "r");
1233 perror("fopen job file");
1238 string = malloc(4096);
1241 * it's really 256 + small bit, 280 should suffice
1244 memset(name, 0, 280);
1247 opts = malloc(sizeof(char *) * alloc_opts);
1250 stonewall = stonewall_flag;
1253 * if skip_fgets is set, we already have loaded a line we
1258 p = strsep(&file, "\n");
1260 p = fgets(string, 4096, f);
1266 strip_blank_front(&p);
1269 if (is_empty_or_comment(p))
1271 if (sscanf(p, "[%255[^\n]]", name) != 1) {
1274 log_err("fio: option <%s> outside of [] job section\n",
1279 name[strlen(name) - 1] = '\0';
1281 if (skip_this_section(name)) {
1287 global = !strncmp(name, "global", 6);
1293 log_info("--name=%s ", name);
1297 td = get_new_job(global, &def_thread, 0);
1304 * Separate multiple job files by a stonewall
1306 if (!global && stonewall) {
1307 td->o.stonewall = stonewall;
1312 memset(opts, 0, alloc_opts * sizeof(char *));
1316 p = strsep(&file, "\n");
1318 p = fgets(string, 4096, f);
1322 if (is_empty_or_comment(p))
1325 strip_blank_front(&p);
1328 * new section, break out and make sure we don't
1329 * fgets() a new line at the top.
1338 if (num_opts == alloc_opts) {
1340 opts = realloc(opts,
1341 alloc_opts * sizeof(char *));
1344 opts[num_opts] = strdup(p);
1348 ret = fio_options_parse(td, opts, num_opts, dump_cmdline);
1350 ret = add_job(td, name, 0, 0, type);
1352 log_err("fio: job %s dropped\n", name);
1356 for (i = 0; i < num_opts; i++)
1365 while (i < nr_job_sections) {
1366 free(job_sections[i]);
1370 for (i = 0; i < num_opts; i++)
1376 if (!is_buf && f != stdin)
1381 static int fill_def_thread(void)
1383 memset(&def_thread, 0, sizeof(def_thread));
1385 fio_getaffinity(getpid(), &def_thread.o.cpumask);
1386 def_thread.o.timeout = def_timeout;
1387 def_thread.o.error_dump = 1;
1389 * fill default options
1391 fio_fill_default_options(&def_thread);
1395 static void usage(const char *name)
1397 printf("%s\n", fio_version_string);
1398 printf("%s [options] [job options] <job file(s)>\n", name);
1399 printf(" --debug=options\tEnable debug logging. May be one/more of:\n"
1400 "\t\t\tprocess,file,io,mem,blktrace,verify,random,parse,\n"
1401 "\t\t\tdiskutil,job,mutex,profile,time,net,rate\n");
1402 printf(" --parse-only\t\tParse options only, don't start any IO\n");
1403 printf(" --output\t\tWrite output to file\n");
1404 printf(" --runtime\t\tRuntime in seconds\n");
1405 printf(" --latency-log\t\tGenerate per-job latency logs\n");
1406 printf(" --bandwidth-log\tGenerate per-job bandwidth logs\n");
1407 printf(" --minimal\t\tMinimal (terse) output\n");
1408 printf(" --output-format=x\tOutput format (terse,json,normal)\n");
1409 printf(" --terse-version=x\tSet terse version output format to 'x'\n");
1410 printf(" --version\t\tPrint version info and exit\n");
1411 printf(" --help\t\tPrint this page\n");
1412 printf(" --cpuclock-test\tPerform test/validation of CPU clock\n");
1413 printf(" --crctest\t\tTest speed of checksum functions\n");
1414 printf(" --cmdhelp=cmd\t\tPrint command help, \"all\" for all of"
1416 printf(" --enghelp=engine\tPrint ioengine help, or list"
1417 " available ioengines\n");
1418 printf(" --enghelp=engine,cmd\tPrint help for an ioengine"
1420 printf(" --showcmd\t\tTurn a job file into command line options\n");
1421 printf(" --eta=when\t\tWhen ETA estimate should be printed\n");
1422 printf(" \t\tMay be \"always\", \"never\" or \"auto\"\n");
1423 printf(" --eta-newline=time\tForce a new line for every 'time'");
1424 printf(" period passed\n");
1425 printf(" --status-interval=t\tForce full status dump every");
1426 printf(" 't' period passed\n");
1427 printf(" --readonly\t\tTurn on safety read-only checks, preventing"
1429 printf(" --section=name\tOnly run specified section in job file\n");
1430 printf(" --alloc-size=kb\tSet smalloc pool to this size in kb"
1432 printf(" --warnings-fatal\tFio parser warnings are fatal\n");
1433 printf(" --max-jobs=nr\t\tMaximum number of threads/processes to support\n");
1434 printf(" --server=args\t\tStart a backend fio server\n");
1435 printf(" --daemonize=pidfile\tBackground fio server, write pid to file\n");
1436 printf(" --client=hostname\tTalk to remote backend fio server at hostname\n");
1437 printf(" --idle-prof=option\tReport cpu idleness on a system or percpu basis\n"
1438 "\t\t\t(option=system,percpu) or run unit work\n"
1439 "\t\t\tcalibration only (option=calibrate)\n");
1440 printf("\nFio was written by Jens Axboe <jens.axboe@oracle.com>");
1441 printf("\n Jens Axboe <jaxboe@fusionio.com>");
1442 printf("\n Jens Axboe <axboe@fb.com>\n");
1445 #ifdef FIO_INC_DEBUG
1446 struct debug_level debug_levels[] = {
1447 { .name = "process",
1448 .help = "Process creation/exit logging",
1449 .shift = FD_PROCESS,
1452 .help = "File related action logging",
1456 .help = "IO and IO engine action logging (offsets, queue, completions, etc)",
1460 .help = "Memory allocation/freeing logging",
1463 { .name = "blktrace",
1464 .help = "blktrace action logging",
1465 .shift = FD_BLKTRACE,
1468 .help = "IO verification action logging",
1472 .help = "Random generation logging",
1476 .help = "Parser logging",
1479 { .name = "diskutil",
1480 .help = "Disk utility logging actions",
1481 .shift = FD_DISKUTIL,
1484 .help = "Logging related to creating/destroying jobs",
1488 .help = "Mutex logging",
1491 { .name = "profile",
1492 .help = "Logging related to profiles",
1493 .shift = FD_PROFILE,
1496 .help = "Logging related to time keeping functions",
1500 .help = "Network logging",
1504 .help = "Rate logging",
1510 static int set_debug(const char *string)
1512 struct debug_level *dl;
1513 char *p = (char *) string;
1517 if (!strcmp(string, "?") || !strcmp(string, "help")) {
1518 log_info("fio: dumping debug options:");
1519 for (i = 0; debug_levels[i].name; i++) {
1520 dl = &debug_levels[i];
1521 log_info("%s,", dl->name);
1527 while ((opt = strsep(&p, ",")) != NULL) {
1530 if (!strncmp(opt, "all", 3)) {
1531 log_info("fio: set all debug options\n");
1536 for (i = 0; debug_levels[i].name; i++) {
1537 dl = &debug_levels[i];
1538 found = !strncmp(opt, dl->name, strlen(dl->name));
1542 if (dl->shift == FD_JOB) {
1543 opt = strchr(opt, ':');
1545 log_err("fio: missing job number\n");
1549 fio_debug_jobno = atoi(opt);
1550 log_info("fio: set debug jobno %d\n",
1553 log_info("fio: set debug option %s\n", opt);
1554 fio_debug |= (1UL << dl->shift);
1560 log_err("fio: debug mask %s not found\n", opt);
1565 static int set_debug(const char *string)
1567 log_err("fio: debug tracing not included in build\n");
1572 static void fio_options_fill_optstring(void)
1574 char *ostr = cmd_optstr;
1578 while (l_opts[i].name) {
1579 ostr[c++] = l_opts[i].val;
1580 if (l_opts[i].has_arg == required_argument)
1582 else if (l_opts[i].has_arg == optional_argument) {
1591 static int client_flag_set(char c)
1596 while (l_opts[i].name) {
1597 int val = l_opts[i].val;
1599 if (c == (val & 0xff))
1600 return (val & FIO_CLIENT_FLAG);
1608 void parse_cmd_client(void *client, char *opt)
1610 fio_client_add_cmd_option(client, opt);
1613 extern int fio_crctest(const char *);
1615 int parse_cmd_line(int argc, char *argv[], int client_type)
1617 struct thread_data *td = NULL;
1618 int c, ini_idx = 0, lidx, ret = 0, do_exit = 0, exit_val = 0;
1619 char *ostr = cmd_optstr;
1620 void *pid_file = NULL;
1621 void *cur_client = NULL;
1625 * Reset optind handling, since we may call this multiple times
1630 while ((c = getopt_long_only(argc, argv, ostr, l_opts, &lidx)) != -1) {
1633 if ((c & FIO_CLIENT_FLAG) || client_flag_set(c)) {
1634 parse_cmd_client(cur_client, argv[optind - 1]);
1635 c &= ~FIO_CLIENT_FLAG;
1640 smalloc_pool_size = atoi(optarg);
1643 def_timeout = atoi(optarg);
1652 f_out = fopen(optarg, "w+");
1654 perror("fopen output");
1660 output_format = FIO_OUTPUT_TERSE;
1664 log_err("fio: missing --output-format argument\n");
1669 if (!strcmp(optarg, "minimal") ||
1670 !strcmp(optarg, "terse") ||
1671 !strcmp(optarg, "csv"))
1672 output_format = FIO_OUTPUT_TERSE;
1673 else if (!strcmp(optarg, "json"))
1674 output_format = FIO_OUTPUT_JSON;
1676 output_format = FIO_OUTPUT_NORMAL;
1686 fio_show_option_help(optarg);
1692 fio_show_ioengine_help(optarg);
1704 log_info("%s\n", fio_version_string);
1709 terse_version = atoi(optarg);
1710 if (!(terse_version == 2 || terse_version == 3 ||
1711 terse_version == 4)) {
1712 log_err("fio: bad terse version format\n");
1718 if (!strcmp("always", optarg))
1719 eta_print = FIO_ETA_ALWAYS;
1720 else if (!strcmp("never", optarg))
1721 eta_print = FIO_ETA_NEVER;
1726 if (str_to_decimal(optarg, &t, 0, NULL)) {
1727 log_err("fio: failed parsing eta time %s\n", optarg);
1735 if (set_debug(optarg))
1744 if (!strcmp(optarg, "global")) {
1745 log_err("fio: can't use global as only "
1751 new_size = (nr_job_sections + 1) * sizeof(char *);
1752 job_sections = realloc(job_sections, new_size);
1753 job_sections[nr_job_sections] = strdup(optarg);
1758 exec_profile = strdup(optarg);
1760 case FIO_GETOPT_JOB: {
1761 const char *opt = l_opts[lidx].name;
1764 if (!strncmp(opt, "name", 4) && td) {
1765 ret = add_job(td, td->o.name ?: "fio", 0, 0, client_type);
1771 int is_section = !strncmp(opt, "name", 4);
1774 if (!is_section || !strncmp(val, "global", 6))
1777 if (is_section && skip_this_section(val))
1780 td = get_new_job(global, &def_thread, 1);
1781 if (!td || ioengine_load(td))
1783 fio_options_set_ioengine_opts(l_opts, td);
1786 if ((!val || !strlen(val)) &&
1787 l_opts[lidx].has_arg == required_argument) {
1788 log_err("fio: option %s requires an argument\n", opt);
1791 ret = fio_cmd_option_parse(td, opt, val);
1801 if (!ret && !strcmp(opt, "ioengine")) {
1803 if (ioengine_load(td))
1805 fio_options_set_ioengine_opts(l_opts, td);
1809 case FIO_GETOPT_IOENGINE: {
1810 const char *opt = l_opts[lidx].name;
1812 ret = fio_cmd_ioengine_option_parse(td, opt, val);
1819 max_jobs = atoi(optarg);
1820 if (!max_jobs || max_jobs > REAL_MAX_JOBS) {
1821 log_err("fio: invalid max jobs: %d\n", max_jobs);
1828 log_err("fio: can't be both client and server\n");
1834 fio_server_set_arg(optarg);
1839 pid_file = strdup(optarg);
1842 if ((ret = fio_idle_prof_parse_opt(optarg))) {
1843 /* exit on error and calibration only */
1851 log_err("fio: can't be both client and server\n");
1856 if (fio_client_add(&fio_client_ops, optarg, &cur_client)) {
1857 log_err("fio: failed adding client %s\n", optarg);
1863 * If the next argument exists and isn't an option,
1864 * assume it's a job file for this client only.
1866 while (optind < argc) {
1867 if (!strncmp(argv[optind], "--", 2) ||
1868 !strncmp(argv[optind], "-", 1))
1871 fio_client_add_ini_file(cur_client, argv[optind]);
1877 exit_val = fio_monotonic_clocktest();
1881 exit_val = fio_crctest(optarg);
1886 if (check_str_time(optarg, &val)) {
1887 log_err("fio: failed parsing time %s\n", optarg);
1892 status_interval = val * 1000;
1896 log_err("%s: unrecognized option '%s'\n", argv[0],
1907 if (do_exit && !(is_backend || nr_clients))
1910 if (nr_clients && fio_clients_connect()) {
1916 if (is_backend && backend)
1917 return fio_start_server(pid_file);
1921 ret = add_job(td, td->o.name ?: "fio", 0, 0, client_type);
1924 while (!ret && optind < argc) {
1926 ini_file = realloc(ini_file, ini_idx * sizeof(char *));
1927 ini_file[ini_idx - 1] = strdup(argv[optind]);
1934 int fio_init_options(void)
1939 fio_options_fill_optstring();
1940 fio_options_dup_and_init(l_opts);
1944 if (fill_def_thread())
1950 extern int fio_check_options(struct thread_options *);
1952 int parse_options(int argc, char *argv[])
1954 const int type = FIO_CLIENT_TYPE_CLI;
1957 if (fio_init_options())
1959 if (fio_test_cconv(&def_thread.o))
1960 log_err("fio: failed internal cconv test\n");
1962 job_files = parse_cmd_line(argc, argv, type);
1964 if (job_files > 0) {
1965 for (i = 0; i < job_files; i++) {
1966 if (fill_def_thread())
1969 if (fio_clients_send_ini(ini_file[i]))
1972 } else if (!is_backend) {
1973 if (parse_jobs_ini(ini_file[i], 0, i, type))
1978 } else if (nr_clients) {
1979 if (fill_def_thread())
1981 if (fio_clients_send_ini(NULL))
1986 fio_options_free(&def_thread);
1988 if (!thread_number) {
1993 if (is_backend || nr_clients)
1998 log_err("No jobs(s) defined\n\n");
2008 if (def_thread.o.gtod_offload) {
2010 fio_gtod_offload = 1;
2011 fio_gtod_cpu = def_thread.o.gtod_cpu;
2014 if (output_format == FIO_OUTPUT_NORMAL)
2015 log_info("%s\n", fio_version_string);
2020 void options_default_fill(struct thread_options *o)
2022 memcpy(o, &def_thread.o, sizeof(*o));