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

/*
 *  net/dccp/ccids/ccid3.h
 *
 *  Copyright (c) 2005-6 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 - ian.mcdonald@jandi.co.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/list.h>
#include <linux/time.h>
#include <linux/types.h>
#include <linux/tfrc.h>
#include "../ccid.h"

/* Two seconds as per RFC 3448 4.2 */
#define TFRC_INITIAL_TIMEOUT	   (2 * USEC_PER_SEC)

/* In usecs - half the scheduling granularity as per RFC3448 4.6 */
#define TFRC_OPSYS_HALF_TIME_GRAN  (USEC_PER_SEC / (2 * HZ))

/* In seconds */
#define TFRC_MAX_BACK_OFF_TIME	   64

#define TFRC_SMALLEST_P		   40

enum ccid3_options {
	TFRC_OPT_LOSS_EVENT_RATE = 192,
	TFRC_OPT_LOSS_INTERVALS	 = 193,
	TFRC_OPT_RECEIVE_RATE	 = 194,
};

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;
};

/* TFRC sender states */
enum ccid3_hc_tx_states {
       	TFRC_SSTATE_NO_SENT = 1,
	TFRC_SSTATE_NO_FBACK,
	TFRC_SSTATE_FBACK,
	TFRC_SSTATE_TERM,
};

/** struct ccid3_hc_tx_sock - CCID3 sender half-connection socket
 *
 * @ccid3hctx_x - Current sending rate
 * @ccid3hctx_x_recv - Receive rate
 * @ccid3hctx_x_calc - Calculated send rate (RFC 3448, 3.1)
 * @ccid3hctx_rtt - Estimate of current round trip time in usecs
 * @ccid3hctx_p - Current loss event rate (0-1) scaled by 1000000
 * @ccid3hctx_s - Packet size
 * @ccid3hctx_t_rto - Retransmission Timeout (RFC 3448, 3.1)
 * @ccid3hctx_t_ipi - Interpacket (send) interval (RFC 3448, 4.6)
 * @ccid3hctx_state - Sender state, one of %ccid3_hc_tx_states
 * @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 - Flag indicating that sender is idling
 * @ccid3hctx_t_ld - Time last doubled during slow start
 * @ccid3hctx_t_nom - Nominal send time of next packet
 * @ccid3hctx_delta - Send timer delta
 * @ccid3hctx_hist - Packet history
 * @ccid3hctx_options_received - Parsed set of retrieved options
 */
struct ccid3_hc_tx_sock {
	struct tfrc_tx_info		ccid3hctx_tfrc;
#define ccid3hctx_x			ccid3hctx_tfrc.tfrctx_x
#define ccid3hctx_x_recv		ccid3hctx_tfrc.tfrctx_x_recv
#define ccid3hctx_x_calc		ccid3hctx_tfrc.tfrctx_x_calc
#define ccid3hctx_rtt			ccid3hctx_tfrc.tfrctx_rtt
#define ccid3hctx_p			ccid3hctx_tfrc.tfrctx_p
#define ccid3hctx_t_rto			ccid3hctx_tfrc.tfrctx_rto
#define ccid3hctx_t_ipi			ccid3hctx_tfrc.tfrctx_ipi
	u16				ccid3hctx_s;
  	enum ccid3_hc_tx_states 	ccid3hctx_state:8;
	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_delta;
	struct list_head		ccid3hctx_hist;
	struct ccid3_options_received	ccid3hctx_options_received;
};

/* TFRC receiver states */
enum ccid3_hc_rx_states {
       	TFRC_RSTATE_NO_DATA = 1,
	TFRC_RSTATE_DATA,
	TFRC_RSTATE_TERM    = 127,
};

/** struct ccid3_hc_rx_sock - CCID3 receiver half-connection socket
 *
 *  @ccid3hcrx_x_recv  -  Receiver estimate of send rate (RFC 3448 4.3)
 *  @ccid3hcrx_rtt  -  Receiver estimate of rtt (non-standard)
 *  @ccid3hcrx_p  -  current loss event rate (RFC 3448 5.4)
 *  @ccid3hcrx_seqno_nonloss  -  Last received non-loss sequence number
 *  @ccid3hcrx_ccval_nonloss  -  Last received non-loss Window CCVal
 *  @ccid3hcrx_ccval_last_counter  -  Tracks window counter (RFC 4342, 8.1)
 *  @ccid3hcrx_state  -  receiver state, one of %ccid3_hc_rx_states
 *  @ccid3hcrx_bytes_recv  -  Total sum of DCCP payload bytes
 *  @ccid3hcrx_tstamp_last_feedback  -  Time at which last feedback was sent
 *  @ccid3hcrx_tstamp_last_ack  -  Time at which last feedback was sent
 *  @ccid3hcrx_hist  -  Packet history
 *  @ccid3hcrx_li_hist  -  Loss Interval History
 *  @ccid3hcrx_s  -  Received packet size in bytes
 *  @ccid3hcrx_pinv  -  Inverse of Loss Event Rate (RFC 4342, sec. 8.5)
 *  @ccid3hcrx_elapsed_time  -  Time since packet reception
 */
struct ccid3_hc_rx_sock {
	struct tfrc_rx_info		ccid3hcrx_tfrc;
#define ccid3hcrx_x_recv		ccid3hcrx_tfrc.tfrcrx_x_recv
#define ccid3hcrx_rtt			ccid3hcrx_tfrc.tfrcrx_rtt
#define ccid3hcrx_p			ccid3hcrx_tfrc.tfrcrx_p
  	u64				ccid3hcrx_seqno_nonloss:48,
					ccid3hcrx_ccval_nonloss:4,
					ccid3hcrx_ccval_last_counter:4;
	enum ccid3_hc_rx_states		ccid3hcrx_state:8;
  	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_li_hist;
  	u16				ccid3hcrx_s;
  	u32				ccid3hcrx_pinv;
  	u32				ccid3hcrx_elapsed_time;
};

static inline struct ccid3_hc_tx_sock *ccid3_hc_tx_sk(const struct sock *sk)
{
    return ccid_priv(dccp_sk(sk)->dccps_hc_tx_ccid);
}

static inline struct ccid3_hc_rx_sock *ccid3_hc_rx_sk(const struct sock *sk)
{
    return ccid_priv(dccp_sk(sk)->dccps_hc_rx_ccid);
}

#endif /* _DCCP_CCID3_H_ */
Commit	Line	Data
7c657876 ACM	1	/*
	2	* net/dccp/ccids/ccid3.h
	3	*
e6bccd35	4	* Copyright (c) 2005-6 The University of Waikato, Hamilton, New Zealand.
7c657876 ACM	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/
e6bccd35	10	* or e-mail Ian McDonald - ian.mcdonald@jandi.co.nz
7c657876 ACM	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
7c657876	39	#include <linux/list.h>
cfc3c525 ACM	40	#include <linux/time.h>
cfc3c525 ACM	41	#include <linux/types.h>
65299d6c	42	#include <linux/tfrc.h>
91f0ebf7	43	#include "../ccid.h"
cfc3c525	44
48e03eee	45	/* Two seconds as per RFC 3448 4.2 */
cfc3c525 ACM	46	#define TFRC_INITIAL_TIMEOUT (2 * USEC_PER_SEC)
	47
	48	/* In usecs - half the scheduling granularity as per RFC3448 4.6 */
	49	#define TFRC_OPSYS_HALF_TIME_GRAN (USEC_PER_SEC / (2 * HZ))
	50
cfc3c525 ACM	51	/* In seconds */
	52	#define TFRC_MAX_BACK_OFF_TIME 64
	53
	54	#define TFRC_SMALLEST_P 40
	55
cfc3c525 ACM	56	enum ccid3_options {
	57	TFRC_OPT_LOSS_EVENT_RATE = 192,
	58	TFRC_OPT_LOSS_INTERVALS = 193,
	59	TFRC_OPT_RECEIVE_RATE = 194,
	60	};
7c657876 ACM	61
	62	struct ccid3_options_received {
	63	u64 ccid3or_seqno:48,
	64	ccid3or_loss_intervals_idx:16;
	65	u16 ccid3or_loss_intervals_len;
	66	u32 ccid3or_loss_event_rate;
	67	u32 ccid3or_receive_rate;
	68	};
	69
3c695262 GR	70	/* TFRC sender states */
	71	enum ccid3_hc_tx_states {
	72	TFRC_SSTATE_NO_SENT = 1,
	73	TFRC_SSTATE_NO_FBACK,
	74	TFRC_SSTATE_FBACK,
	75	TFRC_SSTATE_TERM,
	76	};
	77
23ea8945	78	/** struct ccid3_hc_tx_sock - CCID3 sender half-connection socket
7c657876	79	*
23ea8945 GR	80	* @ccid3hctx_x - Current sending rate
	81	* @ccid3hctx_x_recv - Receive rate
	82	* @ccid3hctx_x_calc - Calculated send rate (RFC 3448, 3.1)
	83	* @ccid3hctx_rtt - Estimate of current round trip time in usecs
	84	* @ccid3hctx_p - Current loss event rate (0-1) scaled by 1000000
	85	* @ccid3hctx_s - Packet size
	86	* @ccid3hctx_t_rto - Retransmission Timeout (RFC 3448, 3.1)
	87	* @ccid3hctx_t_ipi - Interpacket (send) interval (RFC 3448, 4.6)
	88	* @ccid3hctx_state - Sender state, one of %ccid3_hc_tx_states
	89	* @ccid3hctx_last_win_count - Last window counter sent
	90	* @ccid3hctx_t_last_win_count - Timestamp of earliest packet
	91	* with last_win_count value sent
	92	* @ccid3hctx_no_feedback_timer - Handle to no feedback timer
	93	* @ccid3hctx_idle - Flag indicating that sender is idling
	94	* @ccid3hctx_t_ld - Time last doubled during slow start
	95	* @ccid3hctx_t_nom - Nominal send time of next packet
	96	* @ccid3hctx_delta - Send timer delta
	97	* @ccid3hctx_hist - Packet history
	98	* @ccid3hctx_options_received - Parsed set of retrieved options
	99	*/
7c657876	100	struct ccid3_hc_tx_sock {
65299d6c ACM	101	struct tfrc_tx_info ccid3hctx_tfrc;
	102	#define ccid3hctx_x ccid3hctx_tfrc.tfrctx_x
	103	#define ccid3hctx_x_recv ccid3hctx_tfrc.tfrctx_x_recv
	104	#define ccid3hctx_x_calc ccid3hctx_tfrc.tfrctx_x_calc
	105	#define ccid3hctx_rtt ccid3hctx_tfrc.tfrctx_rtt
	106	#define ccid3hctx_p ccid3hctx_tfrc.tfrctx_p
	107	#define ccid3hctx_t_rto ccid3hctx_tfrc.tfrctx_rto
	108	#define ccid3hctx_t_ipi ccid3hctx_tfrc.tfrctx_ipi
7c657876	109	u16 ccid3hctx_s;
3c695262	110	enum ccid3_hc_tx_states ccid3hctx_state:8;
7c657876 ACM	111	u8 ccid3hctx_last_win_count;
	112	u8 ccid3hctx_idle;
	113	struct timeval ccid3hctx_t_last_win_count;
	114	struct timer_list ccid3hctx_no_feedback_timer;
	115	struct timeval ccid3hctx_t_ld;
	116	struct timeval ccid3hctx_t_nom;
7c657876 ACM	117	u32 ccid3hctx_delta;
	118	struct list_head ccid3hctx_hist;
	119	struct ccid3_options_received ccid3hctx_options_received;
	120	};
	121
