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];
386 * Lazy way of fixing up options that depend on each other. We could also
387 * define option callback handlers, but this is easier.
389 static int fixup_options(struct thread_data *td)
391 struct thread_options *o = &td->o;
394 #ifndef FIO_HAVE_PSHARED_MUTEX
395 if (!o->use_thread) {
396 log_info("fio: this platform does not support process shared"
397 " mutexes, forcing use of threads. Use the 'thread'"
398 " option to get rid of this warning.\n");
400 ret = warnings_fatal;
404 if (o->write_iolog_file && o->read_iolog_file) {
405 log_err("fio: read iolog overrides write_iolog\n");
406 free(o->write_iolog_file);
407 o->write_iolog_file = NULL;
408 ret = warnings_fatal;
412 * only really works with 1 file
414 if (o->zone_size && o->open_files == 1)
418 * If zone_range isn't specified, backward compatibility dictates it
419 * should be made equal to zone_size.
421 if (o->zone_size && !o->zone_range)
422 o->zone_range = o->zone_size;
425 * Reads can do overwrites, we always need to pre-create the file
427 if (td_read(td) || td_rw(td))
430 if (!o->min_bs[DDIR_READ])
431 o->min_bs[DDIR_READ] = o->bs[DDIR_READ];
432 if (!o->max_bs[DDIR_READ])
433 o->max_bs[DDIR_READ] = o->bs[DDIR_READ];
434 if (!o->min_bs[DDIR_WRITE])
435 o->min_bs[DDIR_WRITE] = o->bs[DDIR_WRITE];
436 if (!o->max_bs[DDIR_WRITE])
437 o->max_bs[DDIR_WRITE] = o->bs[DDIR_WRITE];
438 if (!o->min_bs[DDIR_TRIM])
439 o->min_bs[DDIR_TRIM] = o->bs[DDIR_TRIM];
440 if (!o->max_bs[DDIR_TRIM])
441 o->max_bs[DDIR_TRIM] = o->bs[DDIR_TRIM];
444 o->rw_min_bs = min(o->min_bs[DDIR_READ], o->min_bs[DDIR_WRITE]);
445 o->rw_min_bs = min(o->min_bs[DDIR_TRIM], o->rw_min_bs);
448 * For random IO, allow blockalign offset other than min_bs.
450 if (!o->ba[DDIR_READ] || !td_random(td))
451 o->ba[DDIR_READ] = o->min_bs[DDIR_READ];
452 if (!o->ba[DDIR_WRITE] || !td_random(td))
453 o->ba[DDIR_WRITE] = o->min_bs[DDIR_WRITE];
454 if (!o->ba[DDIR_TRIM] || !td_random(td))
455 o->ba[DDIR_TRIM] = o->min_bs[DDIR_TRIM];
457 if ((o->ba[DDIR_READ] != o->min_bs[DDIR_READ] ||
458 o->ba[DDIR_WRITE] != o->min_bs[DDIR_WRITE] ||
459 o->ba[DDIR_TRIM] != o->min_bs[DDIR_TRIM]) &&
461 log_err("fio: Any use of blockalign= turns off randommap\n");
463 ret = warnings_fatal;
466 if (!o->file_size_high)
467 o->file_size_high = o->file_size_low;
469 if (o->norandommap && o->verify != VERIFY_NONE
470 && !fixed_block_size(o)) {
471 log_err("fio: norandommap given for variable block sizes, "
472 "verify disabled\n");
473 o->verify = VERIFY_NONE;
474 ret = warnings_fatal;
476 if (o->bs_unaligned && (o->odirect || td->io_ops->flags & FIO_RAWIO))
477 log_err("fio: bs_unaligned may not work with raw io\n");
480 * thinktime_spin must be less than thinktime
482 if (o->thinktime_spin > o->thinktime)
483 o->thinktime_spin = o->thinktime;
486 * The low water mark cannot be bigger than the iodepth
488 if (o->iodepth_low > o->iodepth || !o->iodepth_low) {
490 * syslet work around - if the workload is sequential,
491 * we want to let the queue drain all the way down to
492 * avoid seeking between async threads
494 if (!strcmp(td->io_ops->name, "syslet-rw") && !td_random(td))
497 o->iodepth_low = o->iodepth;
501 * If batch number isn't set, default to the same as iodepth
503 if (o->iodepth_batch > o->iodepth || !o->iodepth_batch)
504 o->iodepth_batch = o->iodepth;
506 if (o->nr_files > td->files_index)
507 o->nr_files = td->files_index;
509 if (o->open_files > o->nr_files || !o->open_files)
510 o->open_files = o->nr_files;
512 if (((o->rate[DDIR_READ] + o->rate[DDIR_WRITE] + o->rate[DDIR_TRIM]) &&
513 (o->rate_iops[DDIR_READ] + o->rate_iops[DDIR_WRITE] + o->rate_iops[DDIR_TRIM])) ||
514 ((o->ratemin[DDIR_READ] + o->ratemin[DDIR_WRITE] + o->ratemin[DDIR_TRIM]) &&
515 (o->rate_iops_min[DDIR_READ] + o->rate_iops_min[DDIR_WRITE] + o->rate_iops_min[DDIR_TRIM]))) {
516 log_err("fio: rate and rate_iops are mutually exclusive\n");
519 if ((o->rate[DDIR_READ] < o->ratemin[DDIR_READ]) ||
520 (o->rate[DDIR_WRITE] < o->ratemin[DDIR_WRITE]) ||
521 (o->rate[DDIR_TRIM] < o->ratemin[DDIR_TRIM]) ||
522 (o->rate_iops[DDIR_READ] < o->rate_iops_min[DDIR_READ]) ||
523 (o->rate_iops[DDIR_WRITE] < o->rate_iops_min[DDIR_WRITE]) ||
524 (o->rate_iops[DDIR_TRIM] < o->rate_iops_min[DDIR_TRIM])) {
525 log_err("fio: minimum rate exceeds rate\n");
529 if (!o->timeout && o->time_based) {
530 log_err("fio: time_based requires a runtime/timeout setting\n");
532 ret = warnings_fatal;
535 if (o->fill_device && !o->size)
538 if (o->verify != VERIFY_NONE) {
539 if (td_write(td) && o->do_verify && o->numjobs > 1) {
540 log_info("Multiple writers may overwrite blocks that "
541 "belong to other jobs. This can cause "
542 "verification failures.\n");
543 ret = warnings_fatal;
546 o->refill_buffers = 1;
547 if (o->max_bs[DDIR_WRITE] != o->min_bs[DDIR_WRITE] &&
549 o->verify_interval = o->min_bs[DDIR_WRITE];
553 o->invalidate_cache = 0;
554 if (td->io_ops->flags & FIO_PIPEIO) {
555 log_info("fio: cannot pre-read files with an IO engine"
556 " that isn't seekable. Pre-read disabled.\n");
557 ret = warnings_fatal;
561 #ifndef FIO_HAVE_FDATASYNC
562 if (o->fdatasync_blocks) {
563 log_info("fio: this platform does not support fdatasync()"
564 " falling back to using fsync(). Use the 'fsync'"
565 " option instead of 'fdatasync' to get rid of"
567 o->fsync_blocks = o->fdatasync_blocks;
568 o->fdatasync_blocks = 0;
569 ret = warnings_fatal;
575 * Windows doesn't support O_DIRECT or O_SYNC with the _open interface,
576 * so fail if we're passed those flags
578 if ((td->io_ops->flags & FIO_SYNCIO) && (td->o.odirect || td->o.sync_io)) {
579 log_err("fio: Windows does not support direct or non-buffered io with"
580 " the synchronous ioengines. Use the 'windowsaio' ioengine"
581 " with 'direct=1' and 'iodepth=1' instead.\n");
587 * For fully compressible data, just zero them at init time.
588 * It's faster than repeatedly filling it.
590 if (td->o.compress_percentage == 100) {
591 td->o.zero_buffers = 1;
592 td->o.compress_percentage = 0;
599 * This function leaks the buffer
601 static char *to_kmg(unsigned int val)
603 char *buf = malloc(32);
604 char post[] = { 0, 'K', 'M', 'G', 'P', 'E', 0 };
615 snprintf(buf, 31, "%u%c", val, *p);
619 /* External engines are specified by "external:name.o") */
620 static const char *get_engine_name(const char *str)
622 char *p = strstr(str, ":");
628 strip_blank_front(&p);
633 static int exists_and_not_file(const char *filename)
637 if (lstat(filename, &sb) == -1)
640 /* \\.\ is the device namespace in Windows, where every file
641 * is a device node */
642 if (S_ISREG(sb.st_mode) && strncmp(filename, "\\\\.\\", 4) != 0)
648 static void td_fill_rand_seeds_os(struct thread_data *td)
650 os_random_seed(td->rand_seeds[0], &td->bsrange_state);
651 os_random_seed(td->rand_seeds[1], &td->verify_state);
652 os_random_seed(td->rand_seeds[2], &td->rwmix_state);
654 if (td->o.file_service_type == FIO_FSERVICE_RANDOM)
655 os_random_seed(td->rand_seeds[3], &td->next_file_state);
657 os_random_seed(td->rand_seeds[5], &td->file_size_state);
658 os_random_seed(td->rand_seeds[6], &td->trim_state);
663 if (td->o.rand_repeatable)
664 td->rand_seeds[4] = FIO_RANDSEED * td->thread_number;
666 os_random_seed(td->rand_seeds[4], &td->random_state);
669 static void td_fill_rand_seeds_internal(struct thread_data *td)
671 init_rand_seed(&td->__bsrange_state, td->rand_seeds[0]);
672 init_rand_seed(&td->__verify_state, td->rand_seeds[1]);
673 init_rand_seed(&td->__rwmix_state, td->rand_seeds[2]);
675 if (td->o.file_service_type == FIO_FSERVICE_RANDOM)
676 init_rand_seed(&td->__next_file_state, td->rand_seeds[3]);
678 init_rand_seed(&td->__file_size_state, td->rand_seeds[5]);
679 init_rand_seed(&td->__trim_state, td->rand_seeds[6]);
684 if (td->o.rand_repeatable)
685 td->rand_seeds[4] = FIO_RANDSEED * td->thread_number;
687 init_rand_seed(&td->__random_state, td->rand_seeds[4]);
690 void td_fill_rand_seeds(struct thread_data *td)
692 if (td->o.use_os_rand)
693 td_fill_rand_seeds_os(td);
695 td_fill_rand_seeds_internal(td);
697 init_rand_seed(&td->buf_state, td->rand_seeds[7]);
702 * Initializes the ioengine configured for a job, if it has not been done so
705 int ioengine_load(struct thread_data *td)
710 * Engine has already been loaded.
715 engine = get_engine_name(td->o.ioengine);
716 td->io_ops = load_ioengine(td, engine);
718 log_err("fio: failed to load engine %s\n", engine);
722 if (td->io_ops->option_struct_size && td->io_ops->options) {
724 * In cases where td->eo is set, clone it for a child thread.
725 * This requires that the parent thread has the same ioengine,
726 * but that requirement must be enforced by the code which
729 void *origeo = td->eo;
731 * Otherwise use the default thread options.
733 if (!origeo && td != &def_thread && def_thread.eo &&
734 def_thread.io_ops->options == td->io_ops->options)
735 origeo = def_thread.eo;
737 options_init(td->io_ops->options);
738 td->eo = malloc(td->io_ops->option_struct_size);
740 * Use the default thread as an option template if this uses the
741 * same options structure and there are non-default options
745 memcpy(td->eo, origeo, td->io_ops->option_struct_size);
746 options_mem_dupe(td->eo, td->io_ops->options);
748 memset(td->eo, 0, td->io_ops->option_struct_size);
749 fill_default_options(td->eo, td->io_ops->options);
751 *(struct thread_data **)td->eo = td;
758 * Adds a job to the list of things todo. Sanitizes the various options
759 * to make sure we don't have conflicts, and initializes various
762 static int add_job(struct thread_data *td, const char *jobname, int job_add_num)
764 const char *ddir_str[] = { NULL, "read", "write", "rw", NULL,
765 "randread", "randwrite", "randrw",
766 "trim", NULL, NULL, NULL, "randtrim" };
768 char fname[PATH_MAX];
769 int numjobs, file_alloced;
772 * the def_thread is just for options, it's not a real job
774 if (td == &def_thread)
778 * if we are just dumping the output command line, don't add the job
785 if (profile_td_init(td))
788 if (ioengine_load(td))
791 if (td->o.use_thread)
797 td->io_ops->flags |= FIO_RAWIO;
800 if (!td->o.filename && !td->files_index && !td->o.read_iolog_file) {
803 if (td->o.nr_files == 1 && exists_and_not_file(jobname))
804 add_file(td, jobname);
806 for (i = 0; i < td->o.nr_files; i++) {
807 sprintf(fname, "%s.%d.%d", jobname,
808 td->thread_number, i);
814 if (fixup_options(td))
820 * IO engines only need this for option callbacks, and the address may
821 * change in subprocesses.
824 *(struct thread_data **)td->eo = NULL;
826 if (td->io_ops->flags & FIO_DISKLESSIO) {
829 for_each_file(td, f, i)
830 f->real_file_size = -1ULL;
833 td->mutex = fio_mutex_init(FIO_MUTEX_LOCKED);
835 td->ts.clat_percentiles = td->o.clat_percentiles;
836 if (td->o.overwrite_plist)
837 memcpy(td->ts.percentile_list, td->o.percentile_list, sizeof(td->o.percentile_list));
839 memcpy(td->ts.percentile_list, def_percentile_list, sizeof(def_percentile_list));
841 for (i = 0; i < DDIR_RWDIR_CNT; i++) {
842 td->ts.clat_stat[i].min_val = ULONG_MAX;
843 td->ts.slat_stat[i].min_val = ULONG_MAX;
844 td->ts.lat_stat[i].min_val = ULONG_MAX;
845 td->ts.bw_stat[i].min_val = ULONG_MAX;
847 td->ddir_seq_nr = td->o.ddir_seq_nr;
849 if ((td->o.stonewall || td->o.new_group) && prev_group_jobs) {
854 td->groupid = groupid;
857 if (init_random_state(td, td->rand_seeds, sizeof(td->rand_seeds))) {
858 td_verror(td, errno, "init_random_state");
865 if (td->o.write_lat_log) {
866 setup_log(&td->lat_log, td->o.log_avg_msec);
867 setup_log(&td->slat_log, td->o.log_avg_msec);
868 setup_log(&td->clat_log, td->o.log_avg_msec);
870 if (td->o.write_bw_log)
871 setup_log(&td->bw_log, td->o.log_avg_msec);
872 if (td->o.write_iops_log)
873 setup_log(&td->iops_log, td->o.log_avg_msec);
876 td->o.name = strdup(jobname);
878 if (output_format == FIO_OUTPUT_NORMAL) {
880 if (!strcmp(td->io_ops->name, "cpuio")) {
881 log_info("%s: ioengine=cpu, cpuload=%u,"
882 " cpucycle=%u\n", td->o.name,
886 char *c1, *c2, *c3, *c4, *c5, *c6;
888 c1 = to_kmg(td->o.min_bs[DDIR_READ]);
889 c2 = to_kmg(td->o.max_bs[DDIR_READ]);
890 c3 = to_kmg(td->o.min_bs[DDIR_WRITE]);
891 c4 = to_kmg(td->o.max_bs[DDIR_WRITE]);
892 c5 = to_kmg(td->o.min_bs[DDIR_TRIM]);
893 c6 = to_kmg(td->o.max_bs[DDIR_TRIM]);
895 log_info("%s: (g=%d): rw=%s, bs=%s-%s/%s-%s/%s-%s,"
896 " ioengine=%s, iodepth=%u\n",
897 td->o.name, td->groupid,
898 ddir_str[td->o.td_ddir],
899 c1, c2, c3, c4, c5, c6,
910 } else if (job_add_num == 1)
915 * recurse add identical jobs, clear numjobs and stonewall options
916 * as they don't apply to sub-jobs
918 numjobs = td->o.numjobs;
920 struct thread_data *td_new = get_new_job(0, td, 1);
925 td_new->o.numjobs = 1;
926 td_new->o.stonewall = 0;
927 td_new->o.new_group = 0;
930 td_new->o.filename = NULL;
931 td_new->files_index = 0;
932 td_new->files_size = 0;
933 td_new->files = NULL;
936 job_add_num = numjobs - 1;
938 if (add_job(td_new, jobname, job_add_num))
949 * Parse as if 'o' was a command line
951 void add_job_opts(const char **o)
953 struct thread_data *td, *td_parent;
954 int i, in_global = 1;
958 td_parent = td = NULL;
960 if (!strncmp(o[i], "name", 4)) {
963 add_job(td, jobname, 0);
965 sprintf(jobname, "%s", o[i] + 5);
967 if (in_global && !td_parent)
968 td_parent = get_new_job(1, &def_thread, 0);
969 else if (!in_global && !td) {
971 td_parent = &def_thread;
972 td = get_new_job(0, td_parent, 0);
975 fio_options_parse(td_parent, (char **) &o[i], 1);
977 fio_options_parse(td, (char **) &o[i], 1);
982 add_job(td, jobname, 0);
985 static int skip_this_section(const char *name)
989 if (!nr_job_sections)
991 if (!strncmp(name, "global", 6))
994 for (i = 0; i < nr_job_sections; i++)
995 if (!strcmp(job_sections[i], name))
1001 static int is_empty_or_comment(char *line)
1005 for (i = 0; i < strlen(line); i++) {
1010 if (!isspace((int) line[i]) && !iscntrl((int) line[i]))
1018 * This is our [ini] type file parser.
1020 int parse_jobs_ini(char *file, int is_buf, int stonewall_flag)
1022 unsigned int global;
1023 struct thread_data *td;
1024 char *string, *name;
1027 int ret = 0, stonewall;
1030 int inside_skip = 0;
1032 int i, alloc_opts, num_opts;
1037 if (!strcmp(file, "-"))
1040 f = fopen(file, "r");
1043 perror("fopen job file");
1048 string = malloc(4096);
1051 * it's really 256 + small bit, 280 should suffice
1054 memset(name, 0, 280);
1057 opts = malloc(sizeof(char *) * alloc_opts);
1060 stonewall = stonewall_flag;
1063 * if skip_fgets is set, we already have loaded a line we
1068 p = strsep(&file, "\n");
1070 p = fgets(string, 4096, f);
1076 strip_blank_front(&p);
1079 if (is_empty_or_comment(p))
1081 if (sscanf(p, "[%255[^\n]]", name) != 1) {
1084 log_err("fio: option <%s> outside of [] job section\n",
1089 name[strlen(name) - 1] = '\0';
1091 if (skip_this_section(name)) {
1097 global = !strncmp(name, "global", 6);
1103 log_info("--name=%s ", name);
1107 td = get_new_job(global, &def_thread, 0);
1114 * Seperate multiple job files by a stonewall
1116 if (!global && stonewall) {
1117 td->o.stonewall = stonewall;
1122 memset(opts, 0, alloc_opts * sizeof(char *));
1126 p = strsep(&file, "\n");
1128 p = fgets(string, 4096, f);
1132 if (is_empty_or_comment(p))
1135 strip_blank_front(&p);
1138 * new section, break out and make sure we don't
1139 * fgets() a new line at the top.
1148 if (num_opts == alloc_opts) {
1150 opts = realloc(opts,
1151 alloc_opts * sizeof(char *));
1154 opts[num_opts] = strdup(p);
1158 ret = fio_options_parse(td, opts, num_opts);
1161 for (i = 0; i < num_opts; i++)
1162 log_info("--%s ", opts[i]);
1164 ret = add_job(td, name, 0);
1166 log_err("fio: job %s dropped\n", name);
1170 for (i = 0; i < num_opts; i++)
1179 while (i < nr_job_sections) {
1180 free(job_sections[i]);
1184 for (i = 0; i < num_opts; i++)
1190 if (!is_buf && f != stdin)
1195 static int fill_def_thread(void)
1197 memset(&def_thread, 0, sizeof(def_thread));
1199 fio_getaffinity(getpid(), &def_thread.o.cpumask);
1200 def_thread.o.timeout = def_timeout;
1201 def_thread.o.error_dump = 1;
1203 * fill default options
1205 fio_fill_default_options(&def_thread);
1209 static void usage(const char *name)
1211 printf("%s\n", fio_version_string);
1212 printf("%s [options] [job options] <job file(s)>\n", name);
1213 printf(" --debug=options\tEnable debug logging. May be one/more of:\n"
1214 "\t\t\tprocess,file,io,mem,blktrace,verify,random,parse,\n"
1215 "\t\t\tdiskutil,job,mutex,profile,time,net\n");
1216 printf(" --output\t\tWrite output to file\n");
1217 printf(" --runtime\t\tRuntime in seconds\n");
1218 printf(" --latency-log\t\tGenerate per-job latency logs\n");
1219 printf(" --bandwidth-log\tGenerate per-job bandwidth logs\n");
1220 printf(" --minimal\t\tMinimal (terse) output\n");
1221 printf(" --output-format=x\tOutput format (terse,json,normal)\n");
1222 printf(" --terse-version=x\tSet terse version output format to 'x'\n");
1223 printf(" --version\t\tPrint version info and exit\n");
1224 printf(" --help\t\tPrint this page\n");
1225 printf(" --cmdhelp=cmd\t\tPrint command help, \"all\" for all of"
1227 printf(" --enghelp=engine\tPrint ioengine help, or list"
1228 " available ioengines\n");
1229 printf(" --enghelp=engine,cmd\tPrint help for an ioengine"
1231 printf(" --showcmd\t\tTurn a job file into command line options\n");
1232 printf(" --eta=when\t\tWhen ETA estimate should be printed\n");
1233 printf(" \t\tMay be \"always\", \"never\" or \"auto\"\n");
1234 printf(" --readonly\t\tTurn on safety read-only checks, preventing"
1236 printf(" --section=name\tOnly run specified section in job file\n");
1237 printf(" --alloc-size=kb\tSet smalloc pool to this size in kb"
1239 printf(" --warnings-fatal\tFio parser warnings are fatal\n");
1240 printf(" --max-jobs=nr\t\tMaximum number of threads/processes to support\n");
1241 printf(" --server=args\t\tStart a backend fio server\n");
1242 printf(" --daemonize=pidfile\tBackground fio server, write pid to file\n");
1243 printf(" --client=hostname\tTalk to remote backend fio server at hostname\n");
1244 printf("\nFio was written by Jens Axboe <jens.axboe@oracle.com>");
1245 printf("\n Jens Axboe <jaxboe@fusionio.com>\n");
1248 #ifdef FIO_INC_DEBUG
1249 struct debug_level debug_levels[] = {
1250 { .name = "process", .shift = FD_PROCESS, },
1251 { .name = "file", .shift = FD_FILE, },
1252 { .name = "io", .shift = FD_IO, },
1253 { .name = "mem", .shift = FD_MEM, },
1254 { .name = "blktrace", .shift = FD_BLKTRACE },
1255 { .name = "verify", .shift = FD_VERIFY },
1256 { .name = "random", .shift = FD_RANDOM },
1257 { .name = "parse", .shift = FD_PARSE },
1258 { .name = "diskutil", .shift = FD_DISKUTIL },
1259 { .name = "job", .shift = FD_JOB },
1260 { .name = "mutex", .shift = FD_MUTEX },
1261 { .name = "profile", .shift = FD_PROFILE },
1262 { .name = "time", .shift = FD_TIME },
1263 { .name = "net", .shift = FD_NET },
1267 static int set_debug(const char *string)
1269 struct debug_level *dl;
1270 char *p = (char *) string;
1274 if (!strcmp(string, "?") || !strcmp(string, "help")) {
1275 log_info("fio: dumping debug options:");
1276 for (i = 0; debug_levels[i].name; i++) {
1277 dl = &debug_levels[i];
1278 log_info("%s,", dl->name);
1284 while ((opt = strsep(&p, ",")) != NULL) {
1287 if (!strncmp(opt, "all", 3)) {
1288 log_info("fio: set all debug options\n");
1293 for (i = 0; debug_levels[i].name; i++) {
1294 dl = &debug_levels[i];
1295 found = !strncmp(opt, dl->name, strlen(dl->name));
1299 if (dl->shift == FD_JOB) {
1300 opt = strchr(opt, ':');
1302 log_err("fio: missing job number\n");
1306 fio_debug_jobno = atoi(opt);
1307 log_info("fio: set debug jobno %d\n",
1310 log_info("fio: set debug option %s\n", opt);
1311 fio_debug |= (1UL << dl->shift);
1317 log_err("fio: debug mask %s not found\n", opt);
1322 static int set_debug(const char *string)
1324 log_err("fio: debug tracing not included in build\n");
1329 static void fio_options_fill_optstring(void)
1331 char *ostr = cmd_optstr;
1335 while (l_opts[i].name) {
1336 ostr[c++] = l_opts[i].val;
1337 if (l_opts[i].has_arg == required_argument)
1339 else if (l_opts[i].has_arg == optional_argument) {
1348 static int client_flag_set(char c)
1353 while (l_opts[i].name) {
1354 int val = l_opts[i].val;
1356 if (c == (val & 0xff))
1357 return (val & FIO_CLIENT_FLAG);
1365 void parse_cmd_client(void *client, char *opt)
1367 fio_client_add_cmd_option(client, opt);
1370 int parse_cmd_line(int argc, char *argv[])
1372 struct thread_data *td = NULL;
1373 int c, ini_idx = 0, lidx, ret = 0, do_exit = 0, exit_val = 0;
1374 char *ostr = cmd_optstr;
1375 void *pid_file = NULL;
1376 void *cur_client = NULL;
1380 * Reset optind handling, since we may call this multiple times
1385 while ((c = getopt_long_only(argc, argv, ostr, l_opts, &lidx)) != -1) {
1388 if ((c & FIO_CLIENT_FLAG) || client_flag_set(c)) {
1389 parse_cmd_client(cur_client, argv[optind - 1]);
1390 c &= ~FIO_CLIENT_FLAG;
1395 smalloc_pool_size = atoi(optarg);
1398 def_timeout = atoi(optarg);
1407 f_out = fopen(optarg, "w+");
1409 perror("fopen output");
1415 output_format = FIO_OUTPUT_TERSE;
1418 if (!strcmp(optarg, "minimal") ||
1419 !strcmp(optarg, "terse") ||
1420 !strcmp(optarg, "csv"))
1421 output_format = FIO_OUTPUT_TERSE;
1422 else if (!strcmp(optarg, "json"))
1423 output_format = FIO_OUTPUT_JSON;
1425 output_format = FIO_OUTPUT_NORMAL;
1435 fio_show_option_help(optarg);
1441 fio_show_ioengine_help(optarg);
1453 log_info("%s\n", fio_version_string);
1458 terse_version = atoi(optarg);
1459 if (!(terse_version == 2 || terse_version == 3 ||
1460 terse_version == 4)) {
1461 log_err("fio: bad terse version format\n");
1467 if (!strcmp("always", optarg))
1468 eta_print = FIO_ETA_ALWAYS;
1469 else if (!strcmp("never", optarg))
1470 eta_print = FIO_ETA_NEVER;
1473 if (set_debug(optarg))
1479 if (!strcmp(optarg, "global")) {
1480 log_err("fio: can't use global as only "
1486 new_size = (nr_job_sections + 1) * sizeof(char *);
1487 job_sections = realloc(job_sections, new_size);
1488 job_sections[nr_job_sections] = strdup(optarg);
1493 exec_profile = strdup(optarg);
1495 case FIO_GETOPT_JOB: {
1496 const char *opt = l_opts[lidx].name;
1499 if (!strncmp(opt, "name", 4) && td) {
1500 ret = add_job(td, td->o.name ?: "fio", 0);
1506 int is_section = !strncmp(opt, "name", 4);
1509 if (!is_section || !strncmp(val, "global", 6))
1512 if (is_section && skip_this_section(val))
1515 td = get_new_job(global, &def_thread, 1);
1516 if (!td || ioengine_load(td))
1518 fio_options_set_ioengine_opts(l_opts, td);
1521 ret = fio_cmd_option_parse(td, opt, val);
1523 if (!ret && !strcmp(opt, "ioengine")) {
1525 if (ioengine_load(td))
1527 fio_options_set_ioengine_opts(l_opts, td);
1531 case FIO_GETOPT_IOENGINE: {
1532 const char *opt = l_opts[lidx].name;
1534 opt = l_opts[lidx].name;
1536 ret = fio_cmd_ioengine_option_parse(td, opt, val);
1543 max_jobs = atoi(optarg);
1544 if (!max_jobs || max_jobs > REAL_MAX_JOBS) {
1545 log_err("fio: invalid max jobs: %d\n", max_jobs);
1552 log_err("fio: can't be both client and server\n");
1558 fio_server_set_arg(optarg);
1563 pid_file = strdup(optarg);
1567 log_err("fio: can't be both client and server\n");
1572 if (fio_client_add(optarg, &cur_client)) {
1573 log_err("fio: failed adding client %s\n", optarg);
1579 * If the next argument exists and isn't an option,
1580 * assume it's a job file for this client only.
1582 while (optind < argc) {
1583 if (!strncmp(argv[optind], "--", 2) ||
1584 !strncmp(argv[optind], "-", 1))
1587 fio_client_add_ini_file(cur_client, argv[optind]);
1601 if (exit_val && !(is_backend || nr_clients))
1605 if (nr_clients && fio_clients_connect()) {
1611 if (is_backend && backend)
1612 return fio_start_server(pid_file);
1616 ret = add_job(td, td->o.name ?: "fio", 0);
1619 while (!ret && optind < argc) {
1621 ini_file = realloc(ini_file, ini_idx * sizeof(char *));
1622 ini_file[ini_idx - 1] = strdup(argv[optind]);
1629 int parse_options(int argc, char *argv[])
1636 fio_options_fill_optstring();
1637 fio_options_dup_and_init(l_opts);
1641 if (fill_def_thread())
1644 job_files = parse_cmd_line(argc, argv);
1646 if (job_files > 0) {
1647 for (i = 0; i < job_files; i++) {
1648 if (fill_def_thread())
1651 if (fio_clients_send_ini(ini_file[i]))
1654 } else if (!is_backend) {
1655 if (parse_jobs_ini(ini_file[i], 0, i))
1660 } else if (nr_clients) {
1661 if (fill_def_thread())
1663 if (fio_clients_send_ini(NULL))
1668 fio_options_free(&def_thread);
1670 if (!thread_number) {
1675 if (is_backend || nr_clients)
1680 log_err("No jobs(s) defined\n\n");
1690 if (def_thread.o.gtod_offload) {
1692 fio_gtod_offload = 1;
1693 fio_gtod_cpu = def_thread.o.gtod_cpu;
1696 if (output_format == FIO_OUTPUT_NORMAL)
1697 log_info("%s\n", fio_version_string);