/*
Copyright (c) 1997, 1998 Carnegie Mellon University.  All Rights
Reserved. 

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
3. The name of the author may not be used to endorse or promote products
derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' 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 THE AUTHOR 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, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

The WCETT 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.
*/


#ifndef __wcett_rtable_h__
#define __wcett_rtable_h__

#include <assert.h>
#include <sys/types.h>
#include <config.h>
#include <lib/bsd-list.h>
#include <scheduler.h>

#define CURRENT_TIME    Scheduler::instance().clock()
#define INFINITY2        0xff

 

//carmen
//WCETT_LinkState is defined to record the linkstate on the route
class WCETT_LinkState{
        friend class WCETT;
        friend class wcett_rt_entry;
  public:
        WCETT_LinkState() {
                               node1=INFINITY2;
                               node2=INFINITY2;
                               //routetableindex=0;
 			       currentchannel=INFINITY2;
                               linkETT=-1;
        }
        nsaddr_t node1;
        nsaddr_t node2;
        //since each route table may need to store multi route entry for each node
        //this index is to record which index to use.
       // int routetableindex;
        int      currentchannel;
        int      linkETT;
};

         
/*
   WCETT Neighbor Cache Entry
*/
class WCETT_Neighbor {
        friend class WCETT;
        friend class wcett_rt_entry;
 public:
        WCETT_Neighbor(u_int32_t a) { nb_addr = a; }

 protected:
        LIST_ENTRY(WCETT_Neighbor) nb_link;
        nsaddr_t        nb_addr;
        double          nb_expire;      // ALLOWED_HELLO_LOSS * HELLO_INTERVAL
};

LIST_HEAD(wcett_ncache, WCETT_Neighbor);

/*
   WCETT Precursor list data structure
*/
class WCETT_Precursor {
        friend class WCETT;
        friend class wcett_rt_entry;
 public:
        WCETT_Precursor(u_int32_t a) { pc_addr = a; }

 protected:
        LIST_ENTRY(WCETT_Precursor) pc_link;
        nsaddr_t        pc_addr;	// precursor address
};

LIST_HEAD(wcett_precursors, WCETT_Precursor);


/*
  Route Table Entry
*/

class wcett_rt_entry {
        friend class wcett_rtable;
        friend class WCETT;
	friend class WCETTLocalRepairTimer;
 public:
        wcett_rt_entry();
        ~wcett_rt_entry();

        void            nb_insert(nsaddr_t id);
        WCETT_Neighbor*  nb_lookup(nsaddr_t id);

        void            pc_insert(nsaddr_t id);
        WCETT_Precursor* pc_lookup(nsaddr_t id);
        void 		pc_delete(nsaddr_t id);
        void 		pc_delete(void);
        bool 		pc_empty(void);

        double          rt_req_timeout;         // when I can send another req
        u_int8_t        rt_req_cnt;             // number of route requests
	
 protected:
        LIST_ENTRY(wcett_rt_entry) rt_link;

        nsaddr_t        rt_dst;
        nsaddr_t        rt_dst_no;//actual no. in rt list. rt_dst*10+i
        u_int32_t       rt_seqno;
        u_int8_t 	rt_interface; 
        u_int16_t       rt_hops;       		// hop count
        //carmen
        int  linkstateindex;
        WCETT_LinkState rt_linkstate[20];
	int 		rt_last_hop_count;	// last valid hop count
        nsaddr_t        rt_nexthop;    		// next hop IP address
        //carmen
        int             rt_if;          // node's current interface
        int             rt_index;       // indicate how many routes this dst have.
	/* list of precursors */ 
        wcett_precursors rt_pclist;
        double          rt_expire;     		// when entry expires
        u_int8_t        rt_flags;

#define RTF_DOWN 0
#define RTF_UP 1
#define RTF_IN_REPAIR 2

        /*
         *  Must receive 4 errors within 3 seconds in order to mark
         *  the route down.
        u_int8_t        rt_errors;      // error count
        double          rt_error_time;
#define MAX_RT_ERROR            4       // errors
#define MAX_RT_ERROR_TIME       3       // seconds
         */

#define MAX_HISTORY	3
	double 		rt_disc_latency[MAX_HISTORY];
	char 		hist_indx;
        int 		rt_req_last_ttl;        // last ttl value used
	// last few route discovery latencies
	// double 		rt_length [MAX_HISTORY];
	// last few route lengths

        /*
         * a list of neighbors that are using this route.
         */
        wcett_ncache          rt_nblist;
};


/*
  The Routing Table
*/

class wcett_rtable {
 public:
	wcett_rtable() { LIST_INIT(&rthead); }

        wcett_rt_entry*       head() { return rthead.lh_first; }

        wcett_rt_entry*       rt_add(nsaddr_t id);
        void                 rt_delete(nsaddr_t id);
        wcett_rt_entry*       rt_lookup(nsaddr_t id);
        //carmen
        void      	     rt_nexthop_if_change(nsaddr_t id, int newif);
        void                 rt_change_linkstate(wcett_rt_entry* rt,int srcid, int currentnodeid, int channel, int ETT);

 private:
        LIST_HEAD(wcett_rthead, wcett_rt_entry) rthead;
};

#endif /* _wcett__rtable_h__ */