1*dd873966SEric Auger /* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */ 251b24e34SJan Kiszka #ifndef _LINUX_VHOST_H 351b24e34SJan Kiszka #define _LINUX_VHOST_H 451b24e34SJan Kiszka /* Userspace interface for in-kernel virtio accelerators. */ 551b24e34SJan Kiszka 651b24e34SJan Kiszka /* vhost is used to reduce the number of system calls involved in virtio. 751b24e34SJan Kiszka * 851b24e34SJan Kiszka * Existing virtio net code is used in the guest without modification. 951b24e34SJan Kiszka * 1051b24e34SJan Kiszka * This header includes interface used by userspace hypervisor for 1151b24e34SJan Kiszka * device configuration. 1251b24e34SJan Kiszka */ 1351b24e34SJan Kiszka 1451b24e34SJan Kiszka #include <linux/types.h> 1551b24e34SJan Kiszka 1651b24e34SJan Kiszka #include <linux/ioctl.h> 1751b24e34SJan Kiszka #include <linux/virtio_config.h> 18a9fd1654SJens Freimann #include <linux/virtio_ring.h> 1951b24e34SJan Kiszka 2051b24e34SJan Kiszka struct vhost_vring_state { 2151b24e34SJan Kiszka unsigned int index; 2251b24e34SJan Kiszka unsigned int num; 2351b24e34SJan Kiszka }; 2451b24e34SJan Kiszka 2551b24e34SJan Kiszka struct vhost_vring_file { 2651b24e34SJan Kiszka unsigned int index; 2751b24e34SJan Kiszka int fd; /* Pass -1 to unbind from file. */ 2851b24e34SJan Kiszka 2951b24e34SJan Kiszka }; 3051b24e34SJan Kiszka 3151b24e34SJan Kiszka struct vhost_vring_addr { 3251b24e34SJan Kiszka unsigned int index; 3351b24e34SJan Kiszka /* Option flags. */ 3451b24e34SJan Kiszka unsigned int flags; 3551b24e34SJan Kiszka /* Flag values: */ 3651b24e34SJan Kiszka /* Whether log address is valid. If set enables logging. */ 3751b24e34SJan Kiszka #define VHOST_VRING_F_LOG 0 3851b24e34SJan Kiszka 3951b24e34SJan Kiszka /* Start of array of descriptors (virtually contiguous) */ 4051b24e34SJan Kiszka __u64 desc_user_addr; 4151b24e34SJan Kiszka /* Used structure address. Must be 32 bit aligned */ 4251b24e34SJan Kiszka __u64 used_user_addr; 4351b24e34SJan Kiszka /* Available structure address. Must be 16 bit aligned */ 4451b24e34SJan Kiszka __u64 avail_user_addr; 4551b24e34SJan Kiszka /* Logging support. */ 4651b24e34SJan Kiszka /* Log writes to used structure, at offset calculated from specified 4751b24e34SJan Kiszka * address. Address must be 32 bit aligned. */ 4851b24e34SJan Kiszka __u64 log_guest_addr; 4951b24e34SJan Kiszka }; 5051b24e34SJan Kiszka 51dbdfea92SCornelia Huck /* no alignment requirement */ 52dbdfea92SCornelia Huck struct vhost_iotlb_msg { 53dbdfea92SCornelia Huck __u64 iova; 54dbdfea92SCornelia Huck __u64 size; 55dbdfea92SCornelia Huck __u64 uaddr; 56dbdfea92SCornelia Huck #define VHOST_ACCESS_RO 0x1 57dbdfea92SCornelia Huck #define VHOST_ACCESS_WO 0x2 58dbdfea92SCornelia Huck #define VHOST_ACCESS_RW 0x3 59dbdfea92SCornelia Huck __u8 perm; 60dbdfea92SCornelia Huck #define VHOST_IOTLB_MISS 1 61dbdfea92SCornelia Huck #define VHOST_IOTLB_UPDATE 2 62dbdfea92SCornelia Huck #define VHOST_IOTLB_INVALIDATE 3 63dbdfea92SCornelia Huck #define VHOST_IOTLB_ACCESS_FAIL 4 64dbdfea92SCornelia Huck __u8 type; 65dbdfea92SCornelia Huck }; 66dbdfea92SCornelia Huck 67dbdfea92SCornelia Huck #define VHOST_IOTLB_MSG 0x1 68dbdfea92SCornelia Huck 69dbdfea92SCornelia Huck struct vhost_msg { 70dbdfea92SCornelia Huck int type; 71dbdfea92SCornelia Huck union { 72dbdfea92SCornelia Huck struct vhost_iotlb_msg iotlb; 73dbdfea92SCornelia Huck __u8 padding[64]; 74dbdfea92SCornelia Huck }; 75dbdfea92SCornelia Huck }; 76dbdfea92SCornelia Huck 7751b24e34SJan Kiszka struct vhost_memory_region { 7851b24e34SJan Kiszka __u64 guest_phys_addr; 7951b24e34SJan Kiszka __u64 memory_size; /* bytes */ 8051b24e34SJan Kiszka __u64 userspace_addr; 8151b24e34SJan Kiszka __u64 flags_padding; /* No flags are currently specified. */ 8251b24e34SJan Kiszka }; 8351b24e34SJan Kiszka 8451b24e34SJan Kiszka /* All region addresses and sizes must be 4K aligned. */ 8551b24e34SJan Kiszka #define VHOST_PAGE_SIZE 0x1000 8651b24e34SJan Kiszka 8751b24e34SJan Kiszka struct vhost_memory { 8851b24e34SJan Kiszka __u32 nregions; 8951b24e34SJan Kiszka __u32 padding; 9051b24e34SJan Kiszka struct vhost_memory_region regions[0]; 9151b24e34SJan Kiszka }; 9251b24e34SJan Kiszka 9351b24e34SJan Kiszka /* ioctls */ 9451b24e34SJan Kiszka 9551b24e34SJan Kiszka #define VHOST_VIRTIO 0xAF 9651b24e34SJan Kiszka 9751b24e34SJan Kiszka /* Features bitmask for forward compatibility. Transport bits are used for 9851b24e34SJan Kiszka * vhost specific features. */ 9951b24e34SJan Kiszka #define VHOST_GET_FEATURES _IOR(VHOST_VIRTIO, 0x00, __u64) 10051b24e34SJan Kiszka #define VHOST_SET_FEATURES _IOW(VHOST_VIRTIO, 0x00, __u64) 10151b24e34SJan Kiszka 10251b24e34SJan Kiszka /* Set current process as the (exclusive) owner of this file descriptor. This 10351b24e34SJan Kiszka * must be called before any other vhost command. Further calls to 10451b24e34SJan Kiszka * VHOST_OWNER_SET fail until VHOST_OWNER_RESET is called. */ 10551b24e34SJan Kiszka #define VHOST_SET_OWNER _IO(VHOST_VIRTIO, 0x01) 10651b24e34SJan Kiszka /* Give up ownership, and reset the device to default values. 10751b24e34SJan Kiszka * Allows subsequent call to VHOST_OWNER_SET to succeed. */ 10860915dc4SYuanhan Liu #define VHOST_RESET_OWNER _IO(VHOST_VIRTIO, 0x02) 10951b24e34SJan Kiszka 11051b24e34SJan Kiszka /* Set up/modify memory layout */ 11151b24e34SJan Kiszka #define VHOST_SET_MEM_TABLE _IOW(VHOST_VIRTIO, 0x03, struct vhost_memory) 11251b24e34SJan Kiszka 11351b24e34SJan Kiszka /* Write logging setup. */ 11451b24e34SJan Kiszka /* Memory writes can optionally be logged by setting bit at an offset 11551b24e34SJan Kiszka * (calculated from the physical address) from specified log base. 11651b24e34SJan Kiszka * The bit is set using an atomic 32 bit operation. */ 11751b24e34SJan Kiszka /* Set base address for logging. */ 11851b24e34SJan Kiszka #define VHOST_SET_LOG_BASE _IOW(VHOST_VIRTIO, 0x04, __u64) 11951b24e34SJan Kiszka /* Specify an eventfd file descriptor to signal on log write. */ 12051b24e34SJan Kiszka #define VHOST_SET_LOG_FD _IOW(VHOST_VIRTIO, 0x07, int) 12151b24e34SJan Kiszka 12251b24e34SJan Kiszka /* Ring setup. */ 12351b24e34SJan Kiszka /* Set number of descriptors in ring. This parameter can not 12451b24e34SJan Kiszka * be modified while ring is running (bound to a device). */ 12551b24e34SJan Kiszka #define VHOST_SET_VRING_NUM _IOW(VHOST_VIRTIO, 0x10, struct vhost_vring_state) 12651b24e34SJan Kiszka /* Set addresses for the ring. */ 12751b24e34SJan Kiszka #define VHOST_SET_VRING_ADDR _IOW(VHOST_VIRTIO, 0x11, struct vhost_vring_addr) 12851b24e34SJan Kiszka /* Base value where queue looks for available descriptors */ 12951b24e34SJan Kiszka #define VHOST_SET_VRING_BASE _IOW(VHOST_VIRTIO, 0x12, struct vhost_vring_state) 13051b24e34SJan Kiszka /* Get accessor: reads index, writes value in num */ 13151b24e34SJan Kiszka #define VHOST_GET_VRING_BASE _IOWR(VHOST_VIRTIO, 0x12, struct vhost_vring_state) 13251b24e34SJan Kiszka 133332f6407SGreg Kurz /* Set the vring byte order in num. Valid values are VHOST_VRING_LITTLE_ENDIAN 134332f6407SGreg Kurz * or VHOST_VRING_BIG_ENDIAN (other values return -EINVAL). 135332f6407SGreg Kurz * The byte order cannot be changed while the device is active: trying to do so 136332f6407SGreg Kurz * returns -EBUSY. 137332f6407SGreg Kurz * This is a legacy only API that is simply ignored when VIRTIO_F_VERSION_1 is 138332f6407SGreg Kurz * set. 139332f6407SGreg Kurz * Not all kernel configurations support this ioctl, but all configurations that 140332f6407SGreg Kurz * support SET also support GET. 141332f6407SGreg Kurz */ 142332f6407SGreg Kurz #define VHOST_VRING_LITTLE_ENDIAN 0 143332f6407SGreg Kurz #define VHOST_VRING_BIG_ENDIAN 1 144332f6407SGreg Kurz #define VHOST_SET_VRING_ENDIAN _IOW(VHOST_VIRTIO, 0x13, struct vhost_vring_state) 145332f6407SGreg Kurz #define VHOST_GET_VRING_ENDIAN _IOW(VHOST_VIRTIO, 0x14, struct vhost_vring_state) 146332f6407SGreg Kurz 14751b24e34SJan Kiszka /* The following ioctls use eventfd file descriptors to signal and poll 14851b24e34SJan Kiszka * for events. */ 14951b24e34SJan Kiszka 15051b24e34SJan Kiszka /* Set eventfd to poll for added buffers */ 15151b24e34SJan Kiszka #define VHOST_SET_VRING_KICK _IOW(VHOST_VIRTIO, 0x20, struct vhost_vring_file) 15251b24e34SJan Kiszka /* Set eventfd to signal when buffers have beed used */ 15351b24e34SJan Kiszka #define VHOST_SET_VRING_CALL _IOW(VHOST_VIRTIO, 0x21, struct vhost_vring_file) 15451b24e34SJan Kiszka /* Set eventfd to signal an error */ 15551b24e34SJan Kiszka #define VHOST_SET_VRING_ERR _IOW(VHOST_VIRTIO, 0x22, struct vhost_vring_file) 156b89485a5SPaolo Bonzini /* Set busy loop timeout (in us) */ 157b89485a5SPaolo Bonzini #define VHOST_SET_VRING_BUSYLOOP_TIMEOUT _IOW(VHOST_VIRTIO, 0x23, \ 158b89485a5SPaolo Bonzini struct vhost_vring_state) 159b89485a5SPaolo Bonzini /* Get busy loop timeout (in us) */ 160b89485a5SPaolo Bonzini #define VHOST_GET_VRING_BUSYLOOP_TIMEOUT _IOW(VHOST_VIRTIO, 0x24, \ 161b89485a5SPaolo Bonzini struct vhost_vring_state) 16251b24e34SJan Kiszka 16351b24e34SJan Kiszka /* VHOST_NET specific defines */ 16451b24e34SJan Kiszka 16551b24e34SJan Kiszka /* Attach virtio net ring to a raw socket, or tap device. 16651b24e34SJan Kiszka * The socket must be already bound to an ethernet device, this device will be 16751b24e34SJan Kiszka * used for transmit. Pass fd -1 to unbind from the socket and the transmit 16851b24e34SJan Kiszka * device. This can be used to stop the ring (e.g. for migration). */ 16951b24e34SJan Kiszka #define VHOST_NET_SET_BACKEND _IOW(VHOST_VIRTIO, 0x30, struct vhost_vring_file) 17051b24e34SJan Kiszka 17151b24e34SJan Kiszka /* Feature bits */ 17251b24e34SJan Kiszka /* Log all write descriptors. Can be changed while device is active. */ 17351b24e34SJan Kiszka #define VHOST_F_LOG_ALL 26 17451b24e34SJan Kiszka /* vhost-net should add virtio_net_hdr for RX, and strip for TX packets. */ 17551b24e34SJan Kiszka #define VHOST_NET_F_VIRTIO_NET_HDR 27 17651b24e34SJan Kiszka 177e098b453SAlexey Kardashevskiy /* VHOST_SCSI specific definitions */ 178e098b453SAlexey Kardashevskiy 179e098b453SAlexey Kardashevskiy /* 180e098b453SAlexey Kardashevskiy * Used by QEMU userspace to ensure a consistent vhost-scsi ABI. 181e098b453SAlexey Kardashevskiy * 182e098b453SAlexey Kardashevskiy * ABI Rev 0: July 2012 version starting point for v3.6-rc merge candidate + 183e098b453SAlexey Kardashevskiy * RFC-v2 vhost-scsi userspace. Add GET_ABI_VERSION ioctl usage 184e098b453SAlexey Kardashevskiy * ABI Rev 1: January 2013. Ignore vhost_tpgt filed in struct vhost_scsi_target. 185e098b453SAlexey Kardashevskiy * All the targets under vhost_wwpn can be seen and used by guset. 186e098b453SAlexey Kardashevskiy */ 187e098b453SAlexey Kardashevskiy 188e098b453SAlexey Kardashevskiy #define VHOST_SCSI_ABI_VERSION 1 189e098b453SAlexey Kardashevskiy 190e098b453SAlexey Kardashevskiy struct vhost_scsi_target { 191e098b453SAlexey Kardashevskiy int abi_version; 192e098b453SAlexey Kardashevskiy char vhost_wwpn[224]; /* TRANSPORT_IQN_LEN */ 193e098b453SAlexey Kardashevskiy unsigned short vhost_tpgt; 194e098b453SAlexey Kardashevskiy unsigned short reserved; 195e098b453SAlexey Kardashevskiy }; 196e098b453SAlexey Kardashevskiy 197e098b453SAlexey Kardashevskiy #define VHOST_SCSI_SET_ENDPOINT _IOW(VHOST_VIRTIO, 0x40, struct vhost_scsi_target) 198e098b453SAlexey Kardashevskiy #define VHOST_SCSI_CLEAR_ENDPOINT _IOW(VHOST_VIRTIO, 0x41, struct vhost_scsi_target) 199e098b453SAlexey Kardashevskiy /* Changing this breaks userspace. */ 200e098b453SAlexey Kardashevskiy #define VHOST_SCSI_GET_ABI_VERSION _IOW(VHOST_VIRTIO, 0x42, int) 201e098b453SAlexey Kardashevskiy /* Set and get the events missed flag */ 202e098b453SAlexey Kardashevskiy #define VHOST_SCSI_SET_EVENTS_MISSED _IOW(VHOST_VIRTIO, 0x43, __u32) 203e098b453SAlexey Kardashevskiy #define VHOST_SCSI_GET_EVENTS_MISSED _IOW(VHOST_VIRTIO, 0x44, __u32) 204e098b453SAlexey Kardashevskiy 205dbdfea92SCornelia Huck /* VHOST_VSOCK specific defines */ 206dbdfea92SCornelia Huck 207dbdfea92SCornelia Huck #define VHOST_VSOCK_SET_GUEST_CID _IOW(VHOST_VIRTIO, 0x60, __u64) 208dbdfea92SCornelia Huck #define VHOST_VSOCK_SET_RUNNING _IOW(VHOST_VIRTIO, 0x61, int) 209dbdfea92SCornelia Huck 21051b24e34SJan Kiszka #endif 211