include/net/sctp/constants.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  * The SCTP reference implementation is free software;
  10  * you can redistribute it and/or modify it under the terms of
  11  * the GNU General Public License as published by
  12  * the Free Software Foundation; either version 2, or (at your option)
  13  * any later version.
  14  *
  15  * The SCTP reference implementation is distributed in the hope that it
  16  * will be useful, but WITHOUT ANY WARRANTY; without even the implied
  17  *                 ************************
  18  * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  19  * See the GNU General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU General Public License
  22  * along with GNU CC; see the file COPYING.  If not, write to
  23  * the Free Software Foundation, 59 Temple Place - Suite 330,
  24  * Boston, MA 02111-1307, USA.
  25  *
  26  * Please send any bug reports or fixes you make to the
  27  * email address(es):
  28  *    lksctp developers <lksctp-developers@lists.sourceforge.net>
  29  *
  30  * Or submit a bug report through the following website:
  31  *    http://www.sf.net/projects/lksctp
  32  *
  33  * Written or modified by:
  34  *   La Monte H.P. Yarroll <piggy@acm.org>
  35  *   Karl Knutson          <karl@athena.chicago.il.us>
  36  *   Randall Stewart       <randall@stewart.chicago.il.us>
  37  *   Ken Morneau           <kmorneau@cisco.com>
  38  *   Qiaobing Xie          <qxie1@motorola.com>
  39  *   Xingang Guo           <xingang.guo@intel.com>
  40  *   Sridhar Samudrala     <samudrala@us.ibm.com>
  41  *   Daisy Chang           <daisyc@us.ibm.com>
  42  *
  43  * Any bugs reported given to us we will try to fix... any fixes shared will
  44  * be incorporated into the next SCTP release.
  45  */
  46
  47 #ifndef __sctp_constants_h__
  48 #define __sctp_constants_h__
  49
  50 #include <linux/sctp.h>
  51 #include <linux/ipv6.h> /* For ipv6hdr. */
  52 #include <net/sctp/user.h>
  53 #include <net/tcp_states.h>  /* For TCP states used in sctp_sock_state_t */
  54
  55 /* Value used for stream negotiation. */
  56 enum { SCTP_MAX_STREAM = 0xffff };
  57 enum { SCTP_DEFAULT_OUTSTREAMS = 10 };
  58 enum { SCTP_DEFAULT_INSTREAMS = SCTP_MAX_STREAM };
  59
  60 /* Since CIDs are sparse, we need all four of the following
  61  * symbols.  CIDs are dense through SCTP_CID_BASE_MAX.
  62  */
  63 #define SCTP_CID_BASE_MAX               SCTP_CID_SHUTDOWN_COMPLETE
  64 #define SCTP_CID_MAX                    SCTP_CID_ASCONF_ACK
  65
  66 #define SCTP_NUM_BASE_CHUNK_TYPES       (SCTP_CID_BASE_MAX + 1)
  67
  68 #define SCTP_NUM_ADDIP_CHUNK_TYPES      2
  69
  70 #define SCTP_NUM_PRSCTP_CHUNK_TYPES     1
  71
  72 #define SCTP_NUM_AUTH_CHUNK_TYPES       1
  73
  74 #define SCTP_NUM_CHUNK_TYPES            (SCTP_NUM_BASE_CHUNK_TYPES + \
  75                                          SCTP_NUM_ADDIP_CHUNK_TYPES +\
  76                                          SCTP_NUM_PRSCTP_CHUNK_TYPES +\
  77                                          SCTP_NUM_AUTH_CHUNK_TYPES)
  78
  79 /* These are the different flavours of event.  */
  80 typedef enum {
  81
  82         SCTP_EVENT_T_CHUNK = 1,
  83         SCTP_EVENT_T_TIMEOUT,
  84         SCTP_EVENT_T_OTHER,
  85         SCTP_EVENT_T_PRIMITIVE
  86
  87 } sctp_event_t;
  88
  89 #define SCTP_EVENT_T_MAX SCTP_EVENT_T_PRIMITIVE
  90 #define SCTP_EVENT_T_NUM (SCTP_EVENT_T_MAX + 1)
  91
  92 /* As a convenience for the state machine, we append SCTP_EVENT_* and
  93  * SCTP_ULP_* to the list of possible chunks.
  94  */
  95
  96 typedef enum {
  97         SCTP_EVENT_TIMEOUT_NONE = 0,
  98         SCTP_EVENT_TIMEOUT_T1_COOKIE,
  99         SCTP_EVENT_TIMEOUT_T1_INIT,
 100         SCTP_EVENT_TIMEOUT_T2_SHUTDOWN,
 101         SCTP_EVENT_TIMEOUT_T3_RTX,
 102         SCTP_EVENT_TIMEOUT_T4_RTO,
 103         SCTP_EVENT_TIMEOUT_T5_SHUTDOWN_GUARD,
 104         SCTP_EVENT_TIMEOUT_HEARTBEAT,
 105         SCTP_EVENT_TIMEOUT_SACK,
 106         SCTP_EVENT_TIMEOUT_AUTOCLOSE,
 107 } sctp_event_timeout_t;
 108
 109 #define SCTP_EVENT_TIMEOUT_MAX          SCTP_EVENT_TIMEOUT_AUTOCLOSE
 110 #define SCTP_NUM_TIMEOUT_TYPES          (SCTP_EVENT_TIMEOUT_MAX + 1)
 111
 112 typedef enum {
 113         SCTP_EVENT_NO_PENDING_TSN = 0,
 114         SCTP_EVENT_ICMP_PROTO_UNREACH,
 115 } sctp_event_other_t;
 116
 117 #define SCTP_EVENT_OTHER_MAX            SCTP_EVENT_ICMP_PROTO_UNREACH
 118 #define SCTP_NUM_OTHER_TYPES            (SCTP_EVENT_OTHER_MAX + 1)
 119
 120 /* These are primitive requests from the ULP.  */
 121 typedef enum {
 122         SCTP_PRIMITIVE_ASSOCIATE = 0,
 123         SCTP_PRIMITIVE_SHUTDOWN,
 124         SCTP_PRIMITIVE_ABORT,
 125         SCTP_PRIMITIVE_SEND,
 126         SCTP_PRIMITIVE_REQUESTHEARTBEAT,
 127         SCTP_PRIMITIVE_ASCONF,
 128 } sctp_event_primitive_t;
 129
 130 #define SCTP_EVENT_PRIMITIVE_MAX        SCTP_PRIMITIVE_ASCONF
 131 #define SCTP_NUM_PRIMITIVE_TYPES        (SCTP_EVENT_PRIMITIVE_MAX + 1)
 132
 133 /* We define here a utility type for manipulating subtypes.
 134  * The subtype constructors all work like this:
 135  *
 136  *      sctp_subtype_t foo = SCTP_ST_CHUNK(SCTP_CID_INIT);
 137  */
 138
 139 typedef union {
 140         sctp_cid_t chunk;
 141         sctp_event_timeout_t timeout;
 142         sctp_event_other_t other;
 143         sctp_event_primitive_t primitive;
 144 } sctp_subtype_t;
 145
 146 #define SCTP_SUBTYPE_CONSTRUCTOR(_name, _type, _elt) \
 147 static inline sctp_subtype_t    \
 148 SCTP_ST_## _name (_type _arg)           \
 149 { sctp_subtype_t _retval; _retval._elt = _arg; return _retval; }
 150
 151 SCTP_SUBTYPE_CONSTRUCTOR(CHUNK,         sctp_cid_t,             chunk)
 152 SCTP_SUBTYPE_CONSTRUCTOR(TIMEOUT,       sctp_event_timeout_t,   timeout)
 153 SCTP_SUBTYPE_CONSTRUCTOR(OTHER,         sctp_event_other_t,     other)
 154 SCTP_SUBTYPE_CONSTRUCTOR(PRIMITIVE,     sctp_event_primitive_t, primitive)
 155
 156
 157 #define sctp_chunk_is_control(a) (a->chunk_hdr->type != SCTP_CID_DATA)
 158 #define sctp_chunk_is_data(a) (a->chunk_hdr->type == SCTP_CID_DATA)
 159
 160 /* Calculate the actual data size in a data chunk */
 161 #define SCTP_DATA_SNDSIZE(c) ((int)((unsigned long)(c->chunk_end)\
 162                                 - (unsigned long)(c->chunk_hdr)\
 163                                 - sizeof(sctp_data_chunk_t)))
 164
 165 #define SCTP_MAX_ERROR_CAUSE  SCTP_ERROR_NONEXIST_IP
 166 #define SCTP_NUM_ERROR_CAUSE  10
 167
 168 /* Internal error codes */
 169 typedef enum {
 170
 171         SCTP_IERROR_NO_ERROR            = 0,
 172         SCTP_IERROR_BASE                = 1000,
 173         SCTP_IERROR_NO_COOKIE,
 174         SCTP_IERROR_BAD_SIG,
 175         SCTP_IERROR_STALE_COOKIE,
 176         SCTP_IERROR_NOMEM,
 177         SCTP_IERROR_MALFORMED,
 178         SCTP_IERROR_BAD_TAG,
 179         SCTP_IERROR_BIG_GAP,
 180         SCTP_IERROR_DUP_TSN,
 181         SCTP_IERROR_HIGH_TSN,
 182         SCTP_IERROR_IGNORE_TSN,
 183         SCTP_IERROR_NO_DATA,
 184         SCTP_IERROR_BAD_STREAM,
 185         SCTP_IERROR_BAD_PORTS,
 186         SCTP_IERROR_AUTH_BAD_HMAC,
 187         SCTP_IERROR_AUTH_BAD_KEYID,
 188         SCTP_IERROR_PROTO_VIOLATION,
 189 } sctp_ierror_t;
 190
 191
 192
 193 /* SCTP state defines for internal state machine */
 194 typedef enum {
 195
 196         SCTP_STATE_EMPTY                = 0,
 197         SCTP_STATE_CLOSED               = 1,
 198         SCTP_STATE_COOKIE_WAIT          = 2,
 199         SCTP_STATE_COOKIE_ECHOED        = 3,
 200         SCTP_STATE_ESTABLISHED          = 4,
 201         SCTP_STATE_SHUTDOWN_PENDING     = 5,
 202         SCTP_STATE_SHUTDOWN_SENT        = 6,
 203         SCTP_STATE_SHUTDOWN_RECEIVED    = 7,
 204         SCTP_STATE_SHUTDOWN_ACK_SENT    = 8,
 205
 206 } sctp_state_t;
 207
 208 #define SCTP_STATE_MAX                  SCTP_STATE_SHUTDOWN_ACK_SENT
 209 #define SCTP_STATE_NUM_STATES           (SCTP_STATE_MAX + 1)
 210
 211 /* These are values for sk->state.
 212  * For a UDP-style SCTP socket, the states are defined as follows
 213  * - A socket in SCTP_SS_CLOSED state indicates that it is not willing to
 214  *   accept new associations, but it can initiate the creation of new ones.
 215  * - A socket in SCTP_SS_LISTENING state indicates that it is willing to
 216  *   accept new  associations and can initiate the creation of new ones.
 217  * - A socket in SCTP_SS_ESTABLISHED state indicates that it is a peeled off
 218  *   socket with one association.
 219  * For a TCP-style SCTP socket, the states are defined as follows
 220  * - A socket in SCTP_SS_CLOSED state indicates that it is not willing to
 221  *   accept new associations, but it can initiate the creation of new ones.
 222  * - A socket in SCTP_SS_LISTENING state indicates that it is willing to
 223  *   accept new associations, but cannot initiate the creation of new ones.
 224  * - A socket in SCTP_SS_ESTABLISHED state indicates that it has a single
 225  *   association.
 226  */
 227 typedef enum {
 228         SCTP_SS_CLOSED         = TCP_CLOSE,
 229         SCTP_SS_LISTENING      = TCP_LISTEN,
 230         SCTP_SS_ESTABLISHING   = TCP_SYN_SENT,
 231         SCTP_SS_ESTABLISHED    = TCP_ESTABLISHED,
 232         SCTP_SS_DISCONNECTING  = TCP_CLOSING,
 233 } sctp_sock_state_t;
 234
 235 /* These functions map various type to printable names.  */
 236 const char *sctp_cname(const sctp_subtype_t);   /* chunk types */
 237 const char *sctp_oname(const sctp_subtype_t);   /* other events */
 238 const char *sctp_tname(const sctp_subtype_t);   /* timeouts */
 239 const char *sctp_pname(const sctp_subtype_t);   /* primitives */
 240
 241 /* This is a table of printable names of sctp_state_t's.  */
 242 extern const char *sctp_state_tbl[], *sctp_evttype_tbl[], *sctp_status_tbl[];
 243
 244 /* Maximum chunk length considering padding requirements. */
 245 enum { SCTP_MAX_CHUNK_LEN = ((1<<16) - sizeof(__u32)) };
 246
 247 /* Encourage Cookie-Echo bundling by pre-fragmenting chunks a little
 248  * harder (until reaching ESTABLISHED state).
 249  */
 250 enum { SCTP_ARBITRARY_COOKIE_ECHO_LEN = 200 };
 251
 252 /* Guess at how big to make the TSN mapping array.
 253  * We guarantee that we can handle at least this big a gap between the
 254  * cumulative ACK and the highest TSN.  In practice, we can often
 255  * handle up to twice this value.
 256  *
 257  * NEVER make this more than 32767 (2^15-1).  The Gap Ack Blocks in a
 258  * SACK (see  section 3.3.4) are only 16 bits, so 2*SCTP_TSN_MAP_SIZE
 259  * must be less than 65535 (2^16 - 1), or we will have overflow
 260  * problems creating SACK's.
 261  */
 262 #define SCTP_TSN_MAP_SIZE 2048
 263 #define SCTP_TSN_MAX_GAP  65535
 264
 265 /* We will not record more than this many duplicate TSNs between two
 266  * SACKs.  The minimum PMTU is 576.  Remove all the headers and there
 267  * is enough room for 131 duplicate reports.  Round down to the
 268  * nearest power of 2.
 269  */
 270 enum { SCTP_MIN_PMTU = 576 };
 271 enum { SCTP_MAX_DUP_TSNS = 16 };
 272 enum { SCTP_MAX_GABS = 16 };
 273
 274 /* Heartbeat interval - 30 secs */
 275 #define SCTP_DEFAULT_TIMEOUT_HEARTBEAT  (30*1000)
 276
 277 /* Delayed sack timer - 200ms */
 278 #define SCTP_DEFAULT_TIMEOUT_SACK       (200)
 279
 280 /* RTO.Initial              - 3  seconds
 281  * RTO.Min                  - 1  second
 282  * RTO.Max                  - 60 seconds
 283  * RTO.Alpha                - 1/8
 284  * RTO.Beta                 - 1/4
 285  */
 286 #define SCTP_RTO_INITIAL        (3 * 1000)
 287 #define SCTP_RTO_MIN            (1 * 1000)
 288 #define SCTP_RTO_MAX            (60 * 1000)
 289
 290 #define SCTP_RTO_ALPHA          3   /* 1/8 when converted to right shifts. */
 291 #define SCTP_RTO_BETA           2   /* 1/4 when converted to right shifts. */
 292
 293 /* Maximum number of new data packets that can be sent in a burst.  */
 294 #define SCTP_DEFAULT_MAX_BURST          4
 295
 296 #define SCTP_CLOCK_GRANULARITY  1       /* 1 jiffy */
 297
 298 #define SCTP_DEF_MAX_INIT 6
 299 #define SCTP_DEF_MAX_SEND 10
 300
 301 #define SCTP_DEFAULT_COOKIE_LIFE        (60 * 1000) /* 60 seconds */
 302
 303 #define SCTP_DEFAULT_MINWINDOW  1500    /* default minimum rwnd size */
 304 #define SCTP_DEFAULT_MAXWINDOW  65535   /* default rwnd size */
 305 #define SCTP_DEFAULT_MAXSEGMENT 1500    /* MTU size, this is the limit
 306                                          * to which we will raise the P-MTU.
 307                                          */
 308 #define SCTP_DEFAULT_MINSEGMENT 512     /* MTU size ... if no mtu disc */
 309 #define SCTP_HOW_MANY_SECRETS 2         /* How many secrets I keep */
 310 #define SCTP_HOW_LONG_COOKIE_LIVE 3600  /* How many seconds the current
 311                                          * secret will live?
 312                                          */
 313 #define SCTP_SECRET_SIZE 32             /* Number of octets in a 256 bits. */
 314
 315 #define SCTP_SIGNATURE_SIZE 20          /* size of a SLA-1 signature */
 316
 317 #define SCTP_COOKIE_MULTIPLE 32 /* Pad out our cookie to make our hash
 318                                  * functions simpler to write.
 319                                  */
 320
 321 #if defined (CONFIG_SCTP_HMAC_MD5)
 322 #define SCTP_COOKIE_HMAC_ALG "hmac(md5)"
 323 #elif defined (CONFIG_SCTP_HMAC_SHA1)
 324 #define SCTP_COOKIE_HMAC_ALG "hmac(sha1)"
 325 #else
 326 #define SCTP_COOKIE_HMAC_ALG NULL
 327 #endif
 328
 329 /* These return values describe the success or failure of a number of
 330  * routines which form the lower interface to SCTP_outqueue.
 331  */
 332 typedef enum {
 333         SCTP_XMIT_OK,
 334         SCTP_XMIT_PMTU_FULL,
 335         SCTP_XMIT_RWND_FULL,
 336         SCTP_XMIT_NAGLE_DELAY,
 337 } sctp_xmit_t;
 338
 339 /* These are the commands for manipulating transports.  */
 340 typedef enum {
 341         SCTP_TRANSPORT_UP,
 342         SCTP_TRANSPORT_DOWN,
 343 } sctp_transport_cmd_t;
 344
 345 /* These are the address scopes defined mainly for IPv4 addresses
 346  * based on draft of SCTP IPv4 scoping <draft-stewart-tsvwg-sctp-ipv4-00.txt>.
 347  * These scopes are hopefully generic enough to be used on scoping both
 348  * IPv4 and IPv6 addresses in SCTP.
 349  * At this point, the IPv6 scopes will be mapped to these internal scopes
 350  * as much as possible.
 351  */
 352 typedef enum {
 353         SCTP_SCOPE_GLOBAL,              /* IPv4 global addresses */
 354         SCTP_SCOPE_PRIVATE,             /* IPv4 private addresses */
 355         SCTP_SCOPE_LINK,                /* IPv4 link local address */
 356         SCTP_SCOPE_LOOPBACK,            /* IPv4 loopback address */
 357         SCTP_SCOPE_UNUSABLE,            /* IPv4 unusable addresses */
 358 } sctp_scope_t;
 359
 360 /* Based on IPv4 scoping <draft-stewart-tsvwg-sctp-ipv4-00.txt>,
 361  * SCTP IPv4 unusable addresses: 0.0.0.0/8, 224.0.0.0/4, 198.18.0.0/24,
 362  * 192.88.99.0/24.
 363  * Also, RFC 8.4, non-unicast addresses are not considered valid SCTP
 364  * addresses.
 365  */
 366 #define IS_IPV4_UNUSABLE_ADDRESS(a) \
 367         ((htonl(INADDR_BROADCAST) == *a) || \
 368         (MULTICAST(*a)) || \
 369         (((unsigned char *)(a))[0] == 0) || \
 370         ((((unsigned char *)(a))[0] == 198) && \
 371         (((unsigned char *)(a))[1] == 18) && \
 372         (((unsigned char *)(a))[2] == 0)) || \
 373         ((((unsigned char *)(a))[0] == 192) && \
 374         (((unsigned char *)(a))[1] == 88) && \
 375         (((unsigned char *)(a))[2] == 99)))
 376
 377 /* IPv4 Link-local addresses: 169.254.0.0/16.  */
 378 #define IS_IPV4_LINK_ADDRESS(a) \
 379         ((((unsigned char *)(a))[0] == 169) && \
 380         (((unsigned char *)(a))[1] == 254))
 381
 382 /* RFC 1918 "Address Allocation for Private Internets" defines the IPv4
 383  * private address space as the following:
 384  *
 385  * 10.0.0.0 - 10.255.255.255 (10/8 prefix)
 386  * 172.16.0.0.0 - 172.31.255.255 (172.16/12 prefix)
 387  * 192.168.0.0 - 192.168.255.255 (192.168/16 prefix)
 388  */
 389 #define IS_IPV4_PRIVATE_ADDRESS(a) \
 390         ((((unsigned char *)(a))[0] == 10) || \
 391         ((((unsigned char *)(a))[0] == 172) && \
 392         (((unsigned char *)(a))[1] >= 16) && \
 393         (((unsigned char *)(a))[1] < 32)) || \
 394         ((((unsigned char *)(a))[0] == 192) && \
 395         (((unsigned char *)(a))[1] == 168)))
 396
 397 /* Flags used for the bind address copy functions.  */
 398 #define SCTP_ADDR6_ALLOWED      0x00000001      /* IPv6 address is allowed by
 399                                                    local sock family */
 400 #define SCTP_ADDR4_PEERSUPP     0x00000002      /* IPv4 address is supported by
 401                                                    peer */
 402 #define SCTP_ADDR6_PEERSUPP     0x00000004      /* IPv6 address is supported by
 403                                                    peer */
 404
 405 /* Reasons to retransmit. */
 406 typedef enum {
 407         SCTP_RTXR_T3_RTX,
 408         SCTP_RTXR_FAST_RTX,
 409         SCTP_RTXR_PMTUD,
 410 } sctp_retransmit_reason_t;
 411
 412 /* Reasons to lower cwnd. */
 413 typedef enum {
 414         SCTP_LOWER_CWND_T3_RTX,
 415         SCTP_LOWER_CWND_FAST_RTX,
 416         SCTP_LOWER_CWND_ECNE,
 417         SCTP_LOWER_CWND_INACTIVE,
 418 } sctp_lower_cwnd_t;
 419
 420
 421 /* SCTP-AUTH Necessary constants */
 422
 423 /* SCTP-AUTH, Section 3.3
 424  *
 425  *  The following Table 2 shows the currently defined values for HMAC
 426  *  identifiers.
 427  *
 428  *  +-----------------+--------------------------+
 429  *  | HMAC Identifier | Message Digest Algorithm |
 430  *  +-----------------+--------------------------+
 431  *  | 0               | Reserved                 |
 432  *  | 1               | SHA-1 defined in [8]     |
 433  *  | 2               | Reserved                 |
 434  *  | 3               | SHA-256 defined in [8]   |
 435  *  +-----------------+--------------------------+
 436  */
 437 enum {
 438         SCTP_AUTH_HMAC_ID_RESERVED_0,
 439         SCTP_AUTH_HMAC_ID_SHA1,
 440         SCTP_AUTH_HMAC_ID_RESERVED_2,
 441         SCTP_AUTH_HMAC_ID_SHA256
 442 };
 443
 444 #define SCTP_AUTH_HMAC_ID_MAX   SCTP_AUTH_HMAC_ID_SHA256
 445 #define SCTP_AUTH_NUM_HMACS (SCTP_AUTH_HMAC_ID_SHA256 + 1)
 446 #define SCTP_SHA1_SIG_SIZE 20
 447 #define SCTP_SHA256_SIG_SIZE 32
 448
 449 /*  SCTP-AUTH, Section 3.2
 450  *     The chunk types for INIT, INIT-ACK, SHUTDOWN-COMPLETE and AUTH chunks
 451  *     MUST NOT be listed in the CHUNKS parameter
 452  */
 453 #define SCTP_NUM_NOAUTH_CHUNKS  4
 454 #define SCTP_AUTH_MAX_CHUNKS    (SCTP_NUM_CHUNK_TYPES - SCTP_NUM_NOAUTH_CHUNKS)
 455
 456 /* SCTP-AUTH Section 6.1
 457  * The RANDOM parameter MUST contain a 32 byte random number.
 458  */
 459 #define SCTP_AUTH_RANDOM_LENGTH 32
 460
 461 #endif /* __sctp_constants_h__ */