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