session.h File Reference

Include dependency graph for session.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	rpc_args_t

Macros
#define	HALF_OPEN_LOOKUP_INVALID_VALUE   ((u64)~0)
#define	INVALID_INDEX   ((u32)~0)
#define	MAX_HDRS_LEN   100 /* Max number of bytes for headers */
#define	foreach_session_input_error
#define	foreach_session_type

Typedefs
typedef struct _stream_session_t	stream_session_t
typedef struct _session_manager_main	session_manager_main_t
typedef int(	session_fifo_rx_fn) (vlib_main_t *vm, vlib_node_runtime_t *node, session_manager_main_t *smm, session_fifo_event_t *e0, stream_session_t *s0, u32 thread_index, int *n_tx_pkts)

Enumerations
enum	fifo_event_type_t {   FIFO_EVENT_APP_RX, FIFO_EVENT_APP_TX, FIFO_EVENT_TIMEOUT, FIFO_EVENT_DISCONNECT,   FIFO_EVENT_BUILTIN_RX, FIFO_EVENT_RPC }
enum	session_error_t { SESSION_N_ERROR }
enum	session_queue_next_t {   SESSION_QUEUE_NEXT_DROP, SESSION_QUEUE_NEXT_TCP_IP4_OUTPUT, SESSION_QUEUE_NEXT_IP4_LOOKUP, SESSION_QUEUE_NEXT_TCP_IP6_OUTPUT,   SESSION_QUEUE_NEXT_IP6_LOOKUP, SESSION_QUEUE_N_NEXT }
enum	session_type_t { SESSION_N_TYPES }
enum	stream_session_state_t {   SESSION_STATE_LISTENING, SESSION_STATE_CONNECTING, SESSION_STATE_READY, SESSION_STATE_CLOSED,   SESSION_STATE_N_STATES }

Functions
typedef	CLIB_PACKED (struct{union{svm_fifo_t *fifo;u64 session_handle;rpc_args_t rpc_args;};u8 event_type;u16 event_id;}) session_fifo_event_t
static session_manager_main_t *	vnet_get_session_manager_main ()
stream_session_t *	stream_session_lookup_listener4 (ip4_address_t *lcl, u16 lcl_port, u8 proto)
stream_session_t *	stream_session_lookup4 (ip4_address_t *lcl, ip4_address_t *rmt, u16 lcl_port, u16 rmt_port, u8 proto, u32 thread_index)
	Looks up a session based on the 5-tuple passed as argument. More...
stream_session_t *	stream_session_lookup_listener6 (ip6_address_t *lcl, u16 lcl_port, u8 proto)
stream_session_t *	stream_session_lookup6 (ip6_address_t *lcl, ip6_address_t *rmt, u16 lcl_port, u16 rmt_port, u8, u32 thread_index)
transport_connection_t *	stream_session_lookup_transport4 (ip4_address_t *lcl, ip4_address_t *rmt, u16 lcl_port, u16 rmt_port, u8 proto, u32 thread_index)
transport_connection_t *	stream_session_lookup_transport6 (ip6_address_t *lcl, ip6_address_t *rmt, u16 lcl_port, u16 rmt_port, u8 proto, u32 thread_index)
stream_session_t *	stream_session_lookup_listener (ip46_address_t *lcl, u16 lcl_port, u8 proto)
void	stream_session_table_add_for_tc (transport_connection_t *tc, u64 value)
int	stream_session_table_del_for_tc (transport_connection_t *tc)
static stream_session_t *	stream_session_get_tsi (u64 ti_and_si, u32 thread_index)
static stream_session_t *	stream_session_get (u32 si, u32 thread_index)
static stream_session_t *	stream_session_get_if_valid (u64 si, u32 thread_index)
static u64	stream_session_handle (stream_session_t *s)
static u32	stream_session_index_from_handle (u64 handle)
static u32	stream_session_thread_from_handle (u64 handle)
static void	stream_session_parse_handle (u64 handle, u32 *index, u32 *thread_index)
static stream_session_t *	stream_session_get_from_handle (u64 handle)
static stream_session_t *	stream_session_listener_get (u8 sst, u64 si)
static u32	stream_session_get_index (stream_session_t *s)
static u32	stream_session_max_rx_enqueue (transport_connection_t *tc)
static u32	stream_session_rx_fifo_size (transport_connection_t *tc)
u32	stream_session_tx_fifo_max_dequeue (transport_connection_t *tc)
int	stream_session_enqueue_data (transport_connection_t *tc, vlib_buffer_t *b, u32 offset, u8 queue_event, u8 is_in_order)
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)
int	stream_session_connect_notify (transport_connection_t *tc, u8 sst, u8 is_fail)
void	stream_session_init_fifos_pointers (transport_connection_t *tc, u32 rx_pointer, u32 tx_pointer)
	Init fifo tail and head pointers. More...
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_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 **tc)
	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	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_send_session_evt_to_thread (u64 session_handle, fifo_event_type_t evt_type, u32 thread_index)
