All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
fib-manager.cpp
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2014-2025, Regents of the University of California,
4  * 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-manager.hpp"
27 
28 #include "common/logger.hpp"
29 #include "fw/face-table.hpp"
30 #include "table/fib.hpp"
31 
32 #include <ndn-cxx/lp/tags.hpp>
33 #include <ndn-cxx/mgmt/nfd/fib-entry.hpp>
34 
35 #include <boost/range/adaptor/transformed.hpp>
36 
37 namespace nfd {
38 
39 NFD_LOG_INIT(FibManager);
40 
41 FibManager::FibManager(Fib& fib, const FaceTable& faceTable,
42  Dispatcher& dispatcher, CommandAuthenticator& authenticator)
43  : ManagerBase("fib", dispatcher, authenticator)
44  , m_fib(fib)
45  , m_faceTable(faceTable)
46 {
47  registerCommandHandler<ndn::nfd::FibAddNextHopCommand>([this] (auto&&, auto&&... args) {
48  addNextHop(std::forward<decltype(args)>(args)...);
49  });
50  registerCommandHandler<ndn::nfd::FibRemoveNextHopCommand>([this] (auto&&, auto&&... args) {
51  removeNextHop(std::forward<decltype(args)>(args)...);
52  });
53  registerStatusDatasetHandler("list", [this] (auto&&, auto&&, auto&&... args) {
54  listEntries(std::forward<decltype(args)>(args)...);
55  });
56 }
57 
58 void
59 FibManager::addNextHop(const Interest& interest, ControlParameters parameters,
60  const CommandContinuation& done)
61 {
62  setFaceForSelfRegistration(interest, parameters);
63  const Name& prefix = parameters.getName();
64  FaceId faceId = parameters.getFaceId();
65  uint64_t cost = parameters.getCost();
66 
67  if (prefix.size() > Fib::getMaxDepth()) {
68  NFD_LOG_DEBUG("add-nexthop(" << prefix << ',' << faceId << ',' << cost <<
69  ") -> FAIL prefix-too-long");
70  return done(ControlResponse(414, "FIB entry prefix cannot exceed " +
71  std::to_string(Fib::getMaxDepth()) + " components"));
72  }
73 
74  Face* face = m_faceTable.get(faceId);
75  if (face == nullptr) {
76  NFD_LOG_DEBUG("add-nexthop(" << prefix << ',' << faceId << ',' << cost <<
77  ") -> FAIL unknown-faceid");
78  return done(ControlResponse(410, "Face not found"));
79  }
80 
81  fib::Entry* entry = m_fib.insert(prefix).first;
82  m_fib.addOrUpdateNextHop(*entry, *face, cost);
83 
84  NFD_LOG_TRACE("add-nexthop(" << prefix << ',' << faceId << ',' << cost << ") -> OK");
85  return done(ControlResponse(200, "OK").setBody(parameters.wireEncode()));
86 }
87 
88 void
89 FibManager::removeNextHop(const Interest& interest, ControlParameters parameters,
90  const CommandContinuation& done)
91 {
92  setFaceForSelfRegistration(interest, parameters);
93  const Name& prefix = parameters.getName();
94  FaceId faceId = parameters.getFaceId();
95 
96  done(ControlResponse(200, "OK").setBody(parameters.wireEncode()));
97 
98  Face* face = m_faceTable.get(faceId);
99  if (face == nullptr) {
100  NFD_LOG_TRACE("remove-nexthop(" << prefix << ',' << faceId << ") -> OK no-face");
101  return;
102  }
103 
104  fib::Entry* entry = m_fib.findExactMatch(parameters.getName());
105  if (entry == nullptr) {
106  NFD_LOG_TRACE("remove-nexthop(" << prefix << ',' << faceId << ") -> OK no-entry");
107  return;
108  }
109 
110  auto status = m_fib.removeNextHop(*entry, *face);
111  switch (status) {
113  NFD_LOG_TRACE("remove-nexthop(" << prefix << ',' << faceId << ") -> OK no-nexthop");
114  break;
116  NFD_LOG_TRACE("remove-nexthop(" << prefix << ',' << faceId << ") -> OK entry-erased");
117  break;
119  NFD_LOG_TRACE("remove-nexthop(" << prefix << ',' << faceId << ") -> OK nexthop-removed");
120  break;
121  }
122 }
123 
124 void
125 FibManager::listEntries(ndn::mgmt::StatusDatasetContext& context)
126 {
127  for (const auto& entry : m_fib) {
128  const auto& nexthops = entry.getNextHops() |
129  boost::adaptors::transformed([] (const fib::NextHop& nh) {
130  return ndn::nfd::NextHopRecord()
131  .setFaceId(nh.getFace().getId())
132  .setCost(nh.getCost());
133  });
134  context.append(ndn::nfd::FibEntry()
135  .setPrefix(entry.getPrefix())
136  .setNextHopRecords(std::begin(nexthops), std::end(nexthops))
137  .wireEncode());
138  }
139  context.end();
140 }
141 
142 void
143 FibManager::setFaceForSelfRegistration(const Interest& request, ControlParameters& parameters)
144 {
145  bool isSelfRegistration = parameters.getFaceId() == face::INVALID_FACEID;
146  if (isSelfRegistration) {
147  auto incomingFaceIdTag = request.getTag<lp::IncomingFaceIdTag>();
148  // NDNLPv2 says "application MUST be prepared to receive a packet without IncomingFaceId field",
149  // but it's fine to assert IncomingFaceId is available, because InternalFace lives inside NFD
150  // and is initialized synchronously with IncomingFaceId field enabled.
151  BOOST_ASSERT(incomingFaceIdTag != nullptr);
152  parameters.setFaceId(*incomingFaceIdTag);
153  }
154 }
155 
156 } // namespace nfd
Provides ControlCommand authorization according to NFD's configuration file.
Container of all faces.
Definition: face-table.hpp:42
Face * get(FaceId id) const noexcept
Get face by FaceId.
Definition: face-table.cpp:38
FibManager(fib::Fib &fib, const FaceTable &faceTable, Dispatcher &dispatcher, CommandAuthenticator &authenticator)
Definition: fib-manager.cpp:41
A collection of common functions shared by all NFD managers, such as communicating with the dispatche...
void registerStatusDatasetHandler(const std::string &verb, const ndn::mgmt::StatusDatasetHandler &handler)
Represents the Forwarding Information Base (FIB).
Definition: fib.hpp:51
@ NEXTHOP_REMOVED
the nexthop is removed and the fib entry stays
@ FIB_ENTRY_REMOVED
the nexthop is removed and the fib entry is removed
@ NO_SUCH_NEXTHOP
the nexthop is not found
std::pair< Entry *, bool > insert(const Name &prefix)
Find or insert a FIB entry.
Definition: fib.cpp:85
Entry * findExactMatch(const Name &prefix)
Performs an exact match lookup.
Definition: fib.cpp:75
RemoveNextHopResult removeNextHop(Entry &entry, const Face &face)
Remove the NextHop record for face from entry.
Definition: fib.cpp:139
static constexpr size_t getMaxDepth()
Maximum number of components in a FIB entry prefix.
Definition: fib.hpp:91
void addOrUpdateNextHop(Entry &entry, Face &face, uint64_t cost)
Add a NextHop record.
Definition: fib.cpp:131
#define NFD_LOG_INIT(name)
Definition: logger.hpp:31
#define NFD_LOG_DEBUG
Definition: logger.hpp:38
#define NFD_LOG_TRACE
Definition: logger.hpp:37
constexpr FaceId INVALID_FACEID
Indicates an invalid FaceId.
Definition: face-common.hpp:51
uint64_t FaceId
Identifies a face.
Definition: face-common.hpp:48
-status-http-server
Definition: common.hpp:71