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) - 1)
28 #define MEMIF_MAX_S2M_RING (vec_len (vlib_mains) - 1)
29 #define MEMIF_MAX_REGION 255
30 #define MEMIF_MAX_LOG2_RING_SIZE 14
33 #define memif_file_add(a, b) do { \
34 *a = clib_file_add (&file_main, b); \
35 vlib_log_warn ((&memif_main)->log_class, \
36 "clib_file_add fd %d private_data %u idx %u", \
37 (b)->file_descriptor, (b)->private_data, *a); \
40 #define memif_file_del(a) do { \
41 vlib_log_warn ((&memif_main)->log_class, \
42 "clib_file_del idx %u",a - file_main.file_pool); \
43 clib_file_del (&file_main, a); \
46 #define memif_file_del_by_index(a) do { \
47 vlib_log_warn ((&memif_main)->log_class, "clib_file_del idx %u", a); \
48 clib_file_del_by_index (&file_main, a); \
56 clib_socket_t **pending_clients;
60 /* hash of all registered id */
61 mhash_t dev_instance_by_id;
63 /* hash of all registered fds */
64 uword *dev_instance_by_fd;
65 } memif_socket_file_t;
69 /* Required for vec_validate_aligned */
70 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
72 memif_region_size_t region_size;
81 } memif_msg_fifo_elt_t;
87 memif_log2_ring_size_t log2_ring_size;
88 memif_region_index_t region;
89 memif_region_offset_t offset;
97 uword int_clib_file_index;
101 memif_ring_type_t type;
104 #define foreach_memif_if_flag \
105 _(0, ADMIN_UP, "admin-up") \
106 _(1, IS_SLAVE, "slave") \
107 _(2, CONNECTING, "connecting") \
108 _(3, CONNECTED, "connected") \
109 _(4, DELETING, "deleting") \
110 _(5, ZERO_COPY, "zero-copy") \
115 #define _(a, b, c) MEMIF_IF_FLAG_##b = (1 << a),
116 foreach_memif_if_flag
122 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
123 clib_spinlock_t lockp;
125 memif_interface_id_t id;
129 memif_interface_mode_t mode:8;
131 u32 per_interface_next_index;
133 /* socket connection */
135 uword socket_file_index;
136 memif_msg_fifo_elt_t *msg_queue;
139 memif_region_t *regions;
141 memif_queue_t *rx_queues;
142 memif_queue_t *tx_queues;
150 memif_log2_ring_size_t log2_ring_size;
158 memif_log2_ring_size_t log2_ring_size;
164 /* disconnect strings */
165 u8 *local_disc_string;
166 u8 *remote_disc_string;
172 u16 first_buffer_vec_index;
180 u16 buffer_vec_index;
183 #define MEMIF_RX_VECTOR_SZ VLIB_FRAME_SIZE
187 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
190 memif_packet_op_t packet_ops[MEMIF_RX_VECTOR_SZ];
191 memif_copy_op_t *copy_ops;
194 /* buffer template */
195 vlib_buffer_t buffer_template;
196 memif_desc_t desc_template;
197 } memif_per_thread_data_t;
201 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
203 /** API message ID base */
206 /* pool of all memory interfaces */
207 memif_if_t *interfaces;
209 /* pool of all unix socket files */
210 memif_socket_file_t *socket_files;
211 uword *socket_file_index_by_sock_id; /* map user socket id to pool idx */
213 /* per thread data */
214 memif_per_thread_data_t *per_thread_data;
216 vlib_log_class_t log_class;
220 extern memif_main_t memif_main;
221 extern vnet_device_class_t memif_device_class;
222 extern vlib_node_registration_t memif_input_node;
226 MEMIF_PROCESS_EVENT_START = 1,
227 MEMIF_PROCESS_EVENT_STOP = 2,
228 } memif_process_event_t;
232 memif_interface_id_t id;
237 memif_interface_mode_t mode:8;
238 memif_log2_ring_size_t log2_ring_size;
247 } memif_create_if_args_t;
249 int memif_socket_filename_add_del (u8 is_add, u32 sock_id,
251 int memif_create_if (vlib_main_t * vm, memif_create_if_args_t * args);
252 int memif_delete_if (vlib_main_t * vm, memif_if_t * mif);
253 clib_error_t *memif_plugin_api_hookup (vlib_main_t * vm);
255 static_always_inline void *
256 memif_get_buffer (memif_if_t * mif, memif_ring_t * ring, u16 slot)
258 u16 region = ring->desc[slot].region;
259 return mif->regions[region].shm + ring->desc[slot].offset;
263 clib_error_t *memif_init_regions_and_queues (memif_if_t * mif);
264 clib_error_t *memif_connect (memif_if_t * mif);
265 void memif_disconnect (memif_if_t * mif, clib_error_t * err);
268 void memif_socket_close (clib_socket_t ** sock);
269 clib_error_t *memif_conn_fd_accept_ready (clib_file_t * uf);
270 clib_error_t *memif_master_conn_fd_read_ready (clib_file_t * uf);
271 clib_error_t *memif_slave_conn_fd_read_ready (clib_file_t * uf);
272 clib_error_t *memif_master_conn_fd_write_ready (clib_file_t * uf);
273 clib_error_t *memif_slave_conn_fd_write_ready (clib_file_t * uf);
274 clib_error_t *memif_master_conn_fd_error (clib_file_t * uf);
275 clib_error_t *memif_slave_conn_fd_error (clib_file_t * uf);
276 clib_error_t *memif_msg_send_disconnect (memif_if_t * mif,
278 u8 *format_memif_device_name (u8 * s, va_list * args);
281 * fd.io coding-style-patch-verification: ON
284 * eval: (c-set-style "gnu")