u8 *	format_stream_session (u8 *s, va_list *args)
	Format stream session as per the following format. More...
int	send_session_connected_callback (u32 app_index, u32 api_context, stream_session_t *s, u8 is_fail)
void	session_register_transport (u8 type, const transport_proto_vft_t *vft)
transport_proto_vft_t *	session_get_transport_vft (u8 type)
clib_error_t *	vnet_session_enable_disable (vlib_main_t *vm, u8 is_en)
static unix_shared_memory_queue_t *	session_manager_get_vpp_event_queue (u32 thread_index)
int	session_manager_flush_enqueue_events (u32 thread_index)
	Flushes queue of sessions that are to be notified of new data enqueued events. More...
static u64	listen_session_get_handle (stream_session_t *s)
static stream_session_t *	listen_session_get_from_handle (u64 handle)
static stream_session_t *	listen_session_new (session_type_t type)
static stream_session_t *	listen_session_get (session_type_t type, u32 index)
static void	listen_session_del (stream_session_t *s)
static u8	session_manager_is_enabled ()

Variables
session_fifo_rx_fn	session_tx_fifo_peek_and_snd
session_fifo_rx_fn	session_tx_fifo_dequeue_and_snd
session_manager_main_t	session_manager_main
vlib_node_registration_t	session_queue_node
	(constructor) VLIB_REGISTER_NODE (session_queue_node) More...

Macro Definition Documentation

#define foreach_session_input_error

Value:

_(NO_SESSION, "No session drops")                                       \
_(NO_LISTENER, "No listener for dst port drops")                        \
_(ENQUEUED, "Packets pushed into rx fifo")                              \
_(NOT_READY, "Session not ready packets")                               \
_(FIFO_FULL, "Packets dropped for lack of rx fifo space")               \
_(EVENT_FIFO_FULL, "Events not sent for lack of event fifo space")      \
_(API_QUEUE_FULL, "Sessions not created for lack of API queue space")   \
_(NEW_SEG_NO_SPACE, "Created segment, couldn't allocate a fifo pair")   \
_(NO_SPACE, "Couldn't allocate a fifo pair")

Definition at line 39 of file session.h.

#define foreach_session_type

Value:

_(IP4_TCP, ip4_tcp)                           \
  _(IP4_UDP, ip4_udp)                           \
  _(IP6_TCP, ip6_tcp)                           \
  _(IP6_UDP, ip6_udp)

Definition at line 69 of file session.h.

#define HALF_OPEN_LOOKUP_INVALID_VALUE   ((u64)~0)

Definition at line 23 of file session.h.

#define INVALID_INDEX   ((u32)~0)

Definition at line 24 of file session.h.

#define MAX_HDRS_LEN   100 /* Max number of bytes for headers */

Definition at line 27 of file session.h.

Typedef Documentation

typedef int( session_fifo_rx_fn) (vlib_main_t *vm, vlib_node_runtime_t *node, session_manager_main_t *smm, session_fifo_event_t *e0, stream_session_t *s0, u32 thread_index, int *n_tx_pkts)

Definition at line 160 of file session.h.

typedef struct _session_manager_main session_manager_main_t

Definition at line 157 of file session.h.

typedef struct _stream_session_t stream_session_t

Enumeration Type Documentation

enum fifo_event_type_t

Enumerator
FIFO_EVENT_APP_RX
FIFO_EVENT_APP_TX
FIFO_EVENT_TIMEOUT
FIFO_EVENT_DISCONNECT
FIFO_EVENT_BUILTIN_RX
FIFO_EVENT_RPC

Definition at line 29 of file session.h.

enum session_error_t

Enumerator
SESSION_N_ERROR

Definition at line 50 of file session.h.

enum session_queue_next_t

Enumerator
SESSION_QUEUE_NEXT_DROP
SESSION_QUEUE_NEXT_TCP_IP4_OUTPUT
SESSION_QUEUE_NEXT_IP4_LOOKUP
SESSION_QUEUE_NEXT_TCP_IP6_OUTPUT
SESSION_QUEUE_NEXT_IP6_LOOKUP
SESSION_QUEUE_N_NEXT

Definition at line 59 of file session.h.

enum session_type_t

Enumerator
SESSION_N_TYPES

Definition at line 75 of file session.h.

enum stream_session_state_t

