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