blob: 3a7caff0101df48f010314d301a7b757f7ea2c81 [file] [log] [blame]
Vince Lehman76c751c2014-11-18 17:36:38 -06001/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
Davide Pesaventoa3148082018-04-12 18:21:54 -04002/*
Davide Pesaventoe422f9e2022-06-03 01:30:23 -04003 * Copyright (c) 2014-2022, Regents of the University of California,
Vince Lehman76c751c2014-11-18 17:36:38 -06004 * Arizona Board of Regents,
5 * Colorado State University,
6 * University Pierre & Marie Curie, Sorbonne University,
7 * Washington University in St. Louis,
8 * Beijing Institute of Technology,
9 * The University of Memphis.
10 *
11 * This file is part of NFD (Named Data Networking Forwarding Daemon).
12 * See AUTHORS.md for complete list of NFD authors and contributors.
13 *
14 * NFD is free software: you can redistribute it and/or modify it under the terms
15 * of the GNU General Public License as published by the Free Software Foundation,
16 * either version 3 of the License, or (at your option) any later version.
17 *
18 * NFD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
19 * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
20 * PURPOSE. See the GNU General Public License for more details.
21 *
22 * You should have received a copy of the GNU General Public License along with
23 * NFD, e.g., in COPYING.md file. If not, see <http://www.gnu.org/licenses/>.
24 */
25
26#include "fib-updater.hpp"
Davide Pesavento2cae8ca2019-04-18 20:48:05 -040027#include "common/logger.hpp"
Vince Lehman76c751c2014-11-18 17:36:38 -060028
Junxiao Shi25c6ce42016-09-09 13:49:59 +000029#include <ndn-cxx/mgmt/nfd/control-parameters.hpp>
Vince Lehman76c751c2014-11-18 17:36:38 -060030
Davide Pesaventoe422f9e2022-06-03 01:30:23 -040031namespace nfd::rib {
Vince Lehman76c751c2014-11-18 17:36:38 -060032
Davide Pesaventoa3148082018-04-12 18:21:54 -040033NFD_LOG_INIT(FibUpdater);
Vince Lehman76c751c2014-11-18 17:36:38 -060034
Davide Pesaventoa3148082018-04-12 18:21:54 -040035using ndn::nfd::ControlParameters;
Vince Lehman76c751c2014-11-18 17:36:38 -060036
Junxiao Shidf1dc652019-08-30 19:03:19 +000037constexpr int MAX_NUM_TIMEOUTS = 10;
38constexpr uint32_t ERROR_FACE_NOT_FOUND = 410;
Vince Lehman76c751c2014-11-18 17:36:38 -060039
40FibUpdater::FibUpdater(Rib& rib, ndn::nfd::Controller& controller)
41 : m_rib(rib)
42 , m_controller(controller)
43{
44 rib.setFibUpdater(this);
45}
46
47void
48FibUpdater::computeAndSendFibUpdates(const RibUpdateBatch& batch,
49 const FibUpdateSuccessCallback& onSuccess,
50 const FibUpdateFailureCallback& onFailure)
51{
52 m_batchFaceId = batch.getFaceId();
53
54 // Erase previously calculated inherited routes
55 m_inheritedRoutes.clear();
56
57 // Erase previously calculated FIB updates
58 m_updatesForBatchFaceId.clear();
59 m_updatesForNonBatchFaceId.clear();
60
61 computeUpdates(batch);
62
63 sendUpdatesForBatchFaceId(onSuccess, onFailure);
64}
65
66void
67FibUpdater::computeUpdates(const RibUpdateBatch& batch)
68{
69 NFD_LOG_DEBUG("Computing updates for batch with faceID: " << batch.getFaceId());
70
71 // Compute updates and add to m_fibUpdates
Junxiao Shi3f21e582017-05-29 15:26:32 +000072 for (const RibUpdate& update : batch) {
73 switch (update.getAction()) {
Vince Lehman76c751c2014-11-18 17:36:38 -060074 case RibUpdate::REGISTER:
75 computeUpdatesForRegistration(update);
76 break;
77 case RibUpdate::UNREGISTER:
78 computeUpdatesForUnregistration(update);
79 break;
80 case RibUpdate::REMOVE_FACE:
81 computeUpdatesForUnregistration(update);
82
83 // Do not apply updates with the same face ID as the destroyed face
84 // since they will be rejected by the FIB
85 m_updatesForBatchFaceId.clear();
86 break;
Vince Lehman76c751c2014-11-18 17:36:38 -060087 }
Junxiao Shi3f21e582017-05-29 15:26:32 +000088 }
Vince Lehman76c751c2014-11-18 17:36:38 -060089}
90
91void
92FibUpdater::computeUpdatesForRegistration(const RibUpdate& update)
93{
94 const Name& prefix = update.getName();
95 const Route& route = update.getRoute();
96
Davide Pesavento412c9822021-07-02 00:21:05 -040097 auto it = m_rib.find(prefix);
Vince Lehman76c751c2014-11-18 17:36:38 -060098
99 // Name prefix exists
100 if (it != m_rib.end()) {
101 shared_ptr<const RibEntry> entry(it->second);
102
Davide Pesavento412c9822021-07-02 00:21:05 -0400103 auto existingRoute = entry->findRoute(route);
Vince Lehman76c751c2014-11-18 17:36:38 -0600104
105 // Route will be new
106 if (existingRoute == entry->end()) {
107 // Will the new route change the namespace's capture flag?
Junxiao Shi3f21e582017-05-29 15:26:32 +0000108 bool willCaptureBeTurnedOn = (entry->hasCapture() == false && route.isRibCapture());
Vince Lehman76c751c2014-11-18 17:36:38 -0600109
110 createFibUpdatesForNewRoute(*entry, route, willCaptureBeTurnedOn);
111 }
112 else {
113 // Route already exists
114 RibEntry entryCopy = *entry;
115
Davide Pesavento412c9822021-07-02 00:21:05 -0400116 Route& routeToUpdate = *entryCopy.findRoute(route);
Vince Lehman76c751c2014-11-18 17:36:38 -0600117 routeToUpdate.flags = route.flags;
118 routeToUpdate.cost = route.cost;
119 routeToUpdate.expires = route.expires;
120
121 createFibUpdatesForUpdatedRoute(entryCopy, route, *existingRoute);
122 }
123 }
124 else {
125 // New name in RIB
126 // Find prefix's parent
127 shared_ptr<RibEntry> parent = m_rib.findParent(prefix);
128
129 Rib::RibEntryList descendants = m_rib.findDescendantsForNonInsertedName(prefix);
130 Rib::RibEntryList children;
131
132 for (const auto& descendant : descendants) {
133 // If the child has the same parent as the new entry,
134 // the new entry must be the child's new parent
135 if (descendant->getParent() == parent) {
136 children.push_back(descendant);
137 }
138 }
139
140 createFibUpdatesForNewRibEntry(prefix, route, children);
141 }
142}
143
144void
145FibUpdater::computeUpdatesForUnregistration(const RibUpdate& update)
146{
147 const Name& prefix = update.getName();
148 const Route& route = update.getRoute();
149
Davide Pesavento412c9822021-07-02 00:21:05 -0400150 auto ribIt = m_rib.find(prefix);
Vince Lehman76c751c2014-11-18 17:36:38 -0600151
152 // Name prefix exists
153 if (ribIt != m_rib.end()) {
154 shared_ptr<const RibEntry> entry(ribIt->second);
Vince Lehman76c751c2014-11-18 17:36:38 -0600155 const bool hadCapture = entry->hasCapture();
156
Davide Pesavento412c9822021-07-02 00:21:05 -0400157 auto existing = entry->findRoute(route);
Vince Lehman76c751c2014-11-18 17:36:38 -0600158 if (existing != entry->end()) {
159 RibEntry temp = *entry;
160
161 // Erase route in temp entry
162 temp.eraseRoute(route);
163
164 const bool captureWasTurnedOff = (hadCapture && !temp.hasCapture());
165
166 createFibUpdatesForErasedRoute(temp, *existing, captureWasTurnedOff);
167
168 // The RibEntry still has the face ID; need to update FIB
169 // with lowest cost for the same face instead of removing the face from the FIB
170 const Route* next = entry->getRouteWithSecondLowestCostByFaceId(route.faceId);
171
172 if (next != nullptr) {
173 createFibUpdatesForNewRoute(temp, *next, false);
174 }
175
176 // The RibEntry will be empty after this removal
177 if (entry->getNRoutes() == 1) {
178 createFibUpdatesForErasedRibEntry(*entry);
179 }
180 }
181 }
182}
183
184void
185FibUpdater::sendUpdates(const FibUpdateList& updates,
186 const FibUpdateSuccessCallback& onSuccess,
187 const FibUpdateFailureCallback& onFailure)
188{
189 std::string updateString = (updates.size() == 1) ? " update" : " updates";
190 NFD_LOG_DEBUG("Applying " << updates.size() << updateString << " to FIB");
191
192 for (const FibUpdate& update : updates) {
193 NFD_LOG_DEBUG("Sending FIB update: " << update);
194
195 if (update.action == FibUpdate::ADD_NEXTHOP) {
196 sendAddNextHopUpdate(update, onSuccess, onFailure);
197 }
198 else if (update.action == FibUpdate::REMOVE_NEXTHOP) {
199 sendRemoveNextHopUpdate(update, onSuccess, onFailure);
200 }
201 }
202}
203
204void
205FibUpdater::sendUpdatesForBatchFaceId(const FibUpdateSuccessCallback& onSuccess,
206 const FibUpdateFailureCallback& onFailure)
207{
208 if (m_updatesForBatchFaceId.size() > 0) {
209 sendUpdates(m_updatesForBatchFaceId, onSuccess, onFailure);
210 }
211 else {
212 sendUpdatesForNonBatchFaceId(onSuccess, onFailure);
213 }
214}
215
216void
217FibUpdater::sendUpdatesForNonBatchFaceId(const FibUpdateSuccessCallback& onSuccess,
218 const FibUpdateFailureCallback& onFailure)
219{
220 if (m_updatesForNonBatchFaceId.size() > 0) {
221 sendUpdates(m_updatesForNonBatchFaceId, onSuccess, onFailure);
222 }
223 else {
224 onSuccess(m_inheritedRoutes);
225 }
226}
227
228void
229FibUpdater::sendAddNextHopUpdate(const FibUpdate& update,
230 const FibUpdateSuccessCallback& onSuccess,
231 const FibUpdateFailureCallback& onFailure,
232 uint32_t nTimeouts)
233{
234 m_controller.start<ndn::nfd::FibAddNextHopCommand>(
235 ControlParameters()
236 .setName(update.name)
237 .setFaceId(update.faceId)
238 .setCost(update.cost),
Davide Pesavento412c9822021-07-02 00:21:05 -0400239 [=] (const auto&) { onUpdateSuccess(update, onSuccess, onFailure); },
240 [=] (const auto& resp) { onUpdateError(update, onSuccess, onFailure, resp, nTimeouts); });
Vince Lehman76c751c2014-11-18 17:36:38 -0600241}
242
243void
244FibUpdater::sendRemoveNextHopUpdate(const FibUpdate& update,
245 const FibUpdateSuccessCallback& onSuccess,
246 const FibUpdateFailureCallback& onFailure,
247 uint32_t nTimeouts)
248{
249 m_controller.start<ndn::nfd::FibRemoveNextHopCommand>(
250 ControlParameters()
251 .setName(update.name)
252 .setFaceId(update.faceId),
Davide Pesavento412c9822021-07-02 00:21:05 -0400253 [=] (const auto&) { onUpdateSuccess(update, onSuccess, onFailure); },
254 [=] (const auto& resp) { onUpdateError(update, onSuccess, onFailure, resp, nTimeouts); });
Vince Lehman76c751c2014-11-18 17:36:38 -0600255}
256
257void
Davide Pesavento412c9822021-07-02 00:21:05 -0400258FibUpdater::onUpdateSuccess(const FibUpdate& update,
Vince Lehman76c751c2014-11-18 17:36:38 -0600259 const FibUpdateSuccessCallback& onSuccess,
260 const FibUpdateFailureCallback& onFailure)
261{
262 if (update.faceId == m_batchFaceId) {
263 m_updatesForBatchFaceId.remove(update);
264
265 if (m_updatesForBatchFaceId.size() == 0) {
266 sendUpdatesForNonBatchFaceId(onSuccess, onFailure);
267 }
268 }
269 else {
270 m_updatesForNonBatchFaceId.remove(update);
271
272 if (m_updatesForNonBatchFaceId.size() == 0) {
273 onSuccess(m_inheritedRoutes);
274 }
275 }
276}
277
278void
Davide Pesavento412c9822021-07-02 00:21:05 -0400279FibUpdater::onUpdateError(const FibUpdate& update,
Vince Lehman76c751c2014-11-18 17:36:38 -0600280 const FibUpdateSuccessCallback& onSuccess,
281 const FibUpdateFailureCallback& onFailure,
Junxiao Shi29b41282016-08-22 03:47:02 +0000282 const ndn::nfd::ControlResponse& response, uint32_t nTimeouts)
Vince Lehman76c751c2014-11-18 17:36:38 -0600283{
Junxiao Shi29b41282016-08-22 03:47:02 +0000284 uint32_t code = response.getCode();
285 NFD_LOG_DEBUG("Failed to apply " << update <<
286 " (code: " << code << ", error: " << response.getText() << ")");
Vince Lehman76c751c2014-11-18 17:36:38 -0600287
288 if (code == ndn::nfd::Controller::ERROR_TIMEOUT && nTimeouts < MAX_NUM_TIMEOUTS) {
289 sendAddNextHopUpdate(update, onSuccess, onFailure, ++nTimeouts);
290 }
291 else if (code == ERROR_FACE_NOT_FOUND) {
292 if (update.faceId == m_batchFaceId) {
Junxiao Shi29b41282016-08-22 03:47:02 +0000293 onFailure(code, response.getText());
Vince Lehman76c751c2014-11-18 17:36:38 -0600294 }
295 else {
296 m_updatesForNonBatchFaceId.remove(update);
297
298 if (m_updatesForNonBatchFaceId.size() == 0) {
299 onSuccess(m_inheritedRoutes);
300 }
301 }
302 }
303 else {
Davide Pesavento19779d82019-02-14 13:40:04 -0500304 NDN_THROW(Error("Non-recoverable error: " + response.getText() + " code: " + to_string(code)));
Vince Lehman76c751c2014-11-18 17:36:38 -0600305 }
306}
307
308void
Davide Pesavento412c9822021-07-02 00:21:05 -0400309FibUpdater::addFibUpdate(const FibUpdate& update)
Vince Lehman76c751c2014-11-18 17:36:38 -0600310{
311 FibUpdateList& updates = (update.faceId == m_batchFaceId) ? m_updatesForBatchFaceId :
312 m_updatesForNonBatchFaceId;
313
Davide Pesavento412c9822021-07-02 00:21:05 -0400314 // If an update with the same name and route already exists, replace it
315 auto it = std::find_if(updates.begin(), updates.end(),
Vince Lehman76c751c2014-11-18 17:36:38 -0600316 [&update] (const FibUpdate& other) {
317 return update.name == other.name && update.faceId == other.faceId;
318 });
319
320 if (it != updates.end()) {
321 FibUpdate& existingUpdate = *it;
322 existingUpdate.action = update.action;
323 existingUpdate.cost = update.cost;
324 }
325 else {
326 updates.push_back(update);
327 }
328}
329
330void
Alexander Afanasyevb755e9d2015-10-20 17:35:51 -0500331FibUpdater::addInheritedRoutes(const RibEntry& entry, const Rib::RouteSet& routesToAdd)
Vince Lehman76c751c2014-11-18 17:36:38 -0600332{
333 for (const Route& route : routesToAdd) {
334 // Don't add an ancestor faceId if the namespace has an entry for that faceId
335 if (!entry.hasFaceId(route.faceId)) {
336 // Create a record of the inherited route so it can be added to the RIB later
337 addInheritedRoute(entry.getName(), route);
338
339 addFibUpdate(FibUpdate::createAddUpdate(entry.getName(), route.faceId, route.cost));
340 }
341 }
342}
343
344void
Alexander Afanasyevb755e9d2015-10-20 17:35:51 -0500345FibUpdater::addInheritedRoutes(const Name& name, const Rib::RouteSet& routesToAdd,
Vince Lehman76c751c2014-11-18 17:36:38 -0600346 const Route& ignore)
347{
348 for (const Route& route : routesToAdd) {
349 if (route.faceId != ignore.faceId) {
350 // Create a record of the inherited route so it can be added to the RIB later
351 addInheritedRoute(name, route);
352
353 addFibUpdate(FibUpdate::createAddUpdate(name, route.faceId, route.cost));
354 }
355 }
356}
357
358void
359FibUpdater::removeInheritedRoutes(const RibEntry& entry, const Rib::Rib::RouteSet& routesToRemove)
360{
361 for (const Route& route : routesToRemove) {
362 // Only remove if the route has been inherited
363 if (entry.hasInheritedRoute(route)) {
364 removeInheritedRoute(entry.getName(), route);
365 addFibUpdate(FibUpdate::createRemoveUpdate(entry.getName(), route.faceId));
366 }
367 }
368}
369
370void
371FibUpdater::createFibUpdatesForNewRibEntry(const Name& name, const Route& route,
372 const Rib::RibEntryList& children)
373{
374 // Create FIB update for new entry
375 addFibUpdate(FibUpdate::createAddUpdate(name, route.faceId, route.cost));
376
377 // No flags are set
Junxiao Shi3f21e582017-05-29 15:26:32 +0000378 if (!route.isChildInherit() && !route.isRibCapture()) {
Vince Lehman76c751c2014-11-18 17:36:38 -0600379 // Add ancestor routes to self
380 addInheritedRoutes(name, m_rib.getAncestorRoutes(name), route);
381 }
Junxiao Shi3f21e582017-05-29 15:26:32 +0000382 else if (route.isChildInherit() && route.isRibCapture()) {
Vince Lehman76c751c2014-11-18 17:36:38 -0600383 // Add route to children
384 Rib::RouteSet routesToAdd;
385 routesToAdd.insert(route);
386
387 // Remove routes blocked by capture and add self to children
388 modifyChildrensInheritedRoutes(children, routesToAdd, m_rib.getAncestorRoutes(name));
389 }
390 else if (route.isChildInherit()) {
391 Rib::RouteSet ancestorRoutes = m_rib.getAncestorRoutes(name);
392
393 // Add ancestor routes to self
394 addInheritedRoutes(name, ancestorRoutes, route);
395
396 // If there is an ancestor route which is the same as the new route, replace it
397 // with the new route
Davide Pesavento412c9822021-07-02 00:21:05 -0400398 auto it = ancestorRoutes.find(route);
Vince Lehman76c751c2014-11-18 17:36:38 -0600399
400 // There is a route that needs to be overwritten, erase and then replace
401 if (it != ancestorRoutes.end()) {
402 ancestorRoutes.erase(it);
403 }
404
405 // Add new route to ancestor list so it can be added to children
406 ancestorRoutes.insert(route);
407
408 // Add ancestor routes to children
409 modifyChildrensInheritedRoutes(children, ancestorRoutes, Rib::RouteSet());
410 }
Junxiao Shi3f21e582017-05-29 15:26:32 +0000411 else if (route.isRibCapture()) {
Vince Lehman76c751c2014-11-18 17:36:38 -0600412 // Remove routes blocked by capture
413 modifyChildrensInheritedRoutes(children, Rib::RouteSet(), m_rib.getAncestorRoutes(name));
414 }
415}
416
417void
418FibUpdater::createFibUpdatesForNewRoute(const RibEntry& entry, const Route& route,
419 bool captureWasTurnedOn)
420{
421 // Only update if the new route has a lower cost than a previously installed route
Vince Lehman9dcfc402015-03-26 03:18:54 -0500422 const Route* prevRoute = entry.getRouteWithLowestCostAndChildInheritByFaceId(route.faceId);
Vince Lehman76c751c2014-11-18 17:36:38 -0600423
424 Rib::RouteSet routesToAdd;
425 if (route.isChildInherit()) {
426 // Add to children if this new route doesn't override a previous lower cost, or
427 // add to children if this new route is lower cost than a previous route.
428 // Less than equal, since entry may find this route
Vince Lehman9dcfc402015-03-26 03:18:54 -0500429 if (prevRoute == nullptr || route.cost <= prevRoute->cost) {
Vince Lehman76c751c2014-11-18 17:36:38 -0600430 // Add self to children
431 routesToAdd.insert(route);
432 }
433 }
434
435 Rib::RouteSet routesToRemove;
436 if (captureWasTurnedOn) {
437 // Capture flag on
438 routesToRemove = m_rib.getAncestorRoutes(entry);
439
440 // Remove ancestor routes from self
441 removeInheritedRoutes(entry, routesToRemove);
442 }
443
444 modifyChildrensInheritedRoutes(entry.getChildren(), routesToAdd, routesToRemove);
445
446 // If another route with same faceId and lower cost exists, don't update.
447 // Must be done last so that add updates replace removal updates
448 // Create FIB update for new entry
Vince Lehman9dcfc402015-03-26 03:18:54 -0500449 const Route* other = entry.getRouteWithLowestCostByFaceId(route.faceId);
Vince Lehman76c751c2014-11-18 17:36:38 -0600450
Vince Lehman9dcfc402015-03-26 03:18:54 -0500451 if (other == nullptr || route.cost <= other->cost) {
Vince Lehman76c751c2014-11-18 17:36:38 -0600452 addFibUpdate(FibUpdate::createAddUpdate(entry.getName(), route.faceId, route.cost));
453 }
454}
455
456void
457FibUpdater::createFibUpdatesForUpdatedRoute(const RibEntry& entry, const Route& route,
458 const Route& existingRoute)
459{
460 const bool costDidChange = (route.cost != existingRoute.cost);
461
462 // Look for an installed route with the lowest cost and child inherit set
Vince Lehman9dcfc402015-03-26 03:18:54 -0500463 const Route* prevRoute = entry.getRouteWithLowestCostAndChildInheritByFaceId(route.faceId);
Vince Lehman76c751c2014-11-18 17:36:38 -0600464
465 // No flags changed and cost didn't change, no change in FIB
466 if (route.flags == existingRoute.flags && !costDidChange) {
467 return;
468 }
469
470 // Cost changed so create update for the entry itself
471 if (costDidChange) {
472 // Create update if this route's cost is lower than other routes
473 if (route.cost <= entry.getRouteWithLowestCostByFaceId(route.faceId)->cost) {
474 // Create FIB update for the updated entry
475 addFibUpdate(FibUpdate::createAddUpdate(entry.getName(), route.faceId, route.cost));
476 }
477 else if (existingRoute.cost < entry.getRouteWithLowestCostByFaceId(route.faceId)->cost) {
478 // Create update if this route used to be the lowest route but is no longer
479 // the lowest cost route.
480 addFibUpdate(FibUpdate::createAddUpdate(entry.getName(), prevRoute->faceId, prevRoute->cost));
481 }
482
483 // If another route with same faceId and lower cost and ChildInherit exists,
484 // don't update children.
Vince Lehman9dcfc402015-03-26 03:18:54 -0500485 if (prevRoute == nullptr || route.cost <= prevRoute->cost) {
Vince Lehman76c751c2014-11-18 17:36:38 -0600486 // If no flags changed but child inheritance is set, need to update children
487 // with new cost
488 if ((route.flags == existingRoute.flags) && route.isChildInherit()) {
489 // Add self to children
490 Rib::RouteSet routesToAdd;
491 routesToAdd.insert(route);
492 modifyChildrensInheritedRoutes(entry.getChildren(), routesToAdd, Rib::RouteSet());
493
494 return;
495 }
496 }
497 }
498
499 // Child inherit was turned on
500 if (!existingRoute.isChildInherit() && route.isChildInherit()) {
501 // If another route with same faceId and lower cost and ChildInherit exists,
502 // don't update children.
Vince Lehman9dcfc402015-03-26 03:18:54 -0500503 if (prevRoute == nullptr || route.cost <= prevRoute->cost) {
Vince Lehman76c751c2014-11-18 17:36:38 -0600504 // Add self to children
505 Rib::RouteSet routesToAdd;
506 routesToAdd.insert(route);
507 modifyChildrensInheritedRoutes(entry.getChildren(), routesToAdd, Rib::RouteSet());
508 }
509 } // Child inherit was turned off
510 else if (existingRoute.isChildInherit() && !route.isChildInherit()) {
511 // Remove self from children
512 Rib::RouteSet routesToRemove;
513 routesToRemove.insert(route);
514
515 Rib::RouteSet routesToAdd;
516 // If another route with same faceId and ChildInherit exists, update children with this route.
Vince Lehman9dcfc402015-03-26 03:18:54 -0500517 if (prevRoute != nullptr) {
Vince Lehman76c751c2014-11-18 17:36:38 -0600518 routesToAdd.insert(*prevRoute);
519 }
520 else {
521 // Look for an ancestor that was blocked previously
522 const Rib::RouteSet ancestorRoutes = m_rib.getAncestorRoutes(entry);
Davide Pesavento412c9822021-07-02 00:21:05 -0400523 auto it = ancestorRoutes.find(route);
Vince Lehman76c751c2014-11-18 17:36:38 -0600524
525 // If an ancestor is found, add it to children
526 if (it != ancestorRoutes.end()) {
527 routesToAdd.insert(*it);
528 }
529 }
530
531 modifyChildrensInheritedRoutes(entry.getChildren(), routesToAdd, routesToRemove);
532 }
533
534 // Capture was turned on
Junxiao Shi3f21e582017-05-29 15:26:32 +0000535 if (!existingRoute.isRibCapture() && route.isRibCapture()) {
Vince Lehman76c751c2014-11-18 17:36:38 -0600536 Rib::RouteSet ancestorRoutes = m_rib.getAncestorRoutes(entry);
537
538 // Remove ancestor routes from self
539 removeInheritedRoutes(entry, ancestorRoutes);
540
541 // Remove ancestor routes from children
542 modifyChildrensInheritedRoutes(entry.getChildren(), Rib::RouteSet(), ancestorRoutes);
543 } // Capture was turned off
Junxiao Shi3f21e582017-05-29 15:26:32 +0000544 else if (existingRoute.isRibCapture() && !route.isRibCapture()) {
Vince Lehman76c751c2014-11-18 17:36:38 -0600545 Rib::RouteSet ancestorRoutes = m_rib.getAncestorRoutes(entry);
546
547 // Add ancestor routes to self
548 addInheritedRoutes(entry, ancestorRoutes);
549
550 // Add ancestor routes to children
551 modifyChildrensInheritedRoutes(entry.getChildren(), ancestorRoutes, Rib::RouteSet());
552 }
553}
554
555void
556FibUpdater::createFibUpdatesForErasedRoute(const RibEntry& entry, const Route& route,
Davide Pesaventoaa9e3b22022-10-21 17:00:07 -0400557 bool captureWasTurnedOff)
Vince Lehman76c751c2014-11-18 17:36:38 -0600558{
559 addFibUpdate(FibUpdate::createRemoveUpdate(entry.getName(), route.faceId));
560
Junxiao Shi3f21e582017-05-29 15:26:32 +0000561 if (route.isChildInherit() && route.isRibCapture()) {
Vince Lehman76c751c2014-11-18 17:36:38 -0600562 // Remove self from children
563 Rib::RouteSet routesToRemove;
564 routesToRemove.insert(route);
565
Vince Lehman9aac8732016-01-11 15:49:23 -0600566 // If capture is turned off for the route and another route is installed in the RibEntry,
567 // add ancestors to self
Vince Lehman76c751c2014-11-18 17:36:38 -0600568 Rib::RouteSet routesToAdd;
Vince Lehman9aac8732016-01-11 15:49:23 -0600569 if (captureWasTurnedOff && entry.getNRoutes() != 0) {
Vince Lehman76c751c2014-11-18 17:36:38 -0600570 // Look for an ancestors that were blocked previously
571 routesToAdd = m_rib.getAncestorRoutes(entry);
572
573 // Add ancestor routes to self
574 addInheritedRoutes(entry, routesToAdd);
575 }
576
577 modifyChildrensInheritedRoutes(entry.getChildren(), routesToAdd, routesToRemove);
578 }
579 else if (route.isChildInherit()) {
580 // If not blocked by capture, add inherited routes to children
581 Rib::RouteSet routesToAdd;
582 if (!entry.hasCapture()) {
583 routesToAdd = m_rib.getAncestorRoutes(entry);
584 }
585
586 Rib::RouteSet routesToRemove;
587 routesToRemove.insert(route);
588
589 // Add ancestor routes to children
590 modifyChildrensInheritedRoutes(entry.getChildren(), routesToAdd, routesToRemove);
591 }
Junxiao Shi3f21e582017-05-29 15:26:32 +0000592 else if (route.isRibCapture()) {
Vince Lehman9aac8732016-01-11 15:49:23 -0600593 // If capture is turned off for the route and another route is installed in the RibEntry,
594 // add ancestors to self
Vince Lehman76c751c2014-11-18 17:36:38 -0600595 Rib::RouteSet routesToAdd;
Vince Lehman9aac8732016-01-11 15:49:23 -0600596 if (captureWasTurnedOff && entry.getNRoutes() != 0) {
Vince Lehman76c751c2014-11-18 17:36:38 -0600597 // Look for an ancestors that were blocked previously
598 routesToAdd = m_rib.getAncestorRoutes(entry);
599
600 // Add ancestor routes to self
601 addInheritedRoutes(entry, routesToAdd);
602 }
603
604 modifyChildrensInheritedRoutes(entry.getChildren(), routesToAdd, Rib::RouteSet());
605 }
606
607 // Need to check if the removed route was blocking an inherited route
608 Rib::RouteSet ancestorRoutes = m_rib.getAncestorRoutes(entry);
609
Vince Lehmanf91ab742015-04-23 15:26:55 -0500610 // If the current entry has capture set or is pending removal, don't add inherited route
611 if (!entry.hasCapture() && entry.getNRoutes() != 0) {
Vince Lehman76c751c2014-11-18 17:36:38 -0600612 // If there is an ancestor route which is the same as the erased route, add that route
613 // to the current entry
Davide Pesavento412c9822021-07-02 00:21:05 -0400614 auto it = ancestorRoutes.find(route);
Vince Lehman76c751c2014-11-18 17:36:38 -0600615
616 if (it != ancestorRoutes.end()) {
617 addInheritedRoute(entry.getName(), *it);
618 addFibUpdate(FibUpdate::createAddUpdate(entry.getName(), it->faceId, it->cost));
619 }
620 }
621}
622
623void
624FibUpdater::createFibUpdatesForErasedRibEntry(const RibEntry& entry)
625{
626 for (const Route& route : entry.getInheritedRoutes()) {
627 addFibUpdate(FibUpdate::createRemoveUpdate(entry.getName(), route.faceId));
628 }
629}
630
631void
632FibUpdater::modifyChildrensInheritedRoutes(const Rib::RibEntryList& children,
633 const Rib::RouteSet& routesToAdd,
634 const Rib::RouteSet& routesToRemove)
635{
636 for (const auto& child : children) {
637 traverseSubTree(*child, routesToAdd, routesToRemove);
638 }
639}
640
641void
642FibUpdater::traverseSubTree(const RibEntry& entry, Rib::Rib::RouteSet routesToAdd,
643 Rib::Rib::RouteSet routesToRemove)
644{
645 // If a route on the namespace has the capture flag set, ignore self and children
646 if (entry.hasCapture()) {
647 return;
648 }
649
650 // Remove inherited routes from current namespace
Davide Pesaventoe4b22382018-06-10 14:37:24 -0400651 for (auto removeIt = routesToRemove.begin(); removeIt != routesToRemove.end(); ) {
Vince Lehman76c751c2014-11-18 17:36:38 -0600652 // If a route on the namespace has the same face ID and child inheritance set,
653 // ignore this route
654 if (entry.hasChildInheritOnFaceId(removeIt->faceId)) {
Davide Pesaventoe4b22382018-06-10 14:37:24 -0400655 removeIt = routesToRemove.erase(removeIt);
Vince Lehman76c751c2014-11-18 17:36:38 -0600656 continue;
657 }
658
659 // Only remove route if it removes an existing inherited route
660 if (entry.hasInheritedRoute(*removeIt)) {
661 removeInheritedRoute(entry.getName(), *removeIt);
662 addFibUpdate(FibUpdate::createRemoveUpdate(entry.getName(), removeIt->faceId));
663 }
664
665 ++removeIt;
666 }
667
668 // Add inherited routes to current namespace
Davide Pesaventoe4b22382018-06-10 14:37:24 -0400669 for (auto addIt = routesToAdd.begin(); addIt != routesToAdd.end(); ) {
Vince Lehman76c751c2014-11-18 17:36:38 -0600670 // If a route on the namespace has the same face ID and child inherit set, ignore this face
671 if (entry.hasChildInheritOnFaceId(addIt->faceId)) {
Davide Pesaventoe4b22382018-06-10 14:37:24 -0400672 addIt = routesToAdd.erase(addIt);
Vince Lehman76c751c2014-11-18 17:36:38 -0600673 continue;
674 }
675
676 // Only add route if it does not override an existing route
677 if (!entry.hasFaceId(addIt->faceId)) {
678 addInheritedRoute(entry.getName(), *addIt);
679 addFibUpdate(FibUpdate::createAddUpdate(entry.getName(), addIt->faceId, addIt->cost));
680 }
681
682 ++addIt;
683 }
684
685 modifyChildrensInheritedRoutes(entry.getChildren(), routesToAdd, routesToRemove);
686}
687
688void
689FibUpdater::addInheritedRoute(const Name& name, const Route& route)
690{
691 RibUpdate update;
692 update.setAction(RibUpdate::REGISTER)
693 .setName(name)
694 .setRoute(route);
695
696 m_inheritedRoutes.push_back(update);
697}
698
699void
700FibUpdater::removeInheritedRoute(const Name& name, const Route& route)
701{
702 RibUpdate update;
703 update.setAction(RibUpdate::UNREGISTER)
704 .setName(name)
705 .setRoute(route);
706
707 m_inheritedRoutes.push_back(update);
708}
709
Davide Pesaventoe422f9e2022-06-03 01:30:23 -0400710} // namespace nfd::rib