[PATCH] Support for specifying exact io pattern
[fio.git] / fio.h
1 #ifndef FIO_H
2 #define FIO_H
3
4 #include <sched.h>
5 #include <limits.h>
6 #include <pthread.h>
7 #include <sys/time.h>
8 #include <sys/resource.h>
9 #include <semaphore.h>
10
11 #include "list.h"
12 #include "md5.h"
13 #include "crc32.h"
14 #include "arch.h"
15 #include "os.h"
16
17 struct io_stat {
18         unsigned long val;
19         unsigned long val_sq;
20         unsigned long max_val;
21         unsigned long min_val;
22         unsigned long samples;
23 };
24
25 struct io_sample {
26         unsigned long time;
27         unsigned long val;
28         unsigned int ddir;
29 };
30
31 struct io_log {
32         unsigned long nr_samples;
33         unsigned long max_samples;
34         struct io_sample *log;
35 };
36
37 struct io_piece {
38         struct list_head list;
39         unsigned long long offset;
40         unsigned int len;
41         int ddir;
42 };
43
44 /*
45  * The io unit
46  */
47 struct io_u {
48         union {
49 #ifdef FIO_HAVE_LIBAIO
50                 struct iocb iocb;
51 #endif
52 #ifdef FIO_HAVE_POSIXAIO
53                 struct aiocb aiocb;
54 #endif
55 #ifdef FIO_HAVE_SGIO
56                 struct sg_io_hdr hdr;
57 #endif
58         };
59         struct timeval start_time;
60         struct timeval issue_time;
61
62         char *buf;
63         unsigned int buflen;
64         unsigned long long offset;
65         unsigned int index;
66
67         unsigned int resid;
68         unsigned int error;
69
70         unsigned char seen;
71         unsigned char ddir;
72
73         struct list_head list;
74 };
75
76 #define FIO_HDR_MAGIC   0xf00baaef
77
78 enum {
79         VERIFY_NONE = 0,
80         VERIFY_MD5,
81         VERIFY_CRC32,
82 };
83
84 struct verify_header {
85         unsigned int fio_magic;
86         unsigned int len;
87         unsigned int verify_type;
88         union {
89                 char md5_digest[MD5_HASH_WORDS * 4];
90                 unsigned long crc32;
91         };
92 };
93
94 struct group_run_stats {
95         unsigned long long max_run[2], min_run[2];
96         unsigned long long max_bw[2], min_bw[2];
97         unsigned long long io_mb[2];
98         unsigned long long agg[2];
99 };
100
101 struct thread_data {
102         char file_name[256];
103         char directory[256];
104         char verror[80];
105         pthread_t thread;
106         int thread_number;
107         int groupid;
108         int filetype;
109         int error;
110         int fd;
111         void *mmap;
112         pid_t pid;
113         char *orig_buffer;
114         size_t orig_buffer_size;
115         volatile int terminate;
116         volatile int runstate;
117         volatile int old_runstate;
118         unsigned int ddir;
119         unsigned int iomix;
120         unsigned int ioprio;
121         unsigned int sequential;
122         unsigned int bs;
123         unsigned int min_bs;
124         unsigned int max_bs;
125         unsigned int odirect;
126         unsigned int thinktime;
127         unsigned int fsync_blocks;
128         unsigned int start_delay;
129         unsigned int timeout;
130         unsigned int io_engine;
131         unsigned int create_file;
132         unsigned int overwrite;
133         unsigned int invalidate_cache;
134         unsigned int bw_avg_time;
135         unsigned int create_serialize;
136         unsigned int create_fsync;
137         unsigned int loops;
138         unsigned long long file_size;
139         unsigned long long real_file_size;
140         unsigned long long file_offset;
141         unsigned long long zone_size;
142         unsigned long long zone_skip;
143         unsigned int sync_io;
144         unsigned int mem_type;
145         unsigned int verify;
146         unsigned int stonewall;
147         unsigned int numjobs;
148         unsigned int use_thread;
149         unsigned int iodepth;
150         os_cpu_mask_t cpumask;
151         unsigned int jobnum;
152         unsigned int iolog;
153
154         char iolog_file[256];
155
156         struct drand48_data bsrange_state;
157         struct drand48_data verify_state;
158
159         int shm_id;
160
161         void *io_data;
162         char io_engine_name[16];
163         int (*io_prep)(struct thread_data *, struct io_u *);
164         int (*io_queue)(struct thread_data *, struct io_u *);
165         int (*io_getevents)(struct thread_data *, int, int, struct timespec *);
166         struct io_u *(*io_event)(struct thread_data *, int);
167         int (*io_cancel)(struct thread_data *, struct io_u *);
168         void (*io_cleanup)(struct thread_data *);
169         int (*io_sync)(struct thread_data *);
170
171         unsigned int cur_depth;
172         struct list_head io_u_freelist;
173         struct list_head io_u_busylist;
174
175         unsigned int rate;
176         unsigned int ratemin;
177         unsigned int ratecycle;
178         unsigned long rate_usec_cycle;
179         long rate_pending_usleep;
180         unsigned long rate_bytes;
181         struct timeval lastrate;
182
183         unsigned long runtime[2];               /* msec */
184         unsigned long long io_size;
185         unsigned long long total_io_size;
186
187         unsigned long long io_blocks[2];
188         unsigned long long io_bytes[2];
189         unsigned long long zone_bytes;
190         unsigned long long this_io_bytes[2];
191         unsigned long long last_pos;
192         sem_t mutex;
193
194         struct drand48_data random_state;
195         unsigned long *file_map;
196         unsigned int num_maps;
197
198         /*
199          * bandwidth and latency stats
200          */
201         struct io_stat clat_stat[2];            /* completion latency */
202         struct io_stat slat_stat[2];            /* submission latency */
203         struct io_stat bw_stat[2];              /* bandwidth stats */
204
205         unsigned long long stat_io_bytes[2];
206         struct timeval stat_sample_time[2];
207
208         struct io_log *slat_log;
209         struct io_log *clat_log;
210         struct io_log *bw_log;
211
212         struct timeval start;   /* start of this loop */
213         struct timeval epoch;   /* time job was started */
214
215         struct rusage ru_start;
216         struct rusage ru_end;
217         unsigned long usr_time;
218         unsigned long sys_time;
219         unsigned long ctx;
220
221         unsigned int do_disk_util;
222         unsigned int override_sync;
223
224         struct list_head io_hist_list;
225         struct list_head io_log_list;
226 };
227
228 #define td_verror(td, err)                                              \
229         do {                                                            \
230                 int e = (err);                                          \
231                 (td)->error = e;                                        \
232                 snprintf(td->verror, sizeof(td->verror) - 1, "file:%s:%d, error=%s", __FILE__, __LINE__, strerror(e));  \
233         } while (0)
234
235 extern int parse_jobs_ini(char *);
236 extern int parse_options(int, char **);
237 extern void finish_log(struct thread_data *, struct io_log *, const char *);
238 extern int init_random_state(struct thread_data *);
239 extern struct io_u *__get_io_u(struct thread_data *);
240 extern void put_io_u(struct thread_data *, struct io_u *);
241
242 extern int rate_quit;
243 extern int write_lat_log;
244 extern int write_bw_log;
245 extern int exitall_on_terminate;
246 extern int thread_number;
247 extern int shm_id;
248 extern int groupid;
249
250 extern struct thread_data *threads;
251
252 enum {
253         DDIR_READ = 0,
254         DDIR_WRITE,
255 };
256
257 /*
258  * What type of allocation to use for io buffers
259  */
260 enum {
261         MEM_MALLOC,     /* ordinary malloc */
262         MEM_SHM,        /* use shared memory segments */
263         MEM_MMAP,       /* use anonynomous mmap */
264 };
265
266 /*
267  * The type of object we are working on
268  */
269 enum {
270         FIO_TYPE_FILE = 1,
271         FIO_TYPE_BD,
272         FIO_TYPE_CHAR,
273 };
274
275 enum {
276         FIO_SYNCIO      = 1 << 0,
277         FIO_MMAPIO      = 1 << 1 | FIO_SYNCIO,
278         FIO_LIBAIO      = 1 << 2,
279         FIO_POSIXAIO    = 1 << 3,
280         FIO_SGIO        = 1 << 4,
281 };
282
283 #define td_read(td)             ((td)->ddir == DDIR_READ)
284 #define td_write(td)            ((td)->ddir == DDIR_WRITE)
285 #define td_rw(td)               ((td)->iomix != 0)
286
287 #define BLOCKS_PER_MAP          (8 * sizeof(long))
288 #define TO_MAP_BLOCK(td, b)     ((b) - ((td)->file_offset / (td)->min_bs))
289 #define RAND_MAP_IDX(td, b)     (TO_MAP_BLOCK(td, b) / BLOCKS_PER_MAP)
290 #define RAND_MAP_BIT(td, b)     (TO_MAP_BLOCK(td, b) & (BLOCKS_PER_MAP - 1))
291
292 #define MAX_JOBS        (1024)
293
294 struct disk_util_stat {
295         unsigned ios[2];
296         unsigned merges[2];
297         unsigned long long sectors[2];
298         unsigned ticks[2];
299         unsigned io_ticks;
300         unsigned time_in_queue;
301 };
302
303 struct disk_util {
304         struct list_head list;
305
306         char *name;
307         char path[256];
308         dev_t dev;
309
310         struct disk_util_stat dus;
311         struct disk_util_stat last_dus;
312
313         unsigned long msec;
314         struct timeval time;
315 };
316
317 struct io_completion_data {
318         int nr;                         /* input */
319
320         int error;                      /* output */
321         unsigned long bytes_done[2];    /* output */
322 };
323
324 #define DISK_UTIL_MSEC  (250)
325
326 #ifndef min
327 #define min(a, b)       ((a) < (b) ? (a) : (b))
328 #endif
329
330 #endif