2 * This file contains job initialization and setup functions.
14 #include <sys/types.h>
20 static char fio_version_string[] = "fio 1.14a";
22 #define FIO_RANDSEED (0xb1899bedUL)
24 static char **ini_file;
25 static int max_jobs = MAX_JOBS;
27 struct thread_data def_thread;
28 struct thread_data *threads = NULL;
30 int exitall_on_terminate = 0;
32 unsigned long long mlock_size = 0;
38 static int def_timeout = 0;
39 static int write_lat_log = 0;
41 static int prev_group_jobs;
44 * Command line options. These will contain the above, plus a few
45 * extra that only pertain to fio itself and not jobs.
47 static struct option long_options[FIO_NR_OPTIONS] = {
50 .has_arg = required_argument,
55 .has_arg = required_argument,
59 .name = "latency-log",
60 .has_arg = required_argument,
64 .name = "bandwidth-log",
65 .has_arg = required_argument,
70 .has_arg = optional_argument,
75 .has_arg = no_argument,
80 .has_arg = no_argument,
85 .has_arg = optional_argument,
104 * Return a free job structure.
106 static struct thread_data *get_new_job(int global, struct thread_data *parent)
108 struct thread_data *td;
112 if (thread_number >= max_jobs)
115 td = &threads[thread_number++];
118 dup_files(td, parent);
119 options_mem_dupe(td);
121 td->thread_number = thread_number;
125 static void put_job(struct thread_data *td)
127 if (td == &def_thread)
131 log_info("fio: %s\n", td->verror);
133 memset(&threads[td->thread_number - 1], 0, sizeof(*td));
137 static int setup_rate(struct thread_data *td)
139 unsigned long nr_reads_per_msec;
140 unsigned long long rate;
143 if (!td->o.rate && !td->o.rate_iops)
147 bs = td->o.rw_min_bs;
148 else if (td_read(td))
149 bs = td->o.min_bs[DDIR_READ];
151 bs = td->o.min_bs[DDIR_WRITE];
155 nr_reads_per_msec = (rate * 1024 * 1000LL) / bs;
157 nr_reads_per_msec = td->o.rate_iops * 1000UL;
159 if (!nr_reads_per_msec) {
160 log_err("rate lower than supported\n");
164 td->rate_usec_cycle = 1000000000ULL / nr_reads_per_msec;
165 td->rate_pending_usleep = 0;
170 * Lazy way of fixing up options that depend on each other. We could also
171 * define option callback handlers, but this is easier.
173 static int fixup_options(struct thread_data *td)
175 struct thread_options *o = &td->o;
177 if (o->rwmix[DDIR_READ] + o->rwmix[DDIR_WRITE] > 100)
178 o->rwmix[DDIR_WRITE] = 100 - o->rwmix[DDIR_READ];
180 if (o->write_iolog_file && o->read_iolog_file) {
181 log_err("fio: read iolog overrides write_iolog\n");
182 free(o->write_iolog_file);
183 o->write_iolog_file = NULL;
186 if (td->io_ops->flags & FIO_SYNCIO)
190 o->iodepth = o->open_files;
194 * only really works for sequential io for now, and with 1 file
196 if (o->zone_size && td_random(td) && o->open_files == 1)
200 * Reads can do overwrites, we always need to pre-create the file
202 if (td_read(td) || td_rw(td))
205 if (!o->min_bs[DDIR_READ])
206 o->min_bs[DDIR_READ]= o->bs[DDIR_READ];
207 if (!o->max_bs[DDIR_READ])
208 o->max_bs[DDIR_READ] = o->bs[DDIR_READ];
209 if (!o->min_bs[DDIR_WRITE])
210 o->min_bs[DDIR_WRITE]= o->bs[DDIR_WRITE];
211 if (!o->max_bs[DDIR_WRITE])
212 o->max_bs[DDIR_WRITE] = o->bs[DDIR_WRITE];
214 o->rw_min_bs = min(o->min_bs[DDIR_READ], o->min_bs[DDIR_WRITE]);
216 if (!o->file_size_high)
217 o->file_size_high = o->file_size_low;
219 if (td_read(td) && !td_rw(td))
222 if (o->norandommap && o->verify != VERIFY_NONE) {
223 log_err("fio: norandommap given, verify disabled\n");
224 o->verify = VERIFY_NONE;
226 if (o->bs_unaligned && (o->odirect || td->io_ops->flags & FIO_RAWIO))
227 log_err("fio: bs_unaligned may not work with raw io\n");
230 * thinktime_spin must be less than thinktime
232 if (o->thinktime_spin > o->thinktime)
233 o->thinktime_spin = o->thinktime;
236 * The low water mark cannot be bigger than the iodepth
238 if (o->iodepth_low > o->iodepth || !o->iodepth_low) {
240 * syslet work around - if the workload is sequential,
241 * we want to let the queue drain all the way down to
242 * avoid seeking between async threads
244 if (!strcmp(td->io_ops->name, "syslet-rw") && !td_random(td))
247 o->iodepth_low = o->iodepth;
251 * If batch number isn't set, default to the same as iodepth
253 if (o->iodepth_batch > o->iodepth || !o->iodepth_batch)
254 o->iodepth_batch = o->iodepth;
256 if (o->nr_files > td->files_index)
257 o->nr_files = td->files_index;
259 if (o->open_files > o->nr_files || !o->open_files)
260 o->open_files = o->nr_files;
262 if ((o->rate && o->rate_iops) || (o->ratemin && o->rate_iops_min)) {
263 log_err("fio: rate and rate_iops are mutually exclusive\n");
266 if ((o->rate < o->ratemin) || (o->rate_iops < o->rate_iops_min)) {
267 log_err("fio: minimum rate exceeds rate\n");
275 * This function leaks the buffer
277 static char *to_kmg(unsigned int val)
279 char *buf = malloc(32);
280 char post[] = { 0, 'K', 'M', 'G', 'P', 'E', 0 };
291 snprintf(buf, 31, "%u%c", val, *p);
295 /* External engines are specified by "external:name.o") */
296 static const char *get_engine_name(const char *str)
298 char *p = strstr(str, ":");
304 strip_blank_front(&p);
309 static int exists_and_not_file(const char *filename)
313 if (lstat(filename, &sb) == -1)
316 if (S_ISREG(sb.st_mode))
323 * Initialize the various random states we need (random io, block size ranges,
324 * read/write mix, etc).
326 static int init_random_state(struct thread_data *td)
328 unsigned long seeds[6];
331 fd = open("/dev/urandom", O_RDONLY);
333 td_verror(td, errno, "open");
337 if (read(fd, seeds, sizeof(seeds)) < (int) sizeof(seeds)) {
338 td_verror(td, EIO, "read");
345 os_random_seed(seeds[0], &td->bsrange_state);
346 os_random_seed(seeds[1], &td->verify_state);
347 os_random_seed(seeds[2], &td->rwmix_state);
349 if (td->o.file_service_type == FIO_FSERVICE_RANDOM)
350 os_random_seed(seeds[3], &td->next_file_state);
352 os_random_seed(seeds[5], &td->file_size_state);
357 if (td->o.rand_repeatable)
358 seeds[4] = FIO_RANDSEED * td->thread_number;
360 os_random_seed(seeds[4], &td->random_state);
365 * Adds a job to the list of things todo. Sanitizes the various options
366 * to make sure we don't have conflicts, and initializes various
369 static int add_job(struct thread_data *td, const char *jobname, int job_add_num)
371 const char *ddir_str[] = { NULL, "read", "write", "rw", NULL,
372 "randread", "randwrite", "randrw" };
375 char fname[PATH_MAX];
376 int numjobs, file_alloced;
379 * the def_thread is just for options, it's not a real job
381 if (td == &def_thread)
384 engine = get_engine_name(td->o.ioengine);
385 td->io_ops = load_ioengine(td, engine);
387 log_err("fio: failed to load engine %s\n", engine);
391 if (td->o.use_thread)
397 td->io_ops->flags |= FIO_RAWIO;
400 if (!td->o.filename && !td->files_index) {
403 if (td->o.nr_files == 1 && exists_and_not_file(jobname))
404 add_file(td, jobname);
406 for (i = 0; i < td->o.nr_files; i++) {
407 sprintf(fname, "%s.%d.%d", jobname, td->thread_number, i);
413 if (fixup_options(td))
416 td->mutex = fio_sem_init(0);
418 td->ts.clat_stat[0].min_val = td->ts.clat_stat[1].min_val = ULONG_MAX;
419 td->ts.slat_stat[0].min_val = td->ts.slat_stat[1].min_val = ULONG_MAX;
420 td->ts.bw_stat[0].min_val = td->ts.bw_stat[1].min_val = ULONG_MAX;
421 td->ddir_nr = td->o.ddir_nr;
423 if ((td->o.stonewall || td->o.numjobs > 1 || td->o.new_group)
424 && prev_group_jobs) {
429 td->groupid = groupid;
432 if (init_random_state(td))
438 if (td->o.write_lat_log) {
439 setup_log(&td->ts.slat_log);
440 setup_log(&td->ts.clat_log);
442 if (td->o.write_bw_log)
443 setup_log(&td->ts.bw_log);
446 td->o.name = strdup(jobname);
450 if (!strcmp(td->io_ops->name, "cpuio"))
451 log_info("%s: ioengine=cpu, cpuload=%u, cpucycle=%u\n", td->o.name, td->o.cpuload, td->o.cpucycle);
453 char *c1, *c2, *c3, *c4;
455 c1 = to_kmg(td->o.min_bs[DDIR_READ]);
456 c2 = to_kmg(td->o.max_bs[DDIR_READ]);
457 c3 = to_kmg(td->o.min_bs[DDIR_WRITE]);
458 c4 = to_kmg(td->o.max_bs[DDIR_WRITE]);
460 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);
467 } else if (job_add_num == 1)
472 * recurse add identical jobs, clear numjobs and stonewall options
473 * as they don't apply to sub-jobs
475 numjobs = td->o.numjobs;
477 struct thread_data *td_new = get_new_job(0, td);
482 td_new->o.numjobs = 1;
483 td_new->o.stonewall = 0;
484 td_new->o.new_group = 0;
487 td_new->o.filename = NULL;
488 td_new->files_index = 0;
489 td_new->files = NULL;
492 job_add_num = numjobs - 1;
494 if (add_job(td_new, jobname, job_add_num))
504 static int is_empty_or_comment(char *line)
508 for (i = 0; i < strlen(line); i++) {
513 if (!isspace(line[i]) && !iscntrl(line[i]))
521 * This is our [ini] type file parser.
523 static int parse_jobs_ini(char *file, int stonewall_flag)
526 struct thread_data *td;
531 int ret = 0, stonewall;
533 f = fopen(file, "r");
535 perror("fopen job file");
539 string = malloc(4096);
541 memset(name, 0, 256);
543 stonewall = stonewall_flag;
545 p = fgets(string, 4095, f);
548 if (is_empty_or_comment(p))
550 if (sscanf(p, "[%255s]", name) != 1)
553 global = !strncmp(name, "global", 6);
555 name[strlen(name) - 1] = '\0';
557 td = get_new_job(global, &def_thread);
564 * Seperate multiple job files by a stonewall
566 if (!global && stonewall) {
567 td->o.stonewall = stonewall;
572 while ((p = fgets(string, 4096, f)) != NULL) {
573 if (is_empty_or_comment(p))
576 strip_blank_front(&p);
586 * Don't break here, continue parsing options so we
587 * dump all the bad ones. Makes trial/error fixups
588 * easier on the user.
590 ret |= fio_option_parse(td, p);
595 ret = add_job(td, name, 0);
597 log_err("fio: job %s dropped\n", name);
608 static int fill_def_thread(void)
610 memset(&def_thread, 0, sizeof(def_thread));
612 if (fio_getaffinity(getpid(), &def_thread.o.cpumask) == -1) {
613 perror("sched_getaffinity");
618 * fill default options
620 fio_fill_default_options(&def_thread);
622 def_thread.o.timeout = def_timeout;
623 def_thread.o.write_bw_log = write_bw_log;
624 def_thread.o.write_lat_log = write_lat_log;
626 #ifdef FIO_HAVE_DISK_UTIL
627 def_thread.o.do_disk_util = 1;
633 static void free_shm(void)
635 struct shmid_ds sbuf;
638 shmdt((void *) threads);
640 shmctl(shm_id, IPC_RMID, &sbuf);
645 * The thread area is shared between the main process and the job
646 * threads/processes. So setup a shared memory segment that will hold
649 static int setup_thread_area(void)
652 * 1024 is too much on some machines, scale max_jobs if
653 * we get a failure that looks like too large a shm segment
656 size_t size = max_jobs * sizeof(struct thread_data);
658 shm_id = shmget(0, size, IPC_CREAT | 0600);
661 if (errno != EINVAL) {
672 threads = shmat(shm_id, NULL, 0);
673 if (threads == (void *) -1) {
682 static void usage(void)
684 printf("%s\n", fio_version_string);
685 printf("\t--output\tWrite output to file\n");
686 printf("\t--timeout\tRuntime in seconds\n");
687 printf("\t--latency-log\tGenerate per-job latency logs\n");
688 printf("\t--bandwidth-log\tGenerate per-job bandwidth logs\n");
689 printf("\t--minimal\tMinimal (terse) output\n");
690 printf("\t--version\tPrint version info and exit\n");
691 printf("\t--help\t\tPrint this page\n");
692 printf("\t--cmdhelp=cmd\tPrint command help, \"all\" for all of them\n");
695 static int parse_cmd_line(int argc, char *argv[])
697 struct thread_data *td = NULL;
698 int c, ini_idx = 0, lidx, ret, dont_add_job = 0;
700 while ((c = getopt_long_only(argc, argv, "", long_options, &lidx)) != -1) {
703 def_timeout = atoi(optarg);
712 f_out = fopen(optarg, "w+");
714 perror("fopen output");
726 exit(fio_show_option_help(optarg));
728 printf("%s\n", fio_version_string);
730 case FIO_GETOPT_JOB: {
731 const char *opt = long_options[lidx].name;
734 if (!strncmp(opt, "name", 4) && td) {
735 ret = add_job(td, td->o.name ?: "fio", 0);
743 int global = !strncmp(val, "global", 6);
745 td = get_new_job(global, &def_thread);
750 ret = fio_cmd_option_parse(td, opt, val);
764 ret = add_job(td, td->o.name ?: "fio", 0);
770 while (optind < argc) {
772 ini_file = realloc(ini_file, ini_idx * sizeof(char *));
773 ini_file[ini_idx - 1] = strdup(argv[optind]);
781 int parse_options(int argc, char *argv[])
788 fio_options_dup_and_init(long_options);
790 if (setup_thread_area())
792 if (fill_def_thread())
795 job_files = parse_cmd_line(argc, argv);
797 for (i = 0; i < job_files; i++) {
798 if (fill_def_thread())
800 if (parse_jobs_ini(ini_file[i], i))
806 options_mem_free(&def_thread);
808 if (!thread_number) {
809 log_err("No jobs defined(s)\n");