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_VPP_CLOSING = 0x10,
71 STATE_DISCONNECT = 0x20,
75 #define SERVER_STATE_OPEN (STATE_ACCEPT|STATE_VPP_CLOSING)
76 #define CLIENT_STATE_OPEN (STATE_CONNECT|STATE_VPP_CLOSING)
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 #define VCL_ACCEPTED_F_CLOSED (1 << 0)
99 #define VCL_ACCEPTED_F_RESET (1 << 1)
101 typedef struct vcl_session_msg
106 session_accepted_msg_t accepted_msg;
113 VCL_SESS_ATTR_SERVER,
114 VCL_SESS_ATTR_CUT_THRU,
116 VCL_SESS_ATTR_VEP_SESSION,
117 VCL_SESS_ATTR_LISTEN, // SOL_SOCKET,SO_ACCEPTCONN
118 VCL_SESS_ATTR_NONBLOCK, // fcntl,O_NONBLOCK
119 VCL_SESS_ATTR_REUSEADDR, // SOL_SOCKET,SO_REUSEADDR
120 VCL_SESS_ATTR_REUSEPORT, // SOL_SOCKET,SO_REUSEPORT
121 VCL_SESS_ATTR_BROADCAST, // SOL_SOCKET,SO_BROADCAST
122 VCL_SESS_ATTR_V6ONLY, // SOL_TCP,IPV6_V6ONLY
123 VCL_SESS_ATTR_KEEPALIVE, // SOL_SOCKET,SO_KEEPALIVE
124 VCL_SESS_ATTR_TCP_NODELAY, // SOL_TCP,TCP_NODELAY
125 VCL_SESS_ATTR_TCP_KEEPIDLE, // SOL_TCP,TCP_KEEPIDLE
126 VCL_SESS_ATTR_TCP_KEEPINTVL, // SOL_TCP,TCP_KEEPINTVL
128 } vppcom_session_attr_t;
130 #define VCL_SESS_ATTR_SET(ATTR, VAL) \
132 (ATTR) |= 1 << (VAL); \
135 #define VCL_SESS_ATTR_CLR(ATTR, VAL) \
137 (ATTR) &= ~(1 << (VAL)); \
140 #define VCL_SESS_ATTR_TEST(ATTR, VAL) \
141 ((ATTR) & (1 << (VAL)) ? 1 : 0)
143 typedef struct vcl_shared_session_
147 } vcl_shared_session_t;
151 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
152 #define _(type, name) type name;
153 foreach_app_session_field
155 u32 sndbuf_size; // VPP-TBD: Hack until support setsockopt(SO_SNDBUF)
156 u32 rcvbuf_size; // VPP-TBD: Hack until support setsockopt(SO_RCVBUF)
157 u32 user_mss; // VPP-TBD: Hack until support setsockopt(TCP_MAXSEG)
162 u32 vpp_thread_index;
164 /* Socket configuration state */
172 svm_msg_q_t *our_evt_q;
174 vcl_session_msg_t *accept_evts_fifo;
177 elog_track_t elog_track;
181 typedef struct vppcom_cfg_t_
185 u32 vpp_api_q_length;
188 u32 add_segment_size;
189 u32 preallocated_fifo_pairs;
192 u32 event_queue_size;
193 u32 listen_queue_size;
194 u8 app_proxy_transport_tcp;
195 u8 app_proxy_transport_udp;
199 u64 namespace_secret;
205 char *event_log_path;
206 u8 *vpp_api_filename;
207 u8 *vpp_api_socket_name;
210 void vppcom_cfg (vppcom_cfg_t * vcl_cfg);
212 typedef struct vcl_cut_through_registration_
215 svm_msg_q_t *peer_mq;
217 u32 epoll_evt_conn_index; /*< mq evt connection index part of
218 the mqs evtfd epoll (if used) */
219 } vcl_cut_through_registration_t;
221 typedef struct vcl_mq_evt_conn_
227 typedef struct vcl_worker_
229 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
232 vcl_session_t *sessions;
234 /** Worker/thread index in current process */
237 /** Worker index in vpp*/
240 /** API client handle */
243 /** State of the connection, shared between msg RX thread and main thread */
244 volatile app_state_t wrk_state;
246 /** VPP binary api input queue */
247 svm_queue_t *vl_input_queue;
249 /** Message queues epoll fd. Initialized only if using mqs with eventfds */
252 /** Pool of event message queue event connections */
253 vcl_mq_evt_conn_t *mq_evt_conns;
255 /** Per worker buffer for receiving mq epoll events */
256 struct epoll_event *mq_events;
258 /** Hash table for disconnect processing */
259 uword *session_index_by_vpp_handles;
261 /** Select bitmaps */
262 clib_bitmap_t *rd_bitmap;
263 clib_bitmap_t *wr_bitmap;
264 clib_bitmap_t *ex_bitmap;
266 /** Our event message queue */
267 svm_msg_q_t *app_event_queue;
269 /** VPP workers event message queues */
270 svm_msg_q_t **vpp_event_queues;
272 /** For deadman timers */
273 clib_time_t clib_time;
275 /** Pool of cut through registrations */
276 vcl_cut_through_registration_t *cut_through_registrations;
278 /** Lock for accessing ct registration pool */
279 clib_spinlock_t ct_registration_lock;
281 /** Cut-through registration by mq address hash table */
282 uword *ct_registration_by_mq;
284 /** Vector acting as buffer for mq messages */
285 svm_msg_q_msg_t *mq_msg_vector;
287 /** Vector of unhandled events */
288 session_event_t *unhandled_evts_vector;
290 /** Used also as a thread stop key buffer */
293 /** Current pid, may be different from main_pid if forked child */
300 typedef struct vppcom_main_t_
306 /** Main process pid */
309 /** App's index in vpp. It's used by vpp to identify the app */
312 /** State of the connection, shared between msg RX thread and main thread */
313 volatile app_state_t app_state;
317 /** VCL configuration */
320 volatile u32 forking;
323 vcl_worker_t *workers;
325 /** Lock to protect worker registrations */
326 clib_spinlock_t workers_lock;
328 /** Pool of shared sessions */
329 vcl_shared_session_t *shared_sessions;
331 /** Lock to protect segment hash table */
332 clib_rwlock_t segment_table_lock;
334 /** Mapped segments table */
335 uword *segment_table;
337 svm_fifo_segment_main_t segment_main;
340 /* VPP Event-logger */
341 elog_main_t elog_main;
342 elog_track_t elog_track;
345 /* VNET_API_ERROR_FOO -> "Foo" hash table */
346 uword *error_string_by_error_number;
350 extern vppcom_main_t *vcm;
352 #define VCL_INVALID_SESSION_INDEX ((u32)~0)
353 #define VCL_INVALID_SEGMENT_INDEX ((u32)~0)
354 #define VCL_INVALID_SEGMENT_HANDLE ((u64)~0)
356 static inline vcl_session_t *
357 vcl_session_alloc (vcl_worker_t * wrk)
360 pool_get (wrk->sessions, s);
361 memset (s, 0, sizeof (*s));
362 s->session_index = s - wrk->sessions;
363 s->shared_index = ~0;
368 vcl_session_free (vcl_worker_t * wrk, vcl_session_t * s)
370 pool_put (wrk->sessions, s);
373 static inline vcl_session_t *
374 vcl_session_get (vcl_worker_t * wrk, u32 session_index)
376 if (pool_is_free_index (wrk->sessions, session_index))
378 return pool_elt_at_index (wrk->sessions, session_index);
382 vcl_session_handle (vcl_session_t * s)
384 ASSERT (s->session_index < 2 << 24);
385 return (vcl_get_worker_index () << 24 | s->session_index);
389 vcl_session_handle_parse (u32 handle, u32 * wrk_index, u32 * session_index)
391 *wrk_index = handle >> 24;
392 *session_index = handle & 0xFFFFFF;
395 static inline vcl_session_t *
396 vcl_session_get_w_handle (vcl_worker_t * wrk, u32 session_handle)
398 u32 session_index, wrk_index;
399 vcl_session_handle_parse (session_handle, &wrk_index, &session_index);
400 ASSERT (wrk_index == wrk->wrk_index);
401 return vcl_session_get (wrk, session_index);
404 static inline vcl_session_t *
405 vcl_session_get_w_vpp_handle (vcl_worker_t * wrk, u64 vpp_handle)
408 if ((p = hash_get (wrk->session_index_by_vpp_handles, vpp_handle)))
409 return vcl_session_get (wrk, (u32) p[0]);
414 vcl_session_index_from_vpp_handle (vcl_worker_t * wrk, u64 vpp_handle)
417 if ((p = hash_get (wrk->session_index_by_vpp_handles, vpp_handle)))
419 return VCL_INVALID_SESSION_INDEX;
423 vcl_session_table_add_vpp_handle (vcl_worker_t * wrk, u64 handle, u32 value)
425 hash_set (wrk->session_index_by_vpp_handles, handle, value);
429 vcl_session_table_del_vpp_handle (vcl_worker_t * wrk, u64 vpp_handle)
431 hash_unset (wrk->session_index_by_vpp_handles, vpp_handle);
434 static inline uword *
435 vcl_session_table_lookup_vpp_handle (vcl_worker_t * wrk, u64 handle)
437 return hash_get (wrk->session_index_by_vpp_handles, handle);
441 vcl_session_table_add_listener (vcl_worker_t * wrk, u64 listener_handle,
444 /* Session and listener handles have different formats. The latter has
445 * the thread index in the upper 32 bits while the former has the session
446 * type. Knowing that, for listeners we just flip the MSB to 1 */
447 listener_handle |= 1ULL << 63;
448 hash_set (wrk->session_index_by_vpp_handles, listener_handle, value);
452 vcl_session_table_del_listener (vcl_worker_t * wrk, u64 listener_handle)
454 listener_handle |= 1ULL << 63;
455 hash_unset (wrk->session_index_by_vpp_handles, listener_handle);
458 static inline vcl_session_t *
459 vcl_session_table_lookup_listener (vcl_worker_t * wrk, u64 listener_handle)
462 u64 handle = listener_handle | (1ULL << 63);
463 vcl_session_t *session;
465 p = hash_get (wrk->session_index_by_vpp_handles, handle);
468 clib_warning ("VCL<%d>: couldn't find listen session: unknown vpp "
469 "listener handle %llx", getpid (), listener_handle);
472 if (pool_is_free_index (wrk->sessions, p[0]))
474 VDBG (1, "VCL<%d>: invalid listen session, sid (%u)", getpid (), p[0]);
478 session = pool_elt_at_index (wrk->sessions, p[0]);
479 ASSERT (session->session_state & STATE_LISTEN);
483 const char *vppcom_session_state_str (session_state_t state);
486 vcl_session_is_ct (vcl_session_t * s)
488 return (s->our_evt_q != 0);
494 int vcl_wait_for_app_state_change (app_state_t app_state);
495 vcl_cut_through_registration_t
496 * vcl_ct_registration_lock_and_alloc (vcl_worker_t * wrk);
497 void vcl_ct_registration_del (vcl_worker_t * wrk,
498 vcl_cut_through_registration_t * ctr);
499 u32 vcl_ct_registration_index (vcl_worker_t * wrk,
500 vcl_cut_through_registration_t * ctr);
501 void vcl_ct_registration_lock (vcl_worker_t * wrk);
502 void vcl_ct_registration_unlock (vcl_worker_t * wrk);
503 vcl_cut_through_registration_t
504 * vcl_ct_registration_lock_and_lookup (vcl_worker_t * wrk, uword mq_addr);
505 void vcl_ct_registration_lookup_add (vcl_worker_t * wrk, uword mq_addr,
507 void vcl_ct_registration_lookup_del (vcl_worker_t * wrk, uword mq_addr);
508 vcl_mq_evt_conn_t *vcl_mq_evt_conn_alloc (vcl_worker_t * wrk);
509 u32 vcl_mq_evt_conn_index (vcl_worker_t * wrk, vcl_mq_evt_conn_t * mqc);
510 vcl_mq_evt_conn_t *vcl_mq_evt_conn_get (vcl_worker_t * wrk, u32 mq_conn_idx);
511 int vcl_mq_epoll_add_evfd (vcl_worker_t * wrk, svm_msg_q_t * mq);
512 int vcl_mq_epoll_del_evfd (vcl_worker_t * wrk, u32 mqc_index);
514 vcl_worker_t *vcl_worker_alloc_and_init (void);
515 void vcl_worker_cleanup (vcl_worker_t * wrk, u8 notify_vpp);
516 int vcl_worker_register_with_vpp (void);
517 int vcl_worker_set_bapi (void);
518 void vcl_worker_share_sessions (vcl_worker_t * parent_wrk);
519 int vcl_worker_unshare_session (vcl_worker_t * wrk, vcl_session_t * s);
520 int vcl_session_get_refcnt (vcl_session_t * s);
522 void vcl_segment_table_add (u64 segment_handle, u32 svm_segment_index);
523 u32 vcl_segment_table_lookup (u64 segment_handle);
524 void vcl_segment_table_del (u64 segment_handle);
526 static inline vcl_worker_t *
527 vcl_worker_get (u32 wrk_index)
529 return pool_elt_at_index (vcm->workers, wrk_index);
532 static inline vcl_worker_t *
533 vcl_worker_get_if_valid (u32 wrk_index)
535 if (pool_is_free_index (vcm->workers, wrk_index))
537 return pool_elt_at_index (vcm->workers, wrk_index);
540 static inline vcl_worker_t *
541 vcl_worker_get_current (void)
543 return vcl_worker_get (vcl_get_worker_index ());
549 int vppcom_connect_to_vpp (char *app_name);
550 void vppcom_init_error_string_table (void);
551 void vppcom_send_session_enable_disable (u8 is_enable);
552 void vppcom_app_send_attach (void);
553 void vppcom_app_send_detach (void);
554 void vppcom_send_connect_sock (vcl_session_t * session);
555 void vppcom_send_disconnect_session (u64 vpp_handle);
556 void vppcom_send_bind_sock (vcl_session_t * session);
557 void vppcom_send_unbind_sock (u64 vpp_handle);
558 void vppcom_api_hookup (void);
559 void vppcom_send_accept_session_reply (u64 vpp_handle, u32 context, int rv);
560 void vcl_send_app_worker_add_del (u8 is_add);
561 void vcl_send_child_worker_del (vcl_worker_t * wrk);
563 u32 vcl_max_nsid_len (void);
565 u8 *format_api_error (u8 * s, va_list * args);
567 #endif /* SRC_VCL_VCL_PRIVATE_H_ */
570 * fd.io coding-style-patch-verification: ON
573 * eval: (c-set-style "gnu")