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 char *fio_uint_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,
743 int recursed, int client_type)
746 char fname[PATH_MAX];
747 int numjobs, file_alloced;
750 * the def_thread is just for options, it's not a real job
752 if (td == &def_thread)
756 * if we are just dumping the output command line, don't add the job
763 td->client_type = client_type;
765 if (profile_td_init(td))
768 if (ioengine_load(td))
772 td->io_ops->flags |= FIO_RAWIO;
775 if (!td->o.filename && !td->files_index && !td->o.read_iolog_file) {
778 if (td->o.nr_files == 1 && exists_and_not_file(jobname))
779 add_file(td, jobname);
781 for (i = 0; i < td->o.nr_files; i++) {
782 sprintf(fname, "%s.%d.%d", jobname,
783 td->thread_number, i);
789 if (fixup_options(td))
795 * IO engines only need this for option callbacks, and the address may
796 * change in subprocesses.
799 *(struct thread_data **)td->eo = NULL;
801 if (td->io_ops->flags & FIO_DISKLESSIO) {
804 for_each_file(td, f, i)
805 f->real_file_size = -1ULL;
808 td->mutex = fio_mutex_init(0);
810 td->ts.clat_percentiles = td->o.clat_percentiles;
811 if (td->o.overwrite_plist)
812 memcpy(td->ts.percentile_list, td->o.percentile_list, sizeof(td->o.percentile_list));
814 memcpy(td->ts.percentile_list, def_percentile_list, sizeof(def_percentile_list));
816 td->ts.clat_stat[0].min_val = td->ts.clat_stat[1].min_val = ULONG_MAX;
817 td->ts.slat_stat[0].min_val = td->ts.slat_stat[1].min_val = ULONG_MAX;
818 td->ts.lat_stat[0].min_val = td->ts.lat_stat[1].min_val = ULONG_MAX;
819 td->ts.bw_stat[0].min_val = td->ts.bw_stat[1].min_val = ULONG_MAX;
820 td->ddir_seq_nr = td->o.ddir_seq_nr;
822 if ((td->o.stonewall || td->o.new_group) && prev_group_jobs) {
827 td->groupid = groupid;
830 if (init_random_state(td, td->rand_seeds, sizeof(td->rand_seeds))) {
831 td_verror(td, errno, "init_random_state");
838 if (td->o.write_lat_log) {
839 setup_log(&td->lat_log, td->o.log_avg_msec, IO_LOG_TYPE_LAT);
840 setup_log(&td->slat_log, td->o.log_avg_msec, IO_LOG_TYPE_SLAT);
841 setup_log(&td->clat_log, td->o.log_avg_msec, IO_LOG_TYPE_CLAT);
843 if (td->o.write_bw_log)
844 setup_log(&td->bw_log, td->o.log_avg_msec, IO_LOG_TYPE_BW);
845 if (td->o.write_iops_log)
846 setup_log(&td->iops_log, td->o.log_avg_msec, IO_LOG_TYPE_IOPS);
849 td->o.name = strdup(jobname);
853 if (is_backend && !recursed)
854 fio_server_send_add_job(td);
856 if (!(td->io_ops->flags & FIO_NOIO)) {
857 char *c1, *c2, *c3, *c4;
859 c1 = fio_uint_to_kmg(td->o.min_bs[DDIR_READ]);
860 c2 = fio_uint_to_kmg(td->o.max_bs[DDIR_READ]);
861 c3 = fio_uint_to_kmg(td->o.min_bs[DDIR_WRITE]);
862 c4 = fio_uint_to_kmg(td->o.max_bs[DDIR_WRITE]);
864 log_info("%s: (g=%d): rw=%s, bs=%s-%s/%s-%s,"
865 " ioengine=%s, iodepth=%u\n",
866 td->o.name, td->groupid,
867 ddir_str(td->o.td_ddir),
877 } else if (job_add_num == 1)
882 * recurse add identical jobs, clear numjobs and stonewall options
883 * as they don't apply to sub-jobs
885 numjobs = td->o.numjobs;
887 struct thread_data *td_new = get_new_job(0, td, 1);
892 td_new->o.numjobs = 1;
893 td_new->o.stonewall = 0;
894 td_new->o.new_group = 0;
897 td_new->o.filename = NULL;
898 td_new->files_index = 0;
899 td_new->files_size = 0;
900 td_new->files = NULL;
903 job_add_num = numjobs - 1;
905 if (add_job(td_new, jobname, job_add_num, 1, client_type))
916 * Parse as if 'o' was a command line
918 void add_job_opts(const char **o, int client_type)
920 struct thread_data *td, *td_parent;
921 int i, in_global = 1;
925 td_parent = td = NULL;
927 if (!strncmp(o[i], "name", 4)) {
930 add_job(td, jobname, 0, 0, client_type);
932 sprintf(jobname, "%s", o[i] + 5);
934 if (in_global && !td_parent)
935 td_parent = get_new_job(1, &def_thread, 0);
936 else if (!in_global && !td) {
938 td_parent = &def_thread;
939 td = get_new_job(0, td_parent, 0);
942 fio_options_parse(td_parent, (char **) &o[i], 1);
944 fio_options_parse(td, (char **) &o[i], 1);
949 add_job(td, jobname, 0, 0, client_type);
952 static int skip_this_section(const char *name)
956 if (!nr_job_sections)
958 if (!strncmp(name, "global", 6))
961 for (i = 0; i < nr_job_sections; i++)
962 if (!strcmp(job_sections[i], name))
968 static int is_empty_or_comment(char *line)
972 for (i = 0; i < strlen(line); i++) {
977 if (!isspace((int) line[i]) && !iscntrl((int) line[i]))
985 * This is our [ini] type file parser.
987 int parse_jobs_ini(char *file, int is_buf, int stonewall_flag, int type)
990 struct thread_data *td;
994 int ret = 0, stonewall;
999 int i, alloc_opts, num_opts;
1004 if (!strcmp(file, "-"))
1007 f = fopen(file, "r");
1010 perror("fopen job file");
1015 string = malloc(4096);
1018 * it's really 256 + small bit, 280 should suffice
1021 memset(name, 0, 280);
1024 opts = malloc(sizeof(char *) * alloc_opts);
1027 stonewall = stonewall_flag;
1030 * if skip_fgets is set, we already have loaded a line we
1035 p = strsep(&file, "\n");
1037 p = fgets(string, 4096, f);
1043 strip_blank_front(&p);
1046 if (is_empty_or_comment(p))
1048 if (sscanf(p, "[%255[^\n]]", name) != 1) {
1051 log_err("fio: option <%s> outside of [] job section\n",
1056 name[strlen(name) - 1] = '\0';
1058 if (skip_this_section(name)) {
1064 global = !strncmp(name, "global", 6);
1070 log_info("--name=%s ", name);
1074 td = get_new_job(global, &def_thread, 0);
1081 * Seperate multiple job files by a stonewall
1083 if (!global && stonewall) {
1084 td->o.stonewall = stonewall;
1089 memset(opts, 0, alloc_opts * sizeof(char *));
1093 p = strsep(&file, "\n");
1095 p = fgets(string, 4096, f);
1099 if (is_empty_or_comment(p))
1102 strip_blank_front(&p);
1105 * new section, break out and make sure we don't
1106 * fgets() a new line at the top.
1115 if (num_opts == alloc_opts) {
1117 opts = realloc(opts,
1118 alloc_opts * sizeof(char *));
1121 opts[num_opts] = strdup(p);
1125 ret = fio_options_parse(td, opts, num_opts);
1128 for (i = 0; i < num_opts; i++)
1129 log_info("--%s ", opts[i]);
1131 ret = add_job(td, name, 0, 0, type);
1133 log_err("fio: job %s dropped\n", name);
1137 for (i = 0; i < num_opts; i++)
1146 while (i < nr_job_sections) {
1147 free(job_sections[i]);
1151 for (i = 0; i < num_opts; i++)
1157 if (!is_buf && f != stdin)
1162 static int fill_def_thread(void)
1164 memset(&def_thread, 0, sizeof(def_thread));
1166 fio_getaffinity(getpid(), &def_thread.o.cpumask);
1167 def_thread.o.timeout = def_timeout;
1170 * fill default options
1172 fio_fill_default_options(&def_thread);
1176 static void usage(const char *name)
1178 printf("%s\n", fio_version_string);
1179 printf("%s [options] [job options] <job file(s)>\n", name);
1180 printf(" --debug=options\tEnable debug logging. May be one/more of:\n"
1181 "\t\t\tprocess,file,io,mem,blktrace,verify,random,parse,\n"
1182 "\t\t\tdiskutil,job,mutex,profile,time,net\n");
1183 printf(" --output\t\tWrite output to file\n");
1184 printf(" --timeout\t\tRuntime in seconds\n");
1185 printf(" --latency-log\t\tGenerate per-job latency logs\n");
1186 printf(" --bandwidth-log\tGenerate per-job bandwidth logs\n");
1187 printf(" --minimal\t\tMinimal (terse) output\n");
1188 printf(" --version\t\tPrint version info and exit\n");
1189 printf(" --terse-version=x\tSet terse version output format to 'x'\n");
1190 printf(" --help\t\tPrint this page\n");
1191 printf(" --cmdhelp=cmd\t\tPrint command help, \"all\" for all of"
1193 printf(" --enghelp=engine\tPrint ioengine help, or list"
1194 " available ioengines\n");
1195 printf(" --enghelp=engine,cmd\tPrint help for an ioengine"
1197 printf(" --showcmd\t\tTurn a job file into command line options\n");
1198 printf(" --eta=when\t\tWhen ETA estimate should be printed\n");
1199 printf(" \t\tMay be \"always\", \"never\" or \"auto\"\n");
1200 printf(" --readonly\t\tTurn on safety read-only checks, preventing"
1202 printf(" --section=name\tOnly run specified section in job file\n");
1203 printf(" --alloc-size=kb\tSet smalloc pool to this size in kb"
1205 printf(" --warnings-fatal\tFio parser warnings are fatal\n");
1206 printf(" --max-jobs=nr\t\tMaximum number of threads/processes to support\n");
1207 printf(" --server=args\t\tStart a backend fio server\n");
1208 printf(" --daemonize=pidfile\tBackground fio server, write pid to file\n");
1209 printf(" --client=hostname\tTalk to remote backend fio server at hostname\n");
1210 printf("\nFio was written by Jens Axboe <jens.axboe@oracle.com>");
1211 printf("\n Jens Axboe <jaxboe@fusionio.com>\n");
1214 #ifdef FIO_INC_DEBUG
1215 struct debug_level debug_levels[] = {
1216 { .name = "process",
1217 .help = "Process creation/exit logging",
1218 .shift = FD_PROCESS,
1221 .help = "File related action logging",
1225 .help = "IO and IO engine action logging (offsets, queue, completions, etc)",
1229 .help = "Memory allocation/freeing logging",
1232 { .name = "blktrace",
1233 .help = "blktrace action logging",
1234 .shift = FD_BLKTRACE,
1237 .help = "IO verification action logging",
1241 .help = "Random generation logging",
1245 .help = "Parser logging",
1248 { .name = "diskutil",
1249 .help = "Disk utility logging actions",
1250 .shift = FD_DISKUTIL,
1253 .help = "Logging related to creating/destroying jobs",
1257 .help = "Mutex logging",
1260 { .name = "profile",
1261 .help = "Logging related to profiles",
1262 .shift = FD_PROFILE,
1265 .help = "Logging related to time keeping functions",
1269 .help = "Network logging",
1275 static int set_debug(const char *string)
1277 struct debug_level *dl;
1278 char *p = (char *) string;
1282 if (!strcmp(string, "?") || !strcmp(string, "help")) {
1283 log_info("fio: dumping debug options:");
1284 for (i = 0; debug_levels[i].name; i++) {
1285 dl = &debug_levels[i];
1286 log_info("%s,", dl->name);
1292 while ((opt = strsep(&p, ",")) != NULL) {
1295 if (!strncmp(opt, "all", 3)) {
1296 log_info("fio: set all debug options\n");
1301 for (i = 0; debug_levels[i].name; i++) {
1302 dl = &debug_levels[i];
1303 found = !strncmp(opt, dl->name, strlen(dl->name));
1307 if (dl->shift == FD_JOB) {
1308 opt = strchr(opt, ':');
1310 log_err("fio: missing job number\n");
1314 fio_debug_jobno = atoi(opt);
1315 log_info("fio: set debug jobno %d\n",
1318 log_info("fio: set debug option %s\n", opt);
1319 fio_debug |= (1UL << dl->shift);
1325 log_err("fio: debug mask %s not found\n", opt);
1330 static int set_debug(const char *string)
1332 log_err("fio: debug tracing not included in build\n");
1337 static void fio_options_fill_optstring(void)
1339 char *ostr = cmd_optstr;
1343 while (l_opts[i].name) {
1344 ostr[c++] = l_opts[i].val;
1345 if (l_opts[i].has_arg == required_argument)
1347 else if (l_opts[i].has_arg == optional_argument) {
1356 static int client_flag_set(char c)
1361 while (l_opts[i].name) {
1362 int val = l_opts[i].val;
1364 if (c == (val & 0xff))
1365 return (val & FIO_CLIENT_FLAG);
1373 void parse_cmd_client(void *client, char *opt)
1375 fio_client_add_cmd_option(client, opt);
1378 int parse_cmd_line(int argc, char *argv[], int client_type)
1380 struct thread_data *td = NULL;
1381 int c, ini_idx = 0, lidx, ret = 0, do_exit = 0, exit_val = 0;
1382 char *ostr = cmd_optstr;
1383 void *pid_file = NULL;
1384 void *cur_client = NULL;
1388 * Reset optind handling, since we may call this multiple times
1393 while ((c = getopt_long_only(argc, argv, ostr, l_opts, &lidx)) != -1) {
1396 if ((c & FIO_CLIENT_FLAG) || client_flag_set(c)) {
1397 parse_cmd_client(cur_client, argv[optind - 1]);
1398 c &= ~FIO_CLIENT_FLAG;
1403 smalloc_pool_size = atoi(optarg);
1406 def_timeout = atoi(optarg);
1415 f_out = fopen(optarg, "w+");
1417 perror("fopen output");
1433 fio_show_option_help(optarg);
1439 fio_show_ioengine_help(optarg);
1451 log_info("%s\n", fio_version_string);
1456 terse_version = atoi(optarg);
1457 if (!(terse_version == 2 || terse_version == 3)) {
1458 log_err("fio: bad terse version format\n");
1464 if (!strcmp("always", optarg))
1465 eta_print = FIO_ETA_ALWAYS;
1466 else if (!strcmp("never", optarg))
1467 eta_print = FIO_ETA_NEVER;
1470 if (set_debug(optarg))
1476 if (!strcmp(optarg, "global")) {
1477 log_err("fio: can't use global as only "
1483 new_size = (nr_job_sections + 1) * sizeof(char *);
1484 job_sections = realloc(job_sections, new_size);
1485 job_sections[nr_job_sections] = strdup(optarg);
1490 exec_profile = strdup(optarg);
1492 case FIO_GETOPT_JOB: {
1493 const char *opt = l_opts[lidx].name;
1496 if (!strncmp(opt, "name", 4) && td) {
1497 ret = add_job(td, td->o.name ?: "fio", 0, 0, client_type);
1503 int is_section = !strncmp(opt, "name", 4);
1506 if (!is_section || !strncmp(val, "global", 6))
1509 if (is_section && skip_this_section(val))
1512 td = get_new_job(global, &def_thread, 1);
1513 if (!td || ioengine_load(td))
1515 fio_options_set_ioengine_opts(l_opts, td);
1518 ret = fio_cmd_option_parse(td, opt, val);
1520 if (!ret && !strcmp(opt, "ioengine")) {
1522 if (ioengine_load(td))
1524 fio_options_set_ioengine_opts(l_opts, td);
1528 case FIO_GETOPT_IOENGINE: {
1529 const char *opt = l_opts[lidx].name;
1531 opt = l_opts[lidx].name;
1533 ret = fio_cmd_ioengine_option_parse(td, opt, val);
1540 max_jobs = atoi(optarg);
1541 if (!max_jobs || max_jobs > REAL_MAX_JOBS) {
1542 log_err("fio: invalid max jobs: %d\n", max_jobs);
1549 log_err("fio: can't be both client and server\n");
1555 fio_server_set_arg(optarg);
1560 pid_file = strdup(optarg);
1564 log_err("fio: can't be both client and server\n");
1569 if (fio_client_add(&fio_client_ops, optarg, &cur_client)) {
1570 log_err("fio: failed adding client %s\n", optarg);
1586 if (exit_val && !(is_backend || nr_clients))
1590 if (nr_clients && fio_clients_connect()) {
1596 if (is_backend && backend)
1597 return fio_start_server(pid_file);
1601 ret = add_job(td, td->o.name ?: "fio", 0, 0, client_type);
1604 while (!ret && optind < argc) {
1606 ini_file = realloc(ini_file, ini_idx * sizeof(char *));
1607 ini_file[ini_idx - 1] = strdup(argv[optind]);
1614 int fio_init_options(void)
1619 fio_options_fill_optstring();
1620 fio_options_dup_and_init(l_opts);
1624 if (fill_def_thread())
1630 extern int fio_check_options(struct thread_options *);
1632 int parse_options(int argc, char *argv[])
1634 const int type = FIO_CLIENT_TYPE_CLI;
1637 if (fio_init_options())
1639 if (fio_test_cconv(&def_thread.o))
1640 log_err("fio: failed internal cconv test\n");
1642 job_files = parse_cmd_line(argc, argv, type);
1644 if (job_files > 0) {
1645 for (i = 0; i < job_files; i++) {
1646 if (fill_def_thread())
1649 if (fio_clients_send_ini(ini_file[i]))
1652 } else if (!is_backend) {
1653 if (parse_jobs_ini(ini_file[i], 0, i, type))
1661 fio_options_free(&def_thread);
1663 if (!thread_number) {
1668 if (is_backend || nr_clients)
1673 log_err("No jobs(s) defined\n\n");
1683 if (def_thread.o.gtod_offload) {
1685 fio_gtod_offload = 1;
1686 fio_gtod_cpu = def_thread.o.gtod_cpu;
1690 log_info("%s\n", fio_version_string);
1695 void options_default_fill(struct thread_options *o)
1697 memcpy(o, &def_thread.o, sizeof(*o));