hw/scsi/virtio-scsi.c

   1 /*
   2  * Virtio SCSI HBA
   3  *
   4  * Copyright IBM, Corp. 2010
   5  * Copyright Red Hat, Inc. 2011
   6  *
   7  * Authors:
   8  *   Stefan Hajnoczi    <stefanha@linux.vnet.ibm.com>
   9  *   Paolo Bonzini      <pbonzini@redhat.com>
  10  *
  11  * This work is licensed under the terms of the GNU GPL, version 2 or later.
  12  * See the COPYING file in the top-level directory.
  13  *
  14  */
  15
  16 #include "qemu/osdep.h"
  17 #include "qapi/error.h"
  18 #include "standard-headers/linux/virtio_ids.h"
  19 #include "hw/virtio/virtio-scsi.h"
  20 #include "qemu/error-report.h"
  21 #include "qemu/iov.h"
  22 #include "sysemu/block-backend.h"
  23 #include "hw/scsi/scsi.h"
  24 #include "block/scsi.h"
  25 #include "hw/virtio/virtio-bus.h"
  26 #include "hw/virtio/virtio-access.h"
  27
  28 static inline int virtio_scsi_get_lun(uint8_t *lun)
  29 {
  30     return ((lun[2] << 8) | lun[3]) & 0x3FFF;
  31 }
  32
  33 static inline SCSIDevice *virtio_scsi_device_find(VirtIOSCSI *s, uint8_t *lun)
  34 {
  35     if (lun[0] != 1) {
  36         return NULL;
  37     }
  38     if (lun[2] != 0 && !(lun[2] >= 0x40 && lun[2] < 0x80)) {
  39         return NULL;
  40     }
  41     return scsi_device_find(&s->bus, 0, lun[1], virtio_scsi_get_lun(lun));
  42 }
  43
  44 void virtio_scsi_init_req(VirtIOSCSI *s, VirtQueue *vq, VirtIOSCSIReq *req)
  45 {
  46     const size_t zero_skip =
  47         offsetof(VirtIOSCSIReq, resp_iov) + sizeof(req->resp_iov);
  48
  49     req->vq = vq;
  50     req->dev = s;
  51     qemu_sglist_init(&req->qsgl, DEVICE(s), 8, &address_space_memory);
  52     qemu_iovec_init(&req->resp_iov, 1);
  53     memset((uint8_t *)req + zero_skip, 0, sizeof(*req) - zero_skip);
  54 }
  55
  56 void virtio_scsi_free_req(VirtIOSCSIReq *req)
  57 {
  58     qemu_iovec_destroy(&req->resp_iov);
  59     qemu_sglist_destroy(&req->qsgl);
  60     g_free(req);
  61 }
  62
  63 static void virtio_scsi_complete_req(VirtIOSCSIReq *req)
  64 {
  65     VirtIOSCSI *s = req->dev;
  66     VirtQueue *vq = req->vq;
  67     VirtIODevice *vdev = VIRTIO_DEVICE(s);
  68
  69     qemu_iovec_from_buf(&req->resp_iov, 0, &req->resp, req->resp_size);
  70     virtqueue_push(vq, &req->elem, req->qsgl.size + req->resp_iov.size);
  71     if (s->dataplane_started && !s->dataplane_fenced) {
  72         virtio_notify_irqfd(vdev, vq);
  73     } else {
  74         virtio_notify(vdev, vq);
  75     }
  76
  77     if (req->sreq) {
  78         req->sreq->hba_private = NULL;
  79         scsi_req_unref(req->sreq);
  80     }
  81     virtio_scsi_free_req(req);
  82 }
  83
  84 static void virtio_scsi_bad_req(VirtIOSCSIReq *req)
  85 {
  86     virtio_error(VIRTIO_DEVICE(req->dev), "wrong size for virtio-scsi headers");
  87     virtqueue_detach_element(req->vq, &req->elem, 0);
  88     virtio_scsi_free_req(req);
  89 }
  90
  91 static size_t qemu_sgl_concat(VirtIOSCSIReq *req, struct iovec *iov,
  92                               hwaddr *addr, int num, size_t skip)
  93 {
  94     QEMUSGList *qsgl = &req->qsgl;
  95     size_t copied = 0;
  96
  97     while (num) {
  98         if (skip >= iov->iov_len) {
  99             skip -= iov->iov_len;
 100         } else {
 101             qemu_sglist_add(qsgl, *addr + skip, iov->iov_len - skip);
 102             copied += iov->iov_len - skip;
 103             skip = 0;
 104         }
 105         iov++;
 106         addr++;
 107         num--;
 108     }
 109
 110     assert(skip == 0);
 111     return copied;
 112 }
 113
 114 static int virtio_scsi_parse_req(VirtIOSCSIReq *req,
 115                                  unsigned req_size, unsigned resp_size)
 116 {
 117     VirtIODevice *vdev = (VirtIODevice *) req->dev;
 118     size_t in_size, out_size;
 119
 120     if (iov_to_buf(req->elem.out_sg, req->elem.out_num, 0,
 121                    &req->req, req_size) < req_size) {
 122         return -EINVAL;
 123     }
 124
 125     if (qemu_iovec_concat_iov(&req->resp_iov,
 126                               req->elem.in_sg, req->elem.in_num, 0,
 127                               resp_size) < resp_size) {
 128         return -EINVAL;
 129     }
 130
 131     req->resp_size = resp_size;
 132
 133     /* Old BIOSes left some padding by mistake after the req_size/resp_size.
 134      * As a workaround, always consider the first buffer as the virtio-scsi
 135      * request/response, making the payload start at the second element
 136      * of the iovec.
 137      *
 138      * The actual length of the response header, stored in req->resp_size,
 139      * does not change.
 140      *
 141      * TODO: always disable this workaround for virtio 1.0 devices.
 142      */
 143     if (!virtio_vdev_has_feature(vdev, VIRTIO_F_ANY_LAYOUT)) {
 144         if (req->elem.out_num) {
 145             req_size = req->elem.out_sg[0].iov_len;
 146         }
 147         if (req->elem.in_num) {
 148             resp_size = req->elem.in_sg[0].iov_len;
 149         }
 150     }
 151
 152     out_size = qemu_sgl_concat(req, req->elem.out_sg,
 153                                &req->elem.out_addr[0], req->elem.out_num,
 154                                req_size);
 155     in_size = qemu_sgl_concat(req, req->elem.in_sg,
 156                               &req->elem.in_addr[0], req->elem.in_num,
 157                               resp_size);
 158
 159     if (out_size && in_size) {
 160         return -ENOTSUP;
 161     }
 162
 163     if (out_size) {
 164         req->mode = SCSI_XFER_TO_DEV;
 165     } else if (in_size) {
 166         req->mode = SCSI_XFER_FROM_DEV;
 167     }
 168
 169     return 0;
 170 }
 171
 172 static VirtIOSCSIReq *virtio_scsi_pop_req(VirtIOSCSI *s, VirtQueue *vq)
 173 {
 174     VirtIOSCSICommon *vs = (VirtIOSCSICommon *)s;
 175     VirtIOSCSIReq *req;
 176
 177     req = virtqueue_pop(vq, sizeof(VirtIOSCSIReq) + vs->cdb_size);
 178     if (!req) {
 179         return NULL;
 180     }
 181     virtio_scsi_init_req(s, vq, req);
 182     return req;
 183 }
 184
 185 static void virtio_scsi_save_request(QEMUFile *f, SCSIRequest *sreq)
 186 {
 187     VirtIOSCSIReq *req = sreq->hba_private;
 188     VirtIOSCSICommon *vs = VIRTIO_SCSI_COMMON(req->dev);
 189     uint32_t n = virtio_get_queue_index(req->vq) - 2;
 190
 191     assert(n < vs->conf.num_queues);
 192     qemu_put_be32s(f, &n);
 193     qemu_put_virtqueue_element(f, &req->elem);
 194 }
 195
 196 static void *virtio_scsi_load_request(QEMUFile *f, SCSIRequest *sreq)
 197 {
 198     SCSIBus *bus = sreq->bus;
 199     VirtIOSCSI *s = container_of(bus, VirtIOSCSI, bus);
 200     VirtIOSCSICommon *vs = VIRTIO_SCSI_COMMON(s);
 201     VirtIODevice *vdev = VIRTIO_DEVICE(s);
 202     VirtIOSCSIReq *req;
 203     uint32_t n;
 204
 205     qemu_get_be32s(f, &n);
 206     assert(n < vs->conf.num_queues);
 207     req = qemu_get_virtqueue_element(vdev, f,
 208                                      sizeof(VirtIOSCSIReq) + vs->cdb_size);
 209     virtio_scsi_init_req(s, vs->cmd_vqs[n], req);
 210
 211     if (virtio_scsi_parse_req(req, sizeof(VirtIOSCSICmdReq) + vs->cdb_size,
 212                               sizeof(VirtIOSCSICmdResp) + vs->sense_size) < 0) {
 213         error_report("invalid SCSI request migration data");
 214         exit(1);
 215     }
 216
 217     scsi_req_ref(sreq);
 218     req->sreq = sreq;
 219     if (req->sreq->cmd.mode != SCSI_XFER_NONE) {
 220         assert(req->sreq->cmd.mode == req->mode);
 221     }
 222     return req;
 223 }
 224
 225 typedef struct {
 226     Notifier        notifier;
 227     VirtIOSCSIReq  *tmf_req;
 228 } VirtIOSCSICancelNotifier;
 229
 230 static void virtio_scsi_cancel_notify(Notifier *notifier, void *data)
 231 {
 232     VirtIOSCSICancelNotifier *n = container_of(notifier,
 233                                                VirtIOSCSICancelNotifier,
 234                                                notifier);
 235
 236     if (--n->tmf_req->remaining == 0) {
 237         virtio_scsi_complete_req(n->tmf_req);
 238     }
 239     g_free(n);
 240 }
 241
 242 static inline void virtio_scsi_ctx_check(VirtIOSCSI *s, SCSIDevice *d)
 243 {
 244     if (s->dataplane_started && d && blk_is_available(d->conf.blk)) {
 245         assert(blk_get_aio_context(d->conf.blk) == s->ctx);
 246     }
 247 }
 248
 249 /* Return 0 if the request is ready to be completed and return to guest;
 250  * -EINPROGRESS if the request is submitted and will be completed later, in the
 251  *  case of async cancellation. */
 252 static int virtio_scsi_do_tmf(VirtIOSCSI *s, VirtIOSCSIReq *req)
 253 {
 254     SCSIDevice *d = virtio_scsi_device_find(s, req->req.tmf.lun);
 255     SCSIRequest *r, *next;
 256     BusChild *kid;
 257     int target;
 258     int ret = 0;
 259
 260     virtio_scsi_ctx_check(s, d);
 261     /* Here VIRTIO_SCSI_S_OK means "FUNCTION COMPLETE".  */
 262     req->resp.tmf.response = VIRTIO_SCSI_S_OK;
 263
 264     virtio_tswap32s(VIRTIO_DEVICE(s), &req->req.tmf.subtype);
 265     switch (req->req.tmf.subtype) {
 266     case VIRTIO_SCSI_T_TMF_ABORT_TASK:
 267     case VIRTIO_SCSI_T_TMF_QUERY_TASK:
 268         if (!d) {
 269             goto fail;
 270         }
 271         if (d->lun != virtio_scsi_get_lun(req->req.tmf.lun)) {
 272             goto incorrect_lun;
 273         }
 274         QTAILQ_FOREACH_SAFE(r, &d->requests, next, next) {
 275             VirtIOSCSIReq *cmd_req = r->hba_private;
 276             if (cmd_req && cmd_req->req.cmd.tag == req->req.tmf.tag) {
 277                 break;
 278             }
 279         }
 280         if (r) {
 281             /*
 282              * Assert that the request has not been completed yet, we
 283              * check for it in the loop above.
 284              */
 285             assert(r->hba_private);
 286             if (req->req.tmf.subtype == VIRTIO_SCSI_T_TMF_QUERY_TASK) {
 287                 /* "If the specified command is present in the task set, then
 288                  * return a service response set to FUNCTION SUCCEEDED".
 289                  */
 290                 req->resp.tmf.response = VIRTIO_SCSI_S_FUNCTION_SUCCEEDED;
 291             } else {
 292                 VirtIOSCSICancelNotifier *notifier;
 293
 294                 req->remaining = 1;
 295                 notifier = g_new(VirtIOSCSICancelNotifier, 1);
 296                 notifier->tmf_req = req;
 297                 notifier->notifier.notify = virtio_scsi_cancel_notify;
 298                 scsi_req_cancel_async(r, &notifier->notifier);
 299                 ret = -EINPROGRESS;
 300             }
 301         }
 302         break;
 303
 304     case VIRTIO_SCSI_T_TMF_LOGICAL_UNIT_RESET:
 305         if (!d) {
 306             goto fail;
 307         }
 308         if (d->lun != virtio_scsi_get_lun(req->req.tmf.lun)) {
 309             goto incorrect_lun;
 310         }
 311         s->resetting++;
 312         qdev_reset_all(&d->qdev);
 313         s->resetting--;
 314         break;
 315
 316     case VIRTIO_SCSI_T_TMF_ABORT_TASK_SET:
 317     case VIRTIO_SCSI_T_TMF_CLEAR_TASK_SET:
 318     case VIRTIO_SCSI_T_TMF_QUERY_TASK_SET:
 319         if (!d) {
 320             goto fail;
 321         }
 322         if (d->lun != virtio_scsi_get_lun(req->req.tmf.lun)) {
 323             goto incorrect_lun;
 324         }
 325
 326         /* Add 1 to "remaining" until virtio_scsi_do_tmf returns.
 327          * This way, if the bus starts calling back to the notifiers
 328          * even before we finish the loop, virtio_scsi_cancel_notify
 329          * will not complete the TMF too early.
 330          */
 331         req->remaining = 1;
 332         QTAILQ_FOREACH_SAFE(r, &d->requests, next, next) {
 333             if (r->hba_private) {
 334                 if (req->req.tmf.subtype == VIRTIO_SCSI_T_TMF_QUERY_TASK_SET) {
 335                     /* "If there is any command present in the task set, then
 336                      * return a service response set to FUNCTION SUCCEEDED".
 337                      */
 338                     req->resp.tmf.response = VIRTIO_SCSI_S_FUNCTION_SUCCEEDED;
 339                     break;
 340                 } else {
 341                     VirtIOSCSICancelNotifier *notifier;
 342
 343                     req->remaining++;
 344                     notifier = g_new(VirtIOSCSICancelNotifier, 1);
 345                     notifier->notifier.notify = virtio_scsi_cancel_notify;
 346                     notifier->tmf_req = req;
 347                     scsi_req_cancel_async(r, &notifier->notifier);
 348                 }
 349             }
 350         }
 351         if (--req->remaining > 0) {
 352             ret = -EINPROGRESS;
 353         }
 354         break;
 355
 356     case VIRTIO_SCSI_T_TMF_I_T_NEXUS_RESET:
 357         target = req->req.tmf.lun[1];
 358         s->resetting++;
 359         QTAILQ_FOREACH(kid, &s->bus.qbus.children, sibling) {
 360              d = SCSI_DEVICE(kid->child);
 361              if (d->channel == 0 && d->id == target) {
 362                 qdev_reset_all(&d->qdev);
 363              }
 364         }
 365         s->resetting--;
 366         break;
 367
 368     case VIRTIO_SCSI_T_TMF_CLEAR_ACA:
 369     default:
 370         req->resp.tmf.response = VIRTIO_SCSI_S_FUNCTION_REJECTED;
 371         break;
 372     }
 373
 374     return ret;
 375
 376 incorrect_lun:
 377     req->resp.tmf.response = VIRTIO_SCSI_S_INCORRECT_LUN;
 378     return ret;
 379
 380 fail:
 381     req->resp.tmf.response = VIRTIO_SCSI_S_BAD_TARGET;
 382     return ret;
 383 }
 384
 385 static void virtio_scsi_handle_ctrl_req(VirtIOSCSI *s, VirtIOSCSIReq *req)
 386 {
 387     VirtIODevice *vdev = (VirtIODevice *)s;
 388     uint32_t type;
 389     int r = 0;
 390
 391     if (iov_to_buf(req->elem.out_sg, req->elem.out_num, 0,
 392                 &type, sizeof(type)) < sizeof(type)) {
 393         virtio_scsi_bad_req(req);
 394         return;
 395     }
 396
 397     virtio_tswap32s(vdev, &type);
 398     if (type == VIRTIO_SCSI_T_TMF) {
 399         if (virtio_scsi_parse_req(req, sizeof(VirtIOSCSICtrlTMFReq),
 400                     sizeof(VirtIOSCSICtrlTMFResp)) < 0) {
 401             virtio_scsi_bad_req(req);
 402             return;
 403         } else {
 404             r = virtio_scsi_do_tmf(s, req);
 405         }
 406
 407     } else if (type == VIRTIO_SCSI_T_AN_QUERY ||
 408                type == VIRTIO_SCSI_T_AN_SUBSCRIBE) {
 409         if (virtio_scsi_parse_req(req, sizeof(VirtIOSCSICtrlANReq),
 410                     sizeof(VirtIOSCSICtrlANResp)) < 0) {
 411             virtio_scsi_bad_req(req);
 412             return;
 413         } else {
 414             req->resp.an.event_actual = 0;
 415             req->resp.an.response = VIRTIO_SCSI_S_OK;
 416         }
 417     }
 418     if (r == 0) {
 419         virtio_scsi_complete_req(req);
 420     } else {
 421         assert(r == -EINPROGRESS);
 422     }
 423 }
 424
 425 static inline void virtio_scsi_acquire(VirtIOSCSI *s)
 426 {
 427     if (s->ctx) {
 428         aio_context_acquire(s->ctx);
 429     }
 430 }
 431
 432 static inline void virtio_scsi_release(VirtIOSCSI *s)
 433 {
 434     if (s->ctx) {
 435         aio_context_release(s->ctx);
 436     }
 437 }
 438
 439 void virtio_scsi_handle_ctrl_vq(VirtIOSCSI *s, VirtQueue *vq)
 440 {
 441     VirtIOSCSIReq *req;
 442
 443     while ((req = virtio_scsi_pop_req(s, vq))) {
 444         virtio_scsi_handle_ctrl_req(s, req);
 445     }
 446 }
 447
 448 static void virtio_scsi_handle_ctrl(VirtIODevice *vdev, VirtQueue *vq)
 449 {
 450     VirtIOSCSI *s = (VirtIOSCSI *)vdev;
 451
 452     if (s->ctx) {
 453         virtio_device_start_ioeventfd(vdev);
 454         if (!s->dataplane_fenced) {
 455             return;
 456         }
 457     }
 458     virtio_scsi_handle_ctrl_vq(s, vq);
 459 }
 460
 461 static void virtio_scsi_complete_cmd_req(VirtIOSCSIReq *req)
 462 {
 463     /* Sense data is not in req->resp and is copied separately
 464      * in virtio_scsi_command_complete.
 465      */
 466     req->resp_size = sizeof(VirtIOSCSICmdResp);
 467     virtio_scsi_complete_req(req);
 468 }
 469
 470 static void virtio_scsi_command_complete(SCSIRequest *r, uint32_t status,
 471                                          size_t resid)
 472 {
 473     VirtIOSCSIReq *req = r->hba_private;
 474     uint8_t sense[SCSI_SENSE_BUF_SIZE];
 475     uint32_t sense_len;
 476     VirtIODevice *vdev = VIRTIO_DEVICE(req->dev);
 477
 478     if (r->io_canceled) {
 479         return;
 480     }
 481
 482     req->resp.cmd.response = VIRTIO_SCSI_S_OK;
 483     req->resp.cmd.status = status;
 484     if (req->resp.cmd.status == GOOD) {
 485         req->resp.cmd.resid = virtio_tswap32(vdev, resid);
 486     } else {
 487         req->resp.cmd.resid = 0;
 488         sense_len = scsi_req_get_sense(r, sense, sizeof(sense));
 489         sense_len = MIN(sense_len, req->resp_iov.size - sizeof(req->resp.cmd));
 490         qemu_iovec_from_buf(&req->resp_iov, sizeof(req->resp.cmd),
 491                             sense, sense_len);
 492         req->resp.cmd.sense_len = virtio_tswap32(vdev, sense_len);
 493     }
 494     virtio_scsi_complete_cmd_req(req);
 495 }
 496
 497 static int virtio_scsi_parse_cdb(SCSIDevice *dev, SCSICommand *cmd,
 498                                  uint8_t *buf, void *hba_private)
 499 {
 500     VirtIOSCSIReq *req = hba_private;
 501
 502     if (cmd->len == 0) {
 503         cmd->len = MIN(VIRTIO_SCSI_CDB_DEFAULT_SIZE, SCSI_CMD_BUF_SIZE);
 504         memcpy(cmd->buf, buf, cmd->len);
 505     }
 506
 507     /* Extract the direction and mode directly from the request, for
 508      * host device passthrough.
 509      */
 510     cmd->xfer = req->qsgl.size;
 511     cmd->mode = req->mode;
 512     return 0;
 513 }
 514
 515 static QEMUSGList *virtio_scsi_get_sg_list(SCSIRequest *r)
 516 {
 517     VirtIOSCSIReq *req = r->hba_private;
 518
 519     return &req->qsgl;
 520 }
 521
 522 static void virtio_scsi_request_cancelled(SCSIRequest *r)
 523 {
 524     VirtIOSCSIReq *req = r->hba_private;
 525
 526     if (!req) {
 527         return;
 528     }
 529     if (req->dev->resetting) {
 530         req->resp.cmd.response = VIRTIO_SCSI_S_RESET;
 531     } else {
 532         req->resp.cmd.response = VIRTIO_SCSI_S_ABORTED;
 533     }
 534     virtio_scsi_complete_cmd_req(req);
 535 }
 536
 537 static void virtio_scsi_fail_cmd_req(VirtIOSCSIReq *req)
 538 {
 539     req->resp.cmd.response = VIRTIO_SCSI_S_FAILURE;
 540     virtio_scsi_complete_cmd_req(req);
 541 }
 542
 543 static int virtio_scsi_handle_cmd_req_prepare(VirtIOSCSI *s, VirtIOSCSIReq *req)
 544 {
 545     VirtIOSCSICommon *vs = &s->parent_obj;
 546     SCSIDevice *d;
 547     int rc;
 548
 549     rc = virtio_scsi_parse_req(req, sizeof(VirtIOSCSICmdReq) + vs->cdb_size,
 550                                sizeof(VirtIOSCSICmdResp) + vs->sense_size);
 551     if (rc < 0) {
 552         if (rc == -ENOTSUP) {
 553             virtio_scsi_fail_cmd_req(req);
 554             return -ENOTSUP;
 555         } else {
 556             virtio_scsi_bad_req(req);
 557             return -EINVAL;
 558         }
 559     }
 560
 561     d = virtio_scsi_device_find(s, req->req.cmd.lun);
 562     if (!d) {
 563         req->resp.cmd.response = VIRTIO_SCSI_S_BAD_TARGET;
 564         virtio_scsi_complete_cmd_req(req);
 565         return -ENOENT;
 566     }
 567     virtio_scsi_ctx_check(s, d);
 568     req->sreq = scsi_req_new(d, req->req.cmd.tag,
 569                              virtio_scsi_get_lun(req->req.cmd.lun),
 570                              req->req.cmd.cdb, req);
 571
 572     if (req->sreq->cmd.mode != SCSI_XFER_NONE
 573         && (req->sreq->cmd.mode != req->mode ||
 574             req->sreq->cmd.xfer > req->qsgl.size)) {
 575         req->resp.cmd.response = VIRTIO_SCSI_S_OVERRUN;
 576         virtio_scsi_complete_cmd_req(req);
 577         return -ENOBUFS;
 578     }
 579     scsi_req_ref(req->sreq);
 580     blk_io_plug(d->conf.blk);
 581     return 0;
 582 }
 583
 584 static void virtio_scsi_handle_cmd_req_submit(VirtIOSCSI *s, VirtIOSCSIReq *req)
 585 {
 586     SCSIRequest *sreq = req->sreq;
 587     if (scsi_req_enqueue(sreq)) {
 588         scsi_req_continue(sreq);
 589     }
 590     blk_io_unplug(sreq->dev->conf.blk);
 591     scsi_req_unref(sreq);
 592 }
 593
 594 void virtio_scsi_handle_cmd_vq(VirtIOSCSI *s, VirtQueue *vq)
 595 {
 596     VirtIOSCSIReq *req, *next;
 597     int ret = 0;
 598
 599     QTAILQ_HEAD(, VirtIOSCSIReq) reqs = QTAILQ_HEAD_INITIALIZER(reqs);
 600
 601     do {
 602         virtio_queue_set_notification(vq, 0);
 603
 604         while ((req = virtio_scsi_pop_req(s, vq))) {
 605             ret = virtio_scsi_handle_cmd_req_prepare(s, req);
 606             if (!ret) {
 607                 QTAILQ_INSERT_TAIL(&reqs, req, next);
 608             } else if (ret == -EINVAL) {
 609                 /* The device is broken and shouldn't process any request */
 610                 while (!QTAILQ_EMPTY(&reqs)) {
 611                     req = QTAILQ_FIRST(&reqs);
 612                     QTAILQ_REMOVE(&reqs, req, next);
 613                     blk_io_unplug(req->sreq->dev->conf.blk);
 614                     scsi_req_unref(req->sreq);
 615                     virtqueue_detach_element(req->vq, &req->elem, 0);
 616                     virtio_scsi_free_req(req);
 617                 }
 618             }
 619         }
 620
 621         virtio_queue_set_notification(vq, 1);
 622     } while (ret != -EINVAL && !virtio_queue_empty(vq));
 623
 624     QTAILQ_FOREACH_SAFE(req, &reqs, next, next) {
 625         virtio_scsi_handle_cmd_req_submit(s, req);
 626     }
 627 }
 628
 629 static void virtio_scsi_handle_cmd(VirtIODevice *vdev, VirtQueue *vq)
 630 {
 631     /* use non-QOM casts in the data path */
 632     VirtIOSCSI *s = (VirtIOSCSI *)vdev;
 633
 634     if (s->ctx) {
 635         virtio_device_start_ioeventfd(vdev);
 636         if (!s->dataplane_fenced) {
 637             return;
 638         }
 639     }
 640     virtio_scsi_handle_cmd_vq(s, vq);
 641 }
 642
 643 static void virtio_scsi_get_config(VirtIODevice *vdev,
 644                                    uint8_t *config)
 645 {
 646     VirtIOSCSIConfig *scsiconf = (VirtIOSCSIConfig *)config;
 647     VirtIOSCSICommon *s = VIRTIO_SCSI_COMMON(vdev);
 648
 649     virtio_stl_p(vdev, &scsiconf->num_queues, s->conf.num_queues);
 650     virtio_stl_p(vdev, &scsiconf->seg_max, 128 - 2);
 651     virtio_stl_p(vdev, &scsiconf->max_sectors, s->conf.max_sectors);
 652     virtio_stl_p(vdev, &scsiconf->cmd_per_lun, s->conf.cmd_per_lun);
 653     virtio_stl_p(vdev, &scsiconf->event_info_size, sizeof(VirtIOSCSIEvent));
 654     virtio_stl_p(vdev, &scsiconf->sense_size, s->sense_size);
 655     virtio_stl_p(vdev, &scsiconf->cdb_size, s->cdb_size);
 656     virtio_stw_p(vdev, &scsiconf->max_channel, VIRTIO_SCSI_MAX_CHANNEL);
 657     virtio_stw_p(vdev, &scsiconf->max_target, VIRTIO_SCSI_MAX_TARGET);
 658     virtio_stl_p(vdev, &scsiconf->max_lun, VIRTIO_SCSI_MAX_LUN);
 659 }
 660
 661 static void virtio_scsi_set_config(VirtIODevice *vdev,
 662                                    const uint8_t *config)
 663 {
 664     VirtIOSCSIConfig *scsiconf = (VirtIOSCSIConfig *)config;
 665     VirtIOSCSICommon *vs = VIRTIO_SCSI_COMMON(vdev);
 666
 667     if ((uint32_t) virtio_ldl_p(vdev, &scsiconf->sense_size) >= 65536 ||
 668         (uint32_t) virtio_ldl_p(vdev, &scsiconf->cdb_size) >= 256) {
 669         virtio_error(vdev,
 670                      "bad data written to virtio-scsi configuration space");
 671         return;
 672     }
 673
 674     vs->sense_size = virtio_ldl_p(vdev, &scsiconf->sense_size);
 675     vs->cdb_size = virtio_ldl_p(vdev, &scsiconf->cdb_size);
 676 }
 677
 678 static uint64_t virtio_scsi_get_features(VirtIODevice *vdev,
 679                                          uint64_t requested_features,
 680                                          Error **errp)
 681 {
 682     VirtIOSCSI *s = VIRTIO_SCSI(vdev);
 683
 684     /* Firstly sync all virtio-scsi possible supported features */
 685     requested_features |= s->host_features;
 686     return requested_features;
 687 }
 688
 689 static void virtio_scsi_reset(VirtIODevice *vdev)
 690 {
 691     VirtIOSCSI *s = VIRTIO_SCSI(vdev);
 692     VirtIOSCSICommon *vs = VIRTIO_SCSI_COMMON(vdev);
 693
 694     assert(!s->dataplane_started);
 695     s->resetting++;
 696     qbus_reset_all(&s->bus.qbus);
 697     s->resetting--;
 698
 699     vs->sense_size = VIRTIO_SCSI_SENSE_DEFAULT_SIZE;
 700     vs->cdb_size = VIRTIO_SCSI_CDB_DEFAULT_SIZE;
 701     s->events_dropped = false;
 702 }
 703
 704 void virtio_scsi_push_event(VirtIOSCSI *s, SCSIDevice *dev,
 705                             uint32_t event, uint32_t reason)
 706 {
 707     VirtIOSCSICommon *vs = VIRTIO_SCSI_COMMON(s);
 708     VirtIOSCSIReq *req;
 709     VirtIOSCSIEvent *evt;
 710     VirtIODevice *vdev = VIRTIO_DEVICE(s);
 711
 712     if (!(vdev->status & VIRTIO_CONFIG_S_DRIVER_OK)) {
 713         return;
 714     }
 715
 716     virtio_scsi_acquire(s);
 717
 718     req = virtio_scsi_pop_req(s, vs->event_vq);
 719     if (!req) {
 720         s->events_dropped = true;
 721         goto out;
 722     }
 723
 724     if (s->events_dropped) {
 725         event |= VIRTIO_SCSI_T_EVENTS_MISSED;
 726         s->events_dropped = false;
 727     }
 728
 729     if (virtio_scsi_parse_req(req, 0, sizeof(VirtIOSCSIEvent))) {
 730         virtio_scsi_bad_req(req);
 731         goto out;
 732     }
 733
 734     evt = &req->resp.event;
 735     memset(evt, 0, sizeof(VirtIOSCSIEvent));
 736     evt->event = virtio_tswap32(vdev, event);
 737     evt->reason = virtio_tswap32(vdev, reason);
 738     if (!dev) {
 739         assert(event == VIRTIO_SCSI_T_EVENTS_MISSED);
 740     } else {
 741         evt->lun[0] = 1;
 742         evt->lun[1] = dev->id;
 743
 744         /* Linux wants us to keep the same encoding we use for REPORT LUNS.  */
 745         if (dev->lun >= 256) {
 746             evt->lun[2] = (dev->lun >> 8) | 0x40;
 747         }
 748         evt->lun[3] = dev->lun & 0xFF;
 749     }
 750     virtio_scsi_complete_req(req);
 751 out:
 752     virtio_scsi_release(s);
 753 }
 754
 755 void virtio_scsi_handle_event_vq(VirtIOSCSI *s, VirtQueue *vq)
 756 {
 757     if (s->events_dropped) {
 758         virtio_scsi_push_event(s, NULL, VIRTIO_SCSI_T_NO_EVENT, 0);
 759     }
 760 }
 761
 762 static void virtio_scsi_handle_event(VirtIODevice *vdev, VirtQueue *vq)
 763 {
 764     VirtIOSCSI *s = VIRTIO_SCSI(vdev);
 765
 766     if (s->ctx) {
 767         virtio_device_start_ioeventfd(vdev);
 768         if (!s->dataplane_fenced) {
 769             return;
 770         }
 771     }
 772     virtio_scsi_handle_event_vq(s, vq);
 773 }
 774
 775 static void virtio_scsi_change(SCSIBus *bus, SCSIDevice *dev, SCSISense sense)
 776 {
 777     VirtIOSCSI *s = container_of(bus, VirtIOSCSI, bus);
 778     VirtIODevice *vdev = VIRTIO_DEVICE(s);
 779
 780     if (virtio_vdev_has_feature(vdev, VIRTIO_SCSI_F_CHANGE) &&
 781         dev->type != TYPE_ROM) {
 782         virtio_scsi_push_event(s, dev, VIRTIO_SCSI_T_PARAM_CHANGE,
 783                                sense.asc | (sense.ascq << 8));
 784     }
 785 }
 786
 787 static void virtio_scsi_hotplug(HotplugHandler *hotplug_dev, DeviceState *dev,
 788                                 Error **errp)
 789 {
 790     VirtIODevice *vdev = VIRTIO_DEVICE(hotplug_dev);
 791     VirtIOSCSI *s = VIRTIO_SCSI(vdev);
 792     SCSIDevice *sd = SCSI_DEVICE(dev);
 793
 794     if (s->ctx && !s->dataplane_fenced) {
 795         if (blk_op_is_blocked(sd->conf.blk, BLOCK_OP_TYPE_DATAPLANE, errp)) {
 796             return;
 797         }
 798         virtio_scsi_acquire(s);
 799         blk_set_aio_context(sd->conf.blk, s->ctx);
 800         virtio_scsi_release(s);
 801
 802     }
 803
 804     if (virtio_vdev_has_feature(vdev, VIRTIO_SCSI_F_HOTPLUG)) {
 805         virtio_scsi_push_event(s, sd,
 806                                VIRTIO_SCSI_T_TRANSPORT_RESET,
 807                                VIRTIO_SCSI_EVT_RESET_RESCAN);
 808     }
 809 }
 810
 811 static void virtio_scsi_hotunplug(HotplugHandler *hotplug_dev, DeviceState *dev,
 812                                   Error **errp)
 813 {
 814     VirtIODevice *vdev = VIRTIO_DEVICE(hotplug_dev);
 815     VirtIOSCSI *s = VIRTIO_SCSI(vdev);
 816     SCSIDevice *sd = SCSI_DEVICE(dev);
 817
 818     if (virtio_vdev_has_feature(vdev, VIRTIO_SCSI_F_HOTPLUG)) {
 819         virtio_scsi_push_event(s, sd,
 820                                VIRTIO_SCSI_T_TRANSPORT_RESET,
 821                                VIRTIO_SCSI_EVT_RESET_REMOVED);
 822     }
 823
 824     qdev_simple_device_unplug_cb(hotplug_dev, dev, errp);
 825 }
 826
 827 static struct SCSIBusInfo virtio_scsi_scsi_info = {
 828     .tcq = true,
 829     .max_channel = VIRTIO_SCSI_MAX_CHANNEL,
 830     .max_target = VIRTIO_SCSI_MAX_TARGET,
 831     .max_lun = VIRTIO_SCSI_MAX_LUN,
 832
 833     .complete = virtio_scsi_command_complete,
 834     .cancel = virtio_scsi_request_cancelled,
 835     .change = virtio_scsi_change,
 836     .parse_cdb = virtio_scsi_parse_cdb,
 837     .get_sg_list = virtio_scsi_get_sg_list,
 838     .save_request = virtio_scsi_save_request,
 839     .load_request = virtio_scsi_load_request,
 840 };
 841
 842 void virtio_scsi_common_realize(DeviceState *dev, Error **errp,
 843                                 VirtIOHandleOutput ctrl,
 844                                 VirtIOHandleOutput evt,
 845                                 VirtIOHandleOutput cmd)
 846 {
 847     VirtIODevice *vdev = VIRTIO_DEVICE(dev);
 848     VirtIOSCSICommon *s = VIRTIO_SCSI_COMMON(dev);
 849     int i;
 850
 851     virtio_init(vdev, "virtio-scsi", VIRTIO_ID_SCSI,
 852                 sizeof(VirtIOSCSIConfig));
 853
 854     if (s->conf.num_queues == 0 ||
 855             s->conf.num_queues > VIRTIO_QUEUE_MAX - 2) {
 856         error_setg(errp, "Invalid number of queues (= %" PRIu32 "), "
 857                          "must be a positive integer less than %d.",
 858                    s->conf.num_queues, VIRTIO_QUEUE_MAX - 2);
 859         virtio_cleanup(vdev);
 860         return;
 861     }
 862     s->cmd_vqs = g_new0(VirtQueue *, s->conf.num_queues);
 863     s->sense_size = VIRTIO_SCSI_SENSE_DEFAULT_SIZE;
 864     s->cdb_size = VIRTIO_SCSI_CDB_DEFAULT_SIZE;
 865
 866     s->ctrl_vq = virtio_add_queue(vdev, VIRTIO_SCSI_VQ_SIZE, ctrl);
 867     s->event_vq = virtio_add_queue(vdev, VIRTIO_SCSI_VQ_SIZE, evt);
 868     for (i = 0; i < s->conf.num_queues; i++) {
 869         s->cmd_vqs[i] = virtio_add_queue(vdev, VIRTIO_SCSI_VQ_SIZE, cmd);
 870     }
 871 }
 872
 873 static void virtio_scsi_device_realize(DeviceState *dev, Error **errp)
 874 {
 875     VirtIODevice *vdev = VIRTIO_DEVICE(dev);
 876     VirtIOSCSI *s = VIRTIO_SCSI(dev);
 877     Error *err = NULL;
 878
 879     virtio_scsi_common_realize(dev, &err, virtio_scsi_handle_ctrl,
 880                                virtio_scsi_handle_event,
 881                                virtio_scsi_handle_cmd);
 882     if (err != NULL) {
 883         error_propagate(errp, err);
 884         return;
 885     }
 886
 887     scsi_bus_new(&s->bus, sizeof(s->bus), dev,
 888                  &virtio_scsi_scsi_info, vdev->bus_name);
 889     /* override default SCSI bus hotplug-handler, with virtio-scsi's one */
 890     qbus_set_hotplug_handler(BUS(&s->bus), dev, &error_abort);
 891
 892     if (!dev->hotplugged) {
 893         scsi_bus_legacy_handle_cmdline(&s->bus, &err);
 894         if (err != NULL) {
 895             error_propagate(errp, err);
 896             return;
 897         }
 898     }
 899
 900     virtio_scsi_dataplane_setup(s, errp);
 901 }
 902
 903 static void virtio_scsi_instance_init(Object *obj)
 904 {
 905     VirtIOSCSICommon *vs = VIRTIO_SCSI_COMMON(obj);
 906
 907     object_property_add_link(obj, "iothread", TYPE_IOTHREAD,
 908                              (Object **)&vs->conf.iothread,
 909                              qdev_prop_allow_set_link_before_realize,
 910                              OBJ_PROP_LINK_UNREF_ON_RELEASE, &error_abort);
 911 }
 912
 913 void virtio_scsi_common_unrealize(DeviceState *dev, Error **errp)
 914 {
 915     VirtIODevice *vdev = VIRTIO_DEVICE(dev);
 916     VirtIOSCSICommon *vs = VIRTIO_SCSI_COMMON(dev);
 917
 918     g_free(vs->cmd_vqs);
 919     virtio_cleanup(vdev);
 920 }
 921
 922 static void virtio_scsi_device_unrealize(DeviceState *dev, Error **errp)
 923 {
 924     virtio_scsi_common_unrealize(dev, errp);
 925 }
 926
 927 static Property virtio_scsi_properties[] = {
 928     DEFINE_PROP_UINT32("num_queues", VirtIOSCSI, parent_obj.conf.num_queues, 1),
 929     DEFINE_PROP_UINT32("max_sectors", VirtIOSCSI, parent_obj.conf.max_sectors,
 930                                                   0xFFFF),
 931     DEFINE_PROP_UINT32("cmd_per_lun", VirtIOSCSI, parent_obj.conf.cmd_per_lun,
 932                                                   128),
 933     DEFINE_PROP_BIT("hotplug", VirtIOSCSI, host_features,
 934                                            VIRTIO_SCSI_F_HOTPLUG, true),
 935     DEFINE_PROP_BIT("param_change", VirtIOSCSI, host_features,
 936                                                 VIRTIO_SCSI_F_CHANGE, true),
 937     DEFINE_PROP_END_OF_LIST(),
 938 };
 939
 940 static const VMStateDescription vmstate_virtio_scsi = {
 941     .name = "virtio-scsi",
 942     .minimum_version_id = 1,
 943     .version_id = 1,
 944     .fields = (VMStateField[]) {
 945         VMSTATE_VIRTIO_DEVICE,
 946         VMSTATE_END_OF_LIST()
 947     },
 948 };
 949
 950 static void virtio_scsi_common_class_init(ObjectClass *klass, void *data)
 951 {
 952     VirtioDeviceClass *vdc = VIRTIO_DEVICE_CLASS(klass);
 953     DeviceClass *dc = DEVICE_CLASS(klass);
 954
 955     vdc->get_config = virtio_scsi_get_config;
 956     set_bit(DEVICE_CATEGORY_STORAGE, dc->categories);
 957 }
 958
 959 static void virtio_scsi_class_init(ObjectClass *klass, void *data)
 960 {
 961     DeviceClass *dc = DEVICE_CLASS(klass);
 962     VirtioDeviceClass *vdc = VIRTIO_DEVICE_CLASS(klass);
 963     HotplugHandlerClass *hc = HOTPLUG_HANDLER_CLASS(klass);
 964
 965     dc->props = virtio_scsi_properties;
 966     dc->vmsd = &vmstate_virtio_scsi;
 967     set_bit(DEVICE_CATEGORY_STORAGE, dc->categories);
 968     vdc->realize = virtio_scsi_device_realize;
 969     vdc->unrealize = virtio_scsi_device_unrealize;
 970     vdc->set_config = virtio_scsi_set_config;
 971     vdc->get_features = virtio_scsi_get_features;
 972     vdc->reset = virtio_scsi_reset;
 973     vdc->start_ioeventfd = virtio_scsi_dataplane_start;
 974     vdc->stop_ioeventfd = virtio_scsi_dataplane_stop;
 975     hc->plug = virtio_scsi_hotplug;
 976     hc->unplug = virtio_scsi_hotunplug;
 977 }
 978
 979 static const TypeInfo virtio_scsi_common_info = {
 980     .name = TYPE_VIRTIO_SCSI_COMMON,
 981     .parent = TYPE_VIRTIO_DEVICE,
 982     .instance_size = sizeof(VirtIOSCSICommon),
 983     .abstract = true,
 984     .class_init = virtio_scsi_common_class_init,
 985 };
 986
 987 static const TypeInfo virtio_scsi_info = {
 988     .name = TYPE_VIRTIO_SCSI,
 989     .parent = TYPE_VIRTIO_SCSI_COMMON,
 990     .instance_size = sizeof(VirtIOSCSI),
 991     .instance_init = virtio_scsi_instance_init,
 992     .class_init = virtio_scsi_class_init,
 993     .interfaces = (InterfaceInfo[]) {
 994         { TYPE_HOTPLUG_HANDLER },
 995         { }
 996     }
 997 };
 998
 999 static void virtio_register_types(void)
1000 {
1001     type_register_static(&virtio_scsi_common_info);
1002     type_register_static(&virtio_scsi_info);
1003 }
1004
1005 type_init(virtio_register_types)