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	SESSION_PROXY_LISTENER_INDEX   ((u32)~0 - 1)
#define	MAX_HDRS_LEN   100 /* Max number of bytes for headers */
#define	foreach_session_input_error
#define	session_cli_return_if_not_enabled()

Typedefs
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 }

Functions
static const char *	fifo_event_type_str (fifo_event_type_t et)
typedef	CLIB_PACKED (struct{union{svm_fifo_t *fifo;u64 session_handle;rpc_args_t rpc_args;};u8 event_type;u8 postponed;}) session_fifo_event_t
u8	session_node_lookup_fifo_event (svm_fifo_t *f, session_fifo_event_t *e)
static session_manager_main_t *	vnet_get_session_manager_main ()
static u8	stream_session_is_valid (u32 si, u8 thread_index)
stream_session_t *	session_alloc (u32 thread_index)
static stream_session_t *	session_get (u32 si, u32 thread_index)
static stream_session_t *	session_get_if_valid (u64 si, u32 thread_index)
static u64	session_handle (stream_session_t *s)
static u32	session_index_from_handle (u64 handle)
static u32	session_thread_from_handle (u64 handle)
static void	session_parse_handle (u64 handle, u32 *index, u32 *thread_index)
static stream_session_t *	session_get_from_handle (u64 handle)
static transport_proto_t	session_get_transport_proto (stream_session_t *s)
static session_type_t	session_type_from_proto_and_ip (transport_proto_t proto, u8 is_ip4)
static void	session_pool_add_peeker (u32 thread_index)
	Acquires a lock that blocks a session pool from expanding. More...
static void	session_pool_remove_peeker (u32 thread_index)
static stream_session_t *	session_get_from_handle_safe (u64 handle)
	Get session from handle and 'lock' pool resize if not in same thread. More...
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)
static u32	session_get_index (stream_session_t *s)
static stream_session_t *	session_clone_safe (u32 session_index, u32 thread_index)
transport_connection_t *	session_get_transport (stream_session_t *s)
u32	stream_session_tx_fifo_max_dequeue (transport_connection_t *tc)
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, vlib_buffer_t *b, u8 proto, u8 queue_event)
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	session_stream_connect_notify (transport_connection_t *tc, u8 is_fail)
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...
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 notify)
	Accept a stream session. More...
int	session_open (u32 app_index, session_endpoint_t *tep, u32 opaque)
	Ask transport to open connection to remote transport endpoint. More...
int	stream_session_listen (stream_session_t *s, session_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...
uword	unformat_stream_session (unformat_input_t *input, va_list *args)
uword	unformat_transport_connection (unformat_input_t *input, va_list *args)
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...
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 (u8 proto, 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)
transport_connection_t *	listen_session_get_transport (stream_session_t *s)
int	listen_session_get_local_session_endpoint (stream_session_t *listener, session_endpoint_t *sep)
static stream_session_t *	session_manager_get_listener (u8 session_type, u32 index)
static void	session_manager_set_transport_rx_fn (session_type_t type, u8 is_peek)
	Set peek or dequeue function for given session type. More...
static u8	session_manager_is_enabled ()
void	session_node_enable_disable (u8 is_en)

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 64 of file session.h.

#define HALF_OPEN_LOOKUP_INVALID_VALUE   ((u64)~0)

Definition at line 25 of file session.h.

#define INVALID_INDEX   ((u32)~0)

Definition at line 26 of file session.h.

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

Definition at line 30 of file session.h.

#define session_cli_return_if_not_enabled

(

)

Value:

do {                                                                    \
    if (!session_manager_main.is_enabled)                               \
      return clib_error_return(0, "session layer is not enabled");      \
} while (0)

Definition at line 550 of file session.h.

#define SESSION_PROXY_LISTENER_INDEX   ((u32)~0 - 1)

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 106 of file session.h.

typedef struct _session_manager_main session_manager_main_t

Definition at line 103 of file session.h.

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 32 of file session.h.

enum session_error_t

Enumerator
SESSION_N_ERROR

Definition at line 75 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;u8 postponed;}

)

static const char* fifo_event_type_str ( fifo_event_type_t  et )

inlinestatic

Definition at line 43 of file session.h.

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 52 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 513 of file session.h.

Here is the call graph for this function:

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 506 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 474 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 467 of file session.h.

Here is the caller graph for this function:

int listen_session_get_local_session_endpoint	(	stream_session_t *	listener,
		session_endpoint_t *	sep
	)

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

Here is the call graph for this function:

Here is the caller graph for this function:

static stream_session_t* listen_session_new ( session_type_t  type )

inlinestatic

Definition at line 491 of file session.h.

Here is the caller graph for this function:

stream_session_t* session_alloc

(

u32

thread_index

)

Definition at line 80 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_clone_safe ( u32  session_index, u32  thread_index  )

inlinestatic

Definition at line 390 of file session.h.

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 641 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,
		vlib_buffer_t *	b,
		u8	proto,
		u8	queue_event
	)

Definition at line 359 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 304 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_get ( u32  si, u32  thread_index  )

inlinestatic

Definition at line 229 of file session.h.

Here is the call graph for this function:

Here is the caller graph for this function:

static stream_session_t* session_get_from_handle ( u64  handle )

inlinestatic

Definition at line 274 of file session.h.

Here is the call graph for this function:

Here is the caller graph for this function:

static stream_session_t* session_get_from_handle_safe ( u64  handle )

