FD.io VPP  v19.01.2-3-gf61a1a8
Vector Packet Processing
session.c File Reference

Session and session manager. More...

+ Include dependency graph for session.c:

Go to the source code of this file.

Typedefs

typedef struct _session_switch_pool_args session_switch_pool_args_t
 
typedef int(* session_open_service_fn) (u32, session_endpoint_t *, u32)
 

Functions

static int session_send_evt_to_thread (void *data, void *args, u32 thread_index, session_evt_type_t evt_type)
 
int session_send_io_evt_to_thread (svm_fifo_t *f, session_evt_type_t evt_type)
 
int session_send_io_evt_to_thread_custom (void *data, u32 thread_index, session_evt_type_t evt_type)
 
int session_send_ctrl_evt_to_thread (stream_session_t *s, session_evt_type_t evt_type)
 
void session_send_rpc_evt_to_thread (u32 thread_index, void *fp, void *rpc_args)
 
static void session_program_transport_close (stream_session_t *s)
 
stream_session_tsession_alloc (u32 thread_index)
 
void session_free (stream_session_t *s)
 
void session_free_w_fifos (stream_session_t *s)
 
static void session_delete (stream_session_t *s)
 Cleans up session and lookup table. More...
 
int session_alloc_fifos (segment_manager_t *sm, stream_session_t *s)
 
static stream_session_tsession_alloc_for_connection (transport_connection_t *tc)
 
static int session_alloc_and_init (segment_manager_t *sm, transport_connection_t *tc, u8 alloc_fifos, stream_session_t **ret_s)
 
static void session_enqueue_discard_chain_bytes (vlib_main_t *vm, vlib_buffer_t *b, vlib_buffer_t **chain_b, u32 n_bytes_to_drop)
 Discards bytes from buffer chain. More...
 
static int session_enqueue_chain_tail (stream_session_t *s, vlib_buffer_t *b, u32 offset, u8 is_in_order)
 Enqueue buffer chain tail. More...
 
int session_enqueue_stream_connection (transport_connection_t *tc, vlib_buffer_t *b, u32 offset, u8 queue_event, u8 is_in_order)
 
int session_enqueue_dgram_connection (stream_session_t *s, session_dgram_hdr_t *hdr, vlib_buffer_t *b, u8 proto, u8 queue_event)
 
u8 stream_session_no_space (transport_connection_t *tc, u32 thread_index, u16 data_len)
 Check if we have space in rx fifo to push more bytes. More...
 
u32 session_tx_fifo_max_dequeue (transport_connection_t *tc)
 
int stream_session_peek_bytes (transport_connection_t *tc, u8 *buffer, u32 offset, u32 max_bytes)
 
u32 stream_session_dequeue_drop (transport_connection_t *tc, u32 max_bytes)
 
static int session_enqueue_notify (stream_session_t *s)
 Notify session peer that new data has been enqueued. More...
 
int session_dequeue_notify (stream_session_t *s)
 
int session_manager_flush_enqueue_events (u8 transport_proto, u32 thread_index)
 Flushes queue of sessions that are to be notified of new data enqueued events. More...
 
int session_manager_flush_all_enqueue_events (u8 transport_proto)
 
void stream_session_init_fifos_pointers (transport_connection_t *tc, u32 rx_pointer, u32 tx_pointer)
 Init fifo tail and head pointers. More...
 
int session_stream_connect_notify (transport_connection_t *tc, u8 is_fail)
 
static void session_switch_pool (void *cb_args)
 
int session_dgram_connect_notify (transport_connection_t *tc, u32 old_thread_index, stream_session_t **new_session)
 Move dgram session to the right thread. More...
 
int stream_session_accept_notify (transport_connection_t *tc)
 
void session_transport_closing_notify (transport_connection_t *tc)
 Notification from transport that connection is being closed. More...
 
void session_transport_delete_notify (transport_connection_t *tc)
 Notification from transport that connection is being deleted. More...
 
