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 */
66 struct rte_mbuf **buffers;
67 /**< Stored mbufs. Used in zero-copy tx. Client stores transmitted
68 * mbufs to free them once server has received them.
72 uint64_t n_pkts; /**< number of rx/tx packets */
73 uint64_t n_bytes; /**< number of rx/tx bytes */
75 struct rte_intr_handle intr_handle; /**< interrupt handle */
77 memif_log2_ring_size_t log2_ring_size; /**< log2 of ring size */
80 struct pmd_internals {
81 memif_interface_id_t id; /**< unique id */
82 enum memif_role_t role; /**< device role */
83 uint32_t flags; /**< device status flags */
84 #define ETH_MEMIF_FLAG_CONNECTING (1 << 0)
85 /**< device is connecting */
86 #define ETH_MEMIF_FLAG_CONNECTED (1 << 1)
87 /**< device is connected */
88 #define ETH_MEMIF_FLAG_ZERO_COPY (1 << 2)
89 /**< device is zero-copy enabled */
90 #define ETH_MEMIF_FLAG_DISABLED (1 << 3)
91 /**< device has not been configured and can not accept connection requests */
92 #define ETH_MEMIF_FLAG_SOCKET_ABSTRACT (1 << 4)
93 /**< use abstract socket address */
95 char *socket_filename; /**< pointer to socket filename */
96 char secret[ETH_MEMIF_SECRET_SIZE]; /**< secret (optional security parameter) */
98 struct memif_control_channel *cc; /**< control channel */
99 rte_spinlock_t cc_lock; /**< control channel lock */
102 char remote_name[RTE_DEV_NAME_MAX_LEN]; /**< remote app name */
103 char remote_if_name[RTE_DEV_NAME_MAX_LEN]; /**< remote peer name */
106 memif_log2_ring_size_t log2_ring_size; /**< log2 of ring size */
107 uint8_t num_c2s_rings; /**< number of client to server rings */
108 uint8_t num_s2c_rings; /**< number of server to client rings */
109 uint16_t pkt_buffer_size; /**< buffer size */
110 } cfg; /**< Configured parameters (max values) */
113 memif_log2_ring_size_t log2_ring_size; /**< log2 of ring size */
114 uint8_t num_c2s_rings; /**< number of client to server rings */
115 uint8_t num_s2c_rings; /**< number of server to client rings */
116 uint16_t pkt_buffer_size; /**< buffer size */
118 /**< Parameters used in active connection */
120 char local_disc_string[ETH_MEMIF_DISC_STRING_SIZE];
121 /**< local disconnect reason */
122 char remote_disc_string[ETH_MEMIF_DISC_STRING_SIZE];
123 /**< remote disconnect reason */
126 struct pmd_process_private {
127 struct memif_region *regions[ETH_MEMIF_MAX_REGION_NUM];
128 /**< shared memory regions */
129 memif_region_index_t regions_num; /**< number of regions */
133 * Unmap shared memory and free regions from memory.
135 * @param proc_private
136 * device process private data
138 void memif_free_regions(struct rte_eth_dev *dev);
141 * Finalize connection establishment process. Map shared memory file
142 * (server role), initialize ring queue, set link status up.
147 * - On success, zero.
148 * - On failure, a negative value.
150 int memif_connect(struct rte_eth_dev *dev);
153 * Create shared memory file and initialize ring queue.
154 * Only called by client when establishing connection
159 * - On success, zero.
160 * - On failure, a negative value.
162 int memif_init_regions_and_queues(struct rte_eth_dev *dev);
165 * Get memif version string.
168 * - memif version string
170 const char *memif_version(void);
173 #ifndef __NR_memfd_create
175 #if defined __x86_64__
176 #define __NR_memfd_create 319
177 #elif defined __x86_32__
178 #define __NR_memfd_create 1073742143
179 #elif defined __arm__
180 #define __NR_memfd_create 385
181 #elif defined __aarch64__
182 #define __NR_memfd_create 279
183 #elif defined __powerpc__
184 #define __NR_memfd_create 360
185 #elif defined __i386__
186 #define __NR_memfd_create 356
188 #error "__NR_memfd_create unknown for this architecture"
191 #endif /* __NR_memfd_create */
193 static inline int memfd_create(const char *name, unsigned int flags)
195 return syscall(__NR_memfd_create, name, flags);
197 #endif /* MFD_HUGETLB */
199 #ifndef F_LINUX_SPECIFIC_BASE
200 #define F_LINUX_SPECIFIC_BASE 1024
203 #ifndef MFD_ALLOW_SEALING
204 #define MFD_ALLOW_SEALING 0x0002U
208 #define F_ADD_SEALS (F_LINUX_SPECIFIC_BASE + 9)
209 #define F_GET_SEALS (F_LINUX_SPECIFIC_BASE + 10)
211 #define F_SEAL_SEAL 0x0001 /* prevent further seals from being set */
212 #define F_SEAL_SHRINK 0x0002 /* prevent file from shrinking */
213 #define F_SEAL_GROW 0x0004 /* prevent file from growing */
214 #define F_SEAL_WRITE 0x0008 /* prevent writes */
217 #endif /* RTE_ETH_MEMIF_H */