lib/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 <stdbool.h>
  18 #include <stdint.h>
  19
  20 /*
  21  * determine if VFIO is present on the system
  22  */
  23 #if !defined(VFIO_PRESENT) && defined(RTE_EAL_VFIO)
  24 #include <linux/version.h>
  25 #if LINUX_VERSION_CODE >= KERNEL_VERSION(3, 6, 0)
  26 #define VFIO_PRESENT
  27 #endif /* kernel version >= 3.6.0 */
  28 #if LINUX_VERSION_CODE >= KERNEL_VERSION(4, 0, 0)
  29 #define HAVE_VFIO_DEV_REQ_INTERFACE
  30 #endif /* kernel version >= 4.0.0 */
  31 #endif /* RTE_EAL_VFIO */
  32
  33 #ifdef VFIO_PRESENT
  34
  35 #include <linux/vfio.h>
  36
  37 #define VFIO_DIR "/dev/vfio"
  38 #define VFIO_CONTAINER_PATH "/dev/vfio/vfio"
  39 #define VFIO_GROUP_FMT "/dev/vfio/%u"
  40 #define VFIO_NOIOMMU_GROUP_FMT "/dev/vfio/noiommu-%u"
  41 #define VFIO_GET_REGION_ADDR(x) ((uint64_t) x << 40ULL)
  42 #define VFIO_GET_REGION_IDX(x) (x >> 40)
  43 #define VFIO_NOIOMMU_MODE      \
  44         "/sys/module/vfio/parameters/enable_unsafe_noiommu_mode"
  45
  46 /* NOIOMMU is defined from kernel version 4.5 onwards */
  47 #ifdef VFIO_NOIOMMU_IOMMU
  48 #define RTE_VFIO_NOIOMMU VFIO_NOIOMMU_IOMMU
  49 #else
  50 #define RTE_VFIO_NOIOMMU 8
  51 #endif
  52
  53 /*
  54  * capabilities are only supported on kernel 4.6+. there were also some API
  55  * changes as well, so add a macro to get cap offset.
  56  */
  57 #ifdef VFIO_REGION_INFO_FLAG_CAPS
  58 #define RTE_VFIO_INFO_FLAG_CAPS VFIO_REGION_INFO_FLAG_CAPS
  59 #define VFIO_CAP_OFFSET(x) (x->cap_offset)
  60 #else
  61 #define RTE_VFIO_INFO_FLAG_CAPS (1 << 3)
  62 #define VFIO_CAP_OFFSET(x) (x->resv)
  63 struct vfio_info_cap_header {
  64         uint16_t id;
  65         uint16_t version;
  66         uint32_t next;
  67 };
  68 #endif
  69
  70 /* kernels 4.16+ can map BAR containing MSI-X table */
  71 #ifdef VFIO_REGION_INFO_CAP_MSIX_MAPPABLE
  72 #define RTE_VFIO_CAP_MSIX_MAPPABLE VFIO_REGION_INFO_CAP_MSIX_MAPPABLE
  73 #else
  74 #define RTE_VFIO_CAP_MSIX_MAPPABLE 3
  75 #endif
  76
  77 #else /* not VFIO_PRESENT */
  78
  79 /* we don't need an actual definition, only pointer is used */
  80 struct vfio_device_info;
  81
  82 #endif /* VFIO_PRESENT */
  83
  84 #define RTE_VFIO_DEFAULT_CONTAINER_FD (-1)
  85
  86 /**
  87  * Setup vfio_cfg for the device identified by its address.
  88  * It discovers the configured I/O MMU groups or sets a new one for the device.
  89  * If a new groups is assigned, the DMA mapping is performed.
  90  *
  91  * This function is only relevant to linux and will return
  92  * an error on BSD.
  93  *
  94  * @param sysfs_base
  95  *   sysfs path prefix.
  96  *
  97  * @param dev_addr
  98  *   device location.
  99  *
 100  * @param vfio_dev_fd
 101  *   VFIO fd.
 102  *
 103  * @param device_info
 104  *   Device information.
 105  *
 106  * @return
 107  *   0 on success.
 108  *   <0 on failure.
 109  *   >1 if the device cannot be managed this way.
 110  */
 111 int rte_vfio_setup_device(const char *sysfs_base, const char *dev_addr,
 112                 int *vfio_dev_fd, struct vfio_device_info *device_info);
 113
 114 /**
 115  * Release a device mapped to a VFIO-managed I/O MMU group.
 116  *
 117  * This function is only relevant to linux and will return
 118  * an error on BSD.
 119  *
 120  * @param sysfs_base
 121  *   sysfs path prefix.
 122  *
 123  * @param dev_addr
 124  *   device location.
 125  *
 126  * @param fd
 127  *   VFIO fd.
 128  *
 129  * @return
 130  *   0 on success.
 131  *   <0 on failure.
 132  */
 133 int rte_vfio_release_device(const char *sysfs_base, const char *dev_addr, int fd);
 134
 135 /**
 136  * Enable a VFIO-related kmod.
 137  *
 138  * This function is only relevant to linux and will return
 139  * an error on BSD.
 140  *
 141  * @param modname
 142  *   kernel module name.
 143  *
 144  * @return
 145  *   0 on success.
 146  *   <0 on failure.
 147  */
 148 int rte_vfio_enable(const char *modname);
 149
 150 /**
 151  * Check whether a VFIO-related kmod is enabled.
 152  *
 153  * This function is only relevant to linux and will return
 154  * an error on BSD.
 155  *
 156  * @param modname
 157  *   kernel module name.
 158  *
 159  * @return
 160  *   1 if true.
 161  *   0 otherwise.
 162  */
 163 int rte_vfio_is_enabled(const char *modname);
 164
 165 /**
 166  * Whether VFIO NOIOMMU mode is enabled.
 167  *
 168  * This function is only relevant to linux and will return
 169  * an error on BSD.
 170  *
 171  * @return
 172  *   1 if true.
 173  *   0 if false.
 174  *   <0 for errors.
 175  */
 176 int rte_vfio_noiommu_is_enabled(void);
 177
 178 /**
 179  * Remove group fd from internal VFIO group fd array/
 180  *
 181  * This function is only relevant to linux and will return
 182  * an error on BSD.
 183  *
 184  * @param vfio_group_fd
 185  *   VFIO Group FD.
 186  *
 187  * @return
 188  *   0 on success.
 189  *   <0 on failure.
 190  */
 191 int
 192 rte_vfio_clear_group(int vfio_group_fd);
 193
 194 /**
 195  * Parse IOMMU group number for a device
 196  *
 197  * This function is only relevant to linux and will return
 198  * an error on BSD.
 199  *
 200  * @param sysfs_base
 201  *   sysfs path prefix.
 202  *
 203  * @param dev_addr
 204  *   device location.
 205  *
 206  * @param iommu_group_num
 207  *   iommu group number
 208  *
 209  * @return
 210  *  >0 on success
 211  *   0 for non-existent group or VFIO
 212  *  <0 for errors
 213  */
 214 int
 215 rte_vfio_get_group_num(const char *sysfs_base,
 216                       const char *dev_addr, int *iommu_group_num);
 217
 218 /**
 219  * Open a new VFIO container fd
 220  *
 221  * This function is only relevant to linux and will return
 222  * an error on BSD.
 223  *
 224  * @return
 225  *  > 0 container fd
 226  *  < 0 for errors
 227  */
 228 int
 229 rte_vfio_get_container_fd(void);
 230
 231 /**
 232  * Open VFIO group fd or get an existing one
 233  *
 234  * This function is only relevant to linux and will return
 235  * an error on BSD.
 236  *
 237  * @param iommu_group_num
 238  *   iommu group number
 239  *
 240  * @return
 241  *  > 0 group fd
 242  *  < 0 for errors
 243  */
 244 int
 245 rte_vfio_get_group_fd(int iommu_group_num);
 246
 247 /**
 248  * Create a new container for device binding.
 249  *
 250  * @note Any newly allocated DPDK memory will not be mapped into these
 251  *       containers by default, user needs to manage DMA mappings for
 252  *       any container created by this API.
 253  *
 254  * @note When creating containers using this API, the container will only be
 255  *       available in the process that has created it. Sharing containers and
 256  *       devices between multiple processes is not supported.
 257  *
 258  * @return
 259  *   the container fd if successful
 260  *   <0 if failed
 261  */
 262 int
 263 rte_vfio_container_create(void);
 264
 265 /**
 266  * Destroy the container, unbind all vfio groups within it.
 267  *
 268  * @param container_fd
 269  *   the container fd to destroy
 270  *
 271  * @return
 272  *    0 if successful
 273  *   <0 if failed
 274  */
 275 int
 276 rte_vfio_container_destroy(int container_fd);
 277
 278 /**
 279  * Bind a IOMMU group to a container.
 280  *
 281  * @param container_fd
 282  *   the container's fd
 283  *
 284  * @param iommu_group_num
 285  *   the iommu group number to bind to container
 286  *
 287  * @return
 288  *   group fd if successful
 289  *   <0 if failed
 290  */
 291 int
 292 rte_vfio_container_group_bind(int container_fd, int iommu_group_num);
 293
 294 /**
 295  * Unbind a IOMMU group from a container.
 296  *
 297  * @param container_fd
 298  *   the container fd of container
 299  *
 300  * @param iommu_group_num
 301  *   the iommu group number to delete from container
 302  *
 303  * @return
 304  *    0 if successful
 305  *   <0 if failed
 306  */
 307 int
 308 rte_vfio_container_group_unbind(int container_fd, int iommu_group_num);
 309
 310 /**
 311  * Perform DMA mapping for devices in a container.
 312  *
 313  * @param container_fd
 314  *   the specified container fd. Use RTE_VFIO_DEFAULT_CONTAINER_FD to
 315  *   use the default container.
 316  *
 317  * @param vaddr
 318  *   Starting virtual address of memory to be mapped.
 319  *
 320  * @param iova
 321  *   Starting IOVA address of memory to be mapped.
 322  *
 323  * @param len
 324  *   Length of memory segment being mapped.
 325  *
 326  * @return
 327  *    0 if successful
 328  *   <0 if failed
 329  */
 330 int
 331 rte_vfio_container_dma_map(int container_fd, uint64_t vaddr,
 332                 uint64_t iova, uint64_t len);
 333
 334 /**
 335  * Perform DMA unmapping for devices in a container.
 336  *
 337  * @param container_fd
 338  *   the specified container fd. Use RTE_VFIO_DEFAULT_CONTAINER_FD to
 339  *   use the default container.
 340  *
 341  * @param vaddr
 342  *   Starting virtual address of memory to be unmapped.
 343  *
 344  * @param iova
 345  *   Starting IOVA address of memory to be unmapped.
 346  *
 347  * @param len
 348  *   Length of memory segment being unmapped.
 349  *
 350  * @return
 351  *    0 if successful
 352  *   <0 if failed
 353  */
 354 int
 355 rte_vfio_container_dma_unmap(int container_fd, uint64_t vaddr,
 356                 uint64_t iova, uint64_t len);
 357
 358 #ifdef __cplusplus
 359 }
 360 #endif
 361
 362 #endif /* _RTE_VFIO_H_ */