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,
215 static void free_shm(void)
217 struct shmid_ds sbuf;
225 fio_debug_jobp = NULL;
227 shmctl(shm_id, IPC_RMID, &sbuf);
234 * The thread area is shared between the main process and the job
235 * threads/processes. So setup a shared memory segment that will hold
236 * all the job info. We use the end of the region for keeping track of
237 * open files across jobs, for file sharing.
239 static int setup_thread_area(void)
247 * 1024 is too much on some machines, scale max_jobs if
248 * we get a failure that looks like too large a shm segment
251 size_t size = max_jobs * sizeof(struct thread_data);
253 size += file_hash_size;
254 size += sizeof(unsigned int);
256 shm_id = shmget(0, size, IPC_CREAT | 0600);
259 if (errno != EINVAL && errno != ENOMEM && errno != ENOSPC) {
270 threads = shmat(shm_id, NULL, 0);
271 if (threads == (void *) -1) {
276 memset(threads, 0, max_jobs * sizeof(struct thread_data));
277 hash = (void *) threads + max_jobs * sizeof(struct thread_data);
278 fio_debug_jobp = (void *) hash + file_hash_size;
279 *fio_debug_jobp = -1;
280 file_hash_init(hash);
288 * Return a free job structure.
290 static struct thread_data *get_new_job(int global, struct thread_data *parent,
293 struct thread_data *td;
297 if (setup_thread_area()) {
298 log_err("error: failed to setup shm segment\n");
301 if (thread_number >= max_jobs) {
302 log_err("error: maximum number of jobs (%d) reached.\n",
307 td = &threads[thread_number++];
314 td->o.uid = td->o.gid = -1U;
316 dup_files(td, parent);
317 fio_options_mem_dupe(td);
319 profile_add_hooks(td);
321 td->thread_number = thread_number;
323 if (!parent || !parent->o.group_reporting)
329 static void put_job(struct thread_data *td)
331 if (td == &def_thread)
338 log_info("fio: %s\n", td->verror);
340 fio_options_free(td);
344 memset(&threads[td->thread_number - 1], 0, sizeof(*td));
348 static int __setup_rate(struct thread_data *td, enum fio_ddir ddir)
350 unsigned int bs = td->o.min_bs[ddir];
352 assert(ddir_rw(ddir));
354 if (td->o.rate[ddir])
355 td->rate_bps[ddir] = td->o.rate[ddir];
357 td->rate_bps[ddir] = td->o.rate_iops[ddir] * bs;
359 if (!td->rate_bps[ddir]) {
360 log_err("rate lower than supported\n");
364 td->rate_pending_usleep[ddir] = 0;
368 static int setup_rate(struct thread_data *td)
372 if (td->o.rate[DDIR_READ] || td->o.rate_iops[DDIR_READ])
373 ret = __setup_rate(td, DDIR_READ);
374 if (td->o.rate[DDIR_WRITE] || td->o.rate_iops[DDIR_WRITE])
375 ret |= __setup_rate(td, DDIR_WRITE);
376 if (td->o.rate[DDIR_TRIM] || td->o.rate_iops[DDIR_TRIM])
377 ret |= __setup_rate(td, DDIR_TRIM);
382 static int fixed_block_size(struct thread_options *o)
384 return o->min_bs[DDIR_READ] == o->max_bs[DDIR_READ] &&
385 o->min_bs[DDIR_WRITE] == o->max_bs[DDIR_WRITE] &&
386 o->min_bs[DDIR_TRIM] == o->max_bs[DDIR_TRIM] &&
387 o->min_bs[DDIR_READ] == o->min_bs[DDIR_WRITE] &&
388 o->min_bs[DDIR_READ] == o->min_bs[DDIR_TRIM];
392 * Lazy way of fixing up options that depend on each other. We could also
393 * define option callback handlers, but this is easier.
395 static int fixup_options(struct thread_data *td)
397 struct thread_options *o = &td->o;
400 #ifndef FIO_HAVE_PSHARED_MUTEX
401 if (!o->use_thread) {
402 log_info("fio: this platform does not support process shared"
403 " mutexes, forcing use of threads. Use the 'thread'"
404 " option to get rid of this warning.\n");
406 ret = warnings_fatal;
410 if (o->write_iolog_file && o->read_iolog_file) {
411 log_err("fio: read iolog overrides write_iolog\n");
412 free(o->write_iolog_file);
413 o->write_iolog_file = NULL;
414 ret = warnings_fatal;
418 * only really works with 1 file
420 if (o->zone_size && o->open_files == 1)
424 * If zone_range isn't specified, backward compatibility dictates it
425 * should be made equal to zone_size.
427 if (o->zone_size && !o->zone_range)
428 o->zone_range = o->zone_size;
431 * Reads can do overwrites, we always need to pre-create the file
433 if (td_read(td) || td_rw(td))
436 if (!o->min_bs[DDIR_READ])
437 o->min_bs[DDIR_READ] = o->bs[DDIR_READ];
438 if (!o->max_bs[DDIR_READ])
439 o->max_bs[DDIR_READ] = o->bs[DDIR_READ];
440 if (!o->min_bs[DDIR_WRITE])
441 o->min_bs[DDIR_WRITE] = o->bs[DDIR_WRITE];
442 if (!o->max_bs[DDIR_WRITE])
443 o->max_bs[DDIR_WRITE] = o->bs[DDIR_WRITE];
444 if (!o->min_bs[DDIR_TRIM])
445 o->min_bs[DDIR_TRIM] = o->bs[DDIR_TRIM];
446 if (!o->max_bs[DDIR_TRIM])
447 o->max_bs[DDIR_TRIM] = o->bs[DDIR_TRIM];
450 o->rw_min_bs = min(o->min_bs[DDIR_READ], o->min_bs[DDIR_WRITE]);
451 o->rw_min_bs = min(o->min_bs[DDIR_TRIM], o->rw_min_bs);
454 * For random IO, allow blockalign offset other than min_bs.
456 if (!o->ba[DDIR_READ] || !td_random(td))
457 o->ba[DDIR_READ] = o->min_bs[DDIR_READ];
458 if (!o->ba[DDIR_WRITE] || !td_random(td))
459 o->ba[DDIR_WRITE] = o->min_bs[DDIR_WRITE];
460 if (!o->ba[DDIR_TRIM] || !td_random(td))
461 o->ba[DDIR_TRIM] = o->min_bs[DDIR_TRIM];
463 if ((o->ba[DDIR_READ] != o->min_bs[DDIR_READ] ||
464 o->ba[DDIR_WRITE] != o->min_bs[DDIR_WRITE] ||
465 o->ba[DDIR_TRIM] != o->min_bs[DDIR_TRIM]) &&
467 log_err("fio: Any use of blockalign= turns off randommap\n");
469 ret = warnings_fatal;
472 if (!o->file_size_high)
473 o->file_size_high = o->file_size_low;
475 if (o->norandommap && o->verify != VERIFY_NONE
476 && !fixed_block_size(o)) {
477 log_err("fio: norandommap given for variable block sizes, "
478 "verify disabled\n");
479 o->verify = VERIFY_NONE;
480 ret = warnings_fatal;
482 if (o->bs_unaligned && (o->odirect || td->io_ops->flags & FIO_RAWIO))
483 log_err("fio: bs_unaligned may not work with raw io\n");
486 * thinktime_spin must be less than thinktime
488 if (o->thinktime_spin > o->thinktime)
489 o->thinktime_spin = o->thinktime;
492 * The low water mark cannot be bigger than the iodepth
494 if (o->iodepth_low > o->iodepth || !o->iodepth_low) {
496 * syslet work around - if the workload is sequential,
497 * we want to let the queue drain all the way down to
498 * avoid seeking between async threads
500 if (!strcmp(td->io_ops->name, "syslet-rw") && !td_random(td))
503 o->iodepth_low = o->iodepth;
507 * If batch number isn't set, default to the same as iodepth
509 if (o->iodepth_batch > o->iodepth || !o->iodepth_batch)
510 o->iodepth_batch = o->iodepth;
512 if (o->nr_files > td->files_index)
513 o->nr_files = td->files_index;
515 if (o->open_files > o->nr_files || !o->open_files)
516 o->open_files = o->nr_files;
518 if (((o->rate[DDIR_READ] + o->rate[DDIR_WRITE] + o->rate[DDIR_TRIM]) &&
519 (o->rate_iops[DDIR_READ] + o->rate_iops[DDIR_WRITE] + o->rate_iops[DDIR_TRIM])) ||
520 ((o->ratemin[DDIR_READ] + o->ratemin[DDIR_WRITE] + o->ratemin[DDIR_TRIM]) &&
521 (o->rate_iops_min[DDIR_READ] + o->rate_iops_min[DDIR_WRITE] + o->rate_iops_min[DDIR_TRIM]))) {
522 log_err("fio: rate and rate_iops are mutually exclusive\n");
525 if ((o->rate[DDIR_READ] < o->ratemin[DDIR_READ]) ||
526 (o->rate[DDIR_WRITE] < o->ratemin[DDIR_WRITE]) ||
527 (o->rate[DDIR_TRIM] < o->ratemin[DDIR_TRIM]) ||
528 (o->rate_iops[DDIR_READ] < o->rate_iops_min[DDIR_READ]) ||
529 (o->rate_iops[DDIR_WRITE] < o->rate_iops_min[DDIR_WRITE]) ||
530 (o->rate_iops[DDIR_TRIM] < o->rate_iops_min[DDIR_TRIM])) {
531 log_err("fio: minimum rate exceeds rate\n");
535 if (!o->timeout && o->time_based) {
536 log_err("fio: time_based requires a runtime/timeout setting\n");
538 ret = warnings_fatal;
541 if (o->fill_device && !o->size)
544 if (o->verify != VERIFY_NONE) {
545 if (td_write(td) && o->do_verify && o->numjobs > 1) {
546 log_info("Multiple writers may overwrite blocks that "
547 "belong to other jobs. This can cause "
548 "verification failures.\n");
549 ret = warnings_fatal;
552 o->refill_buffers = 1;
553 if (o->max_bs[DDIR_WRITE] != o->min_bs[DDIR_WRITE] &&
555 o->verify_interval = o->min_bs[DDIR_WRITE];
559 o->invalidate_cache = 0;
560 if (td->io_ops->flags & FIO_PIPEIO) {
561 log_info("fio: cannot pre-read files with an IO engine"
562 " that isn't seekable. Pre-read disabled.\n");
563 ret = warnings_fatal;
567 #ifndef FIO_HAVE_FDATASYNC
568 if (o->fdatasync_blocks) {
569 log_info("fio: this platform does not support fdatasync()"
570 " falling back to using fsync(). Use the 'fsync'"
571 " option instead of 'fdatasync' to get rid of"
573 o->fsync_blocks = o->fdatasync_blocks;
574 o->fdatasync_blocks = 0;
575 ret = warnings_fatal;
581 * Windows doesn't support O_DIRECT or O_SYNC with the _open interface,
582 * so fail if we're passed those flags
584 if ((td->io_ops->flags & FIO_SYNCIO) && (td->o.odirect || td->o.sync_io)) {
585 log_err("fio: Windows does not support direct or non-buffered io with"
586 " the synchronous ioengines. Use the 'windowsaio' ioengine"
587 " with 'direct=1' and 'iodepth=1' instead.\n");
593 * For fully compressible data, just zero them at init time.
594 * It's faster than repeatedly filling it.
596 if (td->o.compress_percentage == 100) {
597 td->o.zero_buffers = 1;
598 td->o.compress_percentage = 0;
602 * Using a non-uniform random distribution excludes usage of
605 if (td->o.random_distribution != FIO_RAND_DIST_RANDOM)
606 td->o.norandommap = 1;
612 * This function leaks the buffer
614 static char *to_kmg(unsigned int val)
616 char *buf = malloc(32);
617 char post[] = { 0, 'K', 'M', 'G', 'P', 'E', 0 };
628 snprintf(buf, 31, "%u%c", val, *p);
632 /* External engines are specified by "external:name.o") */
633 static const char *get_engine_name(const char *str)
635 char *p = strstr(str, ":");
641 strip_blank_front(&p);
646 static int exists_and_not_file(const char *filename)
650 if (lstat(filename, &sb) == -1)
653 /* \\.\ is the device namespace in Windows, where every file
654 * is a device node */
655 if (S_ISREG(sb.st_mode) && strncmp(filename, "\\\\.\\", 4) != 0)
661 static void td_fill_rand_seeds_os(struct thread_data *td)
663 os_random_seed(td->rand_seeds[FIO_RAND_BS_OFF], &td->bsrange_state);
664 os_random_seed(td->rand_seeds[FIO_RAND_VER_OFF], &td->verify_state);
665 os_random_seed(td->rand_seeds[FIO_RAND_MIX_OFF], &td->rwmix_state);
667 if (td->o.file_service_type == FIO_FSERVICE_RANDOM)
668 os_random_seed(td->rand_seeds[FIO_RAND_FILE_OFF], &td->next_file_state);
670 os_random_seed(td->rand_seeds[FIO_RAND_FILE_SIZE_OFF], &td->file_size_state);
671 os_random_seed(td->rand_seeds[FIO_RAND_TRIM_OFF], &td->trim_state);
676 if (td->o.rand_repeatable)
677 td->rand_seeds[FIO_RAND_BLOCK_OFF] = FIO_RANDSEED * td->thread_number;
679 os_random_seed(td->rand_seeds[FIO_RAND_BLOCK_OFF], &td->random_state);
682 static void td_fill_rand_seeds_internal(struct thread_data *td)
684 init_rand_seed(&td->__bsrange_state, td->rand_seeds[FIO_RAND_BS_OFF]);
685 init_rand_seed(&td->__verify_state, td->rand_seeds[FIO_RAND_VER_OFF]);
686 init_rand_seed(&td->__rwmix_state, td->rand_seeds[FIO_RAND_MIX_OFF]);
688 if (td->o.file_service_type == FIO_FSERVICE_RANDOM)
689 init_rand_seed(&td->__next_file_state, td->rand_seeds[FIO_RAND_FILE_OFF]);
691 init_rand_seed(&td->__file_size_state, td->rand_seeds[FIO_RAND_FILE_SIZE_OFF]);
692 init_rand_seed(&td->__trim_state, td->rand_seeds[FIO_RAND_TRIM_OFF]);
697 if (td->o.rand_repeatable)
698 td->rand_seeds[FIO_RAND_BLOCK_OFF] = FIO_RANDSEED * td->thread_number;
700 init_rand_seed(&td->__random_state, td->rand_seeds[FIO_RAND_BLOCK_OFF]);
703 void td_fill_rand_seeds(struct thread_data *td)
705 if (td->o.use_os_rand)
706 td_fill_rand_seeds_os(td);
708 td_fill_rand_seeds_internal(td);
710 init_rand_seed(&td->buf_state, td->rand_seeds[FIO_RAND_BUF_OFF]);
715 * Initializes the ioengine configured for a job, if it has not been done so
718 int ioengine_load(struct thread_data *td)
723 * Engine has already been loaded.
728 engine = get_engine_name(td->o.ioengine);
729 td->io_ops = load_ioengine(td, engine);
731 log_err("fio: failed to load engine %s\n", engine);
735 if (td->io_ops->option_struct_size && td->io_ops->options) {
737 * In cases where td->eo is set, clone it for a child thread.
738 * This requires that the parent thread has the same ioengine,
739 * but that requirement must be enforced by the code which
742 void *origeo = td->eo;
744 * Otherwise use the default thread options.
746 if (!origeo && td != &def_thread && def_thread.eo &&
747 def_thread.io_ops->options == td->io_ops->options)
748 origeo = def_thread.eo;
750 options_init(td->io_ops->options);
751 td->eo = malloc(td->io_ops->option_struct_size);
753 * Use the default thread as an option template if this uses the
754 * same options structure and there are non-default options
758 memcpy(td->eo, origeo, td->io_ops->option_struct_size);
759 options_mem_dupe(td->eo, td->io_ops->options);
761 memset(td->eo, 0, td->io_ops->option_struct_size);
762 fill_default_options(td->eo, td->io_ops->options);
764 *(struct thread_data **)td->eo = td;
770 static void init_flags(struct thread_data *td)
772 struct thread_options *o = &td->o;
774 if (o->verify_backlog)
775 td->flags |= TD_F_VER_BACKLOG;
777 td->flags |= TD_F_TRIM_BACKLOG;
778 if (o->read_iolog_file)
779 td->flags |= TD_F_READ_IOLOG;
780 if (o->refill_buffers)
781 td->flags |= TD_F_REFILL_BUFFERS;
782 if (o->scramble_buffers)
783 td->flags |= TD_F_SCRAMBLE_BUFFERS;
784 if (o->verify != VERIFY_NONE)
785 td->flags |= TD_F_VER_NONE;
789 * Adds a job to the list of things todo. Sanitizes the various options
790 * to make sure we don't have conflicts, and initializes various
793 static int add_job(struct thread_data *td, const char *jobname, int job_add_num)
795 const char *ddir_str[] = { NULL, "read", "write", "rw", NULL,
796 "randread", "randwrite", "randrw",
797 "trim", NULL, NULL, NULL, "randtrim" };
799 char fname[PATH_MAX];
800 int numjobs, file_alloced;
803 * the def_thread is just for options, it's not a real job
805 if (td == &def_thread)
811 * if we are just dumping the output command line, don't add the job
818 if (profile_td_init(td))
821 if (ioengine_load(td))
824 if (td->o.use_thread)
830 td->io_ops->flags |= FIO_RAWIO;
833 if (!td->o.filename && !td->files_index && !td->o.read_iolog_file) {
836 if (td->o.nr_files == 1 && exists_and_not_file(jobname))
837 add_file(td, jobname);
839 for (i = 0; i < td->o.nr_files; i++) {
840 sprintf(fname, "%s.%d.%d", jobname,
841 td->thread_number, i);
847 if (fixup_options(td))
853 * IO engines only need this for option callbacks, and the address may
854 * change in subprocesses.
857 *(struct thread_data **)td->eo = NULL;
859 if (td->io_ops->flags & FIO_DISKLESSIO) {
862 for_each_file(td, f, i)
863 f->real_file_size = -1ULL;
866 td->mutex = fio_mutex_init(FIO_MUTEX_LOCKED);
868 td->ts.clat_percentiles = td->o.clat_percentiles;
869 if (td->o.overwrite_plist)
870 memcpy(td->ts.percentile_list, td->o.percentile_list, sizeof(td->o.percentile_list));
872 memcpy(td->ts.percentile_list, def_percentile_list, sizeof(def_percentile_list));
874 for (i = 0; i < DDIR_RWDIR_CNT; i++) {
875 td->ts.clat_stat[i].min_val = ULONG_MAX;
876 td->ts.slat_stat[i].min_val = ULONG_MAX;
877 td->ts.lat_stat[i].min_val = ULONG_MAX;
878 td->ts.bw_stat[i].min_val = ULONG_MAX;
880 td->ddir_seq_nr = td->o.ddir_seq_nr;
882 if ((td->o.stonewall || td->o.new_group) && prev_group_jobs) {
887 td->groupid = groupid;
890 if (init_random_state(td, td->rand_seeds, sizeof(td->rand_seeds))) {
891 td_verror(td, errno, "init_random_state");
898 if (td->o.write_lat_log) {
899 setup_log(&td->lat_log, td->o.log_avg_msec);
900 setup_log(&td->slat_log, td->o.log_avg_msec);
901 setup_log(&td->clat_log, td->o.log_avg_msec);
903 if (td->o.write_bw_log)
904 setup_log(&td->bw_log, td->o.log_avg_msec);
905 if (td->o.write_iops_log)
906 setup_log(&td->iops_log, td->o.log_avg_msec);
909 td->o.name = strdup(jobname);
911 if (output_format == FIO_OUTPUT_NORMAL) {
913 if (!strcmp(td->io_ops->name, "cpuio")) {
914 log_info("%s: ioengine=cpu, cpuload=%u,"
915 " cpucycle=%u\n", td->o.name,
919 char *c1, *c2, *c3, *c4, *c5, *c6;
921 c1 = to_kmg(td->o.min_bs[DDIR_READ]);
922 c2 = to_kmg(td->o.max_bs[DDIR_READ]);
923 c3 = to_kmg(td->o.min_bs[DDIR_WRITE]);
924 c4 = to_kmg(td->o.max_bs[DDIR_WRITE]);
925 c5 = to_kmg(td->o.min_bs[DDIR_TRIM]);
926 c6 = to_kmg(td->o.max_bs[DDIR_TRIM]);
928 log_info("%s: (g=%d): rw=%s, bs=%s-%s/%s-%s/%s-%s,"
929 " ioengine=%s, iodepth=%u\n",
930 td->o.name, td->groupid,
931 ddir_str[td->o.td_ddir],
932 c1, c2, c3, c4, c5, c6,
943 } else if (job_add_num == 1)
948 * recurse add identical jobs, clear numjobs and stonewall options
949 * as they don't apply to sub-jobs
951 numjobs = td->o.numjobs;
953 struct thread_data *td_new = get_new_job(0, td, 1);
958 td_new->o.numjobs = 1;
959 td_new->o.stonewall = 0;
960 td_new->o.new_group = 0;
963 td_new->o.filename = NULL;
964 td_new->files_index = 0;
965 td_new->files_size = 0;
966 td_new->files = NULL;
969 job_add_num = numjobs - 1;
971 if (add_job(td_new, jobname, job_add_num))
982 * Parse as if 'o' was a command line
984 void add_job_opts(const char **o)
986 struct thread_data *td, *td_parent;
987 int i, in_global = 1;
991 td_parent = td = NULL;
993 if (!strncmp(o[i], "name", 4)) {
996 add_job(td, jobname, 0);
998 sprintf(jobname, "%s", o[i] + 5);
1000 if (in_global && !td_parent)
1001 td_parent = get_new_job(1, &def_thread, 0);
1002 else if (!in_global && !td) {
1004 td_parent = &def_thread;
1005 td = get_new_job(0, td_parent, 0);
1008 fio_options_parse(td_parent, (char **) &o[i], 1);
1010 fio_options_parse(td, (char **) &o[i], 1);
1015 add_job(td, jobname, 0);
1018 static int skip_this_section(const char *name)
1022 if (!nr_job_sections)
1024 if (!strncmp(name, "global", 6))
1027 for (i = 0; i < nr_job_sections; i++)
1028 if (!strcmp(job_sections[i], name))
1034 static int is_empty_or_comment(char *line)
1038 for (i = 0; i < strlen(line); i++) {
1043 if (!isspace((int) line[i]) && !iscntrl((int) line[i]))
1051 * This is our [ini] type file parser.
1053 int parse_jobs_ini(char *file, int is_buf, int stonewall_flag)
1055 unsigned int global;
1056 struct thread_data *td;
1057 char *string, *name;
1060 int ret = 0, stonewall;
1063 int inside_skip = 0;
1065 int i, alloc_opts, num_opts;
1070 if (!strcmp(file, "-"))
1073 f = fopen(file, "r");
1076 perror("fopen job file");
1081 string = malloc(4096);
1084 * it's really 256 + small bit, 280 should suffice
1087 memset(name, 0, 280);
1090 opts = malloc(sizeof(char *) * alloc_opts);
1093 stonewall = stonewall_flag;
1096 * if skip_fgets is set, we already have loaded a line we
1101 p = strsep(&file, "\n");
1103 p = fgets(string, 4096, f);
1109 strip_blank_front(&p);
1112 if (is_empty_or_comment(p))
1114 if (sscanf(p, "[%255[^\n]]", name) != 1) {
1117 log_err("fio: option <%s> outside of [] job section\n",
1122 name[strlen(name) - 1] = '\0';
1124 if (skip_this_section(name)) {
1130 global = !strncmp(name, "global", 6);
1136 log_info("--name=%s ", name);
1140 td = get_new_job(global, &def_thread, 0);
1147 * Seperate multiple job files by a stonewall
1149 if (!global && stonewall) {
1150 td->o.stonewall = stonewall;
1155 memset(opts, 0, alloc_opts * sizeof(char *));
1159 p = strsep(&file, "\n");
1161 p = fgets(string, 4096, f);
1165 if (is_empty_or_comment(p))
1168 strip_blank_front(&p);
1171 * new section, break out and make sure we don't
1172 * fgets() a new line at the top.
1181 if (num_opts == alloc_opts) {
1183 opts = realloc(opts,
1184 alloc_opts * sizeof(char *));
1187 opts[num_opts] = strdup(p);
1191 ret = fio_options_parse(td, opts, num_opts);
1194 for (i = 0; i < num_opts; i++)
1195 log_info("--%s ", opts[i]);
1197 ret = add_job(td, name, 0);
1199 log_err("fio: job %s dropped\n", name);
1203 for (i = 0; i < num_opts; i++)
1212 while (i < nr_job_sections) {
1213 free(job_sections[i]);
1217 for (i = 0; i < num_opts; i++)
1223 if (!is_buf && f != stdin)
1228 static int fill_def_thread(void)
1230 memset(&def_thread, 0, sizeof(def_thread));
1232 fio_getaffinity(getpid(), &def_thread.o.cpumask);
1233 def_thread.o.timeout = def_timeout;
1234 def_thread.o.error_dump = 1;
1236 * fill default options
1238 fio_fill_default_options(&def_thread);
1242 static void usage(const char *name)
1244 printf("%s\n", fio_version_string);
1245 printf("%s [options] [job options] <job file(s)>\n", name);
1246 printf(" --debug=options\tEnable debug logging. May be one/more of:\n"
1247 "\t\t\tprocess,file,io,mem,blktrace,verify,random,parse,\n"
1248 "\t\t\tdiskutil,job,mutex,profile,time,net\n");
1249 printf(" --output\t\tWrite output to file\n");
1250 printf(" --runtime\t\tRuntime in seconds\n");
1251 printf(" --latency-log\t\tGenerate per-job latency logs\n");
1252 printf(" --bandwidth-log\tGenerate per-job bandwidth logs\n");
1253 printf(" --minimal\t\tMinimal (terse) output\n");
1254 printf(" --output-format=x\tOutput format (terse,json,normal)\n");
1255 printf(" --terse-version=x\tSet terse version output format to 'x'\n");
1256 printf(" --version\t\tPrint version info and exit\n");
1257 printf(" --help\t\tPrint this page\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("\nFio was written by Jens Axboe <jens.axboe@oracle.com>");
1278 printf("\n Jens Axboe <jaxboe@fusionio.com>\n");
1281 #ifdef FIO_INC_DEBUG
1282 struct debug_level debug_levels[] = {
1283 { .name = "process", .shift = FD_PROCESS, },
1284 { .name = "file", .shift = FD_FILE, },
1285 { .name = "io", .shift = FD_IO, },
1286 { .name = "mem", .shift = FD_MEM, },
1287 { .name = "blktrace", .shift = FD_BLKTRACE },
1288 { .name = "verify", .shift = FD_VERIFY },
1289 { .name = "random", .shift = FD_RANDOM },
1290 { .name = "parse", .shift = FD_PARSE },
1291 { .name = "diskutil", .shift = FD_DISKUTIL },
1292 { .name = "job", .shift = FD_JOB },
1293 { .name = "mutex", .shift = FD_MUTEX },
1294 { .name = "profile", .shift = FD_PROFILE },
1295 { .name = "time", .shift = FD_TIME },
1296 { .name = "net", .shift = FD_NET },
1300 static int set_debug(const char *string)
1302 struct debug_level *dl;
1303 char *p = (char *) string;
1307 if (!strcmp(string, "?") || !strcmp(string, "help")) {
1308 log_info("fio: dumping debug options:");
1309 for (i = 0; debug_levels[i].name; i++) {
1310 dl = &debug_levels[i];
1311 log_info("%s,", dl->name);
1317 while ((opt = strsep(&p, ",")) != NULL) {
1320 if (!strncmp(opt, "all", 3)) {
1321 log_info("fio: set all debug options\n");
1326 for (i = 0; debug_levels[i].name; i++) {
1327 dl = &debug_levels[i];
1328 found = !strncmp(opt, dl->name, strlen(dl->name));
1332 if (dl->shift == FD_JOB) {
1333 opt = strchr(opt, ':');
1335 log_err("fio: missing job number\n");
1339 fio_debug_jobno = atoi(opt);
1340 log_info("fio: set debug jobno %d\n",
1343 log_info("fio: set debug option %s\n", opt);
1344 fio_debug |= (1UL << dl->shift);
1350 log_err("fio: debug mask %s not found\n", opt);
1355 static int set_debug(const char *string)
1357 log_err("fio: debug tracing not included in build\n");
1362 static void fio_options_fill_optstring(void)
1364 char *ostr = cmd_optstr;
1368 while (l_opts[i].name) {
1369 ostr[c++] = l_opts[i].val;
1370 if (l_opts[i].has_arg == required_argument)
1372 else if (l_opts[i].has_arg == optional_argument) {
1381 static int client_flag_set(char c)
1386 while (l_opts[i].name) {
1387 int val = l_opts[i].val;
1389 if (c == (val & 0xff))
1390 return (val & FIO_CLIENT_FLAG);
1398 void parse_cmd_client(void *client, char *opt)
1400 fio_client_add_cmd_option(client, opt);
1403 int parse_cmd_line(int argc, char *argv[])
1405 struct thread_data *td = NULL;
1406 int c, ini_idx = 0, lidx, ret = 0, do_exit = 0, exit_val = 0;
1407 char *ostr = cmd_optstr;
1408 void *pid_file = NULL;
1409 void *cur_client = NULL;
1413 * Reset optind handling, since we may call this multiple times
1418 while ((c = getopt_long_only(argc, argv, ostr, l_opts, &lidx)) != -1) {
1421 if ((c & FIO_CLIENT_FLAG) || client_flag_set(c)) {
1422 parse_cmd_client(cur_client, argv[optind - 1]);
1423 c &= ~FIO_CLIENT_FLAG;
1428 smalloc_pool_size = atoi(optarg);
1431 def_timeout = atoi(optarg);
1440 f_out = fopen(optarg, "w+");
1442 perror("fopen output");
1448 output_format = FIO_OUTPUT_TERSE;
1451 if (!strcmp(optarg, "minimal") ||
1452 !strcmp(optarg, "terse") ||
1453 !strcmp(optarg, "csv"))
1454 output_format = FIO_OUTPUT_TERSE;
1455 else if (!strcmp(optarg, "json"))
1456 output_format = FIO_OUTPUT_JSON;
1458 output_format = FIO_OUTPUT_NORMAL;
1468 fio_show_option_help(optarg);
1474 fio_show_ioengine_help(optarg);
1486 log_info("%s\n", fio_version_string);
1491 terse_version = atoi(optarg);
1492 if (!(terse_version == 2 || terse_version == 3 ||
1493 terse_version == 4)) {
1494 log_err("fio: bad terse version format\n");
1500 if (!strcmp("always", optarg))
1501 eta_print = FIO_ETA_ALWAYS;
1502 else if (!strcmp("never", optarg))
1503 eta_print = FIO_ETA_NEVER;
1506 if (set_debug(optarg))
1512 if (!strcmp(optarg, "global")) {
1513 log_err("fio: can't use global as only "
1519 new_size = (nr_job_sections + 1) * sizeof(char *);
1520 job_sections = realloc(job_sections, new_size);
1521 job_sections[nr_job_sections] = strdup(optarg);
1526 exec_profile = strdup(optarg);
1528 case FIO_GETOPT_JOB: {
1529 const char *opt = l_opts[lidx].name;
1532 if (!strncmp(opt, "name", 4) && td) {
1533 ret = add_job(td, td->o.name ?: "fio", 0);
1539 int is_section = !strncmp(opt, "name", 4);
1542 if (!is_section || !strncmp(val, "global", 6))
1545 if (is_section && skip_this_section(val))
1548 td = get_new_job(global, &def_thread, 1);
1549 if (!td || ioengine_load(td))
1551 fio_options_set_ioengine_opts(l_opts, td);
1554 ret = fio_cmd_option_parse(td, opt, val);
1556 if (!ret && !strcmp(opt, "ioengine")) {
1558 if (ioengine_load(td))
1560 fio_options_set_ioengine_opts(l_opts, td);
1564 case FIO_GETOPT_IOENGINE: {
1565 const char *opt = l_opts[lidx].name;
1567 opt = l_opts[lidx].name;
1569 ret = fio_cmd_ioengine_option_parse(td, opt, val);
1576 max_jobs = atoi(optarg);
1577 if (!max_jobs || max_jobs > REAL_MAX_JOBS) {
1578 log_err("fio: invalid max jobs: %d\n", max_jobs);
1585 log_err("fio: can't be both client and server\n");
1591 fio_server_set_arg(optarg);
1596 pid_file = strdup(optarg);
1600 log_err("fio: can't be both client and server\n");
1605 if (fio_client_add(optarg, &cur_client)) {
1606 log_err("fio: failed adding client %s\n", optarg);
1612 * If the next argument exists and isn't an option,
1613 * assume it's a job file for this client only.
1615 while (optind < argc) {
1616 if (!strncmp(argv[optind], "--", 2) ||
1617 !strncmp(argv[optind], "-", 1))
1620 fio_client_add_ini_file(cur_client, argv[optind]);
1634 if (exit_val && !(is_backend || nr_clients))
1638 if (nr_clients && fio_clients_connect()) {
1644 if (is_backend && backend)
1645 return fio_start_server(pid_file);
1649 ret = add_job(td, td->o.name ?: "fio", 0);
1652 while (!ret && optind < argc) {
1654 ini_file = realloc(ini_file, ini_idx * sizeof(char *));
1655 ini_file[ini_idx - 1] = strdup(argv[optind]);
1662 int parse_options(int argc, char *argv[])
1669 fio_options_fill_optstring();
1670 fio_options_dup_and_init(l_opts);
1674 if (fill_def_thread())
1677 job_files = parse_cmd_line(argc, argv);
1679 if (job_files > 0) {
1680 for (i = 0; i < job_files; i++) {
1681 if (fill_def_thread())
1684 if (fio_clients_send_ini(ini_file[i]))
1687 } else if (!is_backend) {
1688 if (parse_jobs_ini(ini_file[i], 0, i))
1693 } else if (nr_clients) {
1694 if (fill_def_thread())
1696 if (fio_clients_send_ini(NULL))
1701 fio_options_free(&def_thread);
1703 if (!thread_number) {
1708 if (is_backend || nr_clients)
1713 log_err("No jobs(s) defined\n\n");
1723 if (def_thread.o.gtod_offload) {
1725 fio_gtod_offload = 1;
1726 fio_gtod_cpu = def_thread.o.gtod_cpu;
1729 if (output_format == FIO_OUTPUT_NORMAL)
1730 log_info("%s\n", fio_version_string);