A Discrete-Event Network Simulator
API
Loading...
Searching...
No Matches
ns3::FqCoDelQueueDisc Class Reference

A FqCoDel packet queue disc. More...

#include "fq-codel-queue-disc.h"

+ Inheritance diagram for ns3::FqCoDelQueueDisc:
+ Collaboration diagram for ns3::FqCoDelQueueDisc:

Public Member Functions

 FqCoDelQueueDisc ()
 FqCoDelQueueDisc constructor.
 
 ~FqCoDelQueueDisc () override
 
uint32_t GetQuantum () const
 Get the quantum value.
 
void SetQuantum (uint32_t quantum)
 Set the quantum value.
 
- Public Member Functions inherited from ns3::QueueDisc
 QueueDisc (const QueueDisc &)=delete
 
 QueueDisc (QueueDiscSizePolicy policy, QueueSizeUnit unit)
 Constructor.
 
 QueueDisc (QueueDiscSizePolicy policy=QueueDiscSizePolicy::SINGLE_INTERNAL_QUEUE)
 Constructor.
 
 ~QueueDisc () override
 
void AddInternalQueue (Ptr< InternalQueue > queue)
 Add an internal queue to the tail of the list of queues.
 
void AddPacketFilter (Ptr< PacketFilter > filter)
 Add a packet filter to the tail of the list of filters used to classify packets.
 
void AddQueueDiscClass (Ptr< QueueDiscClass > qdClass)
 Add a queue disc class to the tail of the list of classes.
 
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.
 
Ptr< QueueDiscItemDequeue ()
 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.
 
bool Enqueue (Ptr< QueueDiscItem > item)
 Pass a packet to store to the queue discipline.
 
QueueSize GetCurrentSize ()
 Get the current size of the queue disc in bytes, if operating in bytes mode, or packets, otherwise.
 
Ptr< InternalQueueGetInternalQueue (std::size_t i) const
 Get the i-th internal queue.
 
QueueSize GetMaxSize () const
 Get the maximum size of the queue disc.
 
uint32_t GetNBytes () const
 Get the amount of bytes stored by the queue disc.
 
Ptr< NetDeviceQueueInterfaceGetNetDeviceQueueInterface () const
 
std::size_t GetNInternalQueues () const
 Get the number of internal queues.
 
std::size_t GetNPacketFilters () const
 Get the number of packet filters.
 
uint32_t GetNPackets () const
 Get the number of packets stored by the queue disc.
 
std::size_t GetNQueueDiscClasses () const
 Get the number of queue disc classes.
 
Ptr< PacketFilterGetPacketFilter (std::size_t i) const
 Get the i-th packet filter.
 
Ptr< QueueDiscClassGetQueueDiscClass (std::size_t i) const
 Get the i-th queue disc class.
 
virtual uint32_t GetQuota () const
 Get the maximum number of dequeue operations following a packet enqueue.
 
SendCallback GetSendCallback () const
 
const StatsGetStats ()
 Retrieve all the collected statistics.
 
virtual WakeMode GetWakeMode () 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.
 
QueueDiscoperator= (const QueueDisc &)=delete
 
Ptr< const QueueDiscItemPeek ()
 Get a copy of the next packet the queue discipline will extract.
 
void Run ()
 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.
 
bool SetMaxSize (QueueSize size)
 Set the maximum size of the queue disc.
 
void SetNetDeviceQueueInterface (Ptr< NetDeviceQueueInterface > ndqi)
 
virtual void SetQuota (const uint32_t quota)
 Set the maximum number of dequeue operations following a packet enqueue.
 
void SetSendCallback (SendCallback func)
 
- Public Member Functions inherited from ns3::Object
 Object ()
 Constructor.
 
 ~Object () override
 Destructor.
 
void AggregateObject (Ptr< Object > other)
 Aggregate two Objects together.
 
void Dispose ()
 Dispose of this Object.
 
AggregateIterator GetAggregateIterator () const
 Get an iterator to the Objects aggregated to this one.
 
TypeId GetInstanceTypeId () const override
 Get the most derived TypeId for this Object.
 
template<typename T >
Ptr< T > GetObject () const
 Get a pointer to the requested aggregated Object.
 
template<>
Ptr< ObjectGetObject () const
 Specialization of () for objects of type ns3::Object.
 
template<typename T >
Ptr< T > GetObject (TypeId tid) const
 Get a pointer to the requested aggregated Object by TypeId.
 
template<>
Ptr< ObjectGetObject (TypeId tid) const
 Specialization of (TypeId tid) for objects of type ns3::Object.
 
void Initialize ()
 Invoke DoInitialize on all Objects aggregated to this one.
 
bool IsInitialized () const
 Check if the object has been initialized.
 
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount ()
 Default constructor.
 
 SimpleRefCount (const SimpleRefCount &o)
 Copy constructor.
 
uint32_t GetReferenceCount () const
 Get the reference count of the object.
 
SimpleRefCountoperator= (const SimpleRefCount &o)
 Assignment operator.
 
void Ref () const
 Increment the reference count.
 
void Unref () const
 Decrement the reference count.
 
- Public Member Functions inherited from ns3::ObjectBase
virtual ~ObjectBase ()
 Virtual destructor.
 
void GetAttribute (std::string name, AttributeValue &value) const
 Get the value of an attribute, raising fatal errors if unsuccessful.
 
bool GetAttributeFailSafe (std::string name, AttributeValue &value) const
 Get the value of an attribute without raising errors.
 
virtual TypeId GetInstanceTypeId () const =0
 Get the most derived TypeId for this Object.
 
void SetAttribute (std::string name, const AttributeValue &value)
 Set a single attribute, raising fatal errors if unsuccessful.
 
bool SetAttributeFailSafe (std::string name, const AttributeValue &value)
 Set a single attribute without raising errors.
 
bool TraceConnect (std::string name, std::string context, const CallbackBase &cb)
 Connect a TraceSource to a Callback with a context.
 
bool TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
 Connect a TraceSource to a Callback without a context.
 
bool TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected with a context.
 
bool TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected without a context.
 

Static Public Member Functions

static TypeId GetTypeId ()
 Get the type ID.
 
- Static Public Member Functions inherited from ns3::QueueDisc
static TypeId GetTypeId ()
 Get the type ID.
 
- Static Public Member Functions inherited from ns3::Object
static TypeId GetTypeId ()
 Register this type.
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId ()
 Get the type ID.
 

Static Public Attributes

static constexpr const char * OVERLIMIT_DROP = "Overlimit drop"
 Overlimit dropped packets.
 
static constexpr const char * UNCLASSIFIED_DROP
 No packet filter able to classify packet.
 
- Static Public Attributes inherited from ns3::QueueDisc
static constexpr const char * CHILD_QUEUE_DISC_DROP
 Packet dropped by a child queue disc.
 
static constexpr const char * CHILD_QUEUE_DISC_MARK
 Packet marked by a child queue disc.
 
static constexpr const char * INTERNAL_QUEUE_DROP
 Packet dropped by an internal queue.
 

Private Member Functions

bool CheckConfig () override
 Check whether the current configuration is correct.
 
Ptr< QueueDiscItemDoDequeue () override
 This function actually extracts a packet from the queue disc.
 
bool DoEnqueue (Ptr< QueueDiscItem > item) override
 This function actually enqueues a packet into the queue disc.
 
uint32_t FqCoDelDrop ()
 Drop a packet from the head of the queue with the largest current byte count.
 
void InitializeParams () override
 Initialize parameters (if any) before the first packet is enqueued.
 
uint32_t SetAssociativeHash (uint32_t flowHash)
 Compute the index of the queue for the flow having the given flowHash, according to the set associative hash approach.
 

Private Attributes

Time m_ceThreshold
 Threshold above which to CE mark.
 
uint32_t m_dropBatchSize
 Max number of packets dropped from the fat flow.
 
bool m_enableSetAssociativeHash
 whether to enable set associative hash
 
ObjectFactory m_flowFactory
 Factory to create a new flow.
 
uint32_t m_flows
 Number of flow queues.
 
std::map< uint32_t, uint32_tm_flowsIndices
 Map with the index of class for each flow.
 
std::string m_interval
 CoDel interval attribute.
 
std::list< Ptr< FqCoDelFlow > > m_newFlows
 The list of new flows.
 
std::list< Ptr< FqCoDelFlow > > m_oldFlows
 The list of old flows.
 
uint32_t m_perturbation
 hash perturbation value
 
uint32_t m_quantum
 Deficit assigned to flows at each round.
 
ObjectFactory m_queueDiscFactory
 Factory to create a new queue.
 
uint32_t m_setWays
 size of a set of queues (used by set associative hash)
 
std::map< uint32_t, uint32_tm_tags
 Tags used by set associative hash.
 
std::string m_target
 CoDel target attribute.
 
bool m_useEcn
 True if ECN is used (packets are marked instead of being dropped)
 
bool m_useL4s
 True if L4S is used (ECT1 packets are marked at CE threshold)
 

Additional Inherited Members

- Public Types inherited from ns3::QueueDisc
typedef Queue< QueueDiscItemInternalQueue
 Internal queues store QueueDiscItem objects.
 
typedef std::function< void(Ptr< QueueDiscItem >)> SendCallback
 Callback invoked to send a packet to the receiving object when Run is called.
 
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...
 
- Protected Member Functions inherited from ns3::QueueDisc
void DoDispose () override
 Dispose of the object.
 
void DoInitialize () override
 Check whether the configuration is correct and initialize parameters.
 
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.
 
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.
 
bool Mark (Ptr< QueueDiscItem > item, const char *reason)
 Marks the given packet and, if successful, updates the counters associated with the given reason.
 
- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 Copy an Object.
 
virtual void DoDispose ()
 Destructor implementation.
 
virtual void DoInitialize ()
 Initialize() implementation.
 
virtual void NotifyNewAggregate ()
 Notify all Objects aggregated to this one of a new Object being aggregated.
 
- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 Complete construction of ObjectBase; invoked by derived classes.
 
virtual void NotifyConstructionCompleted ()
 Notifier called once the ObjectBase is fully constructed.
 

Detailed Description

A FqCoDel packet queue disc.

Introspection did not find any typical Config paths.


Attributes

  • CeThreshold: The FqCoDel CE threshold for marking packets
    • Set with class: ns3::TimeValue
    • Underlying type: Time +9.22337e+18ns:+9.22337e+18ns
    • Initial value: +9.22337e+18ns
    • Flags: constructwriteread
  • DropBatchSize: The maximum number of packets dropped from the fat flow
    • Set with class: ns3::UintegerValue
    • Underlying type: uint32_t 0:4294967295
    • Initial value: 64
    • Flags: constructwriteread
  • EnableSetAssociativeHash: Enable/Disable Set Associative Hash
    • Set with class: ns3::BooleanValue
    • Underlying type: bool
    • Initial value: false
    • Flags: constructwriteread
  • Flows: The number of queues into which the incoming packets are classified
    • Set with class: ns3::UintegerValue
    • Underlying type: uint32_t 0:4294967295
    • Initial value: 1024
    • Flags: constructwriteread
  • Interval: The CoDel algorithm interval for each FQCoDel queue
    • Set with class: ns3::StringValue
    • Underlying type: std::string
    • Initial value: 100ms
    • Flags: constructwriteread
  • MaxSize: The maximum number of packets accepted by this queue disc
  • Perturbation: The salt used as an additional input to the hash function used to classify packets
    • Set with class: ns3::UintegerValue
    • Underlying type: uint32_t 0:4294967295
    • Initial value: 0
    • Flags: constructwriteread
  • SetWays: The size of a set of queues (used by set associative hash)
    • Set with class: ns3::UintegerValue
    • Underlying type: uint32_t 0:4294967295
    • Initial value: 8
    • Flags: constructwriteread
  • Target: The CoDel algorithm target queue delay for each FQCoDel queue
    • Set with class: ns3::StringValue
    • Underlying type: std::string
    • Initial value: 5ms
    • Flags: constructwriteread
  • UseEcn: True to use ECN (packets are marked instead of being dropped)
    • Set with class: ns3::BooleanValue
    • Underlying type: bool
    • Initial value: true
    • Flags: constructwriteread
  • UseL4s: True to use L4S (only ECT1 packets are marked at CE threshold)
    • Set with class: ns3::BooleanValue
    • Underlying type: bool
    • Initial value: false
    • Flags: constructwriteread

Attributes defined in parent class ns3::QueueDisc

No TraceSources are defined for this type.

TraceSources defined in parent class ns3::QueueDisc

Size of this type is 1208 bytes (on a 64-bit architecture).

Definition at line 113 of file fq-codel-queue-disc.h.

Constructor & Destructor Documentation

◆ FqCoDelQueueDisc()

ns3::FqCoDelQueueDisc::FqCoDelQueueDisc ( )

FqCoDelQueueDisc constructor.

Definition at line 177 of file fq-codel-queue-disc.cc.

References NS_LOG_FUNCTION.

◆ ~FqCoDelQueueDisc()

ns3::FqCoDelQueueDisc::~FqCoDelQueueDisc ( )
override

Definition at line 184 of file fq-codel-queue-disc.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

◆ CheckConfig()

bool ns3::FqCoDelQueueDisc::CheckConfig ( )
overrideprivatevirtual

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. This method is automatically called at simulation initialization time, and it is called before the InitializeParams () method. It is appropriate to promote parameter initialization to this method if it aids in checking for correct configuration.

See also
QueueDisc::InitializeParams
Returns
true if the configuration is correct, false otherwise

Implements ns3::QueueDisc.

Definition at line 397 of file fq-codel-queue-disc.cc.

References ns3::QueueDisc::GetNetDeviceQueueInterface(), ns3::QueueDisc::GetNInternalQueues(), ns3::QueueDisc::GetNQueueDiscClasses(), m_ceThreshold, m_enableSetAssociativeHash, m_flows, m_quantum, m_setWays, m_useEcn, m_useL4s, ns3::Time::Max(), NS_ABORT_MSG_IF, NS_LOG_DEBUG, NS_LOG_ERROR, NS_LOG_FUNCTION, and NS_LOG_WARN.

+ Here is the call graph for this function:

◆ DoDequeue()

Ptr< QueueDiscItem > ns3::FqCoDelQueueDisc::DoDequeue ( )
overrideprivatevirtual

This function actually extracts a packet from the queue disc.

Returns
0 if the operation was not successful; the item otherwise.

Implements ns3::QueueDisc.

Definition at line 316 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.

◆ DoEnqueue()

◆ FqCoDelDrop()

uint32_t ns3::FqCoDelQueueDisc::FqCoDelDrop ( )
private

Drop a packet from the head of the queue with the largest current byte count.

Returns
the index of the queue with the largest current byte count

Definition at line 465 of file fq-codel-queue-disc.cc.

References ns3::QueueDisc::DropAfterDequeue(), ns3::QueueDisc::GetNQueueDiscClasses(), ns3::QueueDisc::GetQueueDiscClass(), m_dropBatchSize, NS_LOG_DEBUG, NS_LOG_FUNCTION, and OVERLIMIT_DROP.

Referenced by DoEnqueue().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ GetQuantum()

uint32_t ns3::FqCoDelQueueDisc::GetQuantum ( ) const

Get the quantum value.

Returns
The number of bytes each queue gets to dequeue on each round of the scheduling algorithm

Definition at line 197 of file fq-codel-queue-disc.cc.

References m_quantum.

◆ GetTypeId()

◆ InitializeParams()

void ns3::FqCoDelQueueDisc::InitializeParams ( )
overrideprivatevirtual

Initialize parameters (if any) before the first packet is enqueued.

This method is automatically called at simulation initialization time, after the CheckConfig() method has been called.

See also
QueueDisc::CheckConfig

Implements ns3::QueueDisc.

Definition at line 452 of file fq-codel-queue-disc.cc.

References ns3::QueueDisc::GetMaxSize(), m_flowFactory, m_interval, m_queueDiscFactory, m_target, NS_LOG_FUNCTION, ns3::ObjectFactory::Set(), and ns3::ObjectFactory::SetTypeId().

+ Here is the call graph for this function:

◆ SetAssociativeHash()

uint32_t ns3::FqCoDelQueueDisc::SetAssociativeHash ( uint32_t  flowHash)
private

Compute the index of the queue for the flow having the given flowHash, according to the set associative hash approach.

Parameters
flowHashthe hash of the flow 5-tuple
Returns
the index of the queue for the given flow

Definition at line 203 of file fq-codel-queue-disc.cc.

References ns3::QueueDisc::GetQueueDiscClass(), ns3::FqCoDelFlow::INACTIVE, m_flows, m_flowsIndices, m_setWays, m_tags, and NS_LOG_FUNCTION.

Referenced by DoEnqueue().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ SetQuantum()

void ns3::FqCoDelQueueDisc::SetQuantum ( uint32_t  quantum)

Set the quantum value.

Parameters
quantumThe number of bytes each queue gets to dequeue on each round of the scheduling algorithm

Definition at line 190 of file fq-codel-queue-disc.cc.

References m_quantum, and NS_LOG_FUNCTION.

Member Data Documentation

◆ m_ceThreshold

Time ns3::FqCoDelQueueDisc::m_ceThreshold
private

Threshold above which to CE mark.

Definition at line 178 of file fq-codel-queue-disc.h.

Referenced by CheckConfig(), DoEnqueue(), and GetTypeId().

◆ m_dropBatchSize

uint32_t ns3::FqCoDelQueueDisc::m_dropBatchSize
private

Max number of packets dropped from the fat flow.

Definition at line 176 of file fq-codel-queue-disc.h.

Referenced by FqCoDelDrop(), and GetTypeId().

◆ m_enableSetAssociativeHash

bool ns3::FqCoDelQueueDisc::m_enableSetAssociativeHash
private

whether to enable set associative hash

Definition at line 179 of file fq-codel-queue-disc.h.

