qemu/hw/block/virtio-blk.c

   1 /*
   2  * Virtio Block Device
   3  *
   4  * Copyright IBM, Corp. 2007
   5  *
   6  * Authors:
   7  *  Anthony Liguori   <aliguori@us.ibm.com>
   8  *
   9  * This work is licensed under the terms of the GNU GPL, version 2.  See
  10  * the COPYING file in the top-level directory.
  11  *
  12  */
  13
  14 #include "qemu-common.h"
  15 #include "qemu/iov.h"
  16 #include "qemu/error-report.h"
  17 #include "trace.h"
  18 #include "hw/block/block.h"
  19 #include "sysemu/block-backend.h"
  20 #include "sysemu/blockdev.h"
  21 #include "hw/virtio/virtio-blk.h"
  22 #include "dataplane/virtio-blk.h"
  23 #include "migration/migration.h"
  24 #include "block/scsi.h"
  25 #ifdef __linux__
  26 # include <scsi/sg.h>
  27 #endif
  28 #include "hw/virtio/virtio-bus.h"
  29 #include "hw/virtio/virtio-access.h"
  30
  31 VirtIOBlockReq *virtio_blk_alloc_request(VirtIOBlock *s)
  32 {
  33     VirtIOBlockReq *req = g_slice_new(VirtIOBlockReq);
  34     req->dev = s;
  35     req->qiov.size = 0;
  36     req->in_len = 0;
  37     req->next = NULL;
  38     req->mr_next = NULL;
  39     return req;
  40 }
  41
  42 void virtio_blk_free_request(VirtIOBlockReq *req)
  43 {
  44     if (req) {
  45         g_slice_free(VirtIOBlockReq, req);
  46     }
  47 }
  48
  49 static void virtio_blk_complete_request(VirtIOBlockReq *req,
  50                                         unsigned char status)
  51 {
  52     VirtIOBlock *s = req->dev;
  53     VirtIODevice *vdev = VIRTIO_DEVICE(s);
  54
  55     trace_virtio_blk_req_complete(req, status);
  56
  57     stb_p(&req->in->status, status);
  58     virtqueue_push(s->vq, &req->elem, req->in_len);
  59     virtio_notify(vdev, s->vq);
  60 }
  61
  62 static void virtio_blk_req_complete(VirtIOBlockReq *req, unsigned char status)
  63 {
  64     req->dev->complete_request(req, status);
  65 }
  66
  67 static int virtio_blk_handle_rw_error(VirtIOBlockReq *req, int error,
  68     bool is_read)
  69 {
  70     BlockErrorAction action = blk_get_error_action(req->dev->blk,
  71                                                    is_read, error);
  72     VirtIOBlock *s = req->dev;
  73
  74     if (action == BLOCK_ERROR_ACTION_STOP) {
  75         req->next = s->rq;
  76         s->rq = req;
  77     } else if (action == BLOCK_ERROR_ACTION_REPORT) {
  78         virtio_blk_req_complete(req, VIRTIO_BLK_S_IOERR);
  79         block_acct_done(blk_get_stats(s->blk), &req->acct);
  80         virtio_blk_free_request(req);
  81     }
  82
  83     blk_error_action(s->blk, action, is_read, error);
  84     return action != BLOCK_ERROR_ACTION_IGNORE;
  85 }
  86
  87 static void virtio_blk_rw_complete(void *opaque, int ret)
  88 {
  89     VirtIOBlockReq *next = opaque;
  90
  91     while (next) {
  92         VirtIOBlockReq *req = next;
  93         next = req->mr_next;
  94         trace_virtio_blk_rw_complete(req, ret);
  95
  96         if (req->qiov.nalloc != -1) {
  97             /* If nalloc is != 1 req->qiov is a local copy of the original
  98              * external iovec. It was allocated in submit_merged_requests
  99              * to be able to merge requests. */
 100             qemu_iovec_destroy(&req->qiov);
 101         }
 102
 103         if (ret) {
 104             int p = virtio_ldl_p(VIRTIO_DEVICE(req->dev), &req->out.type);
 105             bool is_read = !(p & VIRTIO_BLK_T_OUT);
 106             /* Note that memory may be dirtied on read failure.  If the
 107              * virtio request is not completed here, as is the case for
 108              * BLOCK_ERROR_ACTION_STOP, the memory may not be copied
 109              * correctly during live migration.  While this is ugly,
 110              * it is acceptable because the device is free to write to
 111              * the memory until the request is completed (which will
 112              * happen on the other side of the migration).
 113              */
 114             if (virtio_blk_handle_rw_error(req, -ret, is_read)) {
 115                 continue;
 116             }
 117         }
 118
 119         virtio_blk_req_complete(req, VIRTIO_BLK_S_OK);
 120         block_acct_done(blk_get_stats(req->dev->blk), &req->acct);
 121         virtio_blk_free_request(req);
 122     }
 123 }
 124
 125 static void virtio_blk_flush_complete(void *opaque, int ret)
 126 {
 127     VirtIOBlockReq *req = opaque;
 128
 129     if (ret) {
 130         if (virtio_blk_handle_rw_error(req, -ret, 0)) {
 131             return;
 132         }
 133     }
 134
 135     virtio_blk_req_complete(req, VIRTIO_BLK_S_OK);
 136     block_acct_done(blk_get_stats(req->dev->blk), &req->acct);
 137     virtio_blk_free_request(req);
 138 }
 139
 140 #ifdef __linux__
 141
 142 typedef struct {
 143     VirtIOBlockReq *req;
 144     struct sg_io_hdr hdr;
 145 } VirtIOBlockIoctlReq;
 146
 147 static void virtio_blk_ioctl_complete(void *opaque, int status)
 148 {
 149     VirtIOBlockIoctlReq *ioctl_req = opaque;
 150     VirtIOBlockReq *req = ioctl_req->req;
 151     VirtIODevice *vdev = VIRTIO_DEVICE(req->dev);
 152     struct virtio_scsi_inhdr *scsi;
 153     struct sg_io_hdr *hdr;
 154
 155     scsi = (void *)req->elem.in_sg[req->elem.in_num - 2].iov_base;
 156
 157     if (status) {
 158         status = VIRTIO_BLK_S_UNSUPP;
 159         virtio_stl_p(vdev, &scsi->errors, 255);
 160         goto out;
 161     }
 162
 163     hdr = &ioctl_req->hdr;
 164     /*
 165      * From SCSI-Generic-HOWTO: "Some lower level drivers (e.g. ide-scsi)
 166      * clear the masked_status field [hence status gets cleared too, see
 167      * block/scsi_ioctl.c] even when a CHECK_CONDITION or COMMAND_TERMINATED
 168      * status has occurred.  However they do set DRIVER_SENSE in driver_status
 169      * field. Also a (sb_len_wr > 0) indicates there is a sense buffer.
 170      */
 171     if (hdr->status == 0 && hdr->sb_len_wr > 0) {
 172         hdr->status = CHECK_CONDITION;
 173     }
 174
 175     virtio_stl_p(vdev, &scsi->errors,
 176                  hdr->status | (hdr->msg_status << 8) |
 177                  (hdr->host_status << 16) | (hdr->driver_status << 24));
 178     virtio_stl_p(vdev, &scsi->residual, hdr->resid);
 179     virtio_stl_p(vdev, &scsi->sense_len, hdr->sb_len_wr);
 180     virtio_stl_p(vdev, &scsi->data_len, hdr->dxfer_len);
 181
 182 out:
 183     virtio_blk_req_complete(req, status);
 184     virtio_blk_free_request(req);
 185     g_free(ioctl_req);
 186 }
 187
 188 #endif
 189
 190 static VirtIOBlockReq *virtio_blk_get_request(VirtIOBlock *s)
 191 {
 192     VirtIOBlockReq *req = virtio_blk_alloc_request(s);
 193
 194     if (!virtqueue_pop(s->vq, &req->elem)) {
 195         virtio_blk_free_request(req);
 196         return NULL;
 197     }
 198
 199     return req;
 200 }
 201
 202 static int virtio_blk_handle_scsi_req(VirtIOBlockReq *req)
 203 {
 204     int status = VIRTIO_BLK_S_OK;
 205     struct virtio_scsi_inhdr *scsi = NULL;
 206     VirtIODevice *vdev = VIRTIO_DEVICE(req->dev);
 207     VirtQueueElement *elem = &req->elem;
 208     VirtIOBlock *blk = req->dev;
 209
 210 #ifdef __linux__
 211     int i;
 212     VirtIOBlockIoctlReq *ioctl_req;
 213     BlockAIOCB *acb;
 214 #endif
 215
 216     /*
 217      * We require at least one output segment each for the virtio_blk_outhdr
 218      * and the SCSI command block.
 219      *
 220      * We also at least require the virtio_blk_inhdr, the virtio_scsi_inhdr
 221      * and the sense buffer pointer in the input segments.
 222      */
 223     if (elem->out_num < 2 || elem->in_num < 3) {
 224         status = VIRTIO_BLK_S_IOERR;
 225         goto fail;
 226     }
 227
 228     /*
 229      * The scsi inhdr is placed in the second-to-last input segment, just
 230      * before the regular inhdr.
 231      */
 232     scsi = (void *)elem->in_sg[elem->in_num - 2].iov_base;
 233
 234     if (!blk->conf.scsi) {
 235         status = VIRTIO_BLK_S_UNSUPP;
 236         goto fail;
 237     }
 238
 239     /*
 240      * No support for bidirection commands yet.
 241      */
 242     if (elem->out_num > 2 && elem->in_num > 3) {
 243         status = VIRTIO_BLK_S_UNSUPP;
 244         goto fail;
 245     }
 246
 247 #ifdef __linux__
 248     ioctl_req = g_new0(VirtIOBlockIoctlReq, 1);
 249     ioctl_req->req = req;
 250     ioctl_req->hdr.interface_id = 'S';
 251     ioctl_req->hdr.cmd_len = elem->out_sg[1].iov_len;
 252     ioctl_req->hdr.cmdp = elem->out_sg[1].iov_base;
 253     ioctl_req->hdr.dxfer_len = 0;
 254
 255     if (elem->out_num > 2) {
 256         /*
 257          * If there are more than the minimally required 2 output segments
 258          * there is write payload starting from the third iovec.
 259          */
 260         ioctl_req->hdr.dxfer_direction = SG_DXFER_TO_DEV;
 261         ioctl_req->hdr.iovec_count = elem->out_num - 2;
 262
 263         for (i = 0; i < ioctl_req->hdr.iovec_count; i++) {
 264             ioctl_req->hdr.dxfer_len += elem->out_sg[i + 2].iov_len;
 265         }
 266
 267         ioctl_req->hdr.dxferp = elem->out_sg + 2;
 268
 269     } else if (elem->in_num > 3) {
 270         /*
 271          * If we have more than 3 input segments the guest wants to actually
 272          * read data.
 273          */
 274         ioctl_req->hdr.dxfer_direction = SG_DXFER_FROM_DEV;
 275         ioctl_req->hdr.iovec_count = elem->in_num - 3;
 276         for (i = 0; i < ioctl_req->hdr.iovec_count; i++) {
 277             ioctl_req->hdr.dxfer_len += elem->in_sg[i].iov_len;
 278         }
 279
 280         ioctl_req->hdr.dxferp = elem->in_sg;
 281     } else {
 282         /*
 283          * Some SCSI commands don't actually transfer any data.
 284          */
 285         ioctl_req->hdr.dxfer_direction = SG_DXFER_NONE;
 286     }
 287
 288     ioctl_req->hdr.sbp = elem->in_sg[elem->in_num - 3].iov_base;
 289     ioctl_req->hdr.mx_sb_len = elem->in_sg[elem->in_num - 3].iov_len;
 290
 291     acb = blk_aio_ioctl(blk->blk, SG_IO, &ioctl_req->hdr,
 292                         virtio_blk_ioctl_complete, ioctl_req);
 293     if (!acb) {
 294         g_free(ioctl_req);
 295         status = VIRTIO_BLK_S_UNSUPP;
 296         goto fail;
 297     }
 298     return -EINPROGRESS;
 299 #else
 300     abort();
 301 #endif
 302
 303 fail:
 304     /* Just put anything nonzero so that the ioctl fails in the guest.  */
 305     if (scsi) {
 306         virtio_stl_p(vdev, &scsi->errors, 255);
 307     }
 308     return status;
 309 }
 310
 311 static void virtio_blk_handle_scsi(VirtIOBlockReq *req)
 312 {
 313     int status;
 314
 315     status = virtio_blk_handle_scsi_req(req);
 316     if (status != -EINPROGRESS) {
 317         virtio_blk_req_complete(req, status);
 318         virtio_blk_free_request(req);
 319     }
 320 }
 321
 322 static inline void submit_requests(BlockBackend *blk, MultiReqBuffer *mrb,
 323                                    int start, int num_reqs, int niov)
 324 {
 325     QEMUIOVector *qiov = &mrb->reqs[start]->qiov;
 326     int64_t sector_num = mrb->reqs[start]->sector_num;
 327     int nb_sectors = mrb->reqs[start]->qiov.size / BDRV_SECTOR_SIZE;
 328     bool is_write = mrb->is_write;
 329
 330     if (num_reqs > 1) {
 331         int i;
 332         struct iovec *tmp_iov = qiov->iov;
 333         int tmp_niov = qiov->niov;
 334
 335         /* mrb->reqs[start]->qiov was initialized from external so we can't
 336          * modifiy it here. We need to initialize it locally and then add the
 337          * external iovecs. */
 338         qemu_iovec_init(qiov, niov);
 339
 340         for (i = 0; i < tmp_niov; i++) {
 341             qemu_iovec_add(qiov, tmp_iov[i].iov_base, tmp_iov[i].iov_len);
 342         }
 343
 344         for (i = start + 1; i < start + num_reqs; i++) {
 345             qemu_iovec_concat(qiov, &mrb->reqs[i]->qiov, 0,
 346                               mrb->reqs[i]->qiov.size);
 347             mrb->reqs[i - 1]->mr_next = mrb->reqs[i];
 348             nb_sectors += mrb->reqs[i]->qiov.size / BDRV_SECTOR_SIZE;
 349         }
 350         assert(nb_sectors == qiov->size / BDRV_SECTOR_SIZE);
 351
 352         trace_virtio_blk_submit_multireq(mrb, start, num_reqs, sector_num,
 353                                          nb_sectors, is_write);
 354         block_acct_merge_done(blk_get_stats(blk),
 355                               is_write ? BLOCK_ACCT_WRITE : BLOCK_ACCT_READ,
 356                               num_reqs - 1);
 357     }
 358
 359     if (is_write) {
 360         blk_aio_writev(blk, sector_num, qiov, nb_sectors,
 361                        virtio_blk_rw_complete, mrb->reqs[start]);
 362     } else {
 363         blk_aio_readv(blk, sector_num, qiov, nb_sectors,
 364                       virtio_blk_rw_complete, mrb->reqs[start]);
 365     }
 366 }
 367
 368 static int multireq_compare(const void *a, const void *b)
 369 {
 370     const VirtIOBlockReq *req1 = *(VirtIOBlockReq **)a,
 371                          *req2 = *(VirtIOBlockReq **)b;
 372
 373     /*
 374      * Note that we can't simply subtract sector_num1 from sector_num2
 375      * here as that could overflow the return value.
 376      */
 377     if (req1->sector_num > req2->sector_num) {
 378         return 1;
 379     } else if (req1->sector_num < req2->sector_num) {
 380         return -1;
 381     } else {
 382         return 0;
 383     }
 384 }
 385
 386 void virtio_blk_submit_multireq(BlockBackend *blk, MultiReqBuffer *mrb)
 387 {
 388     int i = 0, start = 0, num_reqs = 0, niov = 0, nb_sectors = 0;
 389     int max_xfer_len = 0;
 390     int64_t sector_num = 0;
 391
 392     if (mrb->num_reqs == 1) {
 393         submit_requests(blk, mrb, 0, 1, -1);
 394         mrb->num_reqs = 0;
 395         return;
 396     }
 397
 398     max_xfer_len = blk_get_max_transfer_length(mrb->reqs[0]->dev->blk);
 399     max_xfer_len = MIN_NON_ZERO(max_xfer_len, BDRV_REQUEST_MAX_SECTORS);
 400
 401     qsort(mrb->reqs, mrb->num_reqs, sizeof(*mrb->reqs),
 402           &multireq_compare);
 403
 404     for (i = 0; i < mrb->num_reqs; i++) {
 405         VirtIOBlockReq *req = mrb->reqs[i];
 406         if (num_reqs > 0) {
 407             bool merge = true;
 408
 409             /* merge would exceed maximum number of IOVs */
 410             if (niov + req->qiov.niov > IOV_MAX) {
 411                 merge = false;
 412             }
 413
 414             /* merge would exceed maximum transfer length of backend device */
 415             if (req->qiov.size / BDRV_SECTOR_SIZE + nb_sectors > max_xfer_len) {
 416                 merge = false;
 417             }
 418
 419             /* requests are not sequential */
 420             if (sector_num + nb_sectors != req->sector_num) {
 421                 merge = false;
 422             }
 423
 424             if (!merge) {
 425                 submit_requests(blk, mrb, start, num_reqs, niov);
 426                 num_reqs = 0;
 427             }
 428         }
 429
 430         if (num_reqs == 0) {
 431             sector_num = req->sector_num;
 432             nb_sectors = niov = 0;
 433             start = i;
 434         }
 435
 436         nb_sectors += req->qiov.size / BDRV_SECTOR_SIZE;
 437         niov += req->qiov.niov;
 438         num_reqs++;
 439     }
 440
 441     submit_requests(blk, mrb, start, num_reqs, niov);
 442     mrb->num_reqs = 0;
 443 }
 444
 445 static void virtio_blk_handle_flush(VirtIOBlockReq *req, MultiReqBuffer *mrb)
 446 {
 447     block_acct_start(blk_get_stats(req->dev->blk), &req->acct, 0,
 448                      BLOCK_ACCT_FLUSH);
 449
 450     /*
 451      * Make sure all outstanding writes are posted to the backing device.
 452      */
 453     if (mrb->is_write && mrb->num_reqs > 0) {
 454         virtio_blk_submit_multireq(req->dev->blk, mrb);
 455     }
 456     blk_aio_flush(req->dev->blk, virtio_blk_flush_complete, req);
 457 }
 458
 459 static bool virtio_blk_sect_range_ok(VirtIOBlock *dev,
 460                                      uint64_t sector, size_t size)
 461 {
 462     uint64_t nb_sectors = size >> BDRV_SECTOR_BITS;
 463     uint64_t total_sectors;
 464
 465     if (nb_sectors > BDRV_REQUEST_MAX_SECTORS) {
 466         return false;
 467     }
 468     if (sector & dev->sector_mask) {
 469         return false;
 470     }
 471     if (size % dev->conf.conf.logical_block_size) {
 472         return false;
 473     }
 474     blk_get_geometry(dev->blk, &total_sectors);
 475     if (sector > total_sectors || nb_sectors > total_sectors - sector) {
 476         return false;
 477     }
 478     return true;
 479 }
 480
 481 void virtio_blk_handle_request(VirtIOBlockReq *req, MultiReqBuffer *mrb)
 482 {
 483     uint32_t type;
 484     struct iovec *in_iov = req->elem.in_sg;
 485     struct iovec *iov = req->elem.out_sg;
 486     unsigned in_num = req->elem.in_num;
 487     unsigned out_num = req->elem.out_num;
 488
 489     if (req->elem.out_num < 1 || req->elem.in_num < 1) {
 490         error_report("virtio-blk missing headers");
 491         exit(1);
 492     }
 493
 494     if (unlikely(iov_to_buf(iov, out_num, 0, &req->out,
 495                             sizeof(req->out)) != sizeof(req->out))) {
 496         error_report("virtio-blk request outhdr too short");
 497         exit(1);
 498     }
 499
 500     iov_discard_front(&iov, &out_num, sizeof(req->out));
 501
 502     if (in_iov[in_num - 1].iov_len < sizeof(struct virtio_blk_inhdr)) {
 503         error_report("virtio-blk request inhdr too short");
 504         exit(1);
 505     }
 506
 507     /* We always touch the last byte, so just see how big in_iov is.  */
 508     req->in_len = iov_size(in_iov, in_num);
 509     req->in = (void *)in_iov[in_num - 1].iov_base
 510               + in_iov[in_num - 1].iov_len
 511               - sizeof(struct virtio_blk_inhdr);
 512     iov_discard_back(in_iov, &in_num, sizeof(struct virtio_blk_inhdr));
 513
 514     type = virtio_ldl_p(VIRTIO_DEVICE(req->dev), &req->out.type);
 515
 516     /* VIRTIO_BLK_T_OUT defines the command direction. VIRTIO_BLK_T_BARRIER
 517      * is an optional flag. Although a guest should not send this flag if
 518      * not negotiated we ignored it in the past. So keep ignoring it. */
 519     switch (type & ~(VIRTIO_BLK_T_OUT | VIRTIO_BLK_T_BARRIER)) {
 520     case VIRTIO_BLK_T_IN:
 521     {
 522         bool is_write = type & VIRTIO_BLK_T_OUT;
 523         req->sector_num = virtio_ldq_p(VIRTIO_DEVICE(req->dev),
 524                                        &req->out.sector);
 525
 526         if (is_write) {
 527             qemu_iovec_init_external(&req->qiov, iov, out_num);
 528             trace_virtio_blk_handle_write(req, req->sector_num,
 529                                           req->qiov.size / BDRV_SECTOR_SIZE);
 530         } else {
 531             qemu_iovec_init_external(&req->qiov, in_iov, in_num);
 532             trace_virtio_blk_handle_read(req, req->sector_num,
 533                                          req->qiov.size / BDRV_SECTOR_SIZE);
 534         }
 535
 536         if (!virtio_blk_sect_range_ok(req->dev, req->sector_num,
 537                                       req->qiov.size)) {
 538             virtio_blk_req_complete(req, VIRTIO_BLK_S_IOERR);
 539             virtio_blk_free_request(req);
 540             return;
 541         }
 542
 543         block_acct_start(blk_get_stats(req->dev->blk),
 544                          &req->acct, req->qiov.size,
 545                          is_write ? BLOCK_ACCT_WRITE : BLOCK_ACCT_READ);
 546
 547         /* merge would exceed maximum number of requests or IO direction
 548          * changes */
 549         if (mrb->num_reqs > 0 && (mrb->num_reqs == VIRTIO_BLK_MAX_MERGE_REQS ||
 550                                   is_write != mrb->is_write ||
 551                                   !req->dev->conf.request_merging)) {
 552             virtio_blk_submit_multireq(req->dev->blk, mrb);
 553         }
 554
 555         assert(mrb->num_reqs < VIRTIO_BLK_MAX_MERGE_REQS);
 556         mrb->reqs[mrb->num_reqs++] = req;
 557         mrb->is_write = is_write;
 558         break;
 559     }
 560     case VIRTIO_BLK_T_FLUSH:
 561         virtio_blk_handle_flush(req, mrb);
 562         break;
 563     case VIRTIO_BLK_T_SCSI_CMD:
 564         virtio_blk_handle_scsi(req);
 565         break;
 566     case VIRTIO_BLK_T_GET_ID:
 567     {
 568         VirtIOBlock *s = req->dev;
 569
 570         /*
 571          * NB: per existing s/n string convention the string is
 572          * terminated by '\0' only when shorter than buffer.
 573          */
 574         const char *serial = s->conf.serial ? s->conf.serial : "";
 575         size_t size = MIN(strlen(serial) + 1,
 576                           MIN(iov_size(in_iov, in_num),
 577                               VIRTIO_BLK_ID_BYTES));
 578         iov_from_buf(in_iov, in_num, 0, serial, size);
 579         virtio_blk_req_complete(req, VIRTIO_BLK_S_OK);
 580         virtio_blk_free_request(req);
 581         break;
 582     }
 583     default:
 584         virtio_blk_req_complete(req, VIRTIO_BLK_S_UNSUPP);
 585         virtio_blk_free_request(req);
 586     }
 587 }
 588
 589 static void virtio_blk_handle_output(VirtIODevice *vdev, VirtQueue *vq)
 590 {
 591     VirtIOBlock *s = VIRTIO_BLK(vdev);
 592     VirtIOBlockReq *req;
 593     MultiReqBuffer mrb = {};
 594
 595     /* Some guests kick before setting VIRTIO_CONFIG_S_DRIVER_OK so start
 596      * dataplane here instead of waiting for .set_status().
 597      */
 598     if (s->dataplane) {
 599         virtio_blk_data_plane_start(s->dataplane);
 600         return;
 601     }
 602
 603     while ((req = virtio_blk_get_request(s))) {
 604         virtio_blk_handle_request(req, &mrb);
 605     }
 606
 607     if (mrb.num_reqs) {
 608         virtio_blk_submit_multireq(s->blk, &mrb);
 609     }
 610 }
 611
 612 static void virtio_blk_dma_restart_bh(void *opaque)
 613 {
 614     VirtIOBlock *s = opaque;
 615     VirtIOBlockReq *req = s->rq;
 616     MultiReqBuffer mrb = {};
 617
 618     qemu_bh_delete(s->bh);
 619     s->bh = NULL;
 620
 621     s->rq = NULL;
 622
 623     while (req) {
 624         VirtIOBlockReq *next = req->next;
 625         virtio_blk_handle_request(req, &mrb);
 626         req = next;
 627     }
 628
 629     if (mrb.num_reqs) {
 630         virtio_blk_submit_multireq(s->blk, &mrb);
 631     }
 632 }
 633
 634 static void virtio_blk_dma_restart_cb(void *opaque, int running,
 635                                       RunState state)
 636 {
 637     VirtIOBlock *s = opaque;
 638
 639     if (!running) {
 640         return;
 641     }
 642
 643     if (!s->bh) {
 644         s->bh = aio_bh_new(blk_get_aio_context(s->conf.conf.blk),
 645                            virtio_blk_dma_restart_bh, s);
 646         qemu_bh_schedule(s->bh);
 647     }
 648 }
 649
 650 static void virtio_blk_reset(VirtIODevice *vdev)
 651 {
 652     VirtIOBlock *s = VIRTIO_BLK(vdev);
 653     AioContext *ctx;
 654
 655     /*
 656      * This should cancel pending requests, but can't do nicely until there
 657      * are per-device request lists.
 658      */
 659     ctx = blk_get_aio_context(s->blk);
 660     aio_context_acquire(ctx);
 661     blk_drain(s->blk);
 662
 663     if (s->dataplane) {
 664         virtio_blk_data_plane_stop(s->dataplane);
 665     }
 666     aio_context_release(ctx);
 667
 668     blk_set_enable_write_cache(s->blk, s->original_wce);
 669 }
 670
 671 /* coalesce internal state, copy to pci i/o region 0
 672  */
 673 static void virtio_blk_update_config(VirtIODevice *vdev, uint8_t *config)
 674 {
 675     VirtIOBlock *s = VIRTIO_BLK(vdev);
 676     BlockConf *conf = &s->conf.conf;
 677     struct virtio_blk_config blkcfg;
 678     uint64_t capacity;
 679     int blk_size = conf->logical_block_size;
 680
 681     blk_get_geometry(s->blk, &capacity);
 682     memset(&blkcfg, 0, sizeof(blkcfg));
 683     virtio_stq_p(vdev, &blkcfg.capacity, capacity);
 684     virtio_stl_p(vdev, &blkcfg.seg_max, 128 - 2);
 685     virtio_stw_p(vdev, &blkcfg.geometry.cylinders, conf->cyls);
 686     virtio_stl_p(vdev, &blkcfg.blk_size, blk_size);
 687     virtio_stw_p(vdev, &blkcfg.min_io_size, conf->min_io_size / blk_size);
 688     virtio_stw_p(vdev, &blkcfg.opt_io_size, conf->opt_io_size / blk_size);
 689     blkcfg.geometry.heads = conf->heads;
 690     /*
 691      * We must ensure that the block device capacity is a multiple of
 692      * the logical block size. If that is not the case, let's use
 693      * sector_mask to adopt the geometry to have a correct picture.
 694      * For those devices where the capacity is ok for the given geometry
 695      * we don't touch the sector value of the geometry, since some devices
 696      * (like s390 dasd) need a specific value. Here the capacity is already
 697      * cyls*heads*secs*blk_size and the sector value is not block size
 698      * divided by 512 - instead it is the amount of blk_size blocks
 699      * per track (cylinder).
 700      */
 701     if (blk_getlength(s->blk) /  conf->heads / conf->secs % blk_size) {
 702         blkcfg.geometry.sectors = conf->secs & ~s->sector_mask;
 703     } else {
 704         blkcfg.geometry.sectors = conf->secs;
 705     }
 706     blkcfg.size_max = 0;
 707     blkcfg.physical_block_exp = get_physical_block_exp(conf);
 708     blkcfg.alignment_offset = 0;
 709     blkcfg.wce = blk_enable_write_cache(s->blk);
 710     memcpy(config, &blkcfg, sizeof(struct virtio_blk_config));
 711 }
 712
 713 static void virtio_blk_set_config(VirtIODevice *vdev, const uint8_t *config)
 714 {
 715     VirtIOBlock *s = VIRTIO_BLK(vdev);
 716     struct virtio_blk_config blkcfg;
 717
 718     memcpy(&blkcfg, config, sizeof(blkcfg));
 719
 720     aio_context_acquire(blk_get_aio_context(s->blk));
 721     blk_set_enable_write_cache(s->blk, blkcfg.wce != 0);
 722     aio_context_release(blk_get_aio_context(s->blk));
 723 }
 724
 725 static uint64_t virtio_blk_get_features(VirtIODevice *vdev, uint64_t features,
 726                                         Error **errp)
 727 {
 728     VirtIOBlock *s = VIRTIO_BLK(vdev);
 729
 730     virtio_add_feature(&features, VIRTIO_BLK_F_SEG_MAX);
 731     virtio_add_feature(&features, VIRTIO_BLK_F_GEOMETRY);
 732     virtio_add_feature(&features, VIRTIO_BLK_F_TOPOLOGY);
 733     virtio_add_feature(&features, VIRTIO_BLK_F_BLK_SIZE);
 734     if (__virtio_has_feature(features, VIRTIO_F_VERSION_1)) {
 735         if (s->conf.scsi) {
 736             error_setg(errp, "Please set scsi=off for virtio-blk devices in order to use virtio 1.0");
 737             return 0;
 738         }
 739     } else {
 740         virtio_clear_feature(&features, VIRTIO_F_ANY_LAYOUT);
 741         virtio_add_feature(&features, VIRTIO_BLK_F_SCSI);
 742     }
 743
 744     if (s->conf.config_wce) {
 745         virtio_add_feature(&features, VIRTIO_BLK_F_CONFIG_WCE);
 746     }
 747     if (blk_enable_write_cache(s->blk)) {
 748         virtio_add_feature(&features, VIRTIO_BLK_F_WCE);
 749     }
 750     if (blk_is_read_only(s->blk)) {
 751         virtio_add_feature(&features, VIRTIO_BLK_F_RO);
 752     }
 753
 754     return features;
 755 }
 756
 757 static void virtio_blk_set_status(VirtIODevice *vdev, uint8_t status)
 758 {
 759     VirtIOBlock *s = VIRTIO_BLK(vdev);
 760
 761     if (s->dataplane && !(status & (VIRTIO_CONFIG_S_DRIVER |
 762                                     VIRTIO_CONFIG_S_DRIVER_OK))) {
 763         virtio_blk_data_plane_stop(s->dataplane);
 764     }
 765
 766     if (!(status & VIRTIO_CONFIG_S_DRIVER_OK)) {
 767         return;
 768     }
 769
 770     /* A guest that supports VIRTIO_BLK_F_CONFIG_WCE must be able to send
 771      * cache flushes.  Thus, the "auto writethrough" behavior is never
 772      * necessary for guests that support the VIRTIO_BLK_F_CONFIG_WCE feature.
 773      * Leaving it enabled would break the following sequence:
 774      *
 775      *     Guest started with "-drive cache=writethrough"
 776      *     Guest sets status to 0
 777      *     Guest sets DRIVER bit in status field
 778      *     Guest reads host features (WCE=0, CONFIG_WCE=1)
 779      *     Guest writes guest features (WCE=0, CONFIG_WCE=1)
 780      *     Guest writes 1 to the WCE configuration field (writeback mode)
 781      *     Guest sets DRIVER_OK bit in status field
 782      *
 783      * s->blk would erroneously be placed in writethrough mode.
 784      */
 785     if (!virtio_has_feature(vdev, VIRTIO_BLK_F_CONFIG_WCE)) {
 786         aio_context_acquire(blk_get_aio_context(s->blk));
 787         blk_set_enable_write_cache(s->blk,
 788                                    virtio_has_feature(vdev, VIRTIO_BLK_F_WCE));
 789         aio_context_release(blk_get_aio_context(s->blk));
 790     }
 791 }
 792
 793 static void virtio_blk_save(QEMUFile *f, void *opaque)
 794 {
 795     VirtIODevice *vdev = VIRTIO_DEVICE(opaque);
 796
 797     virtio_save(vdev, f);
 798 }
 799
 800 static void virtio_blk_save_device(VirtIODevice *vdev, QEMUFile *f)
 801 {
 802     VirtIOBlock *s = VIRTIO_BLK(vdev);
 803     VirtIOBlockReq *req = s->rq;
 804
 805     while (req) {
 806         qemu_put_sbyte(f, 1);
 807         qemu_put_buffer(f, (unsigned char *)&req->elem,
 808                         sizeof(VirtQueueElement));
 809         req = req->next;
 810     }
 811     qemu_put_sbyte(f, 0);
 812 }
 813
 814 static int virtio_blk_load(QEMUFile *f, void *opaque, int version_id)
 815 {
 816     VirtIOBlock *s = opaque;
 817     VirtIODevice *vdev = VIRTIO_DEVICE(s);
 818
 819     if (version_id != 2)
 820         return -EINVAL;
 821
 822     return virtio_load(vdev, f, version_id);
 823 }
 824
 825 static int virtio_blk_load_device(VirtIODevice *vdev, QEMUFile *f,
 826                                   int version_id)
 827 {
 828     VirtIOBlock *s = VIRTIO_BLK(vdev);
 829
 830     while (qemu_get_sbyte(f)) {
 831         VirtIOBlockReq *req = virtio_blk_alloc_request(s);
 832         qemu_get_buffer(f, (unsigned char *)&req->elem,
 833                         sizeof(VirtQueueElement));
 834         req->next = s->rq;
 835         s->rq = req;
 836
 837         virtqueue_map_sg(req->elem.in_sg, req->elem.in_addr,
 838             req->elem.in_num, 1);
 839         virtqueue_map_sg(req->elem.out_sg, req->elem.out_addr,
 840             req->elem.out_num, 0);
 841     }
 842
 843     return 0;
 844 }
 845
 846 static void virtio_blk_resize(void *opaque)
 847 {
 848     VirtIODevice *vdev = VIRTIO_DEVICE(opaque);
 849
 850     virtio_notify_config(vdev);
 851 }
 852
 853 static const BlockDevOps virtio_block_ops = {
 854     .resize_cb = virtio_blk_resize,
 855 };
 856
 857 /* Disable dataplane thread during live migration since it does not
 858  * update the dirty memory bitmap yet.
 859  */
 860 static void virtio_blk_migration_state_changed(Notifier *notifier, void *data)
 861 {
 862     VirtIOBlock *s = container_of(notifier, VirtIOBlock,
 863                                   migration_state_notifier);
 864     MigrationState *mig = data;
 865     Error *err = NULL;
 866
 867     if (migration_in_setup(mig)) {
 868         if (!s->dataplane) {
 869             return;
 870         }
 871         virtio_blk_data_plane_destroy(s->dataplane);
 872         s->dataplane = NULL;
 873     } else if (migration_has_finished(mig) ||
 874                migration_has_failed(mig)) {
 875         if (s->dataplane) {
 876             return;
 877         }
 878         blk_drain_all(); /* complete in-flight non-dataplane requests */
 879         virtio_blk_data_plane_create(VIRTIO_DEVICE(s), &s->conf,
 880                                      &s->dataplane, &err);
 881         if (err != NULL) {
 882             error_report_err(err);
 883         }
 884     }
 885 }
 886
 887 static void virtio_blk_device_realize(DeviceState *dev, Error **errp)
 888 {
 889     VirtIODevice *vdev = VIRTIO_DEVICE(dev);
 890     VirtIOBlock *s = VIRTIO_BLK(dev);
 891     VirtIOBlkConf *conf = &s->conf;
 892     Error *err = NULL;
 893     static int virtio_blk_id;
 894
 895     if (!conf->conf.blk) {
 896         error_setg(errp, "drive property not set");
 897         return;
 898     }
 899     if (!blk_is_inserted(conf->conf.blk)) {
 900         error_setg(errp, "Device needs media, but drive is empty");
 901         return;
 902     }
 903
 904     blkconf_serial(&conf->conf, &conf->serial);
 905     s->original_wce = blk_enable_write_cache(conf->conf.blk);
 906     blkconf_geometry(&conf->conf, NULL, 65535, 255, 255, &err);
 907     if (err) {
 908         error_propagate(errp, err);
 909         return;
 910     }
 911     blkconf_blocksizes(&conf->conf);
 912
 913     virtio_init(vdev, "virtio-blk", VIRTIO_ID_BLOCK,
 914                 sizeof(struct virtio_blk_config));
 915
 916     s->blk = conf->conf.blk;
 917     s->rq = NULL;
 918     s->sector_mask = (s->conf.conf.logical_block_size / BDRV_SECTOR_SIZE) - 1;
 919
 920     s->vq = virtio_add_queue(vdev, 128, virtio_blk_handle_output);
 921     s->complete_request = virtio_blk_complete_request;
 922     virtio_blk_data_plane_create(vdev, conf, &s->dataplane, &err);
 923     if (err != NULL) {
 924         error_propagate(errp, err);
 925         virtio_cleanup(vdev);
 926         return;
 927     }
 928     s->migration_state_notifier.notify = virtio_blk_migration_state_changed;
 929     add_migration_state_change_notifier(&s->migration_state_notifier);
 930
 931     s->change = qemu_add_vm_change_state_handler(virtio_blk_dma_restart_cb, s);
 932     register_savevm(dev, "virtio-blk", virtio_blk_id++, 2,
 933                     virtio_blk_save, virtio_blk_load, s);
 934     blk_set_dev_ops(s->blk, &virtio_block_ops, s);
 935     blk_set_guest_block_size(s->blk, s->conf.conf.logical_block_size);
 936
 937     blk_iostatus_enable(s->blk);
 938 }
 939
 940 static void virtio_blk_device_unrealize(DeviceState *dev, Error **errp)
 941 {
 942     VirtIODevice *vdev = VIRTIO_DEVICE(dev);
 943     VirtIOBlock *s = VIRTIO_BLK(dev);
 944
 945     remove_migration_state_change_notifier(&s->migration_state_notifier);
 946     virtio_blk_data_plane_destroy(s->dataplane);
 947     s->dataplane = NULL;
 948     qemu_del_vm_change_state_handler(s->change);
 949     unregister_savevm(dev, "virtio-blk", s);
 950     blockdev_mark_auto_del(s->blk);
 951     virtio_cleanup(vdev);
 952 }
 953
 954 static void virtio_blk_instance_init(Object *obj)
 955 {
 956     VirtIOBlock *s = VIRTIO_BLK(obj);
 957
 958     object_property_add_link(obj, "iothread", TYPE_IOTHREAD,
 959                              (Object **)&s->conf.iothread,
 960                              qdev_prop_allow_set_link_before_realize,
 961                              OBJ_PROP_LINK_UNREF_ON_RELEASE, NULL);
 962     device_add_bootindex_property(obj, &s->conf.conf.bootindex,
 963                                   "bootindex", "/disk@0,0",
 964                                   DEVICE(obj), NULL);
 965 }
 966
 967 static Property virtio_blk_properties[] = {
 968     DEFINE_BLOCK_PROPERTIES(VirtIOBlock, conf.conf),
 969     DEFINE_BLOCK_CHS_PROPERTIES(VirtIOBlock, conf.conf),
 970     DEFINE_PROP_STRING("serial", VirtIOBlock, conf.serial),
 971     DEFINE_PROP_BIT("config-wce", VirtIOBlock, conf.config_wce, 0, true),
 972 #ifdef __linux__
 973     DEFINE_PROP_BIT("scsi", VirtIOBlock, conf.scsi, 0, true),
 974 #endif
 975     DEFINE_PROP_BIT("request-merging", VirtIOBlock, conf.request_merging, 0,
 976                     true),
 977     DEFINE_PROP_BIT("x-data-plane", VirtIOBlock, conf.data_plane, 0, false),
 978     DEFINE_PROP_END_OF_LIST(),
 979 };
 980
 981 static void virtio_blk_class_init(ObjectClass *klass, void *data)
 982 {
 983     DeviceClass *dc = DEVICE_CLASS(klass);
 984     VirtioDeviceClass *vdc = VIRTIO_DEVICE_CLASS(klass);
 985
 986     dc->props = virtio_blk_properties;
 987     set_bit(DEVICE_CATEGORY_STORAGE, dc->categories);
 988     vdc->realize = virtio_blk_device_realize;
 989     vdc->unrealize = virtio_blk_device_unrealize;
 990     vdc->get_config = virtio_blk_update_config;
 991     vdc->set_config = virtio_blk_set_config;
 992     vdc->get_features = virtio_blk_get_features;
 993     vdc->set_status = virtio_blk_set_status;
 994     vdc->reset = virtio_blk_reset;
 995     vdc->save = virtio_blk_save_device;
 996     vdc->load = virtio_blk_load_device;
 997 }
 998
 999 static const TypeInfo virtio_device_info = {
1000     .name = TYPE_VIRTIO_BLK,
1001     .parent = TYPE_VIRTIO_DEVICE,
1002     .instance_size = sizeof(VirtIOBlock),
1003     .instance_init = virtio_blk_instance_init,
1004     .class_init = virtio_blk_class_init,
1005 };
1006
1007 static void virtio_register_types(void)
1008 {
1009     type_register_static(&virtio_device_info);
1010 }
1011
1012 type_init(virtio_register_types)