[TFRC]: Migrate TX history to singly-linked lis
[safe/jmp/linux-2.6] / net / dccp / ccids / ccid3.c
1 /*
2  *  net/dccp/ccids/ccid3.c
3  *
4  *  Copyright (c) 2005-7 The University of Waikato, Hamilton, New Zealand.
5  *  Copyright (c) 2005-7 Ian McDonald <ian.mcdonald@jandi.co.nz>
6  *
7  *  An implementation of the DCCP protocol
8  *
9  *  This code has been developed by the University of Waikato WAND
10  *  research group. For further information please see http://www.wand.net.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 #include "../ccid.h"
37 #include "../dccp.h"
38 #include "lib/packet_history.h"
39 #include "lib/loss_interval.h"
40 #include "lib/tfrc.h"
41 #include "ccid3.h"
42
43 #include <asm/unaligned.h>
44
45 #ifdef CONFIG_IP_DCCP_CCID3_DEBUG
46 static int ccid3_debug;
47 #define ccid3_pr_debug(format, a...)    DCCP_PR_DEBUG(ccid3_debug, format, ##a)
48 #else
49 #define ccid3_pr_debug(format, a...)
50 #endif
51
52 static struct dccp_rx_hist *ccid3_rx_hist;
53
54 /*
55  *      Transmitter Half-Connection Routines
56  */
57 #ifdef CONFIG_IP_DCCP_CCID3_DEBUG
58 static const char *ccid3_tx_state_name(enum ccid3_hc_tx_states state)
59 {
60         static char *ccid3_state_names[] = {
61         [TFRC_SSTATE_NO_SENT]  = "NO_SENT",
62         [TFRC_SSTATE_NO_FBACK] = "NO_FBACK",
63         [TFRC_SSTATE_FBACK]    = "FBACK",
64         [TFRC_SSTATE_TERM]     = "TERM",
65         };
66
67         return ccid3_state_names[state];
68 }
69 #endif
70
71 static void ccid3_hc_tx_set_state(struct sock *sk,
72                                   enum ccid3_hc_tx_states state)
73 {
74         struct ccid3_hc_tx_sock *hctx = ccid3_hc_tx_sk(sk);
75         enum ccid3_hc_tx_states oldstate = hctx->ccid3hctx_state;
76
77         ccid3_pr_debug("%s(%p) %-8.8s -> %s\n",
78                        dccp_role(sk), sk, ccid3_tx_state_name(oldstate),
79                        ccid3_tx_state_name(state));
80         WARN_ON(state == oldstate);
81         hctx->ccid3hctx_state = state;
82 }
83
84 /*
85  * Compute the initial sending rate X_init in the manner of RFC 3390:
86  *
87  *      X_init  =  min(4 * s, max(2 * s, 4380 bytes)) / RTT
88  *
89  * Note that RFC 3390 uses MSS, RFC 4342 refers to RFC 3390, and rfc3448bis
90  * (rev-02) clarifies the use of RFC 3390 with regard to the above formula.
91  * For consistency with other parts of the code, X_init is scaled by 2^6.
92  */
93 static inline u64 rfc3390_initial_rate(struct sock *sk)
94 {
95         const struct ccid3_hc_tx_sock *hctx = ccid3_hc_tx_sk(sk);
96         const __u32 w_init = min_t(__u32, 4 * hctx->ccid3hctx_s,
97                                    max_t(__u32, 2 * hctx->ccid3hctx_s, 4380));
98
99         return scaled_div(w_init << 6, hctx->ccid3hctx_rtt);
100 }
101
102 /*
103  * Recalculate t_ipi and delta (should be called whenever X changes)
104  */
105 static inline void ccid3_update_send_interval(struct ccid3_hc_tx_sock *hctx)
106 {
107         /* Calculate new t_ipi = s / X_inst (X_inst is in 64 * bytes/second) */
108         hctx->ccid3hctx_t_ipi = scaled_div32(((u64)hctx->ccid3hctx_s) << 6,
109                                              hctx->ccid3hctx_x);
110
111         /* Calculate new delta by delta = min(t_ipi / 2, t_gran / 2) */
112         hctx->ccid3hctx_delta = min_t(u32, hctx->ccid3hctx_t_ipi / 2,
113                                            TFRC_OPSYS_HALF_TIME_GRAN);
114
115         ccid3_pr_debug("t_ipi=%u, delta=%u, s=%u, X=%u\n",
116                        hctx->ccid3hctx_t_ipi, hctx->ccid3hctx_delta,
117                        hctx->ccid3hctx_s, (unsigned)(hctx->ccid3hctx_x >> 6));
118
119 }
120
121 static u32 ccid3_hc_tx_idle_rtt(struct ccid3_hc_tx_sock *hctx, ktime_t now)
122 {
123         u32 delta = ktime_us_delta(now, hctx->ccid3hctx_t_last_win_count);
124
125         return delta / hctx->ccid3hctx_rtt;
126 }
127
128 /**
129  * ccid3_hc_tx_update_x  -  Update allowed sending rate X
130  * @stamp: most recent time if available - can be left NULL.
131  * This function tracks draft rfc3448bis, check there for latest details.
132  *
133  * Note: X and X_recv are both stored in units of 64 * bytes/second, to support
134  *       fine-grained resolution of sending rates. This requires scaling by 2^6
135  *       throughout the code. Only X_calc is unscaled (in bytes/second).
136  *
137  */
138 static void ccid3_hc_tx_update_x(struct sock *sk, ktime_t *stamp)
139
140 {
141         struct ccid3_hc_tx_sock *hctx = ccid3_hc_tx_sk(sk);
142         __u64 min_rate = 2 * hctx->ccid3hctx_x_recv;
143         const  __u64 old_x = hctx->ccid3hctx_x;
144         ktime_t now = stamp? *stamp : ktime_get_real();
145
146         /*
147          * Handle IDLE periods: do not reduce below RFC3390 initial sending rate
148          * when idling [RFC 4342, 5.1]. Definition of idling is from rfc3448bis:
149          * a sender is idle if it has not sent anything over a 2-RTT-period.
150          * For consistency with X and X_recv, min_rate is also scaled by 2^6.
151          */
152         if (ccid3_hc_tx_idle_rtt(hctx, now) >= 2) {
153                 min_rate = rfc3390_initial_rate(sk);
154                 min_rate = max(min_rate, 2 * hctx->ccid3hctx_x_recv);
155         }
156
157         if (hctx->ccid3hctx_p > 0) {
158
159                 hctx->ccid3hctx_x = min(((__u64)hctx->ccid3hctx_x_calc) << 6,
160                                         min_rate);
161                 hctx->ccid3hctx_x = max(hctx->ccid3hctx_x,
162                                         (((__u64)hctx->ccid3hctx_s) << 6) /
163                                                                 TFRC_T_MBI);
164
165         } else if (ktime_us_delta(now, hctx->ccid3hctx_t_ld)
166                                 - (s64)hctx->ccid3hctx_rtt >= 0) {
167
168                 hctx->ccid3hctx_x =
169                         max(min(2 * hctx->ccid3hctx_x, min_rate),
170                             scaled_div(((__u64)hctx->ccid3hctx_s) << 6,
171                                        hctx->ccid3hctx_rtt));
172                 hctx->ccid3hctx_t_ld = now;
173         }
174
175         if (hctx->ccid3hctx_x != old_x) {
176                 ccid3_pr_debug("X_prev=%u, X_now=%u, X_calc=%u, "
177                                "X_recv=%u\n", (unsigned)(old_x >> 6),
178                                (unsigned)(hctx->ccid3hctx_x >> 6),
179                                hctx->ccid3hctx_x_calc,
180                                (unsigned)(hctx->ccid3hctx_x_recv >> 6));
181
182                 ccid3_update_send_interval(hctx);
183         }
184 }
185
186 /*
187  *      Track the mean packet size `s' (cf. RFC 4342, 5.3 and  RFC 3448, 4.1)
188  *      @len: DCCP packet payload size in bytes
189  */
190 static inline void ccid3_hc_tx_update_s(struct ccid3_hc_tx_sock *hctx, int len)
191 {
192         const u16 old_s = hctx->ccid3hctx_s;
193
194         hctx->ccid3hctx_s = tfrc_ewma(hctx->ccid3hctx_s, len, 9);
195
196         if (hctx->ccid3hctx_s != old_s)
197                 ccid3_update_send_interval(hctx);
198 }
199
200 /*
201  *      Update Window Counter using the algorithm from [RFC 4342, 8.1].
202  *      The algorithm is not applicable if RTT < 4 microseconds.
203  */
204 static inline void ccid3_hc_tx_update_win_count(struct ccid3_hc_tx_sock *hctx,
205                                                 ktime_t now)
206 {
207         u32 quarter_rtts;
208
209         if (unlikely(hctx->ccid3hctx_rtt < 4))  /* avoid divide-by-zero */
210                 return;
211
212         quarter_rtts = ktime_us_delta(now, hctx->ccid3hctx_t_last_win_count);
213         quarter_rtts /= hctx->ccid3hctx_rtt / 4;
214
215         if (quarter_rtts > 0) {
216                 hctx->ccid3hctx_t_last_win_count = now;
217                 hctx->ccid3hctx_last_win_count  += min_t(u32, quarter_rtts, 5);
218                 hctx->ccid3hctx_last_win_count  &= 0xF;         /* mod 16 */
219         }
220 }
221
222 static void ccid3_hc_tx_no_feedback_timer(unsigned long data)
223 {
224         struct sock *sk = (struct sock *)data;
225         struct ccid3_hc_tx_sock *hctx = ccid3_hc_tx_sk(sk);
226         unsigned long t_nfb = USEC_PER_SEC / 5;
227
228         bh_lock_sock(sk);
229         if (sock_owned_by_user(sk)) {
230                 /* Try again later. */
231                 /* XXX: set some sensible MIB */
232                 goto restart_timer;
233         }
234
235         ccid3_pr_debug("%s(%p, state=%s) - entry \n", dccp_role(sk), sk,
236                        ccid3_tx_state_name(hctx->ccid3hctx_state));
237
238         switch (hctx->ccid3hctx_state) {
239         case TFRC_SSTATE_NO_FBACK:
240                 /* RFC 3448, 4.4: Halve send rate directly */
241                 hctx->ccid3hctx_x = max(hctx->ccid3hctx_x / 2,
242                                         (((__u64)hctx->ccid3hctx_s) << 6) /
243                                                                     TFRC_T_MBI);
244
245                 ccid3_pr_debug("%s(%p, state=%s), updated tx rate to %u "
246                                "bytes/s\n", dccp_role(sk), sk,
247                                ccid3_tx_state_name(hctx->ccid3hctx_state),
248                                (unsigned)(hctx->ccid3hctx_x >> 6));
249                 /* The value of R is still undefined and so we can not recompute
250                  * the timeout value. Keep initial value as per [RFC 4342, 5]. */
251                 t_nfb = TFRC_INITIAL_TIMEOUT;
252                 ccid3_update_send_interval(hctx);
253                 break;
254         case TFRC_SSTATE_FBACK:
255                 /*
256                  *  Modify the cached value of X_recv [RFC 3448, 4.4]
257                  *
258                  *  If (p == 0 || X_calc > 2 * X_recv)
259                  *    X_recv = max(X_recv / 2, s / (2 * t_mbi));
260                  *  Else
261                  *    X_recv = X_calc / 4;
262                  *
263                  *  Note that X_recv is scaled by 2^6 while X_calc is not
264                  */
265                 BUG_ON(hctx->ccid3hctx_p && !hctx->ccid3hctx_x_calc);
266
267                 if (hctx->ccid3hctx_p == 0 ||
268                     (hctx->ccid3hctx_x_calc > (hctx->ccid3hctx_x_recv >> 5))) {
269
270                         hctx->ccid3hctx_x_recv =
271                                 max(hctx->ccid3hctx_x_recv / 2,
272                                     (((__u64)hctx->ccid3hctx_s) << 6) /
273                                                               (2 * TFRC_T_MBI));
274                 } else {
275                         hctx->ccid3hctx_x_recv = hctx->ccid3hctx_x_calc;
276                         hctx->ccid3hctx_x_recv <<= 4;
277                 }
278                 /* Now recalculate X [RFC 3448, 4.3, step (4)] */
279                 ccid3_hc_tx_update_x(sk, NULL);
280                 /*
281                  * Schedule no feedback timer to expire in
282                  * max(t_RTO, 2 * s/X)  =  max(t_RTO, 2 * t_ipi)
283                  * See comments in packet_recv() regarding the value of t_RTO.
284                  */
285                 t_nfb = max(hctx->ccid3hctx_t_rto, 2 * hctx->ccid3hctx_t_ipi);
286                 break;
287         case TFRC_SSTATE_NO_SENT:
288                 DCCP_BUG("%s(%p) - Illegal state NO_SENT", dccp_role(sk), sk);
289                 /* fall through */
290         case TFRC_SSTATE_TERM:
291                 goto out;
292         }
293
294 restart_timer:
295         sk_reset_timer(sk, &hctx->ccid3hctx_no_feedback_timer,
296                            jiffies + usecs_to_jiffies(t_nfb));
297 out:
298         bh_unlock_sock(sk);
299         sock_put(sk);
300 }
301
302 /*
303  * returns
304  *   > 0: delay (in msecs) that should pass before actually sending
305  *   = 0: can send immediately
306  *   < 0: error condition; do not send packet
307  */
308 static int ccid3_hc_tx_send_packet(struct sock *sk, struct sk_buff *skb)
309 {
310         struct dccp_sock *dp = dccp_sk(sk);
311         struct ccid3_hc_tx_sock *hctx = ccid3_hc_tx_sk(sk);
312         ktime_t now = ktime_get_real();
313         s64 delay;
314
315         /*
316          * This function is called only for Data and DataAck packets. Sending
317          * zero-sized Data(Ack)s is theoretically possible, but for congestion
318          * control this case is pathological - ignore it.
319          */
320         if (unlikely(skb->len == 0))
321                 return -EBADMSG;
322
323         switch (hctx->ccid3hctx_state) {
324         case TFRC_SSTATE_NO_SENT:
325                 sk_reset_timer(sk, &hctx->ccid3hctx_no_feedback_timer,
326                                (jiffies +
327                                 usecs_to_jiffies(TFRC_INITIAL_TIMEOUT)));
328                 hctx->ccid3hctx_last_win_count   = 0;
329                 hctx->ccid3hctx_t_last_win_count = now;
330
331                 /* Set t_0 for initial packet */
332                 hctx->ccid3hctx_t_nom = now;
333
334                 hctx->ccid3hctx_s = skb->len;
335
336                 /*
337                  * Use initial RTT sample when available: recommended by erratum
338                  * to RFC 4342. This implements the initialisation procedure of
339                  * draft rfc3448bis, section 4.2. Remember, X is scaled by 2^6.
340                  */
341                 if (dp->dccps_syn_rtt) {
342                         ccid3_pr_debug("SYN RTT = %uus\n", dp->dccps_syn_rtt);
343                         hctx->ccid3hctx_rtt  = dp->dccps_syn_rtt;
344                         hctx->ccid3hctx_x    = rfc3390_initial_rate(sk);
345                         hctx->ccid3hctx_t_ld = now;
346                 } else {
347                         /* Sender does not have RTT sample: X_pps = 1 pkt/sec */
348                         hctx->ccid3hctx_x = hctx->ccid3hctx_s;
349                         hctx->ccid3hctx_x <<= 6;
350                 }
351                 ccid3_update_send_interval(hctx);
352
353                 ccid3_hc_tx_set_state(sk, TFRC_SSTATE_NO_FBACK);
354                 break;
355         case TFRC_SSTATE_NO_FBACK:
356         case TFRC_SSTATE_FBACK:
357                 delay = ktime_us_delta(hctx->ccid3hctx_t_nom, now);
358                 ccid3_pr_debug("delay=%ld\n", (long)delay);
359                 /*
360                  *      Scheduling of packet transmissions [RFC 3448, 4.6]
361                  *
362                  * if (t_now > t_nom - delta)
363                  *       // send the packet now
364                  * else
365                  *       // send the packet in (t_nom - t_now) milliseconds.
366                  */
367                 if (delay - (s64)hctx->ccid3hctx_delta >= 1000)
368                         return (u32)delay / 1000L;
369
370                 ccid3_hc_tx_update_win_count(hctx, now);
371                 break;
372         case TFRC_SSTATE_TERM:
373                 DCCP_BUG("%s(%p) - Illegal state TERM", dccp_role(sk), sk);
374                 return -EINVAL;
375         }
376
377         /* prepare to send now (add options etc.) */
378         dp->dccps_hc_tx_insert_options = 1;
379         DCCP_SKB_CB(skb)->dccpd_ccval = hctx->ccid3hctx_last_win_count;
380
381         /* set the nominal send time for the next following packet */
382         hctx->ccid3hctx_t_nom = ktime_add_us(hctx->ccid3hctx_t_nom,
383                                              hctx->ccid3hctx_t_ipi);
384         return 0;
385 }
386
387 static void ccid3_hc_tx_packet_sent(struct sock *sk, int more,
388                                     unsigned int len)
389 {
390         struct ccid3_hc_tx_sock *hctx = ccid3_hc_tx_sk(sk);
391
392         ccid3_hc_tx_update_s(hctx, len);
393
394         if (tfrc_tx_hist_add(&hctx->ccid3hctx_hist, dccp_sk(sk)->dccps_gss))
395                 DCCP_CRIT("packet history - out of memory!");
396 }
397
398 static void ccid3_hc_tx_packet_recv(struct sock *sk, struct sk_buff *skb)
399 {
400         struct ccid3_hc_tx_sock *hctx = ccid3_hc_tx_sk(sk);
401         struct ccid3_options_received *opt_recv;
402         struct tfrc_tx_hist_entry *packet;
403         ktime_t now;
404         unsigned long t_nfb;
405         u32 pinv, r_sample;
406
407         /* we are only interested in ACKs */
408         if (!(DCCP_SKB_CB(skb)->dccpd_type == DCCP_PKT_ACK ||
409               DCCP_SKB_CB(skb)->dccpd_type == DCCP_PKT_DATAACK))
410                 return;
411
412         opt_recv = &hctx->ccid3hctx_options_received;
413
414         switch (hctx->ccid3hctx_state) {
415         case TFRC_SSTATE_NO_FBACK:
416         case TFRC_SSTATE_FBACK:
417                 /* estimate RTT from history if ACK number is valid */
418                 packet = tfrc_tx_hist_find_entry(hctx->ccid3hctx_hist,
419                                                  DCCP_SKB_CB(skb)->dccpd_ack_seq);
420                 if (packet == NULL) {
421                         DCCP_WARN("%s(%p): %s with bogus ACK-%llu\n", dccp_role(sk), sk,
422                                   dccp_packet_name(DCCP_SKB_CB(skb)->dccpd_type),
423                                   (unsigned long long)DCCP_SKB_CB(skb)->dccpd_ack_seq);
424                         return;
425                 }
426                 /*
427                  * Garbage-collect older (irrelevant) entries
428                  */
429                 tfrc_tx_hist_purge(&packet->next);
430
431                 /* Update receive rate in units of 64 * bytes/second */
432                 hctx->ccid3hctx_x_recv = opt_recv->ccid3or_receive_rate;
433                 hctx->ccid3hctx_x_recv <<= 6;
434
435                 /* Update loss event rate */
436                 pinv = opt_recv->ccid3or_loss_event_rate;
437                 if (pinv == ~0U || pinv == 0)          /* see RFC 4342, 8.5   */
438                         hctx->ccid3hctx_p = 0;
439                 else                                   /* can not exceed 100% */
440                         hctx->ccid3hctx_p = 1000000 / pinv;
441
442                 now = ktime_get_real();
443                 /*
444                  * Calculate new RTT sample and update moving average
445                  */
446                 r_sample = dccp_sample_rtt(sk, ktime_us_delta(now, packet->stamp));
447                 hctx->ccid3hctx_rtt = tfrc_ewma(hctx->ccid3hctx_rtt, r_sample, 9);
448
449                 if (hctx->ccid3hctx_state == TFRC_SSTATE_NO_FBACK) {
450                         /*
451                          * Larger Initial Windows [RFC 4342, sec. 5]
452                          */
453                         hctx->ccid3hctx_x    = rfc3390_initial_rate(sk);
454                         hctx->ccid3hctx_t_ld = now;
455
456                         ccid3_update_send_interval(hctx);
457
458                         ccid3_pr_debug("%s(%p), s=%u, MSS=%u, "
459                                        "R_sample=%uus, X=%u\n", dccp_role(sk),
460                                        sk, hctx->ccid3hctx_s,
461                                        dccp_sk(sk)->dccps_mss_cache, r_sample,
462                                        (unsigned)(hctx->ccid3hctx_x >> 6));
463
464                         ccid3_hc_tx_set_state(sk, TFRC_SSTATE_FBACK);
465                 } else {
466
467                         /* Update sending rate (step 4 of [RFC 3448, 4.3]) */
468                         if (hctx->ccid3hctx_p > 0)
469                                 hctx->ccid3hctx_x_calc =
470                                         tfrc_calc_x(hctx->ccid3hctx_s,
471                                                     hctx->ccid3hctx_rtt,
472                                                     hctx->ccid3hctx_p);
473                         ccid3_hc_tx_update_x(sk, &now);
474
475                         ccid3_pr_debug("%s(%p), RTT=%uus (sample=%uus), s=%u, "
476                                        "p=%u, X_calc=%u, X_recv=%u, X=%u\n",
477                                        dccp_role(sk),
478                                        sk, hctx->ccid3hctx_rtt, r_sample,
479                                        hctx->ccid3hctx_s, hctx->ccid3hctx_p,
480                                        hctx->ccid3hctx_x_calc,
481                                        (unsigned)(hctx->ccid3hctx_x_recv >> 6),
482                                        (unsigned)(hctx->ccid3hctx_x >> 6));
483                 }
484
485                 /* unschedule no feedback timer */
486                 sk_stop_timer(sk, &hctx->ccid3hctx_no_feedback_timer);
487
488                 /*
489                  * As we have calculated new ipi, delta, t_nom it is possible
490                  * that we now can send a packet, so wake up dccp_wait_for_ccid
491                  */
492                 sk->sk_write_space(sk);
493
494                 /*
495                  * Update timeout interval for the nofeedback timer.
496                  * We use a configuration option to increase the lower bound.
497                  * This can help avoid triggering the nofeedback timer too
498                  * often ('spinning') on LANs with small RTTs.
499                  */
500                 hctx->ccid3hctx_t_rto = max_t(u32, 4 * hctx->ccid3hctx_rtt,
501                                                    CONFIG_IP_DCCP_CCID3_RTO *
502                                                    (USEC_PER_SEC/1000));
503                 /*
504                  * Schedule no feedback timer to expire in
505                  * max(t_RTO, 2 * s/X)  =  max(t_RTO, 2 * t_ipi)
506                  */
507                 t_nfb = max(hctx->ccid3hctx_t_rto, 2 * hctx->ccid3hctx_t_ipi);
508
509                 ccid3_pr_debug("%s(%p), Scheduled no feedback timer to "
510                                "expire in %lu jiffies (%luus)\n",
511                                dccp_role(sk),
512                                sk, usecs_to_jiffies(t_nfb), t_nfb);
513
514                 sk_reset_timer(sk, &hctx->ccid3hctx_no_feedback_timer,
515                                    jiffies + usecs_to_jiffies(t_nfb));
516                 break;
517         case TFRC_SSTATE_NO_SENT:       /* fall through */
518         case TFRC_SSTATE_TERM:          /* ignore feedback when closing */
519                 break;
520         }
521 }
522
523 static int ccid3_hc_tx_parse_options(struct sock *sk, unsigned char option,
524                                      unsigned char len, u16 idx,
525                                      unsigned char *value)
526 {
527         int rc = 0;
528         const struct dccp_sock *dp = dccp_sk(sk);
529         struct ccid3_hc_tx_sock *hctx = ccid3_hc_tx_sk(sk);
530         struct ccid3_options_received *opt_recv;
531         __be32 opt_val;
532
533         opt_recv = &hctx->ccid3hctx_options_received;
534
535         if (opt_recv->ccid3or_seqno != dp->dccps_gsr) {
536                 opt_recv->ccid3or_seqno              = dp->dccps_gsr;
537                 opt_recv->ccid3or_loss_event_rate    = ~0;
538                 opt_recv->ccid3or_loss_intervals_idx = 0;
539                 opt_recv->ccid3or_loss_intervals_len = 0;
540                 opt_recv->ccid3or_receive_rate       = 0;
541         }
542
543         switch (option) {
544         case TFRC_OPT_LOSS_EVENT_RATE:
545                 if (unlikely(len != 4)) {
546                         DCCP_WARN("%s(%p), invalid len %d "
547                                   "for TFRC_OPT_LOSS_EVENT_RATE\n",
548                                   dccp_role(sk), sk, len);
549                         rc = -EINVAL;
550                 } else {
551                         opt_val = get_unaligned((__be32 *)value);
552                         opt_recv->ccid3or_loss_event_rate = ntohl(opt_val);
553                         ccid3_pr_debug("%s(%p), LOSS_EVENT_RATE=%u\n",
554                                        dccp_role(sk), sk,
555                                        opt_recv->ccid3or_loss_event_rate);
556                 }
557                 break;
558         case TFRC_OPT_LOSS_INTERVALS:
559                 opt_recv->ccid3or_loss_intervals_idx = idx;
560                 opt_recv->ccid3or_loss_intervals_len = len;
561                 ccid3_pr_debug("%s(%p), LOSS_INTERVALS=(%u, %u)\n",
562                                dccp_role(sk), sk,
563                                opt_recv->ccid3or_loss_intervals_idx,
564                                opt_recv->ccid3or_loss_intervals_len);
565                 break;
566         case TFRC_OPT_RECEIVE_RATE:
567                 if (unlikely(len != 4)) {
568                         DCCP_WARN("%s(%p), invalid len %d "
569                                   "for TFRC_OPT_RECEIVE_RATE\n",
570                                   dccp_role(sk), sk, len);
571                         rc = -EINVAL;
572                 } else {
573                         opt_val = get_unaligned((__be32 *)value);
574                         opt_recv->ccid3or_receive_rate = ntohl(opt_val);
575                         ccid3_pr_debug("%s(%p), RECEIVE_RATE=%u\n",
576                                        dccp_role(sk), sk,
577                                        opt_recv->ccid3or_receive_rate);
578                 }
579                 break;
580         }
581
582         return rc;
583 }
584
585 static int ccid3_hc_tx_init(struct ccid *ccid, struct sock *sk)
586 {
587         struct ccid3_hc_tx_sock *hctx = ccid_priv(ccid);
588
589         hctx->ccid3hctx_state = TFRC_SSTATE_NO_SENT;
590         hctx->ccid3hctx_hist = NULL;
591         setup_timer(&hctx->ccid3hctx_no_feedback_timer,
592                         ccid3_hc_tx_no_feedback_timer, (unsigned long)sk);
593
594         return 0;
595 }
596
597 static void ccid3_hc_tx_exit(struct sock *sk)
598 {
599         struct ccid3_hc_tx_sock *hctx = ccid3_hc_tx_sk(sk);
600
601         ccid3_hc_tx_set_state(sk, TFRC_SSTATE_TERM);
602         sk_stop_timer(sk, &hctx->ccid3hctx_no_feedback_timer);
603
604         tfrc_tx_hist_purge(&hctx->ccid3hctx_hist);
605 }
606
607 static void ccid3_hc_tx_get_info(struct sock *sk, struct tcp_info *info)
608 {
609         struct ccid3_hc_tx_sock *hctx;
610
611         /* Listen socks doesn't have a private CCID block */
612         if (sk->sk_state == DCCP_LISTEN)
613                 return;
614
615         hctx = ccid3_hc_tx_sk(sk);
616         info->tcpi_rto = hctx->ccid3hctx_t_rto;
617         info->tcpi_rtt = hctx->ccid3hctx_rtt;
618 }
619
620 static int ccid3_hc_tx_getsockopt(struct sock *sk, const int optname, int len,
621                                   u32 __user *optval, int __user *optlen)
622 {
623         const struct ccid3_hc_tx_sock *hctx;
624         const void *val;
625
626         /* Listen socks doesn't have a private CCID block */
627         if (sk->sk_state == DCCP_LISTEN)
628                 return -EINVAL;
629
630         hctx = ccid3_hc_tx_sk(sk);
631         switch (optname) {
632         case DCCP_SOCKOPT_CCID_TX_INFO:
633                 if (len < sizeof(hctx->ccid3hctx_tfrc))
634                         return -EINVAL;
635                 len = sizeof(hctx->ccid3hctx_tfrc);
636                 val = &hctx->ccid3hctx_tfrc;
637                 break;
638         default:
639                 return -ENOPROTOOPT;
640         }
641
642         if (put_user(len, optlen) || copy_to_user(optval, val, len))
643                 return -EFAULT;
644
645         return 0;
646 }
647
648 /*
649  *      Receiver Half-Connection Routines
650  */
651 #ifdef CONFIG_IP_DCCP_CCID3_DEBUG
652 static const char *ccid3_rx_state_name(enum ccid3_hc_rx_states state)
653 {
654         static char *ccid3_rx_state_names[] = {
655         [TFRC_RSTATE_NO_DATA] = "NO_DATA",
656         [TFRC_RSTATE_DATA]    = "DATA",
657         [TFRC_RSTATE_TERM]    = "TERM",
658         };
659
660         return ccid3_rx_state_names[state];
661 }
662 #endif
663
664 static void ccid3_hc_rx_set_state(struct sock *sk,
665                                   enum ccid3_hc_rx_states state)
666 {
667         struct ccid3_hc_rx_sock *hcrx = ccid3_hc_rx_sk(sk);
668         enum ccid3_hc_rx_states oldstate = hcrx->ccid3hcrx_state;
669
670         ccid3_pr_debug("%s(%p) %-8.8s -> %s\n",
671                        dccp_role(sk), sk, ccid3_rx_state_name(oldstate),
672                        ccid3_rx_state_name(state));
673         WARN_ON(state == oldstate);
674         hcrx->ccid3hcrx_state = state;
675 }
676
677 static inline void ccid3_hc_rx_update_s(struct ccid3_hc_rx_sock *hcrx, int len)
678 {
679         if (likely(len > 0))    /* don't update on empty packets (e.g. ACKs) */
680                 hcrx->ccid3hcrx_s = tfrc_ewma(hcrx->ccid3hcrx_s, len, 9);
681 }
682
683 static void ccid3_hc_rx_send_feedback(struct sock *sk)
684 {
685         struct ccid3_hc_rx_sock *hcrx = ccid3_hc_rx_sk(sk);
686         struct dccp_sock *dp = dccp_sk(sk);
687         struct dccp_rx_hist_entry *packet;
688         ktime_t now;
689         suseconds_t delta;
690
691         ccid3_pr_debug("%s(%p) - entry \n", dccp_role(sk), sk);
692
693         now = ktime_get_real();
694
695         switch (hcrx->ccid3hcrx_state) {
696         case TFRC_RSTATE_NO_DATA:
697                 hcrx->ccid3hcrx_x_recv = 0;
698                 break;
699         case TFRC_RSTATE_DATA:
700                 delta = ktime_us_delta(now,
701                                        hcrx->ccid3hcrx_tstamp_last_feedback);
702                 DCCP_BUG_ON(delta < 0);
703                 hcrx->ccid3hcrx_x_recv =
704                         scaled_div32(hcrx->ccid3hcrx_bytes_recv, delta);
705                 break;
706         case TFRC_RSTATE_TERM:
707                 DCCP_BUG("%s(%p) - Illegal state TERM", dccp_role(sk), sk);
708                 return;
709         }
710
711         packet = dccp_rx_hist_find_data_packet(&hcrx->ccid3hcrx_hist);
712         if (unlikely(packet == NULL)) {
713                 DCCP_WARN("%s(%p), no data packet in history!\n",
714                           dccp_role(sk), sk);
715                 return;
716         }
717
718         hcrx->ccid3hcrx_tstamp_last_feedback = now;
719         hcrx->ccid3hcrx_ccval_last_counter   = packet->dccphrx_ccval;
720         hcrx->ccid3hcrx_bytes_recv           = 0;
721
722         if (hcrx->ccid3hcrx_p == 0)
723                 hcrx->ccid3hcrx_pinv = ~0U;     /* see RFC 4342, 8.5 */
724         else if (hcrx->ccid3hcrx_p > 1000000) {
725                 DCCP_WARN("p (%u) > 100%%\n", hcrx->ccid3hcrx_p);
726                 hcrx->ccid3hcrx_pinv = 1;       /* use 100% in this case */
727         } else
728                 hcrx->ccid3hcrx_pinv = 1000000 / hcrx->ccid3hcrx_p;
729
730         dp->dccps_hc_rx_insert_options = 1;
731         dccp_send_ack(sk);
732 }
733
734 static int ccid3_hc_rx_insert_options(struct sock *sk, struct sk_buff *skb)
735 {
736         const struct ccid3_hc_rx_sock *hcrx;
737         __be32 x_recv, pinv;
738
739         if (!(sk->sk_state == DCCP_OPEN || sk->sk_state == DCCP_PARTOPEN))
740                 return 0;
741
742         hcrx = ccid3_hc_rx_sk(sk);
743         DCCP_SKB_CB(skb)->dccpd_ccval = hcrx->ccid3hcrx_ccval_last_counter;
744
745         if (dccp_packet_without_ack(skb))
746                 return 0;
747
748         x_recv = htonl(hcrx->ccid3hcrx_x_recv);
749         pinv   = htonl(hcrx->ccid3hcrx_pinv);
750
751         if (dccp_insert_option_timestamp(sk, skb) ||
752             dccp_insert_option(sk, skb, TFRC_OPT_LOSS_EVENT_RATE,
753                                &pinv, sizeof(pinv)) ||
754             dccp_insert_option(sk, skb, TFRC_OPT_RECEIVE_RATE,
755                                &x_recv, sizeof(x_recv)))
756                 return -1;
757
758         return 0;
759 }
760
761 static int ccid3_hc_rx_detect_loss(struct sock *sk,
762                                     struct dccp_rx_hist_entry *packet)
763 {
764         struct ccid3_hc_rx_sock *hcrx = ccid3_hc_rx_sk(sk);
765         struct dccp_rx_hist_entry *rx_hist =
766                                 dccp_rx_hist_head(&hcrx->ccid3hcrx_hist);
767         u64 seqno = packet->dccphrx_seqno;
768         u64 tmp_seqno;
769         int loss = 0;
770         u8 ccval;
771
772
773         tmp_seqno = hcrx->ccid3hcrx_seqno_nonloss;
774
775         if (!rx_hist ||
776            follows48(packet->dccphrx_seqno, hcrx->ccid3hcrx_seqno_nonloss)) {
777                 hcrx->ccid3hcrx_seqno_nonloss = seqno;
778                 hcrx->ccid3hcrx_ccval_nonloss = packet->dccphrx_ccval;
779                 goto detect_out;
780         }
781
782
783         while (dccp_delta_seqno(hcrx->ccid3hcrx_seqno_nonloss, seqno)
784            > TFRC_RECV_NUM_LATE_LOSS) {
785                 loss = 1;
786                 dccp_li_update_li(sk,
787                                   &hcrx->ccid3hcrx_li_hist,
788                                   &hcrx->ccid3hcrx_hist,
789                                   hcrx->ccid3hcrx_tstamp_last_feedback,
790                                   hcrx->ccid3hcrx_s,
791                                   hcrx->ccid3hcrx_bytes_recv,
792                                   hcrx->ccid3hcrx_x_recv,
793                                   hcrx->ccid3hcrx_seqno_nonloss,
794                                   hcrx->ccid3hcrx_ccval_nonloss);
795                 tmp_seqno = hcrx->ccid3hcrx_seqno_nonloss;
796                 dccp_inc_seqno(&tmp_seqno);
797                 hcrx->ccid3hcrx_seqno_nonloss = tmp_seqno;
798                 dccp_inc_seqno(&tmp_seqno);
799                 while (dccp_rx_hist_find_entry(&hcrx->ccid3hcrx_hist,
800                    tmp_seqno, &ccval)) {
801                         hcrx->ccid3hcrx_seqno_nonloss = tmp_seqno;
802                         hcrx->ccid3hcrx_ccval_nonloss = ccval;
803                         dccp_inc_seqno(&tmp_seqno);
804                 }
805         }
806
807         /* FIXME - this code could be simplified with above while */
808         /* but works at moment */
809         if (follows48(packet->dccphrx_seqno, hcrx->ccid3hcrx_seqno_nonloss)) {
810                 hcrx->ccid3hcrx_seqno_nonloss = seqno;
811                 hcrx->ccid3hcrx_ccval_nonloss = packet->dccphrx_ccval;
812         }
813
814 detect_out:
815         dccp_rx_hist_add_packet(ccid3_rx_hist, &hcrx->ccid3hcrx_hist,
816                    &hcrx->ccid3hcrx_li_hist, packet,
817                    hcrx->ccid3hcrx_seqno_nonloss);
818         return loss;
819 }
820
821 static void ccid3_hc_rx_packet_recv(struct sock *sk, struct sk_buff *skb)
822 {
823         struct ccid3_hc_rx_sock *hcrx = ccid3_hc_rx_sk(sk);
824         const struct dccp_options_received *opt_recv;
825         struct dccp_rx_hist_entry *packet;
826         u32 p_prev, r_sample, rtt_prev;
827         int loss, payload_size;
828         ktime_t now;
829
830         opt_recv = &dccp_sk(sk)->dccps_options_received;
831
832         switch (DCCP_SKB_CB(skb)->dccpd_type) {
833         case DCCP_PKT_ACK:
834                 if (hcrx->ccid3hcrx_state == TFRC_RSTATE_NO_DATA)
835                         return;
836         case DCCP_PKT_DATAACK:
837                 if (opt_recv->dccpor_timestamp_echo == 0)
838                         break;
839                 r_sample = dccp_timestamp() - opt_recv->dccpor_timestamp_echo;
840                 rtt_prev = hcrx->ccid3hcrx_rtt;
841                 r_sample = dccp_sample_rtt(sk, 10 * r_sample);
842
843                 if (hcrx->ccid3hcrx_state == TFRC_RSTATE_NO_DATA)
844                         hcrx->ccid3hcrx_rtt = r_sample;
845                 else
846                         hcrx->ccid3hcrx_rtt = (hcrx->ccid3hcrx_rtt * 9) / 10 +
847                                               r_sample / 10;
848
849                 if (rtt_prev != hcrx->ccid3hcrx_rtt)
850                         ccid3_pr_debug("%s(%p), New RTT=%uus, elapsed time=%u\n",
851                                        dccp_role(sk), sk, hcrx->ccid3hcrx_rtt,
852                                        opt_recv->dccpor_elapsed_time);
853                 break;
854         case DCCP_PKT_DATA:
855                 break;
856         default: /* We're not interested in other packet types, move along */
857                 return;
858         }
859
860         packet = dccp_rx_hist_entry_new(ccid3_rx_hist, opt_recv->dccpor_ndp,
861                                         skb, GFP_ATOMIC);
862         if (unlikely(packet == NULL)) {
863                 DCCP_WARN("%s(%p), Not enough mem to add rx packet "
864                           "to history, consider it lost!\n", dccp_role(sk), sk);
865                 return;
866         }
867
868         loss = ccid3_hc_rx_detect_loss(sk, packet);
869
870         if (DCCP_SKB_CB(skb)->dccpd_type == DCCP_PKT_ACK)
871                 return;
872
873         payload_size = skb->len - dccp_hdr(skb)->dccph_doff * 4;
874         ccid3_hc_rx_update_s(hcrx, payload_size);
875
876         switch (hcrx->ccid3hcrx_state) {
877         case TFRC_RSTATE_NO_DATA:
878                 ccid3_pr_debug("%s(%p, state=%s), skb=%p, sending initial "
879                                "feedback\n", dccp_role(sk), sk,
880                                dccp_state_name(sk->sk_state), skb);
881                 ccid3_hc_rx_send_feedback(sk);
882                 ccid3_hc_rx_set_state(sk, TFRC_RSTATE_DATA);
883                 return;
884         case TFRC_RSTATE_DATA:
885                 hcrx->ccid3hcrx_bytes_recv += payload_size;
886                 if (loss)
887                         break;
888
889                 now = ktime_get_real();
890                 if ((ktime_us_delta(now, hcrx->ccid3hcrx_tstamp_last_ack) -
891                      (s64)hcrx->ccid3hcrx_rtt) >= 0) {
892                         hcrx->ccid3hcrx_tstamp_last_ack = now;
893                         ccid3_hc_rx_send_feedback(sk);
894                 }
895                 return;
896         case TFRC_RSTATE_TERM:
897                 DCCP_BUG("%s(%p) - Illegal state TERM", dccp_role(sk), sk);
898                 return;
899         }
900
901         /* Dealing with packet loss */
902         ccid3_pr_debug("%s(%p, state=%s), data loss! Reacting...\n",
903                        dccp_role(sk), sk, dccp_state_name(sk->sk_state));
904
905         p_prev = hcrx->ccid3hcrx_p;
906
907         /* Calculate loss event rate */
908         if (!list_empty(&hcrx->ccid3hcrx_li_hist)) {
909                 u32 i_mean = dccp_li_hist_calc_i_mean(&hcrx->ccid3hcrx_li_hist);
910
911                 /* Scaling up by 1000000 as fixed decimal */
912                 if (i_mean != 0)
913                         hcrx->ccid3hcrx_p = 1000000 / i_mean;
914         } else
915                 DCCP_BUG("empty loss history");
916
917         if (hcrx->ccid3hcrx_p > p_prev) {
918                 ccid3_hc_rx_send_feedback(sk);
919                 return;
920         }
921 }
922
923 static int ccid3_hc_rx_init(struct ccid *ccid, struct sock *sk)
924 {
925         struct ccid3_hc_rx_sock *hcrx = ccid_priv(ccid);
926
927         ccid3_pr_debug("entry\n");
928
929         hcrx->ccid3hcrx_state = TFRC_RSTATE_NO_DATA;
930         INIT_LIST_HEAD(&hcrx->ccid3hcrx_hist);
931         INIT_LIST_HEAD(&hcrx->ccid3hcrx_li_hist);
932         hcrx->ccid3hcrx_tstamp_last_feedback =
933                 hcrx->ccid3hcrx_tstamp_last_ack = ktime_get_real();
934         return 0;
935 }
936
937 static void ccid3_hc_rx_exit(struct sock *sk)
938 {
939         struct ccid3_hc_rx_sock *hcrx = ccid3_hc_rx_sk(sk);
940
941         ccid3_hc_rx_set_state(sk, TFRC_RSTATE_TERM);
942
943         /* Empty packet history */
944         dccp_rx_hist_purge(ccid3_rx_hist, &hcrx->ccid3hcrx_hist);
945
946         /* Empty loss interval history */
947         dccp_li_hist_purge(&hcrx->ccid3hcrx_li_hist);
948 }
949
950 static void ccid3_hc_rx_get_info(struct sock *sk, struct tcp_info *info)
951 {
952         const struct ccid3_hc_rx_sock *hcrx;
953
954         /* Listen socks doesn't have a private CCID block */
955         if (sk->sk_state == DCCP_LISTEN)
956                 return;
957
958         hcrx = ccid3_hc_rx_sk(sk);
959         info->tcpi_ca_state = hcrx->ccid3hcrx_state;
960         info->tcpi_options  |= TCPI_OPT_TIMESTAMPS;
961         info->tcpi_rcv_rtt  = hcrx->ccid3hcrx_rtt;
962 }
963
964 static int ccid3_hc_rx_getsockopt(struct sock *sk, const int optname, int len,
965                                   u32 __user *optval, int __user *optlen)
966 {
967         const struct ccid3_hc_rx_sock *hcrx;
968         const void *val;
969
970         /* Listen socks doesn't have a private CCID block */
971         if (sk->sk_state == DCCP_LISTEN)
972                 return -EINVAL;
973
974         hcrx = ccid3_hc_rx_sk(sk);
975         switch (optname) {
976         case DCCP_SOCKOPT_CCID_RX_INFO:
977                 if (len < sizeof(hcrx->ccid3hcrx_tfrc))
978                         return -EINVAL;
979                 len = sizeof(hcrx->ccid3hcrx_tfrc);
980                 val = &hcrx->ccid3hcrx_tfrc;
981                 break;
982         default:
983                 return -ENOPROTOOPT;
984         }
985
986         if (put_user(len, optlen) || copy_to_user(optval, val, len))
987                 return -EFAULT;
988
989         return 0;
990 }
991
992 static struct ccid_operations ccid3 = {
993         .ccid_id                   = DCCPC_CCID3,
994         .ccid_name                 = "ccid3",
995         .ccid_owner                = THIS_MODULE,
996         .ccid_hc_tx_obj_size       = sizeof(struct ccid3_hc_tx_sock),
997         .ccid_hc_tx_init           = ccid3_hc_tx_init,
998         .ccid_hc_tx_exit           = ccid3_hc_tx_exit,
999         .ccid_hc_tx_send_packet    = ccid3_hc_tx_send_packet,
1000         .ccid_hc_tx_packet_sent    = ccid3_hc_tx_packet_sent,
1001         .ccid_hc_tx_packet_recv    = ccid3_hc_tx_packet_recv,
1002         .ccid_hc_tx_parse_options  = ccid3_hc_tx_parse_options,
1003         .ccid_hc_rx_obj_size       = sizeof(struct ccid3_hc_rx_sock),
1004         .ccid_hc_rx_init           = ccid3_hc_rx_init,
1005         .ccid_hc_rx_exit           = ccid3_hc_rx_exit,
1006         .ccid_hc_rx_insert_options = ccid3_hc_rx_insert_options,
1007         .ccid_hc_rx_packet_recv    = ccid3_hc_rx_packet_recv,
1008         .ccid_hc_rx_get_info       = ccid3_hc_rx_get_info,
1009         .ccid_hc_tx_get_info       = ccid3_hc_tx_get_info,
1010         .ccid_hc_rx_getsockopt     = ccid3_hc_rx_getsockopt,
1011         .ccid_hc_tx_getsockopt     = ccid3_hc_tx_getsockopt,
1012 };
1013
1014 #ifdef CONFIG_IP_DCCP_CCID3_DEBUG
1015 module_param(ccid3_debug, bool, 0444);
1016 MODULE_PARM_DESC(ccid3_debug, "Enable debug messages");
1017 #endif
1018
1019 static __init int ccid3_module_init(void)
1020 {
1021         int rc = -ENOBUFS;
1022
1023         ccid3_rx_hist = dccp_rx_hist_new("ccid3");
1024         if (ccid3_rx_hist == NULL)
1025                 goto out;
1026
1027         rc = ccid_register(&ccid3);
1028         if (rc != 0)
1029                 goto out_free_rx;
1030 out:
1031         return rc;
1032
1033 out_free_rx:
1034         dccp_rx_hist_delete(ccid3_rx_hist);
1035         ccid3_rx_hist = NULL;
1036         goto out;
1037 }
1038 module_init(ccid3_module_init);
1039
1040 static __exit void ccid3_module_exit(void)
1041 {
1042         ccid_unregister(&ccid3);
1043
1044         if (ccid3_rx_hist != NULL) {
1045                 dccp_rx_hist_delete(ccid3_rx_hist);
1046                 ccid3_rx_hist = NULL;
1047         }
1048 }
1049 module_exit(ccid3_module_exit);
1050
1051 MODULE_AUTHOR("Ian McDonald <ian.mcdonald@jandi.co.nz>, "
1052               "Arnaldo Carvalho de Melo <acme@ghostprotocols.net>");
1053 MODULE_DESCRIPTION("DCCP TFRC CCID3 CCID");
1054 MODULE_LICENSE("GPL");
1055 MODULE_ALIAS("net-dccp-ccid-3");