2 * This file contains job initialization and setup functions.
12 #include <sys/types.h>
17 #ifndef FIO_NO_HAVE_SHM_H
29 #include "steadystate.h"
31 #include "oslib/getopt.h"
32 #include "oslib/strcasestr.h"
36 #include "lib/memcpy.h"
38 const char fio_version_string[] = FIO_VERSION;
40 #define FIO_RANDSEED (0xb1899bedUL)
42 static char **ini_file;
43 static int max_jobs = FIO_MAX_JOBS;
44 static int dump_cmdline;
45 static int parse_only;
47 static struct thread_data def_thread;
48 struct thread_data *threads = NULL;
49 static char **job_sections;
50 static int nr_job_sections;
52 int exitall_on_terminate = 0;
53 int output_format = FIO_OUTPUT_NORMAL;
54 int eta_print = FIO_ETA_AUTO;
55 unsigned int eta_interval_msec = 1000;
59 char *exec_profile = NULL;
60 int warnings_fatal = 0;
61 int terse_version = 3;
68 int status_interval = 0;
70 char *trigger_file = NULL;
71 long long trigger_timeout = 0;
72 char *trigger_cmd = NULL;
73 char *trigger_remote_cmd = NULL;
75 char *aux_path = NULL;
77 static int prev_group_jobs;
79 unsigned long fio_debug = 0;
80 unsigned int fio_debug_jobno = -1;
81 unsigned int *fio_debug_jobp = NULL;
83 static char cmd_optstr[256];
86 #define FIO_CLIENT_FLAG (1 << 16)
89 * Command line options. These will contain the above, plus a few
90 * extra that only pertain to fio itself and not jobs.
92 static struct option l_opts[FIO_NR_OPTIONS] = {
94 .name = (char *) "output",
95 .has_arg = required_argument,
96 .val = 'o' | FIO_CLIENT_FLAG,
99 .name = (char *) "latency-log",
100 .has_arg = required_argument,
101 .val = 'l' | FIO_CLIENT_FLAG,
104 .name = (char *) "bandwidth-log",
105 .has_arg = no_argument,
106 .val = 'b' | FIO_CLIENT_FLAG,
109 .name = (char *) "minimal",
110 .has_arg = no_argument,
111 .val = 'm' | FIO_CLIENT_FLAG,
114 .name = (char *) "output-format",
115 .has_arg = required_argument,
116 .val = 'F' | FIO_CLIENT_FLAG,
119 .name = (char *) "append-terse",
120 .has_arg = optional_argument,
124 .name = (char *) "version",
125 .has_arg = no_argument,
126 .val = 'v' | FIO_CLIENT_FLAG,
129 .name = (char *) "help",
130 .has_arg = no_argument,
131 .val = 'h' | FIO_CLIENT_FLAG,
134 .name = (char *) "cmdhelp",
135 .has_arg = optional_argument,
136 .val = 'c' | FIO_CLIENT_FLAG,
139 .name = (char *) "enghelp",
140 .has_arg = optional_argument,
141 .val = 'i' | FIO_CLIENT_FLAG,
144 .name = (char *) "showcmd",
145 .has_arg = no_argument,
146 .val = 's' | FIO_CLIENT_FLAG,
149 .name = (char *) "readonly",
150 .has_arg = no_argument,
151 .val = 'r' | FIO_CLIENT_FLAG,
154 .name = (char *) "eta",
155 .has_arg = required_argument,
156 .val = 'e' | FIO_CLIENT_FLAG,
159 .name = (char *) "eta-interval",
160 .has_arg = required_argument,
161 .val = 'O' | FIO_CLIENT_FLAG,
164 .name = (char *) "eta-newline",
165 .has_arg = required_argument,
166 .val = 'E' | FIO_CLIENT_FLAG,
169 .name = (char *) "debug",
170 .has_arg = required_argument,
171 .val = 'd' | FIO_CLIENT_FLAG,
174 .name = (char *) "parse-only",
175 .has_arg = no_argument,
176 .val = 'P' | FIO_CLIENT_FLAG,
179 .name = (char *) "section",
180 .has_arg = required_argument,
181 .val = 'x' | FIO_CLIENT_FLAG,
185 .name = (char *) "inflate-log",
186 .has_arg = required_argument,
187 .val = 'X' | FIO_CLIENT_FLAG,
191 .name = (char *) "alloc-size",
192 .has_arg = required_argument,
193 .val = 'a' | FIO_CLIENT_FLAG,
196 .name = (char *) "profile",
197 .has_arg = required_argument,
198 .val = 'p' | FIO_CLIENT_FLAG,
201 .name = (char *) "warnings-fatal",
202 .has_arg = no_argument,
203 .val = 'w' | FIO_CLIENT_FLAG,
206 .name = (char *) "max-jobs",
207 .has_arg = required_argument,
208 .val = 'j' | FIO_CLIENT_FLAG,
211 .name = (char *) "terse-version",
212 .has_arg = required_argument,
213 .val = 'V' | FIO_CLIENT_FLAG,
216 .name = (char *) "server",
217 .has_arg = optional_argument,
220 { .name = (char *) "daemonize",
221 .has_arg = required_argument,
225 .name = (char *) "client",
226 .has_arg = required_argument,
230 .name = (char *) "remote-config",
231 .has_arg = required_argument,
235 .name = (char *) "cpuclock-test",
236 .has_arg = no_argument,
240 .name = (char *) "crctest",
241 .has_arg = optional_argument,
245 .name = (char *) "memcpytest",
246 .has_arg = optional_argument,
250 .name = (char *) "idle-prof",
251 .has_arg = required_argument,
255 .name = (char *) "status-interval",
256 .has_arg = required_argument,
260 .name = (char *) "trigger-file",
261 .has_arg = required_argument,
265 .name = (char *) "trigger-timeout",
266 .has_arg = required_argument,
270 .name = (char *) "trigger",
271 .has_arg = required_argument,
275 .name = (char *) "trigger-remote",
276 .has_arg = required_argument,
280 .name = (char *) "aux-path",
281 .has_arg = required_argument,
289 void free_threads_shm(void)
293 #ifndef CONFIG_NO_SHM
294 struct shmid_ds sbuf;
298 shmctl(shm_id, IPC_RMID, &sbuf);
307 static void free_shm(void)
311 fio_debug_jobp = NULL;
317 free(trigger_remote_cmd);
318 trigger_file = trigger_cmd = trigger_remote_cmd = NULL;
320 options_free(fio_options, &def_thread.o);
327 * The thread area is shared between the main process and the job
328 * threads/processes. So setup a shared memory segment that will hold
329 * all the job info. We use the end of the region for keeping track of
330 * open files across jobs, for file sharing.
332 static int setup_thread_area(void)
338 * 1024 is too much on some machines, scale max_jobs if
339 * we get a failure that looks like too large a shm segment
342 size_t size = max_jobs * sizeof(struct thread_data);
344 size += sizeof(unsigned int);
346 #ifndef CONFIG_NO_SHM
347 shm_id = shmget(0, size, IPC_CREAT | 0600);
350 if (errno != EINVAL && errno != ENOMEM && errno != ENOSPC) {
355 threads = malloc(size);
363 #ifndef CONFIG_NO_SHM
367 threads = shmat(shm_id, NULL, 0);
368 if (threads == (void *) -1) {
372 if (shm_attach_to_open_removed())
373 shmctl(shm_id, IPC_RMID, NULL);
376 memset(threads, 0, max_jobs * sizeof(struct thread_data));
377 fio_debug_jobp = (unsigned int *)(threads + max_jobs);
378 *fio_debug_jobp = -1;
385 static void dump_print_option(struct print_option *p)
389 if (!strcmp("description", p->name))
394 log_info("--%s%s", p->name, p->value ? "" : " ");
396 log_info("=%s%s%s ", delim, p->value, delim);
399 static void dump_opt_list(struct thread_data *td)
401 struct flist_head *entry;
402 struct print_option *p;
404 if (flist_empty(&td->opt_list))
407 flist_for_each(entry, &td->opt_list) {
408 p = flist_entry(entry, struct print_option, list);
409 dump_print_option(p);
413 static void fio_dump_options_free(struct thread_data *td)
415 while (!flist_empty(&td->opt_list)) {
416 struct print_option *p;
418 p = flist_first_entry(&td->opt_list, struct print_option, list);
419 flist_del_init(&p->list);
426 static void copy_opt_list(struct thread_data *dst, struct thread_data *src)
428 struct flist_head *entry;
430 if (flist_empty(&src->opt_list))
433 flist_for_each(entry, &src->opt_list) {
434 struct print_option *srcp, *dstp;
436 srcp = flist_entry(entry, struct print_option, list);
437 dstp = malloc(sizeof(*dstp));
438 dstp->name = strdup(srcp->name);
440 dstp->value = strdup(srcp->value);
443 flist_add_tail(&dstp->list, &dst->opt_list);
448 * Return a free job structure.
450 static struct thread_data *get_new_job(bool global, struct thread_data *parent,
451 bool preserve_eo, const char *jobname)
453 struct thread_data *td;
457 if (setup_thread_area()) {
458 log_err("error: failed to setup shm segment\n");
461 if (thread_number >= max_jobs) {
462 log_err("error: maximum number of jobs (%d) reached.\n",
467 td = &threads[thread_number++];
470 INIT_FLIST_HEAD(&td->opt_list);
471 if (parent != &def_thread)
472 copy_opt_list(td, parent);
479 td->o.uid = td->o.gid = -1U;
481 dup_files(td, parent);
482 fio_options_mem_dupe(td);
484 profile_add_hooks(td);
486 td->thread_number = thread_number;
487 td->subjob_number = 0;
490 td->o.name = strdup(jobname);
492 if (!parent->o.group_reporting || parent == &def_thread)
498 static void put_job(struct thread_data *td)
500 if (td == &def_thread)
507 log_info("fio: %s\n", td->verror);
509 fio_options_free(td);
510 fio_dump_options_free(td);
517 memset(&threads[td->thread_number - 1], 0, sizeof(*td));
521 static int __setup_rate(struct thread_data *td, enum fio_ddir ddir)
523 unsigned int bs = td->o.min_bs[ddir];
525 assert(ddir_rw(ddir));
527 if (td->o.rate[ddir])
528 td->rate_bps[ddir] = td->o.rate[ddir];
530 td->rate_bps[ddir] = (uint64_t) td->o.rate_iops[ddir] * bs;
532 if (!td->rate_bps[ddir]) {
533 log_err("rate lower than supported\n");
537 td->rate_next_io_time[ddir] = 0;
538 td->rate_io_issue_bytes[ddir] = 0;
539 td->last_usec[ddir] = 0;
543 static int setup_rate(struct thread_data *td)
547 if (td->o.rate[DDIR_READ] || td->o.rate_iops[DDIR_READ])
548 ret = __setup_rate(td, DDIR_READ);
549 if (td->o.rate[DDIR_WRITE] || td->o.rate_iops[DDIR_WRITE])
550 ret |= __setup_rate(td, DDIR_WRITE);
551 if (td->o.rate[DDIR_TRIM] || td->o.rate_iops[DDIR_TRIM])
552 ret |= __setup_rate(td, DDIR_TRIM);
557 static int fixed_block_size(struct thread_options *o)
559 return o->min_bs[DDIR_READ] == o->max_bs[DDIR_READ] &&
560 o->min_bs[DDIR_WRITE] == o->max_bs[DDIR_WRITE] &&
561 o->min_bs[DDIR_TRIM] == o->max_bs[DDIR_TRIM] &&
562 o->min_bs[DDIR_READ] == o->min_bs[DDIR_WRITE] &&
563 o->min_bs[DDIR_READ] == o->min_bs[DDIR_TRIM];
567 static unsigned long long get_rand_start_delay(struct thread_data *td)
569 unsigned long long delayrange;
573 delayrange = td->o.start_delay_high - td->o.start_delay;
575 frand_max = rand_max(&td->delay_state);
576 r = __rand(&td->delay_state);
577 delayrange = (unsigned long long) ((double) delayrange * (r / (frand_max + 1.0)));
579 delayrange += td->o.start_delay;
586 static unsigned int gcd(unsigned int m, unsigned int n)
591 return gcd(n, m % n);
595 * Lazy way of fixing up options that depend on each other. We could also
596 * define option callback handlers, but this is easier.
598 static int fixup_options(struct thread_data *td)
600 struct thread_options *o = &td->o;
603 #ifndef CONFIG_PSHARED
604 if (!o->use_thread) {
605 log_info("fio: this platform does not support process shared"
606 " mutexes, forcing use of threads. Use the 'thread'"
607 " option to get rid of this warning.\n");
609 ret = warnings_fatal;
613 if (o->write_iolog_file && o->read_iolog_file) {
614 log_err("fio: read iolog overrides write_iolog\n");
615 free(o->write_iolog_file);
616 o->write_iolog_file = NULL;
617 ret = warnings_fatal;
621 * only really works with 1 file
623 if (o->zone_size && o->open_files > 1)
627 * If zone_range isn't specified, backward compatibility dictates it
628 * should be made equal to zone_size.
630 if (o->zone_size && !o->zone_range)
631 o->zone_range = o->zone_size;
634 * Reads can do overwrites, we always need to pre-create the file
639 if (!o->min_bs[DDIR_READ])
640 o->min_bs[DDIR_READ] = o->bs[DDIR_READ];
641 if (!o->max_bs[DDIR_READ])
642 o->max_bs[DDIR_READ] = o->bs[DDIR_READ];
643 if (!o->min_bs[DDIR_WRITE])
644 o->min_bs[DDIR_WRITE] = o->bs[DDIR_WRITE];
645 if (!o->max_bs[DDIR_WRITE])
646 o->max_bs[DDIR_WRITE] = o->bs[DDIR_WRITE];
647 if (!o->min_bs[DDIR_TRIM])
648 o->min_bs[DDIR_TRIM] = o->bs[DDIR_TRIM];
649 if (!o->max_bs[DDIR_TRIM])
650 o->max_bs[DDIR_TRIM] = o->bs[DDIR_TRIM];
652 o->rw_min_bs = min(o->min_bs[DDIR_READ], o->min_bs[DDIR_WRITE]);
653 o->rw_min_bs = min(o->min_bs[DDIR_TRIM], o->rw_min_bs);
656 * For random IO, allow blockalign offset other than min_bs.
658 if (!o->ba[DDIR_READ] || !td_random(td))
659 o->ba[DDIR_READ] = o->min_bs[DDIR_READ];
660 if (!o->ba[DDIR_WRITE] || !td_random(td))
661 o->ba[DDIR_WRITE] = o->min_bs[DDIR_WRITE];
662 if (!o->ba[DDIR_TRIM] || !td_random(td))
663 o->ba[DDIR_TRIM] = o->min_bs[DDIR_TRIM];
665 if ((o->ba[DDIR_READ] != o->min_bs[DDIR_READ] ||
666 o->ba[DDIR_WRITE] != o->min_bs[DDIR_WRITE] ||
667 o->ba[DDIR_TRIM] != o->min_bs[DDIR_TRIM]) &&
669 log_err("fio: Any use of blockalign= turns off randommap\n");
671 ret = warnings_fatal;
674 if (!o->file_size_high)
675 o->file_size_high = o->file_size_low;
677 if (o->start_delay_high)
678 o->start_delay = get_rand_start_delay(td);
680 if (o->norandommap && o->verify != VERIFY_NONE
681 && !fixed_block_size(o)) {
682 log_err("fio: norandommap given for variable block sizes, "
684 ret = warnings_fatal;
686 if (o->bs_unaligned && (o->odirect || td_ioengine_flagged(td, FIO_RAWIO)))
687 log_err("fio: bs_unaligned may not work with raw io\n");
690 * thinktime_spin must be less than thinktime
692 if (o->thinktime_spin > o->thinktime)
693 o->thinktime_spin = o->thinktime;
696 * The low water mark cannot be bigger than the iodepth
698 if (o->iodepth_low > o->iodepth || !o->iodepth_low)
699 o->iodepth_low = o->iodepth;
702 * If batch number isn't set, default to the same as iodepth
704 if (o->iodepth_batch > o->iodepth || !o->iodepth_batch)
705 o->iodepth_batch = o->iodepth;
708 * If max batch complete number isn't set or set incorrectly,
709 * default to the same as iodepth_batch_complete_min
711 if (o->iodepth_batch_complete_min > o->iodepth_batch_complete_max)
712 o->iodepth_batch_complete_max = o->iodepth_batch_complete_min;
715 * There's no need to check for in-flight overlapping IOs if the job
716 * isn't changing data or the maximum iodepth is guaranteed to be 1
718 if (o->serialize_overlap && !(td->flags & TD_F_READ_IOLOG) &&
719 (!(td_write(td) || td_trim(td)) || o->iodepth == 1))
720 o->serialize_overlap = 0;
722 * Currently can't check for overlaps in offload mode
724 if (o->serialize_overlap && o->io_submit_mode == IO_MODE_OFFLOAD) {
725 log_err("fio: checking for in-flight overlaps when the "
726 "io_submit_mode is offload is not supported\n");
727 o->serialize_overlap = 0;
728 ret = warnings_fatal;
731 if (o->nr_files > td->files_index)
732 o->nr_files = td->files_index;
734 if (o->open_files > o->nr_files || !o->open_files)
735 o->open_files = o->nr_files;
737 if (((o->rate[DDIR_READ] + o->rate[DDIR_WRITE] + o->rate[DDIR_TRIM]) &&
738 (o->rate_iops[DDIR_READ] + o->rate_iops[DDIR_WRITE] + o->rate_iops[DDIR_TRIM])) ||
739 ((o->ratemin[DDIR_READ] + o->ratemin[DDIR_WRITE] + o->ratemin[DDIR_TRIM]) &&
740 (o->rate_iops_min[DDIR_READ] + o->rate_iops_min[DDIR_WRITE] + o->rate_iops_min[DDIR_TRIM]))) {
741 log_err("fio: rate and rate_iops are mutually exclusive\n");
744 if ((o->rate[DDIR_READ] && (o->rate[DDIR_READ] < o->ratemin[DDIR_READ])) ||
745 (o->rate[DDIR_WRITE] && (o->rate[DDIR_WRITE] < o->ratemin[DDIR_WRITE])) ||
746 (o->rate[DDIR_TRIM] && (o->rate[DDIR_TRIM] < o->ratemin[DDIR_TRIM])) ||
747 (o->rate_iops[DDIR_READ] && (o->rate_iops[DDIR_READ] < o->rate_iops_min[DDIR_READ])) ||
748 (o->rate_iops[DDIR_WRITE] && (o->rate_iops[DDIR_WRITE] < o->rate_iops_min[DDIR_WRITE])) ||
749 (o->rate_iops[DDIR_TRIM] && (o->rate_iops[DDIR_TRIM] < o->rate_iops_min[DDIR_TRIM]))) {
750 log_err("fio: minimum rate exceeds rate\n");
754 if (!o->timeout && o->time_based) {
755 log_err("fio: time_based requires a runtime/timeout setting\n");
757 ret = warnings_fatal;
760 if (o->fill_device && !o->size)
763 if (o->verify != VERIFY_NONE) {
764 if (td_write(td) && o->do_verify && o->numjobs > 1 &&
766 !(o->unique_filename &&
767 strstr(o->filename_format, "$jobname") &&
768 strstr(o->filename_format, "$jobnum") &&
769 strstr(o->filename_format, "$filenum")))) {
770 log_info("fio: multiple writers may overwrite blocks "
771 "that belong to other jobs. This can cause "
772 "verification failures.\n");
773 ret = warnings_fatal;
777 * Warn if verification is requested but no verification of any
778 * kind can be started due to time constraints
780 if (td_write(td) && o->do_verify && o->timeout &&
781 o->time_based && !td_read(td) && !o->verify_backlog) {
782 log_info("fio: verification read phase will never "
783 "start because write phase uses all of "
785 ret = warnings_fatal;
788 if (!fio_option_is_set(o, refill_buffers))
789 o->refill_buffers = 1;
791 if (o->max_bs[DDIR_WRITE] != o->min_bs[DDIR_WRITE] &&
793 o->verify_interval = o->min_bs[DDIR_WRITE];
796 * Verify interval must be smaller or equal to the
799 if (o->verify_interval > o->min_bs[DDIR_WRITE])
800 o->verify_interval = o->min_bs[DDIR_WRITE];
801 else if (td_read(td) && o->verify_interval > o->min_bs[DDIR_READ])
802 o->verify_interval = o->min_bs[DDIR_READ];
805 * Verify interval must be a factor of both min and max
808 if (!o->verify_interval ||
809 (o->min_bs[DDIR_WRITE] % o->verify_interval) ||
810 (o->max_bs[DDIR_WRITE] % o->verify_interval))
811 o->verify_interval = gcd(o->min_bs[DDIR_WRITE],
812 o->max_bs[DDIR_WRITE]);
816 if (o->invalidate_cache)
817 o->invalidate_cache = 0;
818 if (td_ioengine_flagged(td, FIO_PIPEIO)) {
819 log_info("fio: cannot pre-read files with an IO engine"
820 " that isn't seekable. Pre-read disabled.\n");
821 ret = warnings_fatal;
826 if (td_ioengine_flagged(td, FIO_BIT_BASED))
832 #ifndef FIO_HAVE_ANY_FALLOCATE
833 /* Platform doesn't support any fallocate so force it to none */
834 o->fallocate_mode = FIO_FALLOCATE_NONE;
837 #ifndef CONFIG_FDATASYNC
838 if (o->fdatasync_blocks) {
839 log_info("fio: this platform does not support fdatasync()"
840 " falling back to using fsync(). Use the 'fsync'"
841 " option instead of 'fdatasync' to get rid of"
843 o->fsync_blocks = o->fdatasync_blocks;
844 o->fdatasync_blocks = 0;
845 ret = warnings_fatal;
851 * Windows doesn't support O_DIRECT or O_SYNC with the _open interface,
852 * so fail if we're passed those flags
854 if (td_ioengine_flagged(td, FIO_SYNCIO) && (o->odirect || o->sync_io)) {
855 log_err("fio: Windows does not support direct or non-buffered io with"
856 " the synchronous ioengines. Use the 'windowsaio' ioengine"
857 " with 'direct=1' and 'iodepth=1' instead.\n");
863 * For fully compressible data, just zero them at init time.
864 * It's faster than repeatedly filling it. For non-zero
865 * compression, we should have refill_buffers set. Set it, unless
866 * the job file already changed it.
868 if (o->compress_percentage) {
869 if (o->compress_percentage == 100) {
871 o->compress_percentage = 0;
872 } else if (!fio_option_is_set(o, refill_buffers)) {
873 o->refill_buffers = 1;
874 td->flags |= TD_F_REFILL_BUFFERS;
879 * Using a non-uniform random distribution excludes usage of
882 if (o->random_distribution != FIO_RAND_DIST_RANDOM)
886 * If size is set but less than the min block size, complain
888 if (o->size && o->size < td_min_bs(td)) {
889 log_err("fio: size too small, must not be less than minimum block size: %llu < %u\n",
890 (unsigned long long) o->size, td_min_bs(td));
895 * O_ATOMIC implies O_DIRECT
901 * If randseed is set, that overrides randrepeat
903 if (fio_option_is_set(o, rand_seed))
904 o->rand_repeatable = 0;
906 if (td_ioengine_flagged(td, FIO_NOEXTEND) && o->file_append) {
907 log_err("fio: can't append/extent with IO engine %s\n", td->io_ops->name);
911 if (fio_option_is_set(o, gtod_cpu)) {
913 fio_gtod_set_cpu(o->gtod_cpu);
914 fio_gtod_offload = 1;
917 td->loops = o->loops;
921 if (o->block_error_hist && o->nr_files != 1) {
922 log_err("fio: block error histogram only available "
923 "with a single file per job, but %d files "
924 "provided\n", o->nr_files);
928 if (fio_option_is_set(o, clat_percentiles) &&
929 !fio_option_is_set(o, lat_percentiles)) {
930 o->lat_percentiles = !o->clat_percentiles;
931 } else if (fio_option_is_set(o, lat_percentiles) &&
932 !fio_option_is_set(o, clat_percentiles)) {
933 o->clat_percentiles = !o->lat_percentiles;
934 } else if (fio_option_is_set(o, lat_percentiles) &&
935 fio_option_is_set(o, clat_percentiles) &&
936 o->lat_percentiles && o->clat_percentiles) {
937 log_err("fio: lat_percentiles and clat_percentiles are "
938 "mutually exclusive\n");
943 o->lat_percentiles = 0;
945 o->clat_percentiles = 0;
948 * Fix these up to be nsec internally
950 o->max_latency *= 1000ULL;
951 o->latency_target *= 1000ULL;
952 o->latency_window *= 1000ULL;
957 static void init_rand_file_service(struct thread_data *td)
959 unsigned long nranges = td->o.nr_files << FIO_FSERVICE_SHIFT;
960 const unsigned int seed = td->rand_seeds[FIO_RAND_FILE_OFF];
962 if (td->o.file_service_type == FIO_FSERVICE_ZIPF) {
963 zipf_init(&td->next_file_zipf, nranges, td->zipf_theta, seed);
964 zipf_disable_hash(&td->next_file_zipf);
965 } else if (td->o.file_service_type == FIO_FSERVICE_PARETO) {
966 pareto_init(&td->next_file_zipf, nranges, td->pareto_h, seed);
967 zipf_disable_hash(&td->next_file_zipf);
968 } else if (td->o.file_service_type == FIO_FSERVICE_GAUSS) {
969 gauss_init(&td->next_file_gauss, nranges, td->gauss_dev, seed);
970 gauss_disable_hash(&td->next_file_gauss);
974 void td_fill_verify_state_seed(struct thread_data *td)
978 if (td->o.random_generator == FIO_RAND_GEN_TAUSWORTHE64)
983 init_rand_seed(&td->verify_state, td->rand_seeds[FIO_RAND_VER_OFF],
987 static void td_fill_rand_seeds_internal(struct thread_data *td, bool use64)
992 * trimwrite is special in that we need to generate the same
993 * offsets to get the "write after trim" effect. If we are
994 * using bssplit to set buffer length distributions, ensure that
995 * we seed the trim and write generators identically.
997 if (td_trimwrite(td)) {
998 init_rand_seed(&td->bsrange_state[DDIR_READ], td->rand_seeds[FIO_RAND_BS_OFF], use64);
999 init_rand_seed(&td->bsrange_state[DDIR_WRITE], td->rand_seeds[FIO_RAND_BS1_OFF], use64);
1000 init_rand_seed(&td->bsrange_state[DDIR_TRIM], td->rand_seeds[FIO_RAND_BS1_OFF], use64);
1002 init_rand_seed(&td->bsrange_state[DDIR_READ], td->rand_seeds[FIO_RAND_BS_OFF], use64);
1003 init_rand_seed(&td->bsrange_state[DDIR_WRITE], td->rand_seeds[FIO_RAND_BS1_OFF], use64);
1004 init_rand_seed(&td->bsrange_state[DDIR_TRIM], td->rand_seeds[FIO_RAND_BS2_OFF], use64);
1007 td_fill_verify_state_seed(td);
1008 init_rand_seed(&td->rwmix_state, td->rand_seeds[FIO_RAND_MIX_OFF], false);
1010 if (td->o.file_service_type == FIO_FSERVICE_RANDOM)
1011 init_rand_seed(&td->next_file_state, td->rand_seeds[FIO_RAND_FILE_OFF], use64);
1012 else if (td->o.file_service_type & __FIO_FSERVICE_NONUNIFORM)
1013 init_rand_file_service(td);
1015 init_rand_seed(&td->file_size_state, td->rand_seeds[FIO_RAND_FILE_SIZE_OFF], use64);
1016 init_rand_seed(&td->trim_state, td->rand_seeds[FIO_RAND_TRIM_OFF], use64);
1017 init_rand_seed(&td->delay_state, td->rand_seeds[FIO_RAND_START_DELAY], use64);
1018 init_rand_seed(&td->poisson_state[0], td->rand_seeds[FIO_RAND_POISSON_OFF], 0);
1019 init_rand_seed(&td->poisson_state[1], td->rand_seeds[FIO_RAND_POISSON2_OFF], 0);
1020 init_rand_seed(&td->poisson_state[2], td->rand_seeds[FIO_RAND_POISSON3_OFF], 0);
1021 init_rand_seed(&td->dedupe_state, td->rand_seeds[FIO_DEDUPE_OFF], false);
1022 init_rand_seed(&td->zone_state, td->rand_seeds[FIO_RAND_ZONE_OFF], false);
1027 if (td->o.rand_repeatable)
1028 td->rand_seeds[FIO_RAND_BLOCK_OFF] = FIO_RANDSEED * td->thread_number;
1030 init_rand_seed(&td->random_state, td->rand_seeds[FIO_RAND_BLOCK_OFF], use64);
1032 for (i = 0; i < DDIR_RWDIR_CNT; i++) {
1033 struct frand_state *s = &td->seq_rand_state[i];
1035 init_rand_seed(s, td->rand_seeds[FIO_RAND_SEQ_RAND_READ_OFF], false);
1039 void td_fill_rand_seeds(struct thread_data *td)
1043 if (td->o.allrand_repeatable) {
1046 for (i = 0; i < FIO_RAND_NR_OFFS; i++)
1047 td->rand_seeds[i] = FIO_RANDSEED * td->thread_number
1051 if (td->o.random_generator == FIO_RAND_GEN_TAUSWORTHE64)
1056 td_fill_rand_seeds_internal(td, use64);
1058 init_rand_seed(&td->buf_state, td->rand_seeds[FIO_RAND_BUF_OFF], use64);
1059 frand_copy(&td->buf_state_prev, &td->buf_state);
1063 * Initializes the ioengine configured for a job, if it has not been done so
1066 int ioengine_load(struct thread_data *td)
1068 if (!td->o.ioengine) {
1069 log_err("fio: internal fault, no IO engine specified\n");
1074 struct ioengine_ops *ops;
1077 /* An engine is loaded, but the requested ioengine
1080 if (!strcmp(td->io_ops->name, td->o.ioengine)) {
1081 /* The right engine is already loaded */
1086 * Name of file and engine may be different, load ops
1087 * for this name and see if they match. If they do, then
1088 * the engine is unchanged.
1090 dlhandle = td->io_ops_dlhandle;
1091 ops = load_ioengine(td);
1092 if (ops == td->io_ops && dlhandle == td->io_ops_dlhandle) {
1098 if (dlhandle && dlhandle != td->io_ops_dlhandle)
1101 /* Unload the old engine. */
1105 td->io_ops = load_ioengine(td);
1107 log_err("fio: failed to load engine\n");
1111 if (td->io_ops->option_struct_size && td->io_ops->options) {
1113 * In cases where td->eo is set, clone it for a child thread.
1114 * This requires that the parent thread has the same ioengine,
1115 * but that requirement must be enforced by the code which
1116 * cloned the thread.
1118 void *origeo = td->eo;
1120 * Otherwise use the default thread options.
1122 if (!origeo && td != &def_thread && def_thread.eo &&
1123 def_thread.io_ops->options == td->io_ops->options)
1124 origeo = def_thread.eo;
1126 options_init(td->io_ops->options);
1127 td->eo = malloc(td->io_ops->option_struct_size);
1129 * Use the default thread as an option template if this uses the
1130 * same options structure and there are non-default options
1134 memcpy(td->eo, origeo, td->io_ops->option_struct_size);
1135 options_mem_dupe(td->io_ops->options, td->eo);
1137 memset(td->eo, 0, td->io_ops->option_struct_size);
1138 fill_default_options(td->eo, td->io_ops->options);
1140 *(struct thread_data **)td->eo = td;
1144 td->io_ops->flags |= FIO_RAWIO;
1146 td_set_ioengine_flags(td);
1150 static void init_flags(struct thread_data *td)
1152 struct thread_options *o = &td->o;
1155 if (o->verify_backlog)
1156 td->flags |= TD_F_VER_BACKLOG;
1157 if (o->trim_backlog)
1158 td->flags |= TD_F_TRIM_BACKLOG;
1159 if (o->read_iolog_file)
1160 td->flags |= TD_F_READ_IOLOG;
1161 if (o->refill_buffers)
1162 td->flags |= TD_F_REFILL_BUFFERS;
1164 * Always scramble buffers if asked to
1166 if (o->scramble_buffers && fio_option_is_set(o, scramble_buffers))
1167 td->flags |= TD_F_SCRAMBLE_BUFFERS;
1169 * But also scramble buffers, unless we were explicitly asked
1172 if (o->scramble_buffers && !(o->zero_buffers &&
1173 fio_option_is_set(o, zero_buffers)))
1174 td->flags |= TD_F_SCRAMBLE_BUFFERS;
1175 if (o->verify != VERIFY_NONE)
1176 td->flags |= TD_F_VER_NONE;
1178 if (o->verify_async || o->io_submit_mode == IO_MODE_OFFLOAD)
1179 td->flags |= TD_F_NEED_LOCK;
1181 if (o->mem_type == MEM_CUDA_MALLOC)
1182 td->flags &= ~TD_F_SCRAMBLE_BUFFERS;
1184 for (i = 0; i < DDIR_RWDIR_CNT; i++) {
1185 if (option_check_rate(td, i)) {
1186 td->flags |= TD_F_CHECK_RATE;
1192 static int setup_random_seeds(struct thread_data *td)
1197 if (!td->o.rand_repeatable && !fio_option_is_set(&td->o, rand_seed)) {
1198 int ret = init_random_seeds(td->rand_seeds, sizeof(td->rand_seeds));
1200 td_fill_rand_seeds(td);
1204 seed = td->o.rand_seed;
1205 for (i = 0; i < 4; i++)
1206 seed *= 0x9e370001UL;
1208 for (i = 0; i < FIO_RAND_NR_OFFS; i++) {
1209 td->rand_seeds[i] = seed * td->thread_number + i;
1210 seed *= 0x9e370001UL;
1213 td_fill_rand_seeds(td);
1224 static struct fpre_keyword {
1225 const char *keyword;
1228 } fpre_keywords[] = {
1229 { .keyword = "$jobname", .key = FPRE_JOBNAME, },
1230 { .keyword = "$jobnum", .key = FPRE_JOBNUM, },
1231 { .keyword = "$filenum", .key = FPRE_FILENUM, },
1232 { .keyword = NULL, },
1235 static char *make_filename(char *buf, size_t buf_size,struct thread_options *o,
1236 const char *jobname, int jobnum, int filenum)
1238 struct fpre_keyword *f;
1239 char copy[PATH_MAX];
1240 size_t dst_left = PATH_MAX - 1;
1242 if (!o->filename_format || !strlen(o->filename_format)) {
1243 sprintf(buf, "%s.%d.%d", jobname, jobnum, filenum);
1247 for (f = &fpre_keywords[0]; f->keyword; f++)
1248 f->strlen = strlen(f->keyword);
1250 buf[buf_size - 1] = '\0';
1251 strncpy(buf, o->filename_format, buf_size - 1);
1253 memset(copy, 0, sizeof(copy));
1254 for (f = &fpre_keywords[0]; f->keyword; f++) {
1256 size_t pre_len, post_start = 0;
1257 char *str, *dst = copy;
1259 str = strcasestr(buf, f->keyword);
1263 pre_len = str - buf;
1264 if (strlen(str) != f->strlen)
1265 post_start = pre_len + f->strlen;
1268 strncpy(dst, buf, pre_len);
1270 dst_left -= pre_len;
1274 case FPRE_JOBNAME: {
1277 ret = snprintf(dst, dst_left, "%s", jobname);
1280 else if (ret > dst_left) {
1281 log_err("fio: truncated filename\n");
1293 ret = snprintf(dst, dst_left, "%d", jobnum);
1296 else if (ret > dst_left) {
1297 log_err("fio: truncated filename\n");
1306 case FPRE_FILENUM: {
1309 ret = snprintf(dst, dst_left, "%d", filenum);
1312 else if (ret > dst_left) {
1313 log_err("fio: truncated filename\n");
1328 strncpy(dst, buf + post_start, dst_left);
1330 strncpy(buf, copy, buf_size - 1);
1337 bool parse_dryrun(void)
1339 return dump_cmdline || parse_only;
1342 static void gen_log_name(char *name, size_t size, const char *logtype,
1343 const char *logname, unsigned int num,
1344 const char *suf, int per_job)
1347 snprintf(name, size, "%s_%s.%d.%s", logname, logtype, num, suf);
1349 snprintf(name, size, "%s_%s.%s", logname, logtype, suf);
1352 static int check_waitees(char *waitee)
1354 struct thread_data *td;
1357 for_each_td(td, i) {
1358 if (td->subjob_number)
1361 ret += !strcmp(td->o.name, waitee);
1367 static bool wait_for_ok(const char *jobname, struct thread_options *o)
1374 if (!strcmp(jobname, o->wait_for)) {
1375 log_err("%s: a job cannot wait for itself (wait_for=%s).\n",
1376 jobname, o->wait_for);
1380 if (!(nw = check_waitees(o->wait_for))) {
1381 log_err("%s: waitee job %s unknown.\n", jobname, o->wait_for);
1386 log_err("%s: multiple waitees %s found,\n"
1387 "please avoid duplicates when using wait_for option.\n",
1388 jobname, o->wait_for);
1396 * Adds a job to the list of things todo. Sanitizes the various options
1397 * to make sure we don't have conflicts, and initializes various
1400 static int add_job(struct thread_data *td, const char *jobname, int job_add_num,
1401 int recursed, int client_type)
1404 char fname[PATH_MAX];
1405 int numjobs, file_alloced;
1406 struct thread_options *o = &td->o;
1407 char logname[PATH_MAX + 32];
1410 * the def_thread is just for options, it's not a real job
1412 if (td == &def_thread)
1418 * if we are just dumping the output command line, don't add the job
1420 if (parse_dryrun()) {
1425 td->client_type = client_type;
1427 if (profile_td_init(td))
1430 if (ioengine_load(td))
1434 if (!o->filename && !td->files_index && !o->read_iolog_file) {
1437 if (o->nr_files == 1 && exists_and_not_regfile(jobname))
1438 add_file(td, jobname, job_add_num, 0);
1440 for (i = 0; i < o->nr_files; i++)
1441 add_file(td, make_filename(fname, sizeof(fname), o, jobname, job_add_num, i), job_add_num, 0);
1445 if (fixup_options(td))
1449 * Belongs to fixup_options, but o->name is not necessarily set as yet
1451 if (!wait_for_ok(jobname, o))
1457 * IO engines only need this for option callbacks, and the address may
1458 * change in subprocesses.
1461 *(struct thread_data **)td->eo = NULL;
1463 if (td_ioengine_flagged(td, FIO_DISKLESSIO)) {
1466 for_each_file(td, f, i)
1467 f->real_file_size = -1ULL;
1470 td->mutex = fio_mutex_init(FIO_MUTEX_LOCKED);
1472 td->ts.clat_percentiles = o->clat_percentiles;
1473 td->ts.lat_percentiles = o->lat_percentiles;
1474 td->ts.percentile_precision = o->percentile_precision;
1475 memcpy(td->ts.percentile_list, o->percentile_list, sizeof(o->percentile_list));
1476 td->ts.sig_figs = o->sig_figs;
1478 for (i = 0; i < DDIR_RWDIR_CNT; i++) {
1479 td->ts.clat_stat[i].min_val = ULONG_MAX;
1480 td->ts.slat_stat[i].min_val = ULONG_MAX;
1481 td->ts.lat_stat[i].min_val = ULONG_MAX;
1482 td->ts.bw_stat[i].min_val = ULONG_MAX;
1483 td->ts.iops_stat[i].min_val = ULONG_MAX;
1485 td->ts.sync_stat.min_val = ULONG_MAX;
1486 td->ddir_seq_nr = o->ddir_seq_nr;
1488 if ((o->stonewall || o->new_group) && prev_group_jobs) {
1489 prev_group_jobs = 0;
1491 if (groupid == INT_MAX) {
1492 log_err("fio: too many groups defined\n");
1497 td->groupid = groupid;
1500 if (setup_random_seeds(td)) {
1501 td_verror(td, errno, "setup_random_seeds");
1508 if (o->write_lat_log) {
1509 struct log_params p = {
1511 .avg_msec = o->log_avg_msec,
1512 .hist_msec = o->log_hist_msec,
1513 .hist_coarseness = o->log_hist_coarseness,
1514 .log_type = IO_LOG_TYPE_LAT,
1515 .log_offset = o->log_offset,
1516 .log_gz = o->log_gz,
1517 .log_gz_store = o->log_gz_store,
1519 const char *pre = o->lat_log_file ? o->lat_log_file : o->name;
1527 gen_log_name(logname, sizeof(logname), "lat", pre,
1528 td->thread_number, suf, o->per_job_logs);
1529 setup_log(&td->lat_log, &p, logname);
1531 gen_log_name(logname, sizeof(logname), "slat", pre,
1532 td->thread_number, suf, o->per_job_logs);
1533 setup_log(&td->slat_log, &p, logname);
1535 gen_log_name(logname, sizeof(logname), "clat", pre,
1536 td->thread_number, suf, o->per_job_logs);
1537 setup_log(&td->clat_log, &p, logname);
1540 if (o->write_hist_log) {
1541 struct log_params p = {
1543 .avg_msec = o->log_avg_msec,
1544 .hist_msec = o->log_hist_msec,
1545 .hist_coarseness = o->log_hist_coarseness,
1546 .log_type = IO_LOG_TYPE_HIST,
1547 .log_offset = o->log_offset,
1548 .log_gz = o->log_gz,
1549 .log_gz_store = o->log_gz_store,
1551 const char *pre = o->hist_log_file ? o->hist_log_file : o->name;
1555 if (td->client_type) {
1556 log_err("fio: --write_hist_log requires zlib in client/server mode\n");
1566 gen_log_name(logname, sizeof(logname), "clat_hist", pre,
1567 td->thread_number, suf, o->per_job_logs);
1568 setup_log(&td->clat_hist_log, &p, logname);
1571 if (o->write_bw_log) {
1572 struct log_params p = {
1574 .avg_msec = o->log_avg_msec,
1575 .hist_msec = o->log_hist_msec,
1576 .hist_coarseness = o->log_hist_coarseness,
1577 .log_type = IO_LOG_TYPE_BW,
1578 .log_offset = o->log_offset,
1579 .log_gz = o->log_gz,
1580 .log_gz_store = o->log_gz_store,
1582 const char *pre = o->bw_log_file ? o->bw_log_file : o->name;
1585 if (fio_option_is_set(o, bw_avg_time))
1586 p.avg_msec = min(o->log_avg_msec, o->bw_avg_time);
1588 o->bw_avg_time = p.avg_msec;
1590 p.hist_msec = o->log_hist_msec;
1591 p.hist_coarseness = o->log_hist_coarseness;
1598 gen_log_name(logname, sizeof(logname), "bw", pre,
1599 td->thread_number, suf, o->per_job_logs);
1600 setup_log(&td->bw_log, &p, logname);
1602 if (o->write_iops_log) {
1603 struct log_params p = {
1605 .avg_msec = o->log_avg_msec,
1606 .hist_msec = o->log_hist_msec,
1607 .hist_coarseness = o->log_hist_coarseness,
1608 .log_type = IO_LOG_TYPE_IOPS,
1609 .log_offset = o->log_offset,
1610 .log_gz = o->log_gz,
1611 .log_gz_store = o->log_gz_store,
1613 const char *pre = o->iops_log_file ? o->iops_log_file : o->name;
1616 if (fio_option_is_set(o, iops_avg_time))
1617 p.avg_msec = min(o->log_avg_msec, o->iops_avg_time);
1619 o->iops_avg_time = p.avg_msec;
1621 p.hist_msec = o->log_hist_msec;
1622 p.hist_coarseness = o->log_hist_coarseness;
1629 gen_log_name(logname, sizeof(logname), "iops", pre,
1630 td->thread_number, suf, o->per_job_logs);
1631 setup_log(&td->iops_log, &p, logname);
1635 o->name = strdup(jobname);
1637 if (output_format & FIO_OUTPUT_NORMAL) {
1639 if (is_backend && !recursed)
1640 fio_server_send_add_job(td);
1642 if (!td_ioengine_flagged(td, FIO_NOIO)) {
1643 char *c1, *c2, *c3, *c4;
1644 char *c5 = NULL, *c6 = NULL;
1645 int i2p = is_power_of_2(o->kb_base);
1647 c1 = num2str(o->min_bs[DDIR_READ], o->sig_figs, 1, i2p, N2S_BYTE);
1648 c2 = num2str(o->max_bs[DDIR_READ], o->sig_figs, 1, i2p, N2S_BYTE);
1649 c3 = num2str(o->min_bs[DDIR_WRITE], o->sig_figs, 1, i2p, N2S_BYTE);
1650 c4 = num2str(o->max_bs[DDIR_WRITE], o->sig_figs, 1, i2p, N2S_BYTE);
1652 if (!o->bs_is_seq_rand) {
1653 c5 = num2str(o->min_bs[DDIR_TRIM], o->sig_figs, 1, i2p, N2S_BYTE);
1654 c6 = num2str(o->max_bs[DDIR_TRIM], o->sig_figs, 1, i2p, N2S_BYTE);
1657 log_info("%s: (g=%d): rw=%s, ", td->o.name,
1659 ddir_str(o->td_ddir));
1661 if (o->bs_is_seq_rand)
1662 log_info("bs=(R) %s-%s, (W) %s-%s, bs_is_seq_rand, ",
1665 log_info("bs=(R) %s-%s, (W) %s-%s, (T) %s-%s, ",
1666 c1, c2, c3, c4, c5, c6);
1668 log_info("ioengine=%s, iodepth=%u\n",
1669 td->io_ops->name, o->iodepth);
1678 } else if (job_add_num == 1)
1682 if (td_steadystate_init(td))
1686 * recurse add identical jobs, clear numjobs and stonewall options
1687 * as they don't apply to sub-jobs
1689 numjobs = o->numjobs;
1691 struct thread_data *td_new = get_new_job(false, td, true, jobname);
1696 td_new->o.numjobs = 1;
1697 td_new->o.stonewall = 0;
1698 td_new->o.new_group = 0;
1699 td_new->subjob_number = numjobs;
1700 td_new->o.ss_dur = o->ss_dur * 1000000l;
1701 td_new->o.ss_limit = o->ss_limit;
1704 if (td_new->files) {
1706 for_each_file(td_new, f, i) {
1708 sfree(f->file_name);
1711 free(td_new->files);
1712 td_new->files = NULL;
1714 td_new->files_index = 0;
1715 td_new->files_size = 0;
1716 if (td_new->o.filename) {
1717 free(td_new->o.filename);
1718 td_new->o.filename = NULL;
1722 if (add_job(td_new, jobname, numjobs, 1, client_type))
1733 * Parse as if 'o' was a command line
1735 void add_job_opts(const char **o, int client_type)
1737 struct thread_data *td, *td_parent;
1738 int i, in_global = 1;
1742 td_parent = td = NULL;
1744 if (!strncmp(o[i], "name", 4)) {
1747 add_job(td, jobname, 0, 0, client_type);
1749 sprintf(jobname, "%s", o[i] + 5);
1751 if (in_global && !td_parent)
1752 td_parent = get_new_job(true, &def_thread, false, jobname);
1753 else if (!in_global && !td) {
1755 td_parent = &def_thread;
1756 td = get_new_job(false, td_parent, false, jobname);
1759 fio_options_parse(td_parent, (char **) &o[i], 1);
1761 fio_options_parse(td, (char **) &o[i], 1);
1766 add_job(td, jobname, 0, 0, client_type);
1769 static int skip_this_section(const char *name)
1773 if (!nr_job_sections)
1775 if (!strncmp(name, "global", 6))
1778 for (i = 0; i < nr_job_sections; i++)
1779 if (!strcmp(job_sections[i], name))
1785 static int is_empty_or_comment(char *line)
1789 for (i = 0; i < strlen(line); i++) {
1794 if (!isspace((int) line[i]) && !iscntrl((int) line[i]))
1802 * This is our [ini] type file parser.
1804 static int __parse_jobs_ini(struct thread_data *td,
1805 char *file, int is_buf, int stonewall_flag, int type,
1806 int nested, char *name, char ***popts, int *aopts, int *nopts)
1808 bool global = false;
1812 int ret = 0, stonewall;
1815 int inside_skip = 0;
1817 int i, alloc_opts, num_opts;
1819 dprint(FD_PARSE, "Parsing ini file %s\n", file);
1820 assert(td || !nested);
1825 if (!strcmp(file, "-"))
1828 f = fopen(file, "r");
1833 log_err("fio: unable to open '%s' job file\n", file);
1835 td_verror(td, __err, "job file open");
1840 string = malloc(4096);
1843 * it's really 256 + small bit, 280 should suffice
1847 memset(name, 0, 280);
1851 if (nested && popts) {
1853 alloc_opts = *aopts;
1859 opts = malloc(sizeof(char *) * alloc_opts);
1863 stonewall = stonewall_flag;
1866 * if skip_fgets is set, we already have loaded a line we
1871 p = strsep(&file, "\n");
1873 p = fgets(string, 4096, f);
1879 strip_blank_front(&p);
1882 dprint(FD_PARSE, "%s\n", p);
1883 if (is_empty_or_comment(p))
1887 if (sscanf(p, "[%255[^\n]]", name) != 1) {
1891 log_err("fio: option <%s> outside of "
1892 "[] job section\n", p);
1897 name[strlen(name) - 1] = '\0';
1899 if (skip_this_section(name)) {
1905 dprint(FD_PARSE, "Parsing section [%s]\n", name);
1907 global = !strncmp(name, "global", 6);
1913 log_info("--name=%s ", name);
1917 td = get_new_job(global, &def_thread, false, name);
1924 * Separate multiple job files by a stonewall
1926 if (!global && stonewall) {
1927 td->o.stonewall = stonewall;
1932 memset(opts, 0, alloc_opts * sizeof(char *));
1940 p = strsep(&file, "\n");
1942 p = fgets(string, 4096, f);
1945 dprint(FD_PARSE, "%s", p);
1950 if (is_empty_or_comment(p))
1953 strip_blank_front(&p);
1956 * new section, break out and make sure we don't
1957 * fgets() a new line at the top.
1961 log_err("No new sections in included files\n");
1971 if (!strncmp(p, "include", strlen("include"))) {
1972 char *filename = p + strlen("include") + 1,
1973 *ts, *full_fn = NULL;
1976 * Allow for the include filename
1977 * specification to be relative.
1979 if (access(filename, F_OK) &&
1980 (ts = strrchr(file, '/'))) {
1981 int len = ts - file +
1982 strlen(filename) + 2;
1984 if (!(full_fn = calloc(1, len))) {
1990 file, (ts - file) + 1);
1991 strncpy(full_fn + (ts - file) + 1,
1992 filename, strlen(filename));
1993 full_fn[len - 1] = 0;
1997 ret = __parse_jobs_ini(td, filename, is_buf,
1998 stonewall_flag, type, 1,
2000 &alloc_opts, &num_opts);
2003 log_err("Error %d while parsing "
2004 "include file %s\n",
2017 if (num_opts == alloc_opts) {
2019 opts = realloc(opts,
2020 alloc_opts * sizeof(char *));
2023 opts[num_opts] = strdup(p);
2029 *aopts = alloc_opts;
2034 ret = fio_options_parse(td, opts, num_opts);
2039 ret = add_job(td, name, 0, 0, type);
2041 log_err("fio: job %s dropped\n", name);
2045 for (i = 0; i < num_opts; i++)
2054 while (i < nr_job_sections) {
2055 free(job_sections[i]);
2064 if (!is_buf && f != stdin)
2069 int parse_jobs_ini(char *file, int is_buf, int stonewall_flag, int type)
2071 return __parse_jobs_ini(NULL, file, is_buf, stonewall_flag, type,
2072 0, NULL, NULL, NULL, NULL);
2075 static int fill_def_thread(void)
2077 memset(&def_thread, 0, sizeof(def_thread));
2078 INIT_FLIST_HEAD(&def_thread.opt_list);
2080 fio_getaffinity(getpid(), &def_thread.o.cpumask);
2081 def_thread.o.error_dump = 1;
2084 * fill default options
2086 fio_fill_default_options(&def_thread);
2090 static void show_debug_categories(void)
2092 #ifdef FIO_INC_DEBUG
2093 struct debug_level *dl = &debug_levels[0];
2094 int curlen, first = 1;
2098 int has_next = (dl + 1)->name != NULL;
2100 if (first || curlen + strlen(dl->name) >= 80) {
2105 curlen += printf("\t\t\t%s", dl->name);
2106 curlen += 3 * (8 - 1);
2108 curlen += printf(",");
2110 curlen += printf("%s", dl->name);
2112 curlen += printf(",");
2122 * Following options aren't printed by usage().
2123 * --append-terse - Equivalent to --output-format=terse, see f6a7df53.
2124 * --latency-log - Deprecated option.
2126 static void usage(const char *name)
2128 printf("%s\n", fio_version_string);
2129 printf("%s [options] [job options] <job file(s)>\n", name);
2130 printf(" --debug=options\tEnable debug logging. May be one/more of:\n");
2131 show_debug_categories();
2132 printf(" --parse-only\t\tParse options only, don't start any IO\n");
2133 printf(" --output\t\tWrite output to file\n");
2134 printf(" --bandwidth-log\tGenerate aggregate bandwidth logs\n");
2135 printf(" --minimal\t\tMinimal (terse) output\n");
2136 printf(" --output-format=type\tOutput format (terse,json,json+,normal)\n");
2137 printf(" --terse-version=type\tSet terse version output format"
2138 " (default 3, or 2 or 4)\n");
2139 printf(" --version\t\tPrint version info and exit\n");
2140 printf(" --help\t\tPrint this page\n");
2141 printf(" --cpuclock-test\tPerform test/validation of CPU clock\n");
2142 printf(" --crctest=[type]\tTest speed of checksum functions\n");
2143 printf(" --cmdhelp=cmd\t\tPrint command help, \"all\" for all of"
2145 printf(" --enghelp=engine\tPrint ioengine help, or list"
2146 " available ioengines\n");
2147 printf(" --enghelp=engine,cmd\tPrint help for an ioengine"
2149 printf(" --showcmd\t\tTurn a job file into command line options\n");
2150 printf(" --eta=when\t\tWhen ETA estimate should be printed\n");
2151 printf(" \t\tMay be \"always\", \"never\" or \"auto\"\n");
2152 printf(" --eta-newline=time\tForce a new line for every 'time'");
2153 printf(" period passed\n");
2154 printf(" --status-interval=t\tForce full status dump every");
2155 printf(" 't' period passed\n");
2156 printf(" --readonly\t\tTurn on safety read-only checks, preventing"
2158 printf(" --section=name\tOnly run specified section in job file,"
2159 " multiple sections can be specified\n");
2160 printf(" --alloc-size=kb\tSet smalloc pool to this size in kb"
2162 printf(" --warnings-fatal\tFio parser warnings are fatal\n");
2163 printf(" --max-jobs=nr\t\tMaximum number of threads/processes to support\n");
2164 printf(" --server=args\t\tStart a backend fio server\n");
2165 printf(" --daemonize=pidfile\tBackground fio server, write pid to file\n");
2166 printf(" --client=hostname\tTalk to remote backend(s) fio server at hostname\n");
2167 printf(" --remote-config=file\tTell fio server to load this local job file\n");
2168 printf(" --idle-prof=option\tReport cpu idleness on a system or percpu basis\n"
2169 "\t\t\t(option=system,percpu) or run unit work\n"
2170 "\t\t\tcalibration only (option=calibrate)\n");
2172 printf(" --inflate-log=log\tInflate and output compressed log\n");
2174 printf(" --trigger-file=file\tExecute trigger cmd when file exists\n");
2175 printf(" --trigger-timeout=t\tExecute trigger at this time\n");
2176 printf(" --trigger=cmd\t\tSet this command as local trigger\n");
2177 printf(" --trigger-remote=cmd\tSet this command as remote trigger\n");
2178 printf(" --aux-path=path\tUse this path for fio state generated files\n");
2179 printf("\nFio was written by Jens Axboe <axboe@kernel.dk>\n");
2182 #ifdef FIO_INC_DEBUG
2183 struct debug_level debug_levels[] = {
2184 { .name = "process",
2185 .help = "Process creation/exit logging",
2186 .shift = FD_PROCESS,
2189 .help = "File related action logging",
2193 .help = "IO and IO engine action logging (offsets, queue, completions, etc)",
2197 .help = "Memory allocation/freeing logging",
2200 { .name = "blktrace",
2201 .help = "blktrace action logging",
2202 .shift = FD_BLKTRACE,
2205 .help = "IO verification action logging",
2209 .help = "Random generation logging",
2213 .help = "Parser logging",
2216 { .name = "diskutil",
2217 .help = "Disk utility logging actions",
2218 .shift = FD_DISKUTIL,
2221 .help = "Logging related to creating/destroying jobs",
2225 .help = "Mutex logging",
2228 { .name = "profile",
2229 .help = "Logging related to profiles",
2230 .shift = FD_PROFILE,
2233 .help = "Logging related to time keeping functions",
2237 .help = "Network logging",
2241 .help = "Rate logging",
2244 { .name = "compress",
2245 .help = "Log compression logging",
2246 .shift = FD_COMPRESS,
2248 { .name = "steadystate",
2249 .help = "Steady state detection logging",
2250 .shift = FD_STEADYSTATE,
2252 { .name = "helperthread",
2253 .help = "Helper thread logging",
2254 .shift = FD_HELPERTHREAD,
2259 static int set_debug(const char *string)
2261 struct debug_level *dl;
2262 char *p = (char *) string;
2269 if (!strcmp(string, "?") || !strcmp(string, "help")) {
2270 log_info("fio: dumping debug options:");
2271 for (i = 0; debug_levels[i].name; i++) {
2272 dl = &debug_levels[i];
2273 log_info("%s,", dl->name);
2279 while ((opt = strsep(&p, ",")) != NULL) {
2282 if (!strncmp(opt, "all", 3)) {
2283 log_info("fio: set all debug options\n");
2288 for (i = 0; debug_levels[i].name; i++) {
2289 dl = &debug_levels[i];
2290 found = !strncmp(opt, dl->name, strlen(dl->name));
2294 if (dl->shift == FD_JOB) {
2295 opt = strchr(opt, ':');
2297 log_err("fio: missing job number\n");
2301 fio_debug_jobno = atoi(opt);
2302 log_info("fio: set debug jobno %d\n",
2305 log_info("fio: set debug option %s\n", opt);
2306 fio_debug |= (1UL << dl->shift);
2312 log_err("fio: debug mask %s not found\n", opt);
2317 static int set_debug(const char *string)
2319 log_err("fio: debug tracing not included in build\n");
2324 static void fio_options_fill_optstring(void)
2326 char *ostr = cmd_optstr;
2330 while (l_opts[i].name) {
2331 ostr[c++] = l_opts[i].val;
2332 if (l_opts[i].has_arg == required_argument)
2334 else if (l_opts[i].has_arg == optional_argument) {
2343 static int client_flag_set(char c)
2348 while (l_opts[i].name) {
2349 int val = l_opts[i].val;
2351 if (c == (val & 0xff))
2352 return (val & FIO_CLIENT_FLAG);
2360 static void parse_cmd_client(void *client, char *opt)
2362 fio_client_add_cmd_option(client, opt);
2365 static void show_closest_option(const char *name)
2367 int best_option, best_distance;
2370 while (*name == '-')
2374 best_distance = INT_MAX;
2376 while (l_opts[i].name) {
2377 distance = string_distance(name, l_opts[i].name);
2378 if (distance < best_distance) {
2379 best_distance = distance;
2385 if (best_option != -1 && string_distance_ok(name, best_distance))
2386 log_err("Did you mean %s?\n", l_opts[best_option].name);
2389 static int parse_output_format(const char *optarg)
2391 char *p, *orig, *opt;
2394 p = orig = strdup(optarg);
2398 while ((opt = strsep(&p, ",")) != NULL) {
2399 if (!strcmp(opt, "minimal") ||
2400 !strcmp(opt, "terse") ||
2401 !strcmp(opt, "csv"))
2402 output_format |= FIO_OUTPUT_TERSE;
2403 else if (!strcmp(opt, "json"))
2404 output_format |= FIO_OUTPUT_JSON;
2405 else if (!strcmp(opt, "json+"))
2406 output_format |= (FIO_OUTPUT_JSON | FIO_OUTPUT_JSON_PLUS);
2407 else if (!strcmp(opt, "normal"))
2408 output_format |= FIO_OUTPUT_NORMAL;
2410 log_err("fio: invalid output format %s\n", opt);
2420 int parse_cmd_line(int argc, char *argv[], int client_type)
2422 struct thread_data *td = NULL;
2423 int c, ini_idx = 0, lidx, ret = 0, do_exit = 0, exit_val = 0;
2424 char *ostr = cmd_optstr;
2425 char *pid_file = NULL;
2426 void *cur_client = NULL;
2430 * Reset optind handling, since we may call this multiple times
2435 while ((c = getopt_long_only(argc, argv, ostr, l_opts, &lidx)) != -1) {
2436 if ((c & FIO_CLIENT_FLAG) || client_flag_set(c)) {
2437 parse_cmd_client(cur_client, argv[optind - 1]);
2438 c &= ~FIO_CLIENT_FLAG;
2443 smalloc_pool_size = atoi(optarg);
2444 smalloc_pool_size <<= 10;
2448 log_err("fio: --latency-log is deprecated. Use per-job latency log options.\n");
2458 if (f_out && f_out != stdout)
2461 tmp = fopen(optarg, "w+");
2463 log_err("fio: output file open error: %s\n", strerror(errno));
2468 f_err = f_out = tmp;
2472 output_format = FIO_OUTPUT_TERSE;
2475 if (parse_output_format(optarg)) {
2476 log_err("fio: failed parsing output-format\n");
2483 output_format |= FIO_OUTPUT_TERSE;
2495 fio_show_option_help(optarg);
2502 fio_show_ioengine_help(optarg);
2516 log_info("%s\n", fio_version_string);
2521 terse_version = atoi(optarg);
2522 if (!(terse_version >= 2 && terse_version <= 5)) {
2523 log_err("fio: bad terse version format\n");
2529 if (!strcmp("always", optarg))
2530 eta_print = FIO_ETA_ALWAYS;
2531 else if (!strcmp("never", optarg))
2532 eta_print = FIO_ETA_NEVER;
2537 if (check_str_time(optarg, &t, 1)) {
2538 log_err("fio: failed parsing eta time %s\n", optarg);
2543 eta_new_line = t / 1000;
2544 if (!eta_new_line) {
2545 log_err("fio: eta new line time too short\n");
2554 if (check_str_time(optarg, &t, 1)) {
2555 log_err("fio: failed parsing eta interval %s\n", optarg);
2560 eta_interval_msec = t / 1000;
2561 if (eta_interval_msec < DISK_UTIL_MSEC) {
2562 log_err("fio: eta interval time too short (%umsec min)\n", DISK_UTIL_MSEC);
2569 if (set_debug(optarg))
2579 if (!strcmp(optarg, "global")) {
2580 log_err("fio: can't use global as only "
2586 new_size = (nr_job_sections + 1) * sizeof(char *);
2587 job_sections = realloc(job_sections, new_size);
2588 job_sections[nr_job_sections] = strdup(optarg);
2594 exit_val = iolog_file_inflate(optarg);
2603 exec_profile = strdup(optarg);
2605 case FIO_GETOPT_JOB: {
2606 const char *opt = l_opts[lidx].name;
2609 if (!strncmp(opt, "name", 4) && td) {
2610 ret = add_job(td, td->o.name ?: "fio", 0, 0, client_type);
2617 int is_section = !strncmp(opt, "name", 4);
2620 if (!is_section || !strncmp(val, "global", 6))
2623 if (is_section && skip_this_section(val))
2626 td = get_new_job(global, &def_thread, true, NULL);
2627 if (!td || ioengine_load(td)) {
2636 fio_options_set_ioengine_opts(l_opts, td);
2639 if ((!val || !strlen(val)) &&
2640 l_opts[lidx].has_arg == required_argument) {
2641 log_err("fio: option %s requires an argument\n", opt);
2644 ret = fio_cmd_option_parse(td, opt, val);
2655 if (!ret && !strcmp(opt, "ioengine")) {
2656 if (ioengine_load(td)) {
2663 fio_options_set_ioengine_opts(l_opts, td);
2667 case FIO_GETOPT_IOENGINE: {
2668 const char *opt = l_opts[lidx].name;
2674 ret = fio_cmd_ioengine_option_parse(td, opt, val);
2681 max_jobs = atoi(optarg);
2682 if (!max_jobs || max_jobs > REAL_MAX_JOBS) {
2683 log_err("fio: invalid max jobs: %d\n", max_jobs);
2690 #ifndef CONFIG_NO_SHM
2692 log_err("fio: can't be both client and server\n");
2698 fio_server_set_arg(optarg);
2702 log_err("fio: client/server requires SHM support\n");
2710 pid_file = strdup(optarg);
2713 if ((ret = fio_idle_prof_parse_opt(optarg))) {
2714 /* exit on error and calibration only */
2724 log_err("fio: can't be both client and server\n");
2729 /* if --client parameter contains a pathname */
2730 if (0 == access(optarg, R_OK)) {
2731 /* file contains a list of host addrs or names */
2732 char hostaddr[PATH_MAX] = {0};
2734 FILE * hostf = fopen(optarg, "r");
2736 log_err("fio: could not open client list file %s for read\n", optarg);
2741 sprintf(formatstr, "%%%ds", PATH_MAX - 1);
2743 * read at most PATH_MAX-1 chars from each
2744 * record in this file
2746 while (fscanf(hostf, formatstr, hostaddr) == 1) {
2747 /* expect EVERY host in file to be valid */
2748 if (fio_client_add(&fio_client_ops, hostaddr, &cur_client)) {
2749 log_err("fio: failed adding client %s from file %s\n", hostaddr, optarg);
2756 break; /* no possibility of job file for "this client only" */
2758 if (fio_client_add(&fio_client_ops, optarg, &cur_client)) {
2759 log_err("fio: failed adding client %s\n", optarg);
2765 * If the next argument exists and isn't an option,
2766 * assume it's a job file for this client only.
2768 while (optind < argc) {
2769 if (!strncmp(argv[optind], "--", 2) ||
2770 !strncmp(argv[optind], "-", 1))
2773 if (fio_client_add_ini_file(cur_client, argv[optind], false))
2780 if (fio_client_add_ini_file(cur_client, optarg, true)) {
2788 exit_val = fio_monotonic_clocktest(1);
2793 exit_val = fio_crctest(optarg);
2798 exit_val = fio_memcpy_test(optarg);
2803 if (check_str_time(optarg, &val, 1)) {
2804 log_err("fio: failed parsing time %s\n", optarg);
2810 log_err("fio: status interval too small\n");
2814 status_interval = val / 1000;
2820 trigger_file = strdup(optarg);
2825 trigger_cmd = strdup(optarg);
2828 if (trigger_remote_cmd)
2829 free(trigger_remote_cmd);
2830 trigger_remote_cmd = strdup(optarg);
2835 aux_path = strdup(optarg);
2838 if (check_str_time(optarg, &trigger_timeout, 1)) {
2839 log_err("fio: failed parsing time %s\n", optarg);
2843 trigger_timeout /= 1000000;
2846 log_err("%s: unrecognized option '%s'\n", argv[0],
2848 show_closest_option(argv[optind - 1]);
2858 if (do_exit && !(is_backend || nr_clients))
2861 if (nr_clients && fio_clients_connect())
2864 if (is_backend && backend)
2865 return fio_start_server(pid_file);
2871 ret = add_job(td, td->o.name ?: "fio", 0, 0, client_type);
2877 while (!ret && optind < argc) {
2879 ini_file = realloc(ini_file, ini_idx * sizeof(char *));
2880 ini_file[ini_idx - 1] = strdup(argv[optind]);
2888 int fio_init_options(void)
2893 fio_options_fill_optstring();
2894 fio_options_dup_and_init(l_opts);
2898 if (fill_def_thread())
2904 extern int fio_check_options(struct thread_options *);
2906 int parse_options(int argc, char *argv[])
2908 const int type = FIO_CLIENT_TYPE_CLI;
2911 if (fio_init_options())
2913 if (fio_test_cconv(&def_thread.o))
2914 log_err("fio: failed internal cconv test\n");
2916 job_files = parse_cmd_line(argc, argv, type);
2918 if (job_files > 0) {
2919 for (i = 0; i < job_files; i++) {
2920 if (i && fill_def_thread())
2923 if (fio_clients_send_ini(ini_file[i]))
2926 } else if (!is_backend) {
2927 if (parse_jobs_ini(ini_file[i], 0, i, type))
2932 } else if (nr_clients) {
2933 if (fill_def_thread())
2935 if (fio_clients_send_ini(NULL))
2940 fio_options_free(&def_thread);
2941 filesetup_mem_free();
2943 if (!thread_number) {
2948 if (is_backend || nr_clients)
2953 log_err("No job(s) defined\n\n");
2958 if (output_format & FIO_OUTPUT_NORMAL)
2959 log_info("%s\n", fio_version_string);
2964 void options_default_fill(struct thread_options *o)
2966 memcpy(o, &def_thread.o, sizeof(*o));
2969 struct thread_data *get_global_options(void)