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"
29 #include "lib/strcasestr.h"
31 const char fio_version_string[] = FIO_VERSION;
33 #define FIO_RANDSEED (0xb1899bedUL)
35 static char **ini_file;
36 static int max_jobs = FIO_MAX_JOBS;
37 static int dump_cmdline;
38 static int def_timeout;
39 static int parse_only;
41 static struct thread_data def_thread;
42 struct thread_data *threads = NULL;
44 int exitall_on_terminate = 0;
45 int output_format = FIO_OUTPUT_NORMAL;
46 int eta_print = FIO_ETA_AUTO;
48 unsigned long long mlock_size = 0;
51 char **job_sections = NULL;
52 int nr_job_sections = 0;
53 char *exec_profile = NULL;
54 int warnings_fatal = 0;
55 int terse_version = 3;
63 static int write_lat_log;
65 static int prev_group_jobs;
67 unsigned long fio_debug = 0;
68 unsigned int fio_debug_jobno = -1;
69 unsigned int *fio_debug_jobp = NULL;
71 static char cmd_optstr[256];
74 #define FIO_CLIENT_FLAG (1 << 16)
77 * Command line options. These will contain the above, plus a few
78 * extra that only pertain to fio itself and not jobs.
80 static struct option l_opts[FIO_NR_OPTIONS] = {
82 .name = (char *) "output",
83 .has_arg = required_argument,
84 .val = 'o' | FIO_CLIENT_FLAG,
87 .name = (char *) "timeout",
88 .has_arg = required_argument,
89 .val = 't' | FIO_CLIENT_FLAG,
92 .name = (char *) "latency-log",
93 .has_arg = required_argument,
94 .val = 'l' | FIO_CLIENT_FLAG,
97 .name = (char *) "bandwidth-log",
98 .has_arg = required_argument,
99 .val = 'b' | FIO_CLIENT_FLAG,
102 .name = (char *) "minimal",
103 .has_arg = optional_argument,
104 .val = 'm' | FIO_CLIENT_FLAG,
107 .name = (char *) "output-format",
108 .has_arg = optional_argument,
109 .val = 'F' | FIO_CLIENT_FLAG,
112 .name = (char *) "version",
113 .has_arg = no_argument,
114 .val = 'v' | FIO_CLIENT_FLAG,
117 .name = (char *) "help",
118 .has_arg = no_argument,
119 .val = 'h' | FIO_CLIENT_FLAG,
122 .name = (char *) "cmdhelp",
123 .has_arg = optional_argument,
124 .val = 'c' | FIO_CLIENT_FLAG,
127 .name = (char *) "enghelp",
128 .has_arg = optional_argument,
129 .val = 'i' | FIO_CLIENT_FLAG,
132 .name = (char *) "showcmd",
133 .has_arg = no_argument,
134 .val = 's' | FIO_CLIENT_FLAG,
137 .name = (char *) "readonly",
138 .has_arg = no_argument,
139 .val = 'r' | FIO_CLIENT_FLAG,
142 .name = (char *) "eta",
143 .has_arg = required_argument,
144 .val = 'e' | FIO_CLIENT_FLAG,
147 .name = (char *) "eta-newline",
148 .has_arg = required_argument,
149 .val = 'E' | FIO_CLIENT_FLAG,
152 .name = (char *) "debug",
153 .has_arg = required_argument,
154 .val = 'd' | FIO_CLIENT_FLAG,
157 .name = (char *) "parse-only",
158 .has_arg = no_argument,
159 .val = 'P' | FIO_CLIENT_FLAG,
162 .name = (char *) "section",
163 .has_arg = required_argument,
164 .val = 'x' | FIO_CLIENT_FLAG,
167 .name = (char *) "alloc-size",
168 .has_arg = required_argument,
169 .val = 'a' | FIO_CLIENT_FLAG,
172 .name = (char *) "profile",
173 .has_arg = required_argument,
174 .val = 'p' | FIO_CLIENT_FLAG,
177 .name = (char *) "warnings-fatal",
178 .has_arg = no_argument,
179 .val = 'w' | FIO_CLIENT_FLAG,
182 .name = (char *) "max-jobs",
183 .has_arg = required_argument,
184 .val = 'j' | FIO_CLIENT_FLAG,
187 .name = (char *) "terse-version",
188 .has_arg = required_argument,
189 .val = 'V' | FIO_CLIENT_FLAG,
192 .name = (char *) "server",
193 .has_arg = optional_argument,
196 { .name = (char *) "daemonize",
197 .has_arg = required_argument,
201 .name = (char *) "client",
202 .has_arg = required_argument,
206 .name = (char *) "cpuclock-test",
207 .has_arg = no_argument,
211 .name = (char *) "idle-prof",
212 .has_arg = required_argument,
220 void free_threads_shm(void)
222 struct shmid_ds sbuf;
229 shmctl(shm_id, IPC_RMID, &sbuf);
239 fio_debug_jobp = NULL;
247 * The thread area is shared between the main process and the job
248 * threads/processes. So setup a shared memory segment that will hold
249 * all the job info. We use the end of the region for keeping track of
250 * open files across jobs, for file sharing.
252 static int setup_thread_area(void)
260 * 1024 is too much on some machines, scale max_jobs if
261 * we get a failure that looks like too large a shm segment
264 size_t size = max_jobs * sizeof(struct thread_data);
266 size += file_hash_size;
267 size += sizeof(unsigned int);
269 shm_id = shmget(0, size, IPC_CREAT | 0600);
272 if (errno != EINVAL && errno != ENOMEM && errno != ENOSPC) {
283 threads = shmat(shm_id, NULL, 0);
284 if (threads == (void *) -1) {
289 memset(threads, 0, max_jobs * sizeof(struct thread_data));
290 hash = (void *) threads + max_jobs * sizeof(struct thread_data);
291 fio_debug_jobp = (void *) hash + file_hash_size;
292 *fio_debug_jobp = -1;
293 file_hash_init(hash);
301 * Return a free job structure.
303 static struct thread_data *get_new_job(int global, struct thread_data *parent,
306 struct thread_data *td;
310 if (setup_thread_area()) {
311 log_err("error: failed to setup shm segment\n");
314 if (thread_number >= max_jobs) {
315 log_err("error: maximum number of jobs (%d) reached.\n",
320 td = &threads[thread_number++];
327 td->o.uid = td->o.gid = -1U;
329 dup_files(td, parent);
330 fio_options_mem_dupe(td);
332 profile_add_hooks(td);
334 td->thread_number = thread_number;
336 if (!parent || !parent->o.group_reporting)
342 static void put_job(struct thread_data *td)
344 if (td == &def_thread)
351 log_info("fio: %s\n", td->verror);
353 fio_options_free(td);
357 memset(&threads[td->thread_number - 1], 0, sizeof(*td));
361 static int __setup_rate(struct thread_data *td, enum fio_ddir ddir)
363 unsigned int bs = td->o.min_bs[ddir];
365 assert(ddir_rw(ddir));
367 if (td->o.rate[ddir])
368 td->rate_bps[ddir] = td->o.rate[ddir];
370 td->rate_bps[ddir] = td->o.rate_iops[ddir] * bs;
372 if (!td->rate_bps[ddir]) {
373 log_err("rate lower than supported\n");
377 td->rate_pending_usleep[ddir] = 0;
381 static int setup_rate(struct thread_data *td)
385 if (td->o.rate[DDIR_READ] || td->o.rate_iops[DDIR_READ])
386 ret = __setup_rate(td, DDIR_READ);
387 if (td->o.rate[DDIR_WRITE] || td->o.rate_iops[DDIR_WRITE])
388 ret |= __setup_rate(td, DDIR_WRITE);
389 if (td->o.rate[DDIR_TRIM] || td->o.rate_iops[DDIR_TRIM])
390 ret |= __setup_rate(td, DDIR_TRIM);
395 static int fixed_block_size(struct thread_options *o)
397 return o->min_bs[DDIR_READ] == o->max_bs[DDIR_READ] &&
398 o->min_bs[DDIR_WRITE] == o->max_bs[DDIR_WRITE] &&
399 o->min_bs[DDIR_TRIM] == o->max_bs[DDIR_TRIM] &&
400 o->min_bs[DDIR_READ] == o->min_bs[DDIR_WRITE] &&
401 o->min_bs[DDIR_READ] == o->min_bs[DDIR_TRIM];
405 * Lazy way of fixing up options that depend on each other. We could also
406 * define option callback handlers, but this is easier.
408 static int fixup_options(struct thread_data *td)
410 struct thread_options *o = &td->o;
413 #ifndef FIO_HAVE_PSHARED_MUTEX
414 if (!o->use_thread) {
415 log_info("fio: this platform does not support process shared"
416 " mutexes, forcing use of threads. Use the 'thread'"
417 " option to get rid of this warning.\n");
419 ret = warnings_fatal;
423 if (o->write_iolog_file && o->read_iolog_file) {
424 log_err("fio: read iolog overrides write_iolog\n");
425 free(o->write_iolog_file);
426 o->write_iolog_file = NULL;
427 ret = warnings_fatal;
431 * only really works with 1 file
433 if (o->zone_size && o->open_files > 1)
437 * If zone_range isn't specified, backward compatibility dictates it
438 * should be made equal to zone_size.
440 if (o->zone_size && !o->zone_range)
441 o->zone_range = o->zone_size;
444 * Reads can do overwrites, we always need to pre-create the file
446 if (td_read(td) || td_rw(td))
449 if (!o->min_bs[DDIR_READ])
450 o->min_bs[DDIR_READ] = o->bs[DDIR_READ];
451 if (!o->max_bs[DDIR_READ])
452 o->max_bs[DDIR_READ] = o->bs[DDIR_READ];
453 if (!o->min_bs[DDIR_WRITE])
454 o->min_bs[DDIR_WRITE] = o->bs[DDIR_WRITE];
455 if (!o->max_bs[DDIR_WRITE])
456 o->max_bs[DDIR_WRITE] = o->bs[DDIR_WRITE];
457 if (!o->min_bs[DDIR_TRIM])
458 o->min_bs[DDIR_TRIM] = o->bs[DDIR_TRIM];
459 if (!o->max_bs[DDIR_TRIM])
460 o->max_bs[DDIR_TRIM] = o->bs[DDIR_TRIM];
463 o->rw_min_bs = min(o->min_bs[DDIR_READ], o->min_bs[DDIR_WRITE]);
464 o->rw_min_bs = min(o->min_bs[DDIR_TRIM], o->rw_min_bs);
467 * For random IO, allow blockalign offset other than min_bs.
469 if (!o->ba[DDIR_READ] || !td_random(td))
470 o->ba[DDIR_READ] = o->min_bs[DDIR_READ];
471 if (!o->ba[DDIR_WRITE] || !td_random(td))
472 o->ba[DDIR_WRITE] = o->min_bs[DDIR_WRITE];
473 if (!o->ba[DDIR_TRIM] || !td_random(td))
474 o->ba[DDIR_TRIM] = o->min_bs[DDIR_TRIM];
476 if ((o->ba[DDIR_READ] != o->min_bs[DDIR_READ] ||
477 o->ba[DDIR_WRITE] != o->min_bs[DDIR_WRITE] ||
478 o->ba[DDIR_TRIM] != o->min_bs[DDIR_TRIM]) &&
480 log_err("fio: Any use of blockalign= turns off randommap\n");
482 ret = warnings_fatal;
485 if (!o->file_size_high)
486 o->file_size_high = o->file_size_low;
488 if (o->norandommap && o->verify != VERIFY_NONE
489 && !fixed_block_size(o)) {
490 log_err("fio: norandommap given for variable block sizes, "
491 "verify disabled\n");
492 o->verify = VERIFY_NONE;
493 ret = warnings_fatal;
495 if (o->bs_unaligned && (o->odirect || td->io_ops->flags & FIO_RAWIO))
496 log_err("fio: bs_unaligned may not work with raw io\n");
499 * thinktime_spin must be less than thinktime
501 if (o->thinktime_spin > o->thinktime)
502 o->thinktime_spin = o->thinktime;
505 * The low water mark cannot be bigger than the iodepth
507 if (o->iodepth_low > o->iodepth || !o->iodepth_low)
508 o->iodepth_low = o->iodepth;
511 * If batch number isn't set, default to the same as iodepth
513 if (o->iodepth_batch > o->iodepth || !o->iodepth_batch)
514 o->iodepth_batch = o->iodepth;
516 if (o->nr_files > td->files_index)
517 o->nr_files = td->files_index;
519 if (o->open_files > o->nr_files || !o->open_files)
520 o->open_files = o->nr_files;
522 if (((o->rate[DDIR_READ] + o->rate[DDIR_WRITE] + o->rate[DDIR_TRIM]) &&
523 (o->rate_iops[DDIR_READ] + o->rate_iops[DDIR_WRITE] + o->rate_iops[DDIR_TRIM])) ||
524 ((o->ratemin[DDIR_READ] + o->ratemin[DDIR_WRITE] + o->ratemin[DDIR_TRIM]) &&
525 (o->rate_iops_min[DDIR_READ] + o->rate_iops_min[DDIR_WRITE] + o->rate_iops_min[DDIR_TRIM]))) {
526 log_err("fio: rate and rate_iops are mutually exclusive\n");
529 if ((o->rate[DDIR_READ] < o->ratemin[DDIR_READ]) ||
530 (o->rate[DDIR_WRITE] < o->ratemin[DDIR_WRITE]) ||
531 (o->rate[DDIR_TRIM] < o->ratemin[DDIR_TRIM]) ||
532 (o->rate_iops[DDIR_READ] < o->rate_iops_min[DDIR_READ]) ||
533 (o->rate_iops[DDIR_WRITE] < o->rate_iops_min[DDIR_WRITE]) ||
534 (o->rate_iops[DDIR_TRIM] < o->rate_iops_min[DDIR_TRIM])) {
535 log_err("fio: minimum rate exceeds rate\n");
539 if (!o->timeout && o->time_based) {
540 log_err("fio: time_based requires a runtime/timeout setting\n");
542 ret = warnings_fatal;
545 if (o->fill_device && !o->size)
548 if (o->verify != VERIFY_NONE) {
549 if (td_write(td) && o->do_verify && o->numjobs > 1) {
550 log_info("Multiple writers may overwrite blocks that "
551 "belong to other jobs. This can cause "
552 "verification failures.\n");
553 ret = warnings_fatal;
556 o->refill_buffers = 1;
557 if (o->max_bs[DDIR_WRITE] != o->min_bs[DDIR_WRITE] &&
559 o->verify_interval = o->min_bs[DDIR_WRITE];
563 o->invalidate_cache = 0;
564 if (td->io_ops->flags & FIO_PIPEIO) {
565 log_info("fio: cannot pre-read files with an IO engine"
566 " that isn't seekable. Pre-read disabled.\n");
567 ret = warnings_fatal;
572 if (td->io_ops->flags & FIO_BIT_BASED)
578 #ifndef CONFIG_FDATASYNC
579 if (o->fdatasync_blocks) {
580 log_info("fio: this platform does not support fdatasync()"
581 " falling back to using fsync(). Use the 'fsync'"
582 " option instead of 'fdatasync' to get rid of"
584 o->fsync_blocks = o->fdatasync_blocks;
585 o->fdatasync_blocks = 0;
586 ret = warnings_fatal;
592 * Windows doesn't support O_DIRECT or O_SYNC with the _open interface,
593 * so fail if we're passed those flags
595 if ((td->io_ops->flags & FIO_SYNCIO) && (td->o.odirect || td->o.sync_io)) {
596 log_err("fio: Windows does not support direct or non-buffered io with"
597 " the synchronous ioengines. Use the 'windowsaio' ioengine"
598 " with 'direct=1' and 'iodepth=1' instead.\n");
604 * For fully compressible data, just zero them at init time.
605 * It's faster than repeatedly filling it.
607 if (td->o.compress_percentage == 100) {
608 td->o.zero_buffers = 1;
609 td->o.compress_percentage = 0;
613 * Using a non-uniform random distribution excludes usage of
616 if (td->o.random_distribution != FIO_RAND_DIST_RANDOM)
617 td->o.norandommap = 1;
623 * This function leaks the buffer
625 char *fio_uint_to_kmg(unsigned int val)
627 char *buf = malloc(32);
628 char post[] = { 0, 'K', 'M', 'G', 'P', 'E', 0 };
639 snprintf(buf, 32, "%u%c", val, *p);
643 /* External engines are specified by "external:name.o") */
644 static const char *get_engine_name(const char *str)
646 char *p = strstr(str, ":");
652 strip_blank_front(&p);
657 static int exists_and_not_file(const char *filename)
661 if (lstat(filename, &sb) == -1)
664 /* \\.\ is the device namespace in Windows, where every file
665 * is a device node */
666 if (S_ISREG(sb.st_mode) && strncmp(filename, "\\\\.\\", 4) != 0)
672 static void td_fill_rand_seeds_os(struct thread_data *td)
674 os_random_seed(td->rand_seeds[FIO_RAND_BS_OFF], &td->bsrange_state);
675 os_random_seed(td->rand_seeds[FIO_RAND_VER_OFF], &td->verify_state);
676 os_random_seed(td->rand_seeds[FIO_RAND_MIX_OFF], &td->rwmix_state);
678 if (td->o.file_service_type == FIO_FSERVICE_RANDOM)
679 os_random_seed(td->rand_seeds[FIO_RAND_FILE_OFF], &td->next_file_state);
681 os_random_seed(td->rand_seeds[FIO_RAND_FILE_SIZE_OFF], &td->file_size_state);
682 os_random_seed(td->rand_seeds[FIO_RAND_TRIM_OFF], &td->trim_state);
687 if (td->o.rand_repeatable)
688 td->rand_seeds[FIO_RAND_BLOCK_OFF] = FIO_RANDSEED * td->thread_number;
690 os_random_seed(td->rand_seeds[FIO_RAND_BLOCK_OFF], &td->random_state);
693 static void td_fill_rand_seeds_internal(struct thread_data *td)
695 init_rand_seed(&td->__bsrange_state, td->rand_seeds[FIO_RAND_BS_OFF]);
696 init_rand_seed(&td->__verify_state, td->rand_seeds[FIO_RAND_VER_OFF]);
697 init_rand_seed(&td->__rwmix_state, td->rand_seeds[FIO_RAND_MIX_OFF]);
699 if (td->o.file_service_type == FIO_FSERVICE_RANDOM)
700 init_rand_seed(&td->__next_file_state, td->rand_seeds[FIO_RAND_FILE_OFF]);
702 init_rand_seed(&td->__file_size_state, td->rand_seeds[FIO_RAND_FILE_SIZE_OFF]);
703 init_rand_seed(&td->__trim_state, td->rand_seeds[FIO_RAND_TRIM_OFF]);
708 if (td->o.rand_repeatable)
709 td->rand_seeds[FIO_RAND_BLOCK_OFF] = FIO_RANDSEED * td->thread_number;
711 init_rand_seed(&td->__random_state, td->rand_seeds[FIO_RAND_BLOCK_OFF]);
714 void td_fill_rand_seeds(struct thread_data *td)
716 if (td->o.use_os_rand)
717 td_fill_rand_seeds_os(td);
719 td_fill_rand_seeds_internal(td);
721 init_rand_seed(&td->buf_state, td->rand_seeds[FIO_RAND_BUF_OFF]);
725 * Initializes the ioengine configured for a job, if it has not been done so
728 int ioengine_load(struct thread_data *td)
733 * Engine has already been loaded.
738 engine = get_engine_name(td->o.ioengine);
739 td->io_ops = load_ioengine(td, engine);
741 log_err("fio: failed to load engine %s\n", engine);
745 if (td->io_ops->option_struct_size && td->io_ops->options) {
747 * In cases where td->eo is set, clone it for a child thread.
748 * This requires that the parent thread has the same ioengine,
749 * but that requirement must be enforced by the code which
752 void *origeo = td->eo;
754 * Otherwise use the default thread options.
756 if (!origeo && td != &def_thread && def_thread.eo &&
757 def_thread.io_ops->options == td->io_ops->options)
758 origeo = def_thread.eo;
760 options_init(td->io_ops->options);
761 td->eo = malloc(td->io_ops->option_struct_size);
763 * Use the default thread as an option template if this uses the
764 * same options structure and there are non-default options
768 memcpy(td->eo, origeo, td->io_ops->option_struct_size);
769 options_mem_dupe(td->eo, td->io_ops->options);
771 memset(td->eo, 0, td->io_ops->option_struct_size);
772 fill_default_options(td->eo, td->io_ops->options);
774 *(struct thread_data **)td->eo = td;
780 static void init_flags(struct thread_data *td)
782 struct thread_options *o = &td->o;
784 if (o->verify_backlog)
785 td->flags |= TD_F_VER_BACKLOG;
787 td->flags |= TD_F_TRIM_BACKLOG;
788 if (o->read_iolog_file)
789 td->flags |= TD_F_READ_IOLOG;
790 if (o->refill_buffers)
791 td->flags |= TD_F_REFILL_BUFFERS;
792 if (o->scramble_buffers)
793 td->flags |= TD_F_SCRAMBLE_BUFFERS;
794 if (o->verify != VERIFY_NONE)
795 td->flags |= TD_F_VER_NONE;
798 static int setup_random_seeds(struct thread_data *td)
803 if (!td->o.rand_repeatable)
804 return init_random_state(td, td->rand_seeds, sizeof(td->rand_seeds));
806 for (seed = 0x89, i = 0; i < 4; i++)
807 seed *= 0x9e370001UL;
809 for (i = 0; i < FIO_RAND_NR_OFFS; i++) {
810 td->rand_seeds[i] = seed;
811 seed *= 0x9e370001UL;
814 td_fill_rand_seeds(td);
825 static struct fpre_keyword {
829 } fpre_keywords[] = {
830 { .keyword = "$jobname", .key = FPRE_JOBNAME, },
831 { .keyword = "$jobnum", .key = FPRE_JOBNUM, },
832 { .keyword = "$filenum", .key = FPRE_FILENUM, },
833 { .keyword = NULL, },
836 static char *make_filename(char *buf, struct thread_options *o,
837 const char *jobname, int jobnum, int filenum)
839 struct fpre_keyword *f;
842 if (!o->filename_format || !strlen(o->filename_format)) {
843 sprintf(buf, "%s.%d.%d", jobname, jobnum, filenum);
847 for (f = &fpre_keywords[0]; f->keyword; f++)
848 f->strlen = strlen(f->keyword);
850 strcpy(buf, o->filename_format);
851 memset(copy, 0, sizeof(copy));
852 for (f = &fpre_keywords[0]; f->keyword; f++) {
854 size_t pre_len, post_start = 0;
855 char *str, *dst = copy;
857 str = strcasestr(buf, f->keyword);
862 if (strlen(str) != f->strlen)
863 post_start = pre_len + f->strlen;
866 strncpy(dst, buf, pre_len);
872 dst += sprintf(dst, "%s", jobname);
875 dst += sprintf(dst, "%d", jobnum);
878 dst += sprintf(dst, "%d", filenum);
886 strcpy(dst, buf + post_start);
895 * Adds a job to the list of things todo. Sanitizes the various options
896 * to make sure we don't have conflicts, and initializes various
899 static int add_job(struct thread_data *td, const char *jobname, int job_add_num,
900 int recursed, int client_type)
903 char fname[PATH_MAX];
904 int numjobs, file_alloced;
905 struct thread_options *o = &td->o;
908 * the def_thread is just for options, it's not a real job
910 if (td == &def_thread)
916 * if we are just dumping the output command line, don't add the job
918 if (dump_cmdline || parse_only) {
923 td->client_type = client_type;
925 if (profile_td_init(td))
928 if (ioengine_load(td))
932 td->io_ops->flags |= FIO_RAWIO;
935 if (!o->filename && !td->files_index && !o->read_iolog_file) {
938 if (o->nr_files == 1 && exists_and_not_file(jobname))
939 add_file(td, jobname);
941 for (i = 0; i < o->nr_files; i++)
942 add_file(td, make_filename(fname, o, jobname, td->thread_number, i));
946 if (fixup_options(td))
952 * IO engines only need this for option callbacks, and the address may
953 * change in subprocesses.
956 *(struct thread_data **)td->eo = NULL;
958 if (td->io_ops->flags & FIO_DISKLESSIO) {
961 for_each_file(td, f, i)
962 f->real_file_size = -1ULL;
965 td->mutex = fio_mutex_init(FIO_MUTEX_LOCKED);
967 td->ts.clat_percentiles = o->clat_percentiles;
968 td->ts.percentile_precision = o->percentile_precision;
969 memcpy(td->ts.percentile_list, o->percentile_list, sizeof(o->percentile_list));
971 for (i = 0; i < DDIR_RWDIR_CNT; i++) {
972 td->ts.clat_stat[i].min_val = ULONG_MAX;
973 td->ts.slat_stat[i].min_val = ULONG_MAX;
974 td->ts.lat_stat[i].min_val = ULONG_MAX;
975 td->ts.bw_stat[i].min_val = ULONG_MAX;
977 td->ddir_seq_nr = o->ddir_seq_nr;
979 if ((o->stonewall || o->new_group) && prev_group_jobs) {
984 td->groupid = groupid;
987 if (setup_random_seeds(td)) {
988 td_verror(td, errno, "init_random_state");
995 if (o->lat_log_file) {
996 setup_log(&td->lat_log, o->log_avg_msec, IO_LOG_TYPE_LAT);
997 setup_log(&td->slat_log, o->log_avg_msec, IO_LOG_TYPE_SLAT);
998 setup_log(&td->clat_log, o->log_avg_msec, IO_LOG_TYPE_CLAT);
1001 setup_log(&td->bw_log, o->log_avg_msec, IO_LOG_TYPE_BW);
1002 if (o->iops_log_file)
1003 setup_log(&td->iops_log, o->log_avg_msec, IO_LOG_TYPE_IOPS);
1006 o->name = strdup(jobname);
1008 if (output_format == FIO_OUTPUT_NORMAL) {
1010 if (is_backend && !recursed)
1011 fio_server_send_add_job(td);
1013 if (!(td->io_ops->flags & FIO_NOIO)) {
1014 char *c1, *c2, *c3, *c4, *c5, *c6;
1016 c1 = fio_uint_to_kmg(o->min_bs[DDIR_READ]);
1017 c2 = fio_uint_to_kmg(o->max_bs[DDIR_READ]);
1018 c3 = fio_uint_to_kmg(o->min_bs[DDIR_WRITE]);
1019 c4 = fio_uint_to_kmg(o->max_bs[DDIR_WRITE]);
1020 c5 = fio_uint_to_kmg(o->min_bs[DDIR_TRIM]);
1021 c6 = fio_uint_to_kmg(o->max_bs[DDIR_TRIM]);
1023 log_info("%s: (g=%d): rw=%s, bs=%s-%s/%s-%s/%s-%s,"
1024 " ioengine=%s, iodepth=%u\n",
1025 td->o.name, td->groupid,
1026 ddir_str(o->td_ddir),
1027 c1, c2, c3, c4, c5, c6,
1028 td->io_ops->name, o->iodepth);
1037 } else if (job_add_num == 1)
1042 * recurse add identical jobs, clear numjobs and stonewall options
1043 * as they don't apply to sub-jobs
1045 numjobs = o->numjobs;
1047 struct thread_data *td_new = get_new_job(0, td, 1);
1052 td_new->o.numjobs = 1;
1053 td_new->o.stonewall = 0;
1054 td_new->o.new_group = 0;
1057 td_new->o.filename = NULL;
1058 td_new->files_index = 0;
1059 td_new->files_size = 0;
1060 td_new->files = NULL;
1063 job_add_num = numjobs - 1;
1065 if (add_job(td_new, jobname, job_add_num, 1, client_type))
1076 * Parse as if 'o' was a command line
1078 void add_job_opts(const char **o, int client_type)
1080 struct thread_data *td, *td_parent;
1081 int i, in_global = 1;
1085 td_parent = td = NULL;
1087 if (!strncmp(o[i], "name", 4)) {
1090 add_job(td, jobname, 0, 0, client_type);
1092 sprintf(jobname, "%s", o[i] + 5);
1094 if (in_global && !td_parent)
1095 td_parent = get_new_job(1, &def_thread, 0);
1096 else if (!in_global && !td) {
1098 td_parent = &def_thread;
1099 td = get_new_job(0, td_parent, 0);
1102 fio_options_parse(td_parent, (char **) &o[i], 1);
1104 fio_options_parse(td, (char **) &o[i], 1);
1109 add_job(td, jobname, 0, 0, client_type);
1112 static int skip_this_section(const char *name)
1116 if (!nr_job_sections)
1118 if (!strncmp(name, "global", 6))
1121 for (i = 0; i < nr_job_sections; i++)
1122 if (!strcmp(job_sections[i], name))
1128 static int is_empty_or_comment(char *line)
1132 for (i = 0; i < strlen(line); i++) {
1137 if (!isspace((int) line[i]) && !iscntrl((int) line[i]))
1145 * This is our [ini] type file parser.
1147 int parse_jobs_ini(char *file, int is_buf, int stonewall_flag, int type)
1149 unsigned int global;
1150 struct thread_data *td;
1151 char *string, *name;
1154 int ret = 0, stonewall;
1157 int inside_skip = 0;
1159 int i, alloc_opts, num_opts;
1164 if (!strcmp(file, "-"))
1167 f = fopen(file, "r");
1170 perror("fopen job file");
1175 string = malloc(4096);
1178 * it's really 256 + small bit, 280 should suffice
1181 memset(name, 0, 280);
1184 opts = malloc(sizeof(char *) * alloc_opts);
1187 stonewall = stonewall_flag;
1190 * if skip_fgets is set, we already have loaded a line we
1195 p = strsep(&file, "\n");
1197 p = fgets(string, 4096, f);
1203 strip_blank_front(&p);
1206 if (is_empty_or_comment(p))
1208 if (sscanf(p, "[%255[^\n]]", name) != 1) {
1211 log_err("fio: option <%s> outside of [] job section\n",
1216 name[strlen(name) - 1] = '\0';
1218 if (skip_this_section(name)) {
1224 global = !strncmp(name, "global", 6);
1230 log_info("--name=%s ", name);
1234 td = get_new_job(global, &def_thread, 0);
1241 * Seperate multiple job files by a stonewall
1243 if (!global && stonewall) {
1244 td->o.stonewall = stonewall;
1249 memset(opts, 0, alloc_opts * sizeof(char *));
1253 p = strsep(&file, "\n");
1255 p = fgets(string, 4096, f);
1259 if (is_empty_or_comment(p))
1262 strip_blank_front(&p);
1265 * new section, break out and make sure we don't
1266 * fgets() a new line at the top.
1275 if (num_opts == alloc_opts) {
1277 opts = realloc(opts,
1278 alloc_opts * sizeof(char *));
1281 opts[num_opts] = strdup(p);
1285 ret = fio_options_parse(td, opts, num_opts);
1288 for (i = 0; i < num_opts; i++)
1289 log_info("--%s ", opts[i]);
1291 ret = add_job(td, name, 0, 0, type);
1293 log_err("fio: job %s dropped\n", name);
1297 for (i = 0; i < num_opts; i++)
1306 while (i < nr_job_sections) {
1307 free(job_sections[i]);
1311 for (i = 0; i < num_opts; i++)
1317 if (!is_buf && f != stdin)
1322 static int fill_def_thread(void)
1324 memset(&def_thread, 0, sizeof(def_thread));
1326 fio_getaffinity(getpid(), &def_thread.o.cpumask);
1327 def_thread.o.timeout = def_timeout;
1328 def_thread.o.error_dump = 1;
1330 * fill default options
1332 fio_fill_default_options(&def_thread);
1336 static void usage(const char *name)
1338 printf("%s\n", fio_version_string);
1339 printf("%s [options] [job options] <job file(s)>\n", name);
1340 printf(" --debug=options\tEnable debug logging. May be one/more of:\n"
1341 "\t\t\tprocess,file,io,mem,blktrace,verify,random,parse,\n"
1342 "\t\t\tdiskutil,job,mutex,profile,time,net\n");
1343 printf(" --parse-only\t\tParse options only, don't start any IO\n");
1344 printf(" --output\t\tWrite output to file\n");
1345 printf(" --runtime\t\tRuntime in seconds\n");
1346 printf(" --latency-log\t\tGenerate per-job latency logs\n");
1347 printf(" --bandwidth-log\tGenerate per-job bandwidth logs\n");
1348 printf(" --minimal\t\tMinimal (terse) output\n");
1349 printf(" --output-format=x\tOutput format (terse,json,normal)\n");
1350 printf(" --terse-version=x\tSet terse version output format to 'x'\n");
1351 printf(" --version\t\tPrint version info and exit\n");
1352 printf(" --help\t\tPrint this page\n");
1353 printf(" --cpuclock-test\tPerform test/validation of CPU clock\n");
1354 printf(" --cmdhelp=cmd\t\tPrint command help, \"all\" for all of"
1356 printf(" --enghelp=engine\tPrint ioengine help, or list"
1357 " available ioengines\n");
1358 printf(" --enghelp=engine,cmd\tPrint help for an ioengine"
1360 printf(" --showcmd\t\tTurn a job file into command line options\n");
1361 printf(" --eta=when\t\tWhen ETA estimate should be printed\n");
1362 printf(" \t\tMay be \"always\", \"never\" or \"auto\"\n");
1363 printf(" --eta-newline=time\tForce a new line for every 'time'");
1364 printf(" period passed\n");
1365 printf(" --readonly\t\tTurn on safety read-only checks, preventing"
1367 printf(" --section=name\tOnly run specified section in job file\n");
1368 printf(" --alloc-size=kb\tSet smalloc pool to this size in kb"
1370 printf(" --warnings-fatal\tFio parser warnings are fatal\n");
1371 printf(" --max-jobs=nr\t\tMaximum number of threads/processes to support\n");
1372 printf(" --server=args\t\tStart a backend fio server\n");
1373 printf(" --daemonize=pidfile\tBackground fio server, write pid to file\n");
1374 printf(" --client=hostname\tTalk to remote backend fio server at hostname\n");
1375 printf(" --idle-prof=option\tReport cpu idleness on a system or percpu basis\n"
1376 "\t\t\t(option=system,percpu) or run unit work\n"
1377 "\t\t\tcalibration only (option=calibrate)\n");
1378 printf("\nFio was written by Jens Axboe <jens.axboe@oracle.com>");
1379 printf("\n Jens Axboe <jaxboe@fusionio.com>\n");
1382 #ifdef FIO_INC_DEBUG
1383 struct debug_level debug_levels[] = {
1384 { .name = "process",
1385 .help = "Process creation/exit logging",
1386 .shift = FD_PROCESS,
1389 .help = "File related action logging",
1393 .help = "IO and IO engine action logging (offsets, queue, completions, etc)",
1397 .help = "Memory allocation/freeing logging",
1400 { .name = "blktrace",
1401 .help = "blktrace action logging",
1402 .shift = FD_BLKTRACE,
1405 .help = "IO verification action logging",
1409 .help = "Random generation logging",
1413 .help = "Parser logging",
1416 { .name = "diskutil",
1417 .help = "Disk utility logging actions",
1418 .shift = FD_DISKUTIL,
1421 .help = "Logging related to creating/destroying jobs",
1425 .help = "Mutex logging",
1428 { .name = "profile",
1429 .help = "Logging related to profiles",
1430 .shift = FD_PROFILE,
1433 .help = "Logging related to time keeping functions",
1437 .help = "Network logging",
1443 static int set_debug(const char *string)
1445 struct debug_level *dl;
1446 char *p = (char *) string;
1450 if (!strcmp(string, "?") || !strcmp(string, "help")) {
1451 log_info("fio: dumping debug options:");
1452 for (i = 0; debug_levels[i].name; i++) {
1453 dl = &debug_levels[i];
1454 log_info("%s,", dl->name);
1460 while ((opt = strsep(&p, ",")) != NULL) {
1463 if (!strncmp(opt, "all", 3)) {
1464 log_info("fio: set all debug options\n");
1469 for (i = 0; debug_levels[i].name; i++) {
1470 dl = &debug_levels[i];
1471 found = !strncmp(opt, dl->name, strlen(dl->name));
1475 if (dl->shift == FD_JOB) {
1476 opt = strchr(opt, ':');
1478 log_err("fio: missing job number\n");
1482 fio_debug_jobno = atoi(opt);
1483 log_info("fio: set debug jobno %d\n",
1486 log_info("fio: set debug option %s\n", opt);
1487 fio_debug |= (1UL << dl->shift);
1493 log_err("fio: debug mask %s not found\n", opt);
1498 static int set_debug(const char *string)
1500 log_err("fio: debug tracing not included in build\n");
1505 static void fio_options_fill_optstring(void)
1507 char *ostr = cmd_optstr;
1511 while (l_opts[i].name) {
1512 ostr[c++] = l_opts[i].val;
1513 if (l_opts[i].has_arg == required_argument)
1515 else if (l_opts[i].has_arg == optional_argument) {
1524 static int client_flag_set(char c)
1529 while (l_opts[i].name) {
1530 int val = l_opts[i].val;
1532 if (c == (val & 0xff))
1533 return (val & FIO_CLIENT_FLAG);
1541 void parse_cmd_client(void *client, char *opt)
1543 fio_client_add_cmd_option(client, opt);
1546 int parse_cmd_line(int argc, char *argv[], int client_type)
1548 struct thread_data *td = NULL;
1549 int c, ini_idx = 0, lidx, ret = 0, do_exit = 0, exit_val = 0;
1550 char *ostr = cmd_optstr;
1551 void *pid_file = NULL;
1552 void *cur_client = NULL;
1556 * Reset optind handling, since we may call this multiple times
1561 while ((c = getopt_long_only(argc, argv, ostr, l_opts, &lidx)) != -1) {
1564 if ((c & FIO_CLIENT_FLAG) || client_flag_set(c)) {
1565 parse_cmd_client(cur_client, argv[optind - 1]);
1566 c &= ~FIO_CLIENT_FLAG;
1571 smalloc_pool_size = atoi(optarg);
1574 def_timeout = atoi(optarg);
1583 f_out = fopen(optarg, "w+");
1585 perror("fopen output");
1591 output_format = FIO_OUTPUT_TERSE;
1594 if (!strcmp(optarg, "minimal") ||
1595 !strcmp(optarg, "terse") ||
1596 !strcmp(optarg, "csv"))
1597 output_format = FIO_OUTPUT_TERSE;
1598 else if (!strcmp(optarg, "json"))
1599 output_format = FIO_OUTPUT_JSON;
1601 output_format = FIO_OUTPUT_NORMAL;
1611 fio_show_option_help(optarg);
1617 fio_show_ioengine_help(optarg);
1629 log_info("%s\n", fio_version_string);
1634 terse_version = atoi(optarg);
1635 if (!(terse_version == 2 || terse_version == 3 ||
1636 terse_version == 4)) {
1637 log_err("fio: bad terse version format\n");
1643 if (!strcmp("always", optarg))
1644 eta_print = FIO_ETA_ALWAYS;
1645 else if (!strcmp("never", optarg))
1646 eta_print = FIO_ETA_NEVER;
1651 if (str_to_decimal(optarg, &t, 0, NULL)) {
1652 log_err("fio: failed parsing eta time %s\n", optarg);
1660 if (set_debug(optarg))
1669 if (!strcmp(optarg, "global")) {
1670 log_err("fio: can't use global as only "
1676 new_size = (nr_job_sections + 1) * sizeof(char *);
1677 job_sections = realloc(job_sections, new_size);
1678 job_sections[nr_job_sections] = strdup(optarg);
1683 exec_profile = strdup(optarg);
1685 case FIO_GETOPT_JOB: {
1686 const char *opt = l_opts[lidx].name;
1689 if (!strncmp(opt, "name", 4) && td) {
1690 ret = add_job(td, td->o.name ?: "fio", 0, 0, client_type);
1696 int is_section = !strncmp(opt, "name", 4);
1699 if (!is_section || !strncmp(val, "global", 6))
1702 if (is_section && skip_this_section(val))
1705 td = get_new_job(global, &def_thread, 1);
1706 if (!td || ioengine_load(td))
1708 fio_options_set_ioengine_opts(l_opts, td);
1711 ret = fio_cmd_option_parse(td, opt, val);
1713 if (!ret && !strcmp(opt, "ioengine")) {
1715 if (ioengine_load(td))
1717 fio_options_set_ioengine_opts(l_opts, td);
1721 case FIO_GETOPT_IOENGINE: {
1722 const char *opt = l_opts[lidx].name;
1724 opt = l_opts[lidx].name;
1726 ret = fio_cmd_ioengine_option_parse(td, opt, val);
1733 max_jobs = atoi(optarg);
1734 if (!max_jobs || max_jobs > REAL_MAX_JOBS) {
1735 log_err("fio: invalid max jobs: %d\n", max_jobs);
1742 log_err("fio: can't be both client and server\n");
1748 fio_server_set_arg(optarg);
1753 pid_file = strdup(optarg);
1756 if ((ret = fio_idle_prof_parse_opt(optarg))) {
1757 /* exit on error and calibration only */
1765 log_err("fio: can't be both client and server\n");
1770 if (fio_client_add(&fio_client_ops, optarg, &cur_client)) {
1771 log_err("fio: failed adding client %s\n", optarg);
1777 * If the next argument exists and isn't an option,
1778 * assume it's a job file for this client only.
1780 while (optind < argc) {
1781 if (!strncmp(argv[optind], "--", 2) ||
1782 !strncmp(argv[optind], "-", 1))
1785 fio_client_add_ini_file(cur_client, argv[optind]);
1791 exit_val = fio_monotonic_clocktest();
1794 log_err("%s: unrecognized option '%s'\n", argv[0],
1806 if (exit_val && !(is_backend || nr_clients))
1810 if (nr_clients && fio_clients_connect()) {
1816 if (is_backend && backend)
1817 return fio_start_server(pid_file);
1821 ret = add_job(td, td->o.name ?: "fio", 0, 0, client_type);
1824 while (!ret && optind < argc) {
1826 ini_file = realloc(ini_file, ini_idx * sizeof(char *));
1827 ini_file[ini_idx - 1] = strdup(argv[optind]);
1834 int fio_init_options(void)
1839 fio_options_fill_optstring();
1840 fio_options_dup_and_init(l_opts);
1844 if (fill_def_thread())
1850 extern int fio_check_options(struct thread_options *);
1852 int parse_options(int argc, char *argv[])
1854 const int type = FIO_CLIENT_TYPE_CLI;
1857 if (fio_init_options())
1859 if (fio_test_cconv(&def_thread.o))
1860 log_err("fio: failed internal cconv test\n");
1862 job_files = parse_cmd_line(argc, argv, type);
1864 if (job_files > 0) {
1865 for (i = 0; i < job_files; i++) {
1866 if (fill_def_thread())
1869 if (fio_clients_send_ini(ini_file[i]))
1872 } else if (!is_backend) {
1873 if (parse_jobs_ini(ini_file[i], 0, i, type))
1878 } else if (nr_clients) {
1879 if (fill_def_thread())
1881 if (fio_clients_send_ini(NULL))
1886 fio_options_free(&def_thread);
1888 if (!thread_number) {
1889 if (dump_cmdline || parse_only)
1893 if (is_backend || nr_clients)
1898 log_err("No jobs(s) defined\n\n");
1908 if (def_thread.o.gtod_offload) {
1910 fio_gtod_offload = 1;
1911 fio_gtod_cpu = def_thread.o.gtod_cpu;
1914 if (output_format == FIO_OUTPUT_NORMAL)
1915 log_info("%s\n", fio_version_string);
1920 void options_default_fill(struct thread_options *o)
1922 memcpy(o, &def_thread.o, sizeof(*o));