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