A Discrete-Event Network Simulator
API
Loading...
Searching...
No Matches
fq-pie-queue-disc.h
Go to the documentation of this file.
1/*
2 * Copyright (c) 2016 Universita' degli Studi di Napoli Federico II
3 * Copyright (c) 2018 NITK Surathkal (modified for FQ-PIE)
4 *
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License version 2 as
7 * published by the Free Software Foundation;
8 *
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
13 *
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write to the Free Software
16 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17 *
18 * Authors: Pasquale Imputato <p.imputato@gmail.com>
19 * Stefano Avallone <stefano.avallone@unina.it>
20 * Modified for FQ-PIE by: Sumukha PK <sumukhapk46@gmail.com>
21 * Prajval M <26prajval98@gmail.com>
22 * Ishaan R D <ishaanrd6@gmail.com>
23 * Mohit P. Tahiliani <tahiliani@nitk.edu.in>
24 */
25
26#ifndef FQ_PIE_QUEUE_DISC
27#define FQ_PIE_QUEUE_DISC
28
29#include "queue-disc.h"
30
31#include "ns3/object-factory.h"
32
33#include <list>
34#include <map>
35
36namespace ns3
37{
38
46{
47 public:
52 static TypeId GetTypeId();
56 FqPieFlow();
57
58 ~FqPieFlow() override;
59
65 {
69 };
70
75 void SetDeficit(uint32_t deficit);
80 int32_t GetDeficit() const;
85 void IncreaseDeficit(int32_t deficit);
90 void SetStatus(FlowStatus status);
95 FlowStatus GetStatus() const;
100 void SetIndex(uint32_t index);
105 uint32_t GetIndex() const;
106
107 private:
111};
112
120{
121 public:
126 static TypeId GetTypeId();
131
132 ~FqPieQueueDisc() override;
133
140 void SetQuantum(uint32_t quantum);
141
148 uint32_t GetQuantum() const;
149
150 // Reasons for dropping packets
151 static constexpr const char* UNCLASSIFIED_DROP =
152 "Unclassified drop";
153 static constexpr const char* OVERLIMIT_DROP = "Overlimit drop";
154
155 private:
156 bool DoEnqueue(Ptr<QueueDiscItem> item) override;
157 Ptr<QueueDiscItem> DoDequeue() override;
158 bool CheckConfig() override;
159 void InitializeParams() override;
160
166
175
176 // PIE queue disc parameter
177 bool m_useEcn;
178 double m_markEcnTh;
180 bool m_useL4s;
186 double m_a;
187 double m_b;
191 bool
194
195 // Fq parameters
202
203 std::list<Ptr<FqPieFlow>> m_newFlows;
204 std::list<Ptr<FqPieFlow>> m_oldFlows;
205
206 std::map<uint32_t, uint32_t> m_flowsIndices;
207 std::map<uint32_t, uint32_t> m_tags;
208
211};
212
213} // namespace ns3
214
215#endif /* FQ_PIE_QUEUE_DISC */
A flow queue used by the FqPie queue disc.
void SetIndex(uint32_t index)
Set the index for this flow.
FlowStatus
Used to determine the status of this flow queue.
int32_t m_deficit
the deficit for this flow
void SetStatus(FlowStatus status)
Set the status for this flow.
static TypeId GetTypeId()
Get the type ID.
~FqPieFlow() override
FlowStatus GetStatus() const
Get the status of this flow.
FlowStatus m_status
the status of this flow
uint32_t m_index
the index for this flow
void SetDeficit(uint32_t deficit)
Set the deficit for this flow.
uint32_t GetIndex() const
Get the index of this flow.
FqPieFlow()
FqPieFlow constructor.
void IncreaseDeficit(int32_t deficit)
Increase the deficit for this flow.
int32_t GetDeficit() const
Get the deficit for this flow.
A FqPie packet queue disc.
Time m_qDelayRef
Desired queue delay.
std::map< uint32_t, uint32_t > m_tags
Tags used by set associative hash.
bool m_useEcn
True if ECN is used (packets are marked instead of being dropped)
bool m_enableSetAssociativeHash
whether to enable set associative hash
uint32_t m_meanPktSize
Average packet size in bytes.
static constexpr const char * UNCLASSIFIED_DROP
No packet filter able to classify packet.
uint32_t GetQuantum() const
Get the quantum value.
uint32_t m_perturbation
hash perturbation value
FqPieQueueDisc()
FqPieQueueDisc constructor.
ObjectFactory m_queueDiscFactory
Factory to create a new queue.
bool DoEnqueue(Ptr< QueueDiscItem > item) override
This function actually enqueues a packet into the queue disc.
double m_a
Parameter to pie controller.
Time m_sUpdate
Start time of the update timer.
bool m_useDqRateEstimator
Enable/Disable usage of dequeue rate estimator for queue delay calculation.
Time m_ceThreshold
Threshold above which to CE mark.
uint32_t m_dqThreshold
Minimum queue size in bytes before dequeue rate is measured.
Ptr< QueueDiscItem > DoDequeue() override
This function actually extracts a packet from the queue disc.
bool CheckConfig() override
Check whether the current configuration is correct.
uint32_t m_dropBatchSize
Max number of packets dropped from the fat flow.
uint32_t m_quantum
Deficit assigned to flows at each round.
Time m_tUpdate
Time period after which CalculateP () is called.
uint32_t FqPieDrop()
Drop a packet from the head of the queue with the largest current byte count.
bool m_isCapDropAdjustment
Enable/Disable Cap Drop Adjustment feature mentioned in RFC 8033.
std::list< Ptr< FqPieFlow > > m_newFlows
The list of new flows.
Time m_maxBurst
Maximum burst allowed before random early dropping kicks in.
bool m_useDerandomization
Enable Derandomization feature mentioned in RFC 8033.
uint32_t m_setWays
size of a set of queues (used by set associative hash)
uint32_t m_flows
Number of flow queues.
static TypeId GetTypeId()
Get the type ID.
double m_markEcnTh
ECN marking threshold (default 10% as suggested in RFC 8033)
void InitializeParams() override
Initialize parameters (if any) before the first packet is enqueued.
std::map< uint32_t, uint32_t > m_flowsIndices
Map with the index of class for each flow.
uint32_t SetAssociativeHash(uint32_t flowHash)
Compute the index of the queue for the flow having the given flowHash, according to the set associati...
static constexpr const char * OVERLIMIT_DROP
Overlimit dropped packets.
bool m_useL4s
True if L4S is used (ECT1 packets are marked at CE threshold)
void SetQuantum(uint32_t quantum)
Set the quantum value.
double m_b
Parameter to pie controller.
ObjectFactory m_flowFactory
Factory to create a new flow.
std::list< Ptr< FqPieFlow > > m_oldFlows
The list of old flows.
Instantiate subclasses of ns3::Object.
Smart pointer class similar to boost::intrusive_ptr.
Definition: ptr.h:77
QueueDiscClass is the base class for classes that are included in a queue disc.
Definition: queue-disc.h:52
QueueDisc is an abstract base class providing the interface and implementing the operations common to...
Definition: queue-disc.h:184
Simulation virtual time values and global simulation resolution.
Definition: nstime.h:105
a unique identifier for an interface.
Definition: type-id.h:59
Every class exported by the ns3 library is enclosed in the ns3 namespace.