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 "qom/object.h" 22 #include "hw/fw-path-provider.h" 23 #include "hw/qdev-core.h" 24 #include "hw/qdev-properties.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 "hw/virtio/virtio-access.h" 30 #include "chardev/char-fe.h" 31 #include "sysemu/sysemu.h" 32 33 /* Features supported by the host application */ 34 static const int user_feature_bits[] = { 35 VIRTIO_F_NOTIFY_ON_EMPTY, 36 VIRTIO_RING_F_INDIRECT_DESC, 37 VIRTIO_RING_F_EVENT_IDX, 38 VIRTIO_SCSI_F_HOTPLUG, 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 (vsc->dev.started == 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 = 2 + 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); 103 if (ret < 0) { 104 error_setg(errp, "vhost-user-scsi: vhost initialization failed: %s", 105 strerror(-ret)); 106 goto free_vhost; 107 } 108 109 /* Channel and lun both are 0 for bootable vhost-user-scsi disk */ 110 vsc->channel = 0; 111 vsc->lun = 0; 112 vsc->target = vs->conf.boot_tpgt; 113 114 return; 115 116 free_vhost: 117 vhost_user_cleanup(&s->vhost_user); 118 g_free(vqs); 119 free_virtio: 120 virtio_scsi_common_unrealize(dev); 121 } 122 123 static void vhost_user_scsi_unrealize(DeviceState *dev, Error **errp) 124 { 125 VirtIODevice *vdev = VIRTIO_DEVICE(dev); 126 VHostUserSCSI *s = VHOST_USER_SCSI(dev); 127 VHostSCSICommon *vsc = VHOST_SCSI_COMMON(s); 128 struct vhost_virtqueue *vqs = vsc->dev.vqs; 129 130 /* This will stop the vhost backend. */ 131 vhost_user_scsi_set_status(vdev, 0); 132 133 vhost_dev_cleanup(&vsc->dev); 134 g_free(vqs); 135 136 virtio_scsi_common_unrealize(dev); 137 vhost_user_cleanup(&s->vhost_user); 138 } 139 140 static Property vhost_user_scsi_properties[] = { 141 DEFINE_PROP_CHR("chardev", VirtIOSCSICommon, conf.chardev), 142 DEFINE_PROP_UINT32("boot_tpgt", VirtIOSCSICommon, conf.boot_tpgt, 0), 143 DEFINE_PROP_UINT32("num_queues", VirtIOSCSICommon, conf.num_queues, 1), 144 DEFINE_PROP_UINT32("virtqueue_size", VirtIOSCSICommon, conf.virtqueue_size, 145 128), 146 DEFINE_PROP_UINT32("max_sectors", VirtIOSCSICommon, conf.max_sectors, 147 0xFFFF), 148 DEFINE_PROP_UINT32("cmd_per_lun", VirtIOSCSICommon, conf.cmd_per_lun, 128), 149 DEFINE_PROP_BIT64("hotplug", VHostSCSICommon, host_features, 150 VIRTIO_SCSI_F_HOTPLUG, 151 true), 152 DEFINE_PROP_BIT64("param_change", VHostSCSICommon, host_features, 153 VIRTIO_SCSI_F_CHANGE, 154 true), 155 DEFINE_PROP_BIT64("t10_pi", VHostSCSICommon, host_features, 156 VIRTIO_SCSI_F_T10_PI, 157 false), 158 DEFINE_PROP_END_OF_LIST(), 159 }; 160 161 static const VMStateDescription vmstate_vhost_scsi = { 162 .name = "virtio-scsi", 163 .minimum_version_id = 1, 164 .version_id = 1, 165 .fields = (VMStateField[]) { 166 VMSTATE_VIRTIO_DEVICE, 167 VMSTATE_END_OF_LIST() 168 }, 169 }; 170 171 static void vhost_user_scsi_class_init(ObjectClass *klass, void *data) 172 { 173 DeviceClass *dc = DEVICE_CLASS(klass); 174 VirtioDeviceClass *vdc = VIRTIO_DEVICE_CLASS(klass); 175 FWPathProviderClass *fwc = FW_PATH_PROVIDER_CLASS(klass); 176 177 dc->props = vhost_user_scsi_properties; 178 dc->vmsd = &vmstate_vhost_scsi; 179 set_bit(DEVICE_CATEGORY_STORAGE, dc->categories); 180 vdc->realize = vhost_user_scsi_realize; 181 vdc->unrealize = vhost_user_scsi_unrealize; 182 vdc->get_features = vhost_scsi_common_get_features; 183 vdc->set_config = vhost_scsi_common_set_config; 184 vdc->set_status = vhost_user_scsi_set_status; 185 fwc->get_dev_path = vhost_scsi_common_get_fw_dev_path; 186 } 187 188 static void vhost_user_scsi_instance_init(Object *obj) 189 { 190 VHostSCSICommon *vsc = VHOST_SCSI_COMMON(obj); 191 192 vsc->feature_bits = user_feature_bits; 193 194 /* Add the bootindex property for this object */ 195 device_add_bootindex_property(obj, &vsc->bootindex, "bootindex", NULL, 196 DEVICE(vsc), NULL); 197 } 198 199 static const TypeInfo vhost_user_scsi_info = { 200 .name = TYPE_VHOST_USER_SCSI, 201 .parent = TYPE_VHOST_SCSI_COMMON, 202 .instance_size = sizeof(VHostUserSCSI), 203 .class_init = vhost_user_scsi_class_init, 204 .instance_init = vhost_user_scsi_instance_init, 205 .interfaces = (InterfaceInfo[]) { 206 { TYPE_FW_PATH_PROVIDER }, 207 { } 208 }, 209 }; 210 211 static void virtio_register_types(void) 212 { 213 type_register_static(&vhost_user_scsi_info); 214 } 215 216 type_init(virtio_register_types) 217