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> |
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 | ||
a79ef76f GR |
51 | /* Parameter t_mbi from [RFC 3448, 4.3]: backoff interval in seconds */ |
52 | #define TFRC_T_MBI 64 | |
cfc3c525 | 53 | |
de553c18 GR |
54 | /* What we think is a reasonable upper limit on RTT values */ |
55 | #define CCID3_SANE_RTT_MAX (4 * USEC_PER_SEC) | |
56 | ||
57 | #define CCID3_RTT_SANITY_CHECK(rtt) do { \ | |
58 | if (rtt > CCID3_SANE_RTT_MAX) { \ | |
59 | DCCP_CRIT("RTT (%ld) too large, substituting %ld", \ | |
60 | rtt, CCID3_SANE_RTT_MAX); \ | |
61 | rtt = CCID3_SANE_RTT_MAX; \ | |
62 | } } while (0) | |
63 | ||
cfc3c525 ACM |
64 | enum ccid3_options { |
65 | TFRC_OPT_LOSS_EVENT_RATE = 192, | |
66 | TFRC_OPT_LOSS_INTERVALS = 193, | |
67 | TFRC_OPT_RECEIVE_RATE = 194, | |
68 | }; | |
7c657876 ACM |
69 | |
70 | struct ccid3_options_received { | |
71 | u64 ccid3or_seqno:48, | |
72 | ccid3or_loss_intervals_idx:16; | |
73 | u16 ccid3or_loss_intervals_len; | |
74 | u32 ccid3or_loss_event_rate; | |
75 | u32 ccid3or_receive_rate; | |
76 | }; | |
77 | ||
3c695262 GR |
78 | /* TFRC sender states */ |
79 | enum ccid3_hc_tx_states { | |
80 | TFRC_SSTATE_NO_SENT = 1, | |
81 | TFRC_SSTATE_NO_FBACK, | |
82 | TFRC_SSTATE_FBACK, | |
83 | TFRC_SSTATE_TERM, | |
84 | }; | |
85 | ||
23ea8945 | 86 | /** struct ccid3_hc_tx_sock - CCID3 sender half-connection socket |
7c657876 | 87 | * |
1a21e49a GR |
88 | * @ccid3hctx_x - Current sending rate in 64 * bytes per second |
89 | * @ccid3hctx_x_recv - Receive rate in 64 * bytes per second | |
90 | * @ccid3hctx_x_calc - Calculated rate in bytes per second | |
23ea8945 GR |
91 | * @ccid3hctx_rtt - Estimate of current round trip time in usecs |
92 | * @ccid3hctx_p - Current loss event rate (0-1) scaled by 1000000 | |
1a21e49a GR |
93 | * @ccid3hctx_s - Packet size in bytes |
94 | * @ccid3hctx_t_rto - Nofeedback Timer setting in usecs | |
95 | * @ccid3hctx_t_ipi - Interpacket (send) interval (RFC 3448, 4.6) in usecs | |
23ea8945 GR |
96 | * @ccid3hctx_state - Sender state, one of %ccid3_hc_tx_states |
97 | * @ccid3hctx_last_win_count - Last window counter sent | |
98 | * @ccid3hctx_t_last_win_count - Timestamp of earliest packet | |
99 | * with last_win_count value sent | |
100 | * @ccid3hctx_no_feedback_timer - Handle to no feedback timer | |
101 | * @ccid3hctx_idle - Flag indicating that sender is idling | |
102 | * @ccid3hctx_t_ld - Time last doubled during slow start | |
103 | * @ccid3hctx_t_nom - Nominal send time of next packet | |
1a21e49a | 104 | * @ccid3hctx_delta - Send timer delta (RFC 3448, 4.6) in usecs |
23ea8945 GR |
105 | * @ccid3hctx_hist - Packet history |
106 | * @ccid3hctx_options_received - Parsed set of retrieved options | |
107 | */ | |
7c657876 | 108 | struct ccid3_hc_tx_sock { |
65299d6c ACM |
109 | struct tfrc_tx_info ccid3hctx_tfrc; |
110 | #define ccid3hctx_x ccid3hctx_tfrc.tfrctx_x | |
111 | #define ccid3hctx_x_recv ccid3hctx_tfrc.tfrctx_x_recv | |
112 | #define ccid3hctx_x_calc ccid3hctx_tfrc.tfrctx_x_calc | |
113 | #define ccid3hctx_rtt ccid3hctx_tfrc.tfrctx_rtt | |
114 | #define ccid3hctx_p ccid3hctx_tfrc.tfrctx_p | |
115 | #define ccid3hctx_t_rto ccid3hctx_tfrc.tfrctx_rto | |
116 | #define ccid3hctx_t_ipi ccid3hctx_tfrc.tfrctx_ipi | |
7c657876 | 117 | u16 ccid3hctx_s; |
3c695262 | 118 | enum ccid3_hc_tx_states ccid3hctx_state:8; |
7c657876 ACM |
119 | u8 ccid3hctx_last_win_count; |
120 | u8 ccid3hctx_idle; | |
121 | struct timeval ccid3hctx_t_last_win_count; | |
122 | struct timer_list ccid3hctx_no_feedback_timer; | |
123 | struct timeval ccid3hctx_t_ld; | |
124 | struct timeval ccid3hctx_t_nom; | |
7c657876 ACM |
125 | u32 ccid3hctx_delta; |
126 | struct list_head ccid3hctx_hist; | |
127 | struct ccid3_options_received ccid3hctx_options_received; | |
128 | }; | |
129 | ||
3c695262 GR |
130 | /* TFRC receiver states */ |
131 | enum ccid3_hc_rx_states { | |
132 | TFRC_RSTATE_NO_DATA = 1, | |
133 | TFRC_RSTATE_DATA, | |
134 | TFRC_RSTATE_TERM = 127, | |
135 | }; | |
136 | ||
23ea8945 GR |
137 | /** struct ccid3_hc_rx_sock - CCID3 receiver half-connection socket |
138 | * | |
139 | * @ccid3hcrx_x_recv - Receiver estimate of send rate (RFC 3448 4.3) | |
140 | * @ccid3hcrx_rtt - Receiver estimate of rtt (non-standard) | |
141 | * @ccid3hcrx_p - current loss event rate (RFC 3448 5.4) | |
142 | * @ccid3hcrx_seqno_nonloss - Last received non-loss sequence number | |
143 | * @ccid3hcrx_ccval_nonloss - Last received non-loss Window CCVal | |
144 | * @ccid3hcrx_ccval_last_counter - Tracks window counter (RFC 4342, 8.1) | |
145 | * @ccid3hcrx_state - receiver state, one of %ccid3_hc_rx_states | |
146 | * @ccid3hcrx_bytes_recv - Total sum of DCCP payload bytes | |
147 | * @ccid3hcrx_tstamp_last_feedback - Time at which last feedback was sent | |
148 | * @ccid3hcrx_tstamp_last_ack - Time at which last feedback was sent | |
149 | * @ccid3hcrx_hist - Packet history | |
150 | * @ccid3hcrx_li_hist - Loss Interval History | |
151 | * @ccid3hcrx_s - Received packet size in bytes | |
152 | * @ccid3hcrx_pinv - Inverse of Loss Event Rate (RFC 4342, sec. 8.5) | |
153 | * @ccid3hcrx_elapsed_time - Time since packet reception | |
154 | */ | |
7c657876 | 155 | struct ccid3_hc_rx_sock { |
23ea8945 GR |
156 | struct tfrc_rx_info ccid3hcrx_tfrc; |
157 | #define ccid3hcrx_x_recv ccid3hcrx_tfrc.tfrcrx_x_recv | |
158 | #define ccid3hcrx_rtt ccid3hcrx_tfrc.tfrcrx_rtt | |
159 | #define ccid3hcrx_p ccid3hcrx_tfrc.tfrcrx_p | |
160 | u64 ccid3hcrx_seqno_nonloss:48, | |
161 | ccid3hcrx_ccval_nonloss:4, | |
162 | ccid3hcrx_ccval_last_counter:4; | |
163 | enum ccid3_hc_rx_states ccid3hcrx_state:8; | |
164 | u32 ccid3hcrx_bytes_recv; | |
165 | struct timeval ccid3hcrx_tstamp_last_feedback; | |
166 | struct timeval ccid3hcrx_tstamp_last_ack; | |
167 | struct list_head ccid3hcrx_hist; | |
168 | struct list_head ccid3hcrx_li_hist; | |
169 | u16 ccid3hcrx_s; | |
170 | u32 ccid3hcrx_pinv; | |
171 | u32 ccid3hcrx_elapsed_time; | |
7c657876 ACM |
172 | }; |
173 | ||
59725dc2 ACM |
174 | static inline struct ccid3_hc_tx_sock *ccid3_hc_tx_sk(const struct sock *sk) |
175 | { | |
91f0ebf7 | 176 | return ccid_priv(dccp_sk(sk)->dccps_hc_tx_ccid); |
59725dc2 | 177 | } |
7c657876 | 178 | |
59725dc2 ACM |
179 | static inline struct ccid3_hc_rx_sock *ccid3_hc_rx_sk(const struct sock *sk) |
180 | { | |
91f0ebf7 | 181 | return ccid_priv(dccp_sk(sk)->dccps_hc_rx_ccid); |
59725dc2 | 182 | } |
7c657876 ACM |
183 | |
184 | #endif /* _DCCP_CCID3_H_ */ |