| /* |
| * Copyright (c) 2018-2019 Cisco and/or its affiliates. |
| * Licensed under the Apache License, Version 2.0 (the "License"); |
| * you may not use this |
| * You may obtain a copy of the License at: |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, software |
| * distributed under the License is distributed on an "AS IS" BASIS, |
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| * See the License for the specific language governing permissions and |
| * limitations under the License. |
| */ |
| |
| #ifndef SRC_VCL_VCL_PRIVATE_H_ |
| #define SRC_VCL_VCL_PRIVATE_H_ |
| |
| #include <vnet/session/application_interface.h> |
| #include <vcl/vppcom.h> |
| #include <vcl/vcl_debug.h> |
| |
| #if (CLIB_DEBUG > 0) |
| /* Set VPPCOM_DEBUG_INIT 2 for connection debug, |
| * 3 for read/write debug output |
| * or |
| * export VCL_DEBUG=<#> to set dynamically. |
| */ |
| #define VPPCOM_DEBUG_INIT 1 |
| #else |
| #define VPPCOM_DEBUG_INIT 0 |
| #endif |
| |
| #define VPPCOM_DEBUG vcm->debug |
| |
| extern __thread uword __vcl_worker_index; |
| |
| static inline void |
| vcl_set_worker_index (uword wrk_index) |
| { |
| __vcl_worker_index = wrk_index; |
| } |
| |
| static inline uword |
| vcl_get_worker_index (void) |
| { |
| return __vcl_worker_index; |
| } |
| |
| /* |
| * VPPCOM Private definitions and functions. |
| */ |
| typedef enum |
| { |
| STATE_APP_START, |
| STATE_APP_CONN_VPP, |
| STATE_APP_ENABLED, |
| STATE_APP_ATTACHED, |
| STATE_APP_ADDING_WORKER, |
| STATE_APP_ADDING_TLS_DATA, |
| STATE_APP_FAILED, |
| STATE_APP_READY |
| } app_state_t; |
| |
| typedef enum |
| { |
| STATE_CLOSED = 0, |
| STATE_CONNECT = 0x01, |
| STATE_LISTEN = 0x02, |
| STATE_ACCEPT = 0x04, |
| STATE_VPP_CLOSING = 0x08, |
| STATE_DISCONNECT = 0x10, |
| STATE_FAILED = 0x20, |
| STATE_UPDATED = 0x40, |
| STATE_LISTEN_NO_MQ = 0x80, |
| } vcl_session_state_t; |
| |
| #define SERVER_STATE_OPEN (STATE_ACCEPT|STATE_VPP_CLOSING) |
| #define CLIENT_STATE_OPEN (STATE_CONNECT|STATE_VPP_CLOSING) |
| #define STATE_OPEN (SERVER_STATE_OPEN | CLIENT_STATE_OPEN) |
| |
| typedef struct epoll_event vppcom_epoll_event_t; |
| |
| typedef struct |
| { |
| u32 next_sh; |
| u32 prev_sh; |
| u32 vep_sh; |
| vppcom_epoll_event_t ev; |
| #define VEP_DEFAULT_ET_MASK (EPOLLIN|EPOLLOUT) |
| #define VEP_UNSUPPORTED_EVENTS (EPOLLONESHOT|EPOLLEXCLUSIVE) |
| u32 et_mask; |
| } vppcom_epoll_t; |
| |
| /* Select uses the vcl_si_set as if a clib_bitmap. Make sure they are the |
| * same size */ |
| STATIC_ASSERT (sizeof (clib_bitmap_t) == sizeof (vcl_si_set), |
| "vppcom bitmap size mismatch"); |
| |
| typedef struct |
| { |
| u8 is_ip4; |
| ip46_address_t ip46; |
| } vppcom_ip46_t; |
| |
| #define VCL_ACCEPTED_F_CLOSED (1 << 0) |
| #define VCL_ACCEPTED_F_RESET (1 << 1) |
| |
| typedef struct vcl_session_msg |
| { |
| u32 next; |
| union |
| { |
| session_accepted_msg_t accepted_msg; |
| }; |
| u32 flags; |
| } vcl_session_msg_t; |
| |
| typedef enum |
| { |
| VCL_SESS_ATTR_SERVER, |
| VCL_SESS_ATTR_CUT_THRU, |
| VCL_SESS_ATTR_VEP, |
| VCL_SESS_ATTR_VEP_SESSION, |
| VCL_SESS_ATTR_LISTEN, // SOL_SOCKET,SO_ACCEPTCONN |
| VCL_SESS_ATTR_NONBLOCK, // fcntl,O_NONBLOCK |
| VCL_SESS_ATTR_REUSEADDR, // SOL_SOCKET,SO_REUSEADDR |
| VCL_SESS_ATTR_REUSEPORT, // SOL_SOCKET,SO_REUSEPORT |
| VCL_SESS_ATTR_BROADCAST, // SOL_SOCKET,SO_BROADCAST |
| VCL_SESS_ATTR_V6ONLY, // SOL_TCP,IPV6_V6ONLY |
| VCL_SESS_ATTR_KEEPALIVE, // SOL_SOCKET,SO_KEEPALIVE |
| VCL_SESS_ATTR_TCP_NODELAY, // SOL_TCP,TCP_NODELAY |
| VCL_SESS_ATTR_TCP_KEEPIDLE, // SOL_TCP,TCP_KEEPIDLE |
| VCL_SESS_ATTR_TCP_KEEPINTVL, // SOL_TCP,TCP_KEEPINTVL |
| VCL_SESS_ATTR_SHUT_RD, |
| VCL_SESS_ATTR_SHUT_WR, |
| VCL_SESS_ATTR_MAX |
| } vppcom_session_attr_t; |
| |
| #define VCL_SESS_ATTR_SET(ATTR, VAL) \ |
| do { \ |
| (ATTR) |= 1 << (VAL); \ |
| } while (0) |
| |
| #define VCL_SESS_ATTR_CLR(ATTR, VAL) \ |
| do { \ |
| (ATTR) &= ~(1 << (VAL)); \ |
| } while (0) |
| |
| #define VCL_SESS_ATTR_TEST(ATTR, VAL) \ |
| ((ATTR) & (1 << (VAL)) ? 1 : 0) |
| |
| typedef struct |
| { |
| CLIB_CACHE_LINE_ALIGN_MARK (cacheline0); |
| #define _(type, name) type name; |
| foreach_app_session_field |
| #undef _ |
| u32 sndbuf_size; // VPP-TBD: Hack until support setsockopt(SO_SNDBUF) |
| u32 rcvbuf_size; // VPP-TBD: Hack until support setsockopt(SO_RCVBUF) |
| u32 user_mss; // VPP-TBD: Hack until support setsockopt(TCP_MAXSEG) |
| u64 vpp_handle; |
| u32 vpp_thread_index; |
| |
| svm_fifo_t *ct_rx_fifo; |
| svm_fifo_t *ct_tx_fifo; |
| |
| /* Socket configuration state */ |
| u8 is_vep; |
| u8 is_vep_session; |
| /* VCL session index of the listening session (if any) */ |
| u32 listener_index; |
| /* Accepted sessions on this listener */ |
| int n_accepted_sessions; |
| u8 has_rx_evt; |
| u32 attr; |
| u64 parent_handle; |
| vppcom_epoll_t vep; |
| int libc_epfd; |
| svm_msg_q_t *our_evt_q; |
| vcl_session_msg_t *accept_evts_fifo; |
| #if VCL_ELOG |
| elog_track_t elog_track; |
| #endif |
| } vcl_session_t; |
| |
| typedef struct vppcom_cfg_t_ |
| { |
| uword heapsize; |
| u32 max_workers; |
| u32 vpp_api_q_length; |
| uword segment_baseva; |
| u32 segment_size; |
| u32 add_segment_size; |
| u32 preallocated_fifo_pairs; |
| u32 rx_fifo_size; |
| u32 tx_fifo_size; |
| u32 event_queue_size; |
| u32 listen_queue_size; |
| u8 app_proxy_transport_tcp; |
| u8 app_proxy_transport_udp; |
| u8 app_scope_local; |
| u8 app_scope_global; |
| u8 *namespace_id; |
| u64 namespace_secret; |
| u8 use_mq_eventfd; |
| f64 app_timeout; |
| f64 session_timeout; |
| f64 accept_timeout; |
| u32 event_ring_size; |
| char *event_log_path; |
| u8 *vpp_api_filename; |
| u8 *vpp_api_socket_name; |
| u8 *vpp_api_chroot; |
| u32 tls_engine; |
| } vppcom_cfg_t; |
| |
| void vppcom_cfg (vppcom_cfg_t * vcl_cfg); |
| |
| typedef struct vcl_cut_through_registration_ |
| { |
| svm_msg_q_t *mq; |
| svm_msg_q_t *peer_mq; |
| u32 sid; |
| u32 epoll_evt_conn_index; /*< mq evt connection index part of |
| the mqs evtfd epoll (if used) */ |
| } vcl_cut_through_registration_t; |
| |
| typedef struct vcl_mq_evt_conn_ |
| { |
| svm_msg_q_t *mq; |
| int mq_fd; |
| } vcl_mq_evt_conn_t; |
| |
| typedef struct vcl_worker_ |
| { |
| CLIB_CACHE_LINE_ALIGN_MARK (cacheline0); |
| |
| /* Session pool */ |
| vcl_session_t *sessions; |
| |
| /** Worker/thread index in current process */ |
| u32 wrk_index; |
| |
| /** Worker index in vpp*/ |
| u32 vpp_wrk_index; |
| |
| /** API client handle */ |
| u32 my_client_index; |
| |
| /** State of the connection, shared between msg RX thread and main thread */ |
| volatile app_state_t wrk_state; |
| |
| /** VPP binary api input queue */ |
| svm_queue_t *vl_input_queue; |
| |
| /** VPP mq to be used for exchanging control messages */ |
| svm_msg_q_t *ctrl_mq; |
| |
| /** Message queues epoll fd. Initialized only if using mqs with eventfds */ |
| int mqs_epfd; |
| |
| /** Pool of event message queue event connections */ |
| vcl_mq_evt_conn_t *mq_evt_conns; |
| |
| /** Per worker buffer for receiving mq epoll events */ |
| struct epoll_event *mq_events; |
| |
| /** Hash table for disconnect processing */ |
| uword *session_index_by_vpp_handles; |
| |
| /** Select bitmaps */ |
| clib_bitmap_t *rd_bitmap; |
| clib_bitmap_t *wr_bitmap; |
| clib_bitmap_t *ex_bitmap; |
| |
| /** Our event message queue */ |
| svm_msg_q_t *app_event_queue; |
| |
| /** VPP workers event message queues */ |
| svm_msg_q_t **vpp_event_queues; |
| |
| /** For deadman timers */ |
| clib_time_t clib_time; |
| |
| /** Vector acting as buffer for mq messages */ |
| svm_msg_q_msg_t *mq_msg_vector; |
| |
| /** Vector of unhandled events */ |
| session_event_t *unhandled_evts_vector; |
| |
| u32 *pending_session_wrk_updates; |
| |
| /** Used also as a thread stop key buffer */ |
| pthread_t thread_id; |
| |
| /** Current pid, may be different from main_pid if forked child */ |
| pid_t current_pid; |
| |
| u32 forked_child; |
| |
| socket_client_main_t bapi_sock_ctx; |
| memory_client_main_t bapi_shm_ctx; |
| api_main_t bapi_api_ctx; |
| } vcl_worker_t; |
| |
| typedef struct vppcom_main_t_ |
| { |
| u8 is_init; |
| u32 debug; |
| pthread_t main_cpu; |
| |
| /** Main process pid */ |
| pid_t main_pid; |
| |
| /** App's index in vpp. It's used by vpp to identify the app */ |
| u32 app_index; |
| |
| /** State of the connection, shared between msg RX thread and main thread */ |
| volatile app_state_t app_state; |
| |
| u8 *app_name; |
| |
| /** VCL configuration */ |
| vppcom_cfg_t cfg; |
| |
| volatile u32 forking; |
| |
| /** Workers */ |
| vcl_worker_t *workers; |
| |
| /** Lock to protect worker registrations */ |
| clib_spinlock_t workers_lock; |
| |
| /** Lock to protect segment hash table */ |
| clib_rwlock_t segment_table_lock; |
| |
| /** Mapped segments table */ |
| uword *segment_table; |
| |
| /** Control mq obtained from attach */ |
| svm_msg_q_t *ctrl_mq; |
| |
| fifo_segment_main_t segment_main; |
| |
| #ifdef VCL_ELOG |
| /* VPP Event-logger */ |
| elog_main_t elog_main; |
| elog_track_t elog_track; |
| #endif |
| |
| /* VNET_API_ERROR_FOO -> "Foo" hash table */ |
| uword *error_string_by_error_number; |
| |
| } vppcom_main_t; |
| |
| extern vppcom_main_t *vcm; |
| |
| #define VCL_INVALID_SESSION_INDEX ((u32)~0) |
| #define VCL_INVALID_SESSION_HANDLE ((u64)~0) |
| #define VCL_INVALID_SEGMENT_INDEX ((u32)~0) |
| #define VCL_INVALID_SEGMENT_HANDLE ((u64)~0) |
| |
| static inline vcl_session_t * |
| vcl_session_alloc (vcl_worker_t * wrk) |
| { |
| vcl_session_t *s; |
| pool_get (wrk->sessions, s); |
| memset (s, 0, sizeof (*s)); |
| s->session_index = s - wrk->sessions; |
| s->listener_index = VCL_INVALID_SESSION_INDEX; |
| return s; |
| } |
| |
| static inline void |
| vcl_session_free (vcl_worker_t * wrk, vcl_session_t * s) |
| { |
| VDBG (0, "session %u [0x%llx] removed", s->session_index, s->vpp_handle); |
| pool_put (wrk->sessions, s); |
| } |
| |
| static inline vcl_session_t * |
| vcl_session_get (vcl_worker_t * wrk, u32 session_index) |
| { |
| if (pool_is_free_index (wrk->sessions, session_index)) |
| return 0; |
| return pool_elt_at_index (wrk->sessions, session_index); |
| } |
| |
| static inline vcl_session_handle_t |
| vcl_session_handle_from_index (u32 session_index) |
| { |
| ASSERT (session_index < 2 << 24); |
| return (vcl_get_worker_index () << 24 | session_index); |
| } |
| |
| static inline vcl_session_handle_t |
| vcl_session_handle (vcl_session_t * s) |
| { |
| return vcl_session_handle_from_index (s->session_index); |
| } |
| |
| static inline void |
| vcl_session_handle_parse (u32 handle, u32 * wrk_index, u32 * session_index) |
| { |
| *wrk_index = handle >> 24; |
| *session_index = handle & 0xFFFFFF; |
| } |
| |
| static inline vcl_session_t * |
| vcl_session_get_w_handle (vcl_worker_t * wrk, u32 session_handle) |
| { |
| u32 session_index, wrk_index; |
| vcl_session_handle_parse (session_handle, &wrk_index, &session_index); |
| ASSERT (wrk_index == wrk->wrk_index); |
| return vcl_session_get (wrk, session_index); |
| } |
| |
| static inline vcl_session_t * |
| vcl_session_get_w_vpp_handle (vcl_worker_t * wrk, u64 vpp_handle) |
| { |
| uword *p; |
| if ((p = hash_get (wrk->session_index_by_vpp_handles, vpp_handle))) |
| return vcl_session_get (wrk, (u32) p[0]); |
| return 0; |
| } |
| |
| static inline u32 |
| vcl_session_index_from_vpp_handle (vcl_worker_t * wrk, u64 vpp_handle) |
| { |
| uword *p; |
| if ((p = hash_get (wrk->session_index_by_vpp_handles, vpp_handle))) |
| return p[0]; |
| return VCL_INVALID_SESSION_INDEX; |
| } |
| |
| static inline void |
| vcl_session_table_add_vpp_handle (vcl_worker_t * wrk, u64 handle, u32 value) |
| { |
| hash_set (wrk->session_index_by_vpp_handles, handle, value); |
| } |
| |
| static inline void |
| vcl_session_table_del_vpp_handle (vcl_worker_t * wrk, u64 vpp_handle) |
| { |
| hash_unset (wrk->session_index_by_vpp_handles, vpp_handle); |
| } |
| |
| static inline uword * |
| vcl_session_table_lookup_vpp_handle (vcl_worker_t * wrk, u64 handle) |
| { |
| return hash_get (wrk->session_index_by_vpp_handles, handle); |
| } |
| |
| static inline void |
| vcl_session_table_add_listener (vcl_worker_t * wrk, u64 listener_handle, |
| u32 value) |
| { |
| hash_set (wrk->session_index_by_vpp_handles, listener_handle, value); |
| } |
| |
| static inline void |
| vcl_session_table_del_listener (vcl_worker_t * wrk, u64 listener_handle) |
| { |
| hash_unset (wrk->session_index_by_vpp_handles, listener_handle); |
| } |
| |
| static inline int |
| vcl_session_is_connectable_listener (vcl_worker_t * wrk, |
| vcl_session_t * session) |
| { |
| /* Tell if we session_handle is a QUIC session. |
| * We can be in the following cases : |
| * Listen session <- QUIC session <- Stream session |
| * QUIC session <- Stream session |
| */ |
| vcl_session_t *ls; |
| if (session->session_type != VPPCOM_PROTO_QUIC) |
| return 0; |
| if (session->listener_index == VCL_INVALID_SESSION_INDEX) |
| return !(session->session_state & STATE_LISTEN); |
| ls = vcl_session_get_w_handle (wrk, session->listener_index); |
| if (!ls) |
| return VPPCOM_EBADFD; |
| return ls->session_state & STATE_LISTEN; |
| } |
| |
| static inline vcl_session_t * |
| vcl_session_table_lookup_listener (vcl_worker_t * wrk, u64 handle) |
| { |
| uword *p; |
| vcl_session_t *session; |
| |
| p = hash_get (wrk->session_index_by_vpp_handles, handle); |
| if (!p) |
| { |
| VDBG (0, "could not find listen session: unknown vpp listener handle" |
| " %llx", handle); |
| return 0; |
| } |
| session = vcl_session_get (wrk, p[0]); |
| if (!session) |
| { |
| VDBG (1, "invalid listen session index (%u)", p[0]); |
| return 0; |
| } |
| |
| ASSERT ((session->session_state & (STATE_LISTEN | STATE_LISTEN_NO_MQ)) || |
| vcl_session_is_connectable_listener (wrk, session)); |
| return session; |
| } |
| |
| const char *vppcom_session_state_str (vcl_session_state_t state); |
| |
| static inline u8 |
| vcl_session_is_ct (vcl_session_t * s) |
| { |
| return (s->ct_tx_fifo != 0); |
| } |
| |
| static inline u8 |
| vcl_session_is_cl (vcl_session_t * s) |
| { |
| if (s->session_type == VPPCOM_PROTO_UDP) |
| return 1; |
| return 0; |
| } |
| |
| static inline u8 |
| vcl_session_is_open (vcl_session_t * s) |
| { |
| return ((s->session_state & STATE_OPEN) |
| || (s->session_state == STATE_LISTEN |
| && s->session_type == VPPCOM_PROTO_UDP)); |
| } |
| |
| static inline u8 |
| vcl_session_is_closing (vcl_session_t * s) |
| { |
| return (s->session_state == STATE_VPP_CLOSING |
| || s->session_state == STATE_DISCONNECT); |
| } |
| |
| static inline int |
| vcl_session_closing_error (vcl_session_t * s) |
| { |
| return s->session_state == STATE_DISCONNECT ? VPPCOM_ECONNRESET : 0; |
| } |
| |
| static inline int |
| vcl_session_closed_error (vcl_session_t * s) |
| { |
| return s->session_state == STATE_DISCONNECT |
| ? VPPCOM_ECONNRESET : VPPCOM_ENOTCONN; |
| } |
| |
| /* |
| * Helpers |
| */ |
| int vcl_wait_for_app_state_change (app_state_t app_state); |
| vcl_mq_evt_conn_t *vcl_mq_evt_conn_alloc (vcl_worker_t * wrk); |
| u32 vcl_mq_evt_conn_index (vcl_worker_t * wrk, vcl_mq_evt_conn_t * mqc); |
| vcl_mq_evt_conn_t *vcl_mq_evt_conn_get (vcl_worker_t * wrk, u32 mq_conn_idx); |
| int vcl_mq_epoll_add_evfd (vcl_worker_t * wrk, svm_msg_q_t * mq); |
| int vcl_mq_epoll_del_evfd (vcl_worker_t * wrk, u32 mqc_index); |
| |
| vcl_worker_t *vcl_worker_alloc_and_init (void); |
| void vcl_worker_cleanup (vcl_worker_t * wrk, u8 notify_vpp); |
| int vcl_worker_register_with_vpp (void); |
| int vcl_worker_set_bapi (void); |
| svm_msg_q_t *vcl_worker_ctrl_mq (vcl_worker_t * wrk); |
| |
| void vcl_flush_mq_events (void); |
| void vcl_cleanup_bapi (void); |
| int vcl_session_cleanup (vcl_worker_t * wrk, vcl_session_t * session, |
| vcl_session_handle_t sh, u8 do_disconnect); |
| |
| void vcl_segment_table_add (u64 segment_handle, u32 svm_segment_index); |
| u32 vcl_segment_table_lookup (u64 segment_handle); |
| void vcl_segment_table_del (u64 segment_handle); |
| |
| int vcl_session_read_ready (vcl_session_t * session); |
| int vcl_session_write_ready (vcl_session_t * session); |
| |
| static inline vcl_worker_t * |
| vcl_worker_get (u32 wrk_index) |
| { |
| return pool_elt_at_index (vcm->workers, wrk_index); |
| } |
| |
| static inline vcl_worker_t * |
| vcl_worker_get_if_valid (u32 wrk_index) |
| { |
| if (pool_is_free_index (vcm->workers, wrk_index)) |
| return 0; |
| return pool_elt_at_index (vcm->workers, wrk_index); |
| } |
| |
| static inline vcl_worker_t * |
| vcl_worker_get_current (void) |
| { |
| return vcl_worker_get (vcl_get_worker_index ()); |
| } |
| |
| static inline u8 |
| vcl_n_workers (void) |
| { |
| return pool_elts (vcm->workers); |
| } |
| |
| static inline svm_msg_q_t * |
| vcl_session_vpp_evt_q (vcl_worker_t * wrk, vcl_session_t * s) |
| { |
| return wrk->vpp_event_queues[s->vpp_thread_index]; |
| } |
| |
| void vcl_send_session_worker_update (vcl_worker_t * wrk, vcl_session_t * s, |
| u32 wrk_index); |
| /* |
| * VCL Binary API |
| */ |
| int vppcom_connect_to_vpp (char *app_name); |
| void vppcom_disconnect_from_vpp (void); |
| void vppcom_init_error_string_table (void); |
| void vppcom_send_session_enable_disable (u8 is_enable); |
| void vppcom_app_send_attach (void); |
| void vppcom_app_send_detach (void); |
| void vcl_send_session_unlisten (vcl_worker_t * wrk, vcl_session_t * s); |
| void vppcom_send_disconnect_session (u64 vpp_handle); |
| void vppcom_api_hookup (void); |
| void vppcom_send_application_tls_cert_add (vcl_session_t * session, |
| char *cert, u32 cert_len); |
| void vppcom_send_application_tls_key_add (vcl_session_t * session, char *key, |
| u32 key_len); |
| void vcl_send_app_worker_add_del (u8 is_add); |
| void vcl_send_child_worker_del (vcl_worker_t * wrk); |
| |
| int vcl_segment_attach (u64 segment_handle, char *name, |
| ssvm_segment_type_t type, int fd); |
| void vcl_segment_detach (u64 segment_handle); |
| |
| u32 vcl_max_nsid_len (void); |
| |
| u8 *format_api_error (u8 * s, va_list * args); |
| |
| void vls_init (); |
| #endif /* SRC_VCL_VCL_PRIVATE_H_ */ |
| |
| /* |
| * fd.io coding-style-patch-verification: ON |
| * |
| * Local Variables: |
| * eval: (c-set-style "gnu") |
| * End: |
| */ |