blob: 77d2de68ec8628b7fb14a99f300f89cb0b1836c3 [file] [log] [blame]
akmhoque3d06e792014-05-27 16:23:20 -05001/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
Davide Pesaventoaf7a2112019-03-19 14:55:20 -04002/*
Junxiao Shib8752932024-01-07 15:18:46 +00003 * Copyright (c) 2014-2024, The University of Memphis,
Vince Lehmanc2e51f62015-01-20 15:03:11 -06004 * Regents of the University of California,
5 * Arizona Board of Regents.
akmhoque3d06e792014-05-27 16:23:20 -05006 *
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/>.
Ashlesh Gawande0421bc62020-05-08 20:42:19 -070020 */
Vince Lehmanc2e51f62015-01-20 15:03:11 -060021
akmhoque53353462014-04-22 08:43:45 -050022#include "lsdb.hpp"
Muktadir R Chowdhuryaa3b0852015-08-06 13:08:56 -050023
akmhoque674b0b12014-05-20 14:33:28 -050024#include "logger.hpp"
Muktadir R Chowdhuryaa3b0852015-08-06 13:08:56 -050025#include "nlsr.hpp"
Muktadir R Chowdhuryaa3b0852015-08-06 13:08:56 -050026#include "utility/name-helper.hpp"
27
Alexander Afanasyev135288c2022-04-23 23:06:56 -040028#include <ndn-cxx/lp/tags.hpp>
29
akmhoque53353462014-04-22 08:43:45 -050030namespace nlsr {
31
dmcoomescf8d0ed2017-02-21 11:39:01 -060032INIT_LOGGER(Lsdb);
akmhoque674b0b12014-05-20 14:33:28 -050033
Ashlesh Gawande5d93aa52020-06-13 18:57:45 -070034Lsdb::Lsdb(ndn::Face& face, ndn::KeyChain& keyChain, ConfParameter& confParam)
Ashlesh Gawande85998a12017-12-07 22:22:13 -060035 : m_face(face)
Davide Pesaventofd1e9402023-11-13 15:40:41 -050036 , m_scheduler(face.getIoContext())
Ashlesh Gawande85998a12017-12-07 22:22:13 -060037 , m_confParam(confParam)
Davide Pesavento1954a0c2022-09-30 15:56:04 -040038 , m_sync(m_face, keyChain,
Junxiao Shif4674672024-01-06 02:27:36 +000039 [this] (const auto& routerName, Lsa::Type lsaType, uint64_t seqNo, uint64_t) {
40 return isLsaNew(routerName, lsaType, seqNo);
41 },
42 SyncLogicOptions{
43 confParam.getSyncProtocol(),
44 confParam.getSyncPrefix(),
45 confParam.getSyncUserPrefix(),
46 confParam.getSyncInterestLifetime(),
47 confParam.getRouterPrefix(),
48 confParam.getHyperbolicState()
49 })
Ashlesh Gawande85998a12017-12-07 22:22:13 -060050 , m_lsaRefreshTime(ndn::time::seconds(m_confParam.getLsaRefreshTime()))
Ashlesh Gawande85998a12017-12-07 22:22:13 -060051 , m_adjLsaBuildInterval(m_confParam.getAdjLsaBuildInterval())
Ashlesh Gawande57a87172020-05-09 19:47:06 -070052 , m_thisRouterPrefix(m_confParam.getRouterPrefix())
dulalsaurab82a34c22019-02-04 17:31:21 +000053 , m_sequencingManager(m_confParam.getStateFileDir(), m_confParam.getHyperbolicState())
Davide Pesavento1954a0c2022-09-30 15:56:04 -040054 , m_onNewLsaConnection(m_sync.onNewLsa.connect(
Ashlesh Gawande08bce9c2019-04-05 11:08:07 -050055 [this] (const ndn::Name& updateName, uint64_t sequenceNumber,
Alexander Afanasyev135288c2022-04-23 23:06:56 -040056 const ndn::Name& originRouter, uint64_t incomingFaceId) {
Nick Gordon9eac4d92017-08-29 17:31:29 -050057 ndn::Name lsaInterest{updateName};
58 lsaInterest.appendNumber(sequenceNumber);
Alexander Afanasyev135288c2022-04-23 23:06:56 -040059 expressInterest(lsaInterest, 0, incomingFaceId);
Nick Gordon9eac4d92017-08-29 17:31:29 -050060 }))
Davide Pesavento65ee9922022-11-16 00:21:43 -050061 , m_segmenter(keyChain, m_confParam.getSigningInfo())
62 , m_segmentFifo(100)
Ashlesh Gawande5d93aa52020-06-13 18:57:45 -070063 , m_isBuildAdjLsaScheduled(false)
Ashlesh Gawande85998a12017-12-07 22:22:13 -060064 , m_adjBuildCount(0)
Muktadir R Chowdhuryaa3b0852015-08-06 13:08:56 -050065{
Ashlesh Gawande5d93aa52020-06-13 18:57:45 -070066 ndn::Name name = m_confParam.getLsaPrefix();
67 NLSR_LOG_DEBUG("Setting interest filter for LsaPrefix: " << name);
68
69 m_face.setInterestFilter(ndn::InterestFilter(name).allowLoopback(false),
70 [this] (const auto& name, const auto& interest) { processInterest(name, interest); },
71 [] (const auto& name) { NLSR_LOG_DEBUG("Successfully registered prefix: " << name); },
72 [] (const auto& name, const auto& reason) {
73 NLSR_LOG_ERROR("Failed to register prefix " << name);
74 NDN_THROW(std::runtime_error("Register prefix failed: " + reason));
75 },
76 m_confParam.getSigningInfo(), ndn::nfd::ROUTE_FLAG_CAPTURE);
77
78 buildAndInstallOwnNameLsa();
79 // Install coordinate LSAs if using HR or dry-run HR.
80 if (m_confParam.getHyperbolicState() != HYPERBOLIC_STATE_OFF) {
81 buildAndInstallOwnCoordinateLsa();
82 }
Muktadir R Chowdhuryaa3b0852015-08-06 13:08:56 -050083}
84
Davide Pesavento65ee9922022-11-16 00:21:43 -050085Lsdb::~Lsdb()
86{
87 for (const auto& fetcher : m_fetchers) {
88 fetcher->stop();
89 }
90}
91
Muktadir R Chowdhuryaa3b0852015-08-06 13:08:56 -050092void
akmhoque31d1d4b2014-05-05 22:08:14 -050093Lsdb::buildAndInstallOwnNameLsa()
akmhoque53353462014-04-22 08:43:45 -050094{
Ashlesh Gawande57a87172020-05-09 19:47:06 -070095 NameLsa nameLsa(m_thisRouterPrefix, m_sequencingManager.getNameLsaSeq() + 1,
96 getLsaExpirationTimePoint(), m_confParam.getNamePrefixList());
Ashlesh Gawande3e105a02017-05-16 17:36:56 -050097 m_sequencingManager.increaseNameLsaSeq();
Ashlesh Gawande3e105a02017-05-16 17:36:56 -050098 m_sequencingManager.writeSeqNoToFile();
Nick Gordon727d4832017-10-13 18:04:25 -050099 m_sync.publishRoutingUpdate(Lsa::Type::NAME, m_sequencingManager.getNameLsaSeq());
Ashlesh Gawande3e105a02017-05-16 17:36:56 -0500100
Ashlesh Gawande57a87172020-05-09 19:47:06 -0700101 installLsa(std::make_shared<NameLsa>(nameLsa));
akmhoque53353462014-04-22 08:43:45 -0500102}
103
104void
akmhoque31d1d4b2014-05-05 22:08:14 -0500105Lsdb::buildAndInstallOwnCoordinateLsa()
akmhoque53353462014-04-22 08:43:45 -0500106{
Ashlesh Gawande57a87172020-05-09 19:47:06 -0700107 CoordinateLsa corLsa(m_thisRouterPrefix, m_sequencingManager.getCorLsaSeq() + 1,
108 getLsaExpirationTimePoint(), m_confParam.getCorR(),
Ashlesh Gawande85998a12017-12-07 22:22:13 -0600109 m_confParam.getCorTheta());
Ashlesh Gawande57a87172020-05-09 19:47:06 -0700110 m_sequencingManager.increaseCorLsaSeq();
111 m_sequencingManager.writeSeqNoToFile();
Nick Gordon5c467f02016-07-13 13:40:10 -0500112
113 // Sync coordinate LSAs if using HR or HR dry run.
Ashlesh Gawande85998a12017-12-07 22:22:13 -0600114 if (m_confParam.getHyperbolicState() != HYPERBOLIC_STATE_OFF) {
Nick Gordon727d4832017-10-13 18:04:25 -0500115 m_sync.publishRoutingUpdate(Lsa::Type::COORDINATE, m_sequencingManager.getCorLsaSeq());
Nick Gordon5c467f02016-07-13 13:40:10 -0500116 }
117
Ashlesh Gawande57a87172020-05-09 19:47:06 -0700118 installLsa(std::make_shared<CoordinateLsa>(corLsa));
akmhoque53353462014-04-22 08:43:45 -0500119}
120
akmhoque53353462014-04-22 08:43:45 -0500121void
Vince Lehman50df6b72015-03-03 12:06:40 -0600122Lsdb::scheduleAdjLsaBuild()
akmhoque53353462014-04-22 08:43:45 -0500123{
Ashlesh Gawande85998a12017-12-07 22:22:13 -0600124 m_adjBuildCount++;
Vince Lehman50df6b72015-03-03 12:06:40 -0600125
Ashlesh Gawande85998a12017-12-07 22:22:13 -0600126 if (m_confParam.getHyperbolicState() == HYPERBOLIC_STATE_ON) {
Nick Gordon5c467f02016-07-13 13:40:10 -0500127 // Don't build adjacency LSAs in hyperbolic routing
Davide Pesavento65ee9922022-11-16 00:21:43 -0500128 NLSR_LOG_DEBUG("Adjacency LSA not built while in hyperbolic routing state");
Nick Gordon5c467f02016-07-13 13:40:10 -0500129 return;
130 }
131
Ashlesh Gawande5d93aa52020-06-13 18:57:45 -0700132 if (m_isBuildAdjLsaScheduled) {
Ashlesh Gawande6b388fc2019-09-30 10:14:41 -0500133 NLSR_LOG_DEBUG("Rescheduling Adjacency LSA build in " << m_adjLsaBuildInterval);
134 }
135 else {
dmcoomes5bcb39e2017-10-31 15:07:55 -0500136 NLSR_LOG_DEBUG("Scheduling Adjacency LSA build in " << m_adjLsaBuildInterval);
Ashlesh Gawande5d93aa52020-06-13 18:57:45 -0700137 m_isBuildAdjLsaScheduled = true;
Vince Lehman50df6b72015-03-03 12:06:40 -0600138 }
Ashlesh Gawande6b388fc2019-09-30 10:14:41 -0500139 m_scheduledAdjLsaBuild = m_scheduler.schedule(m_adjLsaBuildInterval, [this] { buildAdjLsa(); });
Vince Lehman50df6b72015-03-03 12:06:40 -0600140}
141
Ashlesh Gawande57a87172020-05-09 19:47:06 -0700142void
143Lsdb::writeLog() const
144{
Junxiao Shi153fbc12024-01-09 23:37:23 +0000145 for (auto type : {Lsa::Type::COORDINATE, Lsa::Type::NAME, Lsa::Type::ADJACENCY}) {
Ashlesh Gawande5d93aa52020-06-13 18:57:45 -0700146 if ((type == Lsa::Type::COORDINATE &&
147 m_confParam.getHyperbolicState() == HYPERBOLIC_STATE_OFF) ||
148 (type == Lsa::Type::ADJACENCY &&
149 m_confParam.getHyperbolicState() == HYPERBOLIC_STATE_ON)) {
150 continue;
151 }
Ashlesh Gawande57a87172020-05-09 19:47:06 -0700152
Ashlesh Gawande5d93aa52020-06-13 18:57:45 -0700153 NLSR_LOG_DEBUG("---------------" << type << " LSDB-------------------");
154 auto lsaRange = m_lsdb.get<byType>().equal_range(type);
155 for (auto lsaIt = lsaRange.first; lsaIt != lsaRange.second; ++lsaIt) {
Junxiao Shi153fbc12024-01-09 23:37:23 +0000156 NLSR_LOG_DEBUG(**lsaIt);
Ashlesh Gawande5d93aa52020-06-13 18:57:45 -0700157 }
Ashlesh Gawande57a87172020-05-09 19:47:06 -0700158 }
159}
160
161void
Ashlesh Gawande57a87172020-05-09 19:47:06 -0700162Lsdb::processInterest(const ndn::Name& name, const ndn::Interest& interest)
163{
164 ndn::Name interestName(interest.getName());
165 NLSR_LOG_DEBUG("Interest received for LSA: " << interestName);
166
167 if (interestName[-2].isVersion()) {
168 // Interest for particular segment
Davide Pesavento65ee9922022-11-16 00:21:43 -0500169 auto data = m_segmentFifo.find(interestName);
170 if (data) {
171 NLSR_LOG_TRACE("Replying from FIFO buffer");
172 m_face.put(*data);
Ashlesh Gawande57a87172020-05-09 19:47:06 -0700173 return;
174 }
Davide Pesavento65ee9922022-11-16 00:21:43 -0500175
Ashlesh Gawande57a87172020-05-09 19:47:06 -0700176 // Remove version and segment
Davide Pesavento65ee9922022-11-16 00:21:43 -0500177 interestName = interestName.getPrefix(-2);
Ashlesh Gawande57a87172020-05-09 19:47:06 -0700178 NLSR_LOG_TRACE("Interest w/o segment and version: " << interestName);
179 }
180
181 // increment RCV_LSA_INTEREST
182 lsaIncrementSignal(Statistics::PacketType::RCV_LSA_INTEREST);
183
184 std::string chkString("LSA");
185 int32_t lsaPosition = util::getNameComponentPosition(interestName, chkString);
186
187 // Forms the name of the router that the Interest packet came from.
188 ndn::Name originRouter = m_confParam.getNetwork();
189 originRouter.append(interestName.getSubName(lsaPosition + 1,
190 interestName.size() - lsaPosition - 3));
191
192 // if the interest is for this router's LSA
193 if (originRouter == m_thisRouterPrefix && lsaPosition >= 0) {
194 uint64_t seqNo = interestName[-1].toNumber();
195 NLSR_LOG_DEBUG("LSA sequence number from interest: " << seqNo);
196
197 std::string lsaType = interestName[-2].toUri();
198 Lsa::Type interestedLsType;
199 std::istringstream(lsaType) >> interestedLsType;
200 if (interestedLsType == Lsa::Type::BASE) {
201 NLSR_LOG_WARN("Received unrecognized LSA type: " << lsaType);
202 return;
203 }
204
205 incrementInterestRcvdStats(interestedLsType);
206 if (processInterestForLsa(interest, originRouter, interestedLsType, seqNo)) {
207 lsaIncrementSignal(Statistics::PacketType::SENT_LSA_DATA);
208 }
209 }
210 // else the interest is for other router's LSA, serve signed data from LsaSegmentStorage
Davide Pesavento65ee9922022-11-16 00:21:43 -0500211 else if (auto lsaSegment = m_lsaStorage.find(interest); lsaSegment) {
Davide Pesaventofd1e9402023-11-13 15:40:41 -0500212 NLSR_LOG_TRACE("Found data in LSA storage. Sending data for " << interest.getName());
Ashlesh Gawande57a87172020-05-09 19:47:06 -0700213 m_face.put(*lsaSegment);
214 }
215}
216
217bool
218Lsdb::processInterestForLsa(const ndn::Interest& interest, const ndn::Name& originRouter,
219 Lsa::Type lsaType, uint64_t seqNo)
220{
221 NLSR_LOG_DEBUG(interest << " received for " << lsaType);
Davide Pesavento65ee9922022-11-16 00:21:43 -0500222
223 if (auto lsaPtr = findLsa(originRouter, lsaType); lsaPtr) {
224 NLSR_LOG_TRACE("Verifying SeqNo for " << lsaType << " is same as requested");
Ashlesh Gawande57a87172020-05-09 19:47:06 -0700225 if (lsaPtr->getSeqNo() == seqNo) {
Davide Pesavento65ee9922022-11-16 00:21:43 -0500226 auto segments = m_segmenter.segment(lsaPtr->wireEncode(),
227 ndn::Name(interest.getName()).appendVersion(),
228 ndn::MAX_NDN_PACKET_SIZE / 2, m_lsaRefreshTime);
229 for (const auto& data : segments) {
230 m_segmentFifo.insert(*data, m_lsaRefreshTime);
231 m_scheduler.schedule(m_lsaRefreshTime,
232 [this, name = data->getName()] { m_segmentFifo.erase(name); });
233 }
234
235 uint64_t segNum = 0;
236 if (interest.getName()[-1].isSegment()) {
237 segNum = interest.getName()[-1].toSegment();
238 }
239 if (segNum < segments.size()) {
240 m_face.put(*segments[segNum]);
241 }
Ashlesh Gawande57a87172020-05-09 19:47:06 -0700242 incrementDataSentStats(lsaType);
243 return true;
244 }
245 }
246 else {
Davide Pesavento65ee9922022-11-16 00:21:43 -0500247 NLSR_LOG_TRACE(interest << " was not found in our LSDB");
Ashlesh Gawande57a87172020-05-09 19:47:06 -0700248 }
249 return false;
250}
251
252void
Davide Pesaventod90338d2021-01-07 17:50:05 -0500253Lsdb::installLsa(std::shared_ptr<Lsa> lsa)
Ashlesh Gawande57a87172020-05-09 19:47:06 -0700254{
255 auto timeToExpire = m_lsaRefreshTime;
Ashlesh Gawande5d93aa52020-06-13 18:57:45 -0700256 if (lsa->getOriginRouter() != m_thisRouterPrefix) {
257 auto duration = lsa->getExpirationTimePoint() - ndn::time::system_clock::now();
258 if (duration > ndn::time::seconds(0)) {
259 timeToExpire = ndn::time::duration_cast<ndn::time::seconds>(duration);
260 }
261 }
Ashlesh Gawande57a87172020-05-09 19:47:06 -0700262
263 auto chkLsa = findLsa(lsa->getOriginRouter(), lsa->getType());
264 if (chkLsa == nullptr) {
Junxiao Shi153fbc12024-01-09 23:37:23 +0000265 NLSR_LOG_DEBUG("Adding LSA:\n" << *lsa);
Ashlesh Gawande57a87172020-05-09 19:47:06 -0700266
267 m_lsdb.emplace(lsa);
Ashlesh Gawande5d93aa52020-06-13 18:57:45 -0700268 onLsdbModified(lsa, LsdbUpdate::INSTALLED, {}, {});
Ashlesh Gawande57a87172020-05-09 19:47:06 -0700269
270 lsa->setExpiringEventId(scheduleLsaExpiration(lsa, timeToExpire));
271 }
272 // Else this is a known name LSA, so we are updating it.
273 else if (chkLsa->getSeqNo() < lsa->getSeqNo()) {
Junxiao Shi153fbc12024-01-09 23:37:23 +0000274 NLSR_LOG_DEBUG("Updating LSA:\n" << *chkLsa);
Ashlesh Gawande57a87172020-05-09 19:47:06 -0700275 chkLsa->setSeqNo(lsa->getSeqNo());
276 chkLsa->setExpirationTimePoint(lsa->getExpirationTimePoint());
277
Davide Pesaventoc1d0e8e2022-06-15 14:26:02 -0400278 auto [updated, namesToAdd, namesToRemove] = chkLsa->update(lsa);
Ashlesh Gawande5d93aa52020-06-13 18:57:45 -0700279 if (updated) {
280 onLsdbModified(lsa, LsdbUpdate::UPDATED, namesToAdd, namesToRemove);
Ashlesh Gawande57a87172020-05-09 19:47:06 -0700281 }
282
Ashlesh Gawande57a87172020-05-09 19:47:06 -0700283 chkLsa->setExpiringEventId(scheduleLsaExpiration(chkLsa, timeToExpire));
Junxiao Shi153fbc12024-01-09 23:37:23 +0000284 NLSR_LOG_DEBUG("Updated LSA:\n" << *chkLsa);
Ashlesh Gawande57a87172020-05-09 19:47:06 -0700285 }
286}
287
Ashlesh Gawande5d93aa52020-06-13 18:57:45 -0700288void
289Lsdb::removeLsa(const LsaContainer::index<Lsdb::byName>::type::iterator& lsaIt)
Ashlesh Gawande57a87172020-05-09 19:47:06 -0700290{
Ashlesh Gawande57a87172020-05-09 19:47:06 -0700291 if (lsaIt != m_lsdb.end()) {
292 auto lsaPtr = *lsaIt;
Junxiao Shi153fbc12024-01-09 23:37:23 +0000293 NLSR_LOG_DEBUG("Removing LSA:\n" << *lsaPtr);
Ashlesh Gawande57a87172020-05-09 19:47:06 -0700294 m_lsdb.erase(lsaIt);
Ashlesh Gawande5d93aa52020-06-13 18:57:45 -0700295 onLsdbModified(lsaPtr, LsdbUpdate::REMOVED, {}, {});
Ashlesh Gawande57a87172020-05-09 19:47:06 -0700296 }
Ashlesh Gawande5d93aa52020-06-13 18:57:45 -0700297}
298
299void
300Lsdb::removeLsa(const ndn::Name& router, Lsa::Type lsaType)
301{
302 removeLsa(m_lsdb.get<byName>().find(std::make_tuple(router, lsaType)));
Ashlesh Gawande57a87172020-05-09 19:47:06 -0700303}
304
Vince Lehman50df6b72015-03-03 12:06:40 -0600305void
306Lsdb::buildAdjLsa()
307{
Ashlesh Gawande57a87172020-05-09 19:47:06 -0700308 NLSR_LOG_TRACE("buildAdjLsa called");
Vince Lehman50df6b72015-03-03 12:06:40 -0600309
Ashlesh Gawande5d93aa52020-06-13 18:57:45 -0700310 m_isBuildAdjLsaScheduled = false;
Vince Lehmanf7eec4f2015-05-08 19:02:31 -0500311
Ashlesh Gawande85998a12017-12-07 22:22:13 -0600312 if (m_confParam.getAdjacencyList().isAdjLsaBuildable(m_confParam.getInterestRetryNumber())) {
Vince Lehmanf7eec4f2015-05-08 19:02:31 -0500313
Ashlesh Gawande85998a12017-12-07 22:22:13 -0600314 int adjBuildCount = m_adjBuildCount;
Nick G97e34942016-07-11 14:46:27 -0500315 // Only do the adjLsa build if there's one scheduled
akmhoque157b0a42014-05-13 00:26:37 -0500316 if (adjBuildCount > 0) {
Nick G97e34942016-07-11 14:46:27 -0500317 // It only makes sense to do the adjLsa build if we have neighbors
Ashlesh Gawande85998a12017-12-07 22:22:13 -0600318 if (m_confParam.getAdjacencyList().getNumOfActiveNeighbor() > 0) {
dmcoomes5bcb39e2017-10-31 15:07:55 -0500319 NLSR_LOG_DEBUG("Building and installing own Adj LSA");
akmhoque31d1d4b2014-05-05 22:08:14 -0500320 buildAndInstallOwnAdjLsa();
akmhoque53353462014-04-22 08:43:45 -0500321 }
Nick G97e34942016-07-11 14:46:27 -0500322 // We have no active neighbors, meaning no one can route through
323 // us. So delete our entry in the LSDB. This prevents this
324 // router from refreshing the LSA, eventually causing other
325 // routers to delete it, too.
akmhoque157b0a42014-05-13 00:26:37 -0500326 else {
dmcoomes5bcb39e2017-10-31 15:07:55 -0500327 NLSR_LOG_DEBUG("Removing own Adj LSA; no ACTIVE neighbors");
Ashlesh Gawande57a87172020-05-09 19:47:06 -0700328 removeLsa(m_thisRouterPrefix, Lsa::Type::ADJACENCY);
akmhoque53353462014-04-22 08:43:45 -0500329 }
Nick G97e34942016-07-11 14:46:27 -0500330 // In the case that during building the adj LSA, the FIB has to
331 // wait on an Interest response, the number of scheduled adj LSA
332 // builds could change, so we shouldn't just set it to 0.
Ashlesh Gawande85998a12017-12-07 22:22:13 -0600333 m_adjBuildCount = m_adjBuildCount - adjBuildCount;
akmhoque53353462014-04-22 08:43:45 -0500334 }
335 }
Nick G97e34942016-07-11 14:46:27 -0500336 // We are still waiting to know the adjacency status of some
337 // neighbor, so schedule a build for later (when all that has
338 // hopefully finished)
339 else {
Ashlesh Gawande5d93aa52020-06-13 18:57:45 -0700340 m_isBuildAdjLsaScheduled = true;
Ashlesh Gawande6b388fc2019-09-30 10:14:41 -0500341 auto schedulingTime = ndn::time::seconds(m_confParam.getInterestRetryNumber() *
342 m_confParam.getInterestResendTime());
343 m_scheduledAdjLsaBuild = m_scheduler.schedule(schedulingTime, [this] { buildAdjLsa(); });
Nick G97e34942016-07-11 14:46:27 -0500344 }
akmhoque53353462014-04-22 08:43:45 -0500345}
346
Ashlesh Gawande57a87172020-05-09 19:47:06 -0700347void
akmhoque31d1d4b2014-05-05 22:08:14 -0500348Lsdb::buildAndInstallOwnAdjLsa()
akmhoque53353462014-04-22 08:43:45 -0500349{
Ashlesh Gawande57a87172020-05-09 19:47:06 -0700350 AdjLsa adjLsa(m_thisRouterPrefix, m_sequencingManager.getAdjLsaSeq() + 1,
akmhoquec7a79b22014-05-26 08:06:19 -0500351 getLsaExpirationTimePoint(),
Ashlesh Gawande85998a12017-12-07 22:22:13 -0600352 m_confParam.getAdjacencyList());
Ashlesh Gawande57a87172020-05-09 19:47:06 -0700353 m_sequencingManager.increaseAdjLsaSeq();
354 m_sequencingManager.writeSeqNoToFile();
Vince Lehman904c2412014-09-23 19:36:11 -0500355
Nick Gordon5c467f02016-07-13 13:40:10 -0500356 //Sync adjacency LSAs if link-state or dry-run HR is enabled.
Ashlesh Gawande85998a12017-12-07 22:22:13 -0600357 if (m_confParam.getHyperbolicState() != HYPERBOLIC_STATE_ON) {
Nick Gordon727d4832017-10-13 18:04:25 -0500358 m_sync.publishRoutingUpdate(Lsa::Type::ADJACENCY, m_sequencingManager.getAdjLsaSeq());
Nick Gordon5c467f02016-07-13 13:40:10 -0500359 }
Vince Lehman904c2412014-09-23 19:36:11 -0500360
Ashlesh Gawande57a87172020-05-09 19:47:06 -0700361 installLsa(std::make_shared<AdjLsa>(adjLsa));
akmhoque53353462014-04-22 08:43:45 -0500362}
363
Ashlesh Gawande5d93aa52020-06-13 18:57:45 -0700364ndn::scheduler::EventId
365Lsdb::scheduleLsaExpiration(std::shared_ptr<Lsa> lsa, ndn::time::seconds expTime)
366{
367 NLSR_LOG_DEBUG("Scheduling expiration in: " << expTime + GRACE_PERIOD << " for " << lsa->getOriginRouter());
368 return m_scheduler.schedule(expTime + GRACE_PERIOD, [this, lsa] { expireOrRefreshLsa(lsa); });
369}
370
akmhoque53353462014-04-22 08:43:45 -0500371void
Ashlesh Gawande57a87172020-05-09 19:47:06 -0700372Lsdb::expireOrRefreshLsa(std::shared_ptr<Lsa> lsa)
akmhoque53353462014-04-22 08:43:45 -0500373{
Ashlesh Gawande57a87172020-05-09 19:47:06 -0700374 NLSR_LOG_DEBUG("ExpireOrRefreshLsa called for " << lsa->getType());
375 NLSR_LOG_DEBUG("OriginRouter: " << lsa->getOriginRouter() << " Seq No: " << lsa->getSeqNo());
376
377 auto lsaIt = m_lsdb.get<byName>().find(std::make_tuple(lsa->getOriginRouter(), lsa->getType()));
378
Nick G97e34942016-07-11 14:46:27 -0500379 // If this name LSA exists in the LSDB
Ashlesh Gawande57a87172020-05-09 19:47:06 -0700380 if (lsaIt != m_lsdb.end()) {
381 auto lsaPtr = *lsaIt;
Junxiao Shi153fbc12024-01-09 23:37:23 +0000382 NLSR_LOG_DEBUG(*lsaPtr);
Ashlesh Gawande57a87172020-05-09 19:47:06 -0700383 NLSR_LOG_DEBUG("LSA Exists with seq no: " << lsaPtr->getSeqNo());
Nick G97e34942016-07-11 14:46:27 -0500384 // If its seq no is the one we are expecting.
Ashlesh Gawande57a87172020-05-09 19:47:06 -0700385 if (lsaPtr->getSeqNo() == lsa->getSeqNo()) {
386 if (lsaPtr->getOriginRouter() == m_thisRouterPrefix) {
Davide Pesavento65ee9922022-11-16 00:21:43 -0500387 NLSR_LOG_DEBUG("Own " << lsaPtr->getType() << " LSA, so refreshing it");
Junxiao Shi153fbc12024-01-09 23:37:23 +0000388 NLSR_LOG_DEBUG("Current LSA:\n" << *lsaPtr);
Ashlesh Gawande57a87172020-05-09 19:47:06 -0700389 lsaPtr->setSeqNo(lsaPtr->getSeqNo() + 1);
390 m_sequencingManager.setLsaSeq(lsaPtr->getSeqNo(), lsaPtr->getType());
391 lsaPtr->setExpirationTimePoint(getLsaExpirationTimePoint());
Junxiao Shi153fbc12024-01-09 23:37:23 +0000392 NLSR_LOG_DEBUG("Updated LSA:\n" << *lsaPtr);
akmhoquefdbddb12014-05-02 18:35:19 -0500393 // schedule refreshing event again
Ashlesh Gawande57a87172020-05-09 19:47:06 -0700394 lsaPtr->setExpiringEventId(scheduleLsaExpiration(lsaPtr, m_lsaRefreshTime));
Ashlesh Gawande3e105a02017-05-16 17:36:56 -0500395 m_sequencingManager.writeSeqNoToFile();
Ashlesh Gawande57a87172020-05-09 19:47:06 -0700396 m_sync.publishRoutingUpdate(lsaPtr->getType(), m_sequencingManager.getLsaSeq(lsaPtr->getType()));
akmhoque53353462014-04-22 08:43:45 -0500397 }
Nick G97e34942016-07-11 14:46:27 -0500398 // Since we cannot refresh other router's LSAs, our only choice is to expire.
akmhoque157b0a42014-05-13 00:26:37 -0500399 else {
Ashlesh Gawande57a87172020-05-09 19:47:06 -0700400 NLSR_LOG_DEBUG("Other's " << lsaPtr->getType() << " LSA, so removing from LSDB");
Ashlesh Gawande5d93aa52020-06-13 18:57:45 -0700401 removeLsa(lsaIt);
akmhoque53353462014-04-22 08:43:45 -0500402 }
403 }
404 }
405}
406
akmhoque53353462014-04-22 08:43:45 -0500407void
Alexander Afanasyev135288c2022-04-23 23:06:56 -0400408Lsdb::expressInterest(const ndn::Name& interestName, uint32_t timeoutCount, uint64_t incomingFaceId,
Davide Pesavento658fd852023-05-10 22:15:03 -0400409 ndn::time::steady_clock::time_point deadline)
akmhoque31d1d4b2014-05-05 22:08:14 -0500410{
Alejandro Gil Torrese0d20482016-03-06 23:56:19 -0600411 // increment SENT_LSA_INTEREST
412 lsaIncrementSignal(Statistics::PacketType::SENT_LSA_INTEREST);
413
Ashlesh Gawande5bf83172014-09-19 12:38:17 -0500414 if (deadline == DEFAULT_LSA_RETRIEVAL_DEADLINE) {
Nick Gordone98480b2017-05-24 11:23:03 -0500415 deadline = ndn::time::steady_clock::now() + ndn::time::seconds(static_cast<int>(LSA_REFRESH_TIME_MAX));
Alexander Afanasyev411ee4b2014-08-16 23:17:03 -0700416 }
Nick G97e34942016-07-11 14:46:27 -0500417 // The first component of the interest is the name.
Ashlesh Gawande5bf83172014-09-19 12:38:17 -0500418 ndn::Name lsaName = interestName.getSubName(0, interestName.size()-1);
Nick G97e34942016-07-11 14:46:27 -0500419 // The seq no is the last
Ashlesh Gawande5bf83172014-09-19 12:38:17 -0500420 uint64_t seqNo = interestName[-1].toNumber();
421
Nick G97e34942016-07-11 14:46:27 -0500422 // If the LSA is not found in the list currently.
Ashlesh Gawande5bf83172014-09-19 12:38:17 -0500423 if (m_highestSeqNo.find(lsaName) == m_highestSeqNo.end()) {
424 m_highestSeqNo[lsaName] = seqNo;
425 }
Nick G97e34942016-07-11 14:46:27 -0500426 // If the new seq no is higher, that means the LSA is valid
Ashlesh Gawande5bf83172014-09-19 12:38:17 -0500427 else if (seqNo > m_highestSeqNo[lsaName]) {
428 m_highestSeqNo[lsaName] = seqNo;
429 }
Nick G97e34942016-07-11 14:46:27 -0500430 // Otherwise, its an old/invalid LSA
Ashlesh Gawande5bf83172014-09-19 12:38:17 -0500431 else if (seqNo < m_highestSeqNo[lsaName]) {
432 return;
433 }
434
Muktadir R Chowdhuryaa3b0852015-08-06 13:08:56 -0500435 ndn::Interest interest(interestName);
Alexander Afanasyev135288c2022-04-23 23:06:56 -0400436 if (incomingFaceId != 0) {
437 interest.setTag(std::make_shared<ndn::lp::NextHopFaceIdTag>(incomingFaceId));
438 }
Junxiao Shi43f37a02023-08-09 00:09:00 +0000439 ndn::SegmentFetcher::Options options;
Ashlesh Gawande85998a12017-12-07 22:22:13 -0600440 options.interestLifetime = m_confParam.getLsaInterestLifetime();
awlane0c87b122022-06-17 15:53:10 -0500441 options.maxTimeout = m_confParam.getLsaInterestLifetime();
Ashlesh Gawande5bf83172014-09-19 12:38:17 -0500442
dmcoomes5bcb39e2017-10-31 15:07:55 -0500443 NLSR_LOG_DEBUG("Fetching Data for LSA: " << interestName << " Seq number: " << seqNo);
Junxiao Shi43f37a02023-08-09 00:09:00 +0000444 auto fetcher = ndn::SegmentFetcher::start(m_face, interest, m_confParam.getValidator(), options);
Ashlesh Gawande05cb7282018-08-30 14:39:41 -0500445
Ashlesh Gawande744e4812018-08-22 16:26:24 -0500446 auto it = m_fetchers.insert(fetcher).first;
447
Ashlesh Gawande85998a12017-12-07 22:22:13 -0600448 fetcher->afterSegmentValidated.connect([this] (const ndn::Data& data) {
Ashlesh Gawande15052402018-12-12 20:20:00 -0600449 // Nlsr class subscribes to this to fetch certificates
450 afterSegmentValidatedSignal(data);
451
452 // If we don't do this IMS throws: std::bad_weak_ptr: bad_weak_ptr
453 auto lsaSegment = std::make_shared<const ndn::Data>(data);
454 m_lsaStorage.insert(*lsaSegment);
Ashlesh Gawande15052402018-12-12 20:20:00 -0600455 // Schedule deletion of the segment
456 m_scheduler.schedule(ndn::time::seconds(LSA_REFRESH_TIME_DEFAULT),
Davide Pesavento65ee9922022-11-16 00:21:43 -0500457 [this, name = lsaSegment->getName()] { m_lsaStorage.erase(name); });
Ashlesh Gawande15052402018-12-12 20:20:00 -0600458 });
459
460 fetcher->onComplete.connect([=] (const ndn::ConstBufferPtr& bufferPtr) {
461 m_lsaStorage.erase(ndn::Name(lsaName).appendNumber(seqNo - 1));
462 afterFetchLsa(bufferPtr, interestName);
463 m_fetchers.erase(it);
464 });
465
466 fetcher->onError.connect([=] (uint32_t errorCode, const std::string& msg) {
467 onFetchLsaError(errorCode, msg, interestName, timeoutCount, deadline, lsaName, seqNo);
468 m_fetchers.erase(it);
469 });
Muktadir Chowdhuryc3ea26f2018-01-05 21:40:59 +0000470
Nick Gordon727d4832017-10-13 18:04:25 -0500471 Lsa::Type lsaType;
472 std::istringstream(interestName[-2].toUri()) >> lsaType;
Ashlesh Gawande57a87172020-05-09 19:47:06 -0700473 incrementInterestSentStats(lsaType);
474}
475
476void
477Lsdb::onFetchLsaError(uint32_t errorCode, const std::string& msg, const ndn::Name& interestName,
Davide Pesavento658fd852023-05-10 22:15:03 -0400478 uint32_t retransmitNo, const ndn::time::steady_clock::time_point& deadline,
Ashlesh Gawande57a87172020-05-09 19:47:06 -0700479 ndn::Name lsaName, uint64_t seqNo)
480{
481 NLSR_LOG_DEBUG("Failed to fetch LSA: " << lsaName << ", Error code: " << errorCode
482 << ", Message: " << msg);
483
484 if (ndn::time::steady_clock::now() < deadline) {
485 auto it = m_highestSeqNo.find(lsaName);
486 if (it != m_highestSeqNo.end() && it->second == seqNo) {
487 // If the SegmentFetcher failed due to an Interest timeout, it is safe to re-express
488 // immediately since at the least the LSA Interest lifetime has elapsed.
489 // Otherwise, it is necessary to delay the Interest re-expression to prevent
490 // the potential for constant Interest flooding.
Davide Pesaventofd1e9402023-11-13 15:40:41 -0500491 auto delay = m_confParam.getLsaInterestLifetime();
Junxiao Shi43f37a02023-08-09 00:09:00 +0000492 if (errorCode == ndn::SegmentFetcher::ErrorCode::INTEREST_TIMEOUT) {
Davide Pesaventofd1e9402023-11-13 15:40:41 -0500493 delay = 0_s;
Ashlesh Gawande57a87172020-05-09 19:47:06 -0700494 }
Davide Pesaventofd1e9402023-11-13 15:40:41 -0500495 m_scheduler.schedule(delay, std::bind(&Lsdb::expressInterest, this, interestName,
496 retransmitNo + 1, /*Multicast FaceID*/0, deadline));
Ashlesh Gawande57a87172020-05-09 19:47:06 -0700497 }
Alejandro Gil Torrese0d20482016-03-06 23:56:19 -0600498 }
akmhoque31d1d4b2014-05-05 22:08:14 -0500499}
500
501void
Ashlesh Gawande57a87172020-05-09 19:47:06 -0700502Lsdb::afterFetchLsa(const ndn::ConstBufferPtr& bufferPtr, const ndn::Name& interestName)
akmhoque31d1d4b2014-05-05 22:08:14 -0500503{
Ashlesh Gawande57a87172020-05-09 19:47:06 -0700504 NLSR_LOG_DEBUG("Received data for LSA interest: " << interestName);
505 lsaIncrementSignal(Statistics::PacketType::RCV_LSA_DATA);
Ashlesh Gawande939b6f82018-12-09 16:51:09 -0600506
Ashlesh Gawande57a87172020-05-09 19:47:06 -0700507 ndn::Name lsaName = interestName.getSubName(0, interestName.size()-1);
508 uint64_t seqNo = interestName[-1].toNumber();
509
510 if (m_highestSeqNo.find(lsaName) == m_highestSeqNo.end()) {
511 m_highestSeqNo[lsaName] = seqNo;
Ashlesh Gawande939b6f82018-12-09 16:51:09 -0600512 }
Ashlesh Gawande57a87172020-05-09 19:47:06 -0700513 else if (seqNo > m_highestSeqNo[lsaName]) {
514 m_highestSeqNo[lsaName] = seqNo;
Davide Pesavento65ee9922022-11-16 00:21:43 -0500515 NLSR_LOG_TRACE("SeqNo for LSA(name): " << interestName << " updated");
Ashlesh Gawande57a87172020-05-09 19:47:06 -0700516 }
517 else if (seqNo < m_highestSeqNo[lsaName]) {
518 return;
519 }
Alejandro Gil Torrese0d20482016-03-06 23:56:19 -0600520
Muktadir R Chowdhuryaa3b0852015-08-06 13:08:56 -0500521 std::string chkString("LSA");
Ashlesh Gawande939b6f82018-12-09 16:51:09 -0600522 int32_t lsaPosition = util::getNameComponentPosition(interestName, chkString);
Ashlesh Gawande5bf83172014-09-19 12:38:17 -0500523
Ashlesh Gawande57a87172020-05-09 19:47:06 -0700524 if (lsaPosition >= 0) {
525 // Extracts the prefix of the originating router from the data.
526 ndn::Name originRouter = m_confParam.getNetwork();
527 originRouter.append(interestName.getSubName(lsaPosition + 1,
528 interestName.size() - lsaPosition - 3));
Ashlesh Gawande57a87172020-05-09 19:47:06 -0700529 try {
530 Lsa::Type interestedLsType;
531 std::istringstream(interestName[-2].toUri()) >> interestedLsType;
Ashlesh Gawande5bf83172014-09-19 12:38:17 -0500532
Ashlesh Gawande57a87172020-05-09 19:47:06 -0700533 if (interestedLsType == Lsa::Type::BASE) {
534 NLSR_LOG_WARN("Received unrecognized LSA Type: " << interestName[-2].toUri());
535 return;
536 }
Ashlesh Gawande5bf83172014-09-19 12:38:17 -0500537
Ashlesh Gawande57a87172020-05-09 19:47:06 -0700538 ndn::Block block(bufferPtr);
539 if (interestedLsType == Lsa::Type::NAME) {
540 lsaIncrementSignal(Statistics::PacketType::RCV_NAME_LSA_DATA);
541 if (isLsaNew(originRouter, interestedLsType, seqNo)) {
542 installLsa(std::make_shared<NameLsa>(block));
543 }
544 }
545 else if (interestedLsType == Lsa::Type::ADJACENCY) {
546 lsaIncrementSignal(Statistics::PacketType::RCV_ADJ_LSA_DATA);
547 if (isLsaNew(originRouter, interestedLsType, seqNo)) {
548 installLsa(std::make_shared<AdjLsa>(block));
549 }
550 }
551 else if (interestedLsType == Lsa::Type::COORDINATE) {
552 lsaIncrementSignal(Statistics::PacketType::RCV_COORD_LSA_DATA);
553 if (isLsaNew(originRouter, interestedLsType, seqNo)) {
554 installLsa(std::make_shared<CoordinateLsa>(block));
555 }
556 }
akmhoque31d1d4b2014-05-05 22:08:14 -0500557 }
Ashlesh Gawande57a87172020-05-09 19:47:06 -0700558 catch (const std::exception& e) {
Davide Pesaventofd1e9402023-11-13 15:40:41 -0500559 NLSR_LOG_TRACE("LSA data decoding error: " << e.what());
Ashlesh Gawande939b6f82018-12-09 16:51:09 -0600560 }
Nick Gordon8f23b5d2017-08-31 17:53:07 -0500561 }
562}
563
Alexander Afanasyev8388ec62014-08-16 18:38:57 -0700564} // namespace nlsr