sys/netinet/sctp_constants.h

   1 /*-
   2  * Copyright (c) 2001-2008, by Cisco Systems, Inc. All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions are met:
   6  *
   7  * a) Redistributions of source code must retain the above copyright notice,
   8  *   this list of conditions and the following disclaimer.
   9  *
  10  * b) Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in
  12  *   the documentation and/or other materials provided with the distribution.
  13  *
  14  * c) Neither the name of Cisco Systems, Inc. nor the names of its
  15  *    contributors may be used to endorse or promote products derived
  16  *    from this software without specific prior written permission.
  17  *
  18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
  20  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  21  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
  22  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  23  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  24  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  25  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  26  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  27  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
  28  * THE POSSIBILITY OF SUCH DAMAGE.
  29  */
  30
  31 /* $KAME: sctp_constants.h,v 1.17 2005/03/06 16:04:17 itojun Exp $       */
  32
  33 #include <sys/cdefs.h>
  34 __FBSDID("$FreeBSD$");
  35
  36 #ifndef __sctp_constants_h__
  37 #define __sctp_constants_h__
  38
  39 /* IANA assigned port number for SCTP over UDP encapsulation */
  40 /* For freebsd we cannot bind the port at
  41  * startup. Otherwise what will happen is
  42  * we really won't be bound. The user must
  43  * put it into the sysctl... or we need
  44  * to build a special timer for this to allow
  45  * us to wait 1 second or so after the system
  46  * comes up.
  47  */
  48 #define SCTP_OVER_UDP_TUNNELING_PORT 0
  49 /* Number of packets to get before sack sent by default */
  50 #define SCTP_DEFAULT_SACK_FREQ 2
  51
  52 /* Address limit - This variable is calculated
  53  * based on an 65535 byte max ip packet. We take out 100 bytes
  54  * for the cookie, 40 bytes for a v6 header and 32
  55  * bytes for the init structure. A second init structure
  56  * for the init-ack and then finally a third one for the
  57  * imbedded init. This yeilds 100+40+(3 * 32) = 236 bytes.
  58  * This leaves 65299 bytes for addresses. We throw out the 299 bytes.
  59  * Now whatever we send in the INIT() we need to allow to get back in the
  60  * INIT-ACK plus all the values from INIT and INIT-ACK
  61  * listed in the cookie. Plus we need some overhead for
  62  * maybe copied parameters in the COOKIE. If we
  63  * allow 1080 addresses, and each side has 1080 V6 addresses
  64  * that will be 21600 bytes. In the INIT-ACK we will
  65  * see the INIT-ACK 21600 + 43200 in the cookie. This leaves
  66  * about 500 bytes slack for misc things in the cookie.
  67  */
  68 #define SCTP_ADDRESS_LIMIT 1080
  69
  70 /* We need at least 2k of space for us, inits
  71  * larger than that lets abort.
  72  */
  73 #define SCTP_LARGEST_INIT_ACCEPTED (65535 - 2048)
  74
  75 /* Number of addresses where we just skip the counting */
  76 #define SCTP_COUNT_LIMIT 40
  77
  78 #define SCTP_ZERO_COPY_TICK_DELAY (((100 * hz) + 999) / 1000)
  79 #define SCTP_ZERO_COPY_SENDQ_TICK_DELAY (((100 * hz) + 999) / 1000)
  80
  81 /* Number of ticks to delay before running
  82  * iterator on an address change.
  83  */
  84 #define SCTP_ADDRESS_TICK_DELAY 2
  85
  86 #define SCTP_VERSION_STRING "KAME-BSD 1.1"
  87 /* #define SCTP_AUDITING_ENABLED 1 used for debug/auditing */
  88 #define SCTP_AUDIT_SIZE 256
  89
  90 #define SCTP_USE_THREAD_BASED_ITERATOR 1
  91
  92 #define SCTP_KTRHEAD_NAME "sctp_iterator"
  93 #define SCTP_KTHREAD_PAGES 2
  94
  95
  96 /* If you support Multi-VRF how big to
  97  * make the initial array of VRF's to.
  98  */
  99 #define SCTP_DEFAULT_VRF_SIZE 4
 100
 101 /* constants for rto calc */
 102 #define sctp_align_safe_nocopy 0
 103 #define sctp_align_unsafe_makecopy 1
 104
 105 /* JRS - Values defined for the HTCP algorithm */
 106 #define ALPHA_BASE      (1<<7)  /* 1.0 with shift << 7 */
 107 #define BETA_MIN        (1<<6)  /* 0.5 with shift << 7 */
 108 #define BETA_MAX        102     /* 0.8 with shift << 7 */
 109
 110 /* Places that CWND log can happen from */
 111 #define SCTP_CWND_LOG_FROM_FR   1
 112 #define SCTP_CWND_LOG_FROM_RTX  2
 113 #define SCTP_CWND_LOG_FROM_BRST 3
 114 #define SCTP_CWND_LOG_FROM_SS   4
 115 #define SCTP_CWND_LOG_FROM_CA   5
 116 #define SCTP_CWND_LOG_FROM_SAT  6
 117 #define SCTP_BLOCK_LOG_INTO_BLK 7
 118 #define SCTP_BLOCK_LOG_OUTOF_BLK 8
 119 #define SCTP_BLOCK_LOG_CHECK     9
 120 #define SCTP_STR_LOG_FROM_INTO_STRD 10
 121 #define SCTP_STR_LOG_FROM_IMMED_DEL 11
 122 #define SCTP_STR_LOG_FROM_INSERT_HD 12
 123 #define SCTP_STR_LOG_FROM_INSERT_MD 13
 124 #define SCTP_STR_LOG_FROM_INSERT_TL 14
 125 #define SCTP_STR_LOG_FROM_MARK_TSN  15
 126 #define SCTP_STR_LOG_FROM_EXPRS_DEL 16
 127 #define SCTP_FR_LOG_BIGGEST_TSNS    17
 128 #define SCTP_FR_LOG_STRIKE_TEST     18
 129 #define SCTP_FR_LOG_STRIKE_CHUNK    19
 130 #define SCTP_FR_T3_TIMEOUT          20
 131 #define SCTP_MAP_PREPARE_SLIDE      21
 132 #define SCTP_MAP_SLIDE_FROM         22
 133 #define SCTP_MAP_SLIDE_RESULT       23
 134 #define SCTP_MAP_SLIDE_CLEARED      24
 135 #define SCTP_MAP_SLIDE_NONE         25
 136 #define SCTP_FR_T3_MARK_TIME        26
 137 #define SCTP_FR_T3_MARKED           27
 138 #define SCTP_FR_T3_STOPPED          28
 139 #define SCTP_FR_MARKED              30
 140 #define SCTP_CWND_LOG_NOADV_SS      31
 141 #define SCTP_CWND_LOG_NOADV_CA      32
 142 #define SCTP_MAX_BURST_APPLIED      33
 143 #define SCTP_MAX_IFP_APPLIED        34
 144 #define SCTP_MAX_BURST_ERROR_STOP   35
 145 #define SCTP_INCREASE_PEER_RWND     36
 146 #define SCTP_DECREASE_PEER_RWND     37
 147 #define SCTP_SET_PEER_RWND_VIA_SACK 38
 148 #define SCTP_LOG_MBCNT_INCREASE     39
 149 #define SCTP_LOG_MBCNT_DECREASE     40
 150 #define SCTP_LOG_MBCNT_CHKSET       41
 151 #define SCTP_LOG_NEW_SACK           42
 152 #define SCTP_LOG_TSN_ACKED          43
 153 #define SCTP_LOG_TSN_REVOKED        44
 154 #define SCTP_LOG_LOCK_TCB           45
 155 #define SCTP_LOG_LOCK_INP           46
 156 #define SCTP_LOG_LOCK_SOCK          47
 157 #define SCTP_LOG_LOCK_SOCKBUF_R     48
 158 #define SCTP_LOG_LOCK_SOCKBUF_S     49
 159 #define SCTP_LOG_LOCK_CREATE        50
 160 #define SCTP_LOG_INITIAL_RTT        51
 161 #define SCTP_LOG_RTTVAR             52
 162 #define SCTP_LOG_SBALLOC            53
 163 #define SCTP_LOG_SBFREE             54
 164 #define SCTP_LOG_SBRESULT           55
 165 #define SCTP_FR_DUPED               56
 166 #define SCTP_FR_MARKED_EARLY        57
 167 #define SCTP_FR_CWND_REPORT         58
 168 #define SCTP_FR_CWND_REPORT_START   59
 169 #define SCTP_FR_CWND_REPORT_STOP    60
 170 #define SCTP_CWND_LOG_FROM_SEND     61
 171 #define SCTP_CWND_INITIALIZATION    62
 172 #define SCTP_CWND_LOG_FROM_T3       63
 173 #define SCTP_CWND_LOG_FROM_SACK     64
 174 #define SCTP_CWND_LOG_NO_CUMACK     65
 175 #define SCTP_CWND_LOG_FROM_RESEND   66
 176 #define SCTP_FR_LOG_CHECK_STRIKE    67
 177 #define SCTP_SEND_NOW_COMPLETES     68
 178 #define SCTP_CWND_LOG_FILL_OUTQ_CALLED 69
 179 #define SCTP_CWND_LOG_FILL_OUTQ_FILLS  70
 180 #define SCTP_LOG_FREE_SENT             71
 181 #define SCTP_NAGLE_APPLIED          72
 182 #define SCTP_NAGLE_SKIPPED          73
 183 #define SCTP_WAKESND_FROM_SACK      74
 184 #define SCTP_WAKESND_FROM_FWDTSN    75
 185 #define SCTP_NOWAKE_FROM_SACK       76
 186 #define SCTP_CWNDLOG_PRESEND        77
 187 #define SCTP_CWNDLOG_ENDSEND        78
 188 #define SCTP_AT_END_OF_SACK         79
 189 #define SCTP_REASON_FOR_SC          80
 190 #define SCTP_BLOCK_LOG_INTO_BLKA    81
 191 #define SCTP_ENTER_USER_RECV        82
 192 #define SCTP_USER_RECV_SACKS        83
 193 #define SCTP_SORECV_BLOCKSA         84
 194 #define SCTP_SORECV_BLOCKSB         85
 195 #define SCTP_SORECV_DONE            86
 196 #define SCTP_SACK_RWND_UPDATE       87
 197 #define SCTP_SORECV_ENTER           88
 198 #define SCTP_SORECV_ENTERPL         89
 199 #define SCTP_MBUF_INPUT             90
 200 #define SCTP_MBUF_IALLOC            91
 201 #define SCTP_MBUF_IFREE             92
 202 #define SCTP_MBUF_ICOPY             93
 203 #define SCTP_MBUF_SPLIT             94
 204 #define SCTP_SORCV_FREECTL          95
 205 #define SCTP_SORCV_DOESCPY          96
 206 #define SCTP_SORCV_DOESLCK          97
 207 #define SCTP_SORCV_DOESADJ          98
 208 #define SCTP_SORCV_BOTWHILE         99
 209 #define SCTP_SORCV_PASSBF          100
 210 #define SCTP_SORCV_ADJD            101
 211 #define SCTP_UNKNOWN_MAX           102
 212 #define SCTP_RANDY_STUFF           103
 213 #define SCTP_RANDY_STUFF1          104
 214 #define SCTP_STRMOUT_LOG_ASSIGN    105
 215 #define SCTP_STRMOUT_LOG_SEND      106
 216 #define SCTP_FLIGHT_LOG_DOWN_CA    107
 217 #define SCTP_FLIGHT_LOG_UP         108
 218 #define SCTP_FLIGHT_LOG_DOWN_GAP   109
 219 #define SCTP_FLIGHT_LOG_DOWN_RSND  110
 220 #define SCTP_FLIGHT_LOG_UP_RSND    111
 221 #define SCTP_FLIGHT_LOG_DOWN_RSND_TO    112
 222 #define SCTP_FLIGHT_LOG_DOWN_WP    113
 223 #define SCTP_FLIGHT_LOG_UP_REVOKE  114
 224 #define SCTP_FLIGHT_LOG_DOWN_PDRP  115
 225 #define SCTP_FLIGHT_LOG_DOWN_PMTU  116
 226 #define SCTP_SACK_LOG_NORMAL       117
 227 #define SCTP_SACK_LOG_EXPRESS      118
 228 #define SCTP_MAP_TSN_ENTERS        119
 229 #define SCTP_THRESHOLD_CLEAR       120
 230 #define SCTP_THRESHOLD_INCR        121
 231 #define SCTP_FLIGHT_LOG_DWN_WP_FWD 122
 232 #define SCTP_FWD_TSN_CHECK         123
 233 #define SCTP_LOG_MAX_TYPES 124
 234 /*
 235  * To turn on various logging, you must first enable 'options KTR' and
 236  * you might want to bump the entires 'options KTR_ENTRIES=80000'.
 237  * To get something to log you define one of the logging defines.
 238  * (see LINT).
 239  *
 240  * This gets the compile in place, but you still need to turn the
 241  * logging flag on too in the sysctl (see in sctp.h).
 242  */
 243
 244 #define SCTP_LOG_EVENT_UNKNOWN 0
 245 #define SCTP_LOG_EVENT_CWND  1
 246 #define SCTP_LOG_EVENT_BLOCK 2
 247 #define SCTP_LOG_EVENT_STRM  3
 248 #define SCTP_LOG_EVENT_FR    4
 249 #define SCTP_LOG_EVENT_MAP   5
 250 #define SCTP_LOG_EVENT_MAXBURST 6
 251 #define SCTP_LOG_EVENT_RWND  7
 252 #define SCTP_LOG_EVENT_MBCNT 8
 253 #define SCTP_LOG_EVENT_SACK  9
 254 #define SCTP_LOG_LOCK_EVENT 10
 255 #define SCTP_LOG_EVENT_RTT  11
 256 #define SCTP_LOG_EVENT_SB   12
 257 #define SCTP_LOG_EVENT_NAGLE 13
 258 #define SCTP_LOG_EVENT_WAKE 14
 259 #define SCTP_LOG_MISC_EVENT 15
 260 #define SCTP_LOG_EVENT_CLOSE 16
 261 #define SCTP_LOG_EVENT_MBUF 17
 262 #define SCTP_LOG_CHUNK_PROC 18
 263 #define SCTP_LOG_ERROR_RET  19
 264
 265 #define SCTP_LOG_MAX_EVENT 20
 266
 267 #define SCTP_LOCK_UNKNOWN 2
 268
 269
 270 /* number of associations by default for zone allocation */
 271 #define SCTP_MAX_NUM_OF_ASOC    40000
 272 /* how many addresses per assoc remote and local */
 273 #define SCTP_SCALE_FOR_ADDR     2
 274
 275 /* default AUTO_ASCONF mode enable(1)/disable(0) value (sysctl) */
 276 #if defined (__APPLE__) && !defined(SCTP_APPLE_AUTO_ASCONF)
 277 #define SCTP_DEFAULT_AUTO_ASCONF        0
 278 #else
 279 #define SCTP_DEFAULT_AUTO_ASCONF        1
 280 #endif
 281
 282 /* default MULTIPLE_ASCONF mode enable(1)/disable(0) value (sysctl) */
 283 #define SCTP_DEFAULT_MULTIPLE_ASCONFS   0
 284
 285 /* default MOBILITY_BASE mode enable(1)/disable(0) value (sysctl) */
 286 #if defined (__APPLE__) && !defined(SCTP_APPLE_MOBILITY_BASE)
 287 #define SCTP_DEFAULT_MOBILITY_BASE      0
 288 #else
 289 #define SCTP_DEFAULT_MOBILITY_BASE      0
 290 #endif
 291
 292 /* default MOBILITY_FASTHANDOFF mode enable(1)/disable(0) value (sysctl) */
 293 #if defined (__APPLE__) && !defined(SCTP_APPLE_MOBILITY_FASTHANDOFF)
 294 #define SCTP_DEFAULT_MOBILITY_FASTHANDOFF       0
 295 #else
 296 #define SCTP_DEFAULT_MOBILITY_FASTHANDOFF       0
 297 #endif
 298
 299 /*
 300  * Theshold for rwnd updates, we have to read (sb_hiwat >>
 301  * SCTP_RWND_HIWAT_SHIFT) before we will look to see if we need to send a
 302  * window update sack. When we look, we compare the last rwnd we sent vs the
 303  * current rwnd. It too must be greater than this value. Using 3 divdes the
 304  * hiwat by 8, so for 200k rwnd we need to read 24k. For a 64k rwnd we need
 305  * to read 8k. This seems about right.. I hope :-D.. we do set a
 306  * min of a MTU on it so if the rwnd is real small we will insist
 307  * on a full MTU of 1500 bytes.
 308  */
 309 #define SCTP_RWND_HIWAT_SHIFT 3
 310
 311 /* How much of the rwnd must the
 312  * message be taking up to start partial delivery.
 313  * We calculate this by shifing the hi_water (recv_win)
 314  * left the following .. set to 1, when a message holds
 315  * 1/2 the rwnd. If we set it to 2 when a message holds
 316  * 1/4 the rwnd...etc..
 317  */
 318
 319 #define SCTP_PARTIAL_DELIVERY_SHIFT 1
 320
 321 /*
 322  * default HMAC for cookies, etc... use one of the AUTH HMAC id's
 323  * SCTP_HMAC is the HMAC_ID to use
 324  * SCTP_SIGNATURE_SIZE is the digest length
 325  */
 326 #define SCTP_HMAC               SCTP_AUTH_HMAC_ID_SHA1
 327 #define SCTP_SIGNATURE_SIZE     SCTP_AUTH_DIGEST_LEN_SHA1
 328 #define SCTP_SIGNATURE_ALOC_SIZE SCTP_SIGNATURE_SIZE
 329
 330 /*
 331  * the SCTP protocol signature this includes the version number encoded in
 332  * the last 4 bits of the signature.
 333  */
 334 #define PROTO_SIGNATURE_A       0x30000000
 335 #define SCTP_VERSION_NUMBER     0x3
 336
 337 #define MAX_TSN 0xffffffff
 338 #define MAX_SEQ 0xffff
 339
 340 /* how many executions every N tick's */
 341 #define SCTP_ITERATOR_MAX_AT_ONCE 20
 342
 343 /* number of clock ticks between iterator executions */
 344 #define SCTP_ITERATOR_TICKS 1
 345
 346 /*
 347  * option: If you comment out the following you will receive the old behavior
 348  * of obeying cwnd for the fast retransmit algorithm. With this defined a FR
 349  * happens right away with-out waiting for the flightsize to drop below the
 350  * cwnd value (which is reduced by the FR to 1/2 the inflight packets).
 351  */
 352 #define SCTP_IGNORE_CWND_ON_FR 1
 353
 354 /*
 355  * Adds implementors guide behavior to only use newest highest update in SACK
 356  * gap ack's to figure out if you need to stroke a chunk for FR.
 357  */
 358 #define SCTP_NO_FR_UNLESS_SEGMENT_SMALLER 1
 359
 360 /* default max I can burst out after a fast retransmit */
 361 #define SCTP_DEF_MAX_BURST 4
 362 /* IP hdr (20/40) + 12+2+2 (enet) + sctp common 12 */
 363 #define SCTP_FIRST_MBUF_RESV 68
 364 /* Packet transmit states in the sent field */
 365 #define SCTP_DATAGRAM_UNSENT            0
 366 #define SCTP_DATAGRAM_SENT              1
 367 #define SCTP_DATAGRAM_RESEND1           2       /* not used (in code, but may
 368                                                  * hit this value) */
 369 #define SCTP_DATAGRAM_RESEND2           3       /* not used (in code, but may
 370                                                  * hit this value) */
 371 #define SCTP_DATAGRAM_RESEND            4
 372 #define SCTP_DATAGRAM_ACKED             10010
 373 /* EY
 374  * If a tsn is nr-gapped, its first tagged as NR_MARKED and then NR_ACKED
 375  * When yet another nr-sack is received, if a particular TSN's sent tag
 376  * is observed to be NR_ACKED after gap-ack info is processed, this implies
 377  * that particular TSN is reneged
 378 */
 379 #define SCTP_DATAGRAM_NR_ACKED          10020
 380 #define SCTP_DATAGRAM_NR_MARKED         20005
 381 #define SCTP_DATAGRAM_MARKED            20010
 382 #define SCTP_FORWARD_TSN_SKIP           30010
 383
 384 /* chunk output send from locations */
 385 #define SCTP_OUTPUT_FROM_USR_SEND       0
 386 #define SCTP_OUTPUT_FROM_T3             1
 387 #define SCTP_OUTPUT_FROM_INPUT_ERROR    2
 388 #define SCTP_OUTPUT_FROM_CONTROL_PROC   3
 389 #define SCTP_OUTPUT_FROM_SACK_TMR       4
 390 #define SCTP_OUTPUT_FROM_SHUT_TMR       5
 391 #define SCTP_OUTPUT_FROM_HB_TMR         6
 392 #define SCTP_OUTPUT_FROM_SHUT_ACK_TMR   7
 393 #define SCTP_OUTPUT_FROM_ASCONF_TMR     8
 394 #define SCTP_OUTPUT_FROM_STRRST_TMR     9
 395 #define SCTP_OUTPUT_FROM_AUTOCLOSE_TMR  10
 396 #define SCTP_OUTPUT_FROM_EARLY_FR_TMR   11
 397 #define SCTP_OUTPUT_FROM_STRRST_REQ     12
 398 #define SCTP_OUTPUT_FROM_USR_RCVD       13
 399 #define SCTP_OUTPUT_FROM_COOKIE_ACK     14
 400 #define SCTP_OUTPUT_FROM_DRAIN          15
 401 #define SCTP_OUTPUT_FROM_CLOSING        16
 402 /* SCTP chunk types are moved sctp.h for application (NAT, FW) use */
 403
 404 /* align to 32-bit sizes */
 405 #define SCTP_SIZE32(x)  ((((x)+3) >> 2) << 2)
 406
 407 #define IS_SCTP_CONTROL(a) ((a)->chunk_type != SCTP_DATA)
 408 #define IS_SCTP_DATA(a) ((a)->chunk_type == SCTP_DATA)
 409
 410
 411 /* SCTP parameter types */
 412 /*************0x0000 series*************/
 413 #define SCTP_HEARTBEAT_INFO             0x0001
 414 #define SCTP_IPV4_ADDRESS               0x0005
 415 #define SCTP_IPV6_ADDRESS               0x0006
 416 #define SCTP_STATE_COOKIE               0x0007
 417 #define SCTP_UNRECOG_PARAM              0x0008
 418 #define SCTP_COOKIE_PRESERVE            0x0009
 419 #define SCTP_HOSTNAME_ADDRESS           0x000b
 420 #define SCTP_SUPPORTED_ADDRTYPE         0x000c
 421
 422 /* draft-ietf-stewart-tsvwg-strreset-xxx */
 423 #define SCTP_STR_RESET_OUT_REQUEST      0x000d
 424 #define SCTP_STR_RESET_IN_REQUEST       0x000e
 425 #define SCTP_STR_RESET_TSN_REQUEST      0x000f
 426 #define SCTP_STR_RESET_RESPONSE         0x0010
 427 #define SCTP_STR_RESET_ADD_STREAMS  0x0011
 428
 429 #define SCTP_MAX_RESET_PARAMS 2
 430 #define SCTP_STREAM_RESET_TSN_DELTA    0x1000
 431
 432 /*************0x4000 series*************/
 433
 434 /*************0x8000 series*************/
 435 #define SCTP_ECN_CAPABLE                0x8000
 436 /* ECN Nonce: draft-ladha-sctp-ecn-nonce */
 437 #define SCTP_ECN_NONCE_SUPPORTED        0x8001
 438 /* draft-ietf-tsvwg-auth-xxx */
 439 #define SCTP_RANDOM                     0x8002
 440 #define SCTP_CHUNK_LIST                 0x8003
 441 #define SCTP_HMAC_LIST                  0x8004
 442 /*
 443  * draft-ietf-tsvwg-addip-sctp-xx param=0x8008  len=0xNNNN Byte | Byte | Byte
 444  * | Byte Byte | Byte ...
 445  *
 446  * Where each byte is a chunk type extension supported. For example, to support
 447  * all chunks one would have (in hex):
 448  *
 449  * 80 01 00 09 C0 C1 80 81 82 00 00 00
 450  *
 451  * Has the parameter. C0 = PR-SCTP    (RFC3758) C1, 80 = ASCONF (addip draft) 81
 452  * = Packet Drop 82 = Stream Reset 83 = Authentication
 453  */
 454 #define SCTP_SUPPORTED_CHUNK_EXT    0x8008
 455
 456 /*************0xC000 series*************/
 457 #define SCTP_PRSCTP_SUPPORTED           0xc000
 458 /* draft-ietf-tsvwg-addip-sctp */
 459 #define SCTP_ADD_IP_ADDRESS             0xc001
 460 #define SCTP_DEL_IP_ADDRESS             0xc002
 461 #define SCTP_ERROR_CAUSE_IND            0xc003
 462 #define SCTP_SET_PRIM_ADDR              0xc004
 463 #define SCTP_SUCCESS_REPORT             0xc005
 464 #define SCTP_ULP_ADAPTATION             0xc006
 465 /* behave-nat-draft */
 466 #define SCTP_HAS_NAT_SUPPORT            0xc007
 467 #define SCTP_NAT_VTAGS                  0xc008
 468
 469 /* Notification error codes */
 470 #define SCTP_NOTIFY_DATAGRAM_UNSENT     0x0001
 471 #define SCTP_NOTIFY_DATAGRAM_SENT       0x0002
 472 #define SCTP_FAILED_THRESHOLD           0x0004
 473 #define SCTP_HEARTBEAT_SUCCESS          0x0008
 474 #define SCTP_RESPONSE_TO_USER_REQ       0x0010
 475 #define SCTP_INTERNAL_ERROR             0x0020
 476 #define SCTP_SHUTDOWN_GUARD_EXPIRES     0x0040
 477 #define SCTP_RECEIVED_SACK              0x0080
 478 #define SCTP_PEER_FAULTY                0x0100
 479 #define SCTP_ICMP_REFUSED               0x0200
 480
 481 /* bits for TOS field */
 482 #define SCTP_ECT0_BIT           0x02
 483 #define SCTP_ECT1_BIT           0x01
 484 #define SCTP_CE_BITS            0x03
 485
 486 /* below turns off above */
 487 #define SCTP_FLEXIBLE_ADDRESS   0x20
 488 #define SCTP_NO_HEARTBEAT       0x40
 489
 490 /* mask to get sticky */
 491 #define SCTP_STICKY_OPTIONS_MASK        0x0c
 492
 493
 494 /*
 495  * SCTP states for internal state machine XXX (should match "user" values)
 496  */
 497 #define SCTP_STATE_EMPTY                0x0000
 498 #define SCTP_STATE_INUSE                0x0001
 499 #define SCTP_STATE_COOKIE_WAIT          0x0002
 500 #define SCTP_STATE_COOKIE_ECHOED        0x0004
 501 #define SCTP_STATE_OPEN                 0x0008
 502 #define SCTP_STATE_SHUTDOWN_SENT        0x0010
 503 #define SCTP_STATE_SHUTDOWN_RECEIVED    0x0020
 504 #define SCTP_STATE_SHUTDOWN_ACK_SENT    0x0040
 505 #define SCTP_STATE_SHUTDOWN_PENDING     0x0080
 506 #define SCTP_STATE_CLOSED_SOCKET        0x0100
 507 #define SCTP_STATE_ABOUT_TO_BE_FREED    0x0200
 508 #define SCTP_STATE_PARTIAL_MSG_LEFT     0x0400
 509 #define SCTP_STATE_WAS_ABORTED          0x0800
 510 #define SCTP_STATE_MASK                 0x007f
 511
 512 #define SCTP_GET_STATE(asoc)    ((asoc)->state & SCTP_STATE_MASK)
 513 #define SCTP_SET_STATE(asoc, newstate)  ((asoc)->state = ((asoc)->state & ~SCTP_STATE_MASK) |  newstate)
 514 #define SCTP_CLEAR_SUBSTATE(asoc, substate) ((asoc)->state &= ~substate)
 515 #define SCTP_ADD_SUBSTATE(asoc, substate) ((asoc)->state |= substate)
 516
 517 /* SCTP reachability state for each address */
 518 #define SCTP_ADDR_REACHABLE             0x001
 519 #define SCTP_ADDR_NOT_REACHABLE         0x002
 520 #define SCTP_ADDR_NOHB                  0x004
 521 #define SCTP_ADDR_BEING_DELETED         0x008
 522 #define SCTP_ADDR_NOT_IN_ASSOC          0x010
 523 #define SCTP_ADDR_WAS_PRIMARY           0x020
 524 #define SCTP_ADDR_SWITCH_PRIMARY        0x040
 525 #define SCTP_ADDR_OUT_OF_SCOPE          0x080
 526 #define SCTP_ADDR_DOUBLE_SWITCH         0x100
 527 #define SCTP_ADDR_UNCONFIRMED           0x200
 528 #define SCTP_ADDR_REQ_PRIMARY           0x400
 529 /* JRS 5/13/07 - Added potentially failed state for CMT PF */
 530 #define SCTP_ADDR_PF            0x800
 531 #define SCTP_REACHABLE_MASK             0x203
 532
 533 /* bound address types (e.g. valid address types to allow) */
 534 #define SCTP_BOUND_V6           0x01
 535 #define SCTP_BOUND_V4           0x02
 536
 537 /*
 538  * what is the default number of mbufs in a chain I allow before switching to
 539  * a cluster
 540  */
 541 #define SCTP_DEFAULT_MBUFS_IN_CHAIN 5
 542
 543 /* How long a cookie lives in milli-seconds */
 544 #define SCTP_DEFAULT_COOKIE_LIFE        60000
 545
 546 /* resource limit of streams */
 547 #define MAX_SCTP_STREAMS        2048
 548
 549 /* Maximum the mapping array will  grow to (TSN mapping array) */
 550 #define SCTP_MAPPING_ARRAY      512
 551
 552 /* size of the inital malloc on the mapping array */
 553 #define SCTP_INITIAL_MAPPING_ARRAY  16
 554 /* how much we grow the mapping array each call */
 555 #define SCTP_MAPPING_ARRAY_INCR     32
 556 /* EY 05/13/08 - nr_sack version of the previous 3 constants */
 557 /* Maximum the nr mapping array will  grow to (TSN mapping array) */
 558 #define SCTP_NR_MAPPING_ARRAY   512
 559 /* size of the inital malloc on the nr mapping array */
 560 #define SCTP_INITIAL_NR_MAPPING_ARRAY  16
 561 /* how much we grow the nr mapping array each call */
 562 #define SCTP_NR_MAPPING_ARRAY_INCR     32
 563 /*
 564  * Here we define the timer types used by the implementation as arguments in
 565  * the set/get timer type calls.
 566  */
 567 #define SCTP_TIMER_INIT         0
 568 #define SCTP_TIMER_RECV         1
 569 #define SCTP_TIMER_SEND         2
 570 #define SCTP_TIMER_HEARTBEAT    3
 571 #define SCTP_TIMER_PMTU         4
 572 #define SCTP_TIMER_MAXSHUTDOWN  5
 573 #define SCTP_TIMER_SIGNATURE    6
 574 /*
 575  * number of timer types in the base SCTP structure used in the set/get and
 576  * has the base default.
 577  */
 578 #define SCTP_NUM_TMRS   7
 579
 580 /* timer types */
 581 #define SCTP_TIMER_TYPE_NONE            0
 582 #define SCTP_TIMER_TYPE_SEND            1
 583 #define SCTP_TIMER_TYPE_INIT            2
 584 #define SCTP_TIMER_TYPE_RECV            3
 585 #define SCTP_TIMER_TYPE_SHUTDOWN        4
 586 #define SCTP_TIMER_TYPE_HEARTBEAT       5
 587 #define SCTP_TIMER_TYPE_COOKIE          6
 588 #define SCTP_TIMER_TYPE_NEWCOOKIE       7
 589 #define SCTP_TIMER_TYPE_PATHMTURAISE    8
 590 #define SCTP_TIMER_TYPE_SHUTDOWNACK     9
 591 #define SCTP_TIMER_TYPE_ASCONF          10
 592 #define SCTP_TIMER_TYPE_SHUTDOWNGUARD   11
 593 #define SCTP_TIMER_TYPE_AUTOCLOSE       12
 594 #define SCTP_TIMER_TYPE_EVENTWAKE       13
 595 #define SCTP_TIMER_TYPE_STRRESET        14
 596 #define SCTP_TIMER_TYPE_INPKILL         15
 597 #define SCTP_TIMER_TYPE_ITERATOR        16
 598 #define SCTP_TIMER_TYPE_EARLYFR         17
 599 #define SCTP_TIMER_TYPE_ASOCKILL        18
 600 #define SCTP_TIMER_TYPE_ADDR_WQ         19
 601 #define SCTP_TIMER_TYPE_ZERO_COPY       20
 602 #define SCTP_TIMER_TYPE_ZCOPY_SENDQ     21
 603 #define SCTP_TIMER_TYPE_PRIM_DELETED    22
 604 /* add new timers here - and increment LAST */
 605 #define SCTP_TIMER_TYPE_LAST            23
 606
 607 #define SCTP_IS_TIMER_TYPE_VALID(t)     (((t) > SCTP_TIMER_TYPE_NONE) && \
 608                                          ((t) < SCTP_TIMER_TYPE_LAST))
 609
 610
 611
 612 /* max number of TSN's dup'd that I will hold */
 613 #define SCTP_MAX_DUP_TSNS       20
 614
 615 /*
 616  * Here we define the types used when setting the retry amounts.
 617  */
 618 /* How many drop re-attempts we make on  INIT/COOKIE-ECHO */
 619 #define SCTP_RETRY_DROPPED_THRESH 4
 620
 621 /*
 622  * Maxmium number of chunks a single association can have on it. Note that
 623  * this is a squishy number since the count can run over this if the user
 624  * sends a large message down .. the fragmented chunks don't count until
 625  * AFTER the message is on queue.. it would be the next send that blocks
 626  * things. This number will get tuned up at boot in the sctp_init and use the
 627  * number of clusters as a base. This way high bandwidth environments will
 628  * not get impacted by the lower bandwidth sending a bunch of 1 byte chunks
 629  */
 630 #define SCTP_ASOC_MAX_CHUNKS_ON_QUEUE 512
 631
 632
 633 /* The conversion from time to ticks and vice versa is done by rounding
 634  * upwards. This way we can test in the code the time to be positive and
 635  * know that this corresponds to a positive number of ticks.
 636  */
 637 #define MSEC_TO_TICKS(x) ((hz == 1000) ? x : ((((x) * hz) + 999) / 1000))
 638 #define TICKS_TO_MSEC(x) ((hz == 1000) ? x : ((((x) * 1000) + (hz - 1)) / hz))
 639
 640 #define SEC_TO_TICKS(x) ((x) * hz)
 641 #define TICKS_TO_SEC(x) (((x) + (hz - 1)) / hz)
 642
 643 /*
 644  * Basically the minimum amount of time before I do a early FR. Making this
 645  * value to low will cause duplicate retransmissions.
 646  */
 647 #define SCTP_MINFR_MSEC_TIMER 250
 648 /* The floor this value is allowed to fall to when starting a timer. */
 649 #define SCTP_MINFR_MSEC_FLOOR 20
 650
 651 /* init timer def = 1 sec */
 652 #define SCTP_INIT_SEC   1
 653
 654 /* send timer def = 1 seconds */
 655 #define SCTP_SEND_SEC   1
 656
 657 /* recv timer def = 200ms  */
 658 #define SCTP_RECV_MSEC  200
 659
 660 /* 30 seconds + RTO (in ms) */
 661 #define SCTP_HB_DEFAULT_MSEC    30000
 662
 663 /* Max time I will wait for Shutdown to complete */
 664 #define SCTP_DEF_MAX_SHUTDOWN_SEC 180
 665
 666
 667 /*
 668  * This is how long a secret lives, NOT how long a cookie lives how many
 669  * ticks the current secret will live.
 670  */
 671 #define SCTP_DEFAULT_SECRET_LIFE_SEC 3600
 672
 673 #define SCTP_RTO_UPPER_BOUND    (60000) /* 60 sec in ms */
 674 #define SCTP_RTO_UPPER_BOUND_SEC 60     /* for the init timer */
 675 #define SCTP_RTO_LOWER_BOUND    (1000)  /* 1 sec in ms */
 676 #define SCTP_RTO_INITIAL        (3000)  /* 3 sec in ms */
 677
 678
 679 #define SCTP_INP_KILL_TIMEOUT 20/* number of ms to retry kill of inpcb */
 680 #define SCTP_ASOC_KILL_TIMEOUT 10       /* number of ms to retry kill of inpcb */
 681
 682 #define SCTP_DEF_MAX_INIT       8
 683 #define SCTP_DEF_MAX_SEND       10
 684 #define SCTP_DEF_MAX_PATH_RTX   5
 685
 686 #define SCTP_DEF_PMTU_RAISE_SEC 600     /* 10 min between raise attempts */
 687
 688
 689 /* How many streams I request initally by default */
 690 #define SCTP_OSTREAM_INITIAL 10
 691
 692 /*
 693  * How many smallest_mtu's need to increase before a window update sack is
 694  * sent (should be a power of 2).
 695  */
 696 /* Send window update (incr * this > hiwat). Should be a power of 2 */
 697 #define SCTP_MINIMAL_RWND               (4096)  /* minimal rwnd */
 698
 699 #define SCTP_ADDRMAX            24
 700
 701 /* SCTP DEBUG Switch parameters */
 702 #define SCTP_DEBUG_TIMER1       0x00000001
 703 #define SCTP_DEBUG_TIMER2       0x00000002      /* unused */
 704 #define SCTP_DEBUG_TIMER3       0x00000004      /* unused */
 705 #define SCTP_DEBUG_TIMER4       0x00000008
 706 #define SCTP_DEBUG_OUTPUT1      0x00000010
 707 #define SCTP_DEBUG_OUTPUT2      0x00000020
 708 #define SCTP_DEBUG_OUTPUT3      0x00000040
 709 #define SCTP_DEBUG_OUTPUT4      0x00000080
 710 #define SCTP_DEBUG_UTIL1        0x00000100
 711 #define SCTP_DEBUG_UTIL2        0x00000200      /* unused */
 712 #define SCTP_DEBUG_AUTH1        0x00000400
 713 #define SCTP_DEBUG_AUTH2        0x00000800      /* unused */
 714 #define SCTP_DEBUG_INPUT1       0x00001000
 715 #define SCTP_DEBUG_INPUT2       0x00002000
 716 #define SCTP_DEBUG_INPUT3       0x00004000
 717 #define SCTP_DEBUG_INPUT4       0x00008000      /* unused */
 718 #define SCTP_DEBUG_ASCONF1      0x00010000
 719 #define SCTP_DEBUG_ASCONF2      0x00020000
 720 #define SCTP_DEBUG_OUTPUT5      0x00040000      /* unused */
 721 #define SCTP_DEBUG_XXX          0x00080000      /* unused */
 722 #define SCTP_DEBUG_PCB1         0x00100000
 723 #define SCTP_DEBUG_PCB2         0x00200000      /* unused */
 724 #define SCTP_DEBUG_PCB3         0x00400000
 725 #define SCTP_DEBUG_PCB4         0x00800000
 726 #define SCTP_DEBUG_INDATA1      0x01000000
 727 #define SCTP_DEBUG_INDATA2      0x02000000      /* unused */
 728 #define SCTP_DEBUG_INDATA3      0x04000000      /* unused */
 729 #define SCTP_DEBUG_CRCOFFLOAD   0x08000000      /* unused */
 730 #define SCTP_DEBUG_USRREQ1      0x10000000      /* unused */
 731 #define SCTP_DEBUG_USRREQ2      0x20000000      /* unused */
 732 #define SCTP_DEBUG_PEEL1        0x40000000
 733 #define SCTP_DEBUG_XXXXX        0x80000000      /* unused */
 734 #define SCTP_DEBUG_ALL          0x7ff3ffff
 735 #define SCTP_DEBUG_NOISY        0x00040000
 736
 737 /* What sender needs to see to avoid SWS or we consider peers rwnd 0 */
 738 #define SCTP_SWS_SENDER_DEF     1420
 739
 740 /*
 741  * SWS is scaled to the sb_hiwat of the socket. A value of 2 is hiwat/4, 1
 742  * would be hiwat/2 etc.
 743  */
 744 /* What receiver needs to see in sockbuf or we tell peer its 1 */
 745 #define SCTP_SWS_RECEIVER_DEF   3000
 746
 747 #define SCTP_INITIAL_CWND 4380
 748
 749 #define SCTP_DEFAULT_MTU 1500   /* emergency default MTU */
 750 /* amount peer is obligated to have in rwnd or I will abort */
 751 #define SCTP_MIN_RWND   1500
 752
 753 #define SCTP_DEFAULT_MAXSEGMENT 65535
 754
 755 #define SCTP_CHUNK_BUFFER_SIZE  512
 756 #define SCTP_PARAM_BUFFER_SIZE  512
 757
 758 /* small chunk store for looking at chunk_list in auth */
 759 #define SCTP_SMALL_CHUNK_STORE 260
 760
 761 #define SCTP_DEFAULT_MINSEGMENT 512     /* MTU size ... if no mtu disc */
 762 #define SCTP_HOW_MANY_SECRETS   2       /* how many secrets I keep */
 763
 764 #define SCTP_NUMBER_OF_SECRETS  8       /* or 8 * 4 = 32 octets */
 765 #define SCTP_SECRET_SIZE        32      /* number of octets in a 256 bits */
 766
 767
 768 /*
 769  * SCTP upper layer notifications
 770  */
 771 #define SCTP_NOTIFY_ASSOC_UP                     1
 772 #define SCTP_NOTIFY_ASSOC_DOWN                   2
 773 #define SCTP_NOTIFY_INTERFACE_DOWN               3
 774 #define SCTP_NOTIFY_INTERFACE_UP                 4
 775 #define SCTP_NOTIFY_DG_FAIL                      5
 776 #define SCTP_NOTIFY_STRDATA_ERR                  6
 777 #define SCTP_NOTIFY_ASSOC_ABORTED                7
 778 #define SCTP_NOTIFY_PEER_OPENED_STREAM           8
 779 #define SCTP_NOTIFY_STREAM_OPENED_OK             9
 780 #define SCTP_NOTIFY_ASSOC_RESTART               10
 781 #define SCTP_NOTIFY_HB_RESP                     11
 782 #define SCTP_NOTIFY_ASCONF_SUCCESS              12
 783 #define SCTP_NOTIFY_ASCONF_FAILED               13
 784 #define SCTP_NOTIFY_PEER_SHUTDOWN               14
 785 #define SCTP_NOTIFY_ASCONF_ADD_IP               15
 786 #define SCTP_NOTIFY_ASCONF_DELETE_IP            16
 787 #define SCTP_NOTIFY_ASCONF_SET_PRIMARY          17
 788 #define SCTP_NOTIFY_PARTIAL_DELVIERY_INDICATION 18
 789 #define SCTP_NOTIFY_INTERFACE_CONFIRMED         20
 790 #define SCTP_NOTIFY_STR_RESET_RECV              21
 791 #define SCTP_NOTIFY_STR_RESET_SEND              22
 792 #define SCTP_NOTIFY_STR_RESET_FAILED_OUT        23
 793 #define SCTP_NOTIFY_STR_RESET_FAILED_IN         24
 794 #define SCTP_NOTIFY_AUTH_NEW_KEY                25
 795 #define SCTP_NOTIFY_AUTH_FREE_KEY               26
 796 #define SCTP_NOTIFY_SPECIAL_SP_FAIL             27
 797 #define SCTP_NOTIFY_NO_PEER_AUTH                28
 798 #define SCTP_NOTIFY_SENDER_DRY                  29
 799 #define SCTP_NOTIFY_STR_RESET_ADD_OK            30
 800 #define SCTP_NOTIFY_STR_RESET_ADD_FAIL          31
 801 #define SCTP_NOTIFY_STR_RESET_INSTREAM_ADD_OK   32
 802 #define SCTP_NOTIFY_MAX                         32
 803
 804
 805 /* This is the value for messages that are NOT completely
 806  * copied down where we will start to split the message.
 807  * So, with our default, we split only if the piece we
 808  * want to take will fill up a full MTU (assuming
 809  * a 1500 byte MTU).
 810  */
 811 #define SCTP_DEFAULT_SPLIT_POINT_MIN 2904
 812
 813 /* ABORT CODES and other tell-tale location
 814  * codes are generated by adding the below
 815  * to the instance id.
 816  */
 817
 818 /* File defines */
 819 #define SCTP_FROM_SCTP_INPUT   0x10000000
 820 #define SCTP_FROM_SCTP_PCB     0x20000000
 821 #define SCTP_FROM_SCTP_INDATA  0x30000000
 822 #define SCTP_FROM_SCTP_TIMER   0x40000000
 823 #define SCTP_FROM_SCTP_USRREQ  0x50000000
 824 #define SCTP_FROM_SCTPUTIL     0x60000000
 825 #define SCTP_FROM_SCTP6_USRREQ 0x70000000
 826 #define SCTP_FROM_SCTP_ASCONF  0x80000000
 827 #define SCTP_FROM_SCTP_OUTPUT  0x90000000
 828 #define SCTP_FROM_SCTP_PEELOFF 0xa0000000
 829 #define SCTP_FROM_SCTP_PANDA   0xb0000000
 830 #define SCTP_FROM_SCTP_SYSCTL  0xc0000000
 831
 832 /* Location ID's */
 833 #define SCTP_LOC_1  0x00000001
 834 #define SCTP_LOC_2  0x00000002
 835 #define SCTP_LOC_3  0x00000003
 836 #define SCTP_LOC_4  0x00000004
 837 #define SCTP_LOC_5  0x00000005
 838 #define SCTP_LOC_6  0x00000006
 839 #define SCTP_LOC_7  0x00000007
 840 #define SCTP_LOC_8  0x00000008
 841 #define SCTP_LOC_9  0x00000009
 842 #define SCTP_LOC_10 0x0000000a
 843 #define SCTP_LOC_11 0x0000000b
 844 #define SCTP_LOC_12 0x0000000c
 845 #define SCTP_LOC_13 0x0000000d
 846 #define SCTP_LOC_14 0x0000000e
 847 #define SCTP_LOC_15 0x0000000f
 848 #define SCTP_LOC_16 0x00000010
 849 #define SCTP_LOC_17 0x00000011
 850 #define SCTP_LOC_18 0x00000012
 851 #define SCTP_LOC_19 0x00000013
 852 #define SCTP_LOC_20 0x00000014
 853 #define SCTP_LOC_21 0x00000015
 854 #define SCTP_LOC_22 0x00000016
 855 #define SCTP_LOC_23 0x00000017
 856 #define SCTP_LOC_24 0x00000018
 857 #define SCTP_LOC_25 0x00000019
 858 #define SCTP_LOC_26 0x0000001a
 859 #define SCTP_LOC_27 0x0000001b
 860 #define SCTP_LOC_28 0x0000001c
 861 #define SCTP_LOC_29 0x0000001d
 862 #define SCTP_LOC_30 0x0000001e
 863 #define SCTP_LOC_31 0x0000001f
 864 #define SCTP_LOC_32 0x00000020
 865 #define SCTP_LOC_33 0x00000021
 866
 867
 868 /* Free assoc codes */
 869 #define SCTP_NORMAL_PROC      0
 870 #define SCTP_PCBFREE_NOFORCE  1
 871 #define SCTP_PCBFREE_FORCE    2
 872
 873 /* From codes for adding addresses */
 874 #define SCTP_ADDR_IS_CONFIRMED 8
 875 #define SCTP_ADDR_DYNAMIC_ADDED 6
 876 #define SCTP_IN_COOKIE_PROC 100
 877 #define SCTP_ALLOC_ASOC  1
 878 #define SCTP_LOAD_ADDR_2 2
 879 #define SCTP_LOAD_ADDR_3 3
 880 #define SCTP_LOAD_ADDR_4 4
 881 #define SCTP_LOAD_ADDR_5 5
 882
 883 #define SCTP_DONOT_SETSCOPE 0
 884 #define SCTP_DO_SETSCOPE 1
 885
 886
 887 /* This value determines the default for when
 888  * we try to add more on the send queue., if
 889  * there is room. This prevents us from cycling
 890  * into the copy_resume routine to often if
 891  * we have not got enough space to add a decent
 892  * enough size message. Note that if we have enough
 893  * space to complete the message copy we will always
 894  * add to the message, no matter what the size. Its
 895  * only when we reach the point that we have some left
 896  * to add, there is only room for part of it that we
 897  * will use this threshold. Its also a sysctl.
 898  */
 899 #define SCTP_DEFAULT_ADD_MORE 1452
 900
 901 #ifndef SCTP_PCBHASHSIZE
 902 /* default number of association hash buckets in each endpoint */
 903 #define SCTP_PCBHASHSIZE 256
 904 #endif
 905 #ifndef SCTP_TCBHASHSIZE
 906 #define SCTP_TCBHASHSIZE 1024
 907 #endif
 908
 909 #ifndef SCTP_CHUNKQUEUE_SCALE
 910 #define SCTP_CHUNKQUEUE_SCALE 10
 911 #endif
 912
 913 /* clock variance is 1 ms */
 914 #define SCTP_CLOCK_GRANULARITY  1
 915 #define IP_HDR_SIZE 40          /* we use the size of a IP6 header here this
 916                                  * detracts a small amount for ipv4 but it
 917                                  * simplifies the ipv6 addition */
 918
 919 /* Argument magic number for sctp_inpcb_free() */
 920
 921 /* third argument */
 922 #define SCTP_CALLED_DIRECTLY_NOCMPSET     0
 923 #define SCTP_CALLED_AFTER_CMPSET_OFCLOSE  1
 924
 925 /* second argument */
 926 #define SCTP_FREE_SHOULD_USE_ABORT          1
 927 #define SCTP_FREE_SHOULD_USE_GRACEFUL_CLOSE 0
 928
 929 #ifndef IPPROTO_SCTP
 930 #define IPPROTO_SCTP 132        /* the Official IANA number :-) */
 931 #endif                          /* !IPPROTO_SCTP */
 932
 933 #define SCTP_MAX_DATA_BUNDLING          256
 934
 935 /* modular comparison */
 936 /* True if a > b (mod = M) */
 937 #define compare_with_wrap(a, b, M) (((a > b) && ((a - b) < ((M >> 1) + 1))) || \
 938               ((b > a) && ((b - a) > ((M >> 1) + 1))))
 939
 940
 941 /* Mapping array manipulation routines */
 942 #define SCTP_IS_TSN_PRESENT(arry, gap) ((arry[(gap >> 3)] >> (gap & 0x07)) & 0x01)
 943 #define SCTP_SET_TSN_PRESENT(arry, gap) (arry[(gap >> 3)] |= (0x01 << ((gap & 0x07))))
 944 #define SCTP_UNSET_TSN_PRESENT(arry, gap) (arry[(gap >> 3)] &= ((~(0x01 << ((gap & 0x07)))) & 0xff))
 945
 946
 947 #define SCTP_RETRAN_DONE -1
 948 #define SCTP_RETRAN_EXIT -2
 949
 950 /*
 951  * This value defines the number of vtag block time wait entry's per list
 952  * element.  Each entry will take 2 4 byte ints (and of course the overhead
 953  * of the next pointer as well). Using 15 as an example will yield * ((8 *
 954  * 15) + 8) or 128 bytes of overhead for each timewait block that gets
 955  * initialized. Increasing it to 31 would yeild 256 bytes per block.
 956  */
 957 #define SCTP_NUMBER_IN_VTAG_BLOCK 15
 958 /*
 959  * If we use the STACK option, we have an array of this size head pointers.
 960  * This array is mod'd the with the size to find which bucket and then all
 961  * entries must be searched to see if the tag is in timed wait. If so we
 962  * reject it.
 963  */
 964 #define SCTP_STACK_VTAG_HASH_SIZE   32
 965
 966 /*
 967  * Number of seconds of time wait for a vtag.
 968  */
 969 #define SCTP_TIME_WAIT 60
 970
 971 /* The system retains a cache of free chunks such to
 972  * cut down on calls the memory allocation system. There
 973  * is a per association limit of free items and a overall
 974  * system limit. If either one gets hit then the resource
 975  * stops being cached.
 976  */
 977
 978 #define SCTP_DEF_ASOC_RESC_LIMIT 10
 979 #define SCTP_DEF_SYSTEM_RESC_LIMIT 1000
 980
 981 /*-
 982  * defines for socket lock states.
 983  * Used by __APPLE__ and SCTP_SO_LOCK_TESTING
 984  */
 985 #define SCTP_SO_LOCKED          1
 986 #define SCTP_SO_NOT_LOCKED      0
 987
 988
 989 #define SCTP_HOLDS_LOCK 1
 990 #define SCTP_NOT_LOCKED 0
 991
 992 /*-
 993  * For address locks, do we hold the lock?
 994  */
 995 #define SCTP_ADDR_LOCKED 1
 996 #define SCTP_ADDR_NOT_LOCKED 0
 997
 998 #define IN4_ISPRIVATE_ADDRESS(a) \
 999    ((((uint8_t *)&(a)->s_addr)[0] == 10) || \
1000     ((((uint8_t *)&(a)->s_addr)[0] == 172) && \
1001      (((uint8_t *)&(a)->s_addr)[1] >= 16) && \
1002      (((uint8_t *)&(a)->s_addr)[1] <= 32)) || \
1003     ((((uint8_t *)&(a)->s_addr)[0] == 192) && \
1004      (((uint8_t *)&(a)->s_addr)[1] == 168)))
1005
1006 #define IN4_ISLOOPBACK_ADDRESS(a) \
1007     ((((uint8_t *)&(a)->s_addr)[0] == 127) && \
1008      (((uint8_t *)&(a)->s_addr)[1] == 0) && \
1009      (((uint8_t *)&(a)->s_addr)[2] == 0) && \
1010      (((uint8_t *)&(a)->s_addr)[3] == 1))
1011
1012
1013 #if defined(_KERNEL)
1014
1015 #define SCTP_GETTIME_TIMEVAL(x) (getmicrouptime(x))
1016 #define SCTP_GETPTIME_TIMEVAL(x)        (microuptime(x))
1017 #endif
1018 /*#if defined(__FreeBSD__) || defined(__APPLE__)*/
1019 /*#define SCTP_GETTIME_TIMEVAL(x) { \*/
1020 /*      (x)->tv_sec = ticks / 1000; \*/
1021 /*      (x)->tv_usec = (ticks % 1000) * 1000; \*/
1022 /*}*/
1023
1024 /*#else*/
1025 /*#define SCTP_GETTIME_TIMEVAL(x)       (microtime(x))*/
1026 /*#endif                                 __FreeBSD__ */
1027
1028 #if defined(_KERNEL) || defined(__Userspace__)
1029 #define sctp_sowwakeup(inp, so) \
1030 do { \
1031         if (inp->sctp_flags & SCTP_PCB_FLAGS_DONT_WAKE) { \
1032                 inp->sctp_flags |= SCTP_PCB_FLAGS_WAKEOUTPUT; \
1033         } else { \
1034                 sowwakeup(so); \
1035         } \
1036 } while (0)
1037
1038 #define sctp_sowwakeup_locked(inp, so) \
1039 do { \
1040         if (inp->sctp_flags & SCTP_PCB_FLAGS_DONT_WAKE) { \
1041                 SOCKBUF_UNLOCK(&((so)->so_snd)); \
1042                 inp->sctp_flags |= SCTP_PCB_FLAGS_WAKEOUTPUT; \
1043         } else { \
1044                 sowwakeup_locked(so); \
1045         } \
1046 } while (0)
1047
1048 #define sctp_sorwakeup(inp, so) \
1049 do { \
1050         if (inp->sctp_flags & SCTP_PCB_FLAGS_DONT_WAKE) { \
1051                 inp->sctp_flags |= SCTP_PCB_FLAGS_WAKEINPUT; \
1052         } else { \
1053                 sorwakeup(so); \
1054         } \
1055 } while (0)
1056
1057 #define sctp_sorwakeup_locked(inp, so) \
1058 do { \
1059         if (inp->sctp_flags & SCTP_PCB_FLAGS_DONT_WAKE) { \
1060                 inp->sctp_flags |= SCTP_PCB_FLAGS_WAKEINPUT; \
1061                 SOCKBUF_UNLOCK(&((so)->so_rcv)); \
1062         } else { \
1063                 sorwakeup_locked(so); \
1064         } \
1065 } while (0)
1066
1067 #endif                          /* _KERNEL || __Userspace__ */
1068 #endif