2 * This file contains job initialization and setup functions.
12 #ifndef FIO_NO_HAVE_SHM_H
15 #include <sys/types.h>
26 #include "lib/getopt.h"
28 const char fio_version_string[] = FIO_VERSION;
30 #define FIO_RANDSEED (0xb1899bedUL)
32 static char **ini_file;
33 static int max_jobs = FIO_MAX_JOBS;
34 static int dump_cmdline;
35 static int def_timeout;
37 static struct thread_data def_thread;
38 struct thread_data *threads = NULL;
40 int exitall_on_terminate = 0;
41 int output_format = FIO_OUTPUT_NORMAL;
45 char **job_sections = NULL;
46 int nr_job_sections = 0;
47 char *exec_profile = NULL;
48 int warnings_fatal = 0;
49 int terse_version = 3;
57 static int write_lat_log;
59 static int prev_group_jobs;
61 unsigned long fio_debug = 0;
62 unsigned int fio_debug_jobno = -1;
63 unsigned int *fio_debug_jobp = NULL;
65 static char cmd_optstr[256];
68 const fio_fp64_t def_percentile_list[FIO_IO_U_LIST_MAX_LEN] = {
88 #define FIO_CLIENT_FLAG (1 << 16)
91 * Command line options. These will contain the above, plus a few
92 * extra that only pertain to fio itself and not jobs.
94 static struct option l_opts[FIO_NR_OPTIONS] = {
96 .name = (char *) "output",
97 .has_arg = required_argument,
98 .val = 'o' | FIO_CLIENT_FLAG,
101 .name = (char *) "timeout",
102 .has_arg = required_argument,
103 .val = 't' | FIO_CLIENT_FLAG,
106 .name = (char *) "latency-log",
107 .has_arg = required_argument,
108 .val = 'l' | FIO_CLIENT_FLAG,
111 .name = (char *) "bandwidth-log",
112 .has_arg = required_argument,
113 .val = 'b' | FIO_CLIENT_FLAG,
116 .name = (char *) "minimal",
117 .has_arg = optional_argument,
118 .val = 'm' | FIO_CLIENT_FLAG,
121 .name = (char *) "output-format",
122 .has_arg = optional_argument,
123 .val = 'F' | FIO_CLIENT_FLAG,
126 .name = (char *) "version",
127 .has_arg = no_argument,
128 .val = 'v' | FIO_CLIENT_FLAG,
131 .name = (char *) "help",
132 .has_arg = no_argument,
133 .val = 'h' | FIO_CLIENT_FLAG,
136 .name = (char *) "cmdhelp",
137 .has_arg = optional_argument,
138 .val = 'c' | FIO_CLIENT_FLAG,
141 .name = (char *) "enghelp",
142 .has_arg = optional_argument,
143 .val = 'i' | FIO_CLIENT_FLAG,
146 .name = (char *) "showcmd",
147 .has_arg = no_argument,
148 .val = 's' | FIO_CLIENT_FLAG,
151 .name = (char *) "readonly",
152 .has_arg = no_argument,
153 .val = 'r' | FIO_CLIENT_FLAG,
156 .name = (char *) "eta",
157 .has_arg = required_argument,
158 .val = 'e' | FIO_CLIENT_FLAG,
161 .name = (char *) "debug",
162 .has_arg = required_argument,
163 .val = 'd' | FIO_CLIENT_FLAG,
166 .name = (char *) "section",
167 .has_arg = required_argument,
168 .val = 'x' | FIO_CLIENT_FLAG,
171 .name = (char *) "alloc-size",
172 .has_arg = required_argument,
173 .val = 'a' | FIO_CLIENT_FLAG,
176 .name = (char *) "profile",
177 .has_arg = required_argument,
178 .val = 'p' | FIO_CLIENT_FLAG,
181 .name = (char *) "warnings-fatal",
182 .has_arg = no_argument,
183 .val = 'w' | FIO_CLIENT_FLAG,
186 .name = (char *) "max-jobs",
187 .has_arg = required_argument,
188 .val = 'j' | FIO_CLIENT_FLAG,
191 .name = (char *) "terse-version",
192 .has_arg = required_argument,
193 .val = 'V' | FIO_CLIENT_FLAG,
196 .name = (char *) "server",
197 .has_arg = optional_argument,
200 { .name = (char *) "daemonize",
201 .has_arg = required_argument,
205 .name = (char *) "client",
206 .has_arg = required_argument,
214 void free_threads_shm(void)
216 struct shmid_ds sbuf;
223 shmctl(shm_id, IPC_RMID, &sbuf);
233 fio_debug_jobp = NULL;
241 * The thread area is shared between the main process and the job
242 * threads/processes. So setup a shared memory segment that will hold
243 * all the job info. We use the end of the region for keeping track of
244 * open files across jobs, for file sharing.
246 static int setup_thread_area(void)
254 * 1024 is too much on some machines, scale max_jobs if
255 * we get a failure that looks like too large a shm segment
258 size_t size = max_jobs * sizeof(struct thread_data);
260 size += file_hash_size;
261 size += sizeof(unsigned int);
263 shm_id = shmget(0, size, IPC_CREAT | 0600);
266 if (errno != EINVAL && errno != ENOMEM && errno != ENOSPC) {
277 threads = shmat(shm_id, NULL, 0);
278 if (threads == (void *) -1) {
283 memset(threads, 0, max_jobs * sizeof(struct thread_data));
284 hash = (void *) threads + max_jobs * sizeof(struct thread_data);
285 fio_debug_jobp = (void *) hash + file_hash_size;
286 *fio_debug_jobp = -1;
287 file_hash_init(hash);
295 * Return a free job structure.
297 static struct thread_data *get_new_job(int global, struct thread_data *parent,
300 struct thread_data *td;
304 if (setup_thread_area()) {
305 log_err("error: failed to setup shm segment\n");
308 if (thread_number >= max_jobs) {
309 log_err("error: maximum number of jobs (%d) reached.\n",
314 td = &threads[thread_number++];
321 td->o.uid = td->o.gid = -1U;
323 dup_files(td, parent);
324 fio_options_mem_dupe(td);
326 profile_add_hooks(td);
328 td->thread_number = thread_number;
330 if (!parent || !parent->o.group_reporting)
336 static void put_job(struct thread_data *td)
338 if (td == &def_thread)
345 log_info("fio: %s\n", td->verror);
347 fio_options_free(td);
351 memset(&threads[td->thread_number - 1], 0, sizeof(*td));
355 static int __setup_rate(struct thread_data *td, enum fio_ddir ddir)
357 unsigned int bs = td->o.min_bs[ddir];
359 assert(ddir_rw(ddir));
361 if (td->o.rate[ddir])
362 td->rate_bps[ddir] = td->o.rate[ddir];
364 td->rate_bps[ddir] = td->o.rate_iops[ddir] * bs;
366 if (!td->rate_bps[ddir]) {
367 log_err("rate lower than supported\n");
371 td->rate_pending_usleep[ddir] = 0;
375 static int setup_rate(struct thread_data *td)
379 if (td->o.rate[DDIR_READ] || td->o.rate_iops[DDIR_READ])
380 ret = __setup_rate(td, DDIR_READ);
381 if (td->o.rate[DDIR_WRITE] || td->o.rate_iops[DDIR_WRITE])
382 ret |= __setup_rate(td, DDIR_WRITE);
383 if (td->o.rate[DDIR_TRIM] || td->o.rate_iops[DDIR_TRIM])
384 ret |= __setup_rate(td, DDIR_TRIM);
389 static int fixed_block_size(struct thread_options *o)
391 return o->min_bs[DDIR_READ] == o->max_bs[DDIR_READ] &&
392 o->min_bs[DDIR_WRITE] == o->max_bs[DDIR_WRITE] &&
393 o->min_bs[DDIR_TRIM] == o->max_bs[DDIR_TRIM] &&
394 o->min_bs[DDIR_READ] == o->min_bs[DDIR_WRITE] &&
395 o->min_bs[DDIR_READ] == o->min_bs[DDIR_TRIM];
399 * Lazy way of fixing up options that depend on each other. We could also
400 * define option callback handlers, but this is easier.
402 static int fixup_options(struct thread_data *td)
404 struct thread_options *o = &td->o;
407 #ifndef FIO_HAVE_PSHARED_MUTEX
408 if (!o->use_thread) {
409 log_info("fio: this platform does not support process shared"
410 " mutexes, forcing use of threads. Use the 'thread'"
411 " option to get rid of this warning.\n");
413 ret = warnings_fatal;
417 if (o->write_iolog_file && o->read_iolog_file) {
418 log_err("fio: read iolog overrides write_iolog\n");
419 free(o->write_iolog_file);
420 o->write_iolog_file = NULL;
421 ret = warnings_fatal;
425 * only really works with 1 file
427 if (o->zone_size && o->open_files == 1)
431 * If zone_range isn't specified, backward compatibility dictates it
432 * should be made equal to zone_size.
434 if (o->zone_size && !o->zone_range)
435 o->zone_range = o->zone_size;
438 * Reads can do overwrites, we always need to pre-create the file
440 if (td_read(td) || td_rw(td))
443 if (!o->min_bs[DDIR_READ])
444 o->min_bs[DDIR_READ] = o->bs[DDIR_READ];
445 if (!o->max_bs[DDIR_READ])
446 o->max_bs[DDIR_READ] = o->bs[DDIR_READ];
447 if (!o->min_bs[DDIR_WRITE])
448 o->min_bs[DDIR_WRITE] = o->bs[DDIR_WRITE];
449 if (!o->max_bs[DDIR_WRITE])
450 o->max_bs[DDIR_WRITE] = o->bs[DDIR_WRITE];
451 if (!o->min_bs[DDIR_TRIM])
452 o->min_bs[DDIR_TRIM] = o->bs[DDIR_TRIM];
453 if (!o->max_bs[DDIR_TRIM])
454 o->max_bs[DDIR_TRIM] = o->bs[DDIR_TRIM];
457 o->rw_min_bs = min(o->min_bs[DDIR_READ], o->min_bs[DDIR_WRITE]);
458 o->rw_min_bs = min(o->min_bs[DDIR_TRIM], o->rw_min_bs);
461 * For random IO, allow blockalign offset other than min_bs.
463 if (!o->ba[DDIR_READ] || !td_random(td))
464 o->ba[DDIR_READ] = o->min_bs[DDIR_READ];
465 if (!o->ba[DDIR_WRITE] || !td_random(td))
466 o->ba[DDIR_WRITE] = o->min_bs[DDIR_WRITE];
467 if (!o->ba[DDIR_TRIM] || !td_random(td))
468 o->ba[DDIR_TRIM] = o->min_bs[DDIR_TRIM];
470 if ((o->ba[DDIR_READ] != o->min_bs[DDIR_READ] ||
471 o->ba[DDIR_WRITE] != o->min_bs[DDIR_WRITE] ||
472 o->ba[DDIR_TRIM] != o->min_bs[DDIR_TRIM]) &&
474 log_err("fio: Any use of blockalign= turns off randommap\n");
476 ret = warnings_fatal;
479 if (!o->file_size_high)
480 o->file_size_high = o->file_size_low;
482 if (o->norandommap && o->verify != VERIFY_NONE
483 && !fixed_block_size(o)) {
484 log_err("fio: norandommap given for variable block sizes, "
485 "verify disabled\n");
486 o->verify = VERIFY_NONE;
487 ret = warnings_fatal;
489 if (o->bs_unaligned && (o->odirect || td->io_ops->flags & FIO_RAWIO))
490 log_err("fio: bs_unaligned may not work with raw io\n");
493 * thinktime_spin must be less than thinktime
495 if (o->thinktime_spin > o->thinktime)
496 o->thinktime_spin = o->thinktime;
499 * The low water mark cannot be bigger than the iodepth
501 if (o->iodepth_low > o->iodepth || !o->iodepth_low) {
503 * syslet work around - if the workload is sequential,
504 * we want to let the queue drain all the way down to
505 * avoid seeking between async threads
507 if (!strcmp(td->io_ops->name, "syslet-rw") && !td_random(td))
510 o->iodepth_low = o->iodepth;
514 * If batch number isn't set, default to the same as iodepth
516 if (o->iodepth_batch > o->iodepth || !o->iodepth_batch)
517 o->iodepth_batch = o->iodepth;
519 if (o->nr_files > td->files_index)
520 o->nr_files = td->files_index;
522 if (o->open_files > o->nr_files || !o->open_files)
523 o->open_files = o->nr_files;
525 if (((o->rate[DDIR_READ] + o->rate[DDIR_WRITE] + o->rate[DDIR_TRIM]) &&
526 (o->rate_iops[DDIR_READ] + o->rate_iops[DDIR_WRITE] + o->rate_iops[DDIR_TRIM])) ||
527 ((o->ratemin[DDIR_READ] + o->ratemin[DDIR_WRITE] + o->ratemin[DDIR_TRIM]) &&
528 (o->rate_iops_min[DDIR_READ] + o->rate_iops_min[DDIR_WRITE] + o->rate_iops_min[DDIR_TRIM]))) {
529 log_err("fio: rate and rate_iops are mutually exclusive\n");
532 if ((o->rate[DDIR_READ] < o->ratemin[DDIR_READ]) ||
533 (o->rate[DDIR_WRITE] < o->ratemin[DDIR_WRITE]) ||
534 (o->rate[DDIR_TRIM] < o->ratemin[DDIR_TRIM]) ||
535 (o->rate_iops[DDIR_READ] < o->rate_iops_min[DDIR_READ]) ||
536 (o->rate_iops[DDIR_WRITE] < o->rate_iops_min[DDIR_WRITE]) ||
537 (o->rate_iops[DDIR_TRIM] < o->rate_iops_min[DDIR_TRIM])) {
538 log_err("fio: minimum rate exceeds rate\n");
542 if (!o->timeout && o->time_based) {
543 log_err("fio: time_based requires a runtime/timeout setting\n");
545 ret = warnings_fatal;
548 if (o->fill_device && !o->size)
551 if (o->verify != VERIFY_NONE) {
552 if (td_write(td) && o->do_verify && o->numjobs > 1) {
553 log_info("Multiple writers may overwrite blocks that "
554 "belong to other jobs. This can cause "
555 "verification failures.\n");
556 ret = warnings_fatal;
559 o->refill_buffers = 1;
560 if (o->max_bs[DDIR_WRITE] != o->min_bs[DDIR_WRITE] &&
562 o->verify_interval = o->min_bs[DDIR_WRITE];
566 o->invalidate_cache = 0;
567 if (td->io_ops->flags & FIO_PIPEIO) {
568 log_info("fio: cannot pre-read files with an IO engine"
569 " that isn't seekable. Pre-read disabled.\n");
570 ret = warnings_fatal;
574 #ifndef FIO_HAVE_FDATASYNC
575 if (o->fdatasync_blocks) {
576 log_info("fio: this platform does not support fdatasync()"
577 " falling back to using fsync(). Use the 'fsync'"
578 " option instead of 'fdatasync' to get rid of"
580 o->fsync_blocks = o->fdatasync_blocks;
581 o->fdatasync_blocks = 0;
582 ret = warnings_fatal;
588 * Windows doesn't support O_DIRECT or O_SYNC with the _open interface,
589 * so fail if we're passed those flags
591 if ((td->io_ops->flags & FIO_SYNCIO) && (td->o.odirect || td->o.sync_io)) {
592 log_err("fio: Windows does not support direct or non-buffered io with"
593 " the synchronous ioengines. Use the 'windowsaio' ioengine"
594 " with 'direct=1' and 'iodepth=1' instead.\n");
600 * For fully compressible data, just zero them at init time.
601 * It's faster than repeatedly filling it.
603 if (td->o.compress_percentage == 100) {
604 td->o.zero_buffers = 1;
605 td->o.compress_percentage = 0;
609 * Using a non-uniform random distribution excludes usage of
612 if (td->o.random_distribution != FIO_RAND_DIST_RANDOM)
613 td->o.norandommap = 1;
619 * This function leaks the buffer
621 char *fio_uint_to_kmg(unsigned int val)
623 char *buf = malloc(32);
624 char post[] = { 0, 'K', 'M', 'G', 'P', 'E', 0 };
635 snprintf(buf, 31, "%u%c", val, *p);
639 /* External engines are specified by "external:name.o") */
640 static const char *get_engine_name(const char *str)
642 char *p = strstr(str, ":");
648 strip_blank_front(&p);
653 static int exists_and_not_file(const char *filename)
657 if (lstat(filename, &sb) == -1)
660 /* \\.\ is the device namespace in Windows, where every file
661 * is a device node */
662 if (S_ISREG(sb.st_mode) && strncmp(filename, "\\\\.\\", 4) != 0)
668 static void td_fill_rand_seeds_os(struct thread_data *td)
670 os_random_seed(td->rand_seeds[FIO_RAND_BS_OFF], &td->bsrange_state);
671 os_random_seed(td->rand_seeds[FIO_RAND_VER_OFF], &td->verify_state);
672 os_random_seed(td->rand_seeds[FIO_RAND_MIX_OFF], &td->rwmix_state);
674 if (td->o.file_service_type == FIO_FSERVICE_RANDOM)
675 os_random_seed(td->rand_seeds[FIO_RAND_FILE_OFF], &td->next_file_state);
677 os_random_seed(td->rand_seeds[FIO_RAND_FILE_SIZE_OFF], &td->file_size_state);
678 os_random_seed(td->rand_seeds[FIO_RAND_TRIM_OFF], &td->trim_state);
683 if (td->o.rand_repeatable)
684 td->rand_seeds[FIO_RAND_BLOCK_OFF] = FIO_RANDSEED * td->thread_number;
686 os_random_seed(td->rand_seeds[FIO_RAND_BLOCK_OFF], &td->random_state);
689 static void td_fill_rand_seeds_internal(struct thread_data *td)
691 init_rand_seed(&td->__bsrange_state, td->rand_seeds[FIO_RAND_BS_OFF]);
692 init_rand_seed(&td->__verify_state, td->rand_seeds[FIO_RAND_VER_OFF]);
693 init_rand_seed(&td->__rwmix_state, td->rand_seeds[FIO_RAND_MIX_OFF]);
695 if (td->o.file_service_type == FIO_FSERVICE_RANDOM)
696 init_rand_seed(&td->__next_file_state, td->rand_seeds[FIO_RAND_FILE_OFF]);
698 init_rand_seed(&td->__file_size_state, td->rand_seeds[FIO_RAND_FILE_SIZE_OFF]);
699 init_rand_seed(&td->__trim_state, td->rand_seeds[FIO_RAND_TRIM_OFF]);
704 if (td->o.rand_repeatable)
705 td->rand_seeds[FIO_RAND_BLOCK_OFF] = FIO_RANDSEED * td->thread_number;
707 init_rand_seed(&td->__random_state, td->rand_seeds[FIO_RAND_BLOCK_OFF]);
710 void td_fill_rand_seeds(struct thread_data *td)
712 if (td->o.use_os_rand)
713 td_fill_rand_seeds_os(td);
715 td_fill_rand_seeds_internal(td);
717 init_rand_seed(&td->buf_state, td->rand_seeds[FIO_RAND_BUF_OFF]);
722 * Initializes the ioengine configured for a job, if it has not been done so
725 int ioengine_load(struct thread_data *td)
730 * Engine has already been loaded.
735 engine = get_engine_name(td->o.ioengine);
736 td->io_ops = load_ioengine(td, engine);
738 log_err("fio: failed to load engine %s\n", engine);
742 if (td->io_ops->option_struct_size && td->io_ops->options) {
744 * In cases where td->eo is set, clone it for a child thread.
745 * This requires that the parent thread has the same ioengine,
746 * but that requirement must be enforced by the code which
749 void *origeo = td->eo;
751 * Otherwise use the default thread options.
753 if (!origeo && td != &def_thread && def_thread.eo &&
754 def_thread.io_ops->options == td->io_ops->options)
755 origeo = def_thread.eo;
757 options_init(td->io_ops->options);
758 td->eo = malloc(td->io_ops->option_struct_size);
760 * Use the default thread as an option template if this uses the
761 * same options structure and there are non-default options
765 memcpy(td->eo, origeo, td->io_ops->option_struct_size);
766 options_mem_dupe(td->eo, td->io_ops->options);
768 memset(td->eo, 0, td->io_ops->option_struct_size);
769 fill_default_options(td->eo, td->io_ops->options);
771 *(struct thread_data **)td->eo = td;
777 static void init_flags(struct thread_data *td)
779 struct thread_options *o = &td->o;
781 if (o->verify_backlog)
782 td->flags |= TD_F_VER_BACKLOG;
784 td->flags |= TD_F_TRIM_BACKLOG;
785 if (o->read_iolog_file)
786 td->flags |= TD_F_READ_IOLOG;
787 if (o->refill_buffers)
788 td->flags |= TD_F_REFILL_BUFFERS;
789 if (o->scramble_buffers)
790 td->flags |= TD_F_SCRAMBLE_BUFFERS;
791 if (o->verify != VERIFY_NONE)
792 td->flags |= TD_F_VER_NONE;
796 * Adds a job to the list of things todo. Sanitizes the various options
797 * to make sure we don't have conflicts, and initializes various
800 static int add_job(struct thread_data *td, const char *jobname, int job_add_num,
801 int recursed, int client_type)
804 char fname[PATH_MAX];
805 int numjobs, file_alloced;
808 * the def_thread is just for options, it's not a real job
810 if (td == &def_thread)
816 * if we are just dumping the output command line, don't add the job
823 td->client_type = client_type;
825 if (profile_td_init(td))
828 if (ioengine_load(td))
832 td->io_ops->flags |= FIO_RAWIO;
835 if (!td->o.filename && !td->files_index && !td->o.read_iolog_file) {
838 if (td->o.nr_files == 1 && exists_and_not_file(jobname))
839 add_file(td, jobname);
841 for (i = 0; i < td->o.nr_files; i++) {
842 sprintf(fname, "%s.%d.%d", jobname,
843 td->thread_number, i);
849 if (fixup_options(td))
855 * IO engines only need this for option callbacks, and the address may
856 * change in subprocesses.
859 *(struct thread_data **)td->eo = NULL;
861 if (td->io_ops->flags & FIO_DISKLESSIO) {
864 for_each_file(td, f, i)
865 f->real_file_size = -1ULL;
868 td->mutex = fio_mutex_init(FIO_MUTEX_LOCKED);
870 td->ts.clat_percentiles = td->o.clat_percentiles;
871 if (td->o.overwrite_plist)
872 memcpy(td->ts.percentile_list, td->o.percentile_list, sizeof(td->o.percentile_list));
874 memcpy(td->ts.percentile_list, def_percentile_list, sizeof(def_percentile_list));
876 for (i = 0; i < DDIR_RWDIR_CNT; i++) {
877 td->ts.clat_stat[i].min_val = ULONG_MAX;
878 td->ts.slat_stat[i].min_val = ULONG_MAX;
879 td->ts.lat_stat[i].min_val = ULONG_MAX;
880 td->ts.bw_stat[i].min_val = ULONG_MAX;
882 td->ddir_seq_nr = td->o.ddir_seq_nr;
884 if ((td->o.stonewall || td->o.new_group) && prev_group_jobs) {
889 td->groupid = groupid;
892 if (init_random_state(td, td->rand_seeds, sizeof(td->rand_seeds))) {
893 td_verror(td, errno, "init_random_state");
900 if (td->o.lat_log_file) {
901 setup_log(&td->lat_log, td->o.log_avg_msec, IO_LOG_TYPE_LAT);
902 setup_log(&td->slat_log, td->o.log_avg_msec, IO_LOG_TYPE_SLAT);
903 setup_log(&td->clat_log, td->o.log_avg_msec, IO_LOG_TYPE_CLAT);
905 if (td->o.bw_log_file)
906 setup_log(&td->bw_log, td->o.log_avg_msec, IO_LOG_TYPE_BW);
907 if (td->o.iops_log_file)
908 setup_log(&td->iops_log, td->o.log_avg_msec, IO_LOG_TYPE_IOPS);
911 td->o.name = strdup(jobname);
913 if (output_format == FIO_OUTPUT_NORMAL) {
915 if (is_backend && !recursed)
916 fio_server_send_add_job(td);
918 if (!(td->io_ops->flags & FIO_NOIO)) {
919 char *c1, *c2, *c3, *c4, *c5, *c6;
921 c1 = fio_uint_to_kmg(td->o.min_bs[DDIR_READ]);
922 c2 = fio_uint_to_kmg(td->o.max_bs[DDIR_READ]);
923 c3 = fio_uint_to_kmg(td->o.min_bs[DDIR_WRITE]);
924 c4 = fio_uint_to_kmg(td->o.max_bs[DDIR_WRITE]);
925 c5 = fio_uint_to_kmg(td->o.min_bs[DDIR_TRIM]);
926 c6 = fio_uint_to_kmg(td->o.max_bs[DDIR_TRIM]);
928 log_info("%s: (g=%d): rw=%s, bs=%s-%s/%s-%s/%s-%s,"
929 " ioengine=%s, iodepth=%u\n",
930 td->o.name, td->groupid,
931 ddir_str(td->o.td_ddir),
932 c1, c2, c3, c4, c5, c6,
943 } else if (job_add_num == 1)
948 * recurse add identical jobs, clear numjobs and stonewall options
949 * as they don't apply to sub-jobs
951 numjobs = td->o.numjobs;
953 struct thread_data *td_new = get_new_job(0, td, 1);
958 td_new->o.numjobs = 1;
959 td_new->o.stonewall = 0;
960 td_new->o.new_group = 0;
963 td_new->o.filename = NULL;
964 td_new->files_index = 0;
965 td_new->files_size = 0;
966 td_new->files = NULL;
969 job_add_num = numjobs - 1;
971 if (add_job(td_new, jobname, job_add_num, 1, client_type))
982 * Parse as if 'o' was a command line
984 void add_job_opts(const char **o, int client_type)
986 struct thread_data *td, *td_parent;
987 int i, in_global = 1;
991 td_parent = td = NULL;
993 if (!strncmp(o[i], "name", 4)) {
996 add_job(td, jobname, 0, 0, client_type);
998 sprintf(jobname, "%s", o[i] + 5);
1000 if (in_global && !td_parent)
1001 td_parent = get_new_job(1, &def_thread, 0);
1002 else if (!in_global && !td) {
1004 td_parent = &def_thread;
1005 td = get_new_job(0, td_parent, 0);
1008 fio_options_parse(td_parent, (char **) &o[i], 1);
1010 fio_options_parse(td, (char **) &o[i], 1);
1015 add_job(td, jobname, 0, 0, client_type);
1018 static int skip_this_section(const char *name)
1022 if (!nr_job_sections)
1024 if (!strncmp(name, "global", 6))
1027 for (i = 0; i < nr_job_sections; i++)
1028 if (!strcmp(job_sections[i], name))
1034 static int is_empty_or_comment(char *line)
1038 for (i = 0; i < strlen(line); i++) {
1043 if (!isspace((int) line[i]) && !iscntrl((int) line[i]))
1051 * This is our [ini] type file parser.
1053 int parse_jobs_ini(char *file, int is_buf, int stonewall_flag, int type)
1055 unsigned int global;
1056 struct thread_data *td;
1057 char *string, *name;
1060 int ret = 0, stonewall;
1063 int inside_skip = 0;
1065 int i, alloc_opts, num_opts;
1070 if (!strcmp(file, "-"))
1073 f = fopen(file, "r");
1076 perror("fopen job file");
1081 string = malloc(4096);
1084 * it's really 256 + small bit, 280 should suffice
1087 memset(name, 0, 280);
1090 opts = malloc(sizeof(char *) * alloc_opts);
1093 stonewall = stonewall_flag;
1096 * if skip_fgets is set, we already have loaded a line we
1101 p = strsep(&file, "\n");
1103 p = fgets(string, 4096, f);
1109 strip_blank_front(&p);
1112 if (is_empty_or_comment(p))
1114 if (sscanf(p, "[%255[^\n]]", name) != 1) {
1117 log_err("fio: option <%s> outside of [] job section\n",
1122 name[strlen(name) - 1] = '\0';
1124 if (skip_this_section(name)) {
1130 global = !strncmp(name, "global", 6);
1136 log_info("--name=%s ", name);
1140 td = get_new_job(global, &def_thread, 0);
1147 * Seperate multiple job files by a stonewall
1149 if (!global && stonewall) {
1150 td->o.stonewall = stonewall;
1155 memset(opts, 0, alloc_opts * sizeof(char *));
1159 p = strsep(&file, "\n");
1161 p = fgets(string, 4096, f);
1165 if (is_empty_or_comment(p))
1168 strip_blank_front(&p);
1171 * new section, break out and make sure we don't
1172 * fgets() a new line at the top.
1181 if (num_opts == alloc_opts) {
1183 opts = realloc(opts,
1184 alloc_opts * sizeof(char *));
1187 opts[num_opts] = strdup(p);
1191 ret = fio_options_parse(td, opts, num_opts);
1194 for (i = 0; i < num_opts; i++)
1195 log_info("--%s ", opts[i]);
1197 ret = add_job(td, name, 0, 0, type);
1199 log_err("fio: job %s dropped\n", name);
1203 for (i = 0; i < num_opts; i++)
1212 while (i < nr_job_sections) {
1213 free(job_sections[i]);
1217 for (i = 0; i < num_opts; i++)
1223 if (!is_buf && f != stdin)
1228 static int fill_def_thread(void)
1230 memset(&def_thread, 0, sizeof(def_thread));
1232 fio_getaffinity(getpid(), &def_thread.o.cpumask);
1233 def_thread.o.timeout = def_timeout;
1234 def_thread.o.error_dump = 1;
1236 * fill default options
1238 fio_fill_default_options(&def_thread);
1242 static void usage(const char *name)
1244 printf("%s\n", fio_version_string);
1245 printf("%s [options] [job options] <job file(s)>\n", name);
1246 printf(" --debug=options\tEnable debug logging. May be one/more of:\n"
1247 "\t\t\tprocess,file,io,mem,blktrace,verify,random,parse,\n"
1248 "\t\t\tdiskutil,job,mutex,profile,time,net\n");
1249 printf(" --output\t\tWrite output to file\n");
1250 printf(" --runtime\t\tRuntime in seconds\n");
1251 printf(" --latency-log\t\tGenerate per-job latency logs\n");
1252 printf(" --bandwidth-log\tGenerate per-job bandwidth logs\n");
1253 printf(" --minimal\t\tMinimal (terse) output\n");
1254 printf(" --output-format=x\tOutput format (terse,json,normal)\n");
1255 printf(" --terse-version=x\tSet terse version output format to 'x'\n");
1256 printf(" --version\t\tPrint version info and exit\n");
1257 printf(" --help\t\tPrint this page\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("\nFio was written by Jens Axboe <jens.axboe@oracle.com>");
1278 printf("\n Jens Axboe <jaxboe@fusionio.com>\n");
1281 #ifdef FIO_INC_DEBUG
1282 struct debug_level debug_levels[] = {
1283 { .name = "process",
1284 .help = "Process creation/exit logging",
1285 .shift = FD_PROCESS,
1288 .help = "File related action logging",
1292 .help = "IO and IO engine action logging (offsets, queue, completions, etc)",
1296 .help = "Memory allocation/freeing logging",
1299 { .name = "blktrace",
1300 .help = "blktrace action logging",
1301 .shift = FD_BLKTRACE,
1304 .help = "IO verification action logging",
1308 .help = "Random generation logging",
1312 .help = "Parser logging",
1315 { .name = "diskutil",
1316 .help = "Disk utility logging actions",
1317 .shift = FD_DISKUTIL,
1320 .help = "Logging related to creating/destroying jobs",
1324 .help = "Mutex logging",
1327 { .name = "profile",
1328 .help = "Logging related to profiles",
1329 .shift = FD_PROFILE,
1332 .help = "Logging related to time keeping functions",
1336 .help = "Network logging",
1342 static int set_debug(const char *string)
1344 struct debug_level *dl;
1345 char *p = (char *) string;
1349 if (!strcmp(string, "?") || !strcmp(string, "help")) {
1350 log_info("fio: dumping debug options:");
1351 for (i = 0; debug_levels[i].name; i++) {
1352 dl = &debug_levels[i];
1353 log_info("%s,", dl->name);
1359 while ((opt = strsep(&p, ",")) != NULL) {
1362 if (!strncmp(opt, "all", 3)) {
1363 log_info("fio: set all debug options\n");
1368 for (i = 0; debug_levels[i].name; i++) {
1369 dl = &debug_levels[i];
1370 found = !strncmp(opt, dl->name, strlen(dl->name));
1374 if (dl->shift == FD_JOB) {
1375 opt = strchr(opt, ':');
1377 log_err("fio: missing job number\n");
1381 fio_debug_jobno = atoi(opt);
1382 log_info("fio: set debug jobno %d\n",
1385 log_info("fio: set debug option %s\n", opt);
1386 fio_debug |= (1UL << dl->shift);
1392 log_err("fio: debug mask %s not found\n", opt);
1397 static int set_debug(const char *string)
1399 log_err("fio: debug tracing not included in build\n");
1404 static void fio_options_fill_optstring(void)
1406 char *ostr = cmd_optstr;
1410 while (l_opts[i].name) {
1411 ostr[c++] = l_opts[i].val;
1412 if (l_opts[i].has_arg == required_argument)
1414 else if (l_opts[i].has_arg == optional_argument) {
1423 static int client_flag_set(char c)
1428 while (l_opts[i].name) {
1429 int val = l_opts[i].val;
1431 if (c == (val & 0xff))
1432 return (val & FIO_CLIENT_FLAG);
1440 void parse_cmd_client(void *client, char *opt)
1442 fio_client_add_cmd_option(client, opt);
1445 int parse_cmd_line(int argc, char *argv[], int client_type)
1447 struct thread_data *td = NULL;
1448 int c, ini_idx = 0, lidx, ret = 0, do_exit = 0, exit_val = 0;
1449 char *ostr = cmd_optstr;
1450 void *pid_file = NULL;
1451 void *cur_client = NULL;
1455 * Reset optind handling, since we may call this multiple times
1460 while ((c = getopt_long_only(argc, argv, ostr, l_opts, &lidx)) != -1) {
1463 if ((c & FIO_CLIENT_FLAG) || client_flag_set(c)) {
1464 parse_cmd_client(cur_client, argv[optind - 1]);
1465 c &= ~FIO_CLIENT_FLAG;
1470 smalloc_pool_size = atoi(optarg);
1473 def_timeout = atoi(optarg);
1482 f_out = fopen(optarg, "w+");
1484 perror("fopen output");
1490 output_format = FIO_OUTPUT_TERSE;
1493 if (!strcmp(optarg, "minimal") ||
1494 !strcmp(optarg, "terse") ||
1495 !strcmp(optarg, "csv"))
1496 output_format = FIO_OUTPUT_TERSE;
1497 else if (!strcmp(optarg, "json"))
1498 output_format = FIO_OUTPUT_JSON;
1500 output_format = FIO_OUTPUT_NORMAL;
1510 fio_show_option_help(optarg);
1516 fio_show_ioengine_help(optarg);
1528 log_info("%s\n", fio_version_string);
1533 terse_version = atoi(optarg);
1534 if (!(terse_version == 2 || terse_version == 3 ||
1535 terse_version == 4)) {
1536 log_err("fio: bad terse version format\n");
1542 if (!strcmp("always", optarg))
1543 eta_print = FIO_ETA_ALWAYS;
1544 else if (!strcmp("never", optarg))
1545 eta_print = FIO_ETA_NEVER;
1548 if (set_debug(optarg))
1554 if (!strcmp(optarg, "global")) {
1555 log_err("fio: can't use global as only "
1561 new_size = (nr_job_sections + 1) * sizeof(char *);
1562 job_sections = realloc(job_sections, new_size);
1563 job_sections[nr_job_sections] = strdup(optarg);
1568 exec_profile = strdup(optarg);
1570 case FIO_GETOPT_JOB: {
1571 const char *opt = l_opts[lidx].name;
1574 if (!strncmp(opt, "name", 4) && td) {
1575 ret = add_job(td, td->o.name ?: "fio", 0, 0, client_type);
1581 int is_section = !strncmp(opt, "name", 4);
1584 if (!is_section || !strncmp(val, "global", 6))
1587 if (is_section && skip_this_section(val))
1590 td = get_new_job(global, &def_thread, 1);
1591 if (!td || ioengine_load(td))
1593 fio_options_set_ioengine_opts(l_opts, td);
1596 ret = fio_cmd_option_parse(td, opt, val);
1598 if (!ret && !strcmp(opt, "ioengine")) {
1600 if (ioengine_load(td))
1602 fio_options_set_ioengine_opts(l_opts, td);
1606 case FIO_GETOPT_IOENGINE: {
1607 const char *opt = l_opts[lidx].name;
1609 opt = l_opts[lidx].name;
1611 ret = fio_cmd_ioengine_option_parse(td, opt, val);
1618 max_jobs = atoi(optarg);
1619 if (!max_jobs || max_jobs > REAL_MAX_JOBS) {
1620 log_err("fio: invalid max jobs: %d\n", max_jobs);
1627 log_err("fio: can't be both client and server\n");
1633 fio_server_set_arg(optarg);
1638 pid_file = strdup(optarg);
1642 log_err("fio: can't be both client and server\n");
1647 if (fio_client_add(&fio_client_ops, optarg, &cur_client)) {
1648 log_err("fio: failed adding client %s\n", optarg);
1654 * If the next argument exists and isn't an option,
1655 * assume it's a job file for this client only.
1657 while (optind < argc) {
1658 if (!strncmp(argv[optind], "--", 2) ||
1659 !strncmp(argv[optind], "-", 1))
1662 fio_client_add_ini_file(cur_client, argv[optind]);
1676 if (exit_val && !(is_backend || nr_clients))
1680 if (nr_clients && fio_clients_connect()) {
1686 if (is_backend && backend)
1687 return fio_start_server(pid_file);
1691 ret = add_job(td, td->o.name ?: "fio", 0, 0, client_type);
1694 while (!ret && optind < argc) {
1696 ini_file = realloc(ini_file, ini_idx * sizeof(char *));
1697 ini_file[ini_idx - 1] = strdup(argv[optind]);
1704 int fio_init_options(void)
1709 fio_options_fill_optstring();
1710 fio_options_dup_and_init(l_opts);
1714 if (fill_def_thread())
1720 extern int fio_check_options(struct thread_options *);
1722 int parse_options(int argc, char *argv[])
1724 const int type = FIO_CLIENT_TYPE_CLI;
1727 if (fio_init_options())
1729 if (fio_test_cconv(&def_thread.o))
1730 log_err("fio: failed internal cconv test\n");
1732 job_files = parse_cmd_line(argc, argv, type);
1734 if (job_files > 0) {
1735 for (i = 0; i < job_files; i++) {
1736 if (fill_def_thread())
1739 if (fio_clients_send_ini(ini_file[i]))
1742 } else if (!is_backend) {
1743 if (parse_jobs_ini(ini_file[i], 0, i, type))
1748 } else if (nr_clients) {
1749 if (fill_def_thread())
1751 if (fio_clients_send_ini(NULL))
1756 fio_options_free(&def_thread);
1758 if (!thread_number) {
1763 if (is_backend || nr_clients)
1768 log_err("No jobs(s) defined\n\n");
1778 if (def_thread.o.gtod_offload) {
1780 fio_gtod_offload = 1;
1781 fio_gtod_cpu = def_thread.o.gtod_cpu;
1784 if (output_format == FIO_OUTPUT_NORMAL)
1785 log_info("%s\n", fio_version_string);
1790 void options_default_fill(struct thread_options *o)
1792 memcpy(o, &def_thread.o, sizeof(*o));