xref: /freebsd/sys/netinet/sctp.h (revision cbb3ec25236ba72f91cbdf23f8b78b9d1af0cedf)
1 /*-
2  * SPDX-License-Identifier: BSD-3-Clause
3  *
4  * Copyright (c) 2001-2008, by Cisco Systems, Inc. All rights reserved.
5  * Copyright (c) 2008-2012, by Randall Stewart. All rights reserved.
6  * Copyright (c) 2008-2012, by Michael Tuexen. All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions are met:
10  *
11  * a) Redistributions of source code must retain the above copyright notice,
12  *    this list of conditions and the following disclaimer.
13  *
14  * b) Redistributions in binary form must reproduce the above copyright
15  *    notice, this list of conditions and the following disclaimer in
16  *    the documentation and/or other materials provided with the distribution.
17  *
18  * c) Neither the name of Cisco Systems, Inc. nor the names of its
19  *    contributors may be used to endorse or promote products derived
20  *    from this software without specific prior written permission.
21  *
22  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
23  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
24  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
26  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
27  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
28  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
29  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
30  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
31  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
32  * THE POSSIBILITY OF SUCH DAMAGE.
33  */
34 
35 #ifndef _NETINET_SCTP_H_
36 #define _NETINET_SCTP_H_
37 
38 #include <sys/cdefs.h>
39 #include <sys/types.h>
40 
41 #define SCTP_PACKED __attribute__((packed))
42 
43 /*
44  * SCTP protocol - RFC4960.
45  */
46 struct sctphdr {
47 	uint16_t src_port;	/* source port */
48 	uint16_t dest_port;	/* destination port */
49 	uint32_t v_tag;		/* verification tag of packet */
50 	uint32_t checksum;	/* CRC32C checksum */
51 	/* chunks follow... */
52 }       SCTP_PACKED;
53 
54 /*
55  * SCTP Chunks
56  */
57 struct sctp_chunkhdr {
58 	uint8_t chunk_type;	/* chunk type */
59 	uint8_t chunk_flags;	/* chunk flags */
60 	uint16_t chunk_length;	/* chunk length */
61 	/* optional params follow */
62 }             SCTP_PACKED;
63 
64 /*
65  * SCTP chunk parameters
66  */
67 struct sctp_paramhdr {
68 	uint16_t param_type;	/* parameter type */
69 	uint16_t param_length;	/* parameter length */
70 }             SCTP_PACKED;
71 
72 /*
73  * user socket options: socket API defined
74  */
75 /*
76  * read-write options
77  */
78 #define SCTP_RTOINFO			0x00000001
79 #define SCTP_ASSOCINFO			0x00000002
80 #define SCTP_INITMSG			0x00000003
81 #define SCTP_NODELAY			0x00000004
82 #define SCTP_AUTOCLOSE			0x00000005
83 #define SCTP_SET_PEER_PRIMARY_ADDR	0x00000006
84 #define SCTP_PRIMARY_ADDR		0x00000007
85 #define SCTP_ADAPTATION_LAYER		0x00000008
86 /* same as above */
87 #define SCTP_ADAPTION_LAYER		0x00000008
88 #define SCTP_DISABLE_FRAGMENTS		0x00000009
89 #define SCTP_PEER_ADDR_PARAMS 		0x0000000a
90 #define SCTP_DEFAULT_SEND_PARAM		0x0000000b
91 /* ancillary data/notification interest options */
92 #define SCTP_EVENTS			0x0000000c	/* deprecated */
93 /* Without this applied we will give V4 and V6 addresses on a V6 socket */
94 #define SCTP_I_WANT_MAPPED_V4_ADDR	0x0000000d
95 #define SCTP_MAXSEG 			0x0000000e
96 #define SCTP_DELAYED_SACK               0x0000000f
97 #define SCTP_FRAGMENT_INTERLEAVE        0x00000010
98 #define SCTP_PARTIAL_DELIVERY_POINT     0x00000011
99 /* authentication support */
100 #define SCTP_AUTH_CHUNK 		0x00000012
101 #define SCTP_AUTH_KEY 			0x00000013
102 #define SCTP_HMAC_IDENT 		0x00000014
103 #define SCTP_AUTH_ACTIVE_KEY 		0x00000015
104 #define SCTP_AUTH_DELETE_KEY 		0x00000016
105 #define SCTP_USE_EXT_RCVINFO		0x00000017
106 #define SCTP_AUTO_ASCONF		0x00000018	/* rw */
107 #define SCTP_MAXBURST			0x00000019	/* rw */
108 #define SCTP_MAX_BURST			0x00000019	/* rw */
109 /* assoc level context */
110 #define SCTP_CONTEXT                    0x0000001a	/* rw */
111 /* explicit EOR signalling */
112 #define SCTP_EXPLICIT_EOR               0x0000001b
113 #define SCTP_REUSE_PORT                 0x0000001c	/* rw */
114 #define SCTP_AUTH_DEACTIVATE_KEY	0x0000001d
115 #define SCTP_EVENT                      0x0000001e
116 #define SCTP_RECVRCVINFO                0x0000001f
117 #define SCTP_RECVNXTINFO                0x00000020
118 #define SCTP_DEFAULT_SNDINFO            0x00000021
119 #define SCTP_DEFAULT_PRINFO             0x00000022
120 #define SCTP_PEER_ADDR_THLDS            0x00000023
121 #define SCTP_REMOTE_UDP_ENCAPS_PORT     0x00000024
122 #define SCTP_ECN_SUPPORTED              0x00000025
123 #define SCTP_PR_SUPPORTED               0x00000026
124 #define SCTP_AUTH_SUPPORTED             0x00000027
125 #define SCTP_ASCONF_SUPPORTED           0x00000028
126 #define SCTP_RECONFIG_SUPPORTED         0x00000029
127 #define SCTP_NRSACK_SUPPORTED           0x00000030
128 #define SCTP_PKTDROP_SUPPORTED          0x00000031
129 #define SCTP_MAX_CWND                   0x00000032
130 #define SCTP_ACCEPT_ZERO_CHECKSUM       0x00000033
131 
132 /*
133  * read-only options
134  */
135 #define SCTP_STATUS			0x00000100
136 #define SCTP_GET_PEER_ADDR_INFO		0x00000101
137 /* authentication support */
138 #define SCTP_PEER_AUTH_CHUNKS 		0x00000102
139 #define SCTP_LOCAL_AUTH_CHUNKS 		0x00000103
140 #define SCTP_GET_ASSOC_NUMBER           0x00000104	/* ro */
141 #define SCTP_GET_ASSOC_ID_LIST          0x00000105	/* ro */
142 #define SCTP_TIMEOUTS                   0x00000106
143 #define SCTP_PR_STREAM_STATUS           0x00000107
144 #define SCTP_PR_ASSOC_STATUS            0x00000108
145 
146 /*
147  * user socket options: BSD implementation specific
148  */
149 /*
150  * Blocking I/O is enabled on any TCP type socket by default. For the UDP
151  * model if this is turned on then the socket buffer is shared for send
152  * resources amongst all associations.  The default for the UDP model is that
153  * is SS_NBIO is set.  Which means all associations have a separate send
154  * limit BUT they will NOT ever BLOCK instead you will get an error back
155  * EAGAIN if you try to send too much. If you want the blocking semantics you
156  * set this option at the cost of sharing one socket send buffer size amongst
157  * all associations. Peeled off sockets turn this option off and block. But
158  * since both TCP and peeled off sockets have only one assoc per socket this
159  * is fine. It probably does NOT make sense to set this on SS_NBIO on a TCP
160  * model OR peeled off UDP model, but we do allow you to do so. You just use
161  * the normal syscall to toggle SS_NBIO the way you want.
162  *
163  * Blocking I/O is controlled by the SS_NBIO flag on the socket state so_state
164  * field.
165  */
166 
167 #define SCTP_ENABLE_STREAM_RESET	0x00000900	/* struct
168 							 * sctp_assoc_value */
169 #define SCTP_RESET_STREAMS		0x00000901	/* struct
170 							 * sctp_reset_streams */
171 #define SCTP_RESET_ASSOC		0x00000902	/* sctp_assoc_t */
172 #define SCTP_ADD_STREAMS		0x00000903	/* struct
173 							 * sctp_add_streams */
174 
175 /* For enable stream reset */
176 #define SCTP_ENABLE_RESET_STREAM_REQ 	0x00000001
177 #define SCTP_ENABLE_RESET_ASSOC_REQ 	0x00000002
178 #define SCTP_ENABLE_CHANGE_ASSOC_REQ 	0x00000004
179 #define SCTP_ENABLE_VALUE_MASK		0x00000007
180 /* For reset streams */
181 #define SCTP_STREAM_RESET_INCOMING	0x00000001
182 #define SCTP_STREAM_RESET_OUTGOING	0x00000002
183 
184 /* here on down are more implementation specific */
185 #define SCTP_SET_DEBUG_LEVEL		0x00001005
186 #define SCTP_CLR_STAT_LOG               0x00001007
187 /* CMT ON/OFF socket option */
188 #define SCTP_CMT_ON_OFF                 0x00001200
189 #define SCTP_CMT_USE_DAC                0x00001201
190 /* JRS - Pluggable Congestion Control Socket option */
191 #define SCTP_PLUGGABLE_CC               0x00001202
192 /* RS - Pluggable Stream Scheduling Socket option */
193 #define SCTP_STREAM_SCHEDULER		0x00001203
194 #define SCTP_STREAM_SCHEDULER_VALUE	0x00001204
195 /* The next two are for backwards compatibility. */
196 #define SCTP_PLUGGABLE_SS		SCTP_STREAM_SCHEDULER
197 #define SCTP_SS_VALUE			SCTP_STREAM_SCHEDULER_VALUE
198 #define SCTP_CC_OPTION			0x00001205	/* Options for CC
199 							 * modules */
200 /* For I-DATA */
201 #define SCTP_INTERLEAVING_SUPPORTED	0x00001206
202 
203 /* read only */
204 #define SCTP_GET_SNDBUF_USE		0x00001101
205 #define SCTP_GET_STAT_LOG		0x00001103
206 #define SCTP_PCB_STATUS			0x00001104
207 #define SCTP_GET_NONCE_VALUES           0x00001105
208 
209 /* Special hook for dynamically setting primary for all assoc's,
210  * this is a write only option that requires root privilege.
211  */
212 #define SCTP_SET_DYNAMIC_PRIMARY        0x00002001
213 
214 /* VRF (virtual router feature) and multi-VRF support
215  * options. VRF's provide splits within a router
216  * that give the views of multiple routers. A
217  * standard host, without VRF support, is just
218  * a single VRF. If VRF's are supported then
219  * the transport must be VRF aware. This means
220  * that every socket call coming in must be directed
221  * within the endpoint to one of the VRF's it belongs
222  * to. The endpoint, before binding, may select
223  * the "default" VRF it is in by using a set socket
224  * option with SCTP_VRF_ID. This will also
225  * get propagated to the default VRF. Once the
226  * endpoint binds an address then it CANNOT add
227  * additional VRF's to become a Multi-VRF endpoint.
228  *
229  * Before BINDING additional VRF's can be added with
230  * the SCTP_ADD_VRF_ID call or deleted with
231  * SCTP_DEL_VRF_ID.
232  *
233  * Associations are ALWAYS contained inside a single
234  * VRF. They cannot reside in two (or more) VRF's. Incoming
235  * packets, assuming the router is VRF aware, can always
236  * tell us what VRF they arrived on. A host not supporting
237  * any VRF's will find that the packets always arrived on the
238  * single VRF that the host has.
239  *
240  */
241 
242 #define SCTP_VRF_ID			0x00003001
243 #define SCTP_ADD_VRF_ID			0x00003002
244 #define SCTP_GET_VRF_IDS		0x00003003
245 #define SCTP_GET_ASOC_VRF               0x00003004
246 #define SCTP_DEL_VRF_ID                 0x00003005
247 
248 /*
249  * If you enable packet logging you can get
250  * a poor mans ethereal output in binary
251  * form. Note this is a compile option to
252  * the kernel,  SCTP_PACKET_LOGGING, and
253  * without it in your kernel you
254  * will get a EOPNOTSUPP
255  */
256 #define SCTP_GET_PACKET_LOG             0x00004001
257 
258 /*
259  * hidden implementation specific options these are NOT user visible (should
260  * move out of sctp.h)
261  */
262 /* sctp_bindx() flags as hidden socket options */
263 #define SCTP_BINDX_ADD_ADDR		0x00008001
264 #define SCTP_BINDX_REM_ADDR		0x00008002
265 /* Hidden socket option that gets the addresses */
266 #define SCTP_GET_PEER_ADDRESSES		0x00008003
267 #define SCTP_GET_LOCAL_ADDRESSES	0x00008004
268 /* return the total count in bytes needed to hold all local addresses bound */
269 #define SCTP_GET_LOCAL_ADDR_SIZE	0x00008005
270 /* Return the total count in bytes needed to hold the remote address */
271 #define SCTP_GET_REMOTE_ADDR_SIZE	0x00008006
272 /* hidden option for connectx */
273 #define SCTP_CONNECT_X			0x00008007
274 /* hidden option for connectx_delayed, part of sendx */
275 #define SCTP_CONNECT_X_DELAYED		0x00008008
276 #define SCTP_CONNECT_X_COMPLETE         0x00008009
277 /* hidden socket option based sctp_peeloff */
278 #define SCTP_PEELOFF                    0x0000800a
279 /* the real worker for sctp_getaddrlen() */
280 #define SCTP_GET_ADDR_LEN               0x0000800b
281 /* Debug things that need to be purged */
282 #define SCTP_SET_INITIAL_DBG_SEQ	0x00009f00
283 
284 /* JRS - Supported congestion control modules for pluggable
285  * congestion control
286  */
287 /* Standard TCP Congestion Control */
288 #define SCTP_CC_RFC2581		0x00000000
289 /* High Speed TCP Congestion Control (Floyd) */
290 #define SCTP_CC_HSTCP		0x00000001
291 /* HTCP Congestion Control */
292 #define SCTP_CC_HTCP		0x00000002
293 /* RTCC Congestion Control - RFC2581 plus */
294 #define SCTP_CC_RTCC            0x00000003
295 
296 #define SCTP_CC_OPT_RTCC_SETMODE	0x00002000
297 #define SCTP_CC_OPT_USE_DCCC_ECN	0x00002001
298 #define SCTP_CC_OPT_STEADY_STEP         0x00002002
299 
300 #define SCTP_CMT_OFF            0
301 #define SCTP_CMT_BASE           1
302 #define SCTP_CMT_RPV1           2
303 #define SCTP_CMT_RPV2           3
304 #define SCTP_CMT_MPTCP          4
305 #define SCTP_CMT_MAX            SCTP_CMT_MPTCP
306 
307 /* RS - Supported stream scheduling modules for pluggable
308  * stream scheduling
309  */
310 /* Default simple round-robin */
311 #define SCTP_SS_DEFAULT			0x00000000
312 /* Real round-robin */
313 #define SCTP_SS_RR			0x00000001
314 /* Real round-robin per packet */
315 #define SCTP_SS_RR_PKT			0x00000002
316 /* Priority */
317 #define SCTP_SS_PRIO			0x00000003
318 /* Fair Bandwidth */
319 #define SCTP_SS_FB			0x00000004
320 /* First-come, first-serve */
321 #define SCTP_SS_FCFS			0x00000005
322 /* The next five are for backwards compatibility. */
323 #define SCTP_SS_ROUND_ROBIN		SCTP_SS_RR
324 #define SCTP_SS_ROUND_ROBIN_PACKET	SCTP_SS_RR_PKT
325 #define SCTP_SS_PRIORITY		SCTP_SS_PRIO
326 #define SCTP_SS_FAIR_BANDWITH		SCTP_SS_FB
327 #define SCTP_SS_FIRST_COME		SCTP_SS_FCFS
328 
329 /* fragment interleave constants
330  * setting must be one of these or
331  * EINVAL returned.
332  */
333 #define SCTP_FRAG_LEVEL_0    0x00000000
334 #define SCTP_FRAG_LEVEL_1    0x00000001
335 #define SCTP_FRAG_LEVEL_2    0x00000002
336 
337 /*
338  * user state values
339  */
340 #define SCTP_CLOSED			0x0000
341 #define SCTP_BOUND			0x1000
342 #define SCTP_LISTEN			0x2000
343 #define SCTP_COOKIE_WAIT		0x0002
344 #define SCTP_COOKIE_ECHOED		0x0004
345 #define SCTP_ESTABLISHED		0x0008
346 #define SCTP_SHUTDOWN_SENT		0x0010
347 #define SCTP_SHUTDOWN_RECEIVED		0x0020
348 #define SCTP_SHUTDOWN_ACK_SENT		0x0040
349 #define SCTP_SHUTDOWN_PENDING		0x0080
350 
351 /*
352  * SCTP operational error codes (user visible)
353  */
354 #define SCTP_CAUSE_NO_ERROR		0x0000
355 #define SCTP_CAUSE_INVALID_STREAM	0x0001
356 #define SCTP_CAUSE_MISSING_PARAM	0x0002
357 #define SCTP_CAUSE_STALE_COOKIE		0x0003
358 #define SCTP_CAUSE_OUT_OF_RESC		0x0004
359 #define SCTP_CAUSE_UNRESOLVABLE_ADDR	0x0005
360 #define SCTP_CAUSE_UNRECOG_CHUNK	0x0006
361 #define SCTP_CAUSE_INVALID_PARAM	0x0007
362 #define SCTP_CAUSE_UNRECOG_PARAM	0x0008
363 #define SCTP_CAUSE_NO_USER_DATA		0x0009
364 #define SCTP_CAUSE_COOKIE_IN_SHUTDOWN	0x000a
365 #define SCTP_CAUSE_RESTART_W_NEWADDR	0x000b
366 #define SCTP_CAUSE_USER_INITIATED_ABT	0x000c
367 #define SCTP_CAUSE_PROTOCOL_VIOLATION	0x000d
368 
369 /* Error causes from RFC5061 */
370 #define SCTP_CAUSE_DELETING_LAST_ADDR	0x00a0
371 #define SCTP_CAUSE_RESOURCE_SHORTAGE	0x00a1
372 #define SCTP_CAUSE_DELETING_SRC_ADDR	0x00a2
373 #define SCTP_CAUSE_ILLEGAL_ASCONF_ACK	0x00a3
374 #define SCTP_CAUSE_REQUEST_REFUSED	0x00a4
375 
376 /* Error causes from nat-draft */
377 #define SCTP_CAUSE_NAT_COLLIDING_STATE  0x00b0
378 #define SCTP_CAUSE_NAT_MISSING_STATE    0x00b1
379 
380 /* Error causes from RFC4895 */
381 #define SCTP_CAUSE_UNSUPPORTED_HMACID	0x0105
382 
383 /*
384  * error cause parameters (user visible)
385  */
386 struct sctp_gen_error_cause {
387 	uint16_t code;
388 	uint16_t length;
389 	uint8_t info[];
390 }                    SCTP_PACKED;
391 
392 struct sctp_error_cause {
393 	uint16_t code;
394 	uint16_t length;
395 	/* optional cause-specific info may follow */
396 }                SCTP_PACKED;
397 
398 struct sctp_error_invalid_stream {
399 	struct sctp_error_cause cause;	/* code=SCTP_CAUSE_INVALID_STREAM */
400 	uint16_t stream_id;	/* stream id of the DATA in error */
401 	uint16_t reserved;
402 }                         SCTP_PACKED;
403 
404 struct sctp_error_missing_param {
405 	struct sctp_error_cause cause;	/* code=SCTP_CAUSE_MISSING_PARAM */
406 	uint32_t num_missing_params;	/* number of missing parameters */
407 	uint16_t type[];
408 }                        SCTP_PACKED;
409 
410 struct sctp_error_stale_cookie {
411 	struct sctp_error_cause cause;	/* code=SCTP_CAUSE_STALE_COOKIE */
412 	uint32_t stale_time;	/* time in usec of staleness */
413 }                       SCTP_PACKED;
414 
415 struct sctp_error_out_of_resource {
416 	struct sctp_error_cause cause;	/* code=SCTP_CAUSE_OUT_OF_RESOURCES */
417 }                          SCTP_PACKED;
418 
419 struct sctp_error_unresolv_addr {
420 	struct sctp_error_cause cause;	/* code=SCTP_CAUSE_UNRESOLVABLE_ADDR */
421 }                        SCTP_PACKED;
422 
423 struct sctp_error_unrecognized_chunk {
424 	struct sctp_error_cause cause;	/* code=SCTP_CAUSE_UNRECOG_CHUNK */
425 	struct sctp_chunkhdr ch;	/* header from chunk in error */
426 }                             SCTP_PACKED;
427 
428 struct sctp_error_no_user_data {
429 	struct sctp_error_cause cause;	/* code=SCTP_CAUSE_NO_USER_DATA */
430 	uint32_t tsn;		/* TSN of the empty data chunk */
431 }                       SCTP_PACKED;
432 
433 struct sctp_error_auth_invalid_hmac {
434 	struct sctp_error_cause cause;	/* code=SCTP_CAUSE_UNSUPPORTED_HMACID */
435 	uint16_t hmac_id;
436 }                            SCTP_PACKED;
437 
438 /*
439  * Main SCTP chunk types we place these here so natd and f/w's in user land
440  * can find them.
441  */
442 /************0x00 series ***********/
443 #define SCTP_DATA		0x00
444 #define SCTP_INITIATION		0x01
445 #define SCTP_INITIATION_ACK	0x02
446 #define SCTP_SELECTIVE_ACK	0x03
447 #define SCTP_HEARTBEAT_REQUEST	0x04
448 #define SCTP_HEARTBEAT_ACK	0x05
449 #define SCTP_ABORT_ASSOCIATION	0x06
450 #define SCTP_SHUTDOWN		0x07
451 #define SCTP_SHUTDOWN_ACK	0x08
452 #define SCTP_OPERATION_ERROR	0x09
453 #define SCTP_COOKIE_ECHO	0x0a
454 #define SCTP_COOKIE_ACK		0x0b
455 #define SCTP_ECN_ECHO		0x0c
456 #define SCTP_ECN_CWR		0x0d
457 #define SCTP_SHUTDOWN_COMPLETE	0x0e
458 /* RFC4895 */
459 #define SCTP_AUTHENTICATION     0x0f
460 /* EY nr_sack chunk id*/
461 #define SCTP_NR_SELECTIVE_ACK	0x10
462 /************0x40 series ***********/
463 #define SCTP_IDATA		0x40
464 /************0x80 series ***********/
465 /* RFC5061 */
466 #define	SCTP_ASCONF_ACK		0x80
467 /* draft-ietf-stewart-pktdrpsctp */
468 #define SCTP_PACKET_DROPPED	0x81
469 /* draft-ietf-stewart-strreset-xxx */
470 #define SCTP_STREAM_RESET       0x82
471 
472 /* RFC4820                         */
473 #define SCTP_PAD_CHUNK          0x84
474 /************0xc0 series ***********/
475 /* RFC3758 */
476 #define SCTP_FORWARD_CUM_TSN	0xc0
477 /* RFC5061 */
478 #define SCTP_ASCONF		0xc1
479 #define SCTP_IFORWARD_CUM_TSN	0xc2
480 
481 /* ABORT and SHUTDOWN COMPLETE FLAG */
482 #define SCTP_HAD_NO_TCB		0x01
483 
484 /* Packet dropped flags */
485 #define SCTP_FROM_MIDDLE_BOX	SCTP_HAD_NO_TCB
486 #define SCTP_BADCRC		0x02
487 #define SCTP_PACKET_TRUNCATED	0x04
488 
489 /* Flag for ECN -CWR */
490 #define SCTP_CWR_REDUCE_OVERRIDE 0x01
491 #define SCTP_CWR_IN_SAME_WINDOW  0x02
492 
493 #define SCTP_SAT_NETWORK_MIN	400	/* min ms for RTT to set satellite
494 					 * time */
495 #define SCTP_SAT_NETWORK_BURST_INCR  2	/* how many times to multiply maxburst
496 					 * in sat */
497 
498 /* Data Chuck Specific Flags */
499 #define SCTP_DATA_FRAG_MASK        0x03
500 #define SCTP_DATA_MIDDLE_FRAG      0x00
501 #define SCTP_DATA_LAST_FRAG        0x01
502 #define SCTP_DATA_FIRST_FRAG       0x02
503 #define SCTP_DATA_NOT_FRAG         0x03
504 #define SCTP_DATA_UNORDERED        0x04
505 #define SCTP_DATA_SACK_IMMEDIATELY 0x08
506 /* ECN Nonce: SACK Chunk Specific Flags */
507 #define SCTP_SACK_NONCE_SUM        0x01
508 
509 /* CMT DAC algorithm SACK flag */
510 #define SCTP_SACK_CMT_DAC          0x80
511 
512 /*
513  * PCB flags (in sctp_flags bitmask).
514  * Note the features and flags are meant
515  * for use by netstat.
516  */
517 #define SCTP_PCB_FLAGS_UDPTYPE		0x00000001
518 #define SCTP_PCB_FLAGS_TCPTYPE		0x00000002
519 #define SCTP_PCB_FLAGS_BOUNDALL		0x00000004
520 #define SCTP_PCB_FLAGS_ACCEPTING	0x00000008
521 #define SCTP_PCB_FLAGS_UNBOUND		0x00000010
522 #define SCTP_PCB_FLAGS_SND_ITERATOR_UP  0x00000020
523 #define SCTP_PCB_FLAGS_CLOSE_IP         0x00040000
524 #define SCTP_PCB_FLAGS_WAS_CONNECTED    0x00080000
525 #define SCTP_PCB_FLAGS_WAS_ABORTED      0x00100000
526 /* TCP model support */
527 
528 #define SCTP_PCB_FLAGS_CONNECTED	0x00200000
529 #define SCTP_PCB_FLAGS_IN_TCPPOOL	0x00400000
530 #define SCTP_PCB_FLAGS_DONT_WAKE	0x00800000
531 #define SCTP_PCB_FLAGS_WAKEOUTPUT	0x01000000
532 #define SCTP_PCB_FLAGS_WAKEINPUT	0x02000000
533 #define SCTP_PCB_FLAGS_BOUND_V6		0x04000000
534 #define SCTP_PCB_FLAGS_BLOCKING_IO	0x08000000
535 #define SCTP_PCB_FLAGS_SOCKET_GONE	0x10000000
536 #define SCTP_PCB_FLAGS_SOCKET_ALLGONE	0x20000000
537 #define SCTP_PCB_FLAGS_SOCKET_CANT_READ	0x40000000
538 
539 /* flags to copy to new PCB */
540 #define SCTP_PCB_COPY_FLAGS		(SCTP_PCB_FLAGS_BOUNDALL|\
541 					 SCTP_PCB_FLAGS_WAKEINPUT|\
542 					 SCTP_PCB_FLAGS_BOUND_V6)
543 
544 /*
545  * PCB Features (in sctp_features bitmask)
546  */
547 #define SCTP_PCB_FLAGS_DO_NOT_PMTUD      0x0000000000000001
548 #define SCTP_PCB_FLAGS_EXT_RCVINFO       0x0000000000000002	/* deprecated */
549 #define SCTP_PCB_FLAGS_DONOT_HEARTBEAT   0x0000000000000004
550 #define SCTP_PCB_FLAGS_FRAG_INTERLEAVE   0x0000000000000008
551 #define SCTP_PCB_FLAGS_INTERLEAVE_STRMS  0x0000000000000010
552 #define SCTP_PCB_FLAGS_DO_ASCONF         0x0000000000000020
553 #define SCTP_PCB_FLAGS_AUTO_ASCONF       0x0000000000000040
554 /* socket options */
555 #define SCTP_PCB_FLAGS_NODELAY           0x0000000000000100
556 #define SCTP_PCB_FLAGS_AUTOCLOSE         0x0000000000000200
557 #define SCTP_PCB_FLAGS_RECVDATAIOEVNT    0x0000000000000400	/* deprecated */
558 #define SCTP_PCB_FLAGS_RECVASSOCEVNT     0x0000000000000800
559 #define SCTP_PCB_FLAGS_RECVPADDREVNT     0x0000000000001000
560 #define SCTP_PCB_FLAGS_RECVPEERERR       0x0000000000002000
561 #define SCTP_PCB_FLAGS_RECVSENDFAILEVNT  0x0000000000004000	/* deprecated */
562 #define SCTP_PCB_FLAGS_RECVSHUTDOWNEVNT  0x0000000000008000
563 #define SCTP_PCB_FLAGS_ADAPTATIONEVNT    0x0000000000010000
564 #define SCTP_PCB_FLAGS_PDAPIEVNT         0x0000000000020000
565 #define SCTP_PCB_FLAGS_AUTHEVNT          0x0000000000040000
566 #define SCTP_PCB_FLAGS_STREAM_RESETEVNT  0x0000000000080000
567 #define SCTP_PCB_FLAGS_NO_FRAGMENT       0x0000000000100000
568 #define SCTP_PCB_FLAGS_EXPLICIT_EOR      0x0000000000400000
569 #define SCTP_PCB_FLAGS_NEEDS_MAPPED_V4   0x0000000000800000
570 #define SCTP_PCB_FLAGS_MULTIPLE_ASCONFS  0x0000000001000000
571 #define SCTP_PCB_FLAGS_PORTREUSE         0x0000000002000000
572 #define SCTP_PCB_FLAGS_DRYEVNT           0x0000000004000000
573 #define SCTP_PCB_FLAGS_RECVRCVINFO       0x0000000008000000
574 #define SCTP_PCB_FLAGS_RECVNXTINFO       0x0000000010000000
575 #define SCTP_PCB_FLAGS_ASSOC_RESETEVNT   0x0000000020000000
576 #define SCTP_PCB_FLAGS_STREAM_CHANGEEVNT 0x0000000040000000
577 #define SCTP_PCB_FLAGS_RECVNSENDFAILEVNT 0x0000000080000000
578 
579 /*-
580  * mobility_features parameters (by micchie).Note
581  * these features are applied against the
582  * sctp_mobility_features flags.. not the sctp_features
583  * flags.
584  */
585 #define SCTP_MOBILITY_BASE               0x00000001
586 #define SCTP_MOBILITY_FASTHANDOFF        0x00000002
587 #define SCTP_MOBILITY_PRIM_DELETED       0x00000004
588 
589 /* Smallest PMTU allowed when disabling PMTU discovery */
590 #define SCTP_SMALLEST_PMTU 512
591 /* Largest PMTU allowed when disabling PMTU discovery */
592 #define SCTP_LARGEST_PMTU  65536
593 
594 #undef SCTP_PACKED
595 
596 #include <netinet/sctp_uio.h>
597 
598 /* This dictates the size of the packet
599  * collection buffer. This only applies
600  * if SCTP_PACKET_LOGGING is enabled in
601  * your config.
602  */
603 #define SCTP_PACKET_LOG_SIZE 65536
604 
605 /* Maximum delays and such a user can set for options that
606  * take ms.
607  */
608 #define SCTP_MAX_SACK_DELAY 500	/* per RFC4960 */
609 #define SCTP_MAX_HB_INTERVAL 14400000	/* 4 hours in ms */
610 #define SCTP_MIN_COOKIE_LIFE     1000	/* 1 second in ms */
611 #define SCTP_MAX_COOKIE_LIFE  3600000	/* 1 hour in ms */
612 
613 /* Types of logging/KTR tracing  that can be enabled via the
614  * sysctl net.inet.sctp.sctp_logging. You must also enable
615  * SUBSYS tracing.
616  * Note that you must have the SCTP option in the kernel
617  * to enable these as well.
618  */
619 #define SCTP_BLK_LOGGING_ENABLE				0x00000001
620 #define SCTP_CWND_MONITOR_ENABLE			0x00000002
621 #define SCTP_CWND_LOGGING_ENABLE			0x00000004
622 #define SCTP_FLIGHT_LOGGING_ENABLE			0x00000020
623 #define SCTP_FR_LOGGING_ENABLE				0x00000040
624 #define SCTP_LOCK_LOGGING_ENABLE			0x00000080
625 #define SCTP_MAP_LOGGING_ENABLE				0x00000100
626 #define SCTP_MBCNT_LOGGING_ENABLE			0x00000200
627 #define SCTP_MBUF_LOGGING_ENABLE			0x00000400
628 #define SCTP_NAGLE_LOGGING_ENABLE			0x00000800
629 #define SCTP_RECV_RWND_LOGGING_ENABLE			0x00001000
630 #define SCTP_RTTVAR_LOGGING_ENABLE			0x00002000
631 #define SCTP_SACK_LOGGING_ENABLE			0x00004000
632 #define SCTP_SACK_RWND_LOGGING_ENABLE			0x00008000
633 #define SCTP_SB_LOGGING_ENABLE				0x00010000
634 #define SCTP_STR_LOGGING_ENABLE				0x00020000
635 #define SCTP_WAKE_LOGGING_ENABLE			0x00040000
636 #define SCTP_LOG_MAXBURST_ENABLE			0x00080000
637 #define SCTP_LOG_RWND_ENABLE    			0x00100000
638 #define SCTP_LOG_SACK_ARRIVALS_ENABLE			0x00200000
639 #define SCTP_LTRACE_CHUNK_ENABLE			0x00400000
640 #define SCTP_LTRACE_ERROR_ENABLE			0x00800000
641 #define SCTP_LAST_PACKET_TRACING			0x01000000
642 #define SCTP_THRESHOLD_LOGGING				0x02000000
643 #define SCTP_LOG_AT_SEND_2_SCTP				0x04000000
644 #define SCTP_LOG_AT_SEND_2_OUTQ				0x08000000
645 #define SCTP_LOG_TRY_ADVANCE				0x10000000
646 
647 #endif				/* !_NETINET_SCTP_H_ */
648