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

 *         David Gross <gdavid.devel@gmail.com>

 *         Mehdi Benamor <benamor.mehdi@ensi.rnu.tn>

 */

#ifndef ICMPV6_L4_PROTOCOL_H

#define ICMPV6_L4_PROTOCOL_H

#include <list>

#include "ns3/ipv6-address.h"

#include "icmpv6-header.h"

#include "ipv6-l4-protocol.h"

namespace ns3

{

class NetDevice;

class Node;

class Packet;

class TraceContext;

class NdiscCache;

/**

 * \class Icmpv6L4Protocol

 * \brief An implementation of the ICMPv6 protocol.

 */

class Icmpv6L4Protocol : public Ipv6L4Protocol

{

public:

  /**

   * \brief Interface ID

   */

  static TypeId GetTypeId ();

  /**

   * \brief ICMPv6 protocol number (58).

   */

  static const uint8_t PROT_NUMBER;

  /**

   * \brief Neighbor Discovery router constants : max initial RA initial interval.

   */

  static const uint8_t MAX_INITIAL_RTR_ADVERT_INTERVAL;

  /**

   * \brief Neighbor Discovery router constants : max initial RA transmission.

   */

  static const uint8_t MAX_INITIAL_RTR_ADVERTISEMENTS;

  /**

   * \brief Neighbor Discovery router constants : max final RA transmission.

   */

  static const uint8_t MAX_FINAL_RTR_ADVERTISEMENTS;

  /**

   * \brief Neighbor Discovery router constants : min delay between RA.

   */

  static const uint8_t MIN_DELAY_BETWEEN_RAS;

  /**

   * \brief Neighbor Discovery router constants : max delay between RA.

   */

  static const uint32_t MAX_RA_DELAY_TIME;

  /**

   * \brief Neighbor Discovery host constants : max RS delay.

   */

  static const uint8_t MAX_RTR_SOLICITATION_DELAY;

  /**

   * \brief Neighbor Discovery host constants : RS interval.

   */

  static const uint8_t RTR_SOLICITATION_INTERVAL;

  /**

   * \brief Neighbor Discovery host constants : max RS transmission.

   */

  static const uint8_t MAX_RTR_SOLICITATIONS;

  /**

   * \brief Neighbor Discovery node constants : max multicast solicitations.

   */

  static const uint8_t MAX_MULTICAST_SOLICIT;

  /**

   * \brief Neighbor Discovery node constants : max unicast solicitations.

   */

  static const uint8_t MAX_UNICAST_SOLICIT;

  /**

   * \brief Neighbor Discovery node constants : max anycast delay.

   */

  static const uint8_t MAX_ANYCAST_DELAY_TIME;

  /**

   * \brief Neighbor Discovery node constants : max NA transmission.

   */

  static const uint8_t MAX_NEIGHBOR_ADVERTISEMENT;

  /**

   * \brief Neighbor Discovery node constants : reachable time.

   */

  static const uint32_t REACHABLE_TIME;

  /**

   * \brief Neighbor Discovery node constants : retransmission timer.

   */

  static const uint32_t RETRANS_TIMER;

  /**

   * \brief Neighbor Discovery node constants : delay for the first probe.

   */

  static const uint8_t DELAY_FIRST_PROBE_TIME;

  /**

   * \brief Neighbor Discovery node constants : min random factor.

   */

  static const double MIN_RANDOM_FACTOR;

  /**

   * \brief Neighbor Discovery node constants : max random factor.

   */

  static const double MAX_RANDOM_FACTOR;

  /**

   * \brief Get ICMPv6 protocol number.

   * \return protocol number

   */

  static uint16_t GetStaticProtocolNumber ();

  /**

   * \brief Constructor.

   */

  Icmpv6L4Protocol ();

  /**

   * \brief Destructor.

   */

  virtual ~Icmpv6L4Protocol ();

  /**

   * \brief Set the node.

   * \param node the node to set

   */

