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;
157 u32 vpp_thread_index;
158 u32 listener_index; /**< index of parent listener (if any) */
159 int n_accepted_sessions; /**< sessions accepted by this listener */
160 u32 attributes; /**< see @ref vppcom_session_attr_t */
165 u32 sndbuf_size; // VPP-TBD: Hack until support setsockopt(SO_SNDBUF)
166 u32 rcvbuf_size; // VPP-TBD: Hack until support setsockopt(SO_RCVBUF)
167 u32 user_mss; // VPP-TBD: Hack until support setsockopt(TCP_MAXSEG)
170 elog_track_t elog_track;
174 typedef struct vppcom_cfg_t_
178 u32 vpp_api_q_length;
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_filename; /**< bapi shm transport file name */
201 u8 *vpp_bapi_socket_name; /**< bapi socket transport socket name */
207 void vppcom_cfg (vppcom_cfg_t * vcl_cfg);
209 typedef struct vcl_cut_through_registration_
212 svm_msg_q_t *peer_mq;
214 u32 epoll_evt_conn_index; /*< mq evt connection index part of
215 the mqs evtfd epoll (if used) */
216 } vcl_cut_through_registration_t;
218 typedef struct vcl_mq_evt_conn_
224 typedef struct vcl_worker_
226 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
229 vcl_session_t *sessions;
231 /** Worker/thread index in current process */
234 /** Worker index in vpp*/
238 * Generic api client handle. When binary api is in used, it stores
239 * the "client_index" and when socket api is use, it stores the sapi
241 u32 api_client_handle;
243 /** VPP binary api input queue */
244 svm_queue_t *vl_input_queue;
246 /** VPP mq to be used for exchanging control messages */
247 svm_msg_q_t *ctrl_mq;
249 /** Message queues epoll fd. Initialized only if using mqs with eventfds */
252 /** Pool of event message queue event connections */
253 vcl_mq_evt_conn_t *mq_evt_conns;
255 /** Per worker buffer for receiving mq epoll events */
256 struct epoll_event *mq_events;
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 /** VPP workers event message queues */
270 svm_msg_q_t **vpp_event_queues;
272 /** For deadman timers */
273 clib_time_t clib_time;
275 /** Vector acting as buffer for mq messages */
276 svm_msg_q_msg_t *mq_msg_vector;
278 /** Vector of unhandled events */
279 session_event_t *unhandled_evts_vector;
281 u32 *pending_session_wrk_updates;
283 /** Used also as a thread stop key buffer */
286 /** Current pid, may be different from main_pid if forked child */
291 clib_socket_t app_api_sock;
292 socket_client_main_t bapi_sock_ctx;
293 memory_client_main_t bapi_shm_ctx;
294 api_main_t bapi_api_ctx;
296 /** vcl needs next epoll_create to go to libc_epoll */
297 u8 vcl_needs_real_epoll;
298 volatile int rpc_done;
301 typedef void (vcl_rpc_fn_t) (void *args);
303 typedef struct vppcom_main_t_
309 /** Main process pid */
312 /** App's index in vpp. It's used by vpp to identify the app */
317 /** VCL configuration */
320 volatile u32 forking;
323 vcl_worker_t *workers;
325 /** Lock to protect worker registrations */
326 clib_spinlock_t workers_lock;
328 /** Lock to protect segment hash table */
329 clib_rwlock_t segment_table_lock;
331 /** Mapped segments table */
332 uword *segment_table;
334 /** Control mq obtained from attach */
335 svm_msg_q_t *ctrl_mq;
337 fifo_segment_main_t segment_main;
339 vcl_rpc_fn_t *wrk_rpc_fn;
345 /* State of the connection, shared between msg RX thread and main thread */
346 volatile vcl_bapi_app_state_t bapi_app_state;
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 static inline vcl_session_t *
368 vcl_session_alloc (vcl_worker_t * wrk)
371 pool_get (wrk->sessions, s);
372 memset (s, 0, sizeof (*s));
373 s->session_index = s - wrk->sessions;
374 s->listener_index = VCL_INVALID_SESSION_INDEX;
379 vcl_session_free (vcl_worker_t * wrk, vcl_session_t * s)
381 /* Debug level set to 1 to avoid debug messages while ldp is cleaning up */
382 VDBG (1, "session %u [0x%llx] removed", s->session_index, s->vpp_handle);
383 pool_put (wrk->sessions, s);
386 static inline vcl_session_t *
387 vcl_session_get (vcl_worker_t * wrk, u32 session_index)
389 if (pool_is_free_index (wrk->sessions, session_index))
391 return pool_elt_at_index (wrk->sessions, session_index);
394 static inline vcl_session_handle_t
395 vcl_session_handle_from_wrk_session_index (u32 session_index, u32 wrk_index)
397 ASSERT (session_index < 2 << 24);
398 return (wrk_index << 24 | session_index);
401 static inline vcl_session_handle_t
402 vcl_session_handle_from_index (u32 session_index)
404 ASSERT (session_index < 2 << 24);
405 return (vcl_get_worker_index () << 24 | session_index);
408 static inline vcl_session_handle_t
409 vcl_session_handle (vcl_session_t * s)
411 return vcl_session_handle_from_index (s->session_index);
415 vcl_session_handle_parse (u32 handle, u32 * wrk_index, u32 * session_index)
417 *wrk_index = handle >> 24;
418 *session_index = handle & 0xFFFFFF;
421 static inline vcl_session_t *
422 vcl_session_get_w_handle (vcl_worker_t * wrk, u32 session_handle)
424 u32 session_index, wrk_index;
425 vcl_session_handle_parse (session_handle, &wrk_index, &session_index);
426 ASSERT (wrk_index == wrk->wrk_index);
427 return vcl_session_get (wrk, session_index);
430 static inline vcl_session_t *
431 vcl_session_get_w_vpp_handle (vcl_worker_t * wrk, u64 vpp_handle)
434 if ((p = hash_get (wrk->session_index_by_vpp_handles, vpp_handle)))
435 return vcl_session_get (wrk, (u32) p[0]);
440 vcl_session_index_from_vpp_handle (vcl_worker_t * wrk, u64 vpp_handle)
443 if ((p = hash_get (wrk->session_index_by_vpp_handles, vpp_handle)))
445 return VCL_INVALID_SESSION_INDEX;
449 vcl_session_table_add_vpp_handle (vcl_worker_t * wrk, u64 handle, u32 value)
451 hash_set (wrk->session_index_by_vpp_handles, handle, value);
455 vcl_session_table_del_vpp_handle (vcl_worker_t * wrk, u64 vpp_handle)
457 hash_unset (wrk->session_index_by_vpp_handles, vpp_handle);
460 static inline uword *
461 vcl_session_table_lookup_vpp_handle (vcl_worker_t * wrk, u64 handle)
463 return hash_get (wrk->session_index_by_vpp_handles, handle);
467 vcl_session_table_add_listener (vcl_worker_t * wrk, u64 listener_handle,
470 hash_set (wrk->session_index_by_vpp_handles, listener_handle, value);
474 vcl_session_table_del_listener (vcl_worker_t * wrk, u64 listener_handle)
476 hash_unset (wrk->session_index_by_vpp_handles, listener_handle);
480 vcl_session_is_connectable_listener (vcl_worker_t * wrk,
481 vcl_session_t * session)
483 /* Tell if we session_handle is a QUIC session.
484 * We can be in the following cases :
485 * Listen session <- QUIC session <- Stream session
486 * QUIC session <- Stream session
489 if (session->session_type != VPPCOM_PROTO_QUIC)
491 if (session->listener_index == VCL_INVALID_SESSION_INDEX)
492 return !(session->session_state == VCL_STATE_LISTEN);
493 ls = vcl_session_get_w_handle (wrk, session->listener_index);
495 return VPPCOM_EBADFD;
496 return ls->session_state == VCL_STATE_LISTEN;
499 static inline vcl_session_t *
500 vcl_session_table_lookup_listener (vcl_worker_t * wrk, u64 handle)
505 p = hash_get (wrk->session_index_by_vpp_handles, handle);
508 VDBG (0, "could not find listen session: unknown vpp listener handle"
512 s = vcl_session_get (wrk, p[0]);
515 VDBG (1, "invalid listen session index (%u)", p[0]);
519 ASSERT (s->session_state == VCL_STATE_LISTEN
520 || s->session_state == VCL_STATE_LISTEN_NO_MQ
521 || vcl_session_is_connectable_listener (wrk, s));
525 const char *vppcom_session_state_str (vcl_session_state_t state);
528 vcl_session_is_ct (vcl_session_t * s)
530 return (s->ct_tx_fifo != 0);
534 vcl_session_is_cl (vcl_session_t * s)
536 if (s->session_type == VPPCOM_PROTO_UDP)
537 return !(s->flags & VCL_SESSION_F_CONNECTED);
542 vcl_session_is_ready (vcl_session_t * s)
544 return (s->session_state == VCL_STATE_READY
545 || s->session_state == VCL_STATE_VPP_CLOSING);
549 vcl_session_is_open (vcl_session_t * s)
551 return ((vcl_session_is_ready (s))
552 || (s->session_state == VCL_STATE_LISTEN && vcl_session_is_cl (s)));
556 vcl_session_is_closing (vcl_session_t * s)
558 return (s->session_state == VCL_STATE_VPP_CLOSING
559 || s->session_state == VCL_STATE_DISCONNECT);
563 vcl_session_is_closed (vcl_session_t * s)
565 return (!s || (s->session_state == VCL_STATE_CLOSED));
569 vcl_session_closing_error (vcl_session_t * s)
571 /* Return 0 on closing sockets */
572 return s->session_state == VCL_STATE_DISCONNECT ? VPPCOM_ECONNRESET : 0;
576 vcl_session_closed_error (vcl_session_t * s)
578 return s->session_state == VCL_STATE_DISCONNECT
579 ? VPPCOM_ECONNRESET : VPPCOM_ENOTCONN;
583 vcl_ip_copy_from_ep (ip46_address_t * ip, vppcom_endpt_t * ep)
586 clib_memcpy_fast (&ip->ip4, ep->ip, sizeof (ip4_address_t));
588 clib_memcpy_fast (&ip->ip6, ep->ip, sizeof (ip6_address_t));
592 vcl_ip_copy_to_ep (ip46_address_t * ip, vppcom_endpt_t * ep, u8 is_ip4)
596 clib_memcpy_fast (ep->ip, &ip->ip4, sizeof (ip4_address_t));
598 clib_memcpy_fast (ep->ip, &ip->ip6, sizeof (ip6_address_t));
602 vcl_proto_is_dgram (uint8_t proto)
604 return proto == VPPCOM_PROTO_UDP;
608 vcl_session_has_attr (vcl_session_t * s, u8 attr)
610 return (s->attributes & (1 << attr)) ? 1 : 0;
614 vcl_session_set_attr (vcl_session_t * s, u8 attr)
616 s->attributes |= 1 << attr;
620 vcl_session_clear_attr (vcl_session_t * s, u8 attr)
622 s->attributes &= ~(1 << attr);
628 vcl_mq_evt_conn_t *vcl_mq_evt_conn_alloc (vcl_worker_t * wrk);
629 u32 vcl_mq_evt_conn_index (vcl_worker_t * wrk, vcl_mq_evt_conn_t * mqc);
630 vcl_mq_evt_conn_t *vcl_mq_evt_conn_get (vcl_worker_t * wrk, u32 mq_conn_idx);
631 int vcl_mq_epoll_add_evfd (vcl_worker_t * wrk, svm_msg_q_t * mq);
632 int vcl_mq_epoll_del_evfd (vcl_worker_t * wrk, u32 mqc_index);
634 vcl_worker_t *vcl_worker_alloc_and_init (void);
635 void vcl_worker_cleanup (vcl_worker_t * wrk, u8 notify_vpp);
636 int vcl_worker_register_with_vpp (void);
637 svm_msg_q_t *vcl_worker_ctrl_mq (vcl_worker_t * wrk);
639 void vcl_flush_mq_events (void);
640 int vcl_session_cleanup (vcl_worker_t * wrk, vcl_session_t * session,
641 vcl_session_handle_t sh, u8 do_disconnect);
643 void vcl_segment_table_add (u64 segment_handle, u32 svm_segment_index);
644 u32 vcl_segment_table_lookup (u64 segment_handle);
645 void vcl_segment_table_del (u64 segment_handle);
647 int vcl_session_read_ready (vcl_session_t * session);
648 int vcl_session_write_ready (vcl_session_t * session);
650 static inline vcl_worker_t *
651 vcl_worker_get (u32 wrk_index)
653 return pool_elt_at_index (vcm->workers, wrk_index);
656 static inline vcl_worker_t *
657 vcl_worker_get_if_valid (u32 wrk_index)
659 if (pool_is_free_index (vcm->workers, wrk_index))
661 return pool_elt_at_index (vcm->workers, wrk_index);
664 static inline vcl_worker_t *
665 vcl_worker_get_current (void)
667 return vcl_worker_get (vcl_get_worker_index ());
673 return pool_elts (vcm->workers);
676 static inline svm_msg_q_t *
677 vcl_session_vpp_evt_q (vcl_worker_t * wrk, vcl_session_t * s)
679 return wrk->vpp_event_queues[s->vpp_thread_index];
683 vcl_vpp_worker_segment_handle (u32 wrk_index)
685 return (VCL_INVALID_SEGMENT_HANDLE - wrk_index - 1);
688 void vcl_send_session_worker_update (vcl_worker_t * wrk, vcl_session_t * s,
690 int vcl_send_worker_rpc (u32 dst_wrk_index, void *data, u32 data_len);
692 int vcl_segment_attach (u64 segment_handle, char *name,
693 ssvm_segment_type_t type, int fd);
694 void vcl_segment_detach (u64 segment_handle);
695 void vcl_send_session_unlisten (vcl_worker_t * wrk, vcl_session_t * s);
700 int vcl_bapi_attach (void);
701 int vcl_bapi_app_worker_add (void);
702 void vcl_bapi_app_worker_del (vcl_worker_t * wrk);
703 void vcl_bapi_disconnect_from_vpp (void);
704 int vcl_bapi_recv_fds (vcl_worker_t * wrk, int *fds, int n_fds);
705 void vcl_bapi_send_application_tls_cert_add (vcl_session_t * session,
706 char *cert, u32 cert_len);
707 void vcl_bapi_send_application_tls_key_add (vcl_session_t * session,
708 char *key, u32 key_len);
709 u32 vcl_bapi_max_nsid_len (void);
710 int vcl_bapi_worker_set (void);
715 int vcl_sapi_attach (void);
716 int vcl_sapi_app_worker_add (void);
717 void vcl_sapi_app_worker_del (vcl_worker_t * wrk);
718 void vcl_sapi_detach (vcl_worker_t * wrk);
719 int vcl_sapi_recv_fds (vcl_worker_t * wrk, int *fds, int n_fds);
721 #endif /* SRC_VCL_VCL_PRIVATE_H_ */
724 * fd.io coding-style-patch-verification: ON
727 * eval: (c-set-style "gnu")