|
A Discrete-Event Network Simulator
|
API |
|
|
A Discrete-Event Network Simulator
|
API |
The Prio qdisc is a simple classful queueing discipline that contains an arbitrary number of classes of differing priority. More...
#include "prio-queue-disc.h"
Inheritance diagram for ns3::PrioQueueDisc:Public Member Functions | |
| PrioQueueDisc () | |
| PrioQueueDisc constructor. More... | |
| virtual | ~PrioQueueDisc () |
| uint16_t | GetBandForPriority (uint8_t prio) const |
| Get the band (class) assigned to packets with specified priority. More... | |
| void | SetBandForPriority (uint8_t prio, uint16_t band) |
| Set the band (class) assigned to packets with specified priority. More... | |
| Public Member Functions inherited from ns3::QueueDisc | |
| 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) |
| 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. 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 (std::size_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... | |
| std::size_t | GetNInternalQueues (void) const |
| Get the number of internal queues. More... | |
| std::size_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... | |
| std::size_t | GetNQueueDiscClasses (void) const |
| Get the number of queue disc classes. More... | |
| Ptr< PacketFilter > | GetPacketFilter (std::size_t i) const |
| Get the i-th packet filter. More... | |
| Ptr< QueueDiscClass > | GetQueueDiscClass (std::size_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. 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... | |
| Public Member Functions inherited from ns3::Object | |
| 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... | |
| Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter > | |
| 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... | |
| Public Member Functions inherited from ns3::ObjectBase | |
| 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 Public Member Functions inherited from ns3::QueueDisc | |
| static TypeId | GetTypeId (void) |
| Get the type ID. More... | |
| Static Public Member Functions inherited from ns3::Object | |
| static TypeId | GetTypeId (void) |
| Register this type. More... | |
| Static Public Member Functions inherited from ns3::ObjectBase | |
| 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) |
| Return 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 | |
| Priomap | m_prio2band |
| Priority to band mapping. More... | |
Additional Inherited Members | |
| Public Types inherited from ns3::QueueDisc | |
| 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... | |
| Static Public Attributes inherited from ns3::QueueDisc | |
| 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... | |
| Protected Member Functions inherited from ns3::QueueDisc | |
| 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... | |
| Protected Member Functions inherited from ns3::Object | |
| 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... | |
| Protected Member Functions inherited from ns3::ObjectBase | |
| 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... | |
| Related Functions inherited from ns3::ObjectBase | |
| static TypeId | GetObjectIid (void) |
| Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. More... | |
The Prio qdisc is a simple classful queueing discipline that contains an arbitrary number of classes of differing priority.
Introspection did not find any typical Config paths.
The classes are dequeued in numerical descending order of priority. By default, three Fifo queue discs are created, unless the user provides (at least two) child queue discs.
If no packet filter is installed or able to classify a packet, then the packet is assigned a priority band based on its priority (modulo 16), which is used as an index into an array called priomap. If a packet is classified by a packet filter and the returned value is non-negative and less than the number of priority bands, then the packet is assigned the priority band corresponding to the value returned by the packet filter. Otherwise, the packet is assigned the priority band specified by the first element of the priomap array.
No TraceSources are defined for this type.
Size of this type is 960 bytes (on a 64-bit architecture).
Definition at line 49 of file prio-queue-disc.h.
| ns3::PrioQueueDisc::PrioQueueDisc | ( | ) |
PrioQueueDisc constructor.
Definition at line 71 of file prio-queue-disc.cc.
References NS_LOG_FUNCTION.
|
virtual |
Definition at line 77 of file prio-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 185 of file prio-queue-disc.cc.
References ns3::QueueDisc::AddQueueDiscClass(), ns3::ObjectFactory::Create(), ns3::QueueDisc::GetNInternalQueues(), ns3::QueueDisc::GetNQueueDiscClasses(), ns3::Object::Initialize(), NS_LOG_ERROR, NS_LOG_FUNCTION, and ns3::ObjectFactory::SetTypeId().
|
privatevirtual |
This function actually extracts a packet from the queue disc.
Implements ns3::QueueDisc.
Definition at line 143 of file prio-queue-disc.cc.
References ns3::QueueDisc::Dequeue(), ns3::QueueDisc::GetNPackets(), ns3::QueueDisc::GetNQueueDiscClasses(), ns3::QueueDisc::GetQueueDiscClass(), 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 103 of file prio-queue-disc.cc.
References ns3::QueueDisc::Classify(), ns3::QueueDisc::GetNPackets(), ns3::QueueDisc::GetNQueueDiscClasses(), ns3::SocketPriorityTag::GetPriority(), ns3::QueueDisc::GetQueueDiscClass(), m_prio2band, NS_ASSERT_MSG(), NS_LOG_DEBUG, NS_LOG_FUNCTION, NS_LOG_LOGIC(), and ns3::PacketFilter::PF_NO_MATCH.
|
privatevirtual |
Return a copy of the next packet the queue disc will extract.
The implementation of this method is based on the qdisc_peek_dequeued function of the Linux kernel, which dequeues a packet and retains it in the queue disc as a requeued packet. The packet is not traced as requeued, nor is the total count of requeued packets increased. The packet is still considered to be part of the queue disc and the dequeue trace is fired when Dequeue is called and the packet is actually extracted from the queue disc.
This approach is especially recommended for queue discs for which it is not obvious what is the next packet that will be dequeued (e.g., queue discs having multiple internal queues or child queue discs or queue discs that drop packets after dequeue). Subclasses can however provide their own implementation of this method that overrides the default one.
Reimplemented from ns3::QueueDisc.
Definition at line 164 of file prio-queue-disc.cc.
References ns3::QueueDisc::GetNPackets(), ns3::QueueDisc::GetNQueueDiscClasses(), ns3::QueueDisc::GetQueueDiscClass(), NS_LOG_FUNCTION, NS_LOG_LOGIC(), and ns3::QueueDisc::Peek().
| uint16_t ns3::PrioQueueDisc::GetBandForPriority | ( | uint8_t | prio | ) | const |
Get the band (class) assigned to packets with specified priority.
| prio | the priority of packets (a value between 0 and 15). |
Definition at line 93 of file prio-queue-disc.cc.
References m_prio2band, NS_ASSERT_MSG(), and NS_LOG_FUNCTION.
Referenced by PrioQueueDiscTestCase::DoRun().
|
static |
Get the type ID.
Definition at line 57 of file prio-queue-disc.cc.
References m_prio2band, ns3::MakePriomapAccessor(), ns3::MakePriomapChecker(), and ns3::TypeId::SetParent().
|
privatevirtual |
Initialize parameters (if any) before the first packet is enqueued.
Implements ns3::QueueDisc.
Definition at line 219 of file prio-queue-disc.cc.
References NS_LOG_FUNCTION.
| void ns3::PrioQueueDisc::SetBandForPriority | ( | uint8_t | prio, |
| uint16_t | band | ||
| ) |
Set the band (class) assigned to packets with specified priority.
| prio | the priority of packets (a value between 0 and 15). |
| band | the band assigned to packets. |
Definition at line 83 of file prio-queue-disc.cc.
References m_prio2band, NS_ASSERT_MSG(), and NS_LOG_FUNCTION.
|
private |
Priority to band mapping.
Definition at line 86 of file prio-queue-disc.h.
Referenced by DoEnqueue(), GetBandForPriority(), GetTypeId(), and SetBandForPriority().
1.8.14
