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 VCL_SESSION_F_PENDING_DISCONNECT = 1 << 6,
143 VCL_SESSION_F_PENDING_FREE = 1 << 7,
144 } __clib_packed vcl_session_flags_t;
146 typedef struct vcl_session_
148 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
150 #define _(type, name) type name;
151 foreach_app_session_field
153 vcl_session_flags_t flags; /**< see @ref vcl_session_flags_t */
154 u32 rx_bytes_pending; /**< bytes rx-ed as segs but not yet freed */
156 svm_fifo_t *ct_rx_fifo;
157 svm_fifo_t *ct_tx_fifo;
158 vcl_session_msg_t *accept_evts_fifo;
162 u32 listener_index; /**< index of parent listener (if any) */
163 int n_accepted_sessions; /**< sessions accepted by this listener */
165 u32 attributes; /**< see @ref vppcom_session_attr_t */
169 u32 sndbuf_size; // VPP-TBD: Hack until support setsockopt(SO_SNDBUF)
170 u32 rcvbuf_size; // VPP-TBD: Hack until support setsockopt(SO_RCVBUF)
172 transport_endpt_ext_cfg_t *ext_config;
178 elog_track_t elog_track;
182 typedef struct vppcom_cfg_t_
186 uword segment_baseva;
188 uword add_segment_size;
189 u32 preallocated_fifo_pairs;
192 u32 event_queue_size;
193 u8 app_proxy_transport_tcp;
194 u8 app_proxy_transport_udp;
198 u64 namespace_secret;
202 char *event_log_path;
203 u8 *vpp_app_socket_api; /**< app socket api socket file name */
204 u8 *vpp_bapi_socket_name; /**< bapi socket transport socket name */
210 void vppcom_cfg (vppcom_cfg_t * vcl_cfg);
212 typedef struct vcl_cut_through_registration_
215 svm_msg_q_t *peer_mq;
217 u32 epoll_evt_conn_index; /*< mq evt connection index part of
218 the mqs evtfd epoll (if used) */
219 } vcl_cut_through_registration_t;
221 typedef struct vcl_mq_evt_conn_
227 typedef struct vcl_worker_
229 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
232 vcl_session_t *sessions;
234 /** Worker/thread index in current process */
237 /** Worker index in vpp*/
241 * Generic api client handle. When binary api is in used, it stores
242 * the "client_index" and when socket api is use, it stores the sapi
244 u32 api_client_handle;
246 /** VPP binary api input queue */
247 svm_queue_t *vl_input_queue;
249 /** VPP mq to be used for exchanging control messages */
250 svm_msg_q_t *ctrl_mq;
252 /** Message queues epoll fd. Initialized only if using mqs with eventfds */
255 /** Pool of event message queue event connections */
256 vcl_mq_evt_conn_t *mq_evt_conns;
258 /** Per worker buffer for receiving mq epoll events */
259 struct epoll_event *mq_events;
261 /** Next session to be lt polled */
264 /** Hash table for disconnect processing */
265 uword *session_index_by_vpp_handles;
267 /** Select bitmaps */
268 clib_bitmap_t *rd_bitmap;
269 clib_bitmap_t *wr_bitmap;
270 clib_bitmap_t *ex_bitmap;
272 /** Our event message queue */
273 svm_msg_q_t *app_event_queue;
275 /** For deadman timers */
276 clib_time_t clib_time;
278 /** Vector acting as buffer for mq messages */
279 svm_msg_q_msg_t *mq_msg_vector;
281 /** Vector of unhandled events */
282 session_event_t *unhandled_evts_vector;
284 u32 *pending_session_wrk_updates;
286 /** Used also as a thread stop key buffer */
289 /** Current pid, may be different from main_pid if forked child */
294 clib_socket_t app_api_sock;
295 socket_client_main_t bapi_sock_ctx;
296 api_main_t bapi_api_ctx;
297 memory_client_main_t bapi_mem_ctx;
299 /* State of the connection, shared between msg RX thread and main thread */
300 volatile vcl_bapi_app_state_t bapi_app_state;
301 volatile uword bapi_return;
304 int session_attr_op_rv;
305 transport_endpt_attr_t session_attr_rv;
307 /** vcl needs next epoll_create to go to libc_epoll */
308 u8 vcl_needs_real_epoll;
309 volatile int rpc_done;
312 STATIC_ASSERT (sizeof (session_disconnected_msg_t) <= 16,
313 "disconnected must fit in session_event_t");
314 STATIC_ASSERT (sizeof (session_reset_msg_t) <= 16,
315 "disconnected must fit in session_event_t");
317 typedef void (vcl_rpc_fn_t) (void *args);
319 typedef struct vppcom_main_t_
325 /** Main process pid */
328 /** App's index in vpp. It's used by vpp to identify the app */
333 /** VCL configuration */
336 volatile u32 forking;
339 vcl_worker_t *workers;
341 /** Lock to protect worker registrations */
342 clib_spinlock_t workers_lock;
344 /** Lock to protect segment hash table */
345 clib_rwlock_t segment_table_lock;
347 /** Mapped segments table */
348 uword *segment_table;
350 /** Control mq obtained from attach */
351 svm_msg_q_t *ctrl_mq;
353 fifo_segment_main_t segment_main;
355 vcl_rpc_fn_t *wrk_rpc_fn;
361 /* VNET_API_ERROR_FOO -> "Foo" hash table */
362 uword *error_string_by_error_number;
365 /* VPP Event-logger */
366 elog_main_t elog_main;
367 elog_track_t elog_track;
372 extern vppcom_main_t *vcm;
373 extern vppcom_main_t _vppcom_main;
375 #define VCL_INVALID_SESSION_INDEX ((u32)~0)
376 #define VCL_INVALID_SESSION_HANDLE ((u64)~0)
377 #define VCL_INVALID_SEGMENT_INDEX ((u32)~0)
378 #define VCL_INVALID_SEGMENT_HANDLE ((u64)~0)
380 void vcl_session_detach_fifos (vcl_session_t *s);
382 static inline vcl_session_t *
383 vcl_session_alloc (vcl_worker_t * wrk)
386 pool_get (wrk->sessions, s);
387 memset (s, 0, sizeof (*s));
388 s->session_index = s - wrk->sessions;
389 s->listener_index = VCL_INVALID_SESSION_INDEX;
394 vcl_session_free (vcl_worker_t * wrk, vcl_session_t * s)
396 /* Debug level set to 1 to avoid debug messages while ldp is cleaning up */
397 VDBG (1, "session %u [0x%llx] removed", s->session_index, s->vpp_handle);
398 vcl_session_detach_fifos (s);
400 clib_mem_free (s->ext_config);
401 pool_put (wrk->sessions, s);
404 static inline vcl_session_t *
405 vcl_session_get (vcl_worker_t * wrk, u32 session_index)
407 if (pool_is_free_index (wrk->sessions, session_index))
409 return pool_elt_at_index (wrk->sessions, session_index);
412 static inline vcl_session_handle_t
413 vcl_session_handle_from_wrk_session_index (u32 session_index, u32 wrk_index)
415 ASSERT (session_index < 2 << 24);
416 return (wrk_index << 24 | session_index);
419 static inline vcl_session_handle_t
420 vcl_session_handle_from_index (u32 session_index)
422 ASSERT (session_index < 2 << 24);
423 return (vcl_get_worker_index () << 24 | session_index);
426 static inline vcl_session_handle_t
427 vcl_session_handle (vcl_session_t * s)
429 return vcl_session_handle_from_index (s->session_index);
433 vcl_session_handle_parse (u32 handle, u32 * wrk_index, u32 * session_index)
435 *wrk_index = handle >> 24;
436 *session_index = handle & 0xFFFFFF;
439 static inline vcl_session_t *
440 vcl_session_get_w_handle (vcl_worker_t * wrk, u32 session_handle)
442 u32 session_index, wrk_index;
443 vcl_session_handle_parse (session_handle, &wrk_index, &session_index);
444 ASSERT (wrk_index == wrk->wrk_index);
445 return vcl_session_get (wrk, session_index);
448 static inline vcl_session_t *
449 vcl_session_get_w_vpp_handle (vcl_worker_t * wrk, u64 vpp_handle)
452 if ((p = hash_get (wrk->session_index_by_vpp_handles, vpp_handle)))
453 return vcl_session_get (wrk, (u32) p[0]);
458 vcl_session_index_from_vpp_handle (vcl_worker_t * wrk, u64 vpp_handle)
461 if ((p = hash_get (wrk->session_index_by_vpp_handles, vpp_handle)))
463 return VCL_INVALID_SESSION_INDEX;
467 vcl_session_table_add_vpp_handle (vcl_worker_t * wrk, u64 handle, u32 value)
469 hash_set (wrk->session_index_by_vpp_handles, handle, value);
473 vcl_session_table_del_vpp_handle (vcl_worker_t * wrk, u64 vpp_handle)
475 hash_unset (wrk->session_index_by_vpp_handles, vpp_handle);
478 static inline uword *
479 vcl_session_table_lookup_vpp_handle (vcl_worker_t * wrk, u64 handle)
481 return hash_get (wrk->session_index_by_vpp_handles, handle);
485 vcl_session_table_add_listener (vcl_worker_t * wrk, u64 listener_handle,
488 hash_set (wrk->session_index_by_vpp_handles, listener_handle, value);
492 vcl_session_table_del_listener (vcl_worker_t * wrk, u64 listener_handle)
494 hash_unset (wrk->session_index_by_vpp_handles, listener_handle);
498 vcl_session_is_connectable_listener (vcl_worker_t * wrk,
499 vcl_session_t * session)
501 /* Tell if we session_handle is a QUIC session.
502 * We can be in the following cases :
503 * Listen session <- QUIC session <- Stream session
504 * QUIC session <- Stream session
507 if (session->session_type != VPPCOM_PROTO_QUIC)
509 if (session->listener_index == VCL_INVALID_SESSION_INDEX)
510 return !(session->session_state == VCL_STATE_LISTEN);
511 ls = vcl_session_get_w_handle (wrk, session->listener_index);
513 return VPPCOM_EBADFD;
514 return ls->session_state == VCL_STATE_LISTEN;
517 static inline vcl_session_t *
518 vcl_session_table_lookup_listener (vcl_worker_t * wrk, u64 handle)
523 p = hash_get (wrk->session_index_by_vpp_handles, handle);
526 VDBG (0, "could not find listen session: unknown vpp listener handle"
530 s = vcl_session_get (wrk, p[0]);
533 VDBG (1, "invalid listen session index (%u)", p[0]);
537 if (s->session_state == VCL_STATE_DISCONNECT)
539 VDBG (0, "listen session [0x%llx] is closing", s->vpp_handle);
543 ASSERT (s->session_state == VCL_STATE_LISTEN
544 || s->session_state == VCL_STATE_LISTEN_NO_MQ
545 || vcl_session_is_connectable_listener (wrk, s));
550 vcl_session_is_ct (vcl_session_t * s)
552 return (s->ct_tx_fifo != 0);
556 vcl_session_is_cl (vcl_session_t * s)
558 if (s->session_type == VPPCOM_PROTO_UDP)
559 return !(s->flags & VCL_SESSION_F_CONNECTED);
564 vcl_session_has_crypto (vcl_session_t *s)
566 return (s->session_type == VPPCOM_PROTO_TLS ||
567 s->session_type == VPPCOM_PROTO_QUIC ||
568 s->session_type == VPPCOM_PROTO_DTLS);
572 vcl_session_is_ready (vcl_session_t * s)
574 return (s->session_state == VCL_STATE_READY
575 || s->session_state == VCL_STATE_VPP_CLOSING);
579 vcl_session_is_open (vcl_session_t * s)
581 return ((vcl_session_is_ready (s))
582 || (s->session_state == VCL_STATE_LISTEN && vcl_session_is_cl (s)));
586 vcl_session_is_closing (vcl_session_t * s)
588 return (s->session_state == VCL_STATE_VPP_CLOSING
589 || s->session_state == VCL_STATE_DISCONNECT);
593 vcl_session_is_closed (vcl_session_t * s)
595 return (!s || (s->session_state == VCL_STATE_CLOSED));
599 vcl_session_closing_error (vcl_session_t * s)
601 /* Return 0 on closing sockets */
602 return s->session_state == VCL_STATE_DISCONNECT ? VPPCOM_ECONNRESET : 0;
606 vcl_session_closed_error (vcl_session_t * s)
608 return s->session_state == VCL_STATE_DISCONNECT
609 ? VPPCOM_ECONNRESET : VPPCOM_ENOTCONN;
613 vcl_ip_copy_from_ep (ip46_address_t * ip, vppcom_endpt_t * ep)
616 clib_memcpy_fast (&ip->ip4, ep->ip, sizeof (ip4_address_t));
618 clib_memcpy_fast (&ip->ip6, ep->ip, sizeof (ip6_address_t));
622 vcl_ip_copy_to_ep (ip46_address_t * ip, vppcom_endpt_t * ep, u8 is_ip4)
626 clib_memcpy_fast (ep->ip, &ip->ip4, sizeof (ip4_address_t));
628 clib_memcpy_fast (ep->ip, &ip->ip6, sizeof (ip6_address_t));
632 vcl_proto_is_dgram (uint8_t proto)
634 return proto == VPPCOM_PROTO_UDP || proto == VPPCOM_PROTO_DTLS ||
635 proto == VPPCOM_PROTO_SRTP;
639 vcl_session_has_attr (vcl_session_t * s, u8 attr)
641 return (s->attributes & (1 << attr)) ? 1 : 0;
645 vcl_session_set_attr (vcl_session_t * s, u8 attr)
647 s->attributes |= 1 << attr;
651 vcl_session_clear_attr (vcl_session_t * s, u8 attr)
653 s->attributes &= ~(1 << attr);
659 vcl_mq_evt_conn_t *vcl_mq_evt_conn_alloc (vcl_worker_t * wrk);
660 u32 vcl_mq_evt_conn_index (vcl_worker_t * wrk, vcl_mq_evt_conn_t * mqc);
661 vcl_mq_evt_conn_t *vcl_mq_evt_conn_get (vcl_worker_t * wrk, u32 mq_conn_idx);
662 int vcl_mq_epoll_add_evfd (vcl_worker_t * wrk, svm_msg_q_t * mq);
663 int vcl_mq_epoll_del_evfd (vcl_worker_t * wrk, u32 mqc_index);
665 vcl_worker_t *vcl_worker_alloc_and_init (void);
666 void vcl_worker_cleanup (vcl_worker_t * wrk, u8 notify_vpp);
667 int vcl_worker_register_with_vpp (void);
668 svm_msg_q_t *vcl_worker_ctrl_mq (vcl_worker_t * wrk);
670 void vcl_flush_mq_events (void);
671 int vcl_session_cleanup (vcl_worker_t * wrk, vcl_session_t * session,
672 vcl_session_handle_t sh, u8 do_disconnect);
674 void vcl_segment_table_add (u64 segment_handle, u32 svm_segment_index);
675 u32 vcl_segment_table_lookup (u64 segment_handle);
676 void vcl_segment_table_del (u64 segment_handle);
678 int vcl_session_read_ready (vcl_session_t * session);
679 int vcl_session_write_ready (vcl_session_t * session);
680 int vcl_session_alloc_ext_cfg (vcl_session_t *s,
681 transport_endpt_ext_cfg_type_t type, u32 len);
683 static inline vcl_worker_t *
684 vcl_worker_get (u32 wrk_index)
686 return pool_elt_at_index (vcm->workers, wrk_index);
689 static inline vcl_worker_t *
690 vcl_worker_get_if_valid (u32 wrk_index)
692 if (pool_is_free_index (vcm->workers, wrk_index))
694 return pool_elt_at_index (vcm->workers, wrk_index);
697 static inline vcl_worker_t *
698 vcl_worker_get_current (void)
700 return vcl_worker_get (vcl_get_worker_index ());
706 return pool_elts (vcm->workers);
710 vcl_vpp_worker_segment_handle (u32 wrk_index)
712 return (VCL_INVALID_SEGMENT_HANDLE - wrk_index - 1);
715 void vcl_send_session_worker_update (vcl_worker_t * wrk, vcl_session_t * s,
717 int vcl_send_worker_rpc (u32 dst_wrk_index, void *data, u32 data_len);
719 int vcl_segment_attach (u64 segment_handle, char *name,
720 ssvm_segment_type_t type, int fd);
721 void vcl_segment_detach (u64 segment_handle);
722 void vcl_segment_detach_segments (u32 *seg_indices);
723 void vcl_send_session_unlisten (vcl_worker_t * wrk, vcl_session_t * s);
725 int vcl_segment_attach_session (uword segment_handle, uword rxf_offset,
726 uword txf_offset, uword mq_offset,
727 u32 mq_index, u8 is_ct, vcl_session_t *s);
728 int vcl_segment_attach_mq (uword segment_handle, uword mq_offset, u32 mq_index,
730 int vcl_segment_discover_mqs (uword segment_handle, int *fds, u32 n_fds);
731 svm_fifo_chunk_t *vcl_segment_alloc_chunk (uword segment_handle,
732 u32 slice_index, u32 size,
734 int vcl_session_share_fifos (vcl_session_t *s, svm_fifo_t *rxf,
736 void vcl_worker_detach_sessions (vcl_worker_t *wrk);
741 int vcl_bapi_attach (void);
742 int vcl_bapi_app_worker_add (void);
743 void vcl_bapi_app_worker_del (vcl_worker_t * wrk);
744 void vcl_bapi_disconnect_from_vpp (void);
745 int vcl_bapi_recv_fds (vcl_worker_t * wrk, int *fds, int n_fds);
746 int vcl_bapi_add_cert_key_pair (vppcom_cert_key_pair_t *ckpair);
747 int vcl_bapi_del_cert_key_pair (u32 ckpair_index);
748 u32 vcl_bapi_max_nsid_len (void);
749 int vcl_bapi_worker_set (void);
754 int vcl_sapi_attach (void);
755 int vcl_sapi_app_worker_add (void);
756 void vcl_sapi_app_worker_del (vcl_worker_t * wrk);
757 void vcl_sapi_detach (vcl_worker_t * wrk);
758 int vcl_sapi_recv_fds (vcl_worker_t * wrk, int *fds, int n_fds);
759 int vcl_sapi_add_cert_key_pair (vppcom_cert_key_pair_t *ckpair);
760 int vcl_sapi_del_cert_key_pair (u32 ckpair_index);
765 const char *vcl_session_state_str (vcl_session_state_t state);
766 u8 *vcl_format_ip4_address (u8 *s, va_list *args);
767 u8 *vcl_format_ip6_address (u8 *s, va_list *args);
768 u8 *vcl_format_ip46_address (u8 *s, va_list *args);
770 #endif /* SRC_VCL_VCL_PRIVATE_H_ */
773 * fd.io coding-style-patch-verification: ON
776 * eval: (c-set-style "gnu")