projects / fio.git / blame
| Commit | Line | Data |
|---|---|---|
| dcefb588 JA |
1 | #ifndef FIO_IOENGINE_H |
| 2 | #define FIO_IOENGINE_H | |
| 3 | ||
| 3d2d14bc SW |
4 | #include <stddef.h> |
| 5 | ||
| 41666588 | 6 | #include "compiler/compiler.h" |
| 3d2d14bc | 7 | #include "flist.h" |
| 8ef89e0b | 8 | #include "io_u.h" |
| 6c5b11d3 | 9 | #include "zbd_types.h" |
| 67bf9823 | 10 | |
| 6c5b11d3 | 11 | #define FIO_IOOPS_VERSION 26 |
| dcefb588 | 12 | |
| dcefb588 JA |
13 | /* |
| 14 | * io_ops->queue() return values | |
| 15 | */ | |
| d3b07186 | 16 | enum fio_q_status { |
| dcefb588 JA |
17 | FIO_Q_COMPLETED = 0, /* completed sync */ |
| 18 | FIO_Q_QUEUED = 1, /* queued, will complete async */ | |
| 19 | FIO_Q_BUSY = 2, /* no more room, call ->commit() */ | |
| 20 | }; | |
| 21 | ||
| 22 | struct ioengine_ops { | |
| 23 | struct flist_head list; | |
| 43072e8e | 24 | const char *name; |
| dcefb588 JA |
25 | int version; |
| 26 | int flags; | |
| 27 | int (*setup)(struct thread_data *); | |
| 28 | int (*init)(struct thread_data *); | |
| 2041bd34 | 29 | int (*post_init)(struct thread_data *); |
| dcefb588 | 30 | int (*prep)(struct thread_data *, struct io_u *); |
| d3b07186 | 31 | enum fio_q_status (*queue)(struct thread_data *, struct io_u *); |
| dcefb588 | 32 | int (*commit)(struct thread_data *); |
| 1f440ece | 33 | int (*getevents)(struct thread_data *, unsigned int, unsigned int, const struct timespec *); |
| dcefb588 | 34 | struct io_u *(*event)(struct thread_data *, int); |
| 5ad7be56 | 35 | char *(*errdetails)(struct io_u *); |
| dcefb588 JA |
36 | int (*cancel)(struct thread_data *, struct io_u *); |
| 37 | void (*cleanup)(struct thread_data *); | |
| 38 | int (*open_file)(struct thread_data *, struct fio_file *); | |
| 39 | int (*close_file)(struct thread_data *, struct fio_file *); | |
| d9b100fc | 40 | int (*invalidate)(struct thread_data *, struct fio_file *); |
| 38ef9c90 | 41 | int (*unlink_file)(struct thread_data *, struct fio_file *); |
| dcefb588 | 42 | int (*get_file_size)(struct thread_data *, struct fio_file *); |
| 36d80bc7 | 43 | void (*terminate)(struct thread_data *); |
| a6cb85e2 JA |
44 | int (*iomem_alloc)(struct thread_data *, size_t); |
| 45 | void (*iomem_free)(struct thread_data *); | |
| c73ed246 JA |
46 | int (*io_u_init)(struct thread_data *, struct io_u *); |
| 47 | void (*io_u_free)(struct thread_data *, struct io_u *); | |
| 6c5b11d3 DLM |
48 | int (*get_zoned_model)(struct thread_data *td, |
| 49 | struct fio_file *f, enum zbd_zoned_model *); | |
| 50 | int (*report_zones)(struct thread_data *, struct fio_file *, | |
| 51 | uint64_t, struct zbd_zone *, unsigned int); | |
| 52 | int (*reset_wp)(struct thread_data *, struct fio_file *, | |
| 53 | uint64_t, uint64_t); | |
| de890a1e SL |
54 | int option_struct_size; |
| 55 | struct fio_option *options; | |
| dcefb588 JA |
56 | }; |
| 57 | ||
| 2b4f4abe JA |
58 | enum fio_ioengine_flags { |
| 59 | FIO_SYNCIO = 1 << 0, /* io engine has synchronous ->queue */ | |
| 60 | FIO_RAWIO = 1 << 1, /* some sort of direct/raw io */ | |
| 61 | FIO_DISKLESSIO = 1 << 2, /* no disk involved */ | |
| 62 | FIO_NOEXTEND = 1 << 3, /* engine can't extend file */ | |
| 93bcfd20 | 63 | FIO_NODISKUTIL = 1 << 4, /* diskutil can't handle filename */ |
| 2b4f4abe JA |
64 | FIO_UNIDIR = 1 << 5, /* engine is uni-directional */ |
| 65 | FIO_NOIO = 1 << 6, /* thread does only pseudo IO */ | |
| 36d80bc7 JA |
66 | FIO_PIPEIO = 1 << 7, /* input/output no seekable */ |
| 67 | FIO_BARRIER = 1 << 8, /* engine supports barriers */ | |
| 68 | FIO_MEMALIGN = 1 << 9, /* engine wants aligned memory */ | |
| ad705bcb | 69 | FIO_BIT_BASED = 1 << 10, /* engine uses a bit base (e.g. uses Kbit as opposed to KB) */ |
| 5c57c084 | 70 | FIO_FAKEIO = 1 << 11, /* engine pretends to do IO */ |
| 132b1ee4 | 71 | FIO_NOSTATS = 1 << 12, /* don't do IO stats */ |
| cb9bf647 | 72 | FIO_NOFILEHASH = 1 << 13, /* doesn't hash the files for lookup later. */ |
| 04ba61df VF |
73 | FIO_ASYNCIO_SYNC_TRIM |
| 74 | = 1 << 14 /* io engine has async ->queue except for trim */ | |
| 2b4f4abe | 75 | }; |
| dcefb588 | 76 | |
| a8075704 DG |
77 | /* |
| 78 | * External engine defined symbol to fill in the engine ops structure | |
| 79 | */ | |
| 80 | typedef void (*get_ioengine_t)(struct ioengine_ops **); | |
| 81 | ||
| dcefb588 JA |
82 | /* |
| 83 | * io engine entry points | |
| 84 | */ | |
| 85 | extern int __must_check td_io_init(struct thread_data *); | |
| 86 | extern int __must_check td_io_prep(struct thread_data *, struct io_u *); | |
| d3b07186 | 87 | extern enum fio_q_status __must_check td_io_queue(struct thread_data *, struct io_u *); |
| 1f440ece | 88 | extern int __must_check td_io_getevents(struct thread_data *, unsigned int, unsigned int, const struct timespec *); |
| a80cb54b | 89 | extern void td_io_commit(struct thread_data *); |
| dcefb588 JA |
90 | extern int __must_check td_io_open_file(struct thread_data *, struct fio_file *); |
| 91 | extern int td_io_close_file(struct thread_data *, struct fio_file *); | |
| 38ef9c90 | 92 | extern int td_io_unlink_file(struct thread_data *, struct fio_file *); |
| dcefb588 JA |
93 | extern int __must_check td_io_get_file_size(struct thread_data *, struct fio_file *); |
| 94 | ||
| 4fedf59a | 95 | extern struct ioengine_ops *load_ioengine(struct thread_data *); |
| dcefb588 JA |
96 | extern void register_ioengine(struct ioengine_ops *); |
| 97 | extern void unregister_ioengine(struct ioengine_ops *); | |
| de890a1e | 98 | extern void free_ioengine(struct thread_data *); |
| dcefb588 JA |
99 | extern void close_ioengine(struct thread_data *); |
| 100 | ||
| de890a1e SL |
101 | extern int fio_show_ioengine_help(const char *engine); |
| 102 | ||
| dcefb588 | 103 | #endif |