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