blob: e57d66edd834961e31f7293ca1945c9df4184cb1 [file] [log] [blame]
Alexander Afanasyev996b4872012-07-17 17:07:56 -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 */
20
21#include "nacks.h"
22
Alexander Afanasyev4aac5572012-08-09 10:49:55 -070023#include "ns3/ndn-pit.h"
24#include "ns3/ndn-pit-entry.h"
Alexander Afanasyevbd9c18e2012-11-19 15:23:41 -080025#include "ns3/ndn-interest.h"
26#include "ns3/ndn-content-object.h"
Alexander Afanasyev4aac5572012-08-09 10:49:55 -070027#include "ns3/ndn-pit.h"
28#include "ns3/ndn-fib.h"
29#include "ns3/ndn-content-store.h"
Xiaoke Jianga7325412013-03-10 00:25:12 +080030#include "ns3/ndnSIM/utils/ndn-fw-hop-count-tag.h"
Alexander Afanasyev996b4872012-07-17 17:07:56 -070031
32#include "ns3/assert.h"
33#include "ns3/ptr.h"
34#include "ns3/log.h"
35#include "ns3/simulator.h"
36#include "ns3/boolean.h"
37#include "ns3/string.h"
38
39#include <boost/ref.hpp>
40#include <boost/foreach.hpp>
41#include <boost/lambda/lambda.hpp>
42#include <boost/lambda/bind.hpp>
43#include <boost/tuple/tuple.hpp>
44namespace ll = boost::lambda;
45
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -070046NS_LOG_COMPONENT_DEFINE ("ndn.fw.Nacks");
Alexander Afanasyev996b4872012-07-17 17:07:56 -070047
48namespace ns3 {
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -070049namespace ndn {
50namespace fw {
Alexander Afanasyev996b4872012-07-17 17:07:56 -070051
52NS_OBJECT_ENSURE_REGISTERED (Nacks);
53
54TypeId
55Nacks::GetTypeId (void)
56{
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -070057 static TypeId tid = TypeId ("ns3::ndn::fw::Nacks")
Alexander Afanasyev4aac5572012-08-09 10:49:55 -070058 .SetGroupName ("Ndn")
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -070059 .SetParent<ForwardingStrategy> ()
Alexander Afanasyev3a3ce1a2013-01-31 11:26:11 -080060
Alexander Afanasyev996b4872012-07-17 17:07:56 -070061 ////////////////////////////////////////////////////////////////////
62 ////////////////////////////////////////////////////////////////////
63
64 .AddTraceSource ("OutNacks", "OutNacks", MakeTraceSourceAccessor (&Nacks::m_outNacks))
65 .AddTraceSource ("InNacks", "InNacks", MakeTraceSourceAccessor (&Nacks::m_inNacks))
66 .AddTraceSource ("DropNacks", "DropNacks", MakeTraceSourceAccessor (&Nacks::m_dropNacks))
Alexander Afanasyev3a3ce1a2013-01-31 11:26:11 -080067
Alexander Afanasyev996b4872012-07-17 17:07:56 -070068 .AddAttribute ("EnableNACKs", "Enabling support of NACKs",
69 BooleanValue (false),
70 MakeBooleanAccessor (&Nacks::m_nacksEnabled),
71 MakeBooleanChecker ())
72 ;
73 return tid;
74}
75
76void
Alexander Afanasyev31cb4692012-08-17 13:08:20 -070077Nacks::OnInterest (Ptr<Face> inFace,
Alexander Afanasyevb989b122013-07-10 17:15:46 -070078 Ptr<Interest> interest)
Alexander Afanasyev996b4872012-07-17 17:07:56 -070079{
Alexander Afanasyevb989b122013-07-10 17:15:46 -070080 if (interest->GetNack () > 0)
Alexander Afanasyevfaa01f92013-07-10 18:34:31 -070081 OnNack (inFace, interest);
Alexander Afanasyev996b4872012-07-17 17:07:56 -070082 else
Alexander Afanasyevb989b122013-07-10 17:15:46 -070083 super::OnInterest (inFace, interest);
Alexander Afanasyev996b4872012-07-17 17:07:56 -070084}
85
86void
Alexander Afanasyev31cb4692012-08-17 13:08:20 -070087Nacks::OnNack (Ptr<Face> inFace,
Alexander Afanasyevb989b122013-07-10 17:15:46 -070088 Ptr<Interest> nack)
Alexander Afanasyev996b4872012-07-17 17:07:56 -070089{
Alexander Afanasyevfaa01f92013-07-10 18:34:31 -070090 // NS_LOG_FUNCTION (inFace << nack->GetName ());
Alexander Afanasyevb989b122013-07-10 17:15:46 -070091 m_inNacks (nack, inFace);
Alexander Afanasyev786936a2012-07-17 19:48:15 -070092
Alexander Afanasyevfaa01f92013-07-10 18:34:31 -070093 Ptr<pit::Entry> pitEntry = m_pit->Lookup (*nack);
Alexander Afanasyev786936a2012-07-17 19:48:15 -070094 if (pitEntry == 0)
95 {
96 // somebody is doing something bad
Alexander Afanasyevb989b122013-07-10 17:15:46 -070097 m_dropNacks (nack, inFace);
Alexander Afanasyev786936a2012-07-17 19:48:15 -070098 return;
99 }
Alexander Afanasyev786936a2012-07-17 19:48:15 -0700100
Alexander Afanasyevfaa01f92013-07-10 18:34:31 -0700101 DidReceiveValidNack (inFace, nack->GetNack (), nack, pitEntry);
Alexander Afanasyev996b4872012-07-17 17:07:56 -0700102}
103
104void
Alexander Afanasyev31cb4692012-08-17 13:08:20 -0700105Nacks::DidReceiveDuplicateInterest (Ptr<Face> inFace,
Alexander Afanasyevb989b122013-07-10 17:15:46 -0700106 Ptr<const Interest> interest,
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -0700107 Ptr<pit::Entry> pitEntry)
Alexander Afanasyev996b4872012-07-17 17:07:56 -0700108{
Alexander Afanasyevb989b122013-07-10 17:15:46 -0700109 super::DidReceiveDuplicateInterest (inFace, interest, pitEntry);
Alexander Afanasyev996b4872012-07-17 17:07:56 -0700110
111 if (m_nacksEnabled)
112 {
113 NS_LOG_DEBUG ("Sending NACK_LOOP");
Alexander Afanasyevb989b122013-07-10 17:15:46 -0700114 Ptr<Interest> nack = Create<Interest> (*interest);
115 nack->SetNack (Interest::NACK_LOOP);
Alexander Afanasyev996b4872012-07-17 17:07:56 -0700116
Alexander Afanasyevb989b122013-07-10 17:15:46 -0700117 inFace->SendInterest (nack);
118 m_outNacks (nack, inFace);
Alexander Afanasyev996b4872012-07-17 17:07:56 -0700119 }
120}
121
122void
Alexander Afanasyev31cb4692012-08-17 13:08:20 -0700123Nacks::DidExhaustForwardingOptions (Ptr<Face> inFace,
Alexander Afanasyevb989b122013-07-10 17:15:46 -0700124 Ptr<const Interest> interest,
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -0700125 Ptr<pit::Entry> pitEntry)
Alexander Afanasyev996b4872012-07-17 17:07:56 -0700126{
Alexander Afanasyev996b4872012-07-17 17:07:56 -0700127 if (m_nacksEnabled)
128 {
Alexander Afanasyevfaa01f92013-07-10 18:34:31 -0700129 Ptr<Interest> nack = Create<Interest> (*interest);
Alexander Afanasyevb989b122013-07-10 17:15:46 -0700130 nack->SetNack (Interest::NACK_GIVEUP_PIT);
Alexander Afanasyev996b4872012-07-17 17:07:56 -0700131
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -0700132 BOOST_FOREACH (const pit::IncomingFace &incoming, pitEntry->GetIncoming ())
Alexander Afanasyev996b4872012-07-17 17:07:56 -0700133 {
Alexander Afanasyevb989b122013-07-10 17:15:46 -0700134 NS_LOG_DEBUG ("Send NACK for " << boost::cref (nack->GetName ()) << " to " << boost::cref (*incoming.m_face));
135 incoming.m_face->SendInterest (nack);
136 m_outNacks (nack, incoming.m_face);
Alexander Afanasyev996b4872012-07-17 17:07:56 -0700137 }
Alexander Afanasyev3a3ce1a2013-01-31 11:26:11 -0800138
139 pitEntry->ClearOutgoing (); // to force erasure of the record
Alexander Afanasyev6a3bb132012-08-15 09:47:35 -0700140 }
Alexander Afanasyev3a3ce1a2013-01-31 11:26:11 -0800141
Alexander Afanasyevfaa01f92013-07-10 18:34:31 -0700142 super::DidExhaustForwardingOptions (inFace, interest, pitEntry);
Alexander Afanasyev996b4872012-07-17 17:07:56 -0700143}
144
Alexander Afanasyev786936a2012-07-17 19:48:15 -0700145void
Alexander Afanasyev31cb4692012-08-17 13:08:20 -0700146Nacks::DidReceiveValidNack (Ptr<Face> inFace,
Alexander Afanasyev786936a2012-07-17 19:48:15 -0700147 uint32_t nackCode,
Alexander Afanasyevb989b122013-07-10 17:15:46 -0700148 Ptr<const Interest> nack,
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -0700149 Ptr<pit::Entry> pitEntry)
Alexander Afanasyev786936a2012-07-17 19:48:15 -0700150{
Alexander Afanasyevb989b122013-07-10 17:15:46 -0700151 NS_LOG_DEBUG ("nackCode: " << nackCode << " for [" << nack->GetName () << "]");
Alexander Afanasyev3a3ce1a2013-01-31 11:26:11 -0800152
Alexander Afanasyev786936a2012-07-17 19:48:15 -0700153 // If NACK is NACK_GIVEUP_PIT, then neighbor gave up trying to and removed it's PIT entry.
154 // So, if we had an incoming entry to this neighbor, then we can remove it now
Alexander Afanasyeveae83ee2013-03-15 15:01:10 -0700155 if (nackCode == Interest::NACK_GIVEUP_PIT)
Alexander Afanasyev786936a2012-07-17 19:48:15 -0700156 {
Alexander Afanasyev31cb4692012-08-17 13:08:20 -0700157 pitEntry->RemoveIncoming (inFace);
Alexander Afanasyev786936a2012-07-17 19:48:15 -0700158 }
159
Alexander Afanasyeveae83ee2013-03-15 15:01:10 -0700160 if (nackCode == Interest::NACK_LOOP ||
161 nackCode == Interest::NACK_CONGESTION ||
162 nackCode == Interest::NACK_GIVEUP_PIT)
Alexander Afanasyev0484e772012-10-29 11:02:08 -0700163 {
164 pitEntry->SetWaitingInVain (inFace);
165
166 if (!pitEntry->AreAllOutgoingInVain ()) // not all ougtoing are in vain
167 {
168 NS_LOG_DEBUG ("Not all outgoing are in vain");
169 // suppress
170 // Don't do anything, we are still expecting data from some other face
Alexander Afanasyevb989b122013-07-10 17:15:46 -0700171 m_dropNacks (nack, inFace);
Alexander Afanasyev0484e772012-10-29 11:02:08 -0700172 return;
173 }
Alexander Afanasyev3a3ce1a2013-01-31 11:26:11 -0800174
Alexander Afanasyevb989b122013-07-10 17:15:46 -0700175 Ptr<Interest> interest = Create<Interest> (*nack);
176 interest->SetNack (Interest::NORMAL_INTEREST);
Alexander Afanasyev3a3ce1a2013-01-31 11:26:11 -0800177
Alexander Afanasyevb989b122013-07-10 17:15:46 -0700178 bool propagated = DoPropagateInterest (inFace, interest, pitEntry);
Alexander Afanasyev0484e772012-10-29 11:02:08 -0700179 if (!propagated)
180 {
Alexander Afanasyevb989b122013-07-10 17:15:46 -0700181 DidExhaustForwardingOptions (inFace, interest, pitEntry);
Alexander Afanasyev0484e772012-10-29 11:02:08 -0700182 }
183 }
Alexander Afanasyev786936a2012-07-17 19:48:15 -0700184}
Alexander Afanasyev996b4872012-07-17 17:07:56 -0700185
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -0700186} // namespace fw
187} // namespace ndn
Alexander Afanasyev996b4872012-07-17 17:07:56 -0700188} // namespace ns3