FD.io VPP  v19.04.4-rc0-5-ge88582fac
Vector Packet Processing
application_interface.h File Reference
+ Include dependency graph for application_interface.h:
+ This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  app_session_transport_
 
struct  app_session_t
 
struct  session_bound_msg_
 
struct  session_unlisten_reply_msg_
 
struct  session_accepted_msg_
 
struct  session_accepted_reply_msg_
 
struct  session_connected_msg_
 
struct  session_disconnected_msg_
 
struct  session_disconnected_reply_msg_
 
struct  session_reset_msg_
 
struct  session_reset_reply_msg_
 
struct  session_req_worker_update_msg_
 
struct  session_worker_update_msg_
 
struct  session_worker_update_reply_msg_
 
struct  app_session_event_
 

Macros

#define foreach_app_init_args
 
#define foreach_app_options_flags
 
#define foreach_fd_type
 
#define foreach_app_session_field
 flag for dgram mode More...
 

Typedefs

typedef struct _stream_session_cb_vft session_cb_vft_t
 
typedef struct _vnet_app_attach_args_t vnet_app_attach_args_t
 
typedef struct _vnet_app_detach_args_t vnet_app_detach_args_t
 
typedef struct _vnet_bind_args_t vnet_listen_args_t
 
typedef struct _vnet_unlisten_args_t vnet_unlisten_args_t
 
typedef struct _vnet_connect_args vnet_connect_args_t
 
typedef struct _vnet_disconnect_args_t vnet_disconnect_args_t
 
typedef struct _vnet_application_add_tls_cert_args_t vnet_app_add_tls_cert_args_t
 
typedef struct _vnet_application_add_tls_key_args_t vnet_app_add_tls_key_args_t
 
typedef enum tls_engine_type_ tls_engine_type_t
 
typedef enum _app_options app_options_t
 
typedef enum _app_options_flags app_options_flags_t
 
typedef enum session_fd_type_ session_fd_type_t
 
typedef enum session_fd_flag_ session_fd_flag_t
 
typedef struct app_session_transport_ app_session_transport_t
 
typedef struct session_bound_msg_ session_bound_msg_t
 
typedef struct session_unlisten_reply_msg_ session_unlisten_reply_msg_t
 
typedef struct session_accepted_msg_ session_accepted_msg_t
 
typedef struct session_accepted_reply_msg_ session_accepted_reply_msg_t
 
typedef struct session_connected_msg_ session_connected_msg_t
 
typedef struct session_disconnected_msg_ session_disconnected_msg_t
 
typedef struct session_disconnected_reply_msg_ session_disconnected_reply_msg_t
 
typedef struct session_reset_msg_ session_reset_msg_t
 
typedef struct session_reset_reply_msg_ session_reset_reply_msg_t
 
typedef struct session_req_worker_update_msg_ session_req_worker_update_msg_t
 
typedef struct session_worker_update_msg_ session_worker_update_msg_t
 
typedef struct session_worker_update_reply_msg_ session_worker_update_reply_msg_t
 
typedef struct app_session_event_ app_session_evt_t
 

Enumerations

enum  tls_engine_type_ { TLS_ENGINE_NONE, TLS_ENGINE_MBEDTLS, TLS_ENGINE_OPENSSL, TLS_N_ENGINES }
 
enum  app_attach_options_index_t {
  APP_OPTIONS_FLAGS, APP_OPTIONS_EVT_QUEUE_SIZE, APP_OPTIONS_SEGMENT_SIZE, APP_OPTIONS_ADD_SEGMENT_SIZE,
  APP_OPTIONS_PRIVATE_SEGMENT_COUNT, APP_OPTIONS_RX_FIFO_SIZE, APP_OPTIONS_TX_FIFO_SIZE, APP_OPTIONS_PREALLOC_FIFO_PAIRS,
  APP_OPTIONS_NAMESPACE, APP_OPTIONS_NAMESPACE_SECRET, APP_OPTIONS_PROXY_TRANSPORT, APP_OPTIONS_ACCEPT_COOKIE,
  APP_OPTIONS_TLS_ENGINE, APP_OPTIONS_N_OPTIONS
}
 
enum  session_fd_type_ { SESSION_N_FD_TYPE }
 
enum  session_fd_flag_ { foreach_fd_type }
 

