dsr-option-header.h

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2011 Yufei Cheng
 *
 * 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: Yufei Cheng   <yfcheng@ittc.ku.edu>
 *
 * James P.G. Sterbenz <jpgs@ittc.ku.edu>, director
 * ResiliNets Research Group  http://wiki.ittc.ku.edu/resilinets
 * Information and Telecommunication Technology Center (ITTC)
 * and Department of Electrical Engineering and Computer Science
 * The University of Kansas Lawrence, KS USA.
 *
 * Work supported in part by NSF FIND (Future Internet Design) Program
 * under grant CNS-0626918 (Postmodern Internet Architecture),
 * NSF grant CNS-1050226 (Multilayer Network Resilience Analysis and Experimentation on GENI),
 * US Department of Defense (DoD), and ITTC at The University of Kansas.
 */

#ifndef DSR_OPTION_HEADER_H
#define DSR_OPTION_HEADER_H

#include <ostream>
#include <algorithm>

#include "ns3/header.h"
#include "ns3/ipv4-address.h"
#include "ns3/simulator.h"

namespace ns3 {

class Time;
namespace dsr {
class DsrOptionHeader : public Header
{
public:
  struct Alignment
  {
    uint8_t factor;   
    uint8_t offset;   
  };
  static TypeId GetTypeId ();
  virtual TypeId GetInstanceTypeId () const;
  DsrOptionHeader ();
  virtual ~DsrOptionHeader ();
  void SetType (uint8_t type);
  uint8_t GetType () const;
  void SetLength (uint8_t length);
  uint8_t GetLength () const;
  virtual void Print (std::ostream &os) const;
  virtual uint32_t GetSerializedSize () const;
  virtual void Serialize (Buffer::Iterator start) const;
  virtual uint32_t Deserialize (Buffer::Iterator start);
  virtual Alignment GetAlignment () const;

private:
  uint8_t m_type;
  uint8_t m_length;
  Buffer m_data;
};

class DsrOptionPad1Header : public DsrOptionHeader
{
public:
  static TypeId GetTypeId ();
  virtual TypeId GetInstanceTypeId () const;
  DsrOptionPad1Header ();
  virtual ~DsrOptionPad1Header ();
  virtual void Print (std::ostream &os) const;
  virtual uint32_t GetSerializedSize () const;
  virtual void Serialize (Buffer::Iterator start) const;
  virtual uint32_t Deserialize (Buffer::Iterator start);
};

class DsrOptionPadnHeader : public DsrOptionHeader
{
public:
  static TypeId GetTypeId ();
  virtual TypeId GetInstanceTypeId () const;
  DsrOptionPadnHeader (uint32_t pad = 2);
  virtual ~DsrOptionPadnHeader ();
  virtual void Print (std::ostream &os) const;
  virtual uint32_t GetSerializedSize () const;
  virtual void Serialize (Buffer::Iterator start) const;
  virtual uint32_t Deserialize (Buffer::Iterator start);
};

class DsrOptionRreqHeader : public DsrOptionHeader
{
public:
  static TypeId GetTypeId ();
  virtual TypeId GetInstanceTypeId () const;
  DsrOptionRreqHeader ();
  virtual ~DsrOptionRreqHeader ();
  void SetNumberAddress (uint8_t n);
  Ipv4Address GetTarget ();
  void SetTarget (Ipv4Address target);
  void SetNodesAddress (std::vector<Ipv4Address> ipv4Address);
  std::vector<Ipv4Address> GetNodesAddresses () const;
  uint32_t GetNodesNumber () const;
  void AddNodeAddress (Ipv4Address ipv4);
  void SetNodeAddress (uint8_t index, Ipv4Address addr);
  Ipv4Address GetNodeAddress (uint8_t index) const;
  void SetDataLength (uint32_t dataLength);
  uint32_t GetDataLength () const;
  void SetId (uint16_t identification);
  uint16_t GetId () const;
  virtual void Print (std::ostream &os) const;
  virtual uint32_t GetSerializedSize () const;
  virtual void Serialize (Buffer::Iterator start) const;
  virtual uint32_t Deserialize (Buffer::Iterator start);
  virtual Alignment GetAlignment () const;

private:
  uint32_t m_dataLength;
  uint16_t m_identification;
  /*
   * Ipv4 address of target node
   */
  Ipv4Address m_target;
  /*
   * Ipv4 address to write when desearizing the packet
   */
  Ipv4Address m_address;
  typedef std::vector<Ipv4Address> VectorIpv4Address_t;
  VectorIpv4Address_t m_ipv4Address;
};

// The Route Reply header modified for ns-3 implementation
class DsrOptionRrepHeader : public DsrOptionHeader
{
public:
  static TypeId GetTypeId ();
  virtual TypeId GetInstanceTypeId () const;
  DsrOptionRrepHeader ();
  virtual ~DsrOptionRrepHeader ();
  void SetNumberAddress (uint8_t n);
  void SetNodesAddress (std::vector<Ipv4Address> ipv4Address);
  std::vector<Ipv4Address> GetNodesAddress () const;
  /*
   * \brief Get the target node Ip address
   * \return the target address
   */
  Ipv4Address GetTargetAddress (std::vector<Ipv4Address> ipv4Address) const;
  void SetNodeAddress (uint8_t index, Ipv4Address addr);
  Ipv4Address GetNodeAddress (uint8_t index) const;
  /*
   * \brief Search the next hop Ipv4 address
   * \param Our own IP address
   * \return The next hop address of the route
   */
  Ipv4Address SearchNextHop (Ipv4Address ipv4Address);
  virtual void Print (std::ostream &os) const;
  virtual uint32_t GetSerializedSize () const;
  virtual void Serialize (Buffer::Iterator start) const;
  virtual uint32_t Deserialize (Buffer::Iterator start);
  virtual Alignment GetAlignment () const;

private:
  /*
   * The Ip address to write to when deserialize the packet
   */
  Ipv4Address m_address;
  typedef std::vector<Ipv4Address> VectorIpv4Address_t;
  VectorIpv4Address_t m_ipv4Address;
};

class DsrOptionSRHeader : public DsrOptionHeader
{
public:
  static TypeId GetTypeId ();
  virtual TypeId GetInstanceTypeId () const;
  DsrOptionSRHeader ();
  virtual ~DsrOptionSRHeader ();
  /*
   * \brief Set the number of segments left to send
   * \param The segments left
   */
  void SetSegmentsLeft (uint8_t segmentsLeft);
  /*
   * \brief Get the number of segments left to send
   * \return The segments left
   */
  uint8_t GetSegmentsLeft () const;
  void SetNumberAddress (uint8_t n);
  void SetNodesAddress (std::vector<Ipv4Address> ipv4Address);
  std::vector<Ipv4Address> GetNodesAddress () const;
  /*
   * \brief Get the node list size which is the number of ip address of the route
   * \return the node list size
   */
  uint8_t GetNodeListSize () const;
  void SetNodeAddress (uint8_t index, Ipv4Address addr);
  Ipv4Address GetNodeAddress (uint8_t index) const;
  /*
   * \brief Set the salvage value for a packet
   * \param The salvage value of the packet
   */
  void SetSalvage (uint8_t salvage);
  /*
   * \brief Get the salvage value for a packet
   * \return The salvage value of the packet
   */
  uint8_t GetSalvage () const;
  virtual void Print (std::ostream &os) const;
  virtual uint32_t GetSerializedSize () const;
  virtual void Serialize (Buffer::Iterator start) const;
  virtual uint32_t Deserialize (Buffer::Iterator start);
  virtual Alignment GetAlignment () const;

private:
  Ipv4Address m_address;
  uint8_t m_segmentsLeft;
  uint8_t m_salvage;
  typedef std::vector<Ipv4Address> VectorIpv4Address_t;
  VectorIpv4Address_t m_ipv4Address;
};

// / Error type
enum ErrorType
{
  NODE_UNREACHABLE  = 1,   // !< NODE_UNREACHABLE
  FLOW_STATE_NOT_SUPPORTED  = 2,   // !< FLOW_STATE_NOT_SUPPORTED
  OPTION_NOT_SUPPORTED  = 3,   // !< OPTION_NOT_SUPPORTED
};

class DsrOptionRerrHeader : public DsrOptionHeader
{
public:
  static TypeId GetTypeId ();
  virtual TypeId GetInstanceTypeId () const;
  DsrOptionRerrHeader ();
  virtual ~DsrOptionRerrHeader ();
  void SetErrorType (uint8_t errorType);
  uint8_t GetErrorType () const;
  virtual void SetErrorSrc (Ipv4Address errorSrcAddress);
  virtual Ipv4Address GetErrorSrc () const;
  virtual void SetSalvage (uint8_t salvage);
  virtual uint8_t GetSalvage () const;
  virtual void SetErrorDst (Ipv4Address errorDstAddress);
  virtual Ipv4Address GetErrorDst () const;
  virtual void Print (std::ostream &os) const;
  virtual uint32_t GetSerializedSize () const;
  virtual void Serialize (Buffer::Iterator start) const;
  virtual uint32_t Deserialize (Buffer::Iterator start);
  virtual Alignment GetAlignment () const;

private:
  uint8_t        m_optDataLen;
  uint8_t        m_errorType;
  uint8_t        m_reserved;
  uint8_t        m_salvage;
  uint16_t       m_errorLength;
  Ipv4Address    m_errorSrcAddress;
  Ipv4Address    m_errorDstAddress;
  Buffer m_errorData;
};

/*
 * \brief The type-specific info field
 * \verbatim
   |      0        |      1        |      2        |      3        |
   0 1 2 3 4 5 6 7 0 1 2 3 4 5 6 7 0 1 2 3 4 5 6 7 0 1 2 3 4 5 6 7
   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
   |                    Unreachable Node Address                   |
   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
   \endverbatim
 */

class DsrOptionRerrUnreachHeader : public DsrOptionRerrHeader
{
public:
  static TypeId GetTypeId ();
  virtual TypeId GetInstanceTypeId () const;
  DsrOptionRerrUnreachHeader ();
  virtual ~DsrOptionRerrUnreachHeader ();
  virtual void SetErrorSrc (Ipv4Address errorSrcAddress);
  virtual Ipv4Address GetErrorSrc () const;
  virtual void SetSalvage (uint8_t salvage);
  virtual uint8_t GetSalvage () const;
  virtual void SetErrorDst (Ipv4Address errorDstAddress);
  virtual Ipv4Address GetErrorDst () const;
  void SetUnreachNode (Ipv4Address unreachNode);
  Ipv4Address GetUnreachNode () const;
  void SetOriginalDst (Ipv4Address originalDst);
  Ipv4Address GetOriginalDst () const;
  virtual void Print (std::ostream &os) const;
  virtual uint32_t GetSerializedSize () const;
  virtual void Serialize (Buffer::Iterator start) const;
  virtual uint32_t Deserialize (Buffer::Iterator start);
  virtual Alignment GetAlignment () const;

private:
  uint8_t        m_optDataLen;
  uint8_t        m_errorType;
  uint8_t        m_reserved;
  uint8_t        m_salvage;
  Ipv4Address    m_errorSrcAddress;
  Ipv4Address    m_errorDstAddress;
  Ipv4Address    m_unreachNode;
  Ipv4Address    m_originalDst;
  uint16_t       m_typeSpecific;
};

/*
 * \brief The type-specific info field
 * \unsupported option
 * \verbatim
   |      0        |
   0 1 2 3 4 5 6 7
   +-+-+-+-+-+-+-+-+
   |Unsupported Opt|
   +-+-+-+-+-+-+-+-+
   \endverbatim
 */

class DsrOptionRerrUnsupportHeader : public DsrOptionRerrHeader
{
public:
  static TypeId GetTypeId ();
  virtual TypeId GetInstanceTypeId () const;
  DsrOptionRerrUnsupportHeader ();
  virtual ~DsrOptionRerrUnsupportHeader ();
  virtual void SetErrorSrc (Ipv4Address errorSrcAddress);
  virtual Ipv4Address GetErrorSrc () const;
  virtual void SetSalvage (uint8_t salvage);
  virtual uint8_t GetSalvage () const;
  virtual void SetErrorDst (Ipv4Address errorDstAddress);
  virtual Ipv4Address GetErrorDst () const;
  void SetUnsupported (uint16_t optionType);
  uint16_t GetUnsupported () const;
  virtual void Print (std::ostream &os) const;
  virtual uint32_t GetSerializedSize () const;
  virtual void Serialize (Buffer::Iterator start) const;
  virtual uint32_t Deserialize (Buffer::Iterator start);
  virtual Alignment GetAlignment () const;

private:
  uint8_t        m_optDataLen;
  uint8_t        m_errorType;
  uint8_t        m_reserved;
  uint8_t        m_salvage;
  Ipv4Address    m_errorSrcAddress;
  Ipv4Address    m_errorDstAddress;
  uint16_t       m_unsupport;
};

class DsrOptionAckReqHeader : public DsrOptionHeader
{
public:
  static TypeId GetTypeId ();
  virtual TypeId GetInstanceTypeId () const;
  DsrOptionAckReqHeader ();
  virtual ~DsrOptionAckReqHeader ();
  void SetAckId (uint16_t identification);
  uint16_t GetAckId () const;
  virtual void Print (std::ostream &os) const;
  virtual uint32_t GetSerializedSize () const;
  virtual void Serialize (Buffer::Iterator start) const;
  virtual uint32_t Deserialize (Buffer::Iterator start);
  virtual Alignment GetAlignment () const;

private:
  /*
   * The option data length
   */
  uint8_t  m_optDataLen;
  /*
   * The identification field
   */
  uint16_t m_identification;
};

class DsrOptionAckHeader : public DsrOptionHeader
{
public:
  static TypeId GetTypeId ();
  virtual TypeId GetInstanceTypeId () const;
  DsrOptionAckHeader ();
  virtual ~DsrOptionAckHeader ();
  void SetAckId (uint16_t identification);
  uint16_t GetAckId () const;
  void SetRealSrc (Ipv4Address realSrcAddress);
  Ipv4Address GetRealSrc () const;
  void SetRealDst (Ipv4Address realDstAddress);
  Ipv4Address GetRealDst () const;
  virtual void Print (std::ostream &os) const;
  virtual uint32_t GetSerializedSize () const;
  virtual void Serialize (Buffer::Iterator start) const;
  virtual uint32_t Deserialize (Buffer::Iterator start);
  virtual Alignment GetAlignment () const;

private:
  uint8_t m_optDataLen;
  uint16_t m_identification;
  Ipv4Address m_realSrcAddress;
  Ipv4Address m_realDstAddress;
};

static inline std::ostream & operator<< (std::ostream& os, const DsrOptionSRHeader & sr)
{
  sr.Print (os);
  return os;
}

} // namespace dsr
} // namespace ns3

#endif /* DSR_OPTION_HEADER_H */