aodv.h

在NS环境下对aodv路由协议进行仿真

//*****************************************************************************
//Ali Hamidian, aodv.h 0.2.
//*****************************************************************************
/*
  Copyright (c) 1997, 1998 Carnegie Mellon University.  All Rights
  Reserved. 

  Permission to use, copy, modify, and distribute this
  software and its documentation is hereby granted (including for
  commercial or for-profit use), provided that both the copyright notice
  and this permission notice appear in all copies of the software,
  derivative works, or modified versions, and any portions thereof, and
  that both notices appear in supporting documentation, and that credit
  is given to Carnegie Mellon University in all publications reporting
  on direct or indirect use of this code or its derivatives.

  ALL CODE, SOFTWARE, PROTOCOLS, AND ARCHITECTURES DEVELOPED BY THE CMU
  MONARCH PROJECT ARE EXPERIMENTAL AND ARE KNOWN TO HAVE BUGS, SOME OF
  WHICH MAY HAVE SERIOUS CONSEQUENCES. CARNEGIE MELLON PROVIDES THIS
  SOFTWARE OR OTHER INTELLECTUAL PROPERTY IN ITS ``AS IS'' CONDITION,
  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
  THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL CARNEGIE MELLON UNIVERSITY
  BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
  BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
  WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
  OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE OR
  INTELLECTUAL PROPERTY, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
  DAMAGE.

  Carnegie Mellon encourages (but does not require) users of this
  software or intellectual property to return any improvements or
  extensions that they make, and to grant Carnegie Mellon the rights to
  redistribute these changes without encumbrance.

  The AODV code developed by the CMU/MONARCH group was optimized
  and tuned by Samir Das and Mahesh Marina, University of Cincinnati. The
  work was partially done in Sun Microsystems.
 */

/* 
 * ############################################################################
 * This code was enhanced by Ali Hamidian, Department of Communication Systems,
 * Lund Institute of Technology, Lund University.
 * ns-2.1b9a/ns-2.26/ns-2.27 enhancements for simulations of Internet 
 * connectivity for mobile ad hoc networks with AODV.
 * e-mail: [e-mail]
 * ############################################################################
 */

#ifndef __aodv_h__
#define __aodv_h__

//#include <agent.h>
//#include <packet.h>
//#include <sys/types.h>
//#include <cmu/list.h>
//#include <scheduler.h>

#include <cmu-trace.h>
#include <priqueue.h>
#include <aodv/aodv_rtable.h>
#include <aodv/aodv_rqueue.h>
#include <classifier/classifier-port.h>

/*
  Allows local repair of routes.
  Local repair does not always work correct! Don't use it for now.
*/
//#define AODV_LOCAL_REPAIR

/*
  Allows AODV to use link-layer (802.11) feedback in determining when
  links are up/down.
*/
#define AODV_LINK_LAYER_DETECTION

/*
  Causes AODV to apply a "smoothing" function to the link layer feedback
  that is generated by 802.11.  In essence, it requires that RT_MAX_ERROR
  errors occurs within a window of RT_MAX_ERROR_TIME before the link
  is considered bad.
*/
#define AODV_USE_LL_METRIC

/*
  Only applies if AODV_USE_LL_METRIC is defined.
  Causes AODV to apply omniscient knowledge to the feedback received
  from 802.11.  This may be flawed, because it does not account for
  congestion.
*/
//#define AODV_USE_GOD_FEEDBACK

//My modification************************************************************//
/*
  To run simulations with different gateway discovery methods:
  
  1. PROACTIVE GATEWAY DISCOVERY METHOD
  * Type "Agent/AODV set gw_discovery 0" before the creation of the nodes in 
  * your Tcl file.
  
  2. HYBRID GATEWAY DISCOVERY METHOD
  * Type "Agent/AODV set gw_discovery 1" before the creation of the nodes in
  * your Tcl file.
  
  3. REACTIVE GATEWAY DISCOVERY METHOD
  * Type "Agent/AODV set gw_discovery 2" before the creation of the nodes in
  * your Tcl file.
  */
//#define DEQUE_AFTER_RREP_I
//***************************************************************************//

class AODV;

#define ACTIVE_ROUTE_TIMEOUT    10      // seconds 
#define BCAST_ID_SAVE           6	// seconds
#define MY_ROUTE_TIMEOUT        10     	// seconds
// Should be set by the user using best guess (conservative) 
#define NETWORK_DIAMETER        30      // hops
// This should be somewhat related to arp timeout
#define NODE_TRAVERSAL_TIME     0.03    // seconds (used in PerHopTime)
#define REV_ROUTE_LIFE          6	// seconds
// No. of times to do network-wide search before timing out for 
// MAX_RREQ_TIMEOUT sec.        
#define RREQ_RETRIES            2       // times
// Various constants used for the expanding ring search
#define TTL_START               5
#define TTL_INCREMENT           2 
#define TTL_THRESHOLD           7