Functions

int vnet_bind_uri (vnet_listen_args_t *)
 
int vnet_unbind_uri (vnet_unlisten_args_t *a)
 
int vnet_connect_uri (vnet_connect_args_t *a)
 
int vnet_application_attach (vnet_app_attach_args_t *a)
 Attach application to vpp. More...
 
int vnet_application_detach (vnet_app_detach_args_t *a)
 Detach application from vpp. More...
 
int vnet_listen (vnet_listen_args_t *a)
 
int vnet_connect (vnet_connect_args_t *a)
 
int vnet_unlisten (vnet_unlisten_args_t *a)
 
int vnet_disconnect_session (vnet_disconnect_args_t *a)
 
clib_error_tvnet_app_add_tls_cert (vnet_app_add_tls_cert_args_t *a)
 
clib_error_tvnet_app_add_tls_key (vnet_app_add_tls_key_args_t *a)
 
 STATIC_ASSERT (sizeof(session_accepted_reply_msg_t)<=16, "accept reply")
 
static void app_alloc_ctrl_evt_to_vpp (svm_msg_q_t *mq, app_session_evt_t *app_evt, u8 evt_type)
 
static void app_send_ctrl_evt_to_vpp (svm_msg_q_t *mq, app_session_evt_t *app_evt)
 
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. More...
 
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)
 
static int app_send_dgram (app_session_t *s, u8 *data, u32 len, u8 noblock)
 
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)
 
static int app_send_stream (app_session_t *s, u8 *data, u32 len, u8 noblock)
 
static int app_send (app_session_t *s, u8 *data, u32 len, u8 noblock)
 
static int app_recv_dgram_raw (svm_fifo_t *f, u8 *buf, u32 len, app_session_transport_t *at, u8 clear_evt, u8 peek)
 
static int app_recv_dgram (app_session_t *s, u8 *buf, u32 len)
 
static int app_recv_stream_raw (svm_fifo_t *f, u8 *buf, u32 len, u8 clear_evt, u8 peek)
 
static int app_recv_stream (app_session_t *s, u8 *buf, u32 len)
 
static int app_recv (app_session_t *s, u8 *data, u32 len)
 

Macro Definition Documentation

◆ foreach_app_init_args

#define foreach_app_init_args
Value:
_(u32, api_client_index) \
_(u8 *, name) \
_(u64 *, options) \
_(u8 *, namespace_id) \
_(session_cb_vft_t *, session_cb_vft) \
_(u32, app_index) \
unsigned long u64
Definition: types.h:89
unsigned char u8
Definition: types.h:56
unsigned int u32
Definition: types.h:88
u8 name[64]
Definition: memclnt.api:152
struct _stream_session_cb_vft session_cb_vft_t

Definition at line 53 of file application_interface.h.

◆ foreach_app_options_flags

foreach_app_options_flags
Value:
_(ACCEPT_REDIRECT, "Use FIFO with redirects") \
_(ADD_SEGMENT, "Add segment and signal app if needed") \
_(IS_BUILTIN, "Application is builtin") \
_(IS_TRANSPORT_APP, "Application is a transport proto") \
_(IS_PROXY, "Application is proxying") \
_(USE_GLOBAL_SCOPE, "App can use global session scope") \
_(USE_LOCAL_SCOPE, "App can use local session scope") \
_(EVT_MQ_USE_EVENTFD, "Use eventfds for signaling") \

Definition at line 169 of file application_interface.h.

◆ foreach_app_session_field

#define foreach_app_session_field
Value:
_(svm_fifo_t, *rx_fifo) /**< rx fifo */ \
_(svm_fifo_t, *tx_fifo) /**< tx fifo */ \
_(session_type_t, session_type) /**< session type */ \
_(volatile u8, session_state) /**< session state */ \
_(u32, session_index) /**< index in owning pool */ \
_(app_session_transport_t, transport) /**< transport info */ \
_(svm_msg_q_t, *vpp_evt_q) /**< vpp event queue */ \
_(u8, is_dgram)
unsigned char u8
Definition: types.h:56
struct _svm_fifo svm_fifo_t
u8 session_type_t
unsigned int u32
Definition: types.h:88

flag for dgram mode

Definition at line 237 of file application_interface.h.

◆ foreach_fd_type

#define foreach_fd_type
Value:
_(VPP_MQ_SEGMENT, "Fd for vpp's event mq segment") \
_(MEMFD_SEGMENT, "Fd for memfd segment") \
_(MQ_EVENTFD, "Event fd used by message queue") \
_(VPP_MQ_EVENTFD, "Event fd used by vpp's message queue") \

Definition at line 193 of file application_interface.h.

Typedef Documentation

◆ app_options_flags_t

typedef enum _app_options_flags app_options_flags_t

◆ app_options_t

typedef enum _app_options app_options_t

◆ app_session_evt_t

◆ app_session_transport_t

◆ session_accepted_msg_t

◆ session_accepted_reply_msg_t

◆ session_bound_msg_t

◆ session_cb_vft_t

typedef struct _stream_session_cb_vft session_cb_vft_t

◆ session_connected_msg_t

◆ session_disconnected_msg_t

◆ session_disconnected_reply_msg_t

◆ session_fd_flag_t

◆ session_fd_type_t

◆ session_req_worker_update_msg_t

◆ session_reset_msg_t

◆ session_reset_reply_msg_t

◆ session_unlisten_reply_msg_t

◆ session_worker_update_msg_t

◆ session_worker_update_reply_msg_t

◆ tls_engine_type_t

◆ vnet_app_add_tls_cert_args_t

typedef struct _vnet_application_add_tls_cert_args_t vnet_app_add_tls_cert_args_t

◆ vnet_app_add_tls_key_args_t

typedef struct _vnet_application_add_tls_key_args_t vnet_app_add_tls_key_args_t

◆ vnet_app_attach_args_t

typedef struct _vnet_app_attach_args_t vnet_app_attach_args_t

◆ vnet_app_detach_args_t

typedef struct _vnet_app_detach_args_t vnet_app_detach_args_t

◆ vnet_connect_args_t

typedef struct _vnet_connect_args vnet_connect_args_t

◆ vnet_disconnect_args_t

typedef struct _vnet_disconnect_args_t vnet_disconnect_args_t

◆ vnet_listen_args_t

typedef struct _vnet_bind_args_t vnet_listen_args_t

◆ vnet_unlisten_args_t

typedef struct _vnet_unlisten_args_t vnet_unlisten_args_t

Enumeration Type Documentation

◆ app_attach_options_index_t

Enumerator
APP_OPTIONS_FLAGS 
APP_OPTIONS_EVT_QUEUE_SIZE 
APP_OPTIONS_SEGMENT_SIZE 
APP_OPTIONS_ADD_SEGMENT_SIZE 
APP_OPTIONS_PRIVATE_SEGMENT_COUNT 
APP_OPTIONS_RX_FIFO_SIZE 
APP_OPTIONS_TX_FIFO_SIZE 
APP_OPTIONS_PREALLOC_FIFO_PAIRS 
APP_OPTIONS_NAMESPACE 
APP_OPTIONS_NAMESPACE_SECRET 
APP_OPTIONS_PROXY_TRANSPORT 
APP_OPTIONS_ACCEPT_COOKIE 
APP_OPTIONS_TLS_ENGINE 
APP_OPTIONS_N_OPTIONS 

Definition at line 151 of file application_interface.h.

◆ session_fd_flag_

Enumerator
foreach_fd_type 

Definition at line 207 of file application_interface.h.

◆ session_fd_type_

Enumerator
SESSION_N_FD_TYPE 

Definition at line 199 of file application_interface.h.

◆ tls_engine_type_

Enumerator
TLS_ENGINE_NONE 
TLS_ENGINE_MBEDTLS 
TLS_ENGINE_OPENSSL 
TLS_N_ENGINES 

Definition at line 142 of file application_interface.h.

Function Documentation

◆ app_alloc_ctrl_evt_to_vpp()

static void app_alloc_ctrl_evt_to_vpp ( svm_msg_q_t mq,
app_session_evt_t app_evt,
u8  evt_type 
)
inlinestatic

Definition at line 380 of file application_interface.h.

+ Here is the call graph for this function:

◆ app_recv()

static int app_recv ( app_session_t s,
u8 data,
u32  len 
)
inlinestatic

Definition at line 589 of file application_interface.h.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ app_recv_dgram()

static int app_recv_dgram ( app_session_t s,
u8 buf,
u32  len 
)
inlinestatic

