32#include "ns3/net-device-queue-interface.h"
34#include "ns3/string.h"
48 .SetGroupName(
"TrafficControl")
120 TypeId(
"ns3::FqCobaltQueueDisc")
122 .SetGroupName(
"TrafficControl")
124 .AddAttribute(
"UseEcn",
125 "True to use ECN (packets are marked instead of being dropped)",
129 .AddAttribute(
"Interval",
130 "The CoDel algorithm interval for each FqCobalt queue",
134 .AddAttribute(
"Target",
135 "The CoDel algorithm target queue delay for each FqCobalt queue",
139 .AddAttribute(
"MaxSize",
140 "The maximum number of packets accepted by this queue disc",
143 MakeQueueSizeChecker())
144 .AddAttribute(
"Flows",
145 "The number of queues into which the incoming packets are classified",
148 MakeUintegerChecker<uint32_t>())
149 .AddAttribute(
"DropBatchSize",
150 "The maximum number of packets dropped from the fat flow",
153 MakeUintegerChecker<uint32_t>())
154 .AddAttribute(
"Perturbation",
155 "The salt used as an additional input to the hash function used to "
159 MakeUintegerChecker<uint32_t>())
160 .AddAttribute(
"CeThreshold",
161 "The FqCobalt CE threshold for marking packets",
165 .AddAttribute(
"EnableSetAssociativeHash",
166 "Enable/Disable Set Associative Hash",
170 .AddAttribute(
"SetWays",
171 "The size of a set of queues (used by set associative hash)",
174 MakeUintegerChecker<uint32_t>())
175 .AddAttribute(
"UseL4s",
176 "True to use L4S (only ECT1 packets are marked at CE threshold)",
180 .AddAttribute(
"Pdrop",
181 "Marking Probability",
184 MakeDoubleChecker<double>())
185 .AddAttribute(
"Increment",
186 "Pdrop increment value",
189 MakeDoubleChecker<double>())
190 .AddAttribute(
"Decrement",
191 "Pdrop decrement Value",
194 MakeDoubleChecker<double>())
195 .AddAttribute(
"BlueThreshold",
196 "The Threshold after which Blue is enabled",
254 m_tags[outerHash] = flowHash;
276 flowHash =
static_cast<uint32_t>(ret);
280 NS_LOG_ERROR(
"No filter has been able to classify this packet, drop it.");
298 NS_LOG_DEBUG(
"Creating a new flow queue with index " << h);
311 flow->SetQueueDisc(qd);
329 flow->GetQueueDisc()->Enqueue(item);
358 if (flow->GetDeficit() <= 0)
360 NS_LOG_DEBUG(
"Increase deficit for new flow index " << flow->GetIndex());
368 NS_LOG_DEBUG(
"Found a new flow " << flow->GetIndex() <<
" with positive deficit");
377 if (flow->GetDeficit() <= 0)
379 NS_LOG_DEBUG(
"Increase deficit for old flow index " << flow->GetIndex());
386 NS_LOG_DEBUG(
"Found an old flow " << flow->GetIndex() <<
" with positive deficit");
397 item = flow->GetQueueDisc()->Dequeue();
401 NS_LOG_DEBUG(
"Could not get a packet from the selected flow queue");
420 flow->IncreaseDeficit(item->GetSize() * -1);
437 NS_LOG_ERROR(
"FqCobaltQueueDisc cannot have internal queues");
448 if (ndqi && (dev = ndqi->GetObject<
NetDevice>()))
463 NS_LOG_ERROR(
"The number of queues must be an integer multiple of the size "
464 "of the set of queues used by set associative hash");
474 NS_LOG_WARN(
"Enabling ECN as L4S mode is enabled");
510 if (bytes > maxBacklog)
520 uint32_t threshold = maxBacklog >> 1;
526 NS_LOG_DEBUG(
"Drop packet (overflow); count: " << count <<
" len: " << len
527 <<
" threshold: " << threshold);
528 item = qd->GetInternalQueue(0)->Dequeue();
530 len += item->GetSize();
AttributeValue implementation for Boolean.
Cobalt packet queue disc.
This class can be used to hold variables of floating point type such as 'double' or 'float'.
A flow queue used by the FqCobalt queue disc.
FlowStatus GetStatus() const
Get the status of this flow.
void SetDeficit(uint32_t deficit)
Set the deficit for this flow.
FqCobaltFlow()
FqCobaltFlow constructor.
void SetIndex(uint32_t index)
Set the index for this flow.
void IncreaseDeficit(int32_t deficit)
Increase the deficit for this flow.
int32_t m_deficit
the deficit for this flow
uint32_t m_index
the index for this flow
int32_t GetDeficit() const
Get the deficit for this flow.
uint32_t GetIndex() const
Get the index of this flow.
FlowStatus
Used to determine the status of this flow queue.
static TypeId GetTypeId()
Get the type ID.
FlowStatus m_status
the status of this flow
void SetStatus(FlowStatus status)
Set the status for this flow.
A FqCobalt packet queue disc.
ObjectFactory m_flowFactory
Factory to create a new flow.
std::map< uint32_t, uint32_t > m_tags
Tags used by set associative hash.
bool m_useL4s
True if L4S is used (ECT1 packets are marked at CE threshold)
~FqCobaltQueueDisc() override
Ptr< QueueDiscItem > DoDequeue() override
This function actually extracts a packet from the queue disc.
bool CheckConfig() override
Check whether the current configuration is correct.
bool DoEnqueue(Ptr< QueueDiscItem > item) override
This function actually enqueues a packet into the queue disc.
Time m_ceThreshold
Threshold above which to CE mark.
bool m_enableSetAssociativeHash
whether to enable set associative hash
std::map< uint32_t, uint32_t > m_flowsIndices
Map with the index of class for each flow.
std::list< Ptr< FqCobaltFlow > > m_newFlows
The list of new flows.
uint32_t m_quantum
Deficit assigned to flows at each round.
std::list< Ptr< FqCobaltFlow > > m_oldFlows
The list of old flows.
bool m_useEcn
True if ECN is used (packets are marked instead of being dropped)
uint32_t SetAssociativeHash(uint32_t flowHash)
Compute the index of the queue for the flow having the given flowHash, according to the set associati...
std::string m_target
CoDel target attribute.
uint32_t m_perturbation
hash perturbation value
FqCobaltQueueDisc()
FqCobaltQueueDisc constructor.
uint32_t m_dropBatchSize
Max number of packets dropped from the fat flow.
double m_increment
increment value for marking probability
std::string m_interval
CoDel interval attribute.
static constexpr const char * OVERLIMIT_DROP
Overlimit dropped packets.
double m_decrement
decrement value for marking probability
void InitializeParams() override
Initialize parameters (if any) before the first packet is enqueued.
static constexpr const char * UNCLASSIFIED_DROP
No packet filter able to classify packet.
void SetQuantum(uint32_t quantum)
Set the quantum value.
Time m_blueThreshold
Threshold to enable blue enhancement.
uint32_t FqCobaltDrop()
Drop a packet from the head of the queue with the largest current byte count.
ObjectFactory m_queueDiscFactory
Factory to create a new queue.
double m_Pdrop
Drop Probability.
uint32_t m_flows
Number of flow queues.
static TypeId GetTypeId()
Get the type ID.
uint32_t GetQuantum() const
Get the quantum value.
uint32_t m_setWays
size of a set of queues (used by set associative hash)
Network layer to device interface.
void SetAttribute(std::string name, const AttributeValue &value)
Set a single attribute, raising fatal errors if unsuccessful.
Ptr< Object > Create() const
Create an Object instance of the configured TypeId.
void Set(const std::string &name, const AttributeValue &value, Args &&... args)
Set an attribute to be set during construction.
void SetTypeId(TypeId tid)
Set the TypeId of the Objects to be created by this factory.
static const int PF_NO_MATCH
Standard value used by packet filters to indicate that no match was possible.
Smart pointer class similar to boost::intrusive_ptr.
QueueDiscClass is the base class for classes that are included in a queue disc.
QueueDisc is an abstract base class providing the interface and implementing the operations common to...
void AddQueueDiscClass(Ptr< QueueDiscClass > qdClass)
Add a queue disc class to the tail of the list of classes.
QueueSize GetCurrentSize()
Get the current size of the queue disc in bytes, if operating in bytes mode, or packets,...
int32_t Classify(Ptr< QueueDiscItem > item)
Classify a packet by calling the packet filters, one at a time, until either a filter able to classif...
Ptr< NetDeviceQueueInterface > GetNetDeviceQueueInterface() const
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.
std::size_t GetNQueueDiscClasses() const
Get the number of queue disc classes.
QueueSize GetMaxSize() const
Get the maximum size of the queue disc.
Ptr< QueueDiscClass > GetQueueDiscClass(std::size_t i) const
Get the i-th queue disc class.
std::size_t GetNPacketFilters() const
Get the number of packet filters.
bool SetMaxSize(QueueSize size)
Set the maximum size of the queue disc.
std::size_t GetNInternalQueues() const
Get the number of internal queues.
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.
Class for representing queue sizes.
AttributeValue implementation for QueueSize.
Hold variables of type string.
static Time Max()
Maximum representable Time Not to be confused with Max(Time,Time).
AttributeValue implementation for Time.
a unique identifier for an interface.
TypeId SetParent(TypeId tid)
Set the parent TypeId.
Hold an unsigned integer type.
Ptr< const AttributeAccessor > MakeBooleanAccessor(T1 a1)
Ptr< const AttributeChecker > MakeBooleanChecker()
Ptr< const AttributeAccessor > MakeDoubleAccessor(T1 a1)
Ptr< const AttributeChecker > MakeStringChecker()
Ptr< const AttributeAccessor > MakeStringAccessor(T1 a1)
Ptr< const AttributeChecker > MakeTimeChecker()
Helper to make an unbounded Time checker.
Ptr< const AttributeAccessor > MakeTimeAccessor(T1 a1)
Ptr< const AttributeAccessor > MakeUintegerAccessor(T1 a1)
#define NS_ABORT_MSG_IF(cond, msg)
Abnormal program termination if a condition is true, with a message.
#define NS_LOG_ERROR(msg)
Use NS_LOG to output a message of level LOG_ERROR.
#define NS_LOG_COMPONENT_DEFINE(name)
Define a Log component with a specific name.
#define NS_LOG_DEBUG(msg)
Use NS_LOG to output a message of level LOG_DEBUG.
#define NS_LOG_FUNCTION(parameters)
If log level LOG_FUNCTION is enabled, this macro will output all input parameters separated by ",...
#define NS_LOG_WARN(msg)
Use NS_LOG to output a message of level LOG_WARN.
@ INACTIVE
Inactive Period or unslotted CSMA-CA.
#define NS_OBJECT_ENSURE_REGISTERED(type)
Register an Object subclass with the TypeId system.
QueueSizeUnit
Enumeration of the operating modes of queues.
@ PACKETS
Use number of packets for queue size.
Time MilliSeconds(uint64_t value)
Construct a Time in the indicated unit.
QueueDiscSizePolicy
Enumeration of the available policies to handle the queue disc size.
@ MULTIPLE_QUEUES
Used by queue discs with multiple internal queues/child queue discs.
Every class exported by the ns3 library is enclosed in the ns3 namespace.