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;
37 static int parse_only;
39 static struct thread_data def_thread;
40 struct thread_data *threads = NULL;
42 int exitall_on_terminate = 0;
43 int output_format = FIO_OUTPUT_NORMAL;
44 int eta_print = FIO_ETA_AUTO;
46 unsigned long long mlock_size = 0;
49 char **job_sections = NULL;
50 int nr_job_sections = 0;
51 char *exec_profile = NULL;
52 int warnings_fatal = 0;
53 int terse_version = 3;
61 static int write_lat_log;
63 static int prev_group_jobs;
65 unsigned long fio_debug = 0;
66 unsigned int fio_debug_jobno = -1;
67 unsigned int *fio_debug_jobp = NULL;
69 static char cmd_optstr[256];
72 #define FIO_CLIENT_FLAG (1 << 16)
75 * Command line options. These will contain the above, plus a few
76 * extra that only pertain to fio itself and not jobs.
78 static struct option l_opts[FIO_NR_OPTIONS] = {
80 .name = (char *) "output",
81 .has_arg = required_argument,
82 .val = 'o' | FIO_CLIENT_FLAG,
85 .name = (char *) "timeout",
86 .has_arg = required_argument,
87 .val = 't' | FIO_CLIENT_FLAG,
90 .name = (char *) "latency-log",
91 .has_arg = required_argument,
92 .val = 'l' | FIO_CLIENT_FLAG,
95 .name = (char *) "bandwidth-log",
96 .has_arg = required_argument,
97 .val = 'b' | FIO_CLIENT_FLAG,
100 .name = (char *) "minimal",
101 .has_arg = optional_argument,
102 .val = 'm' | FIO_CLIENT_FLAG,
105 .name = (char *) "output-format",
106 .has_arg = optional_argument,
107 .val = 'F' | FIO_CLIENT_FLAG,
110 .name = (char *) "version",
111 .has_arg = no_argument,
112 .val = 'v' | FIO_CLIENT_FLAG,
115 .name = (char *) "help",
116 .has_arg = no_argument,
117 .val = 'h' | FIO_CLIENT_FLAG,
120 .name = (char *) "cmdhelp",
121 .has_arg = optional_argument,
122 .val = 'c' | FIO_CLIENT_FLAG,
125 .name = (char *) "enghelp",
126 .has_arg = optional_argument,
127 .val = 'i' | FIO_CLIENT_FLAG,
130 .name = (char *) "showcmd",
131 .has_arg = no_argument,
132 .val = 's' | FIO_CLIENT_FLAG,
135 .name = (char *) "readonly",
136 .has_arg = no_argument,
137 .val = 'r' | FIO_CLIENT_FLAG,
140 .name = (char *) "eta",
141 .has_arg = required_argument,
142 .val = 'e' | FIO_CLIENT_FLAG,
145 .name = (char *) "eta-newline",
146 .has_arg = required_argument,
147 .val = 'E' | FIO_CLIENT_FLAG,
150 .name = (char *) "debug",
151 .has_arg = required_argument,
152 .val = 'd' | FIO_CLIENT_FLAG,
155 .name = (char *) "parse-only",
156 .has_arg = no_argument,
157 .val = 'P' | 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 = optional_argument,
194 { .name = (char *) "daemonize",
195 .has_arg = required_argument,
199 .name = (char *) "client",
200 .has_arg = required_argument,
204 .name = (char *) "cpuclock-test",
205 .has_arg = no_argument,
209 .name = (char *) "idle-prof",
210 .has_arg = required_argument,
218 static void free_shm(void)
220 struct shmid_ds sbuf;
228 fio_debug_jobp = NULL;
230 shmctl(shm_id, IPC_RMID, &sbuf);
237 * The thread area is shared between the main process and the job
238 * threads/processes. So setup a shared memory segment that will hold
239 * all the job info. We use the end of the region for keeping track of
240 * open files across jobs, for file sharing.
242 static int setup_thread_area(void)
250 * 1024 is too much on some machines, scale max_jobs if
251 * we get a failure that looks like too large a shm segment
254 size_t size = max_jobs * sizeof(struct thread_data);
256 size += file_hash_size;
257 size += sizeof(unsigned int);
259 shm_id = shmget(0, size, IPC_CREAT | 0600);
262 if (errno != EINVAL && errno != ENOMEM && errno != ENOSPC) {
273 threads = shmat(shm_id, NULL, 0);
274 if (threads == (void *) -1) {
279 memset(threads, 0, max_jobs * sizeof(struct thread_data));
280 hash = (void *) threads + max_jobs * sizeof(struct thread_data);
281 fio_debug_jobp = (void *) hash + file_hash_size;
282 *fio_debug_jobp = -1;
283 file_hash_init(hash);
291 * Return a free job structure.
293 static struct thread_data *get_new_job(int global, struct thread_data *parent,
296 struct thread_data *td;
300 if (setup_thread_area()) {
301 log_err("error: failed to setup shm segment\n");
304 if (thread_number >= max_jobs) {
305 log_err("error: maximum number of jobs (%d) reached.\n",
310 td = &threads[thread_number++];
317 td->o.uid = td->o.gid = -1U;
319 dup_files(td, parent);
320 fio_options_mem_dupe(td);
322 profile_add_hooks(td);
324 td->thread_number = thread_number;
326 if (!parent || !parent->o.group_reporting)
332 static void put_job(struct thread_data *td)
334 if (td == &def_thread)
341 log_info("fio: %s\n", td->verror);
343 fio_options_free(td);
347 memset(&threads[td->thread_number - 1], 0, sizeof(*td));
351 static int __setup_rate(struct thread_data *td, enum fio_ddir ddir)
353 unsigned int bs = td->o.min_bs[ddir];
355 assert(ddir_rw(ddir));
357 if (td->o.rate[ddir])
358 td->rate_bps[ddir] = td->o.rate[ddir];
360 td->rate_bps[ddir] = td->o.rate_iops[ddir] * bs;
362 if (!td->rate_bps[ddir]) {
363 log_err("rate lower than supported\n");
367 td->rate_pending_usleep[ddir] = 0;
371 static int setup_rate(struct thread_data *td)
375 if (td->o.rate[DDIR_READ] || td->o.rate_iops[DDIR_READ])
376 ret = __setup_rate(td, DDIR_READ);
377 if (td->o.rate[DDIR_WRITE] || td->o.rate_iops[DDIR_WRITE])
378 ret |= __setup_rate(td, DDIR_WRITE);
379 if (td->o.rate[DDIR_TRIM] || td->o.rate_iops[DDIR_TRIM])
380 ret |= __setup_rate(td, DDIR_TRIM);
385 static int fixed_block_size(struct thread_options *o)
387 return o->min_bs[DDIR_READ] == o->max_bs[DDIR_READ] &&
388 o->min_bs[DDIR_WRITE] == o->max_bs[DDIR_WRITE] &&
389 o->min_bs[DDIR_TRIM] == o->max_bs[DDIR_TRIM] &&
390 o->min_bs[DDIR_READ] == o->min_bs[DDIR_WRITE] &&
391 o->min_bs[DDIR_READ] == o->min_bs[DDIR_TRIM];
395 * Lazy way of fixing up options that depend on each other. We could also
396 * define option callback handlers, but this is easier.
398 static int fixup_options(struct thread_data *td)
400 struct thread_options *o = &td->o;
403 #ifndef FIO_HAVE_PSHARED_MUTEX
404 if (!o->use_thread) {
405 log_info("fio: this platform does not support process shared"
406 " mutexes, forcing use of threads. Use the 'thread'"
407 " option to get rid of this warning.\n");
409 ret = warnings_fatal;
413 if (o->write_iolog_file && o->read_iolog_file) {
414 log_err("fio: read iolog overrides write_iolog\n");
415 free(o->write_iolog_file);
416 o->write_iolog_file = NULL;
417 ret = warnings_fatal;
421 * only really works with 1 file
423 if (o->zone_size && o->open_files > 1)
427 * If zone_range isn't specified, backward compatibility dictates it
428 * should be made equal to zone_size.
430 if (o->zone_size && !o->zone_range)
431 o->zone_range = o->zone_size;
434 * Reads can do overwrites, we always need to pre-create the file
436 if (td_read(td) || td_rw(td))
439 if (!o->min_bs[DDIR_READ])
440 o->min_bs[DDIR_READ] = o->bs[DDIR_READ];
441 if (!o->max_bs[DDIR_READ])
442 o->max_bs[DDIR_READ] = o->bs[DDIR_READ];
443 if (!o->min_bs[DDIR_WRITE])
444 o->min_bs[DDIR_WRITE] = o->bs[DDIR_WRITE];
445 if (!o->max_bs[DDIR_WRITE])
446 o->max_bs[DDIR_WRITE] = o->bs[DDIR_WRITE];
447 if (!o->min_bs[DDIR_TRIM])
448 o->min_bs[DDIR_TRIM] = o->bs[DDIR_TRIM];
449 if (!o->max_bs[DDIR_TRIM])
450 o->max_bs[DDIR_TRIM] = o->bs[DDIR_TRIM];
453 o->rw_min_bs = min(o->min_bs[DDIR_READ], o->min_bs[DDIR_WRITE]);
454 o->rw_min_bs = min(o->min_bs[DDIR_TRIM], o->rw_min_bs);
457 * For random IO, allow blockalign offset other than min_bs.
459 if (!o->ba[DDIR_READ] || !td_random(td))
460 o->ba[DDIR_READ] = o->min_bs[DDIR_READ];
461 if (!o->ba[DDIR_WRITE] || !td_random(td))
462 o->ba[DDIR_WRITE] = o->min_bs[DDIR_WRITE];
463 if (!o->ba[DDIR_TRIM] || !td_random(td))
464 o->ba[DDIR_TRIM] = o->min_bs[DDIR_TRIM];
466 if ((o->ba[DDIR_READ] != o->min_bs[DDIR_READ] ||
467 o->ba[DDIR_WRITE] != o->min_bs[DDIR_WRITE] ||
468 o->ba[DDIR_TRIM] != o->min_bs[DDIR_TRIM]) &&
470 log_err("fio: Any use of blockalign= turns off randommap\n");
472 ret = warnings_fatal;
475 if (!o->file_size_high)
476 o->file_size_high = o->file_size_low;
478 if (o->norandommap && o->verify != VERIFY_NONE
479 && !fixed_block_size(o)) {
480 log_err("fio: norandommap given for variable block sizes, "
481 "verify disabled\n");
482 o->verify = VERIFY_NONE;
483 ret = warnings_fatal;
485 if (o->bs_unaligned && (o->odirect || td->io_ops->flags & FIO_RAWIO))
486 log_err("fio: bs_unaligned may not work with raw io\n");
489 * thinktime_spin must be less than thinktime
491 if (o->thinktime_spin > o->thinktime)
492 o->thinktime_spin = o->thinktime;
495 * The low water mark cannot be bigger than the iodepth
497 if (o->iodepth_low > o->iodepth || !o->iodepth_low)
498 o->iodepth_low = o->iodepth;
501 * If batch number isn't set, default to the same as iodepth
503 if (o->iodepth_batch > o->iodepth || !o->iodepth_batch)
504 o->iodepth_batch = o->iodepth;
506 if (o->nr_files > td->files_index)
507 o->nr_files = td->files_index;
509 if (o->open_files > o->nr_files || !o->open_files)
510 o->open_files = o->nr_files;
512 if (((o->rate[DDIR_READ] + o->rate[DDIR_WRITE] + o->rate[DDIR_TRIM]) &&
513 (o->rate_iops[DDIR_READ] + o->rate_iops[DDIR_WRITE] + o->rate_iops[DDIR_TRIM])) ||
514 ((o->ratemin[DDIR_READ] + o->ratemin[DDIR_WRITE] + o->ratemin[DDIR_TRIM]) &&
515 (o->rate_iops_min[DDIR_READ] + o->rate_iops_min[DDIR_WRITE] + o->rate_iops_min[DDIR_TRIM]))) {
516 log_err("fio: rate and rate_iops are mutually exclusive\n");
519 if ((o->rate[DDIR_READ] < o->ratemin[DDIR_READ]) ||
520 (o->rate[DDIR_WRITE] < o->ratemin[DDIR_WRITE]) ||
521 (o->rate[DDIR_TRIM] < o->ratemin[DDIR_TRIM]) ||
522 (o->rate_iops[DDIR_READ] < o->rate_iops_min[DDIR_READ]) ||
523 (o->rate_iops[DDIR_WRITE] < o->rate_iops_min[DDIR_WRITE]) ||
524 (o->rate_iops[DDIR_TRIM] < o->rate_iops_min[DDIR_TRIM])) {
525 log_err("fio: minimum rate exceeds rate\n");
529 if (!o->timeout && o->time_based) {
530 log_err("fio: time_based requires a runtime/timeout setting\n");
532 ret = warnings_fatal;
535 if (o->fill_device && !o->size)
538 if (o->verify != VERIFY_NONE) {
539 if (td_write(td) && o->do_verify && o->numjobs > 1) {
540 log_info("Multiple writers may overwrite blocks that "
541 "belong to other jobs. This can cause "
542 "verification failures.\n");
543 ret = warnings_fatal;
546 o->refill_buffers = 1;
547 if (o->max_bs[DDIR_WRITE] != o->min_bs[DDIR_WRITE] &&
549 o->verify_interval = o->min_bs[DDIR_WRITE];
553 o->invalidate_cache = 0;
554 if (td->io_ops->flags & FIO_PIPEIO) {
555 log_info("fio: cannot pre-read files with an IO engine"
556 " that isn't seekable. Pre-read disabled.\n");
557 ret = warnings_fatal;
561 #ifndef CONFIG_FDATASYNC
562 if (o->fdatasync_blocks) {
563 log_info("fio: this platform does not support fdatasync()"
564 " falling back to using fsync(). Use the 'fsync'"
565 " option instead of 'fdatasync' to get rid of"
567 o->fsync_blocks = o->fdatasync_blocks;
568 o->fdatasync_blocks = 0;
569 ret = warnings_fatal;
575 * Windows doesn't support O_DIRECT or O_SYNC with the _open interface,
576 * so fail if we're passed those flags
578 if ((td->io_ops->flags & FIO_SYNCIO) && (td->o.odirect || td->o.sync_io)) {
579 log_err("fio: Windows does not support direct or non-buffered io with"
580 " the synchronous ioengines. Use the 'windowsaio' ioengine"
581 " with 'direct=1' and 'iodepth=1' instead.\n");
587 * For fully compressible data, just zero them at init time.
588 * It's faster than repeatedly filling it.
590 if (td->o.compress_percentage == 100) {
591 td->o.zero_buffers = 1;
592 td->o.compress_percentage = 0;
596 * Using a non-uniform random distribution excludes usage of
599 if (td->o.random_distribution != FIO_RAND_DIST_RANDOM)
600 td->o.norandommap = 1;
606 * This function leaks the buffer
608 static char *to_kmg(unsigned int val)
610 char *buf = malloc(32);
611 char post[] = { 0, 'K', 'M', 'G', 'P', 'E', 0 };
622 snprintf(buf, 32, "%u%c", val, *p);
626 /* External engines are specified by "external:name.o") */
627 static const char *get_engine_name(const char *str)
629 char *p = strstr(str, ":");
635 strip_blank_front(&p);
640 static int exists_and_not_file(const char *filename)
644 if (lstat(filename, &sb) == -1)
647 /* \\.\ is the device namespace in Windows, where every file
648 * is a device node */
649 if (S_ISREG(sb.st_mode) && strncmp(filename, "\\\\.\\", 4) != 0)
655 static void td_fill_rand_seeds_os(struct thread_data *td)
657 os_random_seed(td->rand_seeds[FIO_RAND_BS_OFF], &td->bsrange_state);
658 os_random_seed(td->rand_seeds[FIO_RAND_VER_OFF], &td->verify_state);
659 os_random_seed(td->rand_seeds[FIO_RAND_MIX_OFF], &td->rwmix_state);
661 if (td->o.file_service_type == FIO_FSERVICE_RANDOM)
662 os_random_seed(td->rand_seeds[FIO_RAND_FILE_OFF], &td->next_file_state);
664 os_random_seed(td->rand_seeds[FIO_RAND_FILE_SIZE_OFF], &td->file_size_state);
665 os_random_seed(td->rand_seeds[FIO_RAND_TRIM_OFF], &td->trim_state);
670 if (td->o.rand_repeatable)
671 td->rand_seeds[FIO_RAND_BLOCK_OFF] = FIO_RANDSEED * td->thread_number;
673 os_random_seed(td->rand_seeds[FIO_RAND_BLOCK_OFF], &td->random_state);
676 static void td_fill_rand_seeds_internal(struct thread_data *td)
678 init_rand_seed(&td->__bsrange_state, td->rand_seeds[FIO_RAND_BS_OFF]);
679 init_rand_seed(&td->__verify_state, td->rand_seeds[FIO_RAND_VER_OFF]);
680 init_rand_seed(&td->__rwmix_state, td->rand_seeds[FIO_RAND_MIX_OFF]);
682 if (td->o.file_service_type == FIO_FSERVICE_RANDOM)
683 init_rand_seed(&td->__next_file_state, td->rand_seeds[FIO_RAND_FILE_OFF]);
685 init_rand_seed(&td->__file_size_state, td->rand_seeds[FIO_RAND_FILE_SIZE_OFF]);
686 init_rand_seed(&td->__trim_state, td->rand_seeds[FIO_RAND_TRIM_OFF]);
691 if (td->o.rand_repeatable)
692 td->rand_seeds[FIO_RAND_BLOCK_OFF] = FIO_RANDSEED * td->thread_number;
694 init_rand_seed(&td->__random_state, td->rand_seeds[FIO_RAND_BLOCK_OFF]);
697 void td_fill_rand_seeds(struct thread_data *td)
699 if (td->o.use_os_rand)
700 td_fill_rand_seeds_os(td);
702 td_fill_rand_seeds_internal(td);
704 init_rand_seed(&td->buf_state, td->rand_seeds[FIO_RAND_BUF_OFF]);
708 * Initializes the ioengine configured for a job, if it has not been done so
711 int ioengine_load(struct thread_data *td)
716 * Engine has already been loaded.
721 engine = get_engine_name(td->o.ioengine);
722 td->io_ops = load_ioengine(td, engine);
724 log_err("fio: failed to load engine %s\n", engine);
728 if (td->io_ops->option_struct_size && td->io_ops->options) {
730 * In cases where td->eo is set, clone it for a child thread.
731 * This requires that the parent thread has the same ioengine,
732 * but that requirement must be enforced by the code which
735 void *origeo = td->eo;
737 * Otherwise use the default thread options.
739 if (!origeo && td != &def_thread && def_thread.eo &&
740 def_thread.io_ops->options == td->io_ops->options)
741 origeo = def_thread.eo;
743 options_init(td->io_ops->options);
744 td->eo = malloc(td->io_ops->option_struct_size);
746 * Use the default thread as an option template if this uses the
747 * same options structure and there are non-default options
751 memcpy(td->eo, origeo, td->io_ops->option_struct_size);
752 options_mem_dupe(td->eo, td->io_ops->options);
754 memset(td->eo, 0, td->io_ops->option_struct_size);
755 fill_default_options(td->eo, td->io_ops->options);
757 *(struct thread_data **)td->eo = td;
763 static void init_flags(struct thread_data *td)
765 struct thread_options *o = &td->o;
767 if (o->verify_backlog)
768 td->flags |= TD_F_VER_BACKLOG;
770 td->flags |= TD_F_TRIM_BACKLOG;
771 if (o->read_iolog_file)
772 td->flags |= TD_F_READ_IOLOG;
773 if (o->refill_buffers)
774 td->flags |= TD_F_REFILL_BUFFERS;
775 if (o->scramble_buffers)
776 td->flags |= TD_F_SCRAMBLE_BUFFERS;
777 if (o->verify != VERIFY_NONE)
778 td->flags |= TD_F_VER_NONE;
781 static int setup_random_seeds(struct thread_data *td)
786 if (!td->o.rand_repeatable)
787 return init_random_state(td, td->rand_seeds, sizeof(td->rand_seeds));
789 for (seed = 0x89, i = 0; i < 4; i++)
790 seed *= 0x9e370001UL;
792 for (i = 0; i < FIO_RAND_NR_OFFS; i++) {
793 td->rand_seeds[i] = seed;
794 seed *= 0x9e370001UL;
797 td_fill_rand_seeds(td);
802 * Adds a job to the list of things todo. Sanitizes the various options
803 * to make sure we don't have conflicts, and initializes various
806 static int add_job(struct thread_data *td, const char *jobname, int job_add_num)
808 const char *ddir_str[] = { NULL, "read", "write", "rw", NULL,
809 "randread", "randwrite", "randrw",
810 "trim", NULL, NULL, NULL, "randtrim" };
812 char fname[PATH_MAX];
813 int numjobs, file_alloced;
816 * the def_thread is just for options, it's not a real job
818 if (td == &def_thread)
824 * if we are just dumping the output command line, don't add the job
826 if (dump_cmdline || parse_only) {
831 if (profile_td_init(td))
834 if (ioengine_load(td))
837 if (td->o.use_thread)
843 td->io_ops->flags |= FIO_RAWIO;
846 if (!td->o.filename && !td->files_index && !td->o.read_iolog_file) {
849 if (td->o.nr_files == 1 && exists_and_not_file(jobname))
850 add_file(td, jobname);
852 for (i = 0; i < td->o.nr_files; i++) {
853 sprintf(fname, "%s.%d.%d", jobname,
854 td->thread_number, i);
860 if (fixup_options(td))
866 * IO engines only need this for option callbacks, and the address may
867 * change in subprocesses.
870 *(struct thread_data **)td->eo = NULL;
872 if (td->io_ops->flags & FIO_DISKLESSIO) {
875 for_each_file(td, f, i)
876 f->real_file_size = -1ULL;
879 td->mutex = fio_mutex_init(FIO_MUTEX_LOCKED);
881 td->ts.clat_percentiles = td->o.clat_percentiles;
882 td->ts.percentile_precision = td->o.percentile_precision;
883 memcpy(td->ts.percentile_list, td->o.percentile_list, sizeof(td->o.percentile_list));
885 for (i = 0; i < DDIR_RWDIR_CNT; i++) {
886 td->ts.clat_stat[i].min_val = ULONG_MAX;
887 td->ts.slat_stat[i].min_val = ULONG_MAX;
888 td->ts.lat_stat[i].min_val = ULONG_MAX;
889 td->ts.bw_stat[i].min_val = ULONG_MAX;
891 td->ddir_seq_nr = td->o.ddir_seq_nr;
893 if ((td->o.stonewall || td->o.new_group) && prev_group_jobs) {
898 td->groupid = groupid;
901 if (setup_random_seeds(td)) {
902 td_verror(td, errno, "init_random_state");
909 if (td->o.write_lat_log) {
910 setup_log(&td->lat_log, td->o.log_avg_msec);
911 setup_log(&td->slat_log, td->o.log_avg_msec);
912 setup_log(&td->clat_log, td->o.log_avg_msec);
914 if (td->o.write_bw_log)
915 setup_log(&td->bw_log, td->o.log_avg_msec);
916 if (td->o.write_iops_log)
917 setup_log(&td->iops_log, td->o.log_avg_msec);
920 td->o.name = strdup(jobname);
922 if (output_format == FIO_OUTPUT_NORMAL) {
924 if (!strcmp(td->io_ops->name, "cpuio")) {
925 log_info("%s: ioengine=cpu, cpuload=%u,"
926 " cpucycle=%u\n", td->o.name,
930 char *c1, *c2, *c3, *c4, *c5, *c6;
932 c1 = to_kmg(td->o.min_bs[DDIR_READ]);
933 c2 = to_kmg(td->o.max_bs[DDIR_READ]);
934 c3 = to_kmg(td->o.min_bs[DDIR_WRITE]);
935 c4 = to_kmg(td->o.max_bs[DDIR_WRITE]);
936 c5 = to_kmg(td->o.min_bs[DDIR_TRIM]);
937 c6 = to_kmg(td->o.max_bs[DDIR_TRIM]);
939 log_info("%s: (g=%d): rw=%s, bs=%s-%s/%s-%s/%s-%s,"
940 " ioengine=%s, iodepth=%u\n",
941 td->o.name, td->groupid,
942 ddir_str[td->o.td_ddir],
943 c1, c2, c3, c4, c5, c6,
954 } else if (job_add_num == 1)
959 * recurse add identical jobs, clear numjobs and stonewall options
960 * as they don't apply to sub-jobs
962 numjobs = td->o.numjobs;
964 struct thread_data *td_new = get_new_job(0, td, 1);
969 td_new->o.numjobs = 1;
970 td_new->o.stonewall = 0;
971 td_new->o.new_group = 0;
974 td_new->o.filename = NULL;
975 td_new->files_index = 0;
976 td_new->files_size = 0;
977 td_new->files = NULL;
980 job_add_num = numjobs - 1;
982 if (add_job(td_new, jobname, job_add_num))
993 * Parse as if 'o' was a command line
995 void add_job_opts(const char **o)
997 struct thread_data *td, *td_parent;
998 int i, in_global = 1;
1002 td_parent = td = NULL;
1004 if (!strncmp(o[i], "name", 4)) {
1007 add_job(td, jobname, 0);
1009 sprintf(jobname, "%s", o[i] + 5);
1011 if (in_global && !td_parent)
1012 td_parent = get_new_job(1, &def_thread, 0);
1013 else if (!in_global && !td) {
1015 td_parent = &def_thread;
1016 td = get_new_job(0, td_parent, 0);
1019 fio_options_parse(td_parent, (char **) &o[i], 1);
1021 fio_options_parse(td, (char **) &o[i], 1);
1026 add_job(td, jobname, 0);
1029 static int skip_this_section(const char *name)
1033 if (!nr_job_sections)
1035 if (!strncmp(name, "global", 6))
1038 for (i = 0; i < nr_job_sections; i++)
1039 if (!strcmp(job_sections[i], name))
1045 static int is_empty_or_comment(char *line)
1049 for (i = 0; i < strlen(line); i++) {
1054 if (!isspace((int) line[i]) && !iscntrl((int) line[i]))
1062 * This is our [ini] type file parser.
1064 int parse_jobs_ini(char *file, int is_buf, int stonewall_flag)
1066 unsigned int global;
1067 struct thread_data *td;
1068 char *string, *name;
1071 int ret = 0, stonewall;
1074 int inside_skip = 0;
1076 int i, alloc_opts, num_opts;
1081 if (!strcmp(file, "-"))
1084 f = fopen(file, "r");
1087 perror("fopen job file");
1092 string = malloc(4096);
1095 * it's really 256 + small bit, 280 should suffice
1098 memset(name, 0, 280);
1101 opts = malloc(sizeof(char *) * alloc_opts);
1104 stonewall = stonewall_flag;
1107 * if skip_fgets is set, we already have loaded a line we
1112 p = strsep(&file, "\n");
1114 p = fgets(string, 4096, f);
1120 strip_blank_front(&p);
1123 if (is_empty_or_comment(p))
1125 if (sscanf(p, "[%255[^\n]]", name) != 1) {
1128 log_err("fio: option <%s> outside of [] job section\n",
1133 name[strlen(name) - 1] = '\0';
1135 if (skip_this_section(name)) {
1141 global = !strncmp(name, "global", 6);
1147 log_info("--name=%s ", name);
1151 td = get_new_job(global, &def_thread, 0);
1158 * Seperate multiple job files by a stonewall
1160 if (!global && stonewall) {
1161 td->o.stonewall = stonewall;
1166 memset(opts, 0, alloc_opts * sizeof(char *));
1170 p = strsep(&file, "\n");
1172 p = fgets(string, 4096, f);
1176 if (is_empty_or_comment(p))
1179 strip_blank_front(&p);
1182 * new section, break out and make sure we don't
1183 * fgets() a new line at the top.
1192 if (num_opts == alloc_opts) {
1194 opts = realloc(opts,
1195 alloc_opts * sizeof(char *));
1198 opts[num_opts] = strdup(p);
1202 ret = fio_options_parse(td, opts, num_opts);
1205 for (i = 0; i < num_opts; i++)
1206 log_info("--%s ", opts[i]);
1208 ret = add_job(td, name, 0);
1210 log_err("fio: job %s dropped\n", name);
1214 for (i = 0; i < num_opts; i++)
1223 while (i < nr_job_sections) {
1224 free(job_sections[i]);
1228 for (i = 0; i < num_opts; i++)
1234 if (!is_buf && f != stdin)
1239 static int fill_def_thread(void)
1241 memset(&def_thread, 0, sizeof(def_thread));
1243 fio_getaffinity(getpid(), &def_thread.o.cpumask);
1244 def_thread.o.timeout = def_timeout;
1245 def_thread.o.error_dump = 1;
1247 * fill default options
1249 fio_fill_default_options(&def_thread);
1253 static void usage(const char *name)
1255 printf("%s\n", fio_version_string);
1256 printf("%s [options] [job options] <job file(s)>\n", name);
1257 printf(" --debug=options\tEnable debug logging. May be one/more of:\n"
1258 "\t\t\tprocess,file,io,mem,blktrace,verify,random,parse,\n"
1259 "\t\t\tdiskutil,job,mutex,profile,time,net\n");
1260 printf(" --parse-only\t\tParse options only, don't start any IO\n");
1261 printf(" --output\t\tWrite output to file\n");
1262 printf(" --runtime\t\tRuntime in seconds\n");
1263 printf(" --latency-log\t\tGenerate per-job latency logs\n");
1264 printf(" --bandwidth-log\tGenerate per-job bandwidth logs\n");
1265 printf(" --minimal\t\tMinimal (terse) output\n");
1266 printf(" --output-format=x\tOutput format (terse,json,normal)\n");
1267 printf(" --terse-version=x\tSet terse version output format to 'x'\n");
1268 printf(" --version\t\tPrint version info and exit\n");
1269 printf(" --help\t\tPrint this page\n");
1270 printf(" --cpuclock-test\tPerform test/validation of CPU clock\n");
1271 printf(" --cmdhelp=cmd\t\tPrint command help, \"all\" for all of"
1273 printf(" --enghelp=engine\tPrint ioengine help, or list"
1274 " available ioengines\n");
1275 printf(" --enghelp=engine,cmd\tPrint help for an ioengine"
1277 printf(" --showcmd\t\tTurn a job file into command line options\n");
1278 printf(" --eta=when\t\tWhen ETA estimate should be printed\n");
1279 printf(" \t\tMay be \"always\", \"never\" or \"auto\"\n");
1280 printf(" --eta-newline=time\tForce a new line for every 'time'");
1281 printf(" period passed\n");
1282 printf(" --readonly\t\tTurn on safety read-only checks, preventing"
1284 printf(" --section=name\tOnly run specified section in job file\n");
1285 printf(" --alloc-size=kb\tSet smalloc pool to this size in kb"
1287 printf(" --warnings-fatal\tFio parser warnings are fatal\n");
1288 printf(" --max-jobs=nr\t\tMaximum number of threads/processes to support\n");
1289 printf(" --server=args\t\tStart a backend fio server\n");
1290 printf(" --daemonize=pidfile\tBackground fio server, write pid to file\n");
1291 printf(" --client=hostname\tTalk to remote backend fio server at hostname\n");
1292 printf(" --idle-prof=option\tReport cpu idleness on a system or percpu basis\n"
1293 "\t\t\t(option=system,percpu) or run unit work\n"
1294 "\t\t\tcalibration only (option=calibrate)\n");
1295 printf("\nFio was written by Jens Axboe <jens.axboe@oracle.com>");
1296 printf("\n Jens Axboe <jaxboe@fusionio.com>\n");
1299 #ifdef FIO_INC_DEBUG
1300 struct debug_level debug_levels[] = {
1301 { .name = "process", .shift = FD_PROCESS, },
1302 { .name = "file", .shift = FD_FILE, },
1303 { .name = "io", .shift = FD_IO, },
1304 { .name = "mem", .shift = FD_MEM, },
1305 { .name = "blktrace", .shift = FD_BLKTRACE },
1306 { .name = "verify", .shift = FD_VERIFY },
1307 { .name = "random", .shift = FD_RANDOM },
1308 { .name = "parse", .shift = FD_PARSE },
1309 { .name = "diskutil", .shift = FD_DISKUTIL },
1310 { .name = "job", .shift = FD_JOB },
1311 { .name = "mutex", .shift = FD_MUTEX },
1312 { .name = "profile", .shift = FD_PROFILE },
1313 { .name = "time", .shift = FD_TIME },
1314 { .name = "net", .shift = FD_NET },
1318 static int set_debug(const char *string)
1320 struct debug_level *dl;
1321 char *p = (char *) string;
1325 if (!strcmp(string, "?") || !strcmp(string, "help")) {
1326 log_info("fio: dumping debug options:");
1327 for (i = 0; debug_levels[i].name; i++) {
1328 dl = &debug_levels[i];
1329 log_info("%s,", dl->name);
1335 while ((opt = strsep(&p, ",")) != NULL) {
1338 if (!strncmp(opt, "all", 3)) {
1339 log_info("fio: set all debug options\n");
1344 for (i = 0; debug_levels[i].name; i++) {
1345 dl = &debug_levels[i];
1346 found = !strncmp(opt, dl->name, strlen(dl->name));
1350 if (dl->shift == FD_JOB) {
1351 opt = strchr(opt, ':');
1353 log_err("fio: missing job number\n");
1357 fio_debug_jobno = atoi(opt);
1358 log_info("fio: set debug jobno %d\n",
1361 log_info("fio: set debug option %s\n", opt);
1362 fio_debug |= (1UL << dl->shift);
1368 log_err("fio: debug mask %s not found\n", opt);
1373 static int set_debug(const char *string)
1375 log_err("fio: debug tracing not included in build\n");
1380 static void fio_options_fill_optstring(void)
1382 char *ostr = cmd_optstr;
1386 while (l_opts[i].name) {
1387 ostr[c++] = l_opts[i].val;
1388 if (l_opts[i].has_arg == required_argument)
1390 else if (l_opts[i].has_arg == optional_argument) {
1399 static int client_flag_set(char c)
1404 while (l_opts[i].name) {
1405 int val = l_opts[i].val;
1407 if (c == (val & 0xff))
1408 return (val & FIO_CLIENT_FLAG);
1416 void parse_cmd_client(void *client, char *opt)
1418 fio_client_add_cmd_option(client, opt);
1421 int parse_cmd_line(int argc, char *argv[])
1423 struct thread_data *td = NULL;
1424 int c, ini_idx = 0, lidx, ret = 0, do_exit = 0, exit_val = 0;
1425 char *ostr = cmd_optstr;
1426 void *pid_file = NULL;
1427 void *cur_client = NULL;
1431 * Reset optind handling, since we may call this multiple times
1436 while ((c = getopt_long_only(argc, argv, ostr, l_opts, &lidx)) != -1) {
1439 if ((c & FIO_CLIENT_FLAG) || client_flag_set(c)) {
1440 parse_cmd_client(cur_client, argv[optind - 1]);
1441 c &= ~FIO_CLIENT_FLAG;
1446 smalloc_pool_size = atoi(optarg);
1449 def_timeout = atoi(optarg);
1458 f_out = fopen(optarg, "w+");
1460 perror("fopen output");
1466 output_format = FIO_OUTPUT_TERSE;
1469 if (!strcmp(optarg, "minimal") ||
1470 !strcmp(optarg, "terse") ||
1471 !strcmp(optarg, "csv"))
1472 output_format = FIO_OUTPUT_TERSE;
1473 else if (!strcmp(optarg, "json"))
1474 output_format = FIO_OUTPUT_JSON;
1476 output_format = FIO_OUTPUT_NORMAL;
1486 fio_show_option_help(optarg);
1492 fio_show_ioengine_help(optarg);
1504 log_info("%s\n", fio_version_string);
1509 terse_version = atoi(optarg);
1510 if (!(terse_version == 2 || terse_version == 3 ||
1511 terse_version == 4)) {
1512 log_err("fio: bad terse version format\n");
1518 if (!strcmp("always", optarg))
1519 eta_print = FIO_ETA_ALWAYS;
1520 else if (!strcmp("never", optarg))
1521 eta_print = FIO_ETA_NEVER;
1526 if (str_to_decimal(optarg, &t, 0, NULL)) {
1527 log_err("fio: failed parsing eta time %s\n", optarg);
1535 if (set_debug(optarg))
1544 if (!strcmp(optarg, "global")) {
1545 log_err("fio: can't use global as only "
1551 new_size = (nr_job_sections + 1) * sizeof(char *);
1552 job_sections = realloc(job_sections, new_size);
1553 job_sections[nr_job_sections] = strdup(optarg);
1558 exec_profile = strdup(optarg);
1560 case FIO_GETOPT_JOB: {
1561 const char *opt = l_opts[lidx].name;
1564 if (!strncmp(opt, "name", 4) && td) {
1565 ret = add_job(td, td->o.name ?: "fio", 0);
1571 int is_section = !strncmp(opt, "name", 4);
1574 if (!is_section || !strncmp(val, "global", 6))
1577 if (is_section && skip_this_section(val))
1580 td = get_new_job(global, &def_thread, 1);
1581 if (!td || ioengine_load(td))
1583 fio_options_set_ioengine_opts(l_opts, td);
1586 ret = fio_cmd_option_parse(td, opt, val);
1588 if (!ret && !strcmp(opt, "ioengine")) {
1590 if (ioengine_load(td))
1592 fio_options_set_ioengine_opts(l_opts, td);
1596 case FIO_GETOPT_IOENGINE: {
1597 const char *opt = l_opts[lidx].name;
1599 opt = l_opts[lidx].name;
1601 ret = fio_cmd_ioengine_option_parse(td, opt, val);
1608 max_jobs = atoi(optarg);
1609 if (!max_jobs || max_jobs > REAL_MAX_JOBS) {
1610 log_err("fio: invalid max jobs: %d\n", max_jobs);
1617 log_err("fio: can't be both client and server\n");
1623 fio_server_set_arg(optarg);
1628 pid_file = strdup(optarg);
1631 if ((ret = fio_idle_prof_parse_opt(optarg))) {
1632 /* exit on error and calibration only */
1640 log_err("fio: can't be both client and server\n");
1645 if (fio_client_add(optarg, &cur_client)) {
1646 log_err("fio: failed adding client %s\n", optarg);
1652 * If the next argument exists and isn't an option,
1653 * assume it's a job file for this client only.
1655 while (optind < argc) {
1656 if (!strncmp(argv[optind], "--", 2) ||
1657 !strncmp(argv[optind], "-", 1))
1660 fio_client_add_ini_file(cur_client, argv[optind]);
1666 exit_val = fio_monotonic_clocktest();
1669 log_err("%s: unrecognized option '%s'\n", argv[0],
1681 if (exit_val && !(is_backend || nr_clients))
1685 if (nr_clients && fio_clients_connect()) {
1691 if (is_backend && backend)
1692 return fio_start_server(pid_file);
1696 ret = add_job(td, td->o.name ?: "fio", 0);
1699 while (!ret && optind < argc) {
1701 ini_file = realloc(ini_file, ini_idx * sizeof(char *));
1702 ini_file[ini_idx - 1] = strdup(argv[optind]);
1709 int parse_options(int argc, char *argv[])
1716 fio_options_fill_optstring();
1717 fio_options_dup_and_init(l_opts);
1721 if (fill_def_thread())
1724 job_files = parse_cmd_line(argc, argv);
1726 if (job_files > 0) {
1727 for (i = 0; i < job_files; i++) {
1728 if (fill_def_thread())
1731 if (fio_clients_send_ini(ini_file[i]))
1734 } else if (!is_backend) {
1735 if (parse_jobs_ini(ini_file[i], 0, i))
1740 } else if (nr_clients) {
1741 if (fill_def_thread())
1743 if (fio_clients_send_ini(NULL))
1748 fio_options_free(&def_thread);
1750 if (!thread_number) {
1751 if (dump_cmdline || parse_only)
1755 if (is_backend || nr_clients)
1760 log_err("No jobs(s) defined\n\n");
1770 if (def_thread.o.gtod_offload) {
1772 fio_gtod_offload = 1;
1773 fio_gtod_cpu = def_thread.o.gtod_cpu;
1776 if (output_format == FIO_OUTPUT_NORMAL)
1777 log_info("%s\n", fio_version_string);