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 /* Two seconds as per RFC 3448 4.2 */
46 #define TFRC_INITIAL_TIMEOUT (2 * USEC_PER_SEC)
48 /* In usecs - half the scheduling granularity as per RFC3448 4.6 */
49 #define TFRC_OPSYS_HALF_TIME_GRAN (USEC_PER_SEC / (2 * HZ))
52 #define TFRC_MAX_BACK_OFF_TIME 64
54 #define TFRC_SMALLEST_P 40
57 TFRC_OPT_LOSS_EVENT_RATE = 192,
58 TFRC_OPT_LOSS_INTERVALS = 193,
59 TFRC_OPT_RECEIVE_RATE = 194,
62 struct ccid3_options_received {
64 ccid3or_loss_intervals_idx:16;
65 u16 ccid3or_loss_intervals_len;
66 u32 ccid3or_loss_event_rate;
67 u32 ccid3or_receive_rate;
70 /* TFRC sender states */
71 enum ccid3_hc_tx_states {
72 TFRC_SSTATE_NO_SENT = 1,
78 /** struct ccid3_hc_tx_sock - CCID3 sender half-connection socket
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
100 struct ccid3_hc_tx_sock {
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
110 enum ccid3_hc_tx_states ccid3hctx_state:8;
111 u8 ccid3hctx_last_win_count;
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;
118 struct list_head ccid3hctx_hist;
119 struct ccid3_options_received ccid3hctx_options_received;
122 /* TFRC receiver states */
123 enum ccid3_hc_rx_states {
124 TFRC_RSTATE_NO_DATA = 1,
126 TFRC_RSTATE_TERM = 127,
129 /** struct ccid3_hc_rx_sock - CCID3 receiver half-connection socket
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
147 struct ccid3_hc_rx_sock {
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;
163 u32 ccid3hcrx_elapsed_time;
166 static inline struct ccid3_hc_tx_sock *ccid3_hc_tx_sk(const struct sock *sk)
168 return ccid_priv(dccp_sk(sk)->dccps_hc_tx_ccid);
171 static inline struct ccid3_hc_rx_sock *ccid3_hc_rx_sk(const struct sock *sk)
173 return ccid_priv(dccp_sk(sk)->dccps_hc_rx_ccid);
176 #endif /* _DCCP_CCID3_H_ */