1 /* SPDX-License-Identifier: GPL-2.0+ WITH Linux-syscall-note */
2 /* SCTP kernel implementation
3 * (C) Copyright IBM Corp. 2001, 2004
4 * Copyright (c) 1999-2000 Cisco, Inc.
5 * Copyright (c) 1999-2001 Motorola, Inc.
6 * Copyright (c) 2002 Intel Corp.
8 * This file is part of the SCTP kernel implementation
10 * This header represents the structures and constants needed to support
11 * the SCTP Extension to the Sockets API.
13 * This SCTP implementation is free software;
14 * you can redistribute it and/or modify it under the terms of
15 * the GNU General Public License as published by
16 * the Free Software Foundation; either version 2, or (at your option)
19 * This SCTP implementation is distributed in the hope that it
20 * will be useful, but WITHOUT ANY WARRANTY; without even the implied
21 * ************************
22 * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
23 * See the GNU General Public License for more details.
25 * You should have received a copy of the GNU General Public License
26 * along with GNU CC; see the file COPYING. If not, see
27 * <http://www.gnu.org/licenses/>.
29 * Please send any bug reports or fixes you make to the
31 * lksctp developers <linux-sctp@vger.kernel.org>
33 * Or submit a bug report through the following website:
34 * http://www.sf.net/projects/lksctp
36 * Written or modified by:
37 * La Monte H.P. Yarroll <piggy@acm.org>
38 * R. Stewart <randall@sctp.chicago.il.us>
39 * K. Morneau <kmorneau@cisco.com>
40 * Q. Xie <qxie1@email.mot.com>
41 * Karl Knutson <karl@athena.chicago.il.us>
42 * Jon Grimm <jgrimm@us.ibm.com>
43 * Daisy Chang <daisyc@us.ibm.com>
44 * Ryan Layer <rmlayer@us.ibm.com>
45 * Ardelle Fan <ardelle.fan@intel.com>
46 * Sridhar Samudrala <sri@us.ibm.com>
47 * Inaky Perez-Gonzalez <inaky.gonzalez@intel.com>
48 * Vlad Yasevich <vladislav.yasevich@hp.com>
50 * Any bugs reported given to us we will try to fix... any fixes shared will
51 * be incorporated into the next SCTP release.
57 #include <linux/types.h>
58 #include <linux/socket.h>
60 typedef __s32 sctp_assoc_t;
62 #define SCTP_FUTURE_ASSOC 0
63 #define SCTP_CURRENT_ASSOC 1
64 #define SCTP_ALL_ASSOC 2
66 /* The following symbols come from the Sockets API Extensions for
67 * SCTP <draft-ietf-tsvwg-sctpsocket-07.txt>.
69 #define SCTP_RTOINFO 0
70 #define SCTP_ASSOCINFO 1
71 #define SCTP_INITMSG 2
72 #define SCTP_NODELAY 3 /* Get/set nodelay option. */
73 #define SCTP_AUTOCLOSE 4
74 #define SCTP_SET_PEER_PRIMARY_ADDR 5
75 #define SCTP_PRIMARY_ADDR 6
76 #define SCTP_ADAPTATION_LAYER 7
77 #define SCTP_DISABLE_FRAGMENTS 8
78 #define SCTP_PEER_ADDR_PARAMS 9
79 #define SCTP_DEFAULT_SEND_PARAM 10
80 #define SCTP_EVENTS 11
81 #define SCTP_I_WANT_MAPPED_V4_ADDR 12 /* Turn on/off mapped v4 addresses */
82 #define SCTP_MAXSEG 13 /* Get/set maximum fragment. */
83 #define SCTP_STATUS 14
84 #define SCTP_GET_PEER_ADDR_INFO 15
85 #define SCTP_DELAYED_ACK_TIME 16
86 #define SCTP_DELAYED_ACK SCTP_DELAYED_ACK_TIME
87 #define SCTP_DELAYED_SACK SCTP_DELAYED_ACK_TIME
88 #define SCTP_CONTEXT 17
89 #define SCTP_FRAGMENT_INTERLEAVE 18
90 #define SCTP_PARTIAL_DELIVERY_POINT 19 /* Set/Get partial delivery point */
91 #define SCTP_MAX_BURST 20 /* Set/Get max burst */
92 #define SCTP_AUTH_CHUNK 21 /* Set only: add a chunk type to authenticate */
93 #define SCTP_HMAC_IDENT 22
94 #define SCTP_AUTH_KEY 23
95 #define SCTP_AUTH_ACTIVE_KEY 24
96 #define SCTP_AUTH_DELETE_KEY 25
97 #define SCTP_PEER_AUTH_CHUNKS 26 /* Read only */
98 #define SCTP_LOCAL_AUTH_CHUNKS 27 /* Read only */
99 #define SCTP_GET_ASSOC_NUMBER 28 /* Read only */
100 #define SCTP_GET_ASSOC_ID_LIST 29 /* Read only */
101 #define SCTP_AUTO_ASCONF 30
102 #define SCTP_PEER_ADDR_THLDS 31
103 #define SCTP_RECVRCVINFO 32
104 #define SCTP_RECVNXTINFO 33
105 #define SCTP_DEFAULT_SNDINFO 34
106 #define SCTP_AUTH_DEACTIVATE_KEY 35
107 #define SCTP_REUSE_PORT 36
108 #define SCTP_PEER_ADDR_THLDS_V2 37
110 /* Internal Socket Options. Some of the sctp library functions are
111 * implemented using these socket options.
113 #define SCTP_SOCKOPT_BINDX_ADD 100 /* BINDX requests for adding addrs */
114 #define SCTP_SOCKOPT_BINDX_REM 101 /* BINDX requests for removing addrs. */
115 #define SCTP_SOCKOPT_PEELOFF 102 /* peel off association. */
116 /* Options 104-106 are deprecated and removed. Do not use this space */
117 #define SCTP_SOCKOPT_CONNECTX_OLD 107 /* CONNECTX old requests. */
118 #define SCTP_GET_PEER_ADDRS 108 /* Get all peer address. */
119 #define SCTP_GET_LOCAL_ADDRS 109 /* Get all local address. */
120 #define SCTP_SOCKOPT_CONNECTX 110 /* CONNECTX requests. */
121 #define SCTP_SOCKOPT_CONNECTX3 111 /* CONNECTX requests (updated) */
122 #define SCTP_GET_ASSOC_STATS 112 /* Read only */
123 #define SCTP_PR_SUPPORTED 113
124 #define SCTP_DEFAULT_PRINFO 114
125 #define SCTP_PR_ASSOC_STATUS 115
126 #define SCTP_PR_STREAM_STATUS 116
127 #define SCTP_RECONFIG_SUPPORTED 117
128 #define SCTP_ENABLE_STREAM_RESET 118
129 #define SCTP_RESET_STREAMS 119
130 #define SCTP_RESET_ASSOC 120
131 #define SCTP_ADD_STREAMS 121
132 #define SCTP_SOCKOPT_PEELOFF_FLAGS 122
133 #define SCTP_STREAM_SCHEDULER 123
134 #define SCTP_STREAM_SCHEDULER_VALUE 124
135 #define SCTP_INTERLEAVING_SUPPORTED 125
136 #define SCTP_SENDMSG_CONNECT 126
137 #define SCTP_EVENT 127
138 #define SCTP_ASCONF_SUPPORTED 128
139 #define SCTP_AUTH_SUPPORTED 129
140 #define SCTP_ECN_SUPPORTED 130
141 #define SCTP_EXPOSE_POTENTIALLY_FAILED_STATE 131
142 #define SCTP_EXPOSE_PF_STATE SCTP_EXPOSE_POTENTIALLY_FAILED_STATE
143 #define SCTP_REMOTE_UDP_ENCAPS_PORT 132
145 /* PR-SCTP policies */
146 #define SCTP_PR_SCTP_NONE 0x0000
147 #define SCTP_PR_SCTP_TTL 0x0010
148 #define SCTP_PR_SCTP_RTX 0x0020
149 #define SCTP_PR_SCTP_PRIO 0x0030
150 #define SCTP_PR_SCTP_MAX SCTP_PR_SCTP_PRIO
151 #define SCTP_PR_SCTP_MASK 0x0030
153 #define __SCTP_PR_INDEX(x) ((x >> 4) - 1)
154 #define SCTP_PR_INDEX(x) __SCTP_PR_INDEX(SCTP_PR_SCTP_ ## x)
156 #define SCTP_PR_POLICY(x) ((x) & SCTP_PR_SCTP_MASK)
157 #define SCTP_PR_SET_POLICY(flags, x) \
159 flags &= ~SCTP_PR_SCTP_MASK; \
163 #define SCTP_PR_TTL_ENABLED(x) (SCTP_PR_POLICY(x) == SCTP_PR_SCTP_TTL)
164 #define SCTP_PR_RTX_ENABLED(x) (SCTP_PR_POLICY(x) == SCTP_PR_SCTP_RTX)
165 #define SCTP_PR_PRIO_ENABLED(x) (SCTP_PR_POLICY(x) == SCTP_PR_SCTP_PRIO)
167 /* For enable stream reset */
168 #define SCTP_ENABLE_RESET_STREAM_REQ 0x01
169 #define SCTP_ENABLE_RESET_ASSOC_REQ 0x02
170 #define SCTP_ENABLE_CHANGE_ASSOC_REQ 0x04
171 #define SCTP_ENABLE_STRRESET_MASK 0x07
173 #define SCTP_STREAM_RESET_INCOMING 0x01
174 #define SCTP_STREAM_RESET_OUTGOING 0x02
176 /* These are bit fields for msghdr->msg_flags. See section 5.1. */
177 /* On user space Linux, these live in <bits/socket.h> as an enum. */
178 enum sctp_msg_flags {
179 MSG_NOTIFICATION = 0x8000,
180 #define MSG_NOTIFICATION MSG_NOTIFICATION
183 /* 5.3.1 SCTP Initiation Structure (SCTP_INIT)
185 * This cmsghdr structure provides information for initializing new
186 * SCTP associations with sendmsg(). The SCTP_INITMSG socket option
187 * uses this same data structure. This structure is not used for
190 * cmsg_level cmsg_type cmsg_data[]
191 * ------------ ------------ ----------------------
192 * IPPROTO_SCTP SCTP_INIT struct sctp_initmsg
194 struct sctp_initmsg {
195 __u16 sinit_num_ostreams;
196 __u16 sinit_max_instreams;
197 __u16 sinit_max_attempts;
198 __u16 sinit_max_init_timeo;
201 /* 5.3.2 SCTP Header Information Structure (SCTP_SNDRCV)
203 * This cmsghdr structure specifies SCTP options for sendmsg() and
204 * describes SCTP header information about a received message through
207 * cmsg_level cmsg_type cmsg_data[]
208 * ------------ ------------ ----------------------
209 * IPPROTO_SCTP SCTP_SNDRCV struct sctp_sndrcvinfo
211 struct sctp_sndrcvinfo {
217 __u32 sinfo_timetolive;
220 sctp_assoc_t sinfo_assoc_id;
223 /* 5.3.4 SCTP Send Information Structure (SCTP_SNDINFO)
225 * This cmsghdr structure specifies SCTP options for sendmsg().
227 * cmsg_level cmsg_type cmsg_data[]
228 * ------------ ------------ -------------------
229 * IPPROTO_SCTP SCTP_SNDINFO struct sctp_sndinfo
231 struct sctp_sndinfo {
236 sctp_assoc_t snd_assoc_id;
239 /* 5.3.5 SCTP Receive Information Structure (SCTP_RCVINFO)
241 * This cmsghdr structure describes SCTP receive information
242 * about a received message through recvmsg().
244 * cmsg_level cmsg_type cmsg_data[]
245 * ------------ ------------ -------------------
246 * IPPROTO_SCTP SCTP_RCVINFO struct sctp_rcvinfo
248 struct sctp_rcvinfo {
256 sctp_assoc_t rcv_assoc_id;
259 /* 5.3.6 SCTP Next Receive Information Structure (SCTP_NXTINFO)
261 * This cmsghdr structure describes SCTP receive information
262 * of the next message that will be delivered through recvmsg()
263 * if this information is already available when delivering
264 * the current message.
266 * cmsg_level cmsg_type cmsg_data[]
267 * ------------ ------------ -------------------
268 * IPPROTO_SCTP SCTP_NXTINFO struct sctp_nxtinfo
270 struct sctp_nxtinfo {
275 sctp_assoc_t nxt_assoc_id;
278 /* 5.3.7 SCTP PR-SCTP Information Structure (SCTP_PRINFO)
280 * This cmsghdr structure specifies SCTP options for sendmsg().
282 * cmsg_level cmsg_type cmsg_data[]
283 * ------------ ------------ -------------------
284 * IPPROTO_SCTP SCTP_PRINFO struct sctp_prinfo
291 /* 5.3.8 SCTP AUTH Information Structure (SCTP_AUTHINFO)
293 * This cmsghdr structure specifies SCTP options for sendmsg().
295 * cmsg_level cmsg_type cmsg_data[]
296 * ------------ ------------ -------------------
297 * IPPROTO_SCTP SCTP_AUTHINFO struct sctp_authinfo
299 struct sctp_authinfo {
300 __u16 auth_keynumber;
304 * sinfo_flags: 16 bits (unsigned integer)
306 * This field may contain any of the following flags and is composed of
307 * a bitwise OR of these values.
309 enum sctp_sinfo_flags {
310 SCTP_UNORDERED = (1 << 0), /* Send/receive message unordered. */
311 SCTP_ADDR_OVER = (1 << 1), /* Override the primary destination. */
312 SCTP_ABORT = (1 << 2), /* Send an ABORT message to the peer. */
313 SCTP_SACK_IMMEDIATELY = (1 << 3), /* SACK should be sent without delay. */
314 /* 2 bits here have been used by SCTP_PR_SCTP_MASK */
315 SCTP_SENDALL = (1 << 6),
316 SCTP_PR_SCTP_ALL = (1 << 7),
317 SCTP_NOTIFICATION = MSG_NOTIFICATION, /* Next message is not user msg but notification. */
318 SCTP_EOF = MSG_FIN, /* Initiate graceful shutdown process. */
323 struct sctp_initmsg init;
324 struct sctp_sndrcvinfo sndrcv;
327 /* These are cmsg_types. */
328 typedef enum sctp_cmsg_type {
329 SCTP_INIT, /* 5.2.1 SCTP Initiation Structure */
330 #define SCTP_INIT SCTP_INIT
331 SCTP_SNDRCV, /* 5.2.2 SCTP Header Information Structure */
332 #define SCTP_SNDRCV SCTP_SNDRCV
333 SCTP_SNDINFO, /* 5.3.4 SCTP Send Information Structure */
334 #define SCTP_SNDINFO SCTP_SNDINFO
335 SCTP_RCVINFO, /* 5.3.5 SCTP Receive Information Structure */
336 #define SCTP_RCVINFO SCTP_RCVINFO
337 SCTP_NXTINFO, /* 5.3.6 SCTP Next Receive Information Structure */
338 #define SCTP_NXTINFO SCTP_NXTINFO
339 SCTP_PRINFO, /* 5.3.7 SCTP PR-SCTP Information Structure */
340 #define SCTP_PRINFO SCTP_PRINFO
341 SCTP_AUTHINFO, /* 5.3.8 SCTP AUTH Information Structure */
342 #define SCTP_AUTHINFO SCTP_AUTHINFO
343 SCTP_DSTADDRV4, /* 5.3.9 SCTP Destination IPv4 Address Structure */
344 #define SCTP_DSTADDRV4 SCTP_DSTADDRV4
345 SCTP_DSTADDRV6, /* 5.3.10 SCTP Destination IPv6 Address Structure */
346 #define SCTP_DSTADDRV6 SCTP_DSTADDRV6
350 * 5.3.1.1 SCTP_ASSOC_CHANGE
352 * Communication notifications inform the ULP that an SCTP association
353 * has either begun or ended. The identifier for a new association is
354 * provided by this notificaion. The notification information has the
358 struct sctp_assoc_change {
364 __u16 sac_outbound_streams;
365 __u16 sac_inbound_streams;
366 sctp_assoc_t sac_assoc_id;
371 * sac_state: 32 bits (signed integer)
373 * This field holds one of a number of values that communicate the
374 * event that happened to the association. They include:
376 * Note: The following state names deviate from the API draft as
377 * the names clash too easily with other kernel symbols.
379 enum sctp_sac_state {
388 * 5.3.1.2 SCTP_PEER_ADDR_CHANGE
390 * When a destination address on a multi-homed peer encounters a change
391 * an interface details event is sent. The information has the
392 * following structure:
394 struct sctp_paddr_change {
398 struct sockaddr_storage spc_aaddr;
401 sctp_assoc_t spc_assoc_id;
402 } __attribute__((packed, aligned(4)));
405 * spc_state: 32 bits (signed integer)
407 * This field holds one of a number of values that communicate the
408 * event that happened to the address. They include:
410 enum sctp_spc_state {
412 SCTP_ADDR_UNREACHABLE,
417 SCTP_ADDR_POTENTIALLY_FAILED,
418 #define SCTP_ADDR_PF SCTP_ADDR_POTENTIALLY_FAILED
423 * 5.3.1.3 SCTP_REMOTE_ERROR
425 * A remote peer may send an Operational Error message to its peer.
426 * This message indicates a variety of error conditions on an
427 * association. The entire error TLV as it appears on the wire is
428 * included in a SCTP_REMOTE_ERROR event. Please refer to the SCTP
429 * specification [SCTP] and any extensions for a list of possible
430 * error formats. SCTP error TLVs have the format:
432 struct sctp_remote_error {
437 sctp_assoc_t sre_assoc_id;
443 * 5.3.1.4 SCTP_SEND_FAILED
445 * If SCTP cannot deliver a message it may return the message as a
448 struct sctp_send_failed {
453 struct sctp_sndrcvinfo ssf_info;
454 sctp_assoc_t ssf_assoc_id;
458 struct sctp_send_failed_event {
463 struct sctp_sndinfo ssfe_info;
464 sctp_assoc_t ssf_assoc_id;
469 * ssf_flags: 16 bits (unsigned integer)
471 * The flag value will take one of the following values
473 * SCTP_DATA_UNSENT - Indicates that the data was never put on
476 * SCTP_DATA_SENT - Indicates that the data was put on the wire.
477 * Note that this does not necessarily mean that the
478 * data was (or was not) successfully delivered.
480 enum sctp_ssf_flags {
486 * 5.3.1.5 SCTP_SHUTDOWN_EVENT
488 * When a peer sends a SHUTDOWN, SCTP delivers this notification to
489 * inform the application that it should cease sending data.
491 struct sctp_shutdown_event {
495 sctp_assoc_t sse_assoc_id;
499 * 5.3.1.6 SCTP_ADAPTATION_INDICATION
501 * When a peer sends a Adaptation Layer Indication parameter , SCTP
502 * delivers this notification to inform the application
503 * that of the peers requested adaptation layer.
505 struct sctp_adaptation_event {
509 __u32 sai_adaptation_ind;
510 sctp_assoc_t sai_assoc_id;
514 * 5.3.1.7 SCTP_PARTIAL_DELIVERY_EVENT
516 * When a receiver is engaged in a partial delivery of a
517 * message this notification will be used to indicate
520 struct sctp_pdapi_event {
524 __u32 pdapi_indication;
525 sctp_assoc_t pdapi_assoc_id;
530 enum { SCTP_PARTIAL_DELIVERY_ABORTED=0, };
533 * 5.3.1.8. SCTP_AUTHENTICATION_EVENT
535 * When a receiver is using authentication this message will provide
536 * notifications regarding new keys being made active as well as errors.
538 struct sctp_authkey_event {
542 __u16 auth_keynumber;
543 __u16 auth_altkeynumber;
544 __u32 auth_indication;
545 sctp_assoc_t auth_assoc_id;
550 #define SCTP_AUTH_NEWKEY SCTP_AUTH_NEW_KEY /* compatible with before */
556 * 6.1.9. SCTP_SENDER_DRY_EVENT
558 * When the SCTP stack has no more user data to send or retransmit, this
559 * notification is given to the user. Also, at the time when a user app
560 * subscribes to this event, if there is no data to be sent or
561 * retransmit, the stack will immediately send up this notification.
563 struct sctp_sender_dry_event {
564 __u16 sender_dry_type;
565 __u16 sender_dry_flags;
566 __u32 sender_dry_length;
567 sctp_assoc_t sender_dry_assoc_id;
570 #define SCTP_STREAM_RESET_INCOMING_SSN 0x0001
571 #define SCTP_STREAM_RESET_OUTGOING_SSN 0x0002
572 #define SCTP_STREAM_RESET_DENIED 0x0004
573 #define SCTP_STREAM_RESET_FAILED 0x0008
574 struct sctp_stream_reset_event {
576 __u16 strreset_flags;
577 __u32 strreset_length;
578 sctp_assoc_t strreset_assoc_id;
579 __u16 strreset_stream_list[];
582 #define SCTP_ASSOC_RESET_DENIED 0x0004
583 #define SCTP_ASSOC_RESET_FAILED 0x0008
584 struct sctp_assoc_reset_event {
585 __u16 assocreset_type;
586 __u16 assocreset_flags;
587 __u32 assocreset_length;
588 sctp_assoc_t assocreset_assoc_id;
589 __u32 assocreset_local_tsn;
590 __u32 assocreset_remote_tsn;
593 #define SCTP_ASSOC_CHANGE_DENIED 0x0004
594 #define SCTP_ASSOC_CHANGE_FAILED 0x0008
595 #define SCTP_STREAM_CHANGE_DENIED SCTP_ASSOC_CHANGE_DENIED
596 #define SCTP_STREAM_CHANGE_FAILED SCTP_ASSOC_CHANGE_FAILED
597 struct sctp_stream_change_event {
598 __u16 strchange_type;
599 __u16 strchange_flags;
600 __u32 strchange_length;
601 sctp_assoc_t strchange_assoc_id;
602 __u16 strchange_instrms;
603 __u16 strchange_outstrms;
607 * Described in Section 7.3
608 * Ancillary Data and Notification Interest Options
610 struct sctp_event_subscribe {
611 __u8 sctp_data_io_event;
612 __u8 sctp_association_event;
613 __u8 sctp_address_event;
614 __u8 sctp_send_failure_event;
615 __u8 sctp_peer_error_event;
616 __u8 sctp_shutdown_event;
617 __u8 sctp_partial_delivery_event;
618 __u8 sctp_adaptation_layer_event;
619 __u8 sctp_authentication_event;
620 __u8 sctp_sender_dry_event;
621 __u8 sctp_stream_reset_event;
622 __u8 sctp_assoc_reset_event;
623 __u8 sctp_stream_change_event;
624 __u8 sctp_send_failure_event_event;
628 * 5.3.1 SCTP Notification Structure
630 * The notification structure is defined as the union of all
631 * notification types.
634 union sctp_notification {
636 __u16 sn_type; /* Notification type. */
640 struct sctp_assoc_change sn_assoc_change;
641 struct sctp_paddr_change sn_paddr_change;
642 struct sctp_remote_error sn_remote_error;
643 struct sctp_send_failed sn_send_failed;
644 struct sctp_shutdown_event sn_shutdown_event;
645 struct sctp_adaptation_event sn_adaptation_event;
646 struct sctp_pdapi_event sn_pdapi_event;
647 struct sctp_authkey_event sn_authkey_event;
648 struct sctp_sender_dry_event sn_sender_dry_event;
649 struct sctp_stream_reset_event sn_strreset_event;
650 struct sctp_assoc_reset_event sn_assocreset_event;
651 struct sctp_stream_change_event sn_strchange_event;
652 struct sctp_send_failed_event sn_send_failed_event;
656 * All standard values for sn_type flags are greater than 2^15.
657 * Values from 2^15 and down are reserved.
661 SCTP_SN_TYPE_BASE = (1<<15),
662 SCTP_DATA_IO_EVENT = SCTP_SN_TYPE_BASE,
663 #define SCTP_DATA_IO_EVENT SCTP_DATA_IO_EVENT
665 #define SCTP_ASSOC_CHANGE SCTP_ASSOC_CHANGE
666 SCTP_PEER_ADDR_CHANGE,
667 #define SCTP_PEER_ADDR_CHANGE SCTP_PEER_ADDR_CHANGE
669 #define SCTP_SEND_FAILED SCTP_SEND_FAILED
671 #define SCTP_REMOTE_ERROR SCTP_REMOTE_ERROR
673 #define SCTP_SHUTDOWN_EVENT SCTP_SHUTDOWN_EVENT
674 SCTP_PARTIAL_DELIVERY_EVENT,
675 #define SCTP_PARTIAL_DELIVERY_EVENT SCTP_PARTIAL_DELIVERY_EVENT
676 SCTP_ADAPTATION_INDICATION,
677 #define SCTP_ADAPTATION_INDICATION SCTP_ADAPTATION_INDICATION
678 SCTP_AUTHENTICATION_EVENT,
679 #define SCTP_AUTHENTICATION_INDICATION SCTP_AUTHENTICATION_EVENT
680 SCTP_SENDER_DRY_EVENT,
681 #define SCTP_SENDER_DRY_EVENT SCTP_SENDER_DRY_EVENT
682 SCTP_STREAM_RESET_EVENT,
683 #define SCTP_STREAM_RESET_EVENT SCTP_STREAM_RESET_EVENT
684 SCTP_ASSOC_RESET_EVENT,
685 #define SCTP_ASSOC_RESET_EVENT SCTP_ASSOC_RESET_EVENT
686 SCTP_STREAM_CHANGE_EVENT,
687 #define SCTP_STREAM_CHANGE_EVENT SCTP_STREAM_CHANGE_EVENT
688 SCTP_SEND_FAILED_EVENT,
689 #define SCTP_SEND_FAILED_EVENT SCTP_SEND_FAILED_EVENT
690 SCTP_SN_TYPE_MAX = SCTP_SEND_FAILED_EVENT,
691 #define SCTP_SN_TYPE_MAX SCTP_SN_TYPE_MAX
694 /* Notification error codes used to fill up the error fields in some
696 * SCTP_PEER_ADDRESS_CHAGE : spc_error
697 * SCTP_ASSOC_CHANGE : sac_error
698 * These names should be potentially included in the draft 04 of the SCTP
699 * sockets API specification.
701 typedef enum sctp_sn_error {
702 SCTP_FAILED_THRESHOLD,
704 SCTP_HEARTBEAT_SUCCESS,
705 SCTP_RESPONSE_TO_USER_REQ,
707 SCTP_SHUTDOWN_GUARD_EXPIRES,
712 * 7.1.1 Retransmission Timeout Parameters (SCTP_RTOINFO)
714 * The protocol parameters used to initialize and bound retransmission
715 * timeout (RTO) are tunable. See [SCTP] for more information on how
716 * these parameters are used in RTO calculation.
718 struct sctp_rtoinfo {
719 sctp_assoc_t srto_assoc_id;
726 * 7.1.2 Association Parameters (SCTP_ASSOCINFO)
728 * This option is used to both examine and set various association and
729 * endpoint parameters.
731 struct sctp_assocparams {
732 sctp_assoc_t sasoc_assoc_id;
733 __u16 sasoc_asocmaxrxt;
734 __u16 sasoc_number_peer_destinations;
735 __u32 sasoc_peer_rwnd;
736 __u32 sasoc_local_rwnd;
737 __u32 sasoc_cookie_life;
741 * 7.1.9 Set Peer Primary Address (SCTP_SET_PEER_PRIMARY_ADDR)
743 * Requests that the peer mark the enclosed address as the association
744 * primary. The enclosed address must be one of the association's
745 * locally bound addresses. The following structure is used to make a
746 * set primary request:
748 struct sctp_setpeerprim {
749 sctp_assoc_t sspp_assoc_id;
750 struct sockaddr_storage sspp_addr;
751 } __attribute__((packed, aligned(4)));
754 * 7.1.10 Set Primary Address (SCTP_PRIMARY_ADDR)
756 * Requests that the local SCTP stack use the enclosed peer address as
757 * the association primary. The enclosed address must be one of the
758 * association peer's addresses. The following structure is used to
759 * make a set peer primary request:
762 sctp_assoc_t ssp_assoc_id;
763 struct sockaddr_storage ssp_addr;
764 } __attribute__((packed, aligned(4)));
766 /* For backward compatibility use, define the old name too */
767 #define sctp_setprim sctp_prim
770 * 7.1.11 Set Adaptation Layer Indicator (SCTP_ADAPTATION_LAYER)
772 * Requests that the local endpoint set the specified Adaptation Layer
773 * Indication parameter for all future INIT and INIT-ACK exchanges.
775 struct sctp_setadaptation {
776 __u32 ssb_adaptation_ind;
780 * 7.1.13 Peer Address Parameters (SCTP_PEER_ADDR_PARAMS)
782 * Applications can enable or disable heartbeats for any peer address
783 * of an association, modify an address's heartbeat interval, force a
784 * heartbeat to be sent immediately, and adjust the address's maximum
785 * number of retransmissions sent before an address is considered
786 * unreachable. The following structure is used to access and modify an
787 * address's parameters:
789 enum sctp_spp_flags {
790 SPP_HB_ENABLE = 1<<0, /*Enable heartbeats*/
791 SPP_HB_DISABLE = 1<<1, /*Disable heartbeats*/
792 SPP_HB = SPP_HB_ENABLE | SPP_HB_DISABLE,
793 SPP_HB_DEMAND = 1<<2, /*Send heartbeat immediately*/
794 SPP_PMTUD_ENABLE = 1<<3, /*Enable PMTU discovery*/
795 SPP_PMTUD_DISABLE = 1<<4, /*Disable PMTU discovery*/
796 SPP_PMTUD = SPP_PMTUD_ENABLE | SPP_PMTUD_DISABLE,
797 SPP_SACKDELAY_ENABLE = 1<<5, /*Enable SACK*/
798 SPP_SACKDELAY_DISABLE = 1<<6, /*Disable SACK*/
799 SPP_SACKDELAY = SPP_SACKDELAY_ENABLE | SPP_SACKDELAY_DISABLE,
800 SPP_HB_TIME_IS_ZERO = 1<<7, /* Set HB delay to 0 */
801 SPP_IPV6_FLOWLABEL = 1<<8,
805 struct sctp_paddrparams {
806 sctp_assoc_t spp_assoc_id;
807 struct sockaddr_storage spp_address;
808 __u32 spp_hbinterval;
809 __u16 spp_pathmaxrxt;
813 __u32 spp_ipv6_flowlabel;
815 } __attribute__((packed, aligned(4)));
818 * 7.1.18. Add a chunk that must be authenticated (SCTP_AUTH_CHUNK)
820 * This set option adds a chunk type that the user is requesting to be
821 * received only in an authenticated way. Changes to the list of chunks
822 * will only effect future associations on the socket.
824 struct sctp_authchunk {
829 * 7.1.19. Get or set the list of supported HMAC Identifiers (SCTP_HMAC_IDENT)
831 * This option gets or sets the list of HMAC algorithms that the local
832 * endpoint requires the peer to use.
835 /* This here is only used by user space as is. It might not be a good idea
836 * to export/reveal the whole structure with reserved fields etc.
839 SCTP_AUTH_HMAC_ID_SHA1 = 1,
840 SCTP_AUTH_HMAC_ID_SHA256 = 3,
844 struct sctp_hmacalgo {
845 __u32 shmac_num_idents;
846 __u16 shmac_idents[];
849 /* Sadly, user and kernel space have different names for
850 * this structure member, so this is to not break anything.
852 #define shmac_number_of_idents shmac_num_idents
855 * 7.1.20. Set a shared key (SCTP_AUTH_KEY)
857 * This option will set a shared secret key which is used to build an
858 * association shared key.
860 struct sctp_authkey {
861 sctp_assoc_t sca_assoc_id;
868 * 7.1.21. Get or set the active shared key (SCTP_AUTH_ACTIVE_KEY)
870 * This option will get or set the active shared key to be used to build
871 * the association shared key.
874 struct sctp_authkeyid {
875 sctp_assoc_t scact_assoc_id;
876 __u16 scact_keynumber;
881 * 7.1.23. Get or set delayed ack timer (SCTP_DELAYED_SACK)
883 * This option will effect the way delayed acks are performed. This
884 * option allows you to get or set the delayed ack time, in
885 * milliseconds. It also allows changing the delayed ack frequency.
886 * Changing the frequency to 1 disables the delayed sack algorithm. If
887 * the assoc_id is 0, then this sets or gets the endpoints default
888 * values. If the assoc_id field is non-zero, then the set or get
889 * effects the specified association for the one to many model (the
890 * assoc_id field is ignored by the one to one model). Note that if
891 * sack_delay or sack_freq are 0 when setting this option, then the
892 * current values will remain unchanged.
894 struct sctp_sack_info {
895 sctp_assoc_t sack_assoc_id;
900 struct sctp_assoc_value {
901 sctp_assoc_t assoc_id;
902 uint32_t assoc_value;
905 struct sctp_stream_value {
906 sctp_assoc_t assoc_id;
908 uint16_t stream_value;
912 * 7.2.2 Peer Address Information
914 * Applications can retrieve information about a specific peer address
915 * of an association, including its reachability state, congestion
916 * window, and retransmission timer values. This information is
917 * read-only. The following structure is used to access this
920 struct sctp_paddrinfo {
921 sctp_assoc_t spinfo_assoc_id;
922 struct sockaddr_storage spinfo_address;
928 } __attribute__((packed, aligned(4)));
930 /* Peer addresses's state. */
931 /* UNKNOWN: Peer address passed by the upper layer in sendmsg or connect[x]
933 * UNCONFIRMED: Peer address received in INIT/INIT-ACK address parameters.
934 * Not yet confirmed by a heartbeat and not available for data
936 * ACTIVE : Peer address confirmed, active and available for data transfers.
937 * INACTIVE: Peer address inactive and not available for data transfers.
939 enum sctp_spinfo_state {
942 #define SCTP_POTENTIALLY_FAILED SCTP_PF
945 SCTP_UNKNOWN = 0xffff /* Value used for transport state unknown */
949 * 7.2.1 Association Status (SCTP_STATUS)
951 * Applications can retrieve current status information about an
952 * association, including association state, peer receiver window size,
953 * number of unacked data chunks, and number of data chunks pending
954 * receipt. This information is read-only. The following structure is
955 * used to access this information:
958 sctp_assoc_t sstat_assoc_id;
961 __u16 sstat_unackdata;
962 __u16 sstat_penddata;
964 __u16 sstat_outstrms;
965 __u32 sstat_fragmentation_point;
966 struct sctp_paddrinfo sstat_primary;
970 * 7.2.3. Get the list of chunks the peer requires to be authenticated
971 * (SCTP_PEER_AUTH_CHUNKS)
973 * This option gets a list of chunks for a specified association that
974 * the peer requires to be received authenticated only.
976 struct sctp_authchunks {
977 sctp_assoc_t gauth_assoc_id;
978 __u32 gauth_number_of_chunks;
979 uint8_t gauth_chunks[];
982 /* The broken spelling has been released already in lksctp-tools header,
983 * so don't break anyone, now that it's fixed.
985 #define guth_number_of_chunks gauth_number_of_chunks
987 /* Association states. */
988 enum sctp_sstat_state {
991 SCTP_COOKIE_WAIT = 2,
992 SCTP_COOKIE_ECHOED = 3,
993 SCTP_ESTABLISHED = 4,
994 SCTP_SHUTDOWN_PENDING = 5,
995 SCTP_SHUTDOWN_SENT = 6,
996 SCTP_SHUTDOWN_RECEIVED = 7,
997 SCTP_SHUTDOWN_ACK_SENT = 8,
1001 * 8.2.6. Get the Current Identifiers of Associations
1002 * (SCTP_GET_ASSOC_ID_LIST)
1004 * This option gets the current list of SCTP association identifiers of
1005 * the SCTP associations handled by a one-to-many style socket.
1007 struct sctp_assoc_ids {
1008 __u32 gaids_number_of_ids;
1009 sctp_assoc_t gaids_assoc_id[];
1013 * 8.3, 8.5 get all peer/local addresses in an association.
1014 * This parameter struct is used by SCTP_GET_PEER_ADDRS and
1015 * SCTP_GET_LOCAL_ADDRS socket options used internally to implement
1016 * sctp_getpaddrs() and sctp_getladdrs() API.
1018 struct sctp_getaddrs_old {
1019 sctp_assoc_t assoc_id;
1022 struct sockaddr __user *addrs;
1024 struct sockaddr *addrs;
1028 struct sctp_getaddrs {
1029 sctp_assoc_t assoc_id; /*input*/
1030 __u32 addr_num; /*output*/
1031 __u8 addrs[0]; /*output, variable size*/
1034 /* A socket user request obtained via SCTP_GET_ASSOC_STATS that retrieves
1035 * association stats. All stats are counts except sas_maxrto and
1036 * sas_obs_rto_ipaddr. maxrto is the max observed rto + transport since
1037 * the last call. Will return 0 when RTO was not update since last call
1039 struct sctp_assoc_stats {
1040 sctp_assoc_t sas_assoc_id; /* Input */
1041 /* Transport of observed max RTO */
1042 struct sockaddr_storage sas_obs_rto_ipaddr;
1043 __u64 sas_maxrto; /* Maximum Observed RTO for period */
1044 __u64 sas_isacks; /* SACKs received */
1045 __u64 sas_osacks; /* SACKs sent */
1046 __u64 sas_opackets; /* Packets sent */
1047 __u64 sas_ipackets; /* Packets received */
1048 __u64 sas_rtxchunks; /* Retransmitted Chunks */
1049 __u64 sas_outofseqtsns;/* TSN received > next expected */
1050 __u64 sas_idupchunks; /* Dups received (ordered+unordered) */
1051 __u64 sas_gapcnt; /* Gap Acknowledgements Received */
1052 __u64 sas_ouodchunks; /* Unordered data chunks sent */
1053 __u64 sas_iuodchunks; /* Unordered data chunks received */
1054 __u64 sas_oodchunks; /* Ordered data chunks sent */
1055 __u64 sas_iodchunks; /* Ordered data chunks received */
1056 __u64 sas_octrlchunks; /* Control chunks sent */
1057 __u64 sas_ictrlchunks; /* Control chunks received */
1063 * The flags parameter is formed from the bitwise OR of zero or more of the
1064 * following currently defined flags:
1066 #define SCTP_BINDX_ADD_ADDR 0x01
1067 #define SCTP_BINDX_REM_ADDR 0x02
1069 /* This is the structure that is passed as an argument(optval) to
1070 * getsockopt(SCTP_SOCKOPT_PEELOFF).
1073 sctp_assoc_t associd;
1075 } sctp_peeloff_arg_t;
1078 sctp_peeloff_arg_t p_arg;
1080 } sctp_peeloff_flags_arg_t;
1083 * Peer Address Thresholds socket option
1085 struct sctp_paddrthlds {
1086 sctp_assoc_t spt_assoc_id;
1087 struct sockaddr_storage spt_address;
1088 __u16 spt_pathmaxrxt;
1089 __u16 spt_pathpfthld;
1092 /* Use a new structure with spt_pathcpthld for back compatibility */
1093 struct sctp_paddrthlds_v2 {
1094 sctp_assoc_t spt_assoc_id;
1095 struct sockaddr_storage spt_address;
1096 __u16 spt_pathmaxrxt;
1097 __u16 spt_pathpfthld;
1098 __u16 spt_pathcpthld;
1102 * Socket Option for Getting the Association/Stream-Specific PR-SCTP Status
1104 struct sctp_prstatus {
1105 sctp_assoc_t sprstat_assoc_id;
1107 __u16 sprstat_policy;
1108 __u64 sprstat_abandoned_unsent;
1109 __u64 sprstat_abandoned_sent;
1112 struct sctp_default_prinfo {
1113 sctp_assoc_t pr_assoc_id;
1122 __u16 sctpi_unackdata;
1123 __u16 sctpi_penddata;
1124 __u16 sctpi_instrms;
1125 __u16 sctpi_outstrms;
1126 __u32 sctpi_fragmentation_point;
1127 __u32 sctpi_inqueue;
1128 __u32 sctpi_outqueue;
1129 __u32 sctpi_overall_error;
1130 __u32 sctpi_max_burst;
1132 __u32 sctpi_peer_rwnd;
1133 __u32 sctpi_peer_tag;
1134 __u8 sctpi_peer_capable;
1135 __u8 sctpi_peer_sack;
1138 /* assoc status info */
1141 __u64 sctpi_opackets;
1142 __u64 sctpi_ipackets;
1143 __u64 sctpi_rtxchunks;
1144 __u64 sctpi_outofseqtsns;
1145 __u64 sctpi_idupchunks;
1147 __u64 sctpi_ouodchunks;
1148 __u64 sctpi_iuodchunks;
1149 __u64 sctpi_oodchunks;
1150 __u64 sctpi_iodchunks;
1151 __u64 sctpi_octrlchunks;
1152 __u64 sctpi_ictrlchunks;
1154 /* primary transport info */
1155 struct sockaddr_storage sctpi_p_address;
1156 __s32 sctpi_p_state;
1160 __u32 sctpi_p_hbinterval;
1161 __u32 sctpi_p_pathmaxrxt;
1162 __u32 sctpi_p_sackdelay;
1163 __u32 sctpi_p_sackfreq;
1164 __u32 sctpi_p_ssthresh;
1165 __u32 sctpi_p_partial_bytes_acked;
1166 __u32 sctpi_p_flight_size;
1167 __u16 sctpi_p_error;
1170 /* sctp sock info */
1171 __u32 sctpi_s_autoclose;
1172 __u32 sctpi_s_adaptation_ind;
1173 __u32 sctpi_s_pd_point;
1174 __u8 sctpi_s_nodelay;
1175 __u8 sctpi_s_disable_fragments;
1176 __u8 sctpi_s_v4mapped;
1177 __u8 sctpi_s_frag_interleave;
1182 struct sctp_reset_streams {
1183 sctp_assoc_t srs_assoc_id;
1185 uint16_t srs_number_streams; /* 0 == ALL */
1186 uint16_t srs_stream_list[]; /* list if srs_num_streams is not 0 */
1189 struct sctp_add_streams {
1190 sctp_assoc_t sas_assoc_id;
1191 uint16_t sas_instrms;
1192 uint16_t sas_outstrms;
1196 sctp_assoc_t se_assoc_id;
1201 struct sctp_udpencaps {
1202 sctp_assoc_t sue_assoc_id;
1203 struct sockaddr_storage sue_address;
1207 /* SCTP Stream schedulers */
1208 enum sctp_sched_type {
1210 SCTP_SS_DEFAULT = SCTP_SS_FCFS,
1213 SCTP_SS_MAX = SCTP_SS_RR
1216 #endif /* _UAPI_SCTP_H */