FD.io VPP  v17.07.01-10-g3be13f0
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 
24 /**
25  * A typedef of a node index.
26  * we make this typedef so the code becomes easier for a human to parse.
27  */
29 #define FIB_NODE_INDEX_INVALID ((fib_node_index_t)(~0))
30 
31 /**
32  * Protocol Type. packed so it consumes a u8 only
33  */
34 typedef enum fib_protocol_t_ {
38 } __attribute__ ((packed)) fib_protocol_t;
39 
40 #define FIB_PROTOCOLS { \
41  [FIB_PROTOCOL_IP4] = "ipv4", \
42  [FIB_PROTOCOL_IP6] = "ipv6", \
43  [FIB_PROTOCOL_MPLS] = "MPLS", \
44 }
45 
46 /**
47  * Definition outside of enum so it does not need to be included in non-defaulted
48  * switch statements
49  */
50 #define FIB_PROTOCOL_MAX (FIB_PROTOCOL_MPLS + 1)
51 
52 /**
53  * Not part of the enum so it does not have to be handled in switch statements
54  */
55 #define FIB_PROTOCOL_NONE (FIB_PROTOCOL_MAX+1)
56 
57 #define FOR_EACH_FIB_PROTOCOL(_item) \
58  for (_item = FIB_PROTOCOL_IP4; \
59  _item <= FIB_PROTOCOL_MPLS; \
60  _item++)
61 
62 #define FOR_EACH_FIB_IP_PROTOCOL(_item) \
63  for (_item = FIB_PROTOCOL_IP4; \
64  _item <= FIB_PROTOCOL_IP6; \
65  _item++)
66 
67 /**
68  * @brief Convert from a protocol to a link type
69  */
70 vnet_link_t fib_proto_to_link (fib_protocol_t proto);
71 
72 /**
73  * FIB output chain type. When a child object requests a forwarding contribution
74  * from a parent, it does so for a particular scenario. This enumererates those
75  * sceanrios
76  */
78  /**
79  * Contribute an object that is to be used to forward IP4 packets
80  */
82  /**
83  * Contribute an object that is to be used to forward IP6 packets
84  */
86  /**
87  * Contribute an object that is to be used to forward non-end-of-stack
88  * MPLS packets
89  */
91  /**
92  * Contribute an object that is to be used to forward end-of-stack
93  * MPLS packets. This is a convenient ID for clients. A real EOS chain
94  * must be pay-load protocol specific. This
95  * option is converted into one of the other three internally.
96  */
98  /**
99  * Contribute an object that is to be used to forward IP4 packets
100  */
102  /**
103  * Contribute an object that is to be used to forward IP6 packets
104  */
106  /**
107  * Contribute an object that is to be used to forward Ethernet packets.
108  */
110  /**
111  * Contribute an object that is to be used to forward NSH packets.
112  * This is last in the list since it is not valid for many FIB objects,
113  * and thus their array of per-chain-type DPOs can be sized smaller.
114  */
116 } __attribute__ ((packed)) fib_forward_chain_type_t;
117 
118 #define FIB_FORW_CHAINS { \
119  [FIB_FORW_CHAIN_TYPE_ETHERNET] = "ethernet", \
120  [FIB_FORW_CHAIN_TYPE_UNICAST_IP4] = "unicast-ip4", \
121  [FIB_FORW_CHAIN_TYPE_UNICAST_IP6] = "unicast-ip6", \
122  [FIB_FORW_CHAIN_TYPE_MCAST_IP4] = "multicast-ip4", \
123  [FIB_FORW_CHAIN_TYPE_MCAST_IP6] = "multicast-ip6", \
124  [FIB_FORW_CHAIN_TYPE_MPLS_NON_EOS] = "mpls-neos", \
125  [FIB_FORW_CHAIN_TYPE_MPLS_EOS] = "mpls-eos", \
126  [FIB_FORW_CHAIN_TYPE_NSH] = "nsh", \
127 }
128 
129 #define FIB_FORW_CHAIN_NUM (FIB_FORW_CHAIN_TYPE_NSH+1)
130 #define FIB_FORW_CHAIN_MPLS_NUM (FIB_FORW_CHAIN_TYPE_MPLS_EOS+1)
131 
132 #define FOR_EACH_FIB_FORW_CHAIN(_item) \
133  for (_item = FIB_FORW_CHAIN_TYPE_UNICAST_IP4; \
134  _item <= FIB_FORW_CHAIN_TYPE_NSH; \
135  _item++)
136 
137 #define FOR_EACH_FIB_FORW_MPLS_CHAIN(_item) \
138  for (_item = FIB_FORW_CHAIN_TYPE_UNICAST_IP4; \
139  _item <= FIB_FORW_CHAIN_TYPE_MPLS_EOS; \
140  _item++)
141 
142 /**
143  * @brief Convert from a chain type to the adjacencies link type
144  */
145 extern vnet_link_t fib_forw_chain_type_to_link_type(fib_forward_chain_type_t fct);
146 
147 /**
148  * @brief Convert from a payload-protocol to a chain type.
149  */
150 extern fib_forward_chain_type_t fib_forw_chain_type_from_dpo_proto(dpo_proto_t proto);
151 
152 /**
153  * @brief Convert from a chain type to the DPO proto it will install
154  */
155 extern dpo_proto_t fib_forw_chain_type_to_dpo_proto(fib_forward_chain_type_t fct);
156 
157 /**
158  * Aggregrate type for a prefix
159  */
160 typedef struct fib_prefix_t_ {
161  /**
162  * The mask length
163  */
165 
166  /**
167  * protocol type
168  */
169  fib_protocol_t fp_proto;
170 
171  /**
172  * Pad to keep the address 4 byte aligned
173  */
174  u8 ___fp___pad;
175 
176  union {
177  /**
178  * The address type is not deriveable from the fp_addr member.
179  * If it's v4, then the first 3 u32s of the address will be 0.
180  * v6 addresses (even v4 mapped ones) have at least 2 u32s assigned
181  * to non-zero values. true. but when it's all zero, one cannot decide.
182  */
183  ip46_address_t fp_addr;
184 
185  struct {
188  /**
189  * This protocol determines the payload protocol of packets
190  * that will be forwarded by this entry once the label is popped.
191  * For a non-eos entry it will be MPLS.
192  */
194  };
195  };
196 } fib_prefix_t;
197 
199  "FIB Prefix's address is 4 byte aligned.");
200 
201 /**
202  * \brief Compare two prefixes for equality
203  */
204 extern int fib_prefix_cmp(const fib_prefix_t *p1,
205  const fib_prefix_t *p2);
206 
207 /**
208  * \brief Compare two prefixes for covering relationship
209  *
210  * \return non-zero if the first prefix is a cover for the second
211  */
212 extern int fib_prefix_is_cover(const fib_prefix_t *p1,
213  const fib_prefix_t *p2);
214 
215 /**
216  * \brief Return true is the prefix is a host prefix
217  */
218 extern int fib_prefix_is_host(const fib_prefix_t *p);
219 
220 
221 /**
222  * \brief Host prefix from ip
223  */
224 extern void fib_prefix_from_ip46_addr (const ip46_address_t *addr,
225  fib_prefix_t *pfx);
226 
227 extern u8 * format_fib_prefix(u8 * s, va_list * args);
228 extern u8 * format_fib_forw_chain_type(u8 * s, va_list * args);
229 
230 extern dpo_proto_t fib_proto_to_dpo(fib_protocol_t fib_proto);
231 extern fib_protocol_t dpo_proto_to_fib(dpo_proto_t dpo_proto);
232 
233 /**
234  * Enurmeration of special path/entry types
235  */
236 typedef enum fib_special_type_t_ {
237  /**
238  * Marker. Add new types after this one.
239  */
241  /**
242  * Local/for-us paths
243  */
245  /**
246  * drop paths
247  */
249  /**
250  * Marker. Add new types before this one, then update it.
251  */
253 } __attribute__ ((packed)) fib_special_type_t;
254 
255 /**
256  * The maximum number of types
257  */
258 #define FIB_SPEICAL_TYPE_MAX (FIB_SPEICAL_TYPE_LAST + 1)
259 
260 #define FOR_EACH_FIB_SPEICAL_TYPE(_item) \
261  for (_item = FIB_TYPE_SPEICAL_FIRST; \
262  _item <= FIB_SPEICAL_TYPE_LAST; _item++)
263 
264 extern u8 * format_fib_protocol(u8 * s, va_list ap);
265 extern u8 * format_vnet_link(u8 *s, va_list ap);
266 
267 /**
268  * Path flags from the control plane
269  */
271 {
273  /**
274  * Recursion constraint of via a host prefix
275  */
277  /**
278  * Recursion constraint of via an attahced prefix
279  */
281  /**
282  * A for-us/local path
283  */
285  /**
286  * Attached path
287  */
289  /**
290  * A Drop path - resolve the path on the drop DPO
291  */
293  /**
294  * Don't resolve the path, use the DPO the client provides
295  */
297  /**
298  * A path that result in received traffic being recieved/recirculated
299  * so that it appears to have arrived on the new interface
300  */
302  /**
303  * A local path with a RPF-ID => multicast traffic
304  */
307 
308 /**
309  * An RPF-ID is numerical value that is used RPF validate. An entry
310  * has-a RPF-ID, when a packet egress from (e.g. an LSP) it gains an
311  * RPF-ID, these two are compared for the RPF check.
312  * This replaces the interfce based chack (since the LSP has no associated
313  * interface.
314  */
316 
317 #define MFIB_RPF_ID_NONE (0)
318 
319 /**
320  * @brief
321  * A representation of a path as described by a route producer.
322  * These paramenters will determine the path 'type', of which there are:
323  * 1) Attached-next-hop:
324  * a single peer on a link.
325  * It is 'attached' because it is in the same sub-net as the router, on a link
326  * directly connected to the route.
327  * It is 'next=hop' since the next-hop address of the peer is known.
328  * 2) Attached:
329  * the next-hop is not known. but we can ARP for it.
330  * 3) Recursive.
331  * The next-hop is known but the interface is not. So to find the adj to use
332  * we must recursively resolve the next-hop.
333  * 3) deaggregate (deag)
334  * A further lookup is required.
335  */
336 typedef struct fib_route_path_t_ {
337  /**
338  * The protocol of the address below. We need this since the all
339  * zeros address is ambiguous.
340  */
341  fib_protocol_t frp_proto;
342 
343  union {
344  /**
345  * The next-hop address.
346  * Will be NULL for attached paths.
347  * Will be all zeros for attached-next-hop paths on a p2p interface
348  * Will be all zeros for a deag path.
349  */
350  ip46_address_t frp_addr;
351 
352  struct {
353  /**
354  * The MPLS local Label to reursively resolve through.
355  * This is valid when the path type is MPLS.
356  */
358  /**
359  * EOS bit for the resolving label
360  */
362  };
363  };
364  union {
365  /**
366  * The interface.
367  * Will be invalid for recursive paths.
368  */
370  /**
371  * The RPF-ID
372  */
373  fib_rpf_id_t frp_rpf_id;
374  };
375  /**
376  * The FIB index to lookup the nexthop
377  * Only valid for recursive paths.
378  */
380  /**
381  * [un]equal cost path weight
382  */
384  /**
385  * flags on the path
386  */
388  /**
389  * The outgoing MPLS label Stack. NULL implies no label.
390  */
393 
394 /**
395  * @brief
396  * A representation of a fib path for fib_path_encode to convey the information to the caller
397  */
398 typedef struct fib_route_path_encode_t_ {
402 
403 /**
404  * return code to control pat-hlist walk
405  */
407 {
411 
412 /**
413  * A list of path-extensions
414  */
415 typedef struct fib_path_ext_list_t_
416 {
419 
420 #endif
fib_protocol_t fp_proto
protocol type
Definition: fib_types.h:169
fib_protocol_t frp_proto
The protocol of the address below.
Definition: fib_types.h:341
Contribute an object that is to be used to forward IP6 packets.
Definition: fib_types.h:105
ip46_address_t frp_addr
The next-hop address.
Definition: fib_types.h:350
Contribute an object that is to be used to forward IP6 packets.
Definition: fib_types.h:85
A representation of a fib path for fib_path_encode to convey the information to the caller...
Definition: fib_types.h:398
mpls_eos_bit_t frp_eos
EOS bit for the resolving label.
Definition: fib_types.h:361
A representation of a path as described by a route producer.
Definition: fib_types.h:336
A Drop path - resolve the path on the drop DPO.
Definition: fib_types.h:292
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:308
Local/for-us paths.
Definition: fib_types.h:244
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:281
u32 mpls_label_t
A label value only, i.e.
Definition: packet.h:24
u8 * format_fib_protocol(u8 *s, va_list ap)
Definition: fib_types.c:30
struct fib_path_ext_t_ * fpel_exts
Definition: fib_types.h:417
Contribute an object that is to be used to forward IP4 packets.
Definition: fib_types.h:81
#define STRUCT_OFFSET_OF(t, f)
Definition: clib.h:62
A path that result in received traffic being recieved/recirculated so that it appears to have arrived...
Definition: fib_types.h:301
fib_rpf_id_t frp_rpf_id
The RPF-ID.
Definition: fib_types.h:373
A local path with a RPF-ID => multicast traffic.
Definition: fib_types.h:305
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:193
u32 frp_sw_if_index
The interface.
Definition: fib_types.h:369
fib_special_type_t_
Enurmeration of special path/entry types.
Definition: fib_types.h:236
mpls_label_t * frp_label_stack
The outgoing MPLS label Stack.
Definition: fib_types.h:391
Recursion constraint of via a host prefix.
Definition: fib_types.h:276
Aggregrate type for a prefix.
Definition: fib_types.h:160
enum fib_route_path_flags_t_ fib_route_path_flags_t
Path flags from the control plane.
u8 * format_vnet_link(u8 *s, va_list ap)
Definition: fib_types.c:38
Contribute an object that is to be used to forward Ethernet packets.
Definition: fib_types.h:109
enum dpo_proto_t_ dpo_proto_t
Data path protocol.
u16 fp_len
The mask length.
Definition: fib_types.h:164
STATIC_ASSERT(STRUCT_OFFSET_OF(fib_prefix_t, fp_addr)==4,"FIB Prefix's address is 4 byte aligned.")
The identity of a DPO is a combination of its type and its instance number/index of objects of that t...
Definition: dpo.h:152
Contribute an object that is to be used to forward end-of-stack MPLS packets.
Definition: fib_types.h:97
fib_protocol_t_
Protocol Type.
Definition: fib_types.h:34
ip46_address_t fp_addr
The address type is not deriveable from the fp_addr member.
Definition: fib_types.h:183
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:280
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:415
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:406
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:115
u32 frp_weight
[un]equal cost path weight
Definition: fib_types.h:383
u32 fib_node_index_t
A typedef of a node index.
Definition: fib_types.h:28
Don&#39;t resolve the path, use the DPO the client provides.
Definition: fib_types.h:296
mpls_label_t fp_label
Definition: fib_types.h:186
u32 fib_rpf_id_t
An RPF-ID is numerical value that is used RPF validate.
Definition: fib_types.h:315
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.
fib_route_path_flags_t frp_flags
flags on the path
Definition: fib_types.h:387
int fib_prefix_cmp(const fib_prefix_t *p1, const fib_prefix_t *p2)
Compare two prefixes for equality.
Definition: fib_types.c:79
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:357
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:284
unsigned char u8
Definition: types.h:56
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:399
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:90
Attached path.
Definition: fib_types.h:288
fib_route_path_flags_t_
Path flags from the control plane.
Definition: fib_types.h:270
vhost_vring_addr_t addr
Definition: vhost-user.h:82
Contribute an object that is to be used to forward IP4 packets.
Definition: fib_types.h:101
u32 frp_fib_index
The FIB index to lookup the nexthop Only valid for recursive paths.
Definition: fib_types.h:379
fib_forward_chain_type_t_
FIB output chain type.
Definition: fib_types.h:77
mpls_eos_bit_t fp_eos
Definition: fib_types.h:187
enum mpls_eos_bit_t_ mpls_eos_bit_t