Archipelago » qemu

/*

 * Copyright (C) 2009-2010 Nippon Telegraph and Telephone Corporation.

 *

 * This program is free software; you can redistribute it and/or

 * modify it under the terms of the GNU General Public License version

 * 2 as published by the Free Software Foundation.

 *

 * You should have received a copy of the GNU General Public License

 * along with this program. If not, see <http://www.gnu.org/licenses/>.

 *

 * Contributions after 2012-01-13 are licensed under the terms of the

 * GNU GPL, version 2 or (at your option) any later version.

 */

#include "qemu-common.h"

#include "qemu/uri.h"

#include "qemu/error-report.h"

#include "qemu/sockets.h"

#include "block/block_int.h"

#include "qemu/bitops.h"

#define SD_PROTO_VER 0x01

#define SD_DEFAULT_ADDR "localhost"

#define SD_DEFAULT_PORT 7000

#define SD_OP_CREATE_AND_WRITE_OBJ  0x01

#define SD_OP_READ_OBJ       0x02

#define SD_OP_WRITE_OBJ      0x03

/* 0x04 is used internally by Sheepdog */

#define SD_OP_DISCARD_OBJ    0x05

#define SD_OP_NEW_VDI        0x11

#define SD_OP_LOCK_VDI       0x12

#define SD_OP_RELEASE_VDI    0x13

#define SD_OP_GET_VDI_INFO   0x14

#define SD_OP_READ_VDIS      0x15

#define SD_OP_FLUSH_VDI      0x16

#define SD_OP_DEL_VDI        0x17

#define SD_FLAG_CMD_WRITE    0x01

#define SD_FLAG_CMD_COW      0x02

#define SD_FLAG_CMD_CACHE    0x04 /* Writeback mode for cache */

#define SD_FLAG_CMD_DIRECT   0x08 /* Don't use cache */

#define SD_RES_SUCCESS       0x00 /* Success */

#define SD_RES_UNKNOWN       0x01 /* Unknown error */

#define SD_RES_NO_OBJ        0x02 /* No object found */

#define SD_RES_EIO           0x03 /* I/O error */

#define SD_RES_VDI_EXIST     0x04 /* Vdi exists already */

#define SD_RES_INVALID_PARMS 0x05 /* Invalid parameters */

#define SD_RES_SYSTEM_ERROR  0x06 /* System error */

#define SD_RES_VDI_LOCKED    0x07 /* Vdi is locked */

#define SD_RES_NO_VDI        0x08 /* No vdi found */

#define SD_RES_NO_BASE_VDI   0x09 /* No base vdi found */

#define SD_RES_VDI_READ      0x0A /* Cannot read requested vdi */

#define SD_RES_VDI_WRITE     0x0B /* Cannot write requested vdi */

#define SD_RES_BASE_VDI_READ 0x0C /* Cannot read base vdi */

#define SD_RES_BASE_VDI_WRITE   0x0D /* Cannot write base vdi */

#define SD_RES_NO_TAG        0x0E /* Requested tag is not found */

#define SD_RES_STARTUP       0x0F /* Sheepdog is on starting up */

#define SD_RES_VDI_NOT_LOCKED   0x10 /* Vdi is not locked */

#define SD_RES_SHUTDOWN      0x11 /* Sheepdog is shutting down */

#define SD_RES_NO_MEM        0x12 /* Cannot allocate memory */

#define SD_RES_FULL_VDI      0x13 /* we already have the maximum vdis */

#define SD_RES_VER_MISMATCH  0x14 /* Protocol version mismatch */

#define SD_RES_NO_SPACE      0x15 /* Server has no room for new objects */

#define SD_RES_WAIT_FOR_FORMAT  0x16 /* Waiting for a format operation */

#define SD_RES_WAIT_FOR_JOIN    0x17 /* Waiting for other nodes joining */

#define SD_RES_JOIN_FAILED   0x18 /* Target node had failed to join sheepdog */

#define SD_RES_HALT          0x19 /* Sheepdog is stopped serving IO request */

#define SD_RES_READONLY      0x1A /* Object is read-only */

/*

 * Object ID rules

 *

 *  0 - 19 (20 bits): data object space

 * 20 - 31 (12 bits): reserved data object space

 * 32 - 55 (24 bits): vdi object space

 * 56 - 59 ( 4 bits): reserved vdi object space

 * 60 - 63 ( 4 bits): object type identifier space

 */

#define VDI_SPACE_SHIFT   32

#define VDI_BIT (UINT64_C(1) << 63)

#define VMSTATE_BIT (UINT64_C(1) << 62)

#define MAX_DATA_OBJS (UINT64_C(1) << 20)

#define MAX_CHILDREN 1024

#define SD_MAX_VDI_LEN 256

#define SD_MAX_VDI_TAG_LEN 256

#define SD_NR_VDIS   (1U << 24)

#define SD_DATA_OBJ_SIZE (UINT64_C(1) << 22)

#define SD_MAX_VDI_SIZE (SD_DATA_OBJ_SIZE * MAX_DATA_OBJS)

#define SD_INODE_SIZE (sizeof(SheepdogInode))

#define CURRENT_VDI_ID 0

typedef struct SheepdogReq {

    uint8_t proto_ver;

    uint8_t opcode;

    uint16_t flags;

    uint32_t epoch;

    uint32_t id;

    uint32_t data_length;

    uint32_t opcode_specific[8];

} SheepdogReq;

