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 "qemu/osdep.h"
17 #include "qapi/error.h"
18 #include "standard-headers/linux/virtio_ids.h"
19 #include "hw/virtio/virtio-scsi.h"
20 #include "migration/qemu-file-types.h"
21 #include "qemu/error-report.h"
23 #include "qemu/module.h"
24 #include "sysemu/block-backend.h"
25 #include "hw/qdev-properties.h"
26 #include "hw/scsi/scsi.h"
27 #include "scsi/constants.h"
28 #include "hw/virtio/virtio-bus.h"
29 #include "hw/virtio/virtio-access.h"
31 static inline int virtio_scsi_get_lun(uint8_t *lun
)
33 return ((lun
[2] << 8) | lun
[3]) & 0x3FFF;
36 static inline SCSIDevice
*virtio_scsi_device_find(VirtIOSCSI
*s
, uint8_t *lun
)
41 if (lun
[2] != 0 && !(lun
[2] >= 0x40 && lun
[2] < 0x80)) {
44 return scsi_device_find(&s
->bus
, 0, lun
[1], virtio_scsi_get_lun(lun
));
47 void virtio_scsi_init_req(VirtIOSCSI
*s
, VirtQueue
*vq
, VirtIOSCSIReq
*req
)
49 VirtIODevice
*vdev
= VIRTIO_DEVICE(s
);
50 const size_t zero_skip
=
51 offsetof(VirtIOSCSIReq
, resp_iov
) + sizeof(req
->resp_iov
);
55 qemu_sglist_init(&req
->qsgl
, DEVICE(s
), 8, vdev
->dma_as
);
56 qemu_iovec_init(&req
->resp_iov
, 1);
57 memset((uint8_t *)req
+ zero_skip
, 0, sizeof(*req
) - zero_skip
);
60 void virtio_scsi_free_req(VirtIOSCSIReq
*req
)
62 qemu_iovec_destroy(&req
->resp_iov
);
63 qemu_sglist_destroy(&req
->qsgl
);
67 static void virtio_scsi_complete_req(VirtIOSCSIReq
*req
)
69 VirtIOSCSI
*s
= req
->dev
;
70 VirtQueue
*vq
= req
->vq
;
71 VirtIODevice
*vdev
= VIRTIO_DEVICE(s
);
73 qemu_iovec_from_buf(&req
->resp_iov
, 0, &req
->resp
, req
->resp_size
);
74 virtqueue_push(vq
, &req
->elem
, req
->qsgl
.size
+ req
->resp_iov
.size
);
75 if (s
->dataplane_started
&& !s
->dataplane_fenced
) {
76 virtio_notify_irqfd(vdev
, vq
);
78 virtio_notify(vdev
, vq
);
82 req
->sreq
->hba_private
= NULL
;
83 scsi_req_unref(req
->sreq
);
85 virtio_scsi_free_req(req
);
88 static void virtio_scsi_bad_req(VirtIOSCSIReq
*req
)
90 virtio_error(VIRTIO_DEVICE(req
->dev
), "wrong size for virtio-scsi headers");
91 virtqueue_detach_element(req
->vq
, &req
->elem
, 0);
92 virtio_scsi_free_req(req
);
95 static size_t qemu_sgl_concat(VirtIOSCSIReq
*req
, struct iovec
*iov
,
96 hwaddr
*addr
, int num
, size_t skip
)
98 QEMUSGList
*qsgl
= &req
->qsgl
;
102 if (skip
>= iov
->iov_len
) {
103 skip
-= iov
->iov_len
;
105 qemu_sglist_add(qsgl
, *addr
+ skip
, iov
->iov_len
- skip
);
106 copied
+= iov
->iov_len
- skip
;
118 static int virtio_scsi_parse_req(VirtIOSCSIReq
*req
,
119 unsigned req_size
, unsigned resp_size
)
121 VirtIODevice
*vdev
= (VirtIODevice
*) req
->dev
;
122 size_t in_size
, out_size
;
124 if (iov_to_buf(req
->elem
.out_sg
, req
->elem
.out_num
, 0,
125 &req
->req
, req_size
) < req_size
) {
129 if (qemu_iovec_concat_iov(&req
->resp_iov
,
130 req
->elem
.in_sg
, req
->elem
.in_num
, 0,
131 resp_size
) < resp_size
) {
135 req
->resp_size
= resp_size
;
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
142 * The actual length of the response header, stored in req->resp_size,
145 * TODO: always disable this workaround for virtio 1.0 devices.
147 if (!virtio_vdev_has_feature(vdev
, VIRTIO_F_ANY_LAYOUT
)) {
148 if (req
->elem
.out_num
) {
149 req_size
= req
->elem
.out_sg
[0].iov_len
;
151 if (req
->elem
.in_num
) {
152 resp_size
= req
->elem
.in_sg
[0].iov_len
;
156 out_size
= qemu_sgl_concat(req
, req
->elem
.out_sg
,
157 &req
->elem
.out_addr
[0], req
->elem
.out_num
,
159 in_size
= qemu_sgl_concat(req
, req
->elem
.in_sg
,
160 &req
->elem
.in_addr
[0], req
->elem
.in_num
,
163 if (out_size
&& in_size
) {
168 req
->mode
= SCSI_XFER_TO_DEV
;
169 } else if (in_size
) {
170 req
->mode
= SCSI_XFER_FROM_DEV
;
176 static VirtIOSCSIReq
*virtio_scsi_pop_req(VirtIOSCSI
*s
, VirtQueue
*vq
)
178 VirtIOSCSICommon
*vs
= (VirtIOSCSICommon
*)s
;
181 req
= virtqueue_pop(vq
, sizeof(VirtIOSCSIReq
) + vs
->cdb_size
);
185 virtio_scsi_init_req(s
, vq
, req
);
189 static void virtio_scsi_save_request(QEMUFile
*f
, SCSIRequest
*sreq
)
191 VirtIOSCSIReq
*req
= sreq
->hba_private
;
192 VirtIOSCSICommon
*vs
= VIRTIO_SCSI_COMMON(req
->dev
);
193 VirtIODevice
*vdev
= VIRTIO_DEVICE(req
->dev
);
194 uint32_t n
= virtio_get_queue_index(req
->vq
) - 2;
196 assert(n
< vs
->conf
.num_queues
);
197 qemu_put_be32s(f
, &n
);
198 qemu_put_virtqueue_element(vdev
, f
, &req
->elem
);
201 static void *virtio_scsi_load_request(QEMUFile
*f
, SCSIRequest
*sreq
)
203 SCSIBus
*bus
= sreq
->bus
;
204 VirtIOSCSI
*s
= container_of(bus
, VirtIOSCSI
, bus
);
205 VirtIOSCSICommon
*vs
= VIRTIO_SCSI_COMMON(s
);
206 VirtIODevice
*vdev
= VIRTIO_DEVICE(s
);
210 qemu_get_be32s(f
, &n
);
211 assert(n
< vs
->conf
.num_queues
);
212 req
= qemu_get_virtqueue_element(vdev
, f
,
213 sizeof(VirtIOSCSIReq
) + vs
->cdb_size
);
214 virtio_scsi_init_req(s
, vs
->cmd_vqs
[n
], req
);
216 if (virtio_scsi_parse_req(req
, sizeof(VirtIOSCSICmdReq
) + vs
->cdb_size
,
217 sizeof(VirtIOSCSICmdResp
) + vs
->sense_size
) < 0) {
218 error_report("invalid SCSI request migration data");
224 if (req
->sreq
->cmd
.mode
!= SCSI_XFER_NONE
) {
225 assert(req
->sreq
->cmd
.mode
== req
->mode
);
232 VirtIOSCSIReq
*tmf_req
;
233 } VirtIOSCSICancelNotifier
;
235 static void virtio_scsi_cancel_notify(Notifier
*notifier
, void *data
)
237 VirtIOSCSICancelNotifier
*n
= container_of(notifier
,
238 VirtIOSCSICancelNotifier
,
241 if (--n
->tmf_req
->remaining
== 0) {
242 virtio_scsi_complete_req(n
->tmf_req
);
247 static inline void virtio_scsi_ctx_check(VirtIOSCSI
*s
, SCSIDevice
*d
)
249 if (s
->dataplane_started
&& d
&& blk_is_available(d
->conf
.blk
)) {
250 assert(blk_get_aio_context(d
->conf
.blk
) == s
->ctx
);
254 /* Return 0 if the request is ready to be completed and return to guest;
255 * -EINPROGRESS if the request is submitted and will be completed later, in the
256 * case of async cancellation. */
257 static int virtio_scsi_do_tmf(VirtIOSCSI
*s
, VirtIOSCSIReq
*req
)
259 SCSIDevice
*d
= virtio_scsi_device_find(s
, req
->req
.tmf
.lun
);
260 SCSIRequest
*r
, *next
;
265 virtio_scsi_ctx_check(s
, d
);
266 /* Here VIRTIO_SCSI_S_OK means "FUNCTION COMPLETE". */
267 req
->resp
.tmf
.response
= VIRTIO_SCSI_S_OK
;
270 * req->req.tmf has the QEMU_PACKED attribute. Don't use virtio_tswap32s()
271 * to avoid compiler errors.
273 req
->req
.tmf
.subtype
=
274 virtio_tswap32(VIRTIO_DEVICE(s
), req
->req
.tmf
.subtype
);
276 switch (req
->req
.tmf
.subtype
) {
277 case VIRTIO_SCSI_T_TMF_ABORT_TASK
:
278 case VIRTIO_SCSI_T_TMF_QUERY_TASK
:
282 if (d
->lun
!= virtio_scsi_get_lun(req
->req
.tmf
.lun
)) {
285 QTAILQ_FOREACH_SAFE(r
, &d
->requests
, next
, next
) {
286 VirtIOSCSIReq
*cmd_req
= r
->hba_private
;
287 if (cmd_req
&& cmd_req
->req
.cmd
.tag
== req
->req
.tmf
.tag
) {
293 * Assert that the request has not been completed yet, we
294 * check for it in the loop above.
296 assert(r
->hba_private
);
297 if (req
->req
.tmf
.subtype
== VIRTIO_SCSI_T_TMF_QUERY_TASK
) {
298 /* "If the specified command is present in the task set, then
299 * return a service response set to FUNCTION SUCCEEDED".
301 req
->resp
.tmf
.response
= VIRTIO_SCSI_S_FUNCTION_SUCCEEDED
;
303 VirtIOSCSICancelNotifier
*notifier
;
306 notifier
= g_new(VirtIOSCSICancelNotifier
, 1);
307 notifier
->tmf_req
= req
;
308 notifier
->notifier
.notify
= virtio_scsi_cancel_notify
;
309 scsi_req_cancel_async(r
, ¬ifier
->notifier
);
315 case VIRTIO_SCSI_T_TMF_LOGICAL_UNIT_RESET
:
319 if (d
->lun
!= virtio_scsi_get_lun(req
->req
.tmf
.lun
)) {
323 qdev_reset_all(&d
->qdev
);
327 case VIRTIO_SCSI_T_TMF_ABORT_TASK_SET
:
328 case VIRTIO_SCSI_T_TMF_CLEAR_TASK_SET
:
329 case VIRTIO_SCSI_T_TMF_QUERY_TASK_SET
:
333 if (d
->lun
!= virtio_scsi_get_lun(req
->req
.tmf
.lun
)) {
337 /* Add 1 to "remaining" until virtio_scsi_do_tmf returns.
338 * This way, if the bus starts calling back to the notifiers
339 * even before we finish the loop, virtio_scsi_cancel_notify
340 * will not complete the TMF too early.
343 QTAILQ_FOREACH_SAFE(r
, &d
->requests
, next
, next
) {
344 if (r
->hba_private
) {
345 if (req
->req
.tmf
.subtype
== VIRTIO_SCSI_T_TMF_QUERY_TASK_SET
) {
346 /* "If there is any command present in the task set, then
347 * return a service response set to FUNCTION SUCCEEDED".
349 req
->resp
.tmf
.response
= VIRTIO_SCSI_S_FUNCTION_SUCCEEDED
;
352 VirtIOSCSICancelNotifier
*notifier
;
355 notifier
= g_new(VirtIOSCSICancelNotifier
, 1);
356 notifier
->notifier
.notify
= virtio_scsi_cancel_notify
;
357 notifier
->tmf_req
= req
;
358 scsi_req_cancel_async(r
, ¬ifier
->notifier
);
362 if (--req
->remaining
> 0) {
367 case VIRTIO_SCSI_T_TMF_I_T_NEXUS_RESET
:
368 target
= req
->req
.tmf
.lun
[1];
370 QTAILQ_FOREACH(kid
, &s
->bus
.qbus
.children
, sibling
) {
371 d
= SCSI_DEVICE(kid
->child
);
372 if (d
->channel
== 0 && d
->id
== target
) {
373 qdev_reset_all(&d
->qdev
);
379 case VIRTIO_SCSI_T_TMF_CLEAR_ACA
:
381 req
->resp
.tmf
.response
= VIRTIO_SCSI_S_FUNCTION_REJECTED
;
388 req
->resp
.tmf
.response
= VIRTIO_SCSI_S_INCORRECT_LUN
;
392 req
->resp
.tmf
.response
= VIRTIO_SCSI_S_BAD_TARGET
;
396 static void virtio_scsi_handle_ctrl_req(VirtIOSCSI
*s
, VirtIOSCSIReq
*req
)
398 VirtIODevice
*vdev
= (VirtIODevice
*)s
;
402 if (iov_to_buf(req
->elem
.out_sg
, req
->elem
.out_num
, 0,
403 &type
, sizeof(type
)) < sizeof(type
)) {
404 virtio_scsi_bad_req(req
);
408 virtio_tswap32s(vdev
, &type
);
409 if (type
== VIRTIO_SCSI_T_TMF
) {
410 if (virtio_scsi_parse_req(req
, sizeof(VirtIOSCSICtrlTMFReq
),
411 sizeof(VirtIOSCSICtrlTMFResp
)) < 0) {
412 virtio_scsi_bad_req(req
);
415 r
= virtio_scsi_do_tmf(s
, req
);
418 } else if (type
== VIRTIO_SCSI_T_AN_QUERY
||
419 type
== VIRTIO_SCSI_T_AN_SUBSCRIBE
) {
420 if (virtio_scsi_parse_req(req
, sizeof(VirtIOSCSICtrlANReq
),
421 sizeof(VirtIOSCSICtrlANResp
)) < 0) {
422 virtio_scsi_bad_req(req
);
425 req
->resp
.an
.event_actual
= 0;
426 req
->resp
.an
.response
= VIRTIO_SCSI_S_OK
;
430 virtio_scsi_complete_req(req
);
432 assert(r
== -EINPROGRESS
);
436 bool virtio_scsi_handle_ctrl_vq(VirtIOSCSI
*s
, VirtQueue
*vq
)
439 bool progress
= false;
441 while ((req
= virtio_scsi_pop_req(s
, vq
))) {
443 virtio_scsi_handle_ctrl_req(s
, req
);
448 static void virtio_scsi_handle_ctrl(VirtIODevice
*vdev
, VirtQueue
*vq
)
450 VirtIOSCSI
*s
= (VirtIOSCSI
*)vdev
;
453 virtio_device_start_ioeventfd(vdev
);
454 if (!s
->dataplane_fenced
) {
458 virtio_scsi_acquire(s
);
459 virtio_scsi_handle_ctrl_vq(s
, vq
);
460 virtio_scsi_release(s
);
463 static void virtio_scsi_complete_cmd_req(VirtIOSCSIReq
*req
)
465 /* Sense data is not in req->resp and is copied separately
466 * in virtio_scsi_command_complete.
468 req
->resp_size
= sizeof(VirtIOSCSICmdResp
);
469 virtio_scsi_complete_req(req
);
472 static void virtio_scsi_command_complete(SCSIRequest
*r
, uint32_t status
,
475 VirtIOSCSIReq
*req
= r
->hba_private
;
476 uint8_t sense
[SCSI_SENSE_BUF_SIZE
];
478 VirtIODevice
*vdev
= VIRTIO_DEVICE(req
->dev
);
480 if (r
->io_canceled
) {
484 req
->resp
.cmd
.response
= VIRTIO_SCSI_S_OK
;
485 req
->resp
.cmd
.status
= status
;
486 if (req
->resp
.cmd
.status
== GOOD
) {
487 req
->resp
.cmd
.resid
= virtio_tswap32(vdev
, resid
);
489 req
->resp
.cmd
.resid
= 0;
490 sense_len
= scsi_req_get_sense(r
, sense
, sizeof(sense
));
491 sense_len
= MIN(sense_len
, req
->resp_iov
.size
- sizeof(req
->resp
.cmd
));
492 qemu_iovec_from_buf(&req
->resp_iov
, sizeof(req
->resp
.cmd
),
494 req
->resp
.cmd
.sense_len
= virtio_tswap32(vdev
, sense_len
);
496 virtio_scsi_complete_cmd_req(req
);
499 static int virtio_scsi_parse_cdb(SCSIDevice
*dev
, SCSICommand
*cmd
,
500 uint8_t *buf
, void *hba_private
)
502 VirtIOSCSIReq
*req
= hba_private
;
505 cmd
->len
= MIN(VIRTIO_SCSI_CDB_DEFAULT_SIZE
, SCSI_CMD_BUF_SIZE
);
506 memcpy(cmd
->buf
, buf
, cmd
->len
);
509 /* Extract the direction and mode directly from the request, for
510 * host device passthrough.
512 cmd
->xfer
= req
->qsgl
.size
;
513 cmd
->mode
= req
->mode
;
517 static QEMUSGList
*virtio_scsi_get_sg_list(SCSIRequest
*r
)
519 VirtIOSCSIReq
*req
= r
->hba_private
;
524 static void virtio_scsi_request_cancelled(SCSIRequest
*r
)
526 VirtIOSCSIReq
*req
= r
->hba_private
;
531 if (req
->dev
->resetting
) {
532 req
->resp
.cmd
.response
= VIRTIO_SCSI_S_RESET
;
534 req
->resp
.cmd
.response
= VIRTIO_SCSI_S_ABORTED
;
536 virtio_scsi_complete_cmd_req(req
);
539 static void virtio_scsi_fail_cmd_req(VirtIOSCSIReq
*req
)
541 req
->resp
.cmd
.response
= VIRTIO_SCSI_S_FAILURE
;
542 virtio_scsi_complete_cmd_req(req
);
545 static int virtio_scsi_handle_cmd_req_prepare(VirtIOSCSI
*s
, VirtIOSCSIReq
*req
)
547 VirtIOSCSICommon
*vs
= &s
->parent_obj
;
551 rc
= virtio_scsi_parse_req(req
, sizeof(VirtIOSCSICmdReq
) + vs
->cdb_size
,
552 sizeof(VirtIOSCSICmdResp
) + vs
->sense_size
);
554 if (rc
== -ENOTSUP
) {
555 virtio_scsi_fail_cmd_req(req
);
558 virtio_scsi_bad_req(req
);
563 d
= virtio_scsi_device_find(s
, req
->req
.cmd
.lun
);
565 req
->resp
.cmd
.response
= VIRTIO_SCSI_S_BAD_TARGET
;
566 virtio_scsi_complete_cmd_req(req
);
569 virtio_scsi_ctx_check(s
, d
);
570 req
->sreq
= scsi_req_new(d
, req
->req
.cmd
.tag
,
571 virtio_scsi_get_lun(req
->req
.cmd
.lun
),
572 req
->req
.cmd
.cdb
, req
);
574 if (req
->sreq
->cmd
.mode
!= SCSI_XFER_NONE
575 && (req
->sreq
->cmd
.mode
!= req
->mode
||
576 req
->sreq
->cmd
.xfer
> req
->qsgl
.size
)) {
577 req
->resp
.cmd
.response
= VIRTIO_SCSI_S_OVERRUN
;
578 virtio_scsi_complete_cmd_req(req
);
581 scsi_req_ref(req
->sreq
);
582 blk_io_plug(d
->conf
.blk
);
586 static void virtio_scsi_handle_cmd_req_submit(VirtIOSCSI
*s
, VirtIOSCSIReq
*req
)
588 SCSIRequest
*sreq
= req
->sreq
;
589 if (scsi_req_enqueue(sreq
)) {
590 scsi_req_continue(sreq
);
592 blk_io_unplug(sreq
->dev
->conf
.blk
);
593 scsi_req_unref(sreq
);
596 bool virtio_scsi_handle_cmd_vq(VirtIOSCSI
*s
, VirtQueue
*vq
)
598 VirtIOSCSIReq
*req
, *next
;
600 bool progress
= false;
602 QTAILQ_HEAD(, VirtIOSCSIReq
) reqs
= QTAILQ_HEAD_INITIALIZER(reqs
);
605 virtio_queue_set_notification(vq
, 0);
607 while ((req
= virtio_scsi_pop_req(s
, vq
))) {
609 ret
= virtio_scsi_handle_cmd_req_prepare(s
, req
);
611 QTAILQ_INSERT_TAIL(&reqs
, req
, next
);
612 } else if (ret
== -EINVAL
) {
613 /* The device is broken and shouldn't process any request */
614 while (!QTAILQ_EMPTY(&reqs
)) {
615 req
= QTAILQ_FIRST(&reqs
);
616 QTAILQ_REMOVE(&reqs
, req
, next
);
617 blk_io_unplug(req
->sreq
->dev
->conf
.blk
);
618 scsi_req_unref(req
->sreq
);
619 virtqueue_detach_element(req
->vq
, &req
->elem
, 0);
620 virtio_scsi_free_req(req
);
625 virtio_queue_set_notification(vq
, 1);
626 } while (ret
!= -EINVAL
&& !virtio_queue_empty(vq
));
628 QTAILQ_FOREACH_SAFE(req
, &reqs
, next
, next
) {
629 virtio_scsi_handle_cmd_req_submit(s
, req
);
634 static void virtio_scsi_handle_cmd(VirtIODevice
*vdev
, VirtQueue
*vq
)
636 /* use non-QOM casts in the data path */
637 VirtIOSCSI
*s
= (VirtIOSCSI
*)vdev
;
640 virtio_device_start_ioeventfd(vdev
);
641 if (!s
->dataplane_fenced
) {
645 virtio_scsi_acquire(s
);
646 virtio_scsi_handle_cmd_vq(s
, vq
);
647 virtio_scsi_release(s
);
650 static void virtio_scsi_get_config(VirtIODevice
*vdev
,
653 VirtIOSCSIConfig
*scsiconf
= (VirtIOSCSIConfig
*)config
;
654 VirtIOSCSICommon
*s
= VIRTIO_SCSI_COMMON(vdev
);
656 virtio_stl_p(vdev
, &scsiconf
->num_queues
, s
->conf
.num_queues
);
657 virtio_stl_p(vdev
, &scsiconf
->seg_max
, 128 - 2);
658 virtio_stl_p(vdev
, &scsiconf
->max_sectors
, s
->conf
.max_sectors
);
659 virtio_stl_p(vdev
, &scsiconf
->cmd_per_lun
, s
->conf
.cmd_per_lun
);
660 virtio_stl_p(vdev
, &scsiconf
->event_info_size
, sizeof(VirtIOSCSIEvent
));
661 virtio_stl_p(vdev
, &scsiconf
->sense_size
, s
->sense_size
);
662 virtio_stl_p(vdev
, &scsiconf
->cdb_size
, s
->cdb_size
);
663 virtio_stw_p(vdev
, &scsiconf
->max_channel
, VIRTIO_SCSI_MAX_CHANNEL
);
664 virtio_stw_p(vdev
, &scsiconf
->max_target
, VIRTIO_SCSI_MAX_TARGET
);
665 virtio_stl_p(vdev
, &scsiconf
->max_lun
, VIRTIO_SCSI_MAX_LUN
);
668 static void virtio_scsi_set_config(VirtIODevice
*vdev
,
669 const uint8_t *config
)
671 VirtIOSCSIConfig
*scsiconf
= (VirtIOSCSIConfig
*)config
;
672 VirtIOSCSICommon
*vs
= VIRTIO_SCSI_COMMON(vdev
);
674 if ((uint32_t) virtio_ldl_p(vdev
, &scsiconf
->sense_size
) >= 65536 ||
675 (uint32_t) virtio_ldl_p(vdev
, &scsiconf
->cdb_size
) >= 256) {
677 "bad data written to virtio-scsi configuration space");
681 vs
->sense_size
= virtio_ldl_p(vdev
, &scsiconf
->sense_size
);
682 vs
->cdb_size
= virtio_ldl_p(vdev
, &scsiconf
->cdb_size
);
685 static uint64_t virtio_scsi_get_features(VirtIODevice
*vdev
,
686 uint64_t requested_features
,
689 VirtIOSCSI
*s
= VIRTIO_SCSI(vdev
);
691 /* Firstly sync all virtio-scsi possible supported features */
692 requested_features
|= s
->host_features
;
693 return requested_features
;
696 static void virtio_scsi_reset(VirtIODevice
*vdev
)
698 VirtIOSCSI
*s
= VIRTIO_SCSI(vdev
);
699 VirtIOSCSICommon
*vs
= VIRTIO_SCSI_COMMON(vdev
);
701 assert(!s
->dataplane_started
);
703 qbus_reset_all(BUS(&s
->bus
));
706 vs
->sense_size
= VIRTIO_SCSI_SENSE_DEFAULT_SIZE
;
707 vs
->cdb_size
= VIRTIO_SCSI_CDB_DEFAULT_SIZE
;
708 s
->events_dropped
= false;
711 void virtio_scsi_push_event(VirtIOSCSI
*s
, SCSIDevice
*dev
,
712 uint32_t event
, uint32_t reason
)
714 VirtIOSCSICommon
*vs
= VIRTIO_SCSI_COMMON(s
);
716 VirtIOSCSIEvent
*evt
;
717 VirtIODevice
*vdev
= VIRTIO_DEVICE(s
);
719 if (!(vdev
->status
& VIRTIO_CONFIG_S_DRIVER_OK
)) {
723 req
= virtio_scsi_pop_req(s
, vs
->event_vq
);
725 s
->events_dropped
= true;
729 if (s
->events_dropped
) {
730 event
|= VIRTIO_SCSI_T_EVENTS_MISSED
;
731 s
->events_dropped
= false;
734 if (virtio_scsi_parse_req(req
, 0, sizeof(VirtIOSCSIEvent
))) {
735 virtio_scsi_bad_req(req
);
739 evt
= &req
->resp
.event
;
740 memset(evt
, 0, sizeof(VirtIOSCSIEvent
));
741 evt
->event
= virtio_tswap32(vdev
, event
);
742 evt
->reason
= virtio_tswap32(vdev
, reason
);
744 assert(event
== VIRTIO_SCSI_T_EVENTS_MISSED
);
747 evt
->lun
[1] = dev
->id
;
749 /* Linux wants us to keep the same encoding we use for REPORT LUNS. */
750 if (dev
->lun
>= 256) {
751 evt
->lun
[2] = (dev
->lun
>> 8) | 0x40;
753 evt
->lun
[3] = dev
->lun
& 0xFF;
755 virtio_scsi_complete_req(req
);
758 bool virtio_scsi_handle_event_vq(VirtIOSCSI
*s
, VirtQueue
*vq
)
760 if (s
->events_dropped
) {
761 virtio_scsi_push_event(s
, NULL
, VIRTIO_SCSI_T_NO_EVENT
, 0);
767 static void virtio_scsi_handle_event(VirtIODevice
*vdev
, VirtQueue
*vq
)
769 VirtIOSCSI
*s
= VIRTIO_SCSI(vdev
);
772 virtio_device_start_ioeventfd(vdev
);
773 if (!s
->dataplane_fenced
) {
777 virtio_scsi_acquire(s
);
778 virtio_scsi_handle_event_vq(s
, vq
);
779 virtio_scsi_release(s
);
782 static void virtio_scsi_change(SCSIBus
*bus
, SCSIDevice
*dev
, SCSISense sense
)
784 VirtIOSCSI
*s
= container_of(bus
, VirtIOSCSI
, bus
);
785 VirtIODevice
*vdev
= VIRTIO_DEVICE(s
);
787 if (virtio_vdev_has_feature(vdev
, VIRTIO_SCSI_F_CHANGE
) &&
788 dev
->type
!= TYPE_ROM
) {
789 virtio_scsi_acquire(s
);
790 virtio_scsi_push_event(s
, dev
, VIRTIO_SCSI_T_PARAM_CHANGE
,
791 sense
.asc
| (sense
.ascq
<< 8));
792 virtio_scsi_release(s
);
796 static void virtio_scsi_pre_hotplug(HotplugHandler
*hotplug_dev
,
797 DeviceState
*dev
, Error
**errp
)
799 SCSIDevice
*sd
= SCSI_DEVICE(dev
);
800 sd
->hba_supports_iothread
= true;
803 static void virtio_scsi_hotplug(HotplugHandler
*hotplug_dev
, DeviceState
*dev
,
806 VirtIODevice
*vdev
= VIRTIO_DEVICE(hotplug_dev
);
807 VirtIOSCSI
*s
= VIRTIO_SCSI(vdev
);
808 SCSIDevice
*sd
= SCSI_DEVICE(dev
);
811 if (s
->ctx
&& !s
->dataplane_fenced
) {
812 if (blk_op_is_blocked(sd
->conf
.blk
, BLOCK_OP_TYPE_DATAPLANE
, errp
)) {
815 virtio_scsi_acquire(s
);
816 ret
= blk_set_aio_context(sd
->conf
.blk
, s
->ctx
, errp
);
817 virtio_scsi_release(s
);
823 if (virtio_vdev_has_feature(vdev
, VIRTIO_SCSI_F_HOTPLUG
)) {
824 virtio_scsi_acquire(s
);
825 virtio_scsi_push_event(s
, sd
,
826 VIRTIO_SCSI_T_TRANSPORT_RESET
,
827 VIRTIO_SCSI_EVT_RESET_RESCAN
);
828 virtio_scsi_release(s
);
832 static void virtio_scsi_hotunplug(HotplugHandler
*hotplug_dev
, DeviceState
*dev
,
835 VirtIODevice
*vdev
= VIRTIO_DEVICE(hotplug_dev
);
836 VirtIOSCSI
*s
= VIRTIO_SCSI(vdev
);
837 SCSIDevice
*sd
= SCSI_DEVICE(dev
);
838 AioContext
*ctx
= s
->ctx
?: qemu_get_aio_context();
840 if (virtio_vdev_has_feature(vdev
, VIRTIO_SCSI_F_HOTPLUG
)) {
841 virtio_scsi_acquire(s
);
842 virtio_scsi_push_event(s
, sd
,
843 VIRTIO_SCSI_T_TRANSPORT_RESET
,
844 VIRTIO_SCSI_EVT_RESET_REMOVED
);
845 virtio_scsi_release(s
);
848 aio_disable_external(ctx
);
849 qdev_simple_device_unplug_cb(hotplug_dev
, dev
, errp
);
850 aio_enable_external(ctx
);
853 virtio_scsi_acquire(s
);
854 /* If other users keep the BlockBackend in the iothread, that's ok */
855 blk_set_aio_context(sd
->conf
.blk
, qemu_get_aio_context(), NULL
);
856 virtio_scsi_release(s
);
860 static struct SCSIBusInfo virtio_scsi_scsi_info
= {
862 .max_channel
= VIRTIO_SCSI_MAX_CHANNEL
,
863 .max_target
= VIRTIO_SCSI_MAX_TARGET
,
864 .max_lun
= VIRTIO_SCSI_MAX_LUN
,
866 .complete
= virtio_scsi_command_complete
,
867 .cancel
= virtio_scsi_request_cancelled
,
868 .change
= virtio_scsi_change
,
869 .parse_cdb
= virtio_scsi_parse_cdb
,
870 .get_sg_list
= virtio_scsi_get_sg_list
,
871 .save_request
= virtio_scsi_save_request
,
872 .load_request
= virtio_scsi_load_request
,
875 void virtio_scsi_common_realize(DeviceState
*dev
,
876 VirtIOHandleOutput ctrl
,
877 VirtIOHandleOutput evt
,
878 VirtIOHandleOutput cmd
,
881 VirtIODevice
*vdev
= VIRTIO_DEVICE(dev
);
882 VirtIOSCSICommon
*s
= VIRTIO_SCSI_COMMON(dev
);
885 virtio_init(vdev
, "virtio-scsi", VIRTIO_ID_SCSI
,
886 sizeof(VirtIOSCSIConfig
));
888 if (s
->conf
.num_queues
== 0 ||
889 s
->conf
.num_queues
> VIRTIO_QUEUE_MAX
- 2) {
890 error_setg(errp
, "Invalid number of queues (= %" PRIu32
"), "
891 "must be a positive integer less than %d.",
892 s
->conf
.num_queues
, VIRTIO_QUEUE_MAX
- 2);
893 virtio_cleanup(vdev
);
896 s
->cmd_vqs
= g_new0(VirtQueue
*, s
->conf
.num_queues
);
897 s
->sense_size
= VIRTIO_SCSI_SENSE_DEFAULT_SIZE
;
898 s
->cdb_size
= VIRTIO_SCSI_CDB_DEFAULT_SIZE
;
900 s
->ctrl_vq
= virtio_add_queue(vdev
, s
->conf
.virtqueue_size
, ctrl
);
901 s
->event_vq
= virtio_add_queue(vdev
, s
->conf
.virtqueue_size
, evt
);
902 for (i
= 0; i
< s
->conf
.num_queues
; i
++) {
903 s
->cmd_vqs
[i
] = virtio_add_queue(vdev
, s
->conf
.virtqueue_size
, cmd
);
907 static void virtio_scsi_device_realize(DeviceState
*dev
, Error
**errp
)
909 VirtIODevice
*vdev
= VIRTIO_DEVICE(dev
);
910 VirtIOSCSI
*s
= VIRTIO_SCSI(dev
);
913 virtio_scsi_common_realize(dev
,
914 virtio_scsi_handle_ctrl
,
915 virtio_scsi_handle_event
,
916 virtio_scsi_handle_cmd
,
919 error_propagate(errp
, err
);
923 scsi_bus_new(&s
->bus
, sizeof(s
->bus
), dev
,
924 &virtio_scsi_scsi_info
, vdev
->bus_name
);
925 /* override default SCSI bus hotplug-handler, with virtio-scsi's one */
926 qbus_set_hotplug_handler(BUS(&s
->bus
), OBJECT(dev
), &error_abort
);
928 virtio_scsi_dataplane_setup(s
, errp
);
931 void virtio_scsi_common_unrealize(DeviceState
*dev
)
933 VirtIODevice
*vdev
= VIRTIO_DEVICE(dev
);
934 VirtIOSCSICommon
*vs
= VIRTIO_SCSI_COMMON(dev
);
937 virtio_cleanup(vdev
);
940 static void virtio_scsi_device_unrealize(DeviceState
*dev
, Error
**errp
)
942 VirtIOSCSI
*s
= VIRTIO_SCSI(dev
);
944 qbus_set_hotplug_handler(BUS(&s
->bus
), NULL
, &error_abort
);
945 virtio_scsi_common_unrealize(dev
);
948 static Property virtio_scsi_properties
[] = {
949 DEFINE_PROP_UINT32("num_queues", VirtIOSCSI
, parent_obj
.conf
.num_queues
, 1),
950 DEFINE_PROP_UINT32("virtqueue_size", VirtIOSCSI
,
951 parent_obj
.conf
.virtqueue_size
, 128),
952 DEFINE_PROP_UINT32("max_sectors", VirtIOSCSI
, parent_obj
.conf
.max_sectors
,
954 DEFINE_PROP_UINT32("cmd_per_lun", VirtIOSCSI
, parent_obj
.conf
.cmd_per_lun
,
956 DEFINE_PROP_BIT("hotplug", VirtIOSCSI
, host_features
,
957 VIRTIO_SCSI_F_HOTPLUG
, true),
958 DEFINE_PROP_BIT("param_change", VirtIOSCSI
, host_features
,
959 VIRTIO_SCSI_F_CHANGE
, true),
960 DEFINE_PROP_LINK("iothread", VirtIOSCSI
, parent_obj
.conf
.iothread
,
961 TYPE_IOTHREAD
, IOThread
*),
962 DEFINE_PROP_END_OF_LIST(),
965 static const VMStateDescription vmstate_virtio_scsi
= {
966 .name
= "virtio-scsi",
967 .minimum_version_id
= 1,
969 .fields
= (VMStateField
[]) {
970 VMSTATE_VIRTIO_DEVICE
,
971 VMSTATE_END_OF_LIST()
975 static void virtio_scsi_common_class_init(ObjectClass
*klass
, void *data
)
977 VirtioDeviceClass
*vdc
= VIRTIO_DEVICE_CLASS(klass
);
978 DeviceClass
*dc
= DEVICE_CLASS(klass
);
980 vdc
->get_config
= virtio_scsi_get_config
;
981 set_bit(DEVICE_CATEGORY_STORAGE
, dc
->categories
);
984 static void virtio_scsi_class_init(ObjectClass
*klass
, void *data
)
986 DeviceClass
*dc
= DEVICE_CLASS(klass
);
987 VirtioDeviceClass
*vdc
= VIRTIO_DEVICE_CLASS(klass
);
988 HotplugHandlerClass
*hc
= HOTPLUG_HANDLER_CLASS(klass
);
990 dc
->props
= virtio_scsi_properties
;
991 dc
->vmsd
= &vmstate_virtio_scsi
;
992 set_bit(DEVICE_CATEGORY_STORAGE
, dc
->categories
);
993 vdc
->realize
= virtio_scsi_device_realize
;
994 vdc
->unrealize
= virtio_scsi_device_unrealize
;
995 vdc
->set_config
= virtio_scsi_set_config
;
996 vdc
->get_features
= virtio_scsi_get_features
;
997 vdc
->reset
= virtio_scsi_reset
;
998 vdc
->start_ioeventfd
= virtio_scsi_dataplane_start
;
999 vdc
->stop_ioeventfd
= virtio_scsi_dataplane_stop
;
1000 hc
->pre_plug
= virtio_scsi_pre_hotplug
;
1001 hc
->plug
= virtio_scsi_hotplug
;
1002 hc
->unplug
= virtio_scsi_hotunplug
;
1005 static const TypeInfo virtio_scsi_common_info
= {
1006 .name
= TYPE_VIRTIO_SCSI_COMMON
,
1007 .parent
= TYPE_VIRTIO_DEVICE
,
1008 .instance_size
= sizeof(VirtIOSCSICommon
),
1010 .class_init
= virtio_scsi_common_class_init
,
1013 static const TypeInfo virtio_scsi_info
= {
1014 .name
= TYPE_VIRTIO_SCSI
,
1015 .parent
= TYPE_VIRTIO_SCSI_COMMON
,
1016 .instance_size
= sizeof(VirtIOSCSI
),
1017 .class_init
= virtio_scsi_class_init
,
1018 .interfaces
= (InterfaceInfo
[]) {
1019 { TYPE_HOTPLUG_HANDLER
},
1024 static void virtio_register_types(void)
1026 type_register_static(&virtio_scsi_common_info
);
1027 type_register_static(&virtio_scsi_info
);
1030 type_init(virtio_register_types
)