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

/*

 * Copyright (c) 2007 INRIA

 * All rights reserved.

 *

 * 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: Mathieu Lacage <mathieu.lacage@sophia.inria.fr>

 */

#include "ns3/log.h"

#include "ns3/node.h"

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

#include "ns3/ipv4-route.h"

#include "ns3/ipv4.h"

#include "udp-socket.h"

#include "udp-l4-protocol.h"

#include "ipv4-end-point.h"

#include "ipv4-l4-demux.h"

#include "ns3/ipv4.h"

NS_LOG_COMPONENT_DEFINE ("UdpSocket");

namespace ns3 {

UdpSocket::UdpSocket (Ptr<Node> node, Ptr<UdpL4Protocol> udp)

  : m_endPoint (0),

    m_node (node),

    m_udp (udp),

    m_errno (ERROR_NOTERROR),

    m_shutdownSend (false),

    m_shutdownRecv (false),

    m_connected (false)

{

  NS_LOG_FUNCTION;

}

UdpSocket::~UdpSocket ()

{

  NS_LOG_FUNCTION;

  m_node = 0;

  if (m_endPoint != 0)

    {

      NS_ASSERT (m_udp != 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_udp->DeAllocate (m_endPoint);

      NS_ASSERT (m_endPoint == 0);

    }

  m_udp = 0;

}

enum Socket::SocketErrno

UdpSocket::GetErrno (void) const

{

  NS_LOG_FUNCTION;

  return m_errno;

}

Ptr<Node>

UdpSocket::GetNode (void) const

{

  NS_LOG_FUNCTION;

  return m_node;

}

void 

UdpSocket::Destroy (void)

{

  NS_LOG_FUNCTION;

  m_node = 0;

  m_endPoint = 0;

  m_udp = 0;

}

int

UdpSocket::FinishBind (void)

{

  NS_LOG_FUNCTION;

  if (m_endPoint == 0)

    {

      return -1;

    }

  m_endPoint->SetRxCallback (MakeCallback (&UdpSocket::ForwardUp, this));

  m_endPoint->SetDestroyCallback (MakeCallback (&UdpSocket::Destroy, this));

  return 0;

}

int

UdpSocket::Bind (void)

{

  NS_LOG_FUNCTION;

  m_endPoint = m_udp->Allocate ();

  return FinishBind ();

}

int 

UdpSocket::Bind (const Address &address)

{

  NS_LOG_FUNCTION;

  NS_LOG_PARAMS (this << address);

  if (!InetSocketAddress::IsMatchingType (address))

    {

      NS_LOG_ERROR ("Not IsMatchingType");

      return ERROR_INVAL;

    }

  InetSocketAddress transport = InetSocketAddress::ConvertFrom (address);

  Ipv4Address ipv4 = transport.GetIpv4 ();

  uint16_t port = transport.GetPort ();

  Ipv4Address localInterface = Ipv4Address::GetAny ();

  if (ipv4 != Ipv4Address::GetAny ())

    {

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

      // Assert that the given address matches an existing local interface

      NS_ASSERT (ipv4_api->FindInterfaceForAddr (ipv4) != 0);

      localInterface = ipv4;

    }

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

    {

      m_endPoint = m_udp->Allocate ();

    }

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

    {

      m_endPoint = m_udp->Allocate (port);

    }

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

    {

      m_endPoint = m_udp->Allocate (ipv4, localInterface);

    }

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

    {

      m_endPoint = m_udp->Allocate (ipv4, port, localInterface);

    }

  return FinishBind ();

}

int 

UdpSocket::ShutdownSend (void)

{

  NS_LOG_FUNCTION;

  m_shutdownSend = true;

  return 0;

}

int 

UdpSocket::ShutdownRecv (void)

{

  NS_LOG_FUNCTION;

  m_shutdownRecv = false;

  return 0;

}

int

UdpSocket::Close(void)

{

  NS_LOG_FUNCTION;

  NotifyCloseCompleted ();

  return 0;

}

int

UdpSocket::Connect(const Address & address)

{

  NS_LOG_FUNCTION;

  NS_LOG_PARAMS (this << address);

  Ipv4Route routeToDest;

  InetSocketAddress transport = InetSocketAddress::ConvertFrom (address);

  m_defaultAddress = transport.GetIpv4 ();

  m_defaultPort = transport.GetPort ();

  NotifyConnectionSucceeded ();

  m_connected = true;

  return 0;

}

int 

UdpSocket::Send (Ptr<Packet> p)

{

  NS_LOG_FUNCTION;

  NS_LOG_PARAMS (this << p);

  if (!m_connected)

    {

      m_errno = ERROR_NOTCONN;

      return -1;

    }

  return DoSend (p);

}

int 

UdpSocket::DoSend (Ptr<Packet> p)

{

  NS_LOG_FUNCTION;

  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;

    } 

  return DoSendTo (p, m_defaultAddress, m_defaultPort);

}

int

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

{

  NS_LOG_FUNCTION;

  NS_LOG_PARAMS (this << p << address);

  if (!m_connected)

    {

      NS_LOG_LOGIC ("Not connected");

      InetSocketAddress transport = InetSocketAddress::ConvertFrom (address);

      Ipv4Address ipv4 = transport.GetIpv4 ();

      uint16_t port = transport.GetPort ();

      return DoSendTo (p, ipv4, port);

    }

  else

    {

      // connected UDP socket must use default addresses

      NS_LOG_LOGIC ("Connected");

      return DoSendTo (p, m_defaultAddress, m_defaultPort);

    }

}

int

UdpSocket::DoSendTo (Ptr<Packet> p, Ipv4Address dest, uint16_t port)

{

  NS_LOG_FUNCTION;

  NS_LOG_PARAMS (this << p << dest << port);

  Ipv4Route routeToDest;

  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;

    }

