dsr-options.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_H
#define DSR_OPTION_H

#include <map>
#include <list>

#include "ns3/buffer.h"
#include "ns3/packet.h"
#include "ns3/callback.h"
#include "ns3/ptr.h"
#include "ns3/udp-l4-protocol.h"
#include "ns3/ipv4.h"
#include "ns3/ipv4-route.h"
#include "ns3/object.h"
#include "ns3/node.h"
#include "ns3/ipv4-interface.h"
#include "ns3/ipv4-header.h"
#include "ns3/ipv4-address.h"
#include "ns3/traced-callback.h"
#include "ns3/output-stream-wrapper.h"
#include "ns3/timer.h"

#include "dsr-rsendbuff.h"
#include "dsr-maintain-buff.h"
#include "dsr-option-header.h"
#include "dsr-rcache.h"
#include "dsr-routing.h"
#include "dsr-gratuitous-reply-table.h"

namespace ns3 {

class Packet;
class NetDevice;
class Node;
class Ipv4Address;
class Ipv4Interface;
class Ipv4Route;
class Ipv4;
class Time;

namespace dsr {

class DsrOptions : public Object
{
public:
  static TypeId GetTypeId (void);
  DsrOptions ();
  virtual ~DsrOptions ();
  virtual uint8_t GetOptionNumber () const = 0;
  void SetNode (Ptr<Node> node);
  Ptr<Node> GetNode () const;
  bool ContainAddressAfter (Ipv4Address ipv4Address, Ipv4Address destAddress, std::vector<Ipv4Address> &nodeList);
  std::vector<Ipv4Address> CutRoute (Ipv4Address ipv4Address, std::vector<Ipv4Address> &nodeList);
  virtual Ptr<Ipv4Route> SetRoute (Ipv4Address nextHop, Ipv4Address srcAddress);
  bool ReverseRoutes  (std::vector<Ipv4Address>& vec);
  Ipv4Address SearchNextHop (Ipv4Address ipv4Address, std::vector<Ipv4Address>& vec);
  Ipv4Address ReverseSearchNextHop (Ipv4Address ipv4Address, std::vector<Ipv4Address>& vec);
  Ipv4Address ReverseSearchNextTwoHop  (Ipv4Address ipv4Address, std::vector<Ipv4Address>& vec);
  void PrintVector (std::vector<Ipv4Address>& vec);
  bool IfDuplicates (std::vector<Ipv4Address>& vec, std::vector<Ipv4Address>& vec2);
  bool CheckDuplicates (Ipv4Address ipv4Address, std::vector<Ipv4Address>& vec);
  /*
   * \brief Remove the duplicates from the route
   * \return the route after route shorten
   */
  void RemoveDuplicates (std::vector<Ipv4Address>& vec);
  void ScheduleReply (Ptr<Packet> &packet, std::vector<Ipv4Address> &nodeList, Ipv4Address &source, Ipv4Address &destination);
  uint32_t GetIDfromIP (Ipv4Address address);
  Ptr<Node> GetNodeWithAddress (Ipv4Address ipv4Address);
  virtual uint8_t Process (Ptr<Packet> packet, Ptr<Packet> dsrP, Ipv4Address ipv4Address, Ipv4Address source, Ipv4Header const& ipv4Header, uint8_t protocol, bool& isPromisc, Ipv4Address promiscSource) = 0;

protected:
  TracedCallback<Ptr<const Packet> > m_dropTrace;
  Ipv4Address Broadcast;
  Ptr<dsr::RreqTable> m_rreqTable;
  Ptr<dsr::RouteCache> m_routeCache;
  Ptr<Ipv4Route> m_ipv4Route;
  Ptr<Ipv4> m_ipv4;
  std::vector<Ipv4Address> m_ipv4Address;
  std::vector<Ipv4Address> m_finalRoute;
  Time ActiveRouteTimeout;
  TracedCallback <const DsrOptionSRHeader &> m_rxPacketTrace;

private:
  Ptr<Node> m_node;
};

class DsrOptionPad1 : public DsrOptions
{
public:
  static const uint8_t OPT_NUMBER = 224;
  static TypeId GetTypeId ();
  DsrOptionPad1 ();
  virtual ~DsrOptionPad1 ();
  virtual uint8_t GetOptionNumber () const;
  virtual uint8_t Process (Ptr<Packet> packet, Ptr<Packet> dsrP, Ipv4Address ipv4Address, Ipv4Address source, Ipv4Header const& ipv4Header, uint8_t protocol, bool& isPromisc, Ipv4Address promiscSource);
};

class DsrOptionPadn : public DsrOptions
{
public:
  static const uint8_t OPT_NUMBER = 0;
  static TypeId GetTypeId ();
  DsrOptionPadn ();
  virtual ~DsrOptionPadn ();
  virtual uint8_t GetOptionNumber () const;
  virtual uint8_t Process (Ptr<Packet> packet, Ptr<Packet> dsrP, Ipv4Address ipv4Address, Ipv4Address source, Ipv4Header const& ipv4Header, uint8_t protocol, bool& isPromisc, Ipv4Address promiscSource);
};

class DsrOptionRreq : public DsrOptions
{
public:
  static const uint8_t OPT_NUMBER = 1;
  static TypeId GetTypeId ();
  virtual TypeId GetInstanceTypeId () const;
  DsrOptionRreq ();
  virtual ~DsrOptionRreq ();
  virtual uint8_t GetOptionNumber () const;
  virtual uint8_t Process (Ptr<Packet> packet, Ptr<Packet> dsrP, Ipv4Address ipv4Address, Ipv4Address source, Ipv4Header const& ipv4Header, uint8_t protocol, bool& isPromisc, Ipv4Address promiscSource);

private:
  Ptr<dsr::RouteCache> m_routeCache;
  Ptr<Ipv4> m_ipv4;
};

class DsrOptionRrep : public DsrOptions
{
public:
  static const uint8_t OPT_NUMBER = 2;
  static TypeId GetTypeId ();
  virtual TypeId GetInstanceTypeId () const;
  DsrOptionRrep ();
  virtual ~DsrOptionRrep ();
  virtual uint8_t GetOptionNumber () const;
  virtual uint8_t Process (Ptr<Packet> packet, Ptr<Packet> dsrP, Ipv4Address ipv4Address, Ipv4Address source, Ipv4Header const& ipv4Header, uint8_t protocol, bool& isPromisc, Ipv4Address promiscSource);

private:
  Ptr<dsr::RouteCache> m_routeCache;
  uint32_t m_length;
  Ptr<Ipv4> m_ipv4;
};

class DsrOptionSR : public DsrOptions
{
public:
  static const uint8_t OPT_NUMBER = 96;
  static TypeId GetTypeId ();
  virtual TypeId GetInstanceTypeId () const;
  DsrOptionSR ();
  virtual ~DsrOptionSR ();
  virtual uint8_t GetOptionNumber () const;
  virtual uint8_t Process (Ptr<Packet> packet, Ptr<Packet> dsrP, Ipv4Address ipv4Address, Ipv4Address source, Ipv4Header const& ipv4Header, uint8_t protocol, bool& isPromisc, Ipv4Address promiscSource);

private:
  uint32_t m_length;
  Ptr<Ipv4> m_ipv4;
};

class DsrOptionRerr : public DsrOptions
{
public:
  static const uint8_t OPT_NUMBER = 3;
  static TypeId GetTypeId ();
  virtual TypeId GetInstanceTypeId () const;
  DsrOptionRerr ();
  virtual ~DsrOptionRerr ();
  virtual uint8_t GetOptionNumber () const;
  virtual uint8_t Process (Ptr<Packet> packet, Ptr<Packet> dsrP, Ipv4Address ipv4Address, Ipv4Address source, Ipv4Header const& ipv4Header, uint8_t protocol, bool& isPromisc, Ipv4Address promiscSource);
  uint8_t DoSendError (Ptr<Packet> p, DsrOptionRerrUnreachHeader &rerr, uint32_t rerrSize, Ipv4Address ipv4Address, uint8_t protocol);

private:
  Ptr<dsr::RouteCache> m_routeCache;
  uint32_t m_length;
  Ptr<Ipv4> m_ipv4;
};

class DsrOptionAckReq : public DsrOptions
{
public:
  static const uint8_t OPT_NUMBER = 160;
  static TypeId GetTypeId ();
  virtual TypeId GetInstanceTypeId () const;
  DsrOptionAckReq ();
  virtual ~DsrOptionAckReq ();
  virtual uint8_t GetOptionNumber () const;
  virtual uint8_t Process (Ptr<Packet> packet, Ptr<Packet> dsrP, Ipv4Address ipv4Address, Ipv4Address source, Ipv4Header const& ipv4Header, uint8_t protocol, bool& isPromisc, Ipv4Address promiscSource);

private:
  Ptr<dsr::RouteCache> m_routeCache;
  uint32_t m_length;
  Ptr<Ipv4> m_ipv4;
};

class DsrOptionAck : public DsrOptions
{
public:
  static const uint8_t OPT_NUMBER = 32;
  static TypeId GetTypeId ();
  virtual TypeId GetInstanceTypeId () const;
  DsrOptionAck ();
  virtual ~DsrOptionAck ();
  virtual uint8_t GetOptionNumber () const;
  virtual uint8_t Process (Ptr<Packet> packet, Ptr<Packet> dsrP, Ipv4Address ipv4Address, Ipv4Address source, Ipv4Header const& ipv4Header, uint8_t protocol, bool& isPromisc, Ipv4Address promiscSource);

private:
  Ptr<dsr::RouteCache> m_routeCache;
  uint32_t m_length;
  Ptr<Ipv4> m_ipv4;
};
} // namespace dsr
} // Namespace ns3

#endif