include/hw/virtio/virtio-scsi.h

   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 "chardev/char-fe.h"
  25 #include "sysemu/iothread.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_MAX_CHANNEL 0
  36 #define VIRTIO_SCSI_MAX_TARGET  255
  37 #define VIRTIO_SCSI_MAX_LUN     16383
  38
  39 /* Number of virtqueues that are always present */
  40 #define VIRTIO_SCSI_VQ_NUM_FIXED    2
  41
  42 typedef struct virtio_scsi_cmd_req VirtIOSCSICmdReq;
  43 typedef struct virtio_scsi_cmd_resp VirtIOSCSICmdResp;
  44 typedef struct virtio_scsi_ctrl_tmf_req VirtIOSCSICtrlTMFReq;
  45 typedef struct virtio_scsi_ctrl_tmf_resp VirtIOSCSICtrlTMFResp;
  46 typedef struct virtio_scsi_ctrl_an_req VirtIOSCSICtrlANReq;
  47 typedef struct virtio_scsi_ctrl_an_resp VirtIOSCSICtrlANResp;
  48 typedef struct virtio_scsi_event VirtIOSCSIEvent;
  49 typedef struct virtio_scsi_config VirtIOSCSIConfig;
  50
  51 struct VirtIOSCSIConf {
  52     uint32_t num_queues;
  53     uint32_t virtqueue_size;
  54     bool seg_max_adjust;
  55     uint32_t max_sectors;
  56     uint32_t cmd_per_lun;
  57 #ifdef CONFIG_VHOST_SCSI
  58     char *vhostfd;
  59     char *wwpn;
  60 #endif
  61     CharBackend chardev;
  62     uint32_t boot_tpgt;
  63     IOThread *iothread;
  64 };
  65
  66 struct VirtIOSCSI;
  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 VirtIOSCSI {
  80     VirtIOSCSICommon parent_obj;
  81
  82     SCSIBus bus;
  83     int resetting;
  84     bool events_dropped;
  85
  86     /* Fields for dataplane below */
  87     AioContext *ctx; /* one iothread per virtio-scsi-pci for now */
  88
  89     bool dataplane_started;
  90     bool dataplane_starting;
  91     bool dataplane_stopping;
  92     bool dataplane_fenced;
  93     uint32_t host_features;
  94 } VirtIOSCSI;
  95
  96 typedef struct VirtIOSCSIReq {
  97     /* Note:
  98      * - fields up to resp_iov are initialized by virtio_scsi_init_req;
  99      * - fields starting at vring are zeroed by virtio_scsi_init_req.
 100      * */
 101     VirtQueueElement elem;
 102
 103     VirtIOSCSI *dev;
 104     VirtQueue *vq;
 105     QEMUSGList qsgl;
 106     QEMUIOVector resp_iov;
 107
 108     union {
 109         /* Used for two-stage request submission */
 110         QTAILQ_ENTRY(VirtIOSCSIReq) next;
 111
 112         /* Used for cancellation of request during TMFs */
 113         int remaining;
 114     };
 115
 116     SCSIRequest *sreq;
 117     size_t resp_size;
 118     enum SCSIXferMode mode;
 119     union {
 120         VirtIOSCSICmdResp     cmd;
 121         VirtIOSCSICtrlTMFResp tmf;
 122         VirtIOSCSICtrlANResp  an;
 123         VirtIOSCSIEvent       event;
 124     } resp;
 125     union {
 126         VirtIOSCSICmdReq      cmd;
 127         VirtIOSCSICtrlTMFReq  tmf;
 128         VirtIOSCSICtrlANReq   an;
 129     } req;
 130 } VirtIOSCSIReq;
 131
 132 static inline void virtio_scsi_acquire(VirtIOSCSI *s)
 133 {
 134     if (s->ctx) {
 135         aio_context_acquire(s->ctx);
 136     }
 137 }
 138
 139 static inline void virtio_scsi_release(VirtIOSCSI *s)
 140 {
 141     if (s->ctx) {
 142         aio_context_release(s->ctx);
 143     }
 144 }
 145
 146 void virtio_scsi_common_realize(DeviceState *dev,
 147                                 VirtIOHandleOutput ctrl,
 148                                 VirtIOHandleOutput evt,
 149                                 VirtIOHandleOutput cmd,
 150                                 Error **errp);
 151
 152 void virtio_scsi_common_unrealize(DeviceState *dev);
 153 bool virtio_scsi_handle_event_vq(VirtIOSCSI *s, VirtQueue *vq);
 154 bool virtio_scsi_handle_cmd_vq(VirtIOSCSI *s, VirtQueue *vq);
 155 bool virtio_scsi_handle_ctrl_vq(VirtIOSCSI *s, VirtQueue *vq);
 156 void virtio_scsi_init_req(VirtIOSCSI *s, VirtQueue *vq, VirtIOSCSIReq *req);
 157 void virtio_scsi_free_req(VirtIOSCSIReq *req);
 158 void virtio_scsi_push_event(VirtIOSCSI *s, SCSIDevice *dev,
 159                             uint32_t event, uint32_t reason);
 160
 161 void virtio_scsi_dataplane_setup(VirtIOSCSI *s, Error **errp);
 162 int virtio_scsi_dataplane_start(VirtIODevice *s);
 163 void virtio_scsi_dataplane_stop(VirtIODevice *s);
 164
 165 #endif /* QEMU_VIRTIO_SCSI_H */