/* -*-  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>

 */

#include "ns3/node.h"

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

#include "ns3/log.h"

#include "ns3/ipv4.h"

#include "tcp-socket.h"

#include "tcp-l4-protocol.h"

#include "ipv4-end-point.h"

#include "ipv4-l4-demux.h"

#include "ns3/simulation-singleton.h"

#include "tcp-typedefs.h"

#include "ns3/simulator.h"

#include "ns3/packet.h"

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

#include <algorithm>

NS_LOG_COMPONENT_DEFINE ("TcpSocket");

using namespace std;

namespace ns3 {

NS_OBJECT_ENSURE_REGISTERED (TcpSocket);

TypeId

TcpSocket::GetTypeId ()

{

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

    .SetParent<Socket> ()

    .AddTraceSource ("CongestionWindow",

                     "The TCP connection's congestion window",

                     MakeTraceSourceAccessor (&TcpSocket::m_cWnd))

    ;

  return tid;

}

  TcpSocket::TcpSocket ()

  : 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_pendingData (0),

    m_rtt (0),

    m_lastMeasuredRtt (Seconds(0.0))

{

  NS_LOG_FUNCTION (this);

}

TcpSocket::TcpSocket(const TcpSocket& sock)

  : Socket(sock), //copy the base class callbacks

    m_skipRetxResched (sock.m_skipRetxResched),

    m_dupAckCount (sock.m_dupAckCount),

    m_delAckCount (0),

    m_delAckMaxCount (sock.m_delAckMaxCount),

    m_delAckTimout (sock.m_delAckTimout),

    m_endPoint (0),

    m_node (sock.m_node),

    m_tcp (sock.m_tcp),

    m_remoteAddress (sock.m_remoteAddress),

    m_remotePort (sock.m_remotePort),

    m_localAddress (sock.m_localAddress),

    m_localPort (sock.m_localPort),

    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_pendingData (0),

    m_segmentSize (sock.m_segmentSize),

    m_rxWindowSize (sock.m_rxWindowSize),

    m_advertisedWindowSize (sock.m_advertisedWindowSize),

    m_cWnd (sock.m_cWnd),

    m_ssThresh (sock.m_ssThresh),

    m_initialCWnd (sock.m_initialCWnd),

    m_rtt (0),

    m_lastMeasuredRtt (Seconds(0.0)),

    m_cnTimeout (sock.m_cnTimeout),

    m_cnCount (sock.m_cnCount)

{

  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();

    }

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

  //too; this is in SYN_ACK_TX

}

TcpSocket::~TcpSocket ()

{

  NS_LOG_FUNCTION(this);

  m_node = 0;

  if (m_endPoint != 0)

    {

      NS_ASSERT (m_tcp != 0);

      /**

       * Note that this piece of code is a bit tricky:

       * when DeAllocate is called, it will call into

       * Ipv4EndPointDemux::Deallocate which triggers

       * a delete of the associated endPoint which triggers

       * in turn a call to the method ::Destroy below

       * will will zero the m_endPoint field.

       */

      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;

}

void

TcpSocket::SetNode (Ptr<Node> node)

{

  m_node = node;

  Ptr<Tcp> t = node->GetObject<Tcp> ();

  m_segmentSize = t->GetDefaultSegSize ();

  m_rxWindowSize = t->GetDefaultAdvWin ();

  m_advertisedWindowSize = t->GetDefaultAdvWin ();

  m_cWnd = t->GetDefaultInitialCwnd () * m_segmentSize;

  m_ssThresh = t->GetDefaultSsThresh ();

  m_initialCWnd = t->GetDefaultInitialCwnd ();

  m_cnTimeout = Seconds (t->GetDefaultConnTimeout ());

  m_cnCount = t->GetDefaultConnCount ();

  m_delAckTimout = Seconds(t->GetDefaultDelAckTimeout ());

  m_delAckMaxCount = t->GetDefaultDelAckCount ();

}

void 

TcpSocket::SetTcp (Ptr<TcpL4Protocol> tcp)

{

  m_tcp = tcp;

}

void 

TcpSocket::SetRtt (Ptr<RttEstimator> rtt)

{

  m_rtt = rtt;

}

enum Socket::SocketErrno

TcpSocket::GetErrno (void) const

{

  NS_LOG_FUNCTION_NOARGS ();

  return m_errno;

}

Ptr<Node>

TcpSocket::GetNode (void) const

{

  NS_LOG_FUNCTION_NOARGS ();

  return m_node;

}

void 

TcpSocket::Destroy (void)

{

  NS_LOG_FUNCTION_NOARGS ();

  m_node = 0;

  m_endPoint = 0;

  m_tcp = 0;

  m_retxEvent.Cancel ();

}

int

TcpSocket::FinishBind (void)

{

  NS_LOG_FUNCTION_NOARGS ();

  if (m_endPoint == 0)

    {

      return -1;

    }

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

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

  m_localAddress = m_endPoint->GetLocalAddress ();

  m_localPort = m_endPoint->GetLocalPort ();

  return 0;

}

int

TcpSocket::Bind (void)

{

  NS_LOG_FUNCTION_NOARGS ();

  m_endPoint = m_tcp->Allocate ();

  return FinishBind ();

}

int 

TcpSocket::Bind (const Address &address)

{

  NS_LOG_FUNCTION (this<<address);

  if (!InetSocketAddress::IsMatchingType (address))

    {

      return ERROR_INVAL;

    }

  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 ("TcpSocket "<<this<<" got an endpoint: "<<m_endPoint);

    }

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

    {

      m_endPoint = m_tcp->Allocate (port);

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

    }

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

    {

      m_endPoint = m_tcp->Allocate (ipv4);

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

    }

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

    {

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

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

    }

  return FinishBind ();

}

