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