2 * QEMU Block driver for RADOS (Ceph)
7 * This work is licensed under the terms of the GNU GPL, version 2. See
8 * the COPYING file in the top-level directory.
10 * Contributions after 2012-01-13 are licensed under the terms of the
11 * GNU GPL, version 2 or (at your option) any later version.
16 #include "qemu-common.h"
17 #include "qemu/error-report.h"
18 #include "block/block_int.h"
20 #include <rbd/librbd.h>
23 * When specifying the image filename use:
25 * rbd:poolname/devicename[@snapshotname][:option1=value1[:option2=value2...]]
27 * poolname must be the name of an existing rados pool.
29 * devicename is the name of the rbd image.
31 * Each option given is used to configure rados, and may be any valid
32 * Ceph option, "id", or "conf".
34 * The "id" option indicates what user we should authenticate as to
35 * the Ceph cluster. If it is excluded we will use the Ceph default
38 * The "conf" option specifies a Ceph configuration file to read. If
39 * it is not specified, we will read from the default Ceph locations
40 * (e.g., /etc/ceph/ceph.conf). To avoid reading _any_ configuration
41 * file, specify conf=/dev/null.
43 * Configuration values containing :, @, or = can be escaped with a
47 /* rbd_aio_discard added in 0.1.2 */
48 #if LIBRBD_VERSION_CODE >= LIBRBD_VERSION(0, 1, 2)
49 #define LIBRBD_SUPPORTS_DISCARD
51 #undef LIBRBD_SUPPORTS_DISCARD
54 #define OBJ_MAX_SIZE (1UL << OBJ_DEFAULT_OBJ_ORDER)
56 #define RBD_MAX_CONF_NAME_SIZE 128
57 #define RBD_MAX_CONF_VAL_SIZE 512
58 #define RBD_MAX_CONF_SIZE 1024
59 #define RBD_MAX_POOL_NAME_SIZE 128
60 #define RBD_MAX_SNAP_NAME_SIZE 128
61 #define RBD_MAX_SNAPS 100
69 typedef struct RBDAIOCB {
70 BlockDriverAIOCB common;
78 struct BDRVRBDState *s;
83 typedef struct RADOSCB {
86 struct BDRVRBDState *s;
94 #define RBD_FD_WRITE 1
96 typedef struct BDRVRBDState {
101 char name[RBD_MAX_IMAGE_NAME_SIZE];
104 int event_reader_pos;
108 static void rbd_aio_bh_cb(void *opaque);
110 static int qemu_rbd_next_tok(char *dst, int dst_len,
111 char *src, char delim,
121 for (end = src; *end; ++end) {
125 if (*end == '\\' && end[1] != '\0') {
136 error_report("%s too long", name);
139 error_report("%s too short", name);
143 pstrcpy(dst, dst_len, src);
148 static void qemu_rbd_unescape(char *src)
152 for (p = src; *src; ++src, ++p) {
153 if (*src == '\\' && src[1] != '\0') {
161 static int qemu_rbd_parsename(const char *filename,
162 char *pool, int pool_len,
163 char *snap, int snap_len,
164 char *name, int name_len,
165 char *conf, int conf_len)
171 if (!strstart(filename, "rbd:", &start)) {
175 buf = g_strdup(start);
180 ret = qemu_rbd_next_tok(pool, pool_len, p, '/', "pool name", &p);
185 qemu_rbd_unescape(pool);
187 if (strchr(p, '@')) {
188 ret = qemu_rbd_next_tok(name, name_len, p, '@', "object name", &p);
192 ret = qemu_rbd_next_tok(snap, snap_len, p, ':', "snap name", &p);
193 qemu_rbd_unescape(snap);
195 ret = qemu_rbd_next_tok(name, name_len, p, ':', "object name", &p);
197 qemu_rbd_unescape(name);
202 ret = qemu_rbd_next_tok(conf, conf_len, p, '\0', "configuration", &p);
209 static char *qemu_rbd_parse_clientname(const char *conf, char *clientname)
211 const char *p = conf;
215 const char *end = strchr(p, ':');
223 if (strncmp(p, "id=", 3) == 0) {
225 strncpy(clientname, p + 3, len);
226 clientname[len] = '\0';
237 static int qemu_rbd_set_conf(rados_t cluster, const char *conf)
240 char name[RBD_MAX_CONF_NAME_SIZE];
241 char value[RBD_MAX_CONF_VAL_SIZE];
244 buf = g_strdup(conf);
248 ret = qemu_rbd_next_tok(name, sizeof(name), p,
249 '=', "conf option name", &p);
253 qemu_rbd_unescape(name);
256 error_report("conf option %s has no value", name);
261 ret = qemu_rbd_next_tok(value, sizeof(value), p,
262 ':', "conf option value", &p);
266 qemu_rbd_unescape(value);
268 if (strcmp(name, "conf") == 0) {
269 ret = rados_conf_read_file(cluster, value);
271 error_report("error reading conf file %s", value);
274 } else if (strcmp(name, "id") == 0) {
275 /* ignore, this is parsed by qemu_rbd_parse_clientname() */
277 ret = rados_conf_set(cluster, name, value);
279 error_report("invalid conf option %s", name);
290 static int qemu_rbd_create(const char *filename, QEMUOptionParameter *options)
295 char pool[RBD_MAX_POOL_NAME_SIZE];
296 char name[RBD_MAX_IMAGE_NAME_SIZE];
297 char snap_buf[RBD_MAX_SNAP_NAME_SIZE];
298 char conf[RBD_MAX_CONF_SIZE];
299 char clientname_buf[RBD_MAX_CONF_SIZE];
302 rados_ioctx_t io_ctx;
305 if (qemu_rbd_parsename(filename, pool, sizeof(pool),
306 snap_buf, sizeof(snap_buf),
308 conf, sizeof(conf)) < 0) {
312 /* Read out options */
313 while (options && options->name) {
314 if (!strcmp(options->name, BLOCK_OPT_SIZE)) {
315 bytes = options->value.n;
316 } else if (!strcmp(options->name, BLOCK_OPT_CLUSTER_SIZE)) {
317 if (options->value.n) {
318 objsize = options->value.n;
319 if ((objsize - 1) & objsize) { /* not a power of 2? */
320 error_report("obj size needs to be power of 2");
323 if (objsize < 4096) {
324 error_report("obj size too small");
327 obj_order = ffs(objsize) - 1;
333 clientname = qemu_rbd_parse_clientname(conf, clientname_buf);
334 if (rados_create(&cluster, clientname) < 0) {
335 error_report("error initializing");
339 if (strstr(conf, "conf=") == NULL) {
340 /* try default location, but ignore failure */
341 rados_conf_read_file(cluster, NULL);
344 if (conf[0] != '\0' &&
345 qemu_rbd_set_conf(cluster, conf) < 0) {
346 error_report("error setting config options");
347 rados_shutdown(cluster);
351 if (rados_connect(cluster) < 0) {
352 error_report("error connecting");
353 rados_shutdown(cluster);
357 if (rados_ioctx_create(cluster, pool, &io_ctx) < 0) {
358 error_report("error opening pool %s", pool);
359 rados_shutdown(cluster);
363 ret = rbd_create(io_ctx, name, bytes, &obj_order);
364 rados_ioctx_destroy(io_ctx);
365 rados_shutdown(cluster);
371 * This aio completion is being called from qemu_rbd_aio_event_reader()
372 * and runs in qemu context. It schedules a bh, but just in case the aio
373 * was not cancelled before.
375 static void qemu_rbd_complete_aio(RADOSCB *rcb)
377 RBDAIOCB *acb = rcb->acb;
382 if (acb->cmd == RBD_AIO_WRITE ||
383 acb->cmd == RBD_AIO_DISCARD) {
387 } else if (!acb->error) {
388 acb->ret = rcb->size;
392 memset(rcb->buf, 0, rcb->size);
395 } else if (r < rcb->size) {
396 memset(rcb->buf + r, 0, rcb->size - r);
398 acb->ret = rcb->size;
400 } else if (!acb->error) {
404 /* Note that acb->bh can be NULL in case where the aio was cancelled */
405 acb->bh = qemu_bh_new(rbd_aio_bh_cb, acb);
406 qemu_bh_schedule(acb->bh);
411 * aio fd read handler. It runs in the qemu context and calls the
412 * completion handling of completed rados aio operations.
414 static void qemu_rbd_aio_event_reader(void *opaque)
416 BDRVRBDState *s = opaque;
421 char *p = (char *)&s->event_rcb;
423 /* now read the rcb pointer that was sent from a non qemu thread */
424 ret = read(s->fds[RBD_FD_READ], p + s->event_reader_pos,
425 sizeof(s->event_rcb) - s->event_reader_pos);
427 s->event_reader_pos += ret;
428 if (s->event_reader_pos == sizeof(s->event_rcb)) {
429 s->event_reader_pos = 0;
430 qemu_rbd_complete_aio(s->event_rcb);
434 } while (ret < 0 && errno == EINTR);
437 static int qemu_rbd_aio_flush_cb(void *opaque)
439 BDRVRBDState *s = opaque;
441 return (s->qemu_aio_count > 0);
444 static int qemu_rbd_open(BlockDriverState *bs, const char *filename, int flags)
446 BDRVRBDState *s = bs->opaque;
447 char pool[RBD_MAX_POOL_NAME_SIZE];
448 char snap_buf[RBD_MAX_SNAP_NAME_SIZE];
449 char conf[RBD_MAX_CONF_SIZE];
450 char clientname_buf[RBD_MAX_CONF_SIZE];
454 if (qemu_rbd_parsename(filename, pool, sizeof(pool),
455 snap_buf, sizeof(snap_buf),
456 s->name, sizeof(s->name),
457 conf, sizeof(conf)) < 0) {
461 clientname = qemu_rbd_parse_clientname(conf, clientname_buf);
462 r = rados_create(&s->cluster, clientname);
464 error_report("error initializing");
469 if (snap_buf[0] != '\0') {
470 s->snap = g_strdup(snap_buf);
474 * Fallback to more conservative semantics if setting cache
475 * options fails. Ignore errors from setting rbd_cache because the
476 * only possible error is that the option does not exist, and
477 * librbd defaults to no caching. If write through caching cannot
478 * be set up, fall back to no caching.
480 if (flags & BDRV_O_NOCACHE) {
481 rados_conf_set(s->cluster, "rbd_cache", "false");
483 rados_conf_set(s->cluster, "rbd_cache", "true");
486 if (strstr(conf, "conf=") == NULL) {
487 /* try default location, but ignore failure */
488 rados_conf_read_file(s->cluster, NULL);
491 if (conf[0] != '\0') {
492 r = qemu_rbd_set_conf(s->cluster, conf);
494 error_report("error setting config options");
495 goto failed_shutdown;
499 r = rados_connect(s->cluster);
501 error_report("error connecting");
502 goto failed_shutdown;
505 r = rados_ioctx_create(s->cluster, pool, &s->io_ctx);
507 error_report("error opening pool %s", pool);
508 goto failed_shutdown;
511 r = rbd_open(s->io_ctx, s->name, &s->image, s->snap);
513 error_report("error reading header from %s", s->name);
517 bs->read_only = (s->snap != NULL);
519 s->event_reader_pos = 0;
520 r = qemu_pipe(s->fds);
522 error_report("error opening eventfd");
525 fcntl(s->fds[0], F_SETFL, O_NONBLOCK);
526 fcntl(s->fds[1], F_SETFL, O_NONBLOCK);
527 qemu_aio_set_fd_handler(s->fds[RBD_FD_READ], qemu_rbd_aio_event_reader,
528 NULL, qemu_rbd_aio_flush_cb, s);
536 rados_ioctx_destroy(s->io_ctx);
538 rados_shutdown(s->cluster);
543 static void qemu_rbd_close(BlockDriverState *bs)
545 BDRVRBDState *s = bs->opaque;
549 qemu_aio_set_fd_handler(s->fds[RBD_FD_READ], NULL, NULL, NULL, NULL);
552 rados_ioctx_destroy(s->io_ctx);
554 rados_shutdown(s->cluster);
558 * Cancel aio. Since we don't reference acb in a non qemu threads,
559 * it is safe to access it here.
561 static void qemu_rbd_aio_cancel(BlockDriverAIOCB *blockacb)
563 RBDAIOCB *acb = (RBDAIOCB *) blockacb;
566 while (acb->status == -EINPROGRESS) {
570 qemu_aio_release(acb);
573 static const AIOCBInfo rbd_aiocb_info = {
574 .aiocb_size = sizeof(RBDAIOCB),
575 .cancel = qemu_rbd_aio_cancel,
578 static int qemu_rbd_send_pipe(BDRVRBDState *s, RADOSCB *rcb)
583 int fd = s->fds[RBD_FD_WRITE];
585 /* send the op pointer to the qemu thread that is responsible
586 for the aio/op completion. Must do it in a qemu thread context */
587 ret = write(fd, (void *)&rcb, sizeof(rcb));
591 if (errno == EINTR) {
594 if (errno != EAGAIN) {
601 ret = select(fd + 1, NULL, &wfd, NULL, NULL);
602 } while (ret < 0 && errno == EINTR);
609 * This is the callback function for rbd_aio_read and _write
611 * Note: this function is being called from a non qemu thread so
612 * we need to be careful about what we do here. Generally we only
613 * write to the block notification pipe, and do the rest of the
614 * io completion handling from qemu_rbd_aio_event_reader() which
615 * runs in a qemu context.
617 static void rbd_finish_aiocb(rbd_completion_t c, RADOSCB *rcb)
620 rcb->ret = rbd_aio_get_return_value(c);
622 ret = qemu_rbd_send_pipe(rcb->s, rcb);
624 error_report("failed writing to acb->s->fds");
629 /* Callback when all queued rbd_aio requests are complete */
631 static void rbd_aio_bh_cb(void *opaque)
633 RBDAIOCB *acb = opaque;
635 if (acb->cmd == RBD_AIO_READ) {
636 qemu_iovec_from_buf(acb->qiov, 0, acb->bounce, acb->qiov->size);
638 qemu_vfree(acb->bounce);
639 acb->common.cb(acb->common.opaque, (acb->ret > 0 ? 0 : acb->ret));
640 qemu_bh_delete(acb->bh);
644 if (!acb->cancelled) {
645 qemu_aio_release(acb);
649 static int rbd_aio_discard_wrapper(rbd_image_t image,
652 rbd_completion_t comp)
654 #ifdef LIBRBD_SUPPORTS_DISCARD
655 return rbd_aio_discard(image, off, len, comp);
661 static BlockDriverAIOCB *rbd_start_aio(BlockDriverState *bs,
665 BlockDriverCompletionFunc *cb,
676 BDRVRBDState *s = bs->opaque;
678 acb = qemu_aio_get(&rbd_aiocb_info, bs, cb, opaque);
681 if (cmd == RBD_AIO_DISCARD) {
684 acb->bounce = qemu_blockalign(bs, qiov->size);
691 acb->status = -EINPROGRESS;
693 if (cmd == RBD_AIO_WRITE) {
694 qemu_iovec_to_buf(acb->qiov, 0, acb->bounce, qiov->size);
699 off = sector_num * BDRV_SECTOR_SIZE;
700 size = nb_sectors * BDRV_SECTOR_SIZE;
702 s->qemu_aio_count++; /* All the RADOSCB */
704 rcb = g_malloc(sizeof(RADOSCB));
710 r = rbd_aio_create_completion(rcb, (rbd_callback_t) rbd_finish_aiocb, &c);
717 r = rbd_aio_write(s->image, off, size, buf, c);
720 r = rbd_aio_read(s->image, off, size, buf, c);
722 case RBD_AIO_DISCARD:
723 r = rbd_aio_discard_wrapper(s->image, off, size, c);
738 qemu_aio_release(acb);
742 static BlockDriverAIOCB *qemu_rbd_aio_readv(BlockDriverState *bs,
746 BlockDriverCompletionFunc *cb,
749 return rbd_start_aio(bs, sector_num, qiov, nb_sectors, cb, opaque,
753 static BlockDriverAIOCB *qemu_rbd_aio_writev(BlockDriverState *bs,
757 BlockDriverCompletionFunc *cb,
760 return rbd_start_aio(bs, sector_num, qiov, nb_sectors, cb, opaque,
764 static int qemu_rbd_co_flush(BlockDriverState *bs)
766 #if LIBRBD_VERSION_CODE >= LIBRBD_VERSION(0, 1, 1)
767 /* rbd_flush added in 0.1.1 */
768 BDRVRBDState *s = bs->opaque;
769 return rbd_flush(s->image);
775 static int qemu_rbd_getinfo(BlockDriverState *bs, BlockDriverInfo *bdi)
777 BDRVRBDState *s = bs->opaque;
778 rbd_image_info_t info;
781 r = rbd_stat(s->image, &info, sizeof(info));
786 bdi->cluster_size = info.obj_size;
790 static int64_t qemu_rbd_getlength(BlockDriverState *bs)
792 BDRVRBDState *s = bs->opaque;
793 rbd_image_info_t info;
796 r = rbd_stat(s->image, &info, sizeof(info));
804 static int qemu_rbd_truncate(BlockDriverState *bs, int64_t offset)
806 BDRVRBDState *s = bs->opaque;
809 r = rbd_resize(s->image, offset);
817 static int qemu_rbd_snap_create(BlockDriverState *bs,
818 QEMUSnapshotInfo *sn_info)
820 BDRVRBDState *s = bs->opaque;
823 if (sn_info->name[0] == '\0') {
824 return -EINVAL; /* we need a name for rbd snapshots */
828 * rbd snapshots are using the name as the user controlled unique identifier
829 * we can't use the rbd snapid for that purpose, as it can't be set
831 if (sn_info->id_str[0] != '\0' &&
832 strcmp(sn_info->id_str, sn_info->name) != 0) {
836 if (strlen(sn_info->name) >= sizeof(sn_info->id_str)) {
840 r = rbd_snap_create(s->image, sn_info->name);
842 error_report("failed to create snap: %s", strerror(-r));
849 static int qemu_rbd_snap_remove(BlockDriverState *bs,
850 const char *snapshot_name)
852 BDRVRBDState *s = bs->opaque;
855 r = rbd_snap_remove(s->image, snapshot_name);
859 static int qemu_rbd_snap_rollback(BlockDriverState *bs,
860 const char *snapshot_name)
862 BDRVRBDState *s = bs->opaque;
865 r = rbd_snap_rollback(s->image, snapshot_name);
869 static int qemu_rbd_snap_list(BlockDriverState *bs,
870 QEMUSnapshotInfo **psn_tab)
872 BDRVRBDState *s = bs->opaque;
873 QEMUSnapshotInfo *sn_info, *sn_tab = NULL;
875 rbd_snap_info_t *snaps;
876 int max_snaps = RBD_MAX_SNAPS;
879 snaps = g_malloc(sizeof(*snaps) * max_snaps);
880 snap_count = rbd_snap_list(s->image, snaps, &max_snaps);
881 if (snap_count < 0) {
884 } while (snap_count == -ERANGE);
886 if (snap_count <= 0) {
890 sn_tab = g_malloc0(snap_count * sizeof(QEMUSnapshotInfo));
892 for (i = 0; i < snap_count; i++) {
893 const char *snap_name = snaps[i].name;
895 sn_info = sn_tab + i;
896 pstrcpy(sn_info->id_str, sizeof(sn_info->id_str), snap_name);
897 pstrcpy(sn_info->name, sizeof(sn_info->name), snap_name);
899 sn_info->vm_state_size = snaps[i].size;
900 sn_info->date_sec = 0;
901 sn_info->date_nsec = 0;
902 sn_info->vm_clock_nsec = 0;
904 rbd_snap_list_end(snaps);
911 #ifdef LIBRBD_SUPPORTS_DISCARD
912 static BlockDriverAIOCB* qemu_rbd_aio_discard(BlockDriverState *bs,
915 BlockDriverCompletionFunc *cb,
918 return rbd_start_aio(bs, sector_num, NULL, nb_sectors, cb, opaque,
923 static QEMUOptionParameter qemu_rbd_create_options[] = {
925 .name = BLOCK_OPT_SIZE,
927 .help = "Virtual disk size"
930 .name = BLOCK_OPT_CLUSTER_SIZE,
932 .help = "RBD object size"
937 static BlockDriver bdrv_rbd = {
938 .format_name = "rbd",
939 .instance_size = sizeof(BDRVRBDState),
940 .bdrv_file_open = qemu_rbd_open,
941 .bdrv_close = qemu_rbd_close,
942 .bdrv_create = qemu_rbd_create,
943 .bdrv_get_info = qemu_rbd_getinfo,
944 .create_options = qemu_rbd_create_options,
945 .bdrv_getlength = qemu_rbd_getlength,
946 .bdrv_truncate = qemu_rbd_truncate,
947 .protocol_name = "rbd",
949 .bdrv_aio_readv = qemu_rbd_aio_readv,
950 .bdrv_aio_writev = qemu_rbd_aio_writev,
951 .bdrv_co_flush_to_disk = qemu_rbd_co_flush,
953 #ifdef LIBRBD_SUPPORTS_DISCARD
954 .bdrv_aio_discard = qemu_rbd_aio_discard,
957 .bdrv_snapshot_create = qemu_rbd_snap_create,
958 .bdrv_snapshot_delete = qemu_rbd_snap_remove,
959 .bdrv_snapshot_list = qemu_rbd_snap_list,
960 .bdrv_snapshot_goto = qemu_rbd_snap_rollback,
963 static void bdrv_rbd_init(void)
965 bdrv_register(&bdrv_rbd);
968 block_init(bdrv_rbd_init);