  uint32_t localIfIndex;

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

  //

  // If dest is sent to the limited broadcast address (all ones),

  // convert it to send a copy of the packet out of every interface

  //

  if (dest.IsBroadcast ())

    {

      NS_LOG_LOGIC ("Limited broadcast start.");

      for (uint32_t i = 0; i < ipv4->GetNInterfaces (); i++ )

        {

          Ipv4Address addri = ipv4->GetAddress (i);

          Ipv4Mask maski = ipv4->GetNetworkMask (i);

          Ipv4Address bcast = addri.GetSubnetDirectedBroadcast (maski);

          NS_LOG_LOGIC ("Sending one copy from " << addri << " to " << bcast

                        << " (mask is " << maski << ")");

          m_udp->Send (p->Copy (), addri, bcast,

                       m_endPoint->GetLocalPort (), port);

          NotifyDataSent (p->GetSize ());

        }

      NS_LOG_LOGIC ("Limited broadcast end.");

    }

  else if (ipv4->GetIfIndexForDestination(dest, localIfIndex))

    {

      NS_LOG_LOGIC ("Route exists");

      m_udp->Send (p, ipv4->GetAddress (localIfIndex), dest,

		   m_endPoint->GetLocalPort (), port);

      NotifyDataSent (p->GetSize ());

      return 0;

    }

  else

   {

      NS_LOG_ERROR ("ERROR_NOROUTETOHOST");

      m_errno = ERROR_NOROUTETOHOST;

      return -1;

   }

  return 0;

}

int 

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

{

  NS_LOG_FUNCTION;

  NS_LOG_PARAMS (this << address << p);

  InetSocketAddress transport = InetSocketAddress::ConvertFrom (address);

  Ipv4Address ipv4 = transport.GetIpv4 ();

  uint16_t port = transport.GetPort ();

  return DoSendTo (p, ipv4, port);

}

void 

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

{

  NS_LOG_FUNCTION;

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

  if (m_shutdownRecv)

    {

      return;

    }

  Address address = InetSocketAddress (ipv4, port);

  NotifyDataReceived (packet, address);

}

} //namespace ns3

#ifdef RUN_SELF_TESTS

#include "ns3/test.h"

#include "ns3/internet-node.h"

#include "ns3/socket-factory.h"

#include "ns3/udp.h"

#include "ns3/simulator.h"

#include "ns3/point-to-point-channel.h"

#include "ns3/point-to-point-net-device.h"

#include "ns3/drop-tail-queue.h"

#include <string>

namespace ns3 {

class UdpSocketTest: public Test

{

  Ptr<Packet> m_receivedPacket;

  Ptr<Packet> m_receivedPacket2;

public:

  virtual bool RunTests (void);

  UdpSocketTest ();

  void ReceivePacket (Ptr<Socket> socket, Ptr<Packet> packet, const Address &from);

  void ReceivePacket2 (Ptr<Socket> socket, Ptr<Packet> packet, const Address &from);

};

UdpSocketTest::UdpSocketTest ()

