Alexander Afanasyev | 2b4c947 | 2012-08-09 15:00:38 -0700 | [diff] [blame] | 1 | /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil -*- */ |
| 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> |
Alexander Afanasyev | 2b4c947 | 2012-08-09 15:00:38 -0700 | [diff] [blame] | 19 | */ |
Alexander Afanasyev | 31cb469 | 2012-08-17 13:08:20 -0700 | [diff] [blame] | 20 | |
Alexander Afanasyev | 2b4c947 | 2012-08-09 15:00:38 -0700 | [diff] [blame] | 21 | #ifndef NDN_FORWARDING_STRATEGY_H |
| 22 | #define NDN_FORWARDING_STRATEGY_H |
| 23 | |
| 24 | #include "ns3/packet.h" |
| 25 | #include "ns3/callback.h" |
| 26 | #include "ns3/object.h" |
| 27 | #include "ns3/traced-callback.h" |
| 28 | |
| 29 | namespace ns3 { |
| 30 | namespace ndn { |
| 31 | |
| 32 | class Face; |
| 33 | class InterestHeader; |
| 34 | class ContentObjectHeader; |
| 35 | class Pit; |
| 36 | namespace pit { class Entry; } |
| 37 | class FibFaceMetric; |
| 38 | class Fib; |
| 39 | class ContentStore; |
| 40 | |
| 41 | /** |
| 42 | * \ingroup ndn |
| 43 | * \brief Abstract base class for Ndn forwarding strategies |
| 44 | */ |
| 45 | class ForwardingStrategy : |
| 46 | public Object |
| 47 | { |
| 48 | public: |
| 49 | static TypeId GetTypeId (void); |
| 50 | |
| 51 | /** |
| 52 | * @brief Default constructor |
| 53 | */ |
| 54 | ForwardingStrategy (); |
| 55 | virtual ~ForwardingStrategy (); |
| 56 | |
| 57 | /** |
| 58 | * \brief Actual processing of incoming Ndn interests. Note, interests do not have payload |
| 59 | * |
| 60 | * Processing Interest packets |
| 61 | * @param face incoming face |
| 62 | * @param header deserialized Interest header |
Alexander Afanasyev | 31cb469 | 2012-08-17 13:08:20 -0700 | [diff] [blame] | 63 | * @param origPacket original packet |
Alexander Afanasyev | 2b4c947 | 2012-08-09 15:00:38 -0700 | [diff] [blame] | 64 | */ |
| 65 | virtual void |
Alexander Afanasyev | 31cb469 | 2012-08-17 13:08:20 -0700 | [diff] [blame] | 66 | OnInterest (Ptr<Face> face, |
| 67 | Ptr<const InterestHeader> header, |
| 68 | Ptr<const Packet> origPacket); |
Alexander Afanasyev | 2b4c947 | 2012-08-09 15:00:38 -0700 | [diff] [blame] | 69 | |
| 70 | /** |
| 71 | * \brief Actual processing of incoming Ndn content objects |
| 72 | * |
| 73 | * Processing ContentObject packets |
| 74 | * @param face incoming face |
| 75 | * @param header deserialized ContentObject header |
| 76 | * @param payload data packet payload |
Alexander Afanasyev | 31cb469 | 2012-08-17 13:08:20 -0700 | [diff] [blame] | 77 | * @param origPacket original packet |
Alexander Afanasyev | 2b4c947 | 2012-08-09 15:00:38 -0700 | [diff] [blame] | 78 | */ |
| 79 | virtual void |
Alexander Afanasyev | 31cb469 | 2012-08-17 13:08:20 -0700 | [diff] [blame] | 80 | OnData (Ptr<Face> face, |
| 81 | Ptr<const ContentObjectHeader> header, |
| 82 | Ptr<Packet> payload, |
| 83 | Ptr<const Packet> origPacket); |
Alexander Afanasyev | 2b4c947 | 2012-08-09 15:00:38 -0700 | [diff] [blame] | 84 | |
Alexander Afanasyev | ea9b3e6 | 2012-08-13 19:02:54 -0700 | [diff] [blame] | 85 | /** |
| 86 | * @brief Event fired just before PIT entry is removed by timeout |
| 87 | * @param pitEntry PIT entry to be removed |
| 88 | */ |
Alexander Afanasyev | 2b4c947 | 2012-08-09 15:00:38 -0700 | [diff] [blame] | 89 | virtual void |
Alexander Afanasyev | ea9b3e6 | 2012-08-13 19:02:54 -0700 | [diff] [blame] | 90 | WillEraseTimedOutPendingInterest (Ptr<pit::Entry> pitEntry); |
Alexander Afanasyev | 2b4c947 | 2012-08-09 15:00:38 -0700 | [diff] [blame] | 91 | |
Alexander Afanasyev | ea9b3e6 | 2012-08-13 19:02:54 -0700 | [diff] [blame] | 92 | /** |
| 93 | * @brief Event fired every time face is removed from NDN stack |
| 94 | * @param face face to be removed |
| 95 | * |
| 96 | * For example, when an application terminates, AppFace is removed and this method called by NDN stack. |
| 97 | */ |
Alexander Afanasyev | 2b4c947 | 2012-08-09 15:00:38 -0700 | [diff] [blame] | 98 | virtual void |
| 99 | RemoveFace (Ptr<Face> face); |
| 100 | |
| 101 | protected: |
Alexander Afanasyev | 6466fff | 2012-10-24 22:51:57 -0700 | [diff] [blame^] | 102 | /** |
| 103 | * @brief An event that is fired every time a new PIT entry is created |
| 104 | * |
| 105 | * Note that if NDN node is receiving a similar interest (interest for the same name), |
| 106 | * then either DidReceiveDuplicateInterest, DidSuppressSimilarInterest, or DidForwardSimilarInterest |
| 107 | * will be called |
| 108 | * |
| 109 | * Suppression of similar Interests is controlled using ShouldSuppressIncomingInterest virtual method |
| 110 | * |
| 111 | * @param inFace incoming face |
| 112 | * @param header deserialized Interest header |
| 113 | * @param origPacket original packet |
| 114 | * @param pitEntry created PIT entry (incoming and outgoing face sets are empty) |
| 115 | * |
| 116 | * @see DidReceiveDuplicateInterest, DidSuppressSimilarInterest, DidForwardSimilarInterest, ShouldSuppressIncomingInterest |
| 117 | */ |
| 118 | virtual void |
| 119 | DidCreatePitEntry (Ptr<Face> inFace, |
| 120 | Ptr<const InterestHeader> header, |
| 121 | Ptr<const Packet> origPacket, |
| 122 | Ptr<pit::Entry> pitEntry); |
| 123 | |
| 124 | /** |
| 125 | * @brief An event that is fired every time a new PIT entry cannot be created (e.g., PIT container imposes a limit) |
| 126 | * |
| 127 | * Note that this call can be called only for non-similar Interest (i.e., there is an attempt to create a new PIT entry). |
| 128 | * For any non-similar Interests, either FailedToCreatePitEntry or DidCreatePitEntry is called. |
| 129 | * |
| 130 | * @param inFace incoming face |
| 131 | * @param header deserialized Interest header |
| 132 | * @param origPacket original packet |
| 133 | */ |
| 134 | virtual void |
| 135 | FailedToCreatePitEntry (Ptr<Face> inFace, |
| 136 | Ptr<const InterestHeader> header, |
| 137 | Ptr<const Packet> origPacket); |
| 138 | |
| 139 | /** |
| 140 | * @brief An event that is fired every time a duplicated Interest is received |
| 141 | * |
| 142 | * This even is the last action that is performed before the Interest processing is halted |
| 143 | * |
| 144 | * @param inFace incoming face |
| 145 | * @param header deserialized Interest header |
| 146 | * @param origPacket original packet |
| 147 | * @param pitEntry an existing PIT entry, corresponding to the duplicated Interest |
| 148 | * |
| 149 | * @see DidReceiveDuplicateInterest, DidSuppressSimilarInterest, DidForwardSimilarInterest, ShouldSuppressIncomingInterest |
| 150 | */ |
Alexander Afanasyev | 2b4c947 | 2012-08-09 15:00:38 -0700 | [diff] [blame] | 151 | virtual void |
Alexander Afanasyev | 31cb469 | 2012-08-17 13:08:20 -0700 | [diff] [blame] | 152 | DidReceiveDuplicateInterest (Ptr<Face> inFace, |
| 153 | Ptr<const InterestHeader> header, |
| 154 | Ptr<const Packet> origPacket, |
Alexander Afanasyev | 2b4c947 | 2012-08-09 15:00:38 -0700 | [diff] [blame] | 155 | Ptr<pit::Entry> pitEntry); |
| 156 | |
Alexander Afanasyev | 6466fff | 2012-10-24 22:51:57 -0700 | [diff] [blame^] | 157 | /** |
| 158 | * @brief An event that is fired every time when a similar Interest is received and suppressed (collapsed) |
| 159 | * |
| 160 | * This even is the last action that is performed before the Interest processing is halted |
| 161 | * |
| 162 | * @param inFace incoming face |
| 163 | * @param header deserialized Interest header |
| 164 | * @param origPacket original packet |
| 165 | * @param pitEntry an existing PIT entry, corresponding to the duplicated Interest |
| 166 | * |
| 167 | * @see DidReceiveDuplicateInterest, DidForwardSimilarInterest, ShouldSuppressIncomingInterest |
| 168 | */ |
| 169 | virtual void |
| 170 | DidSuppressSimilarInterest (Ptr<Face> inFace, |
| 171 | Ptr<const InterestHeader> header, |
| 172 | Ptr<const Packet> origPacket, |
| 173 | Ptr<pit::Entry> pitEntry); |
| 174 | |
| 175 | /** |
| 176 | * @brief An event that is fired every time when a similar Interest is received and further forwarded (not suppressed/collapsed) |
| 177 | * |
| 178 | * This even is fired just before handling the Interest to PropagateInterest method |
| 179 | * |
| 180 | * @param inFace incoming face |
| 181 | * @param header deserialized Interest header |
| 182 | * @param origPacket original packet |
| 183 | * @param pitEntry an existing PIT entry, corresponding to the duplicated Interest |
| 184 | * |
| 185 | * @see DidReceiveDuplicateInterest, DidSuppressSimilarInterest, ShouldSuppressIncomingInterest |
| 186 | */ |
| 187 | virtual void |
| 188 | DidForwardSimilarInterest (Ptr<Face> inFace, |
| 189 | Ptr<const InterestHeader> header, |
| 190 | Ptr<const Packet> origPacket, |
| 191 | Ptr<pit::Entry> pitEntry); |
| 192 | |
| 193 | /** |
| 194 | * @brief An even that is fired when Interest cannot be forwarded |
| 195 | * |
| 196 | * Note that the event will not fire if retransmission detection is enabled (by default) |
| 197 | * and retransmitted Interest cannot by forwarded. For more details, refer to the implementation. |
| 198 | * |
| 199 | * @param inFace incoming face |
| 200 | * @param header deserialized Interest header |
| 201 | * @param origPacket original packet |
| 202 | * @param pitEntry an existing PIT entry, corresponding to the duplicated Interest |
| 203 | * |
| 204 | * @see DetectRetransmittedInterest |
| 205 | */ |
Alexander Afanasyev | 2b4c947 | 2012-08-09 15:00:38 -0700 | [diff] [blame] | 206 | virtual void |
Alexander Afanasyev | 31cb469 | 2012-08-17 13:08:20 -0700 | [diff] [blame] | 207 | DidExhaustForwardingOptions (Ptr<Face> inFace, |
| 208 | Ptr<const InterestHeader> header, |
| 209 | Ptr<const Packet> origPacket, |
Alexander Afanasyev | 2b4c947 | 2012-08-09 15:00:38 -0700 | [diff] [blame] | 210 | Ptr<pit::Entry> pitEntry); |
| 211 | |
Alexander Afanasyev | 2b4c947 | 2012-08-09 15:00:38 -0700 | [diff] [blame] | 212 | virtual bool |
Alexander Afanasyev | 31cb469 | 2012-08-17 13:08:20 -0700 | [diff] [blame] | 213 | DetectRetransmittedInterest (Ptr<Face> inFace, |
| 214 | Ptr<const InterestHeader> header, |
| 215 | Ptr<const Packet> origPacket, |
Alexander Afanasyev | 2b4c947 | 2012-08-09 15:00:38 -0700 | [diff] [blame] | 216 | Ptr<pit::Entry> pitEntry); |
| 217 | |
Alexander Afanasyev | 2b4c947 | 2012-08-09 15:00:38 -0700 | [diff] [blame] | 218 | // When Interest is satisfied from the cache, incoming face is 0 |
| 219 | virtual void |
Alexander Afanasyev | 31cb469 | 2012-08-17 13:08:20 -0700 | [diff] [blame] | 220 | WillSatisfyPendingInterest (Ptr<Face> inFace, |
Alexander Afanasyev | 2b4c947 | 2012-08-09 15:00:38 -0700 | [diff] [blame] | 221 | Ptr<pit::Entry> pitEntry); |
| 222 | |
| 223 | // for data received both from network and cache |
| 224 | virtual void |
Alexander Afanasyev | 31cb469 | 2012-08-17 13:08:20 -0700 | [diff] [blame] | 225 | SatisfyPendingInterest (Ptr<Face> inFace, // 0 allowed (from cache) |
Alexander Afanasyev | 2b4c947 | 2012-08-09 15:00:38 -0700 | [diff] [blame] | 226 | Ptr<const ContentObjectHeader> header, |
| 227 | Ptr<const Packet> payload, |
Alexander Afanasyev | 31cb469 | 2012-08-17 13:08:20 -0700 | [diff] [blame] | 228 | Ptr<const Packet> origPacket, |
Alexander Afanasyev | 2b4c947 | 2012-08-09 15:00:38 -0700 | [diff] [blame] | 229 | Ptr<pit::Entry> pitEntry); |
| 230 | |
| 231 | virtual void |
Alexander Afanasyev | 31cb469 | 2012-08-17 13:08:20 -0700 | [diff] [blame] | 232 | DidSendOutData (Ptr<Face> inFace, |
Alexander Afanasyev | 2b4c947 | 2012-08-09 15:00:38 -0700 | [diff] [blame] | 233 | Ptr<const ContentObjectHeader> header, |
| 234 | Ptr<const Packet> payload, |
Alexander Afanasyev | 31cb469 | 2012-08-17 13:08:20 -0700 | [diff] [blame] | 235 | Ptr<const Packet> origPacket, |
| 236 | Ptr<pit::Entry> pitEntry); |
Alexander Afanasyev | 2b4c947 | 2012-08-09 15:00:38 -0700 | [diff] [blame] | 237 | |
| 238 | virtual void |
Alexander Afanasyev | 31cb469 | 2012-08-17 13:08:20 -0700 | [diff] [blame] | 239 | DidReceiveUnsolicitedData (Ptr<Face> inFace, |
Alexander Afanasyev | 2b4c947 | 2012-08-09 15:00:38 -0700 | [diff] [blame] | 240 | Ptr<const ContentObjectHeader> header, |
Alexander Afanasyev | 31cb469 | 2012-08-17 13:08:20 -0700 | [diff] [blame] | 241 | Ptr<const Packet> payload, |
| 242 | Ptr<const Packet> origPacket); |
Alexander Afanasyev | 2b4c947 | 2012-08-09 15:00:38 -0700 | [diff] [blame] | 243 | |
| 244 | virtual bool |
Alexander Afanasyev | 31cb469 | 2012-08-17 13:08:20 -0700 | [diff] [blame] | 245 | ShouldSuppressIncomingInterest (Ptr<Face> inFace, |
| 246 | Ptr<const InterestHeader> header, |
| 247 | Ptr<const Packet> origPacket, |
Alexander Afanasyev | 2b4c947 | 2012-08-09 15:00:38 -0700 | [diff] [blame] | 248 | Ptr<pit::Entry> pitEntry); |
| 249 | |
| 250 | /** |
| 251 | * @brief Event fired before actually sending out an interest |
| 252 | * |
| 253 | * If event returns false, then there is some kind of a problem (e.g., per-face limit reached) |
| 254 | */ |
| 255 | virtual bool |
Alexander Afanasyev | 5db9217 | 2012-08-21 16:52:07 -0700 | [diff] [blame] | 256 | TrySendOutInterest (Ptr<Face> inFace, |
| 257 | Ptr<Face> outFace, |
| 258 | Ptr<const InterestHeader> header, |
| 259 | Ptr<const Packet> origPacket, |
| 260 | Ptr<pit::Entry> pitEntry); |
Alexander Afanasyev | 2b4c947 | 2012-08-09 15:00:38 -0700 | [diff] [blame] | 261 | |
| 262 | /** |
| 263 | * @brief Event fired just after sending out an interest |
| 264 | */ |
| 265 | virtual void |
Alexander Afanasyev | 31cb469 | 2012-08-17 13:08:20 -0700 | [diff] [blame] | 266 | DidSendOutInterest (Ptr<Face> outFace, |
| 267 | Ptr<const InterestHeader> header, |
| 268 | Ptr<const Packet> origPacket, |
Alexander Afanasyev | 2b4c947 | 2012-08-09 15:00:38 -0700 | [diff] [blame] | 269 | Ptr<pit::Entry> pitEntry); |
| 270 | |
Alexander Afanasyev | 6466fff | 2012-10-24 22:51:57 -0700 | [diff] [blame^] | 271 | /** |
| 272 | * @brief Wrapper method, which performs general tasks and calls DoPropagateInterest method |
| 273 | * |
| 274 | * General tasks so far are adding face to the list of incoming face, updating |
| 275 | * PIT entry lifetime, calling DoPropagateInterest, and retransmissions (enabled by default). |
| 276 | * |
| 277 | * @param inFace incoming face |
| 278 | * @param header Interest header |
| 279 | * @param origPacket original Interest packet |
| 280 | * @param pitEntry reference to PIT entry (reference to corresponding FIB entry inside) |
| 281 | * |
| 282 | * @see DoPropagateInterest |
| 283 | */ |
Alexander Afanasyev | 2b4c947 | 2012-08-09 15:00:38 -0700 | [diff] [blame] | 284 | virtual void |
Alexander Afanasyev | 31cb469 | 2012-08-17 13:08:20 -0700 | [diff] [blame] | 285 | PropagateInterest (Ptr<Face> inFace, |
| 286 | Ptr<const InterestHeader> header, |
| 287 | Ptr<const Packet> origPacket, |
Alexander Afanasyev | 2b4c947 | 2012-08-09 15:00:38 -0700 | [diff] [blame] | 288 | Ptr<pit::Entry> pitEntry); |
| 289 | |
| 290 | /** |
Alexander Afanasyev | 6466fff | 2012-10-24 22:51:57 -0700 | [diff] [blame^] | 291 | * @brief Virtual method to perform Interest propagation according to the forwarding strategy logic |
Alexander Afanasyev | 2b4c947 | 2012-08-09 15:00:38 -0700 | [diff] [blame] | 292 | * |
Alexander Afanasyev | 6466fff | 2012-10-24 22:51:57 -0700 | [diff] [blame^] | 293 | * In most cases, this is the call that needs to be implemented/re-implemented in order |
| 294 | * to perform forwarding of Interests according to the desired logic. |
| 295 | * |
| 296 | * There is also PropagateInterest method (generally, do not require to be overriden) |
| 297 | * which performs general tasks (adding face to the list of incoming face, updating |
| 298 | * PIT entry lifetime, calling DoPropagateInterest, as well as perform retransmissions (enabled by default). |
| 299 | * |
| 300 | * @param inFace incoming face |
| 301 | * @param header Interest header |
| 302 | * @param origPacket original Interest packet |
| 303 | * @param pitEntry reference to PIT entry (reference to corresponding FIB entry inside) |
Alexander Afanasyev | 2b4c947 | 2012-08-09 15:00:38 -0700 | [diff] [blame] | 304 | * |
| 305 | * @return true if interest was successfully propagated, false if all options have failed |
Alexander Afanasyev | 6466fff | 2012-10-24 22:51:57 -0700 | [diff] [blame^] | 306 | * |
| 307 | * @see PropagateInterest |
Alexander Afanasyev | 2b4c947 | 2012-08-09 15:00:38 -0700 | [diff] [blame] | 308 | */ |
| 309 | virtual bool |
Alexander Afanasyev | 31cb469 | 2012-08-17 13:08:20 -0700 | [diff] [blame] | 310 | DoPropagateInterest (Ptr<Face> inFace, |
| 311 | Ptr<const InterestHeader> header, |
| 312 | Ptr<const Packet> origPacket, |
Alexander Afanasyev | 2b4c947 | 2012-08-09 15:00:38 -0700 | [diff] [blame] | 313 | Ptr<pit::Entry> pitEntry) = 0; |
| 314 | |
| 315 | protected: |
| 316 | // inherited from Object class |
| 317 | virtual void NotifyNewAggregate (); ///< @brief Even when object is aggregated to another Object |
| 318 | virtual void DoDispose (); ///< @brief Do cleanup |
| 319 | |
| 320 | protected: |
| 321 | Ptr<Pit> m_pit; ///< \brief Reference to PIT to which this forwarding strategy is associated |
| 322 | Ptr<Fib> m_fib; ///< \brief FIB |
| 323 | Ptr<ContentStore> m_contentStore; ///< \brief Content store (for caching purposes only) |
| 324 | |
| 325 | bool m_cacheUnsolicitedData; |
| 326 | bool m_detectRetransmissions; |
| 327 | |
| 328 | TracedCallback<Ptr<const InterestHeader>, |
| 329 | Ptr<const Face> > m_outInterests; ///< @brief Transmitted interests trace |
| 330 | |
| 331 | TracedCallback<Ptr<const InterestHeader>, |
| 332 | Ptr<const Face> > m_inInterests; ///< @brief trace of incoming Interests |
| 333 | |
| 334 | TracedCallback<Ptr<const InterestHeader>, |
| 335 | Ptr<const Face> > m_dropInterests; ///< @brief trace of dropped Interests |
| 336 | |
| 337 | //////////////////////////////////////////////////////////////////// |
| 338 | //////////////////////////////////////////////////////////////////// |
| 339 | //////////////////////////////////////////////////////////////////// |
| 340 | |
| 341 | TracedCallback<Ptr<const ContentObjectHeader>, Ptr<const Packet>, |
| 342 | bool /*from cache*/, |
| 343 | Ptr<const Face> > m_outData; ///< @brief trace of outgoing Data |
| 344 | |
| 345 | TracedCallback<Ptr<const ContentObjectHeader>, Ptr<const Packet>, |
| 346 | Ptr<const Face> > m_inData; ///< @brief trace of incoming Data |
| 347 | |
| 348 | TracedCallback<Ptr<const ContentObjectHeader>, Ptr<const Packet>, |
| 349 | Ptr<const Face> > m_dropData; ///< @brief trace of dropped Data |
| 350 | }; |
| 351 | |
| 352 | } // namespace ndn |
| 353 | } // namespace ns3 |
| 354 | |
| 355 | #endif /* NDN_FORWARDING_STRATEGY_H */ |