blob: 0e773f9a52f15facb0bf9869f601aafaec5688e3 [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 Afanasyeve3d126f2012-07-16 17:07:31 -070074
75 ////////////////////////////////////////////////////////////////////
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 Afanasyeve3d126f2012-07-16 17:07:31 -0700164 if (isDuplicated)
165 {
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 Afanasyeve3d126f2012-07-16 17:07:31 -0700224
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 Afanasyev31cb4692012-08-17 13:08:20 -0700229 DidReceiveUnsolicitedData (inFace, header, payload, origPacket);
Alexander Afanasyev996b4872012-07-17 17:07:56 -0700230 return;
231 }
232 else
233 {
Alexander Afanasyev1a0fff62013-01-19 14:29:51 -0800234 FwHopCountTag hopCountTag;
235 if (payload->PeekPacketTag (hopCountTag))
236 {
237 Ptr<Packet> payloadCopy = payload->Copy ();
238 payloadCopy->RemovePacketTag (hopCountTag);
239
240 // Add or update entry in the content store
241 m_contentStore->Add (header, payloadCopy);
242 }
243 else
244 {
245 // Add or update entry in the content store
246 m_contentStore->Add (header, payload); // no need for extra copy
247 }
Alexander Afanasyeve3d126f2012-07-16 17:07:31 -0700248 }
Alexander Afanasyev996b4872012-07-17 17:07:56 -0700249
250 while (pitEntry != 0)
Alexander Afanasyeve3d126f2012-07-16 17:07:31 -0700251 {
Alexander Afanasyev996b4872012-07-17 17:07:56 -0700252 // Do data plane performance measurements
Alexander Afanasyev31cb4692012-08-17 13:08:20 -0700253 WillSatisfyPendingInterest (inFace, pitEntry);
Alexander Afanasyev996b4872012-07-17 17:07:56 -0700254
255 // Actually satisfy pending interest
Alexander Afanasyev31cb4692012-08-17 13:08:20 -0700256 SatisfyPendingInterest (inFace, header, payload, origPacket, pitEntry);
Alexander Afanasyev996b4872012-07-17 17:07:56 -0700257
258 // Lookup another PIT entry
259 pitEntry = m_pit->Lookup (*header);
Alexander Afanasyeve3d126f2012-07-16 17:07:31 -0700260 }
261}
262
Alexander Afanasyev6466fff2012-10-24 22:51:57 -0700263void
264ForwardingStrategy::DidCreatePitEntry (Ptr<Face> inFace,
265 Ptr<const InterestHeader> header,
266 Ptr<const Packet> origPacket,
267 Ptr<pit::Entry> pitEntrypitEntry)
268{
269}
270
271void
272ForwardingStrategy::FailedToCreatePitEntry (Ptr<Face> inFace,
273 Ptr<const InterestHeader> header,
274 Ptr<const Packet> origPacket)
275{
276 m_dropInterests (header, inFace);
277}
Alexander Afanasyeve3d126f2012-07-16 17:07:31 -0700278
Alexander Afanasyev996b4872012-07-17 17:07:56 -0700279void
Alexander Afanasyev31cb4692012-08-17 13:08:20 -0700280ForwardingStrategy::DidReceiveDuplicateInterest (Ptr<Face> inFace,
281 Ptr<const InterestHeader> header,
282 Ptr<const Packet> origPacket,
283 Ptr<pit::Entry> pitEntry)
Alexander Afanasyev996b4872012-07-17 17:07:56 -0700284{
Alexander Afanasyev996b4872012-07-17 17:07:56 -0700285 /////////////////////////////////////////////////////////////////////////////////////////
286 // //
287 // !!!! IMPORTANT CHANGE !!!! Duplicate interests will create incoming face entry !!!! //
288 // //
289 /////////////////////////////////////////////////////////////////////////////////////////
Alexander Afanasyev31cb4692012-08-17 13:08:20 -0700290 pitEntry->AddIncoming (inFace);
291 m_dropInterests (header, inFace);
Alexander Afanasyev996b4872012-07-17 17:07:56 -0700292}
293
294void
Alexander Afanasyev6466fff2012-10-24 22:51:57 -0700295ForwardingStrategy::DidSuppressSimilarInterest (Ptr<Face> face,
296 Ptr<const InterestHeader> header,
297 Ptr<const Packet> origPacket,
298 Ptr<pit::Entry> pitEntry)
299{
300}
301
302void
303ForwardingStrategy::DidForwardSimilarInterest (Ptr<Face> inFace,
304 Ptr<const InterestHeader> header,
305 Ptr<const Packet> origPacket,
306 Ptr<pit::Entry> pitEntry)
307{
308}
309
310void
Alexander Afanasyev31cb4692012-08-17 13:08:20 -0700311ForwardingStrategy::DidExhaustForwardingOptions (Ptr<Face> inFace,
312 Ptr<const InterestHeader> header,
313 Ptr<const Packet> origPacket,
Alexander Afanasyev6a3bb132012-08-15 09:47:35 -0700314 Ptr<pit::Entry> pitEntry)
Alexander Afanasyev996b4872012-07-17 17:07:56 -0700315{
Alexander Afanasyev31cb4692012-08-17 13:08:20 -0700316 NS_LOG_FUNCTION (this << boost::cref (*inFace));
Alexander Afanasyev6a3bb132012-08-15 09:47:35 -0700317 if (pitEntry->GetOutgoing ().size () == 0)
318 {
Alexander Afanasyev31cb4692012-08-17 13:08:20 -0700319 m_dropInterests (header, inFace);
Alexander Afanasyev6a3bb132012-08-15 09:47:35 -0700320
321 // All incoming interests cannot be satisfied. Remove them
322 pitEntry->ClearIncoming ();
323
324 // Remove also outgoing
325 pitEntry->ClearOutgoing ();
326
327 // Set pruning timout on PIT entry (instead of deleting the record)
328 m_pit->MarkErased (pitEntry);
329 }
Alexander Afanasyev996b4872012-07-17 17:07:56 -0700330}
Alexander Afanasyev996b4872012-07-17 17:07:56 -0700331
Alexander Afanasyev6466fff2012-10-24 22:51:57 -0700332
Alexander Afanasyev996b4872012-07-17 17:07:56 -0700333
Alexander Afanasyeve3d126f2012-07-16 17:07:31 -0700334bool
Alexander Afanasyev31cb4692012-08-17 13:08:20 -0700335ForwardingStrategy::DetectRetransmittedInterest (Ptr<Face> inFace,
336 Ptr<const InterestHeader> header,
337 Ptr<const Packet> packet,
338 Ptr<pit::Entry> pitEntry)
Alexander Afanasyeve3d126f2012-07-16 17:07:31 -0700339{
Alexander Afanasyev31cb4692012-08-17 13:08:20 -0700340 pit::Entry::in_iterator existingInFace = pitEntry->GetIncoming ().find (inFace);
Alexander Afanasyeve3d126f2012-07-16 17:07:31 -0700341
Alexander Afanasyev996b4872012-07-17 17:07:56 -0700342 bool isRetransmitted = false;
Alexander Afanasyeve3d126f2012-07-16 17:07:31 -0700343
Alexander Afanasyev31cb4692012-08-17 13:08:20 -0700344 if (existingInFace != pitEntry->GetIncoming ().end ())
Alexander Afanasyeve3d126f2012-07-16 17:07:31 -0700345 {
Alexander Afanasyev996b4872012-07-17 17:07:56 -0700346 // this is almost definitely a retransmission. But should we trust the user on that?
347 isRetransmitted = true;
Alexander Afanasyeve3d126f2012-07-16 17:07:31 -0700348 }
349
Alexander Afanasyev996b4872012-07-17 17:07:56 -0700350 return isRetransmitted;
Alexander Afanasyeve3d126f2012-07-16 17:07:31 -0700351}
352
353void
Alexander Afanasyev31cb4692012-08-17 13:08:20 -0700354ForwardingStrategy::SatisfyPendingInterest (Ptr<Face> inFace,
355 Ptr<const ContentObjectHeader> header,
356 Ptr<const Packet> payload,
357 Ptr<const Packet> origPacket,
358 Ptr<pit::Entry> pitEntry)
Alexander Afanasyeve3d126f2012-07-16 17:07:31 -0700359{
Alexander Afanasyev31cb4692012-08-17 13:08:20 -0700360 if (inFace != 0)
361 pitEntry->RemoveIncoming (inFace);
Alexander Afanasyev996b4872012-07-17 17:07:56 -0700362
363 //satisfy all pending incoming Interests
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -0700364 BOOST_FOREACH (const pit::IncomingFace &incoming, pitEntry->GetIncoming ())
Alexander Afanasyeve3d126f2012-07-16 17:07:31 -0700365 {
Alexander Afanasyev31cb4692012-08-17 13:08:20 -0700366 bool ok = incoming.m_face->Send (origPacket->Copy ());
Alexander Afanasyev1c0248b2012-07-24 15:59:50 -0700367 if (ok)
368 {
Alexander Afanasyev31cb4692012-08-17 13:08:20 -0700369 m_outData (header, payload, inFace == 0, incoming.m_face);
Alexander Afanasyev67f4a4a2012-11-24 17:18:17 -0800370 DidSendOutData (inFace, incoming.m_face, header, payload, origPacket, pitEntry);
Alexander Afanasyev1c0248b2012-07-24 15:59:50 -0700371
372 NS_LOG_DEBUG ("Satisfy " << *incoming.m_face);
373 }
374 else
375 {
376 m_dropData (header, payload, incoming.m_face);
377 NS_LOG_DEBUG ("Cannot satisfy data to " << *incoming.m_face);
378 }
Alexander Afanasyeve3d126f2012-07-16 17:07:31 -0700379
Alexander Afanasyev996b4872012-07-17 17:07:56 -0700380 // successfull forwarded data trace
381 }
Alexander Afanasyeve3d126f2012-07-16 17:07:31 -0700382
Alexander Afanasyev996b4872012-07-17 17:07:56 -0700383 // All incoming interests are satisfied. Remove them
384 pitEntry->ClearIncoming ();
Alexander Afanasyeve3d126f2012-07-16 17:07:31 -0700385
Alexander Afanasyev996b4872012-07-17 17:07:56 -0700386 // Remove all outgoing faces
387 pitEntry->ClearOutgoing ();
Alexander Afanasyeve3d126f2012-07-16 17:07:31 -0700388
Alexander Afanasyev996b4872012-07-17 17:07:56 -0700389 // Set pruning timout on PIT entry (instead of deleting the record)
390 m_pit->MarkErased (pitEntry);
391}
392
393void
Alexander Afanasyev31cb4692012-08-17 13:08:20 -0700394ForwardingStrategy::DidReceiveUnsolicitedData (Ptr<Face> inFace,
395 Ptr<const ContentObjectHeader> header,
396 Ptr<const Packet> payload,
397 Ptr<const Packet> origPacket)
Alexander Afanasyev996b4872012-07-17 17:07:56 -0700398{
399 if (m_cacheUnsolicitedData)
400 {
401 // Optimistically add or update entry in the content store
402 m_contentStore->Add (header, payload);
Alexander Afanasyeve3d126f2012-07-16 17:07:31 -0700403 }
404 else
405 {
Alexander Afanasyev996b4872012-07-17 17:07:56 -0700406 // Drop data packet if PIT entry is not found
407 // (unsolicited data packets should not "poison" content store)
408
409 //drop dulicated or not requested data packet
Alexander Afanasyev31cb4692012-08-17 13:08:20 -0700410 m_dropData (header, payload, inFace);
Alexander Afanasyeve3d126f2012-07-16 17:07:31 -0700411 }
412}
413
414void
Alexander Afanasyev31cb4692012-08-17 13:08:20 -0700415ForwardingStrategy::WillSatisfyPendingInterest (Ptr<Face> inFace,
416 Ptr<pit::Entry> pitEntry)
Alexander Afanasyeve3d126f2012-07-16 17:07:31 -0700417{
Alexander Afanasyev31cb4692012-08-17 13:08:20 -0700418 pit::Entry::out_iterator out = pitEntry->GetOutgoing ().find (inFace);
Alexander Afanasyev996b4872012-07-17 17:07:56 -0700419
420 // If we have sent interest for this data via this face, then update stats.
421 if (out != pitEntry->GetOutgoing ().end ())
Alexander Afanasyeve3d126f2012-07-16 17:07:31 -0700422 {
Alexander Afanasyev31cb4692012-08-17 13:08:20 -0700423 pitEntry->GetFibEntry ()->UpdateFaceRtt (inFace, Simulator::Now () - out->m_sendTime);
Alexander Afanasyev996b4872012-07-17 17:07:56 -0700424 }
Alexander Afanasyeve3d126f2012-07-16 17:07:31 -0700425}
426
Alexander Afanasyev996b4872012-07-17 17:07:56 -0700427bool
Alexander Afanasyev31cb4692012-08-17 13:08:20 -0700428ForwardingStrategy::ShouldSuppressIncomingInterest (Ptr<Face> inFace,
429 Ptr<const InterestHeader> header,
430 Ptr<const Packet> origPacket,
431 Ptr<pit::Entry> pitEntry)
Alexander Afanasyev996b4872012-07-17 17:07:56 -0700432{
433 bool isNew = pitEntry->GetIncoming ().size () == 0 && pitEntry->GetOutgoing ().size () == 0;
434
435 if (isNew) return false; // never suppress new interests
436
437 bool isRetransmitted = m_detectRetransmissions && // a small guard
Alexander Afanasyev31cb4692012-08-17 13:08:20 -0700438 DetectRetransmittedInterest (inFace, header, origPacket, pitEntry);
Alexander Afanasyev996b4872012-07-17 17:07:56 -0700439
Alexander Afanasyev31cb4692012-08-17 13:08:20 -0700440 if (pitEntry->GetOutgoing ().find (inFace) != pitEntry->GetOutgoing ().end ())
Alexander Afanasyev996b4872012-07-17 17:07:56 -0700441 {
442 NS_LOG_DEBUG ("Non duplicate interests from the face we have sent interest to. Don't suppress");
443 // got a non-duplicate interest from the face we have sent interest to
444 // Probably, there is no point in waiting data from that face... Not sure yet
445
446 // If we're expecting data from the interface we got the interest from ("producer" asks us for "his own" data)
447 // Mark interface YELLOW, but keep a small hope that data will come eventually.
448
449 // ?? not sure if we need to do that ?? ...
450
Alexander Afanasyev31cb4692012-08-17 13:08:20 -0700451 // pitEntry->GetFibEntry ()->UpdateStatus (inFace, fib::FaceMetric::NDN_FIB_YELLOW);
Alexander Afanasyev996b4872012-07-17 17:07:56 -0700452 }
453 else
454 if (!isNew && !isRetransmitted)
455 {
456 return true;
457 }
458
459 return false;
460}
461
462void
Alexander Afanasyev31cb4692012-08-17 13:08:20 -0700463ForwardingStrategy::PropagateInterest (Ptr<Face> inFace,
464 Ptr<const InterestHeader> header,
465 Ptr<const Packet> origPacket,
466 Ptr<pit::Entry> pitEntry)
Alexander Afanasyev996b4872012-07-17 17:07:56 -0700467{
468 bool isRetransmitted = m_detectRetransmissions && // a small guard
Alexander Afanasyev31cb4692012-08-17 13:08:20 -0700469 DetectRetransmittedInterest (inFace, header, origPacket, pitEntry);
Alexander Afanasyev996b4872012-07-17 17:07:56 -0700470
Alexander Afanasyev31cb4692012-08-17 13:08:20 -0700471 pitEntry->AddIncoming (inFace/*, header->GetInterestLifetime ()*/);
Alexander Afanasyev996b4872012-07-17 17:07:56 -0700472 /// @todo Make lifetime per incoming interface
473 pitEntry->UpdateLifetime (header->GetInterestLifetime ());
474
Alexander Afanasyev31cb4692012-08-17 13:08:20 -0700475 bool propagated = DoPropagateInterest (inFace, header, origPacket, pitEntry);
Alexander Afanasyev996b4872012-07-17 17:07:56 -0700476
477 if (!propagated && isRetransmitted) //give another chance if retransmitted
478 {
479 // increase max number of allowed retransmissions
480 pitEntry->IncreaseAllowedRetxCount ();
481
482 // try again
Alexander Afanasyev31cb4692012-08-17 13:08:20 -0700483 propagated = DoPropagateInterest (inFace, header, origPacket, pitEntry);
Alexander Afanasyev996b4872012-07-17 17:07:56 -0700484 }
485
486 // ForwardingStrategy will try its best to forward packet to at least one interface.
487 // If no interests was propagated, then there is not other option for forwarding or
488 // ForwardingStrategy failed to find it.
489 if (!propagated && pitEntry->GetOutgoing ().size () == 0)
490 {
Alexander Afanasyev31cb4692012-08-17 13:08:20 -0700491 DidExhaustForwardingOptions (inFace, header, origPacket, pitEntry);
Alexander Afanasyev996b4872012-07-17 17:07:56 -0700492 }
493}
Alexander Afanasyeve3d126f2012-07-16 17:07:31 -0700494
Alexander Afanasyevf249a192012-07-18 16:52:51 -0700495bool
Alexander Afanasyevdb15acb2012-11-09 14:16:27 -0800496ForwardingStrategy::CanSendOutInterest (Ptr<Face> inFace,
Alexander Afanasyev5db92172012-08-21 16:52:07 -0700497 Ptr<Face> outFace,
498 Ptr<const InterestHeader> header,
499 Ptr<const Packet> origPacket,
500 Ptr<pit::Entry> pitEntry)
Alexander Afanasyevf249a192012-07-18 16:52:51 -0700501{
Alexander Afanasyev5db92172012-08-21 16:52:07 -0700502 if (outFace == inFace)
503 {
504 NS_LOG_DEBUG ("Same as incoming");
505 return false; // same face as incoming, don't forward
506 }
507
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -0700508 pit::Entry::out_iterator outgoing =
Alexander Afanasyev31cb4692012-08-17 13:08:20 -0700509 pitEntry->GetOutgoing ().find (outFace);
Alexander Afanasyevf249a192012-07-18 16:52:51 -0700510
Alexander Afanasyev5db92172012-08-21 16:52:07 -0700511 if (outgoing != pitEntry->GetOutgoing ().end ())
512 {
513 if (!m_detectRetransmissions)
514 return false; // suppress
515 else if (outgoing->m_retxCount >= pitEntry->GetMaxRetxCount ())
516 {
517 NS_LOG_ERROR (outgoing->m_retxCount << " >= " << pitEntry->GetMaxRetxCount ());
518 return false; // already forwarded before during this retransmission cycle
519 }
520 }
Alexander Afanasyevdb15acb2012-11-09 14:16:27 -0800521
522 return true;
523}
524
525
526bool
527ForwardingStrategy::TrySendOutInterest (Ptr<Face> inFace,
528 Ptr<Face> outFace,
529 Ptr<const InterestHeader> header,
530 Ptr<const Packet> origPacket,
531 Ptr<pit::Entry> pitEntry)
532{
533 if (!CanSendOutInterest (inFace, outFace, header, origPacket, pitEntry))
534 {
535 return false;
536 }
Alexander Afanasyev5db92172012-08-21 16:52:07 -0700537
Alexander Afanasyev31cb4692012-08-17 13:08:20 -0700538 pitEntry->AddOutgoing (outFace);
Alexander Afanasyev5db92172012-08-21 16:52:07 -0700539
540 //transmission
541 Ptr<Packet> packetToSend = origPacket->Copy ();
542 outFace->Send (packetToSend);
543
Alexander Afanasyev67f4a4a2012-11-24 17:18:17 -0800544 DidSendOutInterest (inFace, outFace, header, origPacket, pitEntry);
Alexander Afanasyev5db92172012-08-21 16:52:07 -0700545
Alexander Afanasyevf249a192012-07-18 16:52:51 -0700546 return true;
547}
548
549void
Alexander Afanasyev67f4a4a2012-11-24 17:18:17 -0800550ForwardingStrategy::DidSendOutInterest (Ptr<Face> inFace,
551 Ptr<Face> outFace,
Alexander Afanasyev31cb4692012-08-17 13:08:20 -0700552 Ptr<const InterestHeader> header,
553 Ptr<const Packet> origPacket,
554 Ptr<pit::Entry> pitEntry)
Alexander Afanasyevf249a192012-07-18 16:52:51 -0700555{
Alexander Afanasyev31cb4692012-08-17 13:08:20 -0700556 m_outInterests (header, outFace);
Alexander Afanasyevf249a192012-07-18 16:52:51 -0700557}
558
559void
Alexander Afanasyev67f4a4a2012-11-24 17:18:17 -0800560ForwardingStrategy::DidSendOutData (Ptr<Face> inFace,
561 Ptr<Face> outFace,
Alexander Afanasyev31cb4692012-08-17 13:08:20 -0700562 Ptr<const ContentObjectHeader> header,
563 Ptr<const Packet> payload,
564 Ptr<const Packet> origPacket,
565 Ptr<pit::Entry> pitEntry)
Alexander Afanasyev1c0248b2012-07-24 15:59:50 -0700566{
567}
568
569void
Alexander Afanasyevea9b3e62012-08-13 19:02:54 -0700570ForwardingStrategy::WillEraseTimedOutPendingInterest (Ptr<pit::Entry> pitEntry)
Alexander Afanasyevf249a192012-07-18 16:52:51 -0700571{
572 // do nothing for now. may be need to do some logging
573}
574
Alexander Afanasyevf5c07742012-10-31 13:13:05 -0700575void
576ForwardingStrategy::AddFace (Ptr<Face> face)
577{
578 // do nothing here
579}
Alexander Afanasyev33364b62012-07-26 17:53:56 -0700580
581void
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -0700582ForwardingStrategy::RemoveFace (Ptr<Face> face)
Alexander Afanasyev33364b62012-07-26 17:53:56 -0700583{
584 // do nothing here
585}
586
Alexander Afanasyevadcccf42012-11-26 23:55:34 -0800587void
588ForwardingStrategy::DidAddFibEntry (Ptr<fib::Entry> fibEntry)
589{
590 // do nothing here
591}
592
593void
594ForwardingStrategy::WillRemoveFibEntry (Ptr<fib::Entry> fibEntry)
595{
596 // do nothing here
597}
598
599
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -0700600} // namespace ndn
601} // namespace ns3