| /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */ |
| /* |
| * Copyright (c) 2014-2022, 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_FW_FORWARDER_HPP |
| #define NFD_DAEMON_FW_FORWARDER_HPP |
| |
| #include "face-table.hpp" |
| #include "forwarder-counters.hpp" |
| #include "unsolicited-data-policy.hpp" |
| #include "common/config-file.hpp" |
| #include "face/face-endpoint.hpp" |
| #include "table/fib.hpp" |
| #include "table/pit.hpp" |
| #include "table/cs.hpp" |
| #include "table/measurements.hpp" |
| #include "table/strategy-choice.hpp" |
| #include "table/dead-nonce-list.hpp" |
| #include "table/network-region-table.hpp" |
| |
| namespace nfd { |
| |
| namespace fw { |
| class Strategy; |
| } // namespace fw |
| |
| /** |
| * \brief Main class of NFD's forwarding engine. |
| * |
| * The Forwarder class owns all tables and implements the forwarding pipelines. |
| */ |
| class Forwarder |
| { |
| public: |
| explicit |
| Forwarder(FaceTable& faceTable); |
| |
| #ifdef NFD_WITH_TESTS |
| virtual |
| ~Forwarder() = default; |
| #endif |
| |
| const ForwarderCounters& |
| getCounters() const noexcept |
| { |
| return m_counters; |
| } |
| |
| fw::UnsolicitedDataPolicy& |
| getUnsolicitedDataPolicy() const noexcept |
| { |
| return *m_unsolicitedDataPolicy; |
| } |
| |
| void |
| setUnsolicitedDataPolicy(unique_ptr<fw::UnsolicitedDataPolicy> policy) noexcept |
| { |
| BOOST_ASSERT(policy != nullptr); |
| m_unsolicitedDataPolicy = std::move(policy); |
| } |
| |
| NameTree& |
| getNameTree() noexcept |
| { |
| return m_nameTree; |
| } |
| |
| Fib& |
| getFib() noexcept |
| { |
| return m_fib; |
| } |
| |
| Pit& |
| getPit() noexcept |
| { |
| return m_pit; |
| } |
| |
| Cs& |
| getCs() noexcept |
| { |
| return m_cs; |
| } |
| |
| Measurements& |
| getMeasurements() noexcept |
| { |
| return m_measurements; |
| } |
| |
| StrategyChoice& |
| getStrategyChoice() noexcept |
| { |
| return m_strategyChoice; |
| } |
| |
| DeadNonceList& |
| getDeadNonceList() noexcept |
| { |
| return m_deadNonceList; |
| } |
| |
| NetworkRegionTable& |
| getNetworkRegionTable() noexcept |
| { |
| return m_networkRegionTable; |
| } |
| |
| /** \brief Register handler for forwarder section of NFD configuration file. |
| */ |
| void |
| setConfigFile(ConfigFile& configFile); |
| |
| NFD_PUBLIC_WITH_TESTS_ELSE_PRIVATE: // pipelines |
| /** \brief Incoming Interest pipeline. |
| * \param interest the incoming Interest, must be well-formed and created with make_shared |
| * \param ingress face on which \p interest was received and endpoint of the sender |
| */ |
| NFD_VIRTUAL_WITH_TESTS void |
| onIncomingInterest(const Interest& interest, const FaceEndpoint& ingress); |
| |
| /** \brief Interest loop pipeline. |
| */ |
| NFD_VIRTUAL_WITH_TESTS void |
| onInterestLoop(const Interest& interest, const FaceEndpoint& ingress); |
| |
| /** \brief Content Store miss pipeline. |
| */ |
| NFD_VIRTUAL_WITH_TESTS void |
| onContentStoreMiss(const Interest& interest, const FaceEndpoint& ingress, |
| const shared_ptr<pit::Entry>& pitEntry); |
| |
| /** \brief Content Store hit pipeline. |
| */ |
| NFD_VIRTUAL_WITH_TESTS void |
| onContentStoreHit(const Interest& interest, const FaceEndpoint& ingress, |
| const shared_ptr<pit::Entry>& pitEntry, const Data& data); |
| |
| /** \brief Outgoing Interest pipeline. |
| * \return A pointer to the out-record created or nullptr if the Interest was dropped |
| */ |
| NFD_VIRTUAL_WITH_TESTS pit::OutRecord* |
| onOutgoingInterest(const Interest& interest, Face& egress, |
| const shared_ptr<pit::Entry>& pitEntry); |
| |
| /** \brief Interest finalize pipeline. |
| */ |
| NFD_VIRTUAL_WITH_TESTS void |
| onInterestFinalize(const shared_ptr<pit::Entry>& pitEntry); |
| |
| /** \brief Incoming Data pipeline. |
| * \param data the incoming Data, must be well-formed and created with make_shared |
| * \param ingress face on which \p data was received and endpoint of the sender |
| */ |
| NFD_VIRTUAL_WITH_TESTS void |
| onIncomingData(const Data& data, const FaceEndpoint& ingress); |
| |
| /** \brief Data unsolicited pipeline. |
| */ |
| NFD_VIRTUAL_WITH_TESTS void |
| onDataUnsolicited(const Data& data, const FaceEndpoint& ingress); |
| |
| /** \brief Outgoing Data pipeline. |
| * \return Whether the Data was transmitted (true) or dropped (false) |
| */ |
| NFD_VIRTUAL_WITH_TESTS bool |
| onOutgoingData(const Data& data, Face& egress); |
| |
| /** \brief Incoming Nack pipeline. |
| * \param nack the incoming Nack, must be well-formed |
| * \param ingress face on which \p nack is received and endpoint of the sender |
| */ |
| NFD_VIRTUAL_WITH_TESTS void |
| onIncomingNack(const lp::Nack& nack, const FaceEndpoint& ingress); |
| |
| /** \brief Outgoing Nack pipeline. |
| * \return Whether the Nack was transmitted (true) or dropped (false) |
| */ |
| NFD_VIRTUAL_WITH_TESTS bool |
| onOutgoingNack(const lp::NackHeader& nack, Face& egress, |
| const shared_ptr<pit::Entry>& pitEntry); |
| |
| NFD_VIRTUAL_WITH_TESTS void |
| onDroppedInterest(const Interest& interest, Face& egress); |
| |
| NFD_VIRTUAL_WITH_TESTS void |
| onNewNextHop(const Name& prefix, const fib::NextHop& nextHop); |
| |
| private: |
| /** \brief Set a new expiry timer (now + \p duration) on a PIT entry. |
| */ |
| void |
| setExpiryTimer(const shared_ptr<pit::Entry>& pitEntry, time::milliseconds duration); |
| |
| /** \brief Insert Nonce to Dead Nonce List if necessary. |
| * \param upstream if null, insert Nonces from all out-records; |
| * if not null, insert Nonce only on the out-records of this face |
| */ |
| void |
| insertDeadNonceList(pit::Entry& pitEntry, const Face* upstream); |
| |
| void |
| processConfig(const ConfigSection& configSection, bool isDryRun, |
| const std::string& filename); |
| |
| NFD_PUBLIC_WITH_TESTS_ELSE_PRIVATE: |
| /** |
| * \brief Configuration options from the `forwarder` section. |
| */ |
| struct Config |
| { |
| /// Initial value of HopLimit that should be added to Interests that don't have one. |
| /// A value of zero disables the feature. |
| uint8_t defaultHopLimit = 0; |
| }; |
| Config m_config; |
| |
| private: |
| ForwarderCounters m_counters; |
| |
| FaceTable& m_faceTable; |
| unique_ptr<fw::UnsolicitedDataPolicy> m_unsolicitedDataPolicy; |
| |
| NameTree m_nameTree; |
| Fib m_fib; |
| Pit m_pit; |
| Cs m_cs; |
| Measurements m_measurements; |
| StrategyChoice m_strategyChoice; |
| DeadNonceList m_deadNonceList; |
| NetworkRegionTable m_networkRegionTable; |
| |
| // allow Strategy (base class) to enter pipelines |
| friend ::nfd::fw::Strategy; |
| }; |
| |
| } // namespace nfd |
| |
| #endif // NFD_DAEMON_FW_FORWARDER_HPP |