  void SetNode (Ptr<Node> node);

  /**

   * \brief This method is called by AddAgregate and completes the aggregation

   * by setting the node in the ICMPv6 stack and adding ICMPv6 factory to

   * IPv6 stack connected to the node.

   */

  void NotifyNewAggregate ();

  /**

   * \brief Get the protocol number.

   * \return protocol number

   */

  virtual int GetProtocolNumber () const;

  /**

   * \brief Get the version of the protocol.

   * \return version

   */

  virtual int GetVersion () const;

  /**

   * \brief Send a packet via ICMPv6, note that packet already contains ICMPv6 header.

   * \param packet the packet to send which contains ICMPv6 header

   * \param src source address

   * \param dst destination address

   * \param ttl next hop limit

   */

  void SendMessage (Ptr<Packet> packet, Ipv6Address src, Ipv6Address dst, uint8_t ttl);

  /**

   * \brief Send a packet via ICMPv6.

   * \param packet the packet to send

   * \param dst destination address

   * \param icmpv6Hdr ICMPv6 header (needed to calculate checksum 

   * after source address is determined by routing stuff

   * \param ttl next hop limit

   */

  void SendMessage (Ptr<Packet> packet, Ipv6Address dst, Icmpv6Header& icmpv6Hdr, uint8_t ttl);

  /**

   * \brief Do the Duplication Address Detection (DAD).

   * \param target target address

   * \param interface interface

   */

  void DoDAD (Ipv6Address target, Ptr<Ipv6Interface> interface);

  /**

   * \brief Send a Neighbor Adverstisement.

   * \param src source IPv6 address

   * \param dst destination IPv6 address

   * \param hardwareAddress our MAC address

   * \param flags to set (4 = flag R, 2 = flag S, 3 = flag O)

   */

  void SendNA (Ipv6Address src, Ipv6Address dst, Address* hardwareAddress, uint8_t flags);

  /**

   * \brief Send a Echo Reply.

   * \param src source IPv6 address

   * \param dst destination IPv6 address

   * \param id id of the packet

   * \param seq sequence number

   * \param data auxiliary data

   */

  void SendEchoReply (Ipv6Address src, Ipv6Address dst, uint16_t id, uint16_t seq, Ptr<Packet> data);

  /**

   * \brief Send a Neighbor Solicitation.

   * \param src source IPv6 address

   * \param dst destination IPv6 addresss

   * \param target target IPv6 address

   * \param hardwareAddress our mac address

   */

  void SendNS (Ipv6Address src, Ipv6Address dst, Ipv6Address target, Address hardwareAddress);

  /**

   * \brief Send an error Destination Unreachable.

   * \param malformedPacket the malformed packet

   * \param dst destination IPv6 address

   * \param code code of the error

   */

  void SendErrorDestinationUnreachable (Ptr<Packet> malformedPacket, Ipv6Address dst, uint8_t code);

  /**

   * \brief Send an error Too Big.

   * \param malformedPacket the malformed packet

   * \param dst destination IPv6 address

   * \param mtu the mtu

   */

  void SendErrorTooBig (Ptr<Packet> malformedPacket, Ipv6Address dst, uint32_t mtu);

  /**

   * \brief Send an error Time Exceeded.

   * \param malformedPacket the malformed packet

   * \param dst destination IPv6 address

   * \param code code of the error

   */

  void SendErrorTimeExceeded (Ptr<Packet> malformedPacket, Ipv6Address dst, uint8_t code);

  /**

   * \brief Send an error Parameter Error.

   * \param malformedPacket the malformed packet

   * \param dst destination IPv6 address

   * \param code code of the error

   * \param ptr byte of p where the error is located

   */

  void SendErrorParameterError (Ptr<Packet> malformedPacket, Ipv6Address dst, uint8_t code, uint32_t ptr);

