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 "virtio-scsi.h"
18 #include <hw/scsi-defs.h>
20 #define VIRTIO_SCSI_VQ_SIZE 128
21 #define VIRTIO_SCSI_CDB_SIZE 32
22 #define VIRTIO_SCSI_SENSE_SIZE 96
23 #define VIRTIO_SCSI_MAX_CHANNEL 0
24 #define VIRTIO_SCSI_MAX_TARGET 255
25 #define VIRTIO_SCSI_MAX_LUN 16383
28 #define VIRTIO_SCSI_S_OK 0
29 #define VIRTIO_SCSI_S_OVERRUN 1
30 #define VIRTIO_SCSI_S_ABORTED 2
31 #define VIRTIO_SCSI_S_BAD_TARGET 3
32 #define VIRTIO_SCSI_S_RESET 4
33 #define VIRTIO_SCSI_S_BUSY 5
34 #define VIRTIO_SCSI_S_TRANSPORT_FAILURE 6
35 #define VIRTIO_SCSI_S_TARGET_FAILURE 7
36 #define VIRTIO_SCSI_S_NEXUS_FAILURE 8
37 #define VIRTIO_SCSI_S_FAILURE 9
38 #define VIRTIO_SCSI_S_FUNCTION_SUCCEEDED 10
39 #define VIRTIO_SCSI_S_FUNCTION_REJECTED 11
40 #define VIRTIO_SCSI_S_INCORRECT_LUN 12
42 /* Controlq type codes. */
43 #define VIRTIO_SCSI_T_TMF 0
44 #define VIRTIO_SCSI_T_AN_QUERY 1
45 #define VIRTIO_SCSI_T_AN_SUBSCRIBE 2
47 /* Valid TMF subtypes. */
48 #define VIRTIO_SCSI_T_TMF_ABORT_TASK 0
49 #define VIRTIO_SCSI_T_TMF_ABORT_TASK_SET 1
50 #define VIRTIO_SCSI_T_TMF_CLEAR_ACA 2
51 #define VIRTIO_SCSI_T_TMF_CLEAR_TASK_SET 3
52 #define VIRTIO_SCSI_T_TMF_I_T_NEXUS_RESET 4
53 #define VIRTIO_SCSI_T_TMF_LOGICAL_UNIT_RESET 5
54 #define VIRTIO_SCSI_T_TMF_QUERY_TASK 6
55 #define VIRTIO_SCSI_T_TMF_QUERY_TASK_SET 7
58 #define VIRTIO_SCSI_T_EVENTS_MISSED 0x80000000
59 #define VIRTIO_SCSI_T_NO_EVENT 0
60 #define VIRTIO_SCSI_T_TRANSPORT_RESET 1
61 #define VIRTIO_SCSI_T_ASYNC_NOTIFY 2
63 /* SCSI command request, followed by data-out */
65 uint8_t lun
[8]; /* Logical Unit Number */
66 uint64_t tag
; /* Command identifier */
67 uint8_t task_attr
; /* Task attribute */
71 } QEMU_PACKED VirtIOSCSICmdReq
;
73 /* Response, followed by sense data and data-in */
75 uint32_t sense_len
; /* Sense data length */
76 uint32_t resid
; /* Residual bytes in data buffer */
77 uint16_t status_qualifier
; /* Status qualifier */
78 uint8_t status
; /* Command completion status */
79 uint8_t response
; /* Response values */
81 } QEMU_PACKED VirtIOSCSICmdResp
;
83 /* Task Management Request */
89 } QEMU_PACKED VirtIOSCSICtrlTMFReq
;
93 } QEMU_PACKED VirtIOSCSICtrlTMFResp
;
95 /* Asynchronous notification query/subscription */
99 uint32_t event_requested
;
100 } QEMU_PACKED VirtIOSCSICtrlANReq
;
103 uint32_t event_actual
;
105 } QEMU_PACKED VirtIOSCSICtrlANResp
;
111 } QEMU_PACKED VirtIOSCSIEvent
;
116 uint32_t max_sectors
;
117 uint32_t cmd_per_lun
;
118 uint32_t event_info_size
;
121 uint16_t max_channel
;
124 } QEMU_PACKED VirtIOSCSIConfig
;
129 VirtIOSCSIConf
*conf
;
137 VirtQueue
*cmd_vqs
[0];
140 typedef struct VirtIOSCSIReq
{
143 VirtQueueElement elem
;
148 VirtIOSCSICmdReq
*cmd
;
149 VirtIOSCSICtrlTMFReq
*tmf
;
150 VirtIOSCSICtrlANReq
*an
;
154 VirtIOSCSICmdResp
*cmd
;
155 VirtIOSCSICtrlTMFResp
*tmf
;
156 VirtIOSCSICtrlANResp
*an
;
157 VirtIOSCSIEvent
*event
;
161 static inline int virtio_scsi_get_lun(uint8_t *lun
)
163 return ((lun
[2] << 8) | lun
[3]) & 0x3FFF;
166 static inline SCSIDevice
*virtio_scsi_device_find(VirtIOSCSI
*s
, uint8_t *lun
)
171 if (lun
[2] != 0 && !(lun
[2] >= 0x40 && lun
[2] < 0x80)) {
174 return scsi_device_find(&s
->bus
, 0, lun
[1], virtio_scsi_get_lun(lun
));
177 static void virtio_scsi_complete_req(VirtIOSCSIReq
*req
)
179 VirtIOSCSI
*s
= req
->dev
;
180 VirtQueue
*vq
= req
->vq
;
181 virtqueue_push(vq
, &req
->elem
, req
->qsgl
.size
+ req
->elem
.in_sg
[0].iov_len
);
182 qemu_sglist_destroy(&req
->qsgl
);
184 req
->sreq
->hba_private
= NULL
;
185 scsi_req_unref(req
->sreq
);
188 virtio_notify(&s
->vdev
, vq
);
191 static void virtio_scsi_bad_req(void)
193 error_report("wrong size for virtio-scsi headers");
197 static void qemu_sgl_init_external(QEMUSGList
*qsgl
, struct iovec
*sg
,
198 target_phys_addr_t
*addr
, int num
)
200 memset(qsgl
, 0, sizeof(*qsgl
));
202 qemu_sglist_add(qsgl
, *(addr
++), (sg
++)->iov_len
);
206 static void virtio_scsi_parse_req(VirtIOSCSI
*s
, VirtQueue
*vq
,
209 assert(req
->elem
.out_num
&& req
->elem
.in_num
);
213 req
->req
.buf
= req
->elem
.out_sg
[0].iov_base
;
214 req
->resp
.buf
= req
->elem
.in_sg
[0].iov_base
;
216 if (req
->elem
.out_num
> 1) {
217 qemu_sgl_init_external(&req
->qsgl
, &req
->elem
.out_sg
[1],
218 &req
->elem
.out_addr
[1],
219 req
->elem
.out_num
- 1);
221 qemu_sgl_init_external(&req
->qsgl
, &req
->elem
.in_sg
[1],
222 &req
->elem
.in_addr
[1],
223 req
->elem
.in_num
- 1);
227 static VirtIOSCSIReq
*virtio_scsi_pop_req(VirtIOSCSI
*s
, VirtQueue
*vq
)
230 req
= g_malloc(sizeof(*req
));
231 if (!virtqueue_pop(vq
, &req
->elem
)) {
236 virtio_scsi_parse_req(s
, vq
, req
);
240 static void virtio_scsi_save_request(QEMUFile
*f
, SCSIRequest
*sreq
)
242 VirtIOSCSIReq
*req
= sreq
->hba_private
;
243 uint32_t n
= virtio_queue_get_id(req
->vq
) - 2;
245 assert(n
< req
->dev
->conf
->num_queues
);
246 qemu_put_be32s(f
, &n
);
247 qemu_put_buffer(f
, (unsigned char *)&req
->elem
, sizeof(req
->elem
));
250 static void *virtio_scsi_load_request(QEMUFile
*f
, SCSIRequest
*sreq
)
252 SCSIBus
*bus
= sreq
->bus
;
253 VirtIOSCSI
*s
= container_of(bus
, VirtIOSCSI
, bus
);
257 req
= g_malloc(sizeof(*req
));
258 qemu_get_be32s(f
, &n
);
259 assert(n
< s
->conf
->num_queues
);
260 qemu_get_buffer(f
, (unsigned char *)&req
->elem
, sizeof(req
->elem
));
261 virtio_scsi_parse_req(s
, s
->cmd_vqs
[n
], req
);
265 if (req
->sreq
->cmd
.mode
!= SCSI_XFER_NONE
) {
267 (req
->elem
.in_num
> 1 ? SCSI_XFER_FROM_DEV
: SCSI_XFER_TO_DEV
);
269 assert(req
->sreq
->cmd
.mode
== req_mode
);
274 static void virtio_scsi_do_tmf(VirtIOSCSI
*s
, VirtIOSCSIReq
*req
)
276 SCSIDevice
*d
= virtio_scsi_device_find(s
, req
->req
.tmf
->lun
);
277 SCSIRequest
*r
, *next
;
281 /* Here VIRTIO_SCSI_S_OK means "FUNCTION COMPLETE". */
282 req
->resp
.tmf
->response
= VIRTIO_SCSI_S_OK
;
284 switch (req
->req
.tmf
->subtype
) {
285 case VIRTIO_SCSI_T_TMF_ABORT_TASK
:
286 case VIRTIO_SCSI_T_TMF_QUERY_TASK
:
290 if (d
->lun
!= virtio_scsi_get_lun(req
->req
.tmf
->lun
)) {
293 QTAILQ_FOREACH_SAFE(r
, &d
->requests
, next
, next
) {
294 if (r
->tag
== req
->req
.tmf
->tag
) {
298 if (r
&& r
->hba_private
) {
299 if (req
->req
.tmf
->subtype
== VIRTIO_SCSI_T_TMF_QUERY_TASK
) {
300 /* "If the specified command is present in the task set, then
301 * return a service response set to FUNCTION SUCCEEDED".
303 req
->resp
.tmf
->response
= VIRTIO_SCSI_S_FUNCTION_SUCCEEDED
;
310 case VIRTIO_SCSI_T_TMF_LOGICAL_UNIT_RESET
:
314 if (d
->lun
!= virtio_scsi_get_lun(req
->req
.tmf
->lun
)) {
318 qdev_reset_all(&d
->qdev
);
322 case VIRTIO_SCSI_T_TMF_ABORT_TASK_SET
:
323 case VIRTIO_SCSI_T_TMF_CLEAR_TASK_SET
:
324 case VIRTIO_SCSI_T_TMF_QUERY_TASK_SET
:
328 if (d
->lun
!= virtio_scsi_get_lun(req
->req
.tmf
->lun
)) {
331 QTAILQ_FOREACH_SAFE(r
, &d
->requests
, next
, next
) {
332 if (r
->hba_private
) {
333 if (req
->req
.tmf
->subtype
== VIRTIO_SCSI_T_TMF_QUERY_TASK_SET
) {
334 /* "If there is any command present in the task set, then
335 * return a service response set to FUNCTION SUCCEEDED".
337 req
->resp
.tmf
->response
= VIRTIO_SCSI_S_FUNCTION_SUCCEEDED
;
346 case VIRTIO_SCSI_T_TMF_I_T_NEXUS_RESET
:
347 target
= req
->req
.tmf
->lun
[1];
349 QTAILQ_FOREACH(kid
, &s
->bus
.qbus
.children
, sibling
) {
350 d
= DO_UPCAST(SCSIDevice
, qdev
, kid
->child
);
351 if (d
->channel
== 0 && d
->id
== target
) {
352 qdev_reset_all(&d
->qdev
);
358 case VIRTIO_SCSI_T_TMF_CLEAR_ACA
:
360 req
->resp
.tmf
->response
= VIRTIO_SCSI_S_FUNCTION_REJECTED
;
367 req
->resp
.tmf
->response
= VIRTIO_SCSI_S_INCORRECT_LUN
;
371 req
->resp
.tmf
->response
= VIRTIO_SCSI_S_BAD_TARGET
;
374 static void virtio_scsi_handle_ctrl(VirtIODevice
*vdev
, VirtQueue
*vq
)
376 VirtIOSCSI
*s
= (VirtIOSCSI
*)vdev
;
379 while ((req
= virtio_scsi_pop_req(s
, vq
))) {
380 int out_size
, in_size
;
381 if (req
->elem
.out_num
< 1 || req
->elem
.in_num
< 1) {
382 virtio_scsi_bad_req();
386 out_size
= req
->elem
.out_sg
[0].iov_len
;
387 in_size
= req
->elem
.in_sg
[0].iov_len
;
388 if (req
->req
.tmf
->type
== VIRTIO_SCSI_T_TMF
) {
389 if (out_size
< sizeof(VirtIOSCSICtrlTMFReq
) ||
390 in_size
< sizeof(VirtIOSCSICtrlTMFResp
)) {
391 virtio_scsi_bad_req();
393 virtio_scsi_do_tmf(s
, req
);
395 } else if (req
->req
.tmf
->type
== VIRTIO_SCSI_T_AN_QUERY
||
396 req
->req
.tmf
->type
== VIRTIO_SCSI_T_AN_SUBSCRIBE
) {
397 if (out_size
< sizeof(VirtIOSCSICtrlANReq
) ||
398 in_size
< sizeof(VirtIOSCSICtrlANResp
)) {
399 virtio_scsi_bad_req();
401 req
->resp
.an
->event_actual
= 0;
402 req
->resp
.an
->response
= VIRTIO_SCSI_S_OK
;
404 virtio_scsi_complete_req(req
);
408 static void virtio_scsi_handle_event(VirtIODevice
*vdev
, VirtQueue
*vq
)
412 static void virtio_scsi_command_complete(SCSIRequest
*r
, uint32_t status
,
415 VirtIOSCSIReq
*req
= r
->hba_private
;
417 req
->resp
.cmd
->response
= VIRTIO_SCSI_S_OK
;
418 req
->resp
.cmd
->status
= status
;
419 if (req
->resp
.cmd
->status
== GOOD
) {
420 req
->resp
.cmd
->resid
= resid
;
422 req
->resp
.cmd
->resid
= 0;
423 req
->resp
.cmd
->sense_len
=
424 scsi_req_get_sense(r
, req
->resp
.cmd
->sense
, VIRTIO_SCSI_SENSE_SIZE
);
426 virtio_scsi_complete_req(req
);
429 static QEMUSGList
*virtio_scsi_get_sg_list(SCSIRequest
*r
)
431 VirtIOSCSIReq
*req
= r
->hba_private
;
436 static void virtio_scsi_request_cancelled(SCSIRequest
*r
)
438 VirtIOSCSIReq
*req
= r
->hba_private
;
443 if (req
->dev
->resetting
) {
444 req
->resp
.cmd
->response
= VIRTIO_SCSI_S_RESET
;
446 req
->resp
.cmd
->response
= VIRTIO_SCSI_S_ABORTED
;
448 virtio_scsi_complete_req(req
);
451 static void virtio_scsi_fail_cmd_req(VirtIOSCSIReq
*req
)
453 req
->resp
.cmd
->response
= VIRTIO_SCSI_S_FAILURE
;
454 virtio_scsi_complete_req(req
);
457 static void virtio_scsi_handle_cmd(VirtIODevice
*vdev
, VirtQueue
*vq
)
459 VirtIOSCSI
*s
= (VirtIOSCSI
*)vdev
;
463 while ((req
= virtio_scsi_pop_req(s
, vq
))) {
465 int out_size
, in_size
;
466 if (req
->elem
.out_num
< 1 || req
->elem
.in_num
< 1) {
467 virtio_scsi_bad_req();
470 out_size
= req
->elem
.out_sg
[0].iov_len
;
471 in_size
= req
->elem
.in_sg
[0].iov_len
;
472 if (out_size
< sizeof(VirtIOSCSICmdReq
) + s
->cdb_size
||
473 in_size
< sizeof(VirtIOSCSICmdResp
) + s
->sense_size
) {
474 virtio_scsi_bad_req();
477 if (req
->elem
.out_num
> 1 && req
->elem
.in_num
> 1) {
478 virtio_scsi_fail_cmd_req(req
);
482 d
= virtio_scsi_device_find(s
, req
->req
.cmd
->lun
);
484 req
->resp
.cmd
->response
= VIRTIO_SCSI_S_BAD_TARGET
;
485 virtio_scsi_complete_req(req
);
488 req
->sreq
= scsi_req_new(d
, req
->req
.cmd
->tag
,
489 virtio_scsi_get_lun(req
->req
.cmd
->lun
),
490 req
->req
.cmd
->cdb
, req
);
492 if (req
->sreq
->cmd
.mode
!= SCSI_XFER_NONE
) {
494 (req
->elem
.in_num
> 1 ? SCSI_XFER_FROM_DEV
: SCSI_XFER_TO_DEV
);
496 if (req
->sreq
->cmd
.mode
!= req_mode
||
497 req
->sreq
->cmd
.xfer
> req
->qsgl
.size
) {
498 req
->resp
.cmd
->response
= VIRTIO_SCSI_S_OVERRUN
;
499 virtio_scsi_complete_req(req
);
504 n
= scsi_req_enqueue(req
->sreq
);
506 scsi_req_continue(req
->sreq
);
511 static void virtio_scsi_get_config(VirtIODevice
*vdev
,
514 VirtIOSCSIConfig
*scsiconf
= (VirtIOSCSIConfig
*)config
;
515 VirtIOSCSI
*s
= (VirtIOSCSI
*)vdev
;
517 stl_raw(&scsiconf
->num_queues
, s
->conf
->num_queues
);
518 stl_raw(&scsiconf
->seg_max
, 128 - 2);
519 stl_raw(&scsiconf
->max_sectors
, s
->conf
->max_sectors
);
520 stl_raw(&scsiconf
->cmd_per_lun
, s
->conf
->cmd_per_lun
);
521 stl_raw(&scsiconf
->event_info_size
, sizeof(VirtIOSCSIEvent
));
522 stl_raw(&scsiconf
->sense_size
, s
->sense_size
);
523 stl_raw(&scsiconf
->cdb_size
, s
->cdb_size
);
524 stl_raw(&scsiconf
->max_channel
, VIRTIO_SCSI_MAX_CHANNEL
);
525 stl_raw(&scsiconf
->max_target
, VIRTIO_SCSI_MAX_TARGET
);
526 stl_raw(&scsiconf
->max_lun
, VIRTIO_SCSI_MAX_LUN
);
529 static void virtio_scsi_set_config(VirtIODevice
*vdev
,
530 const uint8_t *config
)
532 VirtIOSCSIConfig
*scsiconf
= (VirtIOSCSIConfig
*)config
;
533 VirtIOSCSI
*s
= (VirtIOSCSI
*)vdev
;
535 if ((uint32_t) ldl_raw(&scsiconf
->sense_size
) >= 65536 ||
536 (uint32_t) ldl_raw(&scsiconf
->cdb_size
) >= 256) {
537 error_report("bad data written to virtio-scsi configuration space");
541 s
->sense_size
= ldl_raw(&scsiconf
->sense_size
);
542 s
->cdb_size
= ldl_raw(&scsiconf
->cdb_size
);
545 static uint32_t virtio_scsi_get_features(VirtIODevice
*vdev
,
546 uint32_t requested_features
)
548 return requested_features
;
551 static void virtio_scsi_reset(VirtIODevice
*vdev
)
553 VirtIOSCSI
*s
= (VirtIOSCSI
*)vdev
;
555 s
->sense_size
= VIRTIO_SCSI_SENSE_SIZE
;
556 s
->cdb_size
= VIRTIO_SCSI_CDB_SIZE
;
559 /* The device does not have anything to save beyond the virtio data.
560 * Request data is saved with callbacks from SCSI devices.
562 static void virtio_scsi_save(QEMUFile
*f
, void *opaque
)
564 VirtIOSCSI
*s
= opaque
;
565 virtio_save(&s
->vdev
, f
);
568 static int virtio_scsi_load(QEMUFile
*f
, void *opaque
, int version_id
)
570 VirtIOSCSI
*s
= opaque
;
573 ret
= virtio_load(&s
->vdev
, f
);
580 static struct SCSIBusInfo virtio_scsi_scsi_info
= {
582 .max_channel
= VIRTIO_SCSI_MAX_CHANNEL
,
583 .max_target
= VIRTIO_SCSI_MAX_TARGET
,
584 .max_lun
= VIRTIO_SCSI_MAX_LUN
,
586 .complete
= virtio_scsi_command_complete
,
587 .cancel
= virtio_scsi_request_cancelled
,
588 .get_sg_list
= virtio_scsi_get_sg_list
,
589 .save_request
= virtio_scsi_save_request
,
590 .load_request
= virtio_scsi_load_request
,
593 VirtIODevice
*virtio_scsi_init(DeviceState
*dev
, VirtIOSCSIConf
*proxyconf
)
596 static int virtio_scsi_id
;
600 sz
= sizeof(VirtIOSCSI
) + proxyconf
->num_queues
* sizeof(VirtQueue
*);
601 s
= (VirtIOSCSI
*)virtio_common_init("virtio-scsi", VIRTIO_ID_SCSI
,
602 sizeof(VirtIOSCSIConfig
), sz
);
607 /* TODO set up vdev function pointers */
608 s
->vdev
.get_config
= virtio_scsi_get_config
;
609 s
->vdev
.set_config
= virtio_scsi_set_config
;
610 s
->vdev
.get_features
= virtio_scsi_get_features
;
611 s
->vdev
.reset
= virtio_scsi_reset
;
613 s
->ctrl_vq
= virtio_add_queue(&s
->vdev
, VIRTIO_SCSI_VQ_SIZE
,
614 virtio_scsi_handle_ctrl
);
615 s
->event_vq
= virtio_add_queue(&s
->vdev
, VIRTIO_SCSI_VQ_SIZE
,
616 virtio_scsi_handle_event
);
617 for (i
= 0; i
< s
->conf
->num_queues
; i
++) {
618 s
->cmd_vqs
[i
] = virtio_add_queue(&s
->vdev
, VIRTIO_SCSI_VQ_SIZE
,
619 virtio_scsi_handle_cmd
);
622 scsi_bus_new(&s
->bus
, dev
, &virtio_scsi_scsi_info
);
623 if (!dev
->hotplugged
) {
624 scsi_bus_legacy_handle_cmdline(&s
->bus
);
627 register_savevm(dev
, "virtio-scsi", virtio_scsi_id
++, 1,
628 virtio_scsi_save
, virtio_scsi_load
, s
);
633 void virtio_scsi_exit(VirtIODevice
*vdev
)
635 VirtIOSCSI
*s
= (VirtIOSCSI
*)vdev
;
636 unregister_savevm(s
->qdev
, "virtio-scsi", s
);
637 virtio_cleanup(vdev
);