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