2 * This file contains job initialization and setup functions.
12 #ifndef FIO_NO_HAVE_SHM_H
15 #include <sys/types.h>
27 #include "lib/getopt.h"
29 const char fio_version_string[] = FIO_VERSION;
31 #define FIO_RANDSEED (0xb1899bedUL)
33 static char **ini_file;
34 static int max_jobs = FIO_MAX_JOBS;
35 static int dump_cmdline;
36 static int def_timeout;
38 static struct thread_data def_thread;
39 struct thread_data *threads = NULL;
41 int exitall_on_terminate = 0;
42 int output_format = FIO_OUTPUT_NORMAL;
43 int eta_print = FIO_ETA_AUTO;
46 char **job_sections = NULL;
47 int nr_job_sections = 0;
48 char *exec_profile = NULL;
49 int warnings_fatal = 0;
50 int terse_version = 3;
58 static int write_lat_log;
60 static int prev_group_jobs;
62 unsigned long fio_debug = 0;
63 unsigned int fio_debug_jobno = -1;
64 unsigned int *fio_debug_jobp = NULL;
66 static char cmd_optstr[256];
69 #define FIO_CLIENT_FLAG (1 << 16)
72 * Command line options. These will contain the above, plus a few
73 * extra that only pertain to fio itself and not jobs.
75 static struct option l_opts[FIO_NR_OPTIONS] = {
77 .name = (char *) "output",
78 .has_arg = required_argument,
79 .val = 'o' | FIO_CLIENT_FLAG,
82 .name = (char *) "timeout",
83 .has_arg = required_argument,
84 .val = 't' | FIO_CLIENT_FLAG,
87 .name = (char *) "latency-log",
88 .has_arg = required_argument,
89 .val = 'l' | FIO_CLIENT_FLAG,
92 .name = (char *) "bandwidth-log",
93 .has_arg = required_argument,
94 .val = 'b' | FIO_CLIENT_FLAG,
97 .name = (char *) "minimal",
98 .has_arg = optional_argument,
99 .val = 'm' | FIO_CLIENT_FLAG,
102 .name = (char *) "output-format",
103 .has_arg = optional_argument,
104 .val = 'F' | FIO_CLIENT_FLAG,
107 .name = (char *) "version",
108 .has_arg = no_argument,
109 .val = 'v' | FIO_CLIENT_FLAG,
112 .name = (char *) "help",
113 .has_arg = no_argument,
114 .val = 'h' | FIO_CLIENT_FLAG,
117 .name = (char *) "cmdhelp",
118 .has_arg = optional_argument,
119 .val = 'c' | FIO_CLIENT_FLAG,
122 .name = (char *) "enghelp",
123 .has_arg = optional_argument,
124 .val = 'i' | FIO_CLIENT_FLAG,
127 .name = (char *) "showcmd",
128 .has_arg = no_argument,
129 .val = 's' | FIO_CLIENT_FLAG,
132 .name = (char *) "readonly",
133 .has_arg = no_argument,
134 .val = 'r' | FIO_CLIENT_FLAG,
137 .name = (char *) "eta",
138 .has_arg = required_argument,
139 .val = 'e' | FIO_CLIENT_FLAG,
142 .name = (char *) "debug",
143 .has_arg = required_argument,
144 .val = 'd' | FIO_CLIENT_FLAG,
147 .name = (char *) "section",
148 .has_arg = required_argument,
149 .val = 'x' | FIO_CLIENT_FLAG,
152 .name = (char *) "alloc-size",
153 .has_arg = required_argument,
154 .val = 'a' | FIO_CLIENT_FLAG,
157 .name = (char *) "profile",
158 .has_arg = required_argument,
159 .val = 'p' | FIO_CLIENT_FLAG,
162 .name = (char *) "warnings-fatal",
163 .has_arg = no_argument,
164 .val = 'w' | FIO_CLIENT_FLAG,
167 .name = (char *) "max-jobs",
168 .has_arg = required_argument,
169 .val = 'j' | FIO_CLIENT_FLAG,
172 .name = (char *) "terse-version",
173 .has_arg = required_argument,
174 .val = 'V' | FIO_CLIENT_FLAG,
177 .name = (char *) "server",
178 .has_arg = optional_argument,
181 { .name = (char *) "daemonize",
182 .has_arg = required_argument,
186 .name = (char *) "client",
187 .has_arg = required_argument,
191 .name = (char *) "cpuclock-test",
192 .has_arg = no_argument,
196 .name = (char *) "idle-prof",
197 .has_arg = required_argument,
205 void free_threads_shm(void)
207 struct shmid_ds sbuf;
214 shmctl(shm_id, IPC_RMID, &sbuf);
224 fio_debug_jobp = NULL;
232 * The thread area is shared between the main process and the job
233 * threads/processes. So setup a shared memory segment that will hold
234 * all the job info. We use the end of the region for keeping track of
235 * open files across jobs, for file sharing.
237 static int setup_thread_area(void)
245 * 1024 is too much on some machines, scale max_jobs if
246 * we get a failure that looks like too large a shm segment
249 size_t size = max_jobs * sizeof(struct thread_data);
251 size += file_hash_size;
252 size += sizeof(unsigned int);
254 shm_id = shmget(0, size, IPC_CREAT | 0600);
257 if (errno != EINVAL && errno != ENOMEM && errno != ENOSPC) {
268 threads = shmat(shm_id, NULL, 0);
269 if (threads == (void *) -1) {
274 memset(threads, 0, max_jobs * sizeof(struct thread_data));
275 hash = (void *) threads + max_jobs * sizeof(struct thread_data);
276 fio_debug_jobp = (void *) hash + file_hash_size;
277 *fio_debug_jobp = -1;
278 file_hash_init(hash);
286 * Return a free job structure.
288 static struct thread_data *get_new_job(int global, struct thread_data *parent,
291 struct thread_data *td;
295 if (setup_thread_area()) {
296 log_err("error: failed to setup shm segment\n");
299 if (thread_number >= max_jobs) {
300 log_err("error: maximum number of jobs (%d) reached.\n",
305 td = &threads[thread_number++];
312 td->o.uid = td->o.gid = -1U;
314 dup_files(td, parent);
315 fio_options_mem_dupe(td);
317 profile_add_hooks(td);
319 td->thread_number = thread_number;
321 if (!parent || !parent->o.group_reporting)
327 static void put_job(struct thread_data *td)
329 if (td == &def_thread)
336 log_info("fio: %s\n", td->verror);
338 fio_options_free(td);
342 memset(&threads[td->thread_number - 1], 0, sizeof(*td));
346 static int __setup_rate(struct thread_data *td, enum fio_ddir ddir)
348 unsigned int bs = td->o.min_bs[ddir];
350 assert(ddir_rw(ddir));
352 if (td->o.rate[ddir])
353 td->rate_bps[ddir] = td->o.rate[ddir];
355 td->rate_bps[ddir] = td->o.rate_iops[ddir] * bs;
357 if (!td->rate_bps[ddir]) {
358 log_err("rate lower than supported\n");
362 td->rate_pending_usleep[ddir] = 0;
366 static int setup_rate(struct thread_data *td)
370 if (td->o.rate[DDIR_READ] || td->o.rate_iops[DDIR_READ])
371 ret = __setup_rate(td, DDIR_READ);
372 if (td->o.rate[DDIR_WRITE] || td->o.rate_iops[DDIR_WRITE])
373 ret |= __setup_rate(td, DDIR_WRITE);
374 if (td->o.rate[DDIR_TRIM] || td->o.rate_iops[DDIR_TRIM])
375 ret |= __setup_rate(td, DDIR_TRIM);
380 static int fixed_block_size(struct thread_options *o)
382 return o->min_bs[DDIR_READ] == o->max_bs[DDIR_READ] &&
383 o->min_bs[DDIR_WRITE] == o->max_bs[DDIR_WRITE] &&
384 o->min_bs[DDIR_TRIM] == o->max_bs[DDIR_TRIM] &&
385 o->min_bs[DDIR_READ] == o->min_bs[DDIR_WRITE] &&
386 o->min_bs[DDIR_READ] == o->min_bs[DDIR_TRIM];
390 * Lazy way of fixing up options that depend on each other. We could also
391 * define option callback handlers, but this is easier.
393 static int fixup_options(struct thread_data *td)
395 struct thread_options *o = &td->o;
398 #ifndef FIO_HAVE_PSHARED_MUTEX
399 if (!o->use_thread) {
400 log_info("fio: this platform does not support process shared"
401 " mutexes, forcing use of threads. Use the 'thread'"
402 " option to get rid of this warning.\n");
404 ret = warnings_fatal;
408 if (o->write_iolog_file && o->read_iolog_file) {
409 log_err("fio: read iolog overrides write_iolog\n");
410 free(o->write_iolog_file);
411 o->write_iolog_file = NULL;
412 ret = warnings_fatal;
416 * only really works with 1 file
418 if (o->zone_size && o->open_files > 1)
422 * If zone_range isn't specified, backward compatibility dictates it
423 * should be made equal to zone_size.
425 if (o->zone_size && !o->zone_range)
426 o->zone_range = o->zone_size;
429 * Reads can do overwrites, we always need to pre-create the file
431 if (td_read(td) || td_rw(td))
434 if (!o->min_bs[DDIR_READ])
435 o->min_bs[DDIR_READ] = o->bs[DDIR_READ];
436 if (!o->max_bs[DDIR_READ])
437 o->max_bs[DDIR_READ] = o->bs[DDIR_READ];
438 if (!o->min_bs[DDIR_WRITE])
439 o->min_bs[DDIR_WRITE] = o->bs[DDIR_WRITE];
440 if (!o->max_bs[DDIR_WRITE])
441 o->max_bs[DDIR_WRITE] = o->bs[DDIR_WRITE];
442 if (!o->min_bs[DDIR_TRIM])
443 o->min_bs[DDIR_TRIM] = o->bs[DDIR_TRIM];
444 if (!o->max_bs[DDIR_TRIM])
445 o->max_bs[DDIR_TRIM] = o->bs[DDIR_TRIM];
448 o->rw_min_bs = min(o->min_bs[DDIR_READ], o->min_bs[DDIR_WRITE]);
449 o->rw_min_bs = min(o->min_bs[DDIR_TRIM], o->rw_min_bs);
452 * For random IO, allow blockalign offset other than min_bs.
454 if (!o->ba[DDIR_READ] || !td_random(td))
455 o->ba[DDIR_READ] = o->min_bs[DDIR_READ];
456 if (!o->ba[DDIR_WRITE] || !td_random(td))
457 o->ba[DDIR_WRITE] = o->min_bs[DDIR_WRITE];
458 if (!o->ba[DDIR_TRIM] || !td_random(td))
459 o->ba[DDIR_TRIM] = o->min_bs[DDIR_TRIM];
461 if ((o->ba[DDIR_READ] != o->min_bs[DDIR_READ] ||
462 o->ba[DDIR_WRITE] != o->min_bs[DDIR_WRITE] ||
463 o->ba[DDIR_TRIM] != o->min_bs[DDIR_TRIM]) &&
465 log_err("fio: Any use of blockalign= turns off randommap\n");
467 ret = warnings_fatal;
470 if (!o->file_size_high)
471 o->file_size_high = o->file_size_low;
473 if (o->norandommap && o->verify != VERIFY_NONE
474 && !fixed_block_size(o)) {
475 log_err("fio: norandommap given for variable block sizes, "
476 "verify disabled\n");
477 o->verify = VERIFY_NONE;
478 ret = warnings_fatal;
480 if (o->bs_unaligned && (o->odirect || td->io_ops->flags & FIO_RAWIO))
481 log_err("fio: bs_unaligned may not work with raw io\n");
484 * thinktime_spin must be less than thinktime
486 if (o->thinktime_spin > o->thinktime)
487 o->thinktime_spin = o->thinktime;
490 * The low water mark cannot be bigger than the iodepth
492 if (o->iodepth_low > o->iodepth || !o->iodepth_low)
493 o->iodepth_low = o->iodepth;
496 * If batch number isn't set, default to the same as iodepth
498 if (o->iodepth_batch > o->iodepth || !o->iodepth_batch)
499 o->iodepth_batch = o->iodepth;
501 if (o->nr_files > td->files_index)
502 o->nr_files = td->files_index;
504 if (o->open_files > o->nr_files || !o->open_files)
505 o->open_files = o->nr_files;
507 if (((o->rate[DDIR_READ] + o->rate[DDIR_WRITE] + o->rate[DDIR_TRIM]) &&
508 (o->rate_iops[DDIR_READ] + o->rate_iops[DDIR_WRITE] + o->rate_iops[DDIR_TRIM])) ||
509 ((o->ratemin[DDIR_READ] + o->ratemin[DDIR_WRITE] + o->ratemin[DDIR_TRIM]) &&
510 (o->rate_iops_min[DDIR_READ] + o->rate_iops_min[DDIR_WRITE] + o->rate_iops_min[DDIR_TRIM]))) {
511 log_err("fio: rate and rate_iops are mutually exclusive\n");
514 if ((o->rate[DDIR_READ] < o->ratemin[DDIR_READ]) ||
515 (o->rate[DDIR_WRITE] < o->ratemin[DDIR_WRITE]) ||
516 (o->rate[DDIR_TRIM] < o->ratemin[DDIR_TRIM]) ||
517 (o->rate_iops[DDIR_READ] < o->rate_iops_min[DDIR_READ]) ||
518 (o->rate_iops[DDIR_WRITE] < o->rate_iops_min[DDIR_WRITE]) ||
519 (o->rate_iops[DDIR_TRIM] < o->rate_iops_min[DDIR_TRIM])) {
520 log_err("fio: minimum rate exceeds rate\n");
524 if (!o->timeout && o->time_based) {
525 log_err("fio: time_based requires a runtime/timeout setting\n");
527 ret = warnings_fatal;
530 if (o->fill_device && !o->size)
533 if (o->verify != VERIFY_NONE) {
534 if (td_write(td) && o->do_verify && o->numjobs > 1) {
535 log_info("Multiple writers may overwrite blocks that "
536 "belong to other jobs. This can cause "
537 "verification failures.\n");
538 ret = warnings_fatal;
541 o->refill_buffers = 1;
542 if (o->max_bs[DDIR_WRITE] != o->min_bs[DDIR_WRITE] &&
544 o->verify_interval = o->min_bs[DDIR_WRITE];
548 o->invalidate_cache = 0;
549 if (td->io_ops->flags & FIO_PIPEIO) {
550 log_info("fio: cannot pre-read files with an IO engine"
551 " that isn't seekable. Pre-read disabled.\n");
552 ret = warnings_fatal;
556 #ifndef CONFIG_FDATASYNC
557 if (o->fdatasync_blocks) {
558 log_info("fio: this platform does not support fdatasync()"
559 " falling back to using fsync(). Use the 'fsync'"
560 " option instead of 'fdatasync' to get rid of"
562 o->fsync_blocks = o->fdatasync_blocks;
563 o->fdatasync_blocks = 0;
564 ret = warnings_fatal;
570 * Windows doesn't support O_DIRECT or O_SYNC with the _open interface,
571 * so fail if we're passed those flags
573 if ((td->io_ops->flags & FIO_SYNCIO) && (td->o.odirect || td->o.sync_io)) {
574 log_err("fio: Windows does not support direct or non-buffered io with"
575 " the synchronous ioengines. Use the 'windowsaio' ioengine"
576 " with 'direct=1' and 'iodepth=1' instead.\n");
582 * For fully compressible data, just zero them at init time.
583 * It's faster than repeatedly filling it.
585 if (td->o.compress_percentage == 100) {
586 td->o.zero_buffers = 1;
587 td->o.compress_percentage = 0;
591 * Using a non-uniform random distribution excludes usage of
594 if (td->o.random_distribution != FIO_RAND_DIST_RANDOM)
595 td->o.norandommap = 1;
601 * This function leaks the buffer
603 char *fio_uint_to_kmg(unsigned int val)
605 char *buf = malloc(32);
606 char post[] = { 0, 'K', 'M', 'G', 'P', 'E', 0 };
617 snprintf(buf, 32, "%u%c", val, *p);
621 /* External engines are specified by "external:name.o") */
622 static const char *get_engine_name(const char *str)
624 char *p = strstr(str, ":");
630 strip_blank_front(&p);
635 static int exists_and_not_file(const char *filename)
639 if (lstat(filename, &sb) == -1)
642 /* \\.\ is the device namespace in Windows, where every file
643 * is a device node */
644 if (S_ISREG(sb.st_mode) && strncmp(filename, "\\\\.\\", 4) != 0)
650 static void td_fill_rand_seeds_os(struct thread_data *td)
652 os_random_seed(td->rand_seeds[FIO_RAND_BS_OFF], &td->bsrange_state);
653 os_random_seed(td->rand_seeds[FIO_RAND_VER_OFF], &td->verify_state);
654 os_random_seed(td->rand_seeds[FIO_RAND_MIX_OFF], &td->rwmix_state);
656 if (td->o.file_service_type == FIO_FSERVICE_RANDOM)
657 os_random_seed(td->rand_seeds[FIO_RAND_FILE_OFF], &td->next_file_state);
659 os_random_seed(td->rand_seeds[FIO_RAND_FILE_SIZE_OFF], &td->file_size_state);
660 os_random_seed(td->rand_seeds[FIO_RAND_TRIM_OFF], &td->trim_state);
665 if (td->o.rand_repeatable)
666 td->rand_seeds[FIO_RAND_BLOCK_OFF] = FIO_RANDSEED * td->thread_number;
668 os_random_seed(td->rand_seeds[FIO_RAND_BLOCK_OFF], &td->random_state);
671 static void td_fill_rand_seeds_internal(struct thread_data *td)
673 init_rand_seed(&td->__bsrange_state, td->rand_seeds[FIO_RAND_BS_OFF]);
674 init_rand_seed(&td->__verify_state, td->rand_seeds[FIO_RAND_VER_OFF]);
675 init_rand_seed(&td->__rwmix_state, td->rand_seeds[FIO_RAND_MIX_OFF]);
677 if (td->o.file_service_type == FIO_FSERVICE_RANDOM)
678 init_rand_seed(&td->__next_file_state, td->rand_seeds[FIO_RAND_FILE_OFF]);
680 init_rand_seed(&td->__file_size_state, td->rand_seeds[FIO_RAND_FILE_SIZE_OFF]);
681 init_rand_seed(&td->__trim_state, td->rand_seeds[FIO_RAND_TRIM_OFF]);
686 if (td->o.rand_repeatable)
687 td->rand_seeds[FIO_RAND_BLOCK_OFF] = FIO_RANDSEED * td->thread_number;
689 init_rand_seed(&td->__random_state, td->rand_seeds[FIO_RAND_BLOCK_OFF]);
692 void td_fill_rand_seeds(struct thread_data *td)
694 if (td->o.use_os_rand)
695 td_fill_rand_seeds_os(td);
697 td_fill_rand_seeds_internal(td);
699 init_rand_seed(&td->buf_state, td->rand_seeds[FIO_RAND_BUF_OFF]);
703 * Initializes the ioengine configured for a job, if it has not been done so
706 int ioengine_load(struct thread_data *td)
711 * Engine has already been loaded.
716 engine = get_engine_name(td->o.ioengine);
717 td->io_ops = load_ioengine(td, engine);
719 log_err("fio: failed to load engine %s\n", engine);
723 if (td->io_ops->option_struct_size && td->io_ops->options) {
725 * In cases where td->eo is set, clone it for a child thread.
726 * This requires that the parent thread has the same ioengine,
727 * but that requirement must be enforced by the code which
730 void *origeo = td->eo;
732 * Otherwise use the default thread options.
734 if (!origeo && td != &def_thread && def_thread.eo &&
735 def_thread.io_ops->options == td->io_ops->options)
736 origeo = def_thread.eo;
738 options_init(td->io_ops->options);
739 td->eo = malloc(td->io_ops->option_struct_size);
741 * Use the default thread as an option template if this uses the
742 * same options structure and there are non-default options
746 memcpy(td->eo, origeo, td->io_ops->option_struct_size);
747 options_mem_dupe(td->eo, td->io_ops->options);
749 memset(td->eo, 0, td->io_ops->option_struct_size);
750 fill_default_options(td->eo, td->io_ops->options);
752 *(struct thread_data **)td->eo = td;
758 static void init_flags(struct thread_data *td)
760 struct thread_options *o = &td->o;
762 if (o->verify_backlog)
763 td->flags |= TD_F_VER_BACKLOG;
765 td->flags |= TD_F_TRIM_BACKLOG;
766 if (o->read_iolog_file)
767 td->flags |= TD_F_READ_IOLOG;
768 if (o->refill_buffers)
769 td->flags |= TD_F_REFILL_BUFFERS;
770 if (o->scramble_buffers)
771 td->flags |= TD_F_SCRAMBLE_BUFFERS;
772 if (o->verify != VERIFY_NONE)
773 td->flags |= TD_F_VER_NONE;
776 static int setup_random_seeds(struct thread_data *td)
781 if (!td->o.rand_repeatable)
782 return init_random_state(td, td->rand_seeds, sizeof(td->rand_seeds));
784 for (seed = 0x89, i = 0; i < 4; i++)
785 seed *= 0x9e370001UL;
787 for (i = 0; i < FIO_RAND_NR_OFFS; i++) {
788 td->rand_seeds[i] = seed;
789 seed *= 0x9e370001UL;
792 td_fill_rand_seeds(td);
797 * Adds a job to the list of things todo. Sanitizes the various options
798 * to make sure we don't have conflicts, and initializes various
801 static int add_job(struct thread_data *td, const char *jobname, int job_add_num,
802 int recursed, int client_type)
805 char fname[PATH_MAX];
806 int numjobs, file_alloced;
809 * the def_thread is just for options, it's not a real job
811 if (td == &def_thread)
817 * if we are just dumping the output command line, don't add the job
824 td->client_type = client_type;
826 if (profile_td_init(td))
829 if (ioengine_load(td))
833 td->io_ops->flags |= FIO_RAWIO;
836 if (!td->o.filename && !td->files_index && !td->o.read_iolog_file) {
839 if (td->o.nr_files == 1 && exists_and_not_file(jobname))
840 add_file(td, jobname);
842 for (i = 0; i < td->o.nr_files; i++) {
843 sprintf(fname, "%s.%d.%d", jobname,
844 td->thread_number, i);
850 if (fixup_options(td))
856 * IO engines only need this for option callbacks, and the address may
857 * change in subprocesses.
860 *(struct thread_data **)td->eo = NULL;
862 if (td->io_ops->flags & FIO_DISKLESSIO) {
865 for_each_file(td, f, i)
866 f->real_file_size = -1ULL;
869 td->mutex = fio_mutex_init(FIO_MUTEX_LOCKED);
871 td->ts.clat_percentiles = td->o.clat_percentiles;
872 td->ts.percentile_precision = td->o.percentile_precision;
873 memcpy(td->ts.percentile_list, td->o.percentile_list, sizeof(td->o.percentile_list));
875 for (i = 0; i < DDIR_RWDIR_CNT; i++) {
876 td->ts.clat_stat[i].min_val = ULONG_MAX;
877 td->ts.slat_stat[i].min_val = ULONG_MAX;
878 td->ts.lat_stat[i].min_val = ULONG_MAX;
879 td->ts.bw_stat[i].min_val = ULONG_MAX;
881 td->ddir_seq_nr = td->o.ddir_seq_nr;
883 if ((td->o.stonewall || td->o.new_group) && prev_group_jobs) {
888 td->groupid = groupid;
891 if (setup_random_seeds(td)) {
892 td_verror(td, errno, "init_random_state");
899 if (td->o.lat_log_file) {
900 setup_log(&td->lat_log, td->o.log_avg_msec, IO_LOG_TYPE_LAT);
901 setup_log(&td->slat_log, td->o.log_avg_msec, IO_LOG_TYPE_SLAT);
902 setup_log(&td->clat_log, td->o.log_avg_msec, IO_LOG_TYPE_CLAT);
904 if (td->o.bw_log_file)
905 setup_log(&td->bw_log, td->o.log_avg_msec, IO_LOG_TYPE_BW);
906 if (td->o.iops_log_file)
907 setup_log(&td->iops_log, td->o.log_avg_msec, IO_LOG_TYPE_IOPS);
910 td->o.name = strdup(jobname);
912 if (output_format == FIO_OUTPUT_NORMAL) {
914 if (is_backend && !recursed)
915 fio_server_send_add_job(td);
917 if (!(td->io_ops->flags & FIO_NOIO)) {
918 char *c1, *c2, *c3, *c4, *c5, *c6;
920 c1 = fio_uint_to_kmg(td->o.min_bs[DDIR_READ]);
921 c2 = fio_uint_to_kmg(td->o.max_bs[DDIR_READ]);
922 c3 = fio_uint_to_kmg(td->o.min_bs[DDIR_WRITE]);
923 c4 = fio_uint_to_kmg(td->o.max_bs[DDIR_WRITE]);
924 c5 = fio_uint_to_kmg(td->o.min_bs[DDIR_TRIM]);
925 c6 = fio_uint_to_kmg(td->o.max_bs[DDIR_TRIM]);
927 log_info("%s: (g=%d): rw=%s, bs=%s-%s/%s-%s/%s-%s,"
928 " ioengine=%s, iodepth=%u\n",
929 td->o.name, td->groupid,
930 ddir_str(td->o.td_ddir),
931 c1, c2, c3, c4, c5, c6,
942 } else if (job_add_num == 1)
947 * recurse add identical jobs, clear numjobs and stonewall options
948 * as they don't apply to sub-jobs
950 numjobs = td->o.numjobs;
952 struct thread_data *td_new = get_new_job(0, td, 1);
957 td_new->o.numjobs = 1;
958 td_new->o.stonewall = 0;
959 td_new->o.new_group = 0;
962 td_new->o.filename = NULL;
963 td_new->files_index = 0;
964 td_new->files_size = 0;
965 td_new->files = NULL;
968 job_add_num = numjobs - 1;
970 if (add_job(td_new, jobname, job_add_num, 1, client_type))
981 * Parse as if 'o' was a command line
983 void add_job_opts(const char **o, int client_type)
985 struct thread_data *td, *td_parent;
986 int i, in_global = 1;
990 td_parent = td = NULL;
992 if (!strncmp(o[i], "name", 4)) {
995 add_job(td, jobname, 0, 0, client_type);
997 sprintf(jobname, "%s", o[i] + 5);
999 if (in_global && !td_parent)
1000 td_parent = get_new_job(1, &def_thread, 0);
1001 else if (!in_global && !td) {
1003 td_parent = &def_thread;
1004 td = get_new_job(0, td_parent, 0);
1007 fio_options_parse(td_parent, (char **) &o[i], 1);
1009 fio_options_parse(td, (char **) &o[i], 1);
1014 add_job(td, jobname, 0, 0, client_type);
1017 static int skip_this_section(const char *name)
1021 if (!nr_job_sections)
1023 if (!strncmp(name, "global", 6))
1026 for (i = 0; i < nr_job_sections; i++)
1027 if (!strcmp(job_sections[i], name))
1033 static int is_empty_or_comment(char *line)
1037 for (i = 0; i < strlen(line); i++) {
1042 if (!isspace((int) line[i]) && !iscntrl((int) line[i]))
1050 * This is our [ini] type file parser.
1052 int parse_jobs_ini(char *file, int is_buf, int stonewall_flag, int type)
1054 unsigned int global;
1055 struct thread_data *td;
1056 char *string, *name;
1059 int ret = 0, stonewall;
1062 int inside_skip = 0;
1064 int i, alloc_opts, num_opts;
1069 if (!strcmp(file, "-"))
1072 f = fopen(file, "r");
1075 perror("fopen job file");
1080 string = malloc(4096);
1083 * it's really 256 + small bit, 280 should suffice
1086 memset(name, 0, 280);
1089 opts = malloc(sizeof(char *) * alloc_opts);
1092 stonewall = stonewall_flag;
1095 * if skip_fgets is set, we already have loaded a line we
1100 p = strsep(&file, "\n");
1102 p = fgets(string, 4096, f);
1108 strip_blank_front(&p);
1111 if (is_empty_or_comment(p))
1113 if (sscanf(p, "[%255[^\n]]", name) != 1) {
1116 log_err("fio: option <%s> outside of [] job section\n",
1121 name[strlen(name) - 1] = '\0';
1123 if (skip_this_section(name)) {
1129 global = !strncmp(name, "global", 6);
1135 log_info("--name=%s ", name);
1139 td = get_new_job(global, &def_thread, 0);
1146 * Seperate multiple job files by a stonewall
1148 if (!global && stonewall) {
1149 td->o.stonewall = stonewall;
1154 memset(opts, 0, alloc_opts * sizeof(char *));
1158 p = strsep(&file, "\n");
1160 p = fgets(string, 4096, f);
1164 if (is_empty_or_comment(p))
1167 strip_blank_front(&p);
1170 * new section, break out and make sure we don't
1171 * fgets() a new line at the top.
1180 if (num_opts == alloc_opts) {
1182 opts = realloc(opts,
1183 alloc_opts * sizeof(char *));
1186 opts[num_opts] = strdup(p);
1190 ret = fio_options_parse(td, opts, num_opts);
1193 for (i = 0; i < num_opts; i++)
1194 log_info("--%s ", opts[i]);
1196 ret = add_job(td, name, 0, 0, type);
1198 log_err("fio: job %s dropped\n", name);
1202 for (i = 0; i < num_opts; i++)
1211 while (i < nr_job_sections) {
1212 free(job_sections[i]);
1216 for (i = 0; i < num_opts; i++)
1222 if (!is_buf && f != stdin)
1227 static int fill_def_thread(void)
1229 memset(&def_thread, 0, sizeof(def_thread));
1231 fio_getaffinity(getpid(), &def_thread.o.cpumask);
1232 def_thread.o.timeout = def_timeout;
1233 def_thread.o.error_dump = 1;
1235 * fill default options
1237 fio_fill_default_options(&def_thread);
1241 static void usage(const char *name)
1243 printf("%s\n", fio_version_string);
1244 printf("%s [options] [job options] <job file(s)>\n", name);
1245 printf(" --debug=options\tEnable debug logging. May be one/more of:\n"
1246 "\t\t\tprocess,file,io,mem,blktrace,verify,random,parse,\n"
1247 "\t\t\tdiskutil,job,mutex,profile,time,net\n");
1248 printf(" --output\t\tWrite output to file\n");
1249 printf(" --runtime\t\tRuntime in seconds\n");
1250 printf(" --latency-log\t\tGenerate per-job latency logs\n");
1251 printf(" --bandwidth-log\tGenerate per-job bandwidth logs\n");
1252 printf(" --minimal\t\tMinimal (terse) output\n");
1253 printf(" --output-format=x\tOutput format (terse,json,normal)\n");
1254 printf(" --terse-version=x\tSet terse version output format to 'x'\n");
1255 printf(" --version\t\tPrint version info and exit\n");
1256 printf(" --help\t\tPrint this page\n");
1257 printf(" --cpuclock-test\tPerform test/validation of CPU clock\n");
1258 printf(" --cmdhelp=cmd\t\tPrint command help, \"all\" for all of"
1260 printf(" --enghelp=engine\tPrint ioengine help, or list"
1261 " available ioengines\n");
1262 printf(" --enghelp=engine,cmd\tPrint help for an ioengine"
1264 printf(" --showcmd\t\tTurn a job file into command line options\n");
1265 printf(" --eta=when\t\tWhen ETA estimate should be printed\n");
1266 printf(" \t\tMay be \"always\", \"never\" or \"auto\"\n");
1267 printf(" --readonly\t\tTurn on safety read-only checks, preventing"
1269 printf(" --section=name\tOnly run specified section in job file\n");
1270 printf(" --alloc-size=kb\tSet smalloc pool to this size in kb"
1272 printf(" --warnings-fatal\tFio parser warnings are fatal\n");
1273 printf(" --max-jobs=nr\t\tMaximum number of threads/processes to support\n");
1274 printf(" --server=args\t\tStart a backend fio server\n");
1275 printf(" --daemonize=pidfile\tBackground fio server, write pid to file\n");
1276 printf(" --client=hostname\tTalk to remote backend fio server at hostname\n");
1277 printf(" --idle-prof=option\tReport cpu idleness on a system or percpu basis\n"
1278 "\t\t\t(option=system,percpu) or run unit work\n"
1279 "\t\t\tcalibration only (option=calibrate)\n");
1280 printf("\nFio was written by Jens Axboe <jens.axboe@oracle.com>");
1281 printf("\n Jens Axboe <jaxboe@fusionio.com>\n");
1284 #ifdef FIO_INC_DEBUG
1285 struct debug_level debug_levels[] = {
1286 { .name = "process",
1287 .help = "Process creation/exit logging",
1288 .shift = FD_PROCESS,
1291 .help = "File related action logging",
1295 .help = "IO and IO engine action logging (offsets, queue, completions, etc)",
1299 .help = "Memory allocation/freeing logging",
1302 { .name = "blktrace",
1303 .help = "blktrace action logging",
1304 .shift = FD_BLKTRACE,
1307 .help = "IO verification action logging",
1311 .help = "Random generation logging",
1315 .help = "Parser logging",
1318 { .name = "diskutil",
1319 .help = "Disk utility logging actions",
1320 .shift = FD_DISKUTIL,
1323 .help = "Logging related to creating/destroying jobs",
1327 .help = "Mutex logging",
1330 { .name = "profile",
1331 .help = "Logging related to profiles",
1332 .shift = FD_PROFILE,
1335 .help = "Logging related to time keeping functions",
1339 .help = "Network logging",
1345 static int set_debug(const char *string)
1347 struct debug_level *dl;
1348 char *p = (char *) string;
1352 if (!strcmp(string, "?") || !strcmp(string, "help")) {
1353 log_info("fio: dumping debug options:");
1354 for (i = 0; debug_levels[i].name; i++) {
1355 dl = &debug_levels[i];
1356 log_info("%s,", dl->name);
1362 while ((opt = strsep(&p, ",")) != NULL) {
1365 if (!strncmp(opt, "all", 3)) {
1366 log_info("fio: set all debug options\n");
1371 for (i = 0; debug_levels[i].name; i++) {
1372 dl = &debug_levels[i];
1373 found = !strncmp(opt, dl->name, strlen(dl->name));
1377 if (dl->shift == FD_JOB) {
1378 opt = strchr(opt, ':');
1380 log_err("fio: missing job number\n");
1384 fio_debug_jobno = atoi(opt);
1385 log_info("fio: set debug jobno %d\n",
1388 log_info("fio: set debug option %s\n", opt);
1389 fio_debug |= (1UL << dl->shift);
1395 log_err("fio: debug mask %s not found\n", opt);
1400 static int set_debug(const char *string)
1402 log_err("fio: debug tracing not included in build\n");
1407 static void fio_options_fill_optstring(void)
1409 char *ostr = cmd_optstr;
1413 while (l_opts[i].name) {
1414 ostr[c++] = l_opts[i].val;
1415 if (l_opts[i].has_arg == required_argument)
1417 else if (l_opts[i].has_arg == optional_argument) {
1426 static int client_flag_set(char c)
1431 while (l_opts[i].name) {
1432 int val = l_opts[i].val;
1434 if (c == (val & 0xff))
1435 return (val & FIO_CLIENT_FLAG);
1443 void parse_cmd_client(void *client, char *opt)
1445 fio_client_add_cmd_option(client, opt);
1448 int parse_cmd_line(int argc, char *argv[], int client_type)
1450 struct thread_data *td = NULL;
1451 int c, ini_idx = 0, lidx, ret = 0, do_exit = 0, exit_val = 0;
1452 char *ostr = cmd_optstr;
1453 void *pid_file = NULL;
1454 void *cur_client = NULL;
1458 * Reset optind handling, since we may call this multiple times
1463 while ((c = getopt_long_only(argc, argv, ostr, l_opts, &lidx)) != -1) {
1466 if ((c & FIO_CLIENT_FLAG) || client_flag_set(c)) {
1467 parse_cmd_client(cur_client, argv[optind - 1]);
1468 c &= ~FIO_CLIENT_FLAG;
1473 smalloc_pool_size = atoi(optarg);
1476 def_timeout = atoi(optarg);
1485 f_out = fopen(optarg, "w+");
1487 perror("fopen output");
1493 output_format = FIO_OUTPUT_TERSE;
1496 if (!strcmp(optarg, "minimal") ||
1497 !strcmp(optarg, "terse") ||
1498 !strcmp(optarg, "csv"))
1499 output_format = FIO_OUTPUT_TERSE;
1500 else if (!strcmp(optarg, "json"))
1501 output_format = FIO_OUTPUT_JSON;
1503 output_format = FIO_OUTPUT_NORMAL;
1513 fio_show_option_help(optarg);
1519 fio_show_ioengine_help(optarg);
1531 log_info("%s\n", fio_version_string);
1536 terse_version = atoi(optarg);
1537 if (!(terse_version == 2 || terse_version == 3 ||
1538 terse_version == 4)) {
1539 log_err("fio: bad terse version format\n");
1545 if (!strcmp("always", optarg))
1546 eta_print = FIO_ETA_ALWAYS;
1547 else if (!strcmp("never", optarg))
1548 eta_print = FIO_ETA_NEVER;
1551 if (set_debug(optarg))
1557 if (!strcmp(optarg, "global")) {
1558 log_err("fio: can't use global as only "
1564 new_size = (nr_job_sections + 1) * sizeof(char *);
1565 job_sections = realloc(job_sections, new_size);
1566 job_sections[nr_job_sections] = strdup(optarg);
1571 exec_profile = strdup(optarg);
1573 case FIO_GETOPT_JOB: {
1574 const char *opt = l_opts[lidx].name;
1577 if (!strncmp(opt, "name", 4) && td) {
1578 ret = add_job(td, td->o.name ?: "fio", 0, 0, client_type);
1584 int is_section = !strncmp(opt, "name", 4);
1587 if (!is_section || !strncmp(val, "global", 6))
1590 if (is_section && skip_this_section(val))
1593 td = get_new_job(global, &def_thread, 1);
1594 if (!td || ioengine_load(td))
1596 fio_options_set_ioengine_opts(l_opts, td);
1599 ret = fio_cmd_option_parse(td, opt, val);
1601 if (!ret && !strcmp(opt, "ioengine")) {
1603 if (ioengine_load(td))
1605 fio_options_set_ioengine_opts(l_opts, td);
1609 case FIO_GETOPT_IOENGINE: {
1610 const char *opt = l_opts[lidx].name;
1612 opt = l_opts[lidx].name;
1614 ret = fio_cmd_ioengine_option_parse(td, opt, val);
1621 max_jobs = atoi(optarg);
1622 if (!max_jobs || max_jobs > REAL_MAX_JOBS) {
1623 log_err("fio: invalid max jobs: %d\n", max_jobs);
1630 log_err("fio: can't be both client and server\n");
1636 fio_server_set_arg(optarg);
1641 pid_file = strdup(optarg);
1644 if ((ret = fio_idle_prof_parse_opt(optarg))) {
1645 /* exit on error and calibration only */
1653 log_err("fio: can't be both client and server\n");
1658 if (fio_client_add(&fio_client_ops, optarg, &cur_client)) {
1659 log_err("fio: failed adding client %s\n", optarg);
1665 * If the next argument exists and isn't an option,
1666 * assume it's a job file for this client only.
1668 while (optind < argc) {
1669 if (!strncmp(argv[optind], "--", 2) ||
1670 !strncmp(argv[optind], "-", 1))
1673 fio_client_add_ini_file(cur_client, argv[optind]);
1679 exit_val = fio_monotonic_clocktest();
1682 log_err("%s: unrecognized option '%s'\n", argv[0],
1694 if (exit_val && !(is_backend || nr_clients))
1698 if (nr_clients && fio_clients_connect()) {
1704 if (is_backend && backend)
1705 return fio_start_server(pid_file);
1709 ret = add_job(td, td->o.name ?: "fio", 0, 0, client_type);
1712 while (!ret && optind < argc) {
1714 ini_file = realloc(ini_file, ini_idx * sizeof(char *));
1715 ini_file[ini_idx - 1] = strdup(argv[optind]);
1722 int fio_init_options(void)
1727 fio_options_fill_optstring();
1728 fio_options_dup_and_init(l_opts);
1732 if (fill_def_thread())
1738 extern int fio_check_options(struct thread_options *);
1740 int parse_options(int argc, char *argv[])
1742 const int type = FIO_CLIENT_TYPE_CLI;
1745 if (fio_init_options())
1747 if (fio_test_cconv(&def_thread.o))
1748 log_err("fio: failed internal cconv test\n");
1750 job_files = parse_cmd_line(argc, argv, type);
1752 if (job_files > 0) {
1753 for (i = 0; i < job_files; i++) {
1754 if (fill_def_thread())
1757 if (fio_clients_send_ini(ini_file[i]))
1760 } else if (!is_backend) {
1761 if (parse_jobs_ini(ini_file[i], 0, i, type))
1766 } else if (nr_clients) {
1767 if (fill_def_thread())
1769 if (fio_clients_send_ini(NULL))
1774 fio_options_free(&def_thread);
1776 if (!thread_number) {
1781 if (is_backend || nr_clients)
1786 log_err("No jobs(s) defined\n\n");
1796 if (def_thread.o.gtod_offload) {
1798 fio_gtod_offload = 1;
1799 fio_gtod_cpu = def_thread.o.gtod_cpu;
1802 if (output_format == FIO_OUTPUT_NORMAL)
1803 log_info("%s\n", fio_version_string);
1808 void options_default_fill(struct thread_options *o)
1810 memcpy(o, &def_thread.o, sizeof(*o));