4 * Copyright IBM, Corp. 2010
5 * Copyright Red Hat, Inc. 2011
8 * Stefan Hajnoczi <stefanha@linux.vnet.ibm.com>
9 * Paolo Bonzini <pbonzini@redhat.com>
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.
16 #include "standard-headers/linux/virtio_ids.h"
17 #include "hw/virtio/virtio-scsi.h"
18 #include "qemu/error-report.h"
20 #include "sysemu/block-backend.h"
21 #include <hw/scsi/scsi.h>
22 #include <block/scsi.h>
23 #include <hw/virtio/virtio-bus.h>
24 #include "hw/virtio/virtio-access.h"
25 #include "migration/migration.h"
27 static inline int virtio_scsi_get_lun(uint8_t *lun
)
29 return ((lun
[2] << 8) | lun
[3]) & 0x3FFF;
32 static inline SCSIDevice
*virtio_scsi_device_find(VirtIOSCSI
*s
, uint8_t *lun
)
37 if (lun
[2] != 0 && !(lun
[2] >= 0x40 && lun
[2] < 0x80)) {
40 return scsi_device_find(&s
->bus
, 0, lun
[1], virtio_scsi_get_lun(lun
));
43 VirtIOSCSIReq
*virtio_scsi_init_req(VirtIOSCSI
*s
, VirtQueue
*vq
)
46 VirtIOSCSICommon
*vs
= (VirtIOSCSICommon
*)s
;
47 const size_t zero_skip
= offsetof(VirtIOSCSIReq
, elem
)
48 + sizeof(VirtQueueElement
);
50 req
= g_slice_alloc(sizeof(*req
) + vs
->cdb_size
);
53 qemu_sglist_init(&req
->qsgl
, DEVICE(s
), 8, &address_space_memory
);
54 qemu_iovec_init(&req
->resp_iov
, 1);
55 memset((uint8_t *)req
+ zero_skip
, 0, sizeof(*req
) - zero_skip
);
59 void virtio_scsi_free_req(VirtIOSCSIReq
*req
)
61 VirtIOSCSICommon
*vs
= (VirtIOSCSICommon
*)req
->dev
;
63 qemu_iovec_destroy(&req
->resp_iov
);
64 qemu_sglist_destroy(&req
->qsgl
);
65 g_slice_free1(sizeof(*req
) + vs
->cdb_size
, req
);
68 static void virtio_scsi_complete_req(VirtIOSCSIReq
*req
)
70 VirtIOSCSI
*s
= req
->dev
;
71 VirtQueue
*vq
= req
->vq
;
72 VirtIODevice
*vdev
= VIRTIO_DEVICE(s
);
74 qemu_iovec_from_buf(&req
->resp_iov
, 0, &req
->resp
, req
->resp_size
);
76 assert(req
->vq
== NULL
);
77 virtio_scsi_vring_push_notify(req
);
79 virtqueue_push(vq
, &req
->elem
, req
->qsgl
.size
+ req
->resp_iov
.size
);
80 virtio_notify(vdev
, vq
);
84 req
->sreq
->hba_private
= NULL
;
85 scsi_req_unref(req
->sreq
);
87 virtio_scsi_free_req(req
);
90 static void virtio_scsi_bad_req(void)
92 error_report("wrong size for virtio-scsi headers");
96 static size_t qemu_sgl_concat(VirtIOSCSIReq
*req
, struct iovec
*iov
,
97 hwaddr
*addr
, int num
, size_t skip
)
99 QEMUSGList
*qsgl
= &req
->qsgl
;
103 if (skip
>= iov
->iov_len
) {
104 skip
-= iov
->iov_len
;
106 qemu_sglist_add(qsgl
, *addr
+ skip
, iov
->iov_len
- skip
);
107 copied
+= iov
->iov_len
- skip
;
119 static int virtio_scsi_parse_req(VirtIOSCSIReq
*req
,
120 unsigned req_size
, unsigned resp_size
)
122 VirtIODevice
*vdev
= (VirtIODevice
*) req
->dev
;
123 size_t in_size
, out_size
;
125 if (iov_to_buf(req
->elem
.out_sg
, req
->elem
.out_num
, 0,
126 &req
->req
, req_size
) < req_size
) {
130 if (qemu_iovec_concat_iov(&req
->resp_iov
,
131 req
->elem
.in_sg
, req
->elem
.in_num
, 0,
132 resp_size
) < resp_size
) {
136 req
->resp_size
= resp_size
;
138 /* Old BIOSes left some padding by mistake after the req_size/resp_size.
139 * As a workaround, always consider the first buffer as the virtio-scsi
140 * request/response, making the payload start at the second element
143 * The actual length of the response header, stored in req->resp_size,
146 * TODO: always disable this workaround for virtio 1.0 devices.
148 if (!virtio_has_feature(vdev
, VIRTIO_F_ANY_LAYOUT
)) {
149 if (req
->elem
.out_num
) {
150 req_size
= req
->elem
.out_sg
[0].iov_len
;
152 if (req
->elem
.in_num
) {
153 resp_size
= req
->elem
.in_sg
[0].iov_len
;
157 out_size
= qemu_sgl_concat(req
, req
->elem
.out_sg
,
158 &req
->elem
.out_addr
[0], req
->elem
.out_num
,
160 in_size
= qemu_sgl_concat(req
, req
->elem
.in_sg
,
161 &req
->elem
.in_addr
[0], req
->elem
.in_num
,
164 if (out_size
&& in_size
) {
169 req
->mode
= SCSI_XFER_TO_DEV
;
170 } else if (in_size
) {
171 req
->mode
= SCSI_XFER_FROM_DEV
;
177 static VirtIOSCSIReq
*virtio_scsi_pop_req(VirtIOSCSI
*s
, VirtQueue
*vq
)
179 VirtIOSCSIReq
*req
= virtio_scsi_init_req(s
, vq
);
180 if (!virtqueue_pop(vq
, &req
->elem
)) {
181 virtio_scsi_free_req(req
);
187 static void virtio_scsi_save_request(QEMUFile
*f
, SCSIRequest
*sreq
)
189 VirtIOSCSIReq
*req
= sreq
->hba_private
;
190 VirtIOSCSICommon
*vs
= VIRTIO_SCSI_COMMON(req
->dev
);
191 uint32_t n
= virtio_queue_get_id(req
->vq
) - 2;
193 assert(n
< vs
->conf
.num_queues
);
194 qemu_put_be32s(f
, &n
);
195 qemu_put_buffer(f
, (unsigned char *)&req
->elem
, sizeof(req
->elem
));
198 static void *virtio_scsi_load_request(QEMUFile
*f
, SCSIRequest
*sreq
)
200 SCSIBus
*bus
= sreq
->bus
;
201 VirtIOSCSI
*s
= container_of(bus
, VirtIOSCSI
, bus
);
202 VirtIOSCSICommon
*vs
= VIRTIO_SCSI_COMMON(s
);
206 qemu_get_be32s(f
, &n
);
207 assert(n
< vs
->conf
.num_queues
);
208 req
= virtio_scsi_init_req(s
, vs
->cmd_vqs
[n
]);
209 qemu_get_buffer(f
, (unsigned char *)&req
->elem
, sizeof(req
->elem
));
210 /* TODO: add a way for SCSIBusInfo's load_request to fail,
211 * and fail migration instead of asserting here.
212 * When we do, we might be able to re-enable NDEBUG below.
215 #error building with NDEBUG is not supported
217 assert(req
->elem
.in_num
<= ARRAY_SIZE(req
->elem
.in_sg
));
218 assert(req
->elem
.out_num
<= ARRAY_SIZE(req
->elem
.out_sg
));
220 if (virtio_scsi_parse_req(req
, sizeof(VirtIOSCSICmdReq
) + vs
->cdb_size
,
221 sizeof(VirtIOSCSICmdResp
) + vs
->sense_size
) < 0) {
222 error_report("invalid SCSI request migration data");
228 if (req
->sreq
->cmd
.mode
!= SCSI_XFER_NONE
) {
229 assert(req
->sreq
->cmd
.mode
== req
->mode
);
236 VirtIOSCSIReq
*tmf_req
;
237 } VirtIOSCSICancelNotifier
;
239 static void virtio_scsi_cancel_notify(Notifier
*notifier
, void *data
)
241 VirtIOSCSICancelNotifier
*n
= container_of(notifier
,
242 VirtIOSCSICancelNotifier
,
245 if (--n
->tmf_req
->remaining
== 0) {
246 virtio_scsi_complete_req(n
->tmf_req
);
248 g_slice_free(VirtIOSCSICancelNotifier
, n
);
251 /* Return 0 if the request is ready to be completed and return to guest;
252 * -EINPROGRESS if the request is submitted and will be completed later, in the
253 * case of async cancellation. */
254 static int virtio_scsi_do_tmf(VirtIOSCSI
*s
, VirtIOSCSIReq
*req
)
256 SCSIDevice
*d
= virtio_scsi_device_find(s
, req
->req
.tmf
.lun
);
257 SCSIRequest
*r
, *next
;
262 if (s
->dataplane_started
) {
263 assert(blk_get_aio_context(d
->conf
.blk
) == s
->ctx
);
265 /* Here VIRTIO_SCSI_S_OK means "FUNCTION COMPLETE". */
266 req
->resp
.tmf
.response
= VIRTIO_SCSI_S_OK
;
268 virtio_tswap32s(VIRTIO_DEVICE(s
), &req
->req
.tmf
.subtype
);
269 switch (req
->req
.tmf
.subtype
) {
270 case VIRTIO_SCSI_T_TMF_ABORT_TASK
:
271 case VIRTIO_SCSI_T_TMF_QUERY_TASK
:
275 if (d
->lun
!= virtio_scsi_get_lun(req
->req
.tmf
.lun
)) {
278 QTAILQ_FOREACH_SAFE(r
, &d
->requests
, next
, next
) {
279 VirtIOSCSIReq
*cmd_req
= r
->hba_private
;
280 if (cmd_req
&& cmd_req
->req
.cmd
.tag
== req
->req
.tmf
.tag
) {
286 * Assert that the request has not been completed yet, we
287 * check for it in the loop above.
289 assert(r
->hba_private
);
290 if (req
->req
.tmf
.subtype
== VIRTIO_SCSI_T_TMF_QUERY_TASK
) {
291 /* "If the specified command is present in the task set, then
292 * return a service response set to FUNCTION SUCCEEDED".
294 req
->resp
.tmf
.response
= VIRTIO_SCSI_S_FUNCTION_SUCCEEDED
;
296 VirtIOSCSICancelNotifier
*notifier
;
299 notifier
= g_slice_new(VirtIOSCSICancelNotifier
);
300 notifier
->tmf_req
= req
;
301 notifier
->notifier
.notify
= virtio_scsi_cancel_notify
;
302 scsi_req_cancel_async(r
, ¬ifier
->notifier
);
308 case VIRTIO_SCSI_T_TMF_LOGICAL_UNIT_RESET
:
312 if (d
->lun
!= virtio_scsi_get_lun(req
->req
.tmf
.lun
)) {
316 qdev_reset_all(&d
->qdev
);
320 case VIRTIO_SCSI_T_TMF_ABORT_TASK_SET
:
321 case VIRTIO_SCSI_T_TMF_CLEAR_TASK_SET
:
322 case VIRTIO_SCSI_T_TMF_QUERY_TASK_SET
:
326 if (d
->lun
!= virtio_scsi_get_lun(req
->req
.tmf
.lun
)) {
330 /* Add 1 to "remaining" until virtio_scsi_do_tmf returns.
331 * This way, if the bus starts calling back to the notifiers
332 * even before we finish the loop, virtio_scsi_cancel_notify
333 * will not complete the TMF too early.
336 QTAILQ_FOREACH_SAFE(r
, &d
->requests
, next
, next
) {
337 if (r
->hba_private
) {
338 if (req
->req
.tmf
.subtype
== VIRTIO_SCSI_T_TMF_QUERY_TASK_SET
) {
339 /* "If there is any command present in the task set, then
340 * return a service response set to FUNCTION SUCCEEDED".
342 req
->resp
.tmf
.response
= VIRTIO_SCSI_S_FUNCTION_SUCCEEDED
;
345 VirtIOSCSICancelNotifier
*notifier
;
348 notifier
= g_slice_new(VirtIOSCSICancelNotifier
);
349 notifier
->notifier
.notify
= virtio_scsi_cancel_notify
;
350 notifier
->tmf_req
= req
;
351 scsi_req_cancel_async(r
, ¬ifier
->notifier
);
355 if (--req
->remaining
> 0) {
360 case VIRTIO_SCSI_T_TMF_I_T_NEXUS_RESET
:
361 target
= req
->req
.tmf
.lun
[1];
363 QTAILQ_FOREACH(kid
, &s
->bus
.qbus
.children
, sibling
) {
364 d
= DO_UPCAST(SCSIDevice
, qdev
, kid
->child
);
365 if (d
->channel
== 0 && d
->id
== target
) {
366 qdev_reset_all(&d
->qdev
);
372 case VIRTIO_SCSI_T_TMF_CLEAR_ACA
:
374 req
->resp
.tmf
.response
= VIRTIO_SCSI_S_FUNCTION_REJECTED
;
381 req
->resp
.tmf
.response
= VIRTIO_SCSI_S_INCORRECT_LUN
;
385 req
->resp
.tmf
.response
= VIRTIO_SCSI_S_BAD_TARGET
;
389 void virtio_scsi_handle_ctrl_req(VirtIOSCSI
*s
, VirtIOSCSIReq
*req
)
391 VirtIODevice
*vdev
= (VirtIODevice
*)s
;
395 if (iov_to_buf(req
->elem
.out_sg
, req
->elem
.out_num
, 0,
396 &type
, sizeof(type
)) < sizeof(type
)) {
397 virtio_scsi_bad_req();
401 virtio_tswap32s(vdev
, &type
);
402 if (type
== VIRTIO_SCSI_T_TMF
) {
403 if (virtio_scsi_parse_req(req
, sizeof(VirtIOSCSICtrlTMFReq
),
404 sizeof(VirtIOSCSICtrlTMFResp
)) < 0) {
405 virtio_scsi_bad_req();
407 r
= virtio_scsi_do_tmf(s
, req
);
410 } else if (type
== VIRTIO_SCSI_T_AN_QUERY
||
411 type
== VIRTIO_SCSI_T_AN_SUBSCRIBE
) {
412 if (virtio_scsi_parse_req(req
, sizeof(VirtIOSCSICtrlANReq
),
413 sizeof(VirtIOSCSICtrlANResp
)) < 0) {
414 virtio_scsi_bad_req();
416 req
->resp
.an
.event_actual
= 0;
417 req
->resp
.an
.response
= VIRTIO_SCSI_S_OK
;
421 virtio_scsi_complete_req(req
);
423 assert(r
== -EINPROGRESS
);
427 static void virtio_scsi_handle_ctrl(VirtIODevice
*vdev
, VirtQueue
*vq
)
429 VirtIOSCSI
*s
= (VirtIOSCSI
*)vdev
;
432 if (s
->ctx
&& !s
->dataplane_disabled
) {
433 virtio_scsi_dataplane_start(s
);
436 while ((req
= virtio_scsi_pop_req(s
, vq
))) {
437 virtio_scsi_handle_ctrl_req(s
, req
);
441 static void virtio_scsi_complete_cmd_req(VirtIOSCSIReq
*req
)
443 /* Sense data is not in req->resp and is copied separately
444 * in virtio_scsi_command_complete.
446 req
->resp_size
= sizeof(VirtIOSCSICmdResp
);
447 virtio_scsi_complete_req(req
);
450 static void virtio_scsi_command_complete(SCSIRequest
*r
, uint32_t status
,
453 VirtIOSCSIReq
*req
= r
->hba_private
;
454 uint8_t sense
[SCSI_SENSE_BUF_SIZE
];
456 VirtIODevice
*vdev
= VIRTIO_DEVICE(req
->dev
);
458 if (r
->io_canceled
) {
462 req
->resp
.cmd
.response
= VIRTIO_SCSI_S_OK
;
463 req
->resp
.cmd
.status
= status
;
464 if (req
->resp
.cmd
.status
== GOOD
) {
465 req
->resp
.cmd
.resid
= virtio_tswap32(vdev
, resid
);
467 req
->resp
.cmd
.resid
= 0;
468 sense_len
= scsi_req_get_sense(r
, sense
, sizeof(sense
));
469 sense_len
= MIN(sense_len
, req
->resp_iov
.size
- sizeof(req
->resp
.cmd
));
470 qemu_iovec_from_buf(&req
->resp_iov
, sizeof(req
->resp
.cmd
),
472 req
->resp
.cmd
.sense_len
= virtio_tswap32(vdev
, sense_len
);
474 virtio_scsi_complete_cmd_req(req
);
477 static int virtio_scsi_parse_cdb(SCSIDevice
*dev
, SCSICommand
*cmd
,
478 uint8_t *buf
, void *hba_private
)
480 VirtIOSCSIReq
*req
= hba_private
;
483 cmd
->len
= MIN(VIRTIO_SCSI_CDB_DEFAULT_SIZE
, SCSI_CMD_BUF_SIZE
);
484 memcpy(cmd
->buf
, buf
, cmd
->len
);
487 /* Extract the direction and mode directly from the request, for
488 * host device passthrough.
490 cmd
->xfer
= req
->qsgl
.size
;
491 cmd
->mode
= req
->mode
;
495 static QEMUSGList
*virtio_scsi_get_sg_list(SCSIRequest
*r
)
497 VirtIOSCSIReq
*req
= r
->hba_private
;
502 static void virtio_scsi_request_cancelled(SCSIRequest
*r
)
504 VirtIOSCSIReq
*req
= r
->hba_private
;
509 if (req
->dev
->resetting
) {
510 req
->resp
.cmd
.response
= VIRTIO_SCSI_S_RESET
;
512 req
->resp
.cmd
.response
= VIRTIO_SCSI_S_ABORTED
;
514 virtio_scsi_complete_cmd_req(req
);
517 static void virtio_scsi_fail_cmd_req(VirtIOSCSIReq
*req
)
519 req
->resp
.cmd
.response
= VIRTIO_SCSI_S_FAILURE
;
520 virtio_scsi_complete_cmd_req(req
);
523 bool virtio_scsi_handle_cmd_req_prepare(VirtIOSCSI
*s
, VirtIOSCSIReq
*req
)
525 VirtIOSCSICommon
*vs
= &s
->parent_obj
;
529 rc
= virtio_scsi_parse_req(req
, sizeof(VirtIOSCSICmdReq
) + vs
->cdb_size
,
530 sizeof(VirtIOSCSICmdResp
) + vs
->sense_size
);
532 if (rc
== -ENOTSUP
) {
533 virtio_scsi_fail_cmd_req(req
);
535 virtio_scsi_bad_req();
540 d
= virtio_scsi_device_find(s
, req
->req
.cmd
.lun
);
542 req
->resp
.cmd
.response
= VIRTIO_SCSI_S_BAD_TARGET
;
543 virtio_scsi_complete_cmd_req(req
);
546 if (s
->dataplane_started
) {
547 assert(blk_get_aio_context(d
->conf
.blk
) == s
->ctx
);
549 req
->sreq
= scsi_req_new(d
, req
->req
.cmd
.tag
,
550 virtio_scsi_get_lun(req
->req
.cmd
.lun
),
551 req
->req
.cmd
.cdb
, req
);
553 if (req
->sreq
->cmd
.mode
!= SCSI_XFER_NONE
554 && (req
->sreq
->cmd
.mode
!= req
->mode
||
555 req
->sreq
->cmd
.xfer
> req
->qsgl
.size
)) {
556 req
->resp
.cmd
.response
= VIRTIO_SCSI_S_OVERRUN
;
557 virtio_scsi_complete_cmd_req(req
);
560 scsi_req_ref(req
->sreq
);
561 blk_io_plug(d
->conf
.blk
);
565 void virtio_scsi_handle_cmd_req_submit(VirtIOSCSI
*s
, VirtIOSCSIReq
*req
)
567 SCSIRequest
*sreq
= req
->sreq
;
568 if (scsi_req_enqueue(sreq
)) {
569 scsi_req_continue(sreq
);
571 blk_io_unplug(sreq
->dev
->conf
.blk
);
572 scsi_req_unref(sreq
);
575 static void virtio_scsi_handle_cmd(VirtIODevice
*vdev
, VirtQueue
*vq
)
577 /* use non-QOM casts in the data path */
578 VirtIOSCSI
*s
= (VirtIOSCSI
*)vdev
;
579 VirtIOSCSIReq
*req
, *next
;
580 QTAILQ_HEAD(, VirtIOSCSIReq
) reqs
= QTAILQ_HEAD_INITIALIZER(reqs
);
582 if (s
->ctx
&& !s
->dataplane_disabled
) {
583 virtio_scsi_dataplane_start(s
);
586 while ((req
= virtio_scsi_pop_req(s
, vq
))) {
587 if (virtio_scsi_handle_cmd_req_prepare(s
, req
)) {
588 QTAILQ_INSERT_TAIL(&reqs
, req
, next
);
592 QTAILQ_FOREACH_SAFE(req
, &reqs
, next
, next
) {
593 virtio_scsi_handle_cmd_req_submit(s
, req
);
597 static void virtio_scsi_get_config(VirtIODevice
*vdev
,
600 VirtIOSCSIConfig
*scsiconf
= (VirtIOSCSIConfig
*)config
;
601 VirtIOSCSICommon
*s
= VIRTIO_SCSI_COMMON(vdev
);
603 virtio_stl_p(vdev
, &scsiconf
->num_queues
, s
->conf
.num_queues
);
604 virtio_stl_p(vdev
, &scsiconf
->seg_max
, 128 - 2);
605 virtio_stl_p(vdev
, &scsiconf
->max_sectors
, s
->conf
.max_sectors
);
606 virtio_stl_p(vdev
, &scsiconf
->cmd_per_lun
, s
->conf
.cmd_per_lun
);
607 virtio_stl_p(vdev
, &scsiconf
->event_info_size
, sizeof(VirtIOSCSIEvent
));
608 virtio_stl_p(vdev
, &scsiconf
->sense_size
, s
->sense_size
);
609 virtio_stl_p(vdev
, &scsiconf
->cdb_size
, s
->cdb_size
);
610 virtio_stw_p(vdev
, &scsiconf
->max_channel
, VIRTIO_SCSI_MAX_CHANNEL
);
611 virtio_stw_p(vdev
, &scsiconf
->max_target
, VIRTIO_SCSI_MAX_TARGET
);
612 virtio_stl_p(vdev
, &scsiconf
->max_lun
, VIRTIO_SCSI_MAX_LUN
);
615 static void virtio_scsi_set_config(VirtIODevice
*vdev
,
616 const uint8_t *config
)
618 VirtIOSCSIConfig
*scsiconf
= (VirtIOSCSIConfig
*)config
;
619 VirtIOSCSICommon
*vs
= VIRTIO_SCSI_COMMON(vdev
);
621 if ((uint32_t) virtio_ldl_p(vdev
, &scsiconf
->sense_size
) >= 65536 ||
622 (uint32_t) virtio_ldl_p(vdev
, &scsiconf
->cdb_size
) >= 256) {
623 error_report("bad data written to virtio-scsi configuration space");
627 vs
->sense_size
= virtio_ldl_p(vdev
, &scsiconf
->sense_size
);
628 vs
->cdb_size
= virtio_ldl_p(vdev
, &scsiconf
->cdb_size
);
631 static uint32_t virtio_scsi_get_features(VirtIODevice
*vdev
,
632 uint32_t requested_features
)
634 return requested_features
;
637 static void virtio_scsi_reset(VirtIODevice
*vdev
)
639 VirtIOSCSI
*s
= VIRTIO_SCSI(vdev
);
640 VirtIOSCSICommon
*vs
= VIRTIO_SCSI_COMMON(vdev
);
643 virtio_scsi_dataplane_stop(s
);
646 qbus_reset_all(&s
->bus
.qbus
);
649 vs
->sense_size
= VIRTIO_SCSI_SENSE_DEFAULT_SIZE
;
650 vs
->cdb_size
= VIRTIO_SCSI_CDB_DEFAULT_SIZE
;
651 s
->events_dropped
= false;
654 /* The device does not have anything to save beyond the virtio data.
655 * Request data is saved with callbacks from SCSI devices.
657 static void virtio_scsi_save(QEMUFile
*f
, void *opaque
)
659 VirtIODevice
*vdev
= VIRTIO_DEVICE(opaque
);
660 virtio_save(vdev
, f
);
663 static int virtio_scsi_load(QEMUFile
*f
, void *opaque
, int version_id
)
665 VirtIODevice
*vdev
= VIRTIO_DEVICE(opaque
);
668 ret
= virtio_load(vdev
, f
, version_id
);
675 void virtio_scsi_push_event(VirtIOSCSI
*s
, SCSIDevice
*dev
,
676 uint32_t event
, uint32_t reason
)
678 VirtIOSCSICommon
*vs
= VIRTIO_SCSI_COMMON(s
);
680 VirtIOSCSIEvent
*evt
;
681 VirtIODevice
*vdev
= VIRTIO_DEVICE(s
);
683 if (!(vdev
->status
& VIRTIO_CONFIG_S_DRIVER_OK
)) {
687 if (s
->dataplane_started
) {
689 aio_context_acquire(s
->ctx
);
692 if (s
->dataplane_started
) {
693 req
= virtio_scsi_pop_req_vring(s
, s
->event_vring
);
695 req
= virtio_scsi_pop_req(s
, vs
->event_vq
);
698 s
->events_dropped
= true;
702 if (s
->events_dropped
) {
703 event
|= VIRTIO_SCSI_T_EVENTS_MISSED
;
704 s
->events_dropped
= false;
707 if (virtio_scsi_parse_req(req
, 0, sizeof(VirtIOSCSIEvent
))) {
708 virtio_scsi_bad_req();
711 evt
= &req
->resp
.event
;
712 memset(evt
, 0, sizeof(VirtIOSCSIEvent
));
713 evt
->event
= virtio_tswap32(vdev
, event
);
714 evt
->reason
= virtio_tswap32(vdev
, reason
);
716 assert(event
== VIRTIO_SCSI_T_EVENTS_MISSED
);
719 evt
->lun
[1] = dev
->id
;
721 /* Linux wants us to keep the same encoding we use for REPORT LUNS. */
722 if (dev
->lun
>= 256) {
723 evt
->lun
[2] = (dev
->lun
>> 8) | 0x40;
725 evt
->lun
[3] = dev
->lun
& 0xFF;
727 virtio_scsi_complete_req(req
);
729 if (s
->dataplane_started
) {
730 aio_context_release(s
->ctx
);
734 static void virtio_scsi_handle_event(VirtIODevice
*vdev
, VirtQueue
*vq
)
736 VirtIOSCSI
*s
= VIRTIO_SCSI(vdev
);
738 if (s
->ctx
&& !s
->dataplane_disabled
) {
739 virtio_scsi_dataplane_start(s
);
742 if (s
->events_dropped
) {
743 virtio_scsi_push_event(s
, NULL
, VIRTIO_SCSI_T_NO_EVENT
, 0);
747 static void virtio_scsi_change(SCSIBus
*bus
, SCSIDevice
*dev
, SCSISense sense
)
749 VirtIOSCSI
*s
= container_of(bus
, VirtIOSCSI
, bus
);
750 VirtIODevice
*vdev
= VIRTIO_DEVICE(s
);
752 if (virtio_has_feature(vdev
, VIRTIO_SCSI_F_CHANGE
) &&
753 dev
->type
!= TYPE_ROM
) {
754 virtio_scsi_push_event(s
, dev
, VIRTIO_SCSI_T_PARAM_CHANGE
,
755 sense
.asc
| (sense
.ascq
<< 8));
759 static void virtio_scsi_hotplug(HotplugHandler
*hotplug_dev
, DeviceState
*dev
,
762 VirtIODevice
*vdev
= VIRTIO_DEVICE(hotplug_dev
);
763 VirtIOSCSI
*s
= VIRTIO_SCSI(vdev
);
764 SCSIDevice
*sd
= SCSI_DEVICE(dev
);
766 if (s
->ctx
&& !s
->dataplane_disabled
) {
767 if (blk_op_is_blocked(sd
->conf
.blk
, BLOCK_OP_TYPE_DATAPLANE
, errp
)) {
770 blk_op_block_all(sd
->conf
.blk
, s
->blocker
);
771 aio_context_acquire(s
->ctx
);
772 blk_set_aio_context(sd
->conf
.blk
, s
->ctx
);
773 aio_context_release(s
->ctx
);
776 if (virtio_has_feature(vdev
, VIRTIO_SCSI_F_HOTPLUG
)) {
777 virtio_scsi_push_event(s
, sd
,
778 VIRTIO_SCSI_T_TRANSPORT_RESET
,
779 VIRTIO_SCSI_EVT_RESET_RESCAN
);
783 static void virtio_scsi_hotunplug(HotplugHandler
*hotplug_dev
, DeviceState
*dev
,
786 VirtIODevice
*vdev
= VIRTIO_DEVICE(hotplug_dev
);
787 VirtIOSCSI
*s
= VIRTIO_SCSI(vdev
);
788 SCSIDevice
*sd
= SCSI_DEVICE(dev
);
790 if (virtio_has_feature(vdev
, VIRTIO_SCSI_F_HOTPLUG
)) {
791 virtio_scsi_push_event(s
, sd
,
792 VIRTIO_SCSI_T_TRANSPORT_RESET
,
793 VIRTIO_SCSI_EVT_RESET_REMOVED
);
797 blk_op_unblock_all(sd
->conf
.blk
, s
->blocker
);
799 qdev_simple_device_unplug_cb(hotplug_dev
, dev
, errp
);
802 static struct SCSIBusInfo virtio_scsi_scsi_info
= {
804 .max_channel
= VIRTIO_SCSI_MAX_CHANNEL
,
805 .max_target
= VIRTIO_SCSI_MAX_TARGET
,
806 .max_lun
= VIRTIO_SCSI_MAX_LUN
,
808 .complete
= virtio_scsi_command_complete
,
809 .cancel
= virtio_scsi_request_cancelled
,
810 .change
= virtio_scsi_change
,
811 .parse_cdb
= virtio_scsi_parse_cdb
,
812 .get_sg_list
= virtio_scsi_get_sg_list
,
813 .save_request
= virtio_scsi_save_request
,
814 .load_request
= virtio_scsi_load_request
,
817 void virtio_scsi_common_realize(DeviceState
*dev
, Error
**errp
,
818 HandleOutput ctrl
, HandleOutput evt
,
821 VirtIODevice
*vdev
= VIRTIO_DEVICE(dev
);
822 VirtIOSCSICommon
*s
= VIRTIO_SCSI_COMMON(dev
);
825 virtio_init(vdev
, "virtio-scsi", VIRTIO_ID_SCSI
,
826 sizeof(VirtIOSCSIConfig
));
828 if (s
->conf
.num_queues
== 0 ||
829 s
->conf
.num_queues
> VIRTIO_PCI_QUEUE_MAX
- 2) {
830 error_setg(errp
, "Invalid number of queues (= %" PRIu32
"), "
831 "must be a positive integer less than %d.",
832 s
->conf
.num_queues
, VIRTIO_PCI_QUEUE_MAX
- 2);
833 virtio_cleanup(vdev
);
836 s
->cmd_vqs
= g_new0(VirtQueue
*, s
->conf
.num_queues
);
837 s
->sense_size
= VIRTIO_SCSI_SENSE_DEFAULT_SIZE
;
838 s
->cdb_size
= VIRTIO_SCSI_CDB_DEFAULT_SIZE
;
840 s
->ctrl_vq
= virtio_add_queue(vdev
, VIRTIO_SCSI_VQ_SIZE
,
842 s
->event_vq
= virtio_add_queue(vdev
, VIRTIO_SCSI_VQ_SIZE
,
844 for (i
= 0; i
< s
->conf
.num_queues
; i
++) {
845 s
->cmd_vqs
[i
] = virtio_add_queue(vdev
, VIRTIO_SCSI_VQ_SIZE
,
849 if (s
->conf
.iothread
) {
850 virtio_scsi_set_iothread(VIRTIO_SCSI(s
), s
->conf
.iothread
);
854 /* Disable dataplane thread during live migration since it does not
855 * update the dirty memory bitmap yet.
857 static void virtio_scsi_migration_state_changed(Notifier
*notifier
, void *data
)
859 VirtIOSCSI
*s
= container_of(notifier
, VirtIOSCSI
,
860 migration_state_notifier
);
861 MigrationState
*mig
= data
;
863 if (migration_in_setup(mig
)) {
864 if (!s
->dataplane_started
) {
867 virtio_scsi_dataplane_stop(s
);
868 s
->dataplane_disabled
= true;
869 } else if (migration_has_finished(mig
) ||
870 migration_has_failed(mig
)) {
871 if (s
->dataplane_started
) {
874 blk_drain_all(); /* complete in-flight non-dataplane requests */
875 s
->dataplane_disabled
= false;
879 static void virtio_scsi_device_realize(DeviceState
*dev
, Error
**errp
)
881 VirtIODevice
*vdev
= VIRTIO_DEVICE(dev
);
882 VirtIOSCSI
*s
= VIRTIO_SCSI(dev
);
883 static int virtio_scsi_id
;
886 virtio_scsi_common_realize(dev
, &err
, virtio_scsi_handle_ctrl
,
887 virtio_scsi_handle_event
,
888 virtio_scsi_handle_cmd
);
890 error_propagate(errp
, err
);
894 scsi_bus_new(&s
->bus
, sizeof(s
->bus
), dev
,
895 &virtio_scsi_scsi_info
, vdev
->bus_name
);
896 /* override default SCSI bus hotplug-handler, with virtio-scsi's one */
897 qbus_set_hotplug_handler(BUS(&s
->bus
), dev
, &error_abort
);
899 if (!dev
->hotplugged
) {
900 scsi_bus_legacy_handle_cmdline(&s
->bus
, &err
);
902 error_propagate(errp
, err
);
907 register_savevm(dev
, "virtio-scsi", virtio_scsi_id
++, 1,
908 virtio_scsi_save
, virtio_scsi_load
, s
);
909 s
->migration_state_notifier
.notify
= virtio_scsi_migration_state_changed
;
910 add_migration_state_change_notifier(&s
->migration_state_notifier
);
912 error_setg(&s
->blocker
, "block device is in use by data plane");
915 static void virtio_scsi_instance_init(Object
*obj
)
917 VirtIOSCSICommon
*vs
= VIRTIO_SCSI_COMMON(obj
);
919 object_property_add_link(obj
, "iothread", TYPE_IOTHREAD
,
920 (Object
**)&vs
->conf
.iothread
,
921 qdev_prop_allow_set_link_before_realize
,
922 OBJ_PROP_LINK_UNREF_ON_RELEASE
, &error_abort
);
925 void virtio_scsi_common_unrealize(DeviceState
*dev
, Error
**errp
)
927 VirtIODevice
*vdev
= VIRTIO_DEVICE(dev
);
928 VirtIOSCSICommon
*vs
= VIRTIO_SCSI_COMMON(dev
);
931 virtio_cleanup(vdev
);
934 static void virtio_scsi_device_unrealize(DeviceState
*dev
, Error
**errp
)
936 VirtIOSCSI
*s
= VIRTIO_SCSI(dev
);
938 error_free(s
->blocker
);
940 unregister_savevm(dev
, "virtio-scsi", s
);
941 remove_migration_state_change_notifier(&s
->migration_state_notifier
);
943 virtio_scsi_common_unrealize(dev
, errp
);
946 static Property virtio_scsi_properties
[] = {
947 DEFINE_VIRTIO_SCSI_PROPERTIES(VirtIOSCSI
, parent_obj
.conf
),
948 DEFINE_PROP_END_OF_LIST(),
951 static void virtio_scsi_common_class_init(ObjectClass
*klass
, void *data
)
953 VirtioDeviceClass
*vdc
= VIRTIO_DEVICE_CLASS(klass
);
954 DeviceClass
*dc
= DEVICE_CLASS(klass
);
956 vdc
->get_config
= virtio_scsi_get_config
;
957 set_bit(DEVICE_CATEGORY_STORAGE
, dc
->categories
);
960 static void virtio_scsi_class_init(ObjectClass
*klass
, void *data
)
962 DeviceClass
*dc
= DEVICE_CLASS(klass
);
963 VirtioDeviceClass
*vdc
= VIRTIO_DEVICE_CLASS(klass
);
964 HotplugHandlerClass
*hc
= HOTPLUG_HANDLER_CLASS(klass
);
966 dc
->props
= virtio_scsi_properties
;
967 set_bit(DEVICE_CATEGORY_STORAGE
, dc
->categories
);
968 vdc
->realize
= virtio_scsi_device_realize
;
969 vdc
->unrealize
= virtio_scsi_device_unrealize
;
970 vdc
->set_config
= virtio_scsi_set_config
;
971 vdc
->get_features
= virtio_scsi_get_features
;
972 vdc
->reset
= virtio_scsi_reset
;
973 hc
->plug
= virtio_scsi_hotplug
;
974 hc
->unplug
= virtio_scsi_hotunplug
;
977 static const TypeInfo virtio_scsi_common_info
= {
978 .name
= TYPE_VIRTIO_SCSI_COMMON
,
979 .parent
= TYPE_VIRTIO_DEVICE
,
980 .instance_size
= sizeof(VirtIOSCSICommon
),
982 .class_init
= virtio_scsi_common_class_init
,
985 static const TypeInfo virtio_scsi_info
= {
986 .name
= TYPE_VIRTIO_SCSI
,
987 .parent
= TYPE_VIRTIO_SCSI_COMMON
,
988 .instance_size
= sizeof(VirtIOSCSI
),
989 .instance_init
= virtio_scsi_instance_init
,
990 .class_init
= virtio_scsi_class_init
,
991 .interfaces
= (InterfaceInfo
[]) {
992 { TYPE_HOTPLUG_HANDLER
},
997 static void virtio_register_types(void)
999 type_register_static(&virtio_scsi_common_info
);
1000 type_register_static(&virtio_scsi_info
);
1003 type_init(virtio_register_types
)