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_debug.h>
24 /* Set VPPCOM_DEBUG_INIT 2 for connection debug,
25 * 3 for read/write debug output
27 * export VCL_DEBUG=<#> to set dynamically.
29 #define VPPCOM_DEBUG_INIT 1
31 #define VPPCOM_DEBUG_INIT 0
34 #define VPPCOM_DEBUG vcm->debug
36 extern __thread uword __vcl_worker_index;
39 vcl_set_worker_index (uword wrk_index)
41 __vcl_worker_index = wrk_index;
45 vcl_get_worker_index (void)
47 return __vcl_worker_index;
51 * VPPCOM Private definitions and functions.
59 STATE_APP_ADDING_WORKER,
70 STATE_CLOSE_ON_EMPTY = 0x10,
71 STATE_DISCONNECT = 0x20,
75 #define SERVER_STATE_OPEN (STATE_ACCEPT|STATE_CLOSE_ON_EMPTY)
76 #define CLIENT_STATE_OPEN (STATE_CONNECT|STATE_CLOSE_ON_EMPTY)
77 #define STATE_OPEN (SERVER_STATE_OPEN | CLIENT_STATE_OPEN)
79 typedef struct epoll_event vppcom_epoll_event_t;
86 vppcom_epoll_event_t ev;
87 #define VEP_DEFAULT_ET_MASK (EPOLLIN|EPOLLOUT)
88 #define VEP_UNSUPPORTED_EVENTS (EPOLLONESHOT|EPOLLEXCLUSIVE)
98 typedef struct vcl_session_msg
103 session_accepted_msg_t accepted_msg;
109 VCL_SESS_ATTR_SERVER,
110 VCL_SESS_ATTR_CUT_THRU,
112 VCL_SESS_ATTR_VEP_SESSION,
113 VCL_SESS_ATTR_LISTEN, // SOL_SOCKET,SO_ACCEPTCONN
114 VCL_SESS_ATTR_NONBLOCK, // fcntl,O_NONBLOCK
115 VCL_SESS_ATTR_REUSEADDR, // SOL_SOCKET,SO_REUSEADDR
116 VCL_SESS_ATTR_REUSEPORT, // SOL_SOCKET,SO_REUSEPORT
117 VCL_SESS_ATTR_BROADCAST, // SOL_SOCKET,SO_BROADCAST
118 VCL_SESS_ATTR_V6ONLY, // SOL_TCP,IPV6_V6ONLY
119 VCL_SESS_ATTR_KEEPALIVE, // SOL_SOCKET,SO_KEEPALIVE
120 VCL_SESS_ATTR_TCP_NODELAY, // SOL_TCP,TCP_NODELAY
121 VCL_SESS_ATTR_TCP_KEEPIDLE, // SOL_TCP,TCP_KEEPIDLE
122 VCL_SESS_ATTR_TCP_KEEPINTVL, // SOL_TCP,TCP_KEEPINTVL
124 } vppcom_session_attr_t;
126 #define VCL_SESS_ATTR_SET(ATTR, VAL) \
128 (ATTR) |= 1 << (VAL); \
131 #define VCL_SESS_ATTR_CLR(ATTR, VAL) \
133 (ATTR) &= ~(1 << (VAL)); \
136 #define VCL_SESS_ATTR_TEST(ATTR, VAL) \
137 ((ATTR) & (1 << (VAL)) ? 1 : 0)
141 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
142 #define _(type, name) type name;
143 foreach_app_session_field
145 u32 sndbuf_size; // VPP-TBD: Hack until support setsockopt(SO_SNDBUF)
146 u32 rcvbuf_size; // VPP-TBD: Hack until support setsockopt(SO_RCVBUF)
147 u32 user_mss; // VPP-TBD: Hack until support setsockopt(TCP_MAXSEG)
153 /* Socket configuration state */
161 svm_msg_q_t *our_evt_q;
163 vcl_session_msg_t *accept_evts_fifo;
165 elog_track_t elog_track;
169 typedef struct vppcom_cfg_t_
173 u32 vpp_api_q_length;
176 u32 add_segment_size;
177 u32 preallocated_fifo_pairs;
180 u32 event_queue_size;
181 u32 listen_queue_size;
182 u8 app_proxy_transport_tcp;
183 u8 app_proxy_transport_udp;
187 u64 namespace_secret;
193 char *event_log_path;
194 u8 *vpp_api_filename;
195 u8 *vpp_api_socket_name;
198 void vppcom_cfg (vppcom_cfg_t * vcl_cfg);
200 typedef struct vcl_cut_through_registration_
203 svm_msg_q_t *peer_mq;
205 u32 epoll_evt_conn_index; /*< mq evt connection index part of
206 the mqs evtfd epoll (if used) */
207 } vcl_cut_through_registration_t;
209 typedef struct vcl_mq_evt_conn_
215 typedef struct vcl_worker_
217 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
220 vcl_session_t *sessions;
224 /** Message queues epoll fd. Initialized only if using mqs with eventfds */
227 /** Pool of event message queue event connections */
228 vcl_mq_evt_conn_t *mq_evt_conns;
230 /** Per worker buffer for receiving mq epoll events */
231 struct epoll_event *mq_events;
233 /** Hash table for disconnect processing */
234 uword *session_index_by_vpp_handles;
236 /** Select bitmaps */
237 clib_bitmap_t *rd_bitmap;
238 clib_bitmap_t *wr_bitmap;
239 clib_bitmap_t *ex_bitmap;
241 /** Our event message queue */
242 svm_msg_q_t *app_event_queue;
244 /** VPP workers event message queues */
245 svm_msg_q_t **vpp_event_queues;
247 /** For deadman timers */
248 clib_time_t clib_time;
250 /** Pool of cut through registrations */
251 vcl_cut_through_registration_t *cut_through_registrations;
253 /** Lock for accessing ct registration pool */
254 clib_spinlock_t ct_registration_lock;
256 /** Cut-through registration by mq address hash table */
257 uword *ct_registration_by_mq;
259 /** Vector acting as buffer for mq messages */
260 svm_msg_q_msg_t *mq_msg_vector;
262 /** Vector of unhandled events */
263 session_event_t *unhandled_evts_vector;
265 /** Used also as a thread stop key buffer */
269 typedef struct vppcom_main_t_
275 /** VPP binary api input queue */
276 svm_queue_t *vl_input_queue;
278 /** API client handle */
281 /** State of the connection, shared between msg RX thread and main thread */
282 volatile app_state_t app_state;
284 /** VCL configuration */
287 /** Flag indicating that a new segment is being mounted */
288 volatile u32 mounting_segment;
291 vcl_worker_t *workers;
293 /** Lock to protect worker registrations */
294 clib_spinlock_t workers_lock;
297 /* VPP Event-logger */
298 elog_main_t elog_main;
299 elog_track_t elog_track;
302 /* VNET_API_ERROR_FOO -> "Foo" hash table */
303 uword *error_string_by_error_number;
307 extern vppcom_main_t *vcm;
309 #define VCL_INVALID_SESSION_INDEX ((u32)~0)
311 static inline vcl_session_t *
312 vcl_session_alloc (vcl_worker_t * wrk)
315 pool_get (wrk->sessions, s);
316 memset (s, 0, sizeof (*s));
317 s->session_index = s - wrk->sessions;
322 vcl_session_free (vcl_worker_t * wrk, vcl_session_t * s)
324 pool_put (wrk->sessions, s);
327 static inline vcl_session_t *
328 vcl_session_get (vcl_worker_t * wrk, u32 session_index)
330 if (pool_is_free_index (wrk->sessions, session_index))
332 return pool_elt_at_index (wrk->sessions, session_index);
336 vcl_session_handle (vcl_session_t * s)
338 ASSERT (s->session_index < 2 << 24);
339 return (vcl_get_worker_index () << 24 | s->session_index);
343 vcl_session_handle_parse (u32 handle, u32 * wrk_index, u32 * session_index)
345 *wrk_index = handle >> 24;
346 *session_index = handle & 0xFFFFFF;
349 static inline vcl_session_t *
350 vcl_session_get_w_handle (vcl_worker_t * wrk, u32 session_handle)
352 u32 session_index, wrk_index;
353 vcl_session_handle_parse (session_handle, &wrk_index, &session_index);
354 ASSERT (wrk_index == wrk->wrk_index);
355 return vcl_session_get (wrk, session_index);
358 static inline vcl_session_t *
359 vcl_session_get_w_vpp_handle (vcl_worker_t * wrk, u64 vpp_handle)
362 if ((p = hash_get (wrk->session_index_by_vpp_handles, vpp_handle)))
363 return vcl_session_get (wrk, (u32) p[0]);
368 vcl_session_index_from_vpp_handle (vcl_worker_t * wrk, u64 vpp_handle)
371 if ((p = hash_get (wrk->session_index_by_vpp_handles, vpp_handle)))
373 return VCL_INVALID_SESSION_INDEX;
377 vcl_session_table_add_vpp_handle (vcl_worker_t * wrk, u64 handle, u32 value)
379 hash_set (wrk->session_index_by_vpp_handles, handle, value);
383 vcl_session_table_del_vpp_handle (vcl_worker_t * wrk, u64 vpp_handle)
385 hash_unset (wrk->session_index_by_vpp_handles, vpp_handle);
388 static inline uword *
389 vcl_session_table_lookup_vpp_handle (vcl_worker_t * wrk, u64 handle)
391 return hash_get (wrk->session_index_by_vpp_handles, handle);
395 vcl_session_table_add_listener (vcl_worker_t * wrk, u64 listener_handle,
398 /* Session and listener handles have different formats. The latter has
399 * the thread index in the upper 32 bits while the former has the session
400 * type. Knowing that, for listeners we just flip the MSB to 1 */
401 listener_handle |= 1ULL << 63;
402 hash_set (wrk->session_index_by_vpp_handles, listener_handle, value);
406 vcl_session_table_del_listener (vcl_worker_t * wrk, u64 listener_handle)
408 listener_handle |= 1ULL << 63;
409 hash_unset (wrk->session_index_by_vpp_handles, listener_handle);
412 static inline vcl_session_t *
413 vcl_session_table_lookup_listener (vcl_worker_t * wrk, u64 listener_handle)
416 u64 handle = listener_handle | (1ULL << 63);
417 vcl_session_t *session;
419 p = hash_get (wrk->session_index_by_vpp_handles, handle);
422 clib_warning ("VCL<%d>: couldn't find listen session: unknown vpp "
423 "listener handle %llx", getpid (), listener_handle);
426 if (pool_is_free_index (wrk->sessions, p[0]))
428 VDBG (1, "VCL<%d>: invalid listen session, sid (%u)", getpid (), p[0]);
432 session = pool_elt_at_index (wrk->sessions, p[0]);
433 ASSERT (session->session_state & STATE_LISTEN);
437 const char *vppcom_session_state_str (session_state_t state);
440 vcl_session_is_ct (vcl_session_t * s)
442 return (s->our_evt_q != 0);
448 int vcl_wait_for_app_state_change (app_state_t app_state);
449 vcl_cut_through_registration_t
450 * vcl_ct_registration_lock_and_alloc (vcl_worker_t * wrk);
451 void vcl_ct_registration_del (vcl_worker_t * wrk,
452 vcl_cut_through_registration_t * ctr);
453 u32 vcl_ct_registration_index (vcl_worker_t * wrk,
454 vcl_cut_through_registration_t * ctr);
455 void vcl_ct_registration_lock (vcl_worker_t * wrk);
456 void vcl_ct_registration_unlock (vcl_worker_t * wrk);
457 vcl_cut_through_registration_t
458 * vcl_ct_registration_lock_and_lookup (vcl_worker_t * wrk, uword mq_addr);
459 void vcl_ct_registration_lookup_add (vcl_worker_t * wrk, uword mq_addr,
461 void vcl_ct_registration_lookup_del (vcl_worker_t * wrk, uword mq_addr);
462 vcl_mq_evt_conn_t *vcl_mq_evt_conn_alloc (vcl_worker_t * wrk);
463 u32 vcl_mq_evt_conn_index (vcl_worker_t * wrk, vcl_mq_evt_conn_t * mqc);
464 vcl_mq_evt_conn_t *vcl_mq_evt_conn_get (vcl_worker_t * wrk, u32 mq_conn_idx);
465 int vcl_mq_epoll_add_evfd (vcl_worker_t * wrk, svm_msg_q_t * mq);
466 int vcl_mq_epoll_del_evfd (vcl_worker_t * wrk, u32 mqc_index);
468 vcl_worker_t *vcl_worker_alloc_and_init (void);
470 static inline vcl_worker_t *
471 vcl_worker_get (u32 wrk_index)
473 return pool_elt_at_index (vcm->workers, wrk_index);
476 static inline vcl_worker_t *
477 vcl_worker_get_current (void)
479 return vcl_worker_get (vcl_get_worker_index ());
485 int vppcom_connect_to_vpp (char *app_name);
486 void vppcom_init_error_string_table (void);
487 void vppcom_send_session_enable_disable (u8 is_enable);
488 void vppcom_app_send_attach (void);
489 void vppcom_app_send_detach (void);
490 void vppcom_send_connect_sock (vcl_session_t * session);
491 void vppcom_send_disconnect_session (u64 vpp_handle);
492 void vppcom_send_bind_sock (vcl_session_t * session);
493 void vppcom_send_unbind_sock (u64 vpp_handle);
494 void vppcom_api_hookup (void);
495 void vppcom_send_accept_session_reply (u64 vpp_handle, u32 context, int rv);
496 void vcl_send_app_worker_add_del (u8 is_add);
498 u32 vcl_max_nsid_len (void);
500 u8 *format_api_error (u8 * s, va_list * args);
502 #endif /* SRC_VCL_VCL_PRIVATE_H_ */
505 * fd.io coding-style-patch-verification: ON
508 * eval: (c-set-style "gnu")