A Discrete-Event Network Simulator
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2016 Universita' degli Studi di Napoli Federico II
4  * Copyright (c) 2018 NITK Surathkal (modified for FQ-PIE)
5  *
6  * This program is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License version 2 as
8  * published by the Free Software Foundation;
9  *
10  * This program is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * GNU General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License
16  * along with this program; if not, write to the Free Software
17  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18  *
19  * Authors: Pasquale Imputato <p.imputato@gmail.com>
20  * Stefano Avallone <stefano.avallone@unina.it>
21  * Modified for FQ-PIE by: Sumukha PK <sumukhapk46@gmail.com>
22  * Prajval M <26prajval98@gmail.com>
23  * Ishaan R D <ishaanrd6@gmail.com>
24  * Mohit P. Tahiliani <tahiliani@nitk.edu.in>
25  */
27 #ifndef FQ_PIE_QUEUE_DISC
28 #define FQ_PIE_QUEUE_DISC
30 #include "ns3/queue-disc.h"
31 #include "ns3/object-factory.h"
32 #include <list>
33 #include <map>
35 namespace ns3 {
43 class FqPieFlow : public QueueDiscClass
44 {
45 public:
50  static TypeId GetTypeId (void);
54  FqPieFlow ();
56  virtual ~FqPieFlow ();
63  {
67  };
73  void SetDeficit (uint32_t deficit);
78  int32_t GetDeficit (void) const;
83  void IncreaseDeficit (int32_t deficit);
88  void SetStatus (FlowStatus status);
93  FlowStatus GetStatus (void) const;
98  void SetIndex (uint32_t index);
103  uint32_t GetIndex (void) const;
105 private:
106  int32_t m_deficit;
108  uint32_t m_index;
109 };
118 class FqPieQueueDisc : public QueueDisc
119 {
120 public:
125  static TypeId GetTypeId (void);
129  FqPieQueueDisc ();
131  virtual ~FqPieQueueDisc ();
138  void SetQuantum (uint32_t quantum);
145  uint32_t GetQuantum (void) const;
147  // Reasons for dropping packets
148  static constexpr const char* UNCLASSIFIED_DROP = "Unclassified drop";
149  static constexpr const char* OVERLIMIT_DROP = "Overlimit drop";
151 private:
152  virtual bool DoEnqueue (Ptr<QueueDiscItem> item);
153  virtual Ptr<QueueDiscItem> DoDequeue (void);
154  virtual bool CheckConfig (void);
155  virtual void InitializeParams (void);
161  uint32_t FqPieDrop (void);
170  uint32_t SetAssociativeHash (uint32_t flowHash);
172  // PIE queue disc parameter
173  bool m_useEcn;
174  double m_markEcnTh;
176  bool m_useL4s;
180  uint32_t m_meanPktSize;
182  double m_a;
183  double m_b;
184  uint32_t m_dqThreshold;
189  // Fq parameters
190  uint32_t m_quantum;
191  uint32_t m_flows;
192  uint32_t m_setWays;
193  uint32_t m_dropBatchSize;
194  uint32_t m_perturbation;
197  std::list<Ptr<FqPieFlow> > m_newFlows;
198  std::list<Ptr<FqPieFlow> > m_oldFlows;
200  std::map<uint32_t, uint32_t> m_flowsIndices;
201  std::map<uint32_t, uint32_t> m_tags;
205 };
207 } // namespace ns3
209 #endif /* FQ_PIE_QUEUE_DISC */
bool m_useL4s
True if L4S is used (ECT1 packets are marked at CE threshold)
double m_a
Parameter to pie controller.
double m_b
Parameter to pie controller.
void SetQuantum(uint32_t quantum)
Set the quantum value.
bool m_useDerandomization
Enable Derandomization feature mentioned in RFC 8033.
Simulation virtual time values and global simulation resolution.
Definition: nstime.h:103
std::map< uint32_t, uint32_t > m_flowsIndices
Map with the index of class for each flow.
Smart pointer class similar to boost::intrusive_ptr.
Definition: ptr.h:73
void SetStatus(FlowStatus status)
Set the status for this flow.
ObjectFactory m_flowFactory
Factory to create a new flow.
virtual bool DoEnqueue(Ptr< QueueDiscItem > item)
This function actually enqueues a packet into the queue disc.
double m_markEcnTh
ECN marking threshold (default 10% as suggested in RFC 8033)
A FqPie packet queue disc.
void SetDeficit(uint32_t deficit)
Set the deficit for this flow.
uint32_t FqPieDrop(void)
Drop a packet from the head of the queue with the largest current byte count.
QueueDisc is an abstract base class providing the interface and implementing the operations common to...
Definition: queue-disc.h:181
FlowStatus m_status
the status of this flow
uint32_t m_perturbation
hash perturbation value
int32_t GetDeficit(void) const
Get the deficit for this flow.
void IncreaseDeficit(int32_t deficit)
Increase the deficit for this flow.
static TypeId GetTypeId(void)
Get the type ID.
void SetIndex(uint32_t index)
Set the index for this flow.
uint32_t GetQuantum(void) const
Get the quantum value.
Time m_ceThreshold
Threshold above which to CE mark.
bool m_isCapDropAdjustment
Enable/Disable Cap Drop Adjustment feature mentioned in RFC 8033.
static constexpr const char * OVERLIMIT_DROP
Overlimit dropped packets.
uint32_t GetIndex(void) const
Get the index of this flow.
bool m_useEcn
True if ECN is used (packets are marked instead of being dropped)
uint32_t m_index
the index for this flow
uint32_t m_meanPktSize
Average packet size in bytes.
FqPieFlow constructor.
std::list< Ptr< FqPieFlow > > m_newFlows
The list of new flows.
QueueDiscClass is the base class for classes that are included in a queue disc.
Definition: queue-disc.h:49
static constexpr const char * UNCLASSIFIED_DROP
No packet filter able to classify packet.
Every class exported by the ns3 library is enclosed in the ns3 namespace.
virtual Ptr< QueueDiscItem > DoDequeue(void)
This function actually extracts a packet from the queue disc.
uint32_t m_setWays
size of a set of queues (used by set associative hash)
Time m_maxBurst
Maximum burst allowed before random early dropping kicks in.
uint32_t m_quantum
Deficit assigned to flows at each round.
static TypeId GetTypeId(void)
Get the type ID.
uint32_t SetAssociativeHash(uint32_t flowHash)
Compute the index of the queue for the flow having the given flowHash, according to the set associati...
Instantiate subclasses of ns3::Object.
virtual bool CheckConfig(void)
Check whether the current configuration is correct.
int32_t m_deficit
the deficit for this flow
virtual void InitializeParams(void)
Initialize parameters (if any) before the first packet is enqueued.
Time m_tUpdate
Time period after which CalculateP () is called.
A flow queue used by the FqPie queue disc.
Time m_sUpdate
Start time of the update timer.
std::map< uint32_t, uint32_t > m_tags
Tags used by set associative hash.
FlowStatus GetStatus(void) const
Get the status of this flow.
bool m_useDqRateEstimator
Enable/Disable usage of dequeue rate estimator for queue delay calculation.
uint32_t m_flows
Number of flow queues.
std::list< Ptr< FqPieFlow > > m_oldFlows
The list of old flows.
Time m_qDelayRef
Desired queue delay.
ObjectFactory m_queueDiscFactory
Factory to create a new queue.
bool m_enableSetAssociativeHash
whether to enable set associative hash
uint32_t m_dropBatchSize
Max number of packets dropped from the fat flow.
a unique identifier for an interface.
Definition: type-id.h:58
Used to determine the status of this flow queue.
FqPieQueueDisc constructor.
uint32_t m_dqThreshold
Minimum queue size in bytes before dequeue rate is measured.