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_dummy_handle_output(VirtIODevice *vdev, VirtQueue *vq) 66 { 67 } 68 69 static void vhost_user_scsi_realize(DeviceState *dev, Error **errp) 70 { 71 VirtIOSCSICommon *vs = VIRTIO_SCSI_COMMON(dev); 72 VHostUserSCSI *s = VHOST_USER_SCSI(dev); 73 VHostSCSICommon *vsc = VHOST_SCSI_COMMON(s); 74 struct vhost_virtqueue *vqs = NULL; 75 Error *err = NULL; 76 int ret; 77 78 if (!vs->conf.chardev.chr) { 79 error_setg(errp, "vhost-user-scsi: missing chardev"); 80 return; 81 } 82 83 virtio_scsi_common_realize(dev, vhost_dummy_handle_output, 84 vhost_dummy_handle_output, 85 vhost_dummy_handle_output, &err); 86 if (err != NULL) { 87 error_propagate(errp, err); 88 return; 89 } 90 91 if (!vhost_user_init(&s->vhost_user, &vs->conf.chardev, errp)) { 92 goto free_virtio; 93 } 94 95 vsc->dev.nvqs = VIRTIO_SCSI_VQ_NUM_FIXED + vs->conf.num_queues; 96 vsc->dev.vqs = g_new0(struct vhost_virtqueue, vsc->dev.nvqs); 97 vsc->dev.vq_index = 0; 98 vsc->dev.backend_features = 0; 99 vqs = vsc->dev.vqs; 100 101 ret = vhost_dev_init(&vsc->dev, &s->vhost_user, 102 VHOST_BACKEND_TYPE_USER, 0, errp); 103 if (ret < 0) { 104 goto free_vhost; 105 } 106 107 /* Channel and lun both are 0 for bootable vhost-user-scsi disk */ 108 vsc->channel = 0; 109 vsc->lun = 0; 110 vsc->target = vs->conf.boot_tpgt; 111 112 return; 113 114 free_vhost: 115 vhost_user_cleanup(&s->vhost_user); 116 g_free(vqs); 117 free_virtio: 118 virtio_scsi_common_unrealize(dev); 119 } 120 121 static void vhost_user_scsi_unrealize(DeviceState *dev) 122 { 123 VirtIODevice *vdev = VIRTIO_DEVICE(dev); 124 VHostUserSCSI *s = VHOST_USER_SCSI(dev); 125 VHostSCSICommon *vsc = VHOST_SCSI_COMMON(s); 126 struct vhost_virtqueue *vqs = vsc->dev.vqs; 127 128 /* This will stop the vhost backend. */ 129 vhost_user_scsi_set_status(vdev, 0); 130 131 vhost_dev_cleanup(&vsc->dev); 132 g_free(vqs); 133 134 virtio_scsi_common_unrealize(dev); 135 vhost_user_cleanup(&s->vhost_user); 136 } 137 138 static Property vhost_user_scsi_properties[] = { 139 DEFINE_PROP_CHR("chardev", VirtIOSCSICommon, conf.chardev), 140 DEFINE_PROP_UINT32("boot_tpgt", VirtIOSCSICommon, conf.boot_tpgt, 0), 141 DEFINE_PROP_UINT32("num_queues", VirtIOSCSICommon, conf.num_queues, 142 VIRTIO_SCSI_AUTO_NUM_QUEUES), 143 DEFINE_PROP_UINT32("virtqueue_size", VirtIOSCSICommon, conf.virtqueue_size, 144 128), 145 DEFINE_PROP_UINT32("max_sectors", VirtIOSCSICommon, conf.max_sectors, 146 0xFFFF), 147 DEFINE_PROP_UINT32("cmd_per_lun", VirtIOSCSICommon, conf.cmd_per_lun, 128), 148 DEFINE_PROP_BIT64("hotplug", VHostSCSICommon, host_features, 149 VIRTIO_SCSI_F_HOTPLUG, 150 true), 151 DEFINE_PROP_BIT64("param_change", VHostSCSICommon, host_features, 152 VIRTIO_SCSI_F_CHANGE, 153 true), 154 DEFINE_PROP_BIT64("t10_pi", VHostSCSICommon, host_features, 155 VIRTIO_SCSI_F_T10_PI, 156 false), 157 DEFINE_PROP_END_OF_LIST(), 158 }; 159 160 static const VMStateDescription vmstate_vhost_scsi = { 161 .name = "virtio-scsi", 162 .minimum_version_id = 1, 163 .version_id = 1, 164 .fields = (VMStateField[]) { 165 VMSTATE_VIRTIO_DEVICE, 166 VMSTATE_END_OF_LIST() 167 }, 168 }; 169 170 static void vhost_user_scsi_class_init(ObjectClass *klass, void *data) 171 { 172 DeviceClass *dc = DEVICE_CLASS(klass); 173 VirtioDeviceClass *vdc = VIRTIO_DEVICE_CLASS(klass); 174 FWPathProviderClass *fwc = FW_PATH_PROVIDER_CLASS(klass); 175 176 device_class_set_props(dc, vhost_user_scsi_properties); 177 dc->vmsd = &vmstate_vhost_scsi; 178 set_bit(DEVICE_CATEGORY_STORAGE, dc->categories); 179 vdc->realize = vhost_user_scsi_realize; 180 vdc->unrealize = vhost_user_scsi_unrealize; 181 vdc->get_features = vhost_scsi_common_get_features; 182 vdc->set_config = vhost_scsi_common_set_config; 183 vdc->set_status = vhost_user_scsi_set_status; 184 fwc->get_dev_path = vhost_scsi_common_get_fw_dev_path; 185 } 186 187 static void vhost_user_scsi_instance_init(Object *obj) 188 { 189 VHostSCSICommon *vsc = VHOST_SCSI_COMMON(obj); 190 191 vsc->feature_bits = user_feature_bits; 192 193 /* Add the bootindex property for this object */ 194 device_add_bootindex_property(obj, &vsc->bootindex, "bootindex", NULL, 195 DEVICE(vsc)); 196 } 197 198 static const TypeInfo vhost_user_scsi_info = { 199 .name = TYPE_VHOST_USER_SCSI, 200 .parent = TYPE_VHOST_SCSI_COMMON, 201 .instance_size = sizeof(VHostUserSCSI), 202 .class_init = vhost_user_scsi_class_init, 203 .instance_init = vhost_user_scsi_instance_init, 204 .interfaces = (InterfaceInfo[]) { 205 { TYPE_FW_PATH_PROVIDER }, 206 { } 207 }, 208 }; 209 210 static void virtio_register_types(void) 211 { 212 type_register_static(&vhost_user_scsi_info); 213 } 214 215 type_init(virtio_register_types) 216