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

//

// Copyright (c) 2006 Georgia Tech Research Corporation

// 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: George F. Riley<riley@ece.gatech.edu>

//

#ifndef IPV4_L3_PROTOCOL_H

#define IPV4_L3_PROTOCOL_H

#include <list>

#include <stdint.h>

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

#include "ns3/trace-context-element.h"

#include "ns3/ipv4-address.h"

#include "ns3/ptr.h"

#include "ns3/ipv4.h"

#include "ipv4-header.h"

#include "ipv4-static-routing.h"

namespace ns3 {

class Packet;

class NetDevice;

class Ipv4Interface;

class Ipv4Address;

class Ipv4Header;

class Ipv4Route;

class Node;

class TraceResolver;

class TraceContext;

/**

 * \brief hold in a TraceContext the type of trace source used by this Ipv4L3Protocol

 */

class Ipv4L3ProtocolTraceContextElement : public TraceContextElement

{

public:

  enum Type {

    TX,

    RX,

    DROP,

  };

  Ipv4L3ProtocolTraceContextElement ();

  Ipv4L3ProtocolTraceContextElement (enum Type type);

  /**

   * \returns true if this is a tx event, false otherwise.

   */

  bool IsTx (void) const;

  /**

   * \returns true if this is a rx event, false otherwise.

   */

  bool IsRx (void) const;

  /**

   * \returns true if this is a drop event, false otherwise.

   */

  bool IsDrop (void) const;

  void Print (std::ostream &os) const;

  static uint16_t GetUid (void);

  std::string GetTypeName (void) const;

private:

  enum Type m_type;

};

/**

 * \brief hold in a TraceContext the index of an Ipv4Interface within the ipv4 stack of a Node

 */

class Ipv4L3ProtocolInterfaceIndex : public TraceContextElement

{

public:

  Ipv4L3ProtocolInterfaceIndex ();

  Ipv4L3ProtocolInterfaceIndex (uint32_t index);

  /**

   * \returns the index of the Ipv4Interface within a Node.

   */

  uint32_t Get (void) const;

  void Print (std::ostream &os) const;

  static uint16_t GetUid (void);

  std::string GetTypeName (void) const;

private:

  uint32_t m_index;

};

class Ipv4L3Protocol : public Object

{

public:

  static const InterfaceId iid;

  static const uint16_t PROT_NUMBER;

  Ipv4L3Protocol(Ptr<Node> node);

  virtual ~Ipv4L3Protocol ();

  /**

   * \param ttl default ttl to use

   *

   * When we need to send an ipv4 packet, we use this default

   * ttl value.

   */

  void SetDefaultTtl (uint8_t ttl);

  /**

   * \param device the device to match

   * \returns the matching interface, zero if not found.

   *

   * Try to find an Ipv4Interface whose NetDevice is equal to

   * the input NetDevice.

   */

  Ptr<Ipv4Interface> FindInterfaceForDevice (Ptr<const NetDevice> device);

  /**

   * Lower layer calls this method after calling L3Demux::Lookup

   * The ARP subclass needs to know from which NetDevice this

   * packet is coming to:

   *    - implement a per-NetDevice ARP cache

   *    - send back arp replies on the right device

   */

  /**

   * \param packet packet to send

   * \param source source address of packet

   * \param destination address of packet

   * \param protocol number of packet

   *

   * Higher-level layers call this method to send a packet

   * down the stack to the MAC and PHY layers.

   */

	     Ipv4Address destination, uint8_t protocol);

  void AddHostRouteTo (Ipv4Address dest, 

                       Ipv4Address nextHop, 

                       uint32_t interface);

  void AddHostRouteTo (Ipv4Address dest, 

                       uint32_t interface);

  void AddNetworkRouteTo (Ipv4Address network, 

                          Ipv4Mask networkMask, 

                          Ipv4Address nextHop, 

                          uint32_t interface);

  void AddNetworkRouteTo (Ipv4Address network, 

                          Ipv4Mask networkMask, 

                          uint32_t interface);

  void SetDefaultRoute (Ipv4Address nextHop, 

                        uint32_t interface);

  void Lookup (Ipv4Header const &ipHeader,

               Ipv4RoutingProtocol::RouteReplyCallback routeReply);

  uint32_t GetNRoutes (void);

  Ipv4Route *GetRoute (uint32_t i);

  void RemoveRoute (uint32_t i);

  void AddMulticastRoute (Ipv4Address origin,

                          Ipv4Address group,

                          uint32_t inputInterface,

                          std::vector<uint32_t> outputInterfaces);

  void SetDefaultMulticastRoute (uint32_t onputInterface);

  uint32_t GetNMulticastRoutes (void) const;

  Ipv4MulticastRoute *GetMulticastRoute (uint32_t i) const;

  void RemoveMulticastRoute (Ipv4Address origin,

                             Ipv4Address group,

                             uint32_t inputInterface);

  void RemoveMulticastRoute (uint32_t i);

  uint32_t AddInterface (Ptr<NetDevice> device);

  Ptr<Ipv4Interface> GetInterface (uint32_t i) const;

  uint32_t GetNInterfaces (void) const;

  uint32_t FindInterfaceForAddr (Ipv4Address addr) const;

  uint32_t FindInterfaceForAddr (Ipv4Address addr, Ipv4Mask mask) const;

  void JoinMulticastGroup (Ipv4Address origin, Ipv4Address group);

  void LeaveMulticastGroup (Ipv4Address origin, Ipv4Address group);

  void SetAddress (uint32_t i, Ipv4Address address);

  void SetNetworkMask (uint32_t i, Ipv4Mask mask);

  Ipv4Mask GetNetworkMask (uint32_t t) const;

  Ipv4Address GetAddress (uint32_t i) const;

  bool GetIfIndexForDestination (Ipv4Address destination, 

                                 uint32_t& ifIndex) const;

  uint16_t GetMtu (uint32_t i) const;

  bool IsUp (uint32_t i) const;

  void SetUp (uint32_t i);

  void SetDown (uint32_t i);

  void AddRoutingProtocol (Ptr<Ipv4RoutingProtocol> routingProtocol,

                           int priority);

protected:

  virtual void DoDispose (void);

  virtual Ptr<TraceResolver> GetTraceResolver (void) const;

private:

  void Lookup (uint32_t ifIndex,

               Ipv4Header const &ipHeader,

               Ipv4RoutingProtocol::RouteReplyCallback routeReply);

  void SendRealOut (bool found,

                    Ipv4Route const &route,

                    Ipv4Header const &ipHeader);

  bool Forwarding (uint32_t ifIndex, 

                   Ipv4Header &ipHeader, 

                   Ptr<NetDevice> device);

  uint32_t AddIpv4Interface (Ptr<Ipv4Interface> interface);

  void SetupLoopback (void);

  typedef std::list<Ptr<Ipv4Interface> > Ipv4InterfaceList;

  typedef std::list<std::pair<Ipv4Address, Ipv4Address> > 

    Ipv4MulticastGroupList;

  typedef std::list< std::pair< int, Ptr<Ipv4RoutingProtocol> > > Ipv4RoutingProtocolList;

  Ipv4InterfaceList m_interfaces;

  uint32_t m_nInterfaces;

  uint8_t m_defaultTtl;

  uint16_t m_identification;

  Ptr<Node> m_node;

  Ipv4RoutingProtocolList m_routingProtocols;

  Ptr<Ipv4StaticRouting> m_staticRouting;

  Ipv4MulticastGroupList m_multicastGroups;

};

} // Namespace ns3

#endif /* IPV4_L3_PROTOCOL_H */