blob: 953703b4e8af5a3f2b7388756760e1ca634b5c31 [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"
Alexander Afanasyev3ecec502014-04-16 13:42:44 -070030
31namespace nfd {
32namespace rib {
33
Alexander Afanasyev89cf5e02014-04-17 12:08:57 -070034NFD_LOG_INIT("RibManager");
35
Alexander Afanasyev20d31442014-04-19 17:00:53 -070036const Name RibManager::COMMAND_PREFIX = "/localhost/nfd/rib";
37const Name RibManager::REMOTE_COMMAND_PREFIX = "/localhop/nfd/rib";
Alexander Afanasyev3ecec502014-04-16 13:42:44 -070038
39const size_t RibManager::COMMAND_UNSIGNED_NCOMPS =
40 RibManager::COMMAND_PREFIX.size() +
41 1 + // verb
42 1; // verb options
43
44const size_t RibManager::COMMAND_SIGNED_NCOMPS =
45 RibManager::COMMAND_UNSIGNED_NCOMPS +
46 4; // (timestamp, nonce, signed info tlv, signature tlv)
47
48const RibManager::VerbAndProcessor RibManager::COMMAND_VERBS[] =
49 {
50 VerbAndProcessor(
51 Name::Component("register"),
Alexander Afanasyev20d31442014-04-19 17:00:53 -070052 &RibManager::registerEntry
Alexander Afanasyev3ecec502014-04-16 13:42:44 -070053 ),
54
55 VerbAndProcessor(
56 Name::Component("unregister"),
Alexander Afanasyev20d31442014-04-19 17:00:53 -070057 &RibManager::unregisterEntry
Alexander Afanasyev3ecec502014-04-16 13:42:44 -070058 ),
59 };
60
Vince Lehman72446ec2014-07-09 10:50:02 -050061RibManager::RibManager(ndn::Face& face)
62 : m_face(face)
Alexander Afanasyevb3893c92014-05-15 01:49:54 -070063 , m_nfdController(m_face)
Yingdi Yue5224e92014-04-29 18:04:02 -070064 , m_localhostValidator(m_face)
65 , m_localhopValidator(m_face)
Yingdi Yuf4db0b52014-04-17 13:17:39 -070066 , m_faceMonitor(m_face)
Yingdi Yue5224e92014-04-29 18:04:02 -070067 , m_isLocalhopEnabled(false)
Vince Lehman4387e782014-06-19 16:57:45 -050068 , m_lastTransactionId(0)
Alexander Afanasyev3ecec502014-04-16 13:42:44 -070069 , m_verbDispatch(COMMAND_VERBS,
70 COMMAND_VERBS + (sizeof(COMMAND_VERBS) / sizeof(VerbAndProcessor)))
71{
72}
73
74void
Junxiao Shia3295742014-05-16 22:40:10 -070075RibManager::startListening(const Name& commandPrefix, const ndn::OnInterest& onRequest)
76{
77 NFD_LOG_INFO("Listening on: " << commandPrefix);
78
79 m_nfdController.start<ndn::nfd::FibAddNextHopCommand>(
80 ControlParameters()
81 .setName(commandPrefix)
82 .setFaceId(0),
83 bind(&RibManager::onNrdCommandPrefixAddNextHopSuccess, this, cref(commandPrefix)),
84 bind(&RibManager::onNrdCommandPrefixAddNextHopError, this, cref(commandPrefix), _2));
85
86 m_face.setInterestFilter(commandPrefix, onRequest);
87}
88
89void
Alexander Afanasyev3ecec502014-04-16 13:42:44 -070090RibManager::registerWithNfd()
91{
92 //check whether the components of localhop and localhost prefixes are same
93 BOOST_ASSERT(COMMAND_PREFIX.size() == REMOTE_COMMAND_PREFIX.size());
94
Junxiao Shia3295742014-05-16 22:40:10 -070095 this->startListening(COMMAND_PREFIX, bind(&RibManager::onLocalhostRequest, this, _2));
Alexander Afanasyevb3893c92014-05-15 01:49:54 -070096
Junxiao Shia3295742014-05-16 22:40:10 -070097 if (m_isLocalhopEnabled) {
98 this->startListening(REMOTE_COMMAND_PREFIX,
99 bind(&RibManager::onLocalhopRequest, this, _2));
100 }
Alexander Afanasyev3ecec502014-04-16 13:42:44 -0700101
Alexander Afanasyev89cf5e02014-04-17 12:08:57 -0700102 NFD_LOG_INFO("Start monitoring face create/destroy events");
Alexander Afanasyevf6980282014-05-13 18:28:40 -0700103 m_faceMonitor.addSubscriber(bind(&RibManager::onNotification, this, _1));
Alexander Afanasyev3ecec502014-04-16 13:42:44 -0700104 m_faceMonitor.startNotifications();
105}
106
107void
108RibManager::setConfigFile(ConfigFile& configFile)
109{
Yingdi Yue5224e92014-04-29 18:04:02 -0700110 configFile.addSectionHandler("rib",
Alexander Afanasyev3ecec502014-04-16 13:42:44 -0700111 bind(&RibManager::onConfig, this, _1, _2, _3));
112}
113
114void
115RibManager::onConfig(const ConfigSection& configSection,
Yingdi Yuf4db0b52014-04-17 13:17:39 -0700116 bool isDryRun,
117 const std::string& filename)
Alexander Afanasyev3ecec502014-04-16 13:42:44 -0700118{
Yingdi Yue5224e92014-04-29 18:04:02 -0700119 for (ConfigSection::const_iterator i = configSection.begin();
120 i != configSection.end(); ++i)
121 {
122 if (i->first == "localhost_security")
123 m_localhostValidator.load(i->second, filename);
124 else if (i->first == "localhop_security")
125 {
126 m_localhopValidator.load(i->second, filename);
127 m_isLocalhopEnabled = true;
128 }
129 else
130 throw Error("Unrecognized rib property: " + i->first);
131 }
Alexander Afanasyev3ecec502014-04-16 13:42:44 -0700132}
133
134void
Alexander Afanasyev3ecec502014-04-16 13:42:44 -0700135RibManager::sendResponse(const Name& name,
136 const ControlResponse& response)
137{
138 const Block& encodedControl = response.wireEncode();
139
140 Data responseData(name);
141 responseData.setContent(encodedControl);
142
143 m_keyChain.sign(responseData);
Yingdi Yuf4db0b52014-04-17 13:17:39 -0700144 m_face.put(responseData);
Alexander Afanasyev3ecec502014-04-16 13:42:44 -0700145}
146
147void
148RibManager::sendResponse(const Name& name,
149 uint32_t code,
150 const std::string& text)
151{
152 ControlResponse response(code, text);
153 sendResponse(name, response);
154}
155
156void
Yingdi Yue5224e92014-04-29 18:04:02 -0700157RibManager::onLocalhostRequest(const Interest& request)
Alexander Afanasyev3ecec502014-04-16 13:42:44 -0700158{
Yingdi Yue5224e92014-04-29 18:04:02 -0700159 m_localhostValidator.validate(request,
160 bind(&RibManager::onCommandValidated, this, _1),
161 bind(&RibManager::onCommandValidationFailed, this, _1, _2));
162}
163
164void
165RibManager::onLocalhopRequest(const Interest& request)
166{
167 m_localhopValidator.validate(request,
168 bind(&RibManager::onCommandValidated, this, _1),
169 bind(&RibManager::onCommandValidationFailed, this, _1, _2));
Alexander Afanasyev3ecec502014-04-16 13:42:44 -0700170}
171
172void
Alexander Afanasyev20d31442014-04-19 17:00:53 -0700173RibManager::onCommandValidated(const shared_ptr<const Interest>& request)
Alexander Afanasyev3ecec502014-04-16 13:42:44 -0700174{
Alexander Afanasyev20d31442014-04-19 17:00:53 -0700175 // REMOTE_COMMAND_PREFIX number of componenets are same as
Alexander Afanasyev3ecec502014-04-16 13:42:44 -0700176 // NRD_COMMAND_PREFIX's so no extra checks are required.
Alexander Afanasyev3ecec502014-04-16 13:42:44 -0700177
Alexander Afanasyev20d31442014-04-19 17:00:53 -0700178 const Name& command = request->getName();
179 const Name::Component& verb = command[COMMAND_PREFIX.size()];
180 const Name::Component& parameterComponent = command[COMMAND_PREFIX.size() + 1];
181
182 VerbDispatchTable::const_iterator verbProcessor = m_verbDispatch.find(verb);
Alexander Afanasyev3ecec502014-04-16 13:42:44 -0700183 if (verbProcessor != m_verbDispatch.end())
184 {
Alexander Afanasyev20d31442014-04-19 17:00:53 -0700185 ControlParameters parameters;
186 if (!extractParameters(parameterComponent, parameters))
Alexander Afanasyev3ecec502014-04-16 13:42:44 -0700187 {
Alexander Afanasyev20d31442014-04-19 17:00:53 -0700188 NFD_LOG_DEBUG("command result: malformed verb: " << verb);
Syed Obaid3313a372014-07-01 01:31:33 -0500189 if (static_cast<bool>(request))
190 sendResponse(command, 400, "Malformed command");
Alexander Afanasyev3ecec502014-04-16 13:42:44 -0700191 return;
192 }
193
Alexander Afanasyev20d31442014-04-19 17:00:53 -0700194 if (!parameters.hasFaceId() || parameters.getFaceId() == 0)
195 {
196 parameters.setFaceId(request->getIncomingFaceId());
197 }
Alexander Afanasyev3ecec502014-04-16 13:42:44 -0700198
Alexander Afanasyev20d31442014-04-19 17:00:53 -0700199 NFD_LOG_DEBUG("command result: processing verb: " << verb);
200 (verbProcessor->second)(this, request, parameters);
Alexander Afanasyev3ecec502014-04-16 13:42:44 -0700201 }
202 else
203 {
Alexander Afanasyev89cf5e02014-04-17 12:08:57 -0700204 NFD_LOG_DEBUG("Unsupported command: " << verb);
Syed Obaid3313a372014-07-01 01:31:33 -0500205 if (static_cast<bool>(request))
206 sendResponse(request->getName(), 501, "Unsupported command");
Alexander Afanasyev3ecec502014-04-16 13:42:44 -0700207 }
208}
209
210void
Alexander Afanasyev20d31442014-04-19 17:00:53 -0700211RibManager::registerEntry(const shared_ptr<const Interest>& request,
212 ControlParameters& parameters)
213{
214 ndn::nfd::RibRegisterCommand command;
215
216 if (!validateParameters(command, parameters))
217 {
218 NFD_LOG_DEBUG("register result: FAIL reason: malformed");
Syed Obaid3313a372014-07-01 01:31:33 -0500219 if (static_cast<bool>(request))
220 sendResponse(request->getName(), 400, "Malformed command");
Alexander Afanasyev20d31442014-04-19 17:00:53 -0700221 return;
222 }
223
Vince12e49462014-06-09 13:29:32 -0500224 FaceEntry faceEntry;
225 faceEntry.faceId = parameters.getFaceId();
226 faceEntry.origin = parameters.getOrigin();
227 faceEntry.cost = parameters.getCost();
228 faceEntry.flags = parameters.getFlags();
Syed Obaid3313a372014-07-01 01:31:33 -0500229
Alexander Afanasyevf67cf082014-07-18 16:47:29 -0700230 if (parameters.hasExpirationPeriod() &&
231 parameters.getExpirationPeriod() != time::milliseconds::max())
Syed Obaid3313a372014-07-01 01:31:33 -0500232 {
233 faceEntry.expires = time::steady_clock::now() + parameters.getExpirationPeriod();
234
235 // Schedule a new event, the old one will be cancelled during rib insertion.
236 EventId eventId;
237 NFD_LOG_TRACE("scheduling unregistration at: " << faceEntry.expires);
238 eventId = scheduler::schedule(parameters.getExpirationPeriod(),
239 bind(&RibManager::unregisterEntry,
240 this, shared_ptr<Interest>(), parameters));
241
242 //set the NewEventId of this entry
243 faceEntry.setExpirationEvent(eventId);
244 }
245 else
246 {
247 faceEntry.expires = time::steady_clock::TimePoint::max();
248 }
Alexander Afanasyev20d31442014-04-19 17:00:53 -0700249
Vince12e49462014-06-09 13:29:32 -0500250 NFD_LOG_TRACE("register prefix: " << faceEntry);
Alexander Afanasyev20d31442014-04-19 17:00:53 -0700251
Vince12e49462014-06-09 13:29:32 -0500252 m_managedRib.insert(parameters.getName(), faceEntry);
Vince Lehman4387e782014-06-19 16:57:45 -0500253
254 sendUpdatesToFib(request, parameters);
Alexander Afanasyev20d31442014-04-19 17:00:53 -0700255}
256
257void
258RibManager::unregisterEntry(const shared_ptr<const Interest>& request,
Syed Obaid3313a372014-07-01 01:31:33 -0500259 ControlParameters& params)
Alexander Afanasyev20d31442014-04-19 17:00:53 -0700260{
Alexander Afanasyevce7520e2014-04-28 09:40:06 -0700261 ndn::nfd::RibUnregisterCommand command;
Alexander Afanasyev20d31442014-04-19 17:00:53 -0700262
Syed Obaid3313a372014-07-01 01:31:33 -0500263 //passing all parameters gives error in validation.
264 //so passing only the required arguments.
265 ControlParameters parameters;
266 parameters.setName(params.getName());
Alexander Afanasyev56356b22014-07-18 16:56:34 -0700267 if (params.hasFaceId())
268 parameters.setFaceId(params.getFaceId());
269 if (params.hasOrigin())
270 parameters.setOrigin(params.getOrigin());
Syed Obaid3313a372014-07-01 01:31:33 -0500271
Alexander Afanasyev20d31442014-04-19 17:00:53 -0700272 if (!validateParameters(command, parameters))
273 {
Syed Obaid3313a372014-07-01 01:31:33 -0500274 NFD_LOG_DEBUG("unregister result: FAIL reason: malformed");
275 if (static_cast<bool>(request))
276 sendResponse(request->getName(), 400, "Malformed command");
Alexander Afanasyev20d31442014-04-19 17:00:53 -0700277 return;
278 }
279
Vince12e49462014-06-09 13:29:32 -0500280 FaceEntry faceEntry;
281 faceEntry.faceId = parameters.getFaceId();
282 faceEntry.origin = parameters.getOrigin();
Alexander Afanasyev20d31442014-04-19 17:00:53 -0700283
Vince12e49462014-06-09 13:29:32 -0500284 NFD_LOG_TRACE("unregister prefix: " << faceEntry);
Alexander Afanasyev20d31442014-04-19 17:00:53 -0700285
Vince Lehman4387e782014-06-19 16:57:45 -0500286 m_managedRib.erase(parameters.getName(), faceEntry);
287
288 sendUpdatesToFib(request, parameters);
Alexander Afanasyev20d31442014-04-19 17:00:53 -0700289}
290
291void
292RibManager::onCommandValidationFailed(const shared_ptr<const Interest>& request,
293 const std::string& failureInfo)
Alexander Afanasyev3ecec502014-04-16 13:42:44 -0700294{
Alexander Afanasyev89cf5e02014-04-17 12:08:57 -0700295 NFD_LOG_DEBUG("RibRequestValidationFailed: " << failureInfo);
Syed Obaid3313a372014-07-01 01:31:33 -0500296 if (static_cast<bool>(request))
297 sendResponse(request->getName(), 403, failureInfo);
Alexander Afanasyev3ecec502014-04-16 13:42:44 -0700298}
299
Alexander Afanasyev3ecec502014-04-16 13:42:44 -0700300
Alexander Afanasyev20d31442014-04-19 17:00:53 -0700301bool
302RibManager::extractParameters(const Name::Component& parameterComponent,
303 ControlParameters& extractedParameters)
304{
Alexander Afanasyev3ecec502014-04-16 13:42:44 -0700305 try
306 {
Alexander Afanasyev20d31442014-04-19 17:00:53 -0700307 Block rawParameters = parameterComponent.blockFromValue();
308 extractedParameters.wireDecode(rawParameters);
Alexander Afanasyev3ecec502014-04-16 13:42:44 -0700309 }
310 catch (const ndn::Tlv::Error& e)
311 {
312 return false;
313 }
314
Alexander Afanasyev20d31442014-04-19 17:00:53 -0700315 NFD_LOG_DEBUG("Parameters parsed OK");
316 return true;
317}
318
319bool
320RibManager::validateParameters(const ControlCommand& command,
321 ControlParameters& parameters)
322{
323 try
Alexander Afanasyev3ecec502014-04-16 13:42:44 -0700324 {
Alexander Afanasyev20d31442014-04-19 17:00:53 -0700325 command.validateRequest(parameters);
Alexander Afanasyev3ecec502014-04-16 13:42:44 -0700326 }
Alexander Afanasyev20d31442014-04-19 17:00:53 -0700327 catch (const ControlCommand::ArgumentError&)
328 {
329 return false;
330 }
331
332 command.applyDefaultsToRequest(parameters);
333
Alexander Afanasyev3ecec502014-04-16 13:42:44 -0700334 return true;
335}
336
337void
338RibManager::onCommandError(uint32_t code, const std::string& error,
Alexander Afanasyev20d31442014-04-19 17:00:53 -0700339 const shared_ptr<const Interest>& request,
Vince12e49462014-06-09 13:29:32 -0500340 const FaceEntry& faceEntry)
Alexander Afanasyev3ecec502014-04-16 13:42:44 -0700341{
Alexander Afanasyev89cf5e02014-04-17 12:08:57 -0700342 NFD_LOG_ERROR("NFD returned an error: " << error << " (code: " << code << ")");
Alexander Afanasyev3ecec502014-04-16 13:42:44 -0700343
344 ControlResponse response;
345
346 if (code == 404)
347 {
348 response.setCode(code);
349 response.setText(error);
350 }
351 else
352 {
353 response.setCode(533);
354 std::ostringstream os;
355 os << "Failure to update NFD " << "(NFD Error: " << code << " " << error << ")";
356 response.setText(os.str());
357 }
358
Syed Obaid3313a372014-07-01 01:31:33 -0500359 if (static_cast<bool>(request))
360 sendResponse(request->getName(), response);
Alexander Afanasyev3ecec502014-04-16 13:42:44 -0700361}
362
363void
Alexander Afanasyev20d31442014-04-19 17:00:53 -0700364RibManager::onRegSuccess(const shared_ptr<const Interest>& request,
365 const ControlParameters& parameters,
Vince12e49462014-06-09 13:29:32 -0500366 const FaceEntry& faceEntry)
Alexander Afanasyev3ecec502014-04-16 13:42:44 -0700367{
368 ControlResponse response;
369
370 response.setCode(200);
371 response.setText("Success");
Alexander Afanasyev20d31442014-04-19 17:00:53 -0700372 response.setBody(parameters.wireEncode());
Alexander Afanasyev3ecec502014-04-16 13:42:44 -0700373
Vince12e49462014-06-09 13:29:32 -0500374 NFD_LOG_TRACE("onRegSuccess: registered " << faceEntry);
Alexander Afanasyev89cf5e02014-04-17 12:08:57 -0700375
Syed Obaid3313a372014-07-01 01:31:33 -0500376 if (static_cast<bool>(request))
377 sendResponse(request->getName(), response);
Alexander Afanasyev3ecec502014-04-16 13:42:44 -0700378}
379
Alexander Afanasyev20d31442014-04-19 17:00:53 -0700380
Alexander Afanasyev3ecec502014-04-16 13:42:44 -0700381void
Alexander Afanasyev20d31442014-04-19 17:00:53 -0700382RibManager::onUnRegSuccess(const shared_ptr<const Interest>& request,
383 const ControlParameters& parameters,
Vince12e49462014-06-09 13:29:32 -0500384 const FaceEntry& faceEntry)
Alexander Afanasyev3ecec502014-04-16 13:42:44 -0700385{
386 ControlResponse response;
387
388 response.setCode(200);
389 response.setText("Success");
Alexander Afanasyev20d31442014-04-19 17:00:53 -0700390 response.setBody(parameters.wireEncode());
Alexander Afanasyev3ecec502014-04-16 13:42:44 -0700391
Vince12e49462014-06-09 13:29:32 -0500392 NFD_LOG_TRACE("onUnRegSuccess: unregistered " << faceEntry);
Alexander Afanasyev3ecec502014-04-16 13:42:44 -0700393
Syed Obaid3313a372014-07-01 01:31:33 -0500394 if (static_cast<bool>(request))
395 sendResponse(request->getName(), response);
Vince Lehman4387e782014-06-19 16:57:45 -0500396}
397
398void
399RibManager::sendSuccessResponse(const shared_ptr<const Interest>& request,
400 const ControlParameters& parameters)
401{
402 if (!static_cast<bool>(request))
403 {
404 return;
405 }
406
407 ControlResponse response;
408
409 response.setCode(200);
410 response.setText("Success");
411 response.setBody(parameters.wireEncode());
412
Syed Obaid3313a372014-07-01 01:31:33 -0500413 if (static_cast<bool>(request))
414 sendResponse(request->getName(), response);
Vince Lehman4387e782014-06-19 16:57:45 -0500415}
416
417void
418RibManager::sendErrorResponse(uint32_t code, const std::string& error,
419 const shared_ptr<const Interest>& request)
420{
421 NFD_LOG_ERROR("NFD returned an error: " << error << " (code: " << code << ")");
422
423 if (!static_cast<bool>(request))
424 {
425 return;
426 }
427
428 ControlResponse response;
429
430 if (code == 404)
431 {
432 response.setCode(code);
433 response.setText(error);
434 }
435 else
436 {
437 response.setCode(533);
438 std::ostringstream os;
439 os << "Failure to update NFD " << "(NFD Error: " << code << " " << error << ")";
440 response.setText(os.str());
441 }
442
Syed Obaid3313a372014-07-01 01:31:33 -0500443 if (static_cast<bool>(request))
444 sendResponse(request->getName(), response);
Alexander Afanasyev3ecec502014-04-16 13:42:44 -0700445}
446
Alexander Afanasyev3ecec502014-04-16 13:42:44 -0700447void
Alexander Afanasyevb3893c92014-05-15 01:49:54 -0700448RibManager::onNrdCommandPrefixAddNextHopSuccess(const Name& prefix)
449{
450 NFD_LOG_DEBUG("Successfully registered " + prefix.toUri() + " with NFD");
451}
452
453void
454RibManager::onNrdCommandPrefixAddNextHopError(const Name& name, const std::string& msg)
455{
456 throw Error("Error in setting interest filter (" + name.toUri() + "): " + msg);
457}
458
Vince Lehman4387e782014-06-19 16:57:45 -0500459bool
460RibManager::isTransactionComplete(const TransactionId transactionId)
Alexander Afanasyevb3893c92014-05-15 01:49:54 -0700461{
Vince Lehman4387e782014-06-19 16:57:45 -0500462 FibTransactionTable::iterator it = m_pendingFibTransactions.find(transactionId);
463
464 if (it != m_pendingFibTransactions.end())
465 {
466 int& updatesLeft = it->second;
467
468 updatesLeft--;
469
470 // All of the updates have been applied successfully
471 if (updatesLeft == 0)
472 {
473 m_pendingFibTransactions.erase(it);
474 return true;
475 }
476 }
477
478 return false;
Alexander Afanasyevb3893c92014-05-15 01:49:54 -0700479}
480
481void
Vince Lehman4387e782014-06-19 16:57:45 -0500482RibManager::invalidateTransaction(const TransactionId transactionId)
Alexander Afanasyevb3893c92014-05-15 01:49:54 -0700483{
Vince Lehman4387e782014-06-19 16:57:45 -0500484 FibTransactionTable::iterator it = m_pendingFibTransactions.find(transactionId);
485
486 if (it != m_pendingFibTransactions.end())
487 {
488 m_pendingFibTransactions.erase(it);
489 }
490}
491
492void
493RibManager::onAddNextHopSuccess(const shared_ptr<const Interest>& request,
494 const ControlParameters& parameters,
495 const TransactionId transactionId,
496 const bool shouldSendResponse)
497{
498 if (isTransactionComplete(transactionId) && shouldSendResponse)
499 {
500 sendSuccessResponse(request, parameters);
501 }
502}
503
504void
505RibManager::onAddNextHopError(uint32_t code, const std::string& error,
506 const shared_ptr<const Interest>& request,
507 const TransactionId transactionId, const bool shouldSendResponse)
508{
509 invalidateTransaction(transactionId);
510
511 if (shouldSendResponse)
512 {
513 sendErrorResponse(code, error, request);
514 }
515}
516
517void
518RibManager::onRemoveNextHopSuccess(const shared_ptr<const Interest>& request,
519 const ControlParameters& parameters,
520 const TransactionId transactionId,
521 const bool shouldSendResponse)
522{
523 if (isTransactionComplete(transactionId) && shouldSendResponse)
524 {
525 sendSuccessResponse(request, parameters);
526 }
527}
528
529void
530RibManager::onRemoveNextHopError(uint32_t code, const std::string& error,
531 const shared_ptr<const Interest>& request,
532 const TransactionId transactionId, const bool shouldSendResponse)
533{
534 invalidateTransaction(transactionId);
535
536 if (shouldSendResponse)
537 {
538 sendErrorResponse(code, error, request);
539 }
Alexander Afanasyevb3893c92014-05-15 01:49:54 -0700540}
541
542void
Alexander Afanasyev3ecec502014-04-16 13:42:44 -0700543RibManager::onControlHeaderSuccess()
544{
Alexander Afanasyev89cf5e02014-04-17 12:08:57 -0700545 NFD_LOG_DEBUG("Local control header enabled");
Alexander Afanasyev3ecec502014-04-16 13:42:44 -0700546}
547
548void
549RibManager::onControlHeaderError(uint32_t code, const std::string& reason)
550{
Alexander Afanasyevb3051652014-04-30 17:50:26 -0700551 std::ostringstream os;
552 os << "Couldn't enable local control header "
553 << "(code: " << code << ", info: " << reason << ")";
554 throw Error(os.str());
Alexander Afanasyev3ecec502014-04-16 13:42:44 -0700555}
556
557void
558RibManager::enableLocalControlHeader()
559{
Alexander Afanasyevb3893c92014-05-15 01:49:54 -0700560 m_nfdController.start<ndn::nfd::FaceEnableLocalControlCommand>(
Alexander Afanasyev3ecec502014-04-16 13:42:44 -0700561 ControlParameters()
562 .setLocalControlFeature(ndn::nfd::LOCAL_CONTROL_FEATURE_INCOMING_FACE_ID),
563 bind(&RibManager::onControlHeaderSuccess, this),
564 bind(&RibManager::onControlHeaderError, this, _1, _2));
565}
566
567void
568RibManager::onNotification(const FaceEventNotification& notification)
569{
570 /// \todo A notification can be missed, in this case check Facelist
Alexander Afanasyev89cf5e02014-04-17 12:08:57 -0700571 NFD_LOG_TRACE("onNotification: " << notification);
Vince Lehman4387e782014-06-19 16:57:45 -0500572 if (notification.getKind() == ndn::nfd::FACE_EVENT_DESTROYED) //face destroyed
573 {
Alexander Afanasyev63108c42014-07-07 19:10:47 -0700574 scheduler::schedule(time::seconds(0),
575 bind(&RibManager::processErasureAfterNotification, this,
576 notification.getFaceId()));
Vince Lehman4387e782014-06-19 16:57:45 -0500577 }
578}
579
580void
Alexander Afanasyev63108c42014-07-07 19:10:47 -0700581RibManager::processErasureAfterNotification(uint64_t faceId)
582{
583 m_managedRib.erase(faceId);
584
585 sendUpdatesToFibAfterFaceDestroyEvent();
586}
587
588void
Vince Lehman4387e782014-06-19 16:57:45 -0500589RibManager::sendUpdatesToFib(const shared_ptr<const Interest>& request,
590 const ControlParameters& parameters)
591{
592 const Rib::FibUpdateList& updates = m_managedRib.getFibUpdates();
593
594 // If no updates were generated, consider the operation a success
595 if (updates.empty())
596 {
597 sendSuccessResponse(request, parameters);
598 return;
599 }
600
601 bool shouldWaitToRespond = false;
602
603 // An application request should wait for all FIB updates to be applied
604 // successfully before sending a response
605 if (parameters.getOrigin() == ndn::nfd::ROUTE_ORIGIN_APP)
606 {
607 shouldWaitToRespond = true;
608 }
609 else // Respond immediately
610 {
611 sendSuccessResponse(request, parameters);
612 }
613
614 NFD_LOG_DEBUG("Applying " << updates.size() << " updates to FIB");
615
616 // Assign an ID to this FIB transaction
617 TransactionId currentTransactionId = ++m_lastTransactionId;
618
619 // Add this transaction to the transaction table
620 m_pendingFibTransactions[currentTransactionId] = updates.size();
621
622 for (Rib::FibUpdateList::const_iterator it = updates.begin(); it != updates.end(); ++it)
623 {
624 shared_ptr<const FibUpdate> update(*it);
625
626 if (update->action == FibUpdate::ADD_NEXTHOP)
627 {
628 FaceEntry faceEntry;
629 faceEntry.faceId = update->faceId;
630 faceEntry.cost = update->cost;
631
632 m_nfdController.start<ndn::nfd::FibAddNextHopCommand>(
633 ControlParameters()
634 .setName(update->name)
635 .setFaceId(faceEntry.faceId)
636 .setCost(faceEntry.cost),
637 bind(&RibManager::onAddNextHopSuccess, this, request,
638 parameters,
639 currentTransactionId,
640 shouldWaitToRespond),
641 bind(&RibManager::onAddNextHopError, this, _1, _2, request, currentTransactionId,
642 shouldWaitToRespond));
643 }
644 else if (update->action == FibUpdate::REMOVE_NEXTHOP)
645 {
646 FaceEntry faceEntry;
647 faceEntry.faceId = update->faceId;
648
649 m_nfdController.start<ndn::nfd::FibRemoveNextHopCommand>(
650 ControlParameters()
651 .setName(update->name)
652 .setFaceId(faceEntry.faceId),
653 bind(&RibManager::onRemoveNextHopSuccess, this, request,
654 parameters,
655 currentTransactionId,
656 shouldWaitToRespond),
657 bind(&RibManager::onRemoveNextHopError, this, _1, _2, request, currentTransactionId,
658 shouldWaitToRespond));
659 }
660 }
661
662 m_managedRib.clearFibUpdates();
663}
664
665void
666RibManager::sendUpdatesToFibAfterFaceDestroyEvent()
667{
668 ControlParameters parameters;
669 parameters.setOrigin(ndn::nfd::ROUTE_ORIGIN_STATIC);
670
671 sendUpdatesToFib(shared_ptr<const Interest>(), parameters);
Alexander Afanasyev3ecec502014-04-16 13:42:44 -0700672}
673
674} // namespace rib
675} // namespace nfd