xref: /openbmc/linux/net/sctp/transport.c (revision 8dda2eac)
1 // SPDX-License-Identifier: GPL-2.0-or-later
2 /* SCTP kernel implementation
3  * Copyright (c) 1999-2000 Cisco, Inc.
4  * Copyright (c) 1999-2001 Motorola, Inc.
5  * Copyright (c) 2001-2003 International Business Machines Corp.
6  * Copyright (c) 2001 Intel Corp.
7  * Copyright (c) 2001 La Monte H.P. Yarroll
8  *
9  * This file is part of the SCTP kernel implementation
10  *
11  * This module provides the abstraction for an SCTP transport representing
12  * a remote transport address.  For local transport addresses, we just use
13  * union sctp_addr.
14  *
15  * Please send any bug reports or fixes you make to the
16  * email address(es):
17  *    lksctp developers <linux-sctp@vger.kernel.org>
18  *
19  * Written or modified by:
20  *    La Monte H.P. Yarroll <piggy@acm.org>
21  *    Karl Knutson          <karl@athena.chicago.il.us>
22  *    Jon Grimm             <jgrimm@us.ibm.com>
23  *    Xingang Guo           <xingang.guo@intel.com>
24  *    Hui Huang             <hui.huang@nokia.com>
25  *    Sridhar Samudrala	    <sri@us.ibm.com>
26  *    Ardelle Fan	    <ardelle.fan@intel.com>
27  */
28 
29 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
30 
31 #include <linux/slab.h>
32 #include <linux/types.h>
33 #include <linux/random.h>
34 #include <net/sctp/sctp.h>
35 #include <net/sctp/sm.h>
36 
37 /* 1st Level Abstractions.  */
38 
39 /* Initialize a new transport from provided memory.  */
40 static struct sctp_transport *sctp_transport_init(struct net *net,
41 						  struct sctp_transport *peer,
42 						  const union sctp_addr *addr,
43 						  gfp_t gfp)
44 {
45 	/* Copy in the address.  */
46 	peer->af_specific = sctp_get_af_specific(addr->sa.sa_family);
47 	memcpy(&peer->ipaddr, addr, peer->af_specific->sockaddr_len);
48 	memset(&peer->saddr, 0, sizeof(union sctp_addr));
49 
50 	peer->sack_generation = 0;
51 
52 	/* From 6.3.1 RTO Calculation:
53 	 *
54 	 * C1) Until an RTT measurement has been made for a packet sent to the
55 	 * given destination transport address, set RTO to the protocol
56 	 * parameter 'RTO.Initial'.
57 	 */
58 	peer->rto = msecs_to_jiffies(net->sctp.rto_initial);
59 
60 	peer->last_time_heard = 0;
61 	peer->last_time_ecne_reduced = jiffies;
62 
63 	peer->param_flags = SPP_HB_DISABLE |
64 			    SPP_PMTUD_ENABLE |
65 			    SPP_SACKDELAY_ENABLE;
66 
67 	/* Initialize the default path max_retrans.  */
68 	peer->pathmaxrxt  = net->sctp.max_retrans_path;
69 	peer->pf_retrans  = net->sctp.pf_retrans;
70 
71 	INIT_LIST_HEAD(&peer->transmitted);
72 	INIT_LIST_HEAD(&peer->send_ready);
73 	INIT_LIST_HEAD(&peer->transports);
74 
75 	timer_setup(&peer->T3_rtx_timer, sctp_generate_t3_rtx_event, 0);
76 	timer_setup(&peer->hb_timer, sctp_generate_heartbeat_event, 0);
77 	timer_setup(&peer->reconf_timer, sctp_generate_reconf_event, 0);
78 	timer_setup(&peer->probe_timer, sctp_generate_probe_event, 0);
79 	timer_setup(&peer->proto_unreach_timer,
80 		    sctp_generate_proto_unreach_event, 0);
81 
82 	/* Initialize the 64-bit random nonce sent with heartbeat. */
83 	get_random_bytes(&peer->hb_nonce, sizeof(peer->hb_nonce));
84 
85 	refcount_set(&peer->refcnt, 1);
86 
87 	return peer;
88 }
89 
90 /* Allocate and initialize a new transport.  */
91 struct sctp_transport *sctp_transport_new(struct net *net,
92 					  const union sctp_addr *addr,
93 					  gfp_t gfp)
94 {
95 	struct sctp_transport *transport;
96 
97 	transport = kzalloc(sizeof(*transport), gfp);
98 	if (!transport)
99 		goto fail;
100 
101 	if (!sctp_transport_init(net, transport, addr, gfp))
102 		goto fail_init;
103 
104 	SCTP_DBG_OBJCNT_INC(transport);
105 
106 	return transport;
107 
108 fail_init:
109 	kfree(transport);
110 
111 fail:
112 	return NULL;
113 }
114 
115 /* This transport is no longer needed.  Free up if possible, or
116  * delay until it last reference count.
117  */
118 void sctp_transport_free(struct sctp_transport *transport)
119 {
120 	/* Try to delete the heartbeat timer.  */
121 	if (del_timer(&transport->hb_timer))
122 		sctp_transport_put(transport);
123 
124 	/* Delete the T3_rtx timer if it's active.
125 	 * There is no point in not doing this now and letting
126 	 * structure hang around in memory since we know
127 	 * the transport is going away.
128 	 */
129 	if (del_timer(&transport->T3_rtx_timer))
130 		sctp_transport_put(transport);
131 
132 	if (del_timer(&transport->reconf_timer))
133 		sctp_transport_put(transport);
134 
135 	if (del_timer(&transport->probe_timer))
136 		sctp_transport_put(transport);
137 
138 	/* Delete the ICMP proto unreachable timer if it's active. */
139 	if (del_timer(&transport->proto_unreach_timer))
140 		sctp_transport_put(transport);
141 
142 	sctp_transport_put(transport);
143 }
144 
145 static void sctp_transport_destroy_rcu(struct rcu_head *head)
146 {
147 	struct sctp_transport *transport;
148 
149 	transport = container_of(head, struct sctp_transport, rcu);
150 
151 	dst_release(transport->dst);
152 	kfree(transport);
153 	SCTP_DBG_OBJCNT_DEC(transport);
154 }
155 
156 /* Destroy the transport data structure.
157  * Assumes there are no more users of this structure.
158  */
159 static void sctp_transport_destroy(struct sctp_transport *transport)
160 {
161 	if (unlikely(refcount_read(&transport->refcnt))) {
162 		WARN(1, "Attempt to destroy undead transport %p!\n", transport);
163 		return;
164 	}
165 
166 	sctp_packet_free(&transport->packet);
167 
168 	if (transport->asoc)
169 		sctp_association_put(transport->asoc);
170 
171 	call_rcu(&transport->rcu, sctp_transport_destroy_rcu);
172 }
173 
174 /* Start T3_rtx timer if it is not already running and update the heartbeat
175  * timer.  This routine is called every time a DATA chunk is sent.
176  */
177 void sctp_transport_reset_t3_rtx(struct sctp_transport *transport)
178 {
179 	/* RFC 2960 6.3.2 Retransmission Timer Rules
180 	 *
181 	 * R1) Every time a DATA chunk is sent to any address(including a
182 	 * retransmission), if the T3-rtx timer of that address is not running
183 	 * start it running so that it will expire after the RTO of that
184 	 * address.
185 	 */
186 
187 	if (!timer_pending(&transport->T3_rtx_timer))
188 		if (!mod_timer(&transport->T3_rtx_timer,
189 			       jiffies + transport->rto))
190 			sctp_transport_hold(transport);
191 }
192 
193 void sctp_transport_reset_hb_timer(struct sctp_transport *transport)
194 {
195 	unsigned long expires;
196 
197 	/* When a data chunk is sent, reset the heartbeat interval.  */
198 	expires = jiffies + sctp_transport_timeout(transport);
199 	if ((time_before(transport->hb_timer.expires, expires) ||
200 	     !timer_pending(&transport->hb_timer)) &&
201 	    !mod_timer(&transport->hb_timer,
202 		       expires + prandom_u32_max(transport->rto)))
203 		sctp_transport_hold(transport);
204 }
205 
206 void sctp_transport_reset_reconf_timer(struct sctp_transport *transport)
207 {
208 	if (!timer_pending(&transport->reconf_timer))
209 		if (!mod_timer(&transport->reconf_timer,
210 			       jiffies + transport->rto))
211 			sctp_transport_hold(transport);
212 }
213 
214 void sctp_transport_reset_probe_timer(struct sctp_transport *transport)
215 {
216 	if (timer_pending(&transport->probe_timer))
217 		return;
218 	if (!mod_timer(&transport->probe_timer,
219 		       jiffies + transport->probe_interval))
220 		sctp_transport_hold(transport);
221 }
222 
223 /* This transport has been assigned to an association.
224  * Initialize fields from the association or from the sock itself.
225  * Register the reference count in the association.
226  */
227 void sctp_transport_set_owner(struct sctp_transport *transport,
228 			      struct sctp_association *asoc)
229 {
230 	transport->asoc = asoc;
231 	sctp_association_hold(asoc);
232 }
233 
234 /* Initialize the pmtu of a transport. */
235 void sctp_transport_pmtu(struct sctp_transport *transport, struct sock *sk)
236 {
237 	/* If we don't have a fresh route, look one up */
238 	if (!transport->dst || transport->dst->obsolete) {
239 		sctp_transport_dst_release(transport);
240 		transport->af_specific->get_dst(transport, &transport->saddr,
241 						&transport->fl, sk);
242 	}
243 
244 	if (transport->param_flags & SPP_PMTUD_DISABLE) {
245 		struct sctp_association *asoc = transport->asoc;
246 
247 		if (!transport->pathmtu && asoc && asoc->pathmtu)
248 			transport->pathmtu = asoc->pathmtu;
249 		if (transport->pathmtu)
250 			return;
251 	}
252 
253 	if (transport->dst)
254 		transport->pathmtu = sctp_dst_mtu(transport->dst);
255 	else
256 		transport->pathmtu = SCTP_DEFAULT_MAXSEGMENT;
257 
258 	sctp_transport_pl_update(transport);
259 }
260 
261 void sctp_transport_pl_send(struct sctp_transport *t)
262 {
263 	pr_debug("%s: PLPMTUD: transport: %p, state: %d, pmtu: %d, size: %d, high: %d\n",
264 		 __func__, t, t->pl.state, t->pl.pmtu, t->pl.probe_size, t->pl.probe_high);
265 
266 	if (t->pl.probe_count < SCTP_MAX_PROBES) {
267 		t->pl.probe_count++;
268 		return;
269 	}
270 
271 	if (t->pl.state == SCTP_PL_BASE) {
272 		if (t->pl.probe_size == SCTP_BASE_PLPMTU) { /* BASE_PLPMTU Confirmation Failed */
273 			t->pl.state = SCTP_PL_ERROR; /* Base -> Error */
274 
275 			t->pl.pmtu = SCTP_MIN_PLPMTU;
276 			t->pathmtu = t->pl.pmtu + sctp_transport_pl_hlen(t);
277 			sctp_assoc_sync_pmtu(t->asoc);
278 		}
279 	} else if (t->pl.state == SCTP_PL_SEARCH) {
280 		if (t->pl.pmtu == t->pl.probe_size) { /* Black Hole Detected */
281 			t->pl.state = SCTP_PL_BASE;  /* Search -> Base */
282 			t->pl.probe_size = SCTP_BASE_PLPMTU;
283 			t->pl.probe_high = 0;
284 
285 			t->pl.pmtu = SCTP_BASE_PLPMTU;
286 			t->pathmtu = t->pl.pmtu + sctp_transport_pl_hlen(t);
287 			sctp_assoc_sync_pmtu(t->asoc);
288 		} else { /* Normal probe failure. */
289 			t->pl.probe_high = t->pl.probe_size;
290 			t->pl.probe_size = t->pl.pmtu;
291 		}
292 	} else if (t->pl.state == SCTP_PL_COMPLETE) {
293 		if (t->pl.pmtu == t->pl.probe_size) { /* Black Hole Detected */
294 			t->pl.state = SCTP_PL_BASE;  /* Search Complete -> Base */
295 			t->pl.probe_size = SCTP_BASE_PLPMTU;
296 
297 			t->pl.pmtu = SCTP_BASE_PLPMTU;
298 			t->pathmtu = t->pl.pmtu + sctp_transport_pl_hlen(t);
299 			sctp_assoc_sync_pmtu(t->asoc);
300 		}
301 	}
302 	t->pl.probe_count = 1;
303 }
304 
305 void sctp_transport_pl_recv(struct sctp_transport *t)
306 {
307 	pr_debug("%s: PLPMTUD: transport: %p, state: %d, pmtu: %d, size: %d, high: %d\n",
308 		 __func__, t, t->pl.state, t->pl.pmtu, t->pl.probe_size, t->pl.probe_high);
309 
310 	t->pl.pmtu = t->pl.probe_size;
311 	t->pl.probe_count = 0;
312 	if (t->pl.state == SCTP_PL_BASE) {
313 		t->pl.state = SCTP_PL_SEARCH; /* Base -> Search */
314 		t->pl.probe_size += SCTP_PL_BIG_STEP;
315 	} else if (t->pl.state == SCTP_PL_ERROR) {
316 		t->pl.state = SCTP_PL_SEARCH; /* Error -> Search */
317 
318 		t->pl.pmtu = t->pl.probe_size;
319 		t->pathmtu = t->pl.pmtu + sctp_transport_pl_hlen(t);
320 		sctp_assoc_sync_pmtu(t->asoc);
321 		t->pl.probe_size += SCTP_PL_BIG_STEP;
322 	} else if (t->pl.state == SCTP_PL_SEARCH) {
323 		if (!t->pl.probe_high) {
324 			t->pl.probe_size = min(t->pl.probe_size + SCTP_PL_BIG_STEP,
325 					       SCTP_MAX_PLPMTU);
326 			return;
327 		}
328 		t->pl.probe_size += SCTP_PL_MIN_STEP;
329 		if (t->pl.probe_size >= t->pl.probe_high) {
330 			t->pl.probe_high = 0;
331 			t->pl.raise_count = 0;
332 			t->pl.state = SCTP_PL_COMPLETE; /* Search -> Search Complete */
333 
334 			t->pl.probe_size = t->pl.pmtu;
335 			t->pathmtu = t->pl.pmtu + sctp_transport_pl_hlen(t);
336 			sctp_assoc_sync_pmtu(t->asoc);
337 		}
338 	} else if (t->pl.state == SCTP_PL_COMPLETE && ++t->pl.raise_count == 30) {
339 		/* Raise probe_size again after 30 * interval in Search Complete */
340 		t->pl.state = SCTP_PL_SEARCH; /* Search Complete -> Search */
341 		t->pl.probe_size += SCTP_PL_MIN_STEP;
342 	}
343 }
344 
345 static bool sctp_transport_pl_toobig(struct sctp_transport *t, u32 pmtu)
346 {
347 	pr_debug("%s: PLPMTUD: transport: %p, state: %d, pmtu: %d, size: %d, ptb: %d\n",
348 		 __func__, t, t->pl.state, t->pl.pmtu, t->pl.probe_size, pmtu);
349 
350 	if (pmtu < SCTP_MIN_PLPMTU || pmtu >= t->pl.probe_size)
351 		return false;
352 
353 	if (t->pl.state == SCTP_PL_BASE) {
354 		if (pmtu >= SCTP_MIN_PLPMTU && pmtu < SCTP_BASE_PLPMTU) {
355 			t->pl.state = SCTP_PL_ERROR; /* Base -> Error */
356 
357 			t->pl.pmtu = SCTP_MIN_PLPMTU;
358 			t->pathmtu = t->pl.pmtu + sctp_transport_pl_hlen(t);
359 		}
360 	} else if (t->pl.state == SCTP_PL_SEARCH) {
361 		if (pmtu >= SCTP_BASE_PLPMTU && pmtu < t->pl.pmtu) {
362 			t->pl.state = SCTP_PL_BASE;  /* Search -> Base */
363 			t->pl.probe_size = SCTP_BASE_PLPMTU;
364 			t->pl.probe_count = 0;
365 
366 			t->pl.probe_high = 0;
367 			t->pl.pmtu = SCTP_BASE_PLPMTU;
368 			t->pathmtu = t->pl.pmtu + sctp_transport_pl_hlen(t);
369 		} else if (pmtu > t->pl.pmtu && pmtu < t->pl.probe_size) {
370 			t->pl.probe_size = pmtu;
371 			t->pl.probe_count = 0;
372 
373 			return false;
374 		}
375 	} else if (t->pl.state == SCTP_PL_COMPLETE) {
376 		if (pmtu >= SCTP_BASE_PLPMTU && pmtu < t->pl.pmtu) {
377 			t->pl.state = SCTP_PL_BASE;  /* Complete -> Base */
378 			t->pl.probe_size = SCTP_BASE_PLPMTU;
379 			t->pl.probe_count = 0;
380 
381 			t->pl.probe_high = 0;
382 			t->pl.pmtu = SCTP_BASE_PLPMTU;
383 			t->pathmtu = t->pl.pmtu + sctp_transport_pl_hlen(t);
384 		}
385 	}
386 
387 	return true;
388 }
389 
390 bool sctp_transport_update_pmtu(struct sctp_transport *t, u32 pmtu)
391 {
392 	struct sock *sk = t->asoc->base.sk;
393 	struct dst_entry *dst;
394 	bool change = true;
395 
396 	if (unlikely(pmtu < SCTP_DEFAULT_MINSEGMENT)) {
397 		pr_warn_ratelimited("%s: Reported pmtu %d too low, using default minimum of %d\n",
398 				    __func__, pmtu, SCTP_DEFAULT_MINSEGMENT);
399 		/* Use default minimum segment instead */
400 		pmtu = SCTP_DEFAULT_MINSEGMENT;
401 	}
402 	pmtu = SCTP_TRUNC4(pmtu);
403 
404 	if (sctp_transport_pl_enabled(t))
405 		return sctp_transport_pl_toobig(t, pmtu - sctp_transport_pl_hlen(t));
406 
407 	dst = sctp_transport_dst_check(t);
408 	if (dst) {
409 		struct sctp_pf *pf = sctp_get_pf_specific(dst->ops->family);
410 		union sctp_addr addr;
411 
412 		pf->af->from_sk(&addr, sk);
413 		pf->to_sk_daddr(&t->ipaddr, sk);
414 		dst->ops->update_pmtu(dst, sk, NULL, pmtu, true);
415 		pf->to_sk_daddr(&addr, sk);
416 
417 		dst = sctp_transport_dst_check(t);
418 	}
419 
420 	if (!dst) {
421 		t->af_specific->get_dst(t, &t->saddr, &t->fl, sk);
422 		dst = t->dst;
423 	}
424 
425 	if (dst) {
426 		/* Re-fetch, as under layers may have a higher minimum size */
427 		pmtu = sctp_dst_mtu(dst);
428 		change = t->pathmtu != pmtu;
429 	}
430 	t->pathmtu = pmtu;
431 
432 	return change;
433 }
434 
435 /* Caches the dst entry and source address for a transport's destination
436  * address.
437  */
438 void sctp_transport_route(struct sctp_transport *transport,
439 			  union sctp_addr *saddr, struct sctp_sock *opt)
440 {
441 	struct sctp_association *asoc = transport->asoc;
442 	struct sctp_af *af = transport->af_specific;
443 
444 	sctp_transport_dst_release(transport);
445 	af->get_dst(transport, saddr, &transport->fl, sctp_opt2sk(opt));
446 
447 	if (saddr)
448 		memcpy(&transport->saddr, saddr, sizeof(union sctp_addr));
449 	else
450 		af->get_saddr(opt, transport, &transport->fl);
451 
452 	sctp_transport_pmtu(transport, sctp_opt2sk(opt));
453 
454 	/* Initialize sk->sk_rcv_saddr, if the transport is the
455 	 * association's active path for getsockname().
456 	 */
457 	if (transport->dst && asoc &&
458 	    (!asoc->peer.primary_path || transport == asoc->peer.active_path))
459 		opt->pf->to_sk_saddr(&transport->saddr, asoc->base.sk);
460 }
461 
462 /* Hold a reference to a transport.  */
463 int sctp_transport_hold(struct sctp_transport *transport)
464 {
465 	return refcount_inc_not_zero(&transport->refcnt);
466 }
467 
468 /* Release a reference to a transport and clean up
469  * if there are no more references.
470  */
471 void sctp_transport_put(struct sctp_transport *transport)
472 {
473 	if (refcount_dec_and_test(&transport->refcnt))
474 		sctp_transport_destroy(transport);
475 }
476 
477 /* Update transport's RTO based on the newly calculated RTT. */
478 void sctp_transport_update_rto(struct sctp_transport *tp, __u32 rtt)
479 {
480 	if (unlikely(!tp->rto_pending))
481 		/* We should not be doing any RTO updates unless rto_pending is set.  */
482 		pr_debug("%s: rto_pending not set on transport %p!\n", __func__, tp);
483 
484 	if (tp->rttvar || tp->srtt) {
485 		struct net *net = tp->asoc->base.net;
486 		/* 6.3.1 C3) When a new RTT measurement R' is made, set
487 		 * RTTVAR <- (1 - RTO.Beta) * RTTVAR + RTO.Beta * |SRTT - R'|
488 		 * SRTT <- (1 - RTO.Alpha) * SRTT + RTO.Alpha * R'
489 		 */
490 
491 		/* Note:  The above algorithm has been rewritten to
492 		 * express rto_beta and rto_alpha as inverse powers
493 		 * of two.
494 		 * For example, assuming the default value of RTO.Alpha of
495 		 * 1/8, rto_alpha would be expressed as 3.
496 		 */
497 		tp->rttvar = tp->rttvar - (tp->rttvar >> net->sctp.rto_beta)
498 			+ (((__u32)abs((__s64)tp->srtt - (__s64)rtt)) >> net->sctp.rto_beta);
499 		tp->srtt = tp->srtt - (tp->srtt >> net->sctp.rto_alpha)
500 			+ (rtt >> net->sctp.rto_alpha);
501 	} else {
502 		/* 6.3.1 C2) When the first RTT measurement R is made, set
503 		 * SRTT <- R, RTTVAR <- R/2.
504 		 */
505 		tp->srtt = rtt;
506 		tp->rttvar = rtt >> 1;
507 	}
508 
509 	/* 6.3.1 G1) Whenever RTTVAR is computed, if RTTVAR = 0, then
510 	 * adjust RTTVAR <- G, where G is the CLOCK GRANULARITY.
511 	 */
512 	if (tp->rttvar == 0)
513 		tp->rttvar = SCTP_CLOCK_GRANULARITY;
514 
515 	/* 6.3.1 C3) After the computation, update RTO <- SRTT + 4 * RTTVAR. */
516 	tp->rto = tp->srtt + (tp->rttvar << 2);
517 
518 	/* 6.3.1 C6) Whenever RTO is computed, if it is less than RTO.Min
519 	 * seconds then it is rounded up to RTO.Min seconds.
520 	 */
521 	if (tp->rto < tp->asoc->rto_min)
522 		tp->rto = tp->asoc->rto_min;
523 
524 	/* 6.3.1 C7) A maximum value may be placed on RTO provided it is
525 	 * at least RTO.max seconds.
526 	 */
527 	if (tp->rto > tp->asoc->rto_max)
528 		tp->rto = tp->asoc->rto_max;
529 
530 	sctp_max_rto(tp->asoc, tp);
531 	tp->rtt = rtt;
532 
533 	/* Reset rto_pending so that a new RTT measurement is started when a
534 	 * new data chunk is sent.
535 	 */
536 	tp->rto_pending = 0;
537 
538 	pr_debug("%s: transport:%p, rtt:%d, srtt:%d rttvar:%d, rto:%ld\n",
539 		 __func__, tp, rtt, tp->srtt, tp->rttvar, tp->rto);
540 }
541 
542 /* This routine updates the transport's cwnd and partial_bytes_acked
543  * parameters based on the bytes acked in the received SACK.
544  */
545 void sctp_transport_raise_cwnd(struct sctp_transport *transport,
546 			       __u32 sack_ctsn, __u32 bytes_acked)
547 {
548 	struct sctp_association *asoc = transport->asoc;
549 	__u32 cwnd, ssthresh, flight_size, pba, pmtu;
550 
551 	cwnd = transport->cwnd;
552 	flight_size = transport->flight_size;
553 
554 	/* See if we need to exit Fast Recovery first */
555 	if (asoc->fast_recovery &&
556 	    TSN_lte(asoc->fast_recovery_exit, sack_ctsn))
557 		asoc->fast_recovery = 0;
558 
559 	ssthresh = transport->ssthresh;
560 	pba = transport->partial_bytes_acked;
561 	pmtu = transport->asoc->pathmtu;
562 
563 	if (cwnd <= ssthresh) {
564 		/* RFC 4960 7.2.1
565 		 * o  When cwnd is less than or equal to ssthresh, an SCTP
566 		 *    endpoint MUST use the slow-start algorithm to increase
567 		 *    cwnd only if the current congestion window is being fully
568 		 *    utilized, an incoming SACK advances the Cumulative TSN
569 		 *    Ack Point, and the data sender is not in Fast Recovery.
570 		 *    Only when these three conditions are met can the cwnd be
571 		 *    increased; otherwise, the cwnd MUST not be increased.
572 		 *    If these conditions are met, then cwnd MUST be increased
573 		 *    by, at most, the lesser of 1) the total size of the
574 		 *    previously outstanding DATA chunk(s) acknowledged, and
575 		 *    2) the destination's path MTU.  This upper bound protects
576 		 *    against the ACK-Splitting attack outlined in [SAVAGE99].
577 		 */
578 		if (asoc->fast_recovery)
579 			return;
580 
581 		/* The appropriate cwnd increase algorithm is performed
582 		 * if, and only if the congestion window is being fully
583 		 * utilized.  Note that RFC4960 Errata 3.22 removed the
584 		 * other condition on ctsn moving.
585 		 */
586 		if (flight_size < cwnd)
587 			return;
588 
589 		if (bytes_acked > pmtu)
590 			cwnd += pmtu;
591 		else
592 			cwnd += bytes_acked;
593 
594 		pr_debug("%s: slow start: transport:%p, bytes_acked:%d, "
595 			 "cwnd:%d, ssthresh:%d, flight_size:%d, pba:%d\n",
596 			 __func__, transport, bytes_acked, cwnd, ssthresh,
597 			 flight_size, pba);
598 	} else {
599 		/* RFC 2960 7.2.2 Whenever cwnd is greater than ssthresh,
600 		 * upon each SACK arrival, increase partial_bytes_acked
601 		 * by the total number of bytes of all new chunks
602 		 * acknowledged in that SACK including chunks
603 		 * acknowledged by the new Cumulative TSN Ack and by Gap
604 		 * Ack Blocks. (updated by RFC4960 Errata 3.22)
605 		 *
606 		 * When partial_bytes_acked is greater than cwnd and
607 		 * before the arrival of the SACK the sender had less
608 		 * bytes of data outstanding than cwnd (i.e., before
609 		 * arrival of the SACK, flightsize was less than cwnd),
610 		 * reset partial_bytes_acked to cwnd. (RFC 4960 Errata
611 		 * 3.26)
612 		 *
613 		 * When partial_bytes_acked is equal to or greater than
614 		 * cwnd and before the arrival of the SACK the sender
615 		 * had cwnd or more bytes of data outstanding (i.e.,
616 		 * before arrival of the SACK, flightsize was greater
617 		 * than or equal to cwnd), partial_bytes_acked is reset
618 		 * to (partial_bytes_acked - cwnd). Next, cwnd is
619 		 * increased by MTU. (RFC 4960 Errata 3.12)
620 		 */
621 		pba += bytes_acked;
622 		if (pba > cwnd && flight_size < cwnd)
623 			pba = cwnd;
624 		if (pba >= cwnd && flight_size >= cwnd) {
625 			pba = pba - cwnd;
626 			cwnd += pmtu;
627 		}
628 
629 		pr_debug("%s: congestion avoidance: transport:%p, "
630 			 "bytes_acked:%d, cwnd:%d, ssthresh:%d, "
631 			 "flight_size:%d, pba:%d\n", __func__,
632 			 transport, bytes_acked, cwnd, ssthresh,
633 			 flight_size, pba);
634 	}
635 
636 	transport->cwnd = cwnd;
637 	transport->partial_bytes_acked = pba;
638 }
639 
640 /* This routine is used to lower the transport's cwnd when congestion is
641  * detected.
642  */
643 void sctp_transport_lower_cwnd(struct sctp_transport *transport,
644 			       enum sctp_lower_cwnd reason)
645 {
646 	struct sctp_association *asoc = transport->asoc;
647 
648 	switch (reason) {
649 	case SCTP_LOWER_CWND_T3_RTX:
650 		/* RFC 2960 Section 7.2.3, sctpimpguide
651 		 * When the T3-rtx timer expires on an address, SCTP should
652 		 * perform slow start by:
653 		 *      ssthresh = max(cwnd/2, 4*MTU)
654 		 *      cwnd = 1*MTU
655 		 *      partial_bytes_acked = 0
656 		 */
657 		transport->ssthresh = max(transport->cwnd/2,
658 					  4*asoc->pathmtu);
659 		transport->cwnd = asoc->pathmtu;
660 
661 		/* T3-rtx also clears fast recovery */
662 		asoc->fast_recovery = 0;
663 		break;
664 
665 	case SCTP_LOWER_CWND_FAST_RTX:
666 		/* RFC 2960 7.2.4 Adjust the ssthresh and cwnd of the
667 		 * destination address(es) to which the missing DATA chunks
668 		 * were last sent, according to the formula described in
669 		 * Section 7.2.3.
670 		 *
671 		 * RFC 2960 7.2.3, sctpimpguide Upon detection of packet
672 		 * losses from SACK (see Section 7.2.4), An endpoint
673 		 * should do the following:
674 		 *      ssthresh = max(cwnd/2, 4*MTU)
675 		 *      cwnd = ssthresh
676 		 *      partial_bytes_acked = 0
677 		 */
678 		if (asoc->fast_recovery)
679 			return;
680 
681 		/* Mark Fast recovery */
682 		asoc->fast_recovery = 1;
683 		asoc->fast_recovery_exit = asoc->next_tsn - 1;
684 
685 		transport->ssthresh = max(transport->cwnd/2,
686 					  4*asoc->pathmtu);
687 		transport->cwnd = transport->ssthresh;
688 		break;
689 
690 	case SCTP_LOWER_CWND_ECNE:
691 		/* RFC 2481 Section 6.1.2.
692 		 * If the sender receives an ECN-Echo ACK packet
693 		 * then the sender knows that congestion was encountered in the
694 		 * network on the path from the sender to the receiver. The
695 		 * indication of congestion should be treated just as a
696 		 * congestion loss in non-ECN Capable TCP. That is, the TCP
697 		 * source halves the congestion window "cwnd" and reduces the
698 		 * slow start threshold "ssthresh".
699 		 * A critical condition is that TCP does not react to
700 		 * congestion indications more than once every window of
701 		 * data (or more loosely more than once every round-trip time).
702 		 */
703 		if (time_after(jiffies, transport->last_time_ecne_reduced +
704 					transport->rtt)) {
705 			transport->ssthresh = max(transport->cwnd/2,
706 						  4*asoc->pathmtu);
707 			transport->cwnd = transport->ssthresh;
708 			transport->last_time_ecne_reduced = jiffies;
709 		}
710 		break;
711 
712 	case SCTP_LOWER_CWND_INACTIVE:
713 		/* RFC 2960 Section 7.2.1, sctpimpguide
714 		 * When the endpoint does not transmit data on a given
715 		 * transport address, the cwnd of the transport address
716 		 * should be adjusted to max(cwnd/2, 4*MTU) per RTO.
717 		 * NOTE: Although the draft recommends that this check needs
718 		 * to be done every RTO interval, we do it every hearbeat
719 		 * interval.
720 		 */
721 		transport->cwnd = max(transport->cwnd/2,
722 					 4*asoc->pathmtu);
723 		/* RFC 4960 Errata 3.27.2: also adjust sshthresh */
724 		transport->ssthresh = transport->cwnd;
725 		break;
726 	}
727 
728 	transport->partial_bytes_acked = 0;
729 
730 	pr_debug("%s: transport:%p, reason:%d, cwnd:%d, ssthresh:%d\n",
731 		 __func__, transport, reason, transport->cwnd,
732 		 transport->ssthresh);
733 }
734 
735 /* Apply Max.Burst limit to the congestion window:
736  * sctpimpguide-05 2.14.2
737  * D) When the time comes for the sender to
738  * transmit new DATA chunks, the protocol parameter Max.Burst MUST
739  * first be applied to limit how many new DATA chunks may be sent.
740  * The limit is applied by adjusting cwnd as follows:
741  * 	if ((flightsize+ Max.Burst * MTU) < cwnd)
742  * 		cwnd = flightsize + Max.Burst * MTU
743  */
744 
745 void sctp_transport_burst_limited(struct sctp_transport *t)
746 {
747 	struct sctp_association *asoc = t->asoc;
748 	u32 old_cwnd = t->cwnd;
749 	u32 max_burst_bytes;
750 
751 	if (t->burst_limited || asoc->max_burst == 0)
752 		return;
753 
754 	max_burst_bytes = t->flight_size + (asoc->max_burst * asoc->pathmtu);
755 	if (max_burst_bytes < old_cwnd) {
756 		t->cwnd = max_burst_bytes;
757 		t->burst_limited = old_cwnd;
758 	}
759 }
760 
761 /* Restore the old cwnd congestion window, after the burst had it's
762  * desired effect.
763  */
764 void sctp_transport_burst_reset(struct sctp_transport *t)
765 {
766 	if (t->burst_limited) {
767 		t->cwnd = t->burst_limited;
768 		t->burst_limited = 0;
769 	}
770 }
771 
772 /* What is the next timeout value for this transport? */
773 unsigned long sctp_transport_timeout(struct sctp_transport *trans)
774 {
775 	/* RTO + timer slack +/- 50% of RTO */
776 	unsigned long timeout = trans->rto >> 1;
777 
778 	if (trans->state != SCTP_UNCONFIRMED &&
779 	    trans->state != SCTP_PF)
780 		timeout += trans->hbinterval;
781 
782 	return max_t(unsigned long, timeout, HZ / 5);
783 }
784 
785 /* Reset transport variables to their initial values */
786 void sctp_transport_reset(struct sctp_transport *t)
787 {
788 	struct sctp_association *asoc = t->asoc;
789 
790 	/* RFC 2960 (bis), Section 5.2.4
791 	 * All the congestion control parameters (e.g., cwnd, ssthresh)
792 	 * related to this peer MUST be reset to their initial values
793 	 * (see Section 6.2.1)
794 	 */
795 	t->cwnd = min(4*asoc->pathmtu, max_t(__u32, 2*asoc->pathmtu, 4380));
796 	t->burst_limited = 0;
797 	t->ssthresh = asoc->peer.i.a_rwnd;
798 	t->rto = asoc->rto_initial;
799 	sctp_max_rto(asoc, t);
800 	t->rtt = 0;
801 	t->srtt = 0;
802 	t->rttvar = 0;
803 
804 	/* Reset these additional variables so that we have a clean slate. */
805 	t->partial_bytes_acked = 0;
806 	t->flight_size = 0;
807 	t->error_count = 0;
808 	t->rto_pending = 0;
809 	t->hb_sent = 0;
810 
811 	/* Initialize the state information for SFR-CACC */
812 	t->cacc.changeover_active = 0;
813 	t->cacc.cycling_changeover = 0;
814 	t->cacc.next_tsn_at_change = 0;
815 	t->cacc.cacc_saw_newack = 0;
816 }
817 
818 /* Schedule retransmission on the given transport */
819 void sctp_transport_immediate_rtx(struct sctp_transport *t)
820 {
821 	/* Stop pending T3_rtx_timer */
822 	if (del_timer(&t->T3_rtx_timer))
823 		sctp_transport_put(t);
824 
825 	sctp_retransmit(&t->asoc->outqueue, t, SCTP_RTXR_T3_RTX);
826 	if (!timer_pending(&t->T3_rtx_timer)) {
827 		if (!mod_timer(&t->T3_rtx_timer, jiffies + t->rto))
828 			sctp_transport_hold(t);
829 	}
830 }
831 
832 /* Drop dst */
833 void sctp_transport_dst_release(struct sctp_transport *t)
834 {
835 	dst_release(t->dst);
836 	t->dst = NULL;
837 	t->dst_pending_confirm = 0;
838 }
839 
840 /* Schedule neighbour confirm */
841 void sctp_transport_dst_confirm(struct sctp_transport *t)
842 {
843 	t->dst_pending_confirm = 1;
844 }
845