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 = 2;
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 *) "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;
219 fio_debug_jobp = NULL;
221 shmctl(shm_id, IPC_RMID, &sbuf);
228 * The thread area is shared between the main process and the job
229 * threads/processes. So setup a shared memory segment that will hold
230 * all the job info. We use the end of the region for keeping track of
231 * open files across jobs, for file sharing.
233 static int setup_thread_area(void)
241 * 1024 is too much on some machines, scale max_jobs if
242 * we get a failure that looks like too large a shm segment
245 size_t size = max_jobs * sizeof(struct thread_data);
247 size += file_hash_size;
248 size += sizeof(unsigned int);
250 shm_id = shmget(0, size, IPC_CREAT | 0600);
253 if (errno != EINVAL) {
264 threads = shmat(shm_id, NULL, 0);
265 if (threads == (void *) -1) {
270 memset(threads, 0, max_jobs * sizeof(struct thread_data));
271 hash = (void *) threads + max_jobs * sizeof(struct thread_data);
272 fio_debug_jobp = (void *) hash + file_hash_size;
273 *fio_debug_jobp = -1;
274 file_hash_init(hash);
279 * Return a free job structure.
281 static struct thread_data *get_new_job(int global, struct thread_data *parent)
283 struct thread_data *td;
287 if (setup_thread_area()) {
288 log_err("error: failed to setup shm segment\n");
291 if (thread_number >= max_jobs) {
292 log_err("error: maximum number of jobs (%d) reached.\n",
297 td = &threads[thread_number++];
300 td->o.uid = td->o.gid = -1U;
302 dup_files(td, parent);
303 options_mem_dupe(td);
305 profile_add_hooks(td);
307 td->thread_number = thread_number;
311 static void put_job(struct thread_data *td)
313 if (td == &def_thread)
319 log_info("fio: %s\n", td->verror);
321 fio_options_free(td);
323 memset(&threads[td->thread_number - 1], 0, sizeof(*td));
327 static int __setup_rate(struct thread_data *td, enum fio_ddir ddir)
329 unsigned int bs = td->o.min_bs[ddir];
330 unsigned long long bytes_per_sec;
332 assert(ddir_rw(ddir));
334 if (td->o.rate[ddir])
335 bytes_per_sec = td->o.rate[ddir];
337 bytes_per_sec = td->o.rate_iops[ddir] * bs;
339 if (!bytes_per_sec) {
340 log_err("rate lower than supported\n");
344 td->rate_nsec_cycle[ddir] = 1000000000ULL / bytes_per_sec;
345 td->rate_pending_usleep[ddir] = 0;
349 static int setup_rate(struct thread_data *td)
353 if (td->o.rate[DDIR_READ] || td->o.rate_iops[DDIR_READ])
354 ret = __setup_rate(td, DDIR_READ);
355 if (td->o.rate[DDIR_WRITE] || td->o.rate_iops[DDIR_WRITE])
356 ret |= __setup_rate(td, DDIR_WRITE);
361 static int fixed_block_size(struct thread_options *o)
363 return o->min_bs[DDIR_READ] == o->max_bs[DDIR_READ] &&
364 o->min_bs[DDIR_WRITE] == o->max_bs[DDIR_WRITE] &&
365 o->min_bs[DDIR_READ] == o->min_bs[DDIR_WRITE];
369 * Lazy way of fixing up options that depend on each other. We could also
370 * define option callback handlers, but this is easier.
372 static int fixup_options(struct thread_data *td)
374 struct thread_options *o = &td->o;
377 #ifndef FIO_HAVE_PSHARED_MUTEX
378 if (!o->use_thread) {
379 log_info("fio: this platform does not support process shared"
380 " mutexes, forcing use of threads. Use the 'thread'"
381 " option to get rid of this warning.\n");
383 ret = warnings_fatal;
387 if (o->write_iolog_file && o->read_iolog_file) {
388 log_err("fio: read iolog overrides write_iolog\n");
389 free(o->write_iolog_file);
390 o->write_iolog_file = NULL;
391 ret = warnings_fatal;
395 * only really works for sequential io for now, and with 1 file
397 if (o->zone_size && td_random(td) && o->open_files == 1)
401 * Reads can do overwrites, we always need to pre-create the file
403 if (td_read(td) || td_rw(td))
406 if (!o->min_bs[DDIR_READ])
407 o->min_bs[DDIR_READ] = o->bs[DDIR_READ];
408 if (!o->max_bs[DDIR_READ])
409 o->max_bs[DDIR_READ] = o->bs[DDIR_READ];
410 if (!o->min_bs[DDIR_WRITE])
411 o->min_bs[DDIR_WRITE] = o->bs[DDIR_WRITE];
412 if (!o->max_bs[DDIR_WRITE])
413 o->max_bs[DDIR_WRITE] = o->bs[DDIR_WRITE];
415 o->rw_min_bs = min(o->min_bs[DDIR_READ], o->min_bs[DDIR_WRITE]);
418 * For random IO, allow blockalign offset other than min_bs.
420 if (!o->ba[DDIR_READ] || !td_random(td))
421 o->ba[DDIR_READ] = o->min_bs[DDIR_READ];
422 if (!o->ba[DDIR_WRITE] || !td_random(td))
423 o->ba[DDIR_WRITE] = o->min_bs[DDIR_WRITE];
425 if ((o->ba[DDIR_READ] != o->min_bs[DDIR_READ] ||
426 o->ba[DDIR_WRITE] != o->min_bs[DDIR_WRITE]) &&
428 log_err("fio: Any use of blockalign= turns off randommap\n");
430 ret = warnings_fatal;
433 if (!o->file_size_high)
434 o->file_size_high = o->file_size_low;
436 if (o->norandommap && o->verify != VERIFY_NONE
437 && !fixed_block_size(o)) {
438 log_err("fio: norandommap given for variable block sizes, "
439 "verify disabled\n");
440 o->verify = VERIFY_NONE;
441 ret = warnings_fatal;
443 if (o->bs_unaligned && (o->odirect || td->io_ops->flags & FIO_RAWIO))
444 log_err("fio: bs_unaligned may not work with raw io\n");
447 * thinktime_spin must be less than thinktime
449 if (o->thinktime_spin > o->thinktime)
450 o->thinktime_spin = o->thinktime;
453 * The low water mark cannot be bigger than the iodepth
455 if (o->iodepth_low > o->iodepth || !o->iodepth_low) {
457 * syslet work around - if the workload is sequential,
458 * we want to let the queue drain all the way down to
459 * avoid seeking between async threads
461 if (!strcmp(td->io_ops->name, "syslet-rw") && !td_random(td))
464 o->iodepth_low = o->iodepth;
468 * If batch number isn't set, default to the same as iodepth
470 if (o->iodepth_batch > o->iodepth || !o->iodepth_batch)
471 o->iodepth_batch = o->iodepth;
473 if (o->nr_files > td->files_index)
474 o->nr_files = td->files_index;
476 if (o->open_files > o->nr_files || !o->open_files)
477 o->open_files = o->nr_files;
479 if (((o->rate[0] + o->rate[1]) && (o->rate_iops[0] + o->rate_iops[1]))||
480 ((o->ratemin[0] + o->ratemin[1]) && (o->rate_iops_min[0] +
481 o->rate_iops_min[1]))) {
482 log_err("fio: rate and rate_iops are mutually exclusive\n");
485 if ((o->rate[0] < o->ratemin[0]) || (o->rate[1] < o->ratemin[1]) ||
486 (o->rate_iops[0] < o->rate_iops_min[0]) ||
487 (o->rate_iops[1] < o->rate_iops_min[1])) {
488 log_err("fio: minimum rate exceeds rate\n");
492 if (!o->timeout && o->time_based) {
493 log_err("fio: time_based requires a runtime/timeout setting\n");
495 ret = warnings_fatal;
498 if (o->fill_device && !o->size)
501 if (o->verify != VERIFY_NONE) {
502 if (td_write(td) && o->do_verify && o->numjobs > 1) {
503 log_info("Multiple writers may overwrite blocks that "
504 "belong to other jobs. This can cause "
505 "verification failures.\n");
506 ret = warnings_fatal;
509 o->refill_buffers = 1;
510 if (o->max_bs[DDIR_WRITE] != o->min_bs[DDIR_WRITE] &&
512 o->verify_interval = o->min_bs[DDIR_WRITE];
516 o->invalidate_cache = 0;
517 if (td->io_ops->flags & FIO_PIPEIO) {
518 log_info("fio: cannot pre-read files with an IO engine"
519 " that isn't seekable. Pre-read disabled.\n");
520 ret = warnings_fatal;
524 #ifndef FIO_HAVE_FDATASYNC
525 if (o->fdatasync_blocks) {
526 log_info("fio: this platform does not support fdatasync()"
527 " falling back to using fsync(). Use the 'fsync'"
528 " option instead of 'fdatasync' to get rid of"
530 o->fsync_blocks = o->fdatasync_blocks;
531 o->fdatasync_blocks = 0;
532 ret = warnings_fatal;
540 * This function leaks the buffer
542 static char *to_kmg(unsigned int val)
544 char *buf = malloc(32);
545 char post[] = { 0, 'K', 'M', 'G', 'P', 'E', 0 };
556 snprintf(buf, 31, "%u%c", val, *p);
560 /* External engines are specified by "external:name.o") */
561 static const char *get_engine_name(const char *str)
563 char *p = strstr(str, ":");
569 strip_blank_front(&p);
574 static int exists_and_not_file(const char *filename)
578 if (lstat(filename, &sb) == -1)
581 /* \\.\ is the device namespace in Windows, where every file
582 * is a device node */
583 if (S_ISREG(sb.st_mode) && strncmp(filename, "\\\\.\\", 4) != 0)
589 static void td_fill_rand_seeds_os(struct thread_data *td)
591 os_random_seed(td->rand_seeds[0], &td->bsrange_state);
592 os_random_seed(td->rand_seeds[1], &td->verify_state);
593 os_random_seed(td->rand_seeds[2], &td->rwmix_state);
595 if (td->o.file_service_type == FIO_FSERVICE_RANDOM)
596 os_random_seed(td->rand_seeds[3], &td->next_file_state);
598 os_random_seed(td->rand_seeds[5], &td->file_size_state);
599 os_random_seed(td->rand_seeds[6], &td->trim_state);
604 if (td->o.rand_repeatable)
605 td->rand_seeds[4] = FIO_RANDSEED * td->thread_number;
607 os_random_seed(td->rand_seeds[4], &td->random_state);
610 static void td_fill_rand_seeds_internal(struct thread_data *td)
612 init_rand_seed(&td->__bsrange_state, td->rand_seeds[0]);
613 init_rand_seed(&td->__verify_state, td->rand_seeds[1]);
614 init_rand_seed(&td->__rwmix_state, td->rand_seeds[2]);
616 if (td->o.file_service_type == FIO_FSERVICE_RANDOM)
617 init_rand_seed(&td->__next_file_state, td->rand_seeds[3]);
619 init_rand_seed(&td->__file_size_state, td->rand_seeds[5]);
620 init_rand_seed(&td->__trim_state, td->rand_seeds[6]);
625 if (td->o.rand_repeatable)
626 td->rand_seeds[4] = FIO_RANDSEED * td->thread_number;
628 init_rand_seed(&td->__random_state, td->rand_seeds[4]);
631 void td_fill_rand_seeds(struct thread_data *td)
633 if (td->o.use_os_rand)
634 td_fill_rand_seeds_os(td);
636 td_fill_rand_seeds_internal(td);
638 init_rand_seed(&td->buf_state, td->rand_seeds[7]);
642 * Initialize the various random states we need (random io, block size ranges,
643 * read/write mix, etc).
645 static int init_random_state(struct thread_data *td)
649 fd = open("/dev/urandom", O_RDONLY);
651 td_verror(td, errno, "open");
655 if (read(fd, td->rand_seeds, sizeof(td->rand_seeds)) <
656 (int) sizeof(td->rand_seeds)) {
657 td_verror(td, EIO, "read");
663 td_fill_rand_seeds(td);
668 * Adds a job to the list of things todo. Sanitizes the various options
669 * to make sure we don't have conflicts, and initializes various
672 static int add_job(struct thread_data *td, const char *jobname, int job_add_num)
674 const char *ddir_str[] = { NULL, "read", "write", "rw", NULL,
675 "randread", "randwrite", "randrw" };
678 char fname[PATH_MAX];
679 int numjobs, file_alloced;
682 * the def_thread is just for options, it's not a real job
684 if (td == &def_thread)
688 * if we are just dumping the output command line, don't add the job
695 if (profile_td_init(td))
698 engine = get_engine_name(td->o.ioengine);
699 td->io_ops = load_ioengine(td, engine);
701 log_err("fio: failed to load engine %s\n", engine);
705 if (td->o.use_thread)
711 td->io_ops->flags |= FIO_RAWIO;
714 if (!td->o.filename && !td->files_index && !td->o.read_iolog_file) {
717 if (td->o.nr_files == 1 && exists_and_not_file(jobname))
718 add_file(td, jobname);
720 for (i = 0; i < td->o.nr_files; i++) {
721 sprintf(fname, "%s.%d.%d", jobname,
722 td->thread_number, i);
728 if (fixup_options(td))
731 if (td->io_ops->flags & FIO_DISKLESSIO) {
734 for_each_file(td, f, i)
735 f->real_file_size = -1ULL;
738 td->mutex = fio_mutex_init(0);
740 td->ts.clat_percentiles = td->o.clat_percentiles;
741 if (td->o.overwrite_plist)
742 memcpy(td->ts.percentile_list, td->o.percentile_list, sizeof(td->o.percentile_list));
744 memcpy(td->ts.percentile_list, def_percentile_list, sizeof(def_percentile_list));
746 td->ts.clat_stat[0].min_val = td->ts.clat_stat[1].min_val = ULONG_MAX;
747 td->ts.slat_stat[0].min_val = td->ts.slat_stat[1].min_val = ULONG_MAX;
748 td->ts.lat_stat[0].min_val = td->ts.lat_stat[1].min_val = ULONG_MAX;
749 td->ts.bw_stat[0].min_val = td->ts.bw_stat[1].min_val = ULONG_MAX;
750 td->ddir_seq_nr = td->o.ddir_seq_nr;
752 if ((td->o.stonewall || td->o.new_group) && prev_group_jobs) {
757 td->groupid = groupid;
760 if (init_random_state(td))
766 if (td->o.write_lat_log) {
767 setup_log(&td->lat_log);
768 setup_log(&td->slat_log);
769 setup_log(&td->clat_log);
771 if (td->o.write_bw_log)
772 setup_log(&td->bw_log);
773 if (td->o.write_iops_log)
774 setup_log(&td->iops_log);
777 td->o.name = strdup(jobname);
781 if (!strcmp(td->io_ops->name, "cpuio")) {
782 log_info("%s: ioengine=cpu, cpuload=%u,"
783 " cpucycle=%u\n", td->o.name,
787 char *c1, *c2, *c3, *c4;
789 c1 = to_kmg(td->o.min_bs[DDIR_READ]);
790 c2 = to_kmg(td->o.max_bs[DDIR_READ]);
791 c3 = to_kmg(td->o.min_bs[DDIR_WRITE]);
792 c4 = to_kmg(td->o.max_bs[DDIR_WRITE]);
794 log_info("%s: (g=%d): rw=%s, bs=%s-%s/%s-%s,"
795 " ioengine=%s, iodepth=%u\n",
796 td->o.name, td->groupid,
797 ddir_str[td->o.td_ddir],
807 } else if (job_add_num == 1)
812 * recurse add identical jobs, clear numjobs and stonewall options
813 * as they don't apply to sub-jobs
815 numjobs = td->o.numjobs;
817 struct thread_data *td_new = get_new_job(0, td);
822 td_new->o.numjobs = 1;
823 td_new->o.stonewall = 0;
824 td_new->o.new_group = 0;
827 td_new->o.filename = NULL;
828 td_new->files_index = 0;
829 td_new->files_size = 0;
830 td_new->files = NULL;
833 job_add_num = numjobs - 1;
835 if (add_job(td_new, jobname, job_add_num))
846 * Parse as if 'o' was a command line
848 void add_job_opts(const char **o)
850 struct thread_data *td, *td_parent;
851 int i, in_global = 1;
855 td_parent = td = NULL;
857 if (!strncmp(o[i], "name", 4)) {
860 add_job(td, jobname, 0);
862 sprintf(jobname, "%s", o[i] + 5);
864 if (in_global && !td_parent)
865 td_parent = get_new_job(1, &def_thread);
866 else if (!in_global && !td) {
868 td_parent = &def_thread;
869 td = get_new_job(0, td_parent);
872 fio_options_parse(td_parent, (char **) &o[i], 1);
874 fio_options_parse(td, (char **) &o[i], 1);
879 add_job(td, jobname, 0);
882 static int skip_this_section(const char *name)
886 if (!nr_job_sections)
888 if (!strncmp(name, "global", 6))
891 for (i = 0; i < nr_job_sections; i++)
892 if (!strcmp(job_sections[i], name))
898 static int is_empty_or_comment(char *line)
902 for (i = 0; i < strlen(line); i++) {
907 if (!isspace((int) line[i]) && !iscntrl((int) line[i]))
915 * This is our [ini] type file parser.
917 int parse_jobs_ini(char *file, int is_buf, int stonewall_flag)
920 struct thread_data *td;
924 int ret = 0, stonewall;
929 int i, alloc_opts, num_opts;
934 if (!strcmp(file, "-"))
937 f = fopen(file, "r");
940 perror("fopen job file");
945 string = malloc(4096);
948 * it's really 256 + small bit, 280 should suffice
951 memset(name, 0, 280);
954 opts = malloc(sizeof(char *) * alloc_opts);
957 stonewall = stonewall_flag;
960 * if skip_fgets is set, we already have loaded a line we
965 p = strsep(&file, "\n");
967 p = fgets(string, 4095, f);
973 strip_blank_front(&p);
976 if (is_empty_or_comment(p))
978 if (sscanf(p, "[%255[^\n]]", name) != 1) {
981 log_err("fio: option <%s> outside of [] job section\n",
986 name[strlen(name) - 1] = '\0';
988 if (skip_this_section(name)) {
994 global = !strncmp(name, "global", 6);
1000 log_info("--name=%s ", name);
1004 td = get_new_job(global, &def_thread);
1011 * Seperate multiple job files by a stonewall
1013 if (!global && stonewall) {
1014 td->o.stonewall = stonewall;
1019 memset(opts, 0, alloc_opts * sizeof(char *));
1023 p = strsep(&file, "\n");
1025 p = fgets(string, 4096, f);
1029 if (is_empty_or_comment(p))
1032 strip_blank_front(&p);
1035 * new section, break out and make sure we don't
1036 * fgets() a new line at the top.
1045 if (num_opts == alloc_opts) {
1047 opts = realloc(opts,
1048 alloc_opts * sizeof(char *));
1051 opts[num_opts] = strdup(p);
1055 ret = fio_options_parse(td, opts, num_opts);
1058 for (i = 0; i < num_opts; i++)
1059 log_info("--%s ", opts[i]);
1061 ret = add_job(td, name, 0);
1063 log_err("fio: job %s dropped\n", name);
1067 for (i = 0; i < num_opts; i++)
1076 while (i < nr_job_sections) {
1077 free(job_sections[i]);
1081 for (i = 0; i < num_opts; i++)
1087 if (!is_buf && f != stdin)
1092 static int fill_def_thread(void)
1094 memset(&def_thread, 0, sizeof(def_thread));
1096 fio_getaffinity(getpid(), &def_thread.o.cpumask);
1097 def_thread.o.timeout = def_timeout;
1100 * fill default options
1102 fio_fill_default_options(&def_thread);
1106 static void usage(const char *name)
1108 printf("fio %s\n", fio_version_string);
1109 printf("%s [options] [job options] <job file(s)>\n", name);
1110 printf("\t--debug=options\tEnable debug logging\n");
1111 printf("\t--output\tWrite output to file\n");
1112 printf("\t--timeout\tRuntime in seconds\n");
1113 printf("\t--latency-log\tGenerate per-job latency logs\n");
1114 printf("\t--bandwidth-log\tGenerate per-job bandwidth logs\n");
1115 printf("\t--minimal\tMinimal (terse) output\n");
1116 printf("\t--version\tPrint version info and exit\n");
1117 printf("\t--terse-version=x Terse version output format\n");
1118 printf("\t--help\t\tPrint this page\n");
1119 printf("\t--cmdhelp=cmd\tPrint command help, \"all\" for all of"
1121 printf("\t--showcmd\tTurn a job file into command line options\n");
1122 printf("\t--eta=when\tWhen ETA estimate should be printed\n");
1123 printf("\t \tMay be \"always\", \"never\" or \"auto\"\n");
1124 printf("\t--readonly\tTurn on safety read-only checks, preventing"
1126 printf("\t--section=name\tOnly run specified section in job file\n");
1127 printf("\t--alloc-size=kb\tSet smalloc pool to this size in kb"
1129 printf("\t--warnings-fatal Fio parser warnings are fatal\n");
1130 printf("\t--max-jobs\tMaximum number of threads/processes to support\n");
1131 printf("\t--server=args\tStart a backend fio server\n");
1132 printf("\t--daemonize=pidfile Background fio server, write pid to file\n");
1133 printf("\t--client=hostname Talk to remote backend fio server at hostname\n");
1134 printf("\nFio was written by Jens Axboe <jens.axboe@oracle.com>");
1135 printf("\n Jens Axboe <jaxboe@fusionio.com>\n");
1138 #ifdef FIO_INC_DEBUG
1139 struct debug_level debug_levels[] = {
1140 { .name = "process", .shift = FD_PROCESS, },
1141 { .name = "file", .shift = FD_FILE, },
1142 { .name = "io", .shift = FD_IO, },
1143 { .name = "mem", .shift = FD_MEM, },
1144 { .name = "blktrace", .shift = FD_BLKTRACE },
1145 { .name = "verify", .shift = FD_VERIFY },
1146 { .name = "random", .shift = FD_RANDOM },
1147 { .name = "parse", .shift = FD_PARSE },
1148 { .name = "diskutil", .shift = FD_DISKUTIL },
1149 { .name = "job", .shift = FD_JOB },
1150 { .name = "mutex", .shift = FD_MUTEX },
1151 { .name = "profile", .shift = FD_PROFILE },
1152 { .name = "time", .shift = FD_TIME },
1153 { .name = "net", .shift = FD_NET },
1157 static int set_debug(const char *string)
1159 struct debug_level *dl;
1160 char *p = (char *) string;
1164 if (!strcmp(string, "?") || !strcmp(string, "help")) {
1165 log_info("fio: dumping debug options:");
1166 for (i = 0; debug_levels[i].name; i++) {
1167 dl = &debug_levels[i];
1168 log_info("%s,", dl->name);
1174 while ((opt = strsep(&p, ",")) != NULL) {
1177 if (!strncmp(opt, "all", 3)) {
1178 log_info("fio: set all debug options\n");
1183 for (i = 0; debug_levels[i].name; i++) {
1184 dl = &debug_levels[i];
1185 found = !strncmp(opt, dl->name, strlen(dl->name));
1189 if (dl->shift == FD_JOB) {
1190 opt = strchr(opt, ':');
1192 log_err("fio: missing job number\n");
1196 fio_debug_jobno = atoi(opt);
1197 log_info("fio: set debug jobno %d\n",
1200 log_info("fio: set debug option %s\n", opt);
1201 fio_debug |= (1UL << dl->shift);
1207 log_err("fio: debug mask %s not found\n", opt);
1212 static int set_debug(const char *string)
1214 log_err("fio: debug tracing not included in build\n");
1219 static void fio_options_fill_optstring(void)
1221 char *ostr = cmd_optstr;
1225 while (l_opts[i].name) {
1226 ostr[c++] = l_opts[i].val;
1227 if (l_opts[i].has_arg == required_argument)
1229 else if (l_opts[i].has_arg == optional_argument) {
1238 static int client_flag_set(char c)
1243 while (l_opts[i].name) {
1244 int val = l_opts[i].val;
1246 if (c == (val & 0xff))
1247 return (val & FIO_CLIENT_FLAG);
1255 void parse_cmd_client(void *client, char *opt)
1257 fio_client_add_cmd_option(client, opt);
1260 int parse_cmd_line(int argc, char *argv[])
1262 struct thread_data *td = NULL;
1263 int c, ini_idx = 0, lidx, ret = 0, do_exit = 0, exit_val = 0;
1264 char *ostr = cmd_optstr;
1265 void *pid_file = NULL;
1266 void *cur_client = NULL;
1270 * Reset optind handling, since we may call this multiple times
1275 while ((c = getopt_long_only(argc, argv, ostr, l_opts, &lidx)) != -1) {
1278 if ((c & FIO_CLIENT_FLAG) || client_flag_set(c)) {
1279 parse_cmd_client(cur_client, argv[optind - 1]);
1280 c &= ~FIO_CLIENT_FLAG;
1285 smalloc_pool_size = atoi(optarg);
1288 def_timeout = atoi(optarg);
1297 f_out = fopen(optarg, "w+");
1299 perror("fopen output");
1315 fio_show_option_help(optarg);
1327 log_info("fio %s\n", fio_version_string);
1332 terse_version = atoi(optarg);
1333 if (terse_version != 3) {
1334 log_err("fio: bad terse version format\n");
1340 if (!strcmp("always", optarg))
1341 eta_print = FIO_ETA_ALWAYS;
1342 else if (!strcmp("never", optarg))
1343 eta_print = FIO_ETA_NEVER;
1346 if (set_debug(optarg))
1352 if (!strcmp(optarg, "global")) {
1353 log_err("fio: can't use global as only "
1359 new_size = (nr_job_sections + 1) * sizeof(char *);
1360 job_sections = realloc(job_sections, new_size);
1361 job_sections[nr_job_sections] = strdup(optarg);
1366 exec_profile = strdup(optarg);
1368 case FIO_GETOPT_JOB: {
1369 const char *opt = l_opts[lidx].name;
1372 if (!strncmp(opt, "name", 4) && td) {
1373 ret = add_job(td, td->o.name ?: "fio", 0);
1379 int is_section = !strncmp(opt, "name", 4);
1382 if (!is_section || !strncmp(val, "global", 6))
1385 if (is_section && skip_this_section(val))
1388 td = get_new_job(global, &def_thread);
1393 ret = fio_cmd_option_parse(td, opt, val);
1400 max_jobs = atoi(optarg);
1401 if (!max_jobs || max_jobs > REAL_MAX_JOBS) {
1402 log_err("fio: invalid max jobs: %d\n", max_jobs);
1409 log_err("fio: can't be both client and server\n");
1415 fio_server_set_arg(optarg);
1420 pid_file = strdup(optarg);
1424 log_err("fio: can't be both client and server\n");
1429 if (fio_client_add(optarg, &cur_client)) {
1430 log_err("fio: failed adding client %s\n", optarg);
1446 if (exit_val && !(is_backend || nr_clients))
1450 if (nr_clients && fio_clients_connect()) {
1456 if (is_backend && backend)
1457 return fio_start_server(pid_file);
1461 ret = add_job(td, td->o.name ?: "fio", 0);
1464 while (!ret && optind < argc) {
1466 ini_file = realloc(ini_file, ini_idx * sizeof(char *));
1467 ini_file[ini_idx - 1] = strdup(argv[optind]);
1474 int parse_options(int argc, char *argv[])
1481 fio_options_fill_optstring();
1482 fio_options_dup_and_init(l_opts);
1486 if (fill_def_thread())
1489 job_files = parse_cmd_line(argc, argv);
1491 if (job_files > 0) {
1492 for (i = 0; i < job_files; i++) {
1493 if (fill_def_thread())
1496 if (fio_clients_send_ini(ini_file[i]))
1499 } else if (!is_backend) {
1500 if (parse_jobs_ini(ini_file[i], 0, i))
1508 fio_options_free(&def_thread);
1510 if (!thread_number) {
1515 if (is_backend || nr_clients)
1520 log_err("No jobs(s) defined\n\n");
1530 if (def_thread.o.gtod_offload) {
1532 fio_gtod_offload = 1;
1533 fio_gtod_cpu = def_thread.o.gtod_cpu;
1537 log_info("fio %s\n", fio_version_string);