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 NITK Surathkal
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
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: Shravya Ks <shravya.ks0@gmail.com>
19  * Smriti Murali <m.smriti.95@gmail.com>
20  * Mohit P. Tahiliani <tahiliani@nitk.edu.in>
21  */
23 /*
24  * PORT NOTE: This code was ported from ns-2.36rc1 (queue/pie.h).
25  * Most of the comments are also ported from the same.
26  */
28 #ifndef PIE_QUEUE_DISC_H
29 #define PIE_QUEUE_DISC_H
31 #include "ns3/queue-disc.h"
32 #include "ns3/nstime.h"
33 #include "ns3/boolean.h"
34 #include "ns3/data-rate.h"
35 #include "ns3/timer.h"
36 #include "ns3/event-id.h"
37 #include "ns3/random-variable-stream.h"
39 #define BURST_RESET_TIMEOUT 1.5
41 class PieQueueDiscTestCase; // Forward declaration for unit test
42 namespace ns3 {
44 class TraceContainer;
45 class UniformRandomVariable;
52 class PieQueueDisc : public QueueDisc
53 {
54 public:
59  static TypeId GetTypeId (void);
64  PieQueueDisc ();
69  virtual ~PieQueueDisc ();
75  {
79  };
86  Time GetQueueDelay (void);
95  int64_t AssignStreams (int64_t stream);
97  // Reasons for dropping packets
98  static constexpr const char* UNFORCED_DROP = "Unforced drop";
99  static constexpr const char* FORCED_DROP = "Forced drop";
100  static constexpr const char* UNFORCED_MARK = "Unforced mark";
102 protected:
106  virtual void DoDispose (void);
108 private:
109  friend class::PieQueueDiscTestCase; // Test code
110  virtual bool DoEnqueue (Ptr<QueueDiscItem> item);
111  virtual Ptr<QueueDiscItem> DoDequeue (void);
112  virtual bool CheckConfig (void);
117  virtual void InitializeParams (void);
125  bool DropEarly (Ptr<QueueDiscItem> item, uint32_t qSize);
132  void CalculateP ();
136  // ** Variables supplied by user
140  uint32_t m_meanPktSize;
142  double m_a;
143  double m_b;
144  uint32_t m_dqThreshold;
147  bool m_useEcn;
149  double m_markEcnTh;
152  // ** Variables maintained by PIE
153  double m_dropProb;
157  uint32_t m_burstReset;
160  double m_avgDqRate;
161  double m_dqStart;
162  uint64_t m_dqCount;
165  double m_accuProb;
166  bool m_active;
167 };
169 }; // namespace ns3
171 #endif
Pie Queue Disc Test Case.
Burst types.
Simulation virtual time values and global simulation resolution.
Definition: nstime.h:103
Time m_tUpdate
Time period after which CalculateP () is called.
Smart pointer class similar to boost::intrusive_ptr.
Definition: ptr.h:73
static constexpr const char * UNFORCED_MARK
Early probability marks: proactive.
double m_avgDqRate
Time averaged dequeue rate.
Time m_maxBurst
Maximum burst allowed before random early dropping kicks in.
double m_markEcnTh
ECN marking threshold (default 10% as suggested in RFC 8033)
double m_a
Parameter to pie controller.
Time m_activeThreshold
Threshold for activating PIE (disabled by default)
static constexpr const char * FORCED_DROP
Drops due to queue limit: reactive.
virtual void InitializeParams(void)
Initialize the queue parameters.
bool m_active
Indicates whether PIE is in active state or not.
uint32_t m_burstReset
Used to reset value of burst allowance.
static constexpr const char * UNFORCED_DROP
Early probability drops: proactive.
QueueDisc is an abstract base class providing the interface and implementing the operations common to...
Definition: queue-disc.h:181
Implements PIE Active Queue Management discipline.
double m_accuProb
Accumulated drop probability.
Time m_qDelayRef
Desired queue delay.
double m_dropProb
Variable used in calculation of drop probability.
uint32_t m_meanPktSize
Average packet size in bytes.
Time GetQueueDelay(void)
Get queue delay.
#define max(a, b)
Definition: 80211b.c:43
virtual bool CheckConfig(void)
Check whether the current configuration is correct.
Time m_sUpdate
Start time of the update timer.
bool m_useDqRateEstimator
Enable/Disable usage of dequeue rate estimator for queue delay calculation.
uint32_t m_dqThreshold
Minimum queue size in bytes before dequeue rate is measured.
Time m_qDelayOld
Old value of queue delay.
double m_dqStart
Start timestamp of current measurement cycle.
bool DropEarly(Ptr< QueueDiscItem > item, uint32_t qSize)
Check if a packet needs to be dropped due to probability drop.
virtual void DoDispose(void)
Dispose of the object.
void CalculateP()
Periodically update the drop probability based on the delay samples: not only the current delay sampl...
Every class exported by the ns3 library is enclosed in the ns3 namespace.
EventId m_rtrsEvent
Event used to decide the decision of interval of drop probability calculation.
bool m_useDerandomization
Enable Derandomization feature mentioned in RFC 8033.
Ptr< UniformRandomVariable > m_uv
Rng stream.
PieQueueDisc Constructor.
virtual Ptr< QueueDiscItem > DoDequeue(void)
This function actually extracts a packet from the queue disc.
int64_t AssignStreams(int64_t stream)
Assign a fixed random variable stream number to the random variables used by this model...
Time m_qDelay
Current value of queue delay.
An identifier for simulation events.
Definition: event-id.h:53
static TypeId GetTypeId(void)
Get the type ID.
BurstStateT m_burstState
Used to determine the current state of burst.
Time m_burstAllowance
Current max burst value in seconds that is allowed before random drops kick in.
virtual ~PieQueueDisc()
PieQueueDisc Destructor.
virtual bool DoEnqueue(Ptr< QueueDiscItem > item)
This function actually enqueues a packet into the queue disc.
double m_b
Parameter to pie controller.
uint64_t m_dqCount
Number of bytes departed since current measurement cycle starts.
a unique identifier for an interface.
Definition: type-id.h:58
static const uint64_t DQCOUNT_INVALID
Invalid dqCount value.
bool m_useEcn
Enable ECN Marking functionality.
bool m_inMeasurement
Indicates whether we are in a measurement cycle.
bool m_isCapDropAdjustment
Enable/Disable Cap Drop Adjustment feature mentioned in RFC 8033.