FD.io VPP  v21.06-3-gbb25fbf28
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 <stdbool.h>
20 #include <vnet/ip/ip46_address.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 boolean is_ip6 to FIB protocol.
76  * Drop MPLS on the floor in favor of IPv4.
77  */
78 static inline fib_protocol_t
80 {
82 }
83 
84 /**
85  * @brief Convert from fib_protocol to ip46_type
86  */
88 
89 /**
90  * @brief Convert from ip46_type to fib_protocol
91  */
93 
94 /**
95  * @brief Convert from a protocol to a link type
96  */
98 
99 /**
100  * FIB output chain type. When a child object requests a forwarding contribution
101  * from a parent, it does so for a particular scenario. This enumererates those
102  * sceanrios
103  */
105  /**
106  * Contribute an object that is to be used to forward IP4 packets
107  */
109  /**
110  * Contribute an object that is to be used to forward IP6 packets
111  */
113  /**
114  * Contribute an object that is to be used to forward non-end-of-stack
115  * MPLS packets
116  */
118  /**
119  * Contribute an object that is to be used to forward BIER packets.
120  */
122  /**
123  * Contribute an object that is to be used to forward end-of-stack
124  * MPLS packets. This is a convenient ID for clients. A real EOS chain
125  * must be pay-load protocol specific. This
126  * option is converted into one of the other three internally.
127  */
129  /**
130  * Contribute an object that is to be used to forward IP4 packets
131  */
133  /**
134  * Contribute an object that is to be used to forward IP6 packets
135  */
137  /**
138  * Contribute an object that is to be used to forward Ethernet packets.
139  */
141  /**
142  * Contribute an object that is to be used to forward NSH packets.
143  * This is last in the list since it is not valid for many FIB objects,
144  * and thus their array of per-chain-type DPOs can be sized smaller.
145  */
147 } __attribute__ ((packed)) fib_forward_chain_type_t;
148 
149 #define FIB_FORW_CHAINS { \
150  [FIB_FORW_CHAIN_TYPE_ETHERNET] = "ethernet", \
151  [FIB_FORW_CHAIN_TYPE_BIER] = "bier", \
152  [FIB_FORW_CHAIN_TYPE_UNICAST_IP4] = "unicast-ip4", \
153  [FIB_FORW_CHAIN_TYPE_UNICAST_IP6] = "unicast-ip6", \
154  [FIB_FORW_CHAIN_TYPE_MCAST_IP4] = "multicast-ip4", \
155  [FIB_FORW_CHAIN_TYPE_MCAST_IP6] = "multicast-ip6", \
156  [FIB_FORW_CHAIN_TYPE_MPLS_NON_EOS] = "mpls-neos", \
157  [FIB_FORW_CHAIN_TYPE_MPLS_EOS] = "mpls-eos", \
158  [FIB_FORW_CHAIN_TYPE_NSH] = "nsh", \
159 }
160 
161 #define FIB_FORW_CHAIN_NUM (FIB_FORW_CHAIN_TYPE_NSH+1)
162 #define FIB_FORW_CHAIN_MPLS_NUM (FIB_FORW_CHAIN_TYPE_MPLS_EOS+1)
163 
164 #define FOR_EACH_FIB_FORW_CHAIN(_item) \
165  for (_item = FIB_FORW_CHAIN_TYPE_UNICAST_IP4; \
166  _item <= FIB_FORW_CHAIN_TYPE_NSH; \
167  _item++)
168 
169 #define FOR_EACH_FIB_FORW_MPLS_CHAIN(_item) \
170  for (_item = FIB_FORW_CHAIN_TYPE_UNICAST_IP4; \
171  _item <= FIB_FORW_CHAIN_TYPE_MPLS_EOS; \
172  _item++)
173 
174 /**
175  * @brief Convert from a chain type to the adjacency's link type
176  */
178 
179 /**
180  * @brief Convert from a adjacency's link type to chain type
181  */
183 
184 /**
185  * @brief Convert from a payload-protocol to a chain type.
186  */
188 
189 /**
190  * @brief Convert from a fib-protocol to a chain type.
191  */
193 
194 /**
195  * @brief Convert from a chain type to the DPO proto it will install
196  */
198 
199 /**
200  * Aggregate type for a prefix
201  */
202 typedef struct fib_prefix_t_ {
203  /**
204  * The mask length
205  */
207 
208  /**
209  * protocol type
210  */
212 
213  /**
214  * Pad to keep the address 4 byte aligned
215  */
216  u8 ___fp___pad;
217 
218  union {
219  /**
220  * The address type is not deriveable from the fp_addr member.
221  * If it's v4, then the first 3 u32s of the address will be 0.
222  * v6 addresses (even v4 mapped ones) have at least 2 u32s assigned
223  * to non-zero values. true. but when it's all zero, one cannot decide.
224  */
225  ip46_address_t fp_addr;
226 
227  struct {
230  /**
231  * This protocol determines the payload protocol of packets
232  * that will be forwarded by this entry once the label is popped.
233  * For a non-eos entry it will be MPLS.
234  */
236  };
237  };
238 } fib_prefix_t;
239 
241  "FIB Prefix's address is 4 byte aligned.");
242 
243 /**
244  * \brief Compare two prefixes for equality
245  */
246 extern int fib_prefix_cmp(const fib_prefix_t *p1,
247  const fib_prefix_t *p2);
248 
249 /**
250  * \brief Copy a prefix
251  */
252 extern void fib_prefix_copy(fib_prefix_t *dst,
253  const fib_prefix_t *src);
254 
255 /**
256  * \brief Compare two prefixes for covering relationship
257  *
258  * \return non-zero if the first prefix is a cover for the second
259  */
260 extern int fib_prefix_is_cover(const fib_prefix_t *p1,
261  const fib_prefix_t *p2);
262 
263 /**
264  * \brief Return true is the prefix is a host prefix
265  */
266 extern int fib_prefix_is_host(const fib_prefix_t *p);
268 
269 /**
270  * normalise a prefix (i.e. mask the host bits according to the
271  * prefix length)
272  */
273 extern void fib_prefix_normalize(const fib_prefix_t *p,
274  fib_prefix_t *out);
275 
276 /**
277  * \brief Host prefix from ip
278  */
279 extern void fib_prefix_from_ip46_addr (const ip46_address_t *addr,
280  fib_prefix_t *pfx);
281 
282 extern u8 * format_fib_prefix(u8 * s, va_list * args);
283 extern u8 * format_fib_forw_chain_type(u8 * s, va_list * args);
284 
287 
288 /**
289  * Convert from BIER next-hop proto to FIB proto
290  */
292 
293 /**
294  * Enurmeration of special path/entry types
295  */
296 typedef enum fib_special_type_t_ {
297  /**
298  * Marker. Add new types after this one.
299  */
301  /**
302  * Local/for-us paths
303  */
305  /**
306  * drop paths
307  */
309  /**
310  * Marker. Add new types before this one, then update it.
311  */
313 } __attribute__ ((packed)) fib_special_type_t;
314 
315 /**
316  * The maximum number of types
317  */
318 #define FIB_SPEICAL_TYPE_MAX (FIB_SPEICAL_TYPE_LAST + 1)
319 
320 #define FOR_EACH_FIB_SPEICAL_TYPE(_item) \
321  for (_item = FIB_TYPE_SPEICAL_FIRST; \
322  _item <= FIB_SPEICAL_TYPE_LAST; _item++)
323 
324 extern u8 * format_fib_protocol(u8 * s, va_list *ap);
325 extern u8 * format_vnet_link(u8 *s, va_list *ap);
326 
327 /**
328  * Path flags from the control plane
329  */
331 {
333  /**
334  * Recursion constraint of via a host prefix
335  */
337  /**
338  * Recursion constraint of via an attahced prefix
339  */
341  /**
342  * A for-us/local path
343  */
345  /**
346  * Attached path
347  */
349  /**
350  * A Drop path - resolve the path on the drop DPO
351  */
353  /**
354  * Don't resolve the path, use the DPO the client provides
355  */
357  /**
358  * A path that result in received traffic being recieved/recirculated
359  * so that it appears to have arrived on the new interface
360  */
362  /**
363  * A local path with a RPF-ID => multicast traffic
364  */
366  /**
367  * A deag path using the packet's source not destination address.
368  */
370  /**
371  * A path via a UDP encap object.
372  */
374  /**
375  * A path that resolves via a BIER F-Mask
376  */
378  /**
379  * A path that resolves via a BIER [ECMP] Table
380  */
382  /**
383  * A path that resolves via a BIER impostion object
384  */
386  /**
387  * A path that resolves via another table
388  */
389  FIB_ROUTE_PATH_DEAG = (1 << 13),
390  /**
391  * A path that resolves via a DVR DPO
392  */
393  FIB_ROUTE_PATH_DVR = (1 << 14),
394 
398 
399  /**
400  * Pop a Psuedo Wire Control Word
401  */
403  /**
404  * A path that resolves via a glean adjacency
405  */
406  FIB_ROUTE_PATH_GLEAN = (1 << 19),
408 
409 /**
410  * Format route path flags
411  */
412 extern u8 * format_fib_route_path_flags(u8 *s, va_list *ap);
413 
414 /**
415  * An RPF-ID is numerical value that is used RPF validate. An entry
416  * has-a RPF-ID, when a packet egress from (e.g. an LSP) it gains an
417  * RPF-ID, these two are compared for the RPF check.
418  * This replaces the interfce based chack (since the LSP has no associated
419  * interface.
420  */
422 
423 #define MFIB_RPF_ID_NONE (0)
424 
425 /**
426  * MPLS LSP mode - only valid at the head and tail
427  */
429 {
430  /**
431  * Pipe Mode - the default.
432  * TTL and DSCP markings are not carried between the layers
433  */
435  /**
436  * Uniform mode.
437  * TTL and DSCP are copied between the layers
438  */
440 } __attribute__((packed)) fib_mpls_lsp_mode_t;
441 
442 #define FIB_MPLS_LSP_MODES { \
443  [FIB_MPLS_LSP_MODE_PIPE] = "pipe", \
444  [FIB_MPLS_LSP_MODE_UNIFORM] = "uniform", \
445 }
446 
447 /**
448  * Format an LSP mode type
449  */
450 extern u8 * format_fib_mpls_lsp_mode(u8 *s, va_list *ap);
451 
452 /**
453  * Configuration for each label value in the output-stack
454  */
455 typedef struct fib_mpls_label_t_
456 {
457  /**
458  * The label value
459  */
461 
462  /**
463  * The LSP mode
464  */
466 
467  /**
468  * TTL. valid only at imposition.
469  */
471 
472  /**
473  * EXP bits; valid only at imposition.
474  */
477 
478 /**
479  * Format an MPLS label
480  */
481 extern u8 * format_fib_mpls_label(u8 *s, va_list *ap);
482 
483 /**
484  * @brief
485  * A representation of a path as described by a route producer.
486  * These paramenters will determine the path 'type', of which there are:
487  * 1) Attached-next-hop:
488  * a single peer on a link.
489  * It is 'attached' because it is in the same sub-net as the router, on a link
490  * directly connected to the route.
491  * It is 'next=hop' since the next-hop address of the peer is known.
492  * 2) Attached:
493  * the next-hop is not known. but we can ARP for it.
494  * 3) Recursive.
495  * The next-hop is known but the interface is not. So to find the adj to use
496  * we must recursively resolve the next-hop.
497  * 3) deaggregate (deag)
498  * A further lookup is required.
499  */
500 typedef struct fib_route_path_t_ {
501  /**
502  * The protocol of the address below. We need this since the all
503  * zeros address is ambiguous.
504  */
506 
507  union {
508  struct {
509  union {
510  /**
511  * The next-hop address.
512  * Will be NULL for attached paths.
513  * Will be all zeros for attached-next-hop paths on a p2p interface
514  * Will be all zeros for a deag path.
515  */
516  ip46_address_t frp_addr;
517 
518  struct {
519  /**
520  * The MPLS local Label to reursively resolve through.
521  * This is valid when the path type is MPLS.
522  */
524  /**
525  * EOS bit for the resolving label
526  */
528  };
529  /**
530  * A path via a BIER imposition object.
531  * Present in an mfib path list
532  */
534 
535  /**
536  * Glean prefix on a glean path
537  */
539  };
540 
541  /**
542  * The interface.
543  * Will be invalid for recursive paths.
544  */
546 
547  /**
548  * The RPF-ID
549  */
551 
552  /**
553  * The FIB index to lookup the nexthop
554  * Only valid for recursive paths.
555  */
557  /**
558  * The outgoing MPLS label Stack. NULL implies no label.
559  */
561  /**
562  * Exclusive DPO
563  */
565  /**
566  * MFIB interface flags
567  */
569  };
570  /**
571  * A path that resolves via a BIER Table.
572  * This would be for a MPLS label at a BIER midpoint or tail
573  */
575 
576  /**
577  * UDP encap ID
578  */
580 
581  /**
582  * Classify table ID
583  */
585 
586  /**
587  * Resolving via a BIER Fmask
588  */
590 
591  /**
592  * The DPO for use with exclusive paths
593  */
595  };
596  /**
597  * [un]equal cost path weight
598  */
600  /**
601  * A path preference. 0 is the best.
602  * Only paths of the best preference, that are 'up', are considered
603  * for forwarding.
604  */
606  /**
607  * flags on the path
608  */
611 
612 /**
613  * Unformat a fib_route_path_t from CLI input
614  */
615 extern uword unformat_fib_route_path(unformat_input_t * input, va_list * args);
616 
617 /**
618  * Format route path flags
619  */
620 extern u8 * format_fib_route_path(u8 *s, va_list *ap);
621 
622 /**
623  * A help string to list the FIB path options
624  */
625 #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>]"
626 
627 /**
628  * return code to control pat-hlist walk
629  */
631 {
635 
636 /**
637  * A list of path-extensions
638  */
639 typedef struct fib_path_ext_list_t_
640 {
643 
644 #endif
fib_special_type_t_
fib_special_type_t_
Enurmeration of special path/entry types.
Definition: fib_types.h:296
fib_route_path_t_::frp_fib_index
u32 frp_fib_index
The FIB index to lookup the nexthop Only valid for recursive paths.
Definition: fib_types.h:556
fib_prefix_cmp
int fib_prefix_cmp(const fib_prefix_t *p1, const fib_prefix_t *p2)
Compare two prefixes for equality.
Definition: fib_types.c:177
fib_route_path_t_::frp_mitf_flags
u32 frp_mitf_flags
MFIB interface flags.
Definition: fib_types.h:568
format_fib_protocol
u8 * format_fib_protocol(u8 *s, va_list *ap)
Definition: fib_types.c:33
fib_ip_proto
static fib_protocol_t fib_ip_proto(bool is_ip6)
Convert from boolean is_ip6 to FIB protocol.
Definition: fib_types.h:79
fib_prefix_copy
void fib_prefix_copy(fib_prefix_t *dst, const fib_prefix_t *src)
Copy a prefix.
Definition: fib_types.c:170
fib_route_path_t_::frp_bier_imp
index_t frp_bier_imp
A path via a BIER imposition object.
Definition: fib_types.h:533
fib_prefix_t
struct fib_prefix_t_ fib_prefix_t
Aggregate type for a prefix.
fib_route_path_t
struct fib_route_path_t_ fib_route_path_t
A representation of a path as described by a route producer.
fib_route_path_t_::frp_weight
u8 frp_weight
[un]equal cost path weight
Definition: fib_types.h:599
dpo_proto_t
enum dpo_proto_t_ dpo_proto_t
Data path protocol.
FIB_ROUTE_PATH_ICMP_PROHIBIT
@ FIB_ROUTE_PATH_ICMP_PROHIBIT
Definition: fib_types.h:396
fib_mpls_label_t_::fml_exp
u8 fml_exp
EXP bits; valid only at imposition.
Definition: fib_types.h:475
fib_route_path_t_::frp_bier_tbl
bier_table_id_t frp_bier_tbl
A path that resolves via a BIER Table.
Definition: fib_types.h:574
fib_mpls_lsp_mode_t_
fib_mpls_lsp_mode_t_
MPLS LSP mode - only valid at the head and tail.
Definition: fib_types.h:428
bier_table_id_t_
The ID of a table.
Definition: bier_types.h:394
FIB_FORW_CHAIN_TYPE_MPLS_EOS
@ FIB_FORW_CHAIN_TYPE_MPLS_EOS
Contribute an object that is to be used to forward end-of-stack MPLS packets.
Definition: fib_types.h:128
format_fib_forw_chain_type
u8 * format_fib_forw_chain_type(u8 *s, va_list *args)
Definition: fib_types.c:49
fib_route_path_t_::frp_dpo
dpo_id_t frp_dpo
The DPO for use with exclusive paths.
Definition: fib_types.h:594
fib_path_list_walk_rc_t
enum fib_path_list_walk_rc_t_ fib_path_list_walk_rc_t
return code to control pat-hlist walk
fib_route_path_t_::frp_addr
ip46_address_t frp_addr
The next-hop address.
Definition: fib_types.h:516
FIB_FORW_CHAIN_TYPE_MCAST_IP4
@ FIB_FORW_CHAIN_TYPE_MCAST_IP4
Contribute an object that is to be used to forward IP4 packets.
Definition: fib_types.h:132
fib_route_path_t_::frp_rpf_id
fib_rpf_id_t frp_rpf_id
The RPF-ID.
Definition: fib_types.h:550
u16
unsigned short u16
Definition: types.h:57
fib_special_type_t
enum fib_special_type_t_ fib_special_type_t
Enurmeration of special path/entry types.
FIB_FORW_CHAIN_TYPE_ETHERNET
@ FIB_FORW_CHAIN_TYPE_ETHERNET
Contribute an object that is to be used to forward Ethernet packets.
Definition: fib_types.h:140
fib_prefix_t_::fp_len
u16 fp_len
The mask length.
Definition: fib_types.h:206
fib_route_path_t_::frp_eos
mpls_eos_bit_t frp_eos
EOS bit for the resolving label.
Definition: fib_types.h:527
fib_route_path_t_::frp_sw_if_index
u32 frp_sw_if_index
The interface.
Definition: fib_types.h:545
fib_route_path_t_::frp_bier_fmask
index_t frp_bier_fmask
Resolving via a BIER Fmask.
Definition: fib_types.h:589
fib_prefix_t_::fp_eos
mpls_eos_bit_t fp_eos
Definition: fib_types.h:229
packet.h
unformat_input_t
struct _unformat_input_t unformat_input_t
fib_route_path_t_::frp_proto
dpo_proto_t frp_proto
The protocol of the address below.
Definition: fib_types.h:505
addr
vhost_vring_addr_t addr
Definition: vhost_user.h:130
fib_proto_to_link
vnet_link_t fib_proto_to_link(fib_protocol_t proto)
Convert from a protocol to a link type.
Definition: fib_types.c:377
fib_forw_chain_type_from_dpo_proto
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:427
format_vnet_link
u8 * format_vnet_link(u8 *s, va_list *ap)
Definition: fib_types.c:41
FIB_SPECIAL_TYPE_DROP
@ FIB_SPECIAL_TYPE_DROP
drop paths
Definition: fib_types.h:308
FIB_ROUTE_PATH_DVR
@ FIB_ROUTE_PATH_DVR
A path that resolves via a DVR DPO.
Definition: fib_types.h:393
fib_path_ext_list_t_::fpel_exts
struct fib_path_ext_t_ * fpel_exts
Definition: fib_types.h:641
fib_route_path_t_::frp_label_stack
fib_mpls_label_t * frp_label_stack
The outgoing MPLS label Stack.
Definition: fib_types.h:560
FIB_FORW_CHAIN_TYPE_NSH
@ FIB_FORW_CHAIN_TYPE_NSH
Contribute an object that is to be used to forward NSH packets.
Definition: fib_types.h:146
FIB_FORW_CHAIN_TYPE_UNICAST_IP4
@ FIB_FORW_CHAIN_TYPE_UNICAST_IP4
Contribute an object that is to be used to forward IP4 packets.
Definition: fib_types.h:108
STRUCT_OFFSET_OF
#define STRUCT_OFFSET_OF(t, f)
Definition: clib.h:73
FIB_SPECIAL_TYPE_LAST
@ FIB_SPECIAL_TYPE_LAST
Marker.
Definition: fib_types.h:312
fib_rpf_id_t
u32 fib_rpf_id_t
An RPF-ID is numerical value that is used RPF validate.
Definition: fib_types.h:421
unformat_fib_route_path
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:540
fib_forw_chain_type_to_dpo_proto
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:516
FIB_ROUTE_PATH_INTF_RX
@ FIB_ROUTE_PATH_INTF_RX
A path that result in received traffic being recieved/recirculated so that it appears to have arrived...
Definition: fib_types.h:361
fib_prefix_from_ip46_addr
void fib_prefix_from_ip46_addr(const ip46_address_t *addr, fib_prefix_t *pfx)
Host prefix from ip.
Definition: fib_types.c:81
dpo.h
fib_forward_chain_type_t
enum fib_forward_chain_type_t_ fib_forward_chain_type_t
FIB output chain type.
fib_path_ext_list_t
struct fib_path_ext_list_t_ fib_path_ext_list_t
A list of path-extensions.
fib_proto_from_ip46
fib_protocol_t fib_proto_from_ip46(ip46_type_t iproto)
Convert from ip46_type to fib_protocol.
Definition: fib_types.c:409
fib_prefix_normalize
void fib_prefix_normalize(const fib_prefix_t *p, fib_prefix_t *out)
normalise a prefix (i.e.
Definition: fib_types.c:264
FIB_ROUTE_PATH_BIER_TABLE
@ FIB_ROUTE_PATH_BIER_TABLE
A path that resolves via a BIER [ECMP] Table.
Definition: fib_types.h:381
fib_path_ext_list_t_
A list of path-extensions.
Definition: fib_types.h:639
fib_forw_chain_type_from_link_type
fib_forward_chain_type_t fib_forw_chain_type_from_link_type(vnet_link_t lt)
Convert from a adjacency's link type to chain type.
Definition: fib_types.c:493
index_t
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:43
FIB_ROUTE_PATH_SOURCE_LOOKUP
@ FIB_ROUTE_PATH_SOURCE_LOOKUP
A deag path using the packet's source not destination address.
Definition: fib_types.h:369
fib_node_index_t
u32 fib_node_index_t
A typedef of a node index.
Definition: fib_types.h:29
uword
u64 uword
Definition: types.h:112
FIB_ROUTE_PATH_RESOLVE_VIA_HOST
@ FIB_ROUTE_PATH_RESOLVE_VIA_HOST
Recursion constraint of via a host prefix.
Definition: fib_types.h:336
fib_route_path_t_::frp_classify_table_id
u32 frp_classify_table_id
Classify table ID.
Definition: fib_types.h:584
FIB_ROUTE_PATH_DEAG
@ FIB_ROUTE_PATH_DEAG
A path that resolves via another table.
Definition: fib_types.h:389
fib_prefix_t_::fp_label
mpls_label_t fp_label
Definition: fib_types.h:228
fib_mpls_lsp_mode_t
enum fib_mpls_lsp_mode_t_ fib_mpls_lsp_mode_t
MPLS LSP mode - only valid at the head and tail.
FIB_ROUTE_PATH_UDP_ENCAP
@ FIB_ROUTE_PATH_UDP_ENCAP
A path via a UDP encap object.
Definition: fib_types.h:373
fib_prefix_is_host
int fib_prefix_is_host(const fib_prefix_t *p)
Return true is the prefix is a host prefix.
Definition: fib_types.c:249
fib_prefix_t_::fp_payload_proto
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:235
FIB_ROUTE_PATH_RPF_ID
@ FIB_ROUTE_PATH_RPF_ID
A local path with a RPF-ID => multicast traffic.
Definition: fib_types.h:365
src
vl_api_address_t src
Definition: gre.api:54
fib_protocol_t
enum fib_protocol_t_ fib_protocol_t
Protocol Type.
FIB_PROTOCOL_IP4
@ FIB_PROTOCOL_IP4
Definition: fib_types.h:36
FIB_PATH_LIST_WALK_STOP
@ FIB_PATH_LIST_WALK_STOP
Definition: fib_types.h:632
fib_mpls_label_t
struct fib_mpls_label_t_ fib_mpls_label_t
Configuration for each label value in the output-stack.
fib_prefix_t_::fp_addr
ip46_address_t fp_addr
The address type is not deriveable from the fp_addr member.
Definition: fib_types.h:225
format_fib_route_path
u8 * format_fib_route_path(u8 *s, va_list *ap)
Format route path flags.
Definition: fib_types.c:143
ip46_address.h
FIB_PATH_LIST_WALK_CONTINUE
@ FIB_PATH_LIST_WALK_CONTINUE
Definition: fib_types.h:633
bier_hdr_proto_id_t
enum bier_hdr_proto_id_t_ bier_hdr_proto_id_t
BIER header protocol payload types.
fib_mpls_label_t_::fml_value
mpls_label_t fml_value
The label value.
Definition: fib_types.h:460
is_ip6
bool is_ip6
Definition: ip.api:43
fib_proto_to_dpo
dpo_proto_t fib_proto_to_dpo(fib_protocol_t fib_proto)
Definition: fib_types.c:343
FIB_SPECIAL_TYPE_FIRST
@ FIB_SPECIAL_TYPE_FIRST
Marker.
Definition: fib_types.h:300
bier_hdr_proto_to_fib
fib_protocol_t bier_hdr_proto_to_fib(bier_hdr_proto_id_t bproto)
Convert from BIER next-hop proto to FIB proto.
FIB_ROUTE_PATH_RESOLVE_VIA_ATTACHED
@ FIB_ROUTE_PATH_RESOLVE_VIA_ATTACHED
Recursion constraint of via an attahced prefix.
Definition: fib_types.h:340
STATIC_ASSERT
STATIC_ASSERT(STRUCT_OFFSET_OF(fib_prefix_t, fp_addr)==4, "FIB Prefix's address is 4 byte aligned.")
FIB_FORW_CHAIN_TYPE_MPLS_NON_EOS
@ FIB_FORW_CHAIN_TYPE_MPLS_NON_EOS
Contribute an object that is to be used to forward non-end-of-stack MPLS packets.
Definition: fib_types.h:117
fib_route_path_t_::frp_flags
fib_route_path_flags_t frp_flags
flags on the path
Definition: fib_types.h:609
FIB_ROUTE_PATH_POP_PW_CW
@ FIB_ROUTE_PATH_POP_PW_CW
Pop a Psuedo Wire Control Word.
Definition: fib_types.h:402
fib_route_path_t_::dpo
dpo_id_t dpo
Exclusive DPO.
Definition: fib_types.h:564
FIB_PROTOCOL_MPLS
@ FIB_PROTOCOL_MPLS
Definition: fib_types.h:38
DPO_PROTO_IP6
@ DPO_PROTO_IP6
Definition: dpo.h:65
FIB_ROUTE_PATH_FLAG_NONE
@ FIB_ROUTE_PATH_FLAG_NONE
Definition: fib_types.h:332
DPO_PROTO_MPLS
@ DPO_PROTO_MPLS
Definition: dpo.h:66
FIB_MPLS_LSP_MODE_UNIFORM
@ FIB_MPLS_LSP_MODE_UNIFORM
Uniform mode.
Definition: fib_types.h:439
u32
unsigned int u32
Definition: types.h:88
fib_prefix_get_host_length
u8 fib_prefix_get_host_length(fib_protocol_t proto)
Definition: fib_types.c:234
fib_mpls_label_t_::fml_ttl
u8 fml_ttl
TTL.
Definition: fib_types.h:470
FIB_PROTOCOL_IP6
@ FIB_PROTOCOL_IP6
Definition: fib_types.h:37
dst
vl_api_ip4_address_t dst
Definition: pnat.api:41
fib_route_path_t_
A representation of a path as described by a route producer.
Definition: fib_types.h:500
fib_forward_chain_type_t_
fib_forward_chain_type_t_
FIB output chain type.
Definition: fib_types.h:104
fib_mpls_label_t_::fml_mode
fib_mpls_lsp_mode_t fml_mode
The LSP mode.
Definition: fib_types.h:465
FIB_ROUTE_PATH_ICMP_UNREACH
@ FIB_ROUTE_PATH_ICMP_UNREACH
Definition: fib_types.h:395
bier_types.h
fib_route_path_flags_t_
fib_route_path_flags_t_
Path flags from the control plane.
Definition: fib_types.h:330
FIB_ROUTE_PATH_ATTACHED
@ FIB_ROUTE_PATH_ATTACHED
Attached path.
Definition: fib_types.h:348
FIB_FORW_CHAIN_TYPE_BIER
@ FIB_FORW_CHAIN_TYPE_BIER
Contribute an object that is to be used to forward BIER packets.
Definition: fib_types.h:121
fib_prefix_t_::fp_proto
fib_protocol_t fp_proto
protocol type
Definition: fib_types.h:211
fib_path_list_walk_rc_t_
fib_path_list_walk_rc_t_
return code to control pat-hlist walk
Definition: fib_types.h:630
FIB_FORW_CHAIN_TYPE_MCAST_IP6
@ FIB_FORW_CHAIN_TYPE_MCAST_IP6
Contribute an object that is to be used to forward IP6 packets.
Definition: fib_types.h:136
format_fib_mpls_lsp_mode
u8 * format_fib_mpls_lsp_mode(u8 *s, va_list *ap)
Format an LSP mode type.
Definition: fib_types.c:57
fib_mpls_label_t_
Configuration for each label value in the output-stack.
Definition: fib_types.h:455
vnet_link_t
enum vnet_link_t_ vnet_link_t
Link Type: A description of the protocol of packets on the link.
dpo_proto_to_fib
fib_protocol_t dpo_proto_to_fib(dpo_proto_t dpo_proto)
Definition: fib_types.c:359
format_fib_route_path_flags
u8 * format_fib_route_path_flags(u8 *s, va_list *ap)
Format route path flags.
Definition: fib_types.c:96
u8
unsigned char u8
Definition: types.h:56
fib_forw_chain_type_from_fib_proto
fib_forward_chain_type_t fib_forw_chain_type_from_fib_proto(fib_protocol_t proto)
Convert from a fib-protocol to a chain type.
Definition: fib_types.c:449
FIB_ROUTE_PATH_GLEAN
@ FIB_ROUTE_PATH_GLEAN
A path that resolves via a glean adjacency.
Definition: fib_types.h:406
fib_proto_to_ip46
ip46_type_t fib_proto_to_ip46(fib_protocol_t fproto)
Convert from fib_protocol to ip46_type.
Definition: fib_types.c:393
fib_protocol_t_
fib_protocol_t_
Protocol Type.
Definition: fib_types.h:35
fib_path_ext_t_
A path extension is a per-entry addition to the forwarding information when packets are sent for that...
Definition: fib_path_ext.h:98
ip46_type_t
ip46_type_t
Definition: ip46_address.h:22
DPO_PROTO_IP4
@ DPO_PROTO_IP4
Definition: dpo.h:64
fib_route_path_flags_t
enum fib_route_path_flags_t_ fib_route_path_flags_t
Path flags from the control plane.
FIB_ROUTE_PATH_DROP
@ FIB_ROUTE_PATH_DROP
A Drop path - resolve the path on the drop DPO.
Definition: fib_types.h:352
format_fib_prefix
u8 * format_fib_prefix(u8 *s, va_list *args)
Definition: fib_types.c:283
dpo_id_t_
The identity of a DPO is a combination of its type and its instance number/index of objects of that t...
Definition: dpo.h:172
FIB_SPECIAL_TYPE_LOCAL
@ FIB_SPECIAL_TYPE_LOCAL
Local/for-us paths.
Definition: fib_types.h:304
mpls_label_t
u32 mpls_label_t
A label value only, i.e.
Definition: packet.h:26
fib_route_path_t_::frp_preference
u8 frp_preference
A path preference.
Definition: fib_types.h:605
fib_route_path_t_::frp_udp_encap_id
u32 frp_udp_encap_id
UDP encap ID.
Definition: fib_types.h:579
fib_prefix_is_cover
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:212
FIB_ROUTE_PATH_EXCLUSIVE
@ FIB_ROUTE_PATH_EXCLUSIVE
Don't resolve the path, use the DPO the client provides.
Definition: fib_types.h:356
FIB_ROUTE_PATH_BIER_IMP
@ FIB_ROUTE_PATH_BIER_IMP
A path that resolves via a BIER impostion object.
Definition: fib_types.h:385
FIB_FORW_CHAIN_TYPE_UNICAST_IP6
@ FIB_FORW_CHAIN_TYPE_UNICAST_IP6
Contribute an object that is to be used to forward IP6 packets.
Definition: fib_types.h:112
FIB_MPLS_LSP_MODE_PIPE
@ FIB_MPLS_LSP_MODE_PIPE
Pipe Mode - the default.
Definition: fib_types.h:434
FIB_ROUTE_PATH_BIER_FMASK
@ FIB_ROUTE_PATH_BIER_FMASK
A path that resolves via a BIER F-Mask.
Definition: fib_types.h:377
mpls_eos_bit_t
enum mpls_eos_bit_t_ mpls_eos_bit_t
proto
vl_api_ip_proto_t proto
Definition: acl_types.api:51
format_fib_mpls_label
u8 * format_fib_mpls_label(u8 *s, va_list *ap)
Format an MPLS label.
Definition: fib_types.c:65
fib_route_path_t_::frp_local_label
mpls_label_t frp_local_label
The MPLS local Label to reursively resolve through.
Definition: fib_types.h:523
fib_route_path_t_::frp_connected
fib_prefix_t frp_connected
Glean prefix on a glean path.
Definition: fib_types.h:538
FIB_ROUTE_PATH_CLASSIFY
@ FIB_ROUTE_PATH_CLASSIFY
Definition: fib_types.h:397
fib_prefix_t_
Aggregate type for a prefix.
Definition: fib_types.h:202
FIB_ROUTE_PATH_LOCAL
@ FIB_ROUTE_PATH_LOCAL
A for-us/local path.
Definition: fib_types.h:344
fib_forw_chain_type_to_link_type
vnet_link_t fib_forw_chain_type_to_link_type(fib_forward_chain_type_t fct)
Convert from a chain type to the adjacency's link type.
Definition: fib_types.c:465