A Discrete-Event Network Simulator
API
tcp-dctcp.h
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2017 NITK Surathkal
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
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
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  * Author: Shravya K.S. <shravya.ks0@gmail.com>
19  *
20  */
21 
22 #ifndef TCP_DCTCP_H
23 #define TCP_DCTCP_H
24 
25 #include "ns3/tcp-congestion-ops.h"
26 #include "ns3/tcp-linux-reno.h"
27 #include "ns3/traced-callback.h"
28 
29 namespace ns3 {
30 
38 class TcpDctcp : public TcpLinuxReno
39 {
40 public:
45  static TypeId GetTypeId (void);
46 
50  TcpDctcp ();
51 
56  TcpDctcp (const TcpDctcp& sock);
57 
61  virtual ~TcpDctcp (void);
62 
63  // Documented in base class
64  virtual std::string GetName () const;
65 
74  virtual void Init (Ptr<TcpSocketState> tcb);
75 
83  typedef void (* CongestionEstimateTracedCallback)(uint32_t bytesAcked, uint32_t bytesMarked, double alpha);
84 
85  // Documented in base class
86  virtual uint32_t GetSsThresh (Ptr<const TcpSocketState> tcb,
87  uint32_t bytesInFlight);
88  virtual Ptr<TcpCongestionOps> Fork ();
89  virtual void PktsAcked (Ptr<TcpSocketState> tcb, uint32_t segmentsAcked,
90  const Time &rtt);
91  virtual void CwndEvent (Ptr<TcpSocketState> tcb,
92  const TcpSocketState::TcpCAEvent_t event);
93 private:
100 
106  void CeState1to0 (Ptr<TcpSocketState> tcb);
107 
115  const TcpSocketState::TcpCAEvent_t event);
116 
122  void Reset (Ptr<TcpSocketState> tcb);
123 
129  void InitializeDctcpAlpha (double alpha);
130 
131  uint32_t m_ackedBytesEcn;
132  uint32_t m_ackedBytesTotal;
135  double m_alpha;
138  bool m_ceState;
140  double m_g;
141  bool m_useEct0;
143 
147 };
148 
149 } // namespace ns3
150 
151 #endif /* TCP_DCTCP_H */
152 
Simulation virtual time values and global simulation resolution.
Definition: nstime.h:103
virtual Ptr< TcpCongestionOps > Fork()
Copy the congestion control algorithm across sockets.
Definition: tcp-dctcp.cc:105
TcpCAEvent_t
Congestion avoidance events.
virtual void CwndEvent(Ptr< TcpSocketState > tcb, const TcpSocketState::TcpCAEvent_t event)
Trigger events/calculations on occurrence of congestion window event.
Definition: tcp-dctcp.cc:261
virtual void Init(Ptr< TcpSocketState > tcb)
Set configuration required by congestion control algorithm, This method will force DctcpEcn mode and ...
Definition: tcp-dctcp.cc:112
void CeState1to0(Ptr< TcpSocketState > tcb)
Changes state of m_ceState to false.
Definition: tcp-dctcp.cc:205
bool m_useEct0
Use ECT(0) for ECN codepoint.
Definition: tcp-dctcp.h:141
virtual std::string GetName() const
Get the name of the congestion control algorithm.
Definition: tcp-dctcp.cc:62
static TypeId GetTypeId(void)
Get the type ID.
Definition: tcp-dctcp.cc:33
void UpdateAckReserved(Ptr< TcpSocketState > tcb, const TcpSocketState::TcpCAEvent_t event)
Updates the value of m_delayedAckReserved.
Definition: tcp-dctcp.cc:236
void Reset(Ptr< TcpSocketState > tcb)
Resets the value of m_ackedBytesEcn, m_ackedBytesTotal and m_nextSeq.
Definition: tcp-dctcp.cc:169
virtual void PktsAcked(Ptr< TcpSocketState > tcb, uint32_t segmentsAcked, const Time &rtt)
Timing information on received ACK.
Definition: tcp-dctcp.cc:133
TracedCallback< uint32_t, uint32_t, double > m_traceCongestionEstimate
Callback pointer for congestion state update.
Definition: tcp-dctcp.h:146
bool m_ceState
DCTCP Congestion Experienced state.
Definition: tcp-dctcp.h:138
double m_alpha
Parameter used to estimate the amount of network congestion.
Definition: tcp-dctcp.h:135
SequenceNumber32 m_nextSeq
TCP sequence number threshold for beginning a new observation window.
Definition: tcp-dctcp.h:136
Every class exported by the ns3 library is enclosed in the ns3 namespace.
An implementation of DCTCP.
Definition: tcp-dctcp.h:38
virtual ~TcpDctcp(void)
Destructor.
Definition: tcp-dctcp.cc:100
double m_g
Estimation gain.
Definition: tcp-dctcp.h:140
void InitializeDctcpAlpha(double alpha)
Initialize the value of m_alpha.
Definition: tcp-dctcp.cc:161
void CeState0to1(Ptr< TcpSocketState > tcb)
Changes state of m_ceState to true.
Definition: tcp-dctcp.cc:178
uint32_t m_ackedBytesEcn
Number of acked bytes which are marked.
Definition: tcp-dctcp.h:131
uint32_t m_ackedBytesTotal
Total number of acked bytes.
Definition: tcp-dctcp.h:132
TcpDctcp()
Create an unbound tcp socket.
Definition: tcp-dctcp.cc:67
bool m_priorRcvNxtFlag
Variable used in setting the value of m_priorRcvNxt for first time.
Definition: tcp-dctcp.h:134
SequenceNumber32 m_priorRcvNxt
Sequence number of the first missing byte in data.
Definition: tcp-dctcp.h:133
bool m_delayedAckReserved
Delayed Ack state.
Definition: tcp-dctcp.h:139
virtual uint32_t GetSsThresh(Ptr< const TcpSocketState > tcb, uint32_t bytesInFlight)
Get the slow start threshold after a loss event.
Definition: tcp-dctcp.cc:126
bool m_nextSeqFlag
Variable used in setting the value of m_nextSeq for first time.
Definition: tcp-dctcp.h:137
bool m_initialized
Whether DCTCP has been initialized.
Definition: tcp-dctcp.h:142
a unique identifier for an interface.
Definition: type-id.h:58
void(* CongestionEstimateTracedCallback)(uint32_t bytesAcked, uint32_t bytesMarked, double alpha)
TracedCallback signature for DCTCP update of congestion state.
Definition: tcp-dctcp.h:83