1 /* 2 * Virtio SCSI HBA 3 * 4 * Copyright IBM, Corp. 2010 5 * 6 * Authors: 7 * Stefan Hajnoczi <stefanha@linux.vnet.ibm.com> 8 * 9 * This work is licensed under the terms of the GNU GPL, version 2. See 10 * the COPYING file in the top-level directory. 11 * 12 */ 13 14 #ifndef _QEMU_VIRTIO_SCSI_H 15 #define _QEMU_VIRTIO_SCSI_H 16 17 /* Override CDB/sense data size: they are dynamic (guest controlled) in QEMU */ 18 #define VIRTIO_SCSI_CDB_SIZE 0 19 #define VIRTIO_SCSI_SENSE_SIZE 0 20 #include "standard-headers/linux/virtio_scsi.h" 21 #include "hw/virtio/virtio.h" 22 #include "hw/pci/pci.h" 23 #include "hw/scsi/scsi.h" 24 #include "sysemu/iothread.h" 25 #include "hw/virtio/dataplane/vring.h" 26 27 #define TYPE_VIRTIO_SCSI_COMMON "virtio-scsi-common" 28 #define VIRTIO_SCSI_COMMON(obj) \ 29 OBJECT_CHECK(VirtIOSCSICommon, (obj), TYPE_VIRTIO_SCSI_COMMON) 30 31 #define TYPE_VIRTIO_SCSI "virtio-scsi-device" 32 #define VIRTIO_SCSI(obj) \ 33 OBJECT_CHECK(VirtIOSCSI, (obj), TYPE_VIRTIO_SCSI) 34 35 #define VIRTIO_SCSI_VQ_SIZE 128 36 #define VIRTIO_SCSI_MAX_CHANNEL 0 37 #define VIRTIO_SCSI_MAX_TARGET 255 38 #define VIRTIO_SCSI_MAX_LUN 16383 39 40 typedef struct virtio_scsi_cmd_req VirtIOSCSICmdReq; 41 typedef struct virtio_scsi_cmd_resp VirtIOSCSICmdResp; 42 typedef struct virtio_scsi_ctrl_tmf_req VirtIOSCSICtrlTMFReq; 43 typedef struct virtio_scsi_ctrl_tmf_resp VirtIOSCSICtrlTMFResp; 44 typedef struct virtio_scsi_ctrl_an_req VirtIOSCSICtrlANReq; 45 typedef struct virtio_scsi_ctrl_an_resp VirtIOSCSICtrlANResp; 46 typedef struct virtio_scsi_event VirtIOSCSIEvent; 47 typedef struct virtio_scsi_config VirtIOSCSIConfig; 48 49 struct VirtIOSCSIConf { 50 uint32_t num_queues; 51 uint32_t max_sectors; 52 uint32_t cmd_per_lun; 53 char *vhostfd; 54 char *wwpn; 55 uint32_t boot_tpgt; 56 IOThread *iothread; 57 }; 58 59 struct VirtIOSCSI; 60 61 typedef struct { 62 struct VirtIOSCSI *parent; 63 Vring vring; 64 EventNotifier host_notifier; 65 EventNotifier guest_notifier; 66 } VirtIOSCSIVring; 67 68 typedef struct VirtIOSCSICommon { 69 VirtIODevice parent_obj; 70 VirtIOSCSIConf conf; 71 72 uint32_t sense_size; 73 uint32_t cdb_size; 74 VirtQueue *ctrl_vq; 75 VirtQueue *event_vq; 76 VirtQueue **cmd_vqs; 77 } VirtIOSCSICommon; 78 79 typedef struct VirtIOSCSIBlkChangeNotifier { 80 Notifier n; 81 struct VirtIOSCSI *s; 82 SCSIDevice *sd; 83 QTAILQ_ENTRY(VirtIOSCSIBlkChangeNotifier) next; 84 } VirtIOSCSIBlkChangeNotifier; 85 86 typedef struct VirtIOSCSI { 87 VirtIOSCSICommon parent_obj; 88 89 SCSIBus bus; 90 int resetting; 91 bool events_dropped; 92 93 /* Fields for dataplane below */ 94 AioContext *ctx; /* one iothread per virtio-scsi-pci for now */ 95 96 QTAILQ_HEAD(, VirtIOSCSIBlkChangeNotifier) insert_notifiers; 97 QTAILQ_HEAD(, VirtIOSCSIBlkChangeNotifier) remove_notifiers; 98 99 /* Vring is used instead of vq in dataplane code, because of the underlying 100 * memory layer thread safety */ 101 VirtIOSCSIVring *ctrl_vring; 102 VirtIOSCSIVring *event_vring; 103 VirtIOSCSIVring **cmd_vrings; 104 bool dataplane_started; 105 bool dataplane_starting; 106 bool dataplane_stopping; 107 bool dataplane_disabled; 108 bool dataplane_fenced; 109 Error *blocker; 110 Notifier migration_state_notifier; 111 uint32_t host_features; 112 } VirtIOSCSI; 113 114 typedef struct VirtIOSCSIReq { 115 /* Note: 116 * - fields up to resp_iov are initialized by virtio_scsi_init_req; 117 * - fields starting at vring are zeroed by virtio_scsi_init_req. 118 * */ 119 VirtQueueElement elem; 120 121 VirtIOSCSI *dev; 122 VirtQueue *vq; 123 QEMUSGList qsgl; 124 QEMUIOVector resp_iov; 125 126 /* Set by dataplane code. */ 127 VirtIOSCSIVring *vring; 128 129 union { 130 /* Used for two-stage request submission */ 131 QTAILQ_ENTRY(VirtIOSCSIReq) next; 132 133 /* Used for cancellation of request during TMFs */ 134 int remaining; 135 }; 136 137 SCSIRequest *sreq; 138 size_t resp_size; 139 enum SCSIXferMode mode; 140 union { 141 VirtIOSCSICmdResp cmd; 142 VirtIOSCSICtrlTMFResp tmf; 143 VirtIOSCSICtrlANResp an; 144 VirtIOSCSIEvent event; 145 } resp; 146 union { 147 VirtIOSCSICmdReq cmd; 148 VirtIOSCSICtrlTMFReq tmf; 149 VirtIOSCSICtrlANReq an; 150 } req; 151 } VirtIOSCSIReq; 152 153 typedef void (*HandleOutput)(VirtIODevice *, VirtQueue *); 154 155 void virtio_scsi_common_realize(DeviceState *dev, Error **errp, 156 HandleOutput ctrl, HandleOutput evt, 157 HandleOutput cmd); 158 159 void virtio_scsi_common_unrealize(DeviceState *dev, Error **errp); 160 void virtio_scsi_handle_ctrl_req(VirtIOSCSI *s, VirtIOSCSIReq *req); 161 bool virtio_scsi_handle_cmd_req_prepare(VirtIOSCSI *s, VirtIOSCSIReq *req); 162 void virtio_scsi_handle_cmd_req_submit(VirtIOSCSI *s, VirtIOSCSIReq *req); 163 void virtio_scsi_init_req(VirtIOSCSI *s, VirtQueue *vq, VirtIOSCSIReq *req); 164 void virtio_scsi_free_req(VirtIOSCSIReq *req); 165 void virtio_scsi_push_event(VirtIOSCSI *s, SCSIDevice *dev, 166 uint32_t event, uint32_t reason); 167 168 void virtio_scsi_set_iothread(VirtIOSCSI *s, IOThread *iothread); 169 void virtio_scsi_dataplane_start(VirtIOSCSI *s); 170 void virtio_scsi_dataplane_stop(VirtIOSCSI *s); 171 void virtio_scsi_vring_push_notify(VirtIOSCSIReq *req); 172 VirtIOSCSIReq *virtio_scsi_pop_req_vring(VirtIOSCSI *s, 173 VirtIOSCSIVring *vring); 174 175 #endif /* _QEMU_VIRTIO_SCSI_H */ 176