helper: FibHelper to handle all Fib operations
diff --git a/helper/ndn-fib-helper.cpp b/helper/ndn-fib-helper.cpp
new file mode 100644
index 0000000..ce3f529
--- /dev/null
+++ b/helper/ndn-fib-helper.cpp
@@ -0,0 +1,183 @@
+/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
+/**
+ * Copyright (c) 2011-2014 Regents of the University of California.
+ *
+ * This file is part of ndnSIM. See AUTHORS for complete list of ndnSIM authors and
+ * contributors.
+ *
+ * ndnSIM 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.
+ *
+ * ndnSIM 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
+ * ndnSIM, e.g., in COPYING.md file. If not, see <http://www.gnu.org/licenses/>.
+ **/
+
+#include "ndn-fib-helper.hpp"
+
+#include "ns3/assert.h"
+#include "ns3/log.h"
+#include "ns3/object.h"
+#include "ns3/names.h"
+#include "ns3/packet-socket-factory.h"
+#include "ns3/config.h"
+#include "ns3/simulator.h"
+#include "ns3/string.h"
+#include "ns3/net-device.h"
+#include "ns3/channel.h"
+#include "ns3/callback.h"
+#include "ns3/node.h"
+#include "ns3/core-config.h"
+#include "ns3/point-to-point-net-device.h"
+#include "ns3/point-to-point-helper.h"
+#include "ns3/callback.h"
+#include "ns3/node-list.h"
+#include "ns3/data-rate.h"
+
+#include "daemon/mgmt/fib-manager.hpp"
+#include "ns3/ndnSIM/model/ndn-l3-protocol.hpp"
+#include "ns3/ndnSIM/helper/ndn-stack-helper.hpp"
+
+
+namespace ns3 {
+namespace ndn {
+
+NS_LOG_COMPONENT_DEFINE("ndn.FibHelper");
+
+void
+FibHelper::AddNextHop(const ControlParameters& parameters, Ptr<Node> node)
+{
+ NS_LOG_DEBUG("Add Next Hop command was initialized");
+ Block encodedParameters(parameters.wireEncode());
+
+ Name commandName("/localhost/nfd/fib");
+ commandName.append("add-nexthop");
+ commandName.append(encodedParameters);
+
+ shared_ptr<Interest> command(make_shared<Interest>(commandName));
+ StackHelper::getKeyChain().signWithSha256(*command);
+
+ Ptr<L3Protocol> l3protocol = node->GetObject<L3Protocol>();
+ shared_ptr<nfd::FibManager> fibManager = l3protocol->getFibManager();
+ fibManager->onFibRequest(*command);
+}
+
+void
+FibHelper::RemoveNextHop(const ControlParameters& parameters, Ptr<Node> node)
+{
+ NS_LOG_DEBUG("Remove Next Hop command was initialized");
+ Block encodedParameters(parameters.wireEncode());
+
+ Name commandName("/localhost/nfd/fib");
+ commandName.append("remove-nexthop");
+ commandName.append(encodedParameters);
+
+ shared_ptr<Interest> command(make_shared<Interest>(commandName));
+ StackHelper::getKeyChain().signWithSha256(*command);
+
+ Ptr<L3Protocol> L3protocol = node->GetObject<L3Protocol>();
+ shared_ptr<nfd::FibManager> fibManager = L3protocol->getFibManager();
+ // fibManager->addInterestRule(commandName.toUri(), key, *keyChain.getPublicKey (key));
+ fibManager->onFibRequest(*command);
+}
+
+void
+FibHelper::AddRoute(Ptr<Node> node, const Name& prefix, shared_ptr<Face> face, int32_t metric)
+{
+ NS_LOG_LOGIC("[" << node->GetId() << "]$ route add " << prefix << " via " << face->getLocalUri()
+ << " metric " << metric);
+
+ // Get L3Protocol object
+ Ptr<L3Protocol> L3protocol = node->GetObject<L3Protocol>();
+ // Get the forwarder instance
+ shared_ptr<nfd::Forwarder> m_forwarder = L3protocol->getForwarder();
+
+ ControlParameters parameters;
+ parameters.setName(prefix);
+ parameters.setFaceId(face->getId());
+ parameters.setCost(metric);
+
+ AddNextHop(parameters, node);
+}
+
+void
+FibHelper::AddRoute(Ptr<Node> node, const Name& prefix, uint32_t faceId, int32_t metric)
+{
+ Ptr<L3Protocol> ndn = node->GetObject<L3Protocol>();
+ NS_ASSERT_MSG(ndn != 0, "Ndn stack should be installed on the node");
+
+ shared_ptr<Face> face = ndn->getFaceById(faceId);
+ NS_ASSERT_MSG(face != 0, "Face with ID [" << faceId << "] does not exist on node ["
+ << node->GetId() << "]");
+
+ AddRoute(node, prefix, face, metric);
+}
+
+void
+FibHelper::AddRoute(const std::string& nodeName, const Name& prefix, uint32_t faceId,
+ int32_t metric)
+{
+ Ptr<Node> node = Names::Find<Node>(nodeName);
+ NS_ASSERT_MSG(node != 0, "Node [" << nodeName << "] does not exist");
+
+ Ptr<L3Protocol> ndn = node->GetObject<L3Protocol>();
+ NS_ASSERT_MSG(ndn != 0, "Ndn stack should be installed on the node");
+
+ shared_ptr<Face> face = ndn->getFaceById(faceId);
+ NS_ASSERT_MSG(face != 0, "Face with ID [" << faceId << "] does not exist on node [" << nodeName
+ << "]");
+
+ AddRoute(node, prefix, face, metric);
+}
+
+void
+FibHelper::AddRoute(Ptr<Node> node, const Name& prefix, Ptr<Node> otherNode, int32_t metric)
+{
+ for (uint32_t deviceId = 0; deviceId < node->GetNDevices(); deviceId++) {
+ Ptr<PointToPointNetDevice> netDevice =
+ DynamicCast<PointToPointNetDevice>(node->GetDevice(deviceId));
+ if (netDevice == 0)
+ continue;
+
+ Ptr<Channel> channel = netDevice->GetChannel();
+ if (channel == 0)
+ continue;
+
+ if (channel->GetDevice(0)->GetNode() == otherNode
+ || channel->GetDevice(1)->GetNode() == otherNode) {
+ Ptr<L3Protocol> ndn = node->GetObject<L3Protocol>();
+ NS_ASSERT_MSG(ndn != 0, "Ndn stack should be installed on the node");
+
+ shared_ptr<Face> face = ndn->getFaceByNetDevice(netDevice);
+ NS_ASSERT_MSG(face != 0, "There is no face associated with the p2p link");
+
+ AddRoute(node, prefix, face, metric);
+
+ return;
+ }
+ }
+
+ NS_FATAL_ERROR("Cannot add route: Node# " << node->GetId() << " and Node# " << otherNode->GetId()
+ << " are not connected");
+}
+
+void
+FibHelper::AddRoute(const std::string& nodeName, const Name& prefix,
+ const std::string& otherNodeName, int32_t metric)
+{
+ Ptr<Node> node = Names::Find<Node>(nodeName);
+ NS_ASSERT_MSG(node != 0, "Node [" << nodeName << "] does not exist");
+
+ Ptr<Node> otherNode = Names::Find<Node>(otherNodeName);
+ NS_ASSERT_MSG(otherNode != 0, "Node [" << otherNodeName << "] does not exist");
+
+ AddRoute(node, prefix, otherNode, metric);
+}
+
+} // namespace ndn
+
+} // namespace ns
diff --git a/helper/ndn-fib-helper.hpp b/helper/ndn-fib-helper.hpp
new file mode 100644
index 0000000..d02059b
--- /dev/null
+++ b/helper/ndn-fib-helper.hpp
@@ -0,0 +1,111 @@
+/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
+/**
+ * Copyright (c) 2011-2014 Regents of the University of California.
+ *
+ * This file is part of ndnSIM. See AUTHORS for complete list of ndnSIM authors and
+ * contributors.
+ *
+ * ndnSIM 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.
+ *
+ * ndnSIM 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
+ * ndnSIM, e.g., in COPYING.md file. If not, see <http://www.gnu.org/licenses/>.
+ **/
+
+#ifndef NDN_FIB_HELPER_H
+#define NDN_FIB_HELPER_H
+
+#include "ns3/ndnSIM/model/ndn-common.hpp"
+#include "ns3/ndnSIM/model/ndn-face.hpp"
+
+#include "ns3/node.h"
+#include "ns3/object-vector.h"
+#include "ns3/pointer.h"
+
+#include <ndn-cxx/management/nfd-control-parameters.hpp>
+
+namespace ns3 {
+namespace ndn {
+
+using ::ndn::nfd::ControlParameters;
+
+class FibHelper {
+public:
+ /**
+ * \brief Add forwarding entry to FIB
+ *
+ * \param nodeName Node name
+ * \param prefix Routing prefix
+ * \param faceId Face index
+ * \param metric Routing metric
+ */
+ static void
+ AddRoute(const std::string& nodeName, const Name& prefix, uint32_t faceId, int32_t metric);
+
+ /**
+ * \brief Add forwarding entry to FIB
+ *
+ * \param nodeName Node
+ * \param prefix Routing prefix
+ * \param faceId Face index
+ * \param metric Routing metric
+ */
+ static void
+ AddRoute(Ptr<Node> node, const Name& prefix, uint32_t faceId, int32_t metric);
+
+ /**
+ * \brief Add forwarding entry to FIB
+ *
+ * \param node Node
+ * \param prefix Routing prefix
+ * \param face Face
+ * \param metric Routing metric
+ */
+ static void
+ AddRoute(Ptr<Node> node, const Name& prefix, shared_ptr<Face> face, int32_t metric);
+
+ /**
+ * @brief Add forwarding entry to FIB (work only with point-to-point links)
+ *
+ * \param node Node
+ * \param prefix Routing prefix
+ * \param otherNode The other node, to which interests (will be used to infer face id
+ * \param metric Routing metric
+ */
+ static void
+ AddRoute(Ptr<Node> node, const Name& prefix, Ptr<Node> otherNode, int32_t metric);
+
+ /**
+ * @brief Add forwarding entry to FIB (work only with point-to-point links)
+ *
+ * \param nodeName Node name (refer to ns3::Names)
+ * \param prefix Routing prefix
+ * \param otherNode The other node name, to which interests (will be
+ * used to infer face id (refer to ns3::Names)
+ * \param metric Routing metric
+ */
+ static void
+ AddRoute(const std::string& nodeName, const Name& prefix, const std::string& otherNodeName,
+ int32_t metric);
+
+private:
+ static void
+ GenerateCommand(Interest& interest);
+
+ static void
+ AddNextHop(const ControlParameters& parameters, Ptr<Node> node);
+
+ static void
+ RemoveNextHop(const ControlParameters& parameters, Ptr<Node> node);
+};
+
+} // namespace ndn
+
+} // namespace ns3
+
+#endif // NDN_FIB_HELPER_H
diff --git a/helper/ndn-stack-helper.cpp b/helper/ndn-stack-helper.cpp
index a1a3292..2413fb9 100644
--- a/helper/ndn-stack-helper.cpp
+++ b/helper/ndn-stack-helper.cpp
@@ -40,6 +40,7 @@
namespace ndn {
StackHelper::StackHelper()
+ : m_needSetDefaultRoutes(false)
{
setCustomNdnCxxClocks();
@@ -70,6 +71,13 @@
make_shared<ns3::ndn::time::CustomSystemClock>());
}
+void
+StackHelper::SetDefaultRoutes(bool needSet)
+{
+ NS_LOG_FUNCTION(this << needSet);
+ m_needSetDefaultRoutes = needSet;
+}
+
Ptr<FaceContainer>
StackHelper::Install(const NodeContainer& c) const
{
@@ -126,6 +134,11 @@
face = DefaultNetDeviceCallback(node, ndn, device);
}
+ if (m_needSetDefaultRoutes) {
+ // default route with lowest priority possible
+ FibHelper::AddRoute(node, "/", face, std::numeric_limits<int32_t>::max());
+ }
+
faces->Add(face);
}
diff --git a/helper/ndn-stack-helper.hpp b/helper/ndn-stack-helper.hpp
index 2f3ea3b..bc9ff3e 100644
--- a/helper/ndn-stack-helper.hpp
+++ b/helper/ndn-stack-helper.hpp
@@ -30,6 +30,7 @@
#include "ns3/node-container.h"
#include "ndn-face-container.hpp"
+#include "ndn-fib-helper.hpp"
namespace ns3 {
@@ -167,6 +168,12 @@
Ptr<FaceContainer>
InstallAll() const;
+ /**
+ * \brief Set flag indicating necessity to install default routes in FIB
+ */
+ void
+ SetDefaultRoutes(bool needSet);
+
static KeyChain&
getKeyChain();
diff --git a/wscript b/wscript
index 21e05d3..c46c59d 100644
--- a/wscript
+++ b/wscript
@@ -89,7 +89,8 @@
'helper/*',
'utils/*/*'])
module.source += bld.path.ant_glob(['helper/ndn-face-container.cpp',
- 'helper/ndn-stack-helper.cpp'])
+ 'helper/ndn-stack-helper.cpp',
+ 'helper/ndn-fib-helper.cpp'])
module.full_headers = [p.path_from(bld.path) for p in bld.path.ant_glob(
['%s/**/*.hpp' % dir for dir in module_dirs])]