fib.hpp

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2014-2025,  The University of Memphis,
 *                           Regents of the University of California,
 *                           Arizona Board of Regents.
 *
 * This file is part of NLSR (Named-data Link State Routing).
 * See AUTHORS.md for complete list of NLSR authors and contributors.
 *
 * NLSR 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.
 *
 * NLSR 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
 * NLSR, e.g., in COPYING.md file.  If not, see <http://www.gnu.org/licenses/>.
 */
 
#ifndef NLSR_ROUTE_FIB_HPP
#define NLSR_ROUTE_FIB_HPP
 
#include "test-access-control.hpp"
#include "nexthop-list.hpp"
 
#include <ndn-cxx/mgmt/nfd/controller.hpp>
#include <ndn-cxx/util/scheduler.hpp>
#include <ndn-cxx/util/time.hpp>
 
namespace nlsr {
 
using NextHopsUriSortedSet = NexthopListT<NextHopUriSortedComparator>;
 
struct FibEntry
{
  ndn::Name name;
  ndn::scheduler::ScopedEventId refreshEventId;
  int32_t seqNo = 1;
  NextHopsUriSortedSet nexthopSet;
};
 
using AfterRefreshCallback = std::function<void(FibEntry&, uint64_t)>;
 
class AdjacencyList;
class ConfParameter;
 
class Fib
{
public:
  Fib(ndn::Face& face, ndn::Scheduler& scheduler, AdjacencyList& adjacencyList,
      ConfParameter& conf, ndn::security::KeyChain& keyChain);
 
  void
  remove(const ndn::Name& name);
 
  void
  update(const ndn::Name& name, const NexthopList& allHops, uint64_t routeFlags);
 
  void
  setEntryRefreshTime(int32_t fert)
  {
    m_refreshTime = fert;
  }
 
  void
  registerPrefix(const ndn::Name& namePrefix,
                 const ndn::FaceUri& faceUri,
                 uint64_t faceCost,
                 const ndn::time::milliseconds& timeout,
                 uint64_t flags,
                 uint8_t times);
 
  void
  setStrategy(const ndn::Name& name, const ndn::Name& strategy, uint32_t count);
 
  void
  writeLog();
 
private:
  bool
  isNotNeighbor(const ndn::Name& name);
 
  void
  addNextHopsToFibEntryAndNfd(FibEntry& entry, const NextHopsUriSortedSet& hopsToAdd, uint64_t routeFlags);
 
  unsigned int
  getNumberOfFacesForName(const NexthopList& nextHopList);
 
  void
  unregisterPrefix(const ndn::Name& namePrefix, const ndn::FaceUri& faceUri);
 
  void
  onRegistrationSuccess(const ndn::nfd::ControlParameters& param,
                        const ndn::FaceUri& faceUri);
 
  void
  onRegistrationFailure(const ndn::nfd::ControlResponse& response,
                        const ndn::nfd::ControlParameters& parameters,
                        const ndn::FaceUri& faceUri,
                        uint8_t times);
 
  void
  onSetStrategySuccess(const ndn::nfd::ControlParameters& commandSuccessResult);
 
  void
  onSetStrategyFailure(const ndn::nfd::ControlResponse& response,
                       const ndn::nfd::ControlParameters& parameters,
                       uint32_t count);
 
PUBLIC_WITH_TESTS_ELSE_PRIVATE:
  void
  scheduleEntryRefresh(FibEntry& entry, uint64_t routeFlags, const AfterRefreshCallback& refreshCb);
 
private:
  void
  scheduleLoop(FibEntry& entry, uint64_t routeFlags);
 
  void
  refreshEntry(const ndn::Name& name, uint64_t routeFlags, AfterRefreshCallback refreshCb);
 
public:
  static inline const ndn::Name MULTICAST_STRATEGY{"/localhost/nfd/strategy/multicast"};
  static inline const ndn::Name BEST_ROUTE_STRATEGY{"/localhost/nfd/strategy/best-route"};
 
  ndn::signal::Signal<Fib, ndn::Name> onPrefixRegistrationSuccess;
 
private:
  ndn::Scheduler& m_scheduler;
  int32_t m_refreshTime;
  ndn::nfd::Controller m_controller;
 
PUBLIC_WITH_TESTS_ELSE_PRIVATE:
  std::map<ndn::Name, FibEntry> m_table;
 
private:
  AdjacencyList& m_adjacencyList;
  ConfParameter& m_confParameter;
 
  static constexpr uint64_t GRACE_PERIOD = 10;
};
 
} // namespace nlsr
 
#endif // NLSR_ROUTE_FIB_HPP