31 #include <ndn-cxx/lp/tags.hpp> 32 #include <ndn-cxx/mgmt/nfd/control-command.hpp> 33 #include <ndn-cxx/mgmt/nfd/control-parameters.hpp> 34 #include <ndn-cxx/mgmt/nfd/control-response.hpp> 35 #include <ndn-cxx/mgmt/nfd/face-status.hpp> 36 #include <ndn-cxx/mgmt/nfd/rib-entry.hpp> 50 ndn::nfd::Controller& nfdController, Dispatcher& dispatcher,
51 ndn::util::Scheduler& scheduler)
54 , m_keyChain(keyChain)
55 , m_nfdController(nfdController)
56 , m_dispatcher(dispatcher)
57 , m_scheduler(scheduler)
59 , m_localhostValidator(face)
60 , m_localhopValidator(face)
61 , m_isLocalhopEnabled(false)
63 registerCommandHandler<ndn::nfd::RibRegisterCommand>(
"register",
64 bind(&RibManager::registerEntry,
this, _2, _3, _4, _5));
65 registerCommandHandler<ndn::nfd::RibUnregisterCommand>(
"unregister",
66 bind(&RibManager::unregisterEntry,
this, _2, _3, _4, _5));
74 m_localhostValidator.load(section, filename);
80 m_localhopValidator.load(section, filename);
81 m_isLocalhopEnabled =
true;
87 m_isLocalhopEnabled =
false;
93 registerTopPrefix(LOCALHOST_TOP_PREFIX);
95 if (m_isLocalhopEnabled) {
99 NFD_LOG_INFO(
"Start monitoring face create/destroy events");
100 m_faceMonitor.onNotification.connect(bind(&RibManager::onNotification,
this, _1));
101 m_faceMonitor.start();
103 scheduleActiveFaceFetch(ACTIVE_FACE_FETCH_INTERVAL);
109 m_nfdController.start<ndn::nfd::FaceUpdateCommand>(
110 ControlParameters().setFlagBit(ndn::nfd::BIT_LOCAL_FIELDS_ENABLED,
true),
111 [] (
const ControlParameters& res) {
114 [] (
const ControlResponse& res) {
115 BOOST_THROW_EXCEPTION(
Error(
"Couldn't enable local fields (" + to_string(res.getCode()) +
116 " " + res.getText() +
")"));
121 RibManager::beginAddRoute(
const Name& name,
Route route, optional<time::nanoseconds> expires,
122 const std::function<
void(RibUpdateResult)>& done)
125 route.
expires = time::steady_clock::now() + *expires;
128 expires = *route.
expires - time::steady_clock::now();
131 if (expires && *expires <= 0_s) {
133 return done(RibUpdateResult::EXPIRED);
137 " origin=" << route.
origin <<
" cost=" << route.
cost);
140 auto event = m_scheduler.scheduleEvent(*expires, [=] { m_rib.
onRouteExpiration(name, route); });
145 m_registeredFaces.insert(route.
faceId);
151 beginRibUpdate(update, done);
155 RibManager::beginRemoveRoute(
const Name& name,
const Route& route,
156 const std::function<
void(RibUpdateResult)>& done)
159 " origin=" << route.
origin);
165 beginRibUpdate(update, done);
169 RibManager::beginRibUpdate(
const RibUpdate& update,
170 const std::function<
void(RibUpdateResult)>& done)
175 done(RibUpdateResult::OK);
177 [=] (uint32_t code,
const std::string& error) {
178 NFD_LOG_DEBUG(
"RIB update failed for " << update <<
" (" << code <<
" " << error <<
")");
181 scheduleActiveFaceFetch(1_s);
183 done(RibUpdateResult::ERROR);
188 RibManager::registerTopPrefix(
const Name& topPrefix)
191 m_nfdController.start<ndn::nfd::FibAddNextHopCommand>(
192 ControlParameters().setName(Name(topPrefix).append(MGMT_MODULE_NAME))
194 [=] (
const ControlParameters& res) {
195 NFD_LOG_DEBUG(
"Successfully registered " << topPrefix <<
" with NFD");
199 route.
faceId = res.getFaceId();
200 route.
origin = ndn::nfd::ROUTE_ORIGIN_APP;
201 route.
flags = ndn::nfd::ROUTE_FLAG_CHILD_INHERIT;
203 m_rib.
insert(topPrefix, route);
205 m_registeredFaces.insert(route.
faceId);
207 [=] (
const ControlResponse& res) {
208 BOOST_THROW_EXCEPTION(
Error(
"Cannot add FIB entry " + topPrefix.toUri() +
" (" +
209 to_string(res.getCode()) +
" " + res.getText() +
")"));
213 m_dispatcher.addTopPrefix(topPrefix,
false);
217 RibManager::registerEntry(
const Name& topPrefix,
const Interest& interest,
218 ControlParameters parameters,
219 const ndn::mgmt::CommandContinuation& done)
222 done(ControlResponse(414,
"Route prefix cannot exceed " + ndn::to_string(
FIB_MAX_DEPTH) +
227 setFaceForSelfRegistration(interest, parameters);
230 done(ControlResponse(200,
"Success").setBody(parameters.wireEncode()));
233 route.
faceId = parameters.getFaceId();
234 route.
origin = parameters.getOrigin();
235 route.
cost = parameters.getCost();
236 route.
flags = parameters.getFlags();
238 optional<time::nanoseconds> expires;
239 if (parameters.hasExpirationPeriod() &&
240 parameters.getExpirationPeriod() != time::milliseconds::max()) {
241 expires = time::duration_cast<time::nanoseconds>(parameters.getExpirationPeriod());
244 beginAddRoute(parameters.getName(), std::move(route), expires, [] (RibUpdateResult) {});
248 RibManager::unregisterEntry(
const Name& topPrefix,
const Interest& interest,
249 ControlParameters parameters,
250 const ndn::mgmt::CommandContinuation& done)
252 setFaceForSelfRegistration(interest, parameters);
255 done(ControlResponse(200,
"Success").setBody(parameters.wireEncode()));
258 route.
faceId = parameters.getFaceId();
259 route.
origin = parameters.getOrigin();
261 beginRemoveRoute(parameters.getName(), route, [] (RibUpdateResult) {});
265 RibManager::listEntries(
const Name& topPrefix,
const Interest& interest,
266 ndn::mgmt::StatusDatasetContext& context)
268 auto now = time::steady_clock::now();
269 for (
const auto& kv : m_rib) {
271 ndn::nfd::RibEntry item;
275 r.setFaceId(route.
faceId);
276 r.setOrigin(route.
origin);
277 r.setCost(route.
cost);
278 r.setFlags(route.
flags);
280 r.setExpirationPeriod(time::duration_cast<time::milliseconds>(*route.
expires - now));
284 context.append(item.wireEncode());
290 RibManager::setFaceForSelfRegistration(
const Interest& request, ControlParameters& parameters)
292 bool isSelfRegistration = (parameters.getFaceId() == 0);
293 if (isSelfRegistration) {
294 shared_ptr<lp::IncomingFaceIdTag> incomingFaceIdTag = request.getTag<lp::IncomingFaceIdTag>();
298 BOOST_ASSERT(incomingFaceIdTag !=
nullptr);
299 parameters.setFaceId(*incomingFaceIdTag);
303 ndn::mgmt::Authorization
304 RibManager::makeAuthorization(
const std::string& verb)
306 return [
this] (
const Name& prefix,
const Interest& interest,
307 const ndn::mgmt::ControlParameters* params,
308 const ndn::mgmt::AcceptContinuation& accept,
309 const ndn::mgmt::RejectContinuation& reject) {
310 BOOST_ASSERT(params !=
nullptr);
311 BOOST_ASSERT(
typeid(*params) ==
typeid(ndn::nfd::ControlParameters));
314 ndn::ValidatorConfig& validator = prefix == LOCALHOST_TOP_PREFIX ?
315 m_localhostValidator : m_localhopValidator;
316 validator.validate(interest,
318 bind([reject] { reject(ndn::mgmt::RejectReply::STATUS403); }));
329 return os <<
"ERROR";
331 return os <<
"VALIDATION_FAILURE";
333 return os <<
"EXPIRED";
335 return os <<
"NOT_FOUND";
337 BOOST_ASSERT_MSG(
false,
"bad SlAnnounceResult");
342 RibManager::getSlAnnounceResultFromRibUpdateResult(RibUpdateResult r)
345 case RibUpdateResult::OK:
347 case RibUpdateResult::ERROR:
349 case RibUpdateResult::EXPIRED:
361 BOOST_ASSERT(pa.getData());
363 if (!m_isLocalhopEnabled) {
364 NFD_LOG_INFO(
"slAnnounce " << pa.getAnnouncedName() <<
" " << faceId <<
365 ": localhop_security unconfigured");
370 m_localhopValidator.validate(*pa.getData(),
372 Route route(pa, faceId);
373 route.
expires = std::min(route.
annExpires, time::steady_clock::now() + maxLifetime);
374 beginAddRoute(pa.getAnnouncedName(), route, nullopt,
375 [=] (RibUpdateResult ribRes) {
376 auto res = getSlAnnounceResultFromRibUpdateResult(ribRes);
377 NFD_LOG_INFO(
"slAnnounce " << pa.getAnnouncedName() <<
" " << faceId <<
": " << res);
381 [=] (
const Data&, ndn::security::v2::ValidationError err) {
382 NFD_LOG_INFO(
"slAnnounce " << pa.getAnnouncedName() <<
" " << faceId <<
383 " validation error: " << err);
394 routeQuery.
faceId = faceId;
395 routeQuery.
origin = ndn::nfd::ROUTE_ORIGIN_PREFIXANN;
399 NFD_LOG_DEBUG(
"slRenew " << name <<
" " << faceId <<
": not found");
402 Name routeName = oldRoute->
announcement->getAnnouncedName();
404 Route route = *oldRoute;
405 route.
expires = std::min(route.
annExpires, time::steady_clock::now() + maxLifetime);
406 beginAddRoute(routeName, route, nullopt,
407 [=] (RibUpdateResult ribRes) {
408 auto res = getSlAnnounceResultFromRibUpdateResult(ribRes);
409 NFD_LOG_INFO(
"slRenew " << name <<
" " << faceId <<
": " << res <<
" " << routeName);
417 shared_ptr<RibEntry> entry;
418 auto exactMatch = m_rib.
find(name);
419 if (exactMatch != m_rib.
end()) {
420 entry = exactMatch->second;
425 if (entry ==
nullptr) {
429 auto pa = entry->getPrefixAnnouncement();
430 pa.toData(m_keyChain);
435 RibManager::fetchActiveFaces()
439 m_nfdController.fetch<ndn::nfd::FaceDataset>(
440 bind(&RibManager::removeInvalidFaces,
this, _1),
441 bind(&RibManager::onFetchActiveFacesFailure,
this, _1, _2),
442 ndn::nfd::CommandOptions());
446 RibManager::onFetchActiveFacesFailure(uint32_t code,
const std::string& reason)
448 NFD_LOG_DEBUG(
"Face Status Dataset request failure " << code <<
" " << reason);
449 scheduleActiveFaceFetch(ACTIVE_FACE_FETCH_INTERVAL);
453 RibManager::onFaceDestroyedEvent(uint64_t faceId)
456 m_registeredFaces.erase(faceId);
460 RibManager::scheduleActiveFaceFetch(
const time::seconds& timeToWait)
462 m_activeFaceFetchEvent = m_scheduler.scheduleEvent(timeToWait, [
this] { fetchActiveFaces(); });
466 RibManager::removeInvalidFaces(
const std::vector<ndn::nfd::FaceStatus>& activeFaces)
470 FaceIdSet activeFaceIds;
471 for (
const auto& faceStatus : activeFaces) {
472 activeFaceIds.insert(faceStatus.getFaceId());
477 for (
auto faceId : m_registeredFaces) {
478 if (activeFaceIds.count(faceId) == 0) {
480 m_scheduler.scheduleEvent(0_ns, [
this, faceId] { this->onFaceDestroyedEvent(faceId); });
485 scheduleActiveFaceFetch(ACTIVE_FACE_FETCH_INTERVAL);
489 RibManager::onNotification(
const ndn::nfd::FaceEventNotification& notification)
493 if (notification.getKind() == ndn::nfd::FACE_EVENT_DESTROYED) {
494 NFD_LOG_DEBUG(
"Received notification for destroyed faceId: " << notification.getFaceId());
495 m_scheduler.scheduleEvent(0_ns, [
this,
id = notification.getFaceId()] { onFaceDestroyedEvent(
id); });
route does not exist (slRenew only)
void registerStatusDatasetHandler(const std::string &verb, const ndn::mgmt::StatusDatasetHandler &handler)
RibUpdate & setRoute(const Route &route)
void slFindAnn(const Name &name, const SlFindAnnCallback &cb) const
Retrieve an outgoing prefix announcement for self-learning strategy.
represents the Routing Information Base
std::ostream & operator<<(std::ostream &os, const FibUpdate &update)
optional< ndn::PrefixAnnouncement > announcement
The prefix announcement that caused the creation of this route.
static const Name LOCALHOP_TOP_PREFIX
RibUpdate & setAction(Action action)
static const time::seconds ACTIVE_FACE_FETCH_INTERVAL
std::function< void(SlAnnounceResult res)> SlAnnounceCallback
const_iterator find(const Name &prefix) const
void setName(const Name &prefix)
void enableLocalhop(const ConfigSection §ion, const std::string &filename)
Apply localhop_security configuration and allow accepting commands on /localhop/nfd/rib prefix...
void registerWithNfd()
Start accepting commands and dataset requests.
void applyLocalhostConfig(const ConfigSection §ion, const std::string &filename)
Apply localhost_security configuration.
const_iterator end() const
void enableLocalFields()
Enable NDNLP IncomingFaceId field in order to support self-registration commands. ...
RibUpdate & setName(const Name &name)
a collection of common functions shared by all NFD managers and RIB manager, such as communicating wi...
void setExpirationEvent(const ndn::util::scheduler::EventId &eid)
boost::property_tree::ptree ConfigSection
a config file section
RIB and FIB have been updated.
the announcement has expired
optional< time::steady_clock::TimePoint > expires
Copyright (c) 2014-2015, Regents of the University of California, Arizona Board of Regents...
const Name & getName() const
time::steady_clock::TimePoint annExpires
Expiration time of the prefix announcement.
void slRenew(const Name &name, uint64_t faceId, time::milliseconds maxLifetime, const SlAnnounceCallback &cb)
Renew a route created by prefix announcement from self-learning strategy.
const RouteList & getRoutes() const
ndn::nfd::RouteOrigin origin
void insert(const Name &prefix, const Route &route)
represents a route for a name prefix
static const std::string MGMT_MODULE_NAME
Route * findLongestPrefix(const Name &prefix, const Route &route) const
void extractRequester(const Interest &interest, ndn::mgmt::AcceptContinuation accept)
extract a requester from a ControlCommand request
the announcement cannot be verified against the trust schema
static const int FIB_MAX_DEPTH
Maximum number of components in a FIB entry prefix.
void disableLocalhop()
Disallow accepting commands on /localhop/nfd/rib prefix.
#define NFD_LOG_INIT(name)
std::function< void(optional< ndn::PrefixAnnouncement >)> SlFindAnnCallback
static const Name LOCALHOST_TOP_PREFIX
Represents a RIB entry, which contains one or more Routes with the same prefix.
void beginRemoveFace(uint64_t faceId)
starts the FIB update process when a face has been destroyed
void slAnnounce(const ndn::PrefixAnnouncement &pa, uint64_t faceId, time::milliseconds maxLifetime, const SlAnnounceCallback &cb)
Insert a route by prefix announcement from self-learning strategy.
void onRouteExpiration(const Name &prefix, const Route &route)
void beginApplyUpdate(const RibUpdate &update, const UpdateSuccessCallback &onSuccess, const UpdateFailureCallback &onFailure)
passes the provided RibUpdateBatch to FibUpdater to calculate and send FibUpdates.
RibManager(Rib &rib, ndn::Face &face, ndn::KeyChain &keyChain, ndn::nfd::Controller &nfdController, Dispatcher &dispatcher, ndn::util::Scheduler &scheduler)
shared_ptr< RibEntry > findParent(const Name &prefix) const
std::underlying_type< ndn::nfd::RouteFlags >::type flags