Definitions for all things IP (v4|v6) unicast and multicast lookup related. More...

Include dependency graph for lookup.h:

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

Data Structures
struct	ip_adjacency_t_
	IP unicast adjacency. More...

struct	ip_interface_address_t

struct	ip_lookup_main_t

Macros
#define	IP4_LOOKUP_NEXT_NODES

#define	IP6_LOOKUP_NEXT_NODES

#define	IP_FLOW_HASH_SRC_ADDR (1<<0)
	Flow hash configuration. More...

#define	IP_FLOW_HASH_DST_ADDR (1<<1)

#define	IP_FLOW_HASH_PROTO (1<<2)

#define	IP_FLOW_HASH_SRC_PORT (1<<3)

#define	IP_FLOW_HASH_DST_PORT (1<<4)

#define	IP_FLOW_HASH_REVERSE_SRC_DST (1<<5)

#define	IP_FLOW_HASH_DEFAULT (0x1F)
	Default: 5-tuple without the "reverse" bit. More...

#define	foreach_flow_hash_bit

#define	ip_prefetch_adjacency(lm, adj_index, type)

#define	foreach_ip_interface_address(lm, a, sw_if_index, loop, body)

Typedefs
typedef u32	flow_hash_config_t
	A flow hash configuration is a mask of the flow hash options. More...

typedef void(*	adj_midchain_fixup_t) (vlib_main_t vm, struct ip_adjacency_t_ adj, vlib_buffer_t *b0)
	A function type for post-rewrite fixups on midchain adjacency. More...

typedef enum ip_adjacency_flags_t_	ip_adjacency_flags_t
	Flags on an IP adjacency. More...

typedef struct ip_adjacency_t_	ip_adjacency_t
	IP unicast adjacency. More...

typedef struct ip_lookup_main_t	ip_lookup_main_t

Enumerations
enum	ip_lookup_next_t { IP_LOOKUP_NEXT_DROP, IP_LOOKUP_NEXT_PUNT, IP_LOOKUP_NEXT_LOCAL, IP_LOOKUP_NEXT_ARP, IP_LOOKUP_NEXT_GLEAN, IP_LOOKUP_NEXT_REWRITE, IP_LOOKUP_NEXT_LOAD_BALANCE, IP_LOOKUP_NEXT_MIDCHAIN, IP_LOOKUP_NEXT_ICMP_ERROR, IP_LOOKUP_NEXT_MCAST, IP_LOOKUP_N_NEXT }
	Common (IP4/IP6) next index stored in adjacency. More...

enum	ip4_lookup_next_t { IP4_LOOKUP_N_NEXT = IP_LOOKUP_N_NEXT }

enum	ip6_lookup_next_t { IP6_LOOKUP_NEXT_HOP_BY_HOP = IP_LOOKUP_N_NEXT, IP6_LOOKUP_NEXT_ADD_HOP_BY_HOP, IP6_LOOKUP_NEXT_POP_HOP_BY_HOP, IP6_LOOKUP_N_NEXT }

enum	ip_adjacency_flags_t_ { IP_ADJ_SYNC_WALK_ACTIVE = (1 << 0) }
	Flags on an IP adjacency. More...

enum	ip_local_next_t { IP_LOCAL_NEXT_DROP, IP_LOCAL_NEXT_PUNT, IP_LOCAL_NEXT_UDP_LOOKUP, IP_LOCAL_NEXT_ICMP, IP_LOCAL_N_NEXT }

Functions
	STATIC_ASSERT ((STRUCT_OFFSET_OF(ip_adjacency_t, cacheline0)==0),"IP adjacency cachline 0 is not offset")

	STATIC_ASSERT ((STRUCT_OFFSET_OF(ip_adjacency_t, cacheline1)==CLIB_CACHE_LINE_BYTES),"IP adjacency cachline 1 is more than one cachline size offset")

static ip_adjacency_t *	ip_get_adjacency (ip_lookup_main_t *lm, u32 adj_index)

