/Network/IPv6/IPv6Send.cc

//
// Copyright (C) 2000 Institut fuer Telematik, Universitaet Karlsruhe
// Copyright (C) 2001, 2003 CTIE, Monash University
// Copyright (C) 2006 by Johnny Lai
//
// This program is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// 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 Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser 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.

/**
    @file IPv6Send.cc
    @brief Implementation for IPSendCore
    ------
    Responsibilities:
    receive IPInterfacePacket from Transport layer or ICMP
    or Tunneling (IP tunneled datagram)
    encapsulate in IP datagram
    set version
    set hoplimit
    set Protocol to received value
    set destination address to received value
    send datagram to Routing

    if IPInterfacePacket is invalid (e.g. invalid source address),
     it is thrown away without feedback

    @author Johnny Lai
    based on IPSendCore by Jochen Reber
*/
#include "sys.h"
#include "debug.h"

#include <boost/cast.hpp>
#include <boost/bind.hpp>

#include "IPv6Send.h"
#include "opp_utils.h" //getParser
#include "XMLOmnetParser.h"
#include "IPv6Datagram.h"
#include "IPv6ControlInfo_m.h"
#include "ipv6addrconv.h" //ipv6/ipv4 addr trans
#include "HdrExtRteProc.h"
#include "InterfaceTableAccess.h"
#include "IPv6InterfaceData.h"
#include "RoutingTable6Access.h"
#include "IPv6Mobility.h"
#include "AddrResInfo_m.h"
#include "IPv6CDS.h"
#include "MIPv6MStateMobileNode.h"
#include "MIPv6CDSMobileNode.h"

Define_Module( IPv6Send );

std::ostream& operator<<(std::ostream& os, SrcRoute& route)
{
  copy(route->begin(), route->end(), ostream_iterator<
       _SrcRoute::value_type>(os, " >>\n"));
  /*
  _SrcRoute* sr = route.get();
  typedef _SrcRoute::iterator SRI;
  os<<"start";
  for (SRI it = sr->begin(); it != sr->end();it++)
    os<<*it<<" ";
  os<<endl;
  */
  return os;
}

void IPv6Send::initialize()
{
  QueueBase::initialize();
  ift = InterfaceTableAccess().get();
  rt = RoutingTable6Access().get();

  ctrIP6OutNoRoutes = 0;

  defaultMCTimeToLive = par("multicastTimeToLive");
  ctrIP6OutRequests = 0;
  mob = check_and_cast<IPv6Mobility*>
    (OPP_Global::findModuleByType(rt, "IPv6Mobility"));

  parseSourceRoutes();

  WATCH_MAP(routes);

}

/*
  @brief Test for a preconfigured source route to a destination and insert an
  appropriate routing header
 */
bool IPv6Send::insertSourceRoute(IPv6Datagram& datagram)
{
  SRI srit = routes.find(datagram.destAddress());
  if (srit != routes.end() &&
      !datagram.findHeader(EXTHDR_ROUTING))
  {
    HdrExtRteProc* proc = datagram.acquireRoutingInterface();
    HdrExtRte* rt0 = proc->routingHeader();
    if(!rt0)
    {
      rt0 = new HdrExtRte;
      proc->addRoutingHeader(rt0);
    }
   Dout(dc::send, "source route triggered at "<<rt->nodeName()<<" on dgram="
	<<datagram);
    const SrcRoute& route = srit->second;
    for_each(route->begin()+1, route->end(),
	     boost::bind(&HdrExtRte::addAddress, rt0, _1));
    assert(datagram.destAddress() == *(route->rbegin()));
   Dout(dc::send, "source route added for "<<rt->nodeName()<<" dgram="
	 <<datagram<<" route="<<route);
    datagram.setDestAddress(*(route->begin()));
    return true;
  }
  return false;
}

void IPv6Send::parseSourceRoutes()
{
  typedef cXMLElementList::iterator NodeIt;

  XMLConfiguration::XMLOmnetParser* p = OPP_Global::getParser();
  cXMLElement* netNode = p->getNetNode(rt->nodeName());
  if (!netNode)
  {
    Dout(dc::warning, rt->nodeName()<<" no XML configuration found");
    return;
  }
  cXMLElement* nsource = netNode->getElementByPath("./sourceRoute");
  if (!nsource)
  {
    Dout(dc::send, "No source routes for "<<rt->nodeName()
         <<" in XML config");
    return;
  }
  else
    Dout(dc::xml_addresses|flush_cf, rt->nodeName()<<" in sourceRoute");

  cXMLElementList sres = nsource->getChildrenByTagName("sourceRouteEntry");
  for (NodeIt it = sres.begin();it != sres.end();it++)
  {
    cXMLElement* nsre = *it;
    cXMLElementList nextHops = nsre->getChildrenByTagName("nextHop");
    size_t nextHopCount = nextHops.size();
    SrcRoute route(new _SrcRoute(nextHopCount + 1, IPv6_ADDR_UNSPECIFIED));
    (*route)[nextHopCount] = c_ipv6_addr(p->getNodeProperties(nsre, "finalDestination").c_str());

    NodeIt nextIt = nextHops.begin();
    for ( size_t j = 0 ; j < nextHopCount; nextIt++, j++)
    {
      cXMLElement* nnh = *nextIt;
      (*route)[j] = c_ipv6_addr(p->getNodeProperties(nnh, "address").c_str());
    }

    routes[*route->rbegin()] = route;
  }
}

