queue-disc.h

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2007, 2014 University of Washington
 *               2015 Universita' degli Studi di Napoli Federico II
 *
 * 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
 */

#ifndef QUEUE_DISC_H
#define QUEUE_DISC_H

#include "ns3/object.h"
#include "ns3/traced-value.h"
#include <ns3/queue.h>
#include "ns3/net-device.h"
#include <vector>
#include "packet-filter.h"

namespace ns3 {

class Packet;
class QueueDisc;

class QueueDiscItem : public QueueItem {
public:
  QueueDiscItem (Ptr<Packet> p, const Address & addr, uint16_t protocol);

  virtual ~QueueDiscItem ();

  Address GetAddress (void) const;

  uint16_t GetProtocol (void) const;

  uint8_t GetTxQueueIndex (void) const;

  void SetTxQueueIndex (uint8_t txq);

  virtual void AddHeader (void) = 0;

  virtual void Print (std::ostream &os) const;

private:
  QueueDiscItem ();
  QueueDiscItem (const QueueDiscItem &);
  QueueDiscItem &operator = (const QueueDiscItem &);

  Address m_address;      
  uint16_t m_protocol;    
  uint8_t m_txq;          
};


class QueueDiscClass : public Object {
public:
  static TypeId GetTypeId (void);

  QueueDiscClass ();
  virtual ~QueueDiscClass () {}

  Ptr<QueueDisc> GetQueueDisc (void) const;

  void SetQueueDisc (Ptr<QueueDisc> qd);

protected:
  virtual void DoDispose (void);

private:
  Ptr<QueueDisc> m_queueDisc;        
};


class QueueDisc : public Object {
public:
  static TypeId GetTypeId (void);

  QueueDisc ();

  uint32_t GetNPackets (void) const;

  uint32_t GetNBytes (void) const;

  uint32_t GetTotalReceivedPackets (void) const;

  uint32_t GetTotalReceivedBytes (void) const;

  uint32_t GetTotalDroppedPackets (void) const;

  uint32_t GetTotalDroppedBytes (void) const;

  uint32_t GetTotalRequeuedPackets (void) const;

  uint32_t GetTotalRequeuedBytes (void) const;

  void SetNetDevice (Ptr<NetDevice> device);

  Ptr<NetDevice> GetNetDevice (void) const;

  virtual void SetQuota (const uint32_t quota);

  virtual uint32_t GetQuota (void) const;

  bool Enqueue (Ptr<QueueDiscItem> item);

  Ptr<QueueDiscItem> Dequeue (void);

  Ptr<const QueueDiscItem> Peek (void) const;

  void Run (void);

  void AddInternalQueue (Ptr<Queue> queue);

  Ptr<Queue> GetInternalQueue (uint32_t i) const;

  uint32_t GetNInternalQueues (void) const;

  void AddPacketFilter (Ptr<PacketFilter> filter);

  Ptr<PacketFilter> GetPacketFilter (uint32_t i) const;

  uint32_t GetNPacketFilters (void) const;

  void AddQueueDiscClass (Ptr<QueueDiscClass> qdClass);

  Ptr<QueueDiscClass> GetQueueDiscClass (uint32_t i) const;

  uint32_t GetNQueueDiscClasses (void) const;

  int32_t Classify (Ptr<QueueDiscItem> item);

  enum WakeMode
    {
      WAKE_ROOT = 0x00,
      WAKE_CHILD = 0x01
    };

  WakeMode GetWakeMode (void);

  typedef Callback<void, Ptr<QueueItem> > ParentDropCallback;

  virtual void SetParentDropCallback (ParentDropCallback cb);

protected:
  virtual void DoDispose (void);

  virtual void DoInitialize (void);

  void Drop (Ptr<QueueItem> item);

private:
  void NotifyParentDrop (Ptr<QueueItem> item);

  virtual bool DoEnqueue (Ptr<QueueDiscItem> item) = 0;

  virtual Ptr<QueueDiscItem> DoDequeue (void) = 0;

  virtual Ptr<const QueueDiscItem> DoPeek (void) const = 0;

  virtual bool CheckConfig (void) = 0;

  virtual void InitializeParams (void) = 0;

  bool RunBegin (void);

  void RunEnd (void);

  bool Restart (void);

  Ptr<QueueDiscItem> DequeuePacket (void);

  void Requeue (Ptr<QueueDiscItem> item);

  bool Transmit (Ptr<QueueDiscItem> item);

  static const uint32_t DEFAULT_QUOTA = 64; 

  std::vector<Ptr<Queue> > m_queues;            
  std::vector<Ptr<PacketFilter> > m_filters;    
  std::vector<Ptr<QueueDiscClass> > m_classes;  

  TracedValue<uint32_t> m_nPackets; 
  TracedValue<uint32_t> m_nBytes;   

  uint32_t m_nTotalReceivedPackets; 
  uint32_t m_nTotalReceivedBytes;   
  uint32_t m_nTotalDroppedPackets;  
  uint32_t m_nTotalDroppedBytes;    
  uint32_t m_nTotalRequeuedPackets; 
  uint32_t m_nTotalRequeuedBytes;   
  uint32_t m_quota;                 
  Ptr<NetDevice> m_device;          
  Ptr<NetDeviceQueueInterface> m_devQueueIface;   
  bool m_running;                   
  Ptr<QueueDiscItem> m_requeued;    
  ParentDropCallback m_parentDropCallback;   

  TracedCallback<Ptr<const QueueItem> > m_traceEnqueue;
  TracedCallback<Ptr<const QueueItem> > m_traceDequeue;
  TracedCallback<Ptr<const QueueItem> > m_traceRequeue;
  TracedCallback<Ptr<const QueueItem> > m_traceDrop;
};

} // namespace ns3

#endif /* QueueDisc */