blob: a4241bc256ae9ea0ce2ed48fd117a63dbd572bd0 [file] [log] [blame]
/* -*- 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: Alexander Afanasyev <alexander.afanasyev@ucla.edu>
*/
#include "ccnx-l3-protocol.h"
#include "ns3/packet.h"
#include "ns3/node.h"
#include "ns3/log.h"
#include "ns3/callback.h"
#include "ns3/uinteger.h"
#include "ns3/trace-source-accessor.h"
#include "ns3/object-vector.h"
#include "ns3/boolean.h"
#include "ns3/ccnx-header-helper.h"
#include "ccnx-face.h"
#include "ccnx-route.h"
#include "ccnx-forwarding-strategy.h"
#include "ccnx-interest-header.h"
#include "ccnx-content-object-header.h"
#include <boost/foreach.hpp>
NS_LOG_COMPONENT_DEFINE ("CcnxL3Protocol");
namespace ns3 {
const uint16_t CcnxL3Protocol::ETHERNET_FRAME_TYPE = 0x7777;
NS_OBJECT_ENSURE_REGISTERED (CcnxL3Protocol);
TypeId
CcnxL3Protocol::GetTypeId (void)
{
static TypeId tid = TypeId ("ns3::CcnxL3Protocol")
.SetParent<Ccnx> ()
.SetGroupName ("Ccnx")
.AddConstructor<CcnxL3Protocol> ()
// .AddTraceSource ("Tx", "Send ccnx packet to outgoing interface.",
// MakeTraceSourceAccessor (&CcnxL3Protocol::m_txTrace))
// .AddTraceSource ("Rx", "Receive ccnx packet from incoming interface.",
// MakeTraceSourceAccessor (&CcnxL3Protocol::m_rxTrace))
// .AddTraceSource ("Drop", "Drop ccnx packet",
// MakeTraceSourceAccessor (&CcnxL3Protocol::m_dropTrace))
// .AddAttribute ("InterfaceList", "The set of Ccnx interfaces associated to this Ccnx stack.",
// ObjectVectorValue (),
// MakeObjectVectorAccessor (&CcnxL3Protocol::m_faces),
// MakeObjectVectorChecker<CcnxFace> ())
// .AddTraceSource ("SendOutgoing", "A newly-generated packet by this node is about to be queued for transmission",
// MakeTraceSourceAccessor (&CcnxL3Protocol::m_sendOutgoingTrace))
;
return tid;
}
CcnxL3Protocol::CcnxL3Protocol()
: m_faceCounter (0)
{
NS_LOG_FUNCTION (this);
m_rit = CreateObject<CcnxRit> ();
m_pit = CreateObject<CcnxPit> ();
m_contentStore = CreateObject<CcnxContentStore> ();
}
CcnxL3Protocol::~CcnxL3Protocol ()
{
NS_LOG_FUNCTION (this);
}
void
CcnxL3Protocol::SetNode (Ptr<Node> node)
{
m_node = node;
m_fib = m_node->GetObject<CcnxFib> ();
NS_ASSERT_MSG (m_fib != 0, "FIB should be created and aggregated to a node before calling Ccnx::SetNode");
m_pit->SetFib (m_fib);
}
/*
* This method is called by AddAgregate and completes the aggregation
* by setting the node in the ccnx stack
*/
void
CcnxL3Protocol::NotifyNewAggregate ()
{
if (m_node == 0)
{
Ptr<Node>node = this->GetObject<Node>();
// verify that it's a valid node and that
// the node has not been set before
if (node != 0)
{
this->SetNode (node);
}
}
Object::NotifyNewAggregate ();
}
void
CcnxL3Protocol::DoDispose (void)
{
NS_LOG_FUNCTION (this);
for (CcnxFaceList::iterator i = m_faces.begin (); i != m_faces.end (); ++i)
{
*i = 0;
}
m_faces.clear ();
m_node = 0;
// m_forwardingStrategy = 0;
Object::DoDispose ();
}
void
CcnxL3Protocol::SetForwardingStrategy (Ptr<CcnxForwardingStrategy> forwardingStrategy)
{
NS_LOG_FUNCTION (this);
m_forwardingStrategy = forwardingStrategy;
// m_forwardingStrategy->SetCcnx (this);
}
Ptr<CcnxForwardingStrategy>
CcnxL3Protocol::GetForwardingStrategy (void) const
{
return m_forwardingStrategy;
}
uint32_t
CcnxL3Protocol::AddFace (const Ptr<CcnxFace> &face)
{
NS_LOG_FUNCTION (this << &face);
face->SetNode (m_node);
face->SetId (m_faceCounter); // sets a unique ID of the face. This ID serves only informational purposes
// ask face to register in lower-layer stack
face->RegisterProtocolHandler (MakeCallback (&CcnxL3Protocol::Receive, this));
m_faces.push_back (face);
m_faceCounter ++;
return face->GetId ();
}
void
CcnxL3Protocol::RemoveFace (Ptr<CcnxFace> face)
{
// ask face to register in lower-layer stack
face->RegisterProtocolHandler (MakeNullCallback<void,const Ptr<CcnxFace>&,const Ptr<const Packet>&> ());
CcnxFaceList::iterator face_it = find (m_faces.begin(), m_faces.end(), face);
NS_ASSERT_MSG (face_it != m_faces.end (), "Attempt to remove face that doesn't exist");
m_faces.erase (face_it);
}
Ptr<CcnxFace>
CcnxL3Protocol::GetFace (uint32_t index) const
{
BOOST_FOREACH (const Ptr<CcnxFace> &face, m_faces) // this function is not supposed to be called often, so linear search is fine
{
if (face->GetId () == index)
return face;
}
return 0;
}
uint32_t
CcnxL3Protocol::GetNFaces (void) const
{
return m_faces.size ();
}
void
CcnxL3Protocol::TransmittedDataTrace (Ptr<Packet> packet,
ContentObjectSource type,
Ptr<Ccnx> ccnx, Ptr<const CcnxFace> face)
{
// a "small" inefficiency for logging purposes
Ptr<CcnxContentObjectHeader> header = Create<CcnxContentObjectHeader> ();
static CcnxContentObjectTail tail;
packet->RemoveHeader (*header);
packet->RemoveTrailer (tail);
m_transmittedDataTrace (header, packet/*payload*/, type, ccnx, face);
packet->AddHeader (*header);
packet->AddTrailer (tail);
}
// Callback from lower layer
void
CcnxL3Protocol::Receive (const Ptr<CcnxFace> &face, const Ptr<const Packet> &p)
{
if (!face->IsUp ())
{
NS_LOG_LOGIC ("Dropping received packet -- interface is down");
// m_dropTrace (p, INTERFACE_DOWN, m_node->GetObject<Ccnx> ()/*this*/, face);
return;
}
NS_LOG_LOGIC ("Packet from face " << *face << " received on node " << m_node->GetId ());
Ptr<Packet> packet = p->Copy (); // give upper layers a rw copy of the packet
try
{
CcnxHeaderHelper::Type type = CcnxHeaderHelper::GetCcnxHeaderType (p);
switch (type)
{
case CcnxHeaderHelper::INTEREST:
{
Ptr<CcnxInterestHeader> header = Create<CcnxInterestHeader> ();
// Deserialization. Exception may be thrown
packet->RemoveHeader (*header);
NS_ASSERT_MSG (packet->GetSize () == 0, "Payload of Interests should be zero");
OnInterest (face, header, p/*original packet*/);
break;
}
case CcnxHeaderHelper::CONTENT_OBJECT:
{
Ptr<CcnxContentObjectHeader> header = Create<CcnxContentObjectHeader> ();
static CcnxContentObjectTail contentObjectTrailer; //there is no data in this object
// Deserialization. Exception may be thrown
packet->RemoveHeader (*header);
packet->RemoveTrailer (contentObjectTrailer);
OnData (face, header, packet/*payload*/, p/*original packet*/);
break;
}
}
// exception will be thrown if packet is not recognized
}
catch (CcnxUnknownHeaderException)
{
NS_ASSERT_MSG (false, "Unknown CCNx header. Should not happen");
}
}
// Processing Interests
void CcnxL3Protocol::OnInterest (const Ptr<CcnxFace> &incomingFace,
Ptr<CcnxInterestHeader> &header,
const Ptr<const Packet> &packet)
{
NS_LOG_LOGIC ("Receiving interest from " << &incomingFace);
m_receivedInterestsTrace (header, m_node->GetObject<Ccnx> ()/*this*/, incomingFace);
if (m_rit->WasRecentlySatisfied (*header))
{
m_droppedInterestsTrace (header, NDN_DUPLICATE_INTEREST,
m_node->GetObject<Ccnx> ()/*this*/, incomingFace);
// loop?
return;
}
m_rit->SetRecentlySatisfied (*header);
Ptr<Packet> contentObject = m_contentStore->Lookup (header);
if (contentObject != 0)
{
TransmittedDataTrace (contentObject, CACHED,
m_node->GetObject<Ccnx> ()/*this*/, incomingFace);
incomingFace->Send (contentObject);
return;
}
CcnxPitEntry pitEntry = m_pit->Lookup (*header);
CcnxPitEntryIncomingFaceContainer::type::iterator inFace = pitEntry.m_incoming.find (incomingFace);
CcnxPitEntryOutgoingFaceContainer::type::iterator outFace = pitEntry.m_outgoing.find (incomingFace);
// // suppress interest if
// if (pitEntry.m_incoming.size () != 0 && // not a new PIT entry and
// inFace != pitEntry.m_incoming.end ()) // existing entry, but interest received via different face
// {
// m_droppedInterestsTrace (header, NDN_SUPPRESSED_INTEREST,
// m_node->GetObject<Ccnx> ()/*this*/, incomingFace);
// return;
// }
NS_ASSERT_MSG (m_forwardingStrategy != 0, "Need a forwarding protocol object to process packets");
/*bool propagated = */m_forwardingStrategy->
PropagateInterest (incomingFace, header, packet,
MakeCallback (&CcnxL3Protocol::SendInterest, this)
);
// // If interest wasn't propagated further (probably, a limit is reached),
// // prune and delete PIT entry if there are no outstanding interests.
// // Stop processing otherwise.
// if( !propagated && pitEntry.numberOfPromisingInterests()==0 )
// {
// // printf( "Node %d. Pruning after unsuccessful try to forward an interest\n", _node->nodeId );
// BOOST_FOREACH (const CcnxPitEntryIncomingFace face, pitEntry.m_incoming)
// {
// // send prune
// }
// m_pit->erase (m_pit->iterator_to (pitEntry));
// }
}
// Processing ContentObjects
void CcnxL3Protocol::OnData (const Ptr<CcnxFace> &incomingFace,
Ptr<CcnxContentObjectHeader> &header,
Ptr<Packet> &payload,
const Ptr<const Packet> &packet)
{
NS_LOG_LOGIC ("Receiving contentObject from " << &incomingFace);
m_receivedDataTrace (header, payload, m_node->GetObject<Ccnx> ()/*this*/, incomingFace);
// 1. Lookup PIT entry
try
{
const CcnxPitEntry &pitEntry = m_pit->Lookup (*header);
// Note that with MultiIndex we need to modify entries indirectly
// Update metric status for the incoming interface in the corresponding FIB entry
m_fib->modify (m_fib->iterator_to (pitEntry.m_fibEntry),
CcnxFibEntry::UpdateStatus (incomingFace, CcnxFibFaceMetric::NDN_FIB_GREEN));
// Add or update entry in the content store
m_contentStore->Add (header, payload);
CcnxPitEntryOutgoingFaceContainer::type::iterator
out = pitEntry.m_outgoing.find (incomingFace);
// If we have sent interest for this data via this face, then update stats.
if (out != pitEntry.m_outgoing.end ())
{
m_pit->modify (m_pit->iterator_to (pitEntry),
CcnxPitEntry::EstimateRttAndRemoveFace(out, m_fib));
// face will be removed in the above call
}
else
{
NS_LOG_WARN ("Node "<< m_node->GetId() <<
". PIT entry for "<< header->GetName ()<<" is valid, "
"but outgoing entry for interface "<< incomingFace <<" doesn't exist\n");
}
//satisfy all pending incoming Interests
BOOST_FOREACH (const CcnxPitEntryIncomingFace &interest, pitEntry.m_incoming)
{
if (interest.m_face == incomingFace) continue;
// may not work either because of 'const' thing
interest.m_face->Send (packet->Copy ()); // unfortunately, we have to copy packet...
m_transmittedDataTrace (header, payload, FORWARDED, m_node->GetObject<Ccnx> (), interest.m_face);
}
m_pit->modify (m_pit->iterator_to (pitEntry), CcnxPitEntry::ClearIncoming()); // satisfy all incoming interests
if( pitEntry.m_outgoing.size()==0 ) // remove PIT when all outgoing interests are "satisfied"
{
m_pit->erase (m_pit->iterator_to (pitEntry));
}
}
catch (CcnxPitEntryNotFound)
{
// 2. Drop data packet if PIT entry is not found
// (unsolicited data packets should not "poison" content store)
//drop dulicated or not requested data packet
m_droppedDataTrace (header, payload, NDN_UNSOLICITED_DATA, m_node->GetObject<Ccnx> (), incomingFace);
return; // do not process unsoliced data packets
}
}
void
CcnxL3Protocol::SendInterest (const Ptr<CcnxFace> &face,
const Ptr<CcnxInterestHeader> &header,
const Ptr<Packet> &packet)
{
NS_LOG_FUNCTION (this << "packet: " << &packet << ", face: "<< &face);
NS_ASSERT_MSG (face != 0, "Face should never be NULL");
if (face->IsUp ())
{
NS_LOG_LOGIC ("Sending via face " << &face); //
m_transmittedInterestsTrace (header, m_node->GetObject<Ccnx> (), face);
face->Send (packet);
}
else
{
NS_LOG_LOGIC ("Dropping -- outgoing interface is down: " << &face);
m_droppedInterestsTrace (header, INTERFACE_DOWN, m_node->GetObject<Ccnx> (), face);
}
}
void
CcnxL3Protocol::SendContentObject (const Ptr<CcnxFace> &face,
const Ptr<CcnxContentObjectHeader> &header,
const Ptr<Packet> &packet)
{
NS_LOG_FUNCTION (this << "packet: " << &packet << ", face: "<< &face);
NS_ASSERT_MSG (face != 0, "Face should never be NULL");
NS_ASSERT_MSG (false, "Should not be called for now");
if (face->IsUp ())
{
NS_LOG_LOGIC ("Sending via face " << &face); //
// m_txTrace (packet, m_node->GetObject<Ccnx> (), face);
face->Send (packet);
}
else
{
NS_LOG_LOGIC ("Dropping -- outgoing interface is down: " << &face);
// m_dropTrace (packet, INTERFACE_DOWN, m_node->GetObject<Ccnx> (), face);
}
}
} //namespace ns3