void session_transport_closed_notify (transport_connection_t *tc)
 Notification from transport that session can be closed. More...
 
void session_transport_reset_notify (transport_connection_t *tc)
 Notify application that connection has been reset. More...
 
int stream_session_accept (transport_connection_t *tc, u32 listener_index, u8 notify)
 Accept a stream session. More...
 
int session_open_cl (u32 app_wrk_index, session_endpoint_t *rmt, u32 opaque)
 
int session_open_vc (u32 app_wrk_index, session_endpoint_t *rmt, u32 opaque)
 
int session_open_app (u32 app_wrk_index, session_endpoint_t *rmt, u32 opaque)
 
int session_open (u32 app_wrk_index, session_endpoint_t *rmt, u32 opaque)
 Ask transport to open connection to remote transport endpoint. More...
 
int session_listen (stream_session_t *ls, session_endpoint_cfg_t *sep)
 Ask transport to listen on session endpoint. More...
 
int session_stop_listen (stream_session_t *s)
 Ask transport to stop listening on local transport endpoint. More...
 
void session_close (stream_session_t *s)
 Initialize session closing procedure. More...
 
void session_transport_close (stream_session_t *s)
 Notify transport the session can be disconnected. More...
 
void session_transport_cleanup (stream_session_t *s)
 Cleanup transport and session state. More...
 
transport_service_type_t session_transport_service_type (stream_session_t *s)
 
transport_tx_fn_type_t session_transport_tx_fn_type (stream_session_t *s)
 
u8 session_tx_is_dgram (stream_session_t *s)
 
void session_vpp_event_queues_allocate (session_manager_main_t *smm)
 Allocate event queues in the shared-memory segment. More...
 
ssvm_private_tsession_manager_get_evt_q_segment (void)
 
void session_register_transport (transport_proto_t transport_proto, const transport_proto_vft_t *vft, u8 is_ip4, u32 output_node)
 Initialize session layer for given transport proto and ip version. More...
 
transport_connection_tsession_get_transport (stream_session_t *s)
 
transport_connection_tlisten_session_get_transport (stream_session_t *s)
 
int listen_session_get_local_session_endpoint (stream_session_t *listener, session_endpoint_t *sep)
 
void session_flush_frames_main_thread (vlib_main_t *vm)
 
static clib_error_tsession_manager_main_enable (vlib_main_t *vm)
 
void session_node_enable_disable (u8 is_en)
 
clib_error_tvnet_session_enable_disable (vlib_main_t *vm, u8 is_en)
 
clib_error_tsession_manager_main_init (vlib_main_t *vm)
 
static clib_error_tsession_config_fn (vlib_main_t *vm, unformat_input_t *input)
 

Variables

session_manager_main_t session_manager_main
 
transport_proto_vft_ttp_vfts
 Per-type vector of transport protocol virtual function tables. More...
 
static session_open_service_fn session_open_srv_fns [TRANSPORT_N_SERVICES]
 
static session_fifo_rx_fnsession_tx_fns [TRANSPORT_TX_N_FNS]
 

Detailed Description

Session and session manager.

Definition in file session.c.

Typedef Documentation

typedef int(* session_open_service_fn) (u32, session_endpoint_t *, u32)

Definition at line 1037 of file session.c.

typedef struct _session_switch_pool_args session_switch_pool_args_t

Function Documentation

int listen_session_get_local_session_endpoint ( stream_session_t listener,
session_endpoint_t sep 
)

Definition at line 1378 of file session.c.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

transport_connection_t* listen_session_get_transport ( stream_session_t s)

Definition at line 1371 of file session.c.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

stream_session_t* session_alloc ( u32  thread_index)

Definition at line 144 of file session.c.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

static int session_alloc_and_init ( segment_manager_t sm,
transport_connection_t tc,
u8  alloc_fifos,
stream_session_t **  ret_s 
)
static