Referenced by CheckConfig(), DoEnqueue(), and GetTypeId().

◆ m_flowFactory

ObjectFactory ns3::FqCoDelQueueDisc::m_flowFactory
private

Factory to create a new flow.

Definition at line 188 of file fq-codel-queue-disc.h.

Referenced by DoEnqueue(), and InitializeParams().

◆ m_flows

uint32_t ns3::FqCoDelQueueDisc::m_flows
private

Number of flow queues.

Definition at line 174 of file fq-codel-queue-disc.h.

Referenced by CheckConfig(), DoEnqueue(), GetTypeId(), and SetAssociativeHash().

◆ m_flowsIndices

std::map<uint32_t, uint32_t> ns3::FqCoDelQueueDisc::m_flowsIndices
private

Map with the index of class for each flow.

Definition at line 185 of file fq-codel-queue-disc.h.

Referenced by DoEnqueue(), and SetAssociativeHash().

◆ m_interval

std::string ns3::FqCoDelQueueDisc::m_interval
private

CoDel interval attribute.

Definition at line 171 of file fq-codel-queue-disc.h.

Referenced by GetTypeId(), and InitializeParams().

◆ m_newFlows

std::list<Ptr<FqCoDelFlow> > ns3::FqCoDelQueueDisc::m_newFlows
private

The list of new flows.

Definition at line 182 of file fq-codel-queue-disc.h.

Referenced by DoDequeue(), and DoEnqueue().

◆ m_oldFlows

std::list<Ptr<FqCoDelFlow> > ns3::FqCoDelQueueDisc::m_oldFlows
private

The list of old flows.

Definition at line 183 of file fq-codel-queue-disc.h.

Referenced by DoDequeue().

◆ m_perturbation

uint32_t ns3::FqCoDelQueueDisc::m_perturbation
private

hash perturbation value

Definition at line 177 of file fq-codel-queue-disc.h.

Referenced by DoEnqueue(), and GetTypeId().

◆ m_quantum

uint32_t ns3::FqCoDelQueueDisc::m_quantum
private

Deficit assigned to flows at each round.

Definition at line 173 of file fq-codel-queue-disc.h.

Referenced by CheckConfig(), DoDequeue(), DoEnqueue(), GetQuantum(), and SetQuantum().

◆ m_queueDiscFactory

ObjectFactory ns3::FqCoDelQueueDisc::m_queueDiscFactory
private

Factory to create a new queue.

Definition at line 189 of file fq-codel-queue-disc.h.

Referenced by DoEnqueue(), and InitializeParams().

◆ m_setWays

uint32_t ns3::FqCoDelQueueDisc::m_setWays
private

size of a set of queues (used by set associative hash)

Definition at line 175 of file fq-codel-queue-disc.h.

Referenced by CheckConfig(), GetTypeId(), and SetAssociativeHash().

◆ m_tags

std::map<uint32_t, uint32_t> ns3::FqCoDelQueueDisc::m_tags
private

Tags used by set associative hash.

Definition at line 186 of file fq-codel-queue-disc.h.

Referenced by SetAssociativeHash().

◆ m_target

std::string ns3::FqCoDelQueueDisc::m_target
private

CoDel target attribute.

Definition at line 172 of file fq-codel-queue-disc.h.

Referenced by GetTypeId(), and InitializeParams().

◆ m_useEcn

bool ns3::FqCoDelQueueDisc::m_useEcn
private

True if ECN is used (packets are marked instead of being dropped)

Definition at line 161 of file fq-codel-queue-disc.h.

Referenced by CheckConfig(), DoEnqueue(), and GetTypeId().

◆ m_useL4s

bool ns3::FqCoDelQueueDisc::m_useL4s
private

True if L4S is used (ECT1 packets are marked at CE threshold)

Definition at line 180 of file fq-codel-queue-disc.h.

Referenced by CheckConfig(), DoEnqueue(), and GetTypeId().

◆ OVERLIMIT_DROP

constexpr const char* ns3::FqCoDelQueueDisc::OVERLIMIT_DROP = "Overlimit drop"
staticconstexpr

Overlimit dropped packets.

Definition at line 147 of file fq-codel-queue-disc.h.

Referenced by FqCoDelDrop().

◆ UNCLASSIFIED_DROP

constexpr const char* ns3::FqCoDelQueueDisc::UNCLASSIFIED_DROP
staticconstexpr
Initial value:
=
"Unclassified drop"

No packet filter able to classify packet.

Definition at line 145 of file fq-codel-queue-disc.h.

Referenced by DoEnqueue().


The documentation for this class was generated from the following files: