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;
43 char **job_sections = NULL;
44 int nr_job_sections = 0;
45 char *exec_profile = NULL;
46 int warnings_fatal = 0;
47 int terse_version = 3;
55 static int write_lat_log;
57 static int prev_group_jobs;
59 unsigned long fio_debug = 0;
60 unsigned int fio_debug_jobno = -1;
61 unsigned int *fio_debug_jobp = NULL;
63 static char cmd_optstr[256];
66 const fio_fp64_t def_percentile_list[FIO_IO_U_LIST_MAX_LEN] = {
86 #define FIO_CLIENT_FLAG (1 << 16)
89 * Command line options. These will contain the above, plus a few
90 * extra that only pertain to fio itself and not jobs.
92 static struct option l_opts[FIO_NR_OPTIONS] = {
94 .name = (char *) "output",
95 .has_arg = required_argument,
96 .val = 'o' | FIO_CLIENT_FLAG,
99 .name = (char *) "timeout",
100 .has_arg = required_argument,
101 .val = 't' | FIO_CLIENT_FLAG,
104 .name = (char *) "latency-log",
105 .has_arg = required_argument,
106 .val = 'l' | FIO_CLIENT_FLAG,
109 .name = (char *) "bandwidth-log",
110 .has_arg = required_argument,
111 .val = 'b' | FIO_CLIENT_FLAG,
114 .name = (char *) "minimal",
115 .has_arg = optional_argument,
116 .val = 'm' | FIO_CLIENT_FLAG,
119 .name = (char *) "output-format",
120 .has_arg = optional_argument,
121 .val = 'F' | FIO_CLIENT_FLAG,
124 .name = (char *) "version",
125 .has_arg = no_argument,
126 .val = 'v' | FIO_CLIENT_FLAG,
129 .name = (char *) "help",
130 .has_arg = no_argument,
131 .val = 'h' | FIO_CLIENT_FLAG,
134 .name = (char *) "cmdhelp",
135 .has_arg = optional_argument,
136 .val = 'c' | FIO_CLIENT_FLAG,
139 .name = (char *) "enghelp",
140 .has_arg = optional_argument,
141 .val = 'i' | FIO_CLIENT_FLAG,
144 .name = (char *) "showcmd",
145 .has_arg = no_argument,
146 .val = 's' | FIO_CLIENT_FLAG,
149 .name = (char *) "readonly",
150 .has_arg = no_argument,
151 .val = 'r' | FIO_CLIENT_FLAG,
154 .name = (char *) "eta",
155 .has_arg = required_argument,
156 .val = 'e' | FIO_CLIENT_FLAG,
159 .name = (char *) "debug",
160 .has_arg = required_argument,
161 .val = 'd' | FIO_CLIENT_FLAG,
164 .name = (char *) "section",
165 .has_arg = required_argument,
166 .val = 'x' | FIO_CLIENT_FLAG,
169 .name = (char *) "alloc-size",
170 .has_arg = required_argument,
171 .val = 'a' | FIO_CLIENT_FLAG,
174 .name = (char *) "profile",
175 .has_arg = required_argument,
176 .val = 'p' | FIO_CLIENT_FLAG,
179 .name = (char *) "warnings-fatal",
180 .has_arg = no_argument,
181 .val = 'w' | FIO_CLIENT_FLAG,
184 .name = (char *) "max-jobs",
185 .has_arg = required_argument,
186 .val = 'j' | FIO_CLIENT_FLAG,
189 .name = (char *) "terse-version",
190 .has_arg = required_argument,
191 .val = 'V' | FIO_CLIENT_FLAG,
194 .name = (char *) "server",
195 .has_arg = optional_argument,
198 { .name = (char *) "daemonize",
199 .has_arg = required_argument,
203 .name = (char *) "client",
204 .has_arg = required_argument,
212 void free_threads_shm(void)
214 struct shmid_ds sbuf;
221 shmctl(shm_id, IPC_RMID, &sbuf);
231 fio_debug_jobp = NULL;
239 * The thread area is shared between the main process and the job
240 * threads/processes. So setup a shared memory segment that will hold
241 * all the job info. We use the end of the region for keeping track of
242 * open files across jobs, for file sharing.
244 static int setup_thread_area(void)
252 * 1024 is too much on some machines, scale max_jobs if
253 * we get a failure that looks like too large a shm segment
256 size_t size = max_jobs * sizeof(struct thread_data);
258 size += file_hash_size;
259 size += sizeof(unsigned int);
261 shm_id = shmget(0, size, IPC_CREAT | 0600);
264 if (errno != EINVAL && errno != ENOMEM && errno != ENOSPC) {
275 threads = shmat(shm_id, NULL, 0);
276 if (threads == (void *) -1) {
281 memset(threads, 0, max_jobs * sizeof(struct thread_data));
282 hash = (void *) threads + max_jobs * sizeof(struct thread_data);
283 fio_debug_jobp = (void *) hash + file_hash_size;
284 *fio_debug_jobp = -1;
285 file_hash_init(hash);
293 * Return a free job structure.
295 static struct thread_data *get_new_job(int global, struct thread_data *parent,
298 struct thread_data *td;
302 if (setup_thread_area()) {
303 log_err("error: failed to setup shm segment\n");
306 if (thread_number >= max_jobs) {
307 log_err("error: maximum number of jobs (%d) reached.\n",
312 td = &threads[thread_number++];
319 td->o.uid = td->o.gid = -1U;
321 dup_files(td, parent);
322 fio_options_mem_dupe(td);
324 profile_add_hooks(td);
326 td->thread_number = thread_number;
330 static void put_job(struct thread_data *td)
332 if (td == &def_thread)
339 log_info("fio: %s\n", td->verror);
341 fio_options_free(td);
345 memset(&threads[td->thread_number - 1], 0, sizeof(*td));
349 static int __setup_rate(struct thread_data *td, enum fio_ddir ddir)
351 unsigned int bs = td->o.min_bs[ddir];
353 assert(ddir_rw(ddir));
355 if (td->o.rate[ddir])
356 td->rate_bps[ddir] = td->o.rate[ddir];
358 td->rate_bps[ddir] = td->o.rate_iops[ddir] * bs;
360 if (!td->rate_bps[ddir]) {
361 log_err("rate lower than supported\n");
365 td->rate_pending_usleep[ddir] = 0;
369 static int setup_rate(struct thread_data *td)
373 if (td->o.rate[DDIR_READ] || td->o.rate_iops[DDIR_READ])
374 ret = __setup_rate(td, DDIR_READ);
375 if (td->o.rate[DDIR_WRITE] || td->o.rate_iops[DDIR_WRITE])
376 ret |= __setup_rate(td, DDIR_WRITE);
377 if (td->o.rate[DDIR_TRIM] || td->o.rate_iops[DDIR_TRIM])
378 ret |= __setup_rate(td, DDIR_TRIM);
383 static int fixed_block_size(struct thread_options *o)
385 return o->min_bs[DDIR_READ] == o->max_bs[DDIR_READ] &&
386 o->min_bs[DDIR_WRITE] == o->max_bs[DDIR_WRITE] &&
387 o->min_bs[DDIR_TRIM] == o->max_bs[DDIR_TRIM] &&
388 o->min_bs[DDIR_READ] == o->min_bs[DDIR_WRITE] &&
389 o->min_bs[DDIR_READ] == o->min_bs[DDIR_TRIM];
393 * Lazy way of fixing up options that depend on each other. We could also
394 * define option callback handlers, but this is easier.
396 static int fixup_options(struct thread_data *td)
398 struct thread_options *o = &td->o;
401 #ifndef FIO_HAVE_PSHARED_MUTEX
402 if (!o->use_thread) {
403 log_info("fio: this platform does not support process shared"
404 " mutexes, forcing use of threads. Use the 'thread'"
405 " option to get rid of this warning.\n");
407 ret = warnings_fatal;
411 if (o->write_iolog_file && o->read_iolog_file) {
412 log_err("fio: read iolog overrides write_iolog\n");
413 free(o->write_iolog_file);
414 o->write_iolog_file = NULL;
415 ret = warnings_fatal;
419 * only really works with 1 file
421 if (o->zone_size && o->open_files == 1)
425 * If zone_range isn't specified, backward compatibility dictates it
426 * should be made equal to zone_size.
428 if (o->zone_size && !o->zone_range)
429 o->zone_range = o->zone_size;
432 * Reads can do overwrites, we always need to pre-create the file
434 if (td_read(td) || td_rw(td))
437 if (!o->min_bs[DDIR_READ])
438 o->min_bs[DDIR_READ] = o->bs[DDIR_READ];
439 if (!o->max_bs[DDIR_READ])
440 o->max_bs[DDIR_READ] = o->bs[DDIR_READ];
441 if (!o->min_bs[DDIR_WRITE])
442 o->min_bs[DDIR_WRITE] = o->bs[DDIR_WRITE];
443 if (!o->max_bs[DDIR_WRITE])
444 o->max_bs[DDIR_WRITE] = o->bs[DDIR_WRITE];
445 if (!o->min_bs[DDIR_TRIM])
446 o->min_bs[DDIR_TRIM] = o->bs[DDIR_TRIM];
447 if (!o->max_bs[DDIR_TRIM])
448 o->max_bs[DDIR_TRIM] = o->bs[DDIR_TRIM];
451 o->rw_min_bs = min(o->min_bs[DDIR_READ], o->min_bs[DDIR_WRITE]);
452 o->rw_min_bs = min(o->min_bs[DDIR_TRIM], o->rw_min_bs);
455 * For random IO, allow blockalign offset other than min_bs.
457 if (!o->ba[DDIR_READ] || !td_random(td))
458 o->ba[DDIR_READ] = o->min_bs[DDIR_READ];
459 if (!o->ba[DDIR_WRITE] || !td_random(td))
460 o->ba[DDIR_WRITE] = o->min_bs[DDIR_WRITE];
461 if (!o->ba[DDIR_TRIM] || !td_random(td))
462 o->ba[DDIR_TRIM] = o->min_bs[DDIR_TRIM];
464 if ((o->ba[DDIR_READ] != o->min_bs[DDIR_READ] ||
465 o->ba[DDIR_WRITE] != o->min_bs[DDIR_WRITE] ||
466 o->ba[DDIR_TRIM] != o->min_bs[DDIR_TRIM]) &&
468 log_err("fio: Any use of blockalign= turns off randommap\n");
470 ret = warnings_fatal;
473 if (!o->file_size_high)
474 o->file_size_high = o->file_size_low;
476 if (o->norandommap && o->verify != VERIFY_NONE
477 && !fixed_block_size(o)) {
478 log_err("fio: norandommap given for variable block sizes, "
479 "verify disabled\n");
480 o->verify = VERIFY_NONE;
481 ret = warnings_fatal;
483 if (o->bs_unaligned && (o->odirect || td->io_ops->flags & FIO_RAWIO))
484 log_err("fio: bs_unaligned may not work with raw io\n");
487 * thinktime_spin must be less than thinktime
489 if (o->thinktime_spin > o->thinktime)
490 o->thinktime_spin = o->thinktime;
493 * The low water mark cannot be bigger than the iodepth
495 if (o->iodepth_low > o->iodepth || !o->iodepth_low) {
497 * syslet work around - if the workload is sequential,
498 * we want to let the queue drain all the way down to
499 * avoid seeking between async threads
501 if (!strcmp(td->io_ops->name, "syslet-rw") && !td_random(td))
504 o->iodepth_low = o->iodepth;
508 * If batch number isn't set, default to the same as iodepth
510 if (o->iodepth_batch > o->iodepth || !o->iodepth_batch)
511 o->iodepth_batch = o->iodepth;
513 if (o->nr_files > td->files_index)
514 o->nr_files = td->files_index;
516 if (o->open_files > o->nr_files || !o->open_files)
517 o->open_files = o->nr_files;
519 if (((o->rate[DDIR_READ] + o->rate[DDIR_WRITE] + o->rate[DDIR_TRIM]) &&
520 (o->rate_iops[DDIR_READ] + o->rate_iops[DDIR_WRITE] + o->rate_iops[DDIR_TRIM])) ||
521 ((o->ratemin[DDIR_READ] + o->ratemin[DDIR_WRITE] + o->ratemin[DDIR_TRIM]) &&
522 (o->rate_iops_min[DDIR_READ] + o->rate_iops_min[DDIR_WRITE] + o->rate_iops_min[DDIR_TRIM]))) {
523 log_err("fio: rate and rate_iops are mutually exclusive\n");
526 if ((o->rate[DDIR_READ] < o->ratemin[DDIR_READ]) ||
527 (o->rate[DDIR_WRITE] < o->ratemin[DDIR_WRITE]) ||
528 (o->rate[DDIR_TRIM] < o->ratemin[DDIR_TRIM]) ||
529 (o->rate_iops[DDIR_READ] < o->rate_iops_min[DDIR_READ]) ||
530 (o->rate_iops[DDIR_WRITE] < o->rate_iops_min[DDIR_WRITE]) ||
531 (o->rate_iops[DDIR_TRIM] < o->rate_iops_min[DDIR_TRIM])) {
532 log_err("fio: minimum rate exceeds rate\n");
536 if (!o->timeout && o->time_based) {
537 log_err("fio: time_based requires a runtime/timeout setting\n");
539 ret = warnings_fatal;
542 if (o->fill_device && !o->size)
545 if (o->verify != VERIFY_NONE) {
546 if (td_write(td) && o->do_verify && o->numjobs > 1) {
547 log_info("Multiple writers may overwrite blocks that "
548 "belong to other jobs. This can cause "
549 "verification failures.\n");
550 ret = warnings_fatal;
553 o->refill_buffers = 1;
554 if (o->max_bs[DDIR_WRITE] != o->min_bs[DDIR_WRITE] &&
556 o->verify_interval = o->min_bs[DDIR_WRITE];
560 o->invalidate_cache = 0;
561 if (td->io_ops->flags & FIO_PIPEIO) {
562 log_info("fio: cannot pre-read files with an IO engine"
563 " that isn't seekable. Pre-read disabled.\n");
564 ret = warnings_fatal;
568 #ifndef FIO_HAVE_FDATASYNC
569 if (o->fdatasync_blocks) {
570 log_info("fio: this platform does not support fdatasync()"
571 " falling back to using fsync(). Use the 'fsync'"
572 " option instead of 'fdatasync' to get rid of"
574 o->fsync_blocks = o->fdatasync_blocks;
575 o->fdatasync_blocks = 0;
576 ret = warnings_fatal;
582 * Windows doesn't support O_DIRECT or O_SYNC with the _open interface,
583 * so fail if we're passed those flags
585 if ((td->io_ops->flags & FIO_SYNCIO) && (td->o.odirect || td->o.sync_io)) {
586 log_err("fio: Windows does not support direct or non-buffered io with"
587 " the synchronous ioengines. Use the 'windowsaio' ioengine"
588 " with 'direct=1' and 'iodepth=1' instead.\n");
594 * For fully compressible data, just zero them at init time.
595 * It's faster than repeatedly filling it.
597 if (td->o.compress_percentage == 100) {
598 td->o.zero_buffers = 1;
599 td->o.compress_percentage = 0;
606 * This function leaks the buffer
608 char *fio_uint_to_kmg(unsigned int val)
610 char *buf = malloc(32);
611 char post[] = { 0, 'K', 'M', 'G', 'P', 'E', 0 };
622 snprintf(buf, 31, "%u%c", val, *p);
626 /* External engines are specified by "external:name.o") */
627 static const char *get_engine_name(const char *str)
629 char *p = strstr(str, ":");
635 strip_blank_front(&p);
640 static int exists_and_not_file(const char *filename)
644 if (lstat(filename, &sb) == -1)
647 /* \\.\ is the device namespace in Windows, where every file
648 * is a device node */
649 if (S_ISREG(sb.st_mode) && strncmp(filename, "\\\\.\\", 4) != 0)
655 static void td_fill_rand_seeds_os(struct thread_data *td)
657 os_random_seed(td->rand_seeds[0], &td->bsrange_state);
658 os_random_seed(td->rand_seeds[1], &td->verify_state);
659 os_random_seed(td->rand_seeds[2], &td->rwmix_state);
661 if (td->o.file_service_type == FIO_FSERVICE_RANDOM)
662 os_random_seed(td->rand_seeds[3], &td->next_file_state);
664 os_random_seed(td->rand_seeds[5], &td->file_size_state);
665 os_random_seed(td->rand_seeds[6], &td->trim_state);
670 if (td->o.rand_repeatable)
671 td->rand_seeds[4] = FIO_RANDSEED * td->thread_number;
673 os_random_seed(td->rand_seeds[4], &td->random_state);
676 static void td_fill_rand_seeds_internal(struct thread_data *td)
678 init_rand_seed(&td->__bsrange_state, td->rand_seeds[0]);
679 init_rand_seed(&td->__verify_state, td->rand_seeds[1]);
680 init_rand_seed(&td->__rwmix_state, td->rand_seeds[2]);
682 if (td->o.file_service_type == FIO_FSERVICE_RANDOM)
683 init_rand_seed(&td->__next_file_state, td->rand_seeds[3]);
685 init_rand_seed(&td->__file_size_state, td->rand_seeds[5]);
686 init_rand_seed(&td->__trim_state, td->rand_seeds[6]);
691 if (td->o.rand_repeatable)
692 td->rand_seeds[4] = FIO_RANDSEED * td->thread_number;
694 init_rand_seed(&td->__random_state, td->rand_seeds[4]);
697 void td_fill_rand_seeds(struct thread_data *td)
699 if (td->o.use_os_rand)
700 td_fill_rand_seeds_os(td);
702 td_fill_rand_seeds_internal(td);
704 init_rand_seed(&td->buf_state, td->rand_seeds[7]);
709 * Initializes the ioengine configured for a job, if it has not been done so
712 int ioengine_load(struct thread_data *td)
717 * Engine has already been loaded.
722 engine = get_engine_name(td->o.ioengine);
723 td->io_ops = load_ioengine(td, engine);
725 log_err("fio: failed to load engine %s\n", engine);
729 if (td->io_ops->option_struct_size && td->io_ops->options) {
731 * In cases where td->eo is set, clone it for a child thread.
732 * This requires that the parent thread has the same ioengine,
733 * but that requirement must be enforced by the code which
736 void *origeo = td->eo;
738 * Otherwise use the default thread options.
740 if (!origeo && td != &def_thread && def_thread.eo &&
741 def_thread.io_ops->options == td->io_ops->options)
742 origeo = def_thread.eo;
744 options_init(td->io_ops->options);
745 td->eo = malloc(td->io_ops->option_struct_size);
747 * Use the default thread as an option template if this uses the
748 * same options structure and there are non-default options
752 memcpy(td->eo, origeo, td->io_ops->option_struct_size);
753 options_mem_dupe(td->eo, td->io_ops->options);
755 memset(td->eo, 0, td->io_ops->option_struct_size);
756 fill_default_options(td->eo, td->io_ops->options);
758 *(struct thread_data **)td->eo = td;
765 * Adds a job to the list of things todo. Sanitizes the various options
766 * to make sure we don't have conflicts, and initializes various
769 static int add_job(struct thread_data *td, const char *jobname, int job_add_num,
770 int recursed, int client_type)
773 char fname[PATH_MAX];
774 int numjobs, file_alloced;
777 * the def_thread is just for options, it's not a real job
779 if (td == &def_thread)
783 * if we are just dumping the output command line, don't add the job
790 td->client_type = client_type;
792 if (profile_td_init(td))
795 if (ioengine_load(td))
799 td->io_ops->flags |= FIO_RAWIO;
802 if (!td->o.filename && !td->files_index && !td->o.read_iolog_file) {
805 if (td->o.nr_files == 1 && exists_and_not_file(jobname))
806 add_file(td, jobname);
808 for (i = 0; i < td->o.nr_files; i++) {
809 sprintf(fname, "%s.%d.%d", jobname,
810 td->thread_number, i);
816 if (fixup_options(td))
822 * IO engines only need this for option callbacks, and the address may
823 * change in subprocesses.
826 *(struct thread_data **)td->eo = NULL;
828 if (td->io_ops->flags & FIO_DISKLESSIO) {
831 for_each_file(td, f, i)
832 f->real_file_size = -1ULL;
835 td->mutex = fio_mutex_init(FIO_MUTEX_LOCKED);
837 td->ts.clat_percentiles = td->o.clat_percentiles;
838 if (td->o.overwrite_plist)
839 memcpy(td->ts.percentile_list, td->o.percentile_list, sizeof(td->o.percentile_list));
841 memcpy(td->ts.percentile_list, def_percentile_list, sizeof(def_percentile_list));
843 for (i = 0; i < DDIR_RWDIR_CNT; i++) {
844 td->ts.clat_stat[i].min_val = ULONG_MAX;
845 td->ts.slat_stat[i].min_val = ULONG_MAX;
846 td->ts.lat_stat[i].min_val = ULONG_MAX;
847 td->ts.bw_stat[i].min_val = ULONG_MAX;
849 td->ddir_seq_nr = td->o.ddir_seq_nr;
851 if ((td->o.stonewall || td->o.new_group) && prev_group_jobs) {
856 td->groupid = groupid;
859 if (init_random_state(td, td->rand_seeds, sizeof(td->rand_seeds))) {
860 td_verror(td, errno, "init_random_state");
867 if (td->o.lat_log_file) {
868 setup_log(&td->lat_log, td->o.log_avg_msec, IO_LOG_TYPE_LAT);
869 setup_log(&td->slat_log, td->o.log_avg_msec, IO_LOG_TYPE_SLAT);
870 setup_log(&td->clat_log, td->o.log_avg_msec, IO_LOG_TYPE_CLAT);
872 if (td->o.bw_log_file)
873 setup_log(&td->bw_log, td->o.log_avg_msec, IO_LOG_TYPE_BW);
874 if (td->o.iops_log_file)
875 setup_log(&td->iops_log, td->o.log_avg_msec, IO_LOG_TYPE_IOPS);
878 td->o.name = strdup(jobname);
880 if (output_format == FIO_OUTPUT_NORMAL) {
882 if (is_backend && !recursed)
883 fio_server_send_add_job(td);
885 if (!(td->io_ops->flags & FIO_NOIO)) {
886 char *c1, *c2, *c3, *c4, *c5, *c6;
888 c1 = fio_uint_to_kmg(td->o.min_bs[DDIR_READ]);
889 c2 = fio_uint_to_kmg(td->o.max_bs[DDIR_READ]);
890 c3 = fio_uint_to_kmg(td->o.min_bs[DDIR_WRITE]);
891 c4 = fio_uint_to_kmg(td->o.max_bs[DDIR_WRITE]);
892 c5 = fio_uint_to_kmg(td->o.min_bs[DDIR_TRIM]);
893 c6 = fio_uint_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, 1, client_type))
949 * Parse as if 'o' was a command line
951 void add_job_opts(const char **o, int client_type)
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, 0, client_type);
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, 0, client_type);
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, int type)
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, 0, type);
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",
1251 .help = "Process creation/exit logging",
1252 .shift = FD_PROCESS,
1255 .help = "File related action logging",
1259 .help = "IO and IO engine action logging (offsets, queue, completions, etc)",
1263 .help = "Memory allocation/freeing logging",
1266 { .name = "blktrace",
1267 .help = "blktrace action logging",
1268 .shift = FD_BLKTRACE,
1271 .help = "IO verification action logging",
1275 .help = "Random generation logging",
1279 .help = "Parser logging",
1282 { .name = "diskutil",
1283 .help = "Disk utility logging actions",
1284 .shift = FD_DISKUTIL,
1287 .help = "Logging related to creating/destroying jobs",
1291 .help = "Mutex logging",
1294 { .name = "profile",
1295 .help = "Logging related to profiles",
1296 .shift = FD_PROFILE,
1299 .help = "Logging related to time keeping functions",
1303 .help = "Network logging",
1309 static int set_debug(const char *string)
1311 struct debug_level *dl;
1312 char *p = (char *) string;
1316 if (!strcmp(string, "?") || !strcmp(string, "help")) {
1317 log_info("fio: dumping debug options:");
1318 for (i = 0; debug_levels[i].name; i++) {
1319 dl = &debug_levels[i];
1320 log_info("%s,", dl->name);
1326 while ((opt = strsep(&p, ",")) != NULL) {
1329 if (!strncmp(opt, "all", 3)) {
1330 log_info("fio: set all debug options\n");
1335 for (i = 0; debug_levels[i].name; i++) {
1336 dl = &debug_levels[i];
1337 found = !strncmp(opt, dl->name, strlen(dl->name));
1341 if (dl->shift == FD_JOB) {
1342 opt = strchr(opt, ':');
1344 log_err("fio: missing job number\n");
1348 fio_debug_jobno = atoi(opt);
1349 log_info("fio: set debug jobno %d\n",
1352 log_info("fio: set debug option %s\n", opt);
1353 fio_debug |= (1UL << dl->shift);
1359 log_err("fio: debug mask %s not found\n", opt);
1364 static int set_debug(const char *string)
1366 log_err("fio: debug tracing not included in build\n");
1371 static void fio_options_fill_optstring(void)
1373 char *ostr = cmd_optstr;
1377 while (l_opts[i].name) {
1378 ostr[c++] = l_opts[i].val;
1379 if (l_opts[i].has_arg == required_argument)
1381 else if (l_opts[i].has_arg == optional_argument) {
1390 static int client_flag_set(char c)
1395 while (l_opts[i].name) {
1396 int val = l_opts[i].val;
1398 if (c == (val & 0xff))
1399 return (val & FIO_CLIENT_FLAG);
1407 void parse_cmd_client(void *client, char *opt)
1409 fio_client_add_cmd_option(client, opt);
1412 int parse_cmd_line(int argc, char *argv[], int client_type)
1414 struct thread_data *td = NULL;
1415 int c, ini_idx = 0, lidx, ret = 0, do_exit = 0, exit_val = 0;
1416 char *ostr = cmd_optstr;
1417 void *pid_file = NULL;
1418 void *cur_client = NULL;
1422 * Reset optind handling, since we may call this multiple times
1427 while ((c = getopt_long_only(argc, argv, ostr, l_opts, &lidx)) != -1) {
1430 if ((c & FIO_CLIENT_FLAG) || client_flag_set(c)) {
1431 parse_cmd_client(cur_client, argv[optind - 1]);
1432 c &= ~FIO_CLIENT_FLAG;
1437 smalloc_pool_size = atoi(optarg);
1440 def_timeout = atoi(optarg);
1449 f_out = fopen(optarg, "w+");
1451 perror("fopen output");
1457 output_format = FIO_OUTPUT_TERSE;
1460 if (!strcmp(optarg, "minimal") ||
1461 !strcmp(optarg, "terse") ||
1462 !strcmp(optarg, "csv"))
1463 output_format = FIO_OUTPUT_TERSE;
1464 else if (!strcmp(optarg, "json"))
1465 output_format = FIO_OUTPUT_JSON;
1467 output_format = FIO_OUTPUT_NORMAL;
1477 fio_show_option_help(optarg);
1483 fio_show_ioengine_help(optarg);
1495 log_info("%s\n", fio_version_string);
1500 terse_version = atoi(optarg);
1501 if (!(terse_version == 2 || terse_version == 3) ||
1502 (terse_version == 4)) {
1503 log_err("fio: bad terse version format\n");
1509 if (!strcmp("always", optarg))
1510 eta_print = FIO_ETA_ALWAYS;
1511 else if (!strcmp("never", optarg))
1512 eta_print = FIO_ETA_NEVER;
1515 if (set_debug(optarg))
1521 if (!strcmp(optarg, "global")) {
1522 log_err("fio: can't use global as only "
1528 new_size = (nr_job_sections + 1) * sizeof(char *);
1529 job_sections = realloc(job_sections, new_size);
1530 job_sections[nr_job_sections] = strdup(optarg);
1535 exec_profile = strdup(optarg);
1537 case FIO_GETOPT_JOB: {
1538 const char *opt = l_opts[lidx].name;
1541 if (!strncmp(opt, "name", 4) && td) {
1542 ret = add_job(td, td->o.name ?: "fio", 0, 0, client_type);
1548 int is_section = !strncmp(opt, "name", 4);
1551 if (!is_section || !strncmp(val, "global", 6))
1554 if (is_section && skip_this_section(val))
1557 td = get_new_job(global, &def_thread, 1);
1558 if (!td || ioengine_load(td))
1560 fio_options_set_ioengine_opts(l_opts, td);
1563 ret = fio_cmd_option_parse(td, opt, val);
1565 if (!ret && !strcmp(opt, "ioengine")) {
1567 if (ioengine_load(td))
1569 fio_options_set_ioengine_opts(l_opts, td);
1573 case FIO_GETOPT_IOENGINE: {
1574 const char *opt = l_opts[lidx].name;
1576 opt = l_opts[lidx].name;
1578 ret = fio_cmd_ioengine_option_parse(td, opt, val);
1585 max_jobs = atoi(optarg);
1586 if (!max_jobs || max_jobs > REAL_MAX_JOBS) {
1587 log_err("fio: invalid max jobs: %d\n", max_jobs);
1594 log_err("fio: can't be both client and server\n");
1600 fio_server_set_arg(optarg);
1605 pid_file = strdup(optarg);
1609 log_err("fio: can't be both client and server\n");
1614 if (fio_client_add(&fio_client_ops, optarg, &cur_client)) {
1615 log_err("fio: failed adding client %s\n", optarg);
1621 * If the next argument exists and isn't an option,
1622 * assume it's a job file for this client only.
1624 while (optind < argc) {
1625 if (!strncmp(argv[optind], "--", 2) ||
1626 !strncmp(argv[optind], "-", 1))
1629 fio_client_add_ini_file(cur_client, argv[optind]);
1643 if (exit_val && !(is_backend || nr_clients))
1647 if (nr_clients && fio_clients_connect()) {
1653 if (is_backend && backend)
1654 return fio_start_server(pid_file);
1658 ret = add_job(td, td->o.name ?: "fio", 0, 0, client_type);
1661 while (!ret && optind < argc) {
1663 ini_file = realloc(ini_file, ini_idx * sizeof(char *));
1664 ini_file[ini_idx - 1] = strdup(argv[optind]);
1671 int fio_init_options(void)
1676 fio_options_fill_optstring();
1677 fio_options_dup_and_init(l_opts);
1681 if (fill_def_thread())
1687 extern int fio_check_options(struct thread_options *);
1689 int parse_options(int argc, char *argv[])
1691 const int type = FIO_CLIENT_TYPE_CLI;
1694 if (fio_init_options())
1696 if (fio_test_cconv(&def_thread.o))
1697 log_err("fio: failed internal cconv test\n");
1699 job_files = parse_cmd_line(argc, argv, type);
1701 if (job_files > 0) {
1702 for (i = 0; i < job_files; i++) {
1703 if (fill_def_thread())
1706 if (fio_clients_send_ini(ini_file[i]))
1709 } else if (!is_backend) {
1710 if (parse_jobs_ini(ini_file[i], 0, i, type))
1715 } else if (nr_clients) {
1716 if (fill_def_thread())
1718 if (fio_clients_send_ini(NULL))
1723 fio_options_free(&def_thread);
1725 if (!thread_number) {
1730 if (is_backend || nr_clients)
1735 log_err("No jobs(s) defined\n\n");
1745 if (def_thread.o.gtod_offload) {
1747 fio_gtod_offload = 1;
1748 fio_gtod_cpu = def_thread.o.gtod_cpu;
1751 if (output_format == FIO_OUTPUT_NORMAL)
1752 log_info("%s\n", fio_version_string);
1757 void options_default_fill(struct thread_options *o)
1759 memcpy(o, &def_thread.o, sizeof(*o));