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_VPP_CLOSING = 0x10,
71 STATE_DISCONNECT = 0x20,
76 #define SERVER_STATE_OPEN (STATE_ACCEPT|STATE_VPP_CLOSING)
77 #define CLIENT_STATE_OPEN (STATE_CONNECT|STATE_VPP_CLOSING)
78 #define STATE_OPEN (SERVER_STATE_OPEN | CLIENT_STATE_OPEN)
80 typedef struct epoll_event vppcom_epoll_event_t;
87 vppcom_epoll_event_t ev;
88 #define VEP_DEFAULT_ET_MASK (EPOLLIN|EPOLLOUT)
89 #define VEP_UNSUPPORTED_EVENTS (EPOLLONESHOT|EPOLLEXCLUSIVE)
93 /* Select uses the vcl_si_set as if a clib_bitmap. Make sure they are the
95 STATIC_ASSERT (sizeof (clib_bitmap_t) == sizeof (vcl_si_set),
96 "vppcom bitmap size mismatch");
104 #define VCL_ACCEPTED_F_CLOSED (1 << 0)
105 #define VCL_ACCEPTED_F_RESET (1 << 1)
107 typedef struct vcl_session_msg
112 session_accepted_msg_t accepted_msg;
119 VCL_SESS_ATTR_SERVER,
120 VCL_SESS_ATTR_CUT_THRU,
122 VCL_SESS_ATTR_VEP_SESSION,
123 VCL_SESS_ATTR_LISTEN, // SOL_SOCKET,SO_ACCEPTCONN
124 VCL_SESS_ATTR_NONBLOCK, // fcntl,O_NONBLOCK
125 VCL_SESS_ATTR_REUSEADDR, // SOL_SOCKET,SO_REUSEADDR
126 VCL_SESS_ATTR_REUSEPORT, // SOL_SOCKET,SO_REUSEPORT
127 VCL_SESS_ATTR_BROADCAST, // SOL_SOCKET,SO_BROADCAST
128 VCL_SESS_ATTR_V6ONLY, // SOL_TCP,IPV6_V6ONLY
129 VCL_SESS_ATTR_KEEPALIVE, // SOL_SOCKET,SO_KEEPALIVE
130 VCL_SESS_ATTR_TCP_NODELAY, // SOL_TCP,TCP_NODELAY
131 VCL_SESS_ATTR_TCP_KEEPIDLE, // SOL_TCP,TCP_KEEPIDLE
132 VCL_SESS_ATTR_TCP_KEEPINTVL, // SOL_TCP,TCP_KEEPINTVL
133 VCL_SESS_ATTR_SHUT_RD,
134 VCL_SESS_ATTR_SHUT_WR,
136 } vppcom_session_attr_t;
138 #define VCL_SESS_ATTR_SET(ATTR, VAL) \
140 (ATTR) |= 1 << (VAL); \
143 #define VCL_SESS_ATTR_CLR(ATTR, VAL) \
145 (ATTR) &= ~(1 << (VAL)); \
148 #define VCL_SESS_ATTR_TEST(ATTR, VAL) \
149 ((ATTR) & (1 << (VAL)) ? 1 : 0)
151 typedef struct vcl_shared_session_
156 } vcl_shared_session_t;
160 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
161 #define _(type, name) type name;
162 foreach_app_session_field
164 u32 sndbuf_size; // VPP-TBD: Hack until support setsockopt(SO_SNDBUF)
165 u32 rcvbuf_size; // VPP-TBD: Hack until support setsockopt(SO_RCVBUF)
166 u32 user_mss; // VPP-TBD: Hack until support setsockopt(TCP_MAXSEG)
171 u32 vpp_thread_index;
173 /* Socket configuration state */
181 svm_msg_q_t *our_evt_q;
183 vcl_session_msg_t *accept_evts_fifo;
186 elog_track_t elog_track;
190 typedef struct vppcom_cfg_t_
194 u32 vpp_api_q_length;
195 uword segment_baseva;
197 u32 add_segment_size;
198 u32 preallocated_fifo_pairs;
201 u32 event_queue_size;
202 u32 listen_queue_size;
203 u8 app_proxy_transport_tcp;
204 u8 app_proxy_transport_udp;
208 u64 namespace_secret;
214 char *event_log_path;
215 u8 *vpp_api_filename;
216 u8 *vpp_api_socket_name;
219 void vppcom_cfg (vppcom_cfg_t * vcl_cfg);
221 typedef struct vcl_cut_through_registration_
224 svm_msg_q_t *peer_mq;
226 u32 epoll_evt_conn_index; /*< mq evt connection index part of
227 the mqs evtfd epoll (if used) */
228 } vcl_cut_through_registration_t;
230 typedef struct vcl_mq_evt_conn_
236 typedef struct vcl_worker_
238 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
241 vcl_session_t *sessions;
243 /** Worker/thread index in current process */
246 /** Worker index in vpp*/
249 /** API client handle */
252 /** State of the connection, shared between msg RX thread and main thread */
253 volatile app_state_t wrk_state;
255 /** VPP binary api input queue */
256 svm_queue_t *vl_input_queue;
258 /** Message queues epoll fd. Initialized only if using mqs with eventfds */
261 /** Pool of event message queue event connections */
262 vcl_mq_evt_conn_t *mq_evt_conns;
264 /** Per worker buffer for receiving mq epoll events */
265 struct epoll_event *mq_events;
267 /** Hash table for disconnect processing */
268 uword *session_index_by_vpp_handles;
270 /** Select bitmaps */
271 clib_bitmap_t *rd_bitmap;
272 clib_bitmap_t *wr_bitmap;
273 clib_bitmap_t *ex_bitmap;
275 /** Our event message queue */
276 svm_msg_q_t *app_event_queue;
278 /** VPP workers event message queues */
279 svm_msg_q_t **vpp_event_queues;
281 /** For deadman timers */
282 clib_time_t clib_time;
284 /** Pool of cut through registrations */
285 vcl_cut_through_registration_t *cut_through_registrations;
287 /** Lock for accessing ct registration pool */
288 clib_spinlock_t ct_registration_lock;
290 /** Cut-through registration by mq address hash table */
291 uword *ct_registration_by_mq;
293 /** Vector acting as buffer for mq messages */
294 svm_msg_q_msg_t *mq_msg_vector;
296 /** Vector of unhandled events */
297 session_event_t *unhandled_evts_vector;
299 u32 *pending_session_wrk_updates;
301 /** Used also as a thread stop key buffer */
304 /** Current pid, may be different from main_pid if forked child */
311 typedef struct vppcom_main_t_
317 /** Main process pid */
320 /** App's index in vpp. It's used by vpp to identify the app */
323 /** State of the connection, shared between msg RX thread and main thread */
324 volatile app_state_t app_state;
328 /** VCL configuration */
331 volatile u32 forking;
334 vcl_worker_t *workers;
336 /** Lock to protect worker registrations */
337 clib_spinlock_t workers_lock;
339 /** Pool of shared sessions */
340 vcl_shared_session_t *shared_sessions;
342 /** Lock to protect segment hash table */
343 clib_rwlock_t segment_table_lock;
345 /** Mapped segments table */
346 uword *segment_table;
348 svm_fifo_segment_main_t segment_main;
351 /* VPP Event-logger */
352 elog_main_t elog_main;
353 elog_track_t elog_track;
356 /* VNET_API_ERROR_FOO -> "Foo" hash table */
357 uword *error_string_by_error_number;
361 extern vppcom_main_t *vcm;
363 #define VCL_INVALID_SESSION_INDEX ((u32)~0)
364 #define VCL_INVALID_SEGMENT_INDEX ((u32)~0)
365 #define VCL_INVALID_SEGMENT_HANDLE ((u64)~0)
367 static inline vcl_session_t *
368 vcl_session_alloc (vcl_worker_t * wrk)
371 pool_get (wrk->sessions, s);
372 memset (s, 0, sizeof (*s));
373 s->session_index = s - wrk->sessions;
374 s->shared_index = ~0;
379 vcl_session_free (vcl_worker_t * wrk, vcl_session_t * s)
381 pool_put (wrk->sessions, s);
384 static inline vcl_session_t *
385 vcl_session_get (vcl_worker_t * wrk, u32 session_index)
387 if (pool_is_free_index (wrk->sessions, session_index))
389 return pool_elt_at_index (wrk->sessions, session_index);
393 vcl_session_handle (vcl_session_t * s)
395 ASSERT (s->session_index < 2 << 24);
396 return (vcl_get_worker_index () << 24 | s->session_index);
400 vcl_session_handle_parse (u32 handle, u32 * wrk_index, u32 * session_index)
402 *wrk_index = handle >> 24;
403 *session_index = handle & 0xFFFFFF;
406 static inline vcl_session_t *
407 vcl_session_get_w_handle (vcl_worker_t * wrk, u32 session_handle)
409 u32 session_index, wrk_index;
410 vcl_session_handle_parse (session_handle, &wrk_index, &session_index);
411 ASSERT (wrk_index == wrk->wrk_index);
412 return vcl_session_get (wrk, session_index);
415 static inline vcl_session_t *
416 vcl_session_get_w_vpp_handle (vcl_worker_t * wrk, u64 vpp_handle)
419 if ((p = hash_get (wrk->session_index_by_vpp_handles, vpp_handle)))
420 return vcl_session_get (wrk, (u32) p[0]);
425 vcl_session_index_from_vpp_handle (vcl_worker_t * wrk, u64 vpp_handle)
428 if ((p = hash_get (wrk->session_index_by_vpp_handles, vpp_handle)))
430 return VCL_INVALID_SESSION_INDEX;
434 vcl_session_table_add_vpp_handle (vcl_worker_t * wrk, u64 handle, u32 value)
436 hash_set (wrk->session_index_by_vpp_handles, handle, value);
440 vcl_session_table_del_vpp_handle (vcl_worker_t * wrk, u64 vpp_handle)
442 hash_unset (wrk->session_index_by_vpp_handles, vpp_handle);
445 static inline uword *
446 vcl_session_table_lookup_vpp_handle (vcl_worker_t * wrk, u64 handle)
448 return hash_get (wrk->session_index_by_vpp_handles, handle);
452 vcl_session_table_add_listener (vcl_worker_t * wrk, u64 listener_handle,
455 /* Session and listener handles have different formats. The latter has
456 * the thread index in the upper 32 bits while the former has the session
457 * type. Knowing that, for listeners we just flip the MSB to 1 */
458 listener_handle |= 1ULL << 63;
459 hash_set (wrk->session_index_by_vpp_handles, listener_handle, value);
463 vcl_session_table_del_listener (vcl_worker_t * wrk, u64 listener_handle)
465 listener_handle |= 1ULL << 63;
466 hash_unset (wrk->session_index_by_vpp_handles, listener_handle);
469 static inline vcl_session_t *
470 vcl_session_table_lookup_listener (vcl_worker_t * wrk, u64 listener_handle)
473 u64 handle = listener_handle | (1ULL << 63);
474 vcl_session_t *session;
476 p = hash_get (wrk->session_index_by_vpp_handles, handle);
479 clib_warning ("VCL<%d>: couldn't find listen session: unknown vpp "
480 "listener handle %llx", getpid (), listener_handle);
483 if (pool_is_free_index (wrk->sessions, p[0]))
485 VDBG (1, "VCL<%d>: invalid listen session, sid (%u)", getpid (), p[0]);
489 session = pool_elt_at_index (wrk->sessions, p[0]);
490 ASSERT (session->session_state & STATE_LISTEN);
494 const char *vppcom_session_state_str (session_state_t state);
497 vcl_session_is_ct (vcl_session_t * s)
499 return (s->our_evt_q != 0);
505 int vcl_wait_for_app_state_change (app_state_t app_state);
506 vcl_cut_through_registration_t
507 * vcl_ct_registration_lock_and_alloc (vcl_worker_t * wrk);
508 void vcl_ct_registration_del (vcl_worker_t * wrk,
509 vcl_cut_through_registration_t * ctr);
510 u32 vcl_ct_registration_index (vcl_worker_t * wrk,
511 vcl_cut_through_registration_t * ctr);
512 void vcl_ct_registration_lock (vcl_worker_t * wrk);
513 void vcl_ct_registration_unlock (vcl_worker_t * wrk);
514 vcl_cut_through_registration_t
515 * vcl_ct_registration_lock_and_lookup (vcl_worker_t * wrk, uword mq_addr);
516 void vcl_ct_registration_lookup_add (vcl_worker_t * wrk, uword mq_addr,
518 void vcl_ct_registration_lookup_del (vcl_worker_t * wrk, uword mq_addr);
519 vcl_mq_evt_conn_t *vcl_mq_evt_conn_alloc (vcl_worker_t * wrk);
520 u32 vcl_mq_evt_conn_index (vcl_worker_t * wrk, vcl_mq_evt_conn_t * mqc);
521 vcl_mq_evt_conn_t *vcl_mq_evt_conn_get (vcl_worker_t * wrk, u32 mq_conn_idx);
522 int vcl_mq_epoll_add_evfd (vcl_worker_t * wrk, svm_msg_q_t * mq);
523 int vcl_mq_epoll_del_evfd (vcl_worker_t * wrk, u32 mqc_index);
525 vcl_worker_t *vcl_worker_alloc_and_init (void);
526 void vcl_worker_cleanup (vcl_worker_t * wrk, u8 notify_vpp);
527 int vcl_worker_register_with_vpp (void);
528 int vcl_worker_set_bapi (void);
529 void vcl_worker_share_sessions (vcl_worker_t * parent_wrk);
530 int vcl_worker_unshare_session (vcl_worker_t * wrk, vcl_session_t * s);
531 vcl_shared_session_t *vcl_shared_session_get (u32 ss_index);
532 int vcl_session_get_refcnt (vcl_session_t * s);
534 void vcl_segment_table_add (u64 segment_handle, u32 svm_segment_index);
535 u32 vcl_segment_table_lookup (u64 segment_handle);
536 void vcl_segment_table_del (u64 segment_handle);
538 static inline vcl_worker_t *
539 vcl_worker_get (u32 wrk_index)
541 return pool_elt_at_index (vcm->workers, wrk_index);
544 static inline vcl_worker_t *
545 vcl_worker_get_if_valid (u32 wrk_index)
547 if (pool_is_free_index (vcm->workers, wrk_index))
549 return pool_elt_at_index (vcm->workers, wrk_index);
552 static inline vcl_worker_t *
553 vcl_worker_get_current (void)
555 return vcl_worker_get (vcl_get_worker_index ());
558 static inline svm_msg_q_t *
559 vcl_session_vpp_evt_q (vcl_worker_t * wrk, vcl_session_t * s)
561 if (vcl_session_is_ct (s))
562 return wrk->vpp_event_queues[0];
564 return wrk->vpp_event_queues[s->vpp_thread_index];
567 void vcl_send_session_worker_update (vcl_worker_t * wrk, vcl_session_t * s,
572 int vppcom_connect_to_vpp (char *app_name);
573 void vppcom_init_error_string_table (void);
574 void vppcom_send_session_enable_disable (u8 is_enable);
575 void vppcom_app_send_attach (void);
576 void vppcom_app_send_detach (void);
577 void vppcom_send_connect_sock (vcl_session_t * session);
578 void vppcom_send_disconnect_session (u64 vpp_handle);
579 void vppcom_send_bind_sock (vcl_session_t * session);
580 void vppcom_send_unbind_sock (u64 vpp_handle);
581 void vppcom_api_hookup (void);
582 void vppcom_send_application_tls_cert_add (vcl_session_t * session,
583 char *cert, u32 cert_len);
584 void vppcom_send_application_tls_key_add (vcl_session_t * session, char *key,
586 void vcl_send_app_worker_add_del (u8 is_add);
587 void vcl_send_child_worker_del (vcl_worker_t * wrk);
589 u32 vcl_max_nsid_len (void);
591 u8 *format_api_error (u8 * s, va_list * args);
594 #endif /* SRC_VCL_VCL_PRIVATE_H_ */
597 * fd.io coding-style-patch-verification: ON
600 * eval: (c-set-style "gnu")