///sends datagram from transport or 3.5 layer onto forwarding module only
///Neighbour Discovery and Mobility skips this
void IPv6Send::endService(cMessage* msg)
{
  IPv6Datagram *datagram = encapsulatePacket(msg);
  if (!datagram)
    return;
  auto_ptr<IPv6Datagram> cleanup(datagram);

  if (!rt->localDeliver(datagram->destAddress()))
  {

// {{{ Process outgoing packet for MIP6 

//binding exists for dest then swap dest==hoa to coa

  if (rt->mobilitySupport())
  {
    if (rt->isMobileNode())
    {
      MobileIPv6::MIPv6MStateMobileNode* mstateMN = 
	boost::polymorphic_downcast<MobileIPv6::MIPv6MStateMobileNode*>(mob->role);
      mstateMN->mnSrcAddrDetermination(datagram);

      bool tunnel = false;
      if (!mstateMN->mnSendPacketCheck(*datagram, tunnel))
      {
	ctrIP6OutNoRoutes++;
	return;
      }
      if (tunnel)
      {
	cleanup.release();
	send(datagram, "tunnelEntry");
	return;
      }
    }

    (boost::polymorphic_downcast<MobileIPv6::MIPv6MStateCorrespondentNode*>(
      mob->role))->cnSendPacketCheck(*datagram);
  }

// }}}

  insertSourceRoute(*datagram);

  AddrResInfo* info = new AddrResInfo;
  rt->conceptualSending(datagram, info);
  datagram->setControlInfo(info);

  if (rt->mobilitySupport() && rt->hmipSupport() && info->status() == 0 && 
      info->ifIndex() > ift->numInterfaceGates())
  {
    Dout(dc::send|flush_cf, rt->nodeName()<<":"<<datagram->inputPort()
         <<" vIfindex="<<hex<<info->status()<<dec<<" dgram="<<*datagram
	 <<" hmip tunnel trig");
    datagram->setOutputPort(info->ifIndex());
    delete datagram->removeControlInfo();
    cleanup.release();
    send(datagram, "tunnelEntry");
    return;
  }

  //Set src address here if upper layer protocols left it up
  //to network layer
  if (datagram->srcAddress() == IPv6_ADDR_UNSPECIFIED)
  {
    datagram->setSrcAddress(rt->determineSrcAddress(
                              datagram->destAddress(), info->ifIndex()));
  }

// {{{ Drop packets with src addresses that are not ready yet

  if (rt->mobilitySupport() && info->status() == 0)
  {
    assert(ift->numInterfaceGates() > info->ifIndex());
    MobileIPv6::MIPv6CDSMobileNode* mipv6cdsMN = rt->mipv6cds->mipv6cdsMN;
    if (mipv6cdsMN && mipv6cdsMN->currentRouter().get() != 0 &&
	datagram->srcAddress() != mipv6cdsMN->homeAddr()
	)
    {
      if (
	(ift->interfaceByPortNo(info->ifIndex())->ipv6()->addrAssigned(
	  datagram->srcAddress())
	 ||
	 (rt->odad() &&
	  ift->interfaceByPortNo(info->ifIndex())->ipv6()->tentativeAddrAssigned(
	    datagram->srcAddress())
	  ))
	)
      {
	Dout(dc::send|flush_cf, rt->nodeName()<<" "<<simTime()
	     <<" checking coa "<<datagram->srcAddress()
	     <<" is onlink at correct ifIndex "<<info->ifIndex());
	unsigned int ifIndexTest;
	//outgoing interface (ifIndex) MUST have src addr (care of Addr) as on
	//link prefix
	//assert(rt->cds->lookupAddress(datagram->srcAddress(), ifIndexTest));
	//assert(ifIndexTest == info->ifIndex());
	if (!rt->cds->lookupAddress(datagram->srcAddress(), ifIndexTest))
	{
	  Dout(dc::send|dc::mipv6, rt->nodeName()<<" "<<simTime()
	       <<"No suitable src address available on foreign network as "
	       <<"coa is old one "<<datagram->srcAddress()
	       <<"and BA from HA not received packet dropped");
	  datagram->setSrcAddress(IPv6_ADDR_UNSPECIFIED);
	}
      }
      else
      {
	  InterfaceEntry *ie = ift->interfaceByPortNo(info->ifIndex());
	  if (ie->ipv6()->tentativeAddrs.size())
          {
	    ipv6_addr unready = ie->ipv6()->tentativeAddrs[ie->ipv6()->tentativeAddrs.size()-1];
	    Dout(dc::send|dc::mipv6, rt->nodeName()<<" "<<simTime()
	       <<"No suitable src address available on foreign network as "
	       <<"ncoa in not ready from DAD or BA from HA/MAP not received "
	       <<unready<<" packet dropped");
          }
          else 
            assert(false); //should not triggger otherwise check repo as
	  //bu should have been sen once addr assigned and hence using correct
	  //src addr/coa

	datagram->setSrcAddress(IPv6_ADDR_UNSPECIFIED);
      }
    }
    else if (mipv6cdsMN && mipv6cdsMN->currentRouter().get() == 0)
    {
	  Dout(dc::send|dc::mipv6, rt->nodeName()<<" "<<simTime()
	       <<" No suitable src address available on foreign network as no "
	       <<"routers recorded so far to form coa so packet dropped");
      datagram->setSrcAddress(IPv6_ADDR_UNSPECIFIED);
    }
  }

// }}}

// {{{ unspecified src addr so drop

  if (datagram->srcAddress() == IPv6_ADDR_UNSPECIFIED)
  {
    if (!rt->mobilitySupport())
      Dout(dc::warning, rt->nodeName()<<" "<<className()<<" No suitable src Address for destination "
	   <<datagram->destAddress());
    ctrIP6OutNoRoutes++;
    //TODO probably send error message about -EADDRNOTAVAIL

    return;
  }

// }}}
	
  } // if !localDeliver

  cleanup.release();
  send(datagram, "routingOut");

}

