2 * This file contains job initialization and setup functions.
14 #include <sys/types.h>
20 static char fio_version_string[] = "fio 1.17.1";
22 #define FIO_RANDSEED (0xb1899bedUL)
24 static char **ini_file;
25 static int max_jobs = MAX_JOBS;
26 static int dump_cmdline;
28 struct thread_data def_thread;
29 struct thread_data *threads = NULL;
31 int exitall_on_terminate = 0;
33 unsigned long long mlock_size = 0;
39 static int def_timeout = 0;
40 static int write_lat_log = 0;
42 static int prev_group_jobs;
45 * Command line options. These will contain the above, plus a few
46 * extra that only pertain to fio itself and not jobs.
48 static struct option long_options[FIO_NR_OPTIONS] = {
51 .has_arg = required_argument,
56 .has_arg = required_argument,
60 .name = "latency-log",
61 .has_arg = required_argument,
65 .name = "bandwidth-log",
66 .has_arg = required_argument,
71 .has_arg = optional_argument,
76 .has_arg = no_argument,
81 .has_arg = no_argument,
86 .has_arg = optional_argument,
91 .has_arg = no_argument,
110 * Return a free job structure.
112 static struct thread_data *get_new_job(int global, struct thread_data *parent)
114 struct thread_data *td;
118 if (thread_number >= max_jobs)
121 td = &threads[thread_number++];
124 dup_files(td, parent);
125 options_mem_dupe(td);
127 td->thread_number = thread_number;
131 static void put_job(struct thread_data *td)
133 if (td == &def_thread)
137 log_info("fio: %s\n", td->verror);
139 memset(&threads[td->thread_number - 1], 0, sizeof(*td));
143 static int setup_rate(struct thread_data *td)
145 unsigned long nr_reads_per_msec;
146 unsigned long long rate;
149 if (!td->o.rate && !td->o.rate_iops)
153 bs = td->o.rw_min_bs;
154 else if (td_read(td))
155 bs = td->o.min_bs[DDIR_READ];
157 bs = td->o.min_bs[DDIR_WRITE];
161 nr_reads_per_msec = (rate * 1024 * 1000LL) / bs;
163 nr_reads_per_msec = td->o.rate_iops * 1000UL;
165 if (!nr_reads_per_msec) {
166 log_err("rate lower than supported\n");
170 td->rate_usec_cycle = 1000000000ULL / nr_reads_per_msec;
171 td->rate_pending_usleep = 0;
176 * Lazy way of fixing up options that depend on each other. We could also
177 * define option callback handlers, but this is easier.
179 static int fixup_options(struct thread_data *td)
181 struct thread_options *o = &td->o;
183 if (o->rwmix[DDIR_READ] + o->rwmix[DDIR_WRITE] > 100)
184 o->rwmix[DDIR_WRITE] = 100 - o->rwmix[DDIR_READ];
186 if (o->write_iolog_file && o->read_iolog_file) {
187 log_err("fio: read iolog overrides write_iolog\n");
188 free(o->write_iolog_file);
189 o->write_iolog_file = NULL;
192 if (td->io_ops->flags & FIO_SYNCIO)
196 o->iodepth = o->open_files;
200 * only really works for sequential io for now, and with 1 file
202 if (o->zone_size && td_random(td) && o->open_files == 1)
206 * Reads can do overwrites, we always need to pre-create the file
208 if (td_read(td) || td_rw(td))
211 if (!o->min_bs[DDIR_READ])
212 o->min_bs[DDIR_READ]= o->bs[DDIR_READ];
213 if (!o->max_bs[DDIR_READ])
214 o->max_bs[DDIR_READ] = o->bs[DDIR_READ];
215 if (!o->min_bs[DDIR_WRITE])
216 o->min_bs[DDIR_WRITE]= o->bs[DDIR_WRITE];
217 if (!o->max_bs[DDIR_WRITE])
218 o->max_bs[DDIR_WRITE] = o->bs[DDIR_WRITE];
220 o->rw_min_bs = min(o->min_bs[DDIR_READ], o->min_bs[DDIR_WRITE]);
222 if (!o->file_size_high)
223 o->file_size_high = o->file_size_low;
225 if (o->norandommap && o->verify != VERIFY_NONE) {
226 log_err("fio: norandommap given, verify disabled\n");
227 o->verify = VERIFY_NONE;
229 if (o->bs_unaligned && (o->odirect || td->io_ops->flags & FIO_RAWIO))
230 log_err("fio: bs_unaligned may not work with raw io\n");
233 * thinktime_spin must be less than thinktime
235 if (o->thinktime_spin > o->thinktime)
236 o->thinktime_spin = o->thinktime;
239 * The low water mark cannot be bigger than the iodepth
241 if (o->iodepth_low > o->iodepth || !o->iodepth_low) {
243 * syslet work around - if the workload is sequential,
244 * we want to let the queue drain all the way down to
245 * avoid seeking between async threads
247 if (!strcmp(td->io_ops->name, "syslet-rw") && !td_random(td))
250 o->iodepth_low = o->iodepth;
254 * If batch number isn't set, default to the same as iodepth
256 if (o->iodepth_batch > o->iodepth || !o->iodepth_batch)
257 o->iodepth_batch = o->iodepth;
259 if (o->nr_files > td->files_index)
260 o->nr_files = td->files_index;
262 if (o->open_files > o->nr_files || !o->open_files)
263 o->open_files = o->nr_files;
265 if ((o->rate && o->rate_iops) || (o->ratemin && o->rate_iops_min)) {
266 log_err("fio: rate and rate_iops are mutually exclusive\n");
269 if ((o->rate < o->ratemin) || (o->rate_iops < o->rate_iops_min)) {
270 log_err("fio: minimum rate exceeds rate\n");
274 if (!o->timeout && o->time_based) {
275 log_err("fio: time_based requires a runtime/timeout setting\n");
283 * This function leaks the buffer
285 static char *to_kmg(unsigned int val)
287 char *buf = malloc(32);
288 char post[] = { 0, 'K', 'M', 'G', 'P', 'E', 0 };
299 snprintf(buf, 31, "%u%c", val, *p);
303 /* External engines are specified by "external:name.o") */
304 static const char *get_engine_name(const char *str)
306 char *p = strstr(str, ":");
312 strip_blank_front(&p);
317 static int exists_and_not_file(const char *filename)
321 if (lstat(filename, &sb) == -1)
324 if (S_ISREG(sb.st_mode))
331 * Initialize the various random states we need (random io, block size ranges,
332 * read/write mix, etc).
334 static int init_random_state(struct thread_data *td)
336 unsigned long seeds[6];
339 fd = open("/dev/urandom", O_RDONLY);
341 td_verror(td, errno, "open");
345 if (read(fd, seeds, sizeof(seeds)) < (int) sizeof(seeds)) {
346 td_verror(td, EIO, "read");
353 os_random_seed(seeds[0], &td->bsrange_state);
354 os_random_seed(seeds[1], &td->verify_state);
355 os_random_seed(seeds[2], &td->rwmix_state);
357 if (td->o.file_service_type == FIO_FSERVICE_RANDOM)
358 os_random_seed(seeds[3], &td->next_file_state);
360 os_random_seed(seeds[5], &td->file_size_state);
365 if (td->o.rand_repeatable)
366 seeds[4] = FIO_RANDSEED * td->thread_number;
368 os_random_seed(seeds[4], &td->random_state);
373 * Adds a job to the list of things todo. Sanitizes the various options
374 * to make sure we don't have conflicts, and initializes various
377 static int add_job(struct thread_data *td, const char *jobname, int job_add_num)
379 const char *ddir_str[] = { NULL, "read", "write", "rw", NULL,
380 "randread", "randwrite", "randrw" };
383 char fname[PATH_MAX];
384 int numjobs, file_alloced;
387 * the def_thread is just for options, it's not a real job
389 if (td == &def_thread)
393 * if we are just dumping the output command line, don't add the job
400 engine = get_engine_name(td->o.ioengine);
401 td->io_ops = load_ioengine(td, engine);
403 log_err("fio: failed to load engine %s\n", engine);
407 if (td->o.use_thread)
413 td->io_ops->flags |= FIO_RAWIO;
416 if (!td->o.filename && !td->files_index) {
419 if (td->o.nr_files == 1 && exists_and_not_file(jobname))
420 add_file(td, jobname);
422 for (i = 0; i < td->o.nr_files; i++) {
423 sprintf(fname, "%s.%d.%d", jobname, td->thread_number, i);
429 if (fixup_options(td))
432 if (td->io_ops->flags & FIO_DISKLESSIO) {
435 for_each_file(td, f, i)
436 f->real_file_size = -1ULL;
439 td->mutex = fio_sem_init(0);
441 td->ts.clat_stat[0].min_val = td->ts.clat_stat[1].min_val = ULONG_MAX;
442 td->ts.slat_stat[0].min_val = td->ts.slat_stat[1].min_val = ULONG_MAX;
443 td->ts.bw_stat[0].min_val = td->ts.bw_stat[1].min_val = ULONG_MAX;
444 td->ddir_nr = td->o.ddir_nr;
446 if ((td->o.stonewall || td->o.numjobs > 1 || td->o.new_group)
447 && prev_group_jobs) {
452 td->groupid = groupid;
455 if (init_random_state(td))
461 if (td->o.write_lat_log) {
462 setup_log(&td->ts.slat_log);
463 setup_log(&td->ts.clat_log);
465 if (td->o.write_bw_log)
466 setup_log(&td->ts.bw_log);
469 td->o.name = strdup(jobname);
473 if (!strcmp(td->io_ops->name, "cpuio"))
474 log_info("%s: ioengine=cpu, cpuload=%u, cpucycle=%u\n", td->o.name, td->o.cpuload, td->o.cpucycle);
476 char *c1, *c2, *c3, *c4;
478 c1 = to_kmg(td->o.min_bs[DDIR_READ]);
479 c2 = to_kmg(td->o.max_bs[DDIR_READ]);
480 c3 = to_kmg(td->o.min_bs[DDIR_WRITE]);
481 c4 = to_kmg(td->o.max_bs[DDIR_WRITE]);
483 log_info("%s: (g=%d): rw=%s, bs=%s-%s/%s-%s, ioengine=%s, iodepth=%u\n", td->o.name, td->groupid, ddir_str[td->o.td_ddir], c1, c2, c3, c4, td->io_ops->name, td->o.iodepth);
490 } else if (job_add_num == 1)
495 * recurse add identical jobs, clear numjobs and stonewall options
496 * as they don't apply to sub-jobs
498 numjobs = td->o.numjobs;
500 struct thread_data *td_new = get_new_job(0, td);
505 td_new->o.numjobs = 1;
506 td_new->o.stonewall = 0;
507 td_new->o.new_group = 0;
510 td_new->o.filename = NULL;
511 td_new->files_index = 0;
512 td_new->files = NULL;
515 job_add_num = numjobs - 1;
517 if (add_job(td_new, jobname, job_add_num))
527 static int is_empty_or_comment(char *line)
531 for (i = 0; i < strlen(line); i++) {
536 if (!isspace(line[i]) && !iscntrl(line[i]))
544 * This is our [ini] type file parser.
546 static int parse_jobs_ini(char *file, int stonewall_flag)
549 struct thread_data *td;
554 int ret = 0, stonewall;
557 f = fopen(file, "r");
559 perror("fopen job file");
563 string = malloc(4096);
566 * it's really 256 + small bit, 280 should suffice
569 memset(name, 0, 280);
571 stonewall = stonewall_flag;
573 p = fgets(string, 4095, f);
577 strip_blank_front(&p);
580 if (is_empty_or_comment(p))
582 if (sscanf(p, "[%255s]", name) != 1) {
583 log_err("fio: option <%s> outside of [] job section\n", p);
587 global = !strncmp(name, "global", 6);
589 name[strlen(name) - 1] = '\0';
595 log_info("--name=%s ", name);
599 td = get_new_job(global, &def_thread);
606 * Seperate multiple job files by a stonewall
608 if (!global && stonewall) {
609 td->o.stonewall = stonewall;
614 while ((p = fgets(string, 4096, f)) != NULL) {
615 if (is_empty_or_comment(p))
618 strip_blank_front(&p);
628 * Don't break here, continue parsing options so we
629 * dump all the bad ones. Makes trial/error fixups
630 * easier on the user.
632 ret |= fio_option_parse(td, p);
633 if (!ret && dump_cmdline)
634 log_info("--%s ", p);
639 ret = add_job(td, name, 0);
641 log_err("fio: job %s dropped\n", name);
655 static int fill_def_thread(void)
657 memset(&def_thread, 0, sizeof(def_thread));
659 fio_getaffinity(getpid(), &def_thread.o.cpumask);
662 * fill default options
664 fio_fill_default_options(&def_thread);
666 def_thread.o.timeout = def_timeout;
667 def_thread.o.write_bw_log = write_bw_log;
668 def_thread.o.write_lat_log = write_lat_log;
673 static void free_shm(void)
675 struct shmid_ds sbuf;
678 shmdt((void *) threads);
680 shmctl(shm_id, IPC_RMID, &sbuf);
685 * The thread area is shared between the main process and the job
686 * threads/processes. So setup a shared memory segment that will hold
689 static int setup_thread_area(void)
692 * 1024 is too much on some machines, scale max_jobs if
693 * we get a failure that looks like too large a shm segment
696 size_t size = max_jobs * sizeof(struct thread_data);
698 shm_id = shmget(0, size, IPC_CREAT | 0600);
701 if (errno != EINVAL) {
712 threads = shmat(shm_id, NULL, 0);
713 if (threads == (void *) -1) {
722 static void usage(void)
724 printf("%s\n", fio_version_string);
725 printf("\t--output\tWrite output to file\n");
726 printf("\t--timeout\tRuntime in seconds\n");
727 printf("\t--latency-log\tGenerate per-job latency logs\n");
728 printf("\t--bandwidth-log\tGenerate per-job bandwidth logs\n");
729 printf("\t--minimal\tMinimal (terse) output\n");
730 printf("\t--version\tPrint version info and exit\n");
731 printf("\t--help\t\tPrint this page\n");
732 printf("\t--cmdhelp=cmd\tPrint command help, \"all\" for all of them\n");
733 printf("\t--showcmd\tTurn a job file into command line options\n");
736 static int parse_cmd_line(int argc, char *argv[])
738 struct thread_data *td = NULL;
739 int c, ini_idx = 0, lidx, ret, dont_add_job = 0;
741 while ((c = getopt_long_only(argc, argv, "", long_options, &lidx)) != -1) {
744 def_timeout = atoi(optarg);
753 f_out = fopen(optarg, "w+");
755 perror("fopen output");
767 exit(fio_show_option_help(optarg));
772 printf("%s\n", fio_version_string);
774 case FIO_GETOPT_JOB: {
775 const char *opt = long_options[lidx].name;
778 if (!strncmp(opt, "name", 4) && td) {
779 ret = add_job(td, td->o.name ?: "fio", 0);
789 if (strncmp(opt, "name", 4) ||
790 !strncmp(val, "global", 6))
793 td = get_new_job(global, &def_thread);
798 ret = fio_cmd_option_parse(td, opt, val);
812 ret = add_job(td, td->o.name ?: "fio", 0);
818 while (optind < argc) {
820 ini_file = realloc(ini_file, ini_idx * sizeof(char *));
821 ini_file[ini_idx - 1] = strdup(argv[optind]);
829 int parse_options(int argc, char *argv[])
836 fio_options_dup_and_init(long_options);
838 if (setup_thread_area())
840 if (fill_def_thread())
843 job_files = parse_cmd_line(argc, argv);
845 for (i = 0; i < job_files; i++) {
846 if (fill_def_thread())
848 if (parse_jobs_ini(ini_file[i], i))
854 options_mem_free(&def_thread);
856 if (!thread_number) {
860 log_err("No jobs defined(s)\n");