2 * This file contains job initialization and setup functions.
12 #include <sys/types.h>
16 #ifndef FIO_NO_HAVE_SHM_H
28 #include "lib/getopt.h"
30 const char fio_version_string[] = FIO_VERSION;
32 #define FIO_RANDSEED (0xb1899bedUL)
34 static char **ini_file;
35 static int max_jobs = FIO_MAX_JOBS;
36 static int dump_cmdline;
37 static int def_timeout;
38 static int parse_only;
40 static struct thread_data def_thread;
41 struct thread_data *threads = NULL;
43 int exitall_on_terminate = 0;
44 int output_format = FIO_OUTPUT_NORMAL;
45 int eta_print = FIO_ETA_AUTO;
47 unsigned long long mlock_size = 0;
50 char **job_sections = NULL;
51 int nr_job_sections = 0;
52 char *exec_profile = NULL;
53 int warnings_fatal = 0;
54 int terse_version = 3;
62 static int write_lat_log;
64 static int prev_group_jobs;
66 unsigned long fio_debug = 0;
67 unsigned int fio_debug_jobno = -1;
68 unsigned int *fio_debug_jobp = NULL;
70 static char cmd_optstr[256];
73 #define FIO_CLIENT_FLAG (1 << 16)
76 * Command line options. These will contain the above, plus a few
77 * extra that only pertain to fio itself and not jobs.
79 static struct option l_opts[FIO_NR_OPTIONS] = {
81 .name = (char *) "output",
82 .has_arg = required_argument,
83 .val = 'o' | FIO_CLIENT_FLAG,
86 .name = (char *) "timeout",
87 .has_arg = required_argument,
88 .val = 't' | FIO_CLIENT_FLAG,
91 .name = (char *) "latency-log",
92 .has_arg = required_argument,
93 .val = 'l' | FIO_CLIENT_FLAG,
96 .name = (char *) "bandwidth-log",
97 .has_arg = required_argument,
98 .val = 'b' | FIO_CLIENT_FLAG,
101 .name = (char *) "minimal",
102 .has_arg = optional_argument,
103 .val = 'm' | FIO_CLIENT_FLAG,
106 .name = (char *) "output-format",
107 .has_arg = optional_argument,
108 .val = 'F' | FIO_CLIENT_FLAG,
111 .name = (char *) "version",
112 .has_arg = no_argument,
113 .val = 'v' | FIO_CLIENT_FLAG,
116 .name = (char *) "help",
117 .has_arg = no_argument,
118 .val = 'h' | FIO_CLIENT_FLAG,
121 .name = (char *) "cmdhelp",
122 .has_arg = optional_argument,
123 .val = 'c' | FIO_CLIENT_FLAG,
126 .name = (char *) "enghelp",
127 .has_arg = optional_argument,
128 .val = 'i' | FIO_CLIENT_FLAG,
131 .name = (char *) "showcmd",
132 .has_arg = no_argument,
133 .val = 's' | FIO_CLIENT_FLAG,
136 .name = (char *) "readonly",
137 .has_arg = no_argument,
138 .val = 'r' | FIO_CLIENT_FLAG,
141 .name = (char *) "eta",
142 .has_arg = required_argument,
143 .val = 'e' | FIO_CLIENT_FLAG,
146 .name = (char *) "eta-newline",
147 .has_arg = required_argument,
148 .val = 'E' | FIO_CLIENT_FLAG,
151 .name = (char *) "debug",
152 .has_arg = required_argument,
153 .val = 'd' | FIO_CLIENT_FLAG,
156 .name = (char *) "parse-only",
157 .has_arg = no_argument,
158 .val = 'P' | FIO_CLIENT_FLAG,
161 .name = (char *) "section",
162 .has_arg = required_argument,
163 .val = 'x' | FIO_CLIENT_FLAG,
166 .name = (char *) "alloc-size",
167 .has_arg = required_argument,
168 .val = 'a' | FIO_CLIENT_FLAG,
171 .name = (char *) "profile",
172 .has_arg = required_argument,
173 .val = 'p' | FIO_CLIENT_FLAG,
176 .name = (char *) "warnings-fatal",
177 .has_arg = no_argument,
178 .val = 'w' | FIO_CLIENT_FLAG,
181 .name = (char *) "max-jobs",
182 .has_arg = required_argument,
183 .val = 'j' | FIO_CLIENT_FLAG,
186 .name = (char *) "terse-version",
187 .has_arg = required_argument,
188 .val = 'V' | FIO_CLIENT_FLAG,
191 .name = (char *) "server",
192 .has_arg = optional_argument,
195 { .name = (char *) "daemonize",
196 .has_arg = required_argument,
200 .name = (char *) "client",
201 .has_arg = required_argument,
205 .name = (char *) "cpuclock-test",
206 .has_arg = no_argument,
210 .name = (char *) "idle-prof",
211 .has_arg = required_argument,
219 void free_threads_shm(void)
221 struct shmid_ds sbuf;
228 shmctl(shm_id, IPC_RMID, &sbuf);
238 fio_debug_jobp = NULL;
246 * The thread area is shared between the main process and the job
247 * threads/processes. So setup a shared memory segment that will hold
248 * all the job info. We use the end of the region for keeping track of
249 * open files across jobs, for file sharing.
251 static int setup_thread_area(void)
259 * 1024 is too much on some machines, scale max_jobs if
260 * we get a failure that looks like too large a shm segment
263 size_t size = max_jobs * sizeof(struct thread_data);
265 size += file_hash_size;
266 size += sizeof(unsigned int);
268 shm_id = shmget(0, size, IPC_CREAT | 0600);
271 if (errno != EINVAL && errno != ENOMEM && errno != ENOSPC) {
282 threads = shmat(shm_id, NULL, 0);
283 if (threads == (void *) -1) {
288 memset(threads, 0, max_jobs * sizeof(struct thread_data));
289 hash = (void *) threads + max_jobs * sizeof(struct thread_data);
290 fio_debug_jobp = (void *) hash + file_hash_size;
291 *fio_debug_jobp = -1;
292 file_hash_init(hash);
300 * Return a free job structure.
302 static struct thread_data *get_new_job(int global, struct thread_data *parent,
305 struct thread_data *td;
309 if (setup_thread_area()) {
310 log_err("error: failed to setup shm segment\n");
313 if (thread_number >= max_jobs) {
314 log_err("error: maximum number of jobs (%d) reached.\n",
319 td = &threads[thread_number++];
326 td->o.uid = td->o.gid = -1U;
328 dup_files(td, parent);
329 fio_options_mem_dupe(td);
331 profile_add_hooks(td);
333 td->thread_number = thread_number;
335 if (!parent || !parent->o.group_reporting)
341 static void put_job(struct thread_data *td)
343 if (td == &def_thread)
350 log_info("fio: %s\n", td->verror);
352 fio_options_free(td);
356 memset(&threads[td->thread_number - 1], 0, sizeof(*td));
360 static int __setup_rate(struct thread_data *td, enum fio_ddir ddir)
362 unsigned int bs = td->o.min_bs[ddir];
364 assert(ddir_rw(ddir));
366 if (td->o.rate[ddir])
367 td->rate_bps[ddir] = td->o.rate[ddir];
369 td->rate_bps[ddir] = td->o.rate_iops[ddir] * bs;
371 if (!td->rate_bps[ddir]) {
372 log_err("rate lower than supported\n");
376 td->rate_pending_usleep[ddir] = 0;
380 static int setup_rate(struct thread_data *td)
384 if (td->o.rate[DDIR_READ] || td->o.rate_iops[DDIR_READ])
385 ret = __setup_rate(td, DDIR_READ);
386 if (td->o.rate[DDIR_WRITE] || td->o.rate_iops[DDIR_WRITE])
387 ret |= __setup_rate(td, DDIR_WRITE);
388 if (td->o.rate[DDIR_TRIM] || td->o.rate_iops[DDIR_TRIM])
389 ret |= __setup_rate(td, DDIR_TRIM);
394 static int fixed_block_size(struct thread_options *o)
396 return o->min_bs[DDIR_READ] == o->max_bs[DDIR_READ] &&
397 o->min_bs[DDIR_WRITE] == o->max_bs[DDIR_WRITE] &&
398 o->min_bs[DDIR_TRIM] == o->max_bs[DDIR_TRIM] &&
399 o->min_bs[DDIR_READ] == o->min_bs[DDIR_WRITE] &&
400 o->min_bs[DDIR_READ] == o->min_bs[DDIR_TRIM];
404 * Lazy way of fixing up options that depend on each other. We could also
405 * define option callback handlers, but this is easier.
407 static int fixup_options(struct thread_data *td)
409 struct thread_options *o = &td->o;
412 #ifndef FIO_HAVE_PSHARED_MUTEX
413 if (!o->use_thread) {
414 log_info("fio: this platform does not support process shared"
415 " mutexes, forcing use of threads. Use the 'thread'"
416 " option to get rid of this warning.\n");
418 ret = warnings_fatal;
422 if (o->write_iolog_file && o->read_iolog_file) {
423 log_err("fio: read iolog overrides write_iolog\n");
424 free(o->write_iolog_file);
425 o->write_iolog_file = NULL;
426 ret = warnings_fatal;
430 * only really works with 1 file
432 if (o->zone_size && o->open_files > 1)
436 * If zone_range isn't specified, backward compatibility dictates it
437 * should be made equal to zone_size.
439 if (o->zone_size && !o->zone_range)
440 o->zone_range = o->zone_size;
443 * Reads can do overwrites, we always need to pre-create the file
445 if (td_read(td) || td_rw(td))
448 if (!o->min_bs[DDIR_READ])
449 o->min_bs[DDIR_READ] = o->bs[DDIR_READ];
450 if (!o->max_bs[DDIR_READ])
451 o->max_bs[DDIR_READ] = o->bs[DDIR_READ];
452 if (!o->min_bs[DDIR_WRITE])
453 o->min_bs[DDIR_WRITE] = o->bs[DDIR_WRITE];
454 if (!o->max_bs[DDIR_WRITE])
455 o->max_bs[DDIR_WRITE] = o->bs[DDIR_WRITE];
456 if (!o->min_bs[DDIR_TRIM])
457 o->min_bs[DDIR_TRIM] = o->bs[DDIR_TRIM];
458 if (!o->max_bs[DDIR_TRIM])
459 o->max_bs[DDIR_TRIM] = o->bs[DDIR_TRIM];
462 o->rw_min_bs = min(o->min_bs[DDIR_READ], o->min_bs[DDIR_WRITE]);
463 o->rw_min_bs = min(o->min_bs[DDIR_TRIM], o->rw_min_bs);
466 * For random IO, allow blockalign offset other than min_bs.
468 if (!o->ba[DDIR_READ] || !td_random(td))
469 o->ba[DDIR_READ] = o->min_bs[DDIR_READ];
470 if (!o->ba[DDIR_WRITE] || !td_random(td))
471 o->ba[DDIR_WRITE] = o->min_bs[DDIR_WRITE];
472 if (!o->ba[DDIR_TRIM] || !td_random(td))
473 o->ba[DDIR_TRIM] = o->min_bs[DDIR_TRIM];
475 if ((o->ba[DDIR_READ] != o->min_bs[DDIR_READ] ||
476 o->ba[DDIR_WRITE] != o->min_bs[DDIR_WRITE] ||
477 o->ba[DDIR_TRIM] != o->min_bs[DDIR_TRIM]) &&
479 log_err("fio: Any use of blockalign= turns off randommap\n");
481 ret = warnings_fatal;
484 if (!o->file_size_high)
485 o->file_size_high = o->file_size_low;
487 if (o->norandommap && o->verify != VERIFY_NONE
488 && !fixed_block_size(o)) {
489 log_err("fio: norandommap given for variable block sizes, "
490 "verify disabled\n");
491 o->verify = VERIFY_NONE;
492 ret = warnings_fatal;
494 if (o->bs_unaligned && (o->odirect || td->io_ops->flags & FIO_RAWIO))
495 log_err("fio: bs_unaligned may not work with raw io\n");
498 * thinktime_spin must be less than thinktime
500 if (o->thinktime_spin > o->thinktime)
501 o->thinktime_spin = o->thinktime;
504 * The low water mark cannot be bigger than the iodepth
506 if (o->iodepth_low > o->iodepth || !o->iodepth_low)
507 o->iodepth_low = o->iodepth;
510 * If batch number isn't set, default to the same as iodepth
512 if (o->iodepth_batch > o->iodepth || !o->iodepth_batch)
513 o->iodepth_batch = o->iodepth;
515 if (o->nr_files > td->files_index)
516 o->nr_files = td->files_index;
518 if (o->open_files > o->nr_files || !o->open_files)
519 o->open_files = o->nr_files;
521 if (((o->rate[DDIR_READ] + o->rate[DDIR_WRITE] + o->rate[DDIR_TRIM]) &&
522 (o->rate_iops[DDIR_READ] + o->rate_iops[DDIR_WRITE] + o->rate_iops[DDIR_TRIM])) ||
523 ((o->ratemin[DDIR_READ] + o->ratemin[DDIR_WRITE] + o->ratemin[DDIR_TRIM]) &&
524 (o->rate_iops_min[DDIR_READ] + o->rate_iops_min[DDIR_WRITE] + o->rate_iops_min[DDIR_TRIM]))) {
525 log_err("fio: rate and rate_iops are mutually exclusive\n");
528 if ((o->rate[DDIR_READ] < o->ratemin[DDIR_READ]) ||
529 (o->rate[DDIR_WRITE] < o->ratemin[DDIR_WRITE]) ||
530 (o->rate[DDIR_TRIM] < o->ratemin[DDIR_TRIM]) ||
531 (o->rate_iops[DDIR_READ] < o->rate_iops_min[DDIR_READ]) ||
532 (o->rate_iops[DDIR_WRITE] < o->rate_iops_min[DDIR_WRITE]) ||
533 (o->rate_iops[DDIR_TRIM] < o->rate_iops_min[DDIR_TRIM])) {
534 log_err("fio: minimum rate exceeds rate\n");
538 if (!o->timeout && o->time_based) {
539 log_err("fio: time_based requires a runtime/timeout setting\n");
541 ret = warnings_fatal;
544 if (o->fill_device && !o->size)
547 if (o->verify != VERIFY_NONE) {
548 if (td_write(td) && o->do_verify && o->numjobs > 1) {
549 log_info("Multiple writers may overwrite blocks that "
550 "belong to other jobs. This can cause "
551 "verification failures.\n");
552 ret = warnings_fatal;
555 o->refill_buffers = 1;
556 if (o->max_bs[DDIR_WRITE] != o->min_bs[DDIR_WRITE] &&
558 o->verify_interval = o->min_bs[DDIR_WRITE];
562 o->invalidate_cache = 0;
563 if (td->io_ops->flags & FIO_PIPEIO) {
564 log_info("fio: cannot pre-read files with an IO engine"
565 " that isn't seekable. Pre-read disabled.\n");
566 ret = warnings_fatal;
570 #ifndef CONFIG_FDATASYNC
571 if (o->fdatasync_blocks) {
572 log_info("fio: this platform does not support fdatasync()"
573 " falling back to using fsync(). Use the 'fsync'"
574 " option instead of 'fdatasync' to get rid of"
576 o->fsync_blocks = o->fdatasync_blocks;
577 o->fdatasync_blocks = 0;
578 ret = warnings_fatal;
584 * Windows doesn't support O_DIRECT or O_SYNC with the _open interface,
585 * so fail if we're passed those flags
587 if ((td->io_ops->flags & FIO_SYNCIO) && (td->o.odirect || td->o.sync_io)) {
588 log_err("fio: Windows does not support direct or non-buffered io with"
589 " the synchronous ioengines. Use the 'windowsaio' ioengine"
590 " with 'direct=1' and 'iodepth=1' instead.\n");
596 * For fully compressible data, just zero them at init time.
597 * It's faster than repeatedly filling it.
599 if (td->o.compress_percentage == 100) {
600 td->o.zero_buffers = 1;
601 td->o.compress_percentage = 0;
605 * Using a non-uniform random distribution excludes usage of
608 if (td->o.random_distribution != FIO_RAND_DIST_RANDOM)
609 td->o.norandommap = 1;
615 * This function leaks the buffer
617 char *fio_uint_to_kmg(unsigned int val)
619 char *buf = malloc(32);
620 char post[] = { 0, 'K', 'M', 'G', 'P', 'E', 0 };
631 snprintf(buf, 32, "%u%c", val, *p);
635 /* External engines are specified by "external:name.o") */
636 static const char *get_engine_name(const char *str)
638 char *p = strstr(str, ":");
644 strip_blank_front(&p);
649 static int exists_and_not_file(const char *filename)
653 if (lstat(filename, &sb) == -1)
656 /* \\.\ is the device namespace in Windows, where every file
657 * is a device node */
658 if (S_ISREG(sb.st_mode) && strncmp(filename, "\\\\.\\", 4) != 0)
664 static void td_fill_rand_seeds_os(struct thread_data *td)
666 os_random_seed(td->rand_seeds[FIO_RAND_BS_OFF], &td->bsrange_state);
667 os_random_seed(td->rand_seeds[FIO_RAND_VER_OFF], &td->verify_state);
668 os_random_seed(td->rand_seeds[FIO_RAND_MIX_OFF], &td->rwmix_state);
670 if (td->o.file_service_type == FIO_FSERVICE_RANDOM)
671 os_random_seed(td->rand_seeds[FIO_RAND_FILE_OFF], &td->next_file_state);
673 os_random_seed(td->rand_seeds[FIO_RAND_FILE_SIZE_OFF], &td->file_size_state);
674 os_random_seed(td->rand_seeds[FIO_RAND_TRIM_OFF], &td->trim_state);
679 if (td->o.rand_repeatable)
680 td->rand_seeds[FIO_RAND_BLOCK_OFF] = FIO_RANDSEED * td->thread_number;
682 os_random_seed(td->rand_seeds[FIO_RAND_BLOCK_OFF], &td->random_state);
685 static void td_fill_rand_seeds_internal(struct thread_data *td)
687 init_rand_seed(&td->__bsrange_state, td->rand_seeds[FIO_RAND_BS_OFF]);
688 init_rand_seed(&td->__verify_state, td->rand_seeds[FIO_RAND_VER_OFF]);
689 init_rand_seed(&td->__rwmix_state, td->rand_seeds[FIO_RAND_MIX_OFF]);
691 if (td->o.file_service_type == FIO_FSERVICE_RANDOM)
692 init_rand_seed(&td->__next_file_state, td->rand_seeds[FIO_RAND_FILE_OFF]);
694 init_rand_seed(&td->__file_size_state, td->rand_seeds[FIO_RAND_FILE_SIZE_OFF]);
695 init_rand_seed(&td->__trim_state, td->rand_seeds[FIO_RAND_TRIM_OFF]);
700 if (td->o.rand_repeatable)
701 td->rand_seeds[FIO_RAND_BLOCK_OFF] = FIO_RANDSEED * td->thread_number;
703 init_rand_seed(&td->__random_state, td->rand_seeds[FIO_RAND_BLOCK_OFF]);
706 void td_fill_rand_seeds(struct thread_data *td)
708 if (td->o.use_os_rand)
709 td_fill_rand_seeds_os(td);
711 td_fill_rand_seeds_internal(td);
713 init_rand_seed(&td->buf_state, td->rand_seeds[FIO_RAND_BUF_OFF]);
717 * Initializes the ioengine configured for a job, if it has not been done so
720 int ioengine_load(struct thread_data *td)
725 * Engine has already been loaded.
730 engine = get_engine_name(td->o.ioengine);
731 td->io_ops = load_ioengine(td, engine);
733 log_err("fio: failed to load engine %s\n", engine);
737 if (td->io_ops->option_struct_size && td->io_ops->options) {
739 * In cases where td->eo is set, clone it for a child thread.
740 * This requires that the parent thread has the same ioengine,
741 * but that requirement must be enforced by the code which
744 void *origeo = td->eo;
746 * Otherwise use the default thread options.
748 if (!origeo && td != &def_thread && def_thread.eo &&
749 def_thread.io_ops->options == td->io_ops->options)
750 origeo = def_thread.eo;
752 options_init(td->io_ops->options);
753 td->eo = malloc(td->io_ops->option_struct_size);
755 * Use the default thread as an option template if this uses the
756 * same options structure and there are non-default options
760 memcpy(td->eo, origeo, td->io_ops->option_struct_size);
761 options_mem_dupe(td->eo, td->io_ops->options);
763 memset(td->eo, 0, td->io_ops->option_struct_size);
764 fill_default_options(td->eo, td->io_ops->options);
766 *(struct thread_data **)td->eo = td;
772 static void init_flags(struct thread_data *td)
774 struct thread_options *o = &td->o;
776 if (o->verify_backlog)
777 td->flags |= TD_F_VER_BACKLOG;
779 td->flags |= TD_F_TRIM_BACKLOG;
780 if (o->read_iolog_file)
781 td->flags |= TD_F_READ_IOLOG;
782 if (o->refill_buffers)
783 td->flags |= TD_F_REFILL_BUFFERS;
784 if (o->scramble_buffers)
785 td->flags |= TD_F_SCRAMBLE_BUFFERS;
786 if (o->verify != VERIFY_NONE)
787 td->flags |= TD_F_VER_NONE;
790 static int setup_random_seeds(struct thread_data *td)
795 if (!td->o.rand_repeatable)
796 return init_random_state(td, td->rand_seeds, sizeof(td->rand_seeds));
798 for (seed = 0x89, i = 0; i < 4; i++)
799 seed *= 0x9e370001UL;
801 for (i = 0; i < FIO_RAND_NR_OFFS; i++) {
802 td->rand_seeds[i] = seed;
803 seed *= 0x9e370001UL;
806 td_fill_rand_seeds(td);
811 * Adds a job to the list of things todo. Sanitizes the various options
812 * to make sure we don't have conflicts, and initializes various
815 static int add_job(struct thread_data *td, const char *jobname, int job_add_num,
816 int recursed, int client_type)
819 char fname[PATH_MAX];
820 int numjobs, file_alloced;
823 * the def_thread is just for options, it's not a real job
825 if (td == &def_thread)
831 * if we are just dumping the output command line, don't add the job
833 if (dump_cmdline || parse_only) {
838 td->client_type = client_type;
840 if (profile_td_init(td))
843 if (ioengine_load(td))
847 td->io_ops->flags |= FIO_RAWIO;
850 if (!td->o.filename && !td->files_index && !td->o.read_iolog_file) {
853 if (td->o.nr_files == 1 && exists_and_not_file(jobname))
854 add_file(td, jobname);
856 for (i = 0; i < td->o.nr_files; i++) {
857 sprintf(fname, "%s.%d.%d", jobname,
858 td->thread_number, i);
864 if (fixup_options(td))
870 * IO engines only need this for option callbacks, and the address may
871 * change in subprocesses.
874 *(struct thread_data **)td->eo = NULL;
876 if (td->io_ops->flags & FIO_DISKLESSIO) {
879 for_each_file(td, f, i)
880 f->real_file_size = -1ULL;
883 td->mutex = fio_mutex_init(FIO_MUTEX_LOCKED);
885 td->ts.clat_percentiles = td->o.clat_percentiles;
886 td->ts.percentile_precision = td->o.percentile_precision;
887 memcpy(td->ts.percentile_list, td->o.percentile_list, sizeof(td->o.percentile_list));
889 for (i = 0; i < DDIR_RWDIR_CNT; i++) {
890 td->ts.clat_stat[i].min_val = ULONG_MAX;
891 td->ts.slat_stat[i].min_val = ULONG_MAX;
892 td->ts.lat_stat[i].min_val = ULONG_MAX;
893 td->ts.bw_stat[i].min_val = ULONG_MAX;
895 td->ddir_seq_nr = td->o.ddir_seq_nr;
897 if ((td->o.stonewall || td->o.new_group) && prev_group_jobs) {
902 td->groupid = groupid;
905 if (setup_random_seeds(td)) {
906 td_verror(td, errno, "init_random_state");
913 if (td->o.lat_log_file) {
914 setup_log(&td->lat_log, td->o.log_avg_msec, IO_LOG_TYPE_LAT);
915 setup_log(&td->slat_log, td->o.log_avg_msec, IO_LOG_TYPE_SLAT);
916 setup_log(&td->clat_log, td->o.log_avg_msec, IO_LOG_TYPE_CLAT);
918 if (td->o.bw_log_file)
919 setup_log(&td->bw_log, td->o.log_avg_msec, IO_LOG_TYPE_BW);
920 if (td->o.iops_log_file)
921 setup_log(&td->iops_log, td->o.log_avg_msec, IO_LOG_TYPE_IOPS);
924 td->o.name = strdup(jobname);
926 if (output_format == FIO_OUTPUT_NORMAL) {
928 if (is_backend && !recursed)
929 fio_server_send_add_job(td);
931 if (!(td->io_ops->flags & FIO_NOIO)) {
932 char *c1, *c2, *c3, *c4, *c5, *c6;
934 c1 = fio_uint_to_kmg(td->o.min_bs[DDIR_READ]);
935 c2 = fio_uint_to_kmg(td->o.max_bs[DDIR_READ]);
936 c3 = fio_uint_to_kmg(td->o.min_bs[DDIR_WRITE]);
937 c4 = fio_uint_to_kmg(td->o.max_bs[DDIR_WRITE]);
938 c5 = fio_uint_to_kmg(td->o.min_bs[DDIR_TRIM]);
939 c6 = fio_uint_to_kmg(td->o.max_bs[DDIR_TRIM]);
941 log_info("%s: (g=%d): rw=%s, bs=%s-%s/%s-%s/%s-%s,"
942 " ioengine=%s, iodepth=%u\n",
943 td->o.name, td->groupid,
944 ddir_str(td->o.td_ddir),
945 c1, c2, c3, c4, c5, c6,
956 } else if (job_add_num == 1)
961 * recurse add identical jobs, clear numjobs and stonewall options
962 * as they don't apply to sub-jobs
964 numjobs = td->o.numjobs;
966 struct thread_data *td_new = get_new_job(0, td, 1);
971 td_new->o.numjobs = 1;
972 td_new->o.stonewall = 0;
973 td_new->o.new_group = 0;
976 td_new->o.filename = NULL;
977 td_new->files_index = 0;
978 td_new->files_size = 0;
979 td_new->files = NULL;
982 job_add_num = numjobs - 1;
984 if (add_job(td_new, jobname, job_add_num, 1, client_type))
995 * Parse as if 'o' was a command line
997 void add_job_opts(const char **o, int client_type)
999 struct thread_data *td, *td_parent;
1000 int i, in_global = 1;
1004 td_parent = td = NULL;
1006 if (!strncmp(o[i], "name", 4)) {
1009 add_job(td, jobname, 0, 0, client_type);
1011 sprintf(jobname, "%s", o[i] + 5);
1013 if (in_global && !td_parent)
1014 td_parent = get_new_job(1, &def_thread, 0);
1015 else if (!in_global && !td) {
1017 td_parent = &def_thread;
1018 td = get_new_job(0, td_parent, 0);
1021 fio_options_parse(td_parent, (char **) &o[i], 1);
1023 fio_options_parse(td, (char **) &o[i], 1);
1028 add_job(td, jobname, 0, 0, client_type);
1031 static int skip_this_section(const char *name)
1035 if (!nr_job_sections)
1037 if (!strncmp(name, "global", 6))
1040 for (i = 0; i < nr_job_sections; i++)
1041 if (!strcmp(job_sections[i], name))
1047 static int is_empty_or_comment(char *line)
1051 for (i = 0; i < strlen(line); i++) {
1056 if (!isspace((int) line[i]) && !iscntrl((int) line[i]))
1064 * This is our [ini] type file parser.
1066 int parse_jobs_ini(char *file, int is_buf, int stonewall_flag, int type)
1068 unsigned int global;
1069 struct thread_data *td;
1070 char *string, *name;
1073 int ret = 0, stonewall;
1076 int inside_skip = 0;
1078 int i, alloc_opts, num_opts;
1083 if (!strcmp(file, "-"))
1086 f = fopen(file, "r");
1089 perror("fopen job file");
1094 string = malloc(4096);
1097 * it's really 256 + small bit, 280 should suffice
1100 memset(name, 0, 280);
1103 opts = malloc(sizeof(char *) * alloc_opts);
1106 stonewall = stonewall_flag;
1109 * if skip_fgets is set, we already have loaded a line we
1114 p = strsep(&file, "\n");
1116 p = fgets(string, 4096, f);
1122 strip_blank_front(&p);
1125 if (is_empty_or_comment(p))
1127 if (sscanf(p, "[%255[^\n]]", name) != 1) {
1130 log_err("fio: option <%s> outside of [] job section\n",
1135 name[strlen(name) - 1] = '\0';
1137 if (skip_this_section(name)) {
1143 global = !strncmp(name, "global", 6);
1149 log_info("--name=%s ", name);
1153 td = get_new_job(global, &def_thread, 0);
1160 * Seperate multiple job files by a stonewall
1162 if (!global && stonewall) {
1163 td->o.stonewall = stonewall;
1168 memset(opts, 0, alloc_opts * sizeof(char *));
1172 p = strsep(&file, "\n");
1174 p = fgets(string, 4096, f);
1178 if (is_empty_or_comment(p))
1181 strip_blank_front(&p);
1184 * new section, break out and make sure we don't
1185 * fgets() a new line at the top.
1194 if (num_opts == alloc_opts) {
1196 opts = realloc(opts,
1197 alloc_opts * sizeof(char *));
1200 opts[num_opts] = strdup(p);
1204 ret = fio_options_parse(td, opts, num_opts);
1207 for (i = 0; i < num_opts; i++)
1208 log_info("--%s ", opts[i]);
1210 ret = add_job(td, name, 0, 0, type);
1212 log_err("fio: job %s dropped\n", name);
1216 for (i = 0; i < num_opts; i++)
1225 while (i < nr_job_sections) {
1226 free(job_sections[i]);
1230 for (i = 0; i < num_opts; i++)
1236 if (!is_buf && f != stdin)
1241 static int fill_def_thread(void)
1243 memset(&def_thread, 0, sizeof(def_thread));
1245 fio_getaffinity(getpid(), &def_thread.o.cpumask);
1246 def_thread.o.timeout = def_timeout;
1247 def_thread.o.error_dump = 1;
1249 * fill default options
1251 fio_fill_default_options(&def_thread);
1255 static void usage(const char *name)
1257 printf("%s\n", fio_version_string);
1258 printf("%s [options] [job options] <job file(s)>\n", name);
1259 printf(" --debug=options\tEnable debug logging. May be one/more of:\n"
1260 "\t\t\tprocess,file,io,mem,blktrace,verify,random,parse,\n"
1261 "\t\t\tdiskutil,job,mutex,profile,time,net\n");
1262 printf(" --parse-only\t\tParse options only, don't start any IO\n");
1263 printf(" --output\t\tWrite output to file\n");
1264 printf(" --runtime\t\tRuntime in seconds\n");
1265 printf(" --latency-log\t\tGenerate per-job latency logs\n");
1266 printf(" --bandwidth-log\tGenerate per-job bandwidth logs\n");
1267 printf(" --minimal\t\tMinimal (terse) output\n");
1268 printf(" --output-format=x\tOutput format (terse,json,normal)\n");
1269 printf(" --terse-version=x\tSet terse version output format to 'x'\n");
1270 printf(" --version\t\tPrint version info and exit\n");
1271 printf(" --help\t\tPrint this page\n");
1272 printf(" --cpuclock-test\tPerform test/validation of CPU clock\n");
1273 printf(" --cmdhelp=cmd\t\tPrint command help, \"all\" for all of"
1275 printf(" --enghelp=engine\tPrint ioengine help, or list"
1276 " available ioengines\n");
1277 printf(" --enghelp=engine,cmd\tPrint help for an ioengine"
1279 printf(" --showcmd\t\tTurn a job file into command line options\n");
1280 printf(" --eta=when\t\tWhen ETA estimate should be printed\n");
1281 printf(" \t\tMay be \"always\", \"never\" or \"auto\"\n");
1282 printf(" --eta-newline=time\tForce a new line for every 'time'");
1283 printf(" period passed\n");
1284 printf(" --readonly\t\tTurn on safety read-only checks, preventing"
1286 printf(" --section=name\tOnly run specified section in job file\n");
1287 printf(" --alloc-size=kb\tSet smalloc pool to this size in kb"
1289 printf(" --warnings-fatal\tFio parser warnings are fatal\n");
1290 printf(" --max-jobs=nr\t\tMaximum number of threads/processes to support\n");
1291 printf(" --server=args\t\tStart a backend fio server\n");
1292 printf(" --daemonize=pidfile\tBackground fio server, write pid to file\n");
1293 printf(" --client=hostname\tTalk to remote backend fio server at hostname\n");
1294 printf(" --idle-prof=option\tReport cpu idleness on a system or percpu basis\n"
1295 "\t\t\t(option=system,percpu) or run unit work\n"
1296 "\t\t\tcalibration only (option=calibrate)\n");
1297 printf("\nFio was written by Jens Axboe <jens.axboe@oracle.com>");
1298 printf("\n Jens Axboe <jaxboe@fusionio.com>\n");
1301 #ifdef FIO_INC_DEBUG
1302 struct debug_level debug_levels[] = {
1303 { .name = "process",
1304 .help = "Process creation/exit logging",
1305 .shift = FD_PROCESS,
1308 .help = "File related action logging",
1312 .help = "IO and IO engine action logging (offsets, queue, completions, etc)",
1316 .help = "Memory allocation/freeing logging",
1319 { .name = "blktrace",
1320 .help = "blktrace action logging",
1321 .shift = FD_BLKTRACE,
1324 .help = "IO verification action logging",
1328 .help = "Random generation logging",
1332 .help = "Parser logging",
1335 { .name = "diskutil",
1336 .help = "Disk utility logging actions",
1337 .shift = FD_DISKUTIL,
1340 .help = "Logging related to creating/destroying jobs",
1344 .help = "Mutex logging",
1347 { .name = "profile",
1348 .help = "Logging related to profiles",
1349 .shift = FD_PROFILE,
1352 .help = "Logging related to time keeping functions",
1356 .help = "Network logging",
1362 static int set_debug(const char *string)
1364 struct debug_level *dl;
1365 char *p = (char *) string;
1369 if (!strcmp(string, "?") || !strcmp(string, "help")) {
1370 log_info("fio: dumping debug options:");
1371 for (i = 0; debug_levels[i].name; i++) {
1372 dl = &debug_levels[i];
1373 log_info("%s,", dl->name);
1379 while ((opt = strsep(&p, ",")) != NULL) {
1382 if (!strncmp(opt, "all", 3)) {
1383 log_info("fio: set all debug options\n");
1388 for (i = 0; debug_levels[i].name; i++) {
1389 dl = &debug_levels[i];
1390 found = !strncmp(opt, dl->name, strlen(dl->name));
1394 if (dl->shift == FD_JOB) {
1395 opt = strchr(opt, ':');
1397 log_err("fio: missing job number\n");
1401 fio_debug_jobno = atoi(opt);
1402 log_info("fio: set debug jobno %d\n",
1405 log_info("fio: set debug option %s\n", opt);
1406 fio_debug |= (1UL << dl->shift);
1412 log_err("fio: debug mask %s not found\n", opt);
1417 static int set_debug(const char *string)
1419 log_err("fio: debug tracing not included in build\n");
1424 static void fio_options_fill_optstring(void)
1426 char *ostr = cmd_optstr;
1430 while (l_opts[i].name) {
1431 ostr[c++] = l_opts[i].val;
1432 if (l_opts[i].has_arg == required_argument)
1434 else if (l_opts[i].has_arg == optional_argument) {
1443 static int client_flag_set(char c)
1448 while (l_opts[i].name) {
1449 int val = l_opts[i].val;
1451 if (c == (val & 0xff))
1452 return (val & FIO_CLIENT_FLAG);
1460 void parse_cmd_client(void *client, char *opt)
1462 fio_client_add_cmd_option(client, opt);
1465 int parse_cmd_line(int argc, char *argv[], int client_type)
1467 struct thread_data *td = NULL;
1468 int c, ini_idx = 0, lidx, ret = 0, do_exit = 0, exit_val = 0;
1469 char *ostr = cmd_optstr;
1470 void *pid_file = NULL;
1471 void *cur_client = NULL;
1475 * Reset optind handling, since we may call this multiple times
1480 while ((c = getopt_long_only(argc, argv, ostr, l_opts, &lidx)) != -1) {
1483 if ((c & FIO_CLIENT_FLAG) || client_flag_set(c)) {
1484 parse_cmd_client(cur_client, argv[optind - 1]);
1485 c &= ~FIO_CLIENT_FLAG;
1490 smalloc_pool_size = atoi(optarg);
1493 def_timeout = atoi(optarg);
1502 f_out = fopen(optarg, "w+");
1504 perror("fopen output");
1510 output_format = FIO_OUTPUT_TERSE;
1513 if (!strcmp(optarg, "minimal") ||
1514 !strcmp(optarg, "terse") ||
1515 !strcmp(optarg, "csv"))
1516 output_format = FIO_OUTPUT_TERSE;
1517 else if (!strcmp(optarg, "json"))
1518 output_format = FIO_OUTPUT_JSON;
1520 output_format = FIO_OUTPUT_NORMAL;
1530 fio_show_option_help(optarg);
1536 fio_show_ioengine_help(optarg);
1548 log_info("%s\n", fio_version_string);
1553 terse_version = atoi(optarg);
1554 if (!(terse_version == 2 || terse_version == 3 ||
1555 terse_version == 4)) {
1556 log_err("fio: bad terse version format\n");
1562 if (!strcmp("always", optarg))
1563 eta_print = FIO_ETA_ALWAYS;
1564 else if (!strcmp("never", optarg))
1565 eta_print = FIO_ETA_NEVER;
1570 if (str_to_decimal(optarg, &t, 0, NULL)) {
1571 log_err("fio: failed parsing eta time %s\n", optarg);
1579 if (set_debug(optarg))
1588 if (!strcmp(optarg, "global")) {
1589 log_err("fio: can't use global as only "
1595 new_size = (nr_job_sections + 1) * sizeof(char *);
1596 job_sections = realloc(job_sections, new_size);
1597 job_sections[nr_job_sections] = strdup(optarg);
1602 exec_profile = strdup(optarg);
1604 case FIO_GETOPT_JOB: {
1605 const char *opt = l_opts[lidx].name;
1608 if (!strncmp(opt, "name", 4) && td) {
1609 ret = add_job(td, td->o.name ?: "fio", 0, 0, client_type);
1615 int is_section = !strncmp(opt, "name", 4);
1618 if (!is_section || !strncmp(val, "global", 6))
1621 if (is_section && skip_this_section(val))
1624 td = get_new_job(global, &def_thread, 1);
1625 if (!td || ioengine_load(td))
1627 fio_options_set_ioengine_opts(l_opts, td);
1630 ret = fio_cmd_option_parse(td, opt, val);
1632 if (!ret && !strcmp(opt, "ioengine")) {
1634 if (ioengine_load(td))
1636 fio_options_set_ioengine_opts(l_opts, td);
1640 case FIO_GETOPT_IOENGINE: {
1641 const char *opt = l_opts[lidx].name;
1643 opt = l_opts[lidx].name;
1645 ret = fio_cmd_ioengine_option_parse(td, opt, val);
1652 max_jobs = atoi(optarg);
1653 if (!max_jobs || max_jobs > REAL_MAX_JOBS) {
1654 log_err("fio: invalid max jobs: %d\n", max_jobs);
1661 log_err("fio: can't be both client and server\n");
1667 fio_server_set_arg(optarg);
1672 pid_file = strdup(optarg);
1675 if ((ret = fio_idle_prof_parse_opt(optarg))) {
1676 /* exit on error and calibration only */
1684 log_err("fio: can't be both client and server\n");
1689 if (fio_client_add(&fio_client_ops, optarg, &cur_client)) {
1690 log_err("fio: failed adding client %s\n", optarg);
1696 * If the next argument exists and isn't an option,
1697 * assume it's a job file for this client only.
1699 while (optind < argc) {
1700 if (!strncmp(argv[optind], "--", 2) ||
1701 !strncmp(argv[optind], "-", 1))
1704 fio_client_add_ini_file(cur_client, argv[optind]);
1710 exit_val = fio_monotonic_clocktest();
1713 log_err("%s: unrecognized option '%s'\n", argv[0],
1725 if (exit_val && !(is_backend || nr_clients))
1729 if (nr_clients && fio_clients_connect()) {
1735 if (is_backend && backend)
1736 return fio_start_server(pid_file);
1740 ret = add_job(td, td->o.name ?: "fio", 0, 0, client_type);
1743 while (!ret && optind < argc) {
1745 ini_file = realloc(ini_file, ini_idx * sizeof(char *));
1746 ini_file[ini_idx - 1] = strdup(argv[optind]);
1753 int fio_init_options(void)
1758 fio_options_fill_optstring();
1759 fio_options_dup_and_init(l_opts);
1763 if (fill_def_thread())
1769 extern int fio_check_options(struct thread_options *);
1771 int parse_options(int argc, char *argv[])
1773 const int type = FIO_CLIENT_TYPE_CLI;
1776 if (fio_init_options())
1778 if (fio_test_cconv(&def_thread.o))
1779 log_err("fio: failed internal cconv test\n");
1781 job_files = parse_cmd_line(argc, argv, type);
1783 if (job_files > 0) {
1784 for (i = 0; i < job_files; i++) {
1785 if (fill_def_thread())
1788 if (fio_clients_send_ini(ini_file[i]))
1791 } else if (!is_backend) {
1792 if (parse_jobs_ini(ini_file[i], 0, i, type))
1797 } else if (nr_clients) {
1798 if (fill_def_thread())
1800 if (fio_clients_send_ini(NULL))
1805 fio_options_free(&def_thread);
1807 if (!thread_number) {
1808 if (dump_cmdline || parse_only)
1812 if (is_backend || nr_clients)
1817 log_err("No jobs(s) defined\n\n");
1827 if (def_thread.o.gtod_offload) {
1829 fio_gtod_offload = 1;
1830 fio_gtod_cpu = def_thread.o.gtod_cpu;
1833 if (output_format == FIO_OUTPUT_NORMAL)
1834 log_info("%s\n", fio_version_string);
1839 void options_default_fill(struct thread_options *o)
1841 memcpy(o, &def_thread.o, sizeof(*o));