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

/*

 * Copyright (c) 2007-2009 Strasbourg University

 *

 * 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: Sebastien Vincent <vincent@clarinet.u-strasbg.fr>

 */

#include "ns3/log.h"

#include "ns3/node.h"

#include "ns3/uinteger.h"

#include "ns3/vector.h"

#include "ns3/boolean.h"

#include "ns3/callback.h"

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

#include "ns3/object-vector.h"

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

#include "ns3/ipv6-route.h"

#include "ns3/mac16-address.h"

#include "ns3/mac64-address.h"

#include "loopback-net-device.h"

#include "ipv6-l3-protocol.h"

#include "ipv6-interface.h"

#include "ipv6-raw-socket-impl.h"

#include "ipv6-autoconfigured-prefix.h"

#include "ipv6-extension-demux.h"

#include "ipv6-extension.h"

#include "ipv6-extension-header.h"

#include "ipv6-option-demux.h"

#include "ipv6-option.h"

#include "icmpv6-l4-protocol.h"

#include "ndisc-cache.h"

/// Minimum IPv6 MTU, as defined by \RFC{2460}

#define IPV6_MIN_MTU 1280

namespace ns3 {

NS_LOG_COMPONENT_DEFINE ("Ipv6L3Protocol");

NS_OBJECT_ENSURE_REGISTERED (Ipv6L3Protocol);

const uint16_t Ipv6L3Protocol::PROT_NUMBER = 0x86DD;

TypeId Ipv6L3Protocol::GetTypeId ()

{

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

    .SetParent<Ipv6> ()

    .SetGroupName ("Internet")

    .AddConstructor<Ipv6L3Protocol> ()

    .AddAttribute ("DefaultTtl",

                   "The TTL value set by default on all "

                   "outgoing packets generated on this node.",

                   UintegerValue (64),

                   MakeUintegerAccessor (&Ipv6L3Protocol::m_defaultTtl),

                   MakeUintegerChecker<uint8_t> ())

    .AddAttribute ("DefaultTclass",

                   "The TCLASS value set by default on all "

                   "outgoing packets generated on this node.",

                   UintegerValue (0),

                   MakeUintegerAccessor (&Ipv6L3Protocol::m_defaultTclass),

                   MakeUintegerChecker<uint8_t> ())

    .AddAttribute ("InterfaceList",

                   "The set of IPv6 interfaces associated to this IPv6 stack.",

                   ObjectVectorValue (),

                   MakeObjectVectorAccessor (&Ipv6L3Protocol::m_interfaces),

                   MakeObjectVectorChecker<Ipv6Interface> ())

    .AddAttribute ("SendIcmpv6Redirect",

                   "Send the ICMPv6 Redirect when appropriate.",

                   BooleanValue (true),

                   MakeBooleanAccessor (&Ipv6L3Protocol::SetSendIcmpv6Redirect,

                                        &Ipv6L3Protocol::GetSendIcmpv6Redirect),

                   MakeBooleanChecker ())

    .AddTraceSource ("Tx",

                     "Send IPv6 packet to outgoing interface.",

                     MakeTraceSourceAccessor (&Ipv6L3Protocol::m_txTrace),

                     "ns3::Ipv6L3Protocol::TxRxTracedCallback")

    .AddTraceSource ("Rx",

                     "Receive IPv6 packet from incoming interface.",

                     MakeTraceSourceAccessor (&Ipv6L3Protocol::m_rxTrace),

                     "ns3::Ipv6L3Protocol::TxRxTracedCallback")

    .AddTraceSource ("Drop",

                     "Drop IPv6 packet",

                     MakeTraceSourceAccessor (&Ipv6L3Protocol::m_dropTrace),

                     "ns3::Ipv6L3Protocol::DropTracedCallback")

    .AddTraceSource ("SendOutgoing",

                     "A newly-generated packet by this node is "

                     "about to be queued for transmission",

                     MakeTraceSourceAccessor (&Ipv6L3Protocol::m_sendOutgoingTrace),

                     "ns3::Ipv6L3Protocol::SentTracedCallback")

    .AddTraceSource ("UnicastForward",

                     "A unicast IPv6 packet was received by this node "

                     "and is being forwarded to another node",

                     MakeTraceSourceAccessor (&Ipv6L3Protocol::m_unicastForwardTrace),

                     "ns3::Ipv6L3Protocol::SentTracedCallback")

    .AddTraceSource ("LocalDeliver",

                     "An IPv6 packet was received by/for this node, "

                     "and it is being forward up the stack",

                     MakeTraceSourceAccessor (&Ipv6L3Protocol::m_localDeliverTrace),

                     "ns3::Ipv6L3Protocol::SentTracedCallback")

  ;

  return tid;

}

Ipv6L3Protocol::Ipv6L3Protocol ()

