22 #include "ns3/simulator.h"
24 #include "ns3/double.h"
28 #define INDENT(level) for (int __xpto = 0; __xpto < level; __xpto++) os << ' ';
30 #define PERIODIC_CHECK_INTERVAL (Seconds (1))
44 .AddConstructor<FlowMonitor> ()
45 .AddAttribute (
"MaxPerHopDelay", (
"The maximum per-hop delay that should be considered. "
46 "Packets still not received after this delay are to be considered lost."),
50 .AddAttribute (
"StartTime", (
"The time when the monitoring starts."),
54 .AddAttribute (
"DelayBinWidth", (
"The width used in the delay histogram."),
57 MakeDoubleChecker <double> ())
58 .AddAttribute (
"JitterBinWidth", (
"The width used in the jitter histogram."),
61 MakeDoubleChecker <double> ())
62 .AddAttribute (
"PacketSizeBinWidth", (
"The width used in the packetSize histogram."),
65 MakeDoubleChecker <double> ())
66 .AddAttribute (
"FlowInterruptionsBinWidth", (
"The width used in the flowInterruptions histogram."),
69 MakeDoubleChecker <double> ())
70 .AddAttribute (
"FlowInterruptionsMinTime", (
"The minimum inter-arrival time that is considered a flow interruption."),
110 std::map<FlowId, FlowStats>::iterator iter;
149 NS_LOG_DEBUG (
"ReportFirstTx: adding tracked packet (flowId=" << flowId <<
", packetId=" << packetId
152 probe->AddPacketStats (flowId, packetSize, Seconds (0));
172 std::pair<FlowId, FlowPacketId> key (flowId, packetId);
176 NS_LOG_WARN (
"Received packet forward report (flowId=" << flowId <<
", packetId=" << packetId
177 <<
") but not known to be transmitted.");
181 tracked->second.timesForwarded++;
185 probe->AddPacketStats (flowId, packetSize, delay);
196 TrackedPacketMap::iterator tracked =
m_trackedPackets.find (std::make_pair (flowId, packetId));
199 NS_LOG_WARN (
"Received packet last-tx report (flowId=" << flowId <<
", packetId=" << packetId
200 <<
") but not known to be transmitted.");
205 Time delay = (now - tracked->second.firstSeenTime);
206 probe->AddPacketStats (flowId, packetSize, delay);
214 if (jitter > Seconds (0))
246 NS_LOG_DEBUG (
"ReportLastTx: removing tracked packet (flowId="
247 << flowId <<
", packetId=" << packetId <<
").");
261 probe->AddPacketDropStats (flowId, packetSize, reasonCode);
274 TrackedPacketMap::iterator tracked =
m_trackedPackets.find (std::make_pair (flowId, packetId));
279 NS_LOG_DEBUG (
"ReportDrop: removing tracked packet (flowId="
280 << flowId <<
", packetId=" << packetId <<
").");
285 std::map<FlowId, FlowMonitor::FlowStats>
300 if (now - iter->second.lastSeenTime >= maxDelay)
303 std::map<FlowId, FlowStats>::iterator
306 flow->second.lostPackets++;
344 std::vector< Ptr<FlowProbe> >
407 INDENT (indent); os <<
"<FlowMonitor>\n";
409 INDENT (indent); os <<
"<FlowStats>\n";
411 for (std::map<FlowId, FlowStats>::const_iterator flowI =
m_flowStats.begin ();
416 #define ATTRIB(name) << " " # name "=\"" << flowI->second.name << "\""
417 os <<
"<Flow flowId=\"" << flowI->first <<
"\""
418 ATTRIB (timeFirstTxPacket)
419 ATTRIB (timeFirstRxPacket)
436 for (uint32_t reasonCode = 0; reasonCode < flowI->second.packetsDropped.size (); reasonCode++)
439 os <<
"<packetsDropped reasonCode=\"" << reasonCode <<
"\""
440 <<
" number=\"" << flowI->second.packetsDropped[reasonCode]
443 for (uint32_t reasonCode = 0; reasonCode < flowI->second.bytesDropped.size (); reasonCode++)
446 os <<
"<bytesDropped reasonCode=\"" << reasonCode <<
"\""
447 <<
" bytes=\"" << flowI->second.bytesDropped[reasonCode]
450 if (enableHistograms)
452 flowI->second.delayHistogram.SerializeToXmlStream (os, indent,
"delayHistogram");
453 flowI->second.jitterHistogram.SerializeToXmlStream (os, indent,
"jitterHistogram");
454 flowI->second.packetSizeHistogram.SerializeToXmlStream (os, indent,
"packetSizeHistogram");
455 flowI->second.flowInterruptionsHistogram.SerializeToXmlStream (os, indent,
"flowInterruptionsHistogram");
459 INDENT (indent); os <<
"</Flow>\n";
462 INDENT (indent); os <<
"</FlowStats>\n";
468 (*iter)->SerializeToXmlStream (os, indent);
473 INDENT (indent); os <<
"<FlowProbes>\n";
480 INDENT (indent); os <<
"</FlowProbes>\n";
484 INDENT (indent); os <<
"</FlowMonitor>\n";
491 std::ostringstream os;
500 std::ofstream os (fileName.c_str (), std::ios::out|std::ios::binary);
501 os <<
"<?xml version=\"1.0\" ?>\n";
#define PERIODIC_CHECK_INTERVAL
Simulation virtual time values and global simulation resolution.
smart pointer class similar to boost::intrusive_ptr
#define NS_OBJECT_ENSURE_REGISTERED(type)
Register the class in the ns-3 factory.
void CheckForLostPackets()
Check right now for packets that appear to be lost.
void StartRightNow()
Begin monitoring flows right now
uint32_t lostPackets
Total number of packets that are assumed to be lost, i.e.
uint32_t rxPackets
Total number of received packets for the flow.
uint32_t txPackets
Total number of transmitted packets for the flow.
#define NS_ASSERT(condition)
At runtime, in debugging builds, if this condition is not true, the program prints the source file...
#define NS_LOG_COMPONENT_DEFINE(name)
Define a Log component with a specific name.
Time m_maxPerHopDelay
Minimum per-hop delay.
static TypeId GetTypeId()
Get the type ID.
void ReportDrop(Ptr< FlowProbe > probe, FlowId flowId, FlowPacketId packetId, uint32_t packetSize, uint32_t reasonCode)
FlowProbe implementations are supposed to call this method to report that a known packet is being dro...
virtual void DoDispose(void)
This method is called by Object::Dispose or by the object's destructor, whichever comes first...
static void Cancel(const EventId &id)
Set the cancel bit on this event: the event's associated function will not be invoked when it expires...
static EventId Schedule(Time const &time, MEM mem_ptr, OBJ obj)
Schedule an event to expire at the relative time "time" is reached.
Time delaySum
Contains the sum of all end-to-end delays for all received packets of the flow.
std::vector< uint64_t > bytesDropped
This attribute also tracks the number of lost bytes.
std::map< FlowId, FlowStats > m_flowStats
FlowId –> FlowStats.
Time m_flowInterruptionsMinTime
Flow interruptions minimum time.
void ReportFirstTx(Ptr< FlowProbe > probe, FlowId flowId, FlowPacketId packetId, uint32_t packetSize)
FlowProbe implementations are supposed to call this method to report that a new packet was transmitte...
TrackedPacketMap m_trackedPackets
Tracked packets.
Time lastDelay
Contains the last measured delay of a packet It is stored to measure the packet's Jitter...
std::map< FlowId, FlowStats > GetFlowStats() const
Retrieve all collected the flow statistics.
void SerializeToXmlStream(std::ostream &os, int indent, bool enableHistograms, bool enableProbes)
Serializes the results to an std::ostream in XML format.
double GetSeconds(void) const
Time firstSeenTime
absolute time when the packet was first seen by a probe
hold objects of type ns3::Time
std::list< Ptr< FlowClassifier > > m_classifiers
the FlowClassifiers
Time jitterSum
Contains the sum of all end-to-end delay jitter (delay variation) values for all received packets of ...
std::string SerializeToXmlString(int indent, bool enableHistograms, bool enableProbes)
Same as SerializeToXmlStream, but returns the output as a std::string.
bool m_enabled
FlowMon is enabled.
virtual void NotifyConstructionCompleted(void)
This method is invoked once all member attributes have been initialized.
void SetDefaultBinWidth(double binWidth)
Set the bin width.
Time timeFirstTxPacket
Contains the absolute time when the first packet in the flow was transmitted, i.e.
double m_packetSizeBinWidth
packet size bin width (for histograms)
FlowStats & GetStatsForFlow(FlowId flowId)
Get the stats for a given flow.
double m_jitterBinWidth
Jitter bin width (for histograms)
EventId m_stopEvent
Stop event.
Time lastSeenTime
absolute time when the packet was last seen by a probe
double m_delayBinWidth
Delay bin width (for histograms)
virtual void NotifyConstructionCompleted()
This method is invoked once all member attributes have been initialized.
void Stop(const Time &time)
Set the time, counting from the current time, from which to stop monitoring flows.
std::vector< Ptr< FlowProbe > > m_flowProbes
all the FlowProbes
Time timeFirstRxPacket
Contains the absolute time when the first packet in the flow was received by an end node...
static Time Now(void)
Return the "current simulation time".
uint32_t timesForwarded
Contains the number of times a packet has been reportedly forwarded, summed for all received packets ...
Time timeLastRxPacket
Contains the absolute time when the last packet in the flow was received, i.e.
void AddFlowClassifier(Ptr< FlowClassifier > classifier)
Add a FlowClassifier to be used by the flow monitor.
void StopRightNow()
End monitoring flows right now
#define NS_LOG_WARN(msg)
Use NS_LOG to output a message of level LOG_WARN.
Histogram delayHistogram
Histogram of the packet delays.
void SerializeToXmlFile(std::string fileName, bool enableHistograms, bool enableProbes)
Same as SerializeToXmlStream, but writes to a file instead.
std::vector< Ptr< FlowProbe > > GetAllProbes() const
Get a list of all FlowProbe's associated with this FlowMonitor.
#define NS_LOG_DEBUG(msg)
Use NS_LOG to output a message of level LOG_DEBUG.
virtual void DoDispose(void)
This method is called by Object::Dispose or by the object's destructor, whichever comes first...
Histogram flowInterruptionsHistogram
histogram of durations of flow interruptions
uint64_t txBytes
Total number of transmitted bytes for the flow.
Structure that represents the measured metrics of an individual packet flow.
double m_flowInterruptionsBinWidth
Flow interruptions bin width (for histograms)
Ptr< const AttributeChecker > MakeTimeChecker(const Time min, const Time max)
Helper to make a Time checker with bounded range.
Structure to represent a single tracked packet data.
Histogram jitterHistogram
Histogram of the packet jitters.
a base class which provides memory management and object aggregation
EventId m_startEvent
Start event.
void Start(const Time &time)
Set the time, counting from the current time, from which to start monitoring flows.
void ReportForwarding(Ptr< FlowProbe > probe, FlowId flowId, FlowPacketId packetId, uint32_t packetSize)
FlowProbe implementations are supposed to call this method to report that a known packet is being for...
uint64_t rxBytes
Total number of received bytes for the flow.
Hold a floating point type.
void AddValue(double value)
Add a value to the histogram.
void PeriodicCheckForLostPackets()
Periodic function to check for lost packets and prune statistics.
uint32_t timesForwarded
number of times the packet was reportedly forwarded
void AddProbe(Ptr< FlowProbe > probe)
Register a new FlowProbe that will begin monitoring and report events to this monitor.
a unique identifier for an interface.
Time timeLastTxPacket
Contains the absolute time when the last packet in the flow was transmitted, i.e. ...
TypeId SetParent(TypeId tid)
void ReportLastRx(Ptr< FlowProbe > probe, FlowId flowId, FlowPacketId packetId, uint32_t packetSize)
FlowProbe implementations are supposed to call this method to report that a known packet is being rec...
Histogram packetSizeHistogram
Histogram of the packet sizes.
TypeId GetInstanceTypeId() const
uint32_t FlowId
Abstract identifier of a packet flow.
std::vector< uint32_t > packetsDropped
This attribute also tracks the number of lost packets and bytes, but discriminates the losses by a re...