clib_error_t *	ip_interface_address_add_del (ip_lookup_main_t lm, u32 sw_if_index, void address, u32 address_length, u32 is_del, u32 *result_index)

u8 *	format_ip_flow_hash_config (u8 s, va_list args)

static ip_interface_address_t *	ip_get_interface_address (ip_lookup_main_t lm, void addr_fib)

u32	fib_table_id_find_fib_index (fib_protocol_t proto, u32 table_id)

static void *	ip_interface_address_get_address (ip_lookup_main_t lm, ip_interface_address_t a)

void	ip_lookup_init (ip_lookup_main_t *lm, u32 ip_lookup_node_index)

Variables
const ip46_address_t	zero_addr

Detailed Description

Definitions for all things IP (v4|v6) unicast and multicast lookup related.

Adjacency definitions and registration.
Callbacks on route add.
Callbacks on interface address change.

Definition in file lookup.h.

Macro Definition Documentation

#define foreach_flow_hash_bit

Value:

_(src, IP_FLOW_HASH_SRC_ADDR)                   \
_(dst, IP_FLOW_HASH_DST_ADDR)                   \
_(sport, IP_FLOW_HASH_SRC_PORT)                 \
_(dport, IP_FLOW_HASH_DST_PORT)                 \
_(proto, IP_FLOW_HASH_PROTO)                    \
_(reverse, IP_FLOW_HASH_REVERSE_SRC_DST)

Definition at line 154 of file lookup.h.

#define foreach_ip_interface_address	(	lm,
		a,
		sw_if_index,
		loop,
		body
	)

Value:

do {                                                                    \
    vnet_main_t *_vnm = vnet_get_main();                                \
    u32 _sw_if_index = sw_if_index;                                     \
    vnet_sw_interface_t *_swif;                                         \
    _swif = vnet_get_sw_interface (_vnm, _sw_if_index);                 \
                                                                        \
    /*                                                                  \
     * Loop => honor unnumbered interface addressing.                   \
     */                                                                 \
    if (_swif->flags & VNET_SW_INTERFACE_FLAG_UNNUMBERED)               \
      {                                                                 \
        if (loop)                                                       \
          _sw_if_index = _swif->unnumbered_sw_if_index;                 \
        else                                                            \
          /* the interface is unnumbered, by the caller does not want   \
           * unnumbered interfaces considered/honoured */               \
          break;                                                        \
      }                                                                 \
    u32 _ia = ((vec_len((lm)->if_address_pool_index_by_sw_if_index)     \
                > (_sw_if_index)) ?                                     \
               vec_elt ((lm)->if_address_pool_index_by_sw_if_index,     \
                        (_sw_if_index)) :                               \
               (u32)~0);                                                \
    ip_interface_address_t * _a;                                        \
    while (_ia != ~0)                                                   \
    {                                                                   \
        _a = pool_elt_at_index ((lm)->if_address_pool, _ia);            \
        _ia = _a->next_this_sw_interface;                               \
        (a) = _a;                                                       \
        body;                                                           \
    }                                                                   \
} while (0)

Definition at line 417 of file lookup.h.

#define IP4_LOOKUP_NEXT_NODES

Value:

{                                       \
    [IP_LOOKUP_NEXT_DROP] = "ip4-drop",                         \
    [IP_LOOKUP_NEXT_PUNT] = "ip4-punt",                         \
    [IP_LOOKUP_NEXT_LOCAL] = "ip4-local",                       \
    [IP_LOOKUP_NEXT_ARP] = "ip4-arp",                           \
    [IP_LOOKUP_NEXT_GLEAN] = "ip4-glean",                       \
    [IP_LOOKUP_NEXT_REWRITE] = "ip4-rewrite",                   \
    [IP_LOOKUP_NEXT_MCAST] = "ip4-rewrite-mcast",               \
    [IP_LOOKUP_NEXT_MIDCHAIN] = "ip4-midchain",                 \
    [IP_LOOKUP_NEXT_LOAD_BALANCE] = "ip4-load-balance",         \
    [IP_LOOKUP_NEXT_ICMP_ERROR] = "ip4-icmp-error",             \
}

