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