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 page_shift;
  73         uint64_t window_size;
  74         uint32_t levels;
  75 };
  76
  77 struct vfio_iommu_spapr_tce_remove {
  78         uint32_t argsz;
  79         uint64_t start_addr;
  80 };
  81
  82 struct vfio_iommu_spapr_tce_ddw_info {
  83         uint64_t pgsizes;
  84         uint32_t max_dynamic_windows_supported;
  85         uint32_t levels;
  86 };
  87
  88 /* SPAPR_v2 is not present, but SPAPR might be */
  89 #ifndef VFIO_SPAPR_TCE_IOMMU
  90 #define VFIO_IOMMU_SPAPR_TCE_GET_INFO _IO(VFIO_TYPE, VFIO_BASE + 12)
  91
  92 struct vfio_iommu_spapr_tce_info {
  93         uint32_t argsz;
  94         uint32_t flags;
  95         uint32_t dma32_window_start;
  96         uint32_t dma32_window_size;
  97         struct vfio_iommu_spapr_tce_ddw_info ddw;
  98 };
  99 #endif /* VFIO_SPAPR_TCE_IOMMU */
 100
 101 #else /* VFIO_SPAPR_TCE_v2_IOMMU */
 102 #define RTE_VFIO_SPAPR VFIO_SPAPR_TCE_v2_IOMMU
 103 #endif
 104
 105 #if LINUX_VERSION_CODE < KERNEL_VERSION(4, 5, 0)
 106 #define RTE_VFIO_NOIOMMU 8
 107 #else
 108 #define RTE_VFIO_NOIOMMU VFIO_NOIOMMU_IOMMU
 109 #endif
 110
 111 #define VFIO_MAX_GROUPS 64
 112
 113 /*
 114  * Function prototypes for VFIO multiprocess sync functions
 115  */
 116 int vfio_mp_sync_send_request(int socket, int req);
 117 int vfio_mp_sync_receive_request(int socket);
 118 int vfio_mp_sync_send_fd(int socket, int fd);
 119 int vfio_mp_sync_receive_fd(int socket);
 120 int vfio_mp_sync_connect_to_primary(void);
 121
 122 /*
 123  * we don't need to store device fd's anywhere since they can be obtained from
 124  * the group fd via an ioctl() call.
 125  */
 126 struct vfio_group {
 127         int group_no;
 128         int fd;
 129 };
 130
 131 struct vfio_config {
 132         int vfio_enabled;
 133         int vfio_container_fd;
 134         int vfio_container_has_dma;
 135         int vfio_group_idx;
 136         struct vfio_group vfio_groups[VFIO_MAX_GROUPS];
 137 };
 138
 139 #define VFIO_DIR "/dev/vfio"
 140 #define VFIO_CONTAINER_PATH "/dev/vfio/vfio"
 141 #define VFIO_GROUP_FMT "/dev/vfio/%u"
 142 #define VFIO_NOIOMMU_GROUP_FMT "/dev/vfio/noiommu-%u"
 143 #define VFIO_GET_REGION_ADDR(x) ((uint64_t) x << 40ULL)
 144 #define VFIO_GET_REGION_IDX(x) (x >> 40)
 145
 146 /* DMA mapping function prototype.
 147  * Takes VFIO container fd as a parameter.
 148  * Returns 0 on success, -1 on error.
 149  * */
 150 typedef int (*vfio_dma_func_t)(int);
 151
 152 struct vfio_iommu_type {
 153         int type_id;
 154         const char *name;
 155         vfio_dma_func_t dma_map_func;
 156 };
 157
 158 /* pick IOMMU type. returns a pointer to vfio_iommu_type or NULL for error */
 159 const struct vfio_iommu_type *
 160 vfio_set_iommu_type(int vfio_container_fd);
 161
 162 /* check if we have any supported extensions */
 163 int
 164 vfio_has_supported_extensions(int vfio_container_fd);
 165
 166 /* open container fd or get an existing one */
 167 int
 168 vfio_get_container_fd(void);
 169
 170 /* parse IOMMU group number for a device
 171  * returns 1 on success, -1 for errors, 0 for non-existent group
 172  */
 173 int
 174 vfio_get_group_no(const char *sysfs_base,
 175                 const char *dev_addr, int *iommu_group_no);
 176
 177 /* open group fd or get an existing one */
 178 int
 179 vfio_get_group_fd(int iommu_group_no);
 180
 181 /**
 182  * Setup vfio_cfg for the device identified by its address. It discovers
 183  * the configured I/O MMU groups or sets a new one for the device. If a new
 184  * groups is assigned, the DMA mapping is performed.
 185  * Returns 0 on success, a negative value on failure and a positive value in
 186  * case the given device cannot be managed this way.
 187  */
 188 int vfio_setup_device(const char *sysfs_base, const char *dev_addr,
 189                 int *vfio_dev_fd, struct vfio_device_info *device_info);
 190
 191 int vfio_enable(const char *modname);
 192 int vfio_is_enabled(const char *modname);
 193
 194 int pci_vfio_enable(void);
 195 int pci_vfio_is_enabled(void);
 196
 197 int vfio_mp_sync_setup(void);
 198
 199 #define SOCKET_REQ_CONTAINER 0x100
 200 #define SOCKET_REQ_GROUP 0x200
 201 #define SOCKET_OK 0x0
 202 #define SOCKET_NO_FD 0x1
 203 #define SOCKET_ERR 0xFF
 204
 205 #define VFIO_PRESENT
 206 #endif /* kernel version */
 207 #endif /* RTE_EAL_VFIO */
 208
 209 #endif /* EAL_VFIO_H_ */