A Discrete-Event Network Simulator
API
red-queue-disc.h
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright © 2011 Marcos Talau
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  * Author: Marcos Talau (talau@users.sourceforge.net)
19  *
20  * Thanks to: Duy Nguyen<duy@soe.ucsc.edu> by RED efforts in NS3
21  *
22  *
23  * This file incorporates work covered by the following copyright and
24  * permission notice:
25  *
26  * Copyright (c) 1990-1997 Regents of the University of California.
27  * All rights reserved.
28  *
29  * Redistribution and use in source and binary forms, with or without
30  * modification, are permitted provided that the following conditions
31  * are met:
32  * 1. Redistributions of source code must retain the above copyright
33  * notice, this list of conditions and the following disclaimer.
34  * 2. Redistributions in binary form must reproduce the above copyright
35  * notice, this list of conditions and the following disclaimer in the
36  * documentation and/or other materials provided with the distribution.
37  * 3. Neither the name of the University nor of the Laboratory may be used
38  * to endorse or promote products derived from this software without
39  * specific prior written permission.
40  *
41  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
42  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
43  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
44  * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
45  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
46  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
47  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
48  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
49  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
50  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
51  * SUCH DAMAGE.
52  */
53 
54 /*
55  * PORT NOTE: This code was ported from ns-2 (queue/red.h). Almost all
56  * comments also been ported from NS-2.
57  * This implementation aims to be close to the results cited in [0]
58  * [0] S.Floyd, K.Fall http://icir.org/floyd/papers/redsims.ps
59  */
60 
61 #ifndef RED_QUEUE_DISC_H
62 #define RED_QUEUE_DISC_H
63 
64 #include "ns3/queue-disc.h"
65 #include "ns3/nstime.h"
66 #include "ns3/boolean.h"
67 #include "ns3/data-rate.h"
68 #include "ns3/random-variable-stream.h"
69 
70 namespace ns3 {
71 
72 class TraceContainer;
73 
79 class RedQueueDisc : public QueueDisc
80 {
81 public:
86  static TypeId GetTypeId (void);
92  RedQueueDisc ();
93 
99  virtual ~RedQueueDisc ();
100 
105  {
109  };
110 
114  enum
115  {
119  };
120 
126  void SetAredAlpha (double alpha);
127 
133  double GetAredAlpha (void);
134 
140  void SetAredBeta (double beta);
141 
147  double GetAredBeta (void);
148 
154  void SetFengAdaptiveA (double a);
155 
161  double GetFengAdaptiveA (void);
162 
168  void SetFengAdaptiveB (double b);
169 
175  double GetFengAdaptiveB (void);
176 
183  void SetTh (double minTh, double maxTh);
184 
193  int64_t AssignStreams (int64_t stream);
194 
195  // Reasons for dropping packets
196  static constexpr const char* UNFORCED_DROP = "Unforced drop";
197  static constexpr const char* FORCED_DROP = "Forced drop";
198  // Reasons for marking packets
199  static constexpr const char* UNFORCED_MARK = "Unforced mark";
200  static constexpr const char* FORCED_MARK = "Forced mark";
201 
202 protected:
206  virtual void DoDispose (void);
207 
208 private:
209  virtual bool DoEnqueue (Ptr<QueueDiscItem> item);
210  virtual Ptr<QueueDiscItem> DoDequeue (void);
211  virtual Ptr<const QueueDiscItem> DoPeek (void);
212  virtual bool CheckConfig (void);
213 
222  virtual void InitializeParams (void);
231  double Estimator (uint32_t nQueued, uint32_t m, double qAvg, double qW);
236  void UpdateMaxP (double newAve);
241  void UpdateMaxPFeng (double newAve);
248  uint32_t DropEarly (Ptr<QueueDiscItem> item, uint32_t qSize);
253  double CalculatePNew (void);
260  double ModifyP (double p, uint32_t size);
261 
262  // ** Variables supplied by user
263  uint32_t m_meanPktSize;
264  uint32_t m_idlePktSize;
265  bool m_isWait;
266  bool m_isGentle;
267  bool m_isARED;
269  double m_minTh;
270  double m_maxTh;
271  double m_qW;
272  double m_lInterm;
275  double m_top;
276  double m_bottom;
277  double m_alpha;
278  double m_beta;
282  double m_b;
283  double m_a;
287  bool m_useEcn;
289 
290  // ** Variables maintained by RED
291  double m_vA;
292  double m_vB;
293  double m_vC;
294  double m_vD;
295  double m_curMaxP;
297  double m_vProb;
298  uint32_t m_countBytes;
299  uint32_t m_old;
300  uint32_t m_idle;
301  double m_ptc;
302  double m_qAvg;
303  uint32_t m_count;
305 
311  uint32_t m_cautious;
313 
315 };
316 
317 }; // namespace ns3
318 
319 #endif // RED_QUEUE_DISC_H
FengStatus
Used in Feng&#39;s Adaptive RED.
bool m_isGentle
True to increase dropping prob.
Simulation virtual time values and global simulation resolution.
Definition: nstime.h:103
Smart pointer class similar to boost::intrusive_ptr.
Definition: ptr.h:73
double m_beta
Decrement parameter for m_curMaxP in ARED.
uint32_t m_count
Number of packets since last random number generation.
bool m_isARED
True to enable Adaptive RED.
void SetTh(double minTh, double maxTh)
Set the thresh limits of RED.
virtual bool DoEnqueue(Ptr< QueueDiscItem > item)
This function actually enqueues a packet into the queue disc.
double GetFengAdaptiveA(void)
Get the alpha value to adapt m_curMaxP in Feng&#39;s Adaptive RED.
double m_qAvg
Average queue length.
Time m_linkDelay
Link delay.
void SetAredBeta(double beta)
Set the beta value to adapt m_curMaxP.
uint32_t m_idle
0/1 idle status
FengStatus m_fengStatus
For use in Feng&#39;s Adaptive RED.
double m_vD
2.0 * m_curMaxP - 1.0 - used in "gentle" mode
void SetFengAdaptiveB(double b)
Set the beta value to adapt m_curMaxP in Feng&#39;s Adaptive RED.
double m_vC
(1.0 - m_curMaxP) / m_maxTh - used in "gentle" mode
bool m_useHardDrop
True if packets are always dropped above max threshold.
double m_qW
Queue weight given to cur queue size sample.
static constexpr const char * FORCED_MARK
Forced marks, m_qAvg > m_maxTh.
QueueDisc is an abstract base class providing the interface and implementing the operations common to...
Definition: queue-disc.h:181
A RED packet queue disc.
double m_b
Increment parameter for m_curMaxP in Feng&#39;s Adaptive RED.
static constexpr const char * FORCED_DROP
Forced drops, m_qAvg > m_maxTh.
int64_t AssignStreams(int64_t stream)
Assign a fixed random variable stream number to the random variables used by this model...
double GetAredAlpha(void)
Get the alpha value to adapt m_curMaxP.
Time m_rtt
Rtt to be considered while automatically setting m_bottom in ARED.
static constexpr const char * UNFORCED_DROP
Early probability drops.
double m_alpha
Increment parameter for m_curMaxP in ARED.
Time m_lastSet
Last time m_curMaxP was updated.
bool m_isAdaptMaxP
True to adapt m_curMaxP.
static TypeId GetTypeId(void)
Get the type ID.
Class for representing data rates.
Definition: data-rate.h:88
double m_curMaxP
Current max_p.
Time m_idleTime
Start of current idle period.
double GetFengAdaptiveB(void)
Get the beta value to adapt m_curMaxP in Feng&#39;s Adaptive RED.
virtual bool CheckConfig(void)
Check whether the current configuration is correct.
virtual void InitializeParams(void)
Initialize the queue parameters.
uint32_t m_cautious
0 for default RED 1 experimental (see red-queue-disc.cc) 2 experimental (see red-queue-disc.cc) 3 use Idle packet size in the ptc
Ptr< UniformRandomVariable > m_uv
rng stream
double m_vB
-m_minTh / (m_maxTh - m_minTh)
bool m_isNonlinear
True to enable Nonlinear RED.
bool m_useEcn
True if ECN is used (packets are marked instead of being dropped)
double m_minTh
Minimum threshold for m_qAvg (bytes or packets)
virtual Ptr< const QueueDiscItem > DoPeek(void)
Return a copy of the next packet the queue disc will extract.
uint32_t m_idlePktSize
Avg pkt size used during idle times.
An "unforced" (random) drop.
Every class exported by the ns3 library is enclosed in the ns3 namespace.
double m_vA
1.0 / (m_maxTh - m_minTh)
uint32_t m_countBytes
Number of bytes since last drop.
double m_lInterm
The max probability of dropping a packet.
static constexpr const char * UNFORCED_MARK
Early probability marks.
uint32_t DropEarly(Ptr< QueueDiscItem > item, uint32_t qSize)
Check if a packet needs to be dropped due to probability mark.
RedQueueDisc()
RedQueueDisc Constructor.
double m_bottom
Lower bound for m_curMaxP in ARED.
virtual Ptr< QueueDiscItem > DoDequeue(void)
This function actually extracts a packet from the queue disc.
void UpdateMaxP(double newAve)
Update m_curMaxP.
uint32_t m_old
0 when average queue first exceeds threshold
When m_maxTh < m_qAvg < m_minTh.
void SetFengAdaptiveA(double a)
Set the alpha value to adapt m_curMaxP in Feng&#39;s Adaptive RED.
DataRate m_linkBandwidth
Link bandwidth.
Time m_interval
Time interval to update m_curMaxP.
bool m_isWait
True for waiting between dropped packets.
Time m_targetDelay
Target average queuing delay in ARED.
double GetAredBeta(void)
Get the beta value to adapt m_curMaxP.
double m_ptc
packet time constant in packets/second
virtual ~RedQueueDisc()
Destructor.
double m_top
Upper bound for m_curMaxP in ARED.
double Estimator(uint32_t nQueued, uint32_t m, double qAvg, double qW)
Compute the average queue size.
uint32_t m_meanPktSize
Avg pkt size.
void UpdateMaxPFeng(double newAve)
Update m_curMaxP based on Feng&#39;s Adaptive RED.
bool m_isFengAdaptive
True to enable Feng&#39;s Adaptive RED.
double CalculatePNew(void)
Returns a probability using these function parameters for the DropEarly function. ...
void SetAredAlpha(double alpha)
Set the alpha value to adapt m_curMaxP.
When m_qAvg > m_maxTh.
virtual void DoDispose(void)
Dispose of the object.
double ModifyP(double p, uint32_t size)
Returns a probability using these function parameters for the DropEarly function. ...
a unique identifier for an interface.
Definition: type-id.h:58
double m_vProb
Prob.
double m_maxTh
Maximum threshold for m_qAvg (bytes or packets), should be >= 2 * m_minTh.
double m_a
Decrement parameter for m_curMaxP in Feng&#39;s Adaptive RED.
When m_qAvg < m_minTh.
bool m_isNs1Compat
Ns-1 compatibility.