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" |
Ilya Moiseenko | d83eb0d | 2011-11-16 15:23:46 -0800 | [diff] [blame] | 29 | #include "ns3/nstime.h" |
| 30 | #include "ns3/simulator.h" |
Alexander Afanasyev | 08d984e | 2011-08-13 19:20:22 -0700 | [diff] [blame] | 31 | |
Ilya Moiseenko | 172763c | 2011-10-28 13:21:53 -0700 | [diff] [blame] | 32 | #include "ns3/ccnx-producer-helper.h" |
Alexander Afanasyev | a67e28c | 2011-08-31 21:16:25 -0700 | [diff] [blame] | 33 | #include "ccnx-content-store.h" |
Alexander Afanasyev | a67e28c | 2011-08-31 21:16:25 -0700 | [diff] [blame] | 34 | #include "ccnx-pit.h" |
| 35 | #include "ccnx-fib.h" |
| 36 | |
Alexander Afanasyev | 45b92d4 | 2011-08-14 23:11:38 -0700 | [diff] [blame] | 37 | #include "ccnx.h" |
| 38 | |
Alexander Afanasyev | 08d984e | 2011-08-13 19:20:22 -0700 | [diff] [blame] | 39 | namespace ns3 { |
| 40 | |
| 41 | class Packet; |
| 42 | class NetDevice; |
Alexander Afanasyev | 08d984e | 2011-08-13 19:20:22 -0700 | [diff] [blame] | 43 | class Node; |
Alexander Afanasyev | 45b92d4 | 2011-08-14 23:11:38 -0700 | [diff] [blame] | 44 | class CcnxFace; |
| 45 | class CcnxRoute; |
Alexander Afanasyev | c74a602 | 2011-08-15 20:01:35 -0700 | [diff] [blame] | 46 | class CcnxForwardingStrategy; |
| 47 | class Header; |
| 48 | class CcnxInterestHeader; |
| 49 | class CcnxContentObjectHeader; |
Ilya Moiseenko | 172763c | 2011-10-28 13:21:53 -0700 | [diff] [blame] | 50 | |
| 51 | |
Alexander Afanasyev | 08d984e | 2011-08-13 19:20:22 -0700 | [diff] [blame] | 52 | /** |
Alexander Afanasyev | 7112f48 | 2011-08-17 14:05:57 -0700 | [diff] [blame] | 53 | * \ingroup ccnx |
| 54 | * \brief Actual implementation of the Ccnx network layer |
Alexander Afanasyev | 08d984e | 2011-08-13 19:20:22 -0700 | [diff] [blame] | 55 | * |
Alexander Afanasyev | 7112f48 | 2011-08-17 14:05:57 -0700 | [diff] [blame] | 56 | * \todo This description is incorrect. Should be changed accordingly |
Alexander Afanasyev | 08d984e | 2011-08-13 19:20:22 -0700 | [diff] [blame] | 57 | * |
| 58 | * This class contains two distinct groups of trace sources. The |
| 59 | * trace sources 'Rx' and 'Tx' are called, respectively, immediately |
| 60 | * after receiving from the NetDevice and immediately before sending |
| 61 | * to a NetDevice for transmitting a packet. These are low level |
| 62 | * trace sources that include the CcnxHeader already serialized into |
| 63 | * the packet. In contrast, the Drop, SendOutgoing, UnicastForward, |
| 64 | * and LocalDeliver trace sources are slightly higher-level and pass |
| 65 | * around the CcnxHeader as an explicit parameter and not as part of |
| 66 | * the packet. |
| 67 | */ |
| 68 | class CcnxL3Protocol : public Ccnx |
| 69 | { |
| 70 | public: |
Alexander Afanasyev | 7112f48 | 2011-08-17 14:05:57 -0700 | [diff] [blame] | 71 | /** |
| 72 | * \brief Interface ID |
| 73 | * |
| 74 | * \return interface ID |
| 75 | */ |
Alexander Afanasyev | 56f79ea | 2011-08-17 23:54:27 -0700 | [diff] [blame] | 76 | static TypeId GetTypeId (); |
Alexander Afanasyev | 08d984e | 2011-08-13 19:20:22 -0700 | [diff] [blame] | 77 | |
Alexander Afanasyev | 7112f48 | 2011-08-17 14:05:57 -0700 | [diff] [blame] | 78 | static const uint16_t ETHERNET_FRAME_TYPE; ///< \brief Ethernet Frame Type of CCNx |
Alexander Afanasyev | 0782718 | 2011-12-13 01:07:32 -0800 | [diff] [blame] | 79 | // static const uint16_t IP_PROTOCOL_TYPE; ///< \brief IP protocol type of CCNx |
| 80 | // static const uint16_t UDP_PORT; ///< \brief UDP port of CCNx |
Alexander Afanasyev | 7112f48 | 2011-08-17 14:05:57 -0700 | [diff] [blame] | 81 | |
| 82 | /** |
| 83 | * \brief Default constructor. Creates an empty stack without forwarding strategy set |
| 84 | */ |
Alexander Afanasyev | 08d984e | 2011-08-13 19:20:22 -0700 | [diff] [blame] | 85 | CcnxL3Protocol(); |
| 86 | virtual ~CcnxL3Protocol (); |
| 87 | |
| 88 | /** |
Alexander Afanasyev | 7112f48 | 2011-08-17 14:05:57 -0700 | [diff] [blame] | 89 | * \brief Assigns node to the CCNx stack |
| 90 | * |
| 91 | * \param node Simulation node |
| 92 | */ |
Alexander Afanasyev | 08d984e | 2011-08-13 19:20:22 -0700 | [diff] [blame] | 93 | void SetNode (Ptr<Node> node); |
| 94 | |
Alexander Afanasyev | 7112f48 | 2011-08-17 14:05:57 -0700 | [diff] [blame] | 95 | //////////////////////////////////////////////////////////////////// |
Alexander Afanasyev | 08d984e | 2011-08-13 19:20:22 -0700 | [diff] [blame] | 96 | // functions defined in base class Ccnx |
Alexander Afanasyev | 9825610 | 2011-08-14 01:00:02 -0700 | [diff] [blame] | 97 | |
Alexander Afanasyev | c74a602 | 2011-08-15 20:01:35 -0700 | [diff] [blame] | 98 | void SetForwardingStrategy (Ptr<CcnxForwardingStrategy> forwardingStrategy); |
Alexander Afanasyev | 56f79ea | 2011-08-17 23:54:27 -0700 | [diff] [blame] | 99 | Ptr<CcnxForwardingStrategy> GetForwardingStrategy () const; |
Alexander Afanasyev | 08d984e | 2011-08-13 19:20:22 -0700 | [diff] [blame] | 100 | |
Alexander Afanasyev | 09c7deb | 2011-11-23 14:50:10 -0800 | [diff] [blame] | 101 | // virtual void SendInterest (const Ptr<CcnxFace> &face, |
| 102 | // const Ptr<const CcnxInterestHeader> &header, |
| 103 | // const Ptr<Packet> &packet); |
| 104 | // virtual void SendContentObject (const Ptr<CcnxFace> &face, |
| 105 | // const Ptr<const CcnxContentObjectHeader> &header, |
| 106 | // const Ptr<Packet> &packet); |
Alexander Afanasyev | 7112f48 | 2011-08-17 14:05:57 -0700 | [diff] [blame] | 107 | |
Alexander Afanasyev | c5a23e2 | 2011-09-07 00:37:36 -0700 | [diff] [blame] | 108 | virtual uint32_t |
| 109 | AddFace (const Ptr<CcnxFace> &face); |
| 110 | |
| 111 | virtual uint32_t |
| 112 | GetNFaces () const; |
| 113 | |
| 114 | virtual Ptr<CcnxFace> |
| 115 | GetFace (uint32_t face) const; |
Alexander Afanasyev | 7112f48 | 2011-08-17 14:05:57 -0700 | [diff] [blame] | 116 | |
Alexander Afanasyev | c5a23e2 | 2011-09-07 00:37:36 -0700 | [diff] [blame] | 117 | virtual void |
| 118 | RemoveFace (Ptr<CcnxFace> face); |
Alexander Afanasyev | 52e9aa9 | 2011-11-15 20:23:20 -0800 | [diff] [blame] | 119 | |
| 120 | virtual Ptr<CcnxFace> |
| 121 | GetFaceByNetDevice (Ptr<NetDevice> netDevice) const; |
Alexander Afanasyev | c5a23e2 | 2011-09-07 00:37:36 -0700 | [diff] [blame] | 122 | |
Ilya Moiseenko | 172763c | 2011-10-28 13:21:53 -0700 | [diff] [blame] | 123 | Ptr<CcnxPit> GetPit(); |
Ilya Moiseenko | d83eb0d | 2011-11-16 15:23:46 -0800 | [diff] [blame] | 124 | |
Alexander Afanasyev | a46844b | 2011-11-21 19:13:26 -0800 | [diff] [blame] | 125 | // void ScheduleLeakage(); |
Alexander Afanasyev | 09c7deb | 2011-11-23 14:50:10 -0800 | [diff] [blame] | 126 | private: |
| 127 | void |
| 128 | Receive (const Ptr<CcnxFace> &face, const Ptr<const Packet> &p); |
| 129 | |
Alexander Afanasyev | 08d984e | 2011-08-13 19:20:22 -0700 | [diff] [blame] | 130 | /** |
Alexander Afanasyev | 78cf0c9 | 2011-09-01 19:57:14 -0700 | [diff] [blame] | 131 | * \brief Actual processing of incoming CCNx interests. Note, interests do not have payload |
Alexander Afanasyev | c74a602 | 2011-08-15 20:01:35 -0700 | [diff] [blame] | 132 | * |
| 133 | * Processing Interest packets |
Alexander Afanasyev | 78cf0c9 | 2011-09-01 19:57:14 -0700 | [diff] [blame] | 134 | * @param face incoming face |
| 135 | * @param header deserialized Interest header |
| 136 | * @param packet original packet |
Alexander Afanasyev | 9825610 | 2011-08-14 01:00:02 -0700 | [diff] [blame] | 137 | */ |
Alexander Afanasyev | 09c7deb | 2011-11-23 14:50:10 -0800 | [diff] [blame] | 138 | void |
Alexander Afanasyev | a67e28c | 2011-08-31 21:16:25 -0700 | [diff] [blame] | 139 | OnInterest (const Ptr<CcnxFace> &face, |
| 140 | Ptr<CcnxInterestHeader> &header, |
Alexander Afanasyev | 78cf0c9 | 2011-09-01 19:57:14 -0700 | [diff] [blame] | 141 | const Ptr<const Packet> &p); |
Alexander Afanasyev | c74a602 | 2011-08-15 20:01:35 -0700 | [diff] [blame] | 142 | |
Alexander Afanasyev | a46844b | 2011-11-21 19:13:26 -0800 | [diff] [blame] | 143 | /** |
| 144 | * \brief Processing of incoming CCNx NACKs. Note, these packets, like interests, do not have payload |
| 145 | * |
| 146 | * Processing NACK packets |
| 147 | * @param face incoming face |
| 148 | * @param header deserialized Interest header |
| 149 | * @param packet original packet |
| 150 | */ |
Alexander Afanasyev | 09c7deb | 2011-11-23 14:50:10 -0800 | [diff] [blame] | 151 | void |
Alexander Afanasyev | a46844b | 2011-11-21 19:13:26 -0800 | [diff] [blame] | 152 | OnNack (const Ptr<CcnxFace> &face, |
| 153 | Ptr<CcnxInterestHeader> &header, |
| 154 | const Ptr<const Packet> &p); |
Alexander Afanasyev | c74a602 | 2011-08-15 20:01:35 -0700 | [diff] [blame] | 155 | |
| 156 | /** |
Alexander Afanasyev | 0ab833e | 2011-08-18 15:49:13 -0700 | [diff] [blame] | 157 | * \brief Actual processing of incoming CCNx content objects |
Alexander Afanasyev | c74a602 | 2011-08-15 20:01:35 -0700 | [diff] [blame] | 158 | * |
| 159 | * Processing ContentObject packets |
Alexander Afanasyev | 78cf0c9 | 2011-09-01 19:57:14 -0700 | [diff] [blame] | 160 | * @param face incoming face |
| 161 | * @param header deserialized ContentObject header |
| 162 | * @param payload data packet payload |
| 163 | * @param packet original packet |
Alexander Afanasyev | c74a602 | 2011-08-15 20:01:35 -0700 | [diff] [blame] | 164 | */ |
Alexander Afanasyev | 09c7deb | 2011-11-23 14:50:10 -0800 | [diff] [blame] | 165 | void |
Alexander Afanasyev | a67e28c | 2011-08-31 21:16:25 -0700 | [diff] [blame] | 166 | OnData (const Ptr<CcnxFace> &face, |
| 167 | Ptr<CcnxContentObjectHeader> &header, |
Alexander Afanasyev | 78cf0c9 | 2011-09-01 19:57:14 -0700 | [diff] [blame] | 168 | Ptr<Packet> &payload, |
| 169 | const Ptr<const Packet> &packet); |
Alexander Afanasyev | 08d984e | 2011-08-13 19:20:22 -0700 | [diff] [blame] | 170 | |
| 171 | protected: |
Alexander Afanasyev | 08d984e | 2011-08-13 19:20:22 -0700 | [diff] [blame] | 172 | virtual void DoDispose (void); |
Alexander Afanasyev | 7112f48 | 2011-08-17 14:05:57 -0700 | [diff] [blame] | 173 | |
Alexander Afanasyev | 08d984e | 2011-08-13 19:20:22 -0700 | [diff] [blame] | 174 | /** |
| 175 | * This function will notify other components connected to the node that a new stack member is now connected |
| 176 | * This will be used to notify Layer 3 protocol of layer 4 protocol stack to connect them together. |
| 177 | */ |
| 178 | virtual void NotifyNewAggregate (); |
Alexander Afanasyev | 9825610 | 2011-08-14 01:00:02 -0700 | [diff] [blame] | 179 | |
Alexander Afanasyev | 08d984e | 2011-08-13 19:20:22 -0700 | [diff] [blame] | 180 | private: |
Alexander Afanasyev | 7112f48 | 2011-08-17 14:05:57 -0700 | [diff] [blame] | 181 | CcnxL3Protocol(const CcnxL3Protocol &); ///< copy constructor is disabled |
| 182 | CcnxL3Protocol &operator = (const CcnxL3Protocol &); ///< copy operator is disabled |
Alexander Afanasyev | 08d984e | 2011-08-13 19:20:22 -0700 | [diff] [blame] | 183 | |
Alexander Afanasyev | 09c7deb | 2011-11-23 14:50:10 -0800 | [diff] [blame] | 184 | /// \brief Set buckets leak interval |
| 185 | void |
| 186 | SetBucketLeakInterval (Time interval); |
| 187 | |
| 188 | /// \brief Get buckets leak interval |
| 189 | Time |
| 190 | GetBucketLeakInterval () const; |
Alexander Afanasyev | cf133f0 | 2011-09-06 12:13:48 -0700 | [diff] [blame] | 191 | |
Alexander Afanasyev | 09c7deb | 2011-11-23 14:50:10 -0800 | [diff] [blame] | 192 | /// \brief Periodically generate pre-calculated number of tokens (leak buckets) |
Alexander Afanasyev | 9d313d4 | 2011-11-25 13:36:15 -0800 | [diff] [blame] | 193 | void |
| 194 | LeakBuckets (); |
| 195 | |
| 196 | void |
| 197 | GiveUpInterest (const CcnxPitEntry &pitEntry, |
| 198 | Ptr<CcnxInterestHeader> header); |
Alexander Afanasyev | 09c7deb | 2011-11-23 14:50:10 -0800 | [diff] [blame] | 199 | |
Alexander Afanasyev | 9825610 | 2011-08-14 01:00:02 -0700 | [diff] [blame] | 200 | private: |
Alexander Afanasyev | 0ab833e | 2011-08-18 15:49:13 -0700 | [diff] [blame] | 201 | 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] | 202 | typedef std::vector<Ptr<CcnxFace> > CcnxFaceList; |
Alexander Afanasyev | 0ab833e | 2011-08-18 15:49:13 -0700 | [diff] [blame] | 203 | 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] | 204 | |
Alexander Afanasyev | 0ab833e | 2011-08-18 15:49:13 -0700 | [diff] [blame] | 205 | Ptr<Node> m_node; ///< \brief node on which ccnx stack is installed |
| 206 | Ptr<CcnxForwardingStrategy> m_forwardingStrategy; ///< \brief smart pointer to the selected forwarding strategy |
Alexander Afanasyev | 08d984e | 2011-08-13 19:20:22 -0700 | [diff] [blame] | 207 | |
Alexander Afanasyev | a46844b | 2011-11-21 19:13:26 -0800 | [diff] [blame] | 208 | // Ptr<CcnxRit> m_rit; ///< \brief RIT (recently interest table) |
Alexander Afanasyev | cf133f0 | 2011-09-06 12:13:48 -0700 | [diff] [blame] | 209 | Ptr<CcnxPit> m_pit; ///< \brief PIT (pending interest table) |
Alexander Afanasyev | c5a23e2 | 2011-09-07 00:37:36 -0700 | [diff] [blame] | 210 | Ptr<CcnxFib> m_fib; ///< \brief FIB |
Alexander Afanasyev | cf133f0 | 2011-09-06 12:13:48 -0700 | [diff] [blame] | 211 | Ptr<CcnxContentStore> m_contentStore; ///< \brief Content store (for caching purposes only) |
Alexander Afanasyev | 08d984e | 2011-08-13 19:20:22 -0700 | [diff] [blame] | 212 | |
Alexander Afanasyev | 09c7deb | 2011-11-23 14:50:10 -0800 | [diff] [blame] | 213 | Time m_bucketLeakInterval; |
| 214 | EventId m_bucketLeakEvent; |
Alexander Afanasyev | 08d984e | 2011-08-13 19:20:22 -0700 | [diff] [blame] | 215 | }; |
| 216 | |
| 217 | } // Namespace ns3 |
| 218 | |
| 219 | #endif /* CCNX_L3_PROTOCOL_H */ |