sctp_constants.h revision 171440
1163953Srrs/*-
2169382Srrs * Copyright (c) 2001-2007, by Cisco Systems, Inc. All rights reserved.
3163953Srrs *
4163953Srrs * Redistribution and use in source and binary forms, with or without
5163953Srrs * modification, are permitted provided that the following conditions are met:
6163953Srrs *
7163953Srrs * a) Redistributions of source code must retain the above copyright notice,
8163953Srrs *   this list of conditions and the following disclaimer.
9163953Srrs *
10163953Srrs * b) Redistributions in binary form must reproduce the above copyright
11163953Srrs *    notice, this list of conditions and the following disclaimer in
12163953Srrs *   the documentation and/or other materials provided with the distribution.
13163953Srrs *
14163953Srrs * c) Neither the name of Cisco Systems, Inc. nor the names of its
15163953Srrs *    contributors may be used to endorse or promote products derived
16163953Srrs *    from this software without specific prior written permission.
17163953Srrs *
18163953Srrs * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19163953Srrs * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
20163953Srrs * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21163953Srrs * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
22163953Srrs * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23163953Srrs * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24163953Srrs * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25163953Srrs * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26163953Srrs * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27163953Srrs * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
28163953Srrs * THE POSSIBILITY OF SUCH DAMAGE.
29163953Srrs */
30163953Srrs
31163953Srrs/* $KAME: sctp_constants.h,v 1.17 2005/03/06 16:04:17 itojun Exp $	 */
32163953Srrs
33163953Srrs#include <sys/cdefs.h>
34163953Srrs__FBSDID("$FreeBSD: head/sys/netinet/sctp_constants.h 171440 2007-07-14 09:36:28Z rrs $");
35163953Srrs
36163953Srrs#ifndef __sctp_constants_h__
37163953Srrs#define __sctp_constants_h__
38163953Srrs
39167598Srrs/* Number of packets to get before sack sent by default */
40167598Srrs#define SCTP_DEFAULT_SACK_FREQ 2
41163953Srrs
42167598Srrs/* Address limit - This variable is calculated
43168299Srrs * based on an 65535 byte max ip packet. We take out 100 bytes
44167598Srrs * for the cookie, 40 bytes for a v6 header and 32
45167598Srrs * bytes for the init structure. A second init structure
46167598Srrs * for the init-ack and then finally a third one for the
47167598Srrs * imbedded init. This yeilds 100+40+(3 * 32) = 236 bytes.
48168299Srrs * This leaves 65299 bytes for addresses. We throw out the 299 bytes.
49168299Srrs * Now whatever we send in the INIT() we need to allow to get back in the
50167598Srrs * INIT-ACK plus all the values from INIT and INIT-ACK
51167598Srrs * listed in the cookie. Plus we need some overhead for
52167598Srrs * maybe copied parameters in the COOKIE. If we
53168299Srrs * allow 1080 addresses, and each side has 1080 V6 addresses
54168299Srrs * that will be 21600 bytes. In the INIT-ACK we will
55168299Srrs * see the INIT-ACK 21600 + 43200 in the cookie. This leaves
56168299Srrs * about 500 bytes slack for misc things in the cookie.
57167598Srrs */
58168299Srrs#define SCTP_ADDRESS_LIMIT 1080
59167598Srrs
60167598Srrs/* Number of addresses where we just skip the counting */
61167598Srrs#define SCTP_COUNT_LIMIT 40
62167598Srrs
63170056Srrs#define SCTP_ZERO_COPY_TICK_DELAY (((100 * hz) + 999) / 1000)
64170181Srrs#define SCTP_ZERO_COPY_SENDQ_TICK_DELAY (((100 * hz) + 999) / 1000)
65170056Srrs
66167598Srrs/* Number of ticks to delay before running
67167598Srrs * iterator on an address change.
68167598Srrs */
69167598Srrs#define SCTP_ADDRESS_TICK_DELAY 2
70167598Srrs
71163953Srrs#define SCTP_VERSION_STRING "KAME-BSD 1.1"
72163953Srrs/* #define SCTP_AUDITING_ENABLED 1 used for debug/auditing */
73163953Srrs#define SCTP_AUDIT_SIZE 256
74163953Srrs
75167598Srrs#define SCTP_USE_THREAD_BASED_ITERATOR 1
76167598Srrs
77167598Srrs#define SCTP_KTRHEAD_NAME "sctp_iterator"
78167598Srrs#define SCTP_KTHREAD_PAGES 2
79167598Srrs
80167598Srrs
81167598Srrs/* If you support Multi-VRF how big to
82167598Srrs * make the initial array of VRF's to.
83167598Srrs */
84167598Srrs#define SCTP_DEFAULT_VRF_SIZE 4
85167598Srrs
86171440Srrs/* JRS - Values defined for the HTCP algorithm */
87171440Srrs#define ALPHA_BASE	(1<<7)	/* 1.0 with shift << 7 */
88171440Srrs#define BETA_MIN	(1<<6)	/* 0.5 with shift << 7 */
89171440Srrs#define BETA_MAX	102	/* 0.8 with shift << 7 */
90171440Srrs
91163953Srrs/* Places that CWND log can happen from */
92163953Srrs#define SCTP_CWND_LOG_FROM_FR	1
93163953Srrs#define SCTP_CWND_LOG_FROM_RTX	2
94163953Srrs#define SCTP_CWND_LOG_FROM_BRST	3
95163953Srrs#define SCTP_CWND_LOG_FROM_SS	4
96163953Srrs#define SCTP_CWND_LOG_FROM_CA	5
97163953Srrs#define SCTP_CWND_LOG_FROM_SAT	6
98163953Srrs#define SCTP_BLOCK_LOG_INTO_BLK 7
99163953Srrs#define SCTP_BLOCK_LOG_OUTOF_BLK 8
100163953Srrs#define SCTP_BLOCK_LOG_CHECK     9
101163953Srrs#define SCTP_STR_LOG_FROM_INTO_STRD 10
102163953Srrs#define SCTP_STR_LOG_FROM_IMMED_DEL 11
103163953Srrs#define SCTP_STR_LOG_FROM_INSERT_HD 12
104163953Srrs#define SCTP_STR_LOG_FROM_INSERT_MD 13
105163953Srrs#define SCTP_STR_LOG_FROM_INSERT_TL 14
106163953Srrs#define SCTP_STR_LOG_FROM_MARK_TSN  15
107163953Srrs#define SCTP_STR_LOG_FROM_EXPRS_DEL 16
108163953Srrs#define SCTP_FR_LOG_BIGGEST_TSNS    17
109163953Srrs#define SCTP_FR_LOG_STRIKE_TEST     18
110163953Srrs#define SCTP_FR_LOG_STRIKE_CHUNK    19
111163953Srrs#define SCTP_FR_T3_TIMEOUT          20
112163953Srrs#define SCTP_MAP_PREPARE_SLIDE      21
113163953Srrs#define SCTP_MAP_SLIDE_FROM         22
114163953Srrs#define SCTP_MAP_SLIDE_RESULT       23
115163953Srrs#define SCTP_MAP_SLIDE_CLEARED	    24
116163953Srrs#define SCTP_MAP_SLIDE_NONE         25
117163953Srrs#define SCTP_FR_T3_MARK_TIME        26
118163953Srrs#define SCTP_FR_T3_MARKED           27
119163953Srrs#define SCTP_FR_T3_STOPPED          28
120163953Srrs#define SCTP_FR_MARKED              30
121163953Srrs#define SCTP_CWND_LOG_NOADV_SS      31
122163953Srrs#define SCTP_CWND_LOG_NOADV_CA      32
123163953Srrs#define SCTP_MAX_BURST_APPLIED      33
124163953Srrs#define SCTP_MAX_IFP_APPLIED        34
125163953Srrs#define SCTP_MAX_BURST_ERROR_STOP   35
126163953Srrs#define SCTP_INCREASE_PEER_RWND     36
127163953Srrs#define SCTP_DECREASE_PEER_RWND     37
128163953Srrs#define SCTP_SET_PEER_RWND_VIA_SACK 38
129163953Srrs#define SCTP_LOG_MBCNT_INCREASE     39
130163953Srrs#define SCTP_LOG_MBCNT_DECREASE     40
131163953Srrs#define SCTP_LOG_MBCNT_CHKSET       41
132163953Srrs#define SCTP_LOG_NEW_SACK           42
133163953Srrs#define SCTP_LOG_TSN_ACKED          43
134163953Srrs#define SCTP_LOG_TSN_REVOKED        44
135163953Srrs#define SCTP_LOG_LOCK_TCB           45
136163953Srrs#define SCTP_LOG_LOCK_INP           46
137163953Srrs#define SCTP_LOG_LOCK_SOCK          47
138163953Srrs#define SCTP_LOG_LOCK_SOCKBUF_R     48
139163953Srrs#define SCTP_LOG_LOCK_SOCKBUF_S     49
140163953Srrs#define SCTP_LOG_LOCK_CREATE        50
141163953Srrs#define SCTP_LOG_INITIAL_RTT        51
142163953Srrs#define SCTP_LOG_RTTVAR             52
143163953Srrs#define SCTP_LOG_SBALLOC            53
144163953Srrs#define SCTP_LOG_SBFREE             54
145163953Srrs#define SCTP_LOG_SBRESULT           55
146163953Srrs#define SCTP_FR_DUPED               56
147163953Srrs#define SCTP_FR_MARKED_EARLY        57
148163953Srrs#define SCTP_FR_CWND_REPORT         58
149163953Srrs#define SCTP_FR_CWND_REPORT_START   59
150163953Srrs#define SCTP_FR_CWND_REPORT_STOP    60
151163953Srrs#define SCTP_CWND_LOG_FROM_SEND     61
152163953Srrs#define SCTP_CWND_INITIALIZATION    62
153163953Srrs#define SCTP_CWND_LOG_FROM_T3       63
154163953Srrs#define SCTP_CWND_LOG_FROM_SACK     64
155163953Srrs#define SCTP_CWND_LOG_NO_CUMACK     65
156163953Srrs#define SCTP_CWND_LOG_FROM_RESEND   66
157163953Srrs#define SCTP_FR_LOG_CHECK_STRIKE    67
158163953Srrs#define SCTP_SEND_NOW_COMPLETES     68
159163953Srrs#define SCTP_CWND_LOG_FILL_OUTQ_CALLED 69
160163953Srrs#define SCTP_CWND_LOG_FILL_OUTQ_FILLS  70
161163953Srrs#define SCTP_LOG_FREE_SENT             71
162163953Srrs#define SCTP_NAGLE_APPLIED          72
163163953Srrs#define SCTP_NAGLE_SKIPPED          73
164163953Srrs#define SCTP_WAKESND_FROM_SACK      74
165163953Srrs#define SCTP_WAKESND_FROM_FWDTSN    75
166163953Srrs#define SCTP_NOWAKE_FROM_SACK       76
167163953Srrs#define SCTP_CWNDLOG_PRESEND        77
168163953Srrs#define SCTP_CWNDLOG_ENDSEND        78
169163953Srrs#define SCTP_AT_END_OF_SACK         79
170163953Srrs#define SCTP_REASON_FOR_SC          80
171163953Srrs#define SCTP_BLOCK_LOG_INTO_BLKA    81
172163953Srrs#define SCTP_ENTER_USER_RECV        82
173163953Srrs#define SCTP_USER_RECV_SACKS        83
174163953Srrs#define SCTP_SORECV_BLOCKSA         84
175163953Srrs#define SCTP_SORECV_BLOCKSB         85
176163953Srrs#define SCTP_SORECV_DONE            86
177163953Srrs#define SCTP_SACK_RWND_UPDATE       87
178163953Srrs#define SCTP_SORECV_ENTER           88
179163953Srrs#define SCTP_SORECV_ENTERPL         89
180163953Srrs#define SCTP_MBUF_INPUT             90
181163953Srrs#define SCTP_MBUF_IALLOC            91
182163953Srrs#define SCTP_MBUF_IFREE             92
183163953Srrs#define SCTP_MBUF_ICOPY             93
184163953Srrs#define SCTP_SORCV_FREECTL          94
185163953Srrs#define SCTP_SORCV_DOESCPY          95
186163953Srrs#define SCTP_SORCV_DOESLCK          96
187163953Srrs#define SCTP_SORCV_DOESADJ          97
188163953Srrs#define SCTP_SORCV_BOTWHILE         98
189163953Srrs#define SCTP_SORCV_PASSBF           99
190163953Srrs#define SCTP_SORCV_ADJD            100
191163953Srrs#define SCTP_UNKNOWN_MAX           101
192163953Srrs#define SCTP_RANDY_STUFF           102
193163953Srrs#define SCTP_RANDY_STUFF1          103
194164181Srrs#define SCTP_STRMOUT_LOG_ASSIGN	   104
195164181Srrs#define SCTP_STRMOUT_LOG_SEND	   105
196168709Srrs#define SCTP_FLIGHT_LOG_DOWN_CA    106
197165220Srrs#define SCTP_FLIGHT_LOG_UP         107
198168709Srrs#define SCTP_FLIGHT_LOG_DOWN_GAP   108
199168709Srrs#define SCTP_FLIGHT_LOG_DOWN_RSND  109
200168709Srrs#define SCTP_FLIGHT_LOG_UP_RSND    110
201168709Srrs#define SCTP_FLIGHT_LOG_DOWN_RSND_TO    111
202168709Srrs#define SCTP_FLIGHT_LOG_DOWN_WP    112
203168709Srrs#define SCTP_FLIGHT_LOG_UP_REVOKE  113
204168709Srrs#define SCTP_FLIGHT_LOG_DOWN_PDRP  114
205168709Srrs#define SCTP_FLIGHT_LOG_DOWN_PMTU  115
206169208Srrs#define SCTP_SACK_LOG_NORMAL	   116
207169208Srrs#define SCTP_SACK_LOG_EXPRESS	   117
208169208Srrs
209169208Srrs#define SCTP_LOG_MAX_TYPES 118
210163953Srrs/*
211170744Srrs * To turn on various logging, you must first enable 'options KTR' and
212170744Srrs * you might want to bump the entires 'options KTR_ENTRIES=80000'.
213170744Srrs * To get something to log you define one of the logging defines.
214170744Srrs * (see LINT).
215163953Srrs *
216170744Srrs * This gets the compile in place, but you still need to turn the
217170744Srrs * logging flag on too in the sysctl (see in sctp.h).
218163953Srrs */
219163953Srrs#define SCTP_LOG_EVENT_UNKNOWN 0
220163953Srrs#define SCTP_LOG_EVENT_CWND  1
221163953Srrs#define SCTP_LOG_EVENT_BLOCK 2
222163953Srrs#define SCTP_LOG_EVENT_STRM  3
223163953Srrs#define SCTP_LOG_EVENT_FR    4
224163953Srrs#define SCTP_LOG_EVENT_MAP   5
225163953Srrs#define SCTP_LOG_EVENT_MAXBURST 6
226163953Srrs#define SCTP_LOG_EVENT_RWND  7
227163953Srrs#define SCTP_LOG_EVENT_MBCNT 8
228163953Srrs#define SCTP_LOG_EVENT_SACK  9
229163953Srrs#define SCTP_LOG_LOCK_EVENT 10
230163953Srrs#define SCTP_LOG_EVENT_RTT  11
231163953Srrs#define SCTP_LOG_EVENT_SB   12
232163953Srrs#define SCTP_LOG_EVENT_NAGLE 13
233163953Srrs#define SCTP_LOG_EVENT_WAKE 14
234163953Srrs#define SCTP_LOG_MISC_EVENT 15
235163953Srrs#define SCTP_LOG_EVENT_CLOSE 16
236163953Srrs#define SCTP_LOG_EVENT_MBUF 17
237170744Srrs#define SCTP_LOG_CHUNK_PROC 18
238170744Srrs#define SCTP_LOG_ERROR_RET  19
239163953Srrs
240170744Srrs#define SCTP_LOG_MAX_EVENT 20
241163953Srrs
242163953Srrs#define SCTP_LOCK_UNKNOWN 2
243163953Srrs
244163953Srrs
245163953Srrs/* number of associations by default for zone allocation */
246163953Srrs#define SCTP_MAX_NUM_OF_ASOC	40000
247163953Srrs/* how many addresses per assoc remote and local */
248163953Srrs#define SCTP_SCALE_FOR_ADDR	2
249163953Srrs
250163953Srrs/* default AUTO_ASCONF mode enable(1)/disable(0) value (sysctl) */
251167598Srrs#if defined (__APPLE__) && !defined(SCTP_APPLE_AUTO_ASCONF)
252167598Srrs#define SCTP_DEFAULT_AUTO_ASCONF        0
253167598Srrs#else
254167598Srrs#define SCTP_DEFAULT_AUTO_ASCONF	1
255167598Srrs#endif
256163953Srrs
257163953Srrs/*
258163953Srrs * Theshold for rwnd updates, we have to read (sb_hiwat >>
259163953Srrs * SCTP_RWND_HIWAT_SHIFT) before we will look to see if we need to send a
260163953Srrs * window update sack. When we look, we compare the last rwnd we sent vs the
261163953Srrs * current rwnd. It too must be greater than this value. Using 3 divdes the
262163953Srrs * hiwat by 8, so for 200k rwnd we need to read 24k. For a 64k rwnd we need
263163953Srrs * to read 8k. This seems about right.. I hope :-D.. we do set a
264163953Srrs * min of a MTU on it so if the rwnd is real small we will insist
265163953Srrs * on a full MTU of 1500 bytes.
266163953Srrs */
267163953Srrs#define SCTP_RWND_HIWAT_SHIFT 3
268163953Srrs
269163953Srrs/* How much of the rwnd must the
270163953Srrs * message be taking up to start partial delivery.
271163953Srrs * We calculate this by shifing the hi_water (recv_win)
272163953Srrs * left the following .. set to 1, when a message holds
273163953Srrs * 1/2 the rwnd. If we set it to 2 when a message holds
274163953Srrs * 1/4 the rwnd...etc..
275163953Srrs */
276163953Srrs
277163953Srrs#define SCTP_PARTIAL_DELIVERY_SHIFT 1
278163953Srrs
279163953Srrs/* Minimum number of bytes read by user before we
280163953Srrs * condsider doing a rwnd update
281163953Srrs */
282163953Srrs#define SCTP_MIN_READ_BEFORE_CONSIDERING  3000
283163953Srrs
284163953Srrs/*
285163953Srrs * default HMAC for cookies, etc... use one of the AUTH HMAC id's
286163953Srrs * SCTP_HMAC is the HMAC_ID to use
287163953Srrs * SCTP_SIGNATURE_SIZE is the digest length
288163953Srrs */
289163953Srrs#define SCTP_HMAC		SCTP_AUTH_HMAC_ID_SHA1
290163953Srrs#define SCTP_SIGNATURE_SIZE	SCTP_AUTH_DIGEST_LEN_SHA1
291163953Srrs#define SCTP_SIGNATURE_ALOC_SIZE SCTP_SIGNATURE_SIZE
292163953Srrs
293163953Srrs/* DEFINE HERE WHAT CRC YOU WANT TO USE */
294163953Srrs#define SCTP_USECRC_RFC2960  1
295163953Srrs/* #define SCTP_USECRC_FLETCHER 1 */
296163953Srrs/* #define SCTP_USECRC_SSHCRC32 1 */
297163953Srrs/* #define SCTP_USECRC_FASTCRC32 1 */
298163953Srrs/* #define SCTP_USECRC_CRC32 1 */
299163953Srrs/* #define SCTP_USECRC_TCP32 1 */
300163953Srrs/* #define SCTP_USECRC_CRC16SMAL 1 */
301163953Srrs/* #define SCTP_USECRC_CRC16 1 */
302163953Srrs/* #define SCTP_USECRC_MODADLER 1 */
303163953Srrs
304163953Srrs#ifndef SCTP_ADLER32_BASE
305163953Srrs#define SCTP_ADLER32_BASE 65521
306163953Srrs#endif
307163953Srrs
308163953Srrs/*
309163953Srrs * the SCTP protocol signature this includes the version number encoded in
310163953Srrs * the last 4 bits of the signature.
311163953Srrs */
312163953Srrs#define PROTO_SIGNATURE_A	0x30000000
313163953Srrs#define SCTP_VERSION_NUMBER	0x3
314163953Srrs
315163953Srrs#define MAX_TSN	0xffffffff
316163953Srrs#define MAX_SEQ	0xffff
317163953Srrs
318163953Srrs/* how many executions every N tick's */
319163953Srrs#define SCTP_ITERATOR_MAX_AT_ONCE 20
320163953Srrs
321163953Srrs/* number of clock ticks between iterator executions */
322163953Srrs#define SCTP_ITERATOR_TICKS 1
323163953Srrs
324163953Srrs/*
325163953Srrs * option: If you comment out the following you will receive the old behavior
326163953Srrs * of obeying cwnd for the fast retransmit algorithm. With this defined a FR
327163953Srrs * happens right away with-out waiting for the flightsize to drop below the
328163953Srrs * cwnd value (which is reduced by the FR to 1/2 the inflight packets).
329163953Srrs */
330163953Srrs#define SCTP_IGNORE_CWND_ON_FR 1
331163953Srrs
332163953Srrs/*
333163953Srrs * Adds implementors guide behavior to only use newest highest update in SACK
334163953Srrs * gap ack's to figure out if you need to stroke a chunk for FR.
335163953Srrs */
336163953Srrs#define SCTP_NO_FR_UNLESS_SEGMENT_SMALLER 1
337163953Srrs
338163953Srrs/* default max I can burst out after a fast retransmit */
339163953Srrs#define SCTP_DEF_MAX_BURST 4
340163953Srrs/* IP hdr (20/40) + 12+2+2 (enet) + sctp common 12 */
341163953Srrs#define SCTP_FIRST_MBUF_RESV 68
342163953Srrs/* Packet transmit states in the sent field */
343163953Srrs#define SCTP_DATAGRAM_UNSENT		0
344163953Srrs#define SCTP_DATAGRAM_SENT		1
345163953Srrs#define SCTP_DATAGRAM_RESEND1		2	/* not used (in code, but may
346163953Srrs						 * hit this value) */
347163953Srrs#define SCTP_DATAGRAM_RESEND2		3	/* not used (in code, but may
348163953Srrs						 * hit this value) */
349163953Srrs#define SCTP_DATAGRAM_RESEND		4
350163953Srrs#define SCTP_DATAGRAM_ACKED		10010
351163953Srrs#define SCTP_DATAGRAM_INBOUND		10011
352163953Srrs#define SCTP_READY_TO_TRANSMIT		10012
353163953Srrs#define SCTP_DATAGRAM_MARKED		20010
354163953Srrs#define SCTP_FORWARD_TSN_SKIP		30010
355163953Srrs
356163953Srrs/* chunk output send from locations */
357163953Srrs#define SCTP_OUTPUT_FROM_USR_SEND       0
358163953Srrs#define SCTP_OUTPUT_FROM_T3       	1
359163953Srrs#define SCTP_OUTPUT_FROM_INPUT_ERROR    2
360163953Srrs#define SCTP_OUTPUT_FROM_CONTROL_PROC   3
361163953Srrs#define SCTP_OUTPUT_FROM_SACK_TMR       4
362163953Srrs#define SCTP_OUTPUT_FROM_SHUT_TMR       5
363163953Srrs#define SCTP_OUTPUT_FROM_HB_TMR         6
364163953Srrs#define SCTP_OUTPUT_FROM_SHUT_ACK_TMR   7
365163953Srrs#define SCTP_OUTPUT_FROM_ASCONF_TMR     8
366163953Srrs#define SCTP_OUTPUT_FROM_STRRST_TMR     9
367163953Srrs#define SCTP_OUTPUT_FROM_AUTOCLOSE_TMR  10
368163953Srrs#define SCTP_OUTPUT_FROM_EARLY_FR_TMR   11
369163953Srrs#define SCTP_OUTPUT_FROM_STRRST_REQ     12
370163953Srrs#define SCTP_OUTPUT_FROM_USR_RCVD       13
371164205Srrs#define SCTP_OUTPUT_FROM_COOKIE_ACK     14
372167598Srrs#define SCTP_OUTPUT_FROM_DRAIN          15
373163953Srrs/* SCTP chunk types are moved sctp.h for application (NAT, FW) use */
374163953Srrs
375163953Srrs/* align to 32-bit sizes */
376163953Srrs#define SCTP_SIZE32(x)	((((x)+3) >> 2) << 2)
377163953Srrs
378163953Srrs#define IS_SCTP_CONTROL(a) ((a)->chunk_type != SCTP_DATA)
379163953Srrs#define IS_SCTP_DATA(a) ((a)->chunk_type == SCTP_DATA)
380163953Srrs
381163953Srrs
382163953Srrs/* SCTP parameter types */
383163953Srrs/*************0x0000 series*************/
384163953Srrs#define SCTP_HEARTBEAT_INFO		0x0001
385163953Srrs#define SCTP_IPV4_ADDRESS		0x0005
386163953Srrs#define SCTP_IPV6_ADDRESS		0x0006
387163953Srrs#define SCTP_STATE_COOKIE		0x0007
388163953Srrs#define SCTP_UNRECOG_PARAM		0x0008
389163953Srrs#define SCTP_COOKIE_PRESERVE		0x0009
390163953Srrs#define SCTP_HOSTNAME_ADDRESS		0x000b
391163953Srrs#define SCTP_SUPPORTED_ADDRTYPE		0x000c
392163953Srrs
393163953Srrs/* draft-ietf-stewart-strreset-xxx */
394163953Srrs#define SCTP_STR_RESET_OUT_REQUEST	0x000d
395163953Srrs#define SCTP_STR_RESET_IN_REQUEST	0x000e
396163953Srrs#define SCTP_STR_RESET_TSN_REQUEST	0x000f
397163953Srrs#define SCTP_STR_RESET_RESPONSE		0x0010
398163953Srrs
399163953Srrs#define SCTP_MAX_RESET_PARAMS 2
400163953Srrs#define SCTP_STREAM_RESET_TSN_DELTA    0x1000
401163953Srrs
402163953Srrs/*************0x4000 series*************/
403163953Srrs
404163953Srrs/*************0x8000 series*************/
405163953Srrs#define SCTP_ECN_CAPABLE		0x8000
406163953Srrs/* ECN Nonce: draft-ladha-sctp-ecn-nonce */
407163953Srrs#define SCTP_ECN_NONCE_SUPPORTED	0x8001
408163953Srrs/* draft-ietf-tsvwg-auth-xxx */
409163953Srrs#define SCTP_RANDOM			0x8002
410163953Srrs#define SCTP_CHUNK_LIST			0x8003
411163953Srrs#define SCTP_HMAC_LIST			0x8004
412163953Srrs/*
413163953Srrs * draft-ietf-tsvwg-addip-sctp-xx param=0x8008  len=0xNNNN Byte | Byte | Byte
414163953Srrs * | Byte Byte | Byte ...
415163953Srrs *
416163953Srrs * Where each byte is a chunk type extension supported. For example, to support
417163953Srrs * all chunks one would have (in hex):
418163953Srrs *
419163953Srrs * 80 01 00 09 C0 C1 80 81 82 00 00 00
420163953Srrs *
421163953Srrs * Has the parameter. C0 = PR-SCTP    (RFC3758) C1, 80 = ASCONF (addip draft) 81
422163953Srrs * = Packet Drop 82 = Stream Reset 83 = Authentication
423163953Srrs */
424163953Srrs#define SCTP_SUPPORTED_CHUNK_EXT    0x8008
425163953Srrs
426163953Srrs/*************0xC000 series*************/
427163953Srrs#define SCTP_PRSCTP_SUPPORTED		0xc000
428163953Srrs/* draft-ietf-tsvwg-addip-sctp */
429163953Srrs#define SCTP_ADD_IP_ADDRESS		0xc001
430163953Srrs#define SCTP_DEL_IP_ADDRESS		0xc002
431163953Srrs#define SCTP_ERROR_CAUSE_IND		0xc003
432163953Srrs#define SCTP_SET_PRIM_ADDR		0xc004
433163953Srrs#define SCTP_SUCCESS_REPORT		0xc005
434163953Srrs#define SCTP_ULP_ADAPTATION		0xc006
435163953Srrs
436163953Srrs/* Notification error codes */
437163953Srrs#define SCTP_NOTIFY_DATAGRAM_UNSENT	0x0001
438163953Srrs#define SCTP_NOTIFY_DATAGRAM_SENT	0x0002
439163953Srrs#define SCTP_FAILED_THRESHOLD		0x0004
440163953Srrs#define SCTP_HEARTBEAT_SUCCESS		0x0008
441163953Srrs#define SCTP_RESPONSE_TO_USER_REQ	0x000f
442163953Srrs#define SCTP_INTERNAL_ERROR		0x0010
443163953Srrs#define SCTP_SHUTDOWN_GUARD_EXPIRES	0x0020
444163953Srrs#define SCTP_RECEIVED_SACK		0x0040
445163953Srrs#define SCTP_PEER_FAULTY		0x0080
446163953Srrs
447163953Srrs/* bits for TOS field */
448163953Srrs#define SCTP_ECT0_BIT		0x02
449163953Srrs#define SCTP_ECT1_BIT		0x01
450163953Srrs#define SCTP_CE_BITS		0x03
451163953Srrs
452163953Srrs/* below turns off above */
453163953Srrs#define SCTP_FLEXIBLE_ADDRESS	0x20
454163953Srrs#define SCTP_NO_HEARTBEAT	0x40
455163953Srrs
456163953Srrs/* mask to get sticky */
457163953Srrs#define SCTP_STICKY_OPTIONS_MASK	0x0c
458163953Srrs
459163953Srrs
460163953Srrs/*
461163953Srrs * SCTP states for internal state machine XXX (should match "user" values)
462163953Srrs */
463163953Srrs#define SCTP_STATE_EMPTY		0x0000
464163953Srrs#define SCTP_STATE_INUSE		0x0001
465163953Srrs#define SCTP_STATE_COOKIE_WAIT		0x0002
466163953Srrs#define SCTP_STATE_COOKIE_ECHOED	0x0004
467163953Srrs#define SCTP_STATE_OPEN			0x0008
468163953Srrs#define SCTP_STATE_SHUTDOWN_SENT	0x0010
469163953Srrs#define SCTP_STATE_SHUTDOWN_RECEIVED	0x0020
470163953Srrs#define SCTP_STATE_SHUTDOWN_ACK_SENT	0x0040
471163953Srrs#define SCTP_STATE_SHUTDOWN_PENDING	0x0080
472163953Srrs#define SCTP_STATE_CLOSED_SOCKET	0x0100
473163953Srrs#define SCTP_STATE_ABOUT_TO_BE_FREED    0x0200
474163953Srrs#define SCTP_STATE_PARTIAL_MSG_LEFT     0x0400
475163953Srrs#define SCTP_STATE_MASK			0x007f
476163953Srrs
477163953Srrs#define SCTP_GET_STATE(asoc)	((asoc)->state & SCTP_STATE_MASK)
478163953Srrs
479163953Srrs/* SCTP reachability state for each address */
480163953Srrs#define SCTP_ADDR_REACHABLE		0x001
481163953Srrs#define SCTP_ADDR_NOT_REACHABLE		0x002
482163953Srrs#define SCTP_ADDR_NOHB			0x004
483163953Srrs#define SCTP_ADDR_BEING_DELETED		0x008
484163953Srrs#define SCTP_ADDR_NOT_IN_ASSOC		0x010
485163953Srrs#define SCTP_ADDR_WAS_PRIMARY		0x020
486163953Srrs#define SCTP_ADDR_SWITCH_PRIMARY	0x040
487163953Srrs#define SCTP_ADDR_OUT_OF_SCOPE		0x080
488163953Srrs#define SCTP_ADDR_DOUBLE_SWITCH		0x100
489163953Srrs#define SCTP_ADDR_UNCONFIRMED		0x200
490167598Srrs#define SCTP_ADDR_REQ_PRIMARY           0x400
491171440Srrs/* JRS 5/13/07 - Added potentially failed state for CMT PF */
492171440Srrs#define SCTP_ADDR_PF            0x800
493163953Srrs#define SCTP_REACHABLE_MASK		0x203
494163953Srrs
495163953Srrs/* bound address types (e.g. valid address types to allow) */
496163953Srrs#define SCTP_BOUND_V6		0x01
497163953Srrs#define SCTP_BOUND_V4		0x02
498163953Srrs
499163953Srrs/*
500163953Srrs * what is the default number of mbufs in a chain I allow before switching to
501163953Srrs * a cluster
502163953Srrs */
503163953Srrs#define SCTP_DEFAULT_MBUFS_IN_CHAIN 5
504163953Srrs
505169655Srrs/* How long a cookie lives in milli-seconds */
506169655Srrs#define SCTP_DEFAULT_COOKIE_LIFE	60000
507163953Srrs
508163953Srrs/* resource limit of streams */
509163953Srrs#define MAX_SCTP_STREAMS	2048
510163953Srrs
511163953Srrs/* Maximum the mapping array will  grow to (TSN mapping array) */
512163953Srrs#define SCTP_MAPPING_ARRAY	512
513163953Srrs
514163953Srrs/* size of the inital malloc on the mapping array */
515163953Srrs#define SCTP_INITIAL_MAPPING_ARRAY  16
516163953Srrs/* how much we grow the mapping array each call */
517163953Srrs#define SCTP_MAPPING_ARRAY_INCR     32
518163953Srrs
519163953Srrs/*
520163953Srrs * Here we define the timer types used by the implementation as arguments in
521163953Srrs * the set/get timer type calls.
522163953Srrs */
523163953Srrs#define SCTP_TIMER_INIT 	0
524163953Srrs#define SCTP_TIMER_RECV 	1
525163953Srrs#define SCTP_TIMER_SEND 	2
526163953Srrs#define SCTP_TIMER_HEARTBEAT	3
527163953Srrs#define SCTP_TIMER_PMTU		4
528163953Srrs#define SCTP_TIMER_MAXSHUTDOWN	5
529163953Srrs#define SCTP_TIMER_SIGNATURE	6
530163953Srrs/*
531163953Srrs * number of timer types in the base SCTP structure used in the set/get and
532163953Srrs * has the base default.
533163953Srrs */
534163953Srrs#define SCTP_NUM_TMRS	7
535163953Srrs
536163953Srrs/* timer types */
537163953Srrs#define SCTP_TIMER_TYPE_NONE		0
538163953Srrs#define SCTP_TIMER_TYPE_SEND		1
539163953Srrs#define SCTP_TIMER_TYPE_INIT		2
540163953Srrs#define SCTP_TIMER_TYPE_RECV		3
541163953Srrs#define SCTP_TIMER_TYPE_SHUTDOWN	4
542163953Srrs#define SCTP_TIMER_TYPE_HEARTBEAT	5
543163953Srrs#define SCTP_TIMER_TYPE_COOKIE		6
544163953Srrs#define SCTP_TIMER_TYPE_NEWCOOKIE	7
545163953Srrs#define SCTP_TIMER_TYPE_PATHMTURAISE	8
546163953Srrs#define SCTP_TIMER_TYPE_SHUTDOWNACK	9
547163953Srrs#define SCTP_TIMER_TYPE_ASCONF		10
548163953Srrs#define SCTP_TIMER_TYPE_SHUTDOWNGUARD	11
549163953Srrs#define SCTP_TIMER_TYPE_AUTOCLOSE	12
550163953Srrs#define SCTP_TIMER_TYPE_EVENTWAKE	13
551163953Srrs#define SCTP_TIMER_TYPE_STRRESET        14
552163953Srrs#define SCTP_TIMER_TYPE_INPKILL         15
553163953Srrs#define SCTP_TIMER_TYPE_ITERATOR        16
554163953Srrs#define SCTP_TIMER_TYPE_EARLYFR         17
555163953Srrs#define SCTP_TIMER_TYPE_ASOCKILL        18
556163953Srrs#define SCTP_TIMER_TYPE_ADDR_WQ         19
557170056Srrs#define SCTP_TIMER_TYPE_ZERO_COPY       20
558170181Srrs#define SCTP_TIMER_TYPE_ZCOPY_SENDQ     21
559163953Srrs/* add new timers here - and increment LAST */
560170181Srrs#define SCTP_TIMER_TYPE_LAST            22
561163953Srrs
562163953Srrs#define SCTP_IS_TIMER_TYPE_VALID(t)	(((t) > SCTP_TIMER_TYPE_NONE) && \
563163953Srrs					 ((t) < SCTP_TIMER_TYPE_LAST))
564163953Srrs
565163953Srrs
566163953Srrs
567163953Srrs/*
568163953Srrs * Number of ticks before the soxwakeup() event that is delayed is sent AFTER
569163953Srrs * the accept() call
570163953Srrs */
571163953Srrs#define SCTP_EVENTWAKEUP_WAIT_TICKS	3000
572163953Srrs
573163953Srrs/*
574163953Srrs * Of course we really don't collect stale cookies, being folks of decerning
575163953Srrs * taste. However we do count them, if we get too many before the association
576163953Srrs * comes up.. we give up. Below is the constant that dictates when we give it
577163953Srrs * up...this is a implemenation dependent treatment. In ours we do not ask
578163953Srrs * for a extension of time, but just retry this many times...
579163953Srrs */
580163953Srrs#define SCTP_MAX_STALE_COOKIES_I_COLLECT 10
581163953Srrs
582163953Srrs/* max number of TSN's dup'd that I will hold */
583163953Srrs#define SCTP_MAX_DUP_TSNS	20
584163953Srrs
585163953Srrs/*
586163953Srrs * Here we define the types used when setting the retry amounts.
587163953Srrs */
588163953Srrs/* constants for type of set */
589163953Srrs#define SCTP_MAXATTEMPT_INIT	2
590163953Srrs#define SCTP_MAXATTEMPT_SEND	3
591163953Srrs
592163953Srrs/* Maximum TSN's we will summarize in a drop report */
593163953Srrs#define SCTP_MAX_DROP_REPORT 16
594163953Srrs
595163953Srrs/* How many drop re-attempts we make on  INIT/COOKIE-ECHO */
596163953Srrs#define SCTP_RETRY_DROPPED_THRESH 4
597163953Srrs
598163953Srrs/*
599163953Srrs * And the max we will keep a history of in the tcb which MUST be lower than
600163953Srrs * 256.
601163953Srrs */
602163953Srrs#define SCTP_MAX_DROP_SAVE_REPORT 16
603163953Srrs
604163953Srrs/*
605163953Srrs * Here we define the default timers and the default number of attemts we
606163953Srrs * make for each respective side (send/init).
607163953Srrs */
608163953Srrs
609163953Srrs/*
610163953Srrs * Maxmium number of chunks a single association can have on it. Note that
611163953Srrs * this is a squishy number since the count can run over this if the user
612163953Srrs * sends a large message down .. the fragmented chunks don't count until
613163953Srrs * AFTER the message is on queue.. it would be the next send that blocks
614163953Srrs * things. This number will get tuned up at boot in the sctp_init and use the
615163953Srrs * number of clusters as a base. This way high bandwidth environments will
616163953Srrs * not get impacted by the lower bandwidth sending a bunch of 1 byte chunks
617163953Srrs */
618163953Srrs#define SCTP_ASOC_MAX_CHUNKS_ON_QUEUE 512
619163953Srrs
620167598Srrs/* The conversion from time to ticks and vice versa is done by rounding
621167598Srrs * upwards. This way we can test in the code the time to be positive and
622167598Srrs * know that this corresponds to a positive number of ticks.
623167598Srrs */
624167598Srrs#define MSEC_TO_TICKS(x) ((hz == 1000) ? x : ((((x) * hz) + 999) / 1000))
625167598Srrs#define TICKS_TO_MSEC(x) ((hz == 1000) ? x : ((((x) * 1000) + (hz - 1)) / hz))
626163953Srrs
627163953Srrs#define SEC_TO_TICKS(x) ((x) * hz)
628167598Srrs#define TICKS_TO_SEC(x) (((x) + (hz - 1)) / hz)
629163953Srrs
630163953Srrs/*
631163953Srrs * Basically the minimum amount of time before I do a early FR. Making this
632163953Srrs * value to low will cause duplicate retransmissions.
633163953Srrs */
634163953Srrs#define SCTP_MINFR_MSEC_TIMER 250
635163953Srrs/* The floor this value is allowed to fall to when starting a timer. */
636163953Srrs#define SCTP_MINFR_MSEC_FLOOR 20
637163953Srrs
638163953Srrs/* init timer def = 1 sec */
639163953Srrs#define SCTP_INIT_SEC	1
640163953Srrs
641163953Srrs/* send timer def = 1 seconds */
642163953Srrs#define SCTP_SEND_SEC	1
643163953Srrs
644163953Srrs/* recv timer def = 200ms  */
645163953Srrs#define SCTP_RECV_MSEC	200
646163953Srrs
647163953Srrs/* 30 seconds + RTO (in ms) */
648163953Srrs#define SCTP_HB_DEFAULT_MSEC	30000
649163953Srrs
650163953Srrs/* Max time I will wait for Shutdown to complete */
651163953Srrs#define SCTP_DEF_MAX_SHUTDOWN_SEC 180
652163953Srrs
653163953Srrs
654163953Srrs/*
655163953Srrs * This is how long a secret lives, NOT how long a cookie lives how many
656163953Srrs * ticks the current secret will live.
657163953Srrs */
658163953Srrs#define SCTP_DEFAULT_SECRET_LIFE_SEC 3600
659163953Srrs
660163953Srrs#define SCTP_RTO_UPPER_BOUND	(60000)	/* 60 sec in ms */
661163953Srrs#define SCTP_RTO_UPPER_BOUND_SEC 60	/* for the init timer */
662163953Srrs#define SCTP_RTO_LOWER_BOUND	(1000)	/* 1 sec in ms */
663163953Srrs#define SCTP_RTO_INITIAL	(3000)	/* 3 sec in ms */
664163953Srrs
665163953Srrs
666163953Srrs#define SCTP_INP_KILL_TIMEOUT 20/* number of ms to retry kill of inpcb */
667163953Srrs#define SCTP_ASOC_KILL_TIMEOUT 10	/* number of ms to retry kill of inpcb */
668163953Srrs
669163953Srrs#define SCTP_DEF_MAX_INIT	8
670163953Srrs#define SCTP_DEF_MAX_SEND	10
671170056Srrs#define SCTP_DEF_MAX_PATH_RTX	5
672163953Srrs
673163953Srrs#define SCTP_DEF_PMTU_RAISE_SEC	600	/* 10 min between raise attempts */
674163953Srrs#define SCTP_DEF_PMTU_MIN	600
675163953Srrs
676170056Srrs
677163953Srrs#define SCTP_MSEC_IN_A_SEC	1000
678163953Srrs#define SCTP_USEC_IN_A_SEC	1000000
679163953Srrs#define SCTP_NSEC_IN_A_SEC	1000000000
680163953Srrs
681163953Srrs#define SCTP_MAX_OUTSTANDING_DG	10000
682163953Srrs
683163953Srrs/* How many streams I request initally by default */
684163953Srrs#define SCTP_OSTREAM_INITIAL 10
685163953Srrs
686163953Srrs/*
687163953Srrs * How many smallest_mtu's need to increase before a window update sack is
688163953Srrs * sent (should be a power of 2).
689163953Srrs */
690163953Srrs#define SCTP_SEG_TO_RWND_UPD 32
691163953Srrs/* Send window update (incr * this > hiwat). Should be a power of 2 */
692163953Srrs#define SCTP_SCALE_OF_RWND_TO_UPD       4
693163953Srrs#define SCTP_MINIMAL_RWND		(4096)	/* minimal rwnd */
694163953Srrs
695170606Srrs#define SCTP_ADDRMAX		24
696163953Srrs
697163953Srrs/* SCTP DEBUG Switch parameters */
698163953Srrs#define SCTP_DEBUG_TIMER1	0x00000001
699170181Srrs#define SCTP_DEBUG_TIMER2	0x00000002	/* unused */
700170181Srrs#define SCTP_DEBUG_TIMER3	0x00000004	/* unused */
701163953Srrs#define SCTP_DEBUG_TIMER4	0x00000008
702163953Srrs#define SCTP_DEBUG_OUTPUT1	0x00000010
703163953Srrs#define SCTP_DEBUG_OUTPUT2	0x00000020
704163953Srrs#define SCTP_DEBUG_OUTPUT3	0x00000040
705163953Srrs#define SCTP_DEBUG_OUTPUT4	0x00000080
706163953Srrs#define SCTP_DEBUG_UTIL1	0x00000100
707170181Srrs#define SCTP_DEBUG_UTIL2	0x00000200	/* unused */
708163953Srrs#define SCTP_DEBUG_AUTH1	0x00000400
709170181Srrs#define SCTP_DEBUG_AUTH2	0x00000800	/* unused */
710163953Srrs#define SCTP_DEBUG_INPUT1	0x00001000
711163953Srrs#define SCTP_DEBUG_INPUT2	0x00002000
712163953Srrs#define SCTP_DEBUG_INPUT3	0x00004000
713170181Srrs#define SCTP_DEBUG_INPUT4	0x00008000	/* unused */
714163953Srrs#define SCTP_DEBUG_ASCONF1	0x00010000
715163953Srrs#define SCTP_DEBUG_ASCONF2	0x00020000
716170181Srrs#define SCTP_DEBUG_OUTPUT5	0x00040000	/* unused */
717170181Srrs#define SCTP_DEBUG_XXX		0x00080000	/* unused */
718163953Srrs#define SCTP_DEBUG_PCB1		0x00100000
719170181Srrs#define SCTP_DEBUG_PCB2		0x00200000	/* unused */
720163953Srrs#define SCTP_DEBUG_PCB3		0x00400000
721170181Srrs#define SCTP_DEBUG_PCB4		0x00800000	/* unused */
722163953Srrs#define SCTP_DEBUG_INDATA1	0x01000000
723170181Srrs#define SCTP_DEBUG_INDATA2	0x02000000	/* unused */
724170181Srrs#define SCTP_DEBUG_INDATA3	0x04000000	/* unused */
725170181Srrs#define SCTP_DEBUG_INDATA4	0x08000000	/* unused */
726170181Srrs#define SCTP_DEBUG_USRREQ1	0x10000000	/* unused */
727170181Srrs#define SCTP_DEBUG_USRREQ2	0x20000000	/* unused */
728163953Srrs#define SCTP_DEBUG_PEEL1	0x40000000
729170181Srrs#define SCTP_DEBUG_XXXXX	0x80000000	/* unused */
730163953Srrs#define SCTP_DEBUG_ALL		0x7ff3ffff
731163953Srrs#define SCTP_DEBUG_NOISY	0x00040000
732163953Srrs
733163953Srrs/* What sender needs to see to avoid SWS or we consider peers rwnd 0 */
734163953Srrs#define SCTP_SWS_SENDER_DEF	1420
735163953Srrs
736163953Srrs/*
737163953Srrs * SWS is scaled to the sb_hiwat of the socket. A value of 2 is hiwat/4, 1
738163953Srrs * would be hiwat/2 etc.
739163953Srrs */
740163953Srrs/* What receiver needs to see in sockbuf or we tell peer its 1 */
741163953Srrs#define SCTP_SWS_RECEIVER_DEF	3000
742163953Srrs
743163953Srrs#define SCTP_INITIAL_CWND 4380
744163953Srrs
745169352Srrs#define SCTP_DEFAULT_MTU 1500	/* emegency default MTU */
746163953Srrs/* amount peer is obligated to have in rwnd or I will abort */
747163953Srrs#define SCTP_MIN_RWND	1500
748163953Srrs
749163953Srrs#define SCTP_WINDOW_MIN	1500	/* smallest rwnd can be */
750163953Srrs#define SCTP_WINDOW_MAX 1048576	/* biggest I can grow rwnd to My playing
751163953Srrs				 * around suggests a value greater than 64k
752163953Srrs				 * does not do much, I guess via the kernel
753163953Srrs				 * limitations on the stream/socket. */
754163953Srrs
755163953Srrs/* I can handle a 1meg re-assembly */
756163953Srrs#define SCTP_DEFAULT_MAXMSGREASM 1048576
757163953Srrs
758163953Srrs#define SCTP_DEFAULT_MAXSEGMENT 65535
759163953Srrs
760170642Srrs#define SCTP_CHUNK_BUFFER_SIZE	512
761166675Srrs#define SCTP_PARAM_BUFFER_SIZE	512
762163953Srrs
763163953Srrs#define SCTP_DEFAULT_MINSEGMENT 512	/* MTU size ... if no mtu disc */
764163953Srrs#define SCTP_HOW_MANY_SECRETS	2	/* how many secrets I keep */
765163953Srrs
766163953Srrs#define SCTP_NUMBER_OF_SECRETS	8	/* or 8 * 4 = 32 octets */
767163953Srrs#define SCTP_SECRET_SIZE	32	/* number of octets in a 256 bits */
768163953Srrs
769163953Srrs
770163953Srrs/*
771163953Srrs * SCTP upper layer notifications
772163953Srrs */
773163953Srrs#define SCTP_NOTIFY_ASSOC_UP		1
774163953Srrs#define SCTP_NOTIFY_ASSOC_DOWN		2
775163953Srrs#define SCTP_NOTIFY_INTERFACE_DOWN	3
776163953Srrs#define SCTP_NOTIFY_INTERFACE_UP	4
777163953Srrs#define SCTP_NOTIFY_DG_FAIL		5
778163953Srrs#define SCTP_NOTIFY_STRDATA_ERR 	6
779163953Srrs#define SCTP_NOTIFY_ASSOC_ABORTED	7
780163953Srrs#define SCTP_NOTIFY_PEER_OPENED_STREAM	8
781163953Srrs#define SCTP_NOTIFY_STREAM_OPENED_OK	9
782163953Srrs#define SCTP_NOTIFY_ASSOC_RESTART	10
783163953Srrs#define SCTP_NOTIFY_HB_RESP             11
784163953Srrs#define SCTP_NOTIFY_ASCONF_SUCCESS	12
785163953Srrs#define SCTP_NOTIFY_ASCONF_FAILED	13
786163953Srrs#define SCTP_NOTIFY_PEER_SHUTDOWN	14
787163953Srrs#define SCTP_NOTIFY_ASCONF_ADD_IP	15
788163953Srrs#define SCTP_NOTIFY_ASCONF_DELETE_IP	16
789163953Srrs#define SCTP_NOTIFY_ASCONF_SET_PRIMARY	17
790163953Srrs#define SCTP_NOTIFY_PARTIAL_DELVIERY_INDICATION 18
791163953Srrs#define SCTP_NOTIFY_ADAPTATION_INDICATION       19
792163953Srrs/* same as above */
793163953Srrs#define SCTP_NOTIFY_ADAPTION_INDICATION         19
794163953Srrs#define SCTP_NOTIFY_INTERFACE_CONFIRMED 20
795163953Srrs#define SCTP_NOTIFY_STR_RESET_RECV      21
796163953Srrs#define SCTP_NOTIFY_STR_RESET_SEND      22
797163953Srrs#define SCTP_NOTIFY_STR_RESET_FAILED_OUT 23
798163953Srrs#define SCTP_NOTIFY_STR_RESET_FAILED_IN 24
799163953Srrs#define SCTP_NOTIFY_AUTH_NEW_KEY	25
800163953Srrs#define SCTP_NOTIFY_AUTH_KEY_CONFLICT	26
801163953Srrs#define SCTP_NOTIFY_SPECIAL_SP_FAIL     27
802163953Srrs#define SCTP_NOTIFY_MAX			27
803163953Srrs
804163953Srrs/* This is the value for messages that are NOT completely
805163953Srrs * copied down where we will start to split the message.
806163953Srrs * So, with our default, we split only if the piece we
807163953Srrs * want to take will fill up a full MTU (assuming
808163953Srrs * a 1500 byte MTU).
809163953Srrs */
810168124Srrs#define SCTP_DEFAULT_SPLIT_POINT_MIN 2904
811163953Srrs
812165220Srrs/* ABORT CODES and other tell-tale location
813165220Srrs * codes are generated by adding the below
814165220Srrs * to the instance id.
815165220Srrs */
816165220Srrs
817165220Srrs/* File defines */
818165220Srrs#define SCTP_FROM_SCTP_INPUT   0x10000000
819165220Srrs#define SCTP_FROM_SCTP_PCB     0x20000000
820165220Srrs#define SCTP_FROM_SCTP_INDATA  0x30000000
821165220Srrs#define SCTP_FROM_SCTP_TIMER   0x40000000
822165220Srrs#define SCTP_FROM_SCTP_USRREQ  0x50000000
823165220Srrs#define SCTP_FROM_SCTPUTIL     0x60000000
824165220Srrs#define SCTP_FROM_SCTP6_USRREQ 0x70000000
825165220Srrs#define SCTP_FROM_SCTP_ASCONF  0x80000000
826165220Srrs#define SCTP_FROM_SCTP_OUTPUT  0x90000000
827165220Srrs#define SCTP_FROM_SCTP_PEELOFF 0xa0000000
828170056Srrs#define SCTP_FROM_SCTP_PANDA   0xb0000000
829165220Srrs
830165220Srrs/* Location ID's */
831165220Srrs#define SCTP_LOC_1  0x00000001
832165220Srrs#define SCTP_LOC_2  0x00000002
833165220Srrs#define SCTP_LOC_3  0x00000003
834165220Srrs#define SCTP_LOC_4  0x00000004
835165220Srrs#define SCTP_LOC_5  0x00000005
836165220Srrs#define SCTP_LOC_6  0x00000006
837165220Srrs#define SCTP_LOC_7  0x00000007
838165220Srrs#define SCTP_LOC_8  0x00000008
839165220Srrs#define SCTP_LOC_9  0x00000009
840165220Srrs#define SCTP_LOC_10 0x0000000a
841165220Srrs#define SCTP_LOC_11 0x0000000b
842165220Srrs#define SCTP_LOC_12 0x0000000c
843165220Srrs#define SCTP_LOC_13 0x0000000d
844165220Srrs#define SCTP_LOC_14 0x0000000e
845165220Srrs#define SCTP_LOC_15 0x0000000f
846165220Srrs#define SCTP_LOC_16 0x00000010
847165220Srrs#define SCTP_LOC_17 0x00000011
848165220Srrs#define SCTP_LOC_18 0x00000012
849165220Srrs#define SCTP_LOC_19 0x00000013
850165220Srrs#define SCTP_LOC_20 0x00000014
851165220Srrs#define SCTP_LOC_21 0x00000015
852165220Srrs#define SCTP_LOC_22 0x00000016
853165220Srrs#define SCTP_LOC_23 0x00000017
854165220Srrs#define SCTP_LOC_24 0x00000018
855165220Srrs#define SCTP_LOC_25 0x00000019
856165220Srrs#define SCTP_LOC_26 0x0000001a
857165220Srrs#define SCTP_LOC_27 0x0000001b
858165220Srrs#define SCTP_LOC_28 0x0000001c
859165220Srrs#define SCTP_LOC_29 0x0000001d
860165220Srrs#define SCTP_LOC_30 0x0000001e
861165220Srrs#define SCTP_LOC_31 0x0000001f
862165220Srrs#define SCTP_LOC_32 0x00000020
863169352Srrs#define SCTP_LOC_33 0x00000021
864165220Srrs
865165220Srrs
866165220Srrs/* Free assoc codes */
867165220Srrs#define SCTP_NORMAL_PROC      0
868165220Srrs#define SCTP_PCBFREE_NOFORCE  1
869165220Srrs#define SCTP_PCBFREE_FORCE    2
870165220Srrs
871165220Srrs/* From codes for adding addresses */
872165220Srrs#define SCTP_ADDR_IS_CONFIRMED 8
873165220Srrs#define SCTP_ADDR_DYNAMIC_ADDED 6
874165220Srrs#define SCTP_IN_COOKIE_PROC 100
875165220Srrs#define SCTP_ALLOC_ASOC  1
876165220Srrs#define SCTP_LOAD_ADDR_2 2
877165220Srrs#define SCTP_LOAD_ADDR_3 3
878165220Srrs#define SCTP_LOAD_ADDR_4 4
879165220Srrs#define SCTP_LOAD_ADDR_5 5
880165220Srrs
881165220Srrs#define SCTP_DONOT_SETSCOPE 0
882165220Srrs#define SCTP_DO_SETSCOPE 1
883165220Srrs
884165220Srrs
885163953Srrs/* This value determines the default for when
886163953Srrs * we try to add more on the send queue., if
887163953Srrs * there is room. This prevents us from cycling
888163953Srrs * into the copy_resume routine to often if
889163953Srrs * we have not got enough space to add a decent
890163953Srrs * enough size message. Note that if we have enough
891163953Srrs * space to complete the message copy we will always
892163953Srrs * add to the message, no matter what the size. Its
893163953Srrs * only when we reach the point that we have some left
894163953Srrs * to add, there is only room for part of it that we
895163953Srrs * will use this threshold. Its also a sysctl.
896163953Srrs */
897163953Srrs#define SCTP_DEFAULT_ADD_MORE 1452
898163953Srrs
899163953Srrs#ifndef SCTP_PCBHASHSIZE
900163953Srrs/* default number of association hash buckets in each endpoint */
901163953Srrs#define SCTP_PCBHASHSIZE 256
902163953Srrs#endif
903163953Srrs#ifndef SCTP_TCBHASHSIZE
904163953Srrs#define SCTP_TCBHASHSIZE 1024
905163953Srrs#endif
906163953Srrs
907163953Srrs#ifndef SCTP_CHUNKQUEUE_SCALE
908163953Srrs#define SCTP_CHUNKQUEUE_SCALE 10
909163953Srrs#endif
910163953Srrs
911163953Srrs/* clock variance is 1 ms */
912163953Srrs#define SCTP_CLOCK_GRANULARITY	1
913163953Srrs#define IP_HDR_SIZE 40		/* we use the size of a IP6 header here this
914163953Srrs				 * detracts a small amount for ipv4 but it
915163953Srrs				 * simplifies the ipv6 addition */
916163953Srrs
917169380Srrs/* Argument magic number for sctp_inpcb_free() */
918169380Srrs
919169380Srrs/* third argument */
920169380Srrs#define SCTP_CALLED_DIRECTLY_NOCMPSET     0
921169380Srrs#define SCTP_CALLED_AFTER_CMPSET_OFCLOSE  1
922169380Srrs
923169380Srrs/* second argument */
924169380Srrs#define SCTP_FREE_SHOULD_USE_ABORT          1
925169380Srrs#define SCTP_FREE_SHOULD_USE_GRACEFUL_CLOSE 0
926169380Srrs
927163953Srrs#ifndef IPPROTO_SCTP
928163953Srrs#define IPPROTO_SCTP 132	/* the Official IANA number :-) */
929163953Srrs#endif				/* !IPPROTO_SCTP */
930163953Srrs
931163953Srrs#define SCTP_MAX_DATA_BUNDLING		256
932163953Srrs#define SCTP_MAX_CONTROL_BUNDLING	20
933163953Srrs
934163953Srrs/* modular comparison */
935163953Srrs/* True if a > b (mod = M) */
936163953Srrs#define compare_with_wrap(a, b, M) (((a > b) && ((a - b) < ((M >> 1) + 1))) || \
937163953Srrs              ((b > a) && ((b - a) > ((M >> 1) + 1))))
938163953Srrs
939163953Srrs
940163953Srrs/* Mapping array manipulation routines */
941163953Srrs#define SCTP_IS_TSN_PRESENT(arry, gap) ((arry[(gap >> 3)] >> (gap & 0x07)) & 0x01)
942163953Srrs#define SCTP_SET_TSN_PRESENT(arry, gap) (arry[(gap >> 3)] |= (0x01 << ((gap & 0x07))))
943163953Srrs#define SCTP_UNSET_TSN_PRESENT(arry, gap) (arry[(gap >> 3)] &= ((~(0x01 << ((gap & 0x07)))) & 0xff))
944163953Srrs
945163953Srrs
946168124Srrs#define SCTP_RETRAN_DONE -1
947168124Srrs#define SCTP_RETRAN_EXIT -2
948168124Srrs
949163953Srrs/*
950163953Srrs * This value defines the number of vtag block time wait entry's per list
951163953Srrs * element.  Each entry will take 2 4 byte ints (and of course the overhead
952163953Srrs * of the next pointer as well). Using 15 as an example will yield * ((8 *
953163953Srrs * 15) + 8) or 128 bytes of overhead for each timewait block that gets
954163953Srrs * initialized. Increasing it to 31 would yeild 256 bytes per block.
955163953Srrs */
956163953Srrs#define SCTP_NUMBER_IN_VTAG_BLOCK 15
957163953Srrs/*
958163953Srrs * If we use the STACK option, we have an array of this size head pointers.
959163953Srrs * This array is mod'd the with the size to find which bucket and then all
960163953Srrs * entries must be searched to see if the tag is in timed wait. If so we
961163953Srrs * reject it.
962163953Srrs */
963170138Srrs#define SCTP_STACK_VTAG_HASH_SIZE   31
964170138Srrs#define SCTP_STACK_VTAG_HASH_SIZE_A 32
965163953Srrs
966170138Srrs
967163953Srrs/*
968163953Srrs * If we use the per-endpoint model than we do not have a hash table of
969163953Srrs * entries but instead have a single head pointer and we must crawl through
970163953Srrs * the entire list.
971163953Srrs */
972163953Srrs
973163953Srrs/*
974163953Srrs * Number of seconds of time wait, tied to MSL value (2 minutes), so 2 * MSL
975163953Srrs * = 4 minutes or 480 seconds.
976163953Srrs */
977163953Srrs#define SCTP_TIME_WAIT 480
978163953Srrs
979166023Srrs/* This time wait is the same as the default cookie life
980166023Srrs * since we now enter a tag in every time we send a cookie.
981166023Srrs * We want this shorter to avoid vtag depletion.
982166023Srrs */
983166023Srrs#define SCTP_TIME_WAIT_SHORT 60
984166023Srrs
985163953Srrs/* The system retains a cache of free chunks such to
986163953Srrs * cut down on calls the memory allocation system. There
987163953Srrs * is a per association limit of free items and a overall
988163953Srrs * system limit. If either one gets hit then the resource
989163953Srrs * stops being cached.
990163953Srrs */
991163953Srrs
992163953Srrs#define SCTP_DEF_ASOC_RESC_LIMIT 10
993163953Srrs#define SCTP_DEF_SYSTEM_RESC_LIMIT 1000
994163953Srrs
995163953Srrs
996163953Srrs#define IN4_ISPRIVATE_ADDRESS(a) \
997166675Srrs   ((((uint8_t *)&(a)->s_addr)[0] == 10) || \
998166675Srrs    ((((uint8_t *)&(a)->s_addr)[0] == 172) && \
999166675Srrs     (((uint8_t *)&(a)->s_addr)[1] >= 16) && \
1000166675Srrs     (((uint8_t *)&(a)->s_addr)[1] <= 32)) || \
1001166675Srrs    ((((uint8_t *)&(a)->s_addr)[0] == 192) && \
1002166675Srrs     (((uint8_t *)&(a)->s_addr)[1] == 168)))
1003163953Srrs
1004163953Srrs#define IN4_ISLOOPBACK_ADDRESS(a) \
1005166675Srrs    ((((uint8_t *)&(a)->s_addr)[0] == 127) && \
1006166675Srrs     (((uint8_t *)&(a)->s_addr)[1] == 0) && \
1007166675Srrs     (((uint8_t *)&(a)->s_addr)[2] == 0) && \
1008166675Srrs     (((uint8_t *)&(a)->s_addr)[3] == 1))
1009163953Srrs
1010163953Srrs
1011163953Srrs#if defined(_KERNEL)
1012163953Srrs
1013163953Srrs#define SCTP_GETTIME_TIMEVAL(x)	(getmicrouptime(x))
1014163953Srrs#define SCTP_GETPTIME_TIMEVAL(x)	(microuptime(x))
1015163953Srrs/*#if defined(__FreeBSD__) || defined(__APPLE__)*/
1016163953Srrs/*#define SCTP_GETTIME_TIMEVAL(x) { \*/
1017163953Srrs/*	(x)->tv_sec = ticks / 1000; \*/
1018163953Srrs/*	(x)->tv_usec = (ticks % 1000) * 1000; \*/
1019163953Srrs/*}*/
1020163953Srrs
1021163953Srrs/*#else*/
1022163953Srrs/*#define SCTP_GETTIME_TIMEVAL(x)	(microtime(x))*/
1023163953Srrs/*#endif				 __FreeBSD__ */
1024163953Srrs
1025163953Srrs#define sctp_sowwakeup(inp, so) \
1026163953Srrsdo { \
1027163953Srrs	if (inp->sctp_flags & SCTP_PCB_FLAGS_DONT_WAKE) { \
1028163953Srrs		inp->sctp_flags |= SCTP_PCB_FLAGS_WAKEOUTPUT; \
1029163953Srrs	} else { \
1030163953Srrs		sowwakeup(so); \
1031163953Srrs	} \
1032163953Srrs} while (0)
1033163953Srrs
1034163953Srrs#define sctp_sowwakeup_locked(inp, so) \
1035163953Srrsdo { \
1036163953Srrs	if (inp->sctp_flags & SCTP_PCB_FLAGS_DONT_WAKE) { \
1037163953Srrs                SOCKBUF_UNLOCK(&((so)->so_snd)); \
1038163953Srrs		inp->sctp_flags |= SCTP_PCB_FLAGS_WAKEOUTPUT; \
1039163953Srrs	} else { \
1040163953Srrs		sowwakeup_locked(so); \
1041163953Srrs	} \
1042163953Srrs} while (0)
1043163953Srrs
1044163953Srrs#define sctp_sorwakeup(inp, so) \
1045163953Srrsdo { \
1046163953Srrs	if (inp->sctp_flags & SCTP_PCB_FLAGS_DONT_WAKE) { \
1047163953Srrs		inp->sctp_flags |= SCTP_PCB_FLAGS_WAKEINPUT; \
1048163953Srrs	} else { \
1049163953Srrs		sorwakeup(so); \
1050163953Srrs	} \
1051163953Srrs} while (0)
1052163953Srrs
1053163953Srrs#define sctp_sorwakeup_locked(inp, so) \
1054163953Srrsdo { \
1055163953Srrs	if (inp->sctp_flags & SCTP_PCB_FLAGS_DONT_WAKE) { \
1056163953Srrs		inp->sctp_flags |= SCTP_PCB_FLAGS_WAKEINPUT; \
1057163953Srrs                SOCKBUF_UNLOCK(&((so)->so_rcv)); \
1058163953Srrs	} else { \
1059163953Srrs		sorwakeup_locked(so); \
1060163953Srrs	} \
1061163953Srrs} while (0)
1062163953Srrs
1063163953Srrs#endif				/* _KERNEL */
1064163953Srrs#endif
1065