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
70 typedef struct RBDAIOCB {
71 BlockDriverAIOCB common;
79 struct BDRVRBDState *s;
84 typedef struct RADOSCB {
87 struct BDRVRBDState *s;
95 #define RBD_FD_WRITE 1
97 typedef struct BDRVRBDState {
100 rados_ioctx_t io_ctx;
102 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,
296 char pool[RBD_MAX_POOL_NAME_SIZE];
297 char name[RBD_MAX_IMAGE_NAME_SIZE];
298 char snap_buf[RBD_MAX_SNAP_NAME_SIZE];
299 char conf[RBD_MAX_CONF_SIZE];
300 char clientname_buf[RBD_MAX_CONF_SIZE];
303 rados_ioctx_t io_ctx;
306 if (qemu_rbd_parsename(filename, pool, sizeof(pool),
307 snap_buf, sizeof(snap_buf),
309 conf, sizeof(conf)) < 0) {
313 /* Read out options */
314 while (options && options->name) {
315 if (!strcmp(options->name, BLOCK_OPT_SIZE)) {
316 bytes = options->value.n;
317 } else if (!strcmp(options->name, BLOCK_OPT_CLUSTER_SIZE)) {
318 if (options->value.n) {
319 objsize = options->value.n;
320 if ((objsize - 1) & objsize) { /* not a power of 2? */
321 error_report("obj size needs to be power of 2");
324 if (objsize < 4096) {
325 error_report("obj size too small");
328 obj_order = ffs(objsize) - 1;
334 clientname = qemu_rbd_parse_clientname(conf, clientname_buf);
335 if (rados_create(&cluster, clientname) < 0) {
336 error_report("error initializing");
340 if (strstr(conf, "conf=") == NULL) {
341 /* try default location, but ignore failure */
342 rados_conf_read_file(cluster, NULL);
345 if (conf[0] != '\0' &&
346 qemu_rbd_set_conf(cluster, conf) < 0) {
347 error_report("error setting config options");
348 rados_shutdown(cluster);
352 if (rados_connect(cluster) < 0) {
353 error_report("error connecting");
354 rados_shutdown(cluster);
358 if (rados_ioctx_create(cluster, pool, &io_ctx) < 0) {
359 error_report("error opening pool %s", pool);
360 rados_shutdown(cluster);
364 ret = rbd_create(io_ctx, name, bytes, &obj_order);
365 rados_ioctx_destroy(io_ctx);
366 rados_shutdown(cluster);
372 * This aio completion is being called from qemu_rbd_aio_event_reader()
373 * and runs in qemu context. It schedules a bh, but just in case the aio
374 * was not cancelled before.
376 static void qemu_rbd_complete_aio(RADOSCB *rcb)
378 RBDAIOCB *acb = rcb->acb;
383 if (acb->cmd != RBD_AIO_READ) {
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);
433 } while (ret < 0 && errno == EINTR);
436 /* TODO Convert to fine grained options */
437 static QemuOptsList runtime_opts = {
439 .head = QTAILQ_HEAD_INITIALIZER(runtime_opts.head),
443 .type = QEMU_OPT_STRING,
444 .help = "Specification of the rbd image",
446 { /* end of list */ }
450 static int qemu_rbd_open(BlockDriverState *bs, QDict *options, int flags,
453 BDRVRBDState *s = bs->opaque;
454 char pool[RBD_MAX_POOL_NAME_SIZE];
455 char snap_buf[RBD_MAX_SNAP_NAME_SIZE];
456 char conf[RBD_MAX_CONF_SIZE];
457 char clientname_buf[RBD_MAX_CONF_SIZE];
460 Error *local_err = NULL;
461 const char *filename;
464 opts = qemu_opts_create_nofail(&runtime_opts);
465 qemu_opts_absorb_qdict(opts, options, &local_err);
466 if (error_is_set(&local_err)) {
467 qerror_report_err(local_err);
468 error_free(local_err);
473 filename = qemu_opt_get(opts, "filename");
475 if (qemu_rbd_parsename(filename, pool, sizeof(pool),
476 snap_buf, sizeof(snap_buf),
477 s->name, sizeof(s->name),
478 conf, sizeof(conf)) < 0) {
483 clientname = qemu_rbd_parse_clientname(conf, clientname_buf);
484 r = rados_create(&s->cluster, clientname);
486 error_report("error initializing");
491 if (snap_buf[0] != '\0') {
492 s->snap = g_strdup(snap_buf);
496 * Fallback to more conservative semantics if setting cache
497 * options fails. Ignore errors from setting rbd_cache because the
498 * only possible error is that the option does not exist, and
499 * librbd defaults to no caching. If write through caching cannot
500 * be set up, fall back to no caching.
502 if (flags & BDRV_O_NOCACHE) {
503 rados_conf_set(s->cluster, "rbd_cache", "false");
505 rados_conf_set(s->cluster, "rbd_cache", "true");
508 if (strstr(conf, "conf=") == NULL) {
509 /* try default location, but ignore failure */
510 rados_conf_read_file(s->cluster, NULL);
513 if (conf[0] != '\0') {
514 r = qemu_rbd_set_conf(s->cluster, conf);
516 error_report("error setting config options");
517 goto failed_shutdown;
521 r = rados_connect(s->cluster);
523 error_report("error connecting");
524 goto failed_shutdown;
527 r = rados_ioctx_create(s->cluster, pool, &s->io_ctx);
529 error_report("error opening pool %s", pool);
530 goto failed_shutdown;
533 r = rbd_open(s->io_ctx, s->name, &s->image, s->snap);
535 error_report("error reading header from %s", s->name);
539 bs->read_only = (s->snap != NULL);
541 s->event_reader_pos = 0;
542 r = qemu_pipe(s->fds);
544 error_report("error opening eventfd");
547 fcntl(s->fds[0], F_SETFL, O_NONBLOCK);
548 fcntl(s->fds[1], F_SETFL, O_NONBLOCK);
549 qemu_aio_set_fd_handler(s->fds[RBD_FD_READ], qemu_rbd_aio_event_reader,
559 rados_ioctx_destroy(s->io_ctx);
561 rados_shutdown(s->cluster);
568 static void qemu_rbd_close(BlockDriverState *bs)
570 BDRVRBDState *s = bs->opaque;
574 qemu_aio_set_fd_handler(s->fds[RBD_FD_READ], NULL, NULL, NULL);
577 rados_ioctx_destroy(s->io_ctx);
579 rados_shutdown(s->cluster);
583 * Cancel aio. Since we don't reference acb in a non qemu threads,
584 * it is safe to access it here.
586 static void qemu_rbd_aio_cancel(BlockDriverAIOCB *blockacb)
588 RBDAIOCB *acb = (RBDAIOCB *) blockacb;
591 while (acb->status == -EINPROGRESS) {
595 qemu_aio_release(acb);
598 static const AIOCBInfo rbd_aiocb_info = {
599 .aiocb_size = sizeof(RBDAIOCB),
600 .cancel = qemu_rbd_aio_cancel,
603 static int qemu_rbd_send_pipe(BDRVRBDState *s, RADOSCB *rcb)
608 int fd = s->fds[RBD_FD_WRITE];
610 /* send the op pointer to the qemu thread that is responsible
611 for the aio/op completion. Must do it in a qemu thread context */
612 ret = write(fd, (void *)&rcb, sizeof(rcb));
616 if (errno == EINTR) {
619 if (errno != EAGAIN) {
626 ret = select(fd + 1, NULL, &wfd, NULL, NULL);
627 } while (ret < 0 && errno == EINTR);
634 * This is the callback function for rbd_aio_read and _write
636 * Note: this function is being called from a non qemu thread so
637 * we need to be careful about what we do here. Generally we only
638 * write to the block notification pipe, and do the rest of the
639 * io completion handling from qemu_rbd_aio_event_reader() which
640 * runs in a qemu context.
642 static void rbd_finish_aiocb(rbd_completion_t c, RADOSCB *rcb)
645 rcb->ret = rbd_aio_get_return_value(c);
647 ret = qemu_rbd_send_pipe(rcb->s, rcb);
649 error_report("failed writing to acb->s->fds");
654 /* Callback when all queued rbd_aio requests are complete */
656 static void rbd_aio_bh_cb(void *opaque)
658 RBDAIOCB *acb = opaque;
660 if (acb->cmd == RBD_AIO_READ) {
661 qemu_iovec_from_buf(acb->qiov, 0, acb->bounce, acb->qiov->size);
663 qemu_vfree(acb->bounce);
664 acb->common.cb(acb->common.opaque, (acb->ret > 0 ? 0 : acb->ret));
665 qemu_bh_delete(acb->bh);
669 if (!acb->cancelled) {
670 qemu_aio_release(acb);
674 static int rbd_aio_discard_wrapper(rbd_image_t image,
677 rbd_completion_t comp)
679 #ifdef LIBRBD_SUPPORTS_DISCARD
680 return rbd_aio_discard(image, off, len, comp);
686 static int rbd_aio_flush_wrapper(rbd_image_t image,
687 rbd_completion_t comp)
689 #ifdef LIBRBD_SUPPORTS_AIO_FLUSH
690 return rbd_aio_flush(image, comp);
696 static BlockDriverAIOCB *rbd_start_aio(BlockDriverState *bs,
700 BlockDriverCompletionFunc *cb,
711 BDRVRBDState *s = bs->opaque;
713 acb = qemu_aio_get(&rbd_aiocb_info, bs, cb, opaque);
716 if (cmd == RBD_AIO_DISCARD || cmd == RBD_AIO_FLUSH) {
719 acb->bounce = qemu_blockalign(bs, qiov->size);
726 acb->status = -EINPROGRESS;
728 if (cmd == RBD_AIO_WRITE) {
729 qemu_iovec_to_buf(acb->qiov, 0, acb->bounce, qiov->size);
734 off = sector_num * BDRV_SECTOR_SIZE;
735 size = nb_sectors * BDRV_SECTOR_SIZE;
737 rcb = g_malloc(sizeof(RADOSCB));
743 r = rbd_aio_create_completion(rcb, (rbd_callback_t) rbd_finish_aiocb, &c);
750 r = rbd_aio_write(s->image, off, size, buf, c);
753 r = rbd_aio_read(s->image, off, size, buf, c);
755 case RBD_AIO_DISCARD:
756 r = rbd_aio_discard_wrapper(s->image, off, size, c);
759 r = rbd_aio_flush_wrapper(s->image, c);
773 qemu_aio_release(acb);
777 static BlockDriverAIOCB *qemu_rbd_aio_readv(BlockDriverState *bs,
781 BlockDriverCompletionFunc *cb,
784 return rbd_start_aio(bs, sector_num, qiov, nb_sectors, cb, opaque,
788 static BlockDriverAIOCB *qemu_rbd_aio_writev(BlockDriverState *bs,
792 BlockDriverCompletionFunc *cb,
795 return rbd_start_aio(bs, sector_num, qiov, nb_sectors, cb, opaque,
799 #ifdef LIBRBD_SUPPORTS_AIO_FLUSH
800 static BlockDriverAIOCB *qemu_rbd_aio_flush(BlockDriverState *bs,
801 BlockDriverCompletionFunc *cb,
804 return rbd_start_aio(bs, 0, NULL, 0, cb, opaque, RBD_AIO_FLUSH);
809 static int qemu_rbd_co_flush(BlockDriverState *bs)
811 #if LIBRBD_VERSION_CODE >= LIBRBD_VERSION(0, 1, 1)
812 /* rbd_flush added in 0.1.1 */
813 BDRVRBDState *s = bs->opaque;
814 return rbd_flush(s->image);
821 static int qemu_rbd_getinfo(BlockDriverState *bs, BlockDriverInfo *bdi)
823 BDRVRBDState *s = bs->opaque;
824 rbd_image_info_t info;
827 r = rbd_stat(s->image, &info, sizeof(info));
832 bdi->cluster_size = info.obj_size;
836 static int64_t qemu_rbd_getlength(BlockDriverState *bs)
838 BDRVRBDState *s = bs->opaque;
839 rbd_image_info_t info;
842 r = rbd_stat(s->image, &info, sizeof(info));
850 static int qemu_rbd_truncate(BlockDriverState *bs, int64_t offset)
852 BDRVRBDState *s = bs->opaque;
855 r = rbd_resize(s->image, offset);
863 static int qemu_rbd_snap_create(BlockDriverState *bs,
864 QEMUSnapshotInfo *sn_info)
866 BDRVRBDState *s = bs->opaque;
869 if (sn_info->name[0] == '\0') {
870 return -EINVAL; /* we need a name for rbd snapshots */
874 * rbd snapshots are using the name as the user controlled unique identifier
875 * we can't use the rbd snapid for that purpose, as it can't be set
877 if (sn_info->id_str[0] != '\0' &&
878 strcmp(sn_info->id_str, sn_info->name) != 0) {
882 if (strlen(sn_info->name) >= sizeof(sn_info->id_str)) {
886 r = rbd_snap_create(s->image, sn_info->name);
888 error_report("failed to create snap: %s", strerror(-r));
895 static int qemu_rbd_snap_remove(BlockDriverState *bs,
896 const char *snapshot_id,
897 const char *snapshot_name,
900 BDRVRBDState *s = bs->opaque;
903 if (!snapshot_name) {
904 error_setg(errp, "rbd need a valid snapshot name");
908 /* If snapshot_id is specified, it must be equal to name, see
909 qemu_rbd_snap_list() */
910 if (snapshot_id && strcmp(snapshot_id, snapshot_name)) {
912 "rbd do not support snapshot id, it should be NULL or "
913 "equal to snapshot name");
917 r = rbd_snap_remove(s->image, snapshot_name);
919 error_setg_errno(errp, -r, "Failed to remove the snapshot");
924 static int qemu_rbd_snap_rollback(BlockDriverState *bs,
925 const char *snapshot_name)
927 BDRVRBDState *s = bs->opaque;
930 r = rbd_snap_rollback(s->image, snapshot_name);
934 static int qemu_rbd_snap_list(BlockDriverState *bs,
935 QEMUSnapshotInfo **psn_tab)
937 BDRVRBDState *s = bs->opaque;
938 QEMUSnapshotInfo *sn_info, *sn_tab = NULL;
940 rbd_snap_info_t *snaps;
941 int max_snaps = RBD_MAX_SNAPS;
944 snaps = g_malloc(sizeof(*snaps) * max_snaps);
945 snap_count = rbd_snap_list(s->image, snaps, &max_snaps);
946 if (snap_count <= 0) {
949 } while (snap_count == -ERANGE);
951 if (snap_count <= 0) {
955 sn_tab = g_malloc0(snap_count * sizeof(QEMUSnapshotInfo));
957 for (i = 0; i < snap_count; i++) {
958 const char *snap_name = snaps[i].name;
960 sn_info = sn_tab + i;
961 pstrcpy(sn_info->id_str, sizeof(sn_info->id_str), snap_name);
962 pstrcpy(sn_info->name, sizeof(sn_info->name), snap_name);
964 sn_info->vm_state_size = snaps[i].size;
965 sn_info->date_sec = 0;
966 sn_info->date_nsec = 0;
967 sn_info->vm_clock_nsec = 0;
969 rbd_snap_list_end(snaps);
977 #ifdef LIBRBD_SUPPORTS_DISCARD
978 static BlockDriverAIOCB* qemu_rbd_aio_discard(BlockDriverState *bs,
981 BlockDriverCompletionFunc *cb,
984 return rbd_start_aio(bs, sector_num, NULL, nb_sectors, cb, opaque,
989 static QEMUOptionParameter qemu_rbd_create_options[] = {
991 .name = BLOCK_OPT_SIZE,
993 .help = "Virtual disk size"
996 .name = BLOCK_OPT_CLUSTER_SIZE,
998 .help = "RBD object size"
1003 static BlockDriver bdrv_rbd = {
1004 .format_name = "rbd",
1005 .instance_size = sizeof(BDRVRBDState),
1006 .bdrv_needs_filename = true,
1007 .bdrv_file_open = qemu_rbd_open,
1008 .bdrv_close = qemu_rbd_close,
1009 .bdrv_create = qemu_rbd_create,
1010 .bdrv_has_zero_init = bdrv_has_zero_init_1,
1011 .bdrv_get_info = qemu_rbd_getinfo,
1012 .create_options = qemu_rbd_create_options,
1013 .bdrv_getlength = qemu_rbd_getlength,
1014 .bdrv_truncate = qemu_rbd_truncate,
1015 .protocol_name = "rbd",
1017 .bdrv_aio_readv = qemu_rbd_aio_readv,
1018 .bdrv_aio_writev = qemu_rbd_aio_writev,
1020 #ifdef LIBRBD_SUPPORTS_AIO_FLUSH
1021 .bdrv_aio_flush = qemu_rbd_aio_flush,
1023 .bdrv_co_flush_to_disk = qemu_rbd_co_flush,
1026 #ifdef LIBRBD_SUPPORTS_DISCARD
1027 .bdrv_aio_discard = qemu_rbd_aio_discard,
1030 .bdrv_snapshot_create = qemu_rbd_snap_create,
1031 .bdrv_snapshot_delete = qemu_rbd_snap_remove,
1032 .bdrv_snapshot_list = qemu_rbd_snap_list,
1033 .bdrv_snapshot_goto = qemu_rbd_snap_rollback,
1036 static void bdrv_rbd_init(void)
1038 bdrv_register(&bdrv_rbd);
1041 block_init(bdrv_rbd_init);