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 u32 segment_name_length;
119 u64 server_event_queue_address;
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 session_handle_t session_handle;
147 } vnet_connect_args_t;
149 typedef struct _vnet_disconnect_args_t
151 session_handle_t handle;
153 } vnet_disconnect_args_t;
155 typedef struct _vnet_application_add_tls_cert_args_t
159 } vnet_app_add_tls_cert_args_t;
161 typedef struct _vnet_application_add_tls_key_args_t
165 } vnet_app_add_tls_key_args_t;
167 typedef enum crypto_engine_type_
170 CRYPTO_ENGINE_OPENSSL,
171 CRYPTO_ENGINE_MBEDTLS,
173 CRYPTO_ENGINE_PICOTLS,
174 CRYPTO_ENGINE_LAST = CRYPTO_ENGINE_PICOTLS,
175 } crypto_engine_type_t;
177 typedef struct _vnet_app_add_cert_key_pair_args_
182 } vnet_app_add_cert_key_pair_args_t;
184 typedef struct crypto_ctx_
186 u32 ctx_index; /**< index in crypto context pool */
187 u32 n_subscribers; /**< refcount of sessions using said context */
188 u32 ckpair_index; /**< certificate & key */
190 void *data; /**< protocol specific data */
193 /* Application attach options */
197 APP_OPTIONS_EVT_QUEUE_SIZE,
198 APP_OPTIONS_SEGMENT_SIZE,
199 APP_OPTIONS_ADD_SEGMENT_SIZE,
200 APP_OPTIONS_PRIVATE_SEGMENT_COUNT,
201 APP_OPTIONS_RX_FIFO_SIZE,
202 APP_OPTIONS_TX_FIFO_SIZE,
203 APP_OPTIONS_PREALLOC_FIFO_PAIRS,
204 APP_OPTIONS_PREALLOC_FIFO_HDRS,
205 APP_OPTIONS_NAMESPACE,
206 APP_OPTIONS_NAMESPACE_SECRET,
207 APP_OPTIONS_PROXY_TRANSPORT,
208 APP_OPTIONS_ACCEPT_COOKIE,
209 APP_OPTIONS_TLS_ENGINE,
210 APP_OPTIONS_MAX_FIFO_SIZE,
211 APP_OPTIONS_HIGH_WATERMARK,
212 APP_OPTIONS_LOW_WATERMARK,
213 APP_OPTIONS_PCT_FIRST_ALLOC,
214 APP_OPTIONS_N_OPTIONS
215 } app_attach_options_index_t;
217 #define foreach_app_options_flags \
218 _(ACCEPT_REDIRECT, "Use FIFO with redirects") \
219 _(ADD_SEGMENT, "Add segment and signal app if needed") \
220 _(IS_BUILTIN, "Application is builtin") \
221 _(IS_TRANSPORT_APP, "Application is a transport proto") \
222 _(IS_PROXY, "Application is proxying") \
223 _(USE_GLOBAL_SCOPE, "App can use global session scope") \
224 _(USE_LOCAL_SCOPE, "App can use local session scope") \
225 _(EVT_MQ_USE_EVENTFD, "Use eventfds for signaling") \
227 typedef enum _app_options
229 #define _(sym, str) APP_OPTIONS_##sym,
230 foreach_app_options_flags
234 typedef enum _app_options_flags
236 #define _(sym, str) APP_OPTIONS_FLAGS_##sym = 1 << APP_OPTIONS_##sym,
237 foreach_app_options_flags
239 } app_options_flags_t;
241 #define foreach_fd_type \
242 _(VPP_MQ_SEGMENT, "Fd for vpp's event mq segment") \
243 _(MEMFD_SEGMENT, "Fd for memfd segment") \
244 _(MQ_EVENTFD, "Event fd used by message queue") \
245 _(VPP_MQ_EVENTFD, "Event fd used by vpp's message queue") \
247 typedef enum session_fd_type_
249 #define _(sym, str) SESSION_FD_##sym,
255 typedef enum session_fd_flag_
257 #define _(sym, str) SESSION_FD_F_##sym = 1 << SESSION_FD_##sym,
262 int parse_uri (char *uri, session_endpoint_cfg_t * sep);
263 int vnet_bind_uri (vnet_listen_args_t *);
264 int vnet_unbind_uri (vnet_unlisten_args_t * a);
265 int vnet_connect_uri (vnet_connect_args_t * a);
267 int vnet_application_attach (vnet_app_attach_args_t * a);
268 int vnet_application_detach (vnet_app_detach_args_t * a);
269 int vnet_listen (vnet_listen_args_t * a);
270 int vnet_connect (vnet_connect_args_t * a);
271 int vnet_unlisten (vnet_unlisten_args_t * a);
272 int vnet_disconnect_session (vnet_disconnect_args_t * a);
274 clib_error_t *vnet_app_add_tls_cert (vnet_app_add_tls_cert_args_t * a);
275 clib_error_t *vnet_app_add_tls_key (vnet_app_add_tls_key_args_t * a);
276 int vnet_app_add_cert_key_pair (vnet_app_add_cert_key_pair_args_t * a);
277 int vnet_app_del_cert_key_pair (u32 index);
278 /** Ask for app cb on pair deletion */
279 int vnet_app_add_cert_key_interest (u32 index, u32 app_index);
281 typedef struct app_session_transport_
283 ip46_address_t rmt_ip; /**< remote ip */
284 ip46_address_t lcl_ip; /**< local ip */
285 u16 rmt_port; /**< remote port (network order) */
286 u16 lcl_port; /**< local port (network order) */
287 u8 is_ip4; /**< set if uses ip4 networking */
288 } app_session_transport_t;
290 #define foreach_app_session_field \
291 _(svm_fifo_t, *rx_fifo) /**< rx fifo */ \
292 _(svm_fifo_t, *tx_fifo) /**< tx fifo */ \
293 _(session_type_t, session_type) /**< session type */ \
294 _(volatile u8, session_state) /**< session state */ \
295 _(u32, session_index) /**< index in owning pool */ \
296 _(app_session_transport_t, transport) /**< transport info */ \
297 _(svm_msg_q_t, *vpp_evt_q) /**< vpp event queue */ \
298 _(u8, is_dgram) /**< flag for dgram mode */ \
302 #define _(type, name) type name;
303 foreach_app_session_field
307 typedef struct session_listen_msg_
310 u32 context; /* Not needed but keeping it for compatibility with bapi */
320 } __clib_packed session_listen_msg_t;
322 STATIC_ASSERT (sizeof (session_listen_msg_t) <= SESSION_CTRL_MSG_MAX_SIZE,
325 typedef struct session_listen_uri_msg_
330 } __clib_packed session_listen_uri_msg_t;
332 STATIC_ASSERT (sizeof (session_listen_uri_msg_t) <= SESSION_CTRL_MSG_MAX_SIZE,
335 typedef struct session_bound_msg_
347 } __clib_packed session_bound_msg_t;
349 typedef struct session_unlisten_msg_
354 session_handle_t handle;
355 } __clib_packed session_unlisten_msg_t;
357 typedef struct session_unlisten_reply_msg_
362 } __clib_packed session_unlisten_reply_msg_t;
364 typedef struct session_accepted_msg_
369 uword server_rx_fifo;
370 uword server_tx_fifo;
372 uword vpp_event_queue_address;
373 transport_endpoint_t rmt;
375 } __clib_packed session_accepted_msg_t;
377 typedef struct session_accepted_reply_msg_
382 } __clib_packed session_accepted_reply_msg_t;
384 typedef struct session_connect_msg_
395 ip46_address_t lcl_ip;
402 } __clib_packed session_connect_msg_t;
404 STATIC_ASSERT (sizeof (session_connect_msg_t) <= SESSION_CTRL_MSG_MAX_SIZE,
407 typedef struct session_connect_uri_msg_
412 } __clib_packed session_connect_uri_msg_t;
414 STATIC_ASSERT (sizeof (session_connect_uri_msg_t) <=
415 SESSION_CTRL_MSG_MAX_SIZE, "msg too large");
417 typedef struct session_connected_msg_
422 uword server_rx_fifo;
423 uword server_tx_fifo;
427 u64 ct_segment_handle;
428 uword vpp_event_queue_address;
430 u8 segment_name_length;
432 transport_endpoint_t lcl;
433 } __clib_packed session_connected_msg_t;
435 typedef struct session_disconnect_msg_
439 session_handle_t handle;
440 } __clib_packed session_disconnect_msg_t;
442 typedef struct session_disconnected_msg_
447 } __clib_packed session_disconnected_msg_t;
449 typedef struct session_disconnected_reply_msg_
454 } __clib_packed session_disconnected_reply_msg_t;
456 typedef struct session_reset_msg_
461 } __clib_packed session_reset_msg_t;
463 typedef struct session_reset_reply_msg_
468 } __clib_packed session_reset_reply_msg_t;
470 typedef struct session_req_worker_update_msg_
473 } __clib_packed session_req_worker_update_msg_t;
475 /* NOTE: using u16 for wrk indices because message needs to fit in 18B */
476 typedef struct session_worker_update_msg_
482 } __clib_packed session_worker_update_msg_t;
484 typedef struct session_worker_update_reply_msg_
490 } __clib_packed session_worker_update_reply_msg_t;
492 typedef struct session_app_detach_msg_
496 } session_app_detach_msg_t;
498 typedef struct app_map_another_segment_msg_
504 u8 segment_name[128];
506 } session_app_add_segment_msg_t;
508 typedef struct app_unmap_segment_msg_
513 } session_app_del_segment_msg_t;
515 typedef struct session_migrate_msg_
518 session_handle_t handle;
519 session_handle_t new_handle;
521 u32 vpp_thread_index;
522 } __clib_packed session_migrated_msg_t;
524 typedef struct session_cleanup_msg_
526 session_handle_t handle;
528 } __clib_packed session_cleanup_msg_t;
530 typedef struct session_app_wrk_rpc_msg_
532 u32 client_index; /**< app client index */
533 u32 wrk_index; /**< dst worker index */
534 u8 data[64]; /**< rpc data */
535 } __clib_packed session_app_wrk_rpc_msg_t;
537 typedef struct app_session_event_
540 session_event_t *evt;
541 } __clib_packed app_session_evt_t;
544 app_alloc_ctrl_evt_to_vpp (svm_msg_q_t * mq, app_session_evt_t * app_evt,
547 svm_msg_q_lock_and_alloc_msg_w_ring (mq,
548 SESSION_MQ_CTRL_EVT_RING,
549 SVM_Q_WAIT, &app_evt->msg);
550 app_evt->evt = svm_msg_q_msg_data (mq, &app_evt->msg);
551 clib_memset (app_evt->evt, 0, sizeof (*app_evt->evt));
552 app_evt->evt->event_type = evt_type;
556 app_send_ctrl_evt_to_vpp (svm_msg_q_t * mq, app_session_evt_t * app_evt)
558 svm_msg_q_add_and_unlock (mq, &app_evt->msg);
562 * Send fifo io event to vpp worker thread
564 * Because there may be multiple writers to one of vpp's queues, this
565 * protects message allocation and enqueueing.
567 * @param mq vpp message queue
568 * @param f fifo for which the event is sent
569 * @param evt_type type of event
570 * @param noblock flag to indicate is request is blocking or not
571 * @return 0 if success, negative integer otherwise
574 app_send_io_evt_to_vpp (svm_msg_q_t * mq, u32 session_index, u8 evt_type,
577 session_event_t *evt;
582 if (svm_msg_q_try_lock (mq))
584 if (PREDICT_FALSE (svm_msg_q_ring_is_full (mq, SESSION_MQ_IO_EVT_RING)
585 || svm_msg_q_is_full (mq)))
587 svm_msg_q_unlock (mq);
590 msg = svm_msg_q_alloc_msg_w_ring (mq, SESSION_MQ_IO_EVT_RING);
591 evt = (session_event_t *) svm_msg_q_msg_data (mq, &msg);
592 evt->session_index = session_index;
593 evt->event_type = evt_type;
594 svm_msg_q_add_and_unlock (mq, &msg);
600 while (svm_msg_q_ring_is_full (mq, SESSION_MQ_IO_EVT_RING)
601 || svm_msg_q_is_full (mq))
603 msg = svm_msg_q_alloc_msg_w_ring (mq, SESSION_MQ_IO_EVT_RING);
604 evt = (session_event_t *) svm_msg_q_msg_data (mq, &msg);
605 evt->session_index = session_index;
606 evt->event_type = evt_type;
607 svm_msg_q_add_and_unlock (mq, &msg);
613 app_send_dgram_raw (svm_fifo_t * f, app_session_transport_t * at,
614 svm_msg_q_t * vpp_evt_q, u8 * data, u32 len, u8 evt_type,
615 u8 do_evt, u8 noblock)
617 session_dgram_hdr_t hdr;
620 if (svm_fifo_max_enqueue_prod (f) < (sizeof (session_dgram_hdr_t) + len))
623 hdr.data_length = len;
625 clib_memcpy_fast (&hdr.rmt_ip, &at->rmt_ip, sizeof (ip46_address_t));
626 hdr.is_ip4 = at->is_ip4;
627 hdr.rmt_port = at->rmt_port;
628 clib_memcpy_fast (&hdr.lcl_ip, &at->lcl_ip, sizeof (ip46_address_t));
629 hdr.lcl_port = at->lcl_port;
632 svm_fifo_seg_t segs[2] = {{ (u8 *) &hdr, sizeof (hdr) }, { data, len }};
635 rv = svm_fifo_enqueue_segments (f, segs, 2, 0 /* allow partial */ );
636 if (PREDICT_FALSE (rv < 0))
641 if (svm_fifo_set_event (f))
642 app_send_io_evt_to_vpp (vpp_evt_q, f->shr->master_session_index,
649 app_send_dgram (app_session_t * s, u8 * data, u32 len, u8 noblock)
651 return app_send_dgram_raw (s->tx_fifo, &s->transport, s->vpp_evt_q, data,
652 len, SESSION_IO_EVT_TX, 1 /* do_evt */ ,
657 app_send_stream_raw (svm_fifo_t * f, svm_msg_q_t * vpp_evt_q, u8 * data,
658 u32 len, u8 evt_type, u8 do_evt, u8 noblock)
662 rv = svm_fifo_enqueue (f, len, data);
665 if (rv > 0 && svm_fifo_set_event (f))
666 app_send_io_evt_to_vpp (vpp_evt_q, f->shr->master_session_index,
673 app_send_stream (app_session_t * s, u8 * data, u32 len, u8 noblock)
675 return app_send_stream_raw (s->tx_fifo, s->vpp_evt_q, data, len,
676 SESSION_IO_EVT_TX, 1 /* do_evt */ , noblock);
680 app_send (app_session_t * s, u8 * data, u32 len, u8 noblock)
683 return app_send_dgram (s, data, len, noblock);
684 return app_send_stream (s, data, len, noblock);
688 app_recv_dgram_raw (svm_fifo_t * f, u8 * buf, u32 len,
689 app_session_transport_t * at, u8 clear_evt, u8 peek)
691 session_dgram_pre_hdr_t ph;
695 max_deq = svm_fifo_max_dequeue_cons (f);
696 if (max_deq <= sizeof (session_dgram_hdr_t))
699 svm_fifo_unset_event (f);
704 svm_fifo_unset_event (f);
706 svm_fifo_peek (f, 0, sizeof (ph), (u8 *) & ph);
707 ASSERT (ph.data_length >= ph.data_offset);
709 /* Check if we have the full dgram */
710 if (max_deq < (ph.data_length + SESSION_CONN_HDR_LEN)
711 && len >= ph.data_length)
714 svm_fifo_peek (f, sizeof (ph), sizeof (*at), (u8 *) at);
715 len = clib_min (len, ph.data_length - ph.data_offset);
716 rv = svm_fifo_peek (f, ph.data_offset + SESSION_CONN_HDR_LEN, len, buf);
720 /* Discards data that did not fit in buffer */
721 svm_fifo_dequeue_drop (f, ph.data_length + SESSION_CONN_HDR_LEN);
727 app_recv_dgram (app_session_t * s, u8 * buf, u32 len)
729 return app_recv_dgram_raw (s->rx_fifo, buf, len, &s->transport, 1, 0);
733 app_recv_stream_raw (svm_fifo_t * f, u8 * buf, u32 len, u8 clear_evt, u8 peek)
736 svm_fifo_unset_event (f);
739 return svm_fifo_peek (f, 0, len, buf);
741 return svm_fifo_dequeue (f, len, buf);
745 app_recv_stream (app_session_t * s, u8 * buf, u32 len)
747 return app_recv_stream_raw (s->rx_fifo, buf, len, 1, 0);
751 app_recv (app_session_t * s, u8 * data, u32 len)
754 return app_recv_dgram (s, data, len);
755 return app_recv_stream (s, data, len);
759 static char *session_error_str[] = {
760 #define _(sym, str) str,
761 foreach_session_error
767 format_session_error (u8 * s, va_list * args)
769 session_error_t error = va_arg (*args, session_error_t);
770 if (-error >= 0 && -error < SESSION_N_ERRORS)
771 s = format (s, "%s", session_error_str[-error]);
773 s = format (s, "invalid session err %u", -error);
778 * Socket API messages
781 typedef enum app_sapi_msg_type
783 APP_SAPI_MSG_TYPE_NONE,
784 APP_SAPI_MSG_TYPE_ATTACH,
785 APP_SAPI_MSG_TYPE_ATTACH_REPLY,
786 APP_SAPI_MSG_TYPE_ADD_DEL_WORKER,
787 APP_SAPI_MSG_TYPE_ADD_DEL_WORKER_REPLY,
788 APP_SAPI_MSG_TYPE_SEND_FDS,
789 } __clib_packed app_sapi_msg_type_e;
791 typedef struct app_sapi_attach_msg_
795 } __clib_packed app_sapi_attach_msg_t;
797 STATIC_ASSERT (sizeof (u64) * APP_OPTIONS_N_OPTIONS <=
798 sizeof (((app_sapi_attach_msg_t *) 0)->options),
799 "Out of options, fix message definition");
801 typedef struct app_sapi_attach_reply_msg_
808 u32 api_client_handle;
809 u8 vpp_ctrl_mq_thread;
812 } __clib_packed app_sapi_attach_reply_msg_t;
814 typedef struct app_sapi_worker_add_del_msg_
819 } __clib_packed app_sapi_worker_add_del_msg_t;
821 typedef struct app_sapi_worker_add_del_reply_msg_
825 u64 app_event_queue_address;
827 u32 api_client_handle;
831 } __clib_packed app_sapi_worker_add_del_reply_msg_t;
833 typedef struct app_sapi_msg_
835 app_sapi_msg_type_e type;
838 app_sapi_attach_msg_t attach;
839 app_sapi_attach_reply_msg_t attach_reply;
840 app_sapi_worker_add_del_msg_t worker_add_del;
841 app_sapi_worker_add_del_reply_msg_t worker_add_del_reply;
843 } __clib_packed app_sapi_msg_t;
845 #endif /* __included_uri_h__ */
848 * fd.io coding-style-patch-verification: ON
851 * eval: (c-set-style "gnu")