Florin Coras | 697faea | 2018-06-27 17:10:49 -0700 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (c) 2018 Cisco and/or its affiliates. |
| 3 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 4 | * you may not use this |
| 5 | * You may obtain a copy of the License at: |
| 6 | * |
| 7 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 8 | * |
| 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. |
| 14 | */ |
| 15 | |
| 16 | #ifndef SRC_VCL_VCL_PRIVATE_H_ |
| 17 | #define SRC_VCL_VCL_PRIVATE_H_ |
| 18 | |
| 19 | #include <vnet/session/application_interface.h> |
| 20 | #include <vcl/vppcom.h> |
Florin Coras | 697faea | 2018-06-27 17:10:49 -0700 | [diff] [blame] | 21 | #include <vcl/vcl_debug.h> |
| 22 | |
| 23 | #if (CLIB_DEBUG > 0) |
| 24 | /* Set VPPCOM_DEBUG_INIT 2 for connection debug, |
| 25 | * 3 for read/write debug output |
| 26 | * or |
| 27 | * export VCL_DEBUG=<#> to set dynamically. |
| 28 | */ |
| 29 | #define VPPCOM_DEBUG_INIT 1 |
| 30 | #else |
| 31 | #define VPPCOM_DEBUG_INIT 0 |
| 32 | #endif |
| 33 | |
| 34 | #define VPPCOM_DEBUG vcm->debug |
| 35 | |
Florin Coras | 134a996 | 2018-08-28 11:32:04 -0700 | [diff] [blame] | 36 | extern __thread uword __vcl_worker_index; |
| 37 | |
| 38 | static inline void |
| 39 | vcl_set_worker_index (uword wrk_index) |
| 40 | { |
| 41 | __vcl_worker_index = wrk_index; |
| 42 | } |
| 43 | |
| 44 | static inline uword |
| 45 | vcl_get_worker_index (void) |
| 46 | { |
| 47 | return __vcl_worker_index; |
| 48 | } |
| 49 | |
Florin Coras | 697faea | 2018-06-27 17:10:49 -0700 | [diff] [blame] | 50 | /* |
| 51 | * VPPCOM Private definitions and functions. |
| 52 | */ |
| 53 | typedef enum |
| 54 | { |
| 55 | STATE_APP_START, |
| 56 | STATE_APP_CONN_VPP, |
| 57 | STATE_APP_ENABLED, |
| 58 | STATE_APP_ATTACHED, |
Florin Coras | 134a996 | 2018-08-28 11:32:04 -0700 | [diff] [blame] | 59 | STATE_APP_ADDING_WORKER, |
| 60 | STATE_APP_FAILED, |
| 61 | STATE_APP_READY |
Florin Coras | 697faea | 2018-06-27 17:10:49 -0700 | [diff] [blame] | 62 | } app_state_t; |
| 63 | |
| 64 | typedef enum |
| 65 | { |
| 66 | STATE_START = 0x01, |
| 67 | STATE_CONNECT = 0x02, |
| 68 | STATE_LISTEN = 0x04, |
| 69 | STATE_ACCEPT = 0x08, |
| 70 | STATE_CLOSE_ON_EMPTY = 0x10, |
| 71 | STATE_DISCONNECT = 0x20, |
| 72 | STATE_FAILED = 0x40 |
| 73 | } session_state_t; |
| 74 | |
| 75 | #define SERVER_STATE_OPEN (STATE_ACCEPT|STATE_CLOSE_ON_EMPTY) |
| 76 | #define CLIENT_STATE_OPEN (STATE_CONNECT|STATE_CLOSE_ON_EMPTY) |
Florin Coras | 54693d2 | 2018-07-17 10:46:29 -0700 | [diff] [blame] | 77 | #define STATE_OPEN (SERVER_STATE_OPEN | CLIENT_STATE_OPEN) |
Florin Coras | 697faea | 2018-06-27 17:10:49 -0700 | [diff] [blame] | 78 | |
| 79 | typedef struct epoll_event vppcom_epoll_event_t; |
| 80 | |
| 81 | typedef struct |
| 82 | { |
Florin Coras | 134a996 | 2018-08-28 11:32:04 -0700 | [diff] [blame] | 83 | u32 next_sh; |
| 84 | u32 prev_sh; |
| 85 | u32 vep_sh; |
Florin Coras | 697faea | 2018-06-27 17:10:49 -0700 | [diff] [blame] | 86 | vppcom_epoll_event_t ev; |
| 87 | #define VEP_DEFAULT_ET_MASK (EPOLLIN|EPOLLOUT) |
| 88 | #define VEP_UNSUPPORTED_EVENTS (EPOLLONESHOT|EPOLLEXCLUSIVE) |
| 89 | u32 et_mask; |
| 90 | } vppcom_epoll_t; |
| 91 | |
| 92 | typedef struct |
| 93 | { |
| 94 | u8 is_ip4; |
| 95 | ip46_address_t ip46; |
| 96 | } vppcom_ip46_t; |
| 97 | |
Florin Coras | 54693d2 | 2018-07-17 10:46:29 -0700 | [diff] [blame] | 98 | typedef struct vcl_session_msg |
| 99 | { |
| 100 | u32 next; |
| 101 | union |
| 102 | { |
| 103 | session_accepted_msg_t accepted_msg; |
| 104 | }; |
| 105 | } vcl_session_msg_t; |
| 106 | |
Florin Coras | 697faea | 2018-06-27 17:10:49 -0700 | [diff] [blame] | 107 | enum |
| 108 | { |
| 109 | VCL_SESS_ATTR_SERVER, |
| 110 | VCL_SESS_ATTR_CUT_THRU, |
| 111 | VCL_SESS_ATTR_VEP, |
| 112 | VCL_SESS_ATTR_VEP_SESSION, |
| 113 | VCL_SESS_ATTR_LISTEN, // SOL_SOCKET,SO_ACCEPTCONN |
| 114 | VCL_SESS_ATTR_NONBLOCK, // fcntl,O_NONBLOCK |
| 115 | VCL_SESS_ATTR_REUSEADDR, // SOL_SOCKET,SO_REUSEADDR |
| 116 | VCL_SESS_ATTR_REUSEPORT, // SOL_SOCKET,SO_REUSEPORT |
| 117 | VCL_SESS_ATTR_BROADCAST, // SOL_SOCKET,SO_BROADCAST |
| 118 | VCL_SESS_ATTR_V6ONLY, // SOL_TCP,IPV6_V6ONLY |
| 119 | VCL_SESS_ATTR_KEEPALIVE, // SOL_SOCKET,SO_KEEPALIVE |
| 120 | VCL_SESS_ATTR_TCP_NODELAY, // SOL_TCP,TCP_NODELAY |
| 121 | VCL_SESS_ATTR_TCP_KEEPIDLE, // SOL_TCP,TCP_KEEPIDLE |
| 122 | VCL_SESS_ATTR_TCP_KEEPINTVL, // SOL_TCP,TCP_KEEPINTVL |
| 123 | VCL_SESS_ATTR_MAX |
| 124 | } vppcom_session_attr_t; |
| 125 | |
| 126 | #define VCL_SESS_ATTR_SET(ATTR, VAL) \ |
| 127 | do { \ |
| 128 | (ATTR) |= 1 << (VAL); \ |
| 129 | } while (0) |
| 130 | |
| 131 | #define VCL_SESS_ATTR_CLR(ATTR, VAL) \ |
| 132 | do { \ |
| 133 | (ATTR) &= ~(1 << (VAL)); \ |
| 134 | } while (0) |
| 135 | |
| 136 | #define VCL_SESS_ATTR_TEST(ATTR, VAL) \ |
| 137 | ((ATTR) & (1 << (VAL)) ? 1 : 0) |
| 138 | |
Florin Coras | 47c40e2 | 2018-11-26 17:01:36 -0800 | [diff] [blame] | 139 | typedef struct vcl_shared_session_ |
| 140 | { |
| 141 | u32 ss_index; |
| 142 | u32 *workers; |
| 143 | } vcl_shared_session_t; |
| 144 | |
Florin Coras | 697faea | 2018-06-27 17:10:49 -0700 | [diff] [blame] | 145 | typedef struct |
| 146 | { |
Florin Coras | 2cba853 | 2018-09-11 16:33:36 -0700 | [diff] [blame] | 147 | CLIB_CACHE_LINE_ALIGN_MARK (cacheline0); |
Florin Coras | 697faea | 2018-06-27 17:10:49 -0700 | [diff] [blame] | 148 | #define _(type, name) type name; |
| 149 | foreach_app_session_field |
| 150 | #undef _ |
| 151 | u32 sndbuf_size; // VPP-TBD: Hack until support setsockopt(SO_SNDBUF) |
| 152 | u32 rcvbuf_size; // VPP-TBD: Hack until support setsockopt(SO_RCVBUF) |
| 153 | u32 user_mss; // VPP-TBD: Hack until support setsockopt(TCP_MAXSEG) |
| 154 | u8 *segment_name; |
| 155 | u32 sm_seg_index; |
| 156 | u32 client_context; |
| 157 | u64 vpp_handle; |
| 158 | |
| 159 | /* Socket configuration state */ |
| 160 | u8 is_vep; |
| 161 | u8 is_vep_session; |
Florin Coras | aa27eb9 | 2018-10-13 12:20:01 -0700 | [diff] [blame] | 162 | u8 has_rx_evt; |
Florin Coras | 697faea | 2018-06-27 17:10:49 -0700 | [diff] [blame] | 163 | u32 attr; |
| 164 | u32 wait_cont_idx; |
| 165 | vppcom_epoll_t vep; |
| 166 | int libc_epfd; |
Florin Coras | 54693d2 | 2018-07-17 10:46:29 -0700 | [diff] [blame] | 167 | svm_msg_q_t *our_evt_q; |
Florin Coras | 697faea | 2018-06-27 17:10:49 -0700 | [diff] [blame] | 168 | u64 options[16]; |
Florin Coras | 54693d2 | 2018-07-17 10:46:29 -0700 | [diff] [blame] | 169 | vcl_session_msg_t *accept_evts_fifo; |
Florin Coras | 47c40e2 | 2018-11-26 17:01:36 -0800 | [diff] [blame] | 170 | u32 shared_index; |
Florin Coras | 697faea | 2018-06-27 17:10:49 -0700 | [diff] [blame] | 171 | #if VCL_ELOG |
| 172 | elog_track_t elog_track; |
| 173 | #endif |
| 174 | } vcl_session_t; |
| 175 | |
| 176 | typedef struct vppcom_cfg_t_ |
| 177 | { |
| 178 | u64 heapsize; |
Florin Coras | 134a996 | 2018-08-28 11:32:04 -0700 | [diff] [blame] | 179 | u32 max_workers; |
Florin Coras | 697faea | 2018-06-27 17:10:49 -0700 | [diff] [blame] | 180 | u32 vpp_api_q_length; |
| 181 | u64 segment_baseva; |
| 182 | u32 segment_size; |
| 183 | u32 add_segment_size; |
| 184 | u32 preallocated_fifo_pairs; |
| 185 | u32 rx_fifo_size; |
| 186 | u32 tx_fifo_size; |
| 187 | u32 event_queue_size; |
| 188 | u32 listen_queue_size; |
| 189 | u8 app_proxy_transport_tcp; |
| 190 | u8 app_proxy_transport_udp; |
| 191 | u8 app_scope_local; |
| 192 | u8 app_scope_global; |
| 193 | u8 *namespace_id; |
| 194 | u64 namespace_secret; |
Florin Coras | 9936831 | 2018-08-02 10:45:44 -0700 | [diff] [blame] | 195 | u8 use_mq_eventfd; |
Florin Coras | 697faea | 2018-06-27 17:10:49 -0700 | [diff] [blame] | 196 | f64 app_timeout; |
| 197 | f64 session_timeout; |
| 198 | f64 accept_timeout; |
| 199 | u32 event_ring_size; |
| 200 | char *event_log_path; |
| 201 | u8 *vpp_api_filename; |
Florin Coras | 9936831 | 2018-08-02 10:45:44 -0700 | [diff] [blame] | 202 | u8 *vpp_api_socket_name; |
Florin Coras | 697faea | 2018-06-27 17:10:49 -0700 | [diff] [blame] | 203 | } vppcom_cfg_t; |
| 204 | |
| 205 | void vppcom_cfg (vppcom_cfg_t * vcl_cfg); |
| 206 | |
Florin Coras | 54693d2 | 2018-07-17 10:46:29 -0700 | [diff] [blame] | 207 | typedef struct vcl_cut_through_registration_ |
| 208 | { |
| 209 | svm_msg_q_t *mq; |
Florin Coras | 9936831 | 2018-08-02 10:45:44 -0700 | [diff] [blame] | 210 | svm_msg_q_t *peer_mq; |
Florin Coras | 54693d2 | 2018-07-17 10:46:29 -0700 | [diff] [blame] | 211 | u32 sid; |
Florin Coras | 9936831 | 2018-08-02 10:45:44 -0700 | [diff] [blame] | 212 | u32 epoll_evt_conn_index; /*< mq evt connection index part of |
| 213 | the mqs evtfd epoll (if used) */ |
Florin Coras | 54693d2 | 2018-07-17 10:46:29 -0700 | [diff] [blame] | 214 | } vcl_cut_through_registration_t; |
| 215 | |
Florin Coras | 9936831 | 2018-08-02 10:45:44 -0700 | [diff] [blame] | 216 | typedef struct vcl_mq_evt_conn_ |
| 217 | { |
| 218 | svm_msg_q_t *mq; |
| 219 | int mq_fd; |
| 220 | } vcl_mq_evt_conn_t; |
| 221 | |
Florin Coras | 134a996 | 2018-08-28 11:32:04 -0700 | [diff] [blame] | 222 | typedef struct vcl_worker_ |
Florin Coras | 697faea | 2018-06-27 17:10:49 -0700 | [diff] [blame] | 223 | { |
Florin Coras | 134a996 | 2018-08-28 11:32:04 -0700 | [diff] [blame] | 224 | CLIB_CACHE_LINE_ALIGN_MARK (cacheline0); |
Florin Coras | 697faea | 2018-06-27 17:10:49 -0700 | [diff] [blame] | 225 | |
Florin Coras | 697faea | 2018-06-27 17:10:49 -0700 | [diff] [blame] | 226 | /* Session pool */ |
Florin Coras | 697faea | 2018-06-27 17:10:49 -0700 | [diff] [blame] | 227 | vcl_session_t *sessions; |
| 228 | |
Florin Coras | 053a0e4 | 2018-11-13 15:52:38 -0800 | [diff] [blame] | 229 | /** Worker/thread index in current process */ |
Florin Coras | 134a996 | 2018-08-28 11:32:04 -0700 | [diff] [blame] | 230 | u32 wrk_index; |
| 231 | |
Florin Coras | 053a0e4 | 2018-11-13 15:52:38 -0800 | [diff] [blame] | 232 | /** Worker index in vpp*/ |
| 233 | u32 vpp_wrk_index; |
| 234 | |
Florin Coras | 47c40e2 | 2018-11-26 17:01:36 -0800 | [diff] [blame] | 235 | /** API client handle */ |
| 236 | u32 my_client_index; |
| 237 | |
| 238 | /** State of the connection, shared between msg RX thread and main thread */ |
| 239 | volatile app_state_t wrk_state; |
| 240 | |
| 241 | /** VPP binary api input queue */ |
| 242 | svm_queue_t *vl_input_queue; |
| 243 | |
Florin Coras | 9936831 | 2018-08-02 10:45:44 -0700 | [diff] [blame] | 244 | /** Message queues epoll fd. Initialized only if using mqs with eventfds */ |
| 245 | int mqs_epfd; |
| 246 | |
| 247 | /** Pool of event message queue event connections */ |
| 248 | vcl_mq_evt_conn_t *mq_evt_conns; |
| 249 | |
| 250 | /** Per worker buffer for receiving mq epoll events */ |
| 251 | struct epoll_event *mq_events; |
| 252 | |
Florin Coras | 134a996 | 2018-08-28 11:32:04 -0700 | [diff] [blame] | 253 | /** Hash table for disconnect processing */ |
Florin Coras | 697faea | 2018-06-27 17:10:49 -0700 | [diff] [blame] | 254 | uword *session_index_by_vpp_handles; |
| 255 | |
Florin Coras | 134a996 | 2018-08-28 11:32:04 -0700 | [diff] [blame] | 256 | /** Select bitmaps */ |
Florin Coras | 697faea | 2018-06-27 17:10:49 -0700 | [diff] [blame] | 257 | clib_bitmap_t *rd_bitmap; |
| 258 | clib_bitmap_t *wr_bitmap; |
| 259 | clib_bitmap_t *ex_bitmap; |
| 260 | |
Florin Coras | 134a996 | 2018-08-28 11:32:04 -0700 | [diff] [blame] | 261 | /** Our event message queue */ |
Florin Coras | 3c2fed5 | 2018-07-04 04:15:05 -0700 | [diff] [blame] | 262 | svm_msg_q_t *app_event_queue; |
Florin Coras | 697faea | 2018-06-27 17:10:49 -0700 | [diff] [blame] | 263 | |
Florin Coras | 134a996 | 2018-08-28 11:32:04 -0700 | [diff] [blame] | 264 | /** VPP workers event message queues */ |
Florin Coras | 9936831 | 2018-08-02 10:45:44 -0700 | [diff] [blame] | 265 | svm_msg_q_t **vpp_event_queues; |
| 266 | |
Florin Coras | 134a996 | 2018-08-28 11:32:04 -0700 | [diff] [blame] | 267 | /** For deadman timers */ |
Florin Coras | 697faea | 2018-06-27 17:10:49 -0700 | [diff] [blame] | 268 | clib_time_t clib_time; |
| 269 | |
Florin Coras | 54693d2 | 2018-07-17 10:46:29 -0700 | [diff] [blame] | 270 | /** Pool of cut through registrations */ |
| 271 | vcl_cut_through_registration_t *cut_through_registrations; |
| 272 | |
Florin Coras | 9936831 | 2018-08-02 10:45:44 -0700 | [diff] [blame] | 273 | /** Lock for accessing ct registration pool */ |
| 274 | clib_spinlock_t ct_registration_lock; |
| 275 | |
| 276 | /** Cut-through registration by mq address hash table */ |
| 277 | uword *ct_registration_by_mq; |
| 278 | |
Florin Coras | 134a996 | 2018-08-28 11:32:04 -0700 | [diff] [blame] | 279 | /** Vector acting as buffer for mq messages */ |
Florin Coras | 9936831 | 2018-08-02 10:45:44 -0700 | [diff] [blame] | 280 | svm_msg_q_msg_t *mq_msg_vector; |
Florin Coras | 3348a4c | 2018-09-07 17:09:35 -0700 | [diff] [blame] | 281 | |
Florin Coras | 86f0450 | 2018-09-12 16:08:01 -0700 | [diff] [blame] | 282 | /** Vector of unhandled events */ |
| 283 | session_event_t *unhandled_evts_vector; |
| 284 | |
Florin Coras | 3348a4c | 2018-09-07 17:09:35 -0700 | [diff] [blame] | 285 | /** Used also as a thread stop key buffer */ |
| 286 | pthread_t thread_id; |
Florin Coras | 47c40e2 | 2018-11-26 17:01:36 -0800 | [diff] [blame] | 287 | |
| 288 | /** Current pid, may be different from main_pid if forked child */ |
| 289 | pid_t current_pid; |
Florin Coras | 01f3f89 | 2018-12-02 12:45:53 -0800 | [diff] [blame] | 290 | |
| 291 | u32 forked_child; |
| 292 | |
Florin Coras | 134a996 | 2018-08-28 11:32:04 -0700 | [diff] [blame] | 293 | } vcl_worker_t; |
| 294 | |
| 295 | typedef struct vppcom_main_t_ |
| 296 | { |
| 297 | u8 is_init; |
| 298 | u32 debug; |
| 299 | pthread_t main_cpu; |
| 300 | |
Florin Coras | 053a0e4 | 2018-11-13 15:52:38 -0800 | [diff] [blame] | 301 | /** Main process pid */ |
| 302 | pid_t main_pid; |
| 303 | |
Florin Coras | c1f5a43 | 2018-11-20 11:31:26 -0800 | [diff] [blame] | 304 | /** App's index in vpp. It's used by vpp to identify the app */ |
| 305 | u32 app_index; |
Florin Coras | 134a996 | 2018-08-28 11:32:04 -0700 | [diff] [blame] | 306 | |
Florin Coras | 134a996 | 2018-08-28 11:32:04 -0700 | [diff] [blame] | 307 | /** State of the connection, shared between msg RX thread and main thread */ |
| 308 | volatile app_state_t app_state; |
| 309 | |
Florin Coras | 053a0e4 | 2018-11-13 15:52:38 -0800 | [diff] [blame] | 310 | u8 *app_name; |
| 311 | |
Florin Coras | 134a996 | 2018-08-28 11:32:04 -0700 | [diff] [blame] | 312 | /** VCL configuration */ |
| 313 | vppcom_cfg_t cfg; |
Florin Coras | 9936831 | 2018-08-02 10:45:44 -0700 | [diff] [blame] | 314 | |
Florin Coras | 47c40e2 | 2018-11-26 17:01:36 -0800 | [diff] [blame] | 315 | volatile u32 forking; |
| 316 | |
Florin Coras | 134a996 | 2018-08-28 11:32:04 -0700 | [diff] [blame] | 317 | /** Workers */ |
| 318 | vcl_worker_t *workers; |
| 319 | |
Florin Coras | de9f08b | 2018-09-07 14:32:58 -0700 | [diff] [blame] | 320 | /** Lock to protect worker registrations */ |
| 321 | clib_spinlock_t workers_lock; |
| 322 | |
Florin Coras | d85de68 | 2018-11-29 17:02:29 -0800 | [diff] [blame] | 323 | /** Pool of shared sessions */ |
Florin Coras | 47c40e2 | 2018-11-26 17:01:36 -0800 | [diff] [blame] | 324 | vcl_shared_session_t *shared_sessions; |
Florin Coras | d85de68 | 2018-11-29 17:02:29 -0800 | [diff] [blame] | 325 | |
| 326 | /** Lock to protect segment hash table */ |
| 327 | clib_rwlock_t segment_table_lock; |
| 328 | |
| 329 | /** Mapped segments table */ |
| 330 | uword *segment_table; |
| 331 | |
Florin Coras | adc74d7 | 2018-12-02 13:36:00 -0800 | [diff] [blame] | 332 | svm_fifo_segment_main_t segment_main; |
| 333 | |
Florin Coras | 697faea | 2018-06-27 17:10:49 -0700 | [diff] [blame] | 334 | #ifdef VCL_ELOG |
| 335 | /* VPP Event-logger */ |
| 336 | elog_main_t elog_main; |
| 337 | elog_track_t elog_track; |
| 338 | #endif |
| 339 | |
| 340 | /* VNET_API_ERROR_FOO -> "Foo" hash table */ |
| 341 | uword *error_string_by_error_number; |
Florin Coras | 134a996 | 2018-08-28 11:32:04 -0700 | [diff] [blame] | 342 | |
Florin Coras | 697faea | 2018-06-27 17:10:49 -0700 | [diff] [blame] | 343 | } vppcom_main_t; |
| 344 | |
| 345 | extern vppcom_main_t *vcm; |
| 346 | |
Florin Coras | 54693d2 | 2018-07-17 10:46:29 -0700 | [diff] [blame] | 347 | #define VCL_INVALID_SESSION_INDEX ((u32)~0) |
Florin Coras | d85de68 | 2018-11-29 17:02:29 -0800 | [diff] [blame] | 348 | #define VCL_INVALID_SEGMENT_INDEX ((u32)~0) |
| 349 | #define VCL_INVALID_SEGMENT_HANDLE ((u64)~0) |
Florin Coras | 54693d2 | 2018-07-17 10:46:29 -0700 | [diff] [blame] | 350 | |
| 351 | static inline vcl_session_t * |
Florin Coras | 134a996 | 2018-08-28 11:32:04 -0700 | [diff] [blame] | 352 | vcl_session_alloc (vcl_worker_t * wrk) |
Florin Coras | 9936831 | 2018-08-02 10:45:44 -0700 | [diff] [blame] | 353 | { |
| 354 | vcl_session_t *s; |
Florin Coras | 134a996 | 2018-08-28 11:32:04 -0700 | [diff] [blame] | 355 | pool_get (wrk->sessions, s); |
Florin Coras | 9936831 | 2018-08-02 10:45:44 -0700 | [diff] [blame] | 356 | memset (s, 0, sizeof (*s)); |
Florin Coras | 134a996 | 2018-08-28 11:32:04 -0700 | [diff] [blame] | 357 | s->session_index = s - wrk->sessions; |
Florin Coras | 47c40e2 | 2018-11-26 17:01:36 -0800 | [diff] [blame] | 358 | s->shared_index = ~0; |
Florin Coras | 9936831 | 2018-08-02 10:45:44 -0700 | [diff] [blame] | 359 | return s; |
| 360 | } |
| 361 | |
| 362 | static inline void |
Florin Coras | 134a996 | 2018-08-28 11:32:04 -0700 | [diff] [blame] | 363 | vcl_session_free (vcl_worker_t * wrk, vcl_session_t * s) |
Florin Coras | 9936831 | 2018-08-02 10:45:44 -0700 | [diff] [blame] | 364 | { |
Florin Coras | 134a996 | 2018-08-28 11:32:04 -0700 | [diff] [blame] | 365 | pool_put (wrk->sessions, s); |
Florin Coras | 9936831 | 2018-08-02 10:45:44 -0700 | [diff] [blame] | 366 | } |
| 367 | |
| 368 | static inline vcl_session_t * |
Florin Coras | 134a996 | 2018-08-28 11:32:04 -0700 | [diff] [blame] | 369 | vcl_session_get (vcl_worker_t * wrk, u32 session_index) |
Florin Coras | 54693d2 | 2018-07-17 10:46:29 -0700 | [diff] [blame] | 370 | { |
Florin Coras | 134a996 | 2018-08-28 11:32:04 -0700 | [diff] [blame] | 371 | if (pool_is_free_index (wrk->sessions, session_index)) |
Florin Coras | 54693d2 | 2018-07-17 10:46:29 -0700 | [diff] [blame] | 372 | return 0; |
Florin Coras | 134a996 | 2018-08-28 11:32:04 -0700 | [diff] [blame] | 373 | return pool_elt_at_index (wrk->sessions, session_index); |
Florin Coras | 54693d2 | 2018-07-17 10:46:29 -0700 | [diff] [blame] | 374 | } |
| 375 | |
Florin Coras | 134a996 | 2018-08-28 11:32:04 -0700 | [diff] [blame] | 376 | static inline int |
| 377 | vcl_session_handle (vcl_session_t * s) |
Florin Coras | 54693d2 | 2018-07-17 10:46:29 -0700 | [diff] [blame] | 378 | { |
Florin Coras | 134a996 | 2018-08-28 11:32:04 -0700 | [diff] [blame] | 379 | ASSERT (s->session_index < 2 << 24); |
| 380 | return (vcl_get_worker_index () << 24 | s->session_index); |
| 381 | } |
| 382 | |
| 383 | static inline void |
| 384 | vcl_session_handle_parse (u32 handle, u32 * wrk_index, u32 * session_index) |
| 385 | { |
| 386 | *wrk_index = handle >> 24; |
| 387 | *session_index = handle & 0xFFFFFF; |
Florin Coras | 54693d2 | 2018-07-17 10:46:29 -0700 | [diff] [blame] | 388 | } |
| 389 | |
| 390 | static inline vcl_session_t * |
Florin Coras | 134a996 | 2018-08-28 11:32:04 -0700 | [diff] [blame] | 391 | vcl_session_get_w_handle (vcl_worker_t * wrk, u32 session_handle) |
| 392 | { |
| 393 | u32 session_index, wrk_index; |
| 394 | vcl_session_handle_parse (session_handle, &wrk_index, &session_index); |
| 395 | ASSERT (wrk_index == wrk->wrk_index); |
| 396 | return vcl_session_get (wrk, session_index); |
| 397 | } |
| 398 | |
| 399 | static inline vcl_session_t * |
| 400 | vcl_session_get_w_vpp_handle (vcl_worker_t * wrk, u64 vpp_handle) |
Florin Coras | 54693d2 | 2018-07-17 10:46:29 -0700 | [diff] [blame] | 401 | { |
| 402 | uword *p; |
Florin Coras | 134a996 | 2018-08-28 11:32:04 -0700 | [diff] [blame] | 403 | if ((p = hash_get (wrk->session_index_by_vpp_handles, vpp_handle))) |
| 404 | return vcl_session_get (wrk, (u32) p[0]); |
Florin Coras | 54693d2 | 2018-07-17 10:46:29 -0700 | [diff] [blame] | 405 | return 0; |
| 406 | } |
| 407 | |
| 408 | static inline u32 |
Florin Coras | 134a996 | 2018-08-28 11:32:04 -0700 | [diff] [blame] | 409 | vcl_session_index_from_vpp_handle (vcl_worker_t * wrk, u64 vpp_handle) |
Florin Coras | 54693d2 | 2018-07-17 10:46:29 -0700 | [diff] [blame] | 410 | { |
| 411 | uword *p; |
Florin Coras | 134a996 | 2018-08-28 11:32:04 -0700 | [diff] [blame] | 412 | if ((p = hash_get (wrk->session_index_by_vpp_handles, vpp_handle))) |
Florin Coras | 54693d2 | 2018-07-17 10:46:29 -0700 | [diff] [blame] | 413 | return p[0]; |
| 414 | return VCL_INVALID_SESSION_INDEX; |
| 415 | } |
| 416 | |
Florin Coras | 134a996 | 2018-08-28 11:32:04 -0700 | [diff] [blame] | 417 | static inline void |
| 418 | vcl_session_table_add_vpp_handle (vcl_worker_t * wrk, u64 handle, u32 value) |
| 419 | { |
| 420 | hash_set (wrk->session_index_by_vpp_handles, handle, value); |
| 421 | } |
| 422 | |
| 423 | static inline void |
| 424 | vcl_session_table_del_vpp_handle (vcl_worker_t * wrk, u64 vpp_handle) |
| 425 | { |
| 426 | hash_unset (wrk->session_index_by_vpp_handles, vpp_handle); |
| 427 | } |
| 428 | |
| 429 | static inline uword * |
| 430 | vcl_session_table_lookup_vpp_handle (vcl_worker_t * wrk, u64 handle) |
| 431 | { |
| 432 | return hash_get (wrk->session_index_by_vpp_handles, handle); |
| 433 | } |
| 434 | |
| 435 | static inline void |
| 436 | vcl_session_table_add_listener (vcl_worker_t * wrk, u64 listener_handle, |
| 437 | u32 value) |
| 438 | { |
| 439 | /* Session and listener handles have different formats. The latter has |
| 440 | * the thread index in the upper 32 bits while the former has the session |
| 441 | * type. Knowing that, for listeners we just flip the MSB to 1 */ |
| 442 | listener_handle |= 1ULL << 63; |
| 443 | hash_set (wrk->session_index_by_vpp_handles, listener_handle, value); |
| 444 | } |
| 445 | |
| 446 | static inline void |
| 447 | vcl_session_table_del_listener (vcl_worker_t * wrk, u64 listener_handle) |
| 448 | { |
| 449 | listener_handle |= 1ULL << 63; |
| 450 | hash_unset (wrk->session_index_by_vpp_handles, listener_handle); |
| 451 | } |
| 452 | |
| 453 | static inline vcl_session_t * |
| 454 | vcl_session_table_lookup_listener (vcl_worker_t * wrk, u64 listener_handle) |
| 455 | { |
| 456 | uword *p; |
| 457 | u64 handle = listener_handle | (1ULL << 63); |
| 458 | vcl_session_t *session; |
| 459 | |
| 460 | p = hash_get (wrk->session_index_by_vpp_handles, handle); |
| 461 | if (!p) |
| 462 | { |
| 463 | clib_warning ("VCL<%d>: couldn't find listen session: unknown vpp " |
| 464 | "listener handle %llx", getpid (), listener_handle); |
| 465 | return 0; |
| 466 | } |
| 467 | if (pool_is_free_index (wrk->sessions, p[0])) |
| 468 | { |
| 469 | VDBG (1, "VCL<%d>: invalid listen session, sid (%u)", getpid (), p[0]); |
| 470 | return 0; |
| 471 | } |
| 472 | |
| 473 | session = pool_elt_at_index (wrk->sessions, p[0]); |
| 474 | ASSERT (session->session_state & STATE_LISTEN); |
| 475 | return session; |
| 476 | } |
| 477 | |
| 478 | const char *vppcom_session_state_str (session_state_t state); |
| 479 | |
Florin Coras | 460dce6 | 2018-07-27 05:45:06 -0700 | [diff] [blame] | 480 | static inline u8 |
| 481 | vcl_session_is_ct (vcl_session_t * s) |
| 482 | { |
| 483 | return (s->our_evt_q != 0); |
| 484 | } |
| 485 | |
Florin Coras | 697faea | 2018-06-27 17:10:49 -0700 | [diff] [blame] | 486 | /* |
Florin Coras | 9936831 | 2018-08-02 10:45:44 -0700 | [diff] [blame] | 487 | * Helpers |
| 488 | */ |
Florin Coras | 134a996 | 2018-08-28 11:32:04 -0700 | [diff] [blame] | 489 | int vcl_wait_for_app_state_change (app_state_t app_state); |
| 490 | vcl_cut_through_registration_t |
| 491 | * vcl_ct_registration_lock_and_alloc (vcl_worker_t * wrk); |
| 492 | void vcl_ct_registration_del (vcl_worker_t * wrk, |
| 493 | vcl_cut_through_registration_t * ctr); |
| 494 | u32 vcl_ct_registration_index (vcl_worker_t * wrk, |
| 495 | vcl_cut_through_registration_t * ctr); |
| 496 | void vcl_ct_registration_lock (vcl_worker_t * wrk); |
| 497 | void vcl_ct_registration_unlock (vcl_worker_t * wrk); |
| 498 | vcl_cut_through_registration_t |
| 499 | * vcl_ct_registration_lock_and_lookup (vcl_worker_t * wrk, uword mq_addr); |
| 500 | void vcl_ct_registration_lookup_add (vcl_worker_t * wrk, uword mq_addr, |
| 501 | u32 ctr_index); |
| 502 | void vcl_ct_registration_lookup_del (vcl_worker_t * wrk, uword mq_addr); |
| 503 | vcl_mq_evt_conn_t *vcl_mq_evt_conn_alloc (vcl_worker_t * wrk); |
| 504 | u32 vcl_mq_evt_conn_index (vcl_worker_t * wrk, vcl_mq_evt_conn_t * mqc); |
| 505 | vcl_mq_evt_conn_t *vcl_mq_evt_conn_get (vcl_worker_t * wrk, u32 mq_conn_idx); |
| 506 | int vcl_mq_epoll_add_evfd (vcl_worker_t * wrk, svm_msg_q_t * mq); |
| 507 | int vcl_mq_epoll_del_evfd (vcl_worker_t * wrk, u32 mqc_index); |
| 508 | |
| 509 | vcl_worker_t *vcl_worker_alloc_and_init (void); |
Florin Coras | 01f3f89 | 2018-12-02 12:45:53 -0800 | [diff] [blame] | 510 | void vcl_worker_cleanup (vcl_worker_t * wrk, u8 notify_vpp); |
Florin Coras | 47c40e2 | 2018-11-26 17:01:36 -0800 | [diff] [blame] | 511 | int vcl_worker_register_with_vpp (void); |
| 512 | int vcl_worker_set_bapi (void); |
Florin Coras | 01f3f89 | 2018-12-02 12:45:53 -0800 | [diff] [blame] | 513 | void vcl_worker_share_sessions (vcl_worker_t * parent_wrk); |
Florin Coras | 47c40e2 | 2018-11-26 17:01:36 -0800 | [diff] [blame] | 514 | int vcl_worker_unshare_session (vcl_worker_t * wrk, vcl_session_t * s); |
| 515 | int vcl_session_get_refcnt (vcl_session_t * s); |
Florin Coras | 134a996 | 2018-08-28 11:32:04 -0700 | [diff] [blame] | 516 | |
Florin Coras | d85de68 | 2018-11-29 17:02:29 -0800 | [diff] [blame] | 517 | void vcl_segment_table_add (u64 segment_handle, u32 svm_segment_index); |
| 518 | u32 vcl_segment_table_lookup (u64 segment_handle); |
| 519 | void vcl_segment_table_del (u64 segment_handle); |
| 520 | |
Florin Coras | 134a996 | 2018-08-28 11:32:04 -0700 | [diff] [blame] | 521 | static inline vcl_worker_t * |
| 522 | vcl_worker_get (u32 wrk_index) |
| 523 | { |
| 524 | return pool_elt_at_index (vcm->workers, wrk_index); |
| 525 | } |
| 526 | |
| 527 | static inline vcl_worker_t * |
Florin Coras | 01f3f89 | 2018-12-02 12:45:53 -0800 | [diff] [blame] | 528 | vcl_worker_get_if_valid (u32 wrk_index) |
| 529 | { |
| 530 | if (pool_is_free_index (vcm->workers, wrk_index)) |
| 531 | return 0; |
| 532 | return pool_elt_at_index (vcm->workers, wrk_index); |
| 533 | } |
| 534 | |
| 535 | static inline vcl_worker_t * |
Florin Coras | 134a996 | 2018-08-28 11:32:04 -0700 | [diff] [blame] | 536 | vcl_worker_get_current (void) |
| 537 | { |
| 538 | return vcl_worker_get (vcl_get_worker_index ()); |
| 539 | } |
Florin Coras | 9936831 | 2018-08-02 10:45:44 -0700 | [diff] [blame] | 540 | |
| 541 | /* |
Florin Coras | 697faea | 2018-06-27 17:10:49 -0700 | [diff] [blame] | 542 | * VCL Binary API |
| 543 | */ |
| 544 | int vppcom_connect_to_vpp (char *app_name); |
| 545 | void vppcom_init_error_string_table (void); |
| 546 | void vppcom_send_session_enable_disable (u8 is_enable); |
| 547 | void vppcom_app_send_attach (void); |
| 548 | void vppcom_app_send_detach (void); |
Florin Coras | 134a996 | 2018-08-28 11:32:04 -0700 | [diff] [blame] | 549 | void vppcom_send_connect_sock (vcl_session_t * session); |
Florin Coras | ab2f6db | 2018-08-31 14:31:41 -0700 | [diff] [blame] | 550 | void vppcom_send_disconnect_session (u64 vpp_handle); |
Florin Coras | 134a996 | 2018-08-28 11:32:04 -0700 | [diff] [blame] | 551 | void vppcom_send_bind_sock (vcl_session_t * session); |
Florin Coras | 697faea | 2018-06-27 17:10:49 -0700 | [diff] [blame] | 552 | void vppcom_send_unbind_sock (u64 vpp_handle); |
| 553 | void vppcom_api_hookup (void); |
Florin Coras | 134a996 | 2018-08-28 11:32:04 -0700 | [diff] [blame] | 554 | void vppcom_send_accept_session_reply (u64 vpp_handle, u32 context, int rv); |
| 555 | void vcl_send_app_worker_add_del (u8 is_add); |
Florin Coras | 01f3f89 | 2018-12-02 12:45:53 -0800 | [diff] [blame] | 556 | void vcl_send_child_worker_del (vcl_worker_t * wrk); |
Florin Coras | 697faea | 2018-06-27 17:10:49 -0700 | [diff] [blame] | 557 | |
| 558 | u32 vcl_max_nsid_len (void); |
| 559 | |
Florin Coras | 54693d2 | 2018-07-17 10:46:29 -0700 | [diff] [blame] | 560 | u8 *format_api_error (u8 * s, va_list * args); |
| 561 | |
Florin Coras | 697faea | 2018-06-27 17:10:49 -0700 | [diff] [blame] | 562 | #endif /* SRC_VCL_VCL_PRIVATE_H_ */ |
| 563 | |
| 564 | /* |
| 565 | * fd.io coding-style-patch-verification: ON |
| 566 | * |
| 567 | * Local Variables: |
| 568 | * eval: (c-set-style "gnu") |
| 569 | * End: |
| 570 | */ |