2 * This file contains job initialization and setup functions.
12 #ifndef FIO_NO_HAVE_SHM_H
15 #include <sys/types.h>
27 #include "lib/getopt.h"
29 const char fio_version_string[] = FIO_VERSION;
31 #define FIO_RANDSEED (0xb1899bedUL)
33 static char **ini_file;
34 static int max_jobs = FIO_MAX_JOBS;
35 static int dump_cmdline;
36 static int def_timeout;
38 static struct thread_data def_thread;
39 struct thread_data *threads = NULL;
41 int exitall_on_terminate = 0;
42 int output_format = FIO_OUTPUT_NORMAL;
43 int eta_print = FIO_ETA_AUTO;
44 unsigned long long mlock_size = 0;
47 char **job_sections = NULL;
48 int nr_job_sections = 0;
49 char *exec_profile = NULL;
50 int warnings_fatal = 0;
51 int terse_version = 3;
59 static int write_lat_log;
61 static int prev_group_jobs;
63 unsigned long fio_debug = 0;
64 unsigned int fio_debug_jobno = -1;
65 unsigned int *fio_debug_jobp = NULL;
67 static char cmd_optstr[256];
70 #define FIO_CLIENT_FLAG (1 << 16)
73 * Command line options. These will contain the above, plus a few
74 * extra that only pertain to fio itself and not jobs.
76 static struct option l_opts[FIO_NR_OPTIONS] = {
78 .name = (char *) "output",
79 .has_arg = required_argument,
80 .val = 'o' | FIO_CLIENT_FLAG,
83 .name = (char *) "timeout",
84 .has_arg = required_argument,
85 .val = 't' | FIO_CLIENT_FLAG,
88 .name = (char *) "latency-log",
89 .has_arg = required_argument,
90 .val = 'l' | FIO_CLIENT_FLAG,
93 .name = (char *) "bandwidth-log",
94 .has_arg = required_argument,
95 .val = 'b' | FIO_CLIENT_FLAG,
98 .name = (char *) "minimal",
99 .has_arg = optional_argument,
100 .val = 'm' | FIO_CLIENT_FLAG,
103 .name = (char *) "output-format",
104 .has_arg = optional_argument,
105 .val = 'F' | FIO_CLIENT_FLAG,
108 .name = (char *) "version",
109 .has_arg = no_argument,
110 .val = 'v' | FIO_CLIENT_FLAG,
113 .name = (char *) "help",
114 .has_arg = no_argument,
115 .val = 'h' | FIO_CLIENT_FLAG,
118 .name = (char *) "cmdhelp",
119 .has_arg = optional_argument,
120 .val = 'c' | FIO_CLIENT_FLAG,
123 .name = (char *) "enghelp",
124 .has_arg = optional_argument,
125 .val = 'i' | FIO_CLIENT_FLAG,
128 .name = (char *) "showcmd",
129 .has_arg = no_argument,
130 .val = 's' | FIO_CLIENT_FLAG,
133 .name = (char *) "readonly",
134 .has_arg = no_argument,
135 .val = 'r' | FIO_CLIENT_FLAG,
138 .name = (char *) "eta",
139 .has_arg = required_argument,
140 .val = 'e' | FIO_CLIENT_FLAG,
143 .name = (char *) "debug",
144 .has_arg = required_argument,
145 .val = 'd' | FIO_CLIENT_FLAG,
148 .name = (char *) "section",
149 .has_arg = required_argument,
150 .val = 'x' | FIO_CLIENT_FLAG,
153 .name = (char *) "alloc-size",
154 .has_arg = required_argument,
155 .val = 'a' | FIO_CLIENT_FLAG,
158 .name = (char *) "profile",
159 .has_arg = required_argument,
160 .val = 'p' | FIO_CLIENT_FLAG,
163 .name = (char *) "warnings-fatal",
164 .has_arg = no_argument,
165 .val = 'w' | FIO_CLIENT_FLAG,
168 .name = (char *) "max-jobs",
169 .has_arg = required_argument,
170 .val = 'j' | FIO_CLIENT_FLAG,
173 .name = (char *) "terse-version",
174 .has_arg = required_argument,
175 .val = 'V' | FIO_CLIENT_FLAG,
178 .name = (char *) "server",
179 .has_arg = optional_argument,
182 { .name = (char *) "daemonize",
183 .has_arg = required_argument,
187 .name = (char *) "client",
188 .has_arg = required_argument,
192 .name = (char *) "cpuclock-test",
193 .has_arg = no_argument,
197 .name = (char *) "idle-prof",
198 .has_arg = required_argument,
206 static void free_shm(void)
208 struct shmid_ds sbuf;
216 fio_debug_jobp = NULL;
218 shmctl(shm_id, IPC_RMID, &sbuf);
225 * The thread area is shared between the main process and the job
226 * threads/processes. So setup a shared memory segment that will hold
227 * all the job info. We use the end of the region for keeping track of
228 * open files across jobs, for file sharing.
230 static int setup_thread_area(void)
238 * 1024 is too much on some machines, scale max_jobs if
239 * we get a failure that looks like too large a shm segment
242 size_t size = max_jobs * sizeof(struct thread_data);
244 size += file_hash_size;
245 size += sizeof(unsigned int);
247 shm_id = shmget(0, size, IPC_CREAT | 0600);
250 if (errno != EINVAL && errno != ENOMEM && errno != ENOSPC) {
261 threads = shmat(shm_id, NULL, 0);
262 if (threads == (void *) -1) {
267 memset(threads, 0, max_jobs * sizeof(struct thread_data));
268 hash = (void *) threads + max_jobs * sizeof(struct thread_data);
269 fio_debug_jobp = (void *) hash + file_hash_size;
270 *fio_debug_jobp = -1;
271 file_hash_init(hash);
279 * Return a free job structure.
281 static struct thread_data *get_new_job(int global, struct thread_data *parent,
284 struct thread_data *td;
288 if (setup_thread_area()) {
289 log_err("error: failed to setup shm segment\n");
292 if (thread_number >= max_jobs) {
293 log_err("error: maximum number of jobs (%d) reached.\n",
298 td = &threads[thread_number++];
305 td->o.uid = td->o.gid = -1U;
307 dup_files(td, parent);
308 fio_options_mem_dupe(td);
310 profile_add_hooks(td);
312 td->thread_number = thread_number;
314 if (!parent || !parent->o.group_reporting)
320 static void put_job(struct thread_data *td)
322 if (td == &def_thread)
329 log_info("fio: %s\n", td->verror);
331 fio_options_free(td);
335 memset(&threads[td->thread_number - 1], 0, sizeof(*td));
339 static int __setup_rate(struct thread_data *td, enum fio_ddir ddir)
341 unsigned int bs = td->o.min_bs[ddir];
343 assert(ddir_rw(ddir));
345 if (td->o.rate[ddir])
346 td->rate_bps[ddir] = td->o.rate[ddir];
348 td->rate_bps[ddir] = td->o.rate_iops[ddir] * bs;
350 if (!td->rate_bps[ddir]) {
351 log_err("rate lower than supported\n");
355 td->rate_pending_usleep[ddir] = 0;
359 static int setup_rate(struct thread_data *td)
363 if (td->o.rate[DDIR_READ] || td->o.rate_iops[DDIR_READ])
364 ret = __setup_rate(td, DDIR_READ);
365 if (td->o.rate[DDIR_WRITE] || td->o.rate_iops[DDIR_WRITE])
366 ret |= __setup_rate(td, DDIR_WRITE);
367 if (td->o.rate[DDIR_TRIM] || td->o.rate_iops[DDIR_TRIM])
368 ret |= __setup_rate(td, DDIR_TRIM);
373 static int fixed_block_size(struct thread_options *o)
375 return o->min_bs[DDIR_READ] == o->max_bs[DDIR_READ] &&
376 o->min_bs[DDIR_WRITE] == o->max_bs[DDIR_WRITE] &&
377 o->min_bs[DDIR_TRIM] == o->max_bs[DDIR_TRIM] &&
378 o->min_bs[DDIR_READ] == o->min_bs[DDIR_WRITE] &&
379 o->min_bs[DDIR_READ] == o->min_bs[DDIR_TRIM];
383 * Lazy way of fixing up options that depend on each other. We could also
384 * define option callback handlers, but this is easier.
386 static int fixup_options(struct thread_data *td)
388 struct thread_options *o = &td->o;
391 #ifndef FIO_HAVE_PSHARED_MUTEX
392 if (!o->use_thread) {
393 log_info("fio: this platform does not support process shared"
394 " mutexes, forcing use of threads. Use the 'thread'"
395 " option to get rid of this warning.\n");
397 ret = warnings_fatal;
401 if (o->write_iolog_file && o->read_iolog_file) {
402 log_err("fio: read iolog overrides write_iolog\n");
403 free(o->write_iolog_file);
404 o->write_iolog_file = NULL;
405 ret = warnings_fatal;
409 * only really works with 1 file
411 if (o->zone_size && o->open_files > 1)
415 * If zone_range isn't specified, backward compatibility dictates it
416 * should be made equal to zone_size.
418 if (o->zone_size && !o->zone_range)
419 o->zone_range = o->zone_size;
422 * Reads can do overwrites, we always need to pre-create the file
424 if (td_read(td) || td_rw(td))
427 if (!o->min_bs[DDIR_READ])
428 o->min_bs[DDIR_READ] = o->bs[DDIR_READ];
429 if (!o->max_bs[DDIR_READ])
430 o->max_bs[DDIR_READ] = o->bs[DDIR_READ];
431 if (!o->min_bs[DDIR_WRITE])
432 o->min_bs[DDIR_WRITE] = o->bs[DDIR_WRITE];
433 if (!o->max_bs[DDIR_WRITE])
434 o->max_bs[DDIR_WRITE] = o->bs[DDIR_WRITE];
435 if (!o->min_bs[DDIR_TRIM])
436 o->min_bs[DDIR_TRIM] = o->bs[DDIR_TRIM];
437 if (!o->max_bs[DDIR_TRIM])
438 o->max_bs[DDIR_TRIM] = o->bs[DDIR_TRIM];
441 o->rw_min_bs = min(o->min_bs[DDIR_READ], o->min_bs[DDIR_WRITE]);
442 o->rw_min_bs = min(o->min_bs[DDIR_TRIM], o->rw_min_bs);
445 * For random IO, allow blockalign offset other than min_bs.
447 if (!o->ba[DDIR_READ] || !td_random(td))
448 o->ba[DDIR_READ] = o->min_bs[DDIR_READ];
449 if (!o->ba[DDIR_WRITE] || !td_random(td))
450 o->ba[DDIR_WRITE] = o->min_bs[DDIR_WRITE];
451 if (!o->ba[DDIR_TRIM] || !td_random(td))
452 o->ba[DDIR_TRIM] = o->min_bs[DDIR_TRIM];
454 if ((o->ba[DDIR_READ] != o->min_bs[DDIR_READ] ||
455 o->ba[DDIR_WRITE] != o->min_bs[DDIR_WRITE] ||
456 o->ba[DDIR_TRIM] != o->min_bs[DDIR_TRIM]) &&
458 log_err("fio: Any use of blockalign= turns off randommap\n");
460 ret = warnings_fatal;
463 if (!o->file_size_high)
464 o->file_size_high = o->file_size_low;
466 if (o->norandommap && o->verify != VERIFY_NONE
467 && !fixed_block_size(o)) {
468 log_err("fio: norandommap given for variable block sizes, "
469 "verify disabled\n");
470 o->verify = VERIFY_NONE;
471 ret = warnings_fatal;
473 if (o->bs_unaligned && (o->odirect || td->io_ops->flags & FIO_RAWIO))
474 log_err("fio: bs_unaligned may not work with raw io\n");
477 * thinktime_spin must be less than thinktime
479 if (o->thinktime_spin > o->thinktime)
480 o->thinktime_spin = o->thinktime;
483 * The low water mark cannot be bigger than the iodepth
485 if (o->iodepth_low > o->iodepth || !o->iodepth_low)
486 o->iodepth_low = o->iodepth;
489 * If batch number isn't set, default to the same as iodepth
491 if (o->iodepth_batch > o->iodepth || !o->iodepth_batch)
492 o->iodepth_batch = o->iodepth;
494 if (o->nr_files > td->files_index)
495 o->nr_files = td->files_index;
497 if (o->open_files > o->nr_files || !o->open_files)
498 o->open_files = o->nr_files;
500 if (((o->rate[DDIR_READ] + o->rate[DDIR_WRITE] + o->rate[DDIR_TRIM]) &&
501 (o->rate_iops[DDIR_READ] + o->rate_iops[DDIR_WRITE] + o->rate_iops[DDIR_TRIM])) ||
502 ((o->ratemin[DDIR_READ] + o->ratemin[DDIR_WRITE] + o->ratemin[DDIR_TRIM]) &&
503 (o->rate_iops_min[DDIR_READ] + o->rate_iops_min[DDIR_WRITE] + o->rate_iops_min[DDIR_TRIM]))) {
504 log_err("fio: rate and rate_iops are mutually exclusive\n");
507 if ((o->rate[DDIR_READ] < o->ratemin[DDIR_READ]) ||
508 (o->rate[DDIR_WRITE] < o->ratemin[DDIR_WRITE]) ||
509 (o->rate[DDIR_TRIM] < o->ratemin[DDIR_TRIM]) ||
510 (o->rate_iops[DDIR_READ] < o->rate_iops_min[DDIR_READ]) ||
511 (o->rate_iops[DDIR_WRITE] < o->rate_iops_min[DDIR_WRITE]) ||
512 (o->rate_iops[DDIR_TRIM] < o->rate_iops_min[DDIR_TRIM])) {
513 log_err("fio: minimum rate exceeds rate\n");
517 if (!o->timeout && o->time_based) {
518 log_err("fio: time_based requires a runtime/timeout setting\n");
520 ret = warnings_fatal;
523 if (o->fill_device && !o->size)
526 if (o->verify != VERIFY_NONE) {
527 if (td_write(td) && o->do_verify && o->numjobs > 1) {
528 log_info("Multiple writers may overwrite blocks that "
529 "belong to other jobs. This can cause "
530 "verification failures.\n");
531 ret = warnings_fatal;
534 o->refill_buffers = 1;
535 if (o->max_bs[DDIR_WRITE] != o->min_bs[DDIR_WRITE] &&
537 o->verify_interval = o->min_bs[DDIR_WRITE];
541 o->invalidate_cache = 0;
542 if (td->io_ops->flags & FIO_PIPEIO) {
543 log_info("fio: cannot pre-read files with an IO engine"
544 " that isn't seekable. Pre-read disabled.\n");
545 ret = warnings_fatal;
549 #ifndef CONFIG_FDATASYNC
550 if (o->fdatasync_blocks) {
551 log_info("fio: this platform does not support fdatasync()"
552 " falling back to using fsync(). Use the 'fsync'"
553 " option instead of 'fdatasync' to get rid of"
555 o->fsync_blocks = o->fdatasync_blocks;
556 o->fdatasync_blocks = 0;
557 ret = warnings_fatal;
563 * Windows doesn't support O_DIRECT or O_SYNC with the _open interface,
564 * so fail if we're passed those flags
566 if ((td->io_ops->flags & FIO_SYNCIO) && (td->o.odirect || td->o.sync_io)) {
567 log_err("fio: Windows does not support direct or non-buffered io with"
568 " the synchronous ioengines. Use the 'windowsaio' ioengine"
569 " with 'direct=1' and 'iodepth=1' instead.\n");
575 * For fully compressible data, just zero them at init time.
576 * It's faster than repeatedly filling it.
578 if (td->o.compress_percentage == 100) {
579 td->o.zero_buffers = 1;
580 td->o.compress_percentage = 0;
584 * Using a non-uniform random distribution excludes usage of
587 if (td->o.random_distribution != FIO_RAND_DIST_RANDOM)
588 td->o.norandommap = 1;
594 * This function leaks the buffer
596 static char *to_kmg(unsigned int val)
598 char *buf = malloc(32);
599 char post[] = { 0, 'K', 'M', 'G', 'P', 'E', 0 };
610 snprintf(buf, 32, "%u%c", val, *p);
614 /* External engines are specified by "external:name.o") */
615 static const char *get_engine_name(const char *str)
617 char *p = strstr(str, ":");
623 strip_blank_front(&p);
628 static int exists_and_not_file(const char *filename)
632 if (lstat(filename, &sb) == -1)
635 /* \\.\ is the device namespace in Windows, where every file
636 * is a device node */
637 if (S_ISREG(sb.st_mode) && strncmp(filename, "\\\\.\\", 4) != 0)
643 static void td_fill_rand_seeds_os(struct thread_data *td)
645 os_random_seed(td->rand_seeds[FIO_RAND_BS_OFF], &td->bsrange_state);
646 os_random_seed(td->rand_seeds[FIO_RAND_VER_OFF], &td->verify_state);
647 os_random_seed(td->rand_seeds[FIO_RAND_MIX_OFF], &td->rwmix_state);
649 if (td->o.file_service_type == FIO_FSERVICE_RANDOM)
650 os_random_seed(td->rand_seeds[FIO_RAND_FILE_OFF], &td->next_file_state);
652 os_random_seed(td->rand_seeds[FIO_RAND_FILE_SIZE_OFF], &td->file_size_state);
653 os_random_seed(td->rand_seeds[FIO_RAND_TRIM_OFF], &td->trim_state);
658 if (td->o.rand_repeatable)
659 td->rand_seeds[FIO_RAND_BLOCK_OFF] = FIO_RANDSEED * td->thread_number;
661 os_random_seed(td->rand_seeds[FIO_RAND_BLOCK_OFF], &td->random_state);
664 static void td_fill_rand_seeds_internal(struct thread_data *td)
666 init_rand_seed(&td->__bsrange_state, td->rand_seeds[FIO_RAND_BS_OFF]);
667 init_rand_seed(&td->__verify_state, td->rand_seeds[FIO_RAND_VER_OFF]);
668 init_rand_seed(&td->__rwmix_state, td->rand_seeds[FIO_RAND_MIX_OFF]);
670 if (td->o.file_service_type == FIO_FSERVICE_RANDOM)
671 init_rand_seed(&td->__next_file_state, td->rand_seeds[FIO_RAND_FILE_OFF]);
673 init_rand_seed(&td->__file_size_state, td->rand_seeds[FIO_RAND_FILE_SIZE_OFF]);
674 init_rand_seed(&td->__trim_state, td->rand_seeds[FIO_RAND_TRIM_OFF]);
679 if (td->o.rand_repeatable)
680 td->rand_seeds[FIO_RAND_BLOCK_OFF] = FIO_RANDSEED * td->thread_number;
682 init_rand_seed(&td->__random_state, td->rand_seeds[FIO_RAND_BLOCK_OFF]);
685 void td_fill_rand_seeds(struct thread_data *td)
687 if (td->o.use_os_rand)
688 td_fill_rand_seeds_os(td);
690 td_fill_rand_seeds_internal(td);
692 init_rand_seed(&td->buf_state, td->rand_seeds[FIO_RAND_BUF_OFF]);
696 * Initializes the ioengine configured for a job, if it has not been done so
699 int ioengine_load(struct thread_data *td)
704 * Engine has already been loaded.
709 engine = get_engine_name(td->o.ioengine);
710 td->io_ops = load_ioengine(td, engine);
712 log_err("fio: failed to load engine %s\n", engine);
716 if (td->io_ops->option_struct_size && td->io_ops->options) {
718 * In cases where td->eo is set, clone it for a child thread.
719 * This requires that the parent thread has the same ioengine,
720 * but that requirement must be enforced by the code which
723 void *origeo = td->eo;
725 * Otherwise use the default thread options.
727 if (!origeo && td != &def_thread && def_thread.eo &&
728 def_thread.io_ops->options == td->io_ops->options)
729 origeo = def_thread.eo;
731 options_init(td->io_ops->options);
732 td->eo = malloc(td->io_ops->option_struct_size);
734 * Use the default thread as an option template if this uses the
735 * same options structure and there are non-default options
739 memcpy(td->eo, origeo, td->io_ops->option_struct_size);
740 options_mem_dupe(td->eo, td->io_ops->options);
742 memset(td->eo, 0, td->io_ops->option_struct_size);
743 fill_default_options(td->eo, td->io_ops->options);
745 *(struct thread_data **)td->eo = td;
751 static void init_flags(struct thread_data *td)
753 struct thread_options *o = &td->o;
755 if (o->verify_backlog)
756 td->flags |= TD_F_VER_BACKLOG;
758 td->flags |= TD_F_TRIM_BACKLOG;
759 if (o->read_iolog_file)
760 td->flags |= TD_F_READ_IOLOG;
761 if (o->refill_buffers)
762 td->flags |= TD_F_REFILL_BUFFERS;
763 if (o->scramble_buffers)
764 td->flags |= TD_F_SCRAMBLE_BUFFERS;
765 if (o->verify != VERIFY_NONE)
766 td->flags |= TD_F_VER_NONE;
769 static int setup_random_seeds(struct thread_data *td)
774 if (!td->o.rand_repeatable)
775 return init_random_state(td, td->rand_seeds, sizeof(td->rand_seeds));
777 for (seed = 0x89, i = 0; i < 4; i++)
778 seed *= 0x9e370001UL;
780 for (i = 0; i < FIO_RAND_NR_OFFS; i++) {
781 td->rand_seeds[i] = seed;
782 seed *= 0x9e370001UL;
785 td_fill_rand_seeds(td);
790 * Adds a job to the list of things todo. Sanitizes the various options
791 * to make sure we don't have conflicts, and initializes various
794 static int add_job(struct thread_data *td, const char *jobname, int job_add_num)
796 const char *ddir_str[] = { NULL, "read", "write", "rw", NULL,
797 "randread", "randwrite", "randrw",
798 "trim", NULL, NULL, NULL, "randtrim" };
800 char fname[PATH_MAX];
801 int numjobs, file_alloced;
804 * the def_thread is just for options, it's not a real job
806 if (td == &def_thread)
812 * if we are just dumping the output command line, don't add the job
819 if (profile_td_init(td))
822 if (ioengine_load(td))
825 if (td->o.use_thread)
831 td->io_ops->flags |= FIO_RAWIO;
834 if (!td->o.filename && !td->files_index && !td->o.read_iolog_file) {
837 if (td->o.nr_files == 1 && exists_and_not_file(jobname))
838 add_file(td, jobname);
840 for (i = 0; i < td->o.nr_files; i++) {
841 sprintf(fname, "%s.%d.%d", jobname,
842 td->thread_number, i);
848 if (fixup_options(td))
854 * IO engines only need this for option callbacks, and the address may
855 * change in subprocesses.
858 *(struct thread_data **)td->eo = NULL;
860 if (td->io_ops->flags & FIO_DISKLESSIO) {
863 for_each_file(td, f, i)
864 f->real_file_size = -1ULL;
867 td->mutex = fio_mutex_init(FIO_MUTEX_LOCKED);
869 td->ts.clat_percentiles = td->o.clat_percentiles;
870 td->ts.percentile_precision = td->o.percentile_precision;
871 memcpy(td->ts.percentile_list, td->o.percentile_list, sizeof(td->o.percentile_list));
873 for (i = 0; i < DDIR_RWDIR_CNT; i++) {
874 td->ts.clat_stat[i].min_val = ULONG_MAX;
875 td->ts.slat_stat[i].min_val = ULONG_MAX;
876 td->ts.lat_stat[i].min_val = ULONG_MAX;
877 td->ts.bw_stat[i].min_val = ULONG_MAX;
879 td->ddir_seq_nr = td->o.ddir_seq_nr;
881 if ((td->o.stonewall || td->o.new_group) && prev_group_jobs) {
886 td->groupid = groupid;
889 if (setup_random_seeds(td)) {
890 td_verror(td, errno, "init_random_state");
897 if (td->o.write_lat_log) {
898 setup_log(&td->lat_log, td->o.log_avg_msec);
899 setup_log(&td->slat_log, td->o.log_avg_msec);
900 setup_log(&td->clat_log, td->o.log_avg_msec);
902 if (td->o.write_bw_log)
903 setup_log(&td->bw_log, td->o.log_avg_msec);
904 if (td->o.write_iops_log)
905 setup_log(&td->iops_log, td->o.log_avg_msec);
908 td->o.name = strdup(jobname);
910 if (output_format == FIO_OUTPUT_NORMAL) {
912 if (!strcmp(td->io_ops->name, "cpuio")) {
913 log_info("%s: ioengine=cpu, cpuload=%u,"
914 " cpucycle=%u\n", td->o.name,
918 char *c1, *c2, *c3, *c4, *c5, *c6;
920 c1 = to_kmg(td->o.min_bs[DDIR_READ]);
921 c2 = to_kmg(td->o.max_bs[DDIR_READ]);
922 c3 = to_kmg(td->o.min_bs[DDIR_WRITE]);
923 c4 = to_kmg(td->o.max_bs[DDIR_WRITE]);
924 c5 = to_kmg(td->o.min_bs[DDIR_TRIM]);
925 c6 = to_kmg(td->o.max_bs[DDIR_TRIM]);
927 log_info("%s: (g=%d): rw=%s, bs=%s-%s/%s-%s/%s-%s,"
928 " ioengine=%s, iodepth=%u\n",
929 td->o.name, td->groupid,
930 ddir_str[td->o.td_ddir],
931 c1, c2, c3, c4, c5, c6,
942 } else if (job_add_num == 1)
947 * recurse add identical jobs, clear numjobs and stonewall options
948 * as they don't apply to sub-jobs
950 numjobs = td->o.numjobs;
952 struct thread_data *td_new = get_new_job(0, td, 1);
957 td_new->o.numjobs = 1;
958 td_new->o.stonewall = 0;
959 td_new->o.new_group = 0;
962 td_new->o.filename = NULL;
963 td_new->files_index = 0;
964 td_new->files_size = 0;
965 td_new->files = NULL;
968 job_add_num = numjobs - 1;
970 if (add_job(td_new, jobname, job_add_num))
981 * Parse as if 'o' was a command line
983 void add_job_opts(const char **o)
985 struct thread_data *td, *td_parent;
986 int i, in_global = 1;
990 td_parent = td = NULL;
992 if (!strncmp(o[i], "name", 4)) {
995 add_job(td, jobname, 0);
997 sprintf(jobname, "%s", o[i] + 5);
999 if (in_global && !td_parent)
1000 td_parent = get_new_job(1, &def_thread, 0);
1001 else if (!in_global && !td) {
1003 td_parent = &def_thread;
1004 td = get_new_job(0, td_parent, 0);
1007 fio_options_parse(td_parent, (char **) &o[i], 1);
1009 fio_options_parse(td, (char **) &o[i], 1);
1014 add_job(td, jobname, 0);
1017 static int skip_this_section(const char *name)
1021 if (!nr_job_sections)
1023 if (!strncmp(name, "global", 6))
1026 for (i = 0; i < nr_job_sections; i++)
1027 if (!strcmp(job_sections[i], name))
1033 static int is_empty_or_comment(char *line)
1037 for (i = 0; i < strlen(line); i++) {
1042 if (!isspace((int) line[i]) && !iscntrl((int) line[i]))
1050 * This is our [ini] type file parser.
1052 int parse_jobs_ini(char *file, int is_buf, int stonewall_flag)
1054 unsigned int global;
1055 struct thread_data *td;
1056 char *string, *name;
1059 int ret = 0, stonewall;
1062 int inside_skip = 0;
1064 int i, alloc_opts, num_opts;
1069 if (!strcmp(file, "-"))
1072 f = fopen(file, "r");
1075 perror("fopen job file");
1080 string = malloc(4096);
1083 * it's really 256 + small bit, 280 should suffice
1086 memset(name, 0, 280);
1089 opts = malloc(sizeof(char *) * alloc_opts);
1092 stonewall = stonewall_flag;
1095 * if skip_fgets is set, we already have loaded a line we
1100 p = strsep(&file, "\n");
1102 p = fgets(string, 4096, f);
1108 strip_blank_front(&p);
1111 if (is_empty_or_comment(p))
1113 if (sscanf(p, "[%255[^\n]]", name) != 1) {
1116 log_err("fio: option <%s> outside of [] job section\n",
1121 name[strlen(name) - 1] = '\0';
1123 if (skip_this_section(name)) {
1129 global = !strncmp(name, "global", 6);
1135 log_info("--name=%s ", name);
1139 td = get_new_job(global, &def_thread, 0);
1146 * Seperate multiple job files by a stonewall
1148 if (!global && stonewall) {
1149 td->o.stonewall = stonewall;
1154 memset(opts, 0, alloc_opts * sizeof(char *));
1158 p = strsep(&file, "\n");
1160 p = fgets(string, 4096, f);
1164 if (is_empty_or_comment(p))
1167 strip_blank_front(&p);
1170 * new section, break out and make sure we don't
1171 * fgets() a new line at the top.
1180 if (num_opts == alloc_opts) {
1182 opts = realloc(opts,
1183 alloc_opts * sizeof(char *));
1186 opts[num_opts] = strdup(p);
1190 ret = fio_options_parse(td, opts, num_opts);
1193 for (i = 0; i < num_opts; i++)
1194 log_info("--%s ", opts[i]);
1196 ret = add_job(td, name, 0);
1198 log_err("fio: job %s dropped\n", name);
1202 for (i = 0; i < num_opts; i++)
1211 while (i < nr_job_sections) {
1212 free(job_sections[i]);
1216 for (i = 0; i < num_opts; i++)
1222 if (!is_buf && f != stdin)
1227 static int fill_def_thread(void)
1229 memset(&def_thread, 0, sizeof(def_thread));
1231 fio_getaffinity(getpid(), &def_thread.o.cpumask);
1232 def_thread.o.timeout = def_timeout;
1233 def_thread.o.error_dump = 1;
1235 * fill default options
1237 fio_fill_default_options(&def_thread);
1241 static void usage(const char *name)
1243 printf("%s\n", fio_version_string);
1244 printf("%s [options] [job options] <job file(s)>\n", name);
1245 printf(" --debug=options\tEnable debug logging. May be one/more of:\n"
1246 "\t\t\tprocess,file,io,mem,blktrace,verify,random,parse,\n"
1247 "\t\t\tdiskutil,job,mutex,profile,time,net\n");
1248 printf(" --output\t\tWrite output to file\n");
1249 printf(" --runtime\t\tRuntime in seconds\n");
1250 printf(" --latency-log\t\tGenerate per-job latency logs\n");
1251 printf(" --bandwidth-log\tGenerate per-job bandwidth logs\n");
1252 printf(" --minimal\t\tMinimal (terse) output\n");
1253 printf(" --output-format=x\tOutput format (terse,json,normal)\n");
1254 printf(" --terse-version=x\tSet terse version output format to 'x'\n");
1255 printf(" --version\t\tPrint version info and exit\n");
1256 printf(" --help\t\tPrint this page\n");
1257 printf(" --cpuclock-test\tPerform test/validation of CPU clock\n");
1258 printf(" --cmdhelp=cmd\t\tPrint command help, \"all\" for all of"
1260 printf(" --enghelp=engine\tPrint ioengine help, or list"
1261 " available ioengines\n");
1262 printf(" --enghelp=engine,cmd\tPrint help for an ioengine"
1264 printf(" --showcmd\t\tTurn a job file into command line options\n");
1265 printf(" --eta=when\t\tWhen ETA estimate should be printed\n");
1266 printf(" \t\tMay be \"always\", \"never\" or \"auto\"\n");
1267 printf(" --readonly\t\tTurn on safety read-only checks, preventing"
1269 printf(" --section=name\tOnly run specified section in job file\n");
1270 printf(" --alloc-size=kb\tSet smalloc pool to this size in kb"
1272 printf(" --warnings-fatal\tFio parser warnings are fatal\n");
1273 printf(" --max-jobs=nr\t\tMaximum number of threads/processes to support\n");
1274 printf(" --server=args\t\tStart a backend fio server\n");
1275 printf(" --daemonize=pidfile\tBackground fio server, write pid to file\n");
1276 printf(" --client=hostname\tTalk to remote backend fio server at hostname\n");
1277 printf(" --idle-prof=option\tReport cpu idleness on a system or percpu basis\n"
1278 "\t\t\t(option=system,percpu) or run unit work\n"
1279 "\t\t\tcalibration only (option=calibrate)\n");
1280 printf("\nFio was written by Jens Axboe <jens.axboe@oracle.com>");
1281 printf("\n Jens Axboe <jaxboe@fusionio.com>\n");
1284 #ifdef FIO_INC_DEBUG
1285 struct debug_level debug_levels[] = {
1286 { .name = "process", .shift = FD_PROCESS, },
1287 { .name = "file", .shift = FD_FILE, },
1288 { .name = "io", .shift = FD_IO, },
1289 { .name = "mem", .shift = FD_MEM, },
1290 { .name = "blktrace", .shift = FD_BLKTRACE },
1291 { .name = "verify", .shift = FD_VERIFY },
1292 { .name = "random", .shift = FD_RANDOM },
1293 { .name = "parse", .shift = FD_PARSE },
1294 { .name = "diskutil", .shift = FD_DISKUTIL },
1295 { .name = "job", .shift = FD_JOB },
1296 { .name = "mutex", .shift = FD_MUTEX },
1297 { .name = "profile", .shift = FD_PROFILE },
1298 { .name = "time", .shift = FD_TIME },
1299 { .name = "net", .shift = FD_NET },
1303 static int set_debug(const char *string)
1305 struct debug_level *dl;
1306 char *p = (char *) string;
1310 if (!strcmp(string, "?") || !strcmp(string, "help")) {
1311 log_info("fio: dumping debug options:");
1312 for (i = 0; debug_levels[i].name; i++) {
1313 dl = &debug_levels[i];
1314 log_info("%s,", dl->name);
1320 while ((opt = strsep(&p, ",")) != NULL) {
1323 if (!strncmp(opt, "all", 3)) {
1324 log_info("fio: set all debug options\n");
1329 for (i = 0; debug_levels[i].name; i++) {
1330 dl = &debug_levels[i];
1331 found = !strncmp(opt, dl->name, strlen(dl->name));
1335 if (dl->shift == FD_JOB) {
1336 opt = strchr(opt, ':');
1338 log_err("fio: missing job number\n");
1342 fio_debug_jobno = atoi(opt);
1343 log_info("fio: set debug jobno %d\n",
1346 log_info("fio: set debug option %s\n", opt);
1347 fio_debug |= (1UL << dl->shift);
1353 log_err("fio: debug mask %s not found\n", opt);
1358 static int set_debug(const char *string)
1360 log_err("fio: debug tracing not included in build\n");
1365 static void fio_options_fill_optstring(void)
1367 char *ostr = cmd_optstr;
1371 while (l_opts[i].name) {
1372 ostr[c++] = l_opts[i].val;
1373 if (l_opts[i].has_arg == required_argument)
1375 else if (l_opts[i].has_arg == optional_argument) {
1384 static int client_flag_set(char c)
1389 while (l_opts[i].name) {
1390 int val = l_opts[i].val;
1392 if (c == (val & 0xff))
1393 return (val & FIO_CLIENT_FLAG);
1401 void parse_cmd_client(void *client, char *opt)
1403 fio_client_add_cmd_option(client, opt);
1406 int parse_cmd_line(int argc, char *argv[])
1408 struct thread_data *td = NULL;
1409 int c, ini_idx = 0, lidx, ret = 0, do_exit = 0, exit_val = 0;
1410 char *ostr = cmd_optstr;
1411 void *pid_file = NULL;
1412 void *cur_client = NULL;
1416 * Reset optind handling, since we may call this multiple times
1421 while ((c = getopt_long_only(argc, argv, ostr, l_opts, &lidx)) != -1) {
1424 if ((c & FIO_CLIENT_FLAG) || client_flag_set(c)) {
1425 parse_cmd_client(cur_client, argv[optind - 1]);
1426 c &= ~FIO_CLIENT_FLAG;
1431 smalloc_pool_size = atoi(optarg);
1434 def_timeout = atoi(optarg);
1443 f_out = fopen(optarg, "w+");
1445 perror("fopen output");
1451 output_format = FIO_OUTPUT_TERSE;
1454 if (!strcmp(optarg, "minimal") ||
1455 !strcmp(optarg, "terse") ||
1456 !strcmp(optarg, "csv"))
1457 output_format = FIO_OUTPUT_TERSE;
1458 else if (!strcmp(optarg, "json"))
1459 output_format = FIO_OUTPUT_JSON;
1461 output_format = FIO_OUTPUT_NORMAL;
1471 fio_show_option_help(optarg);
1477 fio_show_ioengine_help(optarg);
1489 log_info("%s\n", fio_version_string);
1494 terse_version = atoi(optarg);
1495 if (!(terse_version == 2 || terse_version == 3 ||
1496 terse_version == 4)) {
1497 log_err("fio: bad terse version format\n");
1503 if (!strcmp("always", optarg))
1504 eta_print = FIO_ETA_ALWAYS;
1505 else if (!strcmp("never", optarg))
1506 eta_print = FIO_ETA_NEVER;
1509 if (set_debug(optarg))
1515 if (!strcmp(optarg, "global")) {
1516 log_err("fio: can't use global as only "
1522 new_size = (nr_job_sections + 1) * sizeof(char *);
1523 job_sections = realloc(job_sections, new_size);
1524 job_sections[nr_job_sections] = strdup(optarg);
1529 exec_profile = strdup(optarg);
1531 case FIO_GETOPT_JOB: {
1532 const char *opt = l_opts[lidx].name;
1535 if (!strncmp(opt, "name", 4) && td) {
1536 ret = add_job(td, td->o.name ?: "fio", 0);
1542 int is_section = !strncmp(opt, "name", 4);
1545 if (!is_section || !strncmp(val, "global", 6))
1548 if (is_section && skip_this_section(val))
1551 td = get_new_job(global, &def_thread, 1);
1552 if (!td || ioengine_load(td))
1554 fio_options_set_ioengine_opts(l_opts, td);
1557 ret = fio_cmd_option_parse(td, opt, val);
1559 if (!ret && !strcmp(opt, "ioengine")) {
1561 if (ioengine_load(td))
1563 fio_options_set_ioengine_opts(l_opts, td);
1567 case FIO_GETOPT_IOENGINE: {
1568 const char *opt = l_opts[lidx].name;
1570 opt = l_opts[lidx].name;
1572 ret = fio_cmd_ioengine_option_parse(td, opt, val);
1579 max_jobs = atoi(optarg);
1580 if (!max_jobs || max_jobs > REAL_MAX_JOBS) {
1581 log_err("fio: invalid max jobs: %d\n", max_jobs);
1588 log_err("fio: can't be both client and server\n");
1594 fio_server_set_arg(optarg);
1599 pid_file = strdup(optarg);
1602 if ((ret = fio_idle_prof_parse_opt(optarg))) {
1603 /* exit on error and calibration only */
1611 log_err("fio: can't be both client and server\n");
1616 if (fio_client_add(optarg, &cur_client)) {
1617 log_err("fio: failed adding client %s\n", optarg);
1623 * If the next argument exists and isn't an option,
1624 * assume it's a job file for this client only.
1626 while (optind < argc) {
1627 if (!strncmp(argv[optind], "--", 2) ||
1628 !strncmp(argv[optind], "-", 1))
1631 fio_client_add_ini_file(cur_client, argv[optind]);
1637 exit_val = fio_monotonic_clocktest();
1640 log_err("%s: unrecognized option '%s'\n", argv[0],
1652 if (exit_val && !(is_backend || nr_clients))
1656 if (nr_clients && fio_clients_connect()) {
1662 if (is_backend && backend)
1663 return fio_start_server(pid_file);
1667 ret = add_job(td, td->o.name ?: "fio", 0);
1670 while (!ret && optind < argc) {
1672 ini_file = realloc(ini_file, ini_idx * sizeof(char *));
1673 ini_file[ini_idx - 1] = strdup(argv[optind]);
1680 int parse_options(int argc, char *argv[])
1687 fio_options_fill_optstring();
1688 fio_options_dup_and_init(l_opts);
1692 if (fill_def_thread())
1695 job_files = parse_cmd_line(argc, argv);
1697 if (job_files > 0) {
1698 for (i = 0; i < job_files; i++) {
1699 if (fill_def_thread())
1702 if (fio_clients_send_ini(ini_file[i]))
1705 } else if (!is_backend) {
1706 if (parse_jobs_ini(ini_file[i], 0, i))
1711 } else if (nr_clients) {
1712 if (fill_def_thread())
1714 if (fio_clients_send_ini(NULL))
1719 fio_options_free(&def_thread);
1721 if (!thread_number) {
1726 if (is_backend || nr_clients)
1731 log_err("No jobs(s) defined\n\n");
1741 if (def_thread.o.gtod_offload) {
1743 fio_gtod_offload = 1;
1744 fio_gtod_cpu = def_thread.o.gtod_cpu;
1747 if (output_format == FIO_OUTPUT_NORMAL)
1748 log_info("%s\n", fio_version_string);