blob: c873107f7373bda8a557425ac63b351887525bb3 [file] [log] [blame]
Alexander Afanasyev33b72772014-01-26 23:22:58 -08001/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
Junxiao Shifc2e13d2017-07-25 02:08:48 +00002/*
Teng Liang63086442018-02-25 20:39:42 -07003 * Copyright (c) 2014-2018, Regents of the University of California,
Junxiao Shi330136a2016-03-10 04:53:08 -07004 * 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 Afanasyev9bcbc7c2014-04-06 19:37:37 -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/>.
Junxiao Shia110f262014-10-12 12:35:20 -070024 */
Alexander Afanasyev33b72772014-01-26 23:22:58 -080025
Alexander Afanasyev613e2a92014-04-15 13:36:58 -070026#ifndef NFD_DAEMON_FW_FORWARDER_HPP
27#define NFD_DAEMON_FW_FORWARDER_HPP
Alexander Afanasyev33b72772014-01-26 23:22:58 -080028
Junxiao Shi9f5b01d2016-08-05 03:54:28 +000029#include "core/common.hpp"
Junxiao Shid3c792f2014-01-30 00:46:13 -070030#include "core/scheduler.hpp"
Junxiao Shi33152f12014-07-16 19:54:32 -070031#include "forwarder-counters.hpp"
Junxiao Shia4f2be82014-03-02 22:56:41 -070032#include "face-table.hpp"
Junxiao Shifbe8efe2016-08-22 16:02:30 +000033#include "unsolicited-data-policy.hpp"
Junxiao Shid3c792f2014-01-30 00:46:13 -070034#include "table/fib.hpp"
35#include "table/pit.hpp"
36#include "table/cs.hpp"
Junxiao Shidbe71732014-02-21 22:23:28 -070037#include "table/measurements.hpp"
Junxiao Shibb5105f2014-03-03 12:06:45 -070038#include "table/strategy-choice.hpp"
Junxiao Shia110f262014-10-12 12:35:20 -070039#include "table/dead-nonce-list.hpp"
Junxiao Shi0355e9f2015-09-02 07:24:53 -070040#include "table/network-region-table.hpp"
Alexander Afanasyev33b72772014-01-26 23:22:58 -080041
Spyridon Mastorakiscef59cb2014-12-05 22:43:34 -080042#include "ns3/ndnSIM/model/cs/ndn-content-store.hpp"
43
Alexander Afanasyev18bbf812014-01-29 01:40:23 -080044namespace nfd {
Alexander Afanasyev33b72772014-01-26 23:22:58 -080045
Junxiao Shi2d9bdc82014-03-02 20:55:42 -070046namespace fw {
47class Strategy;
48} // namespace fw
49
50/** \brief main class of NFD
Junxiao Shic041ca32014-02-25 20:01:15 -070051 *
Junxiao Shi2d9bdc82014-03-02 20:55:42 -070052 * Forwarder owns all faces and tables, and implements forwarding pipelines.
Alexander Afanasyev33b72772014-01-26 23:22:58 -080053 */
54class Forwarder
55{
56public:
Junxiao Shic041ca32014-02-25 20:01:15 -070057 Forwarder();
Alexander Afanasyev33b72772014-01-26 23:22:58 -080058
Steve DiBenedettobf6a93d2014-03-21 14:03:02 -060059 VIRTUAL_WITH_TESTS
60 ~Forwarder();
61
Junxiao Shib289cc12014-03-15 12:19:05 -070062 const ForwarderCounters&
Junxiao Shib9420cf2016-08-13 04:38:52 +000063 getCounters() const
64 {
65 return m_counters;
66 }
Junxiao Shib289cc12014-03-15 12:19:05 -070067
Junxiao Shifbe8efe2016-08-22 16:02:30 +000068public: // faces and policies
Junxiao Shia4f2be82014-03-02 22:56:41 -070069 FaceTable&
Junxiao Shib9420cf2016-08-13 04:38:52 +000070 getFaceTable()
71 {
72 return m_faceTable;
73 }
Junxiao Shia4f2be82014-03-02 22:56:41 -070074
75 /** \brief get existing Face
76 *
77 * shortcut to .getFaceTable().get(face)
78 */
Junxiao Shi5b43f9a2016-07-19 13:15:56 +000079 Face*
Junxiao Shib9420cf2016-08-13 04:38:52 +000080 getFace(FaceId id) const
81 {
82 return m_faceTable.get(id);
83 }
Junxiao Shia4f2be82014-03-02 22:56:41 -070084
85 /** \brief add new Face
86 *
87 * shortcut to .getFaceTable().add(face)
88 */
Junxiao Shi8c8d2182014-01-30 22:33:00 -070089 void
Junxiao Shib9420cf2016-08-13 04:38:52 +000090 addFace(shared_ptr<Face> face)
91 {
92 m_faceTable.add(face);
93 }
Alexander Afanasyev33b72772014-01-26 23:22:58 -080094
Junxiao Shifbe8efe2016-08-22 16:02:30 +000095 fw::UnsolicitedDataPolicy&
96 getUnsolicitedDataPolicy() const
97 {
98 return *m_unsolicitedDataPolicy;
99 }
100
101 void
102 setUnsolicitedDataPolicy(unique_ptr<fw::UnsolicitedDataPolicy> policy)
103 {
104 BOOST_ASSERT(policy != nullptr);
105 m_unsolicitedDataPolicy = std::move(policy);
106 }
107
Junxiao Shia4f2be82014-03-02 22:56:41 -0700108public: // forwarding entrypoints and tables
Junxiao Shi0355e9f2015-09-02 07:24:53 -0700109 /** \brief start incoming Interest processing
Alexander Afanasyevb755e9d2015-10-20 17:35:51 -0500110 * \param face face on which Interest is received
Junxiao Shifc2e13d2017-07-25 02:08:48 +0000111 * \param interest the incoming Interest, must be well-formed and created with make_shared
Junxiao Shi0355e9f2015-09-02 07:24:53 -0700112 */
Alexander Afanasyev33b72772014-01-26 23:22:58 -0800113 void
Junxiao Shifc2e13d2017-07-25 02:08:48 +0000114 startProcessInterest(Face& face, const Interest& interest)
115 {
116 this->onIncomingInterest(face, interest);
117 }
Alexander Afanasyev33b72772014-01-26 23:22:58 -0800118
Junxiao Shi0355e9f2015-09-02 07:24:53 -0700119 /** \brief start incoming Data processing
Alexander Afanasyevb755e9d2015-10-20 17:35:51 -0500120 * \param face face on which Data is received
Junxiao Shifc2e13d2017-07-25 02:08:48 +0000121 * \param data the incoming Data, must be well-formed and created with make_shared
Junxiao Shi0355e9f2015-09-02 07:24:53 -0700122 */
Alexander Afanasyev33b72772014-01-26 23:22:58 -0800123 void
Junxiao Shifc2e13d2017-07-25 02:08:48 +0000124 startProcessData(Face& face, const Data& data)
125 {
126 this->onIncomingData(face, data);
127 }
Junxiao Shic041ca32014-02-25 20:01:15 -0700128
Junxiao Shi5e5e4452015-09-24 16:56:52 -0700129 /** \brief start incoming Nack processing
Alexander Afanasyevb755e9d2015-10-20 17:35:51 -0500130 * \param face face on which Nack is received
Junxiao Shifc2e13d2017-07-25 02:08:48 +0000131 * \param nack the incoming Nack, must be well-formed
Junxiao Shi5e5e4452015-09-24 16:56:52 -0700132 */
133 void
Junxiao Shifc2e13d2017-07-25 02:08:48 +0000134 startProcessNack(Face& face, const lp::Nack& nack)
135 {
136 this->onIncomingNack(face, nack);
137 }
Junxiao Shi5e5e4452015-09-24 16:56:52 -0700138
Junxiao Shiea48d8b2014-03-16 13:53:47 -0700139 NameTree&
Junxiao Shib9420cf2016-08-13 04:38:52 +0000140 getNameTree()
141 {
142 return m_nameTree;
143 }
Junxiao Shiea48d8b2014-03-16 13:53:47 -0700144
Junxiao Shi8c8d2182014-01-30 22:33:00 -0700145 Fib&
Junxiao Shib9420cf2016-08-13 04:38:52 +0000146 getFib()
147 {
148 return m_fib;
149 }
Junxiao Shic041ca32014-02-25 20:01:15 -0700150
Junxiao Shi8c8d2182014-01-30 22:33:00 -0700151 Pit&
Junxiao Shib9420cf2016-08-13 04:38:52 +0000152 getPit()
153 {
154 return m_pit;
155 }
Junxiao Shic041ca32014-02-25 20:01:15 -0700156
Junxiao Shi8c8d2182014-01-30 22:33:00 -0700157 Cs&
Junxiao Shib9420cf2016-08-13 04:38:52 +0000158 getCs()
159 {
160 return m_cs;
161 }
Junxiao Shic041ca32014-02-25 20:01:15 -0700162
Junxiao Shidbe71732014-02-21 22:23:28 -0700163 Measurements&
Junxiao Shib9420cf2016-08-13 04:38:52 +0000164 getMeasurements()
165 {
166 return m_measurements;
167 }
Junxiao Shi8c8d2182014-01-30 22:33:00 -0700168
Junxiao Shibb5105f2014-03-03 12:06:45 -0700169 StrategyChoice&
Junxiao Shib9420cf2016-08-13 04:38:52 +0000170 getStrategyChoice()
171 {
172 return m_strategyChoice;
173 }
Junxiao Shibb5105f2014-03-03 12:06:45 -0700174
Junxiao Shia110f262014-10-12 12:35:20 -0700175 DeadNonceList&
Junxiao Shib9420cf2016-08-13 04:38:52 +0000176 getDeadNonceList()
177 {
178 return m_deadNonceList;
179 }
Junxiao Shia110f262014-10-12 12:35:20 -0700180
Junxiao Shi0355e9f2015-09-02 07:24:53 -0700181 NetworkRegionTable&
Junxiao Shib9420cf2016-08-13 04:38:52 +0000182 getNetworkRegionTable()
183 {
184 return m_networkRegionTable;
185 }
Junxiao Shi0355e9f2015-09-02 07:24:53 -0700186
Spyridon Mastorakiscef59cb2014-12-05 22:43:34 -0800187public: // allow enabling ndnSIM content store (will be removed in the future)
188 void
189 setCsFromNdnSim(ns3::Ptr<ns3::ndn::ContentStore> cs)
190 {
191 m_csFromNdnSim = cs;
192 }
193
Alexander Afanasyev929ef0a2018-08-06 17:28:36 -0400194public:
195 /** \brief trigger before PIT entry is satisfied
196 * \sa Strategy::beforeSatisfyInterest
197 */
198 signal::Signal<Forwarder, pit::Entry, Face, Data> beforeSatisfyInterest;
199
200 /** \brief trigger before PIT entry expires
201 * \sa Strategy::beforeExpirePendingInterest
202 */
203 signal::Signal<Forwarder, pit::Entry> beforeExpirePendingInterest;
204
Junxiao Shi88884492014-02-15 15:57:43 -0700205PUBLIC_WITH_TESTS_ELSE_PRIVATE: // pipelines
Junxiao Shid3c792f2014-01-30 00:46:13 -0700206 /** \brief incoming Interest pipeline
207 */
Junxiao Shi88884492014-02-15 15:57:43 -0700208 VIRTUAL_WITH_TESTS void
Junxiao Shid3c792f2014-01-30 00:46:13 -0700209 onIncomingInterest(Face& inFace, const Interest& interest);
210
Junxiao Shi0355e9f2015-09-02 07:24:53 -0700211 /** \brief Interest loop pipeline
212 */
213 VIRTUAL_WITH_TESTS void
Junxiao Shi330136a2016-03-10 04:53:08 -0700214 onInterestLoop(Face& inFace, const Interest& interest);
Junxiao Shi0355e9f2015-09-02 07:24:53 -0700215
mzhang4eab72492015-02-25 11:16:09 -0600216 /** \brief Content Store miss pipeline
217 */
Junxiao Shi5e5e4452015-09-24 16:56:52 -0700218 VIRTUAL_WITH_TESTS void
Junxiao Shic5f651f2016-11-17 22:58:12 +0000219 onContentStoreMiss(const Face& inFace, const shared_ptr<pit::Entry>& pitEntry, const Interest& interest);
mzhang4eab72492015-02-25 11:16:09 -0600220
221 /** \brief Content Store hit pipeline
222 */
Junxiao Shi5e5e4452015-09-24 16:56:52 -0700223 VIRTUAL_WITH_TESTS void
Junxiao Shib9420cf2016-08-13 04:38:52 +0000224 onContentStoreHit(const Face& inFace, const shared_ptr<pit::Entry>& pitEntry,
mzhang4eab72492015-02-25 11:16:09 -0600225 const Interest& interest, const Data& data);
226
Junxiao Shid3c792f2014-01-30 00:46:13 -0700227 /** \brief outgoing Interest pipeline
228 */
Junxiao Shi88884492014-02-15 15:57:43 -0700229 VIRTUAL_WITH_TESTS void
Junxiao Shic5f651f2016-11-17 22:58:12 +0000230 onOutgoingInterest(const shared_ptr<pit::Entry>& pitEntry, Face& outFace, const Interest& interest);
Junxiao Shic041ca32014-02-25 20:01:15 -0700231
Junxiao Shia110f262014-10-12 12:35:20 -0700232 /** \brief Interest finalize pipeline
Junxiao Shia110f262014-10-12 12:35:20 -0700233 */
234 VIRTUAL_WITH_TESTS void
Teng Liang6f09ab62018-03-01 20:04:08 -0700235 onInterestFinalize(const shared_ptr<pit::Entry>& pitEntry);
Junxiao Shia110f262014-10-12 12:35:20 -0700236
Junxiao Shid3c792f2014-01-30 00:46:13 -0700237 /** \brief incoming Data pipeline
238 */
Junxiao Shi88884492014-02-15 15:57:43 -0700239 VIRTUAL_WITH_TESTS void
Junxiao Shid3c792f2014-01-30 00:46:13 -0700240 onIncomingData(Face& inFace, const Data& data);
Junxiao Shic041ca32014-02-25 20:01:15 -0700241
Junxiao Shid3c792f2014-01-30 00:46:13 -0700242 /** \brief Data unsolicited pipeline
243 */
Junxiao Shi88884492014-02-15 15:57:43 -0700244 VIRTUAL_WITH_TESTS void
Junxiao Shid3c792f2014-01-30 00:46:13 -0700245 onDataUnsolicited(Face& inFace, const Data& data);
Junxiao Shic041ca32014-02-25 20:01:15 -0700246
Junxiao Shid3c792f2014-01-30 00:46:13 -0700247 /** \brief outgoing Data pipeline
248 */
Junxiao Shi88884492014-02-15 15:57:43 -0700249 VIRTUAL_WITH_TESTS void
Junxiao Shid3c792f2014-01-30 00:46:13 -0700250 onOutgoingData(const Data& data, Face& outFace);
251
Junxiao Shi5e5e4452015-09-24 16:56:52 -0700252 /** \brief incoming Nack pipeline
253 */
254 VIRTUAL_WITH_TESTS void
255 onIncomingNack(Face& inFace, const lp::Nack& nack);
256
257 /** \brief outgoing Nack pipeline
258 */
259 VIRTUAL_WITH_TESTS void
Junxiao Shib9420cf2016-08-13 04:38:52 +0000260 onOutgoingNack(const shared_ptr<pit::Entry>& pitEntry, const Face& outFace, const lp::NackHeader& nack);
Junxiao Shi5e5e4452015-09-24 16:56:52 -0700261
Eric Newberry41aba102017-11-01 16:42:13 -0700262 VIRTUAL_WITH_TESTS void
263 onDroppedInterest(Face& outFace, const Interest& interest);
264
Junxiao Shi88884492014-02-15 15:57:43 -0700265PROTECTED_WITH_TESTS_ELSE_PRIVATE:
Teng Liang7003e0b2018-03-03 16:03:30 -0700266 /** \brief set a new expiry timer (now + \p duration) on a PIT entry
267 */
268 void
269 setExpiryTimer(const shared_ptr<pit::Entry>& pitEntry, time::milliseconds duration);
Junxiao Shic041ca32014-02-25 20:01:15 -0700270
Junxiao Shia110f262014-10-12 12:35:20 -0700271 /** \brief insert Nonce to Dead Nonce List if necessary
Junxiao Shi4846f372016-04-05 13:39:30 -0700272 * \param upstream if null, insert Nonces from all out-records;
273 * if not null, insert Nonce only on the out-records of this face
Junxiao Shia110f262014-10-12 12:35:20 -0700274 */
275 VIRTUAL_WITH_TESTS void
Teng Liang6f09ab62018-03-01 20:04:08 -0700276 insertDeadNonceList(pit::Entry& pitEntry, Face* upstream);
Junxiao Shia110f262014-10-12 12:35:20 -0700277
Junxiao Shib9420cf2016-08-13 04:38:52 +0000278 /** \brief call trigger (method) on the effective strategy of pitEntry
279 */
Junxiao Shif3c07812014-03-11 21:48:49 -0700280#ifdef WITH_TESTS
281 virtual void
Davide Pesavento87fc0f82018-04-11 23:43:51 -0400282 dispatchToStrategy(pit::Entry& pitEntry, std::function<void(fw::Strategy&)> trigger)
Junxiao Shif3c07812014-03-11 21:48:49 -0700283#else
284 template<class Function>
285 void
Junxiao Shib9420cf2016-08-13 04:38:52 +0000286 dispatchToStrategy(pit::Entry& pitEntry, Function trigger)
Junxiao Shif3c07812014-03-11 21:48:49 -0700287#endif
Junxiao Shib9420cf2016-08-13 04:38:52 +0000288 {
289 trigger(m_strategyChoice.findEffectiveStrategy(pitEntry));
290 }
Junxiao Shid3c792f2014-01-30 00:46:13 -0700291
292private:
Junxiao Shib289cc12014-03-15 12:19:05 -0700293 ForwarderCounters m_counters;
294
Junxiao Shia4f2be82014-03-02 22:56:41 -0700295 FaceTable m_faceTable;
Junxiao Shifbe8efe2016-08-22 16:02:30 +0000296 unique_ptr<fw::UnsolicitedDataPolicy> m_unsolicitedDataPolicy;
HangZhangad4afd12014-03-01 11:03:08 +0800297
Junxiao Shi0355e9f2015-09-02 07:24:53 -0700298 NameTree m_nameTree;
299 Fib m_fib;
300 Pit m_pit;
301 Cs m_cs;
302 Measurements m_measurements;
303 StrategyChoice m_strategyChoice;
304 DeadNonceList m_deadNonceList;
305 NetworkRegionTable m_networkRegionTable;
Alexander Afanasyev929ef0a2018-08-06 17:28:36 -0400306 shared_ptr<Face> m_csFace;
Junxiao Shibb5105f2014-03-03 12:06:45 -0700307
Spyridon Mastorakiscef59cb2014-12-05 22:43:34 -0800308 ns3::Ptr<ns3::ndn::ContentStore> m_csFromNdnSim;
309
Junxiao Shid3c792f2014-01-30 00:46:13 -0700310 // allow Strategy (base class) to enter pipelines
Junxiao Shi8c8d2182014-01-30 22:33:00 -0700311 friend class fw::Strategy;
Alexander Afanasyev33b72772014-01-26 23:22:58 -0800312};
313
Junxiao Shid3c792f2014-01-30 00:46:13 -0700314} // namespace nfd
Alexander Afanasyev33b72772014-01-26 23:22:58 -0800315
Alexander Afanasyev613e2a92014-04-15 13:36:58 -0700316#endif // NFD_DAEMON_FW_FORWARDER_HPP