projects / fio.git / blame_incremental
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (non-incremental) | history | HEAD
Replace random constant with the symbolic name (GR prime)
[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 unsigned long short_io_u[2];
337
338 unsigned long long io_bytes[2];
339 unsigned long runtime[2];
340 unsigned long total_run_time;
341};
342
343struct thread_options {
344 int pad;
345 char *description;
346 char *name;
347 char *directory;
348 char *filename;
349 char *opendir;
350 char *ioengine;
351 enum td_ddir td_ddir;
352 unsigned int ddir_nr;
353 unsigned int iodepth;
354 unsigned int iodepth_low;
355 unsigned int iodepth_batch;
356
357 unsigned long long size;
358 unsigned long long file_size_low;
359 unsigned long long file_size_high;
360 unsigned long long start_offset;
361
362 unsigned int bs[2];
363 unsigned int min_bs[2];
364 unsigned int max_bs[2];
365
366 unsigned int nr_files;
367 unsigned int open_files;
368
369 unsigned int odirect;
370 unsigned int invalidate_cache;
371 unsigned int create_serialize;
372 unsigned int create_fsync;
373 unsigned int end_fsync;
374 unsigned int sync_io;
375 unsigned int verify;
376 unsigned int verifysort;
377 unsigned int use_thread;
378 unsigned int unlink;
379 unsigned int do_disk_util;
380 unsigned int override_sync;
381 unsigned int rand_repeatable;
382 unsigned int write_lat_log;
383 unsigned int write_bw_log;
384 unsigned int norandommap;
385 unsigned int bs_unaligned;
386 unsigned int fsync_on_close;
387
388 unsigned int hugepage_size;
389 unsigned int rw_min_bs;
390 unsigned int thinktime;
391 unsigned int thinktime_spin;
392 unsigned int thinktime_blocks;
393 unsigned int fsync_blocks;
394 unsigned int start_delay;
395 unsigned long timeout;
396 unsigned int overwrite;
397 unsigned int bw_avg_time;
398 unsigned int loops;
399 unsigned long long zone_size;
400 unsigned long long zone_skip;
401 enum fio_memtype mem_type;
402
403 unsigned int stonewall;
404 unsigned int new_group;
405 unsigned int numjobs;
406 os_cpu_mask_t cpumask;
407 unsigned int iolog;
408 unsigned int read_iolog;
409 unsigned int rwmixcycle;
410 unsigned int rwmix[2];
411 unsigned int nice;
412 unsigned int file_service_type;
413 unsigned int group_reporting;
414 unsigned int fadvise_hint;
415 unsigned int zero_buffers;
416
417 char *read_iolog_file;
418 char *write_iolog_file;
419
420 /*
421 * Pre-run and post-run shell
422 */
423 char *exec_prerun;
424 char *exec_postrun;
425
426 unsigned int rate;
427 unsigned int ratemin;
428 unsigned int ratecycle;
429 unsigned int rate_iops;
430 unsigned int rate_iops_min;
431
432 char *ioscheduler;
433
434 /*
435 * CPU "io" cycle burner
436 */
437 unsigned int cpuload;
438 unsigned int cpucycle;
439};
440
441#define FIO_VERROR_SIZE 128
442
443/*
444 * This describes a single thread/process executing a fio job.
445 */
446struct thread_data {
447 struct thread_options o;
448 char verror[FIO_VERROR_SIZE];
449 pthread_t thread;
450 int thread_number;
451 int groupid;
452 struct thread_stat ts;
453 struct fio_file *files;
454 unsigned int files_index;
455 unsigned int nr_open_files;
456 unsigned int nr_done_files;
457 unsigned int nr_normal_files;
458 union {
459 unsigned int next_file;
460 os_random_state_t next_file_state;
461 };
462 int error;
463 pid_t pid;
464 char *orig_buffer;
465 size_t orig_buffer_size;
466 volatile int terminate;
467 volatile int runstate;
468 unsigned int ioprio;
469 unsigned int last_was_sync;
470
471 char *mmapfile;
472 int mmapfd;
473
474 void *iolog_buf;
475 FILE *iolog_f;
476
477 char *sysfs_root;
478
479 os_random_state_t bsrange_state;
480 os_random_state_t verify_state;
481
482 int shm_id;
483
484 /*
485 * IO engine hooks, contains everything needed to submit an io_u
486 * to any of the available IO engines.
487 */
488 struct ioengine_ops *io_ops;
489
490 /*
491 * Current IO depth and list of free and busy io_u's.
492 */
493 unsigned int cur_depth;
494 struct list_head io_u_freelist;
495 struct list_head io_u_busylist;
496 struct list_head io_u_requeues;
497 unsigned int io_u_queued;
498
499 /*
500 * Rate state
501 */
502 unsigned long rate_usec_cycle;
503 long rate_pending_usleep;
504 unsigned long rate_bytes;
505 unsigned long rate_blocks;
506 struct timeval lastrate;
507
508 unsigned long long total_io_size;
509
510 unsigned long io_issues[2];
511 unsigned long long io_blocks[2];
512 unsigned long long io_bytes[2];
513 unsigned long long this_io_bytes[2];
514 unsigned long long zone_bytes;
515 struct fio_sem *mutex;
516
517 /*
518 * State for random io, a bitmap of blocks done vs not done
519 */
520 os_random_state_t random_state;
521
522 struct timeval start; /* start of this loop */
523 struct timeval epoch; /* time job was started */
524 struct timeval rw_end[2];
525 unsigned int rw_end_set[2];
526
527 /*
528 * read/write mixed workload state
529 */
530 os_random_state_t rwmix_state;
531 unsigned long long rwmix_bytes;
532 struct timeval rwmix_switch;
533 enum fio_ddir rwmix_ddir;
534 unsigned int ddir_nr;
535
536 /*
537 * IO history logs for verification. We use a tree for sorting,
538 * if we are overwriting. Otherwise just use a fifo.
539 */
540 struct rb_root io_hist_tree;
541 struct list_head io_hist_list;
542
543 /*
544 * For IO replaying
545 */
546 struct list_head io_log_list;
547
548 /*
549 * timeout handling
550 */
551 struct timeval timeout_end;
552 struct itimerval timer;
553
554 /*
555 * for fileservice, how often to switch to a new file
556 */
557 unsigned int file_service_nr;
558 unsigned int file_service_left;
559 struct fio_file *file_service_file;
560
561 /*
562 * For generating file sizes
563 */
564 os_random_state_t file_size_state;
565};
566
567/*
568 * roundrobin available files, or choose one at random.
569 */
570enum {
571 FIO_FSERVICE_RANDOM = 1,
572 FIO_FSERVICE_RR = 2,
573};
574
575/*
576 * 30 second per-io_u timeout, with 5 second intervals to avoid resetting
577 * the timer on each queue operation.
578 */
579#define IO_U_TIMEOUT_INC 5
580#define IO_U_TIMEOUT 30
581
582#define __td_verror(td, err, msg, func) \
583 do { \
584 if ((td)->error) \
585 break; \
586 int e = (err); \
587 (td)->error = e; \
588 snprintf(td->verror, sizeof(td->verror) - 1, "file:%s:%d, func=%s, error=%s", __FILE__, __LINE__, (func), (msg)); \
589 } while (0)
590
591
592#define td_verror(td, err, func) \
593 __td_verror((td), (err), strerror((err)), (func))
594#define td_vmsg(td, err, msg, func) \
595 __td_verror((td), (err), (msg), (func))
596
597extern int exitall_on_terminate;
598extern int thread_number;
599extern int nr_process, nr_thread;
600extern int shm_id;
601extern int groupid;
602extern int terse_output;
603extern FILE *f_out;
604extern FILE *f_err;
605extern int temp_stall_ts;
606extern unsigned long long mlock_size;
607extern unsigned long page_mask, page_size;
608
609extern struct thread_data *threads;
610
611#define td_read(td) ((td)->o.td_ddir & TD_DDIR_READ)
612#define td_write(td) ((td)->o.td_ddir & TD_DDIR_WRITE)
613#define td_rw(td) (((td)->o.td_ddir & TD_DDIR_RW) == TD_DDIR_RW)
614#define td_random(td) ((td)->o.td_ddir & TD_DDIR_RAND)
615
616#define BLOCKS_PER_MAP (8 * sizeof(long))
617#define TO_MAP_BLOCK(td, f, b) ((b) - ((f)->file_offset / (td)->o.rw_min_bs))
618#define RAND_MAP_IDX(td, f, b) (TO_MAP_BLOCK(td, f, b) / BLOCKS_PER_MAP)
619#define RAND_MAP_BIT(td, f, b) (TO_MAP_BLOCK(td, f, b) & (BLOCKS_PER_MAP - 1))
620
621#define MAX_JOBS (1024)
622
623static inline int should_fsync(struct thread_data *td)
624{
625 if (td->last_was_sync)
626 return 0;
627 if (td->o.odirect)
628 return 0;
629 if (td_write(td) || td_rw(td) || td->o.override_sync)
630 return 1;
631
632 return 0;
633}
634
635/*
636 * Disk utils as read in /sys/block/<dev>/stat
637 */
638struct disk_util_stat {
639 unsigned ios[2];
640 unsigned merges[2];
641 unsigned long long sectors[2];
642 unsigned ticks[2];
643 unsigned io_ticks;
644 unsigned time_in_queue;
645};
646
647/*
648 * Per-device disk util management
649 */
650struct disk_util {
651 struct list_head list;
652
653 char *name;
654 char *sysfs_root;
655 char path[256];
656 int major, minor;
657
658 struct disk_util_stat dus;
659 struct disk_util_stat last_dus;
660
661 unsigned long msec;
662 struct timeval time;
663};
664
665#define DISK_UTIL_MSEC (250)
666
667#ifndef min
668#define min(a, b) ((a) < (b) ? (a) : (b))
669#endif
670#ifndef max
671#define max(a, b) ((a) > (b) ? (a) : (b))
672#endif
673
674/*
675 * Log exports
676 */
677extern int __must_check read_iolog_get(struct thread_data *, struct io_u *);
678extern void write_iolog_put(struct thread_data *, struct io_u *);
679extern int __must_check init_iolog(struct thread_data *td);
680extern void log_io_piece(struct thread_data *, struct io_u *);
681extern void prune_io_piece_log(struct thread_data *);
682extern void write_iolog_close(struct thread_data *);
683
684/*
685 * Logging
686 */
687extern void add_clat_sample(struct thread_data *, enum fio_ddir, unsigned long);
688extern void add_slat_sample(struct thread_data *, enum fio_ddir, unsigned long);
689extern void add_bw_sample(struct thread_data *, enum fio_ddir, struct timeval *);
690extern void show_run_stats(void);
691extern void init_disk_util(struct thread_data *);
692extern void update_rusage_stat(struct thread_data *);
693extern void update_io_ticks(void);
694extern void disk_util_timer_arm(void);
695extern void setup_log(struct io_log **);
696extern void finish_log(struct thread_data *, struct io_log *, const char *);
697extern void __finish_log(struct io_log *, const char *);
698extern struct io_log *agg_io_log[2];
699extern int write_bw_log;
700extern void add_agg_sample(unsigned long, enum fio_ddir);
701
702/*
703 * Time functions
704 */
705extern unsigned long utime_since(struct timeval *, struct timeval *);
706extern unsigned long utime_since_now(struct timeval *);
707extern unsigned long mtime_since(struct timeval *, struct timeval *);
708extern unsigned long mtime_since_now(struct timeval *);
709extern unsigned long time_since_now(struct timeval *);
710extern unsigned long mtime_since_genesis(void);
711extern void __usec_sleep(unsigned int);
712extern void usec_sleep(struct thread_data *, unsigned long);
713extern void rate_throttle(struct thread_data *, unsigned long, unsigned int);
714extern void fill_start_time(struct timeval *);
715extern void fio_gettime(struct timeval *, void *);
716extern void set_genesis_time(void);
717
718/*
719 * Init/option functions
720 */
721extern int __must_check parse_options(int, char **);
722extern int fio_option_parse(struct thread_data *, const char *);
723extern int fio_cmd_option_parse(struct thread_data *, const char *, char *);
724extern void fio_fill_default_options(struct thread_data *);
725extern int fio_show_option_help(const char *);
726extern void fio_options_dup_and_init(struct option *);
727extern void options_mem_dupe(struct thread_data *);
728extern void options_mem_free(struct thread_data *);
729#define FIO_GETOPT_JOB 0x89988998
730#define FIO_NR_OPTIONS 128
731
732/*
733 * File setup/shutdown
734 */
735extern void close_files(struct thread_data *);
736extern int __must_check setup_files(struct thread_data *);
737extern int __must_check open_files(struct thread_data *);
738extern int __must_check file_invalidate_cache(struct thread_data *, struct fio_file *);
739extern int __must_check generic_open_file(struct thread_data *, struct fio_file *);
740extern void generic_close_file(struct thread_data *, struct fio_file *);
741extern void add_file(struct thread_data *, const char *);
742extern void get_file(struct fio_file *);
743extern void put_file(struct thread_data *, struct fio_file *);
744extern int add_dir_files(struct thread_data *, const char *);
745extern int init_random_map(struct thread_data *);
746extern void dup_files(struct thread_data *, struct thread_data *);
747
748/*
749 * ETA/status stuff
750 */
751extern void print_thread_status(void);
752extern void print_status_init(int);
753
754/*
755 * disk util stuff
756 */
757#ifdef FIO_HAVE_DISK_UTIL
758extern void show_disk_util(void);
759extern void disk_util_timer_arm(void);
760extern void init_disk_util(struct thread_data *);
761extern void update_io_ticks(void);
762#else
763#define show_disk_util()
764#define disk_util_timer_arm()
765#define init_disk_util(td)
766#define update_io_ticks()
767#endif
768
769/*
770 * Thread life cycle. Once a thread has a runstate beyond TD_INITIALIZED, it
771 * will never back again. It may cycle between running/verififying/fsyncing.
772 * Once the thread reaches TD_EXITED, it is just waiting for the core to
773 * reap it.
774 */
775enum {
776 TD_NOT_CREATED = 0,
777 TD_CREATED,
778 TD_INITIALIZED,
779 TD_RUNNING,
780 TD_VERIFYING,
781 TD_FSYNCING,
782 TD_EXITED,
783 TD_REAPED,
784};
785
786/*
787 * Verify helpers
788 */
789extern void populate_verify_io_u(struct thread_data *, struct io_u *);
790extern int __must_check get_next_verify(struct thread_data *td, struct io_u *);
791extern int __must_check verify_io_u(struct thread_data *, struct io_u *);
792
793/*
794 * Memory helpers
795 */
796extern int __must_check fio_pin_memory(void);
797extern void fio_unpin_memory(void);
798extern int __must_check allocate_io_mem(struct thread_data *);
799extern void free_io_mem(struct thread_data *);
800
801/*
802 * io unit handling
803 */
804#define queue_full(td) list_empty(&(td)->io_u_freelist)
805extern struct io_u *__get_io_u(struct thread_data *);
806extern struct io_u *get_io_u(struct thread_data *);
807extern void put_io_u(struct thread_data *, struct io_u *);
808extern void requeue_io_u(struct thread_data *, struct io_u **);
809extern long __must_check io_u_sync_complete(struct thread_data *, struct io_u *);
810extern long __must_check io_u_queued_complete(struct thread_data *, int);
811extern void io_u_queued(struct thread_data *, struct io_u *);
812extern void io_u_log_error(struct thread_data *, struct io_u *);
813extern void io_u_init_timeout(void);
814extern void io_u_set_timeout(struct thread_data *);
815extern void io_u_mark_depth(struct thread_data *, struct io_u *);
816
817/*
818 * io engine entry points
819 */
820extern int __must_check td_io_init(struct thread_data *);
821extern int __must_check td_io_prep(struct thread_data *, struct io_u *);
822extern int __must_check td_io_queue(struct thread_data *, struct io_u *);
823extern int __must_check td_io_sync(struct thread_data *, struct fio_file *);
824extern int __must_check td_io_getevents(struct thread_data *, int, int, struct timespec *);
825extern int __must_check td_io_commit(struct thread_data *);
826extern int __must_check td_io_open_file(struct thread_data *, struct fio_file *);
827extern void td_io_close_file(struct thread_data *, struct fio_file *);
828
829/*
830 * If logging output to a file, stderr should go to both stderr and f_err
831 */
832#define log_err(args...) do { \
833 fprintf(f_err, ##args); \
834 if (f_err != stderr) \
835 fprintf(stderr, ##args); \
836 } while (0)
837
838#define log_info(args...) fprintf(f_out, ##args)
839
840FILE *get_f_out(void);
841FILE *get_f_err(void);
842
843struct ioengine_ops {
844 struct list_head list;
845 char name[16];
846 int version;
847 int flags;
848 int (*setup)(struct thread_data *);
849 int (*init)(struct thread_data *);
850 int (*prep)(struct thread_data *, struct io_u *);
851 int (*queue)(struct thread_data *, struct io_u *);
852 int (*commit)(struct thread_data *);
853 int (*getevents)(struct thread_data *, int, int, struct timespec *);
854 struct io_u *(*event)(struct thread_data *, int);
855 int (*cancel)(struct thread_data *, struct io_u *);
856 void (*cleanup)(struct thread_data *);
857 int (*open_file)(struct thread_data *, struct fio_file *);
858 void (*close_file)(struct thread_data *, struct fio_file *);
859 void *data;
860 void *dlhandle;
861};
862
863#define FIO_IOOPS_VERSION 7
864
865extern struct ioengine_ops *load_ioengine(struct thread_data *, const char *);
866extern void register_ioengine(struct ioengine_ops *);
867extern void unregister_ioengine(struct ioengine_ops *);
868extern void close_ioengine(struct thread_data *);
869
870/*
871 * Mark unused variables passed to ops functions as unused, to silence gcc
872 */
873#define fio_unused __attribute((__unused__))
874#define fio_init __attribute__((constructor))
875#define fio_exit __attribute__((destructor))
876
877#define for_each_td(td, i) \
878 for ((i) = 0, (td) = &threads[0]; (i) < (int) thread_number; (i)++, (td)++)
879#define for_each_file(td, f, i) \
880 for ((i) = 0, (f) = &(td)->files[0]; (i) < (td)->o.nr_files; (i)++, (f)++)
881
882#define fio_assert(td, cond) do { \
883 if (!(cond)) { \
884 int *__foo = NULL; \
885 fprintf(stderr, "file:%s:%d, assert %s failed\n", __FILE__, __LINE__, #cond); \
886 (td)->runstate = TD_EXITED; \
887 (td)->error = EFAULT; \
888 *__foo = 0; \
889 } \
890} while (0)
891
892static inline void clear_error(struct thread_data *td)
893{
894 td->error = 0;
895 td->verror[0] = '\0';
896}
897
898#endif
fio - Flexible IO Tester