nlsr.cpp
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2014-2023, The University of Memphis,
4  * Regents of the University of California,
5  * Arizona Board of Regents.
6  *
7  * This file is part of NLSR (Named-data Link State Routing).
8  * See AUTHORS.md for complete list of NLSR authors and contributors.
9  *
10  * NLSR is free software: you can redistribute it and/or modify it under the terms
11  * of the GNU General Public License as published by the Free Software Foundation,
12  * either version 3 of the License, or (at your option) any later version.
13  *
14  * NLSR is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
15  * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
16  * PURPOSE. See the GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License along with
19  * NLSR, e.g., in COPYING.md file. If not, see <http://www.gnu.org/licenses/>.
20  */
21 
22 #include "nlsr.hpp"
23 #include "adjacent.hpp"
24 #include "logger.hpp"
25 
26 #include <cstdlib>
27 #include <cstdio>
28 #include <unistd.h>
29 
30 #include <ndn-cxx/mgmt/nfd/status-dataset.hpp>
31 #include <ndn-cxx/net/face-uri.hpp>
32 
33 namespace nlsr {
34 
35 INIT_LOGGER(Nlsr);
36 
37 Nlsr::Nlsr(ndn::Face& face, ndn::KeyChain& keyChain, ConfParameter& confParam)
38  : m_face(face)
39  , m_scheduler(face.getIoContext())
40  , m_confParam(confParam)
41  , m_adjacencyList(confParam.getAdjacencyList())
42  , m_namePrefixList(confParam.getNamePrefixList())
43  , m_fib(m_face, m_scheduler, m_adjacencyList, m_confParam, keyChain)
44  , m_lsdb(m_face, keyChain, m_confParam)
45  , m_routingTable(m_scheduler, m_lsdb, m_confParam)
46  , m_namePrefixTable(confParam.getRouterPrefix(), m_fib, m_routingTable,
47  m_routingTable.afterRoutingChange, m_lsdb.onLsdbModified)
48  , m_helloProtocol(m_face, keyChain, confParam, m_routingTable, m_lsdb)
49  , m_onNewLsaConnection(m_lsdb.getSync().onNewLsa.connect(
50  [this] (const ndn::Name& updateName, uint64_t sequenceNumber,
51  const ndn::Name& originRouter, uint64_t incomingFaceId) {
52  registerStrategyForCerts(originRouter);
53  }))
54  , m_onPrefixRegistrationSuccess(m_fib.onPrefixRegistrationSuccess.connect(
55  [this] (const ndn::Name& name) {
56  m_helloProtocol.sendHelloInterest(name);
57  }))
58  , m_onInitialHelloDataValidated(m_helloProtocol.onInitialHelloDataValidated.connect(
59  [this] (const ndn::Name& neighbor) {
60  auto it = m_adjacencyList.findAdjacent(neighbor);
61  if (it != m_adjacencyList.end()) {
62  m_fib.registerPrefix(m_confParam.getSyncPrefix(), it->getFaceUri(), it->getLinkCost(),
63  ndn::time::milliseconds::max(), ndn::nfd::ROUTE_FLAG_CAPTURE, 0);
64  }
65  }))
66  , m_dispatcher(m_face, keyChain)
67  , m_datasetHandler(m_dispatcher, m_lsdb, m_routingTable)
68  , m_controller(m_face, keyChain)
69  , m_faceDatasetController(m_face, keyChain)
70  , m_prefixUpdateProcessor(m_dispatcher,
71  m_confParam.getPrefixUpdateValidator(),
72  m_namePrefixList,
73  m_lsdb,
74  m_confParam.getConfFileNameDynamic())
75  , m_nfdRibCommandProcessor(m_dispatcher,
76  m_namePrefixList,
77  m_lsdb)
78  , m_statsCollector(m_lsdb, m_helloProtocol)
79  , m_faceMonitor(m_face)
80 {
81  NLSR_LOG_DEBUG("Initializing Nlsr");
82 
83  m_faceMonitor.onNotification.connect(std::bind(&Nlsr::onFaceEventNotification, this, _1));
84  m_faceMonitor.start();
85 
86  m_fib.setStrategy(m_confParam.getLsaPrefix(), Fib::MULTICAST_STRATEGY, 0);
87  m_fib.setStrategy(m_confParam.getSyncPrefix(), Fib::MULTICAST_STRATEGY, 0);
88 
89  NLSR_LOG_DEBUG("Default NLSR identity: " << m_confParam.getSigningInfo().getSignerName());
90 
91  // Add top-level prefixes: router and localhost prefix
92  addDispatcherTopPrefix(ndn::Name(m_confParam.getRouterPrefix()).append("nlsr"));
93  addDispatcherTopPrefix(LOCALHOST_PREFIX);
94 
95  enableIncomingFaceIdIndication();
96 
97  initializeFaces(std::bind(&Nlsr::processFaceDataset, this, _1),
98  std::bind(&Nlsr::onFaceDatasetFetchTimeout, this, _1, _2, 0));
99 
100  m_adjacencyList.writeLog();
101  NLSR_LOG_DEBUG(m_namePrefixList);
102 
103  // Need to set direct neighbors' costs to 0 for hyperbolic routing
104  if (m_confParam.getHyperbolicState() == HYPERBOLIC_STATE_ON) {
105  for (auto&& neighbor : m_adjacencyList.getAdjList()) {
106  neighbor.setLinkCost(0);
107  }
108  }
109 }
110 
111 void
112 Nlsr::registerStrategyForCerts(const ndn::Name& originRouter)
113 {
114  for (const ndn::Name& router : m_strategySetOnRouters) {
115  if (router == originRouter) {
116  // Have already set strategy for this router's certs once
117  return;
118  }
119  }
120 
121  m_strategySetOnRouters.push_back(originRouter);
122 
123  ndn::Name routerKey(originRouter);
124  routerKey.append(ndn::security::Certificate::KEY_COMPONENT);
125  ndn::Name instanceKey(originRouter);
126  instanceKey.append("nlsr").append(ndn::security::Certificate::KEY_COMPONENT);
127 
128  m_fib.setStrategy(routerKey, Fib::BEST_ROUTE_STRATEGY, 0);
129  m_fib.setStrategy(instanceKey, Fib::BEST_ROUTE_STRATEGY, 0);
130 
131  ndn::Name siteKey;
132  for (size_t i = 0; i < originRouter.size(); ++i) {
133  if (originRouter[i].toUri() == "%C1.Router") {
134  break;
135  }
136  siteKey.append(originRouter[i]);
137  }
138  ndn::Name opPrefix(siteKey);
139  siteKey.append(ndn::security::Certificate::KEY_COMPONENT);
140  m_fib.setStrategy(siteKey, Fib::BEST_ROUTE_STRATEGY, 0);
141 
142  opPrefix.append(std::string("%C1.Operator"));
143  m_fib.setStrategy(opPrefix, Fib::BEST_ROUTE_STRATEGY, 0);
144 }
145 
146 void
147 Nlsr::addDispatcherTopPrefix(const ndn::Name& topPrefix)
148 {
149  registerPrefix(topPrefix);
150  try {
151  // false since we want to have control over the registration process
152  m_dispatcher.addTopPrefix(topPrefix, false, m_confParam.getSigningInfo());
153  }
154  catch (const std::exception& e) {
155  NLSR_LOG_ERROR("Error setting top-level prefix in dispatcher: " << e.what());
156  }
157 }
158 
159 void
160 Nlsr::registerPrefix(const ndn::Name& prefix)
161 {
162  m_face.registerPrefix(prefix,
163  [] (const ndn::Name& name) {
164  NLSR_LOG_DEBUG("Successfully registered prefix: " << name);
165  },
166  [] (const ndn::Name& name, const std::string& reason) {
167  NLSR_LOG_ERROR("ERROR: Failed to register prefix " << name << " in local hub's daemon");
168  NDN_THROW(Error("Error: Prefix registration failed: " + reason));
169  });
170 }
171 
172 void
173 Nlsr::onFaceEventNotification(const ndn::nfd::FaceEventNotification& faceEventNotification)
174 {
175  NLSR_LOG_TRACE("onFaceEventNotification called");
176 
177  switch (faceEventNotification.getKind()) {
178  case ndn::nfd::FACE_EVENT_DESTROYED: {
179  uint64_t faceId = faceEventNotification.getFaceId();
180 
181  auto adjacent = m_adjacencyList.findAdjacent(faceId);
182 
183  if (adjacent != m_adjacencyList.end()) {
184  NLSR_LOG_DEBUG("Face to " << adjacent->getName() << " with face id: " << faceId << " destroyed");
185 
186  adjacent->setFaceId(0);
187 
188  // Only trigger an Adjacency LSA build if this node is changing
189  // from ACTIVE to INACTIVE since this rebuild will effectively
190  // cancel the previous Adjacency LSA refresh event and schedule
191  // a new one further in the future.
192  //
193  // Continuously scheduling the refresh in the future will block
194  // the router from refreshing its Adjacency LSA. Since other
195  // routers' Name prefixes' expiration times are updated when
196  // this router refreshes its Adjacency LSA, the other routers'
197  // prefixes will expire and be removed from the RIB.
198  //
199  // This check is required to fix Bug #2733 for now. This check
200  // would be unnecessary to fix Bug #2733 when Issue #2732 is
201  // completed, but the check also helps with optimization so it
202  // can remain even when Issue #2732 is implemented.
203  if (adjacent->getStatus() == Adjacent::STATUS_ACTIVE) {
204  adjacent->setStatus(Adjacent::STATUS_INACTIVE);
205 
206  // A new adjacency LSA cannot be built until the neighbor is marked INACTIVE and
207  // has met the HELLO retry threshold
208  adjacent->setInterestTimedOutNo(m_confParam.getInterestRetryNumber());
209 
210  if (m_confParam.getHyperbolicState() == HYPERBOLIC_STATE_ON) {
211  m_routingTable.scheduleRoutingTableCalculation();
212  }
213  else {
214  // Will call scheduleRoutingTableCalculation internally
215  // if needed in case of LS or DRY_RUN
216  m_lsdb.scheduleAdjLsaBuild();
217  }
218  }
219  }
220  break;
221  }
222  case ndn::nfd::FACE_EVENT_CREATED: {
223  // Find the neighbor in our adjacency list
224  ndn::FaceUri faceUri;
225  try {
226  faceUri = ndn::FaceUri(faceEventNotification.getRemoteUri());
227  }
228  catch (const std::exception& e) {
229  NLSR_LOG_WARN(e.what());
230  return;
231  }
232  auto adjacent = m_adjacencyList.findAdjacent(faceUri);
233  uint64_t faceId = faceEventNotification.getFaceId();
234 
235  // If we have a neighbor by that FaceUri and it has no FaceId or
236  // the FaceId is different from ours, we have a match.
237  if (adjacent != m_adjacencyList.end() &&
238  (adjacent->getFaceId() == 0 || adjacent->getFaceId() != faceId))
239  {
240  NLSR_LOG_DEBUG("Face creation event matches neighbor: " << adjacent->getName()
241  << ". New Face ID: " << faceId << ". Registering prefixes.");
242  adjacent->setFaceId(faceId);
243 
244  registerAdjacencyPrefixes(*adjacent, ndn::time::milliseconds::max());
245 
246  // We should not do scheduleRoutingTableCalculation or scheduleAdjLsaBuild here
247  // because once the prefixes are registered, we send a HelloInterest
248  // to the prefix (see NLSR ctor). HelloProtocol will call these functions
249  // once HelloData is received and validated.
250  }
251  break;
252  }
253  default:
254  break;
255  }
256 }
257 
258 void
259 Nlsr::initializeFaces(const FetchDatasetCallback& onFetchSuccess,
260  const FetchDatasetTimeoutCallback& onFetchFailure)
261 {
262  NLSR_LOG_TRACE("Initializing faces");
263  m_faceDatasetController.fetch<ndn::nfd::FaceDataset>(onFetchSuccess, onFetchFailure);
264 }
265 
266 void
267 Nlsr::processFaceDataset(const std::vector<ndn::nfd::FaceStatus>& faces)
268 {
269  NLSR_LOG_DEBUG("Processing face dataset");
270 
271  // Iterate over each neighbor listed in nlsr.conf
272  for (auto&& adjacent : m_adjacencyList.getAdjList()) {
273 
274  const std::string& faceUriString = adjacent.getFaceUri().toString();
275  // Check the list of FaceStatus objects we got for a match
276  for (const auto& faceStatus : faces) {
277  // Set the adjacency FaceID if we find a URI match and it was
278  // previously unset. Change the boolean to true.
279  if (adjacent.getFaceId() == 0 && faceUriString == faceStatus.getRemoteUri()) {
280  NLSR_LOG_DEBUG("FaceUri: " << faceStatus.getRemoteUri() <<
281  " FaceId: "<< faceStatus.getFaceId());
282  adjacent.setFaceId(faceStatus.getFaceId());
283  // Register the prefixes for each neighbor
284  this->registerAdjacencyPrefixes(adjacent, ndn::time::milliseconds::max());
285  }
286  }
287  // If this adjacency has no information in this dataset, then one
288  // of two things is happening: 1. NFD is starting slowly and this
289  // Face wasn't ready yet, or 2. NFD is configured
290  // incorrectly and this Face isn't available.
291  if (adjacent.getFaceId() == 0) {
292  NLSR_LOG_WARN("The adjacency " << adjacent.getName() <<
293  " has no Face information in this dataset.");
294  }
295  }
296 
297  scheduleDatasetFetch();
298 }
299 
300 void
301 Nlsr::registerAdjacencyPrefixes(const Adjacent& adj, ndn::time::milliseconds timeout)
302 {
303  ndn::FaceUri faceUri = adj.getFaceUri();
304  double linkCost = adj.getLinkCost();
305  const ndn::Name& adjName = adj.getName();
306 
307  m_fib.registerPrefix(adjName, faceUri, linkCost,
308  timeout, ndn::nfd::ROUTE_FLAG_CAPTURE, 0);
309 
310  m_fib.registerPrefix(m_confParam.getLsaPrefix(),
311  faceUri, linkCost, timeout,
312  ndn::nfd::ROUTE_FLAG_CAPTURE, 0);
313 }
314 
315 void
316 Nlsr::onFaceDatasetFetchTimeout(uint32_t code,
317  const std::string& msg,
318  uint32_t nRetriesSoFar)
319 {
320  // If we have exceeded the maximum attempt count, do not try again.
321  if (nRetriesSoFar++ < m_confParam.getFaceDatasetFetchTries()) {
322  NLSR_LOG_DEBUG("Failed to fetch dataset: " << msg << ". Attempting retry #" << nRetriesSoFar);
323  m_faceDatasetController.fetch<ndn::nfd::FaceDataset>(std::bind(&Nlsr::processFaceDataset, this, _1),
324  std::bind(&Nlsr::onFaceDatasetFetchTimeout,
325  this, _1, _2, nRetriesSoFar));
326  }
327  else {
328  NLSR_LOG_ERROR("Failed to fetch dataset: " << msg << ". Exceeded limit of " <<
329  m_confParam.getFaceDatasetFetchTries() << ", so not trying again this time.");
330  // If we fail to fetch it, just do nothing until the next
331  // interval. Since this is a backup mechanism, we aren't as
332  // concerned with retrying.
333  scheduleDatasetFetch();
334  }
335 }
336 
337 void
338 Nlsr::scheduleDatasetFetch()
339 {
340  NLSR_LOG_DEBUG("Scheduling dataset fetch in " << m_confParam.getFaceDatasetFetchInterval());
341 
342  m_scheduler.schedule(m_confParam.getFaceDatasetFetchInterval(), [this] {
343  initializeFaces(
344  [this] (const auto& faces) { processFaceDataset(faces); },
345  [this] (uint32_t code, const std::string& msg) { onFaceDatasetFetchTimeout(code, msg, 0); });
346  });
347 }
348 
349 void
350 Nlsr::enableIncomingFaceIdIndication()
351 {
352  NLSR_LOG_DEBUG("Enabling incoming face id indication for local face.");
353 
354  m_controller.start<ndn::nfd::FaceUpdateCommand>(
355  ndn::nfd::ControlParameters()
356  .setFlagBit(ndn::nfd::FaceFlagBit::BIT_LOCAL_FIELDS_ENABLED, true),
357  [] (const ndn::nfd::ControlParameters& cp) {
358  NLSR_LOG_DEBUG("Successfully enabled incoming face id indication"
359  << "for face id " << cp.getFaceId());
360  },
361  [] (const ndn::nfd::ControlResponse& cr) {
362  NLSR_LOG_WARN("Failed to enable incoming face id indication feature: " <<
363  "(code: " << cr.getCode() << ", reason: " << cr.getText() << ")");
364  });
365 }
366 
367 } // namespace nlsr
A class to house all the configuration parameters for NLSR.
Nlsr(ndn::Face &face, ndn::KeyChain &keyChain, ConfParameter &confParam)
Definition: nlsr.cpp:37
Copyright (c) 2014-2018, The University of Memphis, Regents of the University of California.
#define NLSR_LOG_DEBUG(x)
Definition: logger.hpp:38
#define INIT_LOGGER(name)
Definition: logger.hpp:35
#define NLSR_LOG_WARN(x)
Definition: logger.hpp:40
#define NLSR_LOG_ERROR(x)
Definition: logger.hpp:41
#define NLSR_LOG_TRACE(x)
Definition: logger.hpp:37
Copyright (c) 2014-2020, The University of Memphis, Regents of the University of California.
@ HYPERBOLIC_STATE_ON