blob: 7d0f5b3168b5d4e95afad2495a6f43b7eb1047eb [file] [log] [blame]
Alexander Afanasyev3ecec502014-04-16 13:42:44 -07001/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2/**
Vince12e49462014-06-09 13:29:32 -05003 * Copyright (c) 2014, 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),
109 bind(&RibManager::onNrdCommandPrefixAddNextHopSuccess, this, cref(commandPrefix)),
110 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 Shi15b12e72014-08-09 19:56:24 -0700129 m_faceMonitor.onNotification += bind(&RibManager::onNotification, this, _1);
130 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
Vince12e49462014-06-09 13:29:32 -0500289 FaceEntry faceEntry;
290 faceEntry.faceId = parameters.getFaceId();
291 faceEntry.origin = parameters.getOrigin();
292 faceEntry.cost = parameters.getCost();
293 faceEntry.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 {
298 faceEntry.expires = time::steady_clock::now() + parameters.getExpirationPeriod();
299
300 // Schedule a new event, the old one will be cancelled during rib insertion.
301 EventId eventId;
Syed Obaid3313a372014-07-01 01:31:33 -0500302 eventId = scheduler::schedule(parameters.getExpirationPeriod(),
Vince Lehman281ded72014-08-21 12:17:08 -0500303 bind(&RibManager::expireEntry,
Syed Obaid3313a372014-07-01 01:31:33 -0500304 this, shared_ptr<Interest>(), parameters));
Vince Lehman281ded72014-08-21 12:17:08 -0500305 NFD_LOG_TRACE("Scheduled unregistration at: " << faceEntry.expires <<
306 " with EventId: " << eventId);
Syed Obaid3313a372014-07-01 01:31:33 -0500307
308 //set the NewEventId of this entry
309 faceEntry.setExpirationEvent(eventId);
310 }
311 else
312 {
313 faceEntry.expires = time::steady_clock::TimePoint::max();
314 }
Alexander Afanasyev20d31442014-04-19 17:00:53 -0700315
Vince12e49462014-06-09 13:29:32 -0500316 NFD_LOG_TRACE("register prefix: " << faceEntry);
Alexander Afanasyev20d31442014-04-19 17:00:53 -0700317
Vince12e49462014-06-09 13:29:32 -0500318 m_managedRib.insert(parameters.getName(), faceEntry);
Vince Lehman26b215c2014-08-17 15:00:41 -0500319 m_registeredFaces.insert(faceEntry.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{
327 FaceEntry face;
328 face.faceId = params.getFaceId();
329 face.origin = params.getOrigin();
330 face.cost = params.getCost();
331 face.flags = params.getFlags();
332
333 NFD_LOG_DEBUG(face << " for " << params.getName() << " has expired");
334 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
Vince12e49462014-06-09 13:29:32 -0500366 FaceEntry faceEntry;
367 faceEntry.faceId = parameters.getFaceId();
368 faceEntry.origin = parameters.getOrigin();
Alexander Afanasyev20d31442014-04-19 17:00:53 -0700369
Vince12e49462014-06-09 13:29:32 -0500370 NFD_LOG_TRACE("unregister prefix: " << faceEntry);
Alexander Afanasyev20d31442014-04-19 17:00:53 -0700371
Vince Lehman4387e782014-06-19 16:57:45 -0500372 m_managedRib.erase(parameters.getName(), faceEntry);
373
374 sendUpdatesToFib(request, parameters);
Alexander Afanasyev20d31442014-04-19 17:00:53 -0700375}
376
377void
378RibManager::onCommandValidationFailed(const shared_ptr<const Interest>& request,
379 const std::string& failureInfo)
Alexander Afanasyev3ecec502014-04-16 13:42:44 -0700380{
Alexander Afanasyev89cf5e02014-04-17 12:08:57 -0700381 NFD_LOG_DEBUG("RibRequestValidationFailed: " << failureInfo);
Syed Obaid3313a372014-07-01 01:31:33 -0500382 if (static_cast<bool>(request))
383 sendResponse(request->getName(), 403, failureInfo);
Alexander Afanasyev3ecec502014-04-16 13:42:44 -0700384}
385
Alexander Afanasyev3ecec502014-04-16 13:42:44 -0700386
Alexander Afanasyev20d31442014-04-19 17:00:53 -0700387bool
388RibManager::extractParameters(const Name::Component& parameterComponent,
389 ControlParameters& extractedParameters)
390{
Alexander Afanasyev3ecec502014-04-16 13:42:44 -0700391 try
392 {
Alexander Afanasyev20d31442014-04-19 17:00:53 -0700393 Block rawParameters = parameterComponent.blockFromValue();
394 extractedParameters.wireDecode(rawParameters);
Alexander Afanasyev3ecec502014-04-16 13:42:44 -0700395 }
Junxiao Shi67f11ac2014-10-19 09:29:13 -0700396 catch (const tlv::Error&)
Alexander Afanasyev3ecec502014-04-16 13:42:44 -0700397 {
398 return false;
399 }
400
Alexander Afanasyev20d31442014-04-19 17:00:53 -0700401 NFD_LOG_DEBUG("Parameters parsed OK");
402 return true;
403}
404
405bool
406RibManager::validateParameters(const ControlCommand& command,
407 ControlParameters& parameters)
408{
409 try
Alexander Afanasyev3ecec502014-04-16 13:42:44 -0700410 {
Alexander Afanasyev20d31442014-04-19 17:00:53 -0700411 command.validateRequest(parameters);
Alexander Afanasyev3ecec502014-04-16 13:42:44 -0700412 }
Alexander Afanasyev20d31442014-04-19 17:00:53 -0700413 catch (const ControlCommand::ArgumentError&)
414 {
415 return false;
416 }
417
418 command.applyDefaultsToRequest(parameters);
419
Alexander Afanasyev3ecec502014-04-16 13:42:44 -0700420 return true;
421}
422
423void
424RibManager::onCommandError(uint32_t code, const std::string& error,
Alexander Afanasyev20d31442014-04-19 17:00:53 -0700425 const shared_ptr<const Interest>& request,
Vince12e49462014-06-09 13:29:32 -0500426 const FaceEntry& faceEntry)
Alexander Afanasyev3ecec502014-04-16 13:42:44 -0700427{
Alexander Afanasyev89cf5e02014-04-17 12:08:57 -0700428 NFD_LOG_ERROR("NFD returned an error: " << error << " (code: " << code << ")");
Alexander Afanasyev3ecec502014-04-16 13:42:44 -0700429
430 ControlResponse response;
431
432 if (code == 404)
433 {
434 response.setCode(code);
435 response.setText(error);
436 }
437 else
438 {
439 response.setCode(533);
440 std::ostringstream os;
441 os << "Failure to update NFD " << "(NFD Error: " << code << " " << error << ")";
442 response.setText(os.str());
443 }
444
Syed Obaid3313a372014-07-01 01:31:33 -0500445 if (static_cast<bool>(request))
446 sendResponse(request->getName(), response);
Alexander Afanasyev3ecec502014-04-16 13:42:44 -0700447}
448
449void
Alexander Afanasyev20d31442014-04-19 17:00:53 -0700450RibManager::onRegSuccess(const shared_ptr<const Interest>& request,
451 const ControlParameters& parameters,
Vince12e49462014-06-09 13:29:32 -0500452 const FaceEntry& faceEntry)
Alexander Afanasyev3ecec502014-04-16 13:42:44 -0700453{
454 ControlResponse response;
455
456 response.setCode(200);
457 response.setText("Success");
Alexander Afanasyev20d31442014-04-19 17:00:53 -0700458 response.setBody(parameters.wireEncode());
Alexander Afanasyev3ecec502014-04-16 13:42:44 -0700459
Vince12e49462014-06-09 13:29:32 -0500460 NFD_LOG_TRACE("onRegSuccess: registered " << faceEntry);
Alexander Afanasyev89cf5e02014-04-17 12:08:57 -0700461
Syed Obaid3313a372014-07-01 01:31:33 -0500462 if (static_cast<bool>(request))
463 sendResponse(request->getName(), response);
Alexander Afanasyev3ecec502014-04-16 13:42:44 -0700464}
465
Alexander Afanasyev20d31442014-04-19 17:00:53 -0700466
Alexander Afanasyev3ecec502014-04-16 13:42:44 -0700467void
Alexander Afanasyev20d31442014-04-19 17:00:53 -0700468RibManager::onUnRegSuccess(const shared_ptr<const Interest>& request,
469 const ControlParameters& parameters,
Vince12e49462014-06-09 13:29:32 -0500470 const FaceEntry& faceEntry)
Alexander Afanasyev3ecec502014-04-16 13:42:44 -0700471{
472 ControlResponse response;
473
474 response.setCode(200);
475 response.setText("Success");
Alexander Afanasyev20d31442014-04-19 17:00:53 -0700476 response.setBody(parameters.wireEncode());
Alexander Afanasyev3ecec502014-04-16 13:42:44 -0700477
Vince12e49462014-06-09 13:29:32 -0500478 NFD_LOG_TRACE("onUnRegSuccess: unregistered " << faceEntry);
Alexander Afanasyev3ecec502014-04-16 13:42:44 -0700479
Syed Obaid3313a372014-07-01 01:31:33 -0500480 if (static_cast<bool>(request))
481 sendResponse(request->getName(), response);
Vince Lehman4387e782014-06-19 16:57:45 -0500482}
483
484void
485RibManager::sendSuccessResponse(const shared_ptr<const Interest>& request,
486 const ControlParameters& parameters)
487{
488 if (!static_cast<bool>(request))
489 {
490 return;
491 }
492
493 ControlResponse response;
494
495 response.setCode(200);
496 response.setText("Success");
497 response.setBody(parameters.wireEncode());
498
Syed Obaid3313a372014-07-01 01:31:33 -0500499 if (static_cast<bool>(request))
500 sendResponse(request->getName(), response);
Vince Lehman4387e782014-06-19 16:57:45 -0500501}
502
503void
504RibManager::sendErrorResponse(uint32_t code, const std::string& error,
505 const shared_ptr<const Interest>& request)
506{
507 NFD_LOG_ERROR("NFD returned an error: " << error << " (code: " << code << ")");
508
509 if (!static_cast<bool>(request))
510 {
511 return;
512 }
513
514 ControlResponse response;
515
516 if (code == 404)
517 {
518 response.setCode(code);
519 response.setText(error);
520 }
521 else
522 {
523 response.setCode(533);
524 std::ostringstream os;
525 os << "Failure to update NFD " << "(NFD Error: " << code << " " << error << ")";
526 response.setText(os.str());
527 }
528
Syed Obaid3313a372014-07-01 01:31:33 -0500529 if (static_cast<bool>(request))
530 sendResponse(request->getName(), response);
Alexander Afanasyev3ecec502014-04-16 13:42:44 -0700531}
532
Alexander Afanasyev3ecec502014-04-16 13:42:44 -0700533void
Alexander Afanasyevb3893c92014-05-15 01:49:54 -0700534RibManager::onNrdCommandPrefixAddNextHopSuccess(const Name& prefix)
535{
536 NFD_LOG_DEBUG("Successfully registered " + prefix.toUri() + " with NFD");
537}
538
539void
540RibManager::onNrdCommandPrefixAddNextHopError(const Name& name, const std::string& msg)
541{
542 throw Error("Error in setting interest filter (" + name.toUri() + "): " + msg);
543}
544
Vince Lehman4387e782014-06-19 16:57:45 -0500545bool
546RibManager::isTransactionComplete(const TransactionId transactionId)
Alexander Afanasyevb3893c92014-05-15 01:49:54 -0700547{
Vince Lehman4387e782014-06-19 16:57:45 -0500548 FibTransactionTable::iterator it = m_pendingFibTransactions.find(transactionId);
549
550 if (it != m_pendingFibTransactions.end())
551 {
552 int& updatesLeft = it->second;
553
554 updatesLeft--;
555
556 // All of the updates have been applied successfully
557 if (updatesLeft == 0)
558 {
559 m_pendingFibTransactions.erase(it);
560 return true;
561 }
562 }
563
564 return false;
Alexander Afanasyevb3893c92014-05-15 01:49:54 -0700565}
566
567void
Vince Lehman4387e782014-06-19 16:57:45 -0500568RibManager::invalidateTransaction(const TransactionId transactionId)
Alexander Afanasyevb3893c92014-05-15 01:49:54 -0700569{
Vince Lehman4387e782014-06-19 16:57:45 -0500570 FibTransactionTable::iterator it = m_pendingFibTransactions.find(transactionId);
571
572 if (it != m_pendingFibTransactions.end())
573 {
574 m_pendingFibTransactions.erase(it);
575 }
576}
577
578void
579RibManager::onAddNextHopSuccess(const shared_ptr<const Interest>& request,
580 const ControlParameters& parameters,
581 const TransactionId transactionId,
582 const bool shouldSendResponse)
583{
584 if (isTransactionComplete(transactionId) && shouldSendResponse)
585 {
586 sendSuccessResponse(request, parameters);
587 }
588}
589
590void
591RibManager::onAddNextHopError(uint32_t code, const std::string& error,
592 const shared_ptr<const Interest>& request,
593 const TransactionId transactionId, const bool shouldSendResponse)
594{
595 invalidateTransaction(transactionId);
596
597 if (shouldSendResponse)
598 {
599 sendErrorResponse(code, error, request);
600 }
Vince Lehman26b215c2014-08-17 15:00:41 -0500601
602 // Since the FIB rejected the update, clean up the invalid face
603 scheduleActiveFaceFetch(time::seconds(1));
Vince Lehman4387e782014-06-19 16:57:45 -0500604}
605
606void
607RibManager::onRemoveNextHopSuccess(const shared_ptr<const Interest>& request,
608 const ControlParameters& parameters,
609 const TransactionId transactionId,
610 const bool shouldSendResponse)
611{
612 if (isTransactionComplete(transactionId) && shouldSendResponse)
613 {
614 sendSuccessResponse(request, parameters);
615 }
616}
617
618void
619RibManager::onRemoveNextHopError(uint32_t code, const std::string& error,
620 const shared_ptr<const Interest>& request,
621 const TransactionId transactionId, const bool shouldSendResponse)
622{
623 invalidateTransaction(transactionId);
624
625 if (shouldSendResponse)
626 {
627 sendErrorResponse(code, error, request);
628 }
Alexander Afanasyevb3893c92014-05-15 01:49:54 -0700629}
630
631void
Alexander Afanasyev3ecec502014-04-16 13:42:44 -0700632RibManager::onControlHeaderSuccess()
633{
Alexander Afanasyev89cf5e02014-04-17 12:08:57 -0700634 NFD_LOG_DEBUG("Local control header enabled");
Alexander Afanasyev3ecec502014-04-16 13:42:44 -0700635}
636
637void
638RibManager::onControlHeaderError(uint32_t code, const std::string& reason)
639{
Alexander Afanasyevb3051652014-04-30 17:50:26 -0700640 std::ostringstream os;
641 os << "Couldn't enable local control header "
642 << "(code: " << code << ", info: " << reason << ")";
643 throw Error(os.str());
Alexander Afanasyev3ecec502014-04-16 13:42:44 -0700644}
645
646void
647RibManager::enableLocalControlHeader()
648{
Alexander Afanasyevb3893c92014-05-15 01:49:54 -0700649 m_nfdController.start<ndn::nfd::FaceEnableLocalControlCommand>(
Alexander Afanasyev3ecec502014-04-16 13:42:44 -0700650 ControlParameters()
651 .setLocalControlFeature(ndn::nfd::LOCAL_CONTROL_FEATURE_INCOMING_FACE_ID),
652 bind(&RibManager::onControlHeaderSuccess, this),
653 bind(&RibManager::onControlHeaderError, this, _1, _2));
654}
655
656void
657RibManager::onNotification(const FaceEventNotification& notification)
658{
Alexander Afanasyev89cf5e02014-04-17 12:08:57 -0700659 NFD_LOG_TRACE("onNotification: " << notification);
Vince Lehmancd613c52014-07-30 14:34:49 -0500660
Vince Lehman26b215c2014-08-17 15:00:41 -0500661 if (notification.getKind() == ndn::nfd::FACE_EVENT_DESTROYED)
Vince Lehmancd613c52014-07-30 14:34:49 -0500662 {
663 NFD_LOG_DEBUG("Received notification for destroyed faceId: " << notification.getFaceId());
Vince Lehmancd613c52014-07-30 14:34:49 -0500664
Alexander Afanasyev63108c42014-07-07 19:10:47 -0700665 scheduler::schedule(time::seconds(0),
666 bind(&RibManager::processErasureAfterNotification, this,
667 notification.getFaceId()));
Vince Lehman4387e782014-06-19 16:57:45 -0500668 }
669}
670
671void
Alexander Afanasyev63108c42014-07-07 19:10:47 -0700672RibManager::processErasureAfterNotification(uint64_t faceId)
673{
674 m_managedRib.erase(faceId);
Vince Lehman26b215c2014-08-17 15:00:41 -0500675 m_registeredFaces.erase(faceId);
Alexander Afanasyev63108c42014-07-07 19:10:47 -0700676
677 sendUpdatesToFibAfterFaceDestroyEvent();
678}
679
680void
Vince Lehman4387e782014-06-19 16:57:45 -0500681RibManager::sendUpdatesToFib(const shared_ptr<const Interest>& request,
682 const ControlParameters& parameters)
683{
684 const Rib::FibUpdateList& updates = m_managedRib.getFibUpdates();
685
686 // If no updates were generated, consider the operation a success
687 if (updates.empty())
688 {
689 sendSuccessResponse(request, parameters);
690 return;
691 }
692
693 bool shouldWaitToRespond = false;
694
695 // An application request should wait for all FIB updates to be applied
696 // successfully before sending a response
697 if (parameters.getOrigin() == ndn::nfd::ROUTE_ORIGIN_APP)
698 {
699 shouldWaitToRespond = true;
700 }
701 else // Respond immediately
702 {
703 sendSuccessResponse(request, parameters);
704 }
705
Vince Lehmanbc05b762014-08-15 15:37:02 -0500706 std::string updateString = (updates.size() == 1) ? " update" : " updates";
707 NFD_LOG_DEBUG("Applying " << updates.size() << updateString << " to FIB");
Vince Lehman4387e782014-06-19 16:57:45 -0500708
709 // Assign an ID to this FIB transaction
710 TransactionId currentTransactionId = ++m_lastTransactionId;
711
712 // Add this transaction to the transaction table
713 m_pendingFibTransactions[currentTransactionId] = updates.size();
714
715 for (Rib::FibUpdateList::const_iterator it = updates.begin(); it != updates.end(); ++it)
716 {
717 shared_ptr<const FibUpdate> update(*it);
Vince Lehmanbc05b762014-08-15 15:37:02 -0500718 NFD_LOG_DEBUG("Sending FIB update: " << *update);
Vince Lehman4387e782014-06-19 16:57:45 -0500719
720 if (update->action == FibUpdate::ADD_NEXTHOP)
721 {
722 FaceEntry faceEntry;
723 faceEntry.faceId = update->faceId;
724 faceEntry.cost = update->cost;
725
726 m_nfdController.start<ndn::nfd::FibAddNextHopCommand>(
727 ControlParameters()
728 .setName(update->name)
729 .setFaceId(faceEntry.faceId)
730 .setCost(faceEntry.cost),
731 bind(&RibManager::onAddNextHopSuccess, this, request,
732 parameters,
733 currentTransactionId,
734 shouldWaitToRespond),
735 bind(&RibManager::onAddNextHopError, this, _1, _2, request, currentTransactionId,
736 shouldWaitToRespond));
737 }
738 else if (update->action == FibUpdate::REMOVE_NEXTHOP)
739 {
740 FaceEntry faceEntry;
741 faceEntry.faceId = update->faceId;
742
743 m_nfdController.start<ndn::nfd::FibRemoveNextHopCommand>(
744 ControlParameters()
745 .setName(update->name)
746 .setFaceId(faceEntry.faceId),
747 bind(&RibManager::onRemoveNextHopSuccess, this, request,
748 parameters,
749 currentTransactionId,
750 shouldWaitToRespond),
751 bind(&RibManager::onRemoveNextHopError, this, _1, _2, request, currentTransactionId,
752 shouldWaitToRespond));
753 }
754 }
755
756 m_managedRib.clearFibUpdates();
757}
758
759void
760RibManager::sendUpdatesToFibAfterFaceDestroyEvent()
761{
762 ControlParameters parameters;
763 parameters.setOrigin(ndn::nfd::ROUTE_ORIGIN_STATIC);
764
765 sendUpdatesToFib(shared_ptr<const Interest>(), parameters);
Alexander Afanasyev3ecec502014-04-16 13:42:44 -0700766}
767
Vince Lehmancd16c832014-07-23 15:14:55 -0700768void
769RibManager::listEntries(const Interest& request)
770{
771 const Name& command = request.getName();
772 const size_t commandNComps = command.size();
773
774 if (commandNComps < LIST_COMMAND_NCOMPS ||
775 !LIST_COMMAND_PREFIX.isPrefixOf(command))
776 {
777 NFD_LOG_DEBUG("command result: malformed");
778 sendResponse(command, 400, "Malformed command");
779 return;
780 }
781
782 m_ribStatusPublisher.publish();
783}
784
Vince Lehmancd613c52014-07-30 14:34:49 -0500785void
Vince Lehman26b215c2014-08-17 15:00:41 -0500786RibManager::scheduleActiveFaceFetch(const time::seconds& timeToWait)
787{
788 scheduler::cancel(m_activeFaceFetchEvent);
789
790 m_activeFaceFetchEvent = scheduler::schedule(timeToWait,
791 bind(&RibManager::fetchActiveFaces, this));
792}
793
794void
Vince Lehmancd613c52014-07-30 14:34:49 -0500795RibManager::fetchActiveFaces()
796{
797 NFD_LOG_DEBUG("Fetching active faces");
798
799 Interest interest(FACES_LIST_DATASET_PREFIX);
800 interest.setChildSelector(1);
801 interest.setMustBeFresh(true);
802
803 shared_ptr<ndn::OBufferStream> buffer = make_shared<ndn::OBufferStream>();
804
805 m_face.expressInterest(interest,
806 bind(&RibManager::fetchSegments, this, _2, buffer),
807 bind(&RibManager::onFetchFaceStatusTimeout, this));
808}
809
810void
811RibManager::fetchSegments(const Data& data, shared_ptr<ndn::OBufferStream> buffer)
812{
813 buffer->write(reinterpret_cast<const char*>(data.getContent().value()),
814 data.getContent().value_size());
815
816 uint64_t currentSegment = data.getName().get(-1).toSegment();
817
818 const name::Component& finalBlockId = data.getMetaInfo().getFinalBlockId();
819 if (finalBlockId.empty() || finalBlockId.toSegment() > currentSegment)
820 {
821 m_face.expressInterest(data.getName().getPrefix(-1).appendSegment(currentSegment+1),
822 bind(&RibManager::fetchSegments, this, _2, buffer),
823 bind(&RibManager::onFetchFaceStatusTimeout, this));
824 }
825 else
826 {
Vince Lehman26b215c2014-08-17 15:00:41 -0500827 removeInvalidFaces(buffer);
Vince Lehmancd613c52014-07-30 14:34:49 -0500828 }
829}
830
831void
Vince Lehman26b215c2014-08-17 15:00:41 -0500832RibManager::removeInvalidFaces(shared_ptr<ndn::OBufferStream> buffer)
Vince Lehmancd613c52014-07-30 14:34:49 -0500833{
Vince Lehman26b215c2014-08-17 15:00:41 -0500834 NFD_LOG_DEBUG("Checking for invalid face registrations");
Vince Lehmancd613c52014-07-30 14:34:49 -0500835
836 ndn::ConstBufferPtr buf = buffer->buf();
837
838 Block block;
839 size_t offset = 0;
Vince Lehman26b215c2014-08-17 15:00:41 -0500840 FaceIdSet activeFaces;
Vince Lehmancd613c52014-07-30 14:34:49 -0500841
842 while (offset < buf->size())
843 {
844 if (!Block::fromBuffer(buf, offset, block))
845 {
846 std::cerr << "ERROR: cannot decode FaceStatus TLV" << std::endl;
847 break;
848 }
849
850 offset += block.size();
851
852 ndn::nfd::FaceStatus status(block);
Vince Lehmancd613c52014-07-30 14:34:49 -0500853 activeFaces.insert(status.getFaceId());
854 }
Vince Lehman26b215c2014-08-17 15:00:41 -0500855
856 // Look for face IDs that were registered but not active to find missed
857 // face destroyed events
858 for (FaceIdSet::iterator it = m_registeredFaces.begin(); it != m_registeredFaces.end(); ++it)
859 {
860 if (activeFaces.find(*it) == activeFaces.end())
861 {
862 NFD_LOG_DEBUG("Removing invalid face ID: " << *it);
863 scheduler::schedule(time::seconds(0),
864 bind(&RibManager::processErasureAfterNotification, this, *it));
865 }
866 }
867
868 // Reschedule the check for future clean up
869 scheduleActiveFaceFetch(ACTIVE_FACE_FETCH_INTERVAL);
Vince Lehmancd613c52014-07-30 14:34:49 -0500870}
871
872void
873RibManager::onFetchFaceStatusTimeout()
874{
875 std::cerr << "Face Status Dataset request timed out" << std::endl;
Vince Lehman26b215c2014-08-17 15:00:41 -0500876 scheduleActiveFaceFetch(ACTIVE_FACE_FETCH_INTERVAL);
Vince Lehmancd613c52014-07-30 14:34:49 -0500877}
878
Alexander Afanasyev3ecec502014-04-16 13:42:44 -0700879} // namespace rib
880} // namespace nfd