2 * This file contains job initialization and setup functions.
13 #include <sys/types.h>
23 #include "lib/getopt.h"
25 static char fio_version_string[] = "fio 1.43";
27 #define FIO_RANDSEED (0xb1899bedUL)
29 static char **ini_file;
30 static int max_jobs = MAX_JOBS;
31 static int dump_cmdline;
33 static struct thread_data def_thread;
34 struct thread_data *threads = NULL;
36 int exitall_on_terminate = 0;
39 unsigned long long mlock_size = 0;
42 char *job_section = NULL;
43 char *exec_profile = NULL;
48 static int def_timeout;
49 static int write_lat_log;
51 static int prev_group_jobs;
53 unsigned long fio_debug = 0;
54 unsigned int fio_debug_jobno = -1;
55 unsigned int *fio_debug_jobp = NULL;
58 * Command line options. These will contain the above, plus a few
59 * extra that only pertain to fio itself and not jobs.
61 static struct option l_opts[FIO_NR_OPTIONS] = {
64 .has_arg = required_argument,
69 .has_arg = required_argument,
73 .name = "latency-log",
74 .has_arg = required_argument,
78 .name = "bandwidth-log",
79 .has_arg = required_argument,
84 .has_arg = optional_argument,
89 .has_arg = no_argument,
94 .has_arg = no_argument,
99 .has_arg = optional_argument,
104 .has_arg = no_argument,
109 .has_arg = no_argument,
114 .has_arg = required_argument,
119 .has_arg = required_argument,
124 .has_arg = required_argument,
128 .name = "alloc-size",
129 .has_arg = required_argument,
134 .has_arg = required_argument,
153 * Return a free job structure.
155 static struct thread_data *get_new_job(int global, struct thread_data *parent)
157 struct thread_data *td;
161 if (thread_number >= max_jobs)
164 td = &threads[thread_number++];
167 td->o.uid = td->o.gid = -1U;
169 dup_files(td, parent);
170 options_mem_dupe(td);
172 profile_add_hooks(td);
174 td->thread_number = thread_number;
178 static void put_job(struct thread_data *td)
180 if (td == &def_thread)
186 log_info("fio: %s\n", td->verror);
188 memset(&threads[td->thread_number - 1], 0, sizeof(*td));
192 static int __setup_rate(struct thread_data *td, enum fio_ddir ddir)
194 unsigned int bs = td->o.min_bs[ddir];
195 unsigned long long bytes_per_sec;
197 if (td->o.rate[ddir])
198 bytes_per_sec = td->o.rate[ddir];
200 bytes_per_sec = td->o.rate_iops[ddir] * bs;
202 if (!bytes_per_sec) {
203 log_err("rate lower than supported\n");
207 td->rate_nsec_cycle[ddir] = 1000000000ULL / bytes_per_sec;
208 td->rate_pending_usleep[ddir] = 0;
212 static int setup_rate(struct thread_data *td)
216 if (td->o.rate[DDIR_READ] || td->o.rate_iops[DDIR_READ])
217 ret = __setup_rate(td, DDIR_READ);
218 if (td->o.rate[DDIR_WRITE] || td->o.rate_iops[DDIR_WRITE])
219 ret |= __setup_rate(td, DDIR_WRITE);
224 static int fixed_block_size(struct thread_options *o)
226 return o->min_bs[DDIR_READ] == o->max_bs[DDIR_READ] &&
227 o->min_bs[DDIR_WRITE] == o->max_bs[DDIR_WRITE] &&
228 o->min_bs[DDIR_READ] == o->min_bs[DDIR_WRITE];
232 * Lazy way of fixing up options that depend on each other. We could also
233 * define option callback handlers, but this is easier.
235 static int fixup_options(struct thread_data *td)
237 struct thread_options *o = &td->o;
239 #ifndef FIO_HAVE_PSHARED_MUTEX
240 if (!o->use_thread) {
241 log_info("fio: this platform does not support process shared"
242 " mutexes, forcing use of threads. Use the 'thread'"
243 " option to get rid of this warning.\n");
248 if (o->write_iolog_file && o->read_iolog_file) {
249 log_err("fio: read iolog overrides write_iolog\n");
250 free(o->write_iolog_file);
251 o->write_iolog_file = NULL;
255 * only really works for sequential io for now, and with 1 file
257 if (o->zone_size && td_random(td) && o->open_files == 1)
261 * Reads can do overwrites, we always need to pre-create the file
263 if (td_read(td) || td_rw(td))
266 if (!o->min_bs[DDIR_READ])
267 o->min_bs[DDIR_READ] = o->bs[DDIR_READ];
268 if (!o->max_bs[DDIR_READ])
269 o->max_bs[DDIR_READ] = o->bs[DDIR_READ];
270 if (!o->min_bs[DDIR_WRITE])
271 o->min_bs[DDIR_WRITE] = o->bs[DDIR_WRITE];
272 if (!o->max_bs[DDIR_WRITE])
273 o->max_bs[DDIR_WRITE] = o->bs[DDIR_WRITE];
275 o->rw_min_bs = min(o->min_bs[DDIR_READ], o->min_bs[DDIR_WRITE]);
278 * For random IO, allow blockalign offset other than min_bs.
280 if (!o->ba[DDIR_READ] || !td_random(td))
281 o->ba[DDIR_READ] = o->min_bs[DDIR_READ];
282 if (!o->ba[DDIR_WRITE] || !td_random(td))
283 o->ba[DDIR_WRITE] = o->min_bs[DDIR_WRITE];
285 if ((o->ba[DDIR_READ] != o->min_bs[DDIR_READ] ||
286 o->ba[DDIR_WRITE] != o->min_bs[DDIR_WRITE]) &&
288 log_err("fio: Any use of blockalign= turns off randommap\n");
292 if (!o->file_size_high)
293 o->file_size_high = o->file_size_low;
295 if (o->norandommap && o->verify != VERIFY_NONE
296 && !fixed_block_size(o)) {
297 log_err("fio: norandommap given for variable block sizes, "
298 "verify disabled\n");
299 o->verify = VERIFY_NONE;
301 if (o->bs_unaligned && (o->odirect || td->io_ops->flags & FIO_RAWIO))
302 log_err("fio: bs_unaligned may not work with raw io\n");
305 * thinktime_spin must be less than thinktime
307 if (o->thinktime_spin > o->thinktime)
308 o->thinktime_spin = o->thinktime;
311 * The low water mark cannot be bigger than the iodepth
313 if (o->iodepth_low > o->iodepth || !o->iodepth_low) {
315 * syslet work around - if the workload is sequential,
316 * we want to let the queue drain all the way down to
317 * avoid seeking between async threads
319 if (!strcmp(td->io_ops->name, "syslet-rw") && !td_random(td))
322 o->iodepth_low = o->iodepth;
326 * If batch number isn't set, default to the same as iodepth
328 if (o->iodepth_batch > o->iodepth || !o->iodepth_batch)
329 o->iodepth_batch = o->iodepth;
331 if (o->nr_files > td->files_index)
332 o->nr_files = td->files_index;
334 if (o->open_files > o->nr_files || !o->open_files)
335 o->open_files = o->nr_files;
337 if (((o->rate[0] + o->rate[1]) && (o->rate_iops[0] + o->rate_iops[1]))||
338 ((o->ratemin[0] + o->ratemin[1]) && (o->rate_iops_min[0] +
339 o->rate_iops_min[1]))) {
340 log_err("fio: rate and rate_iops are mutually exclusive\n");
343 if ((o->rate[0] < o->ratemin[0]) || (o->rate[1] < o->ratemin[1]) ||
344 (o->rate_iops[0] < o->rate_iops_min[0]) ||
345 (o->rate_iops[1] < o->rate_iops_min[1])) {
346 log_err("fio: minimum rate exceeds rate\n");
350 if (!o->timeout && o->time_based) {
351 log_err("fio: time_based requires a runtime/timeout setting\n");
355 if (o->fill_device && !o->size)
358 if (td_rw(td) && o->verify != VERIFY_NONE)
359 log_info("fio: mixed read/write workload with verify. May not "
360 "work as expected, unless you pre-populated the file\n");
362 if (o->verify != VERIFY_NONE) {
363 o->refill_buffers = 1;
364 if (o->max_bs[DDIR_WRITE] != o->min_bs[DDIR_WRITE] &&
366 o->verify_interval = o->min_bs[DDIR_WRITE];
370 o->invalidate_cache = 0;
371 if (td->io_ops->flags & FIO_PIPEIO)
372 log_info("fio: cannot pre-read files with an IO engine"
373 " that isn't seekable. Pre-read disabled.\n");
376 #ifndef FIO_HAVE_FDATASYNC
377 if (o->fdatasync_blocks) {
378 log_info("fio: this platform does not support fdatasync()"
379 " falling back to using fsync(). Use the 'fsync'"
380 " option instead of 'fdatasync' to get rid of"
382 o->fsync_blocks = o->fdatasync_blocks;
383 o->fdatasync_blocks = 0;
391 * This function leaks the buffer
393 static char *to_kmg(unsigned int val)
395 char *buf = malloc(32);
396 char post[] = { 0, 'K', 'M', 'G', 'P', 'E', 0 };
407 snprintf(buf, 31, "%u%c", val, *p);
411 /* External engines are specified by "external:name.o") */
412 static const char *get_engine_name(const char *str)
414 char *p = strstr(str, ":");
420 strip_blank_front(&p);
425 static int exists_and_not_file(const char *filename)
429 if (lstat(filename, &sb) == -1)
432 if (S_ISREG(sb.st_mode))
438 void td_fill_rand_seeds(struct thread_data *td)
440 os_random_seed(td->rand_seeds[0], &td->bsrange_state);
441 os_random_seed(td->rand_seeds[1], &td->verify_state);
442 os_random_seed(td->rand_seeds[2], &td->rwmix_state);
444 if (td->o.file_service_type == FIO_FSERVICE_RANDOM)
445 os_random_seed(td->rand_seeds[3], &td->next_file_state);
447 os_random_seed(td->rand_seeds[5], &td->file_size_state);
452 if (td->o.rand_repeatable)
453 td->rand_seeds[4] = FIO_RANDSEED * td->thread_number;
455 os_random_seed(td->rand_seeds[4], &td->random_state);
459 * Initialize the various random states we need (random io, block size ranges,
460 * read/write mix, etc).
462 static int init_random_state(struct thread_data *td)
466 fd = open("/dev/urandom", O_RDONLY);
468 td_verror(td, errno, "open");
472 if (read(fd, td->rand_seeds, sizeof(td->rand_seeds)) <
473 (int) sizeof(td->rand_seeds)) {
474 td_verror(td, EIO, "read");
480 td_fill_rand_seeds(td);
485 * Adds a job to the list of things todo. Sanitizes the various options
486 * to make sure we don't have conflicts, and initializes various
489 static int add_job(struct thread_data *td, const char *jobname, int job_add_num)
491 const char *ddir_str[] = { NULL, "read", "write", "rw", NULL,
492 "randread", "randwrite", "randrw" };
495 char fname[PATH_MAX];
496 int numjobs, file_alloced;
499 * the def_thread is just for options, it's not a real job
501 if (td == &def_thread)
505 * if we are just dumping the output command line, don't add the job
512 if (profile_td_init(td))
515 engine = get_engine_name(td->o.ioengine);
516 td->io_ops = load_ioengine(td, engine);
518 log_err("fio: failed to load engine %s\n", engine);
522 if (td->o.use_thread)
528 td->io_ops->flags |= FIO_RAWIO;
531 if (!td->o.filename && !td->files_index && !td->o.read_iolog_file) {
534 if (td->o.nr_files == 1 && exists_and_not_file(jobname))
535 add_file(td, jobname);
537 for (i = 0; i < td->o.nr_files; i++) {
538 sprintf(fname, "%s.%d.%d", jobname,
539 td->thread_number, i);
545 if (fixup_options(td))
548 if (td->io_ops->flags & FIO_DISKLESSIO) {
551 for_each_file(td, f, i)
552 f->real_file_size = -1ULL;
555 td->mutex = fio_mutex_init(0);
557 td->ts.clat_stat[0].min_val = td->ts.clat_stat[1].min_val = ULONG_MAX;
558 td->ts.slat_stat[0].min_val = td->ts.slat_stat[1].min_val = ULONG_MAX;
559 td->ts.lat_stat[0].min_val = td->ts.lat_stat[1].min_val = ULONG_MAX;
560 td->ts.bw_stat[0].min_val = td->ts.bw_stat[1].min_val = ULONG_MAX;
561 td->ddir_seq_nr = td->o.ddir_seq_nr + 1;
563 if ((td->o.stonewall || td->o.new_group) && prev_group_jobs) {
568 td->groupid = groupid;
571 if (init_random_state(td))
577 if (td->o.write_lat_log) {
578 setup_log(&td->ts.lat_log);
579 setup_log(&td->ts.slat_log);
580 setup_log(&td->ts.clat_log);
582 if (td->o.write_bw_log)
583 setup_log(&td->ts.bw_log);
586 td->o.name = strdup(jobname);
590 if (!strcmp(td->io_ops->name, "cpuio")) {
591 log_info("%s: ioengine=cpu, cpuload=%u,"
592 " cpucycle=%u\n", td->o.name,
596 char *c1, *c2, *c3, *c4;
598 c1 = to_kmg(td->o.min_bs[DDIR_READ]);
599 c2 = to_kmg(td->o.max_bs[DDIR_READ]);
600 c3 = to_kmg(td->o.min_bs[DDIR_WRITE]);
601 c4 = to_kmg(td->o.max_bs[DDIR_WRITE]);
603 log_info("%s: (g=%d): rw=%s, bs=%s-%s/%s-%s,"
604 " ioengine=%s, iodepth=%u\n",
605 td->o.name, td->groupid,
606 ddir_str[td->o.td_ddir],
616 } else if (job_add_num == 1)
621 * recurse add identical jobs, clear numjobs and stonewall options
622 * as they don't apply to sub-jobs
624 numjobs = td->o.numjobs;
626 struct thread_data *td_new = get_new_job(0, td);
631 td_new->o.numjobs = 1;
632 td_new->o.stonewall = 0;
633 td_new->o.new_group = 0;
636 td_new->o.filename = NULL;
637 td_new->files_index = 0;
638 td_new->files_size = 0;
639 td_new->files = NULL;
642 job_add_num = numjobs - 1;
644 if (add_job(td_new, jobname, job_add_num))
655 * Parse as if 'o' was a command line
657 void add_job_opts(const char **o)
659 struct thread_data *td, *td_parent;
660 int i, in_global = 1;
664 td_parent = td = NULL;
666 if (!strncmp(o[i], "name", 4)) {
669 add_job(td, jobname, 0);
671 sprintf(jobname, "%s", o[i] + 5);
673 if (in_global && !td_parent)
674 td_parent = get_new_job(1, &def_thread);
675 else if (!in_global && !td) {
677 td_parent = &def_thread;
678 td = get_new_job(0, td_parent);
681 fio_options_parse(td_parent, (char **) &o[i], 1);
683 fio_options_parse(td, (char **) &o[i], 1);
688 add_job(td, jobname, 0);
691 static int skip_this_section(const char *name)
695 if (!strncmp(name, "global", 6))
698 return strcmp(job_section, name);
701 static int is_empty_or_comment(char *line)
705 for (i = 0; i < strlen(line); i++) {
710 if (!isspace(line[i]) && !iscntrl(line[i]))
718 * This is our [ini] type file parser.
720 static int parse_jobs_ini(char *file, int stonewall_flag)
723 struct thread_data *td;
727 int ret = 0, stonewall;
732 int i, alloc_opts, num_opts;
734 if (!strcmp(file, "-"))
737 f = fopen(file, "r");
740 perror("fopen job file");
744 string = malloc(4096);
747 * it's really 256 + small bit, 280 should suffice
750 memset(name, 0, 280);
753 opts = malloc(sizeof(char *) * alloc_opts);
756 stonewall = stonewall_flag;
759 * if skip_fgets is set, we already have loaded a line we
763 p = fgets(string, 4095, f);
769 strip_blank_front(&p);
772 if (is_empty_or_comment(p))
774 if (sscanf(p, "[%255s]", name) != 1) {
777 log_err("fio: option <%s> outside of [] job section\n",
782 name[strlen(name) - 1] = '\0';
784 if (skip_this_section(name)) {
790 global = !strncmp(name, "global", 6);
796 log_info("--name=%s ", name);
800 td = get_new_job(global, &def_thread);
807 * Seperate multiple job files by a stonewall
809 if (!global && stonewall) {
810 td->o.stonewall = stonewall;
815 memset(opts, 0, alloc_opts * sizeof(char *));
817 while ((p = fgets(string, 4096, f)) != NULL) {
818 if (is_empty_or_comment(p))
821 strip_blank_front(&p);
824 * new section, break out and make sure we don't
825 * fgets() a new line at the top.
834 if (num_opts == alloc_opts) {
837 alloc_opts * sizeof(char *));
840 opts[num_opts] = strdup(p);
844 ret = fio_options_parse(td, opts, num_opts);
847 for (i = 0; i < num_opts; i++)
848 log_info("--%s ", opts[i]);
850 ret = add_job(td, name, 0);
852 log_err("fio: job %s dropped\n", name);
856 for (i = 0; i < num_opts; i++)
864 for (i = 0; i < num_opts; i++)
875 static int fill_def_thread(void)
877 memset(&def_thread, 0, sizeof(def_thread));
879 fio_getaffinity(getpid(), &def_thread.o.cpumask);
882 * fill default options
884 fio_fill_default_options(&def_thread);
886 def_thread.o.timeout = def_timeout;
890 static void free_shm(void)
892 struct shmid_ds sbuf;
899 fio_debug_jobp = NULL;
901 shmctl(shm_id, IPC_RMID, &sbuf);
908 * The thread area is shared between the main process and the job
909 * threads/processes. So setup a shared memory segment that will hold
910 * all the job info. We use the end of the region for keeping track of
911 * open files across jobs, for file sharing.
913 static int setup_thread_area(void)
918 * 1024 is too much on some machines, scale max_jobs if
919 * we get a failure that looks like too large a shm segment
922 size_t size = max_jobs * sizeof(struct thread_data);
924 size += file_hash_size;
925 size += sizeof(unsigned int);
927 shm_id = shmget(0, size, IPC_CREAT | 0600);
930 if (errno != EINVAL) {
941 threads = shmat(shm_id, NULL, 0);
942 if (threads == (void *) -1) {
947 memset(threads, 0, max_jobs * sizeof(struct thread_data));
948 hash = (void *) threads + max_jobs * sizeof(struct thread_data);
949 fio_debug_jobp = (void *) hash + file_hash_size;
950 *fio_debug_jobp = -1;
951 file_hash_init(hash);
956 static void usage(const char *name)
958 printf("%s\n", fio_version_string);
959 printf("%s [options] [job options] <job file(s)>\n", name);
960 printf("\t--debug=options\tEnable debug logging\n");
961 printf("\t--output\tWrite output to file\n");
962 printf("\t--timeout\tRuntime in seconds\n");
963 printf("\t--latency-log\tGenerate per-job latency logs\n");
964 printf("\t--bandwidth-log\tGenerate per-job bandwidth logs\n");
965 printf("\t--minimal\tMinimal (terse) output\n");
966 printf("\t--version\tPrint version info and exit\n");
967 printf("\t--help\t\tPrint this page\n");
968 printf("\t--cmdhelp=cmd\tPrint command help, \"all\" for all of"
970 printf("\t--showcmd\tTurn a job file into command line options\n");
971 printf("\t--eta=when\tWhen ETA estimate should be printed\n");
972 printf("\t \tMay be \"always\", \"never\" or \"auto\"\n");
973 printf("\t--readonly\tTurn on safety read-only checks, preventing"
975 printf("\t--section=name\tOnly run specified section in job file\n");
976 printf("\t--alloc-size=kb\tSet smalloc pool to this size in kb"
978 printf("\nFio was written by Jens Axboe <jens.axboe@oracle.com>");
979 printf("\n Jens Axboe <jaxboe@fusionio.com>\n");
983 struct debug_level debug_levels[] = {
984 { .name = "process", .shift = FD_PROCESS, },
985 { .name = "file", .shift = FD_FILE, },
986 { .name = "io", .shift = FD_IO, },
987 { .name = "mem", .shift = FD_MEM, },
988 { .name = "blktrace", .shift = FD_BLKTRACE },
989 { .name = "verify", .shift = FD_VERIFY },
990 { .name = "random", .shift = FD_RANDOM },
991 { .name = "parse", .shift = FD_PARSE },
992 { .name = "diskutil", .shift = FD_DISKUTIL },
993 { .name = "job", .shift = FD_JOB },
994 { .name = "mutex", .shift = FD_MUTEX },
995 { .name = "profile", .shift = FD_PROFILE },
996 { .name = "time", .shift = FD_TIME },
1000 static int set_debug(const char *string)
1002 struct debug_level *dl;
1003 char *p = (char *) string;
1007 if (!strcmp(string, "?") || !strcmp(string, "help")) {
1010 log_info("fio: dumping debug options:");
1011 for (i = 0; debug_levels[i].name; i++) {
1012 dl = &debug_levels[i];
1013 log_info("%s,", dl->name);
1019 while ((opt = strsep(&p, ",")) != NULL) {
1022 if (!strncmp(opt, "all", 3)) {
1023 log_info("fio: set all debug options\n");
1028 for (i = 0; debug_levels[i].name; i++) {
1029 dl = &debug_levels[i];
1030 found = !strncmp(opt, dl->name, strlen(dl->name));
1034 if (dl->shift == FD_JOB) {
1035 opt = strchr(opt, ':');
1037 log_err("fio: missing job number\n");
1041 fio_debug_jobno = atoi(opt);
1042 log_info("fio: set debug jobno %d\n",
1045 log_info("fio: set debug option %s\n", opt);
1046 fio_debug |= (1UL << dl->shift);
1052 log_err("fio: debug mask %s not found\n", opt);
1057 static int set_debug(const char *string)
1059 log_err("fio: debug tracing not included in build\n");
1064 static int parse_cmd_line(int argc, char *argv[])
1066 struct thread_data *td = NULL;
1067 int c, ini_idx = 0, lidx, ret = 0, do_exit = 0, exit_val = 0;
1069 while ((c = getopt_long_only(argc, argv, "", l_opts, &lidx)) != -1) {
1072 smalloc_pool_size = atoi(optarg);
1075 def_timeout = atoi(optarg);
1084 f_out = fopen(optarg, "w+");
1086 perror("fopen output");
1098 exit(fio_show_option_help(optarg));
1106 printf("%s\n", fio_version_string);
1109 if (!strcmp("always", optarg))
1110 eta_print = FIO_ETA_ALWAYS;
1111 else if (!strcmp("never", optarg))
1112 eta_print = FIO_ETA_NEVER;
1115 if (set_debug(optarg))
1119 if (!strcmp(optarg, "global")) {
1120 log_err("fio: can't use global as only "
1128 job_section = strdup(optarg);
1131 exec_profile = strdup(optarg);
1133 case FIO_GETOPT_JOB: {
1134 const char *opt = l_opts[lidx].name;
1137 if (!strncmp(opt, "name", 4) && td) {
1138 ret = add_job(td, td->o.name ?: "fio", 0);
1146 int is_section = !strncmp(opt, "name", 4);
1149 if (!is_section || !strncmp(val, "global", 6))
1152 if (is_section && skip_this_section(val))
1155 td = get_new_job(global, &def_thread);
1160 ret = fio_cmd_option_parse(td, opt, val);
1175 ret = add_job(td, td->o.name ?: "fio", 0);
1180 while (optind < argc) {
1182 ini_file = realloc(ini_file, ini_idx * sizeof(char *));
1183 ini_file[ini_idx - 1] = strdup(argv[optind]);
1190 int parse_options(int argc, char *argv[])
1197 fio_options_dup_and_init(l_opts);
1199 if (setup_thread_area())
1201 if (fill_def_thread())
1204 job_files = parse_cmd_line(argc, argv);
1206 for (i = 0; i < job_files; i++) {
1207 if (fill_def_thread())
1209 if (parse_jobs_ini(ini_file[i], i))
1215 options_mem_free(&def_thread);
1217 if (!thread_number) {
1223 log_err("No jobs defined(s)\n\n");
1228 if (def_thread.o.gtod_offload) {
1230 fio_gtod_offload = 1;
1231 fio_gtod_cpu = def_thread.o.gtod_cpu;