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) \
85 typedef struct _vnet_app_attach_args_t
87 #define _(_type, _name) _type _name;
90 ssvm_private_t * segment;
91 svm_msg_q_t *app_evt_q;
93 } vnet_app_attach_args_t;
95 typedef struct _vnet_app_detach_args_t
99 } vnet_app_detach_args_t;
101 typedef struct _vnet_bind_args_t
105 session_endpoint_cfg_t sep_ext;
106 session_endpoint_t sep;
117 u32 segment_name_length;
118 u64 server_event_queue_address;
120 } vnet_listen_args_t;
122 typedef struct _vnet_unlisten_args_t
127 u64 handle; /**< Session handle */
129 u32 app_index; /**< Owning application index */
130 u32 wrk_map_index; /**< App's local pool worker index */
131 } vnet_unlisten_args_t;
133 typedef struct _vnet_connect_args
137 session_endpoint_cfg_t sep_ext;
138 session_endpoint_t sep;
145 session_handle_t session_handle;
146 } vnet_connect_args_t;
148 typedef struct _vnet_disconnect_args_t
150 session_handle_t handle;
152 } vnet_disconnect_args_t;
154 typedef struct _vnet_application_add_tls_cert_args_t
158 } vnet_app_add_tls_cert_args_t;
160 typedef struct _vnet_application_add_tls_key_args_t
164 } vnet_app_add_tls_key_args_t;
166 typedef enum crypto_engine_type_
169 CRYPTO_ENGINE_OPENSSL,
170 CRYPTO_ENGINE_MBEDTLS,
172 CRYPTO_ENGINE_PICOTLS,
173 CRYPTO_ENGINE_LAST = CRYPTO_ENGINE_PICOTLS,
174 } crypto_engine_type_t;
176 typedef struct _vnet_app_add_cert_key_pair_args_
181 } vnet_app_add_cert_key_pair_args_t;
183 typedef struct crypto_ctx_
185 u32 ctx_index; /**< index in crypto context pool */
186 u32 n_subscribers; /**< refcount of sessions using said context */
187 u32 ckpair_index; /**< certificate & key */
189 void *data; /**< protocol specific data */
192 /* Application attach options */
196 APP_OPTIONS_EVT_QUEUE_SIZE,
197 APP_OPTIONS_SEGMENT_SIZE,
198 APP_OPTIONS_ADD_SEGMENT_SIZE,
199 APP_OPTIONS_PRIVATE_SEGMENT_COUNT,
200 APP_OPTIONS_RX_FIFO_SIZE,
201 APP_OPTIONS_TX_FIFO_SIZE,
202 APP_OPTIONS_PREALLOC_FIFO_PAIRS,
203 APP_OPTIONS_NAMESPACE,
204 APP_OPTIONS_NAMESPACE_SECRET,
205 APP_OPTIONS_PROXY_TRANSPORT,
206 APP_OPTIONS_ACCEPT_COOKIE,
207 APP_OPTIONS_TLS_ENGINE,
208 APP_OPTIONS_MAX_FIFO_SIZE,
209 APP_OPTIONS_HIGH_WATERMARK,
210 APP_OPTIONS_LOW_WATERMARK,
211 APP_OPTIONS_PCT_FIRST_ALLOC,
212 APP_OPTIONS_N_OPTIONS
213 } app_attach_options_index_t;
215 #define foreach_app_options_flags \
216 _(ACCEPT_REDIRECT, "Use FIFO with redirects") \
217 _(ADD_SEGMENT, "Add segment and signal app if needed") \
218 _(IS_BUILTIN, "Application is builtin") \
219 _(IS_TRANSPORT_APP, "Application is a transport proto") \
220 _(IS_PROXY, "Application is proxying") \
221 _(USE_GLOBAL_SCOPE, "App can use global session scope") \
222 _(USE_LOCAL_SCOPE, "App can use local session scope") \
223 _(EVT_MQ_USE_EVENTFD, "Use eventfds for signaling") \
225 typedef enum _app_options
227 #define _(sym, str) APP_OPTIONS_##sym,
228 foreach_app_options_flags
232 typedef enum _app_options_flags
234 #define _(sym, str) APP_OPTIONS_FLAGS_##sym = 1 << APP_OPTIONS_##sym,
235 foreach_app_options_flags
237 } app_options_flags_t;
239 #define foreach_fd_type \
240 _(VPP_MQ_SEGMENT, "Fd for vpp's event mq segment") \
241 _(MEMFD_SEGMENT, "Fd for memfd segment") \
242 _(MQ_EVENTFD, "Event fd used by message queue") \
243 _(VPP_MQ_EVENTFD, "Event fd used by vpp's message queue") \
245 typedef enum session_fd_type_
247 #define _(sym, str) SESSION_FD_##sym,
253 typedef enum session_fd_flag_
255 #define _(sym, str) SESSION_FD_F_##sym = 1 << SESSION_FD_##sym,
260 int parse_uri (char *uri, session_endpoint_cfg_t * sep);
261 int vnet_bind_uri (vnet_listen_args_t *);
262 int vnet_unbind_uri (vnet_unlisten_args_t * a);
263 int vnet_connect_uri (vnet_connect_args_t * a);
265 int vnet_application_attach (vnet_app_attach_args_t * a);
266 int vnet_application_detach (vnet_app_detach_args_t * a);
267 int vnet_listen (vnet_listen_args_t * a);
268 int vnet_connect (vnet_connect_args_t * a);
269 int vnet_unlisten (vnet_unlisten_args_t * a);
270 int vnet_disconnect_session (vnet_disconnect_args_t * a);
272 clib_error_t *vnet_app_add_tls_cert (vnet_app_add_tls_cert_args_t * a);
273 clib_error_t *vnet_app_add_tls_key (vnet_app_add_tls_key_args_t * a);
274 int vnet_app_add_cert_key_pair (vnet_app_add_cert_key_pair_args_t * a);
275 int vnet_app_del_cert_key_pair (u32 index);
276 /** Ask for app cb on pair deletion */
277 int vnet_app_add_cert_key_interest (u32 index, u32 app_index);
279 typedef struct app_session_transport_
281 ip46_address_t rmt_ip; /**< remote ip */
282 ip46_address_t lcl_ip; /**< local ip */
283 u16 rmt_port; /**< remote port (network order) */
284 u16 lcl_port; /**< local port (network order) */
285 u8 is_ip4; /**< set if uses ip4 networking */
286 } app_session_transport_t;
288 #define foreach_app_session_field \
289 _(svm_fifo_t, *rx_fifo) /**< rx fifo */ \
290 _(svm_fifo_t, *tx_fifo) /**< tx fifo */ \
291 _(session_type_t, session_type) /**< session type */ \
292 _(volatile u8, session_state) /**< session state */ \
293 _(u32, session_index) /**< index in owning pool */ \
294 _(app_session_transport_t, transport) /**< transport info */ \
295 _(svm_msg_q_t, *vpp_evt_q) /**< vpp event queue */ \
296 _(u8, is_dgram) /**< flag for dgram mode */ \
300 #define _(type, name) type name;
301 foreach_app_session_field
305 typedef struct session_listen_msg_
308 u32 context; /* Not needed but keeping it for compatibility with bapi */
317 } __clib_packed session_listen_msg_t;
319 STATIC_ASSERT (sizeof (session_listen_msg_t) <= SESSION_CTRL_MSG_MAX_SIZE,
322 typedef struct session_listen_uri_msg_
327 } __clib_packed session_listen_uri_msg_t;
329 STATIC_ASSERT (sizeof (session_listen_uri_msg_t) <= SESSION_CTRL_MSG_MAX_SIZE,
332 typedef struct session_bound_msg_
344 u8 segment_name_length;
345 u8 segment_name[128];
346 } __clib_packed session_bound_msg_t;
348 typedef struct session_unlisten_msg_
353 session_handle_t handle;
354 } __clib_packed session_unlisten_msg_t;
356 typedef struct session_unlisten_reply_msg_
361 } __clib_packed session_unlisten_reply_msg_t;
363 typedef struct session_accepted_msg_
368 uword server_rx_fifo;
369 uword server_tx_fifo;
371 uword vpp_event_queue_address;
372 transport_endpoint_t rmt;
374 } __clib_packed session_accepted_msg_t;
376 typedef struct session_accepted_reply_msg_
381 } __clib_packed session_accepted_reply_msg_t;
383 typedef struct session_connect_msg_
394 ip46_address_t lcl_ip;
401 } __clib_packed session_connect_msg_t;
403 STATIC_ASSERT (sizeof (session_connect_msg_t) <= SESSION_CTRL_MSG_MAX_SIZE,
406 typedef struct session_connect_uri_msg_
411 } __clib_packed session_connect_uri_msg_t;
413 STATIC_ASSERT (sizeof (session_connect_uri_msg_t) <=
414 SESSION_CTRL_MSG_MAX_SIZE, "msg too large");
416 typedef struct session_connected_msg_
421 uword server_rx_fifo;
422 uword server_tx_fifo;
426 u64 ct_segment_handle;
427 uword vpp_event_queue_address;
429 u8 segment_name_length;
431 transport_endpoint_t lcl;
432 } __clib_packed session_connected_msg_t;
434 typedef struct session_disconnect_msg_
438 session_handle_t handle;
439 } __clib_packed session_disconnect_msg_t;
441 typedef struct session_disconnected_msg_
446 } __clib_packed session_disconnected_msg_t;
448 typedef struct session_disconnected_reply_msg_
453 } __clib_packed session_disconnected_reply_msg_t;
455 typedef struct session_reset_msg_
460 } __clib_packed session_reset_msg_t;
462 typedef struct session_reset_reply_msg_
467 } __clib_packed session_reset_reply_msg_t;
469 typedef struct session_req_worker_update_msg_
472 } __clib_packed session_req_worker_update_msg_t;
474 /* NOTE: using u16 for wrk indices because message needs to fit in 18B */
475 typedef struct session_worker_update_msg_
481 } __clib_packed session_worker_update_msg_t;
483 typedef struct session_worker_update_reply_msg_
489 } __clib_packed session_worker_update_reply_msg_t;
491 typedef struct session_app_detach_msg_
495 } session_app_detach_msg_t;
497 typedef struct app_map_another_segment_msg_
503 u8 segment_name[128];
505 } session_app_add_segment_msg_t;
507 typedef struct app_unmap_segment_msg_
512 } session_app_del_segment_msg_t;
514 typedef struct session_migrate_msg_
517 session_handle_t handle;
518 session_handle_t new_handle;
519 u32 vpp_thread_index;
520 } __clib_packed session_migrated_msg_t;
522 typedef struct session_cleanup_msg_
524 session_handle_t handle;
525 } __clib_packed session_cleanup_msg_t;
527 typedef struct app_session_event_
530 session_event_t *evt;
531 } __clib_packed app_session_evt_t;
534 app_alloc_ctrl_evt_to_vpp (svm_msg_q_t * mq, app_session_evt_t * app_evt,
537 svm_msg_q_lock_and_alloc_msg_w_ring (mq,
538 SESSION_MQ_CTRL_EVT_RING,
539 SVM_Q_WAIT, &app_evt->msg);
540 app_evt->evt = svm_msg_q_msg_data (mq, &app_evt->msg);
541 clib_memset (app_evt->evt, 0, sizeof (*app_evt->evt));
542 app_evt->evt->event_type = evt_type;
546 app_send_ctrl_evt_to_vpp (svm_msg_q_t * mq, app_session_evt_t * app_evt)
548 svm_msg_q_add_and_unlock (mq, &app_evt->msg);
552 * Send fifo io event to vpp worker thread
554 * Because there may be multiple writers to one of vpp's queues, this
555 * protects message allocation and enqueueing.
557 * @param mq vpp message queue
558 * @param f fifo for which the event is sent
559 * @param evt_type type of event
560 * @param noblock flag to indicate is request is blocking or not
561 * @return 0 if success, negative integer otherwise
564 app_send_io_evt_to_vpp (svm_msg_q_t * mq, u32 session_index, u8 evt_type,
567 session_event_t *evt;
572 if (svm_msg_q_try_lock (mq))
574 if (PREDICT_FALSE (svm_msg_q_ring_is_full (mq, SESSION_MQ_IO_EVT_RING)))
576 svm_msg_q_unlock (mq);
579 msg = svm_msg_q_alloc_msg_w_ring (mq, SESSION_MQ_IO_EVT_RING);
580 evt = (session_event_t *) svm_msg_q_msg_data (mq, &msg);
581 evt->session_index = session_index;
582 evt->event_type = evt_type;
583 svm_msg_q_add_and_unlock (mq, &msg);
589 while (svm_msg_q_ring_is_full (mq, SESSION_MQ_IO_EVT_RING)
590 || svm_msg_q_is_full (mq))
592 msg = svm_msg_q_alloc_msg_w_ring (mq, SESSION_MQ_IO_EVT_RING);
593 evt = (session_event_t *) svm_msg_q_msg_data (mq, &msg);
594 evt->session_index = session_index;
595 evt->event_type = evt_type;
596 svm_msg_q_add_and_unlock (mq, &msg);
602 app_send_dgram_raw (svm_fifo_t * f, app_session_transport_t * at,
603 svm_msg_q_t * vpp_evt_q, u8 * data, u32 len, u8 evt_type,
604 u8 do_evt, u8 noblock)
606 u32 max_enqueue, actual_write;
607 session_dgram_hdr_t hdr;
610 max_enqueue = svm_fifo_max_enqueue_prod (f);
611 if (max_enqueue < (sizeof (session_dgram_hdr_t) + len))
614 max_enqueue -= sizeof (session_dgram_hdr_t);
615 actual_write = clib_min (len, max_enqueue);
616 hdr.data_length = actual_write;
618 clib_memcpy_fast (&hdr.rmt_ip, &at->rmt_ip, sizeof (ip46_address_t));
619 hdr.is_ip4 = at->is_ip4;
620 hdr.rmt_port = at->rmt_port;
621 clib_memcpy_fast (&hdr.lcl_ip, &at->lcl_ip, sizeof (ip46_address_t));
622 hdr.lcl_port = at->lcl_port;
623 rv = svm_fifo_enqueue (f, sizeof (hdr), (u8 *) & hdr);
624 ASSERT (rv == sizeof (hdr));
626 rv = svm_fifo_enqueue (f, actual_write, data);
629 if (rv > 0 && svm_fifo_set_event (f))
630 app_send_io_evt_to_vpp (vpp_evt_q, f->master_session_index, evt_type,
638 app_send_dgram (app_session_t * s, u8 * data, u32 len, u8 noblock)
640 return app_send_dgram_raw (s->tx_fifo, &s->transport, s->vpp_evt_q, data,
641 len, SESSION_IO_EVT_TX, 1 /* do_evt */ ,
646 app_send_stream_raw (svm_fifo_t * f, svm_msg_q_t * vpp_evt_q, u8 * data,
647 u32 len, u8 evt_type, u8 do_evt, u8 noblock)
651 rv = svm_fifo_enqueue (f, len, data);
654 if (rv > 0 && svm_fifo_set_event (f))
655 app_send_io_evt_to_vpp (vpp_evt_q, f->master_session_index, evt_type,
662 app_send_stream (app_session_t * s, u8 * data, u32 len, u8 noblock)
664 return app_send_stream_raw (s->tx_fifo, s->vpp_evt_q, data, len,
665 SESSION_IO_EVT_TX, 1 /* do_evt */ , noblock);
669 app_send (app_session_t * s, u8 * data, u32 len, u8 noblock)
672 return app_send_dgram (s, data, len, noblock);
673 return app_send_stream (s, data, len, noblock);
677 app_recv_dgram_raw (svm_fifo_t * f, u8 * buf, u32 len,
678 app_session_transport_t * at, u8 clear_evt, u8 peek)
680 session_dgram_pre_hdr_t ph;
684 max_deq = svm_fifo_max_dequeue_cons (f);
685 if (max_deq <= sizeof (session_dgram_hdr_t))
688 svm_fifo_unset_event (f);
693 svm_fifo_unset_event (f);
695 svm_fifo_peek (f, 0, sizeof (ph), (u8 *) & ph);
696 ASSERT (ph.data_length >= ph.data_offset);
698 /* Check if we have the full dgram */
699 if (max_deq < (ph.data_length + SESSION_CONN_HDR_LEN)
700 && len >= ph.data_length)
703 svm_fifo_peek (f, sizeof (ph), sizeof (*at), (u8 *) at);
704 len = clib_min (len, ph.data_length - ph.data_offset);
705 rv = svm_fifo_peek (f, ph.data_offset + SESSION_CONN_HDR_LEN, len, buf);
709 /* Discards data that did not fit in buffer */
710 svm_fifo_dequeue_drop (f, ph.data_length + SESSION_CONN_HDR_LEN);
716 app_recv_dgram (app_session_t * s, u8 * buf, u32 len)
718 return app_recv_dgram_raw (s->rx_fifo, buf, len, &s->transport, 1, 0);
722 app_recv_stream_raw (svm_fifo_t * f, u8 * buf, u32 len, u8 clear_evt, u8 peek)
725 svm_fifo_unset_event (f);
728 return svm_fifo_peek (f, 0, len, buf);
730 return svm_fifo_dequeue (f, len, buf);
734 app_recv_stream (app_session_t * s, u8 * buf, u32 len)
736 return app_recv_stream_raw (s->rx_fifo, buf, len, 1, 0);
740 app_recv (app_session_t * s, u8 * data, u32 len)
743 return app_recv_dgram (s, data, len);
744 return app_recv_stream (s, data, len);
748 static char *session_error_str[] = {
749 #define _(sym, str) str,
750 foreach_session_error
756 format_session_error (u8 * s, va_list * args)
758 session_error_t error = va_arg (*args, session_error_t);
759 if (-error >= 0 && -error < SESSION_N_ERRORS)
760 s = format (s, "%s", session_error_str[-error]);
762 s = format (s, "invalid session err %u", -error);
765 #endif /* __included_uri_h__ */
768 * fd.io coding-style-patch-verification: ON
771 * eval: (c-set-style "gnu")