2 * This file contains the ini and command liner parser. It will create
3 * and initialize the specified jobs.
14 #include <sys/types.h>
23 #define DEF_TIMEOUT (0)
24 #define DEF_RATE_CYCLE (1000)
25 #define DEF_ODIRECT (1)
26 #define DEF_IO_ENGINE (FIO_SYNCIO)
27 #define DEF_IO_ENGINE_NAME "sync"
28 #define DEF_SEQUENTIAL (1)
29 #define DEF_RAND_REPEAT (1)
30 #define DEF_OVERWRITE (1)
31 #define DEF_INVALIDATE (1)
32 #define DEF_SYNCIO (0)
33 #define DEF_RANDSEED (0xb1899bedUL)
34 #define DEF_BWAVGTIME (500)
35 #define DEF_CREATE_SER (1)
36 #define DEF_CREATE_FSYNC (1)
38 #define DEF_VERIFY (0)
39 #define DEF_STONEWALL (0)
40 #define DEF_NUMJOBS (1)
41 #define DEF_USE_THREAD (0)
42 #define DEF_FILE_SIZE (1024 * 1024 * 1024UL)
43 #define DEF_ZONE_SIZE (0)
44 #define DEF_ZONE_SKIP (0)
45 #define DEF_RWMIX_CYCLE (500)
46 #define DEF_RWMIX_READ (50)
48 #define DEF_NR_FILES (1)
49 #define DEF_UNLINK (0)
51 static int def_timeout = DEF_TIMEOUT;
53 static char fio_version_string[] = "fio 1.5";
55 static char **ini_file;
56 static int max_jobs = MAX_JOBS;
58 struct thread_data def_thread;
59 struct thread_data *threads = NULL;
62 int write_lat_log = 0;
64 int exitall_on_terminate = 0;
66 unsigned long long mlock_size = 0;
71 * Return a free job structure.
73 static struct thread_data *get_new_job(int global, struct thread_data *parent)
75 struct thread_data *td;
79 if (thread_number >= max_jobs)
82 td = &threads[thread_number++];
86 td->thread_number = thread_number;
90 static void put_job(struct thread_data *td)
92 memset(&threads[td->thread_number - 1], 0, sizeof(*td));
97 * Adds a job to the list of things todo. Sanitizes the various options
98 * to make sure we don't have conflicts, and initializes various
101 static int add_job(struct thread_data *td, const char *jobname, int job_add_num)
103 char *ddir_str[] = { "read", "write", "randread", "randwrite",
104 "rw", NULL, "randrw" };
106 int numjobs, ddir, i;
109 #ifndef FIO_HAVE_LIBAIO
110 if (td->io_engine == FIO_LIBAIO) {
111 log_err("Linux libaio not available\n");
115 #ifndef FIO_HAVE_POSIXAIO
116 if (td->io_engine == FIO_POSIXAIO) {
117 log_err("posix aio not available\n");
123 * the def_thread is just for options, it's not a real job
125 if (td == &def_thread)
129 * Set default io engine, if none set
132 td->io_ops = load_ioengine(td, DEF_IO_ENGINE_NAME);
134 log_err("default engine %s not there?\n", DEF_IO_ENGINE_NAME);
139 if (td->io_ops->flags & FIO_SYNCIO)
143 td->iodepth = td->nr_files;
147 * only really works for sequential io for now, and with 1 file
149 if (td->zone_size && !td->sequential && td->nr_files == 1)
153 * Reads can do overwrites, we always need to pre-create the file
155 if (td_read(td) || td_rw(td))
158 td->filetype = FIO_TYPE_FILE;
159 if (!stat(jobname, &sb)) {
160 if (S_ISBLK(sb.st_mode))
161 td->filetype = FIO_TYPE_BD;
162 else if (S_ISCHR(sb.st_mode))
163 td->filetype = FIO_TYPE_CHAR;
167 td->io_ops->flags |= FIO_RAWIO;
169 if (td->filetype == FIO_TYPE_FILE) {
174 if (td->directory && td->directory[0] != '\0')
175 sprintf(tmp, "%s/", td->directory);
177 td->files = malloc(sizeof(struct fio_file) * td->nr_files);
179 for_each_file(td, f, i) {
180 memset(f, 0, sizeof(*f));
184 sprintf(tmp + len, "%s.%d.%d", jobname, td->thread_number, i);
185 f->file_name = strdup(tmp);
189 td->files = malloc(sizeof(struct fio_file));
192 memset(f, 0, sizeof(*f));
194 f->file_name = strdup(jobname);
197 for_each_file(td, f, i) {
198 f->file_size = td->total_file_size / td->nr_files;
199 f->file_offset = td->start_offset;
202 fio_sem_init(&td->mutex, 0);
204 td->clat_stat[0].min_val = td->clat_stat[1].min_val = ULONG_MAX;
205 td->slat_stat[0].min_val = td->slat_stat[1].min_val = ULONG_MAX;
206 td->bw_stat[0].min_val = td->bw_stat[1].min_val = ULONG_MAX;
208 if (td->min_bs == -1U)
210 if (td->max_bs == -1U)
212 if (td_read(td) && !td_rw(td))
215 if (td->stonewall && td->thread_number > 1)
218 td->groupid = groupid;
224 setup_log(&td->slat_log);
225 setup_log(&td->clat_log);
228 setup_log(&td->bw_log);
230 if (td->name[0] == '\0')
231 snprintf(td->name, sizeof(td->name)-1, "client%d", td->thread_number);
233 ddir = td->ddir + (!td->sequential << 1) + (td->iomix << 2);
237 if (td->io_ops->flags & FIO_CPUIO)
238 fprintf(f_out, "%s: ioengine=cpu, cpuload=%u, cpucycle=%u\n", td->name, td->cpuload, td->cpucycle);
240 fprintf(f_out, "%s: (g=%d): rw=%s, odir=%d, bs=%d-%d, rate=%d, ioengine=%s, iodepth=%d\n", td->name, td->groupid, ddir_str[ddir], td->odirect, td->min_bs, td->max_bs, td->rate, td->io_ops->name, td->iodepth);
241 } else if (job_add_num == 1)
242 fprintf(f_out, "...\n");
246 * recurse add identical jobs, clear numjobs and stonewall options
247 * as they don't apply to sub-jobs
249 numjobs = td->numjobs;
251 struct thread_data *td_new = get_new_job(0, td);
257 td_new->stonewall = 0;
258 job_add_num = numjobs - 1;
260 if (add_job(td_new, jobname, job_add_num))
270 * Initialize the various random states we need (random io, block size ranges,
271 * read/write mix, etc).
273 int init_random_state(struct thread_data *td)
275 unsigned long seeds[4];
276 int fd, num_maps, blocks, i;
279 fd = open("/dev/urandom", O_RDONLY);
281 td_verror(td, errno);
285 if (read(fd, seeds, sizeof(seeds)) < (int) sizeof(seeds)) {
293 os_random_seed(seeds[0], &td->bsrange_state);
294 os_random_seed(seeds[1], &td->verify_state);
295 os_random_seed(seeds[2], &td->rwmix_state);
300 if (td->rand_repeatable)
301 seeds[3] = DEF_RANDSEED;
303 for_each_file(td, f, i) {
304 blocks = (f->file_size + td->min_bs - 1) / td->min_bs;
305 num_maps = blocks / BLOCKS_PER_MAP;
306 f->file_map = malloc(num_maps * sizeof(long));
307 f->num_maps = num_maps;
308 memset(f->file_map, 0, num_maps * sizeof(long));
311 os_random_seed(seeds[3], &td->random_state);
315 static void fill_cpu_mask(os_cpu_mask_t cpumask, int cpu)
317 #ifdef FIO_HAVE_CPU_AFFINITY
322 for (i = 0; i < sizeof(int) * 8; i++) {
324 CPU_SET(i, &cpumask);
329 static unsigned long get_mult_time(char c)
346 static unsigned long get_mult_bytes(char c)
357 return 1024 * 1024 * 1024;
364 * convert string after '=' into decimal value, noting any size suffix
366 static int str_to_decimal(char *p, unsigned long long *val, int kilo)
371 str = strchr(p, '=');
378 *val = strtoul(str, NULL, 10);
379 if (*val == ULONG_MAX && errno == ERANGE)
383 *val *= get_mult_bytes(str[len - 1]);
385 *val *= get_mult_time(str[len - 1]);
389 static int check_str_bytes(char *p, char *name, unsigned long long *val)
391 if (strncmp(p, name, strlen(name) - 1))
394 return str_to_decimal(p, val, 1);
397 static int check_str_time(char *p, char *name, unsigned long long *val)
399 if (strncmp(p, name, strlen(name) - 1))
402 return str_to_decimal(p, val, 0);
405 static void strip_blank_front(char **p)
413 static void strip_blank_end(char *p)
415 char *s = p + strlen(p) - 1;
417 while (isspace(*s) || iscntrl(*s))
423 typedef int (str_cb_fn)(struct thread_data *, char *);
425 static int check_str(char *p, char *name, str_cb_fn *cb, struct thread_data *td)
429 if (strncmp(p, name, strlen(name)))
441 strip_blank_front(&s);
445 static int check_strstore(char *p, char *name, char *dest)
449 if (strncmp(p, name, strlen(name)))
461 strip_blank_front(&s);
467 static int __check_range_bytes(char *str, unsigned long *val)
471 if (sscanf(str, "%lu%c", val, &suffix) == 2) {
472 *val *= get_mult_bytes(suffix);
476 if (sscanf(str, "%lu", val) == 1)
482 static int check_range_bytes(char *p, char *name, unsigned long *s,
488 if (strncmp(p, name, strlen(name)))
494 str = strstr(p, name);
500 str = strchr(p, '=');
505 * 'p' now holds whatever is after the '=' sign
510 * terminate p1 at the '-' sign
519 if (!__check_range_bytes(p1, s) && !__check_range_bytes(p2, e))
525 static int check_int(char *p, char *name, unsigned int *val)
529 if (strncmp(p, name, strlen(name)))
532 str = strstr(p, name);
536 str = strchr(p, '=');
542 if (sscanf(str, "%u", val) == 1)
548 static int check_strset(char *p, char *name)
550 return strncmp(p, name, strlen(name));
553 static int is_empty_or_comment(char *line)
557 for (i = 0; i < strlen(line); i++) {
560 if (!isspace(line[i]) && !iscntrl(line[i]))
567 static int str_rw_cb(struct thread_data *td, char *mem)
569 if (!strncmp(mem, "read", 4) || !strncmp(mem, "0", 1)) {
570 td->ddir = DDIR_READ;
573 } else if (!strncmp(mem, "randread", 8)) {
574 td->ddir = DDIR_READ;
577 } else if (!strncmp(mem, "write", 5) || !strncmp(mem, "1", 1)) {
578 td->ddir = DDIR_WRITE;
581 } else if (!strncmp(mem, "randwrite", 9)) {
582 td->ddir = DDIR_WRITE;
585 } else if (!strncmp(mem, "rw", 2)) {
590 } else if (!strncmp(mem, "randrw", 6)) {
597 log_err("fio: data direction: read, write, randread, randwrite, rw, randrw\n");
601 static int str_verify_cb(struct thread_data *td, char *mem)
603 if (!strncmp(mem, "0", 1)) {
604 td->verify = VERIFY_NONE;
606 } else if (!strncmp(mem, "md5", 3) || !strncmp(mem, "1", 1)) {
607 td->verify = VERIFY_MD5;
609 } else if (!strncmp(mem, "crc32", 5)) {
610 td->verify = VERIFY_CRC32;
614 log_err("fio: verify types: md5, crc32\n");
618 static int str_mem_cb(struct thread_data *td, char *mem)
620 if (!strncmp(mem, "malloc", 6)) {
621 td->mem_type = MEM_MALLOC;
623 } else if (!strncmp(mem, "shm", 3)) {
624 td->mem_type = MEM_SHM;
626 } else if (!strncmp(mem, "mmap", 4)) {
627 td->mem_type = MEM_MMAP;
631 log_err("fio: mem type: malloc, shm, mmap\n");
635 static int str_ioengine_cb(struct thread_data *td, char *str)
637 td->io_ops = load_ioengine(td, str);
641 log_err("fio: ioengine: { linuxaio, aio, libaio }, posixaio, sync, mmap, sgio, splice, cpu\n");
646 * This is our [ini] type file parser.
648 int parse_jobs_ini(char *file, int stonewall_flag)
650 unsigned int prioclass, prio, cpu, global, il;
651 unsigned long long ull;
652 unsigned long ul1, ul2;
653 struct thread_data *td;
654 char *string, *name, *tmpbuf;
658 int ret = 0, stonewall;
660 f = fopen(file, "r");
662 perror("fopen job file");
666 string = malloc(4096);
668 tmpbuf = malloc(4096);
670 stonewall = stonewall_flag;
671 while ((p = fgets(string, 4096, f)) != NULL) {
674 if (is_empty_or_comment(p))
676 if (sscanf(p, "[%s]", name) != 1)
679 global = !strncmp(name, "global", 6);
681 name[strlen(name) - 1] = '\0';
683 td = get_new_job(global, &def_thread);
690 * Seperate multiple job files by a stonewall
692 if (!global && stonewall) {
693 td->stonewall = stonewall;
698 while ((p = fgets(string, 4096, f)) != NULL) {
699 if (is_empty_or_comment(p))
703 strip_blank_front(&p);
706 if (!check_int(p, "prio", &prio)) {
707 #ifndef FIO_HAVE_IOPRIO
708 log_err("io priorities not available\n");
716 if (!check_int(p, "prioclass", &prioclass)) {
717 #ifndef FIO_HAVE_IOPRIO
718 log_err("io priorities not available\n");
722 td->ioprio |= prioclass << IOPRIO_CLASS_SHIFT;
727 if (!check_int(p, "direct", &il)) {
732 if (!check_int(p, "rand_repeatable", &il)) {
733 td->rand_repeatable = il;
737 if (!check_int(p, "rate", &td->rate)) {
741 if (!check_int(p, "ratemin", &td->ratemin)) {
745 if (!check_int(p, "ratecycle", &td->ratecycle)) {
749 if (!check_int(p, "cpuload", &td->cpuload)) {
753 if (!check_int(p, "cpuchunks", &td->cpucycle)) {
757 if (!check_int(p, "thinktime", &td->thinktime)) {
761 if (!check_int(p, "cpumask", &cpu)) {
762 #ifndef FIO_HAVE_CPU_AFFINITY
763 log_err("cpu affinity not available\n");
767 fill_cpu_mask(td->cpumask, cpu);
771 if (!check_int(p, "fsync", &td->fsync_blocks)) {
776 if (!check_int(p, "startdelay", &td->start_delay)) {
780 if (!check_str_time(p, "timeout", &ull)) {
785 if (!check_int(p, "invalidate", &il)) {
786 td->invalidate_cache = il;
790 if (!check_int(p, "iodepth", &td->iodepth)) {
794 if (!check_int(p, "sync", &il)) {
799 if (!check_int(p, "bwavgtime", &td->bw_avg_time)) {
803 if (!check_int(p, "create_serialize", &il)) {
804 td->create_serialize = il;
808 if (!check_int(p, "create_fsync", &il)) {
809 td->create_fsync = il;
813 if (!check_int(p, "end_fsync", &il)) {
818 if (!check_int(p, "loops", &td->loops)) {
822 if (!check_int(p, "numjobs", &td->numjobs)) {
826 if (!check_int(p, "overwrite", &il)) {
831 if (!check_int(p, "rwmixcycle", &td->rwmixcycle)) {
835 if (!check_int(p, "rwmixread", &il)) {
842 if (!check_int(p, "rwmixwrite", &il)) {
845 td->rwmixread = 100 - il;
849 if (!check_int(p, "nice", &td->nice)) {
853 if (!check_int(p, "nrfiles", &td->nr_files)) {
857 if (!check_range_bytes(p, "bsrange", &ul1, &ul2)) {
868 if (!check_str_bytes(p, "bs", &ull)) {
873 if (!check_str_bytes(p, "size", &td->total_file_size)) {
877 if (!check_str_bytes(p, "offset", &td->start_offset)) {
881 if (!check_str_bytes(p, "zonesize", &td->zone_size)) {
885 if (!check_str_bytes(p, "zoneskip", &td->zone_skip)) {
889 if (!check_str_bytes(p, "lockmem", &mlock_size)) {
893 if (!check_strstore(p, "directory", tmpbuf)) {
894 td->directory = strdup(tmpbuf);
898 if (!check_strstore(p, "name", tmpbuf)) {
899 snprintf(td->name, sizeof(td->name)-1, "%s%d", tmpbuf, td->thread_number);
903 if (!check_str(p, "mem", str_mem_cb, td)) {
907 if (!check_str(p, "verify", str_verify_cb, td)) {
911 if (!check_str(p, "rw", str_rw_cb, td)) {
915 if (!check_str(p, "ioengine", str_ioengine_cb, td)) {
919 if (!check_strset(p, "exitall")) {
920 exitall_on_terminate = 1;
924 if (!check_strset(p, "stonewall")) {
929 if (!check_strset(p, "thread")) {
934 if (!check_strset(p, "unlink")) {
939 if (!check_strstore(p, "iolog", tmpbuf)) {
940 if (td->write_iolog) {
941 log_err("fio: read iolog overrides given write_iolog\n");
942 free(td->iolog_file);
945 td->iolog_file = strdup(tmpbuf);
950 if (!check_strstore(p, "write_iolog", tmpbuf)) {
951 if (!td->read_iolog) {
952 td->iolog_file = strdup(tmpbuf);
955 log_err("fio: read iolog overrides given write_iolog\n");
959 if (!check_strstore(p, "exec_prerun", tmpbuf)) {
960 td->exec_prerun = strdup(tmpbuf);
964 if (!check_strstore(p, "exec_postrun", tmpbuf)) {
965 td->exec_postrun = strdup(tmpbuf);
969 if (!check_strstore(p, "ioscheduler", tmpbuf)) {
970 #ifndef FIO_HAVE_IOSCHED_SWITCH
971 log_err("io scheduler switching not available\n");
975 td->ioscheduler = strdup(tmpbuf);
982 * Don't break here, continue parsing options so we
983 * dump all the bad ones. Makes trial/error fixups
984 * easier on the user.
986 printf("Client%d: bad option %s\n",td->thread_number,p);
992 ret = add_job(td, name, 0);
1005 static int fill_def_thread(void)
1007 memset(&def_thread, 0, sizeof(def_thread));
1009 if (fio_getaffinity(getpid(), &def_thread.cpumask) == -1) {
1010 perror("sched_getaffinity");
1017 def_thread.ddir = DDIR_READ;
1018 def_thread.iomix = 0;
1019 def_thread.bs = DEF_BS;
1020 def_thread.min_bs = -1;
1021 def_thread.max_bs = -1;
1022 def_thread.odirect = DEF_ODIRECT;
1023 def_thread.ratecycle = DEF_RATE_CYCLE;
1024 def_thread.sequential = DEF_SEQUENTIAL;
1025 def_thread.timeout = def_timeout;
1026 def_thread.overwrite = DEF_OVERWRITE;
1027 def_thread.invalidate_cache = DEF_INVALIDATE;
1028 def_thread.sync_io = DEF_SYNCIO;
1029 def_thread.mem_type = MEM_MALLOC;
1030 def_thread.bw_avg_time = DEF_BWAVGTIME;
1031 def_thread.create_serialize = DEF_CREATE_SER;
1032 def_thread.create_fsync = DEF_CREATE_FSYNC;
1033 def_thread.loops = DEF_LOOPS;
1034 def_thread.verify = DEF_VERIFY;
1035 def_thread.stonewall = DEF_STONEWALL;
1036 def_thread.numjobs = DEF_NUMJOBS;
1037 def_thread.use_thread = DEF_USE_THREAD;
1038 def_thread.rwmixcycle = DEF_RWMIX_CYCLE;
1039 def_thread.rwmixread = DEF_RWMIX_READ;
1040 def_thread.nice = DEF_NICE;
1041 def_thread.rand_repeatable = DEF_RAND_REPEAT;
1042 def_thread.nr_files = DEF_NR_FILES;
1043 def_thread.unlink = DEF_UNLINK;
1044 #ifdef FIO_HAVE_DISK_UTIL
1045 def_thread.do_disk_util = 1;
1051 static void usage(void)
1053 printf("%s\n", fio_version_string);
1054 printf("\t-o Write output to file\n");
1055 printf("\t-t Runtime in seconds\n");
1056 printf("\t-l Generate per-job latency logs\n");
1057 printf("\t-w Generate per-job bandwidth logs\n");
1058 printf("\t-m Minimal (terse) output\n");
1059 printf("\t-v Print version info and exit\n");
1062 static int parse_cmd_line(int argc, char *argv[])
1064 int c, idx = 1, ini_idx = 0;
1066 while ((c = getopt(argc, argv, "t:o:lwvhm")) != EOF) {
1069 def_timeout = atoi(optarg);
1081 f_out = fopen(optarg, "w+");
1083 perror("fopen output");
1097 printf("%s\n", fio_version_string);
1102 while (idx < argc) {
1104 ini_file = realloc(ini_file, ini_idx * sizeof(char *));
1105 ini_file[ini_idx - 1] = strdup(argv[idx]);
1117 static void free_shm(void)
1119 struct shmid_ds sbuf;
1122 shmdt((void *) threads);
1124 shmctl(shm_id, IPC_RMID, &sbuf);
1129 * The thread area is shared between the main process and the job
1130 * threads/processes. So setup a shared memory segment that will hold
1133 static int setup_thread_area(void)
1136 * 1024 is too much on some machines, scale max_jobs if
1137 * we get a failure that looks like too large a shm segment
1140 size_t size = max_jobs * sizeof(struct thread_data);
1142 shm_id = shmget(0, size, IPC_CREAT | 0600);
1145 if (errno != EINVAL) {
1156 threads = shmat(shm_id, NULL, 0);
1157 if (threads == (void *) -1) {
1166 int parse_options(int argc, char *argv[])
1170 if (setup_thread_area())
1172 if (fill_def_thread())
1175 job_files = parse_cmd_line(argc, argv);
1177 log_err("Need job file(s)\n");
1182 for (i = 0; i < job_files; i++) {
1183 if (fill_def_thread())
1185 if (parse_jobs_ini(ini_file[i], i))