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