blob: f05a80fed96197469a628708542c14bc9b6f35f0 [file] [log] [blame]
Alexander Afanasyevc74a6022011-08-15 20:01:35 -07001/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil -*- */
Alexander Afanasyevab1d5602011-08-17 19:17:18 -07002/*
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>
Ilya Moiseenko172763c2011-10-28 13:21:53 -070019 * Ilya Moiseenko <iliamo@cs.ucla.edu>
Alexander Afanasyevab1d5602011-08-17 19:17:18 -070020 */
Alexander Afanasyev08d984e2011-08-13 19:20:22 -070021
Alexander Afanasyev45b92d42011-08-14 23:11:38 -070022#include "ccnx-l3-protocol.h"
23
Alexander Afanasyev08d984e2011-08-13 19:20:22 -070024#include "ns3/packet.h"
Alexander Afanasyev45b92d42011-08-14 23:11:38 -070025#include "ns3/node.h"
Alexander Afanasyev08d984e2011-08-13 19:20:22 -070026#include "ns3/log.h"
27#include "ns3/callback.h"
Alexander Afanasyev08d984e2011-08-13 19:20:22 -070028#include "ns3/uinteger.h"
29#include "ns3/trace-source-accessor.h"
30#include "ns3/object-vector.h"
Alexander Afanasyev08d984e2011-08-13 19:20:22 -070031#include "ns3/boolean.h"
Alexander Afanasyev07827182011-12-13 01:07:32 -080032#include "ns3/string.h"
Alexander Afanasyev08d984e2011-08-13 19:20:22 -070033
Alexander Afanasyevc74a6022011-08-15 20:01:35 -070034#include "ns3/ccnx-header-helper.h"
35
Alexander Afanasyev45b92d42011-08-14 23:11:38 -070036#include "ccnx-face.h"
Alexander Afanasyevc74a6022011-08-15 20:01:35 -070037#include "ccnx-forwarding-strategy.h"
38#include "ccnx-interest-header.h"
39#include "ccnx-content-object-header.h"
40
Alexander Afanasyev52e9aa92011-11-15 20:23:20 -080041#include "ccnx-net-device-face.h"
42
Alexander Afanasyev56f79ea2011-08-17 23:54:27 -070043#include <boost/foreach.hpp>
Alexander Afanasyeva46844b2011-11-21 19:13:26 -080044#include <boost/lambda/lambda.hpp>
Alexander Afanasyeva5bbe0e2011-11-22 17:28:39 -080045#include <boost/lambda/bind.hpp>
Alexander Afanasyeva46844b2011-11-21 19:13:26 -080046
47using namespace boost::tuples;
Alexander Afanasyeva5bbe0e2011-11-22 17:28:39 -080048namespace ll = boost::lambda;
Alexander Afanasyev08d984e2011-08-13 19:20:22 -070049
50NS_LOG_COMPONENT_DEFINE ("CcnxL3Protocol");
51
52namespace ns3 {
53
Alexander Afanasyev7112f482011-08-17 14:05:57 -070054const uint16_t CcnxL3Protocol::ETHERNET_FRAME_TYPE = 0x7777;
Alexander Afanasyev08d984e2011-08-13 19:20:22 -070055
Alexander Afanasyev07827182011-12-13 01:07:32 -080056
Alexander Afanasyev08d984e2011-08-13 19:20:22 -070057NS_OBJECT_ENSURE_REGISTERED (CcnxL3Protocol);
58
59TypeId
60CcnxL3Protocol::GetTypeId (void)
61{
62 static TypeId tid = TypeId ("ns3::CcnxL3Protocol")
63 .SetParent<Ccnx> ()
Alexander Afanasyev070aa482011-08-20 00:38:25 -070064 .SetGroupName ("Ccnx")
Alexander Afanasyev08d984e2011-08-13 19:20:22 -070065 .AddConstructor<CcnxL3Protocol> ()
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -080066 .AddAttribute ("BucketLeakInterval",
67 "Interval to leak buckets",
68 StringValue ("10ms"),
Alexander Afanasyev19426ef2011-11-23 20:55:28 -080069 MakeTimeAccessor (&CcnxL3Protocol::GetBucketLeakInterval,
70 &CcnxL3Protocol::SetBucketLeakInterval),
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -080071 MakeTimeChecker ())
Ilya Moiseenko816de832011-12-15 16:32:24 -080072
73 .AddTraceSource ("TransmittedInterestTrace", "Interests that were transmitted",
74 MakeTraceSourceAccessor (&CcnxL3Protocol::m_transmittedInterestsTrace))
75
76 .AddTraceSource ("ReceivedInterestTrace", "Interests that were received",
77 MakeTraceSourceAccessor (&CcnxL3Protocol::m_receivedInterestsTrace))
78
79 .AddTraceSource ("DroppedInterestTrace", "Interests that were dropped",
80 MakeTraceSourceAccessor (&CcnxL3Protocol::m_droppedInterestsTrace))
81
82 .AddTraceSource ("ReceivedDataTrace", "Data that were received",
83 MakeTraceSourceAccessor (&CcnxL3Protocol::m_receivedDataTrace))
84
85 .AddTraceSource ("TransmittedDataTrace", "Data that were transmitted",
86 MakeTraceSourceAccessor (&CcnxL3Protocol::m_transmittedDataTrace))
87
88 .AddTraceSource ("DroppedDataTrace", "Data that were dropped",
89 MakeTraceSourceAccessor (&CcnxL3Protocol::m_droppedDataTrace))
90
Alexander Afanasyev08d984e2011-08-13 19:20:22 -070091 ;
92 return tid;
93}
94
95CcnxL3Protocol::CcnxL3Protocol()
Alexander Afanasyevab1d5602011-08-17 19:17:18 -070096: m_faceCounter (0)
Alexander Afanasyev08d984e2011-08-13 19:20:22 -070097{
98 NS_LOG_FUNCTION (this);
Alexander Afanasyevcf133f02011-09-06 12:13:48 -070099
Alexander Afanasyevcf133f02011-09-06 12:13:48 -0700100 m_pit = CreateObject<CcnxPit> ();
101 m_contentStore = CreateObject<CcnxContentStore> ();
Alexander Afanasyev08d984e2011-08-13 19:20:22 -0700102}
103
104CcnxL3Protocol::~CcnxL3Protocol ()
105{
106 NS_LOG_FUNCTION (this);
107}
108
109void
110CcnxL3Protocol::SetNode (Ptr<Node> node)
111{
112 m_node = node;
Alexander Afanasyevc5a23e22011-09-07 00:37:36 -0700113 m_fib = m_node->GetObject<CcnxFib> ();
114 NS_ASSERT_MSG (m_fib != 0, "FIB should be created and aggregated to a node before calling Ccnx::SetNode");
115
116 m_pit->SetFib (m_fib);
Alexander Afanasyev08d984e2011-08-13 19:20:22 -0700117}
118
119/*
120 * This method is called by AddAgregate and completes the aggregation
121 * by setting the node in the ccnx stack
122 */
123void
124CcnxL3Protocol::NotifyNewAggregate ()
125{
126 if (m_node == 0)
127 {
128 Ptr<Node>node = this->GetObject<Node>();
129 // verify that it's a valid node and that
130 // the node has not been set before
131 if (node != 0)
132 {
133 this->SetNode (node);
134 }
135 }
136 Object::NotifyNewAggregate ();
137}
138
Alexander Afanasyev08d984e2011-08-13 19:20:22 -0700139void
140CcnxL3Protocol::DoDispose (void)
141{
142 NS_LOG_FUNCTION (this);
143
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -0800144 if (m_bucketLeakEvent.IsRunning ())
145 m_bucketLeakEvent.Cancel ();
146
Alexander Afanasyev45b92d42011-08-14 23:11:38 -0700147 for (CcnxFaceList::iterator i = m_faces.begin (); i != m_faces.end (); ++i)
Alexander Afanasyev08d984e2011-08-13 19:20:22 -0700148 {
149 *i = 0;
150 }
Alexander Afanasyev98256102011-08-14 01:00:02 -0700151 m_faces.clear ();
Alexander Afanasyev08d984e2011-08-13 19:20:22 -0700152 m_node = 0;
Alexander Afanasyevd02a5d62011-11-21 11:01:51 -0800153
154 // Force delete on objects
Alexander Afanasyev18252852011-11-21 13:35:31 -0800155 m_forwardingStrategy = 0; // there is a reference to PIT stored in here
Alexander Afanasyevd02a5d62011-11-21 11:01:51 -0800156 m_pit = 0;
157 m_contentStore = 0;
Alexander Afanasyev18252852011-11-21 13:35:31 -0800158 m_fib = 0;
159
Alexander Afanasyevc74a6022011-08-15 20:01:35 -0700160 // m_forwardingStrategy = 0;
Alexander Afanasyev08d984e2011-08-13 19:20:22 -0700161 Object::DoDispose ();
162}
163
Alexander Afanasyeva67e28c2011-08-31 21:16:25 -0700164void
165CcnxL3Protocol::SetForwardingStrategy (Ptr<CcnxForwardingStrategy> forwardingStrategy)
166{
167 NS_LOG_FUNCTION (this);
168 m_forwardingStrategy = forwardingStrategy;
Alexander Afanasyev19426ef2011-11-23 20:55:28 -0800169 m_forwardingStrategy->SetPit (m_pit);
Alexander Afanasyeva67e28c2011-08-31 21:16:25 -0700170}
171
172Ptr<CcnxForwardingStrategy>
173CcnxL3Protocol::GetForwardingStrategy (void) const
174{
175 return m_forwardingStrategy;
176}
177
Alexander Afanasyev08d984e2011-08-13 19:20:22 -0700178uint32_t
Alexander Afanasyev7112f482011-08-17 14:05:57 -0700179CcnxL3Protocol::AddFace (const Ptr<CcnxFace> &face)
Alexander Afanasyev08d984e2011-08-13 19:20:22 -0700180{
Alexander Afanasyev56f79ea2011-08-17 23:54:27 -0700181 NS_LOG_FUNCTION (this << &face);
Alexander Afanasyev08d984e2011-08-13 19:20:22 -0700182
Alexander Afanasyevab1d5602011-08-17 19:17:18 -0700183 face->SetId (m_faceCounter); // sets a unique ID of the face. This ID serves only informational purposes
Alexander Afanasyev08d984e2011-08-13 19:20:22 -0700184
Alexander Afanasyeva67e28c2011-08-31 21:16:25 -0700185 // ask face to register in lower-layer stack
Alexander Afanasyev56f79ea2011-08-17 23:54:27 -0700186 face->RegisterProtocolHandler (MakeCallback (&CcnxL3Protocol::Receive, this));
Alexander Afanasyev08d984e2011-08-13 19:20:22 -0700187
Alexander Afanasyev45b92d42011-08-14 23:11:38 -0700188 m_faces.push_back (face);
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -0800189 m_faceCounter++;
Alexander Afanasyev0ab833e2011-08-18 15:49:13 -0700190 return face->GetId ();
Alexander Afanasyev08d984e2011-08-13 19:20:22 -0700191}
192
Alexander Afanasyevc5a23e22011-09-07 00:37:36 -0700193void
194CcnxL3Protocol::RemoveFace (Ptr<CcnxFace> face)
195{
196 // ask face to register in lower-layer stack
197 face->RegisterProtocolHandler (MakeNullCallback<void,const Ptr<CcnxFace>&,const Ptr<const Packet>&> ());
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -0800198
199 // just to be on a safe side. Do the process in two steps
Alexander Afanasyev4a5c2c12011-12-12 18:50:57 -0800200 std::list<boost::reference_wrapper<const CcnxPitEntry> > entriesToRemoves;
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -0800201 BOOST_FOREACH (const CcnxPitEntry &pitEntry, *m_pit)
202 {
203 m_pit->modify (m_pit->iterator_to (pitEntry),
Alexander Afanasyev19426ef2011-11-23 20:55:28 -0800204 ll::bind (&CcnxPitEntry::RemoveAllReferencesToFace, ll::_1, face));
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -0800205
206 // If this face is the only for the associated FIB entry, then FIB entry will be removed soon.
207 // Thus, we have to remove the whole PIT entry
Alexander Afanasyev19426ef2011-11-23 20:55:28 -0800208 if (pitEntry.m_fibEntry.m_faces.size () == 1 &&
209 pitEntry.m_fibEntry.m_faces.begin ()->m_face == face)
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -0800210 {
Alexander Afanasyev4a5c2c12011-12-12 18:50:57 -0800211 entriesToRemoves.push_back (boost::cref (pitEntry));
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -0800212 }
213 }
Alexander Afanasyev4a5c2c12011-12-12 18:50:57 -0800214 BOOST_FOREACH (const CcnxPitEntry &removedEntry, entriesToRemoves)
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -0800215 {
Alexander Afanasyev4a5c2c12011-12-12 18:50:57 -0800216 m_pit->erase (m_pit->iterator_to (removedEntry));
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -0800217 }
218
Alexander Afanasyevc5a23e22011-09-07 00:37:36 -0700219 CcnxFaceList::iterator face_it = find (m_faces.begin(), m_faces.end(), face);
220 NS_ASSERT_MSG (face_it != m_faces.end (), "Attempt to remove face that doesn't exist");
221 m_faces.erase (face_it);
222}
223
Alexander Afanasyev45b92d42011-08-14 23:11:38 -0700224Ptr<CcnxFace>
Alexander Afanasyev98256102011-08-14 01:00:02 -0700225CcnxL3Protocol::GetFace (uint32_t index) const
Alexander Afanasyev08d984e2011-08-13 19:20:22 -0700226{
Alexander Afanasyev56f79ea2011-08-17 23:54:27 -0700227 BOOST_FOREACH (const Ptr<CcnxFace> &face, m_faces) // this function is not supposed to be called often, so linear search is fine
Alexander Afanasyev08d984e2011-08-13 19:20:22 -0700228 {
Alexander Afanasyev56f79ea2011-08-17 23:54:27 -0700229 if (face->GetId () == index)
230 return face;
Alexander Afanasyev08d984e2011-08-13 19:20:22 -0700231 }
232 return 0;
233}
234
Alexander Afanasyev52e9aa92011-11-15 20:23:20 -0800235Ptr<CcnxFace>
236CcnxL3Protocol::GetFaceByNetDevice (Ptr<NetDevice> netDevice) const
237{
238 BOOST_FOREACH (const Ptr<CcnxFace> &face, m_faces) // this function is not supposed to be called often, so linear search is fine
239 {
240 Ptr<CcnxNetDeviceFace> netDeviceFace = DynamicCast<CcnxNetDeviceFace> (face);
241 if (netDeviceFace == 0) continue;
242
243 if (netDeviceFace->GetNetDevice () == netDevice)
244 return face;
245 }
246 return 0;
247}
248
Alexander Afanasyev08d984e2011-08-13 19:20:22 -0700249uint32_t
Alexander Afanasyev98256102011-08-14 01:00:02 -0700250CcnxL3Protocol::GetNFaces (void) const
Alexander Afanasyev08d984e2011-08-13 19:20:22 -0700251{
Alexander Afanasyev98256102011-08-14 01:00:02 -0700252 return m_faces.size ();
Alexander Afanasyev08d984e2011-08-13 19:20:22 -0700253}
254
Alexander Afanasyev98256102011-08-14 01:00:02 -0700255// Callback from lower layer
Alexander Afanasyev08d984e2011-08-13 19:20:22 -0700256void
Alexander Afanasyev0ab833e2011-08-18 15:49:13 -0700257CcnxL3Protocol::Receive (const Ptr<CcnxFace> &face, const Ptr<const Packet> &p)
Alexander Afanasyev08d984e2011-08-13 19:20:22 -0700258{
Alexander Afanasyevc5a23e22011-09-07 00:37:36 -0700259 NS_LOG_LOGIC ("Packet from face " << *face << " received on node " << m_node->GetId ());
Alexander Afanasyev08d984e2011-08-13 19:20:22 -0700260
Alexander Afanasyev45b92d42011-08-14 23:11:38 -0700261 Ptr<Packet> packet = p->Copy (); // give upper layers a rw copy of the packet
Alexander Afanasyevc74a6022011-08-15 20:01:35 -0700262 try
263 {
Alexander Afanasyevc5a23e22011-09-07 00:37:36 -0700264 CcnxHeaderHelper::Type type = CcnxHeaderHelper::GetCcnxHeaderType (p);
Alexander Afanasyeva67e28c2011-08-31 21:16:25 -0700265 switch (type)
266 {
267 case CcnxHeaderHelper::INTEREST:
268 {
269 Ptr<CcnxInterestHeader> header = Create<CcnxInterestHeader> ();
Alexander Afanasyev78cf0c92011-09-01 19:57:14 -0700270
271 // Deserialization. Exception may be thrown
272 packet->RemoveHeader (*header);
273 NS_ASSERT_MSG (packet->GetSize () == 0, "Payload of Interests should be zero");
Alexander Afanasyeva46844b2011-11-21 19:13:26 -0800274
275 if (header->GetNack () > 0)
276 OnNack (face, header, p/*original packet*/);
277 else
278 OnInterest (face, header, p/*original packet*/);
Alexander Afanasyeva67e28c2011-08-31 21:16:25 -0700279 break;
280 }
281 case CcnxHeaderHelper::CONTENT_OBJECT:
282 {
283 Ptr<CcnxContentObjectHeader> header = Create<CcnxContentObjectHeader> ();
Alexander Afanasyev78cf0c92011-09-01 19:57:14 -0700284
285 static CcnxContentObjectTail contentObjectTrailer; //there is no data in this object
286
287 // Deserialization. Exception may be thrown
288 packet->RemoveHeader (*header);
289 packet->RemoveTrailer (contentObjectTrailer);
290
291 OnData (face, header, packet/*payload*/, p/*original packet*/);
Alexander Afanasyeva67e28c2011-08-31 21:16:25 -0700292 break;
293 }
294 }
295
296 // exception will be thrown if packet is not recognized
Alexander Afanasyevc74a6022011-08-15 20:01:35 -0700297 }
298 catch (CcnxUnknownHeaderException)
299 {
300 NS_ASSERT_MSG (false, "Unknown CCNx header. Should not happen");
301 }
Alexander Afanasyev98256102011-08-14 01:00:02 -0700302}
Alexander Afanasyev08d984e2011-08-13 19:20:22 -0700303
Alexander Afanasyeva46844b2011-11-21 19:13:26 -0800304void
Alexander Afanasyev9d313d42011-11-25 13:36:15 -0800305CcnxL3Protocol::OnNack (const Ptr<CcnxFace> &incomingFace,
Alexander Afanasyeva46844b2011-11-21 19:13:26 -0800306 Ptr<CcnxInterestHeader> &header,
Alexander Afanasyev9d313d42011-11-25 13:36:15 -0800307 const Ptr<const Packet> &packet)
Alexander Afanasyeva46844b2011-11-21 19:13:26 -0800308{
Alexander Afanasyev9d313d42011-11-25 13:36:15 -0800309 NS_LOG_FUNCTION (incomingFace << header << packet);
Alexander Afanasyeva46844b2011-11-21 19:13:26 -0800310
Alexander Afanasyev9d313d42011-11-25 13:36:15 -0800311 tuple<const CcnxPitEntry&,bool,bool> ret = m_pit->Lookup (*header);
312 CcnxPitEntry const& pitEntry = ret.get<0> ();
Alexander Afanasyeva7a2b8b2011-11-28 18:19:09 -0800313 bool isNew = ret.get<1> ();
Alexander Afanasyeve67a97f2011-11-29 14:28:59 -0800314 bool isDuplicated = ret.get<2> ();
Alexander Afanasyev9d313d42011-11-25 13:36:15 -0800315
Alexander Afanasyeva7a2b8b2011-11-28 18:19:09 -0800316 // NS_ASSERT_MSG (isDuplicated,
317 // "NACK should be a duplicated interest");
Alexander Afanasyeve67a97f2011-11-29 14:28:59 -0800318 if (isNew || !isDuplicated) // potential flow
Alexander Afanasyeva7a2b8b2011-11-28 18:19:09 -0800319 {
320 // somebody is doing something bad
Ilya Moiseenko816de832011-12-15 16:32:24 -0800321 m_droppedInterestsTrace (header, NACK_NONDUPLICATE, m_node->GetObject<Ccnx> (), incomingFace);
Alexander Afanasyeva7a2b8b2011-11-28 18:19:09 -0800322 return;
323 }
Alexander Afanasyeva46844b2011-11-21 19:13:26 -0800324
Alexander Afanasyev9d313d42011-11-25 13:36:15 -0800325 // CcnxPitEntryIncomingFaceContainer::type::iterator inFace = pitEntry.m_incoming.find (incomingFace);
326 CcnxPitEntryOutgoingFaceContainer::type::iterator outFace = pitEntry.m_outgoing.find (incomingFace);
Alexander Afanasyeva46844b2011-11-21 19:13:26 -0800327
Alexander Afanasyeve67a97f2011-11-29 14:28:59 -0800328 if (outFace == pitEntry.m_outgoing.end ())
Alexander Afanasyeva7a2b8b2011-11-28 18:19:09 -0800329 {
Alexander Afanasyeve67a97f2011-11-29 14:28:59 -0800330 NS_ASSERT_MSG (false,
331 "Node " << GetObject<Node> ()->GetId () << ", outgoing entry should exist for face " << boost::cref(*incomingFace) << "\n" <<
332 "size: " << pitEntry.m_outgoing.size ());
Alexander Afanasyeva7a2b8b2011-11-28 18:19:09 -0800333
334 return;
335 }
Alexander Afanasyev9d313d42011-11-25 13:36:15 -0800336
Alexander Afanasyev0a61c342011-12-06 12:48:55 -0800337 // This was done in error. Never, never do anything, except normal leakage. This way we ensure that we will not have losses,
338 // at least when there is only one client
339 //
340 // incomingFace->LeakBucketByOnePacket ();
Alexander Afanasyeve67a97f2011-11-29 14:28:59 -0800341
Alexander Afanasyev23d2b542011-12-07 18:54:46 -0800342 NS_LOG_ERROR ("Nack on " << boost::cref(*incomingFace));
343
Alexander Afanasyev5a595072011-11-25 14:49:07 -0800344 m_pit->modify (m_pit->iterator_to (pitEntry),
345 ll::bind (&CcnxPitEntry::SetWaitingInVain, ll::_1, outFace));
Alexander Afanasyeva46844b2011-11-21 19:13:26 -0800346
Alexander Afanasyev9d313d42011-11-25 13:36:15 -0800347 // If NACK is NACK_GIVEUP_PIT, then neighbor gave up trying to and removed it's PIT entry.
348 // So, if we had an incoming entry to this neighbor, then we can remove it now
Alexander Afanasyeva46844b2011-11-21 19:13:26 -0800349
Alexander Afanasyev9d313d42011-11-25 13:36:15 -0800350 if (header->GetNack () == CcnxInterestHeader::NACK_GIVEUP_PIT)
351 {
352 m_pit->modify (m_pit->iterator_to (pitEntry),
353 ll::bind (&CcnxPitEntry::RemoveIncoming, ll::_1, incomingFace));
354 }
Alexander Afanasyeva46844b2011-11-21 19:13:26 -0800355
Alexander Afanasyev07827182011-12-13 01:07:32 -0800356 m_fib->m_fib.modify (m_fib->m_fib.iterator_to (pitEntry.m_fibEntry),
357 ll::bind (&CcnxFibEntry::UpdateStatus,
358 ll::_1, incomingFace, CcnxFibFaceMetric::NDN_FIB_YELLOW));
Alexander Afanasyeva7a2b8b2011-11-28 18:19:09 -0800359
Alexander Afanasyev23d2b542011-12-07 18:54:46 -0800360 if (pitEntry.m_incoming.size () == 0) // interest was actually satisfied
361 {
362 // no need to do anything
Ilya Moiseenko816de832011-12-15 16:32:24 -0800363 m_droppedInterestsTrace (header, NACK_AFTER_SATISFIED, m_node->GetObject<Ccnx> (), incomingFace);
Alexander Afanasyev23d2b542011-12-07 18:54:46 -0800364 return;
365 }
366
Alexander Afanasyeve67a97f2011-11-29 14:28:59 -0800367 if (!pitEntry.AreAllOutgoingInVain ()) // not all ougtoing are in vain
Alexander Afanasyeva7a2b8b2011-11-28 18:19:09 -0800368 {
Alexander Afanasyev23d2b542011-12-07 18:54:46 -0800369 NS_LOG_DEBUG ("Not all outgoing are in vain");
Alexander Afanasyeva7a2b8b2011-11-28 18:19:09 -0800370 // suppress
371 // Don't do anything, we are still expecting data from some other face
Ilya Moiseenko816de832011-12-15 16:32:24 -0800372 m_droppedInterestsTrace (header, NACK_SUPPRESSED, m_node->GetObject<Ccnx> (), incomingFace);
Alexander Afanasyeva7a2b8b2011-11-28 18:19:09 -0800373 return;
374 }
Alexander Afanasyev9d313d42011-11-25 13:36:15 -0800375
376 NS_ASSERT_MSG (m_forwardingStrategy != 0, "Need a forwarding protocol object to process packets");
Alexander Afanasyeva46844b2011-11-21 19:13:26 -0800377
Alexander Afanasyev9d313d42011-11-25 13:36:15 -0800378 Ptr<Packet> nonNackInterest = Create<Packet> ();
379 header->SetNack (CcnxInterestHeader::NORMAL_INTEREST);
380 nonNackInterest->AddHeader (*header);
381
382 bool propagated = m_forwardingStrategy->
383 PropagateInterest (pitEntry, incomingFace, header, nonNackInterest);
384
Alexander Afanasyev23d2b542011-12-07 18:54:46 -0800385 // // ForwardingStrategy will try its best to forward packet to at least one interface.
386 // // If no interests was propagated, then there is not other option for forwarding or
387 // // ForwardingStrategy failed to find it.
Alexander Afanasyeve67a97f2011-11-29 14:28:59 -0800388 if (!propagated)
Alexander Afanasyev23d2b542011-12-07 18:54:46 -0800389 GiveUpInterest (pitEntry, header);
Alexander Afanasyeva46844b2011-11-21 19:13:26 -0800390}
391
Alexander Afanasyevc74a6022011-08-15 20:01:35 -0700392// Processing Interests
Alexander Afanasyeva46844b2011-11-21 19:13:26 -0800393//
394// !!! Key point.
395// !!! All interests should be answerred!!! Either later with data, immediately with data, or immediately with NACK
Alexander Afanasyeva67e28c2011-08-31 21:16:25 -0700396void CcnxL3Protocol::OnInterest (const Ptr<CcnxFace> &incomingFace,
397 Ptr<CcnxInterestHeader> &header,
Alexander Afanasyev78cf0c92011-09-01 19:57:14 -0700398 const Ptr<const Packet> &packet)
Alexander Afanasyev98256102011-08-14 01:00:02 -0700399{
Alexander Afanasyeva46844b2011-11-21 19:13:26 -0800400 NS_LOG_FUNCTION (incomingFace << header << packet);
Ilya Moiseenko816de832011-12-15 16:32:24 -0800401 //m_receivedInterestsTrace (header, m_node->GetObject<Ccnx> (), incomingFace);
Alexander Afanasyevc74a6022011-08-15 20:01:35 -0700402
Alexander Afanasyeva46844b2011-11-21 19:13:26 -0800403 // Lookup of Pit (and associated Fib) entry for this Interest
Alexander Afanasyeva5bbe0e2011-11-22 17:28:39 -0800404 tuple<const CcnxPitEntry&,bool,bool> ret = m_pit->Lookup (*header);
405 CcnxPitEntry const& pitEntry = ret.get<0> ();
406 // bool isNew = ret.get<1> ();
407 bool isDuplicated = ret.get<2> ();
Ilya Moiseenkod83eb0d2011-11-16 15:23:46 -0800408
Alexander Afanasyeva46844b2011-11-21 19:13:26 -0800409 if (isDuplicated)
Ilya Moiseenko172763c2011-10-28 13:21:53 -0700410 {
Alexander Afanasyeva46844b2011-11-21 19:13:26 -0800411 /**
412 * This condition will handle "routing" loops and also recently satisfied interests.
413 * Every time interest is satisfied, PIT entry (with empty incoming and outgoing faces)
414 * is kept for another small chunk of time.
415 */
Ilya Moiseenko172763c2011-10-28 13:21:53 -0700416
Alexander Afanasyeva46844b2011-11-21 19:13:26 -0800417 // //Trace duplicate interest
418 // m_droppedInterestsTrace (header, NDN_DUPLICATE_INTEREST, m_node->GetObject<Ccnx> (), incomingFace);
Ilya Moiseenko172763c2011-10-28 13:21:53 -0700419
Alexander Afanasyev23d2b542011-12-07 18:54:46 -0800420 NS_LOG_DEBUG ("Sending NACK_LOOP");
Alexander Afanasyeva46844b2011-11-21 19:13:26 -0800421 header->SetNack (CcnxInterestHeader::NACK_LOOP);
Alexander Afanasyev23d2b542011-12-07 18:54:46 -0800422 Ptr<Packet> nack = Create<Packet> ();
423 nack->AddHeader (*header);
Ilya Moiseenko172763c2011-10-28 13:21:53 -0700424
Alexander Afanasyev23d2b542011-12-07 18:54:46 -0800425 incomingFace->Send (nack);
Ilya Moiseenko172763c2011-10-28 13:21:53 -0700426
Alexander Afanasyeva46844b2011-11-21 19:13:26 -0800427 // //Trace duplicate interest
Ilya Moiseenko816de832011-12-15 16:32:24 -0800428 m_droppedInterestsTrace (header, NDN_DUPLICATE_INTEREST, m_node->GetObject<Ccnx> (), incomingFace);
Alexander Afanasyevcf133f02011-09-06 12:13:48 -0700429 return;
430 }
Alexander Afanasyeva46844b2011-11-21 19:13:26 -0800431
432 Ptr<Packet> contentObject;
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -0800433 Ptr<const CcnxContentObjectHeader> contentObjectHeader; // unused for now
Alexander Afanasyeva46844b2011-11-21 19:13:26 -0800434 tie (contentObject, contentObjectHeader) = m_contentStore->Lookup (header);
435 if (contentObject != 0)
436 {
Alexander Afanasyeva46844b2011-11-21 19:13:26 -0800437 NS_ASSERT (contentObjectHeader != 0);
438
439 NS_LOG_LOGIC("Found in cache");
440
Ilya Moiseenko816de832011-12-15 16:32:24 -0800441 m_transmittedDataTrace (contentObjectHeader, contentObject, CACHED, m_node->GetObject<Ccnx> (), incomingFace);
Alexander Afanasyev19426ef2011-11-23 20:55:28 -0800442 incomingFace->Send (contentObject);
Alexander Afanasyeva46844b2011-11-21 19:13:26 -0800443
444 // Set pruning timout on PIT entry (instead of deleting the record)
445 m_pit->modify (m_pit->iterator_to (pitEntry),
Alexander Afanasyeva5bbe0e2011-11-22 17:28:39 -0800446 bind (&CcnxPitEntry::SetExpireTime, ll::_1,
447 Simulator::Now () + m_pit->GetPitEntryPruningTimeout ()));
Ilya Moiseenko816de832011-12-15 16:32:24 -0800448
Alexander Afanasyeva46844b2011-11-21 19:13:26 -0800449 return;
450 }
451
452 // \todo Detect retransmissions. Not yet sure how...
Alexander Afanasyev070aa482011-08-20 00:38:25 -0700453
Ilya Moiseenko172763c2011-10-28 13:21:53 -0700454 // Data is not in cache
Alexander Afanasyeva46844b2011-11-21 19:13:26 -0800455 CcnxPitEntryIncomingFaceContainer::type::iterator inFace = pitEntry.m_incoming.find (incomingFace);
456 CcnxPitEntryOutgoingFaceContainer::type::iterator outFace = pitEntry.m_outgoing.find (incomingFace);
457
Alexander Afanasyev0a61c342011-12-06 12:48:55 -0800458 bool isRetransmitted = false;
459
Alexander Afanasyeva46844b2011-11-21 19:13:26 -0800460 if (inFace != pitEntry.m_incoming.end ())
Ilya Moiseenko172763c2011-10-28 13:21:53 -0700461 {
Alexander Afanasyeva46844b2011-11-21 19:13:26 -0800462 // CcnxPitEntryIncomingFace.m_arrivalTime keeps track arrival time of the first packet... why?
Alexander Afanasyev0a61c342011-12-06 12:48:55 -0800463
464 isRetransmitted = true;
Alexander Afanasyeva46844b2011-11-21 19:13:26 -0800465 // this is almost definitely a retransmission. But should we trust the user on that?
466 }
Ilya Moiseenko172763c2011-10-28 13:21:53 -0700467 else
468 {
Alexander Afanasyeva5bbe0e2011-11-22 17:28:39 -0800469 m_pit->modify (m_pit->iterator_to (pitEntry),
470 ll::var(inFace) = ll::bind (&CcnxPitEntry::AddIncoming, ll::_1, incomingFace));
Alexander Afanasyeva46844b2011-11-21 19:13:26 -0800471 }
472
Alexander Afanasyev0a61c342011-12-06 12:48:55 -0800473 // update PIT entry lifetime
474 m_pit->modify (m_pit->iterator_to (pitEntry),
475 ll::bind (&CcnxPitEntry::UpdateLifetime, ll::_1,
476 header->GetInterestLifetime ()));
477
Alexander Afanasyeva46844b2011-11-21 19:13:26 -0800478 if (outFace != pitEntry.m_outgoing.end ())
479 {
480 // got a non-duplicate interest from the face we have sent interest to
481 // Probably, there is no point in waiting data from that face... Not sure yet
482
483 // If we're expecting data from the interface we got the interest from ("producer" asks us for "his own" data)
484 // Mark interface YELLOW, but keep a small hope that data will come eventually.
485
486 // ?? not sure if we need to do that ?? ...
487
Alexander Afanasyev07827182011-12-13 01:07:32 -0800488 m_fib->m_fib.modify(m_fib->m_fib.iterator_to (pitEntry.m_fibEntry),
489 ll::bind (&CcnxFibEntry::UpdateStatus,
490 ll::_1, incomingFace, CcnxFibFaceMetric::NDN_FIB_YELLOW));
Alexander Afanasyeva46844b2011-11-21 19:13:26 -0800491 }
Alexander Afanasyeva46844b2011-11-21 19:13:26 -0800492
Alexander Afanasyev0a61c342011-12-06 12:48:55 -0800493 if (!isRetransmitted &&
494 pitEntry.AreTherePromisingOutgoingFacesExcept (incomingFace))
Alexander Afanasyeva7a2b8b2011-11-28 18:19:09 -0800495 { // Suppress this interest if we're still expecting data from some other face
496
Alexander Afanasyeva46844b2011-11-21 19:13:26 -0800497 // We are already expecting data later in future. Suppress the interest
Ilya Moiseenko816de832011-12-15 16:32:24 -0800498 m_droppedInterestsTrace (header, NDN_SUPPRESSED_INTEREST, m_node->GetObject<Ccnx> (), incomingFace);
Alexander Afanasyeva7a2b8b2011-11-28 18:19:09 -0800499 return;
Alexander Afanasyeva46844b2011-11-21 19:13:26 -0800500 }
Alexander Afanasyeva7a2b8b2011-11-28 18:19:09 -0800501
Alexander Afanasyeva46844b2011-11-21 19:13:26 -0800502 /////////////////////////////////////////////////////////////////////
503 // Propagate
504 /////////////////////////////////////////////////////////////////////
505
506 NS_ASSERT_MSG (m_forwardingStrategy != 0, "Need a forwarding protocol object to process packets");
507
508 bool propagated = m_forwardingStrategy->
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -0800509 PropagateInterest (pitEntry, incomingFace, header, packet);
Alexander Afanasyeva46844b2011-11-21 19:13:26 -0800510
Alexander Afanasyev0a61c342011-12-06 12:48:55 -0800511 if (isRetransmitted) //give another chance if retransmitted
512 {
513 // increase max number of allowed retransmissions
514 m_pit->modify (m_pit->iterator_to (pitEntry),
515 ll::bind (&CcnxPitEntry::IncreaseAllowedRetxCount, ll::_1));
516
517 // try again
518 propagated = m_forwardingStrategy->
519 PropagateInterest (pitEntry, incomingFace, header, packet);
520 }
521
Alexander Afanasyeva46844b2011-11-21 19:13:26 -0800522 // ForwardingStrategy will try its best to forward packet to at least one interface.
523 // If no interests was propagated, then there is not other option for forwarding or
524 // ForwardingStrategy failed to find it.
Alexander Afanasyeve67a97f2011-11-29 14:28:59 -0800525 if (!propagated)
Alexander Afanasyeva7a2b8b2011-11-28 18:19:09 -0800526 GiveUpInterest (pitEntry, header);
Alexander Afanasyevc74a6022011-08-15 20:01:35 -0700527}
528
Alexander Afanasyev9d313d42011-11-25 13:36:15 -0800529void
530CcnxL3Protocol::GiveUpInterest (const CcnxPitEntry &pitEntry,
531 Ptr<CcnxInterestHeader> header)
532{
533 Ptr<Packet> packet = Create<Packet> ();
534 header->SetNack (CcnxInterestHeader::NACK_GIVEUP_PIT);
535 packet->AddHeader (*header);
536
537 BOOST_FOREACH (const CcnxPitEntryIncomingFace &incoming, pitEntry.m_incoming)
538 {
539 incoming.m_face->Send (packet->Copy ());
540
Ilya Moiseenko816de832011-12-15 16:32:24 -0800541 //m_droppedInterestsTrace (header, DROP_CONGESTION,
542 // m_node->GetObject<Ccnx> (), incomingFace);
Alexander Afanasyev9d313d42011-11-25 13:36:15 -0800543 }
544 // All incoming interests cannot be satisfied. Remove them
545 m_pit->modify (m_pit->iterator_to (pitEntry),
546 ll::bind (&CcnxPitEntry::ClearIncoming, ll::_1));
547
548 // Set pruning timout on PIT entry (instead of deleting the record)
549 m_pit->modify (m_pit->iterator_to (pitEntry),
550 ll::bind (&CcnxPitEntry::SetExpireTime, ll::_1,
551 Simulator::Now () + m_pit->GetPitEntryPruningTimeout ()));
552}
553
554
Alexander Afanasyevc74a6022011-08-15 20:01:35 -0700555// Processing ContentObjects
Alexander Afanasyev19426ef2011-11-23 20:55:28 -0800556void
557CcnxL3Protocol::OnData (const Ptr<CcnxFace> &incomingFace,
558 Ptr<CcnxContentObjectHeader> &header,
559 Ptr<Packet> &payload,
560 const Ptr<const Packet> &packet)
Alexander Afanasyevc74a6022011-08-15 20:01:35 -0700561{
Ilya Moiseenko172763c2011-10-28 13:21:53 -0700562
Alexander Afanasyeva5bbe0e2011-11-22 17:28:39 -0800563 NS_LOG_FUNCTION (incomingFace << header << payload << packet);
Ilya Moiseenko816de832011-12-15 16:32:24 -0800564 m_receivedDataTrace (header, payload, m_node->GetObject<Ccnx> (), incomingFace);
Alexander Afanasyevc74a6022011-08-15 20:01:35 -0700565
Alexander Afanasyev78cf0c92011-09-01 19:57:14 -0700566 // 1. Lookup PIT entry
567 try
568 {
Alexander Afanasyevcf133f02011-09-06 12:13:48 -0700569 const CcnxPitEntry &pitEntry = m_pit->Lookup (*header);
Alexander Afanasyev78cf0c92011-09-01 19:57:14 -0700570
571 // Note that with MultiIndex we need to modify entries indirectly
Alexander Afanasyevc74a6022011-08-15 20:01:35 -0700572
Alexander Afanasyeva46844b2011-11-21 19:13:26 -0800573 CcnxPitEntryOutgoingFaceContainer::type::iterator out = pitEntry.m_outgoing.find (incomingFace);
Alexander Afanasyev78cf0c92011-09-01 19:57:14 -0700574
575 // If we have sent interest for this data via this face, then update stats.
576 if (out != pitEntry.m_outgoing.end ())
577 {
Alexander Afanasyev07827182011-12-13 01:07:32 -0800578 m_fib->m_fib.modify (m_fib->m_fib.iterator_to (pitEntry.m_fibEntry),
579 ll::bind (&CcnxFibEntry::UpdateFaceRtt,
580 ll::_1,
581 incomingFace,
582 Simulator::Now () - out->m_sendTime));
Alexander Afanasyev78cf0c92011-09-01 19:57:14 -0700583 }
584 else
585 {
Alexander Afanasyeva46844b2011-11-21 19:13:26 -0800586 // Unsolicited data, but we're interested in it... should we get it?
587 // Potential hole for attacks
588
589 NS_LOG_ERROR ("Node "<< m_node->GetId() <<
590 ". PIT entry for "<< header->GetName ()<<" is valid, "
Alexander Afanasyev19426ef2011-11-23 20:55:28 -0800591 "but outgoing entry for interface "<< boost::cref(*incomingFace) <<" doesn't exist\n");
Alexander Afanasyeva46844b2011-11-21 19:13:26 -0800592
Alexander Afanasyev19426ef2011-11-23 20:55:28 -0800593 // ignore unsolicited data
594 return;
Alexander Afanasyev78cf0c92011-09-01 19:57:14 -0700595 }
596
Alexander Afanasyev19426ef2011-11-23 20:55:28 -0800597 // Update metric status for the incoming interface in the corresponding FIB entry
Alexander Afanasyev07827182011-12-13 01:07:32 -0800598 m_fib->m_fib.modify (m_fib->m_fib.iterator_to (pitEntry.m_fibEntry),
599 ll::bind (&CcnxFibEntry::UpdateStatus, ll::_1,
600 incomingFace, CcnxFibFaceMetric::NDN_FIB_GREEN));
Alexander Afanasyev19426ef2011-11-23 20:55:28 -0800601
602 // Add or update entry in the content store
603 m_contentStore->Add (header, payload);
604
Alexander Afanasyev78cf0c92011-09-01 19:57:14 -0700605 //satisfy all pending incoming Interests
Alexander Afanasyeva5bbe0e2011-11-22 17:28:39 -0800606 BOOST_FOREACH (const CcnxPitEntryIncomingFace &incoming, pitEntry.m_incoming)
Alexander Afanasyev78cf0c92011-09-01 19:57:14 -0700607 {
Alexander Afanasyeva5bbe0e2011-11-22 17:28:39 -0800608 if (incoming.m_face != incomingFace)
Alexander Afanasyev19426ef2011-11-23 20:55:28 -0800609 incoming.m_face->Send (packet->Copy ());
Alexander Afanasyev78cf0c92011-09-01 19:57:14 -0700610
Alexander Afanasyeva5bbe0e2011-11-22 17:28:39 -0800611 // successfull forwarded data trace
Alexander Afanasyev78cf0c92011-09-01 19:57:14 -0700612 }
Alexander Afanasyeva5bbe0e2011-11-22 17:28:39 -0800613 // All incoming interests are satisfied. Remove them
614 m_pit->modify (m_pit->iterator_to (pitEntry),
615 ll::bind (&CcnxPitEntry::ClearIncoming, ll::_1));
616
Alexander Afanasyeva46844b2011-11-21 19:13:26 -0800617 // Set pruning timout on PIT entry (instead of deleting the record)
618 m_pit->modify (m_pit->iterator_to (pitEntry),
Alexander Afanasyeva5bbe0e2011-11-22 17:28:39 -0800619 ll::bind (&CcnxPitEntry::SetExpireTime, ll::_1,
Alexander Afanasyeva46844b2011-11-21 19:13:26 -0800620 Simulator::Now () + m_pit->GetPitEntryPruningTimeout ()));
Alexander Afanasyev78cf0c92011-09-01 19:57:14 -0700621 }
622 catch (CcnxPitEntryNotFound)
623 {
624 // 2. Drop data packet if PIT entry is not found
625 // (unsolicited data packets should not "poison" content store)
626
627 //drop dulicated or not requested data packet
Ilya Moiseenko816de832011-12-15 16:32:24 -0800628 m_droppedDataTrace (header, payload, NDN_UNSOLICITED_DATA, m_node->GetObject<Ccnx> (), incomingFace);
Alexander Afanasyev78cf0c92011-09-01 19:57:14 -0700629 return; // do not process unsoliced data packets
630 }
631}
Alexander Afanasyev08d984e2011-08-13 19:20:22 -0700632
633void
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -0800634CcnxL3Protocol::SetBucketLeakInterval (Time interval)
Alexander Afanasyev08d984e2011-08-13 19:20:22 -0700635{
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -0800636 m_bucketLeakInterval = interval;
637
638 if (m_bucketLeakEvent.IsRunning ())
639 m_bucketLeakEvent.Cancel ();
Alexander Afanasyev070aa482011-08-20 00:38:25 -0700640
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -0800641 m_bucketLeakEvent = Simulator::Schedule (m_bucketLeakInterval,
642 &CcnxL3Protocol::LeakBuckets, this);
Alexander Afanasyevcf133f02011-09-06 12:13:48 -0700643}
644
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -0800645Time
646CcnxL3Protocol::GetBucketLeakInterval () const
Alexander Afanasyevcf133f02011-09-06 12:13:48 -0700647{
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -0800648 return m_bucketLeakInterval;
Alexander Afanasyev08d984e2011-08-13 19:20:22 -0700649}
650
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -0800651void
Alexander Afanasyev19426ef2011-11-23 20:55:28 -0800652CcnxL3Protocol::LeakBuckets ()
Ilya Moiseenko172763c2011-10-28 13:21:53 -0700653{
Alexander Afanasyev23d2b542011-12-07 18:54:46 -0800654 // NS_LOG_FUNCTION (this);
Alexander Afanasyevc39f0b42011-11-28 12:51:12 -0800655
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -0800656 BOOST_FOREACH (const Ptr<CcnxFace> &face, m_faces)
657 {
658 face->LeakBucket (m_bucketLeakInterval);
659 }
660
661 m_bucketLeakEvent = Simulator::Schedule (m_bucketLeakInterval,
Alexander Afanasyevb5703a92011-11-25 16:46:15 -0800662 &CcnxL3Protocol::LeakBuckets,
663 this);
Ilya Moiseenko172763c2011-10-28 13:21:53 -0700664}
Ilya Moiseenkod83eb0d2011-11-16 15:23:46 -0800665
Alexander Afanasyev08d984e2011-08-13 19:20:22 -0700666} //namespace ns3