Definition at line 114 of file lookup.h.

#define IP6_LOOKUP_NEXT_NODES

Value:

{                                       \
    [IP_LOOKUP_NEXT_DROP] = "ip6-drop",                         \
    [IP_LOOKUP_NEXT_PUNT] = "ip6-punt",                         \
    [IP_LOOKUP_NEXT_LOCAL] = "ip6-local",                       \
    [IP_LOOKUP_NEXT_ARP] = "ip6-discover-neighbor",             \
    [IP_LOOKUP_NEXT_GLEAN] = "ip6-glean",                       \
    [IP_LOOKUP_NEXT_REWRITE] = "ip6-rewrite",                   \
    [IP_LOOKUP_NEXT_MCAST] = "ip6-rewrite-mcast",               \
    [IP_LOOKUP_NEXT_MIDCHAIN] = "ip6-midchain",                 \
    [IP_LOOKUP_NEXT_LOAD_BALANCE] = "ip6-load-balance",         \
    [IP_LOOKUP_NEXT_ICMP_ERROR] = "ip6-icmp-error",             \
    [IP6_LOOKUP_NEXT_HOP_BY_HOP] = "ip6-hop-by-hop",            \
    [IP6_LOOKUP_NEXT_ADD_HOP_BY_HOP] = "ip6-add-hop-by-hop",    \
    [IP6_LOOKUP_NEXT_POP_HOP_BY_HOP] = "ip6-pop-hop-by-hop",    \
}

Definition at line 127 of file lookup.h.

#define IP_FLOW_HASH_DEFAULT (0x1F)

Default: 5-tuple without the "reverse" bit.

Definition at line 152 of file lookup.h.

#define IP_FLOW_HASH_DST_ADDR (1<<1)

Definition at line 145 of file lookup.h.

#define IP_FLOW_HASH_DST_PORT (1<<4)

Definition at line 148 of file lookup.h.

#define IP_FLOW_HASH_PROTO (1<<2)

Definition at line 146 of file lookup.h.

#define IP_FLOW_HASH_REVERSE_SRC_DST (1<<5)

Definition at line 149 of file lookup.h.

#define IP_FLOW_HASH_SRC_ADDR (1<<0)

Flow hash configuration.

Definition at line 144 of file lookup.h.

#define IP_FLOW_HASH_SRC_PORT (1<<3)

Definition at line 147 of file lookup.h.

#define ip_prefetch_adjacency	(	lm,
		adj_index,
		type
	)

Value:

do {                                                            \
  ip_adjacency_t * _adj = (lm)->adjacency_heap + (adj_index);   \
  CLIB_PREFETCH (_adj, sizeof (_adj[0]), type);                 \
} while (0)

Definition at line 386 of file lookup.h.

Typedef Documentation

typedef void(* adj_midchain_fixup_t) (vlib_main_t *vm, struct ip_adjacency_t_ *adj, vlib_buffer_t *b0)

A function type for post-rewrite fixups on midchain adjacency.

Definition at line 175 of file lookup.h.

typedef u32 flow_hash_config_t

A flow hash configuration is a mask of the flow hash options.

Definition at line 165 of file lookup.h.

typedef enum ip_adjacency_flags_t_ ip_adjacency_flags_t

Flags on an IP adjacency.

typedef struct ip_adjacency_t_ ip_adjacency_t

IP unicast adjacency.

Note: cache aligned.

typedef struct ip_lookup_main_t ip_lookup_main_t

Enumeration Type Documentation

enum ip4_lookup_next_t

Enumerator
IP4_LOOKUP_N_NEXT

Definition at line 100 of file lookup.h.

enum ip6_lookup_next_t

Enumerator
IP6_LOOKUP_NEXT_HOP_BY_HOP
IP6_LOOKUP_NEXT_ADD_HOP_BY_HOP
IP6_LOOKUP_NEXT_POP_HOP_BY_HOP
IP6_LOOKUP_N_NEXT

Definition at line 105 of file lookup.h.

enum ip_adjacency_flags_t_

