FD.io VPP  v18.01.2-1-g9b554f3
Vector Packet Processing
fib_types.h
Go to the documentation of this file.
1  /*
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:
6  *
7  * http://www.apache.org/licenses/LICENSE-2.0
8  *
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.
14  */
15 
16 #ifndef __FIB_TYPES_H__
17 #define __FIB_TYPES_H__
18 
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>
24 
25 /**
26  * A typedef of a node index.
27  * we make this typedef so the code becomes easier for a human to parse.
28  */
30 #define FIB_NODE_INDEX_INVALID ((fib_node_index_t)(~0))
31 
32 /**
33  * Protocol Type. packed so it consumes a u8 only
34  */
35 typedef enum fib_protocol_t_ {
39 } __attribute__ ((packed)) fib_protocol_t;
40 
41 #define FIB_PROTOCOLS { \
42  [FIB_PROTOCOL_IP4] = "ipv4", \
43  [FIB_PROTOCOL_IP6] = "ipv6", \
44  [FIB_PROTOCOL_MPLS] = "MPLS", \
45 }
46 
47 /**
48  * Definition outside of enum so it does not need to be included in non-defaulted
49  * switch statements
50  */
51 #define FIB_PROTOCOL_MAX (FIB_PROTOCOL_MPLS + 1)
52 
53 /**
54  * Definition outside of enum so it does not need to be included in non-defaulted
55  * switch statements
56  */
57 #define FIB_PROTOCOL_IP_MAX (FIB_PROTOCOL_IP6 + 1)
58 
59 /**
60  * Not part of the enum so it does not have to be handled in switch statements
61  */
62 #define FIB_PROTOCOL_NONE (FIB_PROTOCOL_MAX+1)
63 
64 #define FOR_EACH_FIB_PROTOCOL(_item) \
65  for (_item = FIB_PROTOCOL_IP4; \
66  _item <= FIB_PROTOCOL_MPLS; \
67  _item++)
68 
69 #define FOR_EACH_FIB_IP_PROTOCOL(_item) \
70  for (_item = FIB_PROTOCOL_IP4; \
71  _item <= FIB_PROTOCOL_IP6; \
72  _item++)
73 
74 /**
75  * @brief Convert from a protocol to a link type
76  */
77 vnet_link_t fib_proto_to_link (fib_protocol_t proto);
78 
79 /**
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
82  * sceanrios
83  */
85  /**
86  * Contribute an object that is to be used to forward IP4 packets
87  */
89  /**
90  * Contribute an object that is to be used to forward IP6 packets
91  */
93  /**
94  * Contribute an object that is to be used to forward non-end-of-stack
95  * MPLS packets
96  */
98  /**
99  * Contribute an object that is to be used to forward BIER packets.
100  */
102  /**
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.
107  */
109  /**
110  * Contribute an object that is to be used to forward IP4 packets
111  */
113  /**
114  * Contribute an object that is to be used to forward IP6 packets
115  */
117  /**
118  * Contribute an object that is to be used to forward Ethernet packets.
119  */
121  /**
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.
125  */
127 } __attribute__ ((packed)) fib_forward_chain_type_t;
128 
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", \
139 }
140 
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)
143 
144 #define FOR_EACH_FIB_FORW_CHAIN(_item) \
145  for (_item = FIB_FORW_CHAIN_TYPE_UNICAST_IP4; \
146  _item <= FIB_FORW_CHAIN_TYPE_NSH; \
147  _item++)
148 
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; \
152  _item++)
153 
154 /**
155  * @brief Convert from a chain type to the adjacencies link type
156  */
157 extern vnet_link_t fib_forw_chain_type_to_link_type(fib_forward_chain_type_t fct);
158 
159 /**
160  * @brief Convert from a payload-protocol to a chain type.
161  */
162 extern fib_forward_chain_type_t fib_forw_chain_type_from_dpo_proto(dpo_proto_t proto);
163 
164 /**
165  * @brief Convert from a chain type to the DPO proto it will install
166  */
167 extern dpo_proto_t fib_forw_chain_type_to_dpo_proto(fib_forward_chain_type_t fct);
168 
169 /**
170  * Aggregrate type for a prefix
171  */
172 typedef struct fib_prefix_t_ {
173  /**
174  * The mask length
175  */
177 
178  /**
179  * protocol type
180  */
181  fib_protocol_t fp_proto;
182 
183  /**
184  * Pad to keep the address 4 byte aligned
185  */
186  u8 ___fp___pad;
187 
188  union {
189  /**
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.
194  */
195  ip46_address_t fp_addr;
196 
197  struct {
200  /**
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.
204  */
206  };
207  };
208 } fib_prefix_t;
209 
211  "FIB Prefix's address is 4 byte aligned.");
212 
213 /**
214  * \brief Compare two prefixes for equality
215  */
216 extern int fib_prefix_cmp(const fib_prefix_t *p1,
217  const fib_prefix_t *p2);
218 
219 /**
220  * \brief Compare two prefixes for covering relationship
221  *
222  * \return non-zero if the first prefix is a cover for the second
223  */
224 extern int fib_prefix_is_cover(const fib_prefix_t *p1,
225  const fib_prefix_t *p2);
226 
227 /**
228  * \brief Return true is the prefix is a host prefix
229  */
230 extern int fib_prefix_is_host(const fib_prefix_t *p);
231 
232 
233 /**
234  * \brief Host prefix from ip
235  */
236 extern void fib_prefix_from_ip46_addr (const ip46_address_t *addr,
237  fib_prefix_t *pfx);
238 
239 extern u8 * format_fib_prefix(u8 * s, va_list * args);
240 extern u8 * format_fib_forw_chain_type(u8 * s, va_list * args);
241 
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);
244 
245 /**
246  * Convert from BIER next-hop proto to FIB proto
247  */
248 extern fib_protocol_t bier_hdr_proto_to_fib(bier_hdr_proto_id_t bproto);
249 
250 /**
251  * Enurmeration of special path/entry types
252  */
253 typedef enum fib_special_type_t_ {
254  /**
255  * Marker. Add new types after this one.
256  */
258  /**
259  * Local/for-us paths
260  */
262  /**
263  * drop paths
264  */
266  /**
267  * Marker. Add new types before this one, then update it.
268  */
270 } __attribute__ ((packed)) fib_special_type_t;
271 
272 /**
273  * The maximum number of types
274  */
275 #define FIB_SPEICAL_TYPE_MAX (FIB_SPEICAL_TYPE_LAST + 1)
276 
277 #define FOR_EACH_FIB_SPEICAL_TYPE(_item) \
278  for (_item = FIB_TYPE_SPEICAL_FIRST; \
279  _item <= FIB_SPEICAL_TYPE_LAST; _item++)
280 
281 extern u8 * format_fib_protocol(u8 * s, va_list *ap);
282 extern u8 * format_vnet_link(u8 *s, va_list *ap);
283 
284 /**
285  * Path flags from the control plane
286  */
288 {
290  /**
291  * Recursion constraint of via a host prefix
292  */
294  /**
295  * Recursion constraint of via an attahced prefix
296  */
298  /**
299  * A for-us/local path
300  */
302  /**
303  * Attached path
304  */
306  /**
307  * A Drop path - resolve the path on the drop DPO
308  */
310  /**
311  * Don't resolve the path, use the DPO the client provides
312  */
314  /**
315  * A path that result in received traffic being recieved/recirculated
316  * so that it appears to have arrived on the new interface
317  */
319  /**
320  * A local path with a RPF-ID => multicast traffic
321  */
323  /**
324  * A deag path using the packet's source not destination address.
325  */
327  /**
328  * A path via a UDP encap object.
329  */
331  /**
332  * A path that resolves via a BIER F-Mask
333  */
335  /**
336  * A path that resolves via a BIER [ECMP] Table
337  */
339  /**
340  * A path that resolves via a BIER impostion object
341  */
343  /**
344  * A path that resolves via another table
345  */
346  FIB_ROUTE_PATH_DEAG = (1 << 13),
348 
349 /**
350  * An RPF-ID is numerical value that is used RPF validate. An entry
351  * has-a RPF-ID, when a packet egress from (e.g. an LSP) it gains an
352  * RPF-ID, these two are compared for the RPF check.
353  * This replaces the interfce based chack (since the LSP has no associated
354  * interface.
355  */
357 
358 #define MFIB_RPF_ID_NONE (0)
359 
360 /**
361  * @brief
362  * A representation of a path as described by a route producer.
363  * These paramenters will determine the path 'type', of which there are:
364  * 1) Attached-next-hop:
365  * a single peer on a link.
366  * It is 'attached' because it is in the same sub-net as the router, on a link
367  * directly connected to the route.
368  * It is 'next=hop' since the next-hop address of the peer is known.
369  * 2) Attached:
370  * the next-hop is not known. but we can ARP for it.
371  * 3) Recursive.
372  * The next-hop is known but the interface is not. So to find the adj to use
373  * we must recursively resolve the next-hop.
374  * 3) deaggregate (deag)
375  * A further lookup is required.
376  */
377 typedef struct fib_route_path_t_ {
378  /**
379  * The protocol of the address below. We need this since the all
380  * zeros address is ambiguous.
381  */
383 
384  union {
385  struct {
386  union {
387  /**
388  * The next-hop address.
389  * Will be NULL for attached paths.
390  * Will be all zeros for attached-next-hop paths on a p2p interface
391  * Will be all zeros for a deag path.
392  */
393  ip46_address_t frp_addr;
394 
395  struct {
396  /**
397  * The MPLS local Label to reursively resolve through.
398  * This is valid when the path type is MPLS.
399  */
401  /**
402  * EOS bit for the resolving label
403  */
405  };
406  };
407  union {
408  /**
409  * The interface.
410  * Will be invalid for recursive paths.
411  */
413  /**
414  * The RPF-ID
415  */
416  fib_rpf_id_t frp_rpf_id;
417  };
418  union {
419  /**
420  * The FIB index to lookup the nexthop
421  * Only valid for recursive paths.
422  */
424  /**
425  * The BIER table to resolve the fmask in
426  */
428  };
429  /**
430  * The outgoing MPLS label Stack. NULL implies no label.
431  */
433  };
434  /**
435  * A path that resolves via a BIER Table.
436  * This would be for a MPLS label at a BIER midpoint or tail
437  */
439 
440  /**
441  * A path via a BIER imposition object.
442  * Present in an mfib path list
443  */
445 
446  /**
447  * UDP encap ID
448  */
450 
451  /**
452  * Resolving via a BIER Fmask
453  */
455  };
456  /**
457  * [un]equal cost path weight
458  */
460  /**
461  * A path preference. 0 is the best.
462  * Only paths of the best preference, that are 'up', are considered
463  * for forwarding.
464  */
466  /**
467  * flags on the path
468  */
471 
472 /**
473  * Unformat a fib_route_path_t from CLI input
474  */
475 extern uword unformat_fib_route_path(unformat_input_t * input, va_list * args);
476 
477 /**
478  * A help string to list the FIB path options
479  */
480 #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>]"
481 
482 /**
483  * @brief
484  * A representation of a fib path for fib_path_encode to convey the information to the caller
485  */
486 typedef struct fib_route_path_encode_t_ {
490 
491 /**
492  * return code to control pat-hlist walk
493  */
495 {
499 
500 /**
501  * A list of path-extensions
502  */
503 typedef struct fib_path_ext_list_t_
504 {
507 
508 #endif
fib_protocol_t fp_proto
protocol type
Definition: fib_types.h:181
Contribute an object that is to be used to forward BIER packets.
Definition: fib_types.h:101
Contribute an object that is to be used to forward IP6 packets.
Definition: fib_types.h:116
ip46_address_t frp_addr
The next-hop address.
Definition: fib_types.h:393
Contribute an object that is to be used to forward IP6 packets.
Definition: fib_types.h:92
A representation of a fib path for fib_path_encode to convey the information to the caller...
Definition: fib_types.h:486
mpls_eos_bit_t frp_eos
EOS bit for the resolving label.
Definition: fib_types.h:404
A representation of a path as described by a route producer.
Definition: fib_types.h:377
A Drop path - resolve the path on the drop DPO.
Definition: fib_types.h:309
dpo_proto_t fib_forw_chain_type_to_dpo_proto(fib_forward_chain_type_t fct)
Convert from a chain type to the DPO proto it will install.
Definition: fib_types.c:311
Local/for-us paths.
Definition: fib_types.h:261
u8 * format_vnet_link(u8 *s, va_list *ap)
Definition: fib_types.c:38
A path that resolves via a BIER impostion object.
Definition: fib_types.h:342
index_t frp_bier_imp
A path via a BIER imposition object.
Definition: fib_types.h:444
vnet_link_t fib_forw_chain_type_to_link_type(fib_forward_chain_type_t fct)
Convert from a chain type to the adjacencies link type.
Definition: fib_types.c:283
u32 mpls_label_t
A label value only, i.e.
Definition: packet.h:24
u32 index_t
A Data-Path Object is an object that represents actions that are applied to packets are they are swit...
Definition: dpo.h:41
A path that resolves via a BIER [ECMP] Table.
Definition: fib_types.h:338
struct fib_path_ext_t_ * fpel_exts
Definition: fib_types.h:505
Contribute an object that is to be used to forward IP4 packets.
Definition: fib_types.h:88
#define STRUCT_OFFSET_OF(t, f)
Definition: clib.h:62
dpo_proto_t frp_proto
The protocol of the address below.
Definition: fib_types.h:382
bier_table_id_t frp_bier_tbl
A path that resolves via a BIER Table.
Definition: fib_types.h:438
A path that result in received traffic being recieved/recirculated so that it appears to have arrived...
Definition: fib_types.h:318
The ID of a table.
Definition: bier_types.h:446
fib_rpf_id_t frp_rpf_id
The RPF-ID.
Definition: fib_types.h:416
A local path with a RPF-ID => multicast traffic.
Definition: fib_types.h:322
dpo_proto_t fp_payload_proto
This protocol determines the payload protocol of packets that will be forwarded by this entry once th...
Definition: fib_types.h:205
u32 frp_sw_if_index
The interface.
Definition: fib_types.h:412
fib_special_type_t_
Enurmeration of special path/entry types.
Definition: fib_types.h:253
mpls_label_t * frp_label_stack
The outgoing MPLS label Stack.
Definition: fib_types.h:432
Recursion constraint of via a host prefix.
Definition: fib_types.h:293
Aggregrate type for a prefix.
Definition: fib_types.h:172
A path via a UDP encap object.
Definition: fib_types.h:330
enum fib_route_path_flags_t_ fib_route_path_flags_t
Path flags from the control plane.
Contribute an object that is to be used to forward Ethernet packets.
Definition: fib_types.h:120
enum dpo_proto_t_ dpo_proto_t
Data path protocol.
u16 fp_len
The mask length.
Definition: fib_types.h:176
STATIC_ASSERT(STRUCT_OFFSET_OF(fib_prefix_t, fp_addr)==4,"FIB Prefix's address is 4 byte aligned.")
index_t frp_bier_fmask
Resolving via a BIER Fmask.
Definition: fib_types.h:454
The identity of a DPO is a combination of its type and its instance number/index of objects of that t...
Definition: dpo.h:166
Contribute an object that is to be used to forward end-of-stack MPLS packets.
Definition: fib_types.h:108
fib_protocol_t_
Protocol Type.
Definition: fib_types.h:35
ip46_address_t fp_addr
The address type is not deriveable from the fp_addr member.
Definition: fib_types.h:195
struct _unformat_input_t unformat_input_t
u8 * format_fib_prefix(u8 *s, va_list *args)
Definition: fib_types.c:151
int fib_prefix_is_cover(const fib_prefix_t *p1, const fib_prefix_t *p2)
Compare two prefixes for covering relationship.
Definition: fib_types.c:114
Recursion constraint of via an attahced prefix.
Definition: fib_types.h:297
struct fib_route_path_t_ fib_route_path_t
A representation of a path as described by a route producer.
A list of path-extensions.
Definition: fib_types.h:503
fib_protocol_t dpo_proto_to_fib(dpo_proto_t dpo_proto)
Definition: fib_types.c:227
fib_path_list_walk_rc_t_
return code to control pat-hlist walk
Definition: fib_types.h:494
uword unformat_fib_route_path(unformat_input_t *input, va_list *args)
Unformat a fib_route_path_t from CLI input.
Definition: fib_types.c:335
struct fib_path_ext_list_t_ fib_path_ext_list_t
A list of path-extensions.
fib_forward_chain_type_t fib_forw_chain_type_from_dpo_proto(dpo_proto_t proto)
Convert from a payload-protocol to a chain type.
Definition: fib_types.c:261
struct fib_route_path_encode_t_ fib_route_path_encode_t
A representation of a fib path for fib_path_encode to convey the information to the caller...
struct fib_prefix_t_ fib_prefix_t
Aggregrate type for a prefix.
Contribute an object that is to be used to forward NSH packets.
Definition: fib_types.h:126
u32 fib_node_index_t
A typedef of a node index.
Definition: fib_types.h:29
Don&#39;t resolve the path, use the DPO the client provides.
Definition: fib_types.h:313
enum bier_hdr_proto_id_t_ bier_hdr_proto_id_t
BIER header protocol payload types.
mpls_label_t fp_label
Definition: fib_types.h:198
u32 fib_rpf_id_t
An RPF-ID is numerical value that is used RPF validate.
Definition: fib_types.h:356
u8 * format_fib_protocol(u8 *s, va_list *ap)
Definition: fib_types.c:30
vnet_link_t fib_proto_to_link(fib_protocol_t proto)
Convert from a protocol to a link type.
Definition: fib_types.c:245
unsigned int u32
Definition: types.h:88
enum vnet_link_t_ vnet_link_t
Link Type: A description of the protocol of packets on the link.
u8 frp_preference
A path preference.
Definition: fib_types.h:465
A deag path using the packet&#39;s source not destination address.
Definition: fib_types.h:326
fib_route_path_flags_t frp_flags
flags on the path
Definition: fib_types.h:469
A path that resolves via a BIER F-Mask.
Definition: fib_types.h:334
int fib_prefix_cmp(const fib_prefix_t *p1, const fib_prefix_t *p2)
Compare two prefixes for equality.
Definition: fib_types.c:79
A path that resolves via another table.
Definition: fib_types.h:346
u64 uword
Definition: types.h:112
void fib_prefix_from_ip46_addr(const ip46_address_t *addr, fib_prefix_t *pfx)
Host prefix from ip.
Definition: fib_types.c:54
u8 * format_fib_forw_chain_type(u8 *s, va_list *args)
Definition: fib_types.c:46
mpls_label_t frp_local_label
The MPLS local Label to reursively resolve through.
Definition: fib_types.h:400
dpo_proto_t fib_proto_to_dpo(fib_protocol_t fib_proto)
Definition: fib_types.c:211
unsigned short u16
Definition: types.h:57
enum fib_path_list_walk_rc_t_ fib_path_list_walk_rc_t
return code to control pat-hlist walk
A for-us/local path.
Definition: fib_types.h:301
unsigned char u8
Definition: types.h:56
u32 frp_bier_fib_index
The BIER table to resolve the fmask in.
Definition: fib_types.h:427
fib_protocol_t bier_hdr_proto_to_fib(bier_hdr_proto_id_t bproto)
Convert from BIER next-hop proto to FIB proto.
A path extension is a per-entry addition to the forwarding information when packets are sent for that...
Definition: fib_path_ext.h:72
fib_route_path_t rpath
Definition: fib_types.h:487
int fib_prefix_is_host(const fib_prefix_t *p)
Return true is the prefix is a host prefix.
Definition: fib_types.c:136
Contribute an object that is to be used to forward non-end-of-stack MPLS packets. ...
Definition: fib_types.h:97
Attached path.
Definition: fib_types.h:305
fib_route_path_flags_t_
Path flags from the control plane.
Definition: fib_types.h:287
vhost_vring_addr_t addr
Definition: vhost-user.h:83
u8 frp_weight
[un]equal cost path weight
Definition: fib_types.h:459
u32 frp_udp_encap_id
UDP encap ID.
Definition: fib_types.h:449
Contribute an object that is to be used to forward IP4 packets.
Definition: fib_types.h:112
u32 frp_fib_index
The FIB index to lookup the nexthop Only valid for recursive paths.
Definition: fib_types.h:423
fib_forward_chain_type_t_
FIB output chain type.
Definition: fib_types.h:84
mpls_eos_bit_t fp_eos
Definition: fib_types.h:199
enum mpls_eos_bit_t_ mpls_eos_bit_t