2 *------------------------------------------------------------------
3 * Copyright (c) 2017 Cisco and/or its affiliates.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at:
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 *------------------------------------------------------------------
19 #ifndef _MEMIF_PRIVATE_H_
20 #define _MEMIF_PRIVATE_H_
24 #include <sys/syscall.h>
28 #include <sys/timerfd.h>
34 #define MEMIF_NAME_LEN 32
35 _Static_assert (strlen (MEMIF_DEFAULT_APP_NAME) <= MEMIF_NAME_LEN,
36 "MEMIF_DEFAULT_APP_NAME max length is 32");
38 #define MEMIF_DEFAULT_SOCKET_PATH "/run/vpp/memif.sock"
39 #define MEMIF_DEFAULT_RING_SIZE 1024
40 #define MEMIF_DEFAULT_LOG2_RING_SIZE 10
41 #define MEMIF_DEFAULT_RX_QUEUES 1
42 #define MEMIF_DEFAULT_TX_QUEUES 1
43 #define MEMIF_DEFAULT_BUFFER_SIZE 2048
44 #define MEMIF_DEFAULT_RECONNECT_PERIOD_SEC 2
45 #define MEMIF_DEFAULT_RECONNECT_PERIOD_NSEC 0
47 #define MEMIF_MAX_M2S_RING 255
48 #define MEMIF_MAX_S2M_RING 255
49 #define MEMIF_MAX_REGION 255
50 #define MEMIF_MAX_LOG2_RING_SIZE 14
52 #define MEMIF_MAX_FDS 512
54 #define memif_min(a,b) (((a) < (b)) ? (a) : (b))
56 #define EXPECT_TRUE(x) __builtin_expect((x),1)
57 #define EXPECT_FALSE(x) __builtin_expect((x),0)
60 #define DBG(...) do { \
61 printf("MEMIF_DEBUG:%s:%s:%d: ", __FILE__, __func__, __LINE__); \
62 printf(__VA_ARGS__); \
67 #endif /* MEMIF_DBG */
71 MEMIF_SOCKET_TYPE_NONE = 0, /* unassigned, not used by any interface */
72 MEMIF_SOCKET_TYPE_LISTENER, /* listener socket, master interface assigned */
73 MEMIF_SOCKET_TYPE_CLIENT /* client socket, slave interface assigned */
74 } memif_socket_type_t;
80 uint32_t buffer_offset;
88 uint8_t log2_ring_size;
101 typedef struct memif_msg_queue_elt
105 struct memif_msg_queue_elt *next;
106 } memif_msg_queue_elt_t;
108 struct memif_connection;
110 typedef struct memif_connection memif_connection_t;
112 /* functions called by memif_control_fd_handler */
113 typedef int (memif_fn) (memif_connection_t * conn);
117 uint8_t num_s2m_rings;
118 uint8_t num_m2s_rings;
119 uint16_t buffer_size;
120 memif_log2_ring_size_t log2_ring_size;
121 } memif_conn_run_args_t;
123 typedef struct memif_connection
126 memif_conn_args_t args;
127 memif_conn_run_args_t run_args;
131 memif_fn *write_fn, *read_fn, *error_fn;
133 memif_connection_update_t *on_connect, *on_disconnect;
134 memif_interrupt_t *on_interrupt;
137 /* connection message queue */
138 memif_msg_queue_elt_t *msg_queue;
140 uint8_t remote_if_name[MEMIF_NAME_LEN];
141 uint8_t remote_name[MEMIF_NAME_LEN];
142 uint8_t remote_disconnect_string[96];
145 memif_region_t *regions;
147 uint8_t rx_queues_num;
148 uint8_t tx_queues_num;
149 memif_queue_t *rx_queues;
150 memif_queue_t *tx_queues;
153 #define MEMIF_CONNECTION_FLAG_WRITE (1 << 0)
154 } memif_connection_t;
166 memif_socket_type_t type;
168 uint16_t interface_list_len;
170 memif_list_elt_t *interface_list; /* memif master interfaces listening on this socket */
175 memif_control_fd_update_t *control_fd_update;
177 struct itimerspec arm, disarm;
178 uint16_t disconn_slaves;
179 uint8_t app_name[MEMIF_NAME_LEN];
181 memif_socket_handle_t default_socket;
183 memif_add_external_region_t *add_external_region;
184 memif_get_external_region_addr_t *get_external_region_addr;
185 memif_del_external_region_t *del_external_region;
186 memif_get_external_buffer_offset_t *get_external_buffer_offset;
188 memif_alloc_t *alloc;
189 memif_realloc_t *realloc;
192 uint16_t control_list_len;
193 uint16_t interrupt_list_len;
194 uint16_t socket_list_len;
195 uint16_t pending_list_len;
196 memif_list_elt_t *control_list;
197 memif_list_elt_t *interrupt_list;
198 memif_list_elt_t *socket_list;
199 memif_list_elt_t *pending_list;
202 extern libmemif_main_t libmemif_main;
203 extern int memif_epfd;
207 /* if region doesn't contain shared memory, mmap region, check ring cookie */
208 int memif_connect1 (memif_connection_t * c);
210 /* memory map region, initalize rings and queues */
211 int memif_init_regions_and_queues (memif_connection_t * c);
213 int memif_disconnect_internal (memif_connection_t * c);
215 /* map errno to memif error code */
216 int memif_syscall_error_handler (int err_code);
218 int add_list_elt (memif_list_elt_t * e, memif_list_elt_t ** list,
221 int get_list_elt (memif_list_elt_t ** e, memif_list_elt_t * list,
222 uint16_t len, int key);
224 int free_list_elt (memif_list_elt_t * list, uint16_t len, int key);
226 #ifndef __NR_memfd_create
227 #if defined __x86_64__
228 #define __NR_memfd_create 319
229 #elif defined __arm__
230 #define __NR_memfd_create 385
231 #elif defined __aarch64__
232 #define __NR_memfd_create 279
234 #error "__NR_memfd_create unknown for this architecture"
238 #ifndef HAVE_MEMFD_CREATE
240 memfd_create (const char *name, unsigned int flags)
242 return syscall (__NR_memfd_create, name, flags);
247 memif_get_buffer (memif_connection_t * conn, memif_ring_t * ring,
250 return (conn->regions[ring->desc[index].region].addr +
251 ring->desc[index].offset);
254 #ifndef F_LINUX_SPECIFIC_BASE
255 #define F_LINUX_SPECIFIC_BASE 1024
258 #ifndef MFD_ALLOW_SEALING
259 #define MFD_ALLOW_SEALING 0x0002U
263 #define F_ADD_SEALS (F_LINUX_SPECIFIC_BASE + 9)
264 #define F_GET_SEALS (F_LINUX_SPECIFIC_BASE + 10)
266 #define F_SEAL_SEAL 0x0001 /* prevent further seals from being set */
267 #define F_SEAL_SHRINK 0x0002 /* prevent file from shrinking */
268 #define F_SEAL_GROW 0x0004 /* prevent file from growing */
269 #define F_SEAL_WRITE 0x0008 /* prevent writes */
272 #endif /* _MEMIF_PRIVATE_H_ */