2 * This file contains job initialization and setup functions.
12 #ifndef FIO_NO_HAVE_SHM_H
15 #include <sys/types.h>
26 #include "lib/getopt.h"
28 const char fio_version_string[] = FIO_VERSION;
30 #define FIO_RANDSEED (0xb1899bedUL)
32 static char **ini_file;
33 static int max_jobs = FIO_MAX_JOBS;
34 static int dump_cmdline;
35 static int def_timeout;
37 static struct thread_data def_thread;
38 struct thread_data *threads = NULL;
40 int exitall_on_terminate = 0;
41 int output_format = FIO_OUTPUT_NORMAL;
43 unsigned long long mlock_size = 0;
46 char **job_sections = NULL;
47 int nr_job_sections = 0;
48 char *exec_profile = NULL;
49 int warnings_fatal = 0;
50 int terse_version = 3;
58 static int write_lat_log;
60 static int prev_group_jobs;
62 unsigned long fio_debug = 0;
63 unsigned int fio_debug_jobno = -1;
64 unsigned int *fio_debug_jobp = NULL;
66 static char cmd_optstr[256];
69 const fio_fp64_t def_percentile_list[FIO_IO_U_LIST_MAX_LEN] = {
89 #define FIO_CLIENT_FLAG (1 << 16)
92 * Command line options. These will contain the above, plus a few
93 * extra that only pertain to fio itself and not jobs.
95 static struct option l_opts[FIO_NR_OPTIONS] = {
97 .name = (char *) "output",
98 .has_arg = required_argument,
99 .val = 'o' | FIO_CLIENT_FLAG,
102 .name = (char *) "timeout",
103 .has_arg = required_argument,
104 .val = 't' | FIO_CLIENT_FLAG,
107 .name = (char *) "latency-log",
108 .has_arg = required_argument,
109 .val = 'l' | FIO_CLIENT_FLAG,
112 .name = (char *) "bandwidth-log",
113 .has_arg = required_argument,
114 .val = 'b' | FIO_CLIENT_FLAG,
117 .name = (char *) "minimal",
118 .has_arg = optional_argument,
119 .val = 'm' | FIO_CLIENT_FLAG,
122 .name = (char *) "output-format",
123 .has_arg = optional_argument,
124 .val = 'F' | FIO_CLIENT_FLAG,
127 .name = (char *) "version",
128 .has_arg = no_argument,
129 .val = 'v' | FIO_CLIENT_FLAG,
132 .name = (char *) "help",
133 .has_arg = no_argument,
134 .val = 'h' | FIO_CLIENT_FLAG,
137 .name = (char *) "cmdhelp",
138 .has_arg = optional_argument,
139 .val = 'c' | FIO_CLIENT_FLAG,
142 .name = (char *) "enghelp",
143 .has_arg = optional_argument,
144 .val = 'i' | FIO_CLIENT_FLAG,
147 .name = (char *) "showcmd",
148 .has_arg = no_argument,
149 .val = 's' | FIO_CLIENT_FLAG,
152 .name = (char *) "readonly",
153 .has_arg = no_argument,
154 .val = 'r' | FIO_CLIENT_FLAG,
157 .name = (char *) "eta",
158 .has_arg = required_argument,
159 .val = 'e' | FIO_CLIENT_FLAG,
162 .name = (char *) "debug",
163 .has_arg = required_argument,
164 .val = 'd' | FIO_CLIENT_FLAG,
167 .name = (char *) "section",
168 .has_arg = required_argument,
169 .val = 'x' | FIO_CLIENT_FLAG,
172 .name = (char *) "alloc-size",
173 .has_arg = required_argument,
174 .val = 'a' | FIO_CLIENT_FLAG,
177 .name = (char *) "profile",
178 .has_arg = required_argument,
179 .val = 'p' | FIO_CLIENT_FLAG,
182 .name = (char *) "warnings-fatal",
183 .has_arg = no_argument,
184 .val = 'w' | FIO_CLIENT_FLAG,
187 .name = (char *) "max-jobs",
188 .has_arg = required_argument,
189 .val = 'j' | FIO_CLIENT_FLAG,
192 .name = (char *) "terse-version",
193 .has_arg = required_argument,
194 .val = 'V' | FIO_CLIENT_FLAG,
197 .name = (char *) "server",
198 .has_arg = optional_argument,
201 { .name = (char *) "daemonize",
202 .has_arg = required_argument,
206 .name = (char *) "client",
207 .has_arg = required_argument,
211 .name = (char *) "cpuclock-test",
212 .has_arg = no_argument,
220 static void free_shm(void)
222 struct shmid_ds sbuf;
230 fio_debug_jobp = NULL;
232 shmctl(shm_id, IPC_RMID, &sbuf);
239 * The thread area is shared between the main process and the job
240 * threads/processes. So setup a shared memory segment that will hold
241 * all the job info. We use the end of the region for keeping track of
242 * open files across jobs, for file sharing.
244 static int setup_thread_area(void)
252 * 1024 is too much on some machines, scale max_jobs if
253 * we get a failure that looks like too large a shm segment
256 size_t size = max_jobs * sizeof(struct thread_data);
258 size += file_hash_size;
259 size += sizeof(unsigned int);
261 shm_id = shmget(0, size, IPC_CREAT | 0600);
264 if (errno != EINVAL && errno != ENOMEM && errno != ENOSPC) {
275 threads = shmat(shm_id, NULL, 0);
276 if (threads == (void *) -1) {
281 memset(threads, 0, max_jobs * sizeof(struct thread_data));
282 hash = (void *) threads + max_jobs * sizeof(struct thread_data);
283 fio_debug_jobp = (void *) hash + file_hash_size;
284 *fio_debug_jobp = -1;
285 file_hash_init(hash);
293 * Return a free job structure.
295 static struct thread_data *get_new_job(int global, struct thread_data *parent,
298 struct thread_data *td;
302 if (setup_thread_area()) {
303 log_err("error: failed to setup shm segment\n");
306 if (thread_number >= max_jobs) {
307 log_err("error: maximum number of jobs (%d) reached.\n",
312 td = &threads[thread_number++];
319 td->o.uid = td->o.gid = -1U;
321 dup_files(td, parent);
322 fio_options_mem_dupe(td);
324 profile_add_hooks(td);
326 td->thread_number = thread_number;
328 if (!parent || !parent->o.group_reporting)
334 static void put_job(struct thread_data *td)
336 if (td == &def_thread)
343 log_info("fio: %s\n", td->verror);
345 fio_options_free(td);
349 memset(&threads[td->thread_number - 1], 0, sizeof(*td));
353 static int __setup_rate(struct thread_data *td, enum fio_ddir ddir)
355 unsigned int bs = td->o.min_bs[ddir];
357 assert(ddir_rw(ddir));
359 if (td->o.rate[ddir])
360 td->rate_bps[ddir] = td->o.rate[ddir];
362 td->rate_bps[ddir] = td->o.rate_iops[ddir] * bs;
364 if (!td->rate_bps[ddir]) {
365 log_err("rate lower than supported\n");
369 td->rate_pending_usleep[ddir] = 0;
373 static int setup_rate(struct thread_data *td)
377 if (td->o.rate[DDIR_READ] || td->o.rate_iops[DDIR_READ])
378 ret = __setup_rate(td, DDIR_READ);
379 if (td->o.rate[DDIR_WRITE] || td->o.rate_iops[DDIR_WRITE])
380 ret |= __setup_rate(td, DDIR_WRITE);
381 if (td->o.rate[DDIR_TRIM] || td->o.rate_iops[DDIR_TRIM])
382 ret |= __setup_rate(td, DDIR_TRIM);
387 static int fixed_block_size(struct thread_options *o)
389 return o->min_bs[DDIR_READ] == o->max_bs[DDIR_READ] &&
390 o->min_bs[DDIR_WRITE] == o->max_bs[DDIR_WRITE] &&
391 o->min_bs[DDIR_TRIM] == o->max_bs[DDIR_TRIM] &&
392 o->min_bs[DDIR_READ] == o->min_bs[DDIR_WRITE] &&
393 o->min_bs[DDIR_READ] == o->min_bs[DDIR_TRIM];
397 * Lazy way of fixing up options that depend on each other. We could also
398 * define option callback handlers, but this is easier.
400 static int fixup_options(struct thread_data *td)
402 struct thread_options *o = &td->o;
405 #ifndef FIO_HAVE_PSHARED_MUTEX
406 if (!o->use_thread) {
407 log_info("fio: this platform does not support process shared"
408 " mutexes, forcing use of threads. Use the 'thread'"
409 " option to get rid of this warning.\n");
411 ret = warnings_fatal;
415 if (o->write_iolog_file && o->read_iolog_file) {
416 log_err("fio: read iolog overrides write_iolog\n");
417 free(o->write_iolog_file);
418 o->write_iolog_file = NULL;
419 ret = warnings_fatal;
423 * only really works with 1 file
425 if (o->zone_size && o->open_files == 1)
429 * If zone_range isn't specified, backward compatibility dictates it
430 * should be made equal to zone_size.
432 if (o->zone_size && !o->zone_range)
433 o->zone_range = o->zone_size;
436 * Reads can do overwrites, we always need to pre-create the file
438 if (td_read(td) || td_rw(td))
441 if (!o->min_bs[DDIR_READ])
442 o->min_bs[DDIR_READ] = o->bs[DDIR_READ];
443 if (!o->max_bs[DDIR_READ])
444 o->max_bs[DDIR_READ] = o->bs[DDIR_READ];
445 if (!o->min_bs[DDIR_WRITE])
446 o->min_bs[DDIR_WRITE] = o->bs[DDIR_WRITE];
447 if (!o->max_bs[DDIR_WRITE])
448 o->max_bs[DDIR_WRITE] = o->bs[DDIR_WRITE];
449 if (!o->min_bs[DDIR_TRIM])
450 o->min_bs[DDIR_TRIM] = o->bs[DDIR_TRIM];
451 if (!o->max_bs[DDIR_TRIM])
452 o->max_bs[DDIR_TRIM] = o->bs[DDIR_TRIM];
455 o->rw_min_bs = min(o->min_bs[DDIR_READ], o->min_bs[DDIR_WRITE]);
456 o->rw_min_bs = min(o->min_bs[DDIR_TRIM], o->rw_min_bs);
459 * For random IO, allow blockalign offset other than min_bs.
461 if (!o->ba[DDIR_READ] || !td_random(td))
462 o->ba[DDIR_READ] = o->min_bs[DDIR_READ];
463 if (!o->ba[DDIR_WRITE] || !td_random(td))
464 o->ba[DDIR_WRITE] = o->min_bs[DDIR_WRITE];
465 if (!o->ba[DDIR_TRIM] || !td_random(td))
466 o->ba[DDIR_TRIM] = o->min_bs[DDIR_TRIM];
468 if ((o->ba[DDIR_READ] != o->min_bs[DDIR_READ] ||
469 o->ba[DDIR_WRITE] != o->min_bs[DDIR_WRITE] ||
470 o->ba[DDIR_TRIM] != o->min_bs[DDIR_TRIM]) &&
472 log_err("fio: Any use of blockalign= turns off randommap\n");
474 ret = warnings_fatal;
477 if (!o->file_size_high)
478 o->file_size_high = o->file_size_low;
480 if (o->norandommap && o->verify != VERIFY_NONE
481 && !fixed_block_size(o)) {
482 log_err("fio: norandommap given for variable block sizes, "
483 "verify disabled\n");
484 o->verify = VERIFY_NONE;
485 ret = warnings_fatal;
487 if (o->bs_unaligned && (o->odirect || td->io_ops->flags & FIO_RAWIO))
488 log_err("fio: bs_unaligned may not work with raw io\n");
491 * thinktime_spin must be less than thinktime
493 if (o->thinktime_spin > o->thinktime)
494 o->thinktime_spin = o->thinktime;
497 * The low water mark cannot be bigger than the iodepth
499 if (o->iodepth_low > o->iodepth || !o->iodepth_low) {
501 * syslet work around - if the workload is sequential,
502 * we want to let the queue drain all the way down to
503 * avoid seeking between async threads
505 if (!strcmp(td->io_ops->name, "syslet-rw") && !td_random(td))
508 o->iodepth_low = o->iodepth;
512 * If batch number isn't set, default to the same as iodepth
514 if (o->iodepth_batch > o->iodepth || !o->iodepth_batch)
515 o->iodepth_batch = o->iodepth;
517 if (o->nr_files > td->files_index)
518 o->nr_files = td->files_index;
520 if (o->open_files > o->nr_files || !o->open_files)
521 o->open_files = o->nr_files;
523 if (((o->rate[DDIR_READ] + o->rate[DDIR_WRITE] + o->rate[DDIR_TRIM]) &&
524 (o->rate_iops[DDIR_READ] + o->rate_iops[DDIR_WRITE] + o->rate_iops[DDIR_TRIM])) ||
525 ((o->ratemin[DDIR_READ] + o->ratemin[DDIR_WRITE] + o->ratemin[DDIR_TRIM]) &&
526 (o->rate_iops_min[DDIR_READ] + o->rate_iops_min[DDIR_WRITE] + o->rate_iops_min[DDIR_TRIM]))) {
527 log_err("fio: rate and rate_iops are mutually exclusive\n");
530 if ((o->rate[DDIR_READ] < o->ratemin[DDIR_READ]) ||
531 (o->rate[DDIR_WRITE] < o->ratemin[DDIR_WRITE]) ||
532 (o->rate[DDIR_TRIM] < o->ratemin[DDIR_TRIM]) ||
533 (o->rate_iops[DDIR_READ] < o->rate_iops_min[DDIR_READ]) ||
534 (o->rate_iops[DDIR_WRITE] < o->rate_iops_min[DDIR_WRITE]) ||
535 (o->rate_iops[DDIR_TRIM] < o->rate_iops_min[DDIR_TRIM])) {
536 log_err("fio: minimum rate exceeds rate\n");
540 if (!o->timeout && o->time_based) {
541 log_err("fio: time_based requires a runtime/timeout setting\n");
543 ret = warnings_fatal;
546 if (o->fill_device && !o->size)
549 if (o->verify != VERIFY_NONE) {
550 if (td_write(td) && o->do_verify && o->numjobs > 1) {
551 log_info("Multiple writers may overwrite blocks that "
552 "belong to other jobs. This can cause "
553 "verification failures.\n");
554 ret = warnings_fatal;
557 o->refill_buffers = 1;
558 if (o->max_bs[DDIR_WRITE] != o->min_bs[DDIR_WRITE] &&
560 o->verify_interval = o->min_bs[DDIR_WRITE];
564 o->invalidate_cache = 0;
565 if (td->io_ops->flags & FIO_PIPEIO) {
566 log_info("fio: cannot pre-read files with an IO engine"
567 " that isn't seekable. Pre-read disabled.\n");
568 ret = warnings_fatal;
572 #ifndef FIO_HAVE_FDATASYNC
573 if (o->fdatasync_blocks) {
574 log_info("fio: this platform does not support fdatasync()"
575 " falling back to using fsync(). Use the 'fsync'"
576 " option instead of 'fdatasync' to get rid of"
578 o->fsync_blocks = o->fdatasync_blocks;
579 o->fdatasync_blocks = 0;
580 ret = warnings_fatal;
586 * Windows doesn't support O_DIRECT or O_SYNC with the _open interface,
587 * so fail if we're passed those flags
589 if ((td->io_ops->flags & FIO_SYNCIO) && (td->o.odirect || td->o.sync_io)) {
590 log_err("fio: Windows does not support direct or non-buffered io with"
591 " the synchronous ioengines. Use the 'windowsaio' ioengine"
592 " with 'direct=1' and 'iodepth=1' instead.\n");
598 * For fully compressible data, just zero them at init time.
599 * It's faster than repeatedly filling it.
601 if (td->o.compress_percentage == 100) {
602 td->o.zero_buffers = 1;
603 td->o.compress_percentage = 0;
607 * Using a non-uniform random distribution excludes usage of
610 if (td->o.random_distribution != FIO_RAND_DIST_RANDOM)
611 td->o.norandommap = 1;
617 * This function leaks the buffer
619 static char *to_kmg(unsigned int val)
621 char *buf = malloc(32);
622 char post[] = { 0, 'K', 'M', 'G', 'P', 'E', 0 };
633 snprintf(buf, 31, "%u%c", val, *p);
637 /* External engines are specified by "external:name.o") */
638 static const char *get_engine_name(const char *str)
640 char *p = strstr(str, ":");
646 strip_blank_front(&p);
651 static int exists_and_not_file(const char *filename)
655 if (lstat(filename, &sb) == -1)
658 /* \\.\ is the device namespace in Windows, where every file
659 * is a device node */
660 if (S_ISREG(sb.st_mode) && strncmp(filename, "\\\\.\\", 4) != 0)
666 static void td_fill_rand_seeds_os(struct thread_data *td)
668 os_random_seed(td->rand_seeds[FIO_RAND_BS_OFF], &td->bsrange_state);
669 os_random_seed(td->rand_seeds[FIO_RAND_VER_OFF], &td->verify_state);
670 os_random_seed(td->rand_seeds[FIO_RAND_MIX_OFF], &td->rwmix_state);
672 if (td->o.file_service_type == FIO_FSERVICE_RANDOM)
673 os_random_seed(td->rand_seeds[FIO_RAND_FILE_OFF], &td->next_file_state);
675 os_random_seed(td->rand_seeds[FIO_RAND_FILE_SIZE_OFF], &td->file_size_state);
676 os_random_seed(td->rand_seeds[FIO_RAND_TRIM_OFF], &td->trim_state);
681 if (td->o.rand_repeatable)
682 td->rand_seeds[FIO_RAND_BLOCK_OFF] = FIO_RANDSEED * td->thread_number;
684 os_random_seed(td->rand_seeds[FIO_RAND_BLOCK_OFF], &td->random_state);
687 static void td_fill_rand_seeds_internal(struct thread_data *td)
689 init_rand_seed(&td->__bsrange_state, td->rand_seeds[FIO_RAND_BS_OFF]);
690 init_rand_seed(&td->__verify_state, td->rand_seeds[FIO_RAND_VER_OFF]);
691 init_rand_seed(&td->__rwmix_state, td->rand_seeds[FIO_RAND_MIX_OFF]);
693 if (td->o.file_service_type == FIO_FSERVICE_RANDOM)
694 init_rand_seed(&td->__next_file_state, td->rand_seeds[FIO_RAND_FILE_OFF]);
696 init_rand_seed(&td->__file_size_state, td->rand_seeds[FIO_RAND_FILE_SIZE_OFF]);
697 init_rand_seed(&td->__trim_state, td->rand_seeds[FIO_RAND_TRIM_OFF]);
702 if (td->o.rand_repeatable)
703 td->rand_seeds[FIO_RAND_BLOCK_OFF] = FIO_RANDSEED * td->thread_number;
705 init_rand_seed(&td->__random_state, td->rand_seeds[FIO_RAND_BLOCK_OFF]);
708 void td_fill_rand_seeds(struct thread_data *td)
710 if (td->o.use_os_rand)
711 td_fill_rand_seeds_os(td);
713 td_fill_rand_seeds_internal(td);
715 init_rand_seed(&td->buf_state, td->rand_seeds[FIO_RAND_BUF_OFF]);
720 * Initializes the ioengine configured for a job, if it has not been done so
723 int ioengine_load(struct thread_data *td)
728 * Engine has already been loaded.
733 engine = get_engine_name(td->o.ioengine);
734 td->io_ops = load_ioengine(td, engine);
736 log_err("fio: failed to load engine %s\n", engine);
740 if (td->io_ops->option_struct_size && td->io_ops->options) {
742 * In cases where td->eo is set, clone it for a child thread.
743 * This requires that the parent thread has the same ioengine,
744 * but that requirement must be enforced by the code which
747 void *origeo = td->eo;
749 * Otherwise use the default thread options.
751 if (!origeo && td != &def_thread && def_thread.eo &&
752 def_thread.io_ops->options == td->io_ops->options)
753 origeo = def_thread.eo;
755 options_init(td->io_ops->options);
756 td->eo = malloc(td->io_ops->option_struct_size);
758 * Use the default thread as an option template if this uses the
759 * same options structure and there are non-default options
763 memcpy(td->eo, origeo, td->io_ops->option_struct_size);
764 options_mem_dupe(td->eo, td->io_ops->options);
766 memset(td->eo, 0, td->io_ops->option_struct_size);
767 fill_default_options(td->eo, td->io_ops->options);
769 *(struct thread_data **)td->eo = td;
775 static void init_flags(struct thread_data *td)
777 struct thread_options *o = &td->o;
779 if (o->verify_backlog)
780 td->flags |= TD_F_VER_BACKLOG;
782 td->flags |= TD_F_TRIM_BACKLOG;
783 if (o->read_iolog_file)
784 td->flags |= TD_F_READ_IOLOG;
785 if (o->refill_buffers)
786 td->flags |= TD_F_REFILL_BUFFERS;
787 if (o->scramble_buffers)
788 td->flags |= TD_F_SCRAMBLE_BUFFERS;
789 if (o->verify != VERIFY_NONE)
790 td->flags |= TD_F_VER_NONE;
794 * Adds a job to the list of things todo. Sanitizes the various options
795 * to make sure we don't have conflicts, and initializes various
798 static int add_job(struct thread_data *td, const char *jobname, int job_add_num)
800 const char *ddir_str[] = { NULL, "read", "write", "rw", NULL,
801 "randread", "randwrite", "randrw",
802 "trim", NULL, NULL, NULL, "randtrim" };
804 char fname[PATH_MAX];
805 int numjobs, file_alloced;
808 * the def_thread is just for options, it's not a real job
810 if (td == &def_thread)
816 * if we are just dumping the output command line, don't add the job
823 if (profile_td_init(td))
826 if (ioengine_load(td))
829 if (td->o.use_thread)
835 td->io_ops->flags |= FIO_RAWIO;
838 if (!td->o.filename && !td->files_index && !td->o.read_iolog_file) {
841 if (td->o.nr_files == 1 && exists_and_not_file(jobname))
842 add_file(td, jobname);
844 for (i = 0; i < td->o.nr_files; i++) {
845 sprintf(fname, "%s.%d.%d", jobname,
846 td->thread_number, i);
852 if (fixup_options(td))
858 * IO engines only need this for option callbacks, and the address may
859 * change in subprocesses.
862 *(struct thread_data **)td->eo = NULL;
864 if (td->io_ops->flags & FIO_DISKLESSIO) {
867 for_each_file(td, f, i)
868 f->real_file_size = -1ULL;
871 td->mutex = fio_mutex_init(FIO_MUTEX_LOCKED);
873 td->ts.clat_percentiles = td->o.clat_percentiles;
874 if (td->o.overwrite_plist)
875 memcpy(td->ts.percentile_list, td->o.percentile_list, sizeof(td->o.percentile_list));
877 memcpy(td->ts.percentile_list, def_percentile_list, sizeof(def_percentile_list));
879 for (i = 0; i < DDIR_RWDIR_CNT; i++) {
880 td->ts.clat_stat[i].min_val = ULONG_MAX;
881 td->ts.slat_stat[i].min_val = ULONG_MAX;
882 td->ts.lat_stat[i].min_val = ULONG_MAX;
883 td->ts.bw_stat[i].min_val = ULONG_MAX;
885 td->ddir_seq_nr = td->o.ddir_seq_nr;
887 if ((td->o.stonewall || td->o.new_group) && prev_group_jobs) {
892 td->groupid = groupid;
895 if (init_random_state(td, td->rand_seeds, sizeof(td->rand_seeds))) {
896 td_verror(td, errno, "init_random_state");
903 if (td->o.write_lat_log) {
904 setup_log(&td->lat_log, td->o.log_avg_msec);
905 setup_log(&td->slat_log, td->o.log_avg_msec);
906 setup_log(&td->clat_log, td->o.log_avg_msec);
908 if (td->o.write_bw_log)
909 setup_log(&td->bw_log, td->o.log_avg_msec);
910 if (td->o.write_iops_log)
911 setup_log(&td->iops_log, td->o.log_avg_msec);
914 td->o.name = strdup(jobname);
916 if (output_format == FIO_OUTPUT_NORMAL) {
918 if (!strcmp(td->io_ops->name, "cpuio")) {
919 log_info("%s: ioengine=cpu, cpuload=%u,"
920 " cpucycle=%u\n", td->o.name,
924 char *c1, *c2, *c3, *c4, *c5, *c6;
926 c1 = to_kmg(td->o.min_bs[DDIR_READ]);
927 c2 = to_kmg(td->o.max_bs[DDIR_READ]);
928 c3 = to_kmg(td->o.min_bs[DDIR_WRITE]);
929 c4 = to_kmg(td->o.max_bs[DDIR_WRITE]);
930 c5 = to_kmg(td->o.min_bs[DDIR_TRIM]);
931 c6 = to_kmg(td->o.max_bs[DDIR_TRIM]);
933 log_info("%s: (g=%d): rw=%s, bs=%s-%s/%s-%s/%s-%s,"
934 " ioengine=%s, iodepth=%u\n",
935 td->o.name, td->groupid,
936 ddir_str[td->o.td_ddir],
937 c1, c2, c3, c4, c5, c6,
948 } else if (job_add_num == 1)
953 * recurse add identical jobs, clear numjobs and stonewall options
954 * as they don't apply to sub-jobs
956 numjobs = td->o.numjobs;
958 struct thread_data *td_new = get_new_job(0, td, 1);
963 td_new->o.numjobs = 1;
964 td_new->o.stonewall = 0;
965 td_new->o.new_group = 0;
968 td_new->o.filename = NULL;
969 td_new->files_index = 0;
970 td_new->files_size = 0;
971 td_new->files = NULL;
974 job_add_num = numjobs - 1;
976 if (add_job(td_new, jobname, job_add_num))
987 * Parse as if 'o' was a command line
989 void add_job_opts(const char **o)
991 struct thread_data *td, *td_parent;
992 int i, in_global = 1;
996 td_parent = td = NULL;
998 if (!strncmp(o[i], "name", 4)) {
1001 add_job(td, jobname, 0);
1003 sprintf(jobname, "%s", o[i] + 5);
1005 if (in_global && !td_parent)
1006 td_parent = get_new_job(1, &def_thread, 0);
1007 else if (!in_global && !td) {
1009 td_parent = &def_thread;
1010 td = get_new_job(0, td_parent, 0);
1013 fio_options_parse(td_parent, (char **) &o[i], 1);
1015 fio_options_parse(td, (char **) &o[i], 1);
1020 add_job(td, jobname, 0);
1023 static int skip_this_section(const char *name)
1027 if (!nr_job_sections)
1029 if (!strncmp(name, "global", 6))
1032 for (i = 0; i < nr_job_sections; i++)
1033 if (!strcmp(job_sections[i], name))
1039 static int is_empty_or_comment(char *line)
1043 for (i = 0; i < strlen(line); i++) {
1048 if (!isspace((int) line[i]) && !iscntrl((int) line[i]))
1056 * This is our [ini] type file parser.
1058 int parse_jobs_ini(char *file, int is_buf, int stonewall_flag)
1060 unsigned int global;
1061 struct thread_data *td;
1062 char *string, *name;
1065 int ret = 0, stonewall;
1068 int inside_skip = 0;
1070 int i, alloc_opts, num_opts;
1075 if (!strcmp(file, "-"))
1078 f = fopen(file, "r");
1081 perror("fopen job file");
1086 string = malloc(4096);
1089 * it's really 256 + small bit, 280 should suffice
1092 memset(name, 0, 280);
1095 opts = malloc(sizeof(char *) * alloc_opts);
1098 stonewall = stonewall_flag;
1101 * if skip_fgets is set, we already have loaded a line we
1106 p = strsep(&file, "\n");
1108 p = fgets(string, 4096, f);
1114 strip_blank_front(&p);
1117 if (is_empty_or_comment(p))
1119 if (sscanf(p, "[%255[^\n]]", name) != 1) {
1122 log_err("fio: option <%s> outside of [] job section\n",
1127 name[strlen(name) - 1] = '\0';
1129 if (skip_this_section(name)) {
1135 global = !strncmp(name, "global", 6);
1141 log_info("--name=%s ", name);
1145 td = get_new_job(global, &def_thread, 0);
1152 * Seperate multiple job files by a stonewall
1154 if (!global && stonewall) {
1155 td->o.stonewall = stonewall;
1160 memset(opts, 0, alloc_opts * sizeof(char *));
1164 p = strsep(&file, "\n");
1166 p = fgets(string, 4096, f);
1170 if (is_empty_or_comment(p))
1173 strip_blank_front(&p);
1176 * new section, break out and make sure we don't
1177 * fgets() a new line at the top.
1186 if (num_opts == alloc_opts) {
1188 opts = realloc(opts,
1189 alloc_opts * sizeof(char *));
1192 opts[num_opts] = strdup(p);
1196 ret = fio_options_parse(td, opts, num_opts);
1199 for (i = 0; i < num_opts; i++)
1200 log_info("--%s ", opts[i]);
1202 ret = add_job(td, name, 0);
1204 log_err("fio: job %s dropped\n", name);
1208 for (i = 0; i < num_opts; i++)
1217 while (i < nr_job_sections) {
1218 free(job_sections[i]);
1222 for (i = 0; i < num_opts; i++)
1228 if (!is_buf && f != stdin)
1233 static int fill_def_thread(void)
1235 memset(&def_thread, 0, sizeof(def_thread));
1237 fio_getaffinity(getpid(), &def_thread.o.cpumask);
1238 def_thread.o.timeout = def_timeout;
1239 def_thread.o.error_dump = 1;
1241 * fill default options
1243 fio_fill_default_options(&def_thread);
1247 static void usage(const char *name)
1249 printf("%s\n", fio_version_string);
1250 printf("%s [options] [job options] <job file(s)>\n", name);
1251 printf(" --debug=options\tEnable debug logging. May be one/more of:\n"
1252 "\t\t\tprocess,file,io,mem,blktrace,verify,random,parse,\n"
1253 "\t\t\tdiskutil,job,mutex,profile,time,net\n");
1254 printf(" --output\t\tWrite output to file\n");
1255 printf(" --runtime\t\tRuntime in seconds\n");
1256 printf(" --latency-log\t\tGenerate per-job latency logs\n");
1257 printf(" --bandwidth-log\tGenerate per-job bandwidth logs\n");
1258 printf(" --minimal\t\tMinimal (terse) output\n");
1259 printf(" --output-format=x\tOutput format (terse,json,normal)\n");
1260 printf(" --terse-version=x\tSet terse version output format to 'x'\n");
1261 printf(" --version\t\tPrint version info and exit\n");
1262 printf(" --help\t\tPrint this page\n");
1263 printf(" --cpuclock-test\tPerform test/validation of CPU clock\n");
1264 printf(" --cmdhelp=cmd\t\tPrint command help, \"all\" for all of"
1266 printf(" --enghelp=engine\tPrint ioengine help, or list"
1267 " available ioengines\n");
1268 printf(" --enghelp=engine,cmd\tPrint help for an ioengine"
1270 printf(" --showcmd\t\tTurn a job file into command line options\n");
1271 printf(" --eta=when\t\tWhen ETA estimate should be printed\n");
1272 printf(" \t\tMay be \"always\", \"never\" or \"auto\"\n");
1273 printf(" --readonly\t\tTurn on safety read-only checks, preventing"
1275 printf(" --section=name\tOnly run specified section in job file\n");
1276 printf(" --alloc-size=kb\tSet smalloc pool to this size in kb"
1278 printf(" --warnings-fatal\tFio parser warnings are fatal\n");
1279 printf(" --max-jobs=nr\t\tMaximum number of threads/processes to support\n");
1280 printf(" --server=args\t\tStart a backend fio server\n");
1281 printf(" --daemonize=pidfile\tBackground fio server, write pid to file\n");
1282 printf(" --client=hostname\tTalk to remote backend fio server at hostname\n");
1283 printf("\nFio was written by Jens Axboe <jens.axboe@oracle.com>");
1284 printf("\n Jens Axboe <jaxboe@fusionio.com>\n");
1287 #ifdef FIO_INC_DEBUG
1288 struct debug_level debug_levels[] = {
1289 { .name = "process", .shift = FD_PROCESS, },
1290 { .name = "file", .shift = FD_FILE, },
1291 { .name = "io", .shift = FD_IO, },
1292 { .name = "mem", .shift = FD_MEM, },
1293 { .name = "blktrace", .shift = FD_BLKTRACE },
1294 { .name = "verify", .shift = FD_VERIFY },
1295 { .name = "random", .shift = FD_RANDOM },
1296 { .name = "parse", .shift = FD_PARSE },
1297 { .name = "diskutil", .shift = FD_DISKUTIL },
1298 { .name = "job", .shift = FD_JOB },
1299 { .name = "mutex", .shift = FD_MUTEX },
1300 { .name = "profile", .shift = FD_PROFILE },
1301 { .name = "time", .shift = FD_TIME },
1302 { .name = "net", .shift = FD_NET },
1306 static int set_debug(const char *string)
1308 struct debug_level *dl;
1309 char *p = (char *) string;
1313 if (!strcmp(string, "?") || !strcmp(string, "help")) {
1314 log_info("fio: dumping debug options:");
1315 for (i = 0; debug_levels[i].name; i++) {
1316 dl = &debug_levels[i];
1317 log_info("%s,", dl->name);
1323 while ((opt = strsep(&p, ",")) != NULL) {
1326 if (!strncmp(opt, "all", 3)) {
1327 log_info("fio: set all debug options\n");
1332 for (i = 0; debug_levels[i].name; i++) {
1333 dl = &debug_levels[i];
1334 found = !strncmp(opt, dl->name, strlen(dl->name));
1338 if (dl->shift == FD_JOB) {
1339 opt = strchr(opt, ':');
1341 log_err("fio: missing job number\n");
1345 fio_debug_jobno = atoi(opt);
1346 log_info("fio: set debug jobno %d\n",
1349 log_info("fio: set debug option %s\n", opt);
1350 fio_debug |= (1UL << dl->shift);
1356 log_err("fio: debug mask %s not found\n", opt);
1361 static int set_debug(const char *string)
1363 log_err("fio: debug tracing not included in build\n");
1368 static void fio_options_fill_optstring(void)
1370 char *ostr = cmd_optstr;
1374 while (l_opts[i].name) {
1375 ostr[c++] = l_opts[i].val;
1376 if (l_opts[i].has_arg == required_argument)
1378 else if (l_opts[i].has_arg == optional_argument) {
1387 static int client_flag_set(char c)
1392 while (l_opts[i].name) {
1393 int val = l_opts[i].val;
1395 if (c == (val & 0xff))
1396 return (val & FIO_CLIENT_FLAG);
1404 void parse_cmd_client(void *client, char *opt)
1406 fio_client_add_cmd_option(client, opt);
1409 int parse_cmd_line(int argc, char *argv[])
1411 struct thread_data *td = NULL;
1412 int c, ini_idx = 0, lidx, ret = 0, do_exit = 0, exit_val = 0;
1413 char *ostr = cmd_optstr;
1414 void *pid_file = NULL;
1415 void *cur_client = NULL;
1419 * Reset optind handling, since we may call this multiple times
1424 while ((c = getopt_long_only(argc, argv, ostr, l_opts, &lidx)) != -1) {
1427 if ((c & FIO_CLIENT_FLAG) || client_flag_set(c)) {
1428 parse_cmd_client(cur_client, argv[optind - 1]);
1429 c &= ~FIO_CLIENT_FLAG;
1434 smalloc_pool_size = atoi(optarg);
1437 def_timeout = atoi(optarg);
1446 f_out = fopen(optarg, "w+");
1448 perror("fopen output");
1454 output_format = FIO_OUTPUT_TERSE;
1457 if (!strcmp(optarg, "minimal") ||
1458 !strcmp(optarg, "terse") ||
1459 !strcmp(optarg, "csv"))
1460 output_format = FIO_OUTPUT_TERSE;
1461 else if (!strcmp(optarg, "json"))
1462 output_format = FIO_OUTPUT_JSON;
1464 output_format = FIO_OUTPUT_NORMAL;
1474 fio_show_option_help(optarg);
1480 fio_show_ioengine_help(optarg);
1492 log_info("%s\n", fio_version_string);
1497 terse_version = atoi(optarg);
1498 if (!(terse_version == 2 || terse_version == 3 ||
1499 terse_version == 4)) {
1500 log_err("fio: bad terse version format\n");
1506 if (!strcmp("always", optarg))
1507 eta_print = FIO_ETA_ALWAYS;
1508 else if (!strcmp("never", optarg))
1509 eta_print = FIO_ETA_NEVER;
1512 if (set_debug(optarg))
1518 if (!strcmp(optarg, "global")) {
1519 log_err("fio: can't use global as only "
1525 new_size = (nr_job_sections + 1) * sizeof(char *);
1526 job_sections = realloc(job_sections, new_size);
1527 job_sections[nr_job_sections] = strdup(optarg);
1532 exec_profile = strdup(optarg);
1534 case FIO_GETOPT_JOB: {
1535 const char *opt = l_opts[lidx].name;
1538 if (!strncmp(opt, "name", 4) && td) {
1539 ret = add_job(td, td->o.name ?: "fio", 0);
1545 int is_section = !strncmp(opt, "name", 4);
1548 if (!is_section || !strncmp(val, "global", 6))
1551 if (is_section && skip_this_section(val))
1554 td = get_new_job(global, &def_thread, 1);
1555 if (!td || ioengine_load(td))
1557 fio_options_set_ioengine_opts(l_opts, td);
1560 ret = fio_cmd_option_parse(td, opt, val);
1562 if (!ret && !strcmp(opt, "ioengine")) {
1564 if (ioengine_load(td))
1566 fio_options_set_ioengine_opts(l_opts, td);
1570 case FIO_GETOPT_IOENGINE: {
1571 const char *opt = l_opts[lidx].name;
1573 opt = l_opts[lidx].name;
1575 ret = fio_cmd_ioengine_option_parse(td, opt, val);
1582 max_jobs = atoi(optarg);
1583 if (!max_jobs || max_jobs > REAL_MAX_JOBS) {
1584 log_err("fio: invalid max jobs: %d\n", max_jobs);
1591 log_err("fio: can't be both client and server\n");
1597 fio_server_set_arg(optarg);
1602 pid_file = strdup(optarg);
1606 log_err("fio: can't be both client and server\n");
1611 if (fio_client_add(optarg, &cur_client)) {
1612 log_err("fio: failed adding client %s\n", optarg);
1618 * If the next argument exists and isn't an option,
1619 * assume it's a job file for this client only.
1621 while (optind < argc) {
1622 if (!strncmp(argv[optind], "--", 2) ||
1623 !strncmp(argv[optind], "-", 1))
1626 fio_client_add_ini_file(cur_client, argv[optind]);
1632 exit_val = fio_monotonic_clocktest();
1644 if (exit_val && !(is_backend || nr_clients))
1648 if (nr_clients && fio_clients_connect()) {
1654 if (is_backend && backend)
1655 return fio_start_server(pid_file);
1659 ret = add_job(td, td->o.name ?: "fio", 0);
1662 while (!ret && optind < argc) {
1664 ini_file = realloc(ini_file, ini_idx * sizeof(char *));
1665 ini_file[ini_idx - 1] = strdup(argv[optind]);
1672 int parse_options(int argc, char *argv[])
1679 fio_options_fill_optstring();
1680 fio_options_dup_and_init(l_opts);
1684 if (fill_def_thread())
1687 job_files = parse_cmd_line(argc, argv);
1689 if (job_files > 0) {
1690 for (i = 0; i < job_files; i++) {
1691 if (fill_def_thread())
1694 if (fio_clients_send_ini(ini_file[i]))
1697 } else if (!is_backend) {
1698 if (parse_jobs_ini(ini_file[i], 0, i))
1703 } else if (nr_clients) {
1704 if (fill_def_thread())
1706 if (fio_clients_send_ini(NULL))
1711 fio_options_free(&def_thread);
1713 if (!thread_number) {
1718 if (is_backend || nr_clients)
1723 log_err("No jobs(s) defined\n\n");
1733 if (def_thread.o.gtod_offload) {
1735 fio_gtod_offload = 1;
1736 fio_gtod_cpu = def_thread.o.gtod_cpu;
1739 if (output_format == FIO_OUTPUT_NORMAL)
1740 log_info("%s\n", fio_version_string);