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