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_get(VirtIOSCSI
*s
, uint8_t *lun
)
41 if (lun
[2] != 0 && !(lun
[2] >= 0x40 && lun
[2] < 0x80)) {
44 return scsi_device_get(&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
) - VIRTIO_SCSI_VQ_NUM_FIXED
;
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_get(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];
372 QTAILQ_FOREACH_RCU(kid
, &s
->bus
.qbus
.children
, sibling
) {
373 SCSIDevice
*d1
= SCSI_DEVICE(kid
->child
);
374 if (d1
->channel
== 0 && d1
->id
== target
) {
375 qdev_reset_all(&d1
->qdev
);
383 case VIRTIO_SCSI_T_TMF_CLEAR_ACA
:
385 req
->resp
.tmf
.response
= VIRTIO_SCSI_S_FUNCTION_REJECTED
;
389 object_unref(OBJECT(d
));
393 req
->resp
.tmf
.response
= VIRTIO_SCSI_S_INCORRECT_LUN
;
394 object_unref(OBJECT(d
));
398 req
->resp
.tmf
.response
= VIRTIO_SCSI_S_BAD_TARGET
;
399 object_unref(OBJECT(d
));
403 static void virtio_scsi_handle_ctrl_req(VirtIOSCSI
*s
, VirtIOSCSIReq
*req
)
405 VirtIODevice
*vdev
= (VirtIODevice
*)s
;
409 if (iov_to_buf(req
->elem
.out_sg
, req
->elem
.out_num
, 0,
410 &type
, sizeof(type
)) < sizeof(type
)) {
411 virtio_scsi_bad_req(req
);
415 virtio_tswap32s(vdev
, &type
);
416 if (type
== VIRTIO_SCSI_T_TMF
) {
417 if (virtio_scsi_parse_req(req
, sizeof(VirtIOSCSICtrlTMFReq
),
418 sizeof(VirtIOSCSICtrlTMFResp
)) < 0) {
419 virtio_scsi_bad_req(req
);
422 r
= virtio_scsi_do_tmf(s
, req
);
425 } else if (type
== VIRTIO_SCSI_T_AN_QUERY
||
426 type
== VIRTIO_SCSI_T_AN_SUBSCRIBE
) {
427 if (virtio_scsi_parse_req(req
, sizeof(VirtIOSCSICtrlANReq
),
428 sizeof(VirtIOSCSICtrlANResp
)) < 0) {
429 virtio_scsi_bad_req(req
);
432 req
->resp
.an
.event_actual
= 0;
433 req
->resp
.an
.response
= VIRTIO_SCSI_S_OK
;
437 virtio_scsi_complete_req(req
);
439 assert(r
== -EINPROGRESS
);
443 bool virtio_scsi_handle_ctrl_vq(VirtIOSCSI
*s
, VirtQueue
*vq
)
446 bool progress
= false;
448 while ((req
= virtio_scsi_pop_req(s
, vq
))) {
450 virtio_scsi_handle_ctrl_req(s
, req
);
455 static void virtio_scsi_handle_ctrl(VirtIODevice
*vdev
, VirtQueue
*vq
)
457 VirtIOSCSI
*s
= (VirtIOSCSI
*)vdev
;
460 virtio_device_start_ioeventfd(vdev
);
461 if (!s
->dataplane_fenced
) {
465 virtio_scsi_acquire(s
);
466 virtio_scsi_handle_ctrl_vq(s
, vq
);
467 virtio_scsi_release(s
);
470 static void virtio_scsi_complete_cmd_req(VirtIOSCSIReq
*req
)
472 /* Sense data is not in req->resp and is copied separately
473 * in virtio_scsi_command_complete.
475 req
->resp_size
= sizeof(VirtIOSCSICmdResp
);
476 virtio_scsi_complete_req(req
);
479 static void virtio_scsi_command_complete(SCSIRequest
*r
, uint32_t status
,
482 VirtIOSCSIReq
*req
= r
->hba_private
;
483 uint8_t sense
[SCSI_SENSE_BUF_SIZE
];
485 VirtIODevice
*vdev
= VIRTIO_DEVICE(req
->dev
);
487 if (r
->io_canceled
) {
491 req
->resp
.cmd
.response
= VIRTIO_SCSI_S_OK
;
492 req
->resp
.cmd
.status
= status
;
493 if (req
->resp
.cmd
.status
== GOOD
) {
494 req
->resp
.cmd
.resid
= virtio_tswap32(vdev
, resid
);
496 req
->resp
.cmd
.resid
= 0;
497 sense_len
= scsi_req_get_sense(r
, sense
, sizeof(sense
));
498 sense_len
= MIN(sense_len
, req
->resp_iov
.size
- sizeof(req
->resp
.cmd
));
499 qemu_iovec_from_buf(&req
->resp_iov
, sizeof(req
->resp
.cmd
),
501 req
->resp
.cmd
.sense_len
= virtio_tswap32(vdev
, sense_len
);
503 virtio_scsi_complete_cmd_req(req
);
506 static int virtio_scsi_parse_cdb(SCSIDevice
*dev
, SCSICommand
*cmd
,
507 uint8_t *buf
, void *hba_private
)
509 VirtIOSCSIReq
*req
= hba_private
;
512 cmd
->len
= MIN(VIRTIO_SCSI_CDB_DEFAULT_SIZE
, SCSI_CMD_BUF_SIZE
);
513 memcpy(cmd
->buf
, buf
, cmd
->len
);
516 /* Extract the direction and mode directly from the request, for
517 * host device passthrough.
519 cmd
->xfer
= req
->qsgl
.size
;
520 cmd
->mode
= req
->mode
;
524 static QEMUSGList
*virtio_scsi_get_sg_list(SCSIRequest
*r
)
526 VirtIOSCSIReq
*req
= r
->hba_private
;
531 static void virtio_scsi_request_cancelled(SCSIRequest
*r
)
533 VirtIOSCSIReq
*req
= r
->hba_private
;
538 if (req
->dev
->resetting
) {
539 req
->resp
.cmd
.response
= VIRTIO_SCSI_S_RESET
;
541 req
->resp
.cmd
.response
= VIRTIO_SCSI_S_ABORTED
;
543 virtio_scsi_complete_cmd_req(req
);
546 static void virtio_scsi_fail_cmd_req(VirtIOSCSIReq
*req
)
548 req
->resp
.cmd
.response
= VIRTIO_SCSI_S_FAILURE
;
549 virtio_scsi_complete_cmd_req(req
);
552 static int virtio_scsi_handle_cmd_req_prepare(VirtIOSCSI
*s
, VirtIOSCSIReq
*req
)
554 VirtIOSCSICommon
*vs
= &s
->parent_obj
;
558 rc
= virtio_scsi_parse_req(req
, sizeof(VirtIOSCSICmdReq
) + vs
->cdb_size
,
559 sizeof(VirtIOSCSICmdResp
) + vs
->sense_size
);
561 if (rc
== -ENOTSUP
) {
562 virtio_scsi_fail_cmd_req(req
);
565 virtio_scsi_bad_req(req
);
570 d
= virtio_scsi_device_get(s
, req
->req
.cmd
.lun
);
572 req
->resp
.cmd
.response
= VIRTIO_SCSI_S_BAD_TARGET
;
573 virtio_scsi_complete_cmd_req(req
);
576 virtio_scsi_ctx_check(s
, d
);
577 req
->sreq
= scsi_req_new(d
, req
->req
.cmd
.tag
,
578 virtio_scsi_get_lun(req
->req
.cmd
.lun
),
579 req
->req
.cmd
.cdb
, req
);
581 if (req
->sreq
->cmd
.mode
!= SCSI_XFER_NONE
582 && (req
->sreq
->cmd
.mode
!= req
->mode
||
583 req
->sreq
->cmd
.xfer
> req
->qsgl
.size
)) {
584 req
->resp
.cmd
.response
= VIRTIO_SCSI_S_OVERRUN
;
585 virtio_scsi_complete_cmd_req(req
);
586 object_unref(OBJECT(d
));
589 scsi_req_ref(req
->sreq
);
590 blk_io_plug(d
->conf
.blk
);
591 object_unref(OBJECT(d
));
595 static void virtio_scsi_handle_cmd_req_submit(VirtIOSCSI
*s
, VirtIOSCSIReq
*req
)
597 SCSIRequest
*sreq
= req
->sreq
;
598 if (scsi_req_enqueue(sreq
)) {
599 scsi_req_continue(sreq
);
601 blk_io_unplug(sreq
->dev
->conf
.blk
);
602 scsi_req_unref(sreq
);
605 bool virtio_scsi_handle_cmd_vq(VirtIOSCSI
*s
, VirtQueue
*vq
)
607 VirtIOSCSIReq
*req
, *next
;
609 bool suppress_notifications
= virtio_queue_get_notification(vq
);
610 bool progress
= false;
612 QTAILQ_HEAD(, VirtIOSCSIReq
) reqs
= QTAILQ_HEAD_INITIALIZER(reqs
);
615 if (suppress_notifications
) {
616 virtio_queue_set_notification(vq
, 0);
619 while ((req
= virtio_scsi_pop_req(s
, vq
))) {
621 ret
= virtio_scsi_handle_cmd_req_prepare(s
, req
);
623 QTAILQ_INSERT_TAIL(&reqs
, req
, next
);
624 } else if (ret
== -EINVAL
) {
625 /* The device is broken and shouldn't process any request */
626 while (!QTAILQ_EMPTY(&reqs
)) {
627 req
= QTAILQ_FIRST(&reqs
);
628 QTAILQ_REMOVE(&reqs
, req
, next
);
629 blk_io_unplug(req
->sreq
->dev
->conf
.blk
);
630 scsi_req_unref(req
->sreq
);
631 virtqueue_detach_element(req
->vq
, &req
->elem
, 0);
632 virtio_scsi_free_req(req
);
637 if (suppress_notifications
) {
638 virtio_queue_set_notification(vq
, 1);
640 } while (ret
!= -EINVAL
&& !virtio_queue_empty(vq
));
642 QTAILQ_FOREACH_SAFE(req
, &reqs
, next
, next
) {
643 virtio_scsi_handle_cmd_req_submit(s
, req
);
648 static void virtio_scsi_handle_cmd(VirtIODevice
*vdev
, VirtQueue
*vq
)
650 /* use non-QOM casts in the data path */
651 VirtIOSCSI
*s
= (VirtIOSCSI
*)vdev
;
654 virtio_device_start_ioeventfd(vdev
);
655 if (!s
->dataplane_fenced
) {
659 virtio_scsi_acquire(s
);
660 virtio_scsi_handle_cmd_vq(s
, vq
);
661 virtio_scsi_release(s
);
664 static void virtio_scsi_get_config(VirtIODevice
*vdev
,
667 VirtIOSCSIConfig
*scsiconf
= (VirtIOSCSIConfig
*)config
;
668 VirtIOSCSICommon
*s
= VIRTIO_SCSI_COMMON(vdev
);
670 virtio_stl_p(vdev
, &scsiconf
->num_queues
, s
->conf
.num_queues
);
671 virtio_stl_p(vdev
, &scsiconf
->seg_max
,
672 s
->conf
.seg_max_adjust
? s
->conf
.virtqueue_size
- 2 : 128 - 2);
673 virtio_stl_p(vdev
, &scsiconf
->max_sectors
, s
->conf
.max_sectors
);
674 virtio_stl_p(vdev
, &scsiconf
->cmd_per_lun
, s
->conf
.cmd_per_lun
);
675 virtio_stl_p(vdev
, &scsiconf
->event_info_size
, sizeof(VirtIOSCSIEvent
));
676 virtio_stl_p(vdev
, &scsiconf
->sense_size
, s
->sense_size
);
677 virtio_stl_p(vdev
, &scsiconf
->cdb_size
, s
->cdb_size
);
678 virtio_stw_p(vdev
, &scsiconf
->max_channel
, VIRTIO_SCSI_MAX_CHANNEL
);
679 virtio_stw_p(vdev
, &scsiconf
->max_target
, VIRTIO_SCSI_MAX_TARGET
);
680 virtio_stl_p(vdev
, &scsiconf
->max_lun
, VIRTIO_SCSI_MAX_LUN
);
683 static void virtio_scsi_set_config(VirtIODevice
*vdev
,
684 const uint8_t *config
)
686 VirtIOSCSIConfig
*scsiconf
= (VirtIOSCSIConfig
*)config
;
687 VirtIOSCSICommon
*vs
= VIRTIO_SCSI_COMMON(vdev
);
689 if ((uint32_t) virtio_ldl_p(vdev
, &scsiconf
->sense_size
) >= 65536 ||
690 (uint32_t) virtio_ldl_p(vdev
, &scsiconf
->cdb_size
) >= 256) {
692 "bad data written to virtio-scsi configuration space");
696 vs
->sense_size
= virtio_ldl_p(vdev
, &scsiconf
->sense_size
);
697 vs
->cdb_size
= virtio_ldl_p(vdev
, &scsiconf
->cdb_size
);
700 static uint64_t virtio_scsi_get_features(VirtIODevice
*vdev
,
701 uint64_t requested_features
,
704 VirtIOSCSI
*s
= VIRTIO_SCSI(vdev
);
706 /* Firstly sync all virtio-scsi possible supported features */
707 requested_features
|= s
->host_features
;
708 return requested_features
;
711 static void virtio_scsi_reset(VirtIODevice
*vdev
)
713 VirtIOSCSI
*s
= VIRTIO_SCSI(vdev
);
714 VirtIOSCSICommon
*vs
= VIRTIO_SCSI_COMMON(vdev
);
716 assert(!s
->dataplane_started
);
718 qbus_reset_all(BUS(&s
->bus
));
721 vs
->sense_size
= VIRTIO_SCSI_SENSE_DEFAULT_SIZE
;
722 vs
->cdb_size
= VIRTIO_SCSI_CDB_DEFAULT_SIZE
;
723 s
->events_dropped
= false;
726 void virtio_scsi_push_event(VirtIOSCSI
*s
, SCSIDevice
*dev
,
727 uint32_t event
, uint32_t reason
)
729 VirtIOSCSICommon
*vs
= VIRTIO_SCSI_COMMON(s
);
731 VirtIOSCSIEvent
*evt
;
732 VirtIODevice
*vdev
= VIRTIO_DEVICE(s
);
734 if (!(vdev
->status
& VIRTIO_CONFIG_S_DRIVER_OK
)) {
738 req
= virtio_scsi_pop_req(s
, vs
->event_vq
);
740 s
->events_dropped
= true;
744 if (s
->events_dropped
) {
745 event
|= VIRTIO_SCSI_T_EVENTS_MISSED
;
746 s
->events_dropped
= false;
749 if (virtio_scsi_parse_req(req
, 0, sizeof(VirtIOSCSIEvent
))) {
750 virtio_scsi_bad_req(req
);
754 evt
= &req
->resp
.event
;
755 memset(evt
, 0, sizeof(VirtIOSCSIEvent
));
756 evt
->event
= virtio_tswap32(vdev
, event
);
757 evt
->reason
= virtio_tswap32(vdev
, reason
);
759 assert(event
== VIRTIO_SCSI_T_EVENTS_MISSED
);
762 evt
->lun
[1] = dev
->id
;
764 /* Linux wants us to keep the same encoding we use for REPORT LUNS. */
765 if (dev
->lun
>= 256) {
766 evt
->lun
[2] = (dev
->lun
>> 8) | 0x40;
768 evt
->lun
[3] = dev
->lun
& 0xFF;
770 virtio_scsi_complete_req(req
);
773 bool virtio_scsi_handle_event_vq(VirtIOSCSI
*s
, VirtQueue
*vq
)
775 if (s
->events_dropped
) {
776 virtio_scsi_push_event(s
, NULL
, VIRTIO_SCSI_T_NO_EVENT
, 0);
782 static void virtio_scsi_handle_event(VirtIODevice
*vdev
, VirtQueue
*vq
)
784 VirtIOSCSI
*s
= VIRTIO_SCSI(vdev
);
787 virtio_device_start_ioeventfd(vdev
);
788 if (!s
->dataplane_fenced
) {
792 virtio_scsi_acquire(s
);
793 virtio_scsi_handle_event_vq(s
, vq
);
794 virtio_scsi_release(s
);
797 static void virtio_scsi_change(SCSIBus
*bus
, SCSIDevice
*dev
, SCSISense sense
)
799 VirtIOSCSI
*s
= container_of(bus
, VirtIOSCSI
, bus
);
800 VirtIODevice
*vdev
= VIRTIO_DEVICE(s
);
802 if (virtio_vdev_has_feature(vdev
, VIRTIO_SCSI_F_CHANGE
) &&
803 dev
->type
!= TYPE_ROM
) {
804 virtio_scsi_acquire(s
);
805 virtio_scsi_push_event(s
, dev
, VIRTIO_SCSI_T_PARAM_CHANGE
,
806 sense
.asc
| (sense
.ascq
<< 8));
807 virtio_scsi_release(s
);
811 static void virtio_scsi_pre_hotplug(HotplugHandler
*hotplug_dev
,
812 DeviceState
*dev
, Error
**errp
)
814 SCSIDevice
*sd
= SCSI_DEVICE(dev
);
815 sd
->hba_supports_iothread
= true;
818 static void virtio_scsi_hotplug(HotplugHandler
*hotplug_dev
, DeviceState
*dev
,
821 VirtIODevice
*vdev
= VIRTIO_DEVICE(hotplug_dev
);
822 VirtIOSCSI
*s
= VIRTIO_SCSI(vdev
);
823 SCSIDevice
*sd
= SCSI_DEVICE(dev
);
826 if (s
->ctx
&& !s
->dataplane_fenced
) {
827 if (blk_op_is_blocked(sd
->conf
.blk
, BLOCK_OP_TYPE_DATAPLANE
, errp
)) {
830 virtio_scsi_acquire(s
);
831 ret
= blk_set_aio_context(sd
->conf
.blk
, s
->ctx
, errp
);
832 virtio_scsi_release(s
);
838 if (virtio_vdev_has_feature(vdev
, VIRTIO_SCSI_F_HOTPLUG
)) {
839 virtio_scsi_acquire(s
);
840 virtio_scsi_push_event(s
, sd
,
841 VIRTIO_SCSI_T_TRANSPORT_RESET
,
842 VIRTIO_SCSI_EVT_RESET_RESCAN
);
843 virtio_scsi_release(s
);
847 static void virtio_scsi_hotunplug(HotplugHandler
*hotplug_dev
, DeviceState
*dev
,
850 VirtIODevice
*vdev
= VIRTIO_DEVICE(hotplug_dev
);
851 VirtIOSCSI
*s
= VIRTIO_SCSI(vdev
);
852 SCSIDevice
*sd
= SCSI_DEVICE(dev
);
853 AioContext
*ctx
= s
->ctx
?: qemu_get_aio_context();
855 if (virtio_vdev_has_feature(vdev
, VIRTIO_SCSI_F_HOTPLUG
)) {
856 virtio_scsi_acquire(s
);
857 virtio_scsi_push_event(s
, sd
,
858 VIRTIO_SCSI_T_TRANSPORT_RESET
,
859 VIRTIO_SCSI_EVT_RESET_REMOVED
);
860 virtio_scsi_release(s
);
863 aio_disable_external(ctx
);
864 qdev_simple_device_unplug_cb(hotplug_dev
, dev
, errp
);
865 aio_enable_external(ctx
);
868 virtio_scsi_acquire(s
);
869 /* If other users keep the BlockBackend in the iothread, that's ok */
870 blk_set_aio_context(sd
->conf
.blk
, qemu_get_aio_context(), NULL
);
871 virtio_scsi_release(s
);
875 static struct SCSIBusInfo virtio_scsi_scsi_info
= {
877 .max_channel
= VIRTIO_SCSI_MAX_CHANNEL
,
878 .max_target
= VIRTIO_SCSI_MAX_TARGET
,
879 .max_lun
= VIRTIO_SCSI_MAX_LUN
,
881 .complete
= virtio_scsi_command_complete
,
882 .cancel
= virtio_scsi_request_cancelled
,
883 .change
= virtio_scsi_change
,
884 .parse_cdb
= virtio_scsi_parse_cdb
,
885 .get_sg_list
= virtio_scsi_get_sg_list
,
886 .save_request
= virtio_scsi_save_request
,
887 .load_request
= virtio_scsi_load_request
,
890 void virtio_scsi_common_realize(DeviceState
*dev
,
891 VirtIOHandleOutput ctrl
,
892 VirtIOHandleOutput evt
,
893 VirtIOHandleOutput cmd
,
896 VirtIODevice
*vdev
= VIRTIO_DEVICE(dev
);
897 VirtIOSCSICommon
*s
= VIRTIO_SCSI_COMMON(dev
);
900 virtio_init(vdev
, "virtio-scsi", VIRTIO_ID_SCSI
,
901 sizeof(VirtIOSCSIConfig
));
903 if (s
->conf
.num_queues
== VIRTIO_SCSI_AUTO_NUM_QUEUES
) {
904 s
->conf
.num_queues
= 1;
906 if (s
->conf
.num_queues
== 0 ||
907 s
->conf
.num_queues
> VIRTIO_QUEUE_MAX
- VIRTIO_SCSI_VQ_NUM_FIXED
) {
908 error_setg(errp
, "Invalid number of queues (= %" PRIu32
"), "
909 "must be a positive integer less than %d.",
911 VIRTIO_QUEUE_MAX
- VIRTIO_SCSI_VQ_NUM_FIXED
);
912 virtio_cleanup(vdev
);
915 if (s
->conf
.virtqueue_size
<= 2) {
916 error_setg(errp
, "invalid virtqueue_size property (= %" PRIu32
"), "
917 "must be > 2", s
->conf
.virtqueue_size
);
920 s
->cmd_vqs
= g_new0(VirtQueue
*, s
->conf
.num_queues
);
921 s
->sense_size
= VIRTIO_SCSI_SENSE_DEFAULT_SIZE
;
922 s
->cdb_size
= VIRTIO_SCSI_CDB_DEFAULT_SIZE
;
924 s
->ctrl_vq
= virtio_add_queue(vdev
, s
->conf
.virtqueue_size
, ctrl
);
925 s
->event_vq
= virtio_add_queue(vdev
, s
->conf
.virtqueue_size
, evt
);
926 for (i
= 0; i
< s
->conf
.num_queues
; i
++) {
927 s
->cmd_vqs
[i
] = virtio_add_queue(vdev
, s
->conf
.virtqueue_size
, cmd
);
931 static void virtio_scsi_device_realize(DeviceState
*dev
, Error
**errp
)
933 VirtIODevice
*vdev
= VIRTIO_DEVICE(dev
);
934 VirtIOSCSI
*s
= VIRTIO_SCSI(dev
);
937 virtio_scsi_common_realize(dev
,
938 virtio_scsi_handle_ctrl
,
939 virtio_scsi_handle_event
,
940 virtio_scsi_handle_cmd
,
943 error_propagate(errp
, err
);
947 scsi_bus_new(&s
->bus
, sizeof(s
->bus
), dev
,
948 &virtio_scsi_scsi_info
, vdev
->bus_name
);
949 /* override default SCSI bus hotplug-handler, with virtio-scsi's one */
950 qbus_set_hotplug_handler(BUS(&s
->bus
), OBJECT(dev
));
952 virtio_scsi_dataplane_setup(s
, errp
);
955 void virtio_scsi_common_unrealize(DeviceState
*dev
)
957 VirtIODevice
*vdev
= VIRTIO_DEVICE(dev
);
958 VirtIOSCSICommon
*vs
= VIRTIO_SCSI_COMMON(dev
);
961 virtio_delete_queue(vs
->ctrl_vq
);
962 virtio_delete_queue(vs
->event_vq
);
963 for (i
= 0; i
< vs
->conf
.num_queues
; i
++) {
964 virtio_delete_queue(vs
->cmd_vqs
[i
]);
967 virtio_cleanup(vdev
);
970 static void virtio_scsi_device_unrealize(DeviceState
*dev
)
972 VirtIOSCSI
*s
= VIRTIO_SCSI(dev
);
974 qbus_set_hotplug_handler(BUS(&s
->bus
), NULL
);
975 virtio_scsi_common_unrealize(dev
);
978 static Property virtio_scsi_properties
[] = {
979 DEFINE_PROP_UINT32("num_queues", VirtIOSCSI
, parent_obj
.conf
.num_queues
,
980 VIRTIO_SCSI_AUTO_NUM_QUEUES
),
981 DEFINE_PROP_UINT32("virtqueue_size", VirtIOSCSI
,
982 parent_obj
.conf
.virtqueue_size
, 256),
983 DEFINE_PROP_BOOL("seg_max_adjust", VirtIOSCSI
,
984 parent_obj
.conf
.seg_max_adjust
, true),
985 DEFINE_PROP_UINT32("max_sectors", VirtIOSCSI
, parent_obj
.conf
.max_sectors
,
987 DEFINE_PROP_UINT32("cmd_per_lun", VirtIOSCSI
, parent_obj
.conf
.cmd_per_lun
,
989 DEFINE_PROP_BIT("hotplug", VirtIOSCSI
, host_features
,
990 VIRTIO_SCSI_F_HOTPLUG
, true),
991 DEFINE_PROP_BIT("param_change", VirtIOSCSI
, host_features
,
992 VIRTIO_SCSI_F_CHANGE
, true),
993 DEFINE_PROP_LINK("iothread", VirtIOSCSI
, parent_obj
.conf
.iothread
,
994 TYPE_IOTHREAD
, IOThread
*),
995 DEFINE_PROP_END_OF_LIST(),
998 static const VMStateDescription vmstate_virtio_scsi
= {
999 .name
= "virtio-scsi",
1000 .minimum_version_id
= 1,
1002 .fields
= (VMStateField
[]) {
1003 VMSTATE_VIRTIO_DEVICE
,
1004 VMSTATE_END_OF_LIST()
1008 static void virtio_scsi_common_class_init(ObjectClass
*klass
, void *data
)
1010 VirtioDeviceClass
*vdc
= VIRTIO_DEVICE_CLASS(klass
);
1011 DeviceClass
*dc
= DEVICE_CLASS(klass
);
1013 vdc
->get_config
= virtio_scsi_get_config
;
1014 set_bit(DEVICE_CATEGORY_STORAGE
, dc
->categories
);
1017 static void virtio_scsi_class_init(ObjectClass
*klass
, void *data
)
1019 DeviceClass
*dc
= DEVICE_CLASS(klass
);
1020 VirtioDeviceClass
*vdc
= VIRTIO_DEVICE_CLASS(klass
);
1021 HotplugHandlerClass
*hc
= HOTPLUG_HANDLER_CLASS(klass
);
1023 device_class_set_props(dc
, virtio_scsi_properties
);
1024 dc
->vmsd
= &vmstate_virtio_scsi
;
1025 set_bit(DEVICE_CATEGORY_STORAGE
, dc
->categories
);
1026 vdc
->realize
= virtio_scsi_device_realize
;
1027 vdc
->unrealize
= virtio_scsi_device_unrealize
;
1028 vdc
->set_config
= virtio_scsi_set_config
;
1029 vdc
->get_features
= virtio_scsi_get_features
;
1030 vdc
->reset
= virtio_scsi_reset
;
1031 vdc
->start_ioeventfd
= virtio_scsi_dataplane_start
;
1032 vdc
->stop_ioeventfd
= virtio_scsi_dataplane_stop
;
1033 hc
->pre_plug
= virtio_scsi_pre_hotplug
;
1034 hc
->plug
= virtio_scsi_hotplug
;
1035 hc
->unplug
= virtio_scsi_hotunplug
;
1038 static const TypeInfo virtio_scsi_common_info
= {
1039 .name
= TYPE_VIRTIO_SCSI_COMMON
,
1040 .parent
= TYPE_VIRTIO_DEVICE
,
1041 .instance_size
= sizeof(VirtIOSCSICommon
),
1043 .class_init
= virtio_scsi_common_class_init
,
1046 static const TypeInfo virtio_scsi_info
= {
1047 .name
= TYPE_VIRTIO_SCSI
,
1048 .parent
= TYPE_VIRTIO_SCSI_COMMON
,
1049 .instance_size
= sizeof(VirtIOSCSI
),
1050 .class_init
= virtio_scsi_class_init
,
1051 .interfaces
= (InterfaceInfo
[]) {
1052 { TYPE_HOTPLUG_HANDLER
},
1057 static void virtio_register_types(void)
1059 type_register_static(&virtio_scsi_common_info
);
1060 type_register_static(&virtio_scsi_info
);
1063 type_init(virtio_register_types
)