61 #include "ns3/uinteger.h"
62 #include "ns3/double.h"
63 #include "ns3/simulator.h"
64 #include "ns3/abort.h"
66 #include "ns3/drop-tail-queue.h"
67 #include "ns3/net-device-queue-interface.h"
79 .SetGroupName(
"TrafficControl")
81 .AddAttribute (
"Mode",
82 "Determines unit for QueueLimit",
87 .AddAttribute (
"MeanPktSize",
88 "Average of packet size",
91 MakeUintegerChecker<uint32_t> ())
92 .AddAttribute (
"IdlePktSize",
93 "Average packet size used during idle times. Used when m_cautions = 3",
96 MakeUintegerChecker<uint32_t> ())
97 .AddAttribute (
"Wait",
98 "True for waiting between dropped packets",
102 .AddAttribute (
"Gentle",
103 "True to increases dropping probability slowly when average queue exceeds maxthresh",
107 .AddAttribute (
"ARED",
108 "True to enable ARED",
112 .AddAttribute (
"AdaptMaxP",
113 "True to adapt m_curMaxP",
117 .AddAttribute (
"FengAdaptive",
118 "True to enable Feng's Adaptive RED",
122 .AddAttribute (
"NLRED",
123 "True to enable Nonlinear RED",
127 .AddAttribute (
"MinTh",
128 "Minimum average length threshold in packets/bytes",
131 MakeDoubleChecker<double> ())
132 .AddAttribute (
"MaxTh",
133 "Maximum average length threshold in packets/bytes",
136 MakeDoubleChecker<double> ())
137 .AddAttribute (
"QueueLimit",
138 "Queue limit in bytes/packets",
141 MakeUintegerChecker<uint32_t> ())
143 "Queue weight related to the exponential weighted moving average (EWMA)",
146 MakeDoubleChecker <double> ())
147 .AddAttribute (
"LInterm",
148 "The maximum probability of dropping a packet",
151 MakeDoubleChecker <double> ())
152 .AddAttribute (
"TargetDelay",
153 "Target average queuing delay in ARED",
157 .AddAttribute (
"Interval",
158 "Time interval to update m_curMaxP",
162 .AddAttribute (
"Top",
163 "Upper bound for m_curMaxP in ARED",
166 MakeDoubleChecker <double> (0, 1))
167 .AddAttribute (
"Bottom",
168 "Lower bound for m_curMaxP in ARED",
171 MakeDoubleChecker <double> (0, 1))
172 .AddAttribute (
"Alpha",
173 "Increment parameter for m_curMaxP in ARED",
176 MakeDoubleChecker <double> (0, 1))
177 .AddAttribute (
"Beta",
178 "Decrement parameter for m_curMaxP in ARED",
181 MakeDoubleChecker <double> (0, 1))
182 .AddAttribute (
"FengAlpha",
183 "Decrement parameter for m_curMaxP in Feng's Adaptive RED",
186 MakeDoubleChecker <double> ())
187 .AddAttribute (
"FengBeta",
188 "Increment parameter for m_curMaxP in Feng's Adaptive RED",
191 MakeDoubleChecker <double> ())
192 .AddAttribute (
"LastSet",
193 "Store the last time m_curMaxP was updated",
197 .AddAttribute (
"Rtt",
198 "Round Trip Time to be considered while automatically setting m_bottom",
202 .AddAttribute (
"Ns1Compat",
203 "NS-1 compatibility",
207 .AddAttribute (
"LinkBandwidth",
208 "The RED link bandwidth",
212 .AddAttribute (
"LinkDelay",
213 "The RED link delay",
217 .AddAttribute (
"UseEcn",
218 "True to use ECN (packets are marked instead of being dropped)",
222 .AddAttribute (
"UseHardDrop",
223 "True to always drop packets above max threshold",
236 m_uv = CreateObject<UniformRandomVariable> ();
274 NS_LOG_WARN (
"Alpha value is above the recommended bound!");
293 NS_LOG_WARN (
"Beta value is below the recommended bound!");
312 NS_LOG_WARN (
"Alpha value does not follow the recommendations!");
331 NS_LOG_WARN (
"Beta value does not follow the recommendations!");
371 uint32_t nQueued = 0;
395 m = uint32_t (ptc * (now -
m_idleTime).GetSeconds ());
523 if (
m_minTh < targetqueue / 2.0 )
549 m_vA = 1.0 / th_diff;
577 else if (
m_qW == -1.0)
585 m_qW = 1.0 - std::exp (-1.0 / (10 * rtt *
m_ptc));
587 else if (
m_qW == -2.0)
608 <<
"; m_isGentle " <<
m_isGentle <<
"; th_diff " << th_diff
609 <<
"; lInterm " <<
m_lInterm <<
"; va " <<
m_vA <<
"; cur_max_p "
647 if (newAve < m_minTh + m_part && m_curMaxP >
m_bottom)
672 double newAve = qAvg * pow(1.0-qW, m);
673 newAve += qW * nQueued;
705 double pkts =
m_ptc * 0.05;
706 double fraction = std::pow ((1 -
m_qW), pkts);
708 if ((
double) qSize < fraction *
m_qAvg)
725 double pkts =
m_ptc * 0.05;
726 double fraction = std::pow ((1 -
m_qW), pkts);
727 double ratio = qSize / (fraction *
m_qAvg);
801 double count1 = (double)
m_count;
810 if (count1 * p < 1.0)
814 else if (count1 * p < 2.0)
816 p /= (2.0 - count1 * p);
825 if (count1 * p < 1.0)
827 p /= (1.0 - count1 * p);
923 NS_LOG_ERROR (
"RedQueueDisc cannot have packet filters");
951 NS_LOG_ERROR (
"The mode of the provided queue does not match the mode set on the RedQueueDisc");
958 NS_LOG_ERROR (
"The size of the internal queue differs from the queue disc limit");
964 NS_LOG_ERROR (
"m_isAdaptMaxP and m_isFengAdaptive cannot be simultaneously true");
void SetMode(QueueDiscMode mode)
Set the operating mode of this queue disc.
bool m_isGentle
True to increase dropping prob.
Simulation virtual time values and global simulation resolution.
uint32_t GetQueueSize(void)
Get the current value of the queue in bytes or packets.
uint32_t GetNQueueDiscClasses(void) const
Get the number of queue disc classes.
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 "...
void SetStream(int64_t stream)
Specifies the stream number for the RngStream.
double m_beta
Decrement parameter for m_curMaxP in ARED.
AttributeValue implementation for Boolean.
uint32_t m_count
Number of packets since last random number generation.
#define NS_ABORT_MSG(msg)
Unconditional abnormal program termination with a message.
void DropBeforeEnqueue(Ptr< const QueueDiscItem > item, const char *reason)
Perform the actions required when the queue disc is notified of a packet dropped before enqueue...
#define NS_OBJECT_ENSURE_REGISTERED(type)
Register an Object subclass with the TypeId system.
bool m_isARED
True to enable Adaptive RED.
void SetTh(double minTh, double maxTh)
Set the thresh limits of RED.
virtual bool DoEnqueue(Ptr< QueueDiscItem > item)
This function actually enqueues a packet into the queue disc.
uint32_t GetNBytes(void) const
Get the amount of bytes stored by the queue disc.
double GetFengAdaptiveA(void)
Get the alpha value to adapt m_curMaxP in Feng's Adaptive RED.
double m_qAvg
Average queue length.
bool Mark(Ptr< QueueDiscItem > item, const char *reason)
Marks the given packet and, if successful, updates the counters associated with the given reason...
Time m_linkDelay
Link delay.
Ptr< const AttributeAccessor > MakeEnumAccessor(T1 a1)
Create an AttributeAccessor for a class data member, or a lone class get functor or set method...
Ptr< const AttributeAccessor > MakeBooleanAccessor(T1 a1)
Create an AttributeAccessor for a class data member, or a lone class get functor or set method...
void SetAredBeta(double beta)
Set the beta value to adapt m_curMaxP.
#define NS_ASSERT(condition)
At runtime, in debugging builds, if this condition is not true, the program prints the source file...
uint32_t m_idle
0/1 idle status
FengStatus m_fengStatus
For use in Feng's Adaptive RED.
#define NS_LOG_COMPONENT_DEFINE(name)
Define a Log component with a specific name.
Time MilliSeconds(uint64_t value)
Construct a Time in the indicated unit.
QueueDiscMode GetMode(void)
Get the operating mode of this queue disc.
double m_vD
2.0 * m_curMaxP - 1.0 - used in "gentle" mode
void SetFengAdaptiveB(double b)
Set the beta value to adapt m_curMaxP in Feng's Adaptive RED.
#define NS_LOG_INFO(msg)
Use NS_LOG to output a message of level LOG_INFO.
double m_vC
(1.0 - m_curMaxP) / m_maxTh - used in "gentle" mode
bool m_useHardDrop
True if packets are always dropped above max threshold.
double m_qW
Queue weight given to cur queue size sample.
static constexpr const char * FORCED_MARK
Forced marks, m_qAvg > m_maxTh.
QueueDisc is an abstract base class providing the interface and implementing the operations common to...
double m_b
Increment parameter for m_curMaxP in Feng's Adaptive RED.
static constexpr const char * FORCED_DROP
Forced drops, m_qAvg > m_maxTh.
int64_t AssignStreams(int64_t stream)
Assign a fixed random variable stream number to the random variables used by this model...
double GetAredAlpha(void)
Get the alpha value to adapt m_curMaxP.
Time m_rtt
Rtt to be considered while automatically setting m_bottom in ARED.
Use number of packets for maximum queue size.
static constexpr const char * UNFORCED_DROP
Early probability drops.
double m_alpha
Increment parameter for m_curMaxP in ARED.
Time m_lastSet
Last time m_curMaxP was updated.
bool m_isAdaptMaxP
True to adapt m_curMaxP.
Ptr< const AttributeChecker > MakeDataRateChecker(void)
Ptr< InternalQueue > GetInternalQueue(uint32_t i) const
Get the i-th internal queue.
Ptr< const AttributeChecker > MakeTimeChecker(const Time min, const Time max)
Helper to make a Time checker with bounded range.
static TypeId GetTypeId(void)
Get the type ID.
Class for representing data rates.
double m_curMaxP
Current max_p.
double GetSeconds(void) const
Get an approximation of the time stored in this instance in the indicated unit.
void SetQueueLimit(uint32_t lim)
Set the limit of the queue.
uint32_t GetNInternalQueues(void) const
Get the number of internal queues.
void AddInternalQueue(Ptr< InternalQueue > queue)
Add an internal queue to the tail of the list of queues.
Time m_idleTime
Start of current idle period.
Hold variables of type enum.
AttributeValue implementation for Time.
double GetFengAdaptiveB(void)
Get the beta value to adapt m_curMaxP in Feng's Adaptive RED.
uint32_t m_queueLimit
Queue limit in bytes / packets.
Time NanoSeconds(uint64_t value)
Construct a Time in the indicated unit.
virtual bool CheckConfig(void)
Check whether the current configuration is correct.
Hold an unsigned integer type.
virtual void InitializeParams(void)
Initialize the queue parameters.
uint32_t m_cautious
0 for default RED 1 experimental (see red-queue-disc.cc) 2 experimental (see red-queue-disc.cc) 3 use Idle packet size in the ptc
Ptr< UniformRandomVariable > m_uv
rng stream
double m_vB
-m_minTh / (m_maxTh - m_minTh)
virtual void DoDispose(void)
Dispose of the object.
bool m_isNonlinear
True to enable Nonlinear RED.
uint32_t GetNPacketFilters(void) const
Get the number of packet filters.
Ptr< const AttributeAccessor > MakeDataRateAccessor(T1 a1)
Create an AttributeAccessor for a class data member, or a lone class get functor or set method...
bool m_useEcn
True if ECN is used (packets are marked instead of being dropped)
double m_minTh
Minimum threshold for m_qAvg (bytes or packets)
Use number of bytes for maximum queue disc size.
uint32_t m_idlePktSize
Avg pkt size used during idle times.
Every class exported by the ns3 library is enclosed in the ns3 namespace.
double m_vA
1.0 / (m_maxTh - m_minTh)
uint32_t m_countBytes
Number of bytes since last drop.
QueueDiscMode
Enumeration of the modes supported in the class.
Ptr< const AttributeChecker > MakeBooleanChecker(void)
double m_lInterm
The max probability of dropping a packet.
uint64_t GetBitRate() const
Get the underlying bitrate.
static constexpr const char * UNFORCED_MARK
Early probability marks.
uint32_t DropEarly(Ptr< QueueDiscItem > item, uint32_t qSize)
Check if a packet needs to be dropped due to probability mark.
RedQueueDisc()
RedQueueDisc Constructor.
double m_bottom
Lower bound for m_curMaxP in ARED.
Use number of bytes for maximum queue size.
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.
virtual Ptr< QueueDiscItem > DoDequeue(void)
This function actually extracts a packet from the queue disc.
NS_LOG_LOGIC("Net device "<< nd<< " is not bridged")
void UpdateMaxP(double newAve)
Update m_curMaxP.
Ptr< const AttributeAccessor > MakeDoubleAccessor(T1 a1)
Create an AttributeAccessor for a class data member, or a lone class get functor or set method...
uint32_t m_old
0 when average queue first exceeds threshold
Ptr< const AttributeChecker > MakeEnumChecker(int v1, std::string n1, int v2, std::string n2, int v3, std::string n3, int v4, std::string n4, int v5, std::string n5, int v6, std::string n6, int v7, std::string n7, int v8, std::string n8, int v9, std::string n9, int v10, std::string n10, int v11, std::string n11, int v12, std::string n12, int v13, std::string n13, int v14, std::string n14, int v15, std::string n15, int v16, std::string n16, int v17, std::string n17, int v18, std::string n18, int v19, std::string n19, int v20, std::string n20, int v21, std::string n21, int v22, std::string n22)
Make an EnumChecker pre-configured with a set of allowed values by name.
void SetFengAdaptiveA(double a)
Set the alpha value to adapt m_curMaxP in Feng's Adaptive RED.
QueueDiscMode m_mode
Mode (Bytes or packets)
#define NS_LOG_WARN(msg)
Use NS_LOG to output a message of level LOG_WARN.
AttributeValue implementation for DataRate.
An "unforced" (random) drop.
DataRate m_linkBandwidth
Link bandwidth.
#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.
Time m_interval
Time interval to update m_curMaxP.
bool m_isWait
True for waiting between dropped packets.
Time m_targetDelay
Target average queuing delay in ARED.
double GetAredBeta(void)
Get the beta value to adapt m_curMaxP.
double m_ptc
packet time constant in packets/second
virtual ~RedQueueDisc()
Destructor.
#define NS_LOG_ERROR(msg)
Use NS_LOG to output a message of level LOG_ERROR.
double m_top
Upper bound for m_curMaxP in ARED.
double Estimator(uint32_t nQueued, uint32_t m, double qAvg, double qW)
Compute the average queue size.
uint32_t m_meanPktSize
Avg pkt size.
void UpdateMaxPFeng(double newAve)
Update m_curMaxP based on Feng's Adaptive RED.
bool m_isFengAdaptive
True to enable Feng's Adaptive RED.
double CalculatePNew(void)
Returns a probability using these function parameters for the DropEarly function. ...
void SetAredAlpha(double alpha)
Set the alpha value to adapt m_curMaxP.
virtual Ptr< const QueueDiscItem > DoPeek(void) const
This function returns a copy of the next packet the queue disc will extract.
This class can be used to hold variables of floating point type such as 'double' or 'float'...
virtual void DoDispose(void)
Dispose of the object.
double ModifyP(double p, uint32_t size)
Returns a probability using these function parameters for the DropEarly function. ...
Ptr< const AttributeAccessor > MakeUintegerAccessor(T1 a1)
Create an AttributeAccessor for a class data member, or a lone class get functor or set method...
a unique identifier for an interface.
TypeId SetParent(TypeId tid)
Set the parent TypeId.
Use number of packets for maximum queue disc size.
double m_maxTh
Maximum threshold for m_qAvg (bytes or packets), should be >= 2 * m_minTh.
When m_maxTh < m_qAvg < m_minTh.
double m_a
Decrement parameter for m_curMaxP in Feng's Adaptive RED.
uint32_t GetNPackets(void) const
Get the number of packets stored by the queue disc.
bool m_isNs1Compat
Ns-1 compatibility.