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
= 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
->reconf_timer
, sctp_generate_reconf_event
,
96 setup_timer(&peer
->proto_unreach_timer
,
97 sctp_generate_proto_unreach_event
, (unsigned long)peer
);
99 /* Initialize the 64-bit random nonce sent with heartbeat. */
100 get_random_bytes(&peer
->hb_nonce
, sizeof(peer
->hb_nonce
));
102 atomic_set(&peer
->refcnt
, 1);
107 /* Allocate and initialize a new transport. */
108 struct sctp_transport
*sctp_transport_new(struct net
*net
,
109 const union sctp_addr
*addr
,
112 struct sctp_transport
*transport
;
114 transport
= kzalloc(sizeof(*transport
), gfp
);
118 if (!sctp_transport_init(net
, transport
, addr
, gfp
))
121 SCTP_DBG_OBJCNT_INC(transport
);
132 /* This transport is no longer needed. Free up if possible, or
133 * delay until it last reference count.
135 void sctp_transport_free(struct sctp_transport
*transport
)
137 /* Try to delete the heartbeat timer. */
138 if (del_timer(&transport
->hb_timer
))
139 sctp_transport_put(transport
);
141 /* Delete the T3_rtx timer if it's active.
142 * There is no point in not doing this now and letting
143 * structure hang around in memory since we know
144 * the tranport is going away.
146 if (del_timer(&transport
->T3_rtx_timer
))
147 sctp_transport_put(transport
);
149 if (del_timer(&transport
->reconf_timer
))
150 sctp_transport_put(transport
);
152 /* Delete the ICMP proto unreachable timer if it's active. */
153 if (del_timer(&transport
->proto_unreach_timer
))
154 sctp_association_put(transport
->asoc
);
156 sctp_transport_put(transport
);
159 static void sctp_transport_destroy_rcu(struct rcu_head
*head
)
161 struct sctp_transport
*transport
;
163 transport
= container_of(head
, struct sctp_transport
, rcu
);
165 dst_release(transport
->dst
);
167 SCTP_DBG_OBJCNT_DEC(transport
);
170 /* Destroy the transport data structure.
171 * Assumes there are no more users of this structure.
173 static void sctp_transport_destroy(struct sctp_transport
*transport
)
175 if (unlikely(atomic_read(&transport
->refcnt
))) {
176 WARN(1, "Attempt to destroy undead transport %p!\n", transport
);
180 sctp_packet_free(&transport
->packet
);
183 sctp_association_put(transport
->asoc
);
185 call_rcu(&transport
->rcu
, sctp_transport_destroy_rcu
);
188 /* Start T3_rtx timer if it is not already running and update the heartbeat
189 * timer. This routine is called every time a DATA chunk is sent.
191 void sctp_transport_reset_t3_rtx(struct sctp_transport
*transport
)
193 /* RFC 2960 6.3.2 Retransmission Timer Rules
195 * R1) Every time a DATA chunk is sent to any address(including a
196 * retransmission), if the T3-rtx timer of that address is not running
197 * start it running so that it will expire after the RTO of that
201 if (!timer_pending(&transport
->T3_rtx_timer
))
202 if (!mod_timer(&transport
->T3_rtx_timer
,
203 jiffies
+ transport
->rto
))
204 sctp_transport_hold(transport
);
207 void sctp_transport_reset_hb_timer(struct sctp_transport
*transport
)
209 unsigned long expires
;
211 /* When a data chunk is sent, reset the heartbeat interval. */
212 expires
= jiffies
+ sctp_transport_timeout(transport
);
213 if (time_before(transport
->hb_timer
.expires
, expires
) &&
214 !mod_timer(&transport
->hb_timer
,
215 expires
+ prandom_u32_max(transport
->rto
)))
216 sctp_transport_hold(transport
);
219 void sctp_transport_reset_reconf_timer(struct sctp_transport
*transport
)
221 if (!timer_pending(&transport
->reconf_timer
))
222 if (!mod_timer(&transport
->reconf_timer
,
223 jiffies
+ transport
->rto
))
224 sctp_transport_hold(transport
);
227 /* This transport has been assigned to an association.
228 * Initialize fields from the association or from the sock itself.
229 * Register the reference count in the association.
231 void sctp_transport_set_owner(struct sctp_transport
*transport
,
232 struct sctp_association
*asoc
)
234 transport
->asoc
= asoc
;
235 sctp_association_hold(asoc
);
238 /* Initialize the pmtu of a transport. */
239 void sctp_transport_pmtu(struct sctp_transport
*transport
, struct sock
*sk
)
241 /* If we don't have a fresh route, look one up */
242 if (!transport
->dst
|| transport
->dst
->obsolete
) {
243 sctp_transport_dst_release(transport
);
244 transport
->af_specific
->get_dst(transport
, &transport
->saddr
,
248 if (transport
->dst
) {
249 transport
->pathmtu
= SCTP_TRUNC4(dst_mtu(transport
->dst
));
251 transport
->pathmtu
= SCTP_DEFAULT_MAXSEGMENT
;
254 void sctp_transport_update_pmtu(struct sctp_transport
*t
, u32 pmtu
)
256 struct dst_entry
*dst
= sctp_transport_dst_check(t
);
258 if (unlikely(pmtu
< SCTP_DEFAULT_MINSEGMENT
)) {
259 pr_warn("%s: Reported pmtu %d too low, using default minimum of %d\n",
260 __func__
, pmtu
, SCTP_DEFAULT_MINSEGMENT
);
261 /* Use default minimum segment size and disable
262 * pmtu discovery on this transport.
264 t
->pathmtu
= SCTP_DEFAULT_MINSEGMENT
;
270 dst
->ops
->update_pmtu(dst
, t
->asoc
->base
.sk
, NULL
, pmtu
);
271 dst
= sctp_transport_dst_check(t
);
275 t
->af_specific
->get_dst(t
, &t
->saddr
, &t
->fl
, t
->asoc
->base
.sk
);
278 /* Caches the dst entry and source address for a transport's destination
281 void sctp_transport_route(struct sctp_transport
*transport
,
282 union sctp_addr
*saddr
, struct sctp_sock
*opt
)
284 struct sctp_association
*asoc
= transport
->asoc
;
285 struct sctp_af
*af
= transport
->af_specific
;
287 af
->get_dst(transport
, saddr
, &transport
->fl
, sctp_opt2sk(opt
));
290 memcpy(&transport
->saddr
, saddr
, sizeof(union sctp_addr
));
292 af
->get_saddr(opt
, transport
, &transport
->fl
);
294 if ((transport
->param_flags
& SPP_PMTUD_DISABLE
) && transport
->pathmtu
) {
297 if (transport
->dst
) {
298 transport
->pathmtu
= SCTP_TRUNC4(dst_mtu(transport
->dst
));
300 /* Initialize sk->sk_rcv_saddr, if the transport is the
301 * association's active path for getsockname().
303 if (asoc
&& (!asoc
->peer
.primary_path
||
304 (transport
== asoc
->peer
.active_path
)))
305 opt
->pf
->to_sk_saddr(&transport
->saddr
,
308 transport
->pathmtu
= SCTP_DEFAULT_MAXSEGMENT
;
311 /* Hold a reference to a transport. */
312 int sctp_transport_hold(struct sctp_transport
*transport
)
314 return atomic_add_unless(&transport
->refcnt
, 1, 0);
317 /* Release a reference to a transport and clean up
318 * if there are no more references.
320 void sctp_transport_put(struct sctp_transport
*transport
)
322 if (atomic_dec_and_test(&transport
->refcnt
))
323 sctp_transport_destroy(transport
);
326 /* Update transport's RTO based on the newly calculated RTT. */
327 void sctp_transport_update_rto(struct sctp_transport
*tp
, __u32 rtt
)
329 if (unlikely(!tp
->rto_pending
))
330 /* We should not be doing any RTO updates unless rto_pending is set. */
331 pr_debug("%s: rto_pending not set on transport %p!\n", __func__
, tp
);
333 if (tp
->rttvar
|| tp
->srtt
) {
334 struct net
*net
= sock_net(tp
->asoc
->base
.sk
);
335 /* 6.3.1 C3) When a new RTT measurement R' is made, set
336 * RTTVAR <- (1 - RTO.Beta) * RTTVAR + RTO.Beta * |SRTT - R'|
337 * SRTT <- (1 - RTO.Alpha) * SRTT + RTO.Alpha * R'
340 /* Note: The above algorithm has been rewritten to
341 * express rto_beta and rto_alpha as inverse powers
343 * For example, assuming the default value of RTO.Alpha of
344 * 1/8, rto_alpha would be expressed as 3.
346 tp
->rttvar
= tp
->rttvar
- (tp
->rttvar
>> net
->sctp
.rto_beta
)
347 + (((__u32
)abs((__s64
)tp
->srtt
- (__s64
)rtt
)) >> net
->sctp
.rto_beta
);
348 tp
->srtt
= tp
->srtt
- (tp
->srtt
>> net
->sctp
.rto_alpha
)
349 + (rtt
>> net
->sctp
.rto_alpha
);
351 /* 6.3.1 C2) When the first RTT measurement R is made, set
352 * SRTT <- R, RTTVAR <- R/2.
355 tp
->rttvar
= rtt
>> 1;
358 /* 6.3.1 G1) Whenever RTTVAR is computed, if RTTVAR = 0, then
359 * adjust RTTVAR <- G, where G is the CLOCK GRANULARITY.
362 tp
->rttvar
= SCTP_CLOCK_GRANULARITY
;
364 /* 6.3.1 C3) After the computation, update RTO <- SRTT + 4 * RTTVAR. */
365 tp
->rto
= tp
->srtt
+ (tp
->rttvar
<< 2);
367 /* 6.3.1 C6) Whenever RTO is computed, if it is less than RTO.Min
368 * seconds then it is rounded up to RTO.Min seconds.
370 if (tp
->rto
< tp
->asoc
->rto_min
)
371 tp
->rto
= tp
->asoc
->rto_min
;
373 /* 6.3.1 C7) A maximum value may be placed on RTO provided it is
374 * at least RTO.max seconds.
376 if (tp
->rto
> tp
->asoc
->rto_max
)
377 tp
->rto
= tp
->asoc
->rto_max
;
379 sctp_max_rto(tp
->asoc
, tp
);
382 /* Reset rto_pending so that a new RTT measurement is started when a
383 * new data chunk is sent.
387 pr_debug("%s: transport:%p, rtt:%d, srtt:%d rttvar:%d, rto:%ld\n",
388 __func__
, tp
, rtt
, tp
->srtt
, tp
->rttvar
, tp
->rto
);
391 /* This routine updates the transport's cwnd and partial_bytes_acked
392 * parameters based on the bytes acked in the received SACK.
394 void sctp_transport_raise_cwnd(struct sctp_transport
*transport
,
395 __u32 sack_ctsn
, __u32 bytes_acked
)
397 struct sctp_association
*asoc
= transport
->asoc
;
398 __u32 cwnd
, ssthresh
, flight_size
, pba
, pmtu
;
400 cwnd
= transport
->cwnd
;
401 flight_size
= transport
->flight_size
;
403 /* See if we need to exit Fast Recovery first */
404 if (asoc
->fast_recovery
&&
405 TSN_lte(asoc
->fast_recovery_exit
, sack_ctsn
))
406 asoc
->fast_recovery
= 0;
408 /* The appropriate cwnd increase algorithm is performed if, and only
409 * if the cumulative TSN whould advanced and the congestion window is
410 * being fully utilized.
412 if (TSN_lte(sack_ctsn
, transport
->asoc
->ctsn_ack_point
) ||
413 (flight_size
< cwnd
))
416 ssthresh
= transport
->ssthresh
;
417 pba
= transport
->partial_bytes_acked
;
418 pmtu
= transport
->asoc
->pathmtu
;
420 if (cwnd
<= ssthresh
) {
422 * o When cwnd is less than or equal to ssthresh, an SCTP
423 * endpoint MUST use the slow-start algorithm to increase
424 * cwnd only if the current congestion window is being fully
425 * utilized, an incoming SACK advances the Cumulative TSN
426 * Ack Point, and the data sender is not in Fast Recovery.
427 * Only when these three conditions are met can the cwnd be
428 * increased; otherwise, the cwnd MUST not be increased.
429 * If these conditions are met, then cwnd MUST be increased
430 * by, at most, the lesser of 1) the total size of the
431 * previously outstanding DATA chunk(s) acknowledged, and
432 * 2) the destination's path MTU. This upper bound protects
433 * against the ACK-Splitting attack outlined in [SAVAGE99].
435 if (asoc
->fast_recovery
)
438 if (bytes_acked
> pmtu
)
443 pr_debug("%s: slow start: transport:%p, bytes_acked:%d, "
444 "cwnd:%d, ssthresh:%d, flight_size:%d, pba:%d\n",
445 __func__
, transport
, bytes_acked
, cwnd
, ssthresh
,
448 /* RFC 2960 7.2.2 Whenever cwnd is greater than ssthresh,
449 * upon each SACK arrival that advances the Cumulative TSN Ack
450 * Point, increase partial_bytes_acked by the total number of
451 * bytes of all new chunks acknowledged in that SACK including
452 * chunks acknowledged by the new Cumulative TSN Ack and by
455 * When partial_bytes_acked is equal to or greater than cwnd
456 * and before the arrival of the SACK the sender had cwnd or
457 * more bytes of data outstanding (i.e., before arrival of the
458 * SACK, flightsize was greater than or equal to cwnd),
459 * increase cwnd by MTU, and reset partial_bytes_acked to
460 * (partial_bytes_acked - cwnd).
465 pba
= ((cwnd
< pba
) ? (pba
- cwnd
) : 0);
468 pr_debug("%s: congestion avoidance: transport:%p, "
469 "bytes_acked:%d, cwnd:%d, ssthresh:%d, "
470 "flight_size:%d, pba:%d\n", __func__
,
471 transport
, bytes_acked
, cwnd
, ssthresh
,
475 transport
->cwnd
= cwnd
;
476 transport
->partial_bytes_acked
= pba
;
479 /* This routine is used to lower the transport's cwnd when congestion is
482 void sctp_transport_lower_cwnd(struct sctp_transport
*transport
,
483 sctp_lower_cwnd_t reason
)
485 struct sctp_association
*asoc
= transport
->asoc
;
488 case SCTP_LOWER_CWND_T3_RTX
:
489 /* RFC 2960 Section 7.2.3, sctpimpguide
490 * When the T3-rtx timer expires on an address, SCTP should
491 * perform slow start by:
492 * ssthresh = max(cwnd/2, 4*MTU)
494 * partial_bytes_acked = 0
496 transport
->ssthresh
= max(transport
->cwnd
/2,
498 transport
->cwnd
= asoc
->pathmtu
;
500 /* T3-rtx also clears fast recovery */
501 asoc
->fast_recovery
= 0;
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
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)
515 * partial_bytes_acked = 0
517 if (asoc
->fast_recovery
)
520 /* Mark Fast recovery */
521 asoc
->fast_recovery
= 1;
522 asoc
->fast_recovery_exit
= asoc
->next_tsn
- 1;
524 transport
->ssthresh
= max(transport
->cwnd
/2,
526 transport
->cwnd
= transport
->ssthresh
;
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).
542 if (time_after(jiffies
, transport
->last_time_ecne_reduced
+
544 transport
->ssthresh
= max(transport
->cwnd
/2,
546 transport
->cwnd
= transport
->ssthresh
;
547 transport
->last_time_ecne_reduced
= jiffies
;
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
560 transport
->cwnd
= max(transport
->cwnd
/2,
565 transport
->partial_bytes_acked
= 0;
567 pr_debug("%s: transport:%p, reason:%d, cwnd:%d, ssthresh:%d\n",
568 __func__
, transport
, reason
, transport
->cwnd
,
569 transport
->ssthresh
);
572 /* Apply Max.Burst limit to the congestion window:
573 * sctpimpguide-05 2.14.2
574 * D) When the time comes for the sender to
575 * transmit new DATA chunks, the protocol parameter Max.Burst MUST
576 * first be applied to limit how many new DATA chunks may be sent.
577 * The limit is applied by adjusting cwnd as follows:
578 * if ((flightsize+ Max.Burst * MTU) < cwnd)
579 * cwnd = flightsize + Max.Burst * MTU
582 void sctp_transport_burst_limited(struct sctp_transport
*t
)
584 struct sctp_association
*asoc
= t
->asoc
;
585 u32 old_cwnd
= t
->cwnd
;
588 if (t
->burst_limited
|| asoc
->max_burst
== 0)
591 max_burst_bytes
= t
->flight_size
+ (asoc
->max_burst
* asoc
->pathmtu
);
592 if (max_burst_bytes
< old_cwnd
) {
593 t
->cwnd
= max_burst_bytes
;
594 t
->burst_limited
= old_cwnd
;
598 /* Restore the old cwnd congestion window, after the burst had it's
601 void sctp_transport_burst_reset(struct sctp_transport
*t
)
603 if (t
->burst_limited
) {
604 t
->cwnd
= t
->burst_limited
;
605 t
->burst_limited
= 0;
609 /* What is the next timeout value for this transport? */
610 unsigned long sctp_transport_timeout(struct sctp_transport
*trans
)
612 /* RTO + timer slack +/- 50% of RTO */
613 unsigned long timeout
= trans
->rto
>> 1;
615 if (trans
->state
!= SCTP_UNCONFIRMED
&&
616 trans
->state
!= SCTP_PF
)
617 timeout
+= trans
->hbinterval
;
622 /* Reset transport variables to their initial values */
623 void sctp_transport_reset(struct sctp_transport
*t
)
625 struct sctp_association
*asoc
= t
->asoc
;
627 /* RFC 2960 (bis), Section 5.2.4
628 * All the congestion control parameters (e.g., cwnd, ssthresh)
629 * related to this peer MUST be reset to their initial values
630 * (see Section 6.2.1)
632 t
->cwnd
= min(4*asoc
->pathmtu
, max_t(__u32
, 2*asoc
->pathmtu
, 4380));
633 t
->burst_limited
= 0;
634 t
->ssthresh
= asoc
->peer
.i
.a_rwnd
;
635 t
->rto
= asoc
->rto_initial
;
636 sctp_max_rto(asoc
, t
);
641 /* Reset these additional variables so that we have a clean slate. */
642 t
->partial_bytes_acked
= 0;
648 /* Initialize the state information for SFR-CACC */
649 t
->cacc
.changeover_active
= 0;
650 t
->cacc
.cycling_changeover
= 0;
651 t
->cacc
.next_tsn_at_change
= 0;
652 t
->cacc
.cacc_saw_newack
= 0;
655 /* Schedule retransmission on the given transport */
656 void sctp_transport_immediate_rtx(struct sctp_transport
*t
)
658 /* Stop pending T3_rtx_timer */
659 if (del_timer(&t
->T3_rtx_timer
))
660 sctp_transport_put(t
);
662 sctp_retransmit(&t
->asoc
->outqueue
, t
, SCTP_RTXR_T3_RTX
);
663 if (!timer_pending(&t
->T3_rtx_timer
)) {
664 if (!mod_timer(&t
->T3_rtx_timer
, jiffies
+ t
->rto
))
665 sctp_transport_hold(t
);
670 void sctp_transport_dst_release(struct sctp_transport
*t
)
674 t
->dst_pending_confirm
= 0;
677 /* Schedule neighbour confirm */
678 void sctp_transport_dst_confirm(struct sctp_transport
*t
)
680 t
->dst_pending_confirm
= 1;