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