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 #if LINUX_VERSION_CODE < KERNEL_VERSION(4, 5, 0)
  58 #define RTE_VFIO_NOIOMMU 8
  59 #else
  60 #define RTE_VFIO_NOIOMMU VFIO_NOIOMMU_IOMMU
  61 #endif
  62
  63 #define VFIO_MAX_GROUPS 64
  64
  65 /*
  66  * Function prototypes for VFIO multiprocess sync functions
  67  */
  68 int vfio_mp_sync_send_request(int socket, int req);
  69 int vfio_mp_sync_receive_request(int socket);
  70 int vfio_mp_sync_send_fd(int socket, int fd);
  71 int vfio_mp_sync_receive_fd(int socket);
  72 int vfio_mp_sync_connect_to_primary(void);
  73
  74 /*
  75  * we don't need to store device fd's anywhere since they can be obtained from
  76  * the group fd via an ioctl() call.
  77  */
  78 struct vfio_group {
  79         int group_no;
  80         int fd;
  81 };
  82
  83 struct vfio_config {
  84         int vfio_enabled;
  85         int vfio_container_fd;
  86         int vfio_container_has_dma;
  87         int vfio_group_idx;
  88         struct vfio_group vfio_groups[VFIO_MAX_GROUPS];
  89 };
  90
  91 #define VFIO_DIR "/dev/vfio"
  92 #define VFIO_CONTAINER_PATH "/dev/vfio/vfio"
  93 #define VFIO_GROUP_FMT "/dev/vfio/%u"
  94 #define VFIO_NOIOMMU_GROUP_FMT "/dev/vfio/noiommu-%u"
  95 #define VFIO_GET_REGION_ADDR(x) ((uint64_t) x << 40ULL)
  96 #define VFIO_GET_REGION_IDX(x) (x >> 40)
  97
  98 /* DMA mapping function prototype.
  99  * Takes VFIO container fd as a parameter.
 100  * Returns 0 on success, -1 on error.
 101  * */
 102 typedef int (*vfio_dma_func_t)(int);
 103
 104 struct vfio_iommu_type {
 105         int type_id;
 106         const char *name;
 107         vfio_dma_func_t dma_map_func;
 108 };
 109
 110 /* pick IOMMU type. returns a pointer to vfio_iommu_type or NULL for error */
 111 const struct vfio_iommu_type *
 112 vfio_set_iommu_type(int vfio_container_fd);
 113
 114 /* check if we have any supported extensions */
 115 int
 116 vfio_has_supported_extensions(int vfio_container_fd);
 117
 118 /* open container fd or get an existing one */
 119 int
 120 vfio_get_container_fd(void);
 121
 122 /* parse IOMMU group number for a device
 123  * returns 1 on success, -1 for errors, 0 for non-existent group
 124  */
 125 int
 126 vfio_get_group_no(const char *sysfs_base,
 127                 const char *dev_addr, int *iommu_group_no);
 128
 129 /* open group fd or get an existing one */
 130 int
 131 vfio_get_group_fd(int iommu_group_no);
 132
 133 /**
 134  * Setup vfio_cfg for the device identified by its address. It discovers
 135  * the configured I/O MMU groups or sets a new one for the device. If a new
 136  * groups is assigned, the DMA mapping is performed.
 137  * Returns 0 on success, a negative value on failure and a positive value in
 138  * case the given device cannot be managed this way.
 139  */
 140 int vfio_setup_device(const char *sysfs_base, const char *dev_addr,
 141                 int *vfio_dev_fd, struct vfio_device_info *device_info);
 142
 143 int vfio_enable(const char *modname);
 144 int vfio_is_enabled(const char *modname);
 145
 146 int pci_vfio_enable(void);
 147 int pci_vfio_is_enabled(void);
 148
 149 int vfio_mp_sync_setup(void);
 150
 151 #define SOCKET_REQ_CONTAINER 0x100
 152 #define SOCKET_REQ_GROUP 0x200
 153 #define SOCKET_OK 0x0
 154 #define SOCKET_NO_FD 0x1
 155 #define SOCKET_ERR 0xFF
 156
 157 #define VFIO_PRESENT
 158 #endif /* kernel version */
 159 #endif /* RTE_EAL_VFIO */
 160
 161 #endif /* EAL_VFIO_H_ */