Pull pvops into release branch
[linux-2.6] / net / sctp / transport.c
1 /* SCTP kernel 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 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  * This SCTP 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  * This SCTP 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         peer->af_specific = sctp_get_af_specific(addr->sa.sa_family);
66         peer->asoc = NULL;
67
68         peer->dst = NULL;
69         memset(&peer->saddr, 0, sizeof(union sctp_addr));
70
71         /* From 6.3.1 RTO Calculation:
72          *
73          * C1) Until an RTT measurement has been made for a packet sent to the
74          * given destination transport address, set RTO to the protocol
75          * parameter 'RTO.Initial'.
76          */
77         peer->last_rto = peer->rto = msecs_to_jiffies(sctp_rto_initial);
78         peer->rtt = 0;
79         peer->rttvar = 0;
80         peer->srtt = 0;
81         peer->rto_pending = 0;
82         peer->fast_recovery = 0;
83
84         peer->last_time_heard = jiffies;
85         peer->last_time_used = jiffies;
86         peer->last_time_ecne_reduced = jiffies;
87
88         peer->init_sent_count = 0;
89
90         peer->param_flags = SPP_HB_DISABLE |
91                             SPP_PMTUD_ENABLE |
92                             SPP_SACKDELAY_ENABLE;
93         peer->hbinterval  = 0;
94
95         /* Initialize the default path max_retrans.  */
96         peer->pathmaxrxt  = sctp_max_retrans_path;
97         peer->error_count = 0;
98
99         INIT_LIST_HEAD(&peer->transmitted);
100         INIT_LIST_HEAD(&peer->send_ready);
101         INIT_LIST_HEAD(&peer->transports);
102
103         setup_timer(&peer->T3_rtx_timer, sctp_generate_t3_rtx_event,
104                         (unsigned long)peer);
105         setup_timer(&peer->hb_timer, sctp_generate_heartbeat_event,
106                         (unsigned long)peer);
107
108         /* Initialize the 64-bit random nonce sent with heartbeat. */
109         get_random_bytes(&peer->hb_nonce, sizeof(peer->hb_nonce));
110
111         atomic_set(&peer->refcnt, 1);
112         peer->dead = 0;
113
114         peer->malloced = 0;
115
116         /* Initialize the state information for SFR-CACC */
117         peer->cacc.changeover_active = 0;
118         peer->cacc.cycling_changeover = 0;
119         peer->cacc.next_tsn_at_change = 0;
120         peer->cacc.cacc_saw_newack = 0;
121
122         return peer;
123 }
124
125 /* Allocate and initialize a new transport.  */
126 struct sctp_transport *sctp_transport_new(const union sctp_addr *addr,
127                                           gfp_t gfp)
128 {
129         struct sctp_transport *transport;
130
131         transport = t_new(struct sctp_transport, gfp);
132         if (!transport)
133                 goto fail;
134
135         if (!sctp_transport_init(transport, addr, gfp))
136                 goto fail_init;
137
138         transport->malloced = 1;
139         SCTP_DBG_OBJCNT_INC(transport);
140
141         return transport;
142
143 fail_init:
144         kfree(transport);
145
146 fail:
147         return NULL;
148 }
149
150 /* This transport is no longer needed.  Free up if possible, or
151  * delay until it last reference count.
152  */
153 void sctp_transport_free(struct sctp_transport *transport)
154 {
155         transport->dead = 1;
156
157         /* Try to delete the heartbeat timer.  */
158         if (del_timer(&transport->hb_timer))
159                 sctp_transport_put(transport);
160
161         /* Delete the T3_rtx timer if it's active.
162          * There is no point in not doing this now and letting
163          * structure hang around in memory since we know
164          * the tranport is going away.
165          */
166         if (timer_pending(&transport->T3_rtx_timer) &&
167             del_timer(&transport->T3_rtx_timer))
168                 sctp_transport_put(transport);
169
170
171         sctp_transport_put(transport);
172 }
173
174 /* Destroy the transport data structure.
175  * Assumes there are no more users of this structure.
176  */
177 static void sctp_transport_destroy(struct sctp_transport *transport)
178 {
179         SCTP_ASSERT(transport->dead, "Transport is not dead", return);
180
181         if (transport->asoc)
182                 sctp_association_put(transport->asoc);
183
184         sctp_packet_free(&transport->packet);
185
186         dst_release(transport->dst);
187         kfree(transport);
188         SCTP_DBG_OBJCNT_DEC(transport);
189 }
190
191 /* Start T3_rtx timer if it is not already running and update the heartbeat
192  * timer.  This routine is called every time a DATA chunk is sent.
193  */
194 void sctp_transport_reset_timers(struct sctp_transport *transport, int force)
195 {
196         /* RFC 2960 6.3.2 Retransmission Timer Rules
197          *
198          * R1) Every time a DATA chunk is sent to any address(including a
199          * retransmission), if the T3-rtx timer of that address is not running
200          * start it running so that it will expire after the RTO of that
201          * address.
202          */
203
204         if (force || !timer_pending(&transport->T3_rtx_timer))
205                 if (!mod_timer(&transport->T3_rtx_timer,
206                                jiffies + transport->rto))
207                         sctp_transport_hold(transport);
208
209         /* When a data chunk is sent, reset the heartbeat interval.  */
210         if (!mod_timer(&transport->hb_timer,
211                        sctp_transport_timeout(transport)))
212             sctp_transport_hold(transport);
213 }
214
215 /* This transport has been assigned to an association.
216  * Initialize fields from the association or from the sock itself.
217  * Register the reference count in the association.
218  */
219 void sctp_transport_set_owner(struct sctp_transport *transport,
220                               struct sctp_association *asoc)
221 {
222         transport->asoc = asoc;
223         sctp_association_hold(asoc);
224 }
225
226 /* Initialize the pmtu of a transport. */
227 void sctp_transport_pmtu(struct sctp_transport *transport)
228 {
229         struct dst_entry *dst;
230
231         dst = transport->af_specific->get_dst(NULL, &transport->ipaddr, NULL);
232
233         if (dst) {
234                 transport->pathmtu = dst_mtu(dst);
235                 dst_release(dst);
236         } else
237                 transport->pathmtu = SCTP_DEFAULT_MAXSEGMENT;
238 }
239
240 /* this is a complete rip-off from __sk_dst_check
241  * the cookie is always 0 since this is how it's used in the
242  * pmtu code
243  */
244 static struct dst_entry *sctp_transport_dst_check(struct sctp_transport *t)
245 {
246         struct dst_entry *dst = t->dst;
247
248         if (dst && dst->obsolete && dst->ops->check(dst, 0) == NULL) {
249                 dst_release(t->dst);
250                 t->dst = NULL;
251                 return NULL;
252         }
253
254         return dst;
255 }
256
257 void sctp_transport_update_pmtu(struct sctp_transport *t, u32 pmtu)
258 {
259         struct dst_entry *dst;
260
261         if (unlikely(pmtu < SCTP_DEFAULT_MINSEGMENT)) {
262                 printk(KERN_WARNING "%s: Reported pmtu %d too low, "
263                        "using default minimum of %d\n",
264                        __func__, pmtu,
265                        SCTP_DEFAULT_MINSEGMENT);
266                 /* Use default minimum segment size and disable
267                  * pmtu discovery on this transport.
268                  */
269                 t->pathmtu = SCTP_DEFAULT_MINSEGMENT;
270         } else {
271                 t->pathmtu = pmtu;
272         }
273
274         dst = sctp_transport_dst_check(t);
275         if (dst)
276                 dst->ops->update_pmtu(dst, pmtu);
277 }
278
279 /* Caches the dst entry and source address for a transport's destination
280  * address.
281  */
282 void sctp_transport_route(struct sctp_transport *transport,
283                           union sctp_addr *saddr, struct sctp_sock *opt)
284 {
285         struct sctp_association *asoc = transport->asoc;
286         struct sctp_af *af = transport->af_specific;
287         union sctp_addr *daddr = &transport->ipaddr;
288         struct dst_entry *dst;
289
290         dst = af->get_dst(asoc, daddr, saddr);
291
292         if (saddr)
293                 memcpy(&transport->saddr, saddr, sizeof(union sctp_addr));
294         else
295                 af->get_saddr(opt, asoc, dst, daddr, &transport->saddr);
296
297         transport->dst = dst;
298         if ((transport->param_flags & SPP_PMTUD_DISABLE) && transport->pathmtu) {
299                 return;
300         }
301         if (dst) {
302                 transport->pathmtu = dst_mtu(dst);
303
304                 /* Initialize sk->sk_rcv_saddr, if the transport is the
305                  * association's active path for getsockname().
306                  */
307                 if (asoc && (transport == asoc->peer.active_path))
308                         opt->pf->af->to_sk_saddr(&transport->saddr,
309                                                  asoc->base.sk);
310         } else
311                 transport->pathmtu = SCTP_DEFAULT_MAXSEGMENT;
312 }
313
314 /* Hold a reference to a transport.  */
315 void sctp_transport_hold(struct sctp_transport *transport)
316 {
317         atomic_inc(&transport->refcnt);
318 }
319
320 /* Release a reference to a transport and clean up
321  * if there are no more references.
322  */
323 void sctp_transport_put(struct sctp_transport *transport)
324 {
325         if (atomic_dec_and_test(&transport->refcnt))
326                 sctp_transport_destroy(transport);
327 }
328
329 /* Update transport's RTO based on the newly calculated RTT. */
330 void sctp_transport_update_rto(struct sctp_transport *tp, __u32 rtt)
331 {
332         /* Check for valid transport.  */
333         SCTP_ASSERT(tp, "NULL transport", return);
334
335         /* We should not be doing any RTO updates unless rto_pending is set.  */
336         SCTP_ASSERT(tp->rto_pending, "rto_pending not set", return);
337
338         if (tp->rttvar || tp->srtt) {
339                 /* 6.3.1 C3) When a new RTT measurement R' is made, set
340                  * RTTVAR <- (1 - RTO.Beta) * RTTVAR + RTO.Beta * |SRTT - R'|
341                  * SRTT <- (1 - RTO.Alpha) * SRTT + RTO.Alpha * R'
342                  */
343
344                 /* Note:  The above algorithm has been rewritten to
345                  * express rto_beta and rto_alpha as inverse powers
346                  * of two.
347                  * For example, assuming the default value of RTO.Alpha of
348                  * 1/8, rto_alpha would be expressed as 3.
349                  */
350                 tp->rttvar = tp->rttvar - (tp->rttvar >> sctp_rto_beta)
351                         + ((abs(tp->srtt - rtt)) >> sctp_rto_beta);
352                 tp->srtt = tp->srtt - (tp->srtt >> sctp_rto_alpha)
353                         + (rtt >> sctp_rto_alpha);
354         } else {
355                 /* 6.3.1 C2) When the first RTT measurement R is made, set
356                  * SRTT <- R, RTTVAR <- R/2.
357                  */
358                 tp->srtt = rtt;
359                 tp->rttvar = rtt >> 1;
360         }
361
362         /* 6.3.1 G1) Whenever RTTVAR is computed, if RTTVAR = 0, then
363          * adjust RTTVAR <- G, where G is the CLOCK GRANULARITY.
364          */
365         if (tp->rttvar == 0)
366                 tp->rttvar = SCTP_CLOCK_GRANULARITY;
367
368         /* 6.3.1 C3) After the computation, update RTO <- SRTT + 4 * RTTVAR. */
369         tp->rto = tp->srtt + (tp->rttvar << 2);
370
371         /* 6.3.1 C6) Whenever RTO is computed, if it is less than RTO.Min
372          * seconds then it is rounded up to RTO.Min seconds.
373          */
374         if (tp->rto < tp->asoc->rto_min)
375                 tp->rto = tp->asoc->rto_min;
376
377         /* 6.3.1 C7) A maximum value may be placed on RTO provided it is
378          * at least RTO.max seconds.
379          */
380         if (tp->rto > tp->asoc->rto_max)
381                 tp->rto = tp->asoc->rto_max;
382
383         tp->rtt = rtt;
384         tp->last_rto = tp->rto;
385
386         /* Reset rto_pending so that a new RTT measurement is started when a
387          * new data chunk is sent.
388          */
389         tp->rto_pending = 0;
390
391         SCTP_DEBUG_PRINTK("%s: transport: %p, rtt: %d, srtt: %d "
392                           "rttvar: %d, rto: %ld\n", __func__,
393                           tp, rtt, tp->srtt, tp->rttvar, tp->rto);
394 }
395
396 /* This routine updates the transport's cwnd and partial_bytes_acked
397  * parameters based on the bytes acked in the received SACK.
398  */
399 void sctp_transport_raise_cwnd(struct sctp_transport *transport,
400                                __u32 sack_ctsn, __u32 bytes_acked)
401 {
402         __u32 cwnd, ssthresh, flight_size, pba, pmtu;
403
404         cwnd = transport->cwnd;
405         flight_size = transport->flight_size;
406
407         /* See if we need to exit Fast Recovery first */
408         if (transport->fast_recovery &&
409             TSN_lte(transport->fast_recovery_exit, sack_ctsn))
410                 transport->fast_recovery = 0;
411
412         /* The appropriate cwnd increase algorithm is performed if, and only
413          * if the cumulative TSN whould advanced and the congestion window is
414          * being fully utilized.
415          */
416         if (TSN_lte(sack_ctsn, transport->asoc->ctsn_ack_point) ||
417             (flight_size < cwnd))
418                 return;
419
420         ssthresh = transport->ssthresh;
421         pba = transport->partial_bytes_acked;
422         pmtu = transport->asoc->pathmtu;
423
424         if (cwnd <= ssthresh) {
425                 /* RFC 4960 7.2.1
426                  * o  When cwnd is less than or equal to ssthresh, an SCTP
427                  *    endpoint MUST use the slow-start algorithm to increase
428                  *    cwnd only if the current congestion window is being fully
429                  *    utilized, an incoming SACK advances the Cumulative TSN
430                  *    Ack Point, and the data sender is not in Fast Recovery.
431                  *    Only when these three conditions are met can the cwnd be
432                  *    increased; otherwise, the cwnd MUST not be increased.
433                  *    If these conditions are met, then cwnd MUST be increased
434                  *    by, at most, the lesser of 1) the total size of the
435                  *    previously outstanding DATA chunk(s) acknowledged, and
436                  *    2) the destination's path MTU.  This upper bound protects
437                  *    against the ACK-Splitting attack outlined in [SAVAGE99].
438                  */
439                 if (transport->fast_recovery)
440                         return;
441
442                 if (bytes_acked > pmtu)
443                         cwnd += pmtu;
444                 else
445                         cwnd += bytes_acked;
446                 SCTP_DEBUG_PRINTK("%s: SLOW START: transport: %p, "
447                                   "bytes_acked: %d, cwnd: %d, ssthresh: %d, "
448                                   "flight_size: %d, pba: %d\n",
449                                   __func__,
450                                   transport, bytes_acked, cwnd,
451                                   ssthresh, flight_size, pba);
452         } else {
453                 /* RFC 2960 7.2.2 Whenever cwnd is greater than ssthresh,
454                  * upon each SACK arrival that advances the Cumulative TSN Ack
455                  * Point, increase partial_bytes_acked by the total number of
456                  * bytes of all new chunks acknowledged in that SACK including
457                  * chunks acknowledged by the new Cumulative TSN Ack and by
458                  * Gap Ack Blocks.
459                  *
460                  * When partial_bytes_acked is equal to or greater than cwnd
461                  * and before the arrival of the SACK the sender had cwnd or
462                  * more bytes of data outstanding (i.e., before arrival of the
463                  * SACK, flightsize was greater than or equal to cwnd),
464                  * increase cwnd by MTU, and reset partial_bytes_acked to
465                  * (partial_bytes_acked - cwnd).
466                  */
467                 pba += bytes_acked;
468                 if (pba >= cwnd) {
469                         cwnd += pmtu;
470                         pba = ((cwnd < pba) ? (pba - cwnd) : 0);
471                 }
472                 SCTP_DEBUG_PRINTK("%s: CONGESTION AVOIDANCE: "
473                                   "transport: %p, bytes_acked: %d, cwnd: %d, "
474                                   "ssthresh: %d, flight_size: %d, pba: %d\n",
475                                   __func__,
476                                   transport, bytes_acked, cwnd,
477                                   ssthresh, flight_size, pba);
478         }
479
480         transport->cwnd = cwnd;
481         transport->partial_bytes_acked = pba;
482 }
483
484 /* This routine is used to lower the transport's cwnd when congestion is
485  * detected.
486  */
487 void sctp_transport_lower_cwnd(struct sctp_transport *transport,
488                                sctp_lower_cwnd_t reason)
489 {
490         switch (reason) {
491         case SCTP_LOWER_CWND_T3_RTX:
492                 /* RFC 2960 Section 7.2.3, sctpimpguide
493                  * When the T3-rtx timer expires on an address, SCTP should
494                  * perform slow start by:
495                  *      ssthresh = max(cwnd/2, 4*MTU)
496                  *      cwnd = 1*MTU
497                  *      partial_bytes_acked = 0
498                  */
499                 transport->ssthresh = max(transport->cwnd/2,
500                                           4*transport->asoc->pathmtu);
501                 transport->cwnd = transport->asoc->pathmtu;
502                 break;
503
504         case SCTP_LOWER_CWND_FAST_RTX:
505                 /* RFC 2960 7.2.4 Adjust the ssthresh and cwnd of the
506                  * destination address(es) to which the missing DATA chunks
507                  * were last sent, according to the formula described in
508                  * Section 7.2.3.
509                  *
510                  * RFC 2960 7.2.3, sctpimpguide Upon detection of packet
511                  * losses from SACK (see Section 7.2.4), An endpoint
512                  * should do the following:
513                  *      ssthresh = max(cwnd/2, 4*MTU)
514                  *      cwnd = ssthresh
515                  *      partial_bytes_acked = 0
516                  */
517                 if (transport->fast_recovery)
518                         return;
519
520                 /* Mark Fast recovery */
521                 transport->fast_recovery = 1;
522                 transport->fast_recovery_exit = transport->asoc->next_tsn - 1;
523
524                 transport->ssthresh = max(transport->cwnd/2,
525                                           4*transport->asoc->pathmtu);
526                 transport->cwnd = transport->ssthresh;
527                 break;
528
529         case SCTP_LOWER_CWND_ECNE:
530                 /* RFC 2481 Section 6.1.2.
531                  * If the sender receives an ECN-Echo ACK packet
532                  * then the sender knows that congestion was encountered in the
533                  * network on the path from the sender to the receiver. The
534                  * indication of congestion should be treated just as a
535                  * congestion loss in non-ECN Capable TCP. That is, the TCP
536                  * source halves the congestion window "cwnd" and reduces the
537                  * slow start threshold "ssthresh".
538                  * A critical condition is that TCP does not react to
539                  * congestion indications more than once every window of
540                  * data (or more loosely more than once every round-trip time).
541                  */
542                 if ((jiffies - transport->last_time_ecne_reduced) >
543                     transport->rtt) {
544                         transport->ssthresh = max(transport->cwnd/2,
545                                                   4*transport->asoc->pathmtu);
546                         transport->cwnd = transport->ssthresh;
547                         transport->last_time_ecne_reduced = jiffies;
548                 }
549                 break;
550
551         case SCTP_LOWER_CWND_INACTIVE:
552                 /* RFC 2960 Section 7.2.1, sctpimpguide
553                  * When the endpoint does not transmit data on a given
554                  * transport address, the cwnd of the transport address
555                  * should be adjusted to max(cwnd/2, 4*MTU) per RTO.
556                  * NOTE: Although the draft recommends that this check needs
557                  * to be done every RTO interval, we do it every hearbeat
558                  * interval.
559                  */
560                 if ((jiffies - transport->last_time_used) > transport->rto)
561                         transport->cwnd = max(transport->cwnd/2,
562                                                  4*transport->asoc->pathmtu);
563                 break;
564         }
565
566         transport->partial_bytes_acked = 0;
567         SCTP_DEBUG_PRINTK("%s: transport: %p reason: %d cwnd: "
568                           "%d ssthresh: %d\n", __func__,
569                           transport, reason,
570                           transport->cwnd, transport->ssthresh);
571 }
572
573 /* What is the next timeout value for this transport? */
574 unsigned long sctp_transport_timeout(struct sctp_transport *t)
575 {
576         unsigned long timeout;
577         timeout = t->rto + sctp_jitter(t->rto);
578         if (t->state != SCTP_UNCONFIRMED)
579                 timeout += t->hbinterval;
580         timeout += jiffies;
581         return timeout;
582 }
583
584 /* Reset transport variables to their initial values */
585 void sctp_transport_reset(struct sctp_transport *t)
586 {
587         struct sctp_association *asoc = t->asoc;
588
589         /* RFC 2960 (bis), Section 5.2.4
590          * All the congestion control parameters (e.g., cwnd, ssthresh)
591          * related to this peer MUST be reset to their initial values
592          * (see Section 6.2.1)
593          */
594         t->cwnd = min(4*asoc->pathmtu, max_t(__u32, 2*asoc->pathmtu, 4380));
595         t->ssthresh = asoc->peer.i.a_rwnd;
596         t->last_rto = t->rto = asoc->rto_initial;
597         t->rtt = 0;
598         t->srtt = 0;
599         t->rttvar = 0;
600
601         /* Reset these additional varibles so that we have a clean
602          * slate.
603          */
604         t->partial_bytes_acked = 0;
605         t->flight_size = 0;
606         t->error_count = 0;
607         t->rto_pending = 0;
608         t->fast_recovery = 0;
609
610         /* Initialize the state information for SFR-CACC */
611         t->cacc.changeover_active = 0;
612         t->cacc.cycling_changeover = 0;
613         t->cacc.next_tsn_at_change = 0;
614         t->cacc.cacc_saw_newack = 0;
615 }