Flags on an IP adjacency.

Enumerator

IP_ADJ_SYNC_WALK_ACTIVE

Currently a sync walk is active.

Used to prevent re-entrant walking

Definition at line 182 of file lookup.h.

enum ip_local_next_t

Enumerator
IP_LOCAL_NEXT_DROP
IP_LOCAL_NEXT_PUNT
IP_LOCAL_NEXT_UDP_LOOKUP
IP_LOCAL_NEXT_ICMP
IP_LOCAL_N_NEXT

Definition at line 317 of file lookup.h.

enum ip_lookup_next_t

Common (IP4/IP6) next index stored in adjacency.

Enumerator
IP_LOOKUP_NEXT_DROP	Adjacency to drop this packet.
IP_LOOKUP_NEXT_PUNT	Adjacency to punt this packet.
IP_LOOKUP_NEXT_LOCAL	This packet is for one of our own IP addresses.
IP_LOOKUP_NEXT_ARP	This packet matches an "incomplete adjacency" and packets need to be passed to ARP to find rewrite string for this destination.
IP_LOOKUP_NEXT_GLEAN	This packet matches an "interface route" and packets need to be passed to ARP to find rewrite string for this destination.
IP_LOOKUP_NEXT_REWRITE	This packet is to be rewritten and forwarded to the next processing node. This is typically the output interface but might be another node for further output processing.
IP_LOOKUP_NEXT_LOAD_BALANCE	This packets follow a load-balance.
IP_LOOKUP_NEXT_MIDCHAIN	This packets follow a mid-chain adjacency.
IP_LOOKUP_NEXT_ICMP_ERROR	This packets needs to go to ICMP error.
IP_LOOKUP_NEXT_MCAST	Multicast Adjacency.
IP_LOOKUP_N_NEXT

Definition at line 60 of file lookup.h.

Function Documentation

u32 fib_table_id_find_fib_index	(	fib_protocol_t	proto,
		u32	table_id
	)

Definition at line 360 of file lookup.c.

Here is the caller graph for this function:

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

Definition at line 240 of file lookup.c.

static ip_adjacency_t* ip_get_adjacency	(	ip_lookup_main_t *	lm,
		u32	adj_index
	)

inlinestatic

Definition at line 377 of file lookup.h.

Here is the caller graph for this function:

static ip_interface_address_t* ip_get_interface_address	(	ip_lookup_main_t *	lm,
		void *	addr_fib
	)

inlinestatic

Definition at line 401 of file lookup.h.

Here is the call graph for this function:

clib_error_t* ip_interface_address_add_del	(	ip_lookup_main_t *	lm,
		u32	sw_if_index,
		void *	address,
		u32	address_length,
		u32	is_del,
		u32 *	result_index
	)

Definition at line 61 of file lookup.c.

Here is the call graph for this function:

Here is the caller graph for this function:

static void* ip_interface_address_get_address	(	ip_lookup_main_t *	lm,
		ip_interface_address_t *	a
	)

inlinestatic

Definition at line 410 of file lookup.h.

Here is the call graph for this function:

Here is the caller graph for this function:

void ip_lookup_init	(	ip_lookup_main_t *	lm,
		u32	ip_lookup_node_index
	)

Definition at line 189 of file lookup.c.

Here is the call graph for this function:

Here is the caller graph for this function:

STATIC_ASSERT	(	(STRUCT_OFFSET_OF(ip_adjacency_t, cacheline0)==0)	,
		"IP adjacency cachline 0 is not offset"
	)

STATIC_ASSERT	(	(STRUCT_OFFSET_OF(ip_adjacency_t, cacheline1)==CLIB_CACHE_LINE_BYTES)	,
		"IP adjacency cachline 1 is more than one cachline size offset"
	)

Variable Documentation

const ip46_address_t zero_addr

Definition at line 354 of file lookup.c.

Data Structures

Macros

Typedefs

Enumerations

Functions

Variables

Detailed Description

Macro Definition Documentation

Typedef Documentation

Enumeration Type Documentation

Function Documentation

Variable Documentation