1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright 2018-2019 Cisco Systems, Inc. All rights reserved.
5 #ifndef _RTE_ETH_MEMIF_H_
6 #define _RTE_ETH_MEMIF_H_
10 #endif /* GNU_SOURCE */
12 #include <sys/queue.h>
14 #include <rte_ethdev_driver.h>
15 #include <rte_ether.h>
16 #include <rte_interrupts.h>
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
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
28 #define ETH_MEMIF_SHM_NAME_SIZE 32
29 #define ETH_MEMIF_DISC_STRING_SIZE 96
30 #define ETH_MEMIF_SECRET_SIZE 24
32 extern int memif_logtype;
34 #define MIF_LOG(level, fmt, args...) \
35 rte_log(RTE_LOG_ ## level, memif_logtype, \
36 "%s(): " fmt "\n", __func__, ##args)
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 */
52 struct rte_mempool *mempool; /**< mempool for RX packets */
53 struct pmd_internals *pmd; /**< device internals */
55 memif_ring_type_t type; /**< ring type */
56 memif_region_index_t region; /**< shared memory region index */
58 uint16_t in_port; /**< port id */
60 memif_region_offset_t ring_offset;
61 /**< ring offset from start of shm region (ring - memif_region.addr) */
63 uint16_t last_head; /**< last ring head */
64 uint16_t last_tail; /**< last ring tail */
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 */
71 memif_ring_t *ring; /**< pointer to ring */
73 struct rte_intr_handle intr_handle; /**< interrupt handle */
75 memif_log2_ring_size_t log2_ring_size; /**< log2 of ring size */
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 */
91 char *socket_filename; /**< pointer to socket filename */
92 char secret[ETH_MEMIF_SECRET_SIZE]; /**< secret (optional security parameter) */
94 struct memif_control_channel *cc; /**< control channel */
97 char remote_name[RTE_DEV_NAME_MAX_LEN]; /**< remote app name */
98 char remote_if_name[RTE_DEV_NAME_MAX_LEN]; /**< remote peer name */
101 memif_log2_ring_size_t log2_ring_size; /**< log2 of ring size */
102 uint8_t num_s2m_rings; /**< number of slave to master rings */
103 uint8_t num_m2s_rings; /**< number of master to slave rings */
104 uint16_t pkt_buffer_size; /**< buffer size */
105 } cfg; /**< Configured parameters (max values) */
108 memif_log2_ring_size_t log2_ring_size; /**< log2 of ring size */
109 uint8_t num_s2m_rings; /**< number of slave to master rings */
110 uint8_t num_m2s_rings; /**< number of master to slave rings */
111 uint16_t pkt_buffer_size; /**< buffer size */
113 /**< Parameters used in active connection */
115 char local_disc_string[ETH_MEMIF_DISC_STRING_SIZE];
116 /**< local disconnect reason */
117 char remote_disc_string[ETH_MEMIF_DISC_STRING_SIZE];
118 /**< remote disconnect reason */
120 struct rte_vdev_device *vdev; /**< vdev handle */
123 struct pmd_process_private {
124 struct memif_region *regions[ETH_MEMIF_MAX_REGION_NUM];
125 /**< shared memory regions */
126 memif_region_index_t regions_num; /**< number of regions */
130 * Unmap shared memory and free regions from memory.
132 * @param proc_private
133 * device process private data
135 void memif_free_regions(struct pmd_process_private *proc_private);
138 * Finalize connection establishment process. Map shared memory file
139 * (master role), initialize ring queue, set link status up.
144 * - On success, zero.
145 * - On failure, a negative value.
147 int memif_connect(struct rte_eth_dev *dev);
150 * Create shared memory file and initialize ring queue.
151 * Only called by slave when establishing connection
156 * - On success, zero.
157 * - On failure, a negative value.
159 int memif_init_regions_and_queues(struct rte_eth_dev *dev);
162 * Get memif version string.
165 * - memif version string
167 const char *memif_version(void);
170 #ifndef __NR_memfd_create
172 #if defined __x86_64__
173 #define __NR_memfd_create 319
174 #elif defined __x86_32__
175 #define __NR_memfd_create 1073742143
176 #elif defined __arm__
177 #define __NR_memfd_create 385
178 #elif defined __aarch64__
179 #define __NR_memfd_create 279
180 #elif defined __powerpc__
181 #define __NR_memfd_create 360
182 #elif defined __i386__
183 #define __NR_memfd_create 356
185 #error "__NR_memfd_create unknown for this architecture"
188 #endif /* __NR_memfd_create */
190 static inline int memfd_create(const char *name, unsigned int flags)
192 return syscall(__NR_memfd_create, name, flags);
194 #endif /* MFD_HUGETLB */
196 #ifndef F_LINUX_SPECIFIC_BASE
197 #define F_LINUX_SPECIFIC_BASE 1024
200 #ifndef MFD_ALLOW_SEALING
201 #define MFD_ALLOW_SEALING 0x0002U
205 #define F_ADD_SEALS (F_LINUX_SPECIFIC_BASE + 9)
206 #define F_GET_SEALS (F_LINUX_SPECIFIC_BASE + 10)
208 #define F_SEAL_SEAL 0x0001 /* prevent further seals from being set */
209 #define F_SEAL_SHRINK 0x0002 /* prevent file from shrinking */
210 #define F_SEAL_GROW 0x0004 /* prevent file from growing */
211 #define F_SEAL_WRITE 0x0008 /* prevent writes */
214 #endif /* RTE_ETH_MEMIF_H */