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;
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 *) "version",
121 .has_arg = no_argument,
122 .val = 'v' | FIO_CLIENT_FLAG,
125 .name = (char *) "help",
126 .has_arg = no_argument,
127 .val = 'h' | FIO_CLIENT_FLAG,
130 .name = (char *) "cmdhelp",
131 .has_arg = optional_argument,
132 .val = 'c' | FIO_CLIENT_FLAG,
135 .name = (char *) "enghelp",
136 .has_arg = optional_argument,
137 .val = 'i' | FIO_CLIENT_FLAG,
140 .name = (char *) "showcmd",
141 .has_arg = no_argument,
142 .val = 's' | FIO_CLIENT_FLAG,
145 .name = (char *) "readonly",
146 .has_arg = no_argument,
147 .val = 'r' | FIO_CLIENT_FLAG,
150 .name = (char *) "eta",
151 .has_arg = required_argument,
152 .val = 'e' | FIO_CLIENT_FLAG,
155 .name = (char *) "debug",
156 .has_arg = required_argument,
157 .val = 'd' | FIO_CLIENT_FLAG,
160 .name = (char *) "section",
161 .has_arg = required_argument,
162 .val = 'x' | FIO_CLIENT_FLAG,
165 .name = (char *) "alloc-size",
166 .has_arg = required_argument,
167 .val = 'a' | FIO_CLIENT_FLAG,
170 .name = (char *) "profile",
171 .has_arg = required_argument,
172 .val = 'p' | FIO_CLIENT_FLAG,
175 .name = (char *) "warnings-fatal",
176 .has_arg = no_argument,
177 .val = 'w' | FIO_CLIENT_FLAG,
180 .name = (char *) "max-jobs",
181 .has_arg = required_argument,
182 .val = 'j' | FIO_CLIENT_FLAG,
185 .name = (char *) "terse-version",
186 .has_arg = required_argument,
187 .val = 'V' | FIO_CLIENT_FLAG,
190 .name = (char *) "server",
191 .has_arg = optional_argument,
194 { .name = (char *) "daemonize",
195 .has_arg = required_argument,
199 .name = (char *) "client",
200 .has_arg = required_argument,
208 static void free_shm(void)
210 struct shmid_ds sbuf;
218 fio_debug_jobp = NULL;
220 shmctl(shm_id, IPC_RMID, &sbuf);
227 * The thread area is shared between the main process and the job
228 * threads/processes. So setup a shared memory segment that will hold
229 * all the job info. We use the end of the region for keeping track of
230 * open files across jobs, for file sharing.
232 static int setup_thread_area(void)
240 * 1024 is too much on some machines, scale max_jobs if
241 * we get a failure that looks like too large a shm segment
244 size_t size = max_jobs * sizeof(struct thread_data);
246 size += file_hash_size;
247 size += sizeof(unsigned int);
249 shm_id = shmget(0, size, IPC_CREAT | 0600);
252 if (errno != EINVAL && errno != ENOMEM) {
263 threads = shmat(shm_id, NULL, 0);
264 if (threads == (void *) -1) {
269 memset(threads, 0, max_jobs * sizeof(struct thread_data));
270 hash = (void *) threads + max_jobs * sizeof(struct thread_data);
271 fio_debug_jobp = (void *) hash + file_hash_size;
272 *fio_debug_jobp = -1;
273 file_hash_init(hash);
281 * Return a free job structure.
283 static struct thread_data *get_new_job(int global, struct thread_data *parent,
286 struct thread_data *td;
290 if (setup_thread_area()) {
291 log_err("error: failed to setup shm segment\n");
294 if (thread_number >= max_jobs) {
295 log_err("error: maximum number of jobs (%d) reached.\n",
300 td = &threads[thread_number++];
307 td->o.uid = td->o.gid = -1U;
309 dup_files(td, parent);
310 fio_options_mem_dupe(td);
312 profile_add_hooks(td);
314 td->thread_number = thread_number;
318 static void put_job(struct thread_data *td)
320 if (td == &def_thread)
327 log_info("fio: %s\n", td->verror);
329 fio_options_free(td);
333 memset(&threads[td->thread_number - 1], 0, sizeof(*td));
337 static int __setup_rate(struct thread_data *td, enum fio_ddir ddir)
339 unsigned int bs = td->o.min_bs[ddir];
341 assert(ddir_rw(ddir));
343 if (td->o.rate[ddir])
344 td->rate_bps[ddir] = td->o.rate[ddir];
346 td->rate_bps[ddir] = td->o.rate_iops[ddir] * bs;
348 if (!td->rate_bps[ddir]) {
349 log_err("rate lower than supported\n");
353 td->rate_pending_usleep[ddir] = 0;
357 static int setup_rate(struct thread_data *td)
361 if (td->o.rate[DDIR_READ] || td->o.rate_iops[DDIR_READ])
362 ret = __setup_rate(td, DDIR_READ);
363 if (td->o.rate[DDIR_WRITE] || td->o.rate_iops[DDIR_WRITE])
364 ret |= __setup_rate(td, DDIR_WRITE);
369 static int fixed_block_size(struct thread_options *o)
371 return o->min_bs[DDIR_READ] == o->max_bs[DDIR_READ] &&
372 o->min_bs[DDIR_WRITE] == o->max_bs[DDIR_WRITE] &&
373 o->min_bs[DDIR_READ] == o->min_bs[DDIR_WRITE];
377 * Lazy way of fixing up options that depend on each other. We could also
378 * define option callback handlers, but this is easier.
380 static int fixup_options(struct thread_data *td)
382 struct thread_options *o = &td->o;
385 #ifndef FIO_HAVE_PSHARED_MUTEX
386 if (!o->use_thread) {
387 log_info("fio: this platform does not support process shared"
388 " mutexes, forcing use of threads. Use the 'thread'"
389 " option to get rid of this warning.\n");
391 ret = warnings_fatal;
395 if (o->write_iolog_file && o->read_iolog_file) {
396 log_err("fio: read iolog overrides write_iolog\n");
397 free(o->write_iolog_file);
398 o->write_iolog_file = NULL;
399 ret = warnings_fatal;
403 * only really works with 1 file
405 if (o->zone_size && o->open_files == 1)
409 * If zone_range isn't specified, backward compatibility dictates it
410 * should be made equal to zone_size.
412 if (o->zone_size && !o->zone_range)
413 o->zone_range = o->zone_size;
416 * Reads can do overwrites, we always need to pre-create the file
418 if (td_read(td) || td_rw(td))
421 if (!o->min_bs[DDIR_READ])
422 o->min_bs[DDIR_READ] = o->bs[DDIR_READ];
423 if (!o->max_bs[DDIR_READ])
424 o->max_bs[DDIR_READ] = o->bs[DDIR_READ];
425 if (!o->min_bs[DDIR_WRITE])
426 o->min_bs[DDIR_WRITE] = o->bs[DDIR_WRITE];
427 if (!o->max_bs[DDIR_WRITE])
428 o->max_bs[DDIR_WRITE] = o->bs[DDIR_WRITE];
430 o->rw_min_bs = min(o->min_bs[DDIR_READ], o->min_bs[DDIR_WRITE]);
433 * For random IO, allow blockalign offset other than min_bs.
435 if (!o->ba[DDIR_READ] || !td_random(td))
436 o->ba[DDIR_READ] = o->min_bs[DDIR_READ];
437 if (!o->ba[DDIR_WRITE] || !td_random(td))
438 o->ba[DDIR_WRITE] = o->min_bs[DDIR_WRITE];
440 if ((o->ba[DDIR_READ] != o->min_bs[DDIR_READ] ||
441 o->ba[DDIR_WRITE] != o->min_bs[DDIR_WRITE]) &&
443 log_err("fio: Any use of blockalign= turns off randommap\n");
445 ret = warnings_fatal;
448 if (!o->file_size_high)
449 o->file_size_high = o->file_size_low;
451 if (o->norandommap && o->verify != VERIFY_NONE
452 && !fixed_block_size(o)) {
453 log_err("fio: norandommap given for variable block sizes, "
454 "verify disabled\n");
455 o->verify = VERIFY_NONE;
456 ret = warnings_fatal;
458 if (o->bs_unaligned && (o->odirect || td->io_ops->flags & FIO_RAWIO))
459 log_err("fio: bs_unaligned may not work with raw io\n");
462 * thinktime_spin must be less than thinktime
464 if (o->thinktime_spin > o->thinktime)
465 o->thinktime_spin = o->thinktime;
468 * The low water mark cannot be bigger than the iodepth
470 if (o->iodepth_low > o->iodepth || !o->iodepth_low) {
472 * syslet work around - if the workload is sequential,
473 * we want to let the queue drain all the way down to
474 * avoid seeking between async threads
476 if (!strcmp(td->io_ops->name, "syslet-rw") && !td_random(td))
479 o->iodepth_low = o->iodepth;
483 * If batch number isn't set, default to the same as iodepth
485 if (o->iodepth_batch > o->iodepth || !o->iodepth_batch)
486 o->iodepth_batch = o->iodepth;
488 if (o->nr_files > td->files_index)
489 o->nr_files = td->files_index;
491 if (o->open_files > o->nr_files || !o->open_files)
492 o->open_files = o->nr_files;
494 if (((o->rate[0] + o->rate[1]) && (o->rate_iops[0] + o->rate_iops[1]))||
495 ((o->ratemin[0] + o->ratemin[1]) && (o->rate_iops_min[0] +
496 o->rate_iops_min[1]))) {
497 log_err("fio: rate and rate_iops are mutually exclusive\n");
500 if ((o->rate[0] < o->ratemin[0]) || (o->rate[1] < o->ratemin[1]) ||
501 (o->rate_iops[0] < o->rate_iops_min[0]) ||
502 (o->rate_iops[1] < o->rate_iops_min[1])) {
503 log_err("fio: minimum rate exceeds rate\n");
507 if (!o->timeout && o->time_based) {
508 log_err("fio: time_based requires a runtime/timeout setting\n");
510 ret = warnings_fatal;
513 if (o->fill_device && !o->size)
516 if (o->verify != VERIFY_NONE) {
517 if (td_write(td) && o->do_verify && o->numjobs > 1) {
518 log_info("Multiple writers may overwrite blocks that "
519 "belong to other jobs. This can cause "
520 "verification failures.\n");
521 ret = warnings_fatal;
524 o->refill_buffers = 1;
525 if (o->max_bs[DDIR_WRITE] != o->min_bs[DDIR_WRITE] &&
527 o->verify_interval = o->min_bs[DDIR_WRITE];
531 o->invalidate_cache = 0;
532 if (td->io_ops->flags & FIO_PIPEIO) {
533 log_info("fio: cannot pre-read files with an IO engine"
534 " that isn't seekable. Pre-read disabled.\n");
535 ret = warnings_fatal;
539 #ifndef FIO_HAVE_FDATASYNC
540 if (o->fdatasync_blocks) {
541 log_info("fio: this platform does not support fdatasync()"
542 " falling back to using fsync(). Use the 'fsync'"
543 " option instead of 'fdatasync' to get rid of"
545 o->fsync_blocks = o->fdatasync_blocks;
546 o->fdatasync_blocks = 0;
547 ret = warnings_fatal;
553 * Windows doesn't support O_DIRECT or O_SYNC with the _open interface,
554 * so fail if we're passed those flags
556 if ((td->io_ops->flags & FIO_SYNCIO) && (td->o.odirect || td->o.sync_io)) {
557 log_err("fio: Windows does not support direct or non-buffered io with"
558 " the synchronous ioengines. Use the 'windowsaio' ioengine"
559 " with 'direct=1' and 'iodepth=1' instead.\n");
565 * For fully compressible data, just zero them at init time.
566 * It's faster than repeatedly filling it.
568 if (td->o.compress_percentage == 100) {
569 td->o.zero_buffers = 1;
570 td->o.compress_percentage = 0;
577 * This function leaks the buffer
579 static char *to_kmg(unsigned int val)
581 char *buf = malloc(32);
582 char post[] = { 0, 'K', 'M', 'G', 'P', 'E', 0 };
593 snprintf(buf, 31, "%u%c", val, *p);
597 /* External engines are specified by "external:name.o") */
598 static const char *get_engine_name(const char *str)
600 char *p = strstr(str, ":");
606 strip_blank_front(&p);
611 static int exists_and_not_file(const char *filename)
615 if (lstat(filename, &sb) == -1)
618 /* \\.\ is the device namespace in Windows, where every file
619 * is a device node */
620 if (S_ISREG(sb.st_mode) && strncmp(filename, "\\\\.\\", 4) != 0)
626 static void td_fill_rand_seeds_os(struct thread_data *td)
628 os_random_seed(td->rand_seeds[0], &td->bsrange_state);
629 os_random_seed(td->rand_seeds[1], &td->verify_state);
630 os_random_seed(td->rand_seeds[2], &td->rwmix_state);
632 if (td->o.file_service_type == FIO_FSERVICE_RANDOM)
633 os_random_seed(td->rand_seeds[3], &td->next_file_state);
635 os_random_seed(td->rand_seeds[5], &td->file_size_state);
636 os_random_seed(td->rand_seeds[6], &td->trim_state);
641 if (td->o.rand_repeatable)
642 td->rand_seeds[4] = FIO_RANDSEED * td->thread_number;
644 os_random_seed(td->rand_seeds[4], &td->random_state);
647 static void td_fill_rand_seeds_internal(struct thread_data *td)
649 init_rand_seed(&td->__bsrange_state, td->rand_seeds[0]);
650 init_rand_seed(&td->__verify_state, td->rand_seeds[1]);
651 init_rand_seed(&td->__rwmix_state, td->rand_seeds[2]);
653 if (td->o.file_service_type == FIO_FSERVICE_RANDOM)
654 init_rand_seed(&td->__next_file_state, td->rand_seeds[3]);
656 init_rand_seed(&td->__file_size_state, td->rand_seeds[5]);
657 init_rand_seed(&td->__trim_state, td->rand_seeds[6]);
662 if (td->o.rand_repeatable)
663 td->rand_seeds[4] = FIO_RANDSEED * td->thread_number;
665 init_rand_seed(&td->__random_state, td->rand_seeds[4]);
668 void td_fill_rand_seeds(struct thread_data *td)
670 if (td->o.use_os_rand)
671 td_fill_rand_seeds_os(td);
673 td_fill_rand_seeds_internal(td);
675 init_rand_seed(&td->buf_state, td->rand_seeds[7]);
680 * Initializes the ioengine configured for a job, if it has not been done so
683 int ioengine_load(struct thread_data *td)
688 * Engine has already been loaded.
693 engine = get_engine_name(td->o.ioengine);
694 td->io_ops = load_ioengine(td, engine);
696 log_err("fio: failed to load engine %s\n", engine);
700 if (td->io_ops->option_struct_size && td->io_ops->options) {
702 * In cases where td->eo is set, clone it for a child thread.
703 * This requires that the parent thread has the same ioengine,
704 * but that requirement must be enforced by the code which
707 void *origeo = td->eo;
709 * Otherwise use the default thread options.
711 if (!origeo && td != &def_thread && def_thread.eo &&
712 def_thread.io_ops->options == td->io_ops->options)
713 origeo = def_thread.eo;
715 options_init(td->io_ops->options);
716 td->eo = malloc(td->io_ops->option_struct_size);
718 * Use the default thread as an option template if this uses the
719 * same options structure and there are non-default options
723 memcpy(td->eo, origeo, td->io_ops->option_struct_size);
724 options_mem_dupe(td->eo, td->io_ops->options);
726 memset(td->eo, 0, td->io_ops->option_struct_size);
727 fill_default_options(td->eo, td->io_ops->options);
729 *(struct thread_data **)td->eo = td;
736 * Adds a job to the list of things todo. Sanitizes the various options
737 * to make sure we don't have conflicts, and initializes various
740 static int add_job(struct thread_data *td, const char *jobname, int job_add_num)
742 const char *ddir_str[] = { NULL, "read", "write", "rw", NULL,
743 "randread", "randwrite", "randrw" };
745 char fname[PATH_MAX];
746 int numjobs, file_alloced;
749 * the def_thread is just for options, it's not a real job
751 if (td == &def_thread)
755 * if we are just dumping the output command line, don't add the job
762 if (profile_td_init(td))
765 if (ioengine_load(td))
768 if (td->o.use_thread)
774 td->io_ops->flags |= FIO_RAWIO;
777 if (!td->o.filename && !td->files_index && !td->o.read_iolog_file) {
780 if (td->o.nr_files == 1 && exists_and_not_file(jobname))
781 add_file(td, jobname);
783 for (i = 0; i < td->o.nr_files; i++) {
784 sprintf(fname, "%s.%d.%d", jobname,
785 td->thread_number, i);
791 if (fixup_options(td))
797 * IO engines only need this for option callbacks, and the address may
798 * change in subprocesses.
801 *(struct thread_data **)td->eo = NULL;
803 if (td->io_ops->flags & FIO_DISKLESSIO) {
806 for_each_file(td, f, i)
807 f->real_file_size = -1ULL;
810 td->mutex = fio_mutex_init(0);
812 td->ts.clat_percentiles = td->o.clat_percentiles;
813 if (td->o.overwrite_plist)
814 memcpy(td->ts.percentile_list, td->o.percentile_list, sizeof(td->o.percentile_list));
816 memcpy(td->ts.percentile_list, def_percentile_list, sizeof(def_percentile_list));
818 td->ts.clat_stat[0].min_val = td->ts.clat_stat[1].min_val = ULONG_MAX;
819 td->ts.slat_stat[0].min_val = td->ts.slat_stat[1].min_val = ULONG_MAX;
820 td->ts.lat_stat[0].min_val = td->ts.lat_stat[1].min_val = ULONG_MAX;
821 td->ts.bw_stat[0].min_val = td->ts.bw_stat[1].min_val = ULONG_MAX;
822 td->ddir_seq_nr = td->o.ddir_seq_nr;
824 if ((td->o.stonewall || td->o.new_group) && prev_group_jobs) {
829 td->groupid = groupid;
832 if (init_random_state(td, td->rand_seeds, sizeof(td->rand_seeds))) {
833 td_verror(td, errno, "init_random_state");
840 if (td->o.write_lat_log) {
841 setup_log(&td->lat_log, td->o.log_avg_msec);
842 setup_log(&td->slat_log, td->o.log_avg_msec);
843 setup_log(&td->clat_log, td->o.log_avg_msec);
845 if (td->o.write_bw_log)
846 setup_log(&td->bw_log, td->o.log_avg_msec);
847 if (td->o.write_iops_log)
848 setup_log(&td->iops_log, td->o.log_avg_msec);
851 td->o.name = strdup(jobname);
855 if (!strcmp(td->io_ops->name, "cpuio")) {
856 log_info("%s: ioengine=cpu, cpuload=%u,"
857 " cpucycle=%u\n", td->o.name,
861 char *c1, *c2, *c3, *c4;
863 c1 = to_kmg(td->o.min_bs[DDIR_READ]);
864 c2 = to_kmg(td->o.max_bs[DDIR_READ]);
865 c3 = to_kmg(td->o.min_bs[DDIR_WRITE]);
866 c4 = to_kmg(td->o.max_bs[DDIR_WRITE]);
868 log_info("%s: (g=%d): rw=%s, bs=%s-%s/%s-%s,"
869 " ioengine=%s, iodepth=%u\n",
870 td->o.name, td->groupid,
871 ddir_str[td->o.td_ddir],
881 } else if (job_add_num == 1)
886 * recurse add identical jobs, clear numjobs and stonewall options
887 * as they don't apply to sub-jobs
889 numjobs = td->o.numjobs;
891 struct thread_data *td_new = get_new_job(0, td, 1);
896 td_new->o.numjobs = 1;
897 td_new->o.stonewall = 0;
898 td_new->o.new_group = 0;
901 td_new->o.filename = NULL;
902 td_new->files_index = 0;
903 td_new->files_size = 0;
904 td_new->files = NULL;
907 job_add_num = numjobs - 1;
909 if (add_job(td_new, jobname, job_add_num))
920 * Parse as if 'o' was a command line
922 void add_job_opts(const char **o)
924 struct thread_data *td, *td_parent;
925 int i, in_global = 1;
929 td_parent = td = NULL;
931 if (!strncmp(o[i], "name", 4)) {
934 add_job(td, jobname, 0);
936 sprintf(jobname, "%s", o[i] + 5);
938 if (in_global && !td_parent)
939 td_parent = get_new_job(1, &def_thread, 0);
940 else if (!in_global && !td) {
942 td_parent = &def_thread;
943 td = get_new_job(0, td_parent, 0);
946 fio_options_parse(td_parent, (char **) &o[i], 1);
948 fio_options_parse(td, (char **) &o[i], 1);
953 add_job(td, jobname, 0);
956 static int skip_this_section(const char *name)
960 if (!nr_job_sections)
962 if (!strncmp(name, "global", 6))
965 for (i = 0; i < nr_job_sections; i++)
966 if (!strcmp(job_sections[i], name))
972 static int is_empty_or_comment(char *line)
976 for (i = 0; i < strlen(line); i++) {
981 if (!isspace((int) line[i]) && !iscntrl((int) line[i]))
989 * This is our [ini] type file parser.
991 int parse_jobs_ini(char *file, int is_buf, int stonewall_flag)
994 struct thread_data *td;
998 int ret = 0, stonewall;
1001 int inside_skip = 0;
1003 int i, alloc_opts, num_opts;
1008 if (!strcmp(file, "-"))
1011 f = fopen(file, "r");
1014 perror("fopen job file");
1019 string = malloc(4096);
1022 * it's really 256 + small bit, 280 should suffice
1025 memset(name, 0, 280);
1028 opts = malloc(sizeof(char *) * alloc_opts);
1031 stonewall = stonewall_flag;
1034 * if skip_fgets is set, we already have loaded a line we
1039 p = strsep(&file, "\n");
1041 p = fgets(string, 4096, f);
1047 strip_blank_front(&p);
1050 if (is_empty_or_comment(p))
1052 if (sscanf(p, "[%255[^\n]]", name) != 1) {
1055 log_err("fio: option <%s> outside of [] job section\n",
1060 name[strlen(name) - 1] = '\0';
1062 if (skip_this_section(name)) {
1068 global = !strncmp(name, "global", 6);
1074 log_info("--name=%s ", name);
1078 td = get_new_job(global, &def_thread, 0);
1085 * Seperate multiple job files by a stonewall
1087 if (!global && stonewall) {
1088 td->o.stonewall = stonewall;
1093 memset(opts, 0, alloc_opts * sizeof(char *));
1097 p = strsep(&file, "\n");
1099 p = fgets(string, 4096, f);
1103 if (is_empty_or_comment(p))
1106 strip_blank_front(&p);
1109 * new section, break out and make sure we don't
1110 * fgets() a new line at the top.
1119 if (num_opts == alloc_opts) {
1121 opts = realloc(opts,
1122 alloc_opts * sizeof(char *));
1125 opts[num_opts] = strdup(p);
1129 ret = fio_options_parse(td, opts, num_opts);
1132 for (i = 0; i < num_opts; i++)
1133 log_info("--%s ", opts[i]);
1135 ret = add_job(td, name, 0);
1137 log_err("fio: job %s dropped\n", name);
1141 for (i = 0; i < num_opts; i++)
1150 while (i < nr_job_sections) {
1151 free(job_sections[i]);
1155 for (i = 0; i < num_opts; i++)
1161 if (!is_buf && f != stdin)
1166 static int fill_def_thread(void)
1168 memset(&def_thread, 0, sizeof(def_thread));
1170 fio_getaffinity(getpid(), &def_thread.o.cpumask);
1171 def_thread.o.timeout = def_timeout;
1174 * fill default options
1176 fio_fill_default_options(&def_thread);
1180 static void usage(const char *name)
1182 printf("%s\n", fio_version_string);
1183 printf("%s [options] [job options] <job file(s)>\n", name);
1184 printf(" --debug=options\tEnable debug logging. May be one/more of:\n"
1185 "\t\t\tprocess,file,io,mem,blktrace,verify,random,parse,\n"
1186 "\t\t\tdiskutil,job,mutex,profile,time,net\n");
1187 printf(" --output\t\tWrite output to file\n");
1188 printf(" --timeout\t\tRuntime in seconds\n");
1189 printf(" --latency-log\t\tGenerate per-job latency logs\n");
1190 printf(" --bandwidth-log\tGenerate per-job bandwidth logs\n");
1191 printf(" --minimal\t\tMinimal (terse) output\n");
1192 printf(" --version\t\tPrint version info and exit\n");
1193 printf(" --terse-version=x\tSet terse version output format to 'x'\n");
1194 printf(" --help\t\tPrint this page\n");
1195 printf(" --cmdhelp=cmd\t\tPrint command help, \"all\" for all of"
1197 printf(" --enghelp=engine\tPrint ioengine help, or list"
1198 " available ioengines\n");
1199 printf(" --enghelp=engine,cmd\tPrint help for an ioengine"
1201 printf(" --showcmd\t\tTurn a job file into command line options\n");
1202 printf(" --eta=when\t\tWhen ETA estimate should be printed\n");
1203 printf(" \t\tMay be \"always\", \"never\" or \"auto\"\n");
1204 printf(" --readonly\t\tTurn on safety read-only checks, preventing"
1206 printf(" --section=name\tOnly run specified section in job file\n");
1207 printf(" --alloc-size=kb\tSet smalloc pool to this size in kb"
1209 printf(" --warnings-fatal\tFio parser warnings are fatal\n");
1210 printf(" --max-jobs=nr\t\tMaximum number of threads/processes to support\n");
1211 printf(" --server=args\t\tStart a backend fio server\n");
1212 printf(" --daemonize=pidfile\tBackground fio server, write pid to file\n");
1213 printf(" --client=hostname\tTalk to remote backend fio server at hostname\n");
1214 printf("\nFio was written by Jens Axboe <jens.axboe@oracle.com>");
1215 printf("\n Jens Axboe <jaxboe@fusionio.com>\n");
1218 #ifdef FIO_INC_DEBUG
1219 struct debug_level debug_levels[] = {
1220 { .name = "process", .shift = FD_PROCESS, },
1221 { .name = "file", .shift = FD_FILE, },
1222 { .name = "io", .shift = FD_IO, },
1223 { .name = "mem", .shift = FD_MEM, },
1224 { .name = "blktrace", .shift = FD_BLKTRACE },
1225 { .name = "verify", .shift = FD_VERIFY },
1226 { .name = "random", .shift = FD_RANDOM },
1227 { .name = "parse", .shift = FD_PARSE },
1228 { .name = "diskutil", .shift = FD_DISKUTIL },
1229 { .name = "job", .shift = FD_JOB },
1230 { .name = "mutex", .shift = FD_MUTEX },
1231 { .name = "profile", .shift = FD_PROFILE },
1232 { .name = "time", .shift = FD_TIME },
1233 { .name = "net", .shift = FD_NET },
1237 static int set_debug(const char *string)
1239 struct debug_level *dl;
1240 char *p = (char *) string;
1244 if (!strcmp(string, "?") || !strcmp(string, "help")) {
1245 log_info("fio: dumping debug options:");
1246 for (i = 0; debug_levels[i].name; i++) {
1247 dl = &debug_levels[i];
1248 log_info("%s,", dl->name);
1254 while ((opt = strsep(&p, ",")) != NULL) {
1257 if (!strncmp(opt, "all", 3)) {
1258 log_info("fio: set all debug options\n");
1263 for (i = 0; debug_levels[i].name; i++) {
1264 dl = &debug_levels[i];
1265 found = !strncmp(opt, dl->name, strlen(dl->name));
1269 if (dl->shift == FD_JOB) {
1270 opt = strchr(opt, ':');
1272 log_err("fio: missing job number\n");
1276 fio_debug_jobno = atoi(opt);
1277 log_info("fio: set debug jobno %d\n",
1280 log_info("fio: set debug option %s\n", opt);
1281 fio_debug |= (1UL << dl->shift);
1287 log_err("fio: debug mask %s not found\n", opt);
1292 static int set_debug(const char *string)
1294 log_err("fio: debug tracing not included in build\n");
1299 static void fio_options_fill_optstring(void)
1301 char *ostr = cmd_optstr;
1305 while (l_opts[i].name) {
1306 ostr[c++] = l_opts[i].val;
1307 if (l_opts[i].has_arg == required_argument)
1309 else if (l_opts[i].has_arg == optional_argument) {
1318 static int client_flag_set(char c)
1323 while (l_opts[i].name) {
1324 int val = l_opts[i].val;
1326 if (c == (val & 0xff))
1327 return (val & FIO_CLIENT_FLAG);
1335 void parse_cmd_client(void *client, char *opt)
1337 fio_client_add_cmd_option(client, opt);
1340 int parse_cmd_line(int argc, char *argv[])
1342 struct thread_data *td = NULL;
1343 int c, ini_idx = 0, lidx, ret = 0, do_exit = 0, exit_val = 0;
1344 char *ostr = cmd_optstr;
1345 void *pid_file = NULL;
1346 void *cur_client = NULL;
1350 * Reset optind handling, since we may call this multiple times
1355 while ((c = getopt_long_only(argc, argv, ostr, l_opts, &lidx)) != -1) {
1358 if ((c & FIO_CLIENT_FLAG) || client_flag_set(c)) {
1359 parse_cmd_client(cur_client, argv[optind - 1]);
1360 c &= ~FIO_CLIENT_FLAG;
1365 smalloc_pool_size = atoi(optarg);
1368 def_timeout = atoi(optarg);
1377 f_out = fopen(optarg, "w+");
1379 perror("fopen output");
1395 fio_show_option_help(optarg);
1401 fio_show_ioengine_help(optarg);
1413 log_info("%s\n", fio_version_string);
1418 terse_version = atoi(optarg);
1419 if (!(terse_version == 2 || terse_version == 3)) {
1420 log_err("fio: bad terse version format\n");
1426 if (!strcmp("always", optarg))
1427 eta_print = FIO_ETA_ALWAYS;
1428 else if (!strcmp("never", optarg))
1429 eta_print = FIO_ETA_NEVER;
1432 if (set_debug(optarg))
1438 if (!strcmp(optarg, "global")) {
1439 log_err("fio: can't use global as only "
1445 new_size = (nr_job_sections + 1) * sizeof(char *);
1446 job_sections = realloc(job_sections, new_size);
1447 job_sections[nr_job_sections] = strdup(optarg);
1452 exec_profile = strdup(optarg);
1454 case FIO_GETOPT_JOB: {
1455 const char *opt = l_opts[lidx].name;
1458 if (!strncmp(opt, "name", 4) && td) {
1459 ret = add_job(td, td->o.name ?: "fio", 0);
1465 int is_section = !strncmp(opt, "name", 4);
1468 if (!is_section || !strncmp(val, "global", 6))
1471 if (is_section && skip_this_section(val))
1474 td = get_new_job(global, &def_thread, 1);
1475 if (!td || ioengine_load(td))
1477 fio_options_set_ioengine_opts(l_opts, td);
1480 ret = fio_cmd_option_parse(td, opt, val);
1482 if (!ret && !strcmp(opt, "ioengine")) {
1484 if (ioengine_load(td))
1486 fio_options_set_ioengine_opts(l_opts, td);
1490 case FIO_GETOPT_IOENGINE: {
1491 const char *opt = l_opts[lidx].name;
1493 opt = l_opts[lidx].name;
1495 ret = fio_cmd_ioengine_option_parse(td, opt, val);
1502 max_jobs = atoi(optarg);
1503 if (!max_jobs || max_jobs > REAL_MAX_JOBS) {
1504 log_err("fio: invalid max jobs: %d\n", max_jobs);
1511 log_err("fio: can't be both client and server\n");
1517 fio_server_set_arg(optarg);
1522 pid_file = strdup(optarg);
1526 log_err("fio: can't be both client and server\n");
1531 if (fio_client_add(optarg, &cur_client)) {
1532 log_err("fio: failed adding client %s\n", optarg);
1548 if (exit_val && !(is_backend || nr_clients))
1552 if (nr_clients && fio_clients_connect()) {
1558 if (is_backend && backend)
1559 return fio_start_server(pid_file);
1563 ret = add_job(td, td->o.name ?: "fio", 0);
1566 while (!ret && optind < argc) {
1568 ini_file = realloc(ini_file, ini_idx * sizeof(char *));
1569 ini_file[ini_idx - 1] = strdup(argv[optind]);
1576 int parse_options(int argc, char *argv[])
1583 fio_options_fill_optstring();
1584 fio_options_dup_and_init(l_opts);
1588 if (fill_def_thread())
1591 job_files = parse_cmd_line(argc, argv);
1593 if (job_files > 0) {
1594 for (i = 0; i < job_files; i++) {
1595 if (fill_def_thread())
1598 if (fio_clients_send_ini(ini_file[i]))
1601 } else if (!is_backend) {
1602 if (parse_jobs_ini(ini_file[i], 0, i))
1610 fio_options_free(&def_thread);
1612 if (!thread_number) {
1617 if (is_backend || nr_clients)
1622 log_err("No jobs(s) defined\n\n");
1632 if (def_thread.o.gtod_offload) {
1634 fio_gtod_offload = 1;
1635 fio_gtod_cpu = def_thread.o.gtod_cpu;
1639 log_info("%s\n", fio_version_string);