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

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

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

 */

#ifndef ICMPV6_HEADER_H

#define ICMPV6_HEADER_H

#include "ns3/header.h"

#include "ns3/ipv6-address.h"

#include "ns3/packet.h"

namespace ns3

{

/**

 * \class Icmpv6Header

 * \brief ICMPv6 header.

 */

class Icmpv6Header : public Header

{

public:

  /**

   * \enum Type_e

   * \brief ICMPv6 type code.

   */

  enum Type_e

  {

    ICMPV6_ERROR_DESTINATION_UNREACHABLE = 1,

    ICMPV6_ERROR_PACKET_TOO_BIG,

    ICMPV6_ERROR_TIME_EXCEEDED,

    ICMPV6_ERROR_PARAMETER_ERROR,

    ICMPV6_ECHO_REQUEST = 128,

    ICMPV6_ECHO_REPLY,

    ICMPV6_SUBSCRIBE_REQUEST,

    ICMPV6_SUBSCRIBE_REPORT,

    ICMPV6_SUBSCRIVE_END,

    ICMPV6_ND_ROUTER_SOLICITATION,

    ICMPV6_ND_ROUTER_ADVERTISEMENT,

    ICMPV6_ND_NEIGHBOR_SOLICITATION,

    ICMPV6_ND_NEIGHBOR_ADVERTISEMENT,

    ICMPV6_ND_REDIRECTION,

    ICMPV6_ROUTER_RENUMBER,

    ICMPV6_INFORMATION_REQUEST,

    ICMPV6_INFORMATION_RESPONSE,

    ICMPV6_INVERSE_ND_SOLICITATION,

    ICMPV6_INVERSE_ND_ADVERSTISEMENT,

    ICMPV6_MLDV2_SUBSCRIBE_REPORT,

    ICMPV6_MOBILITY_HA_DISCOVER_REQUEST,

    ICMPV6_MOBILITY_HA_DISCOVER_RESPONSE,

    ICMPV6_MOBILITY_MOBILE_PREFIX_SOLICITATION,

    ICMPV6_SECURE_ND_CERTIFICATE_PATH_SOLICITATION,

    ICMPV6_SECURE_ND_CERTIFICATE_PATH_ADVERTISEMENT,

    ICMPV6_EXPERIMENTAL_MOBILITY

  };

  /**

   * \enum OptionType_e

   * \brief ICMPv6 Option type code.

   */

  enum OptionType_e

  {

    ICMPV6_OPT_LINK_LAYER_SOURCE = 1,

    ICMPV6_OPT_LINK_LAYER_TARGET,

    ICMPV6_OPT_PREFIX,

    ICMPV6_OPT_REDIRECTED,

    ICMPV6_OPT_MTU

  };

  /**

   * \enum ErrorDestinationUnreachable_e

   * \brief ICMPv6 error code : Destination Unreachable

   */

  enum ErrorDestinationUnreachable_e

  {

    ICMPV6_NO_ROUTE = 0,

    ICMPV6_ADM_PROHIBITED,

    ICMPV6_NOT_NEIGHBOUR,

    ICMPV6_ADDR_UNREACHABLE,

    ICMPV6_PORT_UNREACHABLE

  };

  /**

   * \enum ErrorTimeExceeded_e

   * \brief ICMPv6 error code : Time Exceeded

   */

  enum ErrorTimeExceeded_e

  {

    ICMPV6_HOPLIMIT = 0,

    ICMPV6_FRAGTIME

  };

  /**

   * \enum ErrorParameterError_e

   * \brief ICMPv6 error code : Parameter Error

   */

  enum ErrorParameterError_e

  {

    ICMPV6_MALFORMED_HEADER = 0,

    ICMPV6_UNKNOWN_NEXT_HEADER,

    ICMPV6_UNKNOWN_OPTION

  };

  /**

   * \brief Get the UID of this class.

   * \return UID

   */

  static TypeId GetTypeId ();

  /**

   * \brief Get the instance type ID.

   * \return instance type ID

   */

  virtual TypeId GetInstanceTypeId () const;

  /**

   * \brief Constructor.

   */

  Icmpv6Header ();

  /**

   * \brief Destructor.

   */

  virtual ~Icmpv6Header ();

  /**

   * \brief Get the type field.

   * \return type of ICMPv6 message

   */

  uint8_t GetType () const;

  /**

   * \brief Set the type.

   * \param type type to set

   */

  void SetType (uint8_t type);

  /**

   * \brief Get the code field.

   * \return code of ICMPv6 message

   */

  uint8_t GetCode () const;

  /**

   * \brief Set the code field.

   * \param code code to set

   */

  void SetCode (uint8_t code);

  /**

   * \brief Get the checksum.

   * \return checksum

   */

  uint16_t GetChecksum () const;

  /**

   * \brief Set the checksum.

   * \param checksum to set

   */

  void SetChecksum (uint16_t checksum);

  /**

   * \brief Print informations.

   * \param os output stream

   */

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

  /**

   * \brief Get the serialized size.

   * \return serialized size

   */

  virtual uint32_t GetSerializedSize () const;

  /**

   * \brief Serialize the packet.

   * \param start start offset

   */

  virtual void Serialize (Buffer::Iterator start) const;

  /**

   * \brief Deserialize the packet.

   * \param start start offset

   * \return length of packet

   */

  virtual uint32_t Deserialize (Buffer::Iterator start);

  /**

   * \brief Calculate pseudo header checksum for IPv6.

   * \param src source address

   * \param dst destination address

   * \param length length

   * \param protocol the protocol number to use in the

   * underlying IPv6 packet.

   */

