1 /*- 2 * Copyright (c) 2001-2006, 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 #if defined(_KERNEL) 40 #include <sys/kernel.h> 41 #endif 42 43 44 #define SCTP_VERSION_STRING "KAME-BSD 1.1" 45 /* #define SCTP_AUDITING_ENABLED 1 used for debug/auditing */ 46 #define SCTP_AUDIT_SIZE 256 47 #define SCTP_STAT_LOG_SIZE 80000 48 49 /* Places that CWND log can happen from */ 50 #define SCTP_CWND_LOG_FROM_FR 1 51 #define SCTP_CWND_LOG_FROM_RTX 2 52 #define SCTP_CWND_LOG_FROM_BRST 3 53 #define SCTP_CWND_LOG_FROM_SS 4 54 #define SCTP_CWND_LOG_FROM_CA 5 55 #define SCTP_CWND_LOG_FROM_SAT 6 56 #define SCTP_BLOCK_LOG_INTO_BLK 7 57 #define SCTP_BLOCK_LOG_OUTOF_BLK 8 58 #define SCTP_BLOCK_LOG_CHECK 9 59 #define SCTP_STR_LOG_FROM_INTO_STRD 10 60 #define SCTP_STR_LOG_FROM_IMMED_DEL 11 61 #define SCTP_STR_LOG_FROM_INSERT_HD 12 62 #define SCTP_STR_LOG_FROM_INSERT_MD 13 63 #define SCTP_STR_LOG_FROM_INSERT_TL 14 64 #define SCTP_STR_LOG_FROM_MARK_TSN 15 65 #define SCTP_STR_LOG_FROM_EXPRS_DEL 16 66 #define SCTP_FR_LOG_BIGGEST_TSNS 17 67 #define SCTP_FR_LOG_STRIKE_TEST 18 68 #define SCTP_FR_LOG_STRIKE_CHUNK 19 69 #define SCTP_FR_T3_TIMEOUT 20 70 #define SCTP_MAP_PREPARE_SLIDE 21 71 #define SCTP_MAP_SLIDE_FROM 22 72 #define SCTP_MAP_SLIDE_RESULT 23 73 #define SCTP_MAP_SLIDE_CLEARED 24 74 #define SCTP_MAP_SLIDE_NONE 25 75 #define SCTP_FR_T3_MARK_TIME 26 76 #define SCTP_FR_T3_MARKED 27 77 #define SCTP_FR_T3_STOPPED 28 78 #define SCTP_FR_MARKED 30 79 #define SCTP_CWND_LOG_NOADV_SS 31 80 #define SCTP_CWND_LOG_NOADV_CA 32 81 #define SCTP_MAX_BURST_APPLIED 33 82 #define SCTP_MAX_IFP_APPLIED 34 83 #define SCTP_MAX_BURST_ERROR_STOP 35 84 #define SCTP_INCREASE_PEER_RWND 36 85 #define SCTP_DECREASE_PEER_RWND 37 86 #define SCTP_SET_PEER_RWND_VIA_SACK 38 87 #define SCTP_LOG_MBCNT_INCREASE 39 88 #define SCTP_LOG_MBCNT_DECREASE 40 89 #define SCTP_LOG_MBCNT_CHKSET 41 90 #define SCTP_LOG_NEW_SACK 42 91 #define SCTP_LOG_TSN_ACKED 43 92 #define SCTP_LOG_TSN_REVOKED 44 93 #define SCTP_LOG_LOCK_TCB 45 94 #define SCTP_LOG_LOCK_INP 46 95 #define SCTP_LOG_LOCK_SOCK 47 96 #define SCTP_LOG_LOCK_SOCKBUF_R 48 97 #define SCTP_LOG_LOCK_SOCKBUF_S 49 98 #define SCTP_LOG_LOCK_CREATE 50 99 #define SCTP_LOG_INITIAL_RTT 51 100 #define SCTP_LOG_RTTVAR 52 101 #define SCTP_LOG_SBALLOC 53 102 #define SCTP_LOG_SBFREE 54 103 #define SCTP_LOG_SBRESULT 55 104 #define SCTP_FR_DUPED 56 105 #define SCTP_FR_MARKED_EARLY 57 106 #define SCTP_FR_CWND_REPORT 58 107 #define SCTP_FR_CWND_REPORT_START 59 108 #define SCTP_FR_CWND_REPORT_STOP 60 109 #define SCTP_CWND_LOG_FROM_SEND 61 110 #define SCTP_CWND_INITIALIZATION 62 111 #define SCTP_CWND_LOG_FROM_T3 63 112 #define SCTP_CWND_LOG_FROM_SACK 64 113 #define SCTP_CWND_LOG_NO_CUMACK 65 114 #define SCTP_CWND_LOG_FROM_RESEND 66 115 #define SCTP_FR_LOG_CHECK_STRIKE 67 116 #define SCTP_SEND_NOW_COMPLETES 68 117 #define SCTP_CWND_LOG_FILL_OUTQ_CALLED 69 118 #define SCTP_CWND_LOG_FILL_OUTQ_FILLS 70 119 #define SCTP_LOG_FREE_SENT 71 120 #define SCTP_NAGLE_APPLIED 72 121 #define SCTP_NAGLE_SKIPPED 73 122 #define SCTP_WAKESND_FROM_SACK 74 123 #define SCTP_WAKESND_FROM_FWDTSN 75 124 #define SCTP_NOWAKE_FROM_SACK 76 125 #define SCTP_CWNDLOG_PRESEND 77 126 #define SCTP_CWNDLOG_ENDSEND 78 127 #define SCTP_AT_END_OF_SACK 79 128 #define SCTP_REASON_FOR_SC 80 129 #define SCTP_BLOCK_LOG_INTO_BLKA 81 130 #define SCTP_ENTER_USER_RECV 82 131 #define SCTP_USER_RECV_SACKS 83 132 #define SCTP_SORECV_BLOCKSA 84 133 #define SCTP_SORECV_BLOCKSB 85 134 #define SCTP_SORECV_DONE 86 135 #define SCTP_SACK_RWND_UPDATE 87 136 #define SCTP_SORECV_ENTER 88 137 #define SCTP_SORECV_ENTERPL 89 138 #define SCTP_MBUF_INPUT 90 139 #define SCTP_MBUF_IALLOC 91 140 #define SCTP_MBUF_IFREE 92 141 #define SCTP_MBUF_ICOPY 93 142 #define SCTP_SORCV_FREECTL 94 143 #define SCTP_SORCV_DOESCPY 95 144 #define SCTP_SORCV_DOESLCK 96 145 #define SCTP_SORCV_DOESADJ 97 146 #define SCTP_SORCV_BOTWHILE 98 147 #define SCTP_SORCV_PASSBF 99 148 #define SCTP_SORCV_ADJD 100 149 #define SCTP_UNKNOWN_MAX 101 150 #define SCTP_RANDY_STUFF 102 151 #define SCTP_RANDY_STUFF1 103 152 #define SCTP_STRMOUT_LOG_ASSIGN 104 153 #define SCTP_STRMOUT_LOG_SEND 105 154 155 #define SCTP_LOG_MAX_TYPES 106 156 /* 157 * To turn on various logging, you must first define SCTP_STAT_LOGGING. Then 158 * to get something to log you define one of the logging defines i.e. 159 * 160 * SCTP_CWND_LOGGING SCTP_BLK_LOGGING SCTP_STR_LOGGING SCTP_FR_LOGGING 161 * 162 * Any one or a combination of the logging can be turned on. 163 */ 164 #define SCTP_LOG_EVENT_UNKNOWN 0 165 #define SCTP_LOG_EVENT_CWND 1 166 #define SCTP_LOG_EVENT_BLOCK 2 167 #define SCTP_LOG_EVENT_STRM 3 168 #define SCTP_LOG_EVENT_FR 4 169 #define SCTP_LOG_EVENT_MAP 5 170 #define SCTP_LOG_EVENT_MAXBURST 6 171 #define SCTP_LOG_EVENT_RWND 7 172 #define SCTP_LOG_EVENT_MBCNT 8 173 #define SCTP_LOG_EVENT_SACK 9 174 #define SCTP_LOG_LOCK_EVENT 10 175 #define SCTP_LOG_EVENT_RTT 11 176 #define SCTP_LOG_EVENT_SB 12 177 #define SCTP_LOG_EVENT_NAGLE 13 178 #define SCTP_LOG_EVENT_WAKE 14 179 #define SCTP_LOG_MISC_EVENT 15 180 #define SCTP_LOG_EVENT_CLOSE 16 181 #define SCTP_LOG_EVENT_MBUF 17 182 183 #define SCTP_LOG_MAX_EVENT 18 184 185 #define SCTP_LOCK_UNKNOWN 2 186 187 188 /* number of associations by default for zone allocation */ 189 #define SCTP_MAX_NUM_OF_ASOC 40000 190 /* how many addresses per assoc remote and local */ 191 #define SCTP_SCALE_FOR_ADDR 2 192 193 /* default AUTO_ASCONF mode enable(1)/disable(0) value (sysctl) */ 194 #define SCTP_DEFAULT_AUTO_ASCONF 0 195 196 /* 197 * Theshold for rwnd updates, we have to read (sb_hiwat >> 198 * SCTP_RWND_HIWAT_SHIFT) before we will look to see if we need to send a 199 * window update sack. When we look, we compare the last rwnd we sent vs the 200 * current rwnd. It too must be greater than this value. Using 3 divdes the 201 * hiwat by 8, so for 200k rwnd we need to read 24k. For a 64k rwnd we need 202 * to read 8k. This seems about right.. I hope :-D.. we do set a 203 * min of a MTU on it so if the rwnd is real small we will insist 204 * on a full MTU of 1500 bytes. 205 */ 206 #define SCTP_RWND_HIWAT_SHIFT 3 207 208 /* How much of the rwnd must the 209 * message be taking up to start partial delivery. 210 * We calculate this by shifing the hi_water (recv_win) 211 * left the following .. set to 1, when a message holds 212 * 1/2 the rwnd. If we set it to 2 when a message holds 213 * 1/4 the rwnd...etc.. 214 */ 215 216 #define SCTP_PARTIAL_DELIVERY_SHIFT 1 217 218 /* Minimum number of bytes read by user before we 219 * condsider doing a rwnd update 220 */ 221 #define SCTP_MIN_READ_BEFORE_CONSIDERING 3000 222 223 /* 224 * default HMAC for cookies, etc... use one of the AUTH HMAC id's 225 * SCTP_HMAC is the HMAC_ID to use 226 * SCTP_SIGNATURE_SIZE is the digest length 227 */ 228 #define SCTP_HMAC SCTP_AUTH_HMAC_ID_SHA1 229 #define SCTP_SIGNATURE_SIZE SCTP_AUTH_DIGEST_LEN_SHA1 230 #define SCTP_SIGNATURE_ALOC_SIZE SCTP_SIGNATURE_SIZE 231 232 /* DEFINE HERE WHAT CRC YOU WANT TO USE */ 233 #define SCTP_USECRC_RFC2960 1 234 /* #define SCTP_USECRC_FLETCHER 1 */ 235 /* #define SCTP_USECRC_SSHCRC32 1 */ 236 /* #define SCTP_USECRC_FASTCRC32 1 */ 237 /* #define SCTP_USECRC_CRC32 1 */ 238 /* #define SCTP_USECRC_TCP32 1 */ 239 /* #define SCTP_USECRC_CRC16SMAL 1 */ 240 /* #define SCTP_USECRC_CRC16 1 */ 241 /* #define SCTP_USECRC_MODADLER 1 */ 242 243 #ifndef SCTP_ADLER32_BASE 244 #define SCTP_ADLER32_BASE 65521 245 #endif 246 247 /* 248 * the SCTP protocol signature this includes the version number encoded in 249 * the last 4 bits of the signature. 250 */ 251 #define PROTO_SIGNATURE_A 0x30000000 252 #define SCTP_VERSION_NUMBER 0x3 253 254 #define MAX_TSN 0xffffffff 255 #define MAX_SEQ 0xffff 256 257 /* how many executions every N tick's */ 258 #define SCTP_ITERATOR_MAX_AT_ONCE 20 259 260 /* number of clock ticks between iterator executions */ 261 #define SCTP_ITERATOR_TICKS 1 262 263 /* 264 * option: If you comment out the following you will receive the old behavior 265 * of obeying cwnd for the fast retransmit algorithm. With this defined a FR 266 * happens right away with-out waiting for the flightsize to drop below the 267 * cwnd value (which is reduced by the FR to 1/2 the inflight packets). 268 */ 269 #define SCTP_IGNORE_CWND_ON_FR 1 270 271 /* 272 * Adds implementors guide behavior to only use newest highest update in SACK 273 * gap ack's to figure out if you need to stroke a chunk for FR. 274 */ 275 #define SCTP_NO_FR_UNLESS_SEGMENT_SMALLER 1 276 277 /* default max I can burst out after a fast retransmit */ 278 #define SCTP_DEF_MAX_BURST 4 279 /* IP hdr (20/40) + 12+2+2 (enet) + sctp common 12 */ 280 #define SCTP_FIRST_MBUF_RESV 68 281 /* Packet transmit states in the sent field */ 282 #define SCTP_DATAGRAM_UNSENT 0 283 #define SCTP_DATAGRAM_SENT 1 284 #define SCTP_DATAGRAM_RESEND1 2 /* not used (in code, but may 285 * hit this value) */ 286 #define SCTP_DATAGRAM_RESEND2 3 /* not used (in code, but may 287 * hit this value) */ 288 #define SCTP_DATAGRAM_RESEND 4 289 #define SCTP_DATAGRAM_ACKED 10010 290 #define SCTP_DATAGRAM_INBOUND 10011 291 #define SCTP_READY_TO_TRANSMIT 10012 292 #define SCTP_DATAGRAM_MARKED 20010 293 #define SCTP_FORWARD_TSN_SKIP 30010 294 295 /* chunk output send from locations */ 296 #define SCTP_OUTPUT_FROM_USR_SEND 0 297 #define SCTP_OUTPUT_FROM_T3 1 298 #define SCTP_OUTPUT_FROM_INPUT_ERROR 2 299 #define SCTP_OUTPUT_FROM_CONTROL_PROC 3 300 #define SCTP_OUTPUT_FROM_SACK_TMR 4 301 #define SCTP_OUTPUT_FROM_SHUT_TMR 5 302 #define SCTP_OUTPUT_FROM_HB_TMR 6 303 #define SCTP_OUTPUT_FROM_SHUT_ACK_TMR 7 304 #define SCTP_OUTPUT_FROM_ASCONF_TMR 8 305 #define SCTP_OUTPUT_FROM_STRRST_TMR 9 306 #define SCTP_OUTPUT_FROM_AUTOCLOSE_TMR 10 307 #define SCTP_OUTPUT_FROM_EARLY_FR_TMR 11 308 #define SCTP_OUTPUT_FROM_STRRST_REQ 12 309 #define SCTP_OUTPUT_FROM_USR_RCVD 13 310 #define SCTP_OUTPUT_FROM_COOKIE_ACK 14 311 /* SCTP chunk types are moved sctp.h for application (NAT, FW) use */ 312 313 /* align to 32-bit sizes */ 314 #define SCTP_SIZE32(x) ((((x)+3) >> 2) << 2) 315 316 #define IS_SCTP_CONTROL(a) ((a)->chunk_type != SCTP_DATA) 317 #define IS_SCTP_DATA(a) ((a)->chunk_type == SCTP_DATA) 318 319 320 /* SCTP parameter types */ 321 /*************0x0000 series*************/ 322 #define SCTP_HEARTBEAT_INFO 0x0001 323 #define SCTP_IPV4_ADDRESS 0x0005 324 #define SCTP_IPV6_ADDRESS 0x0006 325 #define SCTP_STATE_COOKIE 0x0007 326 #define SCTP_UNRECOG_PARAM 0x0008 327 #define SCTP_COOKIE_PRESERVE 0x0009 328 #define SCTP_HOSTNAME_ADDRESS 0x000b 329 #define SCTP_SUPPORTED_ADDRTYPE 0x000c 330 331 /* draft-ietf-stewart-strreset-xxx */ 332 #define SCTP_STR_RESET_OUT_REQUEST 0x000d 333 #define SCTP_STR_RESET_IN_REQUEST 0x000e 334 #define SCTP_STR_RESET_TSN_REQUEST 0x000f 335 #define SCTP_STR_RESET_RESPONSE 0x0010 336 337 #define SCTP_MAX_RESET_PARAMS 2 338 #define SCTP_STREAM_RESET_TSN_DELTA 0x1000 339 340 /*************0x4000 series*************/ 341 342 /*************0x8000 series*************/ 343 #define SCTP_ECN_CAPABLE 0x8000 344 /* ECN Nonce: draft-ladha-sctp-ecn-nonce */ 345 #define SCTP_ECN_NONCE_SUPPORTED 0x8001 346 /* draft-ietf-tsvwg-auth-xxx */ 347 #define SCTP_RANDOM 0x8002 348 #define SCTP_CHUNK_LIST 0x8003 349 #define SCTP_HMAC_LIST 0x8004 350 /* 351 * draft-ietf-tsvwg-addip-sctp-xx param=0x8008 len=0xNNNN Byte | Byte | Byte 352 * | Byte Byte | Byte ... 353 * 354 * Where each byte is a chunk type extension supported. For example, to support 355 * all chunks one would have (in hex): 356 * 357 * 80 01 00 09 C0 C1 80 81 82 00 00 00 358 * 359 * Has the parameter. C0 = PR-SCTP (RFC3758) C1, 80 = ASCONF (addip draft) 81 360 * = Packet Drop 82 = Stream Reset 83 = Authentication 361 */ 362 #define SCTP_SUPPORTED_CHUNK_EXT 0x8008 363 364 /*************0xC000 series*************/ 365 #define SCTP_PRSCTP_SUPPORTED 0xc000 366 /* draft-ietf-tsvwg-addip-sctp */ 367 #define SCTP_ADD_IP_ADDRESS 0xc001 368 #define SCTP_DEL_IP_ADDRESS 0xc002 369 #define SCTP_ERROR_CAUSE_IND 0xc003 370 #define SCTP_SET_PRIM_ADDR 0xc004 371 #define SCTP_SUCCESS_REPORT 0xc005 372 #define SCTP_ULP_ADAPTATION 0xc006 373 374 /* Notification error codes */ 375 #define SCTP_NOTIFY_DATAGRAM_UNSENT 0x0001 376 #define SCTP_NOTIFY_DATAGRAM_SENT 0x0002 377 #define SCTP_FAILED_THRESHOLD 0x0004 378 #define SCTP_HEARTBEAT_SUCCESS 0x0008 379 #define SCTP_RESPONSE_TO_USER_REQ 0x000f 380 #define SCTP_INTERNAL_ERROR 0x0010 381 #define SCTP_SHUTDOWN_GUARD_EXPIRES 0x0020 382 #define SCTP_RECEIVED_SACK 0x0040 383 #define SCTP_PEER_FAULTY 0x0080 384 385 /* bits for TOS field */ 386 #define SCTP_ECT0_BIT 0x02 387 #define SCTP_ECT1_BIT 0x01 388 #define SCTP_CE_BITS 0x03 389 390 /* below turns off above */ 391 #define SCTP_FLEXIBLE_ADDRESS 0x20 392 #define SCTP_NO_HEARTBEAT 0x40 393 394 /* mask to get sticky */ 395 #define SCTP_STICKY_OPTIONS_MASK 0x0c 396 397 398 /* Chunk flags */ 399 #define SCTP_WINDOW_PROBE 0x01 400 401 /* 402 * SCTP states for internal state machine XXX (should match "user" values) 403 */ 404 #define SCTP_STATE_EMPTY 0x0000 405 #define SCTP_STATE_INUSE 0x0001 406 #define SCTP_STATE_COOKIE_WAIT 0x0002 407 #define SCTP_STATE_COOKIE_ECHOED 0x0004 408 #define SCTP_STATE_OPEN 0x0008 409 #define SCTP_STATE_SHUTDOWN_SENT 0x0010 410 #define SCTP_STATE_SHUTDOWN_RECEIVED 0x0020 411 #define SCTP_STATE_SHUTDOWN_ACK_SENT 0x0040 412 #define SCTP_STATE_SHUTDOWN_PENDING 0x0080 413 #define SCTP_STATE_CLOSED_SOCKET 0x0100 414 #define SCTP_STATE_ABOUT_TO_BE_FREED 0x0200 415 #define SCTP_STATE_PARTIAL_MSG_LEFT 0x0400 416 #define SCTP_STATE_MASK 0x007f 417 418 #define SCTP_GET_STATE(asoc) ((asoc)->state & SCTP_STATE_MASK) 419 420 /* SCTP reachability state for each address */ 421 #define SCTP_ADDR_REACHABLE 0x001 422 #define SCTP_ADDR_NOT_REACHABLE 0x002 423 #define SCTP_ADDR_NOHB 0x004 424 #define SCTP_ADDR_BEING_DELETED 0x008 425 #define SCTP_ADDR_NOT_IN_ASSOC 0x010 426 #define SCTP_ADDR_WAS_PRIMARY 0x020 427 #define SCTP_ADDR_SWITCH_PRIMARY 0x040 428 #define SCTP_ADDR_OUT_OF_SCOPE 0x080 429 #define SCTP_ADDR_DOUBLE_SWITCH 0x100 430 #define SCTP_ADDR_UNCONFIRMED 0x200 431 432 #define SCTP_REACHABLE_MASK 0x203 433 434 /* bound address types (e.g. valid address types to allow) */ 435 #define SCTP_BOUND_V6 0x01 436 #define SCTP_BOUND_V4 0x02 437 438 /* 439 * what is the default number of mbufs in a chain I allow before switching to 440 * a cluster 441 */ 442 #define SCTP_DEFAULT_MBUFS_IN_CHAIN 5 443 444 /* How long a cookie lives in seconds */ 445 #define SCTP_DEFAULT_COOKIE_LIFE 60 446 447 /* resource limit of streams */ 448 #define MAX_SCTP_STREAMS 2048 449 450 /* Maximum the mapping array will grow to (TSN mapping array) */ 451 #define SCTP_MAPPING_ARRAY 512 452 453 /* size of the inital malloc on the mapping array */ 454 #define SCTP_INITIAL_MAPPING_ARRAY 16 455 /* how much we grow the mapping array each call */ 456 #define SCTP_MAPPING_ARRAY_INCR 32 457 458 /* 459 * Here we define the timer types used by the implementation as arguments in 460 * the set/get timer type calls. 461 */ 462 #define SCTP_TIMER_INIT 0 463 #define SCTP_TIMER_RECV 1 464 #define SCTP_TIMER_SEND 2 465 #define SCTP_TIMER_HEARTBEAT 3 466 #define SCTP_TIMER_PMTU 4 467 #define SCTP_TIMER_MAXSHUTDOWN 5 468 #define SCTP_TIMER_SIGNATURE 6 469 /* 470 * number of timer types in the base SCTP structure used in the set/get and 471 * has the base default. 472 */ 473 #define SCTP_NUM_TMRS 7 474 475 /* timer types */ 476 #define SCTP_TIMER_TYPE_NONE 0 477 #define SCTP_TIMER_TYPE_SEND 1 478 #define SCTP_TIMER_TYPE_INIT 2 479 #define SCTP_TIMER_TYPE_RECV 3 480 #define SCTP_TIMER_TYPE_SHUTDOWN 4 481 #define SCTP_TIMER_TYPE_HEARTBEAT 5 482 #define SCTP_TIMER_TYPE_COOKIE 6 483 #define SCTP_TIMER_TYPE_NEWCOOKIE 7 484 #define SCTP_TIMER_TYPE_PATHMTURAISE 8 485 #define SCTP_TIMER_TYPE_SHUTDOWNACK 9 486 #define SCTP_TIMER_TYPE_ASCONF 10 487 #define SCTP_TIMER_TYPE_SHUTDOWNGUARD 11 488 #define SCTP_TIMER_TYPE_AUTOCLOSE 12 489 #define SCTP_TIMER_TYPE_EVENTWAKE 13 490 #define SCTP_TIMER_TYPE_STRRESET 14 491 #define SCTP_TIMER_TYPE_INPKILL 15 492 #define SCTP_TIMER_TYPE_ITERATOR 16 493 #define SCTP_TIMER_TYPE_EARLYFR 17 494 #define SCTP_TIMER_TYPE_ASOCKILL 18 495 #define SCTP_TIMER_TYPE_ADDR_WQ 19 496 /* add new timers here - and increment LAST */ 497 #define SCTP_TIMER_TYPE_LAST 20 498 499 #define SCTP_IS_TIMER_TYPE_VALID(t) (((t) > SCTP_TIMER_TYPE_NONE) && \ 500 ((t) < SCTP_TIMER_TYPE_LAST)) 501 502 503 504 /* 505 * Number of ticks before the soxwakeup() event that is delayed is sent AFTER 506 * the accept() call 507 */ 508 #define SCTP_EVENTWAKEUP_WAIT_TICKS 3000 509 510 /* 511 * Of course we really don't collect stale cookies, being folks of decerning 512 * taste. However we do count them, if we get too many before the association 513 * comes up.. we give up. Below is the constant that dictates when we give it 514 * up...this is a implemenation dependent treatment. In ours we do not ask 515 * for a extension of time, but just retry this many times... 516 */ 517 #define SCTP_MAX_STALE_COOKIES_I_COLLECT 10 518 519 /* max number of TSN's dup'd that I will hold */ 520 #define SCTP_MAX_DUP_TSNS 20 521 522 /* 523 * Here we define the types used when setting the retry amounts. 524 */ 525 /* constants for type of set */ 526 #define SCTP_MAXATTEMPT_INIT 2 527 #define SCTP_MAXATTEMPT_SEND 3 528 529 /* Maximum TSN's we will summarize in a drop report */ 530 #define SCTP_MAX_DROP_REPORT 16 531 532 /* How many drop re-attempts we make on INIT/COOKIE-ECHO */ 533 #define SCTP_RETRY_DROPPED_THRESH 4 534 535 /* 536 * And the max we will keep a history of in the tcb which MUST be lower than 537 * 256. 538 */ 539 #define SCTP_MAX_DROP_SAVE_REPORT 16 540 541 /* 542 * Here we define the default timers and the default number of attemts we 543 * make for each respective side (send/init). 544 */ 545 546 /* 547 * Maxmium number of chunks a single association can have on it. Note that 548 * this is a squishy number since the count can run over this if the user 549 * sends a large message down .. the fragmented chunks don't count until 550 * AFTER the message is on queue.. it would be the next send that blocks 551 * things. This number will get tuned up at boot in the sctp_init and use the 552 * number of clusters as a base. This way high bandwidth environments will 553 * not get impacted by the lower bandwidth sending a bunch of 1 byte chunks 554 */ 555 #define SCTP_ASOC_MAX_CHUNKS_ON_QUEUE 512 556 557 #define MSEC_TO_TICKS(x) ((hz == 1000) ? x : (((x) * hz) / 1000)) 558 #define TICKS_TO_MSEC(x) ((hz == 1000) ? x : (((x) * 1000) / hz)); 559 560 #define SEC_TO_TICKS(x) ((x) * hz) 561 #define TICKS_TO_SEC(x) ((x) / hz) 562 563 /* 564 * Basically the minimum amount of time before I do a early FR. Making this 565 * value to low will cause duplicate retransmissions. 566 */ 567 #define SCTP_MINFR_MSEC_TIMER 250 568 /* The floor this value is allowed to fall to when starting a timer. */ 569 #define SCTP_MINFR_MSEC_FLOOR 20 570 571 /* init timer def = 1 sec */ 572 #define SCTP_INIT_SEC 1 573 574 /* send timer def = 1 seconds */ 575 #define SCTP_SEND_SEC 1 576 577 /* recv timer def = 200ms */ 578 #define SCTP_RECV_MSEC 200 579 580 /* 30 seconds + RTO (in ms) */ 581 #define SCTP_HB_DEFAULT_MSEC 30000 582 583 /* Max time I will wait for Shutdown to complete */ 584 #define SCTP_DEF_MAX_SHUTDOWN_SEC 180 585 586 587 /* 588 * This is how long a secret lives, NOT how long a cookie lives how many 589 * ticks the current secret will live. 590 */ 591 #define SCTP_DEFAULT_SECRET_LIFE_SEC 3600 592 593 #define SCTP_RTO_UPPER_BOUND (60000) /* 60 sec in ms */ 594 #define SCTP_RTO_UPPER_BOUND_SEC 60 /* for the init timer */ 595 #define SCTP_RTO_LOWER_BOUND (1000) /* 1 sec in ms */ 596 #define SCTP_RTO_INITIAL (3000) /* 3 sec in ms */ 597 598 599 #define SCTP_INP_KILL_TIMEOUT 20/* number of ms to retry kill of inpcb */ 600 #define SCTP_ASOC_KILL_TIMEOUT 10 /* number of ms to retry kill of inpcb */ 601 602 #define SCTP_DEF_MAX_INIT 8 603 #define SCTP_DEF_MAX_SEND 10 604 #define SCTP_DEF_MAX_PATH_RTX 4 605 606 #define SCTP_DEF_PMTU_RAISE_SEC 600 /* 10 min between raise attempts */ 607 #define SCTP_DEF_PMTU_MIN 600 608 609 #define SCTP_MSEC_IN_A_SEC 1000 610 #define SCTP_USEC_IN_A_SEC 1000000 611 #define SCTP_NSEC_IN_A_SEC 1000000000 612 613 #define SCTP_MAX_OUTSTANDING_DG 10000 614 615 /* How many streams I request initally by default */ 616 #define SCTP_OSTREAM_INITIAL 10 617 618 /* 619 * How many smallest_mtu's need to increase before a window update sack is 620 * sent (should be a power of 2). 621 */ 622 #define SCTP_SEG_TO_RWND_UPD 32 623 /* Send window update (incr * this > hiwat). Should be a power of 2 */ 624 #define SCTP_SCALE_OF_RWND_TO_UPD 4 625 #define SCTP_MINIMAL_RWND (4096) /* minimal rwnd */ 626 627 #define SCTP_ADDRMAX 20 628 629 /* SCTP DEBUG Switch parameters */ 630 #define SCTP_DEBUG_TIMER1 0x00000001 631 #define SCTP_DEBUG_TIMER2 0x00000002 632 #define SCTP_DEBUG_TIMER3 0x00000004 633 #define SCTP_DEBUG_TIMER4 0x00000008 634 #define SCTP_DEBUG_OUTPUT1 0x00000010 635 #define SCTP_DEBUG_OUTPUT2 0x00000020 636 #define SCTP_DEBUG_OUTPUT3 0x00000040 637 #define SCTP_DEBUG_OUTPUT4 0x00000080 638 #define SCTP_DEBUG_UTIL1 0x00000100 639 #define SCTP_DEBUG_UTIL2 0x00000200 640 #define SCTP_DEBUG_AUTH1 0x00000400 641 #define SCTP_DEBUG_AUTH2 0x00000800 642 #define SCTP_DEBUG_INPUT1 0x00001000 643 #define SCTP_DEBUG_INPUT2 0x00002000 644 #define SCTP_DEBUG_INPUT3 0x00004000 645 #define SCTP_DEBUG_INPUT4 0x00008000 646 #define SCTP_DEBUG_ASCONF1 0x00010000 647 #define SCTP_DEBUG_ASCONF2 0x00020000 648 #define SCTP_DEBUG_OUTPUT5 0x00040000 649 #define SCTP_DEBUG_XXX 0x00080000 650 #define SCTP_DEBUG_PCB1 0x00100000 651 #define SCTP_DEBUG_PCB2 0x00200000 652 #define SCTP_DEBUG_PCB3 0x00400000 653 #define SCTP_DEBUG_PCB4 0x00800000 654 #define SCTP_DEBUG_INDATA1 0x01000000 655 #define SCTP_DEBUG_INDATA2 0x02000000 656 #define SCTP_DEBUG_INDATA3 0x04000000 657 #define SCTP_DEBUG_INDATA4 0x08000000 658 #define SCTP_DEBUG_USRREQ1 0x10000000 659 #define SCTP_DEBUG_USRREQ2 0x20000000 660 #define SCTP_DEBUG_PEEL1 0x40000000 661 #define SCTP_DEBUG_XXXXX 0x80000000 662 #define SCTP_DEBUG_ALL 0x7ff3ffff 663 #define SCTP_DEBUG_NOISY 0x00040000 664 665 /* What sender needs to see to avoid SWS or we consider peers rwnd 0 */ 666 #define SCTP_SWS_SENDER_DEF 1420 667 668 /* 669 * SWS is scaled to the sb_hiwat of the socket. A value of 2 is hiwat/4, 1 670 * would be hiwat/2 etc. 671 */ 672 /* What receiver needs to see in sockbuf or we tell peer its 1 */ 673 #define SCTP_SWS_RECEIVER_DEF 3000 674 675 #define SCTP_INITIAL_CWND 4380 676 677 /* amount peer is obligated to have in rwnd or I will abort */ 678 #define SCTP_MIN_RWND 1500 679 680 #define SCTP_WINDOW_MIN 1500 /* smallest rwnd can be */ 681 #define SCTP_WINDOW_MAX 1048576 /* biggest I can grow rwnd to My playing 682 * around suggests a value greater than 64k 683 * does not do much, I guess via the kernel 684 * limitations on the stream/socket. */ 685 686 /* I can handle a 1meg re-assembly */ 687 #define SCTP_DEFAULT_MAXMSGREASM 1048576 688 689 #define SCTP_DEFAULT_MAXSEGMENT 65535 690 691 #define DEFAULT_CHUNK_BUFFER 2048 692 #define DEFAULT_PARAM_BUFFER 512 693 694 #define SCTP_DEFAULT_MINSEGMENT 512 /* MTU size ... if no mtu disc */ 695 #define SCTP_HOW_MANY_SECRETS 2 /* how many secrets I keep */ 696 697 #define SCTP_NUMBER_OF_SECRETS 8 /* or 8 * 4 = 32 octets */ 698 #define SCTP_SECRET_SIZE 32 /* number of octets in a 256 bits */ 699 700 701 /* 702 * SCTP upper layer notifications 703 */ 704 #define SCTP_NOTIFY_ASSOC_UP 1 705 #define SCTP_NOTIFY_ASSOC_DOWN 2 706 #define SCTP_NOTIFY_INTERFACE_DOWN 3 707 #define SCTP_NOTIFY_INTERFACE_UP 4 708 #define SCTP_NOTIFY_DG_FAIL 5 709 #define SCTP_NOTIFY_STRDATA_ERR 6 710 #define SCTP_NOTIFY_ASSOC_ABORTED 7 711 #define SCTP_NOTIFY_PEER_OPENED_STREAM 8 712 #define SCTP_NOTIFY_STREAM_OPENED_OK 9 713 #define SCTP_NOTIFY_ASSOC_RESTART 10 714 #define SCTP_NOTIFY_HB_RESP 11 715 #define SCTP_NOTIFY_ASCONF_SUCCESS 12 716 #define SCTP_NOTIFY_ASCONF_FAILED 13 717 #define SCTP_NOTIFY_PEER_SHUTDOWN 14 718 #define SCTP_NOTIFY_ASCONF_ADD_IP 15 719 #define SCTP_NOTIFY_ASCONF_DELETE_IP 16 720 #define SCTP_NOTIFY_ASCONF_SET_PRIMARY 17 721 #define SCTP_NOTIFY_PARTIAL_DELVIERY_INDICATION 18 722 #define SCTP_NOTIFY_ADAPTATION_INDICATION 19 723 /* same as above */ 724 #define SCTP_NOTIFY_ADAPTION_INDICATION 19 725 #define SCTP_NOTIFY_INTERFACE_CONFIRMED 20 726 #define SCTP_NOTIFY_STR_RESET_RECV 21 727 #define SCTP_NOTIFY_STR_RESET_SEND 22 728 #define SCTP_NOTIFY_STR_RESET_FAILED_OUT 23 729 #define SCTP_NOTIFY_STR_RESET_FAILED_IN 24 730 #define SCTP_NOTIFY_AUTH_NEW_KEY 25 731 #define SCTP_NOTIFY_AUTH_KEY_CONFLICT 26 732 #define SCTP_NOTIFY_SPECIAL_SP_FAIL 27 733 #define SCTP_NOTIFY_MAX 27 734 735 /* This is the value for messages that are NOT completely 736 * copied down where we will start to split the message. 737 * So, with our default, we split only if the piece we 738 * want to take will fill up a full MTU (assuming 739 * a 1500 byte MTU). 740 */ 741 #define SCTP_DEFAULT_SPLIT_POINT_MIN 1452 742 743 /* This value determines the default for when 744 * we try to add more on the send queue., if 745 * there is room. This prevents us from cycling 746 * into the copy_resume routine to often if 747 * we have not got enough space to add a decent 748 * enough size message. Note that if we have enough 749 * space to complete the message copy we will always 750 * add to the message, no matter what the size. Its 751 * only when we reach the point that we have some left 752 * to add, there is only room for part of it that we 753 * will use this threshold. Its also a sysctl. 754 */ 755 #define SCTP_DEFAULT_ADD_MORE 1452 756 757 #ifndef SCTP_PCBHASHSIZE 758 /* default number of association hash buckets in each endpoint */ 759 #define SCTP_PCBHASHSIZE 256 760 #endif 761 #ifndef SCTP_TCBHASHSIZE 762 #define SCTP_TCBHASHSIZE 1024 763 #endif 764 765 #ifndef SCTP_CHUNKQUEUE_SCALE 766 #define SCTP_CHUNKQUEUE_SCALE 10 767 #endif 768 769 /* clock variance is 1 ms */ 770 #define SCTP_CLOCK_GRANULARITY 1 771 #define IP_HDR_SIZE 40 /* we use the size of a IP6 header here this 772 * detracts a small amount for ipv4 but it 773 * simplifies the ipv6 addition */ 774 775 #ifndef IPPROTO_SCTP 776 #define IPPROTO_SCTP 132 /* the Official IANA number :-) */ 777 #endif /* !IPPROTO_SCTP */ 778 779 #define SCTP_MAX_DATA_BUNDLING 256 780 #define SCTP_MAX_CONTROL_BUNDLING 20 781 782 /* modular comparison */ 783 /* True if a > b (mod = M) */ 784 #define compare_with_wrap(a, b, M) (((a > b) && ((a - b) < ((M >> 1) + 1))) || \ 785 ((b > a) && ((b - a) > ((M >> 1) + 1)))) 786 787 788 /* Mapping array manipulation routines */ 789 #define SCTP_IS_TSN_PRESENT(arry, gap) ((arry[(gap >> 3)] >> (gap & 0x07)) & 0x01) 790 #define SCTP_SET_TSN_PRESENT(arry, gap) (arry[(gap >> 3)] |= (0x01 << ((gap & 0x07)))) 791 #define SCTP_UNSET_TSN_PRESENT(arry, gap) (arry[(gap >> 3)] &= ((~(0x01 << ((gap & 0x07)))) & 0xff)) 792 793 794 /* 795 * This value defines the number of vtag block time wait entry's per list 796 * element. Each entry will take 2 4 byte ints (and of course the overhead 797 * of the next pointer as well). Using 15 as an example will yield * ((8 * 798 * 15) + 8) or 128 bytes of overhead for each timewait block that gets 799 * initialized. Increasing it to 31 would yeild 256 bytes per block. 800 */ 801 #define SCTP_NUMBER_IN_VTAG_BLOCK 15 802 /* 803 * If we use the STACK option, we have an array of this size head pointers. 804 * This array is mod'd the with the size to find which bucket and then all 805 * entries must be searched to see if the tag is in timed wait. If so we 806 * reject it. 807 */ 808 #define SCTP_STACK_VTAG_HASH_SIZE 31 809 810 /* 811 * If we use the per-endpoint model than we do not have a hash table of 812 * entries but instead have a single head pointer and we must crawl through 813 * the entire list. 814 */ 815 816 /* 817 * Number of seconds of time wait, tied to MSL value (2 minutes), so 2 * MSL 818 * = 4 minutes or 480 seconds. 819 */ 820 #define SCTP_TIME_WAIT 480 821 822 /* The system retains a cache of free chunks such to 823 * cut down on calls the memory allocation system. There 824 * is a per association limit of free items and a overall 825 * system limit. If either one gets hit then the resource 826 * stops being cached. 827 */ 828 829 #define SCTP_DEF_ASOC_RESC_LIMIT 10 830 #define SCTP_DEF_SYSTEM_RESC_LIMIT 1000 831 832 833 834 #define IN4_ISPRIVATE_ADDRESS(a) \ 835 ((((u_char *)&(a)->s_addr)[0] == 10) || \ 836 ((((u_char *)&(a)->s_addr)[0] == 172) && \ 837 (((u_char *)&(a)->s_addr)[1] >= 16) && \ 838 (((u_char *)&(a)->s_addr)[1] <= 32)) || \ 839 ((((u_char *)&(a)->s_addr)[0] == 192) && \ 840 (((u_char *)&(a)->s_addr)[1] == 168))) 841 842 #define IN4_ISLOOPBACK_ADDRESS(a) \ 843 ((((u_char *)&(a)->s_addr)[0] == 127) && \ 844 (((u_char *)&(a)->s_addr)[1] == 0) && \ 845 (((u_char *)&(a)->s_addr)[2] == 0) && \ 846 (((u_char *)&(a)->s_addr)[3] == 1)) 847 848 849 850 851 #if defined(_KERNEL) 852 853 854 #define SCTP_GETTIME_TIMEVAL(x) (getmicrouptime(x)) 855 #define SCTP_GETPTIME_TIMEVAL(x) (microuptime(x)) 856 /*#if defined(__FreeBSD__) || defined(__APPLE__)*/ 857 /*#define SCTP_GETTIME_TIMEVAL(x) { \*/ 858 /* (x)->tv_sec = ticks / 1000; \*/ 859 /* (x)->tv_usec = (ticks % 1000) * 1000; \*/ 860 /*}*/ 861 862 /*#else*/ 863 /*#define SCTP_GETTIME_TIMEVAL(x) (microtime(x))*/ 864 /*#endif __FreeBSD__ */ 865 866 #define sctp_sowwakeup(inp, so) \ 867 do { \ 868 if (inp->sctp_flags & SCTP_PCB_FLAGS_DONT_WAKE) { \ 869 inp->sctp_flags |= SCTP_PCB_FLAGS_WAKEOUTPUT; \ 870 } else { \ 871 sowwakeup(so); \ 872 } \ 873 } while (0) 874 875 #define sctp_sowwakeup_locked(inp, so) \ 876 do { \ 877 if (inp->sctp_flags & SCTP_PCB_FLAGS_DONT_WAKE) { \ 878 SOCKBUF_UNLOCK(&((so)->so_snd)); \ 879 inp->sctp_flags |= SCTP_PCB_FLAGS_WAKEOUTPUT; \ 880 } else { \ 881 sowwakeup_locked(so); \ 882 } \ 883 } while (0) 884 885 #define sctp_sorwakeup(inp, so) \ 886 do { \ 887 if (inp->sctp_flags & SCTP_PCB_FLAGS_DONT_WAKE) { \ 888 inp->sctp_flags |= SCTP_PCB_FLAGS_WAKEINPUT; \ 889 } else { \ 890 sorwakeup(so); \ 891 } \ 892 } while (0) 893 894 /* FIXME */ 895 #define sctp_sorwakeup_locked(inp, so) \ 896 do { \ 897 if (inp->sctp_flags & SCTP_PCB_FLAGS_DONT_WAKE) { \ 898 inp->sctp_flags |= SCTP_PCB_FLAGS_WAKEINPUT; \ 899 SOCKBUF_UNLOCK(&((so)->so_rcv)); \ 900 } else { \ 901 sorwakeup_locked(so); \ 902 } \ 903 } while (0) 904 905 #endif /* _KERNEL */ 906 #endif 907