File: xcp-end-sys.h

package info (click to toggle)
ns2 2.35%2Bdfsg-3
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 78,796 kB
  • sloc: cpp: 172,923; tcl: 107,130; perl: 6,391; sh: 6,143; ansic: 5,846; makefile: 816; awk: 525; csh: 355
file content (177 lines) | stat: -rw-r--r-- 5,614 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
// -*-  Mode:C++; c-basic-offset:8; tab-width:8; indent-tabs-mode:t -*-

/*
 * Copyright (C) 2004-2006 by the University of Southern California,
 * 						   Information Sciences Institute
 *                    2002 by Dina Katabi
 * $Id: xcp-end-sys.h,v 1.10 2006/05/30 20:30:30 pradkin Exp $
 *
 * 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.
 *
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms are permitted
 * provided that the above copyright notice and this paragraph are
 * duplicated in all such forms and that any documentation, advertising
 * materials, and other materials related to such distribution and use
 * acknowledge that the software was developed by the University of
 * Southern California, Information Sciences Institute.  The name of the
 * University may not be used to endorse or promote products derived from
 * this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR IMPLIED
 * WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
 *
 * $Header: /cvsroot/nsnam/ns-2/xcp/xcp-end-sys.h,v 1.10 2006/05/30 20:30:30 pradkin Exp $
 */

#ifndef ns_xcp_end_sys_h
#define ns_xcp_end_sys_h

#include <stdio.h>
#include <stdlib.h>
#include <sys/types.h>

#include "ip.h"
#include "tcp.h"
#include "flags.h"

#include "agent.h"
#include "packet.h"

#include "flags.h"
#include "tcp-sink.h"
#include "tcp-full.h"

#define XCP_HDR_LEN  20 // to match the internet draft 

struct hdr_xcp {
	double  x_;			//idealized inter-packet time
	double	rtt_;
	enum {
		XCP_DISABLED = 0,
		XCP_ENABLED,
		XCP_ACK,
	} 	xcp_enabled_;		// to indicate that the flow is XCP enabled
	int	xcpId_;			// Sender's ID (debugging only)
	double	cwnd_;			// The current window (debugging only) 
	double	reverse_feedback_;

	// --- Initialized by source and Updated by Router 
	double delta_throughput_;
	unsigned int controlling_hop_;  // The AQM ID of the controlling router

	static int offset_;	    // offset for this header
	inline static int& offset() { return offset_; }
	inline static hdr_xcp* access(Packet* p) {
		return (hdr_xcp*) p->access(offset_);
	}

	/* per-field member functions */
	double& cwnd() { return (cwnd_); }
	double& rtt() { return (rtt_); }
};


#define		MAX(a,b)	((a) > (b) ? (a) : (b))
#define		TP_TO_TICKS	MAX(1, (t_srtt_ >> T_SRTT_BITS))

#define TP_AVG_EXP		4	// used for xcp_metered_output_ == true

//Base class for Tcp and FullTcp XCP agents
class XcpEndsys {
protected:
	XcpEndsys(TcpAgent* tcp);
	void trace_var(const char *var_name, double var) const;
	void opencwnd() { /* nothing, cwnd is conrolled in recv() */ }
	void rtt_update(double tao);
	void init_rtt_vars() { srtt_estimate_ = 0.0; }
	void rtt_init();
	void recv(Packet *);
	void send(Packet *, int datalen);

	TcpAgent *tcp_;

	double	xcp_rev_fb_;	/* Accumulated throughput change to send back, B/s */
	double	current_positive_feedback_ ;
	int	tcpId_;
	double	srtt_estimate_;
	long	xcp_srtt_; // srtt estimate using the above macros

	/* more bits in delta for better precision, just for SRTT */
#define	XCP_DELTA_SHIFT		5
#define XCP_EXPO_SHIFT		3
#define	XCP_RTT_SHIFT		(XCP_DELTA_SHIFT + XCP_EXPO_SHIFT)	
	/* macros for SRTT calculations */
#define XCP_INIT_SRTT(rtt)					\
	((rtt) << XCP_RTT_SHIFT)
	   
#define XCP_UPDATE_SRTT(srtt, rtt)				\
	((srtt) + (((rtt) << XCP_DELTA_SHIFT)			\
		   - (((srtt) + (1 << (XCP_EXPO_SHIFT - 1)))	\
		      >> XCP_EXPO_SHIFT)))
	static unsigned int next_xcp_;
};

class XcpNewRenoFullTcpAgent : public NewRenoFullTcpAgent,
			       public XcpEndsys {
public:
	XcpNewRenoFullTcpAgent();

protected:
	/*New*/
	virtual void delay_bind_init_all();
	virtual int delay_bind_dispatch(const char *varName, 
					const char *localName, 
					TclObject *tracer);
	/*New*/
	virtual void opencwnd() { XcpEndsys::opencwnd(); }
	virtual void recv(Packet *, Handler *); 
	virtual void sendpacket(int seq, int ack, int flags, int dlen, int why, Packet *p=0);

	virtual void rtt_init(); // called in reset()
	virtual void rtt_update(double);
};

class XcpRenoTcpAgent : public RenoTcpAgent,
			public XcpEndsys {
public:
	XcpRenoTcpAgent();
protected:
	virtual void delay_bind_init_all();
	virtual int delay_bind_dispatch(const char *varName, 
					const char *localName, 
					TclObject *tracer);
        virtual void output_helper(Packet *);
        virtual void recv_newack_helper(Packet *);
        virtual void opencwnd() { XcpEndsys::opencwnd(); }
        virtual void rtt_init(); // called in reset()
        virtual void rtt_update(double);
};

class XcpTcpSink : public TcpSink,
		public XcpEndsys {
public:
	XcpTcpSink(Acker *);
	virtual void recv(Packet* pkt, Handler*);
protected:
        virtual void add_to_ack(Packet*);
        virtual void delay_bind_init_all();
        virtual int delay_bind_dispatch(const char *varName,
					const char *localName,
					TclObject *tracer);
};
	
#endif /* ns_xcp_end_sys_h */