DPDK  19.05.0
rte_vfio.h
Go to the documentation of this file.
1 /* SPDX-License-Identifier: BSD-3-Clause
2  * Copyright(c) 2017 6WIND S.A.
3  */
4 
5 #ifndef _RTE_VFIO_H_
6 #define _RTE_VFIO_H_
7 
13 #ifdef __cplusplus
14 extern "C" {
15 #endif
16 
17 #include <stdint.h>
18 
19 /*
20  * determine if VFIO is present on the system
21  */
22 #if !defined(VFIO_PRESENT) && defined(RTE_EAL_VFIO)
23 #include <linux/version.h>
24 #if LINUX_VERSION_CODE >= KERNEL_VERSION(3, 6, 0)
25 #define VFIO_PRESENT
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 */
31 
32 #ifdef VFIO_PRESENT
33 
34 #include <linux/vfio.h>
35 
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"
44 
45 /* NOIOMMU is defined from kernel version 4.5 onwards */
46 #ifdef VFIO_NOIOMMU_IOMMU
47 #define RTE_VFIO_NOIOMMU VFIO_NOIOMMU_IOMMU
48 #else
49 #define RTE_VFIO_NOIOMMU 8
50 #endif
51 
52 /*
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.
55  */
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)
59 #else
60 #define RTE_VFIO_INFO_FLAG_CAPS (1 << 3)
61 #define VFIO_CAP_OFFSET(x) (x->resv)
62 struct vfio_info_cap_header {
63  uint16_t id;
64  uint16_t version;
65  uint32_t next;
66 };
67 #endif
68 
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
72 #else
73 #define RTE_VFIO_CAP_MSIX_MAPPABLE 3
74 #endif
75 
76 #else /* not VFIO_PRESENT */
77 
78 /* we don't need an actual definition, only pointer is used */
79 struct vfio_device_info;
80 
81 #endif /* VFIO_PRESENT */
82 
83 #define RTE_VFIO_DEFAULT_CONTAINER_FD (-1)
84 
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);
112 
132 int rte_vfio_release_device(const char *sysfs_base, const char *dev_addr, int fd);
133 
147 int rte_vfio_enable(const char *modname);
148 
162 int rte_vfio_is_enabled(const char *modname);
163 
175 
189 int
190 rte_vfio_clear_group(int vfio_group_fd);
191 
213 int
214 rte_vfio_dma_map(uint64_t vaddr, uint64_t iova, uint64_t len);
215 
216 
234 int
235 rte_vfio_dma_unmap(uint64_t vaddr, uint64_t iova, uint64_t len);
256 int
257 rte_vfio_get_group_num(const char *sysfs_base,
258  const char *dev_addr, int *iommu_group_num);
259 
270 int
272 
286 int
287 rte_vfio_get_group_fd(int iommu_group_num);
288 
304 int
306 
317 int
318 rte_vfio_container_destroy(int container_fd);
319 
333 int
334 rte_vfio_container_group_bind(int container_fd, int iommu_group_num);
335 
349 int
350 rte_vfio_container_group_unbind(int container_fd, int iommu_group_num);
351 
372 int
373 rte_vfio_container_dma_map(int container_fd, uint64_t vaddr,
374  uint64_t iova, uint64_t len);
375 
396 int
397 rte_vfio_container_dma_unmap(int container_fd, uint64_t vaddr,
398  uint64_t iova, uint64_t len);
399 
400 #ifdef __cplusplus
401 }
402 #endif
403 
404 #endif /* _RTE_VFIO_H_ */