Definition at line 246 of file session.c.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

int session_alloc_fifos ( segment_manager_t sm,
stream_session_t s 
)

Definition at line 202 of file session.c.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

static stream_session_t* session_alloc_for_connection ( transport_connection_t tc)
static

Definition at line 226 of file session.c.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void session_close ( stream_session_t s)

Initialize session closing procedure.

Request is always sent to session node to ensure that all outstanding requests are served before transport is notified.

Definition at line 1135 of file session.c.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

static clib_error_t* session_config_fn ( vlib_main_t vm,
unformat_input_t input 
)
static

Definition at line 1568 of file session.c.

+ Here is the call graph for this function:

static void session_delete ( stream_session_t s)
static

Cleans up session and lookup table.

Transport connection must still be valid.

Definition at line 190 of file session.c.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

int session_dequeue_notify ( stream_session_t s)

Definition at line 552 of file session.c.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

int session_dgram_connect_notify ( transport_connection_t tc,
u32  old_thread_index,
stream_session_t **  new_session 
)

Move dgram session to the right thread.

Definition at line 735 of file session.c.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

static int session_enqueue_chain_tail ( stream_session_t s,
vlib_buffer_t b,
u32  offset,
u8  is_in_order 
)
inlinestatic

Enqueue buffer chain tail.

Definition at line 304 of file session.c.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

int session_enqueue_dgram_connection ( stream_session_t s,
session_dgram_hdr_t *  hdr,
vlib_buffer_t b,
u8  proto,
u8  queue_event 
)

Definition at line 445 of file session.c.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

static void session_enqueue_discard_chain_bytes ( vlib_main_t vm,
vlib_buffer_t b,
vlib_buffer_t **  chain_b,
u32  n_bytes_to_drop 
)
inlinestatic

Discards bytes from buffer chain.

It discards n_bytes_to_drop starting at first buffer after chain_b

Definition at line 273 of file session.c.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

static int session_enqueue_notify ( stream_session_t s)
inlinestatic

Notify session peer that new data has been enqueued.

Parameters
sStream session for which the event is to be generated.
lockFlag to indicate if call should lock message queue.
Returns
0 on success or negative number if failed to send notification.

Definition at line 530 of file session.c.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

int session_enqueue_stream_connection ( transport_connection_t tc,
vlib_buffer_t b,
u32  offset,
u8  queue_event,
u8  is_in_order 
)

Definition at line 392 of file session.c.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void session_flush_frames_main_thread ( vlib_main_t vm)

Definition at line 1398 of file session.c.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void session_free ( stream_session_t s)

Definition at line 169 of file session.c.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void session_free_w_fifos ( stream_session_t s)

Definition at line 177 of file session.c.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

transport_connection_t* session_get_transport ( stream_session_t s)

Definition at line 1358 of file session.c.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

int session_listen ( stream_session_t ls,
session_endpoint_cfg_t sep 
)

Ask transport to listen on session endpoint.

Parameters
sSession for which listen will be called. Note that unlike established sessions, listen sessions are not associated to a thread.
sepLocal endpoint to be listened on.

Definition at line 1076 of file session.c.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

int session_manager_flush_all_enqueue_events ( u8  transport_proto)

Definition at line 605 of file session.c.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

int session_manager_flush_enqueue_events ( u8  transport_proto,
u32  thread_index 
)

Flushes queue of sessions that are to be notified of new data enqueued events.

Parameters
thread_indexThread index for which the flush is to be performed.
Returns
0 on success or a positive number indicating the number of failures due to API queue being full.

Definition at line 576 of file session.c.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

ssvm_private_t* session_manager_get_evt_q_segment ( void  )

Definition at line 1305 of file session.c.

+ Here is the caller graph for this function:

static clib_error_t* session_manager_main_enable ( vlib_main_t vm)
static

Definition at line 1406 of file session.c.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

