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