rte_vfio.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-3-Clause
 * Copyright(c) 2017 6WIND S.A.
 */

#ifndef _RTE_VFIO_H_
#define _RTE_VFIO_H_

#ifdef __cplusplus
extern "C" {
#endif

#include <stdbool.h>
#include <stdint.h>

#include <rte_compat.h>

/*
 * determine if VFIO is present on the system
 */
#if !defined(VFIO_PRESENT) && defined(RTE_EAL_VFIO)
#include <linux/version.h>
#if LINUX_VERSION_CODE >= KERNEL_VERSION(3, 6, 0)
#define VFIO_PRESENT
#endif /* kernel version >= 3.6.0 */
#if LINUX_VERSION_CODE >= KERNEL_VERSION(4, 0, 0)
#define HAVE_VFIO_DEV_REQ_INTERFACE
#endif /* kernel version >= 4.0.0 */
#endif /* RTE_EAL_VFIO */

#ifdef VFIO_PRESENT

#include <linux/vfio.h>

#define VFIO_DIR "/dev/vfio"
#define VFIO_CONTAINER_PATH "/dev/vfio/vfio"
#define VFIO_GROUP_FMT "/dev/vfio/%u"
#define VFIO_NOIOMMU_GROUP_FMT "/dev/vfio/noiommu-%u"
#define VFIO_GET_REGION_IDX(x) (x >> 40)
#define VFIO_NOIOMMU_MODE      \
    "/sys/module/vfio/parameters/enable_unsafe_noiommu_mode"

/* NOIOMMU is defined from kernel version 4.5 onwards */
#ifdef VFIO_NOIOMMU_IOMMU
#define RTE_VFIO_NOIOMMU VFIO_NOIOMMU_IOMMU
#else
#define RTE_VFIO_NOIOMMU 8
#endif

/*
 * capabilities are only supported on kernel 4.6+. there were also some API
 * changes as well, so add a macro to get cap offset.
 */
#ifdef VFIO_REGION_INFO_FLAG_CAPS
#define RTE_VFIO_INFO_FLAG_CAPS VFIO_REGION_INFO_FLAG_CAPS
#define VFIO_CAP_OFFSET(x) (x->cap_offset)
#else
#define RTE_VFIO_INFO_FLAG_CAPS (1 << 3)
#define VFIO_CAP_OFFSET(x) (x->resv)
struct vfio_info_cap_header {
    uint16_t id;
    uint16_t version;
    uint32_t next;
};
#endif

/* kernels 4.16+ can map BAR containing MSI-X table */
#ifdef VFIO_REGION_INFO_CAP_MSIX_MAPPABLE
#define RTE_VFIO_CAP_MSIX_MAPPABLE VFIO_REGION_INFO_CAP_MSIX_MAPPABLE
#else
#define RTE_VFIO_CAP_MSIX_MAPPABLE 3
#endif

/* VFIO_DEVICE_FEATURE is defined for kernel version 5.7 and newer. */
#ifdef  VFIO_DEVICE_FEATURE
#define RTE_VFIO_DEVICE_FEATURE VFIO_DEVICE_FEATURE
#else
#define RTE_VFIO_DEVICE_FEATURE _IO(VFIO_TYPE, VFIO_BASE + 17)
struct vfio_device_feature {
    __u32   argsz;
    __u32   flags;
#define VFIO_DEVICE_FEATURE_MASK    (0xffff) /* 16-bit feature index */
#define VFIO_DEVICE_FEATURE_GET     (1 << 16) /* Get feature into data[] */
#define VFIO_DEVICE_FEATURE_SET     (1 << 17) /* Set feature from data[] */
#define VFIO_DEVICE_FEATURE_PROBE   (1 << 18) /* Probe feature support */
    __u8    data[];
};
#endif

#ifdef  VFIO_DEVICE_FEATURE_BUS_MASTER
#define RTE_VFIO_DEVICE_FEATURE_BUS_MASTER  VFIO_DEVICE_FEATURE_BUS_MASTER
#else
#define RTE_VFIO_DEVICE_FEATURE_BUS_MASTER  10
struct vfio_device_feature_bus_master {
    __u32 op;
#define VFIO_DEVICE_FEATURE_CLEAR_MASTER    0   /* Clear Bus Master */
#define VFIO_DEVICE_FEATURE_SET_MASTER      1   /* Set Bus Master */
};
#endif

#else /* not VFIO_PRESENT */

/* we don't need an actual definition, only pointer is used */
struct vfio_device_info;

#endif /* VFIO_PRESENT */

#define RTE_VFIO_DEFAULT_CONTAINER_FD (-1)

int rte_vfio_setup_device(const char *sysfs_base, const char *dev_addr,
        int *vfio_dev_fd, struct vfio_device_info *device_info);

int rte_vfio_release_device(const char *sysfs_base, const char *dev_addr, int fd);

int rte_vfio_enable(const char *modname);

int rte_vfio_is_enabled(const char *modname);

int rte_vfio_noiommu_is_enabled(void);

int
rte_vfio_clear_group(int vfio_group_fd);

int
rte_vfio_get_group_num(const char *sysfs_base,
              const char *dev_addr, int *iommu_group_num);

__rte_experimental
int
rte_vfio_get_device_info(const char *sysfs_base, const char *dev_addr,
        int *vfio_dev_fd, struct vfio_device_info *device_info);

int
rte_vfio_get_container_fd(void);

int
rte_vfio_get_group_fd(int iommu_group_num);

int
rte_vfio_container_create(void);

int
rte_vfio_container_destroy(int container_fd);

int
rte_vfio_container_group_bind(int container_fd, int iommu_group_num);

int
rte_vfio_container_group_unbind(int container_fd, int iommu_group_num);

int
rte_vfio_container_dma_map(int container_fd, uint64_t vaddr,
        uint64_t iova, uint64_t len);

int
rte_vfio_container_dma_unmap(int container_fd, uint64_t vaddr,
        uint64_t iova, uint64_t len);

#ifdef __cplusplus
}
#endif

#endif /* _RTE_VFIO_H_ */