1 /* 2 * vhost-user-scsi host device 3 * 4 * Copyright (c) 2016 Nutanix Inc. All rights reserved. 5 * 6 * Author: 7 * Felipe Franciosi <felipe@nutanix.com> 8 * 9 * This work is largely based on the "vhost-scsi" implementation by: 10 * Stefan Hajnoczi <stefanha@linux.vnet.ibm.com> 11 * Nicholas Bellinger <nab@risingtidesystems.com> 12 * 13 * This work is licensed under the terms of the GNU LGPL, version 2 or later. 14 * See the COPYING.LIB file in the top-level directory. 15 * 16 */ 17 18 #include "qemu/osdep.h" 19 #include "qapi/error.h" 20 #include "qemu/error-report.h" 21 #include "hw/fw-path-provider.h" 22 #include "hw/qdev-core.h" 23 #include "hw/qdev-properties.h" 24 #include "hw/qdev-properties-system.h" 25 #include "hw/virtio/vhost.h" 26 #include "hw/virtio/vhost-backend.h" 27 #include "hw/virtio/vhost-user-scsi.h" 28 #include "hw/virtio/virtio.h" 29 #include "chardev/char-fe.h" 30 #include "sysemu/sysemu.h" 31 32 /* Features supported by the host application */ 33 static const int user_feature_bits[] = { 34 VIRTIO_F_NOTIFY_ON_EMPTY, 35 VIRTIO_RING_F_INDIRECT_DESC, 36 VIRTIO_RING_F_EVENT_IDX, 37 VIRTIO_SCSI_F_HOTPLUG, 38 VIRTIO_F_RING_RESET, 39 VHOST_INVALID_FEATURE_BIT 40 }; 41 42 static void vhost_user_scsi_set_status(VirtIODevice *vdev, uint8_t status) 43 { 44 VHostUserSCSI *s = (VHostUserSCSI *)vdev; 45 VHostSCSICommon *vsc = VHOST_SCSI_COMMON(s); 46 bool start = (status & VIRTIO_CONFIG_S_DRIVER_OK) && vdev->vm_running; 47 48 if (vhost_dev_is_started(&vsc->dev) == start) { 49 return; 50 } 51 52 if (start) { 53 int ret; 54 55 ret = vhost_scsi_common_start(vsc); 56 if (ret < 0) { 57 error_report("unable to start vhost-user-scsi: %s", strerror(-ret)); 58 exit(1); 59 } 60 } else { 61 vhost_scsi_common_stop(vsc); 62 } 63 } 64 65 static void vhost_user_scsi_reset(VirtIODevice *vdev) 66 { 67 VHostSCSICommon *vsc = VHOST_SCSI_COMMON(vdev); 68 struct vhost_dev *dev = &vsc->dev; 69 70 if (dev->vhost_ops->vhost_reset_device) { 71 dev->vhost_ops->vhost_reset_device(dev); 72 } 73 } 74 75 static void vhost_dummy_handle_output(VirtIODevice *vdev, VirtQueue *vq) 76 { 77 } 78 79 static void vhost_user_scsi_realize(DeviceState *dev, Error **errp) 80 { 81 VirtIOSCSICommon *vs = VIRTIO_SCSI_COMMON(dev); 82 VHostUserSCSI *s = VHOST_USER_SCSI(dev); 83 VHostSCSICommon *vsc = VHOST_SCSI_COMMON(s); 84 struct vhost_virtqueue *vqs = NULL; 85 Error *err = NULL; 86 int ret; 87 88 if (!vs->conf.chardev.chr) { 89 error_setg(errp, "vhost-user-scsi: missing chardev"); 90 return; 91 } 92 93 virtio_scsi_common_realize(dev, vhost_dummy_handle_output, 94 vhost_dummy_handle_output, 95 vhost_dummy_handle_output, &err); 96 if (err != NULL) { 97 error_propagate(errp, err); 98 return; 99 } 100 101 if (!vhost_user_init(&s->vhost_user, &vs->conf.chardev, errp)) { 102 goto free_virtio; 103 } 104 105 vsc->dev.nvqs = VIRTIO_SCSI_VQ_NUM_FIXED + vs->conf.num_queues; 106 vsc->dev.vqs = g_new0(struct vhost_virtqueue, vsc->dev.nvqs); 107 vsc->dev.vq_index = 0; 108 vsc->dev.backend_features = 0; 109 vqs = vsc->dev.vqs; 110 111 ret = vhost_dev_init(&vsc->dev, &s->vhost_user, 112 VHOST_BACKEND_TYPE_USER, 0, errp); 113 if (ret < 0) { 114 goto free_vhost; 115 } 116 117 /* Channel and lun both are 0 for bootable vhost-user-scsi disk */ 118 vsc->channel = 0; 119 vsc->lun = 0; 120 vsc->target = vs->conf.boot_tpgt; 121 122 return; 123 124 free_vhost: 125 vhost_user_cleanup(&s->vhost_user); 126 g_free(vqs); 127 free_virtio: 128 virtio_scsi_common_unrealize(dev); 129 } 130 131 static void vhost_user_scsi_unrealize(DeviceState *dev) 132 { 133 VirtIODevice *vdev = VIRTIO_DEVICE(dev); 134 VHostUserSCSI *s = VHOST_USER_SCSI(dev); 135 VHostSCSICommon *vsc = VHOST_SCSI_COMMON(s); 136 struct vhost_virtqueue *vqs = vsc->dev.vqs; 137 138 /* This will stop the vhost backend. */ 139 vhost_user_scsi_set_status(vdev, 0); 140 141 vhost_dev_cleanup(&vsc->dev); 142 g_free(vqs); 143 144 virtio_scsi_common_unrealize(dev); 145 vhost_user_cleanup(&s->vhost_user); 146 } 147 148 static Property vhost_user_scsi_properties[] = { 149 DEFINE_PROP_CHR("chardev", VirtIOSCSICommon, conf.chardev), 150 DEFINE_PROP_UINT32("boot_tpgt", VirtIOSCSICommon, conf.boot_tpgt, 0), 151 DEFINE_PROP_UINT32("num_queues", VirtIOSCSICommon, conf.num_queues, 152 VIRTIO_SCSI_AUTO_NUM_QUEUES), 153 DEFINE_PROP_UINT32("virtqueue_size", VirtIOSCSICommon, conf.virtqueue_size, 154 128), 155 DEFINE_PROP_UINT32("max_sectors", VirtIOSCSICommon, conf.max_sectors, 156 0xFFFF), 157 DEFINE_PROP_UINT32("cmd_per_lun", VirtIOSCSICommon, conf.cmd_per_lun, 128), 158 DEFINE_PROP_BIT64("hotplug", VHostSCSICommon, host_features, 159 VIRTIO_SCSI_F_HOTPLUG, 160 true), 161 DEFINE_PROP_BIT64("param_change", VHostSCSICommon, host_features, 162 VIRTIO_SCSI_F_CHANGE, 163 true), 164 DEFINE_PROP_BIT64("t10_pi", VHostSCSICommon, host_features, 165 VIRTIO_SCSI_F_T10_PI, 166 false), 167 DEFINE_PROP_END_OF_LIST(), 168 }; 169 170 static const VMStateDescription vmstate_vhost_scsi = { 171 .name = "virtio-scsi", 172 .minimum_version_id = 1, 173 .version_id = 1, 174 .fields = (VMStateField[]) { 175 VMSTATE_VIRTIO_DEVICE, 176 VMSTATE_END_OF_LIST() 177 }, 178 }; 179 180 static void vhost_user_scsi_class_init(ObjectClass *klass, void *data) 181 { 182 DeviceClass *dc = DEVICE_CLASS(klass); 183 VirtioDeviceClass *vdc = VIRTIO_DEVICE_CLASS(klass); 184 FWPathProviderClass *fwc = FW_PATH_PROVIDER_CLASS(klass); 185 186 device_class_set_props(dc, vhost_user_scsi_properties); 187 dc->vmsd = &vmstate_vhost_scsi; 188 set_bit(DEVICE_CATEGORY_STORAGE, dc->categories); 189 vdc->realize = vhost_user_scsi_realize; 190 vdc->unrealize = vhost_user_scsi_unrealize; 191 vdc->get_features = vhost_scsi_common_get_features; 192 vdc->set_config = vhost_scsi_common_set_config; 193 vdc->set_status = vhost_user_scsi_set_status; 194 vdc->reset = vhost_user_scsi_reset; 195 fwc->get_dev_path = vhost_scsi_common_get_fw_dev_path; 196 } 197 198 static void vhost_user_scsi_instance_init(Object *obj) 199 { 200 VHostSCSICommon *vsc = VHOST_SCSI_COMMON(obj); 201 202 vsc->feature_bits = user_feature_bits; 203 204 /* Add the bootindex property for this object */ 205 device_add_bootindex_property(obj, &vsc->bootindex, "bootindex", NULL, 206 DEVICE(vsc)); 207 } 208 209 static const TypeInfo vhost_user_scsi_info = { 210 .name = TYPE_VHOST_USER_SCSI, 211 .parent = TYPE_VHOST_SCSI_COMMON, 212 .instance_size = sizeof(VHostUserSCSI), 213 .class_init = vhost_user_scsi_class_init, 214 .instance_init = vhost_user_scsi_instance_init, 215 .interfaces = (InterfaceInfo[]) { 216 { TYPE_FW_PATH_PROVIDER }, 217 { } 218 }, 219 }; 220 221 static void virtio_register_types(void) 222 { 223 type_register_static(&vhost_user_scsi_info); 224 } 225 226 type_init(virtio_register_types) 227