Alexander Afanasyev | c74a602 | 2011-08-15 20:01:35 -0700 | [diff] [blame] | 1 | /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil -*- */ |
Alexander Afanasyev | 7112f48 | 2011-08-17 14:05:57 -0700 | [diff] [blame] | 2 | /* |
| 3 | * Copyright (c) 2011 University of California, Los Angeles |
| 4 | * |
| 5 | * This program is free software; you can redistribute it and/or modify |
| 6 | * it under the terms of the GNU General Public License version 2 as |
| 7 | * published by the Free Software Foundation; |
| 8 | * |
| 9 | * This program is distributed in the hope that it will be useful, |
| 10 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 11 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 12 | * GNU General Public License for more details. |
| 13 | * |
| 14 | * You should have received a copy of the GNU General Public License |
| 15 | * along with this program; if not, write to the Free Software |
| 16 | * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA |
| 17 | * |
| 18 | * Author: Alexander Afanasyev <alexander.afanasyev@ucla.edu> |
| 19 | */ |
Alexander Afanasyev | 08d984e | 2011-08-13 19:20:22 -0700 | [diff] [blame] | 20 | |
| 21 | #ifndef CCNX_L3_PROTOCOL_H |
| 22 | #define CCNX_L3_PROTOCOL_H |
| 23 | |
| 24 | #include <list> |
| 25 | #include <vector> |
| 26 | #include <stdint.h> |
| 27 | #include "ns3/ptr.h" |
| 28 | #include "ns3/net-device.h" |
Alexander Afanasyev | 08d984e | 2011-08-13 19:20:22 -0700 | [diff] [blame] | 29 | #include "ns3/traced-callback.h" |
| 30 | |
Alexander Afanasyev | a67e28c | 2011-08-31 21:16:25 -0700 | [diff] [blame^] | 31 | #include "ccnx-content-store.h" |
| 32 | #include "ccnx-rit.h" |
| 33 | #include "ccnx-pit.h" |
| 34 | #include "ccnx-fib.h" |
| 35 | |
Alexander Afanasyev | 45b92d4 | 2011-08-14 23:11:38 -0700 | [diff] [blame] | 36 | #include "ccnx.h" |
| 37 | |
Alexander Afanasyev | 08d984e | 2011-08-13 19:20:22 -0700 | [diff] [blame] | 38 | namespace ns3 { |
| 39 | |
| 40 | class Packet; |
| 41 | class NetDevice; |
Alexander Afanasyev | 08d984e | 2011-08-13 19:20:22 -0700 | [diff] [blame] | 42 | class Node; |
Alexander Afanasyev | 45b92d4 | 2011-08-14 23:11:38 -0700 | [diff] [blame] | 43 | class CcnxFace; |
| 44 | class CcnxRoute; |
Alexander Afanasyev | c74a602 | 2011-08-15 20:01:35 -0700 | [diff] [blame] | 45 | class CcnxForwardingStrategy; |
| 46 | class Header; |
| 47 | class CcnxInterestHeader; |
| 48 | class CcnxContentObjectHeader; |
Alexander Afanasyev | a67e28c | 2011-08-31 21:16:25 -0700 | [diff] [blame^] | 49 | |
Alexander Afanasyev | 08d984e | 2011-08-13 19:20:22 -0700 | [diff] [blame] | 50 | /** |
Alexander Afanasyev | 7112f48 | 2011-08-17 14:05:57 -0700 | [diff] [blame] | 51 | * \ingroup ccnx |
| 52 | * \brief Actual implementation of the Ccnx network layer |
Alexander Afanasyev | 08d984e | 2011-08-13 19:20:22 -0700 | [diff] [blame] | 53 | * |
Alexander Afanasyev | 7112f48 | 2011-08-17 14:05:57 -0700 | [diff] [blame] | 54 | * \todo This description is incorrect. Should be changed accordingly |
Alexander Afanasyev | 08d984e | 2011-08-13 19:20:22 -0700 | [diff] [blame] | 55 | * |
| 56 | * This class contains two distinct groups of trace sources. The |
| 57 | * trace sources 'Rx' and 'Tx' are called, respectively, immediately |
| 58 | * after receiving from the NetDevice and immediately before sending |
| 59 | * to a NetDevice for transmitting a packet. These are low level |
| 60 | * trace sources that include the CcnxHeader already serialized into |
| 61 | * the packet. In contrast, the Drop, SendOutgoing, UnicastForward, |
| 62 | * and LocalDeliver trace sources are slightly higher-level and pass |
| 63 | * around the CcnxHeader as an explicit parameter and not as part of |
| 64 | * the packet. |
| 65 | */ |
| 66 | class CcnxL3Protocol : public Ccnx |
| 67 | { |
| 68 | public: |
Alexander Afanasyev | 7112f48 | 2011-08-17 14:05:57 -0700 | [diff] [blame] | 69 | /** |
| 70 | * \brief Interface ID |
| 71 | * |
| 72 | * \return interface ID |
| 73 | */ |
Alexander Afanasyev | 56f79ea | 2011-08-17 23:54:27 -0700 | [diff] [blame] | 74 | static TypeId GetTypeId (); |
Alexander Afanasyev | 08d984e | 2011-08-13 19:20:22 -0700 | [diff] [blame] | 75 | |
Alexander Afanasyev | 7112f48 | 2011-08-17 14:05:57 -0700 | [diff] [blame] | 76 | static const uint16_t ETHERNET_FRAME_TYPE; ///< \brief Ethernet Frame Type of CCNx |
| 77 | static const uint16_t IP_PROTOCOL_TYPE; ///< \brief IP protocol type of CCNx |
| 78 | static const uint16_t UDP_PORT; ///< \brief UDP port of CCNx |
| 79 | |
| 80 | /** |
| 81 | * \brief Default constructor. Creates an empty stack without forwarding strategy set |
| 82 | */ |
Alexander Afanasyev | 08d984e | 2011-08-13 19:20:22 -0700 | [diff] [blame] | 83 | CcnxL3Protocol(); |
| 84 | virtual ~CcnxL3Protocol (); |
| 85 | |
| 86 | /** |
| 87 | * \enum DropReason |
| 88 | * \brief Reason why a packet has been dropped. |
| 89 | */ |
| 90 | enum DropReason |
| 91 | { |
Alexander Afanasyev | 9825610 | 2011-08-14 01:00:02 -0700 | [diff] [blame] | 92 | /** \todo Fill reasons from QualNet code */ |
| 93 | DROP_DUPLICATE_INTEREST=1, /**< Duplicate Interest */ |
| 94 | DROP_CONGESTION, /**< Congestion detected */ |
Alexander Afanasyev | 08d984e | 2011-08-13 19:20:22 -0700 | [diff] [blame] | 95 | DROP_NO_ROUTE, /**< No route to host */ |
Alexander Afanasyev | 08d984e | 2011-08-13 19:20:22 -0700 | [diff] [blame] | 96 | DROP_INTERFACE_DOWN, /**< Interface is down so can not send packet */ |
Alexander Afanasyev | 08d984e | 2011-08-13 19:20:22 -0700 | [diff] [blame] | 97 | }; |
| 98 | |
Alexander Afanasyev | 7112f48 | 2011-08-17 14:05:57 -0700 | [diff] [blame] | 99 | /** |
| 100 | * \brief Assigns node to the CCNx stack |
| 101 | * |
| 102 | * \param node Simulation node |
| 103 | */ |
Alexander Afanasyev | 08d984e | 2011-08-13 19:20:22 -0700 | [diff] [blame] | 104 | void SetNode (Ptr<Node> node); |
| 105 | |
Alexander Afanasyev | 7112f48 | 2011-08-17 14:05:57 -0700 | [diff] [blame] | 106 | //////////////////////////////////////////////////////////////////// |
Alexander Afanasyev | 08d984e | 2011-08-13 19:20:22 -0700 | [diff] [blame] | 107 | // functions defined in base class Ccnx |
Alexander Afanasyev | 9825610 | 2011-08-14 01:00:02 -0700 | [diff] [blame] | 108 | |
Alexander Afanasyev | c74a602 | 2011-08-15 20:01:35 -0700 | [diff] [blame] | 109 | void SetForwardingStrategy (Ptr<CcnxForwardingStrategy> forwardingStrategy); |
Alexander Afanasyev | 56f79ea | 2011-08-17 23:54:27 -0700 | [diff] [blame] | 110 | Ptr<CcnxForwardingStrategy> GetForwardingStrategy () const; |
Alexander Afanasyev | 08d984e | 2011-08-13 19:20:22 -0700 | [diff] [blame] | 111 | |
Alexander Afanasyev | 56f79ea | 2011-08-17 23:54:27 -0700 | [diff] [blame] | 112 | virtual void Send (const Ptr<CcnxFace> &face, const Ptr<Packet> &packet); |
Alexander Afanasyev | 0ab833e | 2011-08-18 15:49:13 -0700 | [diff] [blame] | 113 | virtual void Receive (const Ptr<CcnxFace> &face, const Ptr<const Packet> &p); |
Alexander Afanasyev | 7112f48 | 2011-08-17 14:05:57 -0700 | [diff] [blame] | 114 | |
| 115 | virtual uint32_t AddFace (const Ptr<CcnxFace> &face); |
Alexander Afanasyev | 56f79ea | 2011-08-17 23:54:27 -0700 | [diff] [blame] | 116 | virtual uint32_t GetNFaces () const; |
Alexander Afanasyev | 7112f48 | 2011-08-17 14:05:57 -0700 | [diff] [blame] | 117 | virtual Ptr<CcnxFace> GetFace (uint32_t face) const; |
| 118 | |
Alexander Afanasyev | 7112f48 | 2011-08-17 14:05:57 -0700 | [diff] [blame] | 119 | protected: |
Alexander Afanasyev | 08d984e | 2011-08-13 19:20:22 -0700 | [diff] [blame] | 120 | /** |
Alexander Afanasyev | 0ab833e | 2011-08-18 15:49:13 -0700 | [diff] [blame] | 121 | * \brief Actual processing of incoming CCNx interests |
Alexander Afanasyev | c74a602 | 2011-08-15 20:01:35 -0700 | [diff] [blame] | 122 | * |
| 123 | * Processing Interest packets |
Alexander Afanasyev | 9825610 | 2011-08-14 01:00:02 -0700 | [diff] [blame] | 124 | */ |
Alexander Afanasyev | c74a602 | 2011-08-15 20:01:35 -0700 | [diff] [blame] | 125 | virtual void |
Alexander Afanasyev | a67e28c | 2011-08-31 21:16:25 -0700 | [diff] [blame^] | 126 | OnInterest (const Ptr<CcnxFace> &face, |
| 127 | Ptr<CcnxInterestHeader> &header, |
| 128 | Ptr<Packet> &p); |
Alexander Afanasyev | c74a602 | 2011-08-15 20:01:35 -0700 | [diff] [blame] | 129 | |
| 130 | |
| 131 | /** |
Alexander Afanasyev | 0ab833e | 2011-08-18 15:49:13 -0700 | [diff] [blame] | 132 | * \brief Actual processing of incoming CCNx content objects |
Alexander Afanasyev | c74a602 | 2011-08-15 20:01:35 -0700 | [diff] [blame] | 133 | * |
| 134 | * Processing ContentObject packets |
| 135 | */ |
| 136 | virtual void |
Alexander Afanasyev | a67e28c | 2011-08-31 21:16:25 -0700 | [diff] [blame^] | 137 | OnData (const Ptr<CcnxFace> &face, |
| 138 | Ptr<CcnxContentObjectHeader> &header, |
| 139 | Ptr<Packet> &p); |
Alexander Afanasyev | 08d984e | 2011-08-13 19:20:22 -0700 | [diff] [blame] | 140 | |
| 141 | protected: |
Alexander Afanasyev | 08d984e | 2011-08-13 19:20:22 -0700 | [diff] [blame] | 142 | virtual void DoDispose (void); |
Alexander Afanasyev | 7112f48 | 2011-08-17 14:05:57 -0700 | [diff] [blame] | 143 | |
Alexander Afanasyev | 08d984e | 2011-08-13 19:20:22 -0700 | [diff] [blame] | 144 | /** |
| 145 | * This function will notify other components connected to the node that a new stack member is now connected |
| 146 | * This will be used to notify Layer 3 protocol of layer 4 protocol stack to connect them together. |
| 147 | */ |
| 148 | virtual void NotifyNewAggregate (); |
Alexander Afanasyev | 9825610 | 2011-08-14 01:00:02 -0700 | [diff] [blame] | 149 | |
Alexander Afanasyev | 08d984e | 2011-08-13 19:20:22 -0700 | [diff] [blame] | 150 | private: |
Alexander Afanasyev | 7112f48 | 2011-08-17 14:05:57 -0700 | [diff] [blame] | 151 | CcnxL3Protocol(const CcnxL3Protocol &); ///< copy constructor is disabled |
| 152 | CcnxL3Protocol &operator = (const CcnxL3Protocol &); ///< copy operator is disabled |
Alexander Afanasyev | 08d984e | 2011-08-13 19:20:22 -0700 | [diff] [blame] | 153 | |
Alexander Afanasyev | a67e28c | 2011-08-31 21:16:25 -0700 | [diff] [blame^] | 154 | // /** |
| 155 | // * \brief Fake function. should never be called. Just to trick C++ to compile |
| 156 | // */ |
| 157 | // virtual void |
| 158 | // ReceiveAndProcess (const Ptr<CcnxFace> face, Ptr<Header> header, Ptr<Packet> p); |
Alexander Afanasyev | c74a602 | 2011-08-15 20:01:35 -0700 | [diff] [blame] | 159 | |
Alexander Afanasyev | 9825610 | 2011-08-14 01:00:02 -0700 | [diff] [blame] | 160 | private: |
Alexander Afanasyev | 0ab833e | 2011-08-18 15:49:13 -0700 | [diff] [blame] | 161 | uint32_t m_faceCounter; ///< \brief counter of faces. Increased every time a new face is added to the stack |
Alexander Afanasyev | 9825610 | 2011-08-14 01:00:02 -0700 | [diff] [blame] | 162 | typedef std::vector<Ptr<CcnxFace> > CcnxFaceList; |
Alexander Afanasyev | 0ab833e | 2011-08-18 15:49:13 -0700 | [diff] [blame] | 163 | CcnxFaceList m_faces; ///< \brief list of faces that belongs to ccnx stack on this node |
Alexander Afanasyev | 08d984e | 2011-08-13 19:20:22 -0700 | [diff] [blame] | 164 | |
Alexander Afanasyev | 0ab833e | 2011-08-18 15:49:13 -0700 | [diff] [blame] | 165 | Ptr<Node> m_node; ///< \brief node on which ccnx stack is installed |
| 166 | Ptr<CcnxForwardingStrategy> m_forwardingStrategy; ///< \brief smart pointer to the selected forwarding strategy |
Alexander Afanasyev | 08d984e | 2011-08-13 19:20:22 -0700 | [diff] [blame] | 167 | |
Alexander Afanasyev | a67e28c | 2011-08-31 21:16:25 -0700 | [diff] [blame^] | 168 | CcnxRit m_rit; ///< \brief RIT (recently interest table) |
| 169 | CcnxPit m_pit; ///< \brief PIT (pending interest table) |
| 170 | CcnxFib m_fib; ///< \brief FIB |
Alexander Afanasyev | 070aa48 | 2011-08-20 00:38:25 -0700 | [diff] [blame] | 171 | |
Alexander Afanasyev | a67e28c | 2011-08-31 21:16:25 -0700 | [diff] [blame^] | 172 | CcnxContentStore m_contentStore; ///< \brief Content store (for caching purposes only) |
| 173 | |
| 174 | TracedCallback<Ptr<const Packet>, Ptr<Ccnx>, Ptr<const CcnxFace> > m_receivedInterestsTrace; |
| 175 | TracedCallback<Ptr<const Packet>, Ptr<Ccnx>, Ptr<const CcnxFace> > m_transmittedInterestsTrace; |
Alexander Afanasyev | 08d984e | 2011-08-13 19:20:22 -0700 | [diff] [blame] | 176 | |
Alexander Afanasyev | a67e28c | 2011-08-31 21:16:25 -0700 | [diff] [blame^] | 177 | TracedCallback<Ptr<const Packet>, Ptr<Ccnx>, Ptr<const CcnxFace> > m_receivedDataTrace; |
| 178 | TracedCallback<Ptr<const Packet>, Ptr<Ccnx>, Ptr<const CcnxFace> > m_transmittedDataTrace; |
| 179 | |
Alexander Afanasyev | 070aa48 | 2011-08-20 00:38:25 -0700 | [diff] [blame] | 180 | /** |
| 181 | * \brief Trace of dropped packets, including reason and all headers |
| 182 | * \internal |
| 183 | */ |
| 184 | TracedCallback<Ptr<const Packet>, DropReason, Ptr<const Ccnx>, Ptr<const CcnxFace> > m_dropTrace; |
Alexander Afanasyev | 08d984e | 2011-08-13 19:20:22 -0700 | [diff] [blame] | 185 | }; |
| 186 | |
| 187 | } // Namespace ns3 |
| 188 | |
| 189 | #endif /* CCNX_L3_PROTOCOL_H */ |