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 /** Binary API client index */
29 /** Application name. Used by builtin apps */
32 /** Application and segment manager options */
35 /** ID of the namespace the app has access to */
38 /** Session to application callback functions */
39 session_cb_vft_t *session_cb_vft;
44 ssvm_private_t *segment;
45 u64 app_event_queue_address;
47 } vnet_app_attach_args_t;
49 typedef struct _vnet_app_detach_args_t
52 } vnet_app_detach_args_t;
54 typedef struct _vnet_bind_args_t
59 session_endpoint_t sep;
68 u32 segment_name_length;
69 u64 server_event_queue_address;
73 typedef struct _vnet_unbind_args_t
83 typedef struct _vnet_connect_args
88 session_endpoint_extended_t sep;
93 session_handle_t session_handle;
94 } vnet_connect_args_t;
96 typedef struct _vnet_disconnect_args_t
98 session_handle_t handle;
100 } vnet_disconnect_args_t;
102 typedef struct _vnet_application_add_tls_cert_args_t
106 } vnet_app_add_tls_cert_args_t;
108 typedef struct _vnet_application_add_tls_key_args_t
112 } vnet_app_add_tls_key_args_t;
114 /* Application attach options */
118 APP_OPTIONS_EVT_QUEUE_SIZE,
119 APP_OPTIONS_SEGMENT_SIZE,
120 APP_OPTIONS_ADD_SEGMENT_SIZE,
121 APP_OPTIONS_PRIVATE_SEGMENT_COUNT,
122 APP_OPTIONS_RX_FIFO_SIZE,
123 APP_OPTIONS_TX_FIFO_SIZE,
124 APP_OPTIONS_PREALLOC_FIFO_PAIRS,
125 APP_OPTIONS_NAMESPACE,
126 APP_OPTIONS_NAMESPACE_SECRET,
127 APP_OPTIONS_PROXY_TRANSPORT,
128 APP_OPTIONS_ACCEPT_COOKIE,
129 APP_OPTIONS_TLS_ENGINE,
130 APP_OPTIONS_N_OPTIONS
131 } app_attach_options_index_t;
133 #define foreach_app_options_flags \
134 _(ACCEPT_REDIRECT, "Use FIFO with redirects") \
135 _(ADD_SEGMENT, "Add segment and signal app if needed") \
136 _(IS_BUILTIN, "Application is builtin") \
137 _(IS_PROXY, "Application is proxying") \
138 _(USE_GLOBAL_SCOPE, "App can use global session scope") \
139 _(USE_LOCAL_SCOPE, "App can use local session scope")
141 typedef enum _app_options
143 #define _(sym, str) APP_OPTIONS_##sym,
144 foreach_app_options_flags
148 typedef enum _app_options_flags
150 #define _(sym, str) APP_OPTIONS_FLAGS_##sym = 1 << APP_OPTIONS_##sym,
151 foreach_app_options_flags
153 } app_options_flags_t;
155 int vnet_bind_uri (vnet_bind_args_t *);
156 int vnet_unbind_uri (vnet_unbind_args_t * a);
157 clib_error_t *vnet_connect_uri (vnet_connect_args_t * a);
159 clib_error_t *vnet_application_attach (vnet_app_attach_args_t * a);
160 clib_error_t *vnet_bind (vnet_bind_args_t * a);
161 clib_error_t *vnet_connect (vnet_connect_args_t * a);
162 clib_error_t *vnet_unbind (vnet_unbind_args_t * a);
163 int vnet_application_detach (vnet_app_detach_args_t * a);
164 int vnet_disconnect_session (vnet_disconnect_args_t * a);
166 clib_error_t *vnet_app_add_tls_cert (vnet_app_add_tls_cert_args_t * a);
167 clib_error_t *vnet_app_add_tls_key (vnet_app_add_tls_key_args_t * a);
169 extern const char test_srv_crt_rsa[];
170 extern const u32 test_srv_crt_rsa_len;
171 extern const char test_srv_key_rsa[];
172 extern const u32 test_srv_key_rsa_len;
174 typedef struct app_session_transport_
176 ip46_address_t rmt_ip; /**< remote ip */
177 ip46_address_t lcl_ip; /**< local ip */
178 u16 rmt_port; /**< remote port (network order) */
179 u16 lcl_port; /**< local port (network order) */
180 u8 is_ip4; /**< set if uses ip4 networking */
181 } app_session_transport_t;
183 #define foreach_app_session_field \
184 _(svm_fifo_t, *rx_fifo) /**< rx fifo */ \
185 _(svm_fifo_t, *tx_fifo) /**< tx fifo */ \
186 _(session_type_t, session_type) /**< session type */ \
187 _(volatile u8, session_state) /**< session state */ \
188 _(u32, session_index) /**< index in owning pool */ \
189 _(app_session_transport_t, transport) /**< transport info */ \
190 _(svm_queue_t, *vpp_evt_q) /**< vpp event queue */ \
191 _(u8, is_dgram) /**< flag for dgram mode */ \
195 #define _(type, name) type name;
196 foreach_app_session_field
201 app_send_dgram_raw (svm_fifo_t * f, app_session_transport_t * at,
202 svm_queue_t * vpp_evt_q, u8 * data, u32 len, u8 noblock)
204 u32 max_enqueue, actual_write;
205 session_dgram_hdr_t hdr;
206 session_fifo_event_t evt;
209 max_enqueue = svm_fifo_max_enqueue (f);
210 if (max_enqueue <= sizeof (session_dgram_hdr_t))
213 max_enqueue -= sizeof (session_dgram_hdr_t);
214 actual_write = clib_min (len, max_enqueue);
215 hdr.data_length = actual_write;
217 clib_memcpy (&hdr.rmt_ip, &at->rmt_ip, sizeof (ip46_address_t));
218 hdr.is_ip4 = at->is_ip4;
219 hdr.rmt_port = at->rmt_port;
220 clib_memcpy (&hdr.lcl_ip, &at->lcl_ip, sizeof (ip46_address_t));
221 hdr.lcl_port = at->lcl_port;
222 rv = svm_fifo_enqueue_nowait (f, sizeof (hdr), (u8 *) & hdr);
223 ASSERT (rv == sizeof (hdr));
225 if ((rv = svm_fifo_enqueue_nowait (f, actual_write, data)) > 0)
227 if (svm_fifo_set_event (f))
230 evt.event_type = FIFO_EVENT_APP_TX;
231 svm_queue_add (vpp_evt_q, (u8 *) & evt, noblock);
239 app_send_dgram (app_session_t * s, u8 * data, u32 len, u8 noblock)
241 return app_send_dgram_raw (s->tx_fifo, &s->transport, s->vpp_evt_q, data,
246 app_send_stream_raw (svm_fifo_t * f, svm_queue_t * vpp_evt_q, u8 * data,
249 session_fifo_event_t evt;
252 if ((rv = svm_fifo_enqueue_nowait (f, len, data)) > 0)
254 if (svm_fifo_set_event (f))
257 evt.event_type = FIFO_EVENT_APP_TX;
258 svm_queue_add (vpp_evt_q, (u8 *) & evt, noblock);
265 app_send_stream (app_session_t * s, u8 * data, u32 len, u8 noblock)
267 return app_send_stream_raw (s->tx_fifo, s->vpp_evt_q, data, len, noblock);
271 app_send (app_session_t * s, u8 * data, u32 len, u8 noblock)
274 return app_send_dgram (s, data, len, noblock);
275 return app_send_stream (s, data, len, noblock);
279 app_recv_dgram_raw (svm_fifo_t * f, u8 * buf, u32 len,
280 app_session_transport_t * at, u8 clear_evt)
282 session_dgram_pre_hdr_t ph;
287 svm_fifo_unset_event (f);
288 max_deq = svm_fifo_max_dequeue (f);
289 if (max_deq < sizeof (session_dgram_hdr_t))
292 svm_fifo_peek (f, 0, sizeof (ph), (u8 *) & ph);
293 ASSERT (ph.data_length >= ph.data_offset);
295 svm_fifo_peek (f, sizeof (ph), sizeof (*at), (u8 *) at);
296 len = clib_min (len, ph.data_length - ph.data_offset);
297 rv = svm_fifo_peek (f, ph.data_offset + SESSION_CONN_HDR_LEN, len, buf);
298 ph.data_offset += rv;
299 if (ph.data_offset == ph.data_length)
300 svm_fifo_dequeue_drop (f, ph.data_length + SESSION_CONN_HDR_LEN);
302 svm_fifo_overwrite_head (f, (u8 *) & ph, sizeof (ph));
307 app_recv_dgram (app_session_t * s, u8 * buf, u32 len)
309 return app_recv_dgram_raw (s->rx_fifo, buf, len, &s->transport, 1);
313 app_recv_stream_raw (svm_fifo_t * f, u8 * buf, u32 len, u8 clear_evt)
316 svm_fifo_unset_event (f);
317 return svm_fifo_dequeue_nowait (f, len, buf);
321 app_recv_stream (app_session_t * s, u8 * buf, u32 len)
323 return app_recv_stream_raw (s->rx_fifo, buf, len, 1);
327 app_recv (app_session_t * s, u8 * data, u32 len)
330 return app_recv_dgram (s, data, len);
331 return app_recv_stream (s, data, len);
334 #endif /* __included_uri_h__ */
337 * fd.io coding-style-patch-verification: ON
340 * eval: (c-set-style "gnu")