A Discrete-Event Network Simulator
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2014 Natale Patriciello <natale.patriciello@gmail.com>
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
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  */
20 #ifndef TCPCUBIC_H
21 #define TCPCUBIC_H
23 #include "ns3/tcp-congestion-ops.h"
24 #include "ns3/tcp-socket-base.h"
27 namespace ns3 {
70 class TcpCubic : public TcpCongestionOps
71 {
72 public:
77  static TypeId GetTypeId (void);
79  TcpCubic ();
80  TcpCubic (const TcpCubic& sock);
82  virtual std::string GetName () const;
83  virtual void PktsAcked (Ptr<TcpSocketState> tcb, uint32_t segmentsAcked, const Time& rtt);
84  virtual void IncreaseWindow (Ptr<TcpSocketState> tcb, uint32_t segmentsAcked);
85  virtual uint32_t GetSsThresh (Ptr<const TcpSocketState> tcb, uint32_t bytesInFlight);
86  virtual void CongestionStateSet (Ptr<TcpSocketState> tcb,
87  const TcpSocketState::TcpCongState_t newState);
89  virtual Ptr<TcpCongestionOps> Fork ();
91 private:
96  {
97  PACKET_TRAIN = 0x1,
98  DELAY = 0x2
99  };
102  double m_beta;
104  bool m_hystart;
112  uint32_t m_initialCwnd;
113  uint8_t m_cntClamp;
115  double m_c;
117  // Cubic parameters
118  uint32_t m_cWndCnt;
119  uint32_t m_lastMaxCwnd;
120  uint32_t m_bicOriginPoint;
121  double m_bicK;
122  // of the current epoch (in s)
125  bool m_found;
131  uint32_t m_sampleCnt;
133 private:
144  uint32_t Update (Ptr<TcpSocketState> tcb);
152  void HystartUpdate (Ptr<TcpSocketState> tcb, const Time &delay);
164  Time HystartDelayThresh (const Time &t) const;
165 };
167 } // namespace ns3
169 #endif // TCPCUBIC_H
void CubicReset(Ptr< const TcpSocketState > tcb)
Definition: tcp-cubic.cc:438
Simulation virtual time values and global simulation resolution.
Definition: nstime.h:103
virtual void CongestionStateSet(Ptr< TcpSocketState > tcb, const TcpSocketState::TcpCongState_t newState)
Trigger events/calculations specific to a congestion state.
Definition: tcp-cubic.cc:426
Time m_cubicDelta
Time to wait after recovery before update.
Definition: tcp-cubic.h:129
Time HystartDelayThresh(const Time &t) const
Clamp time value in a range.
Definition: tcp-cubic.cc:378
Time m_epochStart
Beginning of an epoch.
Definition: tcp-cubic.h:124
void HystartReset(Ptr< const TcpSocketState > tcb)
Reset HyStart parameters.
Definition: tcp-cubic.cc:152
int m_hystartDetect
Detect way for HyStart algorithm.
Definition: tcp-cubic.h:105
bool m_fastConvergence
Enable or disable fast convergence algorithm.
Definition: tcp-cubic.h:101
SequenceNumber32 m_endSeq
End sequence of the round.
Definition: tcp-cubic.h:127
Time m_hystartDelayMin
Minimum time for hystart algorithm.
Definition: tcp-cubic.h:108
uint32_t Update(Ptr< TcpSocketState > tcb)
Cubic window update after a new ack received.
Definition: tcp-cubic.cc:215
uint32_t m_initialCwnd
Initial cWnd.
Definition: tcp-cubic.h:112
bool m_hystart
Enable or disable HyStart algorithm.
Definition: tcp-cubic.h:104
Time m_hystartAckDelta
Spacing between ack&#39;s indicating train.
Definition: tcp-cubic.h:107
Time m_currRtt
Current Rtt.
Definition: tcp-cubic.h:130
uint32_t m_hystartLowWindow
Lower bound cWnd for hybrid slow start (segments)
Definition: tcp-cubic.h:106
double m_beta
Beta for cubic multiplicative increase.
Definition: tcp-cubic.h:102
virtual uint32_t GetSsThresh(Ptr< const TcpSocketState > tcb, uint32_t bytesInFlight)
Get the slow start threshold after a loss event.
Definition: tcp-cubic.cc:396
Values to detect the Slow Start mode of HyStart.
Definition: tcp-cubic.h:95
Time m_hystartDelayMax
Maximum time for hystart algorithm.
Definition: tcp-cubic.h:109
virtual void PktsAcked(Ptr< TcpSocketState > tcb, uint32_t segmentsAcked, const Time &rtt)
Timing information on received ACK.
Definition: tcp-cubic.cc:300
virtual std::string GetName() const
Get the name of the congestion control algorithm.
Definition: tcp-cubic.cc:146
Detection by delay value.
Definition: tcp-cubic.h:98
bool m_found
The exit point is found?
Definition: tcp-cubic.h:125
uint8_t m_cntClamp
Modulo of the (avoided) float division for cWnd.
Definition: tcp-cubic.h:113
Definition of the Congestion state machine.
double m_c
Cubic Scaling factor.
Definition: tcp-cubic.h:115
uint32_t m_lastMaxCwnd
Last maximum cWnd.
Definition: tcp-cubic.h:119
Every class exported by the ns3 library is enclosed in the ns3 namespace.
Congestion control abstract class.
double m_bicK
Time to origin point from the beginning.
Definition: tcp-cubic.h:121
static TypeId GetTypeId(void)
Get the type ID.
Definition: tcp-cubic.cc:33
uint32_t m_cWndCnt
cWnd integer-to-float counter
Definition: tcp-cubic.h:118
uint8_t m_hystartMinSamples
Number of delay samples for detecting the increase of delay.
Definition: tcp-cubic.h:110
The Cubic Congestion Control Algorithm.
Definition: tcp-cubic.h:70
Time m_delayMin
Min delay.
Definition: tcp-cubic.h:123
virtual Ptr< TcpCongestionOps > Fork()
Copy the congestion control algorithm across sockets.
Definition: tcp-cubic.cc:450
Time m_lastAck
Last time when the ACK spacing is close.
Definition: tcp-cubic.h:128
uint32_t m_bicOriginPoint
Origin point of bic function.
Definition: tcp-cubic.h:120
Detection by trains of packet.
Definition: tcp-cubic.h:97
void HystartUpdate(Ptr< TcpSocketState > tcb, const Time &delay)
Update HyStart parameters.
Definition: tcp-cubic.cc:328
Time m_roundStart
Beginning of each round.
Definition: tcp-cubic.h:126
virtual void IncreaseWindow(Ptr< TcpSocketState > tcb, uint32_t segmentsAcked)
Congestion avoidance algorithm implementation.
Definition: tcp-cubic.cc:163
a unique identifier for an interface.
Definition: type-id.h:58
uint32_t m_sampleCnt
Count of samples for HyStart.
Definition: tcp-cubic.h:131