2 * This file contains job initialization and setup functions.
13 #include <sys/types.h>
24 #include "lib/getopt.h"
26 #include "fio_version.h"
29 const char fio_version_string[] = __fio_stringify(FIO_MAJOR) "." \
30 __fio_stringify(FIO_MINOR) "." \
31 __fio_stringify(FIO_PATCH);
33 const char fio_version_string[] = __fio_stringify(FIO_MAJOR) "." \
34 __fio_stringify(FIO_MINOR);
37 #define FIO_RANDSEED (0xb1899bedUL)
39 static char **ini_file;
40 static int max_jobs = FIO_MAX_JOBS;
41 static int dump_cmdline;
42 static int def_timeout;
44 static struct thread_data def_thread;
45 struct thread_data *threads = NULL;
47 int exitall_on_terminate = 0;
50 unsigned long long mlock_size = 0;
53 char **job_sections = NULL;
54 int nr_job_sections = 0;
55 char *exec_profile = NULL;
56 int warnings_fatal = 0;
57 int terse_version = 3;
65 static int write_lat_log;
67 static int prev_group_jobs;
69 unsigned long fio_debug = 0;
70 unsigned int fio_debug_jobno = -1;
71 unsigned int *fio_debug_jobp = NULL;
73 static char cmd_optstr[256];
76 const fio_fp64_t def_percentile_list[FIO_IO_U_LIST_MAX_LEN] = {
94 #define FIO_CLIENT_FLAG (1 << 16)
97 * Command line options. These will contain the above, plus a few
98 * extra that only pertain to fio itself and not jobs.
100 static struct option l_opts[FIO_NR_OPTIONS] = {
102 .name = (char *) "output",
103 .has_arg = required_argument,
104 .val = 'o' | FIO_CLIENT_FLAG,
107 .name = (char *) "timeout",
108 .has_arg = required_argument,
109 .val = 't' | FIO_CLIENT_FLAG,
112 .name = (char *) "latency-log",
113 .has_arg = required_argument,
114 .val = 'l' | FIO_CLIENT_FLAG,
117 .name = (char *) "bandwidth-log",
118 .has_arg = required_argument,
119 .val = 'b' | FIO_CLIENT_FLAG,
122 .name = (char *) "minimal",
123 .has_arg = optional_argument,
124 .val = 'm' | FIO_CLIENT_FLAG,
127 .name = (char *) "version",
128 .has_arg = no_argument,
129 .val = 'v' | FIO_CLIENT_FLAG,
132 .name = (char *) "help",
133 .has_arg = no_argument,
134 .val = 'h' | FIO_CLIENT_FLAG,
137 .name = (char *) "cmdhelp",
138 .has_arg = optional_argument,
139 .val = 'c' | FIO_CLIENT_FLAG,
142 .name = (char *) "enghelp",
143 .has_arg = optional_argument,
144 .val = 'i' | FIO_CLIENT_FLAG,
147 .name = (char *) "showcmd",
148 .has_arg = no_argument,
149 .val = 's' | FIO_CLIENT_FLAG,
152 .name = (char *) "readonly",
153 .has_arg = no_argument,
154 .val = 'r' | FIO_CLIENT_FLAG,
157 .name = (char *) "eta",
158 .has_arg = required_argument,
159 .val = 'e' | FIO_CLIENT_FLAG,
162 .name = (char *) "debug",
163 .has_arg = required_argument,
164 .val = 'd' | FIO_CLIENT_FLAG,
167 .name = (char *) "section",
168 .has_arg = required_argument,
169 .val = 'x' | FIO_CLIENT_FLAG,
172 .name = (char *) "alloc-size",
173 .has_arg = required_argument,
174 .val = 'a' | FIO_CLIENT_FLAG,
177 .name = (char *) "profile",
178 .has_arg = required_argument,
179 .val = 'p' | FIO_CLIENT_FLAG,
182 .name = (char *) "warnings-fatal",
183 .has_arg = no_argument,
184 .val = 'w' | FIO_CLIENT_FLAG,
187 .name = (char *) "max-jobs",
188 .has_arg = required_argument,
189 .val = 'j' | FIO_CLIENT_FLAG,
192 .name = (char *) "terse-version",
193 .has_arg = required_argument,
194 .val = 'V' | FIO_CLIENT_FLAG,
197 .name = (char *) "server",
198 .has_arg = optional_argument,
201 { .name = (char *) "daemonize",
202 .has_arg = required_argument,
206 .name = (char *) "client",
207 .has_arg = required_argument,
215 static void free_shm(void)
217 struct shmid_ds sbuf;
225 fio_debug_jobp = NULL;
227 shmctl(shm_id, IPC_RMID, &sbuf);
234 * The thread area is shared between the main process and the job
235 * threads/processes. So setup a shared memory segment that will hold
236 * all the job info. We use the end of the region for keeping track of
237 * open files across jobs, for file sharing.
239 static int setup_thread_area(void)
247 * 1024 is too much on some machines, scale max_jobs if
248 * we get a failure that looks like too large a shm segment
251 size_t size = max_jobs * sizeof(struct thread_data);
253 size += file_hash_size;
254 size += sizeof(unsigned int);
256 shm_id = shmget(0, size, IPC_CREAT | 0600);
259 if (errno != EINVAL && errno != ENOMEM) {
270 threads = shmat(shm_id, NULL, 0);
271 if (threads == (void *) -1) {
276 memset(threads, 0, max_jobs * sizeof(struct thread_data));
277 hash = (void *) threads + max_jobs * sizeof(struct thread_data);
278 fio_debug_jobp = (void *) hash + file_hash_size;
279 *fio_debug_jobp = -1;
280 file_hash_init(hash);
288 * Return a free job structure.
290 static struct thread_data *get_new_job(int global, struct thread_data *parent,
293 struct thread_data *td;
297 if (setup_thread_area()) {
298 log_err("error: failed to setup shm segment\n");
301 if (thread_number >= max_jobs) {
302 log_err("error: maximum number of jobs (%d) reached.\n",
307 td = &threads[thread_number++];
314 td->o.uid = td->o.gid = -1U;
316 dup_files(td, parent);
317 fio_options_mem_dupe(td);
319 profile_add_hooks(td);
321 td->thread_number = thread_number;
325 static void put_job(struct thread_data *td)
327 if (td == &def_thread)
334 log_info("fio: %s\n", td->verror);
336 fio_options_free(td);
340 memset(&threads[td->thread_number - 1], 0, sizeof(*td));
344 static int __setup_rate(struct thread_data *td, enum fio_ddir ddir)
346 unsigned int bs = td->o.min_bs[ddir];
348 assert(ddir_rw(ddir));
350 if (td->o.rate[ddir])
351 td->rate_bps[ddir] = td->o.rate[ddir];
353 td->rate_bps[ddir] = td->o.rate_iops[ddir] * bs;
355 if (!td->rate_bps[ddir]) {
356 log_err("rate lower than supported\n");
360 td->rate_pending_usleep[ddir] = 0;
364 static int setup_rate(struct thread_data *td)
368 if (td->o.rate[DDIR_READ] || td->o.rate_iops[DDIR_READ])
369 ret = __setup_rate(td, DDIR_READ);
370 if (td->o.rate[DDIR_WRITE] || td->o.rate_iops[DDIR_WRITE])
371 ret |= __setup_rate(td, DDIR_WRITE);
376 static int fixed_block_size(struct thread_options *o)
378 return o->min_bs[DDIR_READ] == o->max_bs[DDIR_READ] &&
379 o->min_bs[DDIR_WRITE] == o->max_bs[DDIR_WRITE] &&
380 o->min_bs[DDIR_READ] == o->min_bs[DDIR_WRITE];
384 * Lazy way of fixing up options that depend on each other. We could also
385 * define option callback handlers, but this is easier.
387 static int fixup_options(struct thread_data *td)
389 struct thread_options *o = &td->o;
392 #ifndef FIO_HAVE_PSHARED_MUTEX
393 if (!o->use_thread) {
394 log_info("fio: this platform does not support process shared"
395 " mutexes, forcing use of threads. Use the 'thread'"
396 " option to get rid of this warning.\n");
398 ret = warnings_fatal;
402 if (o->write_iolog_file && o->read_iolog_file) {
403 log_err("fio: read iolog overrides write_iolog\n");
404 free(o->write_iolog_file);
405 o->write_iolog_file = NULL;
406 ret = warnings_fatal;
410 * only really works with 1 file
412 if (o->zone_size && o->open_files == 1)
416 * If zone_range isn't specified, backward compatibility dictates it
417 * should be made equal to zone_size.
419 if (o->zone_size && !o->zone_range)
420 o->zone_range = o->zone_size;
423 * Reads can do overwrites, we always need to pre-create the file
425 if (td_read(td) || td_rw(td))
428 if (!o->min_bs[DDIR_READ])
429 o->min_bs[DDIR_READ] = o->bs[DDIR_READ];
430 if (!o->max_bs[DDIR_READ])
431 o->max_bs[DDIR_READ] = o->bs[DDIR_READ];
432 if (!o->min_bs[DDIR_WRITE])
433 o->min_bs[DDIR_WRITE] = o->bs[DDIR_WRITE];
434 if (!o->max_bs[DDIR_WRITE])
435 o->max_bs[DDIR_WRITE] = o->bs[DDIR_WRITE];
437 o->rw_min_bs = min(o->min_bs[DDIR_READ], o->min_bs[DDIR_WRITE]);
440 * For random IO, allow blockalign offset other than min_bs.
442 if (!o->ba[DDIR_READ] || !td_random(td))
443 o->ba[DDIR_READ] = o->min_bs[DDIR_READ];
444 if (!o->ba[DDIR_WRITE] || !td_random(td))
445 o->ba[DDIR_WRITE] = o->min_bs[DDIR_WRITE];
447 if ((o->ba[DDIR_READ] != o->min_bs[DDIR_READ] ||
448 o->ba[DDIR_WRITE] != o->min_bs[DDIR_WRITE]) &&
450 log_err("fio: Any use of blockalign= turns off randommap\n");
452 ret = warnings_fatal;
455 if (!o->file_size_high)
456 o->file_size_high = o->file_size_low;
458 if (o->norandommap && o->verify != VERIFY_NONE
459 && !fixed_block_size(o)) {
460 log_err("fio: norandommap given for variable block sizes, "
461 "verify disabled\n");
462 o->verify = VERIFY_NONE;
463 ret = warnings_fatal;
465 if (o->bs_unaligned && (o->odirect || td->io_ops->flags & FIO_RAWIO))
466 log_err("fio: bs_unaligned may not work with raw io\n");
469 * thinktime_spin must be less than thinktime
471 if (o->thinktime_spin > o->thinktime)
472 o->thinktime_spin = o->thinktime;
475 * The low water mark cannot be bigger than the iodepth
477 if (o->iodepth_low > o->iodepth || !o->iodepth_low) {
479 * syslet work around - if the workload is sequential,
480 * we want to let the queue drain all the way down to
481 * avoid seeking between async threads
483 if (!strcmp(td->io_ops->name, "syslet-rw") && !td_random(td))
486 o->iodepth_low = o->iodepth;
490 * If batch number isn't set, default to the same as iodepth
492 if (o->iodepth_batch > o->iodepth || !o->iodepth_batch)
493 o->iodepth_batch = o->iodepth;
495 if (o->nr_files > td->files_index)
496 o->nr_files = td->files_index;
498 if (o->open_files > o->nr_files || !o->open_files)
499 o->open_files = o->nr_files;
501 if (((o->rate[0] + o->rate[1]) && (o->rate_iops[0] + o->rate_iops[1]))||
502 ((o->ratemin[0] + o->ratemin[1]) && (o->rate_iops_min[0] +
503 o->rate_iops_min[1]))) {
504 log_err("fio: rate and rate_iops are mutually exclusive\n");
507 if ((o->rate[0] < o->ratemin[0]) || (o->rate[1] < o->ratemin[1]) ||
508 (o->rate_iops[0] < o->rate_iops_min[0]) ||
509 (o->rate_iops[1] < o->rate_iops_min[1])) {
510 log_err("fio: minimum rate exceeds rate\n");
514 if (!o->timeout && o->time_based) {
515 log_err("fio: time_based requires a runtime/timeout setting\n");
517 ret = warnings_fatal;
520 if (o->fill_device && !o->size)
523 if (o->verify != VERIFY_NONE) {
524 if (td_write(td) && o->do_verify && o->numjobs > 1) {
525 log_info("Multiple writers may overwrite blocks that "
526 "belong to other jobs. This can cause "
527 "verification failures.\n");
528 ret = warnings_fatal;
531 o->refill_buffers = 1;
532 if (o->max_bs[DDIR_WRITE] != o->min_bs[DDIR_WRITE] &&
534 o->verify_interval = o->min_bs[DDIR_WRITE];
538 o->invalidate_cache = 0;
539 if (td->io_ops->flags & FIO_PIPEIO) {
540 log_info("fio: cannot pre-read files with an IO engine"
541 " that isn't seekable. Pre-read disabled.\n");
542 ret = warnings_fatal;
546 #ifndef FIO_HAVE_FDATASYNC
547 if (o->fdatasync_blocks) {
548 log_info("fio: this platform does not support fdatasync()"
549 " falling back to using fsync(). Use the 'fsync'"
550 " option instead of 'fdatasync' to get rid of"
552 o->fsync_blocks = o->fdatasync_blocks;
553 o->fdatasync_blocks = 0;
554 ret = warnings_fatal;
560 * Windows doesn't support O_DIRECT or O_SYNC with the _open interface,
561 * so fail if we're passed those flags
563 if ((td->io_ops->flags & FIO_SYNCIO) && (td->o.odirect || td->o.sync_io)) {
564 log_err("fio: Windows does not support direct or non-buffered io with"
565 " the synchronous ioengines. Use the 'windowsaio' ioengine"
566 " with 'direct=1' and 'iodepth=1' instead.\n");
572 * For fully compressible data, just zero them at init time.
573 * It's faster than repeatedly filling it.
575 if (td->o.compress_percentage == 100) {
576 td->o.zero_buffers = 1;
577 td->o.compress_percentage = 0;
584 * This function leaks the buffer
586 char *fio_uint_to_kmg(unsigned int val)
588 char *buf = malloc(32);
589 char post[] = { 0, 'K', 'M', 'G', 'P', 'E', 0 };
600 snprintf(buf, 31, "%u%c", val, *p);
604 /* External engines are specified by "external:name.o") */
605 static const char *get_engine_name(const char *str)
607 char *p = strstr(str, ":");
613 strip_blank_front(&p);
618 static int exists_and_not_file(const char *filename)
622 if (lstat(filename, &sb) == -1)
625 /* \\.\ is the device namespace in Windows, where every file
626 * is a device node */
627 if (S_ISREG(sb.st_mode) && strncmp(filename, "\\\\.\\", 4) != 0)
633 static void td_fill_rand_seeds_os(struct thread_data *td)
635 os_random_seed(td->rand_seeds[0], &td->bsrange_state);
636 os_random_seed(td->rand_seeds[1], &td->verify_state);
637 os_random_seed(td->rand_seeds[2], &td->rwmix_state);
639 if (td->o.file_service_type == FIO_FSERVICE_RANDOM)
640 os_random_seed(td->rand_seeds[3], &td->next_file_state);
642 os_random_seed(td->rand_seeds[5], &td->file_size_state);
643 os_random_seed(td->rand_seeds[6], &td->trim_state);
648 if (td->o.rand_repeatable)
649 td->rand_seeds[4] = FIO_RANDSEED * td->thread_number;
651 os_random_seed(td->rand_seeds[4], &td->random_state);
654 static void td_fill_rand_seeds_internal(struct thread_data *td)
656 init_rand_seed(&td->__bsrange_state, td->rand_seeds[0]);
657 init_rand_seed(&td->__verify_state, td->rand_seeds[1]);
658 init_rand_seed(&td->__rwmix_state, td->rand_seeds[2]);
660 if (td->o.file_service_type == FIO_FSERVICE_RANDOM)
661 init_rand_seed(&td->__next_file_state, td->rand_seeds[3]);
663 init_rand_seed(&td->__file_size_state, td->rand_seeds[5]);
664 init_rand_seed(&td->__trim_state, td->rand_seeds[6]);
669 if (td->o.rand_repeatable)
670 td->rand_seeds[4] = FIO_RANDSEED * td->thread_number;
672 init_rand_seed(&td->__random_state, td->rand_seeds[4]);
675 void td_fill_rand_seeds(struct thread_data *td)
677 if (td->o.use_os_rand)
678 td_fill_rand_seeds_os(td);
680 td_fill_rand_seeds_internal(td);
682 init_rand_seed(&td->buf_state, td->rand_seeds[7]);
687 * Initializes the ioengine configured for a job, if it has not been done so
690 int ioengine_load(struct thread_data *td)
695 * Engine has already been loaded.
700 engine = get_engine_name(td->o.ioengine);
701 td->io_ops = load_ioengine(td, engine);
703 log_err("fio: failed to load engine %s\n", engine);
707 if (td->io_ops->option_struct_size && td->io_ops->options) {
709 * In cases where td->eo is set, clone it for a child thread.
710 * This requires that the parent thread has the same ioengine,
711 * but that requirement must be enforced by the code which
714 void *origeo = td->eo;
716 * Otherwise use the default thread options.
718 if (!origeo && td != &def_thread && def_thread.eo &&
719 def_thread.io_ops->options == td->io_ops->options)
720 origeo = def_thread.eo;
722 options_init(td->io_ops->options);
723 td->eo = malloc(td->io_ops->option_struct_size);
725 * Use the default thread as an option template if this uses the
726 * same options structure and there are non-default options
730 memcpy(td->eo, origeo, td->io_ops->option_struct_size);
731 options_mem_dupe(td->eo, td->io_ops->options);
733 memset(td->eo, 0, td->io_ops->option_struct_size);
734 fill_default_options(td->eo, td->io_ops->options);
736 *(struct thread_data **)td->eo = td;
743 * Adds a job to the list of things todo. Sanitizes the various options
744 * to make sure we don't have conflicts, and initializes various
747 static int add_job(struct thread_data *td, const char *jobname, int job_add_num,
748 int recursed, int client_type)
751 char fname[PATH_MAX];
752 int numjobs, file_alloced;
755 * the def_thread is just for options, it's not a real job
757 if (td == &def_thread)
761 * if we are just dumping the output command line, don't add the job
768 td->client_type = client_type;
770 if (profile_td_init(td))
773 if (ioengine_load(td))
776 if (td->o.use_thread)
782 td->io_ops->flags |= FIO_RAWIO;
785 if (!td->o.filename && !td->files_index && !td->o.read_iolog_file) {
788 if (td->o.nr_files == 1 && exists_and_not_file(jobname))
789 add_file(td, jobname);
791 for (i = 0; i < td->o.nr_files; i++) {
792 sprintf(fname, "%s.%d.%d", jobname,
793 td->thread_number, i);
799 if (fixup_options(td))
805 * IO engines only need this for option callbacks, and the address may
806 * change in subprocesses.
809 *(struct thread_data **)td->eo = NULL;
811 if (td->io_ops->flags & FIO_DISKLESSIO) {
814 for_each_file(td, f, i)
815 f->real_file_size = -1ULL;
818 td->mutex = fio_mutex_init(0);
820 td->ts.clat_percentiles = td->o.clat_percentiles;
821 if (td->o.overwrite_plist)
822 memcpy(td->ts.percentile_list, td->o.percentile_list, sizeof(td->o.percentile_list));
824 memcpy(td->ts.percentile_list, def_percentile_list, sizeof(def_percentile_list));
826 td->ts.clat_stat[0].min_val = td->ts.clat_stat[1].min_val = ULONG_MAX;
827 td->ts.slat_stat[0].min_val = td->ts.slat_stat[1].min_val = ULONG_MAX;
828 td->ts.lat_stat[0].min_val = td->ts.lat_stat[1].min_val = ULONG_MAX;
829 td->ts.bw_stat[0].min_val = td->ts.bw_stat[1].min_val = ULONG_MAX;
830 td->ddir_seq_nr = td->o.ddir_seq_nr;
832 if ((td->o.stonewall || td->o.new_group) && prev_group_jobs) {
837 td->groupid = groupid;
840 if (init_random_state(td, td->rand_seeds, sizeof(td->rand_seeds))) {
841 td_verror(td, errno, "init_random_state");
848 if (td->o.write_lat_log) {
849 setup_log(&td->lat_log, td->o.log_avg_msec, IO_LOG_TYPE_LAT);
850 setup_log(&td->slat_log, td->o.log_avg_msec, IO_LOG_TYPE_SLAT);
851 setup_log(&td->clat_log, td->o.log_avg_msec, IO_LOG_TYPE_CLAT);
853 if (td->o.write_bw_log)
854 setup_log(&td->bw_log, td->o.log_avg_msec, IO_LOG_TYPE_BW);
855 if (td->o.write_iops_log)
856 setup_log(&td->iops_log, td->o.log_avg_msec, IO_LOG_TYPE_IOPS);
859 td->o.name = strdup(jobname);
863 if (is_backend && !recursed)
864 fio_server_send_add_job(td);
866 if (!strcmp(td->io_ops->name, "cpuio")) {
867 log_info("%s: ioengine=cpu, cpuload=%u,"
868 " cpucycle=%u\n", td->o.name,
872 char *c1, *c2, *c3, *c4;
874 c1 = fio_uint_to_kmg(td->o.min_bs[DDIR_READ]);
875 c2 = fio_uint_to_kmg(td->o.max_bs[DDIR_READ]);
876 c3 = fio_uint_to_kmg(td->o.min_bs[DDIR_WRITE]);
877 c4 = fio_uint_to_kmg(td->o.max_bs[DDIR_WRITE]);
879 log_info("%s: (g=%d): rw=%s, bs=%s-%s/%s-%s,"
880 " ioengine=%s, iodepth=%u\n",
881 td->o.name, td->groupid,
882 ddir_str(td->o.td_ddir),
892 } else if (job_add_num == 1)
897 * recurse add identical jobs, clear numjobs and stonewall options
898 * as they don't apply to sub-jobs
900 numjobs = td->o.numjobs;
902 struct thread_data *td_new = get_new_job(0, td, 1);
907 td_new->o.numjobs = 1;
908 td_new->o.stonewall = 0;
909 td_new->o.new_group = 0;
912 td_new->o.filename = NULL;
913 td_new->files_index = 0;
914 td_new->files_size = 0;
915 td_new->files = NULL;
918 job_add_num = numjobs - 1;
920 if (add_job(td_new, jobname, job_add_num, 1, client_type))
931 * Parse as if 'o' was a command line
933 void add_job_opts(const char **o, int client_type)
935 struct thread_data *td, *td_parent;
936 int i, in_global = 1;
940 td_parent = td = NULL;
942 if (!strncmp(o[i], "name", 4)) {
945 add_job(td, jobname, 0, 0, client_type);
947 sprintf(jobname, "%s", o[i] + 5);
949 if (in_global && !td_parent)
950 td_parent = get_new_job(1, &def_thread, 0);
951 else if (!in_global && !td) {
953 td_parent = &def_thread;
954 td = get_new_job(0, td_parent, 0);
957 fio_options_parse(td_parent, (char **) &o[i], 1);
959 fio_options_parse(td, (char **) &o[i], 1);
964 add_job(td, jobname, 0, 0, client_type);
967 static int skip_this_section(const char *name)
971 if (!nr_job_sections)
973 if (!strncmp(name, "global", 6))
976 for (i = 0; i < nr_job_sections; i++)
977 if (!strcmp(job_sections[i], name))
983 static int is_empty_or_comment(char *line)
987 for (i = 0; i < strlen(line); i++) {
992 if (!isspace((int) line[i]) && !iscntrl((int) line[i]))
1000 * This is our [ini] type file parser.
1002 int parse_jobs_ini(char *file, int is_buf, int stonewall_flag, int type)
1004 unsigned int global;
1005 struct thread_data *td;
1006 char *string, *name;
1009 int ret = 0, stonewall;
1012 int inside_skip = 0;
1014 int i, alloc_opts, num_opts;
1019 if (!strcmp(file, "-"))
1022 f = fopen(file, "r");
1025 perror("fopen job file");
1030 string = malloc(4096);
1033 * it's really 256 + small bit, 280 should suffice
1036 memset(name, 0, 280);
1039 opts = malloc(sizeof(char *) * alloc_opts);
1042 stonewall = stonewall_flag;
1045 * if skip_fgets is set, we already have loaded a line we
1050 p = strsep(&file, "\n");
1052 p = fgets(string, 4096, f);
1058 strip_blank_front(&p);
1061 if (is_empty_or_comment(p))
1063 if (sscanf(p, "[%255[^\n]]", name) != 1) {
1066 log_err("fio: option <%s> outside of [] job section\n",
1071 name[strlen(name) - 1] = '\0';
1073 if (skip_this_section(name)) {
1079 global = !strncmp(name, "global", 6);
1085 log_info("--name=%s ", name);
1089 td = get_new_job(global, &def_thread, 0);
1096 * Seperate multiple job files by a stonewall
1098 if (!global && stonewall) {
1099 td->o.stonewall = stonewall;
1104 memset(opts, 0, alloc_opts * sizeof(char *));
1108 p = strsep(&file, "\n");
1110 p = fgets(string, 4096, f);
1114 if (is_empty_or_comment(p))
1117 strip_blank_front(&p);
1120 * new section, break out and make sure we don't
1121 * fgets() a new line at the top.
1130 if (num_opts == alloc_opts) {
1132 opts = realloc(opts,
1133 alloc_opts * sizeof(char *));
1136 opts[num_opts] = strdup(p);
1140 ret = fio_options_parse(td, opts, num_opts);
1143 for (i = 0; i < num_opts; i++)
1144 log_info("--%s ", opts[i]);
1146 ret = add_job(td, name, 0, 0, type);
1148 log_err("fio: job %s dropped\n", name);
1152 for (i = 0; i < num_opts; i++)
1161 while (i < nr_job_sections) {
1162 free(job_sections[i]);
1166 for (i = 0; i < num_opts; i++)
1172 if (!is_buf && f != stdin)
1177 static int fill_def_thread(void)
1179 memset(&def_thread, 0, sizeof(def_thread));
1181 fio_getaffinity(getpid(), &def_thread.o.cpumask);
1182 def_thread.o.timeout = def_timeout;
1185 * fill default options
1187 fio_fill_default_options(&def_thread);
1191 static void usage(const char *name)
1193 printf("fio %s\n", fio_version_string);
1194 printf("%s [options] [job options] <job file(s)>\n", name);
1195 printf(" --debug=options\tEnable debug logging. May be one/more of:\n"
1196 "\t\t\tprocess,file,io,mem,blktrace,verify,random,parse,\n"
1197 "\t\t\tdiskutil,job,mutex,profile,time,net\n");
1198 printf(" --output\t\tWrite output to file\n");
1199 printf(" --timeout\t\tRuntime in seconds\n");
1200 printf(" --latency-log\t\tGenerate per-job latency logs\n");
1201 printf(" --bandwidth-log\tGenerate per-job bandwidth logs\n");
1202 printf(" --minimal\t\tMinimal (terse) output\n");
1203 printf(" --version\t\tPrint version info and exit\n");
1204 printf(" --terse-version=x\tSet terse version output format to 'x'\n");
1205 printf(" --help\t\tPrint this page\n");
1206 printf(" --cmdhelp=cmd\t\tPrint command help, \"all\" for all of"
1208 printf(" --enghelp=engine\tPrint ioengine help, or list"
1209 " available ioengines\n");
1210 printf(" --enghelp=engine,cmd\tPrint help for an ioengine"
1212 printf(" --showcmd\t\tTurn a job file into command line options\n");
1213 printf(" --eta=when\t\tWhen ETA estimate should be printed\n");
1214 printf(" \t\tMay be \"always\", \"never\" or \"auto\"\n");
1215 printf(" --readonly\t\tTurn on safety read-only checks, preventing"
1217 printf(" --section=name\tOnly run specified section in job file\n");
1218 printf(" --alloc-size=kb\tSet smalloc pool to this size in kb"
1220 printf(" --warnings-fatal\tFio parser warnings are fatal\n");
1221 printf(" --max-jobs=nr\t\tMaximum number of threads/processes to support\n");
1222 printf(" --server=args\t\tStart a backend fio server\n");
1223 printf(" --daemonize=pidfile\tBackground fio server, write pid to file\n");
1224 printf(" --client=hostname\tTalk to remote backend fio server at hostname\n");
1225 printf("\nFio was written by Jens Axboe <jens.axboe@oracle.com>");
1226 printf("\n Jens Axboe <jaxboe@fusionio.com>\n");
1229 #ifdef FIO_INC_DEBUG
1230 struct debug_level debug_levels[] = {
1231 { .name = "process",
1232 .help = "Process creation/exit logging",
1233 .shift = FD_PROCESS,
1236 .help = "File related action logging",
1240 .help = "IO and IO engine action logging (offsets, queue, completions, etc)",
1244 .help = "Memory allocation/freeing logging",
1247 { .name = "blktrace",
1248 .help = "blktrace action logging",
1249 .shift = FD_BLKTRACE,
1252 .help = "IO verification action logging",
1256 .help = "Random generation logging",
1260 .help = "Parser logging",
1263 { .name = "diskutil",
1264 .help = "Disk utility logging actions",
1265 .shift = FD_DISKUTIL,
1268 .help = "Logging related to creating/destroying jobs",
1272 .help = "Mutex logging",
1275 { .name = "profile",
1276 .help = "Logging related to profiles",
1277 .shift = FD_PROFILE,
1280 .help = "Logging related to time keeping functions",
1284 .help = "Network logging",
1290 static int set_debug(const char *string)
1292 struct debug_level *dl;
1293 char *p = (char *) string;
1297 if (!strcmp(string, "?") || !strcmp(string, "help")) {
1298 log_info("fio: dumping debug options:");
1299 for (i = 0; debug_levels[i].name; i++) {
1300 dl = &debug_levels[i];
1301 log_info("%s,", dl->name);
1307 while ((opt = strsep(&p, ",")) != NULL) {
1310 if (!strncmp(opt, "all", 3)) {
1311 log_info("fio: set all debug options\n");
1316 for (i = 0; debug_levels[i].name; i++) {
1317 dl = &debug_levels[i];
1318 found = !strncmp(opt, dl->name, strlen(dl->name));
1322 if (dl->shift == FD_JOB) {
1323 opt = strchr(opt, ':');
1325 log_err("fio: missing job number\n");
1329 fio_debug_jobno = atoi(opt);
1330 log_info("fio: set debug jobno %d\n",
1333 log_info("fio: set debug option %s\n", opt);
1334 fio_debug |= (1UL << dl->shift);
1340 log_err("fio: debug mask %s not found\n", opt);
1345 static int set_debug(const char *string)
1347 log_err("fio: debug tracing not included in build\n");
1352 static void fio_options_fill_optstring(void)
1354 char *ostr = cmd_optstr;
1358 while (l_opts[i].name) {
1359 ostr[c++] = l_opts[i].val;
1360 if (l_opts[i].has_arg == required_argument)
1362 else if (l_opts[i].has_arg == optional_argument) {
1371 static int client_flag_set(char c)
1376 while (l_opts[i].name) {
1377 int val = l_opts[i].val;
1379 if (c == (val & 0xff))
1380 return (val & FIO_CLIENT_FLAG);
1388 void parse_cmd_client(void *client, char *opt)
1390 fio_client_add_cmd_option(client, opt);
1393 int parse_cmd_line(int argc, char *argv[], int client_type)
1395 struct thread_data *td = NULL;
1396 int c, ini_idx = 0, lidx, ret = 0, do_exit = 0, exit_val = 0;
1397 char *ostr = cmd_optstr;
1398 void *pid_file = NULL;
1399 void *cur_client = NULL;
1403 * Reset optind handling, since we may call this multiple times
1408 while ((c = getopt_long_only(argc, argv, ostr, l_opts, &lidx)) != -1) {
1411 if ((c & FIO_CLIENT_FLAG) || client_flag_set(c)) {
1412 parse_cmd_client(cur_client, argv[optind - 1]);
1413 c &= ~FIO_CLIENT_FLAG;
1418 smalloc_pool_size = atoi(optarg);
1421 def_timeout = atoi(optarg);
1430 f_out = fopen(optarg, "w+");
1432 perror("fopen output");
1448 fio_show_option_help(optarg);
1454 fio_show_ioengine_help(optarg);
1466 log_info("fio %s\n", fio_version_string);
1471 terse_version = atoi(optarg);
1472 if (!(terse_version == 2 || terse_version == 3)) {
1473 log_err("fio: bad terse version format\n");
1479 if (!strcmp("always", optarg))
1480 eta_print = FIO_ETA_ALWAYS;
1481 else if (!strcmp("never", optarg))
1482 eta_print = FIO_ETA_NEVER;
1485 if (set_debug(optarg))
1491 if (!strcmp(optarg, "global")) {
1492 log_err("fio: can't use global as only "
1498 new_size = (nr_job_sections + 1) * sizeof(char *);
1499 job_sections = realloc(job_sections, new_size);
1500 job_sections[nr_job_sections] = strdup(optarg);
1505 exec_profile = strdup(optarg);
1507 case FIO_GETOPT_JOB: {
1508 const char *opt = l_opts[lidx].name;
1511 if (!strncmp(opt, "name", 4) && td) {
1512 ret = add_job(td, td->o.name ?: "fio", 0, 0, client_type);
1518 int is_section = !strncmp(opt, "name", 4);
1521 if (!is_section || !strncmp(val, "global", 6))
1524 if (is_section && skip_this_section(val))
1527 td = get_new_job(global, &def_thread, 1);
1528 if (!td || ioengine_load(td))
1530 fio_options_set_ioengine_opts(l_opts, td);
1533 ret = fio_cmd_option_parse(td, opt, val);
1535 if (!ret && !strcmp(opt, "ioengine")) {
1537 if (ioengine_load(td))
1539 fio_options_set_ioengine_opts(l_opts, td);
1543 case FIO_GETOPT_IOENGINE: {
1544 const char *opt = l_opts[lidx].name;
1546 opt = l_opts[lidx].name;
1548 ret = fio_cmd_ioengine_option_parse(td, opt, val);
1555 max_jobs = atoi(optarg);
1556 if (!max_jobs || max_jobs > REAL_MAX_JOBS) {
1557 log_err("fio: invalid max jobs: %d\n", max_jobs);
1564 log_err("fio: can't be both client and server\n");
1570 fio_server_set_arg(optarg);
1575 pid_file = strdup(optarg);
1579 log_err("fio: can't be both client and server\n");
1584 if (fio_client_add(&fio_client_ops, optarg, &cur_client)) {
1585 log_err("fio: failed adding client %s\n", optarg);
1601 if (exit_val && !(is_backend || nr_clients))
1605 if (nr_clients && fio_clients_connect()) {
1611 if (is_backend && backend)
1612 return fio_start_server(pid_file);
1616 ret = add_job(td, td->o.name ?: "fio", 0, 0, client_type);
1619 while (!ret && optind < argc) {
1621 ini_file = realloc(ini_file, ini_idx * sizeof(char *));
1622 ini_file[ini_idx - 1] = strdup(argv[optind]);
1629 int fio_init_options(void)
1634 fio_options_fill_optstring();
1635 fio_options_dup_and_init(l_opts);
1639 if (fill_def_thread())
1645 extern int fio_check_options(struct thread_options *);
1647 int parse_options(int argc, char *argv[])
1649 const int type = FIO_CLIENT_TYPE_CLI;
1652 if (fio_init_options())
1654 if (fio_test_cconv(&def_thread.o))
1655 log_err("fio: failed internal cconv test\n");
1657 job_files = parse_cmd_line(argc, argv, type);
1659 if (job_files > 0) {
1660 for (i = 0; i < job_files; i++) {
1661 if (fill_def_thread())
1664 if (fio_clients_send_ini(ini_file[i]))
1667 } else if (!is_backend) {
1668 if (parse_jobs_ini(ini_file[i], 0, i, type))
1676 fio_options_free(&def_thread);
1678 if (!thread_number) {
1683 if (is_backend || nr_clients)
1688 log_err("No jobs(s) defined\n\n");
1698 if (def_thread.o.gtod_offload) {
1700 fio_gtod_offload = 1;
1701 fio_gtod_cpu = def_thread.o.gtod_cpu;
1705 log_info("fio %s\n", fio_version_string);