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__
20 #include <vlib/vlib.h>
21 #include <vnet/ip/ip6_packet.h>
22 #include <vnet/mpls/packet.h>
23 #include <vnet/dpo/dpo.h>
24 #include <vnet/bier/bier_types.h>
27 * A typedef of a node index.
28 * we make this typedef so the code becomes easier for a human to parse.
30 typedef u32 fib_node_index_t;
31 #define FIB_NODE_INDEX_INVALID ((fib_node_index_t)(~0))
34 * Protocol Type. packed so it consumes a u8 only
36 typedef enum fib_protocol_t_ {
37 FIB_PROTOCOL_IP4 = DPO_PROTO_IP4,
38 FIB_PROTOCOL_IP6 = DPO_PROTO_IP6,
39 FIB_PROTOCOL_MPLS = DPO_PROTO_MPLS,
40 } __attribute__ ((packed)) fib_protocol_t;
42 #define FIB_PROTOCOLS { \
43 [FIB_PROTOCOL_IP4] = "ipv4", \
44 [FIB_PROTOCOL_IP6] = "ipv6", \
45 [FIB_PROTOCOL_MPLS] = "MPLS", \
49 * Definition outside of enum so it does not need to be included in non-defaulted
52 #define FIB_PROTOCOL_MAX (FIB_PROTOCOL_MPLS + 1)
55 * Definition outside of enum so it does not need to be included in non-defaulted
58 #define FIB_PROTOCOL_IP_MAX (FIB_PROTOCOL_IP6 + 1)
61 * Not part of the enum so it does not have to be handled in switch statements
63 #define FIB_PROTOCOL_NONE (FIB_PROTOCOL_MAX+1)
65 #define FOR_EACH_FIB_PROTOCOL(_item) \
66 for (_item = FIB_PROTOCOL_IP4; \
67 _item <= FIB_PROTOCOL_MPLS; \
70 #define FOR_EACH_FIB_IP_PROTOCOL(_item) \
71 for (_item = FIB_PROTOCOL_IP4; \
72 _item <= FIB_PROTOCOL_IP6; \
76 * @brief Convert from boolean is_ip6 to FIB protocol.
77 * Drop MPLS on the floor in favor of IPv4.
79 static inline fib_protocol_t
80 fib_ip_proto(bool is_ip6)
82 return (is_ip6) ? FIB_PROTOCOL_IP6 : FIB_PROTOCOL_IP4;
86 * @brief Convert from fib_protocol to ip46_type
88 extern ip46_type_t fib_proto_to_ip46(fib_protocol_t fproto);
91 * @brief Convert from ip46_type to fib_protocol
93 extern fib_protocol_t fib_proto_from_ip46(ip46_type_t iproto);
96 * @brief Convert from a protocol to a link type
98 vnet_link_t fib_proto_to_link (fib_protocol_t proto);
101 * FIB output chain type. When a child object requests a forwarding contribution
102 * from a parent, it does so for a particular scenario. This enumererates those
105 typedef enum fib_forward_chain_type_t_ {
107 * Contribute an object that is to be used to forward IP4 packets
109 FIB_FORW_CHAIN_TYPE_UNICAST_IP4,
111 * Contribute an object that is to be used to forward IP6 packets
113 FIB_FORW_CHAIN_TYPE_UNICAST_IP6,
115 * Contribute an object that is to be used to forward non-end-of-stack
118 FIB_FORW_CHAIN_TYPE_MPLS_NON_EOS,
120 * Contribute an object that is to be used to forward BIER packets.
122 FIB_FORW_CHAIN_TYPE_BIER,
124 * Contribute an object that is to be used to forward end-of-stack
125 * MPLS packets. This is a convenient ID for clients. A real EOS chain
126 * must be pay-load protocol specific. This
127 * option is converted into one of the other three internally.
129 FIB_FORW_CHAIN_TYPE_MPLS_EOS,
131 * Contribute an object that is to be used to forward IP4 packets
133 FIB_FORW_CHAIN_TYPE_MCAST_IP4,
135 * Contribute an object that is to be used to forward IP6 packets
137 FIB_FORW_CHAIN_TYPE_MCAST_IP6,
139 * Contribute an object that is to be used to forward Ethernet packets.
141 FIB_FORW_CHAIN_TYPE_ETHERNET,
143 * Contribute an object that is to be used to forward NSH packets.
144 * This is last in the list since it is not valid for many FIB objects,
145 * and thus their array of per-chain-type DPOs can be sized smaller.
147 FIB_FORW_CHAIN_TYPE_NSH,
148 } __attribute__ ((packed)) fib_forward_chain_type_t;
150 #define FIB_FORW_CHAINS { \
151 [FIB_FORW_CHAIN_TYPE_ETHERNET] = "ethernet", \
152 [FIB_FORW_CHAIN_TYPE_BIER] = "bier", \
153 [FIB_FORW_CHAIN_TYPE_UNICAST_IP4] = "unicast-ip4", \
154 [FIB_FORW_CHAIN_TYPE_UNICAST_IP6] = "unicast-ip6", \
155 [FIB_FORW_CHAIN_TYPE_MCAST_IP4] = "multicast-ip4", \
156 [FIB_FORW_CHAIN_TYPE_MCAST_IP6] = "multicast-ip6", \
157 [FIB_FORW_CHAIN_TYPE_MPLS_NON_EOS] = "mpls-neos", \
158 [FIB_FORW_CHAIN_TYPE_MPLS_EOS] = "mpls-eos", \
159 [FIB_FORW_CHAIN_TYPE_NSH] = "nsh", \
162 #define FIB_FORW_CHAIN_NUM (FIB_FORW_CHAIN_TYPE_NSH+1)
163 #define FIB_FORW_CHAIN_MPLS_NUM (FIB_FORW_CHAIN_TYPE_MPLS_EOS+1)
165 #define FOR_EACH_FIB_FORW_CHAIN(_item) \
166 for (_item = FIB_FORW_CHAIN_TYPE_UNICAST_IP4; \
167 _item <= FIB_FORW_CHAIN_TYPE_NSH; \
170 #define FOR_EACH_FIB_FORW_MPLS_CHAIN(_item) \
171 for (_item = FIB_FORW_CHAIN_TYPE_UNICAST_IP4; \
172 _item <= FIB_FORW_CHAIN_TYPE_MPLS_EOS; \
176 * @brief Convert from a chain type to the adjacency's link type
178 extern vnet_link_t fib_forw_chain_type_to_link_type(fib_forward_chain_type_t fct);
181 * @brief Convert from a adjacency's link type to chain type
183 extern fib_forward_chain_type_t fib_forw_chain_type_from_link_type(vnet_link_t lt);
186 * @brief Convert from a payload-protocol to a chain type.
188 extern fib_forward_chain_type_t fib_forw_chain_type_from_dpo_proto(dpo_proto_t proto);
191 * @brief Convert from a fib-protocol to a chain type.
193 extern fib_forward_chain_type_t fib_forw_chain_type_from_fib_proto(fib_protocol_t proto);
196 * @brief Convert from a chain type to the DPO proto it will install
198 extern dpo_proto_t fib_forw_chain_type_to_dpo_proto(fib_forward_chain_type_t fct);
201 * Aggregrate type for a prefix
203 typedef struct fib_prefix_t_ {
212 fib_protocol_t fp_proto;
215 * Pad to keep the address 4 byte aligned
221 * The address type is not deriveable from the fp_addr member.
222 * If it's v4, then the first 3 u32s of the address will be 0.
223 * v6 addresses (even v4 mapped ones) have at least 2 u32s assigned
224 * to non-zero values. true. but when it's all zero, one cannot decide.
226 ip46_address_t fp_addr;
229 mpls_label_t fp_label;
230 mpls_eos_bit_t fp_eos;
232 * This protocol determines the payload protocol of packets
233 * that will be forwarded by this entry once the label is popped.
234 * For a non-eos entry it will be MPLS.
236 dpo_proto_t fp_payload_proto;
241 STATIC_ASSERT(STRUCT_OFFSET_OF(fib_prefix_t, fp_addr) == 4,
242 "FIB Prefix's address is 4 byte aligned.");
245 * \brief Compare two prefixes for equality
247 extern int fib_prefix_cmp(const fib_prefix_t *p1,
248 const fib_prefix_t *p2);
251 * \brief Compare two prefixes for covering relationship
253 * \return non-zero if the first prefix is a cover for the second
255 extern int fib_prefix_is_cover(const fib_prefix_t *p1,
256 const fib_prefix_t *p2);
259 * \brief Return true is the prefix is a host prefix
261 extern int fib_prefix_is_host(const fib_prefix_t *p);
265 * \brief Host prefix from ip
267 extern void fib_prefix_from_ip46_addr (const ip46_address_t *addr,
270 extern u8 * format_fib_prefix(u8 * s, va_list * args);
271 extern u8 * format_fib_forw_chain_type(u8 * s, va_list * args);
273 extern dpo_proto_t fib_proto_to_dpo(fib_protocol_t fib_proto);
274 extern fib_protocol_t dpo_proto_to_fib(dpo_proto_t dpo_proto);
277 * Convert from BIER next-hop proto to FIB proto
279 extern fib_protocol_t bier_hdr_proto_to_fib(bier_hdr_proto_id_t bproto);
282 * Enurmeration of special path/entry types
284 typedef enum fib_special_type_t_ {
286 * Marker. Add new types after this one.
288 FIB_SPECIAL_TYPE_FIRST = 0,
292 FIB_SPECIAL_TYPE_LOCAL = FIB_SPECIAL_TYPE_FIRST,
296 FIB_SPECIAL_TYPE_DROP,
298 * Marker. Add new types before this one, then update it.
300 FIB_SPECIAL_TYPE_LAST = FIB_SPECIAL_TYPE_DROP,
301 } __attribute__ ((packed)) fib_special_type_t;
304 * The maximum number of types
306 #define FIB_SPEICAL_TYPE_MAX (FIB_SPEICAL_TYPE_LAST + 1)
308 #define FOR_EACH_FIB_SPEICAL_TYPE(_item) \
309 for (_item = FIB_TYPE_SPEICAL_FIRST; \
310 _item <= FIB_SPEICAL_TYPE_LAST; _item++)
312 extern u8 * format_fib_protocol(u8 * s, va_list *ap);
313 extern u8 * format_vnet_link(u8 *s, va_list *ap);
316 * Path flags from the control plane
318 typedef enum fib_route_path_flags_t_
320 FIB_ROUTE_PATH_FLAG_NONE = 0,
322 * Recursion constraint of via a host prefix
324 FIB_ROUTE_PATH_RESOLVE_VIA_HOST = (1 << 0),
326 * Recursion constraint of via an attahced prefix
328 FIB_ROUTE_PATH_RESOLVE_VIA_ATTACHED = (1 << 1),
330 * A for-us/local path
332 FIB_ROUTE_PATH_LOCAL = (1 << 2),
336 FIB_ROUTE_PATH_ATTACHED = (1 << 3),
338 * A Drop path - resolve the path on the drop DPO
340 FIB_ROUTE_PATH_DROP = (1 << 4),
342 * Don't resolve the path, use the DPO the client provides
344 FIB_ROUTE_PATH_EXCLUSIVE = (1 << 5),
346 * A path that result in received traffic being recieved/recirculated
347 * so that it appears to have arrived on the new interface
349 FIB_ROUTE_PATH_INTF_RX = (1 << 6),
351 * A local path with a RPF-ID => multicast traffic
353 FIB_ROUTE_PATH_RPF_ID = (1 << 7),
355 * A deag path using the packet's source not destination address.
357 FIB_ROUTE_PATH_SOURCE_LOOKUP = (1 << 8),
359 * A path via a UDP encap object.
361 FIB_ROUTE_PATH_UDP_ENCAP = (1 << 9),
363 * A path that resolves via a BIER F-Mask
365 FIB_ROUTE_PATH_BIER_FMASK = (1 << 10),
367 * A path that resolves via a BIER [ECMP] Table
369 FIB_ROUTE_PATH_BIER_TABLE = (1 << 11),
371 * A path that resolves via a BIER impostion object
373 FIB_ROUTE_PATH_BIER_IMP = (1 << 12),
375 * A path that resolves via another table
377 FIB_ROUTE_PATH_DEAG = (1 << 13),
379 * A path that resolves via a DVR DPO
381 FIB_ROUTE_PATH_DVR = (1 << 14),
382 } fib_route_path_flags_t;
385 * An RPF-ID is numerical value that is used RPF validate. An entry
386 * has-a RPF-ID, when a packet egress from (e.g. an LSP) it gains an
387 * RPF-ID, these two are compared for the RPF check.
388 * This replaces the interfce based chack (since the LSP has no associated
391 typedef u32 fib_rpf_id_t;
393 #define MFIB_RPF_ID_NONE (0)
396 * MPLS LSP mode - only valid at the head and tail
398 typedef enum fib_mpls_lsp_mode_t_
401 * Pipe Mode - the default.
402 * TTL and DSCP markings are not carried between the layers
404 FIB_MPLS_LSP_MODE_PIPE,
407 * TTL and DSCP are copied between the layers
409 FIB_MPLS_LSP_MODE_UNIFORM,
410 } __attribute__((packed)) fib_mpls_lsp_mode_t;
412 #define FIB_MPLS_LSP_MODES { \
413 [FIB_MPLS_LSP_MODE_PIPE] = "pipe", \
414 [FIB_MPLS_LSP_MODE_UNIFORM] = "uniform", \
418 * Format an LSP mode type
420 extern u8 * format_fib_mpls_lsp_mode(u8 *s, va_list *ap);
423 * Configuration for each label value in the output-stack
425 typedef struct fib_mpls_label_t_
430 mpls_label_t fml_value;
435 fib_mpls_lsp_mode_t fml_mode;
438 * TTL. valid only at imposition.
443 * EXP bits; valid only at imposition.
449 * Format an MPLS label
451 extern u8 * format_fib_mpls_label(u8 *s, va_list *ap);
455 * A representation of a path as described by a route producer.
456 * These paramenters will determine the path 'type', of which there are:
457 * 1) Attached-next-hop:
458 * a single peer on a link.
459 * It is 'attached' because it is in the same sub-net as the router, on a link
460 * directly connected to the route.
461 * It is 'next=hop' since the next-hop address of the peer is known.
463 * the next-hop is not known. but we can ARP for it.
465 * The next-hop is known but the interface is not. So to find the adj to use
466 * we must recursively resolve the next-hop.
467 * 3) deaggregate (deag)
468 * A further lookup is required.
470 typedef struct fib_route_path_t_ {
472 * The protocol of the address below. We need this since the all
473 * zeros address is ambiguous.
475 dpo_proto_t frp_proto;
481 * The next-hop address.
482 * Will be NULL for attached paths.
483 * Will be all zeros for attached-next-hop paths on a p2p interface
484 * Will be all zeros for a deag path.
486 ip46_address_t frp_addr;
490 * The MPLS local Label to reursively resolve through.
491 * This is valid when the path type is MPLS.
493 mpls_label_t frp_local_label;
495 * EOS bit for the resolving label
497 mpls_eos_bit_t frp_eos;
503 * Will be invalid for recursive paths.
509 fib_rpf_id_t frp_rpf_id;
513 * The FIB index to lookup the nexthop
514 * Only valid for recursive paths.
518 * The BIER table to resolve the fmask in
520 u32 frp_bier_fib_index;
523 * The outgoing MPLS label Stack. NULL implies no label.
525 fib_mpls_label_t *frp_label_stack;
532 * MFIB interface flags
537 * A path that resolves via a BIER Table.
538 * This would be for a MPLS label at a BIER midpoint or tail
540 bier_table_id_t frp_bier_tbl;
543 * A path via a BIER imposition object.
544 * Present in an mfib path list
546 index_t frp_bier_imp;
551 u32 frp_udp_encap_id;
554 * Resolving via a BIER Fmask
556 index_t frp_bier_fmask;
559 * [un]equal cost path weight
563 * A path preference. 0 is the best.
564 * Only paths of the best preference, that are 'up', are considered
571 fib_route_path_flags_t frp_flags;
575 * Unformat a fib_route_path_t from CLI input
577 extern uword unformat_fib_route_path(unformat_input_t * input, va_list * args);
580 * A help string to list the FIB path options
582 #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>]"
586 * A representation of a fib path for fib_path_encode to convey the information to the caller
588 typedef struct fib_route_path_encode_t_ {
589 fib_route_path_t rpath;
591 } fib_route_path_encode_t;
594 * return code to control pat-hlist walk
596 typedef enum fib_path_list_walk_rc_t_
598 FIB_PATH_LIST_WALK_STOP,
599 FIB_PATH_LIST_WALK_CONTINUE,
600 } fib_path_list_walk_rc_t;
603 * A list of path-extensions
605 typedef struct fib_path_ext_list_t_
607 struct fib_path_ext_t_ *fpel_exts;
608 } fib_path_ext_list_t;