blob: e178d18de706a1d02e9678e2f03a64b31cae4a06 [file] [log] [blame]
/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil -*- */
/*
* Copyright (c) 2011 UCLA
*
* 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>
* Ilya Moiseenko <iliamo@cs.ucla.edu>
*/
#include "ns3/assert.h"
#include "ns3/log.h"
#include "ns3/object.h"
#include "ns3/names.h"
#include "ns3/packet-socket-factory.h"
#include "ns3/config.h"
#include "ns3/simulator.h"
#include "ns3/string.h"
#include "ns3/net-device.h"
#include "ns3/callback.h"
#include "ns3/node.h"
#include "ns3/core-config.h"
#include "ns3/point-to-point-net-device.h"
#include "ns3/point-to-point-helper.h"
#include "../model/ccnx-net-device-face.h"
#include "../model/ccnx-l3-protocol.h"
#include "ns3/ccnx-forwarding-strategy.h"
#include "ns3/ccnx-fib.h"
#include "ns3/ccnx-pit.h"
#include "ns3/ccnx-name-components.h"
#include "ns3/ccnx-content-store.h"
#include "ns3/node-list.h"
// #include "ns3/loopback-net-device.h"
#include "ns3/data-rate.h"
#include "ccnx-face-container.h"
#include "ccnx-stack-helper.h"
#include <limits>
#include <map>
#include <boost/foreach.hpp>
#include <boost/lexical_cast.hpp>
NS_LOG_COMPONENT_DEFINE ("CcnxStackHelper");
namespace ns3 {
CcnxStackHelper::CcnxStackHelper ()
: m_limitsEnabled (false)
, m_needSetDefaultRoutes (false)
{
m_ccnxFactory. SetTypeId ("ns3::CcnxL3Protocol");
m_strategyFactory. SetTypeId ("ns3::ndnSIM::Flooding");
m_contentStoreFactory.SetTypeId ("ns3::CcnxContentStoreLru");
m_fibFactory. SetTypeId ("ns3::CcnxFib");
m_pitFactory. SetTypeId ("ns3::CcnxPit");
}
CcnxStackHelper::~CcnxStackHelper ()
{
}
void
CcnxStackHelper::SetCcnxAttributes (const std::string &attr1, const std::string &value1,
const std::string &attr2, const std::string &value2,
const std::string &attr3, const std::string &value3,
const std::string &attr4, const std::string &value4)
{
if (attr1 != "")
m_ccnxFactory.Set (attr1, StringValue (value1));
if (attr2 != "")
m_ccnxFactory.Set (attr2, StringValue (value2));
if (attr3 != "")
m_ccnxFactory.Set (attr3, StringValue (value3));
if (attr4 != "")
m_ccnxFactory.Set (attr4, StringValue (value4));
}
void
CcnxStackHelper::SetForwardingStrategy (const std::string &strategy,
const std::string &attr1, const std::string &value1,
const std::string &attr2, const std::string &value2,
const std::string &attr3, const std::string &value3,
const std::string &attr4, const std::string &value4)
{
m_strategyFactory.SetTypeId (strategy);
if (attr1 != "")
m_strategyFactory.Set (attr1, StringValue (value1));
if (attr2 != "")
m_strategyFactory.Set (attr2, StringValue (value2));
if (attr3 != "")
m_strategyFactory.Set (attr3, StringValue (value3));
if (attr4 != "")
m_strategyFactory.Set (attr4, StringValue (value4));
}
void
CcnxStackHelper::SetContentStore (const std::string &contentStore,
const std::string &attr1, const std::string &value1,
const std::string &attr2, const std::string &value2,
const std::string &attr3, const std::string &value3,
const std::string &attr4, const std::string &value4)
{
m_contentStoreFactory.SetTypeId (contentStore);
if (attr1 != "")
m_contentStoreFactory.Set (attr1, StringValue (value1));
if (attr2 != "")
m_contentStoreFactory.Set (attr2, StringValue (value2));
if (attr3 != "")
m_contentStoreFactory.Set (attr3, StringValue (value3));
if (attr4 != "")
m_contentStoreFactory.Set (attr4, StringValue (value4));
}
void
CcnxStackHelper::SetPit (const std::string &pitClass,
const std::string &attr1, const std::string &value1,
const std::string &attr2, const std::string &value2,
const std::string &attr3, const std::string &value3,
const std::string &attr4, const std::string &value4)
{
m_pitFactory.SetTypeId (pitClass);
if (attr1 != "")
m_pitFactory.Set (attr1, StringValue (value1));
if (attr2 != "")
m_pitFactory.Set (attr2, StringValue (value2));
if (attr3 != "")
m_pitFactory.Set (attr3, StringValue (value3));
if (attr4 != "")
m_pitFactory.Set (attr4, StringValue (value4));
}
void
CcnxStackHelper::SetFib (const std::string &fibClass,
const std::string &attr1, const std::string &value1,
const std::string &attr2, const std::string &value2,
const std::string &attr3, const std::string &value3,
const std::string &attr4, const std::string &value4)
{
m_fibFactory.SetTypeId (fibClass);
if (attr1 != "")
m_fibFactory.Set (attr1, StringValue (value1));
if (attr2 != "")
m_fibFactory.Set (attr2, StringValue (value2));
if (attr3 != "")
m_fibFactory.Set (attr3, StringValue (value3));
if (attr4 != "")
m_fibFactory.Set (attr4, StringValue (value4));
}
void
CcnxStackHelper::SetDefaultRoutes (bool needSet)
{
NS_LOG_FUNCTION (this << needSet);
m_needSetDefaultRoutes = needSet;
}
void
CcnxStackHelper::EnableLimits (bool enable/* = true*/,
Time avgRtt/*=Seconds(0.1)*/,
uint32_t avgContentObject/*=1100*/,
uint32_t avgInterest/*=40*/)
{
NS_LOG_INFO ("EnableLimits: " << enable);
m_limitsEnabled = enable;
m_avgRtt = avgRtt;
m_avgContentObjectSize = avgContentObject;
m_avgInterestSize = avgInterest;
}
Ptr<CcnxFaceContainer>
CcnxStackHelper::Install (NodeContainer c) const
{
Ptr<CcnxFaceContainer> faces = Create<CcnxFaceContainer> ();
for (NodeContainer::Iterator i = c.Begin (); i != c.End (); ++i)
{
faces->AddAll (Install (*i));
}
return faces;
}
Ptr<CcnxFaceContainer>
CcnxStackHelper::InstallAll (void) const
{
return Install (NodeContainer::GetGlobal ());
}
Ptr<CcnxFaceContainer>
CcnxStackHelper::Install (Ptr<Node> node) const
{
// NS_ASSERT_MSG (m_forwarding, "SetForwardingHelper() should be set prior calling Install() method");
Ptr<CcnxFaceContainer> faces = Create<CcnxFaceContainer> ();
if (node->GetObject<Ccnx> () != 0)
{
NS_FATAL_ERROR ("CcnxStackHelper::Install (): Installing "
"a CcnxStack to a node with an existing Ccnx object");
return 0;
}
// Create CcnxL3Protocol
Ptr<Ccnx> ccnx = m_ccnxFactory.Create<Ccnx> ();
// Create and aggregate FIB
Ptr<CcnxFib> fib = m_fibFactory.Create<CcnxFib> ();
ccnx->AggregateObject (fib);
// Create and aggregate PIT
ccnx->AggregateObject (m_pitFactory.Create<CcnxPit> ());
// Create and aggregate forwarding strategy
ccnx->AggregateObject (m_strategyFactory.Create<CcnxForwardingStrategy> ());
// Create and aggregate content store
ccnx->AggregateObject (m_contentStoreFactory.Create<CcnxContentStore> ());
// Aggregate CcnxL3Protocol on node
node->AggregateObject (ccnx);
for (uint32_t index=0; index < node->GetNDevices (); index++)
{
Ptr<NetDevice> device = node->GetDevice (index);
// This check does not make sense: LoopbackNetDevice is installed only if IP stack is installed,
// Normally, ndnSIM works without IP stack, so no reason to check
// if (DynamicCast<LoopbackNetDevice> (device) != 0)
// continue; // don't create face for a LoopbackNetDevice
Ptr<CcnxNetDeviceFace> face = CreateObject<CcnxNetDeviceFace> (node, device);
ccnx->AddFace (face);
NS_LOG_LOGIC ("Node " << node->GetId () << ": added CcnxNetDeviceFace as face #" << *face);
if (m_needSetDefaultRoutes)
{
// default route with lowest priority possible
AddRoute (node, "/", face, std::numeric_limits<int32_t>::max ());
}
if (m_limitsEnabled)
{
NS_LOG_INFO ("Limits are enabled");
Ptr<PointToPointNetDevice> p2p = DynamicCast<PointToPointNetDevice> (device);
if (p2p != 0)
{
// Setup bucket filtering
// Assume that we know average data packet size, and this size is equal default size
// Set maximum buckets (averaging over 1 second)
DataRateValue dataRate; device->GetAttribute ("DataRate", dataRate);
NS_LOG_INFO("DataRate for this link is " << dataRate.Get());
double maxInterestPackets = 1.0 * dataRate.Get ().GetBitRate () / 8.0 / (m_avgContentObjectSize + m_avgInterestSize);
NS_LOG_INFO ("Max packets per second: " << maxInterestPackets);
NS_LOG_INFO ("Max burst: " << m_avgRtt.ToDouble (Time::S) * maxInterestPackets);
// Set bucket max to BDP
face->SetBucketMax (m_avgRtt.ToDouble (Time::S) * maxInterestPackets); // number of interests allowed
face->SetBucketLeak (maxInterestPackets);
}
}
face->SetUp ();
faces->Add (face);
}
return faces;
}
Ptr<CcnxFaceContainer>
CcnxStackHelper::Install (std::string nodeName) const
{
Ptr<Node> node = Names::Find<Node> (nodeName);
return Install (node);
}
void
CcnxStackHelper::AddRoute (Ptr<Node> node, std::string prefix, Ptr<CcnxFace> face, int32_t metric)
{
NS_LOG_LOGIC ("[" << node->GetId () << "]$ route add " << prefix << " via " << *face << " metric " << metric);
Ptr<CcnxFib> fib = node->GetObject<CcnxFib> ();
CcnxNameComponentsValue prefixValue;
prefixValue.DeserializeFromString (prefix, MakeCcnxNameComponentsChecker ());
fib->Add (prefixValue.Get (), face, metric);
}
void
CcnxStackHelper::AddRoute (Ptr<Node> node, std::string prefix, uint32_t faceId, int32_t metric)
{
Ptr<Ccnx> ccnx = node->GetObject<Ccnx> ();
NS_ASSERT_MSG (ccnx != 0, "Ccnx stack should be installed on the node");
Ptr<CcnxFace> face = ccnx->GetFace (faceId);
NS_ASSERT_MSG (face != 0, "Face with ID [" << faceId << "] does not exist on node [" << node->GetId () << "]");
AddRoute (node, prefix, face, metric);
}
void
CcnxStackHelper::AddRoute (std::string nodeName, std::string prefix, uint32_t faceId, int32_t metric)
{
Ptr<Node> node = Names::Find<Node> (nodeName);
NS_ASSERT_MSG (node != 0, "Node [" << nodeName << "] does not exist");
Ptr<Ccnx> ccnx = node->GetObject<Ccnx> ();
NS_ASSERT_MSG (ccnx != 0, "Ccnx stack should be installed on the node");
Ptr<CcnxFace> face = ccnx->GetFace (faceId);
NS_ASSERT_MSG (face != 0, "Face with ID [" << faceId << "] does not exist on node [" << nodeName << "]");
AddRoute (node, prefix, face, metric);
}
} // namespace ns3