2 * This file contains job initialization and setup functions.
12 #ifndef FIO_NO_HAVE_SHM_H
15 #include <sys/types.h>
27 #include "lib/getopt.h"
29 const char fio_version_string[] = FIO_VERSION;
31 #define FIO_RANDSEED (0xb1899bedUL)
33 static char **ini_file;
34 static int max_jobs = FIO_MAX_JOBS;
35 static int dump_cmdline;
36 static int def_timeout;
38 static struct thread_data def_thread;
39 struct thread_data *threads = NULL;
41 int exitall_on_terminate = 0;
42 int output_format = FIO_OUTPUT_NORMAL;
43 int eta_print = FIO_ETA_AUTO;
45 unsigned long long mlock_size = 0;
48 char **job_sections = NULL;
49 int nr_job_sections = 0;
50 char *exec_profile = NULL;
51 int warnings_fatal = 0;
52 int terse_version = 3;
60 static int write_lat_log;
62 static int prev_group_jobs;
64 unsigned long fio_debug = 0;
65 unsigned int fio_debug_jobno = -1;
66 unsigned int *fio_debug_jobp = NULL;
68 static char cmd_optstr[256];
71 #define FIO_CLIENT_FLAG (1 << 16)
74 * Command line options. These will contain the above, plus a few
75 * extra that only pertain to fio itself and not jobs.
77 static struct option l_opts[FIO_NR_OPTIONS] = {
79 .name = (char *) "output",
80 .has_arg = required_argument,
81 .val = 'o' | FIO_CLIENT_FLAG,
84 .name = (char *) "timeout",
85 .has_arg = required_argument,
86 .val = 't' | FIO_CLIENT_FLAG,
89 .name = (char *) "latency-log",
90 .has_arg = required_argument,
91 .val = 'l' | FIO_CLIENT_FLAG,
94 .name = (char *) "bandwidth-log",
95 .has_arg = required_argument,
96 .val = 'b' | FIO_CLIENT_FLAG,
99 .name = (char *) "minimal",
100 .has_arg = optional_argument,
101 .val = 'm' | FIO_CLIENT_FLAG,
104 .name = (char *) "output-format",
105 .has_arg = optional_argument,
106 .val = 'F' | FIO_CLIENT_FLAG,
109 .name = (char *) "version",
110 .has_arg = no_argument,
111 .val = 'v' | FIO_CLIENT_FLAG,
114 .name = (char *) "help",
115 .has_arg = no_argument,
116 .val = 'h' | FIO_CLIENT_FLAG,
119 .name = (char *) "cmdhelp",
120 .has_arg = optional_argument,
121 .val = 'c' | FIO_CLIENT_FLAG,
124 .name = (char *) "enghelp",
125 .has_arg = optional_argument,
126 .val = 'i' | FIO_CLIENT_FLAG,
129 .name = (char *) "showcmd",
130 .has_arg = no_argument,
131 .val = 's' | FIO_CLIENT_FLAG,
134 .name = (char *) "readonly",
135 .has_arg = no_argument,
136 .val = 'r' | FIO_CLIENT_FLAG,
139 .name = (char *) "eta",
140 .has_arg = required_argument,
141 .val = 'e' | FIO_CLIENT_FLAG,
144 .name = (char *) "eta-newline",
145 .has_arg = required_argument,
146 .val = 'E' | FIO_CLIENT_FLAG,
149 .name = (char *) "debug",
150 .has_arg = required_argument,
151 .val = 'd' | FIO_CLIENT_FLAG,
154 .name = (char *) "section",
155 .has_arg = required_argument,
156 .val = 'x' | FIO_CLIENT_FLAG,
159 .name = (char *) "alloc-size",
160 .has_arg = required_argument,
161 .val = 'a' | FIO_CLIENT_FLAG,
164 .name = (char *) "profile",
165 .has_arg = required_argument,
166 .val = 'p' | FIO_CLIENT_FLAG,
169 .name = (char *) "warnings-fatal",
170 .has_arg = no_argument,
171 .val = 'w' | FIO_CLIENT_FLAG,
174 .name = (char *) "max-jobs",
175 .has_arg = required_argument,
176 .val = 'j' | FIO_CLIENT_FLAG,
179 .name = (char *) "terse-version",
180 .has_arg = required_argument,
181 .val = 'V' | FIO_CLIENT_FLAG,
184 .name = (char *) "server",
185 .has_arg = optional_argument,
188 { .name = (char *) "daemonize",
189 .has_arg = required_argument,
193 .name = (char *) "client",
194 .has_arg = required_argument,
198 .name = (char *) "cpuclock-test",
199 .has_arg = no_argument,
203 .name = (char *) "idle-prof",
204 .has_arg = required_argument,
212 static void free_shm(void)
214 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 && errno != ENOMEM && errno != ENOSPC) {
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);
285 * Return a free job structure.
287 static struct thread_data *get_new_job(int global, struct thread_data *parent,
290 struct thread_data *td;
294 if (setup_thread_area()) {
295 log_err("error: failed to setup shm segment\n");
298 if (thread_number >= max_jobs) {
299 log_err("error: maximum number of jobs (%d) reached.\n",
304 td = &threads[thread_number++];
311 td->o.uid = td->o.gid = -1U;
313 dup_files(td, parent);
314 fio_options_mem_dupe(td);
316 profile_add_hooks(td);
318 td->thread_number = thread_number;
320 if (!parent || !parent->o.group_reporting)
326 static void put_job(struct thread_data *td)
328 if (td == &def_thread)
335 log_info("fio: %s\n", td->verror);
337 fio_options_free(td);
341 memset(&threads[td->thread_number - 1], 0, sizeof(*td));
345 static int __setup_rate(struct thread_data *td, enum fio_ddir ddir)
347 unsigned int bs = td->o.min_bs[ddir];
349 assert(ddir_rw(ddir));
351 if (td->o.rate[ddir])
352 td->rate_bps[ddir] = td->o.rate[ddir];
354 td->rate_bps[ddir] = td->o.rate_iops[ddir] * bs;
356 if (!td->rate_bps[ddir]) {
357 log_err("rate lower than supported\n");
361 td->rate_pending_usleep[ddir] = 0;
365 static int setup_rate(struct thread_data *td)
369 if (td->o.rate[DDIR_READ] || td->o.rate_iops[DDIR_READ])
370 ret = __setup_rate(td, DDIR_READ);
371 if (td->o.rate[DDIR_WRITE] || td->o.rate_iops[DDIR_WRITE])
372 ret |= __setup_rate(td, DDIR_WRITE);
373 if (td->o.rate[DDIR_TRIM] || td->o.rate_iops[DDIR_TRIM])
374 ret |= __setup_rate(td, DDIR_TRIM);
379 static int fixed_block_size(struct thread_options *o)
381 return o->min_bs[DDIR_READ] == o->max_bs[DDIR_READ] &&
382 o->min_bs[DDIR_WRITE] == o->max_bs[DDIR_WRITE] &&
383 o->min_bs[DDIR_TRIM] == o->max_bs[DDIR_TRIM] &&
384 o->min_bs[DDIR_READ] == o->min_bs[DDIR_WRITE] &&
385 o->min_bs[DDIR_READ] == o->min_bs[DDIR_TRIM];
389 * Lazy way of fixing up options that depend on each other. We could also
390 * define option callback handlers, but this is easier.
392 static int fixup_options(struct thread_data *td)
394 struct thread_options *o = &td->o;
397 #ifndef FIO_HAVE_PSHARED_MUTEX
398 if (!o->use_thread) {
399 log_info("fio: this platform does not support process shared"
400 " mutexes, forcing use of threads. Use the 'thread'"
401 " option to get rid of this warning.\n");
403 ret = warnings_fatal;
407 if (o->write_iolog_file && o->read_iolog_file) {
408 log_err("fio: read iolog overrides write_iolog\n");
409 free(o->write_iolog_file);
410 o->write_iolog_file = NULL;
411 ret = warnings_fatal;
415 * only really works with 1 file
417 if (o->zone_size && o->open_files > 1)
421 * If zone_range isn't specified, backward compatibility dictates it
422 * should be made equal to zone_size.
424 if (o->zone_size && !o->zone_range)
425 o->zone_range = o->zone_size;
428 * Reads can do overwrites, we always need to pre-create the file
430 if (td_read(td) || td_rw(td))
433 if (!o->min_bs[DDIR_READ])
434 o->min_bs[DDIR_READ] = o->bs[DDIR_READ];
435 if (!o->max_bs[DDIR_READ])
436 o->max_bs[DDIR_READ] = o->bs[DDIR_READ];
437 if (!o->min_bs[DDIR_WRITE])
438 o->min_bs[DDIR_WRITE] = o->bs[DDIR_WRITE];
439 if (!o->max_bs[DDIR_WRITE])
440 o->max_bs[DDIR_WRITE] = o->bs[DDIR_WRITE];
441 if (!o->min_bs[DDIR_TRIM])
442 o->min_bs[DDIR_TRIM] = o->bs[DDIR_TRIM];
443 if (!o->max_bs[DDIR_TRIM])
444 o->max_bs[DDIR_TRIM] = o->bs[DDIR_TRIM];
447 o->rw_min_bs = min(o->min_bs[DDIR_READ], o->min_bs[DDIR_WRITE]);
448 o->rw_min_bs = min(o->min_bs[DDIR_TRIM], o->rw_min_bs);
451 * For random IO, allow blockalign offset other than min_bs.
453 if (!o->ba[DDIR_READ] || !td_random(td))
454 o->ba[DDIR_READ] = o->min_bs[DDIR_READ];
455 if (!o->ba[DDIR_WRITE] || !td_random(td))
456 o->ba[DDIR_WRITE] = o->min_bs[DDIR_WRITE];
457 if (!o->ba[DDIR_TRIM] || !td_random(td))
458 o->ba[DDIR_TRIM] = o->min_bs[DDIR_TRIM];
460 if ((o->ba[DDIR_READ] != o->min_bs[DDIR_READ] ||
461 o->ba[DDIR_WRITE] != o->min_bs[DDIR_WRITE] ||
462 o->ba[DDIR_TRIM] != o->min_bs[DDIR_TRIM]) &&
464 log_err("fio: Any use of blockalign= turns off randommap\n");
466 ret = warnings_fatal;
469 if (!o->file_size_high)
470 o->file_size_high = o->file_size_low;
472 if (o->norandommap && o->verify != VERIFY_NONE
473 && !fixed_block_size(o)) {
474 log_err("fio: norandommap given for variable block sizes, "
475 "verify disabled\n");
476 o->verify = VERIFY_NONE;
477 ret = warnings_fatal;
479 if (o->bs_unaligned && (o->odirect || td->io_ops->flags & FIO_RAWIO))
480 log_err("fio: bs_unaligned may not work with raw io\n");
483 * thinktime_spin must be less than thinktime
485 if (o->thinktime_spin > o->thinktime)
486 o->thinktime_spin = o->thinktime;
489 * The low water mark cannot be bigger than the iodepth
491 if (o->iodepth_low > o->iodepth || !o->iodepth_low)
492 o->iodepth_low = o->iodepth;
495 * If batch number isn't set, default to the same as iodepth
497 if (o->iodepth_batch > o->iodepth || !o->iodepth_batch)
498 o->iodepth_batch = o->iodepth;
500 if (o->nr_files > td->files_index)
501 o->nr_files = td->files_index;
503 if (o->open_files > o->nr_files || !o->open_files)
504 o->open_files = o->nr_files;
506 if (((o->rate[DDIR_READ] + o->rate[DDIR_WRITE] + o->rate[DDIR_TRIM]) &&
507 (o->rate_iops[DDIR_READ] + o->rate_iops[DDIR_WRITE] + o->rate_iops[DDIR_TRIM])) ||
508 ((o->ratemin[DDIR_READ] + o->ratemin[DDIR_WRITE] + o->ratemin[DDIR_TRIM]) &&
509 (o->rate_iops_min[DDIR_READ] + o->rate_iops_min[DDIR_WRITE] + o->rate_iops_min[DDIR_TRIM]))) {
510 log_err("fio: rate and rate_iops are mutually exclusive\n");
513 if ((o->rate[DDIR_READ] < o->ratemin[DDIR_READ]) ||
514 (o->rate[DDIR_WRITE] < o->ratemin[DDIR_WRITE]) ||
515 (o->rate[DDIR_TRIM] < o->ratemin[DDIR_TRIM]) ||
516 (o->rate_iops[DDIR_READ] < o->rate_iops_min[DDIR_READ]) ||
517 (o->rate_iops[DDIR_WRITE] < o->rate_iops_min[DDIR_WRITE]) ||
518 (o->rate_iops[DDIR_TRIM] < o->rate_iops_min[DDIR_TRIM])) {
519 log_err("fio: minimum rate exceeds rate\n");
523 if (!o->timeout && o->time_based) {
524 log_err("fio: time_based requires a runtime/timeout setting\n");
526 ret = warnings_fatal;
529 if (o->fill_device && !o->size)
532 if (o->verify != VERIFY_NONE) {
533 if (td_write(td) && o->do_verify && o->numjobs > 1) {
534 log_info("Multiple writers may overwrite blocks that "
535 "belong to other jobs. This can cause "
536 "verification failures.\n");
537 ret = warnings_fatal;
540 o->refill_buffers = 1;
541 if (o->max_bs[DDIR_WRITE] != o->min_bs[DDIR_WRITE] &&
543 o->verify_interval = o->min_bs[DDIR_WRITE];
547 o->invalidate_cache = 0;
548 if (td->io_ops->flags & FIO_PIPEIO) {
549 log_info("fio: cannot pre-read files with an IO engine"
550 " that isn't seekable. Pre-read disabled.\n");
551 ret = warnings_fatal;
555 #ifndef CONFIG_FDATASYNC
556 if (o->fdatasync_blocks) {
557 log_info("fio: this platform does not support fdatasync()"
558 " falling back to using fsync(). Use the 'fsync'"
559 " option instead of 'fdatasync' to get rid of"
561 o->fsync_blocks = o->fdatasync_blocks;
562 o->fdatasync_blocks = 0;
563 ret = warnings_fatal;
569 * Windows doesn't support O_DIRECT or O_SYNC with the _open interface,
570 * so fail if we're passed those flags
572 if ((td->io_ops->flags & FIO_SYNCIO) && (td->o.odirect || td->o.sync_io)) {
573 log_err("fio: Windows does not support direct or non-buffered io with"
574 " the synchronous ioengines. Use the 'windowsaio' ioengine"
575 " with 'direct=1' and 'iodepth=1' instead.\n");
581 * For fully compressible data, just zero them at init time.
582 * It's faster than repeatedly filling it.
584 if (td->o.compress_percentage == 100) {
585 td->o.zero_buffers = 1;
586 td->o.compress_percentage = 0;
590 * Using a non-uniform random distribution excludes usage of
593 if (td->o.random_distribution != FIO_RAND_DIST_RANDOM)
594 td->o.norandommap = 1;
600 * This function leaks the buffer
602 static char *to_kmg(unsigned int val)
604 char *buf = malloc(32);
605 char post[] = { 0, 'K', 'M', 'G', 'P', 'E', 0 };
616 snprintf(buf, 32, "%u%c", val, *p);
620 /* External engines are specified by "external:name.o") */
621 static const char *get_engine_name(const char *str)
623 char *p = strstr(str, ":");
629 strip_blank_front(&p);
634 static int exists_and_not_file(const char *filename)
638 if (lstat(filename, &sb) == -1)
641 /* \\.\ is the device namespace in Windows, where every file
642 * is a device node */
643 if (S_ISREG(sb.st_mode) && strncmp(filename, "\\\\.\\", 4) != 0)
649 static void td_fill_rand_seeds_os(struct thread_data *td)
651 os_random_seed(td->rand_seeds[FIO_RAND_BS_OFF], &td->bsrange_state);
652 os_random_seed(td->rand_seeds[FIO_RAND_VER_OFF], &td->verify_state);
653 os_random_seed(td->rand_seeds[FIO_RAND_MIX_OFF], &td->rwmix_state);
655 if (td->o.file_service_type == FIO_FSERVICE_RANDOM)
656 os_random_seed(td->rand_seeds[FIO_RAND_FILE_OFF], &td->next_file_state);
658 os_random_seed(td->rand_seeds[FIO_RAND_FILE_SIZE_OFF], &td->file_size_state);
659 os_random_seed(td->rand_seeds[FIO_RAND_TRIM_OFF], &td->trim_state);
664 if (td->o.rand_repeatable)
665 td->rand_seeds[FIO_RAND_BLOCK_OFF] = FIO_RANDSEED * td->thread_number;
667 os_random_seed(td->rand_seeds[FIO_RAND_BLOCK_OFF], &td->random_state);
670 static void td_fill_rand_seeds_internal(struct thread_data *td)
672 init_rand_seed(&td->__bsrange_state, td->rand_seeds[FIO_RAND_BS_OFF]);
673 init_rand_seed(&td->__verify_state, td->rand_seeds[FIO_RAND_VER_OFF]);
674 init_rand_seed(&td->__rwmix_state, td->rand_seeds[FIO_RAND_MIX_OFF]);
676 if (td->o.file_service_type == FIO_FSERVICE_RANDOM)
677 init_rand_seed(&td->__next_file_state, td->rand_seeds[FIO_RAND_FILE_OFF]);
679 init_rand_seed(&td->__file_size_state, td->rand_seeds[FIO_RAND_FILE_SIZE_OFF]);
680 init_rand_seed(&td->__trim_state, td->rand_seeds[FIO_RAND_TRIM_OFF]);
685 if (td->o.rand_repeatable)
686 td->rand_seeds[FIO_RAND_BLOCK_OFF] = FIO_RANDSEED * td->thread_number;
688 init_rand_seed(&td->__random_state, td->rand_seeds[FIO_RAND_BLOCK_OFF]);
691 void td_fill_rand_seeds(struct thread_data *td)
693 if (td->o.use_os_rand)
694 td_fill_rand_seeds_os(td);
696 td_fill_rand_seeds_internal(td);
698 init_rand_seed(&td->buf_state, td->rand_seeds[FIO_RAND_BUF_OFF]);
702 * Initializes the ioengine configured for a job, if it has not been done so
705 int ioengine_load(struct thread_data *td)
710 * Engine has already been loaded.
715 engine = get_engine_name(td->o.ioengine);
716 td->io_ops = load_ioengine(td, engine);
718 log_err("fio: failed to load engine %s\n", engine);
722 if (td->io_ops->option_struct_size && td->io_ops->options) {
724 * In cases where td->eo is set, clone it for a child thread.
725 * This requires that the parent thread has the same ioengine,
726 * but that requirement must be enforced by the code which
729 void *origeo = td->eo;
731 * Otherwise use the default thread options.
733 if (!origeo && td != &def_thread && def_thread.eo &&
734 def_thread.io_ops->options == td->io_ops->options)
735 origeo = def_thread.eo;
737 options_init(td->io_ops->options);
738 td->eo = malloc(td->io_ops->option_struct_size);
740 * Use the default thread as an option template if this uses the
741 * same options structure and there are non-default options
745 memcpy(td->eo, origeo, td->io_ops->option_struct_size);
746 options_mem_dupe(td->eo, td->io_ops->options);
748 memset(td->eo, 0, td->io_ops->option_struct_size);
749 fill_default_options(td->eo, td->io_ops->options);
751 *(struct thread_data **)td->eo = td;
757 static void init_flags(struct thread_data *td)
759 struct thread_options *o = &td->o;
761 if (o->verify_backlog)
762 td->flags |= TD_F_VER_BACKLOG;
764 td->flags |= TD_F_TRIM_BACKLOG;
765 if (o->read_iolog_file)
766 td->flags |= TD_F_READ_IOLOG;
767 if (o->refill_buffers)
768 td->flags |= TD_F_REFILL_BUFFERS;
769 if (o->scramble_buffers)
770 td->flags |= TD_F_SCRAMBLE_BUFFERS;
771 if (o->verify != VERIFY_NONE)
772 td->flags |= TD_F_VER_NONE;
775 static int setup_random_seeds(struct thread_data *td)
780 if (!td->o.rand_repeatable)
781 return init_random_state(td, td->rand_seeds, sizeof(td->rand_seeds));
783 for (seed = 0x89, i = 0; i < 4; i++)
784 seed *= 0x9e370001UL;
786 for (i = 0; i < FIO_RAND_NR_OFFS; i++) {
787 td->rand_seeds[i] = seed;
788 seed *= 0x9e370001UL;
791 td_fill_rand_seeds(td);
796 * Adds a job to the list of things todo. Sanitizes the various options
797 * to make sure we don't have conflicts, and initializes various
800 static int add_job(struct thread_data *td, const char *jobname, int job_add_num)
802 const char *ddir_str[] = { NULL, "read", "write", "rw", NULL,
803 "randread", "randwrite", "randrw",
804 "trim", NULL, NULL, NULL, "randtrim" };
806 char fname[PATH_MAX];
807 int numjobs, file_alloced;
810 * the def_thread is just for options, it's not a real job
812 if (td == &def_thread)
818 * if we are just dumping the output command line, don't add the job
825 if (profile_td_init(td))
828 if (ioengine_load(td))
831 if (td->o.use_thread)
837 td->io_ops->flags |= FIO_RAWIO;
840 if (!td->o.filename && !td->files_index && !td->o.read_iolog_file) {
843 if (td->o.nr_files == 1 && exists_and_not_file(jobname))
844 add_file(td, jobname);
846 for (i = 0; i < td->o.nr_files; i++) {
847 sprintf(fname, "%s.%d.%d", jobname,
848 td->thread_number, i);
854 if (fixup_options(td))
860 * IO engines only need this for option callbacks, and the address may
861 * change in subprocesses.
864 *(struct thread_data **)td->eo = NULL;
866 if (td->io_ops->flags & FIO_DISKLESSIO) {
869 for_each_file(td, f, i)
870 f->real_file_size = -1ULL;
873 td->mutex = fio_mutex_init(FIO_MUTEX_LOCKED);
875 td->ts.clat_percentiles = td->o.clat_percentiles;
876 td->ts.percentile_precision = td->o.percentile_precision;
877 memcpy(td->ts.percentile_list, td->o.percentile_list, sizeof(td->o.percentile_list));
879 for (i = 0; i < DDIR_RWDIR_CNT; i++) {
880 td->ts.clat_stat[i].min_val = ULONG_MAX;
881 td->ts.slat_stat[i].min_val = ULONG_MAX;
882 td->ts.lat_stat[i].min_val = ULONG_MAX;
883 td->ts.bw_stat[i].min_val = ULONG_MAX;
885 td->ddir_seq_nr = td->o.ddir_seq_nr;
887 if ((td->o.stonewall || td->o.new_group) && prev_group_jobs) {
892 td->groupid = groupid;
895 if (setup_random_seeds(td)) {
896 td_verror(td, errno, "init_random_state");
903 if (td->o.write_lat_log) {
904 setup_log(&td->lat_log, td->o.log_avg_msec);
905 setup_log(&td->slat_log, td->o.log_avg_msec);
906 setup_log(&td->clat_log, td->o.log_avg_msec);
908 if (td->o.write_bw_log)
909 setup_log(&td->bw_log, td->o.log_avg_msec);
910 if (td->o.write_iops_log)
911 setup_log(&td->iops_log, td->o.log_avg_msec);
914 td->o.name = strdup(jobname);
916 if (output_format == FIO_OUTPUT_NORMAL) {
918 if (!strcmp(td->io_ops->name, "cpuio")) {
919 log_info("%s: ioengine=cpu, cpuload=%u,"
920 " cpucycle=%u\n", td->o.name,
924 char *c1, *c2, *c3, *c4, *c5, *c6;
926 c1 = to_kmg(td->o.min_bs[DDIR_READ]);
927 c2 = to_kmg(td->o.max_bs[DDIR_READ]);
928 c3 = to_kmg(td->o.min_bs[DDIR_WRITE]);
929 c4 = to_kmg(td->o.max_bs[DDIR_WRITE]);
930 c5 = to_kmg(td->o.min_bs[DDIR_TRIM]);
931 c6 = to_kmg(td->o.max_bs[DDIR_TRIM]);
933 log_info("%s: (g=%d): rw=%s, bs=%s-%s/%s-%s/%s-%s,"
934 " ioengine=%s, iodepth=%u\n",
935 td->o.name, td->groupid,
936 ddir_str[td->o.td_ddir],
937 c1, c2, c3, c4, c5, c6,
948 } else if (job_add_num == 1)
953 * recurse add identical jobs, clear numjobs and stonewall options
954 * as they don't apply to sub-jobs
956 numjobs = td->o.numjobs;
958 struct thread_data *td_new = get_new_job(0, td, 1);
963 td_new->o.numjobs = 1;
964 td_new->o.stonewall = 0;
965 td_new->o.new_group = 0;
968 td_new->o.filename = NULL;
969 td_new->files_index = 0;
970 td_new->files_size = 0;
971 td_new->files = NULL;
974 job_add_num = numjobs - 1;
976 if (add_job(td_new, jobname, job_add_num))
987 * Parse as if 'o' was a command line
989 void add_job_opts(const char **o)
991 struct thread_data *td, *td_parent;
992 int i, in_global = 1;
996 td_parent = td = NULL;
998 if (!strncmp(o[i], "name", 4)) {
1001 add_job(td, jobname, 0);
1003 sprintf(jobname, "%s", o[i] + 5);
1005 if (in_global && !td_parent)
1006 td_parent = get_new_job(1, &def_thread, 0);
1007 else if (!in_global && !td) {
1009 td_parent = &def_thread;
1010 td = get_new_job(0, td_parent, 0);
1013 fio_options_parse(td_parent, (char **) &o[i], 1);
1015 fio_options_parse(td, (char **) &o[i], 1);
1020 add_job(td, jobname, 0);
1023 static int skip_this_section(const char *name)
1027 if (!nr_job_sections)
1029 if (!strncmp(name, "global", 6))
1032 for (i = 0; i < nr_job_sections; i++)
1033 if (!strcmp(job_sections[i], name))
1039 static int is_empty_or_comment(char *line)
1043 for (i = 0; i < strlen(line); i++) {
1048 if (!isspace((int) line[i]) && !iscntrl((int) line[i]))
1056 * This is our [ini] type file parser.
1058 int parse_jobs_ini(char *file, int is_buf, int stonewall_flag)
1060 unsigned int global;
1061 struct thread_data *td;
1062 char *string, *name;
1065 int ret = 0, stonewall;
1068 int inside_skip = 0;
1070 int i, alloc_opts, num_opts;
1075 if (!strcmp(file, "-"))
1078 f = fopen(file, "r");
1081 perror("fopen job file");
1086 string = malloc(4096);
1089 * it's really 256 + small bit, 280 should suffice
1092 memset(name, 0, 280);
1095 opts = malloc(sizeof(char *) * alloc_opts);
1098 stonewall = stonewall_flag;
1101 * if skip_fgets is set, we already have loaded a line we
1106 p = strsep(&file, "\n");
1108 p = fgets(string, 4096, f);
1114 strip_blank_front(&p);
1117 if (is_empty_or_comment(p))
1119 if (sscanf(p, "[%255[^\n]]", name) != 1) {
1122 log_err("fio: option <%s> outside of [] job section\n",
1127 name[strlen(name) - 1] = '\0';
1129 if (skip_this_section(name)) {
1135 global = !strncmp(name, "global", 6);
1141 log_info("--name=%s ", name);
1145 td = get_new_job(global, &def_thread, 0);
1152 * Seperate multiple job files by a stonewall
1154 if (!global && stonewall) {
1155 td->o.stonewall = stonewall;
1160 memset(opts, 0, alloc_opts * sizeof(char *));
1164 p = strsep(&file, "\n");
1166 p = fgets(string, 4096, f);
1170 if (is_empty_or_comment(p))
1173 strip_blank_front(&p);
1176 * new section, break out and make sure we don't
1177 * fgets() a new line at the top.
1186 if (num_opts == alloc_opts) {
1188 opts = realloc(opts,
1189 alloc_opts * sizeof(char *));
1192 opts[num_opts] = strdup(p);
1196 ret = fio_options_parse(td, opts, num_opts);
1199 for (i = 0; i < num_opts; i++)
1200 log_info("--%s ", opts[i]);
1202 ret = add_job(td, name, 0);
1204 log_err("fio: job %s dropped\n", name);
1208 for (i = 0; i < num_opts; i++)
1217 while (i < nr_job_sections) {
1218 free(job_sections[i]);
1222 for (i = 0; i < num_opts; i++)
1228 if (!is_buf && f != stdin)
1233 static int fill_def_thread(void)
1235 memset(&def_thread, 0, sizeof(def_thread));
1237 fio_getaffinity(getpid(), &def_thread.o.cpumask);
1238 def_thread.o.timeout = def_timeout;
1239 def_thread.o.error_dump = 1;
1241 * fill default options
1243 fio_fill_default_options(&def_thread);
1247 static void usage(const char *name)
1249 printf("%s\n", fio_version_string);
1250 printf("%s [options] [job options] <job file(s)>\n", name);
1251 printf(" --debug=options\tEnable debug logging. May be one/more of:\n"
1252 "\t\t\tprocess,file,io,mem,blktrace,verify,random,parse,\n"
1253 "\t\t\tdiskutil,job,mutex,profile,time,net\n");
1254 printf(" --output\t\tWrite output to file\n");
1255 printf(" --runtime\t\tRuntime in seconds\n");
1256 printf(" --latency-log\t\tGenerate per-job latency logs\n");
1257 printf(" --bandwidth-log\tGenerate per-job bandwidth logs\n");
1258 printf(" --minimal\t\tMinimal (terse) output\n");
1259 printf(" --output-format=x\tOutput format (terse,json,normal)\n");
1260 printf(" --terse-version=x\tSet terse version output format to 'x'\n");
1261 printf(" --version\t\tPrint version info and exit\n");
1262 printf(" --help\t\tPrint this page\n");
1263 printf(" --cpuclock-test\tPerform test/validation of CPU clock\n");
1264 printf(" --cmdhelp=cmd\t\tPrint command help, \"all\" for all of"
1266 printf(" --enghelp=engine\tPrint ioengine help, or list"
1267 " available ioengines\n");
1268 printf(" --enghelp=engine,cmd\tPrint help for an ioengine"
1270 printf(" --showcmd\t\tTurn a job file into command line options\n");
1271 printf(" --eta=when\t\tWhen ETA estimate should be printed\n");
1272 printf(" \t\tMay be \"always\", \"never\" or \"auto\"\n");
1273 printf(" --eta-newline=time\tForce a new line for every 'time'");
1274 printf(" period passed\n");
1275 printf(" --readonly\t\tTurn on safety read-only checks, preventing"
1277 printf(" --section=name\tOnly run specified section in job file\n");
1278 printf(" --alloc-size=kb\tSet smalloc pool to this size in kb"
1280 printf(" --warnings-fatal\tFio parser warnings are fatal\n");
1281 printf(" --max-jobs=nr\t\tMaximum number of threads/processes to support\n");
1282 printf(" --server=args\t\tStart a backend fio server\n");
1283 printf(" --daemonize=pidfile\tBackground fio server, write pid to file\n");
1284 printf(" --client=hostname\tTalk to remote backend fio server at hostname\n");
1285 printf(" --idle-prof=option\tReport cpu idleness on a system or percpu basis\n"
1286 "\t\t\t(option=system,percpu) or run unit work\n"
1287 "\t\t\tcalibration only (option=calibrate)\n");
1288 printf("\nFio was written by Jens Axboe <jens.axboe@oracle.com>");
1289 printf("\n Jens Axboe <jaxboe@fusionio.com>\n");
1292 #ifdef FIO_INC_DEBUG
1293 struct debug_level debug_levels[] = {
1294 { .name = "process", .shift = FD_PROCESS, },
1295 { .name = "file", .shift = FD_FILE, },
1296 { .name = "io", .shift = FD_IO, },
1297 { .name = "mem", .shift = FD_MEM, },
1298 { .name = "blktrace", .shift = FD_BLKTRACE },
1299 { .name = "verify", .shift = FD_VERIFY },
1300 { .name = "random", .shift = FD_RANDOM },
1301 { .name = "parse", .shift = FD_PARSE },
1302 { .name = "diskutil", .shift = FD_DISKUTIL },
1303 { .name = "job", .shift = FD_JOB },
1304 { .name = "mutex", .shift = FD_MUTEX },
1305 { .name = "profile", .shift = FD_PROFILE },
1306 { .name = "time", .shift = FD_TIME },
1307 { .name = "net", .shift = FD_NET },
1311 static int set_debug(const char *string)
1313 struct debug_level *dl;
1314 char *p = (char *) string;
1318 if (!strcmp(string, "?") || !strcmp(string, "help")) {
1319 log_info("fio: dumping debug options:");
1320 for (i = 0; debug_levels[i].name; i++) {
1321 dl = &debug_levels[i];
1322 log_info("%s,", dl->name);
1328 while ((opt = strsep(&p, ",")) != NULL) {
1331 if (!strncmp(opt, "all", 3)) {
1332 log_info("fio: set all debug options\n");
1337 for (i = 0; debug_levels[i].name; i++) {
1338 dl = &debug_levels[i];
1339 found = !strncmp(opt, dl->name, strlen(dl->name));
1343 if (dl->shift == FD_JOB) {
1344 opt = strchr(opt, ':');
1346 log_err("fio: missing job number\n");
1350 fio_debug_jobno = atoi(opt);
1351 log_info("fio: set debug jobno %d\n",
1354 log_info("fio: set debug option %s\n", opt);
1355 fio_debug |= (1UL << dl->shift);
1361 log_err("fio: debug mask %s not found\n", opt);
1366 static int set_debug(const char *string)
1368 log_err("fio: debug tracing not included in build\n");
1373 static void fio_options_fill_optstring(void)
1375 char *ostr = cmd_optstr;
1379 while (l_opts[i].name) {
1380 ostr[c++] = l_opts[i].val;
1381 if (l_opts[i].has_arg == required_argument)
1383 else if (l_opts[i].has_arg == optional_argument) {
1392 static int client_flag_set(char c)
1397 while (l_opts[i].name) {
1398 int val = l_opts[i].val;
1400 if (c == (val & 0xff))
1401 return (val & FIO_CLIENT_FLAG);
1409 void parse_cmd_client(void *client, char *opt)
1411 fio_client_add_cmd_option(client, opt);
1414 int parse_cmd_line(int argc, char *argv[])
1416 struct thread_data *td = NULL;
1417 int c, ini_idx = 0, lidx, ret = 0, do_exit = 0, exit_val = 0;
1418 char *ostr = cmd_optstr;
1419 void *pid_file = NULL;
1420 void *cur_client = NULL;
1424 * Reset optind handling, since we may call this multiple times
1429 while ((c = getopt_long_only(argc, argv, ostr, l_opts, &lidx)) != -1) {
1432 if ((c & FIO_CLIENT_FLAG) || client_flag_set(c)) {
1433 parse_cmd_client(cur_client, argv[optind - 1]);
1434 c &= ~FIO_CLIENT_FLAG;
1439 smalloc_pool_size = atoi(optarg);
1442 def_timeout = atoi(optarg);
1451 f_out = fopen(optarg, "w+");
1453 perror("fopen output");
1459 output_format = FIO_OUTPUT_TERSE;
1462 if (!strcmp(optarg, "minimal") ||
1463 !strcmp(optarg, "terse") ||
1464 !strcmp(optarg, "csv"))
1465 output_format = FIO_OUTPUT_TERSE;
1466 else if (!strcmp(optarg, "json"))
1467 output_format = FIO_OUTPUT_JSON;
1469 output_format = FIO_OUTPUT_NORMAL;
1479 fio_show_option_help(optarg);
1485 fio_show_ioengine_help(optarg);
1497 log_info("%s\n", fio_version_string);
1502 terse_version = atoi(optarg);
1503 if (!(terse_version == 2 || terse_version == 3 ||
1504 terse_version == 4)) {
1505 log_err("fio: bad terse version format\n");
1511 if (!strcmp("always", optarg))
1512 eta_print = FIO_ETA_ALWAYS;
1513 else if (!strcmp("never", optarg))
1514 eta_print = FIO_ETA_NEVER;
1519 if (str_to_decimal(optarg, &t, 0, NULL)) {
1520 log_err("fio: failed parsing eta time %s\n", optarg);
1528 if (set_debug(optarg))
1534 if (!strcmp(optarg, "global")) {
1535 log_err("fio: can't use global as only "
1541 new_size = (nr_job_sections + 1) * sizeof(char *);
1542 job_sections = realloc(job_sections, new_size);
1543 job_sections[nr_job_sections] = strdup(optarg);
1548 exec_profile = strdup(optarg);
1550 case FIO_GETOPT_JOB: {
1551 const char *opt = l_opts[lidx].name;
1554 if (!strncmp(opt, "name", 4) && td) {
1555 ret = add_job(td, td->o.name ?: "fio", 0);
1561 int is_section = !strncmp(opt, "name", 4);
1564 if (!is_section || !strncmp(val, "global", 6))
1567 if (is_section && skip_this_section(val))
1570 td = get_new_job(global, &def_thread, 1);
1571 if (!td || ioengine_load(td))
1573 fio_options_set_ioengine_opts(l_opts, td);
1576 ret = fio_cmd_option_parse(td, opt, val);
1578 if (!ret && !strcmp(opt, "ioengine")) {
1580 if (ioengine_load(td))
1582 fio_options_set_ioengine_opts(l_opts, td);
1586 case FIO_GETOPT_IOENGINE: {
1587 const char *opt = l_opts[lidx].name;
1589 opt = l_opts[lidx].name;
1591 ret = fio_cmd_ioengine_option_parse(td, opt, val);
1598 max_jobs = atoi(optarg);
1599 if (!max_jobs || max_jobs > REAL_MAX_JOBS) {
1600 log_err("fio: invalid max jobs: %d\n", max_jobs);
1607 log_err("fio: can't be both client and server\n");
1613 fio_server_set_arg(optarg);
1618 pid_file = strdup(optarg);
1621 if ((ret = fio_idle_prof_parse_opt(optarg))) {
1622 /* exit on error and calibration only */
1630 log_err("fio: can't be both client and server\n");
1635 if (fio_client_add(optarg, &cur_client)) {
1636 log_err("fio: failed adding client %s\n", optarg);
1642 * If the next argument exists and isn't an option,
1643 * assume it's a job file for this client only.
1645 while (optind < argc) {
1646 if (!strncmp(argv[optind], "--", 2) ||
1647 !strncmp(argv[optind], "-", 1))
1650 fio_client_add_ini_file(cur_client, argv[optind]);
1656 exit_val = fio_monotonic_clocktest();
1659 log_err("%s: unrecognized option '%s'\n", argv[0],
1671 if (exit_val && !(is_backend || nr_clients))
1675 if (nr_clients && fio_clients_connect()) {
1681 if (is_backend && backend)
1682 return fio_start_server(pid_file);
1686 ret = add_job(td, td->o.name ?: "fio", 0);
1689 while (!ret && optind < argc) {
1691 ini_file = realloc(ini_file, ini_idx * sizeof(char *));
1692 ini_file[ini_idx - 1] = strdup(argv[optind]);
1699 int parse_options(int argc, char *argv[])
1706 fio_options_fill_optstring();
1707 fio_options_dup_and_init(l_opts);
1711 if (fill_def_thread())
1714 job_files = parse_cmd_line(argc, argv);
1716 if (job_files > 0) {
1717 for (i = 0; i < job_files; i++) {
1718 if (fill_def_thread())
1721 if (fio_clients_send_ini(ini_file[i]))
1724 } else if (!is_backend) {
1725 if (parse_jobs_ini(ini_file[i], 0, i))
1730 } else if (nr_clients) {
1731 if (fill_def_thread())
1733 if (fio_clients_send_ini(NULL))
1738 fio_options_free(&def_thread);
1740 if (!thread_number) {
1745 if (is_backend || nr_clients)
1750 log_err("No jobs(s) defined\n\n");
1760 if (def_thread.o.gtod_offload) {
1762 fio_gtod_offload = 1;
1763 fio_gtod_cpu = def_thread.o.gtod_cpu;
1766 if (output_format == FIO_OUTPUT_NORMAL)
1767 log_info("%s\n", fio_version_string);