xref: /freebsd/sys/netinet/sctp.h (revision f79aab18)
1f8829a4aSRandall Stewart /*-
2830d754dSRandall Stewart  * Copyright (c) 2001-2008, by Cisco Systems, Inc. All rights reserved.
35d40cf5dSRandall Stewart  * Copyright (c) 2008-2011, by Randall Stewart. All rights reserved.
45d40cf5dSRandall Stewart  * Copyright (c) 2008-2011, by Michael Tuexen. All rights reserved.
5f8829a4aSRandall Stewart  *
6f8829a4aSRandall Stewart  * Redistribution and use in source and binary forms, with or without
7f8829a4aSRandall Stewart  * modification, are permitted provided that the following conditions are met:
8f8829a4aSRandall Stewart  *
9f8829a4aSRandall Stewart  * a) Redistributions of source code must retain the above copyright notice,
10f8829a4aSRandall Stewart  *   this list of conditions and the following disclaimer.
11f8829a4aSRandall Stewart  *
12f8829a4aSRandall Stewart  * b) Redistributions in binary form must reproduce the above copyright
13f8829a4aSRandall Stewart  *    notice, this list of conditions and the following disclaimer in
14f8829a4aSRandall Stewart  *   the documentation and/or other materials provided with the distribution.
15f8829a4aSRandall Stewart  *
16f8829a4aSRandall Stewart  * c) Neither the name of Cisco Systems, Inc. nor the names of its
17f8829a4aSRandall Stewart  *    contributors may be used to endorse or promote products derived
18f8829a4aSRandall Stewart  *    from this software without specific prior written permission.
19f8829a4aSRandall Stewart  *
20f8829a4aSRandall Stewart  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21f8829a4aSRandall Stewart  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
22f8829a4aSRandall Stewart  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23f8829a4aSRandall Stewart  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
24f8829a4aSRandall Stewart  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25f8829a4aSRandall Stewart  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26f8829a4aSRandall Stewart  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27f8829a4aSRandall Stewart  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28f8829a4aSRandall Stewart  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29f8829a4aSRandall Stewart  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
30f8829a4aSRandall Stewart  * THE POSSIBILITY OF SUCH DAMAGE.
31f8829a4aSRandall Stewart  */
32f8829a4aSRandall Stewart /* $KAME: sctp.h,v 1.18 2005/03/06 16:04:16 itojun Exp $	 */
33f8829a4aSRandall Stewart 
34f8829a4aSRandall Stewart #include <sys/cdefs.h>
35f8829a4aSRandall Stewart __FBSDID("$FreeBSD$");
36f8829a4aSRandall Stewart 
37f8829a4aSRandall Stewart #ifndef _NETINET_SCTP_H_
38f8829a4aSRandall Stewart #define _NETINET_SCTP_H_
39f8829a4aSRandall Stewart 
40f8829a4aSRandall Stewart #include <sys/types.h>
41f8829a4aSRandall Stewart 
42b3f1ea41SRandall Stewart 
43b3f1ea41SRandall Stewart #define SCTP_PACKED __attribute__((packed))
44b3f1ea41SRandall Stewart 
45f8829a4aSRandall Stewart /*
46f8829a4aSRandall Stewart  * SCTP protocol - RFC2960.
47f8829a4aSRandall Stewart  */
48f8829a4aSRandall Stewart struct sctphdr {
49f8829a4aSRandall Stewart 	uint16_t src_port;	/* source port */
50f8829a4aSRandall Stewart 	uint16_t dest_port;	/* destination port */
51f8829a4aSRandall Stewart 	uint32_t v_tag;		/* verification tag of packet */
52f8829a4aSRandall Stewart 	uint32_t checksum;	/* Adler32 C-Sum */
53f8829a4aSRandall Stewart 	/* chunks follow... */
54b3f1ea41SRandall Stewart }       SCTP_PACKED;
55f8829a4aSRandall Stewart 
56f8829a4aSRandall Stewart /*
57f8829a4aSRandall Stewart  * SCTP Chunks
58f8829a4aSRandall Stewart  */
59f8829a4aSRandall Stewart struct sctp_chunkhdr {
60f8829a4aSRandall Stewart 	uint8_t chunk_type;	/* chunk type */
61f8829a4aSRandall Stewart 	uint8_t chunk_flags;	/* chunk flags */
62f8829a4aSRandall Stewart 	uint16_t chunk_length;	/* chunk length */
63f8829a4aSRandall Stewart 	/* optional params follow */
64b3f1ea41SRandall Stewart }             SCTP_PACKED;
65f8829a4aSRandall Stewart 
66f8829a4aSRandall Stewart /*
67f8829a4aSRandall Stewart  * SCTP chunk parameters
68f8829a4aSRandall Stewart  */
69f8829a4aSRandall Stewart struct sctp_paramhdr {
70f8829a4aSRandall Stewart 	uint16_t param_type;	/* parameter type */
71f8829a4aSRandall Stewart 	uint16_t param_length;	/* parameter length */
72b3f1ea41SRandall Stewart }             SCTP_PACKED;
73f8829a4aSRandall Stewart 
74f8829a4aSRandall Stewart /*
75f8829a4aSRandall Stewart  * user socket options: socket API defined
76f8829a4aSRandall Stewart  */
77f8829a4aSRandall Stewart /*
78f8829a4aSRandall Stewart  * read-write options
79f8829a4aSRandall Stewart  */
80f8829a4aSRandall Stewart #define SCTP_RTOINFO			0x00000001
81f8829a4aSRandall Stewart #define SCTP_ASSOCINFO			0x00000002
82f8829a4aSRandall Stewart #define SCTP_INITMSG			0x00000003
83f8829a4aSRandall Stewart #define SCTP_NODELAY			0x00000004
84f8829a4aSRandall Stewart #define SCTP_AUTOCLOSE			0x00000005
85f8829a4aSRandall Stewart #define SCTP_SET_PEER_PRIMARY_ADDR	0x00000006
86f8829a4aSRandall Stewart #define SCTP_PRIMARY_ADDR		0x00000007
87f8829a4aSRandall Stewart #define SCTP_ADAPTATION_LAYER		0x00000008
88f8829a4aSRandall Stewart /* same as above */
89f8829a4aSRandall Stewart #define SCTP_ADAPTION_LAYER		0x00000008
90f8829a4aSRandall Stewart #define SCTP_DISABLE_FRAGMENTS		0x00000009
91f8829a4aSRandall Stewart #define SCTP_PEER_ADDR_PARAMS 		0x0000000a
92f8829a4aSRandall Stewart #define SCTP_DEFAULT_SEND_PARAM		0x0000000b
93f8829a4aSRandall Stewart /* ancillary data/notification interest options */
94f8829a4aSRandall Stewart #define SCTP_EVENTS			0x0000000c
95f8829a4aSRandall Stewart /* Without this applied we will give V4 and V6 addresses on a V6 socket */
96f8829a4aSRandall Stewart #define SCTP_I_WANT_MAPPED_V4_ADDR	0x0000000d
97f8829a4aSRandall Stewart #define SCTP_MAXSEG 			0x0000000e
98d61a0ae0SRandall Stewart #define SCTP_DELAYED_SACK               0x0000000f
99f8829a4aSRandall Stewart #define SCTP_FRAGMENT_INTERLEAVE        0x00000010
100f8829a4aSRandall Stewart #define SCTP_PARTIAL_DELIVERY_POINT     0x00000011
101f8829a4aSRandall Stewart /* authentication support */
102f8829a4aSRandall Stewart #define SCTP_AUTH_CHUNK 		0x00000012
103f8829a4aSRandall Stewart #define SCTP_AUTH_KEY 			0x00000013
104f8829a4aSRandall Stewart #define SCTP_HMAC_IDENT 		0x00000014
105f8829a4aSRandall Stewart #define SCTP_AUTH_ACTIVE_KEY 		0x00000015
106f8829a4aSRandall Stewart #define SCTP_AUTH_DELETE_KEY 		0x00000016
107f8829a4aSRandall Stewart #define SCTP_USE_EXT_RCVINFO		0x00000017
108f8829a4aSRandall Stewart #define SCTP_AUTO_ASCONF		0x00000018	/* rw */
109f8829a4aSRandall Stewart #define SCTP_MAXBURST			0x00000019	/* rw */
110d61a0ae0SRandall Stewart #define SCTP_MAX_BURST			0x00000019	/* rw */
111f8829a4aSRandall Stewart /* assoc level context */
112f8829a4aSRandall Stewart #define SCTP_CONTEXT                    0x0000001a	/* rw */
113b1ce21c6SRebecca Cran /* explicit EOR signalling */
114f8829a4aSRandall Stewart #define SCTP_EXPLICIT_EOR               0x0000001b
1156d9e8f2bSRandall Stewart #define SCTP_REUSE_PORT                 0x0000001c	/* rw */
116830d754dSRandall Stewart #define SCTP_AUTH_DEACTIVATE_KEY	0x0000001d
117f8829a4aSRandall Stewart 
118f8829a4aSRandall Stewart /*
119f8829a4aSRandall Stewart  * read-only options
120f8829a4aSRandall Stewart  */
121f8829a4aSRandall Stewart #define SCTP_STATUS			0x00000100
122f8829a4aSRandall Stewart #define SCTP_GET_PEER_ADDR_INFO		0x00000101
123f8829a4aSRandall Stewart /* authentication support */
124f8829a4aSRandall Stewart #define SCTP_PEER_AUTH_CHUNKS 		0x00000102
125f8829a4aSRandall Stewart #define SCTP_LOCAL_AUTH_CHUNKS 		0x00000103
1263c503c28SRandall Stewart #define SCTP_GET_ASSOC_NUMBER           0x00000104	/* ro */
1273c503c28SRandall Stewart #define SCTP_GET_ASSOC_ID_LIST          0x00000105	/* ro */
1286a67588bSMichael Tuexen #define SCTP_TIMEOUTS                   0x00000106
129f8829a4aSRandall Stewart 
130f8829a4aSRandall Stewart /*
131f8829a4aSRandall Stewart  * user socket options: BSD implementation specific
132f8829a4aSRandall Stewart  */
133f8829a4aSRandall Stewart /*
134f8829a4aSRandall Stewart  * Blocking I/O is enabled on any TCP type socket by default. For the UDP
135f8829a4aSRandall Stewart  * model if this is turned on then the socket buffer is shared for send
136f8829a4aSRandall Stewart  * resources amongst all associations.  The default for the UDP model is that
137b1ce21c6SRebecca Cran  * is SS_NBIO is set.  Which means all associations have a separate send
138f8829a4aSRandall Stewart  * limit BUT they will NOT ever BLOCK instead you will get an error back
139b1ce21c6SRebecca Cran  * EAGAIN if you try to send too much. If you want the blocking semantics you
140f8829a4aSRandall Stewart  * set this option at the cost of sharing one socket send buffer size amongst
141f8829a4aSRandall Stewart  * all associations. Peeled off sockets turn this option off and block. But
142f8829a4aSRandall Stewart  * since both TCP and peeled off sockets have only one assoc per socket this
143f8829a4aSRandall Stewart  * is fine. It probably does NOT make sense to set this on SS_NBIO on a TCP
144f8829a4aSRandall Stewart  * model OR peeled off UDP model, but we do allow you to do so. You just use
145f8829a4aSRandall Stewart  * the normal syscall to toggle SS_NBIO the way you want.
146f8829a4aSRandall Stewart  *
147b1ce21c6SRebecca Cran  * Blocking I/O is controlled by the SS_NBIO flag on the socket state so_state
148f8829a4aSRandall Stewart  * field.
149f8829a4aSRandall Stewart  */
150f8829a4aSRandall Stewart 
151f8829a4aSRandall Stewart /* these should probably go into sockets API */
152f8829a4aSRandall Stewart #define SCTP_RESET_STREAMS		0x00001004	/* wo */
153f8829a4aSRandall Stewart 
154f8829a4aSRandall Stewart 
155f8829a4aSRandall Stewart /* here on down are more implementation specific */
156f8829a4aSRandall Stewart #define SCTP_SET_DEBUG_LEVEL		0x00001005
157f8829a4aSRandall Stewart #define SCTP_CLR_STAT_LOG               0x00001007
158f8829a4aSRandall Stewart /* CMT ON/OFF socket option */
159f8829a4aSRandall Stewart #define SCTP_CMT_ON_OFF                 0x00001200
160f8829a4aSRandall Stewart #define SCTP_CMT_USE_DAC                0x00001201
161b54d3a6cSRandall Stewart /* JRS - Pluggable Congestion Control Socket option */
162b54d3a6cSRandall Stewart #define SCTP_PLUGGABLE_CC               0x00001202
163f7a77f6fSMichael Tuexen /* RS - Pluggable Stream Scheduling Socket option */
164f7a77f6fSMichael Tuexen #define SCTP_PLUGGABLE_SS		0x00001203
165f7a77f6fSMichael Tuexen #define SCTP_SS_VALUE			0x00001204
166299108c5SRandall Stewart #define SCTP_CC_OPTION			0x00001205	/* Options for CC
167299108c5SRandall Stewart 							 * modules */
168f8829a4aSRandall Stewart /* read only */
169f8829a4aSRandall Stewart #define SCTP_GET_SNDBUF_USE		0x00001101
170f8829a4aSRandall Stewart #define SCTP_GET_STAT_LOG		0x00001103
1713c503c28SRandall Stewart #define SCTP_PCB_STATUS			0x00001104
1723c503c28SRandall Stewart #define SCTP_GET_NONCE_VALUES           0x00001105
173f8829a4aSRandall Stewart 
174207304d4SRandall Stewart 
17542551e99SRandall Stewart /* Special hook for dynamically setting primary for all assoc's,
176b1ce21c6SRebecca Cran  * this is a write only option that requires root privilege.
17742551e99SRandall Stewart  */
17842551e99SRandall Stewart #define SCTP_SET_DYNAMIC_PRIMARY        0x00002001
179f8829a4aSRandall Stewart 
18042551e99SRandall Stewart /* VRF (virtual router feature) and multi-VRF support
18142551e99SRandall Stewart  * options. VRF's provide splits within a router
18242551e99SRandall Stewart  * that give the views of multiple routers. A
18342551e99SRandall Stewart  * standard host, without VRF support, is just
18442551e99SRandall Stewart  * a single VRF. If VRF's are supported then
18542551e99SRandall Stewart  * the transport must be VRF aware. This means
18642551e99SRandall Stewart  * that every socket call coming in must be directed
18742551e99SRandall Stewart  * within the endpoint to one of the VRF's it belongs
18842551e99SRandall Stewart  * to. The endpoint, before binding, may select
18942551e99SRandall Stewart  * the "default" VRF it is in by using a set socket
19042551e99SRandall Stewart  * option with SCTP_VRF_ID. This will also
191b1ce21c6SRebecca Cran  * get propagated to the default VRF. Once the
19242551e99SRandall Stewart  * endpoint binds an address then it CANNOT add
19342551e99SRandall Stewart  * additional VRF's to become a Multi-VRF endpoint.
19442551e99SRandall Stewart  *
19542551e99SRandall Stewart  * Before BINDING additional VRF's can be added with
19642551e99SRandall Stewart  * the SCTP_ADD_VRF_ID call or deleted with
19742551e99SRandall Stewart  * SCTP_DEL_VRF_ID.
19842551e99SRandall Stewart  *
19942551e99SRandall Stewart  * Associations are ALWAYS contained inside a single
20042551e99SRandall Stewart  * VRF. They cannot reside in two (or more) VRF's. Incoming
20142551e99SRandall Stewart  * packets, assuming the router is VRF aware, can always
20242551e99SRandall Stewart  * tell us what VRF they arrived on. A host not supporting
20342551e99SRandall Stewart  * any VRF's will find that the packets always arrived on the
20442551e99SRandall Stewart  * single VRF that the host has.
20542551e99SRandall Stewart  *
20642551e99SRandall Stewart  */
20742551e99SRandall Stewart 
20842551e99SRandall Stewart #define SCTP_VRF_ID			0x00003001
20942551e99SRandall Stewart #define SCTP_ADD_VRF_ID			0x00003002
21042551e99SRandall Stewart #define SCTP_GET_VRF_IDS		0x00003003
21142551e99SRandall Stewart #define SCTP_GET_ASOC_VRF               0x00003004
21242551e99SRandall Stewart #define SCTP_DEL_VRF_ID                 0x00003005
213207304d4SRandall Stewart 
214207304d4SRandall Stewart /*
215207304d4SRandall Stewart  * If you enable packet logging you can get
216207304d4SRandall Stewart  * a poor mans ethereal output in binary
217207304d4SRandall Stewart  * form. Note this is a compile option to
218207304d4SRandall Stewart  * the kernel,  SCTP_PACKET_LOGGING, and
219207304d4SRandall Stewart  * without it in your kernel you
2206b4ae356SRandall Stewart  * will get a EOPNOTSUPP
221207304d4SRandall Stewart  */
222207304d4SRandall Stewart #define SCTP_GET_PACKET_LOG             0x00004001
223207304d4SRandall Stewart 
224f8829a4aSRandall Stewart /*
225f8829a4aSRandall Stewart  * hidden implementation specific options these are NOT user visible (should
226f8829a4aSRandall Stewart  * move out of sctp.h)
227f8829a4aSRandall Stewart  */
228f8829a4aSRandall Stewart /* sctp_bindx() flags as hidden socket options */
229f8829a4aSRandall Stewart #define SCTP_BINDX_ADD_ADDR		0x00008001
230f8829a4aSRandall Stewart #define SCTP_BINDX_REM_ADDR		0x00008002
231f8829a4aSRandall Stewart /* Hidden socket option that gets the addresses */
232f8829a4aSRandall Stewart #define SCTP_GET_PEER_ADDRESSES		0x00008003
233f8829a4aSRandall Stewart #define SCTP_GET_LOCAL_ADDRESSES	0x00008004
234f8829a4aSRandall Stewart /* return the total count in bytes needed to hold all local addresses bound */
235f8829a4aSRandall Stewart #define SCTP_GET_LOCAL_ADDR_SIZE	0x00008005
236f8829a4aSRandall Stewart /* Return the total count in bytes needed to hold the remote address */
237f8829a4aSRandall Stewart #define SCTP_GET_REMOTE_ADDR_SIZE	0x00008006
238f8829a4aSRandall Stewart /* hidden option for connectx */
239f8829a4aSRandall Stewart #define SCTP_CONNECT_X			0x00008007
240f8829a4aSRandall Stewart /* hidden option for connectx_delayed, part of sendx */
241f8829a4aSRandall Stewart #define SCTP_CONNECT_X_DELAYED		0x00008008
242f8829a4aSRandall Stewart #define SCTP_CONNECT_X_COMPLETE         0x00008009
243f8829a4aSRandall Stewart /* hidden socket option based sctp_peeloff */
244f8829a4aSRandall Stewart #define SCTP_PEELOFF                    0x0000800a
245f8829a4aSRandall Stewart /* the real worker for sctp_getaddrlen() */
246f8829a4aSRandall Stewart #define SCTP_GET_ADDR_LEN               0x0000800b
247f8829a4aSRandall Stewart /* temporary workaround for Apple listen() issue, no args used */
248f8829a4aSRandall Stewart #define SCTP_LISTEN_FIX			0x0000800c
249f8829a4aSRandall Stewart /* Debug things that need to be purged */
250f8829a4aSRandall Stewart #define SCTP_SET_INITIAL_DBG_SEQ	0x00009f00
251f8829a4aSRandall Stewart 
252b54d3a6cSRandall Stewart /* JRS - Supported congestion control modules for pluggable
253b54d3a6cSRandall Stewart  * congestion control
254b54d3a6cSRandall Stewart  */
255b54d3a6cSRandall Stewart /* Standard TCP Congestion Control */
256b54d3a6cSRandall Stewart #define SCTP_CC_RFC2581		0x00000000
257b54d3a6cSRandall Stewart /* High Speed TCP Congestion Control (Floyd) */
258b54d3a6cSRandall Stewart #define SCTP_CC_HSTCP		0x00000001
259b54d3a6cSRandall Stewart /* HTCP Congestion Control */
260b54d3a6cSRandall Stewart #define SCTP_CC_HTCP		0x00000002
26148b6c649SRandall Stewart /* RTCC Congestion Control - RFC2581 plus */
26248b6c649SRandall Stewart #define SCTP_CC_RTCC            0x00000003
26348b6c649SRandall Stewart 
26448b6c649SRandall Stewart #define SCTP_CC_OPT_RTCC_SETMODE	0x00002000
26548b6c649SRandall Stewart #define SCTP_CC_OPT_USE_DCCC_ECN	0x00002001
266f79aab18SRandall Stewart #define SCTP_CC_OPT_STEADY_STEP         0x00002002
267b54d3a6cSRandall Stewart 
268f7a77f6fSMichael Tuexen /* RS - Supported stream scheduling modules for pluggable
269f7a77f6fSMichael Tuexen  * stream scheduling
270f7a77f6fSMichael Tuexen  */
271f7a77f6fSMichael Tuexen /* Default simple round-robin */
272f7a77f6fSMichael Tuexen #define SCTP_SS_DEFAULT			0x00000000
273f7a77f6fSMichael Tuexen /* Real round-robin */
274f7a77f6fSMichael Tuexen #define SCTP_SS_ROUND_ROBIN		0x00000001
275f7a77f6fSMichael Tuexen /* Real round-robin per packet */
276f7a77f6fSMichael Tuexen #define SCTP_SS_ROUND_ROBIN_PACKET	0x00000002
277f7a77f6fSMichael Tuexen /* Priority */
278f7a77f6fSMichael Tuexen #define SCTP_SS_PRIORITY		0x00000003
279f7a77f6fSMichael Tuexen /* Fair Bandwidth */
280f7a77f6fSMichael Tuexen #define SCTP_SS_FAIR_BANDWITH		0x00000004
281f7a77f6fSMichael Tuexen /* First-come, first-serve */
282f7a77f6fSMichael Tuexen #define SCTP_SS_FIRST_COME		0x00000005
283f7a77f6fSMichael Tuexen 
2849a6142d8SRandall Stewart 
2859a6142d8SRandall Stewart /* fragment interleave constants
2869a6142d8SRandall Stewart  * setting must be one of these or
2879a6142d8SRandall Stewart  * EINVAL returned.
2889a6142d8SRandall Stewart  */
2899a6142d8SRandall Stewart #define SCTP_FRAG_LEVEL_0    0x00000000
2909a6142d8SRandall Stewart #define SCTP_FRAG_LEVEL_1    0x00000001
2919a6142d8SRandall Stewart #define SCTP_FRAG_LEVEL_2    0x00000002
2929a6142d8SRandall Stewart 
293f8829a4aSRandall Stewart /*
294f8829a4aSRandall Stewart  * user state values
295f8829a4aSRandall Stewart  */
296f8829a4aSRandall Stewart #define SCTP_CLOSED			0x0000
297f8829a4aSRandall Stewart #define SCTP_BOUND			0x1000
298f8829a4aSRandall Stewart #define SCTP_LISTEN			0x2000
299f8829a4aSRandall Stewart #define SCTP_COOKIE_WAIT		0x0002
300f8829a4aSRandall Stewart #define SCTP_COOKIE_ECHOED		0x0004
301f8829a4aSRandall Stewart #define SCTP_ESTABLISHED		0x0008
302f8829a4aSRandall Stewart #define SCTP_SHUTDOWN_SENT		0x0010
303f8829a4aSRandall Stewart #define SCTP_SHUTDOWN_RECEIVED		0x0020
304f8829a4aSRandall Stewart #define SCTP_SHUTDOWN_ACK_SENT		0x0040
305f8829a4aSRandall Stewart #define SCTP_SHUTDOWN_PENDING		0x0080
306f8829a4aSRandall Stewart 
307f8829a4aSRandall Stewart /*
308f8829a4aSRandall Stewart  * SCTP operational error codes (user visible)
309f8829a4aSRandall Stewart  */
310f8829a4aSRandall Stewart #define SCTP_CAUSE_NO_ERROR		0x0000
311f8829a4aSRandall Stewart #define SCTP_CAUSE_INVALID_STREAM	0x0001
312f8829a4aSRandall Stewart #define SCTP_CAUSE_MISSING_PARAM	0x0002
313f8829a4aSRandall Stewart #define SCTP_CAUSE_STALE_COOKIE		0x0003
314f8829a4aSRandall Stewart #define SCTP_CAUSE_OUT_OF_RESC		0x0004
315f8829a4aSRandall Stewart #define SCTP_CAUSE_UNRESOLVABLE_ADDR	0x0005
316f8829a4aSRandall Stewart #define SCTP_CAUSE_UNRECOG_CHUNK	0x0006
317f8829a4aSRandall Stewart #define SCTP_CAUSE_INVALID_PARAM	0x0007
318f8829a4aSRandall Stewart #define SCTP_CAUSE_UNRECOG_PARAM	0x0008
319f8829a4aSRandall Stewart #define SCTP_CAUSE_NO_USER_DATA		0x0009
320f8829a4aSRandall Stewart #define SCTP_CAUSE_COOKIE_IN_SHUTDOWN	0x000a
321f8829a4aSRandall Stewart #define SCTP_CAUSE_RESTART_W_NEWADDR	0x000b
322f8829a4aSRandall Stewart #define SCTP_CAUSE_USER_INITIATED_ABT	0x000c
323f8829a4aSRandall Stewart #define SCTP_CAUSE_PROTOCOL_VIOLATION	0x000d
324f8829a4aSRandall Stewart 
3253232788eSRandall Stewart /* Error causes from RFC5061 */
326830d754dSRandall Stewart #define SCTP_CAUSE_DELETING_LAST_ADDR	0x00a0
327830d754dSRandall Stewart #define SCTP_CAUSE_RESOURCE_SHORTAGE	0x00a1
328830d754dSRandall Stewart #define SCTP_CAUSE_DELETING_SRC_ADDR	0x00a2
329830d754dSRandall Stewart #define SCTP_CAUSE_ILLEGAL_ASCONF_ACK	0x00a3
330830d754dSRandall Stewart #define SCTP_CAUSE_REQUEST_REFUSED	0x00a4
331830d754dSRandall Stewart 
332830d754dSRandall Stewart /* Error causes from nat-draft */
333830d754dSRandall Stewart #define SCTP_CAUSE_NAT_COLLIDING_STATE  0x00b0
334830d754dSRandall Stewart #define SCTP_CAUSE_NAT_MISSING_STATE    0x00b1
335f8829a4aSRandall Stewart 
3363232788eSRandall Stewart /* Error causes from RFC4895 */
337f8829a4aSRandall Stewart #define SCTP_CAUSE_UNSUPPORTED_HMACID	0x0105
338f8829a4aSRandall Stewart 
339f8829a4aSRandall Stewart /*
340b1ce21c6SRebecca Cran  * error cause parameters (user visible)
341f8829a4aSRandall Stewart  */
342f8829a4aSRandall Stewart struct sctp_error_cause {
343f8829a4aSRandall Stewart 	uint16_t code;
344f8829a4aSRandall Stewart 	uint16_t length;
345f8829a4aSRandall Stewart 	/* optional cause-specific info may follow */
346b3f1ea41SRandall Stewart }                SCTP_PACKED;
347f8829a4aSRandall Stewart 
348f8829a4aSRandall Stewart struct sctp_error_invalid_stream {
349b3f1ea41SRandall Stewart 	struct sctp_error_cause cause;	/* code=SCTP_ERROR_INVALID_STREAM */
350f8829a4aSRandall Stewart 	uint16_t stream_id;	/* stream id of the DATA in error */
351f8829a4aSRandall Stewart 	uint16_t reserved;
352b3f1ea41SRandall Stewart }                         SCTP_PACKED;
353f8829a4aSRandall Stewart 
354f8829a4aSRandall Stewart struct sctp_error_missing_param {
355b3f1ea41SRandall Stewart 	struct sctp_error_cause cause;	/* code=SCTP_ERROR_MISSING_PARAM */
356b3f1ea41SRandall Stewart 	uint32_t num_missing_params;	/* number of missing parameters */
357f8829a4aSRandall Stewart 	/* uint16_t param_type's follow */
358b3f1ea41SRandall Stewart }                        SCTP_PACKED;
359f8829a4aSRandall Stewart 
360f8829a4aSRandall Stewart struct sctp_error_stale_cookie {
361b3f1ea41SRandall Stewart 	struct sctp_error_cause cause;	/* code=SCTP_ERROR_STALE_COOKIE */
362f8829a4aSRandall Stewart 	uint32_t stale_time;	/* time in usec of staleness */
363b3f1ea41SRandall Stewart }                       SCTP_PACKED;
364f8829a4aSRandall Stewart 
365f8829a4aSRandall Stewart struct sctp_error_out_of_resource {
366b3f1ea41SRandall Stewart 	struct sctp_error_cause cause;	/* code=SCTP_ERROR_OUT_OF_RESOURCES */
367b3f1ea41SRandall Stewart }                          SCTP_PACKED;
368f8829a4aSRandall Stewart 
369f8829a4aSRandall Stewart struct sctp_error_unresolv_addr {
370b3f1ea41SRandall Stewart 	struct sctp_error_cause cause;	/* code=SCTP_ERROR_UNRESOLVABLE_ADDR */
371f8829a4aSRandall Stewart 
372b3f1ea41SRandall Stewart }                        SCTP_PACKED;
373f8829a4aSRandall Stewart 
374f8829a4aSRandall Stewart struct sctp_error_unrecognized_chunk {
375b3f1ea41SRandall Stewart 	struct sctp_error_cause cause;	/* code=SCTP_ERROR_UNRECOG_CHUNK */
376f8829a4aSRandall Stewart 	struct sctp_chunkhdr ch;/* header from chunk in error */
377b3f1ea41SRandall Stewart }                             SCTP_PACKED;
378f8829a4aSRandall Stewart 
379f8829a4aSRandall Stewart /*
380f8829a4aSRandall Stewart  * Main SCTP chunk types we place these here so natd and f/w's in user land
381f8829a4aSRandall Stewart  * can find them.
382f8829a4aSRandall Stewart  */
383f8829a4aSRandall Stewart /************0x00 series ***********/
384f8829a4aSRandall Stewart #define SCTP_DATA		0x00
385f8829a4aSRandall Stewart #define SCTP_INITIATION		0x01
386f8829a4aSRandall Stewart #define SCTP_INITIATION_ACK	0x02
387f8829a4aSRandall Stewart #define SCTP_SELECTIVE_ACK	0x03
388f8829a4aSRandall Stewart #define SCTP_HEARTBEAT_REQUEST	0x04
389f8829a4aSRandall Stewart #define SCTP_HEARTBEAT_ACK	0x05
390f8829a4aSRandall Stewart #define SCTP_ABORT_ASSOCIATION	0x06
391f8829a4aSRandall Stewart #define SCTP_SHUTDOWN		0x07
392f8829a4aSRandall Stewart #define SCTP_SHUTDOWN_ACK	0x08
393f8829a4aSRandall Stewart #define SCTP_OPERATION_ERROR	0x09
394f8829a4aSRandall Stewart #define SCTP_COOKIE_ECHO	0x0a
395f8829a4aSRandall Stewart #define SCTP_COOKIE_ACK		0x0b
396f8829a4aSRandall Stewart #define SCTP_ECN_ECHO		0x0c
397f8829a4aSRandall Stewart #define SCTP_ECN_CWR		0x0d
398f8829a4aSRandall Stewart #define SCTP_SHUTDOWN_COMPLETE	0x0e
3993232788eSRandall Stewart /* RFC4895 */
400f8829a4aSRandall Stewart #define SCTP_AUTHENTICATION     0x0f
401830d754dSRandall Stewart /* EY nr_sack chunk id*/
402830d754dSRandall Stewart #define SCTP_NR_SELECTIVE_ACK 0x10
403f8829a4aSRandall Stewart /************0x40 series ***********/
404f8829a4aSRandall Stewart /************0x80 series ***********/
4053232788eSRandall Stewart /* RFC5061 */
406f8829a4aSRandall Stewart #define	SCTP_ASCONF_ACK		0x80
407f8829a4aSRandall Stewart /* draft-ietf-stewart-pktdrpsctp */
408f8829a4aSRandall Stewart #define SCTP_PACKET_DROPPED	0x81
409f8829a4aSRandall Stewart /* draft-ietf-stewart-strreset-xxx */
410f8829a4aSRandall Stewart #define SCTP_STREAM_RESET       0x82
4119a972525SRandall Stewart 
4129a972525SRandall Stewart /* RFC4820                         */
4139a972525SRandall Stewart #define SCTP_PAD_CHUNK          0x84
414f8829a4aSRandall Stewart /************0xc0 series ***********/
415f8829a4aSRandall Stewart /* RFC3758 */
416f8829a4aSRandall Stewart #define SCTP_FORWARD_CUM_TSN	0xc0
4173232788eSRandall Stewart /* RFC5061 */
418f8829a4aSRandall Stewart #define SCTP_ASCONF		0xc1
419f8829a4aSRandall Stewart 
420f8829a4aSRandall Stewart 
421f8829a4aSRandall Stewart /* ABORT and SHUTDOWN COMPLETE FLAG */
422f8829a4aSRandall Stewart #define SCTP_HAD_NO_TCB		0x01
423f8829a4aSRandall Stewart 
424f8829a4aSRandall Stewart /* Packet dropped flags */
425f8829a4aSRandall Stewart #define SCTP_FROM_MIDDLE_BOX	SCTP_HAD_NO_TCB
426f8829a4aSRandall Stewart #define SCTP_BADCRC		0x02
427f8829a4aSRandall Stewart #define SCTP_PACKET_TRUNCATED	0x04
428f8829a4aSRandall Stewart 
429a21779f0SRandall Stewart /* Flag for ECN -CWR */
430a21779f0SRandall Stewart #define SCTP_CWR_REDUCE_OVERRIDE 0x01
431a21779f0SRandall Stewart #define SCTP_CWR_IN_SAME_WINDOW  0x02
432a21779f0SRandall Stewart 
433f8829a4aSRandall Stewart #define SCTP_SAT_NETWORK_MIN	400	/* min ms for RTT to set satellite
434f8829a4aSRandall Stewart 					 * time */
435f8829a4aSRandall Stewart #define SCTP_SAT_NETWORK_BURST_INCR  2	/* how many times to multiply maxburst
436f8829a4aSRandall Stewart 					 * in sat */
437f8829a4aSRandall Stewart 
438f8829a4aSRandall Stewart /* Data Chuck Specific Flags */
439f8829a4aSRandall Stewart #define SCTP_DATA_FRAG_MASK        0x03
440f8829a4aSRandall Stewart #define SCTP_DATA_MIDDLE_FRAG      0x00
441f8829a4aSRandall Stewart #define SCTP_DATA_LAST_FRAG        0x01
442f8829a4aSRandall Stewart #define SCTP_DATA_FIRST_FRAG       0x02
443f8829a4aSRandall Stewart #define SCTP_DATA_NOT_FRAG         0x03
444f8829a4aSRandall Stewart #define SCTP_DATA_UNORDERED        0x04
445b3f1ea41SRandall Stewart #define SCTP_DATA_SACK_IMMEDIATELY 0x08
446f8829a4aSRandall Stewart /* ECN Nonce: SACK Chunk Specific Flags */
447f8829a4aSRandall Stewart #define SCTP_SACK_NONCE_SUM        0x01
448f8829a4aSRandall Stewart 
449f8829a4aSRandall Stewart /* CMT DAC algorithm SACK flag */
450f8829a4aSRandall Stewart #define SCTP_SACK_CMT_DAC          0x80
451f8829a4aSRandall Stewart 
45258967d8dSRandall Stewart /*
45358967d8dSRandall Stewart  * PCB flags (in sctp_flags bitmask).
45458967d8dSRandall Stewart  * Note the features and flags are meant
45558967d8dSRandall Stewart  * for use by netstat.
45658967d8dSRandall Stewart  */
45758967d8dSRandall Stewart #define SCTP_PCB_FLAGS_UDPTYPE		0x00000001
45858967d8dSRandall Stewart #define SCTP_PCB_FLAGS_TCPTYPE		0x00000002
45958967d8dSRandall Stewart #define SCTP_PCB_FLAGS_BOUNDALL		0x00000004
46058967d8dSRandall Stewart #define SCTP_PCB_FLAGS_ACCEPTING	0x00000008
46158967d8dSRandall Stewart #define SCTP_PCB_FLAGS_UNBOUND		0x00000010
46258967d8dSRandall Stewart #define SCTP_PCB_FLAGS_CLOSE_IP         0x00040000
46358967d8dSRandall Stewart #define SCTP_PCB_FLAGS_WAS_CONNECTED    0x00080000
46458967d8dSRandall Stewart #define SCTP_PCB_FLAGS_WAS_ABORTED      0x00100000
46558967d8dSRandall Stewart /* TCP model support */
46658967d8dSRandall Stewart 
46758967d8dSRandall Stewart #define SCTP_PCB_FLAGS_CONNECTED	0x00200000
46858967d8dSRandall Stewart #define SCTP_PCB_FLAGS_IN_TCPPOOL	0x00400000
46958967d8dSRandall Stewart #define SCTP_PCB_FLAGS_DONT_WAKE	0x00800000
47058967d8dSRandall Stewart #define SCTP_PCB_FLAGS_WAKEOUTPUT	0x01000000
47158967d8dSRandall Stewart #define SCTP_PCB_FLAGS_WAKEINPUT	0x02000000
47258967d8dSRandall Stewart #define SCTP_PCB_FLAGS_BOUND_V6		0x04000000
473bfefd190SRandall Stewart #define SCTP_PCB_FLAGS_BLOCKING_IO	0x08000000
474bfefd190SRandall Stewart #define SCTP_PCB_FLAGS_SOCKET_GONE	0x10000000
475bfefd190SRandall Stewart #define SCTP_PCB_FLAGS_SOCKET_ALLGONE	0x20000000
476cd1386abSMichael Tuexen #define SCTP_PCB_FLAGS_SOCKET_CANT_READ	0x40000000
47758967d8dSRandall Stewart /* flags to copy to new PCB */
478bfefd190SRandall Stewart #define SCTP_PCB_COPY_FLAGS		(SCTP_PCB_FLAGS_BOUNDALL|\
479bfefd190SRandall Stewart 					 SCTP_PCB_FLAGS_WAKEINPUT|\
480bfefd190SRandall Stewart 					 SCTP_PCB_FLAGS_BOUND_V6)
48158967d8dSRandall Stewart 
48258967d8dSRandall Stewart 
48358967d8dSRandall Stewart /*
48458967d8dSRandall Stewart  * PCB Features (in sctp_features bitmask)
48558967d8dSRandall Stewart  */
48658967d8dSRandall Stewart #define SCTP_PCB_FLAGS_EXT_RCVINFO      0x00000002
48758967d8dSRandall Stewart #define SCTP_PCB_FLAGS_DONOT_HEARTBEAT  0x00000004
48858967d8dSRandall Stewart #define SCTP_PCB_FLAGS_FRAG_INTERLEAVE  0x00000008
48958967d8dSRandall Stewart #define SCTP_PCB_FLAGS_INTERLEAVE_STRMS	0x00000010
49058967d8dSRandall Stewart #define SCTP_PCB_FLAGS_DO_ASCONF	0x00000020
49158967d8dSRandall Stewart #define SCTP_PCB_FLAGS_AUTO_ASCONF	0x00000040
49217205eccSRandall Stewart #define SCTP_PCB_FLAGS_ZERO_COPY_ACTIVE 0x00000080
49358967d8dSRandall Stewart /* socket options */
49458967d8dSRandall Stewart #define SCTP_PCB_FLAGS_NODELAY		0x00000100
49558967d8dSRandall Stewart #define SCTP_PCB_FLAGS_AUTOCLOSE	0x00000200
49658967d8dSRandall Stewart #define SCTP_PCB_FLAGS_RECVDATAIOEVNT	0x00000400
49758967d8dSRandall Stewart #define SCTP_PCB_FLAGS_RECVASSOCEVNT	0x00000800
49858967d8dSRandall Stewart #define SCTP_PCB_FLAGS_RECVPADDREVNT	0x00001000
49958967d8dSRandall Stewart #define SCTP_PCB_FLAGS_RECVPEERERR	0x00002000
50058967d8dSRandall Stewart #define SCTP_PCB_FLAGS_RECVSENDFAILEVNT	0x00004000
50158967d8dSRandall Stewart #define SCTP_PCB_FLAGS_RECVSHUTDOWNEVNT	0x00008000
50258967d8dSRandall Stewart #define SCTP_PCB_FLAGS_ADAPTATIONEVNT	0x00010000
50358967d8dSRandall Stewart #define SCTP_PCB_FLAGS_PDAPIEVNT	0x00020000
50458967d8dSRandall Stewart #define SCTP_PCB_FLAGS_AUTHEVNT		0x00040000
50558967d8dSRandall Stewart #define SCTP_PCB_FLAGS_STREAM_RESETEVNT 0x00080000
50658967d8dSRandall Stewart #define SCTP_PCB_FLAGS_NO_FRAGMENT	0x00100000
50758967d8dSRandall Stewart #define SCTP_PCB_FLAGS_EXPLICIT_EOR     0x00400000
508bfefd190SRandall Stewart #define SCTP_PCB_FLAGS_NEEDS_MAPPED_V4	0x00800000
509c54a18d2SRandall Stewart #define SCTP_PCB_FLAGS_MULTIPLE_ASCONFS	0x01000000
5106d9e8f2bSRandall Stewart #define SCTP_PCB_FLAGS_PORTREUSE        0x02000000
511830d754dSRandall Stewart #define SCTP_PCB_FLAGS_DRYEVNT          0x04000000
5122afb3e84SRandall Stewart /*-
5132afb3e84SRandall Stewart  * mobility_features parameters (by micchie).Note
5142afb3e84SRandall Stewart  * these features are applied against the
5152afb3e84SRandall Stewart  * sctp_mobility_features flags.. not the sctp_features
5162afb3e84SRandall Stewart  * flags.
5172afb3e84SRandall Stewart  */
5182afb3e84SRandall Stewart #define SCTP_MOBILITY_BASE		0x00000001
5192afb3e84SRandall Stewart #define SCTP_MOBILITY_FASTHANDOFF	0x00000002
520851b7298SRandall Stewart #define SCTP_MOBILITY_PRIM_DELETED	0x00000004
5212afb3e84SRandall Stewart 
5222afb3e84SRandall Stewart 
523d61a0ae0SRandall Stewart #define SCTP_SMALLEST_PMTU 512	/* smallest pmtu allowed when disabling PMTU
524d61a0ae0SRandall Stewart 				 * discovery */
525d61a0ae0SRandall Stewart 
526f8829a4aSRandall Stewart #include <netinet/sctp_uio.h>
527f8829a4aSRandall Stewart 
52880fefe0aSRandall Stewart /* This dictates the size of the packet
52980fefe0aSRandall Stewart  * collection buffer. This only applies
53080fefe0aSRandall Stewart  * if SCTP_PACKET_LOGGING is enabled in
53180fefe0aSRandall Stewart  * your config.
53280fefe0aSRandall Stewart  */
533207304d4SRandall Stewart #define SCTP_PACKET_LOG_SIZE 65536
534207304d4SRandall Stewart 
53518e198d3SRandall Stewart /* Maximum delays and such a user can set for options that
53618e198d3SRandall Stewart  * take ms.
53718e198d3SRandall Stewart  */
53818e198d3SRandall Stewart #define SCTP_MAX_SACK_DELAY 500	/* per RFC4960 */
53918e198d3SRandall Stewart #define SCTP_MAX_HB_INTERVAL 14400000	/* 4 hours in ms */
54018e198d3SRandall Stewart #define SCTP_MAX_COOKIE_LIFE  3600000	/* 1 hour in ms */
54118e198d3SRandall Stewart 
54218e198d3SRandall Stewart 
54380fefe0aSRandall Stewart /* Types of logging/KTR tracing  that can be enabled via the
54480fefe0aSRandall Stewart  * sysctl net.inet.sctp.sctp_logging. You must also enable
54580fefe0aSRandall Stewart  * SUBSYS tracing.
54680fefe0aSRandall Stewart  * Note that you must have the SCTP option in the kernel
54780fefe0aSRandall Stewart  * to enable these as well.
54880fefe0aSRandall Stewart  */
54980fefe0aSRandall Stewart #define SCTP_BLK_LOGGING_ENABLE				0x00000001
55080fefe0aSRandall Stewart #define SCTP_CWND_MONITOR_ENABLE			0x00000002
55180fefe0aSRandall Stewart #define SCTP_CWND_LOGGING_ENABLE			0x00000004
55280fefe0aSRandall Stewart #define SCTP_EARLYFR_LOGGING_ENABLE			0x00000010
55380fefe0aSRandall Stewart #define SCTP_FLIGHT_LOGGING_ENABLE			0x00000020
55480fefe0aSRandall Stewart #define SCTP_FR_LOGGING_ENABLE				0x00000040
55580fefe0aSRandall Stewart #define SCTP_LOCK_LOGGING_ENABLE			0x00000080
55680fefe0aSRandall Stewart #define SCTP_MAP_LOGGING_ENABLE				0x00000100
55780fefe0aSRandall Stewart #define SCTP_MBCNT_LOGGING_ENABLE			0x00000200
55880fefe0aSRandall Stewart #define SCTP_MBUF_LOGGING_ENABLE			0x00000400
55980fefe0aSRandall Stewart #define SCTP_NAGLE_LOGGING_ENABLE			0x00000800
56080fefe0aSRandall Stewart #define SCTP_RECV_RWND_LOGGING_ENABLE		0x00001000
56180fefe0aSRandall Stewart #define SCTP_RTTVAR_LOGGING_ENABLE			0x00002000
56280fefe0aSRandall Stewart #define SCTP_SACK_LOGGING_ENABLE			0x00004000
56380fefe0aSRandall Stewart #define SCTP_SACK_RWND_LOGGING_ENABLE		0x00008000
56480fefe0aSRandall Stewart #define SCTP_SB_LOGGING_ENABLE				0x00010000
56580fefe0aSRandall Stewart #define SCTP_STR_LOGGING_ENABLE				0x00020000
56680fefe0aSRandall Stewart #define SCTP_WAKE_LOGGING_ENABLE			0x00040000
56780fefe0aSRandall Stewart #define SCTP_LOG_MAXBURST_ENABLE			0x00080000
56880fefe0aSRandall Stewart #define SCTP_LOG_RWND_ENABLE    			0x00100000
56980fefe0aSRandall Stewart #define SCTP_LOG_SACK_ARRIVALS_ENABLE       0x00200000
57080fefe0aSRandall Stewart #define SCTP_LTRACE_CHUNK_ENABLE            0x00400000
57180fefe0aSRandall Stewart #define SCTP_LTRACE_ERROR_ENABLE            0x00800000
572d95ddf02SRandall Stewart #define SCTP_LAST_PACKET_TRACING            0x01000000
573c4739e2fSRandall Stewart #define SCTP_THRESHOLD_LOGGING              0x02000000
5749f22f500SRandall Stewart #define SCTP_LOG_AT_SEND_2_SCTP             0x04000000
5759f22f500SRandall Stewart #define SCTP_LOG_AT_SEND_2_OUTQ             0x08000000
5760c0982b8SRandall Stewart #define SCTP_LOG_TRY_ADVANCE                0x10000000
577207304d4SRandall Stewart 
5782afb3e84SRandall Stewart 
579b3f1ea41SRandall Stewart #undef SCTP_PACKED
580b3f1ea41SRandall Stewart 
581f8829a4aSRandall Stewart #endif				/* !_NETINET_SCTP_H_ */
582