  /**

   * \brief Send an ICMPv6 Redirection.

   * \param redirectedPacket the redirected packet

   * \param dst destination IPv6 address

   * \param redirTarget IPv6 target address for Icmpv6Redirection

   * \param redirDestination IPv6 destination address for Icmpv6Redirection

   * \param redirHardwareTarget L2 target address for Icmpv6OptionRdirected

   */

  void SendRedirection (Ptr<Packet> redirectedPacket, Ipv6Address dst, Ipv6Address redirTarget, Ipv6Address redirDestination, Address redirHardwareTarget);

  /**

   * \brief Forge a Neighbor Solicitation.

   * \param src source IPv6 address

   * \param dst destination IPv6 addresss

   * \param target target IPv6 address

   * \param hardwareAddress our mac address

   * \return NS packet (with IPv6 header)

   */

  Ptr<Packet> ForgeNS (Ipv6Address src, Ipv6Address dst, Ipv6Address target, Address hardwareAddress);

  /**

   * \brief Forge a Neighbor Advertisement.

   * \param src source IPv6 address

   * \param dst destination IPv6 addresss

   * \param hardwareAddress our mac address

   * \param flags flags (bitfield => R (4), S (2), O (1))

   * \return NA packet (with IPv6 header)

   */

  Ptr<Packet> ForgeNA (Ipv6Address src, Ipv6Address dst, Address* hardwareAddress, uint8_t flags);

  /**

   * \brief Forge a Router Solicitation.

   * \param src source IPv6 address

   * \param dst destination IPv6 addresss

   * \param hardwareAddress our mac address

   * \return RS packet (with IPv6 header)

   */

  Ptr<Packet> ForgeRS (Ipv6Address src, Ipv6Address dst, Address hardwareAddress);

  /**

   * \brief Forge an Echo Request.

   * \param src source address

   * \param dst destination address

   * \param id ID of the packet

   * \param seq sequence number

   * \param data the data

   * \return Echo Request packet (without IPv6 header)

   */

  Ptr<Packet> ForgeEchoRequest (Ipv6Address src, Ipv6Address dst, uint16_t id, uint16_t seq, Ptr<Packet> data);

  /**

   * \brief Receive method.

   * \param p the packet

   * \param src source address

   * \param dst destination address

   * \param interface the interface from which the packet is coming

   */

  virtual enum Ipv6L4Protocol::RxStatus_e Receive (Ptr<Packet> p, Ipv6Address const &src, Ipv6Address const &dst, Ptr<Ipv6Interface> interface);

  /**

   * \brief Do the Duplication Address Detection.

   * It consists in sending a NS with our IPv6 as target. If 

   * we received a NA with matched target address, we could not use the address, 

   * else the address pass from TENTATIVE to PERMANENT.

   * \param addr IPv6 address to test

   * \param interface interface

   */

  void DoDad (Ipv6Address addr, Ptr<Ipv6Interface> interface);

  /**

   * \brief Function called when DAD timeout.

   * \param icmpv6 Icmpv6L4Protocol instance

   * \param interface the interface

   * \param addr the IPv6 address

   */

  static void FunctionDadTimeout (Ptr<Icmpv6L4Protocol> icmpv6, Ipv6Interface* interface, Ipv6Address addr);

  /**

   * \brief Lookup in the ND cache for the IPv6 address

   * \param dst destination address

   * \param device device

   * \param cache the neighbor cache

   * \param hardwareDestination hardware address

   * \note Unlike other Lookup method, it does not send NS request!

   */

  bool Lookup (Ipv6Address dst, Ptr<NetDevice> device, Ptr<NdiscCache> cache, Address* hardwareDestination);

  /**

   * \brief Lookup in the ND cache for the IPv6 address (similar as ARP protocol).

   *

   * It also send NS request to target and store the waiting packet.

   * \param p the packet

   * \param dst destination address

   * \param device device

   * \param cache the neighbor cache

   * \param hardwareDestination hardware address

   * \return true if the address is in the ND cache, the hardwareDestination is updated.

   */

