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)
99 #define VCL_ACCEPTED_F_CLOSED (1 << 0)
100 #define VCL_ACCEPTED_F_RESET (1 << 1)
102 typedef struct vcl_session_msg
107 session_accepted_msg_t accepted_msg;
114 VCL_SESS_ATTR_SERVER,
115 VCL_SESS_ATTR_CUT_THRU,
117 VCL_SESS_ATTR_VEP_SESSION,
118 VCL_SESS_ATTR_LISTEN, // SOL_SOCKET,SO_ACCEPTCONN
119 VCL_SESS_ATTR_NONBLOCK, // fcntl,O_NONBLOCK
120 VCL_SESS_ATTR_REUSEADDR, // SOL_SOCKET,SO_REUSEADDR
121 VCL_SESS_ATTR_REUSEPORT, // SOL_SOCKET,SO_REUSEPORT
122 VCL_SESS_ATTR_BROADCAST, // SOL_SOCKET,SO_BROADCAST
123 VCL_SESS_ATTR_V6ONLY, // SOL_TCP,IPV6_V6ONLY
124 VCL_SESS_ATTR_KEEPALIVE, // SOL_SOCKET,SO_KEEPALIVE
125 VCL_SESS_ATTR_TCP_NODELAY, // SOL_TCP,TCP_NODELAY
126 VCL_SESS_ATTR_TCP_KEEPIDLE, // SOL_TCP,TCP_KEEPIDLE
127 VCL_SESS_ATTR_TCP_KEEPINTVL, // SOL_TCP,TCP_KEEPINTVL
129 } vppcom_session_attr_t;
131 #define VCL_SESS_ATTR_SET(ATTR, VAL) \
133 (ATTR) |= 1 << (VAL); \
136 #define VCL_SESS_ATTR_CLR(ATTR, VAL) \
138 (ATTR) &= ~(1 << (VAL)); \
141 #define VCL_SESS_ATTR_TEST(ATTR, VAL) \
142 ((ATTR) & (1 << (VAL)) ? 1 : 0)
144 typedef struct vcl_shared_session_
149 } vcl_shared_session_t;
153 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
154 #define _(type, name) type name;
155 foreach_app_session_field
157 u32 sndbuf_size; // VPP-TBD: Hack until support setsockopt(SO_SNDBUF)
158 u32 rcvbuf_size; // VPP-TBD: Hack until support setsockopt(SO_RCVBUF)
159 u32 user_mss; // VPP-TBD: Hack until support setsockopt(TCP_MAXSEG)
164 u32 vpp_thread_index;
166 /* Socket configuration state */
174 svm_msg_q_t *our_evt_q;
176 vcl_session_msg_t *accept_evts_fifo;
179 elog_track_t elog_track;
183 typedef struct vppcom_cfg_t_
187 u32 vpp_api_q_length;
188 uword segment_baseva;
190 u32 add_segment_size;
191 u32 preallocated_fifo_pairs;
194 u32 event_queue_size;
195 u32 listen_queue_size;
196 u8 app_proxy_transport_tcp;
197 u8 app_proxy_transport_udp;
201 u64 namespace_secret;
207 char *event_log_path;
208 u8 *vpp_api_filename;
209 u8 *vpp_api_socket_name;
212 void vppcom_cfg (vppcom_cfg_t * vcl_cfg);
214 typedef struct vcl_cut_through_registration_
217 svm_msg_q_t *peer_mq;
219 u32 epoll_evt_conn_index; /*< mq evt connection index part of
220 the mqs evtfd epoll (if used) */
221 } vcl_cut_through_registration_t;
223 typedef struct vcl_mq_evt_conn_
229 typedef struct vcl_worker_
231 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
234 vcl_session_t *sessions;
236 /** Worker/thread index in current process */
239 /** Worker index in vpp*/
242 /** API client handle */
245 /** State of the connection, shared between msg RX thread and main thread */
246 volatile app_state_t wrk_state;
248 /** VPP binary api input queue */
249 svm_queue_t *vl_input_queue;
251 /** Message queues epoll fd. Initialized only if using mqs with eventfds */
254 /** Pool of event message queue event connections */
255 vcl_mq_evt_conn_t *mq_evt_conns;
257 /** Per worker buffer for receiving mq epoll events */
258 struct epoll_event *mq_events;
260 /** Hash table for disconnect processing */
261 uword *session_index_by_vpp_handles;
263 /** Select bitmaps */
264 clib_bitmap_t *rd_bitmap;
265 clib_bitmap_t *wr_bitmap;
266 clib_bitmap_t *ex_bitmap;
268 /** Our event message queue */
269 svm_msg_q_t *app_event_queue;
271 /** VPP workers event message queues */
272 svm_msg_q_t **vpp_event_queues;
274 /** For deadman timers */
275 clib_time_t clib_time;
277 /** Pool of cut through registrations */
278 vcl_cut_through_registration_t *cut_through_registrations;
280 /** Lock for accessing ct registration pool */
281 clib_spinlock_t ct_registration_lock;
283 /** Cut-through registration by mq address hash table */
284 uword *ct_registration_by_mq;
286 /** Vector acting as buffer for mq messages */
287 svm_msg_q_msg_t *mq_msg_vector;
289 /** Vector of unhandled events */
290 session_event_t *unhandled_evts_vector;
292 u32 *pending_session_wrk_updates;
294 /** Used also as a thread stop key buffer */
297 /** Current pid, may be different from main_pid if forked child */
304 typedef struct vppcom_main_t_
310 /** Main process pid */
313 /** App's index in vpp. It's used by vpp to identify the app */
316 /** State of the connection, shared between msg RX thread and main thread */
317 volatile app_state_t app_state;
321 /** VCL configuration */
324 volatile u32 forking;
327 vcl_worker_t *workers;
329 /** Lock to protect worker registrations */
330 clib_spinlock_t workers_lock;
332 /** Pool of shared sessions */
333 vcl_shared_session_t *shared_sessions;
335 /** Lock to protect segment hash table */
336 clib_rwlock_t segment_table_lock;
338 /** Mapped segments table */
339 uword *segment_table;
341 svm_fifo_segment_main_t segment_main;
344 /* VPP Event-logger */
345 elog_main_t elog_main;
346 elog_track_t elog_track;
349 /* VNET_API_ERROR_FOO -> "Foo" hash table */
350 uword *error_string_by_error_number;
354 extern vppcom_main_t *vcm;
356 #define VCL_INVALID_SESSION_INDEX ((u32)~0)
357 #define VCL_INVALID_SEGMENT_INDEX ((u32)~0)
358 #define VCL_INVALID_SEGMENT_HANDLE ((u64)~0)
360 static inline vcl_session_t *
361 vcl_session_alloc (vcl_worker_t * wrk)
364 pool_get (wrk->sessions, s);
365 memset (s, 0, sizeof (*s));
366 s->session_index = s - wrk->sessions;
367 s->shared_index = ~0;
372 vcl_session_free (vcl_worker_t * wrk, vcl_session_t * s)
374 pool_put (wrk->sessions, s);
377 static inline vcl_session_t *
378 vcl_session_get (vcl_worker_t * wrk, u32 session_index)
380 if (pool_is_free_index (wrk->sessions, session_index))
382 return pool_elt_at_index (wrk->sessions, session_index);
386 vcl_session_handle (vcl_session_t * s)
388 ASSERT (s->session_index < 2 << 24);
389 return (vcl_get_worker_index () << 24 | s->session_index);
393 vcl_session_handle_parse (u32 handle, u32 * wrk_index, u32 * session_index)
395 *wrk_index = handle >> 24;
396 *session_index = handle & 0xFFFFFF;
399 static inline vcl_session_t *
400 vcl_session_get_w_handle (vcl_worker_t * wrk, u32 session_handle)
402 u32 session_index, wrk_index;
403 vcl_session_handle_parse (session_handle, &wrk_index, &session_index);
404 ASSERT (wrk_index == wrk->wrk_index);
405 return vcl_session_get (wrk, session_index);
408 static inline vcl_session_t *
409 vcl_session_get_w_vpp_handle (vcl_worker_t * wrk, u64 vpp_handle)
412 if ((p = hash_get (wrk->session_index_by_vpp_handles, vpp_handle)))
413 return vcl_session_get (wrk, (u32) p[0]);
418 vcl_session_index_from_vpp_handle (vcl_worker_t * wrk, u64 vpp_handle)
421 if ((p = hash_get (wrk->session_index_by_vpp_handles, vpp_handle)))
423 return VCL_INVALID_SESSION_INDEX;
427 vcl_session_table_add_vpp_handle (vcl_worker_t * wrk, u64 handle, u32 value)
429 hash_set (wrk->session_index_by_vpp_handles, handle, value);
433 vcl_session_table_del_vpp_handle (vcl_worker_t * wrk, u64 vpp_handle)
435 hash_unset (wrk->session_index_by_vpp_handles, vpp_handle);
438 static inline uword *
439 vcl_session_table_lookup_vpp_handle (vcl_worker_t * wrk, u64 handle)
441 return hash_get (wrk->session_index_by_vpp_handles, handle);
445 vcl_session_table_add_listener (vcl_worker_t * wrk, u64 listener_handle,
448 /* Session and listener handles have different formats. The latter has
449 * the thread index in the upper 32 bits while the former has the session
450 * type. Knowing that, for listeners we just flip the MSB to 1 */
451 listener_handle |= 1ULL << 63;
452 hash_set (wrk->session_index_by_vpp_handles, listener_handle, value);
456 vcl_session_table_del_listener (vcl_worker_t * wrk, u64 listener_handle)
458 listener_handle |= 1ULL << 63;
459 hash_unset (wrk->session_index_by_vpp_handles, listener_handle);
462 static inline vcl_session_t *
463 vcl_session_table_lookup_listener (vcl_worker_t * wrk, u64 listener_handle)
466 u64 handle = listener_handle | (1ULL << 63);
467 vcl_session_t *session;
469 p = hash_get (wrk->session_index_by_vpp_handles, handle);
472 clib_warning ("VCL<%d>: couldn't find listen session: unknown vpp "
473 "listener handle %llx", getpid (), listener_handle);
476 if (pool_is_free_index (wrk->sessions, p[0]))
478 VDBG (1, "VCL<%d>: invalid listen session, sid (%u)", getpid (), p[0]);
482 session = pool_elt_at_index (wrk->sessions, p[0]);
483 ASSERT (session->session_state & STATE_LISTEN);
487 const char *vppcom_session_state_str (session_state_t state);
490 vcl_session_is_ct (vcl_session_t * s)
492 return (s->our_evt_q != 0);
498 int vcl_wait_for_app_state_change (app_state_t app_state);
499 vcl_cut_through_registration_t
500 * vcl_ct_registration_lock_and_alloc (vcl_worker_t * wrk);
501 void vcl_ct_registration_del (vcl_worker_t * wrk,
502 vcl_cut_through_registration_t * ctr);
503 u32 vcl_ct_registration_index (vcl_worker_t * wrk,
504 vcl_cut_through_registration_t * ctr);
505 void vcl_ct_registration_lock (vcl_worker_t * wrk);
506 void vcl_ct_registration_unlock (vcl_worker_t * wrk);
507 vcl_cut_through_registration_t
508 * vcl_ct_registration_lock_and_lookup (vcl_worker_t * wrk, uword mq_addr);
509 void vcl_ct_registration_lookup_add (vcl_worker_t * wrk, uword mq_addr,
511 void vcl_ct_registration_lookup_del (vcl_worker_t * wrk, uword mq_addr);
512 vcl_mq_evt_conn_t *vcl_mq_evt_conn_alloc (vcl_worker_t * wrk);
513 u32 vcl_mq_evt_conn_index (vcl_worker_t * wrk, vcl_mq_evt_conn_t * mqc);
514 vcl_mq_evt_conn_t *vcl_mq_evt_conn_get (vcl_worker_t * wrk, u32 mq_conn_idx);
515 int vcl_mq_epoll_add_evfd (vcl_worker_t * wrk, svm_msg_q_t * mq);
516 int vcl_mq_epoll_del_evfd (vcl_worker_t * wrk, u32 mqc_index);
518 vcl_worker_t *vcl_worker_alloc_and_init (void);
519 void vcl_worker_cleanup (vcl_worker_t * wrk, u8 notify_vpp);
520 int vcl_worker_register_with_vpp (void);
521 int vcl_worker_set_bapi (void);
522 void vcl_worker_share_sessions (vcl_worker_t * parent_wrk);
523 int vcl_worker_unshare_session (vcl_worker_t * wrk, vcl_session_t * s);
524 vcl_shared_session_t *vcl_shared_session_get (u32 ss_index);
525 int vcl_session_get_refcnt (vcl_session_t * s);
527 void vcl_segment_table_add (u64 segment_handle, u32 svm_segment_index);
528 u32 vcl_segment_table_lookup (u64 segment_handle);
529 void vcl_segment_table_del (u64 segment_handle);
531 static inline vcl_worker_t *
532 vcl_worker_get (u32 wrk_index)
534 return pool_elt_at_index (vcm->workers, wrk_index);
537 static inline vcl_worker_t *
538 vcl_worker_get_if_valid (u32 wrk_index)
540 if (pool_is_free_index (vcm->workers, wrk_index))
542 return pool_elt_at_index (vcm->workers, wrk_index);
545 static inline vcl_worker_t *
546 vcl_worker_get_current (void)
548 return vcl_worker_get (vcl_get_worker_index ());
551 static inline svm_msg_q_t *
552 vcl_session_vpp_evt_q (vcl_worker_t * wrk, vcl_session_t * s)
554 if (vcl_session_is_ct (s))
555 return wrk->vpp_event_queues[0];
557 return wrk->vpp_event_queues[s->vpp_thread_index];
560 void vcl_send_session_worker_update (vcl_worker_t * wrk, vcl_session_t * s,
565 int vppcom_connect_to_vpp (char *app_name);
566 void vppcom_init_error_string_table (void);
567 void vppcom_send_session_enable_disable (u8 is_enable);
568 void vppcom_app_send_attach (void);
569 void vppcom_app_send_detach (void);
570 void vppcom_send_connect_sock (vcl_session_t * session);
571 void vppcom_send_disconnect_session (u64 vpp_handle);
572 void vppcom_send_bind_sock (vcl_session_t * session);
573 void vppcom_send_unbind_sock (u64 vpp_handle);
574 void vppcom_api_hookup (void);
575 void vppcom_send_application_tls_cert_add (vcl_session_t * session,
576 char *cert, u32 cert_len);
577 void vppcom_send_application_tls_key_add (vcl_session_t * session, char *key,
579 void vcl_send_app_worker_add_del (u8 is_add);
580 void vcl_send_child_worker_del (vcl_worker_t * wrk);
582 u32 vcl_max_nsid_len (void);
584 u8 *format_api_error (u8 * s, va_list * args);
586 #endif /* SRC_VCL_VCL_PRIVATE_H_ */
589 * fd.io coding-style-patch-verification: ON
592 * eval: (c-set-style "gnu")