blob: f9ff0f8064135d4f7a1197bf29f227582ff5a47a [file] [log] [blame]
Alexander Afanasyev60a7b622014-12-20 17:04:07 -08001/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2/**
3 * Copyright (c) 2011-2015 Regents of the University of California.
Alexander Afanasyev45b92d42011-08-14 23:11:38 -07004 *
Alexander Afanasyev60a7b622014-12-20 17:04:07 -08005 * This file is part of ndnSIM. See AUTHORS for complete list of ndnSIM authors and
6 * contributors.
Alexander Afanasyev45b92d42011-08-14 23:11:38 -07007 *
Alexander Afanasyev60a7b622014-12-20 17:04:07 -08008 * ndnSIM is free software: you can redistribute it and/or modify it under the terms
9 * of the GNU General Public License as published by the Free Software Foundation,
10 * either version 3 of the License, or (at your option) any later version.
Alexander Afanasyev45b92d42011-08-14 23:11:38 -070011 *
Alexander Afanasyev60a7b622014-12-20 17:04:07 -080012 * ndnSIM is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
13 * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
14 * PURPOSE. See the GNU General Public License for more details.
Alexander Afanasyev45b92d42011-08-14 23:11:38 -070015 *
Alexander Afanasyev60a7b622014-12-20 17:04:07 -080016 * You should have received a copy of the GNU General Public License along with
17 * ndnSIM, e.g., in COPYING.md file. If not, see <http://www.gnu.org/licenses/>.
18 **/
Alexander Afanasyev45b92d42011-08-14 23:11:38 -070019
Alexander Afanasyeva91aab42016-09-08 15:47:38 -070020#ifndef NDNSIM_HELPER_NDN_STACK_HELPER_HPP
21#define NDNSIM_HELPER_NDN_STACK_HELPER_HPP
Alexander Afanasyev45b92d42011-08-14 23:11:38 -070022
Spyridon Mastorakis53e922f2014-10-17 17:29:26 -070023#include "ns3/ndnSIM/model/ndn-common.hpp"
24
Alexander Afanasyev45b92d42011-08-14 23:11:38 -070025#include "ns3/ptr.h"
26#include "ns3/object-factory.h"
Spyridon Mastorakis9760bd02014-11-12 13:32:55 -080027#include "ns3/node.h"
28#include "ns3/node-container.h"
29
Spyridon Mastorakis588fd102014-11-20 19:50:02 -080030#include "ndn-fib-helper.hpp"
Spyridon Mastorakis592fcba2014-11-23 22:48:03 -080031#include "ndn-strategy-choice-helper.hpp"
Alexander Afanasyev45b92d42011-08-14 23:11:38 -070032
spirosmastorakis34eed982016-11-02 15:20:50 -070033namespace nfd {
34namespace cs {
35class Policy;
36} // namespace cs
37} // namespace nfd
38
Alexander Afanasyev45b92d42011-08-14 23:11:38 -070039namespace ns3 {
40
41class Node;
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -070042
43namespace ndn {
44
Alexander Afanasyevc17e4bd2013-02-17 14:31:56 -080045class L3Protocol;
Alexander Afanasyev45b92d42011-08-14 23:11:38 -070046
47/**
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -080048 * @ingroup ndn
49 * @defgroup ndn-helpers Helpers
Alexander Afanasyev0ab833e2011-08-18 15:49:13 -070050 */
51/**
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -080052 * @ingroup ndn-helpers
53 * @brief Helper class to install NDN stack and configure its parameters
Alexander Afanasyev45b92d42011-08-14 23:11:38 -070054 */
Alexander Afanasyevdde1e812015-01-06 14:26:09 -080055class StackHelper : boost::noncopyable {
Alexander Afanasyev45b92d42011-08-14 23:11:38 -070056public:
57 /**
Alexander Afanasyev4aac5572012-08-09 10:49:55 -070058 * \brief Create a new NdnStackHelper with a default NDN_FLOODING forwarding stategy
Alexander Afanasyev45b92d42011-08-14 23:11:38 -070059 */
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -070060 StackHelper();
Alexander Afanasyev122f3782013-02-02 00:04:40 -080061
Ilya Moiseenko25f7d4d2011-09-29 18:41:06 -070062 /**
Alexander Afanasyev4aac5572012-08-09 10:49:55 -070063 * \brief Destroy the NdnStackHelper
Alexander Afanasyev45b92d42011-08-14 23:11:38 -070064 */
Alexander Afanasyevbe55cf62014-12-20 17:51:09 -080065 virtual ~StackHelper();
Alexander Afanasyev45b92d42011-08-14 23:11:38 -070066
67 /**
Alexander Afanasyev4aac5572012-08-09 10:49:55 -070068 * @brief Set parameters of NdnL3Protocol
Alexander Afanasyev3a4a0b32012-06-28 14:14:22 -070069 */
70 void
Alexander Afanasyevbe55cf62014-12-20 17:51:09 -080071 SetStackAttributes(const std::string& attr1 = "", const std::string& value1 = "",
72 const std::string& attr2 = "", const std::string& value2 = "",
73 const std::string& attr3 = "", const std::string& value3 = "",
74 const std::string& attr4 = "", const std::string& value4 = "");
Alexander Afanasyev122f3782013-02-02 00:04:40 -080075
Spyridon Mastorakisde1f7732014-12-05 22:43:34 -080076 /**
Spyridon Mastorakis460f57c2014-12-17 00:44:14 -080077 * @brief Set maximum size for NFD's Content Store (in number of packets)
78 */
79 void
80 setCsSize(size_t maxSize);
81
82 /**
spirosmastorakis34eed982016-11-02 15:20:50 -070083 * @brief Set the cache replacement policy for NFD's Content Store
84 */
85 void
86 setPolicy(const std::string& policy);
87
Alexander Afanasyeva91aab42016-09-08 15:47:38 -070088 typedef Callback<shared_ptr<Face>, Ptr<Node>, Ptr<L3Protocol>, Ptr<NetDevice>>
89 FaceCreateCallback;
Alexander Afanasyev122f3782013-02-02 00:04:40 -080090
91 /**
Alexander Afanasyevbe55cf62014-12-20 17:51:09 -080092 * @brief Add callback to create and configure instance of the face, based on supplied Ptr<Node>
93 *and Ptr<NetDevice>
Alexander Afanasyev122f3782013-02-02 00:04:40 -080094 *
95 * It is possible to set up several callbacks for different NetDevice types.
96 *
Alexander Afanasyevbe55cf62014-12-20 17:51:09 -080097 * If none of the callbacks fit the TypeId of NetDevice, a default callback is used
98 *(DefaultNetDeviceCallback)
Alexander Afanasyev122f3782013-02-02 00:04:40 -080099 */
100 void
Alexander Afanasyeva91aab42016-09-08 15:47:38 -0700101 AddFaceCreateCallback(TypeId netDeviceType, FaceCreateCallback callback);
Alexander Afanasyev122f3782013-02-02 00:04:40 -0800102
Alexander Afanasyev3a4a0b32012-06-28 14:14:22 -0700103 /**
Alexander Afanasyevbe55cf62014-12-20 17:51:09 -0800104 * @brief Update callback to create and configure instance of the face, based on supplied
105 *Ptr<Node> and Ptr<NetDevice>
Alexander Afanasyev2a269f72013-06-06 22:59:33 -0700106 *
107 * It is possible to set up several callbacks for different NetDevice types.
108 *
109 * Using this method, it is possible to override Face creation for PointToPointNetDevices
110 */
111 void
Alexander Afanasyeva91aab42016-09-08 15:47:38 -0700112 UpdateFaceCreateCallback(TypeId netDeviceType, FaceCreateCallback callback);
Alexander Afanasyev2a269f72013-06-06 22:59:33 -0700113
114 /**
Alexander Afanasyevbe55cf62014-12-20 17:51:09 -0800115 * @brief Remove callback to create and configure instance of the face, based on supplied
116 * Ptr<Node> and Ptr<NetDevice>
Alexander Afanasyev2a269f72013-06-06 22:59:33 -0700117 */
118 void
Alexander Afanasyeva91aab42016-09-08 15:47:38 -0700119 RemoveFaceCreateCallback(TypeId netDeviceType, FaceCreateCallback callback);
Alexander Afanasyev2a269f72013-06-06 22:59:33 -0700120
121 /**
Spyridon Mastorakis9760bd02014-11-12 13:32:55 -0800122 * \brief Install Ndn stack on the node
123 *
124 * This method will assert if called on a node that already has Ndn object
125 * installed on it
126 *
127 * \param nodeName The name of the node on which to install the stack.
128 *
129 * \returns list of installed faces in the form of a smart pointer
130 * to NdnFaceContainer object
131 */
Alexander Afanasyevdc3c3a32019-02-17 20:17:32 -0500132 void
Alexander Afanasyevbe55cf62014-12-20 17:51:09 -0800133 Install(const std::string& nodeName) const;
Alexander Afanasyev45b92d42011-08-14 23:11:38 -0700134
135 /**
Alexander Afanasyev4aac5572012-08-09 10:49:55 -0700136 * \brief Install Ndn stack on the node
Alexander Afanasyev45b92d42011-08-14 23:11:38 -0700137 *
Alexander Afanasyev4aac5572012-08-09 10:49:55 -0700138 * This method will assert if called on a node that already has Ndn object
Alexander Afanasyev45b92d42011-08-14 23:11:38 -0700139 * installed on it
Alexander Afanasyev122f3782013-02-02 00:04:40 -0800140 *
Alexander Afanasyev45b92d42011-08-14 23:11:38 -0700141 * \param node The node on which to install the stack.
Alexander Afanasyev0ab833e2011-08-18 15:49:13 -0700142 *
143 * \returns list of installed faces in the form of a smart pointer
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -0700144 * to FaceContainer object
Alexander Afanasyev45b92d42011-08-14 23:11:38 -0700145 */
Alexander Afanasyevdc3c3a32019-02-17 20:17:32 -0500146 void
Alexander Afanasyevbe55cf62014-12-20 17:51:09 -0800147 Install(Ptr<Node> node) const;
Alexander Afanasyev45b92d42011-08-14 23:11:38 -0700148
149 /**
Alexander Afanasyev4aac5572012-08-09 10:49:55 -0700150 * \brief Install Ndn stack on each node in the input container
Alexander Afanasyev45b92d42011-08-14 23:11:38 -0700151 *
152 * The program will assert if this method is called on a container with a node
Alexander Afanasyev4aac5572012-08-09 10:49:55 -0700153 * that already has an ndn object aggregated to it.
Alexander Afanasyev122f3782013-02-02 00:04:40 -0800154 *
Alexander Afanasyev45b92d42011-08-14 23:11:38 -0700155 * \param c NodeContainer that holds the set of nodes on which to install the
156 * new stacks.
Alexander Afanasyev0ab833e2011-08-18 15:49:13 -0700157 *
158 * \returns list of installed faces in the form of a smart pointer
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -0700159 * to FaceContainer object
Alexander Afanasyev45b92d42011-08-14 23:11:38 -0700160 */
Alexander Afanasyevdc3c3a32019-02-17 20:17:32 -0500161 void
Alexander Afanasyevbe55cf62014-12-20 17:51:09 -0800162 Install(const NodeContainer& c) const;
Alexander Afanasyev45b92d42011-08-14 23:11:38 -0700163
164 /**
Alexander Afanasyev4aac5572012-08-09 10:49:55 -0700165 * \brief Install Ndn stack on all nodes in the simulation
Alexander Afanasyev0ab833e2011-08-18 15:49:13 -0700166 *
167 * \returns list of installed faces in the form of a smart pointer
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -0700168 * to FaceContainer object
Alexander Afanasyev45b92d42011-08-14 23:11:38 -0700169 */
Alexander Afanasyevdc3c3a32019-02-17 20:17:32 -0500170 void
Alexander Afanasyevbe55cf62014-12-20 17:51:09 -0800171 InstallAll() const;
Alexander Afanasyev45b92d42011-08-14 23:11:38 -0700172
Spyridon Mastorakis588fd102014-11-20 19:50:02 -0800173 /**
174 * \brief Set flag indicating necessity to install default routes in FIB
175 */
176 void
177 SetDefaultRoutes(bool needSet);
178
Alexander Afanasyev34e13f32014-12-14 15:13:28 -0800179 static KeyChain&
180 getKeyChain();
181
Spyridon Mastorakis21226ae2015-03-31 18:03:11 -0700182 /**
183 * \brief Update Ndn stack on a given node (Add faces for new devices)
184 *
185 * \param node The node on which to update the stack.
186 */
187 void
188 Update(Ptr<Node> node);
189
190 /**
191 *\brief Update Ndn stack on given nodes (Add faces for new devices)
192 *
193 * \param c The nodes on which to update the stack.
194 */
195 void
196 Update(const NodeContainer& c);
197
198 /**
199 *\brief Update Ndn stack on a given node name (Add faces for new devices)
200 *
201 * \param nodeName The name of the node on which to update the stack.
202 */
203 void
204 Update(const std::string& nodeName);
205
206 /**
207 *\brief Update Ndn stack on all the nodes (Add faces for new devices)
208 */
209 void
210 UpdateAll();
211
spirosmastorakis0df15ba2015-11-14 08:46:24 -0800212 /**
spirosmastorakis0df15ba2015-11-14 08:46:24 -0800213 * \brief Disable Strategy Choice Manager
214 */
215 void
216 disableStrategyChoiceManager();
217
218 /**
Alexander Afanasyeva91aab42016-09-08 15:47:38 -0700219 * \brief Disable Forwarder Status Manager
spirosmastorakis0df15ba2015-11-14 08:46:24 -0800220 */
221 void
Alexander Afanasyeva91aab42016-09-08 15:47:38 -0700222 disableForwarderStatusManager();
spirosmastorakis0df15ba2015-11-14 08:46:24 -0800223
Chavoosh Ghasemi58ef8612018-09-12 15:12:49 -0700224 /**
225 * @brief Set face metric of all faces connected through PointToPoint channel to channel latency
226 */
227 static void
228 SetLinkDelayAsFaceMetric();
229
Alexander Afanasyev6995bb72019-02-23 15:53:26 -0500230 static void
231 ProcessWarmupEvents();
232
Alexander Afanasyev11453142011-11-25 16:13:33 -0800233private:
Alexander Afanasyevdc3c3a32019-02-17 20:17:32 -0500234 void
235 doInstall(Ptr<Node> node) const;
236
237private:
Alexander Afanasyeva91aab42016-09-08 15:47:38 -0700238 shared_ptr<Face>
Alexander Afanasyevbe55cf62014-12-20 17:51:09 -0800239 DefaultNetDeviceCallback(Ptr<Node> node, Ptr<L3Protocol> ndn, Ptr<NetDevice> netDevice) const;
Alexander Afanasyev122f3782013-02-02 00:04:40 -0800240
Alexander Afanasyeva91aab42016-09-08 15:47:38 -0700241 shared_ptr<Face>
Alexander Afanasyevbe55cf62014-12-20 17:51:09 -0800242 PointToPointNetDeviceCallback(Ptr<Node> node, Ptr<L3Protocol> ndn,
243 Ptr<NetDevice> netDevice) const;
Alexander Afanasyeva91aab42016-09-08 15:47:38 -0700244 shared_ptr<Face>
Spyridon Mastorakis21226ae2015-03-31 18:03:11 -0700245 createAndRegisterFace(Ptr<Node> node, Ptr<L3Protocol> ndn, Ptr<NetDevice> device) const;
Alexander Afanasyev122f3782013-02-02 00:04:40 -0800246
Alexander Afanasyeva91aab42016-09-08 15:47:38 -0700247 bool m_isForwarderStatusManagerDisabled;
spirosmastorakis0df15ba2015-11-14 08:46:24 -0800248 bool m_isStrategyChoiceManagerDisabled;
249
Spyridon Mastorakis86edf6f2014-11-14 19:27:18 -0800250public:
251 void
252 setCustomNdnCxxClocks();
253
Alexander Afanasyev122f3782013-02-02 00:04:40 -0800254private:
Alexander Afanasyev4aac5572012-08-09 10:49:55 -0700255 ObjectFactory m_ndnFactory;
Alexander Afanasyev122f3782013-02-02 00:04:40 -0800256
Alexander Afanasyevbe55cf62014-12-20 17:51:09 -0800257 bool m_needSetDefaultRoutes;
Alexander Afanasyev25e4d8f2019-07-29 13:44:04 -0400258 size_t m_maxCsSize = 100;
Alexander Afanasyev122f3782013-02-02 00:04:40 -0800259
spirosmastorakis34eed982016-11-02 15:20:50 -0700260 typedef std::function<std::unique_ptr<nfd::cs::Policy>()> PolicyCreationCallback;
261 PolicyCreationCallback m_csPolicyCreationFunc;
262
263 std::map<std::string, PolicyCreationCallback> m_csPolicies;
264
Alexander Afanasyeva91aab42016-09-08 15:47:38 -0700265 typedef std::list<std::pair<TypeId, FaceCreateCallback>> NetDeviceCallbackList;
Alexander Afanasyev2a269f72013-06-06 22:59:33 -0700266 NetDeviceCallbackList m_netDeviceCallbacks;
Alexander Afanasyev45b92d42011-08-14 23:11:38 -0700267};
268
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -0700269} // namespace ndn
Alexander Afanasyev45b92d42011-08-14 23:11:38 -0700270} // namespace ns3
271
Alexander Afanasyeva91aab42016-09-08 15:47:38 -0700272#endif // NDNSIM_HELPER_NDN_STACK_HELPER_HPP