[deliverable/linux.git] / net / dccp / ccids / ccid3.h

/*
 *  net/dccp/ccids/ccid3.h
 *
 *  Copyright (c) 2005 The University of Waikato, Hamilton, New Zealand.
 *
 *  An implementation of the DCCP protocol
 *
 *  This code has been developed by the University of Waikato WAND
 *  research group. For further information please see http://www.wand.net.nz/
 *  or e-mail Ian McDonald - iam4@cs.waikato.ac.nz
 *
 *  This code also uses code from Lulea University, rereleased as GPL by its
 *  authors:
 *  Copyright (c) 2003 Nils-Erik Mattsson, Joacim Haggmark, Magnus Erixzon
 *
 *  Changes to meet Linux coding standards, to make it meet latest ccid3 draft
 *  and to make it work as a loadable module in the DCCP stack written by
 *  Arnaldo Carvalho de Melo <acme@conectiva.com.br>.
 *
 *  Copyright (c) 2005 Arnaldo Carvalho de Melo <acme@conectiva.com.br>
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2 of the License, or
 *  (at your option) any later version.
 *
 *  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., 675 Mass Ave, Cambridge, MA 02139, USA.
 */
#ifndef _DCCP_CCID3_H_
#define _DCCP_CCID3_H_

#include <linux/types.h>
#include <linux/list.h>
#include <linux/timer.h>

struct ccid3_tx_hist_entry {
	struct list_head	ccid3htx_node;
	u64			ccid3htx_seqno:48,
				ccid3htx_win_count:8,
				ccid3htx_sent:1;
	struct timeval		ccid3htx_tstamp;
};

struct ccid3_options_received {
	u64 ccid3or_seqno:48,
	    ccid3or_loss_intervals_idx:16;
	u16 ccid3or_loss_intervals_len;
	u32 ccid3or_loss_event_rate;
	u32 ccid3or_receive_rate;
};

/** struct ccid3_hc_tx_sock - CCID3 sender half connection congestion control block
 *
  * @ccid3hctx_state - Sender state
  * @ccid3hctx_x - Current sending rate
  * @ccid3hctx_x_recv - Receive rate
  * @ccid3hctx_x_calc - Calculated send (?) rate
  * @ccid3hctx_s - Packet size
  * @ccid3hctx_rtt - Estimate of current round trip time in usecs
  * @@ccid3hctx_p - Current loss event rate (0-1) scaled by 1000000
  * @ccid3hctx_last_win_count - Last window counter sent
  * @ccid3hctx_t_last_win_count - Timestamp of earliest packet with last_win_count value sent
  * @ccid3hctx_no_feedback_timer - Handle to no feedback timer
  * @ccid3hctx_idle - FIXME
  * @ccid3hctx_t_ld - Time last doubled during slow start
  * @ccid3hctx_t_nom - Nominal send time of next packet
  * @ccid3hctx_t_ipi - Interpacket (send) interval
  * @ccid3hctx_delta - Send timer delta
  * @ccid3hctx_hist - Packet history
  */
struct ccid3_hc_tx_sock {
	u32				ccid3hctx_x;
	u32				ccid3hctx_x_recv;
	u32				ccid3hctx_x_calc;
	u16				ccid3hctx_s;
	u32				ccid3hctx_rtt;
	u32				ccid3hctx_p;
  	u8				ccid3hctx_state;
	u8				ccid3hctx_last_win_count;
	u8				ccid3hctx_idle;
	struct timeval			ccid3hctx_t_last_win_count;
	struct timer_list		ccid3hctx_no_feedback_timer;
	struct timeval			ccid3hctx_t_ld;
	struct timeval			ccid3hctx_t_nom;
	u32				ccid3hctx_t_ipi;
	u32				ccid3hctx_delta;
	struct list_head		ccid3hctx_hist;
	struct ccid3_options_received	ccid3hctx_options_received;
};

struct ccid3_loss_interval_hist_entry {
	struct list_head	ccid3lih_node;
	u64			ccid3lih_seqno:48,
				ccid3lih_win_count:4;
	u32			ccid3lih_interval;
};

