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 *------------------------------------------------------------------
18 #include <vppinfra/lock.h>
20 #define MEMIF_DEFAULT_SOCKET_DIR "/run/vpp"
21 #define MEMIF_DEFAULT_SOCKET_FILENAME "memif.sock"
22 #define MEMIF_DEFAULT_RING_SIZE 1024
23 #define MEMIF_DEFAULT_RX_QUEUES 1
24 #define MEMIF_DEFAULT_TX_QUEUES 1
25 #define MEMIF_DEFAULT_BUFFER_SIZE 2048
27 #define MEMIF_VERSION_MAJOR 0
28 #define MEMIF_VERSION_MINOR 1
29 #define MEMIF_VERSION ((MEMIF_VERSION_MAJOR << 8) | MEMIF_VERSION_MINOR)
30 #define MEMIF_COOKIE 0xdeadbeef
31 #define MEMIF_MAX_M2S_RING (vec_len (vlib_mains) - 1)
32 #define MEMIF_MAX_S2M_RING (vec_len (vlib_mains) - 1)
33 #define MEMIF_MAX_REGION 255
34 #define MEMIF_MAX_LOG2_RING_SIZE 14
39 #define DBG(...) clib_warning(__VA_ARGS__)
40 #define DBG_UNIX_LOG(...) clib_unix_warning(__VA_ARGS__)
43 #define DBG_UNIX_LOG(...)
47 #define memif_file_add(a, b) do { \
49 *a = unix_file_add (&unix_main, b); \
50 clib_warning ("unix_file_add fd %d private_data %u idx %u", \
51 (b)->file_descriptor, (b)->private_data, *a); \
54 #define memif_file_del(a) do { \
55 clib_warning ("unix_file_del idx %u",a - unix_main.file_pool); \
56 unix_file_del (&unix_main, a); \
59 #define memif_file_del_by_index(a) do { \
60 clib_warning ("unix_file_del idx %u", a); \
61 unix_file_del_by_index (&unix_main, a); \
64 #define memif_file_add(a, b) do { \
66 *a = unix_file_add (&unix_main, b); \
68 #define memif_file_del(a) unix_file_del(&unix_main, a)
69 #define memif_file_del_by_index(a) unix_file_del_by_index(&unix_main, a)
76 uword unix_file_index;
77 uword *pending_file_indices;
81 /* hash of all registered id */
82 mhash_t dev_instance_by_id;
84 /* hash of all registered fds */
85 uword *dev_instance_by_fd;
86 } memif_socket_file_t;
99 } memif_msg_fifo_elt_t;
114 uword int_unix_file_index;
118 #define foreach_memif_if_flag \
119 _(0, ADMIN_UP, "admin-up") \
120 _(1, IS_SLAVE, "slave") \
121 _(2, CONNECTING, "connecting") \
122 _(3, CONNECTED, "connected") \
123 _(4, DELETING, "deleting")
127 #define _(a, b, c) MEMIF_IF_FLAG_##b = (1 << a),
128 foreach_memif_if_flag
134 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
135 clib_spinlock_t lockp;
137 memif_interface_id_t id;
141 memif_interface_mode_t mode:8;
143 u32 per_interface_next_index;
145 /* socket connection */
146 uword socket_file_index;
148 uword conn_unix_file_index;
149 memif_msg_fifo_elt_t *msg_queue;
152 memif_region_t *regions;
154 memif_queue_t *rx_queues;
155 memif_queue_t *tx_queues;
180 /* disconnect strings */
181 u8 *local_disc_string;
182 u8 *remote_disc_string;
187 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
189 /** API message ID base */
192 /* pool of all memory interfaces */
193 memif_if_t *interfaces;
195 /* pool of all unix socket files */
196 memif_socket_file_t *socket_files;
197 mhash_t socket_file_index_by_filename;
199 /* rx buffer cache */
204 extern memif_main_t memif_main;
205 extern vnet_device_class_t memif_device_class;
206 extern vlib_node_registration_t memif_input_node;
210 MEMIF_PROCESS_EVENT_START = 1,
211 MEMIF_PROCESS_EVENT_STOP = 2,
212 } memif_process_event_t;
216 memif_interface_id_t id;
220 memif_interface_mode_t mode:8;
230 } memif_create_if_args_t;
232 int memif_create_if (vlib_main_t * vm, memif_create_if_args_t * args);
233 int memif_delete_if (vlib_main_t * vm, memif_if_t * mif);
234 clib_error_t *memif_plugin_api_hookup (vlib_main_t * vm);
236 #ifndef __NR_memfd_create
237 #if defined __x86_64__
238 #define __NR_memfd_create 319
239 #elif defined __arm__
240 #define __NR_memfd_create 385
241 #elif defined __aarch64__
242 #define __NR_memfd_create 279
244 #error "__NR_memfd_create unknown for this architecture"
249 memfd_create (const char *name, unsigned int flags)
251 return syscall (__NR_memfd_create, name, flags);
254 static_always_inline void *
255 memif_get_buffer (memif_if_t * mif, memif_ring_t * ring, u16 slot)
257 u16 region = ring->desc[slot].region;
258 return mif->regions[region].shm + ring->desc[slot].offset;
261 #ifndef F_LINUX_SPECIFIC_BASE
262 #define F_LINUX_SPECIFIC_BASE 1024
264 #define MFD_ALLOW_SEALING 0x0002U
265 #define F_ADD_SEALS (F_LINUX_SPECIFIC_BASE + 9)
266 #define F_GET_SEALS (F_LINUX_SPECIFIC_BASE + 10)
268 #define F_SEAL_SEAL 0x0001 /* prevent further seals from being set */
269 #define F_SEAL_SHRINK 0x0002 /* prevent file from shrinking */
270 #define F_SEAL_GROW 0x0004 /* prevent file from growing */
271 #define F_SEAL_WRITE 0x0008 /* prevent writes */
274 clib_error_t *memif_init_regions_and_queues (memif_if_t * mif);
275 clib_error_t *memif_connect (memif_if_t * mif);
276 void memif_disconnect (memif_if_t * mif, clib_error_t * err);
279 clib_error_t *memif_conn_fd_accept_ready (unix_file_t * uf);
280 clib_error_t *memif_master_conn_fd_read_ready (unix_file_t * uf);
281 clib_error_t *memif_slave_conn_fd_read_ready (unix_file_t * uf);
282 clib_error_t *memif_master_conn_fd_write_ready (unix_file_t * uf);
283 clib_error_t *memif_slave_conn_fd_write_ready (unix_file_t * uf);
284 clib_error_t *memif_master_conn_fd_error (unix_file_t * uf);
285 clib_error_t *memif_slave_conn_fd_error (unix_file_t * uf);
286 clib_error_t *memif_msg_send_disconnect (memif_if_t * mif,
288 u8 *format_memif_device_name (u8 * s, va_list * args);
291 * fd.io coding-style-patch-verification: ON
294 * eval: (c-set-style "gnu")