sctp_constants.h revision 248953
11590Srgrimes/*-
21590Srgrimes * Copyright (c) 2001-2008, by Cisco Systems, Inc. All rights reserved.
31590Srgrimes * Copyright (c) 2008-2012, by Randall Stewart. All rights reserved.
497377Sdes * Copyright (c) 2008-2012, by Michael Tuexen. All rights reserved.
597377Sdes *
61590Srgrimes * Redistribution and use in source and binary forms, with or without
797377Sdes * modification, are permitted provided that the following conditions are met:
897377Sdes *
997377Sdes * a) Redistributions of source code must retain the above copyright notice,
1097377Sdes *    this list of conditions and the following disclaimer.
1197377Sdes *
121590Srgrimes * b) Redistributions in binary form must reproduce the above copyright
131590Srgrimes *    notice, this list of conditions and the following disclaimer in
141590Srgrimes *    the documentation and/or other materials provided with the distribution.
151590Srgrimes *
161590Srgrimes * c) Neither the name of Cisco Systems, Inc. nor the names of its
171590Srgrimes *    contributors may be used to endorse or promote products derived
181590Srgrimes *    from this software without specific prior written permission.
191590Srgrimes *
201590Srgrimes * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
211590Srgrimes * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
221590Srgrimes * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
231590Srgrimes * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
241590Srgrimes * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
251590Srgrimes * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
261590Srgrimes * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
271590Srgrimes * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
281590Srgrimes * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
291590Srgrimes * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
301590Srgrimes * THE POSSIBILITY OF SUCH DAMAGE.
311590Srgrimes */
321590Srgrimes
331590Srgrimes#include <sys/cdefs.h>
341590Srgrimes__FBSDID("$FreeBSD: head/sys/netinet/sctp_constants.h 248953 2013-03-31 18:27:46Z tuexen $");
351590Srgrimes
361590Srgrimes#ifndef _NETINET_SCTP_CONSTANTS_H_
371590Srgrimes#define _NETINET_SCTP_CONSTANTS_H_
381590Srgrimes
391590Srgrimes/* IANA assigned port number for SCTP over UDP encapsulation */
401590Srgrimes/* For freebsd we cannot bind the port at
411590Srgrimes * startup. Otherwise what will happen is
4214440Smarkm * we really won't be bound. The user must
431590Srgrimes * put it into the sysctl... or we need
441590Srgrimes * to build a special timer for this to allow
451590Srgrimes * us to wait 1 second or so after the system
461590Srgrimes * comes up.
471590Srgrimes */
4828099Scharnier#define SCTP_OVER_UDP_TUNNELING_PORT 0
491590Srgrimes/* Number of packets to get before sack sent by default */
5028099Scharnier#define SCTP_DEFAULT_SACK_FREQ 2
5114440Smarkm
5250477Speter/* Address limit - This variable is calculated
531590Srgrimes * based on an 65535 byte max ip packet. We take out 100 bytes
541590Srgrimes * for the cookie, 40 bytes for a v6 header and 32
551590Srgrimes * bytes for the init structure. A second init structure
561590Srgrimes * for the init-ack and then finally a third one for the
571590Srgrimes * imbedded init. This yeilds 100+40+(3 * 32) = 236 bytes.
5877220Smarkm * This leaves 65299 bytes for addresses. We throw out the 299 bytes.
591590Srgrimes * Now whatever we send in the INIT() we need to allow to get back in the
601590Srgrimes * INIT-ACK plus all the values from INIT and INIT-ACK
611590Srgrimes * listed in the cookie. Plus we need some overhead for
621590Srgrimes * maybe copied parameters in the COOKIE. If we
6377220Smarkm * allow 1080 addresses, and each side has 1080 V6 addresses
6477220Smarkm * that will be 21600 bytes. In the INIT-ACK we will
651590Srgrimes * see the INIT-ACK 21600 + 43200 in the cookie. This leaves
661590Srgrimes * about 500 bytes slack for misc things in the cookie.
6777220Smarkm */
681590Srgrimes#define SCTP_ADDRESS_LIMIT 1080
691590Srgrimes
701590Srgrimes/* We need at least 2k of space for us, inits
711590Srgrimes * larger than that lets abort.
721590Srgrimes */
7321646Sdavidn#define SCTP_LARGEST_INIT_ACCEPTED (65535 - 2048)
7474874Smarkm
7591745Sdes/* Number of addresses where we just skip the counting */
7674874Smarkm#define SCTP_COUNT_LIMIT 40
7781528Smarkm
7877220Smarkm#define SCTP_ZERO_COPY_TICK_DELAY (((100 * hz) + 999) / 1000)
7977220Smarkm#define SCTP_ZERO_COPY_SENDQ_TICK_DELAY (((100 * hz) + 999) / 1000)
8077220Smarkm
8177220Smarkm/* Number of ticks to delay before running
8277220Smarkm * iterator on an address change.
8377220Smarkm */
8477220Smarkm#define SCTP_ADDRESS_TICK_DELAY 2
8577220Smarkm
8677220Smarkm#define SCTP_VERSION_STRING "KAME-BSD 1.1"
8777220Smarkm/* #define SCTP_AUDITING_ENABLED 1 used for debug/auditing */
8877220Smarkm#define SCTP_AUDIT_SIZE 256
8977220Smarkm
9074874Smarkm
9174874Smarkm#define SCTP_KTRHEAD_NAME "sctp_iterator"
9277220Smarkm#define SCTP_KTHREAD_PAGES 0
9377220Smarkm
9477220Smarkm#define SCTP_MCORE_NAME "sctp_core_worker"
9577220Smarkm
9677220Smarkm
9777220Smarkm/* If you support Multi-VRF how big to
9877220Smarkm * make the initial array of VRF's to.
9977220Smarkm */
10077220Smarkm#define SCTP_DEFAULT_VRF_SIZE 4
10177220Smarkm
1023702Spst/* constants for rto calc */
10377220Smarkm#define sctp_align_safe_nocopy 0
1041590Srgrimes#define sctp_align_unsafe_makecopy 1
10577220Smarkm
10677220Smarkm/* JRS - Values defined for the HTCP algorithm */
10777220Smarkm#define ALPHA_BASE	(1<<7)	/* 1.0 with shift << 7 */
10877220Smarkm#define BETA_MIN	(1<<6)	/* 0.5 with shift << 7 */
10977220Smarkm#define BETA_MAX	102	/* 0.8 with shift << 7 */
11077220Smarkm
11177220Smarkm/* Places that CWND log can happen from */
11277220Smarkm#define SCTP_CWND_LOG_FROM_FR	1
11377220Smarkm#define SCTP_CWND_LOG_FROM_RTX	2
11477220Smarkm#define SCTP_CWND_LOG_FROM_BRST	3
11577220Smarkm#define SCTP_CWND_LOG_FROM_SS	4
11677220Smarkm#define SCTP_CWND_LOG_FROM_CA	5
1171590Srgrimes#define SCTP_CWND_LOG_FROM_SAT	6
11877220Smarkm#define SCTP_BLOCK_LOG_INTO_BLK 7
1191590Srgrimes#define SCTP_BLOCK_LOG_OUTOF_BLK 8
12077220Smarkm#define SCTP_BLOCK_LOG_CHECK     9
12191745Sdes#define SCTP_STR_LOG_FROM_INTO_STRD 10
12277220Smarkm#define SCTP_STR_LOG_FROM_IMMED_DEL 11
12377220Smarkm#define SCTP_STR_LOG_FROM_INSERT_HD 12
12483373Smarkm#define SCTP_STR_LOG_FROM_INSERT_MD 13
12583373Smarkm#define SCTP_STR_LOG_FROM_INSERT_TL 14
12683373Smarkm#define SCTP_STR_LOG_FROM_MARK_TSN  15
12797377Sdes#define SCTP_STR_LOG_FROM_EXPRS_DEL 16
12877220Smarkm#define SCTP_FR_LOG_BIGGEST_TSNS    17
12977220Smarkm#define SCTP_FR_LOG_STRIKE_TEST     18
130101446Sache#define SCTP_FR_LOG_STRIKE_CHUNK    19
13189746Sdes#define SCTP_FR_T3_TIMEOUT          20
13283373Smarkm#define SCTP_MAP_PREPARE_SLIDE      21
1331590Srgrimes#define SCTP_MAP_SLIDE_FROM         22
13498837Sdillon#define SCTP_MAP_SLIDE_RESULT       23
13598837Sdillon#define SCTP_MAP_SLIDE_CLEARED	    24
13677220Smarkm#define SCTP_MAP_SLIDE_NONE         25
13777220Smarkm#define SCTP_FR_T3_MARK_TIME        26
13810586Sjoerg#define SCTP_FR_T3_MARKED           27
13977220Smarkm#define SCTP_FR_T3_STOPPED          28
14077220Smarkm#define SCTP_FR_MARKED              30
14181703Sru#define SCTP_CWND_LOG_NOADV_SS      31
14277220Smarkm#define SCTP_CWND_LOG_NOADV_CA      32
1431590Srgrimes#define SCTP_MAX_BURST_APPLIED      33
1441590Srgrimes#define SCTP_MAX_IFP_APPLIED        34
1451590Srgrimes#define SCTP_MAX_BURST_ERROR_STOP   35
1461590Srgrimes#define SCTP_INCREASE_PEER_RWND     36
1471590Srgrimes#define SCTP_DECREASE_PEER_RWND     37
1481590Srgrimes#define SCTP_SET_PEER_RWND_VIA_SACK 38
1491590Srgrimes#define SCTP_LOG_MBCNT_INCREASE     39
1501590Srgrimes#define SCTP_LOG_MBCNT_DECREASE     40
1511590Srgrimes#define SCTP_LOG_MBCNT_CHKSET       41
1521590Srgrimes#define SCTP_LOG_NEW_SACK           42
1531590Srgrimes#define SCTP_LOG_TSN_ACKED          43
1541590Srgrimes#define SCTP_LOG_TSN_REVOKED        44
15530793Sguido#define SCTP_LOG_LOCK_TCB           45
15630793Sguido#define SCTP_LOG_LOCK_INP           46
15730793Sguido#define SCTP_LOG_LOCK_SOCK          47
1581590Srgrimes#define SCTP_LOG_LOCK_SOCKBUF_R     48
1591590Srgrimes#define SCTP_LOG_LOCK_SOCKBUF_S     49
16028099Scharnier#define SCTP_LOG_LOCK_CREATE        50
16128099Scharnier#define SCTP_LOG_INITIAL_RTT        51
16239538Sroberto#define SCTP_LOG_RTTVAR             52
16339538Sroberto#define SCTP_LOG_SBALLOC            53
16410586Sjoerg#define SCTP_LOG_SBFREE             54
16510586Sjoerg#define SCTP_LOG_SBRESULT           55
16628612Sjoerg#define SCTP_FR_DUPED               56
16728612Sjoerg#define SCTP_FR_MARKED_EARLY        57
16828612Sjoerg#define SCTP_FR_CWND_REPORT         58
16977220Smarkm#define SCTP_FR_CWND_REPORT_START   59
17077220Smarkm#define SCTP_FR_CWND_REPORT_STOP    60
17110586Sjoerg#define SCTP_CWND_LOG_FROM_SEND     61
17277220Smarkm#define SCTP_CWND_INITIALIZATION    62
17377220Smarkm#define SCTP_CWND_LOG_FROM_T3       63
17477220Smarkm#define SCTP_CWND_LOG_FROM_SACK     64
17577220Smarkm#define SCTP_CWND_LOG_NO_CUMACK     65
17610586Sjoerg#define SCTP_CWND_LOG_FROM_RESEND   66
17710586Sjoerg#define SCTP_FR_LOG_CHECK_STRIKE    67
17877220Smarkm#define SCTP_SEND_NOW_COMPLETES     68
17983373Smarkm#define SCTP_CWND_LOG_FILL_OUTQ_CALLED 69
18010586Sjoerg#define SCTP_CWND_LOG_FILL_OUTQ_FILLS  70
1811590Srgrimes#define SCTP_LOG_FREE_SENT             71
1821590Srgrimes#define SCTP_NAGLE_APPLIED          72
1831590Srgrimes#define SCTP_NAGLE_SKIPPED          73
1841590Srgrimes#define SCTP_WAKESND_FROM_SACK      74
1851590Srgrimes#define SCTP_WAKESND_FROM_FWDTSN    75
1861590Srgrimes#define SCTP_NOWAKE_FROM_SACK       76
18777220Smarkm#define SCTP_CWNDLOG_PRESEND        77
18877220Smarkm#define SCTP_CWNDLOG_ENDSEND        78
18974874Smarkm#define SCTP_AT_END_OF_SACK         79
1901590Srgrimes#define SCTP_REASON_FOR_SC          80
19177220Smarkm#define SCTP_BLOCK_LOG_INTO_BLKA    81
1921590Srgrimes#define SCTP_ENTER_USER_RECV        82
1931590Srgrimes#define SCTP_USER_RECV_SACKS        83
19477220Smarkm#define SCTP_SORECV_BLOCKSA         84
19577220Smarkm#define SCTP_SORECV_BLOCKSB         85
1961590Srgrimes#define SCTP_SORECV_DONE            86
1971590Srgrimes#define SCTP_SACK_RWND_UPDATE       87
1981590Srgrimes#define SCTP_SORECV_ENTER           88
19977220Smarkm#define SCTP_SORECV_ENTERPL         89
2001590Srgrimes#define SCTP_MBUF_INPUT             90
2011590Srgrimes#define SCTP_MBUF_IALLOC            91
20277220Smarkm#define SCTP_MBUF_IFREE             92
20377220Smarkm#define SCTP_MBUF_ICOPY             93
20421646Sdavidn#define SCTP_MBUF_SPLIT             94
20521646Sdavidn#define SCTP_SORCV_FREECTL          95
20677220Smarkm#define SCTP_SORCV_DOESCPY          96
20777220Smarkm#define SCTP_SORCV_DOESLCK          97
20877220Smarkm#define SCTP_SORCV_DOESADJ          98
20977220Smarkm#define SCTP_SORCV_BOTWHILE         99
21077220Smarkm#define SCTP_SORCV_PASSBF          100
21177220Smarkm#define SCTP_SORCV_ADJD            101
2121590Srgrimes#define SCTP_UNKNOWN_MAX           102
2131590Srgrimes#define SCTP_RANDY_STUFF           103
2141590Srgrimes#define SCTP_RANDY_STUFF1          104
21521646Sdavidn#define SCTP_STRMOUT_LOG_ASSIGN	   105
2161590Srgrimes#define SCTP_STRMOUT_LOG_SEND	   106
21777220Smarkm#define SCTP_FLIGHT_LOG_DOWN_CA    107
21874874Smarkm#define SCTP_FLIGHT_LOG_UP         108
21974874Smarkm#define SCTP_FLIGHT_LOG_DOWN_GAP   109
22074874Smarkm#define SCTP_FLIGHT_LOG_DOWN_RSND  110
22174874Smarkm#define SCTP_FLIGHT_LOG_UP_RSND    111
22274874Smarkm#define SCTP_FLIGHT_LOG_DOWN_RSND_TO    112
22374874Smarkm#define SCTP_FLIGHT_LOG_DOWN_WP    113
22481529Smarkm#define SCTP_FLIGHT_LOG_UP_REVOKE  114
22581529Smarkm#define SCTP_FLIGHT_LOG_DOWN_PDRP  115
22674874Smarkm#define SCTP_FLIGHT_LOG_DOWN_PMTU  116
22774874Smarkm#define SCTP_SACK_LOG_NORMAL	   117
22874874Smarkm#define SCTP_SACK_LOG_EXPRESS	   118
22977220Smarkm#define SCTP_MAP_TSN_ENTERS        119
23077220Smarkm#define SCTP_THRESHOLD_CLEAR       120
23177220Smarkm#define SCTP_THRESHOLD_INCR        121
23274874Smarkm#define SCTP_FLIGHT_LOG_DWN_WP_FWD 122
23377220Smarkm#define SCTP_FWD_TSN_CHECK         123
23477220Smarkm#define SCTP_LOG_MAX_TYPES 124
23577220Smarkm/*
23674874Smarkm * To turn on various logging, you must first enable 'options KTR' and
23777220Smarkm * you might want to bump the entires 'options KTR_ENTRIES=80000'.
23877220Smarkm * To get something to log you define one of the logging defines.
23977220Smarkm * (see LINT).
24077220Smarkm *
24177220Smarkm * This gets the compile in place, but you still need to turn the
24277220Smarkm * logging flag on too in the sysctl (see in sctp.h).
24374874Smarkm */
24477220Smarkm
24577220Smarkm#define SCTP_LOG_EVENT_UNKNOWN 0
24677220Smarkm#define SCTP_LOG_EVENT_CWND  1
24777220Smarkm#define SCTP_LOG_EVENT_BLOCK 2
24874874Smarkm#define SCTP_LOG_EVENT_STRM  3
24977220Smarkm#define SCTP_LOG_EVENT_FR    4
25077220Smarkm#define SCTP_LOG_EVENT_MAP   5
25174874Smarkm#define SCTP_LOG_EVENT_MAXBURST 6
25274874Smarkm#define SCTP_LOG_EVENT_RWND  7
25374874Smarkm#define SCTP_LOG_EVENT_MBCNT 8
25477220Smarkm#define SCTP_LOG_EVENT_SACK  9
25577220Smarkm#define SCTP_LOG_LOCK_EVENT 10
25677220Smarkm#define SCTP_LOG_EVENT_RTT  11
25777220Smarkm#define SCTP_LOG_EVENT_SB   12
25877220Smarkm#define SCTP_LOG_EVENT_NAGLE 13
25974874Smarkm#define SCTP_LOG_EVENT_WAKE 14
2601590Srgrimes#define SCTP_LOG_MISC_EVENT 15
26177220Smarkm#define SCTP_LOG_EVENT_CLOSE 16
26277220Smarkm#define SCTP_LOG_EVENT_MBUF 17
2639502Swollman#define SCTP_LOG_CHUNK_PROC 18
26477220Smarkm#define SCTP_LOG_ERROR_RET  19
26530793Sguido
26677220Smarkm#define SCTP_LOG_MAX_EVENT 20
26777220Smarkm
26830793Sguido#define SCTP_LOCK_UNKNOWN 2
26930793Sguido
27030793Sguido
27130793Sguido/* number of associations by default for zone allocation */
27230793Sguido#define SCTP_MAX_NUM_OF_ASOC	40000
2731590Srgrimes/* how many addresses per assoc remote and local */
27477220Smarkm#define SCTP_SCALE_FOR_ADDR	2
2751590Srgrimes
27677220Smarkm/* default AUTO_ASCONF mode enable(1)/disable(0) value (sysctl) */
2771590Srgrimes#define SCTP_DEFAULT_AUTO_ASCONF	1
27877220Smarkm
27977220Smarkm/* default MULTIPLE_ASCONF mode enable(1)/disable(0) value (sysctl) */
2801590Srgrimes#define SCTP_DEFAULT_MULTIPLE_ASCONFS	0
2811590Srgrimes
28277220Smarkm/* default MOBILITY_BASE mode enable(1)/disable(0) value (sysctl) */
28377220Smarkm#define SCTP_DEFAULT_MOBILITY_BASE	0
2841590Srgrimes
2851590Srgrimes/* default MOBILITY_FASTHANDOFF mode enable(1)/disable(0) value (sysctl) */
2861590Srgrimes#define SCTP_DEFAULT_MOBILITY_FASTHANDOFF	0
2871590Srgrimes
2881590Srgrimes/*
2891590Srgrimes * Theshold for rwnd updates, we have to read (sb_hiwat >>
29014440Smarkm * SCTP_RWND_HIWAT_SHIFT) before we will look to see if we need to send a
29114440Smarkm * window update sack. When we look, we compare the last rwnd we sent vs the
2921590Srgrimes * current rwnd. It too must be greater than this value. Using 3 divdes the
2931590Srgrimes * hiwat by 8, so for 200k rwnd we need to read 24k. For a 64k rwnd we need
2941590Srgrimes * to read 8k. This seems about right.. I hope :-D.. we do set a
29577220Smarkm * min of a MTU on it so if the rwnd is real small we will insist
2961590Srgrimes * on a full MTU of 1500 bytes.
29777220Smarkm */
2981590Srgrimes#define SCTP_RWND_HIWAT_SHIFT 3
29921646Sdavidn
30077220Smarkm/* How much of the rwnd must the
30177220Smarkm * message be taking up to start partial delivery.
30274874Smarkm * We calculate this by shifing the hi_water (recv_win)
30374874Smarkm * left the following .. set to 1, when a message holds
30474874Smarkm * 1/2 the rwnd. If we set it to 2 when a message holds
30574874Smarkm * 1/4 the rwnd...etc..
30674874Smarkm */
30777220Smarkm
30877220Smarkm#define SCTP_PARTIAL_DELIVERY_SHIFT 1
30977220Smarkm
31077220Smarkm/*
31177220Smarkm * default HMAC for cookies, etc... use one of the AUTH HMAC id's
31274874Smarkm * SCTP_HMAC is the HMAC_ID to use
31374874Smarkm * SCTP_SIGNATURE_SIZE is the digest length
31474874Smarkm */
31574874Smarkm#define SCTP_HMAC		SCTP_AUTH_HMAC_ID_SHA1
31674874Smarkm#define SCTP_SIGNATURE_SIZE	SCTP_AUTH_DIGEST_LEN_SHA1
31798837Sdillon#define SCTP_SIGNATURE_ALOC_SIZE SCTP_SIGNATURE_SIZE
318105362Stjr
31998837Sdillon/*
32098837Sdillon * the SCTP protocol signature this includes the version number encoded in
32198837Sdillon * the last 4 bits of the signature.
32298837Sdillon */
32374874Smarkm#define PROTO_SIGNATURE_A	0x30000000
32474874Smarkm#define SCTP_VERSION_NUMBER	0x3
32577220Smarkm
32677220Smarkm#define MAX_TSN	0xffffffff
32774874Smarkm
32877220Smarkm/* how many executions every N tick's */
32977220Smarkm#define SCTP_ITERATOR_MAX_AT_ONCE 20
33077220Smarkm
331101722Sache/* number of clock ticks between iterator executions */
332101749Sache#define SCTP_ITERATOR_TICKS 1
333101722Sache
334101722Sache/*
335101722Sache * option: If you comment out the following you will receive the old behavior
33677220Smarkm * of obeying cwnd for the fast retransmit algorithm. With this defined a FR
33777220Smarkm * happens right away with-out waiting for the flightsize to drop below the
33877220Smarkm * cwnd value (which is reduced by the FR to 1/2 the inflight packets).
33977220Smarkm */
34074874Smarkm#define SCTP_IGNORE_CWND_ON_FR 1
34177220Smarkm
34277220Smarkm/*
34381528Smarkm * Adds implementors guide behavior to only use newest highest update in SACK
34477220Smarkm * gap ack's to figure out if you need to stroke a chunk for FR.
34574874Smarkm */
34677220Smarkm#define SCTP_NO_FR_UNLESS_SEGMENT_SMALLER 1
34781528Smarkm
34877220Smarkm/* default max I can burst out after a fast retransmit, 0 disables it */
34974874Smarkm#define SCTP_DEF_MAX_BURST 4
35098837Sdillon#define SCTP_DEF_HBMAX_BURST 4
35198837Sdillon#define SCTP_DEF_FRMAX_BURST 4
35298837Sdillon
35377220Smarkm/* RTO calculation flag to say if it
35477220Smarkm * is safe to determine local lan or not.
35577220Smarkm */
35677220Smarkm#define SCTP_RTT_FROM_NON_DATA 0
35777220Smarkm#define SCTP_RTT_FROM_DATA     1
35877220Smarkm
35977220Smarkm
36077220Smarkm/* IP hdr (20/40) + 12+2+2 (enet) + sctp common 12 */
36177220Smarkm#define SCTP_FIRST_MBUF_RESV 68
36277220Smarkm/* Packet transmit states in the sent field */
36377220Smarkm#define SCTP_DATAGRAM_UNSENT		0
36477220Smarkm#define SCTP_DATAGRAM_SENT		1
36577220Smarkm#define SCTP_DATAGRAM_RESEND1		2	/* not used (in code, but may
36677220Smarkm						 * hit this value) */
36774874Smarkm#define SCTP_DATAGRAM_RESEND2		3	/* not used (in code, but may
36877220Smarkm						 * hit this value) */
36977220Smarkm#define SCTP_DATAGRAM_RESEND		4
37077220Smarkm#define SCTP_DATAGRAM_ACKED		10010
37177220Smarkm#define SCTP_DATAGRAM_MARKED		20010
37269427Srwatson#define SCTP_FORWARD_TSN_SKIP		30010
37377220Smarkm#define SCTP_DATAGRAM_NR_ACKED		40010
37477220Smarkm
37577220Smarkm/* chunk output send from locations */
37677220Smarkm#define SCTP_OUTPUT_FROM_USR_SEND       0
37777220Smarkm#define SCTP_OUTPUT_FROM_T3       	1
37877220Smarkm#define SCTP_OUTPUT_FROM_INPUT_ERROR    2
37977220Smarkm#define SCTP_OUTPUT_FROM_CONTROL_PROC   3
3801590Srgrimes#define SCTP_OUTPUT_FROM_SACK_TMR       4
38177220Smarkm#define SCTP_OUTPUT_FROM_SHUT_TMR       5
38277220Smarkm#define SCTP_OUTPUT_FROM_HB_TMR         6
38377220Smarkm#define SCTP_OUTPUT_FROM_SHUT_ACK_TMR   7
38477220Smarkm#define SCTP_OUTPUT_FROM_ASCONF_TMR     8
38577220Smarkm#define SCTP_OUTPUT_FROM_STRRST_TMR     9
38677220Smarkm#define SCTP_OUTPUT_FROM_AUTOCLOSE_TMR  10
38777220Smarkm#define SCTP_OUTPUT_FROM_EARLY_FR_TMR   11
38877220Smarkm#define SCTP_OUTPUT_FROM_STRRST_REQ     12
38977220Smarkm#define SCTP_OUTPUT_FROM_USR_RCVD       13
39077220Smarkm#define SCTP_OUTPUT_FROM_COOKIE_ACK     14
39177220Smarkm#define SCTP_OUTPUT_FROM_DRAIN          15
39277220Smarkm#define SCTP_OUTPUT_FROM_CLOSING        16
39377220Smarkm#define SCTP_OUTPUT_FROM_SOCKOPT        17
39477220Smarkm
39577220Smarkm/* SCTP chunk types are moved sctp.h for application (NAT, FW) use */
39674874Smarkm
39777220Smarkm/* align to 32-bit sizes */
39877220Smarkm#define SCTP_SIZE32(x)	((((x) + 3) >> 2) << 2)
39983373Smarkm
40077220Smarkm#define IS_SCTP_CONTROL(a) ((a)->chunk_type != SCTP_DATA)
40183373Smarkm#define IS_SCTP_DATA(a) ((a)->chunk_type == SCTP_DATA)
4021590Srgrimes
40377220Smarkm
40483373Smarkm/* SCTP parameter types */
40574874Smarkm/*************0x0000 series*************/
40677220Smarkm#define SCTP_HEARTBEAT_INFO		0x0001
40777220Smarkm#define SCTP_IPV4_ADDRESS		0x0005
40877220Smarkm#define SCTP_IPV6_ADDRESS		0x0006
40974874Smarkm#define SCTP_STATE_COOKIE		0x0007
41083373Smarkm#define SCTP_UNRECOG_PARAM		0x0008
41177220Smarkm#define SCTP_COOKIE_PRESERVE		0x0009
4121590Srgrimes#define SCTP_HOSTNAME_ADDRESS		0x000b
4131590Srgrimes#define SCTP_SUPPORTED_ADDRTYPE		0x000c
4141590Srgrimes
41574874Smarkm/* draft-ietf-stewart-tsvwg-strreset-xxx */
41677220Smarkm#define SCTP_STR_RESET_OUT_REQUEST	0x000d
41774874Smarkm#define SCTP_STR_RESET_IN_REQUEST	0x000e
41874874Smarkm#define SCTP_STR_RESET_TSN_REQUEST	0x000f
41974874Smarkm#define SCTP_STR_RESET_RESPONSE		0x0010
42074874Smarkm#define SCTP_STR_RESET_ADD_OUT_STREAMS	0x0011
42174874Smarkm#define SCTP_STR_RESET_ADD_IN_STREAMS   0x0012
42277220Smarkm
42374874Smarkm#define SCTP_MAX_RESET_PARAMS 2
42474874Smarkm#define SCTP_STREAM_RESET_TSN_DELTA    0x1000
42574874Smarkm
42674874Smarkm/*************0x4000 series*************/
42774874Smarkm
42874874Smarkm/*************0x8000 series*************/
42974874Smarkm#define SCTP_ECN_CAPABLE		0x8000
43074874Smarkm
43174874Smarkm/* draft-ietf-tsvwg-auth-xxx */
43274874Smarkm#define SCTP_RANDOM			0x8002
43374874Smarkm#define SCTP_CHUNK_LIST			0x8003
43474874Smarkm#define SCTP_HMAC_LIST			0x8004
43574874Smarkm/*
43677220Smarkm * draft-ietf-tsvwg-addip-sctp-xx param=0x8008  len=0xNNNN Byte | Byte | Byte
43774874Smarkm * | Byte Byte | Byte ...
43874874Smarkm *
43974874Smarkm * Where each byte is a chunk type extension supported. For example, to support
44074874Smarkm * all chunks one would have (in hex):
44174874Smarkm *
44274874Smarkm * 80 01 00 09 C0 C1 80 81 82 00 00 00
44374874Smarkm *
44474874Smarkm * Has the parameter. C0 = PR-SCTP    (RFC3758) C1, 80 = ASCONF (addip draft) 81
44574874Smarkm * = Packet Drop 82 = Stream Reset 83 = Authentication
44674874Smarkm */
44774874Smarkm#define SCTP_SUPPORTED_CHUNK_EXT    0x8008
44874874Smarkm
44974874Smarkm/*************0xC000 series*************/
45074874Smarkm#define SCTP_PRSCTP_SUPPORTED		0xc000
45174874Smarkm/* draft-ietf-tsvwg-addip-sctp */
45274874Smarkm#define SCTP_ADD_IP_ADDRESS		0xc001
45374874Smarkm#define SCTP_DEL_IP_ADDRESS		0xc002
45474874Smarkm#define SCTP_ERROR_CAUSE_IND		0xc003
45574874Smarkm#define SCTP_SET_PRIM_ADDR		0xc004
45674874Smarkm#define SCTP_SUCCESS_REPORT		0xc005
45728099Scharnier#define SCTP_ULP_ADAPTATION		0xc006
45877220Smarkm/* behave-nat-draft */
45928099Scharnier#define SCTP_HAS_NAT_SUPPORT            0xc007
46081702Sru#define SCTP_NAT_VTAGS                  0xc008
46181971Smarkm
46281702Sru/* bits for TOS field */
46328099Scharnier#define SCTP_ECT0_BIT		0x02
46428099Scharnier#define SCTP_ECT1_BIT		0x01
46577220Smarkm#define SCTP_CE_BITS		0x03
46677220Smarkm
4671590Srgrimes/* below turns off above */
46877220Smarkm#define SCTP_FLEXIBLE_ADDRESS	0x20
4691590Srgrimes#define SCTP_NO_HEARTBEAT	0x40
4701590Srgrimes
47177220Smarkm/* mask to get sticky */
47221646Sdavidn#define SCTP_STICKY_OPTIONS_MASK	0x0c
47377220Smarkm
47477220Smarkm
47577220Smarkm/*
47677220Smarkm * SCTP states for internal state machine XXX (should match "user" values)
47721646Sdavidn */
47821646Sdavidn#define SCTP_STATE_EMPTY		0x0000
4791590Srgrimes#define SCTP_STATE_INUSE		0x0001
4801590Srgrimes#define SCTP_STATE_COOKIE_WAIT		0x0002
48177220Smarkm#define SCTP_STATE_COOKIE_ECHOED	0x0004
48277220Smarkm#define SCTP_STATE_OPEN			0x0008
4831590Srgrimes#define SCTP_STATE_SHUTDOWN_SENT	0x0010
4841590Srgrimes#define SCTP_STATE_SHUTDOWN_RECEIVED	0x0020
4851590Srgrimes#define SCTP_STATE_SHUTDOWN_ACK_SENT	0x0040
4861590Srgrimes#define SCTP_STATE_SHUTDOWN_PENDING	0x0080
4871590Srgrimes#define SCTP_STATE_CLOSED_SOCKET	0x0100
48814440Smarkm#define SCTP_STATE_ABOUT_TO_BE_FREED    0x0200
48914440Smarkm#define SCTP_STATE_PARTIAL_MSG_LEFT     0x0400
4901590Srgrimes#define SCTP_STATE_WAS_ABORTED          0x0800
49177220Smarkm#define SCTP_STATE_IN_ACCEPT_QUEUE      0x1000
4921590Srgrimes#define SCTP_STATE_MASK			0x007f
493
494#define SCTP_GET_STATE(asoc)	((asoc)->state & SCTP_STATE_MASK)
495#define SCTP_SET_STATE(asoc, newstate)  ((asoc)->state = ((asoc)->state & ~SCTP_STATE_MASK) |  newstate)
496#define SCTP_CLEAR_SUBSTATE(asoc, substate) ((asoc)->state &= ~substate)
497#define SCTP_ADD_SUBSTATE(asoc, substate) ((asoc)->state |= substate)
498
499/* SCTP reachability state for each address */
500#define SCTP_ADDR_REACHABLE		0x001
501#define SCTP_ADDR_NO_PMTUD              0x002
502#define SCTP_ADDR_NOHB			0x004
503#define SCTP_ADDR_BEING_DELETED		0x008
504#define SCTP_ADDR_NOT_IN_ASSOC		0x010
505#define SCTP_ADDR_OUT_OF_SCOPE		0x080
506#define SCTP_ADDR_UNCONFIRMED		0x200
507#define SCTP_ADDR_REQ_PRIMARY           0x400
508/* JRS 5/13/07 - Added potentially failed state for CMT PF */
509#define SCTP_ADDR_PF                    0x800
510
511/* bound address types (e.g. valid address types to allow) */
512#define SCTP_BOUND_V6		0x01
513#define SCTP_BOUND_V4		0x02
514
515/*
516 * what is the default number of mbufs in a chain I allow before switching to
517 * a cluster
518 */
519#define SCTP_DEFAULT_MBUFS_IN_CHAIN 5
520
521/* How long a cookie lives in milli-seconds */
522#define SCTP_DEFAULT_COOKIE_LIFE	60000
523
524/* resource limit of streams */
525#define MAX_SCTP_STREAMS	2048
526
527/* Maximum the mapping array will  grow to (TSN mapping array) */
528#define SCTP_MAPPING_ARRAY	512
529
530/* size of the inital malloc on the mapping array */
531#define SCTP_INITIAL_MAPPING_ARRAY  16
532/* how much we grow the mapping array each call */
533#define SCTP_MAPPING_ARRAY_INCR     32
534
535/*
536 * Here we define the timer types used by the implementation as arguments in
537 * the set/get timer type calls.
538 */
539#define SCTP_TIMER_INIT 	0
540#define SCTP_TIMER_RECV 	1
541#define SCTP_TIMER_SEND 	2
542#define SCTP_TIMER_HEARTBEAT	3
543#define SCTP_TIMER_PMTU		4
544#define SCTP_TIMER_MAXSHUTDOWN	5
545#define SCTP_TIMER_SIGNATURE	6
546/*
547 * number of timer types in the base SCTP structure used in the set/get and
548 * has the base default.
549 */
550#define SCTP_NUM_TMRS	7
551
552/* timer types */
553#define SCTP_TIMER_TYPE_NONE		0
554#define SCTP_TIMER_TYPE_SEND		1
555#define SCTP_TIMER_TYPE_INIT		2
556#define SCTP_TIMER_TYPE_RECV		3
557#define SCTP_TIMER_TYPE_SHUTDOWN	4
558#define SCTP_TIMER_TYPE_HEARTBEAT	5
559#define SCTP_TIMER_TYPE_COOKIE		6
560#define SCTP_TIMER_TYPE_NEWCOOKIE	7
561#define SCTP_TIMER_TYPE_PATHMTURAISE	8
562#define SCTP_TIMER_TYPE_SHUTDOWNACK	9
563#define SCTP_TIMER_TYPE_ASCONF		10
564#define SCTP_TIMER_TYPE_SHUTDOWNGUARD	11
565#define SCTP_TIMER_TYPE_AUTOCLOSE	12
566#define SCTP_TIMER_TYPE_EVENTWAKE	13
567#define SCTP_TIMER_TYPE_STRRESET        14
568#define SCTP_TIMER_TYPE_INPKILL         15
569#define SCTP_TIMER_TYPE_ASOCKILL        16
570#define SCTP_TIMER_TYPE_ADDR_WQ         17
571#define SCTP_TIMER_TYPE_ZERO_COPY       18
572#define SCTP_TIMER_TYPE_ZCOPY_SENDQ     19
573#define SCTP_TIMER_TYPE_PRIM_DELETED    20
574/* add new timers here - and increment LAST */
575#define SCTP_TIMER_TYPE_LAST            21
576
577#define SCTP_IS_TIMER_TYPE_VALID(t)	(((t) > SCTP_TIMER_TYPE_NONE) && \
578					 ((t) < SCTP_TIMER_TYPE_LAST))
579
580
581
582/* max number of TSN's dup'd that I will hold */
583#define SCTP_MAX_DUP_TSNS	20
584
585/*
586 * Here we define the types used when setting the retry amounts.
587 */
588/* How many drop re-attempts we make on  INIT/COOKIE-ECHO */
589#define SCTP_RETRY_DROPPED_THRESH 4
590
591/*
592 * Maxmium number of chunks a single association can have on it. Note that
593 * this is a squishy number since the count can run over this if the user
594 * sends a large message down .. the fragmented chunks don't count until
595 * AFTER the message is on queue.. it would be the next send that blocks
596 * things. This number will get tuned up at boot in the sctp_init and use the
597 * number of clusters as a base. This way high bandwidth environments will
598 * not get impacted by the lower bandwidth sending a bunch of 1 byte chunks
599 */
600#define SCTP_ASOC_MAX_CHUNKS_ON_QUEUE 512
601
602
603/* The conversion from time to ticks and vice versa is done by rounding
604 * upwards. This way we can test in the code the time to be positive and
605 * know that this corresponds to a positive number of ticks.
606 */
607#define MSEC_TO_TICKS(x) ((hz == 1000) ? x : ((((x) * hz) + 999) / 1000))
608#define TICKS_TO_MSEC(x) ((hz == 1000) ? x : ((((x) * 1000) + (hz - 1)) / hz))
609
610#define SEC_TO_TICKS(x) ((x) * hz)
611#define TICKS_TO_SEC(x) (((x) + (hz - 1)) / hz)
612
613/*
614 * Basically the minimum amount of time before I do a early FR. Making this
615 * value to low will cause duplicate retransmissions.
616 */
617#define SCTP_MINFR_MSEC_TIMER 250
618/* The floor this value is allowed to fall to when starting a timer. */
619#define SCTP_MINFR_MSEC_FLOOR 20
620
621/* init timer def = 1 sec */
622#define SCTP_INIT_SEC	1
623
624/* send timer def = 1 seconds */
625#define SCTP_SEND_SEC	1
626
627/* recv timer def = 200ms  */
628#define SCTP_RECV_MSEC	200
629
630/* 30 seconds + RTO (in ms) */
631#define SCTP_HB_DEFAULT_MSEC	30000
632
633/* Max time I will wait for Shutdown to complete */
634#define SCTP_DEF_MAX_SHUTDOWN_SEC 180
635
636
637/*
638 * This is how long a secret lives, NOT how long a cookie lives how many
639 * ticks the current secret will live.
640 */
641#define SCTP_DEFAULT_SECRET_LIFE_SEC 3600
642
643#define SCTP_RTO_UPPER_BOUND	(60000)	/* 60 sec in ms */
644#define SCTP_RTO_LOWER_BOUND	(1000)	/* 1 sec is ms */
645#define SCTP_RTO_INITIAL	(3000)	/* 3 sec in ms */
646
647
648#define SCTP_INP_KILL_TIMEOUT 20/* number of ms to retry kill of inpcb */
649#define SCTP_ASOC_KILL_TIMEOUT 10	/* number of ms to retry kill of inpcb */
650
651#define SCTP_DEF_MAX_INIT		8
652#define SCTP_DEF_MAX_SEND		10
653#define SCTP_DEF_MAX_PATH_RTX		5
654#define SCTP_DEF_PATH_PF_THRESHOLD	SCTP_DEF_MAX_PATH_RTX
655
656#define SCTP_DEF_PMTU_RAISE_SEC	600	/* 10 min between raise attempts */
657
658
659/* How many streams I request initally by default */
660#define SCTP_OSTREAM_INITIAL 10
661
662/*
663 * How many smallest_mtu's need to increase before a window update sack is
664 * sent (should be a power of 2).
665 */
666/* Send window update (incr * this > hiwat). Should be a power of 2 */
667#define SCTP_MINIMAL_RWND		(4096)	/* minimal rwnd */
668
669#define SCTP_ADDRMAX		16
670
671/* SCTP DEBUG Switch parameters */
672#define SCTP_DEBUG_TIMER1	0x00000001
673#define SCTP_DEBUG_TIMER2	0x00000002	/* unused */
674#define SCTP_DEBUG_TIMER3	0x00000004	/* unused */
675#define SCTP_DEBUG_TIMER4	0x00000008
676#define SCTP_DEBUG_OUTPUT1	0x00000010
677#define SCTP_DEBUG_OUTPUT2	0x00000020
678#define SCTP_DEBUG_OUTPUT3	0x00000040
679#define SCTP_DEBUG_OUTPUT4	0x00000080
680#define SCTP_DEBUG_UTIL1	0x00000100
681#define SCTP_DEBUG_UTIL2	0x00000200	/* unused */
682#define SCTP_DEBUG_AUTH1	0x00000400
683#define SCTP_DEBUG_AUTH2	0x00000800	/* unused */
684#define SCTP_DEBUG_INPUT1	0x00001000
685#define SCTP_DEBUG_INPUT2	0x00002000
686#define SCTP_DEBUG_INPUT3	0x00004000
687#define SCTP_DEBUG_INPUT4	0x00008000	/* unused */
688#define SCTP_DEBUG_ASCONF1	0x00010000
689#define SCTP_DEBUG_ASCONF2	0x00020000
690#define SCTP_DEBUG_OUTPUT5	0x00040000	/* unused */
691#define SCTP_DEBUG_XXX		0x00080000	/* unused */
692#define SCTP_DEBUG_PCB1		0x00100000
693#define SCTP_DEBUG_PCB2		0x00200000	/* unused */
694#define SCTP_DEBUG_PCB3		0x00400000
695#define SCTP_DEBUG_PCB4		0x00800000
696#define SCTP_DEBUG_INDATA1	0x01000000
697#define SCTP_DEBUG_INDATA2	0x02000000	/* unused */
698#define SCTP_DEBUG_INDATA3	0x04000000	/* unused */
699#define SCTP_DEBUG_CRCOFFLOAD	0x08000000	/* unused */
700#define SCTP_DEBUG_USRREQ1	0x10000000	/* unused */
701#define SCTP_DEBUG_USRREQ2	0x20000000	/* unused */
702#define SCTP_DEBUG_PEEL1	0x40000000
703#define SCTP_DEBUG_XXXXX	0x80000000	/* unused */
704#define SCTP_DEBUG_ALL		0x7ff3ffff
705#define SCTP_DEBUG_NOISY	0x00040000
706
707/* What sender needs to see to avoid SWS or we consider peers rwnd 0 */
708#define SCTP_SWS_SENDER_DEF	1420
709
710/*
711 * SWS is scaled to the sb_hiwat of the socket. A value of 2 is hiwat/4, 1
712 * would be hiwat/2 etc.
713 */
714/* What receiver needs to see in sockbuf or we tell peer its 1 */
715#define SCTP_SWS_RECEIVER_DEF	3000
716
717#define SCTP_INITIAL_CWND 4380
718
719#define SCTP_DEFAULT_MTU 1500	/* emergency default MTU */
720/* amount peer is obligated to have in rwnd or I will abort */
721#define SCTP_MIN_RWND	1500
722
723#define SCTP_DEFAULT_MAXSEGMENT 65535
724
725#define SCTP_CHUNK_BUFFER_SIZE	512
726#define SCTP_PARAM_BUFFER_SIZE	512
727
728/* small chunk store for looking at chunk_list in auth */
729#define SCTP_SMALL_CHUNK_STORE 260
730
731#define SCTP_DEFAULT_MINSEGMENT 512	/* MTU size ... if no mtu disc */
732#define SCTP_HOW_MANY_SECRETS	2	/* how many secrets I keep */
733
734#define SCTP_NUMBER_OF_SECRETS	8	/* or 8 * 4 = 32 octets */
735#define SCTP_SECRET_SIZE	32	/* number of octets in a 256 bits */
736
737
738/*
739 * SCTP upper layer notifications
740 */
741#define SCTP_NOTIFY_ASSOC_UP                     1
742#define SCTP_NOTIFY_ASSOC_DOWN                   2
743#define SCTP_NOTIFY_INTERFACE_DOWN               3
744#define SCTP_NOTIFY_INTERFACE_UP                 4
745#define SCTP_NOTIFY_SENT_DG_FAIL                 5
746#define SCTP_NOTIFY_UNSENT_DG_FAIL               6
747#define SCTP_NOTIFY_SPECIAL_SP_FAIL              7
748#define SCTP_NOTIFY_ASSOC_LOC_ABORTED            8
749#define SCTP_NOTIFY_ASSOC_REM_ABORTED            9
750#define SCTP_NOTIFY_ASSOC_RESTART               10
751#define SCTP_NOTIFY_PEER_SHUTDOWN               11
752#define SCTP_NOTIFY_ASCONF_ADD_IP               12
753#define SCTP_NOTIFY_ASCONF_DELETE_IP            13
754#define SCTP_NOTIFY_ASCONF_SET_PRIMARY          14
755#define SCTP_NOTIFY_PARTIAL_DELVIERY_INDICATION 15
756#define SCTP_NOTIFY_INTERFACE_CONFIRMED         16
757#define SCTP_NOTIFY_STR_RESET_RECV              17
758#define SCTP_NOTIFY_STR_RESET_SEND              18
759#define SCTP_NOTIFY_STR_RESET_FAILED_OUT        19
760#define SCTP_NOTIFY_STR_RESET_FAILED_IN         20
761#define SCTP_NOTIFY_STR_RESET_DENIED_OUT        21
762#define SCTP_NOTIFY_STR_RESET_DENIED_IN         22
763#define SCTP_NOTIFY_AUTH_NEW_KEY                23
764#define SCTP_NOTIFY_AUTH_FREE_KEY               24
765#define SCTP_NOTIFY_NO_PEER_AUTH                25
766#define SCTP_NOTIFY_SENDER_DRY                  26
767#define SCTP_NOTIFY_REMOTE_ERROR                27
768
769/* This is the value for messages that are NOT completely
770 * copied down where we will start to split the message.
771 * So, with our default, we split only if the piece we
772 * want to take will fill up a full MTU (assuming
773 * a 1500 byte MTU).
774 */
775#define SCTP_DEFAULT_SPLIT_POINT_MIN 2904
776
777/* ABORT CODES and other tell-tale location
778 * codes are generated by adding the below
779 * to the instance id.
780 */
781
782/* File defines */
783#define SCTP_FROM_SCTP_INPUT   0x10000000
784#define SCTP_FROM_SCTP_PCB     0x20000000
785#define SCTP_FROM_SCTP_INDATA  0x30000000
786#define SCTP_FROM_SCTP_TIMER   0x40000000
787#define SCTP_FROM_SCTP_USRREQ  0x50000000
788#define SCTP_FROM_SCTPUTIL     0x60000000
789#define SCTP_FROM_SCTP6_USRREQ 0x70000000
790#define SCTP_FROM_SCTP_ASCONF  0x80000000
791#define SCTP_FROM_SCTP_OUTPUT  0x90000000
792#define SCTP_FROM_SCTP_PEELOFF 0xa0000000
793#define SCTP_FROM_SCTP_PANDA   0xb0000000
794#define SCTP_FROM_SCTP_SYSCTL  0xc0000000
795
796/* Location ID's */
797#define SCTP_LOC_1  0x00000001
798#define SCTP_LOC_2  0x00000002
799#define SCTP_LOC_3  0x00000003
800#define SCTP_LOC_4  0x00000004
801#define SCTP_LOC_5  0x00000005
802#define SCTP_LOC_6  0x00000006
803#define SCTP_LOC_7  0x00000007
804#define SCTP_LOC_8  0x00000008
805#define SCTP_LOC_9  0x00000009
806#define SCTP_LOC_10 0x0000000a
807#define SCTP_LOC_11 0x0000000b
808#define SCTP_LOC_12 0x0000000c
809#define SCTP_LOC_13 0x0000000d
810#define SCTP_LOC_14 0x0000000e
811#define SCTP_LOC_15 0x0000000f
812#define SCTP_LOC_16 0x00000010
813#define SCTP_LOC_17 0x00000011
814#define SCTP_LOC_18 0x00000012
815#define SCTP_LOC_19 0x00000013
816#define SCTP_LOC_20 0x00000014
817#define SCTP_LOC_21 0x00000015
818#define SCTP_LOC_22 0x00000016
819#define SCTP_LOC_23 0x00000017
820#define SCTP_LOC_24 0x00000018
821#define SCTP_LOC_25 0x00000019
822#define SCTP_LOC_26 0x0000001a
823#define SCTP_LOC_27 0x0000001b
824#define SCTP_LOC_28 0x0000001c
825#define SCTP_LOC_29 0x0000001d
826#define SCTP_LOC_30 0x0000001e
827#define SCTP_LOC_31 0x0000001f
828#define SCTP_LOC_32 0x00000020
829#define SCTP_LOC_33 0x00000021
830
831
832/* Free assoc codes */
833#define SCTP_NORMAL_PROC      0
834#define SCTP_PCBFREE_NOFORCE  1
835#define SCTP_PCBFREE_FORCE    2
836
837/* From codes for adding addresses */
838#define SCTP_ADDR_IS_CONFIRMED 8
839#define SCTP_ADDR_DYNAMIC_ADDED 6
840#define SCTP_IN_COOKIE_PROC 100
841#define SCTP_ALLOC_ASOC  1
842#define SCTP_LOAD_ADDR_2 2
843#define SCTP_LOAD_ADDR_3 3
844#define SCTP_LOAD_ADDR_4 4
845#define SCTP_LOAD_ADDR_5 5
846
847#define SCTP_DONOT_SETSCOPE 0
848#define SCTP_DO_SETSCOPE 1
849
850
851/* This value determines the default for when
852 * we try to add more on the send queue., if
853 * there is room. This prevents us from cycling
854 * into the copy_resume routine to often if
855 * we have not got enough space to add a decent
856 * enough size message. Note that if we have enough
857 * space to complete the message copy we will always
858 * add to the message, no matter what the size. Its
859 * only when we reach the point that we have some left
860 * to add, there is only room for part of it that we
861 * will use this threshold. Its also a sysctl.
862 */
863#define SCTP_DEFAULT_ADD_MORE 1452
864
865#ifndef SCTP_PCBHASHSIZE
866/* default number of association hash buckets in each endpoint */
867#define SCTP_PCBHASHSIZE 256
868#endif
869#ifndef SCTP_TCBHASHSIZE
870#define SCTP_TCBHASHSIZE 1024
871#endif
872
873#ifndef SCTP_CHUNKQUEUE_SCALE
874#define SCTP_CHUNKQUEUE_SCALE 10
875#endif
876
877/* clock variance is 1 ms */
878#define SCTP_CLOCK_GRANULARITY	1
879#define IP_HDR_SIZE 40		/* we use the size of a IP6 header here this
880				 * detracts a small amount for ipv4 but it
881				 * simplifies the ipv6 addition */
882
883/* Argument magic number for sctp_inpcb_free() */
884
885/* third argument */
886#define SCTP_CALLED_DIRECTLY_NOCMPSET     0
887#define SCTP_CALLED_AFTER_CMPSET_OFCLOSE  1
888#define SCTP_CALLED_FROM_INPKILL_TIMER    2
889/* second argument */
890#define SCTP_FREE_SHOULD_USE_ABORT          1
891#define SCTP_FREE_SHOULD_USE_GRACEFUL_CLOSE 0
892
893#ifndef IPPROTO_SCTP
894#define IPPROTO_SCTP 132	/* the Official IANA number :-) */
895#endif				/* !IPPROTO_SCTP */
896
897#define SCTP_MAX_DATA_BUNDLING		256
898
899/* modular comparison */
900/* See RFC 1982 for details. */
901#define SCTP_SSN_GT(a, b) (((a < b) && ((uint16_t)(b - a) > (1U<<15))) || \
902                           ((a > b) && ((uint16_t)(a - b) < (1U<<15))))
903#define SCTP_SSN_GE(a, b) (SCTP_SSN_GT(a, b) || (a == b))
904#define SCTP_TSN_GT(a, b) (((a < b) && ((uint32_t)(b - a) > (1U<<31))) || \
905                           ((a > b) && ((uint32_t)(a - b) < (1U<<31))))
906#define SCTP_TSN_GE(a, b) (SCTP_TSN_GT(a, b) || (a == b))
907
908/* Mapping array manipulation routines */
909#define SCTP_IS_TSN_PRESENT(arry, gap) ((arry[(gap >> 3)] >> (gap & 0x07)) & 0x01)
910#define SCTP_SET_TSN_PRESENT(arry, gap) (arry[(gap >> 3)] |= (0x01 << ((gap & 0x07))))
911#define SCTP_UNSET_TSN_PRESENT(arry, gap) (arry[(gap >> 3)] &= ((~(0x01 << ((gap & 0x07)))) & 0xff))
912#define SCTP_CALC_TSN_TO_GAP(gap, tsn, mapping_tsn) do { \
913	                if (tsn >= mapping_tsn) { \
914						gap = tsn - mapping_tsn; \
915					} else { \
916						gap = (MAX_TSN - mapping_tsn) + tsn + 1; \
917					} \
918                  } while (0)
919
920
921#define SCTP_RETRAN_DONE -1
922#define SCTP_RETRAN_EXIT -2
923
924/*
925 * This value defines the number of vtag block time wait entry's per list
926 * element.  Each entry will take 2 4 byte ints (and of course the overhead
927 * of the next pointer as well). Using 15 as an example will yield * ((8 *
928 * 15) + 8) or 128 bytes of overhead for each timewait block that gets
929 * initialized. Increasing it to 31 would yeild 256 bytes per block.
930 */
931#define SCTP_NUMBER_IN_VTAG_BLOCK 15
932/*
933 * If we use the STACK option, we have an array of this size head pointers.
934 * This array is mod'd the with the size to find which bucket and then all
935 * entries must be searched to see if the tag is in timed wait. If so we
936 * reject it.
937 */
938#define SCTP_STACK_VTAG_HASH_SIZE   32
939
940/*
941 * Number of seconds of time wait for a vtag.
942 */
943#define SCTP_TIME_WAIT 60
944
945/* How many micro seconds is the cutoff from
946 * local lan type rtt's
947 */
948 /*
949  * We allow 900us for the rtt.
950  */
951#define SCTP_LOCAL_LAN_RTT 900
952#define SCTP_LAN_UNKNOWN  0
953#define SCTP_LAN_LOCAL    1
954#define SCTP_LAN_INTERNET 2
955
956#define SCTP_SEND_BUFFER_SPLITTING 0x00000001
957#define SCTP_RECV_BUFFER_SPLITTING 0x00000002
958
959/* The system retains a cache of free chunks such to
960 * cut down on calls the memory allocation system. There
961 * is a per association limit of free items and a overall
962 * system limit. If either one gets hit then the resource
963 * stops being cached.
964 */
965
966#define SCTP_DEF_ASOC_RESC_LIMIT 10
967#define SCTP_DEF_SYSTEM_RESC_LIMIT 1000
968
969/*-
970 * defines for socket lock states.
971 * Used by __APPLE__ and SCTP_SO_LOCK_TESTING
972 */
973#define SCTP_SO_LOCKED		1
974#define SCTP_SO_NOT_LOCKED	0
975
976
977#define SCTP_HOLDS_LOCK 1
978#define SCTP_NOT_LOCKED 0
979
980/*-
981 * For address locks, do we hold the lock?
982 */
983#define SCTP_ADDR_LOCKED 1
984#define SCTP_ADDR_NOT_LOCKED 0
985
986#define IN4_ISPRIVATE_ADDRESS(a) \
987   ((((uint8_t *)&(a)->s_addr)[0] == 10) || \
988    ((((uint8_t *)&(a)->s_addr)[0] == 172) && \
989     (((uint8_t *)&(a)->s_addr)[1] >= 16) && \
990     (((uint8_t *)&(a)->s_addr)[1] <= 32)) || \
991    ((((uint8_t *)&(a)->s_addr)[0] == 192) && \
992     (((uint8_t *)&(a)->s_addr)[1] == 168)))
993
994#define IN4_ISLOOPBACK_ADDRESS(a) \
995    ((((uint8_t *)&(a)->s_addr)[0] == 127) && \
996     (((uint8_t *)&(a)->s_addr)[1] == 0) && \
997     (((uint8_t *)&(a)->s_addr)[2] == 0) && \
998     (((uint8_t *)&(a)->s_addr)[3] == 1))
999
1000#define IN4_ISLINKLOCAL_ADDRESS(a) \
1001    ((((uint8_t *)&(a)->s_addr)[0] == 169) && \
1002     (((uint8_t *)&(a)->s_addr)[1] == 254))
1003
1004
1005#if defined(_KERNEL)
1006#define SCTP_GETTIME_TIMEVAL(x) (getmicrouptime(x))
1007#define SCTP_GETPTIME_TIMEVAL(x) (microuptime(x))
1008#endif
1009
1010#if defined(_KERNEL) || defined(__Userspace__)
1011#define sctp_sowwakeup(inp, so) \
1012do { \
1013	if (inp->sctp_flags & SCTP_PCB_FLAGS_DONT_WAKE) { \
1014		inp->sctp_flags |= SCTP_PCB_FLAGS_WAKEOUTPUT; \
1015	} else { \
1016		sowwakeup(so); \
1017	} \
1018} while (0)
1019
1020#define sctp_sowwakeup_locked(inp, so) \
1021do { \
1022	if (inp->sctp_flags & SCTP_PCB_FLAGS_DONT_WAKE) { \
1023                SOCKBUF_UNLOCK(&((so)->so_snd)); \
1024		inp->sctp_flags |= SCTP_PCB_FLAGS_WAKEOUTPUT; \
1025	} else { \
1026		sowwakeup_locked(so); \
1027	} \
1028} while (0)
1029
1030#define sctp_sorwakeup(inp, so) \
1031do { \
1032	if (inp->sctp_flags & SCTP_PCB_FLAGS_DONT_WAKE) { \
1033		inp->sctp_flags |= SCTP_PCB_FLAGS_WAKEINPUT; \
1034	} else { \
1035		sorwakeup(so); \
1036	} \
1037} while (0)
1038
1039#define sctp_sorwakeup_locked(inp, so) \
1040do { \
1041	if (inp->sctp_flags & SCTP_PCB_FLAGS_DONT_WAKE) { \
1042		inp->sctp_flags |= SCTP_PCB_FLAGS_WAKEINPUT; \
1043                SOCKBUF_UNLOCK(&((so)->so_rcv)); \
1044	} else { \
1045		sorwakeup_locked(so); \
1046	} \
1047} while (0)
1048
1049#endif				/* _KERNEL || __Userspace__ */
1050#endif
1051