1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2017 6WIND S.A.
10 * RTE VFIO. This library provides various VFIO related utility functions.
20 * determine if VFIO is present on the system
22 #if !defined(VFIO_PRESENT) && defined(RTE_EAL_VFIO)
23 #include <linux/version.h>
24 #if LINUX_VERSION_CODE >= KERNEL_VERSION(3, 6, 0)
26 #endif /* kernel version >= 3.6.0 */
27 #endif /* RTE_EAL_VFIO */
31 #include <linux/vfio.h>
33 #define VFIO_DIR "/dev/vfio"
34 #define VFIO_CONTAINER_PATH "/dev/vfio/vfio"
35 #define VFIO_GROUP_FMT "/dev/vfio/%u"
36 #define VFIO_NOIOMMU_GROUP_FMT "/dev/vfio/noiommu-%u"
37 #define VFIO_GET_REGION_ADDR(x) ((uint64_t) x << 40ULL)
38 #define VFIO_GET_REGION_IDX(x) (x >> 40)
39 #define VFIO_NOIOMMU_MODE \
40 "/sys/module/vfio/parameters/enable_unsafe_noiommu_mode"
42 /* NOIOMMU is defined from kernel version 4.5 onwards */
43 #ifdef VFIO_NOIOMMU_IOMMU
44 #define RTE_VFIO_NOIOMMU VFIO_NOIOMMU_IOMMU
46 #define RTE_VFIO_NOIOMMU 8
50 * capabilities are only supported on kernel 4.6+. there were also some API
51 * changes as well, so add a macro to get cap offset.
53 #ifdef VFIO_REGION_INFO_FLAG_CAPS
54 #define RTE_VFIO_INFO_FLAG_CAPS VFIO_REGION_INFO_FLAG_CAPS
55 #define VFIO_CAP_OFFSET(x) (x->cap_offset)
57 #define RTE_VFIO_INFO_FLAG_CAPS (1 << 3)
58 #define VFIO_CAP_OFFSET(x) (x->resv)
59 struct vfio_info_cap_header {
66 /* kernels 4.16+ can map BAR containing MSI-X table */
67 #ifdef VFIO_REGION_INFO_CAP_MSIX_MAPPABLE
68 #define RTE_VFIO_CAP_MSIX_MAPPABLE VFIO_REGION_INFO_CAP_MSIX_MAPPABLE
70 #define RTE_VFIO_CAP_MSIX_MAPPABLE 3
73 #else /* not VFIO_PRESENT */
75 /* we don't need an actual definition, only pointer is used */
76 struct vfio_device_info;
78 #endif /* VFIO_PRESENT */
81 * Setup vfio_cfg for the device identified by its address.
82 * It discovers the configured I/O MMU groups or sets a new one for the device.
83 * If a new groups is assigned, the DMA mapping is performed.
85 * This function is only relevant to linux and will return
103 * >1 if the device cannot be managed this way.
105 int rte_vfio_setup_device(const char *sysfs_base, const char *dev_addr,
106 int *vfio_dev_fd, struct vfio_device_info *device_info);
109 * Release a device mapped to a VFIO-managed I/O MMU group.
111 * This function is only relevant to linux and will return
127 int rte_vfio_release_device(const char *sysfs_base, const char *dev_addr, int fd);
130 * Enable a VFIO-related kmod.
132 * This function is only relevant to linux and will return
136 * kernel module name.
142 int rte_vfio_enable(const char *modname);
145 * Check whether a VFIO-related kmod is enabled.
147 * This function is only relevant to linux and will return
151 * kernel module name.
157 int rte_vfio_is_enabled(const char *modname);
160 * Whether VFIO NOIOMMU mode is enabled.
162 * This function is only relevant to linux and will return
169 int rte_vfio_noiommu_is_enabled(void);
172 * Remove group fd from internal VFIO group fd array/
174 * This function is only relevant to linux and will return
177 * @param vfio_group_fd
185 rte_vfio_clear_group(int vfio_group_fd);
188 * Map memory region for use with VFIO.
190 * @note Require at least one device to be attached at the time of
191 * mapping. DMA maps done via this API will only apply to default
192 * container and will not apply to any of the containers created
193 * via rte_vfio_container_create().
196 * Starting virtual address of memory to be mapped.
199 * Starting IOVA address of memory to be mapped.
202 * Length of memory segment being mapped.
209 rte_vfio_dma_map(uint64_t vaddr, uint64_t iova, uint64_t len);
213 * Unmap memory region from VFIO.
216 * Starting virtual address of memory to be unmapped.
219 * Starting IOVA address of memory to be unmapped.
222 * Length of memory segment being unmapped.
230 rte_vfio_dma_unmap(uint64_t vaddr, uint64_t iova, uint64_t len);
232 * Parse IOMMU group number for a device
234 * This function is only relevant to linux and will return
243 * @param iommu_group_num
248 * 0 for non-existent group or VFIO
252 rte_vfio_get_group_num(const char *sysfs_base,
253 const char *dev_addr, int *iommu_group_num);
256 * Open VFIO container fd or get an existing one
258 * This function is only relevant to linux and will return
266 rte_vfio_get_container_fd(void);
269 * Open VFIO group fd or get an existing one
271 * This function is only relevant to linux and will return
274 * @param iommu_group_num
282 rte_vfio_get_group_fd(int iommu_group_num);
285 * Create a new container for device binding.
287 * @note Any newly allocated DPDK memory will not be mapped into these
288 * containers by default, user needs to manage DMA mappings for
289 * any container created by this API.
292 * the container fd if successful
296 rte_vfio_container_create(void);
299 * Destroy the container, unbind all vfio groups within it.
301 * @param container_fd
302 * the container fd to destroy
309 rte_vfio_container_destroy(int container_fd);
312 * Bind a IOMMU group to a container.
314 * @param container_fd
317 * @param iommu_group_num
318 * the iommu group number to bind to container
321 * group fd if successful
325 rte_vfio_container_group_bind(int container_fd, int iommu_group_num);
328 * Unbind a IOMMU group from a container.
330 * @param container_fd
331 * the container fd of container
333 * @param iommu_group_num
334 * the iommu group number to delete from container
341 rte_vfio_container_group_unbind(int container_fd, int iommu_group_num);
344 * Perform DMA mapping for devices in a container.
346 * @param container_fd
347 * the specified container fd
350 * Starting virtual address of memory to be mapped.
353 * Starting IOVA address of memory to be mapped.
356 * Length of memory segment being mapped.
363 rte_vfio_container_dma_map(int container_fd, uint64_t vaddr,
364 uint64_t iova, uint64_t len);
367 * Perform DMA unmapping for devices in a container.
369 * @param container_fd
370 * the specified container fd
373 * Starting virtual address of memory to be unmapped.
376 * Starting IOVA address of memory to be unmapped.
379 * Length of memory segment being unmapped.
386 rte_vfio_container_dma_unmap(int container_fd, uint64_t vaddr,
387 uint64_t iova, uint64_t len);
393 #endif /* _RTE_VFIO_H_ */