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