blob: 6c58bc7a143520f56787b077e593364b1c6bade9 [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"
Ilya Moiseenko8196d2e2011-08-29 13:03:22 -070036
Alexander Afanasyev19426ef2011-11-23 20:55:28 -080037#include <boost/ref.hpp>
Alexander Afanasyev781ea812011-12-15 22:42:09 -080038#include <boost/lexical_cast.hpp>
39#include <boost/lambda/lambda.hpp>
40#include <boost/lambda/bind.hpp>
41
42namespace ll = boost::lambda;
Alexander Afanasyev19426ef2011-11-23 20:55:28 -080043
Ilya Moiseenko8196d2e2011-08-29 13:03:22 -070044NS_LOG_COMPONENT_DEFINE ("CcnxConsumer");
45
46namespace ns3
47{
48
49NS_OBJECT_ENSURE_REGISTERED (CcnxConsumer);
50
51TypeId
52CcnxConsumer::GetTypeId (void)
53{
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -080054 static TypeId tid = TypeId ("ns3::CcnxConsumer")
Alexander Afanasyevbdc0d982011-12-16 01:15:26 -080055 .SetParent<CcnxApp> ()
Alexander Afanasyev781ea812011-12-15 22:42:09 -080056 .AddAttribute ("StartSeq", "Initial sequence number",
Alexander Afanasyevb3e4b852011-12-23 15:58:20 -080057 IntegerValue (0),
Alexander Afanasyev781ea812011-12-15 22:42:09 -080058 MakeIntegerAccessor(&CcnxConsumer::m_seq),
59 MakeIntegerChecker<int32_t>())
Alexander Afanasyev011b8592011-12-21 14:45:27 -080060
Alexander Afanasyev4975f732011-12-20 17:52:19 -080061 .AddAttribute ("Prefix","CcnxName of the Interest",
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -080062 StringValue ("/"),
63 MakeCcnxNameComponentsAccessor (&CcnxConsumer::m_interestName),
64 MakeCcnxNameComponentsChecker ())
Ilya Moiseenko956d0542012-01-02 15:26:40 -080065 .AddAttribute ("LifeTime", "LifeTime for interest packet",
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -080066 StringValue ("2s"),
67 MakeTimeAccessor (&CcnxConsumer::m_interestLifeTime),
68 MakeTimeChecker ())
69 .AddAttribute ("MinSuffixComponents", "MinSuffixComponents",
70 IntegerValue(-1),
71 MakeIntegerAccessor(&CcnxConsumer::m_minSuffixComponents),
72 MakeIntegerChecker<int32_t>())
73 .AddAttribute ("MaxSuffixComponents", "MaxSuffixComponents",
74 IntegerValue(-1),
75 MakeIntegerAccessor(&CcnxConsumer::m_maxSuffixComponents),
76 MakeIntegerChecker<int32_t>())
77 .AddAttribute ("ChildSelector", "ChildSelector",
78 BooleanValue(false),
79 MakeBooleanAccessor(&CcnxConsumer::m_childSelector),
80 MakeBooleanChecker())
81 .AddAttribute ("Exclude", "only simple name matching is supported (use CcnxNameComponents)",
82 CcnxNameComponentsValue (),
83 MakeCcnxNameComponentsAccessor (&CcnxConsumer::m_exclude),
84 MakeCcnxNameComponentsChecker ())
Alexander Afanasyev781ea812011-12-15 22:42:09 -080085
Alexander Afanasyev781ea812011-12-15 22:42:09 -080086 .AddAttribute ("RetxTimer",
87 "Timeout defining how frequent retransmission timeouts should be checked",
Alexander Afanasyevb7ad2322012-01-17 22:54:49 -080088 StringValue ("1ms"),
Alexander Afanasyev781ea812011-12-15 22:42:09 -080089 MakeTimeAccessor (&CcnxConsumer::GetRetxTimer, &CcnxConsumer::SetRetxTimer),
90 MakeTimeChecker ())
91
Alexander Afanasyevbdc0d982011-12-16 01:15:26 -080092 .AddTraceSource ("TransmittedInterests", "TransmittedInterests",
93 MakeTraceSourceAccessor (&CcnxConsumer::m_transmittedInterests))
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -080094 ;
Ilya Moiseenko8196d2e2011-08-29 13:03:22 -070095
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -080096 return tid;
Ilya Moiseenko8196d2e2011-08-29 13:03:22 -070097}
98
99CcnxConsumer::CcnxConsumer ()
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -0800100 : m_rand (0, std::numeric_limits<uint32_t>::max ())
101 , m_seq (0)
Alexander Afanasyevb7ad2322012-01-17 22:54:49 -0800102 , m_seqMax (0) // don't request anything
Ilya Moiseenko8196d2e2011-08-29 13:03:22 -0700103{
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -0800104 NS_LOG_FUNCTION_NOARGS ();
Alexander Afanasyev359bfb72012-01-09 18:42:50 -0800105
Alexander Afanasyev94cebd02012-01-16 12:22:34 -0800106 m_rtt = CreateObject<RttMeanDeviation> ();
Ilya Moiseenko8196d2e2011-08-29 13:03:22 -0700107}
Alexander Afanasyev781ea812011-12-15 22:42:09 -0800108
109void
110CcnxConsumer::SetRetxTimer (Time retxTimer)
111{
112 m_retxTimer = retxTimer;
113 if (m_retxEvent.IsRunning ())
114 m_retxEvent.Cancel (); // cancel any scheduled cleanup events
115
116 // schedule even with new timeout
117 m_retxEvent = Simulator::Schedule (m_retxTimer,
118 &CcnxConsumer::CheckRetxTimeout, this);
119}
120
121Time
122CcnxConsumer::GetRetxTimer () const
123{
124 return m_retxTimer;
125}
126
127void
128CcnxConsumer::CheckRetxTimeout ()
129{
130 Time now = Simulator::Now ();
131
Alexander Afanasyevbdc0d982011-12-16 01:15:26 -0800132 boost::mutex::scoped_lock (m_seqTimeoutsGuard);
133
Alexander Afanasyev359bfb72012-01-09 18:42:50 -0800134 Time rto = m_rtt->RetransmitTimeout ();
135
Alexander Afanasyev781ea812011-12-15 22:42:09 -0800136 while (!m_seqTimeouts.empty ())
137 {
138 SeqTimeoutsContainer::index<i_timestamp>::type::iterator entry =
139 m_seqTimeouts.get<i_timestamp> ().begin ();
Alexander Afanasyev359bfb72012-01-09 18:42:50 -0800140 if (entry->time + rto <= now) // timeout expired?
Alexander Afanasyev781ea812011-12-15 22:42:09 -0800141 {
Alexander Afanasyev359bfb72012-01-09 18:42:50 -0800142 m_seqTimeouts.get<i_timestamp> ().erase (entry);
143 OnTimeout (entry->seq);
Alexander Afanasyev781ea812011-12-15 22:42:09 -0800144 }
145 else
146 break; // nothing else to do. All later packets need not be retransmitted
147 }
Alexander Afanasyev3183b5a2011-12-23 20:48:20 -0800148
Alexander Afanasyev781ea812011-12-15 22:42:09 -0800149 m_retxEvent = Simulator::Schedule (m_retxTimer,
150 &CcnxConsumer::CheckRetxTimeout, this);
151}
152
Ilya Moiseenko8196d2e2011-08-29 13:03:22 -0700153// Application Methods
154void
155CcnxConsumer::StartApplication () // Called at time specified by Start
156{
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -0800157 NS_LOG_FUNCTION_NOARGS ();
Alexander Afanasyevc5a23e22011-09-07 00:37:36 -0700158
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -0800159 // do base stuff
160 CcnxApp::StartApplication ();
Alexander Afanasyev011b8592011-12-21 14:45:27 -0800161
162 ScheduleNextPacket ();
Ilya Moiseenko8196d2e2011-08-29 13:03:22 -0700163}
164
165void
166CcnxConsumer::StopApplication () // Called at time specified by Stop
167{
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -0800168 NS_LOG_FUNCTION_NOARGS ();
Alexander Afanasyevc5a23e22011-09-07 00:37:36 -0700169
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -0800170 // cancel periodic packet generation
171 Simulator::Cancel (m_sendEvent);
Alexander Afanasyevc5a23e22011-09-07 00:37:36 -0700172
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -0800173 // cleanup base stuff
174 CcnxApp::StopApplication ();
Ilya Moiseenko8196d2e2011-08-29 13:03:22 -0700175}
176
Ilya Moiseenko8196d2e2011-08-29 13:03:22 -0700177void
178CcnxConsumer::SendPacket ()
179{
Alexander Afanasyev3183b5a2011-12-23 20:48:20 -0800180 if (!m_active) return;
181
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -0800182 NS_LOG_FUNCTION_NOARGS ();
Alexander Afanasyev781ea812011-12-15 22:42:09 -0800183
Alexander Afanasyevbdc0d982011-12-16 01:15:26 -0800184 boost::mutex::scoped_lock (m_seqTimeoutsGuard);
185
Alexander Afanasyev781ea812011-12-15 22:42:09 -0800186 uint32_t seq;
187
188 if (m_retxSeqs.size () != 0)
189 {
Alexander Afanasyev359bfb72012-01-09 18:42:50 -0800190 // for (RetxSeqsContainer::const_iterator i=m_retxSeqs.begin (); i!=m_retxSeqs.end (); i++)
191 // {
192 // std::cout << *i << " ";
193 // }
194 // std::cout << "\n";
195
Alexander Afanasyev781ea812011-12-15 22:42:09 -0800196 seq = *m_retxSeqs.begin ();
Alexander Afanasyev120bf312011-12-19 01:24:47 -0800197 NS_LOG_INFO ("Before: " << m_retxSeqs.size ());
Alexander Afanasyev781ea812011-12-15 22:42:09 -0800198 m_retxSeqs.erase (m_retxSeqs.begin ());
Alexander Afanasyev120bf312011-12-19 01:24:47 -0800199 NS_LOG_INFO ("After: " << m_retxSeqs.size ());
Alexander Afanasyev781ea812011-12-15 22:42:09 -0800200 }
201 else
Alexander Afanasyevb3e4b852011-12-23 15:58:20 -0800202 {
203 if (m_seqMax > 0)
204 {
205 if (m_seq >= m_seqMax)
206 {
Alexander Afanasyev3183b5a2011-12-23 20:48:20 -0800207 return; // we are totally done
Alexander Afanasyevb3e4b852011-12-23 15:58:20 -0800208 }
209 }
210
211 seq = m_seq++;
212 }
Alexander Afanasyev359bfb72012-01-09 18:42:50 -0800213
214 // std::cout << Simulator::Now ().ToDouble (Time::S) << "s -> " << seq << "\n";
Alexander Afanasyev781ea812011-12-15 22:42:09 -0800215
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -0800216 //
217 Ptr<CcnxNameComponents> nameWithSequence = Create<CcnxNameComponents> (m_interestName);
Alexander Afanasyev781ea812011-12-15 22:42:09 -0800218 (*nameWithSequence) (seq);
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -0800219 //
220
221 CcnxInterestHeader interestHeader;
222 interestHeader.SetNonce (m_rand.GetValue ());
223 interestHeader.SetName (nameWithSequence);
224 interestHeader.SetInterestLifetime (m_interestLifeTime);
225 interestHeader.SetChildSelector (m_childSelector);
Alexander Afanasyevc39f0b42011-11-28 12:51:12 -0800226 if (m_exclude.size ()>0)
227 {
Alexander Afanasyevbdc0d982011-12-16 01:15:26 -0800228 interestHeader.SetExclude (Create<CcnxNameComponents> (m_exclude));
Alexander Afanasyevc39f0b42011-11-28 12:51:12 -0800229 }
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -0800230 interestHeader.SetMaxSuffixComponents (m_maxSuffixComponents);
231 interestHeader.SetMinSuffixComponents (m_minSuffixComponents);
Ilya Moiseenko8196d2e2011-08-29 13:03:22 -0700232
Alexander Afanasyev781ea812011-12-15 22:42:09 -0800233 // NS_LOG_INFO ("Requesting Interest: \n" << interestHeader);
234 NS_LOG_INFO ("> Interest for " << seq);
Alexander Afanasyevc5a23e22011-09-07 00:37:36 -0700235
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -0800236 Ptr<Packet> packet = Create<Packet> ();
237 packet->AddHeader (interestHeader);
Alexander Afanasyevd02a5d62011-11-21 11:01:51 -0800238
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -0800239 m_protocolHandler (packet);
Alexander Afanasyev781ea812011-12-15 22:42:09 -0800240
Alexander Afanasyevbdc0d982011-12-16 01:15:26 -0800241 NS_LOG_DEBUG ("Trying to add " << seq << " with " << Simulator::Now () << ". already " << m_seqTimeouts.size () << " items");
242
Alexander Afanasyev359bfb72012-01-09 18:42:50 -0800243 m_seqTimeouts.insert (SeqTimeout (seq, Simulator::Now ()));
Alexander Afanasyevbdc0d982011-12-16 01:15:26 -0800244 m_transmittedInterests (&interestHeader, this, m_face);
Alexander Afanasyev011b8592011-12-21 14:45:27 -0800245
Alexander Afanasyev359bfb72012-01-09 18:42:50 -0800246 m_rtt->SentSeq (SequenceNumber32 (seq), 1);
Alexander Afanasyev011b8592011-12-21 14:45:27 -0800247 ScheduleNextPacket ();
Ilya Moiseenko8196d2e2011-08-29 13:03:22 -0700248}
Alexander Afanasyevc5a23e22011-09-07 00:37:36 -0700249
Alexander Afanasyev011b8592011-12-21 14:45:27 -0800250///////////////////////////////////////////////////
251// Process incoming packets //
252///////////////////////////////////////////////////
253
254
Ilya Moiseenko8196d2e2011-08-29 13:03:22 -0700255void
Alexander Afanasyevc5a23e22011-09-07 00:37:36 -0700256CcnxConsumer::OnContentObject (const Ptr<const CcnxContentObjectHeader> &contentObject,
257 const Ptr<const Packet> &payload)
Ilya Moiseenko8196d2e2011-08-29 13:03:22 -0700258{
Alexander Afanasyev3183b5a2011-12-23 20:48:20 -0800259 if (!m_active) return;
260
Alexander Afanasyevbdc0d982011-12-16 01:15:26 -0800261 CcnxApp::OnContentObject (contentObject, payload); // tracing inside
262
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -0800263 NS_LOG_FUNCTION (this << contentObject << payload);
264
Alexander Afanasyev781ea812011-12-15 22:42:09 -0800265 // NS_LOG_INFO ("Received content object: " << boost::cref(*contentObject));
266
267 uint32_t seq = boost::lexical_cast<uint32_t> (contentObject->GetName ().GetComponents ().back ());
268 NS_LOG_INFO ("< DATA for " << seq);
269
Alexander Afanasyevbdc0d982011-12-16 01:15:26 -0800270 boost::mutex::scoped_lock (m_seqTimeoutsGuard);
271
Alexander Afanasyev8dcfa5d2012-01-05 14:22:25 -0700272 // SeqTimeoutsContainer::iterator entry = m_seqTimeouts.find (seq);
Alexander Afanasyev781ea812011-12-15 22:42:09 -0800273
Alexander Afanasyev8f5a9bb2011-12-18 19:49:02 -0800274 // NS_ASSERT_MSG (entry != m_seqTimeouts.end (),
275 // "Comment out this assert, if it causes problems");
Alexander Afanasyev781ea812011-12-15 22:42:09 -0800276
Alexander Afanasyev36d5c2a2012-01-02 19:09:19 -0800277 // if (entry != m_seqTimeouts.end ())
278 // m_seqTimeouts.erase (entry);
279
280 m_seqTimeouts.erase (seq);
281 m_retxSeqs.erase (seq);
Alexander Afanasyev359bfb72012-01-09 18:42:50 -0800282
283 m_rtt->AckSeq (SequenceNumber32 (seq));
Alexander Afanasyev781ea812011-12-15 22:42:09 -0800284}
285
286void
287CcnxConsumer::OnNack (const Ptr<const CcnxInterestHeader> &interest)
288{
Alexander Afanasyev3183b5a2011-12-23 20:48:20 -0800289 if (!m_active) return;
290
Alexander Afanasyevbdc0d982011-12-16 01:15:26 -0800291 CcnxApp::OnNack (interest); // tracing inside
292
Alexander Afanasyev120bf312011-12-19 01:24:47 -0800293 NS_LOG_DEBUG ("Nack type: " << interest->GetNack ());
294 boost::mutex::scoped_lock (m_seqTimeoutsGuard);
295
Alexander Afanasyev781ea812011-12-15 22:42:09 -0800296 NS_LOG_FUNCTION (this << interest);
297
298 // NS_LOG_INFO ("Received NACK: " << boost::cref(*interest));
299 uint32_t seq = boost::lexical_cast<uint32_t> (interest->GetName ().GetComponents ().back ());
300 NS_LOG_INFO ("< NACK for " << seq);
Alexander Afanasyev359bfb72012-01-09 18:42:50 -0800301 // std::cout << Simulator::Now ().ToDouble (Time::S) << "s -> " << "NACK for " << seq << "\n";
Alexander Afanasyev781ea812011-12-15 22:42:09 -0800302
303 // put in the queue of interests to be retransmitted
Alexander Afanasyev120bf312011-12-19 01:24:47 -0800304 NS_LOG_INFO ("Before: " << m_retxSeqs.size ());
Alexander Afanasyev781ea812011-12-15 22:42:09 -0800305 m_retxSeqs.insert (seq);
Alexander Afanasyev120bf312011-12-19 01:24:47 -0800306 NS_LOG_INFO ("After: " << m_retxSeqs.size ());
Alexander Afanasyev3183b5a2011-12-23 20:48:20 -0800307
308 ScheduleNextPacket ();
Ilya Moiseenko8196d2e2011-08-29 13:03:22 -0700309}
Alexander Afanasyevc5a23e22011-09-07 00:37:36 -0700310
Alexander Afanasyev359bfb72012-01-09 18:42:50 -0800311void
312CcnxConsumer::OnTimeout (uint32_t sequenceNumber)
313{
Alexander Afanasyevb7ad2322012-01-17 22:54:49 -0800314 std::cout << Simulator::Now () << ", TO: " << sequenceNumber << ", current RTO: " << m_rtt->RetransmitTimeout ().ToDouble (Time::S) << "s\n";
315
Alexander Afanasyev4d66de52012-01-13 00:06:01 -0800316 m_retxSeqs.insert (sequenceNumber);
Alexander Afanasyev359bfb72012-01-09 18:42:50 -0800317 ScheduleNextPacket ();
318}
319
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -0800320} // namespace ns3