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
131 VCL_SESS_ATTR_IP_PKTINFO, /* IPPROTO_IP, IP_PKTINFO */
133 } vppcom_session_attr_t;
135 typedef enum vcl_session_flags_
137 VCL_SESSION_F_CONNECTED = 1 << 0,
138 VCL_SESSION_F_IS_VEP = 1 << 1,
139 VCL_SESSION_F_IS_VEP_SESSION = 1 << 2,
140 VCL_SESSION_F_HAS_RX_EVT = 1 << 3,
141 VCL_SESSION_F_RD_SHUTDOWN = 1 << 4,
142 VCL_SESSION_F_WR_SHUTDOWN = 1 << 5,
143 VCL_SESSION_F_PENDING_DISCONNECT = 1 << 6,
144 VCL_SESSION_F_PENDING_FREE = 1 << 7,
145 VCL_SESSION_F_PENDING_LISTEN = 1 << 8,
146 } __clib_packed vcl_session_flags_t;
148 typedef struct vcl_session_
150 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
152 #define _(type, name) type name;
153 foreach_app_session_field
155 vcl_session_flags_t flags; /**< see @ref vcl_session_flags_t */
156 u32 rx_bytes_pending; /**< bytes rx-ed as segs but not yet freed */
158 svm_fifo_t *ct_rx_fifo;
159 svm_fifo_t *ct_tx_fifo;
160 vcl_session_msg_t *accept_evts_fifo;
164 u32 listener_index; /**< index of parent listener (if any) */
165 int n_accepted_sessions; /**< sessions accepted by this listener */
167 u32 attributes; /**< see @ref vppcom_session_attr_t */
172 u32 sndbuf_size; // VPP-TBD: Hack until support setsockopt(SO_SNDBUF)
173 u32 rcvbuf_size; // VPP-TBD: Hack until support setsockopt(SO_RCVBUF)
175 transport_endpt_ext_cfg_t *ext_config;
181 elog_track_t elog_track;
185 typedef struct vppcom_cfg_t_
189 uword segment_baseva;
191 uword add_segment_size;
192 u32 preallocated_fifo_pairs;
195 u32 event_queue_size;
196 u8 app_proxy_transport_tcp;
197 u8 app_proxy_transport_udp;
201 u64 namespace_secret;
205 char *event_log_path;
206 u8 *vpp_app_socket_api; /**< app socket api socket file name */
207 u8 *vpp_bapi_socket_name; /**< bapi socket transport socket name */
213 void vppcom_cfg (vppcom_cfg_t * vcl_cfg);
215 typedef struct vcl_cut_through_registration_
218 svm_msg_q_t *peer_mq;
220 u32 epoll_evt_conn_index; /*< mq evt connection index part of
221 the mqs evtfd epoll (if used) */
222 } vcl_cut_through_registration_t;
224 typedef struct vcl_mq_evt_conn_
230 typedef struct vcl_worker_
232 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
235 vcl_session_t *sessions;
237 /** Worker/thread index in current process */
240 /** Worker index in vpp*/
244 * Generic api client handle. When binary api is in used, it stores
245 * the "client_index" and when socket api is use, it stores the sapi
247 u32 api_client_handle;
249 /** VPP binary api input queue */
250 svm_queue_t *vl_input_queue;
252 /** VPP mq to be used for exchanging control messages */
253 svm_msg_q_t *ctrl_mq;
255 /** Message queues epoll fd. Initialized only if using mqs with eventfds */
258 /** Pool of event message queue event connections */
259 vcl_mq_evt_conn_t *mq_evt_conns;
261 /** Per worker buffer for receiving mq epoll events */
262 struct epoll_event *mq_events;
264 /** Next session to be lt polled */
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 /** For deadman timers */
279 clib_time_t clib_time;
281 /** Vector acting as buffer for mq messages */
282 svm_msg_q_msg_t *mq_msg_vector;
284 /** Vector of unhandled events */
285 session_event_t *unhandled_evts_vector;
287 u32 *pending_session_wrk_updates;
289 /** Used also as a thread stop key buffer */
292 /** Current pid, may be different from main_pid if forked child */
297 clib_socket_t app_api_sock;
298 socket_client_main_t bapi_sock_ctx;
299 api_main_t bapi_api_ctx;
300 memory_client_main_t bapi_mem_ctx;
302 /* State of the connection, shared between msg RX thread and main thread */
303 volatile vcl_bapi_app_state_t bapi_app_state;
304 volatile uword bapi_return;
307 int session_attr_op_rv;
308 transport_endpt_attr_t session_attr_rv;
310 /** vcl needs next epoll_create to go to libc_epoll */
311 u8 vcl_needs_real_epoll;
312 volatile int rpc_done;
315 STATIC_ASSERT (sizeof (session_disconnected_msg_t) <= 16,
316 "disconnected must fit in session_event_t");
317 STATIC_ASSERT (sizeof (session_reset_msg_t) <= 16,
318 "disconnected must fit in session_event_t");
320 typedef void (vcl_rpc_fn_t) (void *args);
322 typedef struct vppcom_main_t_
328 /** Main process pid */
331 /** App's index in vpp. It's used by vpp to identify the app */
336 /** VCL configuration */
339 volatile u32 forking;
342 vcl_worker_t *workers;
344 /** Lock to protect worker registrations */
345 clib_spinlock_t workers_lock;
347 /** Counter to determine order of execution of `vcl_api_retry_attach`
348 * function by multiple workers */
351 /** Lock to protect segment hash table */
352 clib_rwlock_t segment_table_lock;
354 /** Mapped segments table */
355 uword *segment_table;
357 /** Control mq obtained from attach */
358 svm_msg_q_t *ctrl_mq;
360 fifo_segment_main_t segment_main;
362 vcl_rpc_fn_t *wrk_rpc_fn;
368 /* VNET_API_ERROR_FOO -> "Foo" hash table */
369 uword *error_string_by_error_number;
372 /* VPP Event-logger */
373 elog_main_t elog_main;
374 elog_track_t elog_track;
379 extern vppcom_main_t *vcm;
380 extern vppcom_main_t _vppcom_main;
382 #define VCL_INVALID_SESSION_INDEX ((u32)~0)
383 #define VCL_INVALID_SESSION_HANDLE ((u64)~0)
384 #define VCL_INVALID_SEGMENT_INDEX ((u32)~0)
385 #define VCL_INVALID_SEGMENT_HANDLE ((u64)~0)
387 void vcl_session_detach_fifos (vcl_session_t *s);
389 static inline vcl_session_t *
390 vcl_session_alloc (vcl_worker_t * wrk)
393 pool_get (wrk->sessions, s);
394 memset (s, 0, sizeof (*s));
395 s->session_index = s - wrk->sessions;
396 s->listener_index = VCL_INVALID_SESSION_INDEX;
401 vcl_session_free (vcl_worker_t * wrk, vcl_session_t * s)
403 /* Debug level set to 1 to avoid debug messages while ldp is cleaning up */
404 VDBG (1, "session %u [0x%llx] removed", s->session_index, s->vpp_handle);
405 vcl_session_detach_fifos (s);
407 clib_mem_free (s->ext_config);
408 pool_put (wrk->sessions, s);
411 static inline vcl_session_t *
412 vcl_session_get (vcl_worker_t * wrk, u32 session_index)
414 if (pool_is_free_index (wrk->sessions, session_index))
416 return pool_elt_at_index (wrk->sessions, session_index);
419 static inline vcl_session_handle_t
420 vcl_session_handle_from_wrk_session_index (u32 session_index, u32 wrk_index)
422 ASSERT (session_index < 2 << 24);
423 return (wrk_index << 24 | session_index);
426 static inline vcl_session_handle_t
427 vcl_session_handle_from_index (u32 session_index)
429 ASSERT (session_index < 2 << 24);
430 return (vcl_get_worker_index () << 24 | session_index);
433 static inline vcl_session_handle_t
434 vcl_session_handle (vcl_session_t * s)
436 return vcl_session_handle_from_index (s->session_index);
440 vcl_session_handle_parse (u32 handle, u32 * wrk_index, u32 * session_index)
442 *wrk_index = handle >> 24;
443 *session_index = handle & 0xFFFFFF;
446 static inline vcl_session_t *
447 vcl_session_get_w_handle (vcl_worker_t * wrk, u32 session_handle)
449 u32 session_index, wrk_index;
450 vcl_session_handle_parse (session_handle, &wrk_index, &session_index);
451 ASSERT (wrk_index == wrk->wrk_index);
452 return vcl_session_get (wrk, session_index);
455 static inline vcl_session_t *
456 vcl_session_get_w_vpp_handle (vcl_worker_t * wrk, u64 vpp_handle)
459 if ((p = hash_get (wrk->session_index_by_vpp_handles, vpp_handle)))
460 return vcl_session_get (wrk, (u32) p[0]);
465 vcl_session_index_from_vpp_handle (vcl_worker_t * wrk, u64 vpp_handle)
468 if ((p = hash_get (wrk->session_index_by_vpp_handles, vpp_handle)))
470 return VCL_INVALID_SESSION_INDEX;
474 vcl_session_table_add_vpp_handle (vcl_worker_t * wrk, u64 handle, u32 value)
476 hash_set (wrk->session_index_by_vpp_handles, handle, value);
480 vcl_session_table_del_vpp_handle (vcl_worker_t * wrk, u64 vpp_handle)
482 hash_unset (wrk->session_index_by_vpp_handles, vpp_handle);
485 static inline uword *
486 vcl_session_table_lookup_vpp_handle (vcl_worker_t * wrk, u64 handle)
488 return hash_get (wrk->session_index_by_vpp_handles, handle);
492 vcl_session_table_add_listener (vcl_worker_t * wrk, u64 listener_handle,
495 hash_set (wrk->session_index_by_vpp_handles, listener_handle, value);
499 vcl_session_table_del_listener (vcl_worker_t * wrk, u64 listener_handle)
501 hash_unset (wrk->session_index_by_vpp_handles, listener_handle);
505 vcl_session_is_connectable_listener (vcl_worker_t * wrk,
506 vcl_session_t * session)
508 /* Tell if we session_handle is a QUIC session.
509 * We can be in the following cases :
510 * Listen session <- QUIC session <- Stream session
511 * QUIC session <- Stream session
514 if (session->session_type != VPPCOM_PROTO_QUIC)
516 if (session->listener_index == VCL_INVALID_SESSION_INDEX)
517 return !(session->session_state == VCL_STATE_LISTEN);
518 ls = vcl_session_get_w_handle (wrk, session->listener_index);
520 return VPPCOM_EBADFD;
521 return ls->session_state == VCL_STATE_LISTEN;
524 static inline vcl_session_t *
525 vcl_session_table_lookup_listener (vcl_worker_t * wrk, u64 handle)
530 p = hash_get (wrk->session_index_by_vpp_handles, handle);
533 VDBG (0, "could not find listen session: unknown vpp listener handle"
537 s = vcl_session_get (wrk, p[0]);
540 VDBG (1, "invalid listen session index (%u)", p[0]);
544 if (s->session_state == VCL_STATE_DISCONNECT)
546 VDBG (0, "listen session [0x%llx] is closing", s->vpp_handle);
550 ASSERT (s->session_state == VCL_STATE_LISTEN
551 || s->session_state == VCL_STATE_LISTEN_NO_MQ
552 || vcl_session_is_connectable_listener (wrk, s));
557 vcl_session_is_ct (vcl_session_t * s)
559 return (s->ct_tx_fifo != 0);
563 vcl_session_is_cl (vcl_session_t * s)
565 if (s->session_type == VPPCOM_PROTO_UDP)
566 return !(s->flags & VCL_SESSION_F_CONNECTED);
571 vcl_session_has_crypto (vcl_session_t *s)
573 return (s->session_type == VPPCOM_PROTO_TLS ||
574 s->session_type == VPPCOM_PROTO_QUIC ||
575 s->session_type == VPPCOM_PROTO_DTLS);
579 vcl_session_is_ready (vcl_session_t * s)
581 return (s->session_state == VCL_STATE_READY
582 || s->session_state == VCL_STATE_VPP_CLOSING);
586 vcl_session_is_open (vcl_session_t * s)
588 return ((vcl_session_is_ready (s))
589 || (s->session_state == VCL_STATE_LISTEN && vcl_session_is_cl (s)));
593 vcl_session_is_closing (vcl_session_t * s)
595 return (s->session_state == VCL_STATE_VPP_CLOSING
596 || s->session_state == VCL_STATE_DISCONNECT);
600 vcl_session_is_closed (vcl_session_t * s)
602 return (!s || (s->session_state == VCL_STATE_CLOSED));
606 vcl_session_closing_error (vcl_session_t * s)
608 /* Return 0 on closing sockets */
609 return s->session_state == VCL_STATE_DISCONNECT ? VPPCOM_ECONNRESET : 0;
613 vcl_session_closed_error (vcl_session_t * s)
615 return s->session_state == VCL_STATE_DISCONNECT
616 ? VPPCOM_ECONNRESET : VPPCOM_ENOTCONN;
620 vcl_ip_copy_from_ep (ip46_address_t * ip, vppcom_endpt_t * ep)
623 clib_memcpy_fast (&ip->ip4, ep->ip, sizeof (ip4_address_t));
625 clib_memcpy_fast (&ip->ip6, ep->ip, sizeof (ip6_address_t));
629 vcl_ip_copy_to_ep (ip46_address_t * ip, vppcom_endpt_t * ep, u8 is_ip4)
633 clib_memcpy_fast (ep->ip, &ip->ip4, sizeof (ip4_address_t));
635 clib_memcpy_fast (ep->ip, &ip->ip6, sizeof (ip6_address_t));
639 vcl_proto_is_dgram (uint8_t proto)
641 return proto == VPPCOM_PROTO_UDP || proto == VPPCOM_PROTO_DTLS ||
642 proto == VPPCOM_PROTO_SRTP;
646 vcl_session_has_attr (vcl_session_t * s, u8 attr)
648 return (s->attributes & (1 << attr)) ? 1 : 0;
652 vcl_session_set_attr (vcl_session_t * s, u8 attr)
654 s->attributes |= 1 << attr;
658 vcl_session_clear_attr (vcl_session_t * s, u8 attr)
660 s->attributes &= ~(1 << attr);
666 vcl_mq_evt_conn_t *vcl_mq_evt_conn_alloc (vcl_worker_t * wrk);
667 u32 vcl_mq_evt_conn_index (vcl_worker_t * wrk, vcl_mq_evt_conn_t * mqc);
668 vcl_mq_evt_conn_t *vcl_mq_evt_conn_get (vcl_worker_t * wrk, u32 mq_conn_idx);
669 int vcl_mq_epoll_add_evfd (vcl_worker_t * wrk, svm_msg_q_t * mq);
670 int vcl_mq_epoll_del_evfd (vcl_worker_t * wrk, u32 mqc_index);
672 vcl_worker_t *vcl_worker_alloc_and_init (void);
673 void vcl_worker_cleanup (vcl_worker_t * wrk, u8 notify_vpp);
674 int vcl_worker_register_with_vpp (void);
675 svm_msg_q_t *vcl_worker_ctrl_mq (vcl_worker_t * wrk);
677 void vcl_flush_mq_events (void);
678 int vcl_session_cleanup (vcl_worker_t * wrk, vcl_session_t * session,
679 vcl_session_handle_t sh, u8 do_disconnect);
681 void vcl_segment_table_add (u64 segment_handle, u32 svm_segment_index);
682 u32 vcl_segment_table_lookup (u64 segment_handle);
683 void vcl_segment_table_del (u64 segment_handle);
685 int vcl_session_read_ready (vcl_session_t * session);
686 int vcl_session_write_ready (vcl_session_t * session);
687 int vcl_session_alloc_ext_cfg (vcl_session_t *s,
688 transport_endpt_ext_cfg_type_t type, u32 len);
690 static inline vcl_worker_t *
691 vcl_worker_get (u32 wrk_index)
693 return pool_elt_at_index (vcm->workers, wrk_index);
696 static inline vcl_worker_t *
697 vcl_worker_get_if_valid (u32 wrk_index)
699 if (pool_is_free_index (vcm->workers, wrk_index))
701 return pool_elt_at_index (vcm->workers, wrk_index);
704 static inline vcl_worker_t *
705 vcl_worker_get_current (void)
707 return vcl_worker_get (vcl_get_worker_index ());
713 return pool_elts (vcm->workers);
717 vcl_vpp_worker_segment_handle (u32 wrk_index)
719 return (VCL_INVALID_SEGMENT_HANDLE - wrk_index - 1);
722 void vcl_send_session_worker_update (vcl_worker_t * wrk, vcl_session_t * s,
724 int vcl_send_worker_rpc (u32 dst_wrk_index, void *data, u32 data_len);
726 int vcl_segment_attach (u64 segment_handle, char *name,
727 ssvm_segment_type_t type, int fd);
728 void vcl_segment_detach (u64 segment_handle);
729 void vcl_segment_detach_segments (u32 *seg_indices);
730 void vcl_send_session_listen (vcl_worker_t *wrk, vcl_session_t *s);
731 void vcl_send_session_unlisten (vcl_worker_t * wrk, vcl_session_t * s);
733 int vcl_segment_attach_session (uword segment_handle, uword rxf_offset,
734 uword txf_offset, uword mq_offset,
735 u32 mq_index, u8 is_ct, vcl_session_t *s);
736 int vcl_segment_attach_mq (uword segment_handle, uword mq_offset, u32 mq_index,
738 int vcl_segment_discover_mqs (uword segment_handle, int *fds, u32 n_fds);
739 svm_fifo_chunk_t *vcl_segment_alloc_chunk (uword segment_handle,
740 u32 slice_index, u32 size,
742 int vcl_session_share_fifos (vcl_session_t *s, svm_fifo_t *rxf,
744 void vcl_worker_detach_sessions (vcl_worker_t *wrk);
749 int vcl_bapi_attach (void);
750 int vcl_bapi_app_worker_add (void);
751 void vcl_bapi_app_worker_del (vcl_worker_t * wrk);
752 void vcl_bapi_disconnect_from_vpp (void);
753 int vcl_bapi_recv_fds (vcl_worker_t * wrk, int *fds, int n_fds);
754 int vcl_bapi_add_cert_key_pair (vppcom_cert_key_pair_t *ckpair);
755 int vcl_bapi_del_cert_key_pair (u32 ckpair_index);
756 u32 vcl_bapi_max_nsid_len (void);
757 int vcl_bapi_worker_set (void);
762 int vcl_sapi_attach (void);
763 int vcl_sapi_app_worker_add (void);
764 void vcl_sapi_app_worker_del (vcl_worker_t * wrk);
765 void vcl_sapi_detach (vcl_worker_t * wrk);
766 int vcl_sapi_recv_fds (vcl_worker_t * wrk, int *fds, int n_fds);
767 int vcl_sapi_add_cert_key_pair (vppcom_cert_key_pair_t *ckpair);
768 int vcl_sapi_del_cert_key_pair (u32 ckpair_index);
773 const char *vcl_session_state_str (vcl_session_state_t state);
774 u8 *vcl_format_ip4_address (u8 *s, va_list *args);
775 u8 *vcl_format_ip6_address (u8 *s, va_list *args);
776 u8 *vcl_format_ip46_address (u8 *s, va_list *args);
778 #endif /* SRC_VCL_VCL_PRIVATE_H_ */
781 * fd.io coding-style-patch-verification: ON
784 * eval: (c-set-style "gnu")