clib_error_t* session_manager_main_init ( vlib_main_t vm)

Definition at line 1550 of file session.c.

void session_node_enable_disable ( u8  is_en)

Definition at line 1495 of file session.c.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

int session_open ( u32  app_wrk_index,
session_endpoint_t rmt,
u32  opaque 
)

Ask transport to open connection to remote transport endpoint.

Stores handle for matching request with reply since the call can be asynchronous. For instance, for TCP the 3-way handshake must complete before reply comes. Session is only created once connection is established.

Parameters
app_indexIndex of the application requesting the connect
stSession type requested.
tepRemote transport endpoint
opaqueOpaque data (typically, api_context) the application expects on open completion.

Definition at line 1061 of file session.c.

+ Here is the caller graph for this function:

int session_open_app ( u32  app_wrk_index,
session_endpoint_t rmt,
u32  opaque 
)

Definition at line 1026 of file session.c.

int session_open_cl ( u32  app_wrk_index,
session_endpoint_t rmt,
u32  opaque 
)

Definition at line 953 of file session.c.

+ Here is the call graph for this function:

int session_open_vc ( u32  app_wrk_index,
session_endpoint_t rmt,
u32  opaque 
)

Definition at line 991 of file session.c.

+ Here is the call graph for this function:

static void session_program_transport_close ( stream_session_t s)
static

Definition at line 123 of file session.c.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void session_register_transport ( transport_proto_t  transport_proto,
const transport_proto_vft_t vft,
u8  is_ip4,
u32  output_node 
)

Initialize session layer for given transport proto and ip version.

Allocates per session type (transport proto + ip version) data structures and adds arc from session queue node to session type output node.

Definition at line 1329 of file session.c.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

int session_send_ctrl_evt_to_thread ( stream_session_t s,
session_evt_type_t  evt_type 
)

Definition at line 101 of file session.c.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

static int session_send_evt_to_thread ( void *  data,
void *  args,
u32  thread_index,
session_evt_type_t  evt_type 
)
inlinestatic

Definition at line 31 of file session.c.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

int session_send_io_evt_to_thread ( svm_fifo_t f,
session_evt_type_t  evt_type 
)

Definition at line 88 of file session.c.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

int session_send_io_evt_to_thread_custom ( void *  data,
u32  thread_index,
session_evt_type_t  evt_type 
)

Definition at line 94 of file session.c.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void session_send_rpc_evt_to_thread ( u32  thread_index,
void *  fp,
void *  rpc_args 
)

Definition at line 111 of file session.c.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

int session_stop_listen ( stream_session_t s)

Ask transport to stop listening on local transport endpoint.

Parameters
sSession to stop listening on. It must be in state LISTENING.

Definition at line 1106 of file session.c.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

int session_stream_connect_notify ( transport_connection_t tc,
u8  is_fail 
)

Definition at line 630 of file session.c.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

static void session_switch_pool ( void *  cb_args)
static

Definition at line 716 of file session.c.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void session_transport_cleanup ( stream_session_t s)

Cleanup transport and session state.

Notify transport of the cleanup and free the session. This should be called only if transport reported some error and is already closed.

Definition at line 1197 of file session.c.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void session_transport_close ( stream_session_t s)

Notify transport the session can be disconnected.

This should eventually result in a delete notification that allows us to cleanup session state. Called for both active/passive disconnects.

Must be called from the session's thread.

Definition at line 1165 of file session.c.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void session_transport_closed_notify ( transport_connection_t tc)

Notification from transport that session can be closed.

Should be called by transport only if it was closed with non-empty tx fifo and once it decides to begin the closing procedure prior to issuing a delete notify. This gives the chance to the session layer to cleanup any outstanding events.

Definition at line 875 of file session.c.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void session_transport_closing_notify ( transport_connection_t tc)

Notification from transport that connection is being closed.

