Linux pfifo_fast is the default priority queue enabled on Linux systems. More...
#include "pfifo-fast-queue-disc.h"
Public Member Functions | |
PfifoFastQueueDisc () | |
PfifoFastQueueDisc constructor. More... | |
virtual | ~PfifoFastQueueDisc () |
![]() | |
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... | |
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) const |
This function returns a copy of the next packet the queue disc will extract. More... | |
virtual void | InitializeParams (void) |
Initialize parameters (if any) before the first packet is enqueued. More... | |
Private Attributes | |
uint32_t | m_limit |
Maximum number of packets that can be stored. More... | |
Static Private Attributes | |
static const uint32_t | prio2band [16] = {1, 2, 2, 2, 1, 2, 0, 0, 1, 1, 1, 1, 1, 1, 1, 1} |
Priority to band map. More... | |
Additional Inherited Members | |
![]() | |
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... | |
![]() | |
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... | |
![]() | |
static TypeId | GetObjectIid (void) |
Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. More... | |
Linux pfifo_fast is the default priority queue enabled on Linux systems.
Introspection did not find any typical Config paths.
Packets are enqueued in three FIFO droptail queues according to three priority bands based on the packet priority.
The system behaves similar to three ns3::DropTail queues operating together, in which packets from higher priority bands are always dequeued before a packet from a lower priority band is dequeued.
The queue disc capacity, i.e., the maximum number of packets that can be enqueued in the queue disc, is set through the limit attribute, which plays the same role as txqueuelen in Linux. If no internal queue is provided, three DropTail queues having each a capacity equal to limit are created by default. User is allowed to provide queues, but they must be three, operate in packet mode and each have a capacity not less than limit. No packet filter can be provided.
No TraceSources are defined for this type.
Size of this type is 296 bytes (on a 64-bit architecture).
Definition at line 49 of file pfifo-fast-queue-disc.h.
ns3::PfifoFastQueueDisc::PfifoFastQueueDisc | ( | ) |
PfifoFastQueueDisc constructor.
Creates a queue with a depth of 1000 packets per band by default
Definition at line 51 of file pfifo-fast-queue-disc.cc.
References NS_LOG_FUNCTION.
|
virtual |
Definition at line 56 of file pfifo-fast-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 135 of file pfifo-fast-queue-disc.cc.
References ns3::QueueDisc::AddInternalQueue(), ns3::ObjectFactory::Create(), ns3::QueueDisc::GetInternalQueue(), ns3::QueueDisc::GetNInternalQueues(), ns3::QueueDisc::GetNPacketFilters(), ns3::QueueDisc::GetNQueueDiscClasses(), m_limit, NS_LOG_ERROR, NS_LOG_FUNCTION, ns3::Queue::QUEUE_MODE_PACKETS, ns3::ObjectFactory::Set(), and ns3::ObjectFactory::SetTypeId().
|
privatevirtual |
This function actually extracts a packet from the queue disc.
Implements ns3::QueueDisc.
Definition at line 95 of file pfifo-fast-queue-disc.cc.
References ns3::QueueDisc::Dequeue(), ns3::QueueDisc::GetInternalQueue(), ns3::QueueDisc::GetNInternalQueues(), ns3::QueueDisc::GetNPackets(), NS_LOG_FUNCTION, and NS_LOG_LOGIC.
|
privatevirtual |
This function actually enqueues a packet into the queue disc.
item | item to enqueue |
Implements ns3::QueueDisc.
Definition at line 64 of file pfifo-fast-queue-disc.cc.
References ns3::QueueDisc::Drop(), ns3::QueueDisc::GetInternalQueue(), ns3::QueueDisc::GetNPackets(), ns3::SocketPriorityTag::GetPriority(), m_limit, NS_LOG_FUNCTION, NS_LOG_LOGIC, and prio2band.
|
privatevirtual |
This function returns a copy of the next packet the queue disc will extract.
Implements ns3::QueueDisc.
Definition at line 116 of file pfifo-fast-queue-disc.cc.
References ns3::QueueDisc::GetInternalQueue(), ns3::QueueDisc::GetNInternalQueues(), ns3::QueueDisc::GetNPackets(), NS_LOG_FUNCTION, and NS_LOG_LOGIC.
|
static |
Get the type ID.
Definition at line 36 of file pfifo-fast-queue-disc.cc.
References m_limit, ns3::MakeUintegerAccessor(), and ns3::TypeId::SetParent().
|
privatevirtual |
Initialize parameters (if any) before the first packet is enqueued.
Implements ns3::QueueDisc.
Definition at line 189 of file pfifo-fast-queue-disc.cc.
References NS_LOG_FUNCTION.
|
private |
Maximum number of packets that can be stored.
Definition at line 78 of file pfifo-fast-queue-disc.h.
Referenced by CheckConfig(), DoEnqueue(), and GetTypeId().
|
staticprivate |
Priority to band map.
Values are taken from the prio2band array used by the Linux pfifo_fast queue disc.
Definition at line 70 of file pfifo-fast-queue-disc.h.
Referenced by DoEnqueue().