typedef struct SheepdogRsp {

    uint8_t proto_ver;

    uint8_t opcode;

    uint16_t flags;

    uint32_t epoch;

    uint32_t id;

    uint32_t data_length;

    uint32_t result;

    uint32_t opcode_specific[7];

} SheepdogRsp;

typedef struct SheepdogObjReq {

    uint8_t proto_ver;

    uint8_t opcode;

    uint16_t flags;

    uint32_t epoch;

    uint32_t id;

    uint32_t data_length;

    uint64_t oid;

    uint64_t cow_oid;

    uint32_t copies;

    uint32_t rsvd;

    uint64_t offset;

} SheepdogObjReq;

typedef struct SheepdogObjRsp {

    uint8_t proto_ver;

    uint8_t opcode;

    uint16_t flags;

    uint32_t epoch;

    uint32_t id;

    uint32_t data_length;

    uint32_t result;

    uint32_t copies;

    uint32_t pad[6];

} SheepdogObjRsp;

typedef struct SheepdogVdiReq {

    uint8_t proto_ver;

    uint8_t opcode;

    uint16_t flags;

    uint32_t epoch;

    uint32_t id;

    uint32_t data_length;

    uint64_t vdi_size;

    uint32_t vdi_id;

    uint32_t copies;

    uint32_t snapid;

    uint32_t pad[3];

} SheepdogVdiReq;

typedef struct SheepdogVdiRsp {

    uint8_t proto_ver;

    uint8_t opcode;

    uint16_t flags;

    uint32_t epoch;

    uint32_t id;

    uint32_t data_length;

    uint32_t result;

    uint32_t rsvd;

    uint32_t vdi_id;

    uint32_t pad[5];

} SheepdogVdiRsp;

typedef struct SheepdogInode {

    char name[SD_MAX_VDI_LEN];

    char tag[SD_MAX_VDI_TAG_LEN];

    uint64_t ctime;

    uint64_t snap_ctime;

    uint64_t vm_clock_nsec;

    uint64_t vdi_size;

    uint64_t vm_state_size;

    uint16_t copy_policy;

    uint8_t nr_copies;

    uint8_t block_size_shift;

    uint32_t snap_id;

    uint32_t vdi_id;

    uint32_t parent_vdi_id;

    uint32_t child_vdi_id[MAX_CHILDREN];

    uint32_t data_vdi_id[MAX_DATA_OBJS];

} SheepdogInode;

/*

 * 64 bit FNV-1a non-zero initial basis

 */

#define FNV1A_64_INIT ((uint64_t)0xcbf29ce484222325ULL)

/*

 * 64 bit Fowler/Noll/Vo FNV-1a hash code

 */

static inline uint64_t fnv_64a_buf(void *buf, size_t len, uint64_t hval)

{

    unsigned char *bp = buf;

    unsigned char *be = bp + len;

    while (bp < be) {

        hval ^= (uint64_t) *bp++;

        hval += (hval << 1) + (hval << 4) + (hval << 5) +

            (hval << 7) + (hval << 8) + (hval << 40);

    }

    return hval;

}

static inline bool is_data_obj_writable(SheepdogInode *inode, unsigned int idx)

{

    return inode->vdi_id == inode->data_vdi_id[idx];

}

static inline bool is_data_obj(uint64_t oid)

{

    return !(VDI_BIT & oid);

}

static inline uint64_t data_oid_to_idx(uint64_t oid)

{

    return oid & (MAX_DATA_OBJS - 1);

}

static inline uint64_t vid_to_vdi_oid(uint32_t vid)

{

    return VDI_BIT | ((uint64_t)vid << VDI_SPACE_SHIFT);

}

static inline uint64_t vid_to_vmstate_oid(uint32_t vid, uint32_t idx)

{

    return VMSTATE_BIT | ((uint64_t)vid << VDI_SPACE_SHIFT) | idx;

}

static inline uint64_t vid_to_data_oid(uint32_t vid, uint32_t idx)

{

    return ((uint64_t)vid << VDI_SPACE_SHIFT) | idx;

}

static inline bool is_snapshot(struct SheepdogInode *inode)

{

    return !!inode->snap_ctime;

}

#undef dprintf

#ifdef DEBUG_SDOG

