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