1 /* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */
2 #ifndef _LINUX_VHOST_TYPES_H
3 #define _LINUX_VHOST_TYPES_H
4 /* Userspace interface for in-kernel virtio accelerators. */
6 /* vhost is used to reduce the number of system calls involved in virtio.
8 * Existing virtio net code is used in the guest without modification.
10 * This header includes interface used by userspace hypervisor for
11 * device configuration.
14 #include "standard-headers/linux/types.h"
16 #include "standard-headers/linux/virtio_config.h"
17 #include "standard-headers/linux/virtio_ring.h"
19 struct vhost_vring_state
{
24 struct vhost_vring_file
{
26 int fd
; /* Pass -1 to unbind from file. */
30 struct vhost_vring_addr
{
35 /* Whether log address is valid. If set enables logging. */
36 #define VHOST_VRING_F_LOG 0
38 /* Start of array of descriptors (virtually contiguous) */
39 uint64_t desc_user_addr
;
40 /* Used structure address. Must be 32 bit aligned */
41 uint64_t used_user_addr
;
42 /* Available structure address. Must be 16 bit aligned */
43 uint64_t avail_user_addr
;
44 /* Logging support. */
45 /* Log writes to used structure, at offset calculated from specified
46 * address. Address must be 32 bit aligned. */
47 uint64_t log_guest_addr
;
50 /* no alignment requirement */
51 struct vhost_iotlb_msg
{
55 #define VHOST_ACCESS_RO 0x1
56 #define VHOST_ACCESS_WO 0x2
57 #define VHOST_ACCESS_RW 0x3
59 #define VHOST_IOTLB_MISS 1
60 #define VHOST_IOTLB_UPDATE 2
61 #define VHOST_IOTLB_INVALIDATE 3
62 #define VHOST_IOTLB_ACCESS_FAIL 4
64 * VHOST_IOTLB_BATCH_BEGIN and VHOST_IOTLB_BATCH_END allow modifying
65 * multiple mappings in one go: beginning with
66 * VHOST_IOTLB_BATCH_BEGIN, followed by any number of
67 * VHOST_IOTLB_UPDATE messages, and ending with VHOST_IOTLB_BATCH_END.
68 * When one of these two values is used as the message type, the rest
69 * of the fields in the message are ignored. There's no guarantee that
70 * these changes take place automatically in the device.
72 #define VHOST_IOTLB_BATCH_BEGIN 5
73 #define VHOST_IOTLB_BATCH_END 6
77 #define VHOST_IOTLB_MSG 0x1
78 #define VHOST_IOTLB_MSG_V2 0x2
83 struct vhost_iotlb_msg iotlb
;
92 struct vhost_iotlb_msg iotlb
;
97 struct vhost_memory_region
{
98 uint64_t guest_phys_addr
;
99 uint64_t memory_size
; /* bytes */
100 uint64_t userspace_addr
;
101 uint64_t flags_padding
; /* No flags are currently specified. */
104 /* All region addresses and sizes must be 4K aligned. */
105 #define VHOST_PAGE_SIZE 0x1000
107 struct vhost_memory
{
110 struct vhost_memory_region regions
[0];
113 /* VHOST_SCSI specific definitions */
116 * Used by QEMU userspace to ensure a consistent vhost-scsi ABI.
118 * ABI Rev 0: July 2012 version starting point for v3.6-rc merge candidate +
119 * RFC-v2 vhost-scsi userspace. Add GET_ABI_VERSION ioctl usage
120 * ABI Rev 1: January 2013. Ignore vhost_tpgt field in struct vhost_scsi_target.
121 * All the targets under vhost_wwpn can be seen and used by guset.
124 #define VHOST_SCSI_ABI_VERSION 1
126 struct vhost_scsi_target
{
128 char vhost_wwpn
[224]; /* TRANSPORT_IQN_LEN */
129 unsigned short vhost_tpgt
;
130 unsigned short reserved
;
133 /* VHOST_VDPA specific definitions */
135 struct vhost_vdpa_config
{
141 /* vhost vdpa IOVA range
142 * @first: First address that can be mapped by vhost-vDPA
143 * @last: Last address that can be mapped by vhost-vDPA
145 struct vhost_vdpa_iova_range
{
151 /* Log all write descriptors. Can be changed while device is active. */
152 #define VHOST_F_LOG_ALL 26
153 /* vhost-net should add virtio_net_hdr for RX, and strip for TX packets. */
154 #define VHOST_NET_F_VIRTIO_NET_HDR 27