utils/tracers/ndn-l3-rate-tracer.cpp

/* -*- 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>
 */

#include "ndn-l3-rate-tracer.hpp"
#include "ns3/node.h"
#include "ns3/packet.h"
#include "ns3/config.h"
#include "ns3/callback.h"
#include "ns3/simulator.h"
#include "ns3/log.h"
#include "ns3/node-list.h"

#include "ns3/ndn-app.hpp"
#include "ns3/ndn-face.hpp"
#include "ns3/ndn-interest.hpp"
#include "ns3/ndn-data.hpp"
#include "ns3/ndn-pit-entry.hpp"

#include <fstream>
#include <boost/lexical_cast.hpp>

using namespace boost;
using namespace std;

NS_LOG_COMPONENT_DEFINE("ndn.L3RateTracer");

namespace ns3 {
namespace ndn {

static std::list<boost::tuple<boost::shared_ptr<std::ostream>, std::list<Ptr<L3RateTracer>>>>
  g_tracers;

template<class T>
static inline void
NullDeleter(T* ptr)
{
}

void
L3RateTracer::Destroy()
{
  g_tracers.clear();
}

void
L3RateTracer::InstallAll(const std::string& file, Time averagingPeriod /* = Seconds (0.5)*/)
{
  std::list<Ptr<L3RateTracer>> tracers;
  boost::shared_ptr<std::ostream> outputStream;
  if (file != "-") {
    boost::shared_ptr<std::ofstream> os(new std::ofstream());
    os->open(file.c_str(), std::ios_base::out | std::ios_base::trunc);

    if (!os->is_open()) {
      NS_LOG_ERROR("File " << file << " cannot be opened for writing. Tracing disabled");
      return;
    }

    outputStream = os;
  }
  else {
    outputStream = boost::shared_ptr<std::ostream>(&std::cout, NullDeleter<std::ostream>);
  }

  for (NodeList::Iterator node = NodeList::Begin(); node != NodeList::End(); node++) {
    Ptr<L3RateTracer> trace = Install(*node, outputStream, averagingPeriod);
    tracers.push_back(trace);
  }

  if (tracers.size() > 0) {
    // *m_l3RateTrace << "# "; // not necessary for R's read.table
    tracers.front()->PrintHeader(*outputStream);
    *outputStream << "\n";
  }

  g_tracers.push_back(boost::make_tuple(outputStream, tracers));
}

void
L3RateTracer::Install(const NodeContainer& nodes, const std::string& file,
                      Time averagingPeriod /* = Seconds (0.5)*/)
{
  using namespace boost;
  using namespace std;

  std::list<Ptr<L3RateTracer>> tracers;
  boost::shared_ptr<std::ostream> outputStream;
  if (file != "-") {
    boost::shared_ptr<std::ofstream> os(new std::ofstream());
    os->open(file.c_str(), std::ios_base::out | std::ios_base::trunc);

    if (!os->is_open()) {
      NS_LOG_ERROR("File " << file << " cannot be opened for writing. Tracing disabled");
      return;
    }

    outputStream = os;
  }
  else {
    outputStream = boost::shared_ptr<std::ostream>(&std::cout, NullDeleter<std::ostream>);
  }

  for (NodeContainer::Iterator node = nodes.Begin(); node != nodes.End(); node++) {
    Ptr<L3RateTracer> trace = Install(*node, outputStream, averagingPeriod);
    tracers.push_back(trace);
  }

  if (tracers.size() > 0) {
    // *m_l3RateTrace << "# "; // not necessary for R's read.table
    tracers.front()->PrintHeader(*outputStream);
    *outputStream << "\n";
  }

  g_tracers.push_back(boost::make_tuple(outputStream, tracers));
}

void
L3RateTracer::Install(Ptr<Node> node, const std::string& file,
                      Time averagingPeriod /* = Seconds (0.5)*/)
{
  using namespace boost;
  using namespace std;

  std::list<Ptr<L3RateTracer>> tracers;
  boost::shared_ptr<std::ostream> outputStream;
  if (file != "-") {
    boost::shared_ptr<std::ofstream> os(new std::ofstream());
    os->open(file.c_str(), std::ios_base::out | std::ios_base::trunc);

    if (!os->is_open()) {
      NS_LOG_ERROR("File " << file << " cannot be opened for writing. Tracing disabled");
      return;
    }

    outputStream = os;
  }
  else {
    outputStream = boost::shared_ptr<std::ostream>(&std::cout, NullDeleter<std::ostream>);
  }

  Ptr<L3RateTracer> trace = Install(node, outputStream, averagingPeriod);
  tracers.push_back(trace);

  if (tracers.size() > 0) {
    // *m_l3RateTrace << "# "; // not necessary for R's read.table
    tracers.front()->PrintHeader(*outputStream);
    *outputStream << "\n";
  }

  g_tracers.push_back(boost::make_tuple(outputStream, tracers));
}

Ptr<L3RateTracer>
L3RateTracer::Install(Ptr<Node> node, boost::shared_ptr<std::ostream> outputStream,
                      Time averagingPeriod /* = Seconds (0.5)*/)
{
  NS_LOG_DEBUG("Node: " << node->GetId());

  Ptr<L3RateTracer> trace = Create<L3RateTracer>(outputStream, node);
  trace->SetAveragingPeriod(averagingPeriod);

  return trace;
}

L3RateTracer::L3RateTracer(boost::shared_ptr<std::ostream> os, Ptr<Node> node)
  : L3Tracer(node)
  , m_os(os)
{
  SetAveragingPeriod(Seconds(1.0));
}

L3RateTracer::L3RateTracer(boost::shared_ptr<std::ostream> os, const std::string& node)
  : L3Tracer(node)
  , m_os(os)
{
  SetAveragingPeriod(Seconds(1.0));
}

L3RateTracer::~L3RateTracer()
{
  m_printEvent.Cancel();
}

void
L3RateTracer::SetAveragingPeriod(const Time& period)
{
  m_period = period;
  m_printEvent.Cancel();
  m_printEvent = Simulator::Schedule(m_period, &L3RateTracer::PeriodicPrinter, this);
}

void
L3RateTracer::PeriodicPrinter()
{
  Print(*m_os);
  Reset();

  m_printEvent = Simulator::Schedule(m_period, &L3RateTracer::PeriodicPrinter, this);
}

void
L3RateTracer::PrintHeader(std::ostream& os) const
{
  os << "Time"
     << "\t"

     << "Node"
     << "\t"
     << "FaceId"
     << "\t"
     << "FaceDescr"
     << "\t"

     << "Type"
     << "\t"
     << "Packets"
     << "\t"
     << "Kilobytes"
     << "\t"
     << "PacketRaw"
     << "\t"
     << "KilobytesRaw";
}

void
L3RateTracer::Reset()
{
  for (std::map<Ptr<const Face>, boost::tuple<Stats, Stats, Stats, Stats>>::iterator stats =
         m_stats.begin();
       stats != m_stats.end(); stats++) {
    stats->second.get<0>().Reset();
    stats->second.get<1>().Reset();
  }
}

const double alpha = 0.8;

#define STATS(INDEX) stats->second.get<INDEX>()
#define RATE(INDEX, fieldName) STATS(INDEX).fieldName / m_period.ToDouble(Time::S)

#define PRINTER(printName, fieldName)                                                              \
  STATS(2).fieldName =                                                                             \
    /*new value*/ alpha * RATE(0, fieldName) + /*old value*/ (1 - alpha) * STATS(2).fieldName;     \
  STATS(3).fieldName = /*new value*/ alpha * RATE(1, fieldName) / 1024.0                           \
                       + /*old value*/ (1 - alpha) * STATS(3).fieldName;                           \
                                                                                                   \
  os << time.ToDouble(Time::S) << "\t" << m_node << "\t";                                          \
  if (stats->first) {                                                                              \
    os << stats->first->GetId() << "\t" << *stats->first << "\t";                                  \
  }                                                                                                \
  else {                                                                                           \
    os << "-1\tall\t";                                                                             \
  }                                                                                                \
  os << printName << "\t" << STATS(2).fieldName << "\t" << STATS(3).fieldName << "\t"              \
     << STATS(0).fieldName << "\t" << STATS(1).fieldName / 1024.0 << "\n";

void
L3RateTracer::Print(std::ostream& os) const
{
  Time time = Simulator::Now();

  for (std::map<Ptr<const Face>, boost::tuple<Stats, Stats, Stats, Stats>>::iterator stats =
         m_stats.begin();
       stats != m_stats.end(); stats++) {
    if (!stats->first)
      continue;

    PRINTER("InInterests", m_inInterests);
    PRINTER("OutInterests", m_outInterests);
    PRINTER("DropInterests", m_dropInterests);

    PRINTER("InNacks", m_inNacks);
    PRINTER("OutNacks", m_outNacks);
    PRINTER("DropNacks", m_dropNacks);

    PRINTER("InData", m_inData);
    PRINTER("OutData", m_outData);
    PRINTER("DropData", m_dropData);

    PRINTER("InSatisfiedInterests", m_satisfiedInterests);
    PRINTER("InTimedOutInterests", m_timedOutInterests);

    PRINTER("OutSatisfiedInterests", m_outSatisfiedInterests);
    PRINTER("OutTimedOutInterests", m_outTimedOutInterests);
  }

  {
    std::map<Ptr<const Face>, boost::tuple<Stats, Stats, Stats, Stats>>::iterator stats =
      m_stats.find(Ptr<const Face>(0));
    if (stats != m_stats.end()) {
      PRINTER("SatisfiedInterests", m_satisfiedInterests);
      PRINTER("TimedOutInterests", m_timedOutInterests);
    }
  }
}

void
L3RateTracer::OutInterests(Ptr<const Interest> interest, Ptr<const Face> face)
{
  m_stats[face].get<0>().m_outInterests++;
  if (interest->GetWire()) {
    m_stats[face].get<1>().m_outInterests += interest->GetWire()->GetSize();
  }
}

void
L3RateTracer::InInterests(Ptr<const Interest> interest, Ptr<const Face> face)
{
  m_stats[face].get<0>().m_inInterests++;
  if (interest->GetWire()) {
    m_stats[face].get<1>().m_inInterests += interest->GetWire()->GetSize();
  }
}

void
L3RateTracer::DropInterests(Ptr<const Interest> interest, Ptr<const Face> face)
{
  m_stats[face].get<0>().m_dropInterests++;
  if (interest->GetWire()) {
    m_stats[face].get<1>().m_dropInterests += interest->GetWire()->GetSize();
  }
}

void
L3RateTracer::OutNacks(Ptr<const Interest> interest, Ptr<const Face> face)
{
  m_stats[face].get<0>().m_outNacks++;
  if (interest->GetWire()) {
    m_stats[face].get<1>().m_outNacks += interest->GetWire()->GetSize();
  }
}

void
L3RateTracer::InNacks(Ptr<const Interest> interest, Ptr<const Face> face)
{
  m_stats[face].get<0>().m_inNacks++;
  if (interest->GetWire()) {
    m_stats[face].get<1>().m_inNacks += interest->GetWire()->GetSize();
  }
}

void
L3RateTracer::DropNacks(Ptr<const Interest> interest, Ptr<const Face> face)
{
  m_stats[face].get<0>().m_dropNacks++;
  if (interest->GetWire()) {
    m_stats[face].get<1>().m_dropNacks += interest->GetWire()->GetSize();
  }
}

void
L3RateTracer::OutData(Ptr<const Data> data, bool fromCache, Ptr<const Face> face)
{
  m_stats[face].get<0>().m_outData++;
  if (data->GetWire()) {
    m_stats[face].get<1>().m_outData += data->GetWire()->GetSize();
  }
}

void
L3RateTracer::InData(Ptr<const Data> data, Ptr<const Face> face)
{
  m_stats[face].get<0>().m_inData++;
  if (data->GetWire()) {
    m_stats[face].get<1>().m_inData += data->GetWire()->GetSize();
  }
}

void
L3RateTracer::DropData(Ptr<const Data> data, Ptr<const Face> face)
{
  m_stats[face].get<0>().m_dropData++;
  if (data->GetWire()) {
    m_stats[face].get<1>().m_dropData += data->GetWire()->GetSize();
  }
}

void
L3RateTracer::SatisfiedInterests(Ptr<const pit::Entry> entry)
{
  m_stats[0].get<0>().m_satisfiedInterests++;
  // no "size" stats

  for (pit::Entry::in_container::const_iterator i = entry->GetIncoming().begin();
       i != entry->GetIncoming().end(); i++) {
    m_stats[i->m_face].get<0>().m_satisfiedInterests++;
  }

  for (pit::Entry::out_container::const_iterator i = entry->GetOutgoing().begin();
       i != entry->GetOutgoing().end(); i++) {
    m_stats[i->m_face].get<0>().m_outSatisfiedInterests++;
  }
}

void
L3RateTracer::TimedOutInterests(Ptr<const pit::Entry> entry)
{
  m_stats[0].get<0>().m_timedOutInterests++;
  // no "size" stats

  for (pit::Entry::in_container::const_iterator i = entry->GetIncoming().begin();
       i != entry->GetIncoming().end(); i++) {
    m_stats[i->m_face].get<0>().m_timedOutInterests++;
  }

  for (pit::Entry::out_container::const_iterator i = entry->GetOutgoing().begin();
       i != entry->GetOutgoing().end(); i++) {
    m_stats[i->m_face].get<0>().m_outTimedOutInterests++;
  }
}

} // namespace ndn
} // namespace ns3