drivers/net/memif/rte_eth_memif.h

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  * Copyright 2018-2019 Cisco Systems, Inc.  All rights reserved.
   3  */
   4
   5 #ifndef _RTE_ETH_MEMIF_H_
   6 #define _RTE_ETH_MEMIF_H_
   7
   8 #ifndef _GNU_SOURCE
   9 #define _GNU_SOURCE
  10 #endif                          /* GNU_SOURCE */
  11
  12 #include <sys/queue.h>
  13
  14 #include <rte_ethdev_driver.h>
  15 #include <rte_ether.h>
  16 #include <rte_interrupts.h>
  17
  18 #include "memif.h"
  19
  20 #define ETH_MEMIF_DEFAULT_SOCKET_FILENAME       "/run/memif.sock"
  21 #define ETH_MEMIF_DEFAULT_RING_SIZE             10
  22 #define ETH_MEMIF_DEFAULT_PKT_BUFFER_SIZE       2048
  23
  24 #define ETH_MEMIF_MAX_NUM_Q_PAIRS               255
  25 #define ETH_MEMIF_MAX_LOG2_RING_SIZE            14
  26 #define ETH_MEMIF_MAX_REGION_NUM                256
  27
  28 #define ETH_MEMIF_SHM_NAME_SIZE                 32
  29 #define ETH_MEMIF_DISC_STRING_SIZE              96
  30 #define ETH_MEMIF_SECRET_SIZE                   24
  31
  32 extern int memif_logtype;
  33
  34 #define MIF_LOG(level, fmt, args...) \
  35         rte_log(RTE_LOG_ ## level, memif_logtype, \
  36                 "%s(): " fmt "\n", __func__, ##args)
  37
  38 enum memif_role_t {
  39         MEMIF_ROLE_MASTER,
  40         MEMIF_ROLE_SLAVE,
  41 };
  42
  43 struct memif_region {
  44         void *addr;                             /**< shared memory address */
  45         memif_region_size_t region_size;        /**< shared memory size */
  46         int fd;                                 /**< shared memory file descriptor */
  47         uint32_t pkt_buffer_offset;
  48         /**< offset from 'addr' to first packet buffer */
  49 };
  50
  51 struct memif_queue {
  52         struct rte_mempool *mempool;            /**< mempool for RX packets */
  53         struct pmd_internals *pmd;              /**< device internals */
  54
  55         memif_ring_type_t type;                 /**< ring type */
  56         memif_region_index_t region;            /**< shared memory region index */
  57
  58         uint16_t in_port;                       /**< port id */
  59
  60         memif_region_offset_t ring_offset;
  61         /**< ring offset from start of shm region (ring - memif_region.addr) */
  62
  63         uint16_t last_head;                     /**< last ring head */
  64         uint16_t last_tail;                     /**< last ring tail */
  65
  66         /* rx/tx info */
  67         uint64_t n_pkts;                        /**< number of rx/tx packets */
  68         uint64_t n_bytes;                       /**< number of rx/tx bytes */
  69         uint64_t n_err;                         /**< number of tx errors */
  70
  71         memif_ring_t *ring;                     /**< pointer to ring */
  72
  73         struct rte_intr_handle intr_handle;     /**< interrupt handle */
  74
  75         memif_log2_ring_size_t log2_ring_size;  /**< log2 of ring size */
  76 };
  77
  78 struct pmd_internals {
  79         memif_interface_id_t id;                /**< unique id */
  80         enum memif_role_t role;                 /**< device role */
  81         uint32_t flags;                         /**< device status flags */
  82 #define ETH_MEMIF_FLAG_CONNECTING       (1 << 0)
  83 /**< device is connecting */
  84 #define ETH_MEMIF_FLAG_CONNECTED        (1 << 1)
  85 /**< device is connected */
  86 #define ETH_MEMIF_FLAG_ZERO_COPY        (1 << 2)
  87 /**< device is zero-copy enabled */
  88 #define ETH_MEMIF_FLAG_DISABLED         (1 << 3)
  89 /**< device has not been configured and can not accept connection requests */
  90
  91         char *socket_filename;                  /**< pointer to socket filename */
  92         char secret[ETH_MEMIF_SECRET_SIZE]; /**< secret (optional security parameter) */
  93
  94         struct memif_control_channel *cc;       /**< control channel */
  95
  96         struct memif_region *regions[ETH_MEMIF_MAX_REGION_NUM];
  97         /**< shared memory regions */
  98         memif_region_index_t regions_num;       /**< number of regions */
  99
 100         /* remote info */
 101         char remote_name[RTE_DEV_NAME_MAX_LEN];         /**< remote app name */
 102         char remote_if_name[RTE_DEV_NAME_MAX_LEN];      /**< remote peer name */
 103
 104         struct {
 105                 memif_log2_ring_size_t log2_ring_size; /**< log2 of ring size */
 106                 uint8_t num_s2m_rings;          /**< number of slave to master rings */
 107                 uint8_t num_m2s_rings;          /**< number of master to slave rings */
 108                 uint16_t pkt_buffer_size;       /**< buffer size */
 109         } cfg;                                  /**< Configured parameters (max values) */
 110
 111         struct {
 112                 memif_log2_ring_size_t log2_ring_size; /**< log2 of ring size */
 113                 uint8_t num_s2m_rings;          /**< number of slave to master rings */
 114                 uint8_t num_m2s_rings;          /**< number of master to slave rings */
 115                 uint16_t pkt_buffer_size;       /**< buffer size */
 116         } run;
 117         /**< Parameters used in active connection */
 118
 119         char local_disc_string[ETH_MEMIF_DISC_STRING_SIZE];
 120         /**< local disconnect reason */
 121         char remote_disc_string[ETH_MEMIF_DISC_STRING_SIZE];
 122         /**< remote disconnect reason */
 123
 124         struct rte_vdev_device *vdev;           /**< vdev handle */
 125 };
 126
 127 /**
 128  * Unmap shared memory and free regions from memory.
 129  *
 130  * @param pmd
 131  *   device internals
 132  */
 133 void memif_free_regions(struct pmd_internals *pmd);
 134
 135 /**
 136  * Finalize connection establishment process. Map shared memory file
 137  * (master role), initialize ring queue, set link status up.
 138  *
 139  * @param dev
 140  *   memif device
 141  * @return
 142  *   - On success, zero.
 143  *   - On failure, a negative value.
 144  */
 145 int memif_connect(struct rte_eth_dev *dev);
 146
 147 /**
 148  * Create shared memory file and initialize ring queue.
 149  * Only called by slave when establishing connection
 150  *
 151  * @param dev
 152  *   memif device
 153  * @return
 154  *   - On success, zero.
 155  *   - On failure, a negative value.
 156  */
 157 int memif_init_regions_and_queues(struct rte_eth_dev *dev);
 158
 159 /**
 160  * Get memif version string.
 161  *
 162  * @return
 163  *   - memif version string
 164  */
 165 const char *memif_version(void);
 166
 167 #ifndef MFD_HUGETLB
 168 #ifndef __NR_memfd_create
 169
 170 #if defined __x86_64__
 171 #define __NR_memfd_create 319
 172 #elif defined __x86_32__
 173 #define __NR_memfd_create 1073742143
 174 #elif defined __arm__
 175 #define __NR_memfd_create 385
 176 #elif defined __aarch64__
 177 #define __NR_memfd_create 279
 178 #elif defined __powerpc__
 179 #define __NR_memfd_create 360
 180 #elif defined __i386__
 181 #define __NR_memfd_create 356
 182 #else
 183 #error "__NR_memfd_create unknown for this architecture"
 184 #endif
 185
 186 #endif                          /* __NR_memfd_create */
 187
 188 static inline int memfd_create(const char *name, unsigned int flags)
 189 {
 190         return syscall(__NR_memfd_create, name, flags);
 191 }
 192 #endif                          /* MFD_HUGETLB */
 193
 194 #ifndef F_LINUX_SPECIFIC_BASE
 195 #define F_LINUX_SPECIFIC_BASE 1024
 196 #endif
 197
 198 #ifndef MFD_ALLOW_SEALING
 199 #define MFD_ALLOW_SEALING       0x0002U
 200 #endif
 201
 202 #ifndef F_ADD_SEALS
 203 #define F_ADD_SEALS (F_LINUX_SPECIFIC_BASE + 9)
 204 #define F_GET_SEALS (F_LINUX_SPECIFIC_BASE + 10)
 205
 206 #define F_SEAL_SEAL     0x0001  /* prevent further seals from being set */
 207 #define F_SEAL_SHRINK   0x0002  /* prevent file from shrinking */
 208 #define F_SEAL_GROW     0x0004  /* prevent file from growing */
 209 #define F_SEAL_WRITE    0x0008  /* prevent writes */
 210 #endif
 211
 212 #endif                          /* RTE_ETH_MEMIF_H */