2 * This file contains job initialization and setup functions.
14 #include <sys/types.h>
20 static char fio_version_string[] = "fio 1.17.2";
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;
34 unsigned long long mlock_size = 0;
41 static int def_timeout = 0;
42 static int write_lat_log = 0;
44 static int prev_group_jobs;
47 * Command line options. These will contain the above, plus a few
48 * extra that only pertain to fio itself and not jobs.
50 static struct option long_options[FIO_NR_OPTIONS] = {
53 .has_arg = required_argument,
58 .has_arg = required_argument,
62 .name = "latency-log",
63 .has_arg = required_argument,
67 .name = "bandwidth-log",
68 .has_arg = required_argument,
73 .has_arg = optional_argument,
78 .has_arg = no_argument,
83 .has_arg = no_argument,
88 .has_arg = optional_argument,
93 .has_arg = no_argument,
98 .has_arg = no_argument,
103 .has_arg = required_argument,
122 * Return a free job structure.
124 static struct thread_data *get_new_job(int global, struct thread_data *parent)
126 struct thread_data *td;
130 if (thread_number >= max_jobs)
133 td = &threads[thread_number++];
136 dup_files(td, parent);
137 options_mem_dupe(td);
139 td->thread_number = thread_number;
143 static void put_job(struct thread_data *td)
145 if (td == &def_thread)
149 log_info("fio: %s\n", td->verror);
151 memset(&threads[td->thread_number - 1], 0, sizeof(*td));
155 static int setup_rate(struct thread_data *td)
157 unsigned long nr_reads_per_msec;
158 unsigned long long rate;
161 if (!td->o.rate && !td->o.rate_iops)
165 bs = td->o.rw_min_bs;
166 else if (td_read(td))
167 bs = td->o.min_bs[DDIR_READ];
169 bs = td->o.min_bs[DDIR_WRITE];
173 nr_reads_per_msec = (rate * 1024 * 1000LL) / bs;
175 nr_reads_per_msec = td->o.rate_iops * 1000UL;
177 if (!nr_reads_per_msec) {
178 log_err("rate lower than supported\n");
182 td->rate_usec_cycle = 1000000000ULL / nr_reads_per_msec;
183 td->rate_pending_usleep = 0;
188 * Lazy way of fixing up options that depend on each other. We could also
189 * define option callback handlers, but this is easier.
191 static int fixup_options(struct thread_data *td)
193 struct thread_options *o = &td->o;
195 if (read_only && td_write(td)) {
196 log_err("fio: job <%s> has write bit set, but fio is in read-only mode\n", td->o.name);
200 if (o->rwmix[DDIR_READ] + o->rwmix[DDIR_WRITE] > 100)
201 o->rwmix[DDIR_WRITE] = 100 - o->rwmix[DDIR_READ];
203 if (o->write_iolog_file && o->read_iolog_file) {
204 log_err("fio: read iolog overrides write_iolog\n");
205 free(o->write_iolog_file);
206 o->write_iolog_file = NULL;
209 if (td->io_ops->flags & FIO_SYNCIO)
213 o->iodepth = o->open_files;
217 * only really works for sequential io for now, and with 1 file
219 if (o->zone_size && td_random(td) && o->open_files == 1)
223 * Reads can do overwrites, we always need to pre-create the file
225 if (td_read(td) || td_rw(td))
228 if (!o->min_bs[DDIR_READ])
229 o->min_bs[DDIR_READ]= o->bs[DDIR_READ];
230 if (!o->max_bs[DDIR_READ])
231 o->max_bs[DDIR_READ] = o->bs[DDIR_READ];
232 if (!o->min_bs[DDIR_WRITE])
233 o->min_bs[DDIR_WRITE]= o->bs[DDIR_WRITE];
234 if (!o->max_bs[DDIR_WRITE])
235 o->max_bs[DDIR_WRITE] = o->bs[DDIR_WRITE];
237 o->rw_min_bs = min(o->min_bs[DDIR_READ], o->min_bs[DDIR_WRITE]);
239 if (!o->file_size_high)
240 o->file_size_high = o->file_size_low;
242 if (o->norandommap && o->verify != VERIFY_NONE) {
243 log_err("fio: norandommap given, verify disabled\n");
244 o->verify = VERIFY_NONE;
246 if (o->bs_unaligned && (o->odirect || td->io_ops->flags & FIO_RAWIO))
247 log_err("fio: bs_unaligned may not work with raw io\n");
250 * thinktime_spin must be less than thinktime
252 if (o->thinktime_spin > o->thinktime)
253 o->thinktime_spin = o->thinktime;
256 * The low water mark cannot be bigger than the iodepth
258 if (o->iodepth_low > o->iodepth || !o->iodepth_low) {
260 * syslet work around - if the workload is sequential,
261 * we want to let the queue drain all the way down to
262 * avoid seeking between async threads
264 if (!strcmp(td->io_ops->name, "syslet-rw") && !td_random(td))
267 o->iodepth_low = o->iodepth;
271 * If batch number isn't set, default to the same as iodepth
273 if (o->iodepth_batch > o->iodepth || !o->iodepth_batch)
274 o->iodepth_batch = o->iodepth;
276 if (o->nr_files > td->files_index)
277 o->nr_files = td->files_index;
279 if (o->open_files > o->nr_files || !o->open_files)
280 o->open_files = o->nr_files;
282 if ((o->rate && o->rate_iops) || (o->ratemin && o->rate_iops_min)) {
283 log_err("fio: rate and rate_iops are mutually exclusive\n");
286 if ((o->rate < o->ratemin) || (o->rate_iops < o->rate_iops_min)) {
287 log_err("fio: minimum rate exceeds rate\n");
291 if (!o->timeout && o->time_based) {
292 log_err("fio: time_based requires a runtime/timeout setting\n");
300 * This function leaks the buffer
302 static char *to_kmg(unsigned int val)
304 char *buf = malloc(32);
305 char post[] = { 0, 'K', 'M', 'G', 'P', 'E', 0 };
316 snprintf(buf, 31, "%u%c", val, *p);
320 /* External engines are specified by "external:name.o") */
321 static const char *get_engine_name(const char *str)
323 char *p = strstr(str, ":");
329 strip_blank_front(&p);
334 static int exists_and_not_file(const char *filename)
338 if (lstat(filename, &sb) == -1)
341 if (S_ISREG(sb.st_mode))
348 * Initialize the various random states we need (random io, block size ranges,
349 * read/write mix, etc).
351 static int init_random_state(struct thread_data *td)
353 unsigned long seeds[6];
356 fd = open("/dev/urandom", O_RDONLY);
358 td_verror(td, errno, "open");
362 if (read(fd, seeds, sizeof(seeds)) < (int) sizeof(seeds)) {
363 td_verror(td, EIO, "read");
370 os_random_seed(seeds[0], &td->bsrange_state);
371 os_random_seed(seeds[1], &td->verify_state);
372 os_random_seed(seeds[2], &td->rwmix_state);
374 if (td->o.file_service_type == FIO_FSERVICE_RANDOM)
375 os_random_seed(seeds[3], &td->next_file_state);
377 os_random_seed(seeds[5], &td->file_size_state);
382 if (td->o.rand_repeatable)
383 seeds[4] = FIO_RANDSEED * td->thread_number;
385 os_random_seed(seeds[4], &td->random_state);
390 * Adds a job to the list of things todo. Sanitizes the various options
391 * to make sure we don't have conflicts, and initializes various
394 static int add_job(struct thread_data *td, const char *jobname, int job_add_num)
396 const char *ddir_str[] = { NULL, "read", "write", "rw", NULL,
397 "randread", "randwrite", "randrw" };
400 char fname[PATH_MAX];
401 int numjobs, file_alloced;
404 * the def_thread is just for options, it's not a real job
406 if (td == &def_thread)
410 * if we are just dumping the output command line, don't add the job
417 engine = get_engine_name(td->o.ioengine);
418 td->io_ops = load_ioengine(td, engine);
420 log_err("fio: failed to load engine %s\n", engine);
424 if (td->o.use_thread)
430 td->io_ops->flags |= FIO_RAWIO;
433 if (!td->o.filename && !td->files_index) {
436 if (td->o.nr_files == 1 && exists_and_not_file(jobname))
437 add_file(td, jobname);
439 for (i = 0; i < td->o.nr_files; i++) {
440 sprintf(fname, "%s.%d.%d", jobname, td->thread_number, i);
446 if (fixup_options(td))
449 if (td->io_ops->flags & FIO_DISKLESSIO) {
452 for_each_file(td, f, i)
453 f->real_file_size = -1ULL;
456 td->mutex = fio_sem_init(0);
458 td->ts.clat_stat[0].min_val = td->ts.clat_stat[1].min_val = ULONG_MAX;
459 td->ts.slat_stat[0].min_val = td->ts.slat_stat[1].min_val = ULONG_MAX;
460 td->ts.bw_stat[0].min_val = td->ts.bw_stat[1].min_val = ULONG_MAX;
461 td->ddir_nr = td->o.ddir_nr;
463 if ((td->o.stonewall || td->o.numjobs > 1 || td->o.new_group)
464 && prev_group_jobs) {
469 td->groupid = groupid;
472 if (init_random_state(td))
478 if (td->o.write_lat_log) {
479 setup_log(&td->ts.slat_log);
480 setup_log(&td->ts.clat_log);
482 if (td->o.write_bw_log)
483 setup_log(&td->ts.bw_log);
486 td->o.name = strdup(jobname);
490 if (!strcmp(td->io_ops->name, "cpuio"))
491 log_info("%s: ioengine=cpu, cpuload=%u, cpucycle=%u\n", td->o.name, td->o.cpuload, td->o.cpucycle);
493 char *c1, *c2, *c3, *c4;
495 c1 = to_kmg(td->o.min_bs[DDIR_READ]);
496 c2 = to_kmg(td->o.max_bs[DDIR_READ]);
497 c3 = to_kmg(td->o.min_bs[DDIR_WRITE]);
498 c4 = to_kmg(td->o.max_bs[DDIR_WRITE]);
500 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);
507 } else if (job_add_num == 1)
512 * recurse add identical jobs, clear numjobs and stonewall options
513 * as they don't apply to sub-jobs
515 numjobs = td->o.numjobs;
517 struct thread_data *td_new = get_new_job(0, td);
522 td_new->o.numjobs = 1;
523 td_new->o.stonewall = 0;
524 td_new->o.new_group = 0;
527 td_new->o.filename = NULL;
528 td_new->files_index = 0;
529 td_new->files = NULL;
532 job_add_num = numjobs - 1;
534 if (add_job(td_new, jobname, job_add_num))
544 static int is_empty_or_comment(char *line)
548 for (i = 0; i < strlen(line); i++) {
553 if (!isspace(line[i]) && !iscntrl(line[i]))
561 * This is our [ini] type file parser.
563 static int parse_jobs_ini(char *file, int stonewall_flag)
566 struct thread_data *td;
570 int ret = 0, stonewall;
574 if (!strcmp(file, "-"))
577 f = fopen(file, "r");
580 perror("fopen job file");
584 string = malloc(4096);
587 * it's really 256 + small bit, 280 should suffice
590 memset(name, 0, 280);
592 stonewall = stonewall_flag;
595 * if skip_fgets is set, we already have loaded a line we
599 p = fgets(string, 4095, f);
605 strip_blank_front(&p);
608 if (is_empty_or_comment(p))
610 if (sscanf(p, "[%255s]", name) != 1) {
611 log_err("fio: option <%s> outside of [] job section\n", p);
615 global = !strncmp(name, "global", 6);
617 name[strlen(name) - 1] = '\0';
623 log_info("--name=%s ", name);
627 td = get_new_job(global, &def_thread);
634 * Seperate multiple job files by a stonewall
636 if (!global && stonewall) {
637 td->o.stonewall = stonewall;
641 while ((p = fgets(string, 4096, f)) != NULL) {
642 if (is_empty_or_comment(p))
645 strip_blank_front(&p);
648 * new section, break out and make sure we don't
649 * fgets() a new line at the top.
659 * Don't break here, continue parsing options so we
660 * dump all the bad ones. Makes trial/error fixups
661 * easier on the user.
663 ret |= fio_option_parse(td, p);
664 if (!ret && dump_cmdline)
665 log_info("--%s ", p);
669 ret = add_job(td, name, 0);
671 log_err("fio: job %s dropped\n", name);
686 static int fill_def_thread(void)
688 memset(&def_thread, 0, sizeof(def_thread));
690 fio_getaffinity(getpid(), &def_thread.o.cpumask);
693 * fill default options
695 fio_fill_default_options(&def_thread);
697 def_thread.o.timeout = def_timeout;
698 def_thread.o.write_bw_log = write_bw_log;
699 def_thread.o.write_lat_log = write_lat_log;
704 static void free_shm(void)
706 struct shmid_ds sbuf;
709 shmdt((void *) threads);
711 shmctl(shm_id, IPC_RMID, &sbuf);
716 * The thread area is shared between the main process and the job
717 * threads/processes. So setup a shared memory segment that will hold
720 static int setup_thread_area(void)
723 * 1024 is too much on some machines, scale max_jobs if
724 * we get a failure that looks like too large a shm segment
727 size_t size = max_jobs * sizeof(struct thread_data);
729 shm_id = shmget(0, size, IPC_CREAT | 0600);
732 if (errno != EINVAL) {
743 threads = shmat(shm_id, NULL, 0);
744 if (threads == (void *) -1) {
749 memset(threads, 0, max_jobs * sizeof(struct thread_data));
754 static void usage(void)
756 printf("%s\n", fio_version_string);
757 printf("\t--output\tWrite output to file\n");
758 printf("\t--timeout\tRuntime in seconds\n");
759 printf("\t--latency-log\tGenerate per-job latency logs\n");
760 printf("\t--bandwidth-log\tGenerate per-job bandwidth logs\n");
761 printf("\t--minimal\tMinimal (terse) output\n");
762 printf("\t--version\tPrint version info and exit\n");
763 printf("\t--help\t\tPrint this page\n");
764 printf("\t--cmdhelp=cmd\tPrint command help, \"all\" for all of them\n");
765 printf("\t--showcmd\tTurn a job file into command line options\n");
766 printf("\t--eta=when\tWhen ETA estimate should be printed\n");
767 printf("\t \tMay be \"always\", \"never\" or \"auto\"\n");
770 static int parse_cmd_line(int argc, char *argv[])
772 struct thread_data *td = NULL;
773 int c, ini_idx = 0, lidx, ret, dont_add_job = 0;
775 while ((c = getopt_long_only(argc, argv, "", long_options, &lidx)) != -1) {
778 def_timeout = atoi(optarg);
787 f_out = fopen(optarg, "w+");
789 perror("fopen output");
801 exit(fio_show_option_help(optarg));
809 printf("%s\n", fio_version_string);
812 if (!strcmp("always", optarg))
813 eta_print = FIO_ETA_ALWAYS;
814 else if (!strcmp("never", optarg))
815 eta_print = FIO_ETA_NEVER;
817 case FIO_GETOPT_JOB: {
818 const char *opt = long_options[lidx].name;
821 if (!strncmp(opt, "name", 4) && td) {
822 ret = add_job(td, td->o.name ?: "fio", 0);
832 if (strncmp(opt, "name", 4) ||
833 !strncmp(val, "global", 6))
836 td = get_new_job(global, &def_thread);
841 ret = fio_cmd_option_parse(td, opt, val);
855 ret = add_job(td, td->o.name ?: "fio", 0);
861 while (optind < argc) {
863 ini_file = realloc(ini_file, ini_idx * sizeof(char *));
864 ini_file[ini_idx - 1] = strdup(argv[optind]);
872 int parse_options(int argc, char *argv[])
879 fio_options_dup_and_init(long_options);
881 if (setup_thread_area())
883 if (fill_def_thread())
886 job_files = parse_cmd_line(argc, argv);
888 for (i = 0; i < job_files; i++) {
889 if (fill_def_thread())
891 if (parse_jobs_ini(ini_file[i], i))
897 options_mem_free(&def_thread);
899 if (!thread_number) {
903 log_err("No jobs defined(s)\n");