/* -*-  Mode: C++; c-file-style: "gnu"; indent-tabs-mode:nil; -*- */

/*

 * Copyright (c) 2007 Georgia Tech Research Corporation

 *

 * 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

 *

 * Author: Raj Bhattacharjea <raj.b@gatech.edu>

 */

#define NS_LOG_APPEND_CONTEXT                                   \

  if (m_node) { std::clog << Simulator::Now ().GetSeconds () << " [node " << m_node->GetId () << "] "; } 

#include "ns3/abort.h"

#include "ns3/node.h"

#include "ns3/inet-socket-address.h"

#include "ns3/log.h"

#include "ns3/ipv4.h"

#include "ns3/ipv4-interface-address.h"

#include "ns3/ipv4-route.h"

#include "ns3/ipv4-routing-protocol.h"

#include "ns3/simulation-singleton.h"

#include "ns3/simulator.h"

#include "ns3/packet.h"

#include "ns3/uinteger.h"

#include "ns3/trace-source-accessor.h"

#include "tcp-typedefs.h"

#include "tcp-socket-impl.h"

#include "tcp-l4-protocol.h"

#include "ipv4-end-point.h"

#include "tcp-header.h"

#include "rtt-estimator.h"

#include <algorithm>

NS_LOG_COMPONENT_DEFINE ("TcpSocketImpl");

namespace ns3 {

NS_OBJECT_ENSURE_REGISTERED (TcpSocketImpl);

TypeId

TcpSocketImpl::GetTypeId ()

{

  static TypeId tid = TypeId("ns3::TcpSocketImpl")

    .SetParent<TcpSocket> ()

    .AddTraceSource ("CongestionWindow",

                     "The TCP connection's congestion window",

                     MakeTraceSourceAccessor (&TcpSocketImpl::m_cWnd))

    ;

  return tid;

}

  TcpSocketImpl::TcpSocketImpl ()

  : m_skipRetxResched (false),

    m_dupAckCount (0),

    m_delAckCount (0),

    m_endPoint (0),

    m_node (0),

    m_tcp (0),

    m_errno (ERROR_NOTERROR),

    m_shutdownSend (false),

    m_shutdownRecv (false),

    m_connected (false),

    m_state (CLOSED),

    m_closeNotified (false),

    m_closeRequestNotified (false),

    m_closeOnEmpty (false),

    m_pendingClose (false),

    m_nextTxSequence (0),

    m_highTxMark (0),

    m_highestRxAck (0),

    m_lastRxAck (0),

    m_nextRxSequence (0),

    m_finSequence (0),

    m_rxAvailable (0),

    m_rxBufSize (0),

    m_pendingData (0),

    m_segmentSize (0),          // For attribute initialization consistency (quiet valgrind)

    m_rxWindowSize (0),

    m_initialCWnd (0),          // For attribute initialization consistency (quiet valgrind)

    m_persistTime (Seconds(6)), //XXX hook this into attributes?

    m_rtt (0),

    m_lastMeasuredRtt (Seconds(0.0))

{

  NS_LOG_FUNCTION (this);

}

TcpSocketImpl::TcpSocketImpl(const TcpSocketImpl& sock)

  : TcpSocket(sock), //copy object::m_tid, copy socket::callbacks

    m_skipRetxResched (sock.m_skipRetxResched),

    m_dupAckCount (sock.m_dupAckCount),

    m_delAckCount (0),

    m_delAckMaxCount (sock.m_delAckMaxCount),

    m_delAckTimeout (sock.m_delAckTimeout),

    m_endPoint (0),

    m_node (sock.m_node),

    m_tcp (sock.m_tcp),

    m_errno (sock.m_errno),

    m_shutdownSend (sock.m_shutdownSend),

    m_shutdownRecv (sock.m_shutdownRecv),

    m_connected (sock.m_connected),

    m_state (sock.m_state),

    m_closeNotified (sock.m_closeNotified),

    m_closeRequestNotified (sock.m_closeRequestNotified),

    m_closeOnEmpty (sock.m_closeOnEmpty),

    m_pendingClose (sock.m_pendingClose),

    m_nextTxSequence (sock.m_nextTxSequence),

    m_highTxMark (sock.m_highTxMark),

    m_highestRxAck (sock.m_highestRxAck),

    m_lastRxAck (sock.m_lastRxAck),

    m_nextRxSequence (sock.m_nextRxSequence),

    m_finSequence (sock.m_finSequence),

    m_rxAvailable (0),

    m_rxBufSize (0),

    m_pendingData (0),

