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_PROXY, "Application is proxying") \
127 _(USE_GLOBAL_SCOPE, "App can use global session scope") \
128 _(USE_LOCAL_SCOPE, "App can use local session scope") \
129 _(USE_MQ_FOR_CTRL_MSGS, "Use message queue for ctr msgs") \
130 _(EVT_MQ_USE_EVENTFD, "Use eventfds for signaling") \
132 typedef enum _app_options
134 #define _(sym, str) APP_OPTIONS_##sym,
135 foreach_app_options_flags
139 typedef enum _app_options_flags
141 #define _(sym, str) APP_OPTIONS_FLAGS_##sym = 1 << APP_OPTIONS_##sym,
142 foreach_app_options_flags
144 } app_options_flags_t;
146 #define foreach_fd_type \
147 _(VPP_MQ_SEGMENT, "Fd for vpp's event mq segment") \
148 _(MEMFD_SEGMENT, "Fd for memfd segment") \
149 _(MQ_EVENTFD, "Event fd used by message queue") \
150 _(VPP_MQ_EVENTFD, "Event fd used by vpp's message queue") \
152 typedef enum session_fd_type_
154 #define _(sym, str) SESSION_FD_##sym,
160 typedef enum session_fd_flag_
162 #define _(sym, str) SESSION_FD_F_##sym = 1 << SESSION_FD_##sym,
167 int vnet_bind_uri (vnet_bind_args_t *);
168 int vnet_unbind_uri (vnet_unbind_args_t * a);
169 clib_error_t *vnet_connect_uri (vnet_connect_args_t * a);
171 clib_error_t *vnet_application_attach (vnet_app_attach_args_t * a);
172 clib_error_t *vnet_bind (vnet_bind_args_t * a);
173 clib_error_t *vnet_connect (vnet_connect_args_t * a);
174 clib_error_t *vnet_unbind (vnet_unbind_args_t * a);
175 int vnet_application_detach (vnet_app_detach_args_t * a);
176 int vnet_disconnect_session (vnet_disconnect_args_t * a);
178 clib_error_t *vnet_app_add_tls_cert (vnet_app_add_tls_cert_args_t * a);
179 clib_error_t *vnet_app_add_tls_key (vnet_app_add_tls_key_args_t * a);
181 extern const char test_srv_crt_rsa[];
182 extern const u32 test_srv_crt_rsa_len;
183 extern const char test_srv_key_rsa[];
184 extern const u32 test_srv_key_rsa_len;
186 typedef struct app_session_transport_
188 ip46_address_t rmt_ip; /**< remote ip */
189 ip46_address_t lcl_ip; /**< local ip */
190 u16 rmt_port; /**< remote port (network order) */
191 u16 lcl_port; /**< local port (network order) */
192 u8 is_ip4; /**< set if uses ip4 networking */
193 } app_session_transport_t;
195 #define foreach_app_session_field \
196 _(svm_fifo_t, *rx_fifo) /**< rx fifo */ \
197 _(svm_fifo_t, *tx_fifo) /**< tx fifo */ \
198 _(session_type_t, session_type) /**< session type */ \
199 _(volatile u8, session_state) /**< session state */ \
200 _(u32, session_index) /**< index in owning pool */ \
201 _(app_session_transport_t, transport) /**< transport info */ \
202 _(svm_msg_q_t, *vpp_evt_q) /**< vpp event queue */ \
203 _(u8, is_dgram) /**< flag for dgram mode */ \
207 #define _(type, name) type name;
208 foreach_app_session_field
212 typedef struct session_bound_msg_
224 u8 segment_name_length;
225 u8 segment_name[128];
226 } __clib_packed session_bound_msg_t;
228 typedef struct session_accepted_msg_
235 u64 vpp_event_queue_address;
236 u64 server_event_queue_address;
237 u64 client_event_queue_address;
241 } __clib_packed session_accepted_msg_t;
243 typedef struct session_accepted_reply_msg_
248 } __clib_packed session_accepted_reply_msg_t;
250 /* Make sure this is not too large, otherwise it won't fit when dequeued in
251 * the session queue node */
252 STATIC_ASSERT (sizeof (session_accepted_reply_msg_t) <= 16, "accept reply");
254 typedef struct session_connected_msg_
261 u64 vpp_event_queue_address;
262 u64 client_event_queue_address;
263 u64 server_event_queue_address;
265 u8 segment_name_length;
270 } __clib_packed session_connected_msg_t;
272 typedef struct session_disconnected_msg_
277 } __clib_packed session_disconnected_msg_t;
279 typedef struct session_disconnected_reply_msg_
284 } __clib_packed session_disconnected_reply_msg_t;
286 typedef struct session_reset_msg_
291 } __clib_packed session_reset_msg_t;
293 typedef struct session_reset_reply_msg_
299 } __clib_packed session_reset_reply_msg_t;
301 typedef struct app_session_event_
304 session_event_t *evt;
305 } __clib_packed app_session_evt_t;
308 app_alloc_ctrl_evt_to_vpp (svm_msg_q_t * mq, app_session_evt_t * app_evt,
311 svm_msg_q_lock_and_alloc_msg_w_ring (mq,
312 SESSION_MQ_CTRL_EVT_RING,
313 SVM_Q_WAIT, &app_evt->msg);
314 svm_msg_q_unlock (mq);
315 app_evt->evt = svm_msg_q_msg_data (mq, &app_evt->msg);
316 memset (app_evt->evt, 0, sizeof (*app_evt->evt));
317 app_evt->evt->event_type = evt_type;
321 app_send_ctrl_evt_to_vpp (svm_msg_q_t * mq, app_session_evt_t * app_evt)
323 svm_msg_q_add (mq, &app_evt->msg, SVM_Q_WAIT);
327 * Send fifo io event to vpp worker thread
329 * Because there may be multiple writers to one of vpp's queues, this
330 * protects message allocation and enqueueing.
332 * @param mq vpp message queue
333 * @param f fifo for which the event is sent
334 * @param evt_type type of event
335 * @param noblock flag to indicate is request is blocking or not
336 * @return 0 if success, negative integer otherwise
339 app_send_io_evt_to_vpp (svm_msg_q_t * mq, svm_fifo_t * f, u8 evt_type,
342 session_event_t *evt;
347 if (svm_msg_q_try_lock (mq))
349 if (PREDICT_FALSE (svm_msg_q_ring_is_full (mq, SESSION_MQ_IO_EVT_RING)))
351 svm_msg_q_unlock (mq);
354 msg = svm_msg_q_alloc_msg_w_ring (mq, SESSION_MQ_IO_EVT_RING);
355 if (PREDICT_FALSE (svm_msg_q_msg_is_invalid (&msg)))
357 svm_msg_q_unlock (mq);
360 evt = (session_event_t *) svm_msg_q_msg_data (mq, &msg);
362 evt->event_type = evt_type;
363 svm_msg_q_add_and_unlock (mq, &msg);
369 while (svm_msg_q_ring_is_full (mq, SESSION_MQ_IO_EVT_RING))
371 msg = svm_msg_q_alloc_msg_w_ring (mq, SESSION_MQ_IO_EVT_RING);
372 evt = (session_event_t *) svm_msg_q_msg_data (mq, &msg);
374 evt->event_type = evt_type;
375 if (svm_msg_q_is_full (mq))
377 svm_msg_q_add_and_unlock (mq, &msg);
383 app_send_dgram_raw (svm_fifo_t * f, app_session_transport_t * at,
384 svm_msg_q_t * vpp_evt_q, u8 * data, u32 len, u8 evt_type,
387 u32 max_enqueue, actual_write;
388 session_dgram_hdr_t hdr;
391 max_enqueue = svm_fifo_max_enqueue (f);
392 if (max_enqueue <= sizeof (session_dgram_hdr_t))
395 max_enqueue -= sizeof (session_dgram_hdr_t);
396 actual_write = clib_min (len, max_enqueue);
397 hdr.data_length = actual_write;
399 clib_memcpy (&hdr.rmt_ip, &at->rmt_ip, sizeof (ip46_address_t));
400 hdr.is_ip4 = at->is_ip4;
401 hdr.rmt_port = at->rmt_port;
402 clib_memcpy (&hdr.lcl_ip, &at->lcl_ip, sizeof (ip46_address_t));
403 hdr.lcl_port = at->lcl_port;
404 rv = svm_fifo_enqueue_nowait (f, sizeof (hdr), (u8 *) & hdr);
405 ASSERT (rv == sizeof (hdr));
407 if ((rv = svm_fifo_enqueue_nowait (f, actual_write, data)) > 0)
409 if (svm_fifo_set_event (f))
410 app_send_io_evt_to_vpp (vpp_evt_q, f, evt_type, noblock);
417 app_send_dgram (app_session_t * s, u8 * data, u32 len, u8 noblock)
419 return app_send_dgram_raw (s->tx_fifo, &s->transport, s->vpp_evt_q, data,
420 len, FIFO_EVENT_APP_TX, noblock);
424 app_send_stream_raw (svm_fifo_t * f, svm_msg_q_t * vpp_evt_q, u8 * data,
425 u32 len, u8 evt_type, u8 noblock)
429 if ((rv = svm_fifo_enqueue_nowait (f, len, data)) > 0)
431 if (svm_fifo_set_event (f))
432 app_send_io_evt_to_vpp (vpp_evt_q, f, evt_type, noblock);
438 app_send_stream (app_session_t * s, u8 * data, u32 len, u8 noblock)
440 return app_send_stream_raw (s->tx_fifo, s->vpp_evt_q, data, len,
441 FIFO_EVENT_APP_TX, noblock);
445 app_send (app_session_t * s, u8 * data, u32 len, u8 noblock)
448 return app_send_dgram (s, data, len, noblock);
449 return app_send_stream (s, data, len, noblock);
453 app_recv_dgram_raw (svm_fifo_t * f, u8 * buf, u32 len,
454 app_session_transport_t * at, u8 clear_evt, u8 peek)
456 session_dgram_pre_hdr_t ph;
460 max_deq = svm_fifo_max_dequeue (f);
461 if (max_deq < sizeof (session_dgram_hdr_t))
464 svm_fifo_unset_event (f);
469 svm_fifo_unset_event (f);
471 svm_fifo_peek (f, 0, sizeof (ph), (u8 *) & ph);
472 ASSERT (ph.data_length >= ph.data_offset);
474 svm_fifo_peek (f, sizeof (ph), sizeof (*at), (u8 *) at);
475 len = clib_min (len, ph.data_length - ph.data_offset);
476 rv = svm_fifo_peek (f, ph.data_offset + SESSION_CONN_HDR_LEN, len, buf);
479 ph.data_offset += rv;
480 if (ph.data_offset == ph.data_length)
481 svm_fifo_dequeue_drop (f, ph.data_length + SESSION_CONN_HDR_LEN);
483 svm_fifo_overwrite_head (f, (u8 *) & ph, sizeof (ph));
488 app_recv_dgram (app_session_t * s, u8 * buf, u32 len)
490 return app_recv_dgram_raw (s->rx_fifo, buf, len, &s->transport, 1, 0);
494 app_recv_stream_raw (svm_fifo_t * f, u8 * buf, u32 len, u8 clear_evt, u8 peek)
497 svm_fifo_unset_event (f);
500 return svm_fifo_peek (f, 0, len, buf);
502 return svm_fifo_dequeue_nowait (f, len, buf);
506 app_recv_stream (app_session_t * s, u8 * buf, u32 len)
508 return app_recv_stream_raw (s->rx_fifo, buf, len, 1, 0);
512 app_recv (app_session_t * s, u8 * data, u32 len)
515 return app_recv_dgram (s, data, len);
516 return app_recv_stream (s, data, len);
519 #endif /* __included_uri_h__ */
522 * fd.io coding-style-patch-verification: ON
525 * eval: (c-set-style "gnu")