  void CalculatePseudoHeaderChecksum (Ipv6Address src, Ipv6Address dst, uint16_t length, uint8_t protocol);

protected:

  /**

   * \brief Checksum enable or not.

   */

  bool m_calcChecksum;

  /**

   * \brief The checksum.

   */

  uint16_t m_checksum; 

private:

  /**

   * \brief The type.

   */

  uint8_t m_type;

  /**

   * \brief The code.

   */

  uint8_t m_code;

};

/**

 * \class Icmpv6OptionHeader

 * \brief ICMPv6 option header.

 */

class Icmpv6OptionHeader : public Header

{

public:

  /**

   * \brief Get the UID of this class.

   * \return UID

   */

  static TypeId GetTypeId ();

  /**

   * \brief Get the instance type ID.

   * \return instance type ID

   */

  virtual TypeId GetInstanceTypeId () const;

  /**

   * \brief Constructor.

   */

  Icmpv6OptionHeader ();

  /**

   * \brief Destructor.

   */

  virtual ~Icmpv6OptionHeader ();

  /**

   * \brief Get the type of the option.

   * \return type

   */

  uint8_t GetType () const;

  /**

   * \brief Set the type of the option.

   * \param type the type to set

   */

  void SetType (uint8_t type);

  /**

   * \brief Get the length of the option in 8 bytes unit.

   * \return length of the option

   */

  uint8_t GetLength () const;

  /**

   * \brief Set the length of the option.

   * \param len length value to set

   */

  void SetLength (uint8_t len);

  /**

   * \brief Print informations.

   * \param os output stream

   */

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

  /**

   * \brief Get the serialized size.

   * \return serialized size

   */

  virtual uint32_t GetSerializedSize () const;

  /**

   * \brief Serialize the packet.

   * \param start start offset

   */

  virtual void Serialize (Buffer::Iterator start) const;

  /**

   * \brief Deserialize the packet.

   * \param start start offset

   * \return length of packet

   */

  virtual uint32_t Deserialize (Buffer::Iterator start);

private:

  /**

   * \brief The type.

   */

  uint8_t m_type;

  /**

   * \brief The length.

   */

  uint8_t m_len;

};

/**

 * \class Icmpv6NS

 * \brief ICMPv6 Neighbor Solicitation header.

 */

class Icmpv6NS : public Icmpv6Header

{

public:

  /**

   * \brief Constructor.

   * \param target target IPv6 address

   */

  Icmpv6NS (Ipv6Address target);

  /**

   * \brief Constructor.

   */

  Icmpv6NS ();

  /**

   * \brief Destructor.

   */

  virtual ~Icmpv6NS ();

  /**

   * \brief Get the UID of this class.

   * \return UID

   */

  static TypeId GetTypeId ();

  /**

   * \brief Get the instance type ID.

   * \return instance type ID

   */

  virtual TypeId GetInstanceTypeId () const;

  /**

   * \brief Get the reserved field.

   * \return reserved value

   */

  uint32_t GetReserved () const;

  /**

   * \brief Set the reserved field.

   * \param reserved the reserved value

   */

  void SetReserved (uint32_t reserved);

  /**

   * \brief Get the IPv6 target field.

   * \return IPv6 address

   */

  Ipv6Address GetIpv6Target () const;

  /**

   * \brief Set the IPv6 target field.

   * \param target IPv6 address

   */

  void SetIpv6Target (Ipv6Address target);

  /**

   * \brief Print informations.

   * \param os output stream

   */

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

  /**

   * \brief Get the serialized size.

   * \return serialized size

   */

  virtual uint32_t GetSerializedSize () const;

  /**

   * \brief Serialize the packet.

   * \param start start offset

   */

  virtual void Serialize (Buffer::Iterator start) const;

  /**

   * \brief Deserialize the packet.

   * \param start start offset

   * \return length of packet

   */

  virtual uint32_t Deserialize (Buffer::Iterator start);

private:

  /**

   * \brief The reserved value.

   */

  uint32_t m_reserved;

  /**

   * \brief The IPv6 target address.

   */

  Ipv6Address m_target;

};

/**

 * \class Icmpv6NA

 * \brief ICMPv6 Neighbor Advertisement header.

 */

class Icmpv6NA : public Icmpv6Header

{

public:

  /**

   * \brief Constructor.

   */

  Icmpv6NA ();

  /**

   * \brief Destructor.

   */

  virtual ~Icmpv6NA ();

  /**

   * \brief Get the UID of this class.

   * \return UID

   */

  static TypeId GetTypeId ();

  /**

   * \brief Get the instance type ID.

   * \return instance type ID

   */

  virtual TypeId GetInstanceTypeId () const;

  /**

   * \brief Get the reserved field.

   * \return reserved value

   */

  uint32_t GetReserved () const;

  /**

   * \brief Set the reserved field.

   * \param reserved the reserved value

   */

  void SetReserved (uint32_t reserved);

  /**

   * \brief Get the IPv6 target field.

   * \return IPv6 address

   */

  Ipv6Address GetIpv6Target () const;

  /**

   * \brief Set the IPv6 target field.

   * \param target IPv6 address

   */

  void SetIpv6Target (Ipv6Address target);

  /**

   * \brief Get the R flag.

   * \return R flag

   */

  bool GetFlagR () const;

  /**

   * \brief Set the R flag.

   * \param r value

   */

  void SetFlagR (bool r);

  /**

   * \brief Get the S flag.

   * \return S flag

   */

  bool GetFlagS () const;

  /**