hsa: use crypto_engine_type_t for TLS
[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 int vent_app_add_cert_key_interest (u32 index, u32 app_index);  /* Ask for app cb on pair deletion */
260
261 typedef struct app_session_transport_
262 {
263   ip46_address_t rmt_ip;        /**< remote ip */
264   ip46_address_t lcl_ip;        /**< local ip */
265   u16 rmt_port;                 /**< remote port (network order) */
266   u16 lcl_port;                 /**< local port (network order) */
267   u8 is_ip4;                    /**< set if uses ip4 networking */
268 } app_session_transport_t;
269
270 #define foreach_app_session_field                                       \
271   _(svm_fifo_t, *rx_fifo)               /**< rx fifo */                 \
272   _(svm_fifo_t, *tx_fifo)               /**< tx fifo */                 \
273   _(session_type_t, session_type)       /**< session type */            \
274   _(volatile u8, session_state)         /**< session state */           \
275   _(u32, session_index)                 /**< index in owning pool */    \
276   _(app_session_transport_t, transport) /**< transport info */          \
277   _(svm_msg_q_t, *vpp_evt_q)            /**< vpp event queue  */        \
278   _(u8, is_dgram)                       /**< flag for dgram mode */     \
279
280 typedef struct
281 {
282 #define _(type, name) type name;
283   foreach_app_session_field
284 #undef _
285 } app_session_t;
286
287 typedef struct session_listen_msg_
288 {
289   u32 client_index;
290   u32 context;                  /* Not needed but keeping it for compatibility with bapi */
291   u32 wrk_index;
292   u32 vrf;
293   u16 port;
294   u8 proto;
295   u8 is_ip4;
296   ip46_address_t ip;
297   u32 ckpair_index;
298 } __clib_packed session_listen_msg_t;
299
300 typedef struct session_listen_uri_msg_
301 {
302   u32 client_index;
303   u32 context;
304   u8 uri[56];
305 } __clib_packed session_listen_uri_msg_t;
306
307 typedef struct session_bound_msg_
308 {
309   u32 context;
310   u64 handle;
311   i32 retval;
312   u8 lcl_is_ip4;
313   u8 lcl_ip[16];
314   u16 lcl_port;
315   uword rx_fifo;
316   uword tx_fifo;
317   uword vpp_evt_q;
318   u32 segment_size;
319   u8 segment_name_length;
320   u8 segment_name[128];
321 } __clib_packed session_bound_msg_t;
322
323 typedef struct session_unlisten_msg_
324 {
325   u32 client_index;
326   u32 context;
327   u32 wrk_index;
328   session_handle_t handle;
329 } __clib_packed session_unlisten_msg_t;
330
331 typedef struct session_unlisten_reply_msg_
332 {
333   u32 context;
334   u64 handle;
335   i32 retval;
336 } __clib_packed session_unlisten_reply_msg_t;
337
338 typedef struct session_accepted_msg_
339 {
340   u32 context;
341   u64 listener_handle;
342   u64 handle;
343   uword server_rx_fifo;
344   uword server_tx_fifo;
345   u64 segment_handle;
346   uword vpp_event_queue_address;
347   transport_endpoint_t rmt;
348 } __clib_packed session_accepted_msg_t;
349
350 typedef struct session_accepted_reply_msg_
351 {
352   u32 context;
353   i32 retval;
354   u64 handle;
355 } __clib_packed session_accepted_reply_msg_t;
356
357 typedef struct session_connect_msg_
358 {
359   u32 client_index;
360   u32 context;
361   u32 wrk_index;
362   u32 vrf;
363   u16 port;
364   u8 proto;
365   u8 is_ip4;
366   ip46_address_t ip;
367   u8 hostname_len;
368   u8 hostname[16];
369   u64 parent_handle;
370   u32 ckpair_index;
371 } __clib_packed session_connect_msg_t;
372
373 typedef struct session_connect_uri_msg_
374 {
375   u32 client_index;
376   u32 context;
377   u8 uri[56];
378 } __clib_packed session_connect_uri_msg_t;
379
380 typedef struct session_connected_msg_
381 {
382   u32 context;
383   i32 retval;
384   u64 handle;
385   uword server_rx_fifo;
386   uword server_tx_fifo;
387   u64 segment_handle;
388   uword ct_rx_fifo;
389   uword ct_tx_fifo;
390   u64 ct_segment_handle;
391   uword vpp_event_queue_address;
392   u32 segment_size;
393   u8 segment_name_length;
394   u8 segment_name[64];
395   transport_endpoint_t lcl;
396 } __clib_packed session_connected_msg_t;
397
398 typedef struct session_disconnect_msg_
399 {
400   u32 client_index;
401   u32 context;
402   session_handle_t handle;
403 } __clib_packed session_disconnect_msg_t;
404
405 typedef struct session_disconnected_msg_
406 {
407   u32 client_index;
408   u32 context;
409   u64 handle;
410 } __clib_packed session_disconnected_msg_t;
411
412 typedef struct session_disconnected_reply_msg_
413 {
414   u32 context;
415   i32 retval;
416   u64 handle;
417 } __clib_packed session_disconnected_reply_msg_t;
418
419 typedef struct session_reset_msg_
420 {
421   u32 client_index;
422   u32 context;
423   u64 handle;
424 } __clib_packed session_reset_msg_t;
425
426 typedef struct session_reset_reply_msg_
427 {
428   u32 context;
429   i32 retval;
430   u64 handle;
431 } __clib_packed session_reset_reply_msg_t;
432
433 typedef struct session_req_worker_update_msg_
434 {
435   u64 session_handle;
436 } __clib_packed session_req_worker_update_msg_t;
437
438 /* NOTE: using u16 for wrk indices because message needs to fit in 18B */
439 typedef struct session_worker_update_msg_
440 {
441   u32 client_index;
442   u16 wrk_index;
443   u16 req_wrk_index;
444   u64 handle;
445 } __clib_packed session_worker_update_msg_t;
446
447 typedef struct session_worker_update_reply_msg_
448 {
449   u64 handle;
450   uword rx_fifo;
451   uword tx_fifo;
452   u64 segment_handle;
453 } __clib_packed session_worker_update_reply_msg_t;
454
455 typedef struct session_app_detach_msg_
456 {
457   u32 client_index;
458   u32 context;
459 } session_app_detach_msg_t;
460
461 typedef struct app_session_event_
462 {
463   svm_msg_q_msg_t msg;
464   session_event_t *evt;
465 } __clib_packed app_session_evt_t;
466
467 static inline void
468 app_alloc_ctrl_evt_to_vpp (svm_msg_q_t * mq, app_session_evt_t * app_evt,
469                            u8 evt_type)
470 {
471   svm_msg_q_lock_and_alloc_msg_w_ring (mq,
472                                        SESSION_MQ_CTRL_EVT_RING,
473                                        SVM_Q_WAIT, &app_evt->msg);
474   app_evt->evt = svm_msg_q_msg_data (mq, &app_evt->msg);
475   clib_memset (app_evt->evt, 0, sizeof (*app_evt->evt));
476   app_evt->evt->event_type = evt_type;
477 }
478
479 static inline void
480 app_send_ctrl_evt_to_vpp (svm_msg_q_t * mq, app_session_evt_t * app_evt)
481 {
482   svm_msg_q_add_and_unlock (mq, &app_evt->msg);
483 }
484
485 /**
486  * Send fifo io event to vpp worker thread
487  *
488  * Because there may be multiple writers to one of vpp's queues, this
489  * protects message allocation and enqueueing.
490  *
491  * @param mq            vpp message queue
492  * @param f             fifo for which the event is sent
493  * @param evt_type      type of event
494  * @param noblock       flag to indicate is request is blocking or not
495  * @return              0 if success, negative integer otherwise
496  */
497 static inline int
498 app_send_io_evt_to_vpp (svm_msg_q_t * mq, u32 session_index, u8 evt_type,
499                         u8 noblock)
500 {
501   session_event_t *evt;
502   svm_msg_q_msg_t msg;
503
504   if (noblock)
505     {
506       if (svm_msg_q_try_lock (mq))
507         return -1;
508       if (PREDICT_FALSE (svm_msg_q_ring_is_full (mq, SESSION_MQ_IO_EVT_RING)))
509         {
510           svm_msg_q_unlock (mq);
511           return -2;
512         }
513       msg = svm_msg_q_alloc_msg_w_ring (mq, SESSION_MQ_IO_EVT_RING);
514       evt = (session_event_t *) svm_msg_q_msg_data (mq, &msg);
515       evt->session_index = session_index;
516       evt->event_type = evt_type;
517       svm_msg_q_add_and_unlock (mq, &msg);
518       return 0;
519     }
520   else
521     {
522       svm_msg_q_lock (mq);
523       while (svm_msg_q_ring_is_full (mq, SESSION_MQ_IO_EVT_RING)
524              || svm_msg_q_is_full (mq))
525         svm_msg_q_wait (mq);
526       msg = svm_msg_q_alloc_msg_w_ring (mq, SESSION_MQ_IO_EVT_RING);
527       evt = (session_event_t *) svm_msg_q_msg_data (mq, &msg);
528       evt->session_index = session_index;
529       evt->event_type = evt_type;
530       svm_msg_q_add_and_unlock (mq, &msg);
531       return 0;
532     }
533 }
534
535 always_inline int
536 app_send_dgram_raw (svm_fifo_t * f, app_session_transport_t * at,
537                     svm_msg_q_t * vpp_evt_q, u8 * data, u32 len, u8 evt_type,
538                     u8 do_evt, u8 noblock)
539 {
540   u32 max_enqueue, actual_write;
541   session_dgram_hdr_t hdr;
542   int rv;
543
544   max_enqueue = svm_fifo_max_enqueue_prod (f);
545   if (max_enqueue <= sizeof (session_dgram_hdr_t))
546     return 0;
547
548   max_enqueue -= sizeof (session_dgram_hdr_t);
549   actual_write = clib_min (len, max_enqueue);
550   hdr.data_length = actual_write;
551   hdr.data_offset = 0;
552   clib_memcpy_fast (&hdr.rmt_ip, &at->rmt_ip, sizeof (ip46_address_t));
553   hdr.is_ip4 = at->is_ip4;
554   hdr.rmt_port = at->rmt_port;
555   clib_memcpy_fast (&hdr.lcl_ip, &at->lcl_ip, sizeof (ip46_address_t));
556   hdr.lcl_port = at->lcl_port;
557   rv = svm_fifo_enqueue (f, sizeof (hdr), (u8 *) & hdr);
558   ASSERT (rv == sizeof (hdr));
559
560   rv = svm_fifo_enqueue (f, actual_write, data);
561   if (do_evt)
562     {
563       if (rv > 0 && svm_fifo_set_event (f))
564         app_send_io_evt_to_vpp (vpp_evt_q, f->master_session_index, evt_type,
565                                 noblock);
566     }
567   ASSERT (rv);
568   return rv;
569 }
570
571 always_inline int
572 app_send_dgram (app_session_t * s, u8 * data, u32 len, u8 noblock)
573 {
574   return app_send_dgram_raw (s->tx_fifo, &s->transport, s->vpp_evt_q, data,
575                              len, SESSION_IO_EVT_TX, 1 /* do_evt */ ,
576                              noblock);
577 }
578
579 always_inline int
580 app_send_stream_raw (svm_fifo_t * f, svm_msg_q_t * vpp_evt_q, u8 * data,
581                      u32 len, u8 evt_type, u8 do_evt, u8 noblock)
582 {
583   int rv;
584
585   rv = svm_fifo_enqueue (f, len, data);
586   if (do_evt)
587     {
588       if (rv > 0 && svm_fifo_set_event (f))
589         app_send_io_evt_to_vpp (vpp_evt_q, f->master_session_index, evt_type,
590                                 noblock);
591     }
592   return rv;
593 }
594
595 always_inline int
596 app_send_stream (app_session_t * s, u8 * data, u32 len, u8 noblock)
597 {
598   return app_send_stream_raw (s->tx_fifo, s->vpp_evt_q, data, len,
599                               SESSION_IO_EVT_TX, 1 /* do_evt */ , noblock);
600 }
601
602 always_inline int
603 app_send (app_session_t * s, u8 * data, u32 len, u8 noblock)
604 {
605   if (s->is_dgram)
606     return app_send_dgram (s, data, len, noblock);
607   return app_send_stream (s, data, len, noblock);
608 }
609
610 always_inline int
611 app_recv_dgram_raw (svm_fifo_t * f, u8 * buf, u32 len,
612                     app_session_transport_t * at, u8 clear_evt, u8 peek)
613 {
614   session_dgram_pre_hdr_t ph;
615   u32 max_deq;
616   int rv;
617
618   max_deq = svm_fifo_max_dequeue_cons (f);
619   if (max_deq < sizeof (session_dgram_hdr_t))
620     {
621       if (clear_evt)
622         svm_fifo_unset_event (f);
623       return 0;
624     }
625
626   if (clear_evt)
627     svm_fifo_unset_event (f);
628
629   svm_fifo_peek (f, 0, sizeof (ph), (u8 *) & ph);
630   ASSERT (ph.data_length >= ph.data_offset);
631   if (!ph.data_offset)
632     svm_fifo_peek (f, sizeof (ph), sizeof (*at), (u8 *) at);
633   len = clib_min (len, ph.data_length - ph.data_offset);
634   rv = svm_fifo_peek (f, ph.data_offset + SESSION_CONN_HDR_LEN, len, buf);
635   if (peek)
636     return rv;
637   ph.data_offset += rv;
638   if (ph.data_offset == ph.data_length)
639     svm_fifo_dequeue_drop (f, ph.data_length + SESSION_CONN_HDR_LEN);
640   else
641     svm_fifo_overwrite_head (f, (u8 *) & ph, sizeof (ph));
642   return rv;
643 }
644
645 always_inline int
646 app_recv_dgram (app_session_t * s, u8 * buf, u32 len)
647 {
648   return app_recv_dgram_raw (s->rx_fifo, buf, len, &s->transport, 1, 0);
649 }
650
651 always_inline int
652 app_recv_stream_raw (svm_fifo_t * f, u8 * buf, u32 len, u8 clear_evt, u8 peek)
653 {
654   if (clear_evt)
655     svm_fifo_unset_event (f);
656
657   if (peek)
658     return svm_fifo_peek (f, 0, len, buf);
659
660   return svm_fifo_dequeue (f, len, buf);
661 }
662
663 always_inline int
664 app_recv_stream (app_session_t * s, u8 * buf, u32 len)
665 {
666   return app_recv_stream_raw (s->rx_fifo, buf, len, 1, 0);
667 }
668
669 always_inline int
670 app_recv (app_session_t * s, u8 * data, u32 len)
671 {
672   if (s->is_dgram)
673     return app_recv_dgram (s, data, len);
674   return app_recv_stream (s, data, len);
675 }
676
677 #endif /* __included_uri_h__ */
678
679 /*
680  * fd.io coding-style-patch-verification: ON
681  *
682  * Local Variables:
683  * eval: (c-set-style "gnu")
684  * End:
685  */