blob: 6dc5bb0bca8c8058de0e448796e4679d8173e4b7 [file] [log] [blame]
Alexander Afanasyeve3d126f2012-07-16 17:07:31 -07001/* -*- 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>
19 * Ilya Moiseenko <iliamo@cs.ucla.edu>
20 */
21
Alexander Afanasyev4aac5572012-08-09 10:49:55 -070022#include "ndn-forwarding-strategy.h"
Alexander Afanasyeve3d126f2012-07-16 17:07:31 -070023
Alexander Afanasyev4aac5572012-08-09 10:49:55 -070024#include "ns3/ndn-pit.h"
25#include "ns3/ndn-pit-entry.h"
Alexander Afanasyevbd9c18e2012-11-19 15:23:41 -080026#include "ns3/ndn-interest.h"
27#include "ns3/ndn-content-object.h"
Alexander Afanasyev4aac5572012-08-09 10:49:55 -070028#include "ns3/ndn-pit.h"
29#include "ns3/ndn-fib.h"
30#include "ns3/ndn-content-store.h"
31#include "ns3/ndn-face.h"
Alexander Afanasyeve3d126f2012-07-16 17:07:31 -070032
33#include "ns3/assert.h"
34#include "ns3/ptr.h"
35#include "ns3/log.h"
36#include "ns3/simulator.h"
37#include "ns3/boolean.h"
38#include "ns3/string.h"
39
Alexander Afanasyev1a0fff62013-01-19 14:29:51 -080040#include "ns3/ndnSIM/utils/ndn-fw-hop-count-tag.h"
41
Alexander Afanasyeve3d126f2012-07-16 17:07:31 -070042#include <boost/ref.hpp>
43#include <boost/foreach.hpp>
44#include <boost/lambda/lambda.hpp>
45#include <boost/lambda/bind.hpp>
46#include <boost/tuple/tuple.hpp>
47namespace ll = boost::lambda;
48
Alexander Afanasyeve3d126f2012-07-16 17:07:31 -070049namespace ns3 {
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -070050namespace ndn {
Alexander Afanasyeve3d126f2012-07-16 17:07:31 -070051
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -070052NS_OBJECT_ENSURE_REGISTERED (ForwardingStrategy);
Alexander Afanasyeve3d126f2012-07-16 17:07:31 -070053
Alexander Afanasyev042b4a72012-11-09 17:47:48 -080054NS_LOG_COMPONENT_DEFINE (ForwardingStrategy::GetLogName ().c_str ());
55
56std::string
57ForwardingStrategy::GetLogName ()
58{
59 return "ndn.fw";
60}
61
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -070062TypeId ForwardingStrategy::GetTypeId (void)
Alexander Afanasyeve3d126f2012-07-16 17:07:31 -070063{
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -070064 static TypeId tid = TypeId ("ns3::ndn::ForwardingStrategy")
Alexander Afanasyev4aac5572012-08-09 10:49:55 -070065 .SetGroupName ("Ndn")
Alexander Afanasyeve3d126f2012-07-16 17:07:31 -070066 .SetParent<Object> ()
67
68 ////////////////////////////////////////////////////////////////////
69 ////////////////////////////////////////////////////////////////////
70
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -070071 .AddTraceSource ("OutInterests", "OutInterests", MakeTraceSourceAccessor (&ForwardingStrategy::m_outInterests))
72 .AddTraceSource ("InInterests", "InInterests", MakeTraceSourceAccessor (&ForwardingStrategy::m_inInterests))
73 .AddTraceSource ("DropInterests", "DropInterests", MakeTraceSourceAccessor (&ForwardingStrategy::m_dropInterests))
Alexander Afanasyev3a3ce1a2013-01-31 11:26:11 -080074
Alexander Afanasyeve3d126f2012-07-16 17:07:31 -070075 ////////////////////////////////////////////////////////////////////
76 ////////////////////////////////////////////////////////////////////
77
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -070078 .AddTraceSource ("OutData", "OutData", MakeTraceSourceAccessor (&ForwardingStrategy::m_outData))
79 .AddTraceSource ("InData", "InData", MakeTraceSourceAccessor (&ForwardingStrategy::m_inData))
80 .AddTraceSource ("DropData", "DropData", MakeTraceSourceAccessor (&ForwardingStrategy::m_dropData))
Alexander Afanasyeve3d126f2012-07-16 17:07:31 -070081
Alexander Afanasyeve3d126f2012-07-16 17:07:31 -070082 .AddAttribute ("CacheUnsolicitedData", "Cache overheard data that have not been requested",
83 BooleanValue (false),
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -070084 MakeBooleanAccessor (&ForwardingStrategy::m_cacheUnsolicitedData),
Alexander Afanasyeve3d126f2012-07-16 17:07:31 -070085 MakeBooleanChecker ())
86
Alexander Afanasyev996b4872012-07-17 17:07:56 -070087 .AddAttribute ("DetectRetransmissions", "If non-duplicate interest is received on the same face more than once, "
88 "it is considered a retransmission",
89 BooleanValue (true),
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -070090 MakeBooleanAccessor (&ForwardingStrategy::m_detectRetransmissions),
Alexander Afanasyev996b4872012-07-17 17:07:56 -070091 MakeBooleanChecker ())
Alexander Afanasyeve3d126f2012-07-16 17:07:31 -070092 ;
93 return tid;
94}
95
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -070096ForwardingStrategy::ForwardingStrategy ()
Alexander Afanasyeve3d126f2012-07-16 17:07:31 -070097{
98}
99
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -0700100ForwardingStrategy::~ForwardingStrategy ()
Alexander Afanasyeve3d126f2012-07-16 17:07:31 -0700101{
102}
103
104void
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -0700105ForwardingStrategy::NotifyNewAggregate ()
Alexander Afanasyeve3d126f2012-07-16 17:07:31 -0700106{
107 if (m_pit == 0)
108 {
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -0700109 m_pit = GetObject<Pit> ();
Alexander Afanasyeve3d126f2012-07-16 17:07:31 -0700110 }
111 if (m_fib == 0)
112 {
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -0700113 m_fib = GetObject<Fib> ();
Alexander Afanasyeve3d126f2012-07-16 17:07:31 -0700114 }
115 if (m_contentStore == 0)
116 {
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -0700117 m_contentStore = GetObject<ContentStore> ();
Alexander Afanasyeve3d126f2012-07-16 17:07:31 -0700118 }
119
120 Object::NotifyNewAggregate ();
121}
122
123void
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -0700124ForwardingStrategy::DoDispose ()
Alexander Afanasyeve3d126f2012-07-16 17:07:31 -0700125{
126 m_pit = 0;
127 m_contentStore = 0;
128 m_fib = 0;
129
130 Object::DoDispose ();
131}
132
133void
Alexander Afanasyev31cb4692012-08-17 13:08:20 -0700134ForwardingStrategy::OnInterest (Ptr<Face> inFace,
135 Ptr<const InterestHeader> header,
136 Ptr<const Packet> origPacket)
Alexander Afanasyeve3d126f2012-07-16 17:07:31 -0700137{
Alexander Afanasyev31cb4692012-08-17 13:08:20 -0700138 m_inInterests (header, inFace);
Alexander Afanasyeve3d126f2012-07-16 17:07:31 -0700139
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -0700140 Ptr<pit::Entry> pitEntry = m_pit->Lookup (*header);
Alexander Afanasyev6466fff2012-10-24 22:51:57 -0700141 bool similarInterest = true;
Alexander Afanasyeve3d126f2012-07-16 17:07:31 -0700142 if (pitEntry == 0)
143 {
Alexander Afanasyev6466fff2012-10-24 22:51:57 -0700144 similarInterest = false;
Alexander Afanasyeve3d126f2012-07-16 17:07:31 -0700145 pitEntry = m_pit->Create (header);
Alexander Afanasyev996b4872012-07-17 17:07:56 -0700146 if (pitEntry != 0)
147 {
Alexander Afanasyev31cb4692012-08-17 13:08:20 -0700148 DidCreatePitEntry (inFace, header, origPacket, pitEntry);
Alexander Afanasyev996b4872012-07-17 17:07:56 -0700149 }
150 else
151 {
Alexander Afanasyev31cb4692012-08-17 13:08:20 -0700152 FailedToCreatePitEntry (inFace, header, origPacket);
Alexander Afanasyev996b4872012-07-17 17:07:56 -0700153 return;
154 }
Alexander Afanasyeve3d126f2012-07-16 17:07:31 -0700155 }
156
Alexander Afanasyeve3d126f2012-07-16 17:07:31 -0700157 bool isDuplicated = true;
158 if (!pitEntry->IsNonceSeen (header->GetNonce ()))
159 {
160 pitEntry->AddSeenNonce (header->GetNonce ());
161 isDuplicated = false;
162 }
163
Alexander Afanasyev3a3ce1a2013-01-31 11:26:11 -0800164 if (isDuplicated)
Alexander Afanasyeve3d126f2012-07-16 17:07:31 -0700165 {
Alexander Afanasyev31cb4692012-08-17 13:08:20 -0700166 DidReceiveDuplicateInterest (inFace, header, origPacket, pitEntry);
Alexander Afanasyeve3d126f2012-07-16 17:07:31 -0700167 return;
168 }
169
170 Ptr<Packet> contentObject;
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -0700171 Ptr<const ContentObjectHeader> contentObjectHeader; // used for tracing
Alexander Afanasyeve3d126f2012-07-16 17:07:31 -0700172 Ptr<const Packet> payload; // used for tracing
173 boost::tie (contentObject, contentObjectHeader, payload) = m_contentStore->Lookup (header);
174 if (contentObject != 0)
175 {
Alexander Afanasyev1a0fff62013-01-19 14:29:51 -0800176 NS_ASSERT (contentObjectHeader != 0);
177
178 FwHopCountTag hopCountTag;
179 if (origPacket->PeekPacketTag (hopCountTag))
180 {
181 contentObject->AddPacketTag (hopCountTag);
182 }
Alexander Afanasyeve3d126f2012-07-16 17:07:31 -0700183
Alexander Afanasyev31cb4692012-08-17 13:08:20 -0700184 pitEntry->AddIncoming (inFace/*, Seconds (1.0)*/);
Alexander Afanasyevf249a192012-07-18 16:52:51 -0700185
186 // Do data plane performance measurements
187 WillSatisfyPendingInterest (0, pitEntry);
188
189 // Actually satisfy pending interest
Alexander Afanasyev996b4872012-07-17 17:07:56 -0700190 SatisfyPendingInterest (0, contentObjectHeader, payload, contentObject, pitEntry);
Alexander Afanasyeve3d126f2012-07-16 17:07:31 -0700191 return;
192 }
193
Alexander Afanasyev6466fff2012-10-24 22:51:57 -0700194 if (similarInterest && ShouldSuppressIncomingInterest (inFace, header, origPacket, pitEntry))
Alexander Afanasyeve3d126f2012-07-16 17:07:31 -0700195 {
Alexander Afanasyev31cb4692012-08-17 13:08:20 -0700196 pitEntry->AddIncoming (inFace/*, header->GetInterestLifetime ()*/);
Alexander Afanasyev996b4872012-07-17 17:07:56 -0700197 // update PIT entry lifetime
198 pitEntry->UpdateLifetime (header->GetInterestLifetime ());
Alexander Afanasyeve3d126f2012-07-16 17:07:31 -0700199
Alexander Afanasyev996b4872012-07-17 17:07:56 -0700200 // Suppress this interest if we're still expecting data from some other face
201 NS_LOG_DEBUG ("Suppress interests");
Alexander Afanasyev31cb4692012-08-17 13:08:20 -0700202 m_dropInterests (header, inFace);
Alexander Afanasyev6466fff2012-10-24 22:51:57 -0700203
204 DidSuppressSimilarInterest (inFace, header, origPacket, pitEntry);
Alexander Afanasyev996b4872012-07-17 17:07:56 -0700205 return;
Alexander Afanasyeve3d126f2012-07-16 17:07:31 -0700206 }
Alexander Afanasyev996b4872012-07-17 17:07:56 -0700207
Alexander Afanasyev6466fff2012-10-24 22:51:57 -0700208 if (similarInterest)
209 {
210 DidForwardSimilarInterest (inFace, header, origPacket, pitEntry);
211 }
212
Alexander Afanasyev31cb4692012-08-17 13:08:20 -0700213 PropagateInterest (inFace, header, origPacket, pitEntry);
Alexander Afanasyeve3d126f2012-07-16 17:07:31 -0700214}
215
216void
Alexander Afanasyev31cb4692012-08-17 13:08:20 -0700217ForwardingStrategy::OnData (Ptr<Face> inFace,
218 Ptr<const ContentObjectHeader> header,
219 Ptr<Packet> payload,
220 Ptr<const Packet> origPacket)
Alexander Afanasyeve3d126f2012-07-16 17:07:31 -0700221{
Alexander Afanasyev31cb4692012-08-17 13:08:20 -0700222 NS_LOG_FUNCTION (inFace << header->GetName () << payload << origPacket);
223 m_inData (header, payload, inFace);
Alexander Afanasyev3a3ce1a2013-01-31 11:26:11 -0800224
Alexander Afanasyev996b4872012-07-17 17:07:56 -0700225 // Lookup PIT entry
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -0700226 Ptr<pit::Entry> pitEntry = m_pit->Lookup (*header);
Alexander Afanasyev996b4872012-07-17 17:07:56 -0700227 if (pitEntry == 0)
Alexander Afanasyeve3d126f2012-07-16 17:07:31 -0700228 {
Alexander Afanasyeve6c07b52013-02-12 11:05:14 -0800229 bool cached = false;
230
231 if (m_cacheUnsolicitedData)
232 {
233 FwHopCountTag hopCountTag;
234
235 Ptr<Packet> payloadCopy = payload->Copy ();
236 payloadCopy->RemovePacketTag (hopCountTag);
237
238 // Optimistically add or update entry in the content store
239 cached = m_contentStore->Add (header, payloadCopy);
240 }
241 else
242 {
243 // Drop data packet if PIT entry is not found
244 // (unsolicited data packets should not "poison" content store)
245
246 //drop dulicated or not requested data packet
247 m_dropData (header, payload, inFace);
248 }
249
250 DidReceiveUnsolicitedData (inFace, header, payload, origPacket, cached);
Alexander Afanasyev996b4872012-07-17 17:07:56 -0700251 return;
252 }
253 else
254 {
Alexander Afanasyeve6c07b52013-02-12 11:05:14 -0800255 bool cached = false;
256
Alexander Afanasyev1a0fff62013-01-19 14:29:51 -0800257 FwHopCountTag hopCountTag;
258 if (payload->PeekPacketTag (hopCountTag))
259 {
260 Ptr<Packet> payloadCopy = payload->Copy ();
261 payloadCopy->RemovePacketTag (hopCountTag);
Alexander Afanasyev3a3ce1a2013-01-31 11:26:11 -0800262
Alexander Afanasyev1a0fff62013-01-19 14:29:51 -0800263 // Add or update entry in the content store
Alexander Afanasyeve6c07b52013-02-12 11:05:14 -0800264 cached = m_contentStore->Add (header, payloadCopy);
Alexander Afanasyev1a0fff62013-01-19 14:29:51 -0800265 }
266 else
267 {
268 // Add or update entry in the content store
Alexander Afanasyeve6c07b52013-02-12 11:05:14 -0800269 cached = m_contentStore->Add (header, payload); // no need for extra copy
Alexander Afanasyev1a0fff62013-01-19 14:29:51 -0800270 }
Alexander Afanasyeve6c07b52013-02-12 11:05:14 -0800271
272 DidReceiveSolicitedData (inFace, header, payload, origPacket, cached);
Alexander Afanasyeve3d126f2012-07-16 17:07:31 -0700273 }
Alexander Afanasyev996b4872012-07-17 17:07:56 -0700274
275 while (pitEntry != 0)
Alexander Afanasyeve3d126f2012-07-16 17:07:31 -0700276 {
Alexander Afanasyev996b4872012-07-17 17:07:56 -0700277 // Do data plane performance measurements
Alexander Afanasyev31cb4692012-08-17 13:08:20 -0700278 WillSatisfyPendingInterest (inFace, pitEntry);
Alexander Afanasyev996b4872012-07-17 17:07:56 -0700279
280 // Actually satisfy pending interest
Alexander Afanasyev31cb4692012-08-17 13:08:20 -0700281 SatisfyPendingInterest (inFace, header, payload, origPacket, pitEntry);
Alexander Afanasyev996b4872012-07-17 17:07:56 -0700282
283 // Lookup another PIT entry
284 pitEntry = m_pit->Lookup (*header);
Alexander Afanasyeve3d126f2012-07-16 17:07:31 -0700285 }
286}
287
Alexander Afanasyev6466fff2012-10-24 22:51:57 -0700288void
289ForwardingStrategy::DidCreatePitEntry (Ptr<Face> inFace,
290 Ptr<const InterestHeader> header,
291 Ptr<const Packet> origPacket,
292 Ptr<pit::Entry> pitEntrypitEntry)
293{
294}
295
296void
297ForwardingStrategy::FailedToCreatePitEntry (Ptr<Face> inFace,
298 Ptr<const InterestHeader> header,
299 Ptr<const Packet> origPacket)
300{
301 m_dropInterests (header, inFace);
302}
Alexander Afanasyeve3d126f2012-07-16 17:07:31 -0700303
Alexander Afanasyev996b4872012-07-17 17:07:56 -0700304void
Alexander Afanasyev31cb4692012-08-17 13:08:20 -0700305ForwardingStrategy::DidReceiveDuplicateInterest (Ptr<Face> inFace,
306 Ptr<const InterestHeader> header,
307 Ptr<const Packet> origPacket,
308 Ptr<pit::Entry> pitEntry)
Alexander Afanasyev996b4872012-07-17 17:07:56 -0700309{
Alexander Afanasyev996b4872012-07-17 17:07:56 -0700310 /////////////////////////////////////////////////////////////////////////////////////////
311 // //
312 // !!!! IMPORTANT CHANGE !!!! Duplicate interests will create incoming face entry !!!! //
313 // //
314 /////////////////////////////////////////////////////////////////////////////////////////
Alexander Afanasyev31cb4692012-08-17 13:08:20 -0700315 pitEntry->AddIncoming (inFace);
316 m_dropInterests (header, inFace);
Alexander Afanasyev996b4872012-07-17 17:07:56 -0700317}
318
319void
Alexander Afanasyev6466fff2012-10-24 22:51:57 -0700320ForwardingStrategy::DidSuppressSimilarInterest (Ptr<Face> face,
321 Ptr<const InterestHeader> header,
322 Ptr<const Packet> origPacket,
323 Ptr<pit::Entry> pitEntry)
324{
325}
326
327void
328ForwardingStrategy::DidForwardSimilarInterest (Ptr<Face> inFace,
329 Ptr<const InterestHeader> header,
330 Ptr<const Packet> origPacket,
331 Ptr<pit::Entry> pitEntry)
332{
333}
334
335void
Alexander Afanasyev31cb4692012-08-17 13:08:20 -0700336ForwardingStrategy::DidExhaustForwardingOptions (Ptr<Face> inFace,
337 Ptr<const InterestHeader> header,
338 Ptr<const Packet> origPacket,
Alexander Afanasyev6a3bb132012-08-15 09:47:35 -0700339 Ptr<pit::Entry> pitEntry)
Alexander Afanasyev996b4872012-07-17 17:07:56 -0700340{
Alexander Afanasyev31cb4692012-08-17 13:08:20 -0700341 NS_LOG_FUNCTION (this << boost::cref (*inFace));
Alexander Afanasyev3a3ce1a2013-01-31 11:26:11 -0800342 if (pitEntry->AreAllOutgoingInVain ())
Alexander Afanasyev6a3bb132012-08-15 09:47:35 -0700343 {
Alexander Afanasyev31cb4692012-08-17 13:08:20 -0700344 m_dropInterests (header, inFace);
Alexander Afanasyev6a3bb132012-08-15 09:47:35 -0700345
346 // All incoming interests cannot be satisfied. Remove them
347 pitEntry->ClearIncoming ();
348
349 // Remove also outgoing
350 pitEntry->ClearOutgoing ();
Alexander Afanasyev3a3ce1a2013-01-31 11:26:11 -0800351
Alexander Afanasyev6a3bb132012-08-15 09:47:35 -0700352 // Set pruning timout on PIT entry (instead of deleting the record)
353 m_pit->MarkErased (pitEntry);
354 }
Alexander Afanasyev996b4872012-07-17 17:07:56 -0700355}
Alexander Afanasyev3a3ce1a2013-01-31 11:26:11 -0800356
Alexander Afanasyev6466fff2012-10-24 22:51:57 -0700357
Alexander Afanasyev996b4872012-07-17 17:07:56 -0700358
Alexander Afanasyeve3d126f2012-07-16 17:07:31 -0700359bool
Alexander Afanasyev31cb4692012-08-17 13:08:20 -0700360ForwardingStrategy::DetectRetransmittedInterest (Ptr<Face> inFace,
361 Ptr<const InterestHeader> header,
362 Ptr<const Packet> packet,
363 Ptr<pit::Entry> pitEntry)
Alexander Afanasyeve3d126f2012-07-16 17:07:31 -0700364{
Alexander Afanasyev31cb4692012-08-17 13:08:20 -0700365 pit::Entry::in_iterator existingInFace = pitEntry->GetIncoming ().find (inFace);
Alexander Afanasyeve3d126f2012-07-16 17:07:31 -0700366
Alexander Afanasyev996b4872012-07-17 17:07:56 -0700367 bool isRetransmitted = false;
Alexander Afanasyev3a3ce1a2013-01-31 11:26:11 -0800368
Alexander Afanasyev31cb4692012-08-17 13:08:20 -0700369 if (existingInFace != pitEntry->GetIncoming ().end ())
Alexander Afanasyeve3d126f2012-07-16 17:07:31 -0700370 {
Alexander Afanasyev996b4872012-07-17 17:07:56 -0700371 // this is almost definitely a retransmission. But should we trust the user on that?
372 isRetransmitted = true;
Alexander Afanasyeve3d126f2012-07-16 17:07:31 -0700373 }
374
Alexander Afanasyev996b4872012-07-17 17:07:56 -0700375 return isRetransmitted;
Alexander Afanasyeve3d126f2012-07-16 17:07:31 -0700376}
377
378void
Alexander Afanasyev31cb4692012-08-17 13:08:20 -0700379ForwardingStrategy::SatisfyPendingInterest (Ptr<Face> inFace,
380 Ptr<const ContentObjectHeader> header,
381 Ptr<const Packet> payload,
382 Ptr<const Packet> origPacket,
383 Ptr<pit::Entry> pitEntry)
Alexander Afanasyeve3d126f2012-07-16 17:07:31 -0700384{
Alexander Afanasyev31cb4692012-08-17 13:08:20 -0700385 if (inFace != 0)
386 pitEntry->RemoveIncoming (inFace);
Alexander Afanasyev996b4872012-07-17 17:07:56 -0700387
388 //satisfy all pending incoming Interests
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -0700389 BOOST_FOREACH (const pit::IncomingFace &incoming, pitEntry->GetIncoming ())
Alexander Afanasyeve3d126f2012-07-16 17:07:31 -0700390 {
Alexander Afanasyev31cb4692012-08-17 13:08:20 -0700391 bool ok = incoming.m_face->Send (origPacket->Copy ());
Alexander Afanasyev1c0248b2012-07-24 15:59:50 -0700392 if (ok)
393 {
Alexander Afanasyev31cb4692012-08-17 13:08:20 -0700394 m_outData (header, payload, inFace == 0, incoming.m_face);
Alexander Afanasyev67f4a4a2012-11-24 17:18:17 -0800395 DidSendOutData (inFace, incoming.m_face, header, payload, origPacket, pitEntry);
Alexander Afanasyev3a3ce1a2013-01-31 11:26:11 -0800396
Alexander Afanasyev1c0248b2012-07-24 15:59:50 -0700397 NS_LOG_DEBUG ("Satisfy " << *incoming.m_face);
398 }
399 else
400 {
401 m_dropData (header, payload, incoming.m_face);
402 NS_LOG_DEBUG ("Cannot satisfy data to " << *incoming.m_face);
403 }
Alexander Afanasyev3a3ce1a2013-01-31 11:26:11 -0800404
Alexander Afanasyev996b4872012-07-17 17:07:56 -0700405 // successfull forwarded data trace
406 }
Alexander Afanasyeve3d126f2012-07-16 17:07:31 -0700407
Alexander Afanasyev996b4872012-07-17 17:07:56 -0700408 // All incoming interests are satisfied. Remove them
409 pitEntry->ClearIncoming ();
Alexander Afanasyeve3d126f2012-07-16 17:07:31 -0700410
Alexander Afanasyev996b4872012-07-17 17:07:56 -0700411 // Remove all outgoing faces
412 pitEntry->ClearOutgoing ();
Alexander Afanasyev3a3ce1a2013-01-31 11:26:11 -0800413
Alexander Afanasyev996b4872012-07-17 17:07:56 -0700414 // Set pruning timout on PIT entry (instead of deleting the record)
415 m_pit->MarkErased (pitEntry);
416}
417
418void
Alexander Afanasyeve6c07b52013-02-12 11:05:14 -0800419ForwardingStrategy::DidReceiveSolicitedData (Ptr<Face> inFace,
420 Ptr<const ContentObjectHeader> header,
421 Ptr<const Packet> payload,
422 Ptr<const Packet> origPacket,
423 bool didCreateCacheEntry)
424{
425 // do nothing
426}
427
428void
Alexander Afanasyev31cb4692012-08-17 13:08:20 -0700429ForwardingStrategy::DidReceiveUnsolicitedData (Ptr<Face> inFace,
430 Ptr<const ContentObjectHeader> header,
431 Ptr<const Packet> payload,
Alexander Afanasyeve6c07b52013-02-12 11:05:14 -0800432 Ptr<const Packet> origPacket,
433 bool didCreateCacheEntry)
Alexander Afanasyev996b4872012-07-17 17:07:56 -0700434{
Alexander Afanasyeve6c07b52013-02-12 11:05:14 -0800435 // do nothing
Alexander Afanasyeve3d126f2012-07-16 17:07:31 -0700436}
437
438void
Alexander Afanasyev31cb4692012-08-17 13:08:20 -0700439ForwardingStrategy::WillSatisfyPendingInterest (Ptr<Face> inFace,
440 Ptr<pit::Entry> pitEntry)
Alexander Afanasyeve3d126f2012-07-16 17:07:31 -0700441{
Alexander Afanasyev31cb4692012-08-17 13:08:20 -0700442 pit::Entry::out_iterator out = pitEntry->GetOutgoing ().find (inFace);
Alexander Afanasyev3a3ce1a2013-01-31 11:26:11 -0800443
Alexander Afanasyev996b4872012-07-17 17:07:56 -0700444 // If we have sent interest for this data via this face, then update stats.
445 if (out != pitEntry->GetOutgoing ().end ())
Alexander Afanasyeve3d126f2012-07-16 17:07:31 -0700446 {
Alexander Afanasyev31cb4692012-08-17 13:08:20 -0700447 pitEntry->GetFibEntry ()->UpdateFaceRtt (inFace, Simulator::Now () - out->m_sendTime);
Alexander Afanasyev3a3ce1a2013-01-31 11:26:11 -0800448 }
Alexander Afanasyeve3d126f2012-07-16 17:07:31 -0700449}
450
Alexander Afanasyev996b4872012-07-17 17:07:56 -0700451bool
Alexander Afanasyev31cb4692012-08-17 13:08:20 -0700452ForwardingStrategy::ShouldSuppressIncomingInterest (Ptr<Face> inFace,
453 Ptr<const InterestHeader> header,
454 Ptr<const Packet> origPacket,
455 Ptr<pit::Entry> pitEntry)
Alexander Afanasyev996b4872012-07-17 17:07:56 -0700456{
457 bool isNew = pitEntry->GetIncoming ().size () == 0 && pitEntry->GetOutgoing ().size () == 0;
458
459 if (isNew) return false; // never suppress new interests
Alexander Afanasyev3a3ce1a2013-01-31 11:26:11 -0800460
Alexander Afanasyev996b4872012-07-17 17:07:56 -0700461 bool isRetransmitted = m_detectRetransmissions && // a small guard
Alexander Afanasyev3a3ce1a2013-01-31 11:26:11 -0800462 DetectRetransmittedInterest (inFace, header, origPacket, pitEntry);
Alexander Afanasyev996b4872012-07-17 17:07:56 -0700463
Alexander Afanasyev31cb4692012-08-17 13:08:20 -0700464 if (pitEntry->GetOutgoing ().find (inFace) != pitEntry->GetOutgoing ().end ())
Alexander Afanasyev996b4872012-07-17 17:07:56 -0700465 {
466 NS_LOG_DEBUG ("Non duplicate interests from the face we have sent interest to. Don't suppress");
467 // got a non-duplicate interest from the face we have sent interest to
468 // Probably, there is no point in waiting data from that face... Not sure yet
469
470 // If we're expecting data from the interface we got the interest from ("producer" asks us for "his own" data)
471 // Mark interface YELLOW, but keep a small hope that data will come eventually.
472
473 // ?? not sure if we need to do that ?? ...
Alexander Afanasyev3a3ce1a2013-01-31 11:26:11 -0800474
Alexander Afanasyev31cb4692012-08-17 13:08:20 -0700475 // pitEntry->GetFibEntry ()->UpdateStatus (inFace, fib::FaceMetric::NDN_FIB_YELLOW);
Alexander Afanasyev996b4872012-07-17 17:07:56 -0700476 }
477 else
478 if (!isNew && !isRetransmitted)
479 {
480 return true;
481 }
482
483 return false;
484}
485
486void
Alexander Afanasyev31cb4692012-08-17 13:08:20 -0700487ForwardingStrategy::PropagateInterest (Ptr<Face> inFace,
488 Ptr<const InterestHeader> header,
489 Ptr<const Packet> origPacket,
490 Ptr<pit::Entry> pitEntry)
Alexander Afanasyev996b4872012-07-17 17:07:56 -0700491{
492 bool isRetransmitted = m_detectRetransmissions && // a small guard
Alexander Afanasyev3a3ce1a2013-01-31 11:26:11 -0800493 DetectRetransmittedInterest (inFace, header, origPacket, pitEntry);
494
Alexander Afanasyev31cb4692012-08-17 13:08:20 -0700495 pitEntry->AddIncoming (inFace/*, header->GetInterestLifetime ()*/);
Alexander Afanasyev996b4872012-07-17 17:07:56 -0700496 /// @todo Make lifetime per incoming interface
497 pitEntry->UpdateLifetime (header->GetInterestLifetime ());
Alexander Afanasyev3a3ce1a2013-01-31 11:26:11 -0800498
Alexander Afanasyev31cb4692012-08-17 13:08:20 -0700499 bool propagated = DoPropagateInterest (inFace, header, origPacket, pitEntry);
Alexander Afanasyev996b4872012-07-17 17:07:56 -0700500
501 if (!propagated && isRetransmitted) //give another chance if retransmitted
502 {
503 // increase max number of allowed retransmissions
504 pitEntry->IncreaseAllowedRetxCount ();
505
506 // try again
Alexander Afanasyev31cb4692012-08-17 13:08:20 -0700507 propagated = DoPropagateInterest (inFace, header, origPacket, pitEntry);
Alexander Afanasyev996b4872012-07-17 17:07:56 -0700508 }
509
Alexander Afanasyev3a3ce1a2013-01-31 11:26:11 -0800510 // if (!propagated)
511 // {
512 // NS_LOG_DEBUG ("++++++++++++++++++++++++++++++++++++++++++++++++++++++");
513 // NS_LOG_DEBUG ("+++ Not propagated ["<< header->GetName () <<"], but number of outgoing faces: " << pitEntry->GetOutgoing ().size ());
514 // NS_LOG_DEBUG ("++++++++++++++++++++++++++++++++++++++++++++++++++++++");
515 // }
516
Alexander Afanasyev996b4872012-07-17 17:07:56 -0700517 // ForwardingStrategy will try its best to forward packet to at least one interface.
518 // If no interests was propagated, then there is not other option for forwarding or
Alexander Afanasyev3a3ce1a2013-01-31 11:26:11 -0800519 // ForwardingStrategy failed to find it.
520 if (!propagated && pitEntry->AreAllOutgoingInVain ())
Alexander Afanasyev996b4872012-07-17 17:07:56 -0700521 {
Alexander Afanasyev31cb4692012-08-17 13:08:20 -0700522 DidExhaustForwardingOptions (inFace, header, origPacket, pitEntry);
Alexander Afanasyev996b4872012-07-17 17:07:56 -0700523 }
524}
Alexander Afanasyeve3d126f2012-07-16 17:07:31 -0700525
Alexander Afanasyevf249a192012-07-18 16:52:51 -0700526bool
Alexander Afanasyevdb15acb2012-11-09 14:16:27 -0800527ForwardingStrategy::CanSendOutInterest (Ptr<Face> inFace,
Alexander Afanasyev5db92172012-08-21 16:52:07 -0700528 Ptr<Face> outFace,
529 Ptr<const InterestHeader> header,
530 Ptr<const Packet> origPacket,
531 Ptr<pit::Entry> pitEntry)
Alexander Afanasyevf249a192012-07-18 16:52:51 -0700532{
Alexander Afanasyev3a3ce1a2013-01-31 11:26:11 -0800533 if (outFace == inFace)
Alexander Afanasyev5db92172012-08-21 16:52:07 -0700534 {
Alexander Afanasyev3a3ce1a2013-01-31 11:26:11 -0800535 // NS_LOG_DEBUG ("Same as incoming");
Alexander Afanasyev5db92172012-08-21 16:52:07 -0700536 return false; // same face as incoming, don't forward
537 }
Alexander Afanasyev3a3ce1a2013-01-31 11:26:11 -0800538
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -0700539 pit::Entry::out_iterator outgoing =
Alexander Afanasyev31cb4692012-08-17 13:08:20 -0700540 pitEntry->GetOutgoing ().find (outFace);
Alexander Afanasyevf249a192012-07-18 16:52:51 -0700541
Alexander Afanasyev5db92172012-08-21 16:52:07 -0700542 if (outgoing != pitEntry->GetOutgoing ().end ())
543 {
544 if (!m_detectRetransmissions)
545 return false; // suppress
546 else if (outgoing->m_retxCount >= pitEntry->GetMaxRetxCount ())
547 {
Alexander Afanasyev3a3ce1a2013-01-31 11:26:11 -0800548 // NS_LOG_DEBUG ("Already forwarded before during this retransmission cycle (" <<outgoing->m_retxCount << " >= " << pitEntry->GetMaxRetxCount () << ")");
Alexander Afanasyev5db92172012-08-21 16:52:07 -0700549 return false; // already forwarded before during this retransmission cycle
550 }
551 }
Alexander Afanasyevdb15acb2012-11-09 14:16:27 -0800552
553 return true;
554}
555
556
557bool
558ForwardingStrategy::TrySendOutInterest (Ptr<Face> inFace,
559 Ptr<Face> outFace,
560 Ptr<const InterestHeader> header,
561 Ptr<const Packet> origPacket,
562 Ptr<pit::Entry> pitEntry)
563{
564 if (!CanSendOutInterest (inFace, outFace, header, origPacket, pitEntry))
565 {
566 return false;
567 }
Alexander Afanasyev3a3ce1a2013-01-31 11:26:11 -0800568
Alexander Afanasyev31cb4692012-08-17 13:08:20 -0700569 pitEntry->AddOutgoing (outFace);
Alexander Afanasyev5db92172012-08-21 16:52:07 -0700570
571 //transmission
572 Ptr<Packet> packetToSend = origPacket->Copy ();
573 outFace->Send (packetToSend);
574
Alexander Afanasyev67f4a4a2012-11-24 17:18:17 -0800575 DidSendOutInterest (inFace, outFace, header, origPacket, pitEntry);
Alexander Afanasyev5db92172012-08-21 16:52:07 -0700576
Alexander Afanasyevf249a192012-07-18 16:52:51 -0700577 return true;
578}
579
580void
Alexander Afanasyev67f4a4a2012-11-24 17:18:17 -0800581ForwardingStrategy::DidSendOutInterest (Ptr<Face> inFace,
582 Ptr<Face> outFace,
Alexander Afanasyev31cb4692012-08-17 13:08:20 -0700583 Ptr<const InterestHeader> header,
584 Ptr<const Packet> origPacket,
585 Ptr<pit::Entry> pitEntry)
Alexander Afanasyevf249a192012-07-18 16:52:51 -0700586{
Alexander Afanasyev31cb4692012-08-17 13:08:20 -0700587 m_outInterests (header, outFace);
Alexander Afanasyevf249a192012-07-18 16:52:51 -0700588}
589
590void
Alexander Afanasyev67f4a4a2012-11-24 17:18:17 -0800591ForwardingStrategy::DidSendOutData (Ptr<Face> inFace,
592 Ptr<Face> outFace,
Alexander Afanasyev31cb4692012-08-17 13:08:20 -0700593 Ptr<const ContentObjectHeader> header,
594 Ptr<const Packet> payload,
595 Ptr<const Packet> origPacket,
596 Ptr<pit::Entry> pitEntry)
Alexander Afanasyev1c0248b2012-07-24 15:59:50 -0700597{
598}
599
600void
Alexander Afanasyevea9b3e62012-08-13 19:02:54 -0700601ForwardingStrategy::WillEraseTimedOutPendingInterest (Ptr<pit::Entry> pitEntry)
Alexander Afanasyevf249a192012-07-18 16:52:51 -0700602{
603 // do nothing for now. may be need to do some logging
604}
605
Alexander Afanasyevf5c07742012-10-31 13:13:05 -0700606void
607ForwardingStrategy::AddFace (Ptr<Face> face)
608{
609 // do nothing here
610}
Alexander Afanasyev33364b62012-07-26 17:53:56 -0700611
612void
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -0700613ForwardingStrategy::RemoveFace (Ptr<Face> face)
Alexander Afanasyev33364b62012-07-26 17:53:56 -0700614{
615 // do nothing here
616}
617
Alexander Afanasyevadcccf42012-11-26 23:55:34 -0800618void
619ForwardingStrategy::DidAddFibEntry (Ptr<fib::Entry> fibEntry)
620{
621 // do nothing here
622}
623
624void
625ForwardingStrategy::WillRemoveFibEntry (Ptr<fib::Entry> fibEntry)
626{
627 // do nothing here
628}
629
630
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -0700631} // namespace ndn
632} // namespace ns3