net/sctp/transport.c

   1 /* SCTP kernel reference Implementation
   2  * Copyright (c) 1999-2000 Cisco, Inc.
   3  * Copyright (c) 1999-2001 Motorola, Inc.
   4  * Copyright (c) 2001-2003 International Business Machines Corp.
   5  * Copyright (c) 2001 Intel Corp.
   6  * Copyright (c) 2001 La Monte H.P. Yarroll
   7  *
   8  * This file is part of the SCTP kernel reference Implementation
   9  *
  10  * This module provides the abstraction for an SCTP tranport representing
  11  * a remote transport address.  For local transport addresses, we just use
  12  * union sctp_addr.
  13  *
  14  * The SCTP reference implementation is free software;
  15  * you can redistribute it and/or modify it under the terms of
  16  * the GNU General Public License as published by
  17  * the Free Software Foundation; either version 2, or (at your option)
  18  * any later version.
  19  *
  20  * The SCTP reference implementation is distributed in the hope that it
  21  * will be useful, but WITHOUT ANY WARRANTY; without even the implied
  22  *                 ************************
  23  * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  24  * See the GNU General Public License for more details.
  25  *
  26  * You should have received a copy of the GNU General Public License
  27  * along with GNU CC; see the file COPYING.  If not, write to
  28  * the Free Software Foundation, 59 Temple Place - Suite 330,
  29  * Boston, MA 02111-1307, USA.
  30  *
  31  * Please send any bug reports or fixes you make to the
  32  * email address(es):
  33  *    lksctp developers <lksctp-developers@lists.sourceforge.net>
  34  *
  35  * Or submit a bug report through the following website:
  36  *    http://www.sf.net/projects/lksctp
  37  *
  38  * Written or modified by:
  39  *    La Monte H.P. Yarroll <piggy@acm.org>
  40  *    Karl Knutson          <karl@athena.chicago.il.us>
  41  *    Jon Grimm             <jgrimm@us.ibm.com>
  42  *    Xingang Guo           <xingang.guo@intel.com>
  43  *    Hui Huang             <hui.huang@nokia.com>
  44  *    Sridhar Samudrala     <sri@us.ibm.com>
  45  *    Ardelle Fan           <ardelle.fan@intel.com>
  46  *
  47  * Any bugs reported given to us we will try to fix... any fixes shared will
  48  * be incorporated into the next SCTP release.
  49  */
  50
  51 #include <linux/types.h>
  52 #include <linux/random.h>
  53 #include <net/sctp/sctp.h>
  54 #include <net/sctp/sm.h>
  55
  56 /* 1st Level Abstractions.  */
  57
  58 /* Initialize a new transport from provided memory.  */
  59 static struct sctp_transport *sctp_transport_init(struct sctp_transport *peer,
  60                                                   const union sctp_addr *addr,
  61                                                   gfp_t gfp)
  62 {
  63         /* Copy in the address.  */
  64         peer->ipaddr = *addr;
  65         flip_to_h(&peer->ipaddr_h, &peer->ipaddr);
  66         peer->af_specific = sctp_get_af_specific(addr->sa.sa_family);
  67         peer->asoc = NULL;
  68
  69         peer->dst = NULL;
  70         memset(&peer->saddr, 0, sizeof(union sctp_addr));
  71         memset(&peer->saddr_h, 0, sizeof(union sctp_addr));
  72
  73         /* From 6.3.1 RTO Calculation:
  74          *
  75          * C1) Until an RTT measurement has been made for a packet sent to the
  76          * given destination transport address, set RTO to the protocol
  77          * parameter 'RTO.Initial'.
  78          */
  79         peer->rtt = 0;
  80         peer->rto = msecs_to_jiffies(sctp_rto_initial);
  81         peer->rttvar = 0;
  82         peer->srtt = 0;
  83         peer->rto_pending = 0;
  84
  85         peer->last_time_heard = jiffies;
  86         peer->last_time_used = jiffies;
  87         peer->last_time_ecne_reduced = jiffies;
  88
  89         peer->init_sent_count = 0;
  90
  91         peer->param_flags = SPP_HB_DISABLE |
  92                             SPP_PMTUD_ENABLE |
  93                             SPP_SACKDELAY_ENABLE;
  94         peer->hbinterval  = 0;
  95
  96         /* Initialize the default path max_retrans.  */
  97         peer->pathmaxrxt  = sctp_max_retrans_path;
  98         peer->error_count = 0;
  99
 100         INIT_LIST_HEAD(&peer->transmitted);
 101         INIT_LIST_HEAD(&peer->send_ready);
 102         INIT_LIST_HEAD(&peer->transports);
 103
 104         /* Set up the retransmission timer.  */
 105         init_timer(&peer->T3_rtx_timer);
 106         peer->T3_rtx_timer.function = sctp_generate_t3_rtx_event;
 107         peer->T3_rtx_timer.data = (unsigned long)peer;
 108
 109         /* Set up the heartbeat timer. */
 110         init_timer(&peer->hb_timer);
 111         peer->hb_timer.function = sctp_generate_heartbeat_event;
 112         peer->hb_timer.data = (unsigned long)peer;
 113
 114         /* Initialize the 64-bit random nonce sent with heartbeat. */
 115         get_random_bytes(&peer->hb_nonce, sizeof(peer->hb_nonce));
 116
 117         atomic_set(&peer->refcnt, 1);
 118         peer->dead = 0;
 119
 120         peer->malloced = 0;
 121
 122         /* Initialize the state information for SFR-CACC */
 123         peer->cacc.changeover_active = 0;
 124         peer->cacc.cycling_changeover = 0;
 125         peer->cacc.next_tsn_at_change = 0;
 126         peer->cacc.cacc_saw_newack = 0;
 127
 128         return peer;
 129 }
 130
 131 /* Allocate and initialize a new transport.  */
 132 struct sctp_transport *sctp_transport_new(const union sctp_addr *addr,
 133                                           gfp_t gfp)
 134 {
 135         struct sctp_transport *transport;
 136
 137         transport = t_new(struct sctp_transport, gfp);
 138         if (!transport)
 139                 goto fail;
 140
 141         if (!sctp_transport_init(transport, addr, gfp))
 142                 goto fail_init;
 143
 144         transport->malloced = 1;
 145         SCTP_DBG_OBJCNT_INC(transport);
 146
 147         return transport;
 148
 149 fail_init:
 150         kfree(transport);
 151
 152 fail:
 153         return NULL;
 154 }
 155
 156 /* This transport is no longer needed.  Free up if possible, or
 157  * delay until it last reference count.
 158  */
 159 void sctp_transport_free(struct sctp_transport *transport)
 160 {
 161         transport->dead = 1;
 162
 163         /* Try to delete the heartbeat timer.  */
 164         if (del_timer(&transport->hb_timer))
 165                 sctp_transport_put(transport);
 166
 167         /* Delete the T3_rtx timer if it's active.
 168          * There is no point in not doing this now and letting
 169          * structure hang around in memory since we know
 170          * the tranport is going away.
 171          */
 172         if (timer_pending(&transport->T3_rtx_timer) &&
 173             del_timer(&transport->T3_rtx_timer))
 174                 sctp_transport_put(transport);
 175
 176
 177         sctp_transport_put(transport);
 178 }
 179
 180 /* Destroy the transport data structure.
 181  * Assumes there are no more users of this structure.
 182  */
 183 static void sctp_transport_destroy(struct sctp_transport *transport)
 184 {
 185         SCTP_ASSERT(transport->dead, "Transport is not dead", return);
 186
 187         if (transport->asoc)
 188                 sctp_association_put(transport->asoc);
 189
 190         sctp_packet_free(&transport->packet);
 191
 192         dst_release(transport->dst);
 193         kfree(transport);
 194         SCTP_DBG_OBJCNT_DEC(transport);
 195 }
 196
 197 /* Start T3_rtx timer if it is not already running and update the heartbeat
 198  * timer.  This routine is called every time a DATA chunk is sent.
 199  */
 200 void sctp_transport_reset_timers(struct sctp_transport *transport)
 201 {
 202         /* RFC 2960 6.3.2 Retransmission Timer Rules
 203          *
 204          * R1) Every time a DATA chunk is sent to any address(including a
 205          * retransmission), if the T3-rtx timer of that address is not running
 206          * start it running so that it will expire after the RTO of that
 207          * address.
 208          */
 209
 210         if (!timer_pending(&transport->T3_rtx_timer))
 211                 if (!mod_timer(&transport->T3_rtx_timer,
 212                                jiffies + transport->rto))
 213                         sctp_transport_hold(transport);
 214
 215         /* When a data chunk is sent, reset the heartbeat interval.  */
 216         if (!mod_timer(&transport->hb_timer,
 217                        sctp_transport_timeout(transport)))
 218             sctp_transport_hold(transport);
 219 }
 220
 221 /* This transport has been assigned to an association.
 222  * Initialize fields from the association or from the sock itself.
 223  * Register the reference count in the association.
 224  */
 225 void sctp_transport_set_owner(struct sctp_transport *transport,
 226                               struct sctp_association *asoc)
 227 {
 228         transport->asoc = asoc;
 229         sctp_association_hold(asoc);
 230 }
 231
 232 /* Initialize the pmtu of a transport. */
 233 void sctp_transport_pmtu(struct sctp_transport *transport)
 234 {
 235         struct dst_entry *dst;
 236
 237         dst = transport->af_specific->get_dst(NULL, &transport->ipaddr_h, NULL);
 238
 239         if (dst) {
 240                 transport->pathmtu = dst_mtu(dst);
 241                 dst_release(dst);
 242         } else
 243                 transport->pathmtu = SCTP_DEFAULT_MAXSEGMENT;
 244 }
 245
 246 /* Caches the dst entry and source address for a transport's destination
 247  * address.
 248  */
 249 void sctp_transport_route(struct sctp_transport *transport,
 250                           union sctp_addr *saddr, struct sctp_sock *opt)
 251 {
 252         struct sctp_association *asoc = transport->asoc;
 253         struct sctp_af *af = transport->af_specific;
 254         union sctp_addr *daddr = &transport->ipaddr_h;
 255         struct dst_entry *dst;
 256
 257         dst = af->get_dst(asoc, daddr, saddr);
 258
 259         if (saddr) {
 260                 memcpy(&transport->saddr_h, saddr, sizeof(union sctp_addr));
 261                 flip_to_n(&transport->saddr, &transport->saddr_h);
 262         } else {
 263                 af->get_saddr(asoc, dst, &transport->ipaddr, &transport->saddr);
 264                 flip_to_h(&transport->saddr_h, &transport->saddr);
 265         }
 266
 267         transport->dst = dst;
 268         if ((transport->param_flags & SPP_PMTUD_DISABLE) && transport->pathmtu) {
 269                 return;
 270         }
 271         if (dst) {
 272                 transport->pathmtu = dst_mtu(dst);
 273
 274                 /* Initialize sk->sk_rcv_saddr, if the transport is the
 275                  * association's active path for getsockname().
 276                  */
 277                 if (asoc && (transport == asoc->peer.active_path))
 278                         opt->pf->af->to_sk_saddr(&transport->saddr_h,
 279                                                  asoc->base.sk);
 280         } else
 281                 transport->pathmtu = SCTP_DEFAULT_MAXSEGMENT;
 282 }
 283
 284 /* Hold a reference to a transport.  */
 285 void sctp_transport_hold(struct sctp_transport *transport)
 286 {
 287         atomic_inc(&transport->refcnt);
 288 }
 289
 290 /* Release a reference to a transport and clean up
 291  * if there are no more references.
 292  */
 293 void sctp_transport_put(struct sctp_transport *transport)
 294 {
 295         if (atomic_dec_and_test(&transport->refcnt))
 296                 sctp_transport_destroy(transport);
 297 }
 298
 299 /* Update transport's RTO based on the newly calculated RTT. */
 300 void sctp_transport_update_rto(struct sctp_transport *tp, __u32 rtt)
 301 {
 302         /* Check for valid transport.  */
 303         SCTP_ASSERT(tp, "NULL transport", return);
 304
 305         /* We should not be doing any RTO updates unless rto_pending is set.  */
 306         SCTP_ASSERT(tp->rto_pending, "rto_pending not set", return);
 307
 308         if (tp->rttvar || tp->srtt) {
 309                 /* 6.3.1 C3) When a new RTT measurement R' is made, set
 310                  * RTTVAR <- (1 - RTO.Beta) * RTTVAR + RTO.Beta * |SRTT - R'|
 311                  * SRTT <- (1 - RTO.Alpha) * SRTT + RTO.Alpha * R'
 312                  */
 313
 314                 /* Note:  The above algorithm has been rewritten to
 315                  * express rto_beta and rto_alpha as inverse powers
 316                  * of two.
 317                  * For example, assuming the default value of RTO.Alpha of
 318                  * 1/8, rto_alpha would be expressed as 3.
 319                  */
 320                 tp->rttvar = tp->rttvar - (tp->rttvar >> sctp_rto_beta)
 321                         + ((abs(tp->srtt - rtt)) >> sctp_rto_beta);
 322                 tp->srtt = tp->srtt - (tp->srtt >> sctp_rto_alpha)
 323                         + (rtt >> sctp_rto_alpha);
 324         } else {
 325                 /* 6.3.1 C2) When the first RTT measurement R is made, set
 326                  * SRTT <- R, RTTVAR <- R/2.
 327                  */
 328                 tp->srtt = rtt;
 329                 tp->rttvar = rtt >> 1;
 330         }
 331
 332         /* 6.3.1 G1) Whenever RTTVAR is computed, if RTTVAR = 0, then
 333          * adjust RTTVAR <- G, where G is the CLOCK GRANULARITY.
 334          */
 335         if (tp->rttvar == 0)
 336                 tp->rttvar = SCTP_CLOCK_GRANULARITY;
 337
 338         /* 6.3.1 C3) After the computation, update RTO <- SRTT + 4 * RTTVAR. */
 339         tp->rto = tp->srtt + (tp->rttvar << 2);
 340
 341         /* 6.3.1 C6) Whenever RTO is computed, if it is less than RTO.Min
 342          * seconds then it is rounded up to RTO.Min seconds.
 343          */
 344         if (tp->rto < tp->asoc->rto_min)
 345                 tp->rto = tp->asoc->rto_min;
 346
 347         /* 6.3.1 C7) A maximum value may be placed on RTO provided it is
 348          * at least RTO.max seconds.
 349          */
 350         if (tp->rto > tp->asoc->rto_max)
 351                 tp->rto = tp->asoc->rto_max;
 352
 353         tp->rtt = rtt;
 354
 355         /* Reset rto_pending so that a new RTT measurement is started when a
 356          * new data chunk is sent.
 357          */
 358         tp->rto_pending = 0;
 359
 360         SCTP_DEBUG_PRINTK("%s: transport: %p, rtt: %d, srtt: %d "
 361                           "rttvar: %d, rto: %ld\n", __FUNCTION__,
 362                           tp, rtt, tp->srtt, tp->rttvar, tp->rto);
 363 }
 364
 365 /* This routine updates the transport's cwnd and partial_bytes_acked
 366  * parameters based on the bytes acked in the received SACK.
 367  */
 368 void sctp_transport_raise_cwnd(struct sctp_transport *transport,
 369                                __u32 sack_ctsn, __u32 bytes_acked)
 370 {
 371         __u32 cwnd, ssthresh, flight_size, pba, pmtu;
 372
 373         cwnd = transport->cwnd;
 374         flight_size = transport->flight_size;
 375
 376         /* The appropriate cwnd increase algorithm is performed if, and only
 377          * if the cumulative TSN has advanced and the congestion window is
 378          * being fully utilized.
 379          */
 380         if ((transport->asoc->ctsn_ack_point >= sack_ctsn) ||
 381             (flight_size < cwnd))
 382                 return;
 383
 384         ssthresh = transport->ssthresh;
 385         pba = transport->partial_bytes_acked;
 386         pmtu = transport->asoc->pathmtu;
 387
 388         if (cwnd <= ssthresh) {
 389                 /* RFC 2960 7.2.1, sctpimpguide-05 2.14.2 When cwnd is less
 390                  * than or equal to ssthresh an SCTP endpoint MUST use the
 391                  * slow start algorithm to increase cwnd only if the current
 392                  * congestion window is being fully utilized and an incoming
 393                  * SACK advances the Cumulative TSN Ack Point. Only when these
 394                  * two conditions are met can the cwnd be increased otherwise
 395                  * the cwnd MUST not be increased. If these conditions are met
 396                  * then cwnd MUST be increased by at most the lesser of
 397                  * 1) the total size of the previously outstanding DATA
 398                  * chunk(s) acknowledged, and 2) the destination's path MTU.
 399                  */
 400                 if (bytes_acked > pmtu)
 401                         cwnd += pmtu;
 402                 else
 403                         cwnd += bytes_acked;
 404                 SCTP_DEBUG_PRINTK("%s: SLOW START: transport: %p, "
 405                                   "bytes_acked: %d, cwnd: %d, ssthresh: %d, "
 406                                   "flight_size: %d, pba: %d\n",
 407                                   __FUNCTION__,
 408                                   transport, bytes_acked, cwnd,
 409                                   ssthresh, flight_size, pba);
 410         } else {
 411                 /* RFC 2960 7.2.2 Whenever cwnd is greater than ssthresh,
 412                  * upon each SACK arrival that advances the Cumulative TSN Ack
 413                  * Point, increase partial_bytes_acked by the total number of
 414                  * bytes of all new chunks acknowledged in that SACK including
 415                  * chunks acknowledged by the new Cumulative TSN Ack and by
 416                  * Gap Ack Blocks.
 417                  *
 418                  * When partial_bytes_acked is equal to or greater than cwnd
 419                  * and before the arrival of the SACK the sender had cwnd or
 420                  * more bytes of data outstanding (i.e., before arrival of the
 421                  * SACK, flightsize was greater than or equal to cwnd),
 422                  * increase cwnd by MTU, and reset partial_bytes_acked to
 423                  * (partial_bytes_acked - cwnd).
 424                  */
 425                 pba += bytes_acked;
 426                 if (pba >= cwnd) {
 427                         cwnd += pmtu;
 428                         pba = ((cwnd < pba) ? (pba - cwnd) : 0);
 429                 }
 430                 SCTP_DEBUG_PRINTK("%s: CONGESTION AVOIDANCE: "
 431                                   "transport: %p, bytes_acked: %d, cwnd: %d, "
 432                                   "ssthresh: %d, flight_size: %d, pba: %d\n",
 433                                   __FUNCTION__,
 434                                   transport, bytes_acked, cwnd,
 435                                   ssthresh, flight_size, pba);
 436         }
 437
 438         transport->cwnd = cwnd;
 439         transport->partial_bytes_acked = pba;
 440 }
 441
 442 /* This routine is used to lower the transport's cwnd when congestion is
 443  * detected.
 444  */
 445 void sctp_transport_lower_cwnd(struct sctp_transport *transport,
 446                                sctp_lower_cwnd_t reason)
 447 {
 448         switch (reason) {
 449         case SCTP_LOWER_CWND_T3_RTX:
 450                 /* RFC 2960 Section 7.2.3, sctpimpguide
 451                  * When the T3-rtx timer expires on an address, SCTP should
 452                  * perform slow start by:
 453                  *      ssthresh = max(cwnd/2, 4*MTU)
 454                  *      cwnd = 1*MTU
 455                  *      partial_bytes_acked = 0
 456                  */
 457                 transport->ssthresh = max(transport->cwnd/2,
 458                                           4*transport->asoc->pathmtu);
 459                 transport->cwnd = transport->asoc->pathmtu;
 460                 break;
 461
 462         case SCTP_LOWER_CWND_FAST_RTX:
 463                 /* RFC 2960 7.2.4 Adjust the ssthresh and cwnd of the
 464                  * destination address(es) to which the missing DATA chunks
 465                  * were last sent, according to the formula described in
 466                  * Section 7.2.3.
 467                  *
 468                  * RFC 2960 7.2.3, sctpimpguide Upon detection of packet
 469                  * losses from SACK (see Section 7.2.4), An endpoint
 470                  * should do the following:
 471                  *      ssthresh = max(cwnd/2, 4*MTU)
 472                  *      cwnd = ssthresh
 473                  *      partial_bytes_acked = 0
 474                  */
 475                 transport->ssthresh = max(transport->cwnd/2,
 476                                           4*transport->asoc->pathmtu);
 477                 transport->cwnd = transport->ssthresh;
 478                 break;
 479
 480         case SCTP_LOWER_CWND_ECNE:
 481                 /* RFC 2481 Section 6.1.2.
 482                  * If the sender receives an ECN-Echo ACK packet
 483                  * then the sender knows that congestion was encountered in the
 484                  * network on the path from the sender to the receiver. The
 485                  * indication of congestion should be treated just as a
 486                  * congestion loss in non-ECN Capable TCP. That is, the TCP
 487                  * source halves the congestion window "cwnd" and reduces the
 488                  * slow start threshold "ssthresh".
 489                  * A critical condition is that TCP does not react to
 490                  * congestion indications more than once every window of
 491                  * data (or more loosely more than once every round-trip time).
 492                  */
 493                 if ((jiffies - transport->last_time_ecne_reduced) >
 494                     transport->rtt) {
 495                         transport->ssthresh = max(transport->cwnd/2,
 496                                                   4*transport->asoc->pathmtu);
 497                         transport->cwnd = transport->ssthresh;
 498                         transport->last_time_ecne_reduced = jiffies;
 499                 }
 500                 break;
 501
 502         case SCTP_LOWER_CWND_INACTIVE:
 503                 /* RFC 2960 Section 7.2.1, sctpimpguide
 504                  * When the endpoint does not transmit data on a given
 505                  * transport address, the cwnd of the transport address
 506                  * should be adjusted to max(cwnd/2, 4*MTU) per RTO.
 507                  * NOTE: Although the draft recommends that this check needs
 508                  * to be done every RTO interval, we do it every hearbeat
 509                  * interval.
 510                  */
 511                 if ((jiffies - transport->last_time_used) > transport->rto)
 512                         transport->cwnd = max(transport->cwnd/2,
 513                                                  4*transport->asoc->pathmtu);
 514                 break;
 515         };
 516
 517         transport->partial_bytes_acked = 0;
 518         SCTP_DEBUG_PRINTK("%s: transport: %p reason: %d cwnd: "
 519                           "%d ssthresh: %d\n", __FUNCTION__,
 520                           transport, reason,
 521                           transport->cwnd, transport->ssthresh);
 522 }
 523
 524 /* What is the next timeout value for this transport? */
 525 unsigned long sctp_transport_timeout(struct sctp_transport *t)
 526 {
 527         unsigned long timeout;
 528         timeout = t->rto + sctp_jitter(t->rto);
 529         if (t->state != SCTP_UNCONFIRMED)
 530                 timeout += t->hbinterval;
 531         timeout += jiffies;
 532         return timeout;
 533 }