tcp-ledbat.h

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2016 NITK Surathkal
 *
 * 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: Ankit Deepak <adadeepak8@gmail.com>
 *
 */

#ifndef TCP_LEDBAT_H
#define TCP_LEDBAT_H

#include <vector>
#include "ns3/tcp-congestion-ops.h"
#include "ns3/event-id.h"

namespace ns3 {

class TcpLedbat : public TcpNewReno
{
private:
  enum SlowStartType
  {
    DO_NOT_SLOWSTART,           
    DO_SLOWSTART,               
  };

  enum State
  {
    LEDBAT_VALID_OWD  = (1 << 1),  
    LEDBAT_CAN_SS     = (1 << 3)   
  };

public:
  static TypeId GetTypeId (void);

  TcpLedbat (void);

  TcpLedbat (const TcpLedbat& sock);

  virtual ~TcpLedbat (void);

  virtual std::string GetName () const;

  virtual void PktsAcked (Ptr<TcpSocketState> tcb, uint32_t segmentsAcked,
                          const Time& rtt);

  virtual uint32_t GetSsThresh (Ptr<const TcpSocketState> tcb,
                                uint32_t bytesInFlight);
  virtual Ptr<TcpCongestionOps> Fork ();

  virtual void IncreaseWindow (Ptr<TcpSocketState> tcb, uint32_t segmentsAcked);

  void SetDoSs (SlowStartType doSS);

protected:
  virtual void CongestionAvoidance (Ptr<TcpSocketState> tcb, uint32_t segmentsAcked);

private:
  struct OwdCircBuf
  {
    std::vector<uint32_t> buffer; 
    uint32_t min;  
  };

  void InitCircBuf (struct OwdCircBuf &buffer);

  typedef uint32_t (*FilterFunction)(struct OwdCircBuf &);

  static uint32_t MinCircBuf (struct OwdCircBuf &b);

  uint32_t CurrentDelay (FilterFunction filter);

  uint32_t BaseDelay ();

  void AddDelay (struct OwdCircBuf &cb, uint32_t owd, uint32_t maxlen);

  void UpdateBaseDelay (uint32_t owd);

  Time m_target;                     
  double m_gain;                     
  SlowStartType m_doSs;              
  uint32_t m_baseHistoLen;           
  uint32_t m_noiseFilterLen;         
  uint64_t m_lastRollover;           
  int32_t m_sndCwndCnt;              
  struct OwdCircBuf m_baseHistory;   
  struct OwdCircBuf m_noiseFilter;   
  uint32_t m_flag;                   
};

} // namespace ns3

#endif /* TCP_LEDBAT_H */