Implements PIE Active Queue Management discipline. More...
#include "pie-queue-disc.h"
Public Types | |
enum | BurstStateT { NO_BURST, IN_BURST, IN_BURST_PROTECTING } |
Burst types. More... | |
Public Types inherited from ns3::QueueDisc | |
typedef Queue< QueueDiscItem > | InternalQueue |
Internal queues store QueueDiscItem objects. More... | |
enum | WakeMode { WAKE_ROOT = 0x00, WAKE_CHILD = 0x01 } |
Used to determine whether the queue disc itself or its children must be activated when a netdevice wakes a transmission queue. More... | |
Public Member Functions | |
PieQueueDisc () | |
PieQueueDisc Constructor. More... | |
virtual | ~PieQueueDisc () |
PieQueueDisc Destructor. More... | |
int64_t | AssignStreams (int64_t stream) |
Assign a fixed random variable stream number to the random variables used by this model. More... | |
Time | GetQueueDelay (void) |
Get queue delay. More... | |
Public Member Functions inherited from ns3::QueueDisc | |
QueueDisc (QueueDiscSizePolicy policy=QueueDiscSizePolicy::SINGLE_INTERNAL_QUEUE) | |
Constructor. More... | |
QueueDisc (QueueDiscSizePolicy policy, QueueSizeUnit unit) | |
Constructor. More... | |
virtual | ~QueueDisc () |
void | AddInternalQueue (Ptr< InternalQueue > queue) |
Add an internal queue to the tail of the list of queues. More... | |
void | AddPacketFilter (Ptr< PacketFilter > filter) |
Add a packet filter to the tail of the list of filters used to classify packets. More... | |
void | AddQueueDiscClass (Ptr< QueueDiscClass > qdClass) |
Add a queue disc class to the tail of the list of classes. More... | |
int32_t | Classify (Ptr< QueueDiscItem > item) |
Classify a packet by calling the packet filters, one at a time, until either a filter able to classify the packet is found or all the filters have been processed. More... | |
Ptr< QueueDiscItem > | Dequeue (void) |
Extract from the queue disc the packet that has been dequeued by calling Peek, if any, or call the private DoDequeue method (which must be implemented by derived classes) to dequeue a packet, otherwise. More... | |
bool | Enqueue (Ptr< QueueDiscItem > item) |
Pass a packet to store to the queue discipline. More... | |
QueueSize | GetCurrentSize (void) |
Get the current size of the queue disc in bytes, if operating in bytes mode, or packets, otherwise. More... | |
Ptr< InternalQueue > | GetInternalQueue (std::size_t i) const |
Get the i-th internal queue. More... | |
QueueSize | GetMaxSize (void) const |
Get the maximum size of the queue disc. More... | |
uint32_t | GetNBytes (void) const |
Get the amount of bytes stored by the queue disc. More... | |
Ptr< NetDevice > | GetNetDevice (void) const |
Get the NetDevice on which this queue discipline is installed. More... | |
std::size_t | GetNInternalQueues (void) const |
Get the number of internal queues. More... | |
std::size_t | GetNPacketFilters (void) const |
Get the number of packet filters. More... | |
uint32_t | GetNPackets (void) const |
Get the number of packets stored by the queue disc. More... | |
std::size_t | GetNQueueDiscClasses (void) const |
Get the number of queue disc classes. More... | |
Ptr< PacketFilter > | GetPacketFilter (std::size_t i) const |
Get the i-th packet filter. More... | |
Ptr< QueueDiscClass > | GetQueueDiscClass (std::size_t i) const |
Get the i-th queue disc class. More... | |
virtual uint32_t | GetQuota (void) const |
Get the maximum number of dequeue operations following a packet enqueue. More... | |
const Stats & | GetStats (void) |
Retrieve all the collected statistics. More... | |
virtual WakeMode | GetWakeMode (void) const |
When setting up the wake callbacks on the netdevice queues, it is necessary to determine which queue disc (the root queue disc or one of its children) should be activated when the netdevice wakes one of its transmission queues. More... | |
Ptr< const QueueDiscItem > | Peek (void) |
Get a copy of the next packet the queue discipline will extract. More... | |
void | Run (void) |
Modelled after the Linux function __qdisc_run (net/sched/sch_generic.c) Dequeues multiple packets, until a quota is exceeded or sending a packet to the device failed. More... | |
bool | SetMaxSize (QueueSize size) |
Set the maximum size of the queue disc. More... | |
void | SetNetDevice (Ptr< NetDevice > device) |
Set the NetDevice on which this queue discipline is installed. More... | |
virtual void | SetQuota (const uint32_t quota) |
Set the maximum number of dequeue operations following a packet enqueue. More... | |
Public Member Functions inherited from ns3::Object | |
Object () | |
Constructor. More... | |
virtual | ~Object () |
Destructor. More... | |
void | AggregateObject (Ptr< Object > other) |
Aggregate two Objects together. More... | |
void | Dispose (void) |
Dispose of this Object. More... | |
AggregateIterator | GetAggregateIterator (void) const |
Get an iterator to the Objects aggregated to this one. More... | |
virtual TypeId | GetInstanceTypeId (void) const |
Get the most derived TypeId for this Object. More... | |
template<typename T > | |
Ptr< T > | GetObject (void) const |
Get a pointer to the requested aggregated Object. More... | |
template<typename T > | |
Ptr< T > | GetObject (TypeId tid) const |
Get a pointer to the requested aggregated Object by TypeId. More... | |
void | Initialize (void) |
Invoke DoInitialize on all Objects aggregated to this one. More... | |
bool | IsInitialized (void) const |
Check if the object has been initialized. More... | |
Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter > | |
SimpleRefCount () | |
Default constructor. More... | |
SimpleRefCount (const SimpleRefCount &o) | |
Copy constructor. More... | |
uint32_t | GetReferenceCount (void) const |
Get the reference count of the object. More... | |
SimpleRefCount & | operator= (const SimpleRefCount &o) |
Assignment operator. More... | |
void | Ref (void) const |
Increment the reference count. More... | |
void | Unref (void) const |
Decrement the reference count. More... | |
Public Member Functions inherited from ns3::ObjectBase | |
virtual | ~ObjectBase () |
Virtual destructor. More... | |
void | GetAttribute (std::string name, AttributeValue &value) const |
Get the value of an attribute, raising fatal errors if unsuccessful. More... | |
bool | GetAttributeFailSafe (std::string name, AttributeValue &value) const |
Get the value of an attribute without raising erros. More... | |
void | SetAttribute (std::string name, const AttributeValue &value) |
Set a single attribute, raising fatal errors if unsuccessful. More... | |
bool | SetAttributeFailSafe (std::string name, const AttributeValue &value) |
Set a single attribute without raising errors. More... | |
bool | TraceConnect (std::string name, std::string context, const CallbackBase &cb) |
Connect a TraceSource to a Callback with a context. More... | |
bool | TraceConnectWithoutContext (std::string name, const CallbackBase &cb) |
Connect a TraceSource to a Callback without a context. More... | |
bool | TraceDisconnect (std::string name, std::string context, const CallbackBase &cb) |
Disconnect from a TraceSource a Callback previously connected with a context. More... | |
bool | TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb) |
Disconnect from a TraceSource a Callback previously connected without a context. More... | |
Static Public Member Functions | |
static TypeId | GetTypeId (void) |
Get the type ID. More... | |
Static Public Member Functions inherited from ns3::QueueDisc | |
static TypeId | GetTypeId (void) |
Get the type ID. More... | |
Static Public Member Functions inherited from ns3::Object | |
static TypeId | GetTypeId (void) |
Register this type. More... | |
Static Public Member Functions inherited from ns3::ObjectBase | |
static TypeId | GetTypeId (void) |
Get the type ID. More... | |
Static Public Attributes | |
static constexpr const char * | FORCED_DROP = "Forced drop" |
Drops due to queue limit: reactive. More... | |
static constexpr const char * | UNFORCED_DROP = "Unforced drop" |
Early probability drops: proactive. More... | |
Static Public Attributes inherited from ns3::QueueDisc | |
static constexpr const char * | CHILD_QUEUE_DISC_DROP = "(Dropped by child queue disc) " |
Packet dropped by a child queue disc. More... | |
static constexpr const char * | INTERNAL_QUEUE_DROP = "Dropped by internal queue" |
Packet dropped by an internal queue. More... | |
Protected Member Functions | |
virtual void | DoDispose (void) |
Dispose of the object. More... | |
Protected Member Functions inherited from ns3::QueueDisc | |
void | DoInitialize (void) |
Check whether the configuration is correct and initialize parameters. More... | |
void | DropAfterDequeue (Ptr< const QueueDiscItem > item, const char *reason) |
Perform the actions required when the queue disc is notified of a packet dropped after dequeue. More... | |
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. More... | |
bool | Mark (Ptr< QueueDiscItem > item, const char *reason) |
Marks the given packet and, if successful, updates the counters associated with the given reason. More... | |
Protected Member Functions inherited from ns3::Object | |
Object (const Object &o) | |
Copy an Object. More... | |
virtual void | NotifyNewAggregate (void) |
Notify all Objects aggregated to this one of a new Object being aggregated. More... | |
Protected Member Functions inherited from ns3::ObjectBase | |
void | ConstructSelf (const AttributeConstructionList &attributes) |
Complete construction of ObjectBase; invoked by derived classes. More... | |
virtual void | NotifyConstructionCompleted (void) |
Notifier called once the ObjectBase is fully constructed. More... | |
Private Member Functions | |
void | CalculateP () |
Periodically update the drop probability based on the delay samples: not only the current delay sample but also the trend where the delay is going, up or down. More... | |
virtual bool | CheckConfig (void) |
Check whether the current configuration is correct. More... | |
virtual Ptr< QueueDiscItem > | DoDequeue (void) |
This function actually extracts a packet from the queue disc. More... | |
virtual bool | DoEnqueue (Ptr< QueueDiscItem > item) |
This function actually enqueues a packet into the queue disc. More... | |
bool | DropEarly (Ptr< QueueDiscItem > item, uint32_t qSize) |
Check if a packet needs to be dropped due to probability drop. More... | |
virtual void | InitializeParams (void) |
Initialize the queue parameters. More... | |
Private Attributes | |
double | m_a |
Parameter to pie controller. More... | |
double | m_avgDqRate |
Time averaged dequeue rate. More... | |
double | m_b |
Parameter to pie controller. More... | |
Time | m_burstAllowance |
Current max burst value in seconds that is allowed before random drops kick in. More... | |
uint32_t | m_burstReset |
Used to reset value of burst allowance. More... | |
BurstStateT | m_burstState |
Used to determine the current state of burst. More... | |
uint64_t | m_dqCount |
Number of bytes departed since current measurement cycle starts. More... | |
double | m_dqStart |
Start timestamp of current measurement cycle. More... | |
uint32_t | m_dqThreshold |
Minimum queue size in bytes before dequeue rate is measured. More... | |
double | m_dropProb |
Variable used in calculation of drop probability. More... | |
bool | m_inMeasurement |
Indicates whether we are in a measurement cycle. More... | |
Time | m_maxBurst |
Maximum burst allowed before random early dropping kicks in. More... | |
uint32_t | m_meanPktSize |
Average packet size in bytes. More... | |
Time | m_qDelay |
Current value of queue delay. More... | |
Time | m_qDelayOld |
Old value of queue delay. More... | |
Time | m_qDelayRef |
Desired queue delay. More... | |
EventId | m_rtrsEvent |
Event used to decide the decision of interval of drop probability calculation. More... | |
Time | m_sUpdate |
Start time of the update timer. More... | |
Time | m_tUpdate |
Time period after which CalculateP () is called. More... | |
Ptr< UniformRandomVariable > | m_uv |
Rng stream. More... | |
Static Private Attributes | |
static const uint64_t | DQCOUNT_INVALID = std::numeric_limits<uint64_t>::max() |
Invalid dqCount value. More... | |
Additional Inherited Members | |
Related Functions inherited from ns3::ObjectBase | |
static TypeId | GetObjectIid (void) |
Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. More... | |
Implements PIE Active Queue Management discipline.
Introspection did not find any typical Config paths.
No TraceSources are defined for this type.
Size of this type is 1104 bytes (on a 64-bit architecture).
Definition at line 51 of file pie-queue-disc.h.
Burst types.
Enumerator | |
---|---|
NO_BURST | |
IN_BURST | |
IN_BURST_PROTECTING |
Definition at line 73 of file pie-queue-disc.h.
ns3::PieQueueDisc::PieQueueDisc | ( | ) |
PieQueueDisc Constructor.
Definition at line 101 of file pie-queue-disc.cc.
References CalculateP(), m_rtrsEvent, m_sUpdate, m_uv, NS_LOG_FUNCTION, and ns3::Simulator::Schedule().
|
virtual |
PieQueueDisc Destructor.
Definition at line 109 of file pie-queue-disc.cc.
References NS_LOG_FUNCTION.
int64_t ns3::PieQueueDisc::AssignStreams | ( | int64_t | stream | ) |
Assign a fixed random variable stream number to the random variables used by this model.
Return the number of streams (possibly zero) that have been assigned.
stream | first stream index to use |
Definition at line 131 of file pie-queue-disc.cc.
References m_uv, NS_LOG_FUNCTION, and ns3::RandomVariableStream::SetStream().
|
private |
Periodically update the drop probability based on the delay samples: not only the current delay sample but also the trend where the delay is going, up or down.
Definition at line 234 of file pie-queue-disc.cc.
References BURST_RESET_TIMEOUT, DQCOUNT_INVALID, ns3::QueueDisc::GetInternalQueue(), ns3::QueueDisc::GetNBytes(), ns3::Time::GetSeconds(), IN_BURST, IN_BURST_PROTECTING, m_a, m_avgDqRate, m_b, m_burstAllowance, m_burstReset, m_burstState, m_dqCount, m_dropProb, m_qDelay, m_qDelayOld, m_qDelayRef, m_rtrsEvent, m_tUpdate, NO_BURST, NS_LOG_FUNCTION, ns3::Simulator::Schedule(), and ns3::Seconds().
Referenced by PieQueueDisc().
|
privatevirtual |
Check whether the current configuration is correct.
Default objects (such as internal queues) might be created by this method to ensure the configuration is correct.
Implements ns3::QueueDisc.
Definition at line 410 of file pie-queue-disc.cc.
References ns3::QueueDisc::AddInternalQueue(), ns3::CreateObjectWithAttributes(), ns3::QueueDisc::GetMaxSize(), ns3::QueueDisc::GetNInternalQueues(), ns3::QueueDisc::GetNPacketFilters(), ns3::QueueDisc::GetNQueueDiscClasses(), NS_LOG_ERROR, and NS_LOG_FUNCTION.
|
privatevirtual |
This function actually extracts a packet from the queue disc.
Implements ns3::QueueDisc.
Definition at line 345 of file pie-queue-disc.cc.
References ns3::QueueDisc::GetInternalQueue(), ns3::QueueDisc::GetNBytes(), ns3::Time::GetSeconds(), m_avgDqRate, m_dqCount, m_dqStart, m_dqThreshold, m_inMeasurement, ns3::Simulator::Now(), NS_LOG_FUNCTION, and NS_LOG_LOGIC().
|
protectedvirtual |
Dispose of the object.
Reimplemented from ns3::QueueDisc.
Definition at line 115 of file pie-queue-disc.cc.
References ns3::QueueDisc::DoDispose(), m_rtrsEvent, m_uv, NS_LOG_FUNCTION, and ns3::Simulator::Remove().
|
privatevirtual |
This function actually enqueues a packet into the queue disc.
item | item to enqueue |
Implements ns3::QueueDisc.
Definition at line 139 of file pie-queue-disc.cc.
References ns3::QueueDisc::DropBeforeEnqueue(), DropEarly(), FORCED_DROP, ns3::QueueDisc::GetCurrentSize(), ns3::QueueDisc::GetInternalQueue(), ns3::QueueDisc::GetMaxSize(), ns3::QueueDisc::GetNBytes(), ns3::QueueDisc::GetNPackets(), ns3::QueueSize::GetValue(), NS_LOG_FUNCTION, NS_LOG_LOGIC(), and UNFORCED_DROP.
|
private |
Check if a packet needs to be dropped due to probability drop.
item | queue item |
qSize | queue size |
Definition at line 183 of file pie-queue-disc.cc.
References ns3::BYTES, ns3::QueueDisc::GetMaxSize(), ns3::Time::GetSeconds(), ns3::QueueSize::GetUnit(), ns3::UniformRandomVariable::GetValue(), IN_BURST_PROTECTING, m_burstAllowance, m_burstState, m_dropProb, m_maxBurst, m_meanPktSize, m_qDelayOld, m_qDelayRef, m_uv, NO_BURST, NS_LOG_FUNCTION, ns3::PACKETS, and packetSize.
Referenced by DoEnqueue().
Time ns3::PieQueueDisc::GetQueueDelay | ( | void | ) |
Get queue delay.
Definition at line 124 of file pie-queue-disc.cc.
References m_qDelay, and NS_LOG_FUNCTION.
|
static |
Get the type ID.
Definition at line 44 of file pie-queue-disc.cc.
References ns3::QueueDisc::GetMaxSize(), m_a, m_b, m_dqThreshold, m_maxBurst, m_meanPktSize, m_qDelayRef, m_sUpdate, m_tUpdate, ns3::MakeDoubleAccessor(), ns3::MakeQueueSizeAccessor(), ns3::MakeQueueSizeChecker(), ns3::MakeTimeAccessor(), ns3::MakeTimeChecker(), ns3::MakeUintegerAccessor(), ns3::Seconds(), ns3::QueueDisc::SetMaxSize(), and ns3::TypeId::SetParent().
|
privatevirtual |
Initialize the queue parameters.
Implements ns3::QueueDisc.
Definition at line 171 of file pie-queue-disc.cc.
References DQCOUNT_INVALID, m_avgDqRate, m_burstState, m_dqCount, m_dqStart, m_dropProb, m_inMeasurement, m_qDelayOld, NO_BURST, and ns3::Seconds().
|
staticprivate |
Invalid dqCount value.
Definition at line 132 of file pie-queue-disc.h.
Referenced by CalculateP(), and InitializeParams().
|
static |
Drops due to queue limit: reactive.
Definition at line 99 of file pie-queue-disc.h.
Referenced by DoEnqueue().
|
private |
Parameter to pie controller.
Definition at line 140 of file pie-queue-disc.h.
Referenced by CalculateP(), and GetTypeId().
|
private |
Time averaged dequeue rate.
Definition at line 152 of file pie-queue-disc.h.
Referenced by CalculateP(), DoDequeue(), and InitializeParams().
|
private |
Parameter to pie controller.
Definition at line 141 of file pie-queue-disc.h.
Referenced by CalculateP(), and GetTypeId().
|
private |
Current max burst value in seconds that is allowed before random drops kick in.
Definition at line 148 of file pie-queue-disc.h.
Referenced by CalculateP(), and DropEarly().
|
private |
Used to reset value of burst allowance.
Definition at line 149 of file pie-queue-disc.h.
Referenced by CalculateP().
|
private |
Used to determine the current state of burst.
Definition at line 150 of file pie-queue-disc.h.
Referenced by CalculateP(), DropEarly(), and InitializeParams().
|
private |
Number of bytes departed since current measurement cycle starts.
Definition at line 154 of file pie-queue-disc.h.
Referenced by CalculateP(), DoDequeue(), and InitializeParams().
|
private |
Start timestamp of current measurement cycle.
Definition at line 153 of file pie-queue-disc.h.
Referenced by DoDequeue(), and InitializeParams().
|
private |
Minimum queue size in bytes before dequeue rate is measured.
Definition at line 142 of file pie-queue-disc.h.
Referenced by DoDequeue(), and GetTypeId().
|
private |
Variable used in calculation of drop probability.
Definition at line 145 of file pie-queue-disc.h.
Referenced by CalculateP(), DropEarly(), and InitializeParams().
|
private |
Indicates whether we are in a measurement cycle.
Definition at line 151 of file pie-queue-disc.h.
Referenced by DoDequeue(), and InitializeParams().
|
private |
Maximum burst allowed before random early dropping kicks in.
Definition at line 139 of file pie-queue-disc.h.
Referenced by DropEarly(), and GetTypeId().
|
private |
Average packet size in bytes.
Definition at line 138 of file pie-queue-disc.h.
Referenced by DropEarly(), and GetTypeId().
|
private |
Current value of queue delay.
Definition at line 147 of file pie-queue-disc.h.
Referenced by CalculateP(), and GetQueueDelay().
|
private |
Old value of queue delay.
Definition at line 146 of file pie-queue-disc.h.
Referenced by CalculateP(), DropEarly(), and InitializeParams().
|
private |
Desired queue delay.
Definition at line 137 of file pie-queue-disc.h.
Referenced by CalculateP(), DropEarly(), and GetTypeId().
|
private |
Event used to decide the decision of interval of drop probability calculation.
Definition at line 155 of file pie-queue-disc.h.
Referenced by CalculateP(), DoDispose(), and PieQueueDisc().
|
private |
Start time of the update timer.
Definition at line 135 of file pie-queue-disc.h.
Referenced by GetTypeId(), and PieQueueDisc().
|
private |
Time period after which CalculateP () is called.
Definition at line 136 of file pie-queue-disc.h.
Referenced by CalculateP(), and GetTypeId().
|
private |
Rng stream.
Definition at line 156 of file pie-queue-disc.h.
Referenced by AssignStreams(), DoDispose(), DropEarly(), and PieQueueDisc().
|
static |
Early probability drops: proactive.
Definition at line 98 of file pie-queue-disc.h.
Referenced by DoEnqueue().