IPv6Datagram *IPv6Send::encapsulatePacket(cMessage *msg)
{
  // if no interface exists, do not send datagram
  if (ift->numInterfaceGates() == 0 ||
      ift->interfaceByPortNo(0)->ipv6()->inetAddrs.size() == 0)
  {
    if ((rt->odad() &&
	 ift->interfaceByPortNo(0)->ipv6()->tentativeAddrs.size() == 0) ||
	ift->numInterfaceGates() == 0)
    {
      cerr<<rt->nodeId()<<" 1st Interface is not ready yet"<<endl;
      Dout(dc::warning, rt->nodeName()<<" 1st Interface is not ready yet");
      delete msg;
      return NULL;
    }
  }

  IPv6Datagram *datagram = new IPv6Datagram();
  IPv6ControlInfo *ctrl = check_and_cast<IPv6ControlInfo*>(msg->removeControlInfo());

  datagram->encapsulate(msg);
  datagram->setName(msg->name());
  //display bit set?
  if (msg->kind() == 1)
    datagram->setKind(1);

  datagram->setTransportProtocol(ctrl->protocol());

  // set source and destination address
  assert(mkIpv6_addr(ctrl->destAddr()) != IPv6_ADDR_UNSPECIFIED);
  datagram->setDestAddress(mkIpv6_addr(ctrl->destAddr()));

  // when source address given in Interface Message, use it
  if (mkIpv6_addr(ctrl->srcAddr()) != IPv6_ADDR_UNSPECIFIED)
  {
    //Test if source address actually exists
    bool found = false;
    for (size_t ifIndex = 0; ifIndex < ift->numInterfaceGates(); ifIndex++)
    {
      InterfaceEntry *ie = ift->interfaceByPortNo(ifIndex);
      if (ie->ipv6()->addrAssigned(mkIpv6_addr(ctrl->srcAddr())) ||
          (rt->odad() && ie->ipv6()->tentativeAddrAssigned(mkIpv6_addr(ctrl->srcAddr()))))
      {
        found = true;
        break;
      }
    }

    if (!found)
    {
      Dout(dc::warning|flush_cf, rt->nodeName()<<" src addr not assigned in ifaces "<<mkIpv6_addr(ctrl->srcAddr()));
      //Perhaps coa not assigned yet?
      //opp_error(rt->nodeName()<<" src addr not found in ifaces "<<mkIpv6_addr(ctrl->srcAddr()));
      //assert(false);
      delete ctrl;
      delete datagram;
      return 0;
    }

    datagram->setSrcAddress(mkIpv6_addr(ctrl->srcAddr()));
  }
  else
  {
    //Let IPv6Routing determine src addr
  }

  datagram->setInputPort(-1);

  if (ctrl->timeToLive() > 0)
    datagram->setHopLimit(ctrl->timeToLive());

  datagram->setEncapLimit(ctrl->encapLimit());

  //TODO check dest Path MTU here
  ctrIP6OutRequests++;

  delete ctrl;
  return datagram;
}

void IPv6Send::finish()
{
  recordScalar("IP6OutRequests", ctrIP6OutRequests);
  recordScalar("IP6OutNoRoutes", ctrIP6OutNoRoutes);
}