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