4 * IO engine using Ceph's librbd to test RADOS Block Devices.
8 #include <rbd/librbd.h>
14 rbd_completion_t completion;
23 struct io_u **aio_events;
27 struct thread_data *td;
34 static struct fio_option options[] = {
37 .lname = "rbd engine rbdname",
38 .type = FIO_OPT_STR_STORE,
39 .help = "RBD name for RBD engine",
40 .off1 = offsetof(struct rbd_options, rbd_name),
41 .category = FIO_OPT_C_ENGINE,
42 .group = FIO_OPT_G_RBD,
46 .lname = "rbd engine pool",
47 .type = FIO_OPT_STR_STORE,
48 .help = "Name of the pool hosting the RBD for the RBD engine",
49 .off1 = offsetof(struct rbd_options, pool_name),
50 .category = FIO_OPT_C_ENGINE,
51 .group = FIO_OPT_G_RBD,
55 .lname = "rbd engine clientname",
56 .type = FIO_OPT_STR_STORE,
57 .help = "Name of the ceph client to access the RBD for the RBD engine",
58 .off1 = offsetof(struct rbd_options, client_name),
59 .category = FIO_OPT_C_ENGINE,
60 .group = FIO_OPT_G_RBD,
66 .help = "Busy poll for completions instead of sleeping",
67 .off1 = offsetof(struct rbd_options, busy_poll),
69 .category = FIO_OPT_C_ENGINE,
70 .group = FIO_OPT_G_RBD,
77 static int _fio_setup_rbd_data(struct thread_data *td,
78 struct rbd_data **rbd_data_ptr)
80 struct rbd_data *rbd_data;
85 rbd_data = malloc(sizeof(struct rbd_data));
89 memset(rbd_data, 0, sizeof(struct rbd_data));
91 rbd_data->aio_events = malloc(td->o.iodepth * sizeof(struct io_u *));
92 if (!rbd_data->aio_events)
95 memset(rbd_data->aio_events, 0, td->o.iodepth * sizeof(struct io_u *));
97 *rbd_data_ptr = rbd_data;
108 static int _fio_rbd_connect(struct thread_data *td)
110 struct rbd_data *rbd_data = td->io_ops->data;
111 struct rbd_options *o = td->eo;
114 r = rados_create(&rbd_data->cluster, o->client_name);
116 log_err("rados_create failed.\n");
120 r = rados_conf_read_file(rbd_data->cluster, NULL);
122 log_err("rados_conf_read_file failed.\n");
126 r = rados_connect(rbd_data->cluster);
128 log_err("rados_connect failed.\n");
129 goto failed_shutdown;
132 r = rados_ioctx_create(rbd_data->cluster, o->pool_name,
135 log_err("rados_ioctx_create failed.\n");
136 goto failed_shutdown;
139 r = rbd_open(rbd_data->io_ctx, o->rbd_name, &rbd_data->image,
142 log_err("rbd_open failed.\n");
148 rados_ioctx_destroy(rbd_data->io_ctx);
149 rbd_data->io_ctx = NULL;
151 rados_shutdown(rbd_data->cluster);
152 rbd_data->cluster = NULL;
157 static void _fio_rbd_disconnect(struct rbd_data *rbd_data)
162 /* shutdown everything */
163 if (rbd_data->image) {
164 rbd_close(rbd_data->image);
165 rbd_data->image = NULL;
168 if (rbd_data->io_ctx) {
169 rados_ioctx_destroy(rbd_data->io_ctx);
170 rbd_data->io_ctx = NULL;
173 if (rbd_data->cluster) {
174 rados_shutdown(rbd_data->cluster);
175 rbd_data->cluster = NULL;
179 static void _fio_rbd_finish_aiocb(rbd_completion_t comp, void *data)
181 struct fio_rbd_iou *fri = data;
182 struct io_u *io_u = fri->io_u;
186 * Looks like return value is 0 for success, or < 0 for
187 * a specific error. So we have to assume that it can't do
188 * partial completions.
190 fri->io_complete = 1;
192 ret = rbd_aio_get_return_value(fri->completion);
195 io_u->resid = io_u->xfer_buflen;
200 static struct io_u *fio_rbd_event(struct thread_data *td, int event)
202 struct rbd_data *rbd_data = td->io_ops->data;
204 return rbd_data->aio_events[event];
207 static inline int fri_check_complete(struct rbd_data *rbd_data,
209 unsigned int *events)
211 struct fio_rbd_iou *fri = io_u->engine_data;
213 if (fri->io_complete) {
215 rbd_data->aio_events[*events] = io_u;
218 rbd_aio_release(fri->completion);
225 static int rbd_iter_events(struct thread_data *td, unsigned int *events,
226 unsigned int min_evts, int wait)
228 struct rbd_data *rbd_data = td->io_ops->data;
229 unsigned int this_events = 0;
233 io_u_qiter(&td->io_u_all, io_u, i) {
234 struct fio_rbd_iou *fri = io_u->engine_data;
236 if (!(io_u->flags & IO_U_F_FLIGHT))
241 if (fri_check_complete(rbd_data, io_u, events))
244 rbd_aio_wait_for_complete(fri->completion);
246 if (fri_check_complete(rbd_data, io_u, events))
249 if (*events >= min_evts)
256 static int fio_rbd_getevents(struct thread_data *td, unsigned int min,
257 unsigned int max, const struct timespec *t)
259 unsigned int this_events, events = 0;
260 struct rbd_options *o = td->eo;
264 this_events = rbd_iter_events(td, &events, min, wait);
280 static int fio_rbd_queue(struct thread_data *td, struct io_u *io_u)
282 struct rbd_data *rbd_data = td->io_ops->data;
283 struct fio_rbd_iou *fri = io_u->engine_data;
286 fio_ro_check(td, io_u);
289 fri->io_complete = 0;
291 r = rbd_aio_create_completion(fri, _fio_rbd_finish_aiocb,
294 log_err("rbd_aio_create_completion failed.\n");
298 if (io_u->ddir == DDIR_WRITE) {
299 r = rbd_aio_write(rbd_data->image, io_u->offset,
300 io_u->xfer_buflen, io_u->xfer_buf,
303 log_err("rbd_aio_write failed.\n");
307 } else if (io_u->ddir == DDIR_READ) {
308 r = rbd_aio_read(rbd_data->image, io_u->offset,
309 io_u->xfer_buflen, io_u->xfer_buf,
313 log_err("rbd_aio_read failed.\n");
316 } else if (io_u->ddir == DDIR_TRIM) {
317 r = rbd_aio_discard(rbd_data->image, io_u->offset,
318 io_u->xfer_buflen, fri->completion);
320 log_err("rbd_aio_discard failed.\n");
323 } else if (io_u->ddir == DDIR_SYNC) {
324 r = rbd_aio_flush(rbd_data->image, fri->completion);
326 log_err("rbd_flush failed.\n");
330 dprint(FD_IO, "%s: Warning: unhandled ddir: %d\n", __func__,
337 rbd_aio_release(fri->completion);
340 td_verror(td, io_u->error, "xfer");
341 return FIO_Q_COMPLETED;
344 static int fio_rbd_init(struct thread_data *td)
348 r = _fio_rbd_connect(td);
350 log_err("fio_rbd_connect failed, return code: %d .\n", r);
360 static void fio_rbd_cleanup(struct thread_data *td)
362 struct rbd_data *rbd_data = td->io_ops->data;
365 _fio_rbd_disconnect(rbd_data);
366 free(rbd_data->aio_events);
372 static int fio_rbd_setup(struct thread_data *td)
375 rbd_image_info_t info;
377 struct rbd_data *rbd_data = NULL;
378 int major, minor, extra;
380 /* log version of librbd. No cluster connection required. */
381 rbd_version(&major, &minor, &extra);
382 log_info("rbd engine: RBD version: %d.%d.%d\n", major, minor, extra);
384 /* allocate engine specific structure to deal with librbd. */
385 r = _fio_setup_rbd_data(td, &rbd_data);
387 log_err("fio_setup_rbd_data failed.\n");
390 td->io_ops->data = rbd_data;
392 /* librbd does not allow us to run first in the main thread and later
393 * in a fork child. It needs to be the same process context all the
396 td->o.use_thread = 1;
398 /* connect in the main thread to determine to determine
399 * the size of the given RADOS block device. And disconnect
402 r = _fio_rbd_connect(td);
404 log_err("fio_rbd_connect failed.\n");
408 /* get size of the RADOS block device */
409 r = rbd_stat(rbd_data->image, &info, sizeof(info));
411 log_err("rbd_status failed.\n");
414 dprint(FD_IO, "rbd-engine: image size: %lu\n", info.size);
416 /* taken from "net" engine. Pretend we deal with files,
417 * even if we do not have any ideas about files.
418 * The size of the RBD is set instead of a artificial file.
420 if (!td->files_index) {
421 add_file(td, td->o.filename ? : "rbd", 0, 0);
422 td->o.nr_files = td->o.nr_files ? : 1;
426 f->real_file_size = info.size;
428 /* disconnect, then we were only connected to determine
429 * the size of the RBD.
431 _fio_rbd_disconnect(rbd_data);
435 _fio_rbd_disconnect(rbd_data);
441 static int fio_rbd_open(struct thread_data *td, struct fio_file *f)
446 static int fio_rbd_invalidate(struct thread_data *td, struct fio_file *f)
448 #if defined(CONFIG_RBD_INVAL)
449 struct rbd_data *rbd_data = td->io_ops->data;
451 return rbd_invalidate_cache(rbd_data->image);
457 static void fio_rbd_io_u_free(struct thread_data *td, struct io_u *io_u)
459 struct fio_rbd_iou *fri = io_u->engine_data;
462 io_u->engine_data = NULL;
467 static int fio_rbd_io_u_init(struct thread_data *td, struct io_u *io_u)
469 struct fio_rbd_iou *fri;
471 fri = calloc(1, sizeof(*fri));
473 io_u->engine_data = fri;
477 static struct ioengine_ops ioengine = {
479 .version = FIO_IOOPS_VERSION,
480 .setup = fio_rbd_setup,
481 .init = fio_rbd_init,
482 .queue = fio_rbd_queue,
483 .getevents = fio_rbd_getevents,
484 .event = fio_rbd_event,
485 .cleanup = fio_rbd_cleanup,
486 .open_file = fio_rbd_open,
487 .invalidate = fio_rbd_invalidate,
489 .io_u_init = fio_rbd_io_u_init,
490 .io_u_free = fio_rbd_io_u_free,
491 .option_struct_size = sizeof(struct rbd_options),
494 static void fio_init fio_rbd_register(void)
496 register_ioengine(&ioengine);
499 static void fio_exit fio_rbd_unregister(void)
501 unregister_ioengine(&ioengine);