2 * This file contains job initialization and setup functions.
13 #include <sys/types.h>
24 #include "lib/getopt.h"
26 const char fio_version_string[] = FIO_VERSION;
28 #define FIO_RANDSEED (0xb1899bedUL)
30 static char **ini_file;
31 static int max_jobs = FIO_MAX_JOBS;
32 static int dump_cmdline;
33 static int def_timeout;
35 static struct thread_data def_thread;
36 struct thread_data *threads = NULL;
38 int exitall_on_terminate = 0;
39 int output_format = FIO_OUTPUT_NORMAL;
41 unsigned long long mlock_size = 0;
44 char **job_sections = NULL;
45 int nr_job_sections = 0;
46 char *exec_profile = NULL;
47 int warnings_fatal = 0;
48 int terse_version = 3;
56 static int write_lat_log;
58 static int prev_group_jobs;
60 unsigned long fio_debug = 0;
61 unsigned int fio_debug_jobno = -1;
62 unsigned int *fio_debug_jobp = NULL;
64 static char cmd_optstr[256];
67 const fio_fp64_t def_percentile_list[FIO_IO_U_LIST_MAX_LEN] = {
87 #define FIO_CLIENT_FLAG (1 << 16)
90 * Command line options. These will contain the above, plus a few
91 * extra that only pertain to fio itself and not jobs.
93 static struct option l_opts[FIO_NR_OPTIONS] = {
95 .name = (char *) "output",
96 .has_arg = required_argument,
97 .val = 'o' | FIO_CLIENT_FLAG,
100 .name = (char *) "timeout",
101 .has_arg = required_argument,
102 .val = 't' | FIO_CLIENT_FLAG,
105 .name = (char *) "latency-log",
106 .has_arg = required_argument,
107 .val = 'l' | FIO_CLIENT_FLAG,
110 .name = (char *) "bandwidth-log",
111 .has_arg = required_argument,
112 .val = 'b' | FIO_CLIENT_FLAG,
115 .name = (char *) "minimal",
116 .has_arg = optional_argument,
117 .val = 'm' | FIO_CLIENT_FLAG,
120 .name = (char *) "output-format",
121 .has_arg = optional_argument,
122 .val = 'F' | FIO_CLIENT_FLAG,
125 .name = (char *) "version",
126 .has_arg = no_argument,
127 .val = 'v' | FIO_CLIENT_FLAG,
130 .name = (char *) "help",
131 .has_arg = no_argument,
132 .val = 'h' | FIO_CLIENT_FLAG,
135 .name = (char *) "cmdhelp",
136 .has_arg = optional_argument,
137 .val = 'c' | FIO_CLIENT_FLAG,
140 .name = (char *) "enghelp",
141 .has_arg = optional_argument,
142 .val = 'i' | FIO_CLIENT_FLAG,
145 .name = (char *) "showcmd",
146 .has_arg = no_argument,
147 .val = 's' | FIO_CLIENT_FLAG,
150 .name = (char *) "readonly",
151 .has_arg = no_argument,
152 .val = 'r' | FIO_CLIENT_FLAG,
155 .name = (char *) "eta",
156 .has_arg = required_argument,
157 .val = 'e' | FIO_CLIENT_FLAG,
160 .name = (char *) "debug",
161 .has_arg = required_argument,
162 .val = 'd' | FIO_CLIENT_FLAG,
165 .name = (char *) "section",
166 .has_arg = required_argument,
167 .val = 'x' | FIO_CLIENT_FLAG,
170 .name = (char *) "alloc-size",
171 .has_arg = required_argument,
172 .val = 'a' | FIO_CLIENT_FLAG,
175 .name = (char *) "profile",
176 .has_arg = required_argument,
177 .val = 'p' | FIO_CLIENT_FLAG,
180 .name = (char *) "warnings-fatal",
181 .has_arg = no_argument,
182 .val = 'w' | FIO_CLIENT_FLAG,
185 .name = (char *) "max-jobs",
186 .has_arg = required_argument,
187 .val = 'j' | FIO_CLIENT_FLAG,
190 .name = (char *) "terse-version",
191 .has_arg = required_argument,
192 .val = 'V' | FIO_CLIENT_FLAG,
195 .name = (char *) "server",
196 .has_arg = optional_argument,
199 { .name = (char *) "daemonize",
200 .has_arg = required_argument,
204 .name = (char *) "client",
205 .has_arg = required_argument,
213 static void free_shm(void)
215 struct shmid_ds sbuf;
223 fio_debug_jobp = NULL;
225 shmctl(shm_id, IPC_RMID, &sbuf);
232 * The thread area is shared between the main process and the job
233 * threads/processes. So setup a shared memory segment that will hold
234 * all the job info. We use the end of the region for keeping track of
235 * open files across jobs, for file sharing.
237 static int setup_thread_area(void)
245 * 1024 is too much on some machines, scale max_jobs if
246 * we get a failure that looks like too large a shm segment
249 size_t size = max_jobs * sizeof(struct thread_data);
251 size += file_hash_size;
252 size += sizeof(unsigned int);
254 shm_id = shmget(0, size, IPC_CREAT | 0600);
257 if (errno != EINVAL && errno != ENOMEM && errno != ENOSPC) {
268 threads = shmat(shm_id, NULL, 0);
269 if (threads == (void *) -1) {
274 memset(threads, 0, max_jobs * sizeof(struct thread_data));
275 hash = (void *) threads + max_jobs * sizeof(struct thread_data);
276 fio_debug_jobp = (void *) hash + file_hash_size;
277 *fio_debug_jobp = -1;
278 file_hash_init(hash);
286 * Return a free job structure.
288 static struct thread_data *get_new_job(int global, struct thread_data *parent,
291 struct thread_data *td;
295 if (setup_thread_area()) {
296 log_err("error: failed to setup shm segment\n");
299 if (thread_number >= max_jobs) {
300 log_err("error: maximum number of jobs (%d) reached.\n",
305 td = &threads[thread_number++];
312 td->o.uid = td->o.gid = -1U;
314 dup_files(td, parent);
315 fio_options_mem_dupe(td);
317 profile_add_hooks(td);
319 td->thread_number = thread_number;
323 static void put_job(struct thread_data *td)
325 if (td == &def_thread)
332 log_info("fio: %s\n", td->verror);
334 fio_options_free(td);
338 memset(&threads[td->thread_number - 1], 0, sizeof(*td));
342 static int __setup_rate(struct thread_data *td, enum fio_ddir ddir)
344 unsigned int bs = td->o.min_bs[ddir];
346 assert(ddir_rw(ddir));
348 if (td->o.rate[ddir])
349 td->rate_bps[ddir] = td->o.rate[ddir];
351 td->rate_bps[ddir] = td->o.rate_iops[ddir] * bs;
353 if (!td->rate_bps[ddir]) {
354 log_err("rate lower than supported\n");
358 td->rate_pending_usleep[ddir] = 0;
362 static int setup_rate(struct thread_data *td)
366 if (td->o.rate[DDIR_READ] || td->o.rate_iops[DDIR_READ])
367 ret = __setup_rate(td, DDIR_READ);
368 if (td->o.rate[DDIR_WRITE] || td->o.rate_iops[DDIR_WRITE])
369 ret |= __setup_rate(td, DDIR_WRITE);
370 if (td->o.rate[DDIR_TRIM] || td->o.rate_iops[DDIR_TRIM])
371 ret |= __setup_rate(td, DDIR_TRIM);
376 static int fixed_block_size(struct thread_options *o)
378 return o->min_bs[DDIR_READ] == o->max_bs[DDIR_READ] &&
379 o->min_bs[DDIR_WRITE] == o->max_bs[DDIR_WRITE] &&
380 o->min_bs[DDIR_TRIM] == o->max_bs[DDIR_TRIM] &&
381 o->min_bs[DDIR_READ] == o->min_bs[DDIR_WRITE] &&
382 o->min_bs[DDIR_READ] == o->min_bs[DDIR_TRIM];
385 static void init_rand_distribution(struct thread_data *td)
387 unsigned int range_size;
388 unsigned long nranges;
390 if (td->o.random_distribution == FIO_RAND_DIST_RANDOM)
393 range_size = min(td->o.min_bs[DDIR_READ], td->o.min_bs[DDIR_WRITE]);
395 nranges = (td->o.size + range_size - 1) / range_size;
397 if (td->o.random_distribution == FIO_RAND_DIST_ZIPF)
398 zipf_init(&td->zipf, nranges, td->o.zipf_theta);
400 pareto_init(&td->zipf, nranges, td->o.pareto_h);
404 * Lazy way of fixing up options that depend on each other. We could also
405 * define option callback handlers, but this is easier.
407 static int fixup_options(struct thread_data *td)
409 struct thread_options *o = &td->o;
412 #ifndef FIO_HAVE_PSHARED_MUTEX
413 if (!o->use_thread) {
414 log_info("fio: this platform does not support process shared"
415 " mutexes, forcing use of threads. Use the 'thread'"
416 " option to get rid of this warning.\n");
418 ret = warnings_fatal;
422 if (o->write_iolog_file && o->read_iolog_file) {
423 log_err("fio: read iolog overrides write_iolog\n");
424 free(o->write_iolog_file);
425 o->write_iolog_file = NULL;
426 ret = warnings_fatal;
430 * only really works with 1 file
432 if (o->zone_size && o->open_files == 1)
436 * If zone_range isn't specified, backward compatibility dictates it
437 * should be made equal to zone_size.
439 if (o->zone_size && !o->zone_range)
440 o->zone_range = o->zone_size;
443 * Reads can do overwrites, we always need to pre-create the file
445 if (td_read(td) || td_rw(td))
448 if (!o->min_bs[DDIR_READ])
449 o->min_bs[DDIR_READ] = o->bs[DDIR_READ];
450 if (!o->max_bs[DDIR_READ])
451 o->max_bs[DDIR_READ] = o->bs[DDIR_READ];
452 if (!o->min_bs[DDIR_WRITE])
453 o->min_bs[DDIR_WRITE] = o->bs[DDIR_WRITE];
454 if (!o->max_bs[DDIR_WRITE])
455 o->max_bs[DDIR_WRITE] = o->bs[DDIR_WRITE];
456 if (!o->min_bs[DDIR_TRIM])
457 o->min_bs[DDIR_TRIM] = o->bs[DDIR_TRIM];
458 if (!o->max_bs[DDIR_TRIM])
459 o->max_bs[DDIR_TRIM] = o->bs[DDIR_TRIM];
462 o->rw_min_bs = min(o->min_bs[DDIR_READ], o->min_bs[DDIR_WRITE]);
463 o->rw_min_bs = min(o->min_bs[DDIR_TRIM], o->rw_min_bs);
466 * For random IO, allow blockalign offset other than min_bs.
468 if (!o->ba[DDIR_READ] || !td_random(td))
469 o->ba[DDIR_READ] = o->min_bs[DDIR_READ];
470 if (!o->ba[DDIR_WRITE] || !td_random(td))
471 o->ba[DDIR_WRITE] = o->min_bs[DDIR_WRITE];
472 if (!o->ba[DDIR_TRIM] || !td_random(td))
473 o->ba[DDIR_TRIM] = o->min_bs[DDIR_TRIM];
475 if ((o->ba[DDIR_READ] != o->min_bs[DDIR_READ] ||
476 o->ba[DDIR_WRITE] != o->min_bs[DDIR_WRITE] ||
477 o->ba[DDIR_TRIM] != o->min_bs[DDIR_TRIM]) &&
479 log_err("fio: Any use of blockalign= turns off randommap\n");
481 ret = warnings_fatal;
484 if (!o->file_size_high)
485 o->file_size_high = o->file_size_low;
487 if (o->norandommap && o->verify != VERIFY_NONE
488 && !fixed_block_size(o)) {
489 log_err("fio: norandommap given for variable block sizes, "
490 "verify disabled\n");
491 o->verify = VERIFY_NONE;
492 ret = warnings_fatal;
494 if (o->bs_unaligned && (o->odirect || td->io_ops->flags & FIO_RAWIO))
495 log_err("fio: bs_unaligned may not work with raw io\n");
498 * thinktime_spin must be less than thinktime
500 if (o->thinktime_spin > o->thinktime)
501 o->thinktime_spin = o->thinktime;
504 * The low water mark cannot be bigger than the iodepth
506 if (o->iodepth_low > o->iodepth || !o->iodepth_low) {
508 * syslet work around - if the workload is sequential,
509 * we want to let the queue drain all the way down to
510 * avoid seeking between async threads
512 if (!strcmp(td->io_ops->name, "syslet-rw") && !td_random(td))
515 o->iodepth_low = o->iodepth;
519 * If batch number isn't set, default to the same as iodepth
521 if (o->iodepth_batch > o->iodepth || !o->iodepth_batch)
522 o->iodepth_batch = o->iodepth;
524 if (o->nr_files > td->files_index)
525 o->nr_files = td->files_index;
527 if (o->open_files > o->nr_files || !o->open_files)
528 o->open_files = o->nr_files;
530 if (((o->rate[DDIR_READ] + o->rate[DDIR_WRITE] + o->rate[DDIR_TRIM]) &&
531 (o->rate_iops[DDIR_READ] + o->rate_iops[DDIR_WRITE] + o->rate_iops[DDIR_TRIM])) ||
532 ((o->ratemin[DDIR_READ] + o->ratemin[DDIR_WRITE] + o->ratemin[DDIR_TRIM]) &&
533 (o->rate_iops_min[DDIR_READ] + o->rate_iops_min[DDIR_WRITE] + o->rate_iops_min[DDIR_TRIM]))) {
534 log_err("fio: rate and rate_iops are mutually exclusive\n");
537 if ((o->rate[DDIR_READ] < o->ratemin[DDIR_READ]) ||
538 (o->rate[DDIR_WRITE] < o->ratemin[DDIR_WRITE]) ||
539 (o->rate[DDIR_TRIM] < o->ratemin[DDIR_TRIM]) ||
540 (o->rate_iops[DDIR_READ] < o->rate_iops_min[DDIR_READ]) ||
541 (o->rate_iops[DDIR_WRITE] < o->rate_iops_min[DDIR_WRITE]) ||
542 (o->rate_iops[DDIR_TRIM] < o->rate_iops_min[DDIR_TRIM])) {
543 log_err("fio: minimum rate exceeds rate\n");
547 if (!o->timeout && o->time_based) {
548 log_err("fio: time_based requires a runtime/timeout setting\n");
550 ret = warnings_fatal;
553 if (o->fill_device && !o->size)
556 if (o->verify != VERIFY_NONE) {
557 if (td_write(td) && o->do_verify && o->numjobs > 1) {
558 log_info("Multiple writers may overwrite blocks that "
559 "belong to other jobs. This can cause "
560 "verification failures.\n");
561 ret = warnings_fatal;
564 o->refill_buffers = 1;
565 if (o->max_bs[DDIR_WRITE] != o->min_bs[DDIR_WRITE] &&
567 o->verify_interval = o->min_bs[DDIR_WRITE];
571 o->invalidate_cache = 0;
572 if (td->io_ops->flags & FIO_PIPEIO) {
573 log_info("fio: cannot pre-read files with an IO engine"
574 " that isn't seekable. Pre-read disabled.\n");
575 ret = warnings_fatal;
579 #ifndef FIO_HAVE_FDATASYNC
580 if (o->fdatasync_blocks) {
581 log_info("fio: this platform does not support fdatasync()"
582 " falling back to using fsync(). Use the 'fsync'"
583 " option instead of 'fdatasync' to get rid of"
585 o->fsync_blocks = o->fdatasync_blocks;
586 o->fdatasync_blocks = 0;
587 ret = warnings_fatal;
593 * Windows doesn't support O_DIRECT or O_SYNC with the _open interface,
594 * so fail if we're passed those flags
596 if ((td->io_ops->flags & FIO_SYNCIO) && (td->o.odirect || td->o.sync_io)) {
597 log_err("fio: Windows does not support direct or non-buffered io with"
598 " the synchronous ioengines. Use the 'windowsaio' ioengine"
599 " with 'direct=1' and 'iodepth=1' instead.\n");
605 * For fully compressible data, just zero them at init time.
606 * It's faster than repeatedly filling it.
608 if (td->o.compress_percentage == 100) {
609 td->o.zero_buffers = 1;
610 td->o.compress_percentage = 0;
613 init_rand_distribution(td);
619 * This function leaks the buffer
621 static char *to_kmg(unsigned int val)
623 char *buf = malloc(32);
624 char post[] = { 0, 'K', 'M', 'G', 'P', 'E', 0 };
635 snprintf(buf, 31, "%u%c", val, *p);
639 /* External engines are specified by "external:name.o") */
640 static const char *get_engine_name(const char *str)
642 char *p = strstr(str, ":");
648 strip_blank_front(&p);
653 static int exists_and_not_file(const char *filename)
657 if (lstat(filename, &sb) == -1)
660 /* \\.\ is the device namespace in Windows, where every file
661 * is a device node */
662 if (S_ISREG(sb.st_mode) && strncmp(filename, "\\\\.\\", 4) != 0)
668 static void td_fill_rand_seeds_os(struct thread_data *td)
670 os_random_seed(td->rand_seeds[0], &td->bsrange_state);
671 os_random_seed(td->rand_seeds[1], &td->verify_state);
672 os_random_seed(td->rand_seeds[2], &td->rwmix_state);
674 if (td->o.file_service_type == FIO_FSERVICE_RANDOM)
675 os_random_seed(td->rand_seeds[3], &td->next_file_state);
677 os_random_seed(td->rand_seeds[5], &td->file_size_state);
678 os_random_seed(td->rand_seeds[6], &td->trim_state);
683 if (td->o.rand_repeatable)
684 td->rand_seeds[4] = FIO_RANDSEED * td->thread_number;
686 os_random_seed(td->rand_seeds[4], &td->random_state);
689 static void td_fill_rand_seeds_internal(struct thread_data *td)
691 init_rand_seed(&td->__bsrange_state, td->rand_seeds[0]);
692 init_rand_seed(&td->__verify_state, td->rand_seeds[1]);
693 init_rand_seed(&td->__rwmix_state, td->rand_seeds[2]);
695 if (td->o.file_service_type == FIO_FSERVICE_RANDOM)
696 init_rand_seed(&td->__next_file_state, td->rand_seeds[3]);
698 init_rand_seed(&td->__file_size_state, td->rand_seeds[5]);
699 init_rand_seed(&td->__trim_state, td->rand_seeds[6]);
704 if (td->o.rand_repeatable)
705 td->rand_seeds[4] = FIO_RANDSEED * td->thread_number;
707 init_rand_seed(&td->__random_state, td->rand_seeds[4]);
710 void td_fill_rand_seeds(struct thread_data *td)
712 if (td->o.use_os_rand)
713 td_fill_rand_seeds_os(td);
715 td_fill_rand_seeds_internal(td);
717 init_rand_seed(&td->buf_state, td->rand_seeds[7]);
722 * Initializes the ioengine configured for a job, if it has not been done so
725 int ioengine_load(struct thread_data *td)
730 * Engine has already been loaded.
735 engine = get_engine_name(td->o.ioengine);
736 td->io_ops = load_ioengine(td, engine);
738 log_err("fio: failed to load engine %s\n", engine);
742 if (td->io_ops->option_struct_size && td->io_ops->options) {
744 * In cases where td->eo is set, clone it for a child thread.
745 * This requires that the parent thread has the same ioengine,
746 * but that requirement must be enforced by the code which
749 void *origeo = td->eo;
751 * Otherwise use the default thread options.
753 if (!origeo && td != &def_thread && def_thread.eo &&
754 def_thread.io_ops->options == td->io_ops->options)
755 origeo = def_thread.eo;
757 options_init(td->io_ops->options);
758 td->eo = malloc(td->io_ops->option_struct_size);
760 * Use the default thread as an option template if this uses the
761 * same options structure and there are non-default options
765 memcpy(td->eo, origeo, td->io_ops->option_struct_size);
766 options_mem_dupe(td->eo, td->io_ops->options);
768 memset(td->eo, 0, td->io_ops->option_struct_size);
769 fill_default_options(td->eo, td->io_ops->options);
771 *(struct thread_data **)td->eo = td;
778 * Adds a job to the list of things todo. Sanitizes the various options
779 * to make sure we don't have conflicts, and initializes various
782 static int add_job(struct thread_data *td, const char *jobname, int job_add_num)
784 const char *ddir_str[] = { NULL, "read", "write", "rw", NULL,
785 "randread", "randwrite", "randrw",
786 "trim", NULL, NULL, NULL, "randtrim" };
788 char fname[PATH_MAX];
789 int numjobs, file_alloced;
792 * the def_thread is just for options, it's not a real job
794 if (td == &def_thread)
798 * if we are just dumping the output command line, don't add the job
805 if (profile_td_init(td))
808 if (ioengine_load(td))
811 if (td->o.use_thread)
817 td->io_ops->flags |= FIO_RAWIO;
820 if (!td->o.filename && !td->files_index && !td->o.read_iolog_file) {
823 if (td->o.nr_files == 1 && exists_and_not_file(jobname))
824 add_file(td, jobname);
826 for (i = 0; i < td->o.nr_files; i++) {
827 sprintf(fname, "%s.%d.%d", jobname,
828 td->thread_number, i);
834 if (fixup_options(td))
840 * IO engines only need this for option callbacks, and the address may
841 * change in subprocesses.
844 *(struct thread_data **)td->eo = NULL;
846 if (td->io_ops->flags & FIO_DISKLESSIO) {
849 for_each_file(td, f, i)
850 f->real_file_size = -1ULL;
853 td->mutex = fio_mutex_init(FIO_MUTEX_LOCKED);
855 td->ts.clat_percentiles = td->o.clat_percentiles;
856 if (td->o.overwrite_plist)
857 memcpy(td->ts.percentile_list, td->o.percentile_list, sizeof(td->o.percentile_list));
859 memcpy(td->ts.percentile_list, def_percentile_list, sizeof(def_percentile_list));
861 for (i = 0; i < DDIR_RWDIR_CNT; i++) {
862 td->ts.clat_stat[i].min_val = ULONG_MAX;
863 td->ts.slat_stat[i].min_val = ULONG_MAX;
864 td->ts.lat_stat[i].min_val = ULONG_MAX;
865 td->ts.bw_stat[i].min_val = ULONG_MAX;
867 td->ddir_seq_nr = td->o.ddir_seq_nr;
869 if ((td->o.stonewall || td->o.new_group) && prev_group_jobs) {
874 td->groupid = groupid;
877 if (init_random_state(td, td->rand_seeds, sizeof(td->rand_seeds))) {
878 td_verror(td, errno, "init_random_state");
885 if (td->o.write_lat_log) {
886 setup_log(&td->lat_log, td->o.log_avg_msec);
887 setup_log(&td->slat_log, td->o.log_avg_msec);
888 setup_log(&td->clat_log, td->o.log_avg_msec);
890 if (td->o.write_bw_log)
891 setup_log(&td->bw_log, td->o.log_avg_msec);
892 if (td->o.write_iops_log)
893 setup_log(&td->iops_log, td->o.log_avg_msec);
896 td->o.name = strdup(jobname);
898 if (output_format == FIO_OUTPUT_NORMAL) {
900 if (!strcmp(td->io_ops->name, "cpuio")) {
901 log_info("%s: ioengine=cpu, cpuload=%u,"
902 " cpucycle=%u\n", td->o.name,
906 char *c1, *c2, *c3, *c4, *c5, *c6;
908 c1 = to_kmg(td->o.min_bs[DDIR_READ]);
909 c2 = to_kmg(td->o.max_bs[DDIR_READ]);
910 c3 = to_kmg(td->o.min_bs[DDIR_WRITE]);
911 c4 = to_kmg(td->o.max_bs[DDIR_WRITE]);
912 c5 = to_kmg(td->o.min_bs[DDIR_TRIM]);
913 c6 = to_kmg(td->o.max_bs[DDIR_TRIM]);
915 log_info("%s: (g=%d): rw=%s, bs=%s-%s/%s-%s/%s-%s,"
916 " ioengine=%s, iodepth=%u\n",
917 td->o.name, td->groupid,
918 ddir_str[td->o.td_ddir],
919 c1, c2, c3, c4, c5, c6,
930 } else if (job_add_num == 1)
935 * recurse add identical jobs, clear numjobs and stonewall options
936 * as they don't apply to sub-jobs
938 numjobs = td->o.numjobs;
940 struct thread_data *td_new = get_new_job(0, td, 1);
945 td_new->o.numjobs = 1;
946 td_new->o.stonewall = 0;
947 td_new->o.new_group = 0;
950 td_new->o.filename = NULL;
951 td_new->files_index = 0;
952 td_new->files_size = 0;
953 td_new->files = NULL;
956 job_add_num = numjobs - 1;
958 if (add_job(td_new, jobname, job_add_num))
969 * Parse as if 'o' was a command line
971 void add_job_opts(const char **o)
973 struct thread_data *td, *td_parent;
974 int i, in_global = 1;
978 td_parent = td = NULL;
980 if (!strncmp(o[i], "name", 4)) {
983 add_job(td, jobname, 0);
985 sprintf(jobname, "%s", o[i] + 5);
987 if (in_global && !td_parent)
988 td_parent = get_new_job(1, &def_thread, 0);
989 else if (!in_global && !td) {
991 td_parent = &def_thread;
992 td = get_new_job(0, td_parent, 0);
995 fio_options_parse(td_parent, (char **) &o[i], 1);
997 fio_options_parse(td, (char **) &o[i], 1);
1002 add_job(td, jobname, 0);
1005 static int skip_this_section(const char *name)
1009 if (!nr_job_sections)
1011 if (!strncmp(name, "global", 6))
1014 for (i = 0; i < nr_job_sections; i++)
1015 if (!strcmp(job_sections[i], name))
1021 static int is_empty_or_comment(char *line)
1025 for (i = 0; i < strlen(line); i++) {
1030 if (!isspace((int) line[i]) && !iscntrl((int) line[i]))
1038 * This is our [ini] type file parser.
1040 int parse_jobs_ini(char *file, int is_buf, int stonewall_flag)
1042 unsigned int global;
1043 struct thread_data *td;
1044 char *string, *name;
1047 int ret = 0, stonewall;
1050 int inside_skip = 0;
1052 int i, alloc_opts, num_opts;
1057 if (!strcmp(file, "-"))
1060 f = fopen(file, "r");
1063 perror("fopen job file");
1068 string = malloc(4096);
1071 * it's really 256 + small bit, 280 should suffice
1074 memset(name, 0, 280);
1077 opts = malloc(sizeof(char *) * alloc_opts);
1080 stonewall = stonewall_flag;
1083 * if skip_fgets is set, we already have loaded a line we
1088 p = strsep(&file, "\n");
1090 p = fgets(string, 4096, f);
1096 strip_blank_front(&p);
1099 if (is_empty_or_comment(p))
1101 if (sscanf(p, "[%255[^\n]]", name) != 1) {
1104 log_err("fio: option <%s> outside of [] job section\n",
1109 name[strlen(name) - 1] = '\0';
1111 if (skip_this_section(name)) {
1117 global = !strncmp(name, "global", 6);
1123 log_info("--name=%s ", name);
1127 td = get_new_job(global, &def_thread, 0);
1134 * Seperate multiple job files by a stonewall
1136 if (!global && stonewall) {
1137 td->o.stonewall = stonewall;
1142 memset(opts, 0, alloc_opts * sizeof(char *));
1146 p = strsep(&file, "\n");
1148 p = fgets(string, 4096, f);
1152 if (is_empty_or_comment(p))
1155 strip_blank_front(&p);
1158 * new section, break out and make sure we don't
1159 * fgets() a new line at the top.
1168 if (num_opts == alloc_opts) {
1170 opts = realloc(opts,
1171 alloc_opts * sizeof(char *));
1174 opts[num_opts] = strdup(p);
1178 ret = fio_options_parse(td, opts, num_opts);
1181 for (i = 0; i < num_opts; i++)
1182 log_info("--%s ", opts[i]);
1184 ret = add_job(td, name, 0);
1186 log_err("fio: job %s dropped\n", name);
1190 for (i = 0; i < num_opts; i++)
1199 while (i < nr_job_sections) {
1200 free(job_sections[i]);
1204 for (i = 0; i < num_opts; i++)
1210 if (!is_buf && f != stdin)
1215 static int fill_def_thread(void)
1217 memset(&def_thread, 0, sizeof(def_thread));
1219 fio_getaffinity(getpid(), &def_thread.o.cpumask);
1220 def_thread.o.timeout = def_timeout;
1221 def_thread.o.error_dump = 1;
1223 * fill default options
1225 fio_fill_default_options(&def_thread);
1229 static void usage(const char *name)
1231 printf("%s\n", fio_version_string);
1232 printf("%s [options] [job options] <job file(s)>\n", name);
1233 printf(" --debug=options\tEnable debug logging. May be one/more of:\n"
1234 "\t\t\tprocess,file,io,mem,blktrace,verify,random,parse,\n"
1235 "\t\t\tdiskutil,job,mutex,profile,time,net\n");
1236 printf(" --output\t\tWrite output to file\n");
1237 printf(" --runtime\t\tRuntime in seconds\n");
1238 printf(" --latency-log\t\tGenerate per-job latency logs\n");
1239 printf(" --bandwidth-log\tGenerate per-job bandwidth logs\n");
1240 printf(" --minimal\t\tMinimal (terse) output\n");
1241 printf(" --output-format=x\tOutput format (terse,json,normal)\n");
1242 printf(" --terse-version=x\tSet terse version output format to 'x'\n");
1243 printf(" --version\t\tPrint version info and exit\n");
1244 printf(" --help\t\tPrint this page\n");
1245 printf(" --cmdhelp=cmd\t\tPrint command help, \"all\" for all of"
1247 printf(" --enghelp=engine\tPrint ioengine help, or list"
1248 " available ioengines\n");
1249 printf(" --enghelp=engine,cmd\tPrint help for an ioengine"
1251 printf(" --showcmd\t\tTurn a job file into command line options\n");
1252 printf(" --eta=when\t\tWhen ETA estimate should be printed\n");
1253 printf(" \t\tMay be \"always\", \"never\" or \"auto\"\n");
1254 printf(" --readonly\t\tTurn on safety read-only checks, preventing"
1256 printf(" --section=name\tOnly run specified section in job file\n");
1257 printf(" --alloc-size=kb\tSet smalloc pool to this size in kb"
1259 printf(" --warnings-fatal\tFio parser warnings are fatal\n");
1260 printf(" --max-jobs=nr\t\tMaximum number of threads/processes to support\n");
1261 printf(" --server=args\t\tStart a backend fio server\n");
1262 printf(" --daemonize=pidfile\tBackground fio server, write pid to file\n");
1263 printf(" --client=hostname\tTalk to remote backend fio server at hostname\n");
1264 printf("\nFio was written by Jens Axboe <jens.axboe@oracle.com>");
1265 printf("\n Jens Axboe <jaxboe@fusionio.com>\n");
1268 #ifdef FIO_INC_DEBUG
1269 struct debug_level debug_levels[] = {
1270 { .name = "process", .shift = FD_PROCESS, },
1271 { .name = "file", .shift = FD_FILE, },
1272 { .name = "io", .shift = FD_IO, },
1273 { .name = "mem", .shift = FD_MEM, },
1274 { .name = "blktrace", .shift = FD_BLKTRACE },
1275 { .name = "verify", .shift = FD_VERIFY },
1276 { .name = "random", .shift = FD_RANDOM },
1277 { .name = "parse", .shift = FD_PARSE },
1278 { .name = "diskutil", .shift = FD_DISKUTIL },
1279 { .name = "job", .shift = FD_JOB },
1280 { .name = "mutex", .shift = FD_MUTEX },
1281 { .name = "profile", .shift = FD_PROFILE },
1282 { .name = "time", .shift = FD_TIME },
1283 { .name = "net", .shift = FD_NET },
1287 static int set_debug(const char *string)
1289 struct debug_level *dl;
1290 char *p = (char *) string;
1294 if (!strcmp(string, "?") || !strcmp(string, "help")) {
1295 log_info("fio: dumping debug options:");
1296 for (i = 0; debug_levels[i].name; i++) {
1297 dl = &debug_levels[i];
1298 log_info("%s,", dl->name);
1304 while ((opt = strsep(&p, ",")) != NULL) {
1307 if (!strncmp(opt, "all", 3)) {
1308 log_info("fio: set all debug options\n");
1313 for (i = 0; debug_levels[i].name; i++) {
1314 dl = &debug_levels[i];
1315 found = !strncmp(opt, dl->name, strlen(dl->name));
1319 if (dl->shift == FD_JOB) {
1320 opt = strchr(opt, ':');
1322 log_err("fio: missing job number\n");
1326 fio_debug_jobno = atoi(opt);
1327 log_info("fio: set debug jobno %d\n",
1330 log_info("fio: set debug option %s\n", opt);
1331 fio_debug |= (1UL << dl->shift);
1337 log_err("fio: debug mask %s not found\n", opt);
1342 static int set_debug(const char *string)
1344 log_err("fio: debug tracing not included in build\n");
1349 static void fio_options_fill_optstring(void)
1351 char *ostr = cmd_optstr;
1355 while (l_opts[i].name) {
1356 ostr[c++] = l_opts[i].val;
1357 if (l_opts[i].has_arg == required_argument)
1359 else if (l_opts[i].has_arg == optional_argument) {
1368 static int client_flag_set(char c)
1373 while (l_opts[i].name) {
1374 int val = l_opts[i].val;
1376 if (c == (val & 0xff))
1377 return (val & FIO_CLIENT_FLAG);
1385 void parse_cmd_client(void *client, char *opt)
1387 fio_client_add_cmd_option(client, opt);
1390 int parse_cmd_line(int argc, char *argv[])
1392 struct thread_data *td = NULL;
1393 int c, ini_idx = 0, lidx, ret = 0, do_exit = 0, exit_val = 0;
1394 char *ostr = cmd_optstr;
1395 void *pid_file = NULL;
1396 void *cur_client = NULL;
1400 * Reset optind handling, since we may call this multiple times
1405 while ((c = getopt_long_only(argc, argv, ostr, l_opts, &lidx)) != -1) {
1408 if ((c & FIO_CLIENT_FLAG) || client_flag_set(c)) {
1409 parse_cmd_client(cur_client, argv[optind - 1]);
1410 c &= ~FIO_CLIENT_FLAG;
1415 smalloc_pool_size = atoi(optarg);
1418 def_timeout = atoi(optarg);
1427 f_out = fopen(optarg, "w+");
1429 perror("fopen output");
1435 output_format = FIO_OUTPUT_TERSE;
1438 if (!strcmp(optarg, "minimal") ||
1439 !strcmp(optarg, "terse") ||
1440 !strcmp(optarg, "csv"))
1441 output_format = FIO_OUTPUT_TERSE;
1442 else if (!strcmp(optarg, "json"))
1443 output_format = FIO_OUTPUT_JSON;
1445 output_format = FIO_OUTPUT_NORMAL;
1455 fio_show_option_help(optarg);
1461 fio_show_ioengine_help(optarg);
1473 log_info("%s\n", fio_version_string);
1478 terse_version = atoi(optarg);
1479 if (!(terse_version == 2 || terse_version == 3 ||
1480 terse_version == 4)) {
1481 log_err("fio: bad terse version format\n");
1487 if (!strcmp("always", optarg))
1488 eta_print = FIO_ETA_ALWAYS;
1489 else if (!strcmp("never", optarg))
1490 eta_print = FIO_ETA_NEVER;
1493 if (set_debug(optarg))
1499 if (!strcmp(optarg, "global")) {
1500 log_err("fio: can't use global as only "
1506 new_size = (nr_job_sections + 1) * sizeof(char *);
1507 job_sections = realloc(job_sections, new_size);
1508 job_sections[nr_job_sections] = strdup(optarg);
1513 exec_profile = strdup(optarg);
1515 case FIO_GETOPT_JOB: {
1516 const char *opt = l_opts[lidx].name;
1519 if (!strncmp(opt, "name", 4) && td) {
1520 ret = add_job(td, td->o.name ?: "fio", 0);
1526 int is_section = !strncmp(opt, "name", 4);
1529 if (!is_section || !strncmp(val, "global", 6))
1532 if (is_section && skip_this_section(val))
1535 td = get_new_job(global, &def_thread, 1);
1536 if (!td || ioengine_load(td))
1538 fio_options_set_ioengine_opts(l_opts, td);
1541 ret = fio_cmd_option_parse(td, opt, val);
1543 if (!ret && !strcmp(opt, "ioengine")) {
1545 if (ioengine_load(td))
1547 fio_options_set_ioengine_opts(l_opts, td);
1551 case FIO_GETOPT_IOENGINE: {
1552 const char *opt = l_opts[lidx].name;
1554 opt = l_opts[lidx].name;
1556 ret = fio_cmd_ioengine_option_parse(td, opt, val);
1563 max_jobs = atoi(optarg);
1564 if (!max_jobs || max_jobs > REAL_MAX_JOBS) {
1565 log_err("fio: invalid max jobs: %d\n", max_jobs);
1572 log_err("fio: can't be both client and server\n");
1578 fio_server_set_arg(optarg);
1583 pid_file = strdup(optarg);
1587 log_err("fio: can't be both client and server\n");
1592 if (fio_client_add(optarg, &cur_client)) {
1593 log_err("fio: failed adding client %s\n", optarg);
1599 * If the next argument exists and isn't an option,
1600 * assume it's a job file for this client only.
1602 while (optind < argc) {
1603 if (!strncmp(argv[optind], "--", 2) ||
1604 !strncmp(argv[optind], "-", 1))
1607 fio_client_add_ini_file(cur_client, argv[optind]);
1621 if (exit_val && !(is_backend || nr_clients))
1625 if (nr_clients && fio_clients_connect()) {
1631 if (is_backend && backend)
1632 return fio_start_server(pid_file);
1636 ret = add_job(td, td->o.name ?: "fio", 0);
1639 while (!ret && optind < argc) {
1641 ini_file = realloc(ini_file, ini_idx * sizeof(char *));
1642 ini_file[ini_idx - 1] = strdup(argv[optind]);
1649 int parse_options(int argc, char *argv[])
1656 fio_options_fill_optstring();
1657 fio_options_dup_and_init(l_opts);
1661 if (fill_def_thread())
1664 job_files = parse_cmd_line(argc, argv);
1666 if (job_files > 0) {
1667 for (i = 0; i < job_files; i++) {
1668 if (fill_def_thread())
1671 if (fio_clients_send_ini(ini_file[i]))
1674 } else if (!is_backend) {
1675 if (parse_jobs_ini(ini_file[i], 0, i))
1680 } else if (nr_clients) {
1681 if (fill_def_thread())
1683 if (fio_clients_send_ini(NULL))
1688 fio_options_free(&def_thread);
1690 if (!thread_number) {
1695 if (is_backend || nr_clients)
1700 log_err("No jobs(s) defined\n\n");
1710 if (def_thread.o.gtod_offload) {
1712 fio_gtod_offload = 1;
1713 fio_gtod_cpu = def_thread.o.gtod_cpu;
1716 if (output_format == FIO_OUTPUT_NORMAL)
1717 log_info("%s\n", fio_version_string);