2 * Copyright (C) 2009-2010 Nippon Telegraph and Telephone Corporation.
4 * This program is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU General Public License version
6 * 2 as published by the Free Software Foundation.
8 * You should have received a copy of the GNU General Public License
9 * along with this program. If not, see <http://www.gnu.org/licenses/>.
11 * Contributions after 2012-01-13 are licensed under the terms of the
12 * GNU GPL, version 2 or (at your option) any later version.
15 #include "qemu/osdep.h"
16 #include "qapi/error.h"
17 #include "qapi/qapi-visit-sockets.h"
18 #include "qapi/qapi-visit-block-core.h"
19 #include "qapi/qmp/qdict.h"
20 #include "qapi/qobject-input-visitor.h"
21 #include "qapi/qobject-output-visitor.h"
23 #include "qemu/error-report.h"
24 #include "qemu/option.h"
25 #include "qemu/sockets.h"
26 #include "block/block_int.h"
27 #include "sysemu/block-backend.h"
28 #include "qemu/bitops.h"
29 #include "qemu/cutils.h"
31 #define SD_PROTO_VER 0x01
33 #define SD_DEFAULT_ADDR "localhost"
34 #define SD_DEFAULT_PORT 7000
36 #define SD_OP_CREATE_AND_WRITE_OBJ 0x01
37 #define SD_OP_READ_OBJ 0x02
38 #define SD_OP_WRITE_OBJ 0x03
39 /* 0x04 is used internally by Sheepdog */
41 #define SD_OP_NEW_VDI 0x11
42 #define SD_OP_LOCK_VDI 0x12
43 #define SD_OP_RELEASE_VDI 0x13
44 #define SD_OP_GET_VDI_INFO 0x14
45 #define SD_OP_READ_VDIS 0x15
46 #define SD_OP_FLUSH_VDI 0x16
47 #define SD_OP_DEL_VDI 0x17
48 #define SD_OP_GET_CLUSTER_DEFAULT 0x18
50 #define SD_FLAG_CMD_WRITE 0x01
51 #define SD_FLAG_CMD_COW 0x02
52 #define SD_FLAG_CMD_CACHE 0x04 /* Writeback mode for cache */
53 #define SD_FLAG_CMD_DIRECT 0x08 /* Don't use cache */
55 #define SD_RES_SUCCESS 0x00 /* Success */
56 #define SD_RES_UNKNOWN 0x01 /* Unknown error */
57 #define SD_RES_NO_OBJ 0x02 /* No object found */
58 #define SD_RES_EIO 0x03 /* I/O error */
59 #define SD_RES_VDI_EXIST 0x04 /* Vdi exists already */
60 #define SD_RES_INVALID_PARMS 0x05 /* Invalid parameters */
61 #define SD_RES_SYSTEM_ERROR 0x06 /* System error */
62 #define SD_RES_VDI_LOCKED 0x07 /* Vdi is locked */
63 #define SD_RES_NO_VDI 0x08 /* No vdi found */
64 #define SD_RES_NO_BASE_VDI 0x09 /* No base vdi found */
65 #define SD_RES_VDI_READ 0x0A /* Cannot read requested vdi */
66 #define SD_RES_VDI_WRITE 0x0B /* Cannot write requested vdi */
67 #define SD_RES_BASE_VDI_READ 0x0C /* Cannot read base vdi */
68 #define SD_RES_BASE_VDI_WRITE 0x0D /* Cannot write base vdi */
69 #define SD_RES_NO_TAG 0x0E /* Requested tag is not found */
70 #define SD_RES_STARTUP 0x0F /* Sheepdog is on starting up */
71 #define SD_RES_VDI_NOT_LOCKED 0x10 /* Vdi is not locked */
72 #define SD_RES_SHUTDOWN 0x11 /* Sheepdog is shutting down */
73 #define SD_RES_NO_MEM 0x12 /* Cannot allocate memory */
74 #define SD_RES_FULL_VDI 0x13 /* we already have the maximum vdis */
75 #define SD_RES_VER_MISMATCH 0x14 /* Protocol version mismatch */
76 #define SD_RES_NO_SPACE 0x15 /* Server has no room for new objects */
77 #define SD_RES_WAIT_FOR_FORMAT 0x16 /* Waiting for a format operation */
78 #define SD_RES_WAIT_FOR_JOIN 0x17 /* Waiting for other nodes joining */
79 #define SD_RES_JOIN_FAILED 0x18 /* Target node had failed to join sheepdog */
80 #define SD_RES_HALT 0x19 /* Sheepdog is stopped serving IO request */
81 #define SD_RES_READONLY 0x1A /* Object is read-only */
86 * 0 - 19 (20 bits): data object space
87 * 20 - 31 (12 bits): reserved data object space
88 * 32 - 55 (24 bits): vdi object space
89 * 56 - 59 ( 4 bits): reserved vdi object space
90 * 60 - 63 ( 4 bits): object type identifier space
93 #define VDI_SPACE_SHIFT 32
94 #define VDI_BIT (UINT64_C(1) << 63)
95 #define VMSTATE_BIT (UINT64_C(1) << 62)
96 #define MAX_DATA_OBJS (UINT64_C(1) << 20)
97 #define MAX_CHILDREN 1024
98 #define SD_MAX_VDI_LEN 256
99 #define SD_MAX_VDI_TAG_LEN 256
100 #define SD_NR_VDIS (1U << 24)
101 #define SD_DATA_OBJ_SIZE (UINT64_C(1) << 22)
102 #define SD_MAX_VDI_SIZE (SD_DATA_OBJ_SIZE * MAX_DATA_OBJS)
103 #define SD_DEFAULT_BLOCK_SIZE_SHIFT 22
105 * For erasure coding, we use at most SD_EC_MAX_STRIP for data strips and
106 * (SD_EC_MAX_STRIP - 1) for parity strips
108 * SD_MAX_COPIES is sum of number of data strips and parity strips.
110 #define SD_EC_MAX_STRIP 16
111 #define SD_MAX_COPIES (SD_EC_MAX_STRIP * 2 - 1)
113 #define SD_INODE_SIZE (sizeof(SheepdogInode))
114 #define CURRENT_VDI_ID 0
116 #define LOCK_TYPE_NORMAL 0
117 #define LOCK_TYPE_SHARED 1 /* for iSCSI multipath */
119 typedef struct SheepdogReq {
125 uint32_t data_length;
126 uint32_t opcode_specific[8];
129 typedef struct SheepdogRsp {
135 uint32_t data_length;
137 uint32_t opcode_specific[7];
140 typedef struct SheepdogObjReq {
146 uint32_t data_length;
155 typedef struct SheepdogObjRsp {
161 uint32_t data_length;
169 typedef struct SheepdogVdiReq {
175 uint32_t data_length;
177 uint32_t base_vdi_id;
180 uint8_t store_policy;
181 uint8_t block_size_shift;
187 typedef struct SheepdogVdiRsp {
193 uint32_t data_length;
200 typedef struct SheepdogClusterRsp {
206 uint32_t data_length;
210 uint8_t block_size_shift;
213 } SheepdogClusterRsp;
215 typedef struct SheepdogInode {
216 char name[SD_MAX_VDI_LEN];
217 char tag[SD_MAX_VDI_TAG_LEN];
220 uint64_t vm_clock_nsec;
222 uint64_t vm_state_size;
223 uint16_t copy_policy;
225 uint8_t block_size_shift;
228 uint32_t parent_vdi_id;
229 uint32_t child_vdi_id[MAX_CHILDREN];
230 uint32_t data_vdi_id[MAX_DATA_OBJS];
233 #define SD_INODE_HEADER_SIZE offsetof(SheepdogInode, data_vdi_id)
236 * 64 bit FNV-1a non-zero initial basis
238 #define FNV1A_64_INIT ((uint64_t)0xcbf29ce484222325ULL)
241 * 64 bit Fowler/Noll/Vo FNV-1a hash code
243 static inline uint64_t fnv_64a_buf(void *buf, size_t len, uint64_t hval)
245 unsigned char *bp = buf;
246 unsigned char *be = bp + len;
248 hval ^= (uint64_t) *bp++;
249 hval += (hval << 1) + (hval << 4) + (hval << 5) +
250 (hval << 7) + (hval << 8) + (hval << 40);
255 static inline bool is_data_obj_writable(SheepdogInode *inode, unsigned int idx)
257 return inode->vdi_id == inode->data_vdi_id[idx];
260 static inline bool is_data_obj(uint64_t oid)
262 return !(VDI_BIT & oid);
265 static inline uint64_t data_oid_to_idx(uint64_t oid)
267 return oid & (MAX_DATA_OBJS - 1);
270 static inline uint32_t oid_to_vid(uint64_t oid)
272 return (oid & ~VDI_BIT) >> VDI_SPACE_SHIFT;
275 static inline uint64_t vid_to_vdi_oid(uint32_t vid)
277 return VDI_BIT | ((uint64_t)vid << VDI_SPACE_SHIFT);
280 static inline uint64_t vid_to_vmstate_oid(uint32_t vid, uint32_t idx)
282 return VMSTATE_BIT | ((uint64_t)vid << VDI_SPACE_SHIFT) | idx;
285 static inline uint64_t vid_to_data_oid(uint32_t vid, uint32_t idx)
287 return ((uint64_t)vid << VDI_SPACE_SHIFT) | idx;
290 static inline bool is_snapshot(struct SheepdogInode *inode)
292 return !!inode->snap_ctime;
295 static inline size_t count_data_objs(const struct SheepdogInode *inode)
297 return DIV_ROUND_UP(inode->vdi_size,
298 (1UL << inode->block_size_shift));
303 #define DEBUG_SDOG_PRINT 1
305 #define DEBUG_SDOG_PRINT 0
307 #define DPRINTF(fmt, args...) \
309 if (DEBUG_SDOG_PRINT) { \
310 fprintf(stderr, "%s %d: " fmt, __func__, __LINE__, ##args); \
314 typedef struct SheepdogAIOCB SheepdogAIOCB;
315 typedef struct BDRVSheepdogState BDRVSheepdogState;
317 typedef struct AIOReq {
318 SheepdogAIOCB *aiocb;
319 unsigned int iov_offset;
324 unsigned int data_len;
329 QLIST_ENTRY(AIOReq) aio_siblings;
339 #define AIOCBOverlapping(x, y) \
340 (!(x->max_affect_data_idx < y->min_affect_data_idx \
341 || y->max_affect_data_idx < x->min_affect_data_idx))
343 struct SheepdogAIOCB {
344 BDRVSheepdogState *s;
352 enum AIOCBState aiocb_type;
354 Coroutine *coroutine;
357 uint32_t min_affect_data_idx;
358 uint32_t max_affect_data_idx;
361 * The difference between affect_data_idx and dirty_data_idx:
362 * affect_data_idx represents range of index of all request types.
363 * dirty_data_idx represents range of index updated by COW requests.
364 * dirty_data_idx is used for updating an inode object.
366 uint32_t min_dirty_data_idx;
367 uint32_t max_dirty_data_idx;
369 QLIST_ENTRY(SheepdogAIOCB) aiocb_siblings;
372 struct BDRVSheepdogState {
373 BlockDriverState *bs;
374 AioContext *aio_context;
378 char name[SD_MAX_VDI_LEN];
380 uint32_t cache_flags;
381 bool discard_supported;
390 uint32_t aioreq_seq_num;
392 /* Every aio request must be linked to either of these queues. */
393 QLIST_HEAD(inflight_aio_head, AIOReq) inflight_aio_head;
394 QLIST_HEAD(failed_aio_head, AIOReq) failed_aio_head;
397 CoQueue overlapping_queue;
398 QLIST_HEAD(inflight_aiocb_head, SheepdogAIOCB) inflight_aiocb_head;
401 typedef struct BDRVSheepdogReopenState {
404 } BDRVSheepdogReopenState;
406 static const char *sd_strerror(int err)
410 static const struct {
414 {SD_RES_SUCCESS, "Success"},
415 {SD_RES_UNKNOWN, "Unknown error"},
416 {SD_RES_NO_OBJ, "No object found"},
417 {SD_RES_EIO, "I/O error"},
418 {SD_RES_VDI_EXIST, "VDI exists already"},
419 {SD_RES_INVALID_PARMS, "Invalid parameters"},
420 {SD_RES_SYSTEM_ERROR, "System error"},
421 {SD_RES_VDI_LOCKED, "VDI is already locked"},
422 {SD_RES_NO_VDI, "No vdi found"},
423 {SD_RES_NO_BASE_VDI, "No base VDI found"},
424 {SD_RES_VDI_READ, "Failed read the requested VDI"},
425 {SD_RES_VDI_WRITE, "Failed to write the requested VDI"},
426 {SD_RES_BASE_VDI_READ, "Failed to read the base VDI"},
427 {SD_RES_BASE_VDI_WRITE, "Failed to write the base VDI"},
428 {SD_RES_NO_TAG, "Failed to find the requested tag"},
429 {SD_RES_STARTUP, "The system is still booting"},
430 {SD_RES_VDI_NOT_LOCKED, "VDI isn't locked"},
431 {SD_RES_SHUTDOWN, "The system is shutting down"},
432 {SD_RES_NO_MEM, "Out of memory on the server"},
433 {SD_RES_FULL_VDI, "We already have the maximum vdis"},
434 {SD_RES_VER_MISMATCH, "Protocol version mismatch"},
435 {SD_RES_NO_SPACE, "Server has no space for new objects"},
436 {SD_RES_WAIT_FOR_FORMAT, "Sheepdog is waiting for a format operation"},
437 {SD_RES_WAIT_FOR_JOIN, "Sheepdog is waiting for other nodes joining"},
438 {SD_RES_JOIN_FAILED, "Target node had failed to join sheepdog"},
439 {SD_RES_HALT, "Sheepdog is stopped serving IO request"},
440 {SD_RES_READONLY, "Object is read-only"},
443 for (i = 0; i < ARRAY_SIZE(errors); ++i) {
444 if (errors[i].err == err) {
445 return errors[i].desc;
449 return "Invalid error code";
453 * Sheepdog I/O handling:
455 * 1. In sd_co_rw_vector, we send the I/O requests to the server and
456 * link the requests to the inflight_list in the
457 * BDRVSheepdogState. The function yields while waiting for
458 * receiving the response.
460 * 2. We receive the response in aio_read_response, the fd handler to
461 * the sheepdog connection. We switch back to sd_co_readv/sd_writev
462 * after all the requests belonging to the AIOCB are finished. If
463 * needed, sd_co_writev will send another requests for the vdi object.
466 static inline AIOReq *alloc_aio_req(BDRVSheepdogState *s, SheepdogAIOCB *acb,
467 uint64_t oid, unsigned int data_len,
468 uint64_t offset, uint8_t flags, bool create,
469 uint64_t base_oid, unsigned int iov_offset)
473 aio_req = g_malloc(sizeof(*aio_req));
474 aio_req->aiocb = acb;
475 aio_req->iov_offset = iov_offset;
477 aio_req->base_oid = base_oid;
478 aio_req->offset = offset;
479 aio_req->data_len = data_len;
480 aio_req->flags = flags;
481 aio_req->id = s->aioreq_seq_num++;
482 aio_req->create = create;
488 static void wait_for_overlapping_aiocb(BDRVSheepdogState *s, SheepdogAIOCB *acb)
493 QLIST_FOREACH(cb, &s->inflight_aiocb_head, aiocb_siblings) {
494 if (AIOCBOverlapping(acb, cb)) {
495 qemu_co_queue_wait(&s->overlapping_queue, &s->queue_lock);
501 static void sd_aio_setup(SheepdogAIOCB *acb, BDRVSheepdogState *s,
502 QEMUIOVector *qiov, int64_t sector_num, int nb_sectors,
505 uint32_t object_size;
507 object_size = (UINT32_C(1) << s->inode.block_size_shift);
513 acb->sector_num = sector_num;
514 acb->nb_sectors = nb_sectors;
516 acb->coroutine = qemu_coroutine_self();
520 acb->min_affect_data_idx = acb->sector_num * BDRV_SECTOR_SIZE / object_size;
521 acb->max_affect_data_idx = (acb->sector_num * BDRV_SECTOR_SIZE +
522 acb->nb_sectors * BDRV_SECTOR_SIZE) / object_size;
524 acb->min_dirty_data_idx = UINT32_MAX;
525 acb->max_dirty_data_idx = 0;
526 acb->aiocb_type = type;
528 if (type == AIOCB_FLUSH_CACHE) {
532 qemu_co_mutex_lock(&s->queue_lock);
533 wait_for_overlapping_aiocb(s, acb);
534 QLIST_INSERT_HEAD(&s->inflight_aiocb_head, acb, aiocb_siblings);
535 qemu_co_mutex_unlock(&s->queue_lock);
538 static SocketAddress *sd_server_config(QDict *options, Error **errp)
540 QDict *server = NULL;
541 QObject *crumpled_server = NULL;
543 SocketAddress *saddr = NULL;
544 Error *local_err = NULL;
546 qdict_extract_subqdict(options, &server, "server.");
548 crumpled_server = qdict_crumple(server, errp);
549 if (!crumpled_server) {
554 * FIXME .numeric, .to, .ipv4 or .ipv6 don't work with -drive
555 * server.type=inet. .to doesn't matter, it's ignored anyway.
556 * That's because when @options come from -blockdev or
557 * blockdev_add, members are typed according to the QAPI schema,
558 * but when they come from -drive, they're all QString. The
559 * visitor expects the former.
561 iv = qobject_input_visitor_new(crumpled_server);
562 visit_type_SocketAddress(iv, NULL, &saddr, &local_err);
564 error_propagate(errp, local_err);
570 qobject_unref(crumpled_server);
571 qobject_unref(server);
575 /* Return -EIO in case of error, file descriptor on success */
576 static int connect_to_sdog(BDRVSheepdogState *s, Error **errp)
580 fd = socket_connect(s->addr, errp);
582 if (s->addr->type == SOCKET_ADDRESS_TYPE_INET && fd >= 0) {
583 int ret = socket_set_nodelay(fd);
585 error_report("%s", strerror(errno));
590 qemu_set_nonblock(fd);
598 /* Return 0 on success and -errno in case of error */
599 static coroutine_fn int send_co_req(int sockfd, SheepdogReq *hdr, void *data,
604 ret = qemu_co_send(sockfd, hdr, sizeof(*hdr));
605 if (ret != sizeof(*hdr)) {
606 error_report("failed to send a req, %s", strerror(errno));
610 ret = qemu_co_send(sockfd, data, *wlen);
612 error_report("failed to send a req, %s", strerror(errno));
619 typedef struct SheepdogReqCo {
621 BlockDriverState *bs;
622 AioContext *aio_context;
632 static void restart_co_req(void *opaque)
634 SheepdogReqCo *srco = opaque;
636 aio_co_wake(srco->co);
639 static coroutine_fn void do_co_req(void *opaque)
642 SheepdogReqCo *srco = opaque;
643 int sockfd = srco->sockfd;
644 SheepdogReq *hdr = srco->hdr;
645 void *data = srco->data;
646 unsigned int *wlen = srco->wlen;
647 unsigned int *rlen = srco->rlen;
649 srco->co = qemu_coroutine_self();
650 aio_set_fd_handler(srco->aio_context, sockfd, false,
651 NULL, restart_co_req, NULL, srco);
653 ret = send_co_req(sockfd, hdr, data, wlen);
658 aio_set_fd_handler(srco->aio_context, sockfd, false,
659 restart_co_req, NULL, NULL, srco);
661 ret = qemu_co_recv(sockfd, hdr, sizeof(*hdr));
662 if (ret != sizeof(*hdr)) {
663 error_report("failed to get a rsp, %s", strerror(errno));
668 if (*rlen > hdr->data_length) {
669 *rlen = hdr->data_length;
673 ret = qemu_co_recv(sockfd, data, *rlen);
675 error_report("failed to get the data, %s", strerror(errno));
682 /* there is at most one request for this sockfd, so it is safe to
683 * set each handler to NULL. */
684 aio_set_fd_handler(srco->aio_context, sockfd, false,
685 NULL, NULL, NULL, NULL);
689 /* Set srco->finished before reading bs->wakeup. */
690 atomic_mb_set(&srco->finished, true);
692 bdrv_wakeup(srco->bs);
697 * Send the request to the sheep in a synchronous manner.
699 * Return 0 on success, -errno in case of error.
701 static int do_req(int sockfd, BlockDriverState *bs, SheepdogReq *hdr,
702 void *data, unsigned int *wlen, unsigned int *rlen)
705 SheepdogReqCo srco = {
707 .aio_context = bs ? bdrv_get_aio_context(bs) : qemu_get_aio_context(),
717 if (qemu_in_coroutine()) {
720 co = qemu_coroutine_create(do_co_req, &srco);
722 bdrv_coroutine_enter(bs, co);
723 BDRV_POLL_WHILE(bs, !srco.finished);
725 qemu_coroutine_enter(co);
726 while (!srco.finished) {
727 aio_poll(qemu_get_aio_context(), true);
735 static void coroutine_fn add_aio_request(BDRVSheepdogState *s, AIOReq *aio_req,
736 struct iovec *iov, int niov,
737 enum AIOCBState aiocb_type);
738 static void coroutine_fn resend_aioreq(BDRVSheepdogState *s, AIOReq *aio_req);
739 static int reload_inode(BDRVSheepdogState *s, uint32_t snapid, const char *tag);
740 static int get_sheep_fd(BDRVSheepdogState *s, Error **errp);
741 static void co_write_request(void *opaque);
743 static coroutine_fn void reconnect_to_sdog(void *opaque)
745 BDRVSheepdogState *s = opaque;
746 AIOReq *aio_req, *next;
748 aio_set_fd_handler(s->aio_context, s->fd, false, NULL,
753 /* Wait for outstanding write requests to be completed. */
754 while (s->co_send != NULL) {
755 co_write_request(opaque);
758 /* Try to reconnect the sheepdog server every one second. */
760 Error *local_err = NULL;
761 s->fd = get_sheep_fd(s, &local_err);
763 DPRINTF("Wait for connection to be established\n");
764 error_report_err(local_err);
765 qemu_co_sleep_ns(QEMU_CLOCK_REALTIME, 1000000000ULL);
770 * Now we have to resend all the request in the inflight queue. However,
771 * resend_aioreq() can yield and newly created requests can be added to the
772 * inflight queue before the coroutine is resumed. To avoid mixing them, we
773 * have to move all the inflight requests to the failed queue before
774 * resend_aioreq() is called.
776 qemu_co_mutex_lock(&s->queue_lock);
777 QLIST_FOREACH_SAFE(aio_req, &s->inflight_aio_head, aio_siblings, next) {
778 QLIST_REMOVE(aio_req, aio_siblings);
779 QLIST_INSERT_HEAD(&s->failed_aio_head, aio_req, aio_siblings);
782 /* Resend all the failed aio requests. */
783 while (!QLIST_EMPTY(&s->failed_aio_head)) {
784 aio_req = QLIST_FIRST(&s->failed_aio_head);
785 QLIST_REMOVE(aio_req, aio_siblings);
786 qemu_co_mutex_unlock(&s->queue_lock);
787 resend_aioreq(s, aio_req);
788 qemu_co_mutex_lock(&s->queue_lock);
790 qemu_co_mutex_unlock(&s->queue_lock);
794 * Receive responses of the I/O requests.
796 * This function is registered as a fd handler, and called from the
797 * main loop when s->fd is ready for reading responses.
799 static void coroutine_fn aio_read_response(void *opaque)
802 BDRVSheepdogState *s = opaque;
805 AIOReq *aio_req = NULL;
810 ret = qemu_co_recv(fd, &rsp, sizeof(rsp));
811 if (ret != sizeof(rsp)) {
812 error_report("failed to get the header, %s", strerror(errno));
816 /* find the right aio_req from the inflight aio list */
817 QLIST_FOREACH(aio_req, &s->inflight_aio_head, aio_siblings) {
818 if (aio_req->id == rsp.id) {
823 error_report("cannot find aio_req %x", rsp.id);
827 acb = aio_req->aiocb;
829 switch (acb->aiocb_type) {
830 case AIOCB_WRITE_UDATA:
831 if (!is_data_obj(aio_req->oid)) {
834 idx = data_oid_to_idx(aio_req->oid);
836 if (aio_req->create) {
838 * If the object is newly created one, we need to update
839 * the vdi object (metadata object). min_dirty_data_idx
840 * and max_dirty_data_idx are changed to include updated
841 * index between them.
843 if (rsp.result == SD_RES_SUCCESS) {
844 s->inode.data_vdi_id[idx] = s->inode.vdi_id;
845 acb->max_dirty_data_idx = MAX(idx, acb->max_dirty_data_idx);
846 acb->min_dirty_data_idx = MIN(idx, acb->min_dirty_data_idx);
850 case AIOCB_READ_UDATA:
851 ret = qemu_co_recvv(fd, acb->qiov->iov, acb->qiov->niov,
852 aio_req->iov_offset, rsp.data_length);
853 if (ret != rsp.data_length) {
854 error_report("failed to get the data, %s", strerror(errno));
858 case AIOCB_FLUSH_CACHE:
859 if (rsp.result == SD_RES_INVALID_PARMS) {
860 DPRINTF("disable cache since the server doesn't support it\n");
861 s->cache_flags = SD_FLAG_CMD_DIRECT;
862 rsp.result = SD_RES_SUCCESS;
865 case AIOCB_DISCARD_OBJ:
866 switch (rsp.result) {
867 case SD_RES_INVALID_PARMS:
868 error_report("server doesn't support discard command");
869 rsp.result = SD_RES_SUCCESS;
870 s->discard_supported = false;
877 /* No more data for this aio_req (reload_inode below uses its own file
878 * descriptor handler which doesn't use co_recv).
882 qemu_co_mutex_lock(&s->queue_lock);
883 QLIST_REMOVE(aio_req, aio_siblings);
884 qemu_co_mutex_unlock(&s->queue_lock);
886 switch (rsp.result) {
889 case SD_RES_READONLY:
890 if (s->inode.vdi_id == oid_to_vid(aio_req->oid)) {
891 ret = reload_inode(s, 0, "");
896 if (is_data_obj(aio_req->oid)) {
897 aio_req->oid = vid_to_data_oid(s->inode.vdi_id,
898 data_oid_to_idx(aio_req->oid));
900 aio_req->oid = vid_to_vdi_oid(s->inode.vdi_id);
902 resend_aioreq(s, aio_req);
906 error_report("%s", sd_strerror(rsp.result));
912 if (!--acb->nr_pending) {
914 * We've finished all requests which belong to the AIOCB, so
915 * we can switch back to sd_co_readv/writev now.
917 aio_co_wake(acb->coroutine);
923 reconnect_to_sdog(opaque);
926 static void co_read_response(void *opaque)
928 BDRVSheepdogState *s = opaque;
931 s->co_recv = qemu_coroutine_create(aio_read_response, opaque);
934 aio_co_enter(s->aio_context, s->co_recv);
937 static void co_write_request(void *opaque)
939 BDRVSheepdogState *s = opaque;
941 aio_co_wake(s->co_send);
945 * Return a socket descriptor to read/write objects.
947 * We cannot use this descriptor for other operations because
948 * the block driver may be on waiting response from the server.
950 static int get_sheep_fd(BDRVSheepdogState *s, Error **errp)
954 fd = connect_to_sdog(s, errp);
959 aio_set_fd_handler(s->aio_context, fd, false,
960 co_read_response, NULL, NULL, s);
965 * Parse numeric snapshot ID in @str
966 * If @str can't be parsed as number, return false.
967 * Else, if the number is zero or too large, set *@snapid to zero and
969 * Else, set *@snapid to the number and return true.
971 static bool sd_parse_snapid(const char *str, uint32_t *snapid)
976 ret = qemu_strtoul(str, NULL, 10, &ul);
977 if (ret == -ERANGE) {
983 if (ul > UINT32_MAX) {
991 static bool sd_parse_snapid_or_tag(const char *str,
992 uint32_t *snapid, char tag[])
994 if (!sd_parse_snapid(str, snapid)) {
996 if (g_strlcpy(tag, str, SD_MAX_VDI_TAG_LEN) >= SD_MAX_VDI_TAG_LEN) {
999 } else if (!*snapid) {
1008 const char *path; /* non-null iff transport is tcp */
1009 const char *host; /* valid when transport is tcp */
1010 int port; /* valid when transport is tcp */
1011 char vdi[SD_MAX_VDI_LEN];
1012 char tag[SD_MAX_VDI_TAG_LEN];
1014 /* Remainder is only for sd_config_done() */
1019 static void sd_config_done(SheepdogConfig *cfg)
1022 query_params_free(cfg->qp);
1027 static void sd_parse_uri(SheepdogConfig *cfg, const char *filename,
1031 QueryParams *qp = NULL;
1035 memset(cfg, 0, sizeof(*cfg));
1037 cfg->uri = uri = uri_parse(filename);
1039 error_setg(&err, "invalid URI '%s'", filename);
1044 if (!g_strcmp0(uri->scheme, "sheepdog")) {
1046 } else if (!g_strcmp0(uri->scheme, "sheepdog+tcp")) {
1048 } else if (!g_strcmp0(uri->scheme, "sheepdog+unix")) {
1051 error_setg(&err, "URI scheme must be 'sheepdog', 'sheepdog+tcp',"
1052 " or 'sheepdog+unix'");
1056 if (uri->path == NULL || !strcmp(uri->path, "/")) {
1057 error_setg(&err, "missing file path in URI");
1060 if (g_strlcpy(cfg->vdi, uri->path + 1, SD_MAX_VDI_LEN)
1061 >= SD_MAX_VDI_LEN) {
1062 error_setg(&err, "VDI name is too long");
1066 cfg->qp = qp = query_params_parse(uri->query);
1069 /* sheepdog+unix:///vdiname?socket=path */
1070 if (uri->server || uri->port) {
1071 error_setg(&err, "URI scheme %s doesn't accept a server address",
1077 "URI scheme %s requires query parameter 'socket'",
1081 if (qp->n != 1 || strcmp(qp->p[0].name, "socket")) {
1082 error_setg(&err, "unexpected query parameters");
1085 cfg->path = qp->p[0].value;
1087 /* sheepdog[+tcp]://[host:port]/vdiname */
1089 error_setg(&err, "unexpected query parameters");
1092 cfg->host = uri->server;
1093 cfg->port = uri->port;
1097 if (uri->fragment) {
1098 if (!sd_parse_snapid_or_tag(uri->fragment,
1099 &cfg->snap_id, cfg->tag)) {
1100 error_setg(&err, "'%s' is not a valid snapshot ID",
1105 cfg->snap_id = CURRENT_VDI_ID; /* search current vdi */
1110 error_propagate(errp, err);
1111 sd_config_done(cfg);
1116 * Parse a filename (old syntax)
1118 * filename must be one of the following formats:
1120 * 2. [vdiname]:[snapid]
1121 * 3. [vdiname]:[tag]
1122 * 4. [hostname]:[port]:[vdiname]
1123 * 5. [hostname]:[port]:[vdiname]:[snapid]
1124 * 6. [hostname]:[port]:[vdiname]:[tag]
1126 * You can boot from the snapshot images by specifying `snapid` or
1129 * You can run VMs outside the Sheepdog cluster by specifying
1130 * `hostname' and `port' (experimental).
1132 static void parse_vdiname(SheepdogConfig *cfg, const char *filename,
1137 const char *host_spec, *vdi_spec;
1140 strstart(filename, "sheepdog:", &filename);
1141 p = q = g_strdup(filename);
1143 /* count the number of separators */
1153 /* use the first two tokens as host_spec. */
1166 p = strchr(vdi_spec, ':');
1171 uri = g_strdup_printf("sheepdog://%s/%s", host_spec, vdi_spec);
1174 * FIXME We to escape URI meta-characters, e.g. "x?y=z"
1175 * produces "sheepdog://x?y=z". Because of that ...
1177 sd_parse_uri(cfg, uri, &err);
1180 * ... this can fail, but the error message is misleading.
1181 * Replace it by the traditional useless one until the
1182 * escaping is fixed.
1185 error_setg(errp, "Can't parse filename");
1192 static void sd_parse_filename(const char *filename, QDict *options,
1199 if (strstr(filename, "://")) {
1200 sd_parse_uri(&cfg, filename, &err);
1202 parse_vdiname(&cfg, filename, &err);
1205 error_propagate(errp, err);
1210 qdict_set_default_str(options, "server.path", cfg.path);
1211 qdict_set_default_str(options, "server.type", "unix");
1213 qdict_set_default_str(options, "server.type", "inet");
1214 qdict_set_default_str(options, "server.host",
1215 cfg.host ?: SD_DEFAULT_ADDR);
1216 snprintf(buf, sizeof(buf), "%d", cfg.port ?: SD_DEFAULT_PORT);
1217 qdict_set_default_str(options, "server.port", buf);
1219 qdict_set_default_str(options, "vdi", cfg.vdi);
1220 qdict_set_default_str(options, "tag", cfg.tag);
1222 snprintf(buf, sizeof(buf), "%d", cfg.snap_id);
1223 qdict_set_default_str(options, "snap-id", buf);
1226 sd_config_done(&cfg);
1229 static int find_vdi_name(BDRVSheepdogState *s, const char *filename,
1230 uint32_t snapid, const char *tag, uint32_t *vid,
1231 bool lock, Error **errp)
1235 SheepdogVdiRsp *rsp = (SheepdogVdiRsp *)&hdr;
1236 unsigned int wlen, rlen = 0;
1237 char buf[SD_MAX_VDI_LEN + SD_MAX_VDI_TAG_LEN];
1239 fd = connect_to_sdog(s, errp);
1244 /* This pair of strncpy calls ensures that the buffer is zero-filled,
1245 * which is desirable since we'll soon be sending those bytes, and
1246 * don't want the send_req to read uninitialized data.
1248 strncpy(buf, filename, SD_MAX_VDI_LEN);
1249 strncpy(buf + SD_MAX_VDI_LEN, tag, SD_MAX_VDI_TAG_LEN);
1251 memset(&hdr, 0, sizeof(hdr));
1253 hdr.opcode = SD_OP_LOCK_VDI;
1254 hdr.type = LOCK_TYPE_NORMAL;
1256 hdr.opcode = SD_OP_GET_VDI_INFO;
1258 wlen = SD_MAX_VDI_LEN + SD_MAX_VDI_TAG_LEN;
1259 hdr.proto_ver = SD_PROTO_VER;
1260 hdr.data_length = wlen;
1261 hdr.snapid = snapid;
1262 hdr.flags = SD_FLAG_CMD_WRITE;
1264 ret = do_req(fd, s->bs, (SheepdogReq *)&hdr, buf, &wlen, &rlen);
1266 error_setg_errno(errp, -ret, "cannot get vdi info");
1270 if (rsp->result != SD_RES_SUCCESS) {
1271 error_setg(errp, "cannot get vdi info, %s, %s %" PRIu32 " %s",
1272 sd_strerror(rsp->result), filename, snapid, tag);
1273 if (rsp->result == SD_RES_NO_VDI) {
1275 } else if (rsp->result == SD_RES_VDI_LOCKED) {
1290 static void coroutine_fn add_aio_request(BDRVSheepdogState *s, AIOReq *aio_req,
1291 struct iovec *iov, int niov,
1292 enum AIOCBState aiocb_type)
1294 int nr_copies = s->inode.nr_copies;
1296 unsigned int wlen = 0;
1298 uint64_t oid = aio_req->oid;
1299 unsigned int datalen = aio_req->data_len;
1300 uint64_t offset = aio_req->offset;
1301 uint8_t flags = aio_req->flags;
1302 uint64_t old_oid = aio_req->base_oid;
1303 bool create = aio_req->create;
1305 qemu_co_mutex_lock(&s->queue_lock);
1306 QLIST_INSERT_HEAD(&s->inflight_aio_head, aio_req, aio_siblings);
1307 qemu_co_mutex_unlock(&s->queue_lock);
1310 error_report("bug");
1313 memset(&hdr, 0, sizeof(hdr));
1315 switch (aiocb_type) {
1316 case AIOCB_FLUSH_CACHE:
1317 hdr.opcode = SD_OP_FLUSH_VDI;
1319 case AIOCB_READ_UDATA:
1320 hdr.opcode = SD_OP_READ_OBJ;
1323 case AIOCB_WRITE_UDATA:
1325 hdr.opcode = SD_OP_CREATE_AND_WRITE_OBJ;
1327 hdr.opcode = SD_OP_WRITE_OBJ;
1330 hdr.flags = SD_FLAG_CMD_WRITE | flags;
1332 case AIOCB_DISCARD_OBJ:
1333 hdr.opcode = SD_OP_WRITE_OBJ;
1334 hdr.flags = SD_FLAG_CMD_WRITE | flags;
1335 s->inode.data_vdi_id[data_oid_to_idx(oid)] = 0;
1336 offset = offsetof(SheepdogInode,
1337 data_vdi_id[data_oid_to_idx(oid)]);
1338 oid = vid_to_vdi_oid(s->inode.vdi_id);
1339 wlen = datalen = sizeof(uint32_t);
1343 if (s->cache_flags) {
1344 hdr.flags |= s->cache_flags;
1348 hdr.cow_oid = old_oid;
1349 hdr.copies = s->inode.nr_copies;
1351 hdr.data_length = datalen;
1352 hdr.offset = offset;
1354 hdr.id = aio_req->id;
1356 qemu_co_mutex_lock(&s->lock);
1357 s->co_send = qemu_coroutine_self();
1358 aio_set_fd_handler(s->aio_context, s->fd, false,
1359 co_read_response, co_write_request, NULL, s);
1360 socket_set_cork(s->fd, 1);
1363 ret = qemu_co_send(s->fd, &hdr, sizeof(hdr));
1364 if (ret != sizeof(hdr)) {
1365 error_report("failed to send a req, %s", strerror(errno));
1370 ret = qemu_co_sendv(s->fd, iov, niov, aio_req->iov_offset, wlen);
1372 error_report("failed to send a data, %s", strerror(errno));
1376 socket_set_cork(s->fd, 0);
1377 aio_set_fd_handler(s->aio_context, s->fd, false,
1378 co_read_response, NULL, NULL, s);
1380 qemu_co_mutex_unlock(&s->lock);
1383 static int read_write_object(int fd, BlockDriverState *bs, char *buf,
1384 uint64_t oid, uint8_t copies,
1385 unsigned int datalen, uint64_t offset,
1386 bool write, bool create, uint32_t cache_flags)
1389 SheepdogObjRsp *rsp = (SheepdogObjRsp *)&hdr;
1390 unsigned int wlen, rlen;
1393 memset(&hdr, 0, sizeof(hdr));
1398 hdr.flags = SD_FLAG_CMD_WRITE;
1400 hdr.opcode = SD_OP_CREATE_AND_WRITE_OBJ;
1402 hdr.opcode = SD_OP_WRITE_OBJ;
1407 hdr.opcode = SD_OP_READ_OBJ;
1410 hdr.flags |= cache_flags;
1413 hdr.data_length = datalen;
1414 hdr.offset = offset;
1415 hdr.copies = copies;
1417 ret = do_req(fd, bs, (SheepdogReq *)&hdr, buf, &wlen, &rlen);
1419 error_report("failed to send a request to the sheep");
1423 switch (rsp->result) {
1424 case SD_RES_SUCCESS:
1427 error_report("%s", sd_strerror(rsp->result));
1432 static int read_object(int fd, BlockDriverState *bs, char *buf,
1433 uint64_t oid, uint8_t copies,
1434 unsigned int datalen, uint64_t offset,
1435 uint32_t cache_flags)
1437 return read_write_object(fd, bs, buf, oid, copies,
1438 datalen, offset, false,
1439 false, cache_flags);
1442 static int write_object(int fd, BlockDriverState *bs, char *buf,
1443 uint64_t oid, uint8_t copies,
1444 unsigned int datalen, uint64_t offset, bool create,
1445 uint32_t cache_flags)
1447 return read_write_object(fd, bs, buf, oid, copies,
1448 datalen, offset, true,
1449 create, cache_flags);
1452 /* update inode with the latest state */
1453 static int reload_inode(BDRVSheepdogState *s, uint32_t snapid, const char *tag)
1455 Error *local_err = NULL;
1456 SheepdogInode *inode;
1460 fd = connect_to_sdog(s, &local_err);
1462 error_report_err(local_err);
1466 inode = g_malloc(SD_INODE_HEADER_SIZE);
1468 ret = find_vdi_name(s, s->name, snapid, tag, &vid, false, &local_err);
1470 error_report_err(local_err);
1474 ret = read_object(fd, s->bs, (char *)inode, vid_to_vdi_oid(vid),
1475 s->inode.nr_copies, SD_INODE_HEADER_SIZE, 0,
1481 if (inode->vdi_id != s->inode.vdi_id) {
1482 memcpy(&s->inode, inode, SD_INODE_HEADER_SIZE);
1492 static void coroutine_fn resend_aioreq(BDRVSheepdogState *s, AIOReq *aio_req)
1494 SheepdogAIOCB *acb = aio_req->aiocb;
1496 aio_req->create = false;
1498 /* check whether this request becomes a CoW one */
1499 if (acb->aiocb_type == AIOCB_WRITE_UDATA && is_data_obj(aio_req->oid)) {
1500 int idx = data_oid_to_idx(aio_req->oid);
1502 if (is_data_obj_writable(&s->inode, idx)) {
1506 if (s->inode.data_vdi_id[idx]) {
1507 aio_req->base_oid = vid_to_data_oid(s->inode.data_vdi_id[idx], idx);
1508 aio_req->flags |= SD_FLAG_CMD_COW;
1510 aio_req->create = true;
1513 if (is_data_obj(aio_req->oid)) {
1514 add_aio_request(s, aio_req, acb->qiov->iov, acb->qiov->niov,
1518 iov.iov_base = &s->inode;
1519 iov.iov_len = sizeof(s->inode);
1520 add_aio_request(s, aio_req, &iov, 1, AIOCB_WRITE_UDATA);
1524 static void sd_detach_aio_context(BlockDriverState *bs)
1526 BDRVSheepdogState *s = bs->opaque;
1528 aio_set_fd_handler(s->aio_context, s->fd, false, NULL,
1532 static void sd_attach_aio_context(BlockDriverState *bs,
1533 AioContext *new_context)
1535 BDRVSheepdogState *s = bs->opaque;
1537 s->aio_context = new_context;
1538 aio_set_fd_handler(new_context, s->fd, false,
1539 co_read_response, NULL, NULL, s);
1542 static QemuOptsList runtime_opts = {
1544 .head = QTAILQ_HEAD_INITIALIZER(runtime_opts.head),
1548 .type = QEMU_OPT_STRING,
1552 .type = QEMU_OPT_NUMBER,
1556 .type = QEMU_OPT_STRING,
1558 { /* end of list */ }
1562 static int sd_open(BlockDriverState *bs, QDict *options, int flags,
1567 BDRVSheepdogState *s = bs->opaque;
1568 const char *vdi, *snap_id_str, *tag;
1572 Error *local_err = NULL;
1575 s->aio_context = bdrv_get_aio_context(bs);
1577 opts = qemu_opts_create(&runtime_opts, NULL, 0, &error_abort);
1578 qemu_opts_absorb_qdict(opts, options, &local_err);
1580 error_propagate(errp, local_err);
1585 s->addr = sd_server_config(options, errp);
1591 vdi = qemu_opt_get(opts, "vdi");
1592 snap_id_str = qemu_opt_get(opts, "snap-id");
1593 snap_id = qemu_opt_get_number(opts, "snap-id", CURRENT_VDI_ID);
1594 tag = qemu_opt_get(opts, "tag");
1597 error_setg(errp, "parameter 'vdi' is missing");
1601 if (strlen(vdi) >= SD_MAX_VDI_LEN) {
1602 error_setg(errp, "value of parameter 'vdi' is too long");
1607 if (snap_id > UINT32_MAX) {
1610 if (snap_id_str && !snap_id) {
1611 error_setg(errp, "'snap-id=%s' is not a valid snapshot ID",
1620 if (strlen(tag) >= SD_MAX_VDI_TAG_LEN) {
1621 error_setg(errp, "value of parameter 'tag' is too long");
1626 QLIST_INIT(&s->inflight_aio_head);
1627 QLIST_INIT(&s->failed_aio_head);
1628 QLIST_INIT(&s->inflight_aiocb_head);
1630 s->fd = get_sheep_fd(s, errp);
1636 ret = find_vdi_name(s, vdi, (uint32_t)snap_id, tag, &vid, true, errp);
1642 * QEMU block layer emulates writethrough cache as 'writeback + flush', so
1643 * we always set SD_FLAG_CMD_CACHE (writeback cache) as default.
1645 s->cache_flags = SD_FLAG_CMD_CACHE;
1646 if (flags & BDRV_O_NOCACHE) {
1647 s->cache_flags = SD_FLAG_CMD_DIRECT;
1649 s->discard_supported = true;
1651 if (snap_id || tag[0]) {
1652 DPRINTF("%" PRIx32 " snapshot inode was open.\n", vid);
1653 s->is_snapshot = true;
1656 fd = connect_to_sdog(s, errp);
1662 buf = g_malloc(SD_INODE_SIZE);
1663 ret = read_object(fd, s->bs, buf, vid_to_vdi_oid(vid),
1664 0, SD_INODE_SIZE, 0, s->cache_flags);
1669 error_setg(errp, "Can't read snapshot inode");
1673 memcpy(&s->inode, buf, sizeof(s->inode));
1675 bs->total_sectors = s->inode.vdi_size / BDRV_SECTOR_SIZE;
1676 pstrcpy(s->name, sizeof(s->name), vdi);
1677 qemu_co_mutex_init(&s->lock);
1678 qemu_co_mutex_init(&s->queue_lock);
1679 qemu_co_queue_init(&s->overlapping_queue);
1680 qemu_opts_del(opts);
1685 aio_set_fd_handler(bdrv_get_aio_context(bs), s->fd,
1686 false, NULL, NULL, NULL, NULL);
1689 qemu_opts_del(opts);
1694 static int sd_reopen_prepare(BDRVReopenState *state, BlockReopenQueue *queue,
1697 BDRVSheepdogState *s = state->bs->opaque;
1698 BDRVSheepdogReopenState *re_s;
1701 re_s = state->opaque = g_new0(BDRVSheepdogReopenState, 1);
1703 re_s->cache_flags = SD_FLAG_CMD_CACHE;
1704 if (state->flags & BDRV_O_NOCACHE) {
1705 re_s->cache_flags = SD_FLAG_CMD_DIRECT;
1708 re_s->fd = get_sheep_fd(s, errp);
1717 static void sd_reopen_commit(BDRVReopenState *state)
1719 BDRVSheepdogReopenState *re_s = state->opaque;
1720 BDRVSheepdogState *s = state->bs->opaque;
1723 aio_set_fd_handler(s->aio_context, s->fd, false,
1724 NULL, NULL, NULL, NULL);
1729 s->cache_flags = re_s->cache_flags;
1731 g_free(state->opaque);
1732 state->opaque = NULL;
1737 static void sd_reopen_abort(BDRVReopenState *state)
1739 BDRVSheepdogReopenState *re_s = state->opaque;
1740 BDRVSheepdogState *s = state->bs->opaque;
1747 aio_set_fd_handler(s->aio_context, re_s->fd, false,
1748 NULL, NULL, NULL, NULL);
1749 closesocket(re_s->fd);
1752 g_free(state->opaque);
1753 state->opaque = NULL;
1758 static int do_sd_create(BDRVSheepdogState *s, uint32_t *vdi_id, int snapshot,
1762 SheepdogVdiRsp *rsp = (SheepdogVdiRsp *)&hdr;
1764 unsigned int wlen, rlen = 0;
1765 char buf[SD_MAX_VDI_LEN];
1767 fd = connect_to_sdog(s, errp);
1772 /* FIXME: would it be better to fail (e.g., return -EIO) when filename
1773 * does not fit in buf? For now, just truncate and avoid buffer overrun.
1775 memset(buf, 0, sizeof(buf));
1776 pstrcpy(buf, sizeof(buf), s->name);
1778 memset(&hdr, 0, sizeof(hdr));
1779 hdr.opcode = SD_OP_NEW_VDI;
1780 hdr.base_vdi_id = s->inode.vdi_id;
1782 wlen = SD_MAX_VDI_LEN;
1784 hdr.flags = SD_FLAG_CMD_WRITE;
1785 hdr.snapid = snapshot;
1787 hdr.data_length = wlen;
1788 hdr.vdi_size = s->inode.vdi_size;
1789 hdr.copy_policy = s->inode.copy_policy;
1790 hdr.copies = s->inode.nr_copies;
1791 hdr.block_size_shift = s->inode.block_size_shift;
1793 ret = do_req(fd, NULL, (SheepdogReq *)&hdr, buf, &wlen, &rlen);
1798 error_setg_errno(errp, -ret, "create failed");
1802 if (rsp->result != SD_RES_SUCCESS) {
1803 error_setg(errp, "%s, %s", sd_strerror(rsp->result), s->inode.name);
1808 *vdi_id = rsp->vdi_id;
1814 static int sd_prealloc(BlockDriverState *bs, int64_t old_size, int64_t new_size,
1817 BlockBackend *blk = NULL;
1818 BDRVSheepdogState *base = bs->opaque;
1819 unsigned long buf_size;
1820 uint32_t idx, max_idx;
1821 uint32_t object_size;
1825 blk = blk_new(BLK_PERM_CONSISTENT_READ | BLK_PERM_WRITE | BLK_PERM_RESIZE,
1828 ret = blk_insert_bs(blk, bs, errp);
1830 goto out_with_err_set;
1833 blk_set_allow_write_beyond_eof(blk, true);
1835 object_size = (UINT32_C(1) << base->inode.block_size_shift);
1836 buf_size = MIN(object_size, SD_DATA_OBJ_SIZE);
1837 buf = g_malloc0(buf_size);
1839 max_idx = DIV_ROUND_UP(new_size, buf_size);
1841 for (idx = old_size / buf_size; idx < max_idx; idx++) {
1843 * The created image can be a cloned image, so we need to read
1844 * a data from the source image.
1846 ret = blk_pread(blk, idx * buf_size, buf, buf_size);
1850 ret = blk_pwrite(blk, idx * buf_size, buf, buf_size, 0);
1859 error_setg_errno(errp, -ret, "Can't pre-allocate");
1870 static int sd_create_prealloc(BlockdevOptionsSheepdog *location, int64_t size,
1873 BlockDriverState *bs;
1875 QObject *obj = NULL;
1877 Error *local_err = NULL;
1880 v = qobject_output_visitor_new(&obj);
1881 visit_type_BlockdevOptionsSheepdog(v, NULL, &location, &local_err);
1885 error_propagate(errp, local_err);
1890 qdict = qobject_to(QDict, obj);
1891 qdict_flatten(qdict);
1893 qdict_put_str(qdict, "driver", "sheepdog");
1895 bs = bdrv_open(NULL, NULL, qdict, BDRV_O_PROTOCOL | BDRV_O_RDWR, errp);
1901 ret = sd_prealloc(bs, 0, size, errp);
1904 qobject_unref(qdict);
1908 static int parse_redundancy(BDRVSheepdogState *s, SheepdogRedundancy *opt)
1910 struct SheepdogInode *inode = &s->inode;
1912 switch (opt->type) {
1913 case SHEEPDOG_REDUNDANCY_TYPE_FULL:
1914 if (opt->u.full.copies > SD_MAX_COPIES || opt->u.full.copies < 1) {
1917 inode->copy_policy = 0;
1918 inode->nr_copies = opt->u.full.copies;
1921 case SHEEPDOG_REDUNDANCY_TYPE_ERASURE_CODED:
1923 int64_t copy = opt->u.erasure_coded.data_strips;
1924 int64_t parity = opt->u.erasure_coded.parity_strips;
1926 if (copy != 2 && copy != 4 && copy != 8 && copy != 16) {
1930 if (parity >= SD_EC_MAX_STRIP || parity < 1) {
1935 * 4 bits for parity and 4 bits for data.
1936 * We have to compress upper data bits because it can't represent 16
1938 inode->copy_policy = ((copy / 2) << 4) + parity;
1939 inode->nr_copies = copy + parity;
1944 g_assert_not_reached();
1951 * Sheepdog support two kinds of redundancy, full replication and erasure
1954 * # create a fully replicated vdi with x copies
1955 * -o redundancy=x (1 <= x <= SD_MAX_COPIES)
1957 * # create a erasure coded vdi with x data strips and y parity strips
1958 * -o redundancy=x:y (x must be one of {2,4,8,16} and 1 <= y < SD_EC_MAX_STRIP)
1960 static SheepdogRedundancy *parse_redundancy_str(const char *opt)
1962 SheepdogRedundancy *redundancy;
1963 const char *n1, *n2;
1968 pstrcpy(p, sizeof(p), opt);
1969 n1 = strtok(p, ":");
1970 n2 = strtok(NULL, ":");
1976 ret = qemu_strtol(n1, NULL, 10, ©);
1981 redundancy = g_new0(SheepdogRedundancy, 1);
1983 *redundancy = (SheepdogRedundancy) {
1984 .type = SHEEPDOG_REDUNDANCY_TYPE_FULL,
1985 .u.full.copies = copy,
1988 ret = qemu_strtol(n2, NULL, 10, &parity);
1994 *redundancy = (SheepdogRedundancy) {
1995 .type = SHEEPDOG_REDUNDANCY_TYPE_ERASURE_CODED,
1996 .u.erasure_coded = {
1997 .data_strips = copy,
1998 .parity_strips = parity,
2006 static int parse_block_size_shift(BDRVSheepdogState *s,
2007 BlockdevCreateOptionsSheepdog *opts)
2009 struct SheepdogInode *inode = &s->inode;
2010 uint64_t object_size;
2013 if (opts->has_object_size) {
2014 object_size = opts->object_size;
2016 if ((object_size - 1) & object_size) { /* not a power of 2? */
2019 obj_order = ctz32(object_size);
2020 if (obj_order < 20 || obj_order > 31) {
2023 inode->block_size_shift = (uint8_t)obj_order;
2029 static int sd_co_create(BlockdevCreateOptions *options, Error **errp)
2031 BlockdevCreateOptionsSheepdog *opts = &options->u.sheepdog;
2034 char *backing_file = NULL;
2036 BDRVSheepdogState *s;
2037 uint64_t max_vdi_size;
2038 bool prealloc = false;
2040 assert(options->driver == BLOCKDEV_DRIVER_SHEEPDOG);
2042 s = g_new0(BDRVSheepdogState, 1);
2044 /* Steal SocketAddress from QAPI, set NULL to prevent double free */
2045 s->addr = opts->location->server;
2046 opts->location->server = NULL;
2048 if (strlen(opts->location->vdi) >= sizeof(s->name)) {
2049 error_setg(errp, "'vdi' string too long");
2053 pstrcpy(s->name, sizeof(s->name), opts->location->vdi);
2055 s->inode.vdi_size = opts->size;
2056 backing_file = opts->backing_file;
2058 if (!opts->has_preallocation) {
2059 opts->preallocation = PREALLOC_MODE_OFF;
2061 switch (opts->preallocation) {
2062 case PREALLOC_MODE_OFF:
2065 case PREALLOC_MODE_FULL:
2069 error_setg(errp, "Preallocation mode not supported for Sheepdog");
2074 if (opts->has_redundancy) {
2075 ret = parse_redundancy(s, opts->redundancy);
2077 error_setg(errp, "Invalid redundancy mode");
2081 ret = parse_block_size_shift(s, opts);
2083 error_setg(errp, "Invalid object_size."
2084 " obect_size needs to be power of 2"
2085 " and be limited from 2^20 to 2^31");
2089 if (opts->has_backing_file) {
2091 BDRVSheepdogState *base;
2094 /* Currently, only Sheepdog backing image is supported. */
2095 drv = bdrv_find_protocol(opts->backing_file, true, NULL);
2096 if (!drv || strcmp(drv->protocol_name, "sheepdog") != 0) {
2097 error_setg(errp, "backing_file must be a sheepdog image");
2102 blk = blk_new_open(opts->backing_file, NULL, NULL,
2103 BDRV_O_PROTOCOL, errp);
2109 base = blk_bs(blk)->opaque;
2111 if (!is_snapshot(&base->inode)) {
2112 error_setg(errp, "cannot clone from a non snapshot vdi");
2117 s->inode.vdi_id = base->inode.vdi_id;
2121 s->aio_context = qemu_get_aio_context();
2123 /* if block_size_shift is not specified, get cluster default value */
2124 if (s->inode.block_size_shift == 0) {
2126 SheepdogClusterRsp *rsp = (SheepdogClusterRsp *)&hdr;
2128 unsigned int wlen = 0, rlen = 0;
2130 fd = connect_to_sdog(s, errp);
2136 memset(&hdr, 0, sizeof(hdr));
2137 hdr.opcode = SD_OP_GET_CLUSTER_DEFAULT;
2138 hdr.proto_ver = SD_PROTO_VER;
2140 ret = do_req(fd, NULL, (SheepdogReq *)&hdr,
2141 NULL, &wlen, &rlen);
2144 error_setg_errno(errp, -ret, "failed to get cluster default");
2147 if (rsp->result == SD_RES_SUCCESS) {
2148 s->inode.block_size_shift = rsp->block_size_shift;
2150 s->inode.block_size_shift = SD_DEFAULT_BLOCK_SIZE_SHIFT;
2154 max_vdi_size = (UINT64_C(1) << s->inode.block_size_shift) * MAX_DATA_OBJS;
2156 if (s->inode.vdi_size > max_vdi_size) {
2157 error_setg(errp, "An image is too large."
2158 " The maximum image size is %"PRIu64 "GB",
2159 max_vdi_size / 1024 / 1024 / 1024);
2164 ret = do_sd_create(s, &vid, 0, errp);
2170 ret = sd_create_prealloc(opts->location, opts->size, errp);
2173 g_free(backing_file);
2180 static int coroutine_fn sd_co_create_opts(const char *filename, QemuOpts *opts,
2183 BlockdevCreateOptions *create_options = NULL;
2184 QDict *qdict, *location_qdict;
2188 Error *local_err = NULL;
2191 redundancy = qemu_opt_get_del(opts, BLOCK_OPT_REDUNDANCY);
2193 qdict = qemu_opts_to_qdict(opts, NULL);
2194 qdict_put_str(qdict, "driver", "sheepdog");
2196 location_qdict = qdict_new();
2197 qdict_put(qdict, "location", location_qdict);
2199 sd_parse_filename(filename, location_qdict, &local_err);
2201 error_propagate(errp, local_err);
2206 qdict_flatten(qdict);
2208 /* Change legacy command line options into QMP ones */
2209 static const QDictRenames opt_renames[] = {
2210 { BLOCK_OPT_BACKING_FILE, "backing-file" },
2211 { BLOCK_OPT_OBJECT_SIZE, "object-size" },
2215 if (!qdict_rename_keys(qdict, opt_renames, errp)) {
2220 /* Get the QAPI object */
2221 crumpled = qdict_crumple(qdict, errp);
2222 if (crumpled == NULL) {
2227 v = qobject_input_visitor_new_keyval(crumpled);
2228 visit_type_BlockdevCreateOptions(v, NULL, &create_options, &local_err);
2230 qobject_unref(crumpled);
2233 error_propagate(errp, local_err);
2238 assert(create_options->driver == BLOCKDEV_DRIVER_SHEEPDOG);
2239 create_options->u.sheepdog.size =
2240 ROUND_UP(create_options->u.sheepdog.size, BDRV_SECTOR_SIZE);
2243 create_options->u.sheepdog.has_redundancy = true;
2244 create_options->u.sheepdog.redundancy =
2245 parse_redundancy_str(redundancy);
2246 if (create_options->u.sheepdog.redundancy == NULL) {
2247 error_setg(errp, "Invalid redundancy mode");
2253 ret = sd_co_create(create_options, errp);
2255 qapi_free_BlockdevCreateOptions(create_options);
2256 qobject_unref(qdict);
2261 static void sd_close(BlockDriverState *bs)
2263 Error *local_err = NULL;
2264 BDRVSheepdogState *s = bs->opaque;
2266 SheepdogVdiRsp *rsp = (SheepdogVdiRsp *)&hdr;
2267 unsigned int wlen, rlen = 0;
2270 DPRINTF("%s\n", s->name);
2272 fd = connect_to_sdog(s, &local_err);
2274 error_report_err(local_err);
2278 memset(&hdr, 0, sizeof(hdr));
2280 hdr.opcode = SD_OP_RELEASE_VDI;
2281 hdr.type = LOCK_TYPE_NORMAL;
2282 hdr.base_vdi_id = s->inode.vdi_id;
2283 wlen = strlen(s->name) + 1;
2284 hdr.data_length = wlen;
2285 hdr.flags = SD_FLAG_CMD_WRITE;
2287 ret = do_req(fd, s->bs, (SheepdogReq *)&hdr,
2288 s->name, &wlen, &rlen);
2292 if (!ret && rsp->result != SD_RES_SUCCESS &&
2293 rsp->result != SD_RES_VDI_NOT_LOCKED) {
2294 error_report("%s, %s", sd_strerror(rsp->result), s->name);
2297 aio_set_fd_handler(bdrv_get_aio_context(bs), s->fd,
2298 false, NULL, NULL, NULL, NULL);
2300 qapi_free_SocketAddress(s->addr);
2303 static int64_t sd_getlength(BlockDriverState *bs)
2305 BDRVSheepdogState *s = bs->opaque;
2307 return s->inode.vdi_size;
2310 static int sd_truncate(BlockDriverState *bs, int64_t offset,
2311 PreallocMode prealloc, Error **errp)
2313 BDRVSheepdogState *s = bs->opaque;
2315 unsigned int datalen;
2316 uint64_t max_vdi_size;
2317 int64_t old_size = s->inode.vdi_size;
2319 if (prealloc != PREALLOC_MODE_OFF && prealloc != PREALLOC_MODE_FULL) {
2320 error_setg(errp, "Unsupported preallocation mode '%s'",
2321 PreallocMode_str(prealloc));
2325 max_vdi_size = (UINT64_C(1) << s->inode.block_size_shift) * MAX_DATA_OBJS;
2326 if (offset < old_size) {
2327 error_setg(errp, "shrinking is not supported");
2329 } else if (offset > max_vdi_size) {
2330 error_setg(errp, "too big image size");
2334 fd = connect_to_sdog(s, errp);
2339 /* we don't need to update entire object */
2340 datalen = SD_INODE_SIZE - sizeof(s->inode.data_vdi_id);
2341 s->inode.vdi_size = offset;
2342 ret = write_object(fd, s->bs, (char *)&s->inode,
2343 vid_to_vdi_oid(s->inode.vdi_id), s->inode.nr_copies,
2344 datalen, 0, false, s->cache_flags);
2348 error_setg_errno(errp, -ret, "failed to update an inode");
2352 if (prealloc == PREALLOC_MODE_FULL) {
2353 ret = sd_prealloc(bs, old_size, offset, errp);
2363 * This function is called after writing data objects. If we need to
2364 * update metadata, this sends a write request to the vdi object.
2366 static void coroutine_fn sd_write_done(SheepdogAIOCB *acb)
2368 BDRVSheepdogState *s = acb->s;
2371 uint32_t offset, data_len, mn, mx;
2373 mn = acb->min_dirty_data_idx;
2374 mx = acb->max_dirty_data_idx;
2376 /* we need to update the vdi object. */
2378 offset = sizeof(s->inode) - sizeof(s->inode.data_vdi_id) +
2379 mn * sizeof(s->inode.data_vdi_id[0]);
2380 data_len = (mx - mn + 1) * sizeof(s->inode.data_vdi_id[0]);
2382 acb->min_dirty_data_idx = UINT32_MAX;
2383 acb->max_dirty_data_idx = 0;
2385 iov.iov_base = &s->inode;
2386 iov.iov_len = sizeof(s->inode);
2387 aio_req = alloc_aio_req(s, acb, vid_to_vdi_oid(s->inode.vdi_id),
2388 data_len, offset, 0, false, 0, offset);
2389 add_aio_request(s, aio_req, &iov, 1, AIOCB_WRITE_UDATA);
2390 if (--acb->nr_pending) {
2391 qemu_coroutine_yield();
2396 /* Delete current working VDI on the snapshot chain */
2397 static bool sd_delete(BDRVSheepdogState *s)
2399 Error *local_err = NULL;
2400 unsigned int wlen = SD_MAX_VDI_LEN, rlen = 0;
2401 SheepdogVdiReq hdr = {
2402 .opcode = SD_OP_DEL_VDI,
2403 .base_vdi_id = s->inode.vdi_id,
2404 .data_length = wlen,
2405 .flags = SD_FLAG_CMD_WRITE,
2407 SheepdogVdiRsp *rsp = (SheepdogVdiRsp *)&hdr;
2410 fd = connect_to_sdog(s, &local_err);
2412 error_report_err(local_err);
2416 ret = do_req(fd, s->bs, (SheepdogReq *)&hdr,
2417 s->name, &wlen, &rlen);
2422 switch (rsp->result) {
2424 error_report("%s was already deleted", s->name);
2426 case SD_RES_SUCCESS:
2429 error_report("%s, %s", sd_strerror(rsp->result), s->name);
2437 * Create a writable VDI from a snapshot
2439 static int sd_create_branch(BDRVSheepdogState *s)
2441 Error *local_err = NULL;
2447 DPRINTF("%" PRIx32 " is snapshot.\n", s->inode.vdi_id);
2449 buf = g_malloc(SD_INODE_SIZE);
2452 * Even If deletion fails, we will just create extra snapshot based on
2453 * the working VDI which was supposed to be deleted. So no need to
2456 deleted = sd_delete(s);
2457 ret = do_sd_create(s, &vid, !deleted, &local_err);
2459 error_report_err(local_err);
2463 DPRINTF("%" PRIx32 " is created.\n", vid);
2465 fd = connect_to_sdog(s, &local_err);
2467 error_report_err(local_err);
2472 ret = read_object(fd, s->bs, buf, vid_to_vdi_oid(vid),
2473 s->inode.nr_copies, SD_INODE_SIZE, 0, s->cache_flags);
2481 memcpy(&s->inode, buf, sizeof(s->inode));
2483 s->is_snapshot = false;
2485 DPRINTF("%" PRIx32 " was newly created.\n", s->inode.vdi_id);
2494 * Send I/O requests to the server.
2496 * This function sends requests to the server, links the requests to
2497 * the inflight_list in BDRVSheepdogState, and exits without
2498 * waiting the response. The responses are received in the
2499 * `aio_read_response' function which is called from the main loop as
2502 * Returns 1 when we need to wait a response, 0 when there is no sent
2503 * request and -errno in error cases.
2505 static void coroutine_fn sd_co_rw_vector(SheepdogAIOCB *acb)
2508 unsigned long len, done = 0, total = acb->nb_sectors * BDRV_SECTOR_SIZE;
2510 uint32_t object_size;
2513 BDRVSheepdogState *s = acb->s;
2514 SheepdogInode *inode = &s->inode;
2517 if (acb->aiocb_type == AIOCB_WRITE_UDATA && s->is_snapshot) {
2519 * In the case we open the snapshot VDI, Sheepdog creates the
2520 * writable VDI when we do a write operation first.
2522 ret = sd_create_branch(s);
2529 object_size = (UINT32_C(1) << inode->block_size_shift);
2530 idx = acb->sector_num * BDRV_SECTOR_SIZE / object_size;
2531 offset = (acb->sector_num * BDRV_SECTOR_SIZE) % object_size;
2534 * Make sure we don't free the aiocb before we are done with all requests.
2535 * This additional reference is dropped at the end of this function.
2539 while (done != total) {
2541 uint64_t old_oid = 0;
2542 bool create = false;
2544 oid = vid_to_data_oid(inode->data_vdi_id[idx], idx);
2546 len = MIN(total - done, object_size - offset);
2548 switch (acb->aiocb_type) {
2549 case AIOCB_READ_UDATA:
2550 if (!inode->data_vdi_id[idx]) {
2551 qemu_iovec_memset(acb->qiov, done, 0, len);
2555 case AIOCB_WRITE_UDATA:
2556 if (!inode->data_vdi_id[idx]) {
2558 } else if (!is_data_obj_writable(inode, idx)) {
2562 flags = SD_FLAG_CMD_COW;
2565 case AIOCB_DISCARD_OBJ:
2567 * We discard the object only when the whole object is
2568 * 1) allocated 2) trimmed. Otherwise, simply skip it.
2570 if (len != object_size || inode->data_vdi_id[idx] == 0) {
2579 DPRINTF("update ino (%" PRIu32 ") %" PRIu64 " %" PRIu64 " %ld\n",
2581 vid_to_data_oid(inode->data_vdi_id[idx], idx), idx);
2582 oid = vid_to_data_oid(inode->vdi_id, idx);
2583 DPRINTF("new oid %" PRIx64 "\n", oid);
2586 aio_req = alloc_aio_req(s, acb, oid, len, offset, flags, create,
2588 acb->aiocb_type == AIOCB_DISCARD_OBJ ?
2590 add_aio_request(s, aio_req, acb->qiov->iov, acb->qiov->niov,
2597 if (--acb->nr_pending) {
2598 qemu_coroutine_yield();
2602 static void sd_aio_complete(SheepdogAIOCB *acb)
2604 BDRVSheepdogState *s;
2605 if (acb->aiocb_type == AIOCB_FLUSH_CACHE) {
2610 qemu_co_mutex_lock(&s->queue_lock);
2611 QLIST_REMOVE(acb, aiocb_siblings);
2612 qemu_co_queue_restart_all(&s->overlapping_queue);
2613 qemu_co_mutex_unlock(&s->queue_lock);
2616 static coroutine_fn int sd_co_writev(BlockDriverState *bs, int64_t sector_num,
2617 int nb_sectors, QEMUIOVector *qiov,
2622 int64_t offset = (sector_num + nb_sectors) * BDRV_SECTOR_SIZE;
2623 BDRVSheepdogState *s = bs->opaque;
2626 if (offset > s->inode.vdi_size) {
2627 ret = sd_truncate(bs, offset, PREALLOC_MODE_OFF, NULL);
2633 sd_aio_setup(&acb, s, qiov, sector_num, nb_sectors, AIOCB_WRITE_UDATA);
2634 sd_co_rw_vector(&acb);
2635 sd_write_done(&acb);
2636 sd_aio_complete(&acb);
2641 static coroutine_fn int sd_co_readv(BlockDriverState *bs, int64_t sector_num,
2642 int nb_sectors, QEMUIOVector *qiov)
2645 BDRVSheepdogState *s = bs->opaque;
2647 sd_aio_setup(&acb, s, qiov, sector_num, nb_sectors, AIOCB_READ_UDATA);
2648 sd_co_rw_vector(&acb);
2649 sd_aio_complete(&acb);
2654 static int coroutine_fn sd_co_flush_to_disk(BlockDriverState *bs)
2656 BDRVSheepdogState *s = bs->opaque;
2660 if (s->cache_flags != SD_FLAG_CMD_CACHE) {
2664 sd_aio_setup(&acb, s, NULL, 0, 0, AIOCB_FLUSH_CACHE);
2667 aio_req = alloc_aio_req(s, &acb, vid_to_vdi_oid(s->inode.vdi_id),
2668 0, 0, 0, false, 0, 0);
2669 add_aio_request(s, aio_req, NULL, 0, acb.aiocb_type);
2671 if (--acb.nr_pending) {
2672 qemu_coroutine_yield();
2675 sd_aio_complete(&acb);
2679 static int sd_snapshot_create(BlockDriverState *bs, QEMUSnapshotInfo *sn_info)
2681 Error *local_err = NULL;
2682 BDRVSheepdogState *s = bs->opaque;
2685 SheepdogInode *inode;
2686 unsigned int datalen;
2688 DPRINTF("sn_info: name %s id_str %s s: name %s vm_state_size %" PRId64 " "
2689 "is_snapshot %d\n", sn_info->name, sn_info->id_str,
2690 s->name, sn_info->vm_state_size, s->is_snapshot);
2692 if (s->is_snapshot) {
2693 error_report("You can't create a snapshot of a snapshot VDI, "
2694 "%s (%" PRIu32 ").", s->name, s->inode.vdi_id);
2699 DPRINTF("%s %s\n", sn_info->name, sn_info->id_str);
2701 s->inode.vm_state_size = sn_info->vm_state_size;
2702 s->inode.vm_clock_nsec = sn_info->vm_clock_nsec;
2703 /* It appears that inode.tag does not require a NUL terminator,
2704 * which means this use of strncpy is ok.
2706 strncpy(s->inode.tag, sn_info->name, sizeof(s->inode.tag));
2707 /* we don't need to update entire object */
2708 datalen = SD_INODE_SIZE - sizeof(s->inode.data_vdi_id);
2709 inode = g_malloc(datalen);
2711 /* refresh inode. */
2712 fd = connect_to_sdog(s, &local_err);
2714 error_report_err(local_err);
2719 ret = write_object(fd, s->bs, (char *)&s->inode,
2720 vid_to_vdi_oid(s->inode.vdi_id), s->inode.nr_copies,
2721 datalen, 0, false, s->cache_flags);
2723 error_report("failed to write snapshot's inode.");
2727 ret = do_sd_create(s, &new_vid, 1, &local_err);
2729 error_reportf_err(local_err,
2730 "failed to create inode for snapshot: ");
2734 ret = read_object(fd, s->bs, (char *)inode,
2735 vid_to_vdi_oid(new_vid), s->inode.nr_copies, datalen, 0,
2739 error_report("failed to read new inode info. %s", strerror(errno));
2743 memcpy(&s->inode, inode, datalen);
2744 DPRINTF("s->inode: name %s snap_id %x oid %x\n",
2745 s->inode.name, s->inode.snap_id, s->inode.vdi_id);
2754 * We implement rollback(loadvm) operation to the specified snapshot by
2755 * 1) switch to the snapshot
2756 * 2) rely on sd_create_branch to delete working VDI and
2757 * 3) create a new working VDI based on the specified snapshot
2759 static int sd_snapshot_goto(BlockDriverState *bs, const char *snapshot_id)
2761 BDRVSheepdogState *s = bs->opaque;
2762 BDRVSheepdogState *old_s;
2763 char tag[SD_MAX_VDI_TAG_LEN];
2764 uint32_t snapid = 0;
2767 if (!sd_parse_snapid_or_tag(snapshot_id, &snapid, tag)) {
2771 old_s = g_new(BDRVSheepdogState, 1);
2773 memcpy(old_s, s, sizeof(BDRVSheepdogState));
2775 ret = reload_inode(s, snapid, tag);
2780 ret = sd_create_branch(s);
2789 /* recover bdrv_sd_state */
2790 memcpy(s, old_s, sizeof(BDRVSheepdogState));
2793 error_report("failed to open. recover old bdrv_sd_state.");
2798 #define NR_BATCHED_DISCARD 128
2800 static int remove_objects(BDRVSheepdogState *s, Error **errp)
2802 int fd, i = 0, nr_objs = 0;
2804 SheepdogInode *inode = &s->inode;
2806 fd = connect_to_sdog(s, errp);
2811 nr_objs = count_data_objs(inode);
2812 while (i < nr_objs) {
2813 int start_idx, nr_filled_idx;
2815 while (i < nr_objs && !inode->data_vdi_id[i]) {
2821 while (i < nr_objs && nr_filled_idx < NR_BATCHED_DISCARD) {
2822 if (inode->data_vdi_id[i]) {
2823 inode->data_vdi_id[i] = 0;
2830 ret = write_object(fd, s->bs,
2831 (char *)&inode->data_vdi_id[start_idx],
2832 vid_to_vdi_oid(s->inode.vdi_id), inode->nr_copies,
2833 (i - start_idx) * sizeof(uint32_t),
2834 offsetof(struct SheepdogInode,
2835 data_vdi_id[start_idx]),
2836 false, s->cache_flags);
2838 error_setg(errp, "Failed to discard snapshot inode");
2849 static int sd_snapshot_delete(BlockDriverState *bs,
2850 const char *snapshot_id,
2855 * FIXME should delete the snapshot matching both @snapshot_id and
2856 * @name, but @name not used here
2858 unsigned long snap_id = 0;
2859 char snap_tag[SD_MAX_VDI_TAG_LEN];
2861 char buf[SD_MAX_VDI_LEN + SD_MAX_VDI_TAG_LEN];
2862 BDRVSheepdogState *s = bs->opaque;
2863 unsigned int wlen = SD_MAX_VDI_LEN + SD_MAX_VDI_TAG_LEN, rlen = 0;
2865 SheepdogVdiReq hdr = {
2866 .opcode = SD_OP_DEL_VDI,
2867 .data_length = wlen,
2868 .flags = SD_FLAG_CMD_WRITE,
2870 SheepdogVdiRsp *rsp = (SheepdogVdiRsp *)&hdr;
2872 ret = remove_objects(s, errp);
2877 memset(buf, 0, sizeof(buf));
2878 memset(snap_tag, 0, sizeof(snap_tag));
2879 pstrcpy(buf, SD_MAX_VDI_LEN, s->name);
2880 /* TODO Use sd_parse_snapid() once this mess is cleaned up */
2881 ret = qemu_strtoul(snapshot_id, NULL, 10, &snap_id);
2882 if (ret || snap_id > UINT32_MAX) {
2884 * FIXME Since qemu_strtoul() returns -EINVAL when
2885 * @snapshot_id is null, @snapshot_id is mandatory. Correct
2886 * would be to require at least one of @snapshot_id and @name.
2888 error_setg(errp, "Invalid snapshot ID: %s",
2889 snapshot_id ? snapshot_id : "<null>");
2894 hdr.snapid = (uint32_t) snap_id;
2896 /* FIXME I suspect we should use @name here */
2897 /* FIXME don't truncate silently */
2898 pstrcpy(snap_tag, sizeof(snap_tag), snapshot_id);
2899 pstrcpy(buf + SD_MAX_VDI_LEN, SD_MAX_VDI_TAG_LEN, snap_tag);
2902 ret = find_vdi_name(s, s->name, snap_id, snap_tag, &vid, true, errp);
2907 fd = connect_to_sdog(s, errp);
2912 ret = do_req(fd, s->bs, (SheepdogReq *)&hdr,
2916 error_setg_errno(errp, -ret, "Couldn't send request to server");
2920 switch (rsp->result) {
2922 error_setg(errp, "Can't find the snapshot");
2924 case SD_RES_SUCCESS:
2927 error_setg(errp, "%s", sd_strerror(rsp->result));
2934 static int sd_snapshot_list(BlockDriverState *bs, QEMUSnapshotInfo **psn_tab)
2936 Error *local_err = NULL;
2937 BDRVSheepdogState *s = bs->opaque;
2939 int fd, nr = 1024, ret, max = BITS_TO_LONGS(SD_NR_VDIS) * sizeof(long);
2940 QEMUSnapshotInfo *sn_tab = NULL;
2941 unsigned wlen, rlen;
2943 static SheepdogInode inode;
2944 unsigned long *vdi_inuse;
2945 unsigned int start_nr;
2949 vdi_inuse = g_malloc(max);
2951 fd = connect_to_sdog(s, &local_err);
2953 error_report_err(local_err);
2961 memset(&req, 0, sizeof(req));
2963 req.opcode = SD_OP_READ_VDIS;
2964 req.data_length = max;
2966 ret = do_req(fd, s->bs, &req, vdi_inuse, &wlen, &rlen);
2973 sn_tab = g_new0(QEMUSnapshotInfo, nr);
2975 /* calculate a vdi id with hash function */
2976 hval = fnv_64a_buf(s->name, strlen(s->name), FNV1A_64_INIT);
2977 start_nr = hval & (SD_NR_VDIS - 1);
2979 fd = connect_to_sdog(s, &local_err);
2981 error_report_err(local_err);
2986 for (vid = start_nr; found < nr; vid = (vid + 1) % SD_NR_VDIS) {
2987 if (!test_bit(vid, vdi_inuse)) {
2991 /* we don't need to read entire object */
2992 ret = read_object(fd, s->bs, (char *)&inode,
2993 vid_to_vdi_oid(vid),
2994 0, SD_INODE_SIZE - sizeof(inode.data_vdi_id), 0,
3001 if (!strcmp(inode.name, s->name) && is_snapshot(&inode)) {
3002 sn_tab[found].date_sec = inode.snap_ctime >> 32;
3003 sn_tab[found].date_nsec = inode.snap_ctime & 0xffffffff;
3004 sn_tab[found].vm_state_size = inode.vm_state_size;
3005 sn_tab[found].vm_clock_nsec = inode.vm_clock_nsec;
3007 snprintf(sn_tab[found].id_str, sizeof(sn_tab[found].id_str),
3008 "%" PRIu32, inode.snap_id);
3009 pstrcpy(sn_tab[found].name,
3010 MIN(sizeof(sn_tab[found].name), sizeof(inode.tag)),
3029 static int do_load_save_vmstate(BDRVSheepdogState *s, uint8_t *data,
3030 int64_t pos, int size, int load)
3032 Error *local_err = NULL;
3034 int fd, ret = 0, remaining = size;
3035 unsigned int data_len;
3036 uint64_t vmstate_oid;
3039 uint32_t vdi_id = load ? s->inode.parent_vdi_id : s->inode.vdi_id;
3040 uint32_t object_size = (UINT32_C(1) << s->inode.block_size_shift);
3042 fd = connect_to_sdog(s, &local_err);
3044 error_report_err(local_err);
3049 vdi_index = pos / object_size;
3050 offset = pos % object_size;
3052 data_len = MIN(remaining, object_size - offset);
3054 vmstate_oid = vid_to_vmstate_oid(vdi_id, vdi_index);
3056 create = (offset == 0);
3058 ret = read_object(fd, s->bs, (char *)data, vmstate_oid,
3059 s->inode.nr_copies, data_len, offset,
3062 ret = write_object(fd, s->bs, (char *)data, vmstate_oid,
3063 s->inode.nr_copies, data_len, offset, create,
3068 error_report("failed to save vmstate %s", strerror(errno));
3074 remaining -= data_len;
3082 static int sd_save_vmstate(BlockDriverState *bs, QEMUIOVector *qiov,
3085 BDRVSheepdogState *s = bs->opaque;
3089 buf = qemu_blockalign(bs, qiov->size);
3090 qemu_iovec_to_buf(qiov, 0, buf, qiov->size);
3091 ret = do_load_save_vmstate(s, (uint8_t *) buf, pos, qiov->size, 0);
3097 static int sd_load_vmstate(BlockDriverState *bs, QEMUIOVector *qiov,
3100 BDRVSheepdogState *s = bs->opaque;
3104 buf = qemu_blockalign(bs, qiov->size);
3105 ret = do_load_save_vmstate(s, buf, pos, qiov->size, 1);
3106 qemu_iovec_from_buf(qiov, 0, buf, qiov->size);
3113 static coroutine_fn int sd_co_pdiscard(BlockDriverState *bs, int64_t offset,
3117 BDRVSheepdogState *s = bs->opaque;
3118 QEMUIOVector discard_iov;
3122 if (!s->discard_supported) {
3126 memset(&discard_iov, 0, sizeof(discard_iov));
3127 memset(&iov, 0, sizeof(iov));
3128 iov.iov_base = &zero;
3129 iov.iov_len = sizeof(zero);
3130 discard_iov.iov = &iov;
3131 discard_iov.niov = 1;
3132 if (!QEMU_IS_ALIGNED(offset | bytes, BDRV_SECTOR_SIZE)) {
3135 sd_aio_setup(&acb, s, &discard_iov, offset >> BDRV_SECTOR_BITS,
3136 bytes >> BDRV_SECTOR_BITS, AIOCB_DISCARD_OBJ);
3137 sd_co_rw_vector(&acb);
3138 sd_aio_complete(&acb);
3143 static coroutine_fn int
3144 sd_co_block_status(BlockDriverState *bs, bool want_zero, int64_t offset,
3145 int64_t bytes, int64_t *pnum, int64_t *map,
3146 BlockDriverState **file)
3148 BDRVSheepdogState *s = bs->opaque;
3149 SheepdogInode *inode = &s->inode;
3150 uint32_t object_size = (UINT32_C(1) << inode->block_size_shift);
3151 unsigned long start = offset / object_size,
3152 end = DIV_ROUND_UP(offset + bytes, object_size);
3155 int ret = BDRV_BLOCK_DATA | BDRV_BLOCK_OFFSET_VALID;
3157 for (idx = start; idx < end; idx++) {
3158 if (inode->data_vdi_id[idx] == 0) {
3163 /* Get the longest length of unallocated sectors */
3165 for (idx = start + 1; idx < end; idx++) {
3166 if (inode->data_vdi_id[idx] != 0) {
3172 *pnum = (idx - start) * object_size;
3173 if (*pnum > bytes) {
3176 if (ret > 0 && ret & BDRV_BLOCK_OFFSET_VALID) {
3182 static int64_t sd_get_allocated_file_size(BlockDriverState *bs)
3184 BDRVSheepdogState *s = bs->opaque;
3185 SheepdogInode *inode = &s->inode;
3186 uint32_t object_size = (UINT32_C(1) << inode->block_size_shift);
3187 unsigned long i, last = DIV_ROUND_UP(inode->vdi_size, object_size);
3190 for (i = 0; i < last; i++) {
3191 if (inode->data_vdi_id[i] == 0) {
3194 size += object_size;
3199 static QemuOptsList sd_create_opts = {
3200 .name = "sheepdog-create-opts",
3201 .head = QTAILQ_HEAD_INITIALIZER(sd_create_opts.head),
3204 .name = BLOCK_OPT_SIZE,
3205 .type = QEMU_OPT_SIZE,
3206 .help = "Virtual disk size"
3209 .name = BLOCK_OPT_BACKING_FILE,
3210 .type = QEMU_OPT_STRING,
3211 .help = "File name of a base image"
3214 .name = BLOCK_OPT_PREALLOC,
3215 .type = QEMU_OPT_STRING,
3216 .help = "Preallocation mode (allowed values: off, full)"
3219 .name = BLOCK_OPT_REDUNDANCY,
3220 .type = QEMU_OPT_STRING,
3221 .help = "Redundancy of the image"
3224 .name = BLOCK_OPT_OBJECT_SIZE,
3225 .type = QEMU_OPT_SIZE,
3226 .help = "Object size of the image"
3228 { /* end of list */ }
3232 static BlockDriver bdrv_sheepdog = {
3233 .format_name = "sheepdog",
3234 .protocol_name = "sheepdog",
3235 .instance_size = sizeof(BDRVSheepdogState),
3236 .bdrv_parse_filename = sd_parse_filename,
3237 .bdrv_file_open = sd_open,
3238 .bdrv_reopen_prepare = sd_reopen_prepare,
3239 .bdrv_reopen_commit = sd_reopen_commit,
3240 .bdrv_reopen_abort = sd_reopen_abort,
3241 .bdrv_close = sd_close,
3242 .bdrv_co_create = sd_co_create,
3243 .bdrv_co_create_opts = sd_co_create_opts,
3244 .bdrv_has_zero_init = bdrv_has_zero_init_1,
3245 .bdrv_getlength = sd_getlength,
3246 .bdrv_get_allocated_file_size = sd_get_allocated_file_size,
3247 .bdrv_truncate = sd_truncate,
3249 .bdrv_co_readv = sd_co_readv,
3250 .bdrv_co_writev = sd_co_writev,
3251 .bdrv_co_flush_to_disk = sd_co_flush_to_disk,
3252 .bdrv_co_pdiscard = sd_co_pdiscard,
3253 .bdrv_co_block_status = sd_co_block_status,
3255 .bdrv_snapshot_create = sd_snapshot_create,
3256 .bdrv_snapshot_goto = sd_snapshot_goto,
3257 .bdrv_snapshot_delete = sd_snapshot_delete,
3258 .bdrv_snapshot_list = sd_snapshot_list,
3260 .bdrv_save_vmstate = sd_save_vmstate,
3261 .bdrv_load_vmstate = sd_load_vmstate,
3263 .bdrv_detach_aio_context = sd_detach_aio_context,
3264 .bdrv_attach_aio_context = sd_attach_aio_context,
3266 .create_opts = &sd_create_opts,
3269 static BlockDriver bdrv_sheepdog_tcp = {
3270 .format_name = "sheepdog",
3271 .protocol_name = "sheepdog+tcp",
3272 .instance_size = sizeof(BDRVSheepdogState),
3273 .bdrv_parse_filename = sd_parse_filename,
3274 .bdrv_file_open = sd_open,
3275 .bdrv_reopen_prepare = sd_reopen_prepare,
3276 .bdrv_reopen_commit = sd_reopen_commit,
3277 .bdrv_reopen_abort = sd_reopen_abort,
3278 .bdrv_close = sd_close,
3279 .bdrv_co_create = sd_co_create,
3280 .bdrv_co_create_opts = sd_co_create_opts,
3281 .bdrv_has_zero_init = bdrv_has_zero_init_1,
3282 .bdrv_getlength = sd_getlength,
3283 .bdrv_get_allocated_file_size = sd_get_allocated_file_size,
3284 .bdrv_truncate = sd_truncate,
3286 .bdrv_co_readv = sd_co_readv,
3287 .bdrv_co_writev = sd_co_writev,
3288 .bdrv_co_flush_to_disk = sd_co_flush_to_disk,
3289 .bdrv_co_pdiscard = sd_co_pdiscard,
3290 .bdrv_co_block_status = sd_co_block_status,
3292 .bdrv_snapshot_create = sd_snapshot_create,
3293 .bdrv_snapshot_goto = sd_snapshot_goto,
3294 .bdrv_snapshot_delete = sd_snapshot_delete,
3295 .bdrv_snapshot_list = sd_snapshot_list,
3297 .bdrv_save_vmstate = sd_save_vmstate,
3298 .bdrv_load_vmstate = sd_load_vmstate,
3300 .bdrv_detach_aio_context = sd_detach_aio_context,
3301 .bdrv_attach_aio_context = sd_attach_aio_context,
3303 .create_opts = &sd_create_opts,
3306 static BlockDriver bdrv_sheepdog_unix = {
3307 .format_name = "sheepdog",
3308 .protocol_name = "sheepdog+unix",
3309 .instance_size = sizeof(BDRVSheepdogState),
3310 .bdrv_parse_filename = sd_parse_filename,
3311 .bdrv_file_open = sd_open,
3312 .bdrv_reopen_prepare = sd_reopen_prepare,
3313 .bdrv_reopen_commit = sd_reopen_commit,
3314 .bdrv_reopen_abort = sd_reopen_abort,
3315 .bdrv_close = sd_close,
3316 .bdrv_co_create = sd_co_create,
3317 .bdrv_co_create_opts = sd_co_create_opts,
3318 .bdrv_has_zero_init = bdrv_has_zero_init_1,
3319 .bdrv_getlength = sd_getlength,
3320 .bdrv_get_allocated_file_size = sd_get_allocated_file_size,
3321 .bdrv_truncate = sd_truncate,
3323 .bdrv_co_readv = sd_co_readv,
3324 .bdrv_co_writev = sd_co_writev,
3325 .bdrv_co_flush_to_disk = sd_co_flush_to_disk,
3326 .bdrv_co_pdiscard = sd_co_pdiscard,
3327 .bdrv_co_block_status = sd_co_block_status,
3329 .bdrv_snapshot_create = sd_snapshot_create,
3330 .bdrv_snapshot_goto = sd_snapshot_goto,
3331 .bdrv_snapshot_delete = sd_snapshot_delete,
3332 .bdrv_snapshot_list = sd_snapshot_list,
3334 .bdrv_save_vmstate = sd_save_vmstate,
3335 .bdrv_load_vmstate = sd_load_vmstate,
3337 .bdrv_detach_aio_context = sd_detach_aio_context,
3338 .bdrv_attach_aio_context = sd_attach_aio_context,
3340 .create_opts = &sd_create_opts,
3343 static void bdrv_sheepdog_init(void)
3345 bdrv_register(&bdrv_sheepdog);
3346 bdrv_register(&bdrv_sheepdog_tcp);
3347 bdrv_register(&bdrv_sheepdog_unix);
3349 block_init(bdrv_sheepdog_init);