blob: ddaf914389e4c2e2da2b9908406bdf75f3db7893 [file] [log] [blame]
Neale Ranns0bfe5d82016-08-25 15:29:12 +01001/*
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>
Neale Rannsad422ed2016-11-02 14:20:04 +000020#include <vnet/fib/fib_entry_delegate.h>
Neale Ranns0bfe5d82016-08-25 15:29:12 +010021#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 */
30typedef 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 /**
Andrew Yourtchenko5f3fcb92017-10-25 05:50:37 -070046 * A route the is being 'proxied' on behalf of another device
47 */
48 FIB_SOURCE_PROXY,
49 /**
Neale Ranns0bfe5d82016-08-25 15:29:12 +010050 * 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 /**
Pablo Camarillo5d73eec2017-04-24 17:51:56 +020056 * SRv6 and SR-MPLS
57 */
58 FIB_SOURCE_SR,
59 /**
Neale Ranns0bfe5d82016-08-25 15:29:12 +010060 * A high priority source a plugin can use
61 */
62 FIB_SOURCE_PLUGIN_HI,
63 /**
Neale Rannsd792d9c2017-10-21 10:53:20 -070064 * From the BIER subsystem
65 */
66 FIB_SOURCE_BIER,
67 /**
Neale Ranns0bfe5d82016-08-25 15:29:12 +010068 * From the control plane API
69 */
70 FIB_SOURCE_API,
71 /**
72 * From the CLI.
73 */
74 FIB_SOURCE_CLI,
75 /**
Neale Ranns6df19032018-04-04 05:00:48 -070076 * A low (below routing) priority source a plugin can use
77 */
78 FIB_SOURCE_PLUGIN_LOW,
79 /**
Neale Ranns0bfe5d82016-08-25 15:29:12 +010080 * LISP
81 */
82 FIB_SOURCE_LISP,
83 /**
Neale Ranns0bfe5d82016-08-25 15:29:12 +010084 * IPv[46] Mapping
85 */
86 FIB_SOURCE_MAP,
87 /**
Neale Ranns0bfe5d82016-08-25 15:29:12 +010088 * DHCP
89 */
90 FIB_SOURCE_DHCP,
91 /**
Neale Ranns3f844d02017-02-18 00:03:54 -080092 * IPv6 Proxy ND
93 */
94 FIB_SOURCE_IP6_ND_PROXY,
95 /**
Neale Ranns53da2212018-02-24 02:11:19 -080096 * IPv6 ND (seen in the link-local tables)
97 */
98 FIB_SOURCE_IP6_ND,
99 /**
Neale Ranns0bfe5d82016-08-25 15:29:12 +0100100 * Adjacency source.
101 * routes created as a result of ARP/ND entries. This is lower priority
102 * then the API/CLI. This is on purpose. trust me.
103 */
104 FIB_SOURCE_ADJ,
105 /**
106 * MPLS label. The prefix has been assigned a local label. This source
107 * never provides forwarding information, instead it acts as a place-holder
108 * so the association of label to prefix can be maintained
109 */
110 FIB_SOURCE_MPLS,
111 /**
112 * Attached Export source.
113 * routes created as a result of attahced export. routes thus sourced
114 * will be present in the export tables
115 */
116 FIB_SOURCE_AE,
117 /**
118 * Recursive resolution source.
Neale Ranns3ee44042016-10-03 13:05:48 +0100119 * Used to install an entry that is the resolution traget of another.
Neale Ranns0bfe5d82016-08-25 15:29:12 +0100120 */
121 FIB_SOURCE_RR,
122 /**
Neale Ranns3ee44042016-10-03 13:05:48 +0100123 * uRPF bypass/exemption.
124 * Used to install an entry that is exempt from the loose uRPF check
125 */
126 FIB_SOURCE_URPF_EXEMPT,
127 /**
Neale Ranns0bfe5d82016-08-25 15:29:12 +0100128 * The default route source.
129 * The default route is always added to the FIB table (like the
130 * special sources) but we need to be able to over-ride it with
131 * 'ip route' sources when provided
132 */
133 FIB_SOURCE_DEFAULT_ROUTE,
134 /**
Neale Ranns2303cb12018-02-21 04:57:17 -0800135 * The interpose source.
136 * This is not a real source, so don't use it to source a prefix.
137 * It exists here to provide a value against which to register to the
138 * VFT for providing the interpose actions to a real source.
139 */
140 FIB_SOURCE_INTERPOSE,
141 /**
Neale Ranns0bfe5d82016-08-25 15:29:12 +0100142 * Marker. add new entries before this one.
143 */
Neale Ranns2303cb12018-02-21 04:57:17 -0800144 FIB_SOURCE_LAST = FIB_SOURCE_INTERPOSE,
Neale Ranns0bfe5d82016-08-25 15:29:12 +0100145} __attribute__ ((packed)) fib_source_t;
146
Damjan Marioncf478942016-11-07 14:57:50 +0100147STATIC_ASSERT (sizeof(fib_source_t) == 1,
148 "FIB too many sources");
Neale Ranns0bfe5d82016-08-25 15:29:12 +0100149
150/**
151 * The maximum number of sources
152 */
153#define FIB_SOURCE_MAX (FIB_SOURCE_LAST+1)
154
155#define FIB_SOURCES { \
156 [FIB_SOURCE_SPECIAL] = "special", \
157 [FIB_SOURCE_INTERFACE] = "interface", \
Andrew Yourtchenko5f3fcb92017-10-25 05:50:37 -0700158 [FIB_SOURCE_PROXY] = "proxy", \
Neale Rannsd792d9c2017-10-21 10:53:20 -0700159 [FIB_SOURCE_BIER] = "BIER", \
Neale Ranns0bfe5d82016-08-25 15:29:12 +0100160 [FIB_SOURCE_API] = "API", \
161 [FIB_SOURCE_CLI] = "CLI", \
162 [FIB_SOURCE_ADJ] = "adjacency", \
163 [FIB_SOURCE_MAP] = "MAP", \
164 [FIB_SOURCE_SR] = "SR", \
Neale Ranns0bfe5d82016-08-25 15:29:12 +0100165 [FIB_SOURCE_LISP] = "LISP", \
166 [FIB_SOURCE_CLASSIFY] = "classify", \
167 [FIB_SOURCE_DHCP] = "DHCP", \
Neale Ranns3f844d02017-02-18 00:03:54 -0800168 [FIB_SOURCE_IP6_ND_PROXY] = "IPv6-proxy-nd", \
Neale Ranns53da2212018-02-24 02:11:19 -0800169 [FIB_SOURCE_IP6_ND] = "IPv6-nd", \
Neale Ranns0bfe5d82016-08-25 15:29:12 +0100170 [FIB_SOURCE_RR] = "recursive-resolution", \
171 [FIB_SOURCE_AE] = "attached_export", \
172 [FIB_SOURCE_MPLS] = "mpls", \
Neale Ranns3ee44042016-10-03 13:05:48 +0100173 [FIB_SOURCE_URPF_EXEMPT] = "urpf-exempt", \
Neale Ranns0bfe5d82016-08-25 15:29:12 +0100174 [FIB_SOURCE_DEFAULT_ROUTE] = "default-route", \
Neale Ranns81458422018-03-12 06:59:36 -0700175 [FIB_SOURCE_PLUGIN_HI] = "plugin-hi", \
Neale Ranns6df19032018-04-04 05:00:48 -0700176 [FIB_SOURCE_PLUGIN_LOW] = "plugin-low", \
Neale Ranns2303cb12018-02-21 04:57:17 -0800177 [FIB_SOURCE_INTERPOSE] = "interpose", \
Neale Ranns0bfe5d82016-08-25 15:29:12 +0100178}
179
180#define FOR_EACH_FIB_SOURCE(_item) \
181 for (_item = FIB_SOURCE_FIRST; _item < FIB_SOURCE_MAX; _item++)
182
183/**
184 * The different sources that can create a route.
185 * The sources are defined here the thier relative priority order.
186 * The lower the value the higher the priority
187 */
188typedef enum fib_entry_attribute_t_ {
189 /**
190 * Marker. Add new values after this one.
191 */
192 FIB_ENTRY_ATTRIBUTE_FIRST,
193 /**
194 * Connected. The prefix is configured on an interface.
195 */
196 FIB_ENTRY_ATTRIBUTE_CONNECTED = FIB_ENTRY_ATTRIBUTE_FIRST,
197 /**
198 * Attached. The prefix is attached to an interface.
199 */
200 FIB_ENTRY_ATTRIBUTE_ATTACHED,
201 /**
202 * The route is an explicit drop.
203 */
204 FIB_ENTRY_ATTRIBUTE_DROP,
205 /**
206 * The route is exclusive. The client creating the route is
207 * providing an exclusive adjacency.
208 */
209 FIB_ENTRY_ATTRIBUTE_EXCLUSIVE,
210 /**
211 * The route is attached cross tables and thus imports covered
212 * prefixes from the other table.
213 */
214 FIB_ENTRY_ATTRIBUTE_IMPORT,
215 /**
216 * The prefix/address is local to this device
217 */
218 FIB_ENTRY_ATTRIBUTE_LOCAL,
219 /**
Neale Ranns0f26c5a2017-03-01 15:12:11 -0800220 * The prefix/address is a multicast prefix.
221 * this aplies only to MPLS. IP multicast is handled by mfib
222 */
223 FIB_ENTRY_ATTRIBUTE_MULTICAST,
224 /**
Shwetha Bhandari78372a92017-01-18 12:43:54 +0530225 * The prefix/address exempted from loose uRPF check
226 * To be used with caution
227 */
228 FIB_ENTRY_ATTRIBUTE_URPF_EXEMPT,
229 /**
Neale Ranns53da2212018-02-24 02:11:19 -0800230 * The prefix/address exempted from attached export
231 */
232 FIB_ENTRY_ATTRIBUTE_NO_ATTACHED_EXPORT,
233 /**
Neale Ranns89541992017-04-06 04:41:02 -0700234 * This FIB entry imposes its source information on all prefixes
235 * that is covers
236 */
237 FIB_ENTRY_ATTRIBUTE_COVERED_INHERIT,
238 /**
Neale Ranns2303cb12018-02-21 04:57:17 -0800239 * The interpose attribute.
240 * place the forwarding provided by the source infront of the forwarding
241 * provided by the best source, or failing that, by the cover.
242 */
243 FIB_ENTRY_ATTRIBUTE_INTERPOSE,
244 /**
Neale Ranns0bfe5d82016-08-25 15:29:12 +0100245 * Marker. add new entries before this one.
246 */
Neale Ranns2303cb12018-02-21 04:57:17 -0800247 FIB_ENTRY_ATTRIBUTE_LAST = FIB_ENTRY_ATTRIBUTE_INTERPOSE,
Neale Ranns0bfe5d82016-08-25 15:29:12 +0100248} fib_entry_attribute_t;
249
Neale Ranns0bfe5d82016-08-25 15:29:12 +0100250#define FIB_ENTRY_ATTRIBUTES { \
251 [FIB_ENTRY_ATTRIBUTE_CONNECTED] = "connected", \
252 [FIB_ENTRY_ATTRIBUTE_ATTACHED] = "attached", \
253 [FIB_ENTRY_ATTRIBUTE_IMPORT] = "import", \
254 [FIB_ENTRY_ATTRIBUTE_DROP] = "drop", \
255 [FIB_ENTRY_ATTRIBUTE_EXCLUSIVE] = "exclusive", \
256 [FIB_ENTRY_ATTRIBUTE_LOCAL] = "local", \
Neale Ranns0f26c5a2017-03-01 15:12:11 -0800257 [FIB_ENTRY_ATTRIBUTE_URPF_EXEMPT] = "uRPF-exempt", \
258 [FIB_ENTRY_ATTRIBUTE_MULTICAST] = "multicast", \
Neale Ranns53da2212018-02-24 02:11:19 -0800259 [FIB_ENTRY_ATTRIBUTE_NO_ATTACHED_EXPORT] = "no-attached-export", \
Neale Ranns89541992017-04-06 04:41:02 -0700260 [FIB_ENTRY_ATTRIBUTE_COVERED_INHERIT] = "covered-inherit", \
Neale Ranns2303cb12018-02-21 04:57:17 -0800261 [FIB_ENTRY_ATTRIBUTE_INTERPOSE] = "interpose", \
Neale Ranns0bfe5d82016-08-25 15:29:12 +0100262}
263
264#define FOR_EACH_FIB_ATTRIBUTE(_item) \
265 for (_item = FIB_ENTRY_ATTRIBUTE_FIRST; \
Neale Ranns808c5b22017-08-02 05:15:07 -0700266 _item <= FIB_ENTRY_ATTRIBUTE_LAST; \
Neale Ranns0bfe5d82016-08-25 15:29:12 +0100267 _item++)
268
269typedef enum fib_entry_flag_t_ {
270 FIB_ENTRY_FLAG_NONE = 0,
271 FIB_ENTRY_FLAG_CONNECTED = (1 << FIB_ENTRY_ATTRIBUTE_CONNECTED),
272 FIB_ENTRY_FLAG_ATTACHED = (1 << FIB_ENTRY_ATTRIBUTE_ATTACHED),
273 FIB_ENTRY_FLAG_DROP = (1 << FIB_ENTRY_ATTRIBUTE_DROP),
274 FIB_ENTRY_FLAG_EXCLUSIVE = (1 << FIB_ENTRY_ATTRIBUTE_EXCLUSIVE),
275 FIB_ENTRY_FLAG_LOCAL = (1 << FIB_ENTRY_ATTRIBUTE_LOCAL),
276 FIB_ENTRY_FLAG_IMPORT = (1 << FIB_ENTRY_ATTRIBUTE_IMPORT),
Neale Ranns53da2212018-02-24 02:11:19 -0800277 FIB_ENTRY_FLAG_NO_ATTACHED_EXPORT = (1 << FIB_ENTRY_ATTRIBUTE_NO_ATTACHED_EXPORT),
Shwetha Bhandari78372a92017-01-18 12:43:54 +0530278 FIB_ENTRY_FLAG_LOOSE_URPF_EXEMPT = (1 << FIB_ENTRY_ATTRIBUTE_URPF_EXEMPT),
Neale Ranns0f26c5a2017-03-01 15:12:11 -0800279 FIB_ENTRY_FLAG_MULTICAST = (1 << FIB_ENTRY_ATTRIBUTE_MULTICAST),
Neale Ranns89541992017-04-06 04:41:02 -0700280 FIB_ENTRY_FLAG_COVERED_INHERIT = (1 << FIB_ENTRY_ATTRIBUTE_COVERED_INHERIT),
Neale Ranns2303cb12018-02-21 04:57:17 -0800281 FIB_ENTRY_FLAG_INTERPOSE = (1 << FIB_ENTRY_ATTRIBUTE_INTERPOSE),
Neale Ranns32e1c012016-11-22 17:07:28 +0000282} __attribute__((packed)) fib_entry_flag_t;
Neale Ranns0bfe5d82016-08-25 15:29:12 +0100283
284/**
285 * Flags for the source data
286 */
287typedef enum fib_entry_src_attribute_t_ {
288 /**
289 * Marker. Add new values after this one.
290 */
291 FIB_ENTRY_SRC_ATTRIBUTE_FIRST,
292 /**
293 * the source has been added to the entry
294 */
295 FIB_ENTRY_SRC_ATTRIBUTE_ADDED = FIB_ENTRY_SRC_ATTRIBUTE_FIRST,
296 /**
Neale Ranns2303cb12018-02-21 04:57:17 -0800297 * the source is contributing forwarding
298 */
299 FIB_ENTRY_SRC_ATTRIBUTE_CONTRIBUTING,
300 /**
Neale Ranns0bfe5d82016-08-25 15:29:12 +0100301 * the source is active/best
302 */
303 FIB_ENTRY_SRC_ATTRIBUTE_ACTIVE,
304 /**
Neale Ranns89541992017-04-06 04:41:02 -0700305 * the source is inherited from its cover
306 */
307 FIB_ENTRY_SRC_ATTRIBUTE_INHERITED,
308 /**
Neale Ranns0bfe5d82016-08-25 15:29:12 +0100309 * Marker. add new entries before this one.
310 */
Neale Ranns89541992017-04-06 04:41:02 -0700311 FIB_ENTRY_SRC_ATTRIBUTE_LAST = FIB_ENTRY_SRC_ATTRIBUTE_INHERITED,
Neale Ranns0bfe5d82016-08-25 15:29:12 +0100312} fib_entry_src_attribute_t;
313
Neale Ranns0bfe5d82016-08-25 15:29:12 +0100314
315#define FIB_ENTRY_SRC_ATTRIBUTES { \
316 [FIB_ENTRY_SRC_ATTRIBUTE_ADDED] = "added", \
Neale Ranns2303cb12018-02-21 04:57:17 -0800317 [FIB_ENTRY_SRC_ATTRIBUTE_CONTRIBUTING] = "contributing", \
Neale Ranns0bfe5d82016-08-25 15:29:12 +0100318 [FIB_ENTRY_SRC_ATTRIBUTE_ACTIVE] = "active", \
Neale Ranns89541992017-04-06 04:41:02 -0700319 [FIB_ENTRY_SRC_ATTRIBUTE_INHERITED] = "inherited", \
Neale Ranns0bfe5d82016-08-25 15:29:12 +0100320}
321
Neale Ranns89541992017-04-06 04:41:02 -0700322#define FOR_EACH_FIB_SRC_ATTRIBUTE(_item) \
323 for (_item = FIB_ENTRY_SRC_ATTRIBUTE_FIRST; \
Neale Ranns2303cb12018-02-21 04:57:17 -0800324 _item <= FIB_ENTRY_SRC_ATTRIBUTE_LAST; \
Neale Ranns89541992017-04-06 04:41:02 -0700325 _item++)
326
Neale Ranns0bfe5d82016-08-25 15:29:12 +0100327typedef enum fib_entry_src_flag_t_ {
328 FIB_ENTRY_SRC_FLAG_NONE = 0,
329 FIB_ENTRY_SRC_FLAG_ADDED = (1 << FIB_ENTRY_SRC_ATTRIBUTE_ADDED),
Neale Ranns2303cb12018-02-21 04:57:17 -0800330 FIB_ENTRY_SRC_FLAG_CONTRIBUTING = (1 << FIB_ENTRY_SRC_ATTRIBUTE_CONTRIBUTING),
Neale Ranns0bfe5d82016-08-25 15:29:12 +0100331 FIB_ENTRY_SRC_FLAG_ACTIVE = (1 << FIB_ENTRY_SRC_ATTRIBUTE_ACTIVE),
Neale Ranns89541992017-04-06 04:41:02 -0700332 FIB_ENTRY_SRC_FLAG_INHERITED = (1 << FIB_ENTRY_SRC_ATTRIBUTE_INHERITED),
Neale Ranns0bfe5d82016-08-25 15:29:12 +0100333} __attribute__ ((packed)) fib_entry_src_flag_t;
334
335/*
336 * Keep the size of the flags field to 2 bytes, so it
337 * can be placed next to the 2 bytes reference count
338 */
Damjan Marioncf478942016-11-07 14:57:50 +0100339STATIC_ASSERT (sizeof(fib_entry_src_flag_t) <= 2,
340 "FIB entry flags field size too big");
Neale Ranns0bfe5d82016-08-25 15:29:12 +0100341
342/**
343 * Information related to the source of a FIB entry
344 */
345typedef struct fib_entry_src_t_ {
346 /**
Neale Ranns6c3ebcc2016-10-02 21:20:15 +0100347 * A vector of path extensions
348 */
Neale Ranns81424992017-05-18 03:03:22 -0700349 fib_path_ext_list_t fes_path_exts;
Neale Ranns6c3ebcc2016-10-02 21:20:15 +0100350
351 /**
Neale Ranns0bfe5d82016-08-25 15:29:12 +0100352 * The path-list created by the source
353 */
354 fib_node_index_t fes_pl;
Neale Ranns2303cb12018-02-21 04:57:17 -0800355
356 /**
357 * Flags the source contributes to the entry
358 */
359 fib_entry_flag_t fes_entry_flags;
360
Neale Ranns0bfe5d82016-08-25 15:29:12 +0100361 /**
362 * Which source this info block is for
363 */
364 fib_source_t fes_src;
Neale Ranns2303cb12018-02-21 04:57:17 -0800365
Neale Ranns0bfe5d82016-08-25 15:29:12 +0100366 /**
367 * Flags on the source
368 */
369 fib_entry_src_flag_t fes_flags;
Neale Ranns0bfe5d82016-08-25 15:29:12 +0100370
371 /**
372 * 1 bytes ref count. This is not the number of users of the Entry
373 * (which is itself not large, due to path-list sharing), but the number
374 * of times a given source has been added. Which is even fewer
375 */
376 u8 fes_ref_count;
Neale Ranns0bfe5d82016-08-25 15:29:12 +0100377
378 /**
379 * Source specific info
380 */
381 union {
382 struct {
383 /**
384 * the index of the FIB entry that is the covering entry
385 */
386 fib_node_index_t fesr_cover;
387 /**
388 * This source's index in the cover's list
389 */
390 u32 fesr_sibling;
391 } rr;
392 struct {
393 /**
394 * the index of the FIB entry that is the covering entry
395 */
Neale Ranns2303cb12018-02-21 04:57:17 -0800396 fib_node_index_t fesi_cover;
397 /**
398 * This source's index in the cover's list
399 */
400 u32 fesi_sibling;
401 /**
402 * DPO type to interpose. The dpo type needs to have registered
403 * it's 'contribute interpose' callback function.
404 */
405 dpo_id_t fesi_dpo;
406 } interpose;
407 struct {
408 /**
409 * the index of the FIB entry that is the covering entry
410 */
Neale Ranns0bfe5d82016-08-25 15:29:12 +0100411 fib_node_index_t fesa_cover;
412 /**
413 * This source's index in the cover's list
414 */
415 u32 fesa_sibling;
416 } adj;
417 struct {
418 /**
419 * the index of the FIB entry that is the covering entry
420 */
421 fib_node_index_t fesi_cover;
422 /**
423 * This source's index in the cover's list
424 */
425 u32 fesi_sibling;
426 } interface;
427 struct {
428 /**
429 * This MPLS local label associated with the prefix.
430 */
431 mpls_label_t fesm_label;
432
433 /**
434 * the indicies of the LFIB entries created
435 */
436 fib_node_index_t fesm_lfes[2];
437 } mpls;
438 struct {
439 /**
440 * The source FIB index.
441 */
442 fib_node_index_t fesl_fib_index;
443 } lisp;
Neale Ranns2303cb12018-02-21 04:57:17 -0800444 } u;
Neale Ranns0bfe5d82016-08-25 15:29:12 +0100445} fib_entry_src_t;
446
447/**
448 * An entry in a FIB table.
449 *
450 * This entry represents a route added to the FIB that is stored
451 * in one of the FIB tables.
452 */
453typedef struct fib_entry_t_ {
454 /**
455 * Base class. The entry's node representation in the graph.
456 */
457 fib_node_t fe_node;
458 /**
Neale Rannsad422ed2016-11-02 14:20:04 +0000459 * The prefix of the route. this is const just to be sure.
460 * It is the entry's key/identity and so should never change.
Neale Ranns0bfe5d82016-08-25 15:29:12 +0100461 */
Neale Rannsad422ed2016-11-02 14:20:04 +0000462 const fib_prefix_t fe_prefix;
Neale Ranns0bfe5d82016-08-25 15:29:12 +0100463 /**
464 * The index of the FIB table this entry is in
465 */
466 u32 fe_fib_index;
467 /**
468 * The load-balance used for forwarding.
469 *
470 * We don't share the EOS and non-EOS even in case when they could be
471 * because:
472 * - complexity & reliability v. memory
473 * determining the conditions where sharing is possible is non-trivial.
474 * - separate LBs means we can get the EOS bit right in the MPLS label DPO
475 * and so save a few clock cycles in the DP imposition node since we can
476 * paint the header straight on without the need to check the packet
477 * type to derive the EOS bit value.
478 */
Neale Ranns0f26c5a2017-03-01 15:12:11 -0800479 dpo_id_t fe_lb;
Neale Ranns0bfe5d82016-08-25 15:29:12 +0100480 /**
Neale Rannsa4e77662017-12-04 20:00:30 +0000481 * Vector of source infos.
482 * Most entries will only have 1 source. So we optimise for memory usage,
483 * which is preferable since we have many entries.
Neale Ranns0bfe5d82016-08-25 15:29:12 +0100484 */
Neale Rannsa4e77662017-12-04 20:00:30 +0000485 fib_entry_src_t *fe_srcs;
Neale Ranns0bfe5d82016-08-25 15:29:12 +0100486 /**
487 * the path-list for which this entry is a child. This is also the path-list
488 * that is contributing forwarding for this entry.
489 */
490 fib_node_index_t fe_parent;
491 /**
492 * index of this entry in the parent's child list.
493 * This is set when this entry is added as a child, but can also
494 * be changed by the parent as it manages its list.
495 */
496 u32 fe_sibling;
Neale Rannsad422ed2016-11-02 14:20:04 +0000497
Neale Ranns0bfe5d82016-08-25 15:29:12 +0100498 /**
Neale Rannsad422ed2016-11-02 14:20:04 +0000499 * A vector of delegates.
Neale Ranns0bfe5d82016-08-25 15:29:12 +0100500 */
Neale Rannsad422ed2016-11-02 14:20:04 +0000501 fib_entry_delegate_t *fe_delegates;
Neale Ranns0bfe5d82016-08-25 15:29:12 +0100502} fib_entry_t;
503
504#define FOR_EACH_FIB_ENTRY_FLAG(_item) \
505 for (_item = FIB_ENTRY_FLAG_FIRST; _item < FIB_ENTRY_FLAG_MAX; _item++)
506
507#define FIB_ENTRY_FORMAT_BRIEF (0x0)
508#define FIB_ENTRY_FORMAT_DETAIL (0x1)
509#define FIB_ENTRY_FORMAT_DETAIL2 (0x2)
510
511extern u8 *format_fib_entry (u8 * s, va_list * args);
Neale Ranns15002542017-09-10 04:39:11 -0700512extern u8 *format_fib_source (u8 * s, va_list * args);
Neale Ranns0bfe5d82016-08-25 15:29:12 +0100513
514extern fib_node_index_t fib_entry_create_special(u32 fib_index,
515 const fib_prefix_t *prefix,
516 fib_source_t source,
517 fib_entry_flag_t flags,
518 const dpo_id_t *dpo);
519
520extern fib_node_index_t fib_entry_create (u32 fib_index,
521 const fib_prefix_t *prefix,
522 fib_source_t source,
523 fib_entry_flag_t flags,
524 const fib_route_path_t *paths);
525extern void fib_entry_update (fib_node_index_t fib_entry_index,
526 fib_source_t source,
527 fib_entry_flag_t flags,
528 const fib_route_path_t *paths);
529
530extern void fib_entry_path_add(fib_node_index_t fib_entry_index,
531 fib_source_t source,
532 fib_entry_flag_t flags,
533 const fib_route_path_t *rpath);
534extern void fib_entry_special_add(fib_node_index_t fib_entry_index,
535 fib_source_t source,
536 fib_entry_flag_t flags,
537 const dpo_id_t *dpo);
Neale Ranns948e00f2016-10-20 13:39:34 +0100538extern void fib_entry_special_update(fib_node_index_t fib_entry_index,
539 fib_source_t source,
540 fib_entry_flag_t flags,
541 const dpo_id_t *dpo);
Neale Ranns0bfe5d82016-08-25 15:29:12 +0100542extern fib_entry_src_flag_t fib_entry_special_remove(fib_node_index_t fib_entry_index,
543 fib_source_t source);
544
545extern fib_entry_src_flag_t fib_entry_path_remove(fib_node_index_t fib_entry_index,
546 fib_source_t source,
547 const fib_route_path_t *rpath);
Neale Ranns89541992017-04-06 04:41:02 -0700548
549extern void fib_entry_inherit(fib_node_index_t cover,
550 fib_node_index_t covered);
551
Neale Ranns0bfe5d82016-08-25 15:29:12 +0100552extern fib_entry_src_flag_t fib_entry_delete(fib_node_index_t fib_entry_index,
553 fib_source_t source);
554
Neale Ranns2303cb12018-02-21 04:57:17 -0800555extern void fib_entry_recalculate_forwarding(
556 fib_node_index_t fib_entry_index);
Neale Ranns3ee44042016-10-03 13:05:48 +0100557extern void fib_entry_contribute_urpf(fib_node_index_t path_index,
558 index_t urpf);
Neale Ranns0bfe5d82016-08-25 15:29:12 +0100559extern void fib_entry_contribute_forwarding(
560 fib_node_index_t fib_entry_index,
561 fib_forward_chain_type_t type,
562 dpo_id_t *dpo);
563extern const dpo_id_t * fib_entry_contribute_ip_forwarding(
564 fib_node_index_t fib_entry_index);
565extern adj_index_t fib_entry_get_adj_for_source(
566 fib_node_index_t fib_entry_index,
567 fib_source_t source);
568extern const int fib_entry_get_dpo_for_source (
569 fib_node_index_t fib_entry_index,
570 fib_source_t source,
571 dpo_id_t *dpo);
572
573extern adj_index_t fib_entry_get_adj(fib_node_index_t fib_entry_index);
574
575extern int fib_entry_cmp_for_sort(void *i1, void *i2);
576
577extern void fib_entry_cover_changed(fib_node_index_t fib_entry);
578extern void fib_entry_cover_updated(fib_node_index_t fib_entry);
579extern int fib_entry_recursive_loop_detect(fib_node_index_t entry_index,
580 fib_node_index_t **entry_indicies);
581
582extern void fib_entry_lock(fib_node_index_t fib_entry_index);
583extern void fib_entry_unlock(fib_node_index_t fib_entry_index);
584
585extern u32 fib_entry_child_add(fib_node_index_t fib_entry_index,
586 fib_node_type_t type,
587 fib_node_index_t child_index);
588extern void fib_entry_child_remove(fib_node_index_t fib_entry_index,
589 u32 sibling_index);
590extern u32 fib_entry_get_resolving_interface(fib_node_index_t fib_entry_index);
Neale Rannsdf089a82016-10-02 16:39:06 +0100591extern u32 fib_entry_get_resolving_interface_for_source(
592 fib_node_index_t fib_entry_index,
593 fib_source_t source);
Neale Ranns0bfe5d82016-08-25 15:29:12 +0100594
Steven01b07122016-11-02 10:40:09 -0700595extern void fib_entry_encode(fib_node_index_t fib_entry_index,
596 fib_route_path_encode_t **api_rpaths);
Neale Ranns0bfe5d82016-08-25 15:29:12 +0100597extern void fib_entry_get_prefix(fib_node_index_t fib_entry_index,
598 fib_prefix_t *pfx);
599extern u32 fib_entry_get_fib_index(fib_node_index_t fib_entry_index);
600extern void fib_entry_set_source_data(fib_node_index_t fib_entry_index,
601 fib_source_t source,
602 const void *data);
603extern const void* fib_entry_get_source_data(fib_node_index_t fib_entry_index,
604 fib_source_t source);
605
606extern fib_entry_flag_t fib_entry_get_flags(fib_node_index_t fib_entry_index);
Neale Rannsdf089a82016-10-02 16:39:06 +0100607extern fib_entry_flag_t fib_entry_get_flags_for_source(
608 fib_node_index_t fib_entry_index,
609 fib_source_t source);
Neale Ranns0bfe5d82016-08-25 15:29:12 +0100610extern fib_source_t fib_entry_get_best_source(fib_node_index_t fib_entry_index);
611extern int fib_entry_is_sourced(fib_node_index_t fib_entry_index,
612 fib_source_t source);
613
614extern fib_node_index_t fib_entry_get_path_list(fib_node_index_t fib_entry_index);
Neale Ranns88fc83e2017-04-05 08:11:14 -0700615extern int fib_entry_is_resolved(fib_node_index_t fib_entry_index);
Neale Ranns227038a2017-04-21 01:07:59 -0700616extern void fib_entry_set_flow_hash_config(fib_node_index_t fib_entry_index,
617 flow_hash_config_t hash_config);
Neale Ranns0bfe5d82016-08-25 15:29:12 +0100618
619extern void fib_entry_module_init(void);
620
621/*
622 * unsafe... beware the raw pointer.
623 */
624extern fib_node_index_t fib_entry_get_index(const fib_entry_t * fib_entry);
625extern fib_entry_t * fib_entry_get(fib_node_index_t fib_entry_index);
626
627/*
628 * for testing purposes.
629 */
630extern u32 fib_entry_pool_size(void);
631
632#endif