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;
40 static int def_timeout = 0;
41 static int write_lat_log = 0;
43 static int prev_group_jobs;
46 * Command line options. These will contain the above, plus a few
47 * extra that only pertain to fio itself and not jobs.
49 static struct option long_options[FIO_NR_OPTIONS] = {
52 .has_arg = required_argument,
57 .has_arg = required_argument,
61 .name = "latency-log",
62 .has_arg = required_argument,
66 .name = "bandwidth-log",
67 .has_arg = required_argument,
72 .has_arg = optional_argument,
77 .has_arg = no_argument,
82 .has_arg = no_argument,
87 .has_arg = optional_argument,
92 .has_arg = no_argument,
97 .has_arg = no_argument,
116 * Return a free job structure.
118 static struct thread_data *get_new_job(int global, struct thread_data *parent)
120 struct thread_data *td;
124 if (thread_number >= max_jobs)
127 td = &threads[thread_number++];
130 dup_files(td, parent);
131 options_mem_dupe(td);
133 td->thread_number = thread_number;
137 static void put_job(struct thread_data *td)
139 if (td == &def_thread)
143 log_info("fio: %s\n", td->verror);
145 memset(&threads[td->thread_number - 1], 0, sizeof(*td));
149 static int setup_rate(struct thread_data *td)
151 unsigned long nr_reads_per_msec;
152 unsigned long long rate;
155 if (!td->o.rate && !td->o.rate_iops)
159 bs = td->o.rw_min_bs;
160 else if (td_read(td))
161 bs = td->o.min_bs[DDIR_READ];
163 bs = td->o.min_bs[DDIR_WRITE];
167 nr_reads_per_msec = (rate * 1024 * 1000LL) / bs;
169 nr_reads_per_msec = td->o.rate_iops * 1000UL;
171 if (!nr_reads_per_msec) {
172 log_err("rate lower than supported\n");
176 td->rate_usec_cycle = 1000000000ULL / nr_reads_per_msec;
177 td->rate_pending_usleep = 0;
182 * Lazy way of fixing up options that depend on each other. We could also
183 * define option callback handlers, but this is easier.
185 static int fixup_options(struct thread_data *td)
187 struct thread_options *o = &td->o;
189 if (read_only && td_write(td)) {
190 log_err("fio: job <%s> has write bit set, but fio is in read-only mode\n", td->o.name);
194 if (o->rwmix[DDIR_READ] + o->rwmix[DDIR_WRITE] > 100)
195 o->rwmix[DDIR_WRITE] = 100 - o->rwmix[DDIR_READ];
197 if (o->write_iolog_file && o->read_iolog_file) {
198 log_err("fio: read iolog overrides write_iolog\n");
199 free(o->write_iolog_file);
200 o->write_iolog_file = NULL;
203 if (td->io_ops->flags & FIO_SYNCIO)
207 o->iodepth = o->open_files;
211 * only really works for sequential io for now, and with 1 file
213 if (o->zone_size && td_random(td) && o->open_files == 1)
217 * Reads can do overwrites, we always need to pre-create the file
219 if (td_read(td) || td_rw(td))
222 if (!o->min_bs[DDIR_READ])
223 o->min_bs[DDIR_READ]= o->bs[DDIR_READ];
224 if (!o->max_bs[DDIR_READ])
225 o->max_bs[DDIR_READ] = o->bs[DDIR_READ];
226 if (!o->min_bs[DDIR_WRITE])
227 o->min_bs[DDIR_WRITE]= o->bs[DDIR_WRITE];
228 if (!o->max_bs[DDIR_WRITE])
229 o->max_bs[DDIR_WRITE] = o->bs[DDIR_WRITE];
231 o->rw_min_bs = min(o->min_bs[DDIR_READ], o->min_bs[DDIR_WRITE]);
233 if (!o->file_size_high)
234 o->file_size_high = o->file_size_low;
236 if (o->norandommap && o->verify != VERIFY_NONE) {
237 log_err("fio: norandommap given, verify disabled\n");
238 o->verify = VERIFY_NONE;
240 if (o->bs_unaligned && (o->odirect || td->io_ops->flags & FIO_RAWIO))
241 log_err("fio: bs_unaligned may not work with raw io\n");
244 * thinktime_spin must be less than thinktime
246 if (o->thinktime_spin > o->thinktime)
247 o->thinktime_spin = o->thinktime;
250 * The low water mark cannot be bigger than the iodepth
252 if (o->iodepth_low > o->iodepth || !o->iodepth_low) {
254 * syslet work around - if the workload is sequential,
255 * we want to let the queue drain all the way down to
256 * avoid seeking between async threads
258 if (!strcmp(td->io_ops->name, "syslet-rw") && !td_random(td))
261 o->iodepth_low = o->iodepth;
265 * If batch number isn't set, default to the same as iodepth
267 if (o->iodepth_batch > o->iodepth || !o->iodepth_batch)
268 o->iodepth_batch = o->iodepth;
270 if (o->nr_files > td->files_index)
271 o->nr_files = td->files_index;
273 if (o->open_files > o->nr_files || !o->open_files)
274 o->open_files = o->nr_files;
276 if ((o->rate && o->rate_iops) || (o->ratemin && o->rate_iops_min)) {
277 log_err("fio: rate and rate_iops are mutually exclusive\n");
280 if ((o->rate < o->ratemin) || (o->rate_iops < o->rate_iops_min)) {
281 log_err("fio: minimum rate exceeds rate\n");
285 if (!o->timeout && o->time_based) {
286 log_err("fio: time_based requires a runtime/timeout setting\n");
294 * This function leaks the buffer
296 static char *to_kmg(unsigned int val)
298 char *buf = malloc(32);
299 char post[] = { 0, 'K', 'M', 'G', 'P', 'E', 0 };
310 snprintf(buf, 31, "%u%c", val, *p);
314 /* External engines are specified by "external:name.o") */
315 static const char *get_engine_name(const char *str)
317 char *p = strstr(str, ":");
323 strip_blank_front(&p);
328 static int exists_and_not_file(const char *filename)
332 if (lstat(filename, &sb) == -1)
335 if (S_ISREG(sb.st_mode))
342 * Initialize the various random states we need (random io, block size ranges,
343 * read/write mix, etc).
345 static int init_random_state(struct thread_data *td)
347 unsigned long seeds[6];
350 fd = open("/dev/urandom", O_RDONLY);
352 td_verror(td, errno, "open");
356 if (read(fd, seeds, sizeof(seeds)) < (int) sizeof(seeds)) {
357 td_verror(td, EIO, "read");
364 os_random_seed(seeds[0], &td->bsrange_state);
365 os_random_seed(seeds[1], &td->verify_state);
366 os_random_seed(seeds[2], &td->rwmix_state);
368 if (td->o.file_service_type == FIO_FSERVICE_RANDOM)
369 os_random_seed(seeds[3], &td->next_file_state);
371 os_random_seed(seeds[5], &td->file_size_state);
376 if (td->o.rand_repeatable)
377 seeds[4] = FIO_RANDSEED * td->thread_number;
379 os_random_seed(seeds[4], &td->random_state);
384 * Adds a job to the list of things todo. Sanitizes the various options
385 * to make sure we don't have conflicts, and initializes various
388 static int add_job(struct thread_data *td, const char *jobname, int job_add_num)
390 const char *ddir_str[] = { NULL, "read", "write", "rw", NULL,
391 "randread", "randwrite", "randrw" };
394 char fname[PATH_MAX];
395 int numjobs, file_alloced;
398 * the def_thread is just for options, it's not a real job
400 if (td == &def_thread)
404 * if we are just dumping the output command line, don't add the job
411 engine = get_engine_name(td->o.ioengine);
412 td->io_ops = load_ioengine(td, engine);
414 log_err("fio: failed to load engine %s\n", engine);
418 if (td->o.use_thread)
424 td->io_ops->flags |= FIO_RAWIO;
427 if (!td->o.filename && !td->files_index) {
430 if (td->o.nr_files == 1 && exists_and_not_file(jobname))
431 add_file(td, jobname);
433 for (i = 0; i < td->o.nr_files; i++) {
434 sprintf(fname, "%s.%d.%d", jobname, td->thread_number, i);
440 if (fixup_options(td))
443 if (td->io_ops->flags & FIO_DISKLESSIO) {
446 for_each_file(td, f, i)
447 f->real_file_size = -1ULL;
450 td->mutex = fio_sem_init(0);
452 td->ts.clat_stat[0].min_val = td->ts.clat_stat[1].min_val = ULONG_MAX;
453 td->ts.slat_stat[0].min_val = td->ts.slat_stat[1].min_val = ULONG_MAX;
454 td->ts.bw_stat[0].min_val = td->ts.bw_stat[1].min_val = ULONG_MAX;
455 td->ddir_nr = td->o.ddir_nr;
457 if ((td->o.stonewall || td->o.numjobs > 1 || td->o.new_group)
458 && prev_group_jobs) {
463 td->groupid = groupid;
466 if (init_random_state(td))
472 if (td->o.write_lat_log) {
473 setup_log(&td->ts.slat_log);
474 setup_log(&td->ts.clat_log);
476 if (td->o.write_bw_log)
477 setup_log(&td->ts.bw_log);
480 td->o.name = strdup(jobname);
484 if (!strcmp(td->io_ops->name, "cpuio"))
485 log_info("%s: ioengine=cpu, cpuload=%u, cpucycle=%u\n", td->o.name, td->o.cpuload, td->o.cpucycle);
487 char *c1, *c2, *c3, *c4;
489 c1 = to_kmg(td->o.min_bs[DDIR_READ]);
490 c2 = to_kmg(td->o.max_bs[DDIR_READ]);
491 c3 = to_kmg(td->o.min_bs[DDIR_WRITE]);
492 c4 = to_kmg(td->o.max_bs[DDIR_WRITE]);
494 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);
501 } else if (job_add_num == 1)
506 * recurse add identical jobs, clear numjobs and stonewall options
507 * as they don't apply to sub-jobs
509 numjobs = td->o.numjobs;
511 struct thread_data *td_new = get_new_job(0, td);
516 td_new->o.numjobs = 1;
517 td_new->o.stonewall = 0;
518 td_new->o.new_group = 0;
521 td_new->o.filename = NULL;
522 td_new->files_index = 0;
523 td_new->files = NULL;
526 job_add_num = numjobs - 1;
528 if (add_job(td_new, jobname, job_add_num))
538 static int is_empty_or_comment(char *line)
542 for (i = 0; i < strlen(line); i++) {
547 if (!isspace(line[i]) && !iscntrl(line[i]))
555 * This is our [ini] type file parser.
557 static int parse_jobs_ini(char *file, int stonewall_flag)
560 struct thread_data *td;
565 int ret = 0, stonewall;
568 f = fopen(file, "r");
570 perror("fopen job file");
574 string = malloc(4096);
577 * it's really 256 + small bit, 280 should suffice
580 memset(name, 0, 280);
582 stonewall = stonewall_flag;
584 p = fgets(string, 4095, f);
588 strip_blank_front(&p);
591 if (is_empty_or_comment(p))
593 if (sscanf(p, "[%255s]", name) != 1) {
594 log_err("fio: option <%s> outside of [] job section\n", p);
598 global = !strncmp(name, "global", 6);
600 name[strlen(name) - 1] = '\0';
606 log_info("--name=%s ", name);
610 td = get_new_job(global, &def_thread);
617 * Seperate multiple job files by a stonewall
619 if (!global && stonewall) {
620 td->o.stonewall = stonewall;
625 while ((p = fgets(string, 4096, f)) != NULL) {
626 if (is_empty_or_comment(p))
629 strip_blank_front(&p);
639 * Don't break here, continue parsing options so we
640 * dump all the bad ones. Makes trial/error fixups
641 * easier on the user.
643 ret |= fio_option_parse(td, p);
644 if (!ret && dump_cmdline)
645 log_info("--%s ", p);
650 ret = add_job(td, name, 0);
652 log_err("fio: job %s dropped\n", name);
666 static int fill_def_thread(void)
668 memset(&def_thread, 0, sizeof(def_thread));
670 fio_getaffinity(getpid(), &def_thread.o.cpumask);
673 * fill default options
675 fio_fill_default_options(&def_thread);
677 def_thread.o.timeout = def_timeout;
678 def_thread.o.write_bw_log = write_bw_log;
679 def_thread.o.write_lat_log = write_lat_log;
684 static void free_shm(void)
686 struct shmid_ds sbuf;
689 shmdt((void *) threads);
691 shmctl(shm_id, IPC_RMID, &sbuf);
696 * The thread area is shared between the main process and the job
697 * threads/processes. So setup a shared memory segment that will hold
700 static int setup_thread_area(void)
703 * 1024 is too much on some machines, scale max_jobs if
704 * we get a failure that looks like too large a shm segment
707 size_t size = max_jobs * sizeof(struct thread_data);
709 shm_id = shmget(0, size, IPC_CREAT | 0600);
712 if (errno != EINVAL) {
723 threads = shmat(shm_id, NULL, 0);
724 if (threads == (void *) -1) {
733 static void usage(void)
735 printf("%s\n", fio_version_string);
736 printf("\t--output\tWrite output to file\n");
737 printf("\t--timeout\tRuntime in seconds\n");
738 printf("\t--latency-log\tGenerate per-job latency logs\n");
739 printf("\t--bandwidth-log\tGenerate per-job bandwidth logs\n");
740 printf("\t--minimal\tMinimal (terse) output\n");
741 printf("\t--version\tPrint version info and exit\n");
742 printf("\t--help\t\tPrint this page\n");
743 printf("\t--cmdhelp=cmd\tPrint command help, \"all\" for all of them\n");
744 printf("\t--showcmd\tTurn a job file into command line options\n");
747 static int parse_cmd_line(int argc, char *argv[])
749 struct thread_data *td = NULL;
750 int c, ini_idx = 0, lidx, ret, dont_add_job = 0;
752 while ((c = getopt_long_only(argc, argv, "", long_options, &lidx)) != -1) {
755 def_timeout = atoi(optarg);
764 f_out = fopen(optarg, "w+");
766 perror("fopen output");
778 exit(fio_show_option_help(optarg));
786 printf("%s\n", fio_version_string);
788 case FIO_GETOPT_JOB: {
789 const char *opt = long_options[lidx].name;
792 if (!strncmp(opt, "name", 4) && td) {
793 ret = add_job(td, td->o.name ?: "fio", 0);
803 if (strncmp(opt, "name", 4) ||
804 !strncmp(val, "global", 6))
807 td = get_new_job(global, &def_thread);
812 ret = fio_cmd_option_parse(td, opt, val);
826 ret = add_job(td, td->o.name ?: "fio", 0);
832 while (optind < argc) {
834 ini_file = realloc(ini_file, ini_idx * sizeof(char *));
835 ini_file[ini_idx - 1] = strdup(argv[optind]);
843 int parse_options(int argc, char *argv[])
850 fio_options_dup_and_init(long_options);
852 if (setup_thread_area())
854 if (fill_def_thread())
857 job_files = parse_cmd_line(argc, argv);
859 for (i = 0; i < job_files; i++) {
860 if (fill_def_thread())
862 if (parse_jobs_ini(ini_file[i], i))
868 options_mem_free(&def_thread);
870 if (!thread_number) {
874 log_err("No jobs defined(s)\n");