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:
7 * http://www.apache.org/licenses/LICENSE-2.0
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.
15 #ifndef __included_uri_h__
16 #define __included_uri_h__
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>
24 typedef struct certificate_
26 u32 *app_interests; /* vec of application index asking for deletion cb */
27 u32 cert_key_index; /* index in cert & key pool */
30 } app_cert_key_pair_t;
32 typedef struct session_cb_vft_
34 /** Notify server of new segment */
35 int (*add_segment_callback) (u32 app_wrk_index, u64 segment_handle);
37 /** Notify server of new segment */
38 int (*del_segment_callback) (u32 app_wrk_index, u64 segment_handle);
40 /** Notify server of newly accepted session */
41 int (*session_accept_callback) (session_t * new_session);
43 /** Connection request callback */
44 int (*session_connected_callback) (u32 app_wrk_index, u32 opaque,
45 session_t * s, session_error_t code);
47 /** Notify app that session is closing */
48 void (*session_disconnect_callback) (session_t * s);
50 /** Notify app that transport is closed */
51 void (*session_transport_closed_callback) (session_t * s);
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);
56 /** Notify app that session was reset */
57 void (*session_reset_callback) (session_t * s);
59 /** Notify app that session pool migration happened */
60 void (*session_migrate_callback) (session_t * s, session_handle_t new_sh);
62 /** Direct RX callback for built-in application */
63 int (*builtin_app_rx_callback) (session_t * session);
65 /** Direct TX callback for built-in application */
66 int (*builtin_app_tx_callback) (session_t * session);
68 /** Cert and key pair delete notification */
69 int (*app_cert_key_pair_delete_callback) (app_cert_key_pair_t * ckpair);
71 /** Delegate fifo-tuning-logic to application */
72 int (*fifo_tuning_callback) (session_t * s, svm_fifo_t * f,
73 session_ft_action_t act, u32 bytes);
77 #define foreach_app_init_args \
78 _(u32, api_client_index) \
81 _(u8 *, namespace_id) \
82 _(session_cb_vft_t *, session_cb_vft) \
86 typedef struct _vnet_app_attach_args_t
88 #define _(_type, _name) _type _name;
91 ssvm_private_t * segment;
92 svm_msg_q_t *app_evt_q;
94 } vnet_app_attach_args_t;
96 typedef struct _vnet_app_detach_args_t
100 } vnet_app_detach_args_t;
102 typedef struct _vnet_bind_args_t
106 session_endpoint_cfg_t sep_ext;
107 session_endpoint_t sep;
118 } vnet_listen_args_t;
120 typedef struct _vnet_unlisten_args_t
125 u64 handle; /**< Session handle */
127 u32 app_index; /**< Owning application index */
128 u32 wrk_map_index; /**< App's local pool worker index */
129 } vnet_unlisten_args_t;
131 typedef struct _vnet_connect_args
135 session_endpoint_cfg_t sep_ext;
136 session_endpoint_t sep;
142 } vnet_connect_args_t;
144 typedef struct _vnet_disconnect_args_t
146 session_handle_t handle;
148 } vnet_disconnect_args_t;
150 typedef struct _vnet_application_add_tls_cert_args_t
154 } vnet_app_add_tls_cert_args_t;
156 typedef struct _vnet_application_add_tls_key_args_t
160 } vnet_app_add_tls_key_args_t;
162 typedef enum crypto_engine_type_
165 CRYPTO_ENGINE_OPENSSL,
166 CRYPTO_ENGINE_MBEDTLS,
168 CRYPTO_ENGINE_PICOTLS,
169 CRYPTO_ENGINE_LAST = CRYPTO_ENGINE_PICOTLS,
170 } crypto_engine_type_t;
172 typedef struct _vnet_app_add_cert_key_pair_args_
179 } vnet_app_add_cert_key_pair_args_t;
181 typedef struct crypto_ctx_
183 u32 ctx_index; /**< index in crypto context pool */
184 u32 n_subscribers; /**< refcount of sessions using said context */
185 u32 ckpair_index; /**< certificate & key */
187 void *data; /**< protocol specific data */
190 /* Application attach options */
194 APP_OPTIONS_EVT_QUEUE_SIZE,
195 APP_OPTIONS_SEGMENT_SIZE,
196 APP_OPTIONS_ADD_SEGMENT_SIZE,
197 APP_OPTIONS_PRIVATE_SEGMENT_COUNT,
198 APP_OPTIONS_RX_FIFO_SIZE,
199 APP_OPTIONS_TX_FIFO_SIZE,
200 APP_OPTIONS_PREALLOC_FIFO_PAIRS,
201 APP_OPTIONS_PREALLOC_FIFO_HDRS,
202 APP_OPTIONS_NAMESPACE,
203 APP_OPTIONS_NAMESPACE_SECRET,
204 APP_OPTIONS_PROXY_TRANSPORT,
205 APP_OPTIONS_ACCEPT_COOKIE,
206 APP_OPTIONS_TLS_ENGINE,
207 APP_OPTIONS_MAX_FIFO_SIZE,
208 APP_OPTIONS_HIGH_WATERMARK,
209 APP_OPTIONS_LOW_WATERMARK,
210 APP_OPTIONS_PCT_FIRST_ALLOC,
211 APP_OPTIONS_N_OPTIONS
212 } app_attach_options_index_t;
214 #define foreach_app_options_flags \
215 _(ACCEPT_REDIRECT, "Use FIFO with redirects") \
216 _(ADD_SEGMENT, "Add segment and signal app if needed") \
217 _(IS_BUILTIN, "Application is builtin") \
218 _(IS_TRANSPORT_APP, "Application is a transport proto") \
219 _(IS_PROXY, "Application is proxying") \
220 _(USE_GLOBAL_SCOPE, "App can use global session scope") \
221 _(USE_LOCAL_SCOPE, "App can use local session scope") \
222 _(EVT_MQ_USE_EVENTFD, "Use eventfds for signaling") \
224 typedef enum _app_options
226 #define _(sym, str) APP_OPTIONS_##sym,
227 foreach_app_options_flags
231 typedef enum _app_options_flags
233 #define _(sym, str) APP_OPTIONS_FLAGS_##sym = 1 << APP_OPTIONS_##sym,
234 foreach_app_options_flags
236 } app_options_flags_t;
238 #define foreach_fd_type \
239 _(VPP_MQ_SEGMENT, "Fd for vpp's event mq segment") \
240 _(MEMFD_SEGMENT, "Fd for memfd segment") \
241 _(MQ_EVENTFD, "Event fd used by message queue") \
242 _(VPP_MQ_EVENTFD, "Event fd used by vpp's message queue") \
244 typedef enum session_fd_type_
246 #define _(sym, str) SESSION_FD_##sym,
252 typedef enum session_fd_flag_
254 #define _(sym, str) SESSION_FD_F_##sym = 1 << SESSION_FD_##sym,
259 int parse_uri (char *uri, session_endpoint_cfg_t * sep);
260 int vnet_bind_uri (vnet_listen_args_t *);
261 int vnet_unbind_uri (vnet_unlisten_args_t * a);
262 int vnet_connect_uri (vnet_connect_args_t * a);
264 int vnet_application_attach (vnet_app_attach_args_t * a);
265 int vnet_application_detach (vnet_app_detach_args_t * a);
266 int vnet_listen (vnet_listen_args_t * a);
267 int vnet_connect (vnet_connect_args_t * a);
268 int vnet_unlisten (vnet_unlisten_args_t * a);
269 int vnet_disconnect_session (vnet_disconnect_args_t * a);
271 int vnet_app_add_cert_key_pair (vnet_app_add_cert_key_pair_args_t * a);
272 int vnet_app_del_cert_key_pair (u32 index);
273 /** Ask for app cb on pair deletion */
274 int vnet_app_add_cert_key_interest (u32 index, u32 app_index);
276 typedef struct app_session_transport_
278 ip46_address_t rmt_ip; /**< remote ip */
279 ip46_address_t lcl_ip; /**< local ip */
280 u16 rmt_port; /**< remote port (network order) */
281 u16 lcl_port; /**< local port (network order) */
282 u8 is_ip4; /**< set if uses ip4 networking */
283 } app_session_transport_t;
285 #define foreach_app_session_field \
286 _(svm_fifo_t, *rx_fifo) /**< rx fifo */ \
287 _(svm_fifo_t, *tx_fifo) /**< tx fifo */ \
288 _(session_type_t, session_type) /**< session type */ \
289 _(volatile u8, session_state) /**< session state */ \
290 _(u32, session_index) /**< index in owning pool */ \
291 _(app_session_transport_t, transport) /**< transport info */ \
292 _(svm_msg_q_t, *vpp_evt_q) /**< vpp event queue */ \
293 _(u8, is_dgram) /**< flag for dgram mode */ \
297 #define _(type, name) type name;
298 foreach_app_session_field
302 typedef struct session_listen_msg_
305 u32 context; /* Not needed but keeping it for compatibility with bapi */
314 } __clib_packed session_listen_msg_t;
316 STATIC_ASSERT (sizeof (session_listen_msg_t) <= SESSION_CTRL_MSG_MAX_SIZE,
319 typedef struct session_listen_uri_msg_
324 } __clib_packed session_listen_uri_msg_t;
326 STATIC_ASSERT (sizeof (session_listen_uri_msg_t) <= SESSION_CTRL_MSG_MAX_SIZE,
329 typedef struct session_bound_msg_
341 } __clib_packed session_bound_msg_t;
343 typedef struct session_unlisten_msg_
348 session_handle_t handle;
349 } __clib_packed session_unlisten_msg_t;
351 typedef struct session_unlisten_reply_msg_
356 } __clib_packed session_unlisten_reply_msg_t;
358 typedef struct session_accepted_msg_
363 uword server_rx_fifo;
364 uword server_tx_fifo;
366 uword vpp_event_queue_address;
368 transport_endpoint_t rmt;
370 } __clib_packed session_accepted_msg_t;
372 typedef struct session_accepted_reply_msg_
377 } __clib_packed session_accepted_reply_msg_t;
379 typedef struct session_connect_msg_
390 ip46_address_t lcl_ip;
396 } __clib_packed session_connect_msg_t;
398 STATIC_ASSERT (sizeof (session_connect_msg_t) <= SESSION_CTRL_MSG_MAX_SIZE,
401 typedef struct session_connect_uri_msg_
406 } __clib_packed session_connect_uri_msg_t;
408 STATIC_ASSERT (sizeof (session_connect_uri_msg_t) <=
409 SESSION_CTRL_MSG_MAX_SIZE, "msg too large");
411 typedef struct session_connected_msg_
416 uword server_rx_fifo;
417 uword server_tx_fifo;
421 u64 ct_segment_handle;
422 uword vpp_event_queue_address;
424 u8 segment_name_length;
426 transport_endpoint_t lcl;
427 } __clib_packed session_connected_msg_t;
429 typedef struct session_disconnect_msg_
433 session_handle_t handle;
434 } __clib_packed session_disconnect_msg_t;
436 typedef struct session_disconnected_msg_
441 } __clib_packed session_disconnected_msg_t;
443 typedef struct session_disconnected_reply_msg_
448 } __clib_packed session_disconnected_reply_msg_t;
450 typedef struct session_reset_msg_
455 } __clib_packed session_reset_msg_t;
457 typedef struct session_reset_reply_msg_
462 } __clib_packed session_reset_reply_msg_t;
464 typedef struct session_req_worker_update_msg_
467 } __clib_packed session_req_worker_update_msg_t;
469 /* NOTE: using u16 for wrk indices because message needs to fit in 18B */
470 typedef struct session_worker_update_msg_
476 } __clib_packed session_worker_update_msg_t;
478 typedef struct session_worker_update_reply_msg_
484 } __clib_packed session_worker_update_reply_msg_t;
486 typedef struct session_app_detach_msg_
490 } session_app_detach_msg_t;
492 typedef struct app_map_another_segment_msg_
498 u8 segment_name[128];
500 } session_app_add_segment_msg_t;
502 typedef struct app_unmap_segment_msg_
507 } session_app_del_segment_msg_t;
509 typedef struct session_migrate_msg_
512 session_handle_t handle;
513 session_handle_t new_handle;
515 u32 vpp_thread_index;
516 } __clib_packed session_migrated_msg_t;
518 typedef struct session_cleanup_msg_
520 session_handle_t handle;
522 } __clib_packed session_cleanup_msg_t;
524 typedef struct session_app_wrk_rpc_msg_
526 u32 client_index; /**< app client index */
527 u32 wrk_index; /**< dst worker index */
528 u8 data[64]; /**< rpc data */
529 } __clib_packed session_app_wrk_rpc_msg_t;
531 typedef struct session_transport_attr_msg_
534 session_handle_t handle;
535 transport_endpt_attr_t attr;
537 } __clib_packed session_transport_attr_msg_t;
539 typedef struct session_transport_attr_reply_msg_
542 session_handle_t handle;
543 transport_endpt_attr_t attr;
545 } __clib_packed session_transport_attr_reply_msg_t;
547 typedef struct app_session_event_
550 session_event_t *evt;
551 } __clib_packed app_session_evt_t;
554 app_alloc_ctrl_evt_to_vpp (svm_msg_q_t * mq, app_session_evt_t * app_evt,
557 svm_msg_q_lock_and_alloc_msg_w_ring (mq,
558 SESSION_MQ_CTRL_EVT_RING,
559 SVM_Q_WAIT, &app_evt->msg);
560 app_evt->evt = svm_msg_q_msg_data (mq, &app_evt->msg);
561 clib_memset (app_evt->evt, 0, sizeof (*app_evt->evt));
562 app_evt->evt->event_type = evt_type;
566 app_send_ctrl_evt_to_vpp (svm_msg_q_t * mq, app_session_evt_t * app_evt)
568 svm_msg_q_add_and_unlock (mq, &app_evt->msg);
572 * Send fifo io event to vpp worker thread
574 * Because there may be multiple writers to one of vpp's queues, this
575 * protects message allocation and enqueueing.
577 * @param mq vpp message queue
578 * @param f fifo for which the event is sent
579 * @param evt_type type of event
580 * @param noblock flag to indicate is request is blocking or not
581 * @return 0 if success, negative integer otherwise
584 app_send_io_evt_to_vpp (svm_msg_q_t * mq, u32 session_index, u8 evt_type,
587 session_event_t *evt;
592 if (svm_msg_q_try_lock (mq))
594 if (PREDICT_FALSE (svm_msg_q_ring_is_full (mq, SESSION_MQ_IO_EVT_RING)
595 || svm_msg_q_is_full (mq)))
597 svm_msg_q_unlock (mq);
600 msg = svm_msg_q_alloc_msg_w_ring (mq, SESSION_MQ_IO_EVT_RING);
601 evt = (session_event_t *) svm_msg_q_msg_data (mq, &msg);
602 evt->session_index = session_index;
603 evt->event_type = evt_type;
604 svm_msg_q_add_and_unlock (mq, &msg);
610 while (svm_msg_q_ring_is_full (mq, SESSION_MQ_IO_EVT_RING)
611 || svm_msg_q_is_full (mq))
612 svm_msg_q_wait_prod (mq);
613 msg = svm_msg_q_alloc_msg_w_ring (mq, SESSION_MQ_IO_EVT_RING);
614 evt = (session_event_t *) svm_msg_q_msg_data (mq, &msg);
615 evt->session_index = session_index;
616 evt->event_type = evt_type;
617 svm_msg_q_add_and_unlock (mq, &msg);
623 app_send_dgram_raw (svm_fifo_t * f, app_session_transport_t * at,
624 svm_msg_q_t * vpp_evt_q, u8 * data, u32 len, u8 evt_type,
625 u8 do_evt, u8 noblock)
627 session_dgram_hdr_t hdr;
630 if (svm_fifo_max_enqueue_prod (f) < (sizeof (session_dgram_hdr_t) + len))
633 hdr.data_length = len;
635 clib_memcpy_fast (&hdr.rmt_ip, &at->rmt_ip, sizeof (ip46_address_t));
636 hdr.is_ip4 = at->is_ip4;
637 hdr.rmt_port = at->rmt_port;
638 clib_memcpy_fast (&hdr.lcl_ip, &at->lcl_ip, sizeof (ip46_address_t));
639 hdr.lcl_port = at->lcl_port;
642 svm_fifo_seg_t segs[2] = {{ (u8 *) &hdr, sizeof (hdr) }, { data, len }};
645 rv = svm_fifo_enqueue_segments (f, segs, 2, 0 /* allow partial */ );
646 if (PREDICT_FALSE (rv < 0))
651 if (svm_fifo_set_event (f))
652 app_send_io_evt_to_vpp (vpp_evt_q, f->shr->master_session_index,
659 app_send_dgram (app_session_t * s, u8 * data, u32 len, u8 noblock)
661 return app_send_dgram_raw (s->tx_fifo, &s->transport, s->vpp_evt_q, data,
662 len, SESSION_IO_EVT_TX, 1 /* do_evt */ ,
667 app_send_stream_raw (svm_fifo_t * f, svm_msg_q_t * vpp_evt_q, u8 * data,
668 u32 len, u8 evt_type, u8 do_evt, u8 noblock)
672 rv = svm_fifo_enqueue (f, len, data);
675 if (rv > 0 && svm_fifo_set_event (f))
676 app_send_io_evt_to_vpp (vpp_evt_q, f->shr->master_session_index,
683 app_send_stream (app_session_t * s, u8 * data, u32 len, u8 noblock)
685 return app_send_stream_raw (s->tx_fifo, s->vpp_evt_q, data, len,
686 SESSION_IO_EVT_TX, 1 /* do_evt */ , noblock);
690 app_send (app_session_t * s, u8 * data, u32 len, u8 noblock)
693 return app_send_dgram (s, data, len, noblock);
694 return app_send_stream (s, data, len, noblock);
698 app_recv_dgram_raw (svm_fifo_t * f, u8 * buf, u32 len,
699 app_session_transport_t * at, u8 clear_evt, u8 peek)
701 session_dgram_pre_hdr_t ph;
705 max_deq = svm_fifo_max_dequeue_cons (f);
706 if (max_deq <= sizeof (session_dgram_hdr_t))
709 svm_fifo_unset_event (f);
714 svm_fifo_unset_event (f);
716 svm_fifo_peek (f, 0, sizeof (ph), (u8 *) & ph);
717 ASSERT (ph.data_length >= ph.data_offset);
719 /* Check if we have the full dgram */
720 if (max_deq < (ph.data_length + SESSION_CONN_HDR_LEN)
721 && len >= ph.data_length)
724 svm_fifo_peek (f, sizeof (ph), sizeof (*at), (u8 *) at);
725 len = clib_min (len, ph.data_length - ph.data_offset);
726 rv = svm_fifo_peek (f, ph.data_offset + SESSION_CONN_HDR_LEN, len, buf);
730 /* Discards data that did not fit in buffer */
731 svm_fifo_dequeue_drop (f, ph.data_length + SESSION_CONN_HDR_LEN);
737 app_recv_dgram (app_session_t * s, u8 * buf, u32 len)
739 return app_recv_dgram_raw (s->rx_fifo, buf, len, &s->transport, 1, 0);
743 app_recv_stream_raw (svm_fifo_t * f, u8 * buf, u32 len, u8 clear_evt, u8 peek)
746 svm_fifo_unset_event (f);
749 return svm_fifo_peek (f, 0, len, buf);
751 return svm_fifo_dequeue (f, len, buf);
755 app_recv_stream (app_session_t * s, u8 * buf, u32 len)
757 return app_recv_stream_raw (s->rx_fifo, buf, len, 1, 0);
761 app_recv (app_session_t * s, u8 * data, u32 len)
764 return app_recv_dgram (s, data, len);
765 return app_recv_stream (s, data, len);
769 static char *session_error_str[] = {
770 #define _(sym, str) str,
771 foreach_session_error
777 format_session_error (u8 * s, va_list * args)
779 session_error_t error = va_arg (*args, session_error_t);
780 if (-error >= 0 && -error < SESSION_N_ERRORS)
781 s = format (s, "%s", session_error_str[-error]);
783 s = format (s, "invalid session err %u", -error);
788 * Socket API messages
791 typedef enum app_sapi_msg_type
793 APP_SAPI_MSG_TYPE_NONE,
794 APP_SAPI_MSG_TYPE_ATTACH,
795 APP_SAPI_MSG_TYPE_ATTACH_REPLY,
796 APP_SAPI_MSG_TYPE_ADD_DEL_WORKER,
797 APP_SAPI_MSG_TYPE_ADD_DEL_WORKER_REPLY,
798 APP_SAPI_MSG_TYPE_SEND_FDS,
799 } __clib_packed app_sapi_msg_type_e;
801 typedef struct app_sapi_attach_msg_
805 } __clib_packed app_sapi_attach_msg_t;
807 STATIC_ASSERT (sizeof (u64) * APP_OPTIONS_N_OPTIONS <=
808 sizeof (((app_sapi_attach_msg_t *) 0)->options),
809 "Out of options, fix message definition");
811 typedef struct app_sapi_attach_reply_msg_
818 u32 api_client_handle;
819 u8 vpp_ctrl_mq_thread;
822 } __clib_packed app_sapi_attach_reply_msg_t;
824 typedef struct app_sapi_worker_add_del_msg_
829 } __clib_packed app_sapi_worker_add_del_msg_t;
831 typedef struct app_sapi_worker_add_del_reply_msg_
835 u64 app_event_queue_address;
837 u32 api_client_handle;
841 } __clib_packed app_sapi_worker_add_del_reply_msg_t;
843 typedef struct app_sapi_msg_
845 app_sapi_msg_type_e type;
848 app_sapi_attach_msg_t attach;
849 app_sapi_attach_reply_msg_t attach_reply;
850 app_sapi_worker_add_del_msg_t worker_add_del;
851 app_sapi_worker_add_del_reply_msg_t worker_add_del_reply;
853 } __clib_packed app_sapi_msg_t;
856 session_endpoint_alloc_ext_cfg (session_endpoint_cfg_t *sep_ext,
857 transport_endpt_ext_cfg_type_t type)
859 transport_endpt_ext_cfg_t *cfg;
862 cfg_size = sizeof (transport_endpt_ext_cfg_t);
863 cfg = clib_mem_alloc (cfg_size);
864 clib_memset (cfg, 0, cfg_size);
866 sep_ext->ext_cfg = cfg;
869 #endif /* __included_uri_h__ */
872 * fd.io coding-style-patch-verification: ON
875 * eval: (c-set-style "gnu")