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, u8 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);
73 #define foreach_app_init_args \
74 _(u32, api_client_index) \
77 _(u8 *, namespace_id) \
78 _(session_cb_vft_t *, session_cb_vft) \
81 typedef struct _vnet_app_attach_args_t
83 #define _(_type, _name) _type _name;
86 ssvm_private_t * segment;
87 svm_msg_q_t *app_evt_q;
89 } vnet_app_attach_args_t;
91 typedef struct _vnet_app_detach_args_t
95 } vnet_app_detach_args_t;
97 typedef struct _vnet_bind_args_t
101 session_endpoint_cfg_t sep_ext;
102 session_endpoint_t sep;
113 u32 segment_name_length;
114 u64 server_event_queue_address;
116 } vnet_listen_args_t;
118 typedef struct _vnet_unlisten_args_t
123 u64 handle; /**< Session handle */
125 u32 app_index; /**< Owning application index */
126 u32 wrk_map_index; /**< App's local pool worker index */
127 } vnet_unlisten_args_t;
129 typedef struct _vnet_connect_args
133 session_endpoint_cfg_t sep_ext;
134 session_endpoint_t sep;
141 session_handle_t session_handle;
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_
177 } vnet_app_add_cert_key_pair_args_t;
179 typedef struct crypto_ctx_
181 u32 ctx_index; /**< index in crypto context pool */
182 u32 n_subscribers; /**< refcount of sessions using said context */
183 u32 ckpair_index; /**< certificate & key */
185 void *data; /**< protocol specific data */
188 /* Application attach options */
192 APP_OPTIONS_EVT_QUEUE_SIZE,
193 APP_OPTIONS_SEGMENT_SIZE,
194 APP_OPTIONS_ADD_SEGMENT_SIZE,
195 APP_OPTIONS_PRIVATE_SEGMENT_COUNT,
196 APP_OPTIONS_RX_FIFO_SIZE,
197 APP_OPTIONS_TX_FIFO_SIZE,
198 APP_OPTIONS_PREALLOC_FIFO_PAIRS,
199 APP_OPTIONS_NAMESPACE,
200 APP_OPTIONS_NAMESPACE_SECRET,
201 APP_OPTIONS_PROXY_TRANSPORT,
202 APP_OPTIONS_ACCEPT_COOKIE,
203 APP_OPTIONS_TLS_ENGINE,
204 APP_OPTIONS_HIGH_WATERMARK,
205 APP_OPTIONS_LOW_WATERMARK,
206 APP_OPTIONS_N_OPTIONS
207 } app_attach_options_index_t;
209 #define foreach_app_options_flags \
210 _(ACCEPT_REDIRECT, "Use FIFO with redirects") \
211 _(ADD_SEGMENT, "Add segment and signal app if needed") \
212 _(IS_BUILTIN, "Application is builtin") \
213 _(IS_TRANSPORT_APP, "Application is a transport proto") \
214 _(IS_PROXY, "Application is proxying") \
215 _(USE_GLOBAL_SCOPE, "App can use global session scope") \
216 _(USE_LOCAL_SCOPE, "App can use local session scope") \
217 _(EVT_MQ_USE_EVENTFD, "Use eventfds for signaling") \
219 typedef enum _app_options
221 #define _(sym, str) APP_OPTIONS_##sym,
222 foreach_app_options_flags
226 typedef enum _app_options_flags
228 #define _(sym, str) APP_OPTIONS_FLAGS_##sym = 1 << APP_OPTIONS_##sym,
229 foreach_app_options_flags
231 } app_options_flags_t;
233 #define foreach_fd_type \
234 _(VPP_MQ_SEGMENT, "Fd for vpp's event mq segment") \
235 _(MEMFD_SEGMENT, "Fd for memfd segment") \
236 _(MQ_EVENTFD, "Event fd used by message queue") \
237 _(VPP_MQ_EVENTFD, "Event fd used by vpp's message queue") \
239 typedef enum session_fd_type_
241 #define _(sym, str) SESSION_FD_##sym,
247 typedef enum session_fd_flag_
249 #define _(sym, str) SESSION_FD_F_##sym = 1 << SESSION_FD_##sym,
254 int parse_uri (char *uri, session_endpoint_cfg_t * sep);
255 int vnet_bind_uri (vnet_listen_args_t *);
256 int vnet_unbind_uri (vnet_unlisten_args_t * a);
257 int vnet_connect_uri (vnet_connect_args_t * a);
259 int vnet_application_attach (vnet_app_attach_args_t * a);
260 int vnet_application_detach (vnet_app_detach_args_t * a);
261 int vnet_listen (vnet_listen_args_t * a);
262 int vnet_connect (vnet_connect_args_t * a);
263 int vnet_unlisten (vnet_unlisten_args_t * a);
264 int vnet_disconnect_session (vnet_disconnect_args_t * a);
266 clib_error_t *vnet_app_add_tls_cert (vnet_app_add_tls_cert_args_t * a);
267 clib_error_t *vnet_app_add_tls_key (vnet_app_add_tls_key_args_t * a);
268 int vnet_app_add_cert_key_pair (vnet_app_add_cert_key_pair_args_t * a);
269 int vnet_app_del_cert_key_pair (u32 index);
270 /** Ask for app cb on pair deletion */
271 int vnet_app_add_cert_key_interest (u32 index, u32 app_index);
273 typedef struct app_session_transport_
275 ip46_address_t rmt_ip; /**< remote ip */
276 ip46_address_t lcl_ip; /**< local ip */
277 u16 rmt_port; /**< remote port (network order) */
278 u16 lcl_port; /**< local port (network order) */
279 u8 is_ip4; /**< set if uses ip4 networking */
280 } app_session_transport_t;
282 #define foreach_app_session_field \
283 _(svm_fifo_t, *rx_fifo) /**< rx fifo */ \
284 _(svm_fifo_t, *tx_fifo) /**< tx fifo */ \
285 _(session_type_t, session_type) /**< session type */ \
286 _(volatile u8, session_state) /**< session state */ \
287 _(u32, session_index) /**< index in owning pool */ \
288 _(app_session_transport_t, transport) /**< transport info */ \
289 _(svm_msg_q_t, *vpp_evt_q) /**< vpp event queue */ \
290 _(u8, is_dgram) /**< flag for dgram mode */ \
294 #define _(type, name) type name;
295 foreach_app_session_field
299 typedef struct session_listen_msg_
302 u32 context; /* Not needed but keeping it for compatibility with bapi */
311 } __clib_packed session_listen_msg_t;
313 STATIC_ASSERT (sizeof (session_listen_msg_t) <= SESSION_CTRL_MSG_MAX_SIZE,
316 typedef struct session_listen_uri_msg_
321 } __clib_packed session_listen_uri_msg_t;
323 STATIC_ASSERT (sizeof (session_listen_uri_msg_t) <= SESSION_CTRL_MSG_MAX_SIZE,
326 typedef struct session_bound_msg_
338 u8 segment_name_length;
339 u8 segment_name[128];
340 } __clib_packed session_bound_msg_t;
342 typedef struct session_unlisten_msg_
347 session_handle_t handle;
348 } __clib_packed session_unlisten_msg_t;
350 typedef struct session_unlisten_reply_msg_
355 } __clib_packed session_unlisten_reply_msg_t;
357 typedef struct session_accepted_msg_
362 uword server_rx_fifo;
363 uword server_tx_fifo;
365 uword vpp_event_queue_address;
366 transport_endpoint_t rmt;
368 } __clib_packed session_accepted_msg_t;
370 typedef struct session_accepted_reply_msg_
375 } __clib_packed session_accepted_reply_msg_t;
377 typedef struct session_connect_msg_
387 ip46_address_t lcl_ip;
394 } __clib_packed session_connect_msg_t;
396 STATIC_ASSERT (sizeof (session_connect_msg_t) <= SESSION_CTRL_MSG_MAX_SIZE,
399 typedef struct session_connect_uri_msg_
404 } __clib_packed session_connect_uri_msg_t;
406 STATIC_ASSERT (sizeof (session_connect_uri_msg_t) <=
407 SESSION_CTRL_MSG_MAX_SIZE, "msg too large");
409 typedef struct session_connected_msg_
414 uword server_rx_fifo;
415 uword server_tx_fifo;
419 u64 ct_segment_handle;
420 uword vpp_event_queue_address;
422 u8 segment_name_length;
424 transport_endpoint_t lcl;
425 } __clib_packed session_connected_msg_t;
427 typedef struct session_disconnect_msg_
431 session_handle_t handle;
432 } __clib_packed session_disconnect_msg_t;
434 typedef struct session_disconnected_msg_
439 } __clib_packed session_disconnected_msg_t;
441 typedef struct session_disconnected_reply_msg_
446 } __clib_packed session_disconnected_reply_msg_t;
448 typedef struct session_reset_msg_
453 } __clib_packed session_reset_msg_t;
455 typedef struct session_reset_reply_msg_
460 } __clib_packed session_reset_reply_msg_t;
462 typedef struct session_req_worker_update_msg_
465 } __clib_packed session_req_worker_update_msg_t;
467 /* NOTE: using u16 for wrk indices because message needs to fit in 18B */
468 typedef struct session_worker_update_msg_
474 } __clib_packed session_worker_update_msg_t;
476 typedef struct session_worker_update_reply_msg_
482 } __clib_packed session_worker_update_reply_msg_t;
484 typedef struct session_app_detach_msg_
488 } session_app_detach_msg_t;
490 typedef struct app_map_another_segment_msg_
496 u8 segment_name[128];
498 } session_app_add_segment_msg_t;
500 typedef struct app_unmap_segment_msg_
505 } session_app_del_segment_msg_t;
507 typedef struct session_migrate_msg_
510 session_handle_t handle;
511 session_handle_t new_handle;
512 u32 vpp_thread_index;
513 } __clib_packed session_migrated_msg_t;
515 typedef struct session_cleanup_msg_
517 session_handle_t handle;
518 } __clib_packed session_cleanup_msg_t;
520 typedef struct app_session_event_
523 session_event_t *evt;
524 } __clib_packed app_session_evt_t;
527 app_alloc_ctrl_evt_to_vpp (svm_msg_q_t * mq, app_session_evt_t * app_evt,
530 svm_msg_q_lock_and_alloc_msg_w_ring (mq,
531 SESSION_MQ_CTRL_EVT_RING,
532 SVM_Q_WAIT, &app_evt->msg);
533 app_evt->evt = svm_msg_q_msg_data (mq, &app_evt->msg);
534 clib_memset (app_evt->evt, 0, sizeof (*app_evt->evt));
535 app_evt->evt->event_type = evt_type;
539 app_send_ctrl_evt_to_vpp (svm_msg_q_t * mq, app_session_evt_t * app_evt)
541 svm_msg_q_add_and_unlock (mq, &app_evt->msg);
545 * Send fifo io event to vpp worker thread
547 * Because there may be multiple writers to one of vpp's queues, this
548 * protects message allocation and enqueueing.
550 * @param mq vpp message queue
551 * @param f fifo for which the event is sent
552 * @param evt_type type of event
553 * @param noblock flag to indicate is request is blocking or not
554 * @return 0 if success, negative integer otherwise
557 app_send_io_evt_to_vpp (svm_msg_q_t * mq, u32 session_index, u8 evt_type,
560 session_event_t *evt;
565 if (svm_msg_q_try_lock (mq))
567 if (PREDICT_FALSE (svm_msg_q_ring_is_full (mq, SESSION_MQ_IO_EVT_RING)))
569 svm_msg_q_unlock (mq);
572 msg = svm_msg_q_alloc_msg_w_ring (mq, SESSION_MQ_IO_EVT_RING);
573 evt = (session_event_t *) svm_msg_q_msg_data (mq, &msg);
574 evt->session_index = session_index;
575 evt->event_type = evt_type;
576 svm_msg_q_add_and_unlock (mq, &msg);
582 while (svm_msg_q_ring_is_full (mq, SESSION_MQ_IO_EVT_RING)
583 || svm_msg_q_is_full (mq))
585 msg = svm_msg_q_alloc_msg_w_ring (mq, SESSION_MQ_IO_EVT_RING);
586 evt = (session_event_t *) svm_msg_q_msg_data (mq, &msg);
587 evt->session_index = session_index;
588 evt->event_type = evt_type;
589 svm_msg_q_add_and_unlock (mq, &msg);
595 app_send_dgram_raw (svm_fifo_t * f, app_session_transport_t * at,
596 svm_msg_q_t * vpp_evt_q, u8 * data, u32 len, u8 evt_type,
597 u8 do_evt, u8 noblock)
599 u32 max_enqueue, actual_write;
600 session_dgram_hdr_t hdr;
603 max_enqueue = svm_fifo_max_enqueue_prod (f);
604 if (max_enqueue <= sizeof (session_dgram_hdr_t))
607 max_enqueue -= sizeof (session_dgram_hdr_t);
608 actual_write = clib_min (len, max_enqueue);
609 hdr.data_length = actual_write;
611 clib_memcpy_fast (&hdr.rmt_ip, &at->rmt_ip, sizeof (ip46_address_t));
612 hdr.is_ip4 = at->is_ip4;
613 hdr.rmt_port = at->rmt_port;
614 clib_memcpy_fast (&hdr.lcl_ip, &at->lcl_ip, sizeof (ip46_address_t));
615 hdr.lcl_port = at->lcl_port;
616 rv = svm_fifo_enqueue (f, sizeof (hdr), (u8 *) & hdr);
617 ASSERT (rv == sizeof (hdr));
619 rv = svm_fifo_enqueue (f, actual_write, data);
622 if (rv > 0 && svm_fifo_set_event (f))
623 app_send_io_evt_to_vpp (vpp_evt_q, f->master_session_index, evt_type,
631 app_send_dgram (app_session_t * s, u8 * data, u32 len, u8 noblock)
633 return app_send_dgram_raw (s->tx_fifo, &s->transport, s->vpp_evt_q, data,
634 len, SESSION_IO_EVT_TX, 1 /* do_evt */ ,
639 app_send_stream_raw (svm_fifo_t * f, svm_msg_q_t * vpp_evt_q, u8 * data,
640 u32 len, u8 evt_type, u8 do_evt, u8 noblock)
644 rv = svm_fifo_enqueue (f, len, data);
647 if (rv > 0 && svm_fifo_set_event (f))
648 app_send_io_evt_to_vpp (vpp_evt_q, f->master_session_index, evt_type,
655 app_send_stream (app_session_t * s, u8 * data, u32 len, u8 noblock)
657 return app_send_stream_raw (s->tx_fifo, s->vpp_evt_q, data, len,
658 SESSION_IO_EVT_TX, 1 /* do_evt */ , noblock);
662 app_send (app_session_t * s, u8 * data, u32 len, u8 noblock)
665 return app_send_dgram (s, data, len, noblock);
666 return app_send_stream (s, data, len, noblock);
670 app_recv_dgram_raw (svm_fifo_t * f, u8 * buf, u32 len,
671 app_session_transport_t * at, u8 clear_evt, u8 peek)
673 session_dgram_pre_hdr_t ph;
677 max_deq = svm_fifo_max_dequeue_cons (f);
678 if (max_deq < sizeof (session_dgram_hdr_t))
681 svm_fifo_unset_event (f);
686 svm_fifo_unset_event (f);
688 svm_fifo_peek (f, 0, sizeof (ph), (u8 *) & ph);
689 ASSERT (ph.data_length >= ph.data_offset);
691 svm_fifo_peek (f, sizeof (ph), sizeof (*at), (u8 *) at);
692 len = clib_min (len, ph.data_length - ph.data_offset);
693 rv = svm_fifo_peek (f, ph.data_offset + SESSION_CONN_HDR_LEN, len, buf);
696 ph.data_offset += rv;
697 if (ph.data_offset == ph.data_length)
698 svm_fifo_dequeue_drop (f, ph.data_length + SESSION_CONN_HDR_LEN);
700 svm_fifo_overwrite_head (f, (u8 *) & ph, sizeof (ph));
705 app_recv_dgram (app_session_t * s, u8 * buf, u32 len)
707 return app_recv_dgram_raw (s->rx_fifo, buf, len, &s->transport, 1, 0);
711 app_recv_stream_raw (svm_fifo_t * f, u8 * buf, u32 len, u8 clear_evt, u8 peek)
714 svm_fifo_unset_event (f);
717 return svm_fifo_peek (f, 0, len, buf);
719 return svm_fifo_dequeue (f, len, buf);
723 app_recv_stream (app_session_t * s, u8 * buf, u32 len)
725 return app_recv_stream_raw (s->rx_fifo, buf, len, 1, 0);
729 app_recv (app_session_t * s, u8 * data, u32 len)
732 return app_recv_dgram (s, data, len);
733 return app_recv_stream (s, data, len);
736 #endif /* __included_uri_h__ */
739 * fd.io coding-style-patch-verification: ON
742 * eval: (c-set-style "gnu")