blob: 6cd37459f753e740de2e44549a8d1a576ade10b5 [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>
*/
#ifndef CCNX_STACK_HELPER_H
#define CCNX_STACK_HELPER_H
#include "ns3/packet.h"
#include "ns3/ptr.h"
#include "ns3/object-factory.h"
#include "ns3/nstime.h"
namespace ns3 {
class Node;
class CcnxFaceContainer;
class CcnxFace;
/**
* \ingroup ccnx
* \defgroup ccnx-helpers Helpers
*/
/**
* \ingroup ccnx-helpers
* \brief Adding CCNx functionality to existing Nodes.
*
* This helper enables pcap and ascii tracing of events in the ccnx stack
* associated with a node. This is substantially similar to the tracing that
* happens in device helpers, but the important difference is that, well, there
* is no device. This means that the creation of output file names will change,
* and also the user-visible methods will not reference devices and therefore
* the number of trace enable methods is reduced.
*
* Normally we eschew multiple inheritance, however, the classes
* PcapUserHelperForCcnx and AsciiTraceUserHelperForCcnx are treated as
* "mixins". A mixin is a self-contained class that encapsulates a general
* attribute or a set of functionality that may be of interest to many other
* classes.
*/
class CcnxStackHelper
{
public:
/**
* \brief Create a new CcnxStackHelper with a default NDN_FLOODING forwarding stategy
*/
CcnxStackHelper();
/**
* \brief Destroy the CcnxStackHelper
*/
virtual ~CcnxStackHelper ();
/**
* @brief Set forwarding strategy helper
*
* \param forwarding a new forwarding helper
*
* Set the forwarding helper to use during Install. The forwarding helper is
* really an object factory which is used to create an object of type
* ns3::CcnxL3Protocol per node. This forwarding object is then associated to
* a single ns3::Ccnx object through its ns3::Ccnx::SetforwardingProtocol.
*/
void
SetForwardingStrategy (std::string forwardingStrategy);
/**
* @brief Enable Interest limits (disabled by default)
*
* @param enable Enable or disable limits
* @param avgRtt Average RTT
* @param avgContentObject Average size of contentObject packets (including all headers)
* @param avgInterest Average size of interest packets (including all headers)
*/
void
EnableLimits (bool enable = true, Time avgRtt=Seconds(0.1), uint32_t avgContentObject=1100, uint32_t avgInterest=40);
/**
* \brief Install CCNx stack on the node
*
* This method will assert if called on a node that already has Ccnx object
* installed on it
*
* \param nodeName The name of the node on which to install the stack.
*
* \returns list of installed faces in the form of a smart pointer
* to CcnxFaceContainer object
*/
Ptr<CcnxFaceContainer>
Install (std::string nodeName) const;
/**
* \brief Install CCNx stack on the node
*
* This method will assert if called on a node that already has Ccnx object
* installed on it
*
* \param node The node on which to install the stack.
*
* \returns list of installed faces in the form of a smart pointer
* to CcnxFaceContainer object
*/
Ptr<CcnxFaceContainer>
Install (Ptr<Node> node) const;
/**
* \brief Install CCNx stack on each node in the input container
*
* The program will assert if this method is called on a container with a node
* that already has an ccnx object aggregated to it.
*
* \param c NodeContainer that holds the set of nodes on which to install the
* new stacks.
*
* \returns list of installed faces in the form of a smart pointer
* to CcnxFaceContainer object
*/
Ptr<CcnxFaceContainer>
Install (NodeContainer c) const;
/**
* \brief Install CCNx stack on all nodes in the simulation
*
* \returns list of installed faces in the form of a smart pointer
* to CcnxFaceContainer object
*/
Ptr<CcnxFaceContainer>
InstallAll () const;
/**
* \brief Add forwarding entry in FIB
*
* \param nodeName Node name
* \param prefix Routing prefix
* \param faceId Face index
* \param metric Routing metric
*/
static void
AddRoute (std::string nodeName, std::string prefix, uint32_t faceId, int32_t metric);
/**
* \brief Add forwarding entry in FIB
*
* \param node Node
* \param prefix Routing prefix
* \param face Face
* \param metric Routing metric
*/
static void
AddRoute (Ptr<Node> node, std::string prefix, Ptr<CcnxFace> face, int32_t metric);
/**
* \brief Set flag indicating necessity to install default routes in FIB
*/
void
SetDefaultRoutes (bool needSet);
/**
* \brief Install fake IPv4 routes that could be used to find nexthops for CCNx routes
*
* This method adds fake routes to all nodes, where each route is /32 and IPv4 address equal to node number.
* For example, node 5 will have direct route to 0.0.0.5.
*/
static void
InstallFakeGlobalRoutes ();
static void
InstallFakeGlobalRoutesImpl ();
/**
* \brief Install CCNx route to `node` based on fake IPv4 routes
*
* Actual route is "/<nodeId>"
*
* \param node Pointer to a node, which should be reached from all other nodes
*/
static void
InstallRouteTo (Ptr<Node> node);
/**
* \brief Install CCNx route to /prefix which is installed on `node'
*
* Normally, prefix is /<node->GetId()>. Other values may be used in black-holing scenarios
*/
static void
InstallRouteTo (const std::string &prefix, Ptr<Node> node);
/**
* \brief Install CCNx route to all nodes based on fake IPv4 routes
*
* \see InstallRouteTo
*/
static void
InstallRoutesToAll ();
private:
CcnxStackHelper (const CcnxStackHelper &);
CcnxStackHelper &operator = (const CcnxStackHelper &o);
private:
ObjectFactory m_strategyFactory;
bool m_limitsEnabled;
Time m_avgRtt;
uint32_t m_avgContentObjectSize;
uint32_t m_avgInterestSize;
bool m_needSetDefaultRoutes;
// /**
// * @brief Enable pcap output the indicated Ccnx and interface pair.
// * @internal
// *
// * @param prefix Filename prefix to use for pcap files.
// * @param ccnx Ptr to the Ccnx interface on which you want to enable tracing.
// * @param interface Interface ID on the Ccnx on which you want to enable tracing.
// */
// virtual void EnablePcapCcnxInternal (std::string prefix,
// Ptr<Ccnx> ccnx,
// uint32_t interface,
// bool explicitFilename);
// /**
// * @brief Enable ascii trace output on the indicated Ccnx and interface pair.
// * @internal
// *
// * @param stream An OutputStreamWrapper representing an existing file to use
// * when writing trace data.
// * @param prefix Filename prefix to use for ascii trace files.
// * @param ccnx Ptr to the Ccnx interface on which you want to enable tracing.
// * @param interface Interface ID on the Ccnx on which you want to enable tracing.
// */
// virtual void EnableAsciiCcnxInternal (Ptr<OutputStreamWrapper> stream,
// std::string prefix,
// Ptr<Ccnx> ccnx,
// uint32_t interface,
// bool explicitFilename);
// // /**
// // * \internal
// // */
// // static void CreateAndAggregateObjectFromTypeId (Ptr<Node> node, const std::string typeId);
// /**
// * \internal
// */
// static void Cleanup (void);
// /**
// * \internal
// */
// bool PcapHooked (Ptr<Ccnx> ccnx);
// /**
// * \internal
// */
// bool AsciiHooked (Ptr<Ccnx> ccnx);
};
} // namespace ns3
#endif /* CCNX_STACK_HELPER_H */