3c695262 GR	122	/* TFRC receiver states */
	123	enum ccid3_hc_rx_states {
	124	TFRC_RSTATE_NO_DATA = 1,
	125	TFRC_RSTATE_DATA,
	126	TFRC_RSTATE_TERM = 127,
	127	};
	128
23ea8945 GR	129	/** struct ccid3_hc_rx_sock - CCID3 receiver half-connection socket
	130	*
	131	* @ccid3hcrx_x_recv - Receiver estimate of send rate (RFC 3448 4.3)
	132	* @ccid3hcrx_rtt - Receiver estimate of rtt (non-standard)
	133	* @ccid3hcrx_p - current loss event rate (RFC 3448 5.4)
	134	* @ccid3hcrx_seqno_nonloss - Last received non-loss sequence number
	135	* @ccid3hcrx_ccval_nonloss - Last received non-loss Window CCVal
	136	* @ccid3hcrx_ccval_last_counter - Tracks window counter (RFC 4342, 8.1)
	137	* @ccid3hcrx_state - receiver state, one of %ccid3_hc_rx_states
	138	* @ccid3hcrx_bytes_recv - Total sum of DCCP payload bytes
	139	* @ccid3hcrx_tstamp_last_feedback - Time at which last feedback was sent
	140	* @ccid3hcrx_tstamp_last_ack - Time at which last feedback was sent
	141	* @ccid3hcrx_hist - Packet history
	142	* @ccid3hcrx_li_hist - Loss Interval History
	143	* @ccid3hcrx_s - Received packet size in bytes
	144	* @ccid3hcrx_pinv - Inverse of Loss Event Rate (RFC 4342, sec. 8.5)
	145	* @ccid3hcrx_elapsed_time - Time since packet reception
	146	*/
7c657876	147	struct ccid3_hc_rx_sock {
23ea8945 GR	148	struct tfrc_rx_info ccid3hcrx_tfrc;
	149	#define ccid3hcrx_x_recv ccid3hcrx_tfrc.tfrcrx_x_recv
	150	#define ccid3hcrx_rtt ccid3hcrx_tfrc.tfrcrx_rtt
	151	#define ccid3hcrx_p ccid3hcrx_tfrc.tfrcrx_p
	152	u64 ccid3hcrx_seqno_nonloss:48,
	153	ccid3hcrx_ccval_nonloss:4,
	154	ccid3hcrx_ccval_last_counter:4;
	155	enum ccid3_hc_rx_states ccid3hcrx_state:8;
	156	u32 ccid3hcrx_bytes_recv;
	157	struct timeval ccid3hcrx_tstamp_last_feedback;
	158	struct timeval ccid3hcrx_tstamp_last_ack;
	159	struct list_head ccid3hcrx_hist;
	160	struct list_head ccid3hcrx_li_hist;
	161	u16 ccid3hcrx_s;
	162	u32 ccid3hcrx_pinv;
	163	u32 ccid3hcrx_elapsed_time;
7c657876 ACM	164	};
7c657876 ACM	165
59725dc2 ACM	166	static inline struct ccid3_hc_tx_sock ccid3_hc_tx_sk(const struct sock sk)
59725dc2 ACM	167	{
91f0ebf7	168	return ccid_priv(dccp_sk(sk)->dccps_hc_tx_ccid);
59725dc2	169	}
7c657876	170
59725dc2 ACM	171	static inline struct ccid3_hc_rx_sock ccid3_hc_rx_sk(const struct sock sk)
59725dc2 ACM	172	{
91f0ebf7	173	return ccid_priv(dccp_sk(sk)->dccps_hc_rx_ccid);
59725dc2	174	}
7c657876 ACM	175
7c657876 ACM	176	#endif /* _DCCP_CCID3_H_ */