A Discrete-Event Network Simulator
API
tcp-tahoe.cc
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2010 Adrian Sai-wah Tam
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: Adrian Sai-wah Tam <adrian.sw.tam@gmail.com>
19  */
20 
21 #define NS_LOG_APPEND_CONTEXT \
22  if (m_node) { std::clog << Simulator::Now ().GetSeconds () << " [node " << m_node->GetId () << "] "; }
23 
24 #include "tcp-tahoe.h"
25 #include "ns3/log.h"
26 #include "ns3/trace-source-accessor.h"
27 #include "ns3/simulator.h"
28 #include "ns3/abort.h"
29 #include "ns3/node.h"
30 
31 namespace ns3 {
32 
33 NS_LOG_COMPONENT_DEFINE ("TcpTahoe");
34 
36 
37 TypeId
39 {
40  static TypeId tid = TypeId ("ns3::TcpTahoe")
42  .SetGroupName ("Internet")
43  .AddConstructor<TcpTahoe> ()
44  .AddAttribute ("ReTxThreshold", "Threshold for fast retransmit",
45  UintegerValue (3),
47  MakeUintegerChecker<uint32_t> ())
48  ;
49  return tid;
50 }
51 
52 TcpTahoe::TcpTahoe (void) : m_retxThresh (3)
53 {
54  NS_LOG_FUNCTION (this);
55 }
56 
58  : TcpSocketBase (sock),
59  m_retxThresh (sock.m_retxThresh)
60 {
61  NS_LOG_FUNCTION (this);
62  NS_LOG_LOGIC ("Invoked the copy constructor");
63 }
64 
66 {
67 }
68 
71 {
72  return CopyObject<TcpTahoe> (this);
73 }
74 
75 /* New ACK (up to seqnum seq) received. Increase cwnd and call TcpSocketBase::NewAck() */
76 void
78 {
79  NS_LOG_FUNCTION (this << seq);
80  NS_LOG_LOGIC ("TcpTahoe received ACK for seq " << seq <<
81  " cwnd " << m_cWnd <<
82  " ssthresh " << m_ssThresh);
83  if (m_cWnd < m_ssThresh)
84  { // Slow start mode, add one segSize to cWnd. Default m_ssThresh is 65535. (RFC2001, sec.1)
86  NS_LOG_INFO ("In SlowStart, updated to cwnd " << m_cWnd << " ssthresh " << m_ssThresh);
87  }
88  else
89  { // Congestion avoidance mode, increase by (segSize*segSize)/cwnd. (RFC2581, sec.3.1)
90  // To increase cwnd for one segSize per RTT, it should be (ackBytes*segSize)/cwnd
91  double adder = static_cast<double> (m_segmentSize * m_segmentSize) / m_cWnd.Get ();
92  adder = std::max (1.0, adder);
93  m_cWnd += static_cast<uint32_t> (adder);
94  NS_LOG_INFO ("In CongAvoid, updated to cwnd " << m_cWnd << " ssthresh " << m_ssThresh);
95  }
96  TcpSocketBase::NewAck (seq); // Complete newAck processing
97 }
98 
99 /* Cut down ssthresh upon triple dupack */
100 void
101 TcpTahoe::DupAck (const TcpHeader& t, uint32_t count)
102 {
103  NS_LOG_FUNCTION (this << "t " << count);
104  if (count == m_retxThresh)
105  { // triple duplicate ack triggers fast retransmit (RFC2001, sec.3)
106  NS_LOG_INFO ("Triple Dup Ack: old ssthresh " << m_ssThresh << " cwnd " << m_cWnd);
107  // fast retransmit in Tahoe means triggering RTO earlier. Tx is restarted
108  // from the highest ack and run slow start again.
109  // (Fall & Floyd 1996, sec.1)
110  m_ssThresh = std::max (static_cast<unsigned> (m_cWnd / 2), m_segmentSize * 2); // Half ssthresh
111  m_cWnd = m_segmentSize; // Run slow start again
112  m_nextTxSequence = m_txBuffer->HeadSequence (); // Restart from highest Ack
113  NS_LOG_INFO ("Triple Dup Ack: new ssthresh " << m_ssThresh << " cwnd " << m_cWnd);
114  NS_LOG_LOGIC ("Triple Dup Ack: retransmit missing segment at " << Simulator::Now ().GetSeconds ());
115  DoRetransmit ();
116  }
117 }
118 
119 /* Retransmit timeout */
121 {
122  NS_LOG_FUNCTION (this);
123  NS_LOG_LOGIC (this << " ReTxTimeout Expired at time " << Simulator::Now ().GetSeconds ());
124  // If erroneous timeout in closed/timed-wait state, just return
125  if (m_state == CLOSED || m_state == TIME_WAIT) return;
126  // If all data are received (non-closing socket and nothing to send), just return
127  if (m_state <= ESTABLISHED && m_txBuffer->HeadSequence () >= m_highTxMark) return;
128 
129  m_ssThresh = std::max (static_cast<unsigned> (m_cWnd / 2), m_segmentSize * 2); // Half ssthresh
130  m_cWnd = m_segmentSize; // Set cwnd to 1 segSize (RFC2001, sec.2)
131  m_nextTxSequence = m_txBuffer->HeadSequence (); // Restart from highest Ack
132  DoRetransmit (); // Retransmit the packet
133 }
134 
135 } // namespace ns3
virtual Ptr< TcpSocketBase > Fork(void)
Call CopyObject<> to clone me.
Definition: tcp-tahoe.cc:70
Smart pointer class similar to boost::intrusive_ptr.
Definition: ptr.h:73
#define NS_LOG_FUNCTION(parameters)
If log level LOG_FUNCTION is enabled, this macro will output all input parameters separated by "...
uint32_t m_retxThresh
Fast Retransmit threshold.
Definition: tcp-tahoe.h:68
#define NS_OBJECT_ENSURE_REGISTERED(type)
Register an Object subclass with the TypeId system.
Definition: object-base.h:44
Socket is finished.
Definition: tcp-socket.h:65
TracedValue< uint32_t > m_cWnd
Congestion window.
#define NS_LOG_COMPONENT_DEFINE(name)
Define a Log component with a specific name.
Definition: log.h:201
#define NS_LOG_INFO(msg)
Use NS_LOG to output a message of level LOG_INFO.
Definition: log.h:244
uint32_t m_segmentSize
Segment size.
TracedValue< SequenceNumber32 > m_nextTxSequence
Next seqnum to be sent (SND.NXT), ReTx pushes it back.
T Get(void) const
Get the underlying value.
Definition: traced-value.h:217
TracedValue< TcpStates_t > m_state
TCP state.
An implementation of a stream socket using TCP.
Definition: tcp-tahoe.h:42
Ptr< TcpTxBuffer > m_txBuffer
Tx buffer.
Hold an unsigned integer type.
Definition: uinteger.h:44
static TypeId GetTypeId(void)
Get the type ID.
Definition: tcp-tahoe.cc:38
A base class for implementation of a stream socket using TCP.
virtual ~TcpTahoe(void)
Definition: tcp-tahoe.cc:65
#define NS_LOG_LOGIC(msg)
Use NS_LOG to output a message of level LOG_LOGIC.
Definition: log.h:252
virtual void Retransmit(void)
Halving cwnd and call DoRetransmit()
Definition: tcp-tahoe.cc:120
Every class exported by the ns3 library is enclosed in the ns3 namespace.
Header for the Transmission Control Protocol.
Definition: tcp-header.h:44
virtual void DupAck(const TcpHeader &t, uint32_t count)
Received dupack (duplicate ACK)
Definition: tcp-tahoe.cc:101
static Time Now(void)
Return the current simulation virtual time.
Definition: simulator.cc:223
TracedValue< SequenceNumber32 > m_highTxMark
Highest seqno ever sent, regardless of ReTx.
virtual void NewAck(SequenceNumber32 const &seq)
Update buffers w.r.t.
virtual void NewAck(SequenceNumber32 const &seq)
Update buffers w.r.t.
Definition: tcp-tahoe.cc:77
TcpTahoe(void)
Create an unbound tcp socket.
Definition: tcp-tahoe.cc:52
Timeout to catch resent junk before entering closed, can only be entered from FIN_WAIT2 or CLOSING...
Definition: tcp-socket.h:82
TracedValue< uint32_t > m_ssThresh
Slow start threshold.
Ptr< const AttributeAccessor > MakeUintegerAccessor(T1 a1)
Create an AttributeAccessor for a class data member, or a lone class get functor or set method...
Definition: uinteger.h:45
a unique identifier for an interface.
Definition: type-id.h:58
TypeId SetParent(TypeId tid)
Set the parent TypeId.
Definition: type-id.cc:826
virtual void DoRetransmit(void)
Retransmit the oldest packet.