blob: ae99ec430371bfefe91c72bfeafaebfd87ed8ad1 [file] [log] [blame]
Arnaldo Carvalho de Melo7c657872005-08-09 20:14:34 -07001/*
2 * net/dccp/ccids/ccid3.h
3 *
Ian McDonalde6bccd32006-08-26 19:01:30 -07004 * Copyright (c) 2005-6 The University of Waikato, Hamilton, New Zealand.
Arnaldo Carvalho de Melo7c657872005-08-09 20:14:34 -07005 *
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/
Ian McDonalde6bccd32006-08-26 19:01:30 -070010 * or e-mail Ian McDonald - ian.mcdonald@jandi.co.nz
Arnaldo Carvalho de Melo7c657872005-08-09 20:14:34 -070011 *
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
Gerrit Renker8132da42007-06-16 13:34:02 -030039#include <linux/ktime.h>
Arnaldo Carvalho de Melo7c657872005-08-09 20:14:34 -070040#include <linux/list.h>
Arnaldo Carvalho de Melocfc3c522005-08-27 20:20:37 -030041#include <linux/types.h>
Arnaldo Carvalho de Melo65299d62005-09-18 00:18:32 -070042#include <linux/tfrc.h>
Arnaldo Carvalho de Melo91f0ebf2006-03-20 19:21:44 -080043#include "../ccid.h"
Arnaldo Carvalho de Melocfc3c522005-08-27 20:20:37 -030044
Gerrit Renker48e03ee2006-11-27 20:29:27 -020045/* Two seconds as per RFC 3448 4.2 */
Arnaldo Carvalho de Melocfc3c522005-08-27 20:20:37 -030046#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
Gerrit Renkera79ef762006-11-28 19:51:42 -020051/* Parameter t_mbi from [RFC 3448, 4.3]: backoff interval in seconds */
52#define TFRC_T_MBI 64
Arnaldo Carvalho de Melocfc3c522005-08-27 20:20:37 -030053
Arnaldo Carvalho de Melocfc3c522005-08-27 20:20:37 -030054enum ccid3_options {
55 TFRC_OPT_LOSS_EVENT_RATE = 192,
56 TFRC_OPT_LOSS_INTERVALS = 193,
57 TFRC_OPT_RECEIVE_RATE = 194,
58};
Arnaldo Carvalho de Melo7c657872005-08-09 20:14:34 -070059
60struct ccid3_options_received {
61 u64 ccid3or_seqno:48,
62 ccid3or_loss_intervals_idx:16;
63 u16 ccid3or_loss_intervals_len;
64 u32 ccid3or_loss_event_rate;
65 u32 ccid3or_receive_rate;
66};
67
Gerrit Renker3c695262006-11-15 21:27:47 -020068/* TFRC sender states */
69enum ccid3_hc_tx_states {
Arnaldo Carvalho de Melo8109b022006-12-10 16:01:18 -020070 TFRC_SSTATE_NO_SENT = 1,
Gerrit Renker3c695262006-11-15 21:27:47 -020071 TFRC_SSTATE_NO_FBACK,
72 TFRC_SSTATE_FBACK,
73 TFRC_SSTATE_TERM,
74};
75
Gerrit Renker23ea8942006-11-20 18:40:42 -020076/** struct ccid3_hc_tx_sock - CCID3 sender half-connection socket
Arnaldo Carvalho de Melo7c657872005-08-09 20:14:34 -070077 *
Gerrit Renker1a21e492006-12-10 00:02:12 -020078 * @ccid3hctx_x - Current sending rate in 64 * bytes per second
79 * @ccid3hctx_x_recv - Receive rate in 64 * bytes per second
80 * @ccid3hctx_x_calc - Calculated rate in bytes per second
Gerrit Renker23ea8942006-11-20 18:40:42 -020081 * @ccid3hctx_rtt - Estimate of current round trip time in usecs
82 * @ccid3hctx_p - Current loss event rate (0-1) scaled by 1000000
Gerrit Renker1a21e492006-12-10 00:02:12 -020083 * @ccid3hctx_s - Packet size in bytes
84 * @ccid3hctx_t_rto - Nofeedback Timer setting in usecs
85 * @ccid3hctx_t_ipi - Interpacket (send) interval (RFC 3448, 4.6) in usecs
Gerrit Renker23ea8942006-11-20 18:40:42 -020086 * @ccid3hctx_state - Sender state, one of %ccid3_hc_tx_states
87 * @ccid3hctx_last_win_count - Last window counter sent
88 * @ccid3hctx_t_last_win_count - Timestamp of earliest packet
Arnaldo Carvalho de Melo8109b022006-12-10 16:01:18 -020089 * with last_win_count value sent
Gerrit Renker23ea8942006-11-20 18:40:42 -020090 * @ccid3hctx_no_feedback_timer - Handle to no feedback timer
91 * @ccid3hctx_idle - Flag indicating that sender is idling
92 * @ccid3hctx_t_ld - Time last doubled during slow start
93 * @ccid3hctx_t_nom - Nominal send time of next packet
Gerrit Renker1a21e492006-12-10 00:02:12 -020094 * @ccid3hctx_delta - Send timer delta (RFC 3448, 4.6) in usecs
Gerrit Renker23ea8942006-11-20 18:40:42 -020095 * @ccid3hctx_hist - Packet history
96 * @ccid3hctx_options_received - Parsed set of retrieved options
97 */
Arnaldo Carvalho de Melo7c657872005-08-09 20:14:34 -070098struct ccid3_hc_tx_sock {
Arnaldo Carvalho de Melo65299d62005-09-18 00:18:32 -070099 struct tfrc_tx_info ccid3hctx_tfrc;
100#define ccid3hctx_x ccid3hctx_tfrc.tfrctx_x
101#define ccid3hctx_x_recv ccid3hctx_tfrc.tfrctx_x_recv
102#define ccid3hctx_x_calc ccid3hctx_tfrc.tfrctx_x_calc
103#define ccid3hctx_rtt ccid3hctx_tfrc.tfrctx_rtt
104#define ccid3hctx_p ccid3hctx_tfrc.tfrctx_p
105#define ccid3hctx_t_rto ccid3hctx_tfrc.tfrctx_rto
106#define ccid3hctx_t_ipi ccid3hctx_tfrc.tfrctx_ipi
Arnaldo Carvalho de Melo7c657872005-08-09 20:14:34 -0700107 u16 ccid3hctx_s;
Arnaldo Carvalho de Melo8109b022006-12-10 16:01:18 -0200108 enum ccid3_hc_tx_states ccid3hctx_state:8;
Arnaldo Carvalho de Melo7c657872005-08-09 20:14:34 -0700109 u8 ccid3hctx_last_win_count;
110 u8 ccid3hctx_idle;
Gerrit Renker8132da42007-06-16 13:34:02 -0300111 ktime_t ccid3hctx_t_last_win_count;
Arnaldo Carvalho de Melo7c657872005-08-09 20:14:34 -0700112 struct timer_list ccid3hctx_no_feedback_timer;
Arnaldo Carvalho de Melo23f062a2007-08-19 17:14:52 -0700113 ktime_t ccid3hctx_t_ld;
Gerrit Renker8132da42007-06-16 13:34:02 -0300114 ktime_t ccid3hctx_t_nom;
Arnaldo Carvalho de Melo7c657872005-08-09 20:14:34 -0700115 u32 ccid3hctx_delta;
116 struct list_head ccid3hctx_hist;
117 struct ccid3_options_received ccid3hctx_options_received;
118};
119
Gerrit Renker2e869082007-09-26 11:24:28 -0300120static inline struct ccid3_hc_tx_sock *ccid3_hc_tx_sk(const struct sock *sk)
121{
122 struct ccid3_hc_tx_sock *hctx = ccid_priv(dccp_sk(sk)->dccps_hc_tx_ccid);
123#ifdef CONFIG_IP_DCCP_CCID3_DEBUG
124 BUG_ON(hctx == NULL);
125#endif
126 return hctx;
127}
128
Gerrit Renker3c695262006-11-15 21:27:47 -0200129/* TFRC receiver states */
130enum ccid3_hc_rx_states {
Arnaldo Carvalho de Melo8109b022006-12-10 16:01:18 -0200131 TFRC_RSTATE_NO_DATA = 1,
Gerrit Renker3c695262006-11-15 21:27:47 -0200132 TFRC_RSTATE_DATA,
133 TFRC_RSTATE_TERM = 127,
134};
135
Gerrit Renker23ea8942006-11-20 18:40:42 -0200136/** struct ccid3_hc_rx_sock - CCID3 receiver half-connection socket
137 *
138 * @ccid3hcrx_x_recv - Receiver estimate of send rate (RFC 3448 4.3)
139 * @ccid3hcrx_rtt - Receiver estimate of rtt (non-standard)
140 * @ccid3hcrx_p - current loss event rate (RFC 3448 5.4)
141 * @ccid3hcrx_seqno_nonloss - Last received non-loss sequence number
142 * @ccid3hcrx_ccval_nonloss - Last received non-loss Window CCVal
143 * @ccid3hcrx_ccval_last_counter - Tracks window counter (RFC 4342, 8.1)
144 * @ccid3hcrx_state - receiver state, one of %ccid3_hc_rx_states
145 * @ccid3hcrx_bytes_recv - Total sum of DCCP payload bytes
146 * @ccid3hcrx_tstamp_last_feedback - Time at which last feedback was sent
147 * @ccid3hcrx_tstamp_last_ack - Time at which last feedback was sent
148 * @ccid3hcrx_hist - Packet history
149 * @ccid3hcrx_li_hist - Loss Interval History
150 * @ccid3hcrx_s - Received packet size in bytes
151 * @ccid3hcrx_pinv - Inverse of Loss Event Rate (RFC 4342, sec. 8.5)
152 * @ccid3hcrx_elapsed_time - Time since packet reception
153 */
Arnaldo Carvalho de Melo7c657872005-08-09 20:14:34 -0700154struct ccid3_hc_rx_sock {
Gerrit Renker23ea8942006-11-20 18:40:42 -0200155 struct tfrc_rx_info ccid3hcrx_tfrc;
156#define ccid3hcrx_x_recv ccid3hcrx_tfrc.tfrcrx_x_recv
157#define ccid3hcrx_rtt ccid3hcrx_tfrc.tfrcrx_rtt
158#define ccid3hcrx_p ccid3hcrx_tfrc.tfrcrx_p
Arnaldo Carvalho de Melo8109b022006-12-10 16:01:18 -0200159 u64 ccid3hcrx_seqno_nonloss:48,
Gerrit Renker23ea8942006-11-20 18:40:42 -0200160 ccid3hcrx_ccval_nonloss:4,
161 ccid3hcrx_ccval_last_counter:4;
162 enum ccid3_hc_rx_states ccid3hcrx_state:8;
Arnaldo Carvalho de Melo8109b022006-12-10 16:01:18 -0200163 u32 ccid3hcrx_bytes_recv;
Arnaldo Carvalho de Meloe7a81c62007-08-19 17:15:37 -0700164 ktime_t ccid3hcrx_tstamp_last_feedback;
Arnaldo Carvalho de Melo1faf0a12007-08-19 17:15:13 -0700165 ktime_t ccid3hcrx_tstamp_last_ack;
Gerrit Renker23ea8942006-11-20 18:40:42 -0200166 struct list_head ccid3hcrx_hist;
167 struct list_head ccid3hcrx_li_hist;
Arnaldo Carvalho de Melo8109b022006-12-10 16:01:18 -0200168 u16 ccid3hcrx_s;
169 u32 ccid3hcrx_pinv;
170 u32 ccid3hcrx_elapsed_time;
Arnaldo Carvalho de Melo7c657872005-08-09 20:14:34 -0700171};
172
Arnaldo Carvalho de Melo59725dc2005-09-09 02:40:58 -0300173static inline struct ccid3_hc_rx_sock *ccid3_hc_rx_sk(const struct sock *sk)
174{
Gerrit Renker2e869082007-09-26 11:24:28 -0300175 struct ccid3_hc_rx_sock *hcrx = ccid_priv(dccp_sk(sk)->dccps_hc_rx_ccid);
176#ifdef CONFIG_IP_DCCP_CCID3_DEBUG
177 BUG_ON(hcrx == NULL);
178#endif
179 return hcrx;
Arnaldo Carvalho de Melo59725dc2005-09-09 02:40:58 -0300180}
Arnaldo Carvalho de Melo7c657872005-08-09 20:14:34 -0700181
Arnaldo Carvalho de Melo7c657872005-08-09 20:14:34 -0700182#endif /* _DCCP_CCID3_H_ */