2 * net/dccp/ccids/ccid3.h
4 * Copyright (c) 2005-6 The University of Waikato, Hamilton, New Zealand.
6 * An implementation of the DCCP protocol
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 - ian.mcdonald@jandi.co.nz
12 * This code also uses code from Lulea University, rereleased as GPL by its
14 * Copyright (c) 2003 Nils-Erik Mattsson, Joacim Haggmark, Magnus Erixzon
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>.
20 * Copyright (c) 2005 Arnaldo Carvalho de Melo <acme@conectiva.com.br>
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.
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.
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.
36 #ifndef _DCCP_CCID3_H_
37 #define _DCCP_CCID3_H_
39 #include <linux/list.h>
40 #include <linux/time.h>
41 #include <linux/types.h>
42 #include <linux/tfrc.h>
45 #define TFRC_MIN_PACKET_SIZE 16
46 #define TFRC_STD_PACKET_SIZE 256
47 #define TFRC_MAX_PACKET_SIZE 65535
49 /* Two seconds as per CCID3 spec */
50 #define TFRC_INITIAL_TIMEOUT (2 * USEC_PER_SEC)
52 #define TFRC_INITIAL_IPI (USEC_PER_SEC / 4)
54 /* In usecs - half the scheduling granularity as per RFC3448 4.6 */
55 #define TFRC_OPSYS_HALF_TIME_GRAN (USEC_PER_SEC / (2 * HZ))
58 #define TFRC_MAX_BACK_OFF_TIME 64
60 #define TFRC_SMALLEST_P 40
63 TFRC_OPT_LOSS_EVENT_RATE = 192,
64 TFRC_OPT_LOSS_INTERVALS = 193,
65 TFRC_OPT_RECEIVE_RATE = 194,
68 struct ccid3_options_received {
70 ccid3or_loss_intervals_idx:16;
71 u16 ccid3or_loss_intervals_len;
72 u32 ccid3or_loss_event_rate;
73 u32 ccid3or_receive_rate;
76 /* TFRC sender states */
77 enum ccid3_hc_tx_states {
78 TFRC_SSTATE_NO_SENT = 1,
84 /** struct ccid3_hc_tx_sock - CCID3 sender half connection sock
86 * @ccid3hctx_state - Sender state
87 * @ccid3hctx_x - Current sending rate
88 * @ccid3hctx_x_recv - Receive rate
89 * @ccid3hctx_x_calc - Calculated send (?) rate
90 * @ccid3hctx_s - Packet size
91 * @ccid3hctx_rtt - Estimate of current round trip time in usecs
92 * @@ccid3hctx_p - Current loss event rate (0-1) scaled by 1000000
93 * @ccid3hctx_last_win_count - Last window counter sent
94 * @ccid3hctx_t_last_win_count - Timestamp of earliest packet
95 * with last_win_count value sent
96 * @ccid3hctx_no_feedback_timer - Handle to no feedback timer
97 * @ccid3hctx_idle - FIXME
98 * @ccid3hctx_t_ld - Time last doubled during slow start
99 * @ccid3hctx_t_nom - Nominal send time of next packet
100 * @ccid3hctx_t_ipi - Interpacket (send) interval
101 * @ccid3hctx_delta - Send timer delta
102 * @ccid3hctx_hist - Packet history
104 struct ccid3_hc_tx_sock {
105 struct tfrc_tx_info ccid3hctx_tfrc;
106 #define ccid3hctx_x ccid3hctx_tfrc.tfrctx_x
107 #define ccid3hctx_x_recv ccid3hctx_tfrc.tfrctx_x_recv
108 #define ccid3hctx_x_calc ccid3hctx_tfrc.tfrctx_x_calc
109 #define ccid3hctx_rtt ccid3hctx_tfrc.tfrctx_rtt
110 #define ccid3hctx_p ccid3hctx_tfrc.tfrctx_p
111 #define ccid3hctx_t_rto ccid3hctx_tfrc.tfrctx_rto
112 #define ccid3hctx_t_ipi ccid3hctx_tfrc.tfrctx_ipi
114 enum ccid3_hc_tx_states ccid3hctx_state:8;
115 u8 ccid3hctx_last_win_count;
117 struct timeval ccid3hctx_t_last_win_count;
118 struct timer_list ccid3hctx_no_feedback_timer;
119 struct timeval ccid3hctx_t_ld;
120 struct timeval ccid3hctx_t_nom;
122 struct list_head ccid3hctx_hist;
123 struct ccid3_options_received ccid3hctx_options_received;
126 /* TFRC receiver states */
127 enum ccid3_hc_rx_states {
128 TFRC_RSTATE_NO_DATA = 1,
130 TFRC_RSTATE_TERM = 127,
133 struct ccid3_hc_rx_sock {
134 struct tfrc_rx_info ccid3hcrx_tfrc;
135 #define ccid3hcrx_x_recv ccid3hcrx_tfrc.tfrcrx_x_recv
136 #define ccid3hcrx_rtt ccid3hcrx_tfrc.tfrcrx_rtt
137 #define ccid3hcrx_p ccid3hcrx_tfrc.tfrcrx_p
138 u64 ccid3hcrx_seqno_nonloss:48,
139 ccid3hcrx_ccval_nonloss:4,
140 ccid3hcrx_ccval_last_counter:4;
141 enum ccid3_hc_rx_states ccid3hcrx_state:8;
142 u32 ccid3hcrx_bytes_recv;
143 struct timeval ccid3hcrx_tstamp_last_feedback;
144 struct timeval ccid3hcrx_tstamp_last_ack;
145 struct list_head ccid3hcrx_hist;
146 struct list_head ccid3hcrx_li_hist;
149 u32 ccid3hcrx_elapsed_time;
152 static inline struct ccid3_hc_tx_sock *ccid3_hc_tx_sk(const struct sock *sk)
154 return ccid_priv(dccp_sk(sk)->dccps_hc_tx_ccid);
157 static inline struct ccid3_hc_rx_sock *ccid3_hc_rx_sk(const struct sock *sk)
159 return ccid_priv(dccp_sk(sk)->dccps_hc_rx_ccid);
162 #endif /* _DCCP_CCID3_H_ */