2 * Copyright (c) 2016 Cisco and/or its affiliates.
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at:
7 * http://www.apache.org/licenses/LICENSE-2.0
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
16 #ifndef __FIB_TYPES_H__
17 #define __FIB_TYPES_H__
19 #include <vlib/vlib.h>
20 #include <vnet/ip/ip6_packet.h>
21 #include <vnet/mpls/packet.h>
22 #include <vnet/dpo/dpo.h>
25 * A typedef of a node index.
26 * we make this typedef so the code becomes easier for a human to parse.
28 typedef u32 fib_node_index_t;
29 #define FIB_NODE_INDEX_INVALID ((fib_node_index_t)(~0))
32 * Protocol Type. packed so it consumes a u8 only
34 typedef enum fib_protocol_t_ {
38 } __attribute__ ((packed)) fib_protocol_t;
40 #define FIB_PROTOCOLS { \
41 [FIB_PROTOCOL_IP4] = "ipv4", \
42 [FIB_PROTOCOL_IP6] = "ipv6", \
43 [FIB_PROTOCOL_MPLS] = "MPLS", \
47 * Definition outside of enum so it does not need to be included in non-defaulted
50 #define FIB_PROTOCOL_MAX (FIB_PROTOCOL_MPLS + 1)
53 * Not part of the enum so it does not have to be handled in switch statements
55 #define FIB_PROTOCOL_NONE (FIB_PROTOCOL_MAX+1)
57 #define FOR_EACH_FIB_PROTOCOL(_item) \
58 for (_item = FIB_PROTOCOL_IP4; \
59 _item <= FIB_PROTOCOL_MPLS; \
62 #define FOR_EACH_FIB_IP_PROTOCOL(_item) \
63 for (_item = FIB_PROTOCOL_IP4; \
64 _item <= FIB_PROTOCOL_IP6; \
68 * @brief Convert from a protocol to a link type
70 vnet_link_t fib_proto_to_link (fib_protocol_t proto);
73 * FIB output chain type. When a child object requests a forwarding contribution
74 * from a parent, it does so for a particular scenario. This enumererates those
77 typedef enum fib_forward_chain_type_t_ {
79 * Contribute an object that is to be used to forward IP4 packets
81 FIB_FORW_CHAIN_TYPE_UNICAST_IP4,
83 * Contribute an object that is to be used to forward IP6 packets
85 FIB_FORW_CHAIN_TYPE_UNICAST_IP6,
87 * Contribute an object that is to be used to forward non-end-of-stack
90 FIB_FORW_CHAIN_TYPE_MPLS_NON_EOS,
92 * Contribute an object that is to be used to forward end-of-stack
93 * MPLS packets. This is a convenient ID for clients. A real EOS chain
94 * must be pay-load protocol specific. This
95 * option is converted into one of the other three internally.
97 FIB_FORW_CHAIN_TYPE_MPLS_EOS,
99 * Contribute an object that is to be used to forward IP4 packets
101 FIB_FORW_CHAIN_TYPE_MCAST_IP4,
103 * Contribute an object that is to be used to forward IP6 packets
105 FIB_FORW_CHAIN_TYPE_MCAST_IP6,
107 * Contribute an object that is to be used to forward Ethernet packets.
109 FIB_FORW_CHAIN_TYPE_ETHERNET,
111 * Contribute an object that is to be used to forward NSH packets.
112 * This is last in the list since it is not valid for many FIB objects,
113 * and thus their array of per-chain-type DPOs can be sized smaller.
115 FIB_FORW_CHAIN_TYPE_NSH,
116 } __attribute__ ((packed)) fib_forward_chain_type_t;
118 #define FIB_FORW_CHAINS { \
119 [FIB_FORW_CHAIN_TYPE_ETHERNET] = "ethernet", \
120 [FIB_FORW_CHAIN_TYPE_UNICAST_IP4] = "unicast-ip4", \
121 [FIB_FORW_CHAIN_TYPE_UNICAST_IP6] = "unicast-ip6", \
122 [FIB_FORW_CHAIN_TYPE_MCAST_IP4] = "multicast-ip4", \
123 [FIB_FORW_CHAIN_TYPE_MCAST_IP6] = "multicast-ip6", \
124 [FIB_FORW_CHAIN_TYPE_MPLS_NON_EOS] = "mpls-neos", \
125 [FIB_FORW_CHAIN_TYPE_MPLS_EOS] = "mpls-eos", \
126 [FIB_FORW_CHAIN_TYPE_NSH] = "nsh", \
129 #define FIB_FORW_CHAIN_NUM (FIB_FORW_CHAIN_TYPE_NSH+1)
130 #define FIB_FORW_CHAIN_MPLS_NUM (FIB_FORW_CHAIN_TYPE_MPLS_EOS+1)
132 #define FOR_EACH_FIB_FORW_CHAIN(_item) \
133 for (_item = FIB_FORW_CHAIN_TYPE_UNICAST_IP4; \
134 _item <= FIB_FORW_CHAIN_TYPE_NSH; \
137 #define FOR_EACH_FIB_FORW_MPLS_CHAIN(_item) \
138 for (_item = FIB_FORW_CHAIN_TYPE_UNICAST_IP4; \
139 _item <= FIB_FORW_CHAIN_TYPE_MPLS_EOS; \
143 * @brief Convert from a chain type to the adjacencies link type
145 extern vnet_link_t fib_forw_chain_type_to_link_type(fib_forward_chain_type_t fct);
148 * @brief Convert from a payload-protocol to a chain type.
150 extern fib_forward_chain_type_t fib_forw_chain_type_from_dpo_proto(dpo_proto_t proto);
153 * @brief Convert from a chain type to the DPO proto it will install
155 extern dpo_proto_t fib_forw_chain_type_to_dpo_proto(fib_forward_chain_type_t fct);
158 * Aggregrate type for a prefix
160 typedef struct fib_prefix_t_ {
169 fib_protocol_t fp_proto;
172 * Pad to keep the address 4 byte aligned
178 * The address type is not deriveable from the fp_addr member.
179 * If it's v4, then the first 3 u32s of the address will be 0.
180 * v6 addresses (even v4 mapped ones) have at least 2 u32s assigned
181 * to non-zero values. true. but when it's all zero, one cannot decide.
183 ip46_address_t fp_addr;
186 mpls_label_t fp_label;
187 mpls_eos_bit_t fp_eos;
189 * This protocol determines the payload protocol of packets
190 * that will be forwarded by this entry once the label is popped.
191 * For a non-eos entry it will be MPLS.
193 dpo_proto_t fp_payload_proto;
198 STATIC_ASSERT(STRUCT_OFFSET_OF(fib_prefix_t, fp_addr) == 4,
199 "FIB Prefix's address is 4 byte aligned.");
202 * \brief Compare two prefixes for equality
204 extern int fib_prefix_cmp(const fib_prefix_t *p1,
205 const fib_prefix_t *p2);
208 * \brief Compare two prefixes for covering relationship
210 * \return non-zero if the first prefix is a cover for the second
212 extern int fib_prefix_is_cover(const fib_prefix_t *p1,
213 const fib_prefix_t *p2);
216 * \brief Return true is the prefix is a host prefix
218 extern int fib_prefix_is_host(const fib_prefix_t *p);
222 * \brief Host prefix from ip
224 extern void fib_prefix_from_ip46_addr (const ip46_address_t *addr,
227 extern u8 * format_fib_prefix(u8 * s, va_list * args);
228 extern u8 * format_fib_forw_chain_type(u8 * s, va_list * args);
230 extern dpo_proto_t fib_proto_to_dpo(fib_protocol_t fib_proto);
231 extern fib_protocol_t dpo_proto_to_fib(dpo_proto_t dpo_proto);
234 * Enurmeration of special path/entry types
236 typedef enum fib_special_type_t_ {
238 * Marker. Add new types after this one.
240 FIB_SPECIAL_TYPE_FIRST = 0,
244 FIB_SPECIAL_TYPE_LOCAL = FIB_SPECIAL_TYPE_FIRST,
248 FIB_SPECIAL_TYPE_DROP,
250 * Marker. Add new types before this one, then update it.
252 FIB_SPECIAL_TYPE_LAST = FIB_SPECIAL_TYPE_DROP,
253 } __attribute__ ((packed)) fib_special_type_t;
256 * The maximum number of types
258 #define FIB_SPEICAL_TYPE_MAX (FIB_SPEICAL_TYPE_LAST + 1)
260 #define FOR_EACH_FIB_SPEICAL_TYPE(_item) \
261 for (_item = FIB_TYPE_SPEICAL_FIRST; \
262 _item <= FIB_SPEICAL_TYPE_LAST; _item++)
264 extern u8 * format_fib_protocol(u8 * s, va_list ap);
265 extern u8 * format_vnet_link(u8 *s, va_list ap);
268 * Path flags from the control plane
270 typedef enum fib_route_path_flags_t_
272 FIB_ROUTE_PATH_FLAG_NONE = 0,
274 * Recursion constraint of via a host prefix
276 FIB_ROUTE_PATH_RESOLVE_VIA_HOST = (1 << 0),
278 * Recursion constraint of via an attahced prefix
280 FIB_ROUTE_PATH_RESOLVE_VIA_ATTACHED = (1 << 1),
282 * A for-us/local path
284 FIB_ROUTE_PATH_LOCAL = (1 << 2),
285 } fib_route_path_flags_t;
289 * A representation of a path as described by a route producer.
290 * These paramenters will determine the path 'type', of which there are:
291 * 1) Attached-next-hop:
292 * a single peer on a link.
293 * It is 'attached' because it is in the same sub-net as the router, on a link
294 * directly connected to the route.
295 * It is 'next=hop' since the next-hop address of the peer is known.
297 * the next-hop is not known. but we can ARP for it.
299 * The next-hop is known but the interface is not. So to find the adj to use
300 * we must recursively resolve the next-hop.
301 * 3) deaggregate (deag)
302 * A further lookup is required.
304 typedef struct fib_route_path_t_ {
306 * The protocol of the address below. We need this since the all
307 * zeros address is ambiguous.
309 fib_protocol_t frp_proto;
313 * The next-hop address.
314 * Will be NULL for attached paths.
315 * Will be all zeros for attached-next-hop paths on a p2p interface
316 * Will be all zeros for a deag path.
318 ip46_address_t frp_addr;
321 * The MPLS local Label to reursively resolve through.
322 * This is valid when the path type is MPLS.
324 mpls_label_t frp_local_label;
328 * Will be invalid for recursive paths.
332 * The FIB index to lookup the nexthop
333 * Only valid for recursive paths.
337 * [un]equal cost path weight
343 fib_route_path_flags_t frp_flags;
345 * The outgoing MPLS label Stack. NULL implies no label.
347 mpls_label_t *frp_label_stack;
352 * A representation of a fib path for fib_path_encode to convey the information to the caller
354 typedef struct fib_route_path_encode_t_ {
355 fib_route_path_t rpath;
357 } fib_route_path_encode_t;