*
* Should be compiled with:
*
- * gcc -Wall -O2 -g -shared -rdynamic -fPIC -o engine.o engine.c
+ * gcc -Wall -O2 -g -shared -rdynamic -fPIC -o skeleton_external.o skeleton_external.c
+ * (also requires -D_GNU_SOURCE -DCONFIG_STRSEP on Linux)
*
*/
#include <stdio.h>
#include <assert.h>
#include "../fio.h"
+#include "../optgroup.h"
/*
* The core of the module is identical to the ones included with fio,
* for external modules, they should be gotten through dlsym()
*/
+/*
+ * The io engine can define its own options within the io engine source.
+ * The option member must not be at offset 0, due to the way fio parses
+ * the given option. Just add a padding pointer unless the io engine has
+ * something usable.
+ */
+struct fio_skeleton_options {
+ void *pad; /* avoid ->off1 of fio_option becomes 0 */
+ unsigned int dummy;
+};
+
+static struct fio_option options[] = {
+ {
+ .name = "dummy",
+ .lname = "ldummy",
+ .type = FIO_OPT_STR_SET,
+ .off1 = offsetof(struct fio_skeleton_options, dummy),
+ .help = "Set dummy",
+ .category = FIO_OPT_C_ENGINE, /* always use this */
+ .group = FIO_OPT_G_INVALID, /* this can be different */
+ },
+ {
+ .name = NULL,
+ },
+};
+
/*
* The ->event() hook is called to match an event number with an io_u.
* After the core has called ->getevents() and it has returned eg 3,
* 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, const struct timespec *t)
{
return 0;
}
*
* 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
+ * io_u->xfer_buflen. Residual data count may be set in io_u->resid
* for a short read/write.
*/
-static int fio_skeleton_queue(struct thread_data *td, struct io_u *io_u)
+static enum fio_q_status fio_skeleton_queue(struct thread_data *td,
+ struct io_u *io_u)
{
/*
* Double sanity check to catch errant write on a readonly setup
}
/*
- * This is paired with the ->init() funtion and is called when a thread is
+ * This is paired with the ->init() function and is called when a thread is
* done doing io. Should tear down anything setup by the ->init() function.
* Not required.
*/
/*
* Hook for opening the given file. Unless the engine has special
- * needs, it usually just provides generic_file_open() as the handler.
+ * needs, it usually just provides generic_open_file() as the handler.
*/
static int fio_skeleton_open(struct thread_data *td, struct fio_file *f)
{
- return generic_file_open(td, f);
+ return generic_open_file(td, f);
}
/*
*/
static int fio_skeleton_close(struct thread_data *td, struct fio_file *f)
{
- generic_file_close(td, f);
+ return generic_close_file(td, f);
}
/*
* Note that the structure is exported, so that fio can get it via
- * dlsym(..., "ioengine");
+ * dlsym(..., "ioengine"); for (and only for) external engines.
*/
struct ioengine_ops ioengine = {
.name = "engine_name",
.cleanup = fio_skeleton_cleanup,
.open_file = fio_skeleton_open,
.close_file = fio_skeleton_close,
+ .options = options,
+ .option_struct_size = sizeof(struct fio_skeleton_options),
};