File: tora.h

package info (click to toggle)
ns2 2.35%2Bdfsg-2.1
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 78,780 kB
  • ctags: 27,490
  • sloc: cpp: 172,923; tcl: 107,130; perl: 6,391; sh: 6,143; ansic: 5,846; makefile: 816; awk: 525; csh: 355
file content (181 lines) | stat: -rw-r--r-- 5,499 bytes parent folder | download | duplicates (8)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
/* -*-  Mode:C++; c-basic-offset:8; tab-width:8; indent-tabs-mode:t -*- */
/*
 * Copyright (c) 1997 Regents of the University of California.
 * 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. All advertising materials mentioning features or use of this software
 *    must display the following acknowledgement:
 *      This product includes software developed by the Computer Systems
 *      Engineering Group at Lawrence Berkeley Laboratory.
 * 4. Neither the name of the University nor of the Laboratory may be used
 *    to endorse or promote products derived from this software without
 *    specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``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 REGENTS OR CONTRIBUTORS 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.
 *
 * Ported from CMU/Monarch's code 
 *
 * $Header: /cvsroot/nsnam/ns-2/tora/tora.h,v 1.5 2000/09/01 03:04:12 haoboy Exp $
 */

#ifndef __tora_h__
#define __tora_h__

#include <packet.h>
#include <ip.h>
#include <cmu-trace.h>
#include <priqueue.h>
#include <rtqueue.h>
#include "lib/bsd-list.h"

#include <rtproto/rtproto.h>
#include <imep/imep.h>
#include <tora/tora_packet.h>
#include <tora/tora_neighbor.h>
#include <tora/tora_dest.h>

LIST_HEAD(td_head, TORADest);

//#define LOGGING

typedef double Time;

/*
 *  Causes TORA to discard any packets that have "looped".
 */
#define TORA_DISALLOW_ROUTE_LOOP

#define MinQueryRate		0.200	// seconds
// used to rate limit queries

class TORANeighbor;
class TORADest;
class Height;

class toraAgent : public rtAgent {
        friend class TORANeighbor;
        friend class TORADest;
public:
        toraAgent(nsaddr_t id);
        void recv(Packet* p, Handler*);
        int		command(int argc, const char*const* argv);

	// ============================================================
	// Routing API (see cmu/rtproto/rtproto.h)

	void rtNotifyLinkUP(nsaddr_t index);
	void rtNotifyLinkDN(nsaddr_t index);
	void rtNotifyLinkStatus(nsaddr_t index, u_int32_t status);
	void rtRoutePacket(Packet *p);

	// ============================================================

private:

        nsaddr_t        index;  // added for line 78 of tora.cc, needed for
                                // further verification

	TORADest*	dst_find(nsaddr_t id);
	TORADest*	dst_add(nsaddr_t id);
	void		dst_dump(void);

	void		rt_resolve(Packet *p);
        void            forward(Packet *p, nsaddr_t nexthop, Time delay = 0.0);

	void		purge_queue(void);
	void		enque(TORADest *td, Packet *p);
	Packet*		deque(TORADest *td);

	/*
	 * Incoming Packets
	 */
        void		recvTORA(Packet* p);
	void		recvQRY(Packet *p);
	void		recvUPD(Packet *p);
	void		recvCLR(Packet *p);

	/*
	 *  Outgoing Packets
	 */
	void		sendQRY(nsaddr_t id);
	void		sendUPD(nsaddr_t id);
	void		sendCLR(nsaddr_t id, double tau, nsaddr_t oid);
	void		tora_output(Packet *p);


	// ============================================================
	// ============================================================

	inline int initialized() {
		 return logtarget && ifqueue && imepagent;
	}

	td_head		dstlist;	// Active destinations

	imepAgent	*imepagent;
	// a handle to the IMEP layer

	/*
	 * A mechanism for logging the contents of the routing
	 * table.
	 */
	Trace		*logtarget;
	void trace(char* fmt, ...);
	virtual void reset();

        /*
         *  A "drop-front" queue used by the routing layer to buffer
         *  packets to which it does not have a route.
         */
        rtqueue        rqueue;

	/*
	 * A pointer to the network interface queue that sits
	 * between the "classifier" and the "link layer".
	 */
	PriQueue	*ifqueue;

        /*
         * Logging Routines
         */
	void		log_route_loop(nsaddr_t prev, nsaddr_t next);

	void		log_link_layer_feedback(Packet *p);
        void            log_link_layer_recycle(Packet *p);
        void            log_lnk_del(nsaddr_t dst);
        void            log_lnk_kept(nsaddr_t dst);

        void            log_nb_del(nsaddr_t dst, nsaddr_t id);
	void		log_recv_qry(Packet *p);
	void		log_recv_upd(Packet *p);
	void		log_recv_clr(Packet *p);
	void		log_route_table(void);

        void            log_dst_state_change(TORADest *td);

	void		logNextHopChange(TORADest *td);
	void		logNbDeletedLastDN(TORADest *td);
	void		logToraDest(TORADest *td);
	void		logToraNeighbor(TORANeighbor *tn);
};

#endif /* __tora_h__ */