inlinestatic

Get session from handle and 'lock' pool resize if not in same thread.

Caller should drop the peek 'lock' as soon as possible.

Definition at line 337 of file session.h.

Here is the call graph for this function:

Here is the caller graph for this function:

static stream_session_t* session_get_if_valid ( u64  si, u32  thread_index  )

inlinestatic

Definition at line 236 of file session.h.

Here is the call graph for this function:

Here is the caller graph for this function:

static u32 session_get_index ( stream_session_t *  s )

inlinestatic

Definition at line 384 of file session.h.

Here is the caller graph for this function:

transport_connection_t* session_get_transport

(

stream_session_t *

s

)

Definition at line 1026 of file session.c.

Here is the call graph for this function:

Here is the caller graph for this function:

static transport_proto_t session_get_transport_proto ( stream_session_t *  s )

inlinestatic

Definition at line 283 of file session.h.

Here is the caller graph for this function:

static u64 session_handle ( stream_session_t *  s )

inlinestatic

Definition at line 249 of file session.h.

Here is the caller graph for this function:

static u32 session_index_from_handle ( u64  handle )

inlinestatic

Definition at line 255 of file session.h.

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_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 510 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_manager_get_listener ( u8  session_type, u32  index  )

inlinestatic

Definition at line 525 of file session.h.

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 459 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 545 of file session.h.

Here is the caller graph for this function:

static void session_manager_set_transport_rx_fn ( session_type_t  type, u8  is_peek  )

inlinestatic

Set peek or dequeue function for given session type.

Reliable transport protocols will probably want to use a peek function

Definition at line 538 of file session.h.

Here is the caller graph for this function:

void session_node_enable_disable

(

u8

is_en

)

Definition at line 1159 of file session.c.

Here is the call graph for this function:

Here is the caller graph for this function:

u8 session_node_lookup_fifo_event	(	svm_fifo_t *	f,
		session_fifo_event_t *	e
	)

Definition at line 486 of file session_node.c.

Here is the call graph for this function:

Here is the caller graph for this function:

int session_open	(	u32	app_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_index	Index of the application requesting the connect
st	Session type requested.
tep	Remote transport endpoint
opaque	Opaque data (typically, api_context) the application expects on open completion.

Definition at line 807 of file session.c.

Here is the call graph for this function:

Here is the caller graph for this function:

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

inlinestatic

Definition at line 267 of file session.h.

Here is the call graph for this function:

Here is the caller graph for this function:

static void session_pool_add_peeker ( u32  thread_index )

inlinestatic

Acquires a lock that blocks a session pool from expanding.

This is typically used for safely peeking into other threads' pools in order to clone elements. Lock should be dropped as soon as possible by calling session_pool_remove_peeker.

NOTE: Avoid using pool_elt_at_index while the lock is held because it may lead to free elt bitmap expansion/contraction!

Definition at line 305 of file session.h.

Here is the call graph for this function:

Here is the caller graph for this function:

static void session_pool_remove_peeker ( u32  thread_index )

inlinestatic

Definition at line 318 of file session.h.

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 999 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 59 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 549 of file session.c.

Here is the call graph for this function:

Here is the caller graph for this function:

static u32 session_thread_from_handle ( u64  handle )

inlinestatic

Definition at line 261 of file session.h.

Here is the caller graph for this function:

static session_type_t session_type_from_proto_and_ip ( transport_proto_t  proto, u8  is_ip4  )

inlinestatic

Definition at line 289 of file session.h.

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 761 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 677 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 948 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 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 732 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 427 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 934 of file session.c.

Here is the call graph for this function:

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 695 of file session.c.

Here is the call graph for this function:

Here is the caller graph for this function:

static u32 stream_session_get_index ( stream_session_t *  s )

inlinestatic

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

Here is the call graph for this function:

Here is the caller graph for this function:

static u8 stream_session_is_valid ( u32  si, u8  thread_index  )

inlinestatic

Definition at line 213 of file session.h.

Here is the call graph for this function:

Here is the caller graph for this function:

int stream_session_listen	(	stream_session_t *	s,
		session_endpoint_t *	sep
	)

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 872 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 355 of file session.h.

static u32 stream_session_max_rx_enqueue ( transport_connection_t *  tc )

inlinestatic

Definition at line 370 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 419 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 747 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 377 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 904 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 410 of file session.c.

Here is the call graph for this function:

Here is the caller graph for this function:

uword unformat_stream_session	(	unformat_input_t *	input,
		va_list *	args
	)

Definition at line 133 of file session_cli.c.

Here is the call graph for this function:

Here is the caller graph for this function:

uword unformat_transport_connection	(	unformat_input_t *	input,
		va_list *	args
	)

Definition at line 164 of file session_cli.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 207 of file session.h.

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 1171 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.

vlib_node_registration_t session_queue_node

Initial value:

=
{
  .function = session_queue_node_fn,
  .name = "session-queue",
  .format_trace = format_session_queue_trace,
  .type = VLIB_NODE_TYPE_INPUT,
  .n_errors = ARRAY_LEN (session_queue_error_strings),
  .error_strings = session_queue_error_strings,
  .state = VLIB_NODE_STATE_DISABLED,
}

(constructor) VLIB_REGISTER_NODE (session_queue_node)

Definition at line 46 of file session_node.c.

session_fifo_rx_fn session_tx_fifo_dequeue_and_snd

session_fifo_rx_fn session_tx_fifo_peek_and_snd