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] = {
96 #define FIO_CLIENT_FLAG (1 << 16)
99 * Command line options. These will contain the above, plus a few
100 * extra that only pertain to fio itself and not jobs.
102 static struct option l_opts[FIO_NR_OPTIONS] = {
104 .name = (char *) "output",
105 .has_arg = required_argument,
106 .val = 'o' | FIO_CLIENT_FLAG,
109 .name = (char *) "timeout",
110 .has_arg = required_argument,
111 .val = 't' | FIO_CLIENT_FLAG,
114 .name = (char *) "latency-log",
115 .has_arg = required_argument,
116 .val = 'l' | FIO_CLIENT_FLAG,
119 .name = (char *) "bandwidth-log",
120 .has_arg = required_argument,
121 .val = 'b' | FIO_CLIENT_FLAG,
124 .name = (char *) "minimal",
125 .has_arg = optional_argument,
126 .val = 'm' | FIO_CLIENT_FLAG,
129 .name = (char *) "version",
130 .has_arg = no_argument,
131 .val = 'v' | FIO_CLIENT_FLAG,
134 .name = (char *) "help",
135 .has_arg = no_argument,
136 .val = 'h' | FIO_CLIENT_FLAG,
139 .name = (char *) "cmdhelp",
140 .has_arg = optional_argument,
141 .val = 'c' | FIO_CLIENT_FLAG,
144 .name = (char *) "enghelp",
145 .has_arg = optional_argument,
146 .val = 'i' | FIO_CLIENT_FLAG,
149 .name = (char *) "showcmd",
150 .has_arg = no_argument,
151 .val = 's' | FIO_CLIENT_FLAG,
154 .name = (char *) "readonly",
155 .has_arg = no_argument,
156 .val = 'r' | FIO_CLIENT_FLAG,
159 .name = (char *) "eta",
160 .has_arg = required_argument,
161 .val = 'e' | FIO_CLIENT_FLAG,
164 .name = (char *) "debug",
165 .has_arg = required_argument,
166 .val = 'd' | FIO_CLIENT_FLAG,
169 .name = (char *) "section",
170 .has_arg = required_argument,
171 .val = 'x' | FIO_CLIENT_FLAG,
174 .name = (char *) "alloc-size",
175 .has_arg = required_argument,
176 .val = 'a' | FIO_CLIENT_FLAG,
179 .name = (char *) "profile",
180 .has_arg = required_argument,
181 .val = 'p' | FIO_CLIENT_FLAG,
184 .name = (char *) "warnings-fatal",
185 .has_arg = no_argument,
186 .val = 'w' | FIO_CLIENT_FLAG,
189 .name = (char *) "max-jobs",
190 .has_arg = required_argument,
191 .val = 'j' | FIO_CLIENT_FLAG,
194 .name = (char *) "terse-version",
195 .has_arg = required_argument,
196 .val = 'V' | FIO_CLIENT_FLAG,
199 .name = (char *) "server",
200 .has_arg = optional_argument,
203 { .name = (char *) "daemonize",
204 .has_arg = required_argument,
208 .name = (char *) "client",
209 .has_arg = required_argument,
217 static void free_shm(void)
219 struct shmid_ds sbuf;
227 fio_debug_jobp = NULL;
229 shmctl(shm_id, IPC_RMID, &sbuf);
236 * The thread area is shared between the main process and the job
237 * threads/processes. So setup a shared memory segment that will hold
238 * all the job info. We use the end of the region for keeping track of
239 * open files across jobs, for file sharing.
241 static int setup_thread_area(void)
249 * 1024 is too much on some machines, scale max_jobs if
250 * we get a failure that looks like too large a shm segment
253 size_t size = max_jobs * sizeof(struct thread_data);
255 size += file_hash_size;
256 size += sizeof(unsigned int);
258 shm_id = shmget(0, size, IPC_CREAT | 0600);
261 if (errno != EINVAL && errno != ENOMEM) {
272 threads = shmat(shm_id, NULL, 0);
273 if (threads == (void *) -1) {
278 memset(threads, 0, max_jobs * sizeof(struct thread_data));
279 hash = (void *) threads + max_jobs * sizeof(struct thread_data);
280 fio_debug_jobp = (void *) hash + file_hash_size;
281 *fio_debug_jobp = -1;
282 file_hash_init(hash);
290 * Return a free job structure.
292 static struct thread_data *get_new_job(int global, struct thread_data *parent,
295 struct thread_data *td;
299 if (setup_thread_area()) {
300 log_err("error: failed to setup shm segment\n");
303 if (thread_number >= max_jobs) {
304 log_err("error: maximum number of jobs (%d) reached.\n",
309 td = &threads[thread_number++];
316 td->o.uid = td->o.gid = -1U;
318 dup_files(td, parent);
319 fio_options_mem_dupe(td);
321 profile_add_hooks(td);
323 td->thread_number = thread_number;
327 static void put_job(struct thread_data *td)
329 if (td == &def_thread)
336 log_info("fio: %s\n", td->verror);
338 fio_options_free(td);
342 memset(&threads[td->thread_number - 1], 0, sizeof(*td));
346 static int __setup_rate(struct thread_data *td, enum fio_ddir ddir)
348 unsigned int bs = td->o.min_bs[ddir];
350 assert(ddir_rw(ddir));
352 if (td->o.rate[ddir])
353 td->rate_bps[ddir] = td->o.rate[ddir];
355 td->rate_bps[ddir] = td->o.rate_iops[ddir] * bs;
357 if (!td->rate_bps[ddir]) {
358 log_err("rate lower than supported\n");
362 td->rate_pending_usleep[ddir] = 0;
366 static int setup_rate(struct thread_data *td)
370 if (td->o.rate[DDIR_READ] || td->o.rate_iops[DDIR_READ])
371 ret = __setup_rate(td, DDIR_READ);
372 if (td->o.rate[DDIR_WRITE] || td->o.rate_iops[DDIR_WRITE])
373 ret |= __setup_rate(td, DDIR_WRITE);
378 static int fixed_block_size(struct thread_options *o)
380 return o->min_bs[DDIR_READ] == o->max_bs[DDIR_READ] &&
381 o->min_bs[DDIR_WRITE] == o->max_bs[DDIR_WRITE] &&
382 o->min_bs[DDIR_READ] == o->min_bs[DDIR_WRITE];
386 * Lazy way of fixing up options that depend on each other. We could also
387 * define option callback handlers, but this is easier.
389 static int fixup_options(struct thread_data *td)
391 struct thread_options *o = &td->o;
394 #ifndef FIO_HAVE_PSHARED_MUTEX
395 if (!o->use_thread) {
396 log_info("fio: this platform does not support process shared"
397 " mutexes, forcing use of threads. Use the 'thread'"
398 " option to get rid of this warning.\n");
400 ret = warnings_fatal;
404 if (o->write_iolog_file && o->read_iolog_file) {
405 log_err("fio: read iolog overrides write_iolog\n");
406 free(o->write_iolog_file);
407 o->write_iolog_file = NULL;
408 ret = warnings_fatal;
412 * only really works with 1 file
414 if (o->zone_size && o->open_files == 1)
418 * If zone_range isn't specified, backward compatibility dictates it
419 * should be made equal to zone_size.
421 if (o->zone_size && !o->zone_range)
422 o->zone_range = o->zone_size;
425 * Reads can do overwrites, we always need to pre-create the file
427 if (td_read(td) || td_rw(td))
430 if (!o->min_bs[DDIR_READ])
431 o->min_bs[DDIR_READ] = o->bs[DDIR_READ];
432 if (!o->max_bs[DDIR_READ])
433 o->max_bs[DDIR_READ] = o->bs[DDIR_READ];
434 if (!o->min_bs[DDIR_WRITE])
435 o->min_bs[DDIR_WRITE] = o->bs[DDIR_WRITE];
436 if (!o->max_bs[DDIR_WRITE])
437 o->max_bs[DDIR_WRITE] = o->bs[DDIR_WRITE];
439 o->rw_min_bs = min(o->min_bs[DDIR_READ], o->min_bs[DDIR_WRITE]);
442 * For random IO, allow blockalign offset other than min_bs.
444 if (!o->ba[DDIR_READ] || !td_random(td))
445 o->ba[DDIR_READ] = o->min_bs[DDIR_READ];
446 if (!o->ba[DDIR_WRITE] || !td_random(td))
447 o->ba[DDIR_WRITE] = o->min_bs[DDIR_WRITE];
449 if ((o->ba[DDIR_READ] != o->min_bs[DDIR_READ] ||
450 o->ba[DDIR_WRITE] != o->min_bs[DDIR_WRITE]) &&
452 log_err("fio: Any use of blockalign= turns off randommap\n");
454 ret = warnings_fatal;
457 if (!o->file_size_high)
458 o->file_size_high = o->file_size_low;
460 if (o->norandommap && o->verify != VERIFY_NONE
461 && !fixed_block_size(o)) {
462 log_err("fio: norandommap given for variable block sizes, "
463 "verify disabled\n");
464 o->verify = VERIFY_NONE;
465 ret = warnings_fatal;
467 if (o->bs_unaligned && (o->odirect || td->io_ops->flags & FIO_RAWIO))
468 log_err("fio: bs_unaligned may not work with raw io\n");
471 * thinktime_spin must be less than thinktime
473 if (o->thinktime_spin > o->thinktime)
474 o->thinktime_spin = o->thinktime;
477 * The low water mark cannot be bigger than the iodepth
479 if (o->iodepth_low > o->iodepth || !o->iodepth_low) {
481 * syslet work around - if the workload is sequential,
482 * we want to let the queue drain all the way down to
483 * avoid seeking between async threads
485 if (!strcmp(td->io_ops->name, "syslet-rw") && !td_random(td))
488 o->iodepth_low = o->iodepth;
492 * If batch number isn't set, default to the same as iodepth
494 if (o->iodepth_batch > o->iodepth || !o->iodepth_batch)
495 o->iodepth_batch = o->iodepth;
497 if (o->nr_files > td->files_index)
498 o->nr_files = td->files_index;
500 if (o->open_files > o->nr_files || !o->open_files)
501 o->open_files = o->nr_files;
503 if (((o->rate[0] + o->rate[1]) && (o->rate_iops[0] + o->rate_iops[1]))||
504 ((o->ratemin[0] + o->ratemin[1]) && (o->rate_iops_min[0] +
505 o->rate_iops_min[1]))) {
506 log_err("fio: rate and rate_iops are mutually exclusive\n");
509 if ((o->rate[0] < o->ratemin[0]) || (o->rate[1] < o->ratemin[1]) ||
510 (o->rate_iops[0] < o->rate_iops_min[0]) ||
511 (o->rate_iops[1] < o->rate_iops_min[1])) {
512 log_err("fio: minimum rate exceeds rate\n");
516 if (!o->timeout && o->time_based) {
517 log_err("fio: time_based requires a runtime/timeout setting\n");
519 ret = warnings_fatal;
522 if (o->fill_device && !o->size)
525 if (o->verify != VERIFY_NONE) {
526 if (td_write(td) && o->do_verify && o->numjobs > 1) {
527 log_info("Multiple writers may overwrite blocks that "
528 "belong to other jobs. This can cause "
529 "verification failures.\n");
530 ret = warnings_fatal;
533 o->refill_buffers = 1;
534 if (o->max_bs[DDIR_WRITE] != o->min_bs[DDIR_WRITE] &&
536 o->verify_interval = o->min_bs[DDIR_WRITE];
540 o->invalidate_cache = 0;
541 if (td->io_ops->flags & FIO_PIPEIO) {
542 log_info("fio: cannot pre-read files with an IO engine"
543 " that isn't seekable. Pre-read disabled.\n");
544 ret = warnings_fatal;
548 #ifndef FIO_HAVE_FDATASYNC
549 if (o->fdatasync_blocks) {
550 log_info("fio: this platform does not support fdatasync()"
551 " falling back to using fsync(). Use the 'fsync'"
552 " option instead of 'fdatasync' to get rid of"
554 o->fsync_blocks = o->fdatasync_blocks;
555 o->fdatasync_blocks = 0;
556 ret = warnings_fatal;
562 * Windows doesn't support O_DIRECT or O_SYNC with the _open interface,
563 * so fail if we're passed those flags
565 if ((td->io_ops->flags & FIO_SYNCIO) && (td->o.odirect || td->o.sync_io)) {
566 log_err("fio: Windows does not support direct or non-buffered io with"
567 " the synchronous ioengines. Use the 'windowsaio' ioengine"
568 " with 'direct=1' and 'iodepth=1' instead.\n");
574 * For fully compressible data, just zero them at init time.
575 * It's faster than repeatedly filling it.
577 if (td->o.compress_percentage == 100) {
578 td->o.zero_buffers = 1;
579 td->o.compress_percentage = 0;
586 * This function leaks the buffer
588 char *fio_uint_to_kmg(unsigned int val)
590 char *buf = malloc(32);
591 char post[] = { 0, 'K', 'M', 'G', 'P', 'E', 0 };
602 snprintf(buf, 31, "%u%c", val, *p);
606 /* External engines are specified by "external:name.o") */
607 static const char *get_engine_name(const char *str)
609 char *p = strstr(str, ":");
615 strip_blank_front(&p);
620 static int exists_and_not_file(const char *filename)
624 if (lstat(filename, &sb) == -1)
627 /* \\.\ is the device namespace in Windows, where every file
628 * is a device node */
629 if (S_ISREG(sb.st_mode) && strncmp(filename, "\\\\.\\", 4) != 0)
635 static void td_fill_rand_seeds_os(struct thread_data *td)
637 os_random_seed(td->rand_seeds[0], &td->bsrange_state);
638 os_random_seed(td->rand_seeds[1], &td->verify_state);
639 os_random_seed(td->rand_seeds[2], &td->rwmix_state);
641 if (td->o.file_service_type == FIO_FSERVICE_RANDOM)
642 os_random_seed(td->rand_seeds[3], &td->next_file_state);
644 os_random_seed(td->rand_seeds[5], &td->file_size_state);
645 os_random_seed(td->rand_seeds[6], &td->trim_state);
650 if (td->o.rand_repeatable)
651 td->rand_seeds[4] = FIO_RANDSEED * td->thread_number;
653 os_random_seed(td->rand_seeds[4], &td->random_state);
656 static void td_fill_rand_seeds_internal(struct thread_data *td)
658 init_rand_seed(&td->__bsrange_state, td->rand_seeds[0]);
659 init_rand_seed(&td->__verify_state, td->rand_seeds[1]);
660 init_rand_seed(&td->__rwmix_state, td->rand_seeds[2]);
662 if (td->o.file_service_type == FIO_FSERVICE_RANDOM)
663 init_rand_seed(&td->__next_file_state, td->rand_seeds[3]);
665 init_rand_seed(&td->__file_size_state, td->rand_seeds[5]);
666 init_rand_seed(&td->__trim_state, td->rand_seeds[6]);
671 if (td->o.rand_repeatable)
672 td->rand_seeds[4] = FIO_RANDSEED * td->thread_number;
674 init_rand_seed(&td->__random_state, td->rand_seeds[4]);
677 void td_fill_rand_seeds(struct thread_data *td)
679 if (td->o.use_os_rand)
680 td_fill_rand_seeds_os(td);
682 td_fill_rand_seeds_internal(td);
684 init_rand_seed(&td->buf_state, td->rand_seeds[7]);
689 * Initializes the ioengine configured for a job, if it has not been done so
692 int ioengine_load(struct thread_data *td)
697 * Engine has already been loaded.
702 engine = get_engine_name(td->o.ioengine);
703 td->io_ops = load_ioengine(td, engine);
705 log_err("fio: failed to load engine %s\n", engine);
709 if (td->io_ops->option_struct_size && td->io_ops->options) {
711 * In cases where td->eo is set, clone it for a child thread.
712 * This requires that the parent thread has the same ioengine,
713 * but that requirement must be enforced by the code which
716 void *origeo = td->eo;
718 * Otherwise use the default thread options.
720 if (!origeo && td != &def_thread && def_thread.eo &&
721 def_thread.io_ops->options == td->io_ops->options)
722 origeo = def_thread.eo;
724 options_init(td->io_ops->options);
725 td->eo = malloc(td->io_ops->option_struct_size);
727 * Use the default thread as an option template if this uses the
728 * same options structure and there are non-default options
732 memcpy(td->eo, origeo, td->io_ops->option_struct_size);
733 options_mem_dupe(td->eo, td->io_ops->options);
735 memset(td->eo, 0, td->io_ops->option_struct_size);
736 fill_default_options(td->eo, td->io_ops->options);
738 *(struct thread_data **)td->eo = td;
745 * Adds a job to the list of things todo. Sanitizes the various options
746 * to make sure we don't have conflicts, and initializes various
749 static int add_job(struct thread_data *td, const char *jobname, int job_add_num,
750 int recursed, int client_type)
753 char fname[PATH_MAX];
754 int numjobs, file_alloced;
757 * the def_thread is just for options, it's not a real job
759 if (td == &def_thread)
763 * if we are just dumping the output command line, don't add the job
770 td->client_type = client_type;
772 if (profile_td_init(td))
775 if (ioengine_load(td))
778 if (td->o.use_thread)
784 td->io_ops->flags |= FIO_RAWIO;
787 if (!td->o.filename && !td->files_index && !td->o.read_iolog_file) {
790 if (td->o.nr_files == 1 && exists_and_not_file(jobname))
791 add_file(td, jobname);
793 for (i = 0; i < td->o.nr_files; i++) {
794 sprintf(fname, "%s.%d.%d", jobname,
795 td->thread_number, i);
801 if (fixup_options(td))
807 * IO engines only need this for option callbacks, and the address may
808 * change in subprocesses.
811 *(struct thread_data **)td->eo = NULL;
813 if (td->io_ops->flags & FIO_DISKLESSIO) {
816 for_each_file(td, f, i)
817 f->real_file_size = -1ULL;
820 td->mutex = fio_mutex_init(0);
822 td->ts.clat_percentiles = td->o.clat_percentiles;
823 if (td->o.overwrite_plist)
824 memcpy(td->ts.percentile_list, td->o.percentile_list, sizeof(td->o.percentile_list));
826 memcpy(td->ts.percentile_list, def_percentile_list, sizeof(def_percentile_list));
828 td->ts.clat_stat[0].min_val = td->ts.clat_stat[1].min_val = ULONG_MAX;
829 td->ts.slat_stat[0].min_val = td->ts.slat_stat[1].min_val = ULONG_MAX;
830 td->ts.lat_stat[0].min_val = td->ts.lat_stat[1].min_val = ULONG_MAX;
831 td->ts.bw_stat[0].min_val = td->ts.bw_stat[1].min_val = ULONG_MAX;
832 td->ddir_seq_nr = td->o.ddir_seq_nr;
834 if ((td->o.stonewall || td->o.new_group) && prev_group_jobs) {
839 td->groupid = groupid;
842 if (init_random_state(td, td->rand_seeds, sizeof(td->rand_seeds))) {
843 td_verror(td, errno, "init_random_state");
850 if (td->o.write_lat_log) {
851 setup_log(&td->lat_log, td->o.log_avg_msec, IO_LOG_TYPE_LAT);
852 setup_log(&td->slat_log, td->o.log_avg_msec, IO_LOG_TYPE_SLAT);
853 setup_log(&td->clat_log, td->o.log_avg_msec, IO_LOG_TYPE_CLAT);
855 if (td->o.write_bw_log)
856 setup_log(&td->bw_log, td->o.log_avg_msec, IO_LOG_TYPE_BW);
857 if (td->o.write_iops_log)
858 setup_log(&td->iops_log, td->o.log_avg_msec, IO_LOG_TYPE_IOPS);
861 td->o.name = strdup(jobname);
865 if (is_backend && !recursed)
866 fio_server_send_add_job(td);
868 if (!strcmp(td->io_ops->name, "cpuio")) {
869 log_info("%s: ioengine=cpu, cpuload=%u,"
870 " cpucycle=%u\n", td->o.name,
874 char *c1, *c2, *c3, *c4;
876 c1 = fio_uint_to_kmg(td->o.min_bs[DDIR_READ]);
877 c2 = fio_uint_to_kmg(td->o.max_bs[DDIR_READ]);
878 c3 = fio_uint_to_kmg(td->o.min_bs[DDIR_WRITE]);
879 c4 = fio_uint_to_kmg(td->o.max_bs[DDIR_WRITE]);
881 log_info("%s: (g=%d): rw=%s, bs=%s-%s/%s-%s,"
882 " ioengine=%s, iodepth=%u\n",
883 td->o.name, td->groupid,
884 ddir_str(td->o.td_ddir),
894 } else if (job_add_num == 1)
899 * recurse add identical jobs, clear numjobs and stonewall options
900 * as they don't apply to sub-jobs
902 numjobs = td->o.numjobs;
904 struct thread_data *td_new = get_new_job(0, td, 1);
909 td_new->o.numjobs = 1;
910 td_new->o.stonewall = 0;
911 td_new->o.new_group = 0;
914 td_new->o.filename = NULL;
915 td_new->files_index = 0;
916 td_new->files_size = 0;
917 td_new->files = NULL;
920 job_add_num = numjobs - 1;
922 if (add_job(td_new, jobname, job_add_num, 1, client_type))
933 * Parse as if 'o' was a command line
935 void add_job_opts(const char **o, int client_type)
937 struct thread_data *td, *td_parent;
938 int i, in_global = 1;
942 td_parent = td = NULL;
944 if (!strncmp(o[i], "name", 4)) {
947 add_job(td, jobname, 0, 0, client_type);
949 sprintf(jobname, "%s", o[i] + 5);
951 if (in_global && !td_parent)
952 td_parent = get_new_job(1, &def_thread, 0);
953 else if (!in_global && !td) {
955 td_parent = &def_thread;
956 td = get_new_job(0, td_parent, 0);
959 fio_options_parse(td_parent, (char **) &o[i], 1);
961 fio_options_parse(td, (char **) &o[i], 1);
966 add_job(td, jobname, 0, 0, client_type);
969 static int skip_this_section(const char *name)
973 if (!nr_job_sections)
975 if (!strncmp(name, "global", 6))
978 for (i = 0; i < nr_job_sections; i++)
979 if (!strcmp(job_sections[i], name))
985 static int is_empty_or_comment(char *line)
989 for (i = 0; i < strlen(line); i++) {
994 if (!isspace((int) line[i]) && !iscntrl((int) line[i]))
1002 * This is our [ini] type file parser.
1004 int parse_jobs_ini(char *file, int is_buf, int stonewall_flag, int type)
1006 unsigned int global;
1007 struct thread_data *td;
1008 char *string, *name;
1011 int ret = 0, stonewall;
1014 int inside_skip = 0;
1016 int i, alloc_opts, num_opts;
1021 if (!strcmp(file, "-"))
1024 f = fopen(file, "r");
1027 perror("fopen job file");
1032 string = malloc(4096);
1035 * it's really 256 + small bit, 280 should suffice
1038 memset(name, 0, 280);
1041 opts = malloc(sizeof(char *) * alloc_opts);
1044 stonewall = stonewall_flag;
1047 * if skip_fgets is set, we already have loaded a line we
1052 p = strsep(&file, "\n");
1054 p = fgets(string, 4096, f);
1060 strip_blank_front(&p);
1063 if (is_empty_or_comment(p))
1065 if (sscanf(p, "[%255[^\n]]", name) != 1) {
1068 log_err("fio: option <%s> outside of [] job section\n",
1073 name[strlen(name) - 1] = '\0';
1075 if (skip_this_section(name)) {
1081 global = !strncmp(name, "global", 6);
1087 log_info("--name=%s ", name);
1091 td = get_new_job(global, &def_thread, 0);
1098 * Seperate multiple job files by a stonewall
1100 if (!global && stonewall) {
1101 td->o.stonewall = stonewall;
1106 memset(opts, 0, alloc_opts * sizeof(char *));
1110 p = strsep(&file, "\n");
1112 p = fgets(string, 4096, f);
1116 if (is_empty_or_comment(p))
1119 strip_blank_front(&p);
1122 * new section, break out and make sure we don't
1123 * fgets() a new line at the top.
1132 if (num_opts == alloc_opts) {
1134 opts = realloc(opts,
1135 alloc_opts * sizeof(char *));
1138 opts[num_opts] = strdup(p);
1142 ret = fio_options_parse(td, opts, num_opts);
1145 for (i = 0; i < num_opts; i++)
1146 log_info("--%s ", opts[i]);
1148 ret = add_job(td, name, 0, 0, type);
1150 log_err("fio: job %s dropped\n", name);
1154 for (i = 0; i < num_opts; i++)
1163 while (i < nr_job_sections) {
1164 free(job_sections[i]);
1168 for (i = 0; i < num_opts; i++)
1174 if (!is_buf && f != stdin)
1179 static int fill_def_thread(void)
1181 memset(&def_thread, 0, sizeof(def_thread));
1183 fio_getaffinity(getpid(), &def_thread.o.cpumask);
1184 def_thread.o.timeout = def_timeout;
1187 * fill default options
1189 fio_fill_default_options(&def_thread);
1193 static void usage(const char *name)
1195 printf("fio %s\n", fio_version_string);
1196 printf("%s [options] [job options] <job file(s)>\n", name);
1197 printf(" --debug=options\tEnable debug logging. May be one/more of:\n"
1198 "\t\t\tprocess,file,io,mem,blktrace,verify,random,parse,\n"
1199 "\t\t\tdiskutil,job,mutex,profile,time,net\n");
1200 printf(" --output\t\tWrite output to file\n");
1201 printf(" --timeout\t\tRuntime in seconds\n");
1202 printf(" --latency-log\t\tGenerate per-job latency logs\n");
1203 printf(" --bandwidth-log\tGenerate per-job bandwidth logs\n");
1204 printf(" --minimal\t\tMinimal (terse) output\n");
1205 printf(" --version\t\tPrint version info and exit\n");
1206 printf(" --terse-version=x\tSet terse version output format to 'x'\n");
1207 printf(" --help\t\tPrint this page\n");
1208 printf(" --cmdhelp=cmd\t\tPrint command help, \"all\" for all of"
1210 printf(" --enghelp=engine\tPrint ioengine help, or list"
1211 " available ioengines\n");
1212 printf(" --enghelp=engine,cmd\tPrint help for an ioengine"
1214 printf(" --showcmd\t\tTurn a job file into command line options\n");
1215 printf(" --eta=when\t\tWhen ETA estimate should be printed\n");
1216 printf(" \t\tMay be \"always\", \"never\" or \"auto\"\n");
1217 printf(" --readonly\t\tTurn on safety read-only checks, preventing"
1219 printf(" --section=name\tOnly run specified section in job file\n");
1220 printf(" --alloc-size=kb\tSet smalloc pool to this size in kb"
1222 printf(" --warnings-fatal\tFio parser warnings are fatal\n");
1223 printf(" --max-jobs=nr\t\tMaximum number of threads/processes to support\n");
1224 printf(" --server=args\t\tStart a backend fio server\n");
1225 printf(" --daemonize=pidfile\tBackground fio server, write pid to file\n");
1226 printf(" --client=hostname\tTalk to remote backend fio server at hostname\n");
1227 printf("\nFio was written by Jens Axboe <jens.axboe@oracle.com>");
1228 printf("\n Jens Axboe <jaxboe@fusionio.com>\n");
1231 #ifdef FIO_INC_DEBUG
1232 struct debug_level debug_levels[] = {
1233 { .name = "process",
1234 .help = "Process creation/exit logging",
1235 .shift = FD_PROCESS,
1238 .help = "File related action logging",
1242 .help = "IO and IO engine action logging (offsets, queue, completions, etc)",
1246 .help = "Memory allocation/freeing logging",
1249 { .name = "blktrace",
1250 .help = "blktrace action logging",
1251 .shift = FD_BLKTRACE,
1254 .help = "IO verification action logging",
1258 .help = "Random generation logging",
1262 .help = "Parser logging",
1265 { .name = "diskutil",
1266 .help = "Disk utility logging actions",
1267 .shift = FD_DISKUTIL,
1270 .help = "Logging related to creating/destroying jobs",
1274 .help = "Mutex logging",
1277 { .name = "profile",
1278 .help = "Logging related to profiles",
1279 .shift = FD_PROFILE,
1282 .help = "Logging related to time keeping functions",
1286 .help = "Network logging",
1292 static int set_debug(const char *string)
1294 struct debug_level *dl;
1295 char *p = (char *) string;
1299 if (!strcmp(string, "?") || !strcmp(string, "help")) {
1300 log_info("fio: dumping debug options:");
1301 for (i = 0; debug_levels[i].name; i++) {
1302 dl = &debug_levels[i];
1303 log_info("%s,", dl->name);
1309 while ((opt = strsep(&p, ",")) != NULL) {
1312 if (!strncmp(opt, "all", 3)) {
1313 log_info("fio: set all debug options\n");
1318 for (i = 0; debug_levels[i].name; i++) {
1319 dl = &debug_levels[i];
1320 found = !strncmp(opt, dl->name, strlen(dl->name));
1324 if (dl->shift == FD_JOB) {
1325 opt = strchr(opt, ':');
1327 log_err("fio: missing job number\n");
1331 fio_debug_jobno = atoi(opt);
1332 log_info("fio: set debug jobno %d\n",
1335 log_info("fio: set debug option %s\n", opt);
1336 fio_debug |= (1UL << dl->shift);
1342 log_err("fio: debug mask %s not found\n", opt);
1347 static int set_debug(const char *string)
1349 log_err("fio: debug tracing not included in build\n");
1354 static void fio_options_fill_optstring(void)
1356 char *ostr = cmd_optstr;
1360 while (l_opts[i].name) {
1361 ostr[c++] = l_opts[i].val;
1362 if (l_opts[i].has_arg == required_argument)
1364 else if (l_opts[i].has_arg == optional_argument) {
1373 static int client_flag_set(char c)
1378 while (l_opts[i].name) {
1379 int val = l_opts[i].val;
1381 if (c == (val & 0xff))
1382 return (val & FIO_CLIENT_FLAG);
1390 void parse_cmd_client(void *client, char *opt)
1392 fio_client_add_cmd_option(client, opt);
1395 int parse_cmd_line(int argc, char *argv[], int client_type)
1397 struct thread_data *td = NULL;
1398 int c, ini_idx = 0, lidx, ret = 0, do_exit = 0, exit_val = 0;
1399 char *ostr = cmd_optstr;
1400 void *pid_file = NULL;
1401 void *cur_client = NULL;
1405 * Reset optind handling, since we may call this multiple times
1410 while ((c = getopt_long_only(argc, argv, ostr, l_opts, &lidx)) != -1) {
1413 if ((c & FIO_CLIENT_FLAG) || client_flag_set(c)) {
1414 parse_cmd_client(cur_client, argv[optind - 1]);
1415 c &= ~FIO_CLIENT_FLAG;
1420 smalloc_pool_size = atoi(optarg);
1423 def_timeout = atoi(optarg);
1432 f_out = fopen(optarg, "w+");
1434 perror("fopen output");
1450 fio_show_option_help(optarg);
1456 fio_show_ioengine_help(optarg);
1468 log_info("fio %s\n", fio_version_string);
1473 terse_version = atoi(optarg);
1474 if (!(terse_version == 2 || terse_version == 3)) {
1475 log_err("fio: bad terse version format\n");
1481 if (!strcmp("always", optarg))
1482 eta_print = FIO_ETA_ALWAYS;
1483 else if (!strcmp("never", optarg))
1484 eta_print = FIO_ETA_NEVER;
1487 if (set_debug(optarg))
1493 if (!strcmp(optarg, "global")) {
1494 log_err("fio: can't use global as only "
1500 new_size = (nr_job_sections + 1) * sizeof(char *);
1501 job_sections = realloc(job_sections, new_size);
1502 job_sections[nr_job_sections] = strdup(optarg);
1507 exec_profile = strdup(optarg);
1509 case FIO_GETOPT_JOB: {
1510 const char *opt = l_opts[lidx].name;
1513 if (!strncmp(opt, "name", 4) && td) {
1514 ret = add_job(td, td->o.name ?: "fio", 0, 0, client_type);
1520 int is_section = !strncmp(opt, "name", 4);
1523 if (!is_section || !strncmp(val, "global", 6))
1526 if (is_section && skip_this_section(val))
1529 td = get_new_job(global, &def_thread, 1);
1530 if (!td || ioengine_load(td))
1532 fio_options_set_ioengine_opts(l_opts, td);
1535 ret = fio_cmd_option_parse(td, opt, val);
1537 if (!ret && !strcmp(opt, "ioengine")) {
1539 if (ioengine_load(td))
1541 fio_options_set_ioengine_opts(l_opts, td);
1545 case FIO_GETOPT_IOENGINE: {
1546 const char *opt = l_opts[lidx].name;
1548 opt = l_opts[lidx].name;
1550 ret = fio_cmd_ioengine_option_parse(td, opt, val);
1557 max_jobs = atoi(optarg);
1558 if (!max_jobs || max_jobs > REAL_MAX_JOBS) {
1559 log_err("fio: invalid max jobs: %d\n", max_jobs);
1566 log_err("fio: can't be both client and server\n");
1572 fio_server_set_arg(optarg);
1577 pid_file = strdup(optarg);
1581 log_err("fio: can't be both client and server\n");
1586 if (fio_client_add(&fio_client_ops, optarg, &cur_client)) {
1587 log_err("fio: failed adding client %s\n", optarg);
1603 if (exit_val && !(is_backend || nr_clients))
1607 if (nr_clients && fio_clients_connect()) {
1613 if (is_backend && backend)
1614 return fio_start_server(pid_file);
1618 ret = add_job(td, td->o.name ?: "fio", 0, 0, client_type);
1621 while (!ret && optind < argc) {
1623 ini_file = realloc(ini_file, ini_idx * sizeof(char *));
1624 ini_file[ini_idx - 1] = strdup(argv[optind]);
1631 int fio_init_options(void)
1636 fio_options_fill_optstring();
1637 fio_options_dup_and_init(l_opts);
1641 if (fill_def_thread())
1647 extern int fio_check_options(struct thread_options *);
1649 int parse_options(int argc, char *argv[])
1651 const int type = FIO_CLIENT_TYPE_CLI;
1654 if (fio_init_options())
1656 if (fio_test_cconv(&def_thread.o))
1657 log_err("fio: failed internal cconv test\n");
1659 job_files = parse_cmd_line(argc, argv, type);
1661 if (job_files > 0) {
1662 for (i = 0; i < job_files; i++) {
1663 if (fill_def_thread())
1666 if (fio_clients_send_ini(ini_file[i]))
1669 } else if (!is_backend) {
1670 if (parse_jobs_ini(ini_file[i], 0, i, type))
1678 fio_options_free(&def_thread);
1680 if (!thread_number) {
1685 if (is_backend || nr_clients)
1690 log_err("No jobs(s) defined\n\n");
1700 if (def_thread.o.gtod_offload) {
1702 fio_gtod_offload = 1;
1703 fio_gtod_cpu = def_thread.o.gtod_cpu;
1707 log_info("fio %s\n", fio_version_string);