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 (session_t *s, session_evt_type_t evt_type)
void	session_send_rpc_evt_to_thread_force (u32 thread_index, void *fp, void *rpc_args)
void	session_send_rpc_evt_to_thread (u32 thread_index, void *fp, void *rpc_args)
void	session_add_self_custom_tx_evt (transport_connection_t *tc, u8 has_prio)
static void	session_program_transport_ctrl_evt (session_t *s, session_evt_type_t evt)
session_t *	session_alloc (u32 thread_index)
void	session_free (session_t *s)
u8	session_is_valid (u32 si, u8 thread_index)
static void	session_cleanup_notify (session_t *s, session_cleanup_ntf_t ntf)
void	session_free_w_fifos (session_t *s)
static void	session_delete (session_t *s)
	Cleans up session and lookup table. More...
static session_t *	session_alloc_for_connection (transport_connection_t *tc)
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 (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 (session_t *s, session_dgram_hdr_t *hdr, vlib_buffer_t *b, u8 proto, u8 queue_event)
int	session_tx_fifo_peek_bytes (transport_connection_t *tc, u8 *buffer, u32 offset, u32 max_bytes)
u32	session_tx_fifo_dequeue_drop (transport_connection_t *tc, u32 max_bytes)
static int	session_notify_subscribers (u32 app_index, session_t *s, svm_fifo_t *f, session_evt_type_t evt_type)
static int	session_enqueue_notify_inline (session_t *s)
	Notify session peer that new data has been enqueued. More...
int	session_enqueue_notify (session_t *s)
static void	session_enqueue_notify_rpc (void *arg)
void	session_enqueue_notify_thread (session_handle_t sh)
	Like session_enqueue_notify, but can be called from a thread that does not own the session. More...
int	session_dequeue_notify (session_t *s)
int	session_main_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_main_flush_all_enqueue_events (u8 transport_proto)
static int	session_stream_connect_notify_inline (transport_connection_t *tc, u8 is_fail, session_state_t opened_state)
int	session_stream_connect_notify (transport_connection_t *tc, u8 is_fail)
int	session_ho_stream_connect_notify (transport_connection_t *tc, u8 is_fail)
static void	session_switch_pool (void *cb_args)
	Notify old thread of the session pool switch. More...
int	session_dgram_connect_notify (transport_connection_t *tc, u32 old_thread_index, session_t **new_session)
	Move dgram session to the right thread. More...
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 it is closed. More...
void	session_transport_reset_notify (transport_connection_t *tc)
	Notify application that connection has been reset. More...
int	session_stream_accept_notify (transport_connection_t *tc)
int	session_stream_accept (transport_connection_t *tc, u32 listener_index, u32 thread_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 (session_t *ls, session_endpoint_cfg_t *sep)
	Ask transport to listen on session endpoint. More...
int	session_stop_listen (session_t *s)
	Ask transport to stop listening on local transport endpoint. More...
void	session_close (session_t *s)
	Initialize session closing procedure. More...
void	session_reset (session_t *s)
	Force a close without waiting for data to be flushed. More...
void	session_transport_close (session_t *s)
	Notify transport the session can be disconnected. More...
void	session_transport_reset (session_t *s)
	Force transport close. More...
void	session_transport_cleanup (session_t *s)
	Cleanup transport and session state. More...
void	session_vpp_event_queues_allocate (session_main_t *smm)
	Allocate event queues in the shared-memory segment. More...
ssvm_private_t *	session_main_get_evt_q_segment (void)
u64	session_segment_handle (session_t *s)
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_t *	session_get_transport (session_t *s)
void	session_get_endpoint (session_t *s, transport_endpoint_t *tep, u8 is_lcl)
transport_connection_t *	listen_session_get_transport (session_t *s)
void	session_flush_frames_main_thread (vlib_main_t *vm)
static clib_error_t *	session_manager_main_enable (vlib_main_t *vm)
void	session_node_enable_disable (u8 is_en)
clib_error_t *	vnet_session_enable_disable (vlib_main_t *vm, u8 is_en)
clib_error_t *	session_manager_main_init (vlib_main_t *vm)
static clib_error_t *	session_main_init (vlib_main_t *vm)
static clib_error_t *	session_config_fn (vlib_main_t *vm, unformat_input_t *input)

Variables
session_main_t	session_main
static session_open_service_fn	session_open_srv_fns [TRANSPORT_N_SERVICES]
static session_fifo_rx_fn *	session_tx_fns [TRANSPORT_TX_N_FNS]

Detailed Description

Session and session manager.

Definition in file session.c.

Typedef Documentation

session_open_service_fn

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

Definition at line 1123 of file session.c.

session_switch_pool_args_t

typedef struct _session_switch_pool_args session_switch_pool_args_t

Function Documentation

listen_session_get_transport()

transport_connection_t* listen_session_get_transport

(

session_t *

s

)

Definition at line 1484 of file session.c.

Here is the call graph for this function:

Here is the caller graph for this function:

session_add_self_custom_tx_evt()

void session_add_self_custom_tx_evt	(	transport_connection_t *	tc,
		u8	has_prio
	)

Definition at line 123 of file session.c.

Here is the call graph for this function:

Here is the caller graph for this function:

session_alloc()

session_t* session_alloc

(

u32

thread_index

)

Definition at line 170 of file session.c.

Here is the call graph for this function:

Here is the caller graph for this function:

session_alloc_for_connection()

static session_t* session_alloc_for_connection ( transport_connection_t *  tc )

static

Definition at line 272 of file session.c.

Here is the call graph for this function:

Here is the caller graph for this function:

session_cleanup_notify()

static void session_cleanup_notify ( session_t *  s, session_cleanup_ntf_t  ntf  )

static

Definition at line 236 of file session.c.

Here is the call graph for this function:

Here is the caller graph for this function:

session_close()

void session_close

(

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

Here is the call graph for this function:

Here is the caller graph for this function:

session_config_fn()

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

static

Definition at line 1660 of file session.c.

Here is the call graph for this function:

session_delete()

static void session_delete ( session_t *  s )

static

Cleans up session and lookup table.

Transport connection must still be valid.

Definition at line 260 of file session.c.

Here is the call graph for this function:

Here is the caller graph for this function:

session_dequeue_notify()

int session_dequeue_notify

(

session_t *

s

)

Definition at line 629 of file session.c.

Here is the call graph for this function:

Here is the caller graph for this function:

session_dgram_connect_notify()

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

Move dgram session to the right thread.

Definition at line 815 of file session.c.

Here is the call graph for this function:

Here is the caller graph for this function:

session_enqueue_chain_tail()

static int session_enqueue_chain_tail ( session_t *  s, vlib_buffer_t *  b, u32  offset, u8  is_in_order  )

inlinestatic

Enqueue buffer chain tail.

Definition at line 327 of file session.c.

Here is the call graph for this function:

Here is the caller graph for this function:

session_enqueue_dgram_connection()

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

Definition at line 467 of file session.c.

Here is the call graph for this function:

Here is the caller graph for this function:

session_enqueue_discard_chain_bytes()

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

Here is the call graph for this function:

Here is the caller graph for this function:

session_enqueue_notify()

int session_enqueue_notify

(

session_t *

s

)

Definition at line 591 of file session.c.

Here is the call graph for this function:

Here is the caller graph for this function:

session_enqueue_notify_inline()

static int session_enqueue_notify_inline ( session_t *  s )

inlinestatic

Notify session peer that new data has been enqueued.

Parameters

s	Stream session for which the event is to be generated.
lock	Flag to indicate if call should lock message queue.

Returns

0 on success or negative number if failed to send notification.

Definition at line 557 of file session.c.

Here is the call graph for this function:

Here is the caller graph for this function:

session_enqueue_notify_rpc()

static void session_enqueue_notify_rpc ( void *  arg )

static

Definition at line 597 of file session.c.

Here is the call graph for this function:

Here is the caller graph for this function:

session_enqueue_notify_thread()

void session_enqueue_notify_thread

(

session_handle_t

sh

)

Like session_enqueue_notify, but can be called from a thread that does not own the session.

Definition at line 614 of file session.c.

Here is the call graph for this function:

Here is the caller graph for this function:

session_enqueue_stream_connection()

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

Here is the call graph for this function:

Here is the caller graph for this function:

session_flush_frames_main_thread()

void session_flush_frames_main_thread

(

vlib_main_t *

vm

)

Definition at line 1491 of file session.c.

Here is the call graph for this function:

Here is the caller graph for this function:

session_free()

void session_free

(

session_t *

s

)

Definition at line 196 of file session.c.

Here is the call graph for this function:

Here is the caller graph for this function:

session_free_w_fifos()

void session_free_w_fifos

(

session_t *

s

)

Definition at line 247 of file session.c.

Here is the call graph for this function:

Here is the caller graph for this function:

session_get_endpoint()

void session_get_endpoint	(	session_t *	s,
		transport_endpoint_t *	tep,
		u8	is_lcl
	)

Definition at line 1472 of file session.c.

Here is the call graph for this function:

Here is the caller graph for this function:

session_get_transport()

transport_connection_t* session_get_transport

(

session_t *

s

)

Definition at line 1461 of file session.c.

Here is the call graph for this function:

Here is the caller graph for this function:

session_ho_stream_connect_notify()

int session_ho_stream_connect_notify	(	transport_connection_t *	tc,
		u8	is_fail
	)

Definition at line 764 of file session.c.

Here is the call graph for this function:

Here is the caller graph for this function:

session_is_valid()

u8 session_is_valid	(	u32	si,
		u8	thread_index
	)

Definition at line 210 of file session.c.

Here is the call graph for this function:

Here is the caller graph for this function:

session_listen()

int session_listen	(	session_t *	ls,
		session_endpoint_cfg_t *	sep
	)

Ask transport to listen on session endpoint.

Parameters

s	Session for which listen will be called. Note that unlike established sessions, listen sessions are not associated to a thread.
sep	Local endpoint to be listened on.

Definition at line 1163 of file session.c.

Here is the call graph for this function:

Here is the caller graph for this function:

session_main_flush_all_enqueue_events()

int session_main_flush_all_enqueue_events

(

u8

transport_proto

)

Definition at line 688 of file session.c.

Here is the call graph for this function:

session_main_flush_enqueue_events()

int session_main_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 659 of file session.c.

Here is the call graph for this function:

Here is the caller graph for this function:

session_main_get_evt_q_segment()

ssvm_private_t* session_main_get_evt_q_segment

(

void

)

Definition at line 1394 of file session.c.

Here is the caller graph for this function:

session_main_init()

static clib_error_t* session_main_init ( vlib_main_t *  vm )

static

Definition at line 1644 of file session.c.

Here is the call graph for this function:

session_manager_main_enable()

static clib_error_t* session_manager_main_enable ( vlib_main_t *  vm )

static

Definition at line 1499 of file session.c.

Here is the call graph for this function:

Here is the caller graph for this function:

session_manager_main_init()

clib_error_t* session_manager_main_init

(

vlib_main_t *

vm

)

Definition at line 1627 of file session.c.

session_node_enable_disable()

void session_node_enable_disable

(

u8

is_en

)

Definition at line 1572 of file session.c.

Here is the call graph for this function:

Here is the caller graph for this function:

session_notify_subscribers()

static int session_notify_subscribers ( u32  app_index, session_t *  s, svm_fifo_t *  f, session_evt_type_t  evt_type  )

inlinestatic

Definition at line 525 of file session.c.

Here is the call graph for this function:

Here is the caller graph for this function:

session_open()

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

Here is the call graph for this function:

Here is the caller graph for this function:

session_open_app()

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

Definition at line 1112 of file session.c.

Here is the call graph for this function:

session_open_cl()

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

Definition at line 1039 of file session.c.

Here is the call graph for this function:

session_open_vc()

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

Definition at line 1075 of file session.c.

Here is the call graph for this function:

session_program_transport_ctrl_evt()

static void session_program_transport_ctrl_evt ( session_t *  s, session_evt_type_t  evt  )

static

Definition at line 149 of file session.c.

Here is the call graph for this function:

Here is the caller graph for this function:

session_register_transport()

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

Here is the call graph for this function:

Here is the caller graph for this function:

session_reset()

void session_reset

(

session_t *

s

)

Force a close without waiting for data to be flushed.

Definition at line 1239 of file session.c.

Here is the call graph for this function:

Here is the caller graph for this function:

session_segment_handle()

u64 session_segment_handle

(

session_t *

s

)

Definition at line 1403 of file session.c.

Here is the call graph for this function:

Here is the caller graph for this function:

session_send_ctrl_evt_to_thread()

int session_send_ctrl_evt_to_thread	(	session_t *	s,
		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:

session_send_evt_to_thread()

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

inlinestatic

Definition at line 29 of file session.c.

Here is the call graph for this function:

Here is the caller graph for this function:

session_send_io_evt_to_thread()

int session_send_io_evt_to_thread	(	svm_fifo_t *	f,
		session_evt_type_t	evt_type
	)

Definition at line 80 of file session.c.

Here is the call graph for this function:

Here is the caller graph for this function:

session_send_io_evt_to_thread_custom()

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

Definition at line 87 of file session.c.

Here is the call graph for this function:

Here is the caller graph for this function:

session_send_rpc_evt_to_thread()

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:

session_send_rpc_evt_to_thread_force()

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

Definition at line 103 of file session.c.

Here is the call graph for this function:

Here is the caller graph for this function:

session_stop_listen()

int session_stop_listen

(

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

Here is the call graph for this function:

Here is the caller graph for this function:

session_stream_accept()

int session_stream_accept	(	transport_connection_t *	tc,
		u32	listener_index,
		u32	thread_index,
		u8	notify
	)

Accept a stream session.

Optionally ping the server by callback.

Definition at line 1013 of file session.c.

Here is the call graph for this function:

Here is the caller graph for this function:

session_stream_accept_notify()

int session_stream_accept_notify

(

transport_connection_t *

tc

)

Definition at line 996 of file session.c.

Here is the call graph for this function:

Here is the caller graph for this function:

session_stream_connect_notify()

int session_stream_connect_notify	(	transport_connection_t *	tc,
		u8	is_fail
	)

Definition at line 757 of file session.c.

Here is the call graph for this function:

Here is the caller graph for this function:

session_stream_connect_notify_inline()

static int session_stream_connect_notify_inline ( transport_connection_t *  tc, u8  is_fail, session_state_t  opened_state  )

inlinestatic

Definition at line 698 of file session.c.

Here is the call graph for this function:

Here is the caller graph for this function:

session_switch_pool()

static void session_switch_pool ( void *  cb_args )

static

Notify old thread of the session pool switch.

Definition at line 782 of file session.c.

Here is the call graph for this function:

Here is the caller graph for this function:

session_transport_cleanup()

void session_transport_cleanup

(

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

Here is the call graph for this function:

Here is the caller graph for this function:

session_transport_close()

void session_transport_close

(

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

Here is the call graph for this function:

Here is the caller graph for this function:

session_transport_closed_notify()

void session_transport_closed_notify

(

transport_connection_t *

tc

)

Notification from transport that it is closed.

Should be called by transport, prior to calling delete notify, once it knows that no more data will be exchanged. This could serve as an early acknowledgment of an active close especially if transport delete can be delayed a long time, e.g., tcp time-wait.

Definition at line 946 of file session.c.

Here is the call graph for this function:

Here is the caller graph for this function:

session_transport_closing_notify()

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

Here is the call graph for this function:

Here is the caller graph for this function:

session_transport_delete_notify()

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

Here is the call graph for this function:

Here is the caller graph for this function:

session_transport_reset()

void session_transport_reset

(

session_t *

s

)

Force transport close.

Definition at line 1285 of file session.c.

Here is the call graph for this function:

Here is the caller graph for this function:

session_transport_reset_notify()

void session_transport_reset_notify

(

transport_connection_t *

tc

)

Notify application that connection has been reset.

Definition at line 981 of file session.c.

Here is the call graph for this function:

Here is the caller graph for this function:

session_tx_fifo_dequeue_drop()

u32 session_tx_fifo_dequeue_drop	(	transport_connection_t *	tc,
		u32	max_bytes
	)

Definition at line 511 of file session.c.

Here is the call graph for this function:

Here is the caller graph for this function:

session_tx_fifo_peek_bytes()

int session_tx_fifo_peek_bytes	(	transport_connection_t *	tc,
		u8 *	buffer,
		u32	offset,
		u32	max_bytes
	)

Definition at line 503 of file session.c.

Here is the call graph for this function:

Here is the caller graph for this function:

session_vpp_event_queues_allocate()

void session_vpp_event_queues_allocate

(

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

Here is the call graph for this function:

Here is the caller graph for this function:

vnet_session_enable_disable()

clib_error_t* vnet_session_enable_disable	(	vlib_main_t *	vm,
		u8	is_en
	)

Definition at line 1606 of file session.c.

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

session_main

session_main_t session_main

Definition at line 26 of file session.c.

session_open_srv_fns

session_open_service_fn session_open_srv_fns[TRANSPORT_N_SERVICES]

static

Initial value:

= {
  session_open_vc,
  session_open_cl,
  session_open_app,
}

Definition at line 1126 of file session.c.

session_tx_fns

session_fifo_rx_fn* session_tx_fns[TRANSPORT_TX_N_FNS]

static

Initial value:

= {
    session_tx_fifo_peek_and_snd,
    session_tx_fifo_dequeue_and_snd,
    session_tx_fifo_dequeue_internal,
    session_tx_fifo_dequeue_and_snd
}

Definition at line 1416 of file session.c.