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 256
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) \
69 *a = clib_file_add (&file_main, b); \
70 memif_log_debug (0, "clib_file_add fd %d private_data %u idx %u", \
71 (b)->file_descriptor, (b)->private_data, *a); \
75 #define memif_file_del(a) \
78 memif_log_debug (0, "clib_file_del idx %u", a - file_main.file_pool); \
79 clib_file_del (&file_main, a); \
83 #define memif_file_del_by_index(a) \
86 memif_log_debug (0, "clib_file_del idx %u", a); \
87 clib_file_del_by_index (&file_main, a); \
96 clib_socket_t **pending_clients;
100 /* hash of all registered id */
101 mhash_t dev_instance_by_id;
103 /* hash of all registered fds */
104 uword *dev_instance_by_fd;
105 } memif_socket_file_t;
109 /* Required for vec_validate_aligned */
110 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
112 memif_region_size_t region_size;
121 } memif_msg_fifo_elt_t;
125 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
126 clib_spinlock_t lockp;
129 memif_log2_ring_size_t log2_ring_size;
130 memif_region_index_t region;
131 memif_region_offset_t offset;
136 u8 buffer_pool_index;
140 uword int_clib_file_index;
144 memif_ring_type_t type;
148 #define foreach_memif_if_flag \
149 _(0, ADMIN_UP, "admin-up") \
150 _(1, IS_SLAVE, "slave") \
151 _(2, CONNECTING, "connecting") \
152 _(3, CONNECTED, "connected") \
153 _(4, DELETING, "deleting") \
154 _(5, ZERO_COPY, "zero-copy") \
159 #define _(a, b, c) MEMIF_IF_FLAG_##b = (1 << a),
160 foreach_memif_if_flag
166 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
168 memif_interface_id_t id;
172 memif_interface_mode_t mode:8;
174 u32 per_interface_next_index;
176 /* socket connection */
178 uword socket_file_index;
179 memif_msg_fifo_elt_t *msg_queue;
182 memif_region_t *regions;
184 memif_queue_t *rx_queues;
185 memif_queue_t *tx_queues;
193 memif_log2_ring_size_t log2_ring_size;
201 memif_log2_ring_size_t log2_ring_size;
207 /* disconnect strings */
208 u8 *local_disc_string;
209 u8 *remote_disc_string;
215 u16 first_buffer_vec_index;
220 CLIB_ALIGN_MARK (pad, 16); /* align up to 16 bytes for 32bit builds */
224 u16 buffer_vec_index;
227 #define MEMIF_RX_VECTOR_SZ VLIB_FRAME_SIZE
231 MEMIF_DESC_STATUS_OK = 0,
232 MEMIF_DESC_STATUS_ERR_BAD_REGION,
233 MEMIF_DESC_STATUS_ERR_REGION_OVERRUN,
234 MEMIF_DESC_STATUS_ERR_DATA_TOO_BIG,
235 MEMIF_DESC_STATUS_ERR_ZERO_LENGTH
236 } __clib_packed memif_desc_status_err_code_t;
245 memif_desc_status_err_code_t err_code : 4;
248 } memif_desc_status_t;
250 STATIC_ASSERT_SIZEOF (memif_desc_status_t, 1);
254 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
260 memif_copy_op_t *copy_ops;
262 memif_packet_op_t packet_ops[MEMIF_RX_VECTOR_SZ];
264 /* temp storage for compressed descriptors */
267 memif_desc_status_t *desc_status;
269 /* buffer template */
270 vlib_buffer_t buffer_template;
271 } memif_per_thread_data_t;
275 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
277 /** API message ID base */
280 /* pool of all memory interfaces */
281 memif_if_t *interfaces;
283 /* pool of all unix socket files */
284 memif_socket_file_t *socket_files;
285 uword *socket_file_index_by_sock_id; /* map user socket id to pool idx */
287 /* per thread data */
288 memif_per_thread_data_t *per_thread_data;
290 vlib_log_class_t log_class;
294 extern memif_main_t memif_main;
295 extern vnet_device_class_t memif_device_class;
296 extern vlib_node_registration_t memif_input_node;
300 MEMIF_PROCESS_EVENT_START = 1,
301 MEMIF_PROCESS_EVENT_STOP = 2,
302 MEMIF_PROCESS_EVENT_ADMIN_UP_DOWN = 3,
303 } memif_process_event_t;
307 memif_interface_id_t id;
312 memif_interface_mode_t mode:8;
313 memif_log2_ring_size_t log2_ring_size;
322 } memif_create_if_args_t;
324 u32 memif_get_unused_socket_id ();
325 clib_error_t *memif_socket_filename_add_del (u8 is_add, u32 sock_id,
326 char *sock_filename);
327 clib_error_t *memif_create_if (vlib_main_t *vm, memif_create_if_args_t *args);
328 clib_error_t *memif_delete_if (vlib_main_t *vm, memif_if_t *mif);
329 clib_error_t *memif_plugin_api_hookup (vlib_main_t * vm);
330 clib_error_t *memif_interface_admin_up_down (vnet_main_t *vnm, u32 hw_if_index,
333 static_always_inline void *
334 memif_get_buffer (memif_if_t * mif, memif_ring_t * ring, u16 slot)
336 u16 region = ring->desc[slot].region;
337 return mif->regions[region].shm + ring->desc[slot].offset;
341 clib_error_t *memif_init_regions_and_queues (memif_if_t * mif);
342 clib_error_t *memif_connect (memif_if_t * mif);
343 void memif_disconnect (memif_if_t * mif, clib_error_t * err);
346 void memif_socket_close (clib_socket_t ** sock);
347 clib_error_t *memif_conn_fd_accept_ready (clib_file_t * uf);
348 clib_error_t *memif_master_conn_fd_read_ready (clib_file_t * uf);
349 clib_error_t *memif_slave_conn_fd_read_ready (clib_file_t * uf);
350 clib_error_t *memif_master_conn_fd_write_ready (clib_file_t * uf);
351 clib_error_t *memif_slave_conn_fd_write_ready (clib_file_t * uf);
352 clib_error_t *memif_master_conn_fd_error (clib_file_t * uf);
353 clib_error_t *memif_slave_conn_fd_error (clib_file_t * uf);
354 clib_error_t *memif_msg_send_disconnect (memif_if_t * mif,
356 u8 *format_memif_device_name (u8 * s, va_list * args);
360 * fd.io coding-style-patch-verification: ON
363 * eval: (c-set-style "gnu")