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 bool dump_cmdline;
49 static bool parse_only;
50 static bool merge_blktrace_only;
52 static struct thread_data def_thread;
53 struct thread_segment segments[REAL_MAX_SEG];
54 static char **job_sections;
55 static int nr_job_sections;
57 bool exitall_on_terminate = false;
58 int output_format = FIO_OUTPUT_NORMAL;
59 int eta_print = FIO_ETA_AUTO;
60 unsigned int eta_interval_msec = 1000;
64 char *exec_profile = NULL;
65 int warnings_fatal = 0;
66 int terse_version = 3;
67 bool is_backend = false;
68 bool is_local_backend = false;
70 bool log_syslog = false;
72 bool write_bw_log = false;
73 bool read_only = false;
74 int status_interval = 0;
76 char *trigger_file = NULL;
77 long long trigger_timeout = 0;
78 char *trigger_cmd = NULL;
79 char *trigger_remote_cmd = NULL;
81 char *aux_path = NULL;
83 static int prev_group_jobs;
85 unsigned long fio_debug = 0;
86 unsigned int fio_debug_jobno = -1;
87 unsigned int *fio_debug_jobp = NULL;
88 unsigned int *fio_warned = NULL;
90 static char cmd_optstr[256];
93 #define FIO_CLIENT_FLAG (1 << 16)
96 * Command line options. These will contain the above, plus a few
97 * extra that only pertain to fio itself and not jobs.
99 static struct option l_opts[FIO_NR_OPTIONS] = {
101 .name = (char *) "output",
102 .has_arg = required_argument,
103 .val = 'o' | FIO_CLIENT_FLAG,
106 .name = (char *) "latency-log",
107 .has_arg = required_argument,
108 .val = 'l' | FIO_CLIENT_FLAG,
111 .name = (char *) "bandwidth-log",
112 .has_arg = no_argument,
113 .val = 'b' | FIO_CLIENT_FLAG,
116 .name = (char *) "minimal",
117 .has_arg = no_argument,
118 .val = 'm' | FIO_CLIENT_FLAG,
121 .name = (char *) "output-format",
122 .has_arg = required_argument,
123 .val = 'F' | FIO_CLIENT_FLAG,
126 .name = (char *) "append-terse",
127 .has_arg = optional_argument,
131 .name = (char *) "version",
132 .has_arg = no_argument,
133 .val = 'v' | FIO_CLIENT_FLAG,
136 .name = (char *) "help",
137 .has_arg = no_argument,
138 .val = 'h' | FIO_CLIENT_FLAG,
141 .name = (char *) "cmdhelp",
142 .has_arg = optional_argument,
143 .val = 'c' | FIO_CLIENT_FLAG,
146 .name = (char *) "enghelp",
147 .has_arg = optional_argument,
148 .val = 'i' | FIO_CLIENT_FLAG,
151 .name = (char *) "showcmd",
152 .has_arg = no_argument,
153 .val = 's' | FIO_CLIENT_FLAG,
156 .name = (char *) "readonly",
157 .has_arg = no_argument,
158 .val = 'r' | FIO_CLIENT_FLAG,
161 .name = (char *) "eta",
162 .has_arg = required_argument,
163 .val = 'e' | FIO_CLIENT_FLAG,
166 .name = (char *) "eta-interval",
167 .has_arg = required_argument,
168 .val = 'O' | FIO_CLIENT_FLAG,
171 .name = (char *) "eta-newline",
172 .has_arg = required_argument,
173 .val = 'E' | FIO_CLIENT_FLAG,
176 .name = (char *) "debug",
177 .has_arg = required_argument,
178 .val = 'd' | FIO_CLIENT_FLAG,
181 .name = (char *) "parse-only",
182 .has_arg = no_argument,
183 .val = 'P' | FIO_CLIENT_FLAG,
186 .name = (char *) "section",
187 .has_arg = required_argument,
188 .val = 'x' | FIO_CLIENT_FLAG,
192 .name = (char *) "inflate-log",
193 .has_arg = required_argument,
194 .val = 'X' | FIO_CLIENT_FLAG,
198 .name = (char *) "alloc-size",
199 .has_arg = required_argument,
200 .val = 'a' | FIO_CLIENT_FLAG,
203 .name = (char *) "profile",
204 .has_arg = required_argument,
205 .val = 'p' | FIO_CLIENT_FLAG,
208 .name = (char *) "warnings-fatal",
209 .has_arg = no_argument,
210 .val = 'w' | FIO_CLIENT_FLAG,
213 .name = (char *) "max-jobs",
214 .has_arg = required_argument,
215 .val = 'j' | FIO_CLIENT_FLAG,
218 .name = (char *) "terse-version",
219 .has_arg = required_argument,
220 .val = 'V' | FIO_CLIENT_FLAG,
223 .name = (char *) "server",
224 .has_arg = optional_argument,
227 { .name = (char *) "daemonize",
228 .has_arg = required_argument,
232 .name = (char *) "client",
233 .has_arg = required_argument,
237 .name = (char *) "remote-config",
238 .has_arg = required_argument,
242 .name = (char *) "cpuclock-test",
243 .has_arg = no_argument,
247 .name = (char *) "crctest",
248 .has_arg = optional_argument,
252 .name = (char *) "memcpytest",
253 .has_arg = optional_argument,
257 .name = (char *) "idle-prof",
258 .has_arg = required_argument,
262 .name = (char *) "status-interval",
263 .has_arg = required_argument,
264 .val = 'L' | FIO_CLIENT_FLAG,
267 .name = (char *) "trigger-file",
268 .has_arg = required_argument,
272 .name = (char *) "trigger-timeout",
273 .has_arg = required_argument,
277 .name = (char *) "trigger",
278 .has_arg = required_argument,
282 .name = (char *) "trigger-remote",
283 .has_arg = required_argument,
287 .name = (char *) "aux-path",
288 .has_arg = required_argument,
292 .name = (char *) "merge-blktrace-only",
293 .has_arg = no_argument,
294 .val = 'A' | FIO_CLIENT_FLAG,
301 void free_threads_shm(void)
305 for (i = 0; i < nr_segments; i++) {
306 struct thread_segment *seg = &segments[i];
309 void *tp = seg->threads;
310 #ifndef CONFIG_NO_SHM
311 struct shmid_ds sbuf;
315 shmctl(seg->shm_id, IPC_RMID, &sbuf);
328 static void free_shm(void)
332 fio_debug_jobp = NULL;
339 free(trigger_remote_cmd);
340 trigger_file = trigger_cmd = trigger_remote_cmd = NULL;
342 options_free(fio_options, &def_thread.o);
348 static int add_thread_segment(void)
350 struct thread_segment *seg = &segments[nr_segments];
351 size_t size = JOBS_PER_SEG * sizeof(struct thread_data);
354 if (nr_segments + 1 >= REAL_MAX_SEG) {
355 log_err("error: maximum number of jobs reached.\n");
359 size += 2 * sizeof(unsigned int);
361 #ifndef CONFIG_NO_SHM
362 seg->shm_id = shmget(0, size, IPC_CREAT | 0600);
363 if (seg->shm_id == -1) {
364 if (errno != EINVAL && errno != ENOMEM && errno != ENOSPC)
369 seg->threads = malloc(size);
374 #ifndef CONFIG_NO_SHM
375 seg->threads = shmat(seg->shm_id, NULL, 0);
376 if (seg->threads == (void *) -1) {
380 if (shm_attach_to_open_removed())
381 shmctl(seg->shm_id, IPC_RMID, NULL);
386 memset(seg->threads, 0, JOBS_PER_SEG * sizeof(struct thread_data));
387 for (i = 0; i < JOBS_PER_SEG; i++)
388 DRD_IGNORE_VAR(seg->threads[i]);
391 /* Not first segment, we're done */
392 if (nr_segments != 1) {
397 fio_debug_jobp = (unsigned int *)(seg->threads + JOBS_PER_SEG);
398 *fio_debug_jobp = -1;
399 fio_warned = fio_debug_jobp + 1;
407 * The thread areas are shared between the main process and the job
408 * threads/processes, and is split into chunks of JOBS_PER_SEG. If the current
409 * segment has no more room, add a new chunk.
411 static int expand_thread_area(void)
413 struct thread_segment *seg = &segments[cur_segment];
415 if (nr_segments && seg->nr_threads < JOBS_PER_SEG)
418 return add_thread_segment();
421 static void dump_print_option(struct print_option *p)
425 if (!strcmp("description", p->name))
430 log_info("--%s%s", p->name, p->value ? "" : " ");
432 log_info("=%s%s%s ", delim, p->value, delim);
435 static void dump_opt_list(struct thread_data *td)
437 struct flist_head *entry;
438 struct print_option *p;
440 if (flist_empty(&td->opt_list))
443 flist_for_each(entry, &td->opt_list) {
444 p = flist_entry(entry, struct print_option, list);
445 dump_print_option(p);
449 static void fio_dump_options_free(struct thread_data *td)
451 while (!flist_empty(&td->opt_list)) {
452 struct print_option *p;
454 p = flist_first_entry(&td->opt_list, struct print_option, list);
455 flist_del_init(&p->list);
462 static void copy_opt_list(struct thread_data *dst, struct thread_data *src)
464 struct flist_head *entry;
466 if (flist_empty(&src->opt_list))
469 flist_for_each(entry, &src->opt_list) {
470 struct print_option *srcp, *dstp;
472 srcp = flist_entry(entry, struct print_option, list);
473 dstp = malloc(sizeof(*dstp));
474 dstp->name = strdup(srcp->name);
476 dstp->value = strdup(srcp->value);
479 flist_add_tail(&dstp->list, &dst->opt_list);
484 * Return a free job structure.
486 static struct thread_data *get_new_job(bool global, struct thread_data *parent,
487 bool preserve_eo, const char *jobname)
489 struct thread_segment *seg;
490 struct thread_data *td;
494 if (expand_thread_area()) {
495 log_err("error: failed to setup shm segment\n");
499 seg = &segments[cur_segment];
500 td = &seg->threads[seg->nr_threads++];
504 INIT_FLIST_HEAD(&td->opt_list);
505 if (parent != &def_thread)
506 copy_opt_list(td, parent);
513 td->o.uid = td->o.gid = -1U;
515 dup_files(td, parent);
516 fio_options_mem_dupe(td);
518 profile_add_hooks(td);
520 td->thread_number = thread_number;
521 td->subjob_number = 0;
524 td->o.name = strdup(jobname);
526 if (!parent->o.group_reporting || parent == &def_thread)
532 static void put_job(struct thread_data *td)
534 if (td == &def_thread)
541 log_info("fio: %s\n", td->verror);
543 fio_options_free(td);
544 fio_dump_options_free(td);
551 memset(td, 0, sizeof(*td));
552 segments[cur_segment].nr_threads--;
556 static int __setup_rate(struct thread_data *td, enum fio_ddir ddir)
558 unsigned long long bs = td->o.min_bs[ddir];
560 assert(ddir_rw(ddir));
562 if (td->o.rate[ddir])
563 td->rate_bps[ddir] = td->o.rate[ddir];
565 td->rate_bps[ddir] = (uint64_t) td->o.rate_iops[ddir] * bs;
567 if (!td->rate_bps[ddir]) {
568 log_err("rate lower than supported\n");
572 td->rate_next_io_time[ddir] = 0;
573 td->rate_io_issue_bytes[ddir] = 0;
574 td->last_usec[ddir] = 0;
578 static int setup_rate(struct thread_data *td)
582 for_each_rw_ddir(ddir) {
583 if (td->o.rate[ddir] || td->o.rate_iops[ddir]) {
584 ret |= __setup_rate(td, ddir);
590 static int fixed_block_size(struct thread_options *o)
592 return o->min_bs[DDIR_READ] == o->max_bs[DDIR_READ] &&
593 o->min_bs[DDIR_WRITE] == o->max_bs[DDIR_WRITE] &&
594 o->min_bs[DDIR_TRIM] == o->max_bs[DDIR_TRIM] &&
595 o->min_bs[DDIR_READ] == o->min_bs[DDIR_WRITE] &&
596 o->min_bs[DDIR_READ] == o->min_bs[DDIR_TRIM];
602 static unsigned int gcd(unsigned int m, unsigned int n)
607 return gcd(n, m % n);
611 * Lazy way of fixing up options that depend on each other. We could also
612 * define option callback handlers, but this is easier.
614 static int fixup_options(struct thread_data *td)
616 struct thread_options *o = &td->o;
619 if (read_only && (td_write(td) || td_trim(td))) {
620 log_err("fio: trim and write operations are not allowed"
621 " with the --readonly parameter.\n");
625 #ifndef CONFIG_PSHARED
626 if (!o->use_thread) {
627 log_info("fio: this platform does not support process shared"
628 " mutexes, forcing use of threads. Use the 'thread'"
629 " option to get rid of this warning.\n");
631 ret |= warnings_fatal;
635 if (o->write_iolog_file && o->read_iolog_file) {
636 log_err("fio: read iolog overrides write_iolog\n");
637 free(o->write_iolog_file);
638 o->write_iolog_file = NULL;
639 ret |= warnings_fatal;
642 if (o->zone_mode == ZONE_MODE_NONE && o->zone_size) {
643 log_err("fio: --zonemode=none and --zonesize are not compatible.\n");
647 if (o->zone_mode == ZONE_MODE_STRIDED && !o->zone_size) {
648 log_err("fio: --zonesize must be specified when using --zonemode=strided.\n");
652 if (o->zone_mode == ZONE_MODE_NOT_SPECIFIED) {
654 o->zone_mode = ZONE_MODE_STRIDED;
656 o->zone_mode = ZONE_MODE_NONE;
660 * Strided zone mode only really works with 1 file.
662 if (o->zone_mode == ZONE_MODE_STRIDED && o->open_files > 1)
663 o->zone_mode = ZONE_MODE_NONE;
666 * If zone_range isn't specified, backward compatibility dictates it
667 * should be made equal to zone_size.
669 if (o->zone_mode == ZONE_MODE_STRIDED && !o->zone_range)
670 o->zone_range = o->zone_size;
673 * Reads can do overwrites, we always need to pre-create the file
678 for_each_rw_ddir(ddir) {
679 if (!o->min_bs[ddir])
680 o->min_bs[ddir] = o->bs[ddir];
681 if (!o->max_bs[ddir])
682 o->max_bs[ddir] = o->bs[ddir];
686 for_each_rw_ddir(ddir) {
687 o->rw_min_bs = min(o->rw_min_bs, o->min_bs[ddir]);
691 * For random IO, allow blockalign offset other than min_bs.
693 for_each_rw_ddir(ddir) {
694 if (!o->ba[ddir] || !td_random(td))
695 o->ba[ddir] = o->min_bs[ddir];
698 if ((o->ba[DDIR_READ] != o->min_bs[DDIR_READ] ||
699 o->ba[DDIR_WRITE] != o->min_bs[DDIR_WRITE] ||
700 o->ba[DDIR_TRIM] != o->min_bs[DDIR_TRIM]) &&
702 log_err("fio: Any use of blockalign= turns off randommap\n");
704 ret |= warnings_fatal;
707 if (!o->file_size_high)
708 o->file_size_high = o->file_size_low;
710 if (o->start_delay_high) {
711 if (!o->start_delay_orig)
712 o->start_delay_orig = o->start_delay;
713 o->start_delay = rand_between(&td->delay_state,
715 o->start_delay_high);
718 if (o->norandommap && o->verify != VERIFY_NONE
719 && !fixed_block_size(o)) {
720 log_err("fio: norandommap given for variable block sizes, "
722 ret |= warnings_fatal;
724 if (o->bs_unaligned && (o->odirect || td_ioengine_flagged(td, FIO_RAWIO)))
725 log_err("fio: bs_unaligned may not work with raw io\n");
728 * thinktime_spin must be less than thinktime
730 if (o->thinktime_spin > o->thinktime)
731 o->thinktime_spin = o->thinktime;
734 * The low water mark cannot be bigger than the iodepth
736 if (o->iodepth_low > o->iodepth || !o->iodepth_low)
737 o->iodepth_low = o->iodepth;
740 * If batch number isn't set, default to the same as iodepth
742 if (o->iodepth_batch > o->iodepth || !o->iodepth_batch)
743 o->iodepth_batch = o->iodepth;
746 * If max batch complete number isn't set or set incorrectly,
747 * default to the same as iodepth_batch_complete_min
749 if (o->iodepth_batch_complete_min > o->iodepth_batch_complete_max)
750 o->iodepth_batch_complete_max = o->iodepth_batch_complete_min;
753 * There's no need to check for in-flight overlapping IOs if the job
754 * isn't changing data or the maximum iodepth is guaranteed to be 1
755 * when we are not in offload mode
757 if (o->serialize_overlap && !(td->flags & TD_F_READ_IOLOG) &&
758 (!(td_write(td) || td_trim(td)) || o->iodepth == 1) &&
759 o->io_submit_mode != IO_MODE_OFFLOAD)
760 o->serialize_overlap = 0;
762 if (o->nr_files > td->files_index)
763 o->nr_files = td->files_index;
765 if (o->open_files > o->nr_files || !o->open_files)
766 o->open_files = o->nr_files;
768 if (((o->rate[DDIR_READ] + o->rate[DDIR_WRITE] + o->rate[DDIR_TRIM]) &&
769 (o->rate_iops[DDIR_READ] + o->rate_iops[DDIR_WRITE] + o->rate_iops[DDIR_TRIM])) ||
770 ((o->ratemin[DDIR_READ] + o->ratemin[DDIR_WRITE] + o->ratemin[DDIR_TRIM]) &&
771 (o->rate_iops_min[DDIR_READ] + o->rate_iops_min[DDIR_WRITE] + o->rate_iops_min[DDIR_TRIM]))) {
772 log_err("fio: rate and rate_iops are mutually exclusive\n");
775 for_each_rw_ddir(ddir) {
776 if ((o->rate[ddir] && (o->rate[ddir] < o->ratemin[ddir])) ||
777 (o->rate_iops[ddir] && (o->rate_iops[ddir] < o->rate_iops_min[ddir]))) {
778 log_err("fio: minimum rate exceeds rate, ddir %d\n", +ddir);
783 if (!o->timeout && o->time_based) {
784 log_err("fio: time_based requires a runtime/timeout setting\n");
786 ret |= warnings_fatal;
789 if (o->fill_device && !o->size)
792 if (o->verify != VERIFY_NONE) {
793 if (td_write(td) && o->do_verify && o->numjobs > 1 &&
795 !(o->unique_filename &&
796 strstr(o->filename_format, "$jobname") &&
797 strstr(o->filename_format, "$jobnum") &&
798 strstr(o->filename_format, "$filenum")))) {
799 log_info("fio: multiple writers may overwrite blocks "
800 "that belong to other jobs. This can cause "
801 "verification failures.\n");
802 ret |= warnings_fatal;
806 * Warn if verification is requested but no verification of any
807 * kind can be started due to time constraints
809 if (td_write(td) && o->do_verify && o->timeout &&
810 o->time_based && !td_read(td) && !o->verify_backlog) {
811 log_info("fio: verification read phase will never "
812 "start because write phase uses all of "
814 ret |= warnings_fatal;
817 if (!fio_option_is_set(o, refill_buffers))
818 o->refill_buffers = 1;
820 if (o->max_bs[DDIR_WRITE] != o->min_bs[DDIR_WRITE] &&
822 o->verify_interval = o->min_bs[DDIR_WRITE];
825 * Verify interval must be smaller or equal to the
828 if (o->verify_interval > o->min_bs[DDIR_WRITE])
829 o->verify_interval = o->min_bs[DDIR_WRITE];
830 else if (td_read(td) && o->verify_interval > o->min_bs[DDIR_READ])
831 o->verify_interval = o->min_bs[DDIR_READ];
834 * Verify interval must be a factor of both min and max
837 if (!o->verify_interval ||
838 (o->min_bs[DDIR_WRITE] % o->verify_interval) ||
839 (o->max_bs[DDIR_WRITE] % o->verify_interval))
840 o->verify_interval = gcd(o->min_bs[DDIR_WRITE],
841 o->max_bs[DDIR_WRITE]);
845 if (o->invalidate_cache)
846 o->invalidate_cache = 0;
847 if (td_ioengine_flagged(td, FIO_PIPEIO)) {
848 log_info("fio: cannot pre-read files with an IO engine"
849 " that isn't seekable. Pre-read disabled.\n");
850 ret |= warnings_fatal;
854 if (o->unit_base == N2S_NONE) {
855 if (td_ioengine_flagged(td, FIO_BIT_BASED))
856 o->unit_base = N2S_BITPERSEC;
858 o->unit_base = N2S_BYTEPERSEC;
861 #ifndef CONFIG_FDATASYNC
862 if (o->fdatasync_blocks) {
863 log_info("fio: this platform does not support fdatasync()"
864 " falling back to using fsync(). Use the 'fsync'"
865 " option instead of 'fdatasync' to get rid of"
867 o->fsync_blocks = o->fdatasync_blocks;
868 o->fdatasync_blocks = 0;
869 ret |= warnings_fatal;
875 * Windows doesn't support O_DIRECT or O_SYNC with the _open interface,
876 * so fail if we're passed those flags
878 if (td_ioengine_flagged(td, FIO_SYNCIO) && (o->odirect || o->sync_io)) {
879 log_err("fio: Windows does not support direct or non-buffered io with"
880 " the synchronous ioengines. Use the 'windowsaio' ioengine"
881 " with 'direct=1' and 'iodepth=1' instead.\n");
887 * For fully compressible data, just zero them at init time.
888 * It's faster than repeatedly filling it. For non-zero
889 * compression, we should have refill_buffers set. Set it, unless
890 * the job file already changed it.
892 if (o->compress_percentage) {
893 if (o->compress_percentage == 100) {
895 o->compress_percentage = 0;
896 } else if (!fio_option_is_set(o, refill_buffers)) {
897 o->refill_buffers = 1;
898 td->flags |= TD_F_REFILL_BUFFERS;
903 * Using a non-uniform random distribution excludes usage of
906 if (o->random_distribution != FIO_RAND_DIST_RANDOM)
910 * If size is set but less than the min block size, complain
912 if (o->size && o->size < td_min_bs(td)) {
913 log_err("fio: size too small, must not be less than minimum block size: %llu < %llu\n",
914 (unsigned long long) o->size, td_min_bs(td));
919 * O_ATOMIC implies O_DIRECT
925 * If randseed is set, that overrides randrepeat
927 if (fio_option_is_set(o, rand_seed))
928 o->rand_repeatable = 0;
930 if (td_ioengine_flagged(td, FIO_NOEXTEND) && o->file_append) {
931 log_err("fio: can't append/extent with IO engine %s\n", td->io_ops->name);
935 if (fio_option_is_set(o, gtod_cpu)) {
937 fio_gtod_set_cpu(o->gtod_cpu);
938 fio_gtod_offload = 1;
941 td->loops = o->loops;
945 if (o->block_error_hist && o->nr_files != 1) {
946 log_err("fio: block error histogram only available "
947 "with a single file per job, but %d files "
948 "provided\n", o->nr_files);
953 o->lat_percentiles = 0;
955 o->clat_percentiles = 0;
957 o->slat_percentiles = 0;
960 * Fix these up to be nsec internally
962 o->max_latency *= 1000ULL;
963 o->latency_target *= 1000ULL;
968 static void init_rand_file_service(struct thread_data *td)
970 unsigned long nranges = td->o.nr_files << FIO_FSERVICE_SHIFT;
971 const unsigned int seed = td->rand_seeds[FIO_RAND_FILE_OFF];
973 if (td->o.file_service_type == FIO_FSERVICE_ZIPF) {
974 zipf_init(&td->next_file_zipf, nranges, td->zipf_theta, seed);
975 zipf_disable_hash(&td->next_file_zipf);
976 } else if (td->o.file_service_type == FIO_FSERVICE_PARETO) {
977 pareto_init(&td->next_file_zipf, nranges, td->pareto_h, seed);
978 zipf_disable_hash(&td->next_file_zipf);
979 } else if (td->o.file_service_type == FIO_FSERVICE_GAUSS) {
980 gauss_init(&td->next_file_gauss, nranges, td->gauss_dev, seed);
981 gauss_disable_hash(&td->next_file_gauss);
985 void td_fill_verify_state_seed(struct thread_data *td)
989 if (td->o.random_generator == FIO_RAND_GEN_TAUSWORTHE64)
994 init_rand_seed(&td->verify_state, td->rand_seeds[FIO_RAND_VER_OFF],
998 static void td_fill_rand_seeds_internal(struct thread_data *td, bool use64)
1000 uint64_t read_seed = td->rand_seeds[FIO_RAND_BS_OFF];
1001 uint64_t write_seed = td->rand_seeds[FIO_RAND_BS1_OFF];
1002 uint64_t trim_seed = td->rand_seeds[FIO_RAND_BS2_OFF];
1006 * trimwrite is special in that we need to generate the same
1007 * offsets to get the "write after trim" effect. If we are
1008 * using bssplit to set buffer length distributions, ensure that
1009 * we seed the trim and write generators identically. Ditto for
1010 * verify, read and writes must have the same seed, if we are doing
1013 if (td->o.verify != VERIFY_NONE)
1014 write_seed = read_seed;
1015 if (td_trimwrite(td))
1016 trim_seed = write_seed;
1017 init_rand_seed(&td->bsrange_state[DDIR_READ], read_seed, use64);
1018 init_rand_seed(&td->bsrange_state[DDIR_WRITE], write_seed, use64);
1019 init_rand_seed(&td->bsrange_state[DDIR_TRIM], trim_seed, use64);
1021 td_fill_verify_state_seed(td);
1022 init_rand_seed(&td->rwmix_state, td->rand_seeds[FIO_RAND_MIX_OFF], false);
1024 if (td->o.file_service_type == FIO_FSERVICE_RANDOM)
1025 init_rand_seed(&td->next_file_state, td->rand_seeds[FIO_RAND_FILE_OFF], use64);
1026 else if (td->o.file_service_type & __FIO_FSERVICE_NONUNIFORM)
1027 init_rand_file_service(td);
1029 init_rand_seed(&td->file_size_state, td->rand_seeds[FIO_RAND_FILE_SIZE_OFF], use64);
1030 init_rand_seed(&td->trim_state, td->rand_seeds[FIO_RAND_TRIM_OFF], use64);
1031 init_rand_seed(&td->delay_state, td->rand_seeds[FIO_RAND_START_DELAY], use64);
1032 init_rand_seed(&td->poisson_state[0], td->rand_seeds[FIO_RAND_POISSON_OFF], 0);
1033 init_rand_seed(&td->poisson_state[1], td->rand_seeds[FIO_RAND_POISSON2_OFF], 0);
1034 init_rand_seed(&td->poisson_state[2], td->rand_seeds[FIO_RAND_POISSON3_OFF], 0);
1035 init_rand_seed(&td->dedupe_state, td->rand_seeds[FIO_DEDUPE_OFF], false);
1036 init_rand_seed(&td->zone_state, td->rand_seeds[FIO_RAND_ZONE_OFF], false);
1037 init_rand_seed(&td->prio_state, td->rand_seeds[FIO_RAND_PRIO_CMDS], false);
1042 if (td->o.rand_repeatable)
1043 td->rand_seeds[FIO_RAND_BLOCK_OFF] = FIO_RANDSEED * td->thread_number;
1045 init_rand_seed(&td->random_state, td->rand_seeds[FIO_RAND_BLOCK_OFF], use64);
1047 for (i = 0; i < DDIR_RWDIR_CNT; i++) {
1048 struct frand_state *s = &td->seq_rand_state[i];
1050 init_rand_seed(s, td->rand_seeds[FIO_RAND_SEQ_RAND_READ_OFF], false);
1054 void td_fill_rand_seeds(struct thread_data *td)
1058 if (td->o.allrand_repeatable) {
1061 for (i = 0; i < FIO_RAND_NR_OFFS; i++)
1062 td->rand_seeds[i] = FIO_RANDSEED * td->thread_number
1066 if (td->o.random_generator == FIO_RAND_GEN_TAUSWORTHE64)
1071 td_fill_rand_seeds_internal(td, use64);
1073 init_rand_seed(&td->buf_state, td->rand_seeds[FIO_RAND_BUF_OFF], use64);
1074 frand_copy(&td->buf_state_prev, &td->buf_state);
1078 * Initializes the ioengine configured for a job, if it has not been done so
1081 int ioengine_load(struct thread_data *td)
1083 if (!td->o.ioengine) {
1084 log_err("fio: internal fault, no IO engine specified\n");
1089 struct ioengine_ops *ops;
1092 /* An engine is loaded, but the requested ioengine
1095 if (!strcmp(td->io_ops->name, td->o.ioengine)) {
1096 /* The right engine is already loaded */
1101 * Name of file and engine may be different, load ops
1102 * for this name and see if they match. If they do, then
1103 * the engine is unchanged.
1105 dlhandle = td->io_ops_dlhandle;
1106 ops = load_ioengine(td);
1110 if (ops == td->io_ops && dlhandle == td->io_ops_dlhandle) {
1116 if (dlhandle && dlhandle != td->io_ops_dlhandle)
1119 /* Unload the old engine. */
1123 td->io_ops = load_ioengine(td);
1127 if (td->io_ops->option_struct_size && td->io_ops->options) {
1129 * In cases where td->eo is set, clone it for a child thread.
1130 * This requires that the parent thread has the same ioengine,
1131 * but that requirement must be enforced by the code which
1132 * cloned the thread.
1134 void *origeo = td->eo;
1136 * Otherwise use the default thread options.
1138 if (!origeo && td != &def_thread && def_thread.eo &&
1139 def_thread.io_ops->options == td->io_ops->options)
1140 origeo = def_thread.eo;
1142 options_init(td->io_ops->options);
1143 td->eo = malloc(td->io_ops->option_struct_size);
1145 * Use the default thread as an option template if this uses the
1146 * same options structure and there are non-default options
1150 memcpy(td->eo, origeo, td->io_ops->option_struct_size);
1151 options_mem_dupe(td->io_ops->options, td->eo);
1153 memset(td->eo, 0, td->io_ops->option_struct_size);
1154 fill_default_options(td->eo, td->io_ops->options);
1156 *(struct thread_data **)td->eo = td;
1160 td->io_ops->flags |= FIO_RAWIO;
1162 td_set_ioengine_flags(td);
1166 log_err("fio: failed to load engine\n");
1171 static void init_flags(struct thread_data *td)
1173 struct thread_options *o = &td->o;
1176 if (o->verify_backlog)
1177 td->flags |= TD_F_VER_BACKLOG;
1178 if (o->trim_backlog)
1179 td->flags |= TD_F_TRIM_BACKLOG;
1180 if (o->read_iolog_file)
1181 td->flags |= TD_F_READ_IOLOG;
1182 if (o->refill_buffers)
1183 td->flags |= TD_F_REFILL_BUFFERS;
1185 * Always scramble buffers if asked to
1187 if (o->scramble_buffers && fio_option_is_set(o, scramble_buffers))
1188 td->flags |= TD_F_SCRAMBLE_BUFFERS;
1190 * But also scramble buffers, unless we were explicitly asked
1193 if (o->scramble_buffers && !(o->zero_buffers &&
1194 fio_option_is_set(o, zero_buffers)))
1195 td->flags |= TD_F_SCRAMBLE_BUFFERS;
1196 if (o->verify != VERIFY_NONE)
1197 td->flags |= TD_F_DO_VERIFY;
1199 if (o->verify_async || o->io_submit_mode == IO_MODE_OFFLOAD)
1200 td->flags |= TD_F_NEED_LOCK;
1202 if (o->mem_type == MEM_CUDA_MALLOC)
1203 td->flags &= ~TD_F_SCRAMBLE_BUFFERS;
1205 for (i = 0; i < DDIR_RWDIR_CNT; i++) {
1206 if (option_check_rate(td, i)) {
1207 td->flags |= TD_F_CHECK_RATE;
1213 static int setup_random_seeds(struct thread_data *td)
1218 if (!td->o.rand_repeatable && !fio_option_is_set(&td->o, rand_seed)) {
1219 int ret = init_random_seeds(td->rand_seeds, sizeof(td->rand_seeds));
1221 td_fill_rand_seeds(td);
1225 seed = td->o.rand_seed;
1226 for (i = 0; i < 4; i++)
1227 seed *= 0x9e370001UL;
1229 for (i = 0; i < FIO_RAND_NR_OFFS; i++) {
1230 td->rand_seeds[i] = seed * td->thread_number + i;
1231 seed *= 0x9e370001UL;
1234 td_fill_rand_seeds(td);
1245 static struct fpre_keyword {
1246 const char *keyword;
1249 } fpre_keywords[] = {
1250 { .keyword = "$jobname", .key = FPRE_JOBNAME, },
1251 { .keyword = "$jobnum", .key = FPRE_JOBNUM, },
1252 { .keyword = "$filenum", .key = FPRE_FILENUM, },
1253 { .keyword = NULL, },
1256 static char *make_filename(char *buf, size_t buf_size,struct thread_options *o,
1257 const char *jobname, int jobnum, int filenum)
1259 struct fpre_keyword *f;
1260 char copy[PATH_MAX];
1261 size_t dst_left = PATH_MAX - 1;
1263 if (!o->filename_format || !strlen(o->filename_format)) {
1264 sprintf(buf, "%s.%d.%d", jobname, jobnum, filenum);
1268 for (f = &fpre_keywords[0]; f->keyword; f++)
1269 f->strlen = strlen(f->keyword);
1271 snprintf(buf, buf_size, "%s", o->filename_format);
1273 memset(copy, 0, sizeof(copy));
1274 for (f = &fpre_keywords[0]; f->keyword; f++) {
1276 size_t pre_len, post_start = 0;
1277 char *str, *dst = copy;
1279 str = strcasestr(buf, f->keyword);
1283 pre_len = str - buf;
1284 if (strlen(str) != f->strlen)
1285 post_start = pre_len + f->strlen;
1288 strncpy(dst, buf, pre_len);
1290 dst_left -= pre_len;
1294 case FPRE_JOBNAME: {
1297 ret = snprintf(dst, dst_left, "%s", jobname);
1300 else if (ret > dst_left) {
1301 log_err("fio: truncated filename\n");
1313 ret = snprintf(dst, dst_left, "%d", jobnum);
1316 else if (ret > dst_left) {
1317 log_err("fio: truncated filename\n");
1326 case FPRE_FILENUM: {
1329 ret = snprintf(dst, dst_left, "%d", filenum);
1332 else if (ret > dst_left) {
1333 log_err("fio: truncated filename\n");
1348 strncpy(dst, buf + post_start, dst_left);
1350 snprintf(buf, buf_size, "%s", copy);
1357 bool parse_dryrun(void)
1359 return dump_cmdline || parse_only;
1362 static void gen_log_name(char *name, size_t size, const char *logtype,
1363 const char *logname, unsigned int num,
1364 const char *suf, int per_job)
1367 snprintf(name, size, "%s_%s.%d.%s", logname, logtype, num, suf);
1369 snprintf(name, size, "%s_%s.%s", logname, logtype, suf);
1372 static int check_waitees(char *waitee)
1374 struct thread_data *td;
1377 for_each_td(td, i) {
1378 if (td->subjob_number)
1381 ret += !strcmp(td->o.name, waitee);
1387 static bool wait_for_ok(const char *jobname, struct thread_options *o)
1394 if (!strcmp(jobname, o->wait_for)) {
1395 log_err("%s: a job cannot wait for itself (wait_for=%s).\n",
1396 jobname, o->wait_for);
1400 if (!(nw = check_waitees(o->wait_for))) {
1401 log_err("%s: waitee job %s unknown.\n", jobname, o->wait_for);
1406 log_err("%s: multiple waitees %s found,\n"
1407 "please avoid duplicates when using wait_for option.\n",
1408 jobname, o->wait_for);
1416 * Treat an empty log file name the same as a one not given
1418 static const char *make_log_name(const char *logname, const char *jobname)
1420 if (logname && strcmp(logname, ""))
1427 * Adds a job to the list of things todo. Sanitizes the various options
1428 * to make sure we don't have conflicts, and initializes various
1431 static int add_job(struct thread_data *td, const char *jobname, int job_add_num,
1432 int recursed, int client_type)
1435 char fname[PATH_MAX + 1];
1436 int numjobs, file_alloced;
1437 struct thread_options *o = &td->o;
1438 char logname[PATH_MAX + 32];
1441 * the def_thread is just for options, it's not a real job
1443 if (td == &def_thread)
1449 * if we are just dumping the output command line, don't add the job
1451 if (parse_dryrun()) {
1456 td->client_type = client_type;
1458 if (profile_td_init(td))
1461 if (ioengine_load(td))
1465 if (!o->filename && !td->files_index && !o->read_iolog_file) {
1468 if (o->nr_files == 1 && exists_and_not_regfile(jobname))
1469 add_file(td, jobname, job_add_num, 0);
1471 for (i = 0; i < o->nr_files; i++)
1472 add_file(td, make_filename(fname, sizeof(fname), o, jobname, job_add_num, i), job_add_num, 0);
1476 if (setup_random_seeds(td)) {
1477 td_verror(td, errno, "setup_random_seeds");
1481 if (fixup_options(td))
1485 * Belongs to fixup_options, but o->name is not necessarily set as yet
1487 if (!wait_for_ok(jobname, o))
1493 * IO engines only need this for option callbacks, and the address may
1494 * change in subprocesses.
1497 *(struct thread_data **)td->eo = NULL;
1499 if (td_ioengine_flagged(td, FIO_DISKLESSIO)) {
1502 for_each_file(td, f, i)
1503 f->real_file_size = -1ULL;
1506 td->sem = fio_sem_init(FIO_SEM_LOCKED);
1508 td->ts.clat_percentiles = o->clat_percentiles;
1509 td->ts.lat_percentiles = o->lat_percentiles;
1510 td->ts.slat_percentiles = o->slat_percentiles;
1511 td->ts.percentile_precision = o->percentile_precision;
1512 memcpy(td->ts.percentile_list, o->percentile_list, sizeof(o->percentile_list));
1513 td->ts.sig_figs = o->sig_figs;
1515 for (i = 0; i < DDIR_RWDIR_CNT; i++) {
1516 td->ts.clat_stat[i].min_val = ULONG_MAX;
1517 td->ts.slat_stat[i].min_val = ULONG_MAX;
1518 td->ts.lat_stat[i].min_val = ULONG_MAX;
1519 td->ts.bw_stat[i].min_val = ULONG_MAX;
1520 td->ts.iops_stat[i].min_val = ULONG_MAX;
1521 td->ts.clat_high_prio_stat[i].min_val = ULONG_MAX;
1522 td->ts.clat_low_prio_stat[i].min_val = ULONG_MAX;
1524 td->ts.sync_stat.min_val = ULONG_MAX;
1525 td->ddir_seq_nr = o->ddir_seq_nr;
1527 if ((o->stonewall || o->new_group) && prev_group_jobs) {
1528 prev_group_jobs = 0;
1530 if (groupid == INT_MAX) {
1531 log_err("fio: too many groups defined\n");
1536 td->groupid = groupid;
1542 if (o->write_lat_log) {
1543 struct log_params p = {
1545 .avg_msec = o->log_avg_msec,
1546 .hist_msec = o->log_hist_msec,
1547 .hist_coarseness = o->log_hist_coarseness,
1548 .log_type = IO_LOG_TYPE_LAT,
1549 .log_offset = o->log_offset,
1550 .log_gz = o->log_gz,
1551 .log_gz_store = o->log_gz_store,
1553 const char *pre = make_log_name(o->lat_log_file, o->name);
1561 gen_log_name(logname, sizeof(logname), "lat", pre,
1562 td->thread_number, suf, o->per_job_logs);
1563 setup_log(&td->lat_log, &p, logname);
1565 gen_log_name(logname, sizeof(logname), "slat", pre,
1566 td->thread_number, suf, o->per_job_logs);
1567 setup_log(&td->slat_log, &p, logname);
1569 gen_log_name(logname, sizeof(logname), "clat", pre,
1570 td->thread_number, suf, o->per_job_logs);
1571 setup_log(&td->clat_log, &p, logname);
1575 if (o->write_hist_log) {
1576 struct log_params p = {
1578 .avg_msec = o->log_avg_msec,
1579 .hist_msec = o->log_hist_msec,
1580 .hist_coarseness = o->log_hist_coarseness,
1581 .log_type = IO_LOG_TYPE_HIST,
1582 .log_offset = o->log_offset,
1583 .log_gz = o->log_gz,
1584 .log_gz_store = o->log_gz_store,
1586 const char *pre = make_log_name(o->hist_log_file, o->name);
1590 if (td->client_type) {
1591 log_err("fio: --write_hist_log requires zlib in client/server mode\n");
1601 gen_log_name(logname, sizeof(logname), "clat_hist", pre,
1602 td->thread_number, suf, o->per_job_logs);
1603 setup_log(&td->clat_hist_log, &p, logname);
1606 if (o->write_bw_log) {
1607 struct log_params p = {
1609 .avg_msec = o->log_avg_msec,
1610 .hist_msec = o->log_hist_msec,
1611 .hist_coarseness = o->log_hist_coarseness,
1612 .log_type = IO_LOG_TYPE_BW,
1613 .log_offset = o->log_offset,
1614 .log_gz = o->log_gz,
1615 .log_gz_store = o->log_gz_store,
1617 const char *pre = make_log_name(o->bw_log_file, o->name);
1620 if (fio_option_is_set(o, bw_avg_time))
1621 p.avg_msec = min(o->log_avg_msec, o->bw_avg_time);
1623 o->bw_avg_time = p.avg_msec;
1625 p.hist_msec = o->log_hist_msec;
1626 p.hist_coarseness = o->log_hist_coarseness;
1633 gen_log_name(logname, sizeof(logname), "bw", pre,
1634 td->thread_number, suf, o->per_job_logs);
1635 setup_log(&td->bw_log, &p, logname);
1637 if (o->write_iops_log) {
1638 struct log_params p = {
1640 .avg_msec = o->log_avg_msec,
1641 .hist_msec = o->log_hist_msec,
1642 .hist_coarseness = o->log_hist_coarseness,
1643 .log_type = IO_LOG_TYPE_IOPS,
1644 .log_offset = o->log_offset,
1645 .log_gz = o->log_gz,
1646 .log_gz_store = o->log_gz_store,
1648 const char *pre = make_log_name(o->iops_log_file, o->name);
1651 if (fio_option_is_set(o, iops_avg_time))
1652 p.avg_msec = min(o->log_avg_msec, o->iops_avg_time);
1654 o->iops_avg_time = p.avg_msec;
1656 p.hist_msec = o->log_hist_msec;
1657 p.hist_coarseness = o->log_hist_coarseness;
1664 gen_log_name(logname, sizeof(logname), "iops", pre,
1665 td->thread_number, suf, o->per_job_logs);
1666 setup_log(&td->iops_log, &p, logname);
1670 o->name = strdup(jobname);
1672 if (output_format & FIO_OUTPUT_NORMAL) {
1674 if (is_backend && !recursed)
1675 fio_server_send_add_job(td);
1677 if (!td_ioengine_flagged(td, FIO_NOIO)) {
1678 char *c1, *c2, *c3, *c4;
1679 char *c5 = NULL, *c6 = NULL;
1680 int i2p = is_power_of_2(o->kb_base);
1681 struct buf_output out;
1683 c1 = num2str(o->min_bs[DDIR_READ], o->sig_figs, 1, i2p, N2S_BYTE);
1684 c2 = num2str(o->max_bs[DDIR_READ], o->sig_figs, 1, i2p, N2S_BYTE);
1685 c3 = num2str(o->min_bs[DDIR_WRITE], o->sig_figs, 1, i2p, N2S_BYTE);
1686 c4 = num2str(o->max_bs[DDIR_WRITE], o->sig_figs, 1, i2p, N2S_BYTE);
1688 if (!o->bs_is_seq_rand) {
1689 c5 = num2str(o->min_bs[DDIR_TRIM], o->sig_figs, 1, i2p, N2S_BYTE);
1690 c6 = num2str(o->max_bs[DDIR_TRIM], o->sig_figs, 1, i2p, N2S_BYTE);
1693 buf_output_init(&out);
1694 __log_buf(&out, "%s: (g=%d): rw=%s, ", td->o.name,
1696 ddir_str(o->td_ddir));
1698 if (o->bs_is_seq_rand)
1699 __log_buf(&out, "bs=(R) %s-%s, (W) %s-%s, bs_is_seq_rand, ",
1702 __log_buf(&out, "bs=(R) %s-%s, (W) %s-%s, (T) %s-%s, ",
1703 c1, c2, c3, c4, c5, c6);
1705 __log_buf(&out, "ioengine=%s, iodepth=%u\n",
1706 td->io_ops->name, o->iodepth);
1707 log_info_buf(out.buf, out.buflen);
1708 buf_output_free(&out);
1717 } else if (job_add_num == 1)
1721 if (td_steadystate_init(td))
1724 if (o->merge_blktrace_file && !merge_blktrace_iologs(td))
1727 if (merge_blktrace_only) {
1733 * recurse add identical jobs, clear numjobs and stonewall options
1734 * as they don't apply to sub-jobs
1736 numjobs = o->numjobs;
1738 struct thread_data *td_new = get_new_job(false, td, true, jobname);
1743 td_new->o.numjobs = 1;
1744 td_new->o.stonewall = 0;
1745 td_new->o.new_group = 0;
1746 td_new->subjob_number = numjobs;
1747 td_new->o.ss_dur = o->ss_dur * 1000000l;
1748 td_new->o.ss_limit = o->ss_limit;
1751 if (td_new->files) {
1753 for_each_file(td_new, f, i)
1755 free(td_new->files);
1756 td_new->files = NULL;
1758 td_new->files_index = 0;
1759 td_new->files_size = 0;
1760 if (td_new->o.filename) {
1761 free(td_new->o.filename);
1762 td_new->o.filename = NULL;
1766 if (add_job(td_new, jobname, numjobs, 1, client_type))
1777 * Parse as if 'o' was a command line
1779 void add_job_opts(const char **o, int client_type)
1781 struct thread_data *td, *td_parent;
1782 int i, in_global = 1;
1786 td_parent = td = NULL;
1788 if (!strncmp(o[i], "name", 4)) {
1791 add_job(td, jobname, 0, 0, client_type);
1793 sprintf(jobname, "%s", o[i] + 5);
1795 if (in_global && !td_parent)
1796 td_parent = get_new_job(true, &def_thread, false, jobname);
1797 else if (!in_global && !td) {
1799 td_parent = &def_thread;
1800 td = get_new_job(false, td_parent, false, jobname);
1803 fio_options_parse(td_parent, (char **) &o[i], 1);
1805 fio_options_parse(td, (char **) &o[i], 1);
1810 add_job(td, jobname, 0, 0, client_type);
1813 static int skip_this_section(const char *name)
1817 if (!nr_job_sections)
1819 if (!strncmp(name, "global", 6))
1822 for (i = 0; i < nr_job_sections; i++)
1823 if (!strcmp(job_sections[i], name))
1829 static int is_empty_or_comment(char *line)
1833 for (i = 0; i < strlen(line); i++) {
1838 if (!isspace((int) line[i]) && !iscntrl((int) line[i]))
1846 * This is our [ini] type file parser.
1848 static int __parse_jobs_ini(struct thread_data *td,
1849 char *file, int is_buf, int stonewall_flag, int type,
1850 int nested, char *name, char ***popts, int *aopts, int *nopts)
1852 bool global = false;
1853 bool stdin_occupied = false;
1857 int ret = 0, stonewall;
1860 int inside_skip = 0;
1862 int i, alloc_opts, num_opts;
1864 dprint(FD_PARSE, "Parsing ini file %s\n", file);
1865 assert(td || !nested);
1870 if (!strcmp(file, "-")) {
1872 stdin_occupied = true;
1874 f = fopen(file, "r");
1879 log_err("fio: unable to open '%s' job file\n", file);
1881 td_verror(td, __err, "job file open");
1886 string = malloc(OPT_LEN_MAX);
1889 * it's really 256 + small bit, 280 should suffice
1893 memset(name, 0, 280);
1897 if (nested && popts) {
1899 alloc_opts = *aopts;
1905 opts = malloc(sizeof(char *) * alloc_opts);
1909 stonewall = stonewall_flag;
1912 * if skip_fgets is set, we already have loaded a line we
1917 p = strsep(&file, "\n");
1919 p = fgets(string, OPT_LEN_MAX, f);
1925 strip_blank_front(&p);
1928 dprint(FD_PARSE, "%s\n", p);
1929 if (is_empty_or_comment(p))
1933 if (sscanf(p, "[%255[^\n]]", name) != 1) {
1937 log_err("fio: option <%s> outside of "
1938 "[] job section\n", p);
1943 name[strlen(name) - 1] = '\0';
1945 if (skip_this_section(name)) {
1951 dprint(FD_PARSE, "Parsing section [%s]\n", name);
1953 global = !strncmp(name, "global", 6);
1959 log_info("--name=%s ", name);
1963 td = get_new_job(global, &def_thread, false, name);
1970 * Separate multiple job files by a stonewall
1972 if (!global && stonewall) {
1973 td->o.stonewall = stonewall;
1978 memset(opts, 0, alloc_opts * sizeof(char *));
1986 p = strsep(&file, "\n");
1988 p = fgets(string, OPT_LEN_MAX, f);
1991 dprint(FD_PARSE, "%s", p);
1996 if (is_empty_or_comment(p))
1999 strip_blank_front(&p);
2002 * new section, break out and make sure we don't
2003 * fgets() a new line at the top.
2007 log_err("No new sections in included files\n");
2018 if (!strncmp(p, "include", strlen("include"))) {
2019 char *filename = p + strlen("include") + 1,
2020 *ts, *full_fn = NULL;
2023 * Allow for the include filename
2024 * specification to be relative.
2026 if (access(filename, F_OK) &&
2027 (ts = strrchr(file, '/'))) {
2028 if (asprintf(&full_fn, "%.*s%s",
2029 (int)(ts - file + 1), file,
2037 ret = __parse_jobs_ini(td, filename, is_buf,
2038 stonewall_flag, type, 1,
2040 &alloc_opts, &num_opts);
2043 log_err("Error %d while parsing "
2044 "include file %s\n",
2057 if (num_opts == alloc_opts) {
2059 opts = realloc(opts,
2060 alloc_opts * sizeof(char *));
2063 opts[num_opts] = strdup(p);
2069 *aopts = alloc_opts;
2074 ret = fio_options_parse(td, opts, num_opts);
2076 if (!ret && td->o.read_iolog_file != NULL) {
2077 char *fname = get_name_by_idx(td->o.read_iolog_file,
2079 if (!strcmp(fname, "-")) {
2080 if (stdin_occupied) {
2081 log_err("fio: only one user (read_iolog_file/job "
2082 "file) of stdin is permitted at once but "
2083 "more than one was found.\n");
2086 stdin_occupied = true;
2093 ret = add_job(td, name, 0, 0, type);
2095 log_err("fio: job %s dropped\n", name);
2099 for (i = 0; i < num_opts; i++)
2108 while (i < nr_job_sections) {
2109 free(job_sections[i]);
2118 if (!is_buf && f != stdin)
2123 int parse_jobs_ini(char *file, int is_buf, int stonewall_flag, int type)
2125 return __parse_jobs_ini(NULL, file, is_buf, stonewall_flag, type,
2126 0, NULL, NULL, NULL, NULL);
2129 static int fill_def_thread(void)
2131 memset(&def_thread, 0, sizeof(def_thread));
2132 INIT_FLIST_HEAD(&def_thread.opt_list);
2134 fio_getaffinity(getpid(), &def_thread.o.cpumask);
2135 def_thread.o.error_dump = 1;
2138 * fill default options
2140 fio_fill_default_options(&def_thread);
2144 static void show_debug_categories(void)
2146 #ifdef FIO_INC_DEBUG
2147 const struct debug_level *dl = &debug_levels[0];
2148 int curlen, first = 1;
2152 int has_next = (dl + 1)->name != NULL;
2154 if (first || curlen + strlen(dl->name) >= 80) {
2159 curlen += printf("\t\t\t%s", dl->name);
2160 curlen += 3 * (8 - 1);
2162 curlen += printf(",");
2164 curlen += printf("%s", dl->name);
2166 curlen += printf(",");
2176 * Following options aren't printed by usage().
2177 * --append-terse - Equivalent to --output-format=terse, see f6a7df53.
2178 * --latency-log - Deprecated option.
2180 static void usage(const char *name)
2182 printf("%s\n", fio_version_string);
2183 printf("%s [options] [job options] <job file(s)>\n", name);
2184 printf(" --debug=options\tEnable debug logging. May be one/more of:\n");
2185 show_debug_categories();
2186 printf(" --parse-only\t\tParse options only, don't start any IO\n");
2187 printf(" --merge-blktrace-only\tMerge blktraces only, don't start any IO\n");
2188 printf(" --output\t\tWrite output to file\n");
2189 printf(" --bandwidth-log\tGenerate aggregate bandwidth logs\n");
2190 printf(" --minimal\t\tMinimal (terse) output\n");
2191 printf(" --output-format=type\tOutput format (terse,json,json+,normal)\n");
2192 printf(" --terse-version=type\tSet terse version output format"
2193 " (default 3, or 2 or 4)\n");
2194 printf(" --version\t\tPrint version info and exit\n");
2195 printf(" --help\t\tPrint this page\n");
2196 printf(" --cpuclock-test\tPerform test/validation of CPU clock\n");
2197 printf(" --crctest=[type]\tTest speed of checksum functions\n");
2198 printf(" --cmdhelp=cmd\t\tPrint command help, \"all\" for all of"
2200 printf(" --enghelp=engine\tPrint ioengine help, or list"
2201 " available ioengines\n");
2202 printf(" --enghelp=engine,cmd\tPrint help for an ioengine"
2204 printf(" --showcmd\t\tTurn a job file into command line options\n");
2205 printf(" --eta=when\t\tWhen ETA estimate should be printed\n");
2206 printf(" \t\tMay be \"always\", \"never\" or \"auto\"\n");
2207 printf(" --eta-newline=t\tForce a new line for every 't'");
2208 printf(" period passed\n");
2209 printf(" --status-interval=t\tForce full status dump every");
2210 printf(" 't' period passed\n");
2211 printf(" --readonly\t\tTurn on safety read-only checks, preventing"
2213 printf(" --section=name\tOnly run specified section in job file,"
2214 " multiple sections can be specified\n");
2215 printf(" --alloc-size=kb\tSet smalloc pool to this size in kb"
2217 printf(" --warnings-fatal\tFio parser warnings are fatal\n");
2218 printf(" --max-jobs=nr\t\tMaximum number of threads/processes to support\n");
2219 printf(" --server=args\t\tStart a backend fio server\n");
2220 printf(" --daemonize=pidfile\tBackground fio server, write pid to file\n");
2221 printf(" --client=hostname\tTalk to remote backend(s) fio server at hostname\n");
2222 printf(" --remote-config=file\tTell fio server to load this local job file\n");
2223 printf(" --idle-prof=option\tReport cpu idleness on a system or percpu basis\n"
2224 "\t\t\t(option=system,percpu) or run unit work\n"
2225 "\t\t\tcalibration only (option=calibrate)\n");
2227 printf(" --inflate-log=log\tInflate and output compressed log\n");
2229 printf(" --trigger-file=file\tExecute trigger cmd when file exists\n");
2230 printf(" --trigger-timeout=t\tExecute trigger at this time\n");
2231 printf(" --trigger=cmd\t\tSet this command as local trigger\n");
2232 printf(" --trigger-remote=cmd\tSet this command as remote trigger\n");
2233 printf(" --aux-path=path\tUse this path for fio state generated files\n");
2234 printf("\nFio was written by Jens Axboe <axboe@kernel.dk>\n");
2237 #ifdef FIO_INC_DEBUG
2238 const struct debug_level debug_levels[] = {
2239 { .name = "process",
2240 .help = "Process creation/exit logging",
2241 .shift = FD_PROCESS,
2244 .help = "File related action logging",
2248 .help = "IO and IO engine action logging (offsets, queue, completions, etc)",
2252 .help = "Memory allocation/freeing logging",
2255 { .name = "blktrace",
2256 .help = "blktrace action logging",
2257 .shift = FD_BLKTRACE,
2260 .help = "IO verification action logging",
2264 .help = "Random generation logging",
2268 .help = "Parser logging",
2271 { .name = "diskutil",
2272 .help = "Disk utility logging actions",
2273 .shift = FD_DISKUTIL,
2276 .help = "Logging related to creating/destroying jobs",
2280 .help = "Mutex logging",
2283 { .name = "profile",
2284 .help = "Logging related to profiles",
2285 .shift = FD_PROFILE,
2288 .help = "Logging related to time keeping functions",
2292 .help = "Network logging",
2296 .help = "Rate logging",
2299 { .name = "compress",
2300 .help = "Log compression logging",
2301 .shift = FD_COMPRESS,
2303 { .name = "steadystate",
2304 .help = "Steady state detection logging",
2305 .shift = FD_STEADYSTATE,
2307 { .name = "helperthread",
2308 .help = "Helper thread logging",
2309 .shift = FD_HELPERTHREAD,
2312 .help = "Zoned Block Device logging",
2318 static int set_debug(const char *string)
2320 const struct debug_level *dl;
2321 char *p = (char *) string;
2328 if (!strcmp(string, "?") || !strcmp(string, "help")) {
2329 log_info("fio: dumping debug options:");
2330 for (i = 0; debug_levels[i].name; i++) {
2331 dl = &debug_levels[i];
2332 log_info("%s,", dl->name);
2338 while ((opt = strsep(&p, ",")) != NULL) {
2341 if (!strncmp(opt, "all", 3)) {
2342 log_info("fio: set all debug options\n");
2347 for (i = 0; debug_levels[i].name; i++) {
2348 dl = &debug_levels[i];
2349 found = !strncmp(opt, dl->name, strlen(dl->name));
2353 if (dl->shift == FD_JOB) {
2354 opt = strchr(opt, ':');
2356 log_err("fio: missing job number\n");
2360 fio_debug_jobno = atoi(opt);
2361 log_info("fio: set debug jobno %d\n",
2364 log_info("fio: set debug option %s\n", opt);
2365 fio_debug |= (1UL << dl->shift);
2371 log_err("fio: debug mask %s not found\n", opt);
2376 static int set_debug(const char *string)
2378 log_err("fio: debug tracing not included in build\n");
2383 static void fio_options_fill_optstring(void)
2385 char *ostr = cmd_optstr;
2389 while (l_opts[i].name) {
2390 ostr[c++] = l_opts[i].val;
2391 if (l_opts[i].has_arg == required_argument)
2393 else if (l_opts[i].has_arg == optional_argument) {
2402 static int client_flag_set(char c)
2407 while (l_opts[i].name) {
2408 int val = l_opts[i].val;
2410 if (c == (val & 0xff))
2411 return (val & FIO_CLIENT_FLAG);
2419 static void parse_cmd_client(void *client, char *opt)
2421 fio_client_add_cmd_option(client, opt);
2424 static void show_closest_option(const char *name)
2426 int best_option, best_distance;
2429 while (*name == '-')
2433 best_distance = INT_MAX;
2435 while (l_opts[i].name) {
2436 distance = string_distance(name, l_opts[i].name);
2437 if (distance < best_distance) {
2438 best_distance = distance;
2444 if (best_option != -1 && string_distance_ok(name, best_distance))
2445 log_err("Did you mean %s?\n", l_opts[best_option].name);
2448 static int parse_output_format(const char *optarg)
2450 char *p, *orig, *opt;
2453 p = orig = strdup(optarg);
2457 while ((opt = strsep(&p, ",")) != NULL) {
2458 if (!strcmp(opt, "minimal") ||
2459 !strcmp(opt, "terse") ||
2460 !strcmp(opt, "csv"))
2461 output_format |= FIO_OUTPUT_TERSE;
2462 else if (!strcmp(opt, "json"))
2463 output_format |= FIO_OUTPUT_JSON;
2464 else if (!strcmp(opt, "json+"))
2465 output_format |= (FIO_OUTPUT_JSON | FIO_OUTPUT_JSON_PLUS);
2466 else if (!strcmp(opt, "normal"))
2467 output_format |= FIO_OUTPUT_NORMAL;
2469 log_err("fio: invalid output format %s\n", opt);
2479 int parse_cmd_line(int argc, char *argv[], int client_type)
2481 struct thread_data *td = NULL;
2482 int c, ini_idx = 0, lidx, ret = 0, do_exit = 0, exit_val = 0;
2483 char *ostr = cmd_optstr;
2484 char *pid_file = NULL;
2485 void *cur_client = NULL;
2486 bool backend = false;
2489 * Reset optind handling, since we may call this multiple times
2494 while ((c = getopt_long_only(argc, argv, ostr, l_opts, &lidx)) != -1) {
2495 if ((c & FIO_CLIENT_FLAG) || client_flag_set(c)) {
2496 parse_cmd_client(cur_client, argv[optind - 1]);
2497 c &= ~FIO_CLIENT_FLAG;
2502 smalloc_pool_size = atoi(optarg);
2503 smalloc_pool_size <<= 10;
2507 log_err("fio: --latency-log is deprecated. Use per-job latency log options.\n");
2512 write_bw_log = true;
2517 if (f_out && f_out != stdout)
2520 tmp = fopen(optarg, "w+");
2522 log_err("fio: output file open error: %s\n", strerror(errno));
2527 f_err = f_out = tmp;
2531 output_format = FIO_OUTPUT_TERSE;
2534 if (parse_output_format(optarg)) {
2535 log_err("fio: failed parsing output-format\n");
2542 output_format |= FIO_OUTPUT_TERSE;
2554 fio_show_option_help(optarg);
2561 exit_val = fio_show_ioengine_help(optarg);
2567 dump_cmdline = true;
2575 log_info("%s\n", fio_version_string);
2580 terse_version = atoi(optarg);
2581 if (!(terse_version >= 2 && terse_version <= 5)) {
2582 log_err("fio: bad terse version format\n");
2588 if (!strcmp("always", optarg))
2589 eta_print = FIO_ETA_ALWAYS;
2590 else if (!strcmp("never", optarg))
2591 eta_print = FIO_ETA_NEVER;
2596 if (check_str_time(optarg, &t, 1)) {
2597 log_err("fio: failed parsing eta time %s\n", optarg);
2602 eta_new_line = t / 1000;
2603 if (!eta_new_line) {
2604 log_err("fio: eta new line time too short\n");
2613 if (check_str_time(optarg, &t, 1)) {
2614 log_err("fio: failed parsing eta interval %s\n", optarg);
2619 eta_interval_msec = t / 1000;
2620 if (eta_interval_msec < DISK_UTIL_MSEC) {
2621 log_err("fio: eta interval time too short (%umsec min)\n", DISK_UTIL_MSEC);
2628 if (set_debug(optarg))
2638 if (!strcmp(optarg, "global")) {
2639 log_err("fio: can't use global as only "
2645 new_size = (nr_job_sections + 1) * sizeof(char *);
2646 job_sections = realloc(job_sections, new_size);
2647 job_sections[nr_job_sections] = strdup(optarg);
2653 exit_val = iolog_file_inflate(optarg);
2662 exec_profile = strdup(optarg);
2664 case FIO_GETOPT_JOB: {
2665 const char *opt = l_opts[lidx].name;
2668 if (!strncmp(opt, "name", 4) && td) {
2669 ret = add_job(td, td->o.name ?: "fio", 0, 0, client_type);
2676 int is_section = !strncmp(opt, "name", 4);
2679 if (!is_section || !strncmp(val, "global", 6))
2682 if (is_section && skip_this_section(val))
2685 td = get_new_job(global, &def_thread, true, NULL);
2686 if (!td || ioengine_load(td)) {
2695 fio_options_set_ioengine_opts(l_opts, td);
2698 if ((!val || !strlen(val)) &&
2699 l_opts[lidx].has_arg == required_argument) {
2700 log_err("fio: option %s requires an argument\n", opt);
2703 ret = fio_cmd_option_parse(td, opt, val);
2714 if (!ret && !strcmp(opt, "ioengine")) {
2715 if (ioengine_load(td)) {
2722 fio_options_set_ioengine_opts(l_opts, td);
2726 case FIO_GETOPT_IOENGINE: {
2727 const char *opt = l_opts[lidx].name;
2733 ret = fio_cmd_ioengine_option_parse(td, opt, val);
2740 /* we don't track/need this anymore, ignore it */
2744 #ifndef CONFIG_NO_SHM
2746 log_err("fio: can't be both client and server\n");
2752 fio_server_set_arg(optarg);
2756 log_err("fio: client/server requires SHM support\n");
2764 pid_file = strdup(optarg);
2767 if ((ret = fio_idle_prof_parse_opt(optarg))) {
2768 /* exit on error and calibration only */
2778 log_err("fio: can't be both client and server\n");
2783 /* if --client parameter contains a pathname */
2784 if (0 == access(optarg, R_OK)) {
2785 /* file contains a list of host addrs or names */
2786 char hostaddr[PATH_MAX] = {0};
2788 FILE * hostf = fopen(optarg, "r");
2790 log_err("fio: could not open client list file %s for read\n", optarg);
2795 sprintf(formatstr, "%%%ds", PATH_MAX - 1);
2797 * read at most PATH_MAX-1 chars from each
2798 * record in this file
2800 while (fscanf(hostf, formatstr, hostaddr) == 1) {
2801 /* expect EVERY host in file to be valid */
2802 if (fio_client_add(&fio_client_ops, hostaddr, &cur_client)) {
2803 log_err("fio: failed adding client %s from file %s\n", hostaddr, optarg);
2810 break; /* no possibility of job file for "this client only" */
2812 if (fio_client_add(&fio_client_ops, optarg, &cur_client)) {
2813 log_err("fio: failed adding client %s\n", optarg);
2819 * If the next argument exists and isn't an option,
2820 * assume it's a job file for this client only.
2822 while (optind < argc) {
2823 if (!strncmp(argv[optind], "--", 2) ||
2824 !strncmp(argv[optind], "-", 1))
2827 if (fio_client_add_ini_file(cur_client, argv[optind], false))
2834 if (fio_client_add_ini_file(cur_client, optarg, true)) {
2842 exit_val = fio_monotonic_clocktest(1);
2847 exit_val = fio_crctest(optarg);
2852 exit_val = fio_memcpy_test(optarg);
2857 if (check_str_time(optarg, &val, 1)) {
2858 log_err("fio: failed parsing time %s\n", optarg);
2864 log_err("fio: status interval too small\n");
2868 status_interval = val / 1000;
2874 trigger_file = strdup(optarg);
2879 trigger_cmd = strdup(optarg);
2882 if (trigger_remote_cmd)
2883 free(trigger_remote_cmd);
2884 trigger_remote_cmd = strdup(optarg);
2889 aux_path = strdup(optarg);
2892 if (check_str_time(optarg, &trigger_timeout, 1)) {
2893 log_err("fio: failed parsing time %s\n", optarg);
2897 trigger_timeout /= 1000000;
2902 merge_blktrace_only = true;
2905 log_err("%s: unrecognized option '%s'\n", argv[0],
2907 show_closest_option(argv[optind - 1]);
2918 if (do_exit && !(is_backend || nr_clients))
2921 if (nr_clients && fio_clients_connect())
2924 if (is_backend && backend)
2925 return fio_start_server(pid_file);
2931 ret = add_job(td, td->o.name ?: "fio", 0, 0, client_type);
2937 while (!ret && optind < argc) {
2939 ini_file = realloc(ini_file, ini_idx * sizeof(char *));
2940 ini_file[ini_idx - 1] = strdup(argv[optind]);
2948 int fio_init_options(void)
2953 fio_options_fill_optstring();
2954 fio_options_dup_and_init(l_opts);
2958 if (fill_def_thread())
2964 extern int fio_check_options(struct thread_options *);
2966 int parse_options(int argc, char *argv[])
2968 const int type = FIO_CLIENT_TYPE_CLI;
2971 if (fio_init_options())
2973 if (fio_test_cconv(&def_thread.o))
2974 log_err("fio: failed internal cconv test\n");
2976 job_files = parse_cmd_line(argc, argv, type);
2978 if (job_files > 0) {
2979 for (i = 0; i < job_files; i++) {
2980 if (i && fill_def_thread())
2983 if (fio_clients_send_ini(ini_file[i]))
2986 } else if (!is_backend) {
2987 if (parse_jobs_ini(ini_file[i], 0, i, type))
2992 } else if (nr_clients) {
2993 if (fill_def_thread())
2995 if (fio_clients_send_ini(NULL))
3000 fio_options_free(&def_thread);
3001 filesetup_mem_free();
3003 if (!thread_number) {
3008 if (is_backend || nr_clients)
3013 log_err("No job(s) defined\n\n");
3018 if (output_format & FIO_OUTPUT_NORMAL)
3019 log_info("%s\n", fio_version_string);
3024 void options_default_fill(struct thread_options *o)
3026 memcpy(o, &def_thread.o, sizeof(*o));
3029 struct thread_data *get_global_options(void)