A disconnect is sent to application but state is not removed. Once disconnect is acknowledged by application, session disconnect is called. Ultimately this leads to close being called on transport (passive close).

Definition at line 794 of file session.c.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void session_transport_delete_notify ( transport_connection_t tc)

Notification from transport that connection is being deleted.

This removes the session if it is still valid. It should be called only on previously fully established sessions. For instance failed connects should call stream_session_connect_notify and indicate that the connect has failed.

Definition at line 820 of file session.c.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void session_transport_reset_notify ( transport_connection_t tc)

Notify application that connection has been reset.

Definition at line 904 of file session.c.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

transport_service_type_t session_transport_service_type ( stream_session_t s)

Definition at line 1211 of file session.c.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

transport_tx_fn_type_t session_transport_tx_fn_type ( stream_session_t s)

Definition at line 1219 of file session.c.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

u32 session_tx_fifo_max_dequeue ( transport_connection_t tc)

Definition at line 498 of file session.c.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

u8 session_tx_is_dgram ( stream_session_t s)

Definition at line 1227 of file session.c.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void session_vpp_event_queues_allocate ( session_manager_main_t smm)

Allocate event queues in the shared-memory segment.

That can either be a newly created memfd segment, that will need to be mapped by all stack users, or the binary api's svm region. The latter is assumed to be already mapped. NOTE that this assumption DOES NOT hold if api clients bootstrap shm api over sockets (i.e. use memfd segments) and vpp uses api svm region for event queues.

Definition at line 1242 of file session.c.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

int stream_session_accept ( transport_connection_t tc,
u32  listener_index,
u8  notify 
)

Accept a stream session.

Optionally ping the server by callback.

Definition at line 923 of file session.c.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

int stream_session_accept_notify ( transport_connection_t tc)

Definition at line 771 of file session.c.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

u32 stream_session_dequeue_drop ( transport_connection_t tc,
u32  max_bytes 
)

Definition at line 515 of file session.c.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void stream_session_init_fifos_pointers ( transport_connection_t tc,
u32  rx_pointer,
u32  tx_pointer 
)

Init fifo tail and head pointers.

Useful if transport uses absolute offsets for tracking ooo segments.

Definition at line 620 of file session.c.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

u8 stream_session_no_space ( transport_connection_t tc,
u32  thread_index,
u16  data_len 
)

Check if we have space in rx fifo to push more bytes.

Definition at line 483 of file session.c.

+ Here is the call graph for this function:

int stream_session_peek_bytes ( transport_connection_t tc,
u8 buffer,
u32  offset,
u32  max_bytes 
)

Definition at line 507 of file session.c.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

clib_error_t* vnet_session_enable_disable ( vlib_main_t vm,
u8  is_en 
)

Definition at line 1529 of file session.c.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

Variable Documentation

session_manager_main_t session_manager_main

Definition at line 27 of file session.c.

session_open_service_fn session_open_srv_fns[TRANSPORT_N_SERVICES]
static
Initial value:
= {
}
int session_open_vc(u32 app_wrk_index, session_endpoint_t *rmt, u32 opaque)
Definition: session.c:991
int session_open_cl(u32 app_wrk_index, session_endpoint_t *rmt, u32 opaque)
Definition: session.c:953
int session_open_app(u32 app_wrk_index, session_endpoint_t *rmt, u32 opaque)
Definition: session.c:1026

Definition at line 1040 of file session.c.

session_fifo_rx_fn* session_tx_fns[TRANSPORT_TX_N_FNS]
static
Initial value:
= {
session_tx_fifo_dequeue_and_snd
}
session_fifo_rx_fn session_tx_fifo_peek_and_snd
session_fifo_rx_fn session_tx_fifo_dequeue_and_snd
session_fifo_rx_fn session_tx_fifo_dequeue_internal

Definition at line 1314 of file session.c.

Per-type vector of transport protocol virtual function tables.

Definition at line 23 of file transport.c.