FD.io VPP  v17.07.01-10-g3be13f0
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.

Functions

void stream_session_table_add_for_tc (transport_connection_t *tc, u64 value)
 
void stream_session_table_add (session_manager_main_t *smm, stream_session_t *s, u64 value)
 
static void stream_session_half_open_table_add (session_type_t sst, transport_connection_t *tc, u64 value)
 
int stream_session_table_del_for_tc (transport_connection_t *tc)
 
static int stream_session_table_del (session_manager_main_t *smm, stream_session_t *s)
 
static void stream_session_half_open_table_del (session_manager_main_t *smm, u8 sst, transport_connection_t *tc)
 
stream_session_tstream_session_lookup_listener4 (ip4_address_t *lcl, u16 lcl_port, u8 proto)
 
stream_session_tstream_session_lookup4 (ip4_address_t *lcl, ip4_address_t *rmt, u16 lcl_port, u16 rmt_port, u8 proto, u32 my_thread_index)
 Looks up a session based on the 5-tuple passed as argument. More...
 
stream_session_tstream_session_lookup_listener6 (ip6_address_t *lcl, u16 lcl_port, u8 proto)
 
stream_session_tstream_session_lookup6 (ip6_address_t *lcl, ip6_address_t *rmt, u16 lcl_port, u16 rmt_port, u8 proto, u32 my_thread_index)
 
stream_session_tstream_session_lookup_listener (ip46_address_t *lcl, u16 lcl_port, u8 proto)
 
static u64 stream_session_half_open_lookup (session_manager_main_t *smm, ip46_address_t *lcl, ip46_address_t *rmt, u16 lcl_port, u16 rmt_port, u8 proto)
 
transport_connection_tstream_session_lookup_transport4 (ip4_address_t *lcl, ip4_address_t *rmt, u16 lcl_port, u16 rmt_port, u8 proto, u32 my_thread_index)
 
transport_connection_tstream_session_lookup_transport6 (ip6_address_t *lcl, ip6_address_t *rmt, u16 lcl_port, u16 rmt_port, u8 proto, u32 my_thread_index)
 
int stream_session_create_i (segment_manager_t *sm, transport_connection_t *tc, stream_session_t **ret_s)
 
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 stream_session_enqueue_data (transport_connection_t *tc, vlib_buffer_t *b, u32 offset, u8 queue_event, u8 is_in_order)
 
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 stream_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 stream_session_enqueue_notify (stream_session_t *s, u8 block)
 Notify session peer that new data has been enqueued. More...
 
int session_manager_flush_enqueue_events (u32 thread_index)
 Flushes queue of sessions that are to be notified of new data enqueued events. More...
 
void stream_session_init_fifos_pointers (transport_connection_t *tc, u32 rx_pointer, u32 tx_pointer)
 Init fifo tail and head pointers. More...
 
int stream_session_connect_notify (transport_connection_t *tc, u8 sst, u8 is_fail)
 
void stream_session_accept_notify (transport_connection_t *tc)
 
void stream_session_disconnect_notify (transport_connection_t *tc)
 Notification from transport that connection is being closed. More...
 
void stream_session_delete (stream_session_t *s)
 Cleans up session and associated app if needed. More...
 
void stream_session_delete_notify (transport_connection_t *tc)
 Notification from transport that connection is being deleted. More...
 
void stream_session_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 sst, u8 notify)
 Accept a stream session. More...
 
int stream_session_open (u32 app_index, session_type_t st, transport_endpoint_t *tep, transport_connection_t **res)
 Ask transport to open connection to remote transport endpoint. More...
 
int stream_session_listen (stream_session_t *s, transport_endpoint_t *tep)
 Ask transport to listen on local transport endpoint. More...
 
int stream_session_stop_listen (stream_session_t *s)
 Ask transport to stop listening on local transport endpoint. More...
 
void session_send_session_evt_to_thread (u64 session_handle, fifo_event_type_t evt_type, u32 thread_index)
 
void stream_session_disconnect (stream_session_t *s)
 Disconnect session and propagate to transport. More...
 
void stream_session_cleanup (stream_session_t *s)
 Cleanup transport and session state. More...
 
void session_register_transport (u8 type, const transport_proto_vft_t *vft)
 
transport_proto_vft_tsession_get_transport_vft (u8 type)
 
void session_vpp_event_queue_allocate (session_manager_main_t *smm, u32 thread_index)
 Allocate vpp event queue (once) per worker thread. More...
 
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)
 
vlib_init_function_t *static _vlib_init_function_session_manager_main_init clib_error_tsession_config_fn (vlib_main_t *vm, unformat_input_t *input)
 (constructor) VLIB_INIT_FUNCTION (session_manager_main_init) More...
 

Variables

static transport_proto_vft_ttp_vfts
 Per-type vector of transport protocol virtual function tables. More...
 
session_manager_main_t session_manager_main
 

Detailed Description

Session and session manager.

Definition in file session.c.

Function Documentation

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

(constructor) VLIB_INIT_FUNCTION (session_manager_main_init)

Definition at line 1212 of file session.c.

+ Here is the call 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 437 of file session.c.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

transport_proto_vft_t* session_get_transport_vft ( u8  type)

Definition at line 1055 of file session.c.

+ Here is the caller graph for this function:

int session_manager_flush_enqueue_events ( 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 656 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_manager_main_enable ( vlib_main_t vm)
static

Definition at line 1092 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 1200 of file session.c.

+ Here is the call graph for this function:

void session_node_enable_disable ( u8  is_en)

Definition at line 1167 of file session.c.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void session_register_transport ( u8  type,
const transport_proto_vft_t vft 
)

Definition at line 1041 of file session.c.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void session_send_session_evt_to_thread ( u64  session_handle,
fifo_event_type_t  evt_type,
u32  thread_index 
)

Definition at line 973 of file session.c.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void session_vpp_event_queue_allocate ( session_manager_main_t smm,
u32  thread_index 
)

Allocate vpp event queue (once) per worker thread.

Definition at line 1066 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  sst,
u8  notify 
)

