lib/librte_eal/linuxapp/eal/eal_vfio.h

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
   5  *   All rights reserved.
   6  *
   7  *   Redistribution and use in source and binary forms, with or without
   8  *   modification, are permitted provided that the following conditions
   9  *   are met:
  10  *
  11  *     * Redistributions of source code must retain the above copyright
  12  *       notice, this list of conditions and the following disclaimer.
  13  *     * Redistributions in binary form must reproduce the above copyright
  14  *       notice, this list of conditions and the following disclaimer in
  15  *       the documentation and/or other materials provided with the
  16  *       distribution.
  17  *     * Neither the name of Intel Corporation nor the names of its
  18  *       contributors may be used to endorse or promote products derived
  19  *       from this software without specific prior written permission.
  20  *
  21  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  22  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  23  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  24  *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  25  *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  26  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  27  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  28  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  29  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  30  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  31  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  32  */
  33
  34 #ifndef EAL_VFIO_H_
  35 #define EAL_VFIO_H_
  36
  37 /*
  38  * determine if VFIO is present on the system
  39  */
  40 #ifdef RTE_EAL_VFIO
  41 #include <linux/version.h>
  42 #if LINUX_VERSION_CODE >= KERNEL_VERSION(3, 6, 0)
  43 #include <linux/vfio.h>
  44
  45 #if LINUX_VERSION_CODE < KERNEL_VERSION(3, 10, 0)
  46 #define RTE_PCI_MSIX_TABLE_BIR    0x7
  47 #define RTE_PCI_MSIX_TABLE_OFFSET 0xfffffff8
  48 #define RTE_PCI_MSIX_FLAGS_QSIZE  0x07ff
  49 #else
  50 #define RTE_PCI_MSIX_TABLE_BIR    PCI_MSIX_TABLE_BIR
  51 #define RTE_PCI_MSIX_TABLE_OFFSET PCI_MSIX_TABLE_OFFSET
  52 #define RTE_PCI_MSIX_FLAGS_QSIZE  PCI_MSIX_FLAGS_QSIZE
  53 #endif
  54
  55 #define RTE_VFIO_TYPE1 VFIO_TYPE1_IOMMU
  56
  57 #ifndef VFIO_SPAPR_TCE_v2_IOMMU
  58 #define RTE_VFIO_SPAPR 7
  59 #define VFIO_IOMMU_SPAPR_REGISTER_MEMORY _IO(VFIO_TYPE, VFIO_BASE + 17)
  60 #define VFIO_IOMMU_SPAPR_TCE_CREATE _IO(VFIO_TYPE, VFIO_BASE + 19)
  61 #define VFIO_IOMMU_SPAPR_TCE_REMOVE _IO(VFIO_TYPE, VFIO_BASE + 20)
  62
  63 struct vfio_iommu_spapr_register_memory {
  64         uint32_t argsz;
  65         uint32_t flags;
  66         uint64_t vaddr;
  67         uint64_t size;
  68 };
  69
  70 struct vfio_iommu_spapr_tce_create {
  71         uint32_t argsz;
  72         uint32_t flags;
  73         /* in */
  74         uint32_t page_shift;
  75         uint32_t __resv1;
  76         uint64_t window_size;
  77         uint32_t levels;
  78         uint32_t __resv2;
  79         /* out */
  80         uint64_t start_addr;
  81 };
  82
  83 struct vfio_iommu_spapr_tce_remove {
  84         uint32_t argsz;
  85         uint32_t flags;
  86         /* in */
  87         uint64_t start_addr;
  88 };
  89
  90 struct vfio_iommu_spapr_tce_ddw_info {
  91         uint64_t pgsizes;
  92         uint32_t max_dynamic_windows_supported;
  93         uint32_t levels;
  94 };
  95
  96 /* SPAPR_v2 is not present, but SPAPR might be */
  97 #ifndef VFIO_SPAPR_TCE_IOMMU
  98 #define VFIO_IOMMU_SPAPR_TCE_GET_INFO _IO(VFIO_TYPE, VFIO_BASE + 12)
  99
 100 struct vfio_iommu_spapr_tce_info {
 101         uint32_t argsz;
 102         uint32_t flags;
 103         uint32_t dma32_window_start;
 104         uint32_t dma32_window_size;
 105         struct vfio_iommu_spapr_tce_ddw_info ddw;
 106 };
 107 #endif /* VFIO_SPAPR_TCE_IOMMU */
 108
 109 #else /* VFIO_SPAPR_TCE_v2_IOMMU */
 110 #define RTE_VFIO_SPAPR VFIO_SPAPR_TCE_v2_IOMMU
 111 #endif
 112
 113 #if LINUX_VERSION_CODE < KERNEL_VERSION(4, 5, 0)
 114 #define RTE_VFIO_NOIOMMU 8
 115 #else
 116 #define RTE_VFIO_NOIOMMU VFIO_NOIOMMU_IOMMU
 117 #endif
 118
 119 #define VFIO_MAX_GROUPS 64
 120
 121 /*
 122  * Function prototypes for VFIO multiprocess sync functions
 123  */
 124 int vfio_mp_sync_send_request(int socket, int req);
 125 int vfio_mp_sync_receive_request(int socket);
 126 int vfio_mp_sync_send_fd(int socket, int fd);
 127 int vfio_mp_sync_receive_fd(int socket);
 128 int vfio_mp_sync_connect_to_primary(void);
 129
 130 /*
 131  * we don't need to store device fd's anywhere since they can be obtained from
 132  * the group fd via an ioctl() call.
 133  */
 134 struct vfio_group {
 135         int group_no;
 136         int fd;
 137         int devices;
 138 };
 139
 140 struct vfio_config {
 141         int vfio_enabled;
 142         int vfio_container_fd;
 143         int vfio_active_groups;
 144         struct vfio_group vfio_groups[VFIO_MAX_GROUPS];
 145 };
 146
 147 #define VFIO_DIR "/dev/vfio"
 148 #define VFIO_CONTAINER_PATH "/dev/vfio/vfio"
 149 #define VFIO_GROUP_FMT "/dev/vfio/%u"
 150 #define VFIO_NOIOMMU_GROUP_FMT "/dev/vfio/noiommu-%u"
 151 #define VFIO_GET_REGION_ADDR(x) ((uint64_t) x << 40ULL)
 152 #define VFIO_GET_REGION_IDX(x) (x >> 40)
 153 #define VFIO_NOIOMMU_MODE      \
 154         "/sys/module/vfio/parameters/enable_unsafe_noiommu_mode"
 155
 156 /* DMA mapping function prototype.
 157  * Takes VFIO container fd as a parameter.
 158  * Returns 0 on success, -1 on error.
 159  * */
 160 typedef int (*vfio_dma_func_t)(int);
 161
 162 struct vfio_iommu_type {
 163         int type_id;
 164         const char *name;
 165         vfio_dma_func_t dma_map_func;
 166 };
 167
 168 /* pick IOMMU type. returns a pointer to vfio_iommu_type or NULL for error */
 169 const struct vfio_iommu_type *
 170 vfio_set_iommu_type(int vfio_container_fd);
 171
 172 /* check if we have any supported extensions */
 173 int
 174 vfio_has_supported_extensions(int vfio_container_fd);
 175
 176 /* open container fd or get an existing one */
 177 int
 178 vfio_get_container_fd(void);
 179
 180 /* parse IOMMU group number for a device
 181  * returns 1 on success, -1 for errors, 0 for non-existent group
 182  */
 183 int
 184 vfio_get_group_no(const char *sysfs_base,
 185                 const char *dev_addr, int *iommu_group_no);
 186
 187 /* open group fd or get an existing one */
 188 int
 189 vfio_get_group_fd(int iommu_group_no);
 190
 191 /* remove group fd from internal VFIO group fd array */
 192 int
 193 clear_group(int vfio_group_fd);
 194
 195 /**
 196  * Setup vfio_cfg for the device identified by its address. It discovers
 197  * the configured I/O MMU groups or sets a new one for the device. If a new
 198  * groups is assigned, the DMA mapping is performed.
 199  * Returns 0 on success, a negative value on failure and a positive value in
 200  * case the given device cannot be managed this way.
 201  */
 202 int vfio_setup_device(const char *sysfs_base, const char *dev_addr,
 203                 int *vfio_dev_fd, struct vfio_device_info *device_info);
 204
 205 int vfio_release_device(const char *sysfs_base, const char *dev_addr, int fd);
 206
 207 int vfio_enable(const char *modname);
 208 int vfio_is_enabled(const char *modname);
 209
 210 int pci_vfio_enable(void);
 211 int pci_vfio_is_enabled(void);
 212
 213 int vfio_mp_sync_setup(void);
 214
 215 int vfio_noiommu_is_enabled(void);
 216
 217 #define SOCKET_REQ_CONTAINER 0x100
 218 #define SOCKET_REQ_GROUP 0x200
 219 #define SOCKET_CLR_GROUP 0x300
 220 #define SOCKET_OK 0x0
 221 #define SOCKET_NO_FD 0x1
 222 #define SOCKET_ERR 0xFF
 223
 224 #define VFIO_PRESENT
 225 #endif /* kernel version */
 226 #endif /* RTE_EAL_VFIO */
 227
 228 #endif /* EAL_VFIO_H_ */