Enumerator
SESSION_STATE_LISTENING
SESSION_STATE_CONNECTING
SESSION_STATE_READY
SESSION_STATE_CLOSED
SESSION_STATE_N_STATES

Definition at line 86 of file session.h.

Function Documentation

typedef CLIB_PACKED

(

struct{union{svm_fifo_t *fifo;u64 session_handle;rpc_args_t rpc_args;};u8 event_type;u16 event_id;}

)

u8* format_stream_session	(	u8 *	s,
		va_list *	args
	)

Format stream session as per the following format.

verbose: "Connection", "Rx fifo", "Tx fifo", "Session Index" non-verbose: "Connection"

Definition at line 36 of file session_cli.c.

Here is the call graph for this function:

Here is the caller graph for this function:

static void listen_session_del ( stream_session_t *  s )

inlinestatic

Definition at line 460 of file session.h.

Here is the caller graph for this function:

static stream_session_t* listen_session_get ( session_type_t  type, u32  index  )

inlinestatic

Definition at line 453 of file session.h.

Here is the caller graph for this function:

static stream_session_t* listen_session_get_from_handle ( u64  handle )

inlinestatic

Definition at line 421 of file session.h.

Here is the caller graph for this function:

static u64 listen_session_get_handle ( stream_session_t *  s )

inlinestatic

Definition at line 414 of file session.h.

Here is the caller graph for this function:

static stream_session_t* listen_session_new ( session_type_t  type )

inlinestatic

Definition at line 438 of file session.h.

Here is the caller graph for this function:

int send_session_connected_callback	(	u32	app_index,
		u32	api_context,
		stream_session_t *	s,
		u8	is_fail
	)

Definition at line 155 of file session_api.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_index

Thread 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 unix_shared_memory_queue_t* session_manager_get_vpp_event_queue ( u32  thread_index )

inlinestatic

Definition at line 406 of file session.h.

Here is the call graph for this function:

Here is the caller graph for this function:

static u8 session_manager_is_enabled ( )

inlinestatic

Definition at line 466 of file session.h.

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:

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:

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 stream_session_t* stream_session_get ( u32  si, u32  thread_index  )

inlinestatic

Definition at line 281 of file session.h.

Here is the caller graph for this function:

static stream_session_t* stream_session_get_from_handle ( u64  handle )

inlinestatic

Definition at line 324 of file session.h.

Here is the call graph for this function:

Here is the caller graph for this function:

static stream_session_t* stream_session_get_if_valid ( u64  si, u32  thread_index  )

inlinestatic

Definition at line 287 of file session.h.

Here is the caller graph for this function:

static u32 stream_session_get_index ( stream_session_t *  s )

inlinestatic

Definition at line 339 of file session.h.

Here is the caller graph for this function:

static stream_session_t* stream_session_get_tsi ( u64  ti_and_si, u32  thread_index  )

inlinestatic

Definition at line 273 of file session.h.

Here is the caller graph for this function:

static u64 stream_session_handle ( stream_session_t *  s )

inlinestatic

Definition at line 299 of file session.h.

Here is the caller graph for this function:

static u32 stream_session_index_from_handle ( u64  handle )

inlinestatic

Definition at line 305 of file session.h.

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

s	Session for which listen will be called. Note that unlike established sessions, listen sessions are not associated to a thread.
tep	Local 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:

static stream_session_t* stream_session_listener_get ( u8  sst, u64  si  )

inlinestatic

Definition at line 333 of file session.h.

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	,
		u32	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	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	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:

static u32 stream_session_max_rx_enqueue ( transport_connection_t *  tc )

inlinestatic

Definition at line 348 of file session.h.

Here is the call graph for this function:

Here is the caller 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_index	Index of the application requesting the connect
st	Session type requested.
tep	Remote transport endpoint
res	Resulting 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:

static void stream_session_parse_handle ( u64  handle, u32 *  index, u32 *  thread_index  )

inlinestatic

Definition at line 317 of file session.h.

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:

static u32 stream_session_rx_fifo_size ( transport_connection_t *  tc )

inlinestatic

Definition at line 355 of file session.h.

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

s	Session 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_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:

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:

static u32 stream_session_thread_from_handle ( u64  handle )

inlinestatic

Definition at line 311 of file session.h.

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:

static session_manager_main_t* vnet_get_session_manager_main ( )

inlinestatic

Definition at line 237 of file session.h.

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.

vlib_node_registration_t session_queue_node

(constructor) VLIB_REGISTER_NODE (session_queue_node)

Definition at line 25 of file node.c.

session_fifo_rx_fn session_tx_fifo_dequeue_and_snd

session_fifo_rx_fn session_tx_fifo_peek_and_snd