Definition at line 565 of file application_interface.h.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ app_recv_dgram_raw()

static int app_recv_dgram_raw ( svm_fifo_t f,
u8 buf,
u32  len,
app_session_transport_t at,
u8  clear_evt,
u8  peek 
)
inlinestatic

Definition at line 530 of file application_interface.h.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ app_recv_stream()

static int app_recv_stream ( app_session_t s,
u8 buf,
u32  len 
)
inlinestatic

Definition at line 583 of file application_interface.h.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ app_recv_stream_raw()

static int app_recv_stream_raw ( svm_fifo_t f,
u8 buf,
u32  len,
u8  clear_evt,
u8  peek 
)
inlinestatic

Definition at line 571 of file application_interface.h.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ app_send()

static int app_send ( app_session_t s,
u8 data,
u32  len,
u8  noblock 
)
inlinestatic

Definition at line 522 of file application_interface.h.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ app_send_ctrl_evt_to_vpp()

static void app_send_ctrl_evt_to_vpp ( svm_msg_q_t mq,
app_session_evt_t app_evt 
)
inlinestatic

Definition at line 393 of file application_interface.h.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ app_send_dgram()

static int app_send_dgram ( app_session_t s,
u8 data,
u32  len,
u8  noblock 
)
inlinestatic

Definition at line 491 of file application_interface.h.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ app_send_dgram_raw()

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 
)
inlinestatic

Definition at line 455 of file application_interface.h.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ app_send_io_evt_to_vpp()

static int app_send_io_evt_to_vpp ( svm_msg_q_t mq,
u32  session_index,
u8  evt_type,
u8  noblock 
)
inlinestatic

Send fifo io event to vpp worker thread.

Because there may be multiple writers to one of vpp's queues, this protects message allocation and enqueueing.

Parameters
mqvpp message queue
ffifo for which the event is sent
evt_typetype of event
noblockflag to indicate is request is blocking or not
Returns
0 if success, negative integer otherwise

Definition at line 411 of file application_interface.h.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ app_send_stream()

static int app_send_stream ( app_session_t s,
u8 data,
u32  len,
u8  noblock 
)
inlinestatic

Definition at line 515 of file application_interface.h.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ app_send_stream_raw()

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 
)
inlinestatic

Definition at line 499 of file application_interface.h.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ STATIC_ASSERT()

STATIC_ASSERT ( sizeof(session_accepted_reply_msg_t)<=  16,
"accept reply"   
)

◆ vnet_app_add_tls_cert()

clib_error_t* vnet_app_add_tls_cert ( vnet_app_add_tls_cert_args_t a)

Definition at line 1330 of file application.c.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ vnet_app_add_tls_key()

clib_error_t* vnet_app_add_tls_key ( vnet_app_add_tls_key_args_t a)

Definition at line 1342 of file application.c.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ vnet_application_attach()

int vnet_application_attach ( vnet_app_attach_args_t a)

Attach application to vpp.

Allocates a vpp app, i.e., a structure that keeps back pointers to external app and a segment manager for shared memory fifo based communication with the external app.

Definition at line 839 of file application.c.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ vnet_application_detach()

int vnet_application_detach ( vnet_app_detach_args_t a)

Detach application from vpp.

Definition at line 899 of file application.c.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ vnet_bind_uri()

int vnet_bind_uri ( vnet_listen_args_t )

Definition at line 121 of file application_interface.c.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ vnet_connect()

int vnet_connect ( vnet_connect_args_t a)

Definition at line 1029 of file application.c.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ vnet_connect_uri()

int vnet_connect_uri ( vnet_connect_args_t a)

Definition at line 157 of file application_interface.c.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ vnet_disconnect_session()

int vnet_disconnect_session ( vnet_disconnect_args_t a)

Definition at line 1094 of file application.c.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ vnet_listen()

int vnet_listen ( vnet_listen_args_t a)

Definition at line 977 of file application.c.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ vnet_unbind_uri()

int vnet_unbind_uri ( vnet_unlisten_args_t a)

Definition at line 135 of file application_interface.c.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ vnet_unlisten()

int vnet_unlisten ( vnet_unlisten_args_t a)

Definition at line 1065 of file application.c.

+ Here is the call graph for this function:
+ Here is the caller graph for this function: