A FqCoDel packet queue disc. More...
#include "fq-codel-queue-disc.h"
Public Member Functions | |
FqCoDelQueueDisc () | |
FqCoDelQueueDisc constructor. More... | |
virtual | ~FqCoDelQueueDisc () |
uint32_t | GetQuantum (void) const |
Get the quantum value. More... | |
void | SetQuantum (uint32_t quantum) |
Set the quantum value. More... | |
![]() | |
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) |
Request the queue discipline to extract a packet. More... | |
Ptr< QueueDiscItem > | DequeuePeeked (void) |
Extract from the queue disc the packet that has been dequeued by calling PeekDequeued. 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 (uint32_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... | |
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... | |
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, 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... | |
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... | |
![]() | |
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... | |
![]() | |
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... | |
![]() | |
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 TypeId | GetTypeId (void) |
Get the type ID. More... | |
Static Public Attributes | |
static constexpr const char * | OVERLIMIT_DROP = "Overlimit drop" |
Overlimit dropped packets. More... | |
static constexpr const char * | UNCLASSIFIED_DROP = "Unclassified drop" |
No packet filter able to classify packet. More... | |
![]() | |
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... | |
Private Member Functions | |
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) |
This function returns a copy of the next packet the queue disc will extract. More... | |
uint32_t | FqCoDelDrop (void) |
Drop a packet from the head of the queue with the largest current byte count. More... | |
uint32_t | GetLimit (void) const |
Get the limit of this queue disc. More... | |
virtual void | InitializeParams (void) |
Initialize parameters (if any) before the first packet is enqueued. More... | |
void | SetLimit (uint32_t limit) |
Set the limit of this queue disc. More... | |
Private Attributes | |
uint32_t | m_dropBatchSize |
Max number of packets dropped from the fat flow. More... | |
ObjectFactory | m_flowFactory |
Factory to create a new flow. More... | |
uint32_t | m_flows |
Number of flow queues. More... | |
std::map< uint32_t, uint32_t > | m_flowsIndices |
Map with the index of class for each flow. More... | |
std::string | m_interval |
CoDel interval attribute. More... | |
std::list< Ptr< FqCoDelFlow > > | m_newFlows |
The list of new flows. More... | |
std::list< Ptr< FqCoDelFlow > > | m_oldFlows |
The list of old flows. More... | |
uint32_t | m_quantum |
Deficit assigned to flows at each round. More... | |
ObjectFactory | m_queueDiscFactory |
Factory to create a new queue. More... | |
std::string | m_target |
CoDel target attribute. More... | |
Additional Inherited Members | |
![]() | |
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... | |
![]() | |
virtual void | DoDispose (void) |
Dispose of the object. More... | |
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... | |
Ptr< const QueueDiscItem > | PeekDequeued (void) |
Dequeue a packet and retain it in the queue disc as a requeued 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... | |
![]() | |
static TypeId | GetObjectIid (void) |
Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. More... | |
A FqCoDel packet queue disc.
Introspection did not find any typical Config paths.
No TraceSources are defined for this type.
Size of this type is 1064 bytes (on a 64-bit architecture).
Definition at line 101 of file fq-codel-queue-disc.h.
ns3::FqCoDelQueueDisc::FqCoDelQueueDisc | ( | ) |
FqCoDelQueueDisc constructor.
Definition at line 139 of file fq-codel-queue-disc.cc.
References NS_LOG_FUNCTION.
|
virtual |
Definition at line 146 of file fq-codel-queue-disc.cc.
References NS_LOG_FUNCTION.
|
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 320 of file fq-codel-queue-disc.cc.
References 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 217 of file fq-codel-queue-disc.cc.
References ns3::FqCoDelFlow::INACTIVE, m_newFlows, m_oldFlows, m_quantum, NS_LOG_DEBUG, NS_LOG_FUNCTION, and ns3::FqCoDelFlow::OLD_FLOW.
|
privatevirtual |
This function actually enqueues a packet into the queue disc.
item | item to enqueue |
Implements ns3::QueueDisc.
Definition at line 165 of file fq-codel-queue-disc.cc.
References ns3::QueueDisc::AddQueueDiscClass(), ns3::QueueDisc::Classify(), ns3::ObjectFactory::Create(), ns3::QueueDisc::DropBeforeEnqueue(), FqCoDelDrop(), ns3::QueueDisc::GetCurrentSize(), ns3::QueueDisc::GetMaxSize(), ns3::QueueDisc::GetNQueueDiscClasses(), ns3::QueueDisc::GetQueueDiscClass(), ns3::FqCoDelFlow::INACTIVE, ns3::Object::Initialize(), m_flowFactory, m_flows, m_flowsIndices, m_newFlows, m_quantum, m_queueDiscFactory, ns3::FqCoDelFlow::NEW_FLOW, NS_LOG_DEBUG, NS_LOG_ERROR, NS_LOG_FUNCTION, ns3::PacketFilter::PF_NO_MATCH, and UNCLASSIFIED_DROP.
|
privatevirtual |
This function returns a copy of the next packet the queue disc will extract.
Implements ns3::QueueDisc.
Definition at line 298 of file fq-codel-queue-disc.cc.
References NS_LOG_FUNCTION, and ns3::QueueDisc::PeekDequeued().
|
private |
Drop a packet from the head of the queue with the largest current byte count.
Definition at line 368 of file fq-codel-queue-disc.cc.
References ns3::QueueDisc::DropAfterDequeue(), ns3::QueueDisc::GetInternalQueue(), ns3::QueueDisc::GetNBytes(), ns3::QueueDisc::GetNQueueDiscClasses(), ns3::QueueDisc::GetQueueDiscClass(), m_dropBatchSize, NS_LOG_FUNCTION, and OVERLIMIT_DROP.
Referenced by DoEnqueue().
|
private |
Get the limit of this queue disc.
Definition at line 313 of file fq-codel-queue-disc.cc.
References ns3::QueueDisc::GetMaxSize(), ns3::QueueSize::GetValue(), and NS_LOG_FUNCTION.
Referenced by GetTypeId().
uint32_t ns3::FqCoDelQueueDisc::GetQuantum | ( | void | ) | const |
Get the quantum value.
Definition at line 159 of file fq-codel-queue-disc.cc.
References m_quantum.
Referenced by FqCoDelQueueDiscDeficit::DoRun().
|
static |
Get the type ID.
Definition at line 95 of file fq-codel-queue-disc.cc.
References ns3::TypeId::DEPRECATED, GetLimit(), ns3::QueueDisc::GetMaxSize(), m_dropBatchSize, m_flows, m_interval, m_target, ns3::MakeQueueSizeAccessor(), ns3::MakeQueueSizeChecker(), ns3::MakeStringAccessor(), ns3::MakeStringChecker(), ns3::MakeUintegerAccessor(), SetLimit(), ns3::QueueDisc::SetMaxSize(), and ns3::TypeId::SetParent().
|
privatevirtual |
Initialize parameters (if any) before the first packet is enqueued.
Implements ns3::QueueDisc.
Definition at line 345 of file fq-codel-queue-disc.cc.
References ns3::QueueDisc::GetMaxSize(), ns3::QueueDisc::GetNetDevice(), m_flowFactory, m_interval, m_quantum, m_queueDiscFactory, m_target, NS_ASSERT_MSG(), NS_LOG_DEBUG, NS_LOG_FUNCTION, ns3::ObjectFactory::Set(), and ns3::ObjectFactory::SetTypeId().
|
private |
Set the limit of this queue disc.
limit | The limit of this queue disc. |
Definition at line 306 of file fq-codel-queue-disc.cc.
References NS_LOG_FUNCTION, ns3::PACKETS, and ns3::QueueDisc::SetMaxSize().
Referenced by GetTypeId().
void ns3::FqCoDelQueueDisc::SetQuantum | ( | uint32_t | quantum | ) |
Set the quantum value.
quantum | The number of bytes each queue gets to dequeue on each round of the scheduling algorithm |
Definition at line 152 of file fq-codel-queue-disc.cc.
References m_quantum, and NS_LOG_FUNCTION.
Referenced by FqCoDelQueueDiscNoSuitableFilter::DoRun(), FqCoDelQueueDiscIPFlowsSeparationAndPacketLimit::DoRun(), FqCoDelQueueDiscDeficit::DoRun(), FqCoDelQueueDiscTCPFlowsSeparation::DoRun(), and FqCoDelQueueDiscUDPFlowsSeparation::DoRun().
|
private |
Max number of packets dropped from the fat flow.
Definition at line 168 of file fq-codel-queue-disc.h.
Referenced by FqCoDelDrop(), and GetTypeId().
|
private |
Factory to create a new flow.
Definition at line 175 of file fq-codel-queue-disc.h.
Referenced by DoEnqueue(), and InitializeParams().
|
private |
Number of flow queues.
Definition at line 167 of file fq-codel-queue-disc.h.
Referenced by DoEnqueue(), and GetTypeId().
|
private |
Map with the index of class for each flow.
Definition at line 173 of file fq-codel-queue-disc.h.
Referenced by DoEnqueue().
|
private |
CoDel interval attribute.
Definition at line 164 of file fq-codel-queue-disc.h.
Referenced by GetTypeId(), and InitializeParams().
|
private |
The list of new flows.
Definition at line 170 of file fq-codel-queue-disc.h.
Referenced by DoDequeue(), and DoEnqueue().
|
private |
The list of old flows.
Definition at line 171 of file fq-codel-queue-disc.h.
Referenced by DoDequeue().
|
private |
Deficit assigned to flows at each round.
Definition at line 166 of file fq-codel-queue-disc.h.
Referenced by DoDequeue(), DoEnqueue(), GetQuantum(), InitializeParams(), and SetQuantum().
|
private |
Factory to create a new queue.
Definition at line 176 of file fq-codel-queue-disc.h.
Referenced by DoEnqueue(), and InitializeParams().
|
private |
CoDel target attribute.
Definition at line 165 of file fq-codel-queue-disc.h.
Referenced by GetTypeId(), and InitializeParams().
|
static |
Overlimit dropped packets.
Definition at line 131 of file fq-codel-queue-disc.h.
Referenced by FqCoDelDrop().
|
static |
No packet filter able to classify packet.
Definition at line 130 of file fq-codel-queue-disc.h.
Referenced by DoEnqueue().