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_FILENAME "memif.sock"
21 #define MEMIF_DEFAULT_RING_SIZE 1024
22 #define MEMIF_DEFAULT_RX_QUEUES 1
23 #define MEMIF_DEFAULT_TX_QUEUES 1
24 #define MEMIF_DEFAULT_BUFFER_SIZE 2048
26 #define MEMIF_MAX_M2S_RING (vec_len (vlib_mains) - 1)
27 #define MEMIF_MAX_S2M_RING (vec_len (vlib_mains) - 1)
28 #define MEMIF_MAX_REGION 255
29 #define MEMIF_MAX_LOG2_RING_SIZE 14
34 #define DBG(...) clib_warning(__VA_ARGS__)
35 #define DBG_UNIX_LOG(...) clib_unix_warning(__VA_ARGS__)
38 #define DBG_UNIX_LOG(...)
42 #define memif_file_add(a, b) do { \
43 *a = clib_file_add (&file_main, b); \
44 clib_warning ("clib_file_add fd %d private_data %u idx %u", \
45 (b)->file_descriptor, (b)->private_data, *a); \
48 #define memif_file_del(a) do { \
49 clib_warning ("clib_file_del idx %u",a - file_main.file_pool); \
50 clib_file_del (&file_main, a); \
53 #define memif_file_del_by_index(a) do { \
54 clib_warning ("clib_file_del idx %u", a); \
55 clib_file_del_by_index (&file_main, a); \
58 #define memif_file_add(a, b) do { \
59 *a = clib_file_add (&file_main, b); \
61 #define memif_file_del(a) clib_file_del(&file_main, a)
62 #define memif_file_del_by_index(a) clib_file_del_by_index(&file_main, a)
70 clib_socket_t **pending_clients;
74 /* hash of all registered id */
75 mhash_t dev_instance_by_id;
77 /* hash of all registered fds */
78 uword *dev_instance_by_fd;
79 } memif_socket_file_t;
84 memif_region_size_t region_size;
93 } memif_msg_fifo_elt_t;
99 memif_log2_ring_size_t log2_ring_size;
100 memif_region_index_t region;
101 memif_region_offset_t offset;
109 uword int_clib_file_index;
113 memif_ring_type_t type;
116 #define foreach_memif_if_flag \
117 _(0, ADMIN_UP, "admin-up") \
118 _(1, IS_SLAVE, "slave") \
119 _(2, CONNECTING, "connecting") \
120 _(3, CONNECTED, "connected") \
121 _(4, DELETING, "deleting") \
122 _(5, ZERO_COPY, "zero-copy") \
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 */
147 uword socket_file_index;
148 memif_msg_fifo_elt_t *msg_queue;
151 memif_region_t *regions;
153 memif_queue_t *rx_queues;
154 memif_queue_t *tx_queues;
162 memif_log2_ring_size_t log2_ring_size;
170 memif_log2_ring_size_t log2_ring_size;
176 /* disconnect strings */
177 u8 *local_disc_string;
178 u8 *remote_disc_string;
184 u16 first_buffer_vec_index;
192 u16 buffer_vec_index;
195 #define MEMIF_RX_VECTOR_SZ VLIB_FRAME_SIZE
199 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
202 memif_packet_op_t packet_ops[MEMIF_RX_VECTOR_SZ];
203 memif_copy_op_t *copy_ops;
206 /* buffer template */
207 vlib_buffer_t buffer_template;
208 memif_desc_t desc_template;
209 } memif_per_thread_data_t;
213 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
215 /** API message ID base */
218 /* pool of all memory interfaces */
219 memif_if_t *interfaces;
221 /* pool of all unix socket files */
222 memif_socket_file_t *socket_files;
223 uword *socket_file_index_by_sock_id; /* map user socket id to pool idx */
225 /* per thread data */
226 memif_per_thread_data_t *per_thread_data;
230 extern memif_main_t memif_main;
231 extern vnet_device_class_t memif_device_class;
232 extern vlib_node_registration_t memif_input_node;
236 MEMIF_PROCESS_EVENT_START = 1,
237 MEMIF_PROCESS_EVENT_STOP = 2,
238 } memif_process_event_t;
242 memif_interface_id_t id;
247 memif_interface_mode_t mode:8;
248 memif_log2_ring_size_t log2_ring_size;
257 } memif_create_if_args_t;
259 int memif_socket_filename_add_del (u8 is_add, u32 sock_id,
261 int memif_create_if (vlib_main_t * vm, memif_create_if_args_t * args);
262 int memif_delete_if (vlib_main_t * vm, memif_if_t * mif);
263 clib_error_t *memif_plugin_api_hookup (vlib_main_t * vm);
265 static_always_inline void *
266 memif_get_buffer (memif_if_t * mif, memif_ring_t * ring, u16 slot)
268 u16 region = ring->desc[slot].region;
269 return mif->regions[region].shm + ring->desc[slot].offset;
273 clib_error_t *memif_init_regions_and_queues (memif_if_t * mif);
274 clib_error_t *memif_connect (memif_if_t * mif);
275 void memif_disconnect (memif_if_t * mif, clib_error_t * err);
278 void memif_socket_close (clib_socket_t ** sock);
279 clib_error_t *memif_conn_fd_accept_ready (clib_file_t * uf);
280 clib_error_t *memif_master_conn_fd_read_ready (clib_file_t * uf);
281 clib_error_t *memif_slave_conn_fd_read_ready (clib_file_t * uf);
282 clib_error_t *memif_master_conn_fd_write_ready (clib_file_t * uf);
283 clib_error_t *memif_slave_conn_fd_write_ready (clib_file_t * uf);
284 clib_error_t *memif_master_conn_fd_error (clib_file_t * uf);
285 clib_error_t *memif_slave_conn_fd_error (clib_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")