[mirror_qemu.git] / hw / scsi / vhost-scsi.c

/*
 * vhost_scsi host device
 *
 * Copyright IBM, Corp. 2011
 *
 * Authors:
 *  Stefan Hajnoczi   <stefanha@linux.vnet.ibm.com>
 *
 * Changes for QEMU mainline + tcm_vhost kernel upstream:
 *  Nicholas Bellinger <nab@risingtidesystems.com>
 *
 * This work is licensed under the terms of the GNU LGPL, version 2 or later.
 * See the COPYING.LIB file in the top-level directory.
 *
 */

#include <sys/ioctl.h>
#include "config.h"
#include "qemu/queue.h"
#include "monitor/monitor.h"
#include "migration/migration.h"
#include "hw/virtio/vhost-scsi.h"
#include "hw/virtio/vhost.h"
#include "hw/virtio/virtio-scsi.h"
#include "hw/virtio/virtio-bus.h"

static int vhost_scsi_set_endpoint(VHostSCSI *s)
{
    VirtIOSCSICommon *vs = VIRTIO_SCSI_COMMON(s);
    struct vhost_scsi_target backend;
    int ret;

    memset(&backend, 0, sizeof(backend));
    pstrcpy(backend.vhost_wwpn, sizeof(backend.vhost_wwpn), vs->conf.wwpn);
    ret = ioctl(s->dev.control, VHOST_SCSI_SET_ENDPOINT, &backend);
    if (ret < 0) {
        return -errno;
    }
    return 0;
}

static void vhost_scsi_clear_endpoint(VHostSCSI *s)
{
    VirtIOSCSICommon *vs = VIRTIO_SCSI_COMMON(s);
    struct vhost_scsi_target backend;

    memset(&backend, 0, sizeof(backend));
    pstrcpy(backend.vhost_wwpn, sizeof(backend.vhost_wwpn), vs->conf.wwpn);
    ioctl(s->dev.control, VHOST_SCSI_CLEAR_ENDPOINT, &backend);
}

static int vhost_scsi_start(VHostSCSI *s)
{
    int ret, abi_version, i;
    VirtIODevice *vdev = VIRTIO_DEVICE(s);
    BusState *qbus = BUS(qdev_get_parent_bus(DEVICE(vdev)));
    VirtioBusClass *k = VIRTIO_BUS_GET_CLASS(qbus);

    if (!k->set_guest_notifiers) {
        error_report("binding does not support guest notifiers");
        return -ENOSYS;
    }

    ret = ioctl(s->dev.control, VHOST_SCSI_GET_ABI_VERSION, &abi_version);
    if (ret < 0) {
        return -errno;
    }
    if (abi_version > VHOST_SCSI_ABI_VERSION) {
        error_report("vhost-scsi: The running tcm_vhost kernel abi_version:"
                     " %d is greater than vhost_scsi userspace supports: %d, please"
                     " upgrade your version of QEMU\n", abi_version,
                     VHOST_SCSI_ABI_VERSION);
        return -ENOSYS;
    }

    ret = vhost_dev_enable_notifiers(&s->dev, vdev);
    if (ret < 0) {
        return ret;
    }

    s->dev.acked_features = vdev->guest_features;
    ret = vhost_dev_start(&s->dev, vdev);
    if (ret < 0) {
        error_report("Error start vhost dev");
        goto err_notifiers;
    }

    ret = vhost_scsi_set_endpoint(s);
    if (ret < 0) {
        error_report("Error set vhost-scsi endpoint");
        goto err_vhost_stop;
    }

    ret = k->set_guest_notifiers(qbus->parent, s->dev.nvqs, true);
    if (ret < 0) {
        error_report("Error binding guest notifier");
        goto err_endpoint;
    }

    /* guest_notifier_mask/pending not used yet, so just unmask
     * everything here.  virtio-pci will do the right thing by
     * enabling/disabling irqfd.
     */
    for (i = 0; i < s->dev.nvqs; i++) {
        vhost_virtqueue_mask(&s->dev, vdev, i, false);
    }

    return ret;

err_endpoint:
    vhost_scsi_clear_endpoint(s);
err_vhost_stop:
    vhost_dev_stop(&s->dev, vdev);
err_notifiers:
    vhost_dev_disable_notifiers(&s->dev, vdev);
    return ret;
}

