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 _stream_session_cb_vft
26 /** Notify server of new segment */
27 int (*add_segment_callback) (u32 api_client_index, u64 segment_handle);
29 /** Notify server of new segment */
30 int (*del_segment_callback) (u32 api_client_index, u64 segment_handle);
32 /** Notify server of newly accepted session */
33 int (*session_accept_callback) (session_t * new_session);
35 /** Connection request callback */
36 int (*session_connected_callback) (u32 app_wrk_index, u32 opaque,
37 session_t * s, u8 code);
39 /** Notify app that session is closing */
40 void (*session_disconnect_callback) (session_t * s);
42 /** Notify app that transport is closed */
43 void (*session_transport_closed_callback) (session_t * s);
45 /** Notify app that session or transport are about to be removed */
46 void (*session_cleanup_callback) (session_t * s, session_cleanup_ntf_t ntf);
48 /** Notify app that session was reset */
49 void (*session_reset_callback) (session_t * s);
51 /** Direct RX callback for built-in application */
52 int (*builtin_app_rx_callback) (session_t * session);
54 /** Direct TX callback for built-in application */
55 int (*builtin_app_tx_callback) (session_t * session);
59 #define foreach_app_init_args \
60 _(u32, api_client_index) \
63 _(u8 *, namespace_id) \
64 _(session_cb_vft_t *, session_cb_vft) \
67 typedef struct _vnet_app_attach_args_t
69 #define _(_type, _name) _type _name;
72 ssvm_private_t * segment;
73 svm_msg_q_t *app_evt_q;
75 } vnet_app_attach_args_t;
77 typedef struct _vnet_app_detach_args_t
81 } vnet_app_detach_args_t;
83 typedef struct _vnet_bind_args_t
87 session_endpoint_cfg_t sep_ext;
88 session_endpoint_t sep;
99 u32 segment_name_length;
100 u64 server_event_queue_address;
102 } vnet_listen_args_t;
104 typedef struct _vnet_unlisten_args_t
109 u64 handle; /**< Session handle */
111 u32 app_index; /**< Owning application index */
112 u32 wrk_map_index; /**< App's local pool worker index */
113 } vnet_unlisten_args_t;
115 typedef struct _vnet_connect_args
119 session_endpoint_cfg_t sep_ext;
120 session_endpoint_t sep;
127 session_handle_t session_handle;
128 } vnet_connect_args_t;
130 typedef struct _vnet_disconnect_args_t
132 session_handle_t handle;
134 } vnet_disconnect_args_t;
136 typedef struct _vnet_application_add_tls_cert_args_t
140 } vnet_app_add_tls_cert_args_t;
142 typedef struct _vnet_application_add_tls_key_args_t
146 } vnet_app_add_tls_key_args_t;
148 typedef enum tls_engine_type_
156 /* Application attach options */
160 APP_OPTIONS_EVT_QUEUE_SIZE,
161 APP_OPTIONS_SEGMENT_SIZE,
162 APP_OPTIONS_ADD_SEGMENT_SIZE,
163 APP_OPTIONS_PRIVATE_SEGMENT_COUNT,
164 APP_OPTIONS_RX_FIFO_SIZE,
165 APP_OPTIONS_TX_FIFO_SIZE,
166 APP_OPTIONS_PREALLOC_FIFO_PAIRS,
167 APP_OPTIONS_NAMESPACE,
168 APP_OPTIONS_NAMESPACE_SECRET,
169 APP_OPTIONS_PROXY_TRANSPORT,
170 APP_OPTIONS_ACCEPT_COOKIE,
171 APP_OPTIONS_TLS_ENGINE,
172 APP_OPTIONS_N_OPTIONS
173 } app_attach_options_index_t;
175 #define foreach_app_options_flags \
176 _(ACCEPT_REDIRECT, "Use FIFO with redirects") \
177 _(ADD_SEGMENT, "Add segment and signal app if needed") \
178 _(IS_BUILTIN, "Application is builtin") \
179 _(IS_TRANSPORT_APP, "Application is a transport proto") \
180 _(IS_PROXY, "Application is proxying") \
181 _(USE_GLOBAL_SCOPE, "App can use global session scope") \
182 _(USE_LOCAL_SCOPE, "App can use local session scope") \
183 _(EVT_MQ_USE_EVENTFD, "Use eventfds for signaling") \
185 typedef enum _app_options
187 #define _(sym, str) APP_OPTIONS_##sym,
188 foreach_app_options_flags
192 typedef enum _app_options_flags
194 #define _(sym, str) APP_OPTIONS_FLAGS_##sym = 1 << APP_OPTIONS_##sym,
195 foreach_app_options_flags
197 } app_options_flags_t;
199 #define foreach_fd_type \
200 _(VPP_MQ_SEGMENT, "Fd for vpp's event mq segment") \
201 _(MEMFD_SEGMENT, "Fd for memfd segment") \
202 _(MQ_EVENTFD, "Event fd used by message queue") \
203 _(VPP_MQ_EVENTFD, "Event fd used by vpp's message queue") \
205 typedef enum session_fd_type_
207 #define _(sym, str) SESSION_FD_##sym,
213 typedef enum session_fd_flag_
215 #define _(sym, str) SESSION_FD_F_##sym = 1 << SESSION_FD_##sym,
220 int parse_uri (char *uri, session_endpoint_cfg_t * sep);
221 int vnet_bind_uri (vnet_listen_args_t *);
222 int vnet_unbind_uri (vnet_unlisten_args_t * a);
223 int vnet_connect_uri (vnet_connect_args_t * a);
225 int vnet_application_attach (vnet_app_attach_args_t * a);
226 int vnet_application_detach (vnet_app_detach_args_t * a);
227 int vnet_listen (vnet_listen_args_t * a);
228 int vnet_connect (vnet_connect_args_t * a);
229 int vnet_unlisten (vnet_unlisten_args_t * a);
230 int vnet_disconnect_session (vnet_disconnect_args_t * a);
232 clib_error_t *vnet_app_add_tls_cert (vnet_app_add_tls_cert_args_t * a);
233 clib_error_t *vnet_app_add_tls_key (vnet_app_add_tls_key_args_t * a);
235 typedef struct app_session_transport_
237 ip46_address_t rmt_ip; /**< remote ip */
238 ip46_address_t lcl_ip; /**< local ip */
239 u16 rmt_port; /**< remote port (network order) */
240 u16 lcl_port; /**< local port (network order) */
241 u8 is_ip4; /**< set if uses ip4 networking */
242 } app_session_transport_t;
244 #define foreach_app_session_field \
245 _(svm_fifo_t, *rx_fifo) /**< rx fifo */ \
246 _(svm_fifo_t, *tx_fifo) /**< tx fifo */ \
247 _(session_type_t, session_type) /**< session type */ \
248 _(volatile u8, session_state) /**< session state */ \
249 _(u32, session_index) /**< index in owning pool */ \
250 _(app_session_transport_t, transport) /**< transport info */ \
251 _(svm_msg_q_t, *vpp_evt_q) /**< vpp event queue */ \
252 _(u8, is_dgram) /**< flag for dgram mode */ \
256 #define _(type, name) type name;
257 foreach_app_session_field
261 typedef struct session_bound_msg_
273 u8 segment_name_length;
274 u8 segment_name[128];
275 } __clib_packed session_bound_msg_t;
277 typedef struct session_unlisten_reply_msg_
282 } __clib_packed session_unlisten_reply_msg_t;
284 typedef struct session_accepted_msg_
289 uword server_rx_fifo;
290 uword server_tx_fifo;
292 uword vpp_event_queue_address;
293 transport_endpoint_t rmt;
294 } __clib_packed session_accepted_msg_t;
296 typedef struct session_accepted_reply_msg_
301 } __clib_packed session_accepted_reply_msg_t;
303 /* Make sure this is not too large, otherwise it won't fit when dequeued in
304 * the session queue node */
305 STATIC_ASSERT (sizeof (session_accepted_reply_msg_t) <= 16, "accept reply");
307 typedef struct session_connected_msg_
312 uword server_rx_fifo;
313 uword server_tx_fifo;
317 u64 ct_segment_handle;
318 uword vpp_event_queue_address;
320 u8 segment_name_length;
322 transport_endpoint_t lcl;
323 } __clib_packed session_connected_msg_t;
325 typedef struct session_disconnected_msg_
330 } __clib_packed session_disconnected_msg_t;
332 typedef struct session_disconnected_reply_msg_
337 } __clib_packed session_disconnected_reply_msg_t;
339 typedef struct session_reset_msg_
344 } __clib_packed session_reset_msg_t;
346 typedef struct session_reset_reply_msg_
351 } __clib_packed session_reset_reply_msg_t;
353 typedef struct session_req_worker_update_msg_
356 } __clib_packed session_req_worker_update_msg_t;
358 /* NOTE: using u16 for wrk indices because message needs to fit in 18B */
359 typedef struct session_worker_update_msg_
365 } __clib_packed session_worker_update_msg_t;
367 typedef struct session_worker_update_reply_msg_
373 } __clib_packed session_worker_update_reply_msg_t;
375 typedef struct app_session_event_
378 session_event_t *evt;
379 } __clib_packed app_session_evt_t;
382 app_alloc_ctrl_evt_to_vpp (svm_msg_q_t * mq, app_session_evt_t * app_evt,
385 svm_msg_q_lock_and_alloc_msg_w_ring (mq,
386 SESSION_MQ_CTRL_EVT_RING,
387 SVM_Q_WAIT, &app_evt->msg);
388 app_evt->evt = svm_msg_q_msg_data (mq, &app_evt->msg);
389 clib_memset (app_evt->evt, 0, sizeof (*app_evt->evt));
390 app_evt->evt->event_type = evt_type;
394 app_send_ctrl_evt_to_vpp (svm_msg_q_t * mq, app_session_evt_t * app_evt)
396 svm_msg_q_add_and_unlock (mq, &app_evt->msg);
400 * Send fifo io event to vpp worker thread
402 * Because there may be multiple writers to one of vpp's queues, this
403 * protects message allocation and enqueueing.
405 * @param mq vpp message queue
406 * @param f fifo for which the event is sent
407 * @param evt_type type of event
408 * @param noblock flag to indicate is request is blocking or not
409 * @return 0 if success, negative integer otherwise
412 app_send_io_evt_to_vpp (svm_msg_q_t * mq, u32 session_index, u8 evt_type,
415 session_event_t *evt;
420 if (svm_msg_q_try_lock (mq))
422 if (PREDICT_FALSE (svm_msg_q_ring_is_full (mq, SESSION_MQ_IO_EVT_RING)))
424 svm_msg_q_unlock (mq);
427 msg = svm_msg_q_alloc_msg_w_ring (mq, SESSION_MQ_IO_EVT_RING);
428 if (PREDICT_FALSE (svm_msg_q_msg_is_invalid (&msg)))
430 svm_msg_q_unlock (mq);
433 evt = (session_event_t *) svm_msg_q_msg_data (mq, &msg);
434 evt->session_index = session_index;
435 evt->event_type = evt_type;
436 svm_msg_q_add_and_unlock (mq, &msg);
442 while (svm_msg_q_ring_is_full (mq, SESSION_MQ_IO_EVT_RING))
444 msg = svm_msg_q_alloc_msg_w_ring (mq, SESSION_MQ_IO_EVT_RING);
445 evt = (session_event_t *) svm_msg_q_msg_data (mq, &msg);
446 evt->session_index = session_index;
447 evt->event_type = evt_type;
448 if (svm_msg_q_is_full (mq))
450 svm_msg_q_add_and_unlock (mq, &msg);
456 app_send_dgram_raw (svm_fifo_t * f, app_session_transport_t * at,
457 svm_msg_q_t * vpp_evt_q, u8 * data, u32 len, u8 evt_type,
458 u8 do_evt, u8 noblock)
460 u32 max_enqueue, actual_write;
461 session_dgram_hdr_t hdr;
464 max_enqueue = svm_fifo_max_enqueue_prod (f);
465 if (max_enqueue <= sizeof (session_dgram_hdr_t))
468 max_enqueue -= sizeof (session_dgram_hdr_t);
469 actual_write = clib_min (len, max_enqueue);
470 hdr.data_length = actual_write;
472 clib_memcpy_fast (&hdr.rmt_ip, &at->rmt_ip, sizeof (ip46_address_t));
473 hdr.is_ip4 = at->is_ip4;
474 hdr.rmt_port = at->rmt_port;
475 clib_memcpy_fast (&hdr.lcl_ip, &at->lcl_ip, sizeof (ip46_address_t));
476 hdr.lcl_port = at->lcl_port;
477 rv = svm_fifo_enqueue (f, sizeof (hdr), (u8 *) & hdr);
478 ASSERT (rv == sizeof (hdr));
480 rv = svm_fifo_enqueue (f, actual_write, data);
483 if (rv > 0 && svm_fifo_set_event (f))
484 app_send_io_evt_to_vpp (vpp_evt_q, f->master_session_index, evt_type,
492 app_send_dgram (app_session_t * s, u8 * data, u32 len, u8 noblock)
494 return app_send_dgram_raw (s->tx_fifo, &s->transport, s->vpp_evt_q, data,
495 len, SESSION_IO_EVT_TX, 1 /* do_evt */ ,
500 app_send_stream_raw (svm_fifo_t * f, svm_msg_q_t * vpp_evt_q, u8 * data,
501 u32 len, u8 evt_type, u8 do_evt, u8 noblock)
505 rv = svm_fifo_enqueue (f, len, data);
508 if (rv > 0 && svm_fifo_set_event (f))
509 app_send_io_evt_to_vpp (vpp_evt_q, f->master_session_index, evt_type,
516 app_send_stream (app_session_t * s, u8 * data, u32 len, u8 noblock)
518 return app_send_stream_raw (s->tx_fifo, s->vpp_evt_q, data, len,
519 SESSION_IO_EVT_TX, 1 /* do_evt */ , noblock);
523 app_send (app_session_t * s, u8 * data, u32 len, u8 noblock)
526 return app_send_dgram (s, data, len, noblock);
527 return app_send_stream (s, data, len, noblock);
531 app_recv_dgram_raw (svm_fifo_t * f, u8 * buf, u32 len,
532 app_session_transport_t * at, u8 clear_evt, u8 peek)
534 session_dgram_pre_hdr_t ph;
538 max_deq = svm_fifo_max_dequeue_cons (f);
539 if (max_deq < sizeof (session_dgram_hdr_t))
542 svm_fifo_unset_event (f);
547 svm_fifo_unset_event (f);
549 svm_fifo_peek (f, 0, sizeof (ph), (u8 *) & ph);
550 ASSERT (ph.data_length >= ph.data_offset);
552 svm_fifo_peek (f, sizeof (ph), sizeof (*at), (u8 *) at);
553 len = clib_min (len, ph.data_length - ph.data_offset);
554 rv = svm_fifo_peek (f, ph.data_offset + SESSION_CONN_HDR_LEN, len, buf);
557 ph.data_offset += rv;
558 if (ph.data_offset == ph.data_length)
559 svm_fifo_dequeue_drop (f, ph.data_length + SESSION_CONN_HDR_LEN);
561 svm_fifo_overwrite_head (f, (u8 *) & ph, sizeof (ph));
566 app_recv_dgram (app_session_t * s, u8 * buf, u32 len)
568 return app_recv_dgram_raw (s->rx_fifo, buf, len, &s->transport, 1, 0);
572 app_recv_stream_raw (svm_fifo_t * f, u8 * buf, u32 len, u8 clear_evt, u8 peek)
575 svm_fifo_unset_event (f);
578 return svm_fifo_peek (f, 0, len, buf);
580 return svm_fifo_dequeue (f, len, buf);
584 app_recv_stream (app_session_t * s, u8 * buf, u32 len)
586 return app_recv_stream_raw (s->rx_fifo, buf, len, 1, 0);
590 app_recv (app_session_t * s, u8 * data, u32 len)
593 return app_recv_dgram (s, data, len);
594 return app_recv_stream (s, data, len);
597 #endif /* __included_uri_h__ */
600 * fd.io coding-style-patch-verification: ON
603 * eval: (c-set-style "gnu")