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