tcp-cubic.h

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2014 Natale Patriciello <natale.patriciello@gmail.com>
 *
 * 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 TCPCUBIC_H
#define TCPCUBIC_H

#include "ns3/tcp-congestion-ops.h"
#include "ns3/tcp-socket-base.h"


namespace ns3 {

class TcpCubic : public TcpCongestionOps
{
public:
  static TypeId GetTypeId (void);

  TcpCubic ();
  TcpCubic (const TcpCubic& sock);

  virtual std::string GetName () const;
  virtual void PktsAcked (Ptr<TcpSocketState> tcb, uint32_t segmentsAcked, const Time& rtt);
  virtual void IncreaseWindow (Ptr<TcpSocketState> tcb, uint32_t segmentsAcked);
  virtual uint32_t GetSsThresh (Ptr<const TcpSocketState> tcb, uint32_t bytesInFlight);
  virtual void CongestionStateSet (Ptr<TcpSocketState> tcb,
                                   const TcpSocketState::TcpCongState_t newState);

  virtual Ptr<TcpCongestionOps> Fork ();

private:
  enum HybridSSDetectionMode
  {
    PACKET_TRAIN = 0x1, 
    DELAY        = 0x2  
  };

  bool     m_fastConvergence;  
  double   m_beta;             

  bool     m_hystart;          
  int      m_hystartDetect;    
  uint32_t m_hystartLowWindow; 
  Time     m_hystartAckDelta;  
  Time     m_hystartDelayMin;  
  Time     m_hystartDelayMax;  
  uint8_t  m_hystartMinSamples; 

  uint32_t m_initialCwnd;      
  uint8_t  m_cntClamp;         

  double   m_c;                

  // Cubic parameters
  uint32_t     m_cWndCnt;         
  uint32_t     m_lastMaxCwnd;     
  uint32_t     m_bicOriginPoint;  
  double       m_bicK;            
                                  //    of the current epoch (in s)
  Time         m_delayMin;        
  Time         m_epochStart;      
  bool         m_found;           
  Time         m_roundStart;      
  SequenceNumber32   m_endSeq;    
  Time         m_lastAck;         
  Time         m_cubicDelta;      
  Time         m_currRtt;         
  uint32_t     m_sampleCnt;       

private:
  void HystartReset (Ptr<const TcpSocketState> tcb);

  void CubicReset (Ptr<const TcpSocketState> tcb);

  uint32_t Update (Ptr<TcpSocketState> tcb);

  void HystartUpdate (Ptr<TcpSocketState> tcb, const Time &delay);

  Time HystartDelayThresh (const Time &t) const;
};

} // namespace ns3

#endif // TCPCUBIC_H