]>
Commit | Line | Data |
---|---|---|
da054c64 PB |
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. */ | |
5 | ||
6 | /* vhost is used to reduce the number of system calls involved in virtio. | |
7 | * | |
8 | * Existing virtio net code is used in the guest without modification. | |
9 | * | |
10 | * This header includes interface used by userspace hypervisor for | |
11 | * device configuration. | |
12 | */ | |
13 | ||
14 | #include "standard-headers/linux/types.h" | |
15 | ||
16 | #include "standard-headers/linux/virtio_config.h" | |
17 | #include "standard-headers/linux/virtio_ring.h" | |
18 | ||
19 | struct vhost_vring_state { | |
20 | unsigned int index; | |
21 | unsigned int num; | |
22 | }; | |
23 | ||
24 | struct vhost_vring_file { | |
25 | unsigned int index; | |
26 | int fd; /* Pass -1 to unbind from file. */ | |
27 | ||
28 | }; | |
29 | ||
30 | struct vhost_vring_addr { | |
31 | unsigned int index; | |
32 | /* Option flags. */ | |
33 | unsigned int flags; | |
34 | /* Flag values: */ | |
35 | /* Whether log address is valid. If set enables logging. */ | |
36 | #define VHOST_VRING_F_LOG 0 | |
37 | ||
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; | |
48 | }; | |
49 | ||
d0bf492f CLG |
50 | struct vhost_worker_state { |
51 | /* | |
52 | * For VHOST_NEW_WORKER the kernel will return the new vhost_worker id. | |
53 | * For VHOST_FREE_WORKER this must be set to the id of the vhost_worker | |
54 | * to free. | |
55 | */ | |
56 | unsigned int worker_id; | |
57 | }; | |
58 | ||
59 | struct vhost_vring_worker { | |
60 | /* vring index */ | |
61 | unsigned int index; | |
62 | /* The id of the vhost_worker returned from VHOST_NEW_WORKER */ | |
63 | unsigned int worker_id; | |
64 | }; | |
65 | ||
da054c64 PB |
66 | /* no alignment requirement */ |
67 | struct vhost_iotlb_msg { | |
68 | uint64_t iova; | |
69 | uint64_t size; | |
70 | uint64_t uaddr; | |
71 | #define VHOST_ACCESS_RO 0x1 | |
72 | #define VHOST_ACCESS_WO 0x2 | |
73 | #define VHOST_ACCESS_RW 0x3 | |
74 | uint8_t perm; | |
75 | #define VHOST_IOTLB_MISS 1 | |
76 | #define VHOST_IOTLB_UPDATE 2 | |
77 | #define VHOST_IOTLB_INVALIDATE 3 | |
78 | #define VHOST_IOTLB_ACCESS_FAIL 4 | |
e6546342 JW |
79 | /* |
80 | * VHOST_IOTLB_BATCH_BEGIN and VHOST_IOTLB_BATCH_END allow modifying | |
81 | * multiple mappings in one go: beginning with | |
82 | * VHOST_IOTLB_BATCH_BEGIN, followed by any number of | |
83 | * VHOST_IOTLB_UPDATE messages, and ending with VHOST_IOTLB_BATCH_END. | |
84 | * When one of these two values is used as the message type, the rest | |
85 | * of the fields in the message are ignored. There's no guarantee that | |
86 | * these changes take place automatically in the device. | |
87 | */ | |
88 | #define VHOST_IOTLB_BATCH_BEGIN 5 | |
89 | #define VHOST_IOTLB_BATCH_END 6 | |
da054c64 PB |
90 | uint8_t type; |
91 | }; | |
92 | ||
93 | #define VHOST_IOTLB_MSG 0x1 | |
94 | #define VHOST_IOTLB_MSG_V2 0x2 | |
95 | ||
96 | struct vhost_msg { | |
97 | int type; | |
98 | union { | |
99 | struct vhost_iotlb_msg iotlb; | |
100 | uint8_t padding[64]; | |
101 | }; | |
102 | }; | |
103 | ||
104 | struct vhost_msg_v2 { | |
105 | uint32_t type; | |
d525f73f | 106 | uint32_t asid; |
da054c64 PB |
107 | union { |
108 | struct vhost_iotlb_msg iotlb; | |
109 | uint8_t padding[64]; | |
110 | }; | |
111 | }; | |
112 | ||
113 | struct vhost_memory_region { | |
114 | uint64_t guest_phys_addr; | |
115 | uint64_t memory_size; /* bytes */ | |
116 | uint64_t userspace_addr; | |
117 | uint64_t flags_padding; /* No flags are currently specified. */ | |
118 | }; | |
119 | ||
120 | /* All region addresses and sizes must be 4K aligned. */ | |
121 | #define VHOST_PAGE_SIZE 0x1000 | |
122 | ||
123 | struct vhost_memory { | |
124 | uint32_t nregions; | |
125 | uint32_t padding; | |
d525f73f | 126 | struct vhost_memory_region regions[]; |
da054c64 PB |
127 | }; |
128 | ||
129 | /* VHOST_SCSI specific definitions */ | |
130 | ||
131 | /* | |
132 | * Used by QEMU userspace to ensure a consistent vhost-scsi ABI. | |
133 | * | |
134 | * ABI Rev 0: July 2012 version starting point for v3.6-rc merge candidate + | |
135 | * RFC-v2 vhost-scsi userspace. Add GET_ABI_VERSION ioctl usage | |
136 | * ABI Rev 1: January 2013. Ignore vhost_tpgt field in struct vhost_scsi_target. | |
137 | * All the targets under vhost_wwpn can be seen and used by guset. | |
138 | */ | |
139 | ||
140 | #define VHOST_SCSI_ABI_VERSION 1 | |
141 | ||
142 | struct vhost_scsi_target { | |
143 | int abi_version; | |
144 | char vhost_wwpn[224]; /* TRANSPORT_IQN_LEN */ | |
145 | unsigned short vhost_tpgt; | |
146 | unsigned short reserved; | |
147 | }; | |
148 | ||
dc6f8d45 CH |
149 | /* VHOST_VDPA specific definitions */ |
150 | ||
151 | struct vhost_vdpa_config { | |
152 | uint32_t off; | |
153 | uint32_t len; | |
d525f73f | 154 | uint8_t buf[]; |
dc6f8d45 CH |
155 | }; |
156 | ||
b3c818a4 EF |
157 | /* vhost vdpa IOVA range |
158 | * @first: First address that can be mapped by vhost-vDPA | |
159 | * @last: Last address that can be mapped by vhost-vDPA | |
160 | */ | |
161 | struct vhost_vdpa_iova_range { | |
162 | uint64_t first; | |
163 | uint64_t last; | |
164 | }; | |
165 | ||
da054c64 PB |
166 | /* Feature bits */ |
167 | /* Log all write descriptors. Can be changed while device is active. */ | |
168 | #define VHOST_F_LOG_ALL 26 | |
169 | /* vhost-net should add virtio_net_hdr for RX, and strip for TX packets. */ | |
170 | #define VHOST_NET_F_VIRTIO_NET_HDR 27 | |
171 | ||
d525f73f CQ |
172 | /* Use message type V2 */ |
173 | #define VHOST_BACKEND_F_IOTLB_MSG_V2 0x1 | |
174 | /* IOTLB can accept batching hints */ | |
175 | #define VHOST_BACKEND_F_IOTLB_BATCH 0x2 | |
176 | /* IOTLB can accept address space identifier through V2 type of IOTLB | |
177 | * message | |
178 | */ | |
179 | #define VHOST_BACKEND_F_IOTLB_ASID 0x3 | |
180 | /* Device can be suspended */ | |
181 | #define VHOST_BACKEND_F_SUSPEND 0x4 | |
c5c0fdbe DDT |
182 | /* Device can be resumed */ |
183 | #define VHOST_BACKEND_F_RESUME 0x5 | |
da3c22c7 TH |
184 | /* Device supports the driver enabling virtqueues both before and after |
185 | * DRIVER_OK | |
186 | */ | |
187 | #define VHOST_BACKEND_F_ENABLE_AFTER_DRIVER_OK 0x6 | |
efb91426 DHB |
188 | /* Device may expose the virtqueue's descriptor area, driver area and |
189 | * device area to a different group for ASID binding than where its | |
190 | * buffers may reside. Requires VHOST_BACKEND_F_IOTLB_ASID. | |
191 | */ | |
192 | #define VHOST_BACKEND_F_DESC_ASID 0x7 | |
193 | /* IOTLB don't flush memory mapping across device reset */ | |
194 | #define VHOST_BACKEND_F_IOTLB_PERSIST 0x8 | |
d525f73f | 195 | |
da054c64 | 196 | #endif |