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