session_lookup.h File Reference

Include dependency graph for session_lookup.h:

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

Go to the source code of this file.

Macros
#define	HALF_OPEN_LOOKUP_INVALID_VALUE   ((u64)~0)

Typedefs
typedef enum session_lookup_result_	session_lookup_result_t
typedef enum _session_rule_scope	session_rule_scope_e
typedef struct _session_rule_add_del_args	session_rule_add_del_args_t

Enumerations
enum	session_lookup_result_ { SESSION_LOOKUP_RESULT_NONE, SESSION_LOOKUP_RESULT_WRONG_THREAD, SESSION_LOOKUP_RESULT_FILTERED }

Functions
session_t *	session_lookup_safe4 (u32 fib_index, ip4_address_t *lcl, ip4_address_t *rmt, u16 lcl_port, u16 rmt_port, u8 proto)
	Lookup session with ip4 and transport layer information. More...
session_t *	session_lookup_safe6 (u32 fib_index, ip6_address_t *lcl, ip6_address_t *rmt, u16 lcl_port, u16 rmt_port, u8 proto)
	Lookup session with ip6 and transport layer information. More...
transport_connection_t *	session_lookup_connection_wt4 (u32 fib_index, ip4_address_t *lcl, ip4_address_t *rmt, u16 lcl_port, u16 rmt_port, u8 proto, u32 thread_index, u8 *is_filtered)
	Lookup connection with ip4 and transport layer information. More...
transport_connection_t *	session_lookup_connection4 (u32 fib_index, ip4_address_t *lcl, ip4_address_t *rmt, u16 lcl_port, u16 rmt_port, u8 proto)
	Lookup connection with ip4 and transport layer information. More...
transport_connection_t *	session_lookup_connection_wt6 (u32 fib_index, ip6_address_t *lcl, ip6_address_t *rmt, u16 lcl_port, u16 rmt_port, u8 proto, u32 thread_index, u8 *is_filtered)
	Lookup connection with ip6 and transport layer information. More...
transport_connection_t *	session_lookup_connection6 (u32 fib_index, ip6_address_t *lcl, ip6_address_t *rmt, u16 lcl_port, u16 rmt_port, u8 proto)
	Lookup connection with ip6 and transport layer information. More...
session_t *	session_lookup_listener4 (u32 fib_index, ip4_address_t *lcl, u16 lcl_port, u8 proto)
session_t *	session_lookup_listener6 (u32 fib_index, ip6_address_t *lcl, u16 lcl_port, u8 proto)
session_t *	session_lookup_listener (u32 table_index, session_endpoint_t *sep)
	Lookup listener, exact or proxy (inaddr_any:0) match. More...
session_t *	session_lookup_listener_wildcard (u32 table_index, session_endpoint_t *sep)
	Lookup listener wildcard match. More...
int	session_lookup_add_connection (transport_connection_t *tc, u64 value)
	Add transport connection to a session table. More...
int	session_lookup_del_connection (transport_connection_t *tc)
	Delete transport connection from session table. More...
u64	session_lookup_endpoint_listener (u32 table_index, session_endpoint_t *sepi, u8 use_rules)
	Lookup listener for session endpoint in table. More...
u64	session_lookup_local_endpoint (u32 table_index, session_endpoint_t *sep)
	Look up endpoint in local session table. More...
session_t *	session_lookup_global_session_endpoint (session_endpoint_t *)
int	session_lookup_add_session_endpoint (u32 table_index, session_endpoint_t *sep, u64 value)
int	session_lookup_del_session_endpoint (u32 table_index, session_endpoint_t *sep)
int	session_lookup_del_session (session_t *s)
int	session_lookup_del_half_open (transport_connection_t *tc)
int	session_lookup_add_half_open (transport_connection_t *tc, u64 value)
u64	session_lookup_half_open_handle (transport_connection_t *tc)
transport_connection_t *	session_lookup_half_open_connection (u64 handle, u8 proto, u8 is_ip4)
u32	session_lookup_get_index_for_fib (u32 fib_proto, u32 fib_index)
void	session_lookup_show_table_entries (vlib_main_t *vm, session_table_t *table, u8 type, u8 is_local)
void	session_lookup_dump_rules_table (u32 fib_index, u8 fib_proto, u8 transport_proto)
void	session_lookup_dump_local_rules_table (u32 fib_index, u8 fib_proto, u8 transport_proto)
int	vnet_session_rule_add_del (session_rule_add_del_args_t *args)
void	session_lookup_set_tables_appns (app_namespace_t *app_ns)
	Mark (global) tables as pertaining to app ns. More...
void	session_lookup_init (void)

Macro Definition Documentation

HALF_OPEN_LOOKUP_INVALID_VALUE

#define HALF_OPEN_LOOKUP_INVALID_VALUE   ((u64)~0)

Definition at line 23 of file session_lookup.h.

Typedef Documentation

session_lookup_result_t

typedef enum session_lookup_result_ session_lookup_result_t

session_rule_add_del_args_t

typedef struct _session_rule_add_del_args session_rule_add_del_args_t

session_rule_scope_e

typedef enum _session_rule_scope session_rule_scope_e

Enumeration Type Documentation

session_lookup_result_

enum session_lookup_result_

Enumerator
SESSION_LOOKUP_RESULT_NONE
SESSION_LOOKUP_RESULT_WRONG_THREAD
SESSION_LOOKUP_RESULT_FILTERED

Definition at line 25 of file session_lookup.h.

Function Documentation

session_lookup_add_connection()

int session_lookup_add_connection	(	transport_connection_t *	tc,
		u64	value
	)

Add transport connection to a session table.

Session lookup 5-tuple (src-ip, dst-ip, src-port, dst-port, session-type) is added to requested session table.

Parameters

tc	transport connection to be added
value	value to be stored

Returns

non-zero if failure

Definition at line 226 of file session_lookup.c.

Here is the call graph for this function:

Here is the caller graph for this function:

session_lookup_add_half_open()

int session_lookup_add_half_open	(	transport_connection_t *	tc,
		u64	value
	)

Definition at line 748 of file session_lookup.c.

Here is the call graph for this function:

Here is the caller graph for this function:

session_lookup_add_session_endpoint()

int session_lookup_add_session_endpoint	(	u32	table_index,
		session_endpoint_t *	sep,
		u64	value
	)

Definition at line 252 of file session_lookup.c.

Here is the call graph for this function:

Here is the caller graph for this function:

session_lookup_connection4()

transport_connection_t* session_lookup_connection4	(	u32	fib_index,
		ip4_address_t *	lcl,
		ip4_address_t *	rmt,
		u16	lcl_port,
		u16	rmt_port,
		u8	proto
	)

Lookup connection with ip4 and transport layer information.

Not optimized. Lookup logic is identical to that of session_lookup_connection_wt4

Parameters

fib_index	index of the fib wherein the connection was received
lcl	local ip4 address
rmt	remote ip4 address
lcl_port	local port
rmt_port	remote port
proto	transport protocol (e.g., tcp, udp)

Returns

pointer to transport connection, if one is found, 0 otherwise

Definition at line 949 of file session_lookup.c.

Here is the call graph for this function:

Here is the caller graph for this function:

session_lookup_connection6()

transport_connection_t* session_lookup_connection6	(	u32	fib_index,
		ip6_address_t *	lcl,
		ip6_address_t *	rmt,
		u16	lcl_port,
		u16	rmt_port,
		u8	proto
	)

Lookup connection with ip6 and transport layer information.

Not optimized. This is used on the fast path so it needs to be fast. Thereby, duplication of code and 'hacks' allowed. Lookup logic is identical to that of session_lookup_connection_wt4

Parameters

fib_index	index of the fib wherein the connection was received
lcl	local ip6 address
rmt	remote ip6 address
lcl_port	local port
rmt_port	remote port
proto	transport protocol (e.g., tcp, udp)

Returns

pointer to transport connection, if one is found, 0 otherwise

Definition at line 1166 of file session_lookup.c.

Here is the call graph for this function:

Here is the caller graph for this function:

session_lookup_connection_wt4()

transport_connection_t* session_lookup_connection_wt4	(	u32	fib_index,
		ip4_address_t *	lcl,
		ip4_address_t *	rmt,
		u16	lcl_port,
		u16	rmt_port,
		u8	proto,
		u32	thread_index,
		u8 *	result
	)

Lookup connection with ip4 and transport layer information.

This is used on the fast path so it needs to be fast. Thereby, duplication of code and 'hacks' allowed.

The lookup is incremental and returns whenever something is matched. The steps are:

• Try to find an established session
• Try to find a half-open connection
• Try session rules table
• Try to find a fully-formed or local source wildcarded (listener bound to all interfaces) listener session
• return 0

Parameters

fib_index	index of fib wherein the connection was received
lcl	local ip4 address
rmt	remote ip4 address
lcl_port	local port
rmt_port	remote port
proto	transport protocol (e.g., tcp, udp)
thread_index	thread index for request
is_filtered	return flag that indicates if connection was filtered.

Returns

pointer to transport connection, if one is found, 0 otherwise

Definition at line 866 of file session_lookup.c.

Here is the call graph for this function:

Here is the caller graph for this function:

session_lookup_connection_wt6()

transport_connection_t* session_lookup_connection_wt6	(	u32	fib_index,
		ip6_address_t *	lcl,
		ip6_address_t *	rmt,
		u16	lcl_port,
		u16	rmt_port,
		u8	proto,
		u32	thread_index,
		u8 *	result
	)

Lookup connection with ip6 and transport layer information.

This is used on the fast path so it needs to be fast. Thereby, duplication of code and 'hacks' allowed.

The lookup is incremental and returns whenever something is matched. The steps are:

• Try to find an established session
• Try to find a half-open connection
• Try session rules table
• Try to find a fully-formed or local source wildcarded (listener bound to all interfaces) listener session
• return 0

Parameters

fib_index	index of the fib wherein the connection was received
lcl	local ip6 address
rmt	remote ip6 address
lcl_port	local port
rmt_port	remote port
proto	transport protocol (e.g., tcp, udp)
thread_index	thread index for request

Returns

pointer to transport connection, if one is found, 0 otherwise

Definition at line 1090 of file session_lookup.c.

Here is the call graph for this function:

Here is the caller graph for this function:

session_lookup_del_connection()

int session_lookup_del_connection

(

transport_connection_t *

tc

)

Delete transport connection from session table.

Parameters

table_index	session table index
tc	transport connection to be removed

Returns

non-zero if failure

Definition at line 312 of file session_lookup.c.

Here is the call graph for this function:

Here is the caller graph for this function:

session_lookup_del_half_open()

int session_lookup_del_half_open

(

transport_connection_t *

tc

)

Definition at line 774 of file session_lookup.c.

Here is the call graph for this function:

Here is the caller graph for this function:

session_lookup_del_session()

int session_lookup_del_session

(

session_t *

s

)

Definition at line 336 of file session_lookup.c.

Here is the call graph for this function:

Here is the caller graph for this function:

session_lookup_del_session_endpoint()

int session_lookup_del_session_endpoint	(	u32	table_index,
		session_endpoint_t *	sep
	)

Definition at line 279 of file session_lookup.c.

Here is the call graph for this function:

Here is the caller graph for this function:

session_lookup_dump_local_rules_table()

void session_lookup_dump_local_rules_table	(	u32	fib_index,
		u8	fib_proto,
		u8	transport_proto
	)

Definition at line 1537 of file session_lookup.c.

Here is the call graph for this function:

session_lookup_dump_rules_table()

void session_lookup_dump_rules_table	(	u32	fib_index,
		u8	fib_proto,
		u8	transport_proto
	)

Definition at line 1525 of file session_lookup.c.

Here is the call graph for this function:

session_lookup_endpoint_listener()

u64 session_lookup_endpoint_listener	(	u32	table_index,
		session_endpoint_t *	sep,
		u8	use_rules
	)

Lookup listener for session endpoint in table.

Parameters

table_index	table where the endpoint should be looked up
sep	session endpoint to be looked up
use_rules	flag that indicates if the session rules of the table should be used

Returns

invalid handle if nothing is found, the handle of a valid listener or an action derived handle if a rule is hit

Definition at line 435 of file session_lookup.c.

Here is the call graph for this function:

Here is the caller graph for this function:

session_lookup_get_index_for_fib()

u32 session_lookup_get_index_for_fib	(	u32	fib_proto,
		u32	fib_index
	)

Definition at line 207 of file session_lookup.c.

Here is the caller graph for this function:

session_lookup_global_session_endpoint()

session_t* session_lookup_global_session_endpoint

(

session_endpoint_t *

)

session_lookup_half_open_connection()

transport_connection_t* session_lookup_half_open_connection	(	u64	handle,
		u8	proto,
		u8	is_ip4
	)

Definition at line 829 of file session_lookup.c.

Here is the call graph for this function:

Here is the caller graph for this function:

session_lookup_half_open_handle()

u64 session_lookup_half_open_handle

(

transport_connection_t *

tc

)

Definition at line 798 of file session_lookup.c.

Here is the call graph for this function:

Here is the caller graph for this function:

session_lookup_init()

void session_lookup_init

(

void

)

Definition at line 1654 of file session_lookup.c.

Here is the call graph for this function:

session_lookup_listener()

session_t* session_lookup_listener	(	u32	table_index,
		session_endpoint_t *	sep
	)

Lookup listener, exact or proxy (inaddr_any:0) match.

Definition at line 711 of file session_lookup.c.

Here is the call graph for this function:

Here is the caller graph for this function:

session_lookup_listener4()

session_t* session_lookup_listener4	(	u32	fib_index,
		ip4_address_t *	lcl,
		u16	lcl_port,
		u8	proto
	)

Definition at line 654 of file session_lookup.c.

Here is the call graph for this function:

session_lookup_listener6()

session_t* session_lookup_listener6	(	u32	fib_index,
		ip6_address_t *	lcl,
		u16	lcl_port,
		u8	proto
	)

Definition at line 697 of file session_lookup.c.

Here is the call graph for this function:

session_lookup_listener_wildcard()

session_t* session_lookup_listener_wildcard	(	u32	table_index,
		session_endpoint_t *	sep
	)

Lookup listener wildcard match.

Definition at line 730 of file session_lookup.c.

Here is the call graph for this function:

Here is the caller graph for this function:

session_lookup_local_endpoint()

u64 session_lookup_local_endpoint	(	u32	table_index,
		session_endpoint_t *	sep
	)

Look up endpoint in local session table.

The result, for now, is an application index and it may in the future be extended to a more complicated "action object". The only action we emulate now is "drop" and for that we return a special app index.

Lookup logic is to check in order:

• the rules in the table (connect acls)
• session sub-table for a listener
• session sub-table for a local listener (zeroed addr)

Parameters

table_index	table where the lookup should be done
sep	session endpoint to be looked up

Returns

session handle that can be interpreted as an adjacency

Definition at line 507 of file session_lookup.c.

Here is the call graph for this function:

Here is the caller graph for this function:

session_lookup_safe4()

session_t* session_lookup_safe4	(	u32	fib_index,
		ip4_address_t *	lcl,
		ip4_address_t *	rmt,
		u16	lcl_port,
		u16	rmt_port,
		u8	proto
	)

Lookup session with ip4 and transport layer information.

Important note: this may look into another thread's pool table and register as 'peeker'. Caller should call session_pool_remove_peeker as if needed as soon as possible.

Lookup logic is similar to that of session_lookup_connection_wt4 but this returns a session as opposed to a transport connection and it does not try to lookup half-open sessions.

Typically used by dgram connections

Definition at line 1021 of file session_lookup.c.

Here is the call graph for this function:

Here is the caller graph for this function:

session_lookup_safe6()

session_t* session_lookup_safe6	(	u32	fib_index,
		ip6_address_t *	lcl,
		ip6_address_t *	rmt,
		u16	lcl_port,
		u16	rmt_port,
		u8	proto
	)

Lookup session with ip6 and transport layer information.

Important note: this may look into another thread's pool table and register as 'peeker'. Caller should call session_pool_remove_peeker as if needed as soon as possible.

Lookup logic is similar to that of session_lookup_connection_wt6 but this returns a session as opposed to a transport connection and it does not try to lookup half-open sessions.

Typically used by dgram connections

Definition at line 1229 of file session_lookup.c.

Here is the call graph for this function:

Here is the caller graph for this function:

session_lookup_set_tables_appns()

void session_lookup_set_tables_appns

(

app_namespace_t *

app_ns

)

Mark (global) tables as pertaining to app ns.

Definition at line 1309 of file session_lookup.c.

Here is the call graph for this function:

Here is the caller graph for this function:

session_lookup_show_table_entries()

void session_lookup_show_table_entries	(	vlib_main_t *	vm,
		session_table_t *	table,
		u8	type,
		u8	is_local
	)

Definition at line 1375 of file session_lookup.c.

Here is the call graph for this function:

Here is the caller graph for this function:

vnet_session_rule_add_del()

int vnet_session_rule_add_del

(

session_rule_add_del_args_t *

args

)

Definition at line 1265 of file session_lookup.c.

Here is the call graph for this function:

Here is the caller graph for this function: