1 /* SCTP kernel reference Implementation
2 * (C) Copyright IBM Corp. 2001, 2004
3 * Copyright (c) 1999-2000 Cisco, Inc.
4 * Copyright (c) 1999-2001 Motorola, Inc.
6 * This file is part of the SCTP kernel reference Implementation
8 * These functions handle output processing.
10 * The SCTP reference implementation is free software;
11 * you can redistribute it and/or modify it under the terms of
12 * the GNU General Public License as published by
13 * the Free Software Foundation; either version 2, or (at your option)
16 * The SCTP reference implementation is distributed in the hope that it
17 * will be useful, but WITHOUT ANY WARRANTY; without even the implied
18 * ************************
19 * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
20 * See the GNU General Public License for more details.
22 * You should have received a copy of the GNU General Public License
23 * along with GNU CC; see the file COPYING. If not, write to
24 * the Free Software Foundation, 59 Temple Place - Suite 330,
25 * Boston, MA 02111-1307, USA.
27 * Please send any bug reports or fixes you make to the
29 * lksctp developers <lksctp-developers@lists.sourceforge.net>
31 * Or submit a bug report through the following website:
32 * http://www.sf.net/projects/lksctp
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@austin.ibm.com>
38 * Sridhar Samudrala <sri@us.ibm.com>
40 * Any bugs reported given to us we will try to fix... any fixes shared will
41 * be incorporated into the next SCTP release.
44 #include <linux/types.h>
45 #include <linux/kernel.h>
46 #include <linux/wait.h>
47 #include <linux/time.h>
49 #include <linux/ipv6.h>
50 #include <linux/init.h>
51 #include <net/inet_ecn.h>
56 #endif /* TEST_FRAME (not defined) */
58 #include <linux/socket.h> /* for sa_family_t */
61 #include <net/sctp/sctp.h>
62 #include <net/sctp/sm.h>
64 /* Forward declarations for private helpers. */
65 static sctp_xmit_t sctp_packet_append_data(struct sctp_packet *packet,
66 struct sctp_chunk *chunk);
69 * This appears to be a followup set of initializations.
71 struct sctp_packet *sctp_packet_config(struct sctp_packet *packet,
72 __u32 vtag, int ecn_capable)
74 struct sctp_chunk *chunk = NULL;
76 SCTP_DEBUG_PRINTK("%s: packet:%p vtag:0x%x\n", __FUNCTION__,
80 packet->has_cookie_echo = 0;
87 if (ecn_capable && sctp_packet_empty(packet)) {
88 chunk = sctp_get_ecne_prepend(packet->transport->asoc);
90 /* If there a is a prepend chunk stick it on the list before
91 * any other chunks get appended.
94 sctp_packet_append_chunk(packet, chunk);
100 /* Initialize the packet structure. */
101 struct sctp_packet *sctp_packet_init(struct sctp_packet *packet,
102 struct sctp_transport *transport,
103 __u16 sport, __u16 dport)
105 struct sctp_association *asoc = transport->asoc;
108 SCTP_DEBUG_PRINTK("%s: packet:%p transport:%p\n", __FUNCTION__,
111 packet->transport = transport;
112 packet->source_port = sport;
113 packet->destination_port = dport;
114 INIT_LIST_HEAD(&packet->chunk_list);
116 struct sctp_sock *sp = sctp_sk(asoc->base.sk);
117 overhead = sp->pf->af->net_header_len;
119 overhead = sizeof(struct ipv6hdr);
121 overhead += sizeof(struct sctphdr);
122 packet->overhead = overhead;
123 packet->size = overhead;
125 packet->has_cookie_echo = 0;
126 packet->has_sack = 0;
127 packet->has_auth = 0;
128 packet->has_data = 0;
129 packet->ipfragok = 0;
130 packet->malloced = 0;
136 void sctp_packet_free(struct sctp_packet *packet)
138 struct sctp_chunk *chunk, *tmp;
140 SCTP_DEBUG_PRINTK("%s: packet:%p\n", __FUNCTION__, packet);
142 list_for_each_entry_safe(chunk, tmp, &packet->chunk_list, list) {
143 list_del_init(&chunk->list);
144 sctp_chunk_free(chunk);
147 if (packet->malloced)
151 /* This routine tries to append the chunk to the offered packet. If adding
152 * the chunk causes the packet to exceed the path MTU and COOKIE_ECHO chunk
153 * is not present in the packet, it transmits the input packet.
154 * Data can be bundled with a packet containing a COOKIE_ECHO chunk as long
155 * as it can fit in the packet, but any more data that does not fit in this
156 * packet can be sent only after receiving the COOKIE_ACK.
158 sctp_xmit_t sctp_packet_transmit_chunk(struct sctp_packet *packet,
159 struct sctp_chunk *chunk)
164 SCTP_DEBUG_PRINTK("%s: packet:%p chunk:%p\n", __FUNCTION__,
167 switch ((retval = (sctp_packet_append_chunk(packet, chunk)))) {
168 case SCTP_XMIT_PMTU_FULL:
169 if (!packet->has_cookie_echo) {
170 error = sctp_packet_transmit(packet);
172 chunk->skb->sk->sk_err = -error;
174 /* If we have an empty packet, then we can NOT ever
177 retval = sctp_packet_append_chunk(packet, chunk);
181 case SCTP_XMIT_RWND_FULL:
183 case SCTP_XMIT_NAGLE_DELAY:
190 /* Try to bundle an auth chunk into the packet. */
191 static sctp_xmit_t sctp_packet_bundle_auth(struct sctp_packet *pkt,
192 struct sctp_chunk *chunk)
194 struct sctp_association *asoc = pkt->transport->asoc;
195 struct sctp_chunk *auth;
196 sctp_xmit_t retval = SCTP_XMIT_OK;
198 /* if we don't have an association, we can't do authentication */
202 /* See if this is an auth chunk we are bundling or if
203 * auth is already bundled.
205 if (chunk->chunk_hdr->type == SCTP_CID_AUTH || pkt->auth)
208 /* if the peer did not request this chunk to be authenticated,
214 auth = sctp_make_auth(asoc);
218 retval = sctp_packet_append_chunk(pkt, auth);
223 /* Try to bundle a SACK with the packet. */
224 static sctp_xmit_t sctp_packet_bundle_sack(struct sctp_packet *pkt,
225 struct sctp_chunk *chunk)
227 sctp_xmit_t retval = SCTP_XMIT_OK;
229 /* If sending DATA and haven't aleady bundled a SACK, try to
230 * bundle one in to the packet.
232 if (sctp_chunk_is_data(chunk) && !pkt->has_sack &&
233 !pkt->has_cookie_echo) {
234 struct sctp_association *asoc;
235 asoc = pkt->transport->asoc;
237 if (asoc->a_rwnd > asoc->rwnd) {
238 struct sctp_chunk *sack;
239 asoc->a_rwnd = asoc->rwnd;
240 sack = sctp_make_sack(asoc);
242 struct timer_list *timer;
243 retval = sctp_packet_append_chunk(pkt, sack);
244 asoc->peer.sack_needed = 0;
245 timer = &asoc->timers[SCTP_EVENT_TIMEOUT_SACK];
246 if (timer_pending(timer) && del_timer(timer))
247 sctp_association_put(asoc);
254 /* Append a chunk to the offered packet reporting back any inability to do
257 sctp_xmit_t sctp_packet_append_chunk(struct sctp_packet *packet,
258 struct sctp_chunk *chunk)
260 sctp_xmit_t retval = SCTP_XMIT_OK;
261 __u16 chunk_len = WORD_ROUND(ntohs(chunk->chunk_hdr->length));
266 SCTP_DEBUG_PRINTK("%s: packet:%p chunk:%p\n", __FUNCTION__, packet,
269 /* Try to bundle AUTH chunk */
270 retval = sctp_packet_bundle_auth(packet, chunk);
271 if (retval != SCTP_XMIT_OK)
274 /* Try to bundle SACK chunk */
275 retval = sctp_packet_bundle_sack(packet, chunk);
276 if (retval != SCTP_XMIT_OK)
279 psize = packet->size;
280 pmtu = ((packet->transport->asoc) ?
281 (packet->transport->asoc->pathmtu) :
282 (packet->transport->pathmtu));
284 too_big = (psize + chunk_len > pmtu);
286 /* Decide if we need to fragment or resubmit later. */
288 /* It's OK to fragmet at IP level if any one of the following
290 * 1. The packet is empty (meaning this chunk is greater
292 * 2. The chunk we are adding is a control chunk
293 * 3. The packet doesn't have any data in it yet and data
294 * requires authentication.
296 if (sctp_packet_empty(packet) || !sctp_chunk_is_data(chunk) ||
297 (!packet->has_data && chunk->auth)) {
298 /* We no longer do re-fragmentation.
299 * Just fragment at the IP layer, if we
300 * actually hit this condition
302 packet->ipfragok = 1;
306 retval = SCTP_XMIT_PMTU_FULL;
312 /* We believe that this chunk is OK to add to the packet (as
313 * long as we have the cwnd for it).
316 /* DATA is a special case since we must examine both rwnd and cwnd
317 * before we send DATA.
319 switch (chunk->chunk_hdr->type) {
321 retval = sctp_packet_append_data(packet, chunk);
322 /* Disallow SACK bundling after DATA. */
323 packet->has_sack = 1;
324 /* Disallow AUTH bundling after DATA */
325 packet->has_auth = 1;
326 /* Let it be knows that packet has DATA in it */
327 packet->has_data = 1;
328 if (SCTP_XMIT_OK != retval)
331 case SCTP_CID_COOKIE_ECHO:
332 packet->has_cookie_echo = 1;
336 packet->has_sack = 1;
340 packet->has_auth = 1;
341 packet->auth = chunk;
345 /* It is OK to send this chunk. */
346 list_add_tail(&chunk->list, &packet->chunk_list);
347 packet->size += chunk_len;
348 chunk->transport = packet->transport;
353 /* All packets are sent to the network through this function from
356 * The return value is a normal kernel error return value.
358 int sctp_packet_transmit(struct sctp_packet *packet)
360 struct sctp_transport *tp = packet->transport;
361 struct sctp_association *asoc = tp->asoc;
364 struct sk_buff *nskb;
365 struct sctp_chunk *chunk, *tmp;
368 int padding; /* How much padding do we need? */
370 struct dst_entry *dst = tp->dst;
371 unsigned char *auth = NULL; /* pointer to auth in skb data */
372 __u32 cksum_buf_len = sizeof(struct sctphdr);
374 SCTP_DEBUG_PRINTK("%s: packet:%p\n", __FUNCTION__, packet);
376 /* Do NOT generate a chunkless packet. */
377 if (list_empty(&packet->chunk_list))
380 /* Set up convenience variables... */
381 chunk = list_entry(packet->chunk_list.next, struct sctp_chunk, list);
384 /* Allocate the new skb. */
385 nskb = alloc_skb(packet->size + LL_MAX_HEADER, GFP_ATOMIC);
389 /* Make sure the outbound skb has enough header room reserved. */
390 skb_reserve(nskb, packet->overhead + LL_MAX_HEADER);
392 /* Set the owning socket so that we know where to get the
393 * destination IP address.
395 skb_set_owner_w(nskb, sk);
397 /* The 'obsolete' field of dst is set to 2 when a dst is freed. */
398 if (!dst || (dst->obsolete > 1)) {
400 sctp_transport_route(tp, NULL, sctp_sk(sk));
401 if (asoc && (asoc->param_flags & SPP_PMTUD_ENABLE)) {
402 sctp_assoc_sync_pmtu(asoc);
405 nskb->dst = dst_clone(tp->dst);
410 /* Build the SCTP header. */
411 sh = (struct sctphdr *)skb_push(nskb, sizeof(struct sctphdr));
412 sh->source = htons(packet->source_port);
413 sh->dest = htons(packet->destination_port);
415 /* From 6.8 Adler-32 Checksum Calculation:
416 * After the packet is constructed (containing the SCTP common
417 * header and one or more control or DATA chunks), the
420 * 1) Fill in the proper Verification Tag in the SCTP common
421 * header and initialize the checksum field to 0's.
423 sh->vtag = htonl(packet->vtag);
429 * An endpoint bundles chunks by simply including multiple
430 * chunks in one outbound SCTP packet. ...
434 * 3.2 Chunk Field Descriptions
436 * The total length of a chunk (including Type, Length and
437 * Value fields) MUST be a multiple of 4 bytes. If the length
438 * of the chunk is not a multiple of 4 bytes, the sender MUST
439 * pad the chunk with all zero bytes and this padding is not
440 * included in the chunk length field. The sender should
441 * never pad with more than 3 bytes.
443 * [This whole comment explains WORD_ROUND() below.]
445 SCTP_DEBUG_PRINTK("***sctp_transmit_packet***\n");
446 list_for_each_entry_safe(chunk, tmp, &packet->chunk_list, list) {
447 list_del_init(&chunk->list);
448 if (sctp_chunk_is_data(chunk)) {
450 if (!chunk->has_tsn) {
451 sctp_chunk_assign_ssn(chunk);
452 sctp_chunk_assign_tsn(chunk);
454 /* 6.3.1 C4) When data is in flight and when allowed
455 * by rule C5, a new RTT measurement MUST be made each
456 * round trip. Furthermore, new RTT measurements
457 * SHOULD be made no more than once per round-trip
458 * for a given destination transport address.
461 if (!tp->rto_pending) {
462 chunk->rtt_in_progress = 1;
468 chunk->sent_at = jiffies;
472 padding = WORD_ROUND(chunk->skb->len) - chunk->skb->len;
474 memset(skb_put(chunk->skb, padding), 0, padding);
476 /* if this is the auth chunk that we are adding,
477 * store pointer where it will be added and put
478 * the auth into the packet.
480 if (chunk == packet->auth)
481 auth = skb_tail_pointer(nskb);
483 cksum_buf_len += chunk->skb->len;
484 memcpy(skb_put(nskb, chunk->skb->len),
485 chunk->skb->data, chunk->skb->len);
487 SCTP_DEBUG_PRINTK("%s %p[%s] %s 0x%x, %s %d, %s %d, %s %d\n",
489 sctp_cname(SCTP_ST_CHUNK(
490 chunk->chunk_hdr->type)),
491 chunk->has_tsn ? "TSN" : "No TSN",
493 ntohl(chunk->subh.data_hdr->tsn) : 0,
494 "length", ntohs(chunk->chunk_hdr->length),
495 "chunk->skb->len", chunk->skb->len,
496 "rtt_in_progress", chunk->rtt_in_progress);
499 * If this is a control chunk, this is our last
500 * reference. Free data chunks after they've been
501 * acknowledged or have failed.
503 if (!sctp_chunk_is_data(chunk))
504 sctp_chunk_free(chunk);
507 /* SCTP-AUTH, Section 6.2
508 * The sender MUST calculate the MAC as described in RFC2104 [2]
509 * using the hash function H as described by the MAC Identifier and
510 * the shared association key K based on the endpoint pair shared key
511 * described by the shared key identifier. The 'data' used for the
512 * computation of the AUTH-chunk is given by the AUTH chunk with its
513 * HMAC field set to zero (as shown in Figure 6) followed by all
514 * chunks that are placed after the AUTH chunk in the SCTP packet.
517 sctp_auth_calculate_hmac(asoc, nskb,
518 (struct sctp_auth_chunk *)auth,
521 /* 2) Calculate the Adler-32 checksum of the whole packet,
522 * including the SCTP common header and all the
525 * Note: Adler-32 is no longer applicable, as has been replaced
526 * by CRC32-C as described in <draft-ietf-tsvwg-sctpcsum-02.txt>.
528 if (!(dst->dev->features & NETIF_F_NO_CSUM)) {
529 crc32 = sctp_start_cksum((__u8 *)sh, cksum_buf_len);
530 crc32 = sctp_end_cksum(crc32);
533 /* 3) Put the resultant value into the checksum field in the
534 * common header, and leave the rest of the bits unchanged.
536 sh->checksum = htonl(crc32);
538 /* IP layer ECN support
540 * "The ECN-Capable Transport (ECT) bit would be set by the
541 * data sender to indicate that the end-points of the
542 * transport protocol are ECN-capable."
544 * Now setting the ECT bit all the time, as it should not cause
545 * any problems protocol-wise even if our peer ignores it.
547 * Note: The works for IPv6 layer checks this bit too later
548 * in transmission. See IP6_ECN_flow_xmit().
550 INET_ECN_xmit(nskb->sk);
552 /* Set up the IP options. */
553 /* BUG: not implemented
554 * For v4 this all lives somewhere in sk->sk_opt...
557 /* Dump that on IP! */
558 if (asoc && asoc->peer.last_sent_to != tp) {
559 /* Considering the multiple CPU scenario, this is a
560 * "correcter" place for last_sent_to. --xguo
562 asoc->peer.last_sent_to = tp;
566 struct timer_list *timer;
567 unsigned long timeout;
569 tp->last_time_used = jiffies;
571 /* Restart the AUTOCLOSE timer when sending data. */
572 if (sctp_state(asoc, ESTABLISHED) && asoc->autoclose) {
573 timer = &asoc->timers[SCTP_EVENT_TIMEOUT_AUTOCLOSE];
574 timeout = asoc->timeouts[SCTP_EVENT_TIMEOUT_AUTOCLOSE];
576 if (!mod_timer(timer, jiffies + timeout))
577 sctp_association_hold(asoc);
581 SCTP_DEBUG_PRINTK("***sctp_transmit_packet*** skb len %d\n",
584 if (tp->param_flags & SPP_PMTUD_ENABLE)
585 (*tp->af_specific->sctp_xmit)(nskb, tp, packet->ipfragok);
587 (*tp->af_specific->sctp_xmit)(nskb, tp, 1);
590 packet->size = packet->overhead;
594 IP_INC_STATS_BH(IPSTATS_MIB_OUTNOROUTES);
596 /* FIXME: Returning the 'err' will effect all the associations
597 * associated with a socket, although only one of the paths of the
598 * association is unreachable.
599 * The real failure of a transport or association can be passed on
600 * to the user via notifications. So setting this error may not be
603 /* err = -EHOSTUNREACH; */
605 /* Control chunks are unreliable so just drop them. DATA chunks
606 * will get resent or dropped later.
609 list_for_each_entry_safe(chunk, tmp, &packet->chunk_list, list) {
610 list_del_init(&chunk->list);
611 if (!sctp_chunk_is_data(chunk))
612 sctp_chunk_free(chunk);
620 /********************************************************************
621 * 2nd Level Abstractions
622 ********************************************************************/
624 /* This private function handles the specifics of appending DATA chunks. */
625 static sctp_xmit_t sctp_packet_append_data(struct sctp_packet *packet,
626 struct sctp_chunk *chunk)
628 sctp_xmit_t retval = SCTP_XMIT_OK;
629 size_t datasize, rwnd, inflight;
630 struct sctp_transport *transport = packet->transport;
631 __u32 max_burst_bytes;
632 struct sctp_association *asoc = transport->asoc;
633 struct sctp_sock *sp = sctp_sk(asoc->base.sk);
634 struct sctp_outq *q = &asoc->outqueue;
636 /* RFC 2960 6.1 Transmission of DATA Chunks
638 * A) At any given time, the data sender MUST NOT transmit new data to
639 * any destination transport address if its peer's rwnd indicates
640 * that the peer has no buffer space (i.e. rwnd is 0, see Section
641 * 6.2.1). However, regardless of the value of rwnd (including if it
642 * is 0), the data sender can always have one DATA chunk in flight to
643 * the receiver if allowed by cwnd (see rule B below). This rule
644 * allows the sender to probe for a change in rwnd that the sender
645 * missed due to the SACK having been lost in transit from the data
646 * receiver to the data sender.
649 rwnd = asoc->peer.rwnd;
650 inflight = asoc->outqueue.outstanding_bytes;
652 datasize = sctp_data_size(chunk);
654 if (datasize > rwnd) {
656 /* We have (at least) one data chunk in flight,
657 * so we can't fall back to rule 6.1 B).
659 retval = SCTP_XMIT_RWND_FULL;
664 /* sctpimpguide-05 2.14.2
665 * D) When the time comes for the sender to
666 * transmit new DATA chunks, the protocol parameter Max.Burst MUST
667 * first be applied to limit how many new DATA chunks may be sent.
668 * The limit is applied by adjusting cwnd as follows:
669 * if ((flightsize + Max.Burst * MTU) < cwnd)
670 * cwnd = flightsize + Max.Burst * MTU
672 max_burst_bytes = asoc->max_burst * asoc->pathmtu;
673 if ((transport->flight_size + max_burst_bytes) < transport->cwnd) {
674 transport->cwnd = transport->flight_size + max_burst_bytes;
675 SCTP_DEBUG_PRINTK("%s: cwnd limited by max_burst: "
676 "transport: %p, cwnd: %d, "
677 "ssthresh: %d, flight_size: %d, "
679 __FUNCTION__, transport,
682 transport->flight_size,
683 transport->partial_bytes_acked);
686 /* RFC 2960 6.1 Transmission of DATA Chunks
688 * B) At any given time, the sender MUST NOT transmit new data
689 * to a given transport address if it has cwnd or more bytes
690 * of data outstanding to that transport address.
692 /* RFC 7.2.4 & the Implementers Guide 2.8.
695 * When a Fast Retransmit is being performed the sender SHOULD
696 * ignore the value of cwnd and SHOULD NOT delay retransmission.
698 if (chunk->fast_retransmit <= 0)
699 if (transport->flight_size >= transport->cwnd) {
700 retval = SCTP_XMIT_RWND_FULL;
704 /* Nagle's algorithm to solve small-packet problem:
705 * Inhibit the sending of new chunks when new outgoing data arrives
706 * if any previously transmitted data on the connection remains
709 if (!sp->nodelay && sctp_packet_empty(packet) &&
710 q->outstanding_bytes && sctp_state(asoc, ESTABLISHED)) {
711 unsigned len = datasize + q->out_qlen;
713 /* Check whether this chunk and all the rest of pending
714 * data will fit or delay in hopes of bundling a full
717 if (len < asoc->frag_point) {
718 retval = SCTP_XMIT_NAGLE_DELAY;
723 /* Keep track of how many bytes are in flight over this transport. */
724 transport->flight_size += datasize;
726 /* Keep track of how many bytes are in flight to the receiver. */
727 asoc->outqueue.outstanding_bytes += datasize;
729 /* Update our view of the receiver's rwnd. Include sk_buff overhead
730 * while updating peer.rwnd so that it reduces the chances of a
731 * receiver running out of receive buffer space even when receive
732 * window is still open. This can happen when a sender is sending
733 * sending small messages.
735 datasize += sizeof(struct sk_buff);
741 asoc->peer.rwnd = rwnd;
742 /* Has been accepted for transmission. */
743 if (!asoc->peer.prsctp_capable)
744 chunk->msg->can_abandon = 0;