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