// The followings are used for the forward() function. Controls pacing.
#define DELAY 1.0           // random delay - used for rebroadcasting RREQs
#define NO_DELAY -1.0       // no delay 

// think it should be 30 ms
#define ARP_DELAY 0.01      // fixed delay to keep arp happy

//My modification************************************************************//
/*
  The address of the default route is defined to -10.
  All the gateways in the MANET have a common address ALL_MANET_GW_MULTICAST.
*/
#define DEFAULT                  -10
#define ALL_MANET_GW_MULTICAST   -20
#define GWINFO_LIFETIME           10   // seconds
#define RREQ_I_RETRIES            4    // times

#define ADVERTISEMENT_ZONE        3    // hops, used for hybrid gw discovery
#define ADVERTISEMENT_INTERVAL    5    // seconds, used for hybrid & proactive
//***************************************************************************//

// timeout after doing network-wide search RREQ_RETRIES times
#define MAX_RREQ_TIMEOUT	10.0     // seconds

// Must be larger than the time difference between a node propagates a route 
// request and gets the route reply back.
//#define RREP_WAIT_TIME     (3 * NODE_TRAVERSAL_TIME * NETWORK_DIAMETER) // ms
//#define RREP_WAIT_TIME     (2 * REV_ROUTE_LIFE)  // seconds
#define RREP_WAIT_TIME         1.0  // seconds

#define LOCAL_REPAIR_WAIT_TIME  0.15     // seconds

#define ID_NOT_FOUND    0x00
#define ID_FOUND        0x01
//#define INFINITY        0xff

#define HELLO_INTERVAL          1               // second
#define ALLOWED_HELLO_LOSS      3               // packets
#define BAD_LINK_LIFETIME       3               // seconds
#define MaxHelloInterval        (1.25 * HELLO_INTERVAL)
#define MinHelloInterval        (0.75 * HELLO_INTERVAL)



/* =====================================================================
   Timers (Broadcast ID, Hello, Neighbor Cache, Route Cache)
   ===================================================================== */
class BroadcastTimer : public Handler {
 public:
  BroadcastTimer(AODV* a) : agent(a) {}
  void	handle(Event*);
 private:
  AODV    *agent;
  Event	intr;
};

class HelloTimer : public Handler {
 public:
  HelloTimer(AODV* a) : agent(a) {}
  void	handle(Event*);
 private:
  AODV    *agent;
  Event	intr;
};

class NeighborTimer : public Handler {
 public:
  NeighborTimer(AODV* a) : agent(a) {}
  void	handle(Event*);
 private:
  AODV    *agent;
  Event	intr;
};

class RouteCacheTimer : public Handler {
 public:
  RouteCacheTimer(AODV* a) : agent(a) {}
  void	handle(Event*);
 private:
  AODV    *agent;
  Event	intr;
};

class LocalRepairTimer : public Handler {
 public:
  LocalRepairTimer(AODV* a) : agent(a) {}
  void	handle(Event*);
 private:
  AODV    *agent;
  Event	intr;
};

//My modification************************************************************//
/*
  Implementing proactive and hybrid gateway discovery...
*/
class AdvertisementTimer : public Handler {
 public:
  AdvertisementTimer(AODV* a) : agent(a) {}
  void	handle(Event*);
 private:
  AODV    *agent;
  Event	intr;
};
//***************************************************************************//

/* =====================================================================
   Broadcast ID Cache
   ===================================================================== */
class BroadcastID {
  friend class AODV;
 public:
  BroadcastID(nsaddr_t i, u_int32_t b) { src = i; id = b;  }
 protected:
  LIST_ENTRY(BroadcastID) link;
  nsaddr_t        src;
  u_int32_t       id;
  double          expire;         // now + BCAST_ID_SAVE s
};

LIST_HEAD(aodv_bcache, BroadcastID);



/* =====================================================================
   The Routing Agent
   ===================================================================== */
class AODV: public Agent {
  /*
   * make some friends first 
   */
  
  friend class aodv_rt_entry;
  friend class BroadcastTimer;
  friend class HelloTimer;
  friend class NeighborTimer;
  friend class RouteCacheTimer;
  friend class LocalRepairTimer;
  //My modification***************************************//
  /*
    Implementing proactive and hybrid gateway discovery...
  */
  friend class AdvertisementTimer;
  //******************************************************//
  
 public:
  AODV(nsaddr_t id);

  void		recv(Packet *p, Handler *);
  
 protected:
  int             command(int, const char *const *);
  int             initialized() { return 1 && target_; }
  
