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 /** Notify app that session pool migration happened */
52 void (*session_migrate_callback) (session_t * s, session_handle_t new_sh);
54 /** Direct RX callback for built-in application */
55 int (*builtin_app_rx_callback) (session_t * session);
57 /** Direct TX callback for built-in application */
58 int (*builtin_app_tx_callback) (session_t * session);
62 #define foreach_app_init_args \
63 _(u32, api_client_index) \
66 _(u8 *, namespace_id) \
67 _(session_cb_vft_t *, session_cb_vft) \
70 typedef struct _vnet_app_attach_args_t
72 #define _(_type, _name) _type _name;
75 ssvm_private_t * segment;
76 svm_msg_q_t *app_evt_q;
78 } vnet_app_attach_args_t;
80 typedef struct _vnet_app_detach_args_t
84 } vnet_app_detach_args_t;
86 typedef struct _vnet_bind_args_t
90 session_endpoint_cfg_t sep_ext;
91 session_endpoint_t sep;
102 u32 segment_name_length;
103 u64 server_event_queue_address;
105 } vnet_listen_args_t;
107 typedef struct _vnet_unlisten_args_t
112 u64 handle; /**< Session handle */
114 u32 app_index; /**< Owning application index */
115 u32 wrk_map_index; /**< App's local pool worker index */
116 } vnet_unlisten_args_t;
118 typedef struct _vnet_connect_args
122 session_endpoint_cfg_t sep_ext;
123 session_endpoint_t sep;
130 session_handle_t session_handle;
131 } vnet_connect_args_t;
133 typedef struct _vnet_disconnect_args_t
135 session_handle_t handle;
137 } vnet_disconnect_args_t;
139 typedef struct _vnet_application_add_tls_cert_args_t
143 } vnet_app_add_tls_cert_args_t;
145 typedef struct _vnet_application_add_tls_key_args_t
149 } vnet_app_add_tls_key_args_t;
151 typedef enum tls_engine_type_
159 /* Application attach options */
163 APP_OPTIONS_EVT_QUEUE_SIZE,
164 APP_OPTIONS_SEGMENT_SIZE,
165 APP_OPTIONS_ADD_SEGMENT_SIZE,
166 APP_OPTIONS_PRIVATE_SEGMENT_COUNT,
167 APP_OPTIONS_RX_FIFO_SIZE,
168 APP_OPTIONS_TX_FIFO_SIZE,
169 APP_OPTIONS_PREALLOC_FIFO_PAIRS,
170 APP_OPTIONS_NAMESPACE,
171 APP_OPTIONS_NAMESPACE_SECRET,
172 APP_OPTIONS_PROXY_TRANSPORT,
173 APP_OPTIONS_ACCEPT_COOKIE,
174 APP_OPTIONS_TLS_ENGINE,
175 APP_OPTIONS_N_OPTIONS
176 } app_attach_options_index_t;
178 #define foreach_app_options_flags \
179 _(ACCEPT_REDIRECT, "Use FIFO with redirects") \
180 _(ADD_SEGMENT, "Add segment and signal app if needed") \
181 _(IS_BUILTIN, "Application is builtin") \
182 _(IS_TRANSPORT_APP, "Application is a transport proto") \
183 _(IS_PROXY, "Application is proxying") \
184 _(USE_GLOBAL_SCOPE, "App can use global session scope") \
185 _(USE_LOCAL_SCOPE, "App can use local session scope") \
186 _(EVT_MQ_USE_EVENTFD, "Use eventfds for signaling") \
188 typedef enum _app_options
190 #define _(sym, str) APP_OPTIONS_##sym,
191 foreach_app_options_flags
195 typedef enum _app_options_flags
197 #define _(sym, str) APP_OPTIONS_FLAGS_##sym = 1 << APP_OPTIONS_##sym,
198 foreach_app_options_flags
200 } app_options_flags_t;
202 #define foreach_fd_type \
203 _(VPP_MQ_SEGMENT, "Fd for vpp's event mq segment") \
204 _(MEMFD_SEGMENT, "Fd for memfd segment") \
205 _(MQ_EVENTFD, "Event fd used by message queue") \
206 _(VPP_MQ_EVENTFD, "Event fd used by vpp's message queue") \
208 typedef enum session_fd_type_
210 #define _(sym, str) SESSION_FD_##sym,
216 typedef enum session_fd_flag_
218 #define _(sym, str) SESSION_FD_F_##sym = 1 << SESSION_FD_##sym,
223 int parse_uri (char *uri, session_endpoint_cfg_t * sep);
224 int vnet_bind_uri (vnet_listen_args_t *);
225 int vnet_unbind_uri (vnet_unlisten_args_t * a);
226 int vnet_connect_uri (vnet_connect_args_t * a);
228 int vnet_application_attach (vnet_app_attach_args_t * a);
229 int vnet_application_detach (vnet_app_detach_args_t * a);
230 int vnet_listen (vnet_listen_args_t * a);
231 int vnet_connect (vnet_connect_args_t * a);
232 int vnet_unlisten (vnet_unlisten_args_t * a);
233 int vnet_disconnect_session (vnet_disconnect_args_t * a);
235 clib_error_t *vnet_app_add_tls_cert (vnet_app_add_tls_cert_args_t * a);
236 clib_error_t *vnet_app_add_tls_key (vnet_app_add_tls_key_args_t * a);
238 typedef struct app_session_transport_
240 ip46_address_t rmt_ip; /**< remote ip */
241 ip46_address_t lcl_ip; /**< local ip */
242 u16 rmt_port; /**< remote port (network order) */
243 u16 lcl_port; /**< local port (network order) */
244 u8 is_ip4; /**< set if uses ip4 networking */
245 } app_session_transport_t;
247 #define foreach_app_session_field \
248 _(svm_fifo_t, *rx_fifo) /**< rx fifo */ \
249 _(svm_fifo_t, *tx_fifo) /**< tx fifo */ \
250 _(session_type_t, session_type) /**< session type */ \
251 _(volatile u8, session_state) /**< session state */ \
252 _(u32, session_index) /**< index in owning pool */ \
253 _(app_session_transport_t, transport) /**< transport info */ \
254 _(svm_msg_q_t, *vpp_evt_q) /**< vpp event queue */ \
255 _(u8, is_dgram) /**< flag for dgram mode */ \
259 #define _(type, name) type name;
260 foreach_app_session_field
264 typedef struct session_listen_msg_
267 u32 context; /* Not needed but keeping it for compatibility with bapi */
274 } __clib_packed session_listen_msg_t;
276 typedef struct session_listen_uri_msg_
281 } __clib_packed session_listen_uri_msg_t;
283 typedef struct session_bound_msg_
295 u8 segment_name_length;
296 u8 segment_name[128];
297 } __clib_packed session_bound_msg_t;
299 typedef struct session_unlisten_msg_
304 session_handle_t handle;
305 } __clib_packed session_unlisten_msg_t;
307 typedef struct session_unlisten_reply_msg_
312 } __clib_packed session_unlisten_reply_msg_t;
314 typedef struct session_accepted_msg_
319 uword server_rx_fifo;
320 uword server_tx_fifo;
322 uword vpp_event_queue_address;
323 transport_endpoint_t rmt;
324 } __clib_packed session_accepted_msg_t;
326 typedef struct session_accepted_reply_msg_
331 } __clib_packed session_accepted_reply_msg_t;
333 typedef struct session_connect_msg_
346 } __clib_packed session_connect_msg_t;
348 typedef struct session_connect_uri_msg_
353 } __clib_packed session_connect_uri_msg_t;
355 typedef struct session_connected_msg_
360 uword server_rx_fifo;
361 uword server_tx_fifo;
365 u64 ct_segment_handle;
366 uword vpp_event_queue_address;
368 u8 segment_name_length;
370 transport_endpoint_t lcl;
371 } __clib_packed session_connected_msg_t;
373 typedef struct session_disconnect_msg_
377 session_handle_t handle;
378 } __clib_packed session_disconnect_msg_t;
380 typedef struct session_disconnected_msg_
385 } __clib_packed session_disconnected_msg_t;
387 typedef struct session_disconnected_reply_msg_
392 } __clib_packed session_disconnected_reply_msg_t;
394 typedef struct session_reset_msg_
399 } __clib_packed session_reset_msg_t;
401 typedef struct session_reset_reply_msg_
406 } __clib_packed session_reset_reply_msg_t;
408 typedef struct session_req_worker_update_msg_
411 } __clib_packed session_req_worker_update_msg_t;
413 /* NOTE: using u16 for wrk indices because message needs to fit in 18B */
414 typedef struct session_worker_update_msg_
420 } __clib_packed session_worker_update_msg_t;
422 typedef struct session_worker_update_reply_msg_
428 } __clib_packed session_worker_update_reply_msg_t;
430 typedef struct session_app_detach_msg_
434 } session_app_detach_msg_t;
436 typedef struct app_session_event_
439 session_event_t *evt;
440 } __clib_packed app_session_evt_t;
443 app_alloc_ctrl_evt_to_vpp (svm_msg_q_t * mq, app_session_evt_t * app_evt,
446 svm_msg_q_lock_and_alloc_msg_w_ring (mq,
447 SESSION_MQ_CTRL_EVT_RING,
448 SVM_Q_WAIT, &app_evt->msg);
449 app_evt->evt = svm_msg_q_msg_data (mq, &app_evt->msg);
450 clib_memset (app_evt->evt, 0, sizeof (*app_evt->evt));
451 app_evt->evt->event_type = evt_type;
455 app_send_ctrl_evt_to_vpp (svm_msg_q_t * mq, app_session_evt_t * app_evt)
457 svm_msg_q_add_and_unlock (mq, &app_evt->msg);
461 * Send fifo io event to vpp worker thread
463 * Because there may be multiple writers to one of vpp's queues, this
464 * protects message allocation and enqueueing.
466 * @param mq vpp message queue
467 * @param f fifo for which the event is sent
468 * @param evt_type type of event
469 * @param noblock flag to indicate is request is blocking or not
470 * @return 0 if success, negative integer otherwise
473 app_send_io_evt_to_vpp (svm_msg_q_t * mq, u32 session_index, u8 evt_type,
476 session_event_t *evt;
481 if (svm_msg_q_try_lock (mq))
483 if (PREDICT_FALSE (svm_msg_q_ring_is_full (mq, SESSION_MQ_IO_EVT_RING)))
485 svm_msg_q_unlock (mq);
488 msg = svm_msg_q_alloc_msg_w_ring (mq, SESSION_MQ_IO_EVT_RING);
489 evt = (session_event_t *) svm_msg_q_msg_data (mq, &msg);
490 evt->session_index = session_index;
491 evt->event_type = evt_type;
492 svm_msg_q_add_and_unlock (mq, &msg);
498 while (svm_msg_q_ring_is_full (mq, SESSION_MQ_IO_EVT_RING))
500 msg = svm_msg_q_alloc_msg_w_ring (mq, SESSION_MQ_IO_EVT_RING);
501 evt = (session_event_t *) svm_msg_q_msg_data (mq, &msg);
502 evt->session_index = session_index;
503 evt->event_type = evt_type;
504 if (svm_msg_q_is_full (mq))
506 svm_msg_q_add_and_unlock (mq, &msg);
512 app_send_dgram_raw (svm_fifo_t * f, app_session_transport_t * at,
513 svm_msg_q_t * vpp_evt_q, u8 * data, u32 len, u8 evt_type,
514 u8 do_evt, u8 noblock)
516 u32 max_enqueue, actual_write;
517 session_dgram_hdr_t hdr;
520 max_enqueue = svm_fifo_max_enqueue_prod (f);
521 if (max_enqueue <= sizeof (session_dgram_hdr_t))
524 max_enqueue -= sizeof (session_dgram_hdr_t);
525 actual_write = clib_min (len, max_enqueue);
526 hdr.data_length = actual_write;
528 clib_memcpy_fast (&hdr.rmt_ip, &at->rmt_ip, sizeof (ip46_address_t));
529 hdr.is_ip4 = at->is_ip4;
530 hdr.rmt_port = at->rmt_port;
531 clib_memcpy_fast (&hdr.lcl_ip, &at->lcl_ip, sizeof (ip46_address_t));
532 hdr.lcl_port = at->lcl_port;
533 rv = svm_fifo_enqueue (f, sizeof (hdr), (u8 *) & hdr);
534 ASSERT (rv == sizeof (hdr));
536 rv = svm_fifo_enqueue (f, actual_write, data);
539 if (rv > 0 && svm_fifo_set_event (f))
540 app_send_io_evt_to_vpp (vpp_evt_q, f->master_session_index, evt_type,
548 app_send_dgram (app_session_t * s, u8 * data, u32 len, u8 noblock)
550 return app_send_dgram_raw (s->tx_fifo, &s->transport, s->vpp_evt_q, data,
551 len, SESSION_IO_EVT_TX, 1 /* do_evt */ ,
556 app_send_stream_raw (svm_fifo_t * f, svm_msg_q_t * vpp_evt_q, u8 * data,
557 u32 len, u8 evt_type, u8 do_evt, u8 noblock)
561 rv = svm_fifo_enqueue (f, len, data);
564 if (rv > 0 && svm_fifo_set_event (f))
565 app_send_io_evt_to_vpp (vpp_evt_q, f->master_session_index, evt_type,
572 app_send_stream (app_session_t * s, u8 * data, u32 len, u8 noblock)
574 return app_send_stream_raw (s->tx_fifo, s->vpp_evt_q, data, len,
575 SESSION_IO_EVT_TX, 1 /* do_evt */ , noblock);
579 app_send (app_session_t * s, u8 * data, u32 len, u8 noblock)
582 return app_send_dgram (s, data, len, noblock);
583 return app_send_stream (s, data, len, noblock);
587 app_recv_dgram_raw (svm_fifo_t * f, u8 * buf, u32 len,
588 app_session_transport_t * at, u8 clear_evt, u8 peek)
590 session_dgram_pre_hdr_t ph;
594 max_deq = svm_fifo_max_dequeue_cons (f);
595 if (max_deq < sizeof (session_dgram_hdr_t))
598 svm_fifo_unset_event (f);
603 svm_fifo_unset_event (f);
605 svm_fifo_peek (f, 0, sizeof (ph), (u8 *) & ph);
606 ASSERT (ph.data_length >= ph.data_offset);
608 svm_fifo_peek (f, sizeof (ph), sizeof (*at), (u8 *) at);
609 len = clib_min (len, ph.data_length - ph.data_offset);
610 rv = svm_fifo_peek (f, ph.data_offset + SESSION_CONN_HDR_LEN, len, buf);
613 ph.data_offset += rv;
614 if (ph.data_offset == ph.data_length)
615 svm_fifo_dequeue_drop (f, ph.data_length + SESSION_CONN_HDR_LEN);
617 svm_fifo_overwrite_head (f, (u8 *) & ph, sizeof (ph));
622 app_recv_dgram (app_session_t * s, u8 * buf, u32 len)
624 return app_recv_dgram_raw (s->rx_fifo, buf, len, &s->transport, 1, 0);
628 app_recv_stream_raw (svm_fifo_t * f, u8 * buf, u32 len, u8 clear_evt, u8 peek)
631 svm_fifo_unset_event (f);
634 return svm_fifo_peek (f, 0, len, buf);
636 return svm_fifo_dequeue (f, len, buf);
640 app_recv_stream (app_session_t * s, u8 * buf, u32 len)
642 return app_recv_stream_raw (s->rx_fifo, buf, len, 1, 0);
646 app_recv (app_session_t * s, u8 * data, u32 len)
649 return app_recv_dgram (s, data, len);
650 return app_recv_stream (s, data, len);
653 #endif /* __included_uri_h__ */
656 * fd.io coding-style-patch-verification: ON
659 * eval: (c-set-style "gnu")