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_CREATE (1)
32 #define DEF_INVALIDATE (1)
33 #define DEF_SYNCIO (0)
34 #define DEF_RANDSEED (0xb1899bedUL)
35 #define DEF_BWAVGTIME (500)
36 #define DEF_CREATE_SER (1)
37 #define DEF_CREATE_FSYNC (1)
39 #define DEF_VERIFY (0)
40 #define DEF_STONEWALL (0)
41 #define DEF_NUMJOBS (1)
42 #define DEF_USE_THREAD (0)
43 #define DEF_FILE_SIZE (1024 * 1024 * 1024UL)
44 #define DEF_ZONE_SIZE (0)
45 #define DEF_ZONE_SKIP (0)
46 #define DEF_RWMIX_CYCLE (500)
47 #define DEF_RWMIX_READ (50)
50 static int def_timeout = DEF_TIMEOUT;
52 static char fio_version_string[] = "fio 1.5";
54 static char **ini_file;
55 static int max_jobs = MAX_JOBS;
57 struct thread_data def_thread;
58 struct thread_data *threads = NULL;
61 int write_lat_log = 0;
63 int exitall_on_terminate = 0;
65 unsigned long long mlock_size = 0;
70 * Return a free job structure.
72 static struct thread_data *get_new_job(int global, struct thread_data *parent)
74 struct thread_data *td;
78 if (thread_number >= max_jobs)
81 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" };
108 #ifndef FIO_HAVE_LIBAIO
109 if (td->io_engine == FIO_LIBAIO) {
110 log_err("Linux libaio not available\n");
114 #ifndef FIO_HAVE_POSIXAIO
115 if (td->io_engine == FIO_POSIXAIO) {
116 log_err("posix aio not available\n");
122 * the def_thread is just for options, it's not a real job
124 if (td == &def_thread)
128 * Set default io engine, if none set
131 td->io_ops = load_ioengine(td, DEF_IO_ENGINE_NAME);
133 log_err("default engine %s not there?\n", DEF_IO_ENGINE_NAME);
138 if (td->io_ops->flags & FIO_SYNCIO)
146 * only really works for sequential io for now
148 if (td->zone_size && !td->sequential)
152 * Reads can do overwrites, we always need to pre-create the file
154 if (td_read(td) || td_rw(td))
157 td->filetype = FIO_TYPE_FILE;
158 if (!stat(jobname, &sb)) {
159 if (S_ISBLK(sb.st_mode))
160 td->filetype = FIO_TYPE_BD;
161 else if (S_ISCHR(sb.st_mode))
162 td->filetype = FIO_TYPE_CHAR;
165 if (td->filetype == FIO_TYPE_FILE) {
168 if (td->directory && td->directory[0] != '\0')
169 sprintf(tmp, "%s/%s.%d", td->directory, jobname, td->thread_number);
171 sprintf(tmp, "%s.%d", jobname, td->thread_number);
172 td->file_name = strdup(tmp);
174 td->file_name = strdup(jobname);
176 fio_sem_init(&td->mutex, 0);
178 td->clat_stat[0].min_val = td->clat_stat[1].min_val = ULONG_MAX;
179 td->slat_stat[0].min_val = td->slat_stat[1].min_val = ULONG_MAX;
180 td->bw_stat[0].min_val = td->bw_stat[1].min_val = ULONG_MAX;
182 if (td->min_bs == -1U)
184 if (td->max_bs == -1U)
186 if (td_read(td) && !td_rw(td))
189 if (td->stonewall && td->thread_number > 1)
192 td->groupid = groupid;
198 setup_log(&td->slat_log);
199 setup_log(&td->clat_log);
202 setup_log(&td->bw_log);
204 if (td->name[0] == '\0')
205 snprintf(td->name, sizeof(td->name)-1, "client%d", td->thread_number);
207 ddir = td->ddir + (!td->sequential << 1) + (td->iomix << 2);
211 if (td->io_ops->flags & FIO_CPUIO)
212 fprintf(f_out, "%s: ioengine=cpu, cpuload=%u, cpucycle=%u\n", td->name, td->cpuload, td->cpucycle);
214 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);
215 } else if (job_add_num == 1)
216 fprintf(f_out, "...\n");
220 * recurse add identical jobs, clear numjobs and stonewall options
221 * as they don't apply to sub-jobs
223 numjobs = td->numjobs;
225 struct thread_data *td_new = get_new_job(0, td);
231 td_new->stonewall = 0;
232 job_add_num = numjobs - 1;
234 if (add_job(td_new, jobname, job_add_num))
244 * Initialize the various random states we need (random io, block size ranges,
245 * read/write mix, etc).
247 int init_random_state(struct thread_data *td)
249 unsigned long seeds[4];
250 int fd, num_maps, blocks;
252 fd = open("/dev/urandom", O_RDONLY);
254 td_verror(td, errno);
258 if (read(fd, seeds, sizeof(seeds)) < (int) sizeof(seeds)) {
266 os_random_seed(seeds[0], &td->bsrange_state);
267 os_random_seed(seeds[1], &td->verify_state);
268 os_random_seed(seeds[2], &td->rwmix_state);
273 if (td->rand_repeatable)
274 seeds[3] = DEF_RANDSEED;
276 blocks = (td->io_size + td->min_bs - 1) / td->min_bs;
277 num_maps = blocks / BLOCKS_PER_MAP;
278 td->file_map = malloc(num_maps * sizeof(long));
279 td->num_maps = num_maps;
280 memset(td->file_map, 0, num_maps * sizeof(long));
282 os_random_seed(seeds[3], &td->random_state);
286 static void fill_cpu_mask(os_cpu_mask_t cpumask, int cpu)
288 #ifdef FIO_HAVE_CPU_AFFINITY
293 for (i = 0; i < sizeof(int) * 8; i++) {
295 CPU_SET(i, &cpumask);
300 static unsigned long get_mult_time(char c)
317 static unsigned long get_mult_bytes(char c)
328 return 1024 * 1024 * 1024;
335 * convert string after '=' into decimal value, noting any size suffix
337 static int str_to_decimal(char *p, unsigned long long *val, int kilo)
342 str = strchr(p, '=');
349 *val = strtoul(str, NULL, 10);
350 if (*val == ULONG_MAX && errno == ERANGE)
354 *val *= get_mult_bytes(str[len - 1]);
356 *val *= get_mult_time(str[len - 1]);
360 static int check_str_bytes(char *p, char *name, unsigned long long *val)
362 if (strncmp(p, name, strlen(name) - 1))
365 return str_to_decimal(p, val, 1);
368 static int check_str_time(char *p, char *name, unsigned long long *val)
370 if (strncmp(p, name, strlen(name) - 1))
373 return str_to_decimal(p, val, 0);
376 static void strip_blank_front(char **p)
384 static void strip_blank_end(char *p)
386 char *s = p + strlen(p) - 1;
388 while (isspace(*s) || iscntrl(*s))
394 typedef int (str_cb_fn)(struct thread_data *, char *);
396 static int check_str(char *p, char *name, str_cb_fn *cb, struct thread_data *td)
400 if (strncmp(p, name, strlen(name)))
412 strip_blank_front(&s);
416 static int check_strstore(char *p, char *name, char *dest)
420 if (strncmp(p, name, strlen(name)))
432 strip_blank_front(&s);
438 static int __check_range_bytes(char *str, unsigned long *val)
442 if (sscanf(str, "%lu%c", val, &suffix) == 2) {
443 *val *= get_mult_bytes(suffix);
447 if (sscanf(str, "%lu", val) == 1)
453 static int check_range_bytes(char *p, char *name, unsigned long *s,
459 if (strncmp(p, name, strlen(name)))
465 str = strstr(p, name);
471 str = strchr(p, '=');
476 * 'p' now holds whatever is after the '=' sign
481 * terminate p1 at the '-' sign
490 if (!__check_range_bytes(p1, s) && !__check_range_bytes(p2, e))
496 static int check_int(char *p, char *name, unsigned int *val)
500 if (strncmp(p, name, strlen(name)))
503 str = strstr(p, name);
507 str = strchr(p, '=');
513 if (sscanf(str, "%u", val) == 1)
519 static int check_strset(char *p, char *name)
521 return strncmp(p, name, strlen(name));
524 static int is_empty_or_comment(char *line)
528 for (i = 0; i < strlen(line); i++) {
531 if (!isspace(line[i]) && !iscntrl(line[i]))
538 static int str_rw_cb(struct thread_data *td, char *mem)
540 if (!strncmp(mem, "read", 4) || !strncmp(mem, "0", 1)) {
541 td->ddir = DDIR_READ;
544 } else if (!strncmp(mem, "randread", 8)) {
545 td->ddir = DDIR_READ;
548 } else if (!strncmp(mem, "write", 5) || !strncmp(mem, "1", 1)) {
549 td->ddir = DDIR_WRITE;
552 } else if (!strncmp(mem, "randwrite", 9)) {
553 td->ddir = DDIR_WRITE;
556 } else if (!strncmp(mem, "rw", 2)) {
561 } else if (!strncmp(mem, "randrw", 6)) {
568 log_err("fio: data direction: read, write, randread, randwrite, rw, randrw\n");
572 static int str_verify_cb(struct thread_data *td, char *mem)
574 if (!strncmp(mem, "0", 1)) {
575 td->verify = VERIFY_NONE;
577 } else if (!strncmp(mem, "md5", 3) || !strncmp(mem, "1", 1)) {
578 td->verify = VERIFY_MD5;
580 } else if (!strncmp(mem, "crc32", 5)) {
581 td->verify = VERIFY_CRC32;
585 log_err("fio: verify types: md5, crc32\n");
589 static int str_mem_cb(struct thread_data *td, char *mem)
591 if (!strncmp(mem, "malloc", 6)) {
592 td->mem_type = MEM_MALLOC;
594 } else if (!strncmp(mem, "shm", 3)) {
595 td->mem_type = MEM_SHM;
597 } else if (!strncmp(mem, "mmap", 4)) {
598 td->mem_type = MEM_MMAP;
602 log_err("fio: mem type: malloc, shm, mmap\n");
606 static int str_ioengine_cb(struct thread_data *td, char *str)
608 td->io_ops = load_ioengine(td, str);
612 log_err("fio: ioengine: { linuxaio, aio, libaio }, posixaio, sync, mmap, sgio, splice, cpu\n");
617 * This is our [ini] type file parser.
619 int parse_jobs_ini(char *file, int stonewall_flag)
621 unsigned int prioclass, prio, cpu, global, il;
622 unsigned long long ull;
623 unsigned long ul1, ul2;
624 struct thread_data *td;
625 char *string, *name, *tmpbuf;
629 int ret = 0, stonewall;
631 f = fopen(file, "r");
633 perror("fopen job file");
637 string = malloc(4096);
639 tmpbuf = malloc(4096);
641 stonewall = stonewall_flag;
642 while ((p = fgets(string, 4096, f)) != NULL) {
645 if (is_empty_or_comment(p))
647 if (sscanf(p, "[%s]", name) != 1)
650 global = !strncmp(name, "global", 6);
652 name[strlen(name) - 1] = '\0';
654 td = get_new_job(global, &def_thread);
661 * Seperate multiple job files by a stonewall
663 if (!global && stonewall) {
664 td->stonewall = stonewall;
669 while ((p = fgets(string, 4096, f)) != NULL) {
670 if (is_empty_or_comment(p))
674 strip_blank_front(&p);
677 if (!check_int(p, "prio", &prio)) {
678 #ifndef FIO_HAVE_IOPRIO
679 log_err("io priorities not available\n");
687 if (!check_int(p, "prioclass", &prioclass)) {
688 #ifndef FIO_HAVE_IOPRIO
689 log_err("io priorities not available\n");
693 td->ioprio |= prioclass << IOPRIO_CLASS_SHIFT;
698 if (!check_int(p, "direct", &il)) {
703 if (!check_int(p, "rand_repeatable", &il)) {
704 td->rand_repeatable = il;
708 if (!check_int(p, "rate", &td->rate)) {
712 if (!check_int(p, "ratemin", &td->ratemin)) {
716 if (!check_int(p, "ratecycle", &td->ratecycle)) {
720 if (!check_int(p, "cpuload", &td->cpuload)) {
724 if (!check_int(p, "cpuchunks", &td->cpucycle)) {
728 if (!check_int(p, "thinktime", &td->thinktime)) {
732 if (!check_int(p, "cpumask", &cpu)) {
733 #ifndef FIO_HAVE_CPU_AFFINITY
734 log_err("cpu affinity not available\n");
738 fill_cpu_mask(td->cpumask, cpu);
742 if (!check_int(p, "fsync", &td->fsync_blocks)) {
747 if (!check_int(p, "startdelay", &td->start_delay)) {
751 if (!check_str_time(p, "timeout", &ull)) {
756 if (!check_int(p, "invalidate", &il)) {
757 td->invalidate_cache = il;
761 if (!check_int(p, "iodepth", &td->iodepth)) {
765 if (!check_int(p, "sync", &il)) {
770 if (!check_int(p, "bwavgtime", &td->bw_avg_time)) {
774 if (!check_int(p, "create_serialize", &il)) {
775 td->create_serialize = il;
779 if (!check_int(p, "create_fsync", &il)) {
780 td->create_fsync = il;
784 if (!check_int(p, "end_fsync", &il)) {
789 if (!check_int(p, "loops", &td->loops)) {
793 if (!check_int(p, "numjobs", &td->numjobs)) {
797 if (!check_int(p, "overwrite", &il)) {
802 if (!check_int(p, "rwmixcycle", &td->rwmixcycle)) {
806 if (!check_int(p, "rwmixread", &il)) {
813 if (!check_int(p, "rwmixwrite", &il)) {
816 td->rwmixread = 100 - il;
820 if (!check_int(p, "nice", &td->nice)) {
824 if (!check_range_bytes(p, "bsrange", &ul1, &ul2)) {
835 if (!check_str_bytes(p, "bs", &ull)) {
840 if (!check_str_bytes(p, "size", &td->file_size)) {
844 if (!check_str_bytes(p, "offset", &td->file_offset)) {
848 if (!check_str_bytes(p, "zonesize", &td->zone_size)) {
852 if (!check_str_bytes(p, "zoneskip", &td->zone_skip)) {
856 if (!check_str_bytes(p, "lockmem", &mlock_size)) {
860 if (!check_strstore(p, "directory", tmpbuf)) {
861 td->directory = strdup(tmpbuf);
865 if (!check_strstore(p, "name", tmpbuf)) {
866 snprintf(td->name, sizeof(td->name)-1, "%s%d", tmpbuf, td->thread_number);
870 if (!check_str(p, "mem", str_mem_cb, td)) {
874 if (!check_str(p, "verify", str_verify_cb, td)) {
878 if (!check_str(p, "rw", str_rw_cb, td)) {
882 if (!check_str(p, "ioengine", str_ioengine_cb, td)) {
886 if (!check_strset(p, "create")) {
891 if (!check_strset(p, "exitall")) {
892 exitall_on_terminate = 1;
896 if (!check_strset(p, "stonewall")) {
901 if (!check_strset(p, "thread")) {
906 if (!check_strstore(p, "iolog", tmpbuf)) {
907 if (td->write_iolog) {
908 log_err("fio: read iolog overrides given write_iolog\n");
909 free(td->iolog_file);
912 td->iolog_file = strdup(tmpbuf);
917 if (!check_strstore(p, "write_iolog", tmpbuf)) {
918 if (!td->read_iolog) {
919 td->iolog_file = strdup(tmpbuf);
922 log_err("fio: read iolog overrides given write_iolog\n");
926 if (!check_strstore(p, "exec_prerun", tmpbuf)) {
927 td->exec_prerun = strdup(tmpbuf);
931 if (!check_strstore(p, "exec_postrun", tmpbuf)) {
932 td->exec_postrun = strdup(tmpbuf);
936 if (!check_strstore(p, "ioscheduler", tmpbuf)) {
937 #ifndef FIO_HAVE_IOSCHED_SWITCH
938 log_err("io scheduler switching not available\n");
942 td->ioscheduler = strdup(tmpbuf);
949 * Don't break here, continue parsing options so we
950 * dump all the bad ones. Makes trial/error fixups
951 * easier on the user.
953 printf("Client%d: bad option %s\n",td->thread_number,p);
959 ret = add_job(td, name, 0);
972 static int fill_def_thread(void)
974 memset(&def_thread, 0, sizeof(def_thread));
976 if (fio_getaffinity(getpid(), &def_thread.cpumask) == -1) {
977 perror("sched_getaffinity");
984 def_thread.ddir = DDIR_READ;
985 def_thread.iomix = 0;
986 def_thread.bs = DEF_BS;
987 def_thread.min_bs = -1;
988 def_thread.max_bs = -1;
989 def_thread.odirect = DEF_ODIRECT;
990 def_thread.ratecycle = DEF_RATE_CYCLE;
991 def_thread.sequential = DEF_SEQUENTIAL;
992 def_thread.timeout = def_timeout;
993 def_thread.create_file = DEF_CREATE;
994 def_thread.overwrite = DEF_OVERWRITE;
995 def_thread.invalidate_cache = DEF_INVALIDATE;
996 def_thread.sync_io = DEF_SYNCIO;
997 def_thread.mem_type = MEM_MALLOC;
998 def_thread.bw_avg_time = DEF_BWAVGTIME;
999 def_thread.create_serialize = DEF_CREATE_SER;
1000 def_thread.create_fsync = DEF_CREATE_FSYNC;
1001 def_thread.loops = DEF_LOOPS;
1002 def_thread.verify = DEF_VERIFY;
1003 def_thread.stonewall = DEF_STONEWALL;
1004 def_thread.numjobs = DEF_NUMJOBS;
1005 def_thread.use_thread = DEF_USE_THREAD;
1006 def_thread.rwmixcycle = DEF_RWMIX_CYCLE;
1007 def_thread.rwmixread = DEF_RWMIX_READ;
1008 def_thread.nice = DEF_NICE;
1009 def_thread.rand_repeatable = DEF_RAND_REPEAT;
1010 #ifdef FIO_HAVE_DISK_UTIL
1011 def_thread.do_disk_util = 1;
1017 static void usage(char *name)
1019 printf("%s\n", fio_version_string);
1020 printf("\t-o Write output to file\n");
1021 printf("\t-t Runtime in seconds\n");
1022 printf("\t-l Generate per-job latency logs\n");
1023 printf("\t-w Generate per-job bandwidth logs\n");
1024 printf("\t-m Minimal (terse) output\n");
1025 printf("\t-v Print version info and exit\n");
1028 static int parse_cmd_line(int argc, char *argv[])
1030 int c, idx = 1, ini_idx = 0;
1032 while ((c = getopt(argc, argv, "t:o:lwvhm")) != EOF) {
1035 def_timeout = atoi(optarg);
1047 f_out = fopen(optarg, "w+");
1049 perror("fopen output");
1063 printf("%s\n", fio_version_string);
1068 while (idx < argc) {
1070 ini_file = realloc(ini_file, ini_idx * sizeof(char *));
1071 ini_file[ini_idx - 1] = strdup(argv[idx]);
1083 static void free_shm(void)
1085 struct shmid_ds sbuf;
1088 shmdt((void *) threads);
1090 shmctl(shm_id, IPC_RMID, &sbuf);
1095 * The thread area is shared between the main process and the job
1096 * threads/processes. So setup a shared memory segment that will hold
1099 static int setup_thread_area(void)
1102 * 1024 is too much on some machines, scale max_jobs if
1103 * we get a failure that looks like too large a shm segment
1106 size_t size = max_jobs * sizeof(struct thread_data);
1108 shm_id = shmget(0, size, IPC_CREAT | 0600);
1111 if (errno != EINVAL) {
1122 threads = shmat(shm_id, NULL, 0);
1123 if (threads == (void *) -1) {
1132 int parse_options(int argc, char *argv[])
1136 if (setup_thread_area())
1138 if (fill_def_thread())
1141 job_files = parse_cmd_line(argc, argv);
1143 log_err("Need job file(s)\n");
1148 for (i = 0; i < job_files; i++) {
1149 if (fill_def_thread())
1151 if (parse_jobs_ini(ini_file[i], i))