rib-manager.hpp

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2014-2025,  Regents of the University of California,
 *                           Arizona Board of Regents,
 *                           Colorado State University,
 *                           University Pierre & Marie Curie, Sorbonne University,
 *                           Washington University in St. Louis,
 *                           Beijing Institute of Technology,
 *                           The University of Memphis.
 *
 * This file is part of NFD (Named Data Networking Forwarding Daemon).
 * See AUTHORS.md for complete list of NFD authors and contributors.
 *
 * NFD is free software: you can redistribute it and/or modify it under the terms
 * of the GNU General Public License as published by the Free Software Foundation,
 * either version 3 of the License, or (at your option) any later version.
 *
 * NFD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
 * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
 * PURPOSE.  See the GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along with
 * NFD, e.g., in COPYING.md file.  If not, see <http://www.gnu.org/licenses/>.
 */
 
#ifndef NFD_DAEMON_MGMT_RIB_MANAGER_HPP
#define NFD_DAEMON_MGMT_RIB_MANAGER_HPP
 
#include "manager-base.hpp"
 
#include <ndn-cxx/mgmt/nfd/controller.hpp>
#include <ndn-cxx/mgmt/nfd/face-event-notification.hpp>
#include <ndn-cxx/mgmt/nfd/face-monitor.hpp>
#include <ndn-cxx/mgmt/nfd/face-status.hpp>
#include <ndn-cxx/security/validator-config.hpp>
#include <ndn-cxx/util/scheduler.hpp>
 
namespace nfd {
 
namespace rib {
class Route;
class Rib;
struct RibUpdate;
} // namespace rib
 
class RibManager final : public ManagerBase
{
public:
  RibManager(rib::Rib& rib, ndn::Face& face, ndn::KeyChain& keyChain,
             ndn::nfd::Controller& nfdController, Dispatcher& dispatcher);
 
  void
  applyLocalhostConfig(const ConfigSection& section, const std::string& filename);
 
  void
  enableLocalhop(const ConfigSection& section, const std::string& filename);
 
  void
  disableLocalhop();
 
  void
  applyPaConfig(const ConfigSection& section, const std::string& filename);
 
  void
  registerWithNfd();
 
  void
  enableLocalFields();
 
public: // self-learning support
  enum class SlAnnounceResult {
    OK,                 
    ERROR,              
    VALIDATION_FAILURE, 
    EXPIRED,            
    NOT_FOUND,          
  };
 
  using SlAnnounceCallback = std::function<void(SlAnnounceResult res)>;
  using SlFindAnnCallback = std::function<void(std::optional<ndn::PrefixAnnouncement>)>;
 
  void
  slAnnounce(const ndn::PrefixAnnouncement& pa, uint64_t faceId, time::milliseconds maxLifetime,
             const SlAnnounceCallback& cb);
 
  void
  slRenew(const Name& name, uint64_t faceId, time::milliseconds maxLifetime,
          const SlAnnounceCallback& cb);
 
  void
  slFindAnn(const Name& name, const SlFindAnnCallback& cb) const;
 
private: // RIB update actions
  enum class RibUpdateResult
  {
    OK,
    ERROR,
    EXPIRED,
  };
 
  static SlAnnounceResult
  getSlAnnounceResultFromRibUpdateResult(RibUpdateResult r);
 
  void
  addRoute(const Name& name, rib::Route route, const time::steady_clock::time_point& now,
           const std::function<void(RibUpdateResult)>& done = nullptr);
 
  void
  beginRibUpdate(const rib::RibUpdate& update,
                 const std::function<void(RibUpdateResult)>& done);
 
private: // management Dispatcher related
  void
  registerTopPrefix(const Name& topPrefix);
 
  void
  registerEntry(const Interest& interest, ControlParameters parameters,
                const CommandContinuation& done);
 
  void
  unregisterEntry(const Interest& interest, ControlParameters parameters,
                  const CommandContinuation& done);
 
  void
  announceEntry(const Interest& interest, const ndn::nfd::RibAnnounceParameters& parameters,
                const CommandContinuation& done);
 
  void
  listEntries(ndn::mgmt::StatusDatasetContext& context) const;
 
  ndn::mgmt::Authorization
  makeAuthorization(const std::string& verb) final;
 
private: // Face monitor
  void
  fetchActiveFaces();
 
NFD_PUBLIC_WITH_TESTS_ELSE_PRIVATE:
  void
  scheduleActiveFaceFetch(time::seconds timeToWait);
 
  void
  removeInvalidFaces(const std::vector<ndn::nfd::FaceStatus>& activeFaces);
 
  void
  onNotification(const ndn::nfd::FaceEventNotification& notification);
 
public:
  static inline const Name LOCALHOP_TOP_PREFIX{"/localhop/nfd"};
 
private:
  rib::Rib& m_rib;
  ndn::KeyChain& m_keyChain;
  ndn::nfd::Controller& m_nfdController;
  Dispatcher& m_dispatcher;
 
  ndn::nfd::FaceMonitor m_faceMonitor;
  ndn::ValidatorConfig m_localhostValidator;
  ndn::ValidatorConfig m_localhopValidator;
  ndn::ValidatorConfig m_paValidator;
  bool m_isLocalhopEnabled;
 
  ndn::scheduler::ScopedEventId m_activeFaceFetchEvent;
};
 
std::ostream&
operator<<(std::ostream& os, RibManager::SlAnnounceResult res);
 
} // namespace nfd
 
#endif // NFD_DAEMON_MGMT_RIB_MANAGER_HPP