2 * This file contains job initialization and setup functions.
14 #include <sys/types.h>
23 static char fio_version_string[] = "fio 1.34";
25 #define FIO_RANDSEED (0xb1899bedUL)
27 static char **ini_file;
28 static int max_jobs = MAX_JOBS;
29 static int dump_cmdline;
31 static struct thread_data def_thread;
32 struct thread_data *threads = NULL;
34 int exitall_on_terminate = 0;
37 unsigned long long mlock_size = 0;
40 char *job_section = NULL;
45 static int def_timeout;
46 static int write_lat_log;
48 static int prev_group_jobs;
50 unsigned long fio_debug = 0;
51 unsigned int fio_debug_jobno = -1;
52 unsigned int *fio_debug_jobp = NULL;
55 * Command line options. These will contain the above, plus a few
56 * extra that only pertain to fio itself and not jobs.
58 static struct option l_opts[FIO_NR_OPTIONS] = {
61 .has_arg = required_argument,
66 .has_arg = required_argument,
70 .name = "latency-log",
71 .has_arg = required_argument,
75 .name = "bandwidth-log",
76 .has_arg = required_argument,
81 .has_arg = optional_argument,
86 .has_arg = no_argument,
91 .has_arg = no_argument,
96 .has_arg = optional_argument,
101 .has_arg = no_argument,
106 .has_arg = no_argument,
111 .has_arg = required_argument,
116 .has_arg = required_argument,
121 .has_arg = required_argument,
125 .name = "alloc-size",
126 .has_arg = required_argument,
145 * Return a free job structure.
147 static struct thread_data *get_new_job(int global, struct thread_data *parent)
149 struct thread_data *td;
153 if (thread_number >= max_jobs)
156 td = &threads[thread_number++];
159 dup_files(td, parent);
160 options_mem_dupe(td);
162 td->thread_number = thread_number;
166 static void put_job(struct thread_data *td)
168 if (td == &def_thread)
172 log_info("fio: %s\n", td->verror);
174 memset(&threads[td->thread_number - 1], 0, sizeof(*td));
178 static int __setup_rate(struct thread_data *td, enum fio_ddir ddir)
180 unsigned int bs = td->o.min_bs[ddir];
181 unsigned long long rate;
182 unsigned long ios_per_msec;
184 if (td->o.rate[ddir]) {
185 rate = td->o.rate[ddir];
186 ios_per_msec = (rate * 1000LL) / bs;
188 ios_per_msec = td->o.rate_iops[ddir] * 1000UL;
191 log_err("rate lower than supported\n");
195 td->rate_usec_cycle[ddir] = 1000000000ULL / ios_per_msec;
196 td->rate_pending_usleep[ddir] = 0;
200 static int setup_rate(struct thread_data *td)
204 if (td->o.rate[DDIR_READ] || td->o.rate_iops[DDIR_READ])
205 ret = __setup_rate(td, DDIR_READ);
206 if (td->o.rate[DDIR_WRITE] || td->o.rate_iops[DDIR_WRITE])
207 ret |= __setup_rate(td, DDIR_WRITE);
212 static int fixed_block_size(struct thread_options *o)
214 return o->min_bs[DDIR_READ] == o->max_bs[DDIR_READ] &&
215 o->min_bs[DDIR_WRITE] == o->max_bs[DDIR_WRITE] &&
216 o->min_bs[DDIR_READ] == o->min_bs[DDIR_WRITE];
220 * Lazy way of fixing up options that depend on each other. We could also
221 * define option callback handlers, but this is easier.
223 static int fixup_options(struct thread_data *td)
225 struct thread_options *o = &td->o;
227 #ifndef FIO_HAVE_PSHARED_MUTEX
228 if (!td->o.use_thread) {
229 log_info("fio: this platform does not support process shared"
230 " mutexes, forcing use of threads. Use the 'thread'"
231 " option to get rid of this warning.\n");
232 td->o.use_thread = 1;
236 if (o->write_iolog_file && o->read_iolog_file) {
237 log_err("fio: read iolog overrides write_iolog\n");
238 free(o->write_iolog_file);
239 o->write_iolog_file = NULL;
243 * only really works for sequential io for now, and with 1 file
245 if (o->zone_size && td_random(td) && o->open_files == 1)
249 * Reads can do overwrites, we always need to pre-create the file
251 if (td_read(td) || td_rw(td))
254 if (!o->min_bs[DDIR_READ])
255 o->min_bs[DDIR_READ] = o->bs[DDIR_READ];
256 if (!o->max_bs[DDIR_READ])
257 o->max_bs[DDIR_READ] = o->bs[DDIR_READ];
258 if (!o->min_bs[DDIR_WRITE])
259 o->min_bs[DDIR_WRITE] = o->bs[DDIR_WRITE];
260 if (!o->max_bs[DDIR_WRITE])
261 o->max_bs[DDIR_WRITE] = o->bs[DDIR_WRITE];
263 o->rw_min_bs = min(o->min_bs[DDIR_READ], o->min_bs[DDIR_WRITE]);
266 * For random IO, allow blockalign offset other than min_bs.
268 if (!o->ba[DDIR_READ] || !td_random(td))
269 o->ba[DDIR_READ] = o->min_bs[DDIR_READ];
270 if (!o->ba[DDIR_WRITE] || !td_random(td))
271 o->ba[DDIR_WRITE] = o->min_bs[DDIR_WRITE];
273 if ((o->ba[DDIR_READ] != o->min_bs[DDIR_READ] ||
274 o->ba[DDIR_WRITE] != o->min_bs[DDIR_WRITE]) &&
275 !td->o.norandommap) {
276 log_err("fio: Any use of blockalign= turns off randommap\n");
277 td->o.norandommap = 1;
280 if (!o->file_size_high)
281 o->file_size_high = o->file_size_low;
283 if (o->norandommap && o->verify != VERIFY_NONE
284 && !fixed_block_size(o)) {
285 log_err("fio: norandommap given for variable block sizes, "
286 "verify disabled\n");
287 o->verify = VERIFY_NONE;
289 if (o->bs_unaligned && (o->odirect || td->io_ops->flags & FIO_RAWIO))
290 log_err("fio: bs_unaligned may not work with raw io\n");
293 * thinktime_spin must be less than thinktime
295 if (o->thinktime_spin > o->thinktime)
296 o->thinktime_spin = o->thinktime;
299 * The low water mark cannot be bigger than the iodepth
301 if (o->iodepth_low > o->iodepth || !o->iodepth_low) {
303 * syslet work around - if the workload is sequential,
304 * we want to let the queue drain all the way down to
305 * avoid seeking between async threads
307 if (!strcmp(td->io_ops->name, "syslet-rw") && !td_random(td))
310 o->iodepth_low = o->iodepth;
314 * If batch number isn't set, default to the same as iodepth
316 if (o->iodepth_batch > o->iodepth || !o->iodepth_batch)
317 o->iodepth_batch = o->iodepth;
319 if (o->nr_files > td->files_index)
320 o->nr_files = td->files_index;
322 if (o->open_files > o->nr_files || !o->open_files)
323 o->open_files = o->nr_files;
325 if (((o->rate[0] + o->rate[1]) && (o->rate_iops[0] + o->rate_iops[1]))||
326 ((o->ratemin[0] + o->ratemin[1]) && (o->rate_iops_min[0] +
327 o->rate_iops_min[1]))) {
328 log_err("fio: rate and rate_iops are mutually exclusive\n");
331 if ((o->rate[0] < o->ratemin[0]) || (o->rate[1] < o->ratemin[1]) ||
332 (o->rate_iops[0] < o->rate_iops_min[0]) ||
333 (o->rate_iops[1] < o->rate_iops_min[1])) {
334 log_err("fio: minimum rate exceeds rate\n");
338 if (!o->timeout && o->time_based) {
339 log_err("fio: time_based requires a runtime/timeout setting\n");
343 if (o->fill_device && !o->size)
346 if (td_rw(td) && td->o.verify != VERIFY_NONE)
347 log_info("fio: mixed read/write workload with verify. May not "
348 "work as expected, unless you pre-populated the file\n");
350 if (td->o.verify != VERIFY_NONE)
351 td->o.refill_buffers = 1;
353 if (td->o.pre_read) {
354 td->o.invalidate_cache = 0;
355 if (td->io_ops->flags & FIO_PIPEIO)
356 log_info("fio: cannot pre-read files with an IO engine"
357 " that isn't seekable. Pre-read disabled.\n");
364 * This function leaks the buffer
366 static char *to_kmg(unsigned int val)
368 char *buf = malloc(32);
369 char post[] = { 0, 'K', 'M', 'G', 'P', 'E', 0 };
380 snprintf(buf, 31, "%u%c", val, *p);
384 /* External engines are specified by "external:name.o") */
385 static const char *get_engine_name(const char *str)
387 char *p = strstr(str, ":");
393 strip_blank_front(&p);
398 static int exists_and_not_file(const char *filename)
402 if (lstat(filename, &sb) == -1)
405 if (S_ISREG(sb.st_mode))
411 void td_fill_rand_seeds(struct thread_data *td)
413 os_random_seed(td->rand_seeds[0], &td->bsrange_state);
414 os_random_seed(td->rand_seeds[1], &td->verify_state);
415 os_random_seed(td->rand_seeds[2], &td->rwmix_state);
417 if (td->o.file_service_type == FIO_FSERVICE_RANDOM)
418 os_random_seed(td->rand_seeds[3], &td->next_file_state);
420 os_random_seed(td->rand_seeds[5], &td->file_size_state);
425 if (td->o.rand_repeatable)
426 td->rand_seeds[4] = FIO_RANDSEED * td->thread_number;
428 os_random_seed(td->rand_seeds[4], &td->random_state);
432 * Initialize the various random states we need (random io, block size ranges,
433 * read/write mix, etc).
435 static int init_random_state(struct thread_data *td)
439 fd = open("/dev/urandom", O_RDONLY);
441 td_verror(td, errno, "open");
445 if (read(fd, td->rand_seeds, sizeof(td->rand_seeds)) <
446 (int) sizeof(td->rand_seeds)) {
447 td_verror(td, EIO, "read");
453 td_fill_rand_seeds(td);
458 * Adds a job to the list of things todo. Sanitizes the various options
459 * to make sure we don't have conflicts, and initializes various
462 static int add_job(struct thread_data *td, const char *jobname, int job_add_num)
464 const char *ddir_str[] = { NULL, "read", "write", "rw", NULL,
465 "randread", "randwrite", "randrw" };
468 char fname[PATH_MAX];
469 int numjobs, file_alloced;
472 * the def_thread is just for options, it's not a real job
474 if (td == &def_thread)
478 * if we are just dumping the output command line, don't add the job
485 engine = get_engine_name(td->o.ioengine);
486 td->io_ops = load_ioengine(td, engine);
488 log_err("fio: failed to load engine %s\n", engine);
492 if (td->o.use_thread)
498 td->io_ops->flags |= FIO_RAWIO;
501 if (!td->o.filename && !td->files_index && !td->o.read_iolog_file) {
504 if (td->o.nr_files == 1 && exists_and_not_file(jobname))
505 add_file(td, jobname);
507 for (i = 0; i < td->o.nr_files; i++) {
508 sprintf(fname, "%s.%d.%d", jobname,
509 td->thread_number, i);
515 if (fixup_options(td))
518 if (td->io_ops->flags & FIO_DISKLESSIO) {
521 for_each_file(td, f, i)
522 f->real_file_size = -1ULL;
525 td->mutex = fio_mutex_init(0);
527 td->ts.clat_stat[0].min_val = td->ts.clat_stat[1].min_val = ULONG_MAX;
528 td->ts.slat_stat[0].min_val = td->ts.slat_stat[1].min_val = ULONG_MAX;
529 td->ts.bw_stat[0].min_val = td->ts.bw_stat[1].min_val = ULONG_MAX;
530 td->ddir_nr = td->o.ddir_nr;
532 if ((td->o.stonewall || td->o.new_group) && prev_group_jobs) {
537 td->groupid = groupid;
540 if (init_random_state(td))
546 if (td->o.write_lat_log) {
547 setup_log(&td->ts.slat_log);
548 setup_log(&td->ts.clat_log);
550 if (td->o.write_bw_log)
551 setup_log(&td->ts.bw_log);
554 td->o.name = strdup(jobname);
558 if (!strcmp(td->io_ops->name, "cpuio")) {
559 log_info("%s: ioengine=cpu, cpuload=%u,"
560 " cpucycle=%u\n", td->o.name,
564 char *c1, *c2, *c3, *c4;
566 c1 = to_kmg(td->o.min_bs[DDIR_READ]);
567 c2 = to_kmg(td->o.max_bs[DDIR_READ]);
568 c3 = to_kmg(td->o.min_bs[DDIR_WRITE]);
569 c4 = to_kmg(td->o.max_bs[DDIR_WRITE]);
571 log_info("%s: (g=%d): rw=%s, bs=%s-%s/%s-%s,"
572 " ioengine=%s, iodepth=%u\n",
573 td->o.name, td->groupid,
574 ddir_str[td->o.td_ddir],
584 } else if (job_add_num == 1)
589 * recurse add identical jobs, clear numjobs and stonewall options
590 * as they don't apply to sub-jobs
592 numjobs = td->o.numjobs;
594 struct thread_data *td_new = get_new_job(0, td);
599 td_new->o.numjobs = 1;
600 td_new->o.stonewall = 0;
601 td_new->o.new_group = 0;
604 td_new->o.filename = NULL;
605 td_new->files_index = 0;
606 td_new->files_size = 0;
607 td_new->files = NULL;
610 job_add_num = numjobs - 1;
612 if (add_job(td_new, jobname, job_add_num))
622 static int skip_this_section(const char *name)
626 if (!strncmp(name, "global", 6))
629 return strcmp(job_section, name);
632 static int is_empty_or_comment(char *line)
636 for (i = 0; i < strlen(line); i++) {
641 if (!isspace(line[i]) && !iscntrl(line[i]))
649 * This is our [ini] type file parser.
651 static int parse_jobs_ini(char *file, int stonewall_flag)
654 struct thread_data *td;
658 int ret = 0, stonewall;
663 int i, alloc_opts, num_opts;
665 if (!strcmp(file, "-"))
668 f = fopen(file, "r");
671 perror("fopen job file");
675 string = malloc(4096);
678 * it's really 256 + small bit, 280 should suffice
681 memset(name, 0, 280);
684 opts = malloc(sizeof(char *) * alloc_opts);
687 stonewall = stonewall_flag;
690 * if skip_fgets is set, we already have loaded a line we
694 p = fgets(string, 4095, f);
700 strip_blank_front(&p);
703 if (is_empty_or_comment(p))
705 if (sscanf(p, "[%255s]", name) != 1) {
708 log_err("fio: option <%s> outside of [] job section\n",
713 if (skip_this_section(name)) {
719 global = !strncmp(name, "global", 6);
721 name[strlen(name) - 1] = '\0';
727 log_info("--name=%s ", name);
731 td = get_new_job(global, &def_thread);
738 * Seperate multiple job files by a stonewall
740 if (!global && stonewall) {
741 td->o.stonewall = stonewall;
746 memset(opts, 0, alloc_opts * sizeof(char *));
748 while ((p = fgets(string, 4096, f)) != NULL) {
749 if (is_empty_or_comment(p))
752 strip_blank_front(&p);
755 * new section, break out and make sure we don't
756 * fgets() a new line at the top.
765 if (num_opts == alloc_opts) {
768 alloc_opts * sizeof(char *));
771 opts[num_opts] = strdup(p);
775 ret = fio_options_parse(td, opts, num_opts);
778 for (i = 0; i < num_opts; i++)
779 log_info("--%s ", opts[i]);
781 ret = add_job(td, name, 0);
783 log_err("fio: job %s dropped\n", name);
787 for (i = 0; i < num_opts; i++)
795 for (i = 0; i < num_opts; i++)
806 static int fill_def_thread(void)
808 memset(&def_thread, 0, sizeof(def_thread));
810 fio_getaffinity(getpid(), &def_thread.o.cpumask);
813 * fill default options
815 fio_fill_default_options(&def_thread);
817 def_thread.o.timeout = def_timeout;
818 def_thread.o.write_bw_log = write_bw_log;
819 def_thread.o.write_lat_log = write_lat_log;
824 static void free_shm(void)
826 struct shmid_ds sbuf;
833 fio_debug_jobp = NULL;
835 shmctl(shm_id, IPC_RMID, &sbuf);
842 * The thread area is shared between the main process and the job
843 * threads/processes. So setup a shared memory segment that will hold
844 * all the job info. We use the end of the region for keeping track of
845 * open files across jobs, for file sharing.
847 static int setup_thread_area(void)
852 * 1024 is too much on some machines, scale max_jobs if
853 * we get a failure that looks like too large a shm segment
856 size_t size = max_jobs * sizeof(struct thread_data);
858 size += file_hash_size;
859 size += sizeof(unsigned int);
861 shm_id = shmget(0, size, IPC_CREAT | 0600);
864 if (errno != EINVAL) {
875 threads = shmat(shm_id, NULL, 0);
876 if (threads == (void *) -1) {
881 memset(threads, 0, max_jobs * sizeof(struct thread_data));
882 hash = (void *) threads + max_jobs * sizeof(struct thread_data);
883 fio_debug_jobp = (void *) hash + file_hash_size;
884 *fio_debug_jobp = -1;
885 file_hash_init(hash);
890 static void usage(const char *name)
892 printf("%s\n", fio_version_string);
893 printf("%s [options] [job options] <job file(s)>\n", name);
894 printf("\t--debug=options\tEnable debug logging\n");
895 printf("\t--output\tWrite output to file\n");
896 printf("\t--timeout\tRuntime in seconds\n");
897 printf("\t--latency-log\tGenerate per-job latency logs\n");
898 printf("\t--bandwidth-log\tGenerate per-job bandwidth logs\n");
899 printf("\t--minimal\tMinimal (terse) output\n");
900 printf("\t--version\tPrint version info and exit\n");
901 printf("\t--help\t\tPrint this page\n");
902 printf("\t--cmdhelp=cmd\tPrint command help, \"all\" for all of"
904 printf("\t--showcmd\tTurn a job file into command line options\n");
905 printf("\t--eta=when\tWhen ETA estimate should be printed\n");
906 printf("\t \tMay be \"always\", \"never\" or \"auto\"\n");
907 printf("\t--readonly\tTurn on safety read-only checks, preventing"
909 printf("\t--section=name\tOnly run specified section in job file\n");
910 printf("\t--alloc-size=kb\tSet smalloc pool to this size in kb"
912 printf("\nFio was written by Jens Axboe <jens.axboe@oracle.com>\n");
916 struct debug_level debug_levels[] = {
917 { .name = "process", .shift = FD_PROCESS, },
918 { .name = "file", .shift = FD_FILE, },
919 { .name = "io", .shift = FD_IO, },
920 { .name = "mem", .shift = FD_MEM, },
921 { .name = "blktrace", .shift = FD_BLKTRACE },
922 { .name = "verify", .shift = FD_VERIFY },
923 { .name = "random", .shift = FD_RANDOM },
924 { .name = "parse", .shift = FD_PARSE },
925 { .name = "diskutil", .shift = FD_DISKUTIL },
926 { .name = "job", .shift = FD_JOB },
927 { .name = "mutex", .shift = FD_MUTEX },
931 static int set_debug(const char *string)
933 struct debug_level *dl;
934 char *p = (char *) string;
938 if (!strcmp(string, "?") || !strcmp(string, "help")) {
941 log_info("fio: dumping debug options:");
942 for (i = 0; debug_levels[i].name; i++) {
943 dl = &debug_levels[i];
944 log_info("%s,", dl->name);
950 while ((opt = strsep(&p, ",")) != NULL) {
953 if (!strncmp(opt, "all", 3)) {
954 log_info("fio: set all debug options\n");
959 for (i = 0; debug_levels[i].name; i++) {
960 dl = &debug_levels[i];
961 found = !strncmp(opt, dl->name, strlen(dl->name));
965 if (dl->shift == FD_JOB) {
966 opt = strchr(opt, ':');
968 log_err("fio: missing job number\n");
972 fio_debug_jobno = atoi(opt);
973 log_info("fio: set debug jobno %d\n",
976 log_info("fio: set debug option %s\n", opt);
977 fio_debug |= (1UL << dl->shift);
983 log_err("fio: debug mask %s not found\n", opt);
988 static int set_debug(const char *string)
990 log_err("fio: debug tracing not included in build\n");
995 static int parse_cmd_line(int argc, char *argv[])
997 struct thread_data *td = NULL;
998 int c, ini_idx = 0, lidx, ret = 0, do_exit = 0, exit_val = 0;
1000 while ((c = getopt_long_only(argc, argv, "", l_opts, &lidx)) != -1) {
1003 smalloc_pool_size = atoi(optarg);
1006 def_timeout = atoi(optarg);
1015 f_out = fopen(optarg, "w+");
1017 perror("fopen output");
1029 exit(fio_show_option_help(optarg));
1037 printf("%s\n", fio_version_string);
1040 if (!strcmp("always", optarg))
1041 eta_print = FIO_ETA_ALWAYS;
1042 else if (!strcmp("never", optarg))
1043 eta_print = FIO_ETA_NEVER;
1046 if (set_debug(optarg))
1050 if (!strcmp(optarg, "global")) {
1051 log_err("fio: can't use global as only "
1059 job_section = strdup(optarg);
1061 case FIO_GETOPT_JOB: {
1062 const char *opt = l_opts[lidx].name;
1065 if (!strncmp(opt, "name", 4) && td) {
1066 ret = add_job(td, td->o.name ?: "fio", 0);
1074 int is_section = !strncmp(opt, "name", 4);
1077 if (!is_section || !strncmp(val, "global", 6))
1080 if (is_section && skip_this_section(val))
1083 td = get_new_job(global, &def_thread);
1088 ret = fio_cmd_option_parse(td, opt, val);
1103 ret = add_job(td, td->o.name ?: "fio", 0);
1108 while (optind < argc) {
1110 ini_file = realloc(ini_file, ini_idx * sizeof(char *));
1111 ini_file[ini_idx - 1] = strdup(argv[optind]);
1118 int parse_options(int argc, char *argv[])
1125 fio_options_dup_and_init(l_opts);
1127 if (setup_thread_area())
1129 if (fill_def_thread())
1132 job_files = parse_cmd_line(argc, argv);
1134 for (i = 0; i < job_files; i++) {
1135 if (fill_def_thread())
1137 if (parse_jobs_ini(ini_file[i], i))
1143 options_mem_free(&def_thread);
1145 if (!thread_number) {
1149 log_err("No jobs defined(s)\n\n");
1154 if (def_thread.o.gtod_offload) {
1156 fio_gtod_offload = 1;
1157 fio_gtod_cpu = def_thread.o.gtod_cpu;