int 

TcpSocket::ShutdownSend (void)

{

  NS_LOG_FUNCTION_NOARGS ();

  m_shutdownSend = true;

  return 0;

}

int 

TcpSocket::ShutdownRecv (void)

{

  NS_LOG_FUNCTION_NOARGS ();

  m_shutdownRecv = false;

  return 0;

}

int

TcpSocket::Close (void)

{

  NS_LOG_FUNCTION_NOARGS ();

  if (m_state == CLOSED) 

    {

      return -1;

    }

  if (m_pendingData && m_pendingData->Size() != 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;

    }

  Actions_t action  = ProcessEvent (APP_CLOSE);

  ProcessAction (action);

  ShutdownSend ();

  return 0;

}

int

TcpSocket::Connect (const Address & address)

{

  NS_LOG_FUNCTION (this << address);

  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_remoteAddress = transport.GetIpv4 ();

  m_remotePort = transport.GetPort ();

  uint32_t localIfIndex;

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

  if (ipv4->GetIfIndexForDestination (m_remoteAddress, localIfIndex))

    {

      m_endPoint->SetLocalAddress (ipv4->GetAddress (localIfIndex));

    }

  else

    {

      m_errno = ERROR_NOROUTETOHOST;

      return -1;

    }

  Actions_t action = ProcessEvent (APP_CONNECT);

  bool success = ProcessAction (action);

  if (success) 

    {

      return 0;

    }

  return -1;

}

int 

TcpSocket::Send (const Ptr<Packet> p) //p here is just data, no headers

{ // TCP Does not deal with packets from app, just data

  return Send(p->PeekData(), p->GetSize());

}

int TcpSocket::Send (const uint8_t* buf, uint32_t size)

{

  NS_LOG_FUNCTION (this << buf << size);

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

    { // Ok to buffer some data to send

      if (!m_pendingData)

      {

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

        m_firstPendingSequence = m_nextTxSequence; // Note seq of first

      }

      //PendingData::Add always copies the data buffer, never modifies

      m_pendingData->Add (size,buf);

      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 size;

    }

  else

  {

    m_errno = ERROR_NOTCONN;

    return -1;

  }

}

int TcpSocket::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 TcpSocket::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;

    }

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

                  m_endPoint->GetLocalPort (), port);

  NotifyDataSent (p->GetSize ());

  return 0;

}

int 

TcpSocket::SendTo (const Address &address, Ptr<Packet> p)

{

  NS_LOG_FUNCTION (this << address << p);

  if (!m_connected)

    {

      m_errno = ERROR_NOTCONN;

      return -1;

    }

  else

    {

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

    }

}

int

TcpSocket::Listen (uint32_t q)

{

  NS_LOG_FUNCTION (this << q);

  Actions_t action = ProcessEvent (APP_LISTEN);

  ProcessAction (action);

  return 0;

}

void

TcpSocket::ForwardUp (Ptr<Packet> packet, Ipv4Address ipv4, uint16_t port)

{

  NS_LOG_DEBUG("Socket " << this << " got forward up" <<

               " dport " << m_endPoint->GetLocalPort() <<

               " daddr " << m_endPoint->GetLocalAddress() <<

               " sport " << m_endPoint->GetPeerPort() <<

               " saddr " << m_endPoint->GetPeerAddress());

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

  if (m_shutdownRecv)

    {

      return;

    }

  TcpHeader tcpHeader;

  packet->RemoveHeader (tcpHeader);

  if (tcpHeader.GetFlags () & TcpHeader::ACK)

    {

      Time m = m_rtt->AckSeq (tcpHeader.GetAckNumber () );

      if (m != Seconds (0.0))

        {

          m_lastMeasuredRtt = m;

        }

    }

  Events_t event = SimulationSingleton<TcpStateMachine>::Get ()->FlagsEvent (tcpHeader.GetFlags () );

  Actions_t action = ProcessEvent (event); //updates the state

  Address address = InetSocketAddress (ipv4, port);

  NS_LOG_DEBUG("Socket " << this << 

               " processing pkt action, " << action <<

               " current state " << m_state);

  ProcessPacketAction (action, packet, tcpHeader, address);

}

Actions_t TcpSocket::ProcessEvent (Events_t e)

{

  NS_LOG_FUNCTION (this << e);

  States_t saveState = m_state;

  NS_LOG_LOGIC ("TcpSocket " << this << " processing event " << e);

  // simulation singleton is a way to get a single global static instance of a

  // class intended to be a singleton; see simulation-singleton.h

  SA stateAction = SimulationSingleton<TcpStateMachine>::Get ()->Lookup (m_state,e);

  // debug

  if (stateAction.action == RST_TX)

    {

      NS_LOG_LOGIC ("TcpSocket " << this << " sending RST from state "

              << saveState << " event " << e);

    }

  bool needCloseNotify = (stateAction.state == CLOSED && m_state != CLOSED 

    && e != TIMEOUT);

  m_state = stateAction.state;

  NS_LOG_LOGIC ("TcpSocket " << this << " moved from state " << saveState 

    << " to state " <<m_state);

  NS_LOG_LOGIC ("TcpSocket " << this << " pendingData " << m_pendingData);

  //extra event logic is here for RX events

  //e = SYN_ACK_RX

  if (saveState == SYN_SENT && m_state == ESTABLISHED)

    // this means the application side has completed its portion of 

    // the handshaking

    {

      Simulator::ScheduleNow(&TcpSocket::ConnectionSucceeded, this);

      //NotifyConnectionSucceeded ();

      m_connected = true;

      m_endPoint->SetPeer (m_remoteAddress, m_remotePort);

      NS_LOG_LOGIC ("TcpSocket " << this << " Connected!");