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,
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)
154 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
155 #define _(type, name) type name;
156 foreach_app_session_field
158 u32 sndbuf_size; // VPP-TBD: Hack until support setsockopt(SO_SNDBUF)
159 u32 rcvbuf_size; // VPP-TBD: Hack until support setsockopt(SO_RCVBUF)
160 u32 user_mss; // VPP-TBD: Hack until support setsockopt(TCP_MAXSEG)
162 u32 vpp_thread_index;
164 svm_fifo_t *ct_rx_fifo;
165 svm_fifo_t *ct_tx_fifo;
167 /* Socket configuration state */
170 /* VCL session index of the listening session (if any) */
172 /* Accepted sessions on this listener */
173 int n_accepted_sessions;
179 svm_msg_q_t *our_evt_q;
180 vcl_session_msg_t *accept_evts_fifo;
182 elog_track_t elog_track;
186 typedef struct vppcom_cfg_t_
190 u32 vpp_api_q_length;
191 uword segment_baseva;
193 u32 add_segment_size;
194 u32 preallocated_fifo_pairs;
197 u32 event_queue_size;
198 u32 listen_queue_size;
199 u8 app_proxy_transport_tcp;
200 u8 app_proxy_transport_udp;
204 u64 namespace_secret;
210 char *event_log_path;
211 u8 *vpp_api_filename;
212 u8 *vpp_api_socket_name;
217 void vppcom_cfg (vppcom_cfg_t * vcl_cfg);
219 typedef struct vcl_cut_through_registration_
222 svm_msg_q_t *peer_mq;
224 u32 epoll_evt_conn_index; /*< mq evt connection index part of
225 the mqs evtfd epoll (if used) */
226 } vcl_cut_through_registration_t;
228 typedef struct vcl_mq_evt_conn_
234 typedef struct vcl_worker_
236 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
239 vcl_session_t *sessions;
241 /** Worker/thread index in current process */
244 /** Worker index in vpp*/
247 /** API client handle */
250 /** State of the connection, shared between msg RX thread and main thread */
251 volatile app_state_t wrk_state;
253 /** VPP binary api input queue */
254 svm_queue_t *vl_input_queue;
256 /** VPP mq to be used for exchanging control messages */
257 svm_msg_q_t *ctrl_mq;
259 /** Message queues epoll fd. Initialized only if using mqs with eventfds */
262 /** Pool of event message queue event connections */
263 vcl_mq_evt_conn_t *mq_evt_conns;
265 /** Per worker buffer for receiving mq epoll events */
266 struct epoll_event *mq_events;
268 /** Hash table for disconnect processing */
269 uword *session_index_by_vpp_handles;
271 /** Select bitmaps */
272 clib_bitmap_t *rd_bitmap;
273 clib_bitmap_t *wr_bitmap;
274 clib_bitmap_t *ex_bitmap;
276 /** Our event message queue */
277 svm_msg_q_t *app_event_queue;
279 /** VPP workers event message queues */
280 svm_msg_q_t **vpp_event_queues;
282 /** For deadman timers */
283 clib_time_t clib_time;
285 /** Vector acting as buffer for mq messages */
286 svm_msg_q_msg_t *mq_msg_vector;
288 /** Vector of unhandled events */
289 session_event_t *unhandled_evts_vector;
291 u32 *pending_session_wrk_updates;
293 /** Used also as a thread stop key buffer */
296 /** Current pid, may be different from main_pid if forked child */
301 socket_client_main_t bapi_sock_ctx;
302 memory_client_main_t bapi_shm_ctx;
303 api_main_t bapi_api_ctx;
306 typedef struct vppcom_main_t_
312 /** Main process pid */
315 /** App's index in vpp. It's used by vpp to identify the app */
318 /** State of the connection, shared between msg RX thread and main thread */
319 volatile app_state_t app_state;
323 /** VCL configuration */
326 volatile u32 forking;
329 vcl_worker_t *workers;
331 /** Lock to protect worker registrations */
332 clib_spinlock_t workers_lock;
334 /** Lock to protect segment hash table */
335 clib_rwlock_t segment_table_lock;
337 /** Mapped segments table */
338 uword *segment_table;
340 /** Control mq obtained from attach */
341 svm_msg_q_t *ctrl_mq;
343 fifo_segment_main_t segment_main;
346 /* VPP Event-logger */
347 elog_main_t elog_main;
348 elog_track_t elog_track;
351 /* VNET_API_ERROR_FOO -> "Foo" hash table */
352 uword *error_string_by_error_number;
356 extern vppcom_main_t *vcm;
358 #define VCL_INVALID_SESSION_INDEX ((u32)~0)
359 #define VCL_INVALID_SESSION_HANDLE ((u64)~0)
360 #define VCL_INVALID_SEGMENT_INDEX ((u32)~0)
361 #define VCL_INVALID_SEGMENT_HANDLE ((u64)~0)
363 static inline vcl_session_t *
364 vcl_session_alloc (vcl_worker_t * wrk)
367 pool_get (wrk->sessions, s);
368 memset (s, 0, sizeof (*s));
369 s->session_index = s - wrk->sessions;
370 s->listener_index = VCL_INVALID_SESSION_INDEX;
375 vcl_session_free (vcl_worker_t * wrk, vcl_session_t * s)
377 VDBG (0, "session %u [0x%llx] removed", s->session_index, s->vpp_handle);
378 pool_put (wrk->sessions, s);
381 static inline vcl_session_t *
382 vcl_session_get (vcl_worker_t * wrk, u32 session_index)
384 if (pool_is_free_index (wrk->sessions, session_index))
386 return pool_elt_at_index (wrk->sessions, session_index);
389 static inline vcl_session_handle_t
390 vcl_session_handle_from_index (u32 session_index)
392 ASSERT (session_index < 2 << 24);
393 return (vcl_get_worker_index () << 24 | session_index);
396 static inline vcl_session_handle_t
397 vcl_session_handle (vcl_session_t * s)
399 return vcl_session_handle_from_index (s->session_index);
403 vcl_session_handle_parse (u32 handle, u32 * wrk_index, u32 * session_index)
405 *wrk_index = handle >> 24;
406 *session_index = handle & 0xFFFFFF;
409 static inline vcl_session_t *
410 vcl_session_get_w_handle (vcl_worker_t * wrk, u32 session_handle)
412 u32 session_index, wrk_index;
413 vcl_session_handle_parse (session_handle, &wrk_index, &session_index);
414 ASSERT (wrk_index == wrk->wrk_index);
415 return vcl_session_get (wrk, session_index);
418 static inline vcl_session_t *
419 vcl_session_get_w_vpp_handle (vcl_worker_t * wrk, u64 vpp_handle)
422 if ((p = hash_get (wrk->session_index_by_vpp_handles, vpp_handle)))
423 return vcl_session_get (wrk, (u32) p[0]);
428 vcl_session_index_from_vpp_handle (vcl_worker_t * wrk, u64 vpp_handle)
431 if ((p = hash_get (wrk->session_index_by_vpp_handles, vpp_handle)))
433 return VCL_INVALID_SESSION_INDEX;
437 vcl_session_table_add_vpp_handle (vcl_worker_t * wrk, u64 handle, u32 value)
439 hash_set (wrk->session_index_by_vpp_handles, handle, value);
443 vcl_session_table_del_vpp_handle (vcl_worker_t * wrk, u64 vpp_handle)
445 hash_unset (wrk->session_index_by_vpp_handles, vpp_handle);
448 static inline uword *
449 vcl_session_table_lookup_vpp_handle (vcl_worker_t * wrk, u64 handle)
451 return hash_get (wrk->session_index_by_vpp_handles, handle);
455 vcl_session_table_add_listener (vcl_worker_t * wrk, u64 listener_handle,
458 hash_set (wrk->session_index_by_vpp_handles, listener_handle, value);
462 vcl_session_table_del_listener (vcl_worker_t * wrk, u64 listener_handle)
464 hash_unset (wrk->session_index_by_vpp_handles, listener_handle);
468 vcl_session_is_connectable_listener (vcl_worker_t * wrk,
469 vcl_session_t * session)
471 /* Tell if we session_handle is a QUIC session.
472 * We can be in the following cases :
473 * Listen session <- QUIC session <- Stream session
474 * QUIC session <- Stream session
477 if (session->session_type != VPPCOM_PROTO_QUIC)
479 if (session->listener_index == VCL_INVALID_SESSION_INDEX)
480 return !(session->session_state & STATE_LISTEN);
481 ls = vcl_session_get_w_handle (wrk, session->listener_index);
483 return VPPCOM_EBADFD;
484 return ls->session_state & STATE_LISTEN;
487 static inline vcl_session_t *
488 vcl_session_table_lookup_listener (vcl_worker_t * wrk, u64 handle)
491 vcl_session_t *session;
493 p = hash_get (wrk->session_index_by_vpp_handles, handle);
496 VDBG (0, "could not find listen session: unknown vpp listener handle"
500 session = vcl_session_get (wrk, p[0]);
503 VDBG (1, "invalid listen session index (%u)", p[0]);
507 ASSERT ((session->session_state & (STATE_LISTEN | STATE_LISTEN_NO_MQ)) ||
508 vcl_session_is_connectable_listener (wrk, session));
512 const char *vppcom_session_state_str (vcl_session_state_t state);
515 vcl_session_is_ct (vcl_session_t * s)
517 return (s->ct_tx_fifo != 0);
521 vcl_session_is_cl (vcl_session_t * s)
523 if (s->session_type == VPPCOM_PROTO_UDP)
529 vcl_session_is_open (vcl_session_t * s)
531 return ((s->session_state & STATE_OPEN)
532 || (s->session_state == STATE_LISTEN
533 && s->session_type == VPPCOM_PROTO_UDP));
537 vcl_session_is_closing (vcl_session_t * s)
539 return (s->session_state == STATE_VPP_CLOSING
540 || s->session_state == STATE_DISCONNECT);
544 vcl_session_closing_error (vcl_session_t * s)
546 /* Return 0 on closing sockets */
547 return s->session_state == STATE_DISCONNECT ? VPPCOM_ECONNRESET : 0;
551 vcl_session_closed_error (vcl_session_t * s)
553 return s->session_state == STATE_DISCONNECT
554 ? VPPCOM_ECONNRESET : VPPCOM_ENOTCONN;
560 int vcl_wait_for_app_state_change (app_state_t app_state);
561 vcl_mq_evt_conn_t *vcl_mq_evt_conn_alloc (vcl_worker_t * wrk);
562 u32 vcl_mq_evt_conn_index (vcl_worker_t * wrk, vcl_mq_evt_conn_t * mqc);
563 vcl_mq_evt_conn_t *vcl_mq_evt_conn_get (vcl_worker_t * wrk, u32 mq_conn_idx);
564 int vcl_mq_epoll_add_evfd (vcl_worker_t * wrk, svm_msg_q_t * mq);
565 int vcl_mq_epoll_del_evfd (vcl_worker_t * wrk, u32 mqc_index);
567 vcl_worker_t *vcl_worker_alloc_and_init (void);
568 void vcl_worker_cleanup (vcl_worker_t * wrk, u8 notify_vpp);
569 int vcl_worker_register_with_vpp (void);
570 int vcl_worker_set_bapi (void);
571 svm_msg_q_t *vcl_worker_ctrl_mq (vcl_worker_t * wrk);
573 void vcl_flush_mq_events (void);
574 void vcl_cleanup_bapi (void);
575 int vcl_session_cleanup (vcl_worker_t * wrk, vcl_session_t * session,
576 vcl_session_handle_t sh, u8 do_disconnect);
578 void vcl_segment_table_add (u64 segment_handle, u32 svm_segment_index);
579 u32 vcl_segment_table_lookup (u64 segment_handle);
580 void vcl_segment_table_del (u64 segment_handle);
582 int vcl_session_read_ready (vcl_session_t * session);
583 int vcl_session_write_ready (vcl_session_t * session);
585 static inline vcl_worker_t *
586 vcl_worker_get (u32 wrk_index)
588 return pool_elt_at_index (vcm->workers, wrk_index);
591 static inline vcl_worker_t *
592 vcl_worker_get_if_valid (u32 wrk_index)
594 if (pool_is_free_index (vcm->workers, wrk_index))
596 return pool_elt_at_index (vcm->workers, wrk_index);
599 static inline vcl_worker_t *
600 vcl_worker_get_current (void)
602 return vcl_worker_get (vcl_get_worker_index ());
608 return pool_elts (vcm->workers);
611 static inline svm_msg_q_t *
612 vcl_session_vpp_evt_q (vcl_worker_t * wrk, vcl_session_t * s)
614 return wrk->vpp_event_queues[s->vpp_thread_index];
617 void vcl_send_session_worker_update (vcl_worker_t * wrk, vcl_session_t * s,
622 int vppcom_connect_to_vpp (char *app_name);
623 void vppcom_disconnect_from_vpp (void);
624 void vppcom_init_error_string_table (void);
625 void vppcom_send_session_enable_disable (u8 is_enable);
626 void vppcom_app_send_attach (void);
627 void vppcom_app_send_detach (void);
628 void vcl_send_session_unlisten (vcl_worker_t * wrk, vcl_session_t * s);
629 void vppcom_send_disconnect_session (u64 vpp_handle);
630 void vppcom_api_hookup (void);
631 void vppcom_send_application_tls_cert_add (vcl_session_t * session,
632 char *cert, u32 cert_len);
633 void vppcom_send_application_tls_key_add (vcl_session_t * session, char *key,
635 void vcl_send_app_worker_add_del (u8 is_add);
636 void vcl_send_child_worker_del (vcl_worker_t * wrk);
638 int vcl_segment_attach (u64 segment_handle, char *name,
639 ssvm_segment_type_t type, int fd);
640 void vcl_segment_detach (u64 segment_handle);
642 u32 vcl_max_nsid_len (void);
644 u8 *format_api_error (u8 * s, va_list * args);
647 #endif /* SRC_VCL_VCL_PRIVATE_H_ */
650 * fd.io coding-style-patch-verification: ON
653 * eval: (c-set-style "gnu")