Merge remote-tracking branch 'qmp/for-anthony' into staging
[qemu.git] / block / rbd.c
blobbdc448aa9fa45b843e98a981a59085b80b6eab49
1 /*
2 * QEMU Block driver for RADOS (Ceph)
4 * Copyright (C) 2010-2011 Christian Brunner <chb@muc.de>,
5 * Josh Durgin <josh.durgin@dreamhost.com>
7 * This work is licensed under the terms of the GNU GPL, version 2. See
8 * the COPYING file in the top-level directory.
12 #include <inttypes.h>
14 #include "qemu-common.h"
15 #include "qemu-error.h"
17 #include "block_int.h"
19 #include <rbd/librbd.h>
24 * When specifying the image filename use:
26 * rbd:poolname/devicename[@snapshotname][:option1=value1[:option2=value2...]]
28 * poolname must be the name of an existing rados pool
30 * devicename is the basename for all objects used to
31 * emulate the raw device.
33 * Each option given is used to configure rados, and may be
34 * any Ceph option, or "conf". The "conf" option specifies
35 * a Ceph configuration file to read.
37 * Metadata information (image size, ...) is stored in an
38 * object with the name "devicename.rbd".
40 * The raw device is split into 4MB sized objects by default.
41 * The sequencenumber is encoded in a 12 byte long hex-string,
42 * and is attached to the devicename, separated by a dot.
43 * e.g. "devicename.1234567890ab"
47 #define OBJ_MAX_SIZE (1UL << OBJ_DEFAULT_OBJ_ORDER)
49 #define RBD_MAX_CONF_NAME_SIZE 128
50 #define RBD_MAX_CONF_VAL_SIZE 512
51 #define RBD_MAX_CONF_SIZE 1024
52 #define RBD_MAX_POOL_NAME_SIZE 128
53 #define RBD_MAX_SNAP_NAME_SIZE 128
54 #define RBD_MAX_SNAPS 100
56 typedef struct RBDAIOCB {
57 BlockDriverAIOCB common;
58 QEMUBH *bh;
59 int ret;
60 QEMUIOVector *qiov;
61 char *bounce;
62 int write;
63 int64_t sector_num;
64 int error;
65 struct BDRVRBDState *s;
66 int cancelled;
67 } RBDAIOCB;
69 typedef struct RADOSCB {
70 int rcbid;
71 RBDAIOCB *acb;
72 struct BDRVRBDState *s;
73 int done;
74 int64_t size;
75 char *buf;
76 int ret;
77 } RADOSCB;
79 #define RBD_FD_READ 0
80 #define RBD_FD_WRITE 1
82 typedef struct BDRVRBDState {
83 int fds[2];
84 rados_t cluster;
85 rados_ioctx_t io_ctx;
86 rbd_image_t image;
87 char name[RBD_MAX_IMAGE_NAME_SIZE];
88 int qemu_aio_count;
89 char *snap;
90 int event_reader_pos;
91 RADOSCB *event_rcb;
92 } BDRVRBDState;
94 static void rbd_aio_bh_cb(void *opaque);
96 static int qemu_rbd_next_tok(char *dst, int dst_len,
97 char *src, char delim,
98 const char *name,
99 char **p)
101 int l;
102 char *end;
104 *p = NULL;
106 if (delim != '\0') {
107 end = strchr(src, delim);
108 if (end) {
109 *p = end + 1;
110 *end = '\0';
113 l = strlen(src);
114 if (l >= dst_len) {
115 error_report("%s too long", name);
116 return -EINVAL;
117 } else if (l == 0) {
118 error_report("%s too short", name);
119 return -EINVAL;
122 pstrcpy(dst, dst_len, src);
124 return 0;
127 static int qemu_rbd_parsename(const char *filename,
128 char *pool, int pool_len,
129 char *snap, int snap_len,
130 char *name, int name_len,
131 char *conf, int conf_len)
133 const char *start;
134 char *p, *buf;
135 int ret;
137 if (!strstart(filename, "rbd:", &start)) {
138 return -EINVAL;
141 buf = qemu_strdup(start);
142 p = buf;
143 *snap = '\0';
144 *conf = '\0';
146 ret = qemu_rbd_next_tok(pool, pool_len, p, '/', "pool name", &p);
147 if (ret < 0 || !p) {
148 ret = -EINVAL;
149 goto done;
152 if (strchr(p, '@')) {
153 ret = qemu_rbd_next_tok(name, name_len, p, '@', "object name", &p);
154 if (ret < 0) {
155 goto done;
157 ret = qemu_rbd_next_tok(snap, snap_len, p, ':', "snap name", &p);
158 } else {
159 ret = qemu_rbd_next_tok(name, name_len, p, ':', "object name", &p);
161 if (ret < 0 || !p) {
162 goto done;
165 ret = qemu_rbd_next_tok(conf, conf_len, p, '\0', "configuration", &p);
167 done:
168 qemu_free(buf);
169 return ret;
172 static int qemu_rbd_set_conf(rados_t cluster, const char *conf)
174 char *p, *buf;
175 char name[RBD_MAX_CONF_NAME_SIZE];
176 char value[RBD_MAX_CONF_VAL_SIZE];
177 int ret = 0;
179 buf = qemu_strdup(conf);
180 p = buf;
182 while (p) {
183 ret = qemu_rbd_next_tok(name, sizeof(name), p,
184 '=', "conf option name", &p);
185 if (ret < 0) {
186 break;
189 if (!p) {
190 error_report("conf option %s has no value", name);
191 ret = -EINVAL;
192 break;
195 ret = qemu_rbd_next_tok(value, sizeof(value), p,
196 ':', "conf option value", &p);
197 if (ret < 0) {
198 break;
201 if (strcmp(name, "conf")) {
202 ret = rados_conf_set(cluster, name, value);
203 if (ret < 0) {
204 error_report("invalid conf option %s", name);
205 ret = -EINVAL;
206 break;
208 } else {
209 ret = rados_conf_read_file(cluster, value);
210 if (ret < 0) {
211 error_report("error reading conf file %s", value);
212 break;
217 qemu_free(buf);
218 return ret;
221 static int qemu_rbd_create(const char *filename, QEMUOptionParameter *options)
223 int64_t bytes = 0;
224 int64_t objsize;
225 int obj_order = 0;
226 char pool[RBD_MAX_POOL_NAME_SIZE];
227 char name[RBD_MAX_IMAGE_NAME_SIZE];
228 char snap_buf[RBD_MAX_SNAP_NAME_SIZE];
229 char conf[RBD_MAX_CONF_SIZE];
230 char *snap = NULL;
231 rados_t cluster;
232 rados_ioctx_t io_ctx;
233 int ret;
235 if (qemu_rbd_parsename(filename, pool, sizeof(pool),
236 snap_buf, sizeof(snap_buf),
237 name, sizeof(name),
238 conf, sizeof(conf)) < 0) {
239 return -EINVAL;
241 if (snap_buf[0] != '\0') {
242 snap = snap_buf;
245 /* Read out options */
246 while (options && options->name) {
247 if (!strcmp(options->name, BLOCK_OPT_SIZE)) {
248 bytes = options->value.n;
249 } else if (!strcmp(options->name, BLOCK_OPT_CLUSTER_SIZE)) {
250 if (options->value.n) {
251 objsize = options->value.n;
252 if ((objsize - 1) & objsize) { /* not a power of 2? */
253 error_report("obj size needs to be power of 2");
254 return -EINVAL;
256 if (objsize < 4096) {
257 error_report("obj size too small");
258 return -EINVAL;
260 obj_order = ffs(objsize) - 1;
263 options++;
266 if (rados_create(&cluster, NULL) < 0) {
267 error_report("error initializing");
268 return -EIO;
271 if (strstr(conf, "conf=") == NULL) {
272 if (rados_conf_read_file(cluster, NULL) < 0) {
273 error_report("error reading config file");
274 rados_shutdown(cluster);
275 return -EIO;
279 if (conf[0] != '\0' &&
280 qemu_rbd_set_conf(cluster, conf) < 0) {
281 error_report("error setting config options");
282 rados_shutdown(cluster);
283 return -EIO;
286 if (rados_connect(cluster) < 0) {
287 error_report("error connecting");
288 rados_shutdown(cluster);
289 return -EIO;
292 if (rados_ioctx_create(cluster, pool, &io_ctx) < 0) {
293 error_report("error opening pool %s", pool);
294 rados_shutdown(cluster);
295 return -EIO;
298 ret = rbd_create(io_ctx, name, bytes, &obj_order);
299 rados_ioctx_destroy(io_ctx);
300 rados_shutdown(cluster);
302 return ret;
306 * This aio completion is being called from qemu_rbd_aio_event_reader()
307 * and runs in qemu context. It schedules a bh, but just in case the aio
308 * was not cancelled before.
310 static void qemu_rbd_complete_aio(RADOSCB *rcb)
312 RBDAIOCB *acb = rcb->acb;
313 int64_t r;
315 if (acb->cancelled) {
316 qemu_vfree(acb->bounce);
317 qemu_aio_release(acb);
318 goto done;
321 r = rcb->ret;
323 if (acb->write) {
324 if (r < 0) {
325 acb->ret = r;
326 acb->error = 1;
327 } else if (!acb->error) {
328 acb->ret = rcb->size;
330 } else {
331 if (r < 0) {
332 memset(rcb->buf, 0, rcb->size);
333 acb->ret = r;
334 acb->error = 1;
335 } else if (r < rcb->size) {
336 memset(rcb->buf + r, 0, rcb->size - r);
337 if (!acb->error) {
338 acb->ret = rcb->size;
340 } else if (!acb->error) {
341 acb->ret = r;
344 /* Note that acb->bh can be NULL in case where the aio was cancelled */
345 acb->bh = qemu_bh_new(rbd_aio_bh_cb, acb);
346 qemu_bh_schedule(acb->bh);
347 done:
348 qemu_free(rcb);
352 * aio fd read handler. It runs in the qemu context and calls the
353 * completion handling of completed rados aio operations.
355 static void qemu_rbd_aio_event_reader(void *opaque)
357 BDRVRBDState *s = opaque;
359 ssize_t ret;
361 do {
362 char *p = (char *)&s->event_rcb;
364 /* now read the rcb pointer that was sent from a non qemu thread */
365 if ((ret = read(s->fds[RBD_FD_READ], p + s->event_reader_pos,
366 sizeof(s->event_rcb) - s->event_reader_pos)) > 0) {
367 if (ret > 0) {
368 s->event_reader_pos += ret;
369 if (s->event_reader_pos == sizeof(s->event_rcb)) {
370 s->event_reader_pos = 0;
371 qemu_rbd_complete_aio(s->event_rcb);
372 s->qemu_aio_count--;
376 } while (ret < 0 && errno == EINTR);
379 static int qemu_rbd_aio_flush_cb(void *opaque)
381 BDRVRBDState *s = opaque;
383 return (s->qemu_aio_count > 0);
386 static int qemu_rbd_open(BlockDriverState *bs, const char *filename, int flags)
388 BDRVRBDState *s = bs->opaque;
389 char pool[RBD_MAX_POOL_NAME_SIZE];
390 char snap_buf[RBD_MAX_SNAP_NAME_SIZE];
391 char conf[RBD_MAX_CONF_SIZE];
392 int r;
394 if (qemu_rbd_parsename(filename, pool, sizeof(pool),
395 snap_buf, sizeof(snap_buf),
396 s->name, sizeof(s->name),
397 conf, sizeof(conf)) < 0) {
398 return -EINVAL;
400 s->snap = NULL;
401 if (snap_buf[0] != '\0') {
402 s->snap = qemu_strdup(snap_buf);
405 r = rados_create(&s->cluster, NULL);
406 if (r < 0) {
407 error_report("error initializing");
408 return r;
411 if (strstr(conf, "conf=") == NULL) {
412 r = rados_conf_read_file(s->cluster, NULL);
413 if (r < 0) {
414 error_report("error reading config file");
415 rados_shutdown(s->cluster);
416 return r;
420 if (conf[0] != '\0') {
421 r = qemu_rbd_set_conf(s->cluster, conf);
422 if (r < 0) {
423 error_report("error setting config options");
424 rados_shutdown(s->cluster);
425 return r;
429 r = rados_connect(s->cluster);
430 if (r < 0) {
431 error_report("error connecting");
432 rados_shutdown(s->cluster);
433 return r;
436 r = rados_ioctx_create(s->cluster, pool, &s->io_ctx);
437 if (r < 0) {
438 error_report("error opening pool %s", pool);
439 rados_shutdown(s->cluster);
440 return r;
443 r = rbd_open(s->io_ctx, s->name, &s->image, s->snap);
444 if (r < 0) {
445 error_report("error reading header from %s", s->name);
446 rados_ioctx_destroy(s->io_ctx);
447 rados_shutdown(s->cluster);
448 return r;
451 bs->read_only = (s->snap != NULL);
453 s->event_reader_pos = 0;
454 r = qemu_pipe(s->fds);
455 if (r < 0) {
456 error_report("error opening eventfd");
457 goto failed;
459 fcntl(s->fds[0], F_SETFL, O_NONBLOCK);
460 fcntl(s->fds[1], F_SETFL, O_NONBLOCK);
461 qemu_aio_set_fd_handler(s->fds[RBD_FD_READ], qemu_rbd_aio_event_reader,
462 NULL, qemu_rbd_aio_flush_cb, NULL, s);
465 return 0;
467 failed:
468 rbd_close(s->image);
469 rados_ioctx_destroy(s->io_ctx);
470 rados_shutdown(s->cluster);
471 return r;
474 static void qemu_rbd_close(BlockDriverState *bs)
476 BDRVRBDState *s = bs->opaque;
478 close(s->fds[0]);
479 close(s->fds[1]);
480 qemu_aio_set_fd_handler(s->fds[RBD_FD_READ], NULL , NULL, NULL, NULL,
481 NULL);
483 rbd_close(s->image);
484 rados_ioctx_destroy(s->io_ctx);
485 qemu_free(s->snap);
486 rados_shutdown(s->cluster);
490 * Cancel aio. Since we don't reference acb in a non qemu threads,
491 * it is safe to access it here.
493 static void qemu_rbd_aio_cancel(BlockDriverAIOCB *blockacb)
495 RBDAIOCB *acb = (RBDAIOCB *) blockacb;
496 acb->cancelled = 1;
499 static AIOPool rbd_aio_pool = {
500 .aiocb_size = sizeof(RBDAIOCB),
501 .cancel = qemu_rbd_aio_cancel,
504 static int qemu_rbd_send_pipe(BDRVRBDState *s, RADOSCB *rcb)
506 int ret = 0;
507 while (1) {
508 fd_set wfd;
509 int fd = s->fds[RBD_FD_WRITE];
511 /* send the op pointer to the qemu thread that is responsible
512 for the aio/op completion. Must do it in a qemu thread context */
513 ret = write(fd, (void *)&rcb, sizeof(rcb));
514 if (ret >= 0) {
515 break;
517 if (errno == EINTR) {
518 continue;
520 if (errno != EAGAIN) {
521 break;
524 FD_ZERO(&wfd);
525 FD_SET(fd, &wfd);
526 do {
527 ret = select(fd + 1, NULL, &wfd, NULL, NULL);
528 } while (ret < 0 && errno == EINTR);
531 return ret;
535 * This is the callback function for rbd_aio_read and _write
537 * Note: this function is being called from a non qemu thread so
538 * we need to be careful about what we do here. Generally we only
539 * write to the block notification pipe, and do the rest of the
540 * io completion handling from qemu_rbd_aio_event_reader() which
541 * runs in a qemu context.
543 static void rbd_finish_aiocb(rbd_completion_t c, RADOSCB *rcb)
545 int ret;
546 rcb->ret = rbd_aio_get_return_value(c);
547 rbd_aio_release(c);
548 ret = qemu_rbd_send_pipe(rcb->s, rcb);
549 if (ret < 0) {
550 error_report("failed writing to acb->s->fds");
551 qemu_free(rcb);
555 /* Callback when all queued rbd_aio requests are complete */
557 static void rbd_aio_bh_cb(void *opaque)
559 RBDAIOCB *acb = opaque;
561 if (!acb->write) {
562 qemu_iovec_from_buffer(acb->qiov, acb->bounce, acb->qiov->size);
564 qemu_vfree(acb->bounce);
565 acb->common.cb(acb->common.opaque, (acb->ret > 0 ? 0 : acb->ret));
566 qemu_bh_delete(acb->bh);
567 acb->bh = NULL;
569 qemu_aio_release(acb);
572 static BlockDriverAIOCB *rbd_aio_rw_vector(BlockDriverState *bs,
573 int64_t sector_num,
574 QEMUIOVector *qiov,
575 int nb_sectors,
576 BlockDriverCompletionFunc *cb,
577 void *opaque, int write)
579 RBDAIOCB *acb;
580 RADOSCB *rcb;
581 rbd_completion_t c;
582 int64_t off, size;
583 char *buf;
584 int r;
586 BDRVRBDState *s = bs->opaque;
588 acb = qemu_aio_get(&rbd_aio_pool, bs, cb, opaque);
589 if (!acb) {
590 return NULL;
592 acb->write = write;
593 acb->qiov = qiov;
594 acb->bounce = qemu_blockalign(bs, qiov->size);
595 acb->ret = 0;
596 acb->error = 0;
597 acb->s = s;
598 acb->cancelled = 0;
599 acb->bh = NULL;
601 if (write) {
602 qemu_iovec_to_buffer(acb->qiov, acb->bounce);
605 buf = acb->bounce;
607 off = sector_num * BDRV_SECTOR_SIZE;
608 size = nb_sectors * BDRV_SECTOR_SIZE;
610 s->qemu_aio_count++; /* All the RADOSCB */
612 rcb = qemu_malloc(sizeof(RADOSCB));
613 rcb->done = 0;
614 rcb->acb = acb;
615 rcb->buf = buf;
616 rcb->s = acb->s;
617 rcb->size = size;
618 r = rbd_aio_create_completion(rcb, (rbd_callback_t) rbd_finish_aiocb, &c);
619 if (r < 0) {
620 goto failed;
623 if (write) {
624 r = rbd_aio_write(s->image, off, size, buf, c);
625 } else {
626 r = rbd_aio_read(s->image, off, size, buf, c);
629 if (r < 0) {
630 goto failed;
633 return &acb->common;
635 failed:
636 qemu_free(rcb);
637 s->qemu_aio_count--;
638 qemu_aio_release(acb);
639 return NULL;
642 static BlockDriverAIOCB *qemu_rbd_aio_readv(BlockDriverState *bs,
643 int64_t sector_num,
644 QEMUIOVector *qiov,
645 int nb_sectors,
646 BlockDriverCompletionFunc *cb,
647 void *opaque)
649 return rbd_aio_rw_vector(bs, sector_num, qiov, nb_sectors, cb, opaque, 0);
652 static BlockDriverAIOCB *qemu_rbd_aio_writev(BlockDriverState *bs,
653 int64_t sector_num,
654 QEMUIOVector *qiov,
655 int nb_sectors,
656 BlockDriverCompletionFunc *cb,
657 void *opaque)
659 return rbd_aio_rw_vector(bs, sector_num, qiov, nb_sectors, cb, opaque, 1);
662 static int qemu_rbd_getinfo(BlockDriverState *bs, BlockDriverInfo *bdi)
664 BDRVRBDState *s = bs->opaque;
665 rbd_image_info_t info;
666 int r;
668 r = rbd_stat(s->image, &info, sizeof(info));
669 if (r < 0) {
670 return r;
673 bdi->cluster_size = info.obj_size;
674 return 0;
677 static int64_t qemu_rbd_getlength(BlockDriverState *bs)
679 BDRVRBDState *s = bs->opaque;
680 rbd_image_info_t info;
681 int r;
683 r = rbd_stat(s->image, &info, sizeof(info));
684 if (r < 0) {
685 return r;
688 return info.size;
691 static int qemu_rbd_truncate(BlockDriverState *bs, int64_t offset)
693 BDRVRBDState *s = bs->opaque;
694 int r;
696 r = rbd_resize(s->image, offset);
697 if (r < 0) {
698 return r;
701 return 0;
704 static int qemu_rbd_snap_create(BlockDriverState *bs,
705 QEMUSnapshotInfo *sn_info)
707 BDRVRBDState *s = bs->opaque;
708 int r;
710 if (sn_info->name[0] == '\0') {
711 return -EINVAL; /* we need a name for rbd snapshots */
715 * rbd snapshots are using the name as the user controlled unique identifier
716 * we can't use the rbd snapid for that purpose, as it can't be set
718 if (sn_info->id_str[0] != '\0' &&
719 strcmp(sn_info->id_str, sn_info->name) != 0) {
720 return -EINVAL;
723 if (strlen(sn_info->name) >= sizeof(sn_info->id_str)) {
724 return -ERANGE;
727 r = rbd_snap_create(s->image, sn_info->name);
728 if (r < 0) {
729 error_report("failed to create snap: %s", strerror(-r));
730 return r;
733 return 0;
736 static int qemu_rbd_snap_list(BlockDriverState *bs,
737 QEMUSnapshotInfo **psn_tab)
739 BDRVRBDState *s = bs->opaque;
740 QEMUSnapshotInfo *sn_info, *sn_tab = NULL;
741 int i, snap_count;
742 rbd_snap_info_t *snaps;
743 int max_snaps = RBD_MAX_SNAPS;
745 do {
746 snaps = qemu_malloc(sizeof(*snaps) * max_snaps);
747 snap_count = rbd_snap_list(s->image, snaps, &max_snaps);
748 if (snap_count < 0) {
749 qemu_free(snaps);
751 } while (snap_count == -ERANGE);
753 if (snap_count <= 0) {
754 return snap_count;
757 sn_tab = qemu_mallocz(snap_count * sizeof(QEMUSnapshotInfo));
759 for (i = 0; i < snap_count; i++) {
760 const char *snap_name = snaps[i].name;
762 sn_info = sn_tab + i;
763 pstrcpy(sn_info->id_str, sizeof(sn_info->id_str), snap_name);
764 pstrcpy(sn_info->name, sizeof(sn_info->name), snap_name);
766 sn_info->vm_state_size = snaps[i].size;
767 sn_info->date_sec = 0;
768 sn_info->date_nsec = 0;
769 sn_info->vm_clock_nsec = 0;
771 rbd_snap_list_end(snaps);
773 *psn_tab = sn_tab;
774 return snap_count;
777 static QEMUOptionParameter qemu_rbd_create_options[] = {
779 .name = BLOCK_OPT_SIZE,
780 .type = OPT_SIZE,
781 .help = "Virtual disk size"
784 .name = BLOCK_OPT_CLUSTER_SIZE,
785 .type = OPT_SIZE,
786 .help = "RBD object size"
788 {NULL}
791 static BlockDriver bdrv_rbd = {
792 .format_name = "rbd",
793 .instance_size = sizeof(BDRVRBDState),
794 .bdrv_file_open = qemu_rbd_open,
795 .bdrv_close = qemu_rbd_close,
796 .bdrv_create = qemu_rbd_create,
797 .bdrv_get_info = qemu_rbd_getinfo,
798 .create_options = qemu_rbd_create_options,
799 .bdrv_getlength = qemu_rbd_getlength,
800 .bdrv_truncate = qemu_rbd_truncate,
801 .protocol_name = "rbd",
803 .bdrv_aio_readv = qemu_rbd_aio_readv,
804 .bdrv_aio_writev = qemu_rbd_aio_writev,
806 .bdrv_snapshot_create = qemu_rbd_snap_create,
807 .bdrv_snapshot_list = qemu_rbd_snap_list,
810 static void bdrv_rbd_init(void)
812 bdrv_register(&bdrv_rbd);
815 block_init(bdrv_rbd_init);