  /*
   * Route Table Management
   */
  void            rt_resolve(Packet *p);
  void            rt_update(aodv_rt_entry *rt, u_int32_t seqnum,
			    u_int16_t metric, nsaddr_t nexthop,
			    double expire_time);
  void            rt_down(aodv_rt_entry *rt);
  void            local_rt_repair(aodv_rt_entry *rt, Packet *p);
  //My modification**********************************************************//
  void print_routing_table();
  aodv_rt_entry* find_send_entry(aodv_rt_entry *rt);
  aodv_rt_entry* find_fn_entry(void);
  //*************************************************************************//
 public:
  void            rt_ll_failed(Packet *p);
  void            handle_link_failure(nsaddr_t id);
 protected:
  void            rt_purge(void);
  
  void            enque(aodv_rt_entry *rt, Packet *p);
  Packet*         deque(aodv_rt_entry *rt);
  
  /*
   * Neighbor Management
   */
  void            nb_insert(nsaddr_t id);
  AODV_Neighbor*       nb_lookup(nsaddr_t id);
  void            nb_delete(nsaddr_t id);
  void            nb_purge(void);
  
  
  /*
   * Broadcast ID Management
   */
  
  void            id_insert(nsaddr_t id, u_int32_t bid);
  bool	        id_lookup(nsaddr_t id, u_int32_t bid);
  void            id_purge(void);
  
  /*
   * Packet TX Routines
   */
  void            forward(aodv_rt_entry *rt, Packet *p, double delay);
  void            sendHello(void);
  //My modification**********************************************************//
  /*
    Added a field for flags to be able to distinguish between ordinary 
    RREQ/RREP and RREQ_I/RREP_I.
  */
  void            sendRequest(nsaddr_t dst, u_int8_t flag);
  void            sendReply(nsaddr_t ipdst, u_int32_t hop_count,
			    nsaddr_t rpdst, u_int32_t rpseq,
			    u_int32_t lifetime, double timestamp, 
			    u_int8_t flag);
  /*
    Implementing proactive and hybrid gateway discovery...
  */
  void            sendAdvertisement(int ttl);
  //*************************************************************************//
  void            sendError(Packet *p, bool jitter = true);
  
  /*
   * Packet RX Routines
   */
  void            recvAODV(Packet *p);
  void            recvHello(Packet *p);
  void            recvRequest(Packet *p);
  void            recvReply(Packet *p);
  void            recvError(Packet *p);
  //My modification**********************************************************//
  /*
    Implementing proactive gateway discovery...
  */
  void recvAdvertisement(Packet *p);
  //*************************************************************************//
  
  /*
   * History management
   */
  double 		PerHopTime(aodv_rt_entry *rt);
  
  
  nsaddr_t        index;                  // IP Address of this node
  u_int32_t       seqno;                  // Sequence Number
  int             bid;                    // Broadcast ID
  
  //My modification**********************************************************//
  /*
    Implementing proactive and hybrid gateway discovery...
  */
  int gw_discovery;
  int ad_bid;                  //Broadcast ID for advertisemens from GW
  //*************************************************************************//
  
  aodv_rtable         rthead;                 // routing table
  aodv_ncache         nbhead;                 // Neighbor Cache
  aodv_bcache         bihead;                 // Broadcast ID Cache
  
  /*
   * Timers
   */
  BroadcastTimer  btimer;
  HelloTimer      htimer;
  NeighborTimer   ntimer;
  RouteCacheTimer rtimer;
  LocalRepairTimer lrtimer;
  //My modification****************************************//
  /*
    Implementing proactive and hybrid gateway discovery...
  */
  AdvertisementTimer adtimer;
  //*******************************************************//
  
  /*
   * Routing Table
   */
  aodv_rtable          rtable;
  /*
   *  A "drop-front" queue used by the routing layer to buffer
   *  packets to which it does not have a route.
   */
  aodv_rqueue         rqueue;
  
  /*
   * A mechanism for logging the contents of the routing
   * table.
   */
  Trace           *logtarget;
  
  /*
   * A pointer to the network interface queue that sits
   * between the "classifier" and the "link layer".
   */
  PriQueue        *ifqueue;
  
  //My modification**********************************************************//
  /*
    A pointer to a mobile node to be able to use base_stn() and 
    set_base_stn(int addr) in mobilenode.h.
  */
  MobileNode *thisnode;
  //*************************************************************************//
  
  /*
   * Logging stuff
   */
  void            log_link_del(nsaddr_t dst);
  void            log_link_broke(Packet *p);
  void            log_link_kept(nsaddr_t dst);

  /* for passing packets up to agents */
  PortClassifier *dmux_;
};

#endif /* __aodv_h__ */