| /* -*- Mode: C++; c-file-style: "gnu"; indent-tabs-mode:nil; -*- */ |
| /* |
| * Copyright (c) 2011 University of California, Los Angeles |
| * |
| * This program is free software; you can redistribute it and/or modify |
| * it under the terms of the GNU General Public License version 2 as |
| * published by the Free Software Foundation; |
| * |
| * This program is distributed in the hope that it will be useful, |
| * but WITHOUT ANY WARRANTY; without even the implied warranty of |
| * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| * GNU General Public License for more details. |
| * |
| * You should have received a copy of the GNU General Public License |
| * along with this program; if not, write to the Free Software |
| * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA |
| * |
| * Author: Ilya Moiseenko <iliamo@cs.ucla.edu> |
| */ |
| |
| #include "ccnx-consumer.h" |
| #include "ns3/ptr.h" |
| #include "ns3/log.h" |
| #include "ns3/simulator.h" |
| #include "ns3/packet.h" |
| #include "ns3/callback.h" |
| #include "ns3/string.h" |
| #include "ns3/boolean.h" |
| #include "ns3/uinteger.h" |
| #include "ns3/double.h" |
| |
| #include "ns3/ccnx.h" |
| #include "../model/ccnx-local-face.h" |
| #include "ns3/ccnx-interest-header.h" |
| #include "ns3/ccnx-content-object-header.h" |
| |
| #include <boost/ref.hpp> |
| #include <boost/lexical_cast.hpp> |
| #include <boost/lambda/lambda.hpp> |
| #include <boost/lambda/bind.hpp> |
| |
| namespace ll = boost::lambda; |
| |
| NS_LOG_COMPONENT_DEFINE ("CcnxConsumer"); |
| |
| namespace ns3 |
| { |
| |
| NS_OBJECT_ENSURE_REGISTERED (CcnxConsumer); |
| |
| TypeId |
| CcnxConsumer::GetTypeId (void) |
| { |
| static TypeId tid = TypeId ("ns3::CcnxConsumer") |
| .SetParent<CcnxApp> () |
| .AddConstructor<CcnxConsumer> () |
| .AddAttribute ("StartSeq", "Initial sequence number", |
| IntegerValue (0), |
| MakeIntegerAccessor(&CcnxConsumer::m_seq), |
| MakeIntegerChecker<int32_t>()) |
| |
| .AddAttribute ("Size", "Amount of data in megabytes to request (relies on PayloadSize parameter)", |
| DoubleValue (-1), // don't impose limit by default |
| MakeDoubleAccessor (&CcnxConsumer::GetMaxSize, &CcnxConsumer::SetMaxSize), |
| MakeDoubleChecker<double> ()) |
| |
| /////// |
| .AddAttribute ("PayloadSize", "Average size of content object size (to calculate interest generation rate)", |
| UintegerValue (1040), |
| MakeUintegerAccessor (&CcnxConsumer::GetPayloadSize, &CcnxConsumer::SetPayloadSize), |
| MakeUintegerChecker<uint32_t>()) |
| .AddAttribute ("MeanRate", "Mean data packet rate (relies on the PayloadSize parameter)", |
| StringValue ("100Kbps"), |
| MakeDataRateAccessor (&CcnxConsumer::GetDesiredRate, &CcnxConsumer::SetDesiredRate), |
| MakeDataRateChecker ()) |
| /////// |
| |
| .AddAttribute ("Prefix","CcnxName of the Interest", |
| StringValue ("/"), |
| MakeCcnxNameComponentsAccessor (&CcnxConsumer::m_interestName), |
| MakeCcnxNameComponentsChecker ()) |
| .AddAttribute ("LifeTime", "LifeTime for interest packet", |
| StringValue ("2s"), |
| MakeTimeAccessor (&CcnxConsumer::m_interestLifeTime), |
| MakeTimeChecker ()) |
| .AddAttribute ("MinSuffixComponents", "MinSuffixComponents", |
| IntegerValue(-1), |
| MakeIntegerAccessor(&CcnxConsumer::m_minSuffixComponents), |
| MakeIntegerChecker<int32_t>()) |
| .AddAttribute ("MaxSuffixComponents", "MaxSuffixComponents", |
| IntegerValue(-1), |
| MakeIntegerAccessor(&CcnxConsumer::m_maxSuffixComponents), |
| MakeIntegerChecker<int32_t>()) |
| .AddAttribute ("ChildSelector", "ChildSelector", |
| BooleanValue(false), |
| MakeBooleanAccessor(&CcnxConsumer::m_childSelector), |
| MakeBooleanChecker()) |
| .AddAttribute ("Exclude", "only simple name matching is supported (use CcnxNameComponents)", |
| CcnxNameComponentsValue (), |
| MakeCcnxNameComponentsAccessor (&CcnxConsumer::m_exclude), |
| MakeCcnxNameComponentsChecker ()) |
| |
| .AddAttribute ("RTO", |
| "Initial retransmission timeout", |
| StringValue ("1s"), |
| MakeTimeAccessor (&CcnxConsumer::m_rto), |
| MakeTimeChecker ()) |
| .AddAttribute ("RetxTimer", |
| "Timeout defining how frequent retransmission timeouts should be checked", |
| StringValue ("1s"), |
| MakeTimeAccessor (&CcnxConsumer::GetRetxTimer, &CcnxConsumer::SetRetxTimer), |
| MakeTimeChecker ()) |
| |
| .AddTraceSource ("TransmittedInterests", "TransmittedInterests", |
| MakeTraceSourceAccessor (&CcnxConsumer::m_transmittedInterests)) |
| ; |
| |
| return tid; |
| } |
| |
| CcnxConsumer::CcnxConsumer () |
| : m_rand (0, std::numeric_limits<uint32_t>::max ()) |
| , m_desiredRate ("10Kbps") |
| , m_payloadSize (1040) |
| , m_seq (0) |
| { |
| NS_LOG_FUNCTION_NOARGS (); |
| |
| UpdateMean (); // not necessary (will be called by ns3 object system anyways), but doesn't hurt |
| } |
| |
| void |
| CcnxConsumer::SetRetxTimer (Time retxTimer) |
| { |
| m_retxTimer = retxTimer; |
| if (m_retxEvent.IsRunning ()) |
| m_retxEvent.Cancel (); // cancel any scheduled cleanup events |
| |
| // schedule even with new timeout |
| m_retxEvent = Simulator::Schedule (m_retxTimer, |
| &CcnxConsumer::CheckRetxTimeout, this); |
| } |
| |
| Time |
| CcnxConsumer::GetRetxTimer () const |
| { |
| return m_retxTimer; |
| } |
| |
| void |
| CcnxConsumer::CheckRetxTimeout () |
| { |
| Time now = Simulator::Now (); |
| |
| boost::mutex::scoped_lock (m_seqTimeoutsGuard); |
| |
| while (!m_seqTimeouts.empty ()) |
| { |
| SeqTimeoutsContainer::index<i_timestamp>::type::iterator entry = |
| m_seqTimeouts.get<i_timestamp> ().begin (); |
| if (entry->time + m_rto <= now) // timeout expired? |
| { |
| m_retxSeqs.insert (entry->seq); |
| m_seqTimeouts.get<i_timestamp> ().modify (entry, |
| ll::bind(&SeqTimeout::time, ll::_1) = now); |
| } |
| else |
| break; // nothing else to do. All later packets need not be retransmitted |
| } |
| |
| if (m_retxSeqs.size () > 0) |
| { |
| ScheduleNextPacket (); |
| } |
| |
| m_retxEvent = Simulator::Schedule (m_retxTimer, |
| &CcnxConsumer::CheckRetxTimeout, this); |
| } |
| |
| void |
| CcnxConsumer::UpdateMean () |
| { |
| double mean = 8.0 * m_payloadSize / m_desiredRate.GetBitRate (); |
| m_randExp = ExponentialVariable (mean, 10000 * mean); // set upper limit to inter-arrival time |
| } |
| |
| void |
| CcnxConsumer::SetPayloadSize (uint32_t payload) |
| { |
| m_payloadSize = payload; |
| UpdateMean (); |
| } |
| |
| uint32_t |
| CcnxConsumer::GetPayloadSize () const |
| { |
| return m_payloadSize; |
| } |
| |
| void |
| CcnxConsumer::SetDesiredRate (DataRate rate) |
| { |
| m_desiredRate = rate; |
| UpdateMean (); |
| } |
| |
| DataRate |
| CcnxConsumer::GetDesiredRate () const |
| { |
| return m_desiredRate; |
| } |
| |
| double |
| CcnxConsumer::GetMaxSize () const |
| { |
| if (m_seqMax == 0) |
| return -1.0; |
| |
| return m_seqMax * m_payloadSize / 1024.0 / 1024.0; |
| } |
| |
| void |
| CcnxConsumer::SetMaxSize (double size) |
| { |
| if (size < 0) |
| { |
| m_seqMax = 0; |
| return; |
| } |
| |
| m_seqMax = floor(1.0 + size * 1024.0 * 1024.0 / m_payloadSize); |
| NS_LOG_DEBUG ("MaxSeqNo: " << m_seqMax); |
| } |
| |
| |
| void |
| CcnxConsumer::ScheduleNextPacket () |
| { |
| if (!m_sendEvent.IsRunning ()) |
| m_sendEvent = Simulator::Schedule ( |
| Seconds(m_randExp.GetValue ()), |
| &CcnxConsumer::SendPacket, this); |
| } |
| |
| // Application Methods |
| void |
| CcnxConsumer::StartApplication () // Called at time specified by Start |
| { |
| NS_LOG_FUNCTION_NOARGS (); |
| |
| // do base stuff |
| CcnxApp::StartApplication (); |
| |
| ScheduleNextPacket (); |
| } |
| |
| void |
| CcnxConsumer::StopApplication () // Called at time specified by Stop |
| { |
| NS_LOG_FUNCTION_NOARGS (); |
| |
| // cancel periodic packet generation |
| Simulator::Cancel (m_sendEvent); |
| |
| // cleanup base stuff |
| CcnxApp::StopApplication (); |
| } |
| |
| void |
| CcnxConsumer::SendPacket () |
| { |
| if (!m_active) return; |
| |
| NS_LOG_FUNCTION_NOARGS (); |
| |
| boost::mutex::scoped_lock (m_seqTimeoutsGuard); |
| |
| uint32_t seq; |
| |
| if (m_retxSeqs.size () != 0) |
| { |
| seq = *m_retxSeqs.begin (); |
| NS_LOG_INFO ("Before: " << m_retxSeqs.size ()); |
| m_retxSeqs.erase (m_retxSeqs.begin ()); |
| NS_LOG_INFO ("After: " << m_retxSeqs.size ()); |
| } |
| else |
| { |
| if (m_seqMax > 0) |
| { |
| if (m_seq >= m_seqMax) |
| { |
| return; // we are totally done |
| } |
| } |
| |
| seq = m_seq++; |
| } |
| |
| // |
| Ptr<CcnxNameComponents> nameWithSequence = Create<CcnxNameComponents> (m_interestName); |
| (*nameWithSequence) (seq); |
| // |
| |
| CcnxInterestHeader interestHeader; |
| interestHeader.SetNonce (m_rand.GetValue ()); |
| interestHeader.SetName (nameWithSequence); |
| interestHeader.SetInterestLifetime (m_interestLifeTime); |
| interestHeader.SetChildSelector (m_childSelector); |
| if (m_exclude.size ()>0) |
| { |
| interestHeader.SetExclude (Create<CcnxNameComponents> (m_exclude)); |
| } |
| interestHeader.SetMaxSuffixComponents (m_maxSuffixComponents); |
| interestHeader.SetMinSuffixComponents (m_minSuffixComponents); |
| |
| // NS_LOG_INFO ("Requesting Interest: \n" << interestHeader); |
| NS_LOG_DEBUG ("node("<< GetNode()->GetId() <<") sending Interest for sequence " << seq); |
| |
| Ptr<Packet> packet = Create<Packet> (); |
| packet->AddHeader (interestHeader); |
| |
| m_protocolHandler (packet); |
| |
| NS_LOG_DEBUG ("Trying to add " << seq << " with " << Simulator::Now () << ". already " << m_seqTimeouts.size () << " items"); |
| |
| std::pair<SeqTimeoutsContainer::iterator, bool> |
| res = m_seqTimeouts.insert (SeqTimeout (seq, Simulator::Now ())); |
| |
| if (!res.second) |
| m_seqTimeouts.modify (res.first, |
| ll::bind(&SeqTimeout::time, ll::_1) = Simulator::Now ()); |
| |
| m_transmittedInterests (&interestHeader, this, m_face); |
| |
| ScheduleNextPacket (); |
| } |
| |
| /////////////////////////////////////////////////// |
| // Process incoming packets // |
| /////////////////////////////////////////////////// |
| |
| |
| void |
| CcnxConsumer::OnContentObject (const Ptr<const CcnxContentObjectHeader> &contentObject, |
| const Ptr<const Packet> &payload) |
| { |
| if (!m_active) return; |
| |
| CcnxApp::OnContentObject (contentObject, payload); // tracing inside |
| |
| NS_LOG_FUNCTION (this << contentObject << payload); |
| |
| // NS_LOG_INFO ("Received content object: " << boost::cref(*contentObject)); |
| |
| uint32_t seq = boost::lexical_cast<uint32_t> (contentObject->GetName ().GetComponents ().back ()); |
| NS_LOG_INFO ("node("<< GetNode()->GetId() <<") get DATA for sequence " << seq); |
| |
| boost::mutex::scoped_lock (m_seqTimeoutsGuard); |
| |
| // SeqTimeoutsContainer::iterator entry = m_seqTimeouts.find (seq); |
| |
| // NS_ASSERT_MSG (entry != m_seqTimeouts.end (), |
| // "Comment out this assert, if it causes problems"); |
| |
| // if (entry != m_seqTimeouts.end ()) |
| // m_seqTimeouts.erase (entry); |
| |
| m_seqTimeouts.erase (seq); |
| m_retxSeqs.erase (seq); |
| } |
| |
| void |
| CcnxConsumer::OnNack (const Ptr<const CcnxInterestHeader> &interest) |
| { |
| if (!m_active) return; |
| |
| CcnxApp::OnNack (interest); // tracing inside |
| |
| NS_LOG_DEBUG ("Nack type: " << interest->GetNack ()); |
| boost::mutex::scoped_lock (m_seqTimeoutsGuard); |
| |
| NS_LOG_FUNCTION (this << interest); |
| |
| // NS_LOG_INFO ("Received NACK: " << boost::cref(*interest)); |
| uint32_t seq = boost::lexical_cast<uint32_t> (interest->GetName ().GetComponents ().back ()); |
| NS_LOG_DEBUG ("node("<< GetNode()->GetId() <<") < NACK for " << seq); |
| |
| // put in the queue of interests to be retransmitted |
| NS_LOG_INFO ("Before: " << m_retxSeqs.size ()); |
| m_retxSeqs.insert (seq); |
| NS_LOG_INFO ("After: " << m_retxSeqs.size ()); |
| |
| ScheduleNextPacket (); |
| } |
| |
| } // namespace ns3 |