xref: /freebsd/sys/netinet/sctp.h (revision b1ce21c6efcf01904c5ae425327bfeca3c1b47b5)
1f8829a4aSRandall Stewart /*-
2830d754dSRandall Stewart  * Copyright (c) 2001-2008, by Cisco Systems, Inc. All rights reserved.
3f8829a4aSRandall Stewart  *
4f8829a4aSRandall Stewart  * Redistribution and use in source and binary forms, with or without
5f8829a4aSRandall Stewart  * modification, are permitted provided that the following conditions are met:
6f8829a4aSRandall Stewart  *
7f8829a4aSRandall Stewart  * a) Redistributions of source code must retain the above copyright notice,
8f8829a4aSRandall Stewart  *   this list of conditions and the following disclaimer.
9f8829a4aSRandall Stewart  *
10f8829a4aSRandall Stewart  * b) Redistributions in binary form must reproduce the above copyright
11f8829a4aSRandall Stewart  *    notice, this list of conditions and the following disclaimer in
12f8829a4aSRandall Stewart  *   the documentation and/or other materials provided with the distribution.
13f8829a4aSRandall Stewart  *
14f8829a4aSRandall Stewart  * c) Neither the name of Cisco Systems, Inc. nor the names of its
15f8829a4aSRandall Stewart  *    contributors may be used to endorse or promote products derived
16f8829a4aSRandall Stewart  *    from this software without specific prior written permission.
17f8829a4aSRandall Stewart  *
18f8829a4aSRandall Stewart  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19f8829a4aSRandall Stewart  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
20f8829a4aSRandall Stewart  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21f8829a4aSRandall Stewart  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
22f8829a4aSRandall Stewart  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23f8829a4aSRandall Stewart  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24f8829a4aSRandall Stewart  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25f8829a4aSRandall Stewart  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26f8829a4aSRandall Stewart  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27f8829a4aSRandall Stewart  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
28f8829a4aSRandall Stewart  * THE POSSIBILITY OF SUCH DAMAGE.
29f8829a4aSRandall Stewart  */
30f8829a4aSRandall Stewart /* $KAME: sctp.h,v 1.18 2005/03/06 16:04:16 itojun Exp $	 */
31f8829a4aSRandall Stewart 
32f8829a4aSRandall Stewart #include <sys/cdefs.h>
33f8829a4aSRandall Stewart __FBSDID("$FreeBSD$");
34f8829a4aSRandall Stewart 
35f8829a4aSRandall Stewart #ifndef _NETINET_SCTP_H_
36f8829a4aSRandall Stewart #define _NETINET_SCTP_H_
37f8829a4aSRandall Stewart 
38f8829a4aSRandall Stewart #include <sys/types.h>
39f8829a4aSRandall Stewart 
40b3f1ea41SRandall Stewart 
41b3f1ea41SRandall Stewart #define SCTP_PACKED __attribute__((packed))
42b3f1ea41SRandall Stewart 
43f8829a4aSRandall Stewart /*
44f8829a4aSRandall Stewart  * SCTP protocol - RFC2960.
45f8829a4aSRandall Stewart  */
46f8829a4aSRandall Stewart struct sctphdr {
47f8829a4aSRandall Stewart 	uint16_t src_port;	/* source port */
48f8829a4aSRandall Stewart 	uint16_t dest_port;	/* destination port */
49f8829a4aSRandall Stewart 	uint32_t v_tag;		/* verification tag of packet */
50f8829a4aSRandall Stewart 	uint32_t checksum;	/* Adler32 C-Sum */
51f8829a4aSRandall Stewart 	/* chunks follow... */
52b3f1ea41SRandall Stewart }       SCTP_PACKED;
53f8829a4aSRandall Stewart 
54f8829a4aSRandall Stewart /*
55f8829a4aSRandall Stewart  * SCTP Chunks
56f8829a4aSRandall Stewart  */
57f8829a4aSRandall Stewart struct sctp_chunkhdr {
58f8829a4aSRandall Stewart 	uint8_t chunk_type;	/* chunk type */
59f8829a4aSRandall Stewart 	uint8_t chunk_flags;	/* chunk flags */
60f8829a4aSRandall Stewart 	uint16_t chunk_length;	/* chunk length */
61f8829a4aSRandall Stewart 	/* optional params follow */
62b3f1ea41SRandall Stewart }             SCTP_PACKED;
63f8829a4aSRandall Stewart 
64f8829a4aSRandall Stewart /*
65f8829a4aSRandall Stewart  * SCTP chunk parameters
66f8829a4aSRandall Stewart  */
67f8829a4aSRandall Stewart struct sctp_paramhdr {
68f8829a4aSRandall Stewart 	uint16_t param_type;	/* parameter type */
69f8829a4aSRandall Stewart 	uint16_t param_length;	/* parameter length */
70b3f1ea41SRandall Stewart }             SCTP_PACKED;
71f8829a4aSRandall Stewart 
72f8829a4aSRandall Stewart /*
73f8829a4aSRandall Stewart  * user socket options: socket API defined
74f8829a4aSRandall Stewart  */
75f8829a4aSRandall Stewart /*
76f8829a4aSRandall Stewart  * read-write options
77f8829a4aSRandall Stewart  */
78f8829a4aSRandall Stewart #define SCTP_RTOINFO			0x00000001
79f8829a4aSRandall Stewart #define SCTP_ASSOCINFO			0x00000002
80f8829a4aSRandall Stewart #define SCTP_INITMSG			0x00000003
81f8829a4aSRandall Stewart #define SCTP_NODELAY			0x00000004
82f8829a4aSRandall Stewart #define SCTP_AUTOCLOSE			0x00000005
83f8829a4aSRandall Stewart #define SCTP_SET_PEER_PRIMARY_ADDR	0x00000006
84f8829a4aSRandall Stewart #define SCTP_PRIMARY_ADDR		0x00000007
85f8829a4aSRandall Stewart #define SCTP_ADAPTATION_LAYER		0x00000008
86f8829a4aSRandall Stewart /* same as above */
87f8829a4aSRandall Stewart #define SCTP_ADAPTION_LAYER		0x00000008
88f8829a4aSRandall Stewart #define SCTP_DISABLE_FRAGMENTS		0x00000009
89f8829a4aSRandall Stewart #define SCTP_PEER_ADDR_PARAMS 		0x0000000a
90f8829a4aSRandall Stewart #define SCTP_DEFAULT_SEND_PARAM		0x0000000b
91f8829a4aSRandall Stewart /* ancillary data/notification interest options */
92f8829a4aSRandall Stewart #define SCTP_EVENTS			0x0000000c
93f8829a4aSRandall Stewart /* Without this applied we will give V4 and V6 addresses on a V6 socket */
94f8829a4aSRandall Stewart #define SCTP_I_WANT_MAPPED_V4_ADDR	0x0000000d
95f8829a4aSRandall Stewart #define SCTP_MAXSEG 			0x0000000e
96d61a0ae0SRandall Stewart #define SCTP_DELAYED_SACK               0x0000000f
97f8829a4aSRandall Stewart #define SCTP_FRAGMENT_INTERLEAVE        0x00000010
98f8829a4aSRandall Stewart #define SCTP_PARTIAL_DELIVERY_POINT     0x00000011
99f8829a4aSRandall Stewart /* authentication support */
100f8829a4aSRandall Stewart #define SCTP_AUTH_CHUNK 		0x00000012
101f8829a4aSRandall Stewart #define SCTP_AUTH_KEY 			0x00000013
102f8829a4aSRandall Stewart #define SCTP_HMAC_IDENT 		0x00000014
103f8829a4aSRandall Stewart #define SCTP_AUTH_ACTIVE_KEY 		0x00000015
104f8829a4aSRandall Stewart #define SCTP_AUTH_DELETE_KEY 		0x00000016
105f8829a4aSRandall Stewart #define SCTP_USE_EXT_RCVINFO		0x00000017
106f8829a4aSRandall Stewart #define SCTP_AUTO_ASCONF		0x00000018	/* rw */
107f8829a4aSRandall Stewart #define SCTP_MAXBURST			0x00000019	/* rw */
108d61a0ae0SRandall Stewart #define SCTP_MAX_BURST			0x00000019	/* rw */
109f8829a4aSRandall Stewart /* assoc level context */
110f8829a4aSRandall Stewart #define SCTP_CONTEXT                    0x0000001a	/* rw */
111*b1ce21c6SRebecca Cran /* explicit EOR signalling */
112f8829a4aSRandall Stewart #define SCTP_EXPLICIT_EOR               0x0000001b
1136d9e8f2bSRandall Stewart #define SCTP_REUSE_PORT                 0x0000001c	/* rw */
114830d754dSRandall Stewart #define SCTP_AUTH_DEACTIVATE_KEY	0x0000001d
115f8829a4aSRandall Stewart 
116f8829a4aSRandall Stewart /*
117f8829a4aSRandall Stewart  * read-only options
118f8829a4aSRandall Stewart  */
119f8829a4aSRandall Stewart #define SCTP_STATUS			0x00000100
120f8829a4aSRandall Stewart #define SCTP_GET_PEER_ADDR_INFO		0x00000101
121f8829a4aSRandall Stewart /* authentication support */
122f8829a4aSRandall Stewart #define SCTP_PEER_AUTH_CHUNKS 		0x00000102
123f8829a4aSRandall Stewart #define SCTP_LOCAL_AUTH_CHUNKS 		0x00000103
1243c503c28SRandall Stewart #define SCTP_GET_ASSOC_NUMBER           0x00000104	/* ro */
1253c503c28SRandall Stewart #define SCTP_GET_ASSOC_ID_LIST          0x00000105	/* ro */
126f8829a4aSRandall Stewart 
127f8829a4aSRandall Stewart /*
128f8829a4aSRandall Stewart  * user socket options: BSD implementation specific
129f8829a4aSRandall Stewart  */
130f8829a4aSRandall Stewart /*
131f8829a4aSRandall Stewart  * Blocking I/O is enabled on any TCP type socket by default. For the UDP
132f8829a4aSRandall Stewart  * model if this is turned on then the socket buffer is shared for send
133f8829a4aSRandall Stewart  * resources amongst all associations.  The default for the UDP model is that
134*b1ce21c6SRebecca Cran  * is SS_NBIO is set.  Which means all associations have a separate send
135f8829a4aSRandall Stewart  * limit BUT they will NOT ever BLOCK instead you will get an error back
136*b1ce21c6SRebecca Cran  * EAGAIN if you try to send too much. If you want the blocking semantics you
137f8829a4aSRandall Stewart  * set this option at the cost of sharing one socket send buffer size amongst
138f8829a4aSRandall Stewart  * all associations. Peeled off sockets turn this option off and block. But
139f8829a4aSRandall Stewart  * since both TCP and peeled off sockets have only one assoc per socket this
140f8829a4aSRandall Stewart  * is fine. It probably does NOT make sense to set this on SS_NBIO on a TCP
141f8829a4aSRandall Stewart  * model OR peeled off UDP model, but we do allow you to do so. You just use
142f8829a4aSRandall Stewart  * the normal syscall to toggle SS_NBIO the way you want.
143f8829a4aSRandall Stewart  *
144*b1ce21c6SRebecca Cran  * Blocking I/O is controlled by the SS_NBIO flag on the socket state so_state
145f8829a4aSRandall Stewart  * field.
146f8829a4aSRandall Stewart  */
147f8829a4aSRandall Stewart 
148f8829a4aSRandall Stewart /* these should probably go into sockets API */
149f8829a4aSRandall Stewart #define SCTP_RESET_STREAMS		0x00001004	/* wo */
150f8829a4aSRandall Stewart 
151f8829a4aSRandall Stewart 
152f8829a4aSRandall Stewart /* here on down are more implementation specific */
153f8829a4aSRandall Stewart #define SCTP_SET_DEBUG_LEVEL		0x00001005
154f8829a4aSRandall Stewart #define SCTP_CLR_STAT_LOG               0x00001007
155f8829a4aSRandall Stewart /* CMT ON/OFF socket option */
156f8829a4aSRandall Stewart #define SCTP_CMT_ON_OFF                 0x00001200
157f8829a4aSRandall Stewart #define SCTP_CMT_USE_DAC                0x00001201
158b54d3a6cSRandall Stewart /* JRS - Pluggable Congestion Control Socket option */
159b54d3a6cSRandall Stewart #define SCTP_PLUGGABLE_CC               0x00001202
160f8829a4aSRandall Stewart 
161f8829a4aSRandall Stewart /* read only */
162f8829a4aSRandall Stewart #define SCTP_GET_SNDBUF_USE		0x00001101
163f8829a4aSRandall Stewart #define SCTP_GET_STAT_LOG		0x00001103
1643c503c28SRandall Stewart #define SCTP_PCB_STATUS			0x00001104
1653c503c28SRandall Stewart #define SCTP_GET_NONCE_VALUES           0x00001105
166f8829a4aSRandall Stewart 
167207304d4SRandall Stewart 
16842551e99SRandall Stewart /* Special hook for dynamically setting primary for all assoc's,
169*b1ce21c6SRebecca Cran  * this is a write only option that requires root privilege.
17042551e99SRandall Stewart  */
17142551e99SRandall Stewart #define SCTP_SET_DYNAMIC_PRIMARY        0x00002001
172f8829a4aSRandall Stewart 
17342551e99SRandall Stewart /* VRF (virtual router feature) and multi-VRF support
17442551e99SRandall Stewart  * options. VRF's provide splits within a router
17542551e99SRandall Stewart  * that give the views of multiple routers. A
17642551e99SRandall Stewart  * standard host, without VRF support, is just
17742551e99SRandall Stewart  * a single VRF. If VRF's are supported then
17842551e99SRandall Stewart  * the transport must be VRF aware. This means
17942551e99SRandall Stewart  * that every socket call coming in must be directed
18042551e99SRandall Stewart  * within the endpoint to one of the VRF's it belongs
18142551e99SRandall Stewart  * to. The endpoint, before binding, may select
18242551e99SRandall Stewart  * the "default" VRF it is in by using a set socket
18342551e99SRandall Stewart  * option with SCTP_VRF_ID. This will also
184*b1ce21c6SRebecca Cran  * get propagated to the default VRF. Once the
18542551e99SRandall Stewart  * endpoint binds an address then it CANNOT add
18642551e99SRandall Stewart  * additional VRF's to become a Multi-VRF endpoint.
18742551e99SRandall Stewart  *
18842551e99SRandall Stewart  * Before BINDING additional VRF's can be added with
18942551e99SRandall Stewart  * the SCTP_ADD_VRF_ID call or deleted with
19042551e99SRandall Stewart  * SCTP_DEL_VRF_ID.
19142551e99SRandall Stewart  *
19242551e99SRandall Stewart  * Associations are ALWAYS contained inside a single
19342551e99SRandall Stewart  * VRF. They cannot reside in two (or more) VRF's. Incoming
19442551e99SRandall Stewart  * packets, assuming the router is VRF aware, can always
19542551e99SRandall Stewart  * tell us what VRF they arrived on. A host not supporting
19642551e99SRandall Stewart  * any VRF's will find that the packets always arrived on the
19742551e99SRandall Stewart  * single VRF that the host has.
19842551e99SRandall Stewart  *
19942551e99SRandall Stewart  */
20042551e99SRandall Stewart 
20142551e99SRandall Stewart #define SCTP_VRF_ID			0x00003001
20242551e99SRandall Stewart #define SCTP_ADD_VRF_ID			0x00003002
20342551e99SRandall Stewart #define SCTP_GET_VRF_IDS		0x00003003
20442551e99SRandall Stewart #define SCTP_GET_ASOC_VRF               0x00003004
20542551e99SRandall Stewart #define SCTP_DEL_VRF_ID                 0x00003005
206207304d4SRandall Stewart 
207207304d4SRandall Stewart /*
208207304d4SRandall Stewart  * If you enable packet logging you can get
209207304d4SRandall Stewart  * a poor mans ethereal output in binary
210207304d4SRandall Stewart  * form. Note this is a compile option to
211207304d4SRandall Stewart  * the kernel,  SCTP_PACKET_LOGGING, and
212207304d4SRandall Stewart  * without it in your kernel you
2136b4ae356SRandall Stewart  * will get a EOPNOTSUPP
214207304d4SRandall Stewart  */
215207304d4SRandall Stewart #define SCTP_GET_PACKET_LOG             0x00004001
216207304d4SRandall Stewart 
217f8829a4aSRandall Stewart /*
218f8829a4aSRandall Stewart  * hidden implementation specific options these are NOT user visible (should
219f8829a4aSRandall Stewart  * move out of sctp.h)
220f8829a4aSRandall Stewart  */
221f8829a4aSRandall Stewart /* sctp_bindx() flags as hidden socket options */
222f8829a4aSRandall Stewart #define SCTP_BINDX_ADD_ADDR		0x00008001
223f8829a4aSRandall Stewart #define SCTP_BINDX_REM_ADDR		0x00008002
224f8829a4aSRandall Stewart /* Hidden socket option that gets the addresses */
225f8829a4aSRandall Stewart #define SCTP_GET_PEER_ADDRESSES		0x00008003
226f8829a4aSRandall Stewart #define SCTP_GET_LOCAL_ADDRESSES	0x00008004
227f8829a4aSRandall Stewart /* return the total count in bytes needed to hold all local addresses bound */
228f8829a4aSRandall Stewart #define SCTP_GET_LOCAL_ADDR_SIZE	0x00008005
229f8829a4aSRandall Stewart /* Return the total count in bytes needed to hold the remote address */
230f8829a4aSRandall Stewart #define SCTP_GET_REMOTE_ADDR_SIZE	0x00008006
231f8829a4aSRandall Stewart /* hidden option for connectx */
232f8829a4aSRandall Stewart #define SCTP_CONNECT_X			0x00008007
233f8829a4aSRandall Stewart /* hidden option for connectx_delayed, part of sendx */
234f8829a4aSRandall Stewart #define SCTP_CONNECT_X_DELAYED		0x00008008
235f8829a4aSRandall Stewart #define SCTP_CONNECT_X_COMPLETE         0x00008009
236f8829a4aSRandall Stewart /* hidden socket option based sctp_peeloff */
237f8829a4aSRandall Stewart #define SCTP_PEELOFF                    0x0000800a
238f8829a4aSRandall Stewart /* the real worker for sctp_getaddrlen() */
239f8829a4aSRandall Stewart #define SCTP_GET_ADDR_LEN               0x0000800b
240f8829a4aSRandall Stewart /* temporary workaround for Apple listen() issue, no args used */
241f8829a4aSRandall Stewart #define SCTP_LISTEN_FIX			0x0000800c
242f8829a4aSRandall Stewart /* Debug things that need to be purged */
243f8829a4aSRandall Stewart #define SCTP_SET_INITIAL_DBG_SEQ	0x00009f00
244f8829a4aSRandall Stewart 
245b54d3a6cSRandall Stewart /* JRS - Supported congestion control modules for pluggable
246b54d3a6cSRandall Stewart  * congestion control
247b54d3a6cSRandall Stewart  */
248b54d3a6cSRandall Stewart /* Standard TCP Congestion Control */
249b54d3a6cSRandall Stewart #define SCTP_CC_RFC2581		0x00000000
250b54d3a6cSRandall Stewart /* High Speed TCP Congestion Control (Floyd) */
251b54d3a6cSRandall Stewart #define SCTP_CC_HSTCP		0x00000001
252b54d3a6cSRandall Stewart /* HTCP Congestion Control */
253b54d3a6cSRandall Stewart #define SCTP_CC_HTCP		0x00000002
254b54d3a6cSRandall Stewart 
2559a6142d8SRandall Stewart 
2569a6142d8SRandall Stewart /* fragment interleave constants
2579a6142d8SRandall Stewart  * setting must be one of these or
2589a6142d8SRandall Stewart  * EINVAL returned.
2599a6142d8SRandall Stewart  */
2609a6142d8SRandall Stewart #define SCTP_FRAG_LEVEL_0    0x00000000
2619a6142d8SRandall Stewart #define SCTP_FRAG_LEVEL_1    0x00000001
2629a6142d8SRandall Stewart #define SCTP_FRAG_LEVEL_2    0x00000002
2639a6142d8SRandall Stewart 
264f8829a4aSRandall Stewart /*
265f8829a4aSRandall Stewart  * user state values
266f8829a4aSRandall Stewart  */
267f8829a4aSRandall Stewart #define SCTP_CLOSED			0x0000
268f8829a4aSRandall Stewart #define SCTP_BOUND			0x1000
269f8829a4aSRandall Stewart #define SCTP_LISTEN			0x2000
270f8829a4aSRandall Stewart #define SCTP_COOKIE_WAIT		0x0002
271f8829a4aSRandall Stewart #define SCTP_COOKIE_ECHOED		0x0004
272f8829a4aSRandall Stewart #define SCTP_ESTABLISHED		0x0008
273f8829a4aSRandall Stewart #define SCTP_SHUTDOWN_SENT		0x0010
274f8829a4aSRandall Stewart #define SCTP_SHUTDOWN_RECEIVED		0x0020
275f8829a4aSRandall Stewart #define SCTP_SHUTDOWN_ACK_SENT		0x0040
276f8829a4aSRandall Stewart #define SCTP_SHUTDOWN_PENDING		0x0080
277f8829a4aSRandall Stewart 
278f8829a4aSRandall Stewart /*
279f8829a4aSRandall Stewart  * SCTP operational error codes (user visible)
280f8829a4aSRandall Stewart  */
281f8829a4aSRandall Stewart #define SCTP_CAUSE_NO_ERROR		0x0000
282f8829a4aSRandall Stewart #define SCTP_CAUSE_INVALID_STREAM	0x0001
283f8829a4aSRandall Stewart #define SCTP_CAUSE_MISSING_PARAM	0x0002
284f8829a4aSRandall Stewart #define SCTP_CAUSE_STALE_COOKIE		0x0003
285f8829a4aSRandall Stewart #define SCTP_CAUSE_OUT_OF_RESC		0x0004
286f8829a4aSRandall Stewart #define SCTP_CAUSE_UNRESOLVABLE_ADDR	0x0005
287f8829a4aSRandall Stewart #define SCTP_CAUSE_UNRECOG_CHUNK	0x0006
288f8829a4aSRandall Stewart #define SCTP_CAUSE_INVALID_PARAM	0x0007
289f8829a4aSRandall Stewart #define SCTP_CAUSE_UNRECOG_PARAM	0x0008
290f8829a4aSRandall Stewart #define SCTP_CAUSE_NO_USER_DATA		0x0009
291f8829a4aSRandall Stewart #define SCTP_CAUSE_COOKIE_IN_SHUTDOWN	0x000a
292f8829a4aSRandall Stewart #define SCTP_CAUSE_RESTART_W_NEWADDR	0x000b
293f8829a4aSRandall Stewart #define SCTP_CAUSE_USER_INITIATED_ABT	0x000c
294f8829a4aSRandall Stewart #define SCTP_CAUSE_PROTOCOL_VIOLATION	0x000d
295f8829a4aSRandall Stewart 
2963232788eSRandall Stewart /* Error causes from RFC5061 */
297830d754dSRandall Stewart #define SCTP_CAUSE_DELETING_LAST_ADDR	0x00a0
298830d754dSRandall Stewart #define SCTP_CAUSE_RESOURCE_SHORTAGE	0x00a1
299830d754dSRandall Stewart #define SCTP_CAUSE_DELETING_SRC_ADDR	0x00a2
300830d754dSRandall Stewart #define SCTP_CAUSE_ILLEGAL_ASCONF_ACK	0x00a3
301830d754dSRandall Stewart #define SCTP_CAUSE_REQUEST_REFUSED	0x00a4
302830d754dSRandall Stewart 
303830d754dSRandall Stewart /* Error causes from nat-draft */
304830d754dSRandall Stewart #define SCTP_CAUSE_NAT_COLLIDING_STATE  0x00b0
305830d754dSRandall Stewart #define SCTP_CAUSE_NAT_MISSING_STATE    0x00b1
306f8829a4aSRandall Stewart 
3073232788eSRandall Stewart /* Error causes from RFC4895 */
308f8829a4aSRandall Stewart #define SCTP_CAUSE_UNSUPPORTED_HMACID	0x0105
309f8829a4aSRandall Stewart 
310f8829a4aSRandall Stewart /*
311*b1ce21c6SRebecca Cran  * error cause parameters (user visible)
312f8829a4aSRandall Stewart  */
313f8829a4aSRandall Stewart struct sctp_error_cause {
314f8829a4aSRandall Stewart 	uint16_t code;
315f8829a4aSRandall Stewart 	uint16_t length;
316f8829a4aSRandall Stewart 	/* optional cause-specific info may follow */
317b3f1ea41SRandall Stewart }                SCTP_PACKED;
318f8829a4aSRandall Stewart 
319f8829a4aSRandall Stewart struct sctp_error_invalid_stream {
320b3f1ea41SRandall Stewart 	struct sctp_error_cause cause;	/* code=SCTP_ERROR_INVALID_STREAM */
321f8829a4aSRandall Stewart 	uint16_t stream_id;	/* stream id of the DATA in error */
322f8829a4aSRandall Stewart 	uint16_t reserved;
323b3f1ea41SRandall Stewart }                         SCTP_PACKED;
324f8829a4aSRandall Stewart 
325f8829a4aSRandall Stewart struct sctp_error_missing_param {
326b3f1ea41SRandall Stewart 	struct sctp_error_cause cause;	/* code=SCTP_ERROR_MISSING_PARAM */
327b3f1ea41SRandall Stewart 	uint32_t num_missing_params;	/* number of missing parameters */
328f8829a4aSRandall Stewart 	/* uint16_t param_type's follow */
329b3f1ea41SRandall Stewart }                        SCTP_PACKED;
330f8829a4aSRandall Stewart 
331f8829a4aSRandall Stewart struct sctp_error_stale_cookie {
332b3f1ea41SRandall Stewart 	struct sctp_error_cause cause;	/* code=SCTP_ERROR_STALE_COOKIE */
333f8829a4aSRandall Stewart 	uint32_t stale_time;	/* time in usec of staleness */
334b3f1ea41SRandall Stewart }                       SCTP_PACKED;
335f8829a4aSRandall Stewart 
336f8829a4aSRandall Stewart struct sctp_error_out_of_resource {
337b3f1ea41SRandall Stewart 	struct sctp_error_cause cause;	/* code=SCTP_ERROR_OUT_OF_RESOURCES */
338b3f1ea41SRandall Stewart }                          SCTP_PACKED;
339f8829a4aSRandall Stewart 
340f8829a4aSRandall Stewart struct sctp_error_unresolv_addr {
341b3f1ea41SRandall Stewart 	struct sctp_error_cause cause;	/* code=SCTP_ERROR_UNRESOLVABLE_ADDR */
342f8829a4aSRandall Stewart 
343b3f1ea41SRandall Stewart }                        SCTP_PACKED;
344f8829a4aSRandall Stewart 
345f8829a4aSRandall Stewart struct sctp_error_unrecognized_chunk {
346b3f1ea41SRandall Stewart 	struct sctp_error_cause cause;	/* code=SCTP_ERROR_UNRECOG_CHUNK */
347f8829a4aSRandall Stewart 	struct sctp_chunkhdr ch;/* header from chunk in error */
348b3f1ea41SRandall Stewart }                             SCTP_PACKED;
349f8829a4aSRandall Stewart 
350f8829a4aSRandall Stewart /*
351f8829a4aSRandall Stewart  * Main SCTP chunk types we place these here so natd and f/w's in user land
352f8829a4aSRandall Stewart  * can find them.
353f8829a4aSRandall Stewart  */
354f8829a4aSRandall Stewart /************0x00 series ***********/
355f8829a4aSRandall Stewart #define SCTP_DATA		0x00
356f8829a4aSRandall Stewart #define SCTP_INITIATION		0x01
357f8829a4aSRandall Stewart #define SCTP_INITIATION_ACK	0x02
358f8829a4aSRandall Stewart #define SCTP_SELECTIVE_ACK	0x03
359f8829a4aSRandall Stewart #define SCTP_HEARTBEAT_REQUEST	0x04
360f8829a4aSRandall Stewart #define SCTP_HEARTBEAT_ACK	0x05
361f8829a4aSRandall Stewart #define SCTP_ABORT_ASSOCIATION	0x06
362f8829a4aSRandall Stewart #define SCTP_SHUTDOWN		0x07
363f8829a4aSRandall Stewart #define SCTP_SHUTDOWN_ACK	0x08
364f8829a4aSRandall Stewart #define SCTP_OPERATION_ERROR	0x09
365f8829a4aSRandall Stewart #define SCTP_COOKIE_ECHO	0x0a
366f8829a4aSRandall Stewart #define SCTP_COOKIE_ACK		0x0b
367f8829a4aSRandall Stewart #define SCTP_ECN_ECHO		0x0c
368f8829a4aSRandall Stewart #define SCTP_ECN_CWR		0x0d
369f8829a4aSRandall Stewart #define SCTP_SHUTDOWN_COMPLETE	0x0e
3703232788eSRandall Stewart /* RFC4895 */
371f8829a4aSRandall Stewart #define SCTP_AUTHENTICATION     0x0f
372830d754dSRandall Stewart /* EY nr_sack chunk id*/
373830d754dSRandall Stewart #define SCTP_NR_SELECTIVE_ACK 0x10
374f8829a4aSRandall Stewart /************0x40 series ***********/
375f8829a4aSRandall Stewart /************0x80 series ***********/
3763232788eSRandall Stewart /* RFC5061 */
377f8829a4aSRandall Stewart #define	SCTP_ASCONF_ACK		0x80
378f8829a4aSRandall Stewart /* draft-ietf-stewart-pktdrpsctp */
379f8829a4aSRandall Stewart #define SCTP_PACKET_DROPPED	0x81
380f8829a4aSRandall Stewart /* draft-ietf-stewart-strreset-xxx */
381f8829a4aSRandall Stewart #define SCTP_STREAM_RESET       0x82
3829a972525SRandall Stewart 
3839a972525SRandall Stewart /* RFC4820                         */
3849a972525SRandall Stewart #define SCTP_PAD_CHUNK          0x84
385f8829a4aSRandall Stewart /************0xc0 series ***********/
386f8829a4aSRandall Stewart /* RFC3758 */
387f8829a4aSRandall Stewart #define SCTP_FORWARD_CUM_TSN	0xc0
3883232788eSRandall Stewart /* RFC5061 */
389f8829a4aSRandall Stewart #define SCTP_ASCONF		0xc1
390f8829a4aSRandall Stewart 
391f8829a4aSRandall Stewart 
392f8829a4aSRandall Stewart /* ABORT and SHUTDOWN COMPLETE FLAG */
393f8829a4aSRandall Stewart #define SCTP_HAD_NO_TCB		0x01
394f8829a4aSRandall Stewart 
395f8829a4aSRandall Stewart /* Packet dropped flags */
396f8829a4aSRandall Stewart #define SCTP_FROM_MIDDLE_BOX	SCTP_HAD_NO_TCB
397f8829a4aSRandall Stewart #define SCTP_BADCRC		0x02
398f8829a4aSRandall Stewart #define SCTP_PACKET_TRUNCATED	0x04
399f8829a4aSRandall Stewart 
400f8829a4aSRandall Stewart #define SCTP_SAT_NETWORK_MIN	400	/* min ms for RTT to set satellite
401f8829a4aSRandall Stewart 					 * time */
402f8829a4aSRandall Stewart #define SCTP_SAT_NETWORK_BURST_INCR  2	/* how many times to multiply maxburst
403f8829a4aSRandall Stewart 					 * in sat */
404f8829a4aSRandall Stewart 
405f8829a4aSRandall Stewart /* Data Chuck Specific Flags */
406f8829a4aSRandall Stewart #define SCTP_DATA_FRAG_MASK        0x03
407f8829a4aSRandall Stewart #define SCTP_DATA_MIDDLE_FRAG      0x00
408f8829a4aSRandall Stewart #define SCTP_DATA_LAST_FRAG        0x01
409f8829a4aSRandall Stewart #define SCTP_DATA_FIRST_FRAG       0x02
410f8829a4aSRandall Stewart #define SCTP_DATA_NOT_FRAG         0x03
411f8829a4aSRandall Stewart #define SCTP_DATA_UNORDERED        0x04
412b3f1ea41SRandall Stewart #define SCTP_DATA_SACK_IMMEDIATELY 0x08
413f8829a4aSRandall Stewart /* ECN Nonce: SACK Chunk Specific Flags */
414f8829a4aSRandall Stewart #define SCTP_SACK_NONCE_SUM        0x01
415f8829a4aSRandall Stewart 
416f8829a4aSRandall Stewart /* CMT DAC algorithm SACK flag */
417f8829a4aSRandall Stewart #define SCTP_SACK_CMT_DAC          0x80
418f8829a4aSRandall Stewart 
41958967d8dSRandall Stewart /*
42058967d8dSRandall Stewart  * PCB flags (in sctp_flags bitmask).
42158967d8dSRandall Stewart  * Note the features and flags are meant
42258967d8dSRandall Stewart  * for use by netstat.
42358967d8dSRandall Stewart  */
42458967d8dSRandall Stewart #define SCTP_PCB_FLAGS_UDPTYPE		0x00000001
42558967d8dSRandall Stewart #define SCTP_PCB_FLAGS_TCPTYPE		0x00000002
42658967d8dSRandall Stewart #define SCTP_PCB_FLAGS_BOUNDALL		0x00000004
42758967d8dSRandall Stewart #define SCTP_PCB_FLAGS_ACCEPTING	0x00000008
42858967d8dSRandall Stewart #define SCTP_PCB_FLAGS_UNBOUND		0x00000010
42958967d8dSRandall Stewart #define SCTP_PCB_FLAGS_CLOSE_IP         0x00040000
43058967d8dSRandall Stewart #define SCTP_PCB_FLAGS_WAS_CONNECTED    0x00080000
43158967d8dSRandall Stewart #define SCTP_PCB_FLAGS_WAS_ABORTED      0x00100000
43258967d8dSRandall Stewart /* TCP model support */
43358967d8dSRandall Stewart 
43458967d8dSRandall Stewart #define SCTP_PCB_FLAGS_CONNECTED	0x00200000
43558967d8dSRandall Stewart #define SCTP_PCB_FLAGS_IN_TCPPOOL	0x00400000
43658967d8dSRandall Stewart #define SCTP_PCB_FLAGS_DONT_WAKE	0x00800000
43758967d8dSRandall Stewart #define SCTP_PCB_FLAGS_WAKEOUTPUT	0x01000000
43858967d8dSRandall Stewart #define SCTP_PCB_FLAGS_WAKEINPUT	0x02000000
43958967d8dSRandall Stewart #define SCTP_PCB_FLAGS_BOUND_V6		0x04000000
440bfefd190SRandall Stewart #define SCTP_PCB_FLAGS_BLOCKING_IO	0x08000000
441bfefd190SRandall Stewart #define SCTP_PCB_FLAGS_SOCKET_GONE	0x10000000
442bfefd190SRandall Stewart #define SCTP_PCB_FLAGS_SOCKET_ALLGONE	0x20000000
443cd1386abSMichael Tuexen #define SCTP_PCB_FLAGS_SOCKET_CANT_READ	0x40000000
44458967d8dSRandall Stewart /* flags to copy to new PCB */
445bfefd190SRandall Stewart #define SCTP_PCB_COPY_FLAGS		(SCTP_PCB_FLAGS_BOUNDALL|\
446bfefd190SRandall Stewart 					 SCTP_PCB_FLAGS_WAKEINPUT|\
447bfefd190SRandall Stewart 					 SCTP_PCB_FLAGS_BOUND_V6)
44858967d8dSRandall Stewart 
44958967d8dSRandall Stewart 
45058967d8dSRandall Stewart /*
45158967d8dSRandall Stewart  * PCB Features (in sctp_features bitmask)
45258967d8dSRandall Stewart  */
45358967d8dSRandall Stewart #define SCTP_PCB_FLAGS_EXT_RCVINFO      0x00000002
45458967d8dSRandall Stewart #define SCTP_PCB_FLAGS_DONOT_HEARTBEAT  0x00000004
45558967d8dSRandall Stewart #define SCTP_PCB_FLAGS_FRAG_INTERLEAVE  0x00000008
45658967d8dSRandall Stewart #define SCTP_PCB_FLAGS_INTERLEAVE_STRMS	0x00000010
45758967d8dSRandall Stewart #define SCTP_PCB_FLAGS_DO_ASCONF	0x00000020
45858967d8dSRandall Stewart #define SCTP_PCB_FLAGS_AUTO_ASCONF	0x00000040
45917205eccSRandall Stewart #define SCTP_PCB_FLAGS_ZERO_COPY_ACTIVE 0x00000080
46058967d8dSRandall Stewart /* socket options */
46158967d8dSRandall Stewart #define SCTP_PCB_FLAGS_NODELAY		0x00000100
46258967d8dSRandall Stewart #define SCTP_PCB_FLAGS_AUTOCLOSE	0x00000200
46358967d8dSRandall Stewart #define SCTP_PCB_FLAGS_RECVDATAIOEVNT	0x00000400
46458967d8dSRandall Stewart #define SCTP_PCB_FLAGS_RECVASSOCEVNT	0x00000800
46558967d8dSRandall Stewart #define SCTP_PCB_FLAGS_RECVPADDREVNT	0x00001000
46658967d8dSRandall Stewart #define SCTP_PCB_FLAGS_RECVPEERERR	0x00002000
46758967d8dSRandall Stewart #define SCTP_PCB_FLAGS_RECVSENDFAILEVNT	0x00004000
46858967d8dSRandall Stewart #define SCTP_PCB_FLAGS_RECVSHUTDOWNEVNT	0x00008000
46958967d8dSRandall Stewart #define SCTP_PCB_FLAGS_ADAPTATIONEVNT	0x00010000
47058967d8dSRandall Stewart #define SCTP_PCB_FLAGS_PDAPIEVNT	0x00020000
47158967d8dSRandall Stewart #define SCTP_PCB_FLAGS_AUTHEVNT		0x00040000
47258967d8dSRandall Stewart #define SCTP_PCB_FLAGS_STREAM_RESETEVNT 0x00080000
47358967d8dSRandall Stewart #define SCTP_PCB_FLAGS_NO_FRAGMENT	0x00100000
47458967d8dSRandall Stewart #define SCTP_PCB_FLAGS_EXPLICIT_EOR     0x00400000
475bfefd190SRandall Stewart #define SCTP_PCB_FLAGS_NEEDS_MAPPED_V4	0x00800000
476c54a18d2SRandall Stewart #define SCTP_PCB_FLAGS_MULTIPLE_ASCONFS	0x01000000
4776d9e8f2bSRandall Stewart #define SCTP_PCB_FLAGS_PORTREUSE        0x02000000
478830d754dSRandall Stewart #define SCTP_PCB_FLAGS_DRYEVNT          0x04000000
4792afb3e84SRandall Stewart /*-
4802afb3e84SRandall Stewart  * mobility_features parameters (by micchie).Note
4812afb3e84SRandall Stewart  * these features are applied against the
4822afb3e84SRandall Stewart  * sctp_mobility_features flags.. not the sctp_features
4832afb3e84SRandall Stewart  * flags.
4842afb3e84SRandall Stewart  */
4852afb3e84SRandall Stewart #define SCTP_MOBILITY_BASE		0x00000001
4862afb3e84SRandall Stewart #define SCTP_MOBILITY_FASTHANDOFF	0x00000002
487851b7298SRandall Stewart #define SCTP_MOBILITY_PRIM_DELETED	0x00000004
4882afb3e84SRandall Stewart 
4892afb3e84SRandall Stewart 
490d61a0ae0SRandall Stewart #define SCTP_SMALLEST_PMTU 512	/* smallest pmtu allowed when disabling PMTU
491d61a0ae0SRandall Stewart 				 * discovery */
492d61a0ae0SRandall Stewart 
493f8829a4aSRandall Stewart #include <netinet/sctp_uio.h>
494f8829a4aSRandall Stewart 
49580fefe0aSRandall Stewart /* This dictates the size of the packet
49680fefe0aSRandall Stewart  * collection buffer. This only applies
49780fefe0aSRandall Stewart  * if SCTP_PACKET_LOGGING is enabled in
49880fefe0aSRandall Stewart  * your config.
49980fefe0aSRandall Stewart  */
500207304d4SRandall Stewart #define SCTP_PACKET_LOG_SIZE 65536
501207304d4SRandall Stewart 
50218e198d3SRandall Stewart /* Maximum delays and such a user can set for options that
50318e198d3SRandall Stewart  * take ms.
50418e198d3SRandall Stewart  */
50518e198d3SRandall Stewart #define SCTP_MAX_SACK_DELAY 500	/* per RFC4960 */
50618e198d3SRandall Stewart #define SCTP_MAX_HB_INTERVAL 14400000	/* 4 hours in ms */
50718e198d3SRandall Stewart #define SCTP_MAX_COOKIE_LIFE  3600000	/* 1 hour in ms */
50818e198d3SRandall Stewart 
50918e198d3SRandall Stewart 
51080fefe0aSRandall Stewart /* Types of logging/KTR tracing  that can be enabled via the
51180fefe0aSRandall Stewart  * sysctl net.inet.sctp.sctp_logging. You must also enable
51280fefe0aSRandall Stewart  * SUBSYS tracing.
51380fefe0aSRandall Stewart  * Note that you must have the SCTP option in the kernel
51480fefe0aSRandall Stewart  * to enable these as well.
51580fefe0aSRandall Stewart  */
51680fefe0aSRandall Stewart #define SCTP_BLK_LOGGING_ENABLE				0x00000001
51780fefe0aSRandall Stewart #define SCTP_CWND_MONITOR_ENABLE			0x00000002
51880fefe0aSRandall Stewart #define SCTP_CWND_LOGGING_ENABLE			0x00000004
51980fefe0aSRandall Stewart #define SCTP_EARLYFR_LOGGING_ENABLE			0x00000010
52080fefe0aSRandall Stewart #define SCTP_FLIGHT_LOGGING_ENABLE			0x00000020
52180fefe0aSRandall Stewart #define SCTP_FR_LOGGING_ENABLE				0x00000040
52280fefe0aSRandall Stewart #define SCTP_LOCK_LOGGING_ENABLE			0x00000080
52380fefe0aSRandall Stewart #define SCTP_MAP_LOGGING_ENABLE				0x00000100
52480fefe0aSRandall Stewart #define SCTP_MBCNT_LOGGING_ENABLE			0x00000200
52580fefe0aSRandall Stewart #define SCTP_MBUF_LOGGING_ENABLE			0x00000400
52680fefe0aSRandall Stewart #define SCTP_NAGLE_LOGGING_ENABLE			0x00000800
52780fefe0aSRandall Stewart #define SCTP_RECV_RWND_LOGGING_ENABLE		0x00001000
52880fefe0aSRandall Stewart #define SCTP_RTTVAR_LOGGING_ENABLE			0x00002000
52980fefe0aSRandall Stewart #define SCTP_SACK_LOGGING_ENABLE			0x00004000
53080fefe0aSRandall Stewart #define SCTP_SACK_RWND_LOGGING_ENABLE		0x00008000
53180fefe0aSRandall Stewart #define SCTP_SB_LOGGING_ENABLE				0x00010000
53280fefe0aSRandall Stewart #define SCTP_STR_LOGGING_ENABLE				0x00020000
53380fefe0aSRandall Stewart #define SCTP_WAKE_LOGGING_ENABLE			0x00040000
53480fefe0aSRandall Stewart #define SCTP_LOG_MAXBURST_ENABLE			0x00080000
53580fefe0aSRandall Stewart #define SCTP_LOG_RWND_ENABLE    			0x00100000
53680fefe0aSRandall Stewart #define SCTP_LOG_SACK_ARRIVALS_ENABLE       0x00200000
53780fefe0aSRandall Stewart #define SCTP_LTRACE_CHUNK_ENABLE            0x00400000
53880fefe0aSRandall Stewart #define SCTP_LTRACE_ERROR_ENABLE            0x00800000
539d95ddf02SRandall Stewart #define SCTP_LAST_PACKET_TRACING            0x01000000
540c4739e2fSRandall Stewart #define SCTP_THRESHOLD_LOGGING              0x02000000
5419f22f500SRandall Stewart #define SCTP_LOG_AT_SEND_2_SCTP             0x04000000
5429f22f500SRandall Stewart #define SCTP_LOG_AT_SEND_2_OUTQ             0x08000000
5430c0982b8SRandall Stewart #define SCTP_LOG_TRY_ADVANCE                0x10000000
544207304d4SRandall Stewart 
5452afb3e84SRandall Stewart 
546b3f1ea41SRandall Stewart #undef SCTP_PACKED
547b3f1ea41SRandall Stewart 
548f8829a4aSRandall Stewart #endif				/* !_NETINET_SCTP_H_ */
549