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