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 * Lazy way of fixing up options that depend on each other. We could also
417 * define option callback handlers, but this is easier.
419 static int fixup_options(struct thread_data *td)
421 struct thread_options *o = &td->o;
424 #ifndef FIO_HAVE_PSHARED_MUTEX
425 if (!o->use_thread) {
426 log_info("fio: this platform does not support process shared"
427 " mutexes, forcing use of threads. Use the 'thread'"
428 " option to get rid of this warning.\n");
430 ret = warnings_fatal;
434 if (o->write_iolog_file && o->read_iolog_file) {
435 log_err("fio: read iolog overrides write_iolog\n");
436 free(o->write_iolog_file);
437 o->write_iolog_file = NULL;
438 ret = warnings_fatal;
442 * only really works with 1 file
444 if (o->zone_size && o->open_files > 1)
448 * If zone_range isn't specified, backward compatibility dictates it
449 * should be made equal to zone_size.
451 if (o->zone_size && !o->zone_range)
452 o->zone_range = o->zone_size;
455 * Reads can do overwrites, we always need to pre-create the file
457 if (td_read(td) || td_rw(td))
460 if (!o->min_bs[DDIR_READ])
461 o->min_bs[DDIR_READ] = o->bs[DDIR_READ];
462 if (!o->max_bs[DDIR_READ])
463 o->max_bs[DDIR_READ] = o->bs[DDIR_READ];
464 if (!o->min_bs[DDIR_WRITE])
465 o->min_bs[DDIR_WRITE] = o->bs[DDIR_WRITE];
466 if (!o->max_bs[DDIR_WRITE])
467 o->max_bs[DDIR_WRITE] = o->bs[DDIR_WRITE];
468 if (!o->min_bs[DDIR_TRIM])
469 o->min_bs[DDIR_TRIM] = o->bs[DDIR_TRIM];
470 if (!o->max_bs[DDIR_TRIM])
471 o->max_bs[DDIR_TRIM] = o->bs[DDIR_TRIM];
474 o->rw_min_bs = min(o->min_bs[DDIR_READ], o->min_bs[DDIR_WRITE]);
475 o->rw_min_bs = min(o->min_bs[DDIR_TRIM], o->rw_min_bs);
478 * For random IO, allow blockalign offset other than min_bs.
480 if (!o->ba[DDIR_READ] || !td_random(td))
481 o->ba[DDIR_READ] = o->min_bs[DDIR_READ];
482 if (!o->ba[DDIR_WRITE] || !td_random(td))
483 o->ba[DDIR_WRITE] = o->min_bs[DDIR_WRITE];
484 if (!o->ba[DDIR_TRIM] || !td_random(td))
485 o->ba[DDIR_TRIM] = o->min_bs[DDIR_TRIM];
487 if ((o->ba[DDIR_READ] != o->min_bs[DDIR_READ] ||
488 o->ba[DDIR_WRITE] != o->min_bs[DDIR_WRITE] ||
489 o->ba[DDIR_TRIM] != o->min_bs[DDIR_TRIM]) &&
491 log_err("fio: Any use of blockalign= turns off randommap\n");
493 ret = warnings_fatal;
496 if (!o->file_size_high)
497 o->file_size_high = o->file_size_low;
499 if (o->norandommap && o->verify != VERIFY_NONE
500 && !fixed_block_size(o)) {
501 log_err("fio: norandommap given for variable block sizes, "
502 "verify disabled\n");
503 o->verify = VERIFY_NONE;
504 ret = warnings_fatal;
506 if (o->bs_unaligned && (o->odirect || td->io_ops->flags & FIO_RAWIO))
507 log_err("fio: bs_unaligned may not work with raw io\n");
510 * thinktime_spin must be less than thinktime
512 if (o->thinktime_spin > o->thinktime)
513 o->thinktime_spin = o->thinktime;
516 * The low water mark cannot be bigger than the iodepth
518 if (o->iodepth_low > o->iodepth || !o->iodepth_low)
519 o->iodepth_low = o->iodepth;
522 * If batch number isn't set, default to the same as iodepth
524 if (o->iodepth_batch > o->iodepth || !o->iodepth_batch)
525 o->iodepth_batch = o->iodepth;
527 if (o->nr_files > td->files_index)
528 o->nr_files = td->files_index;
530 if (o->open_files > o->nr_files || !o->open_files)
531 o->open_files = o->nr_files;
533 if (((o->rate[DDIR_READ] + o->rate[DDIR_WRITE] + o->rate[DDIR_TRIM]) &&
534 (o->rate_iops[DDIR_READ] + o->rate_iops[DDIR_WRITE] + o->rate_iops[DDIR_TRIM])) ||
535 ((o->ratemin[DDIR_READ] + o->ratemin[DDIR_WRITE] + o->ratemin[DDIR_TRIM]) &&
536 (o->rate_iops_min[DDIR_READ] + o->rate_iops_min[DDIR_WRITE] + o->rate_iops_min[DDIR_TRIM]))) {
537 log_err("fio: rate and rate_iops are mutually exclusive\n");
540 if ((o->rate[DDIR_READ] < o->ratemin[DDIR_READ]) ||
541 (o->rate[DDIR_WRITE] < o->ratemin[DDIR_WRITE]) ||
542 (o->rate[DDIR_TRIM] < o->ratemin[DDIR_TRIM]) ||
543 (o->rate_iops[DDIR_READ] < o->rate_iops_min[DDIR_READ]) ||
544 (o->rate_iops[DDIR_WRITE] < o->rate_iops_min[DDIR_WRITE]) ||
545 (o->rate_iops[DDIR_TRIM] < o->rate_iops_min[DDIR_TRIM])) {
546 log_err("fio: minimum rate exceeds rate\n");
550 if (!o->timeout && o->time_based) {
551 log_err("fio: time_based requires a runtime/timeout setting\n");
553 ret = warnings_fatal;
556 if (o->fill_device && !o->size)
559 if (o->verify != VERIFY_NONE) {
560 if (td_write(td) && o->do_verify && o->numjobs > 1) {
561 log_info("Multiple writers may overwrite blocks that "
562 "belong to other jobs. This can cause "
563 "verification failures.\n");
564 ret = warnings_fatal;
567 o->refill_buffers = 1;
568 if (o->max_bs[DDIR_WRITE] != o->min_bs[DDIR_WRITE] &&
570 o->verify_interval = o->min_bs[DDIR_WRITE];
574 o->invalidate_cache = 0;
575 if (td->io_ops->flags & FIO_PIPEIO) {
576 log_info("fio: cannot pre-read files with an IO engine"
577 " that isn't seekable. Pre-read disabled.\n");
578 ret = warnings_fatal;
583 if (td->io_ops->flags & FIO_BIT_BASED)
589 #ifndef CONFIG_FDATASYNC
590 if (o->fdatasync_blocks) {
591 log_info("fio: this platform does not support fdatasync()"
592 " falling back to using fsync(). Use the 'fsync'"
593 " option instead of 'fdatasync' to get rid of"
595 o->fsync_blocks = o->fdatasync_blocks;
596 o->fdatasync_blocks = 0;
597 ret = warnings_fatal;
603 * Windows doesn't support O_DIRECT or O_SYNC with the _open interface,
604 * so fail if we're passed those flags
606 if ((td->io_ops->flags & FIO_SYNCIO) && (td->o.odirect || td->o.sync_io)) {
607 log_err("fio: Windows does not support direct or non-buffered io with"
608 " the synchronous ioengines. Use the 'windowsaio' ioengine"
609 " with 'direct=1' and 'iodepth=1' instead.\n");
615 * For fully compressible data, just zero them at init time.
616 * It's faster than repeatedly filling it.
618 if (td->o.compress_percentage == 100) {
619 td->o.zero_buffers = 1;
620 td->o.compress_percentage = 0;
624 * Using a non-uniform random distribution excludes usage of
627 if (td->o.random_distribution != FIO_RAND_DIST_RANDOM)
628 td->o.norandommap = 1;
631 * If size is set but less than the min block size, complain
633 if (o->size && o->size < td_min_bs(td)) {
634 log_err("fio: size too small, must be larger than the IO size: %llu\n", (unsigned long long) o->size);
639 * O_ATOMIC implies O_DIRECT
645 * If randseed is set, that overrides randrepeat
648 td->o.rand_repeatable = 0;
654 * This function leaks the buffer
656 char *fio_uint_to_kmg(unsigned int val)
658 char *buf = malloc(32);
659 char post[] = { 0, 'K', 'M', 'G', 'P', 'E', 0 };
670 snprintf(buf, 32, "%u%c", val, *p);
674 /* External engines are specified by "external:name.o") */
675 static const char *get_engine_name(const char *str)
677 char *p = strstr(str, ":");
683 strip_blank_front(&p);
688 static int exists_and_not_file(const char *filename)
692 if (lstat(filename, &sb) == -1)
695 /* \\.\ is the device namespace in Windows, where every file
696 * is a device node */
697 if (S_ISREG(sb.st_mode) && strncmp(filename, "\\\\.\\", 4) != 0)
703 static void td_fill_rand_seeds_os(struct thread_data *td)
705 os_random_seed(td->rand_seeds[FIO_RAND_BS_OFF], &td->bsrange_state);
706 os_random_seed(td->rand_seeds[FIO_RAND_VER_OFF], &td->verify_state);
707 os_random_seed(td->rand_seeds[FIO_RAND_MIX_OFF], &td->rwmix_state);
709 if (td->o.file_service_type == FIO_FSERVICE_RANDOM)
710 os_random_seed(td->rand_seeds[FIO_RAND_FILE_OFF], &td->next_file_state);
712 os_random_seed(td->rand_seeds[FIO_RAND_FILE_SIZE_OFF], &td->file_size_state);
713 os_random_seed(td->rand_seeds[FIO_RAND_TRIM_OFF], &td->trim_state);
718 if (td->o.rand_repeatable)
719 td->rand_seeds[FIO_RAND_BLOCK_OFF] = FIO_RANDSEED * td->thread_number;
721 os_random_seed(td->rand_seeds[FIO_RAND_BLOCK_OFF], &td->random_state);
723 os_random_seed(td->rand_seeds[FIO_RAND_SEQ_RAND_READ_OFF], &td->seq_rand_state[DDIR_READ]);
724 os_random_seed(td->rand_seeds[FIO_RAND_SEQ_RAND_WRITE_OFF], &td->seq_rand_state[DDIR_WRITE]);
725 os_random_seed(td->rand_seeds[FIO_RAND_SEQ_RAND_TRIM_OFF], &td->seq_rand_state[DDIR_TRIM]);
728 static void td_fill_rand_seeds_internal(struct thread_data *td)
730 init_rand_seed(&td->__bsrange_state, td->rand_seeds[FIO_RAND_BS_OFF]);
731 init_rand_seed(&td->__verify_state, td->rand_seeds[FIO_RAND_VER_OFF]);
732 init_rand_seed(&td->__rwmix_state, td->rand_seeds[FIO_RAND_MIX_OFF]);
734 if (td->o.file_service_type == FIO_FSERVICE_RANDOM)
735 init_rand_seed(&td->__next_file_state, td->rand_seeds[FIO_RAND_FILE_OFF]);
737 init_rand_seed(&td->__file_size_state, td->rand_seeds[FIO_RAND_FILE_SIZE_OFF]);
738 init_rand_seed(&td->__trim_state, td->rand_seeds[FIO_RAND_TRIM_OFF]);
743 if (td->o.rand_repeatable)
744 td->rand_seeds[FIO_RAND_BLOCK_OFF] = FIO_RANDSEED * td->thread_number;
746 init_rand_seed(&td->__random_state, td->rand_seeds[FIO_RAND_BLOCK_OFF]);
747 init_rand_seed(&td->__seq_rand_state[DDIR_READ], td->rand_seeds[FIO_RAND_SEQ_RAND_READ_OFF]);
748 init_rand_seed(&td->__seq_rand_state[DDIR_WRITE], td->rand_seeds[FIO_RAND_SEQ_RAND_WRITE_OFF]);
749 init_rand_seed(&td->__seq_rand_state[DDIR_TRIM], td->rand_seeds[FIO_RAND_SEQ_RAND_TRIM_OFF]);
752 void td_fill_rand_seeds(struct thread_data *td)
754 if (td->o.use_os_rand)
755 td_fill_rand_seeds_os(td);
757 td_fill_rand_seeds_internal(td);
759 init_rand_seed(&td->buf_state, td->rand_seeds[FIO_RAND_BUF_OFF]);
763 * Initializes the ioengine configured for a job, if it has not been done so
766 int ioengine_load(struct thread_data *td)
771 * Engine has already been loaded.
775 if (!td->o.ioengine) {
776 log_err("fio: internal fault, no IO engine specified\n");
780 engine = get_engine_name(td->o.ioengine);
781 td->io_ops = load_ioengine(td, engine);
783 log_err("fio: failed to load engine %s\n", engine);
787 if (td->io_ops->option_struct_size && td->io_ops->options) {
789 * In cases where td->eo is set, clone it for a child thread.
790 * This requires that the parent thread has the same ioengine,
791 * but that requirement must be enforced by the code which
794 void *origeo = td->eo;
796 * Otherwise use the default thread options.
798 if (!origeo && td != &def_thread && def_thread.eo &&
799 def_thread.io_ops->options == td->io_ops->options)
800 origeo = def_thread.eo;
802 options_init(td->io_ops->options);
803 td->eo = malloc(td->io_ops->option_struct_size);
805 * Use the default thread as an option template if this uses the
806 * same options structure and there are non-default options
810 memcpy(td->eo, origeo, td->io_ops->option_struct_size);
811 options_mem_dupe(td->eo, td->io_ops->options);
813 memset(td->eo, 0, td->io_ops->option_struct_size);
814 fill_default_options(td->eo, td->io_ops->options);
816 *(struct thread_data **)td->eo = td;
822 static void init_flags(struct thread_data *td)
824 struct thread_options *o = &td->o;
826 if (o->verify_backlog)
827 td->flags |= TD_F_VER_BACKLOG;
829 td->flags |= TD_F_TRIM_BACKLOG;
830 if (o->read_iolog_file)
831 td->flags |= TD_F_READ_IOLOG;
832 if (o->refill_buffers)
833 td->flags |= TD_F_REFILL_BUFFERS;
834 if (o->scramble_buffers)
835 td->flags |= TD_F_SCRAMBLE_BUFFERS;
836 if (o->verify != VERIFY_NONE)
837 td->flags |= TD_F_VER_NONE;
840 static int setup_random_seeds(struct thread_data *td)
845 if (!td->o.rand_repeatable && !td->o.rand_seed)
846 return init_random_state(td, td->rand_seeds, sizeof(td->rand_seeds));
848 if (!td->o.rand_seed)
851 seed = td->o.rand_seed;
853 for (i = 0; i < 4; i++)
854 seed *= 0x9e370001UL;
856 for (i = 0; i < FIO_RAND_NR_OFFS; i++) {
857 td->rand_seeds[i] = seed;
858 seed *= 0x9e370001UL;
861 td_fill_rand_seeds(td);
872 static struct fpre_keyword {
876 } fpre_keywords[] = {
877 { .keyword = "$jobname", .key = FPRE_JOBNAME, },
878 { .keyword = "$jobnum", .key = FPRE_JOBNUM, },
879 { .keyword = "$filenum", .key = FPRE_FILENUM, },
880 { .keyword = NULL, },
883 static char *make_filename(char *buf, struct thread_options *o,
884 const char *jobname, int jobnum, int filenum)
886 struct fpre_keyword *f;
889 if (!o->filename_format || !strlen(o->filename_format)) {
890 sprintf(buf, "%s.%d.%d", jobname, jobnum, filenum);
894 for (f = &fpre_keywords[0]; f->keyword; f++)
895 f->strlen = strlen(f->keyword);
897 strcpy(buf, o->filename_format);
898 memset(copy, 0, sizeof(copy));
899 for (f = &fpre_keywords[0]; f->keyword; f++) {
901 size_t pre_len, post_start = 0;
902 char *str, *dst = copy;
904 str = strcasestr(buf, f->keyword);
909 if (strlen(str) != f->strlen)
910 post_start = pre_len + f->strlen;
913 strncpy(dst, buf, pre_len);
919 dst += sprintf(dst, "%s", jobname);
922 dst += sprintf(dst, "%d", jobnum);
925 dst += sprintf(dst, "%d", filenum);
933 strcpy(dst, buf + post_start);
942 int parse_dryrun(void)
944 return dump_cmdline || parse_only;
948 * Adds a job to the list of things todo. Sanitizes the various options
949 * to make sure we don't have conflicts, and initializes various
952 static int add_job(struct thread_data *td, const char *jobname, int job_add_num,
953 int recursed, int client_type)
956 char fname[PATH_MAX];
957 int numjobs, file_alloced;
958 struct thread_options *o = &td->o;
961 * the def_thread is just for options, it's not a real job
963 if (td == &def_thread)
969 * if we are just dumping the output command line, don't add the job
971 if (parse_dryrun()) {
976 td->client_type = client_type;
978 if (profile_td_init(td))
981 if (ioengine_load(td))
985 td->io_ops->flags |= FIO_RAWIO;
988 if (!o->filename && !td->files_index && !o->read_iolog_file) {
991 if (o->nr_files == 1 && exists_and_not_file(jobname))
992 add_file(td, jobname);
994 for (i = 0; i < o->nr_files; i++)
995 add_file(td, make_filename(fname, o, jobname, td->thread_number, i));
999 if (fixup_options(td))
1005 * IO engines only need this for option callbacks, and the address may
1006 * change in subprocesses.
1009 *(struct thread_data **)td->eo = NULL;
1011 if (td->io_ops->flags & FIO_DISKLESSIO) {
1014 for_each_file(td, f, i)
1015 f->real_file_size = -1ULL;
1018 td->mutex = fio_mutex_init(FIO_MUTEX_LOCKED);
1020 td->ts.clat_percentiles = o->clat_percentiles;
1021 td->ts.percentile_precision = o->percentile_precision;
1022 memcpy(td->ts.percentile_list, o->percentile_list, sizeof(o->percentile_list));
1024 for (i = 0; i < DDIR_RWDIR_CNT; i++) {
1025 td->ts.clat_stat[i].min_val = ULONG_MAX;
1026 td->ts.slat_stat[i].min_val = ULONG_MAX;
1027 td->ts.lat_stat[i].min_val = ULONG_MAX;
1028 td->ts.bw_stat[i].min_val = ULONG_MAX;
1030 td->ddir_seq_nr = o->ddir_seq_nr;
1032 if ((o->stonewall || o->new_group) && prev_group_jobs) {
1033 prev_group_jobs = 0;
1037 td->groupid = groupid;
1040 if (setup_random_seeds(td)) {
1041 td_verror(td, errno, "init_random_state");
1048 if (o->lat_log_file) {
1049 setup_log(&td->lat_log, o->log_avg_msec, IO_LOG_TYPE_LAT);
1050 setup_log(&td->slat_log, o->log_avg_msec, IO_LOG_TYPE_SLAT);
1051 setup_log(&td->clat_log, o->log_avg_msec, IO_LOG_TYPE_CLAT);
1054 setup_log(&td->bw_log, o->log_avg_msec, IO_LOG_TYPE_BW);
1055 if (o->iops_log_file)
1056 setup_log(&td->iops_log, o->log_avg_msec, IO_LOG_TYPE_IOPS);
1059 o->name = strdup(jobname);
1061 if (output_format == FIO_OUTPUT_NORMAL) {
1063 if (is_backend && !recursed)
1064 fio_server_send_add_job(td);
1066 if (!(td->io_ops->flags & FIO_NOIO)) {
1067 char *c1, *c2, *c3, *c4;
1068 char *c5 = NULL, *c6 = NULL;
1070 c1 = fio_uint_to_kmg(o->min_bs[DDIR_READ]);
1071 c2 = fio_uint_to_kmg(o->max_bs[DDIR_READ]);
1072 c3 = fio_uint_to_kmg(o->min_bs[DDIR_WRITE]);
1073 c4 = fio_uint_to_kmg(o->max_bs[DDIR_WRITE]);
1075 if (!o->bs_is_seq_rand) {
1076 c5 = fio_uint_to_kmg(o->min_bs[DDIR_TRIM]);
1077 c6 = fio_uint_to_kmg(o->max_bs[DDIR_TRIM]);
1080 log_info("%s: (g=%d): rw=%s, ", td->o.name,
1082 ddir_str(o->td_ddir));
1084 if (o->bs_is_seq_rand)
1085 log_info("bs(seq/rand)=%s-%s/%s-%s, ",
1088 log_info("bs=%s-%s/%s-%s/%s-%s, ",
1089 c1, c2, c3, c4, c5, c6);
1091 log_info("ioengine=%s, iodepth=%u\n",
1092 td->io_ops->name, o->iodepth);
1101 } else if (job_add_num == 1)
1106 * recurse add identical jobs, clear numjobs and stonewall options
1107 * as they don't apply to sub-jobs
1109 numjobs = o->numjobs;
1111 struct thread_data *td_new = get_new_job(0, td, 1);
1116 td_new->o.numjobs = 1;
1117 td_new->o.stonewall = 0;
1118 td_new->o.new_group = 0;
1121 td_new->o.filename = NULL;
1122 td_new->files_index = 0;
1123 td_new->files_size = 0;
1124 td_new->files = NULL;
1127 job_add_num = numjobs - 1;
1129 if (add_job(td_new, jobname, job_add_num, 1, client_type))
1140 * Parse as if 'o' was a command line
1142 void add_job_opts(const char **o, int client_type)
1144 struct thread_data *td, *td_parent;
1145 int i, in_global = 1;
1149 td_parent = td = NULL;
1151 if (!strncmp(o[i], "name", 4)) {
1154 add_job(td, jobname, 0, 0, client_type);
1156 sprintf(jobname, "%s", o[i] + 5);
1158 if (in_global && !td_parent)
1159 td_parent = get_new_job(1, &def_thread, 0);
1160 else if (!in_global && !td) {
1162 td_parent = &def_thread;
1163 td = get_new_job(0, td_parent, 0);
1166 fio_options_parse(td_parent, (char **) &o[i], 1, 0);
1168 fio_options_parse(td, (char **) &o[i], 1, 0);
1173 add_job(td, jobname, 0, 0, client_type);
1176 static int skip_this_section(const char *name)
1180 if (!nr_job_sections)
1182 if (!strncmp(name, "global", 6))
1185 for (i = 0; i < nr_job_sections; i++)
1186 if (!strcmp(job_sections[i], name))
1192 static int is_empty_or_comment(char *line)
1196 for (i = 0; i < strlen(line); i++) {
1201 if (!isspace((int) line[i]) && !iscntrl((int) line[i]))
1209 * This is our [ini] type file parser.
1211 int parse_jobs_ini(char *file, int is_buf, int stonewall_flag, int type)
1213 unsigned int global;
1214 struct thread_data *td;
1215 char *string, *name;
1218 int ret = 0, stonewall;
1221 int inside_skip = 0;
1223 int i, alloc_opts, num_opts;
1228 if (!strcmp(file, "-"))
1231 f = fopen(file, "r");
1234 perror("fopen job file");
1239 string = malloc(4096);
1242 * it's really 256 + small bit, 280 should suffice
1245 memset(name, 0, 280);
1248 opts = malloc(sizeof(char *) * alloc_opts);
1251 stonewall = stonewall_flag;
1254 * if skip_fgets is set, we already have loaded a line we
1259 p = strsep(&file, "\n");
1261 p = fgets(string, 4096, f);
1267 strip_blank_front(&p);
1270 if (is_empty_or_comment(p))
1272 if (sscanf(p, "[%255[^\n]]", name) != 1) {
1275 log_err("fio: option <%s> outside of [] job section\n",
1280 name[strlen(name) - 1] = '\0';
1282 if (skip_this_section(name)) {
1288 global = !strncmp(name, "global", 6);
1294 log_info("--name=%s ", name);
1298 td = get_new_job(global, &def_thread, 0);
1305 * Separate multiple job files by a stonewall
1307 if (!global && stonewall) {
1308 td->o.stonewall = stonewall;
1313 memset(opts, 0, alloc_opts * sizeof(char *));
1317 p = strsep(&file, "\n");
1319 p = fgets(string, 4096, f);
1323 if (is_empty_or_comment(p))
1326 strip_blank_front(&p);
1329 * new section, break out and make sure we don't
1330 * fgets() a new line at the top.
1339 if (num_opts == alloc_opts) {
1341 opts = realloc(opts,
1342 alloc_opts * sizeof(char *));
1345 opts[num_opts] = strdup(p);
1349 ret = fio_options_parse(td, opts, num_opts, dump_cmdline);
1351 ret = add_job(td, name, 0, 0, type);
1353 log_err("fio: job %s dropped\n", name);
1357 for (i = 0; i < num_opts; i++)
1366 while (i < nr_job_sections) {
1367 free(job_sections[i]);
1371 for (i = 0; i < num_opts; i++)
1377 if (!is_buf && f != stdin)
1382 static int fill_def_thread(void)
1384 memset(&def_thread, 0, sizeof(def_thread));
1386 fio_getaffinity(getpid(), &def_thread.o.cpumask);
1387 def_thread.o.timeout = def_timeout;
1388 def_thread.o.error_dump = 1;
1390 * fill default options
1392 fio_fill_default_options(&def_thread);
1396 static void usage(const char *name)
1398 printf("%s\n", fio_version_string);
1399 printf("%s [options] [job options] <job file(s)>\n", name);
1400 printf(" --debug=options\tEnable debug logging. May be one/more of:\n"
1401 "\t\t\tprocess,file,io,mem,blktrace,verify,random,parse,\n"
1402 "\t\t\tdiskutil,job,mutex,profile,time,net,rate\n");
1403 printf(" --parse-only\t\tParse options only, don't start any IO\n");
1404 printf(" --output\t\tWrite output to file\n");
1405 printf(" --runtime\t\tRuntime in seconds\n");
1406 printf(" --latency-log\t\tGenerate per-job latency logs\n");
1407 printf(" --bandwidth-log\tGenerate per-job bandwidth logs\n");
1408 printf(" --minimal\t\tMinimal (terse) output\n");
1409 printf(" --output-format=x\tOutput format (terse,json,normal)\n");
1410 printf(" --terse-version=x\tSet terse version output format to 'x'\n");
1411 printf(" --version\t\tPrint version info and exit\n");
1412 printf(" --help\t\tPrint this page\n");
1413 printf(" --cpuclock-test\tPerform test/validation of CPU clock\n");
1414 printf(" --crctest\t\tTest speed of checksum functions\n");
1415 printf(" --cmdhelp=cmd\t\tPrint command help, \"all\" for all of"
1417 printf(" --enghelp=engine\tPrint ioengine help, or list"
1418 " available ioengines\n");
1419 printf(" --enghelp=engine,cmd\tPrint help for an ioengine"
1421 printf(" --showcmd\t\tTurn a job file into command line options\n");
1422 printf(" --eta=when\t\tWhen ETA estimate should be printed\n");
1423 printf(" \t\tMay be \"always\", \"never\" or \"auto\"\n");
1424 printf(" --eta-newline=time\tForce a new line for every 'time'");
1425 printf(" period passed\n");
1426 printf(" --status-interval=t\tForce full status dump every");
1427 printf(" 't' period passed\n");
1428 printf(" --readonly\t\tTurn on safety read-only checks, preventing"
1430 printf(" --section=name\tOnly run specified section in job file\n");
1431 printf(" --alloc-size=kb\tSet smalloc pool to this size in kb"
1433 printf(" --warnings-fatal\tFio parser warnings are fatal\n");
1434 printf(" --max-jobs=nr\t\tMaximum number of threads/processes to support\n");
1435 printf(" --server=args\t\tStart a backend fio server\n");
1436 printf(" --daemonize=pidfile\tBackground fio server, write pid to file\n");
1437 printf(" --client=hostname\tTalk to remote backend fio server at hostname\n");
1438 printf(" --idle-prof=option\tReport cpu idleness on a system or percpu basis\n"
1439 "\t\t\t(option=system,percpu) or run unit work\n"
1440 "\t\t\tcalibration only (option=calibrate)\n");
1441 printf("\nFio was written by Jens Axboe <jens.axboe@oracle.com>");
1442 printf("\n Jens Axboe <jaxboe@fusionio.com>");
1443 printf("\n Jens Axboe <axboe@fb.com>\n");
1446 #ifdef FIO_INC_DEBUG
1447 struct debug_level debug_levels[] = {
1448 { .name = "process",
1449 .help = "Process creation/exit logging",
1450 .shift = FD_PROCESS,
1453 .help = "File related action logging",
1457 .help = "IO and IO engine action logging (offsets, queue, completions, etc)",
1461 .help = "Memory allocation/freeing logging",
1464 { .name = "blktrace",
1465 .help = "blktrace action logging",
1466 .shift = FD_BLKTRACE,
1469 .help = "IO verification action logging",
1473 .help = "Random generation logging",
1477 .help = "Parser logging",
1480 { .name = "diskutil",
1481 .help = "Disk utility logging actions",
1482 .shift = FD_DISKUTIL,
1485 .help = "Logging related to creating/destroying jobs",
1489 .help = "Mutex logging",
1492 { .name = "profile",
1493 .help = "Logging related to profiles",
1494 .shift = FD_PROFILE,
1497 .help = "Logging related to time keeping functions",
1501 .help = "Network logging",
1505 .help = "Rate logging",
1511 static int set_debug(const char *string)
1513 struct debug_level *dl;
1514 char *p = (char *) string;
1518 if (!strcmp(string, "?") || !strcmp(string, "help")) {
1519 log_info("fio: dumping debug options:");
1520 for (i = 0; debug_levels[i].name; i++) {
1521 dl = &debug_levels[i];
1522 log_info("%s,", dl->name);
1528 while ((opt = strsep(&p, ",")) != NULL) {
1531 if (!strncmp(opt, "all", 3)) {
1532 log_info("fio: set all debug options\n");
1537 for (i = 0; debug_levels[i].name; i++) {
1538 dl = &debug_levels[i];
1539 found = !strncmp(opt, dl->name, strlen(dl->name));
1543 if (dl->shift == FD_JOB) {
1544 opt = strchr(opt, ':');
1546 log_err("fio: missing job number\n");
1550 fio_debug_jobno = atoi(opt);
1551 log_info("fio: set debug jobno %d\n",
1554 log_info("fio: set debug option %s\n", opt);
1555 fio_debug |= (1UL << dl->shift);
1561 log_err("fio: debug mask %s not found\n", opt);
1566 static int set_debug(const char *string)
1568 log_err("fio: debug tracing not included in build\n");
1573 static void fio_options_fill_optstring(void)
1575 char *ostr = cmd_optstr;
1579 while (l_opts[i].name) {
1580 ostr[c++] = l_opts[i].val;
1581 if (l_opts[i].has_arg == required_argument)
1583 else if (l_opts[i].has_arg == optional_argument) {
1592 static int client_flag_set(char c)
1597 while (l_opts[i].name) {
1598 int val = l_opts[i].val;
1600 if (c == (val & 0xff))
1601 return (val & FIO_CLIENT_FLAG);
1609 void parse_cmd_client(void *client, char *opt)
1611 fio_client_add_cmd_option(client, opt);
1614 extern int fio_crctest(const char *);
1616 int parse_cmd_line(int argc, char *argv[], int client_type)
1618 struct thread_data *td = NULL;
1619 int c, ini_idx = 0, lidx, ret = 0, do_exit = 0, exit_val = 0;
1620 char *ostr = cmd_optstr;
1621 void *pid_file = NULL;
1622 void *cur_client = NULL;
1626 * Reset optind handling, since we may call this multiple times
1631 while ((c = getopt_long_only(argc, argv, ostr, l_opts, &lidx)) != -1) {
1634 if ((c & FIO_CLIENT_FLAG) || client_flag_set(c)) {
1635 parse_cmd_client(cur_client, argv[optind - 1]);
1636 c &= ~FIO_CLIENT_FLAG;
1641 smalloc_pool_size = atoi(optarg);
1644 def_timeout = atoi(optarg);
1653 f_out = fopen(optarg, "w+");
1655 perror("fopen output");
1661 output_format = FIO_OUTPUT_TERSE;
1665 log_err("fio: missing --output-format argument\n");
1670 if (!strcmp(optarg, "minimal") ||
1671 !strcmp(optarg, "terse") ||
1672 !strcmp(optarg, "csv"))
1673 output_format = FIO_OUTPUT_TERSE;
1674 else if (!strcmp(optarg, "json"))
1675 output_format = FIO_OUTPUT_JSON;
1677 output_format = FIO_OUTPUT_NORMAL;
1687 fio_show_option_help(optarg);
1693 fio_show_ioengine_help(optarg);
1705 log_info("%s\n", fio_version_string);
1710 terse_version = atoi(optarg);
1711 if (!(terse_version == 2 || terse_version == 3 ||
1712 terse_version == 4)) {
1713 log_err("fio: bad terse version format\n");
1719 if (!strcmp("always", optarg))
1720 eta_print = FIO_ETA_ALWAYS;
1721 else if (!strcmp("never", optarg))
1722 eta_print = FIO_ETA_NEVER;
1727 if (str_to_decimal(optarg, &t, 0, NULL)) {
1728 log_err("fio: failed parsing eta time %s\n", optarg);
1736 if (set_debug(optarg))
1745 if (!strcmp(optarg, "global")) {
1746 log_err("fio: can't use global as only "
1752 new_size = (nr_job_sections + 1) * sizeof(char *);
1753 job_sections = realloc(job_sections, new_size);
1754 job_sections[nr_job_sections] = strdup(optarg);
1759 exec_profile = strdup(optarg);
1761 case FIO_GETOPT_JOB: {
1762 const char *opt = l_opts[lidx].name;
1765 if (!strncmp(opt, "name", 4) && td) {
1766 ret = add_job(td, td->o.name ?: "fio", 0, 0, client_type);
1772 int is_section = !strncmp(opt, "name", 4);
1775 if (!is_section || !strncmp(val, "global", 6))
1778 if (is_section && skip_this_section(val))
1781 td = get_new_job(global, &def_thread, 1);
1782 if (!td || ioengine_load(td))
1784 fio_options_set_ioengine_opts(l_opts, td);
1787 if ((!val || !strlen(val)) &&
1788 l_opts[lidx].has_arg == required_argument) {
1789 log_err("fio: option %s requires an argument\n", opt);
1792 ret = fio_cmd_option_parse(td, opt, val);
1802 if (!ret && !strcmp(opt, "ioengine")) {
1804 if (ioengine_load(td))
1806 fio_options_set_ioengine_opts(l_opts, td);
1810 case FIO_GETOPT_IOENGINE: {
1811 const char *opt = l_opts[lidx].name;
1813 ret = fio_cmd_ioengine_option_parse(td, opt, val);
1820 max_jobs = atoi(optarg);
1821 if (!max_jobs || max_jobs > REAL_MAX_JOBS) {
1822 log_err("fio: invalid max jobs: %d\n", max_jobs);
1829 log_err("fio: can't be both client and server\n");
1835 fio_server_set_arg(optarg);
1840 pid_file = strdup(optarg);
1843 if ((ret = fio_idle_prof_parse_opt(optarg))) {
1844 /* exit on error and calibration only */
1852 log_err("fio: can't be both client and server\n");
1857 if (fio_client_add(&fio_client_ops, optarg, &cur_client)) {
1858 log_err("fio: failed adding client %s\n", optarg);
1864 * If the next argument exists and isn't an option,
1865 * assume it's a job file for this client only.
1867 while (optind < argc) {
1868 if (!strncmp(argv[optind], "--", 2) ||
1869 !strncmp(argv[optind], "-", 1))
1872 fio_client_add_ini_file(cur_client, argv[optind]);
1878 exit_val = fio_monotonic_clocktest();
1882 exit_val = fio_crctest(optarg);
1887 if (check_str_time(optarg, &val)) {
1888 log_err("fio: failed parsing time %s\n", optarg);
1893 status_interval = val * 1000;
1897 log_err("%s: unrecognized option '%s'\n", argv[0],
1908 if (do_exit && !(is_backend || nr_clients))
1911 if (nr_clients && fio_clients_connect()) {
1917 if (is_backend && backend)
1918 return fio_start_server(pid_file);
1922 ret = add_job(td, td->o.name ?: "fio", 0, 0, client_type);
1925 while (!ret && optind < argc) {
1927 ini_file = realloc(ini_file, ini_idx * sizeof(char *));
1928 ini_file[ini_idx - 1] = strdup(argv[optind]);
1935 int fio_init_options(void)
1940 fio_options_fill_optstring();
1941 fio_options_dup_and_init(l_opts);
1945 if (fill_def_thread())
1951 extern int fio_check_options(struct thread_options *);
1953 int parse_options(int argc, char *argv[])
1955 const int type = FIO_CLIENT_TYPE_CLI;
1958 if (fio_init_options())
1960 if (fio_test_cconv(&def_thread.o))
1961 log_err("fio: failed internal cconv test\n");
1963 job_files = parse_cmd_line(argc, argv, type);
1965 if (job_files > 0) {
1966 for (i = 0; i < job_files; i++) {
1967 if (fill_def_thread())
1970 if (fio_clients_send_ini(ini_file[i]))
1973 } else if (!is_backend) {
1974 if (parse_jobs_ini(ini_file[i], 0, i, type))
1979 } else if (nr_clients) {
1980 if (fill_def_thread())
1982 if (fio_clients_send_ini(NULL))
1987 fio_options_free(&def_thread);
1989 if (!thread_number) {
1994 if (is_backend || nr_clients)
1999 log_err("No jobs(s) defined\n\n");
2009 if (def_thread.o.gtod_offload) {
2011 fio_gtod_offload = 1;
2012 fio_gtod_cpu = def_thread.o.gtod_cpu;
2015 if (output_format == FIO_OUTPUT_NORMAL)
2016 log_info("%s\n", fio_version_string);
2021 void options_default_fill(struct thread_options *o)
2023 memcpy(o, &def_thread.o, sizeof(*o));