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