Refactor #includes and headers
[fio.git] / engines / null.c
CommitLineData
a94ea28b 1/*
da751ca9
JA
2 * null engine
3 *
4 * IO engine that doesn't do any real IO transfers, it just pretends to.
5 * The main purpose is to test fio itself.
a94ea28b 6 *
46a67478
DG
7 * It also can act as external C++ engine - compiled with:
8 *
966fcbd4 9 * g++ -O2 -g -shared -rdynamic -fPIC -o cpp_null null.c -DFIO_EXTERNAL_ENGINE
10 *
11 * to test it execute:
12 *
13 * LD_LIBRARY_PATH=./engines ./fio examples/cpp_null.fio
46a67478 14 *
a94ea28b 15 */
a94ea28b 16#include <stdlib.h>
a94ea28b
JA
17#include <assert.h>
18
19#include "../fio.h"
a94ea28b 20
65afa5f2
JA
21struct null_data {
22 struct io_u **io_us;
23 int queued;
24 int events;
25};
26
966fcbd4 27static struct io_u *null_event(struct null_data *nd, int event)
65afa5f2 28{
65afa5f2
JA
29 return nd->io_us[event];
30}
31
966fcbd4 32static int null_getevents(struct null_data *nd, unsigned int min_events,
33 unsigned int fio_unused max,
34 const struct timespec fio_unused *t)
65afa5f2 35{
7401c088 36 int ret = 0;
966fcbd4 37
7401c088
JA
38 if (min_events) {
39 ret = nd->events;
40 nd->events = 0;
41 }
65afa5f2 42
65afa5f2
JA
43 return ret;
44}
45
966fcbd4 46static int null_commit(struct thread_data *td, struct null_data *nd)
65afa5f2 47{
ed8bd849 48 if (!nd->events) {
46a67478 49#ifndef FIO_EXTERNAL_ENGINE
838bc709 50 io_u_mark_submit(td, nd->queued);
46a67478 51#endif
ed8bd849
JA
52 nd->events = nd->queued;
53 nd->queued = 0;
54 }
55
65afa5f2
JA
56 return 0;
57}
58
966fcbd4 59static int null_queue(struct thread_data *td, struct null_data *nd,
60 struct io_u *io_u)
a94ea28b 61{
7101d9c2
JA
62 fio_ro_check(td, io_u);
63
65afa5f2
JA
64 if (td->io_ops->flags & FIO_SYNCIO)
65 return FIO_Q_COMPLETED;
ed8bd849
JA
66 if (nd->events)
67 return FIO_Q_BUSY;
65afa5f2
JA
68
69 nd->io_us[nd->queued++] = io_u;
70 return FIO_Q_QUEUED;
a94ea28b
JA
71}
72
966fcbd4 73static int null_open(struct null_data fio_unused *nd,
74 struct fio_file fio_unused *f)
b5af8293
JA
75{
76 return 0;
77}
78
966fcbd4 79static void null_cleanup(struct null_data *nd)
65afa5f2 80{
65afa5f2 81 if (nd) {
02a3d83f 82 free(nd->io_us);
65afa5f2 83 free(nd);
65afa5f2
JA
84 }
85}
86
7746976c 87static struct null_data *null_init(struct thread_data *td)
65afa5f2 88{
7746976c 89 struct null_data *nd = (struct null_data *) malloc(sizeof(*nd));
65afa5f2
JA
90
91 memset(nd, 0, sizeof(*nd));
92
2dc1bbeb 93 if (td->o.iodepth != 1) {
46a67478 94 nd->io_us = (struct io_u **) malloc(td->o.iodepth * sizeof(struct io_u *));
2dc1bbeb 95 memset(nd->io_us, 0, td->o.iodepth * sizeof(struct io_u *));
65afa5f2
JA
96 } else
97 td->io_ops->flags |= FIO_SYNCIO;
98
7746976c 99 return nd;
65afa5f2
JA
100}
101
46a67478 102#ifndef __cplusplus
966fcbd4 103
104static struct io_u *fio_null_event(struct thread_data *td, int event)
105{
ca65714c 106 return null_event(td->io_ops_data, event);
966fcbd4 107}
108
109static int fio_null_getevents(struct thread_data *td, unsigned int min_events,
110 unsigned int max, const struct timespec *t)
111{
ca65714c 112 struct null_data *nd = td->io_ops_data;
966fcbd4 113 return null_getevents(nd, min_events, max, t);
114}
115
116static int fio_null_commit(struct thread_data *td)
117{
ca65714c 118 return null_commit(td, td->io_ops_data);
966fcbd4 119}
120
121static int fio_null_queue(struct thread_data *td, struct io_u *io_u)
122{
ca65714c 123 return null_queue(td, td->io_ops_data, io_u);
966fcbd4 124}
125
126static int fio_null_open(struct thread_data *td, struct fio_file *f)
127{
ca65714c 128 return null_open(td->io_ops_data, f);
966fcbd4 129}
130
131static void fio_null_cleanup(struct thread_data *td)
132{
ca65714c 133 null_cleanup(td->io_ops_data);
966fcbd4 134}
135
136static int fio_null_init(struct thread_data *td)
137{
7746976c
TK
138 td->io_ops_data = null_init(td);
139 assert(td->io_ops_data);
140 return 0;
966fcbd4 141}
142
a94ea28b
JA
143static struct ioengine_ops ioengine = {
144 .name = "null",
145 .version = FIO_IOOPS_VERSION,
a94ea28b 146 .queue = fio_null_queue,
65afa5f2
JA
147 .commit = fio_null_commit,
148 .getevents = fio_null_getevents,
149 .event = fio_null_event,
150 .init = fio_null_init,
151 .cleanup = fio_null_cleanup,
b5af8293 152 .open_file = fio_null_open,
5c57c084 153 .flags = FIO_DISKLESSIO | FIO_FAKEIO,
a94ea28b
JA
154};
155
156static void fio_init fio_null_register(void)
157{
158 register_ioengine(&ioengine);
159}
160
161static void fio_exit fio_null_unregister(void)
162{
163 unregister_ioengine(&ioengine);
164}
46a67478
DG
165
166#else
167
168#ifdef FIO_EXTERNAL_ENGINE
966fcbd4 169
170struct NullData {
171 NullData(struct thread_data *td)
172 {
7746976c
TK
173 impl_ = null_init(td);
174 assert(impl_);
966fcbd4 175 }
176
177 ~NullData()
178 {
179 null_cleanup(impl_);
180 }
181
182 static NullData *get(struct thread_data *td)
183 {
184 return reinterpret_cast<NullData *>(td->io_ops_data);
185 }
186
187 io_u *fio_null_event(struct thread_data *, int event)
188 {
189 return null_event(impl_, event);
190 }
191
192 int fio_null_getevents(struct thread_data *, unsigned int min_events,
193 unsigned int max, const struct timespec *t)
194 {
195 return null_getevents(impl_, min_events, max, t);
196 }
197
198 int fio_null_commit(struct thread_data *td)
199 {
200 return null_commit(td, impl_);
201 }
202
203 int fio_null_queue(struct thread_data *td, struct io_u *io_u)
204 {
205 return null_queue(td, impl_, io_u);
206 }
207
208 int fio_null_open(struct thread_data *, struct fio_file *f)
209 {
210 return null_open(impl_, f);
211 }
212
7caf10f1 213private:
966fcbd4 214 struct null_data *impl_;
215};
216
46a67478 217extern "C" {
966fcbd4 218
219static struct io_u *fio_null_event(struct thread_data *td, int event)
220{
221 return NullData::get(td)->fio_null_event(td, event);
222}
223
224static int fio_null_getevents(struct thread_data *td, unsigned int min_events,
225 unsigned int max, const struct timespec *t)
226{
227 return NullData::get(td)->fio_null_getevents(td, min_events, max, t);
228}
229
230static int fio_null_commit(struct thread_data *td)
231{
232 return NullData::get(td)->fio_null_commit(td);
233}
234
235static int fio_null_queue(struct thread_data *td, struct io_u *io_u)
236{
237 return NullData::get(td)->fio_null_queue(td, io_u);
238}
239
240static int fio_null_open(struct thread_data *td, struct fio_file *f)
241{
242 return NullData::get(td)->fio_null_open(td, f);
243}
244
245static int fio_null_init(struct thread_data *td)
246{
247 td->io_ops_data = new NullData(td);
248 return 0;
249}
250
251static void fio_null_cleanup(struct thread_data *td)
252{
253 delete NullData::get(td);
254}
255
247f299a 256static struct ioengine_ops ioengine;
8d6ecac2
JA
257void get_ioengine(struct ioengine_ops **ioengine_ptr)
258{
247f299a
TK
259 *ioengine_ptr = &ioengine;
260
261 ioengine.name = "cpp_null";
262 ioengine.version = FIO_IOOPS_VERSION;
263 ioengine.queue = fio_null_queue;
264 ioengine.commit = fio_null_commit;
265 ioengine.getevents = fio_null_getevents;
266 ioengine.event = fio_null_event;
267 ioengine.init = fio_null_init;
268 ioengine.cleanup = fio_null_cleanup;
269 ioengine.open_file = fio_null_open;
270 ioengine.flags = FIO_DISKLESSIO | FIO_FAKEIO;
46a67478
DG
271}
272}
273#endif /* FIO_EXTERNAL_ENGINE */
274
275#endif /* __cplusplus */