FD.io VPP  v18.10-34-gcce845e
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 #define _(_type, _name) _type _name;
28 #undef _
29  ssvm_private_t * segment;
30  svm_msg_q_t *app_evt_q;
32 
33 typedef struct _vnet_app_detach_args_t
34 {
35  u32 app_index;
37 
38 typedef struct _vnet_bind_args_t
39 {
40  union
41  {
44  char *uri;
45  };
46 
47  u32 app_index;
48  u32 wrk_map_index;
49 
50  /*
51  * Results
52  */
53  char *segment_name;
54  u32 segment_name_length;
55  u64 server_event_queue_address;
56  u64 handle;
58 
59 typedef struct _vnet_unbind_args_t
60 {
61  union
62  {
63  char *uri;
64  u64 handle; /**< Session handle */
65  };
66  u32 app_index; /**< Owning application index */
67  u32 wrk_map_index; /**< App's local pool worker index */
69 
70 typedef struct _vnet_connect_args
71 {
72  union
73  {
76  char *uri;
77  };
78  u32 app_index;
79  u32 wrk_map_index;
80  u32 api_context;
81 
84 
85 typedef struct _vnet_disconnect_args_t
86 {
87  session_handle_t handle;
88  u32 app_index;
90 
91 typedef struct _vnet_application_add_tls_cert_args_t
92 {
93  u32 app_index;
94  u8 *cert;
96 
97 typedef struct _vnet_application_add_tls_key_args_t
98 {
99  u32 app_index;
100  u8 *key;
102 
103 /* Application attach options */
104 typedef enum
105 {
121 
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") \
132 
133 typedef enum _app_options
134 {
135 #define _(sym, str) APP_OPTIONS_##sym,
137 #undef _
138 } app_options_t;
139 
140 typedef enum _app_options_flags
141 {
142 #define _(sym, str) APP_OPTIONS_FLAGS_##sym = 1 << APP_OPTIONS_##sym,
144 #undef _
146 
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") \
152 
153 typedef enum session_fd_type_
154 {
155 #define _(sym, str) SESSION_FD_##sym,
157 #undef _
160 
161 typedef enum session_fd_flag_
162 {
163 #define _(sym, str) SESSION_FD_F_##sym = 1 << SESSION_FD_##sym,
165 #undef _
167 
171 
178 
181 
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;
186 
188 {
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 */
195 
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 */ \
205 
206 typedef struct
207 {
208 #define _(type, name) type name;
210 #undef _
211 } app_session_t;
212 
213 typedef struct session_bound_msg_
214 {
215  u32 context;
216  u64 handle;
217  i32 retval;
218  u8 lcl_is_ip4;
219  u8 lcl_ip[16];
220  u16 lcl_port;
221  u64 rx_fifo;
222  u64 tx_fifo;
223  u64 vpp_evt_q;
224  u32 segment_size;
225  u8 segment_name_length;
226  u8 segment_name[128];
227 } __clib_packed session_bound_msg_t;
228 
229 typedef struct session_accepted_msg_
230 {
231  u32 context;
232  u64 listener_handle;
233  u64 handle;
234  u64 server_rx_fifo;
235  u64 server_tx_fifo;
236  u64 vpp_event_queue_address;
237  u64 server_event_queue_address;
238  u64 client_event_queue_address;
239  u16 port;
240  u8 is_ip4;
241  u8 ip[16];
242 } __clib_packed session_accepted_msg_t;
243 
244 typedef struct session_accepted_reply_msg_
245 {
246  u32 context;
247  i32 retval;
248  u64 handle;
250 
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");
254 
255 typedef struct session_connected_msg_
256 {
257  u32 context;
258  i32 retval;
259  u64 handle;
260  u64 server_rx_fifo;
261  u64 server_tx_fifo;
262  u64 vpp_event_queue_address;
263  u64 client_event_queue_address;
264  u64 server_event_queue_address;
265  u32 segment_size;
266  u8 segment_name_length;
267  u8 segment_name[64];
268  u8 lcl_ip[16];
269  u8 is_ip4;
270  u16 lcl_port;
271 } __clib_packed session_connected_msg_t;
272 
273 typedef struct session_disconnected_msg_
274 {
275  u32 client_index;
276  u32 context;
277  u64 handle;
279 
280 typedef struct session_disconnected_reply_msg_
281 {
282  u32 context;
283  i32 retval;
284  u64 handle;
286 
287 typedef struct session_reset_msg_
288 {
289  u32 client_index;
290  u32 context;
291  u64 handle;
292 } __clib_packed session_reset_msg_t;
293 
294 typedef struct session_reset_reply_msg_
295 {
296  u32 client_index;
297  u32 context;
298  i32 retval;
299  u64 handle;
301 
302 typedef struct app_session_event_
303 {
304  svm_msg_q_msg_t msg;
305  session_event_t *evt;
306 } __clib_packed app_session_evt_t;
307 
308 static inline void
309 app_alloc_ctrl_evt_to_vpp (svm_msg_q_t * mq, app_session_evt_t * app_evt,
310  u8 evt_type)
311 {
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;
319 }
320 
321 static inline void
322 app_send_ctrl_evt_to_vpp (svm_msg_q_t * mq, app_session_evt_t * app_evt)
323 {
324  svm_msg_q_add (mq, &app_evt->msg, SVM_Q_WAIT);
325 }
326 
327 /**
328  * Send fifo io event to vpp worker thread
329  *
330  * Because there may be multiple writers to one of vpp's queues, this
331  * protects message allocation and enqueueing.
332  *
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
338  */
339 static inline int
340 app_send_io_evt_to_vpp (svm_msg_q_t * mq, svm_fifo_t * f, u8 evt_type,
341  u8 noblock)
342 {
343  session_event_t *evt;
344  svm_msg_q_msg_t msg;
345 
346  if (noblock)
347  {
348  if (svm_msg_q_try_lock (mq))
349  return -1;
351  {
352  svm_msg_q_unlock (mq);
353  return -2;
354  }
357  {
358  svm_msg_q_unlock (mq);
359  return -2;
360  }
361  evt = (session_event_t *) svm_msg_q_msg_data (mq, &msg);
362  evt->fifo = f;
363  evt->event_type = evt_type;
364  svm_msg_q_add_and_unlock (mq, &msg);
365  return 0;
366  }
367  else
368  {
369  svm_msg_q_lock (mq);
371  svm_msg_q_wait (mq);
373  evt = (session_event_t *) svm_msg_q_msg_data (mq, &msg);
374  evt->fifo = f;
375  evt->event_type = evt_type;
376  if (svm_msg_q_is_full (mq))
377  svm_msg_q_wait (mq);
378  svm_msg_q_add_and_unlock (mq, &msg);
379  return 0;
380  }
381 }
382 
383 always_inline int
385  svm_msg_q_t * vpp_evt_q, u8 * data, u32 len, u8 evt_type,
386  u8 noblock)
387 {
388  u32 max_enqueue, actual_write;
389  session_dgram_hdr_t hdr;
390  int rv;
391 
392  max_enqueue = svm_fifo_max_enqueue (f);
393  if (max_enqueue <= sizeof (session_dgram_hdr_t))
394  return 0;
395 
396  max_enqueue -= sizeof (session_dgram_hdr_t);
397  actual_write = clib_min (len, max_enqueue);
398  hdr.data_length = actual_write;
399  hdr.data_offset = 0;
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));
407 
408  if ((rv = svm_fifo_enqueue_nowait (f, actual_write, data)) > 0)
409  {
410  if (svm_fifo_set_event (f))
411  app_send_io_evt_to_vpp (vpp_evt_q, f, evt_type, noblock);
412  }
413  ASSERT (rv);
414  return rv;
415 }
416 
417 always_inline int
418 app_send_dgram (app_session_t * s, u8 * data, u32 len, u8 noblock)
419 {
420  return app_send_dgram_raw (s->tx_fifo, &s->transport, s->vpp_evt_q, data,
421  len, FIFO_EVENT_APP_TX, noblock);
422 }
423 
424 always_inline int
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)
427 {
428  int rv;
429 
430  if ((rv = svm_fifo_enqueue_nowait (f, len, data)) > 0)
431  {
432  if (svm_fifo_set_event (f))
433  app_send_io_evt_to_vpp (vpp_evt_q, f, evt_type, noblock);
434  }
435  return rv;
436 }
437 
438 always_inline int
439 app_send_stream (app_session_t * s, u8 * data, u32 len, u8 noblock)
440 {
441  return app_send_stream_raw (s->tx_fifo, s->vpp_evt_q, data, len,
442  FIFO_EVENT_APP_TX, noblock);
443 }
444 
445 always_inline int
446 app_send (app_session_t * s, u8 * data, u32 len, u8 noblock)
447 {
448  if (s->is_dgram)
449  return app_send_dgram (s, data, len, noblock);
450  return app_send_stream (s, data, len, noblock);
451 }
452 
453 always_inline int
454 app_recv_dgram_raw (svm_fifo_t * f, u8 * buf, u32 len,
455  app_session_transport_t * at, u8 clear_evt, u8 peek)
456 {
458  u32 max_deq;
459  int rv;
460 
461  max_deq = svm_fifo_max_dequeue (f);
462  if (max_deq < sizeof (session_dgram_hdr_t))
463  {
464  if (clear_evt)
466  return 0;
467  }
468 
469  if (clear_evt)
471 
472  svm_fifo_peek (f, 0, sizeof (ph), (u8 *) & ph);
473  ASSERT (ph.data_length >= ph.data_offset);
474  if (!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);
478  if (peek)
479  return rv;
480  ph.data_offset += rv;
481  if (ph.data_offset == ph.data_length)
483  else
484  svm_fifo_overwrite_head (f, (u8 *) & ph, sizeof (ph));
485  return rv;
486 }
487 
488 always_inline int
489 app_recv_dgram (app_session_t * s, u8 * buf, u32 len)
490 {
491  return app_recv_dgram_raw (s->rx_fifo, buf, len, &s->transport, 1, 0);
492 }
493 
494 always_inline int
495 app_recv_stream_raw (svm_fifo_t * f, u8 * buf, u32 len, u8 clear_evt, u8 peek)
496 {
497  if (clear_evt)
499 
500  if (peek)
501  return svm_fifo_peek (f, 0, len, buf);
502 
503  return svm_fifo_dequeue_nowait (f, len, buf);
504 }
505 
506 always_inline int
507 app_recv_stream (app_session_t * s, u8 * buf, u32 len)
508 {
509  return app_recv_stream_raw (s->rx_fifo, buf, len, 1, 0);
510 }
511 
512 always_inline int
513 app_recv (app_session_t * s, u8 * data, u32 len)
514 {
515  if (s->is_dgram)
516  return app_recv_dgram (s, data, len);
517  return app_recv_stream (s, data, len);
518 }
519 
520 #endif /* __included_uri_h__ */
521 
522 /*
523  * fd.io coding-style-patch-verification: ON
524  *
525  * Local Variables:
526  * eval: (c-set-style "gnu")
527  * End:
528  */
#define foreach_app_session_field
flag for dgram mode
static int app_recv_stream_raw(svm_fifo_t *f, u8 *buf, u32 len, u8 clear_evt, u8 peek)
clib_error_t * vnet_connect_uri(vnet_connect_args_t *a)
struct app_session_event_ app_session_evt_t
static u8 svm_msg_q_msg_is_invalid(svm_msg_q_msg_t *msg)
Check if message is invalid.
void * svm_msg_q_msg_data(svm_msg_q_t *mq, svm_msg_q_msg_t *msg)
Get data for message in queue.
static u8 svm_msg_q_ring_is_full(svm_msg_q_t *mq, u32 ring_index)
#define clib_min(x, y)
Definition: clib.h:291
struct session_accepted_msg_ session_accepted_msg_t
u8 is_ip4
set if uses ip4 networking
a
Definition: bitmap.h:538
#define SESSION_CONN_HDR_LEN
Definition: session.h:149
struct _vnet_connect_args vnet_connect_args_t
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:599
static u32 svm_fifo_max_enqueue(svm_fifo_t *f)
Definition: svm_fifo.h:132
static int app_send_io_evt_to_vpp(svm_msg_q_t *mq, svm_fifo_t *f, u8 evt_type, u8 noblock)
Send fifo io event to vpp worker thread.
struct session_disconnected_reply_msg_ session_disconnected_reply_msg_t
u64 session_handle_t
Definition: session.h:107
struct session_reset_msg_ session_reset_msg_t
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)
int svm_msg_q_lock_and_alloc_msg_w_ring(svm_msg_q_t *mq, u32 ring_index, u8 noblock, svm_msg_q_msg_t *msg)
Lock message queue and allocate message buffer on ring.
struct session_reset_reply_msg_ session_reset_reply_msg_t
struct session_accepted_reply_msg_ session_accepted_reply_msg_t
memset(h->entries, 0, sizeof(h->entries[0])*entries)
static void app_alloc_ctrl_evt_to_vpp(svm_msg_q_t *mq, app_session_evt_t *app_evt, u8 evt_type)
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:94
static u32 svm_fifo_max_dequeue(svm_fifo_t *f)
Definition: svm_fifo.h:114
enum session_fd_type_ session_fd_type_t
struct _vnet_unbind_args_t vnet_unbind_args_t
#define foreach_fd_type
int svm_fifo_enqueue_nowait(svm_fifo_t *f, u32 max_bytes, const u8 *copy_from_here)
Definition: svm_fifo.c:523
static int app_send_stream_raw(svm_fifo_t *f, svm_msg_q_t *vpp_evt_q, u8 *data, u32 len, u8 evt_type, u8 noblock)
unsigned int u32
Definition: types.h:88
STATIC_ASSERT(sizeof(session_accepted_reply_msg_t)<=16,"accept reply")
static int app_recv_dgram_raw(svm_fifo_t *f, u8 *buf, u32 len, app_session_transport_t *at, u8 clear_evt, u8 peek)
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:1899
static int app_recv(app_session_t *s, u8 *data, u32 len)
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:334
#define PREDICT_FALSE(x)
Definition: clib.h:107
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:170
static void svm_msg_q_wait(svm_msg_q_t *mq)
Wait for message queue event.
struct session_connected_msg_ session_connected_msg_t
int vnet_bind_uri(vnet_bind_args_t *)
const u32 test_srv_key_rsa_len
enum session_fd_flag_ session_fd_flag_t
static void app_send_ctrl_evt_to_vpp(svm_msg_q_t *mq, app_session_evt_t *app_evt)
static u8 svm_fifo_set_event(svm_fifo_t *f)
Sets fifo event flag.
Definition: svm_fifo.h:157
static void svm_msg_q_unlock(svm_msg_q_t *mq)
Unlock message queue.
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_msg_q_t *vpp_evt_q, u8 *data, u32 len, u8 evt_type, u8 noblock)
#define clib_memcpy(a, b, c)
Definition: string.h:75
struct app_session_transport_ app_session_transport_t
int svm_msg_q_add(svm_msg_q_t *mq, svm_msg_q_msg_t *msg, int nowait)
Producer enqueue one message to queue.
blocking call - best used in combination with condvars, for eventfds we don&#39;t yield the cpu ...
Definition: queue.h:42
static int app_recv_stream(app_session_t *s, u8 *buf, u32 len)
static int svm_msg_q_try_lock(svm_msg_q_t *mq)
Try locking message queue.
enum _app_options_flags app_options_flags_t
const char test_srv_crt_rsa[]
signed int i32
Definition: types.h:77
clib_error_t * vnet_app_add_tls_cert(vnet_app_add_tls_cert_args_t *a)
Definition: application.c:1887
int vnet_disconnect_session(vnet_disconnect_args_t *a)
#define ASSERT(truth)
void svm_msg_q_add_and_unlock(svm_msg_q_t *mq, svm_msg_q_msg_t *msg)
Producer enqueue one message to queue with mutex held.
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
struct session_disconnected_msg_ session_disconnected_msg_t
int svm_fifo_dequeue_drop(svm_fifo_t *f, u32 max_bytes)
Definition: svm_fifo.c:726
struct session_bound_msg_ session_bound_msg_t
#define foreach_app_init_args
Definition: application.h:194
#define foreach_app_options_flags
static int svm_msg_q_lock(svm_msg_q_t *mq)
Lock, or block trying, the message queue.
int svm_fifo_peek(svm_fifo_t *f, u32 relative_offset, u32 max_bytes, u8 *copy_here)
Definition: svm_fifo.c:718
static u8 svm_msg_q_is_full(svm_msg_q_t *mq)
Check if message queue is full.
int svm_fifo_dequeue_nowait(svm_fifo_t *f, u32 max_bytes, u8 *copy_here)
Definition: svm_fifo.c:670
struct _vnet_bind_args_t vnet_bind_args_t
svm_msg_q_msg_t svm_msg_q_alloc_msg_w_ring(svm_msg_q_t *mq, u32 ring_index)
Allocate message buffer on ring.
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)