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 <svm/svm_fifo_segment.h>
21 #include <vnet/session/session_types.h>
22 #include <vnet/tls/tls_test.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 session was reset */
43 void (*session_reset_callback) (session_t * s);
45 /** Direct RX callback for built-in application */
46 int (*builtin_app_rx_callback) (session_t * session);
48 /** Direct TX callback for built-in application */
49 int (*builtin_app_tx_callback) (session_t * session);
53 #define foreach_app_init_args \
54 _(u32, api_client_index) \
57 _(u8 *, namespace_id) \
58 _(session_cb_vft_t *, session_cb_vft) \
61 typedef struct _vnet_app_attach_args_t
63 #define _(_type, _name) _type _name;
66 ssvm_private_t * segment;
67 svm_msg_q_t *app_evt_q;
69 } vnet_app_attach_args_t;
71 typedef struct _vnet_app_detach_args_t
75 } vnet_app_detach_args_t;
77 typedef struct _vnet_bind_args_t
81 session_endpoint_cfg_t sep_ext;
82 session_endpoint_t sep;
93 u32 segment_name_length;
94 u64 server_event_queue_address;
98 typedef struct _vnet_unlisten_args_t
103 u64 handle; /**< Session handle */
105 u32 app_index; /**< Owning application index */
106 u32 wrk_map_index; /**< App's local pool worker index */
107 } vnet_unlisten_args_t;
109 typedef struct _vnet_connect_args
113 session_endpoint_cfg_t sep_ext;
114 session_endpoint_t sep;
121 session_handle_t session_handle;
122 } vnet_connect_args_t;
124 typedef struct _vnet_disconnect_args_t
126 session_handle_t handle;
128 } vnet_disconnect_args_t;
130 typedef struct _vnet_application_add_tls_cert_args_t
134 } vnet_app_add_tls_cert_args_t;
136 typedef struct _vnet_application_add_tls_key_args_t
140 } vnet_app_add_tls_key_args_t;
142 typedef enum tls_engine_type_
150 /* Application attach options */
154 APP_OPTIONS_EVT_QUEUE_SIZE,
155 APP_OPTIONS_SEGMENT_SIZE,
156 APP_OPTIONS_ADD_SEGMENT_SIZE,
157 APP_OPTIONS_PRIVATE_SEGMENT_COUNT,
158 APP_OPTIONS_RX_FIFO_SIZE,
159 APP_OPTIONS_TX_FIFO_SIZE,
160 APP_OPTIONS_PREALLOC_FIFO_PAIRS,
161 APP_OPTIONS_NAMESPACE,
162 APP_OPTIONS_NAMESPACE_SECRET,
163 APP_OPTIONS_PROXY_TRANSPORT,
164 APP_OPTIONS_ACCEPT_COOKIE,
165 APP_OPTIONS_TLS_ENGINE,
166 APP_OPTIONS_N_OPTIONS
167 } app_attach_options_index_t;
169 #define foreach_app_options_flags \
170 _(ACCEPT_REDIRECT, "Use FIFO with redirects") \
171 _(ADD_SEGMENT, "Add segment and signal app if needed") \
172 _(IS_BUILTIN, "Application is builtin") \
173 _(IS_TRANSPORT_APP, "Application is a transport proto") \
174 _(IS_PROXY, "Application is proxying") \
175 _(USE_GLOBAL_SCOPE, "App can use global session scope") \
176 _(USE_LOCAL_SCOPE, "App can use local session scope") \
177 _(EVT_MQ_USE_EVENTFD, "Use eventfds for signaling") \
179 typedef enum _app_options
181 #define _(sym, str) APP_OPTIONS_##sym,
182 foreach_app_options_flags
186 typedef enum _app_options_flags
188 #define _(sym, str) APP_OPTIONS_FLAGS_##sym = 1 << APP_OPTIONS_##sym,
189 foreach_app_options_flags
191 } app_options_flags_t;
193 #define foreach_fd_type \
194 _(VPP_MQ_SEGMENT, "Fd for vpp's event mq segment") \
195 _(MEMFD_SEGMENT, "Fd for memfd segment") \
196 _(MQ_EVENTFD, "Event fd used by message queue") \
197 _(VPP_MQ_EVENTFD, "Event fd used by vpp's message queue") \
199 typedef enum session_fd_type_
201 #define _(sym, str) SESSION_FD_##sym,
207 typedef enum session_fd_flag_
209 #define _(sym, str) SESSION_FD_F_##sym = 1 << SESSION_FD_##sym,
214 int vnet_bind_uri (vnet_listen_args_t *);
215 int vnet_unbind_uri (vnet_unlisten_args_t * a);
216 int vnet_connect_uri (vnet_connect_args_t * a);
218 int vnet_application_attach (vnet_app_attach_args_t * a);
219 int vnet_application_detach (vnet_app_detach_args_t * a);
220 int vnet_listen (vnet_listen_args_t * a);
221 int vnet_connect (vnet_connect_args_t * a);
222 int vnet_unlisten (vnet_unlisten_args_t * a);
223 int vnet_disconnect_session (vnet_disconnect_args_t * a);
225 clib_error_t *vnet_app_add_tls_cert (vnet_app_add_tls_cert_args_t * a);
226 clib_error_t *vnet_app_add_tls_key (vnet_app_add_tls_key_args_t * a);
228 typedef struct app_session_transport_
230 ip46_address_t rmt_ip; /**< remote ip */
231 ip46_address_t lcl_ip; /**< local ip */
232 u16 rmt_port; /**< remote port (network order) */
233 u16 lcl_port; /**< local port (network order) */
234 u8 is_ip4; /**< set if uses ip4 networking */
235 } app_session_transport_t;
237 #define foreach_app_session_field \
238 _(svm_fifo_t, *rx_fifo) /**< rx fifo */ \
239 _(svm_fifo_t, *tx_fifo) /**< tx fifo */ \
240 _(session_type_t, session_type) /**< session type */ \
241 _(volatile u8, session_state) /**< session state */ \
242 _(u32, session_index) /**< index in owning pool */ \
243 _(app_session_transport_t, transport) /**< transport info */ \
244 _(svm_msg_q_t, *vpp_evt_q) /**< vpp event queue */ \
245 _(u8, is_dgram) /**< flag for dgram mode */ \
249 #define _(type, name) type name;
250 foreach_app_session_field
254 typedef struct session_bound_msg_
266 u8 segment_name_length;
267 u8 segment_name[128];
268 } __clib_packed session_bound_msg_t;
270 typedef struct session_unlisten_reply_msg_
275 } __clib_packed session_unlisten_reply_msg_t;
277 typedef struct session_accepted_msg_
282 uword server_rx_fifo;
283 uword server_tx_fifo;
285 uword vpp_event_queue_address;
286 uword server_event_queue_address;
287 uword client_event_queue_address;
291 } __clib_packed session_accepted_msg_t;
293 typedef struct session_accepted_reply_msg_
298 } __clib_packed session_accepted_reply_msg_t;
300 /* Make sure this is not too large, otherwise it won't fit when dequeued in
301 * the session queue node */
302 STATIC_ASSERT (sizeof (session_accepted_reply_msg_t) <= 16, "accept reply");
304 typedef struct session_connected_msg_
309 uword server_rx_fifo;
310 uword server_tx_fifo;
312 uword vpp_event_queue_address;
313 uword client_event_queue_address;
314 uword server_event_queue_address;
316 u8 segment_name_length;
321 } __clib_packed session_connected_msg_t;
323 typedef struct session_disconnected_msg_
328 } __clib_packed session_disconnected_msg_t;
330 typedef struct session_disconnected_reply_msg_
335 } __clib_packed session_disconnected_reply_msg_t;
337 typedef struct session_reset_msg_
342 } __clib_packed session_reset_msg_t;
344 typedef struct session_reset_reply_msg_
349 } __clib_packed session_reset_reply_msg_t;
351 typedef struct session_req_worker_update_msg_
354 } __clib_packed session_req_worker_update_msg_t;
356 /* NOTE: using u16 for wrk indices because message needs to fit in 18B */
357 typedef struct session_worker_update_msg_
363 } __clib_packed session_worker_update_msg_t;
365 typedef struct session_worker_update_reply_msg_
371 } __clib_packed session_worker_update_reply_msg_t;
373 typedef struct app_session_event_
376 session_event_t *evt;
377 } __clib_packed app_session_evt_t;
380 app_alloc_ctrl_evt_to_vpp (svm_msg_q_t * mq, app_session_evt_t * app_evt,
383 svm_msg_q_lock_and_alloc_msg_w_ring (mq,
384 SESSION_MQ_CTRL_EVT_RING,
385 SVM_Q_WAIT, &app_evt->msg);
386 svm_msg_q_unlock (mq);
387 app_evt->evt = svm_msg_q_msg_data (mq, &app_evt->msg);
388 clib_memset (app_evt->evt, 0, sizeof (*app_evt->evt));
389 app_evt->evt->event_type = evt_type;
393 app_send_ctrl_evt_to_vpp (svm_msg_q_t * mq, app_session_evt_t * app_evt)
395 svm_msg_q_add (mq, &app_evt->msg, SVM_Q_WAIT);
399 * Send fifo io event to vpp worker thread
401 * Because there may be multiple writers to one of vpp's queues, this
402 * protects message allocation and enqueueing.
404 * @param mq vpp message queue
405 * @param f fifo for which the event is sent
406 * @param evt_type type of event
407 * @param noblock flag to indicate is request is blocking or not
408 * @return 0 if success, negative integer otherwise
411 app_send_io_evt_to_vpp (svm_msg_q_t * mq, svm_fifo_t * f, u8 evt_type,
414 session_event_t *evt;
419 if (svm_msg_q_try_lock (mq))
421 if (PREDICT_FALSE (svm_msg_q_ring_is_full (mq, SESSION_MQ_IO_EVT_RING)))
423 svm_msg_q_unlock (mq);
426 msg = svm_msg_q_alloc_msg_w_ring (mq, SESSION_MQ_IO_EVT_RING);
427 if (PREDICT_FALSE (svm_msg_q_msg_is_invalid (&msg)))
429 svm_msg_q_unlock (mq);
432 evt = (session_event_t *) svm_msg_q_msg_data (mq, &msg);
434 evt->event_type = evt_type;
435 svm_msg_q_add_and_unlock (mq, &msg);
441 while (svm_msg_q_ring_is_full (mq, SESSION_MQ_IO_EVT_RING))
443 msg = svm_msg_q_alloc_msg_w_ring (mq, SESSION_MQ_IO_EVT_RING);
444 evt = (session_event_t *) svm_msg_q_msg_data (mq, &msg);
446 evt->event_type = evt_type;
447 if (svm_msg_q_is_full (mq))
449 svm_msg_q_add_and_unlock (mq, &msg);
455 app_send_dgram_raw (svm_fifo_t * f, app_session_transport_t * at,
456 svm_msg_q_t * vpp_evt_q, u8 * data, u32 len, u8 evt_type,
459 u32 max_enqueue, actual_write;
460 session_dgram_hdr_t hdr;
463 max_enqueue = svm_fifo_max_enqueue (f);
464 if (max_enqueue <= sizeof (session_dgram_hdr_t))
467 max_enqueue -= sizeof (session_dgram_hdr_t);
468 actual_write = clib_min (len, max_enqueue);
469 hdr.data_length = actual_write;
471 clib_memcpy_fast (&hdr.rmt_ip, &at->rmt_ip, sizeof (ip46_address_t));
472 hdr.is_ip4 = at->is_ip4;
473 hdr.rmt_port = at->rmt_port;
474 clib_memcpy_fast (&hdr.lcl_ip, &at->lcl_ip, sizeof (ip46_address_t));
475 hdr.lcl_port = at->lcl_port;
476 rv = svm_fifo_enqueue_nowait (f, sizeof (hdr), (u8 *) & hdr);
477 ASSERT (rv == sizeof (hdr));
479 if ((rv = svm_fifo_enqueue_nowait (f, actual_write, data)) > 0)
481 if (svm_fifo_set_event (f))
482 app_send_io_evt_to_vpp (vpp_evt_q, f, evt_type, noblock);
489 app_send_dgram (app_session_t * s, u8 * data, u32 len, u8 noblock)
491 return app_send_dgram_raw (s->tx_fifo, &s->transport, s->vpp_evt_q, data,
492 len, SESSION_IO_EVT_TX, noblock);
496 app_send_stream_raw (svm_fifo_t * f, svm_msg_q_t * vpp_evt_q, u8 * data,
497 u32 len, u8 evt_type, u8 noblock)
501 if ((rv = svm_fifo_enqueue_nowait (f, len, data)) > 0)
503 if (svm_fifo_set_event (f))
504 app_send_io_evt_to_vpp (vpp_evt_q, f, evt_type, noblock);
510 app_send_stream (app_session_t * s, u8 * data, u32 len, u8 noblock)
512 return app_send_stream_raw (s->tx_fifo, s->vpp_evt_q, data, len,
513 SESSION_IO_EVT_TX, noblock);
517 app_send (app_session_t * s, u8 * data, u32 len, u8 noblock)
520 return app_send_dgram (s, data, len, noblock);
521 return app_send_stream (s, data, len, noblock);
525 app_recv_dgram_raw (svm_fifo_t * f, u8 * buf, u32 len,
526 app_session_transport_t * at, u8 clear_evt, u8 peek)
528 session_dgram_pre_hdr_t ph;
532 max_deq = svm_fifo_max_dequeue (f);
533 if (max_deq < sizeof (session_dgram_hdr_t))
536 svm_fifo_unset_event (f);
541 svm_fifo_unset_event (f);
543 svm_fifo_peek (f, 0, sizeof (ph), (u8 *) & ph);
544 ASSERT (ph.data_length >= ph.data_offset);
546 svm_fifo_peek (f, sizeof (ph), sizeof (*at), (u8 *) at);
547 len = clib_min (len, ph.data_length - ph.data_offset);
548 rv = svm_fifo_peek (f, ph.data_offset + SESSION_CONN_HDR_LEN, len, buf);
551 ph.data_offset += rv;
552 if (ph.data_offset == ph.data_length)
553 svm_fifo_dequeue_drop (f, ph.data_length + SESSION_CONN_HDR_LEN);
555 svm_fifo_overwrite_head (f, (u8 *) & ph, sizeof (ph));
560 app_recv_dgram (app_session_t * s, u8 * buf, u32 len)
562 return app_recv_dgram_raw (s->rx_fifo, buf, len, &s->transport, 1, 0);
566 app_recv_stream_raw (svm_fifo_t * f, u8 * buf, u32 len, u8 clear_evt, u8 peek)
569 svm_fifo_unset_event (f);
572 return svm_fifo_peek (f, 0, len, buf);
574 return svm_fifo_dequeue_nowait (f, len, buf);
578 app_recv_stream (app_session_t * s, u8 * buf, u32 len)
580 return app_recv_stream_raw (s->rx_fifo, buf, len, 1, 0);
584 app_recv (app_session_t * s, u8 * data, u32 len)
587 return app_recv_dgram (s, data, len);
588 return app_recv_stream (s, data, len);
591 #endif /* __included_uri_h__ */
594 * fd.io coding-style-patch-verification: ON
597 * eval: (c-set-style "gnu")