dbf476e94a4dc5099753eb3bf9c7b5acc629f320
[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 end_fsync;
138         unsigned int loops;
139         unsigned long long file_size;
140         unsigned long long real_file_size;
141         unsigned long long file_offset;
142         unsigned long long zone_size;
143         unsigned long long zone_skip;
144         unsigned int sync_io;
145         unsigned int mem_type;
146         unsigned int verify;
147         unsigned int stonewall;
148         unsigned int numjobs;
149         unsigned int use_thread;
150         unsigned int iodepth;
151         os_cpu_mask_t cpumask;
152         unsigned int jobnum;
153         unsigned int iolog;
154         unsigned int rwmixcycle;
155         unsigned int rwmixread;
156
157         char iolog_file[256];
158
159         struct drand48_data bsrange_state;
160         struct drand48_data verify_state;
161
162         int shm_id;
163
164         void *io_data;
165         char io_engine_name[16];
166         int (*io_prep)(struct thread_data *, struct io_u *);
167         int (*io_queue)(struct thread_data *, struct io_u *);
168         int (*io_getevents)(struct thread_data *, int, int, struct timespec *);
169         struct io_u *(*io_event)(struct thread_data *, int);
170         int (*io_cancel)(struct thread_data *, struct io_u *);
171         void (*io_cleanup)(struct thread_data *);
172         int (*io_sync)(struct thread_data *);
173
174         unsigned int cur_depth;
175         struct list_head io_u_freelist;
176         struct list_head io_u_busylist;
177
178         unsigned int rate;
179         unsigned int ratemin;
180         unsigned int ratecycle;
181         unsigned long rate_usec_cycle;
182         long rate_pending_usleep;
183         unsigned long rate_bytes;
184         struct timeval lastrate;
185
186         unsigned long runtime[2];               /* msec */
187         unsigned long long io_size;
188         unsigned long long total_io_size;
189
190         unsigned long long io_blocks[2];
191         unsigned long long io_bytes[2];
192         unsigned long long zone_bytes;
193         unsigned long long this_io_bytes[2];
194         unsigned long long last_pos;
195         sem_t mutex;
196
197         struct drand48_data random_state;
198         unsigned long *file_map;
199         unsigned int num_maps;
200
201         /*
202          * bandwidth and latency stats
203          */
204         struct io_stat clat_stat[2];            /* completion latency */
205         struct io_stat slat_stat[2];            /* submission latency */
206         struct io_stat bw_stat[2];              /* bandwidth stats */
207
208         unsigned long long stat_io_bytes[2];
209         struct timeval stat_sample_time[2];
210
211         struct io_log *slat_log;
212         struct io_log *clat_log;
213         struct io_log *bw_log;
214
215         struct timeval start;   /* start of this loop */
216         struct timeval epoch;   /* time job was started */
217
218         struct rusage ru_start;
219         struct rusage ru_end;
220         unsigned long usr_time;
221         unsigned long sys_time;
222         unsigned long ctx;
223
224         unsigned int do_disk_util;
225         unsigned int override_sync;
226
227         struct drand48_data rwmix_state;
228         struct timeval rwmix_switch;
229         int rwmix_ddir;
230
231         struct list_head io_hist_list;
232         struct list_head io_log_list;
233 };
234
235 #define td_verror(td, err)                                              \
236         do {                                                            \
237                 int e = (err);                                          \
238                 (td)->error = e;                                        \
239                 snprintf(td->verror, sizeof(td->verror) - 1, "file:%s:%d, error=%s", __FILE__, __LINE__, strerror(e));  \
240         } while (0)
241
242 extern int parse_jobs_ini(char *);
243 extern int parse_options(int, char **);
244 extern void finish_log(struct thread_data *, struct io_log *, const char *);
245 extern int init_random_state(struct thread_data *);
246 extern struct io_u *__get_io_u(struct thread_data *);
247 extern void put_io_u(struct thread_data *, struct io_u *);
248
249 extern int rate_quit;
250 extern int write_lat_log;
251 extern int write_bw_log;
252 extern int exitall_on_terminate;
253 extern int thread_number;
254 extern int shm_id;
255 extern int groupid;
256
257 extern struct thread_data *threads;
258
259 enum {
260         DDIR_READ = 0,
261         DDIR_WRITE,
262 };
263
264 /*
265  * What type of allocation to use for io buffers
266  */
267 enum {
268         MEM_MALLOC,     /* ordinary malloc */
269         MEM_SHM,        /* use shared memory segments */
270         MEM_MMAP,       /* use anonynomous mmap */
271 };
272
273 /*
274  * The type of object we are working on
275  */
276 enum {
277         FIO_TYPE_FILE = 1,
278         FIO_TYPE_BD,
279         FIO_TYPE_CHAR,
280 };
281
282 enum {
283         FIO_SYNCIO      = 1 << 0,
284         FIO_MMAPIO      = 1 << 1 | FIO_SYNCIO,
285         FIO_LIBAIO      = 1 << 2,
286         FIO_POSIXAIO    = 1 << 3,
287         FIO_SGIO        = 1 << 4,
288         FIO_SPLICEIO    = 1 << 5 | FIO_SYNCIO,
289 };
290
291 #define td_read(td)             ((td)->ddir == DDIR_READ)
292 #define td_write(td)            ((td)->ddir == DDIR_WRITE)
293 #define td_rw(td)               ((td)->iomix != 0)
294
295 #define BLOCKS_PER_MAP          (8 * sizeof(long))
296 #define TO_MAP_BLOCK(td, b)     ((b) - ((td)->file_offset / (td)->min_bs))
297 #define RAND_MAP_IDX(td, b)     (TO_MAP_BLOCK(td, b) / BLOCKS_PER_MAP)
298 #define RAND_MAP_BIT(td, b)     (TO_MAP_BLOCK(td, b) & (BLOCKS_PER_MAP - 1))
299
300 #define MAX_JOBS        (1024)
301
302 struct disk_util_stat {
303         unsigned ios[2];
304         unsigned merges[2];
305         unsigned long long sectors[2];
306         unsigned ticks[2];
307         unsigned io_ticks;
308         unsigned time_in_queue;
309 };
310
311 struct disk_util {
312         struct list_head list;
313
314         char *name;
315         char path[256];
316         dev_t dev;
317
318         struct disk_util_stat dus;
319         struct disk_util_stat last_dus;
320
321         unsigned long msec;
322         struct timeval time;
323 };
324
325 struct io_completion_data {
326         int nr;                         /* input */
327
328         int error;                      /* output */
329         unsigned long bytes_done[2];    /* output */
330 };
331
332 #define DISK_UTIL_MSEC  (250)
333
334 #ifndef min
335 #define min(a, b)       ((a) < (b) ? (a) : (b))
336 #endif
337
338 #endif