2 * Copyright (c) 2018 Cisco and/or its affiliates.
3 * Licensed under the Apache License, Version 2.0 (the "License");
5 * You may obtain a copy of the License at:
7 * http://www.apache.org/licenses/LICENSE-2.0
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
16 #ifndef SRC_VCL_VCL_PRIVATE_H_
17 #define SRC_VCL_VCL_PRIVATE_H_
19 #include <vnet/session/application_interface.h>
20 #include <vcl/vppcom.h>
21 #include <vcl/vcl_event.h>
22 #include <vcl/vcl_debug.h>
25 /* Set VPPCOM_DEBUG_INIT 2 for connection debug,
26 * 3 for read/write debug output
28 * export VCL_DEBUG=<#> to set dynamically.
30 #define VPPCOM_DEBUG_INIT 1
32 #define VPPCOM_DEBUG_INIT 0
35 #define VPPCOM_DEBUG vcm->debug
38 * VPPCOM Private definitions and functions.
54 STATE_CLOSE_ON_EMPTY = 0x10,
55 STATE_DISCONNECT = 0x20,
59 #define SERVER_STATE_OPEN (STATE_ACCEPT|STATE_CLOSE_ON_EMPTY)
60 #define CLIENT_STATE_OPEN (STATE_CONNECT|STATE_CLOSE_ON_EMPTY)
61 #define STATE_OPEN (SERVER_STATE_OPEN | CLIENT_STATE_OPEN)
63 typedef struct epoll_event vppcom_epoll_event_t;
70 vppcom_epoll_event_t ev;
71 #define VEP_DEFAULT_ET_MASK (EPOLLIN|EPOLLOUT)
72 #define VEP_UNSUPPORTED_EVENTS (EPOLLONESHOT|EPOLLEXCLUSIVE)
82 typedef struct vcl_session_msg
87 session_accepted_msg_t accepted_msg;
94 VCL_SESS_ATTR_CUT_THRU,
96 VCL_SESS_ATTR_VEP_SESSION,
97 VCL_SESS_ATTR_LISTEN, // SOL_SOCKET,SO_ACCEPTCONN
98 VCL_SESS_ATTR_NONBLOCK, // fcntl,O_NONBLOCK
99 VCL_SESS_ATTR_REUSEADDR, // SOL_SOCKET,SO_REUSEADDR
100 VCL_SESS_ATTR_REUSEPORT, // SOL_SOCKET,SO_REUSEPORT
101 VCL_SESS_ATTR_BROADCAST, // SOL_SOCKET,SO_BROADCAST
102 VCL_SESS_ATTR_V6ONLY, // SOL_TCP,IPV6_V6ONLY
103 VCL_SESS_ATTR_KEEPALIVE, // SOL_SOCKET,SO_KEEPALIVE
104 VCL_SESS_ATTR_TCP_NODELAY, // SOL_TCP,TCP_NODELAY
105 VCL_SESS_ATTR_TCP_KEEPIDLE, // SOL_TCP,TCP_KEEPIDLE
106 VCL_SESS_ATTR_TCP_KEEPINTVL, // SOL_TCP,TCP_KEEPINTVL
108 } vppcom_session_attr_t;
110 #define VCL_SESS_ATTR_SET(ATTR, VAL) \
112 (ATTR) |= 1 << (VAL); \
115 #define VCL_SESS_ATTR_CLR(ATTR, VAL) \
117 (ATTR) &= ~(1 << (VAL)); \
120 #define VCL_SESS_ATTR_TEST(ATTR, VAL) \
121 ((ATTR) & (1 << (VAL)) ? 1 : 0)
125 #define _(type, name) type name;
126 foreach_app_session_field
128 u32 sndbuf_size; // VPP-TBD: Hack until support setsockopt(SO_SNDBUF)
129 u32 rcvbuf_size; // VPP-TBD: Hack until support setsockopt(SO_RCVBUF)
130 u32 user_mss; // VPP-TBD: Hack until support setsockopt(TCP_MAXSEG)
136 /* Socket configuration state */
143 svm_msg_q_t *our_evt_q;
145 vce_event_handler_reg_t *poll_reg;
146 vcl_session_msg_t *accept_evts_fifo;
148 elog_track_t elog_track;
152 typedef struct vppcom_cfg_t_
155 u32 vpp_api_q_length;
158 u32 add_segment_size;
159 u32 preallocated_fifo_pairs;
162 u32 event_queue_size;
163 u32 listen_queue_size;
164 u8 app_proxy_transport_tcp;
165 u8 app_proxy_transport_udp;
169 u64 namespace_secret;
175 char *event_log_path;
176 u8 *vpp_api_filename;
177 u8 *vpp_api_socket_name;
180 void vppcom_cfg (vppcom_cfg_t * vcl_cfg);
182 typedef struct vcl_cut_through_registration_
185 svm_msg_q_t *peer_mq;
187 u32 epoll_evt_conn_index; /*< mq evt connection index part of
188 the mqs evtfd epoll (if used) */
189 } vcl_cut_through_registration_t;
191 typedef struct vcl_mq_evt_conn_
197 typedef struct vppcom_main_t_
203 /* vpp input queue */
204 svm_queue_t *vl_input_queue;
206 /* API client handle */
209 vcl_session_t *sessions;
211 /** Message queues epoll fd. Initialized only if using mqs with eventfds */
214 /** Pool of event message queue event connections */
215 vcl_mq_evt_conn_t *mq_evt_conns;
217 /** Per worker buffer for receiving mq epoll events */
218 struct epoll_event *mq_events;
220 /* Hash table for disconnect processing */
221 uword *session_index_by_vpp_handles;
224 clib_bitmap_t *rd_bitmap;
225 clib_bitmap_t *wr_bitmap;
226 clib_bitmap_t *ex_bitmap;
228 /* Our event queue */
229 svm_msg_q_t *app_event_queue;
231 svm_msg_q_t **vpp_event_queues;
233 /* unique segment name counter */
234 u32 unique_segment_index;
236 /* For deadman timers */
237 clib_time_t clib_time;
239 /* State of the connection, shared between msg RX thread and main thread */
240 volatile app_state_t app_state;
245 vce_event_thread_t event_thread;
248 vppcom_session_io_thread_t session_io_thread;
250 /* pool of ctrl msgs */
251 vcl_session_msg_t *ctrl_evt_pool;
253 /** Pool of cut through registrations */
254 vcl_cut_through_registration_t *cut_through_registrations;
256 /** Lock for accessing ct registration pool */
257 clib_spinlock_t ct_registration_lock;
259 /** Cut-through registration by mq address hash table */
260 uword *ct_registration_by_mq;
262 svm_msg_q_msg_t *mq_msg_vector;
264 /** Flag indicating that a new segment is being mounted */
265 volatile u32 mounting_segment;
268 /* VPP Event-logger */
269 elog_main_t elog_main;
270 elog_track_t elog_track;
273 /* VNET_API_ERROR_FOO -> "Foo" hash table */
274 uword *error_string_by_error_number;
277 extern vppcom_main_t *vcm;
279 #define VCL_INVALID_SESSION_INDEX ((u32)~0)
281 static inline vcl_session_t *
282 vcl_session_alloc (void)
285 pool_get (vcm->sessions, s);
286 memset (s, 0, sizeof (*s));
291 vcl_session_free (vcl_session_t * s)
293 pool_put (vcm->sessions, s);
296 static inline vcl_session_t *
297 vcl_session_get (u32 session_index)
299 if (pool_is_free_index (vcm->sessions, session_index))
301 return pool_elt_at_index (vcm->sessions, session_index);
305 vcl_session_index (vcl_session_t * s)
307 return (s - vcm->sessions);
310 static inline vcl_session_t *
311 vcl_session_get_w_handle (u64 handle)
314 if ((p = hash_get (vcm->session_index_by_vpp_handles, handle)))
315 return vcl_session_get ((u32) p[0]);
320 vcl_session_get_index_from_handle (u64 handle)
323 if ((p = hash_get (vcm->session_index_by_vpp_handles, handle)))
325 return VCL_INVALID_SESSION_INDEX;
329 vcl_session_is_ct (vcl_session_t * s)
331 return (s->our_evt_q != 0);
335 vppcom_session_table_add_listener (u64 listener_handle, u32 value)
337 /* Session and listener handles have different formats. The latter has
338 * the thread index in the upper 32 bits while the former has the session
339 * type. Knowing that, for listeners we just flip the MSB to 1 */
340 listener_handle |= 1ULL << 63;
341 hash_set (vcm->session_index_by_vpp_handles, listener_handle, value);
344 static inline vcl_session_t *
345 vppcom_session_table_lookup_listener (u64 listener_handle)
348 u64 handle = listener_handle | (1ULL << 63);
349 vcl_session_t *session;
351 p = hash_get (vcm->session_index_by_vpp_handles, handle);
354 clib_warning ("VCL<%d>: couldn't find listen session: unknown vpp "
355 "listener handle %llx", getpid (), listener_handle);
358 if (pool_is_free_index (vcm->sessions, p[0]))
360 VDBG (1, "VCL<%d>: invalid listen session, sid (%u)", getpid (), p[0]);
364 session = pool_elt_at_index (vcm->sessions, p[0]);
365 ASSERT (session->session_state & STATE_LISTEN);
369 const char *vppcom_session_state_str (session_state_t state);
374 vcl_cut_through_registration_t *vcl_ct_registration_lock_and_alloc (void);
375 void vcl_ct_registration_del (vcl_cut_through_registration_t * ctr);
376 u32 vcl_ct_registration_index (vcl_cut_through_registration_t * ctr);
377 void vcl_ct_registration_unlock (void);
378 vcl_cut_through_registration_t *vcl_ct_registration_get (u32 ctr_index);
379 vcl_cut_through_registration_t *vcl_ct_registration_lock_and_lookup (uword);
380 void vcl_ct_registration_lookup_add (uword mq_addr, u32 ctr_index);
381 void vcl_ct_registration_lookup_del (uword mq_addr);
382 vcl_mq_evt_conn_t *vcl_mq_evt_conn_alloc (void);
383 u32 vcl_mq_evt_conn_index (vcl_mq_evt_conn_t * mqc);
384 vcl_mq_evt_conn_t *vcl_mq_evt_conn_get (u32 mq_conn_idx);
385 int vcl_mq_epoll_add_evfd (svm_msg_q_t * mq);
386 int vcl_mq_epoll_del_evfd (u32 mqc_index);
391 int vppcom_connect_to_vpp (char *app_name);
392 void vppcom_init_error_string_table (void);
393 void vppcom_send_session_enable_disable (u8 is_enable);
394 void vppcom_app_send_attach (void);
395 void vppcom_app_send_detach (void);
396 void vppcom_send_connect_sock (vcl_session_t * session, u32 session_index);
397 void vppcom_send_disconnect_session_reply (u64 vpp_handle, u32 session_index,
399 void vppcom_send_disconnect_session (u64 vpp_handle, u32 session_index);
400 void vppcom_send_bind_sock (vcl_session_t * session, u32 session_index);
401 void vppcom_send_unbind_sock (u64 vpp_handle);
402 void vppcom_api_hookup (void);
403 void vppcom_send_accept_session_reply (u64 handle, u32 context, int retval);
405 u32 vcl_max_nsid_len (void);
407 u8 *format_api_error (u8 * s, va_list * args);
409 #endif /* SRC_VCL_VCL_PRIVATE_H_ */
412 * fd.io coding-style-patch-verification: ON
415 * eval: (c-set-style "gnu")