include/net/sctp/sm.h

   1 /* SCTP kernel reference Implementation
   2  * Copyright (c) 1999-2000 Cisco, Inc.
   3  * Copyright (c) 1999-2001 Motorola, Inc.
   4  * Copyright (c) 2001 Intel Corp.
   5  * Copyright (c) 2001-2002 International Business Machines 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  *
  45  * Any bugs reported given to us we will try to fix... any fixes shared will
  46  * be incorporated into the next SCTP release.
  47  */
  48
  49 #include <linux/types.h>
  50 #include <linux/compiler.h>
  51 #include <linux/slab.h>
  52 #include <linux/in.h>
  53 #include <net/sctp/command.h>
  54 #include <net/sctp/sctp.h>
  55
  56 #ifndef __sctp_sm_h__
  57 #define __sctp_sm_h__
  58
  59 /*
  60  * Possible values for the disposition are:
  61  */
  62 typedef enum {
  63         SCTP_DISPOSITION_DISCARD,        /* No further processing.  */
  64         SCTP_DISPOSITION_CONSUME,        /* Process return values normally.  */
  65         SCTP_DISPOSITION_NOMEM,          /* We ran out of memory--recover.  */
  66         SCTP_DISPOSITION_DELETE_TCB,     /* Close the association.  */
  67         SCTP_DISPOSITION_ABORT,          /* Close the association NOW.  */
  68         SCTP_DISPOSITION_VIOLATION,      /* The peer is misbehaving.  */
  69         SCTP_DISPOSITION_NOT_IMPL,       /* This entry is not implemented.  */
  70         SCTP_DISPOSITION_ERROR,          /* This is plain old user error.  */
  71         SCTP_DISPOSITION_BUG,            /* This is a bug.  */
  72 } sctp_disposition_t;
  73
  74 typedef struct {
  75         int name;
  76         int action;
  77 } sctp_sm_command_t;
  78
  79 typedef sctp_disposition_t (sctp_state_fn_t) (const struct sctp_endpoint *,
  80                                               const struct sctp_association *,
  81                                               const sctp_subtype_t type,
  82                                               void *arg,
  83                                               sctp_cmd_seq_t *);
  84 typedef void (sctp_timer_event_t) (unsigned long);
  85 typedef struct {
  86         sctp_state_fn_t *fn;
  87         const char *name;
  88 } sctp_sm_table_entry_t;
  89
  90 /* A naming convention of "sctp_sf_xxx" applies to all the state functions
  91  * currently in use.
  92  */
  93
  94 /* Prototypes for generic state functions. */
  95 sctp_state_fn_t sctp_sf_not_impl;
  96 sctp_state_fn_t sctp_sf_bug;
  97
  98 /* Prototypes for gener timer state functions. */
  99 sctp_state_fn_t sctp_sf_timer_ignore;
 100
 101 /* Prototypes for chunk state functions. */
 102 sctp_state_fn_t sctp_sf_do_9_1_abort;
 103 sctp_state_fn_t sctp_sf_cookie_wait_abort;
 104 sctp_state_fn_t sctp_sf_cookie_echoed_abort;
 105 sctp_state_fn_t sctp_sf_shutdown_pending_abort;
 106 sctp_state_fn_t sctp_sf_shutdown_sent_abort;
 107 sctp_state_fn_t sctp_sf_shutdown_ack_sent_abort;
 108 sctp_state_fn_t sctp_sf_do_5_1B_init;
 109 sctp_state_fn_t sctp_sf_do_5_1C_ack;
 110 sctp_state_fn_t sctp_sf_do_5_1D_ce;
 111 sctp_state_fn_t sctp_sf_do_5_1E_ca;
 112 sctp_state_fn_t sctp_sf_do_4_C;
 113 sctp_state_fn_t sctp_sf_eat_data_6_2;
 114 sctp_state_fn_t sctp_sf_eat_data_fast_4_4;
 115 sctp_state_fn_t sctp_sf_eat_sack_6_2;
 116 sctp_state_fn_t sctp_sf_tabort_8_4_8;
 117 sctp_state_fn_t sctp_sf_operr_notify;
 118 sctp_state_fn_t sctp_sf_t1_timer_expire;
 119 sctp_state_fn_t sctp_sf_t2_timer_expire;
 120 sctp_state_fn_t sctp_sf_t5_timer_expire;
 121 sctp_state_fn_t sctp_sf_sendbeat_8_3;
 122 sctp_state_fn_t sctp_sf_beat_8_3;
 123 sctp_state_fn_t sctp_sf_backbeat_8_3;
 124 sctp_state_fn_t sctp_sf_do_9_2_final;
 125 sctp_state_fn_t sctp_sf_do_9_2_shutdown;
 126 sctp_state_fn_t sctp_sf_do_ecn_cwr;
 127 sctp_state_fn_t sctp_sf_do_ecne;
 128 sctp_state_fn_t sctp_sf_ootb;
 129 sctp_state_fn_t sctp_sf_shut_8_4_5;
 130 sctp_state_fn_t sctp_sf_pdiscard;
 131 sctp_state_fn_t sctp_sf_violation;
 132 sctp_state_fn_t sctp_sf_discard_chunk;
 133 sctp_state_fn_t sctp_sf_do_5_2_1_siminit;
 134 sctp_state_fn_t sctp_sf_do_5_2_2_dupinit;
 135 sctp_state_fn_t sctp_sf_do_5_2_4_dupcook;
 136 sctp_state_fn_t sctp_sf_unk_chunk;
 137 sctp_state_fn_t sctp_sf_do_8_5_1_E_sa;
 138 sctp_state_fn_t sctp_sf_cookie_echoed_err;
 139 sctp_state_fn_t sctp_sf_do_5_2_6_stale;
 140
 141 /* Prototypes for primitive event state functions.  */
 142 sctp_state_fn_t sctp_sf_do_prm_asoc;
 143 sctp_state_fn_t sctp_sf_do_prm_send;
 144 sctp_state_fn_t sctp_sf_do_9_2_prm_shutdown;
 145 sctp_state_fn_t sctp_sf_cookie_wait_prm_shutdown;
 146 sctp_state_fn_t sctp_sf_cookie_echoed_prm_shutdown;
 147 sctp_state_fn_t sctp_sf_do_9_1_prm_abort;
 148 sctp_state_fn_t sctp_sf_cookie_wait_prm_abort;
 149 sctp_state_fn_t sctp_sf_cookie_echoed_prm_abort;
 150 sctp_state_fn_t sctp_sf_shutdown_pending_prm_abort;
 151 sctp_state_fn_t sctp_sf_shutdown_sent_prm_abort;
 152 sctp_state_fn_t sctp_sf_shutdown_ack_sent_prm_abort;
 153 sctp_state_fn_t sctp_sf_error_closed;
 154 sctp_state_fn_t sctp_sf_error_shutdown;
 155 sctp_state_fn_t sctp_sf_ignore_primitive;
 156 sctp_state_fn_t sctp_sf_do_prm_requestheartbeat;
 157
 158 /* Prototypes for other event state functions.  */
 159 sctp_state_fn_t sctp_sf_do_9_2_start_shutdown;
 160 sctp_state_fn_t sctp_sf_do_9_2_shutdown_ack;
 161 sctp_state_fn_t sctp_sf_ignore_other;
 162
 163 /* Prototypes for timeout event state functions.  */
 164 sctp_state_fn_t sctp_sf_do_6_3_3_rtx;
 165 sctp_state_fn_t sctp_sf_do_6_2_sack;
 166 sctp_state_fn_t sctp_sf_autoclose_timer_expire;
 167
 168
 169 /* These are state functions which are either obsolete or not in use yet.
 170  * If any of these functions needs to be revived, it should be renamed with
 171  * the "sctp_sf_xxx" prefix, and be moved to the above prototype groups.
 172  */
 173
 174 /* Prototypes for chunk state functions.  Not in use. */
 175 sctp_state_fn_t sctp_sf_do_9_2_reshutack;
 176 sctp_state_fn_t sctp_sf_do_9_2_reshut;
 177 sctp_state_fn_t sctp_sf_do_9_2_shutack;
 178
 179 /* Prototypes for timeout event state functions.  Not in use. */
 180 sctp_state_fn_t sctp_do_4_2_reinit;
 181 sctp_state_fn_t sctp_do_4_3_reecho;
 182 sctp_state_fn_t sctp_do_9_2_reshut;
 183 sctp_state_fn_t sctp_do_9_2_reshutack;
 184 sctp_state_fn_t sctp_do_8_3_hb_err;
 185 sctp_state_fn_t sctp_heartoff;
 186
 187 /* Prototypes for addip related state functions.  Not in use. */
 188 sctp_state_fn_t sctp_addip_do_asconf;
 189 sctp_state_fn_t sctp_addip_do_asconf_ack;
 190
 191 /* Prototypes for utility support functions.  */
 192 __u8 sctp_get_chunk_type(struct sctp_chunk *chunk);
 193 const sctp_sm_table_entry_t *sctp_sm_lookup_event(sctp_event_t,
 194                                             sctp_state_t,
 195                                             sctp_subtype_t);
 196 int sctp_chunk_iif(const struct sctp_chunk *);
 197 struct sctp_association *sctp_make_temp_asoc(const struct sctp_endpoint *,
 198                                              struct sctp_chunk *,
 199                                              int gfp);
 200 __u32 sctp_generate_verification_tag(void);
 201 void sctp_populate_tie_tags(__u8 *cookie, __u32 curTag, __u32 hisTag);
 202
 203 /* Prototypes for chunk-building functions.  */
 204 struct sctp_chunk *sctp_make_init(const struct sctp_association *,
 205                              const struct sctp_bind_addr *,
 206                              int gfp, int vparam_len);
 207 struct sctp_chunk *sctp_make_init_ack(const struct sctp_association *,
 208                                  const struct sctp_chunk *,
 209                                  const int gfp,
 210                                  const int unkparam_len);
 211 struct sctp_chunk *sctp_make_cookie_echo(const struct sctp_association *,
 212                                     const struct sctp_chunk *);
 213 struct sctp_chunk *sctp_make_cookie_ack(const struct sctp_association *,
 214                                    const struct sctp_chunk *);
 215 struct sctp_chunk *sctp_make_cwr(const struct sctp_association *,
 216                                  const __u32 lowest_tsn,
 217                                  const struct sctp_chunk *);
 218 struct sctp_chunk *sctp_make_datafrag(struct sctp_association *,
 219                                  const struct sctp_sndrcvinfo *sinfo,
 220                                  int len, const __u8 *data,
 221                                  __u8 flags, __u16 ssn);
 222 struct sctp_chunk * sctp_make_datafrag_empty(struct sctp_association *,
 223                                         const struct sctp_sndrcvinfo *sinfo,
 224                                         int len, const __u8 flags,
 225                                         __u16 ssn);
 226 struct sctp_chunk *sctp_make_data(struct sctp_association *,
 227                              const struct sctp_sndrcvinfo *sinfo,
 228                              int len, const __u8 *data);
 229 struct sctp_chunk *sctp_make_data_empty(struct sctp_association *,
 230                                    const struct sctp_sndrcvinfo *, int len);
 231 struct sctp_chunk *sctp_make_ecne(const struct sctp_association *,
 232                                   const __u32);
 233 struct sctp_chunk *sctp_make_sack(const struct sctp_association *);
 234 struct sctp_chunk *sctp_make_shutdown(const struct sctp_association *asoc,
 235                                       const struct sctp_chunk *chunk);
 236 struct sctp_chunk *sctp_make_shutdown_ack(const struct sctp_association *asoc,
 237                                           const struct sctp_chunk *);
 238 struct sctp_chunk *sctp_make_shutdown_complete(const struct sctp_association *,
 239                                           const struct sctp_chunk *);
 240 void sctp_init_cause(struct sctp_chunk *, __u16 cause, const void *, size_t);
 241 struct sctp_chunk *sctp_make_abort(const struct sctp_association *,
 242                               const struct sctp_chunk *,
 243                               const size_t hint);
 244 struct sctp_chunk *sctp_make_abort_no_data(const struct sctp_association *,
 245                                       const struct sctp_chunk *,
 246                                       __u32 tsn);
 247 struct sctp_chunk *sctp_make_abort_user(const struct sctp_association *,
 248                                    const struct sctp_chunk *,
 249                                    const struct msghdr *);
 250 struct sctp_chunk *sctp_make_heartbeat(const struct sctp_association *,
 251                                   const struct sctp_transport *,
 252                                   const void *payload,
 253                                   const size_t paylen);
 254 struct sctp_chunk *sctp_make_heartbeat_ack(const struct sctp_association *,
 255                                       const struct sctp_chunk *,
 256                                       const void *payload,
 257                                       const size_t paylen);
 258 struct sctp_chunk *sctp_make_op_error(const struct sctp_association *,
 259                                  const struct sctp_chunk *chunk,
 260                                  __u16 cause_code,
 261                                  const void *payload,
 262                                  size_t paylen);
 263 void sctp_chunk_assign_tsn(struct sctp_chunk *);
 264 void sctp_chunk_assign_ssn(struct sctp_chunk *);
 265
 266 /* Prototypes for statetable processing. */
 267
 268 int sctp_do_sm(sctp_event_t event_type, sctp_subtype_t subtype,
 269                sctp_state_t state,
 270                struct sctp_endpoint *,
 271                struct sctp_association *asoc,
 272                void *event_arg,
 273                int gfp);
 274
 275 int sctp_side_effects(sctp_event_t event_type, sctp_subtype_t subtype,
 276                       sctp_state_t state,
 277                       struct sctp_endpoint *,
 278                       struct sctp_association *asoc,
 279                       void *event_arg,
 280                       sctp_disposition_t status,
 281                       sctp_cmd_seq_t *commands,
 282                       int gfp);
 283
 284 /* 2nd level prototypes */
 285 int sctp_cmd_interpreter(sctp_event_t, sctp_subtype_t, sctp_state_t,
 286                          struct sctp_endpoint *, struct sctp_association *,
 287                          void *event_arg, sctp_disposition_t,
 288                          sctp_cmd_seq_t *retval, int gfp);
 289
 290
 291 int sctp_gen_sack(struct sctp_association *, int force, sctp_cmd_seq_t *);
 292 void sctp_generate_t3_rtx_event(unsigned long peer);
 293 void sctp_generate_heartbeat_event(unsigned long peer);
 294
 295 sctp_sackhdr_t *sctp_sm_pull_sack(struct sctp_chunk *);
 296 struct sctp_packet *sctp_abort_pkt_new(const struct sctp_endpoint *,
 297                                        const struct sctp_association *,
 298                                        struct sctp_chunk *chunk,
 299                                        const void *payload,
 300                                        size_t paylen);
 301 struct sctp_packet *sctp_ootb_pkt_new(const struct sctp_association *,
 302                                       const struct sctp_chunk *);
 303 void sctp_ootb_pkt_free(struct sctp_packet *);
 304
 305 struct sctp_cookie_param *
 306 sctp_pack_cookie(const struct sctp_endpoint *, const struct sctp_association *,
 307                  const struct sctp_chunk *, int *cookie_len,
 308                  const __u8 *, int addrs_len);
 309 struct sctp_association *sctp_unpack_cookie(const struct sctp_endpoint *,
 310                                        const struct sctp_association *,
 311                                        struct sctp_chunk *, int gfp, int *err,
 312                                        struct sctp_chunk **err_chk_p);
 313 int sctp_addip_addr_config(struct sctp_association *, sctp_param_t,
 314                            struct sockaddr_storage*, int);
 315 void sctp_send_stale_cookie_err(const struct sctp_endpoint *ep,
 316                                 const struct sctp_association *asoc,
 317                                 const struct sctp_chunk *chunk,
 318                                 sctp_cmd_seq_t *commands,
 319                                 struct sctp_chunk *err_chunk);
 320
 321 /* 3rd level prototypes */
 322 __u32 sctp_generate_tag(const struct sctp_endpoint *);
 323 __u32 sctp_generate_tsn(const struct sctp_endpoint *);
 324
 325 /* 4th level prototypes */
 326 void sctp_param2sockaddr(union sctp_addr *addr, union sctp_addr_param *,
 327                          __u16 port, int iif);
 328 int sctp_addr2sockaddr(const union sctp_params, union sctp_addr *);
 329 int sockaddr2sctp_addr(const union sctp_addr *, union sctp_addr_param *);
 330
 331 /* Extern declarations for major data structures.  */
 332 const sctp_sm_table_entry_t *sctp_chunk_event_lookup(sctp_cid_t, sctp_state_t);
 333 extern const sctp_sm_table_entry_t
 334 primitive_event_table[SCTP_NUM_PRIMITIVE_TYPES][SCTP_STATE_NUM_STATES];
 335 extern const sctp_sm_table_entry_t
 336 other_event_table[SCTP_NUM_OTHER_TYPES][SCTP_STATE_NUM_STATES];
 337 extern const sctp_sm_table_entry_t
 338 timeout_event_table[SCTP_NUM_TIMEOUT_TYPES][SCTP_STATE_NUM_STATES];
 339 extern sctp_timer_event_t *sctp_timer_events[SCTP_NUM_TIMEOUT_TYPES];
 340
 341 /* These are some handy utility macros... */
 342
 343
 344 /* Get the size of a DATA chunk payload. */
 345 static inline __u16 sctp_data_size(struct sctp_chunk *chunk)
 346 {
 347         __u16 size;
 348
 349         size = ntohs(chunk->chunk_hdr->length);
 350         size -= sizeof(sctp_data_chunk_t);
 351
 352         return size;
 353 }
 354
 355 /* Compare two TSNs */
 356
 357 /* RFC 1982 - Serial Number Arithmetic
 358  *
 359  * 2. Comparison
 360  *  Then, s1 is said to be equal to s2 if and only if i1 is equal to i2,
 361  *  in all other cases, s1 is not equal to s2.
 362  *
 363  * s1 is said to be less than s2 if, and only if, s1 is not equal to s2,
 364  * and
 365  *
 366  *      (i1 < i2 and i2 - i1 < 2^(SERIAL_BITS - 1)) or
 367  *      (i1 > i2 and i1 - i2 > 2^(SERIAL_BITS - 1))
 368  *
 369  * s1 is said to be greater than s2 if, and only if, s1 is not equal to
 370  * s2, and
 371  *
 372  *      (i1 < i2 and i2 - i1 > 2^(SERIAL_BITS - 1)) or
 373  *      (i1 > i2 and i1 - i2 < 2^(SERIAL_BITS - 1))
 374  */
 375
 376 /*
 377  * RFC 2960
 378  *  1.6 Serial Number Arithmetic
 379  *
 380  * Comparisons and arithmetic on TSNs in this document SHOULD use Serial
 381  * Number Arithmetic as defined in [RFC1982] where SERIAL_BITS = 32.
 382  */
 383
 384 enum {
 385         TSN_SIGN_BIT = (1<<31)
 386 };
 387
 388 static inline int TSN_lt(__u32 s, __u32 t)
 389 {
 390         return (((s) - (t)) & TSN_SIGN_BIT);
 391 }
 392
 393 static inline int TSN_lte(__u32 s, __u32 t)
 394 {
 395         return (((s) == (t)) || (((s) - (t)) & TSN_SIGN_BIT));
 396 }
 397
 398 /* Compare two SSNs */
 399
 400 /*
 401  * RFC 2960
 402  *  1.6 Serial Number Arithmetic
 403  *
 404  * Comparisons and arithmetic on Stream Sequence Numbers in this document
 405  * SHOULD use Serial Number Arithmetic as defined in [RFC1982] where
 406  * SERIAL_BITS = 16.
 407  */
 408 enum {
 409         SSN_SIGN_BIT = (1<<15)
 410 };
 411
 412 static inline int SSN_lt(__u16 s, __u16 t)
 413 {
 414         return (((s) - (t)) & SSN_SIGN_BIT);
 415 }
 416
 417 static inline int SSN_lte(__u16 s, __u16 t)
 418 {
 419         return (((s) == (t)) || (((s) - (t)) & SSN_SIGN_BIT));
 420 }
 421
 422 /* Run sctp_add_cmd() generating a BUG() if there is a failure.  */
 423 static inline void sctp_add_cmd_sf(sctp_cmd_seq_t *seq, sctp_verb_t verb, sctp_arg_t obj)
 424 {
 425         if (unlikely(!sctp_add_cmd(seq, verb, obj)))
 426                 BUG();
 427 }
 428
 429 /* Check VTAG of the packet matches the sender's own tag OR its peer's
 430  * tag and the T bit is set in the Chunk Flags.
 431  */
 432 static inline int
 433 sctp_vtag_verify_either(const struct sctp_chunk *chunk,
 434                         const struct sctp_association *asoc)
 435 {
 436         /* RFC 2960 Section 8.5.1, sctpimpguide-06 Section 2.13.2
 437          *
 438          * B) The receiver of a ABORT shall accept the packet if the
 439          * Verification Tag field of the packet matches its own tag OR it
 440          * is set to its peer's tag and the T bit is set in the Chunk
 441          * Flags. Otherwise, the receiver MUST silently discard the packet
 442          * and take no further action.
 443          *
 444          * (C) The receiver of a SHUTDOWN COMPLETE shall accept the
 445          * packet if the Verification Tag field of the packet
 446          * matches its own tag OR it is set to its peer's tag and
 447          * the T bit is set in the Chunk Flags.  Otherwise, the
 448          * receiver MUST silently discard the packet and take no
 449          * further action....
 450          *
 451          */
 452         if ((ntohl(chunk->sctp_hdr->vtag) == asoc->c.my_vtag) ||
 453             (sctp_test_T_bit(chunk) && (ntohl(chunk->sctp_hdr->vtag)
 454             == asoc->c.peer_vtag))) {
 455                 return 1;
 456         }
 457
 458         return 0;
 459 }
 460
 461 #endif /* __sctp_sm_h__ */