22 #include "ns3/simulator.h" 24 #include "ns3/double.h" 28 #define PERIODIC_CHECK_INTERVAL (Seconds (1)) 41 .SetGroupName (
"FlowMonitor")
43 .AddAttribute (
"MaxPerHopDelay", (
"The maximum per-hop delay that should be considered. " 44 "Packets still not received after this delay are to be considered lost."),
48 .AddAttribute (
"StartTime", (
"The time when the monitoring starts."),
52 .AddAttribute (
"DelayBinWidth", (
"The width used in the delay histogram."),
55 MakeDoubleChecker <double> ())
56 .AddAttribute (
"JitterBinWidth", (
"The width used in the jitter histogram."),
59 MakeDoubleChecker <double> ())
60 .AddAttribute (
"PacketSizeBinWidth", (
"The width used in the packetSize histogram."),
63 MakeDoubleChecker <double> ())
64 .AddAttribute (
"FlowInterruptionsBinWidth", (
"The width used in the flowInterruptions histogram."),
67 MakeDoubleChecker <double> ())
68 .AddAttribute (
"FlowInterruptionsMinTime", (
"The minimum inter-arrival time that is considered a flow interruption."),
153 NS_LOG_DEBUG (
"ReportFirstTx: adding tracked packet (flowId=" << flowId <<
", packetId=" << packetId
178 std::pair<FlowId, FlowPacketId> key (flowId, packetId);
182 NS_LOG_WARN (
"Received packet forward report (flowId=" << flowId <<
", packetId=" << packetId
183 <<
") but not known to be transmitted.");
187 tracked->second.timesForwarded++;
204 TrackedPacketMap::iterator tracked =
m_trackedPackets.find (std::make_pair (flowId, packetId));
207 NS_LOG_WARN (
"Received packet last-tx report (flowId=" << flowId <<
", packetId=" << packetId
208 <<
") but not known to be transmitted.");
213 Time delay = (now - tracked->second.firstSeenTime);
254 NS_LOG_DEBUG (
"ReportLastTx: removing tracked packet (flowId=" 255 << flowId <<
", packetId=" << packetId <<
").");
284 TrackedPacketMap::iterator tracked =
m_trackedPackets.find (std::make_pair (flowId, packetId));
289 NS_LOG_DEBUG (
"ReportDrop: removing tracked packet (flowId=" 290 << flowId <<
", packetId=" << packetId <<
").");
311 if (now - iter->second.lastSeenTime >= maxDelay)
316 flow->second.lostPackets++;
368 NS_LOG_DEBUG (
"FlowMonitor already enabled; returning");
392 NS_LOG_DEBUG (
"FlowMonitor already enabled; returning");
424 os << std::string (
indent,
' ' ) <<
"<FlowMonitor>\n";
426 os << std::string (
indent,
' ' ) <<
"<FlowStats>\n";
431 os << std::string (
indent,
' ' );
432 #define ATTRIB(name) << " " # name "=\"" << flowI->second.name << "\"" 433 os <<
"<Flow flowId=\"" << flowI->first <<
"\"" 434 ATTRIB (timeFirstTxPacket)
435 ATTRIB (timeFirstRxPacket)
451 for (uint32_t reasonCode = 0; reasonCode < flowI->second.packetsDropped.size (); reasonCode++)
453 os << std::string (
indent,
' ' );
454 os <<
"<packetsDropped reasonCode=\"" << reasonCode <<
"\"" 455 <<
" number=\"" << flowI->second.packetsDropped[reasonCode]
458 for (uint32_t reasonCode = 0; reasonCode < flowI->second.bytesDropped.size (); reasonCode++)
460 os << std::string (
indent,
' ' );
461 os <<
"<bytesDropped reasonCode=\"" << reasonCode <<
"\"" 462 <<
" bytes=\"" << flowI->second.bytesDropped[reasonCode]
465 if (enableHistograms)
467 flowI->second.delayHistogram.SerializeToXmlStream (os,
indent,
"delayHistogram");
468 flowI->second.jitterHistogram.SerializeToXmlStream (os,
indent,
"jitterHistogram");
469 flowI->second.packetSizeHistogram.SerializeToXmlStream (os,
indent,
"packetSizeHistogram");
470 flowI->second.flowInterruptionsHistogram.SerializeToXmlStream (os,
indent,
"flowInterruptionsHistogram");
474 os << std::string (
indent,
' ' ) <<
"</Flow>\n";
477 os << std::string (
indent,
' ' ) <<
"</FlowStats>\n";
483 (*iter)->SerializeToXmlStream (os,
indent);
488 os << std::string (
indent,
' ' ) <<
"<FlowProbes>\n";
495 os << std::string (
indent,
' ' ) <<
"</FlowProbes>\n";
499 os << std::string (
indent,
' ' ) <<
"</FlowMonitor>\n";
507 std::ostringstream os;
516 NS_LOG_FUNCTION (
this << fileName << enableHistograms << enableProbes);
517 std::ofstream os (fileName.c_str (), std::ios::out|std::ios::binary);
518 os <<
"<?xml version=\"1.0\" ?>\n";
#define PERIODIC_CHECK_INTERVAL
static EventId Schedule(Time const &delay, FUNC f, Ts &&... args)
Schedule an event to expire after delay.
Simulation virtual time values and global simulation resolution.
Smart pointer class similar to boost::intrusive_ptr.
#define NS_LOG_FUNCTION(parameters)
If log level LOG_FUNCTION is enabled, this macro will output all input parameters separated by "...
#define NS_OBJECT_ENSURE_REGISTERED(type)
Register an Object subclass with the TypeId system.
virtual TypeId GetInstanceTypeId() const
Get the most derived TypeId for this Object.
void CheckForLostPackets()
Check right now for packets that appear to be lost.
static const uint32_t packetSize
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.
double GetSeconds(void) const
Get an approximation of the time stored in this instance in the indicated unit.
#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.
const FlowStatsContainer & GetFlowStats() const
Retrieve all collected the flow statistics.
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...
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...
virtual void DoDispose(void)
Destructor implementation.
TimeWithUnit As(const enum Unit unit) const
Attach a unit to a Time, to facilitate output in a specific unit.
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.
void AddPacketStats(FlowId flowId, uint32_t packetSize, Time delayFromFirstProbe)
Add a packet data to the flow stats.
std::string SerializeToXmlString(uint16_t indent, bool enableHistograms, bool enableProbes)
Same as SerializeToXmlStream, but returns the output as a std::string.
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.
const FlowProbeContainer & GetAllProbes() const
Get a list of all FlowProbe's associated with this FlowMonitor.
FlowStatsContainer m_flowStats
FlowId –> FlowStats.
Time lastDelay
Contains the last measured delay of a packet It is stored to measure the packet's Jitter...
def indent(source, debug, level)
std::map< FlowId, FlowStats > FlowStatsContainer
Container: FlowId, FlowStats.
Time firstSeenTime
absolute time when the packet was first seen by a probe
AttributeValue implementation for 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 ...
bool m_enabled
FlowMon is enabled.
virtual void NotifyConstructionCompleted(void)
Notifier called once the ObjectBase is fully constructed.
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.
std::map< FlowId, FlowStats >::const_iterator FlowStatsContainerCI
Container Const Iterator: FlowId, FlowStats.
Time lastSeenTime
absolute time when the packet was last seen by a probe
double m_delayBinWidth
Delay bin width (for histograms)
Every class exported by the ns3 library is enclosed in the ns3 namespace.
virtual void NotifyConstructionCompleted()
Notifier called once the ObjectBase is fully constructed.
void Stop(const Time &time)
Set the time, counting from the current time, from which to stop monitoring flows.
void AddPacketDropStats(FlowId flowId, uint32_t packetSize, uint32_t reasonCode)
Add a packet drop data to the flow stats.
Time timeFirstRxPacket
Contains the absolute time when the first packet in the flow was received by an end node...
Ptr< const AttributeAccessor > MakeTimeAccessor(T1 a1)
Create an AttributeAccessor for a class data member, or a lone class get functor or set method...
static Time Now(void)
Return the current simulation virtual time.
uint32_t timesForwarded
Contains the number of times a packet has been reportedly forwarded, summed for all received packets ...
std::map< FlowId, FlowStats >::iterator FlowStatsContainerI
Container Iterator: FlowId, FlowStats.
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.
Ptr< const AttributeAccessor > MakeDoubleAccessor(T1 a1)
Create an AttributeAccessor for a class data member, or a lone class get functor or set method...
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.
#define NS_LOG_DEBUG(msg)
Use NS_LOG to output a message of level LOG_DEBUG.
Time Seconds(double value)
Construct a Time in the indicated unit.
virtual void DoDispose(void)
Destructor implementation.
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.
This class can be used to hold variables of floating point type such as 'double' or 'float'...
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
An object that monitors and reports back packet flows observed during a simulation.
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.
std::vector< Ptr< FlowProbe > > FlowProbeContainer
Container: FlowProbe.
Time timeLastTxPacket
Contains the absolute time when the last packet in the flow was transmitted, i.e. ...
TypeId SetParent(TypeId tid)
Set the parent TypeId.
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.
FlowProbeContainer m_flowProbes
all the FlowProbes
void SerializeToXmlStream(std::ostream &os, uint16_t indent, bool enableHistograms, bool enableProbes)
Serializes the results to an std::ostream in XML format.
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...