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_
184 } vnet_app_add_cert_key_pair_args_t;
186 typedef struct crypto_ctx_
188 u32 ctx_index; /**< index in crypto context pool */
189 u32 n_subscribers; /**< refcount of sessions using said context */
190 u32 ckpair_index; /**< certificate & key */
192 void *data; /**< protocol specific data */
195 /* Application attach options */
199 APP_OPTIONS_EVT_QUEUE_SIZE,
200 APP_OPTIONS_SEGMENT_SIZE,
201 APP_OPTIONS_ADD_SEGMENT_SIZE,
202 APP_OPTIONS_PRIVATE_SEGMENT_COUNT,
203 APP_OPTIONS_RX_FIFO_SIZE,
204 APP_OPTIONS_TX_FIFO_SIZE,
205 APP_OPTIONS_PREALLOC_FIFO_PAIRS,
206 APP_OPTIONS_PREALLOC_FIFO_HDRS,
207 APP_OPTIONS_NAMESPACE,
208 APP_OPTIONS_NAMESPACE_SECRET,
209 APP_OPTIONS_PROXY_TRANSPORT,
210 APP_OPTIONS_ACCEPT_COOKIE,
211 APP_OPTIONS_TLS_ENGINE,
212 APP_OPTIONS_MAX_FIFO_SIZE,
213 APP_OPTIONS_HIGH_WATERMARK,
214 APP_OPTIONS_LOW_WATERMARK,
215 APP_OPTIONS_PCT_FIRST_ALLOC,
216 APP_OPTIONS_N_OPTIONS
217 } app_attach_options_index_t;
219 #define foreach_app_options_flags \
220 _(ACCEPT_REDIRECT, "Use FIFO with redirects") \
221 _(ADD_SEGMENT, "Add segment and signal app if needed") \
222 _(IS_BUILTIN, "Application is builtin") \
223 _(IS_TRANSPORT_APP, "Application is a transport proto") \
224 _(IS_PROXY, "Application is proxying") \
225 _(USE_GLOBAL_SCOPE, "App can use global session scope") \
226 _(USE_LOCAL_SCOPE, "App can use local session scope") \
227 _(EVT_MQ_USE_EVENTFD, "Use eventfds for signaling") \
229 typedef enum _app_options
231 #define _(sym, str) APP_OPTIONS_##sym,
232 foreach_app_options_flags
236 typedef enum _app_options_flags
238 #define _(sym, str) APP_OPTIONS_FLAGS_##sym = 1 << APP_OPTIONS_##sym,
239 foreach_app_options_flags
241 } app_options_flags_t;
243 #define foreach_fd_type \
244 _(VPP_MQ_SEGMENT, "Fd for vpp's event mq segment") \
245 _(MEMFD_SEGMENT, "Fd for memfd segment") \
246 _(MQ_EVENTFD, "Event fd used by message queue") \
247 _(VPP_MQ_EVENTFD, "Event fd used by vpp's message queue") \
249 typedef enum session_fd_type_
251 #define _(sym, str) SESSION_FD_##sym,
257 typedef enum session_fd_flag_
259 #define _(sym, str) SESSION_FD_F_##sym = 1 << SESSION_FD_##sym,
264 int parse_uri (char *uri, session_endpoint_cfg_t * sep);
265 int vnet_bind_uri (vnet_listen_args_t *);
266 int vnet_unbind_uri (vnet_unlisten_args_t * a);
267 int vnet_connect_uri (vnet_connect_args_t * a);
269 int vnet_application_attach (vnet_app_attach_args_t * a);
270 int vnet_application_detach (vnet_app_detach_args_t * a);
271 int vnet_listen (vnet_listen_args_t * a);
272 int vnet_connect (vnet_connect_args_t * a);
273 int vnet_unlisten (vnet_unlisten_args_t * a);
274 int vnet_disconnect_session (vnet_disconnect_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;
374 transport_endpoint_t rmt;
376 } __clib_packed session_accepted_msg_t;
378 typedef struct session_accepted_reply_msg_
383 } __clib_packed session_accepted_reply_msg_t;
385 typedef struct session_connect_msg_
396 ip46_address_t lcl_ip;
403 } __clib_packed session_connect_msg_t;
405 STATIC_ASSERT (sizeof (session_connect_msg_t) <= SESSION_CTRL_MSG_MAX_SIZE,
408 typedef struct session_connect_uri_msg_
413 } __clib_packed session_connect_uri_msg_t;
415 STATIC_ASSERT (sizeof (session_connect_uri_msg_t) <=
416 SESSION_CTRL_MSG_MAX_SIZE, "msg too large");
418 typedef struct session_connected_msg_
423 uword server_rx_fifo;
424 uword server_tx_fifo;
428 u64 ct_segment_handle;
429 uword vpp_event_queue_address;
431 u8 segment_name_length;
433 transport_endpoint_t lcl;
434 } __clib_packed session_connected_msg_t;
436 typedef struct session_disconnect_msg_
440 session_handle_t handle;
441 } __clib_packed session_disconnect_msg_t;
443 typedef struct session_disconnected_msg_
448 } __clib_packed session_disconnected_msg_t;
450 typedef struct session_disconnected_reply_msg_
455 } __clib_packed session_disconnected_reply_msg_t;
457 typedef struct session_reset_msg_
462 } __clib_packed session_reset_msg_t;
464 typedef struct session_reset_reply_msg_
469 } __clib_packed session_reset_reply_msg_t;
471 typedef struct session_req_worker_update_msg_
474 } __clib_packed session_req_worker_update_msg_t;
476 /* NOTE: using u16 for wrk indices because message needs to fit in 18B */
477 typedef struct session_worker_update_msg_
483 } __clib_packed session_worker_update_msg_t;
485 typedef struct session_worker_update_reply_msg_
491 } __clib_packed session_worker_update_reply_msg_t;
493 typedef struct session_app_detach_msg_
497 } session_app_detach_msg_t;
499 typedef struct app_map_another_segment_msg_
505 u8 segment_name[128];
507 } session_app_add_segment_msg_t;
509 typedef struct app_unmap_segment_msg_
514 } session_app_del_segment_msg_t;
516 typedef struct session_migrate_msg_
519 session_handle_t handle;
520 session_handle_t new_handle;
522 u32 vpp_thread_index;
523 } __clib_packed session_migrated_msg_t;
525 typedef struct session_cleanup_msg_
527 session_handle_t handle;
529 } __clib_packed session_cleanup_msg_t;
531 typedef struct session_app_wrk_rpc_msg_
533 u32 client_index; /**< app client index */
534 u32 wrk_index; /**< dst worker index */
535 u8 data[64]; /**< rpc data */
536 } __clib_packed session_app_wrk_rpc_msg_t;
538 typedef struct app_session_event_
541 session_event_t *evt;
542 } __clib_packed app_session_evt_t;
545 app_alloc_ctrl_evt_to_vpp (svm_msg_q_t * mq, app_session_evt_t * app_evt,
548 svm_msg_q_lock_and_alloc_msg_w_ring (mq,
549 SESSION_MQ_CTRL_EVT_RING,
550 SVM_Q_WAIT, &app_evt->msg);
551 app_evt->evt = svm_msg_q_msg_data (mq, &app_evt->msg);
552 clib_memset (app_evt->evt, 0, sizeof (*app_evt->evt));
553 app_evt->evt->event_type = evt_type;
557 app_send_ctrl_evt_to_vpp (svm_msg_q_t * mq, app_session_evt_t * app_evt)
559 svm_msg_q_add_and_unlock (mq, &app_evt->msg);
563 * Send fifo io event to vpp worker thread
565 * Because there may be multiple writers to one of vpp's queues, this
566 * protects message allocation and enqueueing.
568 * @param mq vpp message queue
569 * @param f fifo for which the event is sent
570 * @param evt_type type of event
571 * @param noblock flag to indicate is request is blocking or not
572 * @return 0 if success, negative integer otherwise
575 app_send_io_evt_to_vpp (svm_msg_q_t * mq, u32 session_index, u8 evt_type,
578 session_event_t *evt;
583 if (svm_msg_q_try_lock (mq))
585 if (PREDICT_FALSE (svm_msg_q_ring_is_full (mq, SESSION_MQ_IO_EVT_RING)
586 || svm_msg_q_is_full (mq)))
588 svm_msg_q_unlock (mq);
591 msg = svm_msg_q_alloc_msg_w_ring (mq, SESSION_MQ_IO_EVT_RING);
592 evt = (session_event_t *) svm_msg_q_msg_data (mq, &msg);
593 evt->session_index = session_index;
594 evt->event_type = evt_type;
595 svm_msg_q_add_and_unlock (mq, &msg);
601 while (svm_msg_q_ring_is_full (mq, SESSION_MQ_IO_EVT_RING)
602 || svm_msg_q_is_full (mq))
603 svm_msg_q_wait (mq, SVM_MQ_WAIT_FULL);
604 msg = svm_msg_q_alloc_msg_w_ring (mq, SESSION_MQ_IO_EVT_RING);
605 evt = (session_event_t *) svm_msg_q_msg_data (mq, &msg);
606 evt->session_index = session_index;
607 evt->event_type = evt_type;
608 svm_msg_q_add_and_unlock (mq, &msg);
614 app_send_dgram_raw (svm_fifo_t * f, app_session_transport_t * at,
615 svm_msg_q_t * vpp_evt_q, u8 * data, u32 len, u8 evt_type,
616 u8 do_evt, u8 noblock)
618 session_dgram_hdr_t hdr;
621 if (svm_fifo_max_enqueue_prod (f) < (sizeof (session_dgram_hdr_t) + len))
624 hdr.data_length = len;
626 clib_memcpy_fast (&hdr.rmt_ip, &at->rmt_ip, sizeof (ip46_address_t));
627 hdr.is_ip4 = at->is_ip4;
628 hdr.rmt_port = at->rmt_port;
629 clib_memcpy_fast (&hdr.lcl_ip, &at->lcl_ip, sizeof (ip46_address_t));
630 hdr.lcl_port = at->lcl_port;
633 svm_fifo_seg_t segs[2] = {{ (u8 *) &hdr, sizeof (hdr) }, { data, len }};
636 rv = svm_fifo_enqueue_segments (f, segs, 2, 0 /* allow partial */ );
637 if (PREDICT_FALSE (rv < 0))
642 if (svm_fifo_set_event (f))
643 app_send_io_evt_to_vpp (vpp_evt_q, f->shr->master_session_index,
650 app_send_dgram (app_session_t * s, u8 * data, u32 len, u8 noblock)
652 return app_send_dgram_raw (s->tx_fifo, &s->transport, s->vpp_evt_q, data,
653 len, SESSION_IO_EVT_TX, 1 /* do_evt */ ,
658 app_send_stream_raw (svm_fifo_t * f, svm_msg_q_t * vpp_evt_q, u8 * data,
659 u32 len, u8 evt_type, u8 do_evt, u8 noblock)
663 rv = svm_fifo_enqueue (f, len, data);
666 if (rv > 0 && svm_fifo_set_event (f))
667 app_send_io_evt_to_vpp (vpp_evt_q, f->shr->master_session_index,
674 app_send_stream (app_session_t * s, u8 * data, u32 len, u8 noblock)
676 return app_send_stream_raw (s->tx_fifo, s->vpp_evt_q, data, len,
677 SESSION_IO_EVT_TX, 1 /* do_evt */ , noblock);
681 app_send (app_session_t * s, u8 * data, u32 len, u8 noblock)
684 return app_send_dgram (s, data, len, noblock);
685 return app_send_stream (s, data, len, noblock);
689 app_recv_dgram_raw (svm_fifo_t * f, u8 * buf, u32 len,
690 app_session_transport_t * at, u8 clear_evt, u8 peek)
692 session_dgram_pre_hdr_t ph;
696 max_deq = svm_fifo_max_dequeue_cons (f);
697 if (max_deq <= sizeof (session_dgram_hdr_t))
700 svm_fifo_unset_event (f);
705 svm_fifo_unset_event (f);
707 svm_fifo_peek (f, 0, sizeof (ph), (u8 *) & ph);
708 ASSERT (ph.data_length >= ph.data_offset);
710 /* Check if we have the full dgram */
711 if (max_deq < (ph.data_length + SESSION_CONN_HDR_LEN)
712 && len >= ph.data_length)
715 svm_fifo_peek (f, sizeof (ph), sizeof (*at), (u8 *) at);
716 len = clib_min (len, ph.data_length - ph.data_offset);
717 rv = svm_fifo_peek (f, ph.data_offset + SESSION_CONN_HDR_LEN, len, buf);
721 /* Discards data that did not fit in buffer */
722 svm_fifo_dequeue_drop (f, ph.data_length + SESSION_CONN_HDR_LEN);
728 app_recv_dgram (app_session_t * s, u8 * buf, u32 len)
730 return app_recv_dgram_raw (s->rx_fifo, buf, len, &s->transport, 1, 0);
734 app_recv_stream_raw (svm_fifo_t * f, u8 * buf, u32 len, u8 clear_evt, u8 peek)
737 svm_fifo_unset_event (f);
740 return svm_fifo_peek (f, 0, len, buf);
742 return svm_fifo_dequeue (f, len, buf);
746 app_recv_stream (app_session_t * s, u8 * buf, u32 len)
748 return app_recv_stream_raw (s->rx_fifo, buf, len, 1, 0);
752 app_recv (app_session_t * s, u8 * data, u32 len)
755 return app_recv_dgram (s, data, len);
756 return app_recv_stream (s, data, len);
760 static char *session_error_str[] = {
761 #define _(sym, str) str,
762 foreach_session_error
768 format_session_error (u8 * s, va_list * args)
770 session_error_t error = va_arg (*args, session_error_t);
771 if (-error >= 0 && -error < SESSION_N_ERRORS)
772 s = format (s, "%s", session_error_str[-error]);
774 s = format (s, "invalid session err %u", -error);
779 * Socket API messages
782 typedef enum app_sapi_msg_type
784 APP_SAPI_MSG_TYPE_NONE,
785 APP_SAPI_MSG_TYPE_ATTACH,
786 APP_SAPI_MSG_TYPE_ATTACH_REPLY,
787 APP_SAPI_MSG_TYPE_ADD_DEL_WORKER,
788 APP_SAPI_MSG_TYPE_ADD_DEL_WORKER_REPLY,
789 APP_SAPI_MSG_TYPE_SEND_FDS,
790 } __clib_packed app_sapi_msg_type_e;
792 typedef struct app_sapi_attach_msg_
796 } __clib_packed app_sapi_attach_msg_t;
798 STATIC_ASSERT (sizeof (u64) * APP_OPTIONS_N_OPTIONS <=
799 sizeof (((app_sapi_attach_msg_t *) 0)->options),
800 "Out of options, fix message definition");
802 typedef struct app_sapi_attach_reply_msg_
809 u32 api_client_handle;
810 u8 vpp_ctrl_mq_thread;
813 } __clib_packed app_sapi_attach_reply_msg_t;
815 typedef struct app_sapi_worker_add_del_msg_
820 } __clib_packed app_sapi_worker_add_del_msg_t;
822 typedef struct app_sapi_worker_add_del_reply_msg_
826 u64 app_event_queue_address;
828 u32 api_client_handle;
832 } __clib_packed app_sapi_worker_add_del_reply_msg_t;
834 typedef struct app_sapi_msg_
836 app_sapi_msg_type_e type;
839 app_sapi_attach_msg_t attach;
840 app_sapi_attach_reply_msg_t attach_reply;
841 app_sapi_worker_add_del_msg_t worker_add_del;
842 app_sapi_worker_add_del_reply_msg_t worker_add_del_reply;
844 } __clib_packed app_sapi_msg_t;
846 #endif /* __included_uri_h__ */
849 * fd.io coding-style-patch-verification: ON
852 * eval: (c-set-style "gnu")