2 * This file contains job initialization and setup functions.
13 #include <sys/types.h>
24 #include "lib/getopt.h"
27 static char fio_version_string[] = __fio_stringify(FIO_MAJOR) "." \
28 __fio_stringify(FIO_MINOR) "." \
29 __fio_stringify(FIO_PATCH);
31 static char fio_version_string[] = __fio_stringify(FIO_MAJOR) "." \
32 __fio_stringify(FIO_MINOR);
35 #define FIO_RANDSEED (0xb1899bedUL)
37 static char **ini_file;
38 static int max_jobs = FIO_MAX_JOBS;
39 static int dump_cmdline;
40 static int def_timeout;
42 static struct thread_data def_thread;
43 struct thread_data *threads = NULL;
45 int exitall_on_terminate = 0;
48 unsigned long long mlock_size = 0;
51 char **job_sections = NULL;
52 int nr_job_sections = 0;
53 char *exec_profile = NULL;
54 int warnings_fatal = 0;
55 int terse_version = 2;
63 static int write_lat_log;
65 static int prev_group_jobs;
67 unsigned long fio_debug = 0;
68 unsigned int fio_debug_jobno = -1;
69 unsigned int *fio_debug_jobp = NULL;
71 static char cmd_optstr[256];
74 const fio_fp64_t def_percentile_list[FIO_IO_U_LIST_MAX_LEN] = {
92 #define FIO_CLIENT_FLAG (1 << 16)
95 * Command line options. These will contain the above, plus a few
96 * extra that only pertain to fio itself and not jobs.
98 static struct option l_opts[FIO_NR_OPTIONS] = {
100 .name = (char *) "output",
101 .has_arg = required_argument,
102 .val = 'o' | FIO_CLIENT_FLAG,
105 .name = (char *) "timeout",
106 .has_arg = required_argument,
107 .val = 't' | FIO_CLIENT_FLAG,
110 .name = (char *) "latency-log",
111 .has_arg = required_argument,
112 .val = 'l' | FIO_CLIENT_FLAG,
115 .name = (char *) "bandwidth-log",
116 .has_arg = required_argument,
117 .val = 'b' | FIO_CLIENT_FLAG,
120 .name = (char *) "minimal",
121 .has_arg = optional_argument,
122 .val = 'm' | FIO_CLIENT_FLAG,
125 .name = (char *) "version",
126 .has_arg = no_argument,
127 .val = 'v' | FIO_CLIENT_FLAG,
130 .name = (char *) "help",
131 .has_arg = no_argument,
132 .val = 'h' | FIO_CLIENT_FLAG,
135 .name = (char *) "cmdhelp",
136 .has_arg = optional_argument,
137 .val = 'c' | FIO_CLIENT_FLAG,
140 .name = (char *) "showcmd",
141 .has_arg = no_argument,
142 .val = 's' | FIO_CLIENT_FLAG,
145 .name = (char *) "readonly",
146 .has_arg = no_argument,
147 .val = 'r' | FIO_CLIENT_FLAG,
150 .name = (char *) "eta",
151 .has_arg = required_argument,
152 .val = 'e' | FIO_CLIENT_FLAG,
155 .name = (char *) "debug",
156 .has_arg = required_argument,
157 .val = 'd' | FIO_CLIENT_FLAG,
160 .name = (char *) "section",
161 .has_arg = required_argument,
162 .val = 'x' | FIO_CLIENT_FLAG,
165 .name = (char *) "alloc-size",
166 .has_arg = required_argument,
167 .val = 'a' | FIO_CLIENT_FLAG,
170 .name = (char *) "profile",
171 .has_arg = required_argument,
172 .val = 'p' | FIO_CLIENT_FLAG,
175 .name = (char *) "warnings-fatal",
176 .has_arg = no_argument,
177 .val = 'w' | FIO_CLIENT_FLAG,
180 .name = (char *) "max-jobs",
181 .has_arg = required_argument,
182 .val = 'j' | FIO_CLIENT_FLAG,
185 .name = (char *) "terse-version",
186 .has_arg = required_argument,
187 .val = 'V' | FIO_CLIENT_FLAG,
190 .name = (char *) "server",
191 .has_arg = no_argument,
194 { .name = (char *) "daemonize",
195 .has_arg = no_argument,
199 .name = (char *) "net-port",
200 .has_arg = required_argument,
204 .name = (char *) "client",
205 .has_arg = required_argument,
213 static void free_shm(void)
215 struct shmid_ds sbuf;
222 fio_debug_jobp = NULL;
224 shmctl(shm_id, IPC_RMID, &sbuf);
231 * The thread area is shared between the main process and the job
232 * threads/processes. So setup a shared memory segment that will hold
233 * all the job info. We use the end of the region for keeping track of
234 * open files across jobs, for file sharing.
236 static int setup_thread_area(void)
244 * 1024 is too much on some machines, scale max_jobs if
245 * we get a failure that looks like too large a shm segment
248 size_t size = max_jobs * sizeof(struct thread_data);
250 size += file_hash_size;
251 size += sizeof(unsigned int);
253 shm_id = shmget(0, size, IPC_CREAT | 0600);
256 if (errno != EINVAL) {
267 threads = shmat(shm_id, NULL, 0);
268 if (threads == (void *) -1) {
273 memset(threads, 0, max_jobs * sizeof(struct thread_data));
274 hash = (void *) threads + max_jobs * sizeof(struct thread_data);
275 fio_debug_jobp = (void *) hash + file_hash_size;
276 *fio_debug_jobp = -1;
277 file_hash_init(hash);
282 * Return a free job structure.
284 static struct thread_data *get_new_job(int global, struct thread_data *parent)
286 struct thread_data *td;
290 if (setup_thread_area()) {
291 log_err("error: failed to setup shm segment\n");
294 if (thread_number >= max_jobs) {
295 log_err("error: maximum number of jobs (%d) reached.\n",
300 td = &threads[thread_number++];
303 td->o.uid = td->o.gid = -1U;
305 dup_files(td, parent);
306 options_mem_dupe(td);
308 profile_add_hooks(td);
310 td->thread_number = thread_number;
314 static void put_job(struct thread_data *td)
316 if (td == &def_thread)
322 log_info("fio: %s\n", td->verror);
324 memset(&threads[td->thread_number - 1], 0, sizeof(*td));
328 static int __setup_rate(struct thread_data *td, enum fio_ddir ddir)
330 unsigned int bs = td->o.min_bs[ddir];
331 unsigned long long bytes_per_sec;
333 assert(ddir_rw(ddir));
335 if (td->o.rate[ddir])
336 bytes_per_sec = td->o.rate[ddir];
338 bytes_per_sec = td->o.rate_iops[ddir] * bs;
340 if (!bytes_per_sec) {
341 log_err("rate lower than supported\n");
345 td->rate_nsec_cycle[ddir] = 1000000000ULL / bytes_per_sec;
346 td->rate_pending_usleep[ddir] = 0;
350 static int setup_rate(struct thread_data *td)
354 if (td->o.rate[DDIR_READ] || td->o.rate_iops[DDIR_READ])
355 ret = __setup_rate(td, DDIR_READ);
356 if (td->o.rate[DDIR_WRITE] || td->o.rate_iops[DDIR_WRITE])
357 ret |= __setup_rate(td, DDIR_WRITE);
362 static int fixed_block_size(struct thread_options *o)
364 return o->min_bs[DDIR_READ] == o->max_bs[DDIR_READ] &&
365 o->min_bs[DDIR_WRITE] == o->max_bs[DDIR_WRITE] &&
366 o->min_bs[DDIR_READ] == o->min_bs[DDIR_WRITE];
370 * Lazy way of fixing up options that depend on each other. We could also
371 * define option callback handlers, but this is easier.
373 static int fixup_options(struct thread_data *td)
375 struct thread_options *o = &td->o;
378 #ifndef FIO_HAVE_PSHARED_MUTEX
379 if (!o->use_thread) {
380 log_info("fio: this platform does not support process shared"
381 " mutexes, forcing use of threads. Use the 'thread'"
382 " option to get rid of this warning.\n");
384 ret = warnings_fatal;
388 if (o->write_iolog_file && o->read_iolog_file) {
389 log_err("fio: read iolog overrides write_iolog\n");
390 free(o->write_iolog_file);
391 o->write_iolog_file = NULL;
392 ret = warnings_fatal;
396 * only really works for sequential io for now, and with 1 file
398 if (o->zone_size && td_random(td) && o->open_files == 1)
402 * Reads can do overwrites, we always need to pre-create the file
404 if (td_read(td) || td_rw(td))
407 if (!o->min_bs[DDIR_READ])
408 o->min_bs[DDIR_READ] = o->bs[DDIR_READ];
409 if (!o->max_bs[DDIR_READ])
410 o->max_bs[DDIR_READ] = o->bs[DDIR_READ];
411 if (!o->min_bs[DDIR_WRITE])
412 o->min_bs[DDIR_WRITE] = o->bs[DDIR_WRITE];
413 if (!o->max_bs[DDIR_WRITE])
414 o->max_bs[DDIR_WRITE] = o->bs[DDIR_WRITE];
416 o->rw_min_bs = min(o->min_bs[DDIR_READ], o->min_bs[DDIR_WRITE]);
419 * For random IO, allow blockalign offset other than min_bs.
421 if (!o->ba[DDIR_READ] || !td_random(td))
422 o->ba[DDIR_READ] = o->min_bs[DDIR_READ];
423 if (!o->ba[DDIR_WRITE] || !td_random(td))
424 o->ba[DDIR_WRITE] = o->min_bs[DDIR_WRITE];
426 if ((o->ba[DDIR_READ] != o->min_bs[DDIR_READ] ||
427 o->ba[DDIR_WRITE] != o->min_bs[DDIR_WRITE]) &&
429 log_err("fio: Any use of blockalign= turns off randommap\n");
431 ret = warnings_fatal;
434 if (!o->file_size_high)
435 o->file_size_high = o->file_size_low;
437 if (o->norandommap && o->verify != VERIFY_NONE
438 && !fixed_block_size(o)) {
439 log_err("fio: norandommap given for variable block sizes, "
440 "verify disabled\n");
441 o->verify = VERIFY_NONE;
442 ret = warnings_fatal;
444 if (o->bs_unaligned && (o->odirect || td->io_ops->flags & FIO_RAWIO))
445 log_err("fio: bs_unaligned may not work with raw io\n");
448 * thinktime_spin must be less than thinktime
450 if (o->thinktime_spin > o->thinktime)
451 o->thinktime_spin = o->thinktime;
454 * The low water mark cannot be bigger than the iodepth
456 if (o->iodepth_low > o->iodepth || !o->iodepth_low) {
458 * syslet work around - if the workload is sequential,
459 * we want to let the queue drain all the way down to
460 * avoid seeking between async threads
462 if (!strcmp(td->io_ops->name, "syslet-rw") && !td_random(td))
465 o->iodepth_low = o->iodepth;
469 * If batch number isn't set, default to the same as iodepth
471 if (o->iodepth_batch > o->iodepth || !o->iodepth_batch)
472 o->iodepth_batch = o->iodepth;
474 if (o->nr_files > td->files_index)
475 o->nr_files = td->files_index;
477 if (o->open_files > o->nr_files || !o->open_files)
478 o->open_files = o->nr_files;
480 if (((o->rate[0] + o->rate[1]) && (o->rate_iops[0] + o->rate_iops[1]))||
481 ((o->ratemin[0] + o->ratemin[1]) && (o->rate_iops_min[0] +
482 o->rate_iops_min[1]))) {
483 log_err("fio: rate and rate_iops are mutually exclusive\n");
486 if ((o->rate[0] < o->ratemin[0]) || (o->rate[1] < o->ratemin[1]) ||
487 (o->rate_iops[0] < o->rate_iops_min[0]) ||
488 (o->rate_iops[1] < o->rate_iops_min[1])) {
489 log_err("fio: minimum rate exceeds rate\n");
493 if (!o->timeout && o->time_based) {
494 log_err("fio: time_based requires a runtime/timeout setting\n");
496 ret = warnings_fatal;
499 if (o->fill_device && !o->size)
502 if (o->verify != VERIFY_NONE) {
503 if (td_write(td) && o->do_verify && o->numjobs > 1) {
504 log_info("Multiple writers may overwrite blocks that "
505 "belong to other jobs. This can cause "
506 "verification failures.\n");
507 ret = warnings_fatal;
510 o->refill_buffers = 1;
511 if (o->max_bs[DDIR_WRITE] != o->min_bs[DDIR_WRITE] &&
513 o->verify_interval = o->min_bs[DDIR_WRITE];
517 o->invalidate_cache = 0;
518 if (td->io_ops->flags & FIO_PIPEIO) {
519 log_info("fio: cannot pre-read files with an IO engine"
520 " that isn't seekable. Pre-read disabled.\n");
521 ret = warnings_fatal;
525 #ifndef FIO_HAVE_FDATASYNC
526 if (o->fdatasync_blocks) {
527 log_info("fio: this platform does not support fdatasync()"
528 " falling back to using fsync(). Use the 'fsync'"
529 " option instead of 'fdatasync' to get rid of"
531 o->fsync_blocks = o->fdatasync_blocks;
532 o->fdatasync_blocks = 0;
533 ret = warnings_fatal;
541 * This function leaks the buffer
543 static char *to_kmg(unsigned int val)
545 char *buf = malloc(32);
546 char post[] = { 0, 'K', 'M', 'G', 'P', 'E', 0 };
557 snprintf(buf, 31, "%u%c", val, *p);
561 /* External engines are specified by "external:name.o") */
562 static const char *get_engine_name(const char *str)
564 char *p = strstr(str, ":");
570 strip_blank_front(&p);
575 static int exists_and_not_file(const char *filename)
579 if (lstat(filename, &sb) == -1)
582 /* \\.\ is the device namespace in Windows, where every file
583 * is a device node */
584 if (S_ISREG(sb.st_mode) && strncmp(filename, "\\\\.\\", 4) != 0)
590 static void td_fill_rand_seeds_os(struct thread_data *td)
592 os_random_seed(td->rand_seeds[0], &td->bsrange_state);
593 os_random_seed(td->rand_seeds[1], &td->verify_state);
594 os_random_seed(td->rand_seeds[2], &td->rwmix_state);
596 if (td->o.file_service_type == FIO_FSERVICE_RANDOM)
597 os_random_seed(td->rand_seeds[3], &td->next_file_state);
599 os_random_seed(td->rand_seeds[5], &td->file_size_state);
600 os_random_seed(td->rand_seeds[6], &td->trim_state);
605 if (td->o.rand_repeatable)
606 td->rand_seeds[4] = FIO_RANDSEED * td->thread_number;
608 os_random_seed(td->rand_seeds[4], &td->random_state);
611 static void td_fill_rand_seeds_internal(struct thread_data *td)
613 init_rand_seed(&td->__bsrange_state, td->rand_seeds[0]);
614 init_rand_seed(&td->__verify_state, td->rand_seeds[1]);
615 init_rand_seed(&td->__rwmix_state, td->rand_seeds[2]);
617 if (td->o.file_service_type == FIO_FSERVICE_RANDOM)
618 init_rand_seed(&td->__next_file_state, td->rand_seeds[3]);
620 init_rand_seed(&td->__file_size_state, td->rand_seeds[5]);
621 init_rand_seed(&td->__trim_state, td->rand_seeds[6]);
626 if (td->o.rand_repeatable)
627 td->rand_seeds[4] = FIO_RANDSEED * td->thread_number;
629 init_rand_seed(&td->__random_state, td->rand_seeds[4]);
632 void td_fill_rand_seeds(struct thread_data *td)
634 if (td->o.use_os_rand)
635 td_fill_rand_seeds_os(td);
637 td_fill_rand_seeds_internal(td);
639 init_rand_seed(&td->buf_state, td->rand_seeds[7]);
643 * Initialize the various random states we need (random io, block size ranges,
644 * read/write mix, etc).
646 static int init_random_state(struct thread_data *td)
650 fd = open("/dev/urandom", O_RDONLY);
652 td_verror(td, errno, "open");
656 if (read(fd, td->rand_seeds, sizeof(td->rand_seeds)) <
657 (int) sizeof(td->rand_seeds)) {
658 td_verror(td, EIO, "read");
664 td_fill_rand_seeds(td);
669 * Adds a job to the list of things todo. Sanitizes the various options
670 * to make sure we don't have conflicts, and initializes various
673 static int add_job(struct thread_data *td, const char *jobname, int job_add_num)
675 const char *ddir_str[] = { NULL, "read", "write", "rw", NULL,
676 "randread", "randwrite", "randrw" };
679 char fname[PATH_MAX];
680 int numjobs, file_alloced;
683 * the def_thread is just for options, it's not a real job
685 if (td == &def_thread)
689 * if we are just dumping the output command line, don't add the job
696 if (profile_td_init(td))
699 engine = get_engine_name(td->o.ioengine);
700 td->io_ops = load_ioengine(td, engine);
702 log_err("fio: failed to load engine %s\n", engine);
706 if (td->o.use_thread)
712 td->io_ops->flags |= FIO_RAWIO;
715 if (!td->o.filename && !td->files_index && !td->o.read_iolog_file) {
718 if (td->o.nr_files == 1 && exists_and_not_file(jobname))
719 add_file(td, jobname);
721 for (i = 0; i < td->o.nr_files; i++) {
722 sprintf(fname, "%s.%d.%d", jobname,
723 td->thread_number, i);
729 if (fixup_options(td))
732 if (td->io_ops->flags & FIO_DISKLESSIO) {
735 for_each_file(td, f, i)
736 f->real_file_size = -1ULL;
739 td->mutex = fio_mutex_init(0);
741 td->ts.clat_percentiles = td->o.clat_percentiles;
742 if (td->o.overwrite_plist)
743 memcpy(td->ts.percentile_list, td->o.percentile_list, sizeof(td->o.percentile_list));
745 memcpy(td->ts.percentile_list, def_percentile_list, sizeof(def_percentile_list));
747 td->ts.clat_stat[0].min_val = td->ts.clat_stat[1].min_val = ULONG_MAX;
748 td->ts.slat_stat[0].min_val = td->ts.slat_stat[1].min_val = ULONG_MAX;
749 td->ts.lat_stat[0].min_val = td->ts.lat_stat[1].min_val = ULONG_MAX;
750 td->ts.bw_stat[0].min_val = td->ts.bw_stat[1].min_val = ULONG_MAX;
751 td->ddir_seq_nr = td->o.ddir_seq_nr;
753 if ((td->o.stonewall || td->o.new_group) && prev_group_jobs) {
758 td->groupid = groupid;
761 if (init_random_state(td))
767 if (td->o.write_lat_log) {
768 setup_log(&td->lat_log);
769 setup_log(&td->slat_log);
770 setup_log(&td->clat_log);
772 if (td->o.write_bw_log)
773 setup_log(&td->bw_log);
774 if (td->o.write_iops_log)
775 setup_log(&td->iops_log);
778 td->o.name = strdup(jobname);
782 if (!strcmp(td->io_ops->name, "cpuio")) {
783 log_info("%s: ioengine=cpu, cpuload=%u,"
784 " cpucycle=%u\n", td->o.name,
788 char *c1, *c2, *c3, *c4;
790 c1 = to_kmg(td->o.min_bs[DDIR_READ]);
791 c2 = to_kmg(td->o.max_bs[DDIR_READ]);
792 c3 = to_kmg(td->o.min_bs[DDIR_WRITE]);
793 c4 = to_kmg(td->o.max_bs[DDIR_WRITE]);
795 log_info("%s: (g=%d): rw=%s, bs=%s-%s/%s-%s,"
796 " ioengine=%s, iodepth=%u\n",
797 td->o.name, td->groupid,
798 ddir_str[td->o.td_ddir],
808 } else if (job_add_num == 1)
813 * recurse add identical jobs, clear numjobs and stonewall options
814 * as they don't apply to sub-jobs
816 numjobs = td->o.numjobs;
818 struct thread_data *td_new = get_new_job(0, td);
823 td_new->o.numjobs = 1;
824 td_new->o.stonewall = 0;
825 td_new->o.new_group = 0;
828 td_new->o.filename = NULL;
829 td_new->files_index = 0;
830 td_new->files_size = 0;
831 td_new->files = NULL;
834 job_add_num = numjobs - 1;
836 if (add_job(td_new, jobname, job_add_num))
847 * Parse as if 'o' was a command line
849 void add_job_opts(const char **o)
851 struct thread_data *td, *td_parent;
852 int i, in_global = 1;
856 td_parent = td = NULL;
858 if (!strncmp(o[i], "name", 4)) {
861 add_job(td, jobname, 0);
863 sprintf(jobname, "%s", o[i] + 5);
865 if (in_global && !td_parent)
866 td_parent = get_new_job(1, &def_thread);
867 else if (!in_global && !td) {
869 td_parent = &def_thread;
870 td = get_new_job(0, td_parent);
873 fio_options_parse(td_parent, (char **) &o[i], 1);
875 fio_options_parse(td, (char **) &o[i], 1);
880 add_job(td, jobname, 0);
883 static int skip_this_section(const char *name)
887 if (!nr_job_sections)
889 if (!strncmp(name, "global", 6))
892 for (i = 0; i < nr_job_sections; i++)
893 if (!strcmp(job_sections[i], name))
899 static int is_empty_or_comment(char *line)
903 for (i = 0; i < strlen(line); i++) {
908 if (!isspace((int) line[i]) && !iscntrl((int) line[i]))
916 * This is our [ini] type file parser.
918 int parse_jobs_ini(char *file, int is_buf, int stonewall_flag)
921 struct thread_data *td;
925 int ret = 0, stonewall;
930 int i, alloc_opts, num_opts;
935 if (!strcmp(file, "-"))
938 f = fopen(file, "r");
941 perror("fopen job file");
946 string = malloc(4096);
949 * it's really 256 + small bit, 280 should suffice
952 memset(name, 0, 280);
955 opts = malloc(sizeof(char *) * alloc_opts);
958 stonewall = stonewall_flag;
961 * if skip_fgets is set, we already have loaded a line we
966 p = strsep(&file, "\n");
968 p = fgets(string, 4095, f);
974 strip_blank_front(&p);
977 if (is_empty_or_comment(p))
979 if (sscanf(p, "[%255[^\n]]", name) != 1) {
982 log_err("fio: option <%s> outside of [] job section\n",
987 name[strlen(name) - 1] = '\0';
989 if (skip_this_section(name)) {
995 global = !strncmp(name, "global", 6);
1001 log_info("--name=%s ", name);
1005 td = get_new_job(global, &def_thread);
1012 * Seperate multiple job files by a stonewall
1014 if (!global && stonewall) {
1015 td->o.stonewall = stonewall;
1020 memset(opts, 0, alloc_opts * sizeof(char *));
1024 p = strsep(&file, "\n");
1026 p = fgets(string, 4096, f);
1030 if (is_empty_or_comment(p))
1033 strip_blank_front(&p);
1036 * new section, break out and make sure we don't
1037 * fgets() a new line at the top.
1046 if (num_opts == alloc_opts) {
1048 opts = realloc(opts,
1049 alloc_opts * sizeof(char *));
1052 opts[num_opts] = strdup(p);
1056 ret = fio_options_parse(td, opts, num_opts);
1059 for (i = 0; i < num_opts; i++)
1060 log_info("--%s ", opts[i]);
1062 ret = add_job(td, name, 0);
1064 log_err("fio: job %s dropped\n", name);
1068 for (i = 0; i < num_opts; i++)
1076 for (i = 0; i < num_opts; i++)
1082 if (!is_buf && f != stdin)
1087 static int fill_def_thread(void)
1089 memset(&def_thread, 0, sizeof(def_thread));
1091 fio_getaffinity(getpid(), &def_thread.o.cpumask);
1092 def_thread.o.timeout = def_timeout;
1095 * fill default options
1097 fio_fill_default_options(&def_thread);
1101 static void usage(const char *name)
1103 printf("fio %s\n", fio_version_string);
1104 printf("%s [options] [job options] <job file(s)>\n", name);
1105 printf("\t--debug=options\tEnable debug logging\n");
1106 printf("\t--output\tWrite output to file\n");
1107 printf("\t--timeout\tRuntime in seconds\n");
1108 printf("\t--latency-log\tGenerate per-job latency logs\n");
1109 printf("\t--bandwidth-log\tGenerate per-job bandwidth logs\n");
1110 printf("\t--minimal\tMinimal (terse) output\n");
1111 printf("\t--version\tPrint version info and exit\n");
1112 printf("\t--terse-version=x Terse version output format\n");
1113 printf("\t--help\t\tPrint this page\n");
1114 printf("\t--cmdhelp=cmd\tPrint command help, \"all\" for all of"
1116 printf("\t--showcmd\tTurn a job file into command line options\n");
1117 printf("\t--eta=when\tWhen ETA estimate should be printed\n");
1118 printf("\t \tMay be \"always\", \"never\" or \"auto\"\n");
1119 printf("\t--readonly\tTurn on safety read-only checks, preventing"
1121 printf("\t--section=name\tOnly run specified section in job file\n");
1122 printf("\t--alloc-size=kb\tSet smalloc pool to this size in kb"
1124 printf("\t--warnings-fatal Fio parser warnings are fatal\n");
1125 printf("\t--max-jobs\tMaximum number of threads/processes to support\n");
1126 printf("\t--server\tStart a backend fio server\n");
1127 printf("\t--client=hostname Talk to remove backend fio server at hostname\n");
1128 printf("\t--net-port=port\tUse specified port for client/server connection\n");
1129 printf("\nFio was written by Jens Axboe <jens.axboe@oracle.com>");
1130 printf("\n Jens Axboe <jaxboe@fusionio.com>\n");
1133 #ifdef FIO_INC_DEBUG
1134 struct debug_level debug_levels[] = {
1135 { .name = "process", .shift = FD_PROCESS, },
1136 { .name = "file", .shift = FD_FILE, },
1137 { .name = "io", .shift = FD_IO, },
1138 { .name = "mem", .shift = FD_MEM, },
1139 { .name = "blktrace", .shift = FD_BLKTRACE },
1140 { .name = "verify", .shift = FD_VERIFY },
1141 { .name = "random", .shift = FD_RANDOM },
1142 { .name = "parse", .shift = FD_PARSE },
1143 { .name = "diskutil", .shift = FD_DISKUTIL },
1144 { .name = "job", .shift = FD_JOB },
1145 { .name = "mutex", .shift = FD_MUTEX },
1146 { .name = "profile", .shift = FD_PROFILE },
1147 { .name = "time", .shift = FD_TIME },
1148 { .name = "net", .shift = FD_NET },
1152 static int set_debug(const char *string)
1154 struct debug_level *dl;
1155 char *p = (char *) string;
1159 if (!strcmp(string, "?") || !strcmp(string, "help")) {
1160 log_info("fio: dumping debug options:");
1161 for (i = 0; debug_levels[i].name; i++) {
1162 dl = &debug_levels[i];
1163 log_info("%s,", dl->name);
1169 while ((opt = strsep(&p, ",")) != NULL) {
1172 if (!strncmp(opt, "all", 3)) {
1173 log_info("fio: set all debug options\n");
1178 for (i = 0; debug_levels[i].name; i++) {
1179 dl = &debug_levels[i];
1180 found = !strncmp(opt, dl->name, strlen(dl->name));
1184 if (dl->shift == FD_JOB) {
1185 opt = strchr(opt, ':');
1187 log_err("fio: missing job number\n");
1191 fio_debug_jobno = atoi(opt);
1192 log_info("fio: set debug jobno %d\n",
1195 log_info("fio: set debug option %s\n", opt);
1196 fio_debug |= (1UL << dl->shift);
1202 log_err("fio: debug mask %s not found\n", opt);
1207 static int set_debug(const char *string)
1209 log_err("fio: debug tracing not included in build\n");
1214 static void fio_options_fill_optstring(void)
1216 char *ostr = cmd_optstr;
1220 while (l_opts[i].name) {
1221 ostr[c++] = l_opts[i].val;
1222 if (l_opts[i].has_arg == required_argument)
1224 else if (l_opts[i].has_arg == optional_argument) {
1233 static int client_flag_set(char c)
1238 while (l_opts[i].name) {
1239 int val = l_opts[i].val;
1241 if (c == (val & 0xff))
1242 return (val & FIO_CLIENT_FLAG);
1250 int parse_cmd_client(char *client, char *opt)
1252 return fio_client_add_cmd_option(client, opt);
1255 int parse_cmd_line(int argc, char *argv[])
1257 struct thread_data *td = NULL;
1258 int c, ini_idx = 0, lidx, ret = 0, do_exit = 0, exit_val = 0;
1259 char *ostr = cmd_optstr;
1260 int daemonize_server = 0;
1261 char *cur_client = NULL;
1265 * Reset optind handling, since we may call this multiple times
1270 while ((c = getopt_long_only(argc, argv, ostr, l_opts, &lidx)) != -1) {
1273 if ((c & FIO_CLIENT_FLAG) || client_flag_set(c)) {
1274 if (parse_cmd_client(cur_client, argv[optind - 1])) {
1279 c &= ~FIO_CLIENT_FLAG;
1284 smalloc_pool_size = atoi(optarg);
1287 def_timeout = atoi(optarg);
1296 f_out = fopen(optarg, "w+");
1298 perror("fopen output");
1314 fio_show_option_help(optarg);
1326 log_info("fio %s\n", fio_version_string);
1331 terse_version = atoi(optarg);
1332 if (terse_version != 2) {
1333 log_err("fio: bad terse version format\n");
1339 if (!strcmp("always", optarg))
1340 eta_print = FIO_ETA_ALWAYS;
1341 else if (!strcmp("never", optarg))
1342 eta_print = FIO_ETA_NEVER;
1345 if (set_debug(optarg))
1351 if (!strcmp(optarg, "global")) {
1352 log_err("fio: can't use global as only "
1358 new_size = (nr_job_sections + 1) * sizeof(char *);
1359 job_sections = realloc(job_sections, new_size);
1360 job_sections[nr_job_sections] = strdup(optarg);
1365 exec_profile = strdup(optarg);
1367 case FIO_GETOPT_JOB: {
1368 const char *opt = l_opts[lidx].name;
1371 if (!strncmp(opt, "name", 4) && td) {
1372 ret = add_job(td, td->o.name ?: "fio", 0);
1378 int is_section = !strncmp(opt, "name", 4);
1381 if (!is_section || !strncmp(val, "global", 6))
1384 if (is_section && skip_this_section(val))
1387 td = get_new_job(global, &def_thread);
1392 ret = fio_cmd_option_parse(td, opt, val);
1399 max_jobs = atoi(optarg);
1400 if (!max_jobs || max_jobs > REAL_MAX_JOBS) {
1401 log_err("fio: invalid max jobs: %d\n", max_jobs);
1408 log_err("fio: can't be both client and server\n");
1417 daemonize_server = 1;
1420 fio_net_port = atoi(optarg);
1424 log_err("fio: can't be both client and server\n");
1429 fio_client_add(optarg);
1430 cur_client = optarg;
1442 if (exit_val && !(is_backend || nr_clients))
1446 if (nr_clients && fio_clients_connect()) {
1452 if (is_backend && backend)
1453 return fio_start_server(daemonize_server);
1457 ret = add_job(td, td->o.name ?: "fio", 0);
1460 while (!ret && optind < argc) {
1462 ini_file = realloc(ini_file, ini_idx * sizeof(char *));
1463 ini_file[ini_idx - 1] = strdup(argv[optind]);
1470 int parse_options(int argc, char *argv[])
1477 fio_options_fill_optstring();
1478 fio_options_dup_and_init(l_opts);
1482 if (fill_def_thread())
1485 job_files = parse_cmd_line(argc, argv);
1487 if (job_files > 0) {
1488 for (i = 0; i < job_files; i++) {
1489 if (fill_def_thread())
1492 if (fio_clients_send_ini(ini_file[i]))
1495 } else if (!is_backend) {
1496 if (parse_jobs_ini(ini_file[i], 0, i))
1504 options_mem_free(&def_thread);
1506 if (!thread_number) {
1511 if (is_backend || nr_clients)
1516 log_err("No jobs(s) defined\n\n");
1526 if (def_thread.o.gtod_offload) {
1528 fio_gtod_offload = 1;
1529 fio_gtod_cpu = def_thread.o.gtod_cpu;
1532 log_info("fio %s\n", fio_version_string);