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