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 a protocol to a link type
88 vnet_link_t fib_proto_to_link (fib_protocol_t proto);
91 * FIB output chain type. When a child object requests a forwarding contribution
92 * from a parent, it does so for a particular scenario. This enumererates those
95 typedef enum fib_forward_chain_type_t_ {
97 * Contribute an object that is to be used to forward IP4 packets
99 FIB_FORW_CHAIN_TYPE_UNICAST_IP4,
101 * Contribute an object that is to be used to forward IP6 packets
103 FIB_FORW_CHAIN_TYPE_UNICAST_IP6,
105 * Contribute an object that is to be used to forward non-end-of-stack
108 FIB_FORW_CHAIN_TYPE_MPLS_NON_EOS,
110 * Contribute an object that is to be used to forward BIER packets.
112 FIB_FORW_CHAIN_TYPE_BIER,
114 * Contribute an object that is to be used to forward end-of-stack
115 * MPLS packets. This is a convenient ID for clients. A real EOS chain
116 * must be pay-load protocol specific. This
117 * option is converted into one of the other three internally.
119 FIB_FORW_CHAIN_TYPE_MPLS_EOS,
121 * Contribute an object that is to be used to forward IP4 packets
123 FIB_FORW_CHAIN_TYPE_MCAST_IP4,
125 * Contribute an object that is to be used to forward IP6 packets
127 FIB_FORW_CHAIN_TYPE_MCAST_IP6,
129 * Contribute an object that is to be used to forward Ethernet packets.
131 FIB_FORW_CHAIN_TYPE_ETHERNET,
133 * Contribute an object that is to be used to forward NSH packets.
134 * This is last in the list since it is not valid for many FIB objects,
135 * and thus their array of per-chain-type DPOs can be sized smaller.
137 FIB_FORW_CHAIN_TYPE_NSH,
138 } __attribute__ ((packed)) fib_forward_chain_type_t;
140 #define FIB_FORW_CHAINS { \
141 [FIB_FORW_CHAIN_TYPE_ETHERNET] = "ethernet", \
142 [FIB_FORW_CHAIN_TYPE_BIER] = "bier", \
143 [FIB_FORW_CHAIN_TYPE_UNICAST_IP4] = "unicast-ip4", \
144 [FIB_FORW_CHAIN_TYPE_UNICAST_IP6] = "unicast-ip6", \
145 [FIB_FORW_CHAIN_TYPE_MCAST_IP4] = "multicast-ip4", \
146 [FIB_FORW_CHAIN_TYPE_MCAST_IP6] = "multicast-ip6", \
147 [FIB_FORW_CHAIN_TYPE_MPLS_NON_EOS] = "mpls-neos", \
148 [FIB_FORW_CHAIN_TYPE_MPLS_EOS] = "mpls-eos", \
149 [FIB_FORW_CHAIN_TYPE_NSH] = "nsh", \
152 #define FIB_FORW_CHAIN_NUM (FIB_FORW_CHAIN_TYPE_NSH+1)
153 #define FIB_FORW_CHAIN_MPLS_NUM (FIB_FORW_CHAIN_TYPE_MPLS_EOS+1)
155 #define FOR_EACH_FIB_FORW_CHAIN(_item) \
156 for (_item = FIB_FORW_CHAIN_TYPE_UNICAST_IP4; \
157 _item <= FIB_FORW_CHAIN_TYPE_NSH; \
160 #define FOR_EACH_FIB_FORW_MPLS_CHAIN(_item) \
161 for (_item = FIB_FORW_CHAIN_TYPE_UNICAST_IP4; \
162 _item <= FIB_FORW_CHAIN_TYPE_MPLS_EOS; \
166 * @brief Convert from a chain type to the adjacency's link type
168 extern vnet_link_t fib_forw_chain_type_to_link_type(fib_forward_chain_type_t fct);
171 * @brief Convert from a adjacency's link type to chain type
173 extern fib_forward_chain_type_t fib_forw_chain_type_from_link_type(vnet_link_t lt);
176 * @brief Convert from a payload-protocol to a chain type.
178 extern fib_forward_chain_type_t fib_forw_chain_type_from_dpo_proto(dpo_proto_t proto);
181 * @brief Convert from a chain type to the DPO proto it will install
183 extern dpo_proto_t fib_forw_chain_type_to_dpo_proto(fib_forward_chain_type_t fct);
186 * Aggregrate type for a prefix
188 typedef struct fib_prefix_t_ {
197 fib_protocol_t fp_proto;
200 * Pad to keep the address 4 byte aligned
206 * The address type is not deriveable from the fp_addr member.
207 * If it's v4, then the first 3 u32s of the address will be 0.
208 * v6 addresses (even v4 mapped ones) have at least 2 u32s assigned
209 * to non-zero values. true. but when it's all zero, one cannot decide.
211 ip46_address_t fp_addr;
214 mpls_label_t fp_label;
215 mpls_eos_bit_t fp_eos;
217 * This protocol determines the payload protocol of packets
218 * that will be forwarded by this entry once the label is popped.
219 * For a non-eos entry it will be MPLS.
221 dpo_proto_t fp_payload_proto;
226 STATIC_ASSERT(STRUCT_OFFSET_OF(fib_prefix_t, fp_addr) == 4,
227 "FIB Prefix's address is 4 byte aligned.");
230 * \brief Compare two prefixes for equality
232 extern int fib_prefix_cmp(const fib_prefix_t *p1,
233 const fib_prefix_t *p2);
236 * \brief Compare two prefixes for covering relationship
238 * \return non-zero if the first prefix is a cover for the second
240 extern int fib_prefix_is_cover(const fib_prefix_t *p1,
241 const fib_prefix_t *p2);
244 * \brief Return true is the prefix is a host prefix
246 extern int fib_prefix_is_host(const fib_prefix_t *p);
250 * \brief Host prefix from ip
252 extern void fib_prefix_from_ip46_addr (const ip46_address_t *addr,
255 extern u8 * format_fib_prefix(u8 * s, va_list * args);
256 extern u8 * format_fib_forw_chain_type(u8 * s, va_list * args);
258 extern dpo_proto_t fib_proto_to_dpo(fib_protocol_t fib_proto);
259 extern fib_protocol_t dpo_proto_to_fib(dpo_proto_t dpo_proto);
262 * Convert from BIER next-hop proto to FIB proto
264 extern fib_protocol_t bier_hdr_proto_to_fib(bier_hdr_proto_id_t bproto);
267 * Enurmeration of special path/entry types
269 typedef enum fib_special_type_t_ {
271 * Marker. Add new types after this one.
273 FIB_SPECIAL_TYPE_FIRST = 0,
277 FIB_SPECIAL_TYPE_LOCAL = FIB_SPECIAL_TYPE_FIRST,
281 FIB_SPECIAL_TYPE_DROP,
283 * Marker. Add new types before this one, then update it.
285 FIB_SPECIAL_TYPE_LAST = FIB_SPECIAL_TYPE_DROP,
286 } __attribute__ ((packed)) fib_special_type_t;
289 * The maximum number of types
291 #define FIB_SPEICAL_TYPE_MAX (FIB_SPEICAL_TYPE_LAST + 1)
293 #define FOR_EACH_FIB_SPEICAL_TYPE(_item) \
294 for (_item = FIB_TYPE_SPEICAL_FIRST; \
295 _item <= FIB_SPEICAL_TYPE_LAST; _item++)
297 extern u8 * format_fib_protocol(u8 * s, va_list *ap);
298 extern u8 * format_vnet_link(u8 *s, va_list *ap);
301 * Path flags from the control plane
303 typedef enum fib_route_path_flags_t_
305 FIB_ROUTE_PATH_FLAG_NONE = 0,
307 * Recursion constraint of via a host prefix
309 FIB_ROUTE_PATH_RESOLVE_VIA_HOST = (1 << 0),
311 * Recursion constraint of via an attahced prefix
313 FIB_ROUTE_PATH_RESOLVE_VIA_ATTACHED = (1 << 1),
315 * A for-us/local path
317 FIB_ROUTE_PATH_LOCAL = (1 << 2),
321 FIB_ROUTE_PATH_ATTACHED = (1 << 3),
323 * A Drop path - resolve the path on the drop DPO
325 FIB_ROUTE_PATH_DROP = (1 << 4),
327 * Don't resolve the path, use the DPO the client provides
329 FIB_ROUTE_PATH_EXCLUSIVE = (1 << 5),
331 * A path that result in received traffic being recieved/recirculated
332 * so that it appears to have arrived on the new interface
334 FIB_ROUTE_PATH_INTF_RX = (1 << 6),
336 * A local path with a RPF-ID => multicast traffic
338 FIB_ROUTE_PATH_RPF_ID = (1 << 7),
340 * A deag path using the packet's source not destination address.
342 FIB_ROUTE_PATH_SOURCE_LOOKUP = (1 << 8),
344 * A path via a UDP encap object.
346 FIB_ROUTE_PATH_UDP_ENCAP = (1 << 9),
348 * A path that resolves via a BIER F-Mask
350 FIB_ROUTE_PATH_BIER_FMASK = (1 << 10),
352 * A path that resolves via a BIER [ECMP] Table
354 FIB_ROUTE_PATH_BIER_TABLE = (1 << 11),
356 * A path that resolves via a BIER impostion object
358 FIB_ROUTE_PATH_BIER_IMP = (1 << 12),
360 * A path that resolves via another table
362 FIB_ROUTE_PATH_DEAG = (1 << 13),
364 * A path that resolves via a DVR DPO
366 FIB_ROUTE_PATH_DVR = (1 << 14),
367 } fib_route_path_flags_t;
370 * An RPF-ID is numerical value that is used RPF validate. An entry
371 * has-a RPF-ID, when a packet egress from (e.g. an LSP) it gains an
372 * RPF-ID, these two are compared for the RPF check.
373 * This replaces the interfce based chack (since the LSP has no associated
376 typedef u32 fib_rpf_id_t;
378 #define MFIB_RPF_ID_NONE (0)
381 * MPLS LSP mode - only valid at the head and tail
383 typedef enum fib_mpls_lsp_mode_t_
386 * Pipe Mode - the default.
387 * TTL and DSCP markings are not carried between the layers
389 FIB_MPLS_LSP_MODE_PIPE,
392 * TTL and DSCP are copied between the layers
394 FIB_MPLS_LSP_MODE_UNIFORM,
395 } __attribute__((packed)) fib_mpls_lsp_mode_t;
397 #define FIB_MPLS_LSP_MODES { \
398 [FIB_MPLS_LSP_MODE_PIPE] = "pipe", \
399 [FIB_MPLS_LSP_MODE_UNIFORM] = "uniform", \
403 * Format an LSP mode type
405 extern u8 * format_fib_mpls_lsp_mode(u8 *s, va_list *ap);
408 * Configuration for each label value in the output-stack
410 typedef struct fib_mpls_label_t_
415 mpls_label_t fml_value;
420 fib_mpls_lsp_mode_t fml_mode;
423 * TTL. valid only at imposition.
428 * EXP bits; valid only at imposition.
434 * Format an MPLS label
436 extern u8 * format_fib_mpls_label(u8 *s, va_list *ap);
440 * A representation of a path as described by a route producer.
441 * These paramenters will determine the path 'type', of which there are:
442 * 1) Attached-next-hop:
443 * a single peer on a link.
444 * It is 'attached' because it is in the same sub-net as the router, on a link
445 * directly connected to the route.
446 * It is 'next=hop' since the next-hop address of the peer is known.
448 * the next-hop is not known. but we can ARP for it.
450 * The next-hop is known but the interface is not. So to find the adj to use
451 * we must recursively resolve the next-hop.
452 * 3) deaggregate (deag)
453 * A further lookup is required.
455 typedef struct fib_route_path_t_ {
457 * The protocol of the address below. We need this since the all
458 * zeros address is ambiguous.
460 dpo_proto_t frp_proto;
466 * The next-hop address.
467 * Will be NULL for attached paths.
468 * Will be all zeros for attached-next-hop paths on a p2p interface
469 * Will be all zeros for a deag path.
471 ip46_address_t frp_addr;
475 * The MPLS local Label to reursively resolve through.
476 * This is valid when the path type is MPLS.
478 mpls_label_t frp_local_label;
480 * EOS bit for the resolving label
482 mpls_eos_bit_t frp_eos;
488 * Will be invalid for recursive paths.
494 fib_rpf_id_t frp_rpf_id;
498 * The FIB index to lookup the nexthop
499 * Only valid for recursive paths.
503 * The BIER table to resolve the fmask in
505 u32 frp_bier_fib_index;
508 * The outgoing MPLS label Stack. NULL implies no label.
510 fib_mpls_label_t *frp_label_stack;
513 * A path that resolves via a BIER Table.
514 * This would be for a MPLS label at a BIER midpoint or tail
516 bier_table_id_t frp_bier_tbl;
519 * A path via a BIER imposition object.
520 * Present in an mfib path list
522 index_t frp_bier_imp;
527 u32 frp_udp_encap_id;
530 * Resolving via a BIER Fmask
532 index_t frp_bier_fmask;
535 * [un]equal cost path weight
539 * A path preference. 0 is the best.
540 * Only paths of the best preference, that are 'up', are considered
547 fib_route_path_flags_t frp_flags;
551 * Unformat a fib_route_path_t from CLI input
553 extern uword unformat_fib_route_path(unformat_input_t * input, va_list * args);
556 * A help string to list the FIB path options
558 #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>]"
562 * A representation of a fib path for fib_path_encode to convey the information to the caller
564 typedef struct fib_route_path_encode_t_ {
565 fib_route_path_t rpath;
567 } fib_route_path_encode_t;
570 * return code to control pat-hlist walk
572 typedef enum fib_path_list_walk_rc_t_
574 FIB_PATH_LIST_WALK_STOP,
575 FIB_PATH_LIST_WALK_CONTINUE,
576 } fib_path_list_walk_rc_t;
579 * A list of path-extensions
581 typedef struct fib_path_ext_list_t_
583 struct fib_path_ext_t_ *fpel_exts;
584 } fib_path_ext_list_t;