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