2 * This file contains job initialization and setup functions.
13 #include <sys/types.h>
24 #include "lib/getopt.h"
26 #include "fio_version.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;
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 *) "version",
123 .has_arg = no_argument,
124 .val = 'v' | FIO_CLIENT_FLAG,
127 .name = (char *) "help",
128 .has_arg = no_argument,
129 .val = 'h' | FIO_CLIENT_FLAG,
132 .name = (char *) "cmdhelp",
133 .has_arg = optional_argument,
134 .val = 'c' | FIO_CLIENT_FLAG,
137 .name = (char *) "enghelp",
138 .has_arg = optional_argument,
139 .val = 'i' | FIO_CLIENT_FLAG,
142 .name = (char *) "showcmd",
143 .has_arg = no_argument,
144 .val = 's' | FIO_CLIENT_FLAG,
147 .name = (char *) "readonly",
148 .has_arg = no_argument,
149 .val = 'r' | FIO_CLIENT_FLAG,
152 .name = (char *) "eta",
153 .has_arg = required_argument,
154 .val = 'e' | FIO_CLIENT_FLAG,
157 .name = (char *) "debug",
158 .has_arg = required_argument,
159 .val = 'd' | FIO_CLIENT_FLAG,
162 .name = (char *) "section",
163 .has_arg = required_argument,
164 .val = 'x' | FIO_CLIENT_FLAG,
167 .name = (char *) "alloc-size",
168 .has_arg = required_argument,
169 .val = 'a' | FIO_CLIENT_FLAG,
172 .name = (char *) "profile",
173 .has_arg = required_argument,
174 .val = 'p' | FIO_CLIENT_FLAG,
177 .name = (char *) "warnings-fatal",
178 .has_arg = no_argument,
179 .val = 'w' | FIO_CLIENT_FLAG,
182 .name = (char *) "max-jobs",
183 .has_arg = required_argument,
184 .val = 'j' | FIO_CLIENT_FLAG,
187 .name = (char *) "terse-version",
188 .has_arg = required_argument,
189 .val = 'V' | FIO_CLIENT_FLAG,
192 .name = (char *) "server",
193 .has_arg = optional_argument,
196 { .name = (char *) "daemonize",
197 .has_arg = required_argument,
201 .name = (char *) "client",
202 .has_arg = required_argument,
210 static void free_shm(void)
212 struct shmid_ds sbuf;
220 fio_debug_jobp = NULL;
222 shmctl(shm_id, IPC_RMID, &sbuf);
229 * The thread area is shared between the main process and the job
230 * threads/processes. So setup a shared memory segment that will hold
231 * all the job info. We use the end of the region for keeping track of
232 * open files across jobs, for file sharing.
234 static int setup_thread_area(void)
242 * 1024 is too much on some machines, scale max_jobs if
243 * we get a failure that looks like too large a shm segment
246 size_t size = max_jobs * sizeof(struct thread_data);
248 size += file_hash_size;
249 size += sizeof(unsigned int);
251 shm_id = shmget(0, size, IPC_CREAT | 0600);
254 if (errno != EINVAL && errno != ENOMEM) {
265 threads = shmat(shm_id, NULL, 0);
266 if (threads == (void *) -1) {
271 memset(threads, 0, max_jobs * sizeof(struct thread_data));
272 hash = (void *) threads + max_jobs * sizeof(struct thread_data);
273 fio_debug_jobp = (void *) hash + file_hash_size;
274 *fio_debug_jobp = -1;
275 file_hash_init(hash);
283 * Return a free job structure.
285 static struct thread_data *get_new_job(int global, struct thread_data *parent,
288 struct thread_data *td;
292 if (setup_thread_area()) {
293 log_err("error: failed to setup shm segment\n");
296 if (thread_number >= max_jobs) {
297 log_err("error: maximum number of jobs (%d) reached.\n",
302 td = &threads[thread_number++];
309 td->o.uid = td->o.gid = -1U;
311 dup_files(td, parent);
312 fio_options_mem_dupe(td);
314 profile_add_hooks(td);
316 td->thread_number = thread_number;
320 static void put_job(struct thread_data *td)
322 if (td == &def_thread)
329 log_info("fio: %s\n", td->verror);
331 fio_options_free(td);
335 memset(&threads[td->thread_number - 1], 0, sizeof(*td));
339 static int __setup_rate(struct thread_data *td, enum fio_ddir ddir)
341 unsigned int bs = td->o.min_bs[ddir];
343 assert(ddir_rw(ddir));
345 if (td->o.rate[ddir])
346 td->rate_bps[ddir] = td->o.rate[ddir];
348 td->rate_bps[ddir] = td->o.rate_iops[ddir] * bs;
350 if (!td->rate_bps[ddir]) {
351 log_err("rate lower than supported\n");
355 td->rate_pending_usleep[ddir] = 0;
359 static int setup_rate(struct thread_data *td)
363 if (td->o.rate[DDIR_READ] || td->o.rate_iops[DDIR_READ])
364 ret = __setup_rate(td, DDIR_READ);
365 if (td->o.rate[DDIR_WRITE] || td->o.rate_iops[DDIR_WRITE])
366 ret |= __setup_rate(td, DDIR_WRITE);
371 static int fixed_block_size(struct thread_options *o)
373 return o->min_bs[DDIR_READ] == o->max_bs[DDIR_READ] &&
374 o->min_bs[DDIR_WRITE] == o->max_bs[DDIR_WRITE] &&
375 o->min_bs[DDIR_READ] == o->min_bs[DDIR_WRITE];
379 * Lazy way of fixing up options that depend on each other. We could also
380 * define option callback handlers, but this is easier.
382 static int fixup_options(struct thread_data *td)
384 struct thread_options *o = &td->o;
387 #ifndef FIO_HAVE_PSHARED_MUTEX
388 if (!o->use_thread) {
389 log_info("fio: this platform does not support process shared"
390 " mutexes, forcing use of threads. Use the 'thread'"
391 " option to get rid of this warning.\n");
393 ret = warnings_fatal;
397 if (o->write_iolog_file && o->read_iolog_file) {
398 log_err("fio: read iolog overrides write_iolog\n");
399 free(o->write_iolog_file);
400 o->write_iolog_file = NULL;
401 ret = warnings_fatal;
405 * only really works with 1 file
407 if (o->zone_size && o->open_files == 1)
411 * If zone_range isn't specified, backward compatibility dictates it
412 * should be made equal to zone_size.
414 if (o->zone_size && !o->zone_range)
415 o->zone_range = o->zone_size;
418 * Reads can do overwrites, we always need to pre-create the file
420 if (td_read(td) || td_rw(td))
423 if (!o->min_bs[DDIR_READ])
424 o->min_bs[DDIR_READ] = o->bs[DDIR_READ];
425 if (!o->max_bs[DDIR_READ])
426 o->max_bs[DDIR_READ] = o->bs[DDIR_READ];
427 if (!o->min_bs[DDIR_WRITE])
428 o->min_bs[DDIR_WRITE] = o->bs[DDIR_WRITE];
429 if (!o->max_bs[DDIR_WRITE])
430 o->max_bs[DDIR_WRITE] = o->bs[DDIR_WRITE];
432 o->rw_min_bs = min(o->min_bs[DDIR_READ], o->min_bs[DDIR_WRITE]);
435 * For random IO, allow blockalign offset other than min_bs.
437 if (!o->ba[DDIR_READ] || !td_random(td))
438 o->ba[DDIR_READ] = o->min_bs[DDIR_READ];
439 if (!o->ba[DDIR_WRITE] || !td_random(td))
440 o->ba[DDIR_WRITE] = o->min_bs[DDIR_WRITE];
442 if ((o->ba[DDIR_READ] != o->min_bs[DDIR_READ] ||
443 o->ba[DDIR_WRITE] != o->min_bs[DDIR_WRITE]) &&
445 log_err("fio: Any use of blockalign= turns off randommap\n");
447 ret = warnings_fatal;
450 if (!o->file_size_high)
451 o->file_size_high = o->file_size_low;
453 if (o->norandommap && o->verify != VERIFY_NONE
454 && !fixed_block_size(o)) {
455 log_err("fio: norandommap given for variable block sizes, "
456 "verify disabled\n");
457 o->verify = VERIFY_NONE;
458 ret = warnings_fatal;
460 if (o->bs_unaligned && (o->odirect || td->io_ops->flags & FIO_RAWIO))
461 log_err("fio: bs_unaligned may not work with raw io\n");
464 * thinktime_spin must be less than thinktime
466 if (o->thinktime_spin > o->thinktime)
467 o->thinktime_spin = o->thinktime;
470 * The low water mark cannot be bigger than the iodepth
472 if (o->iodepth_low > o->iodepth || !o->iodepth_low) {
474 * syslet work around - if the workload is sequential,
475 * we want to let the queue drain all the way down to
476 * avoid seeking between async threads
478 if (!strcmp(td->io_ops->name, "syslet-rw") && !td_random(td))
481 o->iodepth_low = o->iodepth;
485 * If batch number isn't set, default to the same as iodepth
487 if (o->iodepth_batch > o->iodepth || !o->iodepth_batch)
488 o->iodepth_batch = o->iodepth;
490 if (o->nr_files > td->files_index)
491 o->nr_files = td->files_index;
493 if (o->open_files > o->nr_files || !o->open_files)
494 o->open_files = o->nr_files;
496 if (((o->rate[0] + o->rate[1]) && (o->rate_iops[0] + o->rate_iops[1]))||
497 ((o->ratemin[0] + o->ratemin[1]) && (o->rate_iops_min[0] +
498 o->rate_iops_min[1]))) {
499 log_err("fio: rate and rate_iops are mutually exclusive\n");
502 if ((o->rate[0] < o->ratemin[0]) || (o->rate[1] < o->ratemin[1]) ||
503 (o->rate_iops[0] < o->rate_iops_min[0]) ||
504 (o->rate_iops[1] < o->rate_iops_min[1])) {
505 log_err("fio: minimum rate exceeds rate\n");
509 if (!o->timeout && o->time_based) {
510 log_err("fio: time_based requires a runtime/timeout setting\n");
512 ret = warnings_fatal;
515 if (o->fill_device && !o->size)
518 if (o->verify != VERIFY_NONE) {
519 if (td_write(td) && o->do_verify && o->numjobs > 1) {
520 log_info("Multiple writers may overwrite blocks that "
521 "belong to other jobs. This can cause "
522 "verification failures.\n");
523 ret = warnings_fatal;
526 o->refill_buffers = 1;
527 if (o->max_bs[DDIR_WRITE] != o->min_bs[DDIR_WRITE] &&
529 o->verify_interval = o->min_bs[DDIR_WRITE];
533 o->invalidate_cache = 0;
534 if (td->io_ops->flags & FIO_PIPEIO) {
535 log_info("fio: cannot pre-read files with an IO engine"
536 " that isn't seekable. Pre-read disabled.\n");
537 ret = warnings_fatal;
541 #ifndef FIO_HAVE_FDATASYNC
542 if (o->fdatasync_blocks) {
543 log_info("fio: this platform does not support fdatasync()"
544 " falling back to using fsync(). Use the 'fsync'"
545 " option instead of 'fdatasync' to get rid of"
547 o->fsync_blocks = o->fdatasync_blocks;
548 o->fdatasync_blocks = 0;
549 ret = warnings_fatal;
555 * Windows doesn't support O_DIRECT or O_SYNC with the _open interface,
556 * so fail if we're passed those flags
558 if ((td->io_ops->flags & FIO_SYNCIO) && (td->o.odirect || td->o.sync_io)) {
559 log_err("fio: Windows does not support direct or non-buffered io with"
560 " the synchronous ioengines. Use the 'windowsaio' ioengine"
561 " with 'direct=1' and 'iodepth=1' instead.\n");
567 * For fully compressible data, just zero them at init time.
568 * It's faster than repeatedly filling it.
570 if (td->o.compress_percentage == 100) {
571 td->o.zero_buffers = 1;
572 td->o.compress_percentage = 0;
579 * This function leaks the buffer
581 static char *to_kmg(unsigned int val)
583 char *buf = malloc(32);
584 char post[] = { 0, 'K', 'M', 'G', 'P', 'E', 0 };
595 snprintf(buf, 31, "%u%c", val, *p);
599 /* External engines are specified by "external:name.o") */
600 static const char *get_engine_name(const char *str)
602 char *p = strstr(str, ":");
608 strip_blank_front(&p);
613 static int exists_and_not_file(const char *filename)
617 if (lstat(filename, &sb) == -1)
620 /* \\.\ is the device namespace in Windows, where every file
621 * is a device node */
622 if (S_ISREG(sb.st_mode) && strncmp(filename, "\\\\.\\", 4) != 0)
628 static void td_fill_rand_seeds_os(struct thread_data *td)
630 os_random_seed(td->rand_seeds[0], &td->bsrange_state);
631 os_random_seed(td->rand_seeds[1], &td->verify_state);
632 os_random_seed(td->rand_seeds[2], &td->rwmix_state);
634 if (td->o.file_service_type == FIO_FSERVICE_RANDOM)
635 os_random_seed(td->rand_seeds[3], &td->next_file_state);
637 os_random_seed(td->rand_seeds[5], &td->file_size_state);
638 os_random_seed(td->rand_seeds[6], &td->trim_state);
643 if (td->o.rand_repeatable)
644 td->rand_seeds[4] = FIO_RANDSEED * td->thread_number;
646 os_random_seed(td->rand_seeds[4], &td->random_state);
649 static void td_fill_rand_seeds_internal(struct thread_data *td)
651 init_rand_seed(&td->__bsrange_state, td->rand_seeds[0]);
652 init_rand_seed(&td->__verify_state, td->rand_seeds[1]);
653 init_rand_seed(&td->__rwmix_state, td->rand_seeds[2]);
655 if (td->o.file_service_type == FIO_FSERVICE_RANDOM)
656 init_rand_seed(&td->__next_file_state, td->rand_seeds[3]);
658 init_rand_seed(&td->__file_size_state, td->rand_seeds[5]);
659 init_rand_seed(&td->__trim_state, td->rand_seeds[6]);
664 if (td->o.rand_repeatable)
665 td->rand_seeds[4] = FIO_RANDSEED * td->thread_number;
667 init_rand_seed(&td->__random_state, td->rand_seeds[4]);
670 void td_fill_rand_seeds(struct thread_data *td)
672 if (td->o.use_os_rand)
673 td_fill_rand_seeds_os(td);
675 td_fill_rand_seeds_internal(td);
677 init_rand_seed(&td->buf_state, td->rand_seeds[7]);
682 * Initializes the ioengine configured for a job, if it has not been done so
685 int ioengine_load(struct thread_data *td)
690 * Engine has already been loaded.
695 engine = get_engine_name(td->o.ioengine);
696 td->io_ops = load_ioengine(td, engine);
698 log_err("fio: failed to load engine %s\n", engine);
702 if (td->io_ops->option_struct_size && td->io_ops->options) {
704 * In cases where td->eo is set, clone it for a child thread.
705 * This requires that the parent thread has the same ioengine,
706 * but that requirement must be enforced by the code which
709 void *origeo = td->eo;
711 * Otherwise use the default thread options.
713 if (!origeo && td != &def_thread && def_thread.eo &&
714 def_thread.io_ops->options == td->io_ops->options)
715 origeo = def_thread.eo;
717 options_init(td->io_ops->options);
718 td->eo = malloc(td->io_ops->option_struct_size);
720 * Use the default thread as an option template if this uses the
721 * same options structure and there are non-default options
725 memcpy(td->eo, origeo, td->io_ops->option_struct_size);
726 options_mem_dupe(td->eo, td->io_ops->options);
728 memset(td->eo, 0, td->io_ops->option_struct_size);
729 fill_default_options(td->eo, td->io_ops->options);
731 *(struct thread_data **)td->eo = td;
738 * Adds a job to the list of things todo. Sanitizes the various options
739 * to make sure we don't have conflicts, and initializes various
742 static int add_job(struct thread_data *td, const char *jobname, int job_add_num)
744 const char *ddir_str[] = { NULL, "read", "write", "rw", NULL,
745 "randread", "randwrite", "randrw" };
747 char fname[PATH_MAX];
748 int numjobs, file_alloced;
751 * the def_thread is just for options, it's not a real job
753 if (td == &def_thread)
757 * if we are just dumping the output command line, don't add the job
764 if (profile_td_init(td))
767 if (ioengine_load(td))
770 if (td->o.use_thread)
776 td->io_ops->flags |= FIO_RAWIO;
779 if (!td->o.filename && !td->files_index && !td->o.read_iolog_file) {
782 if (td->o.nr_files == 1 && exists_and_not_file(jobname))
783 add_file(td, jobname);
785 for (i = 0; i < td->o.nr_files; i++) {
786 sprintf(fname, "%s.%d.%d", jobname,
787 td->thread_number, i);
793 if (fixup_options(td))
799 * IO engines only need this for option callbacks, and the address may
800 * change in subprocesses.
803 *(struct thread_data **)td->eo = NULL;
805 if (td->io_ops->flags & FIO_DISKLESSIO) {
808 for_each_file(td, f, i)
809 f->real_file_size = -1ULL;
812 td->mutex = fio_mutex_init(0);
814 td->ts.clat_percentiles = td->o.clat_percentiles;
815 if (td->o.overwrite_plist)
816 memcpy(td->ts.percentile_list, td->o.percentile_list, sizeof(td->o.percentile_list));
818 memcpy(td->ts.percentile_list, def_percentile_list, sizeof(def_percentile_list));
820 td->ts.clat_stat[0].min_val = td->ts.clat_stat[1].min_val = ULONG_MAX;
821 td->ts.slat_stat[0].min_val = td->ts.slat_stat[1].min_val = ULONG_MAX;
822 td->ts.lat_stat[0].min_val = td->ts.lat_stat[1].min_val = ULONG_MAX;
823 td->ts.bw_stat[0].min_val = td->ts.bw_stat[1].min_val = ULONG_MAX;
824 td->ddir_seq_nr = td->o.ddir_seq_nr;
826 if ((td->o.stonewall || td->o.new_group) && prev_group_jobs) {
831 td->groupid = groupid;
834 if (init_random_state(td, td->rand_seeds, sizeof(td->rand_seeds))) {
835 td_verror(td, errno, "init_random_state");
842 if (td->o.write_lat_log) {
843 setup_log(&td->lat_log, td->o.log_avg_msec);
844 setup_log(&td->slat_log, td->o.log_avg_msec);
845 setup_log(&td->clat_log, td->o.log_avg_msec);
847 if (td->o.write_bw_log)
848 setup_log(&td->bw_log, td->o.log_avg_msec);
849 if (td->o.write_iops_log)
850 setup_log(&td->iops_log, td->o.log_avg_msec);
853 td->o.name = strdup(jobname);
857 if (!strcmp(td->io_ops->name, "cpuio")) {
858 log_info("%s: ioengine=cpu, cpuload=%u,"
859 " cpucycle=%u\n", td->o.name,
863 char *c1, *c2, *c3, *c4;
865 c1 = to_kmg(td->o.min_bs[DDIR_READ]);
866 c2 = to_kmg(td->o.max_bs[DDIR_READ]);
867 c3 = to_kmg(td->o.min_bs[DDIR_WRITE]);
868 c4 = to_kmg(td->o.max_bs[DDIR_WRITE]);
870 log_info("%s: (g=%d): rw=%s, bs=%s-%s/%s-%s,"
871 " ioengine=%s, iodepth=%u\n",
872 td->o.name, td->groupid,
873 ddir_str[td->o.td_ddir],
883 } else if (job_add_num == 1)
888 * recurse add identical jobs, clear numjobs and stonewall options
889 * as they don't apply to sub-jobs
891 numjobs = td->o.numjobs;
893 struct thread_data *td_new = get_new_job(0, td, 1);
898 td_new->o.numjobs = 1;
899 td_new->o.stonewall = 0;
900 td_new->o.new_group = 0;
903 td_new->o.filename = NULL;
904 td_new->files_index = 0;
905 td_new->files_size = 0;
906 td_new->files = NULL;
909 job_add_num = numjobs - 1;
911 if (add_job(td_new, jobname, job_add_num))
922 * Parse as if 'o' was a command line
924 void add_job_opts(const char **o)
926 struct thread_data *td, *td_parent;
927 int i, in_global = 1;
931 td_parent = td = NULL;
933 if (!strncmp(o[i], "name", 4)) {
936 add_job(td, jobname, 0);
938 sprintf(jobname, "%s", o[i] + 5);
940 if (in_global && !td_parent)
941 td_parent = get_new_job(1, &def_thread, 0);
942 else if (!in_global && !td) {
944 td_parent = &def_thread;
945 td = get_new_job(0, td_parent, 0);
948 fio_options_parse(td_parent, (char **) &o[i], 1);
950 fio_options_parse(td, (char **) &o[i], 1);
955 add_job(td, jobname, 0);
958 static int skip_this_section(const char *name)
962 if (!nr_job_sections)
964 if (!strncmp(name, "global", 6))
967 for (i = 0; i < nr_job_sections; i++)
968 if (!strcmp(job_sections[i], name))
974 static int is_empty_or_comment(char *line)
978 for (i = 0; i < strlen(line); i++) {
983 if (!isspace((int) line[i]) && !iscntrl((int) line[i]))
991 * This is our [ini] type file parser.
993 int parse_jobs_ini(char *file, int is_buf, int stonewall_flag)
996 struct thread_data *td;
1000 int ret = 0, stonewall;
1003 int inside_skip = 0;
1005 int i, alloc_opts, num_opts;
1010 if (!strcmp(file, "-"))
1013 f = fopen(file, "r");
1016 perror("fopen job file");
1021 string = malloc(4096);
1024 * it's really 256 + small bit, 280 should suffice
1027 memset(name, 0, 280);
1030 opts = malloc(sizeof(char *) * alloc_opts);
1033 stonewall = stonewall_flag;
1036 * if skip_fgets is set, we already have loaded a line we
1041 p = strsep(&file, "\n");
1043 p = fgets(string, 4096, f);
1049 strip_blank_front(&p);
1052 if (is_empty_or_comment(p))
1054 if (sscanf(p, "[%255[^\n]]", name) != 1) {
1057 log_err("fio: option <%s> outside of [] job section\n",
1062 name[strlen(name) - 1] = '\0';
1064 if (skip_this_section(name)) {
1070 global = !strncmp(name, "global", 6);
1076 log_info("--name=%s ", name);
1080 td = get_new_job(global, &def_thread, 0);
1087 * Seperate multiple job files by a stonewall
1089 if (!global && stonewall) {
1090 td->o.stonewall = stonewall;
1095 memset(opts, 0, alloc_opts * sizeof(char *));
1099 p = strsep(&file, "\n");
1101 p = fgets(string, 4096, f);
1105 if (is_empty_or_comment(p))
1108 strip_blank_front(&p);
1111 * new section, break out and make sure we don't
1112 * fgets() a new line at the top.
1121 if (num_opts == alloc_opts) {
1123 opts = realloc(opts,
1124 alloc_opts * sizeof(char *));
1127 opts[num_opts] = strdup(p);
1131 ret = fio_options_parse(td, opts, num_opts);
1134 for (i = 0; i < num_opts; i++)
1135 log_info("--%s ", opts[i]);
1137 ret = add_job(td, name, 0);
1139 log_err("fio: job %s dropped\n", name);
1143 for (i = 0; i < num_opts; i++)
1152 while (i < nr_job_sections) {
1153 free(job_sections[i]);
1157 for (i = 0; i < num_opts; i++)
1163 if (!is_buf && f != stdin)
1168 static int fill_def_thread(void)
1170 memset(&def_thread, 0, sizeof(def_thread));
1172 fio_getaffinity(getpid(), &def_thread.o.cpumask);
1173 def_thread.o.timeout = def_timeout;
1176 * fill default options
1178 fio_fill_default_options(&def_thread);
1182 static void usage(const char *name)
1184 printf("%s\n", fio_version_string);
1185 printf("%s [options] [job options] <job file(s)>\n", name);
1186 printf(" --debug=options\tEnable debug logging. May be one/more of:\n"
1187 "\t\t\tprocess,file,io,mem,blktrace,verify,random,parse,\n"
1188 "\t\t\tdiskutil,job,mutex,profile,time,net\n");
1189 printf(" --output\t\tWrite output to file\n");
1190 printf(" --timeout\t\tRuntime in seconds\n");
1191 printf(" --latency-log\t\tGenerate per-job latency logs\n");
1192 printf(" --bandwidth-log\tGenerate per-job bandwidth logs\n");
1193 printf(" --minimal\t\tMinimal (terse) output\n");
1194 printf(" --version\t\tPrint version info and exit\n");
1195 printf(" --terse-version=x\tSet terse version output format to 'x'\n");
1196 printf(" --help\t\tPrint this page\n");
1197 printf(" --cmdhelp=cmd\t\tPrint command help, \"all\" for all of"
1199 printf(" --enghelp=engine\tPrint ioengine help, or list"
1200 " available ioengines\n");
1201 printf(" --enghelp=engine,cmd\tPrint help for an ioengine"
1203 printf(" --showcmd\t\tTurn a job file into command line options\n");
1204 printf(" --eta=when\t\tWhen ETA estimate should be printed\n");
1205 printf(" \t\tMay be \"always\", \"never\" or \"auto\"\n");
1206 printf(" --readonly\t\tTurn on safety read-only checks, preventing"
1208 printf(" --section=name\tOnly run specified section in job file\n");
1209 printf(" --alloc-size=kb\tSet smalloc pool to this size in kb"
1211 printf(" --warnings-fatal\tFio parser warnings are fatal\n");
1212 printf(" --max-jobs=nr\t\tMaximum number of threads/processes to support\n");
1213 printf(" --server=args\t\tStart a backend fio server\n");
1214 printf(" --daemonize=pidfile\tBackground fio server, write pid to file\n");
1215 printf(" --client=hostname\tTalk to remote backend fio server at hostname\n");
1216 printf("\nFio was written by Jens Axboe <jens.axboe@oracle.com>");
1217 printf("\n Jens Axboe <jaxboe@fusionio.com>\n");
1220 #ifdef FIO_INC_DEBUG
1221 struct debug_level debug_levels[] = {
1222 { .name = "process", .shift = FD_PROCESS, },
1223 { .name = "file", .shift = FD_FILE, },
1224 { .name = "io", .shift = FD_IO, },
1225 { .name = "mem", .shift = FD_MEM, },
1226 { .name = "blktrace", .shift = FD_BLKTRACE },
1227 { .name = "verify", .shift = FD_VERIFY },
1228 { .name = "random", .shift = FD_RANDOM },
1229 { .name = "parse", .shift = FD_PARSE },
1230 { .name = "diskutil", .shift = FD_DISKUTIL },
1231 { .name = "job", .shift = FD_JOB },
1232 { .name = "mutex", .shift = FD_MUTEX },
1233 { .name = "profile", .shift = FD_PROFILE },
1234 { .name = "time", .shift = FD_TIME },
1235 { .name = "net", .shift = FD_NET },
1239 static int set_debug(const char *string)
1241 struct debug_level *dl;
1242 char *p = (char *) string;
1246 if (!strcmp(string, "?") || !strcmp(string, "help")) {
1247 log_info("fio: dumping debug options:");
1248 for (i = 0; debug_levels[i].name; i++) {
1249 dl = &debug_levels[i];
1250 log_info("%s,", dl->name);
1256 while ((opt = strsep(&p, ",")) != NULL) {
1259 if (!strncmp(opt, "all", 3)) {
1260 log_info("fio: set all debug options\n");
1265 for (i = 0; debug_levels[i].name; i++) {
1266 dl = &debug_levels[i];
1267 found = !strncmp(opt, dl->name, strlen(dl->name));
1271 if (dl->shift == FD_JOB) {
1272 opt = strchr(opt, ':');
1274 log_err("fio: missing job number\n");
1278 fio_debug_jobno = atoi(opt);
1279 log_info("fio: set debug jobno %d\n",
1282 log_info("fio: set debug option %s\n", opt);
1283 fio_debug |= (1UL << dl->shift);
1289 log_err("fio: debug mask %s not found\n", opt);
1294 static int set_debug(const char *string)
1296 log_err("fio: debug tracing not included in build\n");
1301 static void fio_options_fill_optstring(void)
1303 char *ostr = cmd_optstr;
1307 while (l_opts[i].name) {
1308 ostr[c++] = l_opts[i].val;
1309 if (l_opts[i].has_arg == required_argument)
1311 else if (l_opts[i].has_arg == optional_argument) {
1320 static int client_flag_set(char c)
1325 while (l_opts[i].name) {
1326 int val = l_opts[i].val;
1328 if (c == (val & 0xff))
1329 return (val & FIO_CLIENT_FLAG);
1337 void parse_cmd_client(void *client, char *opt)
1339 fio_client_add_cmd_option(client, opt);
1342 int parse_cmd_line(int argc, char *argv[])
1344 struct thread_data *td = NULL;
1345 int c, ini_idx = 0, lidx, ret = 0, do_exit = 0, exit_val = 0;
1346 char *ostr = cmd_optstr;
1347 void *pid_file = NULL;
1348 void *cur_client = NULL;
1352 * Reset optind handling, since we may call this multiple times
1357 while ((c = getopt_long_only(argc, argv, ostr, l_opts, &lidx)) != -1) {
1360 if ((c & FIO_CLIENT_FLAG) || client_flag_set(c)) {
1361 parse_cmd_client(cur_client, argv[optind - 1]);
1362 c &= ~FIO_CLIENT_FLAG;
1367 smalloc_pool_size = atoi(optarg);
1370 def_timeout = atoi(optarg);
1379 f_out = fopen(optarg, "w+");
1381 perror("fopen output");
1397 fio_show_option_help(optarg);
1403 fio_show_ioengine_help(optarg);
1415 log_info("%s\n", fio_version_string);
1420 terse_version = atoi(optarg);
1421 if (!(terse_version == 2 || terse_version == 3)) {
1422 log_err("fio: bad terse version format\n");
1428 if (!strcmp("always", optarg))
1429 eta_print = FIO_ETA_ALWAYS;
1430 else if (!strcmp("never", optarg))
1431 eta_print = FIO_ETA_NEVER;
1434 if (set_debug(optarg))
1440 if (!strcmp(optarg, "global")) {
1441 log_err("fio: can't use global as only "
1447 new_size = (nr_job_sections + 1) * sizeof(char *);
1448 job_sections = realloc(job_sections, new_size);
1449 job_sections[nr_job_sections] = strdup(optarg);
1454 exec_profile = strdup(optarg);
1456 case FIO_GETOPT_JOB: {
1457 const char *opt = l_opts[lidx].name;
1460 if (!strncmp(opt, "name", 4) && td) {
1461 ret = add_job(td, td->o.name ?: "fio", 0);
1467 int is_section = !strncmp(opt, "name", 4);
1470 if (!is_section || !strncmp(val, "global", 6))
1473 if (is_section && skip_this_section(val))
1476 td = get_new_job(global, &def_thread, 1);
1477 if (!td || ioengine_load(td))
1479 fio_options_set_ioengine_opts(l_opts, td);
1482 ret = fio_cmd_option_parse(td, opt, val);
1484 if (!ret && !strcmp(opt, "ioengine")) {
1486 if (ioengine_load(td))
1488 fio_options_set_ioengine_opts(l_opts, td);
1492 case FIO_GETOPT_IOENGINE: {
1493 const char *opt = l_opts[lidx].name;
1495 opt = l_opts[lidx].name;
1497 ret = fio_cmd_ioengine_option_parse(td, opt, val);
1504 max_jobs = atoi(optarg);
1505 if (!max_jobs || max_jobs > REAL_MAX_JOBS) {
1506 log_err("fio: invalid max jobs: %d\n", max_jobs);
1513 log_err("fio: can't be both client and server\n");
1519 fio_server_set_arg(optarg);
1524 pid_file = strdup(optarg);
1528 log_err("fio: can't be both client and server\n");
1533 if (fio_client_add(optarg, &cur_client)) {
1534 log_err("fio: failed adding client %s\n", optarg);
1550 if (exit_val && !(is_backend || nr_clients))
1554 if (nr_clients && fio_clients_connect()) {
1560 if (is_backend && backend)
1561 return fio_start_server(pid_file);
1565 ret = add_job(td, td->o.name ?: "fio", 0);
1568 while (!ret && optind < argc) {
1570 ini_file = realloc(ini_file, ini_idx * sizeof(char *));
1571 ini_file[ini_idx - 1] = strdup(argv[optind]);
1578 int parse_options(int argc, char *argv[])
1585 fio_options_fill_optstring();
1586 fio_options_dup_and_init(l_opts);
1590 if (fill_def_thread())
1593 job_files = parse_cmd_line(argc, argv);
1595 if (job_files > 0) {
1596 for (i = 0; i < job_files; i++) {
1597 if (fill_def_thread())
1600 if (fio_clients_send_ini(ini_file[i]))
1603 } else if (!is_backend) {
1604 if (parse_jobs_ini(ini_file[i], 0, i))
1612 fio_options_free(&def_thread);
1614 if (!thread_number) {
1619 if (is_backend || nr_clients)
1624 log_err("No jobs(s) defined\n\n");
1634 if (def_thread.o.gtod_offload) {
1636 fio_gtod_offload = 1;
1637 fio_gtod_cpu = def_thread.o.gtod_cpu;
1641 log_info("%s\n", fio_version_string);