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