  bool Lookup (Ptr<Packet> p, Ipv6Address dst, Ptr<NetDevice> device, Ptr<NdiscCache> cache, Address* hardwareDestination);

  /**

   * \brief Send a Router Solicitation.

   * \param src link-local source address

   * \param dst destination address (usealy ff02::2 i.e all-routers)

   * \param hardwareAddress link-layer address (SHOULD be included if src is not ::

   */

  void SendRS (Ipv6Address src, Ipv6Address dst,  Address hardwareAddress);

  /**

   * \brief Create a neighbor cache.

   * \param device thet NetDevice

   * \param interface the IPv6 interface

   * \return a smart pointer of NdCache or 0 if problem

   */

  Ptr<NdiscCache> CreateCache (Ptr<NetDevice> device, Ptr<Ipv6Interface> interface);

  /**

   * \brief Is the node must do DAD.

   * \return true if node has to do DAD.

   */

  bool IsAlwaysDad () const;

protected:

  /**

   * \brief Dispose this object.

   */

  virtual void DoDispose ();

private:

  typedef std::list<Ptr<NdiscCache> > CacheList;

  /**

   * \brief The node.

   */

  Ptr<Node> m_node;

  /**

   * \brief A list of cache by device.

   */

  CacheList m_cacheList;

  /**

   * \brief Always do DAD ?

   */

  bool m_alwaysDad;

  /**

   * \brief Receive Neighbor Solicitation method.

   * \param p the packet

   * \param src source address

   * \param dst destination address

   * \param interface the interface from which the packet is coming

   */

  void HandleNS (Ptr<Packet> p, Ipv6Address const &src, Ipv6Address const &dst, Ptr<Ipv6Interface> interface);

  /**

   * \brief Receive Router Solicitation method.

   * \param p the packet

   * \param src source address

   * \param dst destination address

   * \param interface the interface from which the packet is coming

   */

  void HandleRS (Ptr<Packet> p, Ipv6Address const &src, Ipv6Address const &dst, Ptr<Ipv6Interface> interface);

  /**

   * \brief Receive Router Advertisement method.

   * \param p the packet

   * \param src source address

   * \param dst destination address

   * \param interface the interface from which the packet is coming

   */

  void HandleRA (Ptr<Packet> p, Ipv6Address const &src, Ipv6Address const &dst, Ptr<Ipv6Interface> interface);

  /**

   * \brief Receive Echo Request method.

   * \param p the packet

   * \param src source address

   * \param dst destination address

   * \param interface the interface from which the packet is coming

   */

  void HandleEchoRequest (Ptr<Packet> p, Ipv6Address const &src, Ipv6Address const &dst, Ptr<Ipv6Interface> interface);

  /**

   * \brief Receive Neighbor Advertisement method.

   * \param p the packet

   * \param src source address

   * \param dst destination address

   * \param interface the interface from which the packet is coming

   */

  void HandleNA (Ptr<Packet> p, Ipv6Address const &src, Ipv6Address const &dst, Ptr<Ipv6Interface> interface);

  /**

   * \brief Receive Redirection method.

   * \param p the packet

   * \param src source address

   * \param dst destination address

   * \param interface the interface from which the packet is coming

   */

  void HandleRedirection (Ptr<Packet> p, Ipv6Address const &src, Ipv6Address const &dst, Ptr<Ipv6Interface> interface);

  /**

   * \brief Link layer address option processing.

   * \param lla LLA option

   * \param src source address

   * \param dst destination address

   * \param interface the interface from which the packet is coming

   */

  void ReceiveLLA (Icmpv6OptionLinkLayerAddress lla, Ipv6Address const &src, Ipv6Address const &dst, Ptr<Ipv6Interface> interface);

  /**

   * \brief Get the cache corresponding to the device.

   * \param device the device

   */

  Ptr<NdiscCache> FindCache (Ptr<NetDevice> device);

};

} /* namespace ns3 */

#endif /* ICMPV6_L4_PROTOCOL_H */