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-2019, 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>("add-nexthop",
48  bind(&FibManager::addNextHop, this, _2, _3, _4, _5));
49  registerCommandHandler<ndn::nfd::FibRemoveNextHopCommand>("remove-nexthop",
50  bind(&FibManager::removeNextHop, this, _2, _3, _4, _5));
51 
52  registerStatusDatasetHandler("list", bind(&FibManager::listEntries, this, _1, _2, _3));
53 }
54 
55 void
56 FibManager::addNextHop(const Name& topPrefix, const Interest& interest,
57  ControlParameters parameters,
58  const ndn::mgmt::CommandContinuation& done)
59 {
60  setFaceForSelfRegistration(interest, parameters);
61  const Name& prefix = parameters.getName();
62  FaceId faceId = parameters.getFaceId();
63  uint64_t cost = parameters.getCost();
64 
65  if (prefix.size() > Fib::getMaxDepth()) {
66  NFD_LOG_DEBUG("fib/add-nexthop(" << prefix << ',' << faceId << ',' << cost <<
67  "): FAIL prefix-too-long");
68  return done(ControlResponse(414, "FIB entry prefix cannot exceed " +
69  to_string(Fib::getMaxDepth()) + " components"));
70  }
71 
72  Face* face = m_faceTable.get(faceId);
73  if (face == nullptr) {
74  NFD_LOG_DEBUG("fib/add-nexthop(" << prefix << ',' << faceId << ',' << cost <<
75  "): FAIL unknown-faceid");
76  return done(ControlResponse(410, "Face not found"));
77  }
78 
79  fib::Entry* entry = m_fib.insert(prefix).first;
80  m_fib.addOrUpdateNextHop(*entry, *face, cost);
81 
82  NFD_LOG_TRACE("fib/add-nexthop(" << prefix << ',' << faceId << ',' << cost << "): OK");
83  return done(ControlResponse(200, "Success").setBody(parameters.wireEncode()));
84 }
85 
86 void
87 FibManager::removeNextHop(const Name& topPrefix, const Interest& interest,
88  ControlParameters parameters,
89  const ndn::mgmt::CommandContinuation& done)
90 {
91  setFaceForSelfRegistration(interest, parameters);
92  const Name& prefix = parameters.getName();
93  FaceId faceId = parameters.getFaceId();
94 
95  done(ControlResponse(200, "Success").setBody(parameters.wireEncode()));
96 
97  Face* face = m_faceTable.get(faceId);
98  if (face == nullptr) {
99  NFD_LOG_TRACE("fib/remove-nexthop(" << prefix << ',' << faceId << "): OK no-face");
100  return;
101  }
102 
103  fib::Entry* entry = m_fib.findExactMatch(parameters.getName());
104  if (entry == nullptr) {
105  NFD_LOG_TRACE("fib/remove-nexthop(" << prefix << ',' << faceId << "): OK no-entry");
106  return;
107  }
108 
109  auto status = m_fib.removeNextHop(*entry, *face);
110  switch (status) {
111  case Fib::RemoveNextHopResult::NO_SUCH_NEXTHOP:
112  NFD_LOG_TRACE("fib/remove-nexthop(" << prefix << ',' << faceId << "): OK no-nexthop");
113  break;
114  case Fib::RemoveNextHopResult::FIB_ENTRY_REMOVED:
115  NFD_LOG_TRACE("fib/remove-nexthop(" << prefix << ',' << faceId << "): OK entry-erased");
116  break;
117  case Fib::RemoveNextHopResult::NEXTHOP_REMOVED:
118  NFD_LOG_TRACE("fib/remove-nexthop(" << prefix << ',' << faceId << "): OK nexthop-removed");
119  break;
120  }
121 }
122 
123 void
124 FibManager::listEntries(const Name& topPrefix, const Interest& interest,
125  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() == 0);
146  if (isSelfRegistration) {
147  shared_ptr<lp::IncomingFaceIdTag> 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
void registerStatusDatasetHandler(const std::string &verb, const ndn::mgmt::StatusDatasetHandler &handler)
Entry * findExactMatch(const Name &prefix)
Performs an exact match lookup.
Definition: fib.cpp:80
represents a FIB entry
Definition: fib-entry.hpp:53
#define NFD_LOG_TRACE
Definition: logger.hpp:37
std::pair< Entry *, bool > insert(const Name &prefix)
Find or insert a FIB entry.
Definition: fib.cpp:90
container of all faces
Definition: face-table.hpp:38
Face * get(FaceId id) const
get face by FaceId
Definition: face-table.cpp:45
Provides ControlCommand authorization according to NFD configuration file.
A collection of common functions shared by all NFD managers, such as communicating with the dispatche...
Copyright (c) 2014-2015, Regents of the University of California, Arizona Board of Regents...
Definition: algorithm.hpp:32
Face & getFace() const
Definition: fib-nexthop.hpp:47
FibManager(fib::Fib &fib, const FaceTable &faceTable, Dispatcher &dispatcher, CommandAuthenticator &authenticator)
Definition: fib-manager.cpp:41
void addOrUpdateNextHop(Entry &entry, Face &face, uint64_t cost)
Add a NextHop record.
Definition: fib.cpp:136
#define NFD_LOG_DEBUG
Definition: logger.hpp:38
#define NFD_LOG_INIT(name)
Definition: logger.hpp:31
RemoveNextHopResult removeNextHop(Entry &entry, const Face &face)
Remove the NextHop record for face from entry.
Definition: fib.cpp:147
Represents a nexthop record in a FIB entry.
Definition: fib-nexthop.hpp:37
uint64_t FaceId
Identifies a face.
Definition: face-common.hpp:44
uint64_t getCost() const
Definition: fib-nexthop.hpp:53