blktrace replay: delay support
[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 #include <getopt.h>
15
16 #include "compiler/compiler.h"
17 #include "list.h"
18 #include "rbtree.h"
19 #include "md5.h"
20 #include "crc32.h"
21 #include "arch/arch.h"
22 #include "os/os.h"
23 #include "mutex.h"
24
25 #ifdef FIO_HAVE_SYSLET
26 #include "syslet.h"
27 #endif
28
29 #ifdef FIO_HAVE_GUASI
30 #include <guasi.h>
31 #endif
32
33 enum fio_ddir {
34         DDIR_READ = 0,
35         DDIR_WRITE,
36         DDIR_SYNC,
37 };
38
39 enum td_ddir {
40         TD_DDIR_READ            = 1 << 0,
41         TD_DDIR_WRITE           = 1 << 1,
42         TD_DDIR_RAND            = 1 << 2,
43         TD_DDIR_RW              = TD_DDIR_READ | TD_DDIR_WRITE,
44         TD_DDIR_RANDREAD        = TD_DDIR_READ | TD_DDIR_RAND,
45         TD_DDIR_RANDWRITE       = TD_DDIR_WRITE | TD_DDIR_RAND,
46         TD_DDIR_RANDRW          = TD_DDIR_RW | TD_DDIR_RAND,
47 };
48
49 /*
50  * Use for maintaining statistics
51  */
52 struct io_stat {
53         unsigned long max_val;
54         unsigned long min_val;
55         unsigned long samples;
56
57         double mean;
58         double S;
59 };
60
61 /*
62  * A single data sample
63  */
64 struct io_sample {
65         unsigned long time;
66         unsigned long val;
67         enum fio_ddir ddir;
68 };
69
70 /*
71  * Dynamically growing data sample log
72  */
73 struct io_log {
74         unsigned long nr_samples;
75         unsigned long max_samples;
76         struct io_sample *log;
77 };
78
79 /*
80  * When logging io actions, this matches a single sent io_u
81  */
82 struct io_piece {
83         union {
84                 struct rb_node rb_node;
85                 struct list_head list;
86         };
87         struct fio_file *file;
88         unsigned long long offset;
89         unsigned long len;
90         enum fio_ddir ddir;
91         unsigned long delay;
92 };
93
94 #ifdef FIO_HAVE_SYSLET
95 struct syslet_req {
96         struct syslet_uatom atom;       /* the atom to submit */
97         struct syslet_uatom *head;      /* head of the sequence */
98         long ret;                       /* syscall return value */
99 };
100 #endif
101
102 enum {
103         IO_U_F_FREE     = 1 << 0,
104         IO_U_F_FLIGHT   = 1 << 1,
105 };
106
107 struct thread_data;
108
109 /*
110  * The io unit
111  */
112 struct io_u {
113         union {
114 #ifdef FIO_HAVE_LIBAIO
115                 struct iocb iocb;
116 #endif
117 #ifdef FIO_HAVE_POSIXAIO
118                 struct aiocb aiocb;
119 #endif
120 #ifdef FIO_HAVE_SGIO
121                 struct sg_io_hdr hdr;
122 #endif
123 #ifdef FIO_HAVE_SYSLET
124                 struct syslet_req req;
125 #endif
126 #ifdef FIO_HAVE_GUASI
127                 guasi_req_t greq;
128 #endif
129         };
130         struct timeval start_time;
131         struct timeval issue_time;
132
133         /*
134          * Allocated/set buffer and length
135          */
136         void *buf;
137         unsigned long buflen;
138         unsigned long long offset;
139         unsigned long long endpos;
140
141         /*
142          * IO engine state, may be different from above when we get
143          * partial transfers / residual data counts
144          */
145         void *xfer_buf;
146         unsigned long xfer_buflen;
147
148         unsigned int resid;
149         unsigned int error;
150
151         enum fio_ddir ddir;
152
153         /*
154          * io engine private data
155          */
156         union {
157                 unsigned int index;
158                 unsigned int seen;
159         };
160
161         unsigned int flags;
162
163         struct fio_file *file;
164
165         struct list_head list;
166
167         /*
168          * Callback for io completion
169          */
170         int (*end_io)(struct thread_data *, struct io_u *);
171 };
172
173 /*
174  * io_ops->queue() return values
175  */
176 enum {
177         FIO_Q_COMPLETED = 0,            /* completed sync */
178         FIO_Q_QUEUED    = 1,            /* queued, will complete async */
179         FIO_Q_BUSY      = 2,            /* no more room, call ->commit() */
180 };
181
182 #define FIO_HDR_MAGIC   0xf00baaef
183
184 enum {
185         VERIFY_NONE = 0,                /* no verification */
186         VERIFY_MD5,                     /* md5 sum data blocks */
187         VERIFY_CRC32,                   /* crc32 sum data blocks */
188         VERIFY_NULL,                    /* pretend to verify */
189 };
190
191 /*
192  * A header structure associated with each checksummed data block
193  */
194 struct verify_header {
195         unsigned int fio_magic;
196         unsigned int len;
197         unsigned int verify_type;
198         union {
199                 char md5_digest[MD5_HASH_WORDS * 4];
200                 unsigned long crc32;
201         };
202 };
203
204 struct group_run_stats {
205         unsigned long long max_run[2], min_run[2];
206         unsigned long long max_bw[2], min_bw[2];
207         unsigned long long io_kb[2];
208         unsigned long long agg[2];
209 };
210
211 /*
212  * What type of allocation to use for io buffers
213  */
214 enum fio_memtype {
215         MEM_MALLOC = 0, /* ordinary malloc */
216         MEM_SHM,        /* use shared memory segments */
217         MEM_SHMHUGE,    /* use shared memory segments with huge pages */
218         MEM_MMAP,       /* use anonynomous mmap */
219         MEM_MMAPHUGE,   /* memory mapped huge file */
220 };
221
222 /*
223  * The type of object we are working on
224  */
225 enum fio_filetype {
226         FIO_TYPE_FILE = 1,              /* plain file */
227         FIO_TYPE_BD,                    /* block device */
228         FIO_TYPE_CHAR,                  /* character device */
229         FIO_TYPE_PIPE,                  /* pipe */
230 };
231
232 enum fio_ioengine_flags {
233         FIO_SYNCIO      = 1 << 0,       /* io engine has synchronous ->queue */
234         FIO_RAWIO       = 1 << 1,       /* some sort of direct/raw io */
235         FIO_DISKLESSIO  = 1 << 2,       /* no disk involved */
236         FIO_NOEXTEND    = 1 << 3,       /* engine can't extend file */
237         FIO_NODISKUTIL  = 1 << 4,       /* diskutil can't handle filename */
238 };
239
240 enum fio_file_flags {
241         FIO_FILE_OPEN           = 1 << 0,       /* file is open */
242         FIO_FILE_CLOSING        = 1 << 1,       /* file being closed */
243         FIO_FILE_EXISTS         = 1 << 2,       /* file there */
244         FIO_FILE_EXTEND         = 1 << 3,       /* needs extend */
245         FIO_FILE_NOSORT         = 1 << 4,       /* don't sort verify blocks */
246         FIO_FILE_DONE           = 1 << 5,       /* io completed to this file */
247         FIO_SIZE_KNOWN          = 1 << 6,       /* size has been set */
248 };
249
250 /*
251  * Each thread_data structure has a number of files associated with it,
252  * this structure holds state information for a single file.
253  */
254 struct fio_file {
255         enum fio_filetype filetype;
256
257         /*
258          * A file may not be a file descriptor, let the io engine decide
259          */
260         union {
261                 unsigned long file_data;
262                 int fd;
263         };
264
265         /*
266          * filename and possible memory mapping
267          */
268         char *file_name;
269         void *mmap;
270
271         /*
272          * size of the file, offset into file, and io size from that offset
273          */
274         unsigned long long real_file_size;
275         unsigned long long file_offset;
276         unsigned long long io_size;
277
278         unsigned long long last_pos;
279         unsigned long long last_completed_pos;
280
281         /*
282          * block map for random io
283          */
284         unsigned long *file_map;
285         unsigned int num_maps;
286         unsigned int last_free_lookup;
287
288         int references;
289         enum fio_file_flags flags;
290 };
291
292 /*
293  * How many depth levels to log
294  */
295 #define FIO_IO_U_MAP_NR 8
296 #define FIO_IO_U_LAT_NR 12
297
298 struct thread_stat {
299         char *name;
300         char *verror;
301         int error;
302         int groupid;
303         pid_t pid;
304         char *description;
305         int members;
306
307         struct io_log *slat_log;
308         struct io_log *clat_log;
309         struct io_log *bw_log;
310
311         /*
312          * bandwidth and latency stats
313          */
314         struct io_stat clat_stat[2];            /* completion latency */
315         struct io_stat slat_stat[2];            /* submission latency */
316         struct io_stat bw_stat[2];              /* bandwidth stats */
317
318         unsigned long long stat_io_bytes[2];
319         struct timeval stat_sample_time[2];
320
321         /*
322          * fio system usage accounting
323          */
324         struct rusage ru_start;
325         struct rusage ru_end;
326         unsigned long usr_time;
327         unsigned long sys_time;
328         unsigned long ctx;
329
330         /*
331          * IO depth and latency stats
332          */
333         unsigned int io_u_map[FIO_IO_U_MAP_NR];
334         unsigned int io_u_lat[FIO_IO_U_LAT_NR];
335         unsigned long total_io_u[2];
336         unsigned long short_io_u[2];
337
338         unsigned long long io_bytes[2];
339         unsigned long runtime[2];
340         unsigned long total_run_time;
341 };
342
343 struct thread_options {
344         int pad;
345         char *description;
346         char *name;
347         char *directory;
348         char *filename;
349         char *opendir;
350         char *ioengine;
351         enum td_ddir td_ddir;
352         unsigned int ddir_nr;
353         unsigned int iodepth;
354         unsigned int iodepth_low;
355         unsigned int iodepth_batch;
356
357         unsigned long long size;
358         unsigned long long file_size_low;
359         unsigned long long file_size_high;
360         unsigned long long start_offset;
361
362         unsigned int bs[2];
363         unsigned int min_bs[2];
364         unsigned int max_bs[2];
365
366         unsigned int nr_files;
367         unsigned int open_files;
368
369         unsigned int odirect;
370         unsigned int invalidate_cache;
371         unsigned int create_serialize;
372         unsigned int create_fsync;
373         unsigned int end_fsync;
374         unsigned int sync_io;
375         unsigned int verify;
376         unsigned int verifysort;
377         unsigned int use_thread;
378         unsigned int unlink;
379         unsigned int do_disk_util;
380         unsigned int override_sync;
381         unsigned int rand_repeatable;
382         unsigned int write_lat_log;
383         unsigned int write_bw_log;
384         unsigned int norandommap;
385         unsigned int bs_unaligned;
386         unsigned int fsync_on_close;
387
388         unsigned int hugepage_size;
389         unsigned int rw_min_bs;
390         unsigned int thinktime;
391         unsigned int thinktime_spin;
392         unsigned int thinktime_blocks;
393         unsigned int fsync_blocks;
394         unsigned int start_delay;
395         unsigned long timeout;
396         unsigned int overwrite;
397         unsigned int bw_avg_time;
398         unsigned int loops;
399         unsigned long long zone_size;
400         unsigned long long zone_skip;
401         enum fio_memtype mem_type;
402
403         unsigned int stonewall;
404         unsigned int new_group;
405         unsigned int numjobs;
406         os_cpu_mask_t cpumask;
407         unsigned int iolog;
408         unsigned int rwmixcycle;
409         unsigned int rwmix[2];
410         unsigned int nice;
411         unsigned int file_service_type;
412         unsigned int group_reporting;
413         unsigned int fadvise_hint;
414         unsigned int zero_buffers;
415         unsigned int time_based;
416
417         char *read_iolog_file;
418         char *write_iolog_file;
419
420         /*
421          * Pre-run and post-run shell
422          */
423         char *exec_prerun;
424         char *exec_postrun;
425
426         unsigned int rate;
427         unsigned int ratemin;
428         unsigned int ratecycle;
429         unsigned int rate_iops;
430         unsigned int rate_iops_min;
431
432         char *ioscheduler;
433
434         /*
435          * CPU "io" cycle burner
436          */
437         unsigned int cpuload;
438         unsigned int cpucycle;
439 };
440
441 #define FIO_VERROR_SIZE 128
442
443 /*
444  * This describes a single thread/process executing a fio job.
445  */
446 struct thread_data {
447         struct thread_options o;
448         char verror[FIO_VERROR_SIZE];
449         pthread_t thread;
450         int thread_number;
451         int groupid;
452         struct thread_stat ts;
453         struct fio_file *files;
454         unsigned int files_index;
455         unsigned int nr_open_files;
456         unsigned int nr_done_files;
457         unsigned int nr_normal_files;
458         union {
459                 unsigned int next_file;
460                 os_random_state_t next_file_state;
461         };
462         int error;
463         pid_t pid;
464         char *orig_buffer;
465         size_t orig_buffer_size;
466         volatile int terminate;
467         volatile int runstate;
468         unsigned int ioprio;
469         unsigned int last_was_sync;
470
471         char *mmapfile;
472         int mmapfd;
473
474         void *iolog_buf;
475         FILE *iolog_f;
476
477         char *sysfs_root;
478
479         os_random_state_t bsrange_state;
480         os_random_state_t verify_state;
481
482         int shm_id;
483
484         /*
485          * IO engine hooks, contains everything needed to submit an io_u
486          * to any of the available IO engines.
487          */
488         struct ioengine_ops *io_ops;
489
490         /*
491          * Current IO depth and list of free and busy io_u's.
492          */
493         unsigned int cur_depth;
494         struct list_head io_u_freelist;
495         struct list_head io_u_busylist;
496         struct list_head io_u_requeues;
497         unsigned int io_u_queued;
498
499         /*
500          * Rate state
501          */
502         unsigned long rate_usec_cycle;
503         long rate_pending_usleep;
504         unsigned long rate_bytes;
505         unsigned long rate_blocks;
506         struct timeval lastrate;
507
508         unsigned long long total_io_size;
509
510         unsigned long io_issues[2];
511         unsigned long long io_blocks[2];
512         unsigned long long io_bytes[2];
513         unsigned long long this_io_bytes[2];
514         unsigned long long zone_bytes;
515         struct fio_sem *mutex;
516
517         /*
518          * State for random io, a bitmap of blocks done vs not done
519          */
520         os_random_state_t random_state;
521
522         struct timeval start;   /* start of this loop */
523         struct timeval epoch;   /* time job was started */
524         struct timeval rw_end[2];
525         struct timeval last_issue;
526         unsigned int rw_end_set[2];
527
528         /*
529          * read/write mixed workload state
530          */
531         os_random_state_t rwmix_state;
532         unsigned long long rwmix_bytes;
533         struct timeval rwmix_switch;
534         enum fio_ddir rwmix_ddir;
535         unsigned int ddir_nr;
536
537         /*
538          * IO history logs for verification. We use a tree for sorting,
539          * if we are overwriting. Otherwise just use a fifo.
540          */
541         struct rb_root io_hist_tree;
542         struct list_head io_hist_list;
543
544         /*
545          * For IO replaying
546          */
547         struct list_head io_log_list;
548
549         /*
550          * timeout handling
551          */
552         struct timeval timeout_end;
553         struct itimerval timer;
554
555         /*
556          * for fileservice, how often to switch to a new file
557          */
558         unsigned int file_service_nr;
559         unsigned int file_service_left;
560         struct fio_file *file_service_file;
561
562         /*
563          * For generating file sizes
564          */
565         os_random_state_t file_size_state;
566 };
567
568 /*
569  * roundrobin available files, or choose one at random.
570  */
571 enum {
572         FIO_FSERVICE_RANDOM     = 1,
573         FIO_FSERVICE_RR         = 2,
574 };
575
576 /*
577  * 30 second per-io_u timeout, with 5 second intervals to avoid resetting
578  * the timer on each queue operation.
579  */
580 #define IO_U_TIMEOUT_INC        5
581 #define IO_U_TIMEOUT            30
582
583 #define __td_verror(td, err, msg, func)                                 \
584         do {                                                            \
585                 if ((td)->error)                                        \
586                         break;                                          \
587                 int e = (err);                                          \
588                 (td)->error = e;                                        \
589                 snprintf(td->verror, sizeof(td->verror) - 1, "file:%s:%d, func=%s, error=%s", __FILE__, __LINE__, (func), (msg));       \
590         } while (0)
591
592
593 #define td_verror(td, err, func)        \
594         __td_verror((td), (err), strerror((err)), (func))
595 #define td_vmsg(td, err, msg, func)     \
596         __td_verror((td), (err), (msg), (func))
597
598 extern int exitall_on_terminate;
599 extern int thread_number;
600 extern int nr_process, nr_thread;
601 extern int shm_id;
602 extern int groupid;
603 extern int terse_output;
604 extern FILE *f_out;
605 extern FILE *f_err;
606 extern int temp_stall_ts;
607 extern unsigned long long mlock_size;
608 extern unsigned long page_mask, page_size;
609
610 extern struct thread_data *threads;
611
612 #define td_read(td)             ((td)->o.td_ddir & TD_DDIR_READ)
613 #define td_write(td)            ((td)->o.td_ddir & TD_DDIR_WRITE)
614 #define td_rw(td)               (((td)->o.td_ddir & TD_DDIR_RW) == TD_DDIR_RW)
615 #define td_random(td)           ((td)->o.td_ddir & TD_DDIR_RAND)
616
617 #define BLOCKS_PER_MAP          (8 * sizeof(long))
618 #define TO_MAP_BLOCK(td, f, b)  ((b) - ((f)->file_offset / (td)->o.rw_min_bs))
619 #define RAND_MAP_IDX(td, f, b)  (TO_MAP_BLOCK(td, f, b) / BLOCKS_PER_MAP)
620 #define RAND_MAP_BIT(td, f, b)  (TO_MAP_BLOCK(td, f, b) & (BLOCKS_PER_MAP - 1))
621
622 #define MAX_JOBS        (1024)
623
624 static inline int should_fsync(struct thread_data *td)
625 {
626         if (td->last_was_sync)
627                 return 0;
628         if (td->o.odirect)
629                 return 0;
630         if (td_write(td) || td_rw(td) || td->o.override_sync)
631                 return 1;
632
633         return 0;
634 }
635
636 /*
637  * Disk utils as read in /sys/block/<dev>/stat
638  */
639 struct disk_util_stat {
640         unsigned ios[2];
641         unsigned merges[2];
642         unsigned long long sectors[2];
643         unsigned ticks[2];
644         unsigned io_ticks;
645         unsigned time_in_queue;
646 };
647
648 /*
649  * Per-device disk util management
650  */
651 struct disk_util {
652         struct list_head list;
653
654         char *name;
655         char *sysfs_root;
656         char path[256];
657         int major, minor;
658
659         struct disk_util_stat dus;
660         struct disk_util_stat last_dus;
661
662         unsigned long msec;
663         struct timeval time;
664 };
665
666 #define DISK_UTIL_MSEC  (250)
667
668 #ifndef min
669 #define min(a, b)       ((a) < (b) ? (a) : (b))
670 #endif
671 #ifndef max
672 #define max(a, b)       ((a) > (b) ? (a) : (b))
673 #endif
674
675 /*
676  * Log exports
677  */
678 extern int __must_check read_iolog_get(struct thread_data *, struct io_u *);
679 extern void write_iolog_put(struct thread_data *, struct io_u *);
680 extern int __must_check init_iolog(struct thread_data *td);
681 extern void log_io_piece(struct thread_data *, struct io_u *);
682 extern void prune_io_piece_log(struct thread_data *);
683 extern void write_iolog_close(struct thread_data *);
684
685 /*
686  * Logging
687  */
688 extern void add_clat_sample(struct thread_data *, enum fio_ddir, unsigned long);
689 extern void add_slat_sample(struct thread_data *, enum fio_ddir, unsigned long);
690 extern void add_bw_sample(struct thread_data *, enum fio_ddir, struct timeval *);
691 extern void show_run_stats(void);
692 extern void init_disk_util(struct thread_data *);
693 extern void update_rusage_stat(struct thread_data *);
694 extern void update_io_ticks(void);
695 extern void disk_util_timer_arm(void);
696 extern void setup_log(struct io_log **);
697 extern void finish_log(struct thread_data *, struct io_log *, const char *);
698 extern void __finish_log(struct io_log *, const char *);
699 extern struct io_log *agg_io_log[2];
700 extern int write_bw_log;
701 extern void add_agg_sample(unsigned long, enum fio_ddir);
702
703 /*
704  * Time functions
705  */
706 extern unsigned long utime_since(struct timeval *, struct timeval *);
707 extern unsigned long utime_since_now(struct timeval *);
708 extern unsigned long mtime_since(struct timeval *, struct timeval *);
709 extern unsigned long mtime_since_now(struct timeval *);
710 extern unsigned long time_since_now(struct timeval *);
711 extern unsigned long mtime_since_genesis(void);
712 extern void __usec_sleep(unsigned int);
713 extern void usec_sleep(struct thread_data *, unsigned long);
714 extern void rate_throttle(struct thread_data *, unsigned long, unsigned int);
715 extern void fill_start_time(struct timeval *);
716 extern void fio_gettime(struct timeval *, void *);
717 extern void set_genesis_time(void);
718
719 /*
720  * Init/option functions
721  */
722 extern int __must_check parse_options(int, char **);
723 extern int fio_option_parse(struct thread_data *, const char *);
724 extern int fio_cmd_option_parse(struct thread_data *, const char *, char *);
725 extern void fio_fill_default_options(struct thread_data *);
726 extern int fio_show_option_help(const char *);
727 extern void fio_options_dup_and_init(struct option *);
728 extern void options_mem_dupe(struct thread_data *);
729 extern void options_mem_free(struct thread_data *);
730 #define FIO_GETOPT_JOB          0x89988998
731 #define FIO_NR_OPTIONS          128
732
733 /*
734  * File setup/shutdown
735  */
736 extern void close_files(struct thread_data *);
737 extern int __must_check setup_files(struct thread_data *);
738 extern int __must_check open_files(struct thread_data *);
739 extern int __must_check file_invalidate_cache(struct thread_data *, struct fio_file *);
740 extern int __must_check generic_open_file(struct thread_data *, struct fio_file *);
741 extern void generic_close_file(struct thread_data *, struct fio_file *);
742 extern void add_file(struct thread_data *, const char *);
743 extern void get_file(struct fio_file *);
744 extern void put_file(struct thread_data *, struct fio_file *);
745 extern int add_dir_files(struct thread_data *, const char *);
746 extern int init_random_map(struct thread_data *);
747 extern void dup_files(struct thread_data *, struct thread_data *);
748
749 /*
750  * ETA/status stuff
751  */
752 extern void print_thread_status(void);
753 extern void print_status_init(int);
754
755 /*
756  * disk util stuff
757  */
758 #ifdef FIO_HAVE_DISK_UTIL
759 extern void show_disk_util(void);
760 extern void disk_util_timer_arm(void);
761 extern void init_disk_util(struct thread_data *);
762 extern void update_io_ticks(void);
763 #else
764 #define show_disk_util()
765 #define disk_util_timer_arm()
766 #define init_disk_util(td)
767 #define update_io_ticks()
768 #endif
769
770 /*
771  * Thread life cycle. Once a thread has a runstate beyond TD_INITIALIZED, it
772  * will never back again. It may cycle between running/verififying/fsyncing.
773  * Once the thread reaches TD_EXITED, it is just waiting for the core to
774  * reap it.
775  */
776 enum {
777         TD_NOT_CREATED = 0,
778         TD_CREATED,
779         TD_INITIALIZED,
780         TD_RUNNING,
781         TD_VERIFYING,
782         TD_FSYNCING,
783         TD_EXITED,
784         TD_REAPED,
785 };
786
787 /*
788  * Verify helpers
789  */
790 extern void populate_verify_io_u(struct thread_data *, struct io_u *);
791 extern int __must_check get_next_verify(struct thread_data *td, struct io_u *);
792 extern int __must_check verify_io_u(struct thread_data *, struct io_u *);
793
794 /*
795  * Memory helpers
796  */
797 extern int __must_check fio_pin_memory(void);
798 extern void fio_unpin_memory(void);
799 extern int __must_check allocate_io_mem(struct thread_data *);
800 extern void free_io_mem(struct thread_data *);
801
802 /*
803  * io unit handling
804  */
805 #define queue_full(td)  list_empty(&(td)->io_u_freelist)
806 extern struct io_u *__get_io_u(struct thread_data *);
807 extern struct io_u *get_io_u(struct thread_data *);
808 extern void put_io_u(struct thread_data *, struct io_u *);
809 extern void requeue_io_u(struct thread_data *, struct io_u **);
810 extern long __must_check io_u_sync_complete(struct thread_data *, struct io_u *);
811 extern long __must_check io_u_queued_complete(struct thread_data *, int);
812 extern void io_u_queued(struct thread_data *, struct io_u *);
813 extern void io_u_log_error(struct thread_data *, struct io_u *);
814 extern void io_u_init_timeout(void);
815 extern void io_u_set_timeout(struct thread_data *);
816 extern void io_u_mark_depth(struct thread_data *, struct io_u *);
817
818 /*
819  * io engine entry points
820  */
821 extern int __must_check td_io_init(struct thread_data *);
822 extern int __must_check td_io_prep(struct thread_data *, struct io_u *);
823 extern int __must_check td_io_queue(struct thread_data *, struct io_u *);
824 extern int __must_check td_io_sync(struct thread_data *, struct fio_file *);
825 extern int __must_check td_io_getevents(struct thread_data *, int, int, struct timespec *);
826 extern int __must_check td_io_commit(struct thread_data *);
827 extern int __must_check td_io_open_file(struct thread_data *, struct fio_file *);
828 extern void td_io_close_file(struct thread_data *, struct fio_file *);
829
830 /*
831  * blktrace support
832  */
833 extern int is_blktrace(const char *);
834 extern int load_blktrace(struct thread_data *, const char *);
835
836 /*
837  * If logging output to a file, stderr should go to both stderr and f_err
838  */
839 #define log_err(args...)        do {            \
840         fprintf(f_err, ##args);                 \
841         if (f_err != stderr)                    \
842                 fprintf(stderr, ##args);        \
843         } while (0)
844
845 #define log_info(args...)       fprintf(f_out, ##args)
846
847 FILE *get_f_out(void);
848 FILE *get_f_err(void);
849
850 struct ioengine_ops {
851         struct list_head list;
852         char name[16];
853         int version;
854         int flags;
855         int (*setup)(struct thread_data *);
856         int (*init)(struct thread_data *);
857         int (*prep)(struct thread_data *, struct io_u *);
858         int (*queue)(struct thread_data *, struct io_u *);
859         int (*commit)(struct thread_data *);
860         int (*getevents)(struct thread_data *, int, int, struct timespec *);
861         struct io_u *(*event)(struct thread_data *, int);
862         int (*cancel)(struct thread_data *, struct io_u *);
863         void (*cleanup)(struct thread_data *);
864         int (*open_file)(struct thread_data *, struct fio_file *);
865         void (*close_file)(struct thread_data *, struct fio_file *);
866         void *data;
867         void *dlhandle;
868 };
869
870 #define FIO_IOOPS_VERSION       7
871
872 extern struct ioengine_ops *load_ioengine(struct thread_data *, const char *);
873 extern void register_ioengine(struct ioengine_ops *);
874 extern void unregister_ioengine(struct ioengine_ops *);
875 extern void close_ioengine(struct thread_data *);
876
877 /*
878  * Mark unused variables passed to ops functions as unused, to silence gcc
879  */
880 #define fio_unused      __attribute((__unused__))
881 #define fio_init        __attribute__((constructor))
882 #define fio_exit        __attribute__((destructor))
883
884 #define for_each_td(td, i)      \
885         for ((i) = 0, (td) = &threads[0]; (i) < (int) thread_number; (i)++, (td)++)
886 #define for_each_file(td, f, i) \
887         for ((i) = 0, (f) = &(td)->files[0]; (i) < (td)->o.nr_files; (i)++, (f)++)
888
889 #define fio_assert(td, cond)    do {    \
890         if (!(cond)) {                  \
891                 int *__foo = NULL;      \
892                 fprintf(stderr, "file:%s:%d, assert %s failed\n", __FILE__, __LINE__, #cond);   \
893                 (td)->runstate = TD_EXITED;     \
894                 (td)->error = EFAULT;           \
895                 *__foo = 0;                     \
896         }       \
897 } while (0)
898
899 static inline void clear_error(struct thread_data *td)
900 {
901         td->error = 0;
902         td->verror[0] = '\0';
903 }
904
905 #endif