A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
dsr-options.h
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2011 Yufei Cheng
4  *
5  * This program is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License version 2 as
7  * published by the Free Software Foundation;
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software
16  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17  *
18  * Author: Yufei Cheng <yfcheng@ittc.ku.edu>
19  *
20  * James P.G. Sterbenz <jpgs@ittc.ku.edu>, director
21  * ResiliNets Research Group http://wiki.ittc.ku.edu/resilinets
22  * Information and Telecommunication Technology Center (ITTC)
23  * and Department of Electrical Engineering and Computer Science
24  * The University of Kansas Lawrence, KS USA.
25  *
26  * Work supported in part by NSF FIND (Future Internet Design) Program
27  * under grant CNS-0626918 (Postmodern Internet Architecture),
28  * NSF grant CNS-1050226 (Multilayer Network Resilience Analysis and Experimentation on GENI),
29  * US Department of Defense (DoD), and ITTC at The University of Kansas.
30  */
31 
32 #ifndef DSR_OPTION_H
33 #define DSR_OPTION_H
34 
35 #include <map>
36 #include <list>
37 
38 #include "ns3/buffer.h"
39 #include "ns3/packet.h"
40 #include "ns3/callback.h"
41 #include "ns3/ptr.h"
42 #include "ns3/udp-l4-protocol.h"
43 #include "ns3/ipv4.h"
44 #include "ns3/ipv4-route.h"
45 #include "ns3/object.h"
46 #include "ns3/node.h"
47 #include "ns3/ipv4-interface.h"
48 #include "ns3/ipv4-header.h"
49 #include "ns3/ipv4-address.h"
50 #include "ns3/traced-callback.h"
51 #include "ns3/output-stream-wrapper.h"
52 #include "ns3/timer.h"
53 
54 #include "dsr-rsendbuff.h"
55 #include "dsr-maintain-buff.h"
56 #include "dsr-option-header.h"
57 #include "dsr-rcache.h"
58 #include "dsr-routing.h"
59 #include "dsr-gratuitous-reply-table.h"
60 
61 namespace ns3 {
62 
63 class Packet;
64 class NetDevice;
65 class Node;
66 class Ipv4Address;
67 class Ipv4Interface;
68 class Ipv4Route;
69 class Ipv4;
70 class Time;
71 
72 namespace dsr {
73 
74 class DsrOptions : public Object
75 {
76 public:
81  static TypeId GetTypeId (void);
85  DsrOptions ();
89  virtual ~DsrOptions ();
94  virtual uint8_t GetOptionNumber () const = 0;
99  void SetNode (Ptr<Node> node);
104  Ptr<Node> GetNode () const;
109  bool ContainAddressAfter (Ipv4Address ipv4Address, Ipv4Address destAddress, std::vector<Ipv4Address> &nodeList);
114  std::vector<Ipv4Address> CutRoute (Ipv4Address ipv4Address, std::vector<Ipv4Address> &nodeList);
120  virtual Ptr<Ipv4Route> SetRoute (Ipv4Address nextHop, Ipv4Address srcAddress);
125  bool ReverseRoutes (std::vector<Ipv4Address>& vec);
130  Ipv4Address SearchNextHop (Ipv4Address ipv4Address, std::vector<Ipv4Address>& vec);
135  Ipv4Address ReverseSearchNextHop (Ipv4Address ipv4Address, std::vector<Ipv4Address>& vec);
140  Ipv4Address ReverseSearchNextTwoHop (Ipv4Address ipv4Address, std::vector<Ipv4Address>& vec);
144  void PrintVector (std::vector<Ipv4Address>& vec);
149  bool IfDuplicates (std::vector<Ipv4Address>& vec, std::vector<Ipv4Address>& vec2);
154  bool CheckDuplicates (Ipv4Address ipv4Address, std::vector<Ipv4Address>& vec);
155  /*
156  * \brief Remove the duplicates from the route
157  * \return the route after route shorten
158  */
159  void RemoveDuplicates (std::vector<Ipv4Address>& vec);
167  void ScheduleReply (Ptr<Packet> &packet, std::vector<Ipv4Address> &nodeList, Ipv4Address &source, Ipv4Address &destination);
172  uint32_t GetIDfromIP (Ipv4Address address);
177  Ptr<Node> GetNodeWithAddress (Ipv4Address ipv4Address);
189  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;
190 
191 protected:
195  TracedCallback<Ptr<const Packet> > m_dropTrace;
199  Ipv4Address Broadcast;
203  Ptr<dsr::RreqTable> m_rreqTable;
207  Ptr<dsr::RouteCache> m_routeCache;
211  Ptr<Ipv4Route> m_ipv4Route;
215  Ptr<Ipv4> m_ipv4;
219  std::vector<Ipv4Address> m_ipv4Address;
223  std::vector<Ipv4Address> m_finalRoute;
227  Time ActiveRouteTimeout;
231  TracedCallback <const DsrOptionSRHeader &> m_rxPacketTrace;
232 
233 private:
234  Ptr<Node> m_node;
235 };
236 
241 class DsrOptionPad1 : public DsrOptions
242 {
243 public:
247  static const uint8_t OPT_NUMBER = 224;
252  static TypeId GetTypeId ();
256  DsrOptionPad1 ();
260  virtual ~DsrOptionPad1 ();
265  virtual uint8_t GetOptionNumber () const;
277  virtual uint8_t Process (Ptr<Packet> packet, Ptr<Packet> dsrP, Ipv4Address ipv4Address, Ipv4Address source, Ipv4Header const& ipv4Header, uint8_t protocol, bool& isPromisc, Ipv4Address promiscSource);
278 };
279 
284 class DsrOptionPadn : public DsrOptions
285 {
286 public:
290  static const uint8_t OPT_NUMBER = 0;
295  static TypeId GetTypeId ();
299  DsrOptionPadn ();
303  virtual ~DsrOptionPadn ();
308  virtual uint8_t GetOptionNumber () const;
320  virtual uint8_t Process (Ptr<Packet> packet, Ptr<Packet> dsrP, Ipv4Address ipv4Address, Ipv4Address source, Ipv4Header const& ipv4Header, uint8_t protocol, bool& isPromisc, Ipv4Address promiscSource);
321 };
322 
327 class DsrOptionRreq : public DsrOptions
328 {
329 public:
333  static const uint8_t OPT_NUMBER = 1;
338  static TypeId GetTypeId ();
343  virtual TypeId GetInstanceTypeId () const;
347  DsrOptionRreq ();
351  virtual ~DsrOptionRreq ();
356  virtual uint8_t GetOptionNumber () const;
368  virtual uint8_t Process (Ptr<Packet> packet, Ptr<Packet> dsrP, Ipv4Address ipv4Address, Ipv4Address source, Ipv4Header const& ipv4Header, uint8_t protocol, bool& isPromisc, Ipv4Address promiscSource);
369 
370 private:
374  Ptr<dsr::RouteCache> m_routeCache;
378  Ptr<Ipv4> m_ipv4;
379 };
380 
385 class DsrOptionRrep : public DsrOptions
386 {
387 public:
391  static const uint8_t OPT_NUMBER = 2;
396  static TypeId GetTypeId ();
401  virtual TypeId GetInstanceTypeId () const;
405  DsrOptionRrep ();
409  virtual ~DsrOptionRrep ();
414  virtual uint8_t GetOptionNumber () const;
426  virtual uint8_t Process (Ptr<Packet> packet, Ptr<Packet> dsrP, Ipv4Address ipv4Address, Ipv4Address source, Ipv4Header const& ipv4Header, uint8_t protocol, bool& isPromisc, Ipv4Address promiscSource);
427 
428 private:
432  Ptr<dsr::RouteCache> m_routeCache;
436  uint32_t m_length;
440  Ptr<Ipv4> m_ipv4;
441 };
442 
447 class DsrOptionSR : public DsrOptions
448 {
449 public:
453  static const uint8_t OPT_NUMBER = 96;
458  static TypeId GetTypeId ();
463  virtual TypeId GetInstanceTypeId () const;
467  DsrOptionSR ();
471  virtual ~DsrOptionSR ();
476  virtual uint8_t GetOptionNumber () const;
488  virtual uint8_t Process (Ptr<Packet> packet, Ptr<Packet> dsrP, Ipv4Address ipv4Address, Ipv4Address source, Ipv4Header const& ipv4Header, uint8_t protocol, bool& isPromisc, Ipv4Address promiscSource);
489 
490 private:
494  uint32_t m_length;
498  Ptr<Ipv4> m_ipv4;
499 };
500 
505 class DsrOptionRerr : public DsrOptions
506 {
507 public:
511  static const uint8_t OPT_NUMBER = 3;
516  static TypeId GetTypeId ();
521  virtual TypeId GetInstanceTypeId () const;
525  DsrOptionRerr ();
529  virtual ~DsrOptionRerr ();
534  virtual uint8_t GetOptionNumber () const;
546  virtual uint8_t Process (Ptr<Packet> packet, Ptr<Packet> dsrP, Ipv4Address ipv4Address, Ipv4Address source, Ipv4Header const& ipv4Header, uint8_t protocol, bool& isPromisc, Ipv4Address promiscSource);
557  uint8_t DoSendError (Ptr<Packet> p, DsrOptionRerrUnreachHeader &rerr, uint32_t rerrSize, Ipv4Address ipv4Address, uint8_t protocol);
558 
559 private:
563  Ptr<dsr::RouteCache> m_routeCache;
567  uint32_t m_length;
571  Ptr<Ipv4> m_ipv4;
572 };
573 
578 class DsrOptionAckReq : public DsrOptions
579 {
580 public:
584  static const uint8_t OPT_NUMBER = 160;
589  static TypeId GetTypeId ();
594  virtual TypeId GetInstanceTypeId () const;
598  DsrOptionAckReq ();
602  virtual ~DsrOptionAckReq ();
607  virtual uint8_t GetOptionNumber () const;
619  virtual uint8_t Process (Ptr<Packet> packet, Ptr<Packet> dsrP, Ipv4Address ipv4Address, Ipv4Address source, Ipv4Header const& ipv4Header, uint8_t protocol, bool& isPromisc, Ipv4Address promiscSource);
620 
621 private:
625  Ptr<dsr::RouteCache> m_routeCache;
629  uint32_t m_length;
633  Ptr<Ipv4> m_ipv4;
634 };
635 
640 class DsrOptionAck : public DsrOptions
641 {
642 public:
646  static const uint8_t OPT_NUMBER = 32;
651  static TypeId GetTypeId ();
656  virtual TypeId GetInstanceTypeId () const;
660  DsrOptionAck ();
664  virtual ~DsrOptionAck ();
669  virtual uint8_t GetOptionNumber () const;
681  virtual uint8_t Process (Ptr<Packet> packet, Ptr<Packet> dsrP, Ipv4Address ipv4Address, Ipv4Address source, Ipv4Header const& ipv4Header, uint8_t protocol, bool& isPromisc, Ipv4Address promiscSource);
682 
683 private:
687  Ptr<dsr::RouteCache> m_routeCache;
691  uint32_t m_length;
695  Ptr<Ipv4> m_ipv4;
696 };
697 } // namespace dsr
698 } // Namespace ns3
699 
700 #endif