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 <vlib/vlib.h>
19 #include <vnet/vnet.h>
20 #include <svm/svm_fifo_segment.h>
21 #include <vnet/session/session.h>
22 #include <vnet/session/application.h>
23 #include <vnet/session/transport.h>
24 #include <vnet/tls/tls.h>
26 typedef struct _vnet_app_attach_args_t
28 /** Binary API client index */
31 /** Application name. Used by builtin apps */
34 /** Application and segment manager options */
37 /** ID of the namespace the app has access to */
40 /** Session to application callback functions */
41 session_cb_vft_t *session_cb_vft;
46 ssvm_private_t *segment;
47 u64 app_event_queue_address;
49 } vnet_app_attach_args_t;
51 typedef struct _vnet_app_detach_args_t
54 } vnet_app_detach_args_t;
56 typedef struct _vnet_bind_args_t
61 session_endpoint_t sep;
70 u32 segment_name_length;
71 u64 server_event_queue_address;
75 typedef struct _vnet_unbind_args_t
85 typedef struct _vnet_connect_args
90 session_endpoint_extended_t sep;
95 session_handle_t session_handle;
96 } vnet_connect_args_t;
98 typedef struct _vnet_disconnect_args_t
100 session_handle_t handle;
102 } vnet_disconnect_args_t;
104 typedef struct _vnet_application_add_tls_cert_args_t
108 } vnet_app_add_tls_cert_args_t;
110 typedef struct _vnet_application_add_tls_key_args_t
114 } vnet_app_add_tls_key_args_t;
116 /* Application attach options */
120 APP_OPTIONS_EVT_QUEUE_SIZE,
121 APP_OPTIONS_SEGMENT_SIZE,
122 APP_OPTIONS_ADD_SEGMENT_SIZE,
123 APP_OPTIONS_PRIVATE_SEGMENT_COUNT,
124 APP_OPTIONS_RX_FIFO_SIZE,
125 APP_OPTIONS_TX_FIFO_SIZE,
126 APP_OPTIONS_PREALLOC_FIFO_PAIRS,
127 APP_OPTIONS_NAMESPACE,
128 APP_OPTIONS_NAMESPACE_SECRET,
129 APP_OPTIONS_PROXY_TRANSPORT,
130 APP_OPTIONS_ACCEPT_COOKIE,
131 APP_OPTIONS_TLS_ENGINE,
132 APP_OPTIONS_N_OPTIONS
133 } app_attach_options_index_t;
135 #define foreach_app_options_flags \
136 _(ACCEPT_REDIRECT, "Use FIFO with redirects") \
137 _(ADD_SEGMENT, "Add segment and signal app if needed") \
138 _(IS_BUILTIN, "Application is builtin") \
139 _(IS_PROXY, "Application is proxying") \
140 _(USE_GLOBAL_SCOPE, "App can use global session scope") \
141 _(USE_LOCAL_SCOPE, "App can use local session scope")
143 typedef enum _app_options
145 #define _(sym, str) APP_OPTIONS_##sym,
146 foreach_app_options_flags
150 typedef enum _app_options_flags
152 #define _(sym, str) APP_OPTIONS_FLAGS_##sym = 1 << APP_OPTIONS_##sym,
153 foreach_app_options_flags
155 } app_options_flags_t;
157 int vnet_bind_uri (vnet_bind_args_t *);
158 int vnet_unbind_uri (vnet_unbind_args_t * a);
159 clib_error_t *vnet_connect_uri (vnet_connect_args_t * a);
161 clib_error_t *vnet_application_attach (vnet_app_attach_args_t * a);
162 clib_error_t *vnet_bind (vnet_bind_args_t * a);
163 clib_error_t *vnet_connect (vnet_connect_args_t * a);
164 clib_error_t *vnet_unbind (vnet_unbind_args_t * a);
165 int vnet_application_detach (vnet_app_detach_args_t * a);
166 int vnet_disconnect_session (vnet_disconnect_args_t * a);
168 clib_error_t *vnet_app_add_tls_cert (vnet_app_add_tls_cert_args_t * a);
169 clib_error_t *vnet_app_add_tls_key (vnet_app_add_tls_key_args_t * a);
171 extern const char test_srv_crt_rsa[];
172 extern const u32 test_srv_crt_rsa_len;
173 extern const char test_srv_key_rsa[];
174 extern const u32 test_srv_key_rsa_len;
176 typedef struct app_session_transport_
178 ip46_address_t rmt_ip; /**< remote ip */
179 ip46_address_t lcl_ip; /**< local ip */
180 u16 rmt_port; /**< remote port */
181 u16 lcl_port; /**< local port */
182 u8 is_ip4; /**< set if uses ip4 networking */
183 } app_session_transport_t;
185 typedef struct app_session_
187 svm_fifo_t *rx_fifo; /**< rx fifo */
188 svm_fifo_t *tx_fifo; /**< tx fifo */
189 session_type_t session_type; /**< session type */
190 volatile u8 session_state; /**< session state */
191 u32 session_index; /**< index in owning pool */
192 app_session_transport_t transport; /**< transport info */
193 svm_queue_t *vpp_evt_q; /**< vpp event queue for session */
194 u8 is_dgram; /**< set if it works in dgram mode */
198 app_send_dgram_raw (svm_fifo_t * f, app_session_transport_t * at,
199 svm_queue_t * vpp_evt_q, u8 * data, u32 len, u8 noblock)
201 u32 max_enqueue, actual_write;
202 session_dgram_hdr_t hdr;
203 session_fifo_event_t evt;
206 max_enqueue = svm_fifo_max_enqueue (f);
207 if (max_enqueue <= sizeof (session_dgram_hdr_t))
210 max_enqueue -= sizeof (session_dgram_hdr_t);
211 actual_write = clib_min (len, max_enqueue);
212 hdr.data_length = actual_write;
214 clib_memcpy (&hdr.rmt_ip, &at->rmt_ip, sizeof (ip46_address_t));
215 hdr.is_ip4 = at->is_ip4;
216 hdr.rmt_port = at->rmt_port;
217 clib_memcpy (&hdr.lcl_ip, &at->lcl_ip, sizeof (ip46_address_t));
218 hdr.lcl_port = at->lcl_port;
219 rv = svm_fifo_enqueue_nowait (f, sizeof (hdr), (u8 *) & hdr);
220 ASSERT (rv == sizeof (hdr));
222 if ((rv = svm_fifo_enqueue_nowait (f, actual_write, data)) > 0)
224 if (svm_fifo_set_event (f))
227 evt.event_type = FIFO_EVENT_APP_TX;
228 svm_queue_add (vpp_evt_q, (u8 *) & evt, noblock);
236 app_send_dgram (app_session_t * s, u8 * data, u32 len, u8 noblock)
238 return app_send_dgram_raw (s->tx_fifo, &s->transport, s->vpp_evt_q, data,
243 app_send_stream_raw (svm_fifo_t * f, svm_queue_t * vpp_evt_q, u8 * data,
246 session_fifo_event_t evt;
249 if ((rv = svm_fifo_enqueue_nowait (f, len, data)) > 0)
251 if (svm_fifo_set_event (f))
254 evt.event_type = FIFO_EVENT_APP_TX;
255 svm_queue_add (vpp_evt_q, (u8 *) & evt, noblock);
262 app_send_stream (app_session_t * s, u8 * data, u32 len, u8 noblock)
264 return app_send_stream_raw (s->tx_fifo, s->vpp_evt_q, data, len, noblock);
268 app_send (app_session_t * s, u8 * data, u32 len, u8 noblock)
271 return app_send_dgram (s, data, len, noblock);
272 return app_send_stream (s, data, len, noblock);
276 app_recv_dgram_raw (svm_fifo_t * f, u8 * buf, u32 len,
277 app_session_transport_t * at, u8 clear_evt)
279 session_dgram_pre_hdr_t ph;
284 svm_fifo_unset_event (f);
285 max_deq = svm_fifo_max_dequeue (f);
286 if (max_deq < sizeof (session_dgram_hdr_t))
289 svm_fifo_peek (f, 0, sizeof (ph), (u8 *) & ph);
290 ASSERT (ph.data_length >= ph.data_offset);
292 svm_fifo_peek (f, sizeof (ph), sizeof (*at), (u8 *) at);
293 len = clib_min (len, ph.data_length - ph.data_offset);
294 rv = svm_fifo_peek (f, ph.data_offset + SESSION_CONN_HDR_LEN, len, buf);
295 ph.data_offset += rv;
296 if (ph.data_offset == ph.data_length)
297 svm_fifo_dequeue_drop (f, ph.data_length + SESSION_CONN_HDR_LEN);
299 svm_fifo_overwrite_head (f, (u8 *) & ph, sizeof (ph));
304 app_recv_dgram (app_session_t * s, u8 * buf, u32 len)
306 return app_recv_dgram_raw (s->rx_fifo, buf, len, &s->transport, 1);
310 app_recv_stream_raw (svm_fifo_t * f, u8 * buf, u32 len, u8 clear_evt)
313 svm_fifo_unset_event (f);
314 return svm_fifo_dequeue_nowait (f, len, buf);
318 app_recv_stream (app_session_t * s, u8 * buf, u32 len)
320 return app_recv_stream_raw (s->rx_fifo, buf, len, 1);
324 app_recv (app_session_t * s, u8 * data, u32 len)
327 return app_recv_dgram (s, data, len);
328 return app_recv_stream (s, data, len);
331 #endif /* __included_uri_h__ */
334 * fd.io coding-style-patch-verification: ON
337 * eval: (c-set-style "gnu")