blob: ffd3bc260641d8127106d1d668462cb09843f35a [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 Afanasyev7112f482011-08-17 14:05:57 -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 Afanasyev7112f482011-08-17 14:05:57 -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 Afanasyev7112f482011-08-17 14:05:57 -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 Afanasyev7112f482011-08-17 14:05:57 -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 Afanasyev08d984e2011-08-13 19:20:22 -070019
Alexander Afanasyev4aac5572012-08-09 10:49:55 -070020#ifndef NDN_L3_PROTOCOL_H
21#define NDN_L3_PROTOCOL_H
Alexander Afanasyev08d984e2011-08-13 19:20:22 -070022
Spyridon Mastorakis53e922f2014-10-17 17:29:26 -070023#include "ns3/ndnSIM/model/ndn-common.hpp"
Alexander Afanasyev82d5ffe2014-12-30 23:55:38 -080024#include "ns3/ndnSIM/model/ndn-face.hpp"
Spyridon Mastorakis53e922f2014-10-17 17:29:26 -070025
Alexander Afanasyev08d984e2011-08-13 19:20:22 -070026#include <list>
27#include <vector>
Alexander Afanasyev4975f732011-12-20 17:52:19 -080028
Alexander Afanasyev08d984e2011-08-13 19:20:22 -070029#include "ns3/ptr.h"
30#include "ns3/net-device.h"
Ilya Moiseenkod83eb0d2011-11-16 15:23:46 -080031#include "ns3/nstime.h"
Spyridon Mastorakis9760bd02014-11-12 13:32:55 -080032#include "ns3/traced-callback.h"
33
Alexander Afanasyevdde1e812015-01-06 14:26:09 -080034#include <boost/property_tree/ptree_fwd.hpp>
35
Spyridon Mastorakis9760bd02014-11-12 13:32:55 -080036namespace nfd {
37class Forwarder;
38class FibManager;
39class StrategyChoiceManager;
Alexander Afanasyevdde1e812015-01-06 14:26:09 -080040typedef boost::property_tree::ptree ConfigSection;
Alexander Afanasyevdc6fae82015-01-08 21:44:15 -080041namespace pit {
42class Entry;
43} // namespace pit
Spyridon Mastorakis9760bd02014-11-12 13:32:55 -080044} // namespace nfd
Alexander Afanasyev08d984e2011-08-13 19:20:22 -070045
46namespace ns3 {
47
48class Packet;
Alexander Afanasyev08d984e2011-08-13 19:20:22 -070049class Node;
Alexander Afanasyevc74a6022011-08-15 20:01:35 -070050class Header;
Ilya Moiseenko172763c2011-10-28 13:21:53 -070051
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -070052namespace ndn {
53
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -070054/**
55 * \defgroup ndn ndnSIM: NDN simulation module
56 *
Alexander Afanasyevb989b122013-07-10 17:15:46 -070057 * This is a modular implementation of NDN protocol for NS-3
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -070058 */
Alexander Afanasyev08d984e2011-08-13 19:20:22 -070059/**
Alexander Afanasyev4aac5572012-08-09 10:49:55 -070060 * \ingroup ndn
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -070061 * \brief Implementation network-layer of NDN stack
Alexander Afanasyev08d984e2011-08-13 19:20:22 -070062 *
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -070063 * This class defines the API to manipulate the following aspects of
64 * the NDN stack implementation:
65 * -# register a face (Face-derived object) for use by the NDN
66 * layer
Alexander Afanasyevbe55cf62014-12-20 17:51:09 -080067 *
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -070068 * Each Face-derived object has conceptually a single NDN
69 * interface associated with it.
70 *
71 * In addition, this class defines NDN packet coding constants
72 *
73 * \see Face, ForwardingStrategy
Alexander Afanasyev08d984e2011-08-13 19:20:22 -070074 */
Spyridon Mastorakis9760bd02014-11-12 13:32:55 -080075class L3Protocol : boost::noncopyable, public Object {
Alexander Afanasyev08d984e2011-08-13 19:20:22 -070076public:
Alexander Afanasyev7112f482011-08-17 14:05:57 -070077 /**
78 * \brief Interface ID
79 *
80 * \return interface ID
81 */
Alexander Afanasyevbe55cf62014-12-20 17:51:09 -080082 static TypeId
83 GetTypeId();
Alexander Afanasyev08d984e2011-08-13 19:20:22 -070084
Alexander Afanasyev016a5d82013-07-15 10:41:29 -070085 static const uint16_t ETHERNET_FRAME_TYPE; ///< @brief Ethernet Frame Type of Ndn
86 static const uint16_t IP_STACK_PORT; ///< @brief TCP/UDP port for NDN stack
87 // static const uint16_t IP_PROTOCOL_TYPE; ///< \brief IP protocol type of NDN
Alexander Afanasyev7112f482011-08-17 14:05:57 -070088
89 /**
90 * \brief Default constructor. Creates an empty stack without forwarding strategy set
91 */
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -070092 L3Protocol();
Alexander Afanasyevbe55cf62014-12-20 17:51:09 -080093 virtual ~L3Protocol();
Alexander Afanasyev08d984e2011-08-13 19:20:22 -070094
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -070095 /**
Spyridon Mastorakis9760bd02014-11-12 13:32:55 -080096 * \brief Initialize NFD instance
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -070097 */
Spyridon Mastorakis9760bd02014-11-12 13:32:55 -080098 void
Alexander Afanasyevdde1e812015-01-06 14:26:09 -080099 initialize();
Alexander Afanasyevbe55cf62014-12-20 17:51:09 -0800100
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -0700101 /**
Spyridon Mastorakis9760bd02014-11-12 13:32:55 -0800102 * \brief Get smart pointer to nfd::Forwarder installed on the node
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -0700103 */
Spyridon Mastorakis9760bd02014-11-12 13:32:55 -0800104 shared_ptr<nfd::Forwarder>
105 getForwarder();
Alexander Afanasyevaebf5cf2012-08-28 17:32:17 -0700106
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -0700107 /**
Spyridon Mastorakis9760bd02014-11-12 13:32:55 -0800108 * \brief Get smart pointer to nfd::FibManager, used by node's NFD
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -0700109 */
Spyridon Mastorakis9760bd02014-11-12 13:32:55 -0800110 shared_ptr<nfd::FibManager>
111 getFibManager();
112
113 /**
114 * \brief Get smart pointer to nfd::StrategyChoiceManager, used by node's NFD
115 */
116 shared_ptr<nfd::StrategyChoiceManager>
117 getStrategyChoiceManager();
118
119
120 /**
121 * \brief Add face to NDN stack
122 *
123 * \param face smart pointer to Face-derived object (AppFace, NetDeviceFace)
124 * \return nfd::FaceId
125 *
126 * \see AppFace, NetDeviceFace
127 */
128 nfd::FaceId
129 addFace(shared_ptr<Face> face);
Alexander Afanasyevbe55cf62014-12-20 17:51:09 -0800130
Alexander Afanasyevaebf5cf2012-08-28 17:32:17 -0700131 /**
132 * \brief Get face by face ID
133 * \param face The face ID number
Spyridon Mastorakis9760bd02014-11-12 13:32:55 -0800134 * \returns The Face associated with the Ndn face number.
Alexander Afanasyevaebf5cf2012-08-28 17:32:17 -0700135 */
Spyridon Mastorakis9760bd02014-11-12 13:32:55 -0800136 shared_ptr<Face>
137 getFaceById(nfd::FaceId face) const;
Alexander Afanasyev7112f482011-08-17 14:05:57 -0700138
Spyridon Mastorakis9760bd02014-11-12 13:32:55 -0800139 // /**
140 // * \brief Remove face from ndn stack (remove callbacks)
141 // */
142 // virtual void
143 // removeFace(shared_ptr<Face> face);
Alexander Afanasyev52e9aa92011-11-15 20:23:20 -0800144
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -0700145 /**
146 * \brief Get face for NetDevice
147 */
Spyridon Mastorakis9760bd02014-11-12 13:32:55 -0800148 shared_ptr<Face>
149 getFaceByNetDevice(Ptr<NetDevice> netDevice) const;
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -0700150
Alexander Afanasyevdde1e812015-01-06 14:26:09 -0800151 /**
152 * \brief Get NFD config (boost::property_tree)
153 */
154 nfd::ConfigSection&
155 getConfig();
156
Alexander Afanasyev6b2a3c02015-01-03 02:04:23 -0800157public: // Workaround for python bindings
158 static Ptr<L3Protocol>
159 getL3Protocol(Ptr<Object> node);
160
Alexander Afanasyev08d984e2011-08-13 19:20:22 -0700161protected:
Alexander Afanasyevbe55cf62014-12-20 17:51:09 -0800162 virtual void
163 DoDispose(void); ///< @brief Do cleanup
Alexander Afanasyev7112f482011-08-17 14:05:57 -0700164
Alexander Afanasyev08d984e2011-08-13 19:20:22 -0700165 /**
Alexander Afanasyevbe55cf62014-12-20 17:51:09 -0800166 * This function will notify other components connected to the node that a new stack member is now
167 * connected
168 * This will be used to notify Layer 3 protocol of layer 4 protocol stack to connect them
169 * together.
Alexander Afanasyev08d984e2011-08-13 19:20:22 -0700170 */
Alexander Afanasyevbe55cf62014-12-20 17:51:09 -0800171 virtual void
172 NotifyNewAggregate();
Alexander Afanasyev98256102011-08-14 01:00:02 -0700173
Alexander Afanasyev08d984e2011-08-13 19:20:22 -0700174private:
Spyridon Mastorakis9760bd02014-11-12 13:32:55 -0800175 void
Alexander Afanasyevdde1e812015-01-06 14:26:09 -0800176 initializeManagement();
Alexander Afanasyevbe55cf62014-12-20 17:51:09 -0800177
Alexander Afanasyev98256102011-08-14 01:00:02 -0700178private:
Spyridon Mastorakis9760bd02014-11-12 13:32:55 -0800179 class Impl;
180 std::unique_ptr<Impl> m_impl;
181
182 // These objects are aggregated, but for optimization, get them here
Alexander Afanasyev4aac5572012-08-09 10:49:55 -0700183 Ptr<Node> m_node; ///< \brief node on which ndn stack is installed
Spyridon Mastorakis9760bd02014-11-12 13:32:55 -0800184
185 TracedCallback<const Interest&, const Face&>
186 m_inInterests; ///< @brief trace of incoming Interests
187 TracedCallback<const Interest&, const Face&>
188 m_outInterests; ///< @brief Transmitted interests trace
189
190 TracedCallback<const Data&, const Face&> m_outData; ///< @brief trace of outgoing Data
191 TracedCallback<const Data&, const Face&> m_inData; ///< @brief trace of incoming Data
Alexander Afanasyevdc6fae82015-01-08 21:44:15 -0800192
193 TracedCallback<const nfd::pit::Entry&, const Face&/*in face*/, const Data&> m_satisfiedInterests;
194 TracedCallback<const nfd::pit::Entry&> m_timedOutInterests;
Alexander Afanasyev08d984e2011-08-13 19:20:22 -0700195};
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -0700196
197} // namespace ndn
198} // namespace ns3
Alexander Afanasyev08d984e2011-08-13 19:20:22 -0700199
Alexander Afanasyev4aac5572012-08-09 10:49:55 -0700200#endif /* NDN_L3_PROTOCOL_H */