    m_segmentSize (sock.m_segmentSize),

    m_rxWindowSize (sock.m_rxWindowSize),

    m_cWnd (sock.m_cWnd),

    m_ssThresh (sock.m_ssThresh),

    m_initialCWnd (sock.m_initialCWnd),

    m_persistTime (sock.m_persistTime),

    m_rtt (0),

    m_lastMeasuredRtt (Seconds(0.0)),

    m_cnTimeout (sock.m_cnTimeout),

    m_cnCount (sock.m_cnCount),

    m_sndBufSize (sock.m_sndBufSize),

    m_rxBufMaxSize(sock.m_rxBufMaxSize)

{

  NS_LOG_FUNCTION_NOARGS ();

  NS_LOG_LOGIC("Invoked the copy constructor");

  //copy the pending data if necessary

  if(sock.m_pendingData)

    {

      m_pendingData = sock.m_pendingData->Copy();

    }

  //copy the rtt if necessary

  if (sock.m_rtt)

    {

      m_rtt = sock.m_rtt->Copy();

    }

  //null out the socket base class callbacks,

  //make user of the socket register this explicitly

  Callback<void, Ptr< Socket > > vPS =

      MakeNullCallback<void, Ptr<Socket> > ();

  Callback<void, Ptr<Socket>, const Address &> vPSA =

      MakeNullCallback<void, Ptr<Socket>, const Address &> ();

  Callback<void, Ptr<Socket>, uint32_t> vPSUI =

      MakeNullCallback<void, Ptr<Socket>, uint32_t> ();

  SetConnectCallback (vPS, vPS);

  SetDataSentCallback (vPSUI);

  SetSendCallback (vPSUI);

  SetRecvCallback (vPS);

  //can't "copy" the endpoint just yes, must do this when we know the peer info

  //too; this is in SYN_ACK_TX

}

TcpSocketImpl::~TcpSocketImpl ()

{

  NS_LOG_FUNCTION(this);

  m_node = 0;

  if (m_endPoint != 0)

    {

      NS_ASSERT (m_tcp != 0);

      /*

       * Note that this piece of code is seriously convoluted: When we do a 

       * Bind we allocate an Ipv4Endpoint.  Immediately thereafter we always do

       * a FinishBind which sets the DestroyCallback of that endpoint to be

       * TcpSocketImpl::Destroy, below.  When m_tcp->DeAllocate is called, it 

       * will in turn call into Ipv4EndpointDemux::DeAllocate with the endpoint

       * (m_endPoint).  The demux will look up the endpoint and destroy it (the

       * corollary is that we don't own the object pointed to by m_endpoint, we

       * just borrowed it).  The destructor for the endpoint will call the 

       * DestroyCallback which will then invoke TcpSocketImpl::Destroy below. 

       * Destroy will zero m_node, m_tcp and m_endpoint.  The zero of m_node and

       * m_tcp need to be here also in case the endpoint is deallocated before 

       * shutdown.

       */

      NS_ASSERT (m_endPoint != 0);

      m_tcp->DeAllocate (m_endPoint);

      NS_ASSERT (m_endPoint == 0);

    }

  m_tcp = 0;

  delete m_pendingData; //prevents leak

  m_pendingData = 0;

  CancelAllTimers();

}

void

TcpSocketImpl::SetNode (Ptr<Node> node)

{

  m_node = node;

  /*

   * Set the congestion window to IW.  This method is called from the L4 

   * Protocol after it creates the socket.  The Attribute system takes

   * care of setting m_initialCWnd and m_segmentSize to their default

   * values.  m_cWnd depends on m_initialCwnd and m_segmentSize so it

   * also needs to be updated in SetInitialCwnd and SetSegSize.

   */

  m_cWnd = m_initialCWnd * m_segmentSize;

}

void 

TcpSocketImpl::SetTcp (Ptr<TcpL4Protocol> tcp)

{

  m_tcp = tcp;

}

void 

TcpSocketImpl::SetRtt (Ptr<RttEstimator> rtt)

{

  m_rtt = rtt;

}

enum Socket::SocketErrno

TcpSocketImpl::GetErrno (void) const

{

  NS_LOG_FUNCTION_NOARGS ();

  return m_errno;

}

Ptr<Node>

TcpSocketImpl::GetNode (void) const

{

  NS_LOG_FUNCTION_NOARGS ();

  return m_node;

}

void 

TcpSocketImpl::Destroy (void)

{

  NS_LOG_FUNCTION_NOARGS ();

  m_node = 0;

  m_endPoint = 0;

  m_tcp = 0;

  NS_LOG_LOGIC (this<<" Cancelled ReTxTimeout event which was set to expire at "

                << (Simulator::Now () + 

                Simulator::GetDelayLeft (m_retxEvent)).GetSeconds());

  CancelAllTimers();

}

int

TcpSocketImpl::FinishBind (void)

{

  NS_LOG_FUNCTION_NOARGS ();

  if (m_endPoint == 0)

    {

      return -1;

    }

  m_endPoint->SetRxCallback (MakeCallback (&TcpSocketImpl::ForwardUp, Ptr<TcpSocketImpl>(this)));

  m_endPoint->SetDestroyCallback (MakeCallback (&TcpSocketImpl::Destroy, Ptr<TcpSocketImpl>(this)));

  return 0;

}

int

TcpSocketImpl::Bind (void)

{

  NS_LOG_FUNCTION_NOARGS ();

  m_endPoint = m_tcp->Allocate ();

  return FinishBind ();

}

int 

TcpSocketImpl::Bind (const Address &address)

{

  NS_LOG_FUNCTION (this<<address);

  if (!InetSocketAddress::IsMatchingType (address))

    {

      m_errno = ERROR_INVAL;

      return -1;

    }

  InetSocketAddress transport = InetSocketAddress::ConvertFrom (address);

  Ipv4Address ipv4 = transport.GetIpv4 ();

  uint16_t port = transport.GetPort ();

  if (ipv4 == Ipv4Address::GetAny () && port == 0)

    {

      m_endPoint = m_tcp->Allocate ();

      NS_LOG_LOGIC ("TcpSocketImpl "<<this<<" got an endpoint: "<<m_endPoint);

    }

  else if (ipv4 == Ipv4Address::GetAny () && port != 0)

    {

      m_endPoint = m_tcp->Allocate (port);

      NS_LOG_LOGIC ("TcpSocketImpl "<<this<<" got an endpoint: "<<m_endPoint);

    }

  else if (ipv4 != Ipv4Address::GetAny () && port == 0)

    {

      m_endPoint = m_tcp->Allocate (ipv4);

      NS_LOG_LOGIC ("TcpSocketImpl "<<this<<" got an endpoint: "<<m_endPoint);

    }

  else if (ipv4 != Ipv4Address::GetAny () && port != 0)

    {

      m_endPoint = m_tcp->Allocate (ipv4, port);

      NS_LOG_LOGIC ("TcpSocketImpl "<<this<<" got an endpoint: "<<m_endPoint);

    }

  return FinishBind ();

}

int 

TcpSocketImpl::ShutdownSend (void)

{

  NS_LOG_FUNCTION_NOARGS ();

  m_shutdownSend = true;

  return 0;

}

int 

TcpSocketImpl::ShutdownRecv (void)

{

  NS_LOG_FUNCTION_NOARGS ();

  m_shutdownRecv = true;

  return 0;

}

int

TcpSocketImpl::Close (void)

{

  NS_LOG_FUNCTION_NOARGS ();

  // First we check to see if there is any unread rx data

  // Bug number 426 claims we should send reset in this case.

  if (!m_bufferedData.empty())

    {

      SendRST();

      return 0;

    }

  uint32_t remainingData = 0;

  if (m_pendingData)

    {

      remainingData = m_pendingData->SizeFromSeq (m_firstPendingSequence,

                                                  m_nextTxSequence);

    }

  if (remainingData != 0)

    { // App close with pending data must wait until all data transmitted

      m_closeOnEmpty = true;

      NS_LOG_LOGIC("Socket " << this << 

                   " deferring close, state " << m_state);

      return 0;

    }

  m_finSequence = m_nextTxSequence + SequenceNumber32 (1);

  Actions_t action  = ProcessEvent (APP_CLOSE);

  ProcessAction (action);

  return 0;

}

int

TcpSocketImpl::Connect (const Address & address)

{

  NS_LOG_FUNCTION (this << address);

  Ptr<Ipv4> ipv4 = m_node->GetObject<Ipv4> ();

  NS_ASSERT (ipv4 != 0);

  if (m_endPoint == 0)

    {

      if (Bind () == -1)

        {

          NS_ASSERT (m_endPoint == 0);

          return -1;

        }

      NS_ASSERT (m_endPoint != 0);

    }

  InetSocketAddress transport = InetSocketAddress::ConvertFrom (address);

  m_endPoint->SetPeer(transport.GetIpv4 (), transport.GetPort ());

  if (ipv4->GetRoutingProtocol () != 0)

    {

      Ipv4Header header;

      header.SetDestination (m_endPoint->GetPeerAddress());

      Socket::SocketErrno errno_;

      Ptr<Ipv4Route> route;

      Ptr<NetDevice> oif = m_boundnetdevice; //specify non-zero if bound to a source address

      // XXX here, cache the route in the endpoint?

      route = ipv4->GetRoutingProtocol ()->RouteOutput (Ptr<Packet> (), header, oif, errno_);

      if (route != 0)

        {

          NS_LOG_LOGIC ("Route exists");

          m_endPoint->SetLocalAddress (route->GetSource ());

        }

      else

        {

          NS_LOG_LOGIC ("TcpSocketImpl::Connect():  Route to " << m_endPoint->GetPeerAddress() << " does not exist");

          NS_LOG_ERROR (errno_);

          m_errno = errno_;

          return -1;

        }

    }

  else

    {

      NS_FATAL_ERROR ("No Ipv4RoutingProtocol in the node");

    }

  Actions_t action = ProcessEvent (APP_CONNECT);

  bool success = ProcessAction (action);

  if (success) 

    {

      return 0;

    }

  return -1;

}

//p here is just data, no headers

int 

TcpSocketImpl::Send (Ptr<Packet> p, uint32_t flags) 

{

  NS_LOG_FUNCTION (this << p);

  if (m_state == ESTABLISHED || m_state == SYN_SENT || m_state == CLOSE_WAIT)

  {

    if (p->GetSize() > GetTxAvailable ())

    {

      m_errno = ERROR_MSGSIZE;

      return -1;

    }

    if (!m_pendingData)

    {

      m_pendingData = new PendingData ();   // Create if non-existent

      m_firstPendingSequence = m_nextTxSequence; // Note seq of first

    }

    //PendingData::Add stores a copy of the Ptr p

    m_pendingData->Add (p);

    NS_LOG_DEBUG("TcpSock::Send, pdsize " << m_pendingData->Size() << 

        " state " << m_state);

    Actions_t action = ProcessEvent (APP_SEND);

    NS_LOG_DEBUG(" action " << action);

    if (!ProcessAction (action)) 

    {

      return -1; // Failed, return zero

    }

    return p->GetSize();

  }

  else

  {

    m_errno = ERROR_NOTCONN;

    return -1;

  }

}

int TcpSocketImpl::DoSendTo (Ptr<Packet> p, const Address &address)

{

  NS_LOG_FUNCTION (this << p << address);

  InetSocketAddress transport = InetSocketAddress::ConvertFrom (address);

  Ipv4Address ipv4 = transport.GetIpv4 ();

  uint16_t port = transport.GetPort ();

  return DoSendTo (p, ipv4, port);

}

int TcpSocketImpl::DoSendTo (Ptr<Packet> p, Ipv4Address ipv4, uint16_t port)

{

  NS_LOG_FUNCTION (this << p << ipv4 << port);

  if (m_endPoint == 0)

    {

      if (Bind () == -1)

	{

          NS_ASSERT (m_endPoint == 0);

	  return -1;

	}

      NS_ASSERT (m_endPoint != 0);

    }

  if (m_shutdownSend)

    {

      m_errno = ERROR_SHUTDOWN;

      return -1;

    }

  // Get the size before sending to tcp, as the sent callback cares

  // about payload sent, not with headers

  uint32_t sentSize = p->GetSize();

  m_tcp->Send (p, m_endPoint->GetLocalAddress (), ipv4,

                  m_endPoint->GetLocalPort (), port, m_boundnetdevice);

  NotifyDataSent (sentSize);

  return 0;

}

int 

TcpSocketImpl::SendTo (Ptr<Packet> p, uint32_t flags, const Address &address)

{

  NS_LOG_FUNCTION (this << address << p);

  if (!m_connected)

    {

      m_errno = ERROR_NOTCONN;

      return -1;

    }

  else

    {

      return Send (p, flags); //drop the address according to BSD manpages

    }

}

uint32_t

TcpSocketImpl::GetTxAvailable (void) const

{

  NS_LOG_FUNCTION_NOARGS ();

  if (m_pendingData != 0)

    {

      uint32_t unAckedDataSize = 

        m_pendingData->SizeFromSeq (m_firstPendingSequence, m_highestRxAck);

      NS_ASSERT (m_sndBufSize >= unAckedDataSize); //else a logical error

      return m_sndBufSize-unAckedDataSize;

    }

  else

    {

      return m_sndBufSize;