A FqCobalt packet queue disc. More...
#include "fq-cobalt-queue-disc.h"
Public Member Functions | |
FqCobaltQueueDisc () | |
FqCobaltQueueDisc constructor. | |
~FqCobaltQueueDisc () 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< QueueDiscItem > | Dequeue () |
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 () const |
Get the current size of the queue disc in bytes, if operating in bytes mode, or packets, otherwise. | |
Ptr< InternalQueue > | GetInternalQueue (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< NetDeviceQueueInterface > | GetNetDeviceQueueInterface () 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< PacketFilter > | GetPacketFilter (std::size_t i) const |
Get the i-th packet filter. | |
Ptr< QueueDiscClass > | GetQueueDiscClass (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 Stats & | GetStats () |
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. | |
QueueDisc & | operator= (const QueueDisc &)=delete |
Ptr< const QueueDiscItem > | Peek () |
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< Object > | GetObject () 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< Object > | GetObject (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. | |
void | UnidirectionalAggregateObject (Ptr< Object > other) |
Aggregate an Object to another Object. | |
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. | |
SimpleRefCount & | operator= (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, bool permissive=false) 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. | |
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< QueueDiscItem > | DoDequeue () 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 | FqCobaltDrop () |
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_blueThreshold |
Threshold to enable blue enhancement. | |
Time | m_ceThreshold |
Threshold above which to CE mark. | |
double | m_decrement |
decrement value for marking probability | |
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_t > | m_flowsIndices |
Map with the index of class for each flow. | |
double | m_increment |
increment value for marking probability | |
std::string | m_interval |
CoDel interval attribute. | |
std::list< Ptr< FqCobaltFlow > > | m_newFlows |
The list of new flows. | |
std::list< Ptr< FqCobaltFlow > > | m_oldFlows |
The list of old flows. | |
double | m_Pdrop |
Drop Probability. | |
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_t > | m_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< QueueDiscItem > | InternalQueue |
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 | 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. | |
Related Symbols inherited from ns3::ObjectBase | |
static TypeId | GetObjectIid () |
Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. | |
A FqCobalt packet queue disc.
Introspection did not find any typical Config paths.
Time
-9.22337e+18ns:+9.22337e+18ns Time
-9.22337e+18ns:+9.22337e+18ns std::string
QueueSize
std::string
No TraceSources are defined for this type.
Group: TrafficControl
Size of this type is 1464 bytes (on a 64-bit architecture).
Definition at line 109 of file fq-cobalt-queue-disc.h.
ns3::FqCobaltQueueDisc::FqCobaltQueueDisc | ( | ) |
FqCobaltQueueDisc constructor.
Definition at line 192 of file fq-cobalt-queue-disc.cc.
References NS_LOG_FUNCTION.
|
override |
Definition at line 199 of file fq-cobalt-queue-disc.cc.
References NS_LOG_FUNCTION.
|
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.
Implements ns3::QueueDisc.
Definition at line 415 of file fq-cobalt-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.
|
overrideprivatevirtual |
This function actually extracts a packet from the queue disc.
Implements ns3::QueueDisc.
Definition at line 332 of file fq-cobalt-queue-disc.cc.
References ns3::FqCobaltFlow::INACTIVE, m_newFlows, m_oldFlows, m_quantum, NS_LOG_DEBUG, NS_LOG_FUNCTION, and ns3::FqCobaltFlow::OLD_FLOW.
|
overrideprivatevirtual |
This function actually enqueues a packet into the queue disc.
item | item to enqueue |
Implements ns3::QueueDisc.
Definition at line 248 of file fq-cobalt-queue-disc.cc.
References ns3::QueueDisc::AddQueueDiscClass(), ns3::QueueDisc::Classify(), ns3::ObjectFactory::Create(), ns3::QueueDisc::DropBeforeEnqueue(), FqCobaltDrop(), ns3::QueueDisc::GetCurrentSize(), ns3::QueueDisc::GetMaxSize(), ns3::QueueDisc::GetNPacketFilters(), ns3::QueueDisc::GetNQueueDiscClasses(), ns3::QueueDisc::GetQueueDiscClass(), ns3::FqCobaltFlow::INACTIVE, m_blueThreshold, m_ceThreshold, m_enableSetAssociativeHash, m_flowFactory, m_flows, m_flowsIndices, m_newFlows, m_perturbation, m_quantum, m_queueDiscFactory, m_useEcn, m_useL4s, ns3::FqCobaltFlow::NEW_FLOW, NS_LOG_DEBUG, NS_LOG_ERROR, NS_LOG_FUNCTION, ns3::PacketFilter::PF_NO_MATCH, SetAssociativeHash(), ns3::ObjectBase::SetAttribute(), ns3::StaticCast(), and UNCLASSIFIED_DROP.
|
private |
Drop a packet from the head of the queue with the largest current byte count.
Definition at line 486 of file fq-cobalt-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().
uint32_t ns3::FqCobaltQueueDisc::GetQuantum | ( | ) | const |
Get the quantum value.
Definition at line 212 of file fq-cobalt-queue-disc.cc.
References m_quantum.
|
static |
Get the type ID.
Definition at line 106 of file fq-cobalt-queue-disc.cc.
References ns3::QueueDisc::GetMaxSize(), m_blueThreshold, m_ceThreshold, m_decrement, m_dropBatchSize, m_enableSetAssociativeHash, m_flows, m_increment, m_interval, m_Pdrop, m_perturbation, m_setWays, m_target, m_useEcn, m_useL4s, ns3::MakeBooleanAccessor(), ns3::MakeBooleanChecker(), ns3::MakeDoubleAccessor(), ns3::MakeDoubleChecker(), ns3::MakeQueueSizeAccessor(), ns3::MakeQueueSizeChecker(), ns3::MakeStringAccessor(), ns3::MakeStringChecker(), ns3::MakeTimeAccessor(), ns3::MakeTimeChecker(), ns3::MakeUintegerAccessor(), ns3::MakeUintegerChecker(), ns3::Time::Max(), ns3::MilliSeconds(), ns3::QueueDisc::SetMaxSize(), and ns3::TypeId::SetParent().
|
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.
Implements ns3::QueueDisc.
Definition at line 470 of file fq-cobalt-queue-disc.cc.
References ns3::QueueDisc::GetMaxSize(), m_decrement, m_flowFactory, m_increment, m_interval, m_Pdrop, m_queueDiscFactory, m_target, NS_LOG_FUNCTION, ns3::ObjectFactory::Set(), and ns3::ObjectFactory::SetTypeId().
Compute the index of the queue for the flow having the given flowHash, according to the set associative hash approach.
flowHash | the hash of the flow 5-tuple |
Definition at line 218 of file fq-cobalt-queue-disc.cc.
References ns3::QueueDisc::GetQueueDiscClass(), ns3::FqCobaltFlow::INACTIVE, m_flows, m_flowsIndices, m_setWays, m_tags, NS_LOG_FUNCTION, and ns3::StaticCast().
Referenced by DoEnqueue().
void ns3::FqCobaltQueueDisc::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 205 of file fq-cobalt-queue-disc.cc.
References m_quantum, and NS_LOG_FUNCTION.
|
private |
Threshold to enable blue enhancement.
Definition at line 180 of file fq-cobalt-queue-disc.h.
Referenced by DoEnqueue(), and GetTypeId().
|
private |
Threshold above which to CE mark.
Definition at line 174 of file fq-cobalt-queue-disc.h.
Referenced by CheckConfig(), DoEnqueue(), and GetTypeId().
|
private |
decrement value for marking probability
Definition at line 178 of file fq-cobalt-queue-disc.h.
Referenced by GetTypeId(), and InitializeParams().
|
private |
Max number of packets dropped from the fat flow.
Definition at line 171 of file fq-cobalt-queue-disc.h.
Referenced by FqCobaltDrop(), and GetTypeId().
|
private |
whether to enable set associative hash
Definition at line 175 of file fq-cobalt-queue-disc.h.
Referenced by CheckConfig(), DoEnqueue(), and GetTypeId().
|
private |
Factory to create a new flow.
Definition at line 188 of file fq-cobalt-queue-disc.h.
Referenced by DoEnqueue(), and InitializeParams().
|
private |
Number of flow queues.
Definition at line 169 of file fq-cobalt-queue-disc.h.
Referenced by CheckConfig(), DoEnqueue(), GetTypeId(), and SetAssociativeHash().
Map with the index of class for each flow.
Definition at line 185 of file fq-cobalt-queue-disc.h.
Referenced by DoEnqueue(), and SetAssociativeHash().
|
private |
increment value for marking probability
Definition at line 177 of file fq-cobalt-queue-disc.h.
Referenced by GetTypeId(), and InitializeParams().
|
private |
CoDel interval attribute.
Definition at line 166 of file fq-cobalt-queue-disc.h.
Referenced by GetTypeId(), and InitializeParams().
|
private |
The list of new flows.
Definition at line 182 of file fq-cobalt-queue-disc.h.
Referenced by DoDequeue(), and DoEnqueue().
|
private |
The list of old flows.
Definition at line 183 of file fq-cobalt-queue-disc.h.
Referenced by DoDequeue().
|
private |
Drop Probability.
Definition at line 179 of file fq-cobalt-queue-disc.h.
Referenced by GetTypeId(), and InitializeParams().
|
private |
hash perturbation value
Definition at line 172 of file fq-cobalt-queue-disc.h.
Referenced by DoEnqueue(), and GetTypeId().
|
private |
Deficit assigned to flows at each round.
Definition at line 168 of file fq-cobalt-queue-disc.h.
Referenced by CheckConfig(), DoDequeue(), DoEnqueue(), GetQuantum(), and SetQuantum().
|
private |
Factory to create a new queue.
Definition at line 189 of file fq-cobalt-queue-disc.h.
Referenced by DoEnqueue(), and InitializeParams().
|
private |
size of a set of queues (used by set associative hash)
Definition at line 170 of file fq-cobalt-queue-disc.h.
Referenced by CheckConfig(), GetTypeId(), and SetAssociativeHash().
Tags used by set associative hash.
Definition at line 186 of file fq-cobalt-queue-disc.h.
Referenced by SetAssociativeHash().
|
private |
CoDel target attribute.
Definition at line 167 of file fq-cobalt-queue-disc.h.
Referenced by GetTypeId(), and InitializeParams().
|
private |
True if ECN is used (packets are marked instead of being dropped)
Definition at line 173 of file fq-cobalt-queue-disc.h.
Referenced by CheckConfig(), DoEnqueue(), and GetTypeId().
|
private |
True if L4S is used (ECT1 packets are marked at CE threshold)
Definition at line 176 of file fq-cobalt-queue-disc.h.
Referenced by CheckConfig(), DoEnqueue(), and GetTypeId().
|
staticconstexpr |
Overlimit dropped packets.
Definition at line 143 of file fq-cobalt-queue-disc.h.
Referenced by FqCobaltDrop().
|
staticconstexpr |
No packet filter able to classify packet.
Definition at line 141 of file fq-cobalt-queue-disc.h.
Referenced by DoEnqueue().