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 #if LINUX_VERSION_CODE >= KERNEL_VERSION(4, 0, 0)
28 #define HAVE_VFIO_DEV_REQ_INTERFACE
29 #endif /* kernel version >= 4.0.0 */
30 #endif /* RTE_EAL_VFIO */
34 #include <linux/vfio.h>
36 #define VFIO_DIR "/dev/vfio"
37 #define VFIO_CONTAINER_PATH "/dev/vfio/vfio"
38 #define VFIO_GROUP_FMT "/dev/vfio/%u"
39 #define VFIO_NOIOMMU_GROUP_FMT "/dev/vfio/noiommu-%u"
40 #define VFIO_GET_REGION_ADDR(x) ((uint64_t) x << 40ULL)
41 #define VFIO_GET_REGION_IDX(x) (x >> 40)
42 #define VFIO_NOIOMMU_MODE \
43 "/sys/module/vfio/parameters/enable_unsafe_noiommu_mode"
45 /* NOIOMMU is defined from kernel version 4.5 onwards */
46 #ifdef VFIO_NOIOMMU_IOMMU
47 #define RTE_VFIO_NOIOMMU VFIO_NOIOMMU_IOMMU
49 #define RTE_VFIO_NOIOMMU 8
53 * capabilities are only supported on kernel 4.6+. there were also some API
54 * changes as well, so add a macro to get cap offset.
56 #ifdef VFIO_REGION_INFO_FLAG_CAPS
57 #define RTE_VFIO_INFO_FLAG_CAPS VFIO_REGION_INFO_FLAG_CAPS
58 #define VFIO_CAP_OFFSET(x) (x->cap_offset)
60 #define RTE_VFIO_INFO_FLAG_CAPS (1 << 3)
61 #define VFIO_CAP_OFFSET(x) (x->resv)
62 struct vfio_info_cap_header {
69 /* kernels 4.16+ can map BAR containing MSI-X table */
70 #ifdef VFIO_REGION_INFO_CAP_MSIX_MAPPABLE
71 #define RTE_VFIO_CAP_MSIX_MAPPABLE VFIO_REGION_INFO_CAP_MSIX_MAPPABLE
73 #define RTE_VFIO_CAP_MSIX_MAPPABLE 3
76 #else /* not VFIO_PRESENT */
78 /* we don't need an actual definition, only pointer is used */
79 struct vfio_device_info;
81 #endif /* VFIO_PRESENT */
83 #define RTE_VFIO_DEFAULT_CONTAINER_FD (-1)
86 * Setup vfio_cfg for the device identified by its address.
87 * It discovers the configured I/O MMU groups or sets a new one for the device.
88 * If a new groups is assigned, the DMA mapping is performed.
90 * This function is only relevant to linux and will return
103 * Device information.
108 * >1 if the device cannot be managed this way.
110 int rte_vfio_setup_device(const char *sysfs_base, const char *dev_addr,
111 int *vfio_dev_fd, struct vfio_device_info *device_info);
114 * Release a device mapped to a VFIO-managed I/O MMU group.
116 * This function is only relevant to linux and will return
132 int rte_vfio_release_device(const char *sysfs_base, const char *dev_addr, int fd);
135 * Enable a VFIO-related kmod.
137 * This function is only relevant to linux and will return
141 * kernel module name.
147 int rte_vfio_enable(const char *modname);
150 * Check whether a VFIO-related kmod is enabled.
152 * This function is only relevant to linux and will return
156 * kernel module name.
162 int rte_vfio_is_enabled(const char *modname);
165 * Whether VFIO NOIOMMU mode is enabled.
167 * This function is only relevant to linux and will return
174 int rte_vfio_noiommu_is_enabled(void);
177 * Remove group fd from internal VFIO group fd array/
179 * This function is only relevant to linux and will return
182 * @param vfio_group_fd
190 rte_vfio_clear_group(int vfio_group_fd);
193 * Map memory region for use with VFIO.
195 * @note Require at least one device to be attached at the time of
196 * mapping. DMA maps done via this API will only apply to default
197 * container and will not apply to any of the containers created
198 * via rte_vfio_container_create().
201 * Starting virtual address of memory to be mapped.
204 * Starting IOVA address of memory to be mapped.
207 * Length of memory segment being mapped.
214 rte_vfio_dma_map(uint64_t vaddr, uint64_t iova, uint64_t len);
218 * Unmap memory region from VFIO.
221 * Starting virtual address of memory to be unmapped.
224 * Starting IOVA address of memory to be unmapped.
227 * Length of memory segment being unmapped.
235 rte_vfio_dma_unmap(uint64_t vaddr, uint64_t iova, uint64_t len);
237 * Parse IOMMU group number for a device
239 * This function is only relevant to linux and will return
248 * @param iommu_group_num
253 * 0 for non-existent group or VFIO
257 rte_vfio_get_group_num(const char *sysfs_base,
258 const char *dev_addr, int *iommu_group_num);
261 * Open a new VFIO container fd
263 * This function is only relevant to linux and will return
271 rte_vfio_get_container_fd(void);
274 * Open VFIO group fd or get an existing one
276 * This function is only relevant to linux and will return
279 * @param iommu_group_num
287 rte_vfio_get_group_fd(int iommu_group_num);
290 * Create a new container for device binding.
292 * @note Any newly allocated DPDK memory will not be mapped into these
293 * containers by default, user needs to manage DMA mappings for
294 * any container created by this API.
296 * @note When creating containers using this API, the container will only be
297 * available in the process that has created it. Sharing containers and
298 * devices between multiple processes is not supported.
301 * the container fd if successful
305 rte_vfio_container_create(void);
308 * Destroy the container, unbind all vfio groups within it.
310 * @param container_fd
311 * the container fd to destroy
318 rte_vfio_container_destroy(int container_fd);
321 * Bind a IOMMU group to a container.
323 * @param container_fd
326 * @param iommu_group_num
327 * the iommu group number to bind to container
330 * group fd if successful
334 rte_vfio_container_group_bind(int container_fd, int iommu_group_num);
337 * Unbind a IOMMU group from a container.
339 * @param container_fd
340 * the container fd of container
342 * @param iommu_group_num
343 * the iommu group number to delete from container
350 rte_vfio_container_group_unbind(int container_fd, int iommu_group_num);
353 * Perform DMA mapping for devices in a container.
355 * @param container_fd
356 * the specified container fd. Use RTE_VFIO_DEFAULT_CONTAINER_FD to
357 * use the default container.
360 * Starting virtual address of memory to be mapped.
363 * Starting IOVA address of memory to be mapped.
366 * Length of memory segment being mapped.
373 rte_vfio_container_dma_map(int container_fd, uint64_t vaddr,
374 uint64_t iova, uint64_t len);
377 * Perform DMA unmapping for devices in a container.
379 * @param container_fd
380 * the specified container fd. Use RTE_VFIO_DEFAULT_CONTAINER_FD to
381 * use the default container.
384 * Starting virtual address of memory to be unmapped.
387 * Starting IOVA address of memory to be unmapped.
390 * Length of memory segment being unmapped.
397 rte_vfio_container_dma_unmap(int container_fd, uint64_t vaddr,
398 uint64_t iova, uint64_t len);
404 #endif /* _RTE_VFIO_H_ */