  : m_nInterfaces (0)

{

  NS_LOG_FUNCTION_NOARGS ();

  m_pmtuCache = CreateObject<Ipv6PmtuCache> ();

}

Ipv6L3Protocol::~Ipv6L3Protocol ()

{

  NS_LOG_FUNCTION_NOARGS ();

}

void Ipv6L3Protocol::DoDispose ()

{

  NS_LOG_FUNCTION_NOARGS ();

  /* clear protocol and interface list */

  for (L4List_t::iterator it = m_protocols.begin (); it != m_protocols.end (); ++it)

    {

      *it = 0;

    }

  m_protocols.clear ();

  /* remove interfaces */

  for (Ipv6InterfaceList::iterator it = m_interfaces.begin (); it != m_interfaces.end (); ++it)

    {

      *it = 0;

    }

  m_interfaces.clear ();

  /* remove raw sockets */

  for (SocketList::iterator it = m_sockets.begin (); it != m_sockets.end (); ++it)

    {

      *it = 0;

    }

  m_sockets.clear ();

  /* remove list of prefix */

  for (Ipv6AutoconfiguredPrefixListI it = m_prefixes.begin (); it != m_prefixes.end (); ++it)

    {

      (*it)->StopValidTimer ();

      (*it)->StopPreferredTimer ();

      (*it) = 0;

    }

  m_prefixes.clear ();

  m_node = 0;

  m_routingProtocol = 0;

  m_pmtuCache = 0;

  Object::DoDispose ();

}

void Ipv6L3Protocol::SetRoutingProtocol (Ptr<Ipv6RoutingProtocol> routingProtocol)

{

  NS_LOG_FUNCTION (this << routingProtocol);

  m_routingProtocol = routingProtocol;

  m_routingProtocol->SetIpv6 (this);

}

Ptr<Ipv6RoutingProtocol> Ipv6L3Protocol::GetRoutingProtocol () const

{

  NS_LOG_FUNCTION_NOARGS ();

  return m_routingProtocol;

}

uint32_t Ipv6L3Protocol::AddInterface (Ptr<NetDevice> device)

{

  NS_LOG_FUNCTION (this << device);

  Ptr<Node> node = GetObject<Node> ();

  Ptr<Ipv6Interface> interface = CreateObject<Ipv6Interface> ();

  node->RegisterProtocolHandler (MakeCallback (&Ipv6L3Protocol::Receive, this), Ipv6L3Protocol::PROT_NUMBER, device);

  interface->SetNode (m_node);

  interface->SetDevice (device);

  interface->SetForwarding (m_ipForward);

  return AddIpv6Interface (interface);

}

uint32_t Ipv6L3Protocol::AddIpv6Interface (Ptr<Ipv6Interface> interface)

{

  NS_LOG_FUNCTION (this << interface);

  uint32_t index = m_nInterfaces;

  m_interfaces.push_back (interface);

  m_nInterfaces++;

  return index;

}

Ptr<Ipv6Interface> Ipv6L3Protocol::GetInterface (uint32_t index) const

{

  NS_LOG_FUNCTION (this << index);

  uint32_t tmp = 0;

  for (Ipv6InterfaceList::const_iterator it = m_interfaces.begin (); it != m_interfaces.end (); it++)

    {

      if (index == tmp)

        {

          return *it;

        }

      tmp++;

    }

  return 0;

}

uint32_t Ipv6L3Protocol::GetNInterfaces () const

{

  NS_LOG_FUNCTION_NOARGS ();

  return m_nInterfaces;

}

int32_t Ipv6L3Protocol::GetInterfaceForAddress (Ipv6Address address) const

{

  NS_LOG_FUNCTION (this << address);

  int32_t index = 0;

  for (Ipv6InterfaceList::const_iterator it = m_interfaces.begin (); it != m_interfaces.end (); it++)

    {

      uint32_t j = 0;

      uint32_t max = (*it)->GetNAddresses ();

      for (j = 0; j < max; j++)

        {

          if ((*it)->GetAddress (j).GetAddress () == address)

            {

              return index;

            }

        }

      index++;

    }

  return -1;

}

int32_t Ipv6L3Protocol::GetInterfaceForPrefix (Ipv6Address address, Ipv6Prefix mask) const

{

  NS_LOG_FUNCTION (this << address << mask);

  int32_t index = 0;

  for (Ipv6InterfaceList::const_iterator it = m_interfaces.begin (); it != m_interfaces.end (); it++)

    {

      uint32_t j = 0;

      for (j = 0; j < (*it)->GetNAddresses (); j++)

        {

          if ((*it)->GetAddress (j).GetAddress ().CombinePrefix (mask) == address.CombinePrefix (mask))

            {

              return index;

            }

        }

      index++;

    }

  return -1;

}

Ptr<NetDevice> Ipv6L3Protocol::GetNetDevice (uint32_t i)

{

  NS_LOG_FUNCTION (this << i);

  return GetInterface (i)->GetDevice ();

}

int32_t Ipv6L3Protocol::GetInterfaceForDevice (Ptr<const NetDevice> device) const

{

  NS_LOG_FUNCTION (this << device);

  int32_t index = 0;

  for (Ipv6InterfaceList::const_iterator it = m_interfaces.begin (); it != m_interfaces.end (); it++)

    {

      if ((*it)->GetDevice () == device)

        {

          return index;

        }

      index++;

    }

  return -1;

}

void Ipv6L3Protocol::AddAutoconfiguredAddress (uint32_t interface, Ipv6Address network, Ipv6Prefix mask, uint8_t flags, uint32_t validTime, uint32_t preferredTime, Ipv6Address defaultRouter)

{

  NS_LOG_FUNCTION (this << interface << network << mask << (uint32_t)flags << validTime << preferredTime);

  Ipv6InterfaceAddress address;

  Address addr = GetInterface (interface)->GetDevice ()->GetAddress ();

  if (flags & (1 << 6)) /* auto flag */

    {

      // In case of new MacAddress types, remember to change Ipv6L3Protocol::RemoveAutoconfiguredAddress as well

      if (Mac64Address::IsMatchingType (addr))

        {

          address = Ipv6InterfaceAddress (Ipv6Address::MakeAutoconfiguredAddress (Mac64Address::ConvertFrom (addr), network));

        }

      else if (Mac48Address::IsMatchingType (addr))

        {

          address = Ipv6InterfaceAddress (Ipv6Address::MakeAutoconfiguredAddress (Mac48Address::ConvertFrom (addr), network));

        }

      else if (Mac16Address::IsMatchingType (addr))

        {

          address = Ipv6InterfaceAddress (Ipv6Address::MakeAutoconfiguredAddress (Mac16Address::ConvertFrom (addr), network));

        }

      else

        {

          NS_FATAL_ERROR ("Unknown method to make autoconfigured address for this kind of device.");

          return;

        }

      /* see if we have already the prefix */

      for (Ipv6AutoconfiguredPrefixListI it = m_prefixes.begin (); it != m_prefixes.end (); ++it)

        {

          if ((*it)->GetInterface () == interface && (*it)->GetPrefix () == network && (*it)->GetMask () == mask)

            {

              (*it)->StopPreferredTimer ();

              (*it)->StopValidTimer ();

              (*it)->StartPreferredTimer ();

              return;

            }

        }

      /* no prefix found, add autoconfigured address and the prefix */

      NS_LOG_INFO ("Autoconfigured address is :" << address.GetAddress ());

      AddAddress (interface, address);

      /* add default router

       * if a previous default route exists, the new ones is simply added

       */

      if (!defaultRouter.IsAny())

        {

          GetRoutingProtocol ()->NotifyAddRoute (Ipv6Address::GetAny (), Ipv6Prefix ((uint8_t)0), defaultRouter, interface, network);

        }

      Ptr<Ipv6AutoconfiguredPrefix> aPrefix = CreateObject<Ipv6AutoconfiguredPrefix> (m_node, interface, network, mask, preferredTime, validTime, defaultRouter);

      aPrefix->StartPreferredTimer ();

      m_prefixes.push_back (aPrefix);

    }

}

void Ipv6L3Protocol::RemoveAutoconfiguredAddress (uint32_t interface, Ipv6Address network, Ipv6Prefix mask, Ipv6Address defaultRouter)

{

  NS_LOG_FUNCTION (this << interface << network << mask);

  Ptr<Ipv6Interface> iface = GetInterface (interface);

  Address addr = iface->GetDevice ()->GetAddress ();

  uint32_t max = iface->GetNAddresses ();

  uint32_t i = 0;

  Ipv6Address toFound;

  if (Mac64Address::IsMatchingType (addr))

    {

      toFound = Ipv6Address::MakeAutoconfiguredAddress (Mac64Address::ConvertFrom (addr), network);

    }

  else if (Mac48Address::IsMatchingType (addr))

    {

      toFound = Ipv6Address::MakeAutoconfiguredAddress (Mac48Address::ConvertFrom (addr), network);

    }

  else if (Mac16Address::IsMatchingType (addr))

    {

      toFound = Ipv6Address::MakeAutoconfiguredAddress (Mac16Address::ConvertFrom (addr), network);

    }

  else

    {

      NS_FATAL_ERROR ("Unknown method to make autoconfigured address for this kind of device.");

      return;

    }

  for (i = 0; i < max; i++)

    {

      if (iface->GetAddress (i).GetAddress () == toFound)

        {

          RemoveAddress (interface, i);

          break;

        }

    }

  /* remove from list of autoconfigured address */

  for (Ipv6AutoconfiguredPrefixListI it = m_prefixes.begin (); it != m_prefixes.end (); ++it)

    {

      if ((*it)->GetInterface () == interface && (*it)->GetPrefix () == network && (*it)->GetMask () == mask)

        {

          *it = 0;

          m_prefixes.erase (it);

          break;

        }

    }

  GetRoutingProtocol ()->NotifyRemoveRoute (Ipv6Address::GetAny (), Ipv6Prefix ((uint8_t)0), defaultRouter, interface, network);

}

bool Ipv6L3Protocol::AddAddress (uint32_t i, Ipv6InterfaceAddress address)

{

  NS_LOG_FUNCTION (this << i << address);

  Ptr<Ipv6Interface> interface = GetInterface (i);

  bool ret = interface->AddAddress (address);

  if (m_routingProtocol != 0)

    {

      m_routingProtocol->NotifyAddAddress (i, address);

    }

  return ret;

}

uint32_t Ipv6L3Protocol::GetNAddresses (uint32_t i) const

{

  NS_LOG_FUNCTION (this << i);

  Ptr<Ipv6Interface> interface = GetInterface (i);

  return interface->GetNAddresses ();

}

Ipv6InterfaceAddress Ipv6L3Protocol::GetAddress (uint32_t i, uint32_t addressIndex) const

{

  NS_LOG_FUNCTION (this << i << addressIndex);

  Ptr<Ipv6Interface> interface = GetInterface (i);

  return interface->GetAddress (addressIndex);

}

bool Ipv6L3Protocol::RemoveAddress (uint32_t i, uint32_t addressIndex)

{

  NS_LOG_FUNCTION (this << i << addressIndex);

  Ptr<Ipv6Interface> interface = GetInterface (i);

  Ipv6InterfaceAddress address = interface->RemoveAddress (addressIndex);

  if (address != Ipv6InterfaceAddress ())

    {

      if (m_routingProtocol != 0)

        {

          m_routingProtocol->NotifyRemoveAddress (i, address);

        }

      return true;

    }

  return false;

}

bool 

Ipv6L3Protocol::RemoveAddress (uint32_t i, Ipv6Address address)

{

  NS_LOG_FUNCTION (this << i << address);

  if (address == Ipv6Address::GetLoopback())

    {

      NS_LOG_WARN ("Cannot remove loopback address.");

      return false;

    }

  Ptr<Ipv6Interface> interface = GetInterface (i);

  Ipv6InterfaceAddress ifAddr = interface->RemoveAddress (address);

  if (ifAddr != Ipv6InterfaceAddress ())

  {

    if (m_routingProtocol != 0)

    {

      m_routingProtocol->NotifyRemoveAddress (i, ifAddr);

    }

    return true;

  }

  return false;

}

void Ipv6L3Protocol::SetMetric (uint32_t i, uint16_t metric)

{

  NS_LOG_FUNCTION (this << i << metric);

  Ptr<Ipv6Interface> interface = GetInterface (i);

  interface->SetMetric (metric);

}

uint16_t Ipv6L3Protocol::GetMetric (uint32_t i) const

{

  NS_LOG_FUNCTION (this << i);

  Ptr<Ipv6Interface> interface = GetInterface (i);

  return interface->GetMetric ();

}

uint16_t Ipv6L3Protocol::GetMtu (uint32_t i) const

{

  NS_LOG_FUNCTION (this << i);

  // RFC 1981, if PMTU is disabled, return the minimum MTU

  if (!m_mtuDiscover)

    {

      return IPV6_MIN_MTU;

    }

  Ptr<Ipv6Interface> interface = GetInterface (i);

  return interface->GetDevice ()->GetMtu ();

}

void Ipv6L3Protocol::SetPmtu (Ipv6Address dst, uint32_t pmtu)

{

  NS_LOG_FUNCTION (this << dst << int(pmtu));

  m_pmtuCache->SetPmtu (dst, pmtu);

}