Accept a stream session.

Optionally ping the server by callback.

Definition at line 838 of file session.c.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void stream_session_accept_notify ( transport_connection_t tc)

Definition at line 753 of file session.c.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void stream_session_cleanup ( stream_session_t s)

Cleanup transport and session state.

Notify transport of the cleanup, wait for a delete notify to actually remove the session state.

Definition at line 1025 of file session.c.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

int stream_session_connect_notify ( transport_connection_t tc,
u8  sst,
u8  is_fail 
)

Definition at line 704 of file session.c.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

int stream_session_create_i ( segment_manager_t sm,
transport_connection_t tc,
stream_session_t **  ret_s 
)

Definition at line 381 of file session.c.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void stream_session_delete ( stream_session_t s)

Cleans up session and associated app if needed.

Definition at line 785 of file session.c.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void stream_session_delete_notify ( transport_connection_t tc)

Notification from transport that connection is being deleted.

This 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 807 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 583 of file session.c.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void stream_session_disconnect ( stream_session_t s)

Disconnect session and propagate to transport.

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

Should be called from the session's thread.

Definition at line 1012 of file session.c.

+ Here is the caller graph for this function:

void stream_session_disconnect_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 771 of file session.c.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

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

Definition at line 494 of file session.c.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

static int stream_session_enqueue_notify ( stream_session_t s,
u8  block 
)
static

Notify session peer that new data has been enqueued.

Parameters
sStream session for which the event is to be generated.
blockFlag to indicate if call should block if event queue is full.
Returns
0 on succes or negative number if failed to send notification.

Definition at line 598 of file session.c.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

static u64 stream_session_half_open_lookup ( session_manager_main_t smm,
ip46_address_t *  lcl,
ip46_address_t *  rmt,
u16  lcl_port,
u16  rmt_port,
u8  proto 
)
static

Definition at line 279 of file session.c.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

static void stream_session_half_open_table_add ( session_type_t  sst,
transport_connection_t tc,
u64  value 
)
static

Definition at line 78 of file session.c.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

static void stream_session_half_open_table_del ( session_manager_main_t smm,
u8  sst,
transport_connection_t tc 
)
static

Definition at line 146 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 694 of file session.c.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

int stream_session_listen ( stream_session_t s,
transport_endpoint_t tep 
)

Ask transport to listen on local transport endpoint.

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

Definition at line 919 of file session.c.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

stream_session_t* stream_session_lookup4 ( ip4_address_t lcl,
ip4_address_t rmt,
u16  lcl_port,
u16  rmt_port,
u8  proto,
u32  my_thread_index 
)

Looks up a session based on the 5-tuple passed as argument.

First it tries to find an established session, if this fails, it tries finding a listener session if this fails, it tries a lookup with a wildcarded local source (listener bound to all interfaces)

Definition at line 200 of file session.c.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

stream_session_t* stream_session_lookup6 ( ip6_address_t lcl,
ip6_address_t rmt,
u16  lcl_port,
u16  rmt_port,
u8  proto,
u32  my_thread_index 
)

Definition at line 244 of file session.c.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

stream_session_t* stream_session_lookup_listener ( ip46_address_t *  lcl,
u16  lcl_port,
u8  proto 
)

Definition at line 262 of file session.c.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

stream_session_t* stream_session_lookup_listener4 ( ip4_address_t lcl,
u16  lcl_port,
u8  proto 
)

Definition at line 173 of file session.c.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

stream_session_t* stream_session_lookup_listener6 ( ip6_address_t lcl,
u16  lcl_port,
u8  proto 
)

Definition at line 219 of file session.c.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

transport_connection_t* stream_session_lookup_transport4 ( ip4_address_t lcl,
ip4_address_t rmt,
u16  lcl_port,
u16  rmt_port,
u8  proto,
u32  my_thread_index 
)

Definition at line 314 of file session.c.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

transport_connection_t* stream_session_lookup_transport6 ( ip6_address_t lcl,
ip6_address_t rmt,
u16  lcl_port,
u16  rmt_port,
u8  proto,
u32  my_thread_index 
)

Definition at line 348 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 551 of file session.c.

+ Here is the call graph for this function:

int stream_session_open ( u32  app_index,
session_type_t  st,
transport_endpoint_t tep,
transport_connection_t **  res 
)

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
resResulting transport connection .

Definition at line 880 of file session.c.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

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

Definition at line 575 of file session.c.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void stream_session_reset_notify ( transport_connection_t tc)

Notify application that connection has been reset.

Definition at line 824 of file session.c.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

int stream_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 950 of file session.c.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void stream_session_table_add ( session_manager_main_t smm,
stream_session_t s,
u64  value 
)

Definition at line 67 of file session.c.

+ Here is the call graph for this function:

void stream_session_table_add_for_tc ( transport_connection_t tc,
u64  value 
)

Definition at line 40 of file session.c.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

static int stream_session_table_del ( session_manager_main_t smm,
stream_session_t s 
)
static

Definition at line 136 of file session.c.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

int stream_session_table_del_for_tc ( transport_connection_t tc)

Definition at line 108 of file session.c.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

u32 stream_session_tx_fifo_max_dequeue ( transport_connection_t tc)

Definition at line 566 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 1179 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 33 of file session.c.

transport_proto_vft_t* tp_vfts
static

Per-type vector of transport protocol virtual function tables.

Definition at line 31 of file session.c.