blob: 1a6a401638074e2a58226ba347d42bb5db6bba4d [file] [log] [blame]
Alexander Afanasyevb3e4b852011-12-23 15:58:20 -08001/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil -*- */
2/*
3 * Copyright (c) 2011 UCLA
4 *
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License version 2 as
7 * published by the Free Software Foundation;
8 *
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
13 *
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write to the Free Software
16 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17 *
18 * Author: Alexander Afanasyev <alexander.afanasyev@ucla.edu>
19 */
20
21#ifndef CCNX_RATE_L3_TRACER_H
22#define CCNX_RATE_L3_TRACER_H
23
Alexander Afanasyev0c395372014-12-20 15:54:02 -080024#include "ndn-l3-tracer.hpp"
Alexander Afanasyevb3e4b852011-12-23 15:58:20 -080025
26#include "ns3/nstime.h"
27#include "ns3/event-id.h"
Alexander Afanasyev5352af32013-07-15 09:51:28 -070028#include <ns3/node-container.h>
Alexander Afanasyevb3e4b852011-12-23 15:58:20 -080029
30#include <boost/tuple/tuple.hpp>
Alexander Afanasyevc9d5c1a2012-11-21 18:00:26 -080031#include <boost/shared_ptr.hpp>
Alexander Afanasyevb3e4b852011-12-23 15:58:20 -080032#include <map>
Alexander Afanasyevc9d5c1a2012-11-21 18:00:26 -080033#include <list>
Alexander Afanasyevb3e4b852011-12-23 15:58:20 -080034
35namespace ns3 {
Alexander Afanasyevc9d5c1a2012-11-21 18:00:26 -080036namespace ndn {
Alexander Afanasyevb3e4b852011-12-23 15:58:20 -080037
38/**
Alexander Afanasyev79206512013-07-27 16:49:12 -070039 * @ingroup ndn-tracers
40 * @brief NDN network-layer rate tracer
Alexander Afanasyevb3e4b852011-12-23 15:58:20 -080041 */
Alexander Afanasyevc9d5c1a2012-11-21 18:00:26 -080042class L3RateTracer : public L3Tracer
Alexander Afanasyevb3e4b852011-12-23 15:58:20 -080043{
44public:
45 /**
Alexander Afanasyev3fe94dc2013-08-09 17:12:12 -070046 * @brief Helper method to install tracers on all simulation nodes
47 *
48 * @param file File to which traces will be written. If filename is -, then std::out is used
49 * @param averagingPeriod Defines averaging period for the rate calculation,
50 * as well as how often data will be written into the trace file (default, every half second)
51 */
52 static void
53 InstallAll (const std::string &file, Time averagingPeriod = Seconds (0.5));
54
55 /**
56 * @brief Helper method to install tracers on the selected simulation nodes
57 *
58 * @param nodes Nodes on which to install tracer
59 * @param file File to which traces will be written. If filename is -, then std::out is used
60 * @param averagingPeriod How often data will be written into the trace file (default, every half second)
61 */
62 static void
63 Install (const NodeContainer &nodes, const std::string &file, Time averagingPeriod = Seconds (0.5));
64
65 /**
66 * @brief Helper method to install tracers on a specific simulation node
67 *
68 * @param nodes Nodes on which to install tracer
69 * @param file File to which traces will be written. If filename is -, then std::out is used
70 * @param averagingPeriod How often data will be written into the trace file (default, every half second)
71 */
72 static void
73 Install (Ptr<Node> node, const std::string &file, Time averagingPeriod = Seconds (0.5));
Alexander Afanasyevdb5f3b62013-08-09 17:42:12 -070074
75 /**
76 * @brief Explicit request to remove all statically created tracers
77 *
78 * This method can be helpful if simulation scenario contains several independent run,
79 * or if it is desired to do a postprocessing of the resulting data
80 */
81 static void
82 Destroy ();
Alexander Afanasyev3fe94dc2013-08-09 17:12:12 -070083
84 /**
Alexander Afanasyev59314802012-11-26 14:56:04 -080085 * @brief Trace constructor that attaches to the node using node pointer
86 * @param os reference to the output stream
87 * @param node pointer to the node
Alexander Afanasyevb3e4b852011-12-23 15:58:20 -080088 */
Alexander Afanasyevc9d5c1a2012-11-21 18:00:26 -080089 L3RateTracer (boost::shared_ptr<std::ostream> os, Ptr<Node> node);
Alexander Afanasyev59314802012-11-26 14:56:04 -080090
91 /**
92 * @brief Trace constructor that attaches to the node using node name
93 * @param os reference to the output stream
94 * @param nodeName name of the node registered using Names::Add
95 */
Alexander Afanasyevc9d5c1a2012-11-21 18:00:26 -080096 L3RateTracer (boost::shared_ptr<std::ostream> os, const std::string &node);
Alexander Afanasyev59314802012-11-26 14:56:04 -080097
98 /**
99 * @brief Destructor
100 */
Alexander Afanasyevc9d5c1a2012-11-21 18:00:26 -0800101 virtual ~L3RateTracer ();
Alexander Afanasyevb3e4b852011-12-23 15:58:20 -0800102
Alexander Afanasyev59314802012-11-26 14:56:04 -0800103 /**
Alexander Afanasyev5352af32013-07-15 09:51:28 -0700104 * @brief Helper method to install tracers on a specific simulation node
105 *
106 * @param nodes Nodes on which to install tracer
107 * @param outputStream Smart pointer to a stream
108 * @param averagingPeriod How often data will be written into the trace file (default, every half second)
109 *
110 * @returns a tuple of reference to output stream and list of tracers. !!! Attention !!! This tuple needs to be preserved
111 * for the lifetime of simulation, otherwise SEGFAULTs are inevitable
112 */
113 static Ptr<L3RateTracer>
114 Install (Ptr<Node> node, boost::shared_ptr<std::ostream> outputStream, Time averagingPeriod = Seconds (0.5));
115
Alexander Afanasyev59314802012-11-26 14:56:04 -0800116 // from L3Tracer
Alexander Afanasyevb3e4b852011-12-23 15:58:20 -0800117 virtual void
118 PrintHeader (std::ostream &os) const;
119
120 virtual void
121 Print (std::ostream &os) const;
122
Alexander Afanasyev59314802012-11-26 14:56:04 -0800123protected:
124 // from L3Tracer
Alexander Afanasyevb3e4b852011-12-23 15:58:20 -0800125 virtual void
Alexander Afanasyev5352af32013-07-15 09:51:28 -0700126 OutInterests (Ptr<const Interest>, Ptr<const Face>);
Alexander Afanasyevb3e4b852011-12-23 15:58:20 -0800127
128 virtual void
Alexander Afanasyev5352af32013-07-15 09:51:28 -0700129 InInterests (Ptr<const Interest>, Ptr<const Face>);
Alexander Afanasyevb3e4b852011-12-23 15:58:20 -0800130
131 virtual void
Alexander Afanasyev5352af32013-07-15 09:51:28 -0700132 DropInterests (Ptr<const Interest>, Ptr<const Face>);
Alexander Afanasyev37b84c52013-04-26 13:38:52 -0700133
Alexander Afanasyevb3e4b852011-12-23 15:58:20 -0800134 virtual void
Alexander Afanasyev5352af32013-07-15 09:51:28 -0700135 OutNacks (Ptr<const Interest>, Ptr<const Face>);
Alexander Afanasyevb3e4b852011-12-23 15:58:20 -0800136
137 virtual void
Alexander Afanasyev5352af32013-07-15 09:51:28 -0700138 InNacks (Ptr<const Interest>, Ptr<const Face>);
Alexander Afanasyevb3e4b852011-12-23 15:58:20 -0800139
140 virtual void
Alexander Afanasyev5352af32013-07-15 09:51:28 -0700141 DropNacks (Ptr<const Interest>, Ptr<const Face>);
Alexander Afanasyev37b84c52013-04-26 13:38:52 -0700142
Alexander Afanasyevb3e4b852011-12-23 15:58:20 -0800143 virtual void
Alexander Afanasyev772f51b2013-08-01 18:53:25 -0700144 OutData (Ptr<const Data>, bool fromCache, Ptr<const Face>);
Alexander Afanasyevb3e4b852011-12-23 15:58:20 -0800145
146 virtual void
Alexander Afanasyev772f51b2013-08-01 18:53:25 -0700147 InData (Ptr<const Data>, Ptr<const Face>);
Alexander Afanasyevb3e4b852011-12-23 15:58:20 -0800148
149 virtual void
Alexander Afanasyev772f51b2013-08-01 18:53:25 -0700150 DropData (Ptr<const Data>, Ptr<const Face>);
Alexander Afanasyevb3e4b852011-12-23 15:58:20 -0800151
Alexander Afanasyev37b84c52013-04-26 13:38:52 -0700152 virtual void
153 SatisfiedInterests (Ptr<const pit::Entry>);
154
155 virtual void
156 TimedOutInterests (Ptr<const pit::Entry>);
157
Alexander Afanasyevb3e4b852011-12-23 15:58:20 -0800158private:
159 void
Alexander Afanasyev59314802012-11-26 14:56:04 -0800160 SetAveragingPeriod (const Time &period);
161
162 void
Alexander Afanasyevb3e4b852011-12-23 15:58:20 -0800163 PeriodicPrinter ();
Alexander Afanasyev37b84c52013-04-26 13:38:52 -0700164
Alexander Afanasyevb3e4b852011-12-23 15:58:20 -0800165 void
166 Reset ();
167
168private:
Alexander Afanasyevc9d5c1a2012-11-21 18:00:26 -0800169 boost::shared_ptr<std::ostream> m_os;
Alexander Afanasyevb3e4b852011-12-23 15:58:20 -0800170 Time m_period;
171 EventId m_printEvent;
172
Alexander Afanasyevc9d5c1a2012-11-21 18:00:26 -0800173 mutable std::map<Ptr<const Face>, boost::tuple<Stats, Stats, Stats, Stats> > m_stats;
Alexander Afanasyevb3e4b852011-12-23 15:58:20 -0800174};
175
Alexander Afanasyevc9d5c1a2012-11-21 18:00:26 -0800176} // namespace ndn
Alexander Afanasyevb3e4b852011-12-23 15:58:20 -0800177} // namespace ns3
178
179#endif // CCNX_RATE_L3_TRACER_H