FD.io VPP  v18.07-34-g55fbdb9
Vector Packet Processing
application_interface.h
Go to the documentation of this file.
1 /*
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:
6  *
7  * http://www.apache.org/licenses/LICENSE-2.0
8  *
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.
14  */
15 #ifndef __included_uri_h__
16 #define __included_uri_h__
17 
18 #include <svm/svm_fifo_segment.h>
19 #include <vnet/session/session.h>
21 #include <vnet/session/transport.h>
22 #include <vnet/tls/tls.h>
23 
24 typedef struct _vnet_app_attach_args_t
25 {
26  /** Binary API client index */
27  u32 api_client_index;
28 
29  /** Application name. Used by builtin apps */
30  u8 *name;
31 
32  /** Application and segment manager options */
33  u64 *options;
34 
35  /** ID of the namespace the app has access to */
36  u8 *namespace_id;
37 
38  /** Session to application callback functions */
40 
41  /*
42  * Results
43  */
44  ssvm_private_t *segment;
45  u64 app_event_queue_address;
46  u32 app_index;
48 
49 typedef struct _vnet_app_detach_args_t
50 {
51  u32 app_index;
53 
54 typedef struct _vnet_bind_args_t
55 {
56  union
57  {
58  char *uri;
60  };
61 
62  u32 app_index;
63 
64  /*
65  * Results
66  */
67  char *segment_name;
68  u32 segment_name_length;
69  u64 server_event_queue_address;
70  u64 handle;
72 
73 typedef struct _vnet_unbind_args_t
74 {
75  union
76  {
77  char *uri;
78  u64 handle;
79  };
80  u32 app_index;
82 
83 typedef struct _vnet_connect_args
84 {
85  union
86  {
87  char *uri;
89  };
90  u32 app_index;
91  u32 api_context;
92 
95 
96 typedef struct _vnet_disconnect_args_t
97 {
98  session_handle_t handle;
99  u32 app_index;
101 
102 typedef struct _vnet_application_add_tls_cert_args_t
103 {
104  u32 app_index;
105  u8 *cert;
107 
108 typedef struct _vnet_application_add_tls_key_args_t
109 {
110  u32 app_index;
111  u8 *key;
113 
114 /* Application attach options */
115 typedef enum
116 {
132 
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")
140 
141 typedef enum _app_options
142 {
143 #define _(sym, str) APP_OPTIONS_##sym,
145 #undef _
146 } app_options_t;
147 
148 typedef enum _app_options_flags
149 {
150 #define _(sym, str) APP_OPTIONS_FLAGS_##sym = 1 << APP_OPTIONS_##sym,
152 #undef _
154 
158 
165 
168 
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;
173 
175 {
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 */
182 
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 */ \
192 
193 typedef struct
194 {
195 #define _(type, name) type name;
197 #undef _
198 } app_session_t;
199 
200 always_inline int
202  svm_queue_t * vpp_evt_q, u8 * data, u32 len, u8 noblock)
203 {
204  u32 max_enqueue, actual_write;
205  session_dgram_hdr_t hdr;
206  session_fifo_event_t evt;
207  int rv;
208 
209  max_enqueue = svm_fifo_max_enqueue (f);
210  if (max_enqueue <= sizeof (session_dgram_hdr_t))
211  return 0;
212 
213  max_enqueue -= sizeof (session_dgram_hdr_t);
214  actual_write = clib_min (len, max_enqueue);
215  hdr.data_length = actual_write;
216  hdr.data_offset = 0;
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));
224 
225  if ((rv = svm_fifo_enqueue_nowait (f, actual_write, data)) > 0)
226  {
227  if (svm_fifo_set_event (f))
228  {
229  evt.fifo = f;
230  evt.event_type = FIFO_EVENT_APP_TX;
231  svm_queue_add (vpp_evt_q, (u8 *) & evt, noblock);
232  }
233  }
234  ASSERT (rv);
235  return rv;
236 }
237 
238 always_inline int
239 app_send_dgram (app_session_t * s, u8 * data, u32 len, u8 noblock)
240 {
241  return app_send_dgram_raw (s->tx_fifo, &s->transport, s->vpp_evt_q, data,
242  len, noblock);
243 }
244 
245 always_inline int
246 app_send_stream_raw (svm_fifo_t * f, svm_queue_t * vpp_evt_q, u8 * data,
247  u32 len, u8 noblock)
248 {
249  session_fifo_event_t evt;
250  int rv;
251 
252  if ((rv = svm_fifo_enqueue_nowait (f, len, data)) > 0)
253  {
254  if (svm_fifo_set_event (f))
255  {
256  evt.fifo = f;
257  evt.event_type = FIFO_EVENT_APP_TX;
258  svm_queue_add (vpp_evt_q, (u8 *) & evt, noblock);
259  }
260  }
261  return rv;
262 }
263 
264 always_inline int
265 app_send_stream (app_session_t * s, u8 * data, u32 len, u8 noblock)
266 {
267  return app_send_stream_raw (s->tx_fifo, s->vpp_evt_q, data, len, noblock);
268 }
269 
270 always_inline int
271 app_send (app_session_t * s, u8 * data, u32 len, u8 noblock)
272 {
273  if (s->is_dgram)
274  return app_send_dgram (s, data, len, noblock);
275  return app_send_stream (s, data, len, noblock);
276 }
277 
278 always_inline int
279 app_recv_dgram_raw (svm_fifo_t * f, u8 * buf, u32 len,
280  app_session_transport_t * at, u8 clear_evt)
281 {
283  u32 max_deq;
284  int rv;
285 
286  if (clear_evt)
288  max_deq = svm_fifo_max_dequeue (f);
289  if (max_deq < sizeof (session_dgram_hdr_t))
290  return 0;
291 
292  svm_fifo_peek (f, 0, sizeof (ph), (u8 *) & ph);
293  ASSERT (ph.data_length >= ph.data_offset);
294  if (!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)
301  else
302  svm_fifo_overwrite_head (f, (u8 *) & ph, sizeof (ph));
303  return rv;
304 }
305 
306 always_inline int
307 app_recv_dgram (app_session_t * s, u8 * buf, u32 len)
308 {
309  return app_recv_dgram_raw (s->rx_fifo, buf, len, &s->transport, 1);
310 }
311 
312 always_inline int
313 app_recv_stream_raw (svm_fifo_t * f, u8 * buf, u32 len, u8 clear_evt)
314 {
315  if (clear_evt)
317  return svm_fifo_dequeue_nowait (f, len, buf);
318 }
319 
320 always_inline int
321 app_recv_stream (app_session_t * s, u8 * buf, u32 len)
322 {
323  return app_recv_stream_raw (s->rx_fifo, buf, len, 1);
324 }
325 
326 always_inline int
327 app_recv (app_session_t * s, u8 * data, u32 len)
328 {
329  if (s->is_dgram)
330  return app_recv_dgram (s, data, len);
331  return app_recv_stream (s, data, len);
332 }
333 
334 #endif /* __included_uri_h__ */
335 
336 /*
337  * fd.io coding-style-patch-verification: ON
338  *
339  * Local Variables:
340  * eval: (c-set-style "gnu")
341  * End:
342  */
#define foreach_app_session_field
flag for dgram mode
clib_error_t * vnet_connect_uri(vnet_connect_args_t *a)
#define clib_min(x, y)
Definition: clib.h:289
int svm_queue_add(svm_queue_t *q, u8 *elem, int nowait)
Definition: queue.c:184
u8 is_ip4
set if uses ip4 networking
a
Definition: bitmap.h:538
#define SESSION_CONN_HDR_LEN
Definition: session.h:126
struct _vnet_connect_args vnet_connect_args_t
static int app_recv_dgram_raw(svm_fifo_t *f, u8 *buf, u32 len, app_session_transport_t *at, u8 clear_evt)
unsigned long u64
Definition: types.h:89
const char test_srv_key_rsa[]
const u32 test_srv_crt_rsa_len
clib_error_t * vnet_unbind(vnet_unbind_args_t *a)
static int app_send_stream(app_session_t *s, u8 *data, u32 len, u8 noblock)
void svm_fifo_overwrite_head(svm_fifo_t *f, u8 *data, u32 len)
Definition: svm_fifo.c:623
static u32 svm_fifo_max_enqueue(svm_fifo_t *f)
Definition: svm_fifo.h:111
u64 session_handle_t
Definition: session.h:91
struct _vnet_application_add_tls_cert_args_t vnet_app_add_tls_cert_args_t
unsigned char u8
Definition: types.h:56
struct _svm_fifo svm_fifo_t
clib_error_t * vnet_connect(vnet_connect_args_t *a)
static int app_send(app_session_t *s, u8 *data, u32 len, u8 noblock)
struct _vnet_disconnect_args_t vnet_disconnect_args_t
#define always_inline
Definition: clib.h:92
static u32 svm_fifo_max_dequeue(svm_fifo_t *f)
Definition: svm_fifo.h:105
struct _stream_session_cb_vft session_cb_vft_t
struct _vnet_unbind_args_t vnet_unbind_args_t
int svm_fifo_enqueue_nowait(svm_fifo_t *f, u32 max_bytes, const u8 *copy_from_here)
Definition: svm_fifo.c:538
unsigned int u32
Definition: types.h:88
struct _vnet_app_attach_args_t vnet_app_attach_args_t
clib_error_t * vnet_app_add_tls_key(vnet_app_add_tls_key_args_t *a)
Definition: application.c:1245
static int app_recv(app_session_t *s, u8 *data, u32 len)
static session_cb_vft_t session_cb_vft
Definition: session_api.c:357
int vnet_unbind_uri(vnet_unbind_args_t *a)
struct _session_endpoint session_endpoint_t
clib_error_t * vnet_bind(vnet_bind_args_t *a)
unsigned short u16
Definition: types.h:57
static session_handle_t session_handle(stream_session_t *s)
Definition: session.h:310
ip46_address_t rmt_ip
remote ip
static void svm_fifo_unset_event(svm_fifo_t *f)
Unsets fifo event flag.
Definition: svm_fifo.h:144
int vnet_bind_uri(vnet_bind_args_t *)
const u32 test_srv_key_rsa_len
static u8 svm_fifo_set_event(svm_fifo_t *f)
Sets fifo event flag.
Definition: svm_fifo.h:134
clib_error_t * vnet_application_attach(vnet_app_attach_args_t *a)
Attach application to vpp.
static int app_send_dgram_raw(svm_fifo_t *f, app_session_transport_t *at, svm_queue_t *vpp_evt_q, u8 *data, u32 len, u8 noblock)
#define clib_memcpy(a, b, c)
Definition: string.h:75
struct app_session_transport_ app_session_transport_t
static int app_recv_stream(app_session_t *s, u8 *buf, u32 len)
enum _app_options_flags app_options_flags_t
const char test_srv_crt_rsa[]
static int app_send_stream_raw(svm_fifo_t *f, svm_queue_t *vpp_evt_q, u8 *data, u32 len, u8 noblock)
clib_error_t * vnet_app_add_tls_cert(vnet_app_add_tls_cert_args_t *a)
Definition: application.c:1233
int vnet_disconnect_session(vnet_disconnect_args_t *a)
#define ASSERT(truth)
enum _app_options app_options_t
app_attach_options_index_t
static int app_send_dgram(app_session_t *s, u8 *data, u32 len, u8 noblock)
struct _vnet_application_add_tls_key_args_t vnet_app_add_tls_key_args_t
int vnet_application_detach(vnet_app_detach_args_t *a)
Detach application from vpp.
u16 lcl_port
local port (network order)
struct _vnet_app_detach_args_t vnet_app_detach_args_t
ip46_address_t lcl_ip
local ip
int svm_fifo_dequeue_drop(svm_fifo_t *f, u32 max_bytes)
Definition: svm_fifo.c:792
static int app_recv_stream_raw(svm_fifo_t *f, u8 *buf, u32 len, u8 clear_evt)
struct _svm_queue svm_queue_t
#define foreach_app_options_flags
int svm_fifo_peek(svm_fifo_t *f, u32 relative_offset, u32 max_bytes, u8 *copy_here)
Definition: svm_fifo.c:776
int svm_fifo_dequeue_nowait(svm_fifo_t *f, u32 max_bytes, u8 *copy_here)
Definition: svm_fifo.c:710
struct _vnet_bind_args_t vnet_bind_args_t
struct _session_endpoint_extended session_endpoint_extended_t
static int app_recv_dgram(app_session_t *s, u8 *buf, u32 len)
u16 rmt_port
remote port (network order)