struct ccid3_rx_hist_entry {
	struct list_head	ccid3hrx_node;
	u64			ccid3hrx_seqno:48,
				ccid3hrx_win_count:4,
				ccid3hrx_type:4;
	u32			ccid3hrx_ndp; /* In fact it is from 8 to 24 bits */
	struct timeval		ccid3hrx_tstamp;
};

struct ccid3_hc_rx_sock {
  	u64			ccid3hcrx_seqno_last_counter:48,
				ccid3hcrx_state:8,
				ccid3hcrx_last_counter:4;
	unsigned long		ccid3hcrx_rtt;
  	u32			ccid3hcrx_p;
  	u32			ccid3hcrx_bytes_recv;
  	struct timeval		ccid3hcrx_tstamp_last_feedback;
  	struct timeval		ccid3hcrx_tstamp_last_ack;
	struct list_head	ccid3hcrx_hist;
	struct list_head	ccid3hcrx_loss_interval_hist;
  	u16			ccid3hcrx_s;
  	u32			ccid3hcrx_pinv;
  	u32			ccid3hcrx_elapsed_time;
  	u32			ccid3hcrx_x_recv;
};

#define ccid3_hc_tx_field(s,field) (s->dccps_hc_tx_ccid_private == NULL ? 0 : \
				    ((struct ccid3_hc_tx_sock *)s->dccps_hc_tx_ccid_private)->ccid3hctx_##field)

#define ccid3_hc_rx_field(s,field) (s->dccps_hc_rx_ccid_private == NULL ? 0 : \
				    ((struct ccid3_hc_rx_sock *)s->dccps_hc_rx_ccid_private)->ccid3hcrx_##field)

#endif /* _DCCP_CCID3_H_ */
Commit	Line	Data
7c657876 ACM	1	/*
	2	* net/dccp/ccids/ccid3.h
	3	*
	4	* Copyright (c) 2005 The University of Waikato, Hamilton, New Zealand.
	5	*
	6	* An implementation of the DCCP protocol
	7	*
	8	* This code has been developed by the University of Waikato WAND
	9	* research group. For further information please see http://www.wand.net.nz/
	10	* or e-mail Ian McDonald - iam4@cs.waikato.ac.nz
	11	*
	12	* This code also uses code from Lulea University, rereleased as GPL by its
	13	* authors:
	14	* Copyright (c) 2003 Nils-Erik Mattsson, Joacim Haggmark, Magnus Erixzon
	15	*
	16	* Changes to meet Linux coding standards, to make it meet latest ccid3 draft
	17	* and to make it work as a loadable module in the DCCP stack written by
	18	* Arnaldo Carvalho de Melo <acme@conectiva.com.br>.
	19	*
	20	* Copyright (c) 2005 Arnaldo Carvalho de Melo <acme@conectiva.com.br>
	21	*
	22	* This program is free software; you can redistribute it and/or modify
	23	* it under the terms of the GNU General Public License as published by
	24	* the Free Software Foundation; either version 2 of the License, or
	25	* (at your option) any later version.
	26	*
	27	* This program is distributed in the hope that it will be useful,
	28	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	29	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	30	* GNU General Public License for more details.
	31	*
	32	* You should have received a copy of the GNU General Public License
	33	* along with this program; if not, write to the Free Software
	34	* Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
	35	*/
	36	#ifndef _DCCP_CCID3_H_
	37	#define _DCCP_CCID3_H_
	38
	39	#include <linux/types.h>
	40	#include <linux/list.h>
	41	#include <linux/timer.h>
	42
	43	struct ccid3_tx_hist_entry {
	44	struct list_head ccid3htx_node;
	45	u64 ccid3htx_seqno:48,
	46	ccid3htx_win_count:8,
	47	ccid3htx_sent:1;
	48	struct timeval ccid3htx_tstamp;
	49	};
	50
	51	struct ccid3_options_received {
	52	u64 ccid3or_seqno:48,
	53	ccid3or_loss_intervals_idx:16;
	54	u16 ccid3or_loss_intervals_len;
	55	u32 ccid3or_loss_event_rate;
	56	u32 ccid3or_receive_rate;
	57	};
	58
	59	/** struct ccid3_hc_tx_sock - CCID3 sender half connection congestion control block
	60	*
	61	* @ccid3hctx_state - Sender state
	62	* @ccid3hctx_x - Current sending rate
	63	* @ccid3hctx_x_recv - Receive rate
	64	* @ccid3hctx_x_calc - Calculated send (?) rate
65	* @ccid3hctx_s - Packet size
66	* @ccid3hctx_rtt - Estimate of current round trip time in usecs
67	* @@ccid3hctx_p - Current loss event rate (0-1) scaled by 1000000
68	* @ccid3hctx_last_win_count - Last window counter sent
69	* @ccid3hctx_t_last_win_count - Timestamp of earliest packet with last_win_count value sent
70	* @ccid3hctx_no_feedback_timer - Handle to no feedback timer
71	* @ccid3hctx_idle - FIXME
72	* @ccid3hctx_t_ld - Time last doubled during slow start
73	* @ccid3hctx_t_nom - Nominal send time of next packet
74	* @ccid3hctx_t_ipi - Interpacket (send) interval
75	* @ccid3hctx_delta - Send timer delta
76	* @ccid3hctx_hist - Packet history
77	*/
78	struct ccid3_hc_tx_sock {
79	u32 ccid3hctx_x;
80	u32 ccid3hctx_x_recv;
81	u32 ccid3hctx_x_calc;
82	u16 ccid3hctx_s;
83	u32 ccid3hctx_rtt;
84	u32 ccid3hctx_p;
85	u8 ccid3hctx_state;
86	u8 ccid3hctx_last_win_count;
87	u8 ccid3hctx_idle;
88	struct timeval ccid3hctx_t_last_win_count;
89	struct timer_list ccid3hctx_no_feedback_timer;
90	struct timeval ccid3hctx_t_ld;
91	struct timeval ccid3hctx_t_nom;
92	u32 ccid3hctx_t_ipi;
93	u32 ccid3hctx_delta;
94	struct list_head ccid3hctx_hist;
95	struct ccid3_options_received ccid3hctx_options_received;
96	};
97
98	struct ccid3_loss_interval_hist_entry {
99	struct list_head ccid3lih_node;
100	u64 ccid3lih_seqno:48,
101	ccid3lih_win_count:4;
102	u32 ccid3lih_interval;
103	};
104
105	struct ccid3_rx_hist_entry {
106	struct list_head ccid3hrx_node;
107	u64 ccid3hrx_seqno:48,
108	ccid3hrx_win_count:4,
109	ccid3hrx_type:4;
110	u32 ccid3hrx_ndp; /* In fact it is from 8 to 24 bits */
111	struct timeval ccid3hrx_tstamp;
112	};
113
114	struct ccid3_hc_rx_sock {
115	u64 ccid3hcrx_seqno_last_counter:48,
116	ccid3hcrx_state:8,
117	ccid3hcrx_last_counter:4;
118	unsigned long ccid3hcrx_rtt;
119	u32 ccid3hcrx_p;
120	u32 ccid3hcrx_bytes_recv;
121	struct timeval ccid3hcrx_tstamp_last_feedback;
122	struct timeval ccid3hcrx_tstamp_last_ack;
123	struct list_head ccid3hcrx_hist;
124	struct list_head ccid3hcrx_loss_interval_hist;
125	u16 ccid3hcrx_s;
126	u32 ccid3hcrx_pinv;
127	u32 ccid3hcrx_elapsed_time;
128	u32 ccid3hcrx_x_recv;
129	};
130
131	#define ccid3_hc_tx_field(s,field) (s->dccps_hc_tx_ccid_private == NULL ? 0 : \
132	((struct ccid3_hc_tx_sock *)s->dccps_hc_tx_ccid_private)->ccid3hctx_##field)
133
134	#define ccid3_hc_rx_field(s,field) (s->dccps_hc_rx_ccid_private == NULL ? 0 : \
135	((struct ccid3_hc_rx_sock *)s->dccps_hc_rx_ccid_private)->ccid3hcrx_##field)
136
137	#endif /* _DCCP_CCID3_H_ */