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