2 * Copyright (c) 2016 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 <svm/svm_fifo_segment.h>
19 #include <vnet/session/session.h>
20 #include <vnet/session/application.h>
21 #include <vnet/session/transport.h>
22 #include <vnet/tls/tls.h>
24 typedef struct _vnet_app_attach_args_t
26 #define _(_type, _name) _type _name;
29 ssvm_private_t * segment;
30 svm_msg_q_t *app_evt_q;
32 } vnet_app_attach_args_t;
34 typedef struct _vnet_app_detach_args_t
38 } vnet_app_detach_args_t;
40 typedef struct _vnet_bind_args_t
44 session_endpoint_cfg_t sep_ext;
45 session_endpoint_t sep;
56 u32 segment_name_length;
57 u64 server_event_queue_address;
61 typedef struct _vnet_unbind_args_t
66 u64 handle; /**< Session handle */
68 u32 app_index; /**< Owning application index */
69 u32 wrk_map_index; /**< App's local pool worker index */
72 typedef struct _vnet_connect_args
76 session_endpoint_cfg_t sep_ext;
77 session_endpoint_t sep;
84 session_handle_t session_handle;
85 } vnet_connect_args_t;
87 typedef struct _vnet_disconnect_args_t
89 session_handle_t handle;
91 } vnet_disconnect_args_t;
93 typedef struct _vnet_application_add_tls_cert_args_t
97 } vnet_app_add_tls_cert_args_t;
99 typedef struct _vnet_application_add_tls_key_args_t
103 } vnet_app_add_tls_key_args_t;
105 /* Application attach options */
109 APP_OPTIONS_EVT_QUEUE_SIZE,
110 APP_OPTIONS_SEGMENT_SIZE,
111 APP_OPTIONS_ADD_SEGMENT_SIZE,
112 APP_OPTIONS_PRIVATE_SEGMENT_COUNT,
113 APP_OPTIONS_RX_FIFO_SIZE,
114 APP_OPTIONS_TX_FIFO_SIZE,
115 APP_OPTIONS_PREALLOC_FIFO_PAIRS,
116 APP_OPTIONS_NAMESPACE,
117 APP_OPTIONS_NAMESPACE_SECRET,
118 APP_OPTIONS_PROXY_TRANSPORT,
119 APP_OPTIONS_ACCEPT_COOKIE,
120 APP_OPTIONS_TLS_ENGINE,
121 APP_OPTIONS_N_OPTIONS
122 } app_attach_options_index_t;
124 #define foreach_app_options_flags \
125 _(ACCEPT_REDIRECT, "Use FIFO with redirects") \
126 _(ADD_SEGMENT, "Add segment and signal app if needed") \
127 _(IS_BUILTIN, "Application is builtin") \
128 _(IS_TRANSPORT_APP, "Application is a transport proto") \
129 _(IS_PROXY, "Application is proxying") \
130 _(USE_GLOBAL_SCOPE, "App can use global session scope") \
131 _(USE_LOCAL_SCOPE, "App can use local session scope") \
132 _(USE_MQ_FOR_CTRL_MSGS, "Use message queue for ctr msgs") \
133 _(EVT_MQ_USE_EVENTFD, "Use eventfds for signaling") \
135 typedef enum _app_options
137 #define _(sym, str) APP_OPTIONS_##sym,
138 foreach_app_options_flags
142 typedef enum _app_options_flags
144 #define _(sym, str) APP_OPTIONS_FLAGS_##sym = 1 << APP_OPTIONS_##sym,
145 foreach_app_options_flags
147 } app_options_flags_t;
149 #define foreach_fd_type \
150 _(VPP_MQ_SEGMENT, "Fd for vpp's event mq segment") \
151 _(MEMFD_SEGMENT, "Fd for memfd segment") \
152 _(MQ_EVENTFD, "Event fd used by message queue") \
153 _(VPP_MQ_EVENTFD, "Event fd used by vpp's message queue") \
155 typedef enum session_fd_type_
157 #define _(sym, str) SESSION_FD_##sym,
163 typedef enum session_fd_flag_
165 #define _(sym, str) SESSION_FD_F_##sym = 1 << SESSION_FD_##sym,
170 int vnet_bind_uri (vnet_bind_args_t *);
171 int vnet_unbind_uri (vnet_unbind_args_t * a);
172 clib_error_t *vnet_connect_uri (vnet_connect_args_t * a);
174 clib_error_t *vnet_application_attach (vnet_app_attach_args_t * a);
175 clib_error_t *vnet_bind (vnet_bind_args_t * a);
176 clib_error_t *vnet_connect (vnet_connect_args_t * a);
177 clib_error_t *vnet_unbind (vnet_unbind_args_t * a);
178 int vnet_application_detach (vnet_app_detach_args_t * a);
179 int vnet_disconnect_session (vnet_disconnect_args_t * a);
181 clib_error_t *vnet_app_add_tls_cert (vnet_app_add_tls_cert_args_t * a);
182 clib_error_t *vnet_app_add_tls_key (vnet_app_add_tls_key_args_t * a);
184 extern const char test_srv_crt_rsa[];
185 extern const u32 test_srv_crt_rsa_len;
186 extern const char test_srv_key_rsa[];
187 extern const u32 test_srv_key_rsa_len;
189 typedef struct app_session_transport_
191 ip46_address_t rmt_ip; /**< remote ip */
192 ip46_address_t lcl_ip; /**< local ip */
193 u16 rmt_port; /**< remote port (network order) */
194 u16 lcl_port; /**< local port (network order) */
195 u8 is_ip4; /**< set if uses ip4 networking */
196 } app_session_transport_t;
198 #define foreach_app_session_field \
199 _(svm_fifo_t, *rx_fifo) /**< rx fifo */ \
200 _(svm_fifo_t, *tx_fifo) /**< tx fifo */ \
201 _(session_type_t, session_type) /**< session type */ \
202 _(volatile u8, session_state) /**< session state */ \
203 _(u32, session_index) /**< index in owning pool */ \
204 _(app_session_transport_t, transport) /**< transport info */ \
205 _(svm_msg_q_t, *vpp_evt_q) /**< vpp event queue */ \
206 _(u8, is_dgram) /**< flag for dgram mode */ \
210 #define _(type, name) type name;
211 foreach_app_session_field
215 typedef struct session_bound_msg_
227 u8 segment_name_length;
228 u8 segment_name[128];
229 } __clib_packed session_bound_msg_t;
231 typedef struct session_accepted_msg_
236 uword server_rx_fifo;
237 uword server_tx_fifo;
239 uword vpp_event_queue_address;
240 uword server_event_queue_address;
241 uword client_event_queue_address;
245 } __clib_packed session_accepted_msg_t;
247 typedef struct session_accepted_reply_msg_
252 } __clib_packed session_accepted_reply_msg_t;
254 /* Make sure this is not too large, otherwise it won't fit when dequeued in
255 * the session queue node */
256 STATIC_ASSERT (sizeof (session_accepted_reply_msg_t) <= 16, "accept reply");
258 typedef struct session_connected_msg_
263 uword server_rx_fifo;
264 uword server_tx_fifo;
266 uword vpp_event_queue_address;
267 uword client_event_queue_address;
268 uword server_event_queue_address;
270 u8 segment_name_length;
275 } __clib_packed session_connected_msg_t;
277 typedef struct session_disconnected_msg_
282 } __clib_packed session_disconnected_msg_t;
284 typedef struct session_disconnected_reply_msg_
289 } __clib_packed session_disconnected_reply_msg_t;
291 typedef struct session_reset_msg_
296 } __clib_packed session_reset_msg_t;
298 typedef struct session_reset_reply_msg_
303 } __clib_packed session_reset_reply_msg_t;
305 typedef struct session_req_worker_update_msg_
308 } __clib_packed session_req_worker_update_msg_t;
310 /* NOTE: using u16 for wrk indices because message needs to fit in 18B */
311 typedef struct session_worker_update_msg_
317 } __clib_packed session_worker_update_msg_t;
319 typedef struct session_worker_update_reply_msg_
325 } __clib_packed session_worker_update_reply_msg_t;
327 typedef struct app_session_event_
330 session_event_t *evt;
331 } __clib_packed app_session_evt_t;
334 app_alloc_ctrl_evt_to_vpp (svm_msg_q_t * mq, app_session_evt_t * app_evt,
337 svm_msg_q_lock_and_alloc_msg_w_ring (mq,
338 SESSION_MQ_CTRL_EVT_RING,
339 SVM_Q_WAIT, &app_evt->msg);
340 svm_msg_q_unlock (mq);
341 app_evt->evt = svm_msg_q_msg_data (mq, &app_evt->msg);
342 clib_memset (app_evt->evt, 0, sizeof (*app_evt->evt));
343 app_evt->evt->event_type = evt_type;
347 app_send_ctrl_evt_to_vpp (svm_msg_q_t * mq, app_session_evt_t * app_evt)
349 svm_msg_q_add (mq, &app_evt->msg, SVM_Q_WAIT);
353 * Send fifo io event to vpp worker thread
355 * Because there may be multiple writers to one of vpp's queues, this
356 * protects message allocation and enqueueing.
358 * @param mq vpp message queue
359 * @param f fifo for which the event is sent
360 * @param evt_type type of event
361 * @param noblock flag to indicate is request is blocking or not
362 * @return 0 if success, negative integer otherwise
365 app_send_io_evt_to_vpp (svm_msg_q_t * mq, svm_fifo_t * f, u8 evt_type,
368 session_event_t *evt;
373 if (svm_msg_q_try_lock (mq))
375 if (PREDICT_FALSE (svm_msg_q_ring_is_full (mq, SESSION_MQ_IO_EVT_RING)))
377 svm_msg_q_unlock (mq);
380 msg = svm_msg_q_alloc_msg_w_ring (mq, SESSION_MQ_IO_EVT_RING);
381 if (PREDICT_FALSE (svm_msg_q_msg_is_invalid (&msg)))
383 svm_msg_q_unlock (mq);
386 evt = (session_event_t *) svm_msg_q_msg_data (mq, &msg);
388 evt->event_type = evt_type;
389 svm_msg_q_add_and_unlock (mq, &msg);
395 while (svm_msg_q_ring_is_full (mq, SESSION_MQ_IO_EVT_RING))
397 msg = svm_msg_q_alloc_msg_w_ring (mq, SESSION_MQ_IO_EVT_RING);
398 evt = (session_event_t *) svm_msg_q_msg_data (mq, &msg);
400 evt->event_type = evt_type;
401 if (svm_msg_q_is_full (mq))
403 svm_msg_q_add_and_unlock (mq, &msg);
409 app_send_dgram_raw (svm_fifo_t * f, app_session_transport_t * at,
410 svm_msg_q_t * vpp_evt_q, u8 * data, u32 len, u8 evt_type,
413 u32 max_enqueue, actual_write;
414 session_dgram_hdr_t hdr;
417 max_enqueue = svm_fifo_max_enqueue (f);
418 if (max_enqueue <= sizeof (session_dgram_hdr_t))
421 max_enqueue -= sizeof (session_dgram_hdr_t);
422 actual_write = clib_min (len, max_enqueue);
423 hdr.data_length = actual_write;
425 clib_memcpy_fast (&hdr.rmt_ip, &at->rmt_ip, sizeof (ip46_address_t));
426 hdr.is_ip4 = at->is_ip4;
427 hdr.rmt_port = at->rmt_port;
428 clib_memcpy_fast (&hdr.lcl_ip, &at->lcl_ip, sizeof (ip46_address_t));
429 hdr.lcl_port = at->lcl_port;
430 rv = svm_fifo_enqueue_nowait (f, sizeof (hdr), (u8 *) & hdr);
431 ASSERT (rv == sizeof (hdr));
433 if ((rv = svm_fifo_enqueue_nowait (f, actual_write, data)) > 0)
435 if (svm_fifo_set_event (f))
436 app_send_io_evt_to_vpp (vpp_evt_q, f, evt_type, noblock);
443 app_send_dgram (app_session_t * s, u8 * data, u32 len, u8 noblock)
445 return app_send_dgram_raw (s->tx_fifo, &s->transport, s->vpp_evt_q, data,
446 len, FIFO_EVENT_APP_TX, noblock);
450 app_send_stream_raw (svm_fifo_t * f, svm_msg_q_t * vpp_evt_q, u8 * data,
451 u32 len, u8 evt_type, u8 noblock)
455 if ((rv = svm_fifo_enqueue_nowait (f, len, data)) > 0)
457 if (svm_fifo_set_event (f))
458 app_send_io_evt_to_vpp (vpp_evt_q, f, evt_type, noblock);
464 app_send_stream (app_session_t * s, u8 * data, u32 len, u8 noblock)
466 return app_send_stream_raw (s->tx_fifo, s->vpp_evt_q, data, len,
467 FIFO_EVENT_APP_TX, noblock);
471 app_send (app_session_t * s, u8 * data, u32 len, u8 noblock)
474 return app_send_dgram (s, data, len, noblock);
475 return app_send_stream (s, data, len, noblock);
479 app_recv_dgram_raw (svm_fifo_t * f, u8 * buf, u32 len,
480 app_session_transport_t * at, u8 clear_evt, u8 peek)
482 session_dgram_pre_hdr_t ph;
486 max_deq = svm_fifo_max_dequeue (f);
487 if (max_deq < sizeof (session_dgram_hdr_t))
490 svm_fifo_unset_event (f);
495 svm_fifo_unset_event (f);
497 svm_fifo_peek (f, 0, sizeof (ph), (u8 *) & ph);
498 ASSERT (ph.data_length >= ph.data_offset);
500 svm_fifo_peek (f, sizeof (ph), sizeof (*at), (u8 *) at);
501 len = clib_min (len, ph.data_length - ph.data_offset);
502 rv = svm_fifo_peek (f, ph.data_offset + SESSION_CONN_HDR_LEN, len, buf);
505 ph.data_offset += rv;
506 if (ph.data_offset == ph.data_length)
507 svm_fifo_dequeue_drop (f, ph.data_length + SESSION_CONN_HDR_LEN);
509 svm_fifo_overwrite_head (f, (u8 *) & ph, sizeof (ph));
514 app_recv_dgram (app_session_t * s, u8 * buf, u32 len)
516 return app_recv_dgram_raw (s->rx_fifo, buf, len, &s->transport, 1, 0);
520 app_recv_stream_raw (svm_fifo_t * f, u8 * buf, u32 len, u8 clear_evt, u8 peek)
523 svm_fifo_unset_event (f);
526 return svm_fifo_peek (f, 0, len, buf);
528 return svm_fifo_dequeue_nowait (f, len, buf);
532 app_recv_stream (app_session_t * s, u8 * buf, u32 len)
534 return app_recv_stream_raw (s->rx_fifo, buf, len, 1, 0);
538 app_recv (app_session_t * s, u8 * data, u32 len)
541 return app_recv_dgram (s, data, len);
542 return app_recv_stream (s, data, len);
545 #endif /* __included_uri_h__ */
548 * fd.io coding-style-patch-verification: ON
551 * eval: (c-set-style "gnu")