static void vhost_scsi_stop(VHostSCSI *s)
{
    VirtIODevice *vdev = VIRTIO_DEVICE(s);
    BusState *qbus = BUS(qdev_get_parent_bus(DEVICE(vdev)));
    VirtioBusClass *k = VIRTIO_BUS_GET_CLASS(qbus);
    int ret = 0;

    if (k->set_guest_notifiers) {
        ret = k->set_guest_notifiers(qbus->parent, s->dev.nvqs, false);
        if (ret < 0) {
                error_report("vhost guest notifier cleanup failed: %d\n", ret);
        }
    }
    assert(ret >= 0);

    vhost_scsi_clear_endpoint(s);
    vhost_dev_stop(&s->dev, vdev);
    vhost_dev_disable_notifiers(&s->dev, vdev);
}

static uint32_t vhost_scsi_get_features(VirtIODevice *vdev,
                                        uint32_t features)
{
    VHostSCSI *s = VHOST_SCSI(vdev);

    /* Clear features not supported by host kernel. */
    if (!(s->dev.features & (1 << VIRTIO_F_NOTIFY_ON_EMPTY))) {
        features &= ~(1 << VIRTIO_F_NOTIFY_ON_EMPTY);
    }
    if (!(s->dev.features & (1 << VIRTIO_RING_F_INDIRECT_DESC))) {
        features &= ~(1 << VIRTIO_RING_F_INDIRECT_DESC);
    }
    if (!(s->dev.features & (1 << VIRTIO_RING_F_EVENT_IDX))) {
        features &= ~(1 << VIRTIO_RING_F_EVENT_IDX);
    }
    if (!(s->dev.features & (1 << VIRTIO_SCSI_F_HOTPLUG))) {
        features &= ~(1 << VIRTIO_SCSI_F_HOTPLUG);
    }

    return features;
}

static void vhost_scsi_set_config(VirtIODevice *vdev,
                                  const uint8_t *config)
{
    VirtIOSCSIConfig *scsiconf = (VirtIOSCSIConfig *)config;
    VirtIOSCSICommon *vs = VIRTIO_SCSI_COMMON(vdev);

    if ((uint32_t) ldl_raw(&scsiconf->sense_size) != vs->sense_size ||
        (uint32_t) ldl_raw(&scsiconf->cdb_size) != vs->cdb_size) {
        error_report("vhost-scsi does not support changing the sense data and CDB sizes");
        exit(1);
    }
}

static void vhost_scsi_set_status(VirtIODevice *vdev, uint8_t val)
{
    VHostSCSI *s = (VHostSCSI *)vdev;
    bool start = (val & VIRTIO_CONFIG_S_DRIVER_OK);

    if (s->dev.started == start) {
        return;
    }

    if (start) {
        int ret;

        ret = vhost_scsi_start(s);
        if (ret < 0) {
            error_report("virtio-scsi: unable to start vhost: %s\n",
                         strerror(-ret));

            /* There is no userspace virtio-scsi fallback so exit */
            exit(1);
        }
    } else {
        vhost_scsi_stop(s);
    }
}

static void vhost_scsi_realize(DeviceState *dev, Error **errp)
{
    VirtIOSCSICommon *vs = VIRTIO_SCSI_COMMON(dev);
    VHostSCSI *s = VHOST_SCSI(dev);
    Error *err = NULL;
    int vhostfd = -1;
    int ret;

    if (!vs->conf.wwpn) {
        error_setg(errp, "vhost-scsi: missing wwpn");
        return;
    }

    if (vs->conf.vhostfd) {
        vhostfd = monitor_handle_fd_param(cur_mon, vs->conf.vhostfd);
        if (vhostfd == -1) {
            error_setg(errp, "vhost-scsi: unable to parse vhostfd");
            return;
        }
    }

    virtio_scsi_common_realize(dev, &err);
    if (err != NULL) {
        error_propagate(errp, err);
        return;
    }

    s->dev.nvqs = VHOST_SCSI_VQ_NUM_FIXED + vs->conf.num_queues;
    s->dev.vqs = g_new(struct vhost_virtqueue, s->dev.nvqs);
    s->dev.vq_index = 0;

    ret = vhost_dev_init(&s->dev, vhostfd, "/dev/vhost-scsi", true);
    if (ret < 0) {
        error_setg(errp, "vhost-scsi: vhost initialization failed: %s",
                   strerror(-ret));
        return;
    }
    s->dev.backend_features = 0;

    error_setg(&s->migration_blocker,
            "vhost-scsi does not support migration");
    migrate_add_blocker(s->migration_blocker);
}

static void vhost_scsi_unrealize(DeviceState *dev, Error **errp)
{
    VirtIODevice *vdev = VIRTIO_DEVICE(dev);
    VHostSCSI *s = VHOST_SCSI(dev);

    migrate_del_blocker(s->migration_blocker);
    error_free(s->migration_blocker);

    /* This will stop vhost backend. */
    vhost_scsi_set_status(vdev, 0);

    g_free(s->dev.vqs);

    virtio_scsi_common_unrealize(dev, errp);
}

static Property vhost_scsi_properties[] = {
    DEFINE_VHOST_SCSI_PROPERTIES(VHostSCSI, parent_obj.conf),
    DEFINE_PROP_END_OF_LIST(),
};

static void vhost_scsi_class_init(ObjectClass *klass, void *data)
{
    DeviceClass *dc = DEVICE_CLASS(klass);
    VirtioDeviceClass *vdc = VIRTIO_DEVICE_CLASS(klass);

    dc->props = vhost_scsi_properties;
    set_bit(DEVICE_CATEGORY_STORAGE, dc->categories);
    vdc->realize = vhost_scsi_realize;
    vdc->unrealize = vhost_scsi_unrealize;
    vdc->get_features = vhost_scsi_get_features;
    vdc->set_config = vhost_scsi_set_config;
    vdc->set_status = vhost_scsi_set_status;
}

static const TypeInfo vhost_scsi_info = {
    .name = TYPE_VHOST_SCSI,
    .parent = TYPE_VIRTIO_SCSI_COMMON,
    .instance_size = sizeof(VHostSCSI),
    .class_init = vhost_scsi_class_init,
};

static void virtio_register_types(void)
{
    type_register_static(&vhost_scsi_info);
}

type_init(virtio_register_types)
Commit	Line	Data
5e9be92d NB	1	/*
	2	* vhost_scsi host device
	3	*
	4	* Copyright IBM, Corp. 2011
	5	*
	6	* Authors:
	7	* Stefan Hajnoczi <stefanha@linux.vnet.ibm.com>
	8	*
	9	* Changes for QEMU mainline + tcm_vhost kernel upstream:
	10	* Nicholas Bellinger <nab@risingtidesystems.com>
	11	*
	12	* This work is licensed under the terms of the GNU LGPL, version 2 or later.
	13	* See the COPYING.LIB file in the top-level directory.
	14	*
	15	*/
	16
	17	#include <sys/ioctl.h>
	18	#include "config.h"
	19	#include "qemu/queue.h"
	20	#include "monitor/monitor.h"
	21	#include "migration/migration.h"
	22	#include "hw/virtio/vhost-scsi.h"
	23	#include "hw/virtio/vhost.h"
	24	#include "hw/virtio/virtio-scsi.h"
1c819449	25	#include "hw/virtio/virtio-bus.h"
5e9be92d NB	26
	27	static int vhost_scsi_set_endpoint(VHostSCSI *s)
	28	{
	29	VirtIOSCSICommon *vs = VIRTIO_SCSI_COMMON(s);
	30	struct vhost_scsi_target backend;
	31	int ret;
	32
	33	memset(&backend, 0, sizeof(backend));
	34	pstrcpy(backend.vhost_wwpn, sizeof(backend.vhost_wwpn), vs->conf.wwpn);
	35	ret = ioctl(s->dev.control, VHOST_SCSI_SET_ENDPOINT, &backend);
	36	if (ret < 0) {
	37	return -errno;
	38	}
	39	return 0;
	40	}
	41
	42	static void vhost_scsi_clear_endpoint(VHostSCSI *s)
	43	{
	44	VirtIOSCSICommon *vs = VIRTIO_SCSI_COMMON(s);
	45	struct vhost_scsi_target backend;
	46
	47	memset(&backend, 0, sizeof(backend));
	48	pstrcpy(backend.vhost_wwpn, sizeof(backend.vhost_wwpn), vs->conf.wwpn);
	49	ioctl(s->dev.control, VHOST_SCSI_CLEAR_ENDPOINT, &backend);
	50	}
	51
	52	static int vhost_scsi_start(VHostSCSI *s)
	53	{
	54	int ret, abi_version, i;
	55	VirtIODevice *vdev = VIRTIO_DEVICE(s);
1c819449 FK	56	BusState *qbus = BUS(qdev_get_parent_bus(DEVICE(vdev)));
1c819449 FK	57	VirtioBusClass *k = VIRTIO_BUS_GET_CLASS(qbus);
5e9be92d	58
1c819449	59	if (!k->set_guest_notifiers) {
5e9be92d NB	60	error_report("binding does not support guest notifiers");
	61	return -ENOSYS;
	62	}
	63
	64	ret = ioctl(s->dev.control, VHOST_SCSI_GET_ABI_VERSION, &abi_version);
	65	if (ret < 0) {
	66	return -errno;
	67	}
	68	if (abi_version > VHOST_SCSI_ABI_VERSION) {
	69	error_report("vhost-scsi: The running tcm_vhost kernel abi_version:"
	70	" %d is greater than vhost_scsi userspace supports: %d, please"
	71	" upgrade your version of QEMU\n", abi_version,
	72	VHOST_SCSI_ABI_VERSION);
	73	return -ENOSYS;
	74	}
	75
	76	ret = vhost_dev_enable_notifiers(&s->dev, vdev);
	77	if (ret < 0) {
	78	return ret;
	79	}
	80
	81	s->dev.acked_features = vdev->guest_features;
	82	ret = vhost_dev_start(&s->dev, vdev);
	83	if (ret < 0) {
	84	error_report("Error start vhost dev");
	85	goto err_notifiers;
	86	}
	87
	88	ret = vhost_scsi_set_endpoint(s);
	89	if (ret < 0) {
	90	error_report("Error set vhost-scsi endpoint");
	91	goto err_vhost_stop;
	92	}
	93
1c819449	94	ret = k->set_guest_notifiers(qbus->parent, s->dev.nvqs, true);
5e9be92d NB	95	if (ret < 0) {
	96	error_report("Error binding guest notifier");
	97	goto err_endpoint;
	98	}
	99
	100	/* guest_notifier_mask/pending not used yet, so just unmask
	101	* everything here. virtio-pci will do the right thing by
	102	* enabling/disabling irqfd.
	103	*/
	104	for (i = 0; i < s->dev.nvqs; i++) {
	105	vhost_virtqueue_mask(&s->dev, vdev, i, false);
	106	}
	107
	108	return ret;
	109
	110	err_endpoint:
	111	vhost_scsi_clear_endpoint(s);
	112	err_vhost_stop:
	113	vhost_dev_stop(&s->dev, vdev);
	114	err_notifiers:
	115	vhost_dev_disable_notifiers(&s->dev, vdev);
	116	return ret;
	117	}
	118
	119	static void vhost_scsi_stop(VHostSCSI *s)
	120	{
	121	VirtIODevice *vdev = VIRTIO_DEVICE(s);
1c819449 FK	122	BusState *qbus = BUS(qdev_get_parent_bus(DEVICE(vdev)));
1c819449 FK	123	VirtioBusClass *k = VIRTIO_BUS_GET_CLASS(qbus);
5e9be92d NB	124	int ret = 0;
5e9be92d NB	125
0e22a2d1	126	if (k->set_guest_notifiers) {
1c819449	127	ret = k->set_guest_notifiers(qbus->parent, s->dev.nvqs, false);
5e9be92d NB	128	if (ret < 0) {
	129	error_report("vhost guest notifier cleanup failed: %d\n", ret);
	130	}
	131	}
	132	assert(ret >= 0);
	133
	134	vhost_scsi_clear_endpoint(s);
	135	vhost_dev_stop(&s->dev, vdev);
	136	vhost_dev_disable_notifiers(&s->dev, vdev);
	137	}
	138
	139	static uint32_t vhost_scsi_get_features(VirtIODevice *vdev,
	140	uint32_t features)
	141	{
	142	VHostSCSI *s = VHOST_SCSI(vdev);
	143
	144	/* Clear features not supported by host kernel. */
	145	if (!(s->dev.features & (1 << VIRTIO_F_NOTIFY_ON_EMPTY))) {
	146	features &= ~(1 << VIRTIO_F_NOTIFY_ON_EMPTY);
	147	}
	148	if (!(s->dev.features & (1 << VIRTIO_RING_F_INDIRECT_DESC))) {
	149	features &= ~(1 << VIRTIO_RING_F_INDIRECT_DESC);
	150	}
	151	if (!(s->dev.features & (1 << VIRTIO_RING_F_EVENT_IDX))) {
	152	features &= ~(1 << VIRTIO_RING_F_EVENT_IDX);
	153	}
	154	if (!(s->dev.features & (1 << VIRTIO_SCSI_F_HOTPLUG))) {
	155	features &= ~(1 << VIRTIO_SCSI_F_HOTPLUG);
	156	}
	157
	158	return features;
	159	}
	160
	161	static void vhost_scsi_set_config(VirtIODevice *vdev,
	162	const uint8_t *config)
	163	{
	164	VirtIOSCSIConfig scsiconf = (VirtIOSCSIConfig )config;
	165	VirtIOSCSICommon *vs = VIRTIO_SCSI_COMMON(vdev);
	166
	167	if ((uint32_t) ldl_raw(&scsiconf->sense_size) != vs->sense_size \|\|
	168	(uint32_t) ldl_raw(&scsiconf->cdb_size) != vs->cdb_size) {
	169	error_report("vhost-scsi does not support changing the sense data and CDB sizes");
	170	exit(1);
	171	}
	172	}
	173
	174	static void vhost_scsi_set_status(VirtIODevice *vdev, uint8_t val)
	175	{
	176	VHostSCSI s = (VHostSCSI )vdev;
	177	bool start = (val & VIRTIO_CONFIG_S_DRIVER_OK);
	178
	179	if (s->dev.started == start) {
	180	return;
	181	}
	182
	183	if (start) {
	184	int ret;
	185
	186	ret = vhost_scsi_start(s);
	187	if (ret < 0) {
	188	error_report("virtio-scsi: unable to start vhost: %s\n",
	189	strerror(-ret));
	190
	191	/* There is no userspace virtio-scsi fallback so exit */
192	exit(1);
193	}
194	} else {
195	vhost_scsi_stop(s);
196	}
197	}
198
71a6520b	199	static void vhost_scsi_realize(DeviceState dev, Error *errp)
5e9be92d	200	{
71a6520b AF	201	VirtIOSCSICommon *vs = VIRTIO_SCSI_COMMON(dev);
	202	VHostSCSI *s = VHOST_SCSI(dev);
	203	Error *err = NULL;
5e9be92d NB	204	int vhostfd = -1;
	205	int ret;
	206
	207	if (!vs->conf.wwpn) {
71a6520b AF	208	error_setg(errp, "vhost-scsi: missing wwpn");
71a6520b AF	209	return;
5e9be92d NB	210	}
	211
	212	if (vs->conf.vhostfd) {
	213	vhostfd = monitor_handle_fd_param(cur_mon, vs->conf.vhostfd);
	214	if (vhostfd == -1) {
71a6520b AF	215	error_setg(errp, "vhost-scsi: unable to parse vhostfd");
71a6520b AF	216	return;
5e9be92d NB	217	}
	218	}
	219
71a6520b AF	220	virtio_scsi_common_realize(dev, &err);
	221	if (err != NULL) {
	222	error_propagate(errp, err);
	223	return;
5e9be92d NB	224	}
5e9be92d NB	225
5e9be92d NB	226	s->dev.nvqs = VHOST_SCSI_VQ_NUM_FIXED + vs->conf.num_queues;
	227	s->dev.vqs = g_new(struct vhost_virtqueue, s->dev.nvqs);
	228	s->dev.vq_index = 0;
	229
	230	ret = vhost_dev_init(&s->dev, vhostfd, "/dev/vhost-scsi", true);
	231	if (ret < 0) {
71a6520b AF	232	error_setg(errp, "vhost-scsi: vhost initialization failed: %s",
	233	strerror(-ret));
	234	return;
5e9be92d NB	235	}
	236	s->dev.backend_features = 0;
	237
	238	error_setg(&s->migration_blocker,
	239	"vhost-scsi does not support migration");
	240	migrate_add_blocker(s->migration_blocker);
5e9be92d NB	241	}
5e9be92d NB	242
306ec6c3	243	static void vhost_scsi_unrealize(DeviceState dev, Error *errp)
5e9be92d	244	{
306ec6c3 AF	245	VirtIODevice *vdev = VIRTIO_DEVICE(dev);
306ec6c3 AF	246	VHostSCSI *s = VHOST_SCSI(dev);
5e9be92d NB	247
	248	migrate_del_blocker(s->migration_blocker);
	249	error_free(s->migration_blocker);
	250
	251	/* This will stop vhost backend. */
	252	vhost_scsi_set_status(vdev, 0);
	253
	254	g_free(s->dev.vqs);
306ec6c3 AF	255
306ec6c3 AF	256	virtio_scsi_common_unrealize(dev, errp);
5e9be92d NB	257	}
	258
	259	static Property vhost_scsi_properties[] = {
	260	DEFINE_VHOST_SCSI_PROPERTIES(VHostSCSI, parent_obj.conf),
	261	DEFINE_PROP_END_OF_LIST(),
	262	};
	263
	264	static void vhost_scsi_class_init(ObjectClass klass, void data)
	265	{
	266	DeviceClass *dc = DEVICE_CLASS(klass);
	267	VirtioDeviceClass *vdc = VIRTIO_DEVICE_CLASS(klass);
71a6520b	268
5e9be92d	269	dc->props = vhost_scsi_properties;
125ee0ed	270	set_bit(DEVICE_CATEGORY_STORAGE, dc->categories);
71a6520b	271	vdc->realize = vhost_scsi_realize;
306ec6c3	272	vdc->unrealize = vhost_scsi_unrealize;
5e9be92d NB	273	vdc->get_features = vhost_scsi_get_features;
	274	vdc->set_config = vhost_scsi_set_config;
	275	vdc->set_status = vhost_scsi_set_status;
	276	}
	277
	278	static const TypeInfo vhost_scsi_info = {
	279	.name = TYPE_VHOST_SCSI,
	280	.parent = TYPE_VIRTIO_SCSI_COMMON,
	281	.instance_size = sizeof(VHostSCSI),
	282	.class_init = vhost_scsi_class_init,
	283	};
	284
	285	static void virtio_register_types(void)
	286	{
	287	type_register_static(&vhost_scsi_info);
	288	}
	289
	290	type_init(virtio_register_types)