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>
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_MAX_M2S_RING (vec_len (vlib_mains))
28 #define MEMIF_MAX_S2M_RING 256
29 #define MEMIF_MAX_REGION 256
30 #define MEMIF_MAX_LOG2_RING_SIZE 14
33 #define memif_log_debug(dev, f, ...) do { \
34 memif_if_t *_dev = (memif_if_t *) dev; \
36 vlib_log(VLIB_LOG_LEVEL_DEBUG, memif_main.log_class, "%U: " f, \
37 format_vnet_hw_if_index_name, vnet_get_main(), \
38 _dev->hw_if_index, ##__VA_ARGS__); \
40 vlib_log(VLIB_LOG_LEVEL_DEBUG, memif_main.log_class, f, \
44 #define memif_log_warn(dev, f, ...) do { \
45 memif_if_t *_dev = (memif_if_t *) dev; \
47 vlib_log(VLIB_LOG_LEVEL_WARNING, memif_main.log_class, "%U: " f, \
48 format_vnet_hw_if_index_name, vnet_get_main(), \
49 _dev->hw_if_index, ##__VA_ARGS__); \
51 vlib_log(VLIB_LOG_LEVEL_WARNING, memif_main.log_class, f, \
55 #define memif_log_err(dev, f, ...) do { \
56 memif_if_t *_dev = (memif_if_t *) dev; \
58 vlib_log(VLIB_LOG_LEVEL_ERR, memif_main.log_class, "%U: " f, \
59 format_vnet_hw_if_index_name, vnet_get_main(), \
60 _dev->hw_if_index, ##__VA_ARGS__); \
62 vlib_log(VLIB_LOG_LEVEL_ERR, memif_main.log_class, f, \
66 #define memif_file_add(a, b) do { \
67 *a = clib_file_add (&file_main, b); \
68 memif_log_warn (0, "clib_file_add fd %d private_data %u idx %u", \
69 (b)->file_descriptor, (b)->private_data, *a); \
72 #define memif_file_del(a) do { \
73 memif_log_warn (0, "clib_file_del idx %u", a - file_main.file_pool); \
74 clib_file_del (&file_main, a); \
77 #define memif_file_del_by_index(a) do { \
78 memif_log_warn (0, "clib_file_del idx %u", a); \
79 clib_file_del_by_index (&file_main, a); \
87 clib_socket_t **pending_clients;
91 /* hash of all registered id */
92 mhash_t dev_instance_by_id;
94 /* hash of all registered fds */
95 uword *dev_instance_by_fd;
96 } memif_socket_file_t;
100 /* Required for vec_validate_aligned */
101 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
103 memif_region_size_t region_size;
112 } memif_msg_fifo_elt_t;
116 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
119 memif_log2_ring_size_t log2_ring_size;
120 memif_region_index_t region;
121 memif_region_offset_t offset;
126 u8 buffer_pool_index;
130 uword int_clib_file_index;
134 memif_ring_type_t type;
137 #define foreach_memif_if_flag \
138 _(0, ADMIN_UP, "admin-up") \
139 _(1, IS_SLAVE, "slave") \
140 _(2, CONNECTING, "connecting") \
141 _(3, CONNECTED, "connected") \
142 _(4, DELETING, "deleting") \
143 _(5, ZERO_COPY, "zero-copy") \
148 #define _(a, b, c) MEMIF_IF_FLAG_##b = (1 << a),
149 foreach_memif_if_flag
155 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
156 clib_spinlock_t lockp;
158 memif_interface_id_t id;
162 memif_interface_mode_t mode:8;
164 u32 per_interface_next_index;
166 /* socket connection */
168 uword socket_file_index;
169 memif_msg_fifo_elt_t *msg_queue;
172 memif_region_t *regions;
174 memif_queue_t *rx_queues;
175 memif_queue_t *tx_queues;
183 memif_log2_ring_size_t log2_ring_size;
191 memif_log2_ring_size_t log2_ring_size;
197 /* disconnect strings */
198 u8 *local_disc_string;
199 u8 *remote_disc_string;
205 u16 first_buffer_vec_index;
210 CLIB_ALIGN_MARK (pad, 16); /* align up to 16 bytes for 32bit builds */
214 u16 buffer_vec_index;
217 #define MEMIF_RX_VECTOR_SZ VLIB_FRAME_SIZE
221 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
224 memif_packet_op_t packet_ops[MEMIF_RX_VECTOR_SZ];
225 memif_copy_op_t *copy_ops;
228 /* buffer template */
229 vlib_buffer_t buffer_template;
230 memif_desc_t desc_template;
231 } memif_per_thread_data_t;
235 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
237 /** API message ID base */
240 /* pool of all memory interfaces */
241 memif_if_t *interfaces;
243 /* pool of all unix socket files */
244 memif_socket_file_t *socket_files;
245 uword *socket_file_index_by_sock_id; /* map user socket id to pool idx */
247 /* per thread data */
248 memif_per_thread_data_t *per_thread_data;
250 vlib_log_class_t log_class;
254 extern memif_main_t memif_main;
255 extern vnet_device_class_t memif_device_class;
256 extern vlib_node_registration_t memif_input_node;
260 MEMIF_PROCESS_EVENT_START = 1,
261 MEMIF_PROCESS_EVENT_STOP = 2,
262 } memif_process_event_t;
266 memif_interface_id_t id;
271 memif_interface_mode_t mode:8;
272 memif_log2_ring_size_t log2_ring_size;
281 } memif_create_if_args_t;
283 int memif_socket_filename_add_del (u8 is_add, u32 sock_id,
285 int memif_create_if (vlib_main_t * vm, memif_create_if_args_t * args);
286 int memif_delete_if (vlib_main_t * vm, memif_if_t * mif);
287 clib_error_t *memif_plugin_api_hookup (vlib_main_t * vm);
289 static_always_inline void *
290 memif_get_buffer (memif_if_t * mif, memif_ring_t * ring, u16 slot)
292 u16 region = ring->desc[slot].region;
293 return mif->regions[region].shm + ring->desc[slot].offset;
297 clib_error_t *memif_init_regions_and_queues (memif_if_t * mif);
298 clib_error_t *memif_connect (memif_if_t * mif);
299 void memif_disconnect (memif_if_t * mif, clib_error_t * err);
302 void memif_socket_close (clib_socket_t ** sock);
303 clib_error_t *memif_conn_fd_accept_ready (clib_file_t * uf);
304 clib_error_t *memif_master_conn_fd_read_ready (clib_file_t * uf);
305 clib_error_t *memif_slave_conn_fd_read_ready (clib_file_t * uf);
306 clib_error_t *memif_master_conn_fd_write_ready (clib_file_t * uf);
307 clib_error_t *memif_slave_conn_fd_write_ready (clib_file_t * uf);
308 clib_error_t *memif_master_conn_fd_error (clib_file_t * uf);
309 clib_error_t *memif_slave_conn_fd_error (clib_file_t * uf);
310 clib_error_t *memif_msg_send_disconnect (memif_if_t * mif,
312 u8 *format_memif_device_name (u8 * s, va_list * args);
316 * fd.io coding-style-patch-verification: ON
319 * eval: (c-set-style "gnu")