Implements PIE Active Queue Management discipline. More...
#include "pie-queue-disc.h"
Classes | |
struct | Stats |
Stats. More... | |
Public Types | |
enum | BurstStateT { NO_BURST, IN_BURST, IN_BURST_PROTECTING } |
Burst types. More... | |
![]() | |
typedef Callback< void, Ptr< QueueItem > > | ParentDropCallback |
Callback invoked by a child queue disc to notify the parent of a packet drop. 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... | |
Queue::QueueMode | GetMode (void) |
Get the encapsulation mode of this queue. More... | |
Time | GetQueueDelay (void) |
Get queue delay. More... | |
uint32_t | GetQueueSize (void) |
Get the current value of the queue in bytes or packets. More... | |
Stats | GetStats () |
Get PIE statistics after running. More... | |
void | SetMode (Queue::QueueMode mode) |
Set the operating mode of this queue. More... | |
void | SetQueueLimit (uint32_t lim) |
Set the limit of the queue in bytes or packets. More... | |
![]() | |
QueueDisc () | |
void | AddInternalQueue (Ptr< Queue > 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) |
Request the queue discipline to extract a packet. More... | |
bool | Enqueue (Ptr< QueueDiscItem > item) |
Pass a packet to store to the queue discipline. More... | |
Ptr< Queue > | GetInternalQueue (uint32_t i) const |
Get the i-th internal queue. 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... | |
uint32_t | GetNInternalQueues (void) const |
Get the number of internal queues. More... | |
uint32_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... | |
uint32_t | GetNQueueDiscClasses (void) const |
Get the number of queue disc classes. More... | |
Ptr< PacketFilter > | GetPacketFilter (uint32_t i) const |
Get the i-th packet filter. More... | |
Ptr< QueueDiscClass > | GetQueueDiscClass (uint32_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... | |
uint32_t | GetTotalDroppedBytes (void) const |
Get the total amount of dropped bytes. More... | |
uint32_t | GetTotalDroppedPackets (void) const |
Get the total number of dropped packets. More... | |
uint32_t | GetTotalReceivedBytes (void) const |
Get the total amount of received bytes. More... | |
uint32_t | GetTotalReceivedPackets (void) const |
Get the total number of received packets. More... | |
uint32_t | GetTotalRequeuedBytes (void) const |
Get the total amount of requeued bytes. More... | |
uint32_t | GetTotalRequeuedPackets (void) const |
Get the total number of requeued packets. More... | |
WakeMode | GetWakeMode (void) |
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) const |
Get a copy of the next packet the queue discipline will extract, without actually extracting the packet. 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... | |
void | SetNetDevice (Ptr< NetDevice > device) |
Set the NetDevice on which this queue discipline is installed. More... | |
virtual void | SetParentDropCallback (ParentDropCallback cb) |
Set the parent drop callback. More... | |
virtual void | SetQuota (const uint32_t quota) |
Set the maximum number of dequeue operations following a packet enqueue. More... | |
![]() | |
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 |
Implement the GetInstanceTypeId method defined in ObjectBase. 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... | |
![]() | |
SimpleRefCount () | |
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. More... | |
void | Ref (void) const |
Increment the reference count. More... | |
void | Unref (void) const |
Decrement the reference count. More... | |
![]() | |
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 TypeId | GetTypeId (void) |
Get the type ID. More... | |
![]() | |
static TypeId | GetTypeId (void) |
Register this type. More... | |
![]() | |
static void | Cleanup (void) |
Noop. More... | |
![]() | |
static TypeId | GetTypeId (void) |
Get the type ID. More... | |
Protected Member Functions | |
virtual void | DoDispose (void) |
Dispose of the object. More... | |
![]() | |
virtual void | DoInitialize (void) |
Check whether the configuration is correct and initialize parameters. More... | |
void | Drop (Ptr< QueueItem > item) |
Drop a packet. More... | |
![]() | |
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... | |
![]() | |
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... | |
virtual Ptr< const QueueDiscItem > | DoPeek (void) const |
This function returns a copy of the next packet the queue disc will extract. 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... | |
uint32_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... | |
Queue::QueueMode | m_mode |
Mode (bytes or packets) 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... | |
uint32_t | m_queueLimit |
Queue limit in bytes / packets. More... | |
EventId | m_rtrsEvent |
Event used to decide the decision of interval of drop probability calculation. More... | |
Stats | m_stats |
PIE statistics. 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... | |
Additional Inherited Members | |
![]() | |
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 472 bytes (on a 64-bit architecture).
Definition at line 53 of file pie-queue-disc.h.
ns3::PieQueueDisc::PieQueueDisc | ( | ) |
PieQueueDisc Constructor.
Definition at line 105 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 113 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 181 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 289 of file pie-queue-disc.cc.
References BURST_RESET_TIMEOUT, 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 483 of file pie-queue-disc.cc.
References ns3::QueueDisc::AddInternalQueue(), ns3::QueueDisc::GetInternalQueue(), GetMode(), ns3::QueueDisc::GetNInternalQueues(), ns3::QueueDisc::GetNPacketFilters(), ns3::QueueDisc::GetNQueueDiscClasses(), m_mode, m_queueLimit, NS_LOG_ERROR, NS_LOG_FUNCTION, ns3::Queue::QUEUE_MODE_BYTES, and ns3::Queue::QUEUE_MODE_PACKETS.
|
privatevirtual |
This function actually extracts a packet from the queue disc.
Implements ns3::QueueDisc.
Definition at line 400 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 119 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 189 of file pie-queue-disc.cc.
References ns3::QueueDisc::Drop(), DropEarly(), ns3::PieQueueDisc::Stats::forcedDrop, ns3::QueueDisc::GetInternalQueue(), GetMode(), ns3::QueueDisc::GetNBytes(), ns3::QueueDisc::GetNPackets(), GetQueueSize(), m_queueLimit, m_stats, NS_LOG_FUNCTION, NS_LOG_LOGIC, ns3::Queue::QUEUE_MODE_BYTES, ns3::Queue::QUEUE_MODE_PACKETS, and ns3::PieQueueDisc::Stats::unforcedDrop.
|
privatevirtual |
This function returns a copy of the next packet the queue disc will extract.
Implements ns3::QueueDisc.
Definition at line 465 of file pie-queue-disc.cc.
References ns3::QueueDisc::GetInternalQueue(), ns3::QueueDisc::GetNBytes(), ns3::QueueDisc::GetNPackets(), NS_LOG_FUNCTION, and NS_LOG_LOGIC.
|
private |
Check if a packet needs to be dropped due to probability drop.
item | queue item |
qSize | queue size |
Definition at line 238 of file pie-queue-disc.cc.
References GetMode(), ns3::Time::GetSeconds(), 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, packetSize, ns3::Queue::QUEUE_MODE_BYTES, and ns3::Queue::QUEUE_MODE_PACKETS.
Referenced by DoEnqueue().
Queue::QueueMode ns3::PieQueueDisc::GetMode | ( | void | ) |
Get the encapsulation mode of this queue.
Definition at line 135 of file pie-queue-disc.cc.
References m_mode, and NS_LOG_FUNCTION.
Referenced by CheckConfig(), DoEnqueue(), DropEarly(), GetQueueSize(), and PieQueueDiscTestCase::RunPieTest().
Time ns3::PieQueueDisc::GetQueueDelay | ( | void | ) |
Get queue delay.
Definition at line 174 of file pie-queue-disc.cc.
References m_qDelay, and NS_LOG_FUNCTION.
uint32_t ns3::PieQueueDisc::GetQueueSize | ( | void | ) |
Get the current value of the queue in bytes or packets.
Definition at line 149 of file pie-queue-disc.cc.
References ns3::QueueDisc::GetInternalQueue(), GetMode(), NS_ABORT_MSG, NS_LOG_FUNCTION, ns3::Queue::QUEUE_MODE_BYTES, and ns3::Queue::QUEUE_MODE_PACKETS.
Referenced by DoEnqueue(), and PieQueueDiscTestCase::RunPieTest().
PieQueueDisc::Stats ns3::PieQueueDisc::GetStats | ( | ) |
Get PIE statistics after running.
Definition at line 167 of file pie-queue-disc.cc.
References m_stats, and NS_LOG_FUNCTION.
|
static |
Get the type ID.
Definition at line 43 of file pie-queue-disc.cc.
References m_a, m_b, m_dqThreshold, m_maxBurst, m_meanPktSize, m_qDelayRef, m_sUpdate, m_tUpdate, ns3::MakeDoubleAccessor(), ns3::MakeEnumAccessor(), ns3::MakeEnumChecker(), ns3::MakeTimeAccessor(), ns3::MakeTimeChecker(), ns3::MakeUintegerAccessor(), ns3::Queue::QUEUE_MODE_BYTES, ns3::Queue::QUEUE_MODE_PACKETS, ns3::Seconds(), SetMode(), ns3::TypeId::SetParent(), and SetQueueLimit().
|
privatevirtual |
Initialize the queue parameters.
Implements ns3::QueueDisc.
Definition at line 224 of file pie-queue-disc.cc.
References ns3::PieQueueDisc::Stats::forcedDrop, m_avgDqRate, m_burstState, m_dqCount, m_dqStart, m_dropProb, m_inMeasurement, m_qDelayOld, m_stats, NO_BURST, ns3::Seconds(), and ns3::PieQueueDisc::Stats::unforcedDrop.
void ns3::PieQueueDisc::SetMode | ( | Queue::QueueMode | mode | ) |
Set the operating mode of this queue.
mode | The operating mode of this queue. |
Definition at line 128 of file pie-queue-disc.cc.
References m_mode, and NS_LOG_FUNCTION.
Referenced by GetTypeId().
void ns3::PieQueueDisc::SetQueueLimit | ( | uint32_t | lim | ) |
Set the limit of the queue in bytes or packets.
lim | The limit in bytes or packets. |
Definition at line 142 of file pie-queue-disc.cc.
References m_queueLimit, and NS_LOG_FUNCTION.
Referenced by GetTypeId(), and PieQueueDiscTestCase::RunPieTest().
|
private |
Parameter to pie controller.
Definition at line 183 of file pie-queue-disc.h.
Referenced by CalculateP(), and GetTypeId().
|
private |
Time averaged dequeue rate.
Definition at line 195 of file pie-queue-disc.h.
Referenced by CalculateP(), DoDequeue(), and InitializeParams().
|
private |
Parameter to pie controller.
Definition at line 184 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 191 of file pie-queue-disc.h.
Referenced by CalculateP(), and DropEarly().
|
private |
Used to reset value of burst allowance.
Definition at line 192 of file pie-queue-disc.h.
Referenced by CalculateP().
|
private |
Used to determine the current state of burst.
Definition at line 193 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 197 of file pie-queue-disc.h.
Referenced by CalculateP(), DoDequeue(), and InitializeParams().
|
private |
Start timestamp of current measurement cycle.
Definition at line 196 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 185 of file pie-queue-disc.h.
Referenced by DoDequeue(), and GetTypeId().
|
private |
Variable used in calculation of drop probability.
Definition at line 188 of file pie-queue-disc.h.
Referenced by CalculateP(), DropEarly(), and InitializeParams().
|
private |
Indicates whether we are in a measurement cycle.
Definition at line 194 of file pie-queue-disc.h.
Referenced by DoDequeue(), and InitializeParams().
|
private |
Maximum burst allowed before random early dropping kicks in.
Definition at line 182 of file pie-queue-disc.h.
Referenced by DropEarly(), and GetTypeId().
|
private |
Average packet size in bytes.
Definition at line 181 of file pie-queue-disc.h.
Referenced by DropEarly(), and GetTypeId().
|
private |
Mode (bytes or packets)
Definition at line 176 of file pie-queue-disc.h.
Referenced by CheckConfig(), GetMode(), and SetMode().
|
private |
Current value of queue delay.
Definition at line 190 of file pie-queue-disc.h.
Referenced by CalculateP(), and GetQueueDelay().
|
private |
Old value of queue delay.
Definition at line 189 of file pie-queue-disc.h.
Referenced by CalculateP(), DropEarly(), and InitializeParams().
|
private |
Desired queue delay.
Definition at line 180 of file pie-queue-disc.h.
Referenced by CalculateP(), DropEarly(), and GetTypeId().
|
private |
Queue limit in bytes / packets.
Definition at line 177 of file pie-queue-disc.h.
Referenced by CheckConfig(), DoEnqueue(), and SetQueueLimit().
|
private |
Event used to decide the decision of interval of drop probability calculation.
Definition at line 198 of file pie-queue-disc.h.
Referenced by CalculateP(), DoDispose(), and PieQueueDisc().
|
private |
PIE statistics.
Definition at line 173 of file pie-queue-disc.h.
Referenced by DoEnqueue(), GetStats(), and InitializeParams().
|
private |
Start time of the update timer.
Definition at line 178 of file pie-queue-disc.h.
Referenced by GetTypeId(), and PieQueueDisc().
|
private |
Time period after which CalculateP () is called.
Definition at line 179 of file pie-queue-disc.h.
Referenced by CalculateP(), and GetTypeId().
|
private |
Rng stream.
Definition at line 199 of file pie-queue-disc.h.
Referenced by AssignStreams(), DoDispose(), DropEarly(), and PieQueueDisc().