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)
92 /* Select uses the vcl_si_set as if a clib_bitmap. Make sure they are the
94 STATIC_ASSERT (sizeof (clib_bitmap_t) == sizeof (vcl_si_set),
95 "vppcom bitmap size mismatch");
103 #define VCL_ACCEPTED_F_CLOSED (1 << 0)
104 #define VCL_ACCEPTED_F_RESET (1 << 1)
106 typedef struct vcl_session_msg
110 session_accepted_msg_t accepted_msg;
117 VCL_SESS_ATTR_SERVER,
118 VCL_SESS_ATTR_CUT_THRU,
120 VCL_SESS_ATTR_VEP_SESSION,
121 VCL_SESS_ATTR_LISTEN, // SOL_SOCKET,SO_ACCEPTCONN
122 VCL_SESS_ATTR_NONBLOCK, // fcntl,O_NONBLOCK
123 VCL_SESS_ATTR_REUSEADDR, // SOL_SOCKET,SO_REUSEADDR
124 VCL_SESS_ATTR_REUSEPORT, // SOL_SOCKET,SO_REUSEPORT
125 VCL_SESS_ATTR_BROADCAST, // SOL_SOCKET,SO_BROADCAST
126 VCL_SESS_ATTR_V6ONLY, // SOL_TCP,IPV6_V6ONLY
127 VCL_SESS_ATTR_KEEPALIVE, // SOL_SOCKET,SO_KEEPALIVE
128 VCL_SESS_ATTR_TCP_NODELAY, // SOL_TCP,TCP_NODELAY
129 VCL_SESS_ATTR_TCP_KEEPIDLE, // SOL_TCP,TCP_KEEPIDLE
130 VCL_SESS_ATTR_TCP_KEEPINTVL, // SOL_TCP,TCP_KEEPINTVL
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 VCL_SESSION_F_RD_SHUTDOWN = 1 << 4,
141 VCL_SESSION_F_WR_SHUTDOWN = 1 << 5,
142 } __clib_packed vcl_session_flags_t;
144 typedef struct vcl_session_
146 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
148 #define _(type, name) type name;
149 foreach_app_session_field
151 vcl_session_flags_t flags; /**< see @ref vcl_session_flags_t */
152 u32 rx_bytes_pending; /**< bytes rx-ed as segs but not yet freed */
154 svm_fifo_t *ct_rx_fifo;
155 svm_fifo_t *ct_tx_fifo;
156 vcl_session_msg_t *accept_evts_fifo;
160 u32 listener_index; /**< index of parent listener (if any) */
161 int n_accepted_sessions; /**< sessions accepted by this listener */
163 u32 attributes; /**< see @ref vppcom_session_attr_t */
167 u32 sndbuf_size; // VPP-TBD: Hack until support setsockopt(SO_SNDBUF)
168 u32 rcvbuf_size; // VPP-TBD: Hack until support setsockopt(SO_RCVBUF)
170 transport_endpt_ext_cfg_t *ext_config;
173 elog_track_t elog_track;
177 typedef struct vppcom_cfg_t_
181 uword segment_baseva;
183 uword add_segment_size;
184 u32 preallocated_fifo_pairs;
187 u32 event_queue_size;
188 u8 app_proxy_transport_tcp;
189 u8 app_proxy_transport_udp;
193 u64 namespace_secret;
197 char *event_log_path;
198 u8 *vpp_app_socket_api; /**< app socket api socket file name */
199 u8 *vpp_bapi_socket_name; /**< bapi socket transport socket name */
204 void vppcom_cfg (vppcom_cfg_t * vcl_cfg);
206 typedef struct vcl_cut_through_registration_
209 svm_msg_q_t *peer_mq;
211 u32 epoll_evt_conn_index; /*< mq evt connection index part of
212 the mqs evtfd epoll (if used) */
213 } vcl_cut_through_registration_t;
215 typedef struct vcl_mq_evt_conn_
221 typedef struct vcl_worker_
223 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
226 vcl_session_t *sessions;
228 /** Worker/thread index in current process */
231 /** Worker index in vpp*/
235 * Generic api client handle. When binary api is in used, it stores
236 * the "client_index" and when socket api is use, it stores the sapi
238 u32 api_client_handle;
240 /** VPP binary api input queue */
241 svm_queue_t *vl_input_queue;
243 /** VPP mq to be used for exchanging control messages */
244 svm_msg_q_t *ctrl_mq;
246 /** Message queues epoll fd. Initialized only if using mqs with eventfds */
249 /** Pool of event message queue event connections */
250 vcl_mq_evt_conn_t *mq_evt_conns;
252 /** Per worker buffer for receiving mq epoll events */
253 struct epoll_event *mq_events;
255 /** Next session to be lt polled */
258 /** Hash table for disconnect processing */
259 uword *session_index_by_vpp_handles;
261 /** Select bitmaps */
262 clib_bitmap_t *rd_bitmap;
263 clib_bitmap_t *wr_bitmap;
264 clib_bitmap_t *ex_bitmap;
266 /** Our event message queue */
267 svm_msg_q_t *app_event_queue;
269 /** For deadman timers */
270 clib_time_t clib_time;
272 /** Vector acting as buffer for mq messages */
273 svm_msg_q_msg_t *mq_msg_vector;
275 /** Vector of unhandled events */
276 session_event_t *unhandled_evts_vector;
278 u32 *pending_session_wrk_updates;
280 /** Used also as a thread stop key buffer */
283 /** Current pid, may be different from main_pid if forked child */
288 clib_socket_t app_api_sock;
289 socket_client_main_t bapi_sock_ctx;
290 api_main_t bapi_api_ctx;
291 memory_client_main_t bapi_mem_ctx;
293 /* State of the connection, shared between msg RX thread and main thread */
294 volatile vcl_bapi_app_state_t bapi_app_state;
295 volatile uword bapi_return;
298 int session_attr_op_rv;
299 transport_endpt_attr_t session_attr_rv;
301 /** vcl needs next epoll_create to go to libc_epoll */
302 u8 vcl_needs_real_epoll;
303 volatile int rpc_done;
306 STATIC_ASSERT (sizeof (session_disconnected_msg_t) <= 16,
307 "disconnected must fit in session_event_t");
308 STATIC_ASSERT (sizeof (session_reset_msg_t) <= 16,
309 "disconnected must fit in session_event_t");
311 typedef void (vcl_rpc_fn_t) (void *args);
313 typedef struct vppcom_main_t_
319 /** Main process pid */
322 /** App's index in vpp. It's used by vpp to identify the app */
327 /** VCL configuration */
330 volatile u32 forking;
333 vcl_worker_t *workers;
335 /** Lock to protect worker registrations */
336 clib_spinlock_t workers_lock;
338 /** Lock to protect segment hash table */
339 clib_rwlock_t segment_table_lock;
341 /** Mapped segments table */
342 uword *segment_table;
344 /** Control mq obtained from attach */
345 svm_msg_q_t *ctrl_mq;
347 fifo_segment_main_t segment_main;
349 vcl_rpc_fn_t *wrk_rpc_fn;
355 /* VNET_API_ERROR_FOO -> "Foo" hash table */
356 uword *error_string_by_error_number;
359 /* VPP Event-logger */
360 elog_main_t elog_main;
361 elog_track_t elog_track;
366 extern vppcom_main_t *vcm;
367 extern vppcom_main_t _vppcom_main;
369 #define VCL_INVALID_SESSION_INDEX ((u32)~0)
370 #define VCL_INVALID_SESSION_HANDLE ((u64)~0)
371 #define VCL_INVALID_SEGMENT_INDEX ((u32)~0)
372 #define VCL_INVALID_SEGMENT_HANDLE ((u64)~0)
374 void vcl_session_detach_fifos (vcl_session_t *s);
376 static inline vcl_session_t *
377 vcl_session_alloc (vcl_worker_t * wrk)
380 pool_get (wrk->sessions, s);
381 memset (s, 0, sizeof (*s));
382 s->session_index = s - wrk->sessions;
383 s->listener_index = VCL_INVALID_SESSION_INDEX;
388 vcl_session_free (vcl_worker_t * wrk, vcl_session_t * s)
390 /* Debug level set to 1 to avoid debug messages while ldp is cleaning up */
391 VDBG (1, "session %u [0x%llx] removed", s->session_index, s->vpp_handle);
392 vcl_session_detach_fifos (s);
394 clib_mem_free (s->ext_config);
395 pool_put (wrk->sessions, s);
398 static inline vcl_session_t *
399 vcl_session_get (vcl_worker_t * wrk, u32 session_index)
401 if (pool_is_free_index (wrk->sessions, session_index))
403 return pool_elt_at_index (wrk->sessions, session_index);
406 static inline vcl_session_handle_t
407 vcl_session_handle_from_wrk_session_index (u32 session_index, u32 wrk_index)
409 ASSERT (session_index < 2 << 24);
410 return (wrk_index << 24 | session_index);
413 static inline vcl_session_handle_t
414 vcl_session_handle_from_index (u32 session_index)
416 ASSERT (session_index < 2 << 24);
417 return (vcl_get_worker_index () << 24 | session_index);
420 static inline vcl_session_handle_t
421 vcl_session_handle (vcl_session_t * s)
423 return vcl_session_handle_from_index (s->session_index);
427 vcl_session_handle_parse (u32 handle, u32 * wrk_index, u32 * session_index)
429 *wrk_index = handle >> 24;
430 *session_index = handle & 0xFFFFFF;
433 static inline vcl_session_t *
434 vcl_session_get_w_handle (vcl_worker_t * wrk, u32 session_handle)
436 u32 session_index, wrk_index;
437 vcl_session_handle_parse (session_handle, &wrk_index, &session_index);
438 ASSERT (wrk_index == wrk->wrk_index);
439 return vcl_session_get (wrk, session_index);
442 static inline vcl_session_t *
443 vcl_session_get_w_vpp_handle (vcl_worker_t * wrk, u64 vpp_handle)
446 if ((p = hash_get (wrk->session_index_by_vpp_handles, vpp_handle)))
447 return vcl_session_get (wrk, (u32) p[0]);
452 vcl_session_index_from_vpp_handle (vcl_worker_t * wrk, u64 vpp_handle)
455 if ((p = hash_get (wrk->session_index_by_vpp_handles, vpp_handle)))
457 return VCL_INVALID_SESSION_INDEX;
461 vcl_session_table_add_vpp_handle (vcl_worker_t * wrk, u64 handle, u32 value)
463 hash_set (wrk->session_index_by_vpp_handles, handle, value);
467 vcl_session_table_del_vpp_handle (vcl_worker_t * wrk, u64 vpp_handle)
469 hash_unset (wrk->session_index_by_vpp_handles, vpp_handle);
472 static inline uword *
473 vcl_session_table_lookup_vpp_handle (vcl_worker_t * wrk, u64 handle)
475 return hash_get (wrk->session_index_by_vpp_handles, handle);
479 vcl_session_table_add_listener (vcl_worker_t * wrk, u64 listener_handle,
482 hash_set (wrk->session_index_by_vpp_handles, listener_handle, value);
486 vcl_session_table_del_listener (vcl_worker_t * wrk, u64 listener_handle)
488 hash_unset (wrk->session_index_by_vpp_handles, listener_handle);
492 vcl_session_is_connectable_listener (vcl_worker_t * wrk,
493 vcl_session_t * session)
495 /* Tell if we session_handle is a QUIC session.
496 * We can be in the following cases :
497 * Listen session <- QUIC session <- Stream session
498 * QUIC session <- Stream session
501 if (session->session_type != VPPCOM_PROTO_QUIC)
503 if (session->listener_index == VCL_INVALID_SESSION_INDEX)
504 return !(session->session_state == VCL_STATE_LISTEN);
505 ls = vcl_session_get_w_handle (wrk, session->listener_index);
507 return VPPCOM_EBADFD;
508 return ls->session_state == VCL_STATE_LISTEN;
511 static inline vcl_session_t *
512 vcl_session_table_lookup_listener (vcl_worker_t * wrk, u64 handle)
517 p = hash_get (wrk->session_index_by_vpp_handles, handle);
520 VDBG (0, "could not find listen session: unknown vpp listener handle"
524 s = vcl_session_get (wrk, p[0]);
527 VDBG (1, "invalid listen session index (%u)", p[0]);
531 if (s->session_state == VCL_STATE_DISCONNECT)
533 VDBG (0, "listen session [0x%llx] is closing", s->vpp_handle);
537 ASSERT (s->session_state == VCL_STATE_LISTEN
538 || s->session_state == VCL_STATE_LISTEN_NO_MQ
539 || vcl_session_is_connectable_listener (wrk, s));
543 const char *vppcom_session_state_str (vcl_session_state_t state);
546 vcl_session_is_ct (vcl_session_t * s)
548 return (s->ct_tx_fifo != 0);
552 vcl_session_is_cl (vcl_session_t * s)
554 if (s->session_type == VPPCOM_PROTO_UDP)
555 return !(s->flags & VCL_SESSION_F_CONNECTED);
560 vcl_session_has_crypto (vcl_session_t *s)
562 return (s->session_type == VPPCOM_PROTO_TLS ||
563 s->session_type == VPPCOM_PROTO_QUIC ||
564 s->session_type == VPPCOM_PROTO_DTLS);
568 vcl_session_is_ready (vcl_session_t * s)
570 return (s->session_state == VCL_STATE_READY
571 || s->session_state == VCL_STATE_VPP_CLOSING);
575 vcl_session_is_open (vcl_session_t * s)
577 return ((vcl_session_is_ready (s))
578 || (s->session_state == VCL_STATE_LISTEN && vcl_session_is_cl (s)));
582 vcl_session_is_closing (vcl_session_t * s)
584 return (s->session_state == VCL_STATE_VPP_CLOSING
585 || s->session_state == VCL_STATE_DISCONNECT);
589 vcl_session_is_closed (vcl_session_t * s)
591 return (!s || (s->session_state == VCL_STATE_CLOSED));
595 vcl_session_closing_error (vcl_session_t * s)
597 /* Return 0 on closing sockets */
598 return s->session_state == VCL_STATE_DISCONNECT ? VPPCOM_ECONNRESET : 0;
602 vcl_session_closed_error (vcl_session_t * s)
604 return s->session_state == VCL_STATE_DISCONNECT
605 ? VPPCOM_ECONNRESET : VPPCOM_ENOTCONN;
609 vcl_ip_copy_from_ep (ip46_address_t * ip, vppcom_endpt_t * ep)
612 clib_memcpy_fast (&ip->ip4, ep->ip, sizeof (ip4_address_t));
614 clib_memcpy_fast (&ip->ip6, ep->ip, sizeof (ip6_address_t));
618 vcl_ip_copy_to_ep (ip46_address_t * ip, vppcom_endpt_t * ep, u8 is_ip4)
622 clib_memcpy_fast (ep->ip, &ip->ip4, sizeof (ip4_address_t));
624 clib_memcpy_fast (ep->ip, &ip->ip6, sizeof (ip6_address_t));
628 vcl_proto_is_dgram (uint8_t proto)
630 return proto == VPPCOM_PROTO_UDP || proto == VPPCOM_PROTO_DTLS ||
631 proto == VPPCOM_PROTO_SRTP;
635 vcl_session_has_attr (vcl_session_t * s, u8 attr)
637 return (s->attributes & (1 << attr)) ? 1 : 0;
641 vcl_session_set_attr (vcl_session_t * s, u8 attr)
643 s->attributes |= 1 << attr;
647 vcl_session_clear_attr (vcl_session_t * s, u8 attr)
649 s->attributes &= ~(1 << attr);
655 vcl_mq_evt_conn_t *vcl_mq_evt_conn_alloc (vcl_worker_t * wrk);
656 u32 vcl_mq_evt_conn_index (vcl_worker_t * wrk, vcl_mq_evt_conn_t * mqc);
657 vcl_mq_evt_conn_t *vcl_mq_evt_conn_get (vcl_worker_t * wrk, u32 mq_conn_idx);
658 int vcl_mq_epoll_add_evfd (vcl_worker_t * wrk, svm_msg_q_t * mq);
659 int vcl_mq_epoll_del_evfd (vcl_worker_t * wrk, u32 mqc_index);
661 vcl_worker_t *vcl_worker_alloc_and_init (void);
662 void vcl_worker_cleanup (vcl_worker_t * wrk, u8 notify_vpp);
663 int vcl_worker_register_with_vpp (void);
664 svm_msg_q_t *vcl_worker_ctrl_mq (vcl_worker_t * wrk);
666 void vcl_flush_mq_events (void);
667 int vcl_session_cleanup (vcl_worker_t * wrk, vcl_session_t * session,
668 vcl_session_handle_t sh, u8 do_disconnect);
670 void vcl_segment_table_add (u64 segment_handle, u32 svm_segment_index);
671 u32 vcl_segment_table_lookup (u64 segment_handle);
672 void vcl_segment_table_del (u64 segment_handle);
674 int vcl_session_read_ready (vcl_session_t * session);
675 int vcl_session_write_ready (vcl_session_t * session);
676 int vcl_session_alloc_ext_cfg (vcl_session_t *s,
677 transport_endpt_ext_cfg_type_t type, u32 len);
679 static inline vcl_worker_t *
680 vcl_worker_get (u32 wrk_index)
682 return pool_elt_at_index (vcm->workers, wrk_index);
685 static inline vcl_worker_t *
686 vcl_worker_get_if_valid (u32 wrk_index)
688 if (pool_is_free_index (vcm->workers, wrk_index))
690 return pool_elt_at_index (vcm->workers, wrk_index);
693 static inline vcl_worker_t *
694 vcl_worker_get_current (void)
696 return vcl_worker_get (vcl_get_worker_index ());
702 return pool_elts (vcm->workers);
706 vcl_vpp_worker_segment_handle (u32 wrk_index)
708 return (VCL_INVALID_SEGMENT_HANDLE - wrk_index - 1);
711 void vcl_send_session_worker_update (vcl_worker_t * wrk, vcl_session_t * s,
713 int vcl_send_worker_rpc (u32 dst_wrk_index, void *data, u32 data_len);
715 int vcl_segment_attach (u64 segment_handle, char *name,
716 ssvm_segment_type_t type, int fd);
717 void vcl_segment_detach (u64 segment_handle);
718 void vcl_send_session_unlisten (vcl_worker_t * wrk, vcl_session_t * s);
720 int vcl_segment_attach_session (uword segment_handle, uword rxf_offset,
721 uword txf_offset, uword mq_offset,
722 u32 mq_index, u8 is_ct, vcl_session_t *s);
723 int vcl_segment_attach_mq (uword segment_handle, uword mq_offset, u32 mq_index,
725 int vcl_segment_discover_mqs (uword segment_handle, int *fds, u32 n_fds);
726 svm_fifo_chunk_t *vcl_segment_alloc_chunk (uword segment_handle,
727 u32 slice_index, u32 size,
729 int vcl_session_share_fifos (vcl_session_t *s, svm_fifo_t *rxf,
735 int vcl_bapi_attach (void);
736 int vcl_bapi_app_worker_add (void);
737 void vcl_bapi_app_worker_del (vcl_worker_t * wrk);
738 void vcl_bapi_disconnect_from_vpp (void);
739 int vcl_bapi_recv_fds (vcl_worker_t * wrk, int *fds, int n_fds);
740 int vcl_bapi_add_cert_key_pair (vppcom_cert_key_pair_t *ckpair);
741 int vcl_bapi_del_cert_key_pair (u32 ckpair_index);
742 u32 vcl_bapi_max_nsid_len (void);
743 int vcl_bapi_worker_set (void);
748 int vcl_sapi_attach (void);
749 int vcl_sapi_app_worker_add (void);
750 void vcl_sapi_app_worker_del (vcl_worker_t * wrk);
751 void vcl_sapi_detach (vcl_worker_t * wrk);
752 int vcl_sapi_recv_fds (vcl_worker_t * wrk, int *fds, int n_fds);
753 int vcl_sapi_add_cert_key_pair (vppcom_cert_key_pair_t *ckpair);
754 int vcl_sapi_del_cert_key_pair (u32 ckpair_index);
756 #endif /* SRC_VCL_VCL_PRIVATE_H_ */
759 * fd.io coding-style-patch-verification: ON
762 * eval: (c-set-style "gnu")