]> CyberLeo.Net >> Repos - FreeBSD/releng/8.1.git/blob - sys/netinet/sctp_constants.h
Copy stable/8 to releng/8.1 in preparation for 8.1-RC1.
[FreeBSD/releng/8.1.git] / sys / netinet / sctp_constants.h
1 /*-
2  * Copyright (c) 2001-2008, 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 /* IANA assigned port number for SCTP over UDP encapsulation */
40 /* For freebsd we cannot bind the port at
41  * startup. Otherwise what will happen is
42  * we really won't be bound. The user must
43  * put it into the sysctl... or we need
44  * to build a special timer for this to allow
45  * us to wait 1 second or so after the system
46  * comes up.
47  */
48 #define SCTP_OVER_UDP_TUNNELING_PORT 0
49 /* Number of packets to get before sack sent by default */
50 #define SCTP_DEFAULT_SACK_FREQ 2
51
52 /* Address limit - This variable is calculated
53  * based on an 65535 byte max ip packet. We take out 100 bytes
54  * for the cookie, 40 bytes for a v6 header and 32
55  * bytes for the init structure. A second init structure
56  * for the init-ack and then finally a third one for the
57  * imbedded init. This yeilds 100+40+(3 * 32) = 236 bytes.
58  * This leaves 65299 bytes for addresses. We throw out the 299 bytes.
59  * Now whatever we send in the INIT() we need to allow to get back in the
60  * INIT-ACK plus all the values from INIT and INIT-ACK
61  * listed in the cookie. Plus we need some overhead for
62  * maybe copied parameters in the COOKIE. If we
63  * allow 1080 addresses, and each side has 1080 V6 addresses
64  * that will be 21600 bytes. In the INIT-ACK we will
65  * see the INIT-ACK 21600 + 43200 in the cookie. This leaves
66  * about 500 bytes slack for misc things in the cookie.
67  */
68 #define SCTP_ADDRESS_LIMIT 1080
69
70 /* We need at least 2k of space for us, inits
71  * larger than that lets abort.
72  */
73 #define SCTP_LARGEST_INIT_ACCEPTED (65535 - 2048)
74
75 /* Number of addresses where we just skip the counting */
76 #define SCTP_COUNT_LIMIT 40
77
78 #define SCTP_ZERO_COPY_TICK_DELAY (((100 * hz) + 999) / 1000)
79 #define SCTP_ZERO_COPY_SENDQ_TICK_DELAY (((100 * hz) + 999) / 1000)
80
81 /* Number of ticks to delay before running
82  * iterator on an address change.
83  */
84 #define SCTP_ADDRESS_TICK_DELAY 2
85
86 #define SCTP_VERSION_STRING "KAME-BSD 1.1"
87 /* #define SCTP_AUDITING_ENABLED 1 used for debug/auditing */
88 #define SCTP_AUDIT_SIZE 256
89
90
91 #define SCTP_KTRHEAD_NAME "sctp_iterator"
92 #define SCTP_KTHREAD_PAGES 0
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 AUTO_ASCONF mode enable(1)/disable(0) value (sysctl) */
275 #define SCTP_DEFAULT_AUTO_ASCONF        1
276
277 /* default MULTIPLE_ASCONF mode enable(1)/disable(0) value (sysctl) */
278 #define SCTP_DEFAULT_MULTIPLE_ASCONFS   0
279
280 /* default MOBILITY_BASE mode enable(1)/disable(0) value (sysctl) */
281 #define SCTP_DEFAULT_MOBILITY_BASE      0
282
283 /* default MOBILITY_FASTHANDOFF mode enable(1)/disable(0) value (sysctl) */
284 #define SCTP_DEFAULT_MOBILITY_FASTHANDOFF       0
285
286 /*
287  * Theshold for rwnd updates, we have to read (sb_hiwat >>
288  * SCTP_RWND_HIWAT_SHIFT) before we will look to see if we need to send a
289  * window update sack. When we look, we compare the last rwnd we sent vs the
290  * current rwnd. It too must be greater than this value. Using 3 divdes the
291  * hiwat by 8, so for 200k rwnd we need to read 24k. For a 64k rwnd we need
292  * to read 8k. This seems about right.. I hope :-D.. we do set a
293  * min of a MTU on it so if the rwnd is real small we will insist
294  * on a full MTU of 1500 bytes.
295  */
296 #define SCTP_RWND_HIWAT_SHIFT 3
297
298 /* How much of the rwnd must the
299  * message be taking up to start partial delivery.
300  * We calculate this by shifing the hi_water (recv_win)
301  * left the following .. set to 1, when a message holds
302  * 1/2 the rwnd. If we set it to 2 when a message holds
303  * 1/4 the rwnd...etc..
304  */
305
306 #define SCTP_PARTIAL_DELIVERY_SHIFT 1
307
308 /*
309  * default HMAC for cookies, etc... use one of the AUTH HMAC id's
310  * SCTP_HMAC is the HMAC_ID to use
311  * SCTP_SIGNATURE_SIZE is the digest length
312  */
313 #define SCTP_HMAC               SCTP_AUTH_HMAC_ID_SHA1
314 #define SCTP_SIGNATURE_SIZE     SCTP_AUTH_DIGEST_LEN_SHA1
315 #define SCTP_SIGNATURE_ALOC_SIZE SCTP_SIGNATURE_SIZE
316
317 /*
318  * the SCTP protocol signature this includes the version number encoded in
319  * the last 4 bits of the signature.
320  */
321 #define PROTO_SIGNATURE_A       0x30000000
322 #define SCTP_VERSION_NUMBER     0x3
323
324 #define MAX_TSN 0xffffffff
325 #define MAX_SEQ 0xffff
326
327 /* how many executions every N tick's */
328 #define SCTP_ITERATOR_MAX_AT_ONCE 20
329
330 /* number of clock ticks between iterator executions */
331 #define SCTP_ITERATOR_TICKS 1
332
333 /*
334  * option: If you comment out the following you will receive the old behavior
335  * of obeying cwnd for the fast retransmit algorithm. With this defined a FR
336  * happens right away with-out waiting for the flightsize to drop below the
337  * cwnd value (which is reduced by the FR to 1/2 the inflight packets).
338  */
339 #define SCTP_IGNORE_CWND_ON_FR 1
340
341 /*
342  * Adds implementors guide behavior to only use newest highest update in SACK
343  * gap ack's to figure out if you need to stroke a chunk for FR.
344  */
345 #define SCTP_NO_FR_UNLESS_SEGMENT_SMALLER 1
346
347 /* default max I can burst out after a fast retransmit */
348 #define SCTP_DEF_MAX_BURST 4
349 /* IP hdr (20/40) + 12+2+2 (enet) + sctp common 12 */
350 #define SCTP_FIRST_MBUF_RESV 68
351 /* Packet transmit states in the sent field */
352 #define SCTP_DATAGRAM_UNSENT            0
353 #define SCTP_DATAGRAM_SENT              1
354 #define SCTP_DATAGRAM_RESEND1           2       /* not used (in code, but may
355                                                  * hit this value) */
356 #define SCTP_DATAGRAM_RESEND2           3       /* not used (in code, but may
357                                                  * hit this value) */
358 #define SCTP_DATAGRAM_RESEND            4
359 #define SCTP_DATAGRAM_ACKED             10010
360 #define SCTP_DATAGRAM_MARKED            20010
361 #define SCTP_FORWARD_TSN_SKIP           30010
362
363 /* chunk output send from locations */
364 #define SCTP_OUTPUT_FROM_USR_SEND       0
365 #define SCTP_OUTPUT_FROM_T3             1
366 #define SCTP_OUTPUT_FROM_INPUT_ERROR    2
367 #define SCTP_OUTPUT_FROM_CONTROL_PROC   3
368 #define SCTP_OUTPUT_FROM_SACK_TMR       4
369 #define SCTP_OUTPUT_FROM_SHUT_TMR       5
370 #define SCTP_OUTPUT_FROM_HB_TMR         6
371 #define SCTP_OUTPUT_FROM_SHUT_ACK_TMR   7
372 #define SCTP_OUTPUT_FROM_ASCONF_TMR     8
373 #define SCTP_OUTPUT_FROM_STRRST_TMR     9
374 #define SCTP_OUTPUT_FROM_AUTOCLOSE_TMR  10
375 #define SCTP_OUTPUT_FROM_EARLY_FR_TMR   11
376 #define SCTP_OUTPUT_FROM_STRRST_REQ     12
377 #define SCTP_OUTPUT_FROM_USR_RCVD       13
378 #define SCTP_OUTPUT_FROM_COOKIE_ACK     14
379 #define SCTP_OUTPUT_FROM_DRAIN          15
380 #define SCTP_OUTPUT_FROM_CLOSING        16
381 /* SCTP chunk types are moved sctp.h for application (NAT, FW) use */
382
383 /* align to 32-bit sizes */
384 #define SCTP_SIZE32(x)  ((((x)+3) >> 2) << 2)
385
386 #define IS_SCTP_CONTROL(a) ((a)->chunk_type != SCTP_DATA)
387 #define IS_SCTP_DATA(a) ((a)->chunk_type == SCTP_DATA)
388
389
390 /* SCTP parameter types */
391 /*************0x0000 series*************/
392 #define SCTP_HEARTBEAT_INFO             0x0001
393 #define SCTP_IPV4_ADDRESS               0x0005
394 #define SCTP_IPV6_ADDRESS               0x0006
395 #define SCTP_STATE_COOKIE               0x0007
396 #define SCTP_UNRECOG_PARAM              0x0008
397 #define SCTP_COOKIE_PRESERVE            0x0009
398 #define SCTP_HOSTNAME_ADDRESS           0x000b
399 #define SCTP_SUPPORTED_ADDRTYPE         0x000c
400
401 /* draft-ietf-stewart-tsvwg-strreset-xxx */
402 #define SCTP_STR_RESET_OUT_REQUEST      0x000d
403 #define SCTP_STR_RESET_IN_REQUEST       0x000e
404 #define SCTP_STR_RESET_TSN_REQUEST      0x000f
405 #define SCTP_STR_RESET_RESPONSE         0x0010
406 #define SCTP_STR_RESET_ADD_STREAMS  0x0011
407
408 #define SCTP_MAX_RESET_PARAMS 2
409 #define SCTP_STREAM_RESET_TSN_DELTA    0x1000
410
411 /*************0x4000 series*************/
412
413 /*************0x8000 series*************/
414 #define SCTP_ECN_CAPABLE                0x8000
415 /* ECN Nonce: draft-ladha-sctp-ecn-nonce */
416 #define SCTP_ECN_NONCE_SUPPORTED        0x8001
417 /* draft-ietf-tsvwg-auth-xxx */
418 #define SCTP_RANDOM                     0x8002
419 #define SCTP_CHUNK_LIST                 0x8003
420 #define SCTP_HMAC_LIST                  0x8004
421 /*
422  * draft-ietf-tsvwg-addip-sctp-xx param=0x8008  len=0xNNNN Byte | Byte | Byte
423  * | Byte Byte | Byte ...
424  *
425  * Where each byte is a chunk type extension supported. For example, to support
426  * all chunks one would have (in hex):
427  *
428  * 80 01 00 09 C0 C1 80 81 82 00 00 00
429  *
430  * Has the parameter. C0 = PR-SCTP    (RFC3758) C1, 80 = ASCONF (addip draft) 81
431  * = Packet Drop 82 = Stream Reset 83 = Authentication
432  */
433 #define SCTP_SUPPORTED_CHUNK_EXT    0x8008
434
435 /*************0xC000 series*************/
436 #define SCTP_PRSCTP_SUPPORTED           0xc000
437 /* draft-ietf-tsvwg-addip-sctp */
438 #define SCTP_ADD_IP_ADDRESS             0xc001
439 #define SCTP_DEL_IP_ADDRESS             0xc002
440 #define SCTP_ERROR_CAUSE_IND            0xc003
441 #define SCTP_SET_PRIM_ADDR              0xc004
442 #define SCTP_SUCCESS_REPORT             0xc005
443 #define SCTP_ULP_ADAPTATION             0xc006
444 /* behave-nat-draft */
445 #define SCTP_HAS_NAT_SUPPORT            0xc007
446 #define SCTP_NAT_VTAGS                  0xc008
447
448 /* Notification error codes */
449 #define SCTP_NOTIFY_DATAGRAM_UNSENT     0x0001
450 #define SCTP_NOTIFY_DATAGRAM_SENT       0x0002
451 #define SCTP_FAILED_THRESHOLD           0x0004
452 #define SCTP_HEARTBEAT_SUCCESS          0x0008
453 #define SCTP_RESPONSE_TO_USER_REQ       0x0010
454 #define SCTP_INTERNAL_ERROR             0x0020
455 #define SCTP_SHUTDOWN_GUARD_EXPIRES     0x0040
456 #define SCTP_RECEIVED_SACK              0x0080
457 #define SCTP_PEER_FAULTY                0x0100
458 #define SCTP_ICMP_REFUSED               0x0200
459
460 /* bits for TOS field */
461 #define SCTP_ECT0_BIT           0x02
462 #define SCTP_ECT1_BIT           0x01
463 #define SCTP_CE_BITS            0x03
464
465 /* below turns off above */
466 #define SCTP_FLEXIBLE_ADDRESS   0x20
467 #define SCTP_NO_HEARTBEAT       0x40
468
469 /* mask to get sticky */
470 #define SCTP_STICKY_OPTIONS_MASK        0x0c
471
472
473 /*
474  * SCTP states for internal state machine XXX (should match "user" values)
475  */
476 #define SCTP_STATE_EMPTY                0x0000
477 #define SCTP_STATE_INUSE                0x0001
478 #define SCTP_STATE_COOKIE_WAIT          0x0002
479 #define SCTP_STATE_COOKIE_ECHOED        0x0004
480 #define SCTP_STATE_OPEN                 0x0008
481 #define SCTP_STATE_SHUTDOWN_SENT        0x0010
482 #define SCTP_STATE_SHUTDOWN_RECEIVED    0x0020
483 #define SCTP_STATE_SHUTDOWN_ACK_SENT    0x0040
484 #define SCTP_STATE_SHUTDOWN_PENDING     0x0080
485 #define SCTP_STATE_CLOSED_SOCKET        0x0100
486 #define SCTP_STATE_ABOUT_TO_BE_FREED    0x0200
487 #define SCTP_STATE_PARTIAL_MSG_LEFT     0x0400
488 #define SCTP_STATE_WAS_ABORTED          0x0800
489 #define SCTP_STATE_IN_ACCEPT_QUEUE      0x1000
490 #define SCTP_STATE_MASK                 0x007f
491
492 #define SCTP_GET_STATE(asoc)    ((asoc)->state & SCTP_STATE_MASK)
493 #define SCTP_SET_STATE(asoc, newstate)  ((asoc)->state = ((asoc)->state & ~SCTP_STATE_MASK) |  newstate)
494 #define SCTP_CLEAR_SUBSTATE(asoc, substate) ((asoc)->state &= ~substate)
495 #define SCTP_ADD_SUBSTATE(asoc, substate) ((asoc)->state |= substate)
496
497 /* SCTP reachability state for each address */
498 #define SCTP_ADDR_REACHABLE             0x001
499 #define SCTP_ADDR_NOT_REACHABLE         0x002
500 #define SCTP_ADDR_NOHB                  0x004
501 #define SCTP_ADDR_BEING_DELETED         0x008
502 #define SCTP_ADDR_NOT_IN_ASSOC          0x010
503 #define SCTP_ADDR_WAS_PRIMARY           0x020
504 #define SCTP_ADDR_SWITCH_PRIMARY        0x040
505 #define SCTP_ADDR_OUT_OF_SCOPE          0x080
506 #define SCTP_ADDR_DOUBLE_SWITCH         0x100
507 #define SCTP_ADDR_UNCONFIRMED           0x200
508 #define SCTP_ADDR_REQ_PRIMARY           0x400
509 /* JRS 5/13/07 - Added potentially failed state for CMT PF */
510 #define SCTP_ADDR_PF            0x800
511 #define SCTP_REACHABLE_MASK             0x203
512
513 /* bound address types (e.g. valid address types to allow) */
514 #define SCTP_BOUND_V6           0x01
515 #define SCTP_BOUND_V4           0x02
516
517 /*
518  * what is the default number of mbufs in a chain I allow before switching to
519  * a cluster
520  */
521 #define SCTP_DEFAULT_MBUFS_IN_CHAIN 5
522
523 /* How long a cookie lives in milli-seconds */
524 #define SCTP_DEFAULT_COOKIE_LIFE        60000
525
526 /* resource limit of streams */
527 #define MAX_SCTP_STREAMS        2048
528
529 /* Maximum the mapping array will  grow to (TSN mapping array) */
530 #define SCTP_MAPPING_ARRAY      512
531
532 /* size of the inital malloc on the mapping array */
533 #define SCTP_INITIAL_MAPPING_ARRAY  16
534 /* how much we grow the mapping array each call */
535 #define SCTP_MAPPING_ARRAY_INCR     32
536
537 /*
538  * Here we define the timer types used by the implementation as arguments in
539  * the set/get timer type calls.
540  */
541 #define SCTP_TIMER_INIT         0
542 #define SCTP_TIMER_RECV         1
543 #define SCTP_TIMER_SEND         2
544 #define SCTP_TIMER_HEARTBEAT    3
545 #define SCTP_TIMER_PMTU         4
546 #define SCTP_TIMER_MAXSHUTDOWN  5
547 #define SCTP_TIMER_SIGNATURE    6
548 /*
549  * number of timer types in the base SCTP structure used in the set/get and
550  * has the base default.
551  */
552 #define SCTP_NUM_TMRS   7
553
554 /* timer types */
555 #define SCTP_TIMER_TYPE_NONE            0
556 #define SCTP_TIMER_TYPE_SEND            1
557 #define SCTP_TIMER_TYPE_INIT            2
558 #define SCTP_TIMER_TYPE_RECV            3
559 #define SCTP_TIMER_TYPE_SHUTDOWN        4
560 #define SCTP_TIMER_TYPE_HEARTBEAT       5
561 #define SCTP_TIMER_TYPE_COOKIE          6
562 #define SCTP_TIMER_TYPE_NEWCOOKIE       7
563 #define SCTP_TIMER_TYPE_PATHMTURAISE    8
564 #define SCTP_TIMER_TYPE_SHUTDOWNACK     9
565 #define SCTP_TIMER_TYPE_ASCONF          10
566 #define SCTP_TIMER_TYPE_SHUTDOWNGUARD   11
567 #define SCTP_TIMER_TYPE_AUTOCLOSE       12
568 #define SCTP_TIMER_TYPE_EVENTWAKE       13
569 #define SCTP_TIMER_TYPE_STRRESET        14
570 #define SCTP_TIMER_TYPE_INPKILL         15
571 #define SCTP_TIMER_TYPE_EARLYFR         17
572 #define SCTP_TIMER_TYPE_ASOCKILL        18
573 #define SCTP_TIMER_TYPE_ADDR_WQ         19
574 #define SCTP_TIMER_TYPE_ZERO_COPY       20
575 #define SCTP_TIMER_TYPE_ZCOPY_SENDQ     21
576 #define SCTP_TIMER_TYPE_PRIM_DELETED    22
577 /* add new timers here - and increment LAST */
578 #define SCTP_TIMER_TYPE_LAST            23
579
580 #define SCTP_IS_TIMER_TYPE_VALID(t)     (((t) > SCTP_TIMER_TYPE_NONE) && \
581                                          ((t) < SCTP_TIMER_TYPE_LAST))
582
583
584
585 /* max number of TSN's dup'd that I will hold */
586 #define SCTP_MAX_DUP_TSNS       20
587
588 /*
589  * Here we define the types used when setting the retry amounts.
590  */
591 /* How many drop re-attempts we make on  INIT/COOKIE-ECHO */
592 #define SCTP_RETRY_DROPPED_THRESH 4
593
594 /*
595  * Maxmium number of chunks a single association can have on it. Note that
596  * this is a squishy number since the count can run over this if the user
597  * sends a large message down .. the fragmented chunks don't count until
598  * AFTER the message is on queue.. it would be the next send that blocks
599  * things. This number will get tuned up at boot in the sctp_init and use the
600  * number of clusters as a base. This way high bandwidth environments will
601  * not get impacted by the lower bandwidth sending a bunch of 1 byte chunks
602  */
603 #define SCTP_ASOC_MAX_CHUNKS_ON_QUEUE 512
604
605
606 /* The conversion from time to ticks and vice versa is done by rounding
607  * upwards. This way we can test in the code the time to be positive and
608  * know that this corresponds to a positive number of ticks.
609  */
610 #define MSEC_TO_TICKS(x) ((hz == 1000) ? x : ((((x) * hz) + 999) / 1000))
611 #define TICKS_TO_MSEC(x) ((hz == 1000) ? x : ((((x) * 1000) + (hz - 1)) / hz))
612
613 #define SEC_TO_TICKS(x) ((x) * hz)
614 #define TICKS_TO_SEC(x) (((x) + (hz - 1)) / hz)
615
616 /*
617  * Basically the minimum amount of time before I do a early FR. Making this
618  * value to low will cause duplicate retransmissions.
619  */
620 #define SCTP_MINFR_MSEC_TIMER 250
621 /* The floor this value is allowed to fall to when starting a timer. */
622 #define SCTP_MINFR_MSEC_FLOOR 20
623
624 /* init timer def = 1 sec */
625 #define SCTP_INIT_SEC   1
626
627 /* send timer def = 1 seconds */
628 #define SCTP_SEND_SEC   1
629
630 /* recv timer def = 200ms  */
631 #define SCTP_RECV_MSEC  200
632
633 /* 30 seconds + RTO (in ms) */
634 #define SCTP_HB_DEFAULT_MSEC    30000
635
636 /* Max time I will wait for Shutdown to complete */
637 #define SCTP_DEF_MAX_SHUTDOWN_SEC 180
638
639
640 /*
641  * This is how long a secret lives, NOT how long a cookie lives how many
642  * ticks the current secret will live.
643  */
644 #define SCTP_DEFAULT_SECRET_LIFE_SEC 3600
645
646 #define SCTP_RTO_UPPER_BOUND    (60000) /* 60 sec in ms */
647 #define SCTP_RTO_UPPER_BOUND_SEC 60     /* for the init timer */
648 #define SCTP_RTO_LOWER_BOUND    (1000)  /* 1 sec in ms */
649 #define SCTP_RTO_INITIAL        (3000)  /* 3 sec in ms */
650
651
652 #define SCTP_INP_KILL_TIMEOUT 20/* number of ms to retry kill of inpcb */
653 #define SCTP_ASOC_KILL_TIMEOUT 10       /* number of ms to retry kill of inpcb */
654
655 #define SCTP_DEF_MAX_INIT       8
656 #define SCTP_DEF_MAX_SEND       10
657 #define SCTP_DEF_MAX_PATH_RTX   5
658
659 #define SCTP_DEF_PMTU_RAISE_SEC 600     /* 10 min between raise attempts */
660
661
662 /* How many streams I request initally by default */
663 #define SCTP_OSTREAM_INITIAL 10
664
665 /*
666  * How many smallest_mtu's need to increase before a window update sack is
667  * sent (should be a power of 2).
668  */
669 /* Send window update (incr * this > hiwat). Should be a power of 2 */
670 #define SCTP_MINIMAL_RWND               (4096)  /* minimal rwnd */
671
672 #define SCTP_ADDRMAX            24
673
674 /* SCTP DEBUG Switch parameters */
675 #define SCTP_DEBUG_TIMER1       0x00000001
676 #define SCTP_DEBUG_TIMER2       0x00000002      /* unused */
677 #define SCTP_DEBUG_TIMER3       0x00000004      /* unused */
678 #define SCTP_DEBUG_TIMER4       0x00000008
679 #define SCTP_DEBUG_OUTPUT1      0x00000010
680 #define SCTP_DEBUG_OUTPUT2      0x00000020
681 #define SCTP_DEBUG_OUTPUT3      0x00000040
682 #define SCTP_DEBUG_OUTPUT4      0x00000080
683 #define SCTP_DEBUG_UTIL1        0x00000100
684 #define SCTP_DEBUG_UTIL2        0x00000200      /* unused */
685 #define SCTP_DEBUG_AUTH1        0x00000400
686 #define SCTP_DEBUG_AUTH2        0x00000800      /* unused */
687 #define SCTP_DEBUG_INPUT1       0x00001000
688 #define SCTP_DEBUG_INPUT2       0x00002000
689 #define SCTP_DEBUG_INPUT3       0x00004000
690 #define SCTP_DEBUG_INPUT4       0x00008000      /* unused */
691 #define SCTP_DEBUG_ASCONF1      0x00010000
692 #define SCTP_DEBUG_ASCONF2      0x00020000
693 #define SCTP_DEBUG_OUTPUT5      0x00040000      /* unused */
694 #define SCTP_DEBUG_XXX          0x00080000      /* unused */
695 #define SCTP_DEBUG_PCB1         0x00100000
696 #define SCTP_DEBUG_PCB2         0x00200000      /* unused */
697 #define SCTP_DEBUG_PCB3         0x00400000
698 #define SCTP_DEBUG_PCB4         0x00800000
699 #define SCTP_DEBUG_INDATA1      0x01000000
700 #define SCTP_DEBUG_INDATA2      0x02000000      /* unused */
701 #define SCTP_DEBUG_INDATA3      0x04000000      /* unused */
702 #define SCTP_DEBUG_CRCOFFLOAD   0x08000000      /* unused */
703 #define SCTP_DEBUG_USRREQ1      0x10000000      /* unused */
704 #define SCTP_DEBUG_USRREQ2      0x20000000      /* unused */
705 #define SCTP_DEBUG_PEEL1        0x40000000
706 #define SCTP_DEBUG_XXXXX        0x80000000      /* unused */
707 #define SCTP_DEBUG_ALL          0x7ff3ffff
708 #define SCTP_DEBUG_NOISY        0x00040000
709
710 /* What sender needs to see to avoid SWS or we consider peers rwnd 0 */
711 #define SCTP_SWS_SENDER_DEF     1420
712
713 /*
714  * SWS is scaled to the sb_hiwat of the socket. A value of 2 is hiwat/4, 1
715  * would be hiwat/2 etc.
716  */
717 /* What receiver needs to see in sockbuf or we tell peer its 1 */
718 #define SCTP_SWS_RECEIVER_DEF   3000
719
720 #define SCTP_INITIAL_CWND 4380
721
722 #define SCTP_DEFAULT_MTU 1500   /* emergency default MTU */
723 /* amount peer is obligated to have in rwnd or I will abort */
724 #define SCTP_MIN_RWND   1500
725
726 #define SCTP_DEFAULT_MAXSEGMENT 65535
727
728 #define SCTP_CHUNK_BUFFER_SIZE  512
729 #define SCTP_PARAM_BUFFER_SIZE  512
730
731 /* small chunk store for looking at chunk_list in auth */
732 #define SCTP_SMALL_CHUNK_STORE 260
733
734 #define SCTP_DEFAULT_MINSEGMENT 512     /* MTU size ... if no mtu disc */
735 #define SCTP_HOW_MANY_SECRETS   2       /* how many secrets I keep */
736
737 #define SCTP_NUMBER_OF_SECRETS  8       /* or 8 * 4 = 32 octets */
738 #define SCTP_SECRET_SIZE        32      /* number of octets in a 256 bits */
739
740
741 /*
742  * SCTP upper layer notifications
743  */
744 #define SCTP_NOTIFY_ASSOC_UP                     1
745 #define SCTP_NOTIFY_ASSOC_DOWN                   2
746 #define SCTP_NOTIFY_INTERFACE_DOWN               3
747 #define SCTP_NOTIFY_INTERFACE_UP                 4
748 #define SCTP_NOTIFY_DG_FAIL                      5
749 #define SCTP_NOTIFY_STRDATA_ERR                  6
750 #define SCTP_NOTIFY_ASSOC_ABORTED                7
751 #define SCTP_NOTIFY_PEER_OPENED_STREAM           8
752 #define SCTP_NOTIFY_STREAM_OPENED_OK             9
753 #define SCTP_NOTIFY_ASSOC_RESTART               10
754 #define SCTP_NOTIFY_HB_RESP                     11
755 #define SCTP_NOTIFY_ASCONF_SUCCESS              12
756 #define SCTP_NOTIFY_ASCONF_FAILED               13
757 #define SCTP_NOTIFY_PEER_SHUTDOWN               14
758 #define SCTP_NOTIFY_ASCONF_ADD_IP               15
759 #define SCTP_NOTIFY_ASCONF_DELETE_IP            16
760 #define SCTP_NOTIFY_ASCONF_SET_PRIMARY          17
761 #define SCTP_NOTIFY_PARTIAL_DELVIERY_INDICATION 18
762 #define SCTP_NOTIFY_INTERFACE_CONFIRMED         20
763 #define SCTP_NOTIFY_STR_RESET_RECV              21
764 #define SCTP_NOTIFY_STR_RESET_SEND              22
765 #define SCTP_NOTIFY_STR_RESET_FAILED_OUT        23
766 #define SCTP_NOTIFY_STR_RESET_FAILED_IN         24
767 #define SCTP_NOTIFY_AUTH_NEW_KEY                25
768 #define SCTP_NOTIFY_AUTH_FREE_KEY               26
769 #define SCTP_NOTIFY_SPECIAL_SP_FAIL             27
770 #define SCTP_NOTIFY_NO_PEER_AUTH                28
771 #define SCTP_NOTIFY_SENDER_DRY                  29
772 #define SCTP_NOTIFY_STR_RESET_ADD_OK            30
773 #define SCTP_NOTIFY_STR_RESET_ADD_FAIL          31
774 #define SCTP_NOTIFY_STR_RESET_INSTREAM_ADD_OK   32
775 #define SCTP_NOTIFY_MAX                         32
776
777
778 /* This is the value for messages that are NOT completely
779  * copied down where we will start to split the message.
780  * So, with our default, we split only if the piece we
781  * want to take will fill up a full MTU (assuming
782  * a 1500 byte MTU).
783  */
784 #define SCTP_DEFAULT_SPLIT_POINT_MIN 2904
785
786 /* ABORT CODES and other tell-tale location
787  * codes are generated by adding the below
788  * to the instance id.
789  */
790
791 /* File defines */
792 #define SCTP_FROM_SCTP_INPUT   0x10000000
793 #define SCTP_FROM_SCTP_PCB     0x20000000
794 #define SCTP_FROM_SCTP_INDATA  0x30000000
795 #define SCTP_FROM_SCTP_TIMER   0x40000000
796 #define SCTP_FROM_SCTP_USRREQ  0x50000000
797 #define SCTP_FROM_SCTPUTIL     0x60000000
798 #define SCTP_FROM_SCTP6_USRREQ 0x70000000
799 #define SCTP_FROM_SCTP_ASCONF  0x80000000
800 #define SCTP_FROM_SCTP_OUTPUT  0x90000000
801 #define SCTP_FROM_SCTP_PEELOFF 0xa0000000
802 #define SCTP_FROM_SCTP_PANDA   0xb0000000
803 #define SCTP_FROM_SCTP_SYSCTL  0xc0000000
804
805 /* Location ID's */
806 #define SCTP_LOC_1  0x00000001
807 #define SCTP_LOC_2  0x00000002
808 #define SCTP_LOC_3  0x00000003
809 #define SCTP_LOC_4  0x00000004
810 #define SCTP_LOC_5  0x00000005
811 #define SCTP_LOC_6  0x00000006
812 #define SCTP_LOC_7  0x00000007
813 #define SCTP_LOC_8  0x00000008
814 #define SCTP_LOC_9  0x00000009
815 #define SCTP_LOC_10 0x0000000a
816 #define SCTP_LOC_11 0x0000000b
817 #define SCTP_LOC_12 0x0000000c
818 #define SCTP_LOC_13 0x0000000d
819 #define SCTP_LOC_14 0x0000000e
820 #define SCTP_LOC_15 0x0000000f
821 #define SCTP_LOC_16 0x00000010
822 #define SCTP_LOC_17 0x00000011
823 #define SCTP_LOC_18 0x00000012
824 #define SCTP_LOC_19 0x00000013
825 #define SCTP_LOC_20 0x00000014
826 #define SCTP_LOC_21 0x00000015
827 #define SCTP_LOC_22 0x00000016
828 #define SCTP_LOC_23 0x00000017
829 #define SCTP_LOC_24 0x00000018
830 #define SCTP_LOC_25 0x00000019
831 #define SCTP_LOC_26 0x0000001a
832 #define SCTP_LOC_27 0x0000001b
833 #define SCTP_LOC_28 0x0000001c
834 #define SCTP_LOC_29 0x0000001d
835 #define SCTP_LOC_30 0x0000001e
836 #define SCTP_LOC_31 0x0000001f
837 #define SCTP_LOC_32 0x00000020
838 #define SCTP_LOC_33 0x00000021
839
840
841 /* Free assoc codes */
842 #define SCTP_NORMAL_PROC      0
843 #define SCTP_PCBFREE_NOFORCE  1
844 #define SCTP_PCBFREE_FORCE    2
845
846 /* From codes for adding addresses */
847 #define SCTP_ADDR_IS_CONFIRMED 8
848 #define SCTP_ADDR_DYNAMIC_ADDED 6
849 #define SCTP_IN_COOKIE_PROC 100
850 #define SCTP_ALLOC_ASOC  1
851 #define SCTP_LOAD_ADDR_2 2
852 #define SCTP_LOAD_ADDR_3 3
853 #define SCTP_LOAD_ADDR_4 4
854 #define SCTP_LOAD_ADDR_5 5
855
856 #define SCTP_DONOT_SETSCOPE 0
857 #define SCTP_DO_SETSCOPE 1
858
859
860 /* This value determines the default for when
861  * we try to add more on the send queue., if
862  * there is room. This prevents us from cycling
863  * into the copy_resume routine to often if
864  * we have not got enough space to add a decent
865  * enough size message. Note that if we have enough
866  * space to complete the message copy we will always
867  * add to the message, no matter what the size. Its
868  * only when we reach the point that we have some left
869  * to add, there is only room for part of it that we
870  * will use this threshold. Its also a sysctl.
871  */
872 #define SCTP_DEFAULT_ADD_MORE 1452
873
874 #ifndef SCTP_PCBHASHSIZE
875 /* default number of association hash buckets in each endpoint */
876 #define SCTP_PCBHASHSIZE 256
877 #endif
878 #ifndef SCTP_TCBHASHSIZE
879 #define SCTP_TCBHASHSIZE 1024
880 #endif
881
882 #ifndef SCTP_CHUNKQUEUE_SCALE
883 #define SCTP_CHUNKQUEUE_SCALE 10
884 #endif
885
886 /* clock variance is 1 ms */
887 #define SCTP_CLOCK_GRANULARITY  1
888 #define IP_HDR_SIZE 40          /* we use the size of a IP6 header here this
889                                  * detracts a small amount for ipv4 but it
890                                  * simplifies the ipv6 addition */
891
892 /* Argument magic number for sctp_inpcb_free() */
893
894 /* third argument */
895 #define SCTP_CALLED_DIRECTLY_NOCMPSET     0
896 #define SCTP_CALLED_AFTER_CMPSET_OFCLOSE  1
897 #define SCTP_CALLED_FROM_INPKILL_TIMER    2
898 /* second argument */
899 #define SCTP_FREE_SHOULD_USE_ABORT          1
900 #define SCTP_FREE_SHOULD_USE_GRACEFUL_CLOSE 0
901
902 #ifndef IPPROTO_SCTP
903 #define IPPROTO_SCTP 132        /* the Official IANA number :-) */
904 #endif                          /* !IPPROTO_SCTP */
905
906 #define SCTP_MAX_DATA_BUNDLING          256
907
908 /* modular comparison */
909 /* True if a > b (mod = M) */
910 #define compare_with_wrap(a, b, M) (((a > b) && ((a - b) < ((M >> 1) + 1))) || \
911               ((b > a) && ((b - a) > ((M >> 1) + 1))))
912
913
914 /* Mapping array manipulation routines */
915 #define SCTP_IS_TSN_PRESENT(arry, gap) ((arry[(gap >> 3)] >> (gap & 0x07)) & 0x01)
916 #define SCTP_SET_TSN_PRESENT(arry, gap) (arry[(gap >> 3)] |= (0x01 << ((gap & 0x07))))
917 #define SCTP_UNSET_TSN_PRESENT(arry, gap) (arry[(gap >> 3)] &= ((~(0x01 << ((gap & 0x07)))) & 0xff))
918 #define SCTP_CALC_TSN_TO_GAP(gap, tsn, mapping_tsn) do { \
919                         if (tsn >= mapping_tsn) { \
920                                                 gap = tsn - mapping_tsn; \
921                                         } else { \
922                                                 gap = (MAX_TSN - mapping_tsn) + tsn + 1; \
923                                         } \
924                   } while(0)
925
926
927 #define SCTP_RETRAN_DONE -1
928 #define SCTP_RETRAN_EXIT -2
929
930 /*
931  * This value defines the number of vtag block time wait entry's per list
932  * element.  Each entry will take 2 4 byte ints (and of course the overhead
933  * of the next pointer as well). Using 15 as an example will yield * ((8 *
934  * 15) + 8) or 128 bytes of overhead for each timewait block that gets
935  * initialized. Increasing it to 31 would yeild 256 bytes per block.
936  */
937 #define SCTP_NUMBER_IN_VTAG_BLOCK 15
938 /*
939  * If we use the STACK option, we have an array of this size head pointers.
940  * This array is mod'd the with the size to find which bucket and then all
941  * entries must be searched to see if the tag is in timed wait. If so we
942  * reject it.
943  */
944 #define SCTP_STACK_VTAG_HASH_SIZE   32
945
946 /*
947  * Number of seconds of time wait for a vtag.
948  */
949 #define SCTP_TIME_WAIT 60
950
951 /* The system retains a cache of free chunks such to
952  * cut down on calls the memory allocation system. There
953  * is a per association limit of free items and a overall
954  * system limit. If either one gets hit then the resource
955  * stops being cached.
956  */
957
958 #define SCTP_DEF_ASOC_RESC_LIMIT 10
959 #define SCTP_DEF_SYSTEM_RESC_LIMIT 1000
960
961 /*-
962  * defines for socket lock states.
963  * Used by __APPLE__ and SCTP_SO_LOCK_TESTING
964  */
965 #define SCTP_SO_LOCKED          1
966 #define SCTP_SO_NOT_LOCKED      0
967
968
969 #define SCTP_HOLDS_LOCK 1
970 #define SCTP_NOT_LOCKED 0
971
972 /*-
973  * For address locks, do we hold the lock?
974  */
975 #define SCTP_ADDR_LOCKED 1
976 #define SCTP_ADDR_NOT_LOCKED 0
977
978 #define IN4_ISPRIVATE_ADDRESS(a) \
979    ((((uint8_t *)&(a)->s_addr)[0] == 10) || \
980     ((((uint8_t *)&(a)->s_addr)[0] == 172) && \
981      (((uint8_t *)&(a)->s_addr)[1] >= 16) && \
982      (((uint8_t *)&(a)->s_addr)[1] <= 32)) || \
983     ((((uint8_t *)&(a)->s_addr)[0] == 192) && \
984      (((uint8_t *)&(a)->s_addr)[1] == 168)))
985
986 #define IN4_ISLOOPBACK_ADDRESS(a) \
987     ((((uint8_t *)&(a)->s_addr)[0] == 127) && \
988      (((uint8_t *)&(a)->s_addr)[1] == 0) && \
989      (((uint8_t *)&(a)->s_addr)[2] == 0) && \
990      (((uint8_t *)&(a)->s_addr)[3] == 1))
991
992
993 #if defined(_KERNEL)
994
995 #define SCTP_GETTIME_TIMEVAL(x) (getmicrouptime(x))
996 #define SCTP_GETPTIME_TIMEVAL(x)        (microuptime(x))
997 #endif
998 /*#if defined(__FreeBSD__) || defined(__APPLE__)*/
999 /*#define SCTP_GETTIME_TIMEVAL(x) { \*/
1000 /*      (x)->tv_sec = ticks / 1000; \*/
1001 /*      (x)->tv_usec = (ticks % 1000) * 1000; \*/
1002 /*}*/
1003
1004 /*#else*/
1005 /*#define SCTP_GETTIME_TIMEVAL(x)       (microtime(x))*/
1006 /*#endif                                 __FreeBSD__ */
1007
1008 #if defined(_KERNEL) || defined(__Userspace__)
1009 #define sctp_sowwakeup(inp, so) \
1010 do { \
1011         if (inp->sctp_flags & SCTP_PCB_FLAGS_DONT_WAKE) { \
1012                 inp->sctp_flags |= SCTP_PCB_FLAGS_WAKEOUTPUT; \
1013         } else { \
1014                 sowwakeup(so); \
1015         } \
1016 } while (0)
1017
1018 #define sctp_sowwakeup_locked(inp, so) \
1019 do { \
1020         if (inp->sctp_flags & SCTP_PCB_FLAGS_DONT_WAKE) { \
1021                 SOCKBUF_UNLOCK(&((so)->so_snd)); \
1022                 inp->sctp_flags |= SCTP_PCB_FLAGS_WAKEOUTPUT; \
1023         } else { \
1024                 sowwakeup_locked(so); \
1025         } \
1026 } while (0)
1027
1028 #define sctp_sorwakeup(inp, so) \
1029 do { \
1030         if (inp->sctp_flags & SCTP_PCB_FLAGS_DONT_WAKE) { \
1031                 inp->sctp_flags |= SCTP_PCB_FLAGS_WAKEINPUT; \
1032         } else { \
1033                 sorwakeup(so); \
1034         } \
1035 } while (0)
1036
1037 #define sctp_sorwakeup_locked(inp, so) \
1038 do { \
1039         if (inp->sctp_flags & SCTP_PCB_FLAGS_DONT_WAKE) { \
1040                 inp->sctp_flags |= SCTP_PCB_FLAGS_WAKEINPUT; \
1041                 SOCKBUF_UNLOCK(&((so)->so_rcv)); \
1042         } else { \
1043                 sorwakeup_locked(so); \
1044         } \
1045 } while (0)
1046
1047 #endif                          /* _KERNEL || __Userspace__ */
1048 #endif