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