net/dccp/ccids/ccid3.c

   1 /*
   2  *  Copyright (c) 2007   The University of Aberdeen, Scotland, UK
   3  *  Copyright (c) 2005-7 The University of Waikato, Hamilton, New Zealand.
   4  *  Copyright (c) 2005-7 Ian McDonald <ian.mcdonald@jandi.co.nz>
   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  *
  11  *  This code also uses code from Lulea University, rereleased as GPL by its
  12  *  authors:
  13  *  Copyright (c) 2003 Nils-Erik Mattsson, Joacim Haggmark, Magnus Erixzon
  14  *
  15  *  Changes to meet Linux coding standards, to make it meet latest ccid3 draft
  16  *  and to make it work as a loadable module in the DCCP stack written by
  17  *  Arnaldo Carvalho de Melo <acme@conectiva.com.br>.
  18  *
  19  *  Copyright (c) 2005 Arnaldo Carvalho de Melo <acme@conectiva.com.br>
  20  *
  21  *  This program is free software; you can redistribute it and/or modify
  22  *  it under the terms of the GNU General Public License as published by
  23  *  the Free Software Foundation; either version 2 of the License, or
  24  *  (at your option) any later version.
  25  *
  26  *  This program is distributed in the hope that it will be useful,
  27  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  28  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  29  *  GNU General Public License for more details.
  30  *
  31  *  You should have received a copy of the GNU General Public License
  32  *  along with this program; if not, write to the Free Software
  33  *  Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  34  */
  35 #include "../dccp.h"
  36 #include "ccid3.h"
  37
  38 #include <asm/unaligned.h>
  39
  40 #ifdef CONFIG_IP_DCCP_CCID3_DEBUG
  41 static int ccid3_debug;
  42 #define ccid3_pr_debug(format, a...)    DCCP_PR_DEBUG(ccid3_debug, format, ##a)
  43 #else
  44 #define ccid3_pr_debug(format, a...)
  45 #endif
  46
  47 /*
  48  *      Transmitter Half-Connection Routines
  49  */
  50 #ifdef CONFIG_IP_DCCP_CCID3_DEBUG
  51 static const char *ccid3_tx_state_name(enum ccid3_hc_tx_states state)
  52 {
  53         static const char *const ccid3_state_names[] = {
  54         [TFRC_SSTATE_NO_SENT]  = "NO_SENT",
  55         [TFRC_SSTATE_NO_FBACK] = "NO_FBACK",
  56         [TFRC_SSTATE_FBACK]    = "FBACK",
  57         [TFRC_SSTATE_TERM]     = "TERM",
  58         };
  59
  60         return ccid3_state_names[state];
  61 }
  62 #endif
  63
  64 static void ccid3_hc_tx_set_state(struct sock *sk,
  65                                   enum ccid3_hc_tx_states state)
  66 {
  67         struct ccid3_hc_tx_sock *hc = ccid3_hc_tx_sk(sk);
  68         enum ccid3_hc_tx_states oldstate = hc->tx_state;
  69
  70         ccid3_pr_debug("%s(%p) %-8.8s -> %s\n",
  71                        dccp_role(sk), sk, ccid3_tx_state_name(oldstate),
  72                        ccid3_tx_state_name(state));
  73         WARN_ON(state == oldstate);
  74         hc->tx_state = state;
  75 }
  76
  77 /*
  78  * Compute the initial sending rate X_init in the manner of RFC 3390:
  79  *
  80  *      X_init  =  min(4 * s, max(2 * s, 4380 bytes)) / RTT
  81  *
  82  * Note that RFC 3390 uses MSS, RFC 4342 refers to RFC 3390, and rfc3448bis
  83  * (rev-02) clarifies the use of RFC 3390 with regard to the above formula.
  84  * For consistency with other parts of the code, X_init is scaled by 2^6.
  85  */
  86 static inline u64 rfc3390_initial_rate(struct sock *sk)
  87 {
  88         const struct ccid3_hc_tx_sock *hc = ccid3_hc_tx_sk(sk);
  89         const __u32 w_init = clamp_t(__u32, 4380U, 2 * hc->tx_s, 4 * hc->tx_s);
  90
  91         return scaled_div(w_init << 6, hc->tx_rtt);
  92 }
  93
  94 /**
  95  * ccid3_update_send_interval  -  Calculate new t_ipi = s / X_inst
  96  * This respects the granularity of X_inst (64 * bytes/second).
  97  */
  98 static void ccid3_update_send_interval(struct ccid3_hc_tx_sock *hc)
  99 {
 100         hc->tx_t_ipi = scaled_div32(((u64)hc->tx_s) << 6, hc->tx_x);
 101
 102         ccid3_pr_debug("t_ipi=%u, s=%u, X=%u\n", hc->tx_t_ipi,
 103                        hc->tx_s, (unsigned)(hc->tx_x >> 6));
 104 }
 105
 106 static u32 ccid3_hc_tx_idle_rtt(struct ccid3_hc_tx_sock *hc, ktime_t now)
 107 {
 108         u32 delta = ktime_us_delta(now, hc->tx_t_last_win_count);
 109
 110         return delta / hc->tx_rtt;
 111 }
 112
 113 /**
 114  * ccid3_hc_tx_update_x  -  Update allowed sending rate X
 115  * @stamp: most recent time if available - can be left NULL.
 116  * This function tracks draft rfc3448bis, check there for latest details.
 117  *
 118  * Note: X and X_recv are both stored in units of 64 * bytes/second, to support
 119  *       fine-grained resolution of sending rates. This requires scaling by 2^6
 120  *       throughout the code. Only X_calc is unscaled (in bytes/second).
 121  *
 122  */
 123 static void ccid3_hc_tx_update_x(struct sock *sk, ktime_t *stamp)
 124 {
 125         struct ccid3_hc_tx_sock *hc = ccid3_hc_tx_sk(sk);
 126         __u64 min_rate = 2 * hc->tx_x_recv;
 127         const __u64 old_x = hc->tx_x;
 128         ktime_t now = stamp ? *stamp : ktime_get_real();
 129
 130         /*
 131          * Handle IDLE periods: do not reduce below RFC3390 initial sending rate
 132          * when idling [RFC 4342, 5.1]. Definition of idling is from rfc3448bis:
 133          * a sender is idle if it has not sent anything over a 2-RTT-period.
 134          * For consistency with X and X_recv, min_rate is also scaled by 2^6.
 135          */
 136         if (ccid3_hc_tx_idle_rtt(hc, now) >= 2) {
 137                 min_rate = rfc3390_initial_rate(sk);
 138                 min_rate = max(min_rate, 2 * hc->tx_x_recv);
 139         }
 140
 141         if (hc->tx_p > 0) {
 142
 143                 hc->tx_x = min(((__u64)hc->tx_x_calc) << 6, min_rate);
 144                 hc->tx_x = max(hc->tx_x, (((__u64)hc->tx_s) << 6) / TFRC_T_MBI);
 145
 146         } else if (ktime_us_delta(now, hc->tx_t_ld) - (s64)hc->tx_rtt >= 0) {
 147
 148                 hc->tx_x = min(2 * hc->tx_x, min_rate);
 149                 hc->tx_x = max(hc->tx_x,
 150                                scaled_div(((__u64)hc->tx_s) << 6, hc->tx_rtt));
 151                 hc->tx_t_ld = now;
 152         }
 153
 154         if (hc->tx_x != old_x) {
 155                 ccid3_pr_debug("X_prev=%u, X_now=%u, X_calc=%u, "
 156                                "X_recv=%u\n", (unsigned)(old_x >> 6),
 157                                (unsigned)(hc->tx_x >> 6), hc->tx_x_calc,
 158                                (unsigned)(hc->tx_x_recv >> 6));
 159
 160                 ccid3_update_send_interval(hc);
 161         }
 162 }
 163
 164 /*
 165  *      Track the mean packet size `s' (cf. RFC 4342, 5.3 and  RFC 3448, 4.1)
 166  *      @len: DCCP packet payload size in bytes
 167  */
 168 static inline void ccid3_hc_tx_update_s(struct ccid3_hc_tx_sock *hc, int len)
 169 {
 170         const u16 old_s = hc->tx_s;
 171
 172         hc->tx_s = tfrc_ewma(hc->tx_s, len, 9);
 173
 174         if (hc->tx_s != old_s)
 175                 ccid3_update_send_interval(hc);
 176 }
 177
 178 /*
 179  *      Update Window Counter using the algorithm from [RFC 4342, 8.1].
 180  *      As elsewhere, RTT > 0 is assumed by using dccp_sample_rtt().
 181  */
 182 static inline void ccid3_hc_tx_update_win_count(struct ccid3_hc_tx_sock *hc,
 183                                                 ktime_t now)
 184 {
 185         u32 delta = ktime_us_delta(now, hc->tx_t_last_win_count),
 186             quarter_rtts = (4 * delta) / hc->tx_rtt;
 187
 188         if (quarter_rtts > 0) {
 189                 hc->tx_t_last_win_count = now;
 190                 hc->tx_last_win_count  += min(quarter_rtts, 5U);
 191                 hc->tx_last_win_count  &= 0xF;          /* mod 16 */
 192         }
 193 }
 194
 195 static void ccid3_hc_tx_no_feedback_timer(unsigned long data)
 196 {
 197         struct sock *sk = (struct sock *)data;
 198         struct ccid3_hc_tx_sock *hc = ccid3_hc_tx_sk(sk);
 199         unsigned long t_nfb = USEC_PER_SEC / 5;
 200
 201         bh_lock_sock(sk);
 202         if (sock_owned_by_user(sk)) {
 203                 /* Try again later. */
 204                 /* XXX: set some sensible MIB */
 205                 goto restart_timer;
 206         }
 207
 208         ccid3_pr_debug("%s(%p, state=%s) - entry\n", dccp_role(sk), sk,
 209                        ccid3_tx_state_name(hc->tx_state));
 210
 211         if (hc->tx_state == TFRC_SSTATE_FBACK)
 212                 ccid3_hc_tx_set_state(sk, TFRC_SSTATE_NO_FBACK);
 213         else if (hc->tx_state != TFRC_SSTATE_NO_FBACK)
 214                 goto out;
 215
 216         /*
 217          * Determine new allowed sending rate X as per draft rfc3448bis-00, 4.4
 218          * RTO is 0 if and only if no feedback has been received yet.
 219          */
 220         if (hc->tx_t_rto == 0 || hc->tx_p == 0) {
 221
 222                 /* halve send rate directly */
 223                 hc->tx_x = max(hc->tx_x / 2,
 224                                (((__u64)hc->tx_s) << 6) / TFRC_T_MBI);
 225                 ccid3_update_send_interval(hc);
 226         } else {
 227                 /*
 228                  *  Modify the cached value of X_recv
 229                  *
 230                  *  If (X_calc > 2 * X_recv)
 231                  *    X_recv = max(X_recv / 2, s / (2 * t_mbi));
 232                  *  Else
 233                  *    X_recv = X_calc / 4;
 234                  *
 235                  *  Note that X_recv is scaled by 2^6 while X_calc is not
 236                  */
 237                 BUG_ON(hc->tx_p && !hc->tx_x_calc);
 238
 239                 if (hc->tx_x_calc > (hc->tx_x_recv >> 5))
 240                         hc->tx_x_recv =
 241                                 max(hc->tx_x_recv / 2,
 242                                     (((__u64)hc->tx_s) << 6) / (2*TFRC_T_MBI));
 243                 else {
 244                         hc->tx_x_recv = hc->tx_x_calc;
 245                         hc->tx_x_recv <<= 4;
 246                 }
 247                 ccid3_hc_tx_update_x(sk, NULL);
 248         }
 249         ccid3_pr_debug("Reduced X to %llu/64 bytes/sec\n",
 250                         (unsigned long long)hc->tx_x);
 251
 252         /*
 253          * Set new timeout for the nofeedback timer.
 254          * See comments in packet_recv() regarding the value of t_RTO.
 255          */
 256         if (unlikely(hc->tx_t_rto == 0))        /* no feedback received yet */
 257                 t_nfb = TFRC_INITIAL_TIMEOUT;
 258         else
 259                 t_nfb = max(hc->tx_t_rto, 2 * hc->tx_t_ipi);
 260
 261 restart_timer:
 262         sk_reset_timer(sk, &hc->tx_no_feedback_timer,
 263                            jiffies + usecs_to_jiffies(t_nfb));
 264 out:
 265         bh_unlock_sock(sk);
 266         sock_put(sk);
 267 }
 268
 269 /*
 270  * returns
 271  *   > 0: delay (in msecs) that should pass before actually sending
 272  *   = 0: can send immediately
 273  *   < 0: error condition; do not send packet
 274  */
 275 static int ccid3_hc_tx_send_packet(struct sock *sk, struct sk_buff *skb)
 276 {
 277         struct dccp_sock *dp = dccp_sk(sk);
 278         struct ccid3_hc_tx_sock *hc = ccid3_hc_tx_sk(sk);
 279         ktime_t now = ktime_get_real();
 280         s64 delay;
 281
 282         /*
 283          * This function is called only for Data and DataAck packets. Sending
 284          * zero-sized Data(Ack)s is theoretically possible, but for congestion
 285          * control this case is pathological - ignore it.
 286          */
 287         if (unlikely(skb->len == 0))
 288                 return -EBADMSG;
 289
 290         switch (hc->tx_state) {
 291         case TFRC_SSTATE_NO_SENT:
 292                 sk_reset_timer(sk, &hc->tx_no_feedback_timer, (jiffies +
 293                                usecs_to_jiffies(TFRC_INITIAL_TIMEOUT)));
 294                 hc->tx_last_win_count   = 0;
 295                 hc->tx_t_last_win_count = now;
 296
 297                 /* Set t_0 for initial packet */
 298                 hc->tx_t_nom = now;
 299
 300                 hc->tx_s = skb->len;
 301
 302                 /*
 303                  * Use initial RTT sample when available: recommended by erratum
 304                  * to RFC 4342. This implements the initialisation procedure of
 305                  * draft rfc3448bis, section 4.2. Remember, X is scaled by 2^6.
 306                  */
 307                 if (dp->dccps_syn_rtt) {
 308                         ccid3_pr_debug("SYN RTT = %uus\n", dp->dccps_syn_rtt);
 309                         hc->tx_rtt  = dp->dccps_syn_rtt;
 310                         hc->tx_x    = rfc3390_initial_rate(sk);
 311                         hc->tx_t_ld = now;
 312                 } else {
 313                         /*
 314                          * Sender does not have RTT sample:
 315                          * - set fallback RTT (RFC 4340, 3.4) since a RTT value
 316                          *   is needed in several parts (e.g.  window counter);
 317                          * - set sending rate X_pps = 1pps as per RFC 3448, 4.2.
 318                          */
 319                         hc->tx_rtt = DCCP_FALLBACK_RTT;
 320                         hc->tx_x   = hc->tx_s;
 321                         hc->tx_x <<= 6;
 322                 }
 323                 ccid3_update_send_interval(hc);
 324
 325                 ccid3_hc_tx_set_state(sk, TFRC_SSTATE_NO_FBACK);
 326                 break;
 327         case TFRC_SSTATE_NO_FBACK:
 328         case TFRC_SSTATE_FBACK:
 329                 delay = ktime_us_delta(hc->tx_t_nom, now);
 330                 ccid3_pr_debug("delay=%ld\n", (long)delay);
 331                 /*
 332                  *      Scheduling of packet transmissions (RFC 5348, 8.3)
 333                  *
 334                  * if (t_now > t_nom - delta)
 335                  *       // send the packet now
 336                  * else
 337                  *       // send the packet in (t_nom - t_now) milliseconds.
 338                  */
 339                 if (delay >= TFRC_T_DELTA)
 340                         return (u32)delay / USEC_PER_MSEC;
 341
 342                 ccid3_hc_tx_update_win_count(hc, now);
 343                 break;
 344         case TFRC_SSTATE_TERM:
 345                 DCCP_BUG("%s(%p) - Illegal state TERM", dccp_role(sk), sk);
 346                 return -EINVAL;
 347         }
 348
 349         /* prepare to send now (add options etc.) */
 350         dp->dccps_hc_tx_insert_options = 1;
 351         DCCP_SKB_CB(skb)->dccpd_ccval  = hc->tx_last_win_count;
 352
 353         /* set the nominal send time for the next following packet */
 354         hc->tx_t_nom = ktime_add_us(hc->tx_t_nom, hc->tx_t_ipi);
 355         return 0;
 356 }
 357
 358 static void ccid3_hc_tx_packet_sent(struct sock *sk, int more,
 359                                     unsigned int len)
 360 {
 361         struct ccid3_hc_tx_sock *hc = ccid3_hc_tx_sk(sk);
 362
 363         ccid3_hc_tx_update_s(hc, len);
 364
 365         if (tfrc_tx_hist_add(&hc->tx_hist, dccp_sk(sk)->dccps_gss))
 366                 DCCP_CRIT("packet history - out of memory!");
 367 }
 368
 369 static void ccid3_hc_tx_packet_recv(struct sock *sk, struct sk_buff *skb)
 370 {
 371         struct ccid3_hc_tx_sock *hc = ccid3_hc_tx_sk(sk);
 372         struct ccid3_options_received *opt_recv = &hc->tx_options_received;
 373         struct tfrc_tx_hist_entry *acked;
 374         ktime_t now;
 375         unsigned long t_nfb;
 376         u32 pinv, r_sample;
 377
 378         /* we are only interested in ACKs */
 379         if (!(DCCP_SKB_CB(skb)->dccpd_type == DCCP_PKT_ACK ||
 380               DCCP_SKB_CB(skb)->dccpd_type == DCCP_PKT_DATAACK))
 381                 return;
 382         /* ... and only in the established state */
 383         if (hc->tx_state != TFRC_SSTATE_FBACK &&
 384             hc->tx_state != TFRC_SSTATE_NO_FBACK)
 385                 return;
 386
 387         /*
 388          * Locate the acknowledged packet in the TX history.
 389          *
 390          * Returning "entry not found" here can for instance happen when
 391          *  - the host has not sent out anything (e.g. a passive server),
 392          *  - the Ack is outdated (packet with higher Ack number was received),
 393          *  - it is a bogus Ack (for a packet not sent on this connection).
 394          */
 395         acked = tfrc_tx_hist_find_entry(hc->tx_hist, dccp_hdr_ack_seq(skb));
 396         if (acked == NULL)
 397                 return;
 398         /* For the sake of RTT sampling, ignore/remove all older entries */
 399         tfrc_tx_hist_purge(&acked->next);
 400
 401         /* Update the moving average for the RTT estimate (RFC 3448, 4.3) */
 402         now       = ktime_get_real();
 403         r_sample  = dccp_sample_rtt(sk, ktime_us_delta(now, acked->stamp));
 404         hc->tx_rtt = tfrc_ewma(hc->tx_rtt, r_sample, 9);
 405
 406         /* Update receive rate in units of 64 * bytes/second */
 407         hc->tx_x_recv = opt_recv->ccid3or_receive_rate;
 408         hc->tx_x_recv <<= 6;
 409
 410         /* Update loss event rate (which is scaled by 1e6) */
 411         pinv = opt_recv->ccid3or_loss_event_rate;
 412         if (pinv == ~0U || pinv == 0)          /* see RFC 4342, 8.5   */
 413                 hc->tx_p = 0;
 414         else                                   /* can not exceed 100% */
 415                 hc->tx_p = scaled_div(1, pinv);
 416
 417         /*
 418          * Update allowed sending rate X as per draft rfc3448bis-00, 4.2/3
 419          */
 420         if (hc->tx_state == TFRC_SSTATE_NO_FBACK) {
 421                 ccid3_hc_tx_set_state(sk, TFRC_SSTATE_FBACK);
 422
 423                 if (hc->tx_t_rto == 0) {
 424                         /*
 425                          * Initial feedback packet: Larger Initial Windows (4.2)
 426                          */
 427                         hc->tx_x    = rfc3390_initial_rate(sk);
 428                         hc->tx_t_ld = now;
 429
 430                         ccid3_update_send_interval(hc);
 431
 432                         goto done_computing_x;
 433                 } else if (hc->tx_p == 0) {
 434                         /*
 435                          * First feedback after nofeedback timer expiry (4.3)
 436                          */
 437                         goto done_computing_x;
 438                 }
 439         }
 440
 441         /* Update sending rate (step 4 of [RFC 3448, 4.3]) */
 442         if (hc->tx_p > 0)
 443                 hc->tx_x_calc = tfrc_calc_x(hc->tx_s, hc->tx_rtt, hc->tx_p);
 444         ccid3_hc_tx_update_x(sk, &now);
 445
 446 done_computing_x:
 447         ccid3_pr_debug("%s(%p), RTT=%uus (sample=%uus), s=%u, "
 448                                "p=%u, X_calc=%u, X_recv=%u, X=%u\n",
 449                                dccp_role(sk), sk, hc->tx_rtt, r_sample,
 450                                hc->tx_s, hc->tx_p, hc->tx_x_calc,
 451                                (unsigned)(hc->tx_x_recv >> 6),
 452                                (unsigned)(hc->tx_x >> 6));
 453
 454         /* unschedule no feedback timer */
 455         sk_stop_timer(sk, &hc->tx_no_feedback_timer);
 456
 457         /*
 458          * As we have calculated new ipi, delta, t_nom it is possible
 459          * that we now can send a packet, so wake up dccp_wait_for_ccid
 460          */
 461         sk->sk_write_space(sk);
 462
 463         /*
 464          * Update timeout interval for the nofeedback timer. In order to control
 465          * rate halving on networks with very low RTTs (<= 1 ms), use per-route
 466          * tunable RTAX_RTO_MIN value as the lower bound.
 467          */
 468         hc->tx_t_rto = max_t(u32, 4 * hc->tx_rtt,
 469                                   USEC_PER_SEC/HZ * tcp_rto_min(sk));
 470         /*
 471          * Schedule no feedback timer to expire in
 472          * max(t_RTO, 2 * s/X)  =  max(t_RTO, 2 * t_ipi)
 473          */
 474         t_nfb = max(hc->tx_t_rto, 2 * hc->tx_t_ipi);
 475
 476         ccid3_pr_debug("%s(%p), Scheduled no feedback timer to "
 477                        "expire in %lu jiffies (%luus)\n",
 478                        dccp_role(sk), sk, usecs_to_jiffies(t_nfb), t_nfb);
 479
 480         sk_reset_timer(sk, &hc->tx_no_feedback_timer,
 481                            jiffies + usecs_to_jiffies(t_nfb));
 482 }
 483
 484 static int ccid3_hc_tx_parse_options(struct sock *sk, unsigned char option,
 485                                      unsigned char len, u16 idx,
 486                                      unsigned char *value)
 487 {
 488         int rc = 0;
 489         const struct dccp_sock *dp = dccp_sk(sk);
 490         struct ccid3_hc_tx_sock *hc = ccid3_hc_tx_sk(sk);
 491         struct ccid3_options_received *opt_recv = &hc->tx_options_received;
 492         __be32 opt_val;
 493
 494         if (opt_recv->ccid3or_seqno != dp->dccps_gsr) {
 495                 opt_recv->ccid3or_seqno              = dp->dccps_gsr;
 496                 opt_recv->ccid3or_loss_event_rate    = ~0;
 497                 opt_recv->ccid3or_loss_intervals_idx = 0;
 498                 opt_recv->ccid3or_loss_intervals_len = 0;
 499                 opt_recv->ccid3or_receive_rate       = 0;
 500         }
 501
 502         switch (option) {
 503         case TFRC_OPT_LOSS_EVENT_RATE:
 504                 if (unlikely(len != 4)) {
 505                         DCCP_WARN("%s(%p), invalid len %d "
 506                                   "for TFRC_OPT_LOSS_EVENT_RATE\n",
 507                                   dccp_role(sk), sk, len);
 508                         rc = -EINVAL;
 509                 } else {
 510                         opt_val = get_unaligned((__be32 *)value);
 511                         opt_recv->ccid3or_loss_event_rate = ntohl(opt_val);
 512                         ccid3_pr_debug("%s(%p), LOSS_EVENT_RATE=%u\n",
 513                                        dccp_role(sk), sk,
 514                                        opt_recv->ccid3or_loss_event_rate);
 515                 }
 516                 break;
 517         case TFRC_OPT_LOSS_INTERVALS:
 518                 opt_recv->ccid3or_loss_intervals_idx = idx;
 519                 opt_recv->ccid3or_loss_intervals_len = len;
 520                 ccid3_pr_debug("%s(%p), LOSS_INTERVALS=(%u, %u)\n",
 521                                dccp_role(sk), sk,
 522                                opt_recv->ccid3or_loss_intervals_idx,
 523                                opt_recv->ccid3or_loss_intervals_len);
 524                 break;
 525         case TFRC_OPT_RECEIVE_RATE:
 526                 if (unlikely(len != 4)) {
 527                         DCCP_WARN("%s(%p), invalid len %d "
 528                                   "for TFRC_OPT_RECEIVE_RATE\n",
 529                                   dccp_role(sk), sk, len);
 530                         rc = -EINVAL;
 531                 } else {
 532                         opt_val = get_unaligned((__be32 *)value);
 533                         opt_recv->ccid3or_receive_rate = ntohl(opt_val);
 534                         ccid3_pr_debug("%s(%p), RECEIVE_RATE=%u\n",
 535                                        dccp_role(sk), sk,
 536                                        opt_recv->ccid3or_receive_rate);
 537                 }
 538                 break;
 539         }
 540
 541         return rc;
 542 }
 543
 544 static int ccid3_hc_tx_init(struct ccid *ccid, struct sock *sk)
 545 {
 546         struct ccid3_hc_tx_sock *hc = ccid_priv(ccid);
 547
 548         hc->tx_state = TFRC_SSTATE_NO_SENT;
 549         hc->tx_hist  = NULL;
 550         setup_timer(&hc->tx_no_feedback_timer,
 551                         ccid3_hc_tx_no_feedback_timer, (unsigned long)sk);
 552         return 0;
 553 }
 554
 555 static void ccid3_hc_tx_exit(struct sock *sk)
 556 {
 557         struct ccid3_hc_tx_sock *hc = ccid3_hc_tx_sk(sk);
 558
 559         ccid3_hc_tx_set_state(sk, TFRC_SSTATE_TERM);
 560         sk_stop_timer(sk, &hc->tx_no_feedback_timer);
 561
 562         tfrc_tx_hist_purge(&hc->tx_hist);
 563 }
 564
 565 static void ccid3_hc_tx_get_info(struct sock *sk, struct tcp_info *info)
 566 {
 567         info->tcpi_rto = ccid3_hc_tx_sk(sk)->tx_t_rto;
 568         info->tcpi_rtt = ccid3_hc_tx_sk(sk)->tx_rtt;
 569 }
 570
 571 static int ccid3_hc_tx_getsockopt(struct sock *sk, const int optname, int len,
 572                                   u32 __user *optval, int __user *optlen)
 573 {
 574         const struct ccid3_hc_tx_sock *hc = ccid3_hc_tx_sk(sk);
 575         struct tfrc_tx_info tfrc;
 576         const void *val;
 577
 578         switch (optname) {
 579         case DCCP_SOCKOPT_CCID_TX_INFO:
 580                 if (len < sizeof(tfrc))
 581                         return -EINVAL;
 582                 tfrc.tfrctx_x      = hc->tx_x;
 583                 tfrc.tfrctx_x_recv = hc->tx_x_recv;
 584                 tfrc.tfrctx_x_calc = hc->tx_x_calc;
 585                 tfrc.tfrctx_rtt    = hc->tx_rtt;
 586                 tfrc.tfrctx_p      = hc->tx_p;
 587                 tfrc.tfrctx_rto    = hc->tx_t_rto;
 588                 tfrc.tfrctx_ipi    = hc->tx_t_ipi;
 589                 len = sizeof(tfrc);
 590                 val = &tfrc;
 591                 break;
 592         default:
 593                 return -ENOPROTOOPT;
 594         }
 595
 596         if (put_user(len, optlen) || copy_to_user(optval, val, len))
 597                 return -EFAULT;
 598
 599         return 0;
 600 }
 601
 602 /*
 603  *      Receiver Half-Connection Routines
 604  */
 605
 606 /* CCID3 feedback types */
 607 enum ccid3_fback_type {
 608         CCID3_FBACK_NONE = 0,
 609         CCID3_FBACK_INITIAL,
 610         CCID3_FBACK_PERIODIC,
 611         CCID3_FBACK_PARAM_CHANGE
 612 };
 613
 614 #ifdef CONFIG_IP_DCCP_CCID3_DEBUG
 615 static const char *ccid3_rx_state_name(enum ccid3_hc_rx_states state)
 616 {
 617         static const char *const ccid3_rx_state_names[] = {
 618         [TFRC_RSTATE_NO_DATA] = "NO_DATA",
 619         [TFRC_RSTATE_DATA]    = "DATA",
 620         [TFRC_RSTATE_TERM]    = "TERM",
 621         };
 622
 623         return ccid3_rx_state_names[state];
 624 }
 625 #endif
 626
 627 static void ccid3_hc_rx_set_state(struct sock *sk,
 628                                   enum ccid3_hc_rx_states state)
 629 {
 630         struct ccid3_hc_rx_sock *hc = ccid3_hc_rx_sk(sk);
 631         enum ccid3_hc_rx_states oldstate = hc->rx_state;
 632
 633         ccid3_pr_debug("%s(%p) %-8.8s -> %s\n",
 634                        dccp_role(sk), sk, ccid3_rx_state_name(oldstate),
 635                        ccid3_rx_state_name(state));
 636         WARN_ON(state == oldstate);
 637         hc->rx_state = state;
 638 }
 639
 640 static void ccid3_hc_rx_send_feedback(struct sock *sk,
 641                                       const struct sk_buff *skb,
 642                                       enum ccid3_fback_type fbtype)
 643 {
 644         struct ccid3_hc_rx_sock *hc = ccid3_hc_rx_sk(sk);
 645         struct dccp_sock *dp = dccp_sk(sk);
 646         ktime_t now;
 647         s64 delta = 0;
 648
 649         if (unlikely(hc->rx_state == TFRC_RSTATE_TERM))
 650                 return;
 651
 652         now = ktime_get_real();
 653
 654         switch (fbtype) {
 655         case CCID3_FBACK_INITIAL:
 656                 hc->rx_x_recv = 0;
 657                 hc->rx_pinv   = ~0U;   /* see RFC 4342, 8.5 */
 658                 break;
 659         case CCID3_FBACK_PARAM_CHANGE:
 660                 /*
 661                  * When parameters change (new loss or p > p_prev), we do not
 662                  * have a reliable estimate for R_m of [RFC 3448, 6.2] and so
 663                  * need to  reuse the previous value of X_recv. However, when
 664                  * X_recv was 0 (due to early loss), this would kill X down to
 665                  * s/t_mbi (i.e. one packet in 64 seconds).
 666                  * To avoid such drastic reduction, we approximate X_recv as
 667                  * the number of bytes since last feedback.
 668                  * This is a safe fallback, since X is bounded above by X_calc.
 669                  */
 670                 if (hc->rx_x_recv > 0)
 671                         break;
 672                 /* fall through */
 673         case CCID3_FBACK_PERIODIC:
 674                 delta = ktime_us_delta(now, hc->rx_tstamp_last_feedback);
 675                 if (delta <= 0)
 676                         DCCP_BUG("delta (%ld) <= 0", (long)delta);
 677                 else
 678                         hc->rx_x_recv = scaled_div32(hc->rx_bytes_recv, delta);
 679                 break;
 680         default:
 681                 return;
 682         }
 683
 684         ccid3_pr_debug("Interval %ldusec, X_recv=%u, 1/p=%u\n", (long)delta,
 685                        hc->rx_x_recv, hc->rx_pinv);
 686
 687         hc->rx_tstamp_last_feedback = now;
 688         hc->rx_last_counter         = dccp_hdr(skb)->dccph_ccval;
 689         hc->rx_bytes_recv           = 0;
 690
 691         dp->dccps_hc_rx_insert_options = 1;
 692         dccp_send_ack(sk);
 693 }
 694
 695 static int ccid3_hc_rx_insert_options(struct sock *sk, struct sk_buff *skb)
 696 {
 697         const struct ccid3_hc_rx_sock *hc = ccid3_hc_rx_sk(sk);
 698         __be32 x_recv, pinv;
 699
 700         if (!(sk->sk_state == DCCP_OPEN || sk->sk_state == DCCP_PARTOPEN))
 701                 return 0;
 702
 703         if (dccp_packet_without_ack(skb))
 704                 return 0;
 705
 706         x_recv = htonl(hc->rx_x_recv);
 707         pinv   = htonl(hc->rx_pinv);
 708
 709         if (dccp_insert_option(skb, TFRC_OPT_LOSS_EVENT_RATE,
 710                                &pinv, sizeof(pinv)) ||
 711             dccp_insert_option(skb, TFRC_OPT_RECEIVE_RATE,
 712                                &x_recv, sizeof(x_recv)))
 713                 return -1;
 714
 715         return 0;
 716 }
 717
 718 /**
 719  * ccid3_first_li  -  Implements [RFC 5348, 6.3.1]
 720  *
 721  * Determine the length of the first loss interval via inverse lookup.
 722  * Assume that X_recv can be computed by the throughput equation
 723  *                  s
 724  *      X_recv = --------
 725  *               R * fval
 726  * Find some p such that f(p) = fval; return 1/p (scaled).
 727  */
 728 static u32 ccid3_first_li(struct sock *sk)
 729 {
 730         struct ccid3_hc_rx_sock *hc = ccid3_hc_rx_sk(sk);
 731         u32 x_recv, p, delta;
 732         u64 fval;
 733
 734         if (hc->rx_rtt == 0) {
 735                 DCCP_WARN("No RTT estimate available, using fallback RTT\n");
 736                 hc->rx_rtt = DCCP_FALLBACK_RTT;
 737         }
 738
 739         delta  = ktime_to_us(net_timedelta(hc->rx_tstamp_last_feedback));
 740         x_recv = scaled_div32(hc->rx_bytes_recv, delta);
 741         if (x_recv == 0) {              /* would also trigger divide-by-zero */
 742                 DCCP_WARN("X_recv==0\n");
 743                 if (hc->rx_x_recv == 0) {
 744                         DCCP_BUG("stored value of X_recv is zero");
 745                         return ~0U;
 746                 }
 747                 x_recv = hc->rx_x_recv;
 748         }
 749
 750         fval = scaled_div(hc->rx_s, hc->rx_rtt);
 751         fval = scaled_div32(fval, x_recv);
 752         p = tfrc_calc_x_reverse_lookup(fval);
 753
 754         ccid3_pr_debug("%s(%p), receive rate=%u bytes/s, implied "
 755                        "loss rate=%u\n", dccp_role(sk), sk, x_recv, p);
 756
 757         return p == 0 ? ~0U : scaled_div(1, p);
 758 }
 759
 760 static void ccid3_hc_rx_packet_recv(struct sock *sk, struct sk_buff *skb)
 761 {
 762         struct ccid3_hc_rx_sock *hc = ccid3_hc_rx_sk(sk);
 763         enum ccid3_fback_type do_feedback = CCID3_FBACK_NONE;
 764         const u64 ndp = dccp_sk(sk)->dccps_options_received.dccpor_ndp;
 765         const bool is_data_packet = dccp_data_packet(skb);
 766
 767         if (unlikely(hc->rx_state == TFRC_RSTATE_NO_DATA)) {
 768                 if (is_data_packet) {
 769                         const u32 payload = skb->len - dccp_hdr(skb)->dccph_doff * 4;
 770                         do_feedback = CCID3_FBACK_INITIAL;
 771                         ccid3_hc_rx_set_state(sk, TFRC_RSTATE_DATA);
 772                         hc->rx_s = payload;
 773                         /*
 774                          * Not necessary to update rx_bytes_recv here,
 775                          * since X_recv = 0 for the first feedback packet (cf.
 776                          * RFC 3448, 6.3) -- gerrit
 777                          */
 778                 }
 779                 goto update_records;
 780         }
 781
 782         if (tfrc_rx_hist_duplicate(&hc->rx_hist, skb))
 783                 return; /* done receiving */
 784
 785         if (is_data_packet) {
 786                 const u32 payload = skb->len - dccp_hdr(skb)->dccph_doff * 4;
 787                 /*
 788                  * Update moving-average of s and the sum of received payload bytes
 789                  */
 790                 hc->rx_s = tfrc_ewma(hc->rx_s, payload, 9);
 791                 hc->rx_bytes_recv += payload;
 792         }
 793
 794         /*
 795          * Perform loss detection and handle pending losses
 796          */
 797         if (tfrc_rx_handle_loss(&hc->rx_hist, &hc->rx_li_hist,
 798                                 skb, ndp, ccid3_first_li, sk)) {
 799                 do_feedback = CCID3_FBACK_PARAM_CHANGE;
 800                 goto done_receiving;
 801         }
 802
 803         if (tfrc_rx_hist_loss_pending(&hc->rx_hist))
 804                 return; /* done receiving */
 805
 806         /*
 807          * Handle data packets: RTT sampling and monitoring p
 808          */
 809         if (unlikely(!is_data_packet))
 810                 goto update_records;
 811
 812         if (!tfrc_lh_is_initialised(&hc->rx_li_hist)) {
 813                 const u32 sample = tfrc_rx_hist_sample_rtt(&hc->rx_hist, skb);
 814                 /*
 815                  * Empty loss history: no loss so far, hence p stays 0.
 816                  * Sample RTT values, since an RTT estimate is required for the
 817                  * computation of p when the first loss occurs; RFC 3448, 6.3.1.
 818                  */
 819                 if (sample != 0)
 820                         hc->rx_rtt = tfrc_ewma(hc->rx_rtt, sample, 9);
 821
 822         } else if (tfrc_lh_update_i_mean(&hc->rx_li_hist, skb)) {
 823                 /*
 824                  * Step (3) of [RFC 3448, 6.1]: Recompute I_mean and, if I_mean
 825                  * has decreased (resp. p has increased), send feedback now.
 826                  */
 827                 do_feedback = CCID3_FBACK_PARAM_CHANGE;
 828         }
 829
 830         /*
 831          * Check if the periodic once-per-RTT feedback is due; RFC 4342, 10.3
 832          */
 833         if (SUB16(dccp_hdr(skb)->dccph_ccval, hc->rx_last_counter) > 3)
 834                 do_feedback = CCID3_FBACK_PERIODIC;
 835
 836 update_records:
 837         tfrc_rx_hist_add_packet(&hc->rx_hist, skb, ndp);
 838
 839 done_receiving:
 840         if (do_feedback)
 841                 ccid3_hc_rx_send_feedback(sk, skb, do_feedback);
 842 }
 843
 844 static int ccid3_hc_rx_init(struct ccid *ccid, struct sock *sk)
 845 {
 846         struct ccid3_hc_rx_sock *hc = ccid_priv(ccid);
 847
 848         hc->rx_state = TFRC_RSTATE_NO_DATA;
 849         tfrc_lh_init(&hc->rx_li_hist);
 850         return tfrc_rx_hist_alloc(&hc->rx_hist);
 851 }
 852
 853 static void ccid3_hc_rx_exit(struct sock *sk)
 854 {
 855         struct ccid3_hc_rx_sock *hc = ccid3_hc_rx_sk(sk);
 856
 857         ccid3_hc_rx_set_state(sk, TFRC_RSTATE_TERM);
 858
 859         tfrc_rx_hist_purge(&hc->rx_hist);
 860         tfrc_lh_cleanup(&hc->rx_li_hist);
 861 }
 862
 863 static void ccid3_hc_rx_get_info(struct sock *sk, struct tcp_info *info)
 864 {
 865         info->tcpi_ca_state = ccid3_hc_rx_sk(sk)->rx_state;
 866         info->tcpi_options  |= TCPI_OPT_TIMESTAMPS;
 867         info->tcpi_rcv_rtt  = ccid3_hc_rx_sk(sk)->rx_rtt;
 868 }
 869
 870 static int ccid3_hc_rx_getsockopt(struct sock *sk, const int optname, int len,
 871                                   u32 __user *optval, int __user *optlen)
 872 {
 873         const struct ccid3_hc_rx_sock *hc = ccid3_hc_rx_sk(sk);
 874         struct tfrc_rx_info rx_info;
 875         const void *val;
 876
 877         switch (optname) {
 878         case DCCP_SOCKOPT_CCID_RX_INFO:
 879                 if (len < sizeof(rx_info))
 880                         return -EINVAL;
 881                 rx_info.tfrcrx_x_recv = hc->rx_x_recv;
 882                 rx_info.tfrcrx_rtt    = hc->rx_rtt;
 883                 rx_info.tfrcrx_p      = hc->rx_pinv == 0 ? ~0U :
 884                                            scaled_div(1, hc->rx_pinv);
 885                 len = sizeof(rx_info);
 886                 val = &rx_info;
 887                 break;
 888         default:
 889                 return -ENOPROTOOPT;
 890         }
 891
 892         if (put_user(len, optlen) || copy_to_user(optval, val, len))
 893                 return -EFAULT;
 894
 895         return 0;
 896 }
 897
 898 struct ccid_operations ccid3_ops = {
 899         .ccid_id                   = DCCPC_CCID3,
 900         .ccid_name                 = "TCP-Friendly Rate Control",
 901         .ccid_hc_tx_obj_size       = sizeof(struct ccid3_hc_tx_sock),
 902         .ccid_hc_tx_init           = ccid3_hc_tx_init,
 903         .ccid_hc_tx_exit           = ccid3_hc_tx_exit,
 904         .ccid_hc_tx_send_packet    = ccid3_hc_tx_send_packet,
 905         .ccid_hc_tx_packet_sent    = ccid3_hc_tx_packet_sent,
 906         .ccid_hc_tx_packet_recv    = ccid3_hc_tx_packet_recv,
 907         .ccid_hc_tx_parse_options  = ccid3_hc_tx_parse_options,
 908         .ccid_hc_rx_obj_size       = sizeof(struct ccid3_hc_rx_sock),
 909         .ccid_hc_rx_init           = ccid3_hc_rx_init,
 910         .ccid_hc_rx_exit           = ccid3_hc_rx_exit,
 911         .ccid_hc_rx_insert_options = ccid3_hc_rx_insert_options,
 912         .ccid_hc_rx_packet_recv    = ccid3_hc_rx_packet_recv,
 913         .ccid_hc_rx_get_info       = ccid3_hc_rx_get_info,
 914         .ccid_hc_tx_get_info       = ccid3_hc_tx_get_info,
 915         .ccid_hc_rx_getsockopt     = ccid3_hc_rx_getsockopt,
 916         .ccid_hc_tx_getsockopt     = ccid3_hc_tx_getsockopt,
 917 };
 918
 919 #ifdef CONFIG_IP_DCCP_CCID3_DEBUG
 920 module_param(ccid3_debug, bool, 0644);
 921 MODULE_PARM_DESC(ccid3_debug, "Enable CCID-3 debug messages");
 922 #endif