lib/librte_eal/include/rte_vfio.h

   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
   8 /**
   9  * @file
  10  * RTE VFIO. This library provides various VFIO related utility functions.
  11  */
  12
  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
  85 /**
  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.
  89  *
  90  * This function is only relevant to linux and will return
  91  * an error on BSD.
  92  *
  93  * @param sysfs_base
  94  *   sysfs path prefix.
  95  *
  96  * @param dev_addr
  97  *   device location.
  98  *
  99  * @param vfio_dev_fd
 100  *   VFIO fd.
 101  *
 102  * @param device_info
 103  *   Device information.
 104  *
 105  * @return
 106  *   0 on success.
 107  *   <0 on failure.
 108  *   >1 if the device cannot be managed this way.
 109  */
 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
 113 /**
 114  * Release a device mapped to a VFIO-managed I/O MMU group.
 115  *
 116  * This function is only relevant to linux and will return
 117  * an error on BSD.
 118  *
 119  * @param sysfs_base
 120  *   sysfs path prefix.
 121  *
 122  * @param dev_addr
 123  *   device location.
 124  *
 125  * @param fd
 126  *   VFIO fd.
 127  *
 128  * @return
 129  *   0 on success.
 130  *   <0 on failure.
 131  */
 132 int rte_vfio_release_device(const char *sysfs_base, const char *dev_addr, int fd);
 133
 134 /**
 135  * Enable a VFIO-related kmod.
 136  *
 137  * This function is only relevant to linux and will return
 138  * an error on BSD.
 139  *
 140  * @param modname
 141  *   kernel module name.
 142  *
 143  * @return
 144  *   0 on success.
 145  *   <0 on failure.
 146  */
 147 int rte_vfio_enable(const char *modname);
 148
 149 /**
 150  * Check whether a VFIO-related kmod is enabled.
 151  *
 152  * This function is only relevant to linux and will return
 153  * an error on BSD.
 154  *
 155  * @param modname
 156  *   kernel module name.
 157  *
 158  * @return
 159  *   1 if true.
 160  *   0 otherwise.
 161  */
 162 int rte_vfio_is_enabled(const char *modname);
 163
 164 /**
 165  * Whether VFIO NOIOMMU mode is enabled.
 166  *
 167  * This function is only relevant to linux and will return
 168  * an error on BSD.
 169  *
 170  * @return
 171  *   1 if true.
 172  *   0 if false.
 173  *   <0 for errors.
 174  */
 175 int rte_vfio_noiommu_is_enabled(void);
 176
 177 /**
 178  * Remove group fd from internal VFIO group fd array/
 179  *
 180  * This function is only relevant to linux and will return
 181  * an error on BSD.
 182  *
 183  * @param vfio_group_fd
 184  *   VFIO Group FD.
 185  *
 186  * @return
 187  *   0 on success.
 188  *   <0 on failure.
 189  */
 190 int
 191 rte_vfio_clear_group(int vfio_group_fd);
 192
 193 /**
 194  * Parse IOMMU group number for a device
 195  *
 196  * This function is only relevant to linux and will return
 197  * an error on BSD.
 198  *
 199  * @param sysfs_base
 200  *   sysfs path prefix.
 201  *
 202  * @param dev_addr
 203  *   device location.
 204  *
 205  * @param iommu_group_num
 206  *   iommu group number
 207  *
 208  * @return
 209  *  >0 on success
 210  *   0 for non-existent group or VFIO
 211  *  <0 for errors
 212  */
 213 int
 214 rte_vfio_get_group_num(const char *sysfs_base,
 215                       const char *dev_addr, int *iommu_group_num);
 216
 217 /**
 218  * Open a new VFIO container fd
 219  *
 220  * This function is only relevant to linux and will return
 221  * an error on BSD.
 222  *
 223  * @return
 224  *  > 0 container fd
 225  *  < 0 for errors
 226  */
 227 int
 228 rte_vfio_get_container_fd(void);
 229
 230 /**
 231  * Open VFIO group fd or get an existing one
 232  *
 233  * This function is only relevant to linux and will return
 234  * an error on BSD.
 235  *
 236  * @param iommu_group_num
 237  *   iommu group number
 238  *
 239  * @return
 240  *  > 0 group fd
 241  *  < 0 for errors
 242  */
 243 int
 244 rte_vfio_get_group_fd(int iommu_group_num);
 245
 246 /**
 247  * Create a new container for device binding.
 248  *
 249  * @note Any newly allocated DPDK memory will not be mapped into these
 250  *       containers by default, user needs to manage DMA mappings for
 251  *       any container created by this API.
 252  *
 253  * @note When creating containers using this API, the container will only be
 254  *       available in the process that has created it. Sharing containers and
 255  *       devices between multiple processes is not supported.
 256  *
 257  * @return
 258  *   the container fd if successful
 259  *   <0 if failed
 260  */
 261 int
 262 rte_vfio_container_create(void);
 263
 264 /**
 265  * Destroy the container, unbind all vfio groups within it.
 266  *
 267  * @param container_fd
 268  *   the container fd to destroy
 269  *
 270  * @return
 271  *    0 if successful
 272  *   <0 if failed
 273  */
 274 int
 275 rte_vfio_container_destroy(int container_fd);
 276
 277 /**
 278  * Bind a IOMMU group to a container.
 279  *
 280  * @param container_fd
 281  *   the container's fd
 282  *
 283  * @param iommu_group_num
 284  *   the iommu group number to bind to container
 285  *
 286  * @return
 287  *   group fd if successful
 288  *   <0 if failed
 289  */
 290 int
 291 rte_vfio_container_group_bind(int container_fd, int iommu_group_num);
 292
 293 /**
 294  * Unbind a IOMMU group from a container.
 295  *
 296  * @param container_fd
 297  *   the container fd of container
 298  *
 299  * @param iommu_group_num
 300  *   the iommu group number to delete from container
 301  *
 302  * @return
 303  *    0 if successful
 304  *   <0 if failed
 305  */
 306 int
 307 rte_vfio_container_group_unbind(int container_fd, int iommu_group_num);
 308
 309 /**
 310  * Perform DMA mapping for devices in a container.
 311  *
 312  * @param container_fd
 313  *   the specified container fd. Use RTE_VFIO_DEFAULT_CONTAINER_FD to
 314  *   use the default container.
 315  *
 316  * @param vaddr
 317  *   Starting virtual address of memory to be mapped.
 318  *
 319  * @param iova
 320  *   Starting IOVA address of memory to be mapped.
 321  *
 322  * @param len
 323  *   Length of memory segment being mapped.
 324  *
 325  * @return
 326  *    0 if successful
 327  *   <0 if failed
 328  */
 329 int
 330 rte_vfio_container_dma_map(int container_fd, uint64_t vaddr,
 331                 uint64_t iova, uint64_t len);
 332
 333 /**
 334  * Perform DMA unmapping for devices in a container.
 335  *
 336  * @param container_fd
 337  *   the specified container fd. Use RTE_VFIO_DEFAULT_CONTAINER_FD to
 338  *   use the default container.
 339  *
 340  * @param vaddr
 341  *   Starting virtual address of memory to be unmapped.
 342  *
 343  * @param iova
 344  *   Starting IOVA address of memory to be unmapped.
 345  *
 346  * @param len
 347  *   Length of memory segment being unmapped.
 348  *
 349  * @return
 350  *    0 if successful
 351  *   <0 if failed
 352  */
 353 int
 354 rte_vfio_container_dma_unmap(int container_fd, uint64_t vaddr,
 355                 uint64_t iova, uint64_t len);
 356
 357 #ifdef __cplusplus
 358 }
 359 #endif
 360
 361 #endif /* _RTE_VFIO_H_ */