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:
7 * http://www.apache.org/licenses/LICENSE-2.0
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.
16 #include <vnet/fib/fib_entry.h>
17 #include <vnet/fib/fib_table.h>
19 #include <vnet/fib/fib_attached_export.h>
20 #include <vnet/fib/fib_entry_cover.h>
21 #include <vnet/fib/fib_entry_src.h>
22 #include <vnet/fib/fib_entry_delegate.h>
23 #include <vnet/dpo/drop_dpo.h>
26 * A description of the need to import routes from the export table
28 typedef struct fib_ae_import_t_
31 * The entry in the epxort table that this importer
32 * is importing covereds from
34 fib_node_index_t faei_export_entry;
37 * The attached entry in the import table
39 fib_node_index_t faei_import_entry;
41 * the sibling index on the cover
43 u32 faei_export_sibling;
46 * The index of the exporter tracker. Not set if the
47 * export entry is not valid for export
49 fib_node_index_t faei_exporter;
52 * A vector/list of imported entry indicies
54 fib_node_index_t *faei_importeds;
57 * The FIB index and prefix we are tracking
59 fib_node_index_t faei_export_fib;
60 fib_prefix_t faei_prefix;
63 * The FIB index we are importing into
65 fib_node_index_t faei_import_fib;
69 * A description of the need to export routes to one or more export tables
71 typedef struct fib_ae_export_t_ {
73 * The vector/list of import tracker indicies
75 fib_node_index_t *faee_importers;
78 * THe connected entry this export is acting on behalf of
80 fib_node_index_t faee_ei;
83 * Reference counting locks
89 * memory pools for the importers and exportes
91 static fib_ae_import_t *fib_ae_import_pool;
92 static fib_ae_export_t *fib_ae_export_pool;
94 static fib_ae_export_t *
95 fib_entry_ae_add_or_lock (fib_node_index_t connected)
97 fib_entry_delegate_t *fed;
98 fib_ae_export_t *export;
101 entry = fib_entry_get(connected);
102 fed = fib_entry_delegate_get(entry,
103 FIB_ENTRY_DELEGATE_ATTACHED_EXPORT);
107 fed = fib_entry_delegate_find_or_add(entry,
108 FIB_ENTRY_DELEGATE_ATTACHED_EXPORT);
109 pool_get(fib_ae_export_pool, export);
110 memset(export, 0, sizeof(*export));
112 fed->fd_index = (export - fib_ae_export_pool);
113 export->faee_ei = connected;
117 export = pool_elt_at_index(fib_ae_export_pool, fed->fd_index);
120 export->faee_locks++;
126 fib_entry_import_remove (fib_ae_import_t *import,
127 fib_node_index_t entry_index)
132 * find the index in the vector of the entry we are removing
134 index = vec_search(import->faei_importeds, entry_index);
136 if (index < vec_len(import->faei_importeds))
139 * this is an entry that was previsouly imported
141 fib_table_entry_special_remove(import->faei_import_fib,
142 fib_entry_get_prefix(entry_index),
145 fib_entry_unlock(entry_index);
146 vec_del1(import->faei_importeds, index);
151 fib_entry_import_add (fib_ae_import_t *import,
152 fib_node_index_t entry_index)
154 fib_node_index_t *existing;
155 const fib_prefix_t *prefix;
158 * ensure we only add the exported entry once, since
159 * sourcing prefixes in the table is reference counted
161 vec_foreach(existing, import->faei_importeds)
163 if (*existing == entry_index)
170 * this is the first time this export entry has been imported
171 * Add it to the import FIB and to the list of importeds
173 prefix = fib_entry_get_prefix(entry_index);
176 * don't import entries that have the same prefix the import entry
178 if (0 != fib_prefix_cmp(prefix,
179 &import->faei_prefix))
183 dpo = fib_entry_contribute_ip_forwarding(entry_index);
185 if (dpo_id_is_valid(dpo) && !dpo_is_drop(dpo))
187 fib_table_entry_special_dpo_add(import->faei_import_fib,
190 (fib_entry_get_flags(entry_index) |
191 FIB_ENTRY_FLAG_EXCLUSIVE),
192 load_balance_get_bucket(dpo->dpoi_index, 0));
194 fib_entry_lock(entry_index);
195 vec_add1(import->faei_importeds, entry_index);
199 * the entry currently has no valid forwarding. when it
200 * does it will export itself
206 * Call back when walking a connected prefix's covered prefixes for import
209 fib_entry_covered_walk_import (fib_entry_t *cover,
210 fib_node_index_t covered,
213 fib_ae_import_t *import = ctx;
215 fib_entry_import_add(import, covered);
221 * fib_entry_ae_import_add
223 * Add an importer to a connected entry
226 fib_ae_export_import_add (fib_ae_export_t *export,
227 fib_ae_import_t *import)
231 import->faei_exporter = (export - fib_ae_export_pool);
232 entry = fib_entry_get(export->faee_ei);
234 fib_entry_cover_walk(entry,
235 fib_entry_covered_walk_import,
240 fib_attached_export_import (fib_entry_t *fib_entry,
241 fib_node_index_t export_fib)
243 fib_entry_delegate_t *fed;
244 fib_ae_import_t *import;
245 fib_node_index_t fei;
248 * save index for later post-realloc retreival
250 fei = fib_entry_get_index(fib_entry);
252 pool_get(fib_ae_import_pool, import);
254 import->faei_import_fib = fib_entry->fe_fib_index;
255 import->faei_export_fib = export_fib;
256 import->faei_prefix = fib_entry->fe_prefix;
257 import->faei_import_entry = fib_entry_get_index(fib_entry);
258 import->faei_export_sibling = ~0;
261 * do an exact match in the export table
263 import->faei_export_entry =
264 fib_table_lookup_exact_match(import->faei_export_fib,
265 &import->faei_prefix);
267 if (FIB_NODE_INDEX_INVALID == import->faei_export_entry)
270 * no exact matching entry in the export table. can't be good.
271 * track the next best thing
273 import->faei_export_entry =
274 fib_table_lookup(import->faei_export_fib,
275 &import->faei_prefix);
276 import->faei_exporter = FIB_NODE_INDEX_INVALID;
281 * found the entry in the export table. import the
282 * the prefixes that it covers.
283 * only if the prefix found in the export FIB really is
284 * attached do we want to import its covered
286 if (FIB_ENTRY_FLAG_ATTACHED &
287 fib_entry_get_flags_i(fib_entry_get(import->faei_export_entry)))
289 fib_ae_export_t *export;
291 export = fib_entry_ae_add_or_lock(import->faei_export_entry);
292 vec_add1(export->faee_importers, (import - fib_ae_import_pool));
293 fib_ae_export_import_add(export, import);
298 * track the entry in the export table so we can update appropriately
300 * Exporting prefixes will have allocated new fib_entry_t objects, so the pool
301 * may have realloc'd.
303 fib_entry = fib_entry_get(fei);
304 import->faei_export_sibling =
305 fib_entry_cover_track(fib_entry_get(import->faei_export_entry), fei);
307 fed = fib_entry_delegate_find_or_add(fib_entry,
308 FIB_ENTRY_DELEGATE_ATTACHED_IMPORT);
309 fed->fd_index = (import - fib_ae_import_pool);
313 * \brief All the imported entries need to be pruged
316 fib_attached_export_purge (fib_entry_t *fib_entry)
318 fib_entry_delegate_t *fed;
320 fed = fib_entry_delegate_get(fib_entry,
321 FIB_ENTRY_DELEGATE_ATTACHED_IMPORT);
325 fib_node_index_t *import_index;
326 fib_entry_t *export_entry;
327 fib_ae_import_t *import;
328 fib_ae_export_t *export;
330 import = pool_elt_at_index(fib_ae_import_pool, fed->fd_index);
333 * remove each imported entry
335 vec_foreach(import_index, import->faei_importeds)
337 fib_table_entry_delete(import->faei_import_fib,
338 fib_entry_get_prefix(*import_index),
340 fib_entry_unlock(*import_index);
342 vec_free(import->faei_importeds);
345 * stop tracking the export entry
347 if (~0 != import->faei_export_sibling)
349 fib_entry_cover_untrack(fib_entry_get(import->faei_export_entry),
350 import->faei_export_sibling);
352 import->faei_export_sibling = ~0;
355 * remove this import tracker from the export's list,
356 * if it is attached to one. It won't be in the case the tracked
357 * export entry is not an attached exact match.
359 if (FIB_NODE_INDEX_INVALID != import->faei_exporter)
361 fib_entry_delegate_t *fed;
363 export_entry = fib_entry_get(import->faei_export_entry);
365 fed = fib_entry_delegate_get(export_entry,
366 FIB_ENTRY_DELEGATE_ATTACHED_EXPORT);
369 export = pool_elt_at_index(fib_ae_export_pool, fed->fd_index);
371 u32 index = vec_search(export->faee_importers,
372 (import - fib_ae_import_pool));
374 ASSERT(index < vec_len(export->faee_importers));
375 vec_del1(export->faee_importers, index);
378 * free the exporter if there are no longer importers
380 if (0 == --export->faee_locks)
382 pool_put(fib_ae_export_pool, export);
383 fib_entry_delegate_remove(export_entry,
384 FIB_ENTRY_DELEGATE_ATTACHED_EXPORT);
389 * free the import tracker
391 pool_put(fib_ae_import_pool, import);
392 fib_entry_delegate_remove(fib_entry,
393 FIB_ENTRY_DELEGATE_ATTACHED_IMPORT);
398 fib_attached_export_covered_added (fib_entry_t *cover,
399 fib_node_index_t covered)
401 fib_entry_delegate_t *fed;
403 fed = fib_entry_delegate_get(cover,
404 FIB_ENTRY_DELEGATE_ATTACHED_EXPORT);
409 * the covering prefix is exporting to other tables
411 fib_node_index_t *import_index;
412 fib_ae_import_t *import;
413 fib_ae_export_t *export;
415 export = pool_elt_at_index(fib_ae_export_pool, fed->fd_index);
418 * export the covered entry to each of the importers
420 vec_foreach(import_index, export->faee_importers)
422 import = pool_elt_at_index(fib_ae_import_pool, *import_index);
424 fib_entry_import_add(import, covered);
430 fib_attached_export_covered_removed (fib_entry_t *cover,
431 fib_node_index_t covered)
433 fib_entry_delegate_t *fed;
435 fed = fib_entry_delegate_get(cover,
436 FIB_ENTRY_DELEGATE_ATTACHED_EXPORT);
441 * the covering prefix is exporting to other tables
443 fib_node_index_t *import_index;
444 fib_ae_import_t *import;
445 fib_ae_export_t *export;
447 export = pool_elt_at_index(fib_ae_export_pool, fed->fd_index);
450 * remove the covered entry from each of the importers
452 vec_foreach(import_index, export->faee_importers)
454 import = pool_elt_at_index(fib_ae_import_pool, *import_index);
456 fib_entry_import_remove(import, covered);
462 fib_attached_export_cover_modified_i (fib_entry_t *fib_entry)
464 fib_entry_delegate_t *fed;
466 fed = fib_entry_delegate_get(fib_entry,
467 FIB_ENTRY_DELEGATE_ATTACHED_IMPORT);
471 fib_ae_import_t *import;
475 * safe the temporaries we need from the existing import
476 * since it will be toast after the purge.
478 import = pool_elt_at_index(fib_ae_import_pool, fed->fd_index);
479 export_fib = import->faei_export_fib;
482 * keep it simple. purge anything that was previously imported.
483 * then re-evaluate the need to import.
485 fib_attached_export_purge(fib_entry);
486 fib_attached_export_import(fib_entry, export_fib);
491 * \brief If this entry is tracking a cover (in another table)
492 * then that cover has changed. re-evaluate import.
495 fib_attached_export_cover_change (fib_entry_t *fib_entry)
497 fib_attached_export_cover_modified_i(fib_entry);
501 * \brief If this entry is tracking a cover (in another table)
502 * then that cover has been updated. re-evaluate import.
505 fib_attached_export_cover_update (fib_entry_t *fib_entry)
507 fib_attached_export_cover_modified_i(fib_entry);
511 fib_ae_import_format (fib_node_index_t impi,
514 fib_node_index_t *index;
515 fib_ae_import_t *import;
517 import = pool_elt_at_index(fib_ae_import_pool, impi);
519 s = format(s, "\n Attached-Import:%d:[", (import - fib_ae_import_pool));
520 s = format(s, "export-prefix:%U ", format_fib_prefix, &import->faei_prefix);
521 s = format(s, "export-entry:%d ", import->faei_export_entry);
522 s = format(s, "export-sibling:%d ", import->faei_export_sibling);
523 s = format(s, "exporter:%d ", import->faei_exporter);
524 s = format(s, "export-fib:%d ", import->faei_export_fib);
526 s = format(s, "import-entry:%d ", import->faei_import_entry);
527 s = format(s, "import-fib:%d ", import->faei_import_fib);
529 s = format(s, "importeds:[");
530 vec_foreach(index, import->faei_importeds)
532 s = format(s, "%d, ", *index);
540 fib_ae_export_format (fib_node_index_t expi,
543 fib_node_index_t *index;
544 fib_ae_export_t *export;
546 export = pool_elt_at_index(fib_ae_export_pool, expi);
548 s = format(s, "\n Attached-Export:%d:[", (export - fib_ae_export_pool));
549 s = format(s, "export-entry:%d ", export->faee_ei);
551 s = format(s, "importers:[");
552 vec_foreach(index, export->faee_importers)
554 s = format(s, "%d, ", *index);