1 /* SCTP kernel implementation
2 * (C) Copyright IBM Corp. 2001, 2004
3 * Copyright (c) 1999-2000 Cisco, Inc.
4 * Copyright (c) 1999-2001 Motorola, Inc.
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 association.
12 * This SCTP implementation is free software;
13 * you can redistribute it and/or modify it under the terms of
14 * the GNU General Public License as published by
15 * the Free Software Foundation; either version 2, or (at your option)
18 * This SCTP implementation is distributed in the hope that it
19 * will be useful, but WITHOUT ANY WARRANTY; without even the implied
20 * ************************
21 * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
22 * See the GNU General Public License for more details.
24 * You should have received a copy of the GNU General Public License
25 * along with GNU CC; see the file COPYING. If not, write to
26 * the Free Software Foundation, 59 Temple Place - Suite 330,
27 * Boston, MA 02111-1307, USA.
29 * Please send any bug reports or fixes you make to the
31 * lksctp developers <lksctp-developers@lists.sourceforge.net>
33 * Or submit a bug report through the following website:
34 * http://www.sf.net/projects/lksctp
36 * Written or modified by:
37 * La Monte H.P. Yarroll <piggy@acm.org>
38 * Karl Knutson <karl@athena.chicago.il.us>
39 * Jon Grimm <jgrimm@us.ibm.com>
40 * Xingang Guo <xingang.guo@intel.com>
41 * Hui Huang <hui.huang@nokia.com>
42 * Sridhar Samudrala <sri@us.ibm.com>
43 * Daisy Chang <daisyc@us.ibm.com>
44 * Ryan Layer <rmlayer@us.ibm.com>
45 * Kevin Gao <kevin.gao@intel.com>
47 * Any bugs reported given to us we will try to fix... any fixes shared will
48 * be incorporated into the next SCTP release.
51 #include <linux/types.h>
52 #include <linux/fcntl.h>
53 #include <linux/poll.h>
54 #include <linux/init.h>
56 #include <linux/slab.h>
59 #include <net/sctp/sctp.h>
60 #include <net/sctp/sm.h>
62 /* Forward declarations for internal functions. */
63 static void sctp_assoc_bh_rcv(struct work_struct *work);
64 static void sctp_assoc_free_asconf_acks(struct sctp_association *asoc);
67 /* 1st Level Abstractions. */
69 /* Initialize a new association from provided memory. */
70 static struct sctp_association *sctp_association_init(struct sctp_association *asoc,
71 const struct sctp_endpoint *ep,
72 const struct sock *sk,
81 /* Retrieve the SCTP per socket area. */
82 sp = sctp_sk((struct sock *)sk);
84 /* Init all variables to a known value. */
85 memset(asoc, 0, sizeof(struct sctp_association));
87 /* Discarding const is appropriate here. */
88 asoc->ep = (struct sctp_endpoint *)ep;
89 sctp_endpoint_hold(asoc->ep);
92 asoc->base.sk = (struct sock *)sk;
93 sock_hold(asoc->base.sk);
95 /* Initialize the common base substructure. */
96 asoc->base.type = SCTP_EP_TYPE_ASSOCIATION;
98 /* Initialize the object handling fields. */
99 atomic_set(&asoc->base.refcnt, 1);
101 asoc->base.malloced = 0;
103 /* Initialize the bind addr area. */
104 sctp_bind_addr_init(&asoc->base.bind_addr, ep->base.bind_addr.port);
106 asoc->state = SCTP_STATE_CLOSED;
108 /* Set these values from the socket values, a conversion between
109 * millsecons to seconds/microseconds must also be done.
111 asoc->cookie_life.tv_sec = sp->assocparams.sasoc_cookie_life / 1000;
112 asoc->cookie_life.tv_usec = (sp->assocparams.sasoc_cookie_life % 1000)
114 asoc->frag_point = 0;
116 /* Set the association max_retrans and RTO values from the
119 asoc->max_retrans = sp->assocparams.sasoc_asocmaxrxt;
120 asoc->rto_initial = msecs_to_jiffies(sp->rtoinfo.srto_initial);
121 asoc->rto_max = msecs_to_jiffies(sp->rtoinfo.srto_max);
122 asoc->rto_min = msecs_to_jiffies(sp->rtoinfo.srto_min);
124 asoc->overall_error_count = 0;
126 /* Initialize the association's heartbeat interval based on the
127 * sock configured value.
129 asoc->hbinterval = msecs_to_jiffies(sp->hbinterval);
131 /* Initialize path max retrans value. */
132 asoc->pathmaxrxt = sp->pathmaxrxt;
134 /* Initialize default path MTU. */
135 asoc->pathmtu = sp->pathmtu;
137 /* Set association default SACK delay */
138 asoc->sackdelay = msecs_to_jiffies(sp->sackdelay);
139 asoc->sackfreq = sp->sackfreq;
141 /* Set the association default flags controlling
142 * Heartbeat, SACK delay, and Path MTU Discovery.
144 asoc->param_flags = sp->param_flags;
146 /* Initialize the maximum mumber of new data packets that can be sent
149 asoc->max_burst = sp->max_burst;
151 /* initialize association timers */
152 asoc->timeouts[SCTP_EVENT_TIMEOUT_NONE] = 0;
153 asoc->timeouts[SCTP_EVENT_TIMEOUT_T1_COOKIE] = asoc->rto_initial;
154 asoc->timeouts[SCTP_EVENT_TIMEOUT_T1_INIT] = asoc->rto_initial;
155 asoc->timeouts[SCTP_EVENT_TIMEOUT_T2_SHUTDOWN] = asoc->rto_initial;
156 asoc->timeouts[SCTP_EVENT_TIMEOUT_T3_RTX] = 0;
157 asoc->timeouts[SCTP_EVENT_TIMEOUT_T4_RTO] = 0;
159 /* sctpimpguide Section 2.12.2
160 * If the 'T5-shutdown-guard' timer is used, it SHOULD be set to the
161 * recommended value of 5 times 'RTO.Max'.
163 asoc->timeouts[SCTP_EVENT_TIMEOUT_T5_SHUTDOWN_GUARD]
166 asoc->timeouts[SCTP_EVENT_TIMEOUT_HEARTBEAT] = 0;
167 asoc->timeouts[SCTP_EVENT_TIMEOUT_SACK] = asoc->sackdelay;
168 asoc->timeouts[SCTP_EVENT_TIMEOUT_AUTOCLOSE] =
171 /* Initilizes the timers */
172 for (i = SCTP_EVENT_TIMEOUT_NONE; i < SCTP_NUM_TIMEOUT_TYPES; ++i)
173 setup_timer(&asoc->timers[i], sctp_timer_events[i],
174 (unsigned long)asoc);
176 /* Pull default initialization values from the sock options.
177 * Note: This assumes that the values have already been
178 * validated in the sock.
180 asoc->c.sinit_max_instreams = sp->initmsg.sinit_max_instreams;
181 asoc->c.sinit_num_ostreams = sp->initmsg.sinit_num_ostreams;
182 asoc->max_init_attempts = sp->initmsg.sinit_max_attempts;
184 asoc->max_init_timeo =
185 msecs_to_jiffies(sp->initmsg.sinit_max_init_timeo);
187 /* Allocate storage for the ssnmap after the inbound and outbound
188 * streams have been negotiated during Init.
192 /* Set the local window size for receive.
193 * This is also the rcvbuf space per association.
194 * RFC 6 - A SCTP receiver MUST be able to receive a minimum of
195 * 1500 bytes in one SCTP packet.
197 if ((sk->sk_rcvbuf/2) < SCTP_DEFAULT_MINWINDOW)
198 asoc->rwnd = SCTP_DEFAULT_MINWINDOW;
200 asoc->rwnd = sk->sk_rcvbuf/2;
202 asoc->a_rwnd = asoc->rwnd;
206 /* Use my own max window until I learn something better. */
207 asoc->peer.rwnd = SCTP_DEFAULT_MAXWINDOW;
209 /* Set the sndbuf size for transmit. */
210 asoc->sndbuf_used = 0;
212 /* Initialize the receive memory counter */
213 atomic_set(&asoc->rmem_alloc, 0);
215 init_waitqueue_head(&asoc->wait);
217 asoc->c.my_vtag = sctp_generate_tag(ep);
218 asoc->peer.i.init_tag = 0; /* INIT needs a vtag of 0. */
219 asoc->c.peer_vtag = 0;
221 asoc->c.peer_ttag = 0;
222 asoc->c.my_port = ep->base.bind_addr.port;
224 asoc->c.initial_tsn = sctp_generate_tsn(ep);
226 asoc->next_tsn = asoc->c.initial_tsn;
228 asoc->ctsn_ack_point = asoc->next_tsn - 1;
229 asoc->adv_peer_ack_point = asoc->ctsn_ack_point;
230 asoc->highest_sacked = asoc->ctsn_ack_point;
231 asoc->last_cwr_tsn = asoc->ctsn_ack_point;
232 asoc->unack_data = 0;
234 /* ADDIP Section 4.1 Asconf Chunk Procedures
236 * When an endpoint has an ASCONF signaled change to be sent to the
237 * remote endpoint it should do the following:
239 * A2) a serial number should be assigned to the chunk. The serial
240 * number SHOULD be a monotonically increasing number. The serial
241 * numbers SHOULD be initialized at the start of the
242 * association to the same value as the initial TSN.
244 asoc->addip_serial = asoc->c.initial_tsn;
246 INIT_LIST_HEAD(&asoc->addip_chunk_list);
247 INIT_LIST_HEAD(&asoc->asconf_ack_list);
249 /* Make an empty list of remote transport addresses. */
250 INIT_LIST_HEAD(&asoc->peer.transport_addr_list);
251 asoc->peer.transport_count = 0;
253 /* RFC 2960 5.1 Normal Establishment of an Association
255 * After the reception of the first data chunk in an
256 * association the endpoint must immediately respond with a
257 * sack to acknowledge the data chunk. Subsequent
258 * acknowledgements should be done as described in Section
261 * [We implement this by telling a new association that it
262 * already received one packet.]
264 asoc->peer.sack_needed = 1;
265 asoc->peer.sack_cnt = 0;
267 /* Assume that the peer will tell us if he recognizes ASCONF
268 * as part of INIT exchange.
269 * The sctp_addip_noauth option is there for backward compatibilty
270 * and will revert old behavior.
272 asoc->peer.asconf_capable = 0;
273 if (sctp_addip_noauth)
274 asoc->peer.asconf_capable = 1;
276 /* Create an input queue. */
277 sctp_inq_init(&asoc->base.inqueue);
278 sctp_inq_set_th_handler(&asoc->base.inqueue, sctp_assoc_bh_rcv);
280 /* Create an output queue. */
281 sctp_outq_init(asoc, &asoc->outqueue);
283 if (!sctp_ulpq_init(&asoc->ulpq, asoc))
286 memset(&asoc->peer.tsn_map, 0, sizeof(struct sctp_tsnmap));
292 /* Assume that peer would support both address types unless we are
295 asoc->peer.ipv4_address = 1;
296 asoc->peer.ipv6_address = 1;
297 INIT_LIST_HEAD(&asoc->asocs);
299 asoc->autoclose = sp->autoclose;
301 asoc->default_stream = sp->default_stream;
302 asoc->default_ppid = sp->default_ppid;
303 asoc->default_flags = sp->default_flags;
304 asoc->default_context = sp->default_context;
305 asoc->default_timetolive = sp->default_timetolive;
306 asoc->default_rcv_context = sp->default_rcv_context;
308 /* AUTH related initializations */
309 INIT_LIST_HEAD(&asoc->endpoint_shared_keys);
310 err = sctp_auth_asoc_copy_shkeys(ep, asoc, gfp);
314 asoc->active_key_id = ep->active_key_id;
315 asoc->asoc_shared_key = NULL;
317 asoc->default_hmac_id = 0;
318 /* Save the hmacs and chunks list into this association */
319 if (ep->auth_hmacs_list)
320 memcpy(asoc->c.auth_hmacs, ep->auth_hmacs_list,
321 ntohs(ep->auth_hmacs_list->param_hdr.length));
322 if (ep->auth_chunk_list)
323 memcpy(asoc->c.auth_chunks, ep->auth_chunk_list,
324 ntohs(ep->auth_chunk_list->param_hdr.length));
326 /* Get the AUTH random number for this association */
327 p = (sctp_paramhdr_t *)asoc->c.auth_random;
328 p->type = SCTP_PARAM_RANDOM;
329 p->length = htons(sizeof(sctp_paramhdr_t) + SCTP_AUTH_RANDOM_LENGTH);
330 get_random_bytes(p+1, SCTP_AUTH_RANDOM_LENGTH);
335 sctp_endpoint_put(asoc->ep);
336 sock_put(asoc->base.sk);
340 /* Allocate and initialize a new association */
341 struct sctp_association *sctp_association_new(const struct sctp_endpoint *ep,
342 const struct sock *sk,
346 struct sctp_association *asoc;
348 asoc = t_new(struct sctp_association, gfp);
352 if (!sctp_association_init(asoc, ep, sk, scope, gfp))
355 asoc->base.malloced = 1;
356 SCTP_DBG_OBJCNT_INC(assoc);
357 SCTP_DEBUG_PRINTK("Created asoc %p\n", asoc);
367 /* Free this association if possible. There may still be users, so
368 * the actual deallocation may be delayed.
370 void sctp_association_free(struct sctp_association *asoc)
372 struct sock *sk = asoc->base.sk;
373 struct sctp_transport *transport;
374 struct list_head *pos, *temp;
377 /* Only real associations count against the endpoint, so
378 * don't bother for if this is a temporary association.
381 list_del(&asoc->asocs);
383 /* Decrement the backlog value for a TCP-style listening
386 if (sctp_style(sk, TCP) && sctp_sstate(sk, LISTENING))
387 sk->sk_ack_backlog--;
390 /* Mark as dead, so other users can know this structure is
395 /* Dispose of any data lying around in the outqueue. */
396 sctp_outq_free(&asoc->outqueue);
398 /* Dispose of any pending messages for the upper layer. */
399 sctp_ulpq_free(&asoc->ulpq);
401 /* Dispose of any pending chunks on the inqueue. */
402 sctp_inq_free(&asoc->base.inqueue);
404 sctp_tsnmap_free(&asoc->peer.tsn_map);
406 /* Free ssnmap storage. */
407 sctp_ssnmap_free(asoc->ssnmap);
409 /* Clean up the bound address list. */
410 sctp_bind_addr_free(&asoc->base.bind_addr);
412 /* Do we need to go through all of our timers and
413 * delete them? To be safe we will try to delete all, but we
414 * should be able to go through and make a guess based
417 for (i = SCTP_EVENT_TIMEOUT_NONE; i < SCTP_NUM_TIMEOUT_TYPES; ++i) {
418 if (timer_pending(&asoc->timers[i]) &&
419 del_timer(&asoc->timers[i]))
420 sctp_association_put(asoc);
423 /* Free peer's cached cookie. */
424 kfree(asoc->peer.cookie);
425 kfree(asoc->peer.peer_random);
426 kfree(asoc->peer.peer_chunks);
427 kfree(asoc->peer.peer_hmacs);
429 /* Release the transport structures. */
430 list_for_each_safe(pos, temp, &asoc->peer.transport_addr_list) {
431 transport = list_entry(pos, struct sctp_transport, transports);
433 sctp_transport_free(transport);
436 asoc->peer.transport_count = 0;
438 /* Free any cached ASCONF_ACK chunk. */
439 sctp_assoc_free_asconf_acks(asoc);
441 /* Free any cached ASCONF chunk. */
442 if (asoc->addip_last_asconf)
443 sctp_chunk_free(asoc->addip_last_asconf);
445 /* AUTH - Free the endpoint shared keys */
446 sctp_auth_destroy_keys(&asoc->endpoint_shared_keys);
448 /* AUTH - Free the association shared key */
449 sctp_auth_key_put(asoc->asoc_shared_key);
451 sctp_association_put(asoc);
454 /* Cleanup and free up an association. */
455 static void sctp_association_destroy(struct sctp_association *asoc)
457 SCTP_ASSERT(asoc->base.dead, "Assoc is not dead", return);
459 sctp_endpoint_put(asoc->ep);
460 sock_put(asoc->base.sk);
462 if (asoc->assoc_id != 0) {
463 spin_lock_bh(&sctp_assocs_id_lock);
464 idr_remove(&sctp_assocs_id, asoc->assoc_id);
465 spin_unlock_bh(&sctp_assocs_id_lock);
468 WARN_ON(atomic_read(&asoc->rmem_alloc));
470 if (asoc->base.malloced) {
472 SCTP_DBG_OBJCNT_DEC(assoc);
476 /* Change the primary destination address for the peer. */
477 void sctp_assoc_set_primary(struct sctp_association *asoc,
478 struct sctp_transport *transport)
482 /* it's a changeover only if we already have a primary path
483 * that we are changing
485 if (asoc->peer.primary_path != NULL &&
486 asoc->peer.primary_path != transport)
489 asoc->peer.primary_path = transport;
491 /* Set a default msg_name for events. */
492 memcpy(&asoc->peer.primary_addr, &transport->ipaddr,
493 sizeof(union sctp_addr));
495 /* If the primary path is changing, assume that the
496 * user wants to use this new path.
498 if ((transport->state == SCTP_ACTIVE) ||
499 (transport->state == SCTP_UNKNOWN))
500 asoc->peer.active_path = transport;
503 * SFR-CACC algorithm:
504 * Upon the receipt of a request to change the primary
505 * destination address, on the data structure for the new
506 * primary destination, the sender MUST do the following:
508 * 1) If CHANGEOVER_ACTIVE is set, then there was a switch
509 * to this destination address earlier. The sender MUST set
510 * CYCLING_CHANGEOVER to indicate that this switch is a
511 * double switch to the same destination address.
513 if (transport->cacc.changeover_active)
514 transport->cacc.cycling_changeover = changeover;
516 /* 2) The sender MUST set CHANGEOVER_ACTIVE to indicate that
517 * a changeover has occurred.
519 transport->cacc.changeover_active = changeover;
521 /* 3) The sender MUST store the next TSN to be sent in
522 * next_tsn_at_change.
524 transport->cacc.next_tsn_at_change = asoc->next_tsn;
527 /* Remove a transport from an association. */
528 void sctp_assoc_rm_peer(struct sctp_association *asoc,
529 struct sctp_transport *peer)
531 struct list_head *pos;
532 struct sctp_transport *transport;
534 SCTP_DEBUG_PRINTK_IPADDR("sctp_assoc_rm_peer:association %p addr: ",
538 ntohs(peer->ipaddr.v4.sin_port));
540 /* If we are to remove the current retran_path, update it
541 * to the next peer before removing this peer from the list.
543 if (asoc->peer.retran_path == peer)
544 sctp_assoc_update_retran_path(asoc);
546 /* Remove this peer from the list. */
547 list_del(&peer->transports);
549 /* Get the first transport of asoc. */
550 pos = asoc->peer.transport_addr_list.next;
551 transport = list_entry(pos, struct sctp_transport, transports);
553 /* Update any entries that match the peer to be deleted. */
554 if (asoc->peer.primary_path == peer)
555 sctp_assoc_set_primary(asoc, transport);
556 if (asoc->peer.active_path == peer)
557 asoc->peer.active_path = transport;
558 if (asoc->peer.last_data_from == peer)
559 asoc->peer.last_data_from = transport;
561 /* If we remove the transport an INIT was last sent to, set it to
562 * NULL. Combined with the update of the retran path above, this
563 * will cause the next INIT to be sent to the next available
564 * transport, maintaining the cycle.
566 if (asoc->init_last_sent_to == peer)
567 asoc->init_last_sent_to = NULL;
569 asoc->peer.transport_count--;
571 sctp_transport_free(peer);
574 /* Add a transport address to an association. */
575 struct sctp_transport *sctp_assoc_add_peer(struct sctp_association *asoc,
576 const union sctp_addr *addr,
578 const int peer_state)
580 struct sctp_transport *peer;
581 struct sctp_sock *sp;
584 sp = sctp_sk(asoc->base.sk);
586 /* AF_INET and AF_INET6 share common port field. */
587 port = ntohs(addr->v4.sin_port);
589 SCTP_DEBUG_PRINTK_IPADDR("sctp_assoc_add_peer:association %p addr: ",
590 " port: %d state:%d\n",
596 /* Set the port if it has not been set yet. */
597 if (0 == asoc->peer.port)
598 asoc->peer.port = port;
600 /* Check to see if this is a duplicate. */
601 peer = sctp_assoc_lookup_paddr(asoc, addr);
603 /* An UNKNOWN state is only set on transports added by
604 * user in sctp_connectx() call. Such transports should be
605 * considered CONFIRMED per RFC 4960, Section 5.4.
607 if (peer->state == SCTP_UNKNOWN) {
608 peer->state = SCTP_ACTIVE;
613 peer = sctp_transport_new(addr, gfp);
617 sctp_transport_set_owner(peer, asoc);
619 /* Initialize the peer's heartbeat interval based on the
620 * association configured value.
622 peer->hbinterval = asoc->hbinterval;
624 /* Set the path max_retrans. */
625 peer->pathmaxrxt = asoc->pathmaxrxt;
627 /* Initialize the peer's SACK delay timeout based on the
628 * association configured value.
630 peer->sackdelay = asoc->sackdelay;
631 peer->sackfreq = asoc->sackfreq;
633 /* Enable/disable heartbeat, SACK delay, and path MTU discovery
634 * based on association setting.
636 peer->param_flags = asoc->param_flags;
638 /* Initialize the pmtu of the transport. */
639 if (peer->param_flags & SPP_PMTUD_ENABLE)
640 sctp_transport_pmtu(peer);
641 else if (asoc->pathmtu)
642 peer->pathmtu = asoc->pathmtu;
644 peer->pathmtu = SCTP_DEFAULT_MAXSEGMENT;
646 /* If this is the first transport addr on this association,
647 * initialize the association PMTU to the peer's PMTU.
648 * If not and the current association PMTU is higher than the new
649 * peer's PMTU, reset the association PMTU to the new peer's PMTU.
652 asoc->pathmtu = min_t(int, peer->pathmtu, asoc->pathmtu);
654 asoc->pathmtu = peer->pathmtu;
656 SCTP_DEBUG_PRINTK("sctp_assoc_add_peer:association %p PMTU set to "
657 "%d\n", asoc, asoc->pathmtu);
658 peer->pmtu_pending = 0;
660 asoc->frag_point = sctp_frag_point(sp, asoc->pathmtu);
662 /* The asoc->peer.port might not be meaningful yet, but
663 * initialize the packet structure anyway.
665 sctp_packet_init(&peer->packet, peer, asoc->base.bind_addr.port,
670 * o The initial cwnd before DATA transmission or after a sufficiently
671 * long idle period MUST be set to
672 * min(4*MTU, max(2*MTU, 4380 bytes))
674 * o The initial value of ssthresh MAY be arbitrarily high
675 * (for example, implementations MAY use the size of the
676 * receiver advertised window).
678 peer->cwnd = min(4*asoc->pathmtu, max_t(__u32, 2*asoc->pathmtu, 4380));
680 /* At this point, we may not have the receiver's advertised window,
681 * so initialize ssthresh to the default value and it will be set
682 * later when we process the INIT.
684 peer->ssthresh = SCTP_DEFAULT_MAXWINDOW;
686 peer->partial_bytes_acked = 0;
687 peer->flight_size = 0;
689 /* Set the transport's RTO.initial value */
690 peer->rto = asoc->rto_initial;
692 /* Set the peer's active state. */
693 peer->state = peer_state;
695 /* Attach the remote transport to our asoc. */
696 list_add_tail(&peer->transports, &asoc->peer.transport_addr_list);
697 asoc->peer.transport_count++;
699 /* If we do not yet have a primary path, set one. */
700 if (!asoc->peer.primary_path) {
701 sctp_assoc_set_primary(asoc, peer);
702 asoc->peer.retran_path = peer;
705 if (asoc->peer.active_path == asoc->peer.retran_path) {
706 asoc->peer.retran_path = peer;
712 /* Delete a transport address from an association. */
713 void sctp_assoc_del_peer(struct sctp_association *asoc,
714 const union sctp_addr *addr)
716 struct list_head *pos;
717 struct list_head *temp;
718 struct sctp_transport *transport;
720 list_for_each_safe(pos, temp, &asoc->peer.transport_addr_list) {
721 transport = list_entry(pos, struct sctp_transport, transports);
722 if (sctp_cmp_addr_exact(addr, &transport->ipaddr)) {
723 /* Do book keeping for removing the peer and free it. */
724 sctp_assoc_rm_peer(asoc, transport);
730 /* Lookup a transport by address. */
731 struct sctp_transport *sctp_assoc_lookup_paddr(
732 const struct sctp_association *asoc,
733 const union sctp_addr *address)
735 struct sctp_transport *t;
737 /* Cycle through all transports searching for a peer address. */
739 list_for_each_entry(t, &asoc->peer.transport_addr_list,
741 if (sctp_cmp_addr_exact(address, &t->ipaddr))
748 /* Remove all transports except a give one */
749 void sctp_assoc_del_nonprimary_peers(struct sctp_association *asoc,
750 struct sctp_transport *primary)
752 struct sctp_transport *temp;
753 struct sctp_transport *t;
755 list_for_each_entry_safe(t, temp, &asoc->peer.transport_addr_list,
757 /* if the current transport is not the primary one, delete it */
759 sctp_assoc_rm_peer(asoc, t);
765 /* Engage in transport control operations.
766 * Mark the transport up or down and send a notification to the user.
767 * Select and update the new active and retran paths.
769 void sctp_assoc_control_transport(struct sctp_association *asoc,
770 struct sctp_transport *transport,
771 sctp_transport_cmd_t command,
772 sctp_sn_error_t error)
774 struct sctp_transport *t = NULL;
775 struct sctp_transport *first;
776 struct sctp_transport *second;
777 struct sctp_ulpevent *event;
778 struct sockaddr_storage addr;
781 /* Record the transition on the transport. */
783 case SCTP_TRANSPORT_UP:
784 /* If we are moving from UNCONFIRMED state due
785 * to heartbeat success, report the SCTP_ADDR_CONFIRMED
786 * state to the user, otherwise report SCTP_ADDR_AVAILABLE.
788 if (SCTP_UNCONFIRMED == transport->state &&
789 SCTP_HEARTBEAT_SUCCESS == error)
790 spc_state = SCTP_ADDR_CONFIRMED;
792 spc_state = SCTP_ADDR_AVAILABLE;
793 transport->state = SCTP_ACTIVE;
796 case SCTP_TRANSPORT_DOWN:
797 /* if the transort was never confirmed, do not transition it
800 if (transport->state != SCTP_UNCONFIRMED)
801 transport->state = SCTP_INACTIVE;
803 spc_state = SCTP_ADDR_UNREACHABLE;
810 /* Generate and send a SCTP_PEER_ADDR_CHANGE notification to the
813 memset(&addr, 0, sizeof(struct sockaddr_storage));
814 memcpy(&addr, &transport->ipaddr, transport->af_specific->sockaddr_len);
815 event = sctp_ulpevent_make_peer_addr_change(asoc, &addr,
816 0, spc_state, error, GFP_ATOMIC);
818 sctp_ulpq_tail_event(&asoc->ulpq, event);
820 /* Select new active and retran paths. */
822 /* Look for the two most recently used active transports.
824 * This code produces the wrong ordering whenever jiffies
825 * rolls over, but we still get usable transports, so we don't
828 first = NULL; second = NULL;
830 list_for_each_entry(t, &asoc->peer.transport_addr_list,
833 if ((t->state == SCTP_INACTIVE) ||
834 (t->state == SCTP_UNCONFIRMED))
836 if (!first || t->last_time_heard > first->last_time_heard) {
840 if (!second || t->last_time_heard > second->last_time_heard)
844 /* RFC 2960 6.4 Multi-Homed SCTP Endpoints
846 * By default, an endpoint should always transmit to the
847 * primary path, unless the SCTP user explicitly specifies the
848 * destination transport address (and possibly source
849 * transport address) to use.
851 * [If the primary is active but not most recent, bump the most
852 * recently used transport.]
854 if (((asoc->peer.primary_path->state == SCTP_ACTIVE) ||
855 (asoc->peer.primary_path->state == SCTP_UNKNOWN)) &&
856 first != asoc->peer.primary_path) {
858 first = asoc->peer.primary_path;
861 /* If we failed to find a usable transport, just camp on the
862 * primary, even if it is inactive.
865 first = asoc->peer.primary_path;
866 second = asoc->peer.primary_path;
869 /* Set the active and retran transports. */
870 asoc->peer.active_path = first;
871 asoc->peer.retran_path = second;
874 /* Hold a reference to an association. */
875 void sctp_association_hold(struct sctp_association *asoc)
877 atomic_inc(&asoc->base.refcnt);
880 /* Release a reference to an association and cleanup
881 * if there are no more references.
883 void sctp_association_put(struct sctp_association *asoc)
885 if (atomic_dec_and_test(&asoc->base.refcnt))
886 sctp_association_destroy(asoc);
889 /* Allocate the next TSN, Transmission Sequence Number, for the given
892 __u32 sctp_association_get_next_tsn(struct sctp_association *asoc)
894 /* From Section 1.6 Serial Number Arithmetic:
895 * Transmission Sequence Numbers wrap around when they reach
896 * 2**32 - 1. That is, the next TSN a DATA chunk MUST use
897 * after transmitting TSN = 2*32 - 1 is TSN = 0.
899 __u32 retval = asoc->next_tsn;
906 /* Compare two addresses to see if they match. Wildcard addresses
907 * only match themselves.
909 int sctp_cmp_addr_exact(const union sctp_addr *ss1,
910 const union sctp_addr *ss2)
914 af = sctp_get_af_specific(ss1->sa.sa_family);
918 return af->cmp_addr(ss1, ss2);
921 /* Return an ecne chunk to get prepended to a packet.
922 * Note: We are sly and return a shared, prealloced chunk. FIXME:
923 * No we don't, but we could/should.
925 struct sctp_chunk *sctp_get_ecne_prepend(struct sctp_association *asoc)
927 struct sctp_chunk *chunk;
929 /* Send ECNE if needed.
930 * Not being able to allocate a chunk here is not deadly.
933 chunk = sctp_make_ecne(asoc, asoc->last_ecne_tsn);
941 * Find which transport this TSN was sent on.
943 struct sctp_transport *sctp_assoc_lookup_tsn(struct sctp_association *asoc,
946 struct sctp_transport *active;
947 struct sctp_transport *match;
948 struct sctp_transport *transport;
949 struct sctp_chunk *chunk;
950 __be32 key = htonl(tsn);
955 * FIXME: In general, find a more efficient data structure for
960 * The general strategy is to search each transport's transmitted
961 * list. Return which transport this TSN lives on.
963 * Let's be hopeful and check the active_path first.
964 * Another optimization would be to know if there is only one
965 * outbound path and not have to look for the TSN at all.
969 active = asoc->peer.active_path;
971 list_for_each_entry(chunk, &active->transmitted,
974 if (key == chunk->subh.data_hdr->tsn) {
980 /* If not found, go search all the other transports. */
981 list_for_each_entry(transport, &asoc->peer.transport_addr_list,
984 if (transport == active)
986 list_for_each_entry(chunk, &transport->transmitted,
988 if (key == chunk->subh.data_hdr->tsn) {
998 /* Is this the association we are looking for? */
999 struct sctp_transport *sctp_assoc_is_match(struct sctp_association *asoc,
1000 const union sctp_addr *laddr,
1001 const union sctp_addr *paddr)
1003 struct sctp_transport *transport;
1005 if ((htons(asoc->base.bind_addr.port) == laddr->v4.sin_port) &&
1006 (htons(asoc->peer.port) == paddr->v4.sin_port)) {
1007 transport = sctp_assoc_lookup_paddr(asoc, paddr);
1011 if (sctp_bind_addr_match(&asoc->base.bind_addr, laddr,
1012 sctp_sk(asoc->base.sk)))
1021 /* Do delayed input processing. This is scheduled by sctp_rcv(). */
1022 static void sctp_assoc_bh_rcv(struct work_struct *work)
1024 struct sctp_association *asoc =
1025 container_of(work, struct sctp_association,
1026 base.inqueue.immediate);
1027 struct sctp_endpoint *ep;
1028 struct sctp_chunk *chunk;
1030 struct sctp_inq *inqueue;
1032 sctp_subtype_t subtype;
1035 /* The association should be held so we should be safe. */
1039 inqueue = &asoc->base.inqueue;
1040 sctp_association_hold(asoc);
1041 while (NULL != (chunk = sctp_inq_pop(inqueue))) {
1042 state = asoc->state;
1043 subtype = SCTP_ST_CHUNK(chunk->chunk_hdr->type);
1045 /* SCTP-AUTH, Section 6.3:
1046 * The receiver has a list of chunk types which it expects
1047 * to be received only after an AUTH-chunk. This list has
1048 * been sent to the peer during the association setup. It
1049 * MUST silently discard these chunks if they are not placed
1050 * after an AUTH chunk in the packet.
1052 if (sctp_auth_recv_cid(subtype.chunk, asoc) && !chunk->auth)
1055 /* Remember where the last DATA chunk came from so we
1056 * know where to send the SACK.
1058 if (sctp_chunk_is_data(chunk))
1059 asoc->peer.last_data_from = chunk->transport;
1061 SCTP_INC_STATS(SCTP_MIB_INCTRLCHUNKS);
1063 if (chunk->transport)
1064 chunk->transport->last_time_heard = jiffies;
1066 /* Run through the state machine. */
1067 error = sctp_do_sm(SCTP_EVENT_T_CHUNK, subtype,
1068 state, ep, asoc, chunk, GFP_ATOMIC);
1070 /* Check to see if the association is freed in response to
1071 * the incoming chunk. If so, get out of the while loop.
1073 if (asoc->base.dead)
1076 /* If there is an error on chunk, discard this packet. */
1078 chunk->pdiscard = 1;
1080 sctp_association_put(asoc);
1083 /* This routine moves an association from its old sk to a new sk. */
1084 void sctp_assoc_migrate(struct sctp_association *assoc, struct sock *newsk)
1086 struct sctp_sock *newsp = sctp_sk(newsk);
1087 struct sock *oldsk = assoc->base.sk;
1089 /* Delete the association from the old endpoint's list of
1092 list_del_init(&assoc->asocs);
1094 /* Decrement the backlog value for a TCP-style socket. */
1095 if (sctp_style(oldsk, TCP))
1096 oldsk->sk_ack_backlog--;
1098 /* Release references to the old endpoint and the sock. */
1099 sctp_endpoint_put(assoc->ep);
1100 sock_put(assoc->base.sk);
1102 /* Get a reference to the new endpoint. */
1103 assoc->ep = newsp->ep;
1104 sctp_endpoint_hold(assoc->ep);
1106 /* Get a reference to the new sock. */
1107 assoc->base.sk = newsk;
1108 sock_hold(assoc->base.sk);
1110 /* Add the association to the new endpoint's list of associations. */
1111 sctp_endpoint_add_asoc(newsp->ep, assoc);
1114 /* Update an association (possibly from unexpected COOKIE-ECHO processing). */
1115 void sctp_assoc_update(struct sctp_association *asoc,
1116 struct sctp_association *new)
1118 struct sctp_transport *trans;
1119 struct list_head *pos, *temp;
1121 /* Copy in new parameters of peer. */
1123 asoc->peer.rwnd = new->peer.rwnd;
1124 asoc->peer.sack_needed = new->peer.sack_needed;
1125 asoc->peer.i = new->peer.i;
1126 sctp_tsnmap_init(&asoc->peer.tsn_map, SCTP_TSN_MAP_INITIAL,
1127 asoc->peer.i.initial_tsn, GFP_ATOMIC);
1129 /* Remove any peer addresses not present in the new association. */
1130 list_for_each_safe(pos, temp, &asoc->peer.transport_addr_list) {
1131 trans = list_entry(pos, struct sctp_transport, transports);
1132 if (!sctp_assoc_lookup_paddr(new, &trans->ipaddr))
1133 sctp_assoc_del_peer(asoc, &trans->ipaddr);
1135 if (asoc->state >= SCTP_STATE_ESTABLISHED)
1136 sctp_transport_reset(trans);
1139 /* If the case is A (association restart), use
1140 * initial_tsn as next_tsn. If the case is B, use
1141 * current next_tsn in case data sent to peer
1142 * has been discarded and needs retransmission.
1144 if (asoc->state >= SCTP_STATE_ESTABLISHED) {
1145 asoc->next_tsn = new->next_tsn;
1146 asoc->ctsn_ack_point = new->ctsn_ack_point;
1147 asoc->adv_peer_ack_point = new->adv_peer_ack_point;
1149 /* Reinitialize SSN for both local streams
1150 * and peer's streams.
1152 sctp_ssnmap_clear(asoc->ssnmap);
1154 /* Flush the ULP reassembly and ordered queue.
1155 * Any data there will now be stale and will
1158 sctp_ulpq_flush(&asoc->ulpq);
1160 /* reset the overall association error count so
1161 * that the restarted association doesn't get torn
1162 * down on the next retransmission timer.
1164 asoc->overall_error_count = 0;
1167 /* Add any peer addresses from the new association. */
1168 list_for_each_entry(trans, &new->peer.transport_addr_list,
1170 if (!sctp_assoc_lookup_paddr(asoc, &trans->ipaddr))
1171 sctp_assoc_add_peer(asoc, &trans->ipaddr,
1172 GFP_ATOMIC, trans->state);
1175 asoc->ctsn_ack_point = asoc->next_tsn - 1;
1176 asoc->adv_peer_ack_point = asoc->ctsn_ack_point;
1177 if (!asoc->ssnmap) {
1178 /* Move the ssnmap. */
1179 asoc->ssnmap = new->ssnmap;
1183 if (!asoc->assoc_id) {
1184 /* get a new association id since we don't have one
1187 sctp_assoc_set_id(asoc, GFP_ATOMIC);
1191 /* SCTP-AUTH: Save the peer parameters from the new assocaitions
1192 * and also move the association shared keys over
1194 kfree(asoc->peer.peer_random);
1195 asoc->peer.peer_random = new->peer.peer_random;
1196 new->peer.peer_random = NULL;
1198 kfree(asoc->peer.peer_chunks);
1199 asoc->peer.peer_chunks = new->peer.peer_chunks;
1200 new->peer.peer_chunks = NULL;
1202 kfree(asoc->peer.peer_hmacs);
1203 asoc->peer.peer_hmacs = new->peer.peer_hmacs;
1204 new->peer.peer_hmacs = NULL;
1206 sctp_auth_key_put(asoc->asoc_shared_key);
1207 sctp_auth_asoc_init_active_key(asoc, GFP_ATOMIC);
1210 /* Update the retran path for sending a retransmitted packet.
1211 * Round-robin through the active transports, else round-robin
1212 * through the inactive transports as this is the next best thing
1215 void sctp_assoc_update_retran_path(struct sctp_association *asoc)
1217 struct sctp_transport *t, *next;
1218 struct list_head *head = &asoc->peer.transport_addr_list;
1219 struct list_head *pos;
1221 if (asoc->peer.transport_count == 1)
1224 /* Find the next transport in a round-robin fashion. */
1225 t = asoc->peer.retran_path;
1226 pos = &t->transports;
1230 /* Skip the head. */
1231 if (pos->next == head)
1236 t = list_entry(pos, struct sctp_transport, transports);
1238 /* We have exhausted the list, but didn't find any
1239 * other active transports. If so, use the next
1242 if (t == asoc->peer.retran_path) {
1247 /* Try to find an active transport. */
1249 if ((t->state == SCTP_ACTIVE) ||
1250 (t->state == SCTP_UNKNOWN)) {
1253 /* Keep track of the next transport in case
1254 * we don't find any active transport.
1261 asoc->peer.retran_path = t;
1263 SCTP_DEBUG_PRINTK_IPADDR("sctp_assoc_update_retran_path:association"
1268 ntohs(t->ipaddr.v4.sin_port));
1271 /* Choose the transport for sending a INIT packet. */
1272 struct sctp_transport *sctp_assoc_choose_init_transport(
1273 struct sctp_association *asoc)
1275 struct sctp_transport *t;
1277 /* Use the retran path. If the last INIT was sent over the
1278 * retran path, update the retran path and use it.
1280 if (!asoc->init_last_sent_to) {
1281 t = asoc->peer.active_path;
1283 if (asoc->init_last_sent_to == asoc->peer.retran_path)
1284 sctp_assoc_update_retran_path(asoc);
1285 t = asoc->peer.retran_path;
1288 SCTP_DEBUG_PRINTK_IPADDR("sctp_assoc_update_retran_path:association"
1293 ntohs(t->ipaddr.v4.sin_port));
1298 /* Choose the transport for sending a SHUTDOWN packet. */
1299 struct sctp_transport *sctp_assoc_choose_shutdown_transport(
1300 struct sctp_association *asoc)
1302 /* If this is the first time SHUTDOWN is sent, use the active path,
1303 * else use the retran path. If the last SHUTDOWN was sent over the
1304 * retran path, update the retran path and use it.
1306 if (!asoc->shutdown_last_sent_to)
1307 return asoc->peer.active_path;
1309 if (asoc->shutdown_last_sent_to == asoc->peer.retran_path)
1310 sctp_assoc_update_retran_path(asoc);
1311 return asoc->peer.retran_path;
1316 /* Update the association's pmtu and frag_point by going through all the
1317 * transports. This routine is called when a transport's PMTU has changed.
1319 void sctp_assoc_sync_pmtu(struct sctp_association *asoc)
1321 struct sctp_transport *t;
1327 /* Get the lowest pmtu of all the transports. */
1328 list_for_each_entry(t, &asoc->peer.transport_addr_list,
1330 if (t->pmtu_pending && t->dst) {
1331 sctp_transport_update_pmtu(t, dst_mtu(t->dst));
1332 t->pmtu_pending = 0;
1334 if (!pmtu || (t->pathmtu < pmtu))
1339 struct sctp_sock *sp = sctp_sk(asoc->base.sk);
1340 asoc->pathmtu = pmtu;
1341 asoc->frag_point = sctp_frag_point(sp, pmtu);
1344 SCTP_DEBUG_PRINTK("%s: asoc:%p, pmtu:%d, frag_point:%d\n",
1345 __func__, asoc, asoc->pathmtu, asoc->frag_point);
1348 /* Should we send a SACK to update our peer? */
1349 static inline int sctp_peer_needs_update(struct sctp_association *asoc)
1351 switch (asoc->state) {
1352 case SCTP_STATE_ESTABLISHED:
1353 case SCTP_STATE_SHUTDOWN_PENDING:
1354 case SCTP_STATE_SHUTDOWN_RECEIVED:
1355 case SCTP_STATE_SHUTDOWN_SENT:
1356 if ((asoc->rwnd > asoc->a_rwnd) &&
1357 ((asoc->rwnd - asoc->a_rwnd) >=
1358 min_t(__u32, (asoc->base.sk->sk_rcvbuf >> 1), asoc->pathmtu)))
1367 /* Increase asoc's rwnd by len and send any window update SACK if needed. */
1368 void sctp_assoc_rwnd_increase(struct sctp_association *asoc, unsigned len)
1370 struct sctp_chunk *sack;
1371 struct timer_list *timer;
1373 if (asoc->rwnd_over) {
1374 if (asoc->rwnd_over >= len) {
1375 asoc->rwnd_over -= len;
1377 asoc->rwnd += (len - asoc->rwnd_over);
1378 asoc->rwnd_over = 0;
1384 SCTP_DEBUG_PRINTK("%s: asoc %p rwnd increased by %d to (%u, %u) "
1385 "- %u\n", __func__, asoc, len, asoc->rwnd,
1386 asoc->rwnd_over, asoc->a_rwnd);
1388 /* Send a window update SACK if the rwnd has increased by at least the
1389 * minimum of the association's PMTU and half of the receive buffer.
1390 * The algorithm used is similar to the one described in
1391 * Section 4.2.3.3 of RFC 1122.
1393 if (sctp_peer_needs_update(asoc)) {
1394 asoc->a_rwnd = asoc->rwnd;
1395 SCTP_DEBUG_PRINTK("%s: Sending window update SACK- asoc: %p "
1396 "rwnd: %u a_rwnd: %u\n", __func__,
1397 asoc, asoc->rwnd, asoc->a_rwnd);
1398 sack = sctp_make_sack(asoc);
1402 asoc->peer.sack_needed = 0;
1404 sctp_outq_tail(&asoc->outqueue, sack);
1406 /* Stop the SACK timer. */
1407 timer = &asoc->timers[SCTP_EVENT_TIMEOUT_SACK];
1408 if (timer_pending(timer) && del_timer(timer))
1409 sctp_association_put(asoc);
1413 /* Decrease asoc's rwnd by len. */
1414 void sctp_assoc_rwnd_decrease(struct sctp_association *asoc, unsigned len)
1416 SCTP_ASSERT(asoc->rwnd, "rwnd zero", return);
1417 SCTP_ASSERT(!asoc->rwnd_over, "rwnd_over not zero", return);
1418 if (asoc->rwnd >= len) {
1421 asoc->rwnd_over = len - asoc->rwnd;
1424 SCTP_DEBUG_PRINTK("%s: asoc %p rwnd decreased by %d to (%u, %u)\n",
1425 __func__, asoc, len, asoc->rwnd,
1429 /* Build the bind address list for the association based on info from the
1430 * local endpoint and the remote peer.
1432 int sctp_assoc_set_bind_addr_from_ep(struct sctp_association *asoc,
1438 /* Use scoping rules to determine the subset of addresses from
1441 scope = sctp_scope(&asoc->peer.active_path->ipaddr);
1442 flags = (PF_INET6 == asoc->base.sk->sk_family) ? SCTP_ADDR6_ALLOWED : 0;
1443 if (asoc->peer.ipv4_address)
1444 flags |= SCTP_ADDR4_PEERSUPP;
1445 if (asoc->peer.ipv6_address)
1446 flags |= SCTP_ADDR6_PEERSUPP;
1448 return sctp_bind_addr_copy(&asoc->base.bind_addr,
1449 &asoc->ep->base.bind_addr,
1453 /* Build the association's bind address list from the cookie. */
1454 int sctp_assoc_set_bind_addr_from_cookie(struct sctp_association *asoc,
1455 struct sctp_cookie *cookie,
1458 int var_size2 = ntohs(cookie->peer_init->chunk_hdr.length);
1459 int var_size3 = cookie->raw_addr_list_len;
1460 __u8 *raw = (__u8 *)cookie->peer_init + var_size2;
1462 return sctp_raw_to_bind_addrs(&asoc->base.bind_addr, raw, var_size3,
1463 asoc->ep->base.bind_addr.port, gfp);
1466 /* Lookup laddr in the bind address list of an association. */
1467 int sctp_assoc_lookup_laddr(struct sctp_association *asoc,
1468 const union sctp_addr *laddr)
1472 if ((asoc->base.bind_addr.port == ntohs(laddr->v4.sin_port)) &&
1473 sctp_bind_addr_match(&asoc->base.bind_addr, laddr,
1474 sctp_sk(asoc->base.sk)))
1480 /* Set an association id for a given association */
1481 int sctp_assoc_set_id(struct sctp_association *asoc, gfp_t gfp)
1486 if (unlikely(!idr_pre_get(&sctp_assocs_id, gfp)))
1489 spin_lock_bh(&sctp_assocs_id_lock);
1490 error = idr_get_new_above(&sctp_assocs_id, (void *)asoc,
1492 spin_unlock_bh(&sctp_assocs_id_lock);
1493 if (error == -EAGAIN)
1498 asoc->assoc_id = (sctp_assoc_t) assoc_id;
1502 /* Free asconf_ack cache */
1503 static void sctp_assoc_free_asconf_acks(struct sctp_association *asoc)
1505 struct sctp_chunk *ack;
1506 struct sctp_chunk *tmp;
1508 list_for_each_entry_safe(ack, tmp, &asoc->asconf_ack_list,
1510 list_del_init(&ack->transmitted_list);
1511 sctp_chunk_free(ack);
1515 /* Clean up the ASCONF_ACK queue */
1516 void sctp_assoc_clean_asconf_ack_cache(const struct sctp_association *asoc)
1518 struct sctp_chunk *ack;
1519 struct sctp_chunk *tmp;
1521 /* We can remove all the entries from the queue upto
1522 * the "Peer-Sequence-Number".
1524 list_for_each_entry_safe(ack, tmp, &asoc->asconf_ack_list,
1526 if (ack->subh.addip_hdr->serial ==
1527 htonl(asoc->peer.addip_serial))
1530 list_del_init(&ack->transmitted_list);
1531 sctp_chunk_free(ack);
1535 /* Find the ASCONF_ACK whose serial number matches ASCONF */
1536 struct sctp_chunk *sctp_assoc_lookup_asconf_ack(
1537 const struct sctp_association *asoc,
1540 struct sctp_chunk *ack;
1542 /* Walk through the list of cached ASCONF-ACKs and find the
1543 * ack chunk whose serial number matches that of the request.
1545 list_for_each_entry(ack, &asoc->asconf_ack_list, transmitted_list) {
1546 if (ack->subh.addip_hdr->serial == serial) {
1547 sctp_chunk_hold(ack);