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