include/net/sctp/sm.h

   1 /* SCTP kernel reference Implementation
   2  * (C) Copyright IBM Corp. 2001, 2004
   3  * Copyright (c) 1999-2000 Cisco, Inc.
   4  * Copyright (c) 1999-2001 Motorola, Inc.
   5  * Copyright (c) 2001 Intel Corp.
   6  *
   7  * This file is part of the SCTP kernel reference Implementation
   8  *
   9  * These are definitions needed by the state machine.
  10  *
  11  * The SCTP reference implementation is free software;
  12  * you can redistribute it and/or modify it under the terms of
  13  * the GNU General Public License as published by
  14  * the Free Software Foundation; either version 2, or (at your option)
  15  * any later version.
  16  *
  17  * The SCTP reference implementation is distributed in the hope that it
  18  * will be useful, but WITHOUT ANY WARRANTY; without even the implied
  19  *                 ************************
  20  * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  21  * See the GNU General Public License for more details.
  22  *
  23  * You should have received a copy of the GNU General Public License
  24  * along with GNU CC; see the file COPYING.  If not, write to
  25  * the Free Software Foundation, 59 Temple Place - Suite 330,
  26  * Boston, MA 02111-1307, USA.
  27  *
  28  * Please send any bug reports or fixes you make to the
  29  * email addresses:
  30  *    lksctp developers <lksctp-developers@lists.sourceforge.net>
  31  *
  32  * Or submit a bug report through the following website:
  33  *    http://www.sf.net/projects/lksctp
  34  *
  35  * Written or modified by:
  36  *    La Monte H.P. Yarroll <piggy@acm.org>
  37  *    Karl Knutson <karl@athena.chicago.il.us>
  38  *    Xingang Guo <xingang.guo@intel.com>
  39  *    Jon Grimm <jgrimm@us.ibm.com>
  40  *    Dajiang Zhang <dajiang.zhang@nokia.com>
  41  *    Sridhar Samudrala <sri@us.ibm.com>
  42  *    Daisy Chang <daisyc@us.ibm.com>
  43  *    Ardelle Fan <ardelle.fan@intel.com>
  44  *    Kevin Gao <kevin.gao@intel.com>
  45  *
  46  * Any bugs reported given to us we will try to fix... any fixes shared will
  47  * be incorporated into the next SCTP release.
  48  */
  49
  50 #include <linux/types.h>
  51 #include <linux/compiler.h>
  52 #include <linux/slab.h>
  53 #include <linux/in.h>
  54 #include <net/sctp/command.h>
  55 #include <net/sctp/sctp.h>
  56
  57 #ifndef __sctp_sm_h__
  58 #define __sctp_sm_h__
  59
  60 /*
  61  * Possible values for the disposition are:
  62  */
  63 typedef enum {
  64         SCTP_DISPOSITION_DISCARD,        /* No further processing.  */
  65         SCTP_DISPOSITION_CONSUME,        /* Process return values normally.  */
  66         SCTP_DISPOSITION_NOMEM,          /* We ran out of memory--recover.  */
  67         SCTP_DISPOSITION_DELETE_TCB,     /* Close the association.  */
  68         SCTP_DISPOSITION_ABORT,          /* Close the association NOW.  */
  69         SCTP_DISPOSITION_VIOLATION,      /* The peer is misbehaving.  */
  70         SCTP_DISPOSITION_NOT_IMPL,       /* This entry is not implemented.  */
  71         SCTP_DISPOSITION_ERROR,          /* This is plain old user error.  */
  72         SCTP_DISPOSITION_BUG,            /* This is a bug.  */
  73 } sctp_disposition_t;
  74
  75 typedef struct {
  76         int name;
  77         int action;
  78 } sctp_sm_command_t;
  79
  80 typedef sctp_disposition_t (sctp_state_fn_t) (const struct sctp_endpoint *,
  81                                               const struct sctp_association *,
  82                                               const sctp_subtype_t type,
  83                                               void *arg,
  84                                               sctp_cmd_seq_t *);
  85 typedef void (sctp_timer_event_t) (unsigned long);
  86 typedef struct {
  87         sctp_state_fn_t *fn;
  88         const char *name;
  89 } sctp_sm_table_entry_t;
  90
  91 /* A naming convention of "sctp_sf_xxx" applies to all the state functions
  92  * currently in use.
  93  */
  94
  95 /* Prototypes for generic state functions. */
  96 sctp_state_fn_t sctp_sf_not_impl;
  97 sctp_state_fn_t sctp_sf_bug;
  98
  99 /* Prototypes for gener timer state functions. */
 100 sctp_state_fn_t sctp_sf_timer_ignore;
 101
 102 /* Prototypes for chunk state functions. */
 103 sctp_state_fn_t sctp_sf_do_9_1_abort;
 104 sctp_state_fn_t sctp_sf_cookie_wait_abort;
 105 sctp_state_fn_t sctp_sf_cookie_echoed_abort;
 106 sctp_state_fn_t sctp_sf_shutdown_pending_abort;
 107 sctp_state_fn_t sctp_sf_shutdown_sent_abort;
 108 sctp_state_fn_t sctp_sf_shutdown_ack_sent_abort;
 109 sctp_state_fn_t sctp_sf_do_5_1B_init;
 110 sctp_state_fn_t sctp_sf_do_5_1C_ack;
 111 sctp_state_fn_t sctp_sf_do_5_1D_ce;
 112 sctp_state_fn_t sctp_sf_do_5_1E_ca;
 113 sctp_state_fn_t sctp_sf_do_4_C;
 114 sctp_state_fn_t sctp_sf_eat_data_6_2;
 115 sctp_state_fn_t sctp_sf_eat_data_fast_4_4;
 116 sctp_state_fn_t sctp_sf_eat_sack_6_2;
 117 sctp_state_fn_t sctp_sf_tabort_8_4_8;
 118 sctp_state_fn_t sctp_sf_operr_notify;
 119 sctp_state_fn_t sctp_sf_t1_init_timer_expire;
 120 sctp_state_fn_t sctp_sf_t1_cookie_timer_expire;
 121 sctp_state_fn_t sctp_sf_t2_timer_expire;
 122 sctp_state_fn_t sctp_sf_t4_timer_expire;
 123 sctp_state_fn_t sctp_sf_t5_timer_expire;
 124 sctp_state_fn_t sctp_sf_sendbeat_8_3;
 125 sctp_state_fn_t sctp_sf_beat_8_3;
 126 sctp_state_fn_t sctp_sf_backbeat_8_3;
 127 sctp_state_fn_t sctp_sf_do_9_2_final;
 128 sctp_state_fn_t sctp_sf_do_9_2_shutdown;
 129 sctp_state_fn_t sctp_sf_do_ecn_cwr;
 130 sctp_state_fn_t sctp_sf_do_ecne;
 131 sctp_state_fn_t sctp_sf_ootb;
 132 sctp_state_fn_t sctp_sf_pdiscard;
 133 sctp_state_fn_t sctp_sf_violation;
 134 sctp_state_fn_t sctp_sf_violation_chunklen;
 135 sctp_state_fn_t sctp_sf_discard_chunk;
 136 sctp_state_fn_t sctp_sf_do_5_2_1_siminit;
 137 sctp_state_fn_t sctp_sf_do_5_2_2_dupinit;
 138 sctp_state_fn_t sctp_sf_do_5_2_4_dupcook;
 139 sctp_state_fn_t sctp_sf_unk_chunk;
 140 sctp_state_fn_t sctp_sf_do_8_5_1_E_sa;
 141 sctp_state_fn_t sctp_sf_cookie_echoed_err;
 142 sctp_state_fn_t sctp_sf_do_asconf;
 143 sctp_state_fn_t sctp_sf_do_asconf_ack;
 144 sctp_state_fn_t sctp_sf_do_9_2_reshutack;
 145 sctp_state_fn_t sctp_sf_eat_fwd_tsn;
 146 sctp_state_fn_t sctp_sf_eat_fwd_tsn_fast;
 147
 148 /* Prototypes for primitive event state functions.  */
 149 sctp_state_fn_t sctp_sf_do_prm_asoc;
 150 sctp_state_fn_t sctp_sf_do_prm_send;
 151 sctp_state_fn_t sctp_sf_do_9_2_prm_shutdown;
 152 sctp_state_fn_t sctp_sf_cookie_wait_prm_shutdown;
 153 sctp_state_fn_t sctp_sf_cookie_echoed_prm_shutdown;
 154 sctp_state_fn_t sctp_sf_do_9_1_prm_abort;
 155 sctp_state_fn_t sctp_sf_cookie_wait_prm_abort;
 156 sctp_state_fn_t sctp_sf_cookie_echoed_prm_abort;
 157 sctp_state_fn_t sctp_sf_shutdown_pending_prm_abort;
 158 sctp_state_fn_t sctp_sf_shutdown_sent_prm_abort;
 159 sctp_state_fn_t sctp_sf_shutdown_ack_sent_prm_abort;
 160 sctp_state_fn_t sctp_sf_error_closed;
 161 sctp_state_fn_t sctp_sf_error_shutdown;
 162 sctp_state_fn_t sctp_sf_ignore_primitive;
 163 sctp_state_fn_t sctp_sf_do_prm_requestheartbeat;
 164 sctp_state_fn_t sctp_sf_do_prm_asconf;
 165
 166 /* Prototypes for other event state functions.  */
 167 sctp_state_fn_t sctp_sf_do_9_2_start_shutdown;
 168 sctp_state_fn_t sctp_sf_do_9_2_shutdown_ack;
 169 sctp_state_fn_t sctp_sf_ignore_other;
 170 sctp_state_fn_t sctp_sf_cookie_wait_icmp_abort;
 171
 172 /* Prototypes for timeout event state functions.  */
 173 sctp_state_fn_t sctp_sf_do_6_3_3_rtx;
 174 sctp_state_fn_t sctp_sf_do_6_2_sack;
 175 sctp_state_fn_t sctp_sf_autoclose_timer_expire;
 176
 177 /* Prototypes for utility support functions.  */
 178 __u8 sctp_get_chunk_type(struct sctp_chunk *chunk);
 179 const sctp_sm_table_entry_t *sctp_sm_lookup_event(sctp_event_t,
 180                                             sctp_state_t,
 181                                             sctp_subtype_t);
 182 int sctp_chunk_iif(const struct sctp_chunk *);
 183 struct sctp_association *sctp_make_temp_asoc(const struct sctp_endpoint *,
 184                                              struct sctp_chunk *,
 185                                              int gfp);
 186 __u32 sctp_generate_verification_tag(void);
 187 void sctp_populate_tie_tags(__u8 *cookie, __u32 curTag, __u32 hisTag);
 188
 189 /* Prototypes for chunk-building functions.  */
 190 struct sctp_chunk *sctp_make_init(const struct sctp_association *,
 191                              const struct sctp_bind_addr *,
 192                              int gfp, int vparam_len);
 193 struct sctp_chunk *sctp_make_init_ack(const struct sctp_association *,
 194                                  const struct sctp_chunk *,
 195                                  const int gfp,
 196                                  const int unkparam_len);
 197 struct sctp_chunk *sctp_make_cookie_echo(const struct sctp_association *,
 198                                     const struct sctp_chunk *);
 199 struct sctp_chunk *sctp_make_cookie_ack(const struct sctp_association *,
 200                                    const struct sctp_chunk *);
 201 struct sctp_chunk *sctp_make_cwr(const struct sctp_association *,
 202                                  const __u32 lowest_tsn,
 203                                  const struct sctp_chunk *);
 204 struct sctp_chunk * sctp_make_datafrag_empty(struct sctp_association *,
 205                                         const struct sctp_sndrcvinfo *sinfo,
 206                                         int len, const __u8 flags,
 207                                         __u16 ssn);
 208 struct sctp_chunk *sctp_make_ecne(const struct sctp_association *,
 209                                   const __u32);
 210 struct sctp_chunk *sctp_make_sack(const struct sctp_association *);
 211 struct sctp_chunk *sctp_make_shutdown(const struct sctp_association *asoc,
 212                                       const struct sctp_chunk *chunk);
 213 struct sctp_chunk *sctp_make_shutdown_ack(const struct sctp_association *asoc,
 214                                           const struct sctp_chunk *);
 215 struct sctp_chunk *sctp_make_shutdown_complete(const struct sctp_association *,
 216                                           const struct sctp_chunk *);
 217 void sctp_init_cause(struct sctp_chunk *, __u16 cause, const void *, size_t);
 218 struct sctp_chunk *sctp_make_abort(const struct sctp_association *,
 219                               const struct sctp_chunk *,
 220                               const size_t hint);
 221 struct sctp_chunk *sctp_make_abort_no_data(const struct sctp_association *,
 222                                       const struct sctp_chunk *,
 223                                       __u32 tsn);
 224 struct sctp_chunk *sctp_make_abort_user(const struct sctp_association *,
 225                                    const struct sctp_chunk *,
 226                                    const struct msghdr *);
 227 struct sctp_chunk *sctp_make_abort_violation(const struct sctp_association *,
 228                                    const struct sctp_chunk *,
 229                                    const __u8 *,
 230                                    const size_t );
 231 struct sctp_chunk *sctp_make_heartbeat(const struct sctp_association *,
 232                                   const struct sctp_transport *,
 233                                   const void *payload,
 234                                   const size_t paylen);
 235 struct sctp_chunk *sctp_make_heartbeat_ack(const struct sctp_association *,
 236                                       const struct sctp_chunk *,
 237                                       const void *payload,
 238                                       const size_t paylen);
 239 struct sctp_chunk *sctp_make_op_error(const struct sctp_association *,
 240                                  const struct sctp_chunk *chunk,
 241                                  __u16 cause_code,
 242                                  const void *payload,
 243                                  size_t paylen);
 244
 245 struct sctp_chunk *sctp_make_asconf_update_ip(struct sctp_association *,
 246                                               union sctp_addr *,
 247                                               struct sockaddr *,
 248                                               int, __u16);
 249 struct sctp_chunk *sctp_make_asconf_set_prim(struct sctp_association *asoc,
 250                                              union sctp_addr *addr);
 251 struct sctp_chunk *sctp_process_asconf(struct sctp_association *asoc,
 252                                        struct sctp_chunk *asconf);
 253 int sctp_process_asconf_ack(struct sctp_association *asoc,
 254                             struct sctp_chunk *asconf_ack);
 255 struct sctp_chunk *sctp_make_fwdtsn(const struct sctp_association *asoc,
 256                                     __u32 new_cum_tsn, size_t nstreams,
 257                                     struct sctp_fwdtsn_skip *skiplist);
 258
 259 void sctp_chunk_assign_tsn(struct sctp_chunk *);
 260 void sctp_chunk_assign_ssn(struct sctp_chunk *);
 261
 262 sctp_disposition_t  sctp_stop_t1_and_abort(sctp_cmd_seq_t *commands,
 263                                            __u16 error,
 264                                            const struct sctp_association *asoc,
 265                                            struct sctp_transport *transport);
 266
 267 /* Prototypes for statetable processing. */
 268
 269 int sctp_do_sm(sctp_event_t event_type, sctp_subtype_t subtype,
 270                sctp_state_t state,
 271                struct sctp_endpoint *,
 272                struct sctp_association *asoc,
 273                void *event_arg,
 274                int gfp);
 275
 276 /* 2nd level prototypes */
 277 void sctp_generate_t3_rtx_event(unsigned long peer);
 278 void sctp_generate_heartbeat_event(unsigned long peer);
 279
 280 void sctp_ootb_pkt_free(struct sctp_packet *);
 281
 282 struct sctp_association *sctp_unpack_cookie(const struct sctp_endpoint *,
 283                                        const struct sctp_association *,
 284                                        struct sctp_chunk *, int gfp, int *err,
 285                                        struct sctp_chunk **err_chk_p);
 286 int sctp_addip_addr_config(struct sctp_association *, sctp_param_t,
 287                            struct sockaddr_storage*, int);
 288
 289 /* 3rd level prototypes */
 290 __u32 sctp_generate_tag(const struct sctp_endpoint *);
 291 __u32 sctp_generate_tsn(const struct sctp_endpoint *);
 292
 293 /* Extern declarations for major data structures.  */
 294 extern sctp_timer_event_t *sctp_timer_events[SCTP_NUM_TIMEOUT_TYPES];
 295
 296
 297 /* Get the size of a DATA chunk payload. */
 298 static inline __u16 sctp_data_size(struct sctp_chunk *chunk)
 299 {
 300         __u16 size;
 301
 302         size = ntohs(chunk->chunk_hdr->length);
 303         size -= sizeof(sctp_data_chunk_t);
 304
 305         return size;
 306 }
 307
 308 /* Compare two TSNs */
 309
 310 /* RFC 1982 - Serial Number Arithmetic
 311  *
 312  * 2. Comparison
 313  *  Then, s1 is said to be equal to s2 if and only if i1 is equal to i2,
 314  *  in all other cases, s1 is not equal to s2.
 315  *
 316  * s1 is said to be less than s2 if, and only if, s1 is not equal to s2,
 317  * and
 318  *
 319  *      (i1 < i2 and i2 - i1 < 2^(SERIAL_BITS - 1)) or
 320  *      (i1 > i2 and i1 - i2 > 2^(SERIAL_BITS - 1))
 321  *
 322  * s1 is said to be greater than s2 if, and only if, s1 is not equal to
 323  * s2, and
 324  *
 325  *      (i1 < i2 and i2 - i1 > 2^(SERIAL_BITS - 1)) or
 326  *      (i1 > i2 and i1 - i2 < 2^(SERIAL_BITS - 1))
 327  */
 328
 329 /*
 330  * RFC 2960
 331  *  1.6 Serial Number Arithmetic
 332  *
 333  * Comparisons and arithmetic on TSNs in this document SHOULD use Serial
 334  * Number Arithmetic as defined in [RFC1982] where SERIAL_BITS = 32.
 335  */
 336
 337 enum {
 338         TSN_SIGN_BIT = (1<<31)
 339 };
 340
 341 static inline int TSN_lt(__u32 s, __u32 t)
 342 {
 343         return (((s) - (t)) & TSN_SIGN_BIT);
 344 }
 345
 346 static inline int TSN_lte(__u32 s, __u32 t)
 347 {
 348         return (((s) == (t)) || (((s) - (t)) & TSN_SIGN_BIT));
 349 }
 350
 351 /* Compare two SSNs */
 352
 353 /*
 354  * RFC 2960
 355  *  1.6 Serial Number Arithmetic
 356  *
 357  * Comparisons and arithmetic on Stream Sequence Numbers in this document
 358  * SHOULD use Serial Number Arithmetic as defined in [RFC1982] where
 359  * SERIAL_BITS = 16.
 360  */
 361 enum {
 362         SSN_SIGN_BIT = (1<<15)
 363 };
 364
 365 static inline int SSN_lt(__u16 s, __u16 t)
 366 {
 367         return (((s) - (t)) & SSN_SIGN_BIT);
 368 }
 369
 370 static inline int SSN_lte(__u16 s, __u16 t)
 371 {
 372         return (((s) == (t)) || (((s) - (t)) & SSN_SIGN_BIT));
 373 }
 374
 375 /*
 376  * ADDIP 3.1.1
 377  * The valid range of Serial Number is from 0 to 4294967295 (2**32 - 1). Serial
 378  * Numbers wrap back to 0 after reaching 4294967295.
 379  */
 380 enum {
 381         ADDIP_SERIAL_SIGN_BIT = (1<<31)
 382 };
 383
 384 static inline int ADDIP_SERIAL_gte(__u16 s, __u16 t)
 385 {
 386         return (((s) == (t)) || (((t) - (s)) & ADDIP_SERIAL_SIGN_BIT));
 387 }
 388
 389
 390 /* Run sctp_add_cmd() generating a BUG() if there is a failure.  */
 391 static inline void sctp_add_cmd_sf(sctp_cmd_seq_t *seq, sctp_verb_t verb, sctp_arg_t obj)
 392 {
 393         if (unlikely(!sctp_add_cmd(seq, verb, obj)))
 394                 BUG();
 395 }
 396
 397 /* Check VTAG of the packet matches the sender's own tag. */
 398 static inline int
 399 sctp_vtag_verify(const struct sctp_chunk *chunk,
 400                  const struct sctp_association *asoc)
 401 {
 402         /* RFC 2960 Sec 8.5 When receiving an SCTP packet, the endpoint
 403          * MUST ensure that the value in the Verification Tag field of
 404          * the received SCTP packet matches its own Tag. If the received
 405          * Verification Tag value does not match the receiver's own
 406          * tag value, the receiver shall silently discard the packet...
 407          */
 408         if (ntohl(chunk->sctp_hdr->vtag) == asoc->c.my_vtag)
 409                 return 1;
 410
 411         return 0;
 412 }
 413
 414 /* Check VTAG of the packet matches the sender's own tag and the T bit is
 415  * not set, OR its peer's tag and the T bit is set in the Chunk Flags.
 416  */
 417 static inline int
 418 sctp_vtag_verify_either(const struct sctp_chunk *chunk,
 419                         const struct sctp_association *asoc)
 420 {
 421         /* RFC 2960 Section 8.5.1, sctpimpguide Section 2.41
 422          *
 423          * B) The receiver of a ABORT MUST accept the packet
 424          *    if the Verification Tag field of the packet matches its own tag
 425          *    and the T bit is not set
 426          *    OR
 427          *    it is set to its peer's tag and the T bit is set in the Chunk
 428          *    Flags.
 429          *    Otherwise, the receiver MUST silently discard the packet
 430          *    and take no further action.
 431          *
 432          * C) The receiver of a SHUTDOWN COMPLETE shall accept the packet
 433          *    if the Verification Tag field of the packet matches its own tag
 434          *    and the T bit is not set
 435          *    OR
 436          *    it is set to its peer's tag and the T bit is set in the Chunk
 437          *    Flags.
 438          *    Otherwise, the receiver MUST silently discard the packet
 439          *    and take no further action.  An endpoint MUST ignore the
 440          *    SHUTDOWN COMPLETE if it is not in the SHUTDOWN-ACK-SENT state.
 441          */
 442         if ((!sctp_test_T_bit(chunk) &&
 443              (ntohl(chunk->sctp_hdr->vtag) == asoc->c.my_vtag)) ||
 444             (sctp_test_T_bit(chunk) &&
 445              (ntohl(chunk->sctp_hdr->vtag) == asoc->c.peer_vtag))) {
 446                 return 1;
 447         }
 448
 449         return 0;
 450 }
 451
 452 #endif /* __sctp_sm_h__ */