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 bool virtio_scsi_handle_ctrl_vq(VirtIOSCSI *s, VirtQueue *vq)
 426 {
 427     VirtIOSCSIReq *req;
 428     bool progress = false;
 429
 430     while ((req = virtio_scsi_pop_req(s, vq))) {
 431         progress = true;
 432         virtio_scsi_handle_ctrl_req(s, req);
 433     }
 434     return progress;
 435 }
 436
 437 static void virtio_scsi_handle_ctrl(VirtIODevice *vdev, VirtQueue *vq)
 438 {
 439     VirtIOSCSI *s = (VirtIOSCSI *)vdev;
 440
 441     if (s->ctx) {
 442         virtio_device_start_ioeventfd(vdev);
 443         if (!s->dataplane_fenced) {
 444             return;
 445         }
 446     }
 447     virtio_scsi_acquire(s);
 448     virtio_scsi_handle_ctrl_vq(s, vq);
 449     virtio_scsi_release(s);
 450 }
 451
 452 static void virtio_scsi_complete_cmd_req(VirtIOSCSIReq *req)
 453 {
 454     /* Sense data is not in req->resp and is copied separately
 455      * in virtio_scsi_command_complete.
 456      */
 457     req->resp_size = sizeof(VirtIOSCSICmdResp);
 458     virtio_scsi_complete_req(req);
 459 }
 460
 461 static void virtio_scsi_command_complete(SCSIRequest *r, uint32_t status,
 462                                          size_t resid)
 463 {
 464     VirtIOSCSIReq *req = r->hba_private;
 465     uint8_t sense[SCSI_SENSE_BUF_SIZE];
 466     uint32_t sense_len;
 467     VirtIODevice *vdev = VIRTIO_DEVICE(req->dev);
 468
 469     if (r->io_canceled) {
 470         return;
 471     }
 472
 473     req->resp.cmd.response = VIRTIO_SCSI_S_OK;
 474     req->resp.cmd.status = status;
 475     if (req->resp.cmd.status == GOOD) {
 476         req->resp.cmd.resid = virtio_tswap32(vdev, resid);
 477     } else {
 478         req->resp.cmd.resid = 0;
 479         sense_len = scsi_req_get_sense(r, sense, sizeof(sense));
 480         sense_len = MIN(sense_len, req->resp_iov.size - sizeof(req->resp.cmd));
 481         qemu_iovec_from_buf(&req->resp_iov, sizeof(req->resp.cmd),
 482                             sense, sense_len);
 483         req->resp.cmd.sense_len = virtio_tswap32(vdev, sense_len);
 484     }
 485     virtio_scsi_complete_cmd_req(req);
 486 }
 487
 488 static int virtio_scsi_parse_cdb(SCSIDevice *dev, SCSICommand *cmd,
 489                                  uint8_t *buf, void *hba_private)
 490 {
 491     VirtIOSCSIReq *req = hba_private;
 492
 493     if (cmd->len == 0) {
 494         cmd->len = MIN(VIRTIO_SCSI_CDB_DEFAULT_SIZE, SCSI_CMD_BUF_SIZE);
 495         memcpy(cmd->buf, buf, cmd->len);
 496     }
 497
 498     /* Extract the direction and mode directly from the request, for
 499      * host device passthrough.
 500      */
 501     cmd->xfer = req->qsgl.size;
 502     cmd->mode = req->mode;
 503     return 0;
 504 }
 505
 506 static QEMUSGList *virtio_scsi_get_sg_list(SCSIRequest *r)
 507 {
 508     VirtIOSCSIReq *req = r->hba_private;
 509
 510     return &req->qsgl;
 511 }
 512
 513 static void virtio_scsi_request_cancelled(SCSIRequest *r)
 514 {
 515     VirtIOSCSIReq *req = r->hba_private;
 516
 517     if (!req) {
 518         return;
 519     }
 520     if (req->dev->resetting) {
 521         req->resp.cmd.response = VIRTIO_SCSI_S_RESET;
 522     } else {
 523         req->resp.cmd.response = VIRTIO_SCSI_S_ABORTED;
 524     }
 525     virtio_scsi_complete_cmd_req(req);
 526 }
 527
 528 static void virtio_scsi_fail_cmd_req(VirtIOSCSIReq *req)
 529 {
 530     req->resp.cmd.response = VIRTIO_SCSI_S_FAILURE;
 531     virtio_scsi_complete_cmd_req(req);
 532 }
 533
 534 static int virtio_scsi_handle_cmd_req_prepare(VirtIOSCSI *s, VirtIOSCSIReq *req)
 535 {
 536     VirtIOSCSICommon *vs = &s->parent_obj;
 537     SCSIDevice *d;
 538     int rc;
 539
 540     rc = virtio_scsi_parse_req(req, sizeof(VirtIOSCSICmdReq) + vs->cdb_size,
 541                                sizeof(VirtIOSCSICmdResp) + vs->sense_size);
 542     if (rc < 0) {
 543         if (rc == -ENOTSUP) {
 544             virtio_scsi_fail_cmd_req(req);
 545             return -ENOTSUP;
 546         } else {
 547             virtio_scsi_bad_req(req);
 548             return -EINVAL;
 549         }
 550     }
 551
 552     d = virtio_scsi_device_find(s, req->req.cmd.lun);
 553     if (!d) {
 554         req->resp.cmd.response = VIRTIO_SCSI_S_BAD_TARGET;
 555         virtio_scsi_complete_cmd_req(req);
 556         return -ENOENT;
 557     }
 558     virtio_scsi_ctx_check(s, d);
 559     req->sreq = scsi_req_new(d, req->req.cmd.tag,
 560                              virtio_scsi_get_lun(req->req.cmd.lun),
 561                              req->req.cmd.cdb, req);
 562
 563     if (req->sreq->cmd.mode != SCSI_XFER_NONE
 564         && (req->sreq->cmd.mode != req->mode ||
 565             req->sreq->cmd.xfer > req->qsgl.size)) {
 566         req->resp.cmd.response = VIRTIO_SCSI_S_OVERRUN;
 567         virtio_scsi_complete_cmd_req(req);
 568         return -ENOBUFS;
 569     }
 570     scsi_req_ref(req->sreq);
 571     blk_io_plug(d->conf.blk);
 572     return 0;
 573 }
 574
 575 static void virtio_scsi_handle_cmd_req_submit(VirtIOSCSI *s, VirtIOSCSIReq *req)
 576 {
 577     SCSIRequest *sreq = req->sreq;
 578     if (scsi_req_enqueue(sreq)) {
 579         scsi_req_continue(sreq);
 580     }
 581     blk_io_unplug(sreq->dev->conf.blk);
 582     scsi_req_unref(sreq);
 583 }
 584
 585 bool virtio_scsi_handle_cmd_vq(VirtIOSCSI *s, VirtQueue *vq)
 586 {
 587     VirtIOSCSIReq *req, *next;
 588     int ret = 0;
 589     bool progress = false;
 590
 591     QTAILQ_HEAD(, VirtIOSCSIReq) reqs = QTAILQ_HEAD_INITIALIZER(reqs);
 592
 593     do {
 594         virtio_queue_set_notification(vq, 0);
 595
 596         while ((req = virtio_scsi_pop_req(s, vq))) {
 597             progress = true;
 598             ret = virtio_scsi_handle_cmd_req_prepare(s, req);
 599             if (!ret) {
 600                 QTAILQ_INSERT_TAIL(&reqs, req, next);
 601             } else if (ret == -EINVAL) {
 602                 /* The device is broken and shouldn't process any request */
 603                 while (!QTAILQ_EMPTY(&reqs)) {
 604                     req = QTAILQ_FIRST(&reqs);
 605                     QTAILQ_REMOVE(&reqs, req, next);
 606                     blk_io_unplug(req->sreq->dev->conf.blk);
 607                     scsi_req_unref(req->sreq);
 608                     virtqueue_detach_element(req->vq, &req->elem, 0);
 609                     virtio_scsi_free_req(req);
 610                 }
 611             }
 612         }
 613
 614         virtio_queue_set_notification(vq, 1);
 615     } while (ret != -EINVAL && !virtio_queue_empty(vq));
 616
 617     QTAILQ_FOREACH_SAFE(req, &reqs, next, next) {
 618         virtio_scsi_handle_cmd_req_submit(s, req);
 619     }
 620     return progress;
 621 }
 622
 623 static void virtio_scsi_handle_cmd(VirtIODevice *vdev, VirtQueue *vq)
 624 {
 625     /* use non-QOM casts in the data path */
 626     VirtIOSCSI *s = (VirtIOSCSI *)vdev;
 627
 628     if (s->ctx) {
 629         virtio_device_start_ioeventfd(vdev);
 630         if (!s->dataplane_fenced) {
 631             return;
 632         }
 633     }
 634     virtio_scsi_acquire(s);
 635     virtio_scsi_handle_cmd_vq(s, vq);
 636     virtio_scsi_release(s);
 637 }
 638
 639 static void virtio_scsi_get_config(VirtIODevice *vdev,
 640                                    uint8_t *config)
 641 {
 642     VirtIOSCSIConfig *scsiconf = (VirtIOSCSIConfig *)config;
 643     VirtIOSCSICommon *s = VIRTIO_SCSI_COMMON(vdev);
 644
 645     virtio_stl_p(vdev, &scsiconf->num_queues, s->conf.num_queues);
 646     virtio_stl_p(vdev, &scsiconf->seg_max, 128 - 2);
 647     virtio_stl_p(vdev, &scsiconf->max_sectors, s->conf.max_sectors);
 648     virtio_stl_p(vdev, &scsiconf->cmd_per_lun, s->conf.cmd_per_lun);
 649     virtio_stl_p(vdev, &scsiconf->event_info_size, sizeof(VirtIOSCSIEvent));
 650     virtio_stl_p(vdev, &scsiconf->sense_size, s->sense_size);
 651     virtio_stl_p(vdev, &scsiconf->cdb_size, s->cdb_size);
 652     virtio_stw_p(vdev, &scsiconf->max_channel, VIRTIO_SCSI_MAX_CHANNEL);
 653     virtio_stw_p(vdev, &scsiconf->max_target, VIRTIO_SCSI_MAX_TARGET);
 654     virtio_stl_p(vdev, &scsiconf->max_lun, VIRTIO_SCSI_MAX_LUN);
 655 }
 656
 657 static void virtio_scsi_set_config(VirtIODevice *vdev,
 658                                    const uint8_t *config)
 659 {
 660     VirtIOSCSIConfig *scsiconf = (VirtIOSCSIConfig *)config;
 661     VirtIOSCSICommon *vs = VIRTIO_SCSI_COMMON(vdev);
 662
 663     if ((uint32_t) virtio_ldl_p(vdev, &scsiconf->sense_size) >= 65536 ||
 664         (uint32_t) virtio_ldl_p(vdev, &scsiconf->cdb_size) >= 256) {
 665         virtio_error(vdev,
 666                      "bad data written to virtio-scsi configuration space");
 667         return;
 668     }
 669
 670     vs->sense_size = virtio_ldl_p(vdev, &scsiconf->sense_size);
 671     vs->cdb_size = virtio_ldl_p(vdev, &scsiconf->cdb_size);
 672 }
 673
 674 static uint64_t virtio_scsi_get_features(VirtIODevice *vdev,
 675                                          uint64_t requested_features,
 676                                          Error **errp)
 677 {
 678     VirtIOSCSI *s = VIRTIO_SCSI(vdev);
 679
 680     /* Firstly sync all virtio-scsi possible supported features */
 681     requested_features |= s->host_features;
 682     return requested_features;
 683 }
 684
 685 static void virtio_scsi_reset(VirtIODevice *vdev)
 686 {
 687     VirtIOSCSI *s = VIRTIO_SCSI(vdev);
 688     VirtIOSCSICommon *vs = VIRTIO_SCSI_COMMON(vdev);
 689
 690     assert(!s->dataplane_started);
 691     s->resetting++;
 692     qbus_reset_all(&s->bus.qbus);
 693     s->resetting--;
 694
 695     vs->sense_size = VIRTIO_SCSI_SENSE_DEFAULT_SIZE;
 696     vs->cdb_size = VIRTIO_SCSI_CDB_DEFAULT_SIZE;
 697     s->events_dropped = false;
 698 }
 699
 700 void virtio_scsi_push_event(VirtIOSCSI *s, SCSIDevice *dev,
 701                             uint32_t event, uint32_t reason)
 702 {
 703     VirtIOSCSICommon *vs = VIRTIO_SCSI_COMMON(s);
 704     VirtIOSCSIReq *req;
 705     VirtIOSCSIEvent *evt;
 706     VirtIODevice *vdev = VIRTIO_DEVICE(s);
 707
 708     if (!(vdev->status & VIRTIO_CONFIG_S_DRIVER_OK)) {
 709         return;
 710     }
 711
 712     req = virtio_scsi_pop_req(s, vs->event_vq);
 713     if (!req) {
 714         s->events_dropped = true;
 715         return;
 716     }
 717
 718     if (s->events_dropped) {
 719         event |= VIRTIO_SCSI_T_EVENTS_MISSED;
 720         s->events_dropped = false;
 721     }
 722
 723     if (virtio_scsi_parse_req(req, 0, sizeof(VirtIOSCSIEvent))) {
 724         virtio_scsi_bad_req(req);
 725         return;
 726     }
 727
 728     evt = &req->resp.event;
 729     memset(evt, 0, sizeof(VirtIOSCSIEvent));
 730     evt->event = virtio_tswap32(vdev, event);
 731     evt->reason = virtio_tswap32(vdev, reason);
 732     if (!dev) {
 733         assert(event == VIRTIO_SCSI_T_EVENTS_MISSED);
 734     } else {
 735         evt->lun[0] = 1;
 736         evt->lun[1] = dev->id;
 737
 738         /* Linux wants us to keep the same encoding we use for REPORT LUNS.  */
 739         if (dev->lun >= 256) {
 740             evt->lun[2] = (dev->lun >> 8) | 0x40;
 741         }
 742         evt->lun[3] = dev->lun & 0xFF;
 743     }
 744     virtio_scsi_complete_req(req);
 745 }
 746
 747 bool virtio_scsi_handle_event_vq(VirtIOSCSI *s, VirtQueue *vq)
 748 {
 749     if (s->events_dropped) {
 750         virtio_scsi_push_event(s, NULL, VIRTIO_SCSI_T_NO_EVENT, 0);
 751         return true;
 752     }
 753     return false;
 754 }
 755
 756 static void virtio_scsi_handle_event(VirtIODevice *vdev, VirtQueue *vq)
 757 {
 758     VirtIOSCSI *s = VIRTIO_SCSI(vdev);
 759
 760     if (s->ctx) {
 761         virtio_device_start_ioeventfd(vdev);
 762         if (!s->dataplane_fenced) {
 763             return;
 764         }
 765     }
 766     virtio_scsi_acquire(s);
 767     virtio_scsi_handle_event_vq(s, vq);
 768     virtio_scsi_release(s);
 769 }
 770
 771 static void virtio_scsi_change(SCSIBus *bus, SCSIDevice *dev, SCSISense sense)
 772 {
 773     VirtIOSCSI *s = container_of(bus, VirtIOSCSI, bus);
 774     VirtIODevice *vdev = VIRTIO_DEVICE(s);
 775
 776     if (virtio_vdev_has_feature(vdev, VIRTIO_SCSI_F_CHANGE) &&
 777         dev->type != TYPE_ROM) {
 778         virtio_scsi_acquire(s);
 779         virtio_scsi_push_event(s, dev, VIRTIO_SCSI_T_PARAM_CHANGE,
 780                                sense.asc | (sense.ascq << 8));
 781         virtio_scsi_release(s);
 782     }
 783 }
 784
 785 static void virtio_scsi_hotplug(HotplugHandler *hotplug_dev, DeviceState *dev,
 786                                 Error **errp)
 787 {
 788     VirtIODevice *vdev = VIRTIO_DEVICE(hotplug_dev);
 789     VirtIOSCSI *s = VIRTIO_SCSI(vdev);
 790     SCSIDevice *sd = SCSI_DEVICE(dev);
 791
 792     if (s->ctx && !s->dataplane_fenced) {
 793         if (blk_op_is_blocked(sd->conf.blk, BLOCK_OP_TYPE_DATAPLANE, errp)) {
 794             return;
 795         }
 796         virtio_scsi_acquire(s);
 797         blk_set_aio_context(sd->conf.blk, s->ctx);
 798         virtio_scsi_release(s);
 799
 800     }
 801
 802     if (virtio_vdev_has_feature(vdev, VIRTIO_SCSI_F_HOTPLUG)) {
 803         virtio_scsi_acquire(s);
 804         virtio_scsi_push_event(s, sd,
 805                                VIRTIO_SCSI_T_TRANSPORT_RESET,
 806                                VIRTIO_SCSI_EVT_RESET_RESCAN);
 807         virtio_scsi_release(s);
 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_acquire(s);
 820         virtio_scsi_push_event(s, sd,
 821                                VIRTIO_SCSI_T_TRANSPORT_RESET,
 822                                VIRTIO_SCSI_EVT_RESET_REMOVED);
 823         virtio_scsi_release(s);
 824     }
 825
 826     qdev_simple_device_unplug_cb(hotplug_dev, dev, errp);
 827 }
 828
 829 static struct SCSIBusInfo virtio_scsi_scsi_info = {
 830     .tcq = true,
 831     .max_channel = VIRTIO_SCSI_MAX_CHANNEL,
 832     .max_target = VIRTIO_SCSI_MAX_TARGET,
 833     .max_lun = VIRTIO_SCSI_MAX_LUN,
 834
 835     .complete = virtio_scsi_command_complete,
 836     .cancel = virtio_scsi_request_cancelled,
 837     .change = virtio_scsi_change,
 838     .parse_cdb = virtio_scsi_parse_cdb,
 839     .get_sg_list = virtio_scsi_get_sg_list,
 840     .save_request = virtio_scsi_save_request,
 841     .load_request = virtio_scsi_load_request,
 842 };
 843
 844 void virtio_scsi_common_realize(DeviceState *dev,
 845                                 VirtIOHandleOutput ctrl,
 846                                 VirtIOHandleOutput evt,
 847                                 VirtIOHandleOutput cmd,
 848                                 Error **errp)
 849 {
 850     VirtIODevice *vdev = VIRTIO_DEVICE(dev);
 851     VirtIOSCSICommon *s = VIRTIO_SCSI_COMMON(dev);
 852     int i;
 853
 854     virtio_init(vdev, "virtio-scsi", VIRTIO_ID_SCSI,
 855                 sizeof(VirtIOSCSIConfig));
 856
 857     if (s->conf.num_queues == 0 ||
 858             s->conf.num_queues > VIRTIO_QUEUE_MAX - 2) {
 859         error_setg(errp, "Invalid number of queues (= %" PRIu32 "), "
 860                          "must be a positive integer less than %d.",
 861                    s->conf.num_queues, VIRTIO_QUEUE_MAX - 2);
 862         virtio_cleanup(vdev);
 863         return;
 864     }
 865     s->cmd_vqs = g_new0(VirtQueue *, s->conf.num_queues);
 866     s->sense_size = VIRTIO_SCSI_SENSE_DEFAULT_SIZE;
 867     s->cdb_size = VIRTIO_SCSI_CDB_DEFAULT_SIZE;
 868
 869     s->ctrl_vq = virtio_add_queue(vdev, VIRTIO_SCSI_VQ_SIZE, ctrl);
 870     s->event_vq = virtio_add_queue(vdev, VIRTIO_SCSI_VQ_SIZE, evt);
 871     for (i = 0; i < s->conf.num_queues; i++) {
 872         s->cmd_vqs[i] = virtio_add_queue(vdev, VIRTIO_SCSI_VQ_SIZE, cmd);
 873     }
 874 }
 875
 876 static void virtio_scsi_device_realize(DeviceState *dev, Error **errp)
 877 {
 878     VirtIODevice *vdev = VIRTIO_DEVICE(dev);
 879     VirtIOSCSI *s = VIRTIO_SCSI(dev);
 880     Error *err = NULL;
 881
 882     virtio_scsi_common_realize(dev,
 883                                virtio_scsi_handle_ctrl,
 884                                virtio_scsi_handle_event,
 885                                virtio_scsi_handle_cmd,
 886                                &err);
 887     if (err != NULL) {
 888         error_propagate(errp, err);
 889         return;
 890     }
 891
 892     scsi_bus_new(&s->bus, sizeof(s->bus), dev,
 893                  &virtio_scsi_scsi_info, vdev->bus_name);
 894     /* override default SCSI bus hotplug-handler, with virtio-scsi's one */
 895     qbus_set_hotplug_handler(BUS(&s->bus), dev, &error_abort);
 896
 897     virtio_scsi_dataplane_setup(s, errp);
 898 }
 899
 900 static void virtio_scsi_instance_init(Object *obj)
 901 {
 902     VirtIOSCSICommon *vs = VIRTIO_SCSI_COMMON(obj);
 903
 904     object_property_add_link(obj, "iothread", TYPE_IOTHREAD,
 905                              (Object **)&vs->conf.iothread,
 906                              qdev_prop_allow_set_link_before_realize,
 907                              OBJ_PROP_LINK_UNREF_ON_RELEASE, &error_abort);
 908 }
 909
 910 void virtio_scsi_common_unrealize(DeviceState *dev, Error **errp)
 911 {
 912     VirtIODevice *vdev = VIRTIO_DEVICE(dev);
 913     VirtIOSCSICommon *vs = VIRTIO_SCSI_COMMON(dev);
 914
 915     g_free(vs->cmd_vqs);
 916     virtio_cleanup(vdev);
 917 }
 918
 919 static void virtio_scsi_device_unrealize(DeviceState *dev, Error **errp)
 920 {
 921     virtio_scsi_common_unrealize(dev, errp);
 922 }
 923
 924 static Property virtio_scsi_properties[] = {
 925     DEFINE_PROP_UINT32("num_queues", VirtIOSCSI, parent_obj.conf.num_queues, 1),
 926     DEFINE_PROP_UINT32("max_sectors", VirtIOSCSI, parent_obj.conf.max_sectors,
 927                                                   0xFFFF),
 928     DEFINE_PROP_UINT32("cmd_per_lun", VirtIOSCSI, parent_obj.conf.cmd_per_lun,
 929                                                   128),
 930     DEFINE_PROP_BIT("hotplug", VirtIOSCSI, host_features,
 931                                            VIRTIO_SCSI_F_HOTPLUG, true),
 932     DEFINE_PROP_BIT("param_change", VirtIOSCSI, host_features,
 933                                                 VIRTIO_SCSI_F_CHANGE, true),
 934     DEFINE_PROP_END_OF_LIST(),
 935 };
 936
 937 static const VMStateDescription vmstate_virtio_scsi = {
 938     .name = "virtio-scsi",
 939     .minimum_version_id = 1,
 940     .version_id = 1,
 941     .fields = (VMStateField[]) {
 942         VMSTATE_VIRTIO_DEVICE,
 943         VMSTATE_END_OF_LIST()
 944     },
 945 };
 946
 947 static void virtio_scsi_common_class_init(ObjectClass *klass, void *data)
 948 {
 949     VirtioDeviceClass *vdc = VIRTIO_DEVICE_CLASS(klass);
 950     DeviceClass *dc = DEVICE_CLASS(klass);
 951
 952     vdc->get_config = virtio_scsi_get_config;
 953     set_bit(DEVICE_CATEGORY_STORAGE, dc->categories);
 954 }
 955
 956 static void virtio_scsi_class_init(ObjectClass *klass, void *data)
 957 {
 958     DeviceClass *dc = DEVICE_CLASS(klass);
 959     VirtioDeviceClass *vdc = VIRTIO_DEVICE_CLASS(klass);
 960     HotplugHandlerClass *hc = HOTPLUG_HANDLER_CLASS(klass);
 961
 962     dc->props = virtio_scsi_properties;
 963     dc->vmsd = &vmstate_virtio_scsi;
 964     set_bit(DEVICE_CATEGORY_STORAGE, dc->categories);
 965     vdc->realize = virtio_scsi_device_realize;
 966     vdc->unrealize = virtio_scsi_device_unrealize;
 967     vdc->set_config = virtio_scsi_set_config;
 968     vdc->get_features = virtio_scsi_get_features;
 969     vdc->reset = virtio_scsi_reset;
 970     vdc->start_ioeventfd = virtio_scsi_dataplane_start;
 971     vdc->stop_ioeventfd = virtio_scsi_dataplane_stop;
 972     hc->plug = virtio_scsi_hotplug;
 973     hc->unplug = virtio_scsi_hotunplug;
 974 }
 975
 976 static const TypeInfo virtio_scsi_common_info = {
 977     .name = TYPE_VIRTIO_SCSI_COMMON,
 978     .parent = TYPE_VIRTIO_DEVICE,
 979     .instance_size = sizeof(VirtIOSCSICommon),
 980     .abstract = true,
 981     .class_init = virtio_scsi_common_class_init,
 982 };
 983
 984 static const TypeInfo virtio_scsi_info = {
 985     .name = TYPE_VIRTIO_SCSI,
 986     .parent = TYPE_VIRTIO_SCSI_COMMON,
 987     .instance_size = sizeof(VirtIOSCSI),
 988     .instance_init = virtio_scsi_instance_init,
 989     .class_init = virtio_scsi_class_init,
 990     .interfaces = (InterfaceInfo[]) {
 991         { TYPE_HOTPLUG_HANDLER },
 992         { }
 993     }
 994 };
 995
 996 static void virtio_register_types(void)
 997 {
 998     type_register_static(&virtio_scsi_common_info);
 999     type_register_static(&virtio_scsi_info);
1000 }
1001
1002 type_init(virtio_register_types)