FD.io VPP  v20.09-64-g4f7b92f0a
Vector Packet Processing
application_interface.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2016-2019 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 <vlibmemory/api.h>
19 #include <svm/message_queue.h>
21 #include <vnet/tls/tls_test.h>
22 #include <svm/fifo_segment.h>
23 
24 typedef struct certificate_
25 {
26  u32 *app_interests; /* vec of application index asking for deletion cb */
27  u32 cert_key_index; /* index in cert & key pool */
28  u8 *key;
29  u8 *cert;
31 
32 typedef struct session_cb_vft_
33 {
34  /** Notify server of new segment */
35  int (*add_segment_callback) (u32 app_wrk_index, u64 segment_handle);
36 
37  /** Notify server of new segment */
38  int (*del_segment_callback) (u32 app_wrk_index, u64 segment_handle);
39 
40  /** Notify server of newly accepted session */
41  int (*session_accept_callback) (session_t * new_session);
42 
43  /** Connection request callback */
44  int (*session_connected_callback) (u32 app_wrk_index, u32 opaque,
45  session_t * s, session_error_t code);
46 
47  /** Notify app that session is closing */
48  void (*session_disconnect_callback) (session_t * s);
49 
50  /** Notify app that transport is closed */
51  void (*session_transport_closed_callback) (session_t * s);
52 
53  /** Notify app that session or transport are about to be removed */
54  void (*session_cleanup_callback) (session_t * s, session_cleanup_ntf_t ntf);
55 
56  /** Notify app that session was reset */
57  void (*session_reset_callback) (session_t * s);
58 
59  /** Notify app that session pool migration happened */
60  void (*session_migrate_callback) (session_t * s, session_handle_t new_sh);
61 
62  /** Direct RX callback for built-in application */
63  int (*builtin_app_rx_callback) (session_t * session);
64 
65  /** Direct TX callback for built-in application */
66  int (*builtin_app_tx_callback) (session_t * session);
67 
68  /** Cert and key pair delete notification */
69  int (*app_cert_key_pair_delete_callback) (app_cert_key_pair_t * ckpair);
70 
71  /** Delegate fifo-tuning-logic to application */
72  int (*fifo_tuning_callback) (session_t * s, svm_fifo_t * f,
73  session_ft_action_t act, u32 bytes);
74 
76 
77 #define foreach_app_init_args \
78  _(u32, api_client_index) \
79  _(u8 *, name) \
80  _(u64 *, options) \
81  _(u8 *, namespace_id) \
82  _(session_cb_vft_t *, session_cb_vft) \
83  _(u32, app_index) \
84 
85 typedef struct _vnet_app_attach_args_t
86 {
87 #define _(_type, _name) _type _name;
89 #undef _
90  ssvm_private_t * segment;
91  svm_msg_q_t *app_evt_q;
92  u64 segment_handle;
94 
95 typedef struct _vnet_app_detach_args_t
96 {
97  u32 app_index;
98  u32 api_client_index;
100 
101 typedef struct _vnet_bind_args_t
102 {
103  union
104  {
105  session_endpoint_cfg_t sep_ext;
106  session_endpoint_t sep;
107  char *uri;
108  };
109 
110  u32 app_index;
111  u32 wrk_map_index;
112 
113  /*
114  * Results
115  */
116  char *segment_name;
117  u32 segment_name_length;
118  u64 server_event_queue_address;
119  u64 handle;
121 
122 typedef struct _vnet_unlisten_args_t
123 {
124  union
125  {
126  char *uri;
127  u64 handle; /**< Session handle */
128  };
129  u32 app_index; /**< Owning application index */
130  u32 wrk_map_index; /**< App's local pool worker index */
132 
133 typedef struct _vnet_connect_args
134 {
135  union
136  {
137  session_endpoint_cfg_t sep_ext;
138  session_endpoint_t sep;
139  char *uri;
140  };
141  u32 app_index;
142  u32 wrk_map_index;
143  u32 api_context;
144 
147 
148 typedef struct _vnet_disconnect_args_t
149 {
150  session_handle_t handle;
151  u32 app_index;
153 
154 typedef struct _vnet_application_add_tls_cert_args_t
155 {
156  u32 app_index;
157  u8 *cert;
159 
160 typedef struct _vnet_application_add_tls_key_args_t
161 {
162  u32 app_index;
163  u8 *key;
165 
167 {
175 
176 typedef struct _vnet_app_add_cert_key_pair_args_
177 {
178  u8 *cert;
179  u8 *key;
180  u32 index;
182 
183 typedef struct crypto_ctx_
184 {
185  u32 ctx_index; /**< index in crypto context pool */
186  u32 n_subscribers; /**< refcount of sessions using said context */
187  u32 ckpair_index; /**< certificate & key */
189  void *data; /**< protocol specific data */
191 
192 /* Application attach options */
193 typedef enum
194 {
215 
216 #define foreach_app_options_flags \
217  _(ACCEPT_REDIRECT, "Use FIFO with redirects") \
218  _(ADD_SEGMENT, "Add segment and signal app if needed") \
219  _(IS_BUILTIN, "Application is builtin") \
220  _(IS_TRANSPORT_APP, "Application is a transport proto") \
221  _(IS_PROXY, "Application is proxying") \
222  _(USE_GLOBAL_SCOPE, "App can use global session scope") \
223  _(USE_LOCAL_SCOPE, "App can use local session scope") \
224  _(EVT_MQ_USE_EVENTFD, "Use eventfds for signaling") \
225 
226 typedef enum _app_options
227 {
228 #define _(sym, str) APP_OPTIONS_##sym,
230 #undef _
231 } app_options_t;
232 
233 typedef enum _app_options_flags
234 {
235 #define _(sym, str) APP_OPTIONS_FLAGS_##sym = 1 << APP_OPTIONS_##sym,
237 #undef _
239 
240 #define foreach_fd_type \
241  _(VPP_MQ_SEGMENT, "Fd for vpp's event mq segment") \
242  _(MEMFD_SEGMENT, "Fd for memfd segment") \
243  _(MQ_EVENTFD, "Event fd used by message queue") \
244  _(VPP_MQ_EVENTFD, "Event fd used by vpp's message queue") \
245 
246 typedef enum session_fd_type_
247 {
248 #define _(sym, str) SESSION_FD_##sym,
250 #undef _
253 
254 typedef enum session_fd_flag_
255 {
256 #define _(sym, str) SESSION_FD_F_##sym = 1 << SESSION_FD_##sym,
258 #undef _
260 
261 int parse_uri (char *uri, session_endpoint_cfg_t * sep);
265 
272 
277 /** Ask for app cb on pair deletion */
279 
281 {
282  ip46_address_t rmt_ip; /**< remote ip */
283  ip46_address_t lcl_ip; /**< local ip */
284  u16 rmt_port; /**< remote port (network order) */
285  u16 lcl_port; /**< local port (network order) */
286  u8 is_ip4; /**< set if uses ip4 networking */
288 
289 #define foreach_app_session_field \
290  _(svm_fifo_t, *rx_fifo) /**< rx fifo */ \
291  _(svm_fifo_t, *tx_fifo) /**< tx fifo */ \
292  _(session_type_t, session_type) /**< session type */ \
293  _(volatile u8, session_state) /**< session state */ \
294  _(u32, session_index) /**< index in owning pool */ \
295  _(app_session_transport_t, transport) /**< transport info */ \
296  _(svm_msg_q_t, *vpp_evt_q) /**< vpp event queue */ \
297  _(u8, is_dgram) /**< flag for dgram mode */ \
298 
299 typedef struct
300 {
301 #define _(type, name) type name;
303 #undef _
304 } app_session_t;
305 
306 typedef struct session_listen_msg_
307 {
308  u32 client_index;
309  u32 context; /* Not needed but keeping it for compatibility with bapi */
310  u32 wrk_index;
311  u32 vrf;
314  u8 is_ip4;
315  ip46_address_t ip;
316  u32 ckpair_index;
317  u8 crypto_engine;
319 } __clib_packed session_listen_msg_t;
320 
322  "msg too large");
323 
324 typedef struct session_listen_uri_msg_
325 {
326  u32 client_index;
327  u32 context;
328  u8 uri[56];
329 } __clib_packed session_listen_uri_msg_t;
330 
331 STATIC_ASSERT (sizeof (session_listen_uri_msg_t) <= SESSION_CTRL_MSG_MAX_SIZE,
332  "msg too large");
333 
334 typedef struct session_bound_msg_
335 {
336  u32 context;
337  u64 handle;
338  i32 retval;
339  u8 lcl_is_ip4;
340  u8 lcl_ip[16];
341  u16 lcl_port;
342  uword rx_fifo;
343  uword tx_fifo;
344  uword vpp_evt_q;
345  u32 segment_size;
346  u8 segment_name_length;
347  u8 segment_name[128];
348 } __clib_packed session_bound_msg_t;
349 
350 typedef struct session_unlisten_msg_
351 {
352  u32 client_index;
353  u32 context;
354  u32 wrk_index;
356 } __clib_packed session_unlisten_msg_t;
357 
358 typedef struct session_unlisten_reply_msg_
359 {
360  u32 context;
361  u64 handle;
362  i32 retval;
364 
365 typedef struct session_accepted_msg_
366 {
367  u32 context;
368  u64 listener_handle;
369  u64 handle;
370  uword server_rx_fifo;
371  uword server_tx_fifo;
372  u64 segment_handle;
373  uword vpp_event_queue_address;
376 } __clib_packed session_accepted_msg_t;
377 
378 typedef struct session_accepted_reply_msg_
379 {
380  u32 context;
381  i32 retval;
382  u64 handle;
384 
385 typedef struct session_connect_msg_
386 {
387  u32 client_index;
388  u32 context;
389  u32 wrk_index;
390  u32 vrf;
392  u16 lcl_port;
394  u8 is_ip4;
395  ip46_address_t ip;
396  ip46_address_t lcl_ip;
397  u8 hostname_len;
399  u64 parent_handle;
400  u32 ckpair_index;
401  u8 crypto_engine;
403 } __clib_packed session_connect_msg_t;
404 
405 STATIC_ASSERT (sizeof (session_connect_msg_t) <= SESSION_CTRL_MSG_MAX_SIZE,
406  "msg too large");
407 
408 typedef struct session_connect_uri_msg_
409 {
410  u32 client_index;
411  u32 context;
412  u8 uri[56];
414 
415 STATIC_ASSERT (sizeof (session_connect_uri_msg_t) <=
416  SESSION_CTRL_MSG_MAX_SIZE, "msg too large");
417 
418 typedef struct session_connected_msg_
419 {
420  u32 context;
421  i32 retval;
422  u64 handle;
423  uword server_rx_fifo;
424  uword server_tx_fifo;
425  u64 segment_handle;
426  uword ct_rx_fifo;
427  uword ct_tx_fifo;
428  u64 ct_segment_handle;
429  uword vpp_event_queue_address;
430  u32 segment_size;
431  u8 segment_name_length;
432  u8 segment_name[64];
434 } __clib_packed session_connected_msg_t;
435 
436 typedef struct session_disconnect_msg_
437 {
438  u32 client_index;
439  u32 context;
441 } __clib_packed session_disconnect_msg_t;
442 
443 typedef struct session_disconnected_msg_
444 {
445  u32 client_index;
446  u32 context;
447  u64 handle;
449 
450 typedef struct session_disconnected_reply_msg_
451 {
452  u32 context;
453  i32 retval;
454  u64 handle;
456 
457 typedef struct session_reset_msg_
458 {
459  u32 client_index;
460  u32 context;
461  u64 handle;
462 } __clib_packed session_reset_msg_t;
463 
464 typedef struct session_reset_reply_msg_
465 {
466  u32 context;
467  i32 retval;
468  u64 handle;
470 
471 typedef struct session_req_worker_update_msg_
472 {
475 
476 /* NOTE: using u16 for wrk indices because message needs to fit in 18B */
477 typedef struct session_worker_update_msg_
478 {
479  u32 client_index;
480  u16 wrk_index;
481  u16 req_wrk_index;
482  u64 handle;
484 
486 {
487  u64 handle;
488  uword rx_fifo;
489  uword tx_fifo;
490  u64 segment_handle;
492 
493 typedef struct session_app_detach_msg_
494 {
495  u32 client_index;
496  u32 context;
498 
499 typedef struct app_map_another_segment_msg_
500 {
501  u32 client_index;
502  u32 context;
503  u8 fd_flags;
504  u32 segment_size;
505  u8 segment_name[128];
506  u64 segment_handle;
508 
509 typedef struct app_unmap_segment_msg_
510 {
511  u32 client_index;
512  u32 context;
513  u64 segment_handle;
515 
516 typedef struct session_migrate_msg_
517 {
518  uword vpp_evt_q;
520  session_handle_t new_handle;
521  u32 vpp_thread_index;
522 } __clib_packed session_migrated_msg_t;
523 
524 typedef struct session_cleanup_msg_
525 {
526  session_handle_t handle;
528 } __clib_packed session_cleanup_msg_t;
529 
530 typedef struct session_app_wrk_rpc_msg_
531 {
532  u32 client_index; /**< app client index */
533  u32 wrk_index; /**< dst worker index */
534  u8 data[64]; /**< rpc data */
536 
537 typedef struct app_session_event_
538 {
539  svm_msg_q_msg_t msg;
540  session_event_t *evt;
541 } __clib_packed app_session_evt_t;
542 
543 static inline void
544 app_alloc_ctrl_evt_to_vpp (svm_msg_q_t * mq, app_session_evt_t * app_evt,
545  u8 evt_type)
546 {
549  SVM_Q_WAIT, &app_evt->msg);
550  app_evt->evt = svm_msg_q_msg_data (mq, &app_evt->msg);
551  clib_memset (app_evt->evt, 0, sizeof (*app_evt->evt));
552  app_evt->evt->event_type = evt_type;
553 }
554 
555 static inline void
556 app_send_ctrl_evt_to_vpp (svm_msg_q_t * mq, app_session_evt_t * app_evt)
557 {
558  svm_msg_q_add_and_unlock (mq, &app_evt->msg);
559 }
560 
561 /**
562  * Send fifo io event to vpp worker thread
563  *
564  * Because there may be multiple writers to one of vpp's queues, this
565  * protects message allocation and enqueueing.
566  *
567  * @param mq vpp message queue
568  * @param f fifo for which the event is sent
569  * @param evt_type type of event
570  * @param noblock flag to indicate is request is blocking or not
571  * @return 0 if success, negative integer otherwise
572  */
573 static inline int
574 app_send_io_evt_to_vpp (svm_msg_q_t * mq, u32 session_index, u8 evt_type,
575  u8 noblock)
576 {
577  session_event_t *evt;
578  svm_msg_q_msg_t msg;
579 
580  if (noblock)
581  {
582  if (svm_msg_q_try_lock (mq))
583  return -1;
585  || svm_msg_q_is_full (mq)))
586  {
587  svm_msg_q_unlock (mq);
588  return -2;
589  }
591  evt = (session_event_t *) svm_msg_q_msg_data (mq, &msg);
592  evt->session_index = session_index;
593  evt->event_type = evt_type;
594  svm_msg_q_add_and_unlock (mq, &msg);
595  return 0;
596  }
597  else
598  {
599  svm_msg_q_lock (mq);
601  || svm_msg_q_is_full (mq))
602  svm_msg_q_wait (mq);
604  evt = (session_event_t *) svm_msg_q_msg_data (mq, &msg);
605  evt->session_index = session_index;
606  evt->event_type = evt_type;
607  svm_msg_q_add_and_unlock (mq, &msg);
608  return 0;
609  }
610 }
611 
612 always_inline int
614  svm_msg_q_t * vpp_evt_q, u8 * data, u32 len, u8 evt_type,
615  u8 do_evt, u8 noblock)
616 {
617  u32 max_enqueue, actual_write;
619  int rv;
620 
621  max_enqueue = svm_fifo_max_enqueue_prod (f);
622  if (max_enqueue < (sizeof (session_dgram_hdr_t) + len))
623  return 0;
624 
625  max_enqueue -= sizeof (session_dgram_hdr_t);
626  actual_write = clib_min (len, max_enqueue);
627  hdr.data_length = actual_write;
628  hdr.data_offset = 0;
629  clib_memcpy_fast (&hdr.rmt_ip, &at->rmt_ip, sizeof (ip46_address_t));
630  hdr.is_ip4 = at->is_ip4;
631  hdr.rmt_port = at->rmt_port;
632  clib_memcpy_fast (&hdr.lcl_ip, &at->lcl_ip, sizeof (ip46_address_t));
633  hdr.lcl_port = at->lcl_port;
634  rv = svm_fifo_enqueue (f, sizeof (hdr), (u8 *) & hdr);
635  ASSERT (rv == sizeof (hdr));
636 
637  rv = svm_fifo_enqueue (f, actual_write, data);
638  if (do_evt)
639  {
640  if (rv > 0 && svm_fifo_set_event (f))
641  app_send_io_evt_to_vpp (vpp_evt_q, f->master_session_index, evt_type,
642  noblock);
643  }
644  ASSERT (rv);
645  return rv;
646 }
647 
648 always_inline int
649 app_send_dgram (app_session_t * s, u8 * data, u32 len, u8 noblock)
650 {
651  return app_send_dgram_raw (s->tx_fifo, &s->transport, s->vpp_evt_q, data,
652  len, SESSION_IO_EVT_TX, 1 /* do_evt */ ,
653  noblock);
654 }
655 
656 always_inline int
657 app_send_stream_raw (svm_fifo_t * f, svm_msg_q_t * vpp_evt_q, u8 * data,
658  u32 len, u8 evt_type, u8 do_evt, u8 noblock)
659 {
660  int rv;
661 
662  rv = svm_fifo_enqueue (f, len, data);
663  if (do_evt)
664  {
665  if (rv > 0 && svm_fifo_set_event (f))
666  app_send_io_evt_to_vpp (vpp_evt_q, f->master_session_index, evt_type,
667  noblock);
668  }
669  return rv;
670 }
671 
672 always_inline int
673 app_send_stream (app_session_t * s, u8 * data, u32 len, u8 noblock)
674 {
675  return app_send_stream_raw (s->tx_fifo, s->vpp_evt_q, data, len,
676  SESSION_IO_EVT_TX, 1 /* do_evt */ , noblock);
677 }
678 
679 always_inline int
680 app_send (app_session_t * s, u8 * data, u32 len, u8 noblock)
681 {
682  if (s->is_dgram)
683  return app_send_dgram (s, data, len, noblock);
684  return app_send_stream (s, data, len, noblock);
685 }
686 
687 always_inline int
688 app_recv_dgram_raw (svm_fifo_t * f, u8 * buf, u32 len,
689  app_session_transport_t * at, u8 clear_evt, u8 peek)
690 {
692  u32 max_deq;
693  int rv;
694 
695  max_deq = svm_fifo_max_dequeue_cons (f);
696  if (max_deq <= sizeof (session_dgram_hdr_t))
697  {
698  if (clear_evt)
700  return 0;
701  }
702 
703  if (clear_evt)
705 
706  svm_fifo_peek (f, 0, sizeof (ph), (u8 *) & ph);
707  ASSERT (ph.data_length >= ph.data_offset);
708 
709  /* Check if we have the full dgram */
710  if (max_deq < (ph.data_length + SESSION_CONN_HDR_LEN)
711  && len >= ph.data_length)
712  return 0;
713 
714  svm_fifo_peek (f, sizeof (ph), sizeof (*at), (u8 *) at);
715  len = clib_min (len, ph.data_length - ph.data_offset);
716  rv = svm_fifo_peek (f, ph.data_offset + SESSION_CONN_HDR_LEN, len, buf);
717  if (peek)
718  return rv;
719 
720  /* Discards data that did not fit in buffer */
721  svm_fifo_dequeue_drop (f, ph.data_length + SESSION_CONN_HDR_LEN);
722 
723  return rv;
724 }
725 
726 always_inline int
727 app_recv_dgram (app_session_t * s, u8 * buf, u32 len)
728 {
729  return app_recv_dgram_raw (s->rx_fifo, buf, len, &s->transport, 1, 0);
730 }
731 
732 always_inline int
733 app_recv_stream_raw (svm_fifo_t * f, u8 * buf, u32 len, u8 clear_evt, u8 peek)
734 {
735  if (clear_evt)
737 
738  if (peek)
739  return svm_fifo_peek (f, 0, len, buf);
740 
741  return svm_fifo_dequeue (f, len, buf);
742 }
743 
744 always_inline int
745 app_recv_stream (app_session_t * s, u8 * buf, u32 len)
746 {
747  return app_recv_stream_raw (s->rx_fifo, buf, len, 1, 0);
748 }
749 
750 always_inline int
752 {
753  if (s->is_dgram)
754  return app_recv_dgram (s, data, len);
755  return app_recv_stream (s, data, len);
756 }
757 
758 /* *INDENT-OFF* */
759 static char *session_error_str[] = {
760 #define _(sym, str) str,
762 #undef _
763 };
764 /* *INDENT-ON* */
765 
766 static inline u8 *
767 format_session_error (u8 * s, va_list * args)
768 {
769  session_error_t error = va_arg (*args, session_error_t);
770  if (-error >= 0 && -error < SESSION_N_ERRORS)
771  s = format (s, "%s", session_error_str[-error]);
772  else
773  s = format (s, "invalid session err %u", -error);
774  return s;
775 }
776 #endif /* __included_uri_h__ */
777 
778 /*
779  * fd.io coding-style-patch-verification: ON
780  *
781  * Local Variables:
782  * eval: (c-set-style "gnu")
783  * End:
784  */
#define foreach_app_session_field
flag for dgram mode
string hostname[64]
Definition: dhcp.api:159
struct session_unlisten_msg_ session_unlisten_msg_t
static int app_recv_stream_raw(svm_fifo_t *f, u8 *buf, u32 len, u8 clear_evt, u8 peek)
struct app_session_event_ app_session_evt_t
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:327
struct session_accepted_msg_ session_accepted_msg_t
u8 is_ip4
set if uses ip4 networking
static u32 svm_fifo_max_enqueue_prod(svm_fifo_t *f)
Maximum number of bytes that can be enqueued into fifo.
Definition: svm_fifo.h:524
vl_api_wireguard_peer_flags_t flags
Definition: wireguard.api:103
a
Definition: bitmap.h:538
struct _vnet_connect_args vnet_connect_args_t
int vnet_listen(vnet_listen_args_t *a)
Definition: application.c:965
int vnet_app_add_cert_key_interest(u32 index, u32 app_index)
Ask for app cb on pair deletion.
Definition: application.c:1717
struct _vnet_unlisten_args_t vnet_unlisten_args_t
unsigned long u64
Definition: types.h:89
#define clib_memcpy_fast(a, b, c)
Definition: string.h:81
clib_memset(h->entries, 0, sizeof(h->entries[0]) *entries)
struct session_req_worker_update_msg_ session_req_worker_update_msg_t
static char * session_error_str[]
static int app_send_stream(app_session_t *s, u8 *data, u32 len, u8 noblock)
int svm_fifo_peek(svm_fifo_t *f, u32 offset, u32 len, u8 *dst)
Peek data from fifo.
Definition: svm_fifo.c:1044
struct session_listen_msg_ session_listen_msg_t
u8 * format(u8 *s, const char *fmt,...)
Definition: format.c:424
struct session_disconnected_reply_msg_ session_disconnected_reply_msg_t
struct session_reset_msg_ session_reset_msg_t
struct _vnet_application_add_tls_cert_args_t vnet_app_add_tls_cert_args_t
struct session_worker_update_reply_msg_ session_worker_update_reply_msg_t
unsigned char u8
Definition: types.h:56
u8 data[128]
Definition: ipsec_types.api:89
struct _vnet_bind_args_t vnet_listen_args_t
int vnet_bind_uri(vnet_listen_args_t *)
static session_handle_t session_handle(session_t *s)
u32 ctx_index
index in crypto context pool
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
enum session_ft_action_ session_ft_action_t
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)
void * data
protocol specific data
int vnet_app_del_cert_key_pair(u32 index)
Definition: application.c:1728
struct _vnet_disconnect_args_t vnet_disconnect_args_t
struct app_unmap_segment_msg_ session_app_del_segment_msg_t
struct session_disconnect_msg_ session_disconnect_msg_t
enum session_fd_type_ session_fd_type_t
static u32 svm_fifo_max_dequeue_cons(svm_fifo_t *f)
Fifo max bytes to dequeue optimized for consumer.
Definition: svm_fifo.h:404
static int app_send_io_evt_to_vpp(svm_msg_q_t *mq, u32 session_index, u8 evt_type, u8 noblock)
Send fifo io event to vpp worker thread.
#define foreach_fd_type
ip46_address_t lcl_ip
unsigned int u32
Definition: types.h:88
int svm_fifo_dequeue(svm_fifo_t *f, u32 len, u8 *dst)
Dequeue data from fifo.
Definition: svm_fifo.c:1009
struct session_connect_uri_msg_ session_connect_uri_msg_t
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 session_app_wrk_rpc_msg_ session_app_wrk_rpc_msg_t
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:1335
struct _session_endpoint_cfg session_endpoint_cfg_t
vl_api_fib_path_type_t type
Definition: fib_types.api:123
static int app_recv(app_session_t *s, u8 *data, u32 len)
struct app_map_another_segment_msg_ session_app_add_segment_msg_t
vl_api_ip_proto_t proto
Definition: acl_types.api:50
#define foreach_app_init_args
struct certificate_ app_cert_key_pair_t
unsigned short u16
Definition: types.h:57
#define SESSION_CTRL_MSG_MAX_SIZE
Definition: session_types.h:24
int svm_fifo_enqueue(svm_fifo_t *f, u32 len, const u8 *src)
Enqueue data to fifo.
Definition: svm_fifo.c:838
#define PREDICT_FALSE(x)
Definition: clib.h:120
ip46_address_t rmt_ip
remote ip
#define always_inline
Definition: ipsec.h:28
static void svm_fifo_unset_event(svm_fifo_t *f)
Unset fifo event flag.
Definition: svm_fifo.h:714
struct session_cb_vft_ session_cb_vft_t
int vnet_app_add_cert_key_pair(vnet_app_add_cert_key_pair_args_t *a)
Definition: application.c:1707
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_unbind_uri(vnet_unlisten_args_t *a)
u32 n_subscribers
refcount of sessions using said context
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 do_evt, u8 noblock)
int vnet_application_attach(vnet_app_attach_args_t *a)
Attach application to vpp.
Definition: application.c:827
u8 len
Definition: ip_types.api:92
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)
Set fifo event flag.
Definition: svm_fifo.h:701
u32 ckpair_index
certificate & key
Unidirectional shared-memory multi-ring message queue.
static void svm_msg_q_unlock(svm_msg_q_t *mq)
Unlock message queue.
#define SESSION_CONN_HDR_LEN
struct app_session_transport_ app_session_transport_t
int vnet_unlisten(vnet_unlisten_args_t *a)
Definition: application.c:1056
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
int parse_uri(char *uri, session_endpoint_cfg_t *sep)
struct session_worker_update_msg_ session_worker_update_msg_t
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:1325
int vnet_disconnect_session(vnet_disconnect_args_t *a)
Definition: application.c:1087
#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
struct session_cleanup_msg_ session_cleanup_msg_t
static u8 * format_session_error(u8 *s, va_list *args)
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.
Definition: application.c:887
struct _vnet_app_add_cert_key_pair_args_ vnet_app_add_cert_key_pair_args_t
struct session_migrate_msg_ session_migrated_msg_t
ip46_address_t rmt_ip
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 vnet_connect(vnet_connect_args_t *a)
Definition: application.c:1019
struct session_disconnected_msg_ session_disconnected_msg_t
struct session_bound_msg_ session_bound_msg_t
vl_api_address_t ip
Definition: l2.api:501
int vnet_connect_uri(vnet_connect_args_t *a)
u64 session_handle_t
struct session_app_detach_msg_ session_app_detach_msg_t
u64 uword
Definition: types.h:112
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 do_evt, u8 noblock)
struct session_unlisten_reply_msg_ session_unlisten_reply_msg_t
u32 index
Definition: flow_types.api:221
u16 port
Definition: lb_types.api:72
struct session_connect_msg_ session_connect_msg_t
session_cleanup_ntf_t
struct crypto_ctx_ crypto_context_t
enum session_error_ session_error_t
enum crypto_engine_type_ crypto_engine_type_t
struct _session_endpoint session_endpoint_t
#define foreach_app_options_flags
int svm_fifo_dequeue_drop(svm_fifo_t *f, u32 len)
Dequeue and drop bytes from fifo.
Definition: svm_fifo.c:1068
static int svm_msg_q_lock(svm_msg_q_t *mq)
Lock, or block trying, the message queue.
crypto_engine_type_
struct _svm_fifo svm_fifo_t
static u8 svm_msg_q_is_full(svm_msg_q_t *mq)
Check if message queue is full.
struct session_dgram_header_ session_dgram_hdr_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.
static int app_recv_dgram(app_session_t *s, u8 *buf, u32 len)
u16 rmt_port
remote port (network order)
STATIC_ASSERT(sizeof(session_listen_msg_t)<=SESSION_CTRL_MSG_MAX_SIZE, "msg too large")
struct session_listen_uri_msg_ session_listen_uri_msg_t