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;
44 unsigned long long mlock_size = 0;
47 char **job_sections = NULL;
48 int nr_job_sections = 0;
49 char *exec_profile = NULL;
50 int warnings_fatal = 0;
51 int terse_version = 3;
59 static int write_lat_log;
61 static int prev_group_jobs;
63 unsigned long fio_debug = 0;
64 unsigned int fio_debug_jobno = -1;
65 unsigned int *fio_debug_jobp = NULL;
67 static char cmd_optstr[256];
70 const fio_fp64_t def_percentile_list[FIO_IO_U_LIST_MAX_LEN] = {
90 #define FIO_CLIENT_FLAG (1 << 16)
93 * Command line options. These will contain the above, plus a few
94 * extra that only pertain to fio itself and not jobs.
96 static struct option l_opts[FIO_NR_OPTIONS] = {
98 .name = (char *) "output",
99 .has_arg = required_argument,
100 .val = 'o' | FIO_CLIENT_FLAG,
103 .name = (char *) "timeout",
104 .has_arg = required_argument,
105 .val = 't' | FIO_CLIENT_FLAG,
108 .name = (char *) "latency-log",
109 .has_arg = required_argument,
110 .val = 'l' | FIO_CLIENT_FLAG,
113 .name = (char *) "bandwidth-log",
114 .has_arg = required_argument,
115 .val = 'b' | FIO_CLIENT_FLAG,
118 .name = (char *) "minimal",
119 .has_arg = optional_argument,
120 .val = 'm' | FIO_CLIENT_FLAG,
123 .name = (char *) "output-format",
124 .has_arg = optional_argument,
125 .val = 'F' | FIO_CLIENT_FLAG,
128 .name = (char *) "version",
129 .has_arg = no_argument,
130 .val = 'v' | FIO_CLIENT_FLAG,
133 .name = (char *) "help",
134 .has_arg = no_argument,
135 .val = 'h' | FIO_CLIENT_FLAG,
138 .name = (char *) "cmdhelp",
139 .has_arg = optional_argument,
140 .val = 'c' | FIO_CLIENT_FLAG,
143 .name = (char *) "enghelp",
144 .has_arg = optional_argument,
145 .val = 'i' | FIO_CLIENT_FLAG,
148 .name = (char *) "showcmd",
149 .has_arg = no_argument,
150 .val = 's' | FIO_CLIENT_FLAG,
153 .name = (char *) "readonly",
154 .has_arg = no_argument,
155 .val = 'r' | FIO_CLIENT_FLAG,
158 .name = (char *) "eta",
159 .has_arg = required_argument,
160 .val = 'e' | FIO_CLIENT_FLAG,
163 .name = (char *) "debug",
164 .has_arg = required_argument,
165 .val = 'd' | FIO_CLIENT_FLAG,
168 .name = (char *) "section",
169 .has_arg = required_argument,
170 .val = 'x' | FIO_CLIENT_FLAG,
173 .name = (char *) "alloc-size",
174 .has_arg = required_argument,
175 .val = 'a' | FIO_CLIENT_FLAG,
178 .name = (char *) "profile",
179 .has_arg = required_argument,
180 .val = 'p' | FIO_CLIENT_FLAG,
183 .name = (char *) "warnings-fatal",
184 .has_arg = no_argument,
185 .val = 'w' | FIO_CLIENT_FLAG,
188 .name = (char *) "max-jobs",
189 .has_arg = required_argument,
190 .val = 'j' | FIO_CLIENT_FLAG,
193 .name = (char *) "terse-version",
194 .has_arg = required_argument,
195 .val = 'V' | FIO_CLIENT_FLAG,
198 .name = (char *) "server",
199 .has_arg = optional_argument,
202 { .name = (char *) "daemonize",
203 .has_arg = required_argument,
207 .name = (char *) "client",
208 .has_arg = required_argument,
212 .name = (char *) "cpuclock-test",
213 .has_arg = no_argument,
217 .name = (char *) "idle-prof",
218 .has_arg = required_argument,
226 static void free_shm(void)
228 struct shmid_ds sbuf;
236 fio_debug_jobp = NULL;
238 shmctl(shm_id, IPC_RMID, &sbuf);
245 * The thread area is shared between the main process and the job
246 * threads/processes. So setup a shared memory segment that will hold
247 * all the job info. We use the end of the region for keeping track of
248 * open files across jobs, for file sharing.
250 static int setup_thread_area(void)
258 * 1024 is too much on some machines, scale max_jobs if
259 * we get a failure that looks like too large a shm segment
262 size_t size = max_jobs * sizeof(struct thread_data);
264 size += file_hash_size;
265 size += sizeof(unsigned int);
267 shm_id = shmget(0, size, IPC_CREAT | 0600);
270 if (errno != EINVAL && errno != ENOMEM && errno != ENOSPC) {
281 threads = shmat(shm_id, NULL, 0);
282 if (threads == (void *) -1) {
287 memset(threads, 0, max_jobs * sizeof(struct thread_data));
288 hash = (void *) threads + max_jobs * sizeof(struct thread_data);
289 fio_debug_jobp = (void *) hash + file_hash_size;
290 *fio_debug_jobp = -1;
291 file_hash_init(hash);
299 * Return a free job structure.
301 static struct thread_data *get_new_job(int global, struct thread_data *parent,
304 struct thread_data *td;
308 if (setup_thread_area()) {
309 log_err("error: failed to setup shm segment\n");
312 if (thread_number >= max_jobs) {
313 log_err("error: maximum number of jobs (%d) reached.\n",
318 td = &threads[thread_number++];
325 td->o.uid = td->o.gid = -1U;
327 dup_files(td, parent);
328 fio_options_mem_dupe(td);
330 profile_add_hooks(td);
332 td->thread_number = thread_number;
334 if (!parent || !parent->o.group_reporting)
340 static void put_job(struct thread_data *td)
342 if (td == &def_thread)
349 log_info("fio: %s\n", td->verror);
351 fio_options_free(td);
355 memset(&threads[td->thread_number - 1], 0, sizeof(*td));
359 static int __setup_rate(struct thread_data *td, enum fio_ddir ddir)
361 unsigned int bs = td->o.min_bs[ddir];
363 assert(ddir_rw(ddir));
365 if (td->o.rate[ddir])
366 td->rate_bps[ddir] = td->o.rate[ddir];
368 td->rate_bps[ddir] = td->o.rate_iops[ddir] * bs;
370 if (!td->rate_bps[ddir]) {
371 log_err("rate lower than supported\n");
375 td->rate_pending_usleep[ddir] = 0;
379 static int setup_rate(struct thread_data *td)
383 if (td->o.rate[DDIR_READ] || td->o.rate_iops[DDIR_READ])
384 ret = __setup_rate(td, DDIR_READ);
385 if (td->o.rate[DDIR_WRITE] || td->o.rate_iops[DDIR_WRITE])
386 ret |= __setup_rate(td, DDIR_WRITE);
387 if (td->o.rate[DDIR_TRIM] || td->o.rate_iops[DDIR_TRIM])
388 ret |= __setup_rate(td, DDIR_TRIM);
393 static int fixed_block_size(struct thread_options *o)
395 return o->min_bs[DDIR_READ] == o->max_bs[DDIR_READ] &&
396 o->min_bs[DDIR_WRITE] == o->max_bs[DDIR_WRITE] &&
397 o->min_bs[DDIR_TRIM] == o->max_bs[DDIR_TRIM] &&
398 o->min_bs[DDIR_READ] == o->min_bs[DDIR_WRITE] &&
399 o->min_bs[DDIR_READ] == o->min_bs[DDIR_TRIM];
403 * Lazy way of fixing up options that depend on each other. We could also
404 * define option callback handlers, but this is easier.
406 static int fixup_options(struct thread_data *td)
408 struct thread_options *o = &td->o;
411 #ifndef FIO_HAVE_PSHARED_MUTEX
412 if (!o->use_thread) {
413 log_info("fio: this platform does not support process shared"
414 " mutexes, forcing use of threads. Use the 'thread'"
415 " option to get rid of this warning.\n");
417 ret = warnings_fatal;
421 if (o->write_iolog_file && o->read_iolog_file) {
422 log_err("fio: read iolog overrides write_iolog\n");
423 free(o->write_iolog_file);
424 o->write_iolog_file = NULL;
425 ret = warnings_fatal;
429 * only really works with 1 file
431 if (o->zone_size && o->open_files == 1)
435 * If zone_range isn't specified, backward compatibility dictates it
436 * should be made equal to zone_size.
438 if (o->zone_size && !o->zone_range)
439 o->zone_range = o->zone_size;
442 * Reads can do overwrites, we always need to pre-create the file
444 if (td_read(td) || td_rw(td))
447 if (!o->min_bs[DDIR_READ])
448 o->min_bs[DDIR_READ] = o->bs[DDIR_READ];
449 if (!o->max_bs[DDIR_READ])
450 o->max_bs[DDIR_READ] = o->bs[DDIR_READ];
451 if (!o->min_bs[DDIR_WRITE])
452 o->min_bs[DDIR_WRITE] = o->bs[DDIR_WRITE];
453 if (!o->max_bs[DDIR_WRITE])
454 o->max_bs[DDIR_WRITE] = o->bs[DDIR_WRITE];
455 if (!o->min_bs[DDIR_TRIM])
456 o->min_bs[DDIR_TRIM] = o->bs[DDIR_TRIM];
457 if (!o->max_bs[DDIR_TRIM])
458 o->max_bs[DDIR_TRIM] = o->bs[DDIR_TRIM];
461 o->rw_min_bs = min(o->min_bs[DDIR_READ], o->min_bs[DDIR_WRITE]);
462 o->rw_min_bs = min(o->min_bs[DDIR_TRIM], o->rw_min_bs);
465 * For random IO, allow blockalign offset other than min_bs.
467 if (!o->ba[DDIR_READ] || !td_random(td))
468 o->ba[DDIR_READ] = o->min_bs[DDIR_READ];
469 if (!o->ba[DDIR_WRITE] || !td_random(td))
470 o->ba[DDIR_WRITE] = o->min_bs[DDIR_WRITE];
471 if (!o->ba[DDIR_TRIM] || !td_random(td))
472 o->ba[DDIR_TRIM] = o->min_bs[DDIR_TRIM];
474 if ((o->ba[DDIR_READ] != o->min_bs[DDIR_READ] ||
475 o->ba[DDIR_WRITE] != o->min_bs[DDIR_WRITE] ||
476 o->ba[DDIR_TRIM] != o->min_bs[DDIR_TRIM]) &&
478 log_err("fio: Any use of blockalign= turns off randommap\n");
480 ret = warnings_fatal;
483 if (!o->file_size_high)
484 o->file_size_high = o->file_size_low;
486 if (o->norandommap && o->verify != VERIFY_NONE
487 && !fixed_block_size(o)) {
488 log_err("fio: norandommap given for variable block sizes, "
489 "verify disabled\n");
490 o->verify = VERIFY_NONE;
491 ret = warnings_fatal;
493 if (o->bs_unaligned && (o->odirect || td->io_ops->flags & FIO_RAWIO))
494 log_err("fio: bs_unaligned may not work with raw io\n");
497 * thinktime_spin must be less than thinktime
499 if (o->thinktime_spin > o->thinktime)
500 o->thinktime_spin = o->thinktime;
503 * The low water mark cannot be bigger than the iodepth
505 if (o->iodepth_low > o->iodepth || !o->iodepth_low)
506 o->iodepth_low = o->iodepth;
509 * If batch number isn't set, default to the same as iodepth
511 if (o->iodepth_batch > o->iodepth || !o->iodepth_batch)
512 o->iodepth_batch = o->iodepth;
514 if (o->nr_files > td->files_index)
515 o->nr_files = td->files_index;
517 if (o->open_files > o->nr_files || !o->open_files)
518 o->open_files = o->nr_files;
520 if (((o->rate[DDIR_READ] + o->rate[DDIR_WRITE] + o->rate[DDIR_TRIM]) &&
521 (o->rate_iops[DDIR_READ] + o->rate_iops[DDIR_WRITE] + o->rate_iops[DDIR_TRIM])) ||
522 ((o->ratemin[DDIR_READ] + o->ratemin[DDIR_WRITE] + o->ratemin[DDIR_TRIM]) &&
523 (o->rate_iops_min[DDIR_READ] + o->rate_iops_min[DDIR_WRITE] + o->rate_iops_min[DDIR_TRIM]))) {
524 log_err("fio: rate and rate_iops are mutually exclusive\n");
527 if ((o->rate[DDIR_READ] < o->ratemin[DDIR_READ]) ||
528 (o->rate[DDIR_WRITE] < o->ratemin[DDIR_WRITE]) ||
529 (o->rate[DDIR_TRIM] < o->ratemin[DDIR_TRIM]) ||
530 (o->rate_iops[DDIR_READ] < o->rate_iops_min[DDIR_READ]) ||
531 (o->rate_iops[DDIR_WRITE] < o->rate_iops_min[DDIR_WRITE]) ||
532 (o->rate_iops[DDIR_TRIM] < o->rate_iops_min[DDIR_TRIM])) {
533 log_err("fio: minimum rate exceeds rate\n");
537 if (!o->timeout && o->time_based) {
538 log_err("fio: time_based requires a runtime/timeout setting\n");
540 ret = warnings_fatal;
543 if (o->fill_device && !o->size)
546 if (o->verify != VERIFY_NONE) {
547 if (td_write(td) && o->do_verify && o->numjobs > 1) {
548 log_info("Multiple writers may overwrite blocks that "
549 "belong to other jobs. This can cause "
550 "verification failures.\n");
551 ret = warnings_fatal;
554 o->refill_buffers = 1;
555 if (o->max_bs[DDIR_WRITE] != o->min_bs[DDIR_WRITE] &&
557 o->verify_interval = o->min_bs[DDIR_WRITE];
561 o->invalidate_cache = 0;
562 if (td->io_ops->flags & FIO_PIPEIO) {
563 log_info("fio: cannot pre-read files with an IO engine"
564 " that isn't seekable. Pre-read disabled.\n");
565 ret = warnings_fatal;
569 #ifndef CONFIG_FDATASYNC
570 if (o->fdatasync_blocks) {
571 log_info("fio: this platform does not support fdatasync()"
572 " falling back to using fsync(). Use the 'fsync'"
573 " option instead of 'fdatasync' to get rid of"
575 o->fsync_blocks = o->fdatasync_blocks;
576 o->fdatasync_blocks = 0;
577 ret = warnings_fatal;
583 * Windows doesn't support O_DIRECT or O_SYNC with the _open interface,
584 * so fail if we're passed those flags
586 if ((td->io_ops->flags & FIO_SYNCIO) && (td->o.odirect || td->o.sync_io)) {
587 log_err("fio: Windows does not support direct or non-buffered io with"
588 " the synchronous ioengines. Use the 'windowsaio' ioengine"
589 " with 'direct=1' and 'iodepth=1' instead.\n");
595 * For fully compressible data, just zero them at init time.
596 * It's faster than repeatedly filling it.
598 if (td->o.compress_percentage == 100) {
599 td->o.zero_buffers = 1;
600 td->o.compress_percentage = 0;
604 * Using a non-uniform random distribution excludes usage of
607 if (td->o.random_distribution != FIO_RAND_DIST_RANDOM)
608 td->o.norandommap = 1;
614 * This function leaks the buffer
616 static char *to_kmg(unsigned int val)
618 char *buf = malloc(32);
619 char post[] = { 0, 'K', 'M', 'G', 'P', 'E', 0 };
630 snprintf(buf, 31, "%u%c", val, *p);
634 /* External engines are specified by "external:name.o") */
635 static const char *get_engine_name(const char *str)
637 char *p = strstr(str, ":");
643 strip_blank_front(&p);
648 static int exists_and_not_file(const char *filename)
652 if (lstat(filename, &sb) == -1)
655 /* \\.\ is the device namespace in Windows, where every file
656 * is a device node */
657 if (S_ISREG(sb.st_mode) && strncmp(filename, "\\\\.\\", 4) != 0)
663 static void td_fill_rand_seeds_os(struct thread_data *td)
665 os_random_seed(td->rand_seeds[FIO_RAND_BS_OFF], &td->bsrange_state);
666 os_random_seed(td->rand_seeds[FIO_RAND_VER_OFF], &td->verify_state);
667 os_random_seed(td->rand_seeds[FIO_RAND_MIX_OFF], &td->rwmix_state);
669 if (td->o.file_service_type == FIO_FSERVICE_RANDOM)
670 os_random_seed(td->rand_seeds[FIO_RAND_FILE_OFF], &td->next_file_state);
672 os_random_seed(td->rand_seeds[FIO_RAND_FILE_SIZE_OFF], &td->file_size_state);
673 os_random_seed(td->rand_seeds[FIO_RAND_TRIM_OFF], &td->trim_state);
678 if (td->o.rand_repeatable)
679 td->rand_seeds[FIO_RAND_BLOCK_OFF] = FIO_RANDSEED * td->thread_number;
681 os_random_seed(td->rand_seeds[FIO_RAND_BLOCK_OFF], &td->random_state);
684 static void td_fill_rand_seeds_internal(struct thread_data *td)
686 init_rand_seed(&td->__bsrange_state, td->rand_seeds[FIO_RAND_BS_OFF]);
687 init_rand_seed(&td->__verify_state, td->rand_seeds[FIO_RAND_VER_OFF]);
688 init_rand_seed(&td->__rwmix_state, td->rand_seeds[FIO_RAND_MIX_OFF]);
690 if (td->o.file_service_type == FIO_FSERVICE_RANDOM)
691 init_rand_seed(&td->__next_file_state, td->rand_seeds[FIO_RAND_FILE_OFF]);
693 init_rand_seed(&td->__file_size_state, td->rand_seeds[FIO_RAND_FILE_SIZE_OFF]);
694 init_rand_seed(&td->__trim_state, td->rand_seeds[FIO_RAND_TRIM_OFF]);
699 if (td->o.rand_repeatable)
700 td->rand_seeds[FIO_RAND_BLOCK_OFF] = FIO_RANDSEED * td->thread_number;
702 init_rand_seed(&td->__random_state, td->rand_seeds[FIO_RAND_BLOCK_OFF]);
705 void td_fill_rand_seeds(struct thread_data *td)
707 if (td->o.use_os_rand)
708 td_fill_rand_seeds_os(td);
710 td_fill_rand_seeds_internal(td);
712 init_rand_seed(&td->buf_state, td->rand_seeds[FIO_RAND_BUF_OFF]);
716 * Initializes the ioengine configured for a job, if it has not been done so
719 int ioengine_load(struct thread_data *td)
724 * Engine has already been loaded.
729 engine = get_engine_name(td->o.ioengine);
730 td->io_ops = load_ioengine(td, engine);
732 log_err("fio: failed to load engine %s\n", engine);
736 if (td->io_ops->option_struct_size && td->io_ops->options) {
738 * In cases where td->eo is set, clone it for a child thread.
739 * This requires that the parent thread has the same ioengine,
740 * but that requirement must be enforced by the code which
743 void *origeo = td->eo;
745 * Otherwise use the default thread options.
747 if (!origeo && td != &def_thread && def_thread.eo &&
748 def_thread.io_ops->options == td->io_ops->options)
749 origeo = def_thread.eo;
751 options_init(td->io_ops->options);
752 td->eo = malloc(td->io_ops->option_struct_size);
754 * Use the default thread as an option template if this uses the
755 * same options structure and there are non-default options
759 memcpy(td->eo, origeo, td->io_ops->option_struct_size);
760 options_mem_dupe(td->eo, td->io_ops->options);
762 memset(td->eo, 0, td->io_ops->option_struct_size);
763 fill_default_options(td->eo, td->io_ops->options);
765 *(struct thread_data **)td->eo = td;
771 static void init_flags(struct thread_data *td)
773 struct thread_options *o = &td->o;
775 if (o->verify_backlog)
776 td->flags |= TD_F_VER_BACKLOG;
778 td->flags |= TD_F_TRIM_BACKLOG;
779 if (o->read_iolog_file)
780 td->flags |= TD_F_READ_IOLOG;
781 if (o->refill_buffers)
782 td->flags |= TD_F_REFILL_BUFFERS;
783 if (o->scramble_buffers)
784 td->flags |= TD_F_SCRAMBLE_BUFFERS;
785 if (o->verify != VERIFY_NONE)
786 td->flags |= TD_F_VER_NONE;
789 static int setup_random_seeds(struct thread_data *td)
794 if (!td->o.rand_repeatable)
795 return init_random_state(td, td->rand_seeds, sizeof(td->rand_seeds));
797 for (seed = 0x89, i = 0; i < 4; i++)
798 seed *= 0x9e370001UL;
800 for (i = 0; i < FIO_RAND_NR_OFFS; i++) {
801 td->rand_seeds[i] = seed;
802 seed *= 0x9e370001UL;
805 td_fill_rand_seeds(td);
810 * Adds a job to the list of things todo. Sanitizes the various options
811 * to make sure we don't have conflicts, and initializes various
814 static int add_job(struct thread_data *td, const char *jobname, int job_add_num)
816 const char *ddir_str[] = { NULL, "read", "write", "rw", NULL,
817 "randread", "randwrite", "randrw",
818 "trim", NULL, NULL, NULL, "randtrim" };
820 char fname[PATH_MAX];
821 int numjobs, file_alloced;
824 * the def_thread is just for options, it's not a real job
826 if (td == &def_thread)
832 * if we are just dumping the output command line, don't add the job
839 if (profile_td_init(td))
842 if (ioengine_load(td))
845 if (td->o.use_thread)
851 td->io_ops->flags |= FIO_RAWIO;
854 if (!td->o.filename && !td->files_index && !td->o.read_iolog_file) {
857 if (td->o.nr_files == 1 && exists_and_not_file(jobname))
858 add_file(td, jobname);
860 for (i = 0; i < td->o.nr_files; i++) {
861 sprintf(fname, "%s.%d.%d", jobname,
862 td->thread_number, i);
868 if (fixup_options(td))
874 * IO engines only need this for option callbacks, and the address may
875 * change in subprocesses.
878 *(struct thread_data **)td->eo = NULL;
880 if (td->io_ops->flags & FIO_DISKLESSIO) {
883 for_each_file(td, f, i)
884 f->real_file_size = -1ULL;
887 td->mutex = fio_mutex_init(FIO_MUTEX_LOCKED);
889 td->ts.clat_percentiles = td->o.clat_percentiles;
890 if (td->o.overwrite_plist)
891 memcpy(td->ts.percentile_list, td->o.percentile_list, sizeof(td->o.percentile_list));
893 memcpy(td->ts.percentile_list, def_percentile_list, sizeof(def_percentile_list));
895 for (i = 0; i < DDIR_RWDIR_CNT; i++) {
896 td->ts.clat_stat[i].min_val = ULONG_MAX;
897 td->ts.slat_stat[i].min_val = ULONG_MAX;
898 td->ts.lat_stat[i].min_val = ULONG_MAX;
899 td->ts.bw_stat[i].min_val = ULONG_MAX;
901 td->ddir_seq_nr = td->o.ddir_seq_nr;
903 if ((td->o.stonewall || td->o.new_group) && prev_group_jobs) {
908 td->groupid = groupid;
911 if (setup_random_seeds(td)) {
912 td_verror(td, errno, "init_random_state");
919 if (td->o.write_lat_log) {
920 setup_log(&td->lat_log, td->o.log_avg_msec);
921 setup_log(&td->slat_log, td->o.log_avg_msec);
922 setup_log(&td->clat_log, td->o.log_avg_msec);
924 if (td->o.write_bw_log)
925 setup_log(&td->bw_log, td->o.log_avg_msec);
926 if (td->o.write_iops_log)
927 setup_log(&td->iops_log, td->o.log_avg_msec);
930 td->o.name = strdup(jobname);
932 if (output_format == FIO_OUTPUT_NORMAL) {
934 if (!strcmp(td->io_ops->name, "cpuio")) {
935 log_info("%s: ioengine=cpu, cpuload=%u,"
936 " cpucycle=%u\n", td->o.name,
940 char *c1, *c2, *c3, *c4, *c5, *c6;
942 c1 = to_kmg(td->o.min_bs[DDIR_READ]);
943 c2 = to_kmg(td->o.max_bs[DDIR_READ]);
944 c3 = to_kmg(td->o.min_bs[DDIR_WRITE]);
945 c4 = to_kmg(td->o.max_bs[DDIR_WRITE]);
946 c5 = to_kmg(td->o.min_bs[DDIR_TRIM]);
947 c6 = to_kmg(td->o.max_bs[DDIR_TRIM]);
949 log_info("%s: (g=%d): rw=%s, bs=%s-%s/%s-%s/%s-%s,"
950 " ioengine=%s, iodepth=%u\n",
951 td->o.name, td->groupid,
952 ddir_str[td->o.td_ddir],
953 c1, c2, c3, c4, c5, c6,
964 } else if (job_add_num == 1)
969 * recurse add identical jobs, clear numjobs and stonewall options
970 * as they don't apply to sub-jobs
972 numjobs = td->o.numjobs;
974 struct thread_data *td_new = get_new_job(0, td, 1);
979 td_new->o.numjobs = 1;
980 td_new->o.stonewall = 0;
981 td_new->o.new_group = 0;
984 td_new->o.filename = NULL;
985 td_new->files_index = 0;
986 td_new->files_size = 0;
987 td_new->files = NULL;
990 job_add_num = numjobs - 1;
992 if (add_job(td_new, jobname, job_add_num))
1003 * Parse as if 'o' was a command line
1005 void add_job_opts(const char **o)
1007 struct thread_data *td, *td_parent;
1008 int i, in_global = 1;
1012 td_parent = td = NULL;
1014 if (!strncmp(o[i], "name", 4)) {
1017 add_job(td, jobname, 0);
1019 sprintf(jobname, "%s", o[i] + 5);
1021 if (in_global && !td_parent)
1022 td_parent = get_new_job(1, &def_thread, 0);
1023 else if (!in_global && !td) {
1025 td_parent = &def_thread;
1026 td = get_new_job(0, td_parent, 0);
1029 fio_options_parse(td_parent, (char **) &o[i], 1);
1031 fio_options_parse(td, (char **) &o[i], 1);
1036 add_job(td, jobname, 0);
1039 static int skip_this_section(const char *name)
1043 if (!nr_job_sections)
1045 if (!strncmp(name, "global", 6))
1048 for (i = 0; i < nr_job_sections; i++)
1049 if (!strcmp(job_sections[i], name))
1055 static int is_empty_or_comment(char *line)
1059 for (i = 0; i < strlen(line); i++) {
1064 if (!isspace((int) line[i]) && !iscntrl((int) line[i]))
1072 * This is our [ini] type file parser.
1074 int parse_jobs_ini(char *file, int is_buf, int stonewall_flag)
1076 unsigned int global;
1077 struct thread_data *td;
1078 char *string, *name;
1081 int ret = 0, stonewall;
1084 int inside_skip = 0;
1086 int i, alloc_opts, num_opts;
1091 if (!strcmp(file, "-"))
1094 f = fopen(file, "r");
1097 perror("fopen job file");
1102 string = malloc(4096);
1105 * it's really 256 + small bit, 280 should suffice
1108 memset(name, 0, 280);
1111 opts = malloc(sizeof(char *) * alloc_opts);
1114 stonewall = stonewall_flag;
1117 * if skip_fgets is set, we already have loaded a line we
1122 p = strsep(&file, "\n");
1124 p = fgets(string, 4096, f);
1130 strip_blank_front(&p);
1133 if (is_empty_or_comment(p))
1135 if (sscanf(p, "[%255[^\n]]", name) != 1) {
1138 log_err("fio: option <%s> outside of [] job section\n",
1143 name[strlen(name) - 1] = '\0';
1145 if (skip_this_section(name)) {
1151 global = !strncmp(name, "global", 6);
1157 log_info("--name=%s ", name);
1161 td = get_new_job(global, &def_thread, 0);
1168 * Seperate multiple job files by a stonewall
1170 if (!global && stonewall) {
1171 td->o.stonewall = stonewall;
1176 memset(opts, 0, alloc_opts * sizeof(char *));
1180 p = strsep(&file, "\n");
1182 p = fgets(string, 4096, f);
1186 if (is_empty_or_comment(p))
1189 strip_blank_front(&p);
1192 * new section, break out and make sure we don't
1193 * fgets() a new line at the top.
1202 if (num_opts == alloc_opts) {
1204 opts = realloc(opts,
1205 alloc_opts * sizeof(char *));
1208 opts[num_opts] = strdup(p);
1212 ret = fio_options_parse(td, opts, num_opts);
1215 for (i = 0; i < num_opts; i++)
1216 log_info("--%s ", opts[i]);
1218 ret = add_job(td, name, 0);
1220 log_err("fio: job %s dropped\n", name);
1224 for (i = 0; i < num_opts; i++)
1233 while (i < nr_job_sections) {
1234 free(job_sections[i]);
1238 for (i = 0; i < num_opts; i++)
1244 if (!is_buf && f != stdin)
1249 static int fill_def_thread(void)
1251 memset(&def_thread, 0, sizeof(def_thread));
1253 fio_getaffinity(getpid(), &def_thread.o.cpumask);
1254 def_thread.o.timeout = def_timeout;
1255 def_thread.o.error_dump = 1;
1257 * fill default options
1259 fio_fill_default_options(&def_thread);
1263 static void usage(const char *name)
1265 printf("%s\n", fio_version_string);
1266 printf("%s [options] [job options] <job file(s)>\n", name);
1267 printf(" --debug=options\tEnable debug logging. May be one/more of:\n"
1268 "\t\t\tprocess,file,io,mem,blktrace,verify,random,parse,\n"
1269 "\t\t\tdiskutil,job,mutex,profile,time,net\n");
1270 printf(" --output\t\tWrite output to file\n");
1271 printf(" --runtime\t\tRuntime in seconds\n");
1272 printf(" --latency-log\t\tGenerate per-job latency logs\n");
1273 printf(" --bandwidth-log\tGenerate per-job bandwidth logs\n");
1274 printf(" --minimal\t\tMinimal (terse) output\n");
1275 printf(" --output-format=x\tOutput format (terse,json,normal)\n");
1276 printf(" --terse-version=x\tSet terse version output format to 'x'\n");
1277 printf(" --version\t\tPrint version info and exit\n");
1278 printf(" --help\t\tPrint this page\n");
1279 printf(" --cpuclock-test\tPerform test/validation of CPU clock\n");
1280 printf(" --cmdhelp=cmd\t\tPrint command help, \"all\" for all of"
1282 printf(" --enghelp=engine\tPrint ioengine help, or list"
1283 " available ioengines\n");
1284 printf(" --enghelp=engine,cmd\tPrint help for an ioengine"
1286 printf(" --showcmd\t\tTurn a job file into command line options\n");
1287 printf(" --eta=when\t\tWhen ETA estimate should be printed\n");
1288 printf(" \t\tMay be \"always\", \"never\" or \"auto\"\n");
1289 printf(" --readonly\t\tTurn on safety read-only checks, preventing"
1291 printf(" --section=name\tOnly run specified section in job file\n");
1292 printf(" --alloc-size=kb\tSet smalloc pool to this size in kb"
1294 printf(" --warnings-fatal\tFio parser warnings are fatal\n");
1295 printf(" --max-jobs=nr\t\tMaximum number of threads/processes to support\n");
1296 printf(" --server=args\t\tStart a backend fio server\n");
1297 printf(" --daemonize=pidfile\tBackground fio server, write pid to file\n");
1298 printf(" --client=hostname\tTalk to remote backend fio server at hostname\n");
1299 printf(" --idle-prof=option\tReport cpu idleness on a system or percpu basis\n"
1300 "\t\t\t(option=system,percpu) or run unit work\n"
1301 "\t\t\tcalibration only (option=calibrate)\n");
1302 printf("\nFio was written by Jens Axboe <jens.axboe@oracle.com>");
1303 printf("\n Jens Axboe <jaxboe@fusionio.com>\n");
1306 #ifdef FIO_INC_DEBUG
1307 struct debug_level debug_levels[] = {
1308 { .name = "process", .shift = FD_PROCESS, },
1309 { .name = "file", .shift = FD_FILE, },
1310 { .name = "io", .shift = FD_IO, },
1311 { .name = "mem", .shift = FD_MEM, },
1312 { .name = "blktrace", .shift = FD_BLKTRACE },
1313 { .name = "verify", .shift = FD_VERIFY },
1314 { .name = "random", .shift = FD_RANDOM },
1315 { .name = "parse", .shift = FD_PARSE },
1316 { .name = "diskutil", .shift = FD_DISKUTIL },
1317 { .name = "job", .shift = FD_JOB },
1318 { .name = "mutex", .shift = FD_MUTEX },
1319 { .name = "profile", .shift = FD_PROFILE },
1320 { .name = "time", .shift = FD_TIME },
1321 { .name = "net", .shift = FD_NET },
1325 static int set_debug(const char *string)
1327 struct debug_level *dl;
1328 char *p = (char *) string;
1332 if (!strcmp(string, "?") || !strcmp(string, "help")) {
1333 log_info("fio: dumping debug options:");
1334 for (i = 0; debug_levels[i].name; i++) {
1335 dl = &debug_levels[i];
1336 log_info("%s,", dl->name);
1342 while ((opt = strsep(&p, ",")) != NULL) {
1345 if (!strncmp(opt, "all", 3)) {
1346 log_info("fio: set all debug options\n");
1351 for (i = 0; debug_levels[i].name; i++) {
1352 dl = &debug_levels[i];
1353 found = !strncmp(opt, dl->name, strlen(dl->name));
1357 if (dl->shift == FD_JOB) {
1358 opt = strchr(opt, ':');
1360 log_err("fio: missing job number\n");
1364 fio_debug_jobno = atoi(opt);
1365 log_info("fio: set debug jobno %d\n",
1368 log_info("fio: set debug option %s\n", opt);
1369 fio_debug |= (1UL << dl->shift);
1375 log_err("fio: debug mask %s not found\n", opt);
1380 static int set_debug(const char *string)
1382 log_err("fio: debug tracing not included in build\n");
1387 static void fio_options_fill_optstring(void)
1389 char *ostr = cmd_optstr;
1393 while (l_opts[i].name) {
1394 ostr[c++] = l_opts[i].val;
1395 if (l_opts[i].has_arg == required_argument)
1397 else if (l_opts[i].has_arg == optional_argument) {
1406 static int client_flag_set(char c)
1411 while (l_opts[i].name) {
1412 int val = l_opts[i].val;
1414 if (c == (val & 0xff))
1415 return (val & FIO_CLIENT_FLAG);
1423 void parse_cmd_client(void *client, char *opt)
1425 fio_client_add_cmd_option(client, opt);
1428 int parse_cmd_line(int argc, char *argv[])
1430 struct thread_data *td = NULL;
1431 int c, ini_idx = 0, lidx, ret = 0, do_exit = 0, exit_val = 0;
1432 char *ostr = cmd_optstr;
1433 void *pid_file = NULL;
1434 void *cur_client = NULL;
1438 * Reset optind handling, since we may call this multiple times
1443 while ((c = getopt_long_only(argc, argv, ostr, l_opts, &lidx)) != -1) {
1446 if ((c & FIO_CLIENT_FLAG) || client_flag_set(c)) {
1447 parse_cmd_client(cur_client, argv[optind - 1]);
1448 c &= ~FIO_CLIENT_FLAG;
1453 smalloc_pool_size = atoi(optarg);
1456 def_timeout = atoi(optarg);
1465 f_out = fopen(optarg, "w+");
1467 perror("fopen output");
1473 output_format = FIO_OUTPUT_TERSE;
1476 if (!strcmp(optarg, "minimal") ||
1477 !strcmp(optarg, "terse") ||
1478 !strcmp(optarg, "csv"))
1479 output_format = FIO_OUTPUT_TERSE;
1480 else if (!strcmp(optarg, "json"))
1481 output_format = FIO_OUTPUT_JSON;
1483 output_format = FIO_OUTPUT_NORMAL;
1493 fio_show_option_help(optarg);
1499 fio_show_ioengine_help(optarg);
1511 log_info("%s\n", fio_version_string);
1516 terse_version = atoi(optarg);
1517 if (!(terse_version == 2 || terse_version == 3 ||
1518 terse_version == 4)) {
1519 log_err("fio: bad terse version format\n");
1525 if (!strcmp("always", optarg))
1526 eta_print = FIO_ETA_ALWAYS;
1527 else if (!strcmp("never", optarg))
1528 eta_print = FIO_ETA_NEVER;
1531 if (set_debug(optarg))
1537 if (!strcmp(optarg, "global")) {
1538 log_err("fio: can't use global as only "
1544 new_size = (nr_job_sections + 1) * sizeof(char *);
1545 job_sections = realloc(job_sections, new_size);
1546 job_sections[nr_job_sections] = strdup(optarg);
1551 exec_profile = strdup(optarg);
1553 case FIO_GETOPT_JOB: {
1554 const char *opt = l_opts[lidx].name;
1557 if (!strncmp(opt, "name", 4) && td) {
1558 ret = add_job(td, td->o.name ?: "fio", 0);
1564 int is_section = !strncmp(opt, "name", 4);
1567 if (!is_section || !strncmp(val, "global", 6))
1570 if (is_section && skip_this_section(val))
1573 td = get_new_job(global, &def_thread, 1);
1574 if (!td || ioengine_load(td))
1576 fio_options_set_ioengine_opts(l_opts, td);
1579 ret = fio_cmd_option_parse(td, opt, val);
1581 if (!ret && !strcmp(opt, "ioengine")) {
1583 if (ioengine_load(td))
1585 fio_options_set_ioengine_opts(l_opts, td);
1589 case FIO_GETOPT_IOENGINE: {
1590 const char *opt = l_opts[lidx].name;
1592 opt = l_opts[lidx].name;
1594 ret = fio_cmd_ioengine_option_parse(td, opt, val);
1601 max_jobs = atoi(optarg);
1602 if (!max_jobs || max_jobs > REAL_MAX_JOBS) {
1603 log_err("fio: invalid max jobs: %d\n", max_jobs);
1610 log_err("fio: can't be both client and server\n");
1616 fio_server_set_arg(optarg);
1621 pid_file = strdup(optarg);
1624 if ((ret = fio_idle_prof_parse_opt(optarg))) {
1625 /* exit on error and calibration only */
1633 log_err("fio: can't be both client and server\n");
1638 if (fio_client_add(optarg, &cur_client)) {
1639 log_err("fio: failed adding client %s\n", optarg);
1645 * If the next argument exists and isn't an option,
1646 * assume it's a job file for this client only.
1648 while (optind < argc) {
1649 if (!strncmp(argv[optind], "--", 2) ||
1650 !strncmp(argv[optind], "-", 1))
1653 fio_client_add_ini_file(cur_client, argv[optind]);
1659 exit_val = fio_monotonic_clocktest();
1662 log_err("%s: unrecognized option '%s'\n", argv[0],
1674 if (exit_val && !(is_backend || nr_clients))
1678 if (nr_clients && fio_clients_connect()) {
1684 if (is_backend && backend)
1685 return fio_start_server(pid_file);
1689 ret = add_job(td, td->o.name ?: "fio", 0);
1692 while (!ret && optind < argc) {
1694 ini_file = realloc(ini_file, ini_idx * sizeof(char *));
1695 ini_file[ini_idx - 1] = strdup(argv[optind]);
1702 int parse_options(int argc, char *argv[])
1709 fio_options_fill_optstring();
1710 fio_options_dup_and_init(l_opts);
1714 if (fill_def_thread())
1717 job_files = parse_cmd_line(argc, argv);
1719 if (job_files > 0) {
1720 for (i = 0; i < job_files; i++) {
1721 if (fill_def_thread())
1724 if (fio_clients_send_ini(ini_file[i]))
1727 } else if (!is_backend) {
1728 if (parse_jobs_ini(ini_file[i], 0, i))
1733 } else if (nr_clients) {
1734 if (fill_def_thread())
1736 if (fio_clients_send_ini(NULL))
1741 fio_options_free(&def_thread);
1743 if (!thread_number) {
1748 if (is_backend || nr_clients)
1753 log_err("No jobs(s) defined\n\n");
1763 if (def_thread.o.gtod_offload) {
1765 fio_gtod_offload = 1;
1766 fio_gtod_cpu = def_thread.o.gtod_cpu;
1769 if (output_format == FIO_OUTPUT_NORMAL)
1770 log_info("%s\n", fio_version_string);