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