10 #include <sys/types.h>
16 #define DEF_TIMEOUT (0)
17 #define DEF_RATE_CYCLE (1000)
18 #define DEF_ODIRECT (1)
19 #define DEF_IO_ENGINE (FIO_SYNCIO)
20 #define DEF_IO_ENGINE_NAME "sync"
21 #define DEF_SEQUENTIAL (1)
22 #define DEF_RAND_REPEAT (1)
23 #define DEF_OVERWRITE (1)
24 #define DEF_CREATE (1)
25 #define DEF_INVALIDATE (1)
26 #define DEF_SYNCIO (0)
27 #define DEF_RANDSEED (0xb1899bedUL)
28 #define DEF_BWAVGTIME (500)
29 #define DEF_CREATE_SER (1)
30 #define DEF_CREATE_FSYNC (1)
32 #define DEF_VERIFY (0)
33 #define DEF_STONEWALL (0)
34 #define DEF_NUMJOBS (1)
35 #define DEF_USE_THREAD (0)
36 #define DEF_FILE_SIZE (1024 * 1024 * 1024UL)
37 #define DEF_ZONE_SIZE (0)
38 #define DEF_ZONE_SKIP (0)
40 static char fio_version_string[] = "fio 1.3";
42 static int repeatable = DEF_RAND_REPEAT;
43 static char *ini_file;
44 static int max_jobs = MAX_JOBS;
46 struct thread_data def_thread;
47 struct thread_data *threads = NULL;
50 int write_lat_log = 0;
52 int exitall_on_terminate = 0;
54 static int setup_rate(struct thread_data *td)
61 if (td->rate < td->ratemin) {
62 fprintf(stderr, "min rate larger than nominal rate\n");
66 nr_reads_per_sec = (td->rate * 1024) / td->min_bs;
67 td->rate_usec_cycle = 1000000 / nr_reads_per_sec;
68 td->rate_pending_usleep = 0;
72 static void setup_log(struct io_log **log)
74 struct io_log *l = malloc(sizeof(*l));
77 l->max_samples = 1024;
78 l->log = malloc(l->max_samples * sizeof(struct io_sample));
82 void finish_log(struct thread_data *td, struct io_log *log, const char *name)
88 snprintf(file_name, 200, "client%d_%s.log", td->thread_number, name);
89 f = fopen(file_name, "w");
95 for (i = 0; i < log->nr_samples; i++)
96 fprintf(f, "%lu, %lu, %u\n", log->log[i].time, log->log[i].val, log->log[i].ddir);
103 static struct thread_data *get_new_job(int global, struct thread_data *parent)
105 struct thread_data *td;
109 if (thread_number >= max_jobs)
112 td = &threads[thread_number++];
113 memset(td, 0, sizeof(*td));
116 td->thread_number = thread_number;
118 td->ddir = parent->ddir;
119 td->ioprio = parent->ioprio;
120 td->sequential = parent->sequential;
122 td->min_bs = parent->min_bs;
123 td->max_bs = parent->max_bs;
124 td->odirect = parent->odirect;
125 td->thinktime = parent->thinktime;
126 td->fsync_blocks = parent->fsync_blocks;
127 td->start_delay = parent->start_delay;
128 td->timeout = parent->timeout;
129 td->io_engine = parent->io_engine;
130 td->create_file = parent->create_file;
131 td->overwrite = parent->overwrite;
132 td->invalidate_cache = parent->invalidate_cache;
133 td->file_size = parent->file_size;
134 td->file_offset = parent->file_offset;
135 td->zone_size = parent->zone_size;
136 td->zone_skip = parent->zone_skip;
137 td->rate = parent->rate;
138 td->ratemin = parent->ratemin;
139 td->ratecycle = parent->ratecycle;
140 td->iodepth = parent->iodepth;
141 td->sync_io = parent->sync_io;
142 td->mem_type = parent->mem_type;
143 td->bw_avg_time = parent->bw_avg_time;
144 td->create_serialize = parent->create_serialize;
145 td->create_fsync = parent->create_fsync;
146 td->loops = parent->loops;
147 td->verify = parent->verify;
148 td->stonewall = parent->stonewall;
149 td->numjobs = parent->numjobs;
150 td->use_thread = parent->use_thread;
151 td->do_disk_util = parent->do_disk_util;
152 memcpy(&td->cpumask, &parent->cpumask, sizeof(td->cpumask));
153 strcpy(td->io_engine_name, parent->io_engine_name);
158 static void put_job(struct thread_data *td)
160 memset(&threads[td->thread_number - 1], 0, sizeof(*td));
164 static int add_job(struct thread_data *td, const char *jobname)
166 char *ddir_str[] = { "read", "write", "randread", "randwrite",
167 "rw", NULL, "randrw" };
171 #ifndef FIO_HAVE_LIBAIO
172 if (td->io_engine == FIO_LIBAIO) {
173 fprintf(stderr, "Linux libaio not available\n");
177 #ifndef FIO_HAVE_POSIXAIO
178 if (td->io_engine == FIO_POSIXAIO) {
179 fprintf(stderr, "posix aio not available\n");
185 * the def_thread is just for options, it's not a real job
187 if (td == &def_thread)
190 if (td->io_engine & FIO_SYNCIO)
198 * only really works for sequential io for now
200 if (td->zone_size && !td->sequential)
203 td->filetype = FIO_TYPE_FILE;
204 if (!stat(jobname, &sb)) {
205 if (S_ISBLK(sb.st_mode))
206 td->filetype = FIO_TYPE_BD;
207 else if (S_ISCHR(sb.st_mode))
208 td->filetype = FIO_TYPE_CHAR;
211 if (td->filetype == FIO_TYPE_FILE) {
212 if (td->directory[0] != '\0')
213 sprintf(td->file_name, "%s/%s.%d", td->directory, jobname, td->jobnum);
215 sprintf(td->file_name, "%s.%d", jobname, td->jobnum);
217 strncpy(td->file_name, jobname, sizeof(td->file_name) - 1);
219 sem_init(&td->mutex, 0, 0);
221 td->clat_stat[0].min_val = td->clat_stat[1].min_val = ULONG_MAX;
222 td->slat_stat[0].min_val = td->slat_stat[1].min_val = ULONG_MAX;
223 td->bw_stat[0].min_val = td->bw_stat[1].min_val = ULONG_MAX;
225 if (td->min_bs == -1U)
227 if (td->max_bs == -1U)
229 if (td_read(td) && !td_rw(td))
232 if (td->stonewall && td->thread_number > 1)
235 td->groupid = groupid;
241 setup_log(&td->slat_log);
242 setup_log(&td->clat_log);
245 setup_log(&td->bw_log);
247 ddir = td->ddir + (!td->sequential << 1) + (td->iomix << 2);
248 printf("Client%d (g=%d): rw=%s, odir=%d, bs=%d-%d, rate=%d, ioengine=%s, iodepth=%d\n", td->thread_number, td->groupid, ddir_str[ddir], td->odirect, td->min_bs, td->max_bs, td->rate, td->io_engine_name, td->iodepth);
251 * recurse add identical jobs, clear numjobs and stonewall options
252 * as they don't apply to sub-jobs
254 numjobs = td->numjobs;
256 struct thread_data *td_new = get_new_job(0, td);
262 td_new->stonewall = 0;
263 td_new->jobnum = numjobs;
265 if (add_job(td_new, jobname))
274 int init_random_state(struct thread_data *td)
277 int fd, num_maps, blocks;
279 fd = open("/dev/random", O_RDONLY);
281 td_verror(td, errno);
285 if (read(fd, &seed, sizeof(seed)) < (int) sizeof(seed)) {
293 srand48_r(seed, &td->bsrange_state);
294 srand48_r(seed, &td->verify_state);
302 blocks = (td->io_size + td->min_bs - 1) / td->min_bs;
303 num_maps = blocks / BLOCKS_PER_MAP;
304 td->file_map = malloc(num_maps * sizeof(long));
305 td->num_maps = num_maps;
306 memset(td->file_map, 0, num_maps * sizeof(long));
308 srand48_r(seed, &td->random_state);
312 static void fill_cpu_mask(os_cpu_mask_t cpumask, int cpu)
314 #ifdef FIO_HAVE_CPU_AFFINITY
319 for (i = 0; i < sizeof(int) * 8; i++) {
321 CPU_SET(i, &cpumask);
326 static unsigned long get_mult(char c)
337 return 1024 * 1024 * 1024;
344 * convert string after '=' into decimal value, noting any size suffix
346 static int str_cnv(char *p, unsigned long long *val)
351 str = strchr(p, '=');
358 *val = strtoul(str, NULL, 10);
359 if (*val == ULONG_MAX && errno == ERANGE)
362 *val *= get_mult(str[len - 2]);
366 static int check_strcnv(char *p, char *name, unsigned long long *val)
368 if (strncmp(p, name, strlen(name) - 1))
371 return str_cnv(p, val);
374 static void strip_blank_front(char **p)
382 static void strip_blank_end(char *p)
384 while (isblank(*p)) {
390 static void terminate_line(char *p)
392 while (*p != '\n' && *p != '\0')
398 typedef int (str_cb_fn)(struct thread_data *, char *);
400 static int check_str(char *p, char *name, str_cb_fn *cb, struct thread_data *td)
402 char *s = strstr(p, name);
412 strip_blank_front(&s);
416 static int check_strstore(char *p, char *name, char *dest)
418 char *s = strstr(p, name);
428 strip_blank_front(&s);
432 s = dest + strlen(dest) - 1;
437 static int __check_range(char *str, unsigned long *val)
441 if (sscanf(str, "%lu%c", val, &suffix) == 2) {
442 *val *= get_mult(suffix);
446 if (sscanf(str, "%lu", val) == 1)
452 static int check_range(char *p, char *name, unsigned long *s, unsigned long *e)
460 str = strstr(p, name);
466 str = strchr(p, '=');
471 * 'p' now holds whatever is after the '=' sign
476 * terminate p1 at the '-' sign
485 if (!__check_range(p1, s) && !__check_range(p2, e))
491 static int check_int(char *p, char *name, unsigned int *val)
495 str = strstr(p, name);
499 str = strchr(p, '=');
505 if (sscanf(str, "%u", val) == 1)
511 static int check_strset(char *p, char *name)
513 return strncmp(p, name, strlen(name));
516 static int is_empty_or_comment(char *line)
520 for (i = 0; i < strlen(line); i++) {
523 if (!isspace(line[i]) && !iscntrl(line[i]))
530 static int str_rw_cb(struct thread_data *td, char *mem)
532 if (!strncmp(mem, "read", 4) || !strncmp(mem, "0", 1)) {
533 td->ddir = DDIR_READ;
536 } else if (!strncmp(mem, "randread", 8)) {
537 td->ddir = DDIR_READ;
540 } else if (!strncmp(mem, "write", 5) || !strncmp(mem, "1", 1)) {
541 td->ddir = DDIR_WRITE;
544 } else if (!strncmp(mem, "randwrite", 9)) {
545 td->ddir = DDIR_WRITE;
548 } else if (!strncmp(mem, "rw", 2)) {
553 } else if (!strncmp(mem, "randrw", 6)) {
560 fprintf(stderr, "bad data direction: %s\n", mem);
564 static int str_verify_cb(struct thread_data *td, char *mem)
566 if (!strncmp(mem, "0", 1)) {
567 td->verify = VERIFY_NONE;
569 } else if (!strncmp(mem, "md5", 3) || !strncmp(mem, "1", 1)) {
570 td->verify = VERIFY_MD5;
572 } else if (!strncmp(mem, "crc32", 5)) {
573 td->verify = VERIFY_CRC32;
577 fprintf(stderr, "bad verify type: %s\n", mem);
581 static int str_mem_cb(struct thread_data *td, char *mem)
583 if (!strncmp(mem, "malloc", 6)) {
584 td->mem_type = MEM_MALLOC;
586 } else if (!strncmp(mem, "shm", 3)) {
587 td->mem_type = MEM_SHM;
589 } else if (!strncmp(mem, "mmap", 4)) {
590 td->mem_type = MEM_MMAP;
594 fprintf(stderr, "bad mem type: %s\n", mem);
598 static int str_ioengine_cb(struct thread_data *td, char *str)
600 if (!strncmp(str, "linuxaio", 8) || !strncmp(str, "aio", 3) ||
601 !strncmp(str, "libaio", 6)) {
602 strcpy(td->io_engine_name, "libaio");
603 td->io_engine = FIO_LIBAIO;
605 } else if (!strncmp(str, "posixaio", 8)) {
606 strcpy(td->io_engine_name, "posixaio");
607 td->io_engine = FIO_POSIXAIO;
609 } else if (!strncmp(str, "sync", 4)) {
610 strcpy(td->io_engine_name, "sync");
611 td->io_engine = FIO_SYNCIO;
613 } else if (!strncmp(str, "mmap", 4)) {
614 strcpy(td->io_engine_name, "mmap");
615 td->io_engine = FIO_MMAPIO;
617 } else if (!strncmp(str, "sgio", 4)) {
618 strcpy(td->io_engine_name, "sgio");
619 td->io_engine = FIO_SGIO;
621 } else if (!strncmp(str, "splice", 6)) {
622 strcpy(td->io_engine_name, "splice");
623 td->io_engine = FIO_SPLICEIO;
627 fprintf(stderr, "bad ioengine type: %s\n", str);
631 static int str_iolog_cb(struct thread_data *td, char *file)
633 terminate_line(file);
634 strncpy(td->iolog_file, file, sizeof(td->iolog_file) - 1);
639 int parse_jobs_ini(char *file)
641 unsigned int prioclass, prio, cpu, global;
642 unsigned long long ull;
643 unsigned long ul1, ul2;
644 struct thread_data *td;
650 f = fopen(file, "r");
652 perror("fopen job file");
656 string = malloc(4096);
659 while ((p = fgets(string, 4096, f)) != NULL) {
660 if (is_empty_or_comment(p))
662 if (sscanf(p, "[%s]", name) != 1)
665 global = !strncmp(name, "global", 6);
667 name[strlen(name) - 1] = '\0';
669 td = get_new_job(global, &def_thread);
674 while ((p = fgets(string, 4096, f)) != NULL) {
675 if (is_empty_or_comment(p))
680 if (!check_int(p, "prio", &prio)) {
681 #ifndef FIO_HAVE_IOPRIO
682 fprintf(stderr, "io priorities not available\n");
689 if (!check_int(p, "prioclass", &prioclass)) {
690 #ifndef FIO_HAVE_IOPRIO
691 fprintf(stderr, "io priorities not available\n");
694 td->ioprio |= prioclass << IOPRIO_CLASS_SHIFT;
698 if (!check_int(p, "direct", &td->odirect)) {
702 if (!check_int(p, "rate", &td->rate)) {
706 if (!check_int(p, "ratemin", &td->ratemin)) {
710 if (!check_int(p, "ratecycle", &td->ratecycle)) {
714 if (!check_int(p, "thinktime", &td->thinktime)) {
718 if (!check_int(p, "cpumask", &cpu)) {
719 #ifndef FIO_HAVE_CPU_AFFINITY
720 fprintf(stderr, "cpu affinity not available\n");
723 fill_cpu_mask(td->cpumask, cpu);
727 if (!check_int(p, "fsync", &td->fsync_blocks)) {
731 if (!check_int(p, "startdelay", &td->start_delay)) {
735 if (!check_int(p, "timeout", &td->timeout)) {
739 if (!check_int(p, "invalidate",&td->invalidate_cache)) {
743 if (!check_int(p, "iodepth", &td->iodepth)) {
747 if (!check_int(p, "sync", &td->sync_io)) {
751 if (!check_int(p, "bwavgtime", &td->bw_avg_time)) {
755 if (!check_int(p, "create_serialize", &td->create_serialize)) {
759 if (!check_int(p, "create_fsync", &td->create_fsync)) {
763 if (!check_int(p, "loops", &td->loops)) {
767 if (!check_int(p, "numjobs", &td->numjobs)) {
771 if (!check_int(p, "overwrite", &td->overwrite)) {
775 if (!check_range(p, "bsrange", &ul1, &ul2)) {
786 if (!check_strcnv(p, "bs", &ull)) {
791 if (!check_strcnv(p, "size", &td->file_size)) {
795 if (!check_strcnv(p, "offset", &td->file_offset)) {
799 if (!check_strcnv(p, "zonesize", &td->zone_size)) {
803 if (!check_strcnv(p, "zoneskip", &td->zone_skip)) {
807 if (!check_strstore(p, "directory", td->directory)) {
811 if (!check_str(p, "mem", str_mem_cb, td)) {
815 if (!check_str(p, "verify", str_verify_cb, td)) {
819 if (!check_str(p, "rw", str_rw_cb, td)) {
823 if (!check_str(p, "ioengine", str_ioengine_cb, td)) {
827 if (!check_strset(p, "create")) {
832 if (!check_strset(p, "exitall")) {
833 exitall_on_terminate = 1;
837 if (!check_strset(p, "stonewall")) {
842 if (!check_strset(p, "thread")) {
847 if (!check_str(p, "iolog", str_iolog_cb, td)) {
853 printf("Client%d: bad option %s\n",td->thread_number,p);
858 if (add_job(td, name))
868 static int fill_def_thread(void)
870 memset(&def_thread, 0, sizeof(def_thread));
872 if (fio_getaffinity(getpid(), &def_thread.cpumask) == -1) {
873 perror("sched_getaffinity");
880 def_thread.ddir = DDIR_READ;
881 def_thread.iomix = 0;
882 def_thread.bs = DEF_BS;
883 def_thread.min_bs = -1;
884 def_thread.max_bs = -1;
885 def_thread.io_engine = DEF_IO_ENGINE;
886 strcpy(def_thread.io_engine_name, DEF_IO_ENGINE_NAME);
887 def_thread.odirect = DEF_ODIRECT;
888 def_thread.ratecycle = DEF_RATE_CYCLE;
889 def_thread.sequential = DEF_SEQUENTIAL;
890 def_thread.timeout = DEF_TIMEOUT;
891 def_thread.create_file = DEF_CREATE;
892 def_thread.overwrite = DEF_OVERWRITE;
893 def_thread.invalidate_cache = DEF_INVALIDATE;
894 def_thread.sync_io = DEF_SYNCIO;
895 def_thread.mem_type = MEM_MALLOC;
896 def_thread.bw_avg_time = DEF_BWAVGTIME;
897 def_thread.create_serialize = DEF_CREATE_SER;
898 def_thread.create_fsync = DEF_CREATE_FSYNC;
899 def_thread.loops = DEF_LOOPS;
900 def_thread.verify = DEF_VERIFY;
901 def_thread.stonewall = DEF_STONEWALL;
902 def_thread.numjobs = DEF_NUMJOBS;
903 def_thread.use_thread = DEF_USE_THREAD;
904 #ifdef FIO_HAVE_DISK_UTIL
905 def_thread.do_disk_util = 1;
911 static void usage(char *name)
913 printf("%s\n", fio_version_string);
914 printf("\t-s IO is sequential\n");
915 printf("\t-b Block size in KiB for each IO\n");
916 printf("\t-t Runtime in seconds\n");
917 printf("\t-R Exit all threads on failure to meet rate goal\n");
918 printf("\t-o Use O_DIRECT\n");
919 printf("\t-l Generate per-job latency logs\n");
920 printf("\t-w Generate per-job bandwidth logs\n");
921 printf("\t-f Job file (Required)\n");
922 printf("\t-v Print version info and exit\n");
925 static void parse_cmd_line(int argc, char *argv[])
929 while ((c = getopt(argc, argv, "s:b:t:r:R:o:f:lwvh")) != EOF) {
932 def_thread.sequential = !!atoi(optarg);
935 def_thread.bs = atoi(optarg);
936 def_thread.bs <<= 10;
937 if (!def_thread.bs) {
938 printf("bad block size\n");
939 def_thread.bs = DEF_BS;
943 def_thread.timeout = atoi(optarg);
946 repeatable = !!atoi(optarg);
949 rate_quit = !!atoi(optarg);
952 def_thread.odirect = !!atoi(optarg);
955 ini_file = strdup(optarg);
967 printf("%s\n", fio_version_string);
972 if (!ini_file && argc > 1 && argv[argc - 1][0] != '-')
973 ini_file = strdup(argv[argc - 1]);
976 static void free_shm(void)
978 struct shmid_ds sbuf;
983 shmctl(shm_id, IPC_RMID, &sbuf);
987 static int setup_thread_area(void)
990 * 1024 is too much on some machines, scale max_jobs if
991 * we get a failure that looks like too large a shm segment
994 int s = max_jobs * sizeof(struct thread_data);
996 shm_id = shmget(0, s, IPC_CREAT | 0600);
999 if (errno != EINVAL) {
1010 threads = shmat(shm_id, NULL, 0);
1011 if (threads == (void *) -1) {
1020 int parse_options(int argc, char *argv[])
1022 if (setup_thread_area())
1024 if (fill_def_thread())
1027 parse_cmd_line(argc, argv);
1030 printf("Need job file\n");
1035 if (parse_jobs_ini(ini_file)) {