2 * This file contains job initialization and setup functions.
11 #include <sys/types.h>
13 #ifdef CONFIG_VALGRIND_DEV
14 #include <valgrind/drd.h>
16 #define DRD_IGNORE_VAR(x) do { } while (0)
20 #ifndef FIO_NO_HAVE_SHM_H
32 #include "steadystate.h"
35 #include "oslib/asprintf.h"
36 #include "oslib/getopt.h"
37 #include "oslib/strcasestr.h"
41 #include "lib/memcpy.h"
43 const char fio_version_string[] = FIO_VERSION;
45 #define FIO_RANDSEED (0xb1899bedUL)
47 static char **ini_file;
48 static int max_jobs = FIO_MAX_JOBS;
49 static bool dump_cmdline;
50 static bool parse_only;
51 static bool merge_blktrace_only;
53 static struct thread_data def_thread;
54 struct thread_segment segments[REAL_MAX_SEG];
55 static char **job_sections;
56 static int nr_job_sections;
58 bool exitall_on_terminate = false;
59 int output_format = FIO_OUTPUT_NORMAL;
60 int eta_print = FIO_ETA_AUTO;
61 unsigned int eta_interval_msec = 1000;
65 char *exec_profile = NULL;
66 int warnings_fatal = 0;
67 int terse_version = 3;
68 bool is_backend = false;
69 bool is_local_backend = false;
71 bool log_syslog = false;
73 bool write_bw_log = false;
74 bool read_only = false;
75 int status_interval = 0;
77 char *trigger_file = NULL;
78 long long trigger_timeout = 0;
79 char *trigger_cmd = NULL;
80 char *trigger_remote_cmd = NULL;
82 char *aux_path = NULL;
84 static int prev_group_jobs;
86 unsigned long fio_debug = 0;
87 unsigned int fio_debug_jobno = -1;
88 unsigned int *fio_debug_jobp = NULL;
89 unsigned int *fio_warned = NULL;
91 static char cmd_optstr[256];
94 #define FIO_CLIENT_FLAG (1 << 16)
97 * Command line options. These will contain the above, plus a few
98 * extra that only pertain to fio itself and not jobs.
100 static struct option l_opts[FIO_NR_OPTIONS] = {
102 .name = (char *) "output",
103 .has_arg = required_argument,
104 .val = 'o' | FIO_CLIENT_FLAG,
107 .name = (char *) "latency-log",
108 .has_arg = required_argument,
109 .val = 'l' | FIO_CLIENT_FLAG,
112 .name = (char *) "bandwidth-log",
113 .has_arg = no_argument,
114 .val = 'b' | FIO_CLIENT_FLAG,
117 .name = (char *) "minimal",
118 .has_arg = no_argument,
119 .val = 'm' | FIO_CLIENT_FLAG,
122 .name = (char *) "output-format",
123 .has_arg = required_argument,
124 .val = 'F' | FIO_CLIENT_FLAG,
127 .name = (char *) "append-terse",
128 .has_arg = optional_argument,
132 .name = (char *) "version",
133 .has_arg = no_argument,
134 .val = 'v' | FIO_CLIENT_FLAG,
137 .name = (char *) "help",
138 .has_arg = no_argument,
139 .val = 'h' | FIO_CLIENT_FLAG,
142 .name = (char *) "cmdhelp",
143 .has_arg = optional_argument,
144 .val = 'c' | FIO_CLIENT_FLAG,
147 .name = (char *) "enghelp",
148 .has_arg = optional_argument,
149 .val = 'i' | FIO_CLIENT_FLAG,
152 .name = (char *) "showcmd",
153 .has_arg = no_argument,
154 .val = 's' | FIO_CLIENT_FLAG,
157 .name = (char *) "readonly",
158 .has_arg = no_argument,
159 .val = 'r' | FIO_CLIENT_FLAG,
162 .name = (char *) "eta",
163 .has_arg = required_argument,
164 .val = 'e' | FIO_CLIENT_FLAG,
167 .name = (char *) "eta-interval",
168 .has_arg = required_argument,
169 .val = 'O' | FIO_CLIENT_FLAG,
172 .name = (char *) "eta-newline",
173 .has_arg = required_argument,
174 .val = 'E' | FIO_CLIENT_FLAG,
177 .name = (char *) "debug",
178 .has_arg = required_argument,
179 .val = 'd' | FIO_CLIENT_FLAG,
182 .name = (char *) "parse-only",
183 .has_arg = no_argument,
184 .val = 'P' | FIO_CLIENT_FLAG,
187 .name = (char *) "section",
188 .has_arg = required_argument,
189 .val = 'x' | FIO_CLIENT_FLAG,
193 .name = (char *) "inflate-log",
194 .has_arg = required_argument,
195 .val = 'X' | FIO_CLIENT_FLAG,
199 .name = (char *) "alloc-size",
200 .has_arg = required_argument,
201 .val = 'a' | FIO_CLIENT_FLAG,
204 .name = (char *) "profile",
205 .has_arg = required_argument,
206 .val = 'p' | FIO_CLIENT_FLAG,
209 .name = (char *) "warnings-fatal",
210 .has_arg = no_argument,
211 .val = 'w' | FIO_CLIENT_FLAG,
214 .name = (char *) "max-jobs",
215 .has_arg = required_argument,
216 .val = 'j' | FIO_CLIENT_FLAG,
219 .name = (char *) "terse-version",
220 .has_arg = required_argument,
221 .val = 'V' | FIO_CLIENT_FLAG,
224 .name = (char *) "server",
225 .has_arg = optional_argument,
228 { .name = (char *) "daemonize",
229 .has_arg = required_argument,
233 .name = (char *) "client",
234 .has_arg = required_argument,
238 .name = (char *) "remote-config",
239 .has_arg = required_argument,
243 .name = (char *) "cpuclock-test",
244 .has_arg = no_argument,
248 .name = (char *) "crctest",
249 .has_arg = optional_argument,
253 .name = (char *) "memcpytest",
254 .has_arg = optional_argument,
258 .name = (char *) "idle-prof",
259 .has_arg = required_argument,
263 .name = (char *) "status-interval",
264 .has_arg = required_argument,
265 .val = 'L' | FIO_CLIENT_FLAG,
268 .name = (char *) "trigger-file",
269 .has_arg = required_argument,
273 .name = (char *) "trigger-timeout",
274 .has_arg = required_argument,
278 .name = (char *) "trigger",
279 .has_arg = required_argument,
283 .name = (char *) "trigger-remote",
284 .has_arg = required_argument,
288 .name = (char *) "aux-path",
289 .has_arg = required_argument,
293 .name = (char *) "merge-blktrace-only",
294 .has_arg = no_argument,
295 .val = 'A' | FIO_CLIENT_FLAG,
302 void free_threads_shm(void)
306 for (i = 0; i < nr_segments; i++) {
307 struct thread_segment *seg = &segments[i];
310 void *tp = seg->threads;
311 #ifndef CONFIG_NO_SHM
312 struct shmid_ds sbuf;
316 shmctl(seg->shm_id, IPC_RMID, &sbuf);
329 static void free_shm(void)
333 fio_debug_jobp = NULL;
340 free(trigger_remote_cmd);
341 trigger_file = trigger_cmd = trigger_remote_cmd = NULL;
343 options_free(fio_options, &def_thread.o);
349 static int add_thread_segment(void)
351 struct thread_segment *seg = &segments[nr_segments];
352 size_t size = JOBS_PER_SEG * sizeof(struct thread_data);
355 if (nr_segments + 1 >= REAL_MAX_SEG)
358 size += 2 * sizeof(unsigned int);
360 #ifndef CONFIG_NO_SHM
361 seg->shm_id = shmget(0, size, IPC_CREAT | 0600);
362 if (seg->shm_id == -1) {
363 if (errno != EINVAL && errno != ENOMEM && errno != ENOSPC)
368 seg->threads = malloc(size);
373 #ifndef CONFIG_NO_SHM
374 seg->threads = shmat(seg->shm_id, NULL, 0);
375 if (seg->threads == (void *) -1) {
379 if (shm_attach_to_open_removed())
380 shmctl(seg->shm_id, IPC_RMID, NULL);
385 memset(seg->threads, 0, JOBS_PER_SEG * sizeof(struct thread_data));
386 for (i = 0; i < JOBS_PER_SEG; i++)
387 DRD_IGNORE_VAR(seg->threads[i]);
390 /* Not first segment, we're done */
391 if (nr_segments != 1) {
396 fio_debug_jobp = (unsigned int *)(seg->threads + JOBS_PER_SEG);
397 *fio_debug_jobp = -1;
398 fio_warned = fio_debug_jobp + 1;
406 * The thread areas are shared between the main process and the job
407 * threads/processes, and is split into chunks of JOBS_PER_SEG. If the current
408 * segment has no more room, add a new chunk.
410 static int expand_thread_area(void)
412 struct thread_segment *seg = &segments[cur_segment];
414 if (nr_segments && seg->nr_threads < JOBS_PER_SEG)
417 return add_thread_segment();
420 static void dump_print_option(struct print_option *p)
424 if (!strcmp("description", p->name))
429 log_info("--%s%s", p->name, p->value ? "" : " ");
431 log_info("=%s%s%s ", delim, p->value, delim);
434 static void dump_opt_list(struct thread_data *td)
436 struct flist_head *entry;
437 struct print_option *p;
439 if (flist_empty(&td->opt_list))
442 flist_for_each(entry, &td->opt_list) {
443 p = flist_entry(entry, struct print_option, list);
444 dump_print_option(p);
448 static void fio_dump_options_free(struct thread_data *td)
450 while (!flist_empty(&td->opt_list)) {
451 struct print_option *p;
453 p = flist_first_entry(&td->opt_list, struct print_option, list);
454 flist_del_init(&p->list);
461 static void copy_opt_list(struct thread_data *dst, struct thread_data *src)
463 struct flist_head *entry;
465 if (flist_empty(&src->opt_list))
468 flist_for_each(entry, &src->opt_list) {
469 struct print_option *srcp, *dstp;
471 srcp = flist_entry(entry, struct print_option, list);
472 dstp = malloc(sizeof(*dstp));
473 dstp->name = strdup(srcp->name);
475 dstp->value = strdup(srcp->value);
478 flist_add_tail(&dstp->list, &dst->opt_list);
483 * Return a free job structure.
485 static struct thread_data *get_new_job(bool global, struct thread_data *parent,
486 bool preserve_eo, const char *jobname)
488 struct thread_segment *seg;
489 struct thread_data *td;
493 if (expand_thread_area()) {
494 log_err("error: failed to setup shm segment\n");
497 if (thread_number >= max_jobs) {
498 log_err("error: maximum number of jobs (%d) reached.\n",
503 seg = &segments[cur_segment];
504 td = &seg->threads[seg->nr_threads++];
508 INIT_FLIST_HEAD(&td->opt_list);
509 if (parent != &def_thread)
510 copy_opt_list(td, parent);
517 td->o.uid = td->o.gid = -1U;
519 dup_files(td, parent);
520 fio_options_mem_dupe(td);
522 profile_add_hooks(td);
524 td->thread_number = thread_number;
525 td->subjob_number = 0;
528 td->o.name = strdup(jobname);
530 if (!parent->o.group_reporting || parent == &def_thread)
536 static void put_job(struct thread_data *td)
538 if (td == &def_thread)
545 log_info("fio: %s\n", td->verror);
547 fio_options_free(td);
548 fio_dump_options_free(td);
555 memset(td, 0, sizeof(*td));
556 segments[cur_segment].nr_threads--;
560 static int __setup_rate(struct thread_data *td, enum fio_ddir ddir)
562 unsigned long long bs = td->o.min_bs[ddir];
564 assert(ddir_rw(ddir));
566 if (td->o.rate[ddir])
567 td->rate_bps[ddir] = td->o.rate[ddir];
569 td->rate_bps[ddir] = (uint64_t) td->o.rate_iops[ddir] * bs;
571 if (!td->rate_bps[ddir]) {
572 log_err("rate lower than supported\n");
576 td->rate_next_io_time[ddir] = 0;
577 td->rate_io_issue_bytes[ddir] = 0;
578 td->last_usec[ddir] = 0;
582 static int setup_rate(struct thread_data *td)
586 for_each_rw_ddir(ddir) {
587 if (td->o.rate[ddir] || td->o.rate_iops[ddir]) {
588 ret |= __setup_rate(td, ddir);
594 static int fixed_block_size(struct thread_options *o)
596 return o->min_bs[DDIR_READ] == o->max_bs[DDIR_READ] &&
597 o->min_bs[DDIR_WRITE] == o->max_bs[DDIR_WRITE] &&
598 o->min_bs[DDIR_TRIM] == o->max_bs[DDIR_TRIM] &&
599 o->min_bs[DDIR_READ] == o->min_bs[DDIR_WRITE] &&
600 o->min_bs[DDIR_READ] == o->min_bs[DDIR_TRIM];
606 static unsigned int gcd(unsigned int m, unsigned int n)
611 return gcd(n, m % n);
615 * Lazy way of fixing up options that depend on each other. We could also
616 * define option callback handlers, but this is easier.
618 static int fixup_options(struct thread_data *td)
620 struct thread_options *o = &td->o;
623 if (read_only && (td_write(td) || td_trim(td))) {
624 log_err("fio: trim and write operations are not allowed"
625 " with the --readonly parameter.\n");
629 #ifndef CONFIG_PSHARED
630 if (!o->use_thread) {
631 log_info("fio: this platform does not support process shared"
632 " mutexes, forcing use of threads. Use the 'thread'"
633 " option to get rid of this warning.\n");
635 ret |= warnings_fatal;
639 if (o->write_iolog_file && o->read_iolog_file) {
640 log_err("fio: read iolog overrides write_iolog\n");
641 free(o->write_iolog_file);
642 o->write_iolog_file = NULL;
643 ret |= warnings_fatal;
646 if (o->zone_mode == ZONE_MODE_NONE && o->zone_size) {
647 log_err("fio: --zonemode=none and --zonesize are not compatible.\n");
651 if (o->zone_mode == ZONE_MODE_STRIDED && !o->zone_size) {
652 log_err("fio: --zonesize must be specified when using --zonemode=strided.\n");
656 if (o->zone_mode == ZONE_MODE_NOT_SPECIFIED) {
658 o->zone_mode = ZONE_MODE_STRIDED;
660 o->zone_mode = ZONE_MODE_NONE;
664 * Strided zone mode only really works with 1 file.
666 if (o->zone_mode == ZONE_MODE_STRIDED && o->open_files > 1)
667 o->zone_mode = ZONE_MODE_NONE;
670 * If zone_range isn't specified, backward compatibility dictates it
671 * should be made equal to zone_size.
673 if (o->zone_mode == ZONE_MODE_STRIDED && !o->zone_range)
674 o->zone_range = o->zone_size;
677 * Reads can do overwrites, we always need to pre-create the file
682 for_each_rw_ddir(ddir) {
683 if (!o->min_bs[ddir])
684 o->min_bs[ddir] = o->bs[ddir];
685 if (!o->max_bs[ddir])
686 o->max_bs[ddir] = o->bs[ddir];
690 for_each_rw_ddir(ddir) {
691 o->rw_min_bs = min(o->rw_min_bs, o->min_bs[ddir]);
695 * For random IO, allow blockalign offset other than min_bs.
697 for_each_rw_ddir(ddir) {
698 if (!o->ba[ddir] || !td_random(td))
699 o->ba[ddir] = o->min_bs[ddir];
702 if ((o->ba[DDIR_READ] != o->min_bs[DDIR_READ] ||
703 o->ba[DDIR_WRITE] != o->min_bs[DDIR_WRITE] ||
704 o->ba[DDIR_TRIM] != o->min_bs[DDIR_TRIM]) &&
706 log_err("fio: Any use of blockalign= turns off randommap\n");
708 ret |= warnings_fatal;
711 if (!o->file_size_high)
712 o->file_size_high = o->file_size_low;
714 if (o->start_delay_high) {
715 if (!o->start_delay_orig)
716 o->start_delay_orig = o->start_delay;
717 o->start_delay = rand_between(&td->delay_state,
719 o->start_delay_high);
722 if (o->norandommap && o->verify != VERIFY_NONE
723 && !fixed_block_size(o)) {
724 log_err("fio: norandommap given for variable block sizes, "
726 ret |= warnings_fatal;
728 if (o->bs_unaligned && (o->odirect || td_ioengine_flagged(td, FIO_RAWIO)))
729 log_err("fio: bs_unaligned may not work with raw io\n");
732 * thinktime_spin must be less than thinktime
734 if (o->thinktime_spin > o->thinktime)
735 o->thinktime_spin = o->thinktime;
738 * The low water mark cannot be bigger than the iodepth
740 if (o->iodepth_low > o->iodepth || !o->iodepth_low)
741 o->iodepth_low = o->iodepth;
744 * If batch number isn't set, default to the same as iodepth
746 if (o->iodepth_batch > o->iodepth || !o->iodepth_batch)
747 o->iodepth_batch = o->iodepth;
750 * If max batch complete number isn't set or set incorrectly,
751 * default to the same as iodepth_batch_complete_min
753 if (o->iodepth_batch_complete_min > o->iodepth_batch_complete_max)
754 o->iodepth_batch_complete_max = o->iodepth_batch_complete_min;
757 * There's no need to check for in-flight overlapping IOs if the job
758 * isn't changing data or the maximum iodepth is guaranteed to be 1
759 * when we are not in offload mode
761 if (o->serialize_overlap && !(td->flags & TD_F_READ_IOLOG) &&
762 (!(td_write(td) || td_trim(td)) || o->iodepth == 1) &&
763 o->io_submit_mode != IO_MODE_OFFLOAD)
764 o->serialize_overlap = 0;
766 if (o->nr_files > td->files_index)
767 o->nr_files = td->files_index;
769 if (o->open_files > o->nr_files || !o->open_files)
770 o->open_files = o->nr_files;
772 if (((o->rate[DDIR_READ] + o->rate[DDIR_WRITE] + o->rate[DDIR_TRIM]) &&
773 (o->rate_iops[DDIR_READ] + o->rate_iops[DDIR_WRITE] + o->rate_iops[DDIR_TRIM])) ||
774 ((o->ratemin[DDIR_READ] + o->ratemin[DDIR_WRITE] + o->ratemin[DDIR_TRIM]) &&
775 (o->rate_iops_min[DDIR_READ] + o->rate_iops_min[DDIR_WRITE] + o->rate_iops_min[DDIR_TRIM]))) {
776 log_err("fio: rate and rate_iops are mutually exclusive\n");
779 for_each_rw_ddir(ddir) {
780 if ((o->rate[ddir] && (o->rate[ddir] < o->ratemin[ddir])) ||
781 (o->rate_iops[ddir] && (o->rate_iops[ddir] < o->rate_iops_min[ddir]))) {
782 log_err("fio: minimum rate exceeds rate, ddir %d\n", +ddir);
787 if (!o->timeout && o->time_based) {
788 log_err("fio: time_based requires a runtime/timeout setting\n");
790 ret |= warnings_fatal;
793 if (o->fill_device && !o->size)
796 if (o->verify != VERIFY_NONE) {
797 if (td_write(td) && o->do_verify && o->numjobs > 1 &&
799 !(o->unique_filename &&
800 strstr(o->filename_format, "$jobname") &&
801 strstr(o->filename_format, "$jobnum") &&
802 strstr(o->filename_format, "$filenum")))) {
803 log_info("fio: multiple writers may overwrite blocks "
804 "that belong to other jobs. This can cause "
805 "verification failures.\n");
806 ret |= warnings_fatal;
810 * Warn if verification is requested but no verification of any
811 * kind can be started due to time constraints
813 if (td_write(td) && o->do_verify && o->timeout &&
814 o->time_based && !td_read(td) && !o->verify_backlog) {
815 log_info("fio: verification read phase will never "
816 "start because write phase uses all of "
818 ret |= warnings_fatal;
821 if (!fio_option_is_set(o, refill_buffers))
822 o->refill_buffers = 1;
824 if (o->max_bs[DDIR_WRITE] != o->min_bs[DDIR_WRITE] &&
826 o->verify_interval = o->min_bs[DDIR_WRITE];
829 * Verify interval must be smaller or equal to the
832 if (o->verify_interval > o->min_bs[DDIR_WRITE])
833 o->verify_interval = o->min_bs[DDIR_WRITE];
834 else if (td_read(td) && o->verify_interval > o->min_bs[DDIR_READ])
835 o->verify_interval = o->min_bs[DDIR_READ];
838 * Verify interval must be a factor of both min and max
841 if (!o->verify_interval ||
842 (o->min_bs[DDIR_WRITE] % o->verify_interval) ||
843 (o->max_bs[DDIR_WRITE] % o->verify_interval))
844 o->verify_interval = gcd(o->min_bs[DDIR_WRITE],
845 o->max_bs[DDIR_WRITE]);
849 if (o->invalidate_cache)
850 o->invalidate_cache = 0;
851 if (td_ioengine_flagged(td, FIO_PIPEIO)) {
852 log_info("fio: cannot pre-read files with an IO engine"
853 " that isn't seekable. Pre-read disabled.\n");
854 ret |= warnings_fatal;
858 if (o->unit_base == N2S_NONE) {
859 if (td_ioengine_flagged(td, FIO_BIT_BASED))
860 o->unit_base = N2S_BITPERSEC;
862 o->unit_base = N2S_BYTEPERSEC;
865 #ifndef CONFIG_FDATASYNC
866 if (o->fdatasync_blocks) {
867 log_info("fio: this platform does not support fdatasync()"
868 " falling back to using fsync(). Use the 'fsync'"
869 " option instead of 'fdatasync' to get rid of"
871 o->fsync_blocks = o->fdatasync_blocks;
872 o->fdatasync_blocks = 0;
873 ret |= warnings_fatal;
879 * Windows doesn't support O_DIRECT or O_SYNC with the _open interface,
880 * so fail if we're passed those flags
882 if (td_ioengine_flagged(td, FIO_SYNCIO) && (o->odirect || o->sync_io)) {
883 log_err("fio: Windows does not support direct or non-buffered io with"
884 " the synchronous ioengines. Use the 'windowsaio' ioengine"
885 " with 'direct=1' and 'iodepth=1' instead.\n");
891 * For fully compressible data, just zero them at init time.
892 * It's faster than repeatedly filling it. For non-zero
893 * compression, we should have refill_buffers set. Set it, unless
894 * the job file already changed it.
896 if (o->compress_percentage) {
897 if (o->compress_percentage == 100) {
899 o->compress_percentage = 0;
900 } else if (!fio_option_is_set(o, refill_buffers)) {
901 o->refill_buffers = 1;
902 td->flags |= TD_F_REFILL_BUFFERS;
907 * Using a non-uniform random distribution excludes usage of
910 if (o->random_distribution != FIO_RAND_DIST_RANDOM)
914 * If size is set but less than the min block size, complain
916 if (o->size && o->size < td_min_bs(td)) {
917 log_err("fio: size too small, must not be less than minimum block size: %llu < %llu\n",
918 (unsigned long long) o->size, td_min_bs(td));
923 * O_ATOMIC implies O_DIRECT
929 * If randseed is set, that overrides randrepeat
931 if (fio_option_is_set(o, rand_seed))
932 o->rand_repeatable = 0;
934 if (td_ioengine_flagged(td, FIO_NOEXTEND) && o->file_append) {
935 log_err("fio: can't append/extent with IO engine %s\n", td->io_ops->name);
939 if (fio_option_is_set(o, gtod_cpu)) {
941 fio_gtod_set_cpu(o->gtod_cpu);
942 fio_gtod_offload = 1;
945 td->loops = o->loops;
949 if (o->block_error_hist && o->nr_files != 1) {
950 log_err("fio: block error histogram only available "
951 "with a single file per job, but %d files "
952 "provided\n", o->nr_files);
957 o->lat_percentiles = 0;
959 o->clat_percentiles = 0;
961 o->slat_percentiles = 0;
964 * Fix these up to be nsec internally
966 o->max_latency *= 1000ULL;
967 o->latency_target *= 1000ULL;
972 static void init_rand_file_service(struct thread_data *td)
974 unsigned long nranges = td->o.nr_files << FIO_FSERVICE_SHIFT;
975 const unsigned int seed = td->rand_seeds[FIO_RAND_FILE_OFF];
977 if (td->o.file_service_type == FIO_FSERVICE_ZIPF) {
978 zipf_init(&td->next_file_zipf, nranges, td->zipf_theta, seed);
979 zipf_disable_hash(&td->next_file_zipf);
980 } else if (td->o.file_service_type == FIO_FSERVICE_PARETO) {
981 pareto_init(&td->next_file_zipf, nranges, td->pareto_h, seed);
982 zipf_disable_hash(&td->next_file_zipf);
983 } else if (td->o.file_service_type == FIO_FSERVICE_GAUSS) {
984 gauss_init(&td->next_file_gauss, nranges, td->gauss_dev, seed);
985 gauss_disable_hash(&td->next_file_gauss);
989 void td_fill_verify_state_seed(struct thread_data *td)
993 if (td->o.random_generator == FIO_RAND_GEN_TAUSWORTHE64)
998 init_rand_seed(&td->verify_state, td->rand_seeds[FIO_RAND_VER_OFF],
1002 static void td_fill_rand_seeds_internal(struct thread_data *td, bool use64)
1004 uint64_t read_seed = td->rand_seeds[FIO_RAND_BS_OFF];
1005 uint64_t write_seed = td->rand_seeds[FIO_RAND_BS1_OFF];
1006 uint64_t trim_seed = td->rand_seeds[FIO_RAND_BS2_OFF];
1010 * trimwrite is special in that we need to generate the same
1011 * offsets to get the "write after trim" effect. If we are
1012 * using bssplit to set buffer length distributions, ensure that
1013 * we seed the trim and write generators identically. Ditto for
1014 * verify, read and writes must have the same seed, if we are doing
1017 if (td->o.verify != VERIFY_NONE)
1018 write_seed = read_seed;
1019 if (td_trimwrite(td))
1020 trim_seed = write_seed;
1021 init_rand_seed(&td->bsrange_state[DDIR_READ], read_seed, use64);
1022 init_rand_seed(&td->bsrange_state[DDIR_WRITE], write_seed, use64);
1023 init_rand_seed(&td->bsrange_state[DDIR_TRIM], trim_seed, use64);
1025 td_fill_verify_state_seed(td);
1026 init_rand_seed(&td->rwmix_state, td->rand_seeds[FIO_RAND_MIX_OFF], false);
1028 if (td->o.file_service_type == FIO_FSERVICE_RANDOM)
1029 init_rand_seed(&td->next_file_state, td->rand_seeds[FIO_RAND_FILE_OFF], use64);
1030 else if (td->o.file_service_type & __FIO_FSERVICE_NONUNIFORM)
1031 init_rand_file_service(td);
1033 init_rand_seed(&td->file_size_state, td->rand_seeds[FIO_RAND_FILE_SIZE_OFF], use64);
1034 init_rand_seed(&td->trim_state, td->rand_seeds[FIO_RAND_TRIM_OFF], use64);
1035 init_rand_seed(&td->delay_state, td->rand_seeds[FIO_RAND_START_DELAY], use64);
1036 init_rand_seed(&td->poisson_state[0], td->rand_seeds[FIO_RAND_POISSON_OFF], 0);
1037 init_rand_seed(&td->poisson_state[1], td->rand_seeds[FIO_RAND_POISSON2_OFF], 0);
1038 init_rand_seed(&td->poisson_state[2], td->rand_seeds[FIO_RAND_POISSON3_OFF], 0);
1039 init_rand_seed(&td->dedupe_state, td->rand_seeds[FIO_DEDUPE_OFF], false);
1040 init_rand_seed(&td->zone_state, td->rand_seeds[FIO_RAND_ZONE_OFF], false);
1041 init_rand_seed(&td->prio_state, td->rand_seeds[FIO_RAND_PRIO_CMDS], false);
1046 if (td->o.rand_repeatable)
1047 td->rand_seeds[FIO_RAND_BLOCK_OFF] = FIO_RANDSEED * td->thread_number;
1049 init_rand_seed(&td->random_state, td->rand_seeds[FIO_RAND_BLOCK_OFF], use64);
1051 for (i = 0; i < DDIR_RWDIR_CNT; i++) {
1052 struct frand_state *s = &td->seq_rand_state[i];
1054 init_rand_seed(s, td->rand_seeds[FIO_RAND_SEQ_RAND_READ_OFF], false);
1058 void td_fill_rand_seeds(struct thread_data *td)
1062 if (td->o.allrand_repeatable) {
1065 for (i = 0; i < FIO_RAND_NR_OFFS; i++)
1066 td->rand_seeds[i] = FIO_RANDSEED * td->thread_number
1070 if (td->o.random_generator == FIO_RAND_GEN_TAUSWORTHE64)
1075 td_fill_rand_seeds_internal(td, use64);
1077 init_rand_seed(&td->buf_state, td->rand_seeds[FIO_RAND_BUF_OFF], use64);
1078 frand_copy(&td->buf_state_prev, &td->buf_state);
1082 * Initializes the ioengine configured for a job, if it has not been done so
1085 int ioengine_load(struct thread_data *td)
1087 if (!td->o.ioengine) {
1088 log_err("fio: internal fault, no IO engine specified\n");
1093 struct ioengine_ops *ops;
1096 /* An engine is loaded, but the requested ioengine
1099 if (!strcmp(td->io_ops->name, td->o.ioengine)) {
1100 /* The right engine is already loaded */
1105 * Name of file and engine may be different, load ops
1106 * for this name and see if they match. If they do, then
1107 * the engine is unchanged.
1109 dlhandle = td->io_ops_dlhandle;
1110 ops = load_ioengine(td);
1114 if (ops == td->io_ops && dlhandle == td->io_ops_dlhandle) {
1120 if (dlhandle && dlhandle != td->io_ops_dlhandle)
1123 /* Unload the old engine. */
1127 td->io_ops = load_ioengine(td);
1131 if (td->io_ops->option_struct_size && td->io_ops->options) {
1133 * In cases where td->eo is set, clone it for a child thread.
1134 * This requires that the parent thread has the same ioengine,
1135 * but that requirement must be enforced by the code which
1136 * cloned the thread.
1138 void *origeo = td->eo;
1140 * Otherwise use the default thread options.
1142 if (!origeo && td != &def_thread && def_thread.eo &&
1143 def_thread.io_ops->options == td->io_ops->options)
1144 origeo = def_thread.eo;
1146 options_init(td->io_ops->options);
1147 td->eo = malloc(td->io_ops->option_struct_size);
1149 * Use the default thread as an option template if this uses the
1150 * same options structure and there are non-default options
1154 memcpy(td->eo, origeo, td->io_ops->option_struct_size);
1155 options_mem_dupe(td->io_ops->options, td->eo);
1157 memset(td->eo, 0, td->io_ops->option_struct_size);
1158 fill_default_options(td->eo, td->io_ops->options);
1160 *(struct thread_data **)td->eo = td;
1164 td->io_ops->flags |= FIO_RAWIO;
1166 td_set_ioengine_flags(td);
1170 log_err("fio: failed to load engine\n");
1175 static void init_flags(struct thread_data *td)
1177 struct thread_options *o = &td->o;
1180 if (o->verify_backlog)
1181 td->flags |= TD_F_VER_BACKLOG;
1182 if (o->trim_backlog)
1183 td->flags |= TD_F_TRIM_BACKLOG;
1184 if (o->read_iolog_file)
1185 td->flags |= TD_F_READ_IOLOG;
1186 if (o->refill_buffers)
1187 td->flags |= TD_F_REFILL_BUFFERS;
1189 * Always scramble buffers if asked to
1191 if (o->scramble_buffers && fio_option_is_set(o, scramble_buffers))
1192 td->flags |= TD_F_SCRAMBLE_BUFFERS;
1194 * But also scramble buffers, unless we were explicitly asked
1197 if (o->scramble_buffers && !(o->zero_buffers &&
1198 fio_option_is_set(o, zero_buffers)))
1199 td->flags |= TD_F_SCRAMBLE_BUFFERS;
1200 if (o->verify != VERIFY_NONE)
1201 td->flags |= TD_F_DO_VERIFY;
1203 if (o->verify_async || o->io_submit_mode == IO_MODE_OFFLOAD)
1204 td->flags |= TD_F_NEED_LOCK;
1206 if (o->mem_type == MEM_CUDA_MALLOC)
1207 td->flags &= ~TD_F_SCRAMBLE_BUFFERS;
1209 for (i = 0; i < DDIR_RWDIR_CNT; i++) {
1210 if (option_check_rate(td, i)) {
1211 td->flags |= TD_F_CHECK_RATE;
1217 static int setup_random_seeds(struct thread_data *td)
1222 if (!td->o.rand_repeatable && !fio_option_is_set(&td->o, rand_seed)) {
1223 int ret = init_random_seeds(td->rand_seeds, sizeof(td->rand_seeds));
1225 td_fill_rand_seeds(td);
1229 seed = td->o.rand_seed;
1230 for (i = 0; i < 4; i++)
1231 seed *= 0x9e370001UL;
1233 for (i = 0; i < FIO_RAND_NR_OFFS; i++) {
1234 td->rand_seeds[i] = seed * td->thread_number + i;
1235 seed *= 0x9e370001UL;
1238 td_fill_rand_seeds(td);
1249 static struct fpre_keyword {
1250 const char *keyword;
1253 } fpre_keywords[] = {
1254 { .keyword = "$jobname", .key = FPRE_JOBNAME, },
1255 { .keyword = "$jobnum", .key = FPRE_JOBNUM, },
1256 { .keyword = "$filenum", .key = FPRE_FILENUM, },
1257 { .keyword = NULL, },
1260 static char *make_filename(char *buf, size_t buf_size,struct thread_options *o,
1261 const char *jobname, int jobnum, int filenum)
1263 struct fpre_keyword *f;
1264 char copy[PATH_MAX];
1265 size_t dst_left = PATH_MAX - 1;
1267 if (!o->filename_format || !strlen(o->filename_format)) {
1268 sprintf(buf, "%s.%d.%d", jobname, jobnum, filenum);
1272 for (f = &fpre_keywords[0]; f->keyword; f++)
1273 f->strlen = strlen(f->keyword);
1275 snprintf(buf, buf_size, "%s", o->filename_format);
1277 memset(copy, 0, sizeof(copy));
1278 for (f = &fpre_keywords[0]; f->keyword; f++) {
1280 size_t pre_len, post_start = 0;
1281 char *str, *dst = copy;
1283 str = strcasestr(buf, f->keyword);
1287 pre_len = str - buf;
1288 if (strlen(str) != f->strlen)
1289 post_start = pre_len + f->strlen;
1292 strncpy(dst, buf, pre_len);
1294 dst_left -= pre_len;
1298 case FPRE_JOBNAME: {
1301 ret = snprintf(dst, dst_left, "%s", jobname);
1304 else if (ret > dst_left) {
1305 log_err("fio: truncated filename\n");
1317 ret = snprintf(dst, dst_left, "%d", jobnum);
1320 else if (ret > dst_left) {
1321 log_err("fio: truncated filename\n");
1330 case FPRE_FILENUM: {
1333 ret = snprintf(dst, dst_left, "%d", filenum);
1336 else if (ret > dst_left) {
1337 log_err("fio: truncated filename\n");
1352 strncpy(dst, buf + post_start, dst_left);
1354 snprintf(buf, buf_size, "%s", copy);
1361 bool parse_dryrun(void)
1363 return dump_cmdline || parse_only;
1366 static void gen_log_name(char *name, size_t size, const char *logtype,
1367 const char *logname, unsigned int num,
1368 const char *suf, int per_job)
1371 snprintf(name, size, "%s_%s.%d.%s", logname, logtype, num, suf);
1373 snprintf(name, size, "%s_%s.%s", logname, logtype, suf);
1376 static int check_waitees(char *waitee)
1378 struct thread_data *td;
1381 for_each_td(td, i) {
1382 if (td->subjob_number)
1385 ret += !strcmp(td->o.name, waitee);
1391 static bool wait_for_ok(const char *jobname, struct thread_options *o)
1398 if (!strcmp(jobname, o->wait_for)) {
1399 log_err("%s: a job cannot wait for itself (wait_for=%s).\n",
1400 jobname, o->wait_for);
1404 if (!(nw = check_waitees(o->wait_for))) {
1405 log_err("%s: waitee job %s unknown.\n", jobname, o->wait_for);
1410 log_err("%s: multiple waitees %s found,\n"
1411 "please avoid duplicates when using wait_for option.\n",
1412 jobname, o->wait_for);
1420 * Treat an empty log file name the same as a one not given
1422 static const char *make_log_name(const char *logname, const char *jobname)
1424 if (logname && strcmp(logname, ""))
1431 * Adds a job to the list of things todo. Sanitizes the various options
1432 * to make sure we don't have conflicts, and initializes various
1435 static int add_job(struct thread_data *td, const char *jobname, int job_add_num,
1436 int recursed, int client_type)
1439 char fname[PATH_MAX + 1];
1440 int numjobs, file_alloced;
1441 struct thread_options *o = &td->o;
1442 char logname[PATH_MAX + 32];
1445 * the def_thread is just for options, it's not a real job
1447 if (td == &def_thread)
1453 * if we are just dumping the output command line, don't add the job
1455 if (parse_dryrun()) {
1460 td->client_type = client_type;
1462 if (profile_td_init(td))
1465 if (ioengine_load(td))
1469 if (!o->filename && !td->files_index && !o->read_iolog_file) {
1472 if (o->nr_files == 1 && exists_and_not_regfile(jobname))
1473 add_file(td, jobname, job_add_num, 0);
1475 for (i = 0; i < o->nr_files; i++)
1476 add_file(td, make_filename(fname, sizeof(fname), o, jobname, job_add_num, i), job_add_num, 0);
1480 if (setup_random_seeds(td)) {
1481 td_verror(td, errno, "setup_random_seeds");
1485 if (fixup_options(td))
1489 * Belongs to fixup_options, but o->name is not necessarily set as yet
1491 if (!wait_for_ok(jobname, o))
1497 * IO engines only need this for option callbacks, and the address may
1498 * change in subprocesses.
1501 *(struct thread_data **)td->eo = NULL;
1503 if (td_ioengine_flagged(td, FIO_DISKLESSIO)) {
1506 for_each_file(td, f, i)
1507 f->real_file_size = -1ULL;
1510 td->sem = fio_sem_init(FIO_SEM_LOCKED);
1512 td->ts.clat_percentiles = o->clat_percentiles;
1513 td->ts.lat_percentiles = o->lat_percentiles;
1514 td->ts.slat_percentiles = o->slat_percentiles;
1515 td->ts.percentile_precision = o->percentile_precision;
1516 memcpy(td->ts.percentile_list, o->percentile_list, sizeof(o->percentile_list));
1517 td->ts.sig_figs = o->sig_figs;
1519 for (i = 0; i < DDIR_RWDIR_CNT; i++) {
1520 td->ts.clat_stat[i].min_val = ULONG_MAX;
1521 td->ts.slat_stat[i].min_val = ULONG_MAX;
1522 td->ts.lat_stat[i].min_val = ULONG_MAX;
1523 td->ts.bw_stat[i].min_val = ULONG_MAX;
1524 td->ts.iops_stat[i].min_val = ULONG_MAX;
1525 td->ts.clat_high_prio_stat[i].min_val = ULONG_MAX;
1526 td->ts.clat_low_prio_stat[i].min_val = ULONG_MAX;
1528 td->ts.sync_stat.min_val = ULONG_MAX;
1529 td->ddir_seq_nr = o->ddir_seq_nr;
1531 if ((o->stonewall || o->new_group) && prev_group_jobs) {
1532 prev_group_jobs = 0;
1534 if (groupid == INT_MAX) {
1535 log_err("fio: too many groups defined\n");
1540 td->groupid = groupid;
1546 if (o->write_lat_log) {
1547 struct log_params p = {
1549 .avg_msec = o->log_avg_msec,
1550 .hist_msec = o->log_hist_msec,
1551 .hist_coarseness = o->log_hist_coarseness,
1552 .log_type = IO_LOG_TYPE_LAT,
1553 .log_offset = o->log_offset,
1554 .log_gz = o->log_gz,
1555 .log_gz_store = o->log_gz_store,
1557 const char *pre = make_log_name(o->lat_log_file, o->name);
1565 gen_log_name(logname, sizeof(logname), "lat", pre,
1566 td->thread_number, suf, o->per_job_logs);
1567 setup_log(&td->lat_log, &p, logname);
1569 gen_log_name(logname, sizeof(logname), "slat", pre,
1570 td->thread_number, suf, o->per_job_logs);
1571 setup_log(&td->slat_log, &p, logname);
1573 gen_log_name(logname, sizeof(logname), "clat", pre,
1574 td->thread_number, suf, o->per_job_logs);
1575 setup_log(&td->clat_log, &p, logname);
1579 if (o->write_hist_log) {
1580 struct log_params p = {
1582 .avg_msec = o->log_avg_msec,
1583 .hist_msec = o->log_hist_msec,
1584 .hist_coarseness = o->log_hist_coarseness,
1585 .log_type = IO_LOG_TYPE_HIST,
1586 .log_offset = o->log_offset,
1587 .log_gz = o->log_gz,
1588 .log_gz_store = o->log_gz_store,
1590 const char *pre = make_log_name(o->hist_log_file, o->name);
1594 if (td->client_type) {
1595 log_err("fio: --write_hist_log requires zlib in client/server mode\n");
1605 gen_log_name(logname, sizeof(logname), "clat_hist", pre,
1606 td->thread_number, suf, o->per_job_logs);
1607 setup_log(&td->clat_hist_log, &p, logname);
1610 if (o->write_bw_log) {
1611 struct log_params p = {
1613 .avg_msec = o->log_avg_msec,
1614 .hist_msec = o->log_hist_msec,
1615 .hist_coarseness = o->log_hist_coarseness,
1616 .log_type = IO_LOG_TYPE_BW,
1617 .log_offset = o->log_offset,
1618 .log_gz = o->log_gz,
1619 .log_gz_store = o->log_gz_store,
1621 const char *pre = make_log_name(o->bw_log_file, o->name);
1624 if (fio_option_is_set(o, bw_avg_time))
1625 p.avg_msec = min(o->log_avg_msec, o->bw_avg_time);
1627 o->bw_avg_time = p.avg_msec;
1629 p.hist_msec = o->log_hist_msec;
1630 p.hist_coarseness = o->log_hist_coarseness;
1637 gen_log_name(logname, sizeof(logname), "bw", pre,
1638 td->thread_number, suf, o->per_job_logs);
1639 setup_log(&td->bw_log, &p, logname);
1641 if (o->write_iops_log) {
1642 struct log_params p = {
1644 .avg_msec = o->log_avg_msec,
1645 .hist_msec = o->log_hist_msec,
1646 .hist_coarseness = o->log_hist_coarseness,
1647 .log_type = IO_LOG_TYPE_IOPS,
1648 .log_offset = o->log_offset,
1649 .log_gz = o->log_gz,
1650 .log_gz_store = o->log_gz_store,
1652 const char *pre = make_log_name(o->iops_log_file, o->name);
1655 if (fio_option_is_set(o, iops_avg_time))
1656 p.avg_msec = min(o->log_avg_msec, o->iops_avg_time);
1658 o->iops_avg_time = p.avg_msec;
1660 p.hist_msec = o->log_hist_msec;
1661 p.hist_coarseness = o->log_hist_coarseness;
1668 gen_log_name(logname, sizeof(logname), "iops", pre,
1669 td->thread_number, suf, o->per_job_logs);
1670 setup_log(&td->iops_log, &p, logname);
1674 o->name = strdup(jobname);
1676 if (output_format & FIO_OUTPUT_NORMAL) {
1678 if (is_backend && !recursed)
1679 fio_server_send_add_job(td);
1681 if (!td_ioengine_flagged(td, FIO_NOIO)) {
1682 char *c1, *c2, *c3, *c4;
1683 char *c5 = NULL, *c6 = NULL;
1684 int i2p = is_power_of_2(o->kb_base);
1685 struct buf_output out;
1687 c1 = num2str(o->min_bs[DDIR_READ], o->sig_figs, 1, i2p, N2S_BYTE);
1688 c2 = num2str(o->max_bs[DDIR_READ], o->sig_figs, 1, i2p, N2S_BYTE);
1689 c3 = num2str(o->min_bs[DDIR_WRITE], o->sig_figs, 1, i2p, N2S_BYTE);
1690 c4 = num2str(o->max_bs[DDIR_WRITE], o->sig_figs, 1, i2p, N2S_BYTE);
1692 if (!o->bs_is_seq_rand) {
1693 c5 = num2str(o->min_bs[DDIR_TRIM], o->sig_figs, 1, i2p, N2S_BYTE);
1694 c6 = num2str(o->max_bs[DDIR_TRIM], o->sig_figs, 1, i2p, N2S_BYTE);
1697 buf_output_init(&out);
1698 __log_buf(&out, "%s: (g=%d): rw=%s, ", td->o.name,
1700 ddir_str(o->td_ddir));
1702 if (o->bs_is_seq_rand)
1703 __log_buf(&out, "bs=(R) %s-%s, (W) %s-%s, bs_is_seq_rand, ",
1706 __log_buf(&out, "bs=(R) %s-%s, (W) %s-%s, (T) %s-%s, ",
1707 c1, c2, c3, c4, c5, c6);
1709 __log_buf(&out, "ioengine=%s, iodepth=%u\n",
1710 td->io_ops->name, o->iodepth);
1711 log_info_buf(out.buf, out.buflen);
1712 buf_output_free(&out);
1721 } else if (job_add_num == 1)
1725 if (td_steadystate_init(td))
1728 if (o->merge_blktrace_file && !merge_blktrace_iologs(td))
1731 if (merge_blktrace_only) {
1737 * recurse add identical jobs, clear numjobs and stonewall options
1738 * as they don't apply to sub-jobs
1740 numjobs = o->numjobs;
1742 struct thread_data *td_new = get_new_job(false, td, true, jobname);
1747 td_new->o.numjobs = 1;
1748 td_new->o.stonewall = 0;
1749 td_new->o.new_group = 0;
1750 td_new->subjob_number = numjobs;
1751 td_new->o.ss_dur = o->ss_dur * 1000000l;
1752 td_new->o.ss_limit = o->ss_limit;
1755 if (td_new->files) {
1757 for_each_file(td_new, f, i)
1759 free(td_new->files);
1760 td_new->files = NULL;
1762 td_new->files_index = 0;
1763 td_new->files_size = 0;
1764 if (td_new->o.filename) {
1765 free(td_new->o.filename);
1766 td_new->o.filename = NULL;
1770 if (add_job(td_new, jobname, numjobs, 1, client_type))
1781 * Parse as if 'o' was a command line
1783 void add_job_opts(const char **o, int client_type)
1785 struct thread_data *td, *td_parent;
1786 int i, in_global = 1;
1790 td_parent = td = NULL;
1792 if (!strncmp(o[i], "name", 4)) {
1795 add_job(td, jobname, 0, 0, client_type);
1797 sprintf(jobname, "%s", o[i] + 5);
1799 if (in_global && !td_parent)
1800 td_parent = get_new_job(true, &def_thread, false, jobname);
1801 else if (!in_global && !td) {
1803 td_parent = &def_thread;
1804 td = get_new_job(false, td_parent, false, jobname);
1807 fio_options_parse(td_parent, (char **) &o[i], 1);
1809 fio_options_parse(td, (char **) &o[i], 1);
1814 add_job(td, jobname, 0, 0, client_type);
1817 static int skip_this_section(const char *name)
1821 if (!nr_job_sections)
1823 if (!strncmp(name, "global", 6))
1826 for (i = 0; i < nr_job_sections; i++)
1827 if (!strcmp(job_sections[i], name))
1833 static int is_empty_or_comment(char *line)
1837 for (i = 0; i < strlen(line); i++) {
1842 if (!isspace((int) line[i]) && !iscntrl((int) line[i]))
1850 * This is our [ini] type file parser.
1852 static int __parse_jobs_ini(struct thread_data *td,
1853 char *file, int is_buf, int stonewall_flag, int type,
1854 int nested, char *name, char ***popts, int *aopts, int *nopts)
1856 bool global = false;
1857 bool stdin_occupied = false;
1861 int ret = 0, stonewall;
1864 int inside_skip = 0;
1866 int i, alloc_opts, num_opts;
1868 dprint(FD_PARSE, "Parsing ini file %s\n", file);
1869 assert(td || !nested);
1874 if (!strcmp(file, "-")) {
1876 stdin_occupied = true;
1878 f = fopen(file, "r");
1883 log_err("fio: unable to open '%s' job file\n", file);
1885 td_verror(td, __err, "job file open");
1890 string = malloc(OPT_LEN_MAX);
1893 * it's really 256 + small bit, 280 should suffice
1897 memset(name, 0, 280);
1901 if (nested && popts) {
1903 alloc_opts = *aopts;
1909 opts = malloc(sizeof(char *) * alloc_opts);
1913 stonewall = stonewall_flag;
1916 * if skip_fgets is set, we already have loaded a line we
1921 p = strsep(&file, "\n");
1923 p = fgets(string, OPT_LEN_MAX, f);
1929 strip_blank_front(&p);
1932 dprint(FD_PARSE, "%s\n", p);
1933 if (is_empty_or_comment(p))
1937 if (sscanf(p, "[%255[^\n]]", name) != 1) {
1941 log_err("fio: option <%s> outside of "
1942 "[] job section\n", p);
1947 name[strlen(name) - 1] = '\0';
1949 if (skip_this_section(name)) {
1955 dprint(FD_PARSE, "Parsing section [%s]\n", name);
1957 global = !strncmp(name, "global", 6);
1963 log_info("--name=%s ", name);
1967 td = get_new_job(global, &def_thread, false, name);
1974 * Separate multiple job files by a stonewall
1976 if (!global && stonewall) {
1977 td->o.stonewall = stonewall;
1982 memset(opts, 0, alloc_opts * sizeof(char *));
1990 p = strsep(&file, "\n");
1992 p = fgets(string, OPT_LEN_MAX, f);
1995 dprint(FD_PARSE, "%s", p);
2000 if (is_empty_or_comment(p))
2003 strip_blank_front(&p);
2006 * new section, break out and make sure we don't
2007 * fgets() a new line at the top.
2011 log_err("No new sections in included files\n");
2022 if (!strncmp(p, "include", strlen("include"))) {
2023 char *filename = p + strlen("include") + 1,
2024 *ts, *full_fn = NULL;
2027 * Allow for the include filename
2028 * specification to be relative.
2030 if (access(filename, F_OK) &&
2031 (ts = strrchr(file, '/'))) {
2032 if (asprintf(&full_fn, "%.*s%s",
2033 (int)(ts - file + 1), file,
2041 ret = __parse_jobs_ini(td, filename, is_buf,
2042 stonewall_flag, type, 1,
2044 &alloc_opts, &num_opts);
2047 log_err("Error %d while parsing "
2048 "include file %s\n",
2061 if (num_opts == alloc_opts) {
2063 opts = realloc(opts,
2064 alloc_opts * sizeof(char *));
2067 opts[num_opts] = strdup(p);
2073 *aopts = alloc_opts;
2078 ret = fio_options_parse(td, opts, num_opts);
2080 if (!ret && td->o.read_iolog_file != NULL) {
2081 char *fname = get_name_by_idx(td->o.read_iolog_file,
2083 if (!strcmp(fname, "-")) {
2084 if (stdin_occupied) {
2085 log_err("fio: only one user (read_iolog_file/job "
2086 "file) of stdin is permitted at once but "
2087 "more than one was found.\n");
2090 stdin_occupied = true;
2097 ret = add_job(td, name, 0, 0, type);
2099 log_err("fio: job %s dropped\n", name);
2103 for (i = 0; i < num_opts; i++)
2112 while (i < nr_job_sections) {
2113 free(job_sections[i]);
2122 if (!is_buf && f != stdin)
2127 int parse_jobs_ini(char *file, int is_buf, int stonewall_flag, int type)
2129 return __parse_jobs_ini(NULL, file, is_buf, stonewall_flag, type,
2130 0, NULL, NULL, NULL, NULL);
2133 static int fill_def_thread(void)
2135 memset(&def_thread, 0, sizeof(def_thread));
2136 INIT_FLIST_HEAD(&def_thread.opt_list);
2138 fio_getaffinity(getpid(), &def_thread.o.cpumask);
2139 def_thread.o.error_dump = 1;
2142 * fill default options
2144 fio_fill_default_options(&def_thread);
2148 static void show_debug_categories(void)
2150 #ifdef FIO_INC_DEBUG
2151 const struct debug_level *dl = &debug_levels[0];
2152 int curlen, first = 1;
2156 int has_next = (dl + 1)->name != NULL;
2158 if (first || curlen + strlen(dl->name) >= 80) {
2163 curlen += printf("\t\t\t%s", dl->name);
2164 curlen += 3 * (8 - 1);
2166 curlen += printf(",");
2168 curlen += printf("%s", dl->name);
2170 curlen += printf(",");
2180 * Following options aren't printed by usage().
2181 * --append-terse - Equivalent to --output-format=terse, see f6a7df53.
2182 * --latency-log - Deprecated option.
2184 static void usage(const char *name)
2186 printf("%s\n", fio_version_string);
2187 printf("%s [options] [job options] <job file(s)>\n", name);
2188 printf(" --debug=options\tEnable debug logging. May be one/more of:\n");
2189 show_debug_categories();
2190 printf(" --parse-only\t\tParse options only, don't start any IO\n");
2191 printf(" --merge-blktrace-only\tMerge blktraces only, don't start any IO\n");
2192 printf(" --output\t\tWrite output to file\n");
2193 printf(" --bandwidth-log\tGenerate aggregate bandwidth logs\n");
2194 printf(" --minimal\t\tMinimal (terse) output\n");
2195 printf(" --output-format=type\tOutput format (terse,json,json+,normal)\n");
2196 printf(" --terse-version=type\tSet terse version output format"
2197 " (default 3, or 2 or 4)\n");
2198 printf(" --version\t\tPrint version info and exit\n");
2199 printf(" --help\t\tPrint this page\n");
2200 printf(" --cpuclock-test\tPerform test/validation of CPU clock\n");
2201 printf(" --crctest=[type]\tTest speed of checksum functions\n");
2202 printf(" --cmdhelp=cmd\t\tPrint command help, \"all\" for all of"
2204 printf(" --enghelp=engine\tPrint ioengine help, or list"
2205 " available ioengines\n");
2206 printf(" --enghelp=engine,cmd\tPrint help for an ioengine"
2208 printf(" --showcmd\t\tTurn a job file into command line options\n");
2209 printf(" --eta=when\t\tWhen ETA estimate should be printed\n");
2210 printf(" \t\tMay be \"always\", \"never\" or \"auto\"\n");
2211 printf(" --eta-newline=t\tForce a new line for every 't'");
2212 printf(" period passed\n");
2213 printf(" --status-interval=t\tForce full status dump every");
2214 printf(" 't' period passed\n");
2215 printf(" --readonly\t\tTurn on safety read-only checks, preventing"
2217 printf(" --section=name\tOnly run specified section in job file,"
2218 " multiple sections can be specified\n");
2219 printf(" --alloc-size=kb\tSet smalloc pool to this size in kb"
2221 printf(" --warnings-fatal\tFio parser warnings are fatal\n");
2222 printf(" --max-jobs=nr\t\tMaximum number of threads/processes to support\n");
2223 printf(" --server=args\t\tStart a backend fio server\n");
2224 printf(" --daemonize=pidfile\tBackground fio server, write pid to file\n");
2225 printf(" --client=hostname\tTalk to remote backend(s) fio server at hostname\n");
2226 printf(" --remote-config=file\tTell fio server to load this local job file\n");
2227 printf(" --idle-prof=option\tReport cpu idleness on a system or percpu basis\n"
2228 "\t\t\t(option=system,percpu) or run unit work\n"
2229 "\t\t\tcalibration only (option=calibrate)\n");
2231 printf(" --inflate-log=log\tInflate and output compressed log\n");
2233 printf(" --trigger-file=file\tExecute trigger cmd when file exists\n");
2234 printf(" --trigger-timeout=t\tExecute trigger at this time\n");
2235 printf(" --trigger=cmd\t\tSet this command as local trigger\n");
2236 printf(" --trigger-remote=cmd\tSet this command as remote trigger\n");
2237 printf(" --aux-path=path\tUse this path for fio state generated files\n");
2238 printf("\nFio was written by Jens Axboe <axboe@kernel.dk>\n");
2241 #ifdef FIO_INC_DEBUG
2242 const struct debug_level debug_levels[] = {
2243 { .name = "process",
2244 .help = "Process creation/exit logging",
2245 .shift = FD_PROCESS,
2248 .help = "File related action logging",
2252 .help = "IO and IO engine action logging (offsets, queue, completions, etc)",
2256 .help = "Memory allocation/freeing logging",
2259 { .name = "blktrace",
2260 .help = "blktrace action logging",
2261 .shift = FD_BLKTRACE,
2264 .help = "IO verification action logging",
2268 .help = "Random generation logging",
2272 .help = "Parser logging",
2275 { .name = "diskutil",
2276 .help = "Disk utility logging actions",
2277 .shift = FD_DISKUTIL,
2280 .help = "Logging related to creating/destroying jobs",
2284 .help = "Mutex logging",
2287 { .name = "profile",
2288 .help = "Logging related to profiles",
2289 .shift = FD_PROFILE,
2292 .help = "Logging related to time keeping functions",
2296 .help = "Network logging",
2300 .help = "Rate logging",
2303 { .name = "compress",
2304 .help = "Log compression logging",
2305 .shift = FD_COMPRESS,
2307 { .name = "steadystate",
2308 .help = "Steady state detection logging",
2309 .shift = FD_STEADYSTATE,
2311 { .name = "helperthread",
2312 .help = "Helper thread logging",
2313 .shift = FD_HELPERTHREAD,
2316 .help = "Zoned Block Device logging",
2322 static int set_debug(const char *string)
2324 const struct debug_level *dl;
2325 char *p = (char *) string;
2332 if (!strcmp(string, "?") || !strcmp(string, "help")) {
2333 log_info("fio: dumping debug options:");
2334 for (i = 0; debug_levels[i].name; i++) {
2335 dl = &debug_levels[i];
2336 log_info("%s,", dl->name);
2342 while ((opt = strsep(&p, ",")) != NULL) {
2345 if (!strncmp(opt, "all", 3)) {
2346 log_info("fio: set all debug options\n");
2351 for (i = 0; debug_levels[i].name; i++) {
2352 dl = &debug_levels[i];
2353 found = !strncmp(opt, dl->name, strlen(dl->name));
2357 if (dl->shift == FD_JOB) {
2358 opt = strchr(opt, ':');
2360 log_err("fio: missing job number\n");
2364 fio_debug_jobno = atoi(opt);
2365 log_info("fio: set debug jobno %d\n",
2368 log_info("fio: set debug option %s\n", opt);
2369 fio_debug |= (1UL << dl->shift);
2375 log_err("fio: debug mask %s not found\n", opt);
2380 static int set_debug(const char *string)
2382 log_err("fio: debug tracing not included in build\n");
2387 static void fio_options_fill_optstring(void)
2389 char *ostr = cmd_optstr;
2393 while (l_opts[i].name) {
2394 ostr[c++] = l_opts[i].val;
2395 if (l_opts[i].has_arg == required_argument)
2397 else if (l_opts[i].has_arg == optional_argument) {
2406 static int client_flag_set(char c)
2411 while (l_opts[i].name) {
2412 int val = l_opts[i].val;
2414 if (c == (val & 0xff))
2415 return (val & FIO_CLIENT_FLAG);
2423 static void parse_cmd_client(void *client, char *opt)
2425 fio_client_add_cmd_option(client, opt);
2428 static void show_closest_option(const char *name)
2430 int best_option, best_distance;
2433 while (*name == '-')
2437 best_distance = INT_MAX;
2439 while (l_opts[i].name) {
2440 distance = string_distance(name, l_opts[i].name);
2441 if (distance < best_distance) {
2442 best_distance = distance;
2448 if (best_option != -1 && string_distance_ok(name, best_distance))
2449 log_err("Did you mean %s?\n", l_opts[best_option].name);
2452 static int parse_output_format(const char *optarg)
2454 char *p, *orig, *opt;
2457 p = orig = strdup(optarg);
2461 while ((opt = strsep(&p, ",")) != NULL) {
2462 if (!strcmp(opt, "minimal") ||
2463 !strcmp(opt, "terse") ||
2464 !strcmp(opt, "csv"))
2465 output_format |= FIO_OUTPUT_TERSE;
2466 else if (!strcmp(opt, "json"))
2467 output_format |= FIO_OUTPUT_JSON;
2468 else if (!strcmp(opt, "json+"))
2469 output_format |= (FIO_OUTPUT_JSON | FIO_OUTPUT_JSON_PLUS);
2470 else if (!strcmp(opt, "normal"))
2471 output_format |= FIO_OUTPUT_NORMAL;
2473 log_err("fio: invalid output format %s\n", opt);
2483 int parse_cmd_line(int argc, char *argv[], int client_type)
2485 struct thread_data *td = NULL;
2486 int c, ini_idx = 0, lidx, ret = 0, do_exit = 0, exit_val = 0;
2487 char *ostr = cmd_optstr;
2488 char *pid_file = NULL;
2489 void *cur_client = NULL;
2490 bool backend = false;
2493 * Reset optind handling, since we may call this multiple times
2498 while ((c = getopt_long_only(argc, argv, ostr, l_opts, &lidx)) != -1) {
2499 if ((c & FIO_CLIENT_FLAG) || client_flag_set(c)) {
2500 parse_cmd_client(cur_client, argv[optind - 1]);
2501 c &= ~FIO_CLIENT_FLAG;
2506 smalloc_pool_size = atoi(optarg);
2507 smalloc_pool_size <<= 10;
2511 log_err("fio: --latency-log is deprecated. Use per-job latency log options.\n");
2516 write_bw_log = true;
2521 if (f_out && f_out != stdout)
2524 tmp = fopen(optarg, "w+");
2526 log_err("fio: output file open error: %s\n", strerror(errno));
2531 f_err = f_out = tmp;
2535 output_format = FIO_OUTPUT_TERSE;
2538 if (parse_output_format(optarg)) {
2539 log_err("fio: failed parsing output-format\n");
2546 output_format |= FIO_OUTPUT_TERSE;
2558 fio_show_option_help(optarg);
2565 exit_val = fio_show_ioengine_help(optarg);
2571 dump_cmdline = true;
2579 log_info("%s\n", fio_version_string);
2584 terse_version = atoi(optarg);
2585 if (!(terse_version >= 2 && terse_version <= 5)) {
2586 log_err("fio: bad terse version format\n");
2592 if (!strcmp("always", optarg))
2593 eta_print = FIO_ETA_ALWAYS;
2594 else if (!strcmp("never", optarg))
2595 eta_print = FIO_ETA_NEVER;
2600 if (check_str_time(optarg, &t, 1)) {
2601 log_err("fio: failed parsing eta time %s\n", optarg);
2606 eta_new_line = t / 1000;
2607 if (!eta_new_line) {
2608 log_err("fio: eta new line time too short\n");
2617 if (check_str_time(optarg, &t, 1)) {
2618 log_err("fio: failed parsing eta interval %s\n", optarg);
2623 eta_interval_msec = t / 1000;
2624 if (eta_interval_msec < DISK_UTIL_MSEC) {
2625 log_err("fio: eta interval time too short (%umsec min)\n", DISK_UTIL_MSEC);
2632 if (set_debug(optarg))
2642 if (!strcmp(optarg, "global")) {
2643 log_err("fio: can't use global as only "
2649 new_size = (nr_job_sections + 1) * sizeof(char *);
2650 job_sections = realloc(job_sections, new_size);
2651 job_sections[nr_job_sections] = strdup(optarg);
2657 exit_val = iolog_file_inflate(optarg);
2666 exec_profile = strdup(optarg);
2668 case FIO_GETOPT_JOB: {
2669 const char *opt = l_opts[lidx].name;
2672 if (!strncmp(opt, "name", 4) && td) {
2673 ret = add_job(td, td->o.name ?: "fio", 0, 0, client_type);
2680 int is_section = !strncmp(opt, "name", 4);
2683 if (!is_section || !strncmp(val, "global", 6))
2686 if (is_section && skip_this_section(val))
2689 td = get_new_job(global, &def_thread, true, NULL);
2690 if (!td || ioengine_load(td)) {
2699 fio_options_set_ioengine_opts(l_opts, td);
2702 if ((!val || !strlen(val)) &&
2703 l_opts[lidx].has_arg == required_argument) {
2704 log_err("fio: option %s requires an argument\n", opt);
2707 ret = fio_cmd_option_parse(td, opt, val);
2718 if (!ret && !strcmp(opt, "ioengine")) {
2719 if (ioengine_load(td)) {
2726 fio_options_set_ioengine_opts(l_opts, td);
2730 case FIO_GETOPT_IOENGINE: {
2731 const char *opt = l_opts[lidx].name;
2737 ret = fio_cmd_ioengine_option_parse(td, opt, val);
2744 max_jobs = atoi(optarg);
2745 if (!max_jobs || max_jobs > REAL_MAX_JOBS) {
2746 log_err("fio: invalid max jobs: %d\n", max_jobs);
2753 #ifndef CONFIG_NO_SHM
2755 log_err("fio: can't be both client and server\n");
2761 fio_server_set_arg(optarg);
2765 log_err("fio: client/server requires SHM support\n");
2773 pid_file = strdup(optarg);
2776 if ((ret = fio_idle_prof_parse_opt(optarg))) {
2777 /* exit on error and calibration only */
2787 log_err("fio: can't be both client and server\n");
2792 /* if --client parameter contains a pathname */
2793 if (0 == access(optarg, R_OK)) {
2794 /* file contains a list of host addrs or names */
2795 char hostaddr[PATH_MAX] = {0};
2797 FILE * hostf = fopen(optarg, "r");
2799 log_err("fio: could not open client list file %s for read\n", optarg);
2804 sprintf(formatstr, "%%%ds", PATH_MAX - 1);
2806 * read at most PATH_MAX-1 chars from each
2807 * record in this file
2809 while (fscanf(hostf, formatstr, hostaddr) == 1) {
2810 /* expect EVERY host in file to be valid */
2811 if (fio_client_add(&fio_client_ops, hostaddr, &cur_client)) {
2812 log_err("fio: failed adding client %s from file %s\n", hostaddr, optarg);
2819 break; /* no possibility of job file for "this client only" */
2821 if (fio_client_add(&fio_client_ops, optarg, &cur_client)) {
2822 log_err("fio: failed adding client %s\n", optarg);
2828 * If the next argument exists and isn't an option,
2829 * assume it's a job file for this client only.
2831 while (optind < argc) {
2832 if (!strncmp(argv[optind], "--", 2) ||
2833 !strncmp(argv[optind], "-", 1))
2836 if (fio_client_add_ini_file(cur_client, argv[optind], false))
2843 if (fio_client_add_ini_file(cur_client, optarg, true)) {
2851 exit_val = fio_monotonic_clocktest(1);
2856 exit_val = fio_crctest(optarg);
2861 exit_val = fio_memcpy_test(optarg);
2866 if (check_str_time(optarg, &val, 1)) {
2867 log_err("fio: failed parsing time %s\n", optarg);
2873 log_err("fio: status interval too small\n");
2877 status_interval = val / 1000;
2883 trigger_file = strdup(optarg);
2888 trigger_cmd = strdup(optarg);
2891 if (trigger_remote_cmd)
2892 free(trigger_remote_cmd);
2893 trigger_remote_cmd = strdup(optarg);
2898 aux_path = strdup(optarg);
2901 if (check_str_time(optarg, &trigger_timeout, 1)) {
2902 log_err("fio: failed parsing time %s\n", optarg);
2906 trigger_timeout /= 1000000;
2911 merge_blktrace_only = true;
2914 log_err("%s: unrecognized option '%s'\n", argv[0],
2916 show_closest_option(argv[optind - 1]);
2927 if (do_exit && !(is_backend || nr_clients))
2930 if (nr_clients && fio_clients_connect())
2933 if (is_backend && backend)
2934 return fio_start_server(pid_file);
2940 ret = add_job(td, td->o.name ?: "fio", 0, 0, client_type);
2946 while (!ret && optind < argc) {
2948 ini_file = realloc(ini_file, ini_idx * sizeof(char *));
2949 ini_file[ini_idx - 1] = strdup(argv[optind]);
2957 int fio_init_options(void)
2962 fio_options_fill_optstring();
2963 fio_options_dup_and_init(l_opts);
2967 if (fill_def_thread())
2973 extern int fio_check_options(struct thread_options *);
2975 int parse_options(int argc, char *argv[])
2977 const int type = FIO_CLIENT_TYPE_CLI;
2980 if (fio_init_options())
2982 if (fio_test_cconv(&def_thread.o))
2983 log_err("fio: failed internal cconv test\n");
2985 job_files = parse_cmd_line(argc, argv, type);
2987 if (job_files > 0) {
2988 for (i = 0; i < job_files; i++) {
2989 if (i && fill_def_thread())
2992 if (fio_clients_send_ini(ini_file[i]))
2995 } else if (!is_backend) {
2996 if (parse_jobs_ini(ini_file[i], 0, i, type))
3001 } else if (nr_clients) {
3002 if (fill_def_thread())
3004 if (fio_clients_send_ini(NULL))
3009 fio_options_free(&def_thread);
3010 filesetup_mem_free();
3012 if (!thread_number) {
3017 if (is_backend || nr_clients)
3022 log_err("No job(s) defined\n\n");
3027 if (output_format & FIO_OUTPUT_NORMAL)
3028 log_info("%s\n", fio_version_string);
3033 void options_default_fill(struct thread_options *o)
3035 memcpy(o, &def_thread.o, sizeof(*o));
3038 struct thread_data *get_global_options(void)