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