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