Track io_u state (free or in-flight)
[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         unsigned int next_file;
284         int error;
285         pid_t pid;
286         char *orig_buffer;
287         size_t orig_buffer_size;
288         volatile int terminate;
289         volatile int runstate;
290         enum fio_ddir ddir;
291         unsigned int iomix;
292         unsigned int ioprio;
293         unsigned int last_was_sync;
294
295         unsigned int sequential;
296         unsigned int odirect;
297         unsigned int invalidate_cache;
298         unsigned int create_serialize;
299         unsigned int create_fsync;
300         unsigned int end_fsync;
301         unsigned int sync_io;
302         unsigned int verify;
303         unsigned int use_thread;
304         unsigned int unlink;
305         unsigned int do_disk_util;
306         unsigned int override_sync;
307         unsigned int rand_repeatable;
308         unsigned int write_lat_log;
309         unsigned int write_bw_log;
310         unsigned int norandommap;
311         unsigned int bs_unaligned;
312
313         unsigned int bs[2];
314         unsigned int min_bs[2];
315         unsigned int max_bs[2];
316         unsigned int hugepage_size;
317         unsigned int rw_min_bs;
318         unsigned int thinktime;
319         unsigned int thinktime_spin;
320         unsigned int thinktime_blocks;
321         unsigned int fsync_blocks;
322         unsigned int start_delay;
323         unsigned long timeout;
324         unsigned int overwrite;
325         unsigned int bw_avg_time;
326         unsigned int loops;
327         unsigned long long zone_size;
328         unsigned long long zone_skip;
329         enum fio_memtype mem_type;
330         char *mmapfile;
331         int mmapfd;
332         unsigned int stonewall;
333         unsigned int numjobs;
334         unsigned int iodepth;
335         unsigned int iodepth_low;
336         os_cpu_mask_t cpumask;
337         unsigned int iolog;
338         unsigned int read_iolog;
339         unsigned int rwmixcycle;
340         unsigned int rwmixread;
341         unsigned int rwmixwrite;
342         unsigned int nice;
343
344         char *read_iolog_file;
345         char *write_iolog_file;
346         void *iolog_buf;
347         FILE *iolog_f;
348
349         char *sysfs_root;
350         char *ioscheduler;
351
352         os_random_state_t bsrange_state;
353         os_random_state_t verify_state;
354
355         int shm_id;
356
357         /*
358          * IO engine hooks, contains everything needed to submit an io_u
359          * to any of the available IO engines.
360          */
361         struct ioengine_ops *io_ops;
362
363         /*
364          * Current IO depth and list of free and busy io_u's.
365          */
366         unsigned int cur_depth;
367         unsigned int io_u_map[FIO_IO_U_MAP_NR];
368         unsigned int io_u_lat[FIO_IO_U_LAT_NR];
369         unsigned long total_io_u;
370         struct list_head io_u_freelist;
371         struct list_head io_u_busylist;
372         struct list_head io_u_requeues;
373
374         /*
375          * Rate state
376          */
377         unsigned int rate;
378         unsigned int ratemin;
379         unsigned int ratecycle;
380         unsigned long rate_usec_cycle;
381         long rate_pending_usleep;
382         unsigned long rate_bytes;
383         struct timeval lastrate;
384
385         unsigned long runtime[2];               /* msec */
386         unsigned long long io_size;
387         unsigned long long total_file_size;
388         unsigned long long start_offset;
389         unsigned long long total_io_size;
390
391         unsigned long io_issues[2];
392         unsigned long long io_blocks[2];
393         unsigned long long io_bytes[2];
394         unsigned long long this_io_bytes[2];
395         unsigned long long zone_bytes;
396         volatile int mutex;
397
398         /*
399          * State for random io, a bitmap of blocks done vs not done
400          */
401         os_random_state_t random_state;
402
403         /*
404          * CPU "io" cycle burner
405          */
406         unsigned int cpuload;
407         unsigned int cpucycle;
408
409         struct timeval start;   /* start of this loop */
410         struct timeval epoch;   /* time job was started */
411         struct timeval end_time;/* time job ended */
412
413         /*
414          * read/write mixed workload state
415          */
416         os_random_state_t rwmix_state;
417         struct timeval rwmix_switch;
418         enum fio_ddir rwmix_ddir;
419
420         /*
421          * Pre-run and post-run shell
422          */
423         char *exec_prerun;
424         char *exec_postrun;
425
426         /*
427          * IO historic logs
428          */
429         struct list_head io_hist_list;
430         struct list_head io_log_list;
431 };
432
433 #define __td_verror(td, err, msg)                                       \
434         do {                                                            \
435                 if ((td)->error)                                        \
436                         break;                                          \
437                 int e = (err);                                          \
438                 (td)->error = e;                                        \
439                 snprintf(td->verror, sizeof(td->verror) - 1, "file:%s:%d, error=%s", __FILE__, __LINE__, (msg));        \
440         } while (0)
441
442
443 #define td_verror(td, err)      __td_verror((td), (err), strerror((err)))
444 #define td_vmsg(td, err, msg)   __td_verror((td), (err), (msg))
445
446 extern int exitall_on_terminate;
447 extern int thread_number;
448 extern int shm_id;
449 extern int groupid;
450 extern int terse_output;
451 extern FILE *f_out;
452 extern FILE *f_err;
453 extern int temp_stall_ts;
454 extern unsigned long long mlock_size;
455
456 extern struct thread_data *threads;
457
458 #define td_read(td)             ((td)->ddir == DDIR_READ)
459 #define td_write(td)            ((td)->ddir == DDIR_WRITE)
460 #define td_rw(td)               ((td)->iomix != 0)
461
462 #define BLOCKS_PER_MAP          (8 * sizeof(long))
463 #define TO_MAP_BLOCK(td, f, b)  ((b) - ((f)->file_offset / (td)->rw_min_bs))
464 #define RAND_MAP_IDX(td, f, b)  (TO_MAP_BLOCK(td, f, b) / BLOCKS_PER_MAP)
465 #define RAND_MAP_BIT(td, f, b)  (TO_MAP_BLOCK(td, f, b) & (BLOCKS_PER_MAP - 1))
466
467 #define MAX_JOBS        (1024)
468
469 static inline int should_fsync(struct thread_data *td)
470 {
471         if (td->last_was_sync)
472                 return 0;
473         if (td->odirect)
474                 return 0;
475         if (td_write(td) || td_rw(td) || td->override_sync)
476                 return 1;
477
478         return 0;
479 }
480
481 /*
482  * Disk utils as read in /sys/block/<dev>/stat
483  */
484 struct disk_util_stat {
485         unsigned ios[2];
486         unsigned merges[2];
487         unsigned long long sectors[2];
488         unsigned ticks[2];
489         unsigned io_ticks;
490         unsigned time_in_queue;
491 };
492
493 /*
494  * Per-device disk util management
495  */
496 struct disk_util {
497         struct list_head list;
498
499         char *name;
500         char path[256];
501         dev_t dev;
502
503         struct disk_util_stat dus;
504         struct disk_util_stat last_dus;
505
506         unsigned long msec;
507         struct timeval time;
508 };
509
510 /*
511  * Callback for io completion
512  */
513 typedef int (endio_handler)(struct io_u *);
514
515 #define DISK_UTIL_MSEC  (250)
516
517 #ifndef min
518 #define min(a, b)       ((a) < (b) ? (a) : (b))
519 #endif
520 #ifndef max
521 #define max(a, b)       ((a) > (b) ? (a) : (b))
522 #endif
523
524 /*
525  * Log exports
526  */
527 extern int __must_check read_iolog_get(struct thread_data *, struct io_u *);
528 extern void write_iolog_put(struct thread_data *, struct io_u *);
529 extern int __must_check init_iolog(struct thread_data *td);
530 extern void log_io_piece(struct thread_data *, struct io_u *);
531 extern void prune_io_piece_log(struct thread_data *);
532 extern void write_iolog_close(struct thread_data *);
533
534 /*
535  * Logging
536  */
537 extern void add_clat_sample(struct thread_data *, enum fio_ddir, unsigned long);
538 extern void add_slat_sample(struct thread_data *, enum fio_ddir, unsigned long);
539 extern void add_bw_sample(struct thread_data *, enum fio_ddir, struct timeval *);
540 extern void show_run_stats(void);
541 extern void init_disk_util(struct thread_data *);
542 extern void update_rusage_stat(struct thread_data *);
543 extern void update_io_ticks(void);
544 extern void disk_util_timer_arm(void);
545 extern void setup_log(struct io_log **);
546 extern void finish_log(struct thread_data *, struct io_log *, const char *);
547 extern void __finish_log(struct io_log *, const char *);
548 extern int setup_rate(struct thread_data *);
549 extern struct io_log *agg_io_log[2];
550 extern int write_bw_log;
551 extern void add_agg_sample(unsigned long, enum fio_ddir);
552
553 /*
554  * Time functions
555  */
556 extern unsigned long utime_since(struct timeval *, struct timeval *);
557 extern unsigned long utime_since_now(struct timeval *);
558 extern unsigned long mtime_since(struct timeval *, struct timeval *);
559 extern unsigned long mtime_since_now(struct timeval *);
560 extern unsigned long time_since_now(struct timeval *);
561 extern unsigned long mtime_since_genesis(void);
562 extern void __usec_sleep(unsigned int);
563 extern void usec_sleep(struct thread_data *, unsigned long);
564 extern void rate_throttle(struct thread_data *, unsigned long, unsigned int, int);
565 extern void fill_start_time(struct timeval *);
566 extern void fio_gettime(struct timeval *, void *);
567
568 /*
569  * Init functions
570  */
571 extern int __must_check parse_options(int, char **);
572 extern int __must_check init_random_state(struct thread_data *);
573
574 /*
575  * File setup/shutdown
576  */
577 extern void close_files(struct thread_data *);
578 extern int __must_check setup_files(struct thread_data *);
579 extern int __must_check open_files(struct thread_data *);
580 extern int __must_check file_invalidate_cache(struct thread_data *, struct fio_file *);
581
582 /*
583  * ETA/status stuff
584  */
585 extern void print_thread_status(void);
586 extern void print_status_init(int);
587
588 /*
589  * Thread life cycle. Once a thread has a runstate beyond TD_INITIALIZED, it
590  * will never back again. It may cycle between running/verififying/fsyncing.
591  * Once the thread reaches TD_EXITED, it is just waiting for the core to
592  * reap it.
593  */
594 enum {
595         TD_NOT_CREATED = 0,
596         TD_CREATED,
597         TD_INITIALIZED,
598         TD_RUNNING,
599         TD_VERIFYING,
600         TD_FSYNCING,
601         TD_EXITED,
602         TD_REAPED,
603 };
604
605 /*
606  * Verify helpers
607  */
608 extern void populate_verify_io_u(struct thread_data *, struct io_u *);
609 extern int __must_check get_next_verify(struct thread_data *td, struct io_u *);
610 extern int __must_check verify_io_u(struct io_u *);
611
612 /*
613  * Memory helpers
614  */
615 extern int __must_check fio_pin_memory(void);
616 extern void fio_unpin_memory(void);
617 extern int __must_check allocate_io_mem(struct thread_data *);
618 extern void free_io_mem(struct thread_data *);
619
620 /*
621  * io unit handling
622  */
623 #define queue_full(td)  list_empty(&(td)->io_u_freelist)
624 extern struct io_u *__get_io_u(struct thread_data *);
625 extern struct io_u *get_io_u(struct thread_data *);
626 extern void put_io_u(struct thread_data *, struct io_u *);
627 extern void requeue_io_u(struct thread_data *, struct io_u **);
628 extern long __must_check io_u_sync_complete(struct thread_data *, struct io_u *, endio_handler *);
629 extern long __must_check io_u_queued_complete(struct thread_data *, int, endio_handler *);
630 extern void io_u_queued(struct thread_data *, struct io_u *);
631
632 /*
633  * io engine entry points
634  */
635 extern int __must_check td_io_init(struct thread_data *);
636 extern int __must_check td_io_prep(struct thread_data *, struct io_u *);
637 extern int __must_check td_io_queue(struct thread_data *, struct io_u *);
638 extern int __must_check td_io_sync(struct thread_data *, struct fio_file *);
639 extern int __must_check td_io_getevents(struct thread_data *, int, int, struct timespec *);
640 extern int __must_check td_io_commit(struct thread_data *);
641
642 /*
643  * This is a pretty crappy semaphore implementation, but with the use that fio
644  * has (just signalling start/go conditions), it doesn't have to be better.
645  * Naturally this would not work for any type of contended semaphore or
646  * for real locking.
647  */
648 static inline void fio_sem_init(volatile int *sem, int val)
649 {
650         *sem = val;
651 }
652
653 static inline void fio_sem_down(volatile int *sem)
654 {
655         while (*sem == 0)
656                 usleep(10000);
657
658         (*sem)--;
659 }
660
661 static inline void fio_sem_up(volatile int *sem)
662 {
663         (*sem)++;
664 }
665
666 /*
667  * If logging output to a file, stderr should go to both stderr and f_err
668  */
669 #define log_err(args...)        do {            \
670         fprintf(f_err, ##args);                 \
671         if (f_err != stderr)                    \
672                 fprintf(stderr, ##args);        \
673         } while (0)
674
675 struct ioengine_ops {
676         struct list_head list;
677         char name[16];
678         int version;
679         int flags;
680         int (*setup)(struct thread_data *);
681         int (*init)(struct thread_data *);
682         int (*prep)(struct thread_data *, struct io_u *);
683         int (*queue)(struct thread_data *, struct io_u *);
684         int (*commit)(struct thread_data *);
685         int (*getevents)(struct thread_data *, int, int, struct timespec *);
686         struct io_u *(*event)(struct thread_data *, int);
687         int (*cancel)(struct thread_data *, struct io_u *);
688         void (*cleanup)(struct thread_data *);
689         void *data;
690         void *dlhandle;
691         unsigned long priv;
692 };
693
694 #define FIO_IOOPS_VERSION       5
695
696 extern struct ioengine_ops *load_ioengine(struct thread_data *, const char *);
697 extern void register_ioengine(struct ioengine_ops *);
698 extern void unregister_ioengine(struct ioengine_ops *);
699 extern void close_ioengine(struct thread_data *);
700
701 /*
702  * Mark unused variables passed to ops functions as unused, to silence gcc
703  */
704 #define fio_unused      __attribute((__unused__))
705 #define fio_init        __attribute__((constructor))
706 #define fio_exit        __attribute__((destructor))
707
708 #define for_each_td(td, i)      \
709         for ((i) = 0, (td) = &threads[0]; (i) < (int) thread_number; (i)++, (td)++)
710 #define for_each_file(td, f, i) \
711         for ((i) = 0, (f) = &(td)->files[0]; (i) < (int) (td)->nr_files; (i)++, (f)++)
712
713 #define fio_assert(td, cond)    do {    \
714         if (!(cond)) {                  \
715                 int *__foo = NULL;      \
716                 fprintf(stderr, "file:%s:%d, assert %s failed\n", __FILE__, __LINE__, #cond);   \
717                 (td)->runstate = TD_EXITED;     \
718                 (td)->error = EFAULT;           \
719                 *__foo = 0;                     \
720         }       \
721 } while (0)
722
723 #endif