vcl: add config option for preferred tls engine
[vpp.git] / src / vcl / vcl_private.h
1 /*
2  * Copyright (c) 2018-2019 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>
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
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
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,
59   STATE_APP_ADDING_WORKER,
60   STATE_APP_ADDING_TLS_DATA,
61   STATE_APP_FAILED,
62   STATE_APP_READY
63 } app_state_t;
64
65 typedef enum
66 {
67   STATE_START = 0,
68   STATE_CONNECT = 0x01,
69   STATE_LISTEN = 0x02,
70   STATE_ACCEPT = 0x04,
71   STATE_VPP_CLOSING = 0x08,
72   STATE_DISCONNECT = 0x10,
73   STATE_FAILED = 0x20,
74   STATE_UPDATED = 0x40,
75   STATE_LISTEN_NO_MQ = 0x80,
76 } vcl_session_state_t;
77
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)
81
82 typedef struct epoll_event vppcom_epoll_event_t;
83
84 typedef struct
85 {
86   u32 next_sh;
87   u32 prev_sh;
88   u32 vep_sh;
89   vppcom_epoll_event_t ev;
90 #define VEP_DEFAULT_ET_MASK  (EPOLLIN|EPOLLOUT)
91 #define VEP_UNSUPPORTED_EVENTS (EPOLLONESHOT|EPOLLEXCLUSIVE)
92   u32 et_mask;
93 } vppcom_epoll_t;
94
95 /* Select uses the vcl_si_set as if a clib_bitmap. Make sure they are the
96  * same size */
97 STATIC_ASSERT (sizeof (clib_bitmap_t) == sizeof (vcl_si_set),
98                "vppcom bitmap size mismatch");
99
100 typedef struct
101 {
102   u8 is_ip4;
103   ip46_address_t ip46;
104 } vppcom_ip46_t;
105
106 #define VCL_ACCEPTED_F_CLOSED   (1 << 0)
107 #define VCL_ACCEPTED_F_RESET    (1 << 1)
108
109 typedef struct vcl_session_msg
110 {
111   u32 next;
112   union
113   {
114     session_accepted_msg_t accepted_msg;
115   };
116   u32 flags;
117 } vcl_session_msg_t;
118
119 typedef enum
120 {
121   VCL_SESS_ATTR_SERVER,
122   VCL_SESS_ATTR_CUT_THRU,
123   VCL_SESS_ATTR_VEP,
124   VCL_SESS_ATTR_VEP_SESSION,
125   VCL_SESS_ATTR_LISTEN,         // SOL_SOCKET,SO_ACCEPTCONN
126   VCL_SESS_ATTR_NONBLOCK,       // fcntl,O_NONBLOCK
127   VCL_SESS_ATTR_REUSEADDR,      // SOL_SOCKET,SO_REUSEADDR
128   VCL_SESS_ATTR_REUSEPORT,      // SOL_SOCKET,SO_REUSEPORT
129   VCL_SESS_ATTR_BROADCAST,      // SOL_SOCKET,SO_BROADCAST
130   VCL_SESS_ATTR_V6ONLY,         // SOL_TCP,IPV6_V6ONLY
131   VCL_SESS_ATTR_KEEPALIVE,      // SOL_SOCKET,SO_KEEPALIVE
132   VCL_SESS_ATTR_TCP_NODELAY,    // SOL_TCP,TCP_NODELAY
133   VCL_SESS_ATTR_TCP_KEEPIDLE,   // SOL_TCP,TCP_KEEPIDLE
134   VCL_SESS_ATTR_TCP_KEEPINTVL,  // SOL_TCP,TCP_KEEPINTVL
135   VCL_SESS_ATTR_SHUT_RD,
136   VCL_SESS_ATTR_SHUT_WR,
137   VCL_SESS_ATTR_MAX
138 } vppcom_session_attr_t;
139
140 #define VCL_SESS_ATTR_SET(ATTR, VAL)            \
141 do {                                            \
142   (ATTR) |= 1 << (VAL);                         \
143  } while (0)
144
145 #define VCL_SESS_ATTR_CLR(ATTR, VAL)            \
146 do {                                            \
147   (ATTR) &= ~(1 << (VAL));                      \
148  } while (0)
149
150 #define VCL_SESS_ATTR_TEST(ATTR, VAL)           \
151   ((ATTR) & (1 << (VAL)) ? 1 : 0)
152
153 typedef struct
154 {
155   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
156 #define _(type, name) type name;
157   foreach_app_session_field
158 #undef _
159   u32 sndbuf_size;              // VPP-TBD: Hack until support setsockopt(SO_SNDBUF)
160   u32 rcvbuf_size;              // VPP-TBD: Hack until support setsockopt(SO_RCVBUF)
161   u32 user_mss;                 // VPP-TBD: Hack until support setsockopt(TCP_MAXSEG)
162   u64 vpp_handle;
163   u32 vpp_thread_index;
164
165   svm_fifo_t *ct_rx_fifo;
166   svm_fifo_t *ct_tx_fifo;
167
168   /* Socket configuration state */
169   u8 is_vep;
170   u8 is_vep_session;
171   /* VCL session index of the listening session (if any) */
172   u32 listener_index;
173   /* Accepted sessions on this listener */
174   int n_accepted_sessions;
175   u8 has_rx_evt;
176   u32 attr;
177   u64 parent_handle;
178   vppcom_epoll_t vep;
179   int libc_epfd;
180   svm_msg_q_t *our_evt_q;
181   vcl_session_msg_t *accept_evts_fifo;
182 #if VCL_ELOG
183   elog_track_t elog_track;
184 #endif
185 } vcl_session_t;
186
187 typedef struct vppcom_cfg_t_
188 {
189   uword heapsize;
190   u32 max_workers;
191   u32 vpp_api_q_length;
192   uword segment_baseva;
193   u32 segment_size;
194   u32 add_segment_size;
195   u32 preallocated_fifo_pairs;
196   u32 rx_fifo_size;
197   u32 tx_fifo_size;
198   u32 event_queue_size;
199   u32 listen_queue_size;
200   u8 app_proxy_transport_tcp;
201   u8 app_proxy_transport_udp;
202   u8 app_scope_local;
203   u8 app_scope_global;
204   u8 *namespace_id;
205   u64 namespace_secret;
206   u8 use_mq_eventfd;
207   f64 app_timeout;
208   f64 session_timeout;
209   f64 accept_timeout;
210   u32 event_ring_size;
211   char *event_log_path;
212   u8 *vpp_api_filename;
213   u8 *vpp_api_socket_name;
214   u32 tls_engine;
215 } vppcom_cfg_t;
216
217 void vppcom_cfg (vppcom_cfg_t * vcl_cfg);
218
219 typedef struct vcl_cut_through_registration_
220 {
221   svm_msg_q_t *mq;
222   svm_msg_q_t *peer_mq;
223   u32 sid;
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;
227
228 typedef struct vcl_mq_evt_conn_
229 {
230   svm_msg_q_t *mq;
231   int mq_fd;
232 } vcl_mq_evt_conn_t;
233
234 typedef struct vcl_worker_
235 {
236   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
237
238   /* Session pool */
239   vcl_session_t *sessions;
240
241   /** Worker/thread index in current process */
242   u32 wrk_index;
243
244   /** Worker index in vpp*/
245   u32 vpp_wrk_index;
246
247   /** API client handle */
248   u32 my_client_index;
249
250   /** State of the connection, shared between msg RX thread and main thread */
251   volatile app_state_t wrk_state;
252
253   /** VPP binary api input queue */
254   svm_queue_t *vl_input_queue;
255
256   /** VPP mq to be used for exchanging control messages */
257   svm_msg_q_t *ctrl_mq;
258
259   /** Message queues epoll fd. Initialized only if using mqs with eventfds */
260   int mqs_epfd;
261
262   /** Pool of event message queue event connections */
263   vcl_mq_evt_conn_t *mq_evt_conns;
264
265   /** Per worker buffer for receiving mq epoll events */
266   struct epoll_event *mq_events;
267
268   /** Hash table for disconnect processing */
269   uword *session_index_by_vpp_handles;
270
271   /** Select bitmaps */
272   clib_bitmap_t *rd_bitmap;
273   clib_bitmap_t *wr_bitmap;
274   clib_bitmap_t *ex_bitmap;
275
276   /** Our event message queue */
277   svm_msg_q_t *app_event_queue;
278
279   /** VPP workers event message queues */
280   svm_msg_q_t **vpp_event_queues;
281
282   /** For deadman timers */
283   clib_time_t clib_time;
284
285   /** Vector acting as buffer for mq messages */
286   svm_msg_q_msg_t *mq_msg_vector;
287
288   /** Vector of unhandled events */
289   session_event_t *unhandled_evts_vector;
290
291   u32 *pending_session_wrk_updates;
292
293   /** Used also as a thread stop key buffer */
294   pthread_t thread_id;
295
296   /** Current pid, may be different from main_pid if forked child */
297   pid_t current_pid;
298
299   u32 forked_child;
300
301 } vcl_worker_t;
302
303 typedef struct vppcom_main_t_
304 {
305   u8 is_init;
306   u32 debug;
307   pthread_t main_cpu;
308
309   /** Main process pid */
310   pid_t main_pid;
311
312   /** App's index in vpp. It's used by vpp to identify the app */
313   u32 app_index;
314
315   /** State of the connection, shared between msg RX thread and main thread */
316   volatile app_state_t app_state;
317
318   u8 *app_name;
319
320   /** VCL configuration */
321   vppcom_cfg_t cfg;
322
323   volatile u32 forking;
324
325   /** Workers */
326   vcl_worker_t *workers;
327
328   /** Lock to protect worker registrations */
329   clib_spinlock_t workers_lock;
330
331   /** Lock to protect segment hash table */
332   clib_rwlock_t segment_table_lock;
333
334   /** Mapped segments table */
335   uword *segment_table;
336
337   /** Control mq obtained from attach */
338   svm_msg_q_t *ctrl_mq;
339
340   fifo_segment_main_t segment_main;
341
342 #ifdef VCL_ELOG
343   /* VPP Event-logger */
344   elog_main_t elog_main;
345   elog_track_t elog_track;
346 #endif
347
348   /* VNET_API_ERROR_FOO -> "Foo" hash table */
349   uword *error_string_by_error_number;
350
351 } vppcom_main_t;
352
353 extern vppcom_main_t *vcm;
354
355 #define VCL_INVALID_SESSION_INDEX ((u32)~0)
356 #define VCL_INVALID_SESSION_HANDLE ((u64)~0)
357 #define VCL_INVALID_SEGMENT_INDEX ((u32)~0)
358 #define VCL_INVALID_SEGMENT_HANDLE ((u64)~0)
359
360 static inline vcl_session_t *
361 vcl_session_alloc (vcl_worker_t * wrk)
362 {
363   vcl_session_t *s;
364   pool_get (wrk->sessions, s);
365   memset (s, 0, sizeof (*s));
366   s->session_index = s - wrk->sessions;
367   s->listener_index = VCL_INVALID_SESSION_INDEX;
368   return s;
369 }
370
371 static inline void
372 vcl_session_free (vcl_worker_t * wrk, vcl_session_t * s)
373 {
374   pool_put (wrk->sessions, s);
375 }
376
377 static inline vcl_session_t *
378 vcl_session_get (vcl_worker_t * wrk, u32 session_index)
379 {
380   if (pool_is_free_index (wrk->sessions, session_index))
381     return 0;
382   return pool_elt_at_index (wrk->sessions, session_index);
383 }
384
385 static inline vcl_session_handle_t
386 vcl_session_handle_from_index (u32 session_index)
387 {
388   ASSERT (session_index < 2 << 24);
389   return (vcl_get_worker_index () << 24 | session_index);
390 }
391
392 static inline vcl_session_handle_t
393 vcl_session_handle (vcl_session_t * s)
394 {
395   return vcl_session_handle_from_index (s->session_index);
396 }
397
398 static inline void
399 vcl_session_handle_parse (u32 handle, u32 * wrk_index, u32 * session_index)
400 {
401   *wrk_index = handle >> 24;
402   *session_index = handle & 0xFFFFFF;
403 }
404
405 static inline vcl_session_t *
406 vcl_session_get_w_handle (vcl_worker_t * wrk, u32 session_handle)
407 {
408   u32 session_index, wrk_index;
409   vcl_session_handle_parse (session_handle, &wrk_index, &session_index);
410   ASSERT (wrk_index == wrk->wrk_index);
411   return vcl_session_get (wrk, session_index);
412 }
413
414 static inline vcl_session_t *
415 vcl_session_get_w_vpp_handle (vcl_worker_t * wrk, u64 vpp_handle)
416 {
417   uword *p;
418   if ((p = hash_get (wrk->session_index_by_vpp_handles, vpp_handle)))
419     return vcl_session_get (wrk, (u32) p[0]);
420   return 0;
421 }
422
423 static inline u32
424 vcl_session_index_from_vpp_handle (vcl_worker_t * wrk, u64 vpp_handle)
425 {
426   uword *p;
427   if ((p = hash_get (wrk->session_index_by_vpp_handles, vpp_handle)))
428     return p[0];
429   return VCL_INVALID_SESSION_INDEX;
430 }
431
432 static inline void
433 vcl_session_table_add_vpp_handle (vcl_worker_t * wrk, u64 handle, u32 value)
434 {
435   hash_set (wrk->session_index_by_vpp_handles, handle, value);
436 }
437
438 static inline void
439 vcl_session_table_del_vpp_handle (vcl_worker_t * wrk, u64 vpp_handle)
440 {
441   hash_unset (wrk->session_index_by_vpp_handles, vpp_handle);
442 }
443
444 static inline uword *
445 vcl_session_table_lookup_vpp_handle (vcl_worker_t * wrk, u64 handle)
446 {
447   return hash_get (wrk->session_index_by_vpp_handles, handle);
448 }
449
450 static inline void
451 vcl_session_table_add_listener (vcl_worker_t * wrk, u64 listener_handle,
452                                 u32 value)
453 {
454   hash_set (wrk->session_index_by_vpp_handles, listener_handle, value);
455 }
456
457 static inline void
458 vcl_session_table_del_listener (vcl_worker_t * wrk, u64 listener_handle)
459 {
460   hash_unset (wrk->session_index_by_vpp_handles, listener_handle);
461 }
462
463 static inline int
464 vcl_session_is_connectable_listener (vcl_worker_t * wrk,
465                                      vcl_session_t * session)
466 {
467   /* Tell if we session_handle is a QUIC session.
468    * We can be in the following cases :
469    * Listen session <- QUIC session <- Stream session
470    * QUIC session <- Stream session
471    */
472   vcl_session_t *ls;
473   if (session->session_type != VPPCOM_PROTO_QUIC)
474     return 0;
475   if (session->listener_index == VCL_INVALID_SESSION_INDEX)
476     return !(session->session_state & STATE_LISTEN);
477   ls = vcl_session_get_w_handle (wrk, session->listener_index);
478   if (!ls)
479     return VPPCOM_EBADFD;
480   return ls->session_state & STATE_LISTEN;
481 }
482
483 static inline vcl_session_t *
484 vcl_session_table_lookup_listener (vcl_worker_t * wrk, u64 handle)
485 {
486   uword *p;
487   vcl_session_t *session;
488
489   p = hash_get (wrk->session_index_by_vpp_handles, handle);
490   if (!p)
491     {
492       VDBG (0, "could not find listen session: unknown vpp listener handle"
493             " %llx", handle);
494       return 0;
495     }
496   session = vcl_session_get (wrk, p[0]);
497   if (!session)
498     {
499       VDBG (1, "invalid listen session index (%u)", p[0]);
500       return 0;
501     }
502
503   ASSERT ((session->session_state & (STATE_LISTEN | STATE_LISTEN_NO_MQ)) ||
504           vcl_session_is_connectable_listener (wrk, session));
505   return session;
506 }
507
508 const char *vppcom_session_state_str (vcl_session_state_t state);
509
510 static inline u8
511 vcl_session_is_ct (vcl_session_t * s)
512 {
513   return (s->ct_tx_fifo != 0);
514 }
515
516 static inline u8
517 vcl_session_is_open (vcl_session_t * s)
518 {
519   return ((s->session_state & STATE_OPEN)
520           || (s->session_state == STATE_LISTEN
521               && s->session_type == VPPCOM_PROTO_UDP));
522 }
523
524 static inline u8
525 vcl_session_is_closing (vcl_session_t * s)
526 {
527   return (s->session_state == STATE_VPP_CLOSING
528           || s->session_state == STATE_DISCONNECT);
529 }
530
531 static inline int
532 vcl_session_closing_error (vcl_session_t * s)
533 {
534   return s->session_state == STATE_DISCONNECT ? VPPCOM_ECONNRESET : 0;
535 }
536
537 static inline int
538 vcl_session_closed_error (vcl_session_t * s)
539 {
540   return s->session_state == STATE_DISCONNECT
541     ? VPPCOM_ECONNRESET : VPPCOM_ENOTCONN;
542 }
543
544 /*
545  * Helpers
546  */
547 int vcl_wait_for_app_state_change (app_state_t app_state);
548 vcl_mq_evt_conn_t *vcl_mq_evt_conn_alloc (vcl_worker_t * wrk);
549 u32 vcl_mq_evt_conn_index (vcl_worker_t * wrk, vcl_mq_evt_conn_t * mqc);
550 vcl_mq_evt_conn_t *vcl_mq_evt_conn_get (vcl_worker_t * wrk, u32 mq_conn_idx);
551 int vcl_mq_epoll_add_evfd (vcl_worker_t * wrk, svm_msg_q_t * mq);
552 int vcl_mq_epoll_del_evfd (vcl_worker_t * wrk, u32 mqc_index);
553
554 vcl_worker_t *vcl_worker_alloc_and_init (void);
555 void vcl_worker_cleanup (vcl_worker_t * wrk, u8 notify_vpp);
556 int vcl_worker_register_with_vpp (void);
557 int vcl_worker_set_bapi (void);
558 svm_msg_q_t *vcl_worker_ctrl_mq (vcl_worker_t * wrk);
559
560 void vcl_flush_mq_events (void);
561 void vcl_cleanup_bapi (void);
562 int vcl_session_cleanup (vcl_worker_t * wrk, vcl_session_t * session,
563                          vcl_session_handle_t sh, u8 do_disconnect);
564
565 void vcl_segment_table_add (u64 segment_handle, u32 svm_segment_index);
566 u32 vcl_segment_table_lookup (u64 segment_handle);
567 void vcl_segment_table_del (u64 segment_handle);
568
569 int vcl_session_read_ready (vcl_session_t * session);
570 int vcl_session_write_ready (vcl_session_t * session);
571
572 static inline vcl_worker_t *
573 vcl_worker_get (u32 wrk_index)
574 {
575   return pool_elt_at_index (vcm->workers, wrk_index);
576 }
577
578 static inline vcl_worker_t *
579 vcl_worker_get_if_valid (u32 wrk_index)
580 {
581   if (pool_is_free_index (vcm->workers, wrk_index))
582     return 0;
583   return pool_elt_at_index (vcm->workers, wrk_index);
584 }
585
586 static inline vcl_worker_t *
587 vcl_worker_get_current (void)
588 {
589   return vcl_worker_get (vcl_get_worker_index ());
590 }
591
592 static inline u8
593 vcl_n_workers (void)
594 {
595   return pool_elts (vcm->workers);
596 }
597
598 static inline svm_msg_q_t *
599 vcl_session_vpp_evt_q (vcl_worker_t * wrk, vcl_session_t * s)
600 {
601   return wrk->vpp_event_queues[s->vpp_thread_index];
602 }
603
604 void vcl_send_session_worker_update (vcl_worker_t * wrk, vcl_session_t * s,
605                                      u32 wrk_index);
606 /*
607  * VCL Binary API
608  */
609 int vppcom_connect_to_vpp (char *app_name);
610 void vppcom_disconnect_from_vpp (void);
611 void vppcom_init_error_string_table (void);
612 void vppcom_send_session_enable_disable (u8 is_enable);
613 void vppcom_app_send_attach (void);
614 void vppcom_app_send_detach (void);
615 void vcl_send_session_unlisten (vcl_worker_t * wrk, vcl_session_t * s);
616 void vppcom_send_disconnect_session (u64 vpp_handle);
617 void vppcom_api_hookup (void);
618 void vppcom_send_application_tls_cert_add (vcl_session_t * session,
619                                            char *cert, u32 cert_len);
620 void vppcom_send_application_tls_key_add (vcl_session_t * session, char *key,
621                                           u32 key_len);
622 void vcl_send_app_worker_add_del (u8 is_add);
623 void vcl_send_child_worker_del (vcl_worker_t * wrk);
624
625 u32 vcl_max_nsid_len (void);
626
627 u8 *format_api_error (u8 * s, va_list * args);
628
629 void vls_init ();
630 #endif /* SRC_VCL_VCL_PRIVATE_H_ */
631
632 /*
633  * fd.io coding-style-patch-verification: ON
634  *
635  * Local Variables:
636  * eval: (c-set-style "gnu")
637  * End:
638  */