xref: /freebsd/sys/netinet/sctp.h (revision 6d9e8f2b)
1f8829a4aSRandall Stewart /*-
2b1006367SRandall Stewart  * Copyright (c) 2001-2007, 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 */
111f8829a4aSRandall Stewart /* explict EOR signalling */
112f8829a4aSRandall Stewart #define SCTP_EXPLICIT_EOR               0x0000001b
1136d9e8f2bSRandall Stewart #define SCTP_REUSE_PORT                 0x0000001c	/* rw */
114f8829a4aSRandall Stewart 
115f8829a4aSRandall Stewart /*
116f8829a4aSRandall Stewart  * read-only options
117f8829a4aSRandall Stewart  */
118f8829a4aSRandall Stewart #define SCTP_STATUS			0x00000100
119f8829a4aSRandall Stewart #define SCTP_GET_PEER_ADDR_INFO		0x00000101
120f8829a4aSRandall Stewart /* authentication support */
121f8829a4aSRandall Stewart #define SCTP_PEER_AUTH_CHUNKS 		0x00000102
122f8829a4aSRandall Stewart #define SCTP_LOCAL_AUTH_CHUNKS 		0x00000103
1233c503c28SRandall Stewart #define SCTP_GET_ASSOC_NUMBER           0x00000104	/* ro */
1243c503c28SRandall Stewart #define SCTP_GET_ASSOC_ID_LIST          0x00000105	/* ro */
125f8829a4aSRandall Stewart 
126f8829a4aSRandall Stewart /*
127f8829a4aSRandall Stewart  * user socket options: BSD implementation specific
128f8829a4aSRandall Stewart  */
129f8829a4aSRandall Stewart /*
130f8829a4aSRandall Stewart  * Blocking I/O is enabled on any TCP type socket by default. For the UDP
131f8829a4aSRandall Stewart  * model if this is turned on then the socket buffer is shared for send
132f8829a4aSRandall Stewart  * resources amongst all associations.  The default for the UDP model is that
133f8829a4aSRandall Stewart  * is SS_NBIO is set.  Which means all associations have a seperate send
134f8829a4aSRandall Stewart  * limit BUT they will NOT ever BLOCK instead you will get an error back
135f8829a4aSRandall Stewart  * EAGAIN if you try to send to much. If you want the blocking symantics you
136f8829a4aSRandall Stewart  * set this option at the cost of sharing one socket send buffer size amongst
137f8829a4aSRandall Stewart  * all associations. Peeled off sockets turn this option off and block. But
138f8829a4aSRandall Stewart  * since both TCP and peeled off sockets have only one assoc per socket this
139f8829a4aSRandall Stewart  * is fine. It probably does NOT make sense to set this on SS_NBIO on a TCP
140f8829a4aSRandall Stewart  * model OR peeled off UDP model, but we do allow you to do so. You just use
141f8829a4aSRandall Stewart  * the normal syscall to toggle SS_NBIO the way you want.
142f8829a4aSRandall Stewart  *
143f8829a4aSRandall Stewart  * Blocking I/O is controled by the SS_NBIO flag on the socket state so_state
144f8829a4aSRandall Stewart  * field.
145f8829a4aSRandall Stewart  */
146f8829a4aSRandall Stewart 
147f8829a4aSRandall Stewart /* these should probably go into sockets API */
148f8829a4aSRandall Stewart #define SCTP_RESET_STREAMS		0x00001004	/* wo */
149f8829a4aSRandall Stewart 
150f8829a4aSRandall Stewart 
151f8829a4aSRandall Stewart /* here on down are more implementation specific */
152f8829a4aSRandall Stewart #define SCTP_SET_DEBUG_LEVEL		0x00001005
153f8829a4aSRandall Stewart #define SCTP_CLR_STAT_LOG               0x00001007
154f8829a4aSRandall Stewart /* CMT ON/OFF socket option */
155f8829a4aSRandall Stewart #define SCTP_CMT_ON_OFF                 0x00001200
156f8829a4aSRandall Stewart #define SCTP_CMT_USE_DAC                0x00001201
157b54d3a6cSRandall Stewart /* JRS - Pluggable Congestion Control Socket option */
158b54d3a6cSRandall Stewart #define SCTP_PLUGGABLE_CC				0x00001202
159f8829a4aSRandall Stewart 
160f8829a4aSRandall Stewart /* read only */
161f8829a4aSRandall Stewart #define SCTP_GET_SNDBUF_USE		0x00001101
162f8829a4aSRandall Stewart #define SCTP_GET_STAT_LOG		0x00001103
1633c503c28SRandall Stewart #define SCTP_PCB_STATUS			0x00001104
1643c503c28SRandall Stewart #define SCTP_GET_NONCE_VALUES           0x00001105
165f8829a4aSRandall Stewart 
166207304d4SRandall Stewart 
16742551e99SRandall Stewart /* Special hook for dynamically setting primary for all assoc's,
16842551e99SRandall Stewart  * this is a write only option that requires root privledge.
16942551e99SRandall Stewart  */
17042551e99SRandall Stewart #define SCTP_SET_DYNAMIC_PRIMARY        0x00002001
171f8829a4aSRandall Stewart 
17242551e99SRandall Stewart /* VRF (virtual router feature) and multi-VRF support
17342551e99SRandall Stewart  * options. VRF's provide splits within a router
17442551e99SRandall Stewart  * that give the views of multiple routers. A
17542551e99SRandall Stewart  * standard host, without VRF support, is just
17642551e99SRandall Stewart  * a single VRF. If VRF's are supported then
17742551e99SRandall Stewart  * the transport must be VRF aware. This means
17842551e99SRandall Stewart  * that every socket call coming in must be directed
17942551e99SRandall Stewart  * within the endpoint to one of the VRF's it belongs
18042551e99SRandall Stewart  * to. The endpoint, before binding, may select
18142551e99SRandall Stewart  * the "default" VRF it is in by using a set socket
18242551e99SRandall Stewart  * option with SCTP_VRF_ID. This will also
18342551e99SRandall Stewart  * get propegated to the default VRF. Once the
18442551e99SRandall Stewart  * endpoint binds an address then it CANNOT add
18542551e99SRandall Stewart  * additional VRF's to become a Multi-VRF endpoint.
18642551e99SRandall Stewart  *
18742551e99SRandall Stewart  * Before BINDING additional VRF's can be added with
18842551e99SRandall Stewart  * the SCTP_ADD_VRF_ID call or deleted with
18942551e99SRandall Stewart  * SCTP_DEL_VRF_ID.
19042551e99SRandall Stewart  *
19142551e99SRandall Stewart  * Associations are ALWAYS contained inside a single
19242551e99SRandall Stewart  * VRF. They cannot reside in two (or more) VRF's. Incoming
19342551e99SRandall Stewart  * packets, assuming the router is VRF aware, can always
19442551e99SRandall Stewart  * tell us what VRF they arrived on. A host not supporting
19542551e99SRandall Stewart  * any VRF's will find that the packets always arrived on the
19642551e99SRandall Stewart  * single VRF that the host has.
19742551e99SRandall Stewart  *
19842551e99SRandall Stewart  */
19942551e99SRandall Stewart 
20042551e99SRandall Stewart #define SCTP_VRF_ID			0x00003001
20142551e99SRandall Stewart #define SCTP_ADD_VRF_ID			0x00003002
20242551e99SRandall Stewart #define SCTP_GET_VRF_IDS		0x00003003
20342551e99SRandall Stewart #define SCTP_GET_ASOC_VRF               0x00003004
20442551e99SRandall Stewart #define SCTP_DEL_VRF_ID                 0x00003005
205207304d4SRandall Stewart 
206207304d4SRandall Stewart /*
207207304d4SRandall Stewart  * If you enable packet logging you can get
208207304d4SRandall Stewart  * a poor mans ethereal output in binary
209207304d4SRandall Stewart  * form. Note this is a compile option to
210207304d4SRandall Stewart  * the kernel,  SCTP_PACKET_LOGGING, and
211207304d4SRandall Stewart  * without it in your kernel you
2126b4ae356SRandall Stewart  * will get a EOPNOTSUPP
213207304d4SRandall Stewart  */
214207304d4SRandall Stewart #define SCTP_GET_PACKET_LOG             0x00004001
215207304d4SRandall Stewart 
216f8829a4aSRandall Stewart /*
217f8829a4aSRandall Stewart  * hidden implementation specific options these are NOT user visible (should
218f8829a4aSRandall Stewart  * move out of sctp.h)
219f8829a4aSRandall Stewart  */
220f8829a4aSRandall Stewart /* sctp_bindx() flags as hidden socket options */
221f8829a4aSRandall Stewart #define SCTP_BINDX_ADD_ADDR		0x00008001
222f8829a4aSRandall Stewart #define SCTP_BINDX_REM_ADDR		0x00008002
223f8829a4aSRandall Stewart /* Hidden socket option that gets the addresses */
224f8829a4aSRandall Stewart #define SCTP_GET_PEER_ADDRESSES		0x00008003
225f8829a4aSRandall Stewart #define SCTP_GET_LOCAL_ADDRESSES	0x00008004
226f8829a4aSRandall Stewart /* return the total count in bytes needed to hold all local addresses bound */
227f8829a4aSRandall Stewart #define SCTP_GET_LOCAL_ADDR_SIZE	0x00008005
228f8829a4aSRandall Stewart /* Return the total count in bytes needed to hold the remote address */
229f8829a4aSRandall Stewart #define SCTP_GET_REMOTE_ADDR_SIZE	0x00008006
230f8829a4aSRandall Stewart /* hidden option for connectx */
231f8829a4aSRandall Stewart #define SCTP_CONNECT_X			0x00008007
232f8829a4aSRandall Stewart /* hidden option for connectx_delayed, part of sendx */
233f8829a4aSRandall Stewart #define SCTP_CONNECT_X_DELAYED		0x00008008
234f8829a4aSRandall Stewart #define SCTP_CONNECT_X_COMPLETE         0x00008009
235f8829a4aSRandall Stewart /* hidden socket option based sctp_peeloff */
236f8829a4aSRandall Stewart #define SCTP_PEELOFF                    0x0000800a
237f8829a4aSRandall Stewart /* the real worker for sctp_getaddrlen() */
238f8829a4aSRandall Stewart #define SCTP_GET_ADDR_LEN               0x0000800b
239f8829a4aSRandall Stewart /* temporary workaround for Apple listen() issue, no args used */
240f8829a4aSRandall Stewart #define SCTP_LISTEN_FIX			0x0000800c
241f8829a4aSRandall Stewart /* Debug things that need to be purged */
242f8829a4aSRandall Stewart #define SCTP_SET_INITIAL_DBG_SEQ	0x00009f00
243f8829a4aSRandall Stewart 
244b54d3a6cSRandall Stewart /* JRS - Supported congestion control modules for pluggable
245b54d3a6cSRandall Stewart  * congestion control
246b54d3a6cSRandall Stewart  */
247b54d3a6cSRandall Stewart /* Standard TCP Congestion Control */
248b54d3a6cSRandall Stewart #define SCTP_CC_RFC2581		0x00000000
249b54d3a6cSRandall Stewart /* High Speed TCP Congestion Control (Floyd) */
250b54d3a6cSRandall Stewart #define SCTP_CC_HSTCP		0x00000001
251b54d3a6cSRandall Stewart /* HTCP Congestion Control */
252b54d3a6cSRandall Stewart #define SCTP_CC_HTCP		0x00000002
253b54d3a6cSRandall Stewart 
2549a6142d8SRandall Stewart 
2559a6142d8SRandall Stewart /* fragment interleave constants
2569a6142d8SRandall Stewart  * setting must be one of these or
2579a6142d8SRandall Stewart  * EINVAL returned.
2589a6142d8SRandall Stewart  */
2599a6142d8SRandall Stewart #define SCTP_FRAG_LEVEL_0    0x00000000
2609a6142d8SRandall Stewart #define SCTP_FRAG_LEVEL_1    0x00000001
2619a6142d8SRandall Stewart #define SCTP_FRAG_LEVEL_2    0x00000002
2629a6142d8SRandall Stewart 
263f8829a4aSRandall Stewart /*
264f8829a4aSRandall Stewart  * user state values
265f8829a4aSRandall Stewart  */
266f8829a4aSRandall Stewart #define SCTP_CLOSED			0x0000
267f8829a4aSRandall Stewart #define SCTP_BOUND			0x1000
268f8829a4aSRandall Stewart #define SCTP_LISTEN			0x2000
269f8829a4aSRandall Stewart #define SCTP_COOKIE_WAIT		0x0002
270f8829a4aSRandall Stewart #define SCTP_COOKIE_ECHOED		0x0004
271f8829a4aSRandall Stewart #define SCTP_ESTABLISHED		0x0008
272f8829a4aSRandall Stewart #define SCTP_SHUTDOWN_SENT		0x0010
273f8829a4aSRandall Stewart #define SCTP_SHUTDOWN_RECEIVED		0x0020
274f8829a4aSRandall Stewart #define SCTP_SHUTDOWN_ACK_SENT		0x0040
275f8829a4aSRandall Stewart #define SCTP_SHUTDOWN_PENDING		0x0080
276f8829a4aSRandall Stewart 
277f8829a4aSRandall Stewart /*
278f8829a4aSRandall Stewart  * SCTP operational error codes (user visible)
279f8829a4aSRandall Stewart  */
280f8829a4aSRandall Stewart #define SCTP_CAUSE_NO_ERROR		0x0000
281f8829a4aSRandall Stewart #define SCTP_CAUSE_INVALID_STREAM	0x0001
282f8829a4aSRandall Stewart #define SCTP_CAUSE_MISSING_PARAM	0x0002
283f8829a4aSRandall Stewart #define SCTP_CAUSE_STALE_COOKIE		0x0003
284f8829a4aSRandall Stewart #define SCTP_CAUSE_OUT_OF_RESC		0x0004
285f8829a4aSRandall Stewart #define SCTP_CAUSE_UNRESOLVABLE_ADDR	0x0005
286f8829a4aSRandall Stewart #define SCTP_CAUSE_UNRECOG_CHUNK	0x0006
287f8829a4aSRandall Stewart #define SCTP_CAUSE_INVALID_PARAM	0x0007
288f8829a4aSRandall Stewart #define SCTP_CAUSE_UNRECOG_PARAM	0x0008
289f8829a4aSRandall Stewart #define SCTP_CAUSE_NO_USER_DATA		0x0009
290f8829a4aSRandall Stewart #define SCTP_CAUSE_COOKIE_IN_SHUTDOWN	0x000a
291f8829a4aSRandall Stewart #define SCTP_CAUSE_RESTART_W_NEWADDR	0x000b
292f8829a4aSRandall Stewart #define SCTP_CAUSE_USER_INITIATED_ABT	0x000c
293f8829a4aSRandall Stewart #define SCTP_CAUSE_PROTOCOL_VIOLATION	0x000d
294f8829a4aSRandall Stewart 
2953232788eSRandall Stewart /* Error causes from RFC5061 */
29618e198d3SRandall Stewart #define SCTP_CAUSE_DELETING_LAST_ADDR	0xa0
29718e198d3SRandall Stewart #define SCTP_CAUSE_RESOURCE_SHORTAGE	0xa1
29818e198d3SRandall Stewart #define SCTP_CAUSE_DELETING_SRC_ADDR	0xa2
29918e198d3SRandall Stewart #define SCTP_CAUSE_ILLEGAL_ASCONF_ACK	0xa3
30018e198d3SRandall Stewart #define SCTP_CAUSE_REQUEST_REFUSED	0xa4
301f8829a4aSRandall Stewart 
3023232788eSRandall Stewart /* Error causes from RFC4895 */
303f8829a4aSRandall Stewart #define SCTP_CAUSE_UNSUPPORTED_HMACID	0x0105
304f8829a4aSRandall Stewart 
305f8829a4aSRandall Stewart /*
306f8829a4aSRandall Stewart  * error cause parameters (user visisble)
307f8829a4aSRandall Stewart  */
308f8829a4aSRandall Stewart struct sctp_error_cause {
309f8829a4aSRandall Stewart 	uint16_t code;
310f8829a4aSRandall Stewart 	uint16_t length;
311f8829a4aSRandall Stewart 	/* optional cause-specific info may follow */
312b3f1ea41SRandall Stewart }                SCTP_PACKED;
313f8829a4aSRandall Stewart 
314f8829a4aSRandall Stewart struct sctp_error_invalid_stream {
315b3f1ea41SRandall Stewart 	struct sctp_error_cause cause;	/* code=SCTP_ERROR_INVALID_STREAM */
316f8829a4aSRandall Stewart 	uint16_t stream_id;	/* stream id of the DATA in error */
317f8829a4aSRandall Stewart 	uint16_t reserved;
318b3f1ea41SRandall Stewart }                         SCTP_PACKED;
319f8829a4aSRandall Stewart 
320f8829a4aSRandall Stewart struct sctp_error_missing_param {
321b3f1ea41SRandall Stewart 	struct sctp_error_cause cause;	/* code=SCTP_ERROR_MISSING_PARAM */
322b3f1ea41SRandall Stewart 	uint32_t num_missing_params;	/* number of missing parameters */
323f8829a4aSRandall Stewart 	/* uint16_t param_type's follow */
324b3f1ea41SRandall Stewart }                        SCTP_PACKED;
325f8829a4aSRandall Stewart 
326f8829a4aSRandall Stewart struct sctp_error_stale_cookie {
327b3f1ea41SRandall Stewart 	struct sctp_error_cause cause;	/* code=SCTP_ERROR_STALE_COOKIE */
328f8829a4aSRandall Stewart 	uint32_t stale_time;	/* time in usec of staleness */
329b3f1ea41SRandall Stewart }                       SCTP_PACKED;
330f8829a4aSRandall Stewart 
331f8829a4aSRandall Stewart struct sctp_error_out_of_resource {
332b3f1ea41SRandall Stewart 	struct sctp_error_cause cause;	/* code=SCTP_ERROR_OUT_OF_RESOURCES */
333b3f1ea41SRandall Stewart }                          SCTP_PACKED;
334f8829a4aSRandall Stewart 
335f8829a4aSRandall Stewart struct sctp_error_unresolv_addr {
336b3f1ea41SRandall Stewart 	struct sctp_error_cause cause;	/* code=SCTP_ERROR_UNRESOLVABLE_ADDR */
337f8829a4aSRandall Stewart 
338b3f1ea41SRandall Stewart }                        SCTP_PACKED;
339f8829a4aSRandall Stewart 
340f8829a4aSRandall Stewart struct sctp_error_unrecognized_chunk {
341b3f1ea41SRandall Stewart 	struct sctp_error_cause cause;	/* code=SCTP_ERROR_UNRECOG_CHUNK */
342f8829a4aSRandall Stewart 	struct sctp_chunkhdr ch;/* header from chunk in error */
343b3f1ea41SRandall Stewart }                             SCTP_PACKED;
344f8829a4aSRandall Stewart 
345f8829a4aSRandall Stewart /*
346f8829a4aSRandall Stewart  * Main SCTP chunk types we place these here so natd and f/w's in user land
347f8829a4aSRandall Stewart  * can find them.
348f8829a4aSRandall Stewart  */
349f8829a4aSRandall Stewart /************0x00 series ***********/
350f8829a4aSRandall Stewart #define SCTP_DATA		0x00
351f8829a4aSRandall Stewart #define SCTP_INITIATION		0x01
352f8829a4aSRandall Stewart #define SCTP_INITIATION_ACK	0x02
353f8829a4aSRandall Stewart #define SCTP_SELECTIVE_ACK	0x03
354f8829a4aSRandall Stewart #define SCTP_HEARTBEAT_REQUEST	0x04
355f8829a4aSRandall Stewart #define SCTP_HEARTBEAT_ACK	0x05
356f8829a4aSRandall Stewart #define SCTP_ABORT_ASSOCIATION	0x06
357f8829a4aSRandall Stewart #define SCTP_SHUTDOWN		0x07
358f8829a4aSRandall Stewart #define SCTP_SHUTDOWN_ACK	0x08
359f8829a4aSRandall Stewart #define SCTP_OPERATION_ERROR	0x09
360f8829a4aSRandall Stewart #define SCTP_COOKIE_ECHO	0x0a
361f8829a4aSRandall Stewart #define SCTP_COOKIE_ACK		0x0b
362f8829a4aSRandall Stewart #define SCTP_ECN_ECHO		0x0c
363f8829a4aSRandall Stewart #define SCTP_ECN_CWR		0x0d
364f8829a4aSRandall Stewart #define SCTP_SHUTDOWN_COMPLETE	0x0e
3653232788eSRandall Stewart /* RFC4895 */
366f8829a4aSRandall Stewart #define SCTP_AUTHENTICATION     0x0f
367f8829a4aSRandall Stewart /************0x40 series ***********/
368f8829a4aSRandall Stewart /************0x80 series ***********/
3693232788eSRandall Stewart /* RFC5061 */
370f8829a4aSRandall Stewart #define	SCTP_ASCONF_ACK		0x80
371f8829a4aSRandall Stewart /* draft-ietf-stewart-pktdrpsctp */
372f8829a4aSRandall Stewart #define SCTP_PACKET_DROPPED	0x81
373f8829a4aSRandall Stewart /* draft-ietf-stewart-strreset-xxx */
374f8829a4aSRandall Stewart #define SCTP_STREAM_RESET       0x82
3759a972525SRandall Stewart 
3769a972525SRandall Stewart /* RFC4820                         */
3779a972525SRandall Stewart #define SCTP_PAD_CHUNK          0x84
378f8829a4aSRandall Stewart /************0xc0 series ***********/
379f8829a4aSRandall Stewart /* RFC3758 */
380f8829a4aSRandall Stewart #define SCTP_FORWARD_CUM_TSN	0xc0
3813232788eSRandall Stewart /* RFC5061 */
382f8829a4aSRandall Stewart #define SCTP_ASCONF		0xc1
383f8829a4aSRandall Stewart 
384f8829a4aSRandall Stewart 
385f8829a4aSRandall Stewart /* ABORT and SHUTDOWN COMPLETE FLAG */
386f8829a4aSRandall Stewart #define SCTP_HAD_NO_TCB		0x01
387f8829a4aSRandall Stewart 
388f8829a4aSRandall Stewart /* Packet dropped flags */
389f8829a4aSRandall Stewart #define SCTP_FROM_MIDDLE_BOX	SCTP_HAD_NO_TCB
390f8829a4aSRandall Stewart #define SCTP_BADCRC		0x02
391f8829a4aSRandall Stewart #define SCTP_PACKET_TRUNCATED	0x04
392f8829a4aSRandall Stewart 
393f8829a4aSRandall Stewart #define SCTP_SAT_NETWORK_MIN	400	/* min ms for RTT to set satellite
394f8829a4aSRandall Stewart 					 * time */
395f8829a4aSRandall Stewart #define SCTP_SAT_NETWORK_BURST_INCR  2	/* how many times to multiply maxburst
396f8829a4aSRandall Stewart 					 * in sat */
397f8829a4aSRandall Stewart 
398f8829a4aSRandall Stewart /* Data Chuck Specific Flags */
399f8829a4aSRandall Stewart #define SCTP_DATA_FRAG_MASK        0x03
400f8829a4aSRandall Stewart #define SCTP_DATA_MIDDLE_FRAG      0x00
401f8829a4aSRandall Stewart #define SCTP_DATA_LAST_FRAG        0x01
402f8829a4aSRandall Stewart #define SCTP_DATA_FIRST_FRAG       0x02
403f8829a4aSRandall Stewart #define SCTP_DATA_NOT_FRAG         0x03
404f8829a4aSRandall Stewart #define SCTP_DATA_UNORDERED        0x04
405b3f1ea41SRandall Stewart #define SCTP_DATA_SACK_IMMEDIATELY 0x08
406f8829a4aSRandall Stewart /* ECN Nonce: SACK Chunk Specific Flags */
407f8829a4aSRandall Stewart #define SCTP_SACK_NONCE_SUM        0x01
408f8829a4aSRandall Stewart 
409f8829a4aSRandall Stewart /* CMT DAC algorithm SACK flag */
410f8829a4aSRandall Stewart #define SCTP_SACK_CMT_DAC          0x80
411f8829a4aSRandall Stewart 
41258967d8dSRandall Stewart /*
41358967d8dSRandall Stewart  * PCB flags (in sctp_flags bitmask).
41458967d8dSRandall Stewart  * Note the features and flags are meant
41558967d8dSRandall Stewart  * for use by netstat.
41658967d8dSRandall Stewart  */
41758967d8dSRandall Stewart #define SCTP_PCB_FLAGS_UDPTYPE		0x00000001
41858967d8dSRandall Stewart #define SCTP_PCB_FLAGS_TCPTYPE		0x00000002
41958967d8dSRandall Stewart #define SCTP_PCB_FLAGS_BOUNDALL		0x00000004
42058967d8dSRandall Stewart #define SCTP_PCB_FLAGS_ACCEPTING	0x00000008
42158967d8dSRandall Stewart #define SCTP_PCB_FLAGS_UNBOUND		0x00000010
42258967d8dSRandall Stewart #define SCTP_PCB_FLAGS_CLOSE_IP         0x00040000
42358967d8dSRandall Stewart #define SCTP_PCB_FLAGS_WAS_CONNECTED    0x00080000
42458967d8dSRandall Stewart #define SCTP_PCB_FLAGS_WAS_ABORTED      0x00100000
42558967d8dSRandall Stewart /* TCP model support */
42658967d8dSRandall Stewart 
42758967d8dSRandall Stewart #define SCTP_PCB_FLAGS_CONNECTED	0x00200000
42858967d8dSRandall Stewart #define SCTP_PCB_FLAGS_IN_TCPPOOL	0x00400000
42958967d8dSRandall Stewart #define SCTP_PCB_FLAGS_DONT_WAKE	0x00800000
43058967d8dSRandall Stewart #define SCTP_PCB_FLAGS_WAKEOUTPUT	0x01000000
43158967d8dSRandall Stewart #define SCTP_PCB_FLAGS_WAKEINPUT	0x02000000
43258967d8dSRandall Stewart #define SCTP_PCB_FLAGS_BOUND_V6		0x04000000
433bfefd190SRandall Stewart #define SCTP_PCB_FLAGS_BLOCKING_IO	0x08000000
434bfefd190SRandall Stewart #define SCTP_PCB_FLAGS_SOCKET_GONE	0x10000000
435bfefd190SRandall Stewart #define SCTP_PCB_FLAGS_SOCKET_ALLGONE	0x20000000
43658967d8dSRandall Stewart /* flags to copy to new PCB */
437bfefd190SRandall Stewart #define SCTP_PCB_COPY_FLAGS		(SCTP_PCB_FLAGS_BOUNDALL|\
438bfefd190SRandall Stewart 					 SCTP_PCB_FLAGS_WAKEINPUT|\
439bfefd190SRandall Stewart 					 SCTP_PCB_FLAGS_BOUND_V6)
44058967d8dSRandall Stewart 
44158967d8dSRandall Stewart 
44258967d8dSRandall Stewart /*
44358967d8dSRandall Stewart  * PCB Features (in sctp_features bitmask)
44458967d8dSRandall Stewart  */
44558967d8dSRandall Stewart #define SCTP_PCB_FLAGS_EXT_RCVINFO      0x00000002
44658967d8dSRandall Stewart #define SCTP_PCB_FLAGS_DONOT_HEARTBEAT  0x00000004
44758967d8dSRandall Stewart #define SCTP_PCB_FLAGS_FRAG_INTERLEAVE  0x00000008
44858967d8dSRandall Stewart #define SCTP_PCB_FLAGS_INTERLEAVE_STRMS	0x00000010
44958967d8dSRandall Stewart #define SCTP_PCB_FLAGS_DO_ASCONF	0x00000020
45058967d8dSRandall Stewart #define SCTP_PCB_FLAGS_AUTO_ASCONF	0x00000040
45117205eccSRandall Stewart #define SCTP_PCB_FLAGS_ZERO_COPY_ACTIVE 0x00000080
45258967d8dSRandall Stewart /* socket options */
45358967d8dSRandall Stewart #define SCTP_PCB_FLAGS_NODELAY		0x00000100
45458967d8dSRandall Stewart #define SCTP_PCB_FLAGS_AUTOCLOSE	0x00000200
45558967d8dSRandall Stewart #define SCTP_PCB_FLAGS_RECVDATAIOEVNT	0x00000400
45658967d8dSRandall Stewart #define SCTP_PCB_FLAGS_RECVASSOCEVNT	0x00000800
45758967d8dSRandall Stewart #define SCTP_PCB_FLAGS_RECVPADDREVNT	0x00001000
45858967d8dSRandall Stewart #define SCTP_PCB_FLAGS_RECVPEERERR	0x00002000
45958967d8dSRandall Stewart #define SCTP_PCB_FLAGS_RECVSENDFAILEVNT	0x00004000
46058967d8dSRandall Stewart #define SCTP_PCB_FLAGS_RECVSHUTDOWNEVNT	0x00008000
46158967d8dSRandall Stewart #define SCTP_PCB_FLAGS_ADAPTATIONEVNT	0x00010000
46258967d8dSRandall Stewart #define SCTP_PCB_FLAGS_PDAPIEVNT	0x00020000
46358967d8dSRandall Stewart #define SCTP_PCB_FLAGS_AUTHEVNT		0x00040000
46458967d8dSRandall Stewart #define SCTP_PCB_FLAGS_STREAM_RESETEVNT 0x00080000
46558967d8dSRandall Stewart #define SCTP_PCB_FLAGS_NO_FRAGMENT	0x00100000
46658967d8dSRandall Stewart #define SCTP_PCB_FLAGS_EXPLICIT_EOR     0x00400000
467bfefd190SRandall Stewart #define SCTP_PCB_FLAGS_NEEDS_MAPPED_V4	0x00800000
468c54a18d2SRandall Stewart #define SCTP_PCB_FLAGS_MULTIPLE_ASCONFS	0x01000000
4696d9e8f2bSRandall Stewart #define SCTP_PCB_FLAGS_PORTREUSE        0x02000000
4702afb3e84SRandall Stewart /*-
4712afb3e84SRandall Stewart  * mobility_features parameters (by micchie).Note
4722afb3e84SRandall Stewart  * these features are applied against the
4732afb3e84SRandall Stewart  * sctp_mobility_features flags.. not the sctp_features
4742afb3e84SRandall Stewart  * flags.
4752afb3e84SRandall Stewart  */
4762afb3e84SRandall Stewart #define SCTP_MOBILITY_BASE		0x00000001
4772afb3e84SRandall Stewart #define SCTP_MOBILITY_FASTHANDOFF	0x00000002
478851b7298SRandall Stewart #define SCTP_MOBILITY_PRIM_DELETED	0x00000004
4792afb3e84SRandall Stewart 
4802afb3e84SRandall Stewart 
481d61a0ae0SRandall Stewart #define SCTP_SMALLEST_PMTU 512	/* smallest pmtu allowed when disabling PMTU
482d61a0ae0SRandall Stewart 				 * discovery */
483d61a0ae0SRandall Stewart 
484f8829a4aSRandall Stewart #include <netinet/sctp_uio.h>
485f8829a4aSRandall Stewart 
48680fefe0aSRandall Stewart /* This dictates the size of the packet
48780fefe0aSRandall Stewart  * collection buffer. This only applies
48880fefe0aSRandall Stewart  * if SCTP_PACKET_LOGGING is enabled in
48980fefe0aSRandall Stewart  * your config.
49080fefe0aSRandall Stewart  */
491207304d4SRandall Stewart #define SCTP_PACKET_LOG_SIZE 65536
492207304d4SRandall Stewart 
49318e198d3SRandall Stewart /* Maximum delays and such a user can set for options that
49418e198d3SRandall Stewart  * take ms.
49518e198d3SRandall Stewart  */
49618e198d3SRandall Stewart #define SCTP_MAX_SACK_DELAY 500	/* per RFC4960 */
49718e198d3SRandall Stewart #define SCTP_MAX_HB_INTERVAL 14400000	/* 4 hours in ms */
49818e198d3SRandall Stewart #define SCTP_MAX_COOKIE_LIFE  3600000	/* 1 hour in ms */
49918e198d3SRandall Stewart 
50018e198d3SRandall Stewart 
50180fefe0aSRandall Stewart /* Types of logging/KTR tracing  that can be enabled via the
50280fefe0aSRandall Stewart  * sysctl net.inet.sctp.sctp_logging. You must also enable
50380fefe0aSRandall Stewart  * SUBSYS tracing.
50480fefe0aSRandall Stewart  * Note that you must have the SCTP option in the kernel
50580fefe0aSRandall Stewart  * to enable these as well.
50680fefe0aSRandall Stewart  */
50780fefe0aSRandall Stewart #define SCTP_BLK_LOGGING_ENABLE				0x00000001
50880fefe0aSRandall Stewart #define SCTP_CWND_MONITOR_ENABLE			0x00000002
50980fefe0aSRandall Stewart #define SCTP_CWND_LOGGING_ENABLE			0x00000004
51080fefe0aSRandall Stewart #define SCTP_EARLYFR_LOGGING_ENABLE			0x00000010
51180fefe0aSRandall Stewart #define SCTP_FLIGHT_LOGGING_ENABLE			0x00000020
51280fefe0aSRandall Stewart #define SCTP_FR_LOGGING_ENABLE				0x00000040
51380fefe0aSRandall Stewart #define SCTP_LOCK_LOGGING_ENABLE			0x00000080
51480fefe0aSRandall Stewart #define SCTP_MAP_LOGGING_ENABLE				0x00000100
51580fefe0aSRandall Stewart #define SCTP_MBCNT_LOGGING_ENABLE			0x00000200
51680fefe0aSRandall Stewart #define SCTP_MBUF_LOGGING_ENABLE			0x00000400
51780fefe0aSRandall Stewart #define SCTP_NAGLE_LOGGING_ENABLE			0x00000800
51880fefe0aSRandall Stewart #define SCTP_RECV_RWND_LOGGING_ENABLE		0x00001000
51980fefe0aSRandall Stewart #define SCTP_RTTVAR_LOGGING_ENABLE			0x00002000
52080fefe0aSRandall Stewart #define SCTP_SACK_LOGGING_ENABLE			0x00004000
52180fefe0aSRandall Stewart #define SCTP_SACK_RWND_LOGGING_ENABLE		0x00008000
52280fefe0aSRandall Stewart #define SCTP_SB_LOGGING_ENABLE				0x00010000
52380fefe0aSRandall Stewart #define SCTP_STR_LOGGING_ENABLE				0x00020000
52480fefe0aSRandall Stewart #define SCTP_WAKE_LOGGING_ENABLE			0x00040000
52580fefe0aSRandall Stewart #define SCTP_LOG_MAXBURST_ENABLE			0x00080000
52680fefe0aSRandall Stewart #define SCTP_LOG_RWND_ENABLE    			0x00100000
52780fefe0aSRandall Stewart #define SCTP_LOG_SACK_ARRIVALS_ENABLE       0x00200000
52880fefe0aSRandall Stewart #define SCTP_LTRACE_CHUNK_ENABLE            0x00400000
52980fefe0aSRandall Stewart #define SCTP_LTRACE_ERROR_ENABLE            0x00800000
530d95ddf02SRandall Stewart #define SCTP_LAST_PACKET_TRACING            0x01000000
531c4739e2fSRandall Stewart #define SCTP_THRESHOLD_LOGGING              0x02000000
5329f22f500SRandall Stewart #define SCTP_LOG_AT_SEND_2_SCTP             0x04000000
5339f22f500SRandall Stewart #define SCTP_LOG_AT_SEND_2_OUTQ             0x08000000
534c4739e2fSRandall Stewart 
535207304d4SRandall Stewart 
5362afb3e84SRandall Stewart 
537b3f1ea41SRandall Stewart #undef SCTP_PACKED
538b3f1ea41SRandall Stewart 
539f8829a4aSRandall Stewart #endif				/* !_NETINET_SCTP_H_ */
540