[PATCH] Add seperate read/write block size options
[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 <errno.h>
10 #include <stdlib.h>
11 #include <stdio.h>
12 #include <unistd.h>
13
14 #include "list.h"
15 #include "md5.h"
16 #include "crc32.h"
17 #include "arch.h"
18 #include "os.h"
19
20 struct io_stat {
21         unsigned long val;
22         unsigned long val_sq;
23         unsigned long max_val;
24         unsigned long min_val;
25         unsigned long samples;
26 };
27
28 struct io_sample {
29         unsigned long time;
30         unsigned long val;
31         unsigned int ddir;
32 };
33
34 struct io_log {
35         unsigned long nr_samples;
36         unsigned long max_samples;
37         struct io_sample *log;
38 };
39
40 struct io_piece {
41         struct list_head list;
42         struct fio_file *file;
43         unsigned long long offset;
44         unsigned int len;
45         int ddir;
46 };
47
48 /*
49  * The io unit
50  */
51 struct io_u {
52         union {
53 #ifdef FIO_HAVE_LIBAIO
54                 struct iocb iocb;
55 #endif
56 #ifdef FIO_HAVE_POSIXAIO
57                 struct aiocb aiocb;
58 #endif
59 #ifdef FIO_HAVE_SGIO
60                 struct sg_io_hdr hdr;
61 #endif
62         };
63         struct timeval start_time;
64         struct timeval issue_time;
65
66         void *buf;
67         unsigned int buflen;
68         unsigned long long offset;
69
70         unsigned int resid;
71         unsigned int error;
72
73         unsigned char ddir;
74
75         /*
76          * io engine private data
77          */
78         union {
79                 unsigned int index;
80                 unsigned int seen;
81         };
82
83         struct fio_file *file;
84
85         struct list_head list;
86 };
87
88 #define FIO_HDR_MAGIC   0xf00baaef
89
90 enum {
91         VERIFY_NONE = 0,
92         VERIFY_MD5,
93         VERIFY_CRC32,
94 };
95
96 struct verify_header {
97         unsigned int fio_magic;
98         unsigned int len;
99         unsigned int verify_type;
100         union {
101                 char md5_digest[MD5_HASH_WORDS * 4];
102                 unsigned long crc32;
103         };
104 };
105
106 struct group_run_stats {
107         unsigned long long max_run[2], min_run[2];
108         unsigned long long max_bw[2], min_bw[2];
109         unsigned long long io_kb[2];
110         unsigned long long agg[2];
111 };
112
113 enum fio_ddir {
114         DDIR_READ = 0,
115         DDIR_WRITE,
116         DDIR_SYNC,
117 };
118
119 /*
120  * What type of allocation to use for io buffers
121  */
122 enum fio_memtype {
123         MEM_MALLOC = 0, /* ordinary malloc */
124         MEM_SHM,        /* use shared memory segments */
125         MEM_MMAP,       /* use anonynomous mmap */
126 };
127
128 /*
129  * The type of object we are working on
130  */
131 enum fio_filetype {
132         FIO_TYPE_FILE = 1,
133         FIO_TYPE_BD,
134         FIO_TYPE_CHAR,
135 };
136
137 enum fio_ioengine_flags {
138         FIO_SYNCIO      = 1 << 0,
139         FIO_CPUIO       = 1 << 1,
140         FIO_MMAPIO      = 1 << 2,
141         FIO_RAWIO       = 1 << 3,
142 };
143
144 struct fio_file {
145         /*
146          * A file may not be a file descriptor, let the io engine decide
147          */
148         union {
149                 unsigned long file_data;
150                 int fd;
151         };
152         char *file_name;
153         void *mmap;
154         unsigned long long file_size;
155         unsigned long long real_file_size;
156         unsigned long long file_offset;
157         unsigned long long last_pos;
158
159         unsigned long *file_map;
160         unsigned int num_maps;
161 };
162
163 /*
164  * This describes a single thread/process executing a fio job.
165  */
166 struct thread_data {
167         char *name;
168         char *directory;
169         char *filename;
170         char verror[80];
171         pthread_t thread;
172         int thread_number;
173         int groupid;
174         enum fio_filetype filetype;
175         struct fio_file *files;
176         unsigned int nr_files;
177         unsigned int nr_uniq_files;
178         unsigned int next_file;
179         int error;
180         pid_t pid;
181         char *orig_buffer;
182         size_t orig_buffer_size;
183         volatile int terminate;
184         volatile int runstate;
185         enum fio_ddir ddir;
186         unsigned int iomix;
187         unsigned int ioprio;
188         unsigned int last_was_sync;
189
190         unsigned int sequential;
191         unsigned int odirect;
192         unsigned int invalidate_cache;
193         unsigned int create_serialize;
194         unsigned int create_fsync;
195         unsigned int end_fsync;
196         unsigned int sync_io;
197         unsigned int verify;
198         unsigned int use_thread;
199         unsigned int unlink;
200         unsigned int do_disk_util;
201         unsigned int override_sync;
202         unsigned int rand_repeatable;
203         unsigned int write_lat_log;
204         unsigned int write_bw_log;
205         unsigned int norandommap;
206         unsigned int bs_unaligned;
207
208         unsigned int bs[2];
209         unsigned int min_bs[2];
210         unsigned int max_bs[2];
211         unsigned int rw_min_bs;
212         unsigned int thinktime;
213         unsigned int fsync_blocks;
214         unsigned int start_delay;
215         unsigned long timeout;
216         unsigned int overwrite;
217         unsigned int bw_avg_time;
218         unsigned int loops;
219         unsigned long long zone_size;
220         unsigned long long zone_skip;
221         enum fio_memtype mem_type;
222         unsigned int stonewall;
223         unsigned int numjobs;
224         unsigned int iodepth;
225         os_cpu_mask_t cpumask;
226         unsigned int iolog;
227         unsigned int read_iolog;
228         unsigned int rwmixcycle;
229         unsigned int rwmixread;
230         unsigned int rwmixwrite;
231         unsigned int nice;
232
233         char *read_iolog_file;
234         char *write_iolog_file;
235         void *iolog_buf;
236         FILE *iolog_f;
237
238         char *sysfs_root;
239         char *ioscheduler;
240
241         os_random_state_t bsrange_state;
242         os_random_state_t verify_state;
243
244         int shm_id;
245
246         /*
247          * IO engine hooks, contains everything needed to submit an io_u
248          * to any of the available IO engines.
249          */
250         struct ioengine_ops *io_ops;
251
252         /*
253          * Current IO depth and list of free and busy io_u's.
254          */
255         unsigned int cur_depth;
256         struct list_head io_u_freelist;
257         struct list_head io_u_busylist;
258
259         /*
260          * Rate state
261          */
262         unsigned int rate;
263         unsigned int ratemin;
264         unsigned int ratecycle;
265         unsigned long rate_usec_cycle;
266         long rate_pending_usleep;
267         unsigned long rate_bytes;
268         struct timeval lastrate;
269
270         unsigned long runtime[2];               /* msec */
271         unsigned long long io_size;
272         unsigned long long total_file_size;
273         unsigned long long start_offset;
274         unsigned long long total_io_size;
275
276         unsigned long long io_blocks[2];
277         unsigned long long io_bytes[2];
278         unsigned long long zone_bytes;
279         unsigned long long this_io_bytes[2];
280         volatile int mutex;
281
282         /*
283          * State for random io, a bitmap of blocks done vs not done
284          */
285         os_random_state_t random_state;
286
287         /*
288          * CPU "io" cycle burner
289          */
290         unsigned int cpuload;
291         unsigned int cpucycle;
292
293         /*
294          * bandwidth and latency stats
295          */
296         struct io_stat clat_stat[2];            /* completion latency */
297         struct io_stat slat_stat[2];            /* submission latency */
298         struct io_stat bw_stat[2];              /* bandwidth stats */
299
300         unsigned long long stat_io_bytes[2];
301         struct timeval stat_sample_time[2];
302
303         struct io_log *slat_log;
304         struct io_log *clat_log;
305         struct io_log *bw_log;
306
307         struct timeval start;   /* start of this loop */
308         struct timeval epoch;   /* time job was started */
309
310         /*
311          * fio system usage accounting
312          */
313         struct rusage ru_start;
314         struct rusage ru_end;
315         unsigned long usr_time;
316         unsigned long sys_time;
317         unsigned long ctx;
318
319         /*
320          * read/write mixed workload state
321          */
322         os_random_state_t rwmix_state;
323         struct timeval rwmix_switch;
324         enum fio_ddir rwmix_ddir;
325
326         /*
327          * Pre-run and post-run shell
328          */
329         char *exec_prerun;
330         char *exec_postrun;
331
332         /*
333          * IO historic logs
334          */
335         struct list_head io_hist_list;
336         struct list_head io_log_list;
337 };
338
339 #define __td_verror(td, err, msg)                                       \
340         do {                                                            \
341                 int e = (err);                                          \
342                 (td)->error = e;                                        \
343                 snprintf(td->verror, sizeof(td->verror) - 1, "file:%s:%d, error=%s", __FILE__, __LINE__, (msg));        \
344         } while (0)
345
346
347 #define td_verror(td, err)      __td_verror((td), (err), strerror((err)))
348 #define td_vmsg(td, err, msg)   __td_verror((td), (err), (msg))
349
350 extern int rate_quit;
351 extern int exitall_on_terminate;
352 extern int thread_number;
353 extern int shm_id;
354 extern int groupid;
355 extern int terse_output;
356 extern FILE *f_out;
357 extern FILE *f_err;
358 extern char *fio_inst_prefix;
359 extern int temp_stall_ts;
360
361 extern struct thread_data *threads;
362
363 #define td_read(td)             ((td)->ddir == DDIR_READ)
364 #define td_write(td)            ((td)->ddir == DDIR_WRITE)
365 #define td_rw(td)               ((td)->iomix != 0)
366
367 #define BLOCKS_PER_MAP          (8 * sizeof(long))
368 #define TO_MAP_BLOCK(td, f, b)  ((b) - ((f)->file_offset / (td)->rw_min_bs))
369 #define RAND_MAP_IDX(td, f, b)  (TO_MAP_BLOCK(td, f, b) / BLOCKS_PER_MAP)
370 #define RAND_MAP_BIT(td, f, b)  (TO_MAP_BLOCK(td, f, b) & (BLOCKS_PER_MAP - 1))
371
372 #define MAX_JOBS        (1024)
373
374 static inline int should_fsync(struct thread_data *td)
375 {
376         if (td->last_was_sync)
377                 return 0;
378         if (td->odirect)
379                 return 0;
380         if (td_write(td) || td_rw(td) || td->override_sync)
381                 return 1;
382
383         return 0;
384 }
385
386 struct disk_util_stat {
387         unsigned ios[2];
388         unsigned merges[2];
389         unsigned long long sectors[2];
390         unsigned ticks[2];
391         unsigned io_ticks;
392         unsigned time_in_queue;
393 };
394
395 struct disk_util {
396         struct list_head list;
397
398         char *name;
399         char path[256];
400         dev_t dev;
401
402         struct disk_util_stat dus;
403         struct disk_util_stat last_dus;
404
405         unsigned long msec;
406         struct timeval time;
407 };
408
409 struct io_completion_data {
410         int nr;                         /* input */
411
412         int error;                      /* output */
413         unsigned long bytes_done[2];    /* output */
414 };
415
416 #define DISK_UTIL_MSEC  (250)
417
418 #ifndef min
419 #define min(a, b)       ((a) < (b) ? (a) : (b))
420 #endif
421 #ifndef max
422 #define max(a, b)       ((a) > (b) ? (a) : (b))
423 #endif
424
425 /*
426  * Log exports
427  */
428 extern int read_iolog_get(struct thread_data *, struct io_u *);
429 extern void write_iolog_put(struct thread_data *, struct io_u *);
430 extern int init_iolog(struct thread_data *td);
431 extern void log_io_piece(struct thread_data *, struct io_u *);
432 extern void prune_io_piece_log(struct thread_data *);
433 extern void write_iolog_close(struct thread_data *);
434
435 /*
436  * Logging
437  */
438 extern void add_clat_sample(struct thread_data *, int, unsigned long);
439 extern void add_slat_sample(struct thread_data *, int, unsigned long);
440 extern void add_bw_sample(struct thread_data *, int);
441 extern void show_run_stats(void);
442 extern void init_disk_util(struct thread_data *);
443 extern void update_rusage_stat(struct thread_data *);
444 extern void update_io_ticks(void);
445 extern void disk_util_timer_arm(void);
446 extern void setup_log(struct io_log **);
447 extern void finish_log(struct thread_data *, struct io_log *, const char *);
448 extern int setup_rate(struct thread_data *);
449
450 /*
451  * Time functions
452  */
453 extern void time_init(void);
454 extern unsigned long utime_since(struct timeval *, struct timeval *);
455 extern unsigned long mtime_since(struct timeval *, struct timeval *);
456 extern unsigned long mtime_since_now(struct timeval *);
457 extern unsigned long time_since_now(struct timeval *);
458 extern unsigned long mtime_since_genesis(void);
459 extern void __usec_sleep(unsigned int);
460 extern void usec_sleep(struct thread_data *, unsigned long);
461 extern void rate_throttle(struct thread_data *, unsigned long, unsigned int, int);
462
463 /*
464  * Init functions
465  */
466 extern int parse_options(int, char **);
467 extern int init_random_state(struct thread_data *);
468
469 /*
470  * File setup/shutdown
471  */
472 extern void close_files(struct thread_data *);
473 extern int setup_files(struct thread_data *);
474 extern int file_invalidate_cache(struct thread_data *, struct fio_file *);
475
476 /*
477  * ETA/status stuff
478  */
479 extern void print_thread_status(void);
480 extern void print_status_init(int);
481
482 /*
483  * Thread life cycle. Once a thread has a runstate beyond TD_INITIALIZED, it
484  * will never back again. It may cycle between running/verififying/fsyncing.
485  * Once the thread reaches TD_EXITED, it is just waiting for the core to
486  * reap it.
487  */
488 enum {
489         TD_NOT_CREATED = 0,
490         TD_CREATED,
491         TD_INITIALIZED,
492         TD_RUNNING,
493         TD_VERIFYING,
494         TD_FSYNCING,
495         TD_EXITED,
496         TD_REAPED,
497 };
498
499 /*
500  * Verify helpers
501  */
502 extern void populate_verify_io_u(struct thread_data *, struct io_u *);
503 extern int get_next_verify(struct thread_data *td, struct io_u *);
504 extern int do_io_u_verify(struct thread_data *, struct io_u **);
505
506 /*
507  * Memory helpers
508  */
509 extern int fio_pin_memory(void);
510 extern void fio_unpin_memory(void);
511 extern int allocate_io_mem(struct thread_data *);
512 extern void free_io_mem(struct thread_data *);
513
514 /*
515  * io unit handling
516  */
517 #define queue_full(td)  list_empty(&(td)->io_u_freelist)
518 extern struct io_u *__get_io_u(struct thread_data *);
519 extern struct io_u *get_io_u(struct thread_data *, struct fio_file *);
520 extern void put_io_u(struct thread_data *, struct io_u *);
521 extern void ios_completed(struct thread_data *, struct io_completion_data *);
522 extern void io_completed(struct thread_data *, struct io_u *, struct io_completion_data *);
523
524 /*
525  * io engine entry points
526  */
527 extern int td_io_init(struct thread_data *);
528 extern int td_io_prep(struct thread_data *, struct io_u *);
529 extern int td_io_queue(struct thread_data *, struct io_u *);
530 extern int td_io_sync(struct thread_data *, struct fio_file *);
531 extern int td_io_getevents(struct thread_data *, int, int, struct timespec *);
532
533 /*
534  * This is a pretty crappy semaphore implementation, but with the use that fio
535  * has (just signalling start/go conditions), it doesn't have to be better.
536  * Naturally this would not work for any type of contended semaphore or
537  * for real locking.
538  */
539 static inline void fio_sem_init(volatile int *sem, int val)
540 {
541         *sem = val;
542 }
543
544 static inline void fio_sem_down(volatile int *sem)
545 {
546         while (*sem == 0)
547                 usleep(10000);
548
549         (*sem)--;
550 }
551
552 static inline void fio_sem_up(volatile int *sem)
553 {
554         (*sem)++;
555 }
556
557 /*
558  * If logging output to a file, stderr should go to both stderr and f_err
559  */
560 #define log_err(args...)        do {            \
561         fprintf(f_err, ##args);                 \
562         if (f_err != stderr)                    \
563                 fprintf(stderr, ##args);        \
564         } while (0)
565
566 struct ioengine_ops {
567         char name[16];
568         int version;
569         int flags;
570         int (*setup)(struct thread_data *);
571         int (*init)(struct thread_data *);
572         int (*prep)(struct thread_data *, struct io_u *);
573         int (*queue)(struct thread_data *, struct io_u *);
574         int (*getevents)(struct thread_data *, int, int, struct timespec *);
575         struct io_u *(*event)(struct thread_data *, int);
576         int (*cancel)(struct thread_data *, struct io_u *);
577         void (*cleanup)(struct thread_data *);
578         void *data;
579         void *dlhandle;
580 };
581
582 #define FIO_IOOPS_VERSION       3
583
584 extern struct ioengine_ops *load_ioengine(struct thread_data *, const char *);
585 extern void close_ioengine(struct thread_data *);
586
587 /*
588  * Mark unused variables passed to ops functions as unused, to silence gcc
589  */
590 #define fio_unused      __attribute((__unused__))
591
592 #define for_each_td(td, i)      \
593         for ((i) = 0, (td) = &threads[0]; (i) < (int) thread_number; (i)++, (td)++)
594 #define for_each_file(td, f, i) \
595         for ((i) = 0, (f) = &(td)->files[0]; (i) < (int) (td)->nr_files; (i)++, (f)++)
596
597 #endif