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