2 * This file contains job initialization and setup functions.
14 #include <sys/types.h>
22 static char fio_version_string[] = "fio 1.24";
24 #define FIO_RANDSEED (0xb1899bedUL)
26 static char **ini_file;
27 static int max_jobs = MAX_JOBS;
28 static int dump_cmdline;
30 static struct thread_data def_thread;
31 struct thread_data *threads = NULL;
33 int exitall_on_terminate = 0;
36 unsigned long long mlock_size = 0;
39 char *job_section = NULL;
44 static int def_timeout;
45 static int write_lat_log;
47 static int prev_group_jobs;
49 unsigned long fio_debug = 0;
50 unsigned int fio_debug_jobno = -1;
51 unsigned int *fio_debug_jobp = NULL;
54 * Command line options. These will contain the above, plus a few
55 * extra that only pertain to fio itself and not jobs.
57 static struct option l_opts[FIO_NR_OPTIONS] = {
60 .has_arg = required_argument,
65 .has_arg = required_argument,
69 .name = "latency-log",
70 .has_arg = required_argument,
74 .name = "bandwidth-log",
75 .has_arg = required_argument,
80 .has_arg = optional_argument,
85 .has_arg = no_argument,
90 .has_arg = no_argument,
95 .has_arg = optional_argument,
100 .has_arg = no_argument,
105 .has_arg = no_argument,
110 .has_arg = required_argument,
115 .has_arg = required_argument,
120 .has_arg = required_argument,
124 .name = "alloc-size",
125 .has_arg = required_argument,
144 * Return a free job structure.
146 static struct thread_data *get_new_job(int global, struct thread_data *parent)
148 struct thread_data *td;
152 if (thread_number >= max_jobs)
155 td = &threads[thread_number++];
158 dup_files(td, parent);
159 options_mem_dupe(td);
161 td->thread_number = thread_number;
165 static void put_job(struct thread_data *td)
167 if (td == &def_thread)
171 log_info("fio: %s\n", td->verror);
173 memset(&threads[td->thread_number - 1], 0, sizeof(*td));
177 static int setup_rate(struct thread_data *td)
179 unsigned long nr_reads_per_msec;
180 unsigned long long rate;
183 if (!td->o.rate && !td->o.rate_iops)
187 bs = td->o.rw_min_bs;
188 else if (td_read(td))
189 bs = td->o.min_bs[DDIR_READ];
191 bs = td->o.min_bs[DDIR_WRITE];
195 nr_reads_per_msec = (rate * 1024 * 1000LL) / bs;
197 nr_reads_per_msec = td->o.rate_iops * 1000UL;
199 if (!nr_reads_per_msec) {
200 log_err("rate lower than supported\n");
204 td->rate_usec_cycle = 1000000000ULL / nr_reads_per_msec;
205 td->rate_pending_usleep = 0;
209 static int fixed_block_size(struct thread_options *o)
211 return o->min_bs[DDIR_READ] == o->max_bs[DDIR_READ] &&
212 o->min_bs[DDIR_WRITE] == o->max_bs[DDIR_WRITE] &&
213 o->min_bs[DDIR_READ] == o->min_bs[DDIR_WRITE];
217 * Lazy way of fixing up options that depend on each other. We could also
218 * define option callback handlers, but this is easier.
220 static int fixup_options(struct thread_data *td)
222 struct thread_options *o = &td->o;
224 #ifndef FIO_HAVE_PSHARED_MUTEX
225 if (!td->o.use_thread) {
226 log_info("fio: this platform does not support process shared"
227 " mutexes, forcing use of threads. Use the 'thread'"
228 " option to get rid of this warning.\n");
229 td->o.use_thread = 1;
233 #ifndef FIO_HAVE_CPU_AFFINITY
234 if (td->o.gtod_cpu) {
235 log_err("fio: platform must support CPU affinity for"
236 "gettimeofday() offloading\n");
241 if (read_only && td_write(td)) {
242 log_err("fio: job <%s> has write bit set, but fio is in"
243 " read-only mode\n", td->o.name);
247 if (o->write_iolog_file && o->read_iolog_file) {
248 log_err("fio: read iolog overrides write_iolog\n");
249 free(o->write_iolog_file);
250 o->write_iolog_file = NULL;
254 * only really works for sequential io for now, and with 1 file
256 if (o->zone_size && td_random(td) && o->open_files == 1)
260 * Reads can do overwrites, we always need to pre-create the file
262 if (td_read(td) || td_rw(td))
265 if (!o->min_bs[DDIR_READ])
266 o->min_bs[DDIR_READ] = o->bs[DDIR_READ];
267 if (!o->max_bs[DDIR_READ])
268 o->max_bs[DDIR_READ] = o->bs[DDIR_READ];
269 if (!o->min_bs[DDIR_WRITE])
270 o->min_bs[DDIR_WRITE] = o->bs[DDIR_WRITE];
271 if (!o->max_bs[DDIR_WRITE])
272 o->max_bs[DDIR_WRITE] = o->bs[DDIR_WRITE];
274 o->rw_min_bs = min(o->min_bs[DDIR_READ], o->min_bs[DDIR_WRITE]);
277 * For random IO, allow blockalign offset other than min_bs.
279 if (!o->ba[DDIR_READ] || !td_random(td))
280 o->ba[DDIR_READ] = o->min_bs[DDIR_READ];
281 if (!o->ba[DDIR_WRITE] || !td_random(td))
282 o->ba[DDIR_WRITE] = o->min_bs[DDIR_WRITE];
284 if ((o->ba[DDIR_READ] != o->min_bs[DDIR_READ] ||
285 o->ba[DDIR_WRITE] != o->min_bs[DDIR_WRITE]) &&
286 !td->o.norandommap) {
287 log_err("fio: Any use of blockalign= turns off randommap\n");
288 td->o.norandommap = 1;
291 if (!o->file_size_high)
292 o->file_size_high = o->file_size_low;
294 if (o->norandommap && o->verify != VERIFY_NONE
295 && !fixed_block_size(o)) {
296 log_err("fio: norandommap given for variable block sizes, "
297 "verify disabled\n");
298 o->verify = VERIFY_NONE;
300 if (o->bs_unaligned && (o->odirect || td->io_ops->flags & FIO_RAWIO))
301 log_err("fio: bs_unaligned may not work with raw io\n");
304 * thinktime_spin must be less than thinktime
306 if (o->thinktime_spin > o->thinktime)
307 o->thinktime_spin = o->thinktime;
310 * The low water mark cannot be bigger than the iodepth
312 if (o->iodepth_low > o->iodepth || !o->iodepth_low) {
314 * syslet work around - if the workload is sequential,
315 * we want to let the queue drain all the way down to
316 * avoid seeking between async threads
318 if (!strcmp(td->io_ops->name, "syslet-rw") && !td_random(td))
321 o->iodepth_low = o->iodepth;
325 * If batch number isn't set, default to the same as iodepth
327 if (o->iodepth_batch > o->iodepth || !o->iodepth_batch)
328 o->iodepth_batch = o->iodepth;
330 if (o->nr_files > td->files_index)
331 o->nr_files = td->files_index;
333 if (o->open_files > o->nr_files || !o->open_files)
334 o->open_files = o->nr_files;
336 if ((o->rate && o->rate_iops) || (o->ratemin && o->rate_iops_min)) {
337 log_err("fio: rate and rate_iops are mutually exclusive\n");
340 if ((o->rate < o->ratemin) || (o->rate_iops < o->rate_iops_min)) {
341 log_err("fio: minimum rate exceeds rate\n");
345 if (!o->timeout && o->time_based) {
346 log_err("fio: time_based requires a runtime/timeout setting\n");
350 if (o->fill_device && !o->size)
353 if (td_rw(td) && td->o.verify != VERIFY_NONE)
354 log_info("fio: mixed read/write workload with verify. May not "
355 "work as expected, unless you pre-populated the file\n");
357 if (td->o.verify != VERIFY_NONE)
358 td->o.refill_buffers = 1;
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))
412 * Initialize the various random states we need (random io, block size ranges,
413 * read/write mix, etc).
415 static int init_random_state(struct thread_data *td)
417 unsigned long seeds[6];
420 fd = open("/dev/urandom", O_RDONLY);
422 td_verror(td, errno, "open");
426 if (read(fd, seeds, sizeof(seeds)) < (int) sizeof(seeds)) {
427 td_verror(td, EIO, "read");
434 os_random_seed(seeds[0], &td->bsrange_state);
435 os_random_seed(seeds[1], &td->verify_state);
436 os_random_seed(seeds[2], &td->rwmix_state);
438 if (td->o.file_service_type == FIO_FSERVICE_RANDOM)
439 os_random_seed(seeds[3], &td->next_file_state);
441 os_random_seed(seeds[5], &td->file_size_state);
446 if (td->o.rand_repeatable)
447 seeds[4] = FIO_RANDSEED * td->thread_number;
449 os_random_seed(seeds[4], &td->random_state);
454 * Adds a job to the list of things todo. Sanitizes the various options
455 * to make sure we don't have conflicts, and initializes various
458 static int add_job(struct thread_data *td, const char *jobname, int job_add_num)
460 const char *ddir_str[] = { NULL, "read", "write", "rw", NULL,
461 "randread", "randwrite", "randrw" };
464 char fname[PATH_MAX];
465 int numjobs, file_alloced;
468 * the def_thread is just for options, it's not a real job
470 if (td == &def_thread)
474 * if we are just dumping the output command line, don't add the job
481 engine = get_engine_name(td->o.ioengine);
482 td->io_ops = load_ioengine(td, engine);
484 log_err("fio: failed to load engine %s\n", engine);
488 if (td->o.use_thread)
494 td->io_ops->flags |= FIO_RAWIO;
497 if (!td->o.filename && !td->files_index && !td->o.read_iolog_file) {
500 if (td->o.nr_files == 1 && exists_and_not_file(jobname))
501 add_file(td, jobname);
503 for (i = 0; i < td->o.nr_files; i++) {
504 sprintf(fname, "%s.%d.%d", jobname,
505 td->thread_number, i);
511 if (fixup_options(td))
514 if (td->io_ops->flags & FIO_DISKLESSIO) {
517 for_each_file(td, f, i)
518 f->real_file_size = -1ULL;
521 td->mutex = fio_mutex_init(0);
523 td->ts.clat_stat[0].min_val = td->ts.clat_stat[1].min_val = ULONG_MAX;
524 td->ts.slat_stat[0].min_val = td->ts.slat_stat[1].min_val = ULONG_MAX;
525 td->ts.bw_stat[0].min_val = td->ts.bw_stat[1].min_val = ULONG_MAX;
526 td->ddir_nr = td->o.ddir_nr;
528 if ((td->o.stonewall || td->o.numjobs > 1 || td->o.new_group)
529 && prev_group_jobs) {
534 td->groupid = groupid;
537 if (init_random_state(td))
543 if (td->o.write_lat_log) {
544 setup_log(&td->ts.slat_log);
545 setup_log(&td->ts.clat_log);
547 if (td->o.write_bw_log)
548 setup_log(&td->ts.bw_log);
551 td->o.name = strdup(jobname);
555 if (!strcmp(td->io_ops->name, "cpuio")) {
556 log_info("%s: ioengine=cpu, cpuload=%u,"
557 " cpucycle=%u\n", td->o.name,
561 char *c1, *c2, *c3, *c4;
563 c1 = to_kmg(td->o.min_bs[DDIR_READ]);
564 c2 = to_kmg(td->o.max_bs[DDIR_READ]);
565 c3 = to_kmg(td->o.min_bs[DDIR_WRITE]);
566 c4 = to_kmg(td->o.max_bs[DDIR_WRITE]);
568 log_info("%s: (g=%d): rw=%s, bs=%s-%s/%s-%s,"
569 " ioengine=%s, iodepth=%u\n",
570 td->o.name, td->groupid,
571 ddir_str[td->o.td_ddir],
581 } else if (job_add_num == 1)
586 * recurse add identical jobs, clear numjobs and stonewall options
587 * as they don't apply to sub-jobs
589 numjobs = td->o.numjobs;
591 struct thread_data *td_new = get_new_job(0, td);
596 td_new->o.numjobs = 1;
597 td_new->o.stonewall = 0;
598 td_new->o.new_group = 0;
601 td_new->o.filename = NULL;
602 td_new->files_index = 0;
603 td_new->files_size = 0;
604 td_new->files = NULL;
607 job_add_num = numjobs - 1;
609 if (add_job(td_new, jobname, job_add_num))
619 static int skip_this_section(const char *name)
623 if (!strncmp(name, "global", 6))
626 return strcmp(job_section, name);
629 static int is_empty_or_comment(char *line)
633 for (i = 0; i < strlen(line); i++) {
638 if (!isspace(line[i]) && !iscntrl(line[i]))
646 * This is our [ini] type file parser.
648 static int parse_jobs_ini(char *file, int stonewall_flag)
651 struct thread_data *td;
655 int ret = 0, stonewall;
660 int i, alloc_opts, num_opts;
662 if (!strcmp(file, "-"))
665 f = fopen(file, "r");
668 perror("fopen job file");
672 string = malloc(4096);
675 * it's really 256 + small bit, 280 should suffice
678 memset(name, 0, 280);
681 opts = malloc(sizeof(char *) * alloc_opts);
684 stonewall = stonewall_flag;
687 * if skip_fgets is set, we already have loaded a line we
691 p = fgets(string, 4095, f);
697 strip_blank_front(&p);
700 if (is_empty_or_comment(p))
702 if (sscanf(p, "[%255s]", name) != 1) {
705 log_err("fio: option <%s> outside of [] job section\n",
710 if (skip_this_section(name)) {
716 global = !strncmp(name, "global", 6);
718 name[strlen(name) - 1] = '\0';
724 log_info("--name=%s ", name);
728 td = get_new_job(global, &def_thread);
735 * Seperate multiple job files by a stonewall
737 if (!global && stonewall) {
738 td->o.stonewall = stonewall;
743 memset(opts, 0, alloc_opts * sizeof(char *));
745 while ((p = fgets(string, 4096, f)) != NULL) {
746 if (is_empty_or_comment(p))
749 strip_blank_front(&p);
752 * new section, break out and make sure we don't
753 * fgets() a new line at the top.
762 if (num_opts == alloc_opts) {
765 alloc_opts * sizeof(char *));
768 opts[num_opts] = strdup(p);
772 ret = fio_options_parse(td, opts, num_opts);
775 for (i = 0; i < num_opts; i++)
776 log_info("--%s ", opts[i]);
778 ret = add_job(td, name, 0);
780 log_err("fio: job %s dropped\n", name);
784 for (i = 0; i < num_opts; i++)
792 for (i = 0; i < num_opts; i++)
803 static int fill_def_thread(void)
805 memset(&def_thread, 0, sizeof(def_thread));
807 fio_getaffinity(getpid(), &def_thread.o.cpumask);
810 * fill default options
812 fio_fill_default_options(&def_thread);
814 def_thread.o.timeout = def_timeout;
815 def_thread.o.write_bw_log = write_bw_log;
816 def_thread.o.write_lat_log = write_lat_log;
821 static void free_shm(void)
823 struct shmid_ds sbuf;
830 fio_debug_jobp = NULL;
832 shmctl(shm_id, IPC_RMID, &sbuf);
839 * The thread area is shared between the main process and the job
840 * threads/processes. So setup a shared memory segment that will hold
841 * all the job info. We use the end of the region for keeping track of
842 * open files across jobs, for file sharing.
844 static int setup_thread_area(void)
849 * 1024 is too much on some machines, scale max_jobs if
850 * we get a failure that looks like too large a shm segment
853 size_t size = max_jobs * sizeof(struct thread_data);
855 size += file_hash_size;
856 size += sizeof(unsigned int);
858 shm_id = shmget(0, size, IPC_CREAT | 0600);
861 if (errno != EINVAL) {
872 threads = shmat(shm_id, NULL, 0);
873 if (threads == (void *) -1) {
878 memset(threads, 0, max_jobs * sizeof(struct thread_data));
879 hash = (void *) threads + max_jobs * sizeof(struct thread_data);
880 fio_debug_jobp = (void *) hash + file_hash_size;
881 *fio_debug_jobp = -1;
882 file_hash_init(hash);
887 static void usage(const char *name)
889 printf("%s\n", fio_version_string);
890 printf("%s [options] [job options] <job file(s)>\n", name);
891 printf("\t--debug=options\tEnable debug logging\n");
892 printf("\t--output\tWrite output to file\n");
893 printf("\t--timeout\tRuntime in seconds\n");
894 printf("\t--latency-log\tGenerate per-job latency logs\n");
895 printf("\t--bandwidth-log\tGenerate per-job bandwidth logs\n");
896 printf("\t--minimal\tMinimal (terse) output\n");
897 printf("\t--version\tPrint version info and exit\n");
898 printf("\t--help\t\tPrint this page\n");
899 printf("\t--cmdhelp=cmd\tPrint command help, \"all\" for all of"
901 printf("\t--showcmd\tTurn a job file into command line options\n");
902 printf("\t--eta=when\tWhen ETA estimate should be printed\n");
903 printf("\t \tMay be \"always\", \"never\" or \"auto\"\n");
904 printf("\t--readonly\tTurn on safety read-only checks, preventing"
906 printf("\t--section=name\tOnly run specified section in job file\n");
907 printf("\t--alloc-size=kb\tSet smalloc pool to this size in kb"
912 struct debug_level debug_levels[] = {
913 { .name = "process", .shift = FD_PROCESS, },
914 { .name = "file", .shift = FD_FILE, },
915 { .name = "io", .shift = FD_IO, },
916 { .name = "mem", .shift = FD_MEM, },
917 { .name = "blktrace", .shift = FD_BLKTRACE },
918 { .name = "verify", .shift = FD_VERIFY },
919 { .name = "random", .shift = FD_RANDOM },
920 { .name = "parse", .shift = FD_PARSE },
921 { .name = "diskutil", .shift = FD_DISKUTIL },
922 { .name = "job", .shift = FD_JOB },
923 { .name = "mutex", .shift = FD_MUTEX },
927 static int set_debug(const char *string)
929 struct debug_level *dl;
930 char *p = (char *) string;
934 if (!strcmp(string, "?") || !strcmp(string, "help")) {
937 log_info("fio: dumping debug options:");
938 for (i = 0; debug_levels[i].name; i++) {
939 dl = &debug_levels[i];
940 log_info("%s,", dl->name);
946 while ((opt = strsep(&p, ",")) != NULL) {
949 if (!strncmp(opt, "all", 3)) {
950 log_info("fio: set all debug options\n");
955 for (i = 0; debug_levels[i].name; i++) {
956 dl = &debug_levels[i];
957 found = !strncmp(opt, dl->name, strlen(dl->name));
961 if (dl->shift == FD_JOB) {
962 opt = strchr(opt, ':');
964 log_err("fio: missing job number\n");
968 fio_debug_jobno = atoi(opt);
969 log_info("fio: set debug jobno %d\n",
972 log_info("fio: set debug option %s\n", opt);
973 fio_debug |= (1UL << dl->shift);
979 log_err("fio: debug mask %s not found\n", opt);
984 static int set_debug(const char *string)
986 log_err("fio: debug tracing not included in build\n");
991 static int parse_cmd_line(int argc, char *argv[])
993 struct thread_data *td = NULL;
994 int c, ini_idx = 0, lidx, ret = 0, do_exit = 0, exit_val = 0;
996 while ((c = getopt_long_only(argc, argv, "", l_opts, &lidx)) != -1) {
999 smalloc_pool_size = atoi(optarg);
1002 def_timeout = atoi(optarg);
1011 f_out = fopen(optarg, "w+");
1013 perror("fopen output");
1025 exit(fio_show_option_help(optarg));
1033 printf("%s\n", fio_version_string);
1036 if (!strcmp("always", optarg))
1037 eta_print = FIO_ETA_ALWAYS;
1038 else if (!strcmp("never", optarg))
1039 eta_print = FIO_ETA_NEVER;
1042 if (set_debug(optarg))
1046 if (!strcmp(optarg, "global")) {
1047 log_err("fio: can't use global as only "
1055 job_section = strdup(optarg);
1057 case FIO_GETOPT_JOB: {
1058 const char *opt = l_opts[lidx].name;
1061 if (!strncmp(opt, "name", 4) && td) {
1062 ret = add_job(td, td->o.name ?: "fio", 0);
1070 int is_section = !strncmp(opt, "name", 4);
1073 if (!is_section || !strncmp(val, "global", 6))
1076 if (is_section && skip_this_section(val))
1079 td = get_new_job(global, &def_thread);
1084 ret = fio_cmd_option_parse(td, opt, val);
1099 ret = add_job(td, td->o.name ?: "fio", 0);
1104 while (optind < argc) {
1106 ini_file = realloc(ini_file, ini_idx * sizeof(char *));
1107 ini_file[ini_idx - 1] = strdup(argv[optind]);
1114 int parse_options(int argc, char *argv[])
1121 fio_options_dup_and_init(l_opts);
1123 if (setup_thread_area())
1125 if (fill_def_thread())
1128 job_files = parse_cmd_line(argc, argv);
1130 for (i = 0; i < job_files; i++) {
1131 if (fill_def_thread())
1133 if (parse_jobs_ini(ini_file[i], i))
1139 options_mem_free(&def_thread);
1141 if (!thread_number) {
1145 log_err("No jobs defined(s)\n");
1150 if (def_thread.o.gtod_offload) {
1152 fio_gtod_offload = 1;
1153 fio_gtod_cpu = def_thread.o.gtod_cpu;