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