A Discrete-Event Network Simulator
API
tcp-dctcp.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2017 NITK Surathkal
3  *
4  * This program is free software; you can redistribute it and/or modify
5  * it under the terms of the GNU General Public License version 2 as
6  * published by the Free Software Foundation;
7  *
8  * This program is distributed in the hope that it will be useful,
9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11  * GNU General Public License for more details.
12  *
13  * You should have received a copy of the GNU General Public License
14  * along with this program; if not, write to the Free Software
15  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
16  *
17  * Author: Shravya K.S. <shravya.ks0@gmail.com>
18  *
19  */
20 
21 #ifndef TCP_DCTCP_H
22 #define TCP_DCTCP_H
23 
24 #include "ns3/tcp-congestion-ops.h"
25 #include "ns3/tcp-linux-reno.h"
26 #include "ns3/traced-callback.h"
27 
28 namespace ns3
29 {
30 
38 class TcpDctcp : public TcpLinuxReno
39 {
40  public:
45  static TypeId GetTypeId();
46 
50  TcpDctcp();
51 
56  TcpDctcp(const TcpDctcp& sock);
57 
61  ~TcpDctcp() override;
62 
63  // Documented in base class
64  std::string GetName() const override;
65 
74  void Init(Ptr<TcpSocketState> tcb) override;
75 
83  typedef void (*CongestionEstimateTracedCallback)(uint32_t bytesAcked,
84  uint32_t bytesMarked,
85  double alpha);
86 
87  // Documented in base class
88  uint32_t GetSsThresh(Ptr<const TcpSocketState> tcb, uint32_t bytesInFlight) override;
89  Ptr<TcpCongestionOps> Fork() override;
90  void PktsAcked(Ptr<TcpSocketState> tcb, uint32_t segmentsAcked, const Time& rtt) override;
91  void CwndEvent(Ptr<TcpSocketState> tcb, const TcpSocketState::TcpCAEvent_t event) override;
92 
93  private:
100 
107 
115 
121  void Reset(Ptr<TcpSocketState> tcb);
122 
128  void InitializeDctcpAlpha(double alpha);
129 
130  uint32_t m_ackedBytesEcn;
131  uint32_t m_ackedBytesTotal;
134  double m_alpha;
138  bool m_ceState;
140  double m_g;
141  bool m_useEct0;
147 };
148 
149 } // namespace ns3
150 
151 #endif /* TCP_DCTCP_H */
An implementation of DCTCP.
Definition: tcp-dctcp.h:39
void(* CongestionEstimateTracedCallback)(uint32_t bytesAcked, uint32_t bytesMarked, double alpha)
TracedCallback signature for DCTCP update of congestion state.
Definition: tcp-dctcp.h:83
Ptr< TcpCongestionOps > Fork() override
Copy the congestion control algorithm across sockets.
Definition: tcp-dctcp.cc:109
static TypeId GetTypeId()
Get the type ID.
Definition: tcp-dctcp.cc:35
SequenceNumber32 m_priorRcvNxt
Sequence number of the first missing byte in data.
Definition: tcp-dctcp.h:132
double m_alpha
Parameter used to estimate the amount of network congestion.
Definition: tcp-dctcp.h:134
double m_g
Estimation gain.
Definition: tcp-dctcp.h:140
bool m_initialized
Whether DCTCP has been initialized.
Definition: tcp-dctcp.h:142
bool m_ceState
DCTCP Congestion Experienced state.
Definition: tcp-dctcp.h:138
bool m_priorRcvNxtFlag
Variable used in setting the value of m_priorRcvNxt for first time.
Definition: tcp-dctcp.h:133
void InitializeDctcpAlpha(double alpha)
Initialize the value of m_alpha.
Definition: tcp-dctcp.cc:165
SequenceNumber32 m_nextSeq
TCP sequence number threshold for beginning a new observation window.
Definition: tcp-dctcp.h:136
uint32_t m_ackedBytesEcn
Number of acked bytes which are marked.
Definition: tcp-dctcp.h:130
void Init(Ptr< TcpSocketState > tcb) override
Set configuration required by congestion control algorithm, This method will force DctcpEcn mode and ...
Definition: tcp-dctcp.cc:116
TcpDctcp()
Create an unbound tcp socket.
Definition: tcp-dctcp.cc:70
void Reset(Ptr< TcpSocketState > tcb)
Resets the value of m_ackedBytesEcn, m_ackedBytesTotal and m_nextSeq.
Definition: tcp-dctcp.cc:173
uint32_t m_ackedBytesTotal
Total number of acked bytes.
Definition: tcp-dctcp.h:131
bool m_nextSeqFlag
Variable used in setting the value of m_nextSeq for first time.
Definition: tcp-dctcp.h:137
std::string GetName() const override
Get the name of the congestion control algorithm.
Definition: tcp-dctcp.cc:65
uint32_t GetSsThresh(Ptr< const TcpSocketState > tcb, uint32_t bytesInFlight) override
Get the slow start threshold after a loss event.
Definition: tcp-dctcp.cc:130
void PktsAcked(Ptr< TcpSocketState > tcb, uint32_t segmentsAcked, const Time &rtt) override
Timing information on received ACK.
Definition: tcp-dctcp.cc:137
void CwndEvent(Ptr< TcpSocketState > tcb, const TcpSocketState::TcpCAEvent_t event) override
Trigger events/calculations on occurrence of congestion window event.
Definition: tcp-dctcp.cc:265
void CeState1to0(Ptr< TcpSocketState > tcb)
Changes state of m_ceState to false.
Definition: tcp-dctcp.cc:209
void UpdateAckReserved(Ptr< TcpSocketState > tcb, const TcpSocketState::TcpCAEvent_t event)
Updates the value of m_delayedAckReserved.
Definition: tcp-dctcp.cc:241
bool m_delayedAckReserved
Delayed Ack state.
Definition: tcp-dctcp.h:139
TracedCallback< uint32_t, uint32_t, double > m_traceCongestionEstimate
Callback pointer for congestion state update.
Definition: tcp-dctcp.h:146
bool m_useEct0
Use ECT(0) for ECN codepoint.
Definition: tcp-dctcp.h:141
void CeState0to1(Ptr< TcpSocketState > tcb)
Changes state of m_ceState to true.
Definition: tcp-dctcp.cc:182
~TcpDctcp() override
Destructor.
Definition: tcp-dctcp.cc:103
Reno congestion control algorithm.
TcpCAEvent_t
Congestion avoidance events.
Simulation virtual time values and global simulation resolution.
Definition: nstime.h:105
a unique identifier for an interface.
Definition: type-id.h:60
Every class exported by the ns3 library is enclosed in the ns3 namespace.