2 * Copyright (c) 2018 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,
70 STATE_CLOSE_ON_EMPTY = 0x10,
71 STATE_DISCONNECT = 0x20,
75 #define SERVER_STATE_OPEN (STATE_ACCEPT|STATE_CLOSE_ON_EMPTY)
76 #define CLIENT_STATE_OPEN (STATE_CONNECT|STATE_CLOSE_ON_EMPTY)
77 #define STATE_OPEN (SERVER_STATE_OPEN | CLIENT_STATE_OPEN)
79 typedef struct epoll_event vppcom_epoll_event_t;
86 vppcom_epoll_event_t ev;
87 #define VEP_DEFAULT_ET_MASK (EPOLLIN|EPOLLOUT)
88 #define VEP_UNSUPPORTED_EVENTS (EPOLLONESHOT|EPOLLEXCLUSIVE)
98 typedef struct vcl_session_msg
103 session_accepted_msg_t accepted_msg;
109 VCL_SESS_ATTR_SERVER,
110 VCL_SESS_ATTR_CUT_THRU,
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
124 } vppcom_session_attr_t;
126 #define VCL_SESS_ATTR_SET(ATTR, VAL) \
128 (ATTR) |= 1 << (VAL); \
131 #define VCL_SESS_ATTR_CLR(ATTR, VAL) \
133 (ATTR) &= ~(1 << (VAL)); \
136 #define VCL_SESS_ATTR_TEST(ATTR, VAL) \
137 ((ATTR) & (1 << (VAL)) ? 1 : 0)
139 typedef struct vcl_shared_session_
143 } vcl_shared_session_t;
147 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
148 #define _(type, name) type name;
149 foreach_app_session_field
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)
159 /* Socket configuration state */
167 svm_msg_q_t *our_evt_q;
169 vcl_session_msg_t *accept_evts_fifo;
172 elog_track_t elog_track;
176 typedef struct vppcom_cfg_t_
180 u32 vpp_api_q_length;
183 u32 add_segment_size;
184 u32 preallocated_fifo_pairs;
187 u32 event_queue_size;
188 u32 listen_queue_size;
189 u8 app_proxy_transport_tcp;
190 u8 app_proxy_transport_udp;
194 u64 namespace_secret;
200 char *event_log_path;
201 u8 *vpp_api_filename;
202 u8 *vpp_api_socket_name;
205 void vppcom_cfg (vppcom_cfg_t * vcl_cfg);
207 typedef struct vcl_cut_through_registration_
210 svm_msg_q_t *peer_mq;
212 u32 epoll_evt_conn_index; /*< mq evt connection index part of
213 the mqs evtfd epoll (if used) */
214 } vcl_cut_through_registration_t;
216 typedef struct vcl_mq_evt_conn_
222 typedef struct vcl_worker_
224 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
227 vcl_session_t *sessions;
229 /** Worker/thread index in current process */
232 /** Worker index in vpp*/
235 /** API client handle */
238 /** State of the connection, shared between msg RX thread and main thread */
239 volatile app_state_t wrk_state;
241 /** VPP binary api input queue */
242 svm_queue_t *vl_input_queue;
244 /** Message queues epoll fd. Initialized only if using mqs with eventfds */
247 /** Pool of event message queue event connections */
248 vcl_mq_evt_conn_t *mq_evt_conns;
250 /** Per worker buffer for receiving mq epoll events */
251 struct epoll_event *mq_events;
253 /** Hash table for disconnect processing */
254 uword *session_index_by_vpp_handles;
256 /** Select bitmaps */
257 clib_bitmap_t *rd_bitmap;
258 clib_bitmap_t *wr_bitmap;
259 clib_bitmap_t *ex_bitmap;
261 /** Our event message queue */
262 svm_msg_q_t *app_event_queue;
264 /** VPP workers event message queues */
265 svm_msg_q_t **vpp_event_queues;
267 /** For deadman timers */
268 clib_time_t clib_time;
270 /** Pool of cut through registrations */
271 vcl_cut_through_registration_t *cut_through_registrations;
273 /** Lock for accessing ct registration pool */
274 clib_spinlock_t ct_registration_lock;
276 /** Cut-through registration by mq address hash table */
277 uword *ct_registration_by_mq;
279 /** Vector acting as buffer for mq messages */
280 svm_msg_q_msg_t *mq_msg_vector;
282 /** Vector of unhandled events */
283 session_event_t *unhandled_evts_vector;
285 /** Used also as a thread stop key buffer */
288 /** Current pid, may be different from main_pid if forked child */
295 typedef struct vppcom_main_t_
301 /** Main process pid */
304 /** App's index in vpp. It's used by vpp to identify the app */
307 /** State of the connection, shared between msg RX thread and main thread */
308 volatile app_state_t app_state;
312 /** VCL configuration */
315 volatile u32 forking;
318 vcl_worker_t *workers;
320 /** Lock to protect worker registrations */
321 clib_spinlock_t workers_lock;
323 /** Pool of shared sessions */
324 vcl_shared_session_t *shared_sessions;
326 /** Lock to protect segment hash table */
327 clib_rwlock_t segment_table_lock;
329 /** Mapped segments table */
330 uword *segment_table;
332 svm_fifo_segment_main_t segment_main;
335 /* VPP Event-logger */
336 elog_main_t elog_main;
337 elog_track_t elog_track;
340 /* VNET_API_ERROR_FOO -> "Foo" hash table */
341 uword *error_string_by_error_number;
345 extern vppcom_main_t *vcm;
347 #define VCL_INVALID_SESSION_INDEX ((u32)~0)
348 #define VCL_INVALID_SEGMENT_INDEX ((u32)~0)
349 #define VCL_INVALID_SEGMENT_HANDLE ((u64)~0)
351 static inline vcl_session_t *
352 vcl_session_alloc (vcl_worker_t * wrk)
355 pool_get (wrk->sessions, s);
356 memset (s, 0, sizeof (*s));
357 s->session_index = s - wrk->sessions;
358 s->shared_index = ~0;
363 vcl_session_free (vcl_worker_t * wrk, vcl_session_t * s)
365 pool_put (wrk->sessions, s);
368 static inline vcl_session_t *
369 vcl_session_get (vcl_worker_t * wrk, u32 session_index)
371 if (pool_is_free_index (wrk->sessions, session_index))
373 return pool_elt_at_index (wrk->sessions, session_index);
377 vcl_session_handle (vcl_session_t * s)
379 ASSERT (s->session_index < 2 << 24);
380 return (vcl_get_worker_index () << 24 | s->session_index);
384 vcl_session_handle_parse (u32 handle, u32 * wrk_index, u32 * session_index)
386 *wrk_index = handle >> 24;
387 *session_index = handle & 0xFFFFFF;
390 static inline vcl_session_t *
391 vcl_session_get_w_handle (vcl_worker_t * wrk, u32 session_handle)
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);
399 static inline vcl_session_t *
400 vcl_session_get_w_vpp_handle (vcl_worker_t * wrk, u64 vpp_handle)
403 if ((p = hash_get (wrk->session_index_by_vpp_handles, vpp_handle)))
404 return vcl_session_get (wrk, (u32) p[0]);
409 vcl_session_index_from_vpp_handle (vcl_worker_t * wrk, u64 vpp_handle)
412 if ((p = hash_get (wrk->session_index_by_vpp_handles, vpp_handle)))
414 return VCL_INVALID_SESSION_INDEX;
418 vcl_session_table_add_vpp_handle (vcl_worker_t * wrk, u64 handle, u32 value)
420 hash_set (wrk->session_index_by_vpp_handles, handle, value);
424 vcl_session_table_del_vpp_handle (vcl_worker_t * wrk, u64 vpp_handle)
426 hash_unset (wrk->session_index_by_vpp_handles, vpp_handle);
429 static inline uword *
430 vcl_session_table_lookup_vpp_handle (vcl_worker_t * wrk, u64 handle)
432 return hash_get (wrk->session_index_by_vpp_handles, handle);
436 vcl_session_table_add_listener (vcl_worker_t * wrk, u64 listener_handle,
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);
447 vcl_session_table_del_listener (vcl_worker_t * wrk, u64 listener_handle)
449 listener_handle |= 1ULL << 63;
450 hash_unset (wrk->session_index_by_vpp_handles, listener_handle);
453 static inline vcl_session_t *
454 vcl_session_table_lookup_listener (vcl_worker_t * wrk, u64 listener_handle)
457 u64 handle = listener_handle | (1ULL << 63);
458 vcl_session_t *session;
460 p = hash_get (wrk->session_index_by_vpp_handles, handle);
463 clib_warning ("VCL<%d>: couldn't find listen session: unknown vpp "
464 "listener handle %llx", getpid (), listener_handle);
467 if (pool_is_free_index (wrk->sessions, p[0]))
469 VDBG (1, "VCL<%d>: invalid listen session, sid (%u)", getpid (), p[0]);
473 session = pool_elt_at_index (wrk->sessions, p[0]);
474 ASSERT (session->session_state & STATE_LISTEN);
478 const char *vppcom_session_state_str (session_state_t state);
481 vcl_session_is_ct (vcl_session_t * s)
483 return (s->our_evt_q != 0);
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,
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);
509 vcl_worker_t *vcl_worker_alloc_and_init (void);
510 void vcl_worker_cleanup (vcl_worker_t * wrk, u8 notify_vpp);
511 int vcl_worker_register_with_vpp (void);
512 int vcl_worker_set_bapi (void);
513 void vcl_worker_share_sessions (vcl_worker_t * parent_wrk);
514 int vcl_worker_unshare_session (vcl_worker_t * wrk, vcl_session_t * s);
515 int vcl_session_get_refcnt (vcl_session_t * s);
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);
521 static inline vcl_worker_t *
522 vcl_worker_get (u32 wrk_index)
524 return pool_elt_at_index (vcm->workers, wrk_index);
527 static inline vcl_worker_t *
528 vcl_worker_get_if_valid (u32 wrk_index)
530 if (pool_is_free_index (vcm->workers, wrk_index))
532 return pool_elt_at_index (vcm->workers, wrk_index);
535 static inline vcl_worker_t *
536 vcl_worker_get_current (void)
538 return vcl_worker_get (vcl_get_worker_index ());
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);
549 void vppcom_send_connect_sock (vcl_session_t * session);
550 void vppcom_send_disconnect_session (u64 vpp_handle);
551 void vppcom_send_bind_sock (vcl_session_t * session);
552 void vppcom_send_unbind_sock (u64 vpp_handle);
553 void vppcom_api_hookup (void);
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);
556 void vcl_send_child_worker_del (vcl_worker_t * wrk);
558 u32 vcl_max_nsid_len (void);
560 u8 *format_api_error (u8 * s, va_list * args);
562 #endif /* SRC_VCL_VCL_PRIVATE_H_ */
565 * fd.io coding-style-patch-verification: ON
568 * eval: (c-set-style "gnu")