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,
63 } vcl_bapi_app_state_t;
65 typedef enum vcl_session_state_
70 VCL_STATE_VPP_CLOSING,
74 VCL_STATE_LISTEN_NO_MQ,
75 } vcl_session_state_t;
77 typedef struct epoll_event vppcom_epoll_event_t;
84 vppcom_epoll_event_t ev;
85 #define VEP_DEFAULT_ET_MASK (EPOLLIN|EPOLLOUT)
86 #define VEP_UNSUPPORTED_EVENTS (EPOLLONESHOT|EPOLLEXCLUSIVE)
90 /* Select uses the vcl_si_set as if a clib_bitmap. Make sure they are the
92 STATIC_ASSERT (sizeof (clib_bitmap_t) == sizeof (vcl_si_set),
93 "vppcom bitmap size mismatch");
101 #define VCL_ACCEPTED_F_CLOSED (1 << 0)
102 #define VCL_ACCEPTED_F_RESET (1 << 1)
104 typedef struct vcl_session_msg
108 session_accepted_msg_t accepted_msg;
115 VCL_SESS_ATTR_SERVER,
116 VCL_SESS_ATTR_CUT_THRU,
118 VCL_SESS_ATTR_VEP_SESSION,
119 VCL_SESS_ATTR_LISTEN, // SOL_SOCKET,SO_ACCEPTCONN
120 VCL_SESS_ATTR_NONBLOCK, // fcntl,O_NONBLOCK
121 VCL_SESS_ATTR_REUSEADDR, // SOL_SOCKET,SO_REUSEADDR
122 VCL_SESS_ATTR_REUSEPORT, // SOL_SOCKET,SO_REUSEPORT
123 VCL_SESS_ATTR_BROADCAST, // SOL_SOCKET,SO_BROADCAST
124 VCL_SESS_ATTR_V6ONLY, // SOL_TCP,IPV6_V6ONLY
125 VCL_SESS_ATTR_KEEPALIVE, // SOL_SOCKET,SO_KEEPALIVE
126 VCL_SESS_ATTR_TCP_NODELAY, // SOL_TCP,TCP_NODELAY
127 VCL_SESS_ATTR_TCP_KEEPIDLE, // SOL_TCP,TCP_KEEPIDLE
128 VCL_SESS_ATTR_TCP_KEEPINTVL, // SOL_TCP,TCP_KEEPINTVL
129 VCL_SESS_ATTR_SHUT_RD,
130 VCL_SESS_ATTR_SHUT_WR,
132 } vppcom_session_attr_t;
134 typedef enum vcl_session_flags_
136 VCL_SESSION_F_CONNECTED = 1 << 0,
137 VCL_SESSION_F_IS_VEP = 1 << 1,
138 VCL_SESSION_F_IS_VEP_SESSION = 1 << 2,
139 VCL_SESSION_F_HAS_RX_EVT = 1 << 3,
140 } __clib_packed vcl_session_flags_t;
142 typedef struct vcl_session_
144 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
146 #define _(type, name) type name;
147 foreach_app_session_field
149 vcl_session_flags_t flags; /**< see @ref vcl_session_flags_t */
150 u32 rx_bytes_pending; /**< bytes rx-ed as segs but not yet freed */
152 svm_fifo_t *ct_rx_fifo;
153 svm_fifo_t *ct_tx_fifo;
154 vcl_session_msg_t *accept_evts_fifo;
158 u32 listener_index; /**< index of parent listener (if any) */
159 int n_accepted_sessions; /**< sessions accepted by this listener */
161 u32 attributes; /**< see @ref vppcom_session_attr_t */
166 u32 sndbuf_size; // VPP-TBD: Hack until support setsockopt(SO_SNDBUF)
167 u32 rcvbuf_size; // VPP-TBD: Hack until support setsockopt(SO_RCVBUF)
168 u32 user_mss; // VPP-TBD: Hack until support setsockopt(TCP_MAXSEG)
171 elog_track_t elog_track;
175 typedef struct vppcom_cfg_t_
179 uword segment_baseva;
181 uword add_segment_size;
182 u32 preallocated_fifo_pairs;
185 u32 event_queue_size;
186 u32 listen_queue_size;
187 u8 app_proxy_transport_tcp;
188 u8 app_proxy_transport_udp;
192 u64 namespace_secret;
198 char *event_log_path;
199 u8 *vpp_app_socket_api; /**< app socket api socket file name */
200 u8 *vpp_bapi_socket_name; /**< bapi socket transport socket name */
205 void vppcom_cfg (vppcom_cfg_t * vcl_cfg);
207 typedef struct vcl_cut_through_registration_
210 svm_msg_q_t *peer_mq;
212 u32 epoll_evt_conn_index; /*< mq evt connection index part of
213 the mqs evtfd epoll (if used) */
214 } vcl_cut_through_registration_t;
216 typedef struct vcl_mq_evt_conn_
222 typedef struct vcl_worker_
224 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
227 vcl_session_t *sessions;
229 /** Worker/thread index in current process */
232 /** Worker index in vpp*/
236 * Generic api client handle. When binary api is in used, it stores
237 * the "client_index" and when socket api is use, it stores the sapi
239 u32 api_client_handle;
241 /** VPP binary api input queue */
242 svm_queue_t *vl_input_queue;
244 /** VPP mq to be used for exchanging control messages */
245 svm_msg_q_t *ctrl_mq;
247 /** Message queues epoll fd. Initialized only if using mqs with eventfds */
250 /** Pool of event message queue event connections */
251 vcl_mq_evt_conn_t *mq_evt_conns;
253 /** Per worker buffer for receiving mq epoll events */
254 struct epoll_event *mq_events;
256 /** Hash table for disconnect processing */
257 uword *session_index_by_vpp_handles;
259 /** Select bitmaps */
260 clib_bitmap_t *rd_bitmap;
261 clib_bitmap_t *wr_bitmap;
262 clib_bitmap_t *ex_bitmap;
264 /** Our event message queue */
265 svm_msg_q_t *app_event_queue;
267 /** For deadman timers */
268 clib_time_t clib_time;
270 /** Vector acting as buffer for mq messages */
271 svm_msg_q_msg_t *mq_msg_vector;
273 /** Vector of unhandled events */
274 session_event_t *unhandled_evts_vector;
276 u32 *pending_session_wrk_updates;
278 /** Used also as a thread stop key buffer */
281 /** Current pid, may be different from main_pid if forked child */
286 clib_socket_t app_api_sock;
287 socket_client_main_t bapi_sock_ctx;
288 api_main_t bapi_api_ctx;
290 /* State of the connection, shared between msg RX thread and main thread */
291 volatile vcl_bapi_app_state_t bapi_app_state;
292 volatile uword bapi_return;
294 /** vcl needs next epoll_create to go to libc_epoll */
295 u8 vcl_needs_real_epoll;
296 volatile int rpc_done;
299 STATIC_ASSERT (sizeof (session_disconnected_msg_t) <= 16,
300 "disconnected must fit in session_event_t");
301 STATIC_ASSERT (sizeof (session_reset_msg_t) <= 16,
302 "disconnected must fit in session_event_t");
304 typedef void (vcl_rpc_fn_t) (void *args);
306 typedef struct vppcom_main_t_
312 /** Main process pid */
315 /** App's index in vpp. It's used by vpp to identify the app */
320 /** VCL configuration */
323 volatile u32 forking;
326 vcl_worker_t *workers;
328 /** Lock to protect worker registrations */
329 clib_spinlock_t workers_lock;
331 /** Lock to protect segment hash table */
332 clib_rwlock_t segment_table_lock;
334 /** Mapped segments table */
335 uword *segment_table;
337 /** Control mq obtained from attach */
338 svm_msg_q_t *ctrl_mq;
340 fifo_segment_main_t segment_main;
342 vcl_rpc_fn_t *wrk_rpc_fn;
348 /* VNET_API_ERROR_FOO -> "Foo" hash table */
349 uword *error_string_by_error_number;
352 /* VPP Event-logger */
353 elog_main_t elog_main;
354 elog_track_t elog_track;
359 extern vppcom_main_t *vcm;
360 extern vppcom_main_t _vppcom_main;
362 #define VCL_INVALID_SESSION_INDEX ((u32)~0)
363 #define VCL_INVALID_SESSION_HANDLE ((u64)~0)
364 #define VCL_INVALID_SEGMENT_INDEX ((u32)~0)
365 #define VCL_INVALID_SEGMENT_HANDLE ((u64)~0)
367 void vcl_session_detach_fifos (vcl_session_t *s);
369 static inline vcl_session_t *
370 vcl_session_alloc (vcl_worker_t * wrk)
373 pool_get (wrk->sessions, s);
374 memset (s, 0, sizeof (*s));
375 s->session_index = s - wrk->sessions;
376 s->listener_index = VCL_INVALID_SESSION_INDEX;
381 vcl_session_free (vcl_worker_t * wrk, vcl_session_t * s)
383 /* Debug level set to 1 to avoid debug messages while ldp is cleaning up */
384 VDBG (1, "session %u [0x%llx] removed", s->session_index, s->vpp_handle);
385 vcl_session_detach_fifos (s);
386 pool_put (wrk->sessions, s);
389 static inline vcl_session_t *
390 vcl_session_get (vcl_worker_t * wrk, u32 session_index)
392 if (pool_is_free_index (wrk->sessions, session_index))
394 return pool_elt_at_index (wrk->sessions, session_index);
397 static inline vcl_session_handle_t
398 vcl_session_handle_from_wrk_session_index (u32 session_index, u32 wrk_index)
400 ASSERT (session_index < 2 << 24);
401 return (wrk_index << 24 | session_index);
404 static inline vcl_session_handle_t
405 vcl_session_handle_from_index (u32 session_index)
407 ASSERT (session_index < 2 << 24);
408 return (vcl_get_worker_index () << 24 | session_index);
411 static inline vcl_session_handle_t
412 vcl_session_handle (vcl_session_t * s)
414 return vcl_session_handle_from_index (s->session_index);
418 vcl_session_handle_parse (u32 handle, u32 * wrk_index, u32 * session_index)
420 *wrk_index = handle >> 24;
421 *session_index = handle & 0xFFFFFF;
424 static inline vcl_session_t *
425 vcl_session_get_w_handle (vcl_worker_t * wrk, u32 session_handle)
427 u32 session_index, wrk_index;
428 vcl_session_handle_parse (session_handle, &wrk_index, &session_index);
429 ASSERT (wrk_index == wrk->wrk_index);
430 return vcl_session_get (wrk, session_index);
433 static inline vcl_session_t *
434 vcl_session_get_w_vpp_handle (vcl_worker_t * wrk, u64 vpp_handle)
437 if ((p = hash_get (wrk->session_index_by_vpp_handles, vpp_handle)))
438 return vcl_session_get (wrk, (u32) p[0]);
443 vcl_session_index_from_vpp_handle (vcl_worker_t * wrk, u64 vpp_handle)
446 if ((p = hash_get (wrk->session_index_by_vpp_handles, vpp_handle)))
448 return VCL_INVALID_SESSION_INDEX;
452 vcl_session_table_add_vpp_handle (vcl_worker_t * wrk, u64 handle, u32 value)
454 hash_set (wrk->session_index_by_vpp_handles, handle, value);
458 vcl_session_table_del_vpp_handle (vcl_worker_t * wrk, u64 vpp_handle)
460 hash_unset (wrk->session_index_by_vpp_handles, vpp_handle);
463 static inline uword *
464 vcl_session_table_lookup_vpp_handle (vcl_worker_t * wrk, u64 handle)
466 return hash_get (wrk->session_index_by_vpp_handles, handle);
470 vcl_session_table_add_listener (vcl_worker_t * wrk, u64 listener_handle,
473 hash_set (wrk->session_index_by_vpp_handles, listener_handle, value);
477 vcl_session_table_del_listener (vcl_worker_t * wrk, u64 listener_handle)
479 hash_unset (wrk->session_index_by_vpp_handles, listener_handle);
483 vcl_session_is_connectable_listener (vcl_worker_t * wrk,
484 vcl_session_t * session)
486 /* Tell if we session_handle is a QUIC session.
487 * We can be in the following cases :
488 * Listen session <- QUIC session <- Stream session
489 * QUIC session <- Stream session
492 if (session->session_type != VPPCOM_PROTO_QUIC)
494 if (session->listener_index == VCL_INVALID_SESSION_INDEX)
495 return !(session->session_state == VCL_STATE_LISTEN);
496 ls = vcl_session_get_w_handle (wrk, session->listener_index);
498 return VPPCOM_EBADFD;
499 return ls->session_state == VCL_STATE_LISTEN;
502 static inline vcl_session_t *
503 vcl_session_table_lookup_listener (vcl_worker_t * wrk, u64 handle)
508 p = hash_get (wrk->session_index_by_vpp_handles, handle);
511 VDBG (0, "could not find listen session: unknown vpp listener handle"
515 s = vcl_session_get (wrk, p[0]);
518 VDBG (1, "invalid listen session index (%u)", p[0]);
522 ASSERT (s->session_state == VCL_STATE_LISTEN
523 || s->session_state == VCL_STATE_LISTEN_NO_MQ
524 || vcl_session_is_connectable_listener (wrk, s));
528 const char *vppcom_session_state_str (vcl_session_state_t state);
531 vcl_session_is_ct (vcl_session_t * s)
533 return (s->ct_tx_fifo != 0);
537 vcl_session_is_cl (vcl_session_t * s)
539 if (s->session_type == VPPCOM_PROTO_UDP)
540 return !(s->flags & VCL_SESSION_F_CONNECTED);
545 vcl_session_has_crypto (vcl_session_t *s)
547 return (s->session_type == VPPCOM_PROTO_TLS ||
548 s->session_type == VPPCOM_PROTO_QUIC ||
549 s->session_type == VPPCOM_PROTO_DTLS);
553 vcl_session_is_ready (vcl_session_t * s)
555 return (s->session_state == VCL_STATE_READY
556 || s->session_state == VCL_STATE_VPP_CLOSING);
560 vcl_session_is_open (vcl_session_t * s)
562 return ((vcl_session_is_ready (s))
563 || (s->session_state == VCL_STATE_LISTEN && vcl_session_is_cl (s)));
567 vcl_session_is_closing (vcl_session_t * s)
569 return (s->session_state == VCL_STATE_VPP_CLOSING
570 || s->session_state == VCL_STATE_DISCONNECT);
574 vcl_session_is_closed (vcl_session_t * s)
576 return (!s || (s->session_state == VCL_STATE_CLOSED));
580 vcl_session_closing_error (vcl_session_t * s)
582 /* Return 0 on closing sockets */
583 return s->session_state == VCL_STATE_DISCONNECT ? VPPCOM_ECONNRESET : 0;
587 vcl_session_closed_error (vcl_session_t * s)
589 return s->session_state == VCL_STATE_DISCONNECT
590 ? VPPCOM_ECONNRESET : VPPCOM_ENOTCONN;
594 vcl_ip_copy_from_ep (ip46_address_t * ip, vppcom_endpt_t * ep)
597 clib_memcpy_fast (&ip->ip4, ep->ip, sizeof (ip4_address_t));
599 clib_memcpy_fast (&ip->ip6, ep->ip, sizeof (ip6_address_t));
603 vcl_ip_copy_to_ep (ip46_address_t * ip, vppcom_endpt_t * ep, u8 is_ip4)
607 clib_memcpy_fast (ep->ip, &ip->ip4, sizeof (ip4_address_t));
609 clib_memcpy_fast (ep->ip, &ip->ip6, sizeof (ip6_address_t));
613 vcl_proto_is_dgram (uint8_t proto)
615 return proto == VPPCOM_PROTO_UDP || proto == VPPCOM_PROTO_DTLS;
619 vcl_session_has_attr (vcl_session_t * s, u8 attr)
621 return (s->attributes & (1 << attr)) ? 1 : 0;
625 vcl_session_set_attr (vcl_session_t * s, u8 attr)
627 s->attributes |= 1 << attr;
631 vcl_session_clear_attr (vcl_session_t * s, u8 attr)
633 s->attributes &= ~(1 << attr);
639 vcl_mq_evt_conn_t *vcl_mq_evt_conn_alloc (vcl_worker_t * wrk);
640 u32 vcl_mq_evt_conn_index (vcl_worker_t * wrk, vcl_mq_evt_conn_t * mqc);
641 vcl_mq_evt_conn_t *vcl_mq_evt_conn_get (vcl_worker_t * wrk, u32 mq_conn_idx);
642 int vcl_mq_epoll_add_evfd (vcl_worker_t * wrk, svm_msg_q_t * mq);
643 int vcl_mq_epoll_del_evfd (vcl_worker_t * wrk, u32 mqc_index);
645 vcl_worker_t *vcl_worker_alloc_and_init (void);
646 void vcl_worker_cleanup (vcl_worker_t * wrk, u8 notify_vpp);
647 int vcl_worker_register_with_vpp (void);
648 svm_msg_q_t *vcl_worker_ctrl_mq (vcl_worker_t * wrk);
650 void vcl_flush_mq_events (void);
651 int vcl_session_cleanup (vcl_worker_t * wrk, vcl_session_t * session,
652 vcl_session_handle_t sh, u8 do_disconnect);
654 void vcl_segment_table_add (u64 segment_handle, u32 svm_segment_index);
655 u32 vcl_segment_table_lookup (u64 segment_handle);
656 void vcl_segment_table_del (u64 segment_handle);
658 int vcl_session_read_ready (vcl_session_t * session);
659 int vcl_session_write_ready (vcl_session_t * session);
661 static inline vcl_worker_t *
662 vcl_worker_get (u32 wrk_index)
664 return pool_elt_at_index (vcm->workers, wrk_index);
667 static inline vcl_worker_t *
668 vcl_worker_get_if_valid (u32 wrk_index)
670 if (pool_is_free_index (vcm->workers, wrk_index))
672 return pool_elt_at_index (vcm->workers, wrk_index);
675 static inline vcl_worker_t *
676 vcl_worker_get_current (void)
678 return vcl_worker_get (vcl_get_worker_index ());
684 return pool_elts (vcm->workers);
688 vcl_vpp_worker_segment_handle (u32 wrk_index)
690 return (VCL_INVALID_SEGMENT_HANDLE - wrk_index - 1);
693 void vcl_send_session_worker_update (vcl_worker_t * wrk, vcl_session_t * s,
695 int vcl_send_worker_rpc (u32 dst_wrk_index, void *data, u32 data_len);
697 int vcl_segment_attach (u64 segment_handle, char *name,
698 ssvm_segment_type_t type, int fd);
699 void vcl_segment_detach (u64 segment_handle);
700 void vcl_send_session_unlisten (vcl_worker_t * wrk, vcl_session_t * s);
702 int vcl_segment_attach_session (uword segment_handle, uword rxf_offset,
703 uword txf_offset, uword mq_offset, u8 is_ct,
705 int vcl_segment_attach_mq (uword segment_handle, uword mq_offset, u32 mq_index,
707 int vcl_segment_discover_mqs (uword segment_handle, int *fds, u32 n_fds);
712 int vcl_bapi_attach (void);
713 int vcl_bapi_app_worker_add (void);
714 void vcl_bapi_app_worker_del (vcl_worker_t * wrk);
715 void vcl_bapi_disconnect_from_vpp (void);
716 int vcl_bapi_recv_fds (vcl_worker_t * wrk, int *fds, int n_fds);
717 int vcl_bapi_add_cert_key_pair (vppcom_cert_key_pair_t *ckpair);
718 int vcl_bapi_del_cert_key_pair (u32 ckpair_index);
719 u32 vcl_bapi_max_nsid_len (void);
720 int vcl_bapi_worker_set (void);
725 int vcl_sapi_attach (void);
726 int vcl_sapi_app_worker_add (void);
727 void vcl_sapi_app_worker_del (vcl_worker_t * wrk);
728 void vcl_sapi_detach (vcl_worker_t * wrk);
729 int vcl_sapi_recv_fds (vcl_worker_t * wrk, int *fds, int n_fds);
731 #endif /* SRC_VCL_VCL_PRIVATE_H_ */
734 * fd.io coding-style-patch-verification: ON
737 * eval: (c-set-style "gnu")