2 * Copyright (c) 2018-2019 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,
60 STATE_APP_ADDING_TLS_DATA,
71 STATE_VPP_CLOSING = 0x08,
72 STATE_DISCONNECT = 0x10,
75 STATE_LISTEN_NO_MQ = 0x80,
76 } vcl_session_state_t;
78 #define SERVER_STATE_OPEN (STATE_ACCEPT|STATE_VPP_CLOSING)
79 #define CLIENT_STATE_OPEN (STATE_CONNECT|STATE_VPP_CLOSING)
80 #define STATE_OPEN (SERVER_STATE_OPEN | CLIENT_STATE_OPEN)
82 typedef struct epoll_event vppcom_epoll_event_t;
89 vppcom_epoll_event_t ev;
90 #define VEP_DEFAULT_ET_MASK (EPOLLIN|EPOLLOUT)
91 #define VEP_UNSUPPORTED_EVENTS (EPOLLONESHOT|EPOLLEXCLUSIVE)
95 /* Select uses the vcl_si_set as if a clib_bitmap. Make sure they are the
97 STATIC_ASSERT (sizeof (clib_bitmap_t) == sizeof (vcl_si_set),
98 "vppcom bitmap size mismatch");
106 #define VCL_ACCEPTED_F_CLOSED (1 << 0)
107 #define VCL_ACCEPTED_F_RESET (1 << 1)
109 typedef struct vcl_session_msg
114 session_accepted_msg_t accepted_msg;
121 VCL_SESS_ATTR_SERVER,
122 VCL_SESS_ATTR_CUT_THRU,
124 VCL_SESS_ATTR_VEP_SESSION,
125 VCL_SESS_ATTR_LISTEN, // SOL_SOCKET,SO_ACCEPTCONN
126 VCL_SESS_ATTR_NONBLOCK, // fcntl,O_NONBLOCK
127 VCL_SESS_ATTR_REUSEADDR, // SOL_SOCKET,SO_REUSEADDR
128 VCL_SESS_ATTR_REUSEPORT, // SOL_SOCKET,SO_REUSEPORT
129 VCL_SESS_ATTR_BROADCAST, // SOL_SOCKET,SO_BROADCAST
130 VCL_SESS_ATTR_V6ONLY, // SOL_TCP,IPV6_V6ONLY
131 VCL_SESS_ATTR_KEEPALIVE, // SOL_SOCKET,SO_KEEPALIVE
132 VCL_SESS_ATTR_TCP_NODELAY, // SOL_TCP,TCP_NODELAY
133 VCL_SESS_ATTR_TCP_KEEPIDLE, // SOL_TCP,TCP_KEEPIDLE
134 VCL_SESS_ATTR_TCP_KEEPINTVL, // SOL_TCP,TCP_KEEPINTVL
135 VCL_SESS_ATTR_SHUT_RD,
136 VCL_SESS_ATTR_SHUT_WR,
138 } vppcom_session_attr_t;
140 #define VCL_SESS_ATTR_SET(ATTR, VAL) \
142 (ATTR) |= 1 << (VAL); \
145 #define VCL_SESS_ATTR_CLR(ATTR, VAL) \
147 (ATTR) &= ~(1 << (VAL)); \
150 #define VCL_SESS_ATTR_TEST(ATTR, VAL) \
151 ((ATTR) & (1 << (VAL)) ? 1 : 0)
155 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
156 #define _(type, name) type name;
157 foreach_app_session_field
159 u32 sndbuf_size; // VPP-TBD: Hack until support setsockopt(SO_SNDBUF)
160 u32 rcvbuf_size; // VPP-TBD: Hack until support setsockopt(SO_RCVBUF)
161 u32 user_mss; // VPP-TBD: Hack until support setsockopt(TCP_MAXSEG)
163 u32 vpp_thread_index;
165 svm_fifo_t *ct_rx_fifo;
166 svm_fifo_t *ct_tx_fifo;
168 /* Socket configuration state */
171 /* VCL session index of the listening session (if any) */
173 /* Accepted sessions on this listener */
174 int n_accepted_sessions;
180 svm_msg_q_t *our_evt_q;
181 vcl_session_msg_t *accept_evts_fifo;
183 elog_track_t elog_track;
187 typedef struct vppcom_cfg_t_
191 u32 vpp_api_q_length;
192 uword segment_baseva;
194 u32 add_segment_size;
195 u32 preallocated_fifo_pairs;
198 u32 event_queue_size;
199 u32 listen_queue_size;
200 u8 app_proxy_transport_tcp;
201 u8 app_proxy_transport_udp;
205 u64 namespace_secret;
211 char *event_log_path;
212 u8 *vpp_api_filename;
213 u8 *vpp_api_socket_name;
216 void vppcom_cfg (vppcom_cfg_t * vcl_cfg);
218 typedef struct vcl_cut_through_registration_
221 svm_msg_q_t *peer_mq;
223 u32 epoll_evt_conn_index; /*< mq evt connection index part of
224 the mqs evtfd epoll (if used) */
225 } vcl_cut_through_registration_t;
227 typedef struct vcl_mq_evt_conn_
233 typedef struct vcl_worker_
235 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
238 vcl_session_t *sessions;
240 /** Worker/thread index in current process */
243 /** Worker index in vpp*/
246 /** API client handle */
249 /** State of the connection, shared between msg RX thread and main thread */
250 volatile app_state_t wrk_state;
252 /** VPP binary api input queue */
253 svm_queue_t *vl_input_queue;
255 /** VPP mq to be used for exchanging control messages */
256 svm_msg_q_t *ctrl_mq;
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 /** Vector acting as buffer for mq messages */
285 svm_msg_q_msg_t *mq_msg_vector;
287 /** Vector of unhandled events */
288 session_event_t *unhandled_evts_vector;
290 u32 *pending_session_wrk_updates;
292 /** Used also as a thread stop key buffer */
295 /** Current pid, may be different from main_pid if forked child */
302 typedef struct vppcom_main_t_
308 /** Main process pid */
311 /** App's index in vpp. It's used by vpp to identify the app */
314 /** State of the connection, shared between msg RX thread and main thread */
315 volatile app_state_t app_state;
319 /** VCL configuration */
322 volatile u32 forking;
325 vcl_worker_t *workers;
327 /** Lock to protect worker registrations */
328 clib_spinlock_t workers_lock;
330 /** Lock to protect segment hash table */
331 clib_rwlock_t segment_table_lock;
333 /** Mapped segments table */
334 uword *segment_table;
336 /** Control mq obtained from attach */
337 svm_msg_q_t *ctrl_mq;
339 fifo_segment_main_t segment_main;
342 /* VPP Event-logger */
343 elog_main_t elog_main;
344 elog_track_t elog_track;
347 /* VNET_API_ERROR_FOO -> "Foo" hash table */
348 uword *error_string_by_error_number;
352 extern vppcom_main_t *vcm;
354 #define VCL_INVALID_SESSION_INDEX ((u32)~0)
355 #define VCL_INVALID_SESSION_HANDLE ((u64)~0)
356 #define VCL_INVALID_SEGMENT_INDEX ((u32)~0)
357 #define VCL_INVALID_SEGMENT_HANDLE ((u64)~0)
359 static inline vcl_session_t *
360 vcl_session_alloc (vcl_worker_t * wrk)
363 pool_get (wrk->sessions, s);
364 memset (s, 0, sizeof (*s));
365 s->session_index = s - wrk->sessions;
366 s->listener_index = VCL_INVALID_SESSION_INDEX;
371 vcl_session_free (vcl_worker_t * wrk, vcl_session_t * s)
373 pool_put (wrk->sessions, s);
376 static inline vcl_session_t *
377 vcl_session_get (vcl_worker_t * wrk, u32 session_index)
379 if (pool_is_free_index (wrk->sessions, session_index))
381 return pool_elt_at_index (wrk->sessions, session_index);
384 static inline vcl_session_handle_t
385 vcl_session_handle_from_index (u32 session_index)
387 ASSERT (session_index < 2 << 24);
388 return (vcl_get_worker_index () << 24 | session_index);
391 static inline vcl_session_handle_t
392 vcl_session_handle (vcl_session_t * s)
394 return vcl_session_handle_from_index (s->session_index);
398 vcl_session_handle_parse (u32 handle, u32 * wrk_index, u32 * session_index)
400 *wrk_index = handle >> 24;
401 *session_index = handle & 0xFFFFFF;
404 static inline vcl_session_t *
405 vcl_session_get_w_handle (vcl_worker_t * wrk, u32 session_handle)
407 u32 session_index, wrk_index;
408 vcl_session_handle_parse (session_handle, &wrk_index, &session_index);
409 ASSERT (wrk_index == wrk->wrk_index);
410 return vcl_session_get (wrk, session_index);
413 static inline vcl_session_t *
414 vcl_session_get_w_vpp_handle (vcl_worker_t * wrk, u64 vpp_handle)
417 if ((p = hash_get (wrk->session_index_by_vpp_handles, vpp_handle)))
418 return vcl_session_get (wrk, (u32) p[0]);
423 vcl_session_index_from_vpp_handle (vcl_worker_t * wrk, u64 vpp_handle)
426 if ((p = hash_get (wrk->session_index_by_vpp_handles, vpp_handle)))
428 return VCL_INVALID_SESSION_INDEX;
432 vcl_session_table_add_vpp_handle (vcl_worker_t * wrk, u64 handle, u32 value)
434 hash_set (wrk->session_index_by_vpp_handles, handle, value);
438 vcl_session_table_del_vpp_handle (vcl_worker_t * wrk, u64 vpp_handle)
440 hash_unset (wrk->session_index_by_vpp_handles, vpp_handle);
443 static inline uword *
444 vcl_session_table_lookup_vpp_handle (vcl_worker_t * wrk, u64 handle)
446 return hash_get (wrk->session_index_by_vpp_handles, handle);
450 vcl_session_table_add_listener (vcl_worker_t * wrk, u64 listener_handle,
453 hash_set (wrk->session_index_by_vpp_handles, listener_handle, value);
457 vcl_session_table_del_listener (vcl_worker_t * wrk, u64 listener_handle)
459 hash_unset (wrk->session_index_by_vpp_handles, listener_handle);
463 vcl_session_is_connectable_listener (vcl_worker_t * wrk,
464 vcl_session_t * session)
466 /* Tell if we session_handle is a QUIC session.
467 * We can be in the following cases :
468 * Listen session <- QUIC session <- Stream session
469 * QUIC session <- Stream session
472 if (session->session_type != VPPCOM_PROTO_QUIC)
474 if (session->listener_index == VCL_INVALID_SESSION_INDEX)
475 return !(session->session_state & STATE_LISTEN);
476 ls = vcl_session_get_w_handle (wrk, session->listener_index);
478 return VPPCOM_EBADFD;
479 return ls->session_state & STATE_LISTEN;
482 static inline vcl_session_t *
483 vcl_session_table_lookup_listener (vcl_worker_t * wrk, u64 handle)
486 vcl_session_t *session;
488 p = hash_get (wrk->session_index_by_vpp_handles, handle);
491 VDBG (0, "could not find listen session: unknown vpp listener handle"
495 session = vcl_session_get (wrk, p[0]);
498 VDBG (1, "invalid listen session index (%u)", p[0]);
502 ASSERT ((session->session_state & (STATE_LISTEN | STATE_LISTEN_NO_MQ)) ||
503 vcl_session_is_connectable_listener (wrk, session));
507 const char *vppcom_session_state_str (vcl_session_state_t state);
510 vcl_session_is_ct (vcl_session_t * s)
512 return (s->ct_tx_fifo != 0);
516 vcl_session_is_open (vcl_session_t * s)
518 return ((s->session_state & STATE_OPEN)
519 || (s->session_state == STATE_LISTEN
520 && s->session_type == VPPCOM_PROTO_UDP));
524 vcl_session_is_closing (vcl_session_t * s)
526 return (s->session_state == STATE_VPP_CLOSING
527 || s->session_state == STATE_DISCONNECT);
531 vcl_session_closing_error (vcl_session_t * s)
533 return s->session_state == STATE_DISCONNECT ? VPPCOM_ECONNRESET : 0;
537 vcl_session_closed_error (vcl_session_t * s)
539 return s->session_state == STATE_DISCONNECT
540 ? VPPCOM_ECONNRESET : VPPCOM_ENOTCONN;
546 int vcl_wait_for_app_state_change (app_state_t app_state);
547 vcl_mq_evt_conn_t *vcl_mq_evt_conn_alloc (vcl_worker_t * wrk);
548 u32 vcl_mq_evt_conn_index (vcl_worker_t * wrk, vcl_mq_evt_conn_t * mqc);
549 vcl_mq_evt_conn_t *vcl_mq_evt_conn_get (vcl_worker_t * wrk, u32 mq_conn_idx);
550 int vcl_mq_epoll_add_evfd (vcl_worker_t * wrk, svm_msg_q_t * mq);
551 int vcl_mq_epoll_del_evfd (vcl_worker_t * wrk, u32 mqc_index);
553 vcl_worker_t *vcl_worker_alloc_and_init (void);
554 void vcl_worker_cleanup (vcl_worker_t * wrk, u8 notify_vpp);
555 int vcl_worker_register_with_vpp (void);
556 int vcl_worker_set_bapi (void);
557 svm_msg_q_t *vcl_worker_ctrl_mq (vcl_worker_t * wrk);
559 void vcl_flush_mq_events (void);
560 void vcl_cleanup_bapi (void);
561 int vcl_session_cleanup (vcl_worker_t * wrk, vcl_session_t * session,
562 vcl_session_handle_t sh, u8 do_disconnect);
564 void vcl_segment_table_add (u64 segment_handle, u32 svm_segment_index);
565 u32 vcl_segment_table_lookup (u64 segment_handle);
566 void vcl_segment_table_del (u64 segment_handle);
568 int vcl_session_read_ready (vcl_session_t * session);
569 int vcl_session_write_ready (vcl_session_t * session);
571 static inline vcl_worker_t *
572 vcl_worker_get (u32 wrk_index)
574 return pool_elt_at_index (vcm->workers, wrk_index);
577 static inline vcl_worker_t *
578 vcl_worker_get_if_valid (u32 wrk_index)
580 if (pool_is_free_index (vcm->workers, wrk_index))
582 return pool_elt_at_index (vcm->workers, wrk_index);
585 static inline vcl_worker_t *
586 vcl_worker_get_current (void)
588 return vcl_worker_get (vcl_get_worker_index ());
594 return pool_elts (vcm->workers);
597 static inline svm_msg_q_t *
598 vcl_session_vpp_evt_q (vcl_worker_t * wrk, vcl_session_t * s)
600 return wrk->vpp_event_queues[s->vpp_thread_index];
603 void vcl_send_session_worker_update (vcl_worker_t * wrk, vcl_session_t * s,
608 int vppcom_connect_to_vpp (char *app_name);
609 void vppcom_disconnect_from_vpp (void);
610 void vppcom_init_error_string_table (void);
611 void vppcom_send_session_enable_disable (u8 is_enable);
612 void vppcom_app_send_attach (void);
613 void vppcom_app_send_detach (void);
614 void vcl_send_session_unlisten (vcl_worker_t * wrk, vcl_session_t * s);
615 void vppcom_send_disconnect_session (u64 vpp_handle);
616 void vppcom_api_hookup (void);
617 void vppcom_send_application_tls_cert_add (vcl_session_t * session,
618 char *cert, u32 cert_len);
619 void vppcom_send_application_tls_key_add (vcl_session_t * session, char *key,
621 void vcl_send_app_worker_add_del (u8 is_add);
622 void vcl_send_child_worker_del (vcl_worker_t * wrk);
624 u32 vcl_max_nsid_len (void);
626 u8 *format_api_error (u8 * s, va_list * args);
629 #endif /* SRC_VCL_VCL_PRIVATE_H_ */
632 * fd.io coding-style-patch-verification: ON
635 * eval: (c-set-style "gnu")