1 /* SCTP kernel reference Implementation
2 * (C) Copyright IBM Corp. 2001, 2004
3 * Copyright (c) 1999 Cisco, Inc.
4 * Copyright (c) 1999-2001 Motorola, Inc.
6 * This file is part of the SCTP kernel reference Implementation
8 * These functions work with the state functions in sctp_sm_statefuns.c
9 * to implement that state operations. These functions implement the
10 * steps which require modifying existing data structures.
12 * The SCTP reference 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 * The SCTP reference 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@austin.ibm.com>
40 * Hui Huang <hui.huang@nokia.com>
41 * Dajiang Zhang <dajiang.zhang@nokia.com>
42 * Daisy Chang <daisyc@us.ibm.com>
43 * Sridhar Samudrala <sri@us.ibm.com>
44 * Ardelle Fan <ardelle.fan@intel.com>
46 * Any bugs reported given to us we will try to fix... any fixes shared will
47 * be incorporated into the next SCTP release.
50 #include <linux/skbuff.h>
51 #include <linux/types.h>
52 #include <linux/socket.h>
55 #include <net/sctp/sctp.h>
56 #include <net/sctp/sm.h>
58 static int sctp_cmd_interpreter(sctp_event_t event_type,
59 sctp_subtype_t subtype,
61 struct sctp_endpoint *ep,
62 struct sctp_association *asoc,
64 sctp_disposition_t status,
65 sctp_cmd_seq_t *commands,
67 static int sctp_side_effects(sctp_event_t event_type, sctp_subtype_t subtype,
69 struct sctp_endpoint *ep,
70 struct sctp_association *asoc,
72 sctp_disposition_t status,
73 sctp_cmd_seq_t *commands,
76 /********************************************************************
78 ********************************************************************/
80 /* A helper function for delayed processing of INET ECN CE bit. */
81 static void sctp_do_ecn_ce_work(struct sctp_association *asoc,
84 /* Save the TSN away for comparison when we receive CWR */
86 asoc->last_ecne_tsn = lowest_tsn;
90 /* Helper function for delayed processing of SCTP ECNE chunk. */
91 /* RFC 2960 Appendix A
93 * RFC 2481 details a specific bit for a sender to send in
94 * the header of its next outbound TCP segment to indicate to
95 * its peer that it has reduced its congestion window. This
96 * is termed the CWR bit. For SCTP the same indication is made
97 * by including the CWR chunk. This chunk contains one data
98 * element, i.e. the TSN number that was sent in the ECNE chunk.
99 * This element represents the lowest TSN number in the datagram
100 * that was originally marked with the CE bit.
102 static struct sctp_chunk *sctp_do_ecn_ecne_work(struct sctp_association *asoc,
104 struct sctp_chunk *chunk)
106 struct sctp_chunk *repl;
108 /* Our previously transmitted packet ran into some congestion
109 * so we should take action by reducing cwnd and ssthresh
110 * and then ACK our peer that we we've done so by
114 /* First, try to determine if we want to actually lower
115 * our cwnd variables. Only lower them if the ECNE looks more
116 * recent than the last response.
118 if (TSN_lt(asoc->last_cwr_tsn, lowest_tsn)) {
119 struct sctp_transport *transport;
121 /* Find which transport's congestion variables
122 * need to be adjusted.
124 transport = sctp_assoc_lookup_tsn(asoc, lowest_tsn);
126 /* Update the congestion variables. */
128 sctp_transport_lower_cwnd(transport,
129 SCTP_LOWER_CWND_ECNE);
130 asoc->last_cwr_tsn = lowest_tsn;
133 /* Always try to quiet the other end. In case of lost CWR,
134 * resend last_cwr_tsn.
136 repl = sctp_make_cwr(asoc, asoc->last_cwr_tsn, chunk);
138 /* If we run out of memory, it will look like a lost CWR. We'll
139 * get back in sync eventually.
144 /* Helper function to do delayed processing of ECN CWR chunk. */
145 static void sctp_do_ecn_cwr_work(struct sctp_association *asoc,
148 /* Turn off ECNE getting auto-prepended to every outgoing
154 /* Generate SACK if necessary. We call this at the end of a packet. */
155 static int sctp_gen_sack(struct sctp_association *asoc, int force,
156 sctp_cmd_seq_t *commands)
158 __u32 ctsn, max_tsn_seen;
159 struct sctp_chunk *sack;
160 struct sctp_transport *trans = asoc->peer.last_data_from;
164 (!trans && (asoc->param_flags & SPP_SACKDELAY_DISABLE)) ||
165 (trans && (trans->param_flags & SPP_SACKDELAY_DISABLE)))
166 asoc->peer.sack_needed = 1;
168 ctsn = sctp_tsnmap_get_ctsn(&asoc->peer.tsn_map);
169 max_tsn_seen = sctp_tsnmap_get_max_tsn_seen(&asoc->peer.tsn_map);
171 /* From 12.2 Parameters necessary per association (i.e. the TCB):
173 * Ack State : This flag indicates if the next received packet
174 * : is to be responded to with a SACK. ...
175 * : When DATA chunks are out of order, SACK's
176 * : are not delayed (see Section 6).
178 * [This is actually not mentioned in Section 6, but we
179 * implement it here anyway. --piggy]
181 if (max_tsn_seen != ctsn)
182 asoc->peer.sack_needed = 1;
184 /* From 6.2 Acknowledgement on Reception of DATA Chunks:
186 * Section 4.2 of [RFC2581] SHOULD be followed. Specifically,
187 * an acknowledgement SHOULD be generated for at least every
188 * second packet (not every second DATA chunk) received, and
189 * SHOULD be generated within 200 ms of the arrival of any
190 * unacknowledged DATA chunk. ...
192 if (!asoc->peer.sack_needed) {
193 /* We will need a SACK for the next packet. */
194 asoc->peer.sack_needed = 1;
196 /* Set the SACK delay timeout based on the
197 * SACK delay for the last transport
198 * data was received from, or the default
199 * for the association.
202 asoc->timeouts[SCTP_EVENT_TIMEOUT_SACK] =
205 asoc->timeouts[SCTP_EVENT_TIMEOUT_SACK] =
208 /* Restart the SACK timer. */
209 sctp_add_cmd_sf(commands, SCTP_CMD_TIMER_RESTART,
210 SCTP_TO(SCTP_EVENT_TIMEOUT_SACK));
212 if (asoc->a_rwnd > asoc->rwnd)
213 asoc->a_rwnd = asoc->rwnd;
214 sack = sctp_make_sack(asoc);
218 asoc->peer.sack_needed = 0;
220 error = sctp_outq_tail(&asoc->outqueue, sack);
222 /* Stop the SACK timer. */
223 sctp_add_cmd_sf(commands, SCTP_CMD_TIMER_STOP,
224 SCTP_TO(SCTP_EVENT_TIMEOUT_SACK));
233 /* When the T3-RTX timer expires, it calls this function to create the
234 * relevant state machine event.
236 void sctp_generate_t3_rtx_event(unsigned long peer)
239 struct sctp_transport *transport = (struct sctp_transport *) peer;
240 struct sctp_association *asoc = transport->asoc;
242 /* Check whether a task is in the sock. */
244 sctp_bh_lock_sock(asoc->base.sk);
245 if (sock_owned_by_user(asoc->base.sk)) {
246 SCTP_DEBUG_PRINTK("%s:Sock is busy.\n", __FUNCTION__);
248 /* Try again later. */
249 if (!mod_timer(&transport->T3_rtx_timer, jiffies + (HZ/20)))
250 sctp_transport_hold(transport);
254 /* Is this transport really dead and just waiting around for
255 * the timer to let go of the reference?
260 /* Run through the state machine. */
261 error = sctp_do_sm(SCTP_EVENT_T_TIMEOUT,
262 SCTP_ST_TIMEOUT(SCTP_EVENT_TIMEOUT_T3_RTX),
265 transport, GFP_ATOMIC);
268 asoc->base.sk->sk_err = -error;
271 sctp_bh_unlock_sock(asoc->base.sk);
272 sctp_transport_put(transport);
275 /* This is a sa interface for producing timeout events. It works
276 * for timeouts which use the association as their parameter.
278 static void sctp_generate_timeout_event(struct sctp_association *asoc,
279 sctp_event_timeout_t timeout_type)
283 sctp_bh_lock_sock(asoc->base.sk);
284 if (sock_owned_by_user(asoc->base.sk)) {
285 SCTP_DEBUG_PRINTK("%s:Sock is busy: timer %d\n",
289 /* Try again later. */
290 if (!mod_timer(&asoc->timers[timeout_type], jiffies + (HZ/20)))
291 sctp_association_hold(asoc);
295 /* Is this association really dead and just waiting around for
296 * the timer to let go of the reference?
301 /* Run through the state machine. */
302 error = sctp_do_sm(SCTP_EVENT_T_TIMEOUT,
303 SCTP_ST_TIMEOUT(timeout_type),
304 asoc->state, asoc->ep, asoc,
305 (void *)timeout_type, GFP_ATOMIC);
308 asoc->base.sk->sk_err = -error;
311 sctp_bh_unlock_sock(asoc->base.sk);
312 sctp_association_put(asoc);
315 static void sctp_generate_t1_cookie_event(unsigned long data)
317 struct sctp_association *asoc = (struct sctp_association *) data;
318 sctp_generate_timeout_event(asoc, SCTP_EVENT_TIMEOUT_T1_COOKIE);
321 static void sctp_generate_t1_init_event(unsigned long data)
323 struct sctp_association *asoc = (struct sctp_association *) data;
324 sctp_generate_timeout_event(asoc, SCTP_EVENT_TIMEOUT_T1_INIT);
327 static void sctp_generate_t2_shutdown_event(unsigned long data)
329 struct sctp_association *asoc = (struct sctp_association *) data;
330 sctp_generate_timeout_event(asoc, SCTP_EVENT_TIMEOUT_T2_SHUTDOWN);
333 static void sctp_generate_t4_rto_event(unsigned long data)
335 struct sctp_association *asoc = (struct sctp_association *) data;
336 sctp_generate_timeout_event(asoc, SCTP_EVENT_TIMEOUT_T4_RTO);
339 static void sctp_generate_t5_shutdown_guard_event(unsigned long data)
341 struct sctp_association *asoc = (struct sctp_association *)data;
342 sctp_generate_timeout_event(asoc,
343 SCTP_EVENT_TIMEOUT_T5_SHUTDOWN_GUARD);
345 } /* sctp_generate_t5_shutdown_guard_event() */
347 static void sctp_generate_autoclose_event(unsigned long data)
349 struct sctp_association *asoc = (struct sctp_association *) data;
350 sctp_generate_timeout_event(asoc, SCTP_EVENT_TIMEOUT_AUTOCLOSE);
353 /* Generate a heart beat event. If the sock is busy, reschedule. Make
354 * sure that the transport is still valid.
356 void sctp_generate_heartbeat_event(unsigned long data)
359 struct sctp_transport *transport = (struct sctp_transport *) data;
360 struct sctp_association *asoc = transport->asoc;
362 sctp_bh_lock_sock(asoc->base.sk);
363 if (sock_owned_by_user(asoc->base.sk)) {
364 SCTP_DEBUG_PRINTK("%s:Sock is busy.\n", __FUNCTION__);
366 /* Try again later. */
367 if (!mod_timer(&transport->hb_timer, jiffies + (HZ/20)))
368 sctp_transport_hold(transport);
372 /* Is this structure just waiting around for us to actually
378 error = sctp_do_sm(SCTP_EVENT_T_TIMEOUT,
379 SCTP_ST_TIMEOUT(SCTP_EVENT_TIMEOUT_HEARTBEAT),
380 asoc->state, asoc->ep, asoc,
381 transport, GFP_ATOMIC);
384 asoc->base.sk->sk_err = -error;
387 sctp_bh_unlock_sock(asoc->base.sk);
388 sctp_transport_put(transport);
391 /* Inject a SACK Timeout event into the state machine. */
392 static void sctp_generate_sack_event(unsigned long data)
394 struct sctp_association *asoc = (struct sctp_association *) data;
395 sctp_generate_timeout_event(asoc, SCTP_EVENT_TIMEOUT_SACK);
398 sctp_timer_event_t *sctp_timer_events[SCTP_NUM_TIMEOUT_TYPES] = {
400 sctp_generate_t1_cookie_event,
401 sctp_generate_t1_init_event,
402 sctp_generate_t2_shutdown_event,
404 sctp_generate_t4_rto_event,
405 sctp_generate_t5_shutdown_guard_event,
407 sctp_generate_sack_event,
408 sctp_generate_autoclose_event,
412 /* RFC 2960 8.2 Path Failure Detection
414 * When its peer endpoint is multi-homed, an endpoint should keep a
415 * error counter for each of the destination transport addresses of the
418 * Each time the T3-rtx timer expires on any address, or when a
419 * HEARTBEAT sent to an idle address is not acknowledged within a RTO,
420 * the error counter of that destination address will be incremented.
421 * When the value in the error counter exceeds the protocol parameter
422 * 'Path.Max.Retrans' of that destination address, the endpoint should
423 * mark the destination transport address as inactive, and a
424 * notification SHOULD be sent to the upper layer.
427 static void sctp_do_8_2_transport_strike(struct sctp_association *asoc,
428 struct sctp_transport *transport)
430 /* The check for association's overall error counter exceeding the
431 * threshold is done in the state function.
433 /* When probing UNCONFIRMED addresses, the association overall
434 * error count is NOT incremented
436 if (transport->state != SCTP_UNCONFIRMED)
437 asoc->overall_error_count++;
439 if (transport->state != SCTP_INACTIVE &&
440 (transport->error_count++ >= transport->pathmaxrxt)) {
441 SCTP_DEBUG_PRINTK_IPADDR("transport_strike:association %p",
442 " transport IP: port:%d failed.\n",
444 (&transport->ipaddr),
445 ntohs(transport->ipaddr.v4.sin_port));
446 sctp_assoc_control_transport(asoc, transport,
448 SCTP_FAILED_THRESHOLD);
451 /* E2) For the destination address for which the timer
452 * expires, set RTO <- RTO * 2 ("back off the timer"). The
453 * maximum value discussed in rule C7 above (RTO.max) may be
454 * used to provide an upper bound to this doubling operation.
456 transport->rto = min((transport->rto * 2), transport->asoc->rto_max);
459 /* Worker routine to handle INIT command failure. */
460 static void sctp_cmd_init_failed(sctp_cmd_seq_t *commands,
461 struct sctp_association *asoc,
464 struct sctp_ulpevent *event;
466 event = sctp_ulpevent_make_assoc_change(asoc,0, SCTP_CANT_STR_ASSOC,
471 sctp_add_cmd_sf(commands, SCTP_CMD_EVENT_ULP,
472 SCTP_ULPEVENT(event));
474 sctp_add_cmd_sf(commands, SCTP_CMD_NEW_STATE,
475 SCTP_STATE(SCTP_STATE_CLOSED));
477 /* SEND_FAILED sent later when cleaning up the association. */
478 asoc->outqueue.error = error;
479 sctp_add_cmd_sf(commands, SCTP_CMD_DELETE_TCB, SCTP_NULL());
482 /* Worker routine to handle SCTP_CMD_ASSOC_FAILED. */
483 static void sctp_cmd_assoc_failed(sctp_cmd_seq_t *commands,
484 struct sctp_association *asoc,
485 sctp_event_t event_type,
486 sctp_subtype_t subtype,
487 struct sctp_chunk *chunk,
490 struct sctp_ulpevent *event;
492 /* Cancel any partial delivery in progress. */
493 sctp_ulpq_abort_pd(&asoc->ulpq, GFP_ATOMIC);
495 event = sctp_ulpevent_make_assoc_change(asoc, 0, SCTP_COMM_LOST,
499 sctp_add_cmd_sf(commands, SCTP_CMD_EVENT_ULP,
500 SCTP_ULPEVENT(event));
502 sctp_add_cmd_sf(commands, SCTP_CMD_NEW_STATE,
503 SCTP_STATE(SCTP_STATE_CLOSED));
505 /* SEND_FAILED sent later when cleaning up the association. */
506 asoc->outqueue.error = error;
507 sctp_add_cmd_sf(commands, SCTP_CMD_DELETE_TCB, SCTP_NULL());
510 /* Process an init chunk (may be real INIT/INIT-ACK or an embedded INIT
511 * inside the cookie. In reality, this is only used for INIT-ACK processing
512 * since all other cases use "temporary" associations and can do all
513 * their work in statefuns directly.
515 static int sctp_cmd_process_init(sctp_cmd_seq_t *commands,
516 struct sctp_association *asoc,
517 struct sctp_chunk *chunk,
518 sctp_init_chunk_t *peer_init,
523 /* We only process the init as a sideeffect in a single
524 * case. This is when we process the INIT-ACK. If we
525 * fail during INIT processing (due to malloc problems),
526 * just return the error and stop processing the stack.
528 if (!sctp_process_init(asoc, chunk->chunk_hdr->type,
529 sctp_source(chunk), peer_init, gfp))
537 /* Helper function to break out starting up of heartbeat timers. */
538 static void sctp_cmd_hb_timers_start(sctp_cmd_seq_t *cmds,
539 struct sctp_association *asoc)
541 struct sctp_transport *t;
542 struct list_head *pos;
544 /* Start a heartbeat timer for each transport on the association.
545 * hold a reference on the transport to make sure none of
546 * the needed data structures go away.
548 list_for_each(pos, &asoc->peer.transport_addr_list) {
549 t = list_entry(pos, struct sctp_transport, transports);
551 if (!mod_timer(&t->hb_timer, sctp_transport_timeout(t)))
552 sctp_transport_hold(t);
556 static void sctp_cmd_hb_timers_stop(sctp_cmd_seq_t *cmds,
557 struct sctp_association *asoc)
559 struct sctp_transport *t;
560 struct list_head *pos;
562 /* Stop all heartbeat timers. */
564 list_for_each(pos, &asoc->peer.transport_addr_list) {
565 t = list_entry(pos, struct sctp_transport, transports);
566 if (del_timer(&t->hb_timer))
567 sctp_transport_put(t);
571 /* Helper function to stop any pending T3-RTX timers */
572 static void sctp_cmd_t3_rtx_timers_stop(sctp_cmd_seq_t *cmds,
573 struct sctp_association *asoc)
575 struct sctp_transport *t;
576 struct list_head *pos;
578 list_for_each(pos, &asoc->peer.transport_addr_list) {
579 t = list_entry(pos, struct sctp_transport, transports);
580 if (timer_pending(&t->T3_rtx_timer) &&
581 del_timer(&t->T3_rtx_timer)) {
582 sctp_transport_put(t);
588 /* Helper function to update the heartbeat timer. */
589 static void sctp_cmd_hb_timer_update(sctp_cmd_seq_t *cmds,
590 struct sctp_association *asoc,
591 struct sctp_transport *t)
593 /* Update the heartbeat timer. */
594 if (!mod_timer(&t->hb_timer, sctp_transport_timeout(t)))
595 sctp_transport_hold(t);
598 /* Helper function to handle the reception of an HEARTBEAT ACK. */
599 static void sctp_cmd_transport_on(sctp_cmd_seq_t *cmds,
600 struct sctp_association *asoc,
601 struct sctp_transport *t,
602 struct sctp_chunk *chunk)
604 sctp_sender_hb_info_t *hbinfo;
606 /* 8.3 Upon the receipt of the HEARTBEAT ACK, the sender of the
607 * HEARTBEAT should clear the error counter of the destination
608 * transport address to which the HEARTBEAT was sent.
609 * The association's overall error count is also cleared.
612 t->asoc->overall_error_count = 0;
614 /* Mark the destination transport address as active if it is not so
617 if ((t->state == SCTP_INACTIVE) || (t->state == SCTP_UNCONFIRMED))
618 sctp_assoc_control_transport(asoc, t, SCTP_TRANSPORT_UP,
619 SCTP_HEARTBEAT_SUCCESS);
621 /* The receiver of the HEARTBEAT ACK should also perform an
622 * RTT measurement for that destination transport address
623 * using the time value carried in the HEARTBEAT ACK chunk.
625 hbinfo = (sctp_sender_hb_info_t *) chunk->skb->data;
626 sctp_transport_update_rto(t, (jiffies - hbinfo->sent_at));
628 /* Update the heartbeat timer. */
629 if (!mod_timer(&t->hb_timer, sctp_transport_timeout(t)))
630 sctp_transport_hold(t);
633 /* Helper function to do a transport reset at the expiry of the hearbeat
636 static void sctp_cmd_transport_reset(sctp_cmd_seq_t *cmds,
637 struct sctp_association *asoc,
638 struct sctp_transport *t)
640 sctp_transport_lower_cwnd(t, SCTP_LOWER_CWND_INACTIVE);
642 /* Mark one strike against a transport. */
643 sctp_do_8_2_transport_strike(asoc, t);
646 /* Helper function to process the process SACK command. */
647 static int sctp_cmd_process_sack(sctp_cmd_seq_t *cmds,
648 struct sctp_association *asoc,
649 struct sctp_sackhdr *sackh)
653 if (sctp_outq_sack(&asoc->outqueue, sackh)) {
654 /* There are no more TSNs awaiting SACK. */
655 err = sctp_do_sm(SCTP_EVENT_T_OTHER,
656 SCTP_ST_OTHER(SCTP_EVENT_NO_PENDING_TSN),
657 asoc->state, asoc->ep, asoc, NULL,
660 /* Windows may have opened, so we need
661 * to check if we have DATA to transmit
663 err = sctp_outq_flush(&asoc->outqueue, 0);
669 /* Helper function to set the timeout value for T2-SHUTDOWN timer and to set
670 * the transport for a shutdown chunk.
672 static void sctp_cmd_setup_t2(sctp_cmd_seq_t *cmds,
673 struct sctp_association *asoc,
674 struct sctp_chunk *chunk)
676 struct sctp_transport *t;
678 t = sctp_assoc_choose_shutdown_transport(asoc);
679 asoc->shutdown_last_sent_to = t;
680 asoc->timeouts[SCTP_EVENT_TIMEOUT_T2_SHUTDOWN] = t->rto;
681 chunk->transport = t;
684 /* Helper function to change the state of an association. */
685 static void sctp_cmd_new_state(sctp_cmd_seq_t *cmds,
686 struct sctp_association *asoc,
689 struct sock *sk = asoc->base.sk;
693 SCTP_DEBUG_PRINTK("sctp_cmd_new_state: asoc %p[%s]\n",
694 asoc, sctp_state_tbl[state]);
696 if (sctp_style(sk, TCP)) {
697 /* Change the sk->sk_state of a TCP-style socket that has
698 * sucessfully completed a connect() call.
700 if (sctp_state(asoc, ESTABLISHED) && sctp_sstate(sk, CLOSED))
701 sk->sk_state = SCTP_SS_ESTABLISHED;
703 /* Set the RCV_SHUTDOWN flag when a SHUTDOWN is received. */
704 if (sctp_state(asoc, SHUTDOWN_RECEIVED) &&
705 sctp_sstate(sk, ESTABLISHED))
706 sk->sk_shutdown |= RCV_SHUTDOWN;
709 if (sctp_state(asoc, COOKIE_WAIT)) {
710 /* Reset init timeouts since they may have been
711 * increased due to timer expirations.
713 asoc->timeouts[SCTP_EVENT_TIMEOUT_T1_INIT] =
715 asoc->timeouts[SCTP_EVENT_TIMEOUT_T1_COOKIE] =
719 if (sctp_state(asoc, ESTABLISHED) ||
720 sctp_state(asoc, CLOSED) ||
721 sctp_state(asoc, SHUTDOWN_RECEIVED)) {
722 /* Wake up any processes waiting in the asoc's wait queue in
723 * sctp_wait_for_connect() or sctp_wait_for_sndbuf().
725 if (waitqueue_active(&asoc->wait))
726 wake_up_interruptible(&asoc->wait);
728 /* Wake up any processes waiting in the sk's sleep queue of
729 * a TCP-style or UDP-style peeled-off socket in
730 * sctp_wait_for_accept() or sctp_wait_for_packet().
731 * For a UDP-style socket, the waiters are woken up by the
734 if (!sctp_style(sk, UDP))
735 sk->sk_state_change(sk);
739 /* Helper function to delete an association. */
740 static void sctp_cmd_delete_tcb(sctp_cmd_seq_t *cmds,
741 struct sctp_association *asoc)
743 struct sock *sk = asoc->base.sk;
745 /* If it is a non-temporary association belonging to a TCP-style
746 * listening socket that is not closed, do not free it so that accept()
747 * can pick it up later.
749 if (sctp_style(sk, TCP) && sctp_sstate(sk, LISTENING) &&
750 (!asoc->temp) && (sk->sk_shutdown != SHUTDOWN_MASK))
753 sctp_unhash_established(asoc);
754 sctp_association_free(asoc);
758 * ADDIP Section 4.1 ASCONF Chunk Procedures
759 * A4) Start a T-4 RTO timer, using the RTO value of the selected
760 * destination address (we use active path instead of primary path just
761 * because primary path may be inactive.
763 static void sctp_cmd_setup_t4(sctp_cmd_seq_t *cmds,
764 struct sctp_association *asoc,
765 struct sctp_chunk *chunk)
767 struct sctp_transport *t;
769 t = asoc->peer.active_path;
770 asoc->timeouts[SCTP_EVENT_TIMEOUT_T4_RTO] = t->rto;
771 chunk->transport = t;
774 /* Process an incoming Operation Error Chunk. */
775 static void sctp_cmd_process_operr(sctp_cmd_seq_t *cmds,
776 struct sctp_association *asoc,
777 struct sctp_chunk *chunk)
779 struct sctp_operr_chunk *operr_chunk;
780 struct sctp_errhdr *err_hdr;
782 operr_chunk = (struct sctp_operr_chunk *)chunk->chunk_hdr;
783 err_hdr = &operr_chunk->err_hdr;
785 switch (err_hdr->cause) {
786 case SCTP_ERROR_UNKNOWN_CHUNK:
788 struct sctp_chunkhdr *unk_chunk_hdr;
790 unk_chunk_hdr = (struct sctp_chunkhdr *)err_hdr->variable;
791 switch (unk_chunk_hdr->type) {
792 /* ADDIP 4.1 A9) If the peer responds to an ASCONF with an
793 * ERROR chunk reporting that it did not recognized the ASCONF
794 * chunk type, the sender of the ASCONF MUST NOT send any
795 * further ASCONF chunks and MUST stop its T-4 timer.
797 case SCTP_CID_ASCONF:
798 asoc->peer.asconf_capable = 0;
799 sctp_add_cmd_sf(cmds, SCTP_CMD_TIMER_STOP,
800 SCTP_TO(SCTP_EVENT_TIMEOUT_T4_RTO));
812 /* Process variable FWDTSN chunk information. */
813 static void sctp_cmd_process_fwdtsn(struct sctp_ulpq *ulpq,
814 struct sctp_chunk *chunk)
816 struct sctp_fwdtsn_skip *skip;
817 /* Walk through all the skipped SSNs */
818 sctp_walk_fwdtsn(skip, chunk) {
819 sctp_ulpq_skip(ulpq, ntohs(skip->stream), ntohs(skip->ssn));
825 /* Helper function to remove the association non-primary peer
828 static void sctp_cmd_del_non_primary(struct sctp_association *asoc)
830 struct sctp_transport *t;
831 struct list_head *pos;
832 struct list_head *temp;
834 list_for_each_safe(pos, temp, &asoc->peer.transport_addr_list) {
835 t = list_entry(pos, struct sctp_transport, transports);
836 if (!sctp_cmp_addr_exact(&t->ipaddr,
837 &asoc->peer.primary_addr)) {
838 sctp_assoc_del_peer(asoc, &t->ipaddr);
845 /* Helper function to set sk_err on a 1-1 style socket. */
846 static void sctp_cmd_set_sk_err(struct sctp_association *asoc, int error)
848 struct sock *sk = asoc->base.sk;
850 if (!sctp_style(sk, UDP))
854 /* These three macros allow us to pull the debugging code out of the
855 * main flow of sctp_do_sm() to keep attention focused on the real
856 * functionality there.
859 SCTP_DEBUG_PRINTK("sctp_do_sm prefn: " \
860 "ep %p, %s, %s, asoc %p[%s], %s\n", \
861 ep, sctp_evttype_tbl[event_type], \
862 (*debug_fn)(subtype), asoc, \
863 sctp_state_tbl[state], state_fn->name)
866 SCTP_DEBUG_PRINTK("sctp_do_sm postfn: " \
867 "asoc %p, status: %s\n", \
868 asoc, sctp_status_tbl[status])
870 #define DEBUG_POST_SFX \
871 SCTP_DEBUG_PRINTK("sctp_do_sm post sfx: error %d, asoc %p[%s]\n", \
873 sctp_state_tbl[(asoc && sctp_id2assoc(ep->base.sk, \
874 sctp_assoc2id(asoc)))?asoc->state:SCTP_STATE_CLOSED])
877 * This is the master state machine processing function.
879 * If you want to understand all of lksctp, this is a
880 * good place to start.
882 int sctp_do_sm(sctp_event_t event_type, sctp_subtype_t subtype,
884 struct sctp_endpoint *ep,
885 struct sctp_association *asoc,
889 sctp_cmd_seq_t commands;
890 const sctp_sm_table_entry_t *state_fn;
891 sctp_disposition_t status;
893 typedef const char *(printfn_t)(sctp_subtype_t);
895 static printfn_t *table[] = {
896 NULL, sctp_cname, sctp_tname, sctp_oname, sctp_pname,
898 printfn_t *debug_fn __attribute__ ((unused)) = table[event_type];
900 /* Look up the state function, run it, and then process the
901 * side effects. These three steps are the heart of lksctp.
903 state_fn = sctp_sm_lookup_event(event_type, state, subtype);
905 sctp_init_cmd_seq(&commands);
908 status = (*state_fn->fn)(ep, asoc, subtype, event_arg, &commands);
911 error = sctp_side_effects(event_type, subtype, state,
912 ep, asoc, event_arg, status,
922 /*****************************************************************
923 * This the master state function side effect processing function.
924 *****************************************************************/
925 static int sctp_side_effects(sctp_event_t event_type, sctp_subtype_t subtype,
927 struct sctp_endpoint *ep,
928 struct sctp_association *asoc,
930 sctp_disposition_t status,
931 sctp_cmd_seq_t *commands,
936 /* FIXME - Most of the dispositions left today would be categorized
937 * as "exceptional" dispositions. For those dispositions, it
938 * may not be proper to run through any of the commands at all.
939 * For example, the command interpreter might be run only with
940 * disposition SCTP_DISPOSITION_CONSUME.
942 if (0 != (error = sctp_cmd_interpreter(event_type, subtype, state,
949 case SCTP_DISPOSITION_DISCARD:
950 SCTP_DEBUG_PRINTK("Ignored sctp protocol event - state %d, "
951 "event_type %d, event_id %d\n",
952 state, event_type, subtype.chunk);
955 case SCTP_DISPOSITION_NOMEM:
956 /* We ran out of memory, so we need to discard this
959 /* BUG--we should now recover some memory, probably by
965 case SCTP_DISPOSITION_DELETE_TCB:
966 /* This should now be a command. */
969 case SCTP_DISPOSITION_CONSUME:
970 case SCTP_DISPOSITION_ABORT:
972 * We should no longer have much work to do here as the
973 * real work has been done as explicit commands above.
977 case SCTP_DISPOSITION_VIOLATION:
978 printk(KERN_ERR "sctp protocol violation state %d "
979 "chunkid %d\n", state, subtype.chunk);
982 case SCTP_DISPOSITION_NOT_IMPL:
983 printk(KERN_WARNING "sctp unimplemented feature in state %d, "
984 "event_type %d, event_id %d\n",
985 state, event_type, subtype.chunk);
988 case SCTP_DISPOSITION_BUG:
989 printk(KERN_ERR "sctp bug in state %d, "
990 "event_type %d, event_id %d\n",
991 state, event_type, subtype.chunk);
996 printk(KERN_ERR "sctp impossible disposition %d "
997 "in state %d, event_type %d, event_id %d\n",
998 status, state, event_type, subtype.chunk);
1007 /********************************************************************
1008 * 2nd Level Abstractions
1009 ********************************************************************/
1011 /* This is the side-effect interpreter. */
1012 static int sctp_cmd_interpreter(sctp_event_t event_type,
1013 sctp_subtype_t subtype,
1015 struct sctp_endpoint *ep,
1016 struct sctp_association *asoc,
1018 sctp_disposition_t status,
1019 sctp_cmd_seq_t *commands,
1025 struct sctp_chunk *new_obj;
1026 struct sctp_chunk *chunk = NULL;
1027 struct sctp_packet *packet;
1028 struct list_head *pos;
1029 struct timer_list *timer;
1030 unsigned long timeout;
1031 struct sctp_transport *t;
1032 struct sctp_sackhdr sackh;
1035 if (SCTP_EVENT_T_TIMEOUT != event_type)
1036 chunk = (struct sctp_chunk *) event_arg;
1038 /* Note: This whole file is a huge candidate for rework.
1039 * For example, each command could either have its own handler, so
1040 * the loop would look like:
1042 * cmd->handle(x, y, z)
1045 while (NULL != (cmd = sctp_next_cmd(commands))) {
1046 switch (cmd->verb) {
1051 case SCTP_CMD_NEW_ASOC:
1052 /* Register a new association. */
1054 sctp_outq_uncork(&asoc->outqueue);
1057 asoc = cmd->obj.ptr;
1058 /* Register with the endpoint. */
1059 sctp_endpoint_add_asoc(ep, asoc);
1060 sctp_hash_established(asoc);
1063 case SCTP_CMD_UPDATE_ASSOC:
1064 sctp_assoc_update(asoc, cmd->obj.ptr);
1067 case SCTP_CMD_PURGE_OUTQUEUE:
1068 sctp_outq_teardown(&asoc->outqueue);
1071 case SCTP_CMD_DELETE_TCB:
1073 sctp_outq_uncork(&asoc->outqueue);
1076 /* Delete the current association. */
1077 sctp_cmd_delete_tcb(commands, asoc);
1081 case SCTP_CMD_NEW_STATE:
1082 /* Enter a new state. */
1083 sctp_cmd_new_state(commands, asoc, cmd->obj.state);
1086 case SCTP_CMD_REPORT_TSN:
1087 /* Record the arrival of a TSN. */
1088 sctp_tsnmap_mark(&asoc->peer.tsn_map, cmd->obj.u32);
1091 case SCTP_CMD_REPORT_FWDTSN:
1092 /* Move the Cumulattive TSN Ack ahead. */
1093 sctp_tsnmap_skip(&asoc->peer.tsn_map, cmd->obj.u32);
1095 /* Abort any in progress partial delivery. */
1096 sctp_ulpq_abort_pd(&asoc->ulpq, GFP_ATOMIC);
1099 case SCTP_CMD_PROCESS_FWDTSN:
1100 sctp_cmd_process_fwdtsn(&asoc->ulpq, cmd->obj.ptr);
1103 case SCTP_CMD_GEN_SACK:
1104 /* Generate a Selective ACK.
1105 * The argument tells us whether to just count
1106 * the packet and MAYBE generate a SACK, or
1109 force = cmd->obj.i32;
1110 error = sctp_gen_sack(asoc, force, commands);
1113 case SCTP_CMD_PROCESS_SACK:
1114 /* Process an inbound SACK. */
1115 error = sctp_cmd_process_sack(commands, asoc,
1119 case SCTP_CMD_GEN_INIT_ACK:
1120 /* Generate an INIT ACK chunk. */
1121 new_obj = sctp_make_init_ack(asoc, chunk, GFP_ATOMIC,
1126 sctp_add_cmd_sf(commands, SCTP_CMD_REPLY,
1127 SCTP_CHUNK(new_obj));
1130 case SCTP_CMD_PEER_INIT:
1131 /* Process a unified INIT from the peer.
1132 * Note: Only used during INIT-ACK processing. If
1133 * there is an error just return to the outter
1134 * layer which will bail.
1136 error = sctp_cmd_process_init(commands, asoc, chunk,
1140 case SCTP_CMD_GEN_COOKIE_ECHO:
1141 /* Generate a COOKIE ECHO chunk. */
1142 new_obj = sctp_make_cookie_echo(asoc, chunk);
1145 sctp_chunk_free(cmd->obj.ptr);
1148 sctp_add_cmd_sf(commands, SCTP_CMD_REPLY,
1149 SCTP_CHUNK(new_obj));
1151 /* If there is an ERROR chunk to be sent along with
1152 * the COOKIE_ECHO, send it, too.
1155 sctp_add_cmd_sf(commands, SCTP_CMD_REPLY,
1156 SCTP_CHUNK(cmd->obj.ptr));
1158 /* FIXME - Eventually come up with a cleaner way to
1159 * enabling COOKIE-ECHO + DATA bundling during
1160 * multihoming stale cookie scenarios, the following
1161 * command plays with asoc->peer.retran_path to
1162 * avoid the problem of sending the COOKIE-ECHO and
1163 * DATA in different paths, which could result
1164 * in the association being ABORTed if the DATA chunk
1165 * is processed first by the server. Checking the
1166 * init error counter simply causes this command
1167 * to be executed only during failed attempts of
1168 * association establishment.
1170 if ((asoc->peer.retran_path !=
1171 asoc->peer.primary_path) &&
1172 (asoc->init_err_counter > 0)) {
1173 sctp_add_cmd_sf(commands,
1174 SCTP_CMD_FORCE_PRIM_RETRAN,
1180 case SCTP_CMD_GEN_SHUTDOWN:
1181 /* Generate SHUTDOWN when in SHUTDOWN_SENT state.
1182 * Reset error counts.
1184 asoc->overall_error_count = 0;
1186 /* Generate a SHUTDOWN chunk. */
1187 new_obj = sctp_make_shutdown(asoc, chunk);
1190 sctp_add_cmd_sf(commands, SCTP_CMD_REPLY,
1191 SCTP_CHUNK(new_obj));
1194 case SCTP_CMD_CHUNK_ULP:
1195 /* Send a chunk to the sockets layer. */
1196 SCTP_DEBUG_PRINTK("sm_sideff: %s %p, %s %p.\n",
1197 "chunk_up:", cmd->obj.ptr,
1198 "ulpq:", &asoc->ulpq);
1199 sctp_ulpq_tail_data(&asoc->ulpq, cmd->obj.ptr,
1203 case SCTP_CMD_EVENT_ULP:
1204 /* Send a notification to the sockets layer. */
1205 SCTP_DEBUG_PRINTK("sm_sideff: %s %p, %s %p.\n",
1206 "event_up:",cmd->obj.ptr,
1207 "ulpq:",&asoc->ulpq);
1208 sctp_ulpq_tail_event(&asoc->ulpq, cmd->obj.ptr);
1211 case SCTP_CMD_REPLY:
1212 /* If an caller has not already corked, do cork. */
1213 if (!asoc->outqueue.cork) {
1214 sctp_outq_cork(&asoc->outqueue);
1217 /* Send a chunk to our peer. */
1218 error = sctp_outq_tail(&asoc->outqueue, cmd->obj.ptr);
1221 case SCTP_CMD_SEND_PKT:
1222 /* Send a full packet to our peer. */
1223 packet = cmd->obj.ptr;
1224 sctp_packet_transmit(packet);
1225 sctp_ootb_pkt_free(packet);
1228 case SCTP_CMD_RETRAN:
1229 /* Mark a transport for retransmission. */
1230 sctp_retransmit(&asoc->outqueue, cmd->obj.transport,
1234 case SCTP_CMD_TRANSMIT:
1235 /* Kick start transmission. */
1236 error = sctp_outq_uncork(&asoc->outqueue);
1240 case SCTP_CMD_ECN_CE:
1241 /* Do delayed CE processing. */
1242 sctp_do_ecn_ce_work(asoc, cmd->obj.u32);
1245 case SCTP_CMD_ECN_ECNE:
1246 /* Do delayed ECNE processing. */
1247 new_obj = sctp_do_ecn_ecne_work(asoc, cmd->obj.u32,
1250 sctp_add_cmd_sf(commands, SCTP_CMD_REPLY,
1251 SCTP_CHUNK(new_obj));
1254 case SCTP_CMD_ECN_CWR:
1255 /* Do delayed CWR processing. */
1256 sctp_do_ecn_cwr_work(asoc, cmd->obj.u32);
1259 case SCTP_CMD_SETUP_T2:
1260 sctp_cmd_setup_t2(commands, asoc, cmd->obj.ptr);
1263 case SCTP_CMD_TIMER_START:
1264 timer = &asoc->timers[cmd->obj.to];
1265 timeout = asoc->timeouts[cmd->obj.to];
1268 timer->expires = jiffies + timeout;
1269 sctp_association_hold(asoc);
1273 case SCTP_CMD_TIMER_RESTART:
1274 timer = &asoc->timers[cmd->obj.to];
1275 timeout = asoc->timeouts[cmd->obj.to];
1276 if (!mod_timer(timer, jiffies + timeout))
1277 sctp_association_hold(asoc);
1280 case SCTP_CMD_TIMER_STOP:
1281 timer = &asoc->timers[cmd->obj.to];
1282 if (timer_pending(timer) && del_timer(timer))
1283 sctp_association_put(asoc);
1286 case SCTP_CMD_INIT_CHOOSE_TRANSPORT:
1287 chunk = cmd->obj.ptr;
1288 t = sctp_assoc_choose_init_transport(asoc);
1289 asoc->init_last_sent_to = t;
1290 chunk->transport = t;
1291 t->init_sent_count++;
1294 case SCTP_CMD_INIT_RESTART:
1295 /* Do the needed accounting and updates
1296 * associated with restarting an initialization
1297 * timer. Only multiply the timeout by two if
1298 * all transports have been tried at the current
1301 t = asoc->init_last_sent_to;
1302 asoc->init_err_counter++;
1304 if (t->init_sent_count > (asoc->init_cycle + 1)) {
1305 asoc->timeouts[SCTP_EVENT_TIMEOUT_T1_INIT] *= 2;
1306 if (asoc->timeouts[SCTP_EVENT_TIMEOUT_T1_INIT] >
1307 asoc->max_init_timeo) {
1308 asoc->timeouts[SCTP_EVENT_TIMEOUT_T1_INIT] =
1309 asoc->max_init_timeo;
1313 "T1 INIT Timeout adjustment"
1314 " init_err_counter: %d"
1317 asoc->init_err_counter,
1319 asoc->timeouts[SCTP_EVENT_TIMEOUT_T1_INIT]);
1322 sctp_add_cmd_sf(commands, SCTP_CMD_TIMER_RESTART,
1323 SCTP_TO(SCTP_EVENT_TIMEOUT_T1_INIT));
1326 case SCTP_CMD_COOKIEECHO_RESTART:
1327 /* Do the needed accounting and updates
1328 * associated with restarting an initialization
1329 * timer. Only multiply the timeout by two if
1330 * all transports have been tried at the current
1333 asoc->init_err_counter++;
1335 asoc->timeouts[SCTP_EVENT_TIMEOUT_T1_COOKIE] *= 2;
1336 if (asoc->timeouts[SCTP_EVENT_TIMEOUT_T1_COOKIE] >
1337 asoc->max_init_timeo) {
1338 asoc->timeouts[SCTP_EVENT_TIMEOUT_T1_COOKIE] =
1339 asoc->max_init_timeo;
1342 "T1 COOKIE Timeout adjustment"
1343 " init_err_counter: %d"
1345 asoc->init_err_counter,
1346 asoc->timeouts[SCTP_EVENT_TIMEOUT_T1_COOKIE]);
1348 /* If we've sent any data bundled with
1349 * COOKIE-ECHO we need to resend.
1351 list_for_each(pos, &asoc->peer.transport_addr_list) {
1352 t = list_entry(pos, struct sctp_transport,
1354 sctp_retransmit_mark(&asoc->outqueue, t, 0);
1357 sctp_add_cmd_sf(commands,
1358 SCTP_CMD_TIMER_RESTART,
1359 SCTP_TO(SCTP_EVENT_TIMEOUT_T1_COOKIE));
1362 case SCTP_CMD_INIT_FAILED:
1363 sctp_cmd_init_failed(commands, asoc, cmd->obj.err);
1366 case SCTP_CMD_ASSOC_FAILED:
1367 sctp_cmd_assoc_failed(commands, asoc, event_type,
1368 subtype, chunk, cmd->obj.err);
1371 case SCTP_CMD_INIT_COUNTER_INC:
1372 asoc->init_err_counter++;
1375 case SCTP_CMD_INIT_COUNTER_RESET:
1376 asoc->init_err_counter = 0;
1377 asoc->init_cycle = 0;
1380 case SCTP_CMD_REPORT_DUP:
1381 sctp_tsnmap_mark_dup(&asoc->peer.tsn_map,
1385 case SCTP_CMD_REPORT_BAD_TAG:
1386 SCTP_DEBUG_PRINTK("vtag mismatch!\n");
1389 case SCTP_CMD_STRIKE:
1390 /* Mark one strike against a transport. */
1391 sctp_do_8_2_transport_strike(asoc, cmd->obj.transport);
1394 case SCTP_CMD_TRANSPORT_RESET:
1395 t = cmd->obj.transport;
1396 sctp_cmd_transport_reset(commands, asoc, t);
1399 case SCTP_CMD_TRANSPORT_ON:
1400 t = cmd->obj.transport;
1401 sctp_cmd_transport_on(commands, asoc, t, chunk);
1404 case SCTP_CMD_HB_TIMERS_START:
1405 sctp_cmd_hb_timers_start(commands, asoc);
1408 case SCTP_CMD_HB_TIMER_UPDATE:
1409 t = cmd->obj.transport;
1410 sctp_cmd_hb_timer_update(commands, asoc, t);
1413 case SCTP_CMD_HB_TIMERS_STOP:
1414 sctp_cmd_hb_timers_stop(commands, asoc);
1417 case SCTP_CMD_REPORT_ERROR:
1418 error = cmd->obj.error;
1421 case SCTP_CMD_PROCESS_CTSN:
1422 /* Dummy up a SACK for processing. */
1423 sackh.cum_tsn_ack = cmd->obj.be32;
1425 sackh.num_gap_ack_blocks = 0;
1426 sackh.num_dup_tsns = 0;
1427 sctp_add_cmd_sf(commands, SCTP_CMD_PROCESS_SACK,
1428 SCTP_SACKH(&sackh));
1431 case SCTP_CMD_DISCARD_PACKET:
1432 /* We need to discard the whole packet. */
1433 chunk->pdiscard = 1;
1436 case SCTP_CMD_RTO_PENDING:
1437 t = cmd->obj.transport;
1441 case SCTP_CMD_PART_DELIVER:
1442 sctp_ulpq_partial_delivery(&asoc->ulpq, cmd->obj.ptr,
1446 case SCTP_CMD_RENEGE:
1447 sctp_ulpq_renege(&asoc->ulpq, cmd->obj.ptr,
1451 case SCTP_CMD_SETUP_T4:
1452 sctp_cmd_setup_t4(commands, asoc, cmd->obj.ptr);
1455 case SCTP_CMD_PROCESS_OPERR:
1456 sctp_cmd_process_operr(commands, asoc, chunk);
1458 case SCTP_CMD_CLEAR_INIT_TAG:
1459 asoc->peer.i.init_tag = 0;
1461 case SCTP_CMD_DEL_NON_PRIMARY:
1462 sctp_cmd_del_non_primary(asoc);
1464 case SCTP_CMD_T3_RTX_TIMERS_STOP:
1465 sctp_cmd_t3_rtx_timers_stop(commands, asoc);
1467 case SCTP_CMD_FORCE_PRIM_RETRAN:
1468 t = asoc->peer.retran_path;
1469 asoc->peer.retran_path = asoc->peer.primary_path;
1470 error = sctp_outq_uncork(&asoc->outqueue);
1472 asoc->peer.retran_path = t;
1474 case SCTP_CMD_SET_SK_ERR:
1475 sctp_cmd_set_sk_err(asoc, cmd->obj.error);
1478 printk(KERN_WARNING "Impossible command: %u, %p\n",
1479 cmd->verb, cmd->obj.ptr);
1488 sctp_outq_uncork(&asoc->outqueue);