blob: 5484fb7dcde30271f923d5547c6313433db7f765 [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 Afanasyev08d984e2011-08-13 19:20:22 -070032
Alexander Afanasyevc74a6022011-08-15 20:01:35 -070033#include "ns3/ccnx-header-helper.h"
34
Alexander Afanasyev45b92d42011-08-14 23:11:38 -070035#include "ccnx-face.h"
Alexander Afanasyevc74a6022011-08-15 20:01:35 -070036#include "ccnx-forwarding-strategy.h"
37#include "ccnx-interest-header.h"
38#include "ccnx-content-object-header.h"
39
Alexander Afanasyev52e9aa92011-11-15 20:23:20 -080040#include "ccnx-net-device-face.h"
41
Alexander Afanasyev56f79ea2011-08-17 23:54:27 -070042#include <boost/foreach.hpp>
Alexander Afanasyeva46844b2011-11-21 19:13:26 -080043#include <boost/lambda/lambda.hpp>
Alexander Afanasyeva5bbe0e2011-11-22 17:28:39 -080044#include <boost/lambda/bind.hpp>
Alexander Afanasyeva46844b2011-11-21 19:13:26 -080045
46using namespace boost::tuples;
Alexander Afanasyeva5bbe0e2011-11-22 17:28:39 -080047namespace ll = boost::lambda;
Alexander Afanasyev08d984e2011-08-13 19:20:22 -070048
49NS_LOG_COMPONENT_DEFINE ("CcnxL3Protocol");
50
51namespace ns3 {
52
Alexander Afanasyev7112f482011-08-17 14:05:57 -070053const uint16_t CcnxL3Protocol::ETHERNET_FRAME_TYPE = 0x7777;
Alexander Afanasyev08d984e2011-08-13 19:20:22 -070054
55NS_OBJECT_ENSURE_REGISTERED (CcnxL3Protocol);
56
57TypeId
58CcnxL3Protocol::GetTypeId (void)
59{
60 static TypeId tid = TypeId ("ns3::CcnxL3Protocol")
61 .SetParent<Ccnx> ()
Alexander Afanasyev070aa482011-08-20 00:38:25 -070062 .SetGroupName ("Ccnx")
Alexander Afanasyev08d984e2011-08-13 19:20:22 -070063 .AddConstructor<CcnxL3Protocol> ()
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -080064 .AddAttribute ("BucketLeakInterval",
65 "Interval to leak buckets",
66 StringValue ("10ms"),
Alexander Afanasyev19426ef2011-11-23 20:55:28 -080067 MakeTimeAccessor (&CcnxL3Protocol::GetBucketLeakInterval,
68 &CcnxL3Protocol::SetBucketLeakInterval),
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -080069 MakeTimeChecker ())
Alexander Afanasyev08d984e2011-08-13 19:20:22 -070070 ;
71 return tid;
72}
73
74CcnxL3Protocol::CcnxL3Protocol()
Alexander Afanasyevab1d5602011-08-17 19:17:18 -070075: m_faceCounter (0)
Alexander Afanasyev08d984e2011-08-13 19:20:22 -070076{
77 NS_LOG_FUNCTION (this);
Alexander Afanasyevcf133f02011-09-06 12:13:48 -070078
Alexander Afanasyevcf133f02011-09-06 12:13:48 -070079 m_pit = CreateObject<CcnxPit> ();
80 m_contentStore = CreateObject<CcnxContentStore> ();
Alexander Afanasyev08d984e2011-08-13 19:20:22 -070081}
82
83CcnxL3Protocol::~CcnxL3Protocol ()
84{
85 NS_LOG_FUNCTION (this);
86}
87
88void
89CcnxL3Protocol::SetNode (Ptr<Node> node)
90{
91 m_node = node;
Alexander Afanasyevc5a23e22011-09-07 00:37:36 -070092 m_fib = m_node->GetObject<CcnxFib> ();
93 NS_ASSERT_MSG (m_fib != 0, "FIB should be created and aggregated to a node before calling Ccnx::SetNode");
94
95 m_pit->SetFib (m_fib);
Alexander Afanasyev08d984e2011-08-13 19:20:22 -070096}
97
98/*
99 * This method is called by AddAgregate and completes the aggregation
100 * by setting the node in the ccnx stack
101 */
102void
103CcnxL3Protocol::NotifyNewAggregate ()
104{
105 if (m_node == 0)
106 {
107 Ptr<Node>node = this->GetObject<Node>();
108 // verify that it's a valid node and that
109 // the node has not been set before
110 if (node != 0)
111 {
112 this->SetNode (node);
113 }
114 }
115 Object::NotifyNewAggregate ();
116}
117
Alexander Afanasyev08d984e2011-08-13 19:20:22 -0700118void
119CcnxL3Protocol::DoDispose (void)
120{
121 NS_LOG_FUNCTION (this);
122
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -0800123 if (m_bucketLeakEvent.IsRunning ())
124 m_bucketLeakEvent.Cancel ();
125
Alexander Afanasyev45b92d42011-08-14 23:11:38 -0700126 for (CcnxFaceList::iterator i = m_faces.begin (); i != m_faces.end (); ++i)
Alexander Afanasyev08d984e2011-08-13 19:20:22 -0700127 {
128 *i = 0;
129 }
Alexander Afanasyev98256102011-08-14 01:00:02 -0700130 m_faces.clear ();
Alexander Afanasyev08d984e2011-08-13 19:20:22 -0700131 m_node = 0;
Alexander Afanasyevd02a5d62011-11-21 11:01:51 -0800132
133 // Force delete on objects
Alexander Afanasyev18252852011-11-21 13:35:31 -0800134 m_forwardingStrategy = 0; // there is a reference to PIT stored in here
Alexander Afanasyevd02a5d62011-11-21 11:01:51 -0800135 m_pit = 0;
136 m_contentStore = 0;
Alexander Afanasyev18252852011-11-21 13:35:31 -0800137 m_fib = 0;
138
Alexander Afanasyevc74a6022011-08-15 20:01:35 -0700139 // m_forwardingStrategy = 0;
Alexander Afanasyev08d984e2011-08-13 19:20:22 -0700140 Object::DoDispose ();
141}
142
Alexander Afanasyeva67e28c2011-08-31 21:16:25 -0700143void
144CcnxL3Protocol::SetForwardingStrategy (Ptr<CcnxForwardingStrategy> forwardingStrategy)
145{
146 NS_LOG_FUNCTION (this);
147 m_forwardingStrategy = forwardingStrategy;
Alexander Afanasyev19426ef2011-11-23 20:55:28 -0800148 m_forwardingStrategy->SetPit (m_pit);
Alexander Afanasyeva67e28c2011-08-31 21:16:25 -0700149}
150
151Ptr<CcnxForwardingStrategy>
152CcnxL3Protocol::GetForwardingStrategy (void) const
153{
154 return m_forwardingStrategy;
155}
156
Alexander Afanasyev08d984e2011-08-13 19:20:22 -0700157uint32_t
Alexander Afanasyev7112f482011-08-17 14:05:57 -0700158CcnxL3Protocol::AddFace (const Ptr<CcnxFace> &face)
Alexander Afanasyev08d984e2011-08-13 19:20:22 -0700159{
Alexander Afanasyev56f79ea2011-08-17 23:54:27 -0700160 NS_LOG_FUNCTION (this << &face);
Alexander Afanasyev08d984e2011-08-13 19:20:22 -0700161
Alexander Afanasyevab1d5602011-08-17 19:17:18 -0700162 face->SetId (m_faceCounter); // sets a unique ID of the face. This ID serves only informational purposes
Alexander Afanasyev08d984e2011-08-13 19:20:22 -0700163
Alexander Afanasyeva67e28c2011-08-31 21:16:25 -0700164 // ask face to register in lower-layer stack
Alexander Afanasyev56f79ea2011-08-17 23:54:27 -0700165 face->RegisterProtocolHandler (MakeCallback (&CcnxL3Protocol::Receive, this));
Alexander Afanasyev08d984e2011-08-13 19:20:22 -0700166
Alexander Afanasyev45b92d42011-08-14 23:11:38 -0700167 m_faces.push_back (face);
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -0800168 m_faceCounter++;
Alexander Afanasyev0ab833e2011-08-18 15:49:13 -0700169 return face->GetId ();
Alexander Afanasyev08d984e2011-08-13 19:20:22 -0700170}
171
Alexander Afanasyevc5a23e22011-09-07 00:37:36 -0700172void
173CcnxL3Protocol::RemoveFace (Ptr<CcnxFace> face)
174{
175 // ask face to register in lower-layer stack
176 face->RegisterProtocolHandler (MakeNullCallback<void,const Ptr<CcnxFace>&,const Ptr<const Packet>&> ());
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -0800177
178 // just to be on a safe side. Do the process in two steps
Alexander Afanasyev19426ef2011-11-23 20:55:28 -0800179 std::list<CcnxPitEntryContainer::type::iterator> entriesToRemoves;
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -0800180 BOOST_FOREACH (const CcnxPitEntry &pitEntry, *m_pit)
181 {
182 m_pit->modify (m_pit->iterator_to (pitEntry),
Alexander Afanasyev19426ef2011-11-23 20:55:28 -0800183 ll::bind (&CcnxPitEntry::RemoveAllReferencesToFace, ll::_1, face));
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -0800184
185 // If this face is the only for the associated FIB entry, then FIB entry will be removed soon.
186 // Thus, we have to remove the whole PIT entry
Alexander Afanasyev19426ef2011-11-23 20:55:28 -0800187 if (pitEntry.m_fibEntry.m_faces.size () == 1 &&
188 pitEntry.m_fibEntry.m_faces.begin ()->m_face == face)
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -0800189 {
190 entriesToRemoves.push_back (m_pit->iterator_to (pitEntry));
191 }
192 }
193 BOOST_FOREACH (CcnxPitEntryContainer::type::iterator entry, entriesToRemoves)
194 {
195 m_pit->erase (entry);
196 }
197
Alexander Afanasyevc5a23e22011-09-07 00:37:36 -0700198 CcnxFaceList::iterator face_it = find (m_faces.begin(), m_faces.end(), face);
199 NS_ASSERT_MSG (face_it != m_faces.end (), "Attempt to remove face that doesn't exist");
200 m_faces.erase (face_it);
201}
202
Alexander Afanasyev45b92d42011-08-14 23:11:38 -0700203Ptr<CcnxFace>
Alexander Afanasyev98256102011-08-14 01:00:02 -0700204CcnxL3Protocol::GetFace (uint32_t index) const
Alexander Afanasyev08d984e2011-08-13 19:20:22 -0700205{
Alexander Afanasyev56f79ea2011-08-17 23:54:27 -0700206 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 -0700207 {
Alexander Afanasyev56f79ea2011-08-17 23:54:27 -0700208 if (face->GetId () == index)
209 return face;
Alexander Afanasyev08d984e2011-08-13 19:20:22 -0700210 }
211 return 0;
212}
213
Alexander Afanasyev52e9aa92011-11-15 20:23:20 -0800214Ptr<CcnxFace>
215CcnxL3Protocol::GetFaceByNetDevice (Ptr<NetDevice> netDevice) const
216{
217 BOOST_FOREACH (const Ptr<CcnxFace> &face, m_faces) // this function is not supposed to be called often, so linear search is fine
218 {
219 Ptr<CcnxNetDeviceFace> netDeviceFace = DynamicCast<CcnxNetDeviceFace> (face);
220 if (netDeviceFace == 0) continue;
221
222 if (netDeviceFace->GetNetDevice () == netDevice)
223 return face;
224 }
225 return 0;
226}
227
Alexander Afanasyev08d984e2011-08-13 19:20:22 -0700228uint32_t
Alexander Afanasyev98256102011-08-14 01:00:02 -0700229CcnxL3Protocol::GetNFaces (void) const
Alexander Afanasyev08d984e2011-08-13 19:20:22 -0700230{
Alexander Afanasyev98256102011-08-14 01:00:02 -0700231 return m_faces.size ();
Alexander Afanasyev08d984e2011-08-13 19:20:22 -0700232}
233
Alexander Afanasyev98256102011-08-14 01:00:02 -0700234// Callback from lower layer
Alexander Afanasyev08d984e2011-08-13 19:20:22 -0700235void
Alexander Afanasyev0ab833e2011-08-18 15:49:13 -0700236CcnxL3Protocol::Receive (const Ptr<CcnxFace> &face, const Ptr<const Packet> &p)
Alexander Afanasyev08d984e2011-08-13 19:20:22 -0700237{
Alexander Afanasyevc5a23e22011-09-07 00:37:36 -0700238 if (!face->IsUp ())
Alexander Afanasyev070aa482011-08-20 00:38:25 -0700239 {
240 NS_LOG_LOGIC ("Dropping received packet -- interface is down");
Alexander Afanasyev78cf0c92011-09-01 19:57:14 -0700241 // m_dropTrace (p, INTERFACE_DOWN, m_node->GetObject<Ccnx> ()/*this*/, face);
Alexander Afanasyev070aa482011-08-20 00:38:25 -0700242 return;
243 }
Alexander Afanasyevc5a23e22011-09-07 00:37:36 -0700244 NS_LOG_LOGIC ("Packet from face " << *face << " received on node " << m_node->GetId ());
Alexander Afanasyev08d984e2011-08-13 19:20:22 -0700245
Alexander Afanasyev45b92d42011-08-14 23:11:38 -0700246 Ptr<Packet> packet = p->Copy (); // give upper layers a rw copy of the packet
Alexander Afanasyevc74a6022011-08-15 20:01:35 -0700247 try
248 {
Alexander Afanasyevc5a23e22011-09-07 00:37:36 -0700249 CcnxHeaderHelper::Type type = CcnxHeaderHelper::GetCcnxHeaderType (p);
Alexander Afanasyeva67e28c2011-08-31 21:16:25 -0700250 switch (type)
251 {
252 case CcnxHeaderHelper::INTEREST:
253 {
254 Ptr<CcnxInterestHeader> header = Create<CcnxInterestHeader> ();
Alexander Afanasyev78cf0c92011-09-01 19:57:14 -0700255
256 // Deserialization. Exception may be thrown
257 packet->RemoveHeader (*header);
258 NS_ASSERT_MSG (packet->GetSize () == 0, "Payload of Interests should be zero");
Alexander Afanasyeva46844b2011-11-21 19:13:26 -0800259
260 if (header->GetNack () > 0)
261 OnNack (face, header, p/*original packet*/);
262 else
263 OnInterest (face, header, p/*original packet*/);
Alexander Afanasyeva67e28c2011-08-31 21:16:25 -0700264 break;
265 }
266 case CcnxHeaderHelper::CONTENT_OBJECT:
267 {
268 Ptr<CcnxContentObjectHeader> header = Create<CcnxContentObjectHeader> ();
Alexander Afanasyev78cf0c92011-09-01 19:57:14 -0700269
270 static CcnxContentObjectTail contentObjectTrailer; //there is no data in this object
271
272 // Deserialization. Exception may be thrown
273 packet->RemoveHeader (*header);
274 packet->RemoveTrailer (contentObjectTrailer);
275
276 OnData (face, header, packet/*payload*/, p/*original packet*/);
Alexander Afanasyeva67e28c2011-08-31 21:16:25 -0700277 break;
278 }
279 }
280
281 // exception will be thrown if packet is not recognized
Alexander Afanasyevc74a6022011-08-15 20:01:35 -0700282 }
283 catch (CcnxUnknownHeaderException)
284 {
285 NS_ASSERT_MSG (false, "Unknown CCNx header. Should not happen");
286 }
Alexander Afanasyev98256102011-08-14 01:00:02 -0700287}
Alexander Afanasyev08d984e2011-08-13 19:20:22 -0700288
Alexander Afanasyeva46844b2011-11-21 19:13:26 -0800289void
Alexander Afanasyev9d313d42011-11-25 13:36:15 -0800290CcnxL3Protocol::OnNack (const Ptr<CcnxFace> &incomingFace,
Alexander Afanasyeva46844b2011-11-21 19:13:26 -0800291 Ptr<CcnxInterestHeader> &header,
Alexander Afanasyev9d313d42011-11-25 13:36:15 -0800292 const Ptr<const Packet> &packet)
Alexander Afanasyeva46844b2011-11-21 19:13:26 -0800293{
Alexander Afanasyev9d313d42011-11-25 13:36:15 -0800294 NS_LOG_FUNCTION (incomingFace << header << packet);
Alexander Afanasyeva46844b2011-11-21 19:13:26 -0800295
Alexander Afanasyev9d313d42011-11-25 13:36:15 -0800296 tuple<const CcnxPitEntry&,bool,bool> ret = m_pit->Lookup (*header);
297 CcnxPitEntry const& pitEntry = ret.get<0> ();
298 // bool isNew = ret.get<1> ();
299 bool isDuplicated = ret.get<2> ();
300
301 NS_ASSERT_MSG (isDuplicated,
302 "NACK should be a duplicated interest");
Alexander Afanasyeva46844b2011-11-21 19:13:26 -0800303
Alexander Afanasyev9d313d42011-11-25 13:36:15 -0800304 // CcnxPitEntryIncomingFaceContainer::type::iterator inFace = pitEntry.m_incoming.find (incomingFace);
305 CcnxPitEntryOutgoingFaceContainer::type::iterator outFace = pitEntry.m_outgoing.find (incomingFace);
Alexander Afanasyeva46844b2011-11-21 19:13:26 -0800306
Alexander Afanasyev9d313d42011-11-25 13:36:15 -0800307 NS_ASSERT_MSG (outFace != pitEntry.m_outgoing.end (),
308 "Outgoing entry should exist");
309
310 outFace->m_face->LeakBucketByOnePacket ();
Alexander Afanasyev5a595072011-11-25 14:49:07 -0800311 m_pit->modify (m_pit->iterator_to (pitEntry),
312 ll::bind (&CcnxPitEntry::SetWaitingInVain, ll::_1, outFace));
Alexander Afanasyeva46844b2011-11-21 19:13:26 -0800313
Alexander Afanasyev9d313d42011-11-25 13:36:15 -0800314 // m_droppedInterestsTrace (header, DROP_CONGESTION, m_node->GetObject<Ccnx> (), incomingFace);
Alexander Afanasyeva46844b2011-11-21 19:13:26 -0800315
Alexander Afanasyev9d313d42011-11-25 13:36:15 -0800316 // If NACK is NACK_GIVEUP_PIT, then neighbor gave up trying to and removed it's PIT entry.
317 // So, if we had an incoming entry to this neighbor, then we can remove it now
Alexander Afanasyeva46844b2011-11-21 19:13:26 -0800318
Alexander Afanasyev9d313d42011-11-25 13:36:15 -0800319 if (header->GetNack () == CcnxInterestHeader::NACK_GIVEUP_PIT)
320 {
321 m_pit->modify (m_pit->iterator_to (pitEntry),
322 ll::bind (&CcnxPitEntry::RemoveIncoming, ll::_1, incomingFace));
323 }
Alexander Afanasyeva46844b2011-11-21 19:13:26 -0800324
Alexander Afanasyev9d313d42011-11-25 13:36:15 -0800325 m_fib->modify(m_fib->iterator_to (pitEntry.m_fibEntry),
326 ll::bind (&CcnxFibEntry::UpdateStatus,
327 ll::_1, incomingFace, CcnxFibFaceMetric::NDN_FIB_YELLOW));
328
329 NS_ASSERT_MSG (m_forwardingStrategy != 0, "Need a forwarding protocol object to process packets");
Alexander Afanasyeva46844b2011-11-21 19:13:26 -0800330
Alexander Afanasyev9d313d42011-11-25 13:36:15 -0800331 Ptr<Packet> nonNackInterest = Create<Packet> ();
332 header->SetNack (CcnxInterestHeader::NORMAL_INTEREST);
333 nonNackInterest->AddHeader (*header);
334
335 bool propagated = m_forwardingStrategy->
336 PropagateInterest (pitEntry, incomingFace, header, nonNackInterest);
337
338 // ForwardingStrategy will try its best to forward packet to at least one interface.
339 // If no interests was propagated, then there is not other option for forwarding or
340 // ForwardingStrategy failed to find it.
Alexander Afanasyev5a595072011-11-25 14:49:07 -0800341 if (!propagated && pitEntry.AreAllOutgoingInVain ())
342 GiveUpInterest (pitEntry, header);
Alexander Afanasyeva46844b2011-11-21 19:13:26 -0800343}
344
Alexander Afanasyevc74a6022011-08-15 20:01:35 -0700345// Processing Interests
Alexander Afanasyeva46844b2011-11-21 19:13:26 -0800346//
347// !!! Key point.
348// !!! All interests should be answerred!!! Either later with data, immediately with data, or immediately with NACK
Alexander Afanasyeva67e28c2011-08-31 21:16:25 -0700349void CcnxL3Protocol::OnInterest (const Ptr<CcnxFace> &incomingFace,
350 Ptr<CcnxInterestHeader> &header,
Alexander Afanasyev78cf0c92011-09-01 19:57:14 -0700351 const Ptr<const Packet> &packet)
Alexander Afanasyev98256102011-08-14 01:00:02 -0700352{
Alexander Afanasyeva46844b2011-11-21 19:13:26 -0800353 NS_LOG_FUNCTION (incomingFace << header << packet);
354 // m_receivedInterestsTrace (header, m_node->GetObject<Ccnx> (), incomingFace);
Alexander Afanasyevc74a6022011-08-15 20:01:35 -0700355
Alexander Afanasyeva46844b2011-11-21 19:13:26 -0800356 // Lookup of Pit (and associated Fib) entry for this Interest
Alexander Afanasyeva5bbe0e2011-11-22 17:28:39 -0800357 tuple<const CcnxPitEntry&,bool,bool> ret = m_pit->Lookup (*header);
358 CcnxPitEntry const& pitEntry = ret.get<0> ();
359 // bool isNew = ret.get<1> ();
360 bool isDuplicated = ret.get<2> ();
Ilya Moiseenkod83eb0d2011-11-16 15:23:46 -0800361
Alexander Afanasyeva46844b2011-11-21 19:13:26 -0800362 if (isDuplicated)
Ilya Moiseenko172763c2011-10-28 13:21:53 -0700363 {
Alexander Afanasyeva46844b2011-11-21 19:13:26 -0800364 /**
365 * This condition will handle "routing" loops and also recently satisfied interests.
366 * Every time interest is satisfied, PIT entry (with empty incoming and outgoing faces)
367 * is kept for another small chunk of time.
368 */
Ilya Moiseenko172763c2011-10-28 13:21:53 -0700369
Alexander Afanasyeva46844b2011-11-21 19:13:26 -0800370 // //Trace duplicate interest
371 // m_droppedInterestsTrace (header, NDN_DUPLICATE_INTEREST, m_node->GetObject<Ccnx> (), incomingFace);
Ilya Moiseenko172763c2011-10-28 13:21:53 -0700372
Alexander Afanasyeva46844b2011-11-21 19:13:26 -0800373 header->SetNack (CcnxInterestHeader::NACK_LOOP);
374 Ptr<Packet> packet = Create<Packet> ();
375 packet->AddHeader (*header);
Ilya Moiseenko172763c2011-10-28 13:21:53 -0700376
Alexander Afanasyev19426ef2011-11-23 20:55:28 -0800377 incomingFace->Send (packet);
Ilya Moiseenko172763c2011-10-28 13:21:53 -0700378
Alexander Afanasyeva46844b2011-11-21 19:13:26 -0800379 // //Trace duplicate interest
380 // m_droppedInterestsTrace (header, NDN_DUPLICATE_INTEREST, m_node->GetObject<Ccnx> (), incomingFace);
Alexander Afanasyevcf133f02011-09-06 12:13:48 -0700381 return;
382 }
Alexander Afanasyeva46844b2011-11-21 19:13:26 -0800383
384 Ptr<Packet> contentObject;
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -0800385 Ptr<const CcnxContentObjectHeader> contentObjectHeader; // unused for now
Alexander Afanasyeva46844b2011-11-21 19:13:26 -0800386 tie (contentObject, contentObjectHeader) = m_contentStore->Lookup (header);
387 if (contentObject != 0)
388 {
Alexander Afanasyeva46844b2011-11-21 19:13:26 -0800389 NS_ASSERT (contentObjectHeader != 0);
390
391 NS_LOG_LOGIC("Found in cache");
392
393 // TransmittedDataTrace (contentObject, CACHED,
394 // m_node->GetObject<Ccnx> (), incomingFace);
Alexander Afanasyev19426ef2011-11-23 20:55:28 -0800395 incomingFace->Send (contentObject);
Alexander Afanasyeva46844b2011-11-21 19:13:26 -0800396
397 // Set pruning timout on PIT entry (instead of deleting the record)
398 m_pit->modify (m_pit->iterator_to (pitEntry),
Alexander Afanasyeva5bbe0e2011-11-22 17:28:39 -0800399 bind (&CcnxPitEntry::SetExpireTime, ll::_1,
400 Simulator::Now () + m_pit->GetPitEntryPruningTimeout ()));
Alexander Afanasyeva46844b2011-11-21 19:13:26 -0800401 return;
402 }
403
404 // \todo Detect retransmissions. Not yet sure how...
Alexander Afanasyev070aa482011-08-20 00:38:25 -0700405
Ilya Moiseenko172763c2011-10-28 13:21:53 -0700406 // Data is not in cache
Alexander Afanasyeva46844b2011-11-21 19:13:26 -0800407 CcnxPitEntryIncomingFaceContainer::type::iterator inFace = pitEntry.m_incoming.find (incomingFace);
408 CcnxPitEntryOutgoingFaceContainer::type::iterator outFace = pitEntry.m_outgoing.find (incomingFace);
409
410 if (inFace != pitEntry.m_incoming.end ())
Ilya Moiseenko172763c2011-10-28 13:21:53 -0700411 {
Alexander Afanasyeva46844b2011-11-21 19:13:26 -0800412 // CcnxPitEntryIncomingFace.m_arrivalTime keeps track arrival time of the first packet... why?
Ilya Moiseenko172763c2011-10-28 13:21:53 -0700413
Alexander Afanasyeva46844b2011-11-21 19:13:26 -0800414 // this is almost definitely a retransmission. But should we trust the user on that?
415 }
Ilya Moiseenko172763c2011-10-28 13:21:53 -0700416 else
417 {
Alexander Afanasyeva5bbe0e2011-11-22 17:28:39 -0800418 m_pit->modify (m_pit->iterator_to (pitEntry),
419 ll::var(inFace) = ll::bind (&CcnxPitEntry::AddIncoming, ll::_1, incomingFace));
Alexander Afanasyeva46844b2011-11-21 19:13:26 -0800420 }
421
422 if (outFace != pitEntry.m_outgoing.end ())
423 {
424 // got a non-duplicate interest from the face we have sent interest to
425 // Probably, there is no point in waiting data from that face... Not sure yet
426
427 // If we're expecting data from the interface we got the interest from ("producer" asks us for "his own" data)
428 // Mark interface YELLOW, but keep a small hope that data will come eventually.
429
430 // ?? not sure if we need to do that ?? ...
431
432 m_fib->modify(m_fib->iterator_to (pitEntry.m_fibEntry),
Alexander Afanasyeva5bbe0e2011-11-22 17:28:39 -0800433 ll::bind (&CcnxFibEntry::UpdateStatus,
434 ll::_1, incomingFace, CcnxFibFaceMetric::NDN_FIB_YELLOW));
Alexander Afanasyeva46844b2011-11-21 19:13:26 -0800435
436 // suppress?
437 }
Alexander Afanasyeva5bbe0e2011-11-22 17:28:39 -0800438 else if (pitEntry.m_outgoing.size() > 0) // Suppress this interest if we're still expecting data from some other face
Alexander Afanasyeva46844b2011-11-21 19:13:26 -0800439
440 {
441 // We are already expecting data later in future. Suppress the interest
442 // m_droppedInterestsTrace (header, NDN_SUPPRESSED_INTEREST, m_node->GetObject<Ccnx> (), incomingFace);
443 return;
444 }
445
446 /////////////////////////////////////////////////////////////////////
447 // Propagate
448 /////////////////////////////////////////////////////////////////////
449
450 NS_ASSERT_MSG (m_forwardingStrategy != 0, "Need a forwarding protocol object to process packets");
451
452 bool propagated = m_forwardingStrategy->
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -0800453 PropagateInterest (pitEntry, incomingFace, header, packet);
Alexander Afanasyeva46844b2011-11-21 19:13:26 -0800454
455 // ForwardingStrategy will try its best to forward packet to at least one interface.
456 // If no interests was propagated, then there is not other option for forwarding or
457 // ForwardingStrategy failed to find it.
Alexander Afanasyev9d313d42011-11-25 13:36:15 -0800458 if (!propagated) GiveUpInterest (pitEntry, header);
Alexander Afanasyevc74a6022011-08-15 20:01:35 -0700459}
460
Alexander Afanasyev9d313d42011-11-25 13:36:15 -0800461void
462CcnxL3Protocol::GiveUpInterest (const CcnxPitEntry &pitEntry,
463 Ptr<CcnxInterestHeader> header)
464{
465 Ptr<Packet> packet = Create<Packet> ();
466 header->SetNack (CcnxInterestHeader::NACK_GIVEUP_PIT);
467 packet->AddHeader (*header);
468
469 BOOST_FOREACH (const CcnxPitEntryIncomingFace &incoming, pitEntry.m_incoming)
470 {
471 incoming.m_face->Send (packet->Copy ());
472
473 // m_droppedInterestsTrace (header, DROP_CONGESTION,
474 // m_node->GetObject<Ccnx> (), incomingFace);
475 }
476 // All incoming interests cannot be satisfied. Remove them
477 m_pit->modify (m_pit->iterator_to (pitEntry),
478 ll::bind (&CcnxPitEntry::ClearIncoming, ll::_1));
479
480 // Set pruning timout on PIT entry (instead of deleting the record)
481 m_pit->modify (m_pit->iterator_to (pitEntry),
482 ll::bind (&CcnxPitEntry::SetExpireTime, ll::_1,
483 Simulator::Now () + m_pit->GetPitEntryPruningTimeout ()));
484}
485
486
Alexander Afanasyevc74a6022011-08-15 20:01:35 -0700487// Processing ContentObjects
Alexander Afanasyev19426ef2011-11-23 20:55:28 -0800488void
489CcnxL3Protocol::OnData (const Ptr<CcnxFace> &incomingFace,
490 Ptr<CcnxContentObjectHeader> &header,
491 Ptr<Packet> &payload,
492 const Ptr<const Packet> &packet)
Alexander Afanasyevc74a6022011-08-15 20:01:35 -0700493{
Ilya Moiseenko172763c2011-10-28 13:21:53 -0700494
Alexander Afanasyeva5bbe0e2011-11-22 17:28:39 -0800495 NS_LOG_FUNCTION (incomingFace << header << payload << packet);
Alexander Afanasyeva46844b2011-11-21 19:13:26 -0800496 // m_receivedDataTrace (header, payload, m_node->GetObject<Ccnx> ()/*this*/, incomingFace);
Alexander Afanasyevc74a6022011-08-15 20:01:35 -0700497
Alexander Afanasyev78cf0c92011-09-01 19:57:14 -0700498 // 1. Lookup PIT entry
499 try
500 {
Alexander Afanasyevcf133f02011-09-06 12:13:48 -0700501 const CcnxPitEntry &pitEntry = m_pit->Lookup (*header);
Alexander Afanasyev78cf0c92011-09-01 19:57:14 -0700502
503 // Note that with MultiIndex we need to modify entries indirectly
Alexander Afanasyevc74a6022011-08-15 20:01:35 -0700504
Alexander Afanasyeva46844b2011-11-21 19:13:26 -0800505 CcnxPitEntryOutgoingFaceContainer::type::iterator out = pitEntry.m_outgoing.find (incomingFace);
Alexander Afanasyev78cf0c92011-09-01 19:57:14 -0700506
507 // If we have sent interest for this data via this face, then update stats.
508 if (out != pitEntry.m_outgoing.end ())
509 {
Alexander Afanasyeva46844b2011-11-21 19:13:26 -0800510 m_fib->modify (m_fib->iterator_to (pitEntry.m_fibEntry),
Alexander Afanasyeva5bbe0e2011-11-22 17:28:39 -0800511 ll::bind (&CcnxFibEntry::UpdateFaceRtt,
Alexander Afanasyev19426ef2011-11-23 20:55:28 -0800512 ll::_1,
513 incomingFace,
514 Simulator::Now () - out->m_sendTime));
Alexander Afanasyev78cf0c92011-09-01 19:57:14 -0700515 }
516 else
517 {
Alexander Afanasyeva46844b2011-11-21 19:13:26 -0800518 // Unsolicited data, but we're interested in it... should we get it?
519 // Potential hole for attacks
520
521 NS_LOG_ERROR ("Node "<< m_node->GetId() <<
522 ". PIT entry for "<< header->GetName ()<<" is valid, "
Alexander Afanasyev19426ef2011-11-23 20:55:28 -0800523 "but outgoing entry for interface "<< boost::cref(*incomingFace) <<" doesn't exist\n");
Alexander Afanasyeva46844b2011-11-21 19:13:26 -0800524
Alexander Afanasyev19426ef2011-11-23 20:55:28 -0800525 // ignore unsolicited data
526 return;
Alexander Afanasyev78cf0c92011-09-01 19:57:14 -0700527 }
528
Alexander Afanasyev19426ef2011-11-23 20:55:28 -0800529 // Update metric status for the incoming interface in the corresponding FIB entry
530 m_fib->modify (m_fib->iterator_to (pitEntry.m_fibEntry),
531 ll::bind (&CcnxFibEntry::UpdateStatus, ll::_1,
532 incomingFace, CcnxFibFaceMetric::NDN_FIB_GREEN));
533
534 // Add or update entry in the content store
535 m_contentStore->Add (header, payload);
536
Alexander Afanasyev78cf0c92011-09-01 19:57:14 -0700537 //satisfy all pending incoming Interests
Alexander Afanasyeva5bbe0e2011-11-22 17:28:39 -0800538 BOOST_FOREACH (const CcnxPitEntryIncomingFace &incoming, pitEntry.m_incoming)
Alexander Afanasyev78cf0c92011-09-01 19:57:14 -0700539 {
Alexander Afanasyeva5bbe0e2011-11-22 17:28:39 -0800540 if (incoming.m_face != incomingFace)
Alexander Afanasyev19426ef2011-11-23 20:55:28 -0800541 incoming.m_face->Send (packet->Copy ());
Alexander Afanasyev78cf0c92011-09-01 19:57:14 -0700542
Alexander Afanasyeva5bbe0e2011-11-22 17:28:39 -0800543 // successfull forwarded data trace
Alexander Afanasyev78cf0c92011-09-01 19:57:14 -0700544 }
Alexander Afanasyeva5bbe0e2011-11-22 17:28:39 -0800545 // All incoming interests are satisfied. Remove them
546 m_pit->modify (m_pit->iterator_to (pitEntry),
547 ll::bind (&CcnxPitEntry::ClearIncoming, ll::_1));
548
Alexander Afanasyeva46844b2011-11-21 19:13:26 -0800549 // Set pruning timout on PIT entry (instead of deleting the record)
550 m_pit->modify (m_pit->iterator_to (pitEntry),
Alexander Afanasyeva5bbe0e2011-11-22 17:28:39 -0800551 ll::bind (&CcnxPitEntry::SetExpireTime, ll::_1,
Alexander Afanasyeva46844b2011-11-21 19:13:26 -0800552 Simulator::Now () + m_pit->GetPitEntryPruningTimeout ()));
Alexander Afanasyev78cf0c92011-09-01 19:57:14 -0700553 }
554 catch (CcnxPitEntryNotFound)
555 {
556 // 2. Drop data packet if PIT entry is not found
557 // (unsolicited data packets should not "poison" content store)
558
559 //drop dulicated or not requested data packet
Alexander Afanasyeva46844b2011-11-21 19:13:26 -0800560 // m_droppedDataTrace (header, payload, NDN_UNSOLICITED_DATA, m_node->GetObject<Ccnx> (), incomingFace);
Alexander Afanasyev78cf0c92011-09-01 19:57:14 -0700561 return; // do not process unsoliced data packets
562 }
563}
Alexander Afanasyev08d984e2011-08-13 19:20:22 -0700564
565void
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -0800566CcnxL3Protocol::SetBucketLeakInterval (Time interval)
Alexander Afanasyev08d984e2011-08-13 19:20:22 -0700567{
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -0800568 m_bucketLeakInterval = interval;
569
570 if (m_bucketLeakEvent.IsRunning ())
571 m_bucketLeakEvent.Cancel ();
Alexander Afanasyev070aa482011-08-20 00:38:25 -0700572
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -0800573 m_bucketLeakEvent = Simulator::Schedule (m_bucketLeakInterval,
574 &CcnxL3Protocol::LeakBuckets, this);
Alexander Afanasyevcf133f02011-09-06 12:13:48 -0700575}
576
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -0800577Time
578CcnxL3Protocol::GetBucketLeakInterval () const
Alexander Afanasyevcf133f02011-09-06 12:13:48 -0700579{
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -0800580 return m_bucketLeakInterval;
Alexander Afanasyev08d984e2011-08-13 19:20:22 -0700581}
582
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -0800583void
Alexander Afanasyev19426ef2011-11-23 20:55:28 -0800584CcnxL3Protocol::LeakBuckets ()
Ilya Moiseenko172763c2011-10-28 13:21:53 -0700585{
Alexander Afanasyevb5703a92011-11-25 16:46:15 -0800586 NS_LOG_FUNCTION (this);
Alexander Afanasyevc39f0b42011-11-28 12:51:12 -0800587 NS_LOG_ERROR ("Bucket Interval: " << m_bucketLeakInterval.ToDouble(Time::S));
588
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -0800589 BOOST_FOREACH (const Ptr<CcnxFace> &face, m_faces)
590 {
591 face->LeakBucket (m_bucketLeakInterval);
592 }
593
594 m_bucketLeakEvent = Simulator::Schedule (m_bucketLeakInterval,
Alexander Afanasyevb5703a92011-11-25 16:46:15 -0800595 &CcnxL3Protocol::LeakBuckets,
596 this);
Ilya Moiseenko172763c2011-10-28 13:21:53 -0700597}
Ilya Moiseenkod83eb0d2011-11-16 15:23:46 -0800598
Alexander Afanasyev08d984e2011-08-13 19:20:22 -0700599} //namespace ns3