ipv6-l3-protocol.h

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

#ifndef IPV6_L3_PROTOCOL_H
#define IPV6_L3_PROTOCOL_H

#include <list>

#include "ns3/traced-callback.h"
#include "ns3/net-device.h"
#include "ns3/ipv6.h"
#include "ns3/ipv6-address.h"
#include "ns3/ipv6-header.h"

namespace ns3
{

class Node;
class Ipv6Interface;
class IpL4Protocol;
class Ipv6Route;
class Ipv6MulticastRoute;
class Ipv6RawSocketImpl;
class Icmpv6L4Protocol;
class Ipv6AutoconfiguredPrefix;

class Ipv6L3Protocol : public Ipv6
{
public:
  static TypeId GetTypeId ();

  static const uint16_t PROT_NUMBER;

  enum DropReason 
  {
    DROP_TTL_EXPIRED = 1, 
    DROP_NO_ROUTE, 
    DROP_INTERFACE_DOWN, 
    DROP_ROUTE_ERROR, 
    DROP_UNKNOWN_PROTOCOL, 
  };

  Ipv6L3Protocol ();

  virtual ~Ipv6L3Protocol ();

  void SetNode (Ptr<Node> node);

  void Insert (Ptr<IpL4Protocol> protocol);

  void Remove (Ptr<IpL4Protocol> protocol);

  Ptr<IpL4Protocol> GetProtocol (int protocolNumber) const;

  Ptr<Socket> CreateRawSocket ();

  void DeleteRawSocket (Ptr<Socket> socket);

  void SetDefaultTtl (uint8_t ttl);

  void SetDefaultTclass (uint8_t tclass);

  void Receive (Ptr<NetDevice> device, Ptr<const Packet> p, uint16_t protocol, const Address &from, const Address &to, NetDevice::PacketType packetType);

  void Send (Ptr<Packet> packet, Ipv6Address source, Ipv6Address destination, uint8_t protocol, Ptr<Ipv6Route> route);

  void SetRoutingProtocol (Ptr<Ipv6RoutingProtocol> routingProtocol);

  Ptr<Ipv6RoutingProtocol> GetRoutingProtocol () const;

  uint32_t AddInterface (Ptr<NetDevice> device);

  Ptr<Ipv6Interface> GetInterface (uint32_t i) const;

  uint32_t GetNInterfaces () const;

  int32_t GetInterfaceForAddress (Ipv6Address addr) const;

  int32_t GetInterfaceForPrefix (Ipv6Address addr, Ipv6Prefix mask) const;

  int32_t GetInterfaceForDevice (Ptr<const NetDevice> device) const;

  bool AddAddress (uint32_t i, Ipv6InterfaceAddress address);

  Ipv6InterfaceAddress GetAddress (uint32_t interfaceIndex, uint32_t addressIndex) const;

  uint32_t GetNAddresses (uint32_t interface) const;

  bool RemoveAddress (uint32_t interfaceIndex, uint32_t addressIndex);

  void SetMetric (uint32_t i, uint16_t metric);

  uint16_t GetMetric (uint32_t i) const;

  uint16_t GetMtu (uint32_t i) const;

  bool IsUp (uint32_t i) const;

  void SetUp (uint32_t i);

  void SetDown (uint32_t i);

  bool IsForwarding (uint32_t i) const;

  void SetForwarding (uint32_t i, bool val);

  Ptr<NetDevice> GetNetDevice (uint32_t i);

  Ptr<Icmpv6L4Protocol> GetIcmpv6 () const;

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

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

  virtual void RegisterExtensions ();

  virtual void RegisterOptions ();

protected:
  virtual void DoDispose ();

  virtual void NotifyNewAggregate ();

private:
  /* for unit-tests */
  friend class Ipv6L3ProtocolTestCase;
  friend class Ipv6ExtensionLooseRouting;

  typedef std::list<Ptr<Ipv6Interface> > Ipv6InterfaceList;
  typedef std::list<Ptr<Ipv6RawSocketImpl> > SocketList;
  typedef std::list<Ptr<IpL4Protocol> > L4List_t;

  typedef std::list< Ptr<Ipv6AutoconfiguredPrefix> > Ipv6AutoconfiguredPrefixList;
  typedef std::list< Ptr<Ipv6AutoconfiguredPrefix> >::iterator Ipv6AutoconfiguredPrefixListI;

  TracedCallback<Ptr<const Packet>, Ptr<Ipv6>, uint32_t> m_txTrace;

  TracedCallback<Ptr<const Packet>, Ptr<Ipv6>, uint32_t> m_rxTrace;

  TracedCallback<const Ipv6Header &, Ptr<const Packet>, DropReason, Ptr<Ipv6>, uint32_t> m_dropTrace;

  Ipv6L3Protocol (const Ipv6L3Protocol& o);

  Ipv6L3Protocol &operator = (const Ipv6L3Protocol& o);

  Ipv6Header BuildHeader (Ipv6Address src, Ipv6Address dst, uint8_t protocol,
                          uint16_t payloadSize, uint8_t hopLimit, uint8_t tclass);

  void SendRealOut (Ptr<Ipv6Route> route, Ptr<Packet> packet, Ipv6Header const& ipHeader);

  void IpForward (Ptr<Ipv6Route> rtentry, Ptr<const Packet> p, const Ipv6Header& header);

  void IpMulticastForward (Ptr<Ipv6MulticastRoute> mrtentry, Ptr<const Packet> p, const Ipv6Header& header);

  void LocalDeliver (Ptr<const Packet> p, Ipv6Header const& ip, uint32_t iif);

  void RouteInputError (Ptr<const Packet> p, const Ipv6Header& ipHeader, Socket::SocketErrno sockErrno);

  uint32_t AddIpv6Interface (Ptr<Ipv6Interface> interface);

  void SetupLoopback ();

  virtual void SetIpForward (bool forward);

  virtual bool GetIpForward () const;

  virtual void SetSendIcmpv6Redirect (bool sendIcmpv6Redirect);

  virtual bool GetSendIcmpv6Redirect () const;

  Ptr<Node> m_node;

  bool m_ipForward;

  L4List_t m_protocols;

  Ipv6InterfaceList m_interfaces;

  uint32_t m_nInterfaces;

  uint8_t m_defaultTtl;

  uint8_t m_defaultTclass;

  Ptr<Ipv6RoutingProtocol> m_routingProtocol;

  SocketList m_sockets;

  Ipv6AutoconfiguredPrefixList m_prefixes;

  bool m_sendIcmpv6Redirect;
};

} /* namespace ns3 */

#endif /* IPV6_L3_PROTOCOL_H */