application_interface.h revision 98bd3580
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
24typedef 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
32typedef 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
81typedef 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
91typedef struct _vnet_app_detach_args_t
92{
93  u32 app_index;
94  u32 api_client_index;
95} vnet_app_detach_args_t;
96
97typedef 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
118typedef 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
129typedef 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
144typedef struct _vnet_disconnect_args_t
145{
146  session_handle_t handle;
147  u32 app_index;
148} vnet_disconnect_args_t;
149
150typedef 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
156typedef 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
162typedef enum crypto_engine_type_
163{
164  CRYPTO_ENGINE_NONE,
165  CRYPTO_ENGINE_OPENSSL,
166  CRYPTO_ENGINE_MBEDTLS,
167  CRYPTO_ENGINE_VPP,
168  CRYPTO_ENGINE_PICOTLS,
169  CRYPTO_ENGINE_LAST = CRYPTO_ENGINE_PICOTLS,
170} crypto_engine_type_t;
171
172typedef 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 */
180typedef 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
208typedef enum _app_options
209{
210#define _(sym, str) APP_OPTIONS_##sym,
211  foreach_app_options_flags
212#undef _
213} app_options_t;
214
215typedef 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
228typedef 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
236typedef 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
243int parse_uri (char *uri, session_endpoint_cfg_t * sep);
244int vnet_bind_uri (vnet_listen_args_t *);
245int vnet_unbind_uri (vnet_unlisten_args_t * a);
246int vnet_connect_uri (vnet_connect_args_t * a);
247
248int vnet_application_attach (vnet_app_attach_args_t * a);
249int vnet_application_detach (vnet_app_detach_args_t * a);
250int vnet_listen (vnet_listen_args_t * a);
251int vnet_connect (vnet_connect_args_t * a);
252int vnet_unlisten (vnet_unlisten_args_t * a);
253int vnet_disconnect_session (vnet_disconnect_args_t * a);
254
255clib_error_t *vnet_app_add_tls_cert (vnet_app_add_tls_cert_args_t * a);
256clib_error_t *vnet_app_add_tls_key (vnet_app_add_tls_key_args_t * a);
257int vnet_app_add_cert_key_pair (vnet_app_add_cert_key_pair_args_t * a);
258int vnet_app_del_cert_key_pair (u32 index);
259/** Ask for app cb on pair deletion */
260int vnet_app_add_cert_key_interest (u32 index, u32 app_index);
261
262typedef 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
281typedef struct
282{
283#define _(type, name) type name;
284  foreach_app_session_field
285#undef _
286} app_session_t;
287
288typedef 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
301STATIC_ASSERT (sizeof (session_listen_msg_t) <= SESSION_CTRL_MSG_MAX_SIZE,
302	       "msg too large");
303
304typedef struct session_listen_uri_msg_
305{
306  u32 client_index;
307  u32 context;
308  u8 uri[56];
309} __clib_packed session_listen_uri_msg_t;
310
311STATIC_ASSERT (sizeof (session_listen_uri_msg_t) <= SESSION_CTRL_MSG_MAX_SIZE,
312	       "msg too large");
313
314typedef struct session_bound_msg_
315{
316  u32 context;
317  u64 handle;
318  i32 retval;
319  u8 lcl_is_ip4;
320  u8 lcl_ip[16];
321  u16 lcl_port;
322  uword rx_fifo;
323  uword tx_fifo;
324  uword vpp_evt_q;
325  u32 segment_size;
326  u8 segment_name_length;
327  u8 segment_name[128];
328} __clib_packed session_bound_msg_t;
329
330typedef struct session_unlisten_msg_
331{
332  u32 client_index;
333  u32 context;
334  u32 wrk_index;
335  session_handle_t handle;
336} __clib_packed session_unlisten_msg_t;
337
338typedef struct session_unlisten_reply_msg_
339{
340  u32 context;
341  u64 handle;
342  i32 retval;
343} __clib_packed session_unlisten_reply_msg_t;
344
345typedef struct session_accepted_msg_
346{
347  u32 context;
348  u64 listener_handle;
349  u64 handle;
350  uword server_rx_fifo;
351  uword server_tx_fifo;
352  u64 segment_handle;
353  uword vpp_event_queue_address;
354  transport_endpoint_t rmt;
355} __clib_packed session_accepted_msg_t;
356
357typedef struct session_accepted_reply_msg_
358{
359  u32 context;
360  i32 retval;
361  u64 handle;
362} __clib_packed session_accepted_reply_msg_t;
363
364typedef struct session_connect_msg_
365{
366  u32 client_index;
367  u32 context;
368  u32 wrk_index;
369  u32 vrf;
370  u16 port;
371  u8 proto;
372  u8 is_ip4;
373  ip46_address_t ip;
374  ip46_address_t lcl_ip;
375  u8 hostname_len;
376  u8 hostname[16];
377  u64 parent_handle;
378  u32 ckpair_index;
379} __clib_packed session_connect_msg_t;
380
381STATIC_ASSERT (sizeof (session_connect_msg_t) <= SESSION_CTRL_MSG_MAX_SIZE,
382	       "msg too large");
383
384typedef struct session_connect_uri_msg_
385{
386  u32 client_index;
387  u32 context;
388  u8 uri[56];
389} __clib_packed session_connect_uri_msg_t;
390
391STATIC_ASSERT (sizeof (session_connect_uri_msg_t) <=
392	       SESSION_CTRL_MSG_MAX_SIZE, "msg too large");
393
394typedef struct session_connected_msg_
395{
396  u32 context;
397  i32 retval;
398  u64 handle;
399  uword server_rx_fifo;
400  uword server_tx_fifo;
401  u64 segment_handle;
402  uword ct_rx_fifo;
403  uword ct_tx_fifo;
404  u64 ct_segment_handle;
405  uword vpp_event_queue_address;
406  u32 segment_size;
407  u8 segment_name_length;
408  u8 segment_name[64];
409  transport_endpoint_t lcl;
410} __clib_packed session_connected_msg_t;
411
412typedef struct session_disconnect_msg_
413{
414  u32 client_index;
415  u32 context;
416  session_handle_t handle;
417} __clib_packed session_disconnect_msg_t;
418
419typedef struct session_disconnected_msg_
420{
421  u32 client_index;
422  u32 context;
423  u64 handle;
424} __clib_packed session_disconnected_msg_t;
425
426typedef struct session_disconnected_reply_msg_
427{
428  u32 context;
429  i32 retval;
430  u64 handle;
431} __clib_packed session_disconnected_reply_msg_t;
432
433typedef struct session_reset_msg_
434{
435  u32 client_index;
436  u32 context;
437  u64 handle;
438} __clib_packed session_reset_msg_t;
439
440typedef struct session_reset_reply_msg_
441{
442  u32 context;
443  i32 retval;
444  u64 handle;
445} __clib_packed session_reset_reply_msg_t;
446
447typedef struct session_req_worker_update_msg_
448{
449  u64 session_handle;
450} __clib_packed session_req_worker_update_msg_t;
451
452/* NOTE: using u16 for wrk indices because message needs to fit in 18B */
453typedef struct session_worker_update_msg_
454{
455  u32 client_index;
456  u16 wrk_index;
457  u16 req_wrk_index;
458  u64 handle;
459} __clib_packed session_worker_update_msg_t;
460
461typedef struct session_worker_update_reply_msg_
462{
463  u64 handle;
464  uword rx_fifo;
465  uword tx_fifo;
466  u64 segment_handle;
467} __clib_packed session_worker_update_reply_msg_t;
468
469typedef struct session_app_detach_msg_
470{
471  u32 client_index;
472  u32 context;
473} session_app_detach_msg_t;
474
475typedef struct app_session_event_
476{
477  svm_msg_q_msg_t msg;
478  session_event_t *evt;
479} __clib_packed app_session_evt_t;
480
481static inline void
482app_alloc_ctrl_evt_to_vpp (svm_msg_q_t * mq, app_session_evt_t * app_evt,
483			   u8 evt_type)
484{
485  svm_msg_q_lock_and_alloc_msg_w_ring (mq,
486				       SESSION_MQ_CTRL_EVT_RING,
487				       SVM_Q_WAIT, &app_evt->msg);
488  app_evt->evt = svm_msg_q_msg_data (mq, &app_evt->msg);
489  clib_memset (app_evt->evt, 0, sizeof (*app_evt->evt));
490  app_evt->evt->event_type = evt_type;
491}
492
493static inline void
494app_send_ctrl_evt_to_vpp (svm_msg_q_t * mq, app_session_evt_t * app_evt)
495{
496  svm_msg_q_add_and_unlock (mq, &app_evt->msg);
497}
498
499/**
500 * Send fifo io event to vpp worker thread
501 *
502 * Because there may be multiple writers to one of vpp's queues, this
503 * protects message allocation and enqueueing.
504 *
505 * @param mq		vpp message queue
506 * @param f		fifo for which the event is sent
507 * @param evt_type	type of event
508 * @param noblock	flag to indicate is request is blocking or not
509 * @return		0 if success, negative integer otherwise
510 */
511static inline int
512app_send_io_evt_to_vpp (svm_msg_q_t * mq, u32 session_index, u8 evt_type,
513			u8 noblock)
514{
515  session_event_t *evt;
516  svm_msg_q_msg_t msg;
517
518  if (noblock)
519    {
520      if (svm_msg_q_try_lock (mq))
521	return -1;
522      if (PREDICT_FALSE (svm_msg_q_ring_is_full (mq, SESSION_MQ_IO_EVT_RING)))
523	{
524	  svm_msg_q_unlock (mq);
525	  return -2;
526	}
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  else
535    {
536      svm_msg_q_lock (mq);
537      while (svm_msg_q_ring_is_full (mq, SESSION_MQ_IO_EVT_RING)
538	     || svm_msg_q_is_full (mq))
539	svm_msg_q_wait (mq);
540      msg = svm_msg_q_alloc_msg_w_ring (mq, SESSION_MQ_IO_EVT_RING);
541      evt = (session_event_t *) svm_msg_q_msg_data (mq, &msg);
542      evt->session_index = session_index;
543      evt->event_type = evt_type;
544      svm_msg_q_add_and_unlock (mq, &msg);
545      return 0;
546    }
547}
548
549always_inline int
550app_send_dgram_raw (svm_fifo_t * f, app_session_transport_t * at,
551		    svm_msg_q_t * vpp_evt_q, u8 * data, u32 len, u8 evt_type,
552		    u8 do_evt, u8 noblock)
553{
554  u32 max_enqueue, actual_write;
555  session_dgram_hdr_t hdr;
556  int rv;
557
558  max_enqueue = svm_fifo_max_enqueue_prod (f);
559  if (max_enqueue <= sizeof (session_dgram_hdr_t))
560    return 0;
561
562  max_enqueue -= sizeof (session_dgram_hdr_t);
563  actual_write = clib_min (len, max_enqueue);
564  hdr.data_length = actual_write;
565  hdr.data_offset = 0;
566  clib_memcpy_fast (&hdr.rmt_ip, &at->rmt_ip, sizeof (ip46_address_t));
567  hdr.is_ip4 = at->is_ip4;
568  hdr.rmt_port = at->rmt_port;
569  clib_memcpy_fast (&hdr.lcl_ip, &at->lcl_ip, sizeof (ip46_address_t));
570  hdr.lcl_port = at->lcl_port;
571  rv = svm_fifo_enqueue (f, sizeof (hdr), (u8 *) & hdr);
572  ASSERT (rv == sizeof (hdr));
573
574  rv = svm_fifo_enqueue (f, actual_write, data);
575  if (do_evt)
576    {
577      if (rv > 0 && svm_fifo_set_event (f))
578	app_send_io_evt_to_vpp (vpp_evt_q, f->master_session_index, evt_type,
579				noblock);
580    }
581  ASSERT (rv);
582  return rv;
583}
584
585always_inline int
586app_send_dgram (app_session_t * s, u8 * data, u32 len, u8 noblock)
587{
588  return app_send_dgram_raw (s->tx_fifo, &s->transport, s->vpp_evt_q, data,
589			     len, SESSION_IO_EVT_TX, 1 /* do_evt */ ,
590			     noblock);
591}
592
593always_inline int
594app_send_stream_raw (svm_fifo_t * f, svm_msg_q_t * vpp_evt_q, u8 * data,
595		     u32 len, u8 evt_type, u8 do_evt, u8 noblock)
596{
597  int rv;
598
599  rv = svm_fifo_enqueue (f, len, data);
600  if (do_evt)
601    {
602      if (rv > 0 && svm_fifo_set_event (f))
603	app_send_io_evt_to_vpp (vpp_evt_q, f->master_session_index, evt_type,
604				noblock);
605    }
606  return rv;
607}
608
609always_inline int
610app_send_stream (app_session_t * s, u8 * data, u32 len, u8 noblock)
611{
612  return app_send_stream_raw (s->tx_fifo, s->vpp_evt_q, data, len,
613			      SESSION_IO_EVT_TX, 1 /* do_evt */ , noblock);
614}
615
616always_inline int
617app_send (app_session_t * s, u8 * data, u32 len, u8 noblock)
618{
619  if (s->is_dgram)
620    return app_send_dgram (s, data, len, noblock);
621  return app_send_stream (s, data, len, noblock);
622}
623
624always_inline int
625app_recv_dgram_raw (svm_fifo_t * f, u8 * buf, u32 len,
626		    app_session_transport_t * at, u8 clear_evt, u8 peek)
627{
628  session_dgram_pre_hdr_t ph;
629  u32 max_deq;
630  int rv;
631
632  max_deq = svm_fifo_max_dequeue_cons (f);
633  if (max_deq < sizeof (session_dgram_hdr_t))
634    {
635      if (clear_evt)
636	svm_fifo_unset_event (f);
637      return 0;
638    }
639
640  if (clear_evt)
641    svm_fifo_unset_event (f);
642
643  svm_fifo_peek (f, 0, sizeof (ph), (u8 *) & ph);
644  ASSERT (ph.data_length >= ph.data_offset);
645  if (!ph.data_offset)
646    svm_fifo_peek (f, sizeof (ph), sizeof (*at), (u8 *) at);
647  len = clib_min (len, ph.data_length - ph.data_offset);
648  rv = svm_fifo_peek (f, ph.data_offset + SESSION_CONN_HDR_LEN, len, buf);
649  if (peek)
650    return rv;
651  ph.data_offset += rv;
652  if (ph.data_offset == ph.data_length)
653    svm_fifo_dequeue_drop (f, ph.data_length + SESSION_CONN_HDR_LEN);
654  else
655    svm_fifo_overwrite_head (f, (u8 *) & ph, sizeof (ph));
656  return rv;
657}
658
659always_inline int
660app_recv_dgram (app_session_t * s, u8 * buf, u32 len)
661{
662  return app_recv_dgram_raw (s->rx_fifo, buf, len, &s->transport, 1, 0);
663}
664
665always_inline int
666app_recv_stream_raw (svm_fifo_t * f, u8 * buf, u32 len, u8 clear_evt, u8 peek)
667{
668  if (clear_evt)
669    svm_fifo_unset_event (f);
670
671  if (peek)
672    return svm_fifo_peek (f, 0, len, buf);
673
674  return svm_fifo_dequeue (f, len, buf);
675}
676
677always_inline int
678app_recv_stream (app_session_t * s, u8 * buf, u32 len)
679{
680  return app_recv_stream_raw (s->rx_fifo, buf, len, 1, 0);
681}
682
683always_inline int
684app_recv (app_session_t * s, u8 * data, u32 len)
685{
686  if (s->is_dgram)
687    return app_recv_dgram (s, data, len);
688  return app_recv_stream (s, data, len);
689}
690
691#endif /* __included_uri_h__ */
692
693/*
694 * fd.io coding-style-patch-verification: ON
695 *
696 * Local Variables:
697 * eval: (c-set-style "gnu")
698 * End:
699 */
700