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