Merge master.kernel.org:/pub/scm/linux/kernel/git/acme/net-2.6
[sfrench/cifs-2.6.git] / net / dccp / ccids / ccid3.h
1 /*
2  *  net/dccp/ccids/ccid3.h
3  *
4  *  Copyright (c) 2005 The University of Waikato, Hamilton, New Zealand.
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/
10  *  or e-mail Ian McDonald - iam4@cs.waikato.ac.nz
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
39 #include <linux/config.h>
40 #include <linux/list.h>
41 #include <linux/time.h>
42 #include <linux/types.h>
43
44 #define TFRC_MIN_PACKET_SIZE       16
45 #define TFRC_STD_PACKET_SIZE      256
46 #define TFRC_MAX_PACKET_SIZE    65535
47
48 /* Two seconds as per CCID3 spec */
49 #define TFRC_INITIAL_TIMEOUT       (2 * USEC_PER_SEC)
50
51 /* In usecs - half the scheduling granularity as per RFC3448 4.6 */
52 #define TFRC_OPSYS_HALF_TIME_GRAN  (USEC_PER_SEC / (2 * HZ))
53
54 /* In seconds */
55 #define TFRC_MAX_BACK_OFF_TIME     64
56
57 #define TFRC_SMALLEST_P            40
58
59 enum ccid3_options {
60         TFRC_OPT_LOSS_EVENT_RATE = 192,
61         TFRC_OPT_LOSS_INTERVALS  = 193,
62         TFRC_OPT_RECEIVE_RATE    = 194,
63 };
64
65 struct ccid3_options_received {
66         u64 ccid3or_seqno:48,
67             ccid3or_loss_intervals_idx:16;
68         u16 ccid3or_loss_intervals_len;
69         u32 ccid3or_loss_event_rate;
70         u32 ccid3or_receive_rate;
71 };
72
73 /** struct ccid3_hc_tx_sock - CCID3 sender half connection sock
74  *
75   * @ccid3hctx_state - Sender state
76   * @ccid3hctx_x - Current sending rate
77   * @ccid3hctx_x_recv - Receive rate
78   * @ccid3hctx_x_calc - Calculated send (?) rate
79   * @ccid3hctx_s - Packet size
80   * @ccid3hctx_rtt - Estimate of current round trip time in usecs
81   * @@ccid3hctx_p - Current loss event rate (0-1) scaled by 1000000
82   * @ccid3hctx_last_win_count - Last window counter sent
83   * @ccid3hctx_t_last_win_count - Timestamp of earliest packet
84   *                               with last_win_count value sent
85   * @ccid3hctx_no_feedback_timer - Handle to no feedback timer
86   * @ccid3hctx_idle - FIXME
87   * @ccid3hctx_t_ld - Time last doubled during slow start
88   * @ccid3hctx_t_nom - Nominal send time of next packet
89   * @ccid3hctx_t_ipi - Interpacket (send) interval
90   * @ccid3hctx_delta - Send timer delta
91   * @ccid3hctx_hist - Packet history
92   */
93 struct ccid3_hc_tx_sock {
94         u32                             ccid3hctx_x;
95         u32                             ccid3hctx_x_recv;
96         u32                             ccid3hctx_x_calc;
97         u16                             ccid3hctx_s;
98         u32                             ccid3hctx_rtt;
99         u32                             ccid3hctx_p;
100         u8                              ccid3hctx_state;
101         u8                              ccid3hctx_last_win_count;
102         u8                              ccid3hctx_idle;
103         struct timeval                  ccid3hctx_t_last_win_count;
104         struct timer_list               ccid3hctx_no_feedback_timer;
105         struct timeval                  ccid3hctx_t_ld;
106         struct timeval                  ccid3hctx_t_nom;
107         u32                             ccid3hctx_t_rto;
108         u32                             ccid3hctx_t_ipi;
109         u32                             ccid3hctx_delta;
110         struct list_head                ccid3hctx_hist;
111         struct ccid3_options_received   ccid3hctx_options_received;
112 };
113
114 struct ccid3_hc_rx_sock {
115         u64                     ccid3hcrx_seqno_last_counter:48,
116                                 ccid3hcrx_state:8,
117                                 ccid3hcrx_last_counter:4;
118         u32                     ccid3hcrx_rtt;
119         u32                     ccid3hcrx_p;
120         u32                     ccid3hcrx_bytes_recv;
121         struct timeval          ccid3hcrx_tstamp_last_feedback;
122         struct timeval          ccid3hcrx_tstamp_last_ack;
123         struct list_head        ccid3hcrx_hist;
124         struct list_head        ccid3hcrx_li_hist;
125         u16                     ccid3hcrx_s;
126         u32                     ccid3hcrx_pinv;
127         u32                     ccid3hcrx_elapsed_time;
128         u32                     ccid3hcrx_x_recv;
129 };
130
131 static inline struct ccid3_hc_tx_sock *ccid3_hc_tx_sk(const struct sock *sk)
132 {
133     return dccp_sk(sk)->dccps_hc_tx_ccid_private;
134 }
135
136 static inline struct ccid3_hc_rx_sock *ccid3_hc_rx_sk(const struct sock *sk)
137 {
138     return dccp_sk(sk)->dccps_hc_rx_ccid_private;
139 }
140
141 #endif /* _DCCP_CCID3_H_ */