fib_path.h File Reference

Include dependency graph for fib_path.h:

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

Go to the source code of this file.

Macros
#define	FIB_PATH_CFG_ATTRIBUTE_MAX   (FIB_PATH_CFG_ATTRIBUTE_LAST + 1)
	The maximum number of path attributes. More...
#define	FIB_PATH_CFG_ATTRIBUTES
#define	FOR_EACH_FIB_PATH_CFG_ATTRIBUTE(_item)

Typedefs
typedef enum fib_path_cfg_attribute_t_	fib_path_cfg_attribute_t
	Given a route of the form; q.r.s.t/Y via <interface> <next-hop> More...
typedef enum fib_path_cfg_flags_t_	fib_path_cfg_flags_t
	Path config flags from the attributes. More...

Enumerations
enum	fib_path_cfg_attribute_t_ {   FIB_PATH_CFG_ATTRIBUTE_FIRST = 0, FIB_PATH_CFG_ATTRIBUTE_DROP = FIB_PATH_CFG_ATTRIBUTE_FIRST, FIB_PATH_CFG_ATTRIBUTE_EXCLUSIVE, FIB_PATH_CFG_ATTRIBUTE_RESOLVE_HOST,   FIB_PATH_CFG_ATTRIBUTE_RESOLVE_ATTACHED, FIB_PATH_CFG_ATTRIBUTE_ATTACHED, FIB_PATH_CFG_ATTRIBUTE_LOCAL, FIB_PATH_CFG_ATTRIBUTE_LAST = FIB_PATH_CFG_ATTRIBUTE_LOCAL }
	Given a route of the form; q.r.s.t/Y via <interface> <next-hop> More...
enum	fib_path_cfg_flags_t_ {   FIB_PATH_CFG_FLAG_NONE = 0, FIB_PATH_CFG_FLAG_DROP = (1 << FIB_PATH_CFG_ATTRIBUTE_DROP), FIB_PATH_CFG_FLAG_EXCLUSIVE = (1 << FIB_PATH_CFG_ATTRIBUTE_EXCLUSIVE), FIB_PATH_CFG_FLAG_RESOLVE_HOST = (1 << FIB_PATH_CFG_ATTRIBUTE_RESOLVE_HOST),   FIB_PATH_CFG_FLAG_RESOLVE_ATTACHED = (1 << FIB_PATH_CFG_ATTRIBUTE_RESOLVE_ATTACHED), FIB_PATH_CFG_FLAG_LOCAL = (1 << FIB_PATH_CFG_ATTRIBUTE_LOCAL), FIB_PATH_CFG_FLAG_ATTACHED = (1 << FIB_PATH_CFG_ATTRIBUTE_ATTACHED) }
	Path config flags from the attributes. More...

Functions
u8 *	fib_path_format (fib_node_index_t pi, u8 *s)
u8 *	fib_path_adj_format (fib_node_index_t pi, u32 indent, u8 *s)
u8 *	format_fib_path (u8 *s, va_list *args)
fib_node_index_t	fib_path_create (fib_node_index_t pl_index, fib_protocol_t nh_proto, fib_path_cfg_flags_t flags, const fib_route_path_t *path)
fib_node_index_t	fib_path_create_special (fib_node_index_t pl_index, fib_protocol_t nh_proto, fib_path_cfg_flags_t flags, const dpo_id_t *dpo)
int	fib_path_cmp (fib_node_index_t path_index1, fib_node_index_t path_index2)
int	fib_path_cmp_for_sort (void *a1, void *a2)
int	fib_path_cmp_w_route_path (fib_node_index_t path_index, const fib_route_path_t *rpath)
fib_node_index_t	fib_path_copy (fib_node_index_t path_index, fib_node_index_t path_list_index)
int	fib_path_resolve (fib_node_index_t path_index)
int	fib_path_is_resolved (fib_node_index_t path_index)
int	fib_path_is_recursive (fib_node_index_t path_index)
int	fib_path_is_exclusive (fib_node_index_t path_index)
int	fib_path_is_deag (fib_node_index_t path_index)
int	fib_path_is_looped (fib_node_index_t path_index)
fib_protocol_t	fib_path_get_proto (fib_node_index_t path_index)
void	fib_path_destroy (fib_node_index_t path_index)
uword	fib_path_hash (fib_node_index_t path_index)
load_balance_path_t *	fib_path_append_nh_for_multipath_hash (fib_node_index_t path_index, fib_forward_chain_type_t fct, load_balance_path_t *hash_key)
void	fib_path_contribute_forwarding (fib_node_index_t path_index, fib_forward_chain_type_t type, dpo_id_t *dpo)
void	fib_path_contribute_urpf (fib_node_index_t path_index, index_t urpf)
	Contribute the path's adjacency to the list passed. More...
adj_index_t	fib_path_get_adj (fib_node_index_t path_index)
int	fib_path_recursive_loop_detect (fib_node_index_t path_index, fib_node_index_t **entry_indicies)
u32	fib_path_get_resolving_interface (fib_node_index_t fib_entry_index)
int	fib_path_get_weight (fib_node_index_t path_index)
void	fib_path_module_init (void)
int	fib_path_encode (fib_node_index_t path_list_index, fib_node_index_t path_index, void *ctx)

Macro Definition Documentation

#define FIB_PATH_CFG_ATTRIBUTE_MAX   (FIB_PATH_CFG_ATTRIBUTE_LAST + 1)

The maximum number of path attributes.

Definition at line 82 of file fib_path.h.

#define FIB_PATH_CFG_ATTRIBUTES

Value:

{                       \
    [FIB_PATH_CFG_ATTRIBUTE_DROP]  = "drop",            \
    [FIB_PATH_CFG_ATTRIBUTE_EXCLUSIVE] = "exclusive",   \
    [FIB_PATH_CFG_ATTRIBUTE_RESOLVE_HOST] = "resolve-host", \
    [FIB_PATH_CFG_ATTRIBUTE_RESOLVE_ATTACHED] = "resolve-attached", \
    [FIB_PATH_CFG_ATTRIBUTE_LOCAL] = "local",           \
    [FIB_PATH_CFG_ATTRIBUTE_ATTACHED] = "attached",     \
}

Definition at line 84 of file fib_path.h.

#define FOR_EACH_FIB_PATH_CFG_ATTRIBUTE

(

_item

)

Value:

for (_item = FIB_PATH_CFG_ATTRIBUTE_FIRST; \
         _item <= FIB_PATH_CFG_ATTRIBUTE_LAST; \
         _item++)

Definition at line 93 of file fib_path.h.

Typedef Documentation

typedef enum fib_path_cfg_attribute_t_ fib_path_cfg_attribute_t

Given a route of the form; q.r.s.t/Y via <interface> <next-hop>

The prefix is: q.r.s.t./Y the path is: 'via <interface> <next-hop>

The path is the description of where to send the traffic, and the the prefix is a description of which traffic to send. It is the aim of the FIB to resolve the path, i.e. to find the corresponding adjacency to match the path's description. Enurmeration of path configuration attributes

typedef enum fib_path_cfg_flags_t_ fib_path_cfg_flags_t

Path config flags from the attributes.

Enumeration Type Documentation

enum fib_path_cfg_attribute_t_

Given a route of the form; q.r.s.t/Y via <interface> <next-hop>

The prefix is: q.r.s.t./Y the path is: 'via <interface> <next-hop>

The path is the description of where to send the traffic, and the the prefix is a description of which traffic to send. It is the aim of the FIB to resolve the path, i.e. to find the corresponding adjacency to match the path's description. Enurmeration of path configuration attributes

Enumerator
FIB_PATH_CFG_ATTRIBUTE_FIRST	Marker. Add new types after this one.
FIB_PATH_CFG_ATTRIBUTE_DROP	The path is forced to a drop, whatever the next-hop info says. something somewhere knows better...
FIB_PATH_CFG_ATTRIBUTE_EXCLUSIVE	The path uses an adj that is exclusive. I.e. it is known only by the source of the route.
FIB_PATH_CFG_ATTRIBUTE_RESOLVE_HOST	Recursion constraint via host.
FIB_PATH_CFG_ATTRIBUTE_RESOLVE_ATTACHED	Recursion constraint via attached.
FIB_PATH_CFG_ATTRIBUTE_ATTACHED	The path is attached.
FIB_PATH_CFG_ATTRIBUTE_LOCAL	The path is a for-us path.
FIB_PATH_CFG_ATTRIBUTE_LAST	Marker. Add new types before this one, then update it.

Definition at line 42 of file fib_path.h.

enum fib_path_cfg_flags_t_

Path config flags from the attributes.

Enumerator
FIB_PATH_CFG_FLAG_NONE
FIB_PATH_CFG_FLAG_DROP
FIB_PATH_CFG_FLAG_EXCLUSIVE
FIB_PATH_CFG_FLAG_RESOLVE_HOST
FIB_PATH_CFG_FLAG_RESOLVE_ATTACHED
FIB_PATH_CFG_FLAG_LOCAL
FIB_PATH_CFG_FLAG_ATTACHED

Definition at line 101 of file fib_path.h.

Function Documentation

u8* fib_path_adj_format	(	fib_node_index_t	pi,
		u32	indent,
		u8 *	s
	)

Definition at line 492 of file fib_path.c.

Here is the call graph for this function:

Here is the caller graph for this function:

load_balance_path_t* fib_path_append_nh_for_multipath_hash	(	fib_node_index_t	path_index,
		fib_forward_chain_type_t	fct,
		load_balance_path_t *	hash_key
	)

Definition at line 1878 of file fib_path.c.

Here is the call graph for this function:

Here is the caller graph for this function:

int fib_path_cmp	(	fib_node_index_t	path_index1,
		fib_node_index_t	path_index2
	)

Definition at line 1284 of file fib_path.c.

Here is the call graph for this function:

Here is the caller graph for this function:

int fib_path_cmp_for_sort	(	void *	a1,
		void *	a2
	)

Definition at line 1266 of file fib_path.c.

Here is the call graph for this function:

Here is the caller graph for this function:

int fib_path_cmp_w_route_path	(	fib_node_index_t	path_index,
		const fib_route_path_t *	rpath
	)

Definition at line 1296 of file fib_path.c.

Here is the call graph for this function:

Here is the caller graph for this function:

void fib_path_contribute_forwarding	(	fib_node_index_t	path_index,
		fib_forward_chain_type_t	type,
		dpo_id_t *	dpo
	)

Definition at line 1742 of file fib_path.c.

Here is the call graph for this function:

Here is the caller graph for this function:

void fib_path_contribute_urpf	(	fib_node_index_t	path_index,
		index_t	urpf
	)

Contribute the path's adjacency to the list passed.

By calling this function over all paths, recursively, a child can construct its full set of forwarding adjacencies, and hence its uRPF list.

Definition at line 1684 of file fib_path.c.

Here is the call graph for this function:

Here is the caller graph for this function:

fib_node_index_t fib_path_copy	(	fib_node_index_t	path_index,
		fib_node_index_t	path_list_index
	)

Definition at line 1122 of file fib_path.c.

Here is the call graph for this function:

Here is the caller graph for this function:

fib_node_index_t fib_path_create	(	fib_node_index_t	pl_index,
		fib_protocol_t	nh_proto,
		fib_path_cfg_flags_t	flags,
		const fib_route_path_t *	path
	)

Definition at line 984 of file fib_path.c.

Here is the call graph for this function:

Here is the caller graph for this function:

fib_node_index_t fib_path_create_special	(	fib_node_index_t	pl_index,
		fib_protocol_t	nh_proto,
		fib_path_cfg_flags_t	flags,
		const dpo_id_t *	dpo
	)

Definition at line 1077 of file fib_path.c.

Here is the call graph for this function:

Here is the caller graph for this function:

void fib_path_destroy

(

fib_node_index_t

path_index

)

Definition at line 1155 of file fib_path.c.

Here is the call graph for this function:

Here is the caller graph for this function:

int fib_path_encode	(	fib_node_index_t	path_list_index,
		fib_node_index_t	path_index,
		void *	ctx
	)

Definition at line 1955 of file fib_path.c.

Here is the call graph for this function:

Here is the caller graph for this function:

u8* fib_path_format	(	fib_node_index_t	pi,
		u8 *	s
	)

Definition at line 481 of file fib_path.c.

Here is the call graph for this function:

Here is the caller graph for this function:

adj_index_t fib_path_get_adj

(

fib_node_index_t

path_index

)

Definition at line 1651 of file fib_path.c.

Here is the call graph for this function:

Here is the caller graph for this function:

fib_protocol_t fib_path_get_proto

(

fib_node_index_t

path_index

)

Definition at line 1998 of file fib_path.c.

Here is the call graph for this function:

Here is the caller graph for this function:

u32 fib_path_get_resolving_interface

(

fib_node_index_t

fib_entry_index

)

Definition at line 1622 of file fib_path.c.

Here is the call graph for this function:

Here is the caller graph for this function:

int fib_path_get_weight

(

fib_node_index_t

path_index

)

Definition at line 1666 of file fib_path.c.

Here is the call graph for this function:

Here is the caller graph for this function:

uword fib_path_hash

(

fib_node_index_t

path_index

)

Definition at line 1176 of file fib_path.c.

Here is the call graph for this function:

Here is the caller graph for this function:

int fib_path_is_deag

(

fib_node_index_t

path_index

)

Definition at line 1922 of file fib_path.c.

Here is the call graph for this function:

Here is the caller graph for this function:

int fib_path_is_exclusive

(

fib_node_index_t

path_index

)

Definition at line 1912 of file fib_path.c.

Here is the call graph for this function:

Here is the caller graph for this function:

int fib_path_is_looped

(

fib_node_index_t

path_index

)

Definition at line 1945 of file fib_path.c.

Here is the call graph for this function:

Here is the caller graph for this function:

int fib_path_is_recursive

(

fib_node_index_t

path_index

)

Definition at line 1902 of file fib_path.c.

Here is the call graph for this function:

Here is the caller graph for this function:

int fib_path_is_resolved

(

fib_node_index_t

path_index

)

Definition at line 1932 of file fib_path.c.

Here is the call graph for this function:

Here is the caller graph for this function:

void fib_path_module_init

(

void

)

Definition at line 2008 of file fib_path.c.

Here is the call graph for this function:

Here is the caller graph for this function:

int fib_path_recursive_loop_detect	(	fib_node_index_t	path_index,
		fib_node_index_t **	entry_indicies
	)

Definition at line 1384 of file fib_path.c.

Here is the call graph for this function:

Here is the caller graph for this function:

int fib_path_resolve

(

fib_node_index_t

path_index

)

Definition at line 1464 of file fib_path.c.

Here is the call graph for this function:

Here is the caller graph for this function:

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

Definition at line 363 of file fib_path.c.

Here is the call graph for this function:

Here is the caller graph for this function: