session: fix typos & cert_key store init
[vpp.git] / src / vnet / session / application_interface.h
1 /*
2  * Copyright (c) 2016-2019 Cisco and/or its affiliates.
3  * Licensed under the Apache License, Version 2.0 (the "License");
4  * you may not use this file except in compliance with the License.
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 #ifndef __included_uri_h__
16 #define __included_uri_h__
17
18 #include <vlibmemory/api.h>
19 #include <svm/message_queue.h>
20 #include <vnet/session/session_types.h>
21 #include <vnet/tls/tls_test.h>
22 #include <svm/fifo_segment.h>
23
24 typedef struct certificate_
25 {
26   u32 *app_interests;           /* vec of application index asking for deletion cb */
27   u32 cert_key_index;           /* index in cert & key pool */
28   u8 *key;
29   u8 *cert;
30 } app_cert_key_pair_t;
31
32 typedef struct _stream_session_cb_vft
33 {
34   /** Notify server of new segment */
35   int (*add_segment_callback) (u32 api_client_index, u64 segment_handle);
36
37   /** Notify server of new segment */
38   int (*del_segment_callback) (u32 api_client_index, u64 segment_handle);
39
40   /** Notify server of newly accepted session */
41   int (*session_accept_callback) (session_t * new_session);
42
43   /** Connection request callback */
44   int (*session_connected_callback) (u32 app_wrk_index, u32 opaque,
45                                      session_t * s, u8 code);
46
47   /** Notify app that session is closing */
48   void (*session_disconnect_callback) (session_t * s);
49
50   /** Notify app that transport is closed */
51   void (*session_transport_closed_callback) (session_t * s);
52
53   /** Notify app that session or transport are about to be removed */
54   void (*session_cleanup_callback) (session_t * s, session_cleanup_ntf_t ntf);
55
56   /** Notify app that session was reset */
57   void (*session_reset_callback) (session_t * s);
58
59   /** Notify app that session pool migration happened */
60   void (*session_migrate_callback) (session_t * s, session_handle_t new_sh);
61
62   /** Direct RX callback for built-in application */
63   int (*builtin_app_rx_callback) (session_t * session);
64
65   /** Direct TX callback for built-in application */
66   int (*builtin_app_tx_callback) (session_t * session);
67
68   /** Cert and key pair delete notification */
69   int (*app_cert_key_pair_delete_callback) (app_cert_key_pair_t * ckpair);
70
71 } session_cb_vft_t;
72
73 #define foreach_app_init_args                   \
74   _(u32, api_client_index)                      \
75   _(u8 *, name)                                 \
76   _(u64 *, options)                             \
77   _(u8 *, namespace_id)                         \
78   _(session_cb_vft_t *, session_cb_vft)         \
79   _(u32, app_index)                             \
80
81 typedef struct _vnet_app_attach_args_t
82 {
83 #define _(_type, _name) _type _name;
84   foreach_app_init_args
85 #undef _
86   ssvm_private_t * segment;
87   svm_msg_q_t *app_evt_q;
88   u64 segment_handle;
89 } vnet_app_attach_args_t;
90
91 typedef struct _vnet_app_detach_args_t
92 {
93   u32 app_index;
94   u32 api_client_index;
95 } vnet_app_detach_args_t;
96
97 typedef struct _vnet_bind_args_t
98 {
99   union
100   {
101     session_endpoint_cfg_t sep_ext;
102     session_endpoint_t sep;
103     char *uri;
104   };
105
106   u32 app_index;
107   u32 wrk_map_index;
108
109   /*
110    * Results
111    */
112   char *segment_name;
113   u32 segment_name_length;
114   u64 server_event_queue_address;
115   u64 handle;
116 } vnet_listen_args_t;
117
118 typedef struct _vnet_unlisten_args_t
119 {
120   union
121   {
122     char *uri;
123     u64 handle;                 /**< Session handle */
124   };
125   u32 app_index;                /**< Owning application index */
126   u32 wrk_map_index;            /**< App's local pool worker index */
127 } vnet_unlisten_args_t;
128
129 typedef struct _vnet_connect_args
130 {
131   union
132   {
133     session_endpoint_cfg_t sep_ext;
134     session_endpoint_t sep;
135     char *uri;
136   };
137   u32 app_index;
138   u32 wrk_map_index;
139   u32 api_context;
140
141   session_handle_t session_handle;
142 } vnet_connect_args_t;
143
144 typedef struct _vnet_disconnect_args_t
145 {
146   session_handle_t handle;
147   u32 app_index;
148 } vnet_disconnect_args_t;
149
150 typedef struct _vnet_application_add_tls_cert_args_t
151 {
152   u32 app_index;
153   u8 *cert;
154 } vnet_app_add_tls_cert_args_t;
155
156 typedef struct _vnet_application_add_tls_key_args_t
157 {
158   u32 app_index;
159   u8 *key;
160 } vnet_app_add_tls_key_args_t;
161
162 typedef enum crypto_engine_type_
163 {
164   CRYPTO_ENGINE_NONE,
165   CRYPTO_ENGINE_MBEDTLS,
166   CRYPTO_ENGINE_OPENSSL,
167   CRYPTO_ENGINE_VPP,
168   CRYPTO_ENGINE_PICOTLS,
169   CRYPTO_N_ENGINES
170 } crypto_engine_type_t;
171
172 typedef struct _vnet_app_add_cert_key_pair_args_
173 {
174   u8 *cert;
175   u8 *key;
176   u32 index;
177 } vnet_app_add_cert_key_pair_args_t;
178
179 /* Application attach options */
180 typedef enum
181 {
182   APP_OPTIONS_FLAGS,
183   APP_OPTIONS_EVT_QUEUE_SIZE,
184   APP_OPTIONS_SEGMENT_SIZE,
185   APP_OPTIONS_ADD_SEGMENT_SIZE,
186   APP_OPTIONS_PRIVATE_SEGMENT_COUNT,
187   APP_OPTIONS_RX_FIFO_SIZE,
188   APP_OPTIONS_TX_FIFO_SIZE,
189   APP_OPTIONS_PREALLOC_FIFO_PAIRS,
190   APP_OPTIONS_NAMESPACE,
191   APP_OPTIONS_NAMESPACE_SECRET,
192   APP_OPTIONS_PROXY_TRANSPORT,
193   APP_OPTIONS_ACCEPT_COOKIE,
194   APP_OPTIONS_TLS_ENGINE,
195   APP_OPTIONS_N_OPTIONS
196 } app_attach_options_index_t;
197
198 #define foreach_app_options_flags                               \
199   _(ACCEPT_REDIRECT, "Use FIFO with redirects")                 \
200   _(ADD_SEGMENT, "Add segment and signal app if needed")        \
201   _(IS_BUILTIN, "Application is builtin")                       \
202   _(IS_TRANSPORT_APP, "Application is a transport proto")       \
203   _(IS_PROXY, "Application is proxying")                        \
204   _(USE_GLOBAL_SCOPE, "App can use global session scope")       \
205   _(USE_LOCAL_SCOPE, "App can use local session scope")         \
206   _(EVT_MQ_USE_EVENTFD, "Use eventfds for signaling")           \
207
208 typedef enum _app_options
209 {
210 #define _(sym, str) APP_OPTIONS_##sym,
211   foreach_app_options_flags
212 #undef _
213 } app_options_t;
214
215 typedef enum _app_options_flags
216 {
217 #define _(sym, str) APP_OPTIONS_FLAGS_##sym = 1 << APP_OPTIONS_##sym,
218   foreach_app_options_flags
219 #undef _
220 } app_options_flags_t;
221
222 #define foreach_fd_type                                         \
223   _(VPP_MQ_SEGMENT, "Fd for vpp's event mq segment")            \
224   _(MEMFD_SEGMENT, "Fd for memfd segment")                      \
225   _(MQ_EVENTFD, "Event fd used by message queue")               \
226   _(VPP_MQ_EVENTFD, "Event fd used by vpp's message queue")     \
227
228 typedef enum session_fd_type_
229 {
230 #define _(sym, str) SESSION_FD_##sym,
231   foreach_fd_type
232 #undef _
233   SESSION_N_FD_TYPE
234 } session_fd_type_t;
235
236 typedef enum session_fd_flag_
237 {
238 #define _(sym, str) SESSION_FD_F_##sym = 1 << SESSION_FD_##sym,
239   foreach_fd_type
240 #undef _
241 } session_fd_flag_t;
242
243 int parse_uri (char *uri, session_endpoint_cfg_t * sep);
244 int vnet_bind_uri (vnet_listen_args_t *);
245 int vnet_unbind_uri (vnet_unlisten_args_t * a);
246 int vnet_connect_uri (vnet_connect_args_t * a);
247
248 int vnet_application_attach (vnet_app_attach_args_t * a);
249 int vnet_application_detach (vnet_app_detach_args_t * a);
250 int vnet_listen (vnet_listen_args_t * a);
251 int vnet_connect (vnet_connect_args_t * a);
252 int vnet_unlisten (vnet_unlisten_args_t * a);
253 int vnet_disconnect_session (vnet_disconnect_args_t * a);
254
255 clib_error_t *vnet_app_add_tls_cert (vnet_app_add_tls_cert_args_t * a);
256 clib_error_t *vnet_app_add_tls_key (vnet_app_add_tls_key_args_t * a);
257 int vnet_app_add_cert_key_pair (vnet_app_add_cert_key_pair_args_t * a);
258 int vnet_app_del_cert_key_pair (u32 index);
259 /** Ask for app cb on pair deletion */
260 int vnet_app_add_cert_key_interest (u32 index, u32 app_index);
261
262 typedef struct app_session_transport_
263 {
264   ip46_address_t rmt_ip;        /**< remote ip */
265   ip46_address_t lcl_ip;        /**< local ip */
266   u16 rmt_port;                 /**< remote port (network order) */
267   u16 lcl_port;                 /**< local port (network order) */
268   u8 is_ip4;                    /**< set if uses ip4 networking */
269 } app_session_transport_t;
270
271 #define foreach_app_session_field                                       \
272   _(svm_fifo_t, *rx_fifo)               /**< rx fifo */                 \
273   _(svm_fifo_t, *tx_fifo)               /**< tx fifo */                 \
274   _(session_type_t, session_type)       /**< session type */            \
275   _(volatile u8, session_state)         /**< session state */           \
276   _(u32, session_index)                 /**< index in owning pool */    \
277   _(app_session_transport_t, transport) /**< transport info */          \
278   _(svm_msg_q_t, *vpp_evt_q)            /**< vpp event queue  */        \
279   _(u8, is_dgram)                       /**< flag for dgram mode */     \
280
281 typedef struct
282 {
283 #define _(type, name) type name;
284   foreach_app_session_field
285 #undef _
286 } app_session_t;
287
288 typedef struct session_listen_msg_
289 {
290   u32 client_index;
291   u32 context;                  /* Not needed but keeping it for compatibility with bapi */
292   u32 wrk_index;
293   u32 vrf;
294   u16 port;
295   u8 proto;
296   u8 is_ip4;
297   ip46_address_t ip;
298   u32 ckpair_index;
299 } __clib_packed session_listen_msg_t;
300
301 typedef struct session_listen_uri_msg_
302 {
303   u32 client_index;
304   u32 context;
305   u8 uri[56];
306 } __clib_packed session_listen_uri_msg_t;
307
308 typedef struct session_bound_msg_
309 {
310   u32 context;
311   u64 handle;
312   i32 retval;
313   u8 lcl_is_ip4;
314   u8 lcl_ip[16];
315   u16 lcl_port;
316   uword rx_fifo;
317   uword tx_fifo;
318   uword vpp_evt_q;
319   u32 segment_size;
320   u8 segment_name_length;
321   u8 segment_name[128];
322 } __clib_packed session_bound_msg_t;
323
324 typedef struct session_unlisten_msg_
325 {
326   u32 client_index;
327   u32 context;
328   u32 wrk_index;
329   session_handle_t handle;
330 } __clib_packed session_unlisten_msg_t;
331
332 typedef struct session_unlisten_reply_msg_
333 {
334   u32 context;
335   u64 handle;
336   i32 retval;
337 } __clib_packed session_unlisten_reply_msg_t;
338
339 typedef struct session_accepted_msg_
340 {
341   u32 context;
342   u64 listener_handle;
343   u64 handle;
344   uword server_rx_fifo;
345   uword server_tx_fifo;
346   u64 segment_handle;
347   uword vpp_event_queue_address;
348   transport_endpoint_t rmt;
349 } __clib_packed session_accepted_msg_t;
350
351 typedef struct session_accepted_reply_msg_
352 {
353   u32 context;
354   i32 retval;
355   u64 handle;
356 } __clib_packed session_accepted_reply_msg_t;
357
358 typedef struct session_connect_msg_
359 {
360   u32 client_index;
361   u32 context;
362   u32 wrk_index;
363   u32 vrf;
364   u16 port;
365   u8 proto;
366   u8 is_ip4;
367   ip46_address_t ip;
368   u8 hostname_len;
369   u8 hostname[16];
370   u64 parent_handle;
371   u32 ckpair_index;
372 } __clib_packed session_connect_msg_t;
373
374 typedef struct session_connect_uri_msg_
375 {
376   u32 client_index;
377   u32 context;
378   u8 uri[56];
379 } __clib_packed session_connect_uri_msg_t;
380
381 typedef struct session_connected_msg_
382 {
383   u32 context;
384   i32 retval;
385   u64 handle;
386   uword server_rx_fifo;
387   uword server_tx_fifo;
388   u64 segment_handle;
389   uword ct_rx_fifo;
390   uword ct_tx_fifo;
391   u64 ct_segment_handle;
392   uword vpp_event_queue_address;
393   u32 segment_size;
394   u8 segment_name_length;
395   u8 segment_name[64];
396   transport_endpoint_t lcl;
397 } __clib_packed session_connected_msg_t;
398
399 typedef struct session_disconnect_msg_
400 {
401   u32 client_index;
402   u32 context;
403   session_handle_t handle;
404 } __clib_packed session_disconnect_msg_t;
405
406 typedef struct session_disconnected_msg_
407 {
408   u32 client_index;
409   u32 context;
410   u64 handle;
411 } __clib_packed session_disconnected_msg_t;
412
413 typedef struct session_disconnected_reply_msg_
414 {
415   u32 context;
416   i32 retval;
417   u64 handle;
418 } __clib_packed session_disconnected_reply_msg_t;
419
420 typedef struct session_reset_msg_
421 {
422   u32 client_index;
423   u32 context;
424   u64 handle;
425 } __clib_packed session_reset_msg_t;
426
427 typedef struct session_reset_reply_msg_
428 {
429   u32 context;
430   i32 retval;
431   u64 handle;
432 } __clib_packed session_reset_reply_msg_t;
433
434 typedef struct session_req_worker_update_msg_
435 {
436   u64 session_handle;
437 } __clib_packed session_req_worker_update_msg_t;
438
439 /* NOTE: using u16 for wrk indices because message needs to fit in 18B */
440 typedef struct session_worker_update_msg_
441 {
442   u32 client_index;
443   u16 wrk_index;
444   u16 req_wrk_index;
445   u64 handle;
446 } __clib_packed session_worker_update_msg_t;
447
448 typedef struct session_worker_update_reply_msg_
449 {
450   u64 handle;
451   uword rx_fifo;
452   uword tx_fifo;
453   u64 segment_handle;
454 } __clib_packed session_worker_update_reply_msg_t;
455
456 typedef struct session_app_detach_msg_
457 {
458   u32 client_index;
459   u32 context;
460 } session_app_detach_msg_t;
461
462 typedef struct app_session_event_
463 {
464   svm_msg_q_msg_t msg;
465   session_event_t *evt;
466 } __clib_packed app_session_evt_t;
467
468 static inline void
469 app_alloc_ctrl_evt_to_vpp (svm_msg_q_t * mq, app_session_evt_t * app_evt,
470                            u8 evt_type)
471 {
472   svm_msg_q_lock_and_alloc_msg_w_ring (mq,
473                                        SESSION_MQ_CTRL_EVT_RING,
474                                        SVM_Q_WAIT, &app_evt->msg);
475   app_evt->evt = svm_msg_q_msg_data (mq, &app_evt->msg);
476   clib_memset (app_evt->evt, 0, sizeof (*app_evt->evt));
477   app_evt->evt->event_type = evt_type;
478 }
479
480 static inline void
481 app_send_ctrl_evt_to_vpp (svm_msg_q_t * mq, app_session_evt_t * app_evt)
482 {
483   svm_msg_q_add_and_unlock (mq, &app_evt->msg);
484 }
485
486 /**
487  * Send fifo io event to vpp worker thread
488  *
489  * Because there may be multiple writers to one of vpp's queues, this
490  * protects message allocation and enqueueing.
491  *
492  * @param mq            vpp message queue
493  * @param f             fifo for which the event is sent
494  * @param evt_type      type of event
495  * @param noblock       flag to indicate is request is blocking or not
496  * @return              0 if success, negative integer otherwise
497  */
498 static inline int
499 app_send_io_evt_to_vpp (svm_msg_q_t * mq, u32 session_index, u8 evt_type,
500                         u8 noblock)
501 {
502   session_event_t *evt;
503   svm_msg_q_msg_t msg;
504
505   if (noblock)
506     {
507       if (svm_msg_q_try_lock (mq))
508         return -1;
509       if (PREDICT_FALSE (svm_msg_q_ring_is_full (mq, SESSION_MQ_IO_EVT_RING)))
510         {
511           svm_msg_q_unlock (mq);
512           return -2;
513         }
514       msg = svm_msg_q_alloc_msg_w_ring (mq, SESSION_MQ_IO_EVT_RING);
515       evt = (session_event_t *) svm_msg_q_msg_data (mq, &msg);
516       evt->session_index = session_index;
517       evt->event_type = evt_type;
518       svm_msg_q_add_and_unlock (mq, &msg);
519       return 0;
520     }
521   else
522     {
523       svm_msg_q_lock (mq);
524       while (svm_msg_q_ring_is_full (mq, SESSION_MQ_IO_EVT_RING)
525              || svm_msg_q_is_full (mq))
526         svm_msg_q_wait (mq);
527       msg = svm_msg_q_alloc_msg_w_ring (mq, SESSION_MQ_IO_EVT_RING);
528       evt = (session_event_t *) svm_msg_q_msg_data (mq, &msg);
529       evt->session_index = session_index;
530       evt->event_type = evt_type;
531       svm_msg_q_add_and_unlock (mq, &msg);
532       return 0;
533     }
534 }
535
536 always_inline int
537 app_send_dgram_raw (svm_fifo_t * f, app_session_transport_t * at,
538                     svm_msg_q_t * vpp_evt_q, u8 * data, u32 len, u8 evt_type,
539                     u8 do_evt, u8 noblock)
540 {
541   u32 max_enqueue, actual_write;
542   session_dgram_hdr_t hdr;
543   int rv;
544
545   max_enqueue = svm_fifo_max_enqueue_prod (f);
546   if (max_enqueue <= sizeof (session_dgram_hdr_t))
547     return 0;
548
549   max_enqueue -= sizeof (session_dgram_hdr_t);
550   actual_write = clib_min (len, max_enqueue);
551   hdr.data_length = actual_write;
552   hdr.data_offset = 0;
553   clib_memcpy_fast (&hdr.rmt_ip, &at->rmt_ip, sizeof (ip46_address_t));
554   hdr.is_ip4 = at->is_ip4;
555   hdr.rmt_port = at->rmt_port;
556   clib_memcpy_fast (&hdr.lcl_ip, &at->lcl_ip, sizeof (ip46_address_t));
557   hdr.lcl_port = at->lcl_port;
558   rv = svm_fifo_enqueue (f, sizeof (hdr), (u8 *) & hdr);
559   ASSERT (rv == sizeof (hdr));
560
561   rv = svm_fifo_enqueue (f, actual_write, data);
562   if (do_evt)
563     {
564       if (rv > 0 && svm_fifo_set_event (f))
565         app_send_io_evt_to_vpp (vpp_evt_q, f->master_session_index, evt_type,
566                                 noblock);
567     }
568   ASSERT (rv);
569   return rv;
570 }
571
572 always_inline int
573 app_send_dgram (app_session_t * s, u8 * data, u32 len, u8 noblock)
574 {
575   return app_send_dgram_raw (s->tx_fifo, &s->transport, s->vpp_evt_q, data,
576                              len, SESSION_IO_EVT_TX, 1 /* do_evt */ ,
577                              noblock);
578 }
579
580 always_inline int
581 app_send_stream_raw (svm_fifo_t * f, svm_msg_q_t * vpp_evt_q, u8 * data,
582                      u32 len, u8 evt_type, u8 do_evt, u8 noblock)
583 {
584   int rv;
585
586   rv = svm_fifo_enqueue (f, len, data);
587   if (do_evt)
588     {
589       if (rv > 0 && svm_fifo_set_event (f))
590         app_send_io_evt_to_vpp (vpp_evt_q, f->master_session_index, evt_type,
591                                 noblock);
592     }
593   return rv;
594 }
595
596 always_inline int
597 app_send_stream (app_session_t * s, u8 * data, u32 len, u8 noblock)
598 {
599   return app_send_stream_raw (s->tx_fifo, s->vpp_evt_q, data, len,
600                               SESSION_IO_EVT_TX, 1 /* do_evt */ , noblock);
601 }
602
603 always_inline int
604 app_send (app_session_t * s, u8 * data, u32 len, u8 noblock)
605 {
606   if (s->is_dgram)
607     return app_send_dgram (s, data, len, noblock);
608   return app_send_stream (s, data, len, noblock);
609 }
610
611 always_inline int
612 app_recv_dgram_raw (svm_fifo_t * f, u8 * buf, u32 len,
613                     app_session_transport_t * at, u8 clear_evt, u8 peek)
614 {
615   session_dgram_pre_hdr_t ph;
616   u32 max_deq;
617   int rv;
618
619   max_deq = svm_fifo_max_dequeue_cons (f);
620   if (max_deq < sizeof (session_dgram_hdr_t))
621     {
622       if (clear_evt)
623         svm_fifo_unset_event (f);
624       return 0;
625     }
626
627   if (clear_evt)
628     svm_fifo_unset_event (f);
629
630   svm_fifo_peek (f, 0, sizeof (ph), (u8 *) & ph);
631   ASSERT (ph.data_length >= ph.data_offset);
632   if (!ph.data_offset)
633     svm_fifo_peek (f, sizeof (ph), sizeof (*at), (u8 *) at);
634   len = clib_min (len, ph.data_length - ph.data_offset);
635   rv = svm_fifo_peek (f, ph.data_offset + SESSION_CONN_HDR_LEN, len, buf);
636   if (peek)
637     return rv;
638   ph.data_offset += rv;
639   if (ph.data_offset == ph.data_length)
640     svm_fifo_dequeue_drop (f, ph.data_length + SESSION_CONN_HDR_LEN);
641   else
642     svm_fifo_overwrite_head (f, (u8 *) & ph, sizeof (ph));
643   return rv;
644 }
645
646 always_inline int
647 app_recv_dgram (app_session_t * s, u8 * buf, u32 len)
648 {
649   return app_recv_dgram_raw (s->rx_fifo, buf, len, &s->transport, 1, 0);
650 }
651
652 always_inline int
653 app_recv_stream_raw (svm_fifo_t * f, u8 * buf, u32 len, u8 clear_evt, u8 peek)
654 {
655   if (clear_evt)
656     svm_fifo_unset_event (f);
657
658   if (peek)
659     return svm_fifo_peek (f, 0, len, buf);
660
661   return svm_fifo_dequeue (f, len, buf);
662 }
663
664 always_inline int
665 app_recv_stream (app_session_t * s, u8 * buf, u32 len)
666 {
667   return app_recv_stream_raw (s->rx_fifo, buf, len, 1, 0);
668 }
669
670 always_inline int
671 app_recv (app_session_t * s, u8 * data, u32 len)
672 {
673   if (s->is_dgram)
674     return app_recv_dgram (s, data, len);
675   return app_recv_stream (s, data, len);
676 }
677
678 #endif /* __included_uri_h__ */
679
680 /*
681  * fd.io coding-style-patch-verification: ON
682  *
683  * Local Variables:
684  * eval: (c-set-style "gnu")
685  * End:
686  */