examples+utils: Adding example to evaluate memory footprint of ContentStore/Pit
diff --git a/examples/ndn-simple-with-cs-lfu.cc b/examples/ndn-simple-with-cs-lfu.cc
new file mode 100644
index 0000000..83cef07
--- /dev/null
+++ b/examples/ndn-simple-with-cs-lfu.cc
@@ -0,0 +1,153 @@
+/* -*- Mode: C++; c-file-style: "gnu"; indent-tabs-mode:nil; -*- */
+/*
+ * Copyright (c) 2012-2013 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>
+ */
+// ndn-simple-with-cs-lfu.cc
+#include "ns3/core-module.h"
+#include "ns3/network-module.h"
+#include "ns3/point-to-point-module.h"
+#include "ns3/ndnSIM-module.h"
+
+#include <sys/time.h>
+#include "ns3/ndnSIM/utils/mem-usage.h"
+
+using namespace ns3;
+
+/**
+ * This scenario simulates a very simple network topology:
+ *
+ *
+ * +----------+ 1Mbps +--------+ 1Mbps +----------+
+ * | consumer | <------------> | router | <------------> | producer |
+ * +----------+ 10ms +--------+ 10ms +----------+
+ *
+ * This scenario demonstrates how to use content store that responds to Freshness parameter set in ContentObjects.
+ * That is, if producer set Freshness field to 2 seconds, the corresponding content object will not be cached
+ * more than 2 seconds (can be cached for a shorter time, if entry is evicted earlier)
+ *
+ * NS_LOG=ndn.Consumer ./waf --run ndn-simple-with-cs-lfu
+ */
+
+void PrintCsMemStatsHeader (std::ostream &os)
+{
+ os << "SimulationTime" << "\t"
+ << "RealTime" << "\t"
+ << "NumberOfProcessedData" << "\t"
+ << "NumberOfProcessedInterests" << "\t"
+ << "NumberPitEntries" << "\t"
+ << "NumberCsEntries" << "\t"
+ << "MemUsage" << "\n";
+}
+
+void
+PrintCsMemStats (std::ostream &os, Time nextPrintTime, double beginRealTime)
+{
+ ::timeval t;
+ gettimeofday(&t, NULL);
+ double realTime = t.tv_sec + (0.000001 * (unsigned)t.tv_usec) - beginRealTime;
+
+ os << Simulator::Now ().ToDouble (Time::S) << "\t";
+ os << realTime << "\t";
+
+ os << ndn::L3Protocol::GetDataCounter () << "\t";
+ os << ndn::L3Protocol::GetInterestCounter () << "\t";
+
+ uint64_t pitCount = 0;
+ uint64_t csCount = 0;
+ for (NodeList::Iterator node = NodeList::Begin ();
+ node != NodeList::End ();
+ node ++)
+ {
+ Ptr<ndn::Pit> pit = (*node)->GetObject<ndn::Pit> ();
+ Ptr<ndn::ContentStore> cs = (*node)->GetObject<ndn::ContentStore> ();
+
+ if (pit != 0)
+ pitCount += pit->GetSize ();
+
+ if (cs != 0)
+ csCount += cs->GetSize ();
+ }
+
+ os << pitCount << "\t";
+ os << csCount << "\t";
+ os << MemUsage::Get () / 1024.0 / 1024.0 << "\n";
+
+ Simulator::Schedule (nextPrintTime, PrintCsMemStats, boost::ref (os), nextPrintTime, beginRealTime);
+}
+
+int
+main (int argc, char *argv[])
+{
+ // setting default parameters for PointToPoint links and channels
+ Config::SetDefault ("ns3::PointToPointNetDevice::DataRate", StringValue ("1Mbps"));
+ Config::SetDefault ("ns3::PointToPointChannel::Delay", StringValue ("10ms"));
+ Config::SetDefault ("ns3::DropTailQueue::MaxPackets", StringValue ("20"));
+
+ // Read optional command-line parameters (e.g., enable visualizer with ./waf --run=<> --visualize
+ CommandLine cmd;
+ cmd.Parse (argc, argv);
+
+ // Creating nodes
+ NodeContainer nodes;
+ nodes.Create (3);
+
+ // Connecting nodes using two links
+ PointToPointHelper p2p;
+ p2p.Install (nodes.Get (0), nodes.Get (1));
+ p2p.Install (nodes.Get (1), nodes.Get (2));
+
+ // Install CCNx stack on all nodes
+ ndn::StackHelper ccnxHelper;
+ ccnxHelper.SetDefaultRoutes (true);
+ ccnxHelper.SetContentStore ("ns3::ndn::cs::Freshness::Lfu"); // don't set up max size here, will use default value = 100
+ ccnxHelper.InstallAll ();
+
+ // set up max sizes, after NDN stack is installed
+ Config::Set ("/NodeList/0/$ns3::ndn::ContentStore/MaxSize", UintegerValue (1)); // number after nodeList is global ID of the node (= node->GetId ())
+ Config::Set ("/NodeList/1/$ns3::ndn::ContentStore/MaxSize", UintegerValue (2));
+ Config::Set ("/NodeList/2/$ns3::ndn::ContentStore/MaxSize", UintegerValue (100000));
+
+ // Installing applications
+
+ // Consumer
+ ndn::AppHelper consumerHelper ("ns3::ndn::ConsumerCbr");
+ // Consumer will request /prefix/0, /prefix/1, ...
+ consumerHelper.SetPrefix ("/prefix");
+ consumerHelper.SetAttribute ("Frequency", StringValue ("10")); // 10 interests a second
+ consumerHelper.Install (nodes.Get (0)); // first node
+
+ // Producer
+ ndn::AppHelper producerHelper ("ns3::ndn::Producer");
+ // Producer will reply to all requests starting with /prefix
+ producerHelper.SetPrefix ("/prefix");
+ producerHelper.SetAttribute ("PayloadSize", StringValue("1024"));
+ producerHelper.Install (nodes.Get (2)); // last node
+
+ Simulator::Stop (Seconds (200000.0));
+
+ struct ::timeval t;
+ gettimeofday(&t, NULL);
+ double beginRealTime = t.tv_sec + (0.000001 * (unsigned)t.tv_usec);
+ Simulator::Schedule (Seconds (0), PrintCsMemStatsHeader, boost::ref (std::cout));
+ Simulator::Schedule (Seconds (100), PrintCsMemStats, boost::ref (std::cout), Seconds (100), beginRealTime);
+
+ Simulator::Run ();
+ Simulator::Destroy ();
+
+ return 0;
+}
diff --git a/examples/wscript b/examples/wscript
index 7a24cc8..b21629e 100644
--- a/examples/wscript
+++ b/examples/wscript
@@ -47,3 +47,6 @@
obj = bld.create_ns3_program('ndn-simple-with-different-sizes-content-store', ['ndnSIM'])
obj.source = 'ndn-simple-with-different-sizes-content-store.cc'
+
+ obj = bld.create_ns3_program('ndn-simple-with-cs-lfu', ['ndnSIM'])
+ obj.source = 'ndn-simple-with-cs-lfu.cc'