Merge tag 'lkdtm-next' of https://git.kernel.org/pub/scm/linux/kernel/git/kees/linux...
[linux-2.6-microblaze.git] / net / sctp / sm_sideeffect.c
1 // SPDX-License-Identifier: GPL-2.0-or-later
2 /* SCTP kernel implementation
3  * (C) Copyright IBM Corp. 2001, 2004
4  * Copyright (c) 1999 Cisco, Inc.
5  * Copyright (c) 1999-2001 Motorola, Inc.
6  *
7  * This file is part of the SCTP kernel implementation
8  *
9  * These functions work with the state functions in sctp_sm_statefuns.c
10  * to implement that state operations.  These functions implement the
11  * steps which require modifying existing data structures.
12  *
13  * Please send any bug reports or fixes you make to the
14  * email address(es):
15  *    lksctp developers <linux-sctp@vger.kernel.org>
16  *
17  * Written or modified by:
18  *    La Monte H.P. Yarroll <piggy@acm.org>
19  *    Karl Knutson          <karl@athena.chicago.il.us>
20  *    Jon Grimm             <jgrimm@austin.ibm.com>
21  *    Hui Huang             <hui.huang@nokia.com>
22  *    Dajiang Zhang         <dajiang.zhang@nokia.com>
23  *    Daisy Chang           <daisyc@us.ibm.com>
24  *    Sridhar Samudrala     <sri@us.ibm.com>
25  *    Ardelle Fan           <ardelle.fan@intel.com>
26  */
27
28 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
29
30 #include <linux/skbuff.h>
31 #include <linux/types.h>
32 #include <linux/socket.h>
33 #include <linux/ip.h>
34 #include <linux/gfp.h>
35 #include <net/sock.h>
36 #include <net/sctp/sctp.h>
37 #include <net/sctp/sm.h>
38 #include <net/sctp/stream_sched.h>
39
40 static int sctp_cmd_interpreter(enum sctp_event_type event_type,
41                                 union sctp_subtype subtype,
42                                 enum sctp_state state,
43                                 struct sctp_endpoint *ep,
44                                 struct sctp_association *asoc,
45                                 void *event_arg,
46                                 enum sctp_disposition status,
47                                 struct sctp_cmd_seq *commands,
48                                 gfp_t gfp);
49 static int sctp_side_effects(enum sctp_event_type event_type,
50                              union sctp_subtype subtype,
51                              enum sctp_state state,
52                              struct sctp_endpoint *ep,
53                              struct sctp_association **asoc,
54                              void *event_arg,
55                              enum sctp_disposition status,
56                              struct sctp_cmd_seq *commands,
57                              gfp_t gfp);
58
59 /********************************************************************
60  * Helper functions
61  ********************************************************************/
62
63 /* A helper function for delayed processing of INET ECN CE bit. */
64 static void sctp_do_ecn_ce_work(struct sctp_association *asoc,
65                                 __u32 lowest_tsn)
66 {
67         /* Save the TSN away for comparison when we receive CWR */
68
69         asoc->last_ecne_tsn = lowest_tsn;
70         asoc->need_ecne = 1;
71 }
72
73 /* Helper function for delayed processing of SCTP ECNE chunk.  */
74 /* RFC 2960 Appendix A
75  *
76  * RFC 2481 details a specific bit for a sender to send in
77  * the header of its next outbound TCP segment to indicate to
78  * its peer that it has reduced its congestion window.  This
79  * is termed the CWR bit.  For SCTP the same indication is made
80  * by including the CWR chunk.  This chunk contains one data
81  * element, i.e. the TSN number that was sent in the ECNE chunk.
82  * This element represents the lowest TSN number in the datagram
83  * that was originally marked with the CE bit.
84  */
85 static struct sctp_chunk *sctp_do_ecn_ecne_work(struct sctp_association *asoc,
86                                                 __u32 lowest_tsn,
87                                                 struct sctp_chunk *chunk)
88 {
89         struct sctp_chunk *repl;
90
91         /* Our previously transmitted packet ran into some congestion
92          * so we should take action by reducing cwnd and ssthresh
93          * and then ACK our peer that we we've done so by
94          * sending a CWR.
95          */
96
97         /* First, try to determine if we want to actually lower
98          * our cwnd variables.  Only lower them if the ECNE looks more
99          * recent than the last response.
100          */
101         if (TSN_lt(asoc->last_cwr_tsn, lowest_tsn)) {
102                 struct sctp_transport *transport;
103
104                 /* Find which transport's congestion variables
105                  * need to be adjusted.
106                  */
107                 transport = sctp_assoc_lookup_tsn(asoc, lowest_tsn);
108
109                 /* Update the congestion variables. */
110                 if (transport)
111                         sctp_transport_lower_cwnd(transport,
112                                                   SCTP_LOWER_CWND_ECNE);
113                 asoc->last_cwr_tsn = lowest_tsn;
114         }
115
116         /* Always try to quiet the other end.  In case of lost CWR,
117          * resend last_cwr_tsn.
118          */
119         repl = sctp_make_cwr(asoc, asoc->last_cwr_tsn, chunk);
120
121         /* If we run out of memory, it will look like a lost CWR.  We'll
122          * get back in sync eventually.
123          */
124         return repl;
125 }
126
127 /* Helper function to do delayed processing of ECN CWR chunk.  */
128 static void sctp_do_ecn_cwr_work(struct sctp_association *asoc,
129                                  __u32 lowest_tsn)
130 {
131         /* Turn off ECNE getting auto-prepended to every outgoing
132          * packet
133          */
134         asoc->need_ecne = 0;
135 }
136
137 /* Generate SACK if necessary.  We call this at the end of a packet.  */
138 static int sctp_gen_sack(struct sctp_association *asoc, int force,
139                          struct sctp_cmd_seq *commands)
140 {
141         struct sctp_transport *trans = asoc->peer.last_data_from;
142         __u32 ctsn, max_tsn_seen;
143         struct sctp_chunk *sack;
144         int error = 0;
145
146         if (force ||
147             (!trans && (asoc->param_flags & SPP_SACKDELAY_DISABLE)) ||
148             (trans && (trans->param_flags & SPP_SACKDELAY_DISABLE)))
149                 asoc->peer.sack_needed = 1;
150
151         ctsn = sctp_tsnmap_get_ctsn(&asoc->peer.tsn_map);
152         max_tsn_seen = sctp_tsnmap_get_max_tsn_seen(&asoc->peer.tsn_map);
153
154         /* From 12.2 Parameters necessary per association (i.e. the TCB):
155          *
156          * Ack State : This flag indicates if the next received packet
157          *           : is to be responded to with a SACK. ...
158          *           : When DATA chunks are out of order, SACK's
159          *           : are not delayed (see Section 6).
160          *
161          * [This is actually not mentioned in Section 6, but we
162          * implement it here anyway. --piggy]
163          */
164         if (max_tsn_seen != ctsn)
165                 asoc->peer.sack_needed = 1;
166
167         /* From 6.2  Acknowledgement on Reception of DATA Chunks:
168          *
169          * Section 4.2 of [RFC2581] SHOULD be followed. Specifically,
170          * an acknowledgement SHOULD be generated for at least every
171          * second packet (not every second DATA chunk) received, and
172          * SHOULD be generated within 200 ms of the arrival of any
173          * unacknowledged DATA chunk. ...
174          */
175         if (!asoc->peer.sack_needed) {
176                 asoc->peer.sack_cnt++;
177
178                 /* Set the SACK delay timeout based on the
179                  * SACK delay for the last transport
180                  * data was received from, or the default
181                  * for the association.
182                  */
183                 if (trans) {
184                         /* We will need a SACK for the next packet.  */
185                         if (asoc->peer.sack_cnt >= trans->sackfreq - 1)
186                                 asoc->peer.sack_needed = 1;
187
188                         asoc->timeouts[SCTP_EVENT_TIMEOUT_SACK] =
189                                 trans->sackdelay;
190                 } else {
191                         /* We will need a SACK for the next packet.  */
192                         if (asoc->peer.sack_cnt >= asoc->sackfreq - 1)
193                                 asoc->peer.sack_needed = 1;
194
195                         asoc->timeouts[SCTP_EVENT_TIMEOUT_SACK] =
196                                 asoc->sackdelay;
197                 }
198
199                 /* Restart the SACK timer. */
200                 sctp_add_cmd_sf(commands, SCTP_CMD_TIMER_RESTART,
201                                 SCTP_TO(SCTP_EVENT_TIMEOUT_SACK));
202         } else {
203                 __u32 old_a_rwnd = asoc->a_rwnd;
204
205                 asoc->a_rwnd = asoc->rwnd;
206                 sack = sctp_make_sack(asoc);
207                 if (!sack) {
208                         asoc->a_rwnd = old_a_rwnd;
209                         goto nomem;
210                 }
211
212                 asoc->peer.sack_needed = 0;
213                 asoc->peer.sack_cnt = 0;
214
215                 sctp_add_cmd_sf(commands, SCTP_CMD_REPLY, SCTP_CHUNK(sack));
216
217                 /* Stop the SACK timer.  */
218                 sctp_add_cmd_sf(commands, SCTP_CMD_TIMER_STOP,
219                                 SCTP_TO(SCTP_EVENT_TIMEOUT_SACK));
220         }
221
222         return error;
223 nomem:
224         error = -ENOMEM;
225         return error;
226 }
227
228 /* When the T3-RTX timer expires, it calls this function to create the
229  * relevant state machine event.
230  */
231 void sctp_generate_t3_rtx_event(struct timer_list *t)
232 {
233         struct sctp_transport *transport =
234                 from_timer(transport, t, T3_rtx_timer);
235         struct sctp_association *asoc = transport->asoc;
236         struct sock *sk = asoc->base.sk;
237         struct net *net = sock_net(sk);
238         int error;
239
240         /* Check whether a task is in the sock.  */
241
242         bh_lock_sock(sk);
243         if (sock_owned_by_user(sk)) {
244                 pr_debug("%s: sock is busy\n", __func__);
245
246                 /* Try again later.  */
247                 if (!mod_timer(&transport->T3_rtx_timer, jiffies + (HZ/20)))
248                         sctp_transport_hold(transport);
249                 goto out_unlock;
250         }
251
252         /* Run through the state machine.  */
253         error = sctp_do_sm(net, SCTP_EVENT_T_TIMEOUT,
254                            SCTP_ST_TIMEOUT(SCTP_EVENT_TIMEOUT_T3_RTX),
255                            asoc->state,
256                            asoc->ep, asoc,
257                            transport, GFP_ATOMIC);
258
259         if (error)
260                 sk->sk_err = -error;
261
262 out_unlock:
263         bh_unlock_sock(sk);
264         sctp_transport_put(transport);
265 }
266
267 /* This is a sa interface for producing timeout events.  It works
268  * for timeouts which use the association as their parameter.
269  */
270 static void sctp_generate_timeout_event(struct sctp_association *asoc,
271                                         enum sctp_event_timeout timeout_type)
272 {
273         struct sock *sk = asoc->base.sk;
274         struct net *net = sock_net(sk);
275         int error = 0;
276
277         bh_lock_sock(sk);
278         if (sock_owned_by_user(sk)) {
279                 pr_debug("%s: sock is busy: timer %d\n", __func__,
280                          timeout_type);
281
282                 /* Try again later.  */
283                 if (!mod_timer(&asoc->timers[timeout_type], jiffies + (HZ/20)))
284                         sctp_association_hold(asoc);
285                 goto out_unlock;
286         }
287
288         /* Is this association really dead and just waiting around for
289          * the timer to let go of the reference?
290          */
291         if (asoc->base.dead)
292                 goto out_unlock;
293
294         /* Run through the state machine.  */
295         error = sctp_do_sm(net, SCTP_EVENT_T_TIMEOUT,
296                            SCTP_ST_TIMEOUT(timeout_type),
297                            asoc->state, asoc->ep, asoc,
298                            (void *)timeout_type, GFP_ATOMIC);
299
300         if (error)
301                 sk->sk_err = -error;
302
303 out_unlock:
304         bh_unlock_sock(sk);
305         sctp_association_put(asoc);
306 }
307
308 static void sctp_generate_t1_cookie_event(struct timer_list *t)
309 {
310         struct sctp_association *asoc =
311                 from_timer(asoc, t, timers[SCTP_EVENT_TIMEOUT_T1_COOKIE]);
312
313         sctp_generate_timeout_event(asoc, SCTP_EVENT_TIMEOUT_T1_COOKIE);
314 }
315
316 static void sctp_generate_t1_init_event(struct timer_list *t)
317 {
318         struct sctp_association *asoc =
319                 from_timer(asoc, t, timers[SCTP_EVENT_TIMEOUT_T1_INIT]);
320
321         sctp_generate_timeout_event(asoc, SCTP_EVENT_TIMEOUT_T1_INIT);
322 }
323
324 static void sctp_generate_t2_shutdown_event(struct timer_list *t)
325 {
326         struct sctp_association *asoc =
327                 from_timer(asoc, t, timers[SCTP_EVENT_TIMEOUT_T2_SHUTDOWN]);
328
329         sctp_generate_timeout_event(asoc, SCTP_EVENT_TIMEOUT_T2_SHUTDOWN);
330 }
331
332 static void sctp_generate_t4_rto_event(struct timer_list *t)
333 {
334         struct sctp_association *asoc =
335                 from_timer(asoc, t, timers[SCTP_EVENT_TIMEOUT_T4_RTO]);
336
337         sctp_generate_timeout_event(asoc, SCTP_EVENT_TIMEOUT_T4_RTO);
338 }
339
340 static void sctp_generate_t5_shutdown_guard_event(struct timer_list *t)
341 {
342         struct sctp_association *asoc =
343                 from_timer(asoc, t,
344                            timers[SCTP_EVENT_TIMEOUT_T5_SHUTDOWN_GUARD]);
345
346         sctp_generate_timeout_event(asoc,
347                                     SCTP_EVENT_TIMEOUT_T5_SHUTDOWN_GUARD);
348
349 } /* sctp_generate_t5_shutdown_guard_event() */
350
351 static void sctp_generate_autoclose_event(struct timer_list *t)
352 {
353         struct sctp_association *asoc =
354                 from_timer(asoc, t, timers[SCTP_EVENT_TIMEOUT_AUTOCLOSE]);
355
356         sctp_generate_timeout_event(asoc, SCTP_EVENT_TIMEOUT_AUTOCLOSE);
357 }
358
359 /* Generate a heart beat event.  If the sock is busy, reschedule.   Make
360  * sure that the transport is still valid.
361  */
362 void sctp_generate_heartbeat_event(struct timer_list *t)
363 {
364         struct sctp_transport *transport = from_timer(transport, t, hb_timer);
365         struct sctp_association *asoc = transport->asoc;
366         struct sock *sk = asoc->base.sk;
367         struct net *net = sock_net(sk);
368         u32 elapsed, timeout;
369         int error = 0;
370
371         bh_lock_sock(sk);
372         if (sock_owned_by_user(sk)) {
373                 pr_debug("%s: sock is busy\n", __func__);
374
375                 /* Try again later.  */
376                 if (!mod_timer(&transport->hb_timer, jiffies + (HZ/20)))
377                         sctp_transport_hold(transport);
378                 goto out_unlock;
379         }
380
381         /* Check if we should still send the heartbeat or reschedule */
382         elapsed = jiffies - transport->last_time_sent;
383         timeout = sctp_transport_timeout(transport);
384         if (elapsed < timeout) {
385                 elapsed = timeout - elapsed;
386                 if (!mod_timer(&transport->hb_timer, jiffies + elapsed))
387                         sctp_transport_hold(transport);
388                 goto out_unlock;
389         }
390
391         error = sctp_do_sm(net, SCTP_EVENT_T_TIMEOUT,
392                            SCTP_ST_TIMEOUT(SCTP_EVENT_TIMEOUT_HEARTBEAT),
393                            asoc->state, asoc->ep, asoc,
394                            transport, GFP_ATOMIC);
395
396         if (error)
397                 sk->sk_err = -error;
398
399 out_unlock:
400         bh_unlock_sock(sk);
401         sctp_transport_put(transport);
402 }
403
404 /* Handle the timeout of the ICMP protocol unreachable timer.  Trigger
405  * the correct state machine transition that will close the association.
406  */
407 void sctp_generate_proto_unreach_event(struct timer_list *t)
408 {
409         struct sctp_transport *transport =
410                 from_timer(transport, t, proto_unreach_timer);
411         struct sctp_association *asoc = transport->asoc;
412         struct sock *sk = asoc->base.sk;
413         struct net *net = sock_net(sk);
414
415         bh_lock_sock(sk);
416         if (sock_owned_by_user(sk)) {
417                 pr_debug("%s: sock is busy\n", __func__);
418
419                 /* Try again later.  */
420                 if (!mod_timer(&transport->proto_unreach_timer,
421                                 jiffies + (HZ/20)))
422                         sctp_transport_hold(transport);
423                 goto out_unlock;
424         }
425
426         /* Is this structure just waiting around for us to actually
427          * get destroyed?
428          */
429         if (asoc->base.dead)
430                 goto out_unlock;
431
432         sctp_do_sm(net, SCTP_EVENT_T_OTHER,
433                    SCTP_ST_OTHER(SCTP_EVENT_ICMP_PROTO_UNREACH),
434                    asoc->state, asoc->ep, asoc, transport, GFP_ATOMIC);
435
436 out_unlock:
437         bh_unlock_sock(sk);
438         sctp_transport_put(transport);
439 }
440
441  /* Handle the timeout of the RE-CONFIG timer. */
442 void sctp_generate_reconf_event(struct timer_list *t)
443 {
444         struct sctp_transport *transport =
445                 from_timer(transport, t, reconf_timer);
446         struct sctp_association *asoc = transport->asoc;
447         struct sock *sk = asoc->base.sk;
448         struct net *net = sock_net(sk);
449         int error = 0;
450
451         bh_lock_sock(sk);
452         if (sock_owned_by_user(sk)) {
453                 pr_debug("%s: sock is busy\n", __func__);
454
455                 /* Try again later.  */
456                 if (!mod_timer(&transport->reconf_timer, jiffies + (HZ / 20)))
457                         sctp_transport_hold(transport);
458                 goto out_unlock;
459         }
460
461         /* This happens when the response arrives after the timer is triggered. */
462         if (!asoc->strreset_chunk)
463                 goto out_unlock;
464
465         error = sctp_do_sm(net, SCTP_EVENT_T_TIMEOUT,
466                            SCTP_ST_TIMEOUT(SCTP_EVENT_TIMEOUT_RECONF),
467                            asoc->state, asoc->ep, asoc,
468                            transport, GFP_ATOMIC);
469
470         if (error)
471                 sk->sk_err = -error;
472
473 out_unlock:
474         bh_unlock_sock(sk);
475         sctp_transport_put(transport);
476 }
477
478 /* Handle the timeout of the probe timer. */
479 void sctp_generate_probe_event(struct timer_list *t)
480 {
481         struct sctp_transport *transport = from_timer(transport, t, probe_timer);
482         struct sctp_association *asoc = transport->asoc;
483         struct sock *sk = asoc->base.sk;
484         struct net *net = sock_net(sk);
485         int error = 0;
486
487         bh_lock_sock(sk);
488         if (sock_owned_by_user(sk)) {
489                 pr_debug("%s: sock is busy\n", __func__);
490
491                 /* Try again later.  */
492                 if (!mod_timer(&transport->probe_timer, jiffies + (HZ / 20)))
493                         sctp_transport_hold(transport);
494                 goto out_unlock;
495         }
496
497         error = sctp_do_sm(net, SCTP_EVENT_T_TIMEOUT,
498                            SCTP_ST_TIMEOUT(SCTP_EVENT_TIMEOUT_PROBE),
499                            asoc->state, asoc->ep, asoc,
500                            transport, GFP_ATOMIC);
501
502         if (error)
503                 sk->sk_err = -error;
504
505 out_unlock:
506         bh_unlock_sock(sk);
507         sctp_transport_put(transport);
508 }
509
510 /* Inject a SACK Timeout event into the state machine.  */
511 static void sctp_generate_sack_event(struct timer_list *t)
512 {
513         struct sctp_association *asoc =
514                 from_timer(asoc, t, timers[SCTP_EVENT_TIMEOUT_SACK]);
515
516         sctp_generate_timeout_event(asoc, SCTP_EVENT_TIMEOUT_SACK);
517 }
518
519 sctp_timer_event_t *sctp_timer_events[SCTP_NUM_TIMEOUT_TYPES] = {
520         [SCTP_EVENT_TIMEOUT_NONE] =             NULL,
521         [SCTP_EVENT_TIMEOUT_T1_COOKIE] =        sctp_generate_t1_cookie_event,
522         [SCTP_EVENT_TIMEOUT_T1_INIT] =          sctp_generate_t1_init_event,
523         [SCTP_EVENT_TIMEOUT_T2_SHUTDOWN] =      sctp_generate_t2_shutdown_event,
524         [SCTP_EVENT_TIMEOUT_T3_RTX] =           NULL,
525         [SCTP_EVENT_TIMEOUT_T4_RTO] =           sctp_generate_t4_rto_event,
526         [SCTP_EVENT_TIMEOUT_T5_SHUTDOWN_GUARD] =
527                                         sctp_generate_t5_shutdown_guard_event,
528         [SCTP_EVENT_TIMEOUT_HEARTBEAT] =        NULL,
529         [SCTP_EVENT_TIMEOUT_RECONF] =           NULL,
530         [SCTP_EVENT_TIMEOUT_SACK] =             sctp_generate_sack_event,
531         [SCTP_EVENT_TIMEOUT_AUTOCLOSE] =        sctp_generate_autoclose_event,
532 };
533
534
535 /* RFC 2960 8.2 Path Failure Detection
536  *
537  * When its peer endpoint is multi-homed, an endpoint should keep a
538  * error counter for each of the destination transport addresses of the
539  * peer endpoint.
540  *
541  * Each time the T3-rtx timer expires on any address, or when a
542  * HEARTBEAT sent to an idle address is not acknowledged within a RTO,
543  * the error counter of that destination address will be incremented.
544  * When the value in the error counter exceeds the protocol parameter
545  * 'Path.Max.Retrans' of that destination address, the endpoint should
546  * mark the destination transport address as inactive, and a
547  * notification SHOULD be sent to the upper layer.
548  *
549  */
550 static void sctp_do_8_2_transport_strike(struct sctp_cmd_seq *commands,
551                                          struct sctp_association *asoc,
552                                          struct sctp_transport *transport,
553                                          int is_hb)
554 {
555         /* The check for association's overall error counter exceeding the
556          * threshold is done in the state function.
557          */
558         /* We are here due to a timer expiration.  If the timer was
559          * not a HEARTBEAT, then normal error tracking is done.
560          * If the timer was a heartbeat, we only increment error counts
561          * when we already have an outstanding HEARTBEAT that has not
562          * been acknowledged.
563          * Additionally, some tranport states inhibit error increments.
564          */
565         if (!is_hb) {
566                 asoc->overall_error_count++;
567                 if (transport->state != SCTP_INACTIVE)
568                         transport->error_count++;
569          } else if (transport->hb_sent) {
570                 if (transport->state != SCTP_UNCONFIRMED)
571                         asoc->overall_error_count++;
572                 if (transport->state != SCTP_INACTIVE)
573                         transport->error_count++;
574         }
575
576         /* If the transport error count is greater than the pf_retrans
577          * threshold, and less than pathmaxrtx, and if the current state
578          * is SCTP_ACTIVE, then mark this transport as Partially Failed,
579          * see SCTP Quick Failover Draft, section 5.1
580          */
581         if (asoc->base.net->sctp.pf_enable &&
582             transport->state == SCTP_ACTIVE &&
583             transport->error_count < transport->pathmaxrxt &&
584             transport->error_count > transport->pf_retrans) {
585
586                 sctp_assoc_control_transport(asoc, transport,
587                                              SCTP_TRANSPORT_PF,
588                                              0);
589
590                 /* Update the hb timer to resend a heartbeat every rto */
591                 sctp_transport_reset_hb_timer(transport);
592         }
593
594         if (transport->state != SCTP_INACTIVE &&
595             (transport->error_count > transport->pathmaxrxt)) {
596                 pr_debug("%s: association:%p transport addr:%pISpc failed\n",
597                          __func__, asoc, &transport->ipaddr.sa);
598
599                 sctp_assoc_control_transport(asoc, transport,
600                                              SCTP_TRANSPORT_DOWN,
601                                              SCTP_FAILED_THRESHOLD);
602         }
603
604         if (transport->error_count > transport->ps_retrans &&
605             asoc->peer.primary_path == transport &&
606             asoc->peer.active_path != transport)
607                 sctp_assoc_set_primary(asoc, asoc->peer.active_path);
608
609         /* E2) For the destination address for which the timer
610          * expires, set RTO <- RTO * 2 ("back off the timer").  The
611          * maximum value discussed in rule C7 above (RTO.max) may be
612          * used to provide an upper bound to this doubling operation.
613          *
614          * Special Case:  the first HB doesn't trigger exponential backoff.
615          * The first unacknowledged HB triggers it.  We do this with a flag
616          * that indicates that we have an outstanding HB.
617          */
618         if (!is_hb || transport->hb_sent) {
619                 transport->rto = min((transport->rto * 2), transport->asoc->rto_max);
620                 sctp_max_rto(asoc, transport);
621         }
622 }
623
624 /* Worker routine to handle INIT command failure.  */
625 static void sctp_cmd_init_failed(struct sctp_cmd_seq *commands,
626                                  struct sctp_association *asoc,
627                                  unsigned int error)
628 {
629         struct sctp_ulpevent *event;
630
631         event = sctp_ulpevent_make_assoc_change(asoc, 0, SCTP_CANT_STR_ASSOC,
632                                                 (__u16)error, 0, 0, NULL,
633                                                 GFP_ATOMIC);
634
635         if (event)
636                 sctp_add_cmd_sf(commands, SCTP_CMD_EVENT_ULP,
637                                 SCTP_ULPEVENT(event));
638
639         sctp_add_cmd_sf(commands, SCTP_CMD_NEW_STATE,
640                         SCTP_STATE(SCTP_STATE_CLOSED));
641
642         /* SEND_FAILED sent later when cleaning up the association. */
643         asoc->outqueue.error = error;
644         sctp_add_cmd_sf(commands, SCTP_CMD_DELETE_TCB, SCTP_NULL());
645 }
646
647 /* Worker routine to handle SCTP_CMD_ASSOC_FAILED.  */
648 static void sctp_cmd_assoc_failed(struct sctp_cmd_seq *commands,
649                                   struct sctp_association *asoc,
650                                   enum sctp_event_type event_type,
651                                   union sctp_subtype subtype,
652                                   struct sctp_chunk *chunk,
653                                   unsigned int error)
654 {
655         struct sctp_ulpevent *event;
656         struct sctp_chunk *abort;
657
658         /* Cancel any partial delivery in progress. */
659         asoc->stream.si->abort_pd(&asoc->ulpq, GFP_ATOMIC);
660
661         if (event_type == SCTP_EVENT_T_CHUNK && subtype.chunk == SCTP_CID_ABORT)
662                 event = sctp_ulpevent_make_assoc_change(asoc, 0, SCTP_COMM_LOST,
663                                                 (__u16)error, 0, 0, chunk,
664                                                 GFP_ATOMIC);
665         else
666                 event = sctp_ulpevent_make_assoc_change(asoc, 0, SCTP_COMM_LOST,
667                                                 (__u16)error, 0, 0, NULL,
668                                                 GFP_ATOMIC);
669         if (event)
670                 sctp_add_cmd_sf(commands, SCTP_CMD_EVENT_ULP,
671                                 SCTP_ULPEVENT(event));
672
673         if (asoc->overall_error_count >= asoc->max_retrans) {
674                 abort = sctp_make_violation_max_retrans(asoc, chunk);
675                 if (abort)
676                         sctp_add_cmd_sf(commands, SCTP_CMD_REPLY,
677                                         SCTP_CHUNK(abort));
678         }
679
680         sctp_add_cmd_sf(commands, SCTP_CMD_NEW_STATE,
681                         SCTP_STATE(SCTP_STATE_CLOSED));
682
683         /* SEND_FAILED sent later when cleaning up the association. */
684         asoc->outqueue.error = error;
685         sctp_add_cmd_sf(commands, SCTP_CMD_DELETE_TCB, SCTP_NULL());
686 }
687
688 /* Process an init chunk (may be real INIT/INIT-ACK or an embedded INIT
689  * inside the cookie.  In reality, this is only used for INIT-ACK processing
690  * since all other cases use "temporary" associations and can do all
691  * their work in statefuns directly.
692  */
693 static int sctp_cmd_process_init(struct sctp_cmd_seq *commands,
694                                  struct sctp_association *asoc,
695                                  struct sctp_chunk *chunk,
696                                  struct sctp_init_chunk *peer_init,
697                                  gfp_t gfp)
698 {
699         int error;
700
701         /* We only process the init as a sideeffect in a single
702          * case.   This is when we process the INIT-ACK.   If we
703          * fail during INIT processing (due to malloc problems),
704          * just return the error and stop processing the stack.
705          */
706         if (!sctp_process_init(asoc, chunk, sctp_source(chunk), peer_init, gfp))
707                 error = -ENOMEM;
708         else
709                 error = 0;
710
711         return error;
712 }
713
714 /* Helper function to break out starting up of heartbeat timers.  */
715 static void sctp_cmd_hb_timers_start(struct sctp_cmd_seq *cmds,
716                                      struct sctp_association *asoc)
717 {
718         struct sctp_transport *t;
719
720         /* Start a heartbeat timer for each transport on the association.
721          * hold a reference on the transport to make sure none of
722          * the needed data structures go away.
723          */
724         list_for_each_entry(t, &asoc->peer.transport_addr_list, transports)
725                 sctp_transport_reset_hb_timer(t);
726 }
727
728 static void sctp_cmd_hb_timers_stop(struct sctp_cmd_seq *cmds,
729                                     struct sctp_association *asoc)
730 {
731         struct sctp_transport *t;
732
733         /* Stop all heartbeat timers. */
734
735         list_for_each_entry(t, &asoc->peer.transport_addr_list,
736                         transports) {
737                 if (del_timer(&t->hb_timer))
738                         sctp_transport_put(t);
739         }
740 }
741
742 /* Helper function to stop any pending T3-RTX timers */
743 static void sctp_cmd_t3_rtx_timers_stop(struct sctp_cmd_seq *cmds,
744                                         struct sctp_association *asoc)
745 {
746         struct sctp_transport *t;
747
748         list_for_each_entry(t, &asoc->peer.transport_addr_list,
749                         transports) {
750                 if (del_timer(&t->T3_rtx_timer))
751                         sctp_transport_put(t);
752         }
753 }
754
755
756 /* Helper function to handle the reception of an HEARTBEAT ACK.  */
757 static void sctp_cmd_transport_on(struct sctp_cmd_seq *cmds,
758                                   struct sctp_association *asoc,
759                                   struct sctp_transport *t,
760                                   struct sctp_chunk *chunk)
761 {
762         struct sctp_sender_hb_info *hbinfo;
763         int was_unconfirmed = 0;
764
765         /* 8.3 Upon the receipt of the HEARTBEAT ACK, the sender of the
766          * HEARTBEAT should clear the error counter of the destination
767          * transport address to which the HEARTBEAT was sent.
768          */
769         t->error_count = 0;
770
771         /*
772          * Although RFC4960 specifies that the overall error count must
773          * be cleared when a HEARTBEAT ACK is received, we make an
774          * exception while in SHUTDOWN PENDING. If the peer keeps its
775          * window shut forever, we may never be able to transmit our
776          * outstanding data and rely on the retransmission limit be reached
777          * to shutdown the association.
778          */
779         if (t->asoc->state < SCTP_STATE_SHUTDOWN_PENDING)
780                 t->asoc->overall_error_count = 0;
781
782         /* Clear the hb_sent flag to signal that we had a good
783          * acknowledgement.
784          */
785         t->hb_sent = 0;
786
787         /* Mark the destination transport address as active if it is not so
788          * marked.
789          */
790         if ((t->state == SCTP_INACTIVE) || (t->state == SCTP_UNCONFIRMED)) {
791                 was_unconfirmed = 1;
792                 sctp_assoc_control_transport(asoc, t, SCTP_TRANSPORT_UP,
793                                              SCTP_HEARTBEAT_SUCCESS);
794         }
795
796         if (t->state == SCTP_PF)
797                 sctp_assoc_control_transport(asoc, t, SCTP_TRANSPORT_UP,
798                                              SCTP_HEARTBEAT_SUCCESS);
799
800         /* HB-ACK was received for a the proper HB.  Consider this
801          * forward progress.
802          */
803         if (t->dst)
804                 sctp_transport_dst_confirm(t);
805
806         /* The receiver of the HEARTBEAT ACK should also perform an
807          * RTT measurement for that destination transport address
808          * using the time value carried in the HEARTBEAT ACK chunk.
809          * If the transport's rto_pending variable has been cleared,
810          * it was most likely due to a retransmit.  However, we want
811          * to re-enable it to properly update the rto.
812          */
813         if (t->rto_pending == 0)
814                 t->rto_pending = 1;
815
816         hbinfo = (struct sctp_sender_hb_info *)chunk->skb->data;
817         sctp_transport_update_rto(t, (jiffies - hbinfo->sent_at));
818
819         /* Update the heartbeat timer.  */
820         sctp_transport_reset_hb_timer(t);
821
822         if (was_unconfirmed && asoc->peer.transport_count == 1)
823                 sctp_transport_immediate_rtx(t);
824 }
825
826
827 /* Helper function to process the process SACK command.  */
828 static int sctp_cmd_process_sack(struct sctp_cmd_seq *cmds,
829                                  struct sctp_association *asoc,
830                                  struct sctp_chunk *chunk)
831 {
832         int err = 0;
833
834         if (sctp_outq_sack(&asoc->outqueue, chunk)) {
835                 /* There are no more TSNs awaiting SACK.  */
836                 err = sctp_do_sm(asoc->base.net, SCTP_EVENT_T_OTHER,
837                                  SCTP_ST_OTHER(SCTP_EVENT_NO_PENDING_TSN),
838                                  asoc->state, asoc->ep, asoc, NULL,
839                                  GFP_ATOMIC);
840         }
841
842         return err;
843 }
844
845 /* Helper function to set the timeout value for T2-SHUTDOWN timer and to set
846  * the transport for a shutdown chunk.
847  */
848 static void sctp_cmd_setup_t2(struct sctp_cmd_seq *cmds,
849                               struct sctp_association *asoc,
850                               struct sctp_chunk *chunk)
851 {
852         struct sctp_transport *t;
853
854         if (chunk->transport)
855                 t = chunk->transport;
856         else {
857                 t = sctp_assoc_choose_alter_transport(asoc,
858                                               asoc->shutdown_last_sent_to);
859                 chunk->transport = t;
860         }
861         asoc->shutdown_last_sent_to = t;
862         asoc->timeouts[SCTP_EVENT_TIMEOUT_T2_SHUTDOWN] = t->rto;
863 }
864
865 /* Helper function to change the state of an association. */
866 static void sctp_cmd_new_state(struct sctp_cmd_seq *cmds,
867                                struct sctp_association *asoc,
868                                enum sctp_state state)
869 {
870         struct sock *sk = asoc->base.sk;
871
872         asoc->state = state;
873
874         pr_debug("%s: asoc:%p[%s]\n", __func__, asoc, sctp_state_tbl[state]);
875
876         if (sctp_style(sk, TCP)) {
877                 /* Change the sk->sk_state of a TCP-style socket that has
878                  * successfully completed a connect() call.
879                  */
880                 if (sctp_state(asoc, ESTABLISHED) && sctp_sstate(sk, CLOSED))
881                         inet_sk_set_state(sk, SCTP_SS_ESTABLISHED);
882
883                 /* Set the RCV_SHUTDOWN flag when a SHUTDOWN is received. */
884                 if (sctp_state(asoc, SHUTDOWN_RECEIVED) &&
885                     sctp_sstate(sk, ESTABLISHED)) {
886                         inet_sk_set_state(sk, SCTP_SS_CLOSING);
887                         sk->sk_shutdown |= RCV_SHUTDOWN;
888                 }
889         }
890
891         if (sctp_state(asoc, COOKIE_WAIT)) {
892                 /* Reset init timeouts since they may have been
893                  * increased due to timer expirations.
894                  */
895                 asoc->timeouts[SCTP_EVENT_TIMEOUT_T1_INIT] =
896                                                 asoc->rto_initial;
897                 asoc->timeouts[SCTP_EVENT_TIMEOUT_T1_COOKIE] =
898                                                 asoc->rto_initial;
899         }
900
901         if (sctp_state(asoc, ESTABLISHED)) {
902                 kfree(asoc->peer.cookie);
903                 asoc->peer.cookie = NULL;
904         }
905
906         if (sctp_state(asoc, ESTABLISHED) ||
907             sctp_state(asoc, CLOSED) ||
908             sctp_state(asoc, SHUTDOWN_RECEIVED)) {
909                 /* Wake up any processes waiting in the asoc's wait queue in
910                  * sctp_wait_for_connect() or sctp_wait_for_sndbuf().
911                  */
912                 if (waitqueue_active(&asoc->wait))
913                         wake_up_interruptible(&asoc->wait);
914
915                 /* Wake up any processes waiting in the sk's sleep queue of
916                  * a TCP-style or UDP-style peeled-off socket in
917                  * sctp_wait_for_accept() or sctp_wait_for_packet().
918                  * For a UDP-style socket, the waiters are woken up by the
919                  * notifications.
920                  */
921                 if (!sctp_style(sk, UDP))
922                         sk->sk_state_change(sk);
923         }
924
925         if (sctp_state(asoc, SHUTDOWN_PENDING) &&
926             !sctp_outq_is_empty(&asoc->outqueue))
927                 sctp_outq_uncork(&asoc->outqueue, GFP_ATOMIC);
928 }
929
930 /* Helper function to delete an association. */
931 static void sctp_cmd_delete_tcb(struct sctp_cmd_seq *cmds,
932                                 struct sctp_association *asoc)
933 {
934         struct sock *sk = asoc->base.sk;
935
936         /* If it is a non-temporary association belonging to a TCP-style
937          * listening socket that is not closed, do not free it so that accept()
938          * can pick it up later.
939          */
940         if (sctp_style(sk, TCP) && sctp_sstate(sk, LISTENING) &&
941             (!asoc->temp) && (sk->sk_shutdown != SHUTDOWN_MASK))
942                 return;
943
944         sctp_association_free(asoc);
945 }
946
947 /*
948  * ADDIP Section 4.1 ASCONF Chunk Procedures
949  * A4) Start a T-4 RTO timer, using the RTO value of the selected
950  * destination address (we use active path instead of primary path just
951  * because primary path may be inactive.
952  */
953 static void sctp_cmd_setup_t4(struct sctp_cmd_seq *cmds,
954                               struct sctp_association *asoc,
955                               struct sctp_chunk *chunk)
956 {
957         struct sctp_transport *t;
958
959         t = sctp_assoc_choose_alter_transport(asoc, chunk->transport);
960         asoc->timeouts[SCTP_EVENT_TIMEOUT_T4_RTO] = t->rto;
961         chunk->transport = t;
962 }
963
964 /* Process an incoming Operation Error Chunk. */
965 static void sctp_cmd_process_operr(struct sctp_cmd_seq *cmds,
966                                    struct sctp_association *asoc,
967                                    struct sctp_chunk *chunk)
968 {
969         struct sctp_errhdr *err_hdr;
970         struct sctp_ulpevent *ev;
971
972         while (chunk->chunk_end > chunk->skb->data) {
973                 err_hdr = (struct sctp_errhdr *)(chunk->skb->data);
974
975                 ev = sctp_ulpevent_make_remote_error(asoc, chunk, 0,
976                                                      GFP_ATOMIC);
977                 if (!ev)
978                         return;
979
980                 asoc->stream.si->enqueue_event(&asoc->ulpq, ev);
981
982                 switch (err_hdr->cause) {
983                 case SCTP_ERROR_UNKNOWN_CHUNK:
984                 {
985                         struct sctp_chunkhdr *unk_chunk_hdr;
986
987                         unk_chunk_hdr = (struct sctp_chunkhdr *)
988                                                         err_hdr->variable;
989                         switch (unk_chunk_hdr->type) {
990                         /* ADDIP 4.1 A9) If the peer responds to an ASCONF with
991                          * an ERROR chunk reporting that it did not recognized
992                          * the ASCONF chunk type, the sender of the ASCONF MUST
993                          * NOT send any further ASCONF chunks and MUST stop its
994                          * T-4 timer.
995                          */
996                         case SCTP_CID_ASCONF:
997                                 if (asoc->peer.asconf_capable == 0)
998                                         break;
999
1000                                 asoc->peer.asconf_capable = 0;
1001                                 sctp_add_cmd_sf(cmds, SCTP_CMD_TIMER_STOP,
1002                                         SCTP_TO(SCTP_EVENT_TIMEOUT_T4_RTO));
1003                                 break;
1004                         default:
1005                                 break;
1006                         }
1007                         break;
1008                 }
1009                 default:
1010                         break;
1011                 }
1012         }
1013 }
1014
1015 /* Helper function to remove the association non-primary peer
1016  * transports.
1017  */
1018 static void sctp_cmd_del_non_primary(struct sctp_association *asoc)
1019 {
1020         struct sctp_transport *t;
1021         struct list_head *temp;
1022         struct list_head *pos;
1023
1024         list_for_each_safe(pos, temp, &asoc->peer.transport_addr_list) {
1025                 t = list_entry(pos, struct sctp_transport, transports);
1026                 if (!sctp_cmp_addr_exact(&t->ipaddr,
1027                                          &asoc->peer.primary_addr)) {
1028                         sctp_assoc_rm_peer(asoc, t);
1029                 }
1030         }
1031 }
1032
1033 /* Helper function to set sk_err on a 1-1 style socket. */
1034 static void sctp_cmd_set_sk_err(struct sctp_association *asoc, int error)
1035 {
1036         struct sock *sk = asoc->base.sk;
1037
1038         if (!sctp_style(sk, UDP))
1039                 sk->sk_err = error;
1040 }
1041
1042 /* Helper function to generate an association change event */
1043 static void sctp_cmd_assoc_change(struct sctp_cmd_seq *commands,
1044                                   struct sctp_association *asoc,
1045                                   u8 state)
1046 {
1047         struct sctp_ulpevent *ev;
1048
1049         ev = sctp_ulpevent_make_assoc_change(asoc, 0, state, 0,
1050                                             asoc->c.sinit_num_ostreams,
1051                                             asoc->c.sinit_max_instreams,
1052                                             NULL, GFP_ATOMIC);
1053         if (ev)
1054                 asoc->stream.si->enqueue_event(&asoc->ulpq, ev);
1055 }
1056
1057 static void sctp_cmd_peer_no_auth(struct sctp_cmd_seq *commands,
1058                                   struct sctp_association *asoc)
1059 {
1060         struct sctp_ulpevent *ev;
1061
1062         ev = sctp_ulpevent_make_authkey(asoc, 0, SCTP_AUTH_NO_AUTH, GFP_ATOMIC);
1063         if (ev)
1064                 asoc->stream.si->enqueue_event(&asoc->ulpq, ev);
1065 }
1066
1067 /* Helper function to generate an adaptation indication event */
1068 static void sctp_cmd_adaptation_ind(struct sctp_cmd_seq *commands,
1069                                     struct sctp_association *asoc)
1070 {
1071         struct sctp_ulpevent *ev;
1072
1073         ev = sctp_ulpevent_make_adaptation_indication(asoc, GFP_ATOMIC);
1074
1075         if (ev)
1076                 asoc->stream.si->enqueue_event(&asoc->ulpq, ev);
1077 }
1078
1079
1080 static void sctp_cmd_t1_timer_update(struct sctp_association *asoc,
1081                                      enum sctp_event_timeout timer,
1082                                      char *name)
1083 {
1084         struct sctp_transport *t;
1085
1086         t = asoc->init_last_sent_to;
1087         asoc->init_err_counter++;
1088
1089         if (t->init_sent_count > (asoc->init_cycle + 1)) {
1090                 asoc->timeouts[timer] *= 2;
1091                 if (asoc->timeouts[timer] > asoc->max_init_timeo) {
1092                         asoc->timeouts[timer] = asoc->max_init_timeo;
1093                 }
1094                 asoc->init_cycle++;
1095
1096                 pr_debug("%s: T1[%s] timeout adjustment init_err_counter:%d"
1097                          " cycle:%d timeout:%ld\n", __func__, name,
1098                          asoc->init_err_counter, asoc->init_cycle,
1099                          asoc->timeouts[timer]);
1100         }
1101
1102 }
1103
1104 /* Send the whole message, chunk by chunk, to the outqueue.
1105  * This way the whole message is queued up and bundling if
1106  * encouraged for small fragments.
1107  */
1108 static void sctp_cmd_send_msg(struct sctp_association *asoc,
1109                               struct sctp_datamsg *msg, gfp_t gfp)
1110 {
1111         struct sctp_chunk *chunk;
1112
1113         list_for_each_entry(chunk, &msg->chunks, frag_list)
1114                 sctp_outq_tail(&asoc->outqueue, chunk, gfp);
1115
1116         asoc->outqueue.sched->enqueue(&asoc->outqueue, msg);
1117 }
1118
1119
1120 /* These three macros allow us to pull the debugging code out of the
1121  * main flow of sctp_do_sm() to keep attention focused on the real
1122  * functionality there.
1123  */
1124 #define debug_pre_sfn() \
1125         pr_debug("%s[pre-fn]: ep:%p, %s, %s, asoc:%p[%s], %s\n", __func__, \
1126                  ep, sctp_evttype_tbl[event_type], (*debug_fn)(subtype),   \
1127                  asoc, sctp_state_tbl[state], state_fn->name)
1128
1129 #define debug_post_sfn() \
1130         pr_debug("%s[post-fn]: asoc:%p, status:%s\n", __func__, asoc, \
1131                  sctp_status_tbl[status])
1132
1133 #define debug_post_sfx() \
1134         pr_debug("%s[post-sfx]: error:%d, asoc:%p[%s]\n", __func__, error, \
1135                  asoc, sctp_state_tbl[(asoc && sctp_id2assoc(ep->base.sk, \
1136                  sctp_assoc2id(asoc))) ? asoc->state : SCTP_STATE_CLOSED])
1137
1138 /*
1139  * This is the master state machine processing function.
1140  *
1141  * If you want to understand all of lksctp, this is a
1142  * good place to start.
1143  */
1144 int sctp_do_sm(struct net *net, enum sctp_event_type event_type,
1145                union sctp_subtype subtype, enum sctp_state state,
1146                struct sctp_endpoint *ep, struct sctp_association *asoc,
1147                void *event_arg, gfp_t gfp)
1148 {
1149         typedef const char *(printfn_t)(union sctp_subtype);
1150         static printfn_t *table[] = {
1151                 NULL, sctp_cname, sctp_tname, sctp_oname, sctp_pname,
1152         };
1153         printfn_t *debug_fn  __attribute__ ((unused)) = table[event_type];
1154         const struct sctp_sm_table_entry *state_fn;
1155         struct sctp_cmd_seq commands;
1156         enum sctp_disposition status;
1157         int error = 0;
1158
1159         /* Look up the state function, run it, and then process the
1160          * side effects.  These three steps are the heart of lksctp.
1161          */
1162         state_fn = sctp_sm_lookup_event(net, event_type, state, subtype);
1163
1164         sctp_init_cmd_seq(&commands);
1165
1166         debug_pre_sfn();
1167         status = state_fn->fn(net, ep, asoc, subtype, event_arg, &commands);
1168         debug_post_sfn();
1169
1170         error = sctp_side_effects(event_type, subtype, state,
1171                                   ep, &asoc, event_arg, status,
1172                                   &commands, gfp);
1173         debug_post_sfx();
1174
1175         return error;
1176 }
1177
1178 /*****************************************************************
1179  * This the master state function side effect processing function.
1180  *****************************************************************/
1181 static int sctp_side_effects(enum sctp_event_type event_type,
1182                              union sctp_subtype subtype,
1183                              enum sctp_state state,
1184                              struct sctp_endpoint *ep,
1185                              struct sctp_association **asoc,
1186                              void *event_arg,
1187                              enum sctp_disposition status,
1188                              struct sctp_cmd_seq *commands,
1189                              gfp_t gfp)
1190 {
1191         int error;
1192
1193         /* FIXME - Most of the dispositions left today would be categorized
1194          * as "exceptional" dispositions.  For those dispositions, it
1195          * may not be proper to run through any of the commands at all.
1196          * For example, the command interpreter might be run only with
1197          * disposition SCTP_DISPOSITION_CONSUME.
1198          */
1199         if (0 != (error = sctp_cmd_interpreter(event_type, subtype, state,
1200                                                ep, *asoc,
1201                                                event_arg, status,
1202                                                commands, gfp)))
1203                 goto bail;
1204
1205         switch (status) {
1206         case SCTP_DISPOSITION_DISCARD:
1207                 pr_debug("%s: ignored sctp protocol event - state:%d, "
1208                          "event_type:%d, event_id:%d\n", __func__, state,
1209                          event_type, subtype.chunk);
1210                 break;
1211
1212         case SCTP_DISPOSITION_NOMEM:
1213                 /* We ran out of memory, so we need to discard this
1214                  * packet.
1215                  */
1216                 /* BUG--we should now recover some memory, probably by
1217                  * reneging...
1218                  */
1219                 error = -ENOMEM;
1220                 break;
1221
1222         case SCTP_DISPOSITION_DELETE_TCB:
1223         case SCTP_DISPOSITION_ABORT:
1224                 /* This should now be a command. */
1225                 *asoc = NULL;
1226                 break;
1227
1228         case SCTP_DISPOSITION_CONSUME:
1229                 /*
1230                  * We should no longer have much work to do here as the
1231                  * real work has been done as explicit commands above.
1232                  */
1233                 break;
1234
1235         case SCTP_DISPOSITION_VIOLATION:
1236                 net_err_ratelimited("protocol violation state %d chunkid %d\n",
1237                                     state, subtype.chunk);
1238                 break;
1239
1240         case SCTP_DISPOSITION_NOT_IMPL:
1241                 pr_warn("unimplemented feature in state %d, event_type %d, event_id %d\n",
1242                         state, event_type, subtype.chunk);
1243                 break;
1244
1245         case SCTP_DISPOSITION_BUG:
1246                 pr_err("bug in state %d, event_type %d, event_id %d\n",
1247                        state, event_type, subtype.chunk);
1248                 BUG();
1249                 break;
1250
1251         default:
1252                 pr_err("impossible disposition %d in state %d, event_type %d, event_id %d\n",
1253                        status, state, event_type, subtype.chunk);
1254                 BUG();
1255                 break;
1256         }
1257
1258 bail:
1259         return error;
1260 }
1261
1262 /********************************************************************
1263  * 2nd Level Abstractions
1264  ********************************************************************/
1265
1266 /* This is the side-effect interpreter.  */
1267 static int sctp_cmd_interpreter(enum sctp_event_type event_type,
1268                                 union sctp_subtype subtype,
1269                                 enum sctp_state state,
1270                                 struct sctp_endpoint *ep,
1271                                 struct sctp_association *asoc,
1272                                 void *event_arg,
1273                                 enum sctp_disposition status,
1274                                 struct sctp_cmd_seq *commands,
1275                                 gfp_t gfp)
1276 {
1277         struct sctp_sock *sp = sctp_sk(ep->base.sk);
1278         struct sctp_chunk *chunk = NULL, *new_obj;
1279         struct sctp_packet *packet;
1280         struct sctp_sackhdr sackh;
1281         struct timer_list *timer;
1282         struct sctp_transport *t;
1283         unsigned long timeout;
1284         struct sctp_cmd *cmd;
1285         int local_cork = 0;
1286         int error = 0;
1287         int force;
1288
1289         if (SCTP_EVENT_T_TIMEOUT != event_type)
1290                 chunk = event_arg;
1291
1292         /* Note:  This whole file is a huge candidate for rework.
1293          * For example, each command could either have its own handler, so
1294          * the loop would look like:
1295          *     while (cmds)
1296          *         cmd->handle(x, y, z)
1297          * --jgrimm
1298          */
1299         while (NULL != (cmd = sctp_next_cmd(commands))) {
1300                 switch (cmd->verb) {
1301                 case SCTP_CMD_NOP:
1302                         /* Do nothing. */
1303                         break;
1304
1305                 case SCTP_CMD_NEW_ASOC:
1306                         /* Register a new association.  */
1307                         if (local_cork) {
1308                                 sctp_outq_uncork(&asoc->outqueue, gfp);
1309                                 local_cork = 0;
1310                         }
1311
1312                         /* Register with the endpoint.  */
1313                         asoc = cmd->obj.asoc;
1314                         BUG_ON(asoc->peer.primary_path == NULL);
1315                         sctp_endpoint_add_asoc(ep, asoc);
1316                         break;
1317
1318                 case SCTP_CMD_PURGE_OUTQUEUE:
1319                        sctp_outq_teardown(&asoc->outqueue);
1320                        break;
1321
1322                 case SCTP_CMD_DELETE_TCB:
1323                         if (local_cork) {
1324                                 sctp_outq_uncork(&asoc->outqueue, gfp);
1325                                 local_cork = 0;
1326                         }
1327                         /* Delete the current association.  */
1328                         sctp_cmd_delete_tcb(commands, asoc);
1329                         asoc = NULL;
1330                         break;
1331
1332                 case SCTP_CMD_NEW_STATE:
1333                         /* Enter a new state.  */
1334                         sctp_cmd_new_state(commands, asoc, cmd->obj.state);
1335                         break;
1336
1337                 case SCTP_CMD_REPORT_TSN:
1338                         /* Record the arrival of a TSN.  */
1339                         error = sctp_tsnmap_mark(&asoc->peer.tsn_map,
1340                                                  cmd->obj.u32, NULL);
1341                         break;
1342
1343                 case SCTP_CMD_REPORT_FWDTSN:
1344                         asoc->stream.si->report_ftsn(&asoc->ulpq, cmd->obj.u32);
1345                         break;
1346
1347                 case SCTP_CMD_PROCESS_FWDTSN:
1348                         asoc->stream.si->handle_ftsn(&asoc->ulpq,
1349                                                      cmd->obj.chunk);
1350                         break;
1351
1352                 case SCTP_CMD_GEN_SACK:
1353                         /* Generate a Selective ACK.
1354                          * The argument tells us whether to just count
1355                          * the packet and MAYBE generate a SACK, or
1356                          * force a SACK out.
1357                          */
1358                         force = cmd->obj.i32;
1359                         error = sctp_gen_sack(asoc, force, commands);
1360                         break;
1361
1362                 case SCTP_CMD_PROCESS_SACK:
1363                         /* Process an inbound SACK.  */
1364                         error = sctp_cmd_process_sack(commands, asoc,
1365                                                       cmd->obj.chunk);
1366                         break;
1367
1368                 case SCTP_CMD_GEN_INIT_ACK:
1369                         /* Generate an INIT ACK chunk.  */
1370                         new_obj = sctp_make_init_ack(asoc, chunk, GFP_ATOMIC,
1371                                                      0);
1372                         if (!new_obj) {
1373                                 error = -ENOMEM;
1374                                 break;
1375                         }
1376
1377                         sctp_add_cmd_sf(commands, SCTP_CMD_REPLY,
1378                                         SCTP_CHUNK(new_obj));
1379                         break;
1380
1381                 case SCTP_CMD_PEER_INIT:
1382                         /* Process a unified INIT from the peer.
1383                          * Note: Only used during INIT-ACK processing.  If
1384                          * there is an error just return to the outter
1385                          * layer which will bail.
1386                          */
1387                         error = sctp_cmd_process_init(commands, asoc, chunk,
1388                                                       cmd->obj.init, gfp);
1389                         break;
1390
1391                 case SCTP_CMD_GEN_COOKIE_ECHO:
1392                         /* Generate a COOKIE ECHO chunk.  */
1393                         new_obj = sctp_make_cookie_echo(asoc, chunk);
1394                         if (!new_obj) {
1395                                 if (cmd->obj.chunk)
1396                                         sctp_chunk_free(cmd->obj.chunk);
1397                                 error = -ENOMEM;
1398                                 break;
1399                         }
1400                         sctp_add_cmd_sf(commands, SCTP_CMD_REPLY,
1401                                         SCTP_CHUNK(new_obj));
1402
1403                         /* If there is an ERROR chunk to be sent along with
1404                          * the COOKIE_ECHO, send it, too.
1405                          */
1406                         if (cmd->obj.chunk)
1407                                 sctp_add_cmd_sf(commands, SCTP_CMD_REPLY,
1408                                                 SCTP_CHUNK(cmd->obj.chunk));
1409
1410                         if (new_obj->transport) {
1411                                 new_obj->transport->init_sent_count++;
1412                                 asoc->init_last_sent_to = new_obj->transport;
1413                         }
1414
1415                         /* FIXME - Eventually come up with a cleaner way to
1416                          * enabling COOKIE-ECHO + DATA bundling during
1417                          * multihoming stale cookie scenarios, the following
1418                          * command plays with asoc->peer.retran_path to
1419                          * avoid the problem of sending the COOKIE-ECHO and
1420                          * DATA in different paths, which could result
1421                          * in the association being ABORTed if the DATA chunk
1422                          * is processed first by the server.  Checking the
1423                          * init error counter simply causes this command
1424                          * to be executed only during failed attempts of
1425                          * association establishment.
1426                          */
1427                         if ((asoc->peer.retran_path !=
1428                              asoc->peer.primary_path) &&
1429                             (asoc->init_err_counter > 0)) {
1430                                 sctp_add_cmd_sf(commands,
1431                                                 SCTP_CMD_FORCE_PRIM_RETRAN,
1432                                                 SCTP_NULL());
1433                         }
1434
1435                         break;
1436
1437                 case SCTP_CMD_GEN_SHUTDOWN:
1438                         /* Generate SHUTDOWN when in SHUTDOWN_SENT state.
1439                          * Reset error counts.
1440                          */
1441                         asoc->overall_error_count = 0;
1442
1443                         /* Generate a SHUTDOWN chunk.  */
1444                         new_obj = sctp_make_shutdown(asoc, chunk);
1445                         if (!new_obj) {
1446                                 error = -ENOMEM;
1447                                 break;
1448                         }
1449                         sctp_add_cmd_sf(commands, SCTP_CMD_REPLY,
1450                                         SCTP_CHUNK(new_obj));
1451                         break;
1452
1453                 case SCTP_CMD_CHUNK_ULP:
1454                         /* Send a chunk to the sockets layer.  */
1455                         pr_debug("%s: sm_sideff: chunk_up:%p, ulpq:%p\n",
1456                                  __func__, cmd->obj.chunk, &asoc->ulpq);
1457
1458                         asoc->stream.si->ulpevent_data(&asoc->ulpq,
1459                                                        cmd->obj.chunk,
1460                                                        GFP_ATOMIC);
1461                         break;
1462
1463                 case SCTP_CMD_EVENT_ULP:
1464                         /* Send a notification to the sockets layer.  */
1465                         pr_debug("%s: sm_sideff: event_up:%p, ulpq:%p\n",
1466                                  __func__, cmd->obj.ulpevent, &asoc->ulpq);
1467
1468                         asoc->stream.si->enqueue_event(&asoc->ulpq,
1469                                                        cmd->obj.ulpevent);
1470                         break;
1471
1472                 case SCTP_CMD_REPLY:
1473                         /* If an caller has not already corked, do cork. */
1474                         if (!asoc->outqueue.cork) {
1475                                 sctp_outq_cork(&asoc->outqueue);
1476                                 local_cork = 1;
1477                         }
1478                         /* Send a chunk to our peer.  */
1479                         sctp_outq_tail(&asoc->outqueue, cmd->obj.chunk, gfp);
1480                         break;
1481
1482                 case SCTP_CMD_SEND_PKT:
1483                         /* Send a full packet to our peer.  */
1484                         packet = cmd->obj.packet;
1485                         sctp_packet_transmit(packet, gfp);
1486                         sctp_ootb_pkt_free(packet);
1487                         break;
1488
1489                 case SCTP_CMD_T1_RETRAN:
1490                         /* Mark a transport for retransmission.  */
1491                         sctp_retransmit(&asoc->outqueue, cmd->obj.transport,
1492                                         SCTP_RTXR_T1_RTX);
1493                         break;
1494
1495                 case SCTP_CMD_RETRAN:
1496                         /* Mark a transport for retransmission.  */
1497                         sctp_retransmit(&asoc->outqueue, cmd->obj.transport,
1498                                         SCTP_RTXR_T3_RTX);
1499                         break;
1500
1501                 case SCTP_CMD_ECN_CE:
1502                         /* Do delayed CE processing.   */
1503                         sctp_do_ecn_ce_work(asoc, cmd->obj.u32);
1504                         break;
1505
1506                 case SCTP_CMD_ECN_ECNE:
1507                         /* Do delayed ECNE processing. */
1508                         new_obj = sctp_do_ecn_ecne_work(asoc, cmd->obj.u32,
1509                                                         chunk);
1510                         if (new_obj)
1511                                 sctp_add_cmd_sf(commands, SCTP_CMD_REPLY,
1512                                                 SCTP_CHUNK(new_obj));
1513                         break;
1514
1515                 case SCTP_CMD_ECN_CWR:
1516                         /* Do delayed CWR processing.  */
1517                         sctp_do_ecn_cwr_work(asoc, cmd->obj.u32);
1518                         break;
1519
1520                 case SCTP_CMD_SETUP_T2:
1521                         sctp_cmd_setup_t2(commands, asoc, cmd->obj.chunk);
1522                         break;
1523
1524                 case SCTP_CMD_TIMER_START_ONCE:
1525                         timer = &asoc->timers[cmd->obj.to];
1526
1527                         if (timer_pending(timer))
1528                                 break;
1529                         fallthrough;
1530
1531                 case SCTP_CMD_TIMER_START:
1532                         timer = &asoc->timers[cmd->obj.to];
1533                         timeout = asoc->timeouts[cmd->obj.to];
1534                         BUG_ON(!timeout);
1535
1536                         /*
1537                          * SCTP has a hard time with timer starts.  Because we process
1538                          * timer starts as side effects, it can be hard to tell if we
1539                          * have already started a timer or not, which leads to BUG
1540                          * halts when we call add_timer. So here, instead of just starting
1541                          * a timer, if the timer is already started, and just mod
1542                          * the timer with the shorter of the two expiration times
1543                          */
1544                         if (!timer_pending(timer))
1545                                 sctp_association_hold(asoc);
1546                         timer_reduce(timer, jiffies + timeout);
1547                         break;
1548
1549                 case SCTP_CMD_TIMER_RESTART:
1550                         timer = &asoc->timers[cmd->obj.to];
1551                         timeout = asoc->timeouts[cmd->obj.to];
1552                         if (!mod_timer(timer, jiffies + timeout))
1553                                 sctp_association_hold(asoc);
1554                         break;
1555
1556                 case SCTP_CMD_TIMER_STOP:
1557                         timer = &asoc->timers[cmd->obj.to];
1558                         if (del_timer(timer))
1559                                 sctp_association_put(asoc);
1560                         break;
1561
1562                 case SCTP_CMD_INIT_CHOOSE_TRANSPORT:
1563                         chunk = cmd->obj.chunk;
1564                         t = sctp_assoc_choose_alter_transport(asoc,
1565                                                 asoc->init_last_sent_to);
1566                         asoc->init_last_sent_to = t;
1567                         chunk->transport = t;
1568                         t->init_sent_count++;
1569                         /* Set the new transport as primary */
1570                         sctp_assoc_set_primary(asoc, t);
1571                         break;
1572
1573                 case SCTP_CMD_INIT_RESTART:
1574                         /* Do the needed accounting and updates
1575                          * associated with restarting an initialization
1576                          * timer. Only multiply the timeout by two if
1577                          * all transports have been tried at the current
1578                          * timeout.
1579                          */
1580                         sctp_cmd_t1_timer_update(asoc,
1581                                                 SCTP_EVENT_TIMEOUT_T1_INIT,
1582                                                 "INIT");
1583
1584                         sctp_add_cmd_sf(commands, SCTP_CMD_TIMER_RESTART,
1585                                         SCTP_TO(SCTP_EVENT_TIMEOUT_T1_INIT));
1586                         break;
1587
1588                 case SCTP_CMD_COOKIEECHO_RESTART:
1589                         /* Do the needed accounting and updates
1590                          * associated with restarting an initialization
1591                          * timer. Only multiply the timeout by two if
1592                          * all transports have been tried at the current
1593                          * timeout.
1594                          */
1595                         sctp_cmd_t1_timer_update(asoc,
1596                                                 SCTP_EVENT_TIMEOUT_T1_COOKIE,
1597                                                 "COOKIE");
1598
1599                         /* If we've sent any data bundled with
1600                          * COOKIE-ECHO we need to resend.
1601                          */
1602                         list_for_each_entry(t, &asoc->peer.transport_addr_list,
1603                                         transports) {
1604                                 sctp_retransmit_mark(&asoc->outqueue, t,
1605                                             SCTP_RTXR_T1_RTX);
1606                         }
1607
1608                         sctp_add_cmd_sf(commands,
1609                                         SCTP_CMD_TIMER_RESTART,
1610                                         SCTP_TO(SCTP_EVENT_TIMEOUT_T1_COOKIE));
1611                         break;
1612
1613                 case SCTP_CMD_INIT_FAILED:
1614                         sctp_cmd_init_failed(commands, asoc, cmd->obj.u16);
1615                         break;
1616
1617                 case SCTP_CMD_ASSOC_FAILED:
1618                         sctp_cmd_assoc_failed(commands, asoc, event_type,
1619                                               subtype, chunk, cmd->obj.u16);
1620                         break;
1621
1622                 case SCTP_CMD_INIT_COUNTER_INC:
1623                         asoc->init_err_counter++;
1624                         break;
1625
1626                 case SCTP_CMD_INIT_COUNTER_RESET:
1627                         asoc->init_err_counter = 0;
1628                         asoc->init_cycle = 0;
1629                         list_for_each_entry(t, &asoc->peer.transport_addr_list,
1630                                             transports) {
1631                                 t->init_sent_count = 0;
1632                         }
1633                         break;
1634
1635                 case SCTP_CMD_REPORT_DUP:
1636                         sctp_tsnmap_mark_dup(&asoc->peer.tsn_map,
1637                                              cmd->obj.u32);
1638                         break;
1639
1640                 case SCTP_CMD_REPORT_BAD_TAG:
1641                         pr_debug("%s: vtag mismatch!\n", __func__);
1642                         break;
1643
1644                 case SCTP_CMD_STRIKE:
1645                         /* Mark one strike against a transport.  */
1646                         sctp_do_8_2_transport_strike(commands, asoc,
1647                                                     cmd->obj.transport, 0);
1648                         break;
1649
1650                 case SCTP_CMD_TRANSPORT_IDLE:
1651                         t = cmd->obj.transport;
1652                         sctp_transport_lower_cwnd(t, SCTP_LOWER_CWND_INACTIVE);
1653                         break;
1654
1655                 case SCTP_CMD_TRANSPORT_HB_SENT:
1656                         t = cmd->obj.transport;
1657                         sctp_do_8_2_transport_strike(commands, asoc,
1658                                                      t, 1);
1659                         t->hb_sent = 1;
1660                         break;
1661
1662                 case SCTP_CMD_TRANSPORT_ON:
1663                         t = cmd->obj.transport;
1664                         sctp_cmd_transport_on(commands, asoc, t, chunk);
1665                         break;
1666
1667                 case SCTP_CMD_HB_TIMERS_START:
1668                         sctp_cmd_hb_timers_start(commands, asoc);
1669                         break;
1670
1671                 case SCTP_CMD_HB_TIMER_UPDATE:
1672                         t = cmd->obj.transport;
1673                         sctp_transport_reset_hb_timer(t);
1674                         break;
1675
1676                 case SCTP_CMD_HB_TIMERS_STOP:
1677                         sctp_cmd_hb_timers_stop(commands, asoc);
1678                         break;
1679
1680                 case SCTP_CMD_PROBE_TIMER_UPDATE:
1681                         t = cmd->obj.transport;
1682                         sctp_transport_reset_probe_timer(t);
1683                         break;
1684
1685                 case SCTP_CMD_REPORT_ERROR:
1686                         error = cmd->obj.error;
1687                         break;
1688
1689                 case SCTP_CMD_PROCESS_CTSN:
1690                         /* Dummy up a SACK for processing. */
1691                         sackh.cum_tsn_ack = cmd->obj.be32;
1692                         sackh.a_rwnd = htonl(asoc->peer.rwnd +
1693                                              asoc->outqueue.outstanding_bytes);
1694                         sackh.num_gap_ack_blocks = 0;
1695                         sackh.num_dup_tsns = 0;
1696                         chunk->subh.sack_hdr = &sackh;
1697                         sctp_add_cmd_sf(commands, SCTP_CMD_PROCESS_SACK,
1698                                         SCTP_CHUNK(chunk));
1699                         break;
1700
1701                 case SCTP_CMD_DISCARD_PACKET:
1702                         /* We need to discard the whole packet.
1703                          * Uncork the queue since there might be
1704                          * responses pending
1705                          */
1706                         chunk->pdiscard = 1;
1707                         if (asoc) {
1708                                 sctp_outq_uncork(&asoc->outqueue, gfp);
1709                                 local_cork = 0;
1710                         }
1711                         break;
1712
1713                 case SCTP_CMD_RTO_PENDING:
1714                         t = cmd->obj.transport;
1715                         t->rto_pending = 1;
1716                         break;
1717
1718                 case SCTP_CMD_PART_DELIVER:
1719                         asoc->stream.si->start_pd(&asoc->ulpq, GFP_ATOMIC);
1720                         break;
1721
1722                 case SCTP_CMD_RENEGE:
1723                         asoc->stream.si->renege_events(&asoc->ulpq,
1724                                                        cmd->obj.chunk,
1725                                                        GFP_ATOMIC);
1726                         break;
1727
1728                 case SCTP_CMD_SETUP_T4:
1729                         sctp_cmd_setup_t4(commands, asoc, cmd->obj.chunk);
1730                         break;
1731
1732                 case SCTP_CMD_PROCESS_OPERR:
1733                         sctp_cmd_process_operr(commands, asoc, chunk);
1734                         break;
1735                 case SCTP_CMD_CLEAR_INIT_TAG:
1736                         asoc->peer.i.init_tag = 0;
1737                         break;
1738                 case SCTP_CMD_DEL_NON_PRIMARY:
1739                         sctp_cmd_del_non_primary(asoc);
1740                         break;
1741                 case SCTP_CMD_T3_RTX_TIMERS_STOP:
1742                         sctp_cmd_t3_rtx_timers_stop(commands, asoc);
1743                         break;
1744                 case SCTP_CMD_FORCE_PRIM_RETRAN:
1745                         t = asoc->peer.retran_path;
1746                         asoc->peer.retran_path = asoc->peer.primary_path;
1747                         sctp_outq_uncork(&asoc->outqueue, gfp);
1748                         local_cork = 0;
1749                         asoc->peer.retran_path = t;
1750                         break;
1751                 case SCTP_CMD_SET_SK_ERR:
1752                         sctp_cmd_set_sk_err(asoc, cmd->obj.error);
1753                         break;
1754                 case SCTP_CMD_ASSOC_CHANGE:
1755                         sctp_cmd_assoc_change(commands, asoc,
1756                                               cmd->obj.u8);
1757                         break;
1758                 case SCTP_CMD_ADAPTATION_IND:
1759                         sctp_cmd_adaptation_ind(commands, asoc);
1760                         break;
1761                 case SCTP_CMD_PEER_NO_AUTH:
1762                         sctp_cmd_peer_no_auth(commands, asoc);
1763                         break;
1764
1765                 case SCTP_CMD_ASSOC_SHKEY:
1766                         error = sctp_auth_asoc_init_active_key(asoc,
1767                                                 GFP_ATOMIC);
1768                         break;
1769                 case SCTP_CMD_UPDATE_INITTAG:
1770                         asoc->peer.i.init_tag = cmd->obj.u32;
1771                         break;
1772                 case SCTP_CMD_SEND_MSG:
1773                         if (!asoc->outqueue.cork) {
1774                                 sctp_outq_cork(&asoc->outqueue);
1775                                 local_cork = 1;
1776                         }
1777                         sctp_cmd_send_msg(asoc, cmd->obj.msg, gfp);
1778                         break;
1779                 case SCTP_CMD_PURGE_ASCONF_QUEUE:
1780                         sctp_asconf_queue_teardown(asoc);
1781                         break;
1782
1783                 case SCTP_CMD_SET_ASOC:
1784                         if (asoc && local_cork) {
1785                                 sctp_outq_uncork(&asoc->outqueue, gfp);
1786                                 local_cork = 0;
1787                         }
1788                         asoc = cmd->obj.asoc;
1789                         break;
1790
1791                 default:
1792                         pr_warn("Impossible command: %u\n",
1793                                 cmd->verb);
1794                         break;
1795                 }
1796
1797                 if (error) {
1798                         cmd = sctp_next_cmd(commands);
1799                         while (cmd) {
1800                                 if (cmd->verb == SCTP_CMD_REPLY)
1801                                         sctp_chunk_free(cmd->obj.chunk);
1802                                 cmd = sctp_next_cmd(commands);
1803                         }
1804                         break;
1805                 }
1806         }
1807
1808         /* If this is in response to a received chunk, wait until
1809          * we are done with the packet to open the queue so that we don't
1810          * send multiple packets in response to a single request.
1811          */
1812         if (asoc && SCTP_EVENT_T_CHUNK == event_type && chunk) {
1813                 if (chunk->end_of_packet || chunk->singleton)
1814                         sctp_outq_uncork(&asoc->outqueue, gfp);
1815         } else if (local_cork)
1816                 sctp_outq_uncork(&asoc->outqueue, gfp);
1817
1818         if (sp->data_ready_signalled)
1819                 sp->data_ready_signalled = 0;
1820
1821         return error;
1822 }