#include <assert.h>
#include "../fio.h"
-#include "../os.h"
/*
* The core of the module is identical to the ones included with fio,
* which may then be retrieved by calling the ->event() hook with the event
* numbers. Required.
*/
-static int fio_skeleton_getevents(struct thread_data *td, int min, int max,
- struct timespec *t)
+static int fio_skeleton_getevents(struct thread_data *td, unsigned int min,
+ unsigned int max, struct timespec *t)
{
return 0;
}
* The ->queue() hook is responsible for initiating io on the io_u
* being passed in. If the io engine is a synchronous one, io may complete
* before ->queue() returns. Required.
+ *
+ * The io engine must transfer in the direction noted by io_u->ddir
+ * to the buffer pointed to by io_u->xfer_buf for as many bytes as
+ * io_u->xfer_buflen. Residual data count may be set in io_u->residual
+ * for a short read/write.
*/
static int fio_skeleton_queue(struct thread_data *td, struct io_u *io_u)
{
- return 0;
+ /*
+ * Double sanity check to catch errant write on a readonly setup
+ */
+ fio_ro_check(td, io_u);
+
+ /*
+ * Could return FIO_Q_QUEUED for a queued request,
+ * FIO_Q_COMPLETED for a completed request, and FIO_Q_BUSY
+ * if we could queue no more at this point (you'd have to
+ * define ->commit() to handle that.
+ */
+ return FIO_Q_COMPLETED;
}
/*
* The ->prep() function is called for each io_u prior to being submitted
* with ->queue(). This hook allows the io engine to perform any
- * preperatory actions on the io_u, before being submitted. Not required.
+ * preparatory actions on the io_u, before being submitted. Not required.
*/
static int fio_skeleton_prep(struct thread_data *td, struct io_u *io_u)
{
{
}
+/*
+ * Hook for opening the given file. Unless the engine has special
+ * needs, it usually just provides generic_file_open() as the handler.
+ */
+static int fio_skeleton_open(struct thread_data *td, struct fio_file *f)
+{
+ return generic_file_open(td, f);
+}
+
+/*
+ * Hook for closing a file. See fio_skeleton_open().
+ */
+static int fio_skeleton_close(struct thread_data *td, struct fio_file *f)
+{
+ generic_file_close(td, f);
+}
+
/*
* Note that the structure is exported, so that fio can get it via
* dlsym(..., "ioengine");
.getevents = fio_skeleton_getevents,
.event = fio_skeleton_event,
.cleanup = fio_skeleton_cleanup,
+ .open_file = fio_skeleton_open,
+ .close_file = fio_skeleton_close,
};