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
8 * This file is part of the SCTP kernel implementation
10 * This module provides the abstraction for an SCTP tranport representing
11 * a remote transport address. For local transport addresses, we just use
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)
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.
26 * You should have received a copy of the GNU General Public License
27 * along with GNU CC; see the file COPYING. If not, see
28 * <http://www.gnu.org/licenses/>.
30 * Please send any bug reports or fixes you make to the
32 * lksctp developers <linux-sctp@vger.kernel.org>
34 * Written or modified by:
35 * La Monte H.P. Yarroll <piggy@acm.org>
36 * Karl Knutson <karl@athena.chicago.il.us>
37 * Jon Grimm <jgrimm@us.ibm.com>
38 * Xingang Guo <xingang.guo@intel.com>
39 * Hui Huang <hui.huang@nokia.com>
40 * Sridhar Samudrala <sri@us.ibm.com>
41 * Ardelle Fan <ardelle.fan@intel.com>
44 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
46 #include <linux/slab.h>
47 #include <linux/types.h>
48 #include <linux/random.h>
49 #include <net/sctp/sctp.h>
50 #include <net/sctp/sm.h>
52 /* 1st Level Abstractions. */
54 /* Initialize a new transport from provided memory. */
55 static struct sctp_transport
*sctp_transport_init(struct net
*net
,
56 struct sctp_transport
*peer
,
57 const union sctp_addr
*addr
,
60 /* Copy in the address. */
62 peer
->af_specific
= sctp_get_af_specific(addr
->sa
.sa_family
);
63 memset(&peer
->saddr
, 0, sizeof(union sctp_addr
));
65 peer
->sack_generation
= 0;
67 /* From 6.3.1 RTO Calculation:
69 * C1) Until an RTT measurement has been made for a packet sent to the
70 * given destination transport address, set RTO to the protocol
71 * parameter 'RTO.Initial'.
73 peer
->rto
= msecs_to_jiffies(net
->sctp
.rto_initial
);
75 peer
->last_time_heard
= ktime_set(0, 0);
76 peer
->last_time_ecne_reduced
= jiffies
;
78 peer
->param_flags
= SPP_HB_DISABLE
|
82 /* Initialize the default path max_retrans. */
83 peer
->pathmaxrxt
= net
->sctp
.max_retrans_path
;
84 peer
->pf_retrans
= net
->sctp
.pf_retrans
;
86 INIT_LIST_HEAD(&peer
->transmitted
);
87 INIT_LIST_HEAD(&peer
->send_ready
);
88 INIT_LIST_HEAD(&peer
->transports
);
90 setup_timer(&peer
->T3_rtx_timer
, sctp_generate_t3_rtx_event
,
92 setup_timer(&peer
->hb_timer
, sctp_generate_heartbeat_event
,
94 setup_timer(&peer
->proto_unreach_timer
,
95 sctp_generate_proto_unreach_event
, (unsigned long)peer
);
97 /* Initialize the 64-bit random nonce sent with heartbeat. */
98 get_random_bytes(&peer
->hb_nonce
, sizeof(peer
->hb_nonce
));
100 atomic_set(&peer
->refcnt
, 1);
105 /* Allocate and initialize a new transport. */
106 struct sctp_transport
*sctp_transport_new(struct net
*net
,
107 const union sctp_addr
*addr
,
110 struct sctp_transport
*transport
;
112 transport
= kzalloc(sizeof(*transport
), gfp
);
116 if (!sctp_transport_init(net
, transport
, addr
, gfp
))
119 SCTP_DBG_OBJCNT_INC(transport
);
130 /* This transport is no longer needed. Free up if possible, or
131 * delay until it last reference count.
133 void sctp_transport_free(struct sctp_transport
*transport
)
135 /* Try to delete the heartbeat timer. */
136 if (del_timer(&transport
->hb_timer
))
137 sctp_transport_put(transport
);
139 /* Delete the T3_rtx timer if it's active.
140 * There is no point in not doing this now and letting
141 * structure hang around in memory since we know
142 * the tranport is going away.
144 if (del_timer(&transport
->T3_rtx_timer
))
145 sctp_transport_put(transport
);
147 /* Delete the ICMP proto unreachable timer if it's active. */
148 if (del_timer(&transport
->proto_unreach_timer
))
149 sctp_association_put(transport
->asoc
);
151 sctp_transport_put(transport
);
154 static void sctp_transport_destroy_rcu(struct rcu_head
*head
)
156 struct sctp_transport
*transport
;
158 transport
= container_of(head
, struct sctp_transport
, rcu
);
160 dst_release(transport
->dst
);
162 SCTP_DBG_OBJCNT_DEC(transport
);
165 /* Destroy the transport data structure.
166 * Assumes there are no more users of this structure.
168 static void sctp_transport_destroy(struct sctp_transport
*transport
)
170 if (unlikely(atomic_read(&transport
->refcnt
))) {
171 WARN(1, "Attempt to destroy undead transport %p!\n", transport
);
175 sctp_packet_free(&transport
->packet
);
178 sctp_association_put(transport
->asoc
);
180 call_rcu(&transport
->rcu
, sctp_transport_destroy_rcu
);
183 /* Start T3_rtx timer if it is not already running and update the heartbeat
184 * timer. This routine is called every time a DATA chunk is sent.
186 void sctp_transport_reset_t3_rtx(struct sctp_transport
*transport
)
188 /* RFC 2960 6.3.2 Retransmission Timer Rules
190 * R1) Every time a DATA chunk is sent to any address(including a
191 * retransmission), if the T3-rtx timer of that address is not running
192 * start it running so that it will expire after the RTO of that
196 if (!timer_pending(&transport
->T3_rtx_timer
))
197 if (!mod_timer(&transport
->T3_rtx_timer
,
198 jiffies
+ transport
->rto
))
199 sctp_transport_hold(transport
);
202 void sctp_transport_reset_hb_timer(struct sctp_transport
*transport
)
204 unsigned long expires
;
206 /* When a data chunk is sent, reset the heartbeat interval. */
207 expires
= jiffies
+ sctp_transport_timeout(transport
);
208 if ((time_before(transport
->hb_timer
.expires
, expires
) ||
209 !timer_pending(&transport
->hb_timer
)) &&
210 !mod_timer(&transport
->hb_timer
,
211 expires
+ prandom_u32_max(transport
->rto
)))
212 sctp_transport_hold(transport
);
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.
219 void sctp_transport_set_owner(struct sctp_transport
*transport
,
220 struct sctp_association
*asoc
)
222 transport
->asoc
= asoc
;
223 sctp_association_hold(asoc
);
226 /* Initialize the pmtu of a transport. */
227 void sctp_transport_pmtu(struct sctp_transport
*transport
, struct sock
*sk
)
229 /* If we don't have a fresh route, look one up */
230 if (!transport
->dst
|| transport
->dst
->obsolete
) {
231 dst_release(transport
->dst
);
232 transport
->af_specific
->get_dst(transport
, &transport
->saddr
,
236 if (transport
->dst
) {
237 transport
->pathmtu
= SCTP_TRUNC4(dst_mtu(transport
->dst
));
239 transport
->pathmtu
= SCTP_DEFAULT_MAXSEGMENT
;
242 void sctp_transport_update_pmtu(struct sock
*sk
, struct sctp_transport
*t
, u32 pmtu
)
244 struct dst_entry
*dst
;
246 if (unlikely(pmtu
< SCTP_DEFAULT_MINSEGMENT
)) {
247 pr_warn("%s: Reported pmtu %d too low, using default minimum of %d\n",
249 SCTP_DEFAULT_MINSEGMENT
);
250 /* Use default minimum segment size and disable
251 * pmtu discovery on this transport.
253 t
->pathmtu
= SCTP_DEFAULT_MINSEGMENT
;
258 dst
= sctp_transport_dst_check(t
);
260 t
->af_specific
->get_dst(t
, &t
->saddr
, &t
->fl
, sk
);
263 dst
->ops
->update_pmtu(dst
, sk
, NULL
, pmtu
);
265 dst
= sctp_transport_dst_check(t
);
267 t
->af_specific
->get_dst(t
, &t
->saddr
, &t
->fl
, sk
);
271 /* Caches the dst entry and source address for a transport's destination
274 void sctp_transport_route(struct sctp_transport
*transport
,
275 union sctp_addr
*saddr
, struct sctp_sock
*opt
)
277 struct sctp_association
*asoc
= transport
->asoc
;
278 struct sctp_af
*af
= transport
->af_specific
;
280 af
->get_dst(transport
, saddr
, &transport
->fl
, sctp_opt2sk(opt
));
283 memcpy(&transport
->saddr
, saddr
, sizeof(union sctp_addr
));
285 af
->get_saddr(opt
, transport
, &transport
->fl
);
287 if ((transport
->param_flags
& SPP_PMTUD_DISABLE
) && transport
->pathmtu
) {
290 if (transport
->dst
) {
291 transport
->pathmtu
= SCTP_TRUNC4(dst_mtu(transport
->dst
));
293 /* Initialize sk->sk_rcv_saddr, if the transport is the
294 * association's active path for getsockname().
296 if (asoc
&& (!asoc
->peer
.primary_path
||
297 (transport
== asoc
->peer
.active_path
)))
298 opt
->pf
->to_sk_saddr(&transport
->saddr
,
301 transport
->pathmtu
= SCTP_DEFAULT_MAXSEGMENT
;
304 /* Hold a reference to a transport. */
305 int sctp_transport_hold(struct sctp_transport
*transport
)
307 return atomic_add_unless(&transport
->refcnt
, 1, 0);
310 /* Release a reference to a transport and clean up
311 * if there are no more references.
313 void sctp_transport_put(struct sctp_transport
*transport
)
315 if (atomic_dec_and_test(&transport
->refcnt
))
316 sctp_transport_destroy(transport
);
319 /* Update transport's RTO based on the newly calculated RTT. */
320 void sctp_transport_update_rto(struct sctp_transport
*tp
, __u32 rtt
)
322 if (unlikely(!tp
->rto_pending
))
323 /* We should not be doing any RTO updates unless rto_pending is set. */
324 pr_debug("%s: rto_pending not set on transport %p!\n", __func__
, tp
);
326 if (tp
->rttvar
|| tp
->srtt
) {
327 struct net
*net
= sock_net(tp
->asoc
->base
.sk
);
328 /* 6.3.1 C3) When a new RTT measurement R' is made, set
329 * RTTVAR <- (1 - RTO.Beta) * RTTVAR + RTO.Beta * |SRTT - R'|
330 * SRTT <- (1 - RTO.Alpha) * SRTT + RTO.Alpha * R'
333 /* Note: The above algorithm has been rewritten to
334 * express rto_beta and rto_alpha as inverse powers
336 * For example, assuming the default value of RTO.Alpha of
337 * 1/8, rto_alpha would be expressed as 3.
339 tp
->rttvar
= tp
->rttvar
- (tp
->rttvar
>> net
->sctp
.rto_beta
)
340 + (((__u32
)abs((__s64
)tp
->srtt
- (__s64
)rtt
)) >> net
->sctp
.rto_beta
);
341 tp
->srtt
= tp
->srtt
- (tp
->srtt
>> net
->sctp
.rto_alpha
)
342 + (rtt
>> net
->sctp
.rto_alpha
);
344 /* 6.3.1 C2) When the first RTT measurement R is made, set
345 * SRTT <- R, RTTVAR <- R/2.
348 tp
->rttvar
= rtt
>> 1;
351 /* 6.3.1 G1) Whenever RTTVAR is computed, if RTTVAR = 0, then
352 * adjust RTTVAR <- G, where G is the CLOCK GRANULARITY.
355 tp
->rttvar
= SCTP_CLOCK_GRANULARITY
;
357 /* 6.3.1 C3) After the computation, update RTO <- SRTT + 4 * RTTVAR. */
358 tp
->rto
= tp
->srtt
+ (tp
->rttvar
<< 2);
360 /* 6.3.1 C6) Whenever RTO is computed, if it is less than RTO.Min
361 * seconds then it is rounded up to RTO.Min seconds.
363 if (tp
->rto
< tp
->asoc
->rto_min
)
364 tp
->rto
= tp
->asoc
->rto_min
;
366 /* 6.3.1 C7) A maximum value may be placed on RTO provided it is
367 * at least RTO.max seconds.
369 if (tp
->rto
> tp
->asoc
->rto_max
)
370 tp
->rto
= tp
->asoc
->rto_max
;
372 sctp_max_rto(tp
->asoc
, tp
);
375 /* Reset rto_pending so that a new RTT measurement is started when a
376 * new data chunk is sent.
380 pr_debug("%s: transport:%p, rtt:%d, srtt:%d rttvar:%d, rto:%ld\n",
381 __func__
, tp
, rtt
, tp
->srtt
, tp
->rttvar
, tp
->rto
);
384 /* This routine updates the transport's cwnd and partial_bytes_acked
385 * parameters based on the bytes acked in the received SACK.
387 void sctp_transport_raise_cwnd(struct sctp_transport
*transport
,
388 __u32 sack_ctsn
, __u32 bytes_acked
)
390 struct sctp_association
*asoc
= transport
->asoc
;
391 __u32 cwnd
, ssthresh
, flight_size
, pba
, pmtu
;
393 cwnd
= transport
->cwnd
;
394 flight_size
= transport
->flight_size
;
396 /* See if we need to exit Fast Recovery first */
397 if (asoc
->fast_recovery
&&
398 TSN_lte(asoc
->fast_recovery_exit
, sack_ctsn
))
399 asoc
->fast_recovery
= 0;
401 /* The appropriate cwnd increase algorithm is performed if, and only
402 * if the cumulative TSN whould advanced and the congestion window is
403 * being fully utilized.
405 if (TSN_lte(sack_ctsn
, transport
->asoc
->ctsn_ack_point
) ||
406 (flight_size
< cwnd
))
409 ssthresh
= transport
->ssthresh
;
410 pba
= transport
->partial_bytes_acked
;
411 pmtu
= transport
->asoc
->pathmtu
;
413 if (cwnd
<= ssthresh
) {
415 * o When cwnd is less than or equal to ssthresh, an SCTP
416 * endpoint MUST use the slow-start algorithm to increase
417 * cwnd only if the current congestion window is being fully
418 * utilized, an incoming SACK advances the Cumulative TSN
419 * Ack Point, and the data sender is not in Fast Recovery.
420 * Only when these three conditions are met can the cwnd be
421 * increased; otherwise, the cwnd MUST not be increased.
422 * If these conditions are met, then cwnd MUST be increased
423 * by, at most, the lesser of 1) the total size of the
424 * previously outstanding DATA chunk(s) acknowledged, and
425 * 2) the destination's path MTU. This upper bound protects
426 * against the ACK-Splitting attack outlined in [SAVAGE99].
428 if (asoc
->fast_recovery
)
431 if (bytes_acked
> pmtu
)
436 pr_debug("%s: slow start: transport:%p, bytes_acked:%d, "
437 "cwnd:%d, ssthresh:%d, flight_size:%d, pba:%d\n",
438 __func__
, transport
, bytes_acked
, cwnd
, ssthresh
,
441 /* RFC 2960 7.2.2 Whenever cwnd is greater than ssthresh,
442 * upon each SACK arrival that advances the Cumulative TSN Ack
443 * Point, increase partial_bytes_acked by the total number of
444 * bytes of all new chunks acknowledged in that SACK including
445 * chunks acknowledged by the new Cumulative TSN Ack and by
448 * When partial_bytes_acked is equal to or greater than cwnd
449 * and before the arrival of the SACK the sender had cwnd or
450 * more bytes of data outstanding (i.e., before arrival of the
451 * SACK, flightsize was greater than or equal to cwnd),
452 * increase cwnd by MTU, and reset partial_bytes_acked to
453 * (partial_bytes_acked - cwnd).
458 pba
= ((cwnd
< pba
) ? (pba
- cwnd
) : 0);
461 pr_debug("%s: congestion avoidance: transport:%p, "
462 "bytes_acked:%d, cwnd:%d, ssthresh:%d, "
463 "flight_size:%d, pba:%d\n", __func__
,
464 transport
, bytes_acked
, cwnd
, ssthresh
,
468 transport
->cwnd
= cwnd
;
469 transport
->partial_bytes_acked
= pba
;
472 /* This routine is used to lower the transport's cwnd when congestion is
475 void sctp_transport_lower_cwnd(struct sctp_transport
*transport
,
476 sctp_lower_cwnd_t reason
)
478 struct sctp_association
*asoc
= transport
->asoc
;
481 case SCTP_LOWER_CWND_T3_RTX
:
482 /* RFC 2960 Section 7.2.3, sctpimpguide
483 * When the T3-rtx timer expires on an address, SCTP should
484 * perform slow start by:
485 * ssthresh = max(cwnd/2, 4*MTU)
487 * partial_bytes_acked = 0
489 transport
->ssthresh
= max(transport
->cwnd
/2,
491 transport
->cwnd
= asoc
->pathmtu
;
493 /* T3-rtx also clears fast recovery */
494 asoc
->fast_recovery
= 0;
497 case SCTP_LOWER_CWND_FAST_RTX
:
498 /* RFC 2960 7.2.4 Adjust the ssthresh and cwnd of the
499 * destination address(es) to which the missing DATA chunks
500 * were last sent, according to the formula described in
503 * RFC 2960 7.2.3, sctpimpguide Upon detection of packet
504 * losses from SACK (see Section 7.2.4), An endpoint
505 * should do the following:
506 * ssthresh = max(cwnd/2, 4*MTU)
508 * partial_bytes_acked = 0
510 if (asoc
->fast_recovery
)
513 /* Mark Fast recovery */
514 asoc
->fast_recovery
= 1;
515 asoc
->fast_recovery_exit
= asoc
->next_tsn
- 1;
517 transport
->ssthresh
= max(transport
->cwnd
/2,
519 transport
->cwnd
= transport
->ssthresh
;
522 case SCTP_LOWER_CWND_ECNE
:
523 /* RFC 2481 Section 6.1.2.
524 * If the sender receives an ECN-Echo ACK packet
525 * then the sender knows that congestion was encountered in the
526 * network on the path from the sender to the receiver. The
527 * indication of congestion should be treated just as a
528 * congestion loss in non-ECN Capable TCP. That is, the TCP
529 * source halves the congestion window "cwnd" and reduces the
530 * slow start threshold "ssthresh".
531 * A critical condition is that TCP does not react to
532 * congestion indications more than once every window of
533 * data (or more loosely more than once every round-trip time).
535 if (time_after(jiffies
, transport
->last_time_ecne_reduced
+
537 transport
->ssthresh
= max(transport
->cwnd
/2,
539 transport
->cwnd
= transport
->ssthresh
;
540 transport
->last_time_ecne_reduced
= jiffies
;
544 case SCTP_LOWER_CWND_INACTIVE
:
545 /* RFC 2960 Section 7.2.1, sctpimpguide
546 * When the endpoint does not transmit data on a given
547 * transport address, the cwnd of the transport address
548 * should be adjusted to max(cwnd/2, 4*MTU) per RTO.
549 * NOTE: Although the draft recommends that this check needs
550 * to be done every RTO interval, we do it every hearbeat
553 transport
->cwnd
= max(transport
->cwnd
/2,
558 transport
->partial_bytes_acked
= 0;
560 pr_debug("%s: transport:%p, reason:%d, cwnd:%d, ssthresh:%d\n",
561 __func__
, transport
, reason
, transport
->cwnd
,
562 transport
->ssthresh
);
565 /* Apply Max.Burst limit to the congestion window:
566 * sctpimpguide-05 2.14.2
567 * D) When the time comes for the sender to
568 * transmit new DATA chunks, the protocol parameter Max.Burst MUST
569 * first be applied to limit how many new DATA chunks may be sent.
570 * The limit is applied by adjusting cwnd as follows:
571 * if ((flightsize+ Max.Burst * MTU) < cwnd)
572 * cwnd = flightsize + Max.Burst * MTU
575 void sctp_transport_burst_limited(struct sctp_transport
*t
)
577 struct sctp_association
*asoc
= t
->asoc
;
578 u32 old_cwnd
= t
->cwnd
;
581 if (t
->burst_limited
|| asoc
->max_burst
== 0)
584 max_burst_bytes
= t
->flight_size
+ (asoc
->max_burst
* asoc
->pathmtu
);
585 if (max_burst_bytes
< old_cwnd
) {
586 t
->cwnd
= max_burst_bytes
;
587 t
->burst_limited
= old_cwnd
;
591 /* Restore the old cwnd congestion window, after the burst had it's
594 void sctp_transport_burst_reset(struct sctp_transport
*t
)
596 if (t
->burst_limited
) {
597 t
->cwnd
= t
->burst_limited
;
598 t
->burst_limited
= 0;
602 /* What is the next timeout value for this transport? */
603 unsigned long sctp_transport_timeout(struct sctp_transport
*trans
)
605 /* RTO + timer slack +/- 50% of RTO */
606 unsigned long timeout
= trans
->rto
>> 1;
608 if (trans
->state
!= SCTP_UNCONFIRMED
&&
609 trans
->state
!= SCTP_PF
)
610 timeout
+= trans
->hbinterval
;
612 return max_t(unsigned long, timeout
, HZ
/ 5);
615 /* Reset transport variables to their initial values */
616 void sctp_transport_reset(struct sctp_transport
*t
)
618 struct sctp_association
*asoc
= t
->asoc
;
620 /* RFC 2960 (bis), Section 5.2.4
621 * All the congestion control parameters (e.g., cwnd, ssthresh)
622 * related to this peer MUST be reset to their initial values
623 * (see Section 6.2.1)
625 t
->cwnd
= min(4*asoc
->pathmtu
, max_t(__u32
, 2*asoc
->pathmtu
, 4380));
626 t
->burst_limited
= 0;
627 t
->ssthresh
= asoc
->peer
.i
.a_rwnd
;
628 t
->rto
= asoc
->rto_initial
;
629 sctp_max_rto(asoc
, t
);
634 /* Reset these additional varibles so that we have a clean
637 t
->partial_bytes_acked
= 0;
643 /* Initialize the state information for SFR-CACC */
644 t
->cacc
.changeover_active
= 0;
645 t
->cacc
.cycling_changeover
= 0;
646 t
->cacc
.next_tsn_at_change
= 0;
647 t
->cacc
.cacc_saw_newack
= 0;
650 /* Schedule retransmission on the given transport */
651 void sctp_transport_immediate_rtx(struct sctp_transport
*t
)
653 /* Stop pending T3_rtx_timer */
654 if (del_timer(&t
->T3_rtx_timer
))
655 sctp_transport_put(t
);
657 sctp_retransmit(&t
->asoc
->outqueue
, t
, SCTP_RTXR_T3_RTX
);
658 if (!timer_pending(&t
->T3_rtx_timer
)) {
659 if (!mod_timer(&t
->T3_rtx_timer
, jiffies
+ t
->rto
))
660 sctp_transport_hold(t
);