blob: fa2c3182afdccbba17febe53cd4f0da5dd98e7cc [file] [log] [blame]
Alexander Afanasyev3ecec502014-04-16 13:42:44 -07001/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2/**
Junxiao Shi1e46be32015-01-08 20:18:05 -07003 * Copyright (c) 2014-2015, 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.
Alexander Afanasyev3ecec502014-04-16 13:42:44 -070010 *
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/>.
Vince12e49462014-06-09 13:29:32 -050024 */
Alexander Afanasyev3ecec502014-04-16 13:42:44 -070025
26#include "rib-manager.hpp"
Alexander Afanasyev03ea3eb2014-04-17 18:19:06 -070027#include "core/global-io.hpp"
Alexander Afanasyev89cf5e02014-04-17 12:08:57 -070028#include "core/logger.hpp"
Alexander Afanasyev63108c42014-07-07 19:10:47 -070029#include "core/scheduler.hpp"
Vince Lehmancd613c52014-07-30 14:34:49 -050030#include <ndn-cxx/management/nfd-face-status.hpp>
Alexander Afanasyev3ecec502014-04-16 13:42:44 -070031
32namespace nfd {
33namespace rib {
34
Alexander Afanasyev89cf5e02014-04-17 12:08:57 -070035NFD_LOG_INIT("RibManager");
36
Alexander Afanasyev20d31442014-04-19 17:00:53 -070037const Name RibManager::COMMAND_PREFIX = "/localhost/nfd/rib";
38const Name RibManager::REMOTE_COMMAND_PREFIX = "/localhop/nfd/rib";
Vince Lehmancd613c52014-07-30 14:34:49 -050039const Name RibManager::FACES_LIST_DATASET_PREFIX = "/localhost/nfd/faces/list";
Alexander Afanasyev3ecec502014-04-16 13:42:44 -070040
41const size_t RibManager::COMMAND_UNSIGNED_NCOMPS =
42 RibManager::COMMAND_PREFIX.size() +
43 1 + // verb
44 1; // verb options
45
46const size_t RibManager::COMMAND_SIGNED_NCOMPS =
47 RibManager::COMMAND_UNSIGNED_NCOMPS +
48 4; // (timestamp, nonce, signed info tlv, signature tlv)
49
Vince Lehmancd16c832014-07-23 15:14:55 -070050const RibManager::SignedVerbAndProcessor RibManager::SIGNED_COMMAND_VERBS[] =
Alexander Afanasyev3ecec502014-04-16 13:42:44 -070051 {
Vince Lehmancd16c832014-07-23 15:14:55 -070052 SignedVerbAndProcessor(
53 Name::Component("register"),
54 &RibManager::registerEntry
55 ),
Alexander Afanasyev3ecec502014-04-16 13:42:44 -070056
Vince Lehmancd16c832014-07-23 15:14:55 -070057 SignedVerbAndProcessor(
58 Name::Component("unregister"),
59 &RibManager::unregisterEntry
60 ),
Alexander Afanasyev3ecec502014-04-16 13:42:44 -070061 };
62
Vince Lehmancd16c832014-07-23 15:14:55 -070063const RibManager::UnsignedVerbAndProcessor RibManager::UNSIGNED_COMMAND_VERBS[] =
64 {
65 UnsignedVerbAndProcessor(
66 Name::Component("list"),
67 &RibManager::listEntries
68 ),
69 };
70
71const Name RibManager::LIST_COMMAND_PREFIX("/localhost/nfd/rib/list");
72const size_t RibManager::LIST_COMMAND_NCOMPS = LIST_COMMAND_PREFIX.size();
73
Vince Lehman26b215c2014-08-17 15:00:41 -050074const time::seconds RibManager::ACTIVE_FACE_FETCH_INTERVAL = time::seconds(300);
75
Vince Lehman72446ec2014-07-09 10:50:02 -050076RibManager::RibManager(ndn::Face& face)
77 : m_face(face)
Junxiao Shi8e273ca2014-11-12 00:42:29 -070078 , m_nfdController(m_face, m_keyChain)
Yingdi Yue5224e92014-04-29 18:04:02 -070079 , m_localhostValidator(m_face)
80 , m_localhopValidator(m_face)
Yingdi Yuf4db0b52014-04-17 13:17:39 -070081 , m_faceMonitor(m_face)
Yingdi Yue5224e92014-04-29 18:04:02 -070082 , m_isLocalhopEnabled(false)
Yanbiao Lic17de832014-11-21 17:51:45 -080083 , m_remoteRegistrator(m_nfdController, m_keyChain, m_managedRib)
Vince Lehmancd16c832014-07-23 15:14:55 -070084 , m_ribStatusPublisher(m_managedRib, face, LIST_COMMAND_PREFIX, m_keyChain)
Vince Lehman4387e782014-06-19 16:57:45 -050085 , m_lastTransactionId(0)
Vince Lehmancd16c832014-07-23 15:14:55 -070086 , m_signedVerbDispatch(SIGNED_COMMAND_VERBS,
87 SIGNED_COMMAND_VERBS +
88 (sizeof(SIGNED_COMMAND_VERBS) / sizeof(SignedVerbAndProcessor)))
89 , m_unsignedVerbDispatch(UNSIGNED_COMMAND_VERBS,
90 UNSIGNED_COMMAND_VERBS +
91 (sizeof(UNSIGNED_COMMAND_VERBS) / sizeof(UnsignedVerbAndProcessor)))
Alexander Afanasyev3ecec502014-04-16 13:42:44 -070092{
93}
94
Vince Lehman26b215c2014-08-17 15:00:41 -050095RibManager::~RibManager()
96{
97 scheduler::cancel(m_activeFaceFetchEvent);
98}
99
Alexander Afanasyev3ecec502014-04-16 13:42:44 -0700100void
Junxiao Shia3295742014-05-16 22:40:10 -0700101RibManager::startListening(const Name& commandPrefix, const ndn::OnInterest& onRequest)
102{
103 NFD_LOG_INFO("Listening on: " << commandPrefix);
104
105 m_nfdController.start<ndn::nfd::FibAddNextHopCommand>(
106 ControlParameters()
107 .setName(commandPrefix)
108 .setFaceId(0),
Vince Lehman7c7d33a2015-01-20 17:40:26 -0600109 bind(&RibManager::onNrdCommandPrefixAddNextHopSuccess, this, cref(commandPrefix), _1),
Junxiao Shia3295742014-05-16 22:40:10 -0700110 bind(&RibManager::onNrdCommandPrefixAddNextHopError, this, cref(commandPrefix), _2));
111
112 m_face.setInterestFilter(commandPrefix, onRequest);
113}
114
115void
Alexander Afanasyev3ecec502014-04-16 13:42:44 -0700116RibManager::registerWithNfd()
117{
118 //check whether the components of localhop and localhost prefixes are same
119 BOOST_ASSERT(COMMAND_PREFIX.size() == REMOTE_COMMAND_PREFIX.size());
120
Junxiao Shia3295742014-05-16 22:40:10 -0700121 this->startListening(COMMAND_PREFIX, bind(&RibManager::onLocalhostRequest, this, _2));
Alexander Afanasyevb3893c92014-05-15 01:49:54 -0700122
Junxiao Shia3295742014-05-16 22:40:10 -0700123 if (m_isLocalhopEnabled) {
124 this->startListening(REMOTE_COMMAND_PREFIX,
125 bind(&RibManager::onLocalhopRequest, this, _2));
126 }
Alexander Afanasyev3ecec502014-04-16 13:42:44 -0700127
Alexander Afanasyev89cf5e02014-04-17 12:08:57 -0700128 NFD_LOG_INFO("Start monitoring face create/destroy events");
Junxiao Shifbf78342015-01-23 14:46:41 -0700129 m_faceMonitor.onNotification.connect(bind(&RibManager::onNotification, this, _1));
Junxiao Shi15b12e72014-08-09 19:56:24 -0700130 m_faceMonitor.start();
Vince Lehmancd613c52014-07-30 14:34:49 -0500131
Vince Lehman26b215c2014-08-17 15:00:41 -0500132 scheduleActiveFaceFetch(ACTIVE_FACE_FETCH_INTERVAL);
Alexander Afanasyev3ecec502014-04-16 13:42:44 -0700133}
134
135void
136RibManager::setConfigFile(ConfigFile& configFile)
137{
Yingdi Yue5224e92014-04-29 18:04:02 -0700138 configFile.addSectionHandler("rib",
Alexander Afanasyev3ecec502014-04-16 13:42:44 -0700139 bind(&RibManager::onConfig, this, _1, _2, _3));
140}
141
142void
143RibManager::onConfig(const ConfigSection& configSection,
Yingdi Yuf4db0b52014-04-17 13:17:39 -0700144 bool isDryRun,
145 const std::string& filename)
Alexander Afanasyev3ecec502014-04-16 13:42:44 -0700146{
Yanbiao Lib9d439d2014-12-11 16:12:32 -0800147 bool isRemoteRegisterEnabled = false;
148
Yingdi Yue5224e92014-04-29 18:04:02 -0700149 for (ConfigSection::const_iterator i = configSection.begin();
150 i != configSection.end(); ++i)
151 {
152 if (i->first == "localhost_security")
153 m_localhostValidator.load(i->second, filename);
154 else if (i->first == "localhop_security")
155 {
156 m_localhopValidator.load(i->second, filename);
157 m_isLocalhopEnabled = true;
158 }
Yanbiao Lic17de832014-11-21 17:51:45 -0800159 else if (i->first == "remote_register")
160 {
161 m_remoteRegistrator.loadConfig(i->second);
Yanbiao Lib9d439d2014-12-11 16:12:32 -0800162 isRemoteRegisterEnabled = true;
163 // avoid other actions when isDryRun == true
164 if (isDryRun)
165 {
166 continue;
167 }
Yanbiao Lic17de832014-11-21 17:51:45 -0800168
Yanbiao Lib9d439d2014-12-11 16:12:32 -0800169 m_remoteRegistrator.enable();
Yanbiao Lic17de832014-11-21 17:51:45 -0800170 }
Yingdi Yue5224e92014-04-29 18:04:02 -0700171 else
172 throw Error("Unrecognized rib property: " + i->first);
173 }
Yanbiao Lib9d439d2014-12-11 16:12:32 -0800174
175 if (!isRemoteRegisterEnabled)
176 {
177 m_remoteRegistrator.disable();
178 }
Alexander Afanasyev3ecec502014-04-16 13:42:44 -0700179}
180
181void
Alexander Afanasyev3ecec502014-04-16 13:42:44 -0700182RibManager::sendResponse(const Name& name,
183 const ControlResponse& response)
184{
185 const Block& encodedControl = response.wireEncode();
186
Alexander Afanasyev97a9c2c2014-07-18 16:57:57 -0700187 shared_ptr<Data> responseData = make_shared<Data>(name);
188 responseData->setContent(encodedControl);
Alexander Afanasyev3ecec502014-04-16 13:42:44 -0700189
Alexander Afanasyev97a9c2c2014-07-18 16:57:57 -0700190 m_keyChain.sign(*responseData);
191 m_face.put(*responseData);
Alexander Afanasyev3ecec502014-04-16 13:42:44 -0700192}
193
194void
195RibManager::sendResponse(const Name& name,
196 uint32_t code,
197 const std::string& text)
198{
199 ControlResponse response(code, text);
200 sendResponse(name, response);
201}
202
203void
Yingdi Yue5224e92014-04-29 18:04:02 -0700204RibManager::onLocalhostRequest(const Interest& request)
Alexander Afanasyev3ecec502014-04-16 13:42:44 -0700205{
Vince Lehmancd16c832014-07-23 15:14:55 -0700206 const Name& command = request.getName();
Yanbiao Lib9d439d2014-12-11 16:12:32 -0800207 const Name::Component& verb = command.get(COMMAND_PREFIX.size());
Vince Lehmancd16c832014-07-23 15:14:55 -0700208
209 UnsignedVerbDispatchTable::const_iterator unsignedVerbProcessor = m_unsignedVerbDispatch.find(verb);
210
211 if (unsignedVerbProcessor != m_unsignedVerbDispatch.end())
212 {
213 NFD_LOG_DEBUG("command result: processing unsigned verb: " << verb);
214 (unsignedVerbProcessor->second)(this, request);
215 }
216 else
217 {
218 m_localhostValidator.validate(request,
219 bind(&RibManager::onCommandValidated, this, _1),
220 bind(&RibManager::onCommandValidationFailed, this, _1, _2));
221 }
Yingdi Yue5224e92014-04-29 18:04:02 -0700222}
223
224void
225RibManager::onLocalhopRequest(const Interest& request)
226{
227 m_localhopValidator.validate(request,
228 bind(&RibManager::onCommandValidated, this, _1),
229 bind(&RibManager::onCommandValidationFailed, this, _1, _2));
Alexander Afanasyev3ecec502014-04-16 13:42:44 -0700230}
231
232void
Alexander Afanasyev20d31442014-04-19 17:00:53 -0700233RibManager::onCommandValidated(const shared_ptr<const Interest>& request)
Alexander Afanasyev3ecec502014-04-16 13:42:44 -0700234{
Alexander Afanasyev20d31442014-04-19 17:00:53 -0700235 // REMOTE_COMMAND_PREFIX number of componenets are same as
Alexander Afanasyev3ecec502014-04-16 13:42:44 -0700236 // NRD_COMMAND_PREFIX's so no extra checks are required.
Alexander Afanasyev3ecec502014-04-16 13:42:44 -0700237
Alexander Afanasyev20d31442014-04-19 17:00:53 -0700238 const Name& command = request->getName();
239 const Name::Component& verb = command[COMMAND_PREFIX.size()];
240 const Name::Component& parameterComponent = command[COMMAND_PREFIX.size() + 1];
241
Vince Lehmancd16c832014-07-23 15:14:55 -0700242 SignedVerbDispatchTable::const_iterator verbProcessor = m_signedVerbDispatch.find(verb);
243 if (verbProcessor != m_signedVerbDispatch.end())
Alexander Afanasyev3ecec502014-04-16 13:42:44 -0700244 {
Alexander Afanasyev20d31442014-04-19 17:00:53 -0700245 ControlParameters parameters;
246 if (!extractParameters(parameterComponent, parameters))
Alexander Afanasyev3ecec502014-04-16 13:42:44 -0700247 {
Alexander Afanasyev20d31442014-04-19 17:00:53 -0700248 NFD_LOG_DEBUG("command result: malformed verb: " << verb);
Syed Obaid3313a372014-07-01 01:31:33 -0500249 if (static_cast<bool>(request))
250 sendResponse(command, 400, "Malformed command");
Alexander Afanasyev3ecec502014-04-16 13:42:44 -0700251 return;
252 }
253
Alexander Afanasyev20d31442014-04-19 17:00:53 -0700254 NFD_LOG_DEBUG("command result: processing verb: " << verb);
255 (verbProcessor->second)(this, request, parameters);
Alexander Afanasyev3ecec502014-04-16 13:42:44 -0700256 }
257 else
258 {
Alexander Afanasyev89cf5e02014-04-17 12:08:57 -0700259 NFD_LOG_DEBUG("Unsupported command: " << verb);
Syed Obaid3313a372014-07-01 01:31:33 -0500260 if (static_cast<bool>(request))
261 sendResponse(request->getName(), 501, "Unsupported command");
Alexander Afanasyev3ecec502014-04-16 13:42:44 -0700262 }
263}
264
265void
Alexander Afanasyev20d31442014-04-19 17:00:53 -0700266RibManager::registerEntry(const shared_ptr<const Interest>& request,
267 ControlParameters& parameters)
268{
269 ndn::nfd::RibRegisterCommand command;
270
271 if (!validateParameters(command, parameters))
272 {
273 NFD_LOG_DEBUG("register result: FAIL reason: malformed");
Vince Lehmancd613c52014-07-30 14:34:49 -0500274
Syed Obaid3313a372014-07-01 01:31:33 -0500275 if (static_cast<bool>(request))
Vince Lehmancd613c52014-07-30 14:34:49 -0500276 {
277 sendResponse(request->getName(), 400, "Malformed command");
278 }
279
Alexander Afanasyev20d31442014-04-19 17:00:53 -0700280 return;
281 }
282
Alexander Afanasyev483efd12014-08-14 10:51:18 -0700283 bool isSelfRegistration = (!parameters.hasFaceId() || parameters.getFaceId() == 0);
284 if (isSelfRegistration)
Alexander Afanasyevfb1c8082014-07-17 15:16:15 -0700285 {
286 parameters.setFaceId(request->getIncomingFaceId());
287 }
288
Vince Lehman218be0a2015-01-15 17:25:20 -0600289 Route route;
290 route.faceId = parameters.getFaceId();
291 route.origin = parameters.getOrigin();
292 route.cost = parameters.getCost();
293 route.flags = parameters.getFlags();
Syed Obaid3313a372014-07-01 01:31:33 -0500294
Alexander Afanasyevf67cf082014-07-18 16:47:29 -0700295 if (parameters.hasExpirationPeriod() &&
296 parameters.getExpirationPeriod() != time::milliseconds::max())
Syed Obaid3313a372014-07-01 01:31:33 -0500297 {
Vince Lehman218be0a2015-01-15 17:25:20 -0600298 route.expires = time::steady_clock::now() + parameters.getExpirationPeriod();
Syed Obaid3313a372014-07-01 01:31:33 -0500299
300 // Schedule a new event, the old one will be cancelled during rib insertion.
Junxiao Shi1e46be32015-01-08 20:18:05 -0700301 scheduler::EventId eventId = scheduler::schedule(parameters.getExpirationPeriod(),
302 bind(&RibManager::expireEntry, this, shared_ptr<Interest>(), parameters));
Vince Lehman218be0a2015-01-15 17:25:20 -0600303 NFD_LOG_TRACE("Scheduled unregistration at: " << route.expires <<
Vince Lehman281ded72014-08-21 12:17:08 -0500304 " with EventId: " << eventId);
Syed Obaid3313a372014-07-01 01:31:33 -0500305
306 //set the NewEventId of this entry
Vince Lehman218be0a2015-01-15 17:25:20 -0600307 route.setExpirationEvent(eventId);
Syed Obaid3313a372014-07-01 01:31:33 -0500308 }
309 else
310 {
Vince Lehman218be0a2015-01-15 17:25:20 -0600311 route.expires = time::steady_clock::TimePoint::max();
Syed Obaid3313a372014-07-01 01:31:33 -0500312 }
Alexander Afanasyev20d31442014-04-19 17:00:53 -0700313
Vince Lehmanff8b3972015-02-20 16:51:21 -0600314 NFD_LOG_INFO("Adding route " << parameters.getName() << " nexthop=" << route.faceId
315 << " origin=" << route.origin
316 << " cost=" << route.cost);
Alexander Afanasyev20d31442014-04-19 17:00:53 -0700317
Vince Lehman218be0a2015-01-15 17:25:20 -0600318 m_managedRib.insert(parameters.getName(), route);
319 m_registeredFaces.insert(route.faceId);
Vince Lehman4387e782014-06-19 16:57:45 -0500320
321 sendUpdatesToFib(request, parameters);
Alexander Afanasyev20d31442014-04-19 17:00:53 -0700322}
323
324void
Vince Lehman281ded72014-08-21 12:17:08 -0500325RibManager::expireEntry(const shared_ptr<const Interest>& request, ControlParameters& params)
326{
Vince Lehman218be0a2015-01-15 17:25:20 -0600327 Route route;
328 route.faceId = params.getFaceId();
329 route.origin = params.getOrigin();
330 route.cost = params.getCost();
331 route.flags = params.getFlags();
Vince Lehman281ded72014-08-21 12:17:08 -0500332
Vince Lehman218be0a2015-01-15 17:25:20 -0600333 NFD_LOG_DEBUG(route << " for " << params.getName() << " has expired");
Vince Lehman281ded72014-08-21 12:17:08 -0500334 unregisterEntry(request, params);
335}
336
337void
Alexander Afanasyev20d31442014-04-19 17:00:53 -0700338RibManager::unregisterEntry(const shared_ptr<const Interest>& request,
Syed Obaid3313a372014-07-01 01:31:33 -0500339 ControlParameters& params)
Alexander Afanasyev20d31442014-04-19 17:00:53 -0700340{
Alexander Afanasyevce7520e2014-04-28 09:40:06 -0700341 ndn::nfd::RibUnregisterCommand command;
Alexander Afanasyev20d31442014-04-19 17:00:53 -0700342
Syed Obaid3313a372014-07-01 01:31:33 -0500343 //passing all parameters gives error in validation.
344 //so passing only the required arguments.
345 ControlParameters parameters;
346 parameters.setName(params.getName());
Alexander Afanasyevb609f002014-07-18 16:56:34 -0700347 if (params.hasFaceId())
348 parameters.setFaceId(params.getFaceId());
349 if (params.hasOrigin())
350 parameters.setOrigin(params.getOrigin());
Syed Obaid3313a372014-07-01 01:31:33 -0500351
Alexander Afanasyev20d31442014-04-19 17:00:53 -0700352 if (!validateParameters(command, parameters))
353 {
Syed Obaid3313a372014-07-01 01:31:33 -0500354 NFD_LOG_DEBUG("unregister result: FAIL reason: malformed");
355 if (static_cast<bool>(request))
356 sendResponse(request->getName(), 400, "Malformed command");
Alexander Afanasyev20d31442014-04-19 17:00:53 -0700357 return;
358 }
359
Alexander Afanasyev483efd12014-08-14 10:51:18 -0700360 bool isSelfRegistration = (!parameters.hasFaceId() || parameters.getFaceId() == 0);
361 if (isSelfRegistration)
Alexander Afanasyevfb1c8082014-07-17 15:16:15 -0700362 {
363 parameters.setFaceId(request->getIncomingFaceId());
364 }
365
Vince Lehman218be0a2015-01-15 17:25:20 -0600366 Route route;
367 route.faceId = parameters.getFaceId();
368 route.origin = parameters.getOrigin();
Alexander Afanasyev20d31442014-04-19 17:00:53 -0700369
Vince Lehmanff8b3972015-02-20 16:51:21 -0600370 NFD_LOG_INFO("Removing route " << parameters.getName() << " nexthop=" << route.faceId
371 << " origin=" << route.origin);
Alexander Afanasyev20d31442014-04-19 17:00:53 -0700372
Vince Lehman218be0a2015-01-15 17:25:20 -0600373 m_managedRib.erase(parameters.getName(), route);
Vince Lehman4387e782014-06-19 16:57:45 -0500374
375 sendUpdatesToFib(request, parameters);
Alexander Afanasyev20d31442014-04-19 17:00:53 -0700376}
377
378void
379RibManager::onCommandValidationFailed(const shared_ptr<const Interest>& request,
380 const std::string& failureInfo)
Alexander Afanasyev3ecec502014-04-16 13:42:44 -0700381{
Alexander Afanasyev89cf5e02014-04-17 12:08:57 -0700382 NFD_LOG_DEBUG("RibRequestValidationFailed: " << failureInfo);
Syed Obaid3313a372014-07-01 01:31:33 -0500383 if (static_cast<bool>(request))
384 sendResponse(request->getName(), 403, failureInfo);
Alexander Afanasyev3ecec502014-04-16 13:42:44 -0700385}
386
Alexander Afanasyev3ecec502014-04-16 13:42:44 -0700387
Alexander Afanasyev20d31442014-04-19 17:00:53 -0700388bool
389RibManager::extractParameters(const Name::Component& parameterComponent,
390 ControlParameters& extractedParameters)
391{
Alexander Afanasyev3ecec502014-04-16 13:42:44 -0700392 try
393 {
Alexander Afanasyev20d31442014-04-19 17:00:53 -0700394 Block rawParameters = parameterComponent.blockFromValue();
395 extractedParameters.wireDecode(rawParameters);
Alexander Afanasyev3ecec502014-04-16 13:42:44 -0700396 }
Junxiao Shi67f11ac2014-10-19 09:29:13 -0700397 catch (const tlv::Error&)
Alexander Afanasyev3ecec502014-04-16 13:42:44 -0700398 {
399 return false;
400 }
401
Alexander Afanasyev20d31442014-04-19 17:00:53 -0700402 NFD_LOG_DEBUG("Parameters parsed OK");
403 return true;
404}
405
406bool
407RibManager::validateParameters(const ControlCommand& command,
408 ControlParameters& parameters)
409{
410 try
Alexander Afanasyev3ecec502014-04-16 13:42:44 -0700411 {
Alexander Afanasyev20d31442014-04-19 17:00:53 -0700412 command.validateRequest(parameters);
Alexander Afanasyev3ecec502014-04-16 13:42:44 -0700413 }
Alexander Afanasyev20d31442014-04-19 17:00:53 -0700414 catch (const ControlCommand::ArgumentError&)
415 {
416 return false;
417 }
418
419 command.applyDefaultsToRequest(parameters);
420
Alexander Afanasyev3ecec502014-04-16 13:42:44 -0700421 return true;
422}
423
424void
425RibManager::onCommandError(uint32_t code, const std::string& error,
Alexander Afanasyev20d31442014-04-19 17:00:53 -0700426 const shared_ptr<const Interest>& request,
Vince Lehman218be0a2015-01-15 17:25:20 -0600427 const Route& route)
Alexander Afanasyev3ecec502014-04-16 13:42:44 -0700428{
Alexander Afanasyev89cf5e02014-04-17 12:08:57 -0700429 NFD_LOG_ERROR("NFD returned an error: " << error << " (code: " << code << ")");
Alexander Afanasyev3ecec502014-04-16 13:42:44 -0700430
431 ControlResponse response;
432
433 if (code == 404)
434 {
435 response.setCode(code);
436 response.setText(error);
437 }
438 else
439 {
440 response.setCode(533);
441 std::ostringstream os;
442 os << "Failure to update NFD " << "(NFD Error: " << code << " " << error << ")";
443 response.setText(os.str());
444 }
445
Syed Obaid3313a372014-07-01 01:31:33 -0500446 if (static_cast<bool>(request))
447 sendResponse(request->getName(), response);
Alexander Afanasyev3ecec502014-04-16 13:42:44 -0700448}
449
450void
Alexander Afanasyev20d31442014-04-19 17:00:53 -0700451RibManager::onRegSuccess(const shared_ptr<const Interest>& request,
452 const ControlParameters& parameters,
Vince Lehman218be0a2015-01-15 17:25:20 -0600453 const Route& route)
Alexander Afanasyev3ecec502014-04-16 13:42:44 -0700454{
455 ControlResponse response;
456
457 response.setCode(200);
458 response.setText("Success");
Alexander Afanasyev20d31442014-04-19 17:00:53 -0700459 response.setBody(parameters.wireEncode());
Alexander Afanasyev3ecec502014-04-16 13:42:44 -0700460
Vince Lehman218be0a2015-01-15 17:25:20 -0600461 NFD_LOG_TRACE("onRegSuccess: registered " << route);
Alexander Afanasyev89cf5e02014-04-17 12:08:57 -0700462
Syed Obaid3313a372014-07-01 01:31:33 -0500463 if (static_cast<bool>(request))
464 sendResponse(request->getName(), response);
Alexander Afanasyev3ecec502014-04-16 13:42:44 -0700465}
466
Alexander Afanasyev20d31442014-04-19 17:00:53 -0700467
Alexander Afanasyev3ecec502014-04-16 13:42:44 -0700468void
Alexander Afanasyev20d31442014-04-19 17:00:53 -0700469RibManager::onUnRegSuccess(const shared_ptr<const Interest>& request,
470 const ControlParameters& parameters,
Vince Lehman218be0a2015-01-15 17:25:20 -0600471 const Route& route)
Alexander Afanasyev3ecec502014-04-16 13:42:44 -0700472{
473 ControlResponse response;
474
475 response.setCode(200);
476 response.setText("Success");
Alexander Afanasyev20d31442014-04-19 17:00:53 -0700477 response.setBody(parameters.wireEncode());
Alexander Afanasyev3ecec502014-04-16 13:42:44 -0700478
Vince Lehman218be0a2015-01-15 17:25:20 -0600479 NFD_LOG_TRACE("onUnRegSuccess: unregistered " << route);
Alexander Afanasyev3ecec502014-04-16 13:42:44 -0700480
Syed Obaid3313a372014-07-01 01:31:33 -0500481 if (static_cast<bool>(request))
482 sendResponse(request->getName(), response);
Vince Lehman4387e782014-06-19 16:57:45 -0500483}
484
485void
486RibManager::sendSuccessResponse(const shared_ptr<const Interest>& request,
487 const ControlParameters& parameters)
488{
489 if (!static_cast<bool>(request))
490 {
491 return;
492 }
493
494 ControlResponse response;
495
496 response.setCode(200);
497 response.setText("Success");
498 response.setBody(parameters.wireEncode());
499
Syed Obaid3313a372014-07-01 01:31:33 -0500500 if (static_cast<bool>(request))
501 sendResponse(request->getName(), response);
Vince Lehman4387e782014-06-19 16:57:45 -0500502}
503
504void
505RibManager::sendErrorResponse(uint32_t code, const std::string& error,
506 const shared_ptr<const Interest>& request)
507{
508 NFD_LOG_ERROR("NFD returned an error: " << error << " (code: " << code << ")");
509
510 if (!static_cast<bool>(request))
511 {
512 return;
513 }
514
515 ControlResponse response;
516
517 if (code == 404)
518 {
519 response.setCode(code);
520 response.setText(error);
521 }
522 else
523 {
524 response.setCode(533);
525 std::ostringstream os;
526 os << "Failure to update NFD " << "(NFD Error: " << code << " " << error << ")";
527 response.setText(os.str());
528 }
529
Syed Obaid3313a372014-07-01 01:31:33 -0500530 if (static_cast<bool>(request))
531 sendResponse(request->getName(), response);
Alexander Afanasyev3ecec502014-04-16 13:42:44 -0700532}
533
Alexander Afanasyev3ecec502014-04-16 13:42:44 -0700534void
Vince Lehman7c7d33a2015-01-20 17:40:26 -0600535RibManager::onNrdCommandPrefixAddNextHopSuccess(const Name& prefix,
536 const ndn::nfd::ControlParameters& result)
Alexander Afanasyevb3893c92014-05-15 01:49:54 -0700537{
538 NFD_LOG_DEBUG("Successfully registered " + prefix.toUri() + " with NFD");
Vince Lehman7c7d33a2015-01-20 17:40:26 -0600539
540 // Routes must be inserted into the RIB so route flags can be applied
541 Route route;
542 route.faceId = result.getFaceId();
543 route.origin = ndn::nfd::ROUTE_ORIGIN_APP;
544 route.expires = time::steady_clock::TimePoint::max();
545 route.flags = ndn::nfd::ROUTE_FLAG_CHILD_INHERIT;
546
547 m_managedRib.insert(prefix, route);
548
549 m_registeredFaces.insert(route.faceId);
550 m_managedRib.clearFibUpdates();
Alexander Afanasyevb3893c92014-05-15 01:49:54 -0700551}
552
553void
554RibManager::onNrdCommandPrefixAddNextHopError(const Name& name, const std::string& msg)
555{
556 throw Error("Error in setting interest filter (" + name.toUri() + "): " + msg);
557}
558
Vince Lehman4387e782014-06-19 16:57:45 -0500559bool
560RibManager::isTransactionComplete(const TransactionId transactionId)
Alexander Afanasyevb3893c92014-05-15 01:49:54 -0700561{
Vince Lehman4387e782014-06-19 16:57:45 -0500562 FibTransactionTable::iterator it = m_pendingFibTransactions.find(transactionId);
563
564 if (it != m_pendingFibTransactions.end())
565 {
566 int& updatesLeft = it->second;
567
568 updatesLeft--;
569
570 // All of the updates have been applied successfully
571 if (updatesLeft == 0)
572 {
573 m_pendingFibTransactions.erase(it);
574 return true;
575 }
576 }
577
578 return false;
Alexander Afanasyevb3893c92014-05-15 01:49:54 -0700579}
580
581void
Vince Lehman4387e782014-06-19 16:57:45 -0500582RibManager::invalidateTransaction(const TransactionId transactionId)
Alexander Afanasyevb3893c92014-05-15 01:49:54 -0700583{
Vince Lehman4387e782014-06-19 16:57:45 -0500584 FibTransactionTable::iterator it = m_pendingFibTransactions.find(transactionId);
585
586 if (it != m_pendingFibTransactions.end())
587 {
588 m_pendingFibTransactions.erase(it);
589 }
590}
591
592void
593RibManager::onAddNextHopSuccess(const shared_ptr<const Interest>& request,
594 const ControlParameters& parameters,
595 const TransactionId transactionId,
596 const bool shouldSendResponse)
597{
598 if (isTransactionComplete(transactionId) && shouldSendResponse)
599 {
600 sendSuccessResponse(request, parameters);
601 }
602}
603
604void
605RibManager::onAddNextHopError(uint32_t code, const std::string& error,
606 const shared_ptr<const Interest>& request,
607 const TransactionId transactionId, const bool shouldSendResponse)
608{
609 invalidateTransaction(transactionId);
610
611 if (shouldSendResponse)
612 {
613 sendErrorResponse(code, error, request);
614 }
Vince Lehman26b215c2014-08-17 15:00:41 -0500615
616 // Since the FIB rejected the update, clean up the invalid face
617 scheduleActiveFaceFetch(time::seconds(1));
Vince Lehman4387e782014-06-19 16:57:45 -0500618}
619
620void
621RibManager::onRemoveNextHopSuccess(const shared_ptr<const Interest>& request,
622 const ControlParameters& parameters,
623 const TransactionId transactionId,
624 const bool shouldSendResponse)
625{
626 if (isTransactionComplete(transactionId) && shouldSendResponse)
627 {
628 sendSuccessResponse(request, parameters);
629 }
630}
631
632void
633RibManager::onRemoveNextHopError(uint32_t code, const std::string& error,
634 const shared_ptr<const Interest>& request,
635 const TransactionId transactionId, const bool shouldSendResponse)
636{
637 invalidateTransaction(transactionId);
638
639 if (shouldSendResponse)
640 {
641 sendErrorResponse(code, error, request);
642 }
Alexander Afanasyevb3893c92014-05-15 01:49:54 -0700643}
644
645void
Alexander Afanasyev3ecec502014-04-16 13:42:44 -0700646RibManager::onControlHeaderSuccess()
647{
Alexander Afanasyev89cf5e02014-04-17 12:08:57 -0700648 NFD_LOG_DEBUG("Local control header enabled");
Alexander Afanasyev3ecec502014-04-16 13:42:44 -0700649}
650
651void
652RibManager::onControlHeaderError(uint32_t code, const std::string& reason)
653{
Alexander Afanasyevb3051652014-04-30 17:50:26 -0700654 std::ostringstream os;
655 os << "Couldn't enable local control header "
656 << "(code: " << code << ", info: " << reason << ")";
657 throw Error(os.str());
Alexander Afanasyev3ecec502014-04-16 13:42:44 -0700658}
659
660void
661RibManager::enableLocalControlHeader()
662{
Alexander Afanasyevb3893c92014-05-15 01:49:54 -0700663 m_nfdController.start<ndn::nfd::FaceEnableLocalControlCommand>(
Alexander Afanasyev3ecec502014-04-16 13:42:44 -0700664 ControlParameters()
665 .setLocalControlFeature(ndn::nfd::LOCAL_CONTROL_FEATURE_INCOMING_FACE_ID),
666 bind(&RibManager::onControlHeaderSuccess, this),
667 bind(&RibManager::onControlHeaderError, this, _1, _2));
668}
669
670void
671RibManager::onNotification(const FaceEventNotification& notification)
672{
Alexander Afanasyev89cf5e02014-04-17 12:08:57 -0700673 NFD_LOG_TRACE("onNotification: " << notification);
Vince Lehmancd613c52014-07-30 14:34:49 -0500674
Vince Lehman26b215c2014-08-17 15:00:41 -0500675 if (notification.getKind() == ndn::nfd::FACE_EVENT_DESTROYED)
Vince Lehmancd613c52014-07-30 14:34:49 -0500676 {
677 NFD_LOG_DEBUG("Received notification for destroyed faceId: " << notification.getFaceId());
Vince Lehmancd613c52014-07-30 14:34:49 -0500678
Alexander Afanasyev63108c42014-07-07 19:10:47 -0700679 scheduler::schedule(time::seconds(0),
680 bind(&RibManager::processErasureAfterNotification, this,
681 notification.getFaceId()));
Vince Lehman4387e782014-06-19 16:57:45 -0500682 }
683}
684
685void
Alexander Afanasyev63108c42014-07-07 19:10:47 -0700686RibManager::processErasureAfterNotification(uint64_t faceId)
687{
688 m_managedRib.erase(faceId);
Vince Lehman26b215c2014-08-17 15:00:41 -0500689 m_registeredFaces.erase(faceId);
Alexander Afanasyev63108c42014-07-07 19:10:47 -0700690
691 sendUpdatesToFibAfterFaceDestroyEvent();
692}
693
694void
Vince Lehman4387e782014-06-19 16:57:45 -0500695RibManager::sendUpdatesToFib(const shared_ptr<const Interest>& request,
696 const ControlParameters& parameters)
697{
698 const Rib::FibUpdateList& updates = m_managedRib.getFibUpdates();
699
700 // If no updates were generated, consider the operation a success
701 if (updates.empty())
702 {
703 sendSuccessResponse(request, parameters);
704 return;
705 }
706
707 bool shouldWaitToRespond = false;
708
709 // An application request should wait for all FIB updates to be applied
710 // successfully before sending a response
711 if (parameters.getOrigin() == ndn::nfd::ROUTE_ORIGIN_APP)
712 {
713 shouldWaitToRespond = true;
714 }
715 else // Respond immediately
716 {
717 sendSuccessResponse(request, parameters);
718 }
719
Vince Lehmanbc05b762014-08-15 15:37:02 -0500720 std::string updateString = (updates.size() == 1) ? " update" : " updates";
721 NFD_LOG_DEBUG("Applying " << updates.size() << updateString << " to FIB");
Vince Lehman4387e782014-06-19 16:57:45 -0500722
723 // Assign an ID to this FIB transaction
724 TransactionId currentTransactionId = ++m_lastTransactionId;
725
726 // Add this transaction to the transaction table
727 m_pendingFibTransactions[currentTransactionId] = updates.size();
728
729 for (Rib::FibUpdateList::const_iterator it = updates.begin(); it != updates.end(); ++it)
730 {
731 shared_ptr<const FibUpdate> update(*it);
Vince Lehmanbc05b762014-08-15 15:37:02 -0500732 NFD_LOG_DEBUG("Sending FIB update: " << *update);
Vince Lehman4387e782014-06-19 16:57:45 -0500733
734 if (update->action == FibUpdate::ADD_NEXTHOP)
735 {
Vince Lehman218be0a2015-01-15 17:25:20 -0600736 Route route;
737 route.faceId = update->faceId;
738 route.cost = update->cost;
Vince Lehman4387e782014-06-19 16:57:45 -0500739
740 m_nfdController.start<ndn::nfd::FibAddNextHopCommand>(
741 ControlParameters()
742 .setName(update->name)
Vince Lehman218be0a2015-01-15 17:25:20 -0600743 .setFaceId(route.faceId)
744 .setCost(route.cost),
Vince Lehman4387e782014-06-19 16:57:45 -0500745 bind(&RibManager::onAddNextHopSuccess, this, request,
746 parameters,
747 currentTransactionId,
748 shouldWaitToRespond),
749 bind(&RibManager::onAddNextHopError, this, _1, _2, request, currentTransactionId,
750 shouldWaitToRespond));
751 }
752 else if (update->action == FibUpdate::REMOVE_NEXTHOP)
753 {
Vince Lehman218be0a2015-01-15 17:25:20 -0600754 Route route;
755 route.faceId = update->faceId;
Vince Lehman4387e782014-06-19 16:57:45 -0500756
757 m_nfdController.start<ndn::nfd::FibRemoveNextHopCommand>(
758 ControlParameters()
759 .setName(update->name)
Vince Lehman218be0a2015-01-15 17:25:20 -0600760 .setFaceId(route.faceId),
Vince Lehman4387e782014-06-19 16:57:45 -0500761 bind(&RibManager::onRemoveNextHopSuccess, this, request,
762 parameters,
763 currentTransactionId,
764 shouldWaitToRespond),
765 bind(&RibManager::onRemoveNextHopError, this, _1, _2, request, currentTransactionId,
766 shouldWaitToRespond));
767 }
768 }
769
770 m_managedRib.clearFibUpdates();
771}
772
773void
774RibManager::sendUpdatesToFibAfterFaceDestroyEvent()
775{
776 ControlParameters parameters;
777 parameters.setOrigin(ndn::nfd::ROUTE_ORIGIN_STATIC);
778
779 sendUpdatesToFib(shared_ptr<const Interest>(), parameters);
Alexander Afanasyev3ecec502014-04-16 13:42:44 -0700780}
781
Vince Lehmancd16c832014-07-23 15:14:55 -0700782void
783RibManager::listEntries(const Interest& request)
784{
785 const Name& command = request.getName();
786 const size_t commandNComps = command.size();
787
788 if (commandNComps < LIST_COMMAND_NCOMPS ||
789 !LIST_COMMAND_PREFIX.isPrefixOf(command))
790 {
791 NFD_LOG_DEBUG("command result: malformed");
792 sendResponse(command, 400, "Malformed command");
793 return;
794 }
795
796 m_ribStatusPublisher.publish();
797}
798
Vince Lehmancd613c52014-07-30 14:34:49 -0500799void
Vince Lehman26b215c2014-08-17 15:00:41 -0500800RibManager::scheduleActiveFaceFetch(const time::seconds& timeToWait)
801{
802 scheduler::cancel(m_activeFaceFetchEvent);
803
804 m_activeFaceFetchEvent = scheduler::schedule(timeToWait,
805 bind(&RibManager::fetchActiveFaces, this));
806}
807
808void
Vince Lehmancd613c52014-07-30 14:34:49 -0500809RibManager::fetchActiveFaces()
810{
811 NFD_LOG_DEBUG("Fetching active faces");
812
813 Interest interest(FACES_LIST_DATASET_PREFIX);
814 interest.setChildSelector(1);
815 interest.setMustBeFresh(true);
816
817 shared_ptr<ndn::OBufferStream> buffer = make_shared<ndn::OBufferStream>();
818
819 m_face.expressInterest(interest,
820 bind(&RibManager::fetchSegments, this, _2, buffer),
821 bind(&RibManager::onFetchFaceStatusTimeout, this));
822}
823
824void
825RibManager::fetchSegments(const Data& data, shared_ptr<ndn::OBufferStream> buffer)
826{
827 buffer->write(reinterpret_cast<const char*>(data.getContent().value()),
828 data.getContent().value_size());
829
830 uint64_t currentSegment = data.getName().get(-1).toSegment();
831
832 const name::Component& finalBlockId = data.getMetaInfo().getFinalBlockId();
833 if (finalBlockId.empty() || finalBlockId.toSegment() > currentSegment)
834 {
835 m_face.expressInterest(data.getName().getPrefix(-1).appendSegment(currentSegment+1),
836 bind(&RibManager::fetchSegments, this, _2, buffer),
837 bind(&RibManager::onFetchFaceStatusTimeout, this));
838 }
839 else
840 {
Vince Lehman26b215c2014-08-17 15:00:41 -0500841 removeInvalidFaces(buffer);
Vince Lehmancd613c52014-07-30 14:34:49 -0500842 }
843}
844
845void
Vince Lehman26b215c2014-08-17 15:00:41 -0500846RibManager::removeInvalidFaces(shared_ptr<ndn::OBufferStream> buffer)
Vince Lehmancd613c52014-07-30 14:34:49 -0500847{
Vince Lehman26b215c2014-08-17 15:00:41 -0500848 NFD_LOG_DEBUG("Checking for invalid face registrations");
Vince Lehmancd613c52014-07-30 14:34:49 -0500849
850 ndn::ConstBufferPtr buf = buffer->buf();
851
852 Block block;
853 size_t offset = 0;
Vince Lehman26b215c2014-08-17 15:00:41 -0500854 FaceIdSet activeFaces;
Vince Lehmancd613c52014-07-30 14:34:49 -0500855
856 while (offset < buf->size())
857 {
858 if (!Block::fromBuffer(buf, offset, block))
859 {
860 std::cerr << "ERROR: cannot decode FaceStatus TLV" << std::endl;
861 break;
862 }
863
864 offset += block.size();
865
866 ndn::nfd::FaceStatus status(block);
Vince Lehmancd613c52014-07-30 14:34:49 -0500867 activeFaces.insert(status.getFaceId());
868 }
Vince Lehman26b215c2014-08-17 15:00:41 -0500869
870 // Look for face IDs that were registered but not active to find missed
871 // face destroyed events
872 for (FaceIdSet::iterator it = m_registeredFaces.begin(); it != m_registeredFaces.end(); ++it)
873 {
874 if (activeFaces.find(*it) == activeFaces.end())
875 {
876 NFD_LOG_DEBUG("Removing invalid face ID: " << *it);
877 scheduler::schedule(time::seconds(0),
878 bind(&RibManager::processErasureAfterNotification, this, *it));
879 }
880 }
881
882 // Reschedule the check for future clean up
883 scheduleActiveFaceFetch(ACTIVE_FACE_FETCH_INTERVAL);
Vince Lehmancd613c52014-07-30 14:34:49 -0500884}
885
886void
887RibManager::onFetchFaceStatusTimeout()
888{
889 std::cerr << "Face Status Dataset request timed out" << std::endl;
Vince Lehman26b215c2014-08-17 15:00:41 -0500890 scheduleActiveFaceFetch(ACTIVE_FACE_FETCH_INTERVAL);
Vince Lehmancd613c52014-07-30 14:34:49 -0500891}
892
Alexander Afanasyev3ecec502014-04-16 13:42:44 -0700893} // namespace rib
894} // namespace nfd