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