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;
31 } vnet_app_attach_args_t;
33 typedef struct _vnet_app_detach_args_t
36 } vnet_app_detach_args_t;
38 typedef struct _vnet_bind_args_t
42 session_endpoint_extended_t sep_ext;
43 session_endpoint_t sep;
54 u32 segment_name_length;
55 u64 server_event_queue_address;
59 typedef struct _vnet_unbind_args_t
64 u64 handle; /**< Session handle */
66 u32 app_index; /**< Owning application index */
67 u32 wrk_map_index; /**< App's local pool worker index */
70 typedef struct _vnet_connect_args
74 session_endpoint_extended_t sep_ext;
75 session_endpoint_t sep;
82 session_handle_t session_handle;
83 } vnet_connect_args_t;
85 typedef struct _vnet_disconnect_args_t
87 session_handle_t handle;
89 } vnet_disconnect_args_t;
91 typedef struct _vnet_application_add_tls_cert_args_t
95 } vnet_app_add_tls_cert_args_t;
97 typedef struct _vnet_application_add_tls_key_args_t
101 } vnet_app_add_tls_key_args_t;
103 /* Application attach options */
107 APP_OPTIONS_EVT_QUEUE_SIZE,
108 APP_OPTIONS_SEGMENT_SIZE,
109 APP_OPTIONS_ADD_SEGMENT_SIZE,
110 APP_OPTIONS_PRIVATE_SEGMENT_COUNT,
111 APP_OPTIONS_RX_FIFO_SIZE,
112 APP_OPTIONS_TX_FIFO_SIZE,
113 APP_OPTIONS_PREALLOC_FIFO_PAIRS,
114 APP_OPTIONS_NAMESPACE,
115 APP_OPTIONS_NAMESPACE_SECRET,
116 APP_OPTIONS_PROXY_TRANSPORT,
117 APP_OPTIONS_ACCEPT_COOKIE,
118 APP_OPTIONS_TLS_ENGINE,
119 APP_OPTIONS_N_OPTIONS
120 } app_attach_options_index_t;
122 #define foreach_app_options_flags \
123 _(ACCEPT_REDIRECT, "Use FIFO with redirects") \
124 _(ADD_SEGMENT, "Add segment and signal app if needed") \
125 _(IS_BUILTIN, "Application is builtin") \
126 _(IS_TRANSPORT_APP, "Application is a transport proto") \
127 _(IS_PROXY, "Application is proxying") \
128 _(USE_GLOBAL_SCOPE, "App can use global session scope") \
129 _(USE_LOCAL_SCOPE, "App can use local session scope") \
130 _(USE_MQ_FOR_CTRL_MSGS, "Use message queue for ctr msgs") \
131 _(EVT_MQ_USE_EVENTFD, "Use eventfds for signaling") \
133 typedef enum _app_options
135 #define _(sym, str) APP_OPTIONS_##sym,
136 foreach_app_options_flags
140 typedef enum _app_options_flags
142 #define _(sym, str) APP_OPTIONS_FLAGS_##sym = 1 << APP_OPTIONS_##sym,
143 foreach_app_options_flags
145 } app_options_flags_t;
147 #define foreach_fd_type \
148 _(VPP_MQ_SEGMENT, "Fd for vpp's event mq segment") \
149 _(MEMFD_SEGMENT, "Fd for memfd segment") \
150 _(MQ_EVENTFD, "Event fd used by message queue") \
151 _(VPP_MQ_EVENTFD, "Event fd used by vpp's message queue") \
153 typedef enum session_fd_type_
155 #define _(sym, str) SESSION_FD_##sym,
161 typedef enum session_fd_flag_
163 #define _(sym, str) SESSION_FD_F_##sym = 1 << SESSION_FD_##sym,
168 int vnet_bind_uri (vnet_bind_args_t *);
169 int vnet_unbind_uri (vnet_unbind_args_t * a);
170 clib_error_t *vnet_connect_uri (vnet_connect_args_t * a);
172 clib_error_t *vnet_application_attach (vnet_app_attach_args_t * a);
173 clib_error_t *vnet_bind (vnet_bind_args_t * a);
174 clib_error_t *vnet_connect (vnet_connect_args_t * a);
175 clib_error_t *vnet_unbind (vnet_unbind_args_t * a);
176 int vnet_application_detach (vnet_app_detach_args_t * a);
177 int vnet_disconnect_session (vnet_disconnect_args_t * a);
179 clib_error_t *vnet_app_add_tls_cert (vnet_app_add_tls_cert_args_t * a);
180 clib_error_t *vnet_app_add_tls_key (vnet_app_add_tls_key_args_t * a);
182 extern const char test_srv_crt_rsa[];
183 extern const u32 test_srv_crt_rsa_len;
184 extern const char test_srv_key_rsa[];
185 extern const u32 test_srv_key_rsa_len;
187 typedef struct app_session_transport_
189 ip46_address_t rmt_ip; /**< remote ip */
190 ip46_address_t lcl_ip; /**< local ip */
191 u16 rmt_port; /**< remote port (network order) */
192 u16 lcl_port; /**< local port (network order) */
193 u8 is_ip4; /**< set if uses ip4 networking */
194 } app_session_transport_t;
196 #define foreach_app_session_field \
197 _(svm_fifo_t, *rx_fifo) /**< rx fifo */ \
198 _(svm_fifo_t, *tx_fifo) /**< tx fifo */ \
199 _(session_type_t, session_type) /**< session type */ \
200 _(volatile u8, session_state) /**< session state */ \
201 _(u32, session_index) /**< index in owning pool */ \
202 _(app_session_transport_t, transport) /**< transport info */ \
203 _(svm_msg_q_t, *vpp_evt_q) /**< vpp event queue */ \
204 _(u8, is_dgram) /**< flag for dgram mode */ \
208 #define _(type, name) type name;
209 foreach_app_session_field
213 typedef struct session_bound_msg_
225 u8 segment_name_length;
226 u8 segment_name[128];
227 } __clib_packed session_bound_msg_t;
229 typedef struct session_accepted_msg_
236 u64 vpp_event_queue_address;
237 u64 server_event_queue_address;
238 u64 client_event_queue_address;
242 } __clib_packed session_accepted_msg_t;
244 typedef struct session_accepted_reply_msg_
249 } __clib_packed session_accepted_reply_msg_t;
251 /* Make sure this is not too large, otherwise it won't fit when dequeued in
252 * the session queue node */
253 STATIC_ASSERT (sizeof (session_accepted_reply_msg_t) <= 16, "accept reply");
255 typedef struct session_connected_msg_
262 u64 vpp_event_queue_address;
263 u64 client_event_queue_address;
264 u64 server_event_queue_address;
266 u8 segment_name_length;
271 } __clib_packed session_connected_msg_t;
273 typedef struct session_disconnected_msg_
278 } __clib_packed session_disconnected_msg_t;
280 typedef struct session_disconnected_reply_msg_
285 } __clib_packed session_disconnected_reply_msg_t;
287 typedef struct session_reset_msg_
292 } __clib_packed session_reset_msg_t;
294 typedef struct session_reset_reply_msg_
300 } __clib_packed session_reset_reply_msg_t;
302 typedef struct app_session_event_
305 session_event_t *evt;
306 } __clib_packed app_session_evt_t;
309 app_alloc_ctrl_evt_to_vpp (svm_msg_q_t * mq, app_session_evt_t * app_evt,
312 svm_msg_q_lock_and_alloc_msg_w_ring (mq,
313 SESSION_MQ_CTRL_EVT_RING,
314 SVM_Q_WAIT, &app_evt->msg);
315 svm_msg_q_unlock (mq);
316 app_evt->evt = svm_msg_q_msg_data (mq, &app_evt->msg);
317 memset (app_evt->evt, 0, sizeof (*app_evt->evt));
318 app_evt->evt->event_type = evt_type;
322 app_send_ctrl_evt_to_vpp (svm_msg_q_t * mq, app_session_evt_t * app_evt)
324 svm_msg_q_add (mq, &app_evt->msg, SVM_Q_WAIT);
328 * Send fifo io event to vpp worker thread
330 * Because there may be multiple writers to one of vpp's queues, this
331 * protects message allocation and enqueueing.
333 * @param mq vpp message queue
334 * @param f fifo for which the event is sent
335 * @param evt_type type of event
336 * @param noblock flag to indicate is request is blocking or not
337 * @return 0 if success, negative integer otherwise
340 app_send_io_evt_to_vpp (svm_msg_q_t * mq, svm_fifo_t * f, u8 evt_type,
343 session_event_t *evt;
348 if (svm_msg_q_try_lock (mq))
350 if (PREDICT_FALSE (svm_msg_q_ring_is_full (mq, SESSION_MQ_IO_EVT_RING)))
352 svm_msg_q_unlock (mq);
355 msg = svm_msg_q_alloc_msg_w_ring (mq, SESSION_MQ_IO_EVT_RING);
356 if (PREDICT_FALSE (svm_msg_q_msg_is_invalid (&msg)))
358 svm_msg_q_unlock (mq);
361 evt = (session_event_t *) svm_msg_q_msg_data (mq, &msg);
363 evt->event_type = evt_type;
364 svm_msg_q_add_and_unlock (mq, &msg);
370 while (svm_msg_q_ring_is_full (mq, SESSION_MQ_IO_EVT_RING))
372 msg = svm_msg_q_alloc_msg_w_ring (mq, SESSION_MQ_IO_EVT_RING);
373 evt = (session_event_t *) svm_msg_q_msg_data (mq, &msg);
375 evt->event_type = evt_type;
376 if (svm_msg_q_is_full (mq))
378 svm_msg_q_add_and_unlock (mq, &msg);
384 app_send_dgram_raw (svm_fifo_t * f, app_session_transport_t * at,
385 svm_msg_q_t * vpp_evt_q, u8 * data, u32 len, u8 evt_type,
388 u32 max_enqueue, actual_write;
389 session_dgram_hdr_t hdr;
392 max_enqueue = svm_fifo_max_enqueue (f);
393 if (max_enqueue <= sizeof (session_dgram_hdr_t))
396 max_enqueue -= sizeof (session_dgram_hdr_t);
397 actual_write = clib_min (len, max_enqueue);
398 hdr.data_length = actual_write;
400 clib_memcpy (&hdr.rmt_ip, &at->rmt_ip, sizeof (ip46_address_t));
401 hdr.is_ip4 = at->is_ip4;
402 hdr.rmt_port = at->rmt_port;
403 clib_memcpy (&hdr.lcl_ip, &at->lcl_ip, sizeof (ip46_address_t));
404 hdr.lcl_port = at->lcl_port;
405 rv = svm_fifo_enqueue_nowait (f, sizeof (hdr), (u8 *) & hdr);
406 ASSERT (rv == sizeof (hdr));
408 if ((rv = svm_fifo_enqueue_nowait (f, actual_write, data)) > 0)
410 if (svm_fifo_set_event (f))
411 app_send_io_evt_to_vpp (vpp_evt_q, f, evt_type, noblock);
418 app_send_dgram (app_session_t * s, u8 * data, u32 len, u8 noblock)
420 return app_send_dgram_raw (s->tx_fifo, &s->transport, s->vpp_evt_q, data,
421 len, FIFO_EVENT_APP_TX, noblock);
425 app_send_stream_raw (svm_fifo_t * f, svm_msg_q_t * vpp_evt_q, u8 * data,
426 u32 len, u8 evt_type, u8 noblock)
430 if ((rv = svm_fifo_enqueue_nowait (f, len, data)) > 0)
432 if (svm_fifo_set_event (f))
433 app_send_io_evt_to_vpp (vpp_evt_q, f, evt_type, noblock);
439 app_send_stream (app_session_t * s, u8 * data, u32 len, u8 noblock)
441 return app_send_stream_raw (s->tx_fifo, s->vpp_evt_q, data, len,
442 FIFO_EVENT_APP_TX, noblock);
446 app_send (app_session_t * s, u8 * data, u32 len, u8 noblock)
449 return app_send_dgram (s, data, len, noblock);
450 return app_send_stream (s, data, len, noblock);
454 app_recv_dgram_raw (svm_fifo_t * f, u8 * buf, u32 len,
455 app_session_transport_t * at, u8 clear_evt, u8 peek)
457 session_dgram_pre_hdr_t ph;
461 max_deq = svm_fifo_max_dequeue (f);
462 if (max_deq < sizeof (session_dgram_hdr_t))
465 svm_fifo_unset_event (f);
470 svm_fifo_unset_event (f);
472 svm_fifo_peek (f, 0, sizeof (ph), (u8 *) & ph);
473 ASSERT (ph.data_length >= ph.data_offset);
475 svm_fifo_peek (f, sizeof (ph), sizeof (*at), (u8 *) at);
476 len = clib_min (len, ph.data_length - ph.data_offset);
477 rv = svm_fifo_peek (f, ph.data_offset + SESSION_CONN_HDR_LEN, len, buf);
480 ph.data_offset += rv;
481 if (ph.data_offset == ph.data_length)
482 svm_fifo_dequeue_drop (f, ph.data_length + SESSION_CONN_HDR_LEN);
484 svm_fifo_overwrite_head (f, (u8 *) & ph, sizeof (ph));
489 app_recv_dgram (app_session_t * s, u8 * buf, u32 len)
491 return app_recv_dgram_raw (s->rx_fifo, buf, len, &s->transport, 1, 0);
495 app_recv_stream_raw (svm_fifo_t * f, u8 * buf, u32 len, u8 clear_evt, u8 peek)
498 svm_fifo_unset_event (f);
501 return svm_fifo_peek (f, 0, len, buf);
503 return svm_fifo_dequeue_nowait (f, len, buf);
507 app_recv_stream (app_session_t * s, u8 * buf, u32 len)
509 return app_recv_stream_raw (s->rx_fifo, buf, len, 1, 0);
513 app_recv (app_session_t * s, u8 * data, u32 len)
516 return app_recv_dgram (s, data, len);
517 return app_recv_stream (s, data, len);
520 #endif /* __included_uri_h__ */
523 * fd.io coding-style-patch-verification: ON
526 * eval: (c-set-style "gnu")