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;
71 STATE_VPP_CLOSING = 0x08,
72 STATE_DISCONNECT = 0x10,
73 STATE_DETACHED = 0x20,
75 STATE_LISTEN_NO_MQ = 0x80,
76 } vcl_session_state_t;
78 #define SERVER_STATE_OPEN (STATE_ACCEPT|STATE_VPP_CLOSING)
79 #define CLIENT_STATE_OPEN (STATE_CONNECT|STATE_VPP_CLOSING)
80 #define STATE_OPEN (SERVER_STATE_OPEN | CLIENT_STATE_OPEN)
82 typedef struct epoll_event vppcom_epoll_event_t;
89 vppcom_epoll_event_t ev;
90 #define VEP_DEFAULT_ET_MASK (EPOLLIN|EPOLLOUT)
91 #define VEP_UNSUPPORTED_EVENTS (EPOLLONESHOT|EPOLLEXCLUSIVE)
95 /* Select uses the vcl_si_set as if a clib_bitmap. Make sure they are the
97 STATIC_ASSERT (sizeof (clib_bitmap_t) == sizeof (vcl_si_set),
98 "vppcom bitmap size mismatch");
106 #define VCL_ACCEPTED_F_CLOSED (1 << 0)
107 #define VCL_ACCEPTED_F_RESET (1 << 1)
109 typedef struct vcl_session_msg
113 session_accepted_msg_t accepted_msg;
120 VCL_SESS_ATTR_SERVER,
121 VCL_SESS_ATTR_CUT_THRU,
123 VCL_SESS_ATTR_VEP_SESSION,
124 VCL_SESS_ATTR_LISTEN, // SOL_SOCKET,SO_ACCEPTCONN
125 VCL_SESS_ATTR_NONBLOCK, // fcntl,O_NONBLOCK
126 VCL_SESS_ATTR_REUSEADDR, // SOL_SOCKET,SO_REUSEADDR
127 VCL_SESS_ATTR_REUSEPORT, // SOL_SOCKET,SO_REUSEPORT
128 VCL_SESS_ATTR_BROADCAST, // SOL_SOCKET,SO_BROADCAST
129 VCL_SESS_ATTR_V6ONLY, // SOL_TCP,IPV6_V6ONLY
130 VCL_SESS_ATTR_KEEPALIVE, // SOL_SOCKET,SO_KEEPALIVE
131 VCL_SESS_ATTR_TCP_NODELAY, // SOL_TCP,TCP_NODELAY
132 VCL_SESS_ATTR_TCP_KEEPIDLE, // SOL_TCP,TCP_KEEPIDLE
133 VCL_SESS_ATTR_TCP_KEEPINTVL, // SOL_TCP,TCP_KEEPINTVL
134 VCL_SESS_ATTR_SHUT_RD,
135 VCL_SESS_ATTR_SHUT_WR,
137 } vppcom_session_attr_t;
139 #define VCL_SESS_ATTR_SET(ATTR, VAL) \
141 (ATTR) |= 1 << (VAL); \
144 #define VCL_SESS_ATTR_CLR(ATTR, VAL) \
146 (ATTR) &= ~(1 << (VAL)); \
149 #define VCL_SESS_ATTR_TEST(ATTR, VAL) \
150 ((ATTR) & (1 << (VAL)) ? 1 : 0)
152 typedef enum vcl_session_flags_
154 VCL_SESSION_F_CONNECTED = 1 << 0,
155 } __clib_packed vcl_session_flags_t;
159 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
160 #define _(type, name) type name;
161 foreach_app_session_field
163 u32 sndbuf_size; // VPP-TBD: Hack until support setsockopt(SO_SNDBUF)
164 u32 rcvbuf_size; // VPP-TBD: Hack until support setsockopt(SO_RCVBUF)
165 u32 user_mss; // VPP-TBD: Hack until support setsockopt(TCP_MAXSEG)
167 u32 vpp_thread_index;
169 svm_fifo_t *ct_rx_fifo;
170 svm_fifo_t *ct_tx_fifo;
172 /* Socket configuration state */
175 vcl_session_flags_t flags;
176 /* VCL session index of the listening session (if any) */
178 /* Accepted sessions on this listener */
179 int n_accepted_sessions;
185 svm_msg_q_t *our_evt_q;
186 vcl_session_msg_t *accept_evts_fifo;
188 elog_track_t elog_track;
192 typedef struct vppcom_cfg_t_
196 u32 vpp_api_q_length;
197 uword segment_baseva;
199 uword add_segment_size;
200 u32 preallocated_fifo_pairs;
203 u32 event_queue_size;
204 u32 listen_queue_size;
205 u8 app_proxy_transport_tcp;
206 u8 app_proxy_transport_udp;
210 u64 namespace_secret;
216 char *event_log_path;
217 u8 *vpp_app_socket_api; /**< app socket api socket file name */
218 u8 *vpp_bapi_filename; /**< bapi shm transport file name */
219 u8 *vpp_bapi_socket_name; /**< bapi socket transport socket name */
225 void vppcom_cfg (vppcom_cfg_t * vcl_cfg);
227 typedef struct vcl_cut_through_registration_
230 svm_msg_q_t *peer_mq;
232 u32 epoll_evt_conn_index; /*< mq evt connection index part of
233 the mqs evtfd epoll (if used) */
234 } vcl_cut_through_registration_t;
236 typedef struct vcl_mq_evt_conn_
242 typedef struct vcl_worker_
244 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
247 vcl_session_t *sessions;
249 /** Worker/thread index in current process */
252 /** Worker index in vpp*/
256 * Generic api client handle. When binary api is in used, it stores
257 * the "client_index" and when socket api is use, it stores the sapi
259 u32 api_client_handle;
261 /** VPP binary api input queue */
262 svm_queue_t *vl_input_queue;
264 /** VPP mq to be used for exchanging control messages */
265 svm_msg_q_t *ctrl_mq;
267 /** Message queues epoll fd. Initialized only if using mqs with eventfds */
270 /** Pool of event message queue event connections */
271 vcl_mq_evt_conn_t *mq_evt_conns;
273 /** Per worker buffer for receiving mq epoll events */
274 struct epoll_event *mq_events;
276 /** Hash table for disconnect processing */
277 uword *session_index_by_vpp_handles;
279 /** Select bitmaps */
280 clib_bitmap_t *rd_bitmap;
281 clib_bitmap_t *wr_bitmap;
282 clib_bitmap_t *ex_bitmap;
284 /** Our event message queue */
285 svm_msg_q_t *app_event_queue;
287 /** VPP workers event message queues */
288 svm_msg_q_t **vpp_event_queues;
290 /** For deadman timers */
291 clib_time_t clib_time;
293 /** Vector acting as buffer for mq messages */
294 svm_msg_q_msg_t *mq_msg_vector;
296 /** Vector of unhandled events */
297 session_event_t *unhandled_evts_vector;
299 u32 *pending_session_wrk_updates;
301 /** Used also as a thread stop key buffer */
304 /** Current pid, may be different from main_pid if forked child */
309 clib_socket_t app_api_sock;
310 socket_client_main_t bapi_sock_ctx;
311 memory_client_main_t bapi_shm_ctx;
312 api_main_t bapi_api_ctx;
314 /** vcl needs next epoll_create to go to libc_epoll */
315 u8 vcl_needs_real_epoll;
316 volatile int rpc_done;
319 typedef void (vcl_rpc_fn_t) (void *args);
321 typedef struct vppcom_main_t_
327 /** Main process pid */
330 /** App's index in vpp. It's used by vpp to identify the app */
335 /** VCL configuration */
338 volatile u32 forking;
341 vcl_worker_t *workers;
343 /** Lock to protect worker registrations */
344 clib_spinlock_t workers_lock;
346 /** Lock to protect segment hash table */
347 clib_rwlock_t segment_table_lock;
349 /** Mapped segments table */
350 uword *segment_table;
352 /** Control mq obtained from attach */
353 svm_msg_q_t *ctrl_mq;
355 fifo_segment_main_t segment_main;
357 vcl_rpc_fn_t *wrk_rpc_fn;
363 /* State of the connection, shared between msg RX thread and main thread */
364 volatile vcl_bapi_app_state_t bapi_app_state;
366 /* VNET_API_ERROR_FOO -> "Foo" hash table */
367 uword *error_string_by_error_number;
370 /* VPP Event-logger */
371 elog_main_t elog_main;
372 elog_track_t elog_track;
377 extern vppcom_main_t *vcm;
378 extern vppcom_main_t _vppcom_main;
380 #define VCL_INVALID_SESSION_INDEX ((u32)~0)
381 #define VCL_INVALID_SESSION_HANDLE ((u64)~0)
382 #define VCL_INVALID_SEGMENT_INDEX ((u32)~0)
383 #define VCL_INVALID_SEGMENT_HANDLE ((u64)~0)
385 static inline vcl_session_t *
386 vcl_session_alloc (vcl_worker_t * wrk)
389 pool_get (wrk->sessions, s);
390 memset (s, 0, sizeof (*s));
391 s->session_index = s - wrk->sessions;
392 s->listener_index = VCL_INVALID_SESSION_INDEX;
397 vcl_session_free (vcl_worker_t * wrk, vcl_session_t * s)
399 /* Debug level set to 1 to avoid debug messages while ldp is cleaning up */
400 VDBG (1, "session %u [0x%llx] removed", s->session_index, s->vpp_handle);
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 & STATE_LISTEN);
511 ls = vcl_session_get_w_handle (wrk, session->listener_index);
513 return VPPCOM_EBADFD;
514 return ls->session_state & STATE_LISTEN;
517 static inline vcl_session_t *
518 vcl_session_table_lookup_listener (vcl_worker_t * wrk, u64 handle)
521 vcl_session_t *session;
523 p = hash_get (wrk->session_index_by_vpp_handles, handle);
526 VDBG (0, "could not find listen session: unknown vpp listener handle"
530 session = vcl_session_get (wrk, p[0]);
533 VDBG (1, "invalid listen session index (%u)", p[0]);
537 ASSERT ((session->session_state & (STATE_LISTEN | STATE_LISTEN_NO_MQ)) ||
538 vcl_session_is_connectable_listener (wrk, session));
542 const char *vppcom_session_state_str (vcl_session_state_t state);
545 vcl_session_is_ct (vcl_session_t * s)
547 return (s->ct_tx_fifo != 0);
551 vcl_session_is_cl (vcl_session_t * s)
553 if (s->session_type == VPPCOM_PROTO_UDP)
554 return !(s->flags & VCL_SESSION_F_CONNECTED);
559 vcl_session_is_open (vcl_session_t * s)
561 return ((s->session_state & STATE_OPEN)
562 || (s->session_state == STATE_LISTEN
563 && s->session_type == VPPCOM_PROTO_UDP));
567 vcl_session_is_closing (vcl_session_t * s)
569 return (s->session_state == STATE_VPP_CLOSING
570 || s->session_state == STATE_DISCONNECT);
574 vcl_session_is_closed (vcl_session_t * s)
576 return (!s || (s->session_state == STATE_CLOSED));
580 vcl_session_closing_error (vcl_session_t * s)
582 /* Return 0 on closing sockets */
583 return s->session_state == STATE_DISCONNECT ? VPPCOM_ECONNRESET : 0;
587 vcl_session_closed_error (vcl_session_t * s)
589 return s->session_state == 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;
621 vcl_mq_evt_conn_t *vcl_mq_evt_conn_alloc (vcl_worker_t * wrk);
622 u32 vcl_mq_evt_conn_index (vcl_worker_t * wrk, vcl_mq_evt_conn_t * mqc);
623 vcl_mq_evt_conn_t *vcl_mq_evt_conn_get (vcl_worker_t * wrk, u32 mq_conn_idx);
624 int vcl_mq_epoll_add_evfd (vcl_worker_t * wrk, svm_msg_q_t * mq);
625 int vcl_mq_epoll_del_evfd (vcl_worker_t * wrk, u32 mqc_index);
627 vcl_worker_t *vcl_worker_alloc_and_init (void);
628 void vcl_worker_cleanup (vcl_worker_t * wrk, u8 notify_vpp);
629 int vcl_worker_register_with_vpp (void);
630 svm_msg_q_t *vcl_worker_ctrl_mq (vcl_worker_t * wrk);
632 void vcl_flush_mq_events (void);
633 int vcl_session_cleanup (vcl_worker_t * wrk, vcl_session_t * session,
634 vcl_session_handle_t sh, u8 do_disconnect);
636 void vcl_segment_table_add (u64 segment_handle, u32 svm_segment_index);
637 u32 vcl_segment_table_lookup (u64 segment_handle);
638 void vcl_segment_table_del (u64 segment_handle);
640 int vcl_session_read_ready (vcl_session_t * session);
641 int vcl_session_write_ready (vcl_session_t * session);
643 static inline vcl_worker_t *
644 vcl_worker_get (u32 wrk_index)
646 return pool_elt_at_index (vcm->workers, wrk_index);
649 static inline vcl_worker_t *
650 vcl_worker_get_if_valid (u32 wrk_index)
652 if (pool_is_free_index (vcm->workers, wrk_index))
654 return pool_elt_at_index (vcm->workers, wrk_index);
657 static inline vcl_worker_t *
658 vcl_worker_get_current (void)
660 return vcl_worker_get (vcl_get_worker_index ());
666 return pool_elts (vcm->workers);
669 static inline svm_msg_q_t *
670 vcl_session_vpp_evt_q (vcl_worker_t * wrk, vcl_session_t * s)
672 return wrk->vpp_event_queues[s->vpp_thread_index];
676 vcl_vpp_worker_segment_handle (u32 wrk_index)
678 return (VCL_INVALID_SEGMENT_HANDLE - wrk_index - 1);
681 void vcl_send_session_worker_update (vcl_worker_t * wrk, vcl_session_t * s,
683 int vcl_send_worker_rpc (u32 dst_wrk_index, void *data, u32 data_len);
685 int vcl_segment_attach (u64 segment_handle, char *name,
686 ssvm_segment_type_t type, int fd);
687 void vcl_segment_detach (u64 segment_handle);
688 void vcl_send_session_unlisten (vcl_worker_t * wrk, vcl_session_t * s);
693 int vcl_bapi_attach (void);
694 int vcl_bapi_app_worker_add (void);
695 void vcl_bapi_app_worker_del (vcl_worker_t * wrk);
696 void vcl_bapi_disconnect_from_vpp (void);
697 int vcl_bapi_recv_fds (vcl_worker_t * wrk, int *fds, int n_fds);
698 void vcl_bapi_send_application_tls_cert_add (vcl_session_t * session,
699 char *cert, u32 cert_len);
700 void vcl_bapi_send_application_tls_key_add (vcl_session_t * session,
701 char *key, u32 key_len);
702 u32 vcl_bapi_max_nsid_len (void);
703 int vcl_bapi_worker_set (void);
708 int vcl_sapi_attach (void);
709 int vcl_sapi_app_worker_add (void);
710 void vcl_sapi_app_worker_del (vcl_worker_t * wrk);
711 void vcl_sapi_detach (vcl_worker_t * wrk);
712 int vcl_sapi_recv_fds (vcl_worker_t * wrk, int *fds, int n_fds);
714 #endif /* SRC_VCL_VCL_PRIVATE_H_ */
717 * fd.io coding-style-patch-verification: ON
720 * eval: (c-set-style "gnu")