red-queue.h

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright © 2011 Marcos Talau
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation;
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 * Author: Marcos Talau (talau@users.sourceforge.net)
 *
 * Thanks to: Duy Nguyen<duy@soe.ucsc.edu> by RED efforts in NS3
 *
 *
 * This file incorporates work covered by the following copyright and
 * permission notice:
 *
 * Copyright (c) 1990-1997 Regents of the University of California.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. Neither the name of the University nor of the Laboratory may be used
 *    to endorse or promote products derived from this software without
 *    specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 */

/*
 * PORT NOTE: This code was ported from ns-2 (queue/red.h).  Almost all
 * comments also been ported from NS-2.
 * This implementation aims to be close to the results cited in [0]
 * [0] S.Floyd, K.Fall http://icir.org/floyd/papers/redsims.ps
 */

#ifndef RED_QUEUE_H
#define RED_QUEUE_H

#include <queue>
#include "ns3/packet.h"
#include "ns3/queue.h"
#include "ns3/nstime.h"
#include "ns3/boolean.h"
#include "ns3/data-rate.h"
#include "ns3/nstime.h"

namespace ns3 {

class TraceContainer;
class UniformRandomVariable;

class RedQueue : public Queue
{
public:
  static TypeId GetTypeId (void);
  RedQueue ();

  virtual ~RedQueue ();

  typedef struct
  {   
    uint32_t unforcedDrop;  
    uint32_t forcedDrop;    
    uint32_t qLimDrop;      
  } Stats;

  enum
  {
    DTYPE_NONE,        
    DTYPE_FORCED,      
    DTYPE_UNFORCED,    
  };

  void SetMode (RedQueue::QueueMode mode);

  RedQueue::QueueMode GetMode (void);

  uint32_t GetQueueSize (void);

  void SetQueueLimit (uint32_t lim);

  void SetTh (double minTh, double maxTh);

  Stats GetStats ();

  int64_t AssignStreams (int64_t stream);

private:
  virtual bool DoEnqueue (Ptr<Packet> p);
  virtual Ptr<Packet> DoDequeue (void);
  virtual Ptr<const Packet> DoPeek (void) const;

  void InitializeParams (void);
  double Estimator (uint32_t nQueued, uint32_t m, double qAvg, double qW);
  uint32_t DropEarly (Ptr<Packet> p, uint32_t qSize);
  double CalculatePNew (double qAvg, double , bool gentle, double vA,
                        double vB, double vC, double vD, double maxP);
  double ModifyP (double p, uint32_t count, uint32_t countBytes,
                  uint32_t meanPktSize, bool wait, uint32_t size);

  std::list<Ptr<Packet> > m_packets; 

  uint32_t m_bytesInQueue; 
  bool m_hasRedStarted; 
  Stats m_stats; 

  // ** Variables supplied by user
  QueueMode m_mode;         
  uint32_t m_meanPktSize;   
  uint32_t m_idlePktSize;   
  bool m_isWait;            
  bool m_isGentle;          
  double m_minTh;           
  double m_maxTh;           
  uint32_t m_queueLimit;    
  double m_qW;              
  double m_lInterm;         
  bool m_isNs1Compat;       
  DataRate m_linkBandwidth; 
  Time m_linkDelay;         

  // ** Variables maintained by RED
  double m_vProb1;          
  double m_vA;              
  double m_vB;              
  double m_vC;              
  double m_vD;              
  double m_curMaxP;         
  double m_vProb;           
  uint32_t m_countBytes;    
  uint32_t m_old;           
  uint32_t m_idle;          
  double m_ptc;             
  double m_qAvg;            
  uint32_t m_count;         

  uint32_t m_cautious;
  Time m_idleTime;          

  Ptr<UniformRandomVariable> m_uv;  
};

}; // namespace ns3

#endif // RED_QUEUE_H