blob: e4ebcd345a8f37498e6b51f972a340ec827aa940 [file] [log] [blame]
Ilya Moiseenko8196d2e2011-08-29 13:03:22 -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: Ilya Moiseenko <iliamo@cs.ucla.edu>
19 */
20
21#include "ccnx-consumer.h"
Alexander Afanasyevc5a23e22011-09-07 00:37:36 -070022#include "ns3/ptr.h"
Alexander Afanasyev19426ef2011-11-23 20:55:28 -080023#include "ns3/log.h"
24#include "ns3/simulator.h"
25#include "ns3/packet.h"
Alexander Afanasyevc5a23e22011-09-07 00:37:36 -070026#include "ns3/callback.h"
Alexander Afanasyeva46844b2011-11-21 19:13:26 -080027#include "ns3/string.h"
Alexander Afanasyev19426ef2011-11-23 20:55:28 -080028#include "ns3/boolean.h"
29#include "ns3/uinteger.h"
Alexander Afanasyevb3e4b852011-12-23 15:58:20 -080030#include "ns3/double.h"
Alexander Afanasyev19426ef2011-11-23 20:55:28 -080031
32#include "ns3/ccnx.h"
Alexander Afanasyevf9f4eb02011-12-16 01:51:14 -080033#include "../model/ccnx-local-face.h"
Alexander Afanasyev19426ef2011-11-23 20:55:28 -080034#include "ns3/ccnx-interest-header.h"
Alexander Afanasyevc5a23e22011-09-07 00:37:36 -070035#include "ns3/ccnx-content-object-header.h"
Alexander Afanasyev6bff0df2012-01-19 17:51:52 -080036#include "ns3/ccnx-path-stretch-tag.h"
Ilya Moiseenko8196d2e2011-08-29 13:03:22 -070037
Alexander Afanasyev19426ef2011-11-23 20:55:28 -080038#include <boost/ref.hpp>
Alexander Afanasyev781ea812011-12-15 22:42:09 -080039#include <boost/lexical_cast.hpp>
40#include <boost/lambda/lambda.hpp>
41#include <boost/lambda/bind.hpp>
42
Alexander Afanasyev3661e232012-01-20 17:36:15 -080043#include "ns3/names.h"
44
Alexander Afanasyev781ea812011-12-15 22:42:09 -080045namespace ll = boost::lambda;
Alexander Afanasyev19426ef2011-11-23 20:55:28 -080046
Ilya Moiseenko8196d2e2011-08-29 13:03:22 -070047NS_LOG_COMPONENT_DEFINE ("CcnxConsumer");
48
49namespace ns3
50{
51
52NS_OBJECT_ENSURE_REGISTERED (CcnxConsumer);
53
54TypeId
55CcnxConsumer::GetTypeId (void)
56{
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -080057 static TypeId tid = TypeId ("ns3::CcnxConsumer")
Alexander Afanasyevbdc0d982011-12-16 01:15:26 -080058 .SetParent<CcnxApp> ()
Alexander Afanasyev781ea812011-12-15 22:42:09 -080059 .AddAttribute ("StartSeq", "Initial sequence number",
Alexander Afanasyevb3e4b852011-12-23 15:58:20 -080060 IntegerValue (0),
Alexander Afanasyev781ea812011-12-15 22:42:09 -080061 MakeIntegerAccessor(&CcnxConsumer::m_seq),
62 MakeIntegerChecker<int32_t>())
Alexander Afanasyev011b8592011-12-21 14:45:27 -080063
Alexander Afanasyev4975f732011-12-20 17:52:19 -080064 .AddAttribute ("Prefix","CcnxName of the Interest",
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -080065 StringValue ("/"),
66 MakeCcnxNameComponentsAccessor (&CcnxConsumer::m_interestName),
67 MakeCcnxNameComponentsChecker ())
Ilya Moiseenko956d0542012-01-02 15:26:40 -080068 .AddAttribute ("LifeTime", "LifeTime for interest packet",
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -080069 StringValue ("2s"),
70 MakeTimeAccessor (&CcnxConsumer::m_interestLifeTime),
71 MakeTimeChecker ())
72 .AddAttribute ("MinSuffixComponents", "MinSuffixComponents",
73 IntegerValue(-1),
74 MakeIntegerAccessor(&CcnxConsumer::m_minSuffixComponents),
75 MakeIntegerChecker<int32_t>())
76 .AddAttribute ("MaxSuffixComponents", "MaxSuffixComponents",
77 IntegerValue(-1),
78 MakeIntegerAccessor(&CcnxConsumer::m_maxSuffixComponents),
79 MakeIntegerChecker<int32_t>())
80 .AddAttribute ("ChildSelector", "ChildSelector",
81 BooleanValue(false),
82 MakeBooleanAccessor(&CcnxConsumer::m_childSelector),
83 MakeBooleanChecker())
84 .AddAttribute ("Exclude", "only simple name matching is supported (use CcnxNameComponents)",
85 CcnxNameComponentsValue (),
86 MakeCcnxNameComponentsAccessor (&CcnxConsumer::m_exclude),
87 MakeCcnxNameComponentsChecker ())
Alexander Afanasyev781ea812011-12-15 22:42:09 -080088
Alexander Afanasyev781ea812011-12-15 22:42:09 -080089 .AddAttribute ("RetxTimer",
90 "Timeout defining how frequent retransmission timeouts should be checked",
Alexander Afanasyevb7ad2322012-01-17 22:54:49 -080091 StringValue ("1ms"),
Alexander Afanasyev781ea812011-12-15 22:42:09 -080092 MakeTimeAccessor (&CcnxConsumer::GetRetxTimer, &CcnxConsumer::SetRetxTimer),
93 MakeTimeChecker ())
94
Alexander Afanasyevbdc0d982011-12-16 01:15:26 -080095 .AddTraceSource ("TransmittedInterests", "TransmittedInterests",
96 MakeTraceSourceAccessor (&CcnxConsumer::m_transmittedInterests))
Alexander Afanasyev6bff0df2012-01-19 17:51:52 -080097
98 .AddTraceSource ("PathWeightsTrace", "PathWeightsTrace",
99 MakeTraceSourceAccessor (&CcnxConsumer::m_pathWeightsTrace))
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -0800100 ;
Ilya Moiseenko8196d2e2011-08-29 13:03:22 -0700101
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -0800102 return tid;
Ilya Moiseenko8196d2e2011-08-29 13:03:22 -0700103}
104
105CcnxConsumer::CcnxConsumer ()
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -0800106 : m_rand (0, std::numeric_limits<uint32_t>::max ())
107 , m_seq (0)
Alexander Afanasyevb7ad2322012-01-17 22:54:49 -0800108 , m_seqMax (0) // don't request anything
Ilya Moiseenko8196d2e2011-08-29 13:03:22 -0700109{
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -0800110 NS_LOG_FUNCTION_NOARGS ();
Alexander Afanasyev359bfb72012-01-09 18:42:50 -0800111
Alexander Afanasyev94cebd02012-01-16 12:22:34 -0800112 m_rtt = CreateObject<RttMeanDeviation> ();
Ilya Moiseenko8196d2e2011-08-29 13:03:22 -0700113}
Alexander Afanasyev781ea812011-12-15 22:42:09 -0800114
115void
116CcnxConsumer::SetRetxTimer (Time retxTimer)
117{
118 m_retxTimer = retxTimer;
119 if (m_retxEvent.IsRunning ())
120 m_retxEvent.Cancel (); // cancel any scheduled cleanup events
121
122 // schedule even with new timeout
123 m_retxEvent = Simulator::Schedule (m_retxTimer,
124 &CcnxConsumer::CheckRetxTimeout, this);
125}
126
127Time
128CcnxConsumer::GetRetxTimer () const
129{
130 return m_retxTimer;
131}
132
133void
134CcnxConsumer::CheckRetxTimeout ()
135{
136 Time now = Simulator::Now ();
137
Alexander Afanasyev359bfb72012-01-09 18:42:50 -0800138 Time rto = m_rtt->RetransmitTimeout ();
139
Alexander Afanasyev781ea812011-12-15 22:42:09 -0800140 while (!m_seqTimeouts.empty ())
141 {
142 SeqTimeoutsContainer::index<i_timestamp>::type::iterator entry =
143 m_seqTimeouts.get<i_timestamp> ().begin ();
Alexander Afanasyev359bfb72012-01-09 18:42:50 -0800144 if (entry->time + rto <= now) // timeout expired?
Alexander Afanasyev781ea812011-12-15 22:42:09 -0800145 {
Alexander Afanasyeve0e5bd12012-01-21 14:30:52 -0800146 uint32_t seqNo = entry->seq;
Alexander Afanasyev359bfb72012-01-09 18:42:50 -0800147 m_seqTimeouts.get<i_timestamp> ().erase (entry);
Alexander Afanasyeve0e5bd12012-01-21 14:30:52 -0800148 OnTimeout (seqNo);
Alexander Afanasyev781ea812011-12-15 22:42:09 -0800149 }
150 else
151 break; // nothing else to do. All later packets need not be retransmitted
152 }
Alexander Afanasyev3183b5a2011-12-23 20:48:20 -0800153
Alexander Afanasyev781ea812011-12-15 22:42:09 -0800154 m_retxEvent = Simulator::Schedule (m_retxTimer,
155 &CcnxConsumer::CheckRetxTimeout, this);
156}
157
Ilya Moiseenko8196d2e2011-08-29 13:03:22 -0700158// Application Methods
159void
160CcnxConsumer::StartApplication () // Called at time specified by Start
161{
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -0800162 NS_LOG_FUNCTION_NOARGS ();
Alexander Afanasyevc5a23e22011-09-07 00:37:36 -0700163
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -0800164 // do base stuff
165 CcnxApp::StartApplication ();
Alexander Afanasyev011b8592011-12-21 14:45:27 -0800166
167 ScheduleNextPacket ();
Ilya Moiseenko8196d2e2011-08-29 13:03:22 -0700168}
169
170void
171CcnxConsumer::StopApplication () // Called at time specified by Stop
172{
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -0800173 NS_LOG_FUNCTION_NOARGS ();
Alexander Afanasyevc5a23e22011-09-07 00:37:36 -0700174
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -0800175 // cancel periodic packet generation
176 Simulator::Cancel (m_sendEvent);
Alexander Afanasyevc5a23e22011-09-07 00:37:36 -0700177
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -0800178 // cleanup base stuff
179 CcnxApp::StopApplication ();
Ilya Moiseenko8196d2e2011-08-29 13:03:22 -0700180}
181
Ilya Moiseenko8196d2e2011-08-29 13:03:22 -0700182void
183CcnxConsumer::SendPacket ()
184{
Alexander Afanasyev3183b5a2011-12-23 20:48:20 -0800185 if (!m_active) return;
186
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -0800187 NS_LOG_FUNCTION_NOARGS ();
Alexander Afanasyev781ea812011-12-15 22:42:09 -0800188
189 uint32_t seq;
190
191 if (m_retxSeqs.size () != 0)
192 {
Alexander Afanasyev359bfb72012-01-09 18:42:50 -0800193 // for (RetxSeqsContainer::const_iterator i=m_retxSeqs.begin (); i!=m_retxSeqs.end (); i++)
194 // {
195 // std::cout << *i << " ";
196 // }
197 // std::cout << "\n";
198
Alexander Afanasyev781ea812011-12-15 22:42:09 -0800199 seq = *m_retxSeqs.begin ();
Alexander Afanasyev120bf312011-12-19 01:24:47 -0800200 NS_LOG_INFO ("Before: " << m_retxSeqs.size ());
Alexander Afanasyev781ea812011-12-15 22:42:09 -0800201 m_retxSeqs.erase (m_retxSeqs.begin ());
Alexander Afanasyev120bf312011-12-19 01:24:47 -0800202 NS_LOG_INFO ("After: " << m_retxSeqs.size ());
Alexander Afanasyev781ea812011-12-15 22:42:09 -0800203 }
204 else
Alexander Afanasyevb3e4b852011-12-23 15:58:20 -0800205 {
206 if (m_seqMax > 0)
207 {
208 if (m_seq >= m_seqMax)
209 {
Alexander Afanasyev3183b5a2011-12-23 20:48:20 -0800210 return; // we are totally done
Alexander Afanasyevb3e4b852011-12-23 15:58:20 -0800211 }
212 }
213
214 seq = m_seq++;
215 }
Alexander Afanasyev359bfb72012-01-09 18:42:50 -0800216
217 // std::cout << Simulator::Now ().ToDouble (Time::S) << "s -> " << seq << "\n";
Alexander Afanasyev781ea812011-12-15 22:42:09 -0800218
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -0800219 //
220 Ptr<CcnxNameComponents> nameWithSequence = Create<CcnxNameComponents> (m_interestName);
Alexander Afanasyev781ea812011-12-15 22:42:09 -0800221 (*nameWithSequence) (seq);
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -0800222 //
223
224 CcnxInterestHeader interestHeader;
225 interestHeader.SetNonce (m_rand.GetValue ());
226 interestHeader.SetName (nameWithSequence);
227 interestHeader.SetInterestLifetime (m_interestLifeTime);
228 interestHeader.SetChildSelector (m_childSelector);
Alexander Afanasyevc39f0b42011-11-28 12:51:12 -0800229 if (m_exclude.size ()>0)
230 {
Alexander Afanasyevbdc0d982011-12-16 01:15:26 -0800231 interestHeader.SetExclude (Create<CcnxNameComponents> (m_exclude));
Alexander Afanasyevc39f0b42011-11-28 12:51:12 -0800232 }
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -0800233 interestHeader.SetMaxSuffixComponents (m_maxSuffixComponents);
234 interestHeader.SetMinSuffixComponents (m_minSuffixComponents);
Ilya Moiseenko8196d2e2011-08-29 13:03:22 -0700235
Alexander Afanasyev781ea812011-12-15 22:42:09 -0800236 // NS_LOG_INFO ("Requesting Interest: \n" << interestHeader);
237 NS_LOG_INFO ("> Interest for " << seq);
Alexander Afanasyevc5a23e22011-09-07 00:37:36 -0700238
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -0800239 Ptr<Packet> packet = Create<Packet> ();
240 packet->AddHeader (interestHeader);
Alexander Afanasyevd02a5d62011-11-21 11:01:51 -0800241
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -0800242 m_protocolHandler (packet);
Alexander Afanasyev781ea812011-12-15 22:42:09 -0800243
Alexander Afanasyevbdc0d982011-12-16 01:15:26 -0800244 NS_LOG_DEBUG ("Trying to add " << seq << " with " << Simulator::Now () << ". already " << m_seqTimeouts.size () << " items");
245
Alexander Afanasyev359bfb72012-01-09 18:42:50 -0800246 m_seqTimeouts.insert (SeqTimeout (seq, Simulator::Now ()));
Alexander Afanasyevbdc0d982011-12-16 01:15:26 -0800247 m_transmittedInterests (&interestHeader, this, m_face);
Alexander Afanasyev011b8592011-12-21 14:45:27 -0800248
Alexander Afanasyev359bfb72012-01-09 18:42:50 -0800249 m_rtt->SentSeq (SequenceNumber32 (seq), 1);
Alexander Afanasyev011b8592011-12-21 14:45:27 -0800250 ScheduleNextPacket ();
Ilya Moiseenko8196d2e2011-08-29 13:03:22 -0700251}
Alexander Afanasyevc5a23e22011-09-07 00:37:36 -0700252
Alexander Afanasyev011b8592011-12-21 14:45:27 -0800253///////////////////////////////////////////////////
254// Process incoming packets //
255///////////////////////////////////////////////////
256
257
Ilya Moiseenko8196d2e2011-08-29 13:03:22 -0700258void
Alexander Afanasyevc5a23e22011-09-07 00:37:36 -0700259CcnxConsumer::OnContentObject (const Ptr<const CcnxContentObjectHeader> &contentObject,
Alexander Afanasyeve9c9d722012-01-19 16:59:30 -0800260 Ptr<Packet> payload)
Ilya Moiseenko8196d2e2011-08-29 13:03:22 -0700261{
Alexander Afanasyev3183b5a2011-12-23 20:48:20 -0800262 if (!m_active) return;
263
Alexander Afanasyevbdc0d982011-12-16 01:15:26 -0800264 CcnxApp::OnContentObject (contentObject, payload); // tracing inside
265
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -0800266 NS_LOG_FUNCTION (this << contentObject << payload);
267
Alexander Afanasyev781ea812011-12-15 22:42:09 -0800268 // NS_LOG_INFO ("Received content object: " << boost::cref(*contentObject));
269
270 uint32_t seq = boost::lexical_cast<uint32_t> (contentObject->GetName ().GetComponents ().back ());
271 NS_LOG_INFO ("< DATA for " << seq);
272
Alexander Afanasyev8dcfa5d2012-01-05 14:22:25 -0700273 // SeqTimeoutsContainer::iterator entry = m_seqTimeouts.find (seq);
Alexander Afanasyev781ea812011-12-15 22:42:09 -0800274
Alexander Afanasyev8f5a9bb2011-12-18 19:49:02 -0800275 // NS_ASSERT_MSG (entry != m_seqTimeouts.end (),
276 // "Comment out this assert, if it causes problems");
Alexander Afanasyev781ea812011-12-15 22:42:09 -0800277
Alexander Afanasyev36d5c2a2012-01-02 19:09:19 -0800278 // if (entry != m_seqTimeouts.end ())
279 // m_seqTimeouts.erase (entry);
280
281 m_seqTimeouts.erase (seq);
282 m_retxSeqs.erase (seq);
Alexander Afanasyev359bfb72012-01-09 18:42:50 -0800283
284 m_rtt->AckSeq (SequenceNumber32 (seq));
Alexander Afanasyev6bff0df2012-01-19 17:51:52 -0800285
286 Ptr<const WeightsPathStretchTag> tag = payload->RemovePacketTag<WeightsPathStretchTag> ();
287 if (tag != 0)
288 {
289 // Notify trace about path weights vector (e.g., for path-stretch calculation)
Alexander Afanasyev3661e232012-01-20 17:36:15 -0800290 m_pathWeightsTrace (GetNode (), tag->GetSourceNode (), seq, tag->GetTotalWeight ());
291 // if (Names::FindName (GetNode ()) == "36")// || Names::FindName (GetNode ()) == "40"|| Names::FindName (GetNode ()) == "5")
292 // std::cout << Simulator::Now () << "\t" << boost::cref(*tag) << " = " << tag->GetTotalWeight () << "\n";
Alexander Afanasyev6bff0df2012-01-19 17:51:52 -0800293 }
Alexander Afanasyev781ea812011-12-15 22:42:09 -0800294}
295
296void
Alexander Afanasyeve9c9d722012-01-19 16:59:30 -0800297CcnxConsumer::OnNack (const Ptr<const CcnxInterestHeader> &interest, Ptr<Packet> origPacket)
Alexander Afanasyev781ea812011-12-15 22:42:09 -0800298{
Alexander Afanasyev3183b5a2011-12-23 20:48:20 -0800299 if (!m_active) return;
300
Alexander Afanasyeve9c9d722012-01-19 16:59:30 -0800301 CcnxApp::OnNack (interest, origPacket); // tracing inside
Alexander Afanasyevbdc0d982011-12-16 01:15:26 -0800302
Alexander Afanasyev120bf312011-12-19 01:24:47 -0800303 NS_LOG_DEBUG ("Nack type: " << interest->GetNack ());
Alexander Afanasyev120bf312011-12-19 01:24:47 -0800304
Alexander Afanasyev781ea812011-12-15 22:42:09 -0800305 NS_LOG_FUNCTION (this << interest);
306
307 // NS_LOG_INFO ("Received NACK: " << boost::cref(*interest));
308 uint32_t seq = boost::lexical_cast<uint32_t> (interest->GetName ().GetComponents ().back ());
309 NS_LOG_INFO ("< NACK for " << seq);
Alexander Afanasyev359bfb72012-01-09 18:42:50 -0800310 // std::cout << Simulator::Now ().ToDouble (Time::S) << "s -> " << "NACK for " << seq << "\n";
Alexander Afanasyev781ea812011-12-15 22:42:09 -0800311
312 // put in the queue of interests to be retransmitted
Alexander Afanasyev120bf312011-12-19 01:24:47 -0800313 NS_LOG_INFO ("Before: " << m_retxSeqs.size ());
Alexander Afanasyev781ea812011-12-15 22:42:09 -0800314 m_retxSeqs.insert (seq);
Alexander Afanasyev120bf312011-12-19 01:24:47 -0800315 NS_LOG_INFO ("After: " << m_retxSeqs.size ());
Alexander Afanasyev3183b5a2011-12-23 20:48:20 -0800316
Alexander Afanasyev1e9348f2012-01-22 17:15:54 -0800317 m_rtt->IncreaseMultiplier (); // Double the next RTO ??
Alexander Afanasyev3183b5a2011-12-23 20:48:20 -0800318 ScheduleNextPacket ();
Ilya Moiseenko8196d2e2011-08-29 13:03:22 -0700319}
Alexander Afanasyevc5a23e22011-09-07 00:37:36 -0700320
Alexander Afanasyev359bfb72012-01-09 18:42:50 -0800321void
322CcnxConsumer::OnTimeout (uint32_t sequenceNumber)
323{
Alexander Afanasyev8e0d2812012-01-19 22:38:14 -0800324 // std::cout << Simulator::Now () << ", TO: " << sequenceNumber << ", current RTO: " << m_rtt->RetransmitTimeout ().ToDouble (Time::S) << "s\n";
Alexander Afanasyevb7ad2322012-01-17 22:54:49 -0800325
Alexander Afanasyev1e9348f2012-01-22 17:15:54 -0800326 m_rtt->IncreaseMultiplier (); // Double the next RTO
Alexander Afanasyev8e0d2812012-01-19 22:38:14 -0800327 m_rtt->SentSeq (SequenceNumber32 (sequenceNumber), 1); // make sure to disable RTT calculation for this sample
Alexander Afanasyev4d66de52012-01-13 00:06:01 -0800328 m_retxSeqs.insert (sequenceNumber);
Alexander Afanasyev359bfb72012-01-09 18:42:50 -0800329 ScheduleNextPacket ();
330}
331
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -0800332} // namespace ns3