  : Test ("UdpSocket") {}

void UdpSocketTest::ReceivePacket (Ptr<Socket> socket, Ptr<Packet> packet, const Address &from)

{

  m_receivedPacket = packet;

}

void UdpSocketTest::ReceivePacket2 (Ptr<Socket> socket, Ptr<Packet> packet, const Address &from)

{

  m_receivedPacket2 = packet;

}

bool

UdpSocketTest::RunTests (void)

{

  bool result = true;

  // Create topology

  // Receiver Node

  Ptr<Node> rxNode = CreateObject<InternetNode> ();

  Ptr<PointToPointNetDevice> rxDev1, rxDev2;

  { // first interface

    rxDev1->AddQueue(CreateObject<DropTailQueue> ());

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

    uint32_t netdev_idx = ipv4->AddInterface (rxDev1);

    ipv4->SetAddress (netdev_idx, Ipv4Address ("10.0.0.1"));

    ipv4->SetNetworkMask (netdev_idx, Ipv4Mask (0xffff0000U));

    ipv4->SetUp (netdev_idx);

  }

  { // second interface

    rxDev2->AddQueue(CreateObject<DropTailQueue> ());

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

    uint32_t netdev_idx = ipv4->AddInterface (rxDev2);

    ipv4->SetAddress (netdev_idx, Ipv4Address ("10.0.1.1"));

    ipv4->SetNetworkMask (netdev_idx, Ipv4Mask (0xffff0000U));

    ipv4->SetUp (netdev_idx);

  }

  // Sender Node

  Ptr<Node> txNode = CreateObject<InternetNode> ();

  Ptr<PointToPointNetDevice> txDev;

  {

    txDev->AddQueue(CreateObject<DropTailQueue> ());

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

    uint32_t netdev_idx = ipv4->AddInterface (txDev);

    ipv4->SetAddress (netdev_idx, Ipv4Address ("10.0.0.2"));

    ipv4->SetNetworkMask (netdev_idx, Ipv4Mask (0xffff0000U));

    ipv4->SetUp (netdev_idx);

  }

  // link the two nodes

  Ptr<PointToPointChannel> channel = CreateObject<PointToPointChannel> ();

  rxDev1->Attach (channel);

  txDev->Attach (channel);

  // Create the UDP sockets

  Ptr<SocketFactory> rxSocketFactory = rxNode->GetObject<Udp> ();

  Ptr<Socket> rxSocket = rxSocketFactory->CreateSocket ();

  NS_TEST_ASSERT_EQUAL (rxSocket->Bind (InetSocketAddress (Ipv4Address ("10.0.0.1"), 1234)), 0);

  rxSocket->SetRecvCallback (MakeCallback (&UdpSocketTest::ReceivePacket, this));

  Ptr<Socket> rxSocket2 = rxSocketFactory->CreateSocket ();

  rxSocket2->SetRecvCallback (MakeCallback (&UdpSocketTest::ReceivePacket2, this));

  NS_TEST_ASSERT_EQUAL (rxSocket2->Bind (InetSocketAddress (Ipv4Address ("10.0.1.1"), 1234)), 0);

  Ptr<SocketFactory> txSocketFactory = txNode->GetObject<Udp> ();

  Ptr<Socket> txSocket = txSocketFactory->CreateSocket ();

  // ------ Now the tests ------------

  // Unicast test

  m_receivedPacket = Create<Packet> ();

  m_receivedPacket2 = Create<Packet> ();

  NS_TEST_ASSERT_EQUAL (txSocket->SendTo (InetSocketAddress (Ipv4Address("10.0.0.1"), 1234),

                                          Create<Packet> (123)), 0);

  Simulator::Run ();

  NS_TEST_ASSERT_EQUAL (m_receivedPacket->GetSize (), 123);

  NS_TEST_ASSERT_EQUAL (m_receivedPacket2->GetSize (), 0); // second interface should receive it

  // Simple broadcast test

  m_receivedPacket = Create<Packet> ();

  m_receivedPacket2 = Create<Packet> ();

  NS_TEST_ASSERT_EQUAL (txSocket->SendTo (InetSocketAddress (Ipv4Address("255.255.255.255"), 1234),

                                          Create<Packet> (123)), 0);

  Simulator::Run ();

  NS_TEST_ASSERT_EQUAL (m_receivedPacket->GetSize (), 123);

  // second socket should not receive it (it is bound specifically to the second interface's address

  NS_TEST_ASSERT_EQUAL (m_receivedPacket2->GetSize (), 0);

  // Broadcast test with multiple receiving sockets

  // When receiving broadcast packets, all sockets sockets bound to

  // the address/port should receive a copy of the same packet -- if

  // the socket address matches.

  rxSocket2->Dispose ();