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 half open state was cleaned up (optional) */
57 void (*half_open_cleanup_callback) (session_t *s);
59 /** Notify app that session was reset */
60 void (*session_reset_callback) (session_t * s);
62 /** Notify app that session pool migration happened */
63 void (*session_migrate_callback) (session_t * s, session_handle_t new_sh);
65 /** Direct RX callback for built-in application */
66 int (*builtin_app_rx_callback) (session_t * session);
68 /** Direct TX callback for built-in application */
69 int (*builtin_app_tx_callback) (session_t * session);
71 /** Cert and key pair delete notification */
72 int (*app_cert_key_pair_delete_callback) (app_cert_key_pair_t * ckpair);
74 /** Delegate fifo-tuning-logic to application */
75 int (*fifo_tuning_callback) (session_t * s, svm_fifo_t * f,
76 session_ft_action_t act, u32 bytes);
80 #define foreach_app_init_args \
81 _(u32, api_client_index) \
84 _(u8 *, namespace_id) \
85 _(session_cb_vft_t *, session_cb_vft) \
89 typedef struct _vnet_app_attach_args_t
91 #define _(_type, _name) _type _name;
94 ssvm_private_t * segment;
95 svm_msg_q_t *app_evt_q;
97 } vnet_app_attach_args_t;
99 typedef struct _vnet_app_detach_args_t
102 u32 api_client_index;
103 } vnet_app_detach_args_t;
105 typedef struct _vnet_bind_args_t
109 session_endpoint_cfg_t sep_ext;
110 session_endpoint_t sep;
121 } vnet_listen_args_t;
123 typedef struct _vnet_unlisten_args_t
128 u64 handle; /**< Session handle */
130 u32 app_index; /**< Owning application index */
131 u32 wrk_map_index; /**< App's local pool worker index */
132 } vnet_unlisten_args_t;
134 typedef struct _vnet_connect_args
138 session_endpoint_cfg_t sep_ext;
139 session_endpoint_t sep;
146 /* Resulting session, or half-open session, if connect successful */
148 } vnet_connect_args_t;
150 typedef struct _vnet_shutdown_args_t
152 session_handle_t handle;
154 } vnet_shutdown_args_t;
156 typedef struct _vnet_disconnect_args_t
158 session_handle_t handle;
160 } vnet_disconnect_args_t;
162 typedef struct _vnet_application_add_tls_cert_args_t
166 } vnet_app_add_tls_cert_args_t;
168 typedef struct _vnet_application_add_tls_key_args_t
172 } vnet_app_add_tls_key_args_t;
174 typedef enum crypto_engine_type_
177 CRYPTO_ENGINE_OPENSSL,
178 CRYPTO_ENGINE_MBEDTLS,
180 CRYPTO_ENGINE_PICOTLS,
181 CRYPTO_ENGINE_LAST = CRYPTO_ENGINE_PICOTLS,
182 } crypto_engine_type_t;
184 typedef struct _vnet_app_add_cert_key_pair_args_
191 } vnet_app_add_cert_key_pair_args_t;
193 typedef struct crypto_ctx_
195 u32 ctx_index; /**< index in crypto context pool */
196 u32 n_subscribers; /**< refcount of sessions using said context */
197 u32 ckpair_index; /**< certificate & key */
199 void *data; /**< protocol specific data */
202 /* Application attach options */
206 APP_OPTIONS_EVT_QUEUE_SIZE,
207 APP_OPTIONS_SEGMENT_SIZE,
208 APP_OPTIONS_ADD_SEGMENT_SIZE,
209 APP_OPTIONS_PRIVATE_SEGMENT_COUNT,
210 APP_OPTIONS_RX_FIFO_SIZE,
211 APP_OPTIONS_TX_FIFO_SIZE,
212 APP_OPTIONS_PREALLOC_FIFO_PAIRS,
213 APP_OPTIONS_PREALLOC_FIFO_HDRS,
214 APP_OPTIONS_NAMESPACE,
215 APP_OPTIONS_NAMESPACE_SECRET,
216 APP_OPTIONS_PROXY_TRANSPORT,
217 APP_OPTIONS_ACCEPT_COOKIE,
218 APP_OPTIONS_TLS_ENGINE,
219 APP_OPTIONS_MAX_FIFO_SIZE,
220 APP_OPTIONS_HIGH_WATERMARK,
221 APP_OPTIONS_LOW_WATERMARK,
222 APP_OPTIONS_PCT_FIRST_ALLOC,
223 APP_OPTIONS_N_OPTIONS
224 } app_attach_options_index_t;
226 #define foreach_app_options_flags \
227 _ (ACCEPT_REDIRECT, "Use FIFO with redirects") \
228 _ (ADD_SEGMENT, "Add segment and signal app if needed") \
229 _ (IS_BUILTIN, "Application is builtin") \
230 _ (IS_TRANSPORT_APP, "Application is a transport proto") \
231 _ (IS_PROXY, "Application is proxying") \
232 _ (USE_GLOBAL_SCOPE, "App can use global session scope") \
233 _ (USE_LOCAL_SCOPE, "App can use local session scope") \
234 _ (EVT_MQ_USE_EVENTFD, "Use eventfds for signaling") \
235 _ (MEMFD_FOR_BUILTIN, "Use memfd for builtin app segs") \
236 _ (USE_HUGE_PAGE, "Use huge page for FIFO")
238 typedef enum _app_options
240 #define _(sym, str) APP_OPTIONS_##sym,
241 foreach_app_options_flags
245 typedef enum _app_options_flags
247 #define _(sym, str) APP_OPTIONS_FLAGS_##sym = 1 << APP_OPTIONS_##sym,
248 foreach_app_options_flags
250 } app_options_flags_t;
252 #define foreach_fd_type \
253 _(VPP_MQ_SEGMENT, "Fd for vpp's event mq segment") \
254 _(MEMFD_SEGMENT, "Fd for memfd segment") \
255 _(MQ_EVENTFD, "Event fd used by message queue") \
256 _(VPP_MQ_EVENTFD, "Event fd used by vpp's message queue") \
258 typedef enum session_fd_type_
260 #define _(sym, str) SESSION_FD_##sym,
266 typedef enum session_fd_flag_
268 #define _(sym, str) SESSION_FD_F_##sym = 1 << SESSION_FD_##sym,
273 int parse_uri (char *uri, session_endpoint_cfg_t * sep);
274 int vnet_bind_uri (vnet_listen_args_t *);
275 int vnet_unbind_uri (vnet_unlisten_args_t * a);
276 int vnet_connect_uri (vnet_connect_args_t * a);
278 int vnet_application_attach (vnet_app_attach_args_t * a);
279 int vnet_application_detach (vnet_app_detach_args_t * a);
280 int vnet_listen (vnet_listen_args_t * a);
281 int vnet_connect (vnet_connect_args_t * a);
282 int vnet_unlisten (vnet_unlisten_args_t * a);
283 int vnet_shutdown_session (vnet_shutdown_args_t *a);
284 int vnet_disconnect_session (vnet_disconnect_args_t * a);
286 int vnet_app_add_cert_key_pair (vnet_app_add_cert_key_pair_args_t * a);
287 int vnet_app_del_cert_key_pair (u32 index);
288 /** Ask for app cb on pair deletion */
289 int vnet_app_add_cert_key_interest (u32 index, u32 app_index);
291 uword unformat_vnet_uri (unformat_input_t *input, va_list *args);
293 typedef struct app_session_transport_
295 ip46_address_t rmt_ip; /**< remote ip */
296 ip46_address_t lcl_ip; /**< local ip */
297 u16 rmt_port; /**< remote port (network order) */
298 u16 lcl_port; /**< local port (network order) */
299 u8 is_ip4; /**< set if uses ip4 networking */
300 } app_session_transport_t;
302 #define foreach_app_session_field \
303 _(svm_fifo_t, *rx_fifo) /**< rx fifo */ \
304 _(svm_fifo_t, *tx_fifo) /**< tx fifo */ \
305 _(session_type_t, session_type) /**< session type */ \
306 _(volatile u8, session_state) /**< session state */ \
307 _(u32, session_index) /**< index in owning pool */ \
308 _(app_session_transport_t, transport) /**< transport info */ \
309 _(svm_msg_q_t, *vpp_evt_q) /**< vpp event queue */ \
310 _(u8, is_dgram) /**< flag for dgram mode */ \
314 #define _(type, name) type name;
315 foreach_app_session_field
319 typedef struct session_listen_msg_
322 u32 context; /* Not needed but keeping it for compatibility with bapi */
331 } __clib_packed session_listen_msg_t;
333 STATIC_ASSERT (sizeof (session_listen_msg_t) <= SESSION_CTRL_MSG_MAX_SIZE,
336 typedef struct session_listen_uri_msg_
341 } __clib_packed session_listen_uri_msg_t;
343 STATIC_ASSERT (sizeof (session_listen_uri_msg_t) <= SESSION_CTRL_MSG_MAX_SIZE,
346 typedef struct session_bound_msg_
359 } __clib_packed session_bound_msg_t;
361 typedef struct session_unlisten_msg_
366 session_handle_t handle;
367 } __clib_packed session_unlisten_msg_t;
369 typedef struct session_unlisten_reply_msg_
374 } __clib_packed session_unlisten_reply_msg_t;
376 typedef struct session_accepted_msg_
381 uword server_rx_fifo;
382 uword server_tx_fifo;
384 uword vpp_event_queue_address;
386 transport_endpoint_t lcl;
387 transport_endpoint_t rmt;
389 } __clib_packed session_accepted_msg_t;
391 typedef struct session_accepted_reply_msg_
396 } __clib_packed session_accepted_reply_msg_t;
398 typedef struct session_connect_msg_
409 ip46_address_t lcl_ip;
416 } __clib_packed session_connect_msg_t;
418 STATIC_ASSERT (sizeof (session_connect_msg_t) <= SESSION_CTRL_MSG_MAX_SIZE,
421 typedef struct session_connect_uri_msg_
426 } __clib_packed session_connect_uri_msg_t;
428 STATIC_ASSERT (sizeof (session_connect_uri_msg_t) <=
429 SESSION_CTRL_MSG_MAX_SIZE, "msg too large");
431 typedef struct session_connected_msg_
436 uword server_rx_fifo;
437 uword server_tx_fifo;
441 u64 ct_segment_handle;
442 uword vpp_event_queue_address;
443 transport_endpoint_t lcl;
445 } __clib_packed session_connected_msg_t;
447 typedef struct session_shutdown_msg_
451 session_handle_t handle;
452 } __clib_packed session_shutdown_msg_t;
454 typedef struct session_disconnect_msg_
458 session_handle_t handle;
459 } __clib_packed session_disconnect_msg_t;
461 typedef struct session_disconnected_msg_
466 } __clib_packed session_disconnected_msg_t;
468 typedef struct session_disconnected_reply_msg_
473 } __clib_packed session_disconnected_reply_msg_t;
475 typedef struct session_reset_msg_
480 } __clib_packed session_reset_msg_t;
482 typedef struct session_reset_reply_msg_
487 } __clib_packed session_reset_reply_msg_t;
489 typedef struct session_req_worker_update_msg_
492 } __clib_packed session_req_worker_update_msg_t;
494 /* NOTE: using u16 for wrk indices because message needs to fit in 18B */
495 typedef struct session_worker_update_msg_
501 } __clib_packed session_worker_update_msg_t;
503 typedef struct session_worker_update_reply_msg_
509 } __clib_packed session_worker_update_reply_msg_t;
511 typedef struct session_app_detach_msg_
515 } session_app_detach_msg_t;
517 typedef struct app_map_another_segment_msg_
523 u8 segment_name[128];
525 } session_app_add_segment_msg_t;
527 typedef struct app_unmap_segment_msg_
532 } session_app_del_segment_msg_t;
534 typedef struct session_migrate_msg_
537 session_handle_t handle;
538 session_handle_t new_handle;
540 u32 vpp_thread_index;
541 } __clib_packed session_migrated_msg_t;
543 typedef struct session_cleanup_msg_
545 session_handle_t handle;
547 } __clib_packed session_cleanup_msg_t;
549 typedef struct session_app_wrk_rpc_msg_
551 u32 client_index; /**< app client index */
552 u32 wrk_index; /**< dst worker index */
553 u8 data[64]; /**< rpc data */
554 } __clib_packed session_app_wrk_rpc_msg_t;
556 typedef struct session_transport_attr_msg_
559 session_handle_t handle;
560 transport_endpt_attr_t attr;
562 } __clib_packed session_transport_attr_msg_t;
564 typedef struct session_transport_attr_reply_msg_
567 session_handle_t handle;
568 transport_endpt_attr_t attr;
570 } __clib_packed session_transport_attr_reply_msg_t;
572 typedef struct app_session_event_
575 session_event_t *evt;
576 } __clib_packed app_session_evt_t;
579 app_alloc_ctrl_evt_to_vpp (svm_msg_q_t * mq, app_session_evt_t * app_evt,
582 svm_msg_q_lock_and_alloc_msg_w_ring (mq,
583 SESSION_MQ_CTRL_EVT_RING,
584 SVM_Q_WAIT, &app_evt->msg);
585 app_evt->evt = svm_msg_q_msg_data (mq, &app_evt->msg);
586 clib_memset (app_evt->evt, 0, sizeof (*app_evt->evt));
587 app_evt->evt->event_type = evt_type;
591 app_send_ctrl_evt_to_vpp (svm_msg_q_t * mq, app_session_evt_t * app_evt)
593 svm_msg_q_add_and_unlock (mq, &app_evt->msg);
597 * Send fifo io event to vpp worker thread
599 * Because there may be multiple writers to one of vpp's queues, this
600 * protects message allocation and enqueueing.
602 * @param mq vpp message queue
603 * @param f fifo for which the event is sent
604 * @param evt_type type of event
605 * @param noblock flag to indicate is request is blocking or not
606 * @return 0 if success, negative integer otherwise
609 app_send_io_evt_to_vpp (svm_msg_q_t * mq, u32 session_index, u8 evt_type,
612 session_event_t *evt;
617 if (svm_msg_q_try_lock (mq))
620 svm_msg_q_or_ring_is_full (mq, SESSION_MQ_IO_EVT_RING)))
622 svm_msg_q_unlock (mq);
625 msg = svm_msg_q_alloc_msg_w_ring (mq, SESSION_MQ_IO_EVT_RING);
626 evt = (session_event_t *) svm_msg_q_msg_data (mq, &msg);
627 evt->session_index = session_index;
628 evt->event_type = evt_type;
629 svm_msg_q_add_and_unlock (mq, &msg);
635 while (svm_msg_q_or_ring_is_full (mq, SESSION_MQ_IO_EVT_RING))
636 svm_msg_q_or_ring_wait_prod (mq, SESSION_MQ_IO_EVT_RING);
637 msg = svm_msg_q_alloc_msg_w_ring (mq, SESSION_MQ_IO_EVT_RING);
638 evt = (session_event_t *) svm_msg_q_msg_data (mq, &msg);
639 evt->session_index = session_index;
640 evt->event_type = evt_type;
641 svm_msg_q_add_and_unlock (mq, &msg);
647 app_send_dgram_raw (svm_fifo_t * f, app_session_transport_t * at,
648 svm_msg_q_t * vpp_evt_q, u8 * data, u32 len, u8 evt_type,
649 u8 do_evt, u8 noblock)
651 session_dgram_hdr_t hdr;
654 if (svm_fifo_max_enqueue_prod (f) < (sizeof (session_dgram_hdr_t) + len))
657 hdr.data_length = len;
659 clib_memcpy_fast (&hdr.rmt_ip, &at->rmt_ip, sizeof (ip46_address_t));
660 hdr.is_ip4 = at->is_ip4;
661 hdr.rmt_port = at->rmt_port;
662 clib_memcpy_fast (&hdr.lcl_ip, &at->lcl_ip, sizeof (ip46_address_t));
663 hdr.lcl_port = at->lcl_port;
666 svm_fifo_seg_t segs[2] = {{ (u8 *) &hdr, sizeof (hdr) }, { data, len }};
669 rv = svm_fifo_enqueue_segments (f, segs, 2, 0 /* allow partial */ );
670 if (PREDICT_FALSE (rv < 0))
675 if (svm_fifo_set_event (f))
676 app_send_io_evt_to_vpp (vpp_evt_q, f->shr->master_session_index,
683 app_send_dgram (app_session_t * s, u8 * data, u32 len, u8 noblock)
685 return app_send_dgram_raw (s->tx_fifo, &s->transport, s->vpp_evt_q, data,
686 len, SESSION_IO_EVT_TX, 1 /* do_evt */ ,
691 app_send_stream_raw (svm_fifo_t * f, svm_msg_q_t * vpp_evt_q, u8 * data,
692 u32 len, u8 evt_type, u8 do_evt, u8 noblock)
696 rv = svm_fifo_enqueue (f, len, data);
699 if (rv > 0 && svm_fifo_set_event (f))
700 app_send_io_evt_to_vpp (vpp_evt_q, f->shr->master_session_index,
707 app_send_stream (app_session_t * s, u8 * data, u32 len, u8 noblock)
709 return app_send_stream_raw (s->tx_fifo, s->vpp_evt_q, data, len,
710 SESSION_IO_EVT_TX, 1 /* do_evt */ , noblock);
714 app_send (app_session_t * s, u8 * data, u32 len, u8 noblock)
717 return app_send_dgram (s, data, len, noblock);
718 return app_send_stream (s, data, len, noblock);
722 app_recv_dgram_raw (svm_fifo_t * f, u8 * buf, u32 len,
723 app_session_transport_t * at, u8 clear_evt, u8 peek)
725 session_dgram_pre_hdr_t ph;
729 max_deq = svm_fifo_max_dequeue_cons (f);
730 if (max_deq <= sizeof (session_dgram_hdr_t))
733 svm_fifo_unset_event (f);
738 svm_fifo_unset_event (f);
740 svm_fifo_peek (f, 0, sizeof (ph), (u8 *) & ph);
741 ASSERT (ph.data_length >= ph.data_offset);
743 /* Check if we have the full dgram */
744 if (max_deq < (ph.data_length + SESSION_CONN_HDR_LEN)
745 && len >= ph.data_length)
748 svm_fifo_peek (f, sizeof (ph), sizeof (*at), (u8 *) at);
749 len = clib_min (len, ph.data_length - ph.data_offset);
750 rv = svm_fifo_peek (f, ph.data_offset + SESSION_CONN_HDR_LEN, len, buf);
754 /* Discards data that did not fit in buffer */
755 svm_fifo_dequeue_drop (f, ph.data_length + SESSION_CONN_HDR_LEN);
761 app_recv_dgram (app_session_t * s, u8 * buf, u32 len)
763 return app_recv_dgram_raw (s->rx_fifo, buf, len, &s->transport, 1, 0);
767 app_recv_stream_raw (svm_fifo_t * f, u8 * buf, u32 len, u8 clear_evt, u8 peek)
770 svm_fifo_unset_event (f);
773 return svm_fifo_peek (f, 0, len, buf);
775 return svm_fifo_dequeue (f, len, buf);
779 app_recv_stream (app_session_t * s, u8 * buf, u32 len)
781 return app_recv_stream_raw (s->rx_fifo, buf, len, 1, 0);
785 app_recv (app_session_t * s, u8 * data, u32 len)
788 return app_recv_dgram (s, data, len);
789 return app_recv_stream (s, data, len);
793 static char *session_error_str[] = {
794 #define _(sym, str) str,
795 foreach_session_error
801 format_session_error (u8 * s, va_list * args)
803 session_error_t error = va_arg (*args, session_error_t);
804 if (-error >= 0 && -error < SESSION_N_ERRORS)
805 s = format (s, "%s", session_error_str[-error]);
807 s = format (s, "invalid session err %u", -error);
812 * Socket API messages
815 typedef enum app_sapi_msg_type
817 APP_SAPI_MSG_TYPE_NONE,
818 APP_SAPI_MSG_TYPE_ATTACH,
819 APP_SAPI_MSG_TYPE_ATTACH_REPLY,
820 APP_SAPI_MSG_TYPE_ADD_DEL_WORKER,
821 APP_SAPI_MSG_TYPE_ADD_DEL_WORKER_REPLY,
822 APP_SAPI_MSG_TYPE_SEND_FDS,
823 APP_SAPI_MSG_TYPE_ADD_DEL_CERT_KEY,
824 APP_SAPI_MSG_TYPE_ADD_DEL_CERT_KEY_REPLY,
825 } __clib_packed app_sapi_msg_type_e;
827 typedef struct app_sapi_attach_msg_
831 } __clib_packed app_sapi_attach_msg_t;
833 STATIC_ASSERT (sizeof (u64) * APP_OPTIONS_N_OPTIONS <=
834 sizeof (((app_sapi_attach_msg_t *) 0)->options),
835 "Out of options, fix message definition");
837 typedef struct app_sapi_attach_reply_msg_
844 u32 api_client_handle;
845 u8 vpp_ctrl_mq_thread;
848 } __clib_packed app_sapi_attach_reply_msg_t;
850 typedef struct app_sapi_worker_add_del_msg_
855 } __clib_packed app_sapi_worker_add_del_msg_t;
857 typedef struct app_sapi_worker_add_del_reply_msg_
861 u64 app_event_queue_address;
863 u32 api_client_handle;
867 } __clib_packed app_sapi_worker_add_del_reply_msg_t;
869 typedef struct app_sapi_cert_key_add_del_msg_
876 } __clib_packed app_sapi_cert_key_add_del_msg_t;
878 typedef struct app_sapi_cert_key_add_del_reply_msg_
883 } __clib_packed app_sapi_cert_key_add_del_reply_msg_t;
885 typedef struct app_sapi_msg_
887 app_sapi_msg_type_e type;
890 app_sapi_attach_msg_t attach;
891 app_sapi_attach_reply_msg_t attach_reply;
892 app_sapi_worker_add_del_msg_t worker_add_del;
893 app_sapi_worker_add_del_reply_msg_t worker_add_del_reply;
894 app_sapi_cert_key_add_del_msg_t cert_key_add_del;
895 app_sapi_cert_key_add_del_reply_msg_t cert_key_add_del_reply;
897 } __clib_packed app_sapi_msg_t;
900 session_endpoint_alloc_ext_cfg (session_endpoint_cfg_t *sep_ext,
901 transport_endpt_ext_cfg_type_t type)
903 transport_endpt_ext_cfg_t *cfg;
906 cfg_size = sizeof (transport_endpt_ext_cfg_t);
907 cfg = clib_mem_alloc (cfg_size);
908 clib_memset (cfg, 0, cfg_size);
910 sep_ext->ext_cfg = cfg;
913 #endif /* __included_uri_h__ */
916 * fd.io coding-style-patch-verification: ON
919 * eval: (c-set-style "gnu")