net/dccp/ccids/ccid3.c

   1 /*
   2  *  net/dccp/ccids/ccid3.c
   3  *
   4  *  Copyright (c) 2007   The University of Aberdeen, Scotland, UK
   5  *  Copyright (c) 2005-7 The University of Waikato, Hamilton, New Zealand.
   6  *  Copyright (c) 2005-7 Ian McDonald <ian.mcdonald@jandi.co.nz>
   7  *
   8  *  An implementation of the DCCP protocol
   9  *
  10  *  This code has been developed by the University of Waikato WAND
  11  *  research group. For further information please see http://www.wand.net.nz/
  12  *
  13  *  This code also uses code from Lulea University, rereleased as GPL by its
  14  *  authors:
  15  *  Copyright (c) 2003 Nils-Erik Mattsson, Joacim Haggmark, Magnus Erixzon
  16  *
  17  *  Changes to meet Linux coding standards, to make it meet latest ccid3 draft
  18  *  and to make it work as a loadable module in the DCCP stack written by
  19  *  Arnaldo Carvalho de Melo <acme@conectiva.com.br>.
  20  *
  21  *  Copyright (c) 2005 Arnaldo Carvalho de Melo <acme@conectiva.com.br>
  22  *
  23  *  This program is free software; you can redistribute it and/or modify
  24  *  it under the terms of the GNU General Public License as published by
  25  *  the Free Software Foundation; either version 2 of the License, or
  26  *  (at your option) any later version.
  27  *
  28  *  This program is distributed in the hope that it will be useful,
  29  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  30  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  31  *  GNU General Public License for more details.
  32  *
  33  *  You should have received a copy of the GNU General Public License
  34  *  along with this program; if not, write to the Free Software
  35  *  Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  36  */
  37 #include "../dccp.h"
  38 #include "ccid3.h"
  39
  40 #include <asm/unaligned.h>
  41
  42 #ifdef CONFIG_IP_DCCP_CCID3_DEBUG
  43 static int ccid3_debug;
  44 #define ccid3_pr_debug(format, a...)    DCCP_PR_DEBUG(ccid3_debug, format, ##a)
  45 #else
  46 #define ccid3_pr_debug(format, a...)
  47 #endif
  48
  49 /*
  50  *      Transmitter Half-Connection Routines
  51  */
  52 #ifdef CONFIG_IP_DCCP_CCID3_DEBUG
  53 static const char *ccid3_tx_state_name(enum ccid3_hc_tx_states state)
  54 {
  55         static char *ccid3_state_names[] = {
  56         [TFRC_SSTATE_NO_SENT]  = "NO_SENT",
  57         [TFRC_SSTATE_NO_FBACK] = "NO_FBACK",
  58         [TFRC_SSTATE_FBACK]    = "FBACK",
  59         [TFRC_SSTATE_TERM]     = "TERM",
  60         };
  61
  62         return ccid3_state_names[state];
  63 }
  64 #endif
  65
  66 static void ccid3_hc_tx_set_state(struct sock *sk,
  67                                   enum ccid3_hc_tx_states state)
  68 {
  69         struct ccid3_hc_tx_sock *hctx = ccid3_hc_tx_sk(sk);
  70         enum ccid3_hc_tx_states oldstate = hctx->state;
  71
  72         ccid3_pr_debug("%s(%p) %-8.8s -> %s\n",
  73                        dccp_role(sk), sk, ccid3_tx_state_name(oldstate),
  74                        ccid3_tx_state_name(state));
  75         WARN_ON(state == oldstate);
  76         hctx->state = state;
  77 }
  78
  79 /*
  80  * Compute the initial sending rate X_init in the manner of RFC 3390:
  81  *
  82  *      X_init  =  min(4 * s, max(2 * s, 4380 bytes)) / RTT
  83  *
  84  * Note that RFC 3390 uses MSS, RFC 4342 refers to RFC 3390, and rfc3448bis
  85  * (rev-02) clarifies the use of RFC 3390 with regard to the above formula.
  86  * For consistency with other parts of the code, X_init is scaled by 2^6.
  87  */
  88 static inline u64 rfc3390_initial_rate(struct sock *sk)
  89 {
  90         const struct ccid3_hc_tx_sock *hctx = ccid3_hc_tx_sk(sk);
  91         const __u32 w_init = clamp_t(__u32, 4380U, 2 * hctx->s, 4 * hctx->s);
  92
  93         return scaled_div(w_init << 6, hctx->rtt);
  94 }
  95
  96 /*
  97  * Recalculate t_ipi and delta (should be called whenever X changes)
  98  */
  99 static void ccid3_update_send_interval(struct ccid3_hc_tx_sock *hctx)
 100 {
 101         /* Calculate new t_ipi = s / X_inst (X_inst is in 64 * bytes/second) */
 102         hctx->t_ipi = scaled_div32(((u64)hctx->s) << 6, hctx->x);
 103
 104         /* Calculate new delta by delta = min(t_ipi / 2, t_gran / 2) */
 105         hctx->delta = min_t(u32, hctx->t_ipi / 2, TFRC_OPSYS_HALF_TIME_GRAN);
 106
 107         ccid3_pr_debug("t_ipi=%u, delta=%u, s=%u, X=%u\n", hctx->t_ipi,
 108                        hctx->delta, hctx->s, (unsigned)(hctx->x >> 6));
 109 }
 110
 111 static u32 ccid3_hc_tx_idle_rtt(struct ccid3_hc_tx_sock *hctx, ktime_t now)
 112 {
 113         u32 delta = ktime_us_delta(now, hctx->t_last_win_count);
 114
 115         return delta / hctx->rtt;
 116 }
 117
 118 /**
 119  * ccid3_hc_tx_update_x  -  Update allowed sending rate X
 120  * @stamp: most recent time if available - can be left NULL.
 121  * This function tracks draft rfc3448bis, check there for latest details.
 122  *
 123  * Note: X and X_recv are both stored in units of 64 * bytes/second, to support
 124  *       fine-grained resolution of sending rates. This requires scaling by 2^6
 125  *       throughout the code. Only X_calc is unscaled (in bytes/second).
 126  *
 127  */
 128 static void ccid3_hc_tx_update_x(struct sock *sk, ktime_t *stamp)
 129 {
 130         struct ccid3_hc_tx_sock *hctx = ccid3_hc_tx_sk(sk);
 131         u64 min_rate = 2 * hctx->x_recv;
 132         const u64 old_x = hctx->x;
 133         ktime_t now = stamp ? *stamp : ktime_get_real();
 134
 135         /*
 136          * Handle IDLE periods: do not reduce below RFC3390 initial sending rate
 137          * when idling [RFC 4342, 5.1]. Definition of idling is from rfc3448bis:
 138          * a sender is idle if it has not sent anything over a 2-RTT-period.
 139          * For consistency with X and X_recv, min_rate is also scaled by 2^6.
 140          */
 141         if (ccid3_hc_tx_idle_rtt(hctx, now) >= 2) {
 142                 min_rate = rfc3390_initial_rate(sk);
 143                 min_rate = max(min_rate, 2 * hctx->x_recv);
 144         }
 145
 146         if (hctx->p > 0) {
 147
 148                 hctx->x = min(((u64)hctx->x_calc) << 6, min_rate);
 149                 hctx->x = max(hctx->x, (((u64)hctx->s) << 6) / TFRC_T_MBI);
 150
 151         } else if (ktime_us_delta(now, hctx->t_ld) - (s64)hctx->rtt >= 0) {
 152
 153                 hctx->x = min(2 * hctx->x, min_rate);
 154                 hctx->x = max(hctx->x,
 155                               scaled_div(((u64)hctx->s) << 6, hctx->rtt));
 156                 hctx->t_ld = now;
 157         }
 158
 159         if (hctx->x != old_x) {
 160                 ccid3_pr_debug("X_prev=%u, X_now=%u, X_calc=%u, "
 161                                "X_recv=%u\n", (unsigned)(old_x >> 6),
 162                                (unsigned)(hctx->x >> 6), hctx->x_calc,
 163                                (unsigned)(hctx->x_recv >> 6));
 164
 165                 ccid3_update_send_interval(hctx);
 166         }
 167 }
 168
 169 /*
 170  *      Track the mean packet size `s' (cf. RFC 4342, 5.3 and  RFC 3448, 4.1)
 171  *      @len: DCCP packet payload size in bytes
 172  */
 173 static inline void ccid3_hc_tx_update_s(struct ccid3_hc_tx_sock *hctx, int len)
 174 {
 175         const u16 old_s = hctx->s;
 176
 177         hctx->s = tfrc_ewma(hctx->s, len, 9);
 178
 179         if (hctx->s != old_s)
 180                 ccid3_update_send_interval(hctx);
 181 }
 182
 183 /*
 184  *      Update Window Counter using the algorithm from [RFC 4342, 8.1].
 185  *      As elsewhere, RTT > 0 is assumed by using dccp_sample_rtt().
 186  */
 187 static inline void ccid3_hc_tx_update_win_count(struct ccid3_hc_tx_sock *hctx,
 188                                                 ktime_t now)
 189 {
 190         u32 delta = ktime_us_delta(now, hctx->t_last_win_count),
 191             quarter_rtts = (4 * delta) / hctx->rtt;
 192
 193         if (quarter_rtts > 0) {
 194                 hctx->t_last_win_count = now;
 195                 hctx->last_win_count  += min(quarter_rtts, 5U);
 196                 hctx->last_win_count  &= 0xF;           /* mod 16 */
 197         }
 198 }
 199
 200 static void ccid3_hc_tx_no_feedback_timer(unsigned long data)
 201 {
 202         struct sock *sk = (struct sock *)data;
 203         struct ccid3_hc_tx_sock *hctx = ccid3_hc_tx_sk(sk);
 204         unsigned long t_nfb = USEC_PER_SEC / 5;
 205
 206         bh_lock_sock(sk);
 207         if (sock_owned_by_user(sk)) {
 208                 /* Try again later. */
 209                 /* XXX: set some sensible MIB */
 210                 goto restart_timer;
 211         }
 212
 213         ccid3_pr_debug("%s(%p, state=%s) - entry \n", dccp_role(sk), sk,
 214                        ccid3_tx_state_name(hctx->state));
 215
 216         if (hctx->state == TFRC_SSTATE_FBACK)
 217                 ccid3_hc_tx_set_state(sk, TFRC_SSTATE_NO_FBACK);
 218         else if (hctx->state != TFRC_SSTATE_NO_FBACK)
 219                 goto out;
 220
 221         /*
 222          * Determine new allowed sending rate X as per draft rfc3448bis-00, 4.4
 223          * RTO is 0 if and only if no feedback has been received yet.
 224          */
 225         if (hctx->t_rto == 0 || hctx->p == 0) {
 226
 227                 /* halve send rate directly */
 228                 hctx->x = max(hctx->x / 2, (((u64)hctx->s) << 6) / TFRC_T_MBI);
 229                 ccid3_update_send_interval(hctx);
 230         } else {
 231                 /*
 232                  *  Modify the cached value of X_recv
 233                  *
 234                  *  If (X_calc > 2 * X_recv)
 235                  *    X_recv = max(X_recv / 2, s / (2 * t_mbi));
 236                  *  Else
 237                  *    X_recv = X_calc / 4;
 238                  *
 239                  *  Note that X_recv is scaled by 2^6 while X_calc is not
 240                  */
 241                 BUG_ON(hctx->p && !hctx->x_calc);
 242
 243                 if (hctx->x_calc > (hctx->x_recv >> 5))
 244                         hctx->x_recv =
 245                                 max(hctx->x_recv / 2,
 246                                     (((__u64)hctx->s) << 6) / (2 * TFRC_T_MBI));
 247                 else {
 248                         hctx->x_recv = hctx->x_calc;
 249                         hctx->x_recv <<= 4;
 250                 }
 251                 ccid3_hc_tx_update_x(sk, NULL);
 252         }
 253         ccid3_pr_debug("Reduced X to %llu/64 bytes/sec\n",
 254                         (unsigned long long)hctx->x);
 255
 256         /*
 257          * Set new timeout for the nofeedback timer.
 258          * See comments in packet_recv() regarding the value of t_RTO.
 259          */
 260         if (unlikely(hctx->t_rto == 0))         /* no feedback received yet */
 261                 t_nfb = TFRC_INITIAL_TIMEOUT;
 262         else
 263                 t_nfb = max(hctx->t_rto, 2 * hctx->t_ipi);
 264
 265 restart_timer:
 266         sk_reset_timer(sk, &hctx->no_feedback_timer,
 267                            jiffies + usecs_to_jiffies(t_nfb));
 268 out:
 269         bh_unlock_sock(sk);
 270         sock_put(sk);
 271 }
 272
 273 /*
 274  * returns
 275  *   > 0: delay (in msecs) that should pass before actually sending
 276  *   = 0: can send immediately
 277  *   < 0: error condition; do not send packet
 278  */
 279 static int ccid3_hc_tx_send_packet(struct sock *sk, struct sk_buff *skb)
 280 {
 281         struct dccp_sock *dp = dccp_sk(sk);
 282         struct ccid3_hc_tx_sock *hctx = ccid3_hc_tx_sk(sk);
 283         ktime_t now = ktime_get_real();
 284         s64 delay;
 285
 286         /*
 287          * This function is called only for Data and DataAck packets. Sending
 288          * zero-sized Data(Ack)s is theoretically possible, but for congestion
 289          * control this case is pathological - ignore it.
 290          */
 291         if (unlikely(skb->len == 0))
 292                 return -EBADMSG;
 293
 294         switch (hctx->state) {
 295         case TFRC_SSTATE_NO_SENT:
 296                 sk_reset_timer(sk, &hctx->no_feedback_timer, (jiffies +
 297                                 usecs_to_jiffies(TFRC_INITIAL_TIMEOUT)));
 298                 hctx->last_win_count   = 0;
 299                 hctx->t_last_win_count = now;
 300
 301                 /* Set t_0 for initial packet */
 302                 hctx->t_nom = now;
 303
 304                 hctx->s = skb->len;
 305
 306                 /*
 307                  * Use initial RTT sample when available: recommended by erratum
 308                  * to RFC 4342. This implements the initialisation procedure of
 309                  * draft rfc3448bis, section 4.2. Remember, X is scaled by 2^6.
 310                  */
 311                 if (dp->dccps_syn_rtt) {
 312                         ccid3_pr_debug("SYN RTT = %uus\n", dp->dccps_syn_rtt);
 313                         hctx->rtt  = dp->dccps_syn_rtt;
 314                         hctx->x    = rfc3390_initial_rate(sk);
 315                         hctx->t_ld = now;
 316                 } else {
 317                         /*
 318                          * Sender does not have RTT sample:
 319                          * - set fallback RTT (RFC 4340, 3.4) since a RTT value
 320                          *   is needed in several parts (e.g.  window counter);
 321                          * - set sending rate X_pps = 1pps as per RFC 3448, 4.2.
 322                          */
 323                         hctx->rtt = DCCP_FALLBACK_RTT;
 324                         hctx->x   = hctx->s;
 325                         hctx->x <<= 6;
 326                 }
 327                 ccid3_update_send_interval(hctx);
 328
 329                 ccid3_hc_tx_set_state(sk, TFRC_SSTATE_NO_FBACK);
 330                 break;
 331         case TFRC_SSTATE_NO_FBACK:
 332         case TFRC_SSTATE_FBACK:
 333                 delay = ktime_us_delta(hctx->t_nom, now);
 334                 ccid3_pr_debug("delay=%ld\n", (long)delay);
 335                 /*
 336                  *      Scheduling of packet transmissions [RFC 3448, 4.6]
 337                  *
 338                  * if (t_now > t_nom - delta)
 339                  *       // send the packet now
 340                  * else
 341                  *       // send the packet in (t_nom - t_now) milliseconds.
 342                  */
 343                 if (delay - (s64)hctx->delta >= 1000)
 344                         return (u32)delay / 1000L;
 345
 346                 ccid3_hc_tx_update_win_count(hctx, now);
 347                 break;
 348         case TFRC_SSTATE_TERM:
 349                 DCCP_BUG("%s(%p) - Illegal state TERM", dccp_role(sk), sk);
 350                 return -EINVAL;
 351         }
 352
 353         /* prepare to send now (add options etc.) */
 354         dp->dccps_hc_tx_insert_options = 1;
 355         DCCP_SKB_CB(skb)->dccpd_ccval  = hctx->last_win_count;
 356
 357         /* set the nominal send time for the next following packet */
 358         hctx->t_nom = ktime_add_us(hctx->t_nom, hctx->t_ipi);
 359         return 0;
 360 }
 361
 362 static void ccid3_hc_tx_packet_sent(struct sock *sk, int more,
 363                                     unsigned int len)
 364 {
 365         struct ccid3_hc_tx_sock *hctx = ccid3_hc_tx_sk(sk);
 366
 367         ccid3_hc_tx_update_s(hctx, len);
 368
 369         if (tfrc_tx_hist_add(&hctx->hist, dccp_sk(sk)->dccps_gss))
 370                 DCCP_CRIT("packet history - out of memory!");
 371 }
 372
 373 static void ccid3_hc_tx_packet_recv(struct sock *sk, struct sk_buff *skb)
 374 {
 375         struct ccid3_hc_tx_sock *hctx = ccid3_hc_tx_sk(sk);
 376         struct ccid3_options_received *opt_recv = &hctx->options_received;
 377         ktime_t now;
 378         unsigned long t_nfb;
 379         u32 pinv, r_sample;
 380
 381         /* we are only interested in ACKs */
 382         if (!(DCCP_SKB_CB(skb)->dccpd_type == DCCP_PKT_ACK ||
 383               DCCP_SKB_CB(skb)->dccpd_type == DCCP_PKT_DATAACK))
 384                 return;
 385         /* ... and only in the established state */
 386         if (hctx->state != TFRC_SSTATE_FBACK &&
 387             hctx->state != TFRC_SSTATE_NO_FBACK)
 388                 return;
 389
 390         now = ktime_get_real();
 391
 392         /* Estimate RTT from history if ACK number is valid */
 393         r_sample = tfrc_tx_hist_rtt(hctx->hist,
 394                                     DCCP_SKB_CB(skb)->dccpd_ack_seq, now);
 395         if (r_sample == 0) {
 396                 DCCP_WARN("%s(%p): %s with bogus ACK-%llu\n", dccp_role(sk), sk,
 397                           dccp_packet_name(DCCP_SKB_CB(skb)->dccpd_type),
 398                           (unsigned long long)DCCP_SKB_CB(skb)->dccpd_ack_seq);
 399                 return;
 400         }
 401
 402         /* Update receive rate in units of 64 * bytes/second */
 403         hctx->x_recv = opt_recv->ccid3or_receive_rate;
 404         hctx->x_recv <<= 6;
 405
 406         /* Update loss event rate (which is scaled by 1e6) */
 407         pinv = opt_recv->ccid3or_loss_event_rate;
 408         if (pinv == ~0U || pinv == 0)          /* see RFC 4342, 8.5   */
 409                 hctx->p = 0;
 410         else                                   /* can not exceed 100% */
 411                 hctx->p = scaled_div(1, pinv);
 412         /*
 413          * Validate new RTT sample and update moving average
 414          */
 415         r_sample = dccp_sample_rtt(sk, r_sample);
 416         hctx->rtt = tfrc_ewma(hctx->rtt, r_sample, 9);
 417         /*
 418          * Update allowed sending rate X as per draft rfc3448bis-00, 4.2/3
 419          */
 420         if (hctx->state == TFRC_SSTATE_NO_FBACK) {
 421                 ccid3_hc_tx_set_state(sk, TFRC_SSTATE_FBACK);
 422
 423                 if (hctx->t_rto == 0) {
 424                         /*
 425                          * Initial feedback packet: Larger Initial Windows (4.2)
 426                          */
 427                         hctx->x    = rfc3390_initial_rate(sk);
 428                         hctx->t_ld = now;
 429
 430                         ccid3_update_send_interval(hctx);
 431
 432                         goto done_computing_x;
 433                 } else if (hctx->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 (hctx->p > 0)
 443                 hctx->x_calc = tfrc_calc_x(hctx->s, hctx->rtt, hctx->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, hctx->rtt, r_sample,
 450                                hctx->s, hctx->p, hctx->x_calc,
 451                                (unsigned)(hctx->x_recv >> 6),
 452                                (unsigned)(hctx->x >> 6));
 453
 454         /* unschedule no feedback timer */
 455         sk_stop_timer(sk, &hctx->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.
 465          * We use a configuration option to increase the lower bound.
 466          * This can help avoid triggering the nofeedback timer too
 467          * often ('spinning') on LANs with small RTTs.
 468          */
 469         hctx->t_rto = max_t(u32, 4 * hctx->rtt, (CONFIG_IP_DCCP_CCID3_RTO *
 470                                                  (USEC_PER_SEC / 1000)));
 471         /*
 472          * Schedule no feedback timer to expire in
 473          * max(t_RTO, 2 * s/X)  =  max(t_RTO, 2 * t_ipi)
 474          */
 475         t_nfb = max(hctx->t_rto, 2 * hctx->t_ipi);
 476
 477         ccid3_pr_debug("%s(%p), Scheduled no feedback timer to "
 478                        "expire in %lu jiffies (%luus)\n",
 479                        dccp_role(sk), sk, usecs_to_jiffies(t_nfb), t_nfb);
 480
 481         sk_reset_timer(sk, &hctx->no_feedback_timer,
 482                            jiffies + usecs_to_jiffies(t_nfb));
 483 }
 484
 485 static int ccid3_hc_tx_parse_options(struct sock *sk, unsigned char option,
 486                                      unsigned char len, u16 idx,
 487                                      unsigned char *value)
 488 {
 489         int rc = 0;
 490         const struct dccp_sock *dp = dccp_sk(sk);
 491         struct ccid3_hc_tx_sock *hctx = ccid3_hc_tx_sk(sk);
 492         struct ccid3_options_received *opt_recv = &hctx->options_received;
 493         __be32 opt_val;
 494
 495         if (opt_recv->ccid3or_seqno != dp->dccps_gsr) {
 496                 opt_recv->ccid3or_seqno              = dp->dccps_gsr;
 497                 opt_recv->ccid3or_loss_event_rate    = ~0;
 498                 opt_recv->ccid3or_loss_intervals_idx = 0;
 499                 opt_recv->ccid3or_loss_intervals_len = 0;
 500                 opt_recv->ccid3or_receive_rate       = 0;
 501         }
 502
 503         switch (option) {
 504         case TFRC_OPT_LOSS_EVENT_RATE:
 505                 if (unlikely(len != 4)) {
 506                         DCCP_WARN("%s(%p), invalid len %d "
 507                                   "for TFRC_OPT_LOSS_EVENT_RATE\n",
 508                                   dccp_role(sk), sk, len);
 509                         rc = -EINVAL;
 510                 } else {
 511                         opt_val = get_unaligned((__be32 *)value);
 512                         opt_recv->ccid3or_loss_event_rate = ntohl(opt_val);
 513                         ccid3_pr_debug("%s(%p), LOSS_EVENT_RATE=%u\n",
 514                                        dccp_role(sk), sk,
 515                                        opt_recv->ccid3or_loss_event_rate);
 516                 }
 517                 break;
 518         case TFRC_OPT_LOSS_INTERVALS:
 519                 opt_recv->ccid3or_loss_intervals_idx = idx;
 520                 opt_recv->ccid3or_loss_intervals_len = len;
 521                 ccid3_pr_debug("%s(%p), LOSS_INTERVALS=(%u, %u)\n",
 522                                dccp_role(sk), sk,
 523                                opt_recv->ccid3or_loss_intervals_idx,
 524                                opt_recv->ccid3or_loss_intervals_len);
 525                 break;
 526         case TFRC_OPT_RECEIVE_RATE:
 527                 if (unlikely(len != 4)) {
 528                         DCCP_WARN("%s(%p), invalid len %d "
 529                                   "for TFRC_OPT_RECEIVE_RATE\n",
 530                                   dccp_role(sk), sk, len);
 531                         rc = -EINVAL;
 532                 } else {
 533                         opt_val = get_unaligned((__be32 *)value);
 534                         opt_recv->ccid3or_receive_rate = ntohl(opt_val);
 535                         ccid3_pr_debug("%s(%p), RECEIVE_RATE=%u\n",
 536                                        dccp_role(sk), sk,
 537                                        opt_recv->ccid3or_receive_rate);
 538                 }
 539                 break;
 540         }
 541
 542         return rc;
 543 }
 544
 545 static int ccid3_hc_tx_init(struct ccid *ccid, struct sock *sk)
 546 {
 547         struct ccid3_hc_tx_sock *hctx = ccid_priv(ccid);
 548
 549         hctx->state = TFRC_SSTATE_NO_SENT;
 550         hctx->hist  = NULL;
 551         setup_timer(&hctx->no_feedback_timer,
 552                     ccid3_hc_tx_no_feedback_timer, (unsigned long)sk);
 553         return 0;
 554 }
 555
 556 static void ccid3_hc_tx_exit(struct sock *sk)
 557 {
 558         struct ccid3_hc_tx_sock *hctx = ccid3_hc_tx_sk(sk);
 559
 560         ccid3_hc_tx_set_state(sk, TFRC_SSTATE_TERM);
 561         sk_stop_timer(sk, &hctx->no_feedback_timer);
 562
 563         tfrc_tx_hist_purge(&hctx->hist);
 564 }
 565
 566 static void ccid3_hc_tx_get_info(struct sock *sk, struct tcp_info *info)
 567 {
 568         info->tcpi_rto = ccid3_hc_tx_sk(sk)->t_rto;
 569         info->tcpi_rtt = ccid3_hc_tx_sk(sk)->rtt;
 570 }
 571
 572 static int ccid3_hc_tx_getsockopt(struct sock *sk, const int optname, int len,
 573                                   u32 __user *optval, int __user *optlen)
 574 {
 575         const struct ccid3_hc_tx_sock *hctx = ccid3_hc_tx_sk(sk);
 576         struct tfrc_tx_info tfrc;
 577         const void *val;
 578
 579         switch (optname) {
 580         case DCCP_SOCKOPT_CCID_TX_INFO:
 581                 if (len < sizeof(tfrc))
 582                         return -EINVAL;
 583                 tfrc.tfrctx_x      = hctx->x;
 584                 tfrc.tfrctx_x_recv = hctx->x_recv;
 585                 tfrc.tfrctx_x_calc = hctx->x_calc;
 586                 tfrc.tfrctx_rtt    = hctx->rtt;
 587                 tfrc.tfrctx_p      = hctx->p;
 588                 tfrc.tfrctx_rto    = hctx->t_rto;
 589                 tfrc.tfrctx_ipi    = hctx->t_ipi;
 590                 len = sizeof(tfrc);
 591                 val = &tfrc;
 592                 break;
 593         default:
 594                 return -ENOPROTOOPT;
 595         }
 596
 597         if (put_user(len, optlen) || copy_to_user(optval, val, len))
 598                 return -EFAULT;
 599
 600         return 0;
 601 }
 602
 603 /*
 604  *      Receiver Half-Connection Routines
 605  */
 606
 607 /* CCID3 feedback types */
 608 enum ccid3_fback_type {
 609         CCID3_FBACK_NONE = 0,
 610         CCID3_FBACK_INITIAL,
 611         CCID3_FBACK_PERIODIC,
 612         CCID3_FBACK_PARAM_CHANGE
 613 };
 614
 615 #ifdef CONFIG_IP_DCCP_CCID3_DEBUG
 616 static const char *ccid3_rx_state_name(enum ccid3_hc_rx_states state)
 617 {
 618         static char *ccid3_rx_state_names[] = {
 619         [TFRC_RSTATE_NO_DATA] = "NO_DATA",
 620         [TFRC_RSTATE_DATA]    = "DATA",
 621         [TFRC_RSTATE_TERM]    = "TERM",
 622         };
 623
 624         return ccid3_rx_state_names[state];
 625 }
 626 #endif
 627
 628 static void ccid3_hc_rx_set_state(struct sock *sk,
 629                                   enum ccid3_hc_rx_states state)
 630 {
 631         struct ccid3_hc_rx_sock *hcrx = ccid3_hc_rx_sk(sk);
 632         enum ccid3_hc_rx_states oldstate = hcrx->state;
 633
 634         ccid3_pr_debug("%s(%p) %-8.8s -> %s\n",
 635                        dccp_role(sk), sk, ccid3_rx_state_name(oldstate),
 636                        ccid3_rx_state_name(state));
 637         WARN_ON(state == oldstate);
 638         hcrx->state = state;
 639 }
 640
 641 static void ccid3_hc_rx_send_feedback(struct sock *sk,
 642                                       const struct sk_buff *skb,
 643                                       enum ccid3_fback_type fbtype)
 644 {
 645         struct ccid3_hc_rx_sock *hcrx = ccid3_hc_rx_sk(sk);
 646         struct dccp_sock *dp = dccp_sk(sk);
 647         ktime_t now;
 648         s64 delta = 0;
 649
 650         if (unlikely(hcrx->state == TFRC_RSTATE_TERM))
 651                 return;
 652
 653         now = ktime_get_real();
 654
 655         switch (fbtype) {
 656         case CCID3_FBACK_INITIAL:
 657                 hcrx->x_recv = 0;
 658                 hcrx->p_inverse = ~0U;   /* see RFC 4342, 8.5 */
 659                 break;
 660         case CCID3_FBACK_PARAM_CHANGE:
 661                 /*
 662                  * When parameters change (new loss or p > p_prev), we do not
 663                  * have a reliable estimate for R_m of [RFC 3448, 6.2] and so
 664                  * need to  reuse the previous value of X_recv. However, when
 665                  * X_recv was 0 (due to early loss), this would kill X down to
 666                  * s/t_mbi (i.e. one packet in 64 seconds).
 667                  * To avoid such drastic reduction, we approximate X_recv as
 668                  * the number of bytes since last feedback.
 669                  * This is a safe fallback, since X is bounded above by X_calc.
 670                  */
 671                 if (hcrx->x_recv > 0)
 672                         break;
 673                 /* fall through */
 674         case CCID3_FBACK_PERIODIC:
 675                 delta = ktime_us_delta(now, hcrx->tstamp_last_feedback);
 676                 if (delta <= 0)
 677                         DCCP_BUG("delta (%ld) <= 0", (long)delta);
 678                 else
 679                         hcrx->x_recv = scaled_div32(hcrx->bytes_recv, delta);
 680                 break;
 681         default:
 682                 return;
 683         }
 684
 685         ccid3_pr_debug("Interval %ldusec, X_recv=%u, 1/p=%u\n",
 686                        (long)delta, hcrx->x_recv, hcrx->p_inverse);
 687
 688         hcrx->tstamp_last_feedback = now;
 689         hcrx->last_counter         = dccp_hdr(skb)->dccph_ccval;
 690         hcrx->bytes_recv           = 0;
 691
 692         dp->dccps_hc_rx_insert_options = 1;
 693         dccp_send_ack(sk);
 694 }
 695
 696 static int ccid3_hc_rx_insert_options(struct sock *sk, struct sk_buff *skb)
 697 {
 698         const struct ccid3_hc_rx_sock *hcrx = ccid3_hc_rx_sk(sk);
 699         __be32 x_recv, pinv;
 700
 701         if (!(sk->sk_state == DCCP_OPEN || sk->sk_state == DCCP_PARTOPEN))
 702                 return 0;
 703
 704         if (dccp_packet_without_ack(skb))
 705                 return 0;
 706
 707         x_recv = htonl(hcrx->x_recv);
 708         pinv   = htonl(hcrx->p_inverse);
 709
 710         if (dccp_insert_option(sk, skb, TFRC_OPT_LOSS_EVENT_RATE,
 711                                &pinv, sizeof(pinv)) ||
 712             dccp_insert_option(sk, skb, TFRC_OPT_RECEIVE_RATE,
 713                                &x_recv, sizeof(x_recv)))
 714                 return -1;
 715
 716         return 0;
 717 }
 718
 719 /** ccid3_first_li  -  Implements [RFC 3448, 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 *hcrx = ccid3_hc_rx_sk(sk);
 731         u32 x_recv, p, delta;
 732         u64 fval;
 733
 734         if (hcrx->rtt == 0) {
 735                 DCCP_WARN("No RTT estimate available, using fallback RTT\n");
 736                 hcrx->rtt = DCCP_FALLBACK_RTT;
 737         }
 738
 739         delta = ktime_to_us(net_timedelta(hcrx->tstamp_last_feedback));
 740         x_recv = scaled_div32(hcrx->bytes_recv, delta);
 741         if (x_recv == 0) {              /* would also trigger divide-by-zero */
 742                 DCCP_WARN("X_recv==0\n");
 743                 if (hcrx->x_recv == 0) {
 744                         DCCP_BUG("stored value of X_recv is zero");
 745                         return ~0U;
 746                 }
 747                 x_recv = hcrx->x_recv;
 748         }
 749
 750         fval = scaled_div(hcrx->s, hcrx->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 *hcrx = 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(hcrx->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                         hcrx->s = payload;
 773                         /*
 774                          * Not necessary to update 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(&hcrx->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                 hcrx->s = tfrc_ewma(hcrx->s, payload, 9);
 791                 hcrx->bytes_recv += payload;
 792         }
 793
 794         /*
 795          * Perform loss detection and handle pending losses
 796          */
 797         if (tfrc_rx_handle_loss(&hcrx->hist, &hcrx->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(&hcrx->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(&hcrx->li_hist)) {
 813                 const u32 sample = tfrc_rx_hist_sample_rtt(&hcrx->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                         hcrx->rtt = tfrc_ewma(hcrx->rtt, sample, 9);
 821
 822         } else if (tfrc_lh_update_i_mean(&hcrx->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, hcrx->last_counter) > 3)
 834                 do_feedback = CCID3_FBACK_PERIODIC;
 835
 836 update_records:
 837         tfrc_rx_hist_add_packet(&hcrx->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 *hcrx = ccid_priv(ccid);
 847
 848         hcrx->state = TFRC_RSTATE_NO_DATA;
 849         tfrc_lh_init(&hcrx->li_hist);
 850         return tfrc_rx_hist_alloc(&hcrx->hist);
 851 }
 852
 853 static void ccid3_hc_rx_exit(struct sock *sk)
 854 {
 855         struct ccid3_hc_rx_sock *hcrx = ccid3_hc_rx_sk(sk);
 856
 857         ccid3_hc_rx_set_state(sk, TFRC_RSTATE_TERM);
 858
 859         tfrc_rx_hist_purge(&hcrx->hist);
 860         tfrc_lh_cleanup(&hcrx->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)->state;
 866         info->tcpi_options  |= TCPI_OPT_TIMESTAMPS;
 867         info->tcpi_rcv_rtt  = ccid3_hc_rx_sk(sk)->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 *hcrx = 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 = hcrx->x_recv;
 882                 rx_info.tfrcrx_rtt    = hcrx->rtt;
 883                 rx_info.tfrcrx_p      = hcrx->p_inverse == 0 ? ~0U :
 884                                            scaled_div(1, hcrx->p_inverse);
 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 static struct ccid_operations ccid3 = {
 899         .ccid_id                   = DCCPC_CCID3,
 900         .ccid_name                 = "TCP-Friendly Rate Control",
 901         .ccid_owner                = THIS_MODULE,
 902         .ccid_hc_tx_obj_size       = sizeof(struct ccid3_hc_tx_sock),
 903         .ccid_hc_tx_init           = ccid3_hc_tx_init,
 904         .ccid_hc_tx_exit           = ccid3_hc_tx_exit,
 905         .ccid_hc_tx_send_packet    = ccid3_hc_tx_send_packet,
 906         .ccid_hc_tx_packet_sent    = ccid3_hc_tx_packet_sent,
 907         .ccid_hc_tx_packet_recv    = ccid3_hc_tx_packet_recv,
 908         .ccid_hc_tx_parse_options  = ccid3_hc_tx_parse_options,
 909         .ccid_hc_rx_obj_size       = sizeof(struct ccid3_hc_rx_sock),
 910         .ccid_hc_rx_init           = ccid3_hc_rx_init,
 911         .ccid_hc_rx_exit           = ccid3_hc_rx_exit,
 912         .ccid_hc_rx_insert_options = ccid3_hc_rx_insert_options,
 913         .ccid_hc_rx_packet_recv    = ccid3_hc_rx_packet_recv,
 914         .ccid_hc_rx_get_info       = ccid3_hc_rx_get_info,
 915         .ccid_hc_tx_get_info       = ccid3_hc_tx_get_info,
 916         .ccid_hc_rx_getsockopt     = ccid3_hc_rx_getsockopt,
 917         .ccid_hc_tx_getsockopt     = ccid3_hc_tx_getsockopt,
 918 };
 919
 920 #ifdef CONFIG_IP_DCCP_CCID3_DEBUG
 921 module_param(ccid3_debug, bool, 0644);
 922 MODULE_PARM_DESC(ccid3_debug, "Enable debug messages");
 923 #endif
 924
 925 static __init int ccid3_module_init(void)
 926 {
 927         return ccid_register(&ccid3);
 928 }
 929 module_init(ccid3_module_init);
 930
 931 static __exit void ccid3_module_exit(void)
 932 {
 933         ccid_unregister(&ccid3);
 934 }
 935 module_exit(ccid3_module_exit);
 936
 937 MODULE_AUTHOR("Ian McDonald <ian.mcdonald@jandi.co.nz>, "
 938               "Arnaldo Carvalho de Melo <acme@ghostprotocols.net>");
 939 MODULE_DESCRIPTION("DCCP TFRC CCID3 CCID");
 940 MODULE_LICENSE("GPL");
 941 MODULE_ALIAS("net-dccp-ccid-3");