Include dependency graph for fib_table.h:

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

Data Structures
struct	fib_table_t_
	A protocol Independent FIB table. More...

Typedefs
typedef struct fib_table_t_	fib_table_t
	A protocol Independent FIB table. More...

typedef int(*	fib_table_walk_fn_t) (fib_node_index_t fei, void *ctx)
	Call back function when walking entries in a FIB table. More...

Functions
u8 *	format_fib_table_name (u8 *s, va_list ap)
	Format the description/name of the table. More...

fib_node_index_t	fib_table_lookup (u32 fib_index, const fib_prefix_t *prefix)
	Perfom a longest prefix match in the non-forwarding table. More...

fib_node_index_t	fib_table_lookup_exact_match (u32 fib_index, const fib_prefix_t *prefix)
	Perfom an exact match in the non-forwarding table. More...

fib_node_index_t	fib_table_get_less_specific (u32 fib_index, const fib_prefix_t *prefix)
	Get the less specific (covering) prefix. More...

fib_node_index_t	fib_table_entry_special_add (u32 fib_index, const fib_prefix_t *prefix, fib_source_t source, fib_entry_flag_t flags)
	Add a 'special' entry to the FIB. More...

fib_node_index_t	fib_table_entry_special_dpo_add (u32 fib_index, const fib_prefix_t prefix, fib_source_t source, fib_entry_flag_t stype, const dpo_id_t dpo)
	Add a 'special' entry to the FIB that links to the DPO passed A special entry is an entry that the FIB is not expect to resolve via the usual mechanisms (i.e. More...

fib_node_index_t	fib_table_entry_special_dpo_update (u32 fib_index, const fib_prefix_t prefix, fib_source_t source, fib_entry_flag_t stype, const dpo_id_t dpo)
	Update a 'special' entry to the FIB that links to the DPO passed A special entry is an entry that the FIB is not expect to resolve via the usual mechanisms (i.e. More...

void	fib_table_entry_special_remove (u32 fib_index, const fib_prefix_t *prefix, fib_source_t source)
	Remove a 'special' entry from the FIB. More...

fib_node_index_t	fib_table_entry_path_add (u32 fib_index, const fib_prefix_t prefix, fib_source_t source, fib_entry_flag_t flags, fib_protocol_t next_hop_proto, const ip46_address_t next_hop, u32 next_hop_sw_if_index, u32 next_hop_fib_index, u32 next_hop_weight, mpls_label_t *next_hop_label_stack, fib_route_path_flags_t pf)
	Add one path to an entry (aka route) in the FIB. More...

fib_node_index_t	fib_table_entry_path_add2 (u32 fib_index, const fib_prefix_t prefix, fib_source_t source, fib_entry_flag_t flags, fib_route_path_t rpath)
	Add n paths to an entry (aka route) in the FIB. More...

void	fib_table_entry_path_remove (u32 fib_index, const fib_prefix_t prefix, fib_source_t source, fib_protocol_t next_hop_proto, const ip46_address_t next_hop, u32 next_hop_sw_if_index, u32 next_hop_fib_index, u32 next_hop_weight, fib_route_path_flags_t pf)
	remove one path to an entry (aka route) in the FIB. More...

void	fib_table_entry_path_remove2 (u32 fib_index, const fib_prefix_t prefix, fib_source_t source, fib_route_path_t paths)
	Remove n paths to an entry (aka route) in the FIB. More...

fib_node_index_t	fib_table_entry_update (u32 fib_index, const fib_prefix_t prefix, fib_source_t source, fib_entry_flag_t flags, fib_route_path_t paths)
	Update an entry to have a new set of paths. More...

fib_node_index_t	fib_table_entry_update_one_path (u32 fib_index, const fib_prefix_t prefix, fib_source_t source, fib_entry_flag_t flags, fib_protocol_t next_hop_proto, const ip46_address_t next_hop, u32 next_hop_sw_if_index, u32 next_hop_fib_index, u32 next_hop_weight, mpls_label_t *next_hop_label_stack, fib_route_path_flags_t pf)
	Update the entry to have just one path. More...

fib_node_index_t	fib_table_entry_local_label_add (u32 fib_index, const fib_prefix_t *prefix, mpls_label_t label)
	Add a MPLS local label for the prefix/route. More...

void	fib_table_entry_local_label_remove (u32 fib_index, const fib_prefix_t *prefix, mpls_label_t label)
	remove a MPLS local label for the prefix/route. More...

void	fib_table_entry_delete (u32 fib_index, const fib_prefix_t *prefix, fib_source_t source)
	Delete a FIB entry. More...

void	fib_table_entry_delete_index (fib_node_index_t entry_index, fib_source_t source)
	Delete a FIB entry. More...

void	fib_table_flush (u32 fib_index, fib_protocol_t proto, fib_source_t source)
	Flush all entries from a table for the source. More...

u32	fib_table_get_index_for_sw_if_index (fib_protocol_t proto, u32 sw_if_index)
	Get the index of the FIB bound to the interface. More...

u32	fib_table_get_table_id_for_sw_if_index (fib_protocol_t proto, u32 sw_if_index)
	Get the Table-ID of the FIB bound to the interface. More...

u32	fib_table_find (fib_protocol_t proto, u32 table_id)
	Get the index of the FIB for a Table-ID. More...

u32	fib_table_find_or_create_and_lock (fib_protocol_t proto, u32 table_id)
	Get the index of the FIB for a Table-ID. More...

u32	fib_table_create_and_lock (fib_protocol_t proto, const char *const fmt,...)
	Create a new table with no table ID. More...

flow_hash_config_t	fib_table_get_flow_hash_config (u32 fib_index, fib_protocol_t proto)
	Get the flow hash configured used by the table. More...

void	fib_table_unlock (u32 fib_index, fib_protocol_t proto)
	Take a reference counting lock on the table. More...

void	fib_table_lock (u32 fib_index, fib_protocol_t proto)
	Release a reference counting lock on the table. More...

u32	fib_table_get_num_entries (u32 fib_index, fib_protocol_t proto, fib_source_t source)
	Return the number of entries in the FIB added by a given source. More...

fib_table_t *	fib_table_get (fib_node_index_t index, fib_protocol_t proto)
	Get a pointer to a FIB table. More...

void	fib_table_walk (u32 fib_index, fib_protocol_t proto, fib_table_walk_fn_t fn, void *ctx)
	Walk all entries in a FIB table N.B: This is NOT safe to deletes. More...

Typedef Documentation

typedef struct fib_table_t_ fib_table_t

A protocol Independent FIB table.

typedef int(* fib_table_walk_fn_t) (fib_node_index_t fei, void *ctx)

Call back function when walking entries in a FIB table.

Definition at line 733 of file fib_table.h.

Function Documentation

u32 fib_table_create_and_lock	(	fib_protocol_t	proto,
		const char *const	fmt,
			...
	)

Create a new table with no table ID.

This means it does not get added to the hash-table and so can only be found by using the index returned.

proto The protocol of the FIB (and thus the entries therein)

Parameters

fmt	A string to describe the table

Returns: fib_index The index of the FIB

Definition at line 985 of file fib_table.c.

Here is the call graph for this function:

Here is the caller graph for this function:

void fib_table_entry_delete	(	u32	fib_index,
		const fib_prefix_t *	prefix,
		fib_source_t	source
	)

Delete a FIB entry.

If the entry has no more sources, then it is removed from the table.

Parameters

fib_index	The index of the FIB
prefix	The prefix for the entry to remove
source	The ID of the client/source adding the entry.

Definition at line 798 of file fib_table.c.

Here is the call graph for this function:

Here is the caller graph for this function:

void fib_table_entry_delete_index	(	fib_node_index_t	entry_index,
		fib_source_t	source
	)

Delete a FIB entry.

If the entry has no more sources, then it is removed from the table.

Parameters

entry_index	The index of the FIB entry
source	The ID of the client/source adding the entry.

Definition at line 821 of file fib_table.c.

Here is the call graph for this function:

Here is the caller graph for this function:

fib_node_index_t fib_table_entry_local_label_add	(	u32	fib_index,
		const fib_prefix_t *	prefix,
		mpls_label_t	label
	)

Add a MPLS local label for the prefix/route.

If the entry does not exist, it will be created. In theory more than one local label can be added, but this is not yet supported.

Parameters

fib_index	The index of the FIB
prefix	The prefix for the entry to which to add the label
label	The MPLS label to add

Returns: the index of the fib_entry_t that is created (or existed already).

Definition at line 833 of file fib_table.c.

Here is the call graph for this function:

Here is the caller graph for this function:

void fib_table_entry_local_label_remove	(	u32	fib_index,
		const fib_prefix_t *	prefix,
		mpls_label_t	label
	)

remove a MPLS local label for the prefix/route.

Parameters

fib_index	The index of the FIB
prefix	The prefix for the entry to which to add the label
label	The MPLS label to add

Definition at line 860 of file fib_table.c.

Here is the call graph for this function:

Here is the caller graph for this function:

fib_node_index_t fib_table_entry_path_add	(	u32	fib_index,
		const fib_prefix_t *	prefix,
		fib_source_t	source,
		fib_entry_flag_t	flags,
		fib_protocol_t	next_hop_proto,
		const ip46_address_t *	next_hop,
		u32	next_hop_sw_if_index,
		u32	next_hop_fib_index,
		u32	next_hop_weight,
		mpls_label_t *	next_hop_label_stack,
		fib_route_path_flags_t	pf
	)

Add one path to an entry (aka route) in the FIB.

If the entry does not exist, it will be created. See the documentation for fib_route_path_t for more descirptions of the path parameters.

Parameters

fib_index	The index of the FIB
prefix	The prefix for the entry to add
source	The ID of the client/source adding the entry.
flags	Flags for the entry.

next_hop_proto The protocol of the next hop. This cannot be derived in the event that the next hop is all zeros.

Parameters

next_hop	The address of the next-hop.
sw_if_index	The index of the interface.
next_hop_fib_index,The	fib index of the next-hop for recursive resolution
next_hop_weight	[un]equal cost path weight
next_hop_label_stack	The path's out-going label stack. NULL is there is none.
pf	Flags for the path

Returns: the index of the fib_entry_t that is created (or existed already).

Definition at line 477 of file fib_table.c.

Here is the call graph for this function:

Here is the caller graph for this function:

fib_node_index_t fib_table_entry_path_add2	(	u32	fib_index,
		const fib_prefix_t *	prefix,
		fib_source_t	source,
		fib_entry_flag_t	flags,
		fib_route_path_t *	rpath
	)

Add n paths to an entry (aka route) in the FIB.

If the entry does not exist, it will be created. See the documentation for fib_route_path_t for more descirptions of the path parameters.

Parameters

fib_index	The index of the FIB
prefix	The prefix for the entry to add
source	The ID of the client/source adding the entry.
flags	Flags for the entry.
rpaths	A vector of paths. Not const since they may be modified.

Returns: the index of the fib_entry_t that is created (or existed already).

Definition at line 511 of file fib_table.c.

Here is the call graph for this function:

Here is the caller graph for this function:

void fib_table_entry_path_remove	(	u32	fib_index,
		const fib_prefix_t *	prefix,
		fib_source_t	source,
		fib_protocol_t	next_hop_proto,
		const ip46_address_t *	next_hop,
		u32	next_hop_sw_if_index,
		u32	next_hop_fib_index,
		u32	next_hop_weight,
		fib_route_path_flags_t	pf
	)

remove one path to an entry (aka route) in the FIB.

If this is the entry's last path, then the entry will be removed, unless it has other sources. See the documentation for fib_route_path_t for more descirptions of the path parameters.

Parameters

fib_index	The index of the FIB
prefix	The prefix for the entry to add
source	The ID of the client/source adding the entry.

next_hop_proto The protocol of the next hop. This cannot be derived in the event that the next hop is all zeros.

Parameters

next_hop	The address of the next-hop.
sw_if_index	The index of the interface.
next_hop_fib_index,The	fib index of the next-hop for recursive resolution
next_hop_weight	[un]equal cost path weight
pf	Flags for the path

Definition at line 625 of file fib_table.c.

Here is the call graph for this function:

Here is the caller graph for this function:

void fib_table_entry_path_remove2	(	u32	fib_index,
		const fib_prefix_t *	prefix,
		fib_source_t	source,
		fib_route_path_t *	paths
	)

Remove n paths to an entry (aka route) in the FIB.

If this is the entry's last path, then the entry will be removed, unless it has other sources. See the documentation for fib_route_path_t for more descirptions of the path parameters.

Parameters

fib_index	The index of the FIB
prefix	The prefix for the entry to add
source	The ID of the client/source adding the entry.
rpaths	A vector of paths.

Definition at line 555 of file fib_table.c.

Here is the call graph for this function:

Here is the caller graph for this function:

fib_node_index_t fib_table_entry_special_add	(	u32	fib_index,
		const fib_prefix_t *	prefix,
		fib_source_t	source,
		fib_entry_flag_t	flags
	)

Add a 'special' entry to the FIB.

A special entry is an entry that the FIB is not expect to resolve via the usual mechanisms (i.e. recurisve or neighbour adj DB lookup). Instead the will link to a DPO valid for the source and/or the flags. This add is reference counting per-source. So n 'removes' are required for n 'adds', if the entry is no longer required. If the source needs to provide non-default forwarding use: fib_table_entry_special_dpo_add()

Parameters

fib_index	The index of the FIB
prefix	The prefix to add
source	The ID of the client/source adding the entry.
flags	Flags for the entry.

Returns: the index of the fib_entry_t that is created (or exists already).

Definition at line 369 of file fib_table.c.

Here is the call graph for this function:

Here is the caller graph for this function:

fib_node_index_t fib_table_entry_special_dpo_add	(	u32	fib_index,
		const fib_prefix_t *	prefix,
		fib_source_t	source,
		fib_entry_flag_t	stype,
		const dpo_id_t *	dpo
	)

Add a 'special' entry to the FIB that links to the DPO passed A special entry is an entry that the FIB is not expect to resolve via the usual mechanisms (i.e.

recurisve or neighbour adj DB lookup). Instead the client/source provides the DPO to link to. This add is reference counting per-source. So n 'removes' are required for n 'adds', if the entry is no longer required.

Parameters

fib_index	The index of the FIB
prefix	The prefix to add
source	The ID of the client/source adding the entry.
flags	Flags for the entry.
dpo	The DPO to link to.

Returns: the index of the fib_entry_t that is created (or existed already).

Definition at line 288 of file fib_table.c.

Here is the call graph for this function:

Here is the caller graph for this function:

fib_node_index_t fib_table_entry_special_dpo_update	(	u32	fib_index,
		const fib_prefix_t *	prefix,
		fib_source_t	source,
		fib_entry_flag_t	stype,
		const dpo_id_t *	dpo
	)

Update a 'special' entry to the FIB that links to the DPO passed A special entry is an entry that the FIB is not expect to resolve via the usual mechanisms (i.e.

recurisve or neighbour adj DB lookup). Instead the client/source provides the DPO to link to. Special entries are add/remove reference counted per-source. So n 'removes' are required for n 'adds', if the entry is no longer required. An 'update' is an 'add' if no 'add' has already been called, otherwise an 'add' is therefore assumed to act on the reference instance of that add.

Parameters

fib_entry_index	The index of the FIB entry to update
source	The ID of the client/source adding the entry.
flags	Flags for the entry.
dpo	The DPO to link to.

Returns: the index of the fib_entry_t that is created (or existed already).

Definition at line 327 of file fib_table.c.

Here is the call graph for this function:

Here is the caller graph for this function:

void fib_table_entry_special_remove	(	u32	fib_index,
		const fib_prefix_t *	prefix,
		fib_source_t	source
	)

Remove a 'special' entry from the FIB.

This add is reference counting per-source. So n 'removes' are required for n 'adds', if the entry is no longer required.

Parameters

fib_index	The index of the FIB
prefix	The prefix to remove
source	The ID of the client/source adding the entry.

Definition at line 388 of file fib_table.c.

Here is the call graph for this function:

Here is the caller graph for this function:

fib_node_index_t fib_table_entry_update	(	u32	fib_index,
		const fib_prefix_t *	prefix,
		fib_source_t	source,
		fib_entry_flag_t	flags,
		fib_route_path_t *	paths
	)

Update an entry to have a new set of paths.

If the entry does not exist, it will be created. The difference between an 'path-add' and an update, is that path-add is an incremental addition of paths, whereas an update is a wholesale swap.

Parameters

fib_index	The index of the FIB
prefix	The prefix for the entry to add
source	The ID of the client/source adding the entry.
rpaths	A vector of paths. Not const since they may be modified.

Returns: the index of the fib_entry_t that is created (or existed already).

Definition at line 667 of file fib_table.c.

Here is the call graph for this function:

Here is the caller graph for this function:

fib_node_index_t fib_table_entry_update_one_path	(	u32	fib_index,
		const fib_prefix_t *	prefix,
		fib_source_t	source,
		fib_entry_flag_t	flags,
		fib_protocol_t	next_hop_proto,
		const ip46_address_t *	next_hop,
		u32	next_hop_sw_if_index,
		u32	next_hop_fib_index,
		u32	next_hop_weight,
		mpls_label_t *	next_hop_label_stack,
		fib_route_path_flags_t	pf
	)

Update the entry to have just one path.

If the entry does not exist, it will be created. See the documentation for fib_route_path_t for more descirptions of the path parameters.

Parameters

fib_index	The index of the FIB
prefix	The prefix for the entry to add
source	The ID of the client/source adding the entry.
flags	Flags for the entry.

next_hop_proto The protocol of the next hop. This cannot be derived in the event that the next hop is all zeros.

Parameters

next_hop	The address of the next-hop.
sw_if_index	The index of the interface.
next_hop_fib_index,The	fib index of the next-hop for recursive resolution
next_hop_weight	[un]equal cost path weight
next_hop_label_stack	The path's out-going label stack. NULL is there is none.
pf	Flags for the path

Returns: the index of the fib_entry_t that is created (or existed already).

Definition at line 716 of file fib_table.c.

Here is the call graph for this function:

Here is the caller graph for this function:

u32 fib_table_find	(	fib_protocol_t	proto,
		u32	table_id
	)

Get the index of the FIB for a Table-ID.

This DOES NOT create the FIB if it does not exist.

proto The protocol of the FIB (and thus the entries therein)

Parameters

table-id The Table-ID

Returns: fib_index The index of the FIB, which may be INVALID.

Definition at line 938 of file fib_table.c.

Here is the call graph for this function:

Here is the caller graph for this function:

u32 fib_table_find_or_create_and_lock	(	fib_protocol_t	proto,
		u32	table_id
	)

Get the index of the FIB for a Table-ID.

This DOES create the FIB if it does not exist.

proto The protocol of the FIB (and thus the entries therein)

Parameters

table-id The Table-ID

Returns: fib_index The index of the FIB

Definition at line 954 of file fib_table.c.

Here is the call graph for this function:

Here is the caller graph for this function:

void fib_table_flush	(	u32	fib_index,
		fib_protocol_t	proto,
		fib_source_t	source
	)

Flush all entries from a table for the source.

Parameters

fib_index The index of the FIB

proto The protocol of the entries in the table

Parameters

source the source to flush

Definition at line 1139 of file fib_table.c.

Here is the call graph for this function:

Here is the caller graph for this function:

fib_table_t* fib_table_get	(	fib_node_index_t	index,
		fib_protocol_t	proto
	)

Get a pointer to a FIB table.

Definition at line 27 of file fib_table.c.

Here is the caller graph for this function:

flow_hash_config_t fib_table_get_flow_hash_config	(	u32	fib_index,
		fib_protocol_t	proto
	)

Get the flow hash configured used by the table.

Parameters

fib_index The index of the FIB

proto The protocol of the FIB (and thus the entries therein)

Returns: The flow hash config

Definition at line 908 of file fib_table.c.

Here is the call graph for this function:

Here is the caller graph for this function:

u32 fib_table_get_index_for_sw_if_index	(	fib_protocol_t	proto,
		u32	sw_if_index
	)

Get the index of the FIB bound to the interface.

proto The protocol of the FIB (and thus the entries therein)

Parameters

sw_if_index The interface index

Returns: fib_index The index of the FIB

Definition at line 892 of file fib_table.c.

Here is the call graph for this function:

Here is the caller graph for this function:

fib_node_index_t fib_table_get_less_specific	(	u32	fib_index,
		const fib_prefix_t *	prefix
	)

Get the less specific (covering) prefix.

Parameters

fib_index	The index of the FIB
prefix	The prefix to lookup

Returns: The index of the less specific fib_entry_t.

Definition at line 131 of file fib_table.c.

Here is the call graph for this function:

Here is the caller graph for this function:

u32 fib_table_get_num_entries	(	u32	fib_index,
		fib_protocol_t	proto,
		fib_source_t	source
	)

Return the number of entries in the FIB added by a given source.

Parameters

fib_index The index of the FIB

proto The protocol of the FIB (and thus the entries therein)

Returns: number of sourced entries.

Definition at line 1082 of file fib_table.c.

Here is the call graph for this function:

Here is the caller graph for this function:

u32 fib_table_get_table_id_for_sw_if_index	(	fib_protocol_t	proto,
		u32	sw_if_index
	)

Get the Table-ID of the FIB bound to the interface.

proto The protocol of the FIB (and thus the entries therein)

Parameters

sw_if_index The interface index

Returns: fib_index The tableID of the FIB

Definition at line 925 of file fib_table.c.

Here is the call graph for this function:

Here is the caller graph for this function:

void fib_table_lock	(	u32	fib_index,
		fib_protocol_t	proto
	)

Release a reference counting lock on the table.

When the last lock has gone. the FIB is deleted.

Parameters

fib_index The index of the FIB

proto The protocol of the FIB (and thus the entries therein)

Definition at line 1072 of file fib_table.c.

Here is the call graph for this function:

Here is the caller graph for this function:

fib_node_index_t fib_table_lookup	(	u32	fib_index,
		const fib_prefix_t *	prefix
	)

Perfom a longest prefix match in the non-forwarding table.

Parameters

fib_index	The index of the FIB
prefix	The prefix to lookup

Returns: The index of the fib_entry_t for the best match, which may be the default route

Definition at line 66 of file fib_table.c.

Here is the call graph for this function:

Here is the caller graph for this function:

fib_node_index_t fib_table_lookup_exact_match	(	u32	fib_index,
		const fib_prefix_t *	prefix
	)

Perfom an exact match in the non-forwarding table.

Parameters

fib_index	The index of the FIB
prefix	The prefix to lookup

Returns: The index of the fib_entry_t for the exact match, or INVALID is there is no match.

Definition at line 95 of file fib_table.c.

Here is the call graph for this function:

Here is the caller graph for this function:

void fib_table_unlock	(	u32	fib_index,
		fib_protocol_t	proto
	)

Take a reference counting lock on the table.

Parameters

fib_index The index of the FIB

proto The protocol of the FIB (and thus the entries therein)

Definition at line 1058 of file fib_table.c.

Here is the call graph for this function:

Here is the caller graph for this function:

void fib_table_walk	(	u32	fib_index,
		fib_protocol_t	proto,
		fib_table_walk_fn_t	fn,
		void *	ctx
	)

Walk all entries in a FIB table N.B: This is NOT safe to deletes.

If you need to delete walk the whole table and store elements in a vector, then delete the elements

Definition at line 1038 of file fib_table.c.

Here is the call graph for this function:

Here is the caller graph for this function:

u8* format_fib_table_name	(	u8 *	s,
		va_list	ap
	)

Format the description/name of the table.

Definition at line 1094 of file fib_table.c.

Here is the call graph for this function:

Here is the caller graph for this function:

Data Structures

Typedefs

Functions

Typedef Documentation

Function Documentation