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

/*
 * vhost_scsi host device
 *
 * Copyright IBM, Corp. 2011
 *
 * Authors:
 *  Stefan Hajnoczi   <[email protected]>
 *
 * Changes for QEMU mainline + tcm_vhost kernel upstream:
 *  Nicholas Bellinger <[email protected]>
 *
 * 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"

/* Features supported by host kernel. */
static const int kernel_feature_bits[] = {
    VIRTIO_F_NOTIFY_ON_EMPTY,
    VIRTIO_RING_F_INDIRECT_DESC,
    VIRTIO_RING_F_EVENT_IDX,
    VIRTIO_SCSI_F_HOTPLUG,
    VHOST_INVALID_FEATURE_BIT
};

static int vhost_scsi_set_endpoint(VHostSCSI *s)
{
    VirtIOSCSICommon *vs = VIRTIO_SCSI_COMMON(s);
    const VhostOps *vhost_ops = s->dev.vhost_ops;
    struct vhost_scsi_target backend;
    int ret;

    memset(&backend, 0, sizeof(backend));
    pstrcpy(backend.vhost_wwpn, sizeof(backend.vhost_wwpn), vs->conf.wwpn);
    ret = vhost_ops->vhost_call(&s->dev, 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;
    const VhostOps *vhost_ops = s->dev.vhost_ops;

    memset(&backend, 0, sizeof(backend));
    pstrcpy(backend.vhost_wwpn, sizeof(backend.vhost_wwpn), vs->conf.wwpn);
    vhost_ops->vhost_call(&s->dev, 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);
    const VhostOps *vhost_ops = s->dev.vhost_ops;

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

    ret = vhost_ops->vhost_call(&s->dev,
                                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);

    return vhost_get_features(&s->dev, kernel_feature_bits, 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_p(&scsiconf->sense_size) != vs->sense_size ||
        (uint32_t) ldl_p(&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_dummy_handle_output(VirtIODevice *vdev, VirtQueue *vq)
{
}

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;
        }
    } else {
        vhostfd = open("/dev/vhost-scsi", O_RDWR);
        if (vhostfd < 0) {
            error_setg(errp, "vhost-scsi: open vhost char device failed: %s",
                       strerror(errno));
            return;
        }
    }

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