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>
23 #include <vnet/bier/bier_types.h>
26 * A typedef of a node index.
27 * we make this typedef so the code becomes easier for a human to parse.
29 typedef u32 fib_node_index_t;
30 #define FIB_NODE_INDEX_INVALID ((fib_node_index_t)(~0))
33 * Protocol Type. packed so it consumes a u8 only
35 typedef enum fib_protocol_t_ {
36 FIB_PROTOCOL_IP4 = DPO_PROTO_IP4,
37 FIB_PROTOCOL_IP6 = DPO_PROTO_IP6,
38 FIB_PROTOCOL_MPLS = DPO_PROTO_MPLS,
39 } __attribute__ ((packed)) fib_protocol_t;
41 #define FIB_PROTOCOLS { \
42 [FIB_PROTOCOL_IP4] = "ipv4", \
43 [FIB_PROTOCOL_IP6] = "ipv6", \
44 [FIB_PROTOCOL_MPLS] = "MPLS", \
48 * Definition outside of enum so it does not need to be included in non-defaulted
51 #define FIB_PROTOCOL_MAX (FIB_PROTOCOL_MPLS + 1)
54 * Definition outside of enum so it does not need to be included in non-defaulted
57 #define FIB_PROTOCOL_IP_MAX (FIB_PROTOCOL_IP6 + 1)
60 * Not part of the enum so it does not have to be handled in switch statements
62 #define FIB_PROTOCOL_NONE (FIB_PROTOCOL_MAX+1)
64 #define FOR_EACH_FIB_PROTOCOL(_item) \
65 for (_item = FIB_PROTOCOL_IP4; \
66 _item <= FIB_PROTOCOL_MPLS; \
69 #define FOR_EACH_FIB_IP_PROTOCOL(_item) \
70 for (_item = FIB_PROTOCOL_IP4; \
71 _item <= FIB_PROTOCOL_IP6; \
75 * @brief Convert from a protocol to a link type
77 vnet_link_t fib_proto_to_link (fib_protocol_t proto);
80 * FIB output chain type. When a child object requests a forwarding contribution
81 * from a parent, it does so for a particular scenario. This enumererates those
84 typedef enum fib_forward_chain_type_t_ {
86 * Contribute an object that is to be used to forward IP4 packets
88 FIB_FORW_CHAIN_TYPE_UNICAST_IP4,
90 * Contribute an object that is to be used to forward IP6 packets
92 FIB_FORW_CHAIN_TYPE_UNICAST_IP6,
94 * Contribute an object that is to be used to forward non-end-of-stack
97 FIB_FORW_CHAIN_TYPE_MPLS_NON_EOS,
99 * Contribute an object that is to be used to forward BIER packets.
101 FIB_FORW_CHAIN_TYPE_BIER,
103 * Contribute an object that is to be used to forward end-of-stack
104 * MPLS packets. This is a convenient ID for clients. A real EOS chain
105 * must be pay-load protocol specific. This
106 * option is converted into one of the other three internally.
108 FIB_FORW_CHAIN_TYPE_MPLS_EOS,
110 * Contribute an object that is to be used to forward IP4 packets
112 FIB_FORW_CHAIN_TYPE_MCAST_IP4,
114 * Contribute an object that is to be used to forward IP6 packets
116 FIB_FORW_CHAIN_TYPE_MCAST_IP6,
118 * Contribute an object that is to be used to forward Ethernet packets.
120 FIB_FORW_CHAIN_TYPE_ETHERNET,
122 * Contribute an object that is to be used to forward NSH packets.
123 * This is last in the list since it is not valid for many FIB objects,
124 * and thus their array of per-chain-type DPOs can be sized smaller.
126 FIB_FORW_CHAIN_TYPE_NSH,
127 } __attribute__ ((packed)) fib_forward_chain_type_t;
129 #define FIB_FORW_CHAINS { \
130 [FIB_FORW_CHAIN_TYPE_ETHERNET] = "ethernet", \
131 [FIB_FORW_CHAIN_TYPE_BIER] = "bier", \
132 [FIB_FORW_CHAIN_TYPE_UNICAST_IP4] = "unicast-ip4", \
133 [FIB_FORW_CHAIN_TYPE_UNICAST_IP6] = "unicast-ip6", \
134 [FIB_FORW_CHAIN_TYPE_MCAST_IP4] = "multicast-ip4", \
135 [FIB_FORW_CHAIN_TYPE_MCAST_IP6] = "multicast-ip6", \
136 [FIB_FORW_CHAIN_TYPE_MPLS_NON_EOS] = "mpls-neos", \
137 [FIB_FORW_CHAIN_TYPE_MPLS_EOS] = "mpls-eos", \
138 [FIB_FORW_CHAIN_TYPE_NSH] = "nsh", \
141 #define FIB_FORW_CHAIN_NUM (FIB_FORW_CHAIN_TYPE_NSH+1)
142 #define FIB_FORW_CHAIN_MPLS_NUM (FIB_FORW_CHAIN_TYPE_MPLS_EOS+1)
144 #define FOR_EACH_FIB_FORW_CHAIN(_item) \
145 for (_item = FIB_FORW_CHAIN_TYPE_UNICAST_IP4; \
146 _item <= FIB_FORW_CHAIN_TYPE_NSH; \
149 #define FOR_EACH_FIB_FORW_MPLS_CHAIN(_item) \
150 for (_item = FIB_FORW_CHAIN_TYPE_UNICAST_IP4; \
151 _item <= FIB_FORW_CHAIN_TYPE_MPLS_EOS; \
155 * @brief Convert from a chain type to the adjacencies link type
157 extern vnet_link_t fib_forw_chain_type_to_link_type(fib_forward_chain_type_t fct);
160 * @brief Convert from a payload-protocol to a chain type.
162 extern fib_forward_chain_type_t fib_forw_chain_type_from_dpo_proto(dpo_proto_t proto);
165 * @brief Convert from a chain type to the DPO proto it will install
167 extern dpo_proto_t fib_forw_chain_type_to_dpo_proto(fib_forward_chain_type_t fct);
170 * Aggregrate type for a prefix
172 typedef struct fib_prefix_t_ {
181 fib_protocol_t fp_proto;
184 * Pad to keep the address 4 byte aligned
190 * The address type is not deriveable from the fp_addr member.
191 * If it's v4, then the first 3 u32s of the address will be 0.
192 * v6 addresses (even v4 mapped ones) have at least 2 u32s assigned
193 * to non-zero values. true. but when it's all zero, one cannot decide.
195 ip46_address_t fp_addr;
198 mpls_label_t fp_label;
199 mpls_eos_bit_t fp_eos;
201 * This protocol determines the payload protocol of packets
202 * that will be forwarded by this entry once the label is popped.
203 * For a non-eos entry it will be MPLS.
205 dpo_proto_t fp_payload_proto;
210 STATIC_ASSERT(STRUCT_OFFSET_OF(fib_prefix_t, fp_addr) == 4,
211 "FIB Prefix's address is 4 byte aligned.");
214 * \brief Compare two prefixes for equality
216 extern int fib_prefix_cmp(const fib_prefix_t *p1,
217 const fib_prefix_t *p2);
220 * \brief Compare two prefixes for covering relationship
222 * \return non-zero if the first prefix is a cover for the second
224 extern int fib_prefix_is_cover(const fib_prefix_t *p1,
225 const fib_prefix_t *p2);
228 * \brief Return true is the prefix is a host prefix
230 extern int fib_prefix_is_host(const fib_prefix_t *p);
234 * \brief Host prefix from ip
236 extern void fib_prefix_from_ip46_addr (const ip46_address_t *addr,
239 extern u8 * format_fib_prefix(u8 * s, va_list * args);
240 extern u8 * format_fib_forw_chain_type(u8 * s, va_list * args);
242 extern dpo_proto_t fib_proto_to_dpo(fib_protocol_t fib_proto);
243 extern fib_protocol_t dpo_proto_to_fib(dpo_proto_t dpo_proto);
246 * Convert from BIER next-hop proto to FIB proto
248 extern fib_protocol_t bier_hdr_proto_to_fib(bier_hdr_proto_id_t bproto);
251 * Enurmeration of special path/entry types
253 typedef enum fib_special_type_t_ {
255 * Marker. Add new types after this one.
257 FIB_SPECIAL_TYPE_FIRST = 0,
261 FIB_SPECIAL_TYPE_LOCAL = FIB_SPECIAL_TYPE_FIRST,
265 FIB_SPECIAL_TYPE_DROP,
267 * Marker. Add new types before this one, then update it.
269 FIB_SPECIAL_TYPE_LAST = FIB_SPECIAL_TYPE_DROP,
270 } __attribute__ ((packed)) fib_special_type_t;
273 * The maximum number of types
275 #define FIB_SPEICAL_TYPE_MAX (FIB_SPEICAL_TYPE_LAST + 1)
277 #define FOR_EACH_FIB_SPEICAL_TYPE(_item) \
278 for (_item = FIB_TYPE_SPEICAL_FIRST; \
279 _item <= FIB_SPEICAL_TYPE_LAST; _item++)
281 extern u8 * format_fib_protocol(u8 * s, va_list *ap);
282 extern u8 * format_vnet_link(u8 *s, va_list *ap);
285 * Path flags from the control plane
287 typedef enum fib_route_path_flags_t_
289 FIB_ROUTE_PATH_FLAG_NONE = 0,
291 * Recursion constraint of via a host prefix
293 FIB_ROUTE_PATH_RESOLVE_VIA_HOST = (1 << 0),
295 * Recursion constraint of via an attahced prefix
297 FIB_ROUTE_PATH_RESOLVE_VIA_ATTACHED = (1 << 1),
299 * A for-us/local path
301 FIB_ROUTE_PATH_LOCAL = (1 << 2),
305 FIB_ROUTE_PATH_ATTACHED = (1 << 3),
307 * A Drop path - resolve the path on the drop DPO
309 FIB_ROUTE_PATH_DROP = (1 << 4),
311 * Don't resolve the path, use the DPO the client provides
313 FIB_ROUTE_PATH_EXCLUSIVE = (1 << 5),
315 * A path that result in received traffic being recieved/recirculated
316 * so that it appears to have arrived on the new interface
318 FIB_ROUTE_PATH_INTF_RX = (1 << 6),
320 * A local path with a RPF-ID => multicast traffic
322 FIB_ROUTE_PATH_RPF_ID = (1 << 7),
324 * A deag path using the packet's source not destination address.
326 FIB_ROUTE_PATH_SOURCE_LOOKUP = (1 << 8),
328 * A path via a UDP encap object.
330 FIB_ROUTE_PATH_UDP_ENCAP = (1 << 9),
332 * A path that resolves via a BIER F-Mask
334 FIB_ROUTE_PATH_BIER_FMASK = (1 << 10),
336 * A path that resolves via a BIER [ECMP] Table
338 FIB_ROUTE_PATH_BIER_TABLE = (1 << 11),
340 * A path that resolves via a BIER impostion object
342 FIB_ROUTE_PATH_BIER_IMP = (1 << 12),
343 } fib_route_path_flags_t;
346 * An RPF-ID is numerical value that is used RPF validate. An entry
347 * has-a RPF-ID, when a packet egress from (e.g. an LSP) it gains an
348 * RPF-ID, these two are compared for the RPF check.
349 * This replaces the interfce based chack (since the LSP has no associated
352 typedef u32 fib_rpf_id_t;
354 #define MFIB_RPF_ID_NONE (0)
358 * A representation of a path as described by a route producer.
359 * These paramenters will determine the path 'type', of which there are:
360 * 1) Attached-next-hop:
361 * a single peer on a link.
362 * It is 'attached' because it is in the same sub-net as the router, on a link
363 * directly connected to the route.
364 * It is 'next=hop' since the next-hop address of the peer is known.
366 * the next-hop is not known. but we can ARP for it.
368 * The next-hop is known but the interface is not. So to find the adj to use
369 * we must recursively resolve the next-hop.
370 * 3) deaggregate (deag)
371 * A further lookup is required.
373 typedef struct fib_route_path_t_ {
375 * The protocol of the address below. We need this since the all
376 * zeros address is ambiguous.
378 dpo_proto_t frp_proto;
384 * The next-hop address.
385 * Will be NULL for attached paths.
386 * Will be all zeros for attached-next-hop paths on a p2p interface
387 * Will be all zeros for a deag path.
389 ip46_address_t frp_addr;
393 * The MPLS local Label to reursively resolve through.
394 * This is valid when the path type is MPLS.
396 mpls_label_t frp_local_label;
398 * EOS bit for the resolving label
400 mpls_eos_bit_t frp_eos;
406 * Will be invalid for recursive paths.
412 fib_rpf_id_t frp_rpf_id;
416 * The FIB index to lookup the nexthop
417 * Only valid for recursive paths.
421 * The BIER table to resolve the fmask in
423 u32 frp_bier_fib_index;
426 * The outgoing MPLS label Stack. NULL implies no label.
428 mpls_label_t *frp_label_stack;
431 * A path that resolves via a BIER Table.
432 * This would be for a MPLS label at a BIER midpoint or tail
434 bier_table_id_t frp_bier_tbl;
437 * A path via a BIER imposition object.
438 * Present in an mfib path list
440 index_t frp_bier_imp;
445 u32 frp_udp_encap_id;
448 * Resolving via a BIER Fmask
450 index_t frp_bier_fmask;
453 * [un]equal cost path weight
457 * A path preference. 0 is the best.
458 * Only paths of the best preference, that are 'up', are considered
465 fib_route_path_flags_t frp_flags;
469 * Unformat a fib_route_path_t from CLI input
471 extern uword unformat_fib_route_path(unformat_input_t * input, va_list * args);
474 * A help string to list the FIB path options
476 #define FIB_ROUTE_PATH_HELP "[next-hop-address] [next-hop-interface] [next-hop-table <value>] [weight <value>] [preference <value>] [udp-encap-id <value>] [ip4-lookup-in-table <value>] [ip6-lookup-in-table <value>] [mpls-lookup-in-table <value>] [resolve-via-host] [resolve-via-connected] [rx-ip4 <interface>] [out-labels <value value value>]"
480 * A representation of a fib path for fib_path_encode to convey the information to the caller
482 typedef struct fib_route_path_encode_t_ {
483 fib_route_path_t rpath;
485 } fib_route_path_encode_t;
488 * return code to control pat-hlist walk
490 typedef enum fib_path_list_walk_rc_t_
492 FIB_PATH_LIST_WALK_STOP,
493 FIB_PATH_LIST_WALK_CONTINUE,
494 } fib_path_list_walk_rc_t;
497 * A list of path-extensions
499 typedef struct fib_path_ext_list_t_
501 struct fib_path_ext_t_ *fpel_exts;
502 } fib_path_ext_list_t;