5ade4f668b2258e66b5ce96b697903457deac153
[linux-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/list.h>
40 #include <linux/time.h>
41 #include <linux/types.h>
42 #include <linux/tfrc.h>
43 #include "../ccid.h"
44
45 #define TFRC_MIN_PACKET_SIZE       16
46 #define TFRC_STD_PACKET_SIZE      256
47 #define TFRC_MAX_PACKET_SIZE    65535
48
49 /* Two seconds as per CCID3 spec */
50 #define TFRC_INITIAL_TIMEOUT       (2 * USEC_PER_SEC)
51
52 #define TFRC_INITIAL_IPI           (USEC_PER_SEC / 4)
53
54 /* In usecs - half the scheduling granularity as per RFC3448 4.6 */
55 #define TFRC_OPSYS_HALF_TIME_GRAN  (USEC_PER_SEC / (2 * HZ))
56
57 /* In seconds */
58 #define TFRC_MAX_BACK_OFF_TIME     64
59
60 #define TFRC_SMALLEST_P            40
61
62 enum ccid3_options {
63         TFRC_OPT_LOSS_EVENT_RATE = 192,
64         TFRC_OPT_LOSS_INTERVALS  = 193,
65         TFRC_OPT_RECEIVE_RATE    = 194,
66 };
67
68 struct ccid3_options_received {
69         u64 ccid3or_seqno:48,
70             ccid3or_loss_intervals_idx:16;
71         u16 ccid3or_loss_intervals_len;
72         u32 ccid3or_loss_event_rate;
73         u32 ccid3or_receive_rate;
74 };
75
76 /** struct ccid3_hc_tx_sock - CCID3 sender half connection sock
77  *
78   * @ccid3hctx_state - Sender state
79   * @ccid3hctx_x - Current sending rate
80   * @ccid3hctx_x_recv - Receive rate
81   * @ccid3hctx_x_calc - Calculated send (?) rate
82   * @ccid3hctx_s - Packet size
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_last_win_count - Last window counter sent
86   * @ccid3hctx_t_last_win_count - Timestamp of earliest packet
87   *                               with last_win_count value sent
88   * @ccid3hctx_no_feedback_timer - Handle to no feedback timer
89   * @ccid3hctx_idle - FIXME
90   * @ccid3hctx_t_ld - Time last doubled during slow start
91   * @ccid3hctx_t_nom - Nominal send time of next packet
92   * @ccid3hctx_t_ipi - Interpacket (send) interval
93   * @ccid3hctx_delta - Send timer delta
94   * @ccid3hctx_hist - Packet history
95   */
96 struct ccid3_hc_tx_sock {
97         struct tfrc_tx_info             ccid3hctx_tfrc;
98 #define ccid3hctx_x                     ccid3hctx_tfrc.tfrctx_x
99 #define ccid3hctx_x_recv                ccid3hctx_tfrc.tfrctx_x_recv
100 #define ccid3hctx_x_calc                ccid3hctx_tfrc.tfrctx_x_calc
101 #define ccid3hctx_rtt                   ccid3hctx_tfrc.tfrctx_rtt
102 #define ccid3hctx_p                     ccid3hctx_tfrc.tfrctx_p
103 #define ccid3hctx_t_rto                 ccid3hctx_tfrc.tfrctx_rto
104 #define ccid3hctx_t_ipi                 ccid3hctx_tfrc.tfrctx_ipi
105         u16                             ccid3hctx_s;
106         u8                              ccid3hctx_state;
107         u8                              ccid3hctx_last_win_count;
108         u8                              ccid3hctx_idle;
109         struct timeval                  ccid3hctx_t_last_win_count;
110         struct timer_list               ccid3hctx_no_feedback_timer;
111         struct timeval                  ccid3hctx_t_ld;
112         struct timeval                  ccid3hctx_t_nom;
113         u32                             ccid3hctx_delta;
114         struct list_head                ccid3hctx_hist;
115         struct ccid3_options_received   ccid3hctx_options_received;
116 };
117
118 struct ccid3_hc_rx_sock {
119         struct tfrc_rx_info     ccid3hcrx_tfrc;
120 #define ccid3hcrx_x_recv        ccid3hcrx_tfrc.tfrcrx_x_recv
121 #define ccid3hcrx_rtt           ccid3hcrx_tfrc.tfrcrx_rtt
122 #define ccid3hcrx_p             ccid3hcrx_tfrc.tfrcrx_p
123         u64                     ccid3hcrx_seqno_last_counter:48,
124                                 ccid3hcrx_state:8,
125                                 ccid3hcrx_last_counter:4;
126         u32                     ccid3hcrx_bytes_recv;
127         struct timeval          ccid3hcrx_tstamp_last_feedback;
128         struct timeval          ccid3hcrx_tstamp_last_ack;
129         struct list_head        ccid3hcrx_hist;
130         struct list_head        ccid3hcrx_li_hist;
131         u16                     ccid3hcrx_s;
132         u32                     ccid3hcrx_pinv;
133         u32                     ccid3hcrx_elapsed_time;
134 };
135
136 static inline struct ccid3_hc_tx_sock *ccid3_hc_tx_sk(const struct sock *sk)
137 {
138     return ccid_priv(dccp_sk(sk)->dccps_hc_tx_ccid);
139 }
140
141 static inline struct ccid3_hc_rx_sock *ccid3_hc_rx_sk(const struct sock *sk)
142 {
143     return ccid_priv(dccp_sk(sk)->dccps_hc_rx_ccid);
144 }
145
146 #endif /* _DCCP_CCID3_H_ */