#define dprintf(fmt, args...)                                       \

    do {                                                            \

        fprintf(stdout, "%s %d: " fmt, __func__, __LINE__, ##args); \

    } while (0)

#else

#define dprintf(fmt, args...)

#endif

typedef struct SheepdogAIOCB SheepdogAIOCB;

typedef struct AIOReq {

    SheepdogAIOCB *aiocb;

    unsigned int iov_offset;

    uint64_t oid;

    uint64_t base_oid;

    uint64_t offset;

    unsigned int data_len;

    uint8_t flags;

    uint32_t id;

    QLIST_ENTRY(AIOReq) aio_siblings;

} AIOReq;

enum AIOCBState {

    AIOCB_WRITE_UDATA,

    AIOCB_READ_UDATA,

    AIOCB_FLUSH_CACHE,

    AIOCB_DISCARD_OBJ,

};

struct SheepdogAIOCB {

    BlockDriverAIOCB common;

    QEMUIOVector *qiov;

    int64_t sector_num;

    int nb_sectors;

    int ret;

    enum AIOCBState aiocb_type;

    Coroutine *coroutine;

    void (*aio_done_func)(SheepdogAIOCB *);

    bool canceled;

    int nr_pending;

};

typedef struct BDRVSheepdogState {

    SheepdogInode inode;

    uint32_t min_dirty_data_idx;

    uint32_t max_dirty_data_idx;

    char name[SD_MAX_VDI_LEN];

    bool is_snapshot;

    uint32_t cache_flags;

    bool discard_supported;

    char *host_spec;

    bool is_unix;

    int fd;

    CoMutex lock;

    Coroutine *co_send;

    Coroutine *co_recv;

    uint32_t aioreq_seq_num;

    QLIST_HEAD(inflight_aio_head, AIOReq) inflight_aio_head;

    QLIST_HEAD(pending_aio_head, AIOReq) pending_aio_head;

} BDRVSheepdogState;

static const char * sd_strerror(int err)

{

    int i;

    static const struct {

        int err;

        const char *desc;

    } errors[] = {

        {SD_RES_SUCCESS, "Success"},

        {SD_RES_UNKNOWN, "Unknown error"},

        {SD_RES_NO_OBJ, "No object found"},

        {SD_RES_EIO, "I/O error"},

        {SD_RES_VDI_EXIST, "VDI exists already"},

        {SD_RES_INVALID_PARMS, "Invalid parameters"},

        {SD_RES_SYSTEM_ERROR, "System error"},

        {SD_RES_VDI_LOCKED, "VDI is already locked"},

        {SD_RES_NO_VDI, "No vdi found"},

        {SD_RES_NO_BASE_VDI, "No base VDI found"},

        {SD_RES_VDI_READ, "Failed read the requested VDI"},

        {SD_RES_VDI_WRITE, "Failed to write the requested VDI"},

        {SD_RES_BASE_VDI_READ, "Failed to read the base VDI"},

        {SD_RES_BASE_VDI_WRITE, "Failed to write the base VDI"},

        {SD_RES_NO_TAG, "Failed to find the requested tag"},

        {SD_RES_STARTUP, "The system is still booting"},

        {SD_RES_VDI_NOT_LOCKED, "VDI isn't locked"},

        {SD_RES_SHUTDOWN, "The system is shutting down"},

        {SD_RES_NO_MEM, "Out of memory on the server"},

        {SD_RES_FULL_VDI, "We already have the maximum vdis"},

        {SD_RES_VER_MISMATCH, "Protocol version mismatch"},

        {SD_RES_NO_SPACE, "Server has no space for new objects"},

        {SD_RES_WAIT_FOR_FORMAT, "Sheepdog is waiting for a format operation"},

        {SD_RES_WAIT_FOR_JOIN, "Sheepdog is waiting for other nodes joining"},

        {SD_RES_JOIN_FAILED, "Target node had failed to join sheepdog"},

        {SD_RES_HALT, "Sheepdog is stopped serving IO request"},

        {SD_RES_READONLY, "Object is read-only"},

    };

    for (i = 0; i < ARRAY_SIZE(errors); ++i) {

        if (errors[i].err == err) {

            return errors[i].desc;

        }

    }

    return "Invalid error code";

}

/*

 * Sheepdog I/O handling:

 *

 * 1. In sd_co_rw_vector, we send the I/O requests to the server and

 *    link the requests to the inflight_list in the

 *    BDRVSheepdogState.  The function exits without waiting for

 *    receiving the response.

 *

 * 2. We receive the response in aio_read_response, the fd handler to

 *    the sheepdog connection.  If metadata update is needed, we send

 *    the write request to the vdi object in sd_write_done, the write

 *    completion function.  We switch back to sd_co_readv/writev after

 *    all the requests belonging to the AIOCB are finished.

 */

static inline AIOReq *alloc_aio_req(BDRVSheepdogState *s, SheepdogAIOCB *acb,

                                    uint64_t oid, unsigned int data_len,

                                    uint64_t offset, uint8_t flags,

                                    uint64_t base_oid, unsigned int iov_offset)

{

    AIOReq *aio_req;

    aio_req = g_malloc(sizeof(*aio_req));

    aio_req->aiocb = acb;

    aio_req->iov_offset = iov_offset;

    aio_req->oid = oid;

    aio_req->base_oid = base_oid;

    aio_req->offset = offset;

    aio_req->data_len = data_len;

    aio_req->flags = flags;

    aio_req->id = s->aioreq_seq_num++;

    acb->nr_pending++;

    return aio_req;

}

static inline void free_aio_req(BDRVSheepdogState *s, AIOReq *aio_req)

{

    SheepdogAIOCB *acb = aio_req->aiocb;

    QLIST_REMOVE(aio_req, aio_siblings);

    g_free(aio_req);

    acb->nr_pending--;

}

static void coroutine_fn sd_finish_aiocb(SheepdogAIOCB *acb)

{

    if (!acb->canceled) {

        qemu_coroutine_enter(acb->coroutine, NULL);

    }

    qemu_aio_release(acb);

}

static void sd_aio_cancel(BlockDriverAIOCB *blockacb)

{

    SheepdogAIOCB *acb = (SheepdogAIOCB *)blockacb;

    /*

     * Sheepdog cannot cancel the requests which are already sent to

     * the servers, so we just complete the request with -EIO here.

     */

    acb->ret = -EIO;

    qemu_coroutine_enter(acb->coroutine, NULL);

    acb->canceled = true;

}

static const AIOCBInfo sd_aiocb_info = {

    .aiocb_size = sizeof(SheepdogAIOCB),

    .cancel = sd_aio_cancel,

};

static SheepdogAIOCB *sd_aio_setup(BlockDriverState *bs, QEMUIOVector *qiov,

                                   int64_t sector_num, int nb_sectors)

{

    SheepdogAIOCB *acb;

    acb = qemu_aio_get(&sd_aiocb_info, bs, NULL, NULL);

    acb->qiov = qiov;

    acb->sector_num = sector_num;

    acb->nb_sectors = nb_sectors;

    acb->aio_done_func = NULL;

    acb->canceled = false;

    acb->coroutine = qemu_coroutine_self();

    acb->ret = 0;

    acb->nr_pending = 0;

    return acb;

}

static int connect_to_sdog(BDRVSheepdogState *s)

{

    int fd;

    Error *err = NULL;

    if (s->is_unix) {

        fd = unix_connect(s->host_spec, &err);

    } else {

        fd = inet_connect(s->host_spec, &err);

        if (err == NULL) {

            int ret = socket_set_nodelay(fd);

            if (ret < 0) {

                error_report("%s", strerror(errno));

            }

        }

    }

    if (err != NULL) {

        qerror_report_err(err);

        error_free(err);

    } else {

        qemu_set_nonblock(fd);

    }

    return fd;

}

static coroutine_fn int send_co_req(int sockfd, SheepdogReq *hdr, void *data,

                                    unsigned int *wlen)

{

    int ret;

    ret = qemu_co_send(sockfd, hdr, sizeof(*hdr));

    if (ret < sizeof(*hdr)) {

        error_report("failed to send a req, %s", strerror(errno));

        return ret;

    }

    ret = qemu_co_send(sockfd, data, *wlen);

    if (ret < *wlen) {

        error_report("failed to send a req, %s", strerror(errno));

    }

    return ret;

}

static void restart_co_req(void *opaque)

{

    Coroutine *co = opaque;

    qemu_coroutine_enter(co, NULL);

}

static int have_co_req(void *opaque)

{

    /* this handler is set only when there is a pending request, so

     * always returns 1. */

    return 1;

}

typedef struct SheepdogReqCo {

    int sockfd;

    SheepdogReq *hdr;

    void *data;

    unsigned int *wlen;

    unsigned int *rlen;

    int ret;

    bool finished;

} SheepdogReqCo;

static coroutine_fn void do_co_req(void *opaque)

{

    int ret;

    Coroutine *co;

    SheepdogReqCo *srco = opaque;

    int sockfd = srco->sockfd;

    SheepdogReq *hdr = srco->hdr;

    void *data = srco->data;

    unsigned int *wlen = srco->wlen;

    unsigned int *rlen = srco->rlen;

    co = qemu_coroutine_self();

    qemu_aio_set_fd_handler(sockfd, NULL, restart_co_req, have_co_req, co);

    ret = send_co_req(sockfd, hdr, data, wlen);

    if (ret < 0) {

        goto out;

    }

    qemu_aio_set_fd_handler(sockfd, restart_co_req, NULL, have_co_req, co);

    ret = qemu_co_recv(sockfd, hdr, sizeof(*hdr));

    if (ret < sizeof(*hdr)) {

        error_report("failed to get a rsp, %s", strerror(errno));

        ret = -errno;

        goto out;

    }

    if (*rlen > hdr->data_length) {

        *rlen = hdr->data_length;

    }

    if (*rlen) {

        ret = qemu_co_recv(sockfd, data, *rlen);

        if (ret < *rlen) {

            error_report("failed to get the data, %s", strerror(errno));

            ret = -errno;

            goto out;

        }

    }

    ret = 0;

out:

    /* there is at most one request for this sockfd, so it is safe to

     * set each handler to NULL. */

    qemu_aio_set_fd_handler(sockfd, NULL, NULL, NULL, NULL);

    srco->ret = ret;

    srco->finished = true;

}

static int do_req(int sockfd, SheepdogReq *hdr, void *data,

                  unsigned int *wlen, unsigned int *rlen)

{

    Coroutine *co;

    SheepdogReqCo srco = {

        .sockfd = sockfd,

        .hdr = hdr,

        .data = data,

        .wlen = wlen,

        .rlen = rlen,

        .ret = 0,

        .finished = false,

    };

    if (qemu_in_coroutine()) {

        do_co_req(&srco);

    } else {

        co = qemu_coroutine_create(do_co_req);

        qemu_coroutine_enter(co, &srco);

        while (!srco.finished) {

            qemu_aio_wait();

        }

    }

    return srco.ret;

}

static int coroutine_fn add_aio_request(BDRVSheepdogState *s, AIOReq *aio_req,

                           struct iovec *iov, int niov, bool create,

                           enum AIOCBState aiocb_type);

static int coroutine_fn resend_aioreq(BDRVSheepdogState *s, AIOReq *aio_req);

static AIOReq *find_pending_req(BDRVSheepdogState *s, uint64_t oid)

{

    AIOReq *aio_req;

    QLIST_FOREACH(aio_req, &s->pending_aio_head, aio_siblings) {

        if (aio_req->oid == oid) {

            return aio_req;

        }

    }

    return NULL;

}

/*

 * This function searchs pending requests to the object `oid', and

 * sends them.

 */

static void coroutine_fn send_pending_req(BDRVSheepdogState *s, uint64_t oid)

{

    AIOReq *aio_req;

    SheepdogAIOCB *acb;

    int ret;

    while ((aio_req = find_pending_req(s, oid)) != NULL) {

        acb = aio_req->aiocb;

        /* move aio_req from pending list to inflight one */

        QLIST_REMOVE(aio_req, aio_siblings);

        QLIST_INSERT_HEAD(&s->inflight_aio_head, aio_req, aio_siblings);

        ret = add_aio_request(s, aio_req, acb->qiov->iov,

                              acb->qiov->niov, false, acb->aiocb_type);

        if (ret < 0) {

            error_report("add_aio_request is failed");

            free_aio_req(s, aio_req);

            if (!acb->nr_pending) {

                sd_finish_aiocb(acb);

            }

        }

    }

}

/*

 * Receive responses of the I/O requests.

 *

 * This function is registered as a fd handler, and called from the

 * main loop when s->fd is ready for reading responses.

 */

static void coroutine_fn aio_read_response(void *opaque)

{

    SheepdogObjRsp rsp;

    BDRVSheepdogState *s = opaque;

    int fd = s->fd;

    int ret;

    AIOReq *aio_req = NULL;

    SheepdogAIOCB *acb;

    uint64_t idx;

    if (QLIST_EMPTY(&s->inflight_aio_head)) {

        goto out;

    }

    /* read a header */

    ret = qemu_co_recv(fd, &rsp, sizeof(rsp));

    if (ret < 0) {

        error_report("failed to get the header, %s", strerror(errno));

        goto out;

    }

    /* find the right aio_req from the inflight aio list */

    QLIST_FOREACH(aio_req, &s->inflight_aio_head, aio_siblings) {

        if (aio_req->id == rsp.id) {

            break;

        }

    }

    if (!aio_req) {

        error_report("cannot find aio_req %x", rsp.id);

        goto out;

    }

    acb = aio_req->aiocb;

    switch (acb->aiocb_type) {

    case AIOCB_WRITE_UDATA:

        /* this coroutine context is no longer suitable for co_recv

         * because we may send data to update vdi objects */

        s->co_recv = NULL;

        if (!is_data_obj(aio_req->oid)) {

            break;

        }

        idx = data_oid_to_idx(aio_req->oid);

        if (s->inode.data_vdi_id[idx] != s->inode.vdi_id) {

            /*

             * If the object is newly created one, we need to update

             * the vdi object (metadata object).  min_dirty_data_idx

             * and max_dirty_data_idx are changed to include updated

             * index between them.

             */

            if (rsp.result == SD_RES_SUCCESS) {

                s->inode.data_vdi_id[idx] = s->inode.vdi_id;

                s->max_dirty_data_idx = MAX(idx, s->max_dirty_data_idx);

                s->min_dirty_data_idx = MIN(idx, s->min_dirty_data_idx);

            }

            /*

             * Some requests may be blocked because simultaneous

             * create requests are not allowed, so we search the

             * pending requests here.

             */

            send_pending_req(s, aio_req->oid);

        }

        break;

    case AIOCB_READ_UDATA:

        ret = qemu_co_recvv(fd, acb->qiov->iov, acb->qiov->niov,

                            aio_req->iov_offset, rsp.data_length);

        if (ret < 0) {

            error_report("failed to get the data, %s", strerror(errno));

            goto out;

        }

        break;

    case AIOCB_FLUSH_CACHE:

        if (rsp.result == SD_RES_INVALID_PARMS) {

            dprintf("disable cache since the server doesn't support it\n");

            s->cache_flags = SD_FLAG_CMD_DIRECT;

            rsp.result = SD_RES_SUCCESS;

        }

        break;

    case AIOCB_DISCARD_OBJ:

        switch (rsp.result) {

        case SD_RES_INVALID_PARMS:

            error_report("sheep(%s) doesn't support discard command",

                         s->host_spec);

            rsp.result = SD_RES_SUCCESS;

            s->discard_supported = false;

            break;

        case SD_RES_SUCCESS:

            idx = data_oid_to_idx(aio_req->oid);

            s->inode.data_vdi_id[idx] = 0;

            break;

        default:

            break;

        }

    }

    switch (rsp.result) {

    case SD_RES_SUCCESS:

        break;

    case SD_RES_READONLY:

        ret = resend_aioreq(s, aio_req);

        if (ret == SD_RES_SUCCESS) {

            goto out;

        }

        /* fall through */

    default:

        acb->ret = -EIO;

        error_report("%s", sd_strerror(rsp.result));

        break;

    }

    free_aio_req(s, aio_req);

    if (!acb->nr_pending) {

        /*

         * We've finished all requests which belong to the AIOCB, so

         * we can switch back to sd_co_readv/writev now.

         */

        acb->aio_done_func(acb);

    }

out:

    s->co_recv = NULL;

}

static void co_read_response(void *opaque)

{

    BDRVSheepdogState *s = opaque;

    if (!s->co_recv) {

        s->co_recv = qemu_coroutine_create(aio_read_response);

    }

    qemu_coroutine_enter(s->co_recv, opaque);

}

static void co_write_request(void *opaque)

{

    BDRVSheepdogState *s = opaque;

    qemu_coroutine_enter(s->co_send, NULL);

}

static int aio_flush_request(void *opaque)

{

    BDRVSheepdogState *s = opaque;

    return !QLIST_EMPTY(&s->inflight_aio_head) ||

        !QLIST_EMPTY(&s->pending_aio_head);

}

/*

 * Return a socket discriptor to read/write objects.

 *

 * We cannot use this discriptor for other operations because

 * the block driver may be on waiting response from the server.

 */

static int get_sheep_fd(BDRVSheepdogState *s)

{

    int fd;

    fd = connect_to_sdog(s);

    if (fd < 0) {

        return fd;

    }

    qemu_aio_set_fd_handler(fd, co_read_response, NULL, aio_flush_request, s);

    return fd;

}

static int sd_parse_uri(BDRVSheepdogState *s, const char *filename,

                        char *vdi, uint32_t *snapid, char *tag)

{

    URI *uri;

    QueryParams *qp = NULL;

    int ret = 0;

    uri = uri_parse(filename);

    if (!uri) {

        return -EINVAL;

    }

    /* transport */

    if (!strcmp(uri->scheme, "sheepdog")) {

        s->is_unix = false;

    } else if (!strcmp(uri->scheme, "sheepdog+tcp")) {

        s->is_unix = false;

    } else if (!strcmp(uri->scheme, "sheepdog+unix")) {

        s->is_unix = true;

    } else {

        ret = -EINVAL;

        goto out;

    }

    if (uri->path == NULL || !strcmp(uri->path, "/")) {

        ret = -EINVAL;

        goto out;

    }

    pstrcpy(vdi, SD_MAX_VDI_LEN, uri->path + 1);

    qp = query_params_parse(uri->query);

    if (qp->n > 1 || (s->is_unix && !qp->n) || (!s->is_unix && qp->n)) {

        ret = -EINVAL;

        goto out;

    }

    if (s->is_unix) {

        /* sheepdog+unix:///vdiname?socket=path */

        if (uri->server || uri->port || strcmp(qp->p[0].name, "socket")) {

            ret = -EINVAL;

            goto out;

        }

        s->host_spec = g_strdup(qp->p[0].value);

    } else {

        /* sheepdog[+tcp]://[host:port]/vdiname */

        s->host_spec = g_strdup_printf("%s:%d", uri->server ?: SD_DEFAULT_ADDR,

                                       uri->port ?: SD_DEFAULT_PORT);

    }

    /* snapshot tag */

    if (uri->fragment) {

        *snapid = strtoul(uri->fragment, NULL, 10);

        if (*snapid == 0) {

            pstrcpy(tag, SD_MAX_VDI_TAG_LEN, uri->fragment);

        }

    } else {

        *snapid = CURRENT_VDI_ID; /* search current vdi */

    }

out:

    if (qp) {

        query_params_free(qp);

    }

    uri_free(uri);

    return ret;

}

/*

 * Parse a filename (old syntax)

 *

 * filename must be one of the following formats:

 *   1. [vdiname]

 *   2. [vdiname]:[snapid]

 *   3. [vdiname]:[tag]

 *   4. [hostname]:[port]:[vdiname]

 *   5. [hostname]:[port]:[vdiname]:[snapid]

 *   6. [hostname]:[port]:[vdiname]:[tag]

 *

 * You can boot from the snapshot images by specifying `snapid` or

 * `tag'.

 *

 * You can run VMs outside the Sheepdog cluster by specifying

 * `hostname' and `port' (experimental).

 */

static int parse_vdiname(BDRVSheepdogState *s, const char *filename,

                         char *vdi, uint32_t *snapid, char *tag)

{

    char *p, *q, *uri;

    const char *host_spec, *vdi_spec;

    int nr_sep, ret;

    strstart(filename, "sheepdog:", (const char **)&filename);

    p = q = g_strdup(filename);

    /* count the number of separators */

    nr_sep = 0;

    while (*p) {

        if (*p == ':') {

            nr_sep++;

        }

        p++;

    }

    p = q;

    /* use the first two tokens as host_spec. */

    if (nr_sep >= 2) {

        host_spec = p;

        p = strchr(p, ':');

        p++;

        p = strchr(p, ':');

        *p++ = '\0';

    } else {

        host_spec = "";

    }

    vdi_spec = p;

    p = strchr(vdi_spec, ':');

    if (p) {

        *p++ = '#';

    }

    uri = g_strdup_printf("sheepdog://%s/%s", host_spec, vdi_spec);

    ret = sd_parse_uri(s, uri, vdi, snapid, tag);

    g_free(q);

    g_free(uri);

    return ret;

}

static int find_vdi_name(BDRVSheepdogState *s, const char *filename,

                         uint32_t snapid, const char *tag, uint32_t *vid,

                         bool lock)

{

    int ret, fd;

    SheepdogVdiReq hdr;

    SheepdogVdiRsp *rsp = (SheepdogVdiRsp *)&hdr;

    unsigned int wlen, rlen = 0;

    char buf[SD_MAX_VDI_LEN + SD_MAX_VDI_TAG_LEN];

    fd = connect_to_sdog(s);

    if (fd < 0) {

        return fd;

    }

    /* This pair of strncpy calls ensures that the buffer is zero-filled,

     * which is desirable since we'll soon be sending those bytes, and

     * don't want the send_req to read uninitialized data.

     */

    strncpy(buf, filename, SD_MAX_VDI_LEN);

    strncpy(buf + SD_MAX_VDI_LEN, tag, SD_MAX_VDI_TAG_LEN);

    memset(&hdr, 0, sizeof(hdr));

    if (lock) {

        hdr.opcode = SD_OP_LOCK_VDI;

    } else {

        hdr.opcode = SD_OP_GET_VDI_INFO;

    }

    wlen = SD_MAX_VDI_LEN + SD_MAX_VDI_TAG_LEN;

    hdr.proto_ver = SD_PROTO_VER;

    hdr.data_length = wlen;

    hdr.snapid = snapid;

    hdr.flags = SD_FLAG_CMD_WRITE;

    ret = do_req(fd, (SheepdogReq *)&hdr, buf, &wlen, &rlen);

    if (ret) {

        goto out;

    }

    if (rsp->result != SD_RES_SUCCESS) {

        error_report("cannot get vdi info, %s, %s %d %s",

                     sd_strerror(rsp->result), filename, snapid, tag);

        if (rsp->result == SD_RES_NO_VDI) {

            ret = -ENOENT;

        } else {

            ret = -EIO;

        }

        goto out;

    }

    *vid = rsp->vdi_id;

    ret = 0;

out:

    closesocket(fd);

    return ret;

}

static int coroutine_fn add_aio_request(BDRVSheepdogState *s, AIOReq *aio_req,

                           struct iovec *iov, int niov, bool create,

                           enum AIOCBState aiocb_type)

{

    int nr_copies = s->inode.nr_copies;

    SheepdogObjReq hdr;

    unsigned int wlen = 0;

    int ret;

    uint64_t oid = aio_req->oid;

    unsigned int datalen = aio_req->data_len;

    uint64_t offset = aio_req->offset;

    uint8_t flags = aio_req->flags;

    uint64_t old_oid = aio_req->base_oid;

    if (!nr_copies) {

        error_report("bug");

    }

    memset(&hdr, 0, sizeof(hdr));

    switch (aiocb_type) {

    case AIOCB_FLUSH_CACHE:

        hdr.opcode = SD_OP_FLUSH_VDI;

        break;

    case AIOCB_READ_UDATA:

        hdr.opcode = SD_OP_READ_OBJ;

        hdr.flags = flags;

        break;

    case AIOCB_WRITE_UDATA:

        if (create) {

            hdr.opcode = SD_OP_CREATE_AND_WRITE_OBJ;

        } else {

            hdr.opcode = SD_OP_WRITE_OBJ;

        }

        wlen = datalen;

        hdr.flags = SD_FLAG_CMD_WRITE | flags;

        break;

    case AIOCB_DISCARD_OBJ:

        hdr.opcode = SD_OP_DISCARD_OBJ;

        break;

    }

    if (s->cache_flags) {

        hdr.flags |= s->cache_flags;

    }

    hdr.oid = oid;

    hdr.cow_oid = old_oid;

    hdr.copies = s->inode.nr_copies;

    hdr.data_length = datalen;

    hdr.offset = offset;

    hdr.id = aio_req->id;

    qemu_co_mutex_lock(&s->lock);

    s->co_send = qemu_coroutine_self();

    qemu_aio_set_fd_handler(s->fd, co_read_response, co_write_request,

                            aio_flush_request, s);

    socket_set_cork(s->fd, 1);

    /* send a header */

    ret = qemu_co_send(s->fd, &hdr, sizeof(hdr));

    if (ret < 0) {

        qemu_co_mutex_unlock(&s->lock);

        error_report("failed to send a req, %s", strerror(errno));

        return -errno;

    }

    if (wlen) {

        ret = qemu_co_sendv(s->fd, iov, niov, aio_req->iov_offset, wlen);

        if (ret < 0) {

            qemu_co_mutex_unlock(&s->lock);

            error_report("failed to send a data, %s", strerror(errno));

            return -errno;

        }

    }

    socket_set_cork(s->fd, 0);

    qemu_aio_set_fd_handler(s->fd, co_read_response, NULL,

                            aio_flush_request, s);

    qemu_co_mutex_unlock(&s->lock);

    return 0;

}

static int read_write_object(int fd, char *buf, uint64_t oid, int copies,

                             unsigned int datalen, uint64_t offset,

                             bool write, bool create, uint32_t cache_flags)

{

    SheepdogObjReq hdr;

    SheepdogObjRsp *rsp = (SheepdogObjRsp *)&hdr;

    unsigned int wlen, rlen;

    int ret;

    memset(&hdr, 0, sizeof(hdr));

    if (write) {

        wlen = datalen;

        rlen = 0;

        hdr.flags = SD_FLAG_CMD_WRITE;

        if (create) {

            hdr.opcode = SD_OP_CREATE_AND_WRITE_OBJ;

        } else {

            hdr.opcode = SD_OP_WRITE_OBJ;

        }

    } else {

        wlen = 0;

        rlen = datalen;

        hdr.opcode = SD_OP_READ_OBJ;

    }

    hdr.flags |= cache_flags;

    hdr.oid = oid;

    hdr.data_length = datalen;

    hdr.offset = offset;

    hdr.copies = copies;

    ret = do_req(fd, (SheepdogReq *)&hdr, buf, &wlen, &rlen);

    if (ret) {

        error_report("failed to send a request to the sheep");

        return ret;

    }

    switch (rsp->result) {

    case SD_RES_SUCCESS:

        return 0;

    default:

        error_report("%s", sd_strerror(rsp->result));

        return -EIO;

    }

}

static int read_object(int fd, char *buf, uint64_t oid, int copies,

                       unsigned int datalen, uint64_t offset,

                       uint32_t cache_flags)

{

    return read_write_object(fd, buf, oid, copies, datalen, offset, false,

                             false, cache_flags);

}

static int write_object(int fd, char *buf, uint64_t oid, int copies,

                        unsigned int datalen, uint64_t offset, bool create,

                        uint32_t cache_flags)

{

    return read_write_object(fd, buf, oid, copies, datalen, offset, true,

                             create, cache_flags);

}

/* update inode with the latest state */

static int reload_inode(BDRVSheepdogState *s, uint32_t snapid, const char *tag)

{

    SheepdogInode *inode;

    int ret = 0, fd;

    uint32_t vid = 0;

    fd = connect_to_sdog(s);

    if (fd < 0) {

        return -EIO;

    }

    inode = g_malloc(sizeof(s->inode));

    ret = find_vdi_name(s, s->name, snapid, tag, &vid, false);

    if (ret) {

        goto out;

    }

    ret = read_object(fd, (char *)inode, vid_to_vdi_oid(vid),

                      s->inode.nr_copies, sizeof(*inode), 0, s->cache_flags);

    if (ret < 0) {

        goto out;

    }

    if (inode->vdi_id != s->inode.vdi_id) {

        memcpy(&s->inode, inode, sizeof(s->inode));

    }

out:

    g_free(inode);

    closesocket(fd);

    return ret;

}

static int coroutine_fn resend_aioreq(BDRVSheepdogState *s, AIOReq *aio_req)

{

    SheepdogAIOCB *acb = aio_req->aiocb;

    bool create = false;

    int ret;

    ret = reload_inode(s, 0, "");

    if (ret < 0) {

        return ret;

    }

    aio_req->oid = vid_to_data_oid(s->inode.vdi_id,

                                   data_oid_to_idx(aio_req->oid));

    /* check whether this request becomes a CoW one */

    if (acb->aiocb_type == AIOCB_WRITE_UDATA) {

        int idx = data_oid_to_idx(aio_req->oid);

        AIOReq *areq;

        if (s->inode.data_vdi_id[idx] == 0) {

            create = true;

            goto out;

        }

        if (is_data_obj_writable(&s->inode, idx)) {

            goto out;

        }

        /* link to the pending list if there is another CoW request to

         * the same object */

        QLIST_FOREACH(areq, &s->inflight_aio_head, aio_siblings) {

            if (areq != aio_req && areq->oid == aio_req->oid) {

                dprintf("simultaneous CoW to %" PRIx64 "\n", aio_req->oid);

                QLIST_REMOVE(aio_req, aio_siblings);

                QLIST_INSERT_HEAD(&s->pending_aio_head, aio_req, aio_siblings);

                return SD_RES_SUCCESS;

            }

        }

        aio_req->base_oid = vid_to_data_oid(s->inode.data_vdi_id[idx], idx);

        aio_req->flags |= SD_FLAG_CMD_COW;

        create = true;

    }

out:

    return add_aio_request(s, aio_req, acb->qiov->iov, acb->qiov->niov,

                           create, acb->aiocb_type);

}

/* TODO Convert to fine grained options */

static QemuOptsList runtime_opts = {

    .name = "sheepdog",

    .head = QTAILQ_HEAD_INITIALIZER(runtime_opts.head),

    .desc = {

        {

            .name = "filename",

            .type = QEMU_OPT_STRING,

            .help = "URL to the sheepdog image",

        },

        { /* end of list */ }

    },

};

static int sd_open(BlockDriverState *bs, QDict *options, int flags)

{

    int ret, fd;

    uint32_t vid = 0;

    BDRVSheepdogState *s = bs->opaque;

    char vdi[SD_MAX_VDI_LEN], tag[SD_MAX_VDI_TAG_LEN];

    uint32_t snapid;

    char *buf = NULL;

    QemuOpts *opts;

    Error *local_err = NULL;

    const char *filename;

    opts = qemu_opts_create_nofail(&runtime_opts);

    qemu_opts_absorb_qdict(opts, options, &local_err);

    if (error_is_set(&local_err)) {

        qerror_report_err(local_err);

        error_free(local_err);

        ret = -EINVAL;

        goto out;

    }

    filename = qemu_opt_get(opts, "filename");

    QLIST_INIT(&s->inflight_aio_head);

    QLIST_INIT(&s->pending_aio_head);

    s->fd = -1;

    memset(vdi, 0, sizeof(vdi));

    memset(tag, 0, sizeof(tag));

    if (strstr(filename, "://")) {

        ret = sd_parse_uri(s, filename, vdi, &snapid, tag);

    } else {

        ret = parse_vdiname(s, filename, vdi, &snapid, tag);

    }

    if (ret < 0) {

        goto out;

    }

    s->fd = get_sheep_fd(s);

    if (s->fd < 0) {

        ret = s->fd;

        goto out;

    }

    ret = find_vdi_name(s, vdi, snapid, tag, &vid, true);

    if (ret) {

        goto out;

    }

    /*

     * QEMU block layer emulates writethrough cache as 'writeback + flush', so

     * we always set SD_FLAG_CMD_CACHE (writeback cache) as default.

     */

    s->cache_flags = SD_FLAG_CMD_CACHE;

    if (flags & BDRV_O_NOCACHE) {

        s->cache_flags = SD_FLAG_CMD_DIRECT;

    }

    s->discard_supported = true;

    if (snapid || tag[0] != '\0') {

        dprintf("%" PRIx32 " snapshot inode was open.\n", vid);

        s->is_snapshot = true;

    }

    fd = connect_to_sdog(s);

    if (fd < 0) {

        ret = fd;

        goto out;

    }

    buf = g_malloc(SD_INODE_SIZE);

    ret = read_object(fd, buf, vid_to_vdi_oid(vid), 0, SD_INODE_SIZE, 0,

                      s->cache_flags);

    closesocket(fd);

    if (ret) {

        goto out;

    }

    memcpy(&s->inode, buf, sizeof(s->inode));

    s->min_dirty_data_idx = UINT32_MAX;

    s->max_dirty_data_idx = 0;

    bs->total_sectors = s->inode.vdi_size / BDRV_SECTOR_SIZE;

    pstrcpy(s->name, sizeof(s->name), vdi);

    qemu_co_mutex_init(&s->lock);

    qemu_opts_del(opts);

    g_free(buf);

    return 0;

out: