Include dependency graph for fib_path_list.h:

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

Macros
#define	FIB_PATH_LIST_ATTRIBUTES

#define	FOR_EACH_PATH_LIST_ATTRIBUTE(_item)

Typedefs
typedef enum fib_path_list_attribute_t_	fib_path_list_attribute_t
	Enumeration of path-list flags. More...

typedef enum fib_path_list_flags_t_	fib_path_list_flags_t

typedef fib_path_list_walk_rc_t(*	fib_path_list_walk_fn_t) (fib_node_index_t pl_index, fib_node_index_t path_index, void *ctx)
	A callback function type for walking a path-list's paths. More...

Enumerations
enum	fib_path_list_attribute_t_ { FIB_PATH_LIST_ATTRIBUTE_FIRST = 0, FIB_PATH_LIST_ATTRIBUTE_SHARED = FIB_PATH_LIST_ATTRIBUTE_FIRST, FIB_PATH_LIST_ATTRIBUTE_DROP, FIB_PATH_LIST_ATTRIBUTE_LOCAL, FIB_PATH_LIST_ATTRIBUTE_EXCLUSIVE, FIB_PATH_LIST_ATTRIBUTE_RESOLVED, FIB_PATH_LIST_ATTRIBUTE_LOOPED, FIB_PATH_LIST_ATTRIBUTE_POPULAR, FIB_PATH_LIST_ATTRIBUTE_NO_URPF, FIB_PATH_LIST_ATTRIBUTE_LAST = FIB_PATH_LIST_ATTRIBUTE_NO_URPF }
	Enumeration of path-list flags. More...

enum	fib_path_list_flags_t_ { FIB_PATH_LIST_FLAG_NONE = 0, FIB_PATH_LIST_FLAG_SHARED = (1 << FIB_PATH_LIST_ATTRIBUTE_SHARED), FIB_PATH_LIST_FLAG_DROP = (1 << FIB_PATH_LIST_ATTRIBUTE_DROP), FIB_PATH_LIST_FLAG_LOCAL = (1 << FIB_PATH_LIST_ATTRIBUTE_LOCAL), FIB_PATH_LIST_FLAG_EXCLUSIVE = (1 << FIB_PATH_LIST_ATTRIBUTE_EXCLUSIVE), FIB_PATH_LIST_FLAG_RESOLVED = (1 << FIB_PATH_LIST_ATTRIBUTE_RESOLVED), FIB_PATH_LIST_FLAG_LOOPED = (1 << FIB_PATH_LIST_ATTRIBUTE_LOOPED), FIB_PATH_LIST_FLAG_POPULAR = (1 << FIB_PATH_LIST_ATTRIBUTE_POPULAR), FIB_PATH_LIST_FLAG_NO_URPF = (1 << FIB_PATH_LIST_ATTRIBUTE_NO_URPF) }

Functions
fib_node_index_t	fib_path_list_create (fib_path_list_flags_t flags, const fib_route_path_t *paths)

fib_node_index_t	fib_path_list_create_special (fib_protocol_t nh_proto, fib_path_list_flags_t flags, const dpo_id_t *dpo)

fib_node_index_t	fib_path_list_copy_and_path_add (fib_node_index_t pl_index, fib_path_list_flags_t flags, const fib_route_path_t *path)

fib_node_index_t	fib_path_list_copy_and_path_remove (fib_node_index_t pl_index, fib_path_list_flags_t flags, const fib_route_path_t *path)

fib_node_index_t	fib_path_list_path_add (fib_node_index_t path_list_index, const fib_route_path_t *rpaths)

fib_node_index_t	fib_path_list_path_remove (fib_node_index_t path_list_index, const fib_route_path_t *rpaths)

u32	fib_path_list_get_n_paths (fib_node_index_t pl_index)

void	fib_path_list_contribute_forwarding (fib_node_index_t path_list_index, fib_forward_chain_type_t type, dpo_id_t *dpo)

void	fib_path_list_contribute_urpf (fib_node_index_t path_index, index_t urpf)
	Contribute (add) this path list's uRPF list. More...

index_t	fib_path_list_get_urpf (fib_node_index_t path_list_index)
	Return the the child the RPF list pre-built for this path list. More...

index_t	fib_path_list_get_adj (fib_node_index_t path_list_index, fib_forward_chain_type_t type)

u32	fib_path_list_child_add (fib_node_index_t pl_index, fib_node_type_t type, fib_node_index_t child_index)

void	fib_path_list_child_remove (fib_node_index_t pl_index, fib_node_index_t sibling_index)

void	fib_path_list_back_walk (fib_node_index_t pl_index, fib_node_back_walk_ctx_t *ctx)

void	fib_path_list_lock (fib_node_index_t pl_index)

void	fib_path_list_unlock (fib_node_index_t pl_index)

int	fib_path_list_recursive_loop_detect (fib_node_index_t path_list_index, fib_node_index_t **entry_indicies)

u32	fib_path_list_get_resolving_interface (fib_node_index_t path_list_index)

int	fib_path_list_is_looped (fib_node_index_t path_list_index)

int	fib_path_list_is_popular (fib_node_index_t path_list_index)

fib_protocol_t	fib_path_list_get_proto (fib_node_index_t path_list_index)

u8 *	fib_path_list_format (fib_node_index_t pl_index, u8 *s)

index_t	fib_path_list_lb_map_add_or_lock (fib_node_index_t pl_index, const fib_node_index_t *pis)

u32	fib_path_list_find_rpath (fib_node_index_t path_list_index, const fib_route_path_t *rpath)

void	fib_path_list_walk (fib_node_index_t pl_index, fib_path_list_walk_fn_t func, void *ctx)

void	fib_path_list_module_init (void)

u32	fib_path_list_pool_size (void)

u32	fib_path_list_db_size (void)

Macro Definition Documentation

#define FIB_PATH_LIST_ATTRIBUTES

Value:

{                        \
    [FIB_PATH_LIST_ATTRIBUTE_SHARED]    = "shared",      \
    [FIB_PATH_LIST_ATTRIBUTE_RESOLVED]  = "resolved",    \
    [FIB_PATH_LIST_ATTRIBUTE_DROP]      = "drop",        \
    [FIB_PATH_LIST_ATTRIBUTE_EXCLUSIVE] = "exclusive",   \
    [FIB_PATH_LIST_ATTRIBUTE_LOCAL]     = "local",       \
    [FIB_PATH_LIST_ATTRIBUTE_LOOPED]    = "looped",      \
    [FIB_PATH_LIST_ATTRIBUTE_POPULAR]   = "popular",     \
    [FIB_PATH_LIST_ATTRIBUTE_NO_URPF]   = "no-uRPF",     \
}

Definition at line 91 of file fib_path_list.h.

#define FOR_EACH_PATH_LIST_ATTRIBUTE ( _item )

Value:

for (_item = FIB_PATH_LIST_ATTRIBUTE_FIRST;             \
         _item <= FIB_PATH_LIST_ATTRIBUTE_LAST;         \
         _item++)

Definition at line 102 of file fib_path_list.h.

Typedef Documentation

typedef enum fib_path_list_attribute_t_ fib_path_list_attribute_t

Enumeration of path-list flags.

typedef enum fib_path_list_flags_t_ fib_path_list_flags_t

typedef fib_path_list_walk_rc_t(* fib_path_list_walk_fn_t) (fib_node_index_t pl_index, fib_node_index_t path_index, void *ctx)

A callback function type for walking a path-list's paths.

Definition at line 164 of file fib_path_list.h.

Enumeration Type Documentation

enum fib_path_list_attribute_t_

Enumeration of path-list flags.

Enumerator
FIB_PATH_LIST_ATTRIBUTE_FIRST	Marker. Add new flags after this one.
FIB_PATH_LIST_ATTRIBUTE_SHARED	This path list is shareable. Shareable path-lists are inserted into the path-list data-base. All path-list are inherently shareable, the reason we share some and not others is to limit the size of the path-list database. This DB must be searched for each route update.
FIB_PATH_LIST_ATTRIBUTE_DROP	explicit drop path-list. Used when the entry source needs to force a drop, despite the fact the path info is present.
FIB_PATH_LIST_ATTRIBUTE_LOCAL	explicit local path-list.
FIB_PATH_LIST_ATTRIBUTE_EXCLUSIVE	exclusive path-list. Exclusive means the path will resolve via the exclusive (user provided) adj.
FIB_PATH_LIST_ATTRIBUTE_RESOLVED	resolved path-list
FIB_PATH_LIST_ATTRIBUTE_LOOPED	looped path-list. one path looped implies the whole list is
FIB_PATH_LIST_ATTRIBUTE_POPULAR	a popular path-ist is one that is shared amongst many entries. Path list become popular as they gain more children, but they don't become unpopular as they lose them.
FIB_PATH_LIST_ATTRIBUTE_NO_URPF	no uRPF - do not generate unicast RPF list for this path-list
FIB_PATH_LIST_ATTRIBUTE_LAST	Marher. Add new flags before this one, and then update it.

Definition at line 28 of file fib_path_list.h.

enum fib_path_list_flags_t_

Enumerator
FIB_PATH_LIST_FLAG_NONE
FIB_PATH_LIST_FLAG_SHARED
FIB_PATH_LIST_FLAG_DROP
FIB_PATH_LIST_FLAG_LOCAL
FIB_PATH_LIST_FLAG_EXCLUSIVE
FIB_PATH_LIST_FLAG_RESOLVED
FIB_PATH_LIST_FLAG_LOOPED
FIB_PATH_LIST_FLAG_POPULAR
FIB_PATH_LIST_FLAG_NO_URPF

Definition at line 79 of file fib_path_list.h.