Common form of fib-path reproting in dumps
[vpp.git] / src / vnet / fib / fib_entry.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_ENTRY_H__
17 #define __FIB_ENTRY_H__
18
19 #include <vnet/fib/fib_node.h>
20 #include <vnet/fib/fib_entry_delegate.h>
21 #include <vnet/adj/adj.h>
22 #include <vnet/ip/ip.h>
23 #include <vnet/dpo/dpo.h>
24
25 /**
26  * The different sources that can create a route.
27  * The sources are defined here the thier relative priority order.
28  * The lower the value the higher the priority
29  */
30 typedef enum fib_source_t_ {
31     /**
32      * Marker. Add new values after this one.
33      */
34     FIB_SOURCE_FIRST,
35     /**
36      * Special sources. These are for entries that are added to all
37      * FIBs by default, and should never be over-ridden (hence they
38      * are the highest priority)
39      */
40     FIB_SOURCE_SPECIAL = FIB_SOURCE_FIRST,
41     /**
42      * Classify. A route that links directly to a classify adj
43      */
44     FIB_SOURCE_CLASSIFY,
45     /**
46      * A route the is being 'proxied' on behalf of another device
47      */
48     FIB_SOURCE_PROXY,
49     /**
50      * Route added as a result of interface configuration.
51      * this will also come from the API/CLI, but the distinction is
52      * that is from confiiguration on an interface, not a 'ip route' command
53      */
54     FIB_SOURCE_INTERFACE,
55     /**
56      * SRv6 and SR-MPLS
57      */
58     FIB_SOURCE_SR,
59     /**
60      * A high priority source a plugin can use
61      */
62     FIB_SOURCE_PLUGIN_HI,
63     /**
64      * From the BIER subsystem
65      */
66     FIB_SOURCE_BIER,
67     /**
68      * From the control plane API
69      */
70     FIB_SOURCE_API,
71     /**
72      * From the CLI.
73      */
74     FIB_SOURCE_CLI,
75     /**
76      * LISP
77      */
78     FIB_SOURCE_LISP,
79     /**
80      * IPv[46] Mapping
81      */
82     FIB_SOURCE_MAP,
83     /**
84      * DHCP
85      */
86     FIB_SOURCE_DHCP,
87     /**
88      * IPv6 Proxy ND
89      */
90     FIB_SOURCE_IP6_ND_PROXY,
91     /**
92      * IPv6 ND (seen in the link-local tables)
93      */
94     FIB_SOURCE_IP6_ND,
95     /**
96      * Adjacency source.
97      * routes created as a result of ARP/ND entries. This is lower priority
98      * then the API/CLI. This is on purpose. trust me.
99      */
100     FIB_SOURCE_ADJ,
101     /**
102      * MPLS label. The prefix has been assigned a local label. This source
103      * never provides forwarding information, instead it acts as a place-holder
104      * so the association of label to prefix can be maintained
105      */
106     FIB_SOURCE_MPLS,
107     /**
108      * Attached Export source.
109      * routes created as a result of attahced export. routes thus sourced
110      * will be present in the export tables
111      */
112     FIB_SOURCE_AE,
113     /**
114      * Recursive resolution source.
115      * Used to install an entry that is the resolution traget of another.
116      */
117     FIB_SOURCE_RR,
118     /**
119      * uRPF bypass/exemption.
120      * Used to install an entry that is exempt from the loose uRPF check
121      */
122     FIB_SOURCE_URPF_EXEMPT,
123     /**
124      * The default route source.
125      * The default route is always added to the FIB table (like the
126      * special sources) but we need to be able to over-ride it with
127      * 'ip route' sources when provided
128      */
129     FIB_SOURCE_DEFAULT_ROUTE,
130     /**
131      * Marker. add new entries before this one.
132      */
133     FIB_SOURCE_LAST = FIB_SOURCE_DEFAULT_ROUTE,
134 } __attribute__ ((packed)) fib_source_t;
135
136 STATIC_ASSERT (sizeof(fib_source_t) == 1,
137                "FIB too many sources");
138
139 /**
140  * The maximum number of sources
141  */
142 #define FIB_SOURCE_MAX (FIB_SOURCE_LAST+1)
143
144 #define FIB_SOURCES {                                   \
145     [FIB_SOURCE_SPECIAL] = "special",                   \
146     [FIB_SOURCE_INTERFACE] = "interface",               \
147     [FIB_SOURCE_PROXY] = "proxy",                       \
148     [FIB_SOURCE_BIER] = "BIER",                         \
149     [FIB_SOURCE_API] = "API",                           \
150     [FIB_SOURCE_CLI] = "CLI",                           \
151     [FIB_SOURCE_ADJ] = "adjacency",                     \
152     [FIB_SOURCE_MAP] = "MAP",                           \
153     [FIB_SOURCE_SR] = "SR",                             \
154     [FIB_SOURCE_LISP] = "LISP",                         \
155     [FIB_SOURCE_CLASSIFY] = "classify",                 \
156     [FIB_SOURCE_DHCP] = "DHCP",                         \
157     [FIB_SOURCE_IP6_ND_PROXY] = "IPv6-proxy-nd",        \
158     [FIB_SOURCE_IP6_ND] = "IPv6-nd",                    \
159     [FIB_SOURCE_RR] = "recursive-resolution",           \
160     [FIB_SOURCE_AE] = "attached_export",                \
161     [FIB_SOURCE_MPLS] = "mpls",                         \
162     [FIB_SOURCE_URPF_EXEMPT] = "urpf-exempt",           \
163     [FIB_SOURCE_DEFAULT_ROUTE] = "default-route",       \
164     [FIB_SOURCE_PLUGIN_HI] = "plugin-hi",               \
165 }
166
167 #define FOR_EACH_FIB_SOURCE(_item) \
168     for (_item = FIB_SOURCE_FIRST; _item < FIB_SOURCE_MAX; _item++)
169
170 /**
171  * The different sources that can create a route.
172  * The sources are defined here the thier relative priority order.
173  * The lower the value the higher the priority
174  */
175 typedef enum fib_entry_attribute_t_ {
176     /**
177      * Marker. Add new values after this one.
178      */
179     FIB_ENTRY_ATTRIBUTE_FIRST,
180     /**
181      * Connected. The prefix is configured on an interface.
182      */
183     FIB_ENTRY_ATTRIBUTE_CONNECTED = FIB_ENTRY_ATTRIBUTE_FIRST,
184     /**
185      * Attached. The prefix is attached to an interface.
186      */
187     FIB_ENTRY_ATTRIBUTE_ATTACHED,
188     /**
189      * The route is an explicit drop.
190      */
191     FIB_ENTRY_ATTRIBUTE_DROP,
192     /**
193      * The route is exclusive. The client creating the route is
194      * providing an exclusive adjacency.
195      */
196     FIB_ENTRY_ATTRIBUTE_EXCLUSIVE,
197     /**
198      * The route is attached cross tables and thus imports covered
199      * prefixes from the other table.
200      */
201     FIB_ENTRY_ATTRIBUTE_IMPORT,
202     /**
203      * The prefix/address is local to this device
204      */
205     FIB_ENTRY_ATTRIBUTE_LOCAL,
206     /**
207      * The prefix/address is a multicast prefix.
208      *  this aplies only to MPLS. IP multicast is handled by mfib
209      */
210     FIB_ENTRY_ATTRIBUTE_MULTICAST,
211     /**
212      * The prefix/address exempted from loose uRPF check
213      * To be used with caution
214      */
215     FIB_ENTRY_ATTRIBUTE_URPF_EXEMPT,
216     /**
217      * The prefix/address exempted from attached export
218      */
219     FIB_ENTRY_ATTRIBUTE_NO_ATTACHED_EXPORT,
220     /**
221      * This FIB entry imposes its source information on all prefixes
222      * that is covers
223      */
224     FIB_ENTRY_ATTRIBUTE_COVERED_INHERIT,
225     /**
226      * Marker. add new entries before this one.
227      */
228     FIB_ENTRY_ATTRIBUTE_LAST = FIB_ENTRY_ATTRIBUTE_COVERED_INHERIT,
229 } fib_entry_attribute_t;
230
231 #define FIB_ENTRY_ATTRIBUTES {                          \
232     [FIB_ENTRY_ATTRIBUTE_CONNECTED] = "connected",      \
233     [FIB_ENTRY_ATTRIBUTE_ATTACHED]  = "attached",       \
234     [FIB_ENTRY_ATTRIBUTE_IMPORT]    = "import",         \
235     [FIB_ENTRY_ATTRIBUTE_DROP]      = "drop",           \
236     [FIB_ENTRY_ATTRIBUTE_EXCLUSIVE] = "exclusive",      \
237     [FIB_ENTRY_ATTRIBUTE_LOCAL]     = "local",          \
238     [FIB_ENTRY_ATTRIBUTE_URPF_EXEMPT] = "uRPF-exempt",  \
239     [FIB_ENTRY_ATTRIBUTE_MULTICAST] = "multicast",      \
240     [FIB_ENTRY_ATTRIBUTE_NO_ATTACHED_EXPORT] = "no-attached-export",    \
241     [FIB_ENTRY_ATTRIBUTE_COVERED_INHERIT] = "covered-inherit",  \
242 }
243
244 #define FOR_EACH_FIB_ATTRIBUTE(_item)                   \
245     for (_item = FIB_ENTRY_ATTRIBUTE_FIRST;             \
246          _item <= FIB_ENTRY_ATTRIBUTE_LAST;             \
247          _item++)
248
249 typedef enum fib_entry_flag_t_ {
250     FIB_ENTRY_FLAG_NONE      = 0,
251     FIB_ENTRY_FLAG_CONNECTED = (1 << FIB_ENTRY_ATTRIBUTE_CONNECTED),
252     FIB_ENTRY_FLAG_ATTACHED  = (1 << FIB_ENTRY_ATTRIBUTE_ATTACHED),
253     FIB_ENTRY_FLAG_DROP      = (1 << FIB_ENTRY_ATTRIBUTE_DROP),
254     FIB_ENTRY_FLAG_EXCLUSIVE = (1 << FIB_ENTRY_ATTRIBUTE_EXCLUSIVE),
255     FIB_ENTRY_FLAG_LOCAL     = (1 << FIB_ENTRY_ATTRIBUTE_LOCAL),
256     FIB_ENTRY_FLAG_IMPORT    = (1 << FIB_ENTRY_ATTRIBUTE_IMPORT),
257     FIB_ENTRY_FLAG_NO_ATTACHED_EXPORT = (1 << FIB_ENTRY_ATTRIBUTE_NO_ATTACHED_EXPORT),
258     FIB_ENTRY_FLAG_LOOSE_URPF_EXEMPT = (1 << FIB_ENTRY_ATTRIBUTE_URPF_EXEMPT),
259     FIB_ENTRY_FLAG_MULTICAST = (1 << FIB_ENTRY_ATTRIBUTE_MULTICAST),
260     FIB_ENTRY_FLAG_COVERED_INHERIT = (1 << FIB_ENTRY_ATTRIBUTE_COVERED_INHERIT),
261 } __attribute__((packed)) fib_entry_flag_t;
262
263 /**
264  * Flags for the source data
265  */
266 typedef enum fib_entry_src_attribute_t_ {
267     /**
268      * Marker. Add new values after this one.
269      */
270     FIB_ENTRY_SRC_ATTRIBUTE_FIRST,
271     /**
272      * the source has been added to the entry
273      */
274     FIB_ENTRY_SRC_ATTRIBUTE_ADDED = FIB_ENTRY_SRC_ATTRIBUTE_FIRST,
275     /**
276      * the source is active/best
277      */
278     FIB_ENTRY_SRC_ATTRIBUTE_ACTIVE,
279     /**
280      * the source is inherited from its cover
281      */
282     FIB_ENTRY_SRC_ATTRIBUTE_INHERITED,
283     /**
284      * Marker. add new entries before this one.
285      */
286     FIB_ENTRY_SRC_ATTRIBUTE_LAST = FIB_ENTRY_SRC_ATTRIBUTE_INHERITED,
287 } fib_entry_src_attribute_t;
288
289 #define FIB_ENTRY_SRC_ATTRIBUTE_MAX (FIB_ENTRY_SRC_ATTRIBUTE_LAST+1)
290
291 #define FIB_ENTRY_SRC_ATTRIBUTES {               \
292     [FIB_ENTRY_SRC_ATTRIBUTE_ADDED]  = "added",  \
293     [FIB_ENTRY_SRC_ATTRIBUTE_ACTIVE] = "active", \
294     [FIB_ENTRY_SRC_ATTRIBUTE_INHERITED] = "inherited", \
295 }
296
297 #define FOR_EACH_FIB_SRC_ATTRIBUTE(_item)               \
298     for (_item = FIB_ENTRY_SRC_ATTRIBUTE_FIRST;         \
299          _item < FIB_ENTRY_SRC_ATTRIBUTE_MAX;           \
300          _item++)
301
302 typedef enum fib_entry_src_flag_t_ {
303     FIB_ENTRY_SRC_FLAG_NONE   = 0,
304     FIB_ENTRY_SRC_FLAG_ADDED  = (1 << FIB_ENTRY_SRC_ATTRIBUTE_ADDED),
305     FIB_ENTRY_SRC_FLAG_ACTIVE = (1 << FIB_ENTRY_SRC_ATTRIBUTE_ACTIVE),
306     FIB_ENTRY_SRC_FLAG_INHERITED = (1 << FIB_ENTRY_SRC_ATTRIBUTE_INHERITED),
307 } __attribute__ ((packed)) fib_entry_src_flag_t;
308
309 /*
310  * Keep the size of the flags field to 2 bytes, so it
311  * can be placed next to the 2 bytes reference count
312  */
313 STATIC_ASSERT (sizeof(fib_entry_src_flag_t) <= 2,
314                "FIB entry flags field size too big");
315
316 /**
317  * Information related to the source of a FIB entry
318  */
319 typedef struct fib_entry_src_t_ {
320     /**
321      * A vector of path extensions
322      */
323     fib_path_ext_list_t fes_path_exts;
324
325     /**
326      * The path-list created by the source
327      */
328     fib_node_index_t fes_pl;
329     /**
330      * Which source this info block is for
331      */
332     fib_source_t fes_src;
333     /**
334      * Flags on the source
335      */
336     fib_entry_src_flag_t fes_flags;
337
338     /**
339      * 1 bytes ref count. This is not the number of users of the Entry
340      * (which is itself not large, due to path-list sharing), but the number
341      * of times a given source has been added. Which is even fewer
342      */
343     u8 fes_ref_count;
344
345     /**
346      * Flags the source contributes to the entry
347      */
348     fib_entry_flag_t fes_entry_flags;
349     
350     /**
351      * Source specific info
352      */
353     union {
354         struct {
355             /**
356              * the index of the FIB entry that is the covering entry
357              */
358             fib_node_index_t fesr_cover;
359             /**
360              * This source's index in the cover's list
361              */
362             u32 fesr_sibling;
363         } rr;
364         struct {
365             /**
366              * the index of the FIB entry that is the covering entry
367              */
368             fib_node_index_t fesa_cover;
369             /**
370              * This source's index in the cover's list
371              */
372             u32 fesa_sibling;
373         } adj;
374         struct {
375             /**
376              * the index of the FIB entry that is the covering entry
377              */
378             fib_node_index_t fesi_cover;
379             /**
380              * This source's index in the cover's list
381              */
382             u32 fesi_sibling;
383         } interface;
384         struct {
385             /**
386              * This MPLS local label associated with the prefix.
387              */
388             mpls_label_t fesm_label;
389
390             /**
391              * the indicies of the LFIB entries created
392              */
393             fib_node_index_t fesm_lfes[2];
394         } mpls;
395         struct {
396             /**
397              * The source FIB index.
398              */
399             fib_node_index_t fesl_fib_index;
400         } lisp;
401     };
402 } fib_entry_src_t;
403
404 /**
405  * An entry in a FIB table.
406  *
407  * This entry represents a route added to the FIB that is stored
408  * in one of the FIB tables.
409  */
410 typedef struct fib_entry_t_ {
411     /**
412      * Base class. The entry's node representation in the graph.
413      */
414     fib_node_t fe_node;
415     /**
416      * The prefix of the route. this is const just to be sure.
417      * It is the entry's key/identity and so should never change.
418      */
419     const fib_prefix_t fe_prefix;
420     /**
421      * The index of the FIB table this entry is in
422      */
423     u32 fe_fib_index;
424     /**
425      * The load-balance used for forwarding.
426      *
427      * We don't share the EOS and non-EOS even in case when they could be
428      * because:
429      *   - complexity & reliability v. memory
430      *       determining the conditions where sharing is possible is non-trivial.
431      *   - separate LBs means we can get the EOS bit right in the MPLS label DPO
432      *     and so save a few clock cycles in the DP imposition node since we can
433      *     paint the header straight on without the need to check the packet
434      *     type to derive the EOS bit value.
435      */
436     dpo_id_t fe_lb;
437     /**
438      * Vector of source infos.
439      * Most entries will only have 1 source. So we optimise for memory usage,
440      * which is preferable since we have many entries.
441      */
442     fib_entry_src_t *fe_srcs;
443     /**
444      * the path-list for which this entry is a child. This is also the path-list
445      * that is contributing forwarding for this entry.
446      */
447     fib_node_index_t fe_parent;
448     /**
449      * index of this entry in the parent's child list.
450      * This is set when this entry is added as a child, but can also
451      * be changed by the parent as it manages its list.
452      */
453     u32 fe_sibling;
454
455     /**
456      * A vector of delegates.
457      */
458     fib_entry_delegate_t *fe_delegates;
459 } fib_entry_t;
460
461 #define FOR_EACH_FIB_ENTRY_FLAG(_item) \
462     for (_item = FIB_ENTRY_FLAG_FIRST; _item < FIB_ENTRY_FLAG_MAX; _item++)
463
464 #define FIB_ENTRY_FORMAT_BRIEF   (0x0)
465 #define FIB_ENTRY_FORMAT_DETAIL  (0x1)
466 #define FIB_ENTRY_FORMAT_DETAIL2 (0x2)
467
468 extern u8 *format_fib_entry (u8 * s, va_list * args);
469 extern u8 *format_fib_source (u8 * s, va_list * args);
470
471 extern fib_node_index_t fib_entry_create_special(u32 fib_index,
472                                                  const fib_prefix_t *prefix,
473                                                  fib_source_t source,
474                                                  fib_entry_flag_t flags,
475                                                  const dpo_id_t *dpo);
476
477 extern fib_node_index_t fib_entry_create (u32 fib_index,
478                                           const fib_prefix_t *prefix,
479                                           fib_source_t source,
480                                           fib_entry_flag_t flags,
481                                           const fib_route_path_t *paths);
482 extern void fib_entry_update (fib_node_index_t fib_entry_index,
483                               fib_source_t source,
484                               fib_entry_flag_t flags,
485                               const fib_route_path_t *paths);
486
487 extern void fib_entry_path_add(fib_node_index_t fib_entry_index,
488                                fib_source_t source,
489                                fib_entry_flag_t flags,
490                                const fib_route_path_t *rpath);
491 extern void fib_entry_special_add(fib_node_index_t fib_entry_index,
492                                   fib_source_t source,
493                                   fib_entry_flag_t flags,
494                                   const dpo_id_t *dpo);
495 extern void fib_entry_special_update(fib_node_index_t fib_entry_index,
496                                      fib_source_t source,
497                                      fib_entry_flag_t flags,
498                                      const dpo_id_t *dpo);
499 extern fib_entry_src_flag_t fib_entry_special_remove(fib_node_index_t fib_entry_index,
500                                                      fib_source_t source);
501
502 extern fib_entry_src_flag_t fib_entry_path_remove(fib_node_index_t fib_entry_index,
503                                                   fib_source_t source,
504                                                   const fib_route_path_t *rpath);
505
506 extern void fib_entry_inherit(fib_node_index_t cover,
507                               fib_node_index_t covered);
508
509 extern fib_entry_src_flag_t fib_entry_delete(fib_node_index_t fib_entry_index,
510                                              fib_source_t source);
511
512 extern void fib_entry_contribute_urpf(fib_node_index_t path_index,
513                                       index_t urpf);
514 extern void fib_entry_contribute_forwarding(
515     fib_node_index_t fib_entry_index,
516     fib_forward_chain_type_t type,
517     dpo_id_t *dpo);
518 extern const dpo_id_t * fib_entry_contribute_ip_forwarding(
519     fib_node_index_t fib_entry_index);
520 extern adj_index_t fib_entry_get_adj_for_source(
521     fib_node_index_t fib_entry_index,
522     fib_source_t source);
523 extern const int fib_entry_get_dpo_for_source (
524     fib_node_index_t fib_entry_index,
525     fib_source_t source,
526     dpo_id_t *dpo);
527
528 extern adj_index_t fib_entry_get_adj(fib_node_index_t fib_entry_index);
529
530 extern int fib_entry_cmp_for_sort(void *i1, void *i2);
531
532 extern void fib_entry_cover_changed(fib_node_index_t fib_entry);
533 extern void fib_entry_cover_updated(fib_node_index_t fib_entry);
534 extern int fib_entry_recursive_loop_detect(fib_node_index_t entry_index,
535                                            fib_node_index_t **entry_indicies);
536
537 extern void fib_entry_lock(fib_node_index_t fib_entry_index);
538 extern void fib_entry_unlock(fib_node_index_t fib_entry_index);
539
540 extern u32 fib_entry_child_add(fib_node_index_t fib_entry_index,
541                                fib_node_type_t type,
542                                fib_node_index_t child_index);
543 extern void fib_entry_child_remove(fib_node_index_t fib_entry_index,
544                                    u32 sibling_index);
545 extern u32 fib_entry_get_resolving_interface(fib_node_index_t fib_entry_index);
546 extern u32 fib_entry_get_resolving_interface_for_source(
547     fib_node_index_t fib_entry_index,
548     fib_source_t source);
549
550 extern void fib_entry_encode(fib_node_index_t fib_entry_index,
551                              fib_route_path_encode_t **api_rpaths);
552 extern void fib_entry_get_prefix(fib_node_index_t fib_entry_index,
553                                  fib_prefix_t *pfx);
554 extern u32 fib_entry_get_fib_index(fib_node_index_t fib_entry_index);
555 extern void fib_entry_set_source_data(fib_node_index_t fib_entry_index,
556                                       fib_source_t source,
557                                       const void *data);
558 extern const void* fib_entry_get_source_data(fib_node_index_t fib_entry_index,
559                                              fib_source_t source);
560
561 extern fib_entry_flag_t fib_entry_get_flags(fib_node_index_t fib_entry_index);
562 extern fib_entry_flag_t fib_entry_get_flags_for_source(
563     fib_node_index_t fib_entry_index,
564     fib_source_t source);
565 extern fib_source_t fib_entry_get_best_source(fib_node_index_t fib_entry_index);
566 extern int fib_entry_is_sourced(fib_node_index_t fib_entry_index,
567                                 fib_source_t source);
568
569 extern fib_node_index_t fib_entry_get_path_list(fib_node_index_t fib_entry_index);
570 extern int fib_entry_is_resolved(fib_node_index_t fib_entry_index);
571 extern void fib_entry_set_flow_hash_config(fib_node_index_t fib_entry_index,
572                                            flow_hash_config_t hash_config);
573
574 extern void fib_entry_module_init(void);
575
576 /*
577  * unsafe... beware the raw pointer.
578  */
579 extern fib_node_index_t fib_entry_get_index(const fib_entry_t * fib_entry);
580 extern fib_entry_t * fib_entry_get(fib_node_index_t fib_entry_index);
581
582 /*
583  * for testing purposes.
584  */
585 extern u32 fib_entry_pool_size(void);
586
587 #endif