summaryrefslogtreecommitdiffstats
path: root/src/vnet/fib/ip4_fib.h
blob: ff00b4170c40a6748e43443c53f984444061bb94 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
/*
 * Copyright (c) 2016 Cisco and/or its affiliates.
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at:
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
/**
 * @brief The IPv4 FIB
 *
 * FIBs are composed of two prefix data-bases (akak tables). The non-forwarding
 * table contains all the routes that the control plane has programmed, the
 * forwarding table contains the sub-set of those routes that can be used to
 * forward packets.
 * In the IPv4 FIB the non-forwarding table is an array of hash tables indexed
 * by mask length, the forwarding table is an mtrie
 *
 * This IPv4 FIB is used by the protocol independent FIB. So directly using
 * this APIs in client code is not encouraged. However, this IPv4 FIB can be
 * used if all the client wants is an IPv4 prefix data-base
 */

#ifndef __IP4_FIB_H__
#define __IP4_FIB_H__

#include <vlib/vlib.h>
#include <vnet/ip/ip.h>
#include <vnet/fib/fib_entry.h>
#include <vnet/fib/fib_table.h>
#include <vnet/ip/ip4_mtrie.h>

typedef struct ip4_fib_t_
{
  /** Required for pool_get_aligned */
  CLIB_CACHE_LINE_ALIGN_MARK(cacheline0);

  /**
   * Mtrie for fast lookups. Hash is used to maintain overlapping prefixes.
   * First member so it's in the first cacheline.
   */
  ip4_fib_mtrie_t mtrie;

  /* Hash table for each prefix length mapping. */
  uword *fib_entry_by_dst_address[33];

  /* Table ID (hash key) for this FIB. */
  u32 table_id;

  /* Index into FIB vector. */
  u32 index;
} ip4_fib_t;

extern fib_node_index_t ip4_fib_table_lookup(const ip4_fib_t *fib,
					     const ip4_address_t *addr,
					     u32 len);
extern fib_node_index_t ip4_fib_table_lookup_exact_match(const ip4_fib_t *fib,
							 const ip4_address_t *addr,
							 u32 len);

extern void ip4_fib_table_entry_remove(ip4_fib_t *fib,
				       const ip4_address_t *addr,
				       u32 len);

extern void ip4_fib_table_entry_insert(ip4_fib_t *fib,
				       const ip4_address_t *addr,
				       u32 len,
				       fib_node_index_t fib_entry_index);
extern void ip4_fib_table_destroy(u32 fib_index);

extern void ip4_fib_table_fwding_dpo_update(ip4_fib_t *fib,
					    const ip4_address_t *addr,
					    u32 len,
					    const dpo_id_t *dpo);

extern void ip4_fib_table_fwding_dpo_remove(ip4_fib_t *fib,
					    const ip4_address_t *addr,
					    u32 len,
					    const dpo_id_t *dpo,
                                            fib_node_index_t cover_index);
extern u32 ip4_fib_table_lookup_lb (ip4_fib_t *fib,
				    const ip4_address_t * dst);

/**
 * @brief 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
 */
extern void ip4_fib_table_walk(ip4_fib_t *fib,
                               fib_table_walk_fn_t fn,
                               void *ctx);

/**
 * @brief Walk all entries in a sub-tree of the 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
 */
extern void ip4_fib_table_sub_tree_walk(ip4_fib_t *fib,
                                        const fib_prefix_t *root,
                                        fib_table_walk_fn_t fn,
                                        void *ctx);

/**
 * @brief Get the FIB at the given index
 */
static inline ip4_fib_t *
ip4_fib_get (u32 index)
{
    return (pool_elt_at_index(ip4_main.v4_fibs, index));
}

always_inline u32
ip4_fib_lookup (ip4_main_t * im, u32 sw_if_index, ip4_address_t * dst)
{
    return (ip4_fib_table_lookup_lb(
		ip4_fib_get(vec_elt (im->fib_index_by_sw_if_index, sw_if_index)),
		dst));
}

/**
 * @brief Get or create an IPv4 fib.
 *
 * Get or create an IPv4 fib with the provided table ID.
 *
 * @param table_id
 *      When set to \c ~0, an arbitrary and unused fib ID is picked
 *      and can be retrieved with \c ret->table_id.
 *      Otherwise, the fib ID to be used to retrieve or create the desired fib.
 * @returns A pointer to the retrieved or created fib.
 *
 */
extern u32 ip4_fib_table_find_or_create_and_lock(u32 table_id,
                                                 fib_source_t src);
extern u32 ip4_fib_table_create_and_lock(fib_source_t src);

extern u8 *format_ip4_fib_table_memory(u8 * s, va_list * args);

static inline 
u32 ip4_fib_index_from_table_id (u32 table_id)
{
  ip4_main_t * im = &ip4_main;
  uword * p;

  p = hash_get (im->fib_index_by_table_id, table_id);
  if (!p)
    return ~0;

  return p[0];
}

extern u32 ip4_fib_table_get_index_for_sw_if_index(u32 sw_if_index);

always_inline index_t
ip4_fib_forwarding_lookup (u32 fib_index,
                           const ip4_address_t * addr)
{
    ip4_fib_mtrie_leaf_t leaf;
    ip4_fib_mtrie_t * mtrie;

    mtrie = &ip4_fib_get(fib_index)->mtrie;

    leaf = ip4_fib_mtrie_lookup_step_one (mtrie, addr);
    leaf = ip4_fib_mtrie_lookup_step (mtrie, leaf, addr, 2);
    leaf = ip4_fib_mtrie_lookup_step (mtrie, leaf, addr, 3);

    return (ip4_fib_mtrie_leaf_get_adj_index(leaf));
}


#endif
ter_problem, 1, unrecognized_next_header) \ _ (parameter_problem, 2, unrecognized_option) \ _ (parameter_problem, 3, first_fragment_has_incomplete_header_chain) \ _ (router_renumbering, 0, command) \ _ (router_renumbering, 1, result) \ _ (node_information_request, 0, data_contains_ip6_address) \ _ (node_information_request, 1, data_contains_name) \ _ (node_information_request, 2, data_contains_ip4_address) \ _ (node_information_response, 0, success) \ _ (node_information_response, 1, failed) \ _ (node_information_response, 2, unknown_request) typedef enum { #define _(n,f) ICMP4_##f = n, foreach_icmp4_type #undef _ } icmp4_type_t; typedef enum { #define _(t,n,f) ICMP4_##t##_##f = n, foreach_icmp4_code #undef _ } icmp4_code_t; typedef enum { #define _(n,f) ICMP6_##f = n, foreach_icmp6_type #undef _ } icmp6_type_t; typedef enum { #define _(t,n,f) ICMP6_##t##_##f = n, foreach_icmp6_code #undef _ } icmp6_code_t; typedef CLIB_PACKED (struct { u8 type; u8 code; /* IP checksum of icmp header plus data which follows. */ u16 checksum; }) icmp46_header_t; /* ip6 neighbor discovery */ #define foreach_icmp6_neighbor_discovery_option \ _ (1, source_link_layer_address) \ _ (2, target_link_layer_address) \ _ (3, prefix_information) \ _ (4, redirected_header) \ _ (5, mtu) \ _ (6, nbma_shortcut_limit) \ _ (7, advertisement_interval) \ _ (8, home_agent_information) \ _ (9, source_address_list) \ _ (10, target_address_list) \ _ (11, cryptographically_generated_address) \ _ (12, rsa_signature) \ _ (13, timestamp) \ _ (14, nonce) \ _ (15, trust_anchor) \ _ (16, certificate) \ _ (17, ip_address_and_prefix) \ _ (18, new_router_prefix_information) \ _ (19, mobile_link_layer_address) \ _ (20, neighbor_advertisement_acknowledgment) \ _ (23, map) \ _ (24, route_information) \ _ (25, recursive_dns_server) \ _ (26, ra_flags_extension) \ _ (27, handover_key_request) \ _ (28, handover_key_reply) \ _ (29, handover_assist_information) \ _ (30, mobile_node_identifier) \ _ (31, dns_search_list) \ _ (138, card_request) \ _ (139, card_reply) typedef enum icmp6_neighbor_discovery_option_type { #define _(n,f) ICMP6_NEIGHBOR_DISCOVERY_OPTION_##f = n, foreach_icmp6_neighbor_discovery_option #undef _ } icmp6_neighbor_discovery_option_type_t; typedef CLIB_PACKED (struct { /* Option type. */ u8 type; /* Length of this header plus option data in 8 byte units. */ u8 n_data_u64s; /* Option data follows. */ u8 data[0]; }) icmp6_neighbor_discovery_option_header_t; typedef CLIB_PACKED (struct { icmp6_neighbor_discovery_option_header_t header; u8 dst_address_length; u8 flags; #define ICMP6_NEIGHBOR_DISCOVERY_PREFIX_INFORMATION_FLAG_ON_LINK (1 << 7) #define ICMP6_NEIGHBOR_DISCOVERY_PREFIX_INFORMATION_AUTO (1 << 6) u32 valid_time; u32 preferred_time; u32 unused; ip6_address_t dst_address; }) icmp6_neighbor_discovery_prefix_information_option_t; typedef CLIB_PACKED (struct { u8 type; u8 aux_data_len_u32s; u16 num_sources; ip6_address_t mcast_addr; ip6_address_t source_addr[0]; }) icmp6_multicast_address_record_t; typedef CLIB_PACKED (struct { ip6_hop_by_hop_ext_t ext_hdr; ip6_router_alert_option_t alert; ip6_padN_option_t pad; icmp46_header_t icmp; u16 rsvd; u16 num_addr_records; icmp6_multicast_address_record_t records[0]; }) icmp6_multicast_listener_report_header_t; typedef CLIB_PACKED (struct { icmp6_neighbor_discovery_option_header_t header; u8 reserved[6]; /* IP6 header plus payload follows. */ u8 data[0]; }) icmp6_neighbor_discovery_redirected_header_option_t; typedef CLIB_PACKED (struct { icmp6_neighbor_discovery_option_header_t header; u16 unused; u32 mtu; }) icmp6_neighbor_discovery_mtu_option_t; typedef CLIB_PACKED (struct { icmp6_neighbor_discovery_option_header_t header; u8 ethernet_address[6]; }) icmp6_neighbor_discovery_ethernet_link_layer_address_option_t; typedef CLIB_PACKED (struct { icmp6_neighbor_discovery_option_header_t header; u8 max_l2_address[6 + 8]; }) icmp6_neighbor_discovery_max_link_layer_address_option_t; /* Generic neighbor discover header. Used for router solicitations, etc. */ typedef CLIB_PACKED (struct { icmp46_header_t icmp; u32 reserved_must_be_zero; }) icmp6_neighbor_discovery_header_t; /* Router advertisement packet formats. */ typedef CLIB_PACKED (struct { icmp46_header_t icmp; /* Current hop limit to use for outgoing packets. */ u8 current_hop_limit; u8 flags; #define ICMP6_ROUTER_DISCOVERY_FLAG_ADDRESS_CONFIG_VIA_DHCP (1 << 7) #define ICMP6_ROUTER_DISCOVERY_FLAG_OTHER_CONFIG_VIA_DHCP (1 << 6) /* Zero means unspecified. */ u16 router_lifetime_in_sec; /* Zero means unspecified. */ u32 neighbor_reachable_time_in_msec; /* Zero means unspecified. */ u32 time_in_msec_between_retransmitted_neighbor_solicitations; /* Options that may follow: source_link_layer_address, mtu, prefix_information. */ }) icmp6_router_advertisement_header_t; /* Neighbor solicitation/advertisement header. */ typedef CLIB_PACKED (struct { icmp46_header_t icmp; /* Zero for solicitation; flags for advertisement. */ u32 advertisement_flags; /* Set when sent by a router. */ #define ICMP6_NEIGHBOR_ADVERTISEMENT_FLAG_ROUTER (1 << 31) /* Set when response to solicitation. */ #define ICMP6_NEIGHBOR_ADVERTISEMENT_FLAG_SOLICITED (1 << 30) #define ICMP6_NEIGHBOR_ADVERTISEMENT_FLAG_OVERRIDE (1 << 29) ip6_address_t target_address; /* Options that may follow: source_link_layer_address (for solicitation) target_link_layer_address (for advertisement). */ }) icmp6_neighbor_solicitation_or_advertisement_header_t; typedef CLIB_PACKED (struct { icmp46_header_t icmp; u32 reserved_must_be_zero; /* Better next hop to use for given destination. */ ip6_address_t better_next_hop_address; ip6_address_t dst_address; /* Options that may follow: target_link_layer_address, redirected_header. */ }) icmp6_redirect_header_t; /* Solicitation/advertisement packet format for ethernet. */ typedef CLIB_PACKED (struct { ip6_header_t ip; icmp6_neighbor_solicitation_or_advertisement_header_t neighbor; icmp6_neighbor_discovery_ethernet_link_layer_address_option_t link_layer_option; }) icmp6_neighbor_solicitation_header_t; /* Router solicitation packet format for ethernet. */ typedef CLIB_PACKED (struct { ip6_header_t ip; icmp6_neighbor_discovery_header_t neighbor; icmp6_neighbor_discovery_ethernet_link_layer_address_option_t link_layer_option; }) icmp6_router_solicitation_header_t; /* router advertisement packet format for ethernet. */ typedef CLIB_PACKED (struct { ip6_header_t ip; icmp6_router_advertisement_header_t router; icmp6_neighbor_discovery_ethernet_link_layer_address_option_t link_layer_option; icmp6_neighbor_discovery_mtu_option_t mtu_option; icmp6_neighbor_discovery_prefix_information_option_t prefix[0]; }) icmp6_router_advertisement_packet_t; /* multicast listener report packet format for ethernet. */ typedef CLIB_PACKED (struct { ip6_header_t ip; icmp6_multicast_listener_report_header_t report_hdr; }) icmp6_multicast_listener_report_packet_t; #endif /* included_vnet_icmp46_packet_h */