Commit | Line | Data |
---|---|---|
d2912cb1 | 1 | /* SPDX-License-Identifier: GPL-2.0-only */ |
cba3345c AW |
2 | /* |
3 | * VFIO API definition | |
4 | * | |
5 | * Copyright (C) 2012 Red Hat, Inc. All rights reserved. | |
6 | * Author: Alex Williamson <alex.williamson@redhat.com> | |
cba3345c AW |
7 | */ |
8 | #ifndef VFIO_H | |
9 | #define VFIO_H | |
10 | ||
cba3345c AW |
11 | |
12 | #include <linux/iommu.h> | |
13 | #include <linux/mm.h> | |
7e992d69 AM |
14 | #include <linux/workqueue.h> |
15 | #include <linux/poll.h> | |
607ca46e | 16 | #include <uapi/linux/vfio.h> |
80c4b92a | 17 | #include <linux/iova_bitmap.h> |
cba3345c | 18 | |
ba70a89f | 19 | struct kvm; |
a4d1f91d JG |
20 | struct iommufd_ctx; |
21 | struct iommufd_device; | |
4741f2e9 | 22 | struct iommufd_access; |
ba70a89f | 23 | |
2fd585f4 JG |
24 | /* |
25 | * VFIO devices can be placed in a set, this allows all devices to share this | |
26 | * structure and the VFIO core will provide a lock that is held around | |
27 | * open_device()/close_device() for all devices in the set. | |
28 | */ | |
29 | struct vfio_device_set { | |
30 | void *set_id; | |
31 | struct mutex lock; | |
32 | struct list_head device_list; | |
33 | unsigned int device_count; | |
34 | }; | |
35 | ||
0bfc6a4e JG |
36 | struct vfio_device { |
37 | struct device *dev; | |
38 | const struct vfio_device_ops *ops; | |
6e97eba8 | 39 | /* |
80c4b92a YH |
40 | * mig_ops/log_ops is a static property of the vfio_device which must |
41 | * be set prior to registering the vfio_device. | |
6e97eba8 YH |
42 | */ |
43 | const struct vfio_migration_ops *mig_ops; | |
80c4b92a | 44 | const struct vfio_log_ops *log_ops; |
0bfc6a4e | 45 | struct vfio_group *group; |
2fd585f4 JG |
46 | struct vfio_device_set *dev_set; |
47 | struct list_head dev_set_list; | |
8cb3d83b | 48 | unsigned int migration_flags; |
421cfe65 | 49 | struct kvm *kvm; |
0bfc6a4e JG |
50 | |
51 | /* Members below here are private, not for driver use */ | |
3c28a761 YL |
52 | unsigned int index; |
53 | struct device device; /* device.kref covers object life circle */ | |
cb9ff3f3 | 54 | refcount_t refcount; /* user count on registered device*/ |
2fd585f4 | 55 | unsigned int open_count; |
0bfc6a4e JG |
56 | struct completion comp; |
57 | struct list_head group_next; | |
8cfc5b60 | 58 | struct list_head iommu_entry; |
4741f2e9 | 59 | struct iommufd_access *iommufd_access; |
2b48f52f | 60 | void (*put_kvm)(struct kvm *kvm); |
a4d1f91d JG |
61 | #if IS_ENABLED(CONFIG_IOMMUFD) |
62 | struct iommufd_device *iommufd_device; | |
63 | bool iommufd_attached; | |
64 | #endif | |
0bfc6a4e JG |
65 | }; |
66 | ||
cba3345c AW |
67 | /** |
68 | * struct vfio_device_ops - VFIO bus driver device callbacks | |
69 | * | |
38e4614c | 70 | * @name: Name of the device driver. |
cb9ff3f3 KT |
71 | * @init: initialize private fields in device structure |
72 | * @release: Reclaim private fields in device structure | |
fae90680 YL |
73 | * @bind_iommufd: Called when binding the device to an iommufd |
74 | * @unbind_iommufd: Opposite of bind_iommufd | |
75 | * @attach_ioas: Called when attaching device to an IOAS/HWPT managed by the | |
76 | * bound iommufd. Undo in unbind_iommufd. | |
2fd585f4 JG |
77 | * @open_device: Called when the first file descriptor is opened for this device |
78 | * @close_device: Opposite of open_device | |
cba3345c AW |
79 | * @read: Perform read(2) on device file descriptor |
80 | * @write: Perform write(2) on device file descriptor | |
81 | * @ioctl: Perform ioctl(2) on device file descriptor, supporting VFIO_DEVICE_* | |
82 | * operations documented below | |
83 | * @mmap: Perform mmap(2) on a region of the device file descriptor | |
13060b64 | 84 | * @request: Request for the bus driver to release the device |
5f3874c2 AW |
85 | * @match: Optional device name match callback (return: 0 for no-match, >0 for |
86 | * match, -errno for abort (ex. match with insufficient or incorrect | |
87 | * additional args) | |
ce4b4657 JG |
88 | * @dma_unmap: Called when userspace unmaps IOVA from the container |
89 | * this device is attached to. | |
445ad495 | 90 | * @device_feature: Optional, fill in the VFIO_DEVICE_FEATURE ioctl |
cba3345c AW |
91 | */ |
92 | struct vfio_device_ops { | |
93 | char *name; | |
cb9ff3f3 KT |
94 | int (*init)(struct vfio_device *vdev); |
95 | void (*release)(struct vfio_device *vdev); | |
a4d1f91d JG |
96 | int (*bind_iommufd)(struct vfio_device *vdev, |
97 | struct iommufd_ctx *ictx, u32 *out_device_id); | |
98 | void (*unbind_iommufd)(struct vfio_device *vdev); | |
99 | int (*attach_ioas)(struct vfio_device *vdev, u32 *pt_id); | |
2fd585f4 JG |
100 | int (*open_device)(struct vfio_device *vdev); |
101 | void (*close_device)(struct vfio_device *vdev); | |
6df62c5b | 102 | ssize_t (*read)(struct vfio_device *vdev, char __user *buf, |
cba3345c | 103 | size_t count, loff_t *ppos); |
6df62c5b | 104 | ssize_t (*write)(struct vfio_device *vdev, const char __user *buf, |
cba3345c | 105 | size_t count, loff_t *size); |
6df62c5b | 106 | long (*ioctl)(struct vfio_device *vdev, unsigned int cmd, |
cba3345c | 107 | unsigned long arg); |
6df62c5b JG |
108 | int (*mmap)(struct vfio_device *vdev, struct vm_area_struct *vma); |
109 | void (*request)(struct vfio_device *vdev, unsigned int count); | |
110 | int (*match)(struct vfio_device *vdev, char *buf); | |
ce4b4657 | 111 | void (*dma_unmap)(struct vfio_device *vdev, u64 iova, u64 length); |
445ad495 JG |
112 | int (*device_feature)(struct vfio_device *device, u32 flags, |
113 | void __user *arg, size_t argsz); | |
6e97eba8 YH |
114 | }; |
115 | ||
a4d1f91d JG |
116 | #if IS_ENABLED(CONFIG_IOMMUFD) |
117 | int vfio_iommufd_physical_bind(struct vfio_device *vdev, | |
118 | struct iommufd_ctx *ictx, u32 *out_device_id); | |
119 | void vfio_iommufd_physical_unbind(struct vfio_device *vdev); | |
120 | int vfio_iommufd_physical_attach_ioas(struct vfio_device *vdev, u32 *pt_id); | |
4741f2e9 JG |
121 | int vfio_iommufd_emulated_bind(struct vfio_device *vdev, |
122 | struct iommufd_ctx *ictx, u32 *out_device_id); | |
123 | void vfio_iommufd_emulated_unbind(struct vfio_device *vdev); | |
124 | int vfio_iommufd_emulated_attach_ioas(struct vfio_device *vdev, u32 *pt_id); | |
a4d1f91d JG |
125 | #else |
126 | #define vfio_iommufd_physical_bind \ | |
127 | ((int (*)(struct vfio_device *vdev, struct iommufd_ctx *ictx, \ | |
128 | u32 *out_device_id)) NULL) | |
129 | #define vfio_iommufd_physical_unbind \ | |
130 | ((void (*)(struct vfio_device *vdev)) NULL) | |
131 | #define vfio_iommufd_physical_attach_ioas \ | |
132 | ((int (*)(struct vfio_device *vdev, u32 *pt_id)) NULL) | |
4741f2e9 JG |
133 | #define vfio_iommufd_emulated_bind \ |
134 | ((int (*)(struct vfio_device *vdev, struct iommufd_ctx *ictx, \ | |
135 | u32 *out_device_id)) NULL) | |
136 | #define vfio_iommufd_emulated_unbind \ | |
137 | ((void (*)(struct vfio_device *vdev)) NULL) | |
138 | #define vfio_iommufd_emulated_attach_ioas \ | |
139 | ((int (*)(struct vfio_device *vdev, u32 *pt_id)) NULL) | |
a4d1f91d JG |
140 | #endif |
141 | ||
6e97eba8 | 142 | /** |
38e4614c SH |
143 | * struct vfio_migration_ops - VFIO bus device driver migration callbacks |
144 | * | |
6e97eba8 YH |
145 | * @migration_set_state: Optional callback to change the migration state for |
146 | * devices that support migration. It's mandatory for | |
147 | * VFIO_DEVICE_FEATURE_MIGRATION migration support. | |
148 | * The returned FD is used for data transfer according to the FSM | |
149 | * definition. The driver is responsible to ensure that FD reaches end | |
150 | * of stream or error whenever the migration FSM leaves a data transfer | |
151 | * state or before close_device() returns. | |
152 | * @migration_get_state: Optional callback to get the migration state for | |
153 | * devices that support migration. It's mandatory for | |
154 | * VFIO_DEVICE_FEATURE_MIGRATION migration support. | |
4e016f96 YH |
155 | * @migration_get_data_size: Optional callback to get the estimated data |
156 | * length that will be required to complete stop copy. It's mandatory for | |
157 | * VFIO_DEVICE_FEATURE_MIGRATION migration support. | |
6e97eba8 YH |
158 | */ |
159 | struct vfio_migration_ops { | |
115dcec6 JG |
160 | struct file *(*migration_set_state)( |
161 | struct vfio_device *device, | |
162 | enum vfio_device_mig_state new_state); | |
163 | int (*migration_get_state)(struct vfio_device *device, | |
164 | enum vfio_device_mig_state *curr_state); | |
4e016f96 YH |
165 | int (*migration_get_data_size)(struct vfio_device *device, |
166 | unsigned long *stop_copy_length); | |
cba3345c AW |
167 | }; |
168 | ||
80c4b92a | 169 | /** |
38e4614c SH |
170 | * struct vfio_log_ops - VFIO bus device driver logging callbacks |
171 | * | |
80c4b92a YH |
172 | * @log_start: Optional callback to ask the device start DMA logging. |
173 | * @log_stop: Optional callback to ask the device stop DMA logging. | |
174 | * @log_read_and_clear: Optional callback to ask the device read | |
175 | * and clear the dirty DMAs in some given range. | |
176 | * | |
177 | * The vfio core implementation of the DEVICE_FEATURE_DMA_LOGGING_ set | |
178 | * of features does not track logging state relative to the device, | |
179 | * therefore the device implementation of vfio_log_ops must handle | |
180 | * arbitrary user requests. This includes rejecting subsequent calls | |
181 | * to log_start without an intervening log_stop, as well as graceful | |
182 | * handling of log_stop and log_read_and_clear from invalid states. | |
183 | */ | |
184 | struct vfio_log_ops { | |
185 | int (*log_start)(struct vfio_device *device, | |
186 | struct rb_root_cached *ranges, u32 nnodes, u64 *page_size); | |
187 | int (*log_stop)(struct vfio_device *device); | |
188 | int (*log_read_and_clear)(struct vfio_device *device, | |
189 | unsigned long iova, unsigned long length, | |
190 | struct iova_bitmap *dirty); | |
191 | }; | |
192 | ||
445ad495 JG |
193 | /** |
194 | * vfio_check_feature - Validate user input for the VFIO_DEVICE_FEATURE ioctl | |
195 | * @flags: Arg from the device_feature op | |
196 | * @argsz: Arg from the device_feature op | |
197 | * @supported_ops: Combination of VFIO_DEVICE_FEATURE_GET and SET the driver | |
198 | * supports | |
199 | * @minsz: Minimum data size the driver accepts | |
200 | * | |
201 | * For use in a driver's device_feature op. Checks that the inputs to the | |
202 | * VFIO_DEVICE_FEATURE ioctl are correct for the driver's feature. Returns 1 if | |
203 | * the driver should execute the get or set, otherwise the relevant | |
204 | * value should be returned. | |
205 | */ | |
206 | static inline int vfio_check_feature(u32 flags, size_t argsz, u32 supported_ops, | |
207 | size_t minsz) | |
208 | { | |
209 | if ((flags & (VFIO_DEVICE_FEATURE_GET | VFIO_DEVICE_FEATURE_SET)) & | |
210 | ~supported_ops) | |
211 | return -EINVAL; | |
212 | if (flags & VFIO_DEVICE_FEATURE_PROBE) | |
213 | return 0; | |
214 | /* Without PROBE one of GET or SET must be requested */ | |
215 | if (!(flags & (VFIO_DEVICE_FEATURE_GET | VFIO_DEVICE_FEATURE_SET))) | |
216 | return -EINVAL; | |
217 | if (argsz < minsz) | |
218 | return -EINVAL; | |
219 | return 1; | |
220 | } | |
221 | ||
cb9ff3f3 KT |
222 | struct vfio_device *_vfio_alloc_device(size_t size, struct device *dev, |
223 | const struct vfio_device_ops *ops); | |
224 | #define vfio_alloc_device(dev_struct, member, dev, ops) \ | |
225 | container_of(_vfio_alloc_device(sizeof(struct dev_struct) + \ | |
226 | BUILD_BUG_ON_ZERO(offsetof( \ | |
227 | struct dev_struct, member)), \ | |
228 | dev, ops), \ | |
229 | struct dev_struct, member) | |
230 | ||
cb9ff3f3 KT |
231 | static inline void vfio_put_device(struct vfio_device *device) |
232 | { | |
3c28a761 | 233 | put_device(&device->device); |
cb9ff3f3 KT |
234 | } |
235 | ||
0bfc6a4e | 236 | int vfio_register_group_dev(struct vfio_device *device); |
c68ea0d0 | 237 | int vfio_register_emulated_iommu_dev(struct vfio_device *device); |
0bfc6a4e | 238 | void vfio_unregister_group_dev(struct vfio_device *device); |
cba3345c | 239 | |
2fd585f4 | 240 | int vfio_assign_device_set(struct vfio_device *device, void *set_id); |
5cd189e4 | 241 | unsigned int vfio_device_set_open_count(struct vfio_device_set *dev_set); |
2fd585f4 | 242 | |
115dcec6 JG |
243 | int vfio_mig_get_next_state(struct vfio_device *device, |
244 | enum vfio_device_mig_state cur_fsm, | |
245 | enum vfio_device_mig_state new_fsm, | |
246 | enum vfio_device_mig_state *next_fsm); | |
247 | ||
6cdd9782 AK |
248 | /* |
249 | * External user API | |
250 | */ | |
d1877e63 | 251 | struct iommu_group *vfio_file_iommu_group(struct file *file); |
4b22ef04 | 252 | bool vfio_file_is_group(struct file *file); |
d1877e63 AW |
253 | bool vfio_file_enforced_coherent(struct file *file); |
254 | void vfio_file_set_kvm(struct file *file, struct kvm *kvm); | |
255 | bool vfio_file_has_dev(struct file *file, struct vfio_device *device); | |
6cdd9782 | 256 | |
2169037d KW |
257 | #define VFIO_PIN_PAGES_MAX_ENTRIES (PAGE_SIZE/sizeof(unsigned long)) |
258 | ||
44abdd16 | 259 | int vfio_pin_pages(struct vfio_device *device, dma_addr_t iova, |
34a255e6 | 260 | int npage, int prot, struct page **pages); |
44abdd16 | 261 | void vfio_unpin_pages(struct vfio_device *device, dma_addr_t iova, int npage); |
8561aa4f | 262 | int vfio_dma_rw(struct vfio_device *device, dma_addr_t iova, |
d1877e63 | 263 | void *data, size_t len, bool write); |
8d46c0cc | 264 | |
d7a8d5ed AW |
265 | /* |
266 | * Sub-module helpers | |
267 | */ | |
268 | struct vfio_info_cap { | |
269 | struct vfio_info_cap_header *buf; | |
270 | size_t size; | |
271 | }; | |
d1877e63 AW |
272 | struct vfio_info_cap_header *vfio_info_cap_add(struct vfio_info_cap *caps, |
273 | size_t size, u16 id, | |
274 | u16 version); | |
275 | void vfio_info_cap_shift(struct vfio_info_cap *caps, size_t offset); | |
d7a8d5ed | 276 | |
d1877e63 AW |
277 | int vfio_info_add_capability(struct vfio_info_cap *caps, |
278 | struct vfio_info_cap_header *cap, size_t size); | |
b3c0a866 | 279 | |
d1877e63 AW |
280 | int vfio_set_irqs_validate_and_prepare(struct vfio_irq_set *hdr, |
281 | int num_irqs, int max_irq_type, | |
282 | size_t *data_size); | |
c747f08a | 283 | |
7e992d69 AM |
284 | /* |
285 | * IRQfd - generic | |
286 | */ | |
287 | struct virqfd { | |
288 | void *opaque; | |
289 | struct eventfd_ctx *eventfd; | |
290 | int (*handler)(void *, void *); | |
291 | void (*thread)(void *, void *); | |
292 | void *data; | |
293 | struct work_struct inject; | |
ac6424b9 | 294 | wait_queue_entry_t wait; |
7e992d69 AM |
295 | poll_table pt; |
296 | struct work_struct shutdown; | |
297 | struct virqfd **pvirqfd; | |
298 | }; | |
299 | ||
d1877e63 AW |
300 | int vfio_virqfd_enable(void *opaque, int (*handler)(void *, void *), |
301 | void (*thread)(void *, void *), void *data, | |
302 | struct virqfd **pvirqfd, int fd); | |
303 | void vfio_virqfd_disable(struct virqfd **pvirqfd); | |
7e992d69 | 304 | |
cba3345c | 305 | #endif /* VFIO_H */ |