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
109 /* Internal Socket Options. Some of the sctp library functions are
110 * implemented using these socket options.
112 #define SCTP_SOCKOPT_BINDX_ADD 100 /* BINDX requests for adding addrs */
113 #define SCTP_SOCKOPT_BINDX_REM 101 /* BINDX requests for removing addrs. */
114 #define SCTP_SOCKOPT_PEELOFF 102 /* peel off association. */
115 /* Options 104-106 are deprecated and removed. Do not use this space */
116 #define SCTP_SOCKOPT_CONNECTX_OLD 107 /* CONNECTX old requests. */
117 #define SCTP_GET_PEER_ADDRS 108 /* Get all peer address. */
118 #define SCTP_GET_LOCAL_ADDRS 109 /* Get all local address. */
119 #define SCTP_SOCKOPT_CONNECTX 110 /* CONNECTX requests. */
120 #define SCTP_SOCKOPT_CONNECTX3 111 /* CONNECTX requests (updated) */
121 #define SCTP_GET_ASSOC_STATS 112 /* Read only */
122 #define SCTP_PR_SUPPORTED 113
123 #define SCTP_DEFAULT_PRINFO 114
124 #define SCTP_PR_ASSOC_STATUS 115
125 #define SCTP_PR_STREAM_STATUS 116
126 #define SCTP_RECONFIG_SUPPORTED 117
127 #define SCTP_ENABLE_STREAM_RESET 118
128 #define SCTP_RESET_STREAMS 119
129 #define SCTP_RESET_ASSOC 120
130 #define SCTP_ADD_STREAMS 121
131 #define SCTP_SOCKOPT_PEELOFF_FLAGS 122
132 #define SCTP_STREAM_SCHEDULER 123
133 #define SCTP_STREAM_SCHEDULER_VALUE 124
134 #define SCTP_INTERLEAVING_SUPPORTED 125
135 #define SCTP_SENDMSG_CONNECT 126
136 #define SCTP_EVENT 127
137 #define SCTP_ASCONF_SUPPORTED 128
138 #define SCTP_AUTH_SUPPORTED 129
139 #define SCTP_ECN_SUPPORTED 130
141 /* PR-SCTP policies */
142 #define SCTP_PR_SCTP_NONE 0x0000
143 #define SCTP_PR_SCTP_TTL 0x0010
144 #define SCTP_PR_SCTP_RTX 0x0020
145 #define SCTP_PR_SCTP_PRIO 0x0030
146 #define SCTP_PR_SCTP_MAX SCTP_PR_SCTP_PRIO
147 #define SCTP_PR_SCTP_MASK 0x0030
149 #define __SCTP_PR_INDEX(x) ((x >> 4) - 1)
150 #define SCTP_PR_INDEX(x) __SCTP_PR_INDEX(SCTP_PR_SCTP_ ## x)
152 #define SCTP_PR_POLICY(x) ((x) & SCTP_PR_SCTP_MASK)
153 #define SCTP_PR_SET_POLICY(flags, x) \
155 flags &= ~SCTP_PR_SCTP_MASK; \
159 #define SCTP_PR_TTL_ENABLED(x) (SCTP_PR_POLICY(x) == SCTP_PR_SCTP_TTL)
160 #define SCTP_PR_RTX_ENABLED(x) (SCTP_PR_POLICY(x) == SCTP_PR_SCTP_RTX)
161 #define SCTP_PR_PRIO_ENABLED(x) (SCTP_PR_POLICY(x) == SCTP_PR_SCTP_PRIO)
163 /* For enable stream reset */
164 #define SCTP_ENABLE_RESET_STREAM_REQ 0x01
165 #define SCTP_ENABLE_RESET_ASSOC_REQ 0x02
166 #define SCTP_ENABLE_CHANGE_ASSOC_REQ 0x04
167 #define SCTP_ENABLE_STRRESET_MASK 0x07
169 #define SCTP_STREAM_RESET_INCOMING 0x01
170 #define SCTP_STREAM_RESET_OUTGOING 0x02
172 /* These are bit fields for msghdr->msg_flags. See section 5.1. */
173 /* On user space Linux, these live in <bits/socket.h> as an enum. */
174 enum sctp_msg_flags {
175 MSG_NOTIFICATION = 0x8000,
176 #define MSG_NOTIFICATION MSG_NOTIFICATION
179 /* 5.3.1 SCTP Initiation Structure (SCTP_INIT)
181 * This cmsghdr structure provides information for initializing new
182 * SCTP associations with sendmsg(). The SCTP_INITMSG socket option
183 * uses this same data structure. This structure is not used for
186 * cmsg_level cmsg_type cmsg_data[]
187 * ------------ ------------ ----------------------
188 * IPPROTO_SCTP SCTP_INIT struct sctp_initmsg
190 struct sctp_initmsg {
191 __u16 sinit_num_ostreams;
192 __u16 sinit_max_instreams;
193 __u16 sinit_max_attempts;
194 __u16 sinit_max_init_timeo;
197 /* 5.3.2 SCTP Header Information Structure (SCTP_SNDRCV)
199 * This cmsghdr structure specifies SCTP options for sendmsg() and
200 * describes SCTP header information about a received message through
203 * cmsg_level cmsg_type cmsg_data[]
204 * ------------ ------------ ----------------------
205 * IPPROTO_SCTP SCTP_SNDRCV struct sctp_sndrcvinfo
207 struct sctp_sndrcvinfo {
213 __u32 sinfo_timetolive;
216 sctp_assoc_t sinfo_assoc_id;
219 /* 5.3.4 SCTP Send Information Structure (SCTP_SNDINFO)
221 * This cmsghdr structure specifies SCTP options for sendmsg().
223 * cmsg_level cmsg_type cmsg_data[]
224 * ------------ ------------ -------------------
225 * IPPROTO_SCTP SCTP_SNDINFO struct sctp_sndinfo
227 struct sctp_sndinfo {
232 sctp_assoc_t snd_assoc_id;
235 /* 5.3.5 SCTP Receive Information Structure (SCTP_RCVINFO)
237 * This cmsghdr structure describes SCTP receive information
238 * about a received message through recvmsg().
240 * cmsg_level cmsg_type cmsg_data[]
241 * ------------ ------------ -------------------
242 * IPPROTO_SCTP SCTP_RCVINFO struct sctp_rcvinfo
244 struct sctp_rcvinfo {
252 sctp_assoc_t rcv_assoc_id;
255 /* 5.3.6 SCTP Next Receive Information Structure (SCTP_NXTINFO)
257 * This cmsghdr structure describes SCTP receive information
258 * of the next message that will be delivered through recvmsg()
259 * if this information is already available when delivering
260 * the current message.
262 * cmsg_level cmsg_type cmsg_data[]
263 * ------------ ------------ -------------------
264 * IPPROTO_SCTP SCTP_NXTINFO struct sctp_nxtinfo
266 struct sctp_nxtinfo {
271 sctp_assoc_t nxt_assoc_id;
274 /* 5.3.7 SCTP PR-SCTP Information Structure (SCTP_PRINFO)
276 * This cmsghdr structure specifies SCTP options for sendmsg().
278 * cmsg_level cmsg_type cmsg_data[]
279 * ------------ ------------ -------------------
280 * IPPROTO_SCTP SCTP_PRINFO struct sctp_prinfo
287 /* 5.3.8 SCTP AUTH Information Structure (SCTP_AUTHINFO)
289 * This cmsghdr structure specifies SCTP options for sendmsg().
291 * cmsg_level cmsg_type cmsg_data[]
292 * ------------ ------------ -------------------
293 * IPPROTO_SCTP SCTP_AUTHINFO struct sctp_authinfo
295 struct sctp_authinfo {
296 __u16 auth_keynumber;
300 * sinfo_flags: 16 bits (unsigned integer)
302 * This field may contain any of the following flags and is composed of
303 * a bitwise OR of these values.
305 enum sctp_sinfo_flags {
306 SCTP_UNORDERED = (1 << 0), /* Send/receive message unordered. */
307 SCTP_ADDR_OVER = (1 << 1), /* Override the primary destination. */
308 SCTP_ABORT = (1 << 2), /* Send an ABORT message to the peer. */
309 SCTP_SACK_IMMEDIATELY = (1 << 3), /* SACK should be sent without delay. */
310 /* 2 bits here have been used by SCTP_PR_SCTP_MASK */
311 SCTP_SENDALL = (1 << 6),
312 SCTP_PR_SCTP_ALL = (1 << 7),
313 SCTP_NOTIFICATION = MSG_NOTIFICATION, /* Next message is not user msg but notification. */
314 SCTP_EOF = MSG_FIN, /* Initiate graceful shutdown process. */
319 struct sctp_initmsg init;
320 struct sctp_sndrcvinfo sndrcv;
323 /* These are cmsg_types. */
324 typedef enum sctp_cmsg_type {
325 SCTP_INIT, /* 5.2.1 SCTP Initiation Structure */
326 #define SCTP_INIT SCTP_INIT
327 SCTP_SNDRCV, /* 5.2.2 SCTP Header Information Structure */
328 #define SCTP_SNDRCV SCTP_SNDRCV
329 SCTP_SNDINFO, /* 5.3.4 SCTP Send Information Structure */
330 #define SCTP_SNDINFO SCTP_SNDINFO
331 SCTP_RCVINFO, /* 5.3.5 SCTP Receive Information Structure */
332 #define SCTP_RCVINFO SCTP_RCVINFO
333 SCTP_NXTINFO, /* 5.3.6 SCTP Next Receive Information Structure */
334 #define SCTP_NXTINFO SCTP_NXTINFO
335 SCTP_PRINFO, /* 5.3.7 SCTP PR-SCTP Information Structure */
336 #define SCTP_PRINFO SCTP_PRINFO
337 SCTP_AUTHINFO, /* 5.3.8 SCTP AUTH Information Structure */
338 #define SCTP_AUTHINFO SCTP_AUTHINFO
339 SCTP_DSTADDRV4, /* 5.3.9 SCTP Destination IPv4 Address Structure */
340 #define SCTP_DSTADDRV4 SCTP_DSTADDRV4
341 SCTP_DSTADDRV6, /* 5.3.10 SCTP Destination IPv6 Address Structure */
342 #define SCTP_DSTADDRV6 SCTP_DSTADDRV6
346 * 5.3.1.1 SCTP_ASSOC_CHANGE
348 * Communication notifications inform the ULP that an SCTP association
349 * has either begun or ended. The identifier for a new association is
350 * provided by this notificaion. The notification information has the
354 struct sctp_assoc_change {
360 __u16 sac_outbound_streams;
361 __u16 sac_inbound_streams;
362 sctp_assoc_t sac_assoc_id;
367 * sac_state: 32 bits (signed integer)
369 * This field holds one of a number of values that communicate the
370 * event that happened to the association. They include:
372 * Note: The following state names deviate from the API draft as
373 * the names clash too easily with other kernel symbols.
375 enum sctp_sac_state {
384 * 5.3.1.2 SCTP_PEER_ADDR_CHANGE
386 * When a destination address on a multi-homed peer encounters a change
387 * an interface details event is sent. The information has the
388 * following structure:
390 struct sctp_paddr_change {
394 struct sockaddr_storage spc_aaddr;
397 sctp_assoc_t spc_assoc_id;
398 } __attribute__((packed, aligned(4)));
401 * spc_state: 32 bits (signed integer)
403 * This field holds one of a number of values that communicate the
404 * event that happened to the address. They include:
406 enum sctp_spc_state {
408 SCTP_ADDR_UNREACHABLE,
417 * 5.3.1.3 SCTP_REMOTE_ERROR
419 * A remote peer may send an Operational Error message to its peer.
420 * This message indicates a variety of error conditions on an
421 * association. The entire error TLV as it appears on the wire is
422 * included in a SCTP_REMOTE_ERROR event. Please refer to the SCTP
423 * specification [SCTP] and any extensions for a list of possible
424 * error formats. SCTP error TLVs have the format:
426 struct sctp_remote_error {
431 sctp_assoc_t sre_assoc_id;
437 * 5.3.1.4 SCTP_SEND_FAILED
439 * If SCTP cannot deliver a message it may return the message as a
442 struct sctp_send_failed {
447 struct sctp_sndrcvinfo ssf_info;
448 sctp_assoc_t ssf_assoc_id;
453 * ssf_flags: 16 bits (unsigned integer)
455 * The flag value will take one of the following values
457 * SCTP_DATA_UNSENT - Indicates that the data was never put on
460 * SCTP_DATA_SENT - Indicates that the data was put on the wire.
461 * Note that this does not necessarily mean that the
462 * data was (or was not) successfully delivered.
464 enum sctp_ssf_flags {
470 * 5.3.1.5 SCTP_SHUTDOWN_EVENT
472 * When a peer sends a SHUTDOWN, SCTP delivers this notification to
473 * inform the application that it should cease sending data.
475 struct sctp_shutdown_event {
479 sctp_assoc_t sse_assoc_id;
483 * 5.3.1.6 SCTP_ADAPTATION_INDICATION
485 * When a peer sends a Adaptation Layer Indication parameter , SCTP
486 * delivers this notification to inform the application
487 * that of the peers requested adaptation layer.
489 struct sctp_adaptation_event {
493 __u32 sai_adaptation_ind;
494 sctp_assoc_t sai_assoc_id;
498 * 5.3.1.7 SCTP_PARTIAL_DELIVERY_EVENT
500 * When a receiver is engaged in a partial delivery of a
501 * message this notification will be used to indicate
504 struct sctp_pdapi_event {
508 __u32 pdapi_indication;
509 sctp_assoc_t pdapi_assoc_id;
514 enum { SCTP_PARTIAL_DELIVERY_ABORTED=0, };
517 * 5.3.1.8. SCTP_AUTHENTICATION_EVENT
519 * When a receiver is using authentication this message will provide
520 * notifications regarding new keys being made active as well as errors.
522 struct sctp_authkey_event {
526 __u16 auth_keynumber;
527 __u16 auth_altkeynumber;
528 __u32 auth_indication;
529 sctp_assoc_t auth_assoc_id;
534 #define SCTP_AUTH_NEWKEY SCTP_AUTH_NEW_KEY /* compatible with before */
540 * 6.1.9. SCTP_SENDER_DRY_EVENT
542 * When the SCTP stack has no more user data to send or retransmit, this
543 * notification is given to the user. Also, at the time when a user app
544 * subscribes to this event, if there is no data to be sent or
545 * retransmit, the stack will immediately send up this notification.
547 struct sctp_sender_dry_event {
548 __u16 sender_dry_type;
549 __u16 sender_dry_flags;
550 __u32 sender_dry_length;
551 sctp_assoc_t sender_dry_assoc_id;
554 #define SCTP_STREAM_RESET_INCOMING_SSN 0x0001
555 #define SCTP_STREAM_RESET_OUTGOING_SSN 0x0002
556 #define SCTP_STREAM_RESET_DENIED 0x0004
557 #define SCTP_STREAM_RESET_FAILED 0x0008
558 struct sctp_stream_reset_event {
560 __u16 strreset_flags;
561 __u32 strreset_length;
562 sctp_assoc_t strreset_assoc_id;
563 __u16 strreset_stream_list[];
566 #define SCTP_ASSOC_RESET_DENIED 0x0004
567 #define SCTP_ASSOC_RESET_FAILED 0x0008
568 struct sctp_assoc_reset_event {
569 __u16 assocreset_type;
570 __u16 assocreset_flags;
571 __u32 assocreset_length;
572 sctp_assoc_t assocreset_assoc_id;
573 __u32 assocreset_local_tsn;
574 __u32 assocreset_remote_tsn;
577 #define SCTP_ASSOC_CHANGE_DENIED 0x0004
578 #define SCTP_ASSOC_CHANGE_FAILED 0x0008
579 #define SCTP_STREAM_CHANGE_DENIED SCTP_ASSOC_CHANGE_DENIED
580 #define SCTP_STREAM_CHANGE_FAILED SCTP_ASSOC_CHANGE_FAILED
581 struct sctp_stream_change_event {
582 __u16 strchange_type;
583 __u16 strchange_flags;
584 __u32 strchange_length;
585 sctp_assoc_t strchange_assoc_id;
586 __u16 strchange_instrms;
587 __u16 strchange_outstrms;
591 * Described in Section 7.3
592 * Ancillary Data and Notification Interest Options
594 struct sctp_event_subscribe {
595 __u8 sctp_data_io_event;
596 __u8 sctp_association_event;
597 __u8 sctp_address_event;
598 __u8 sctp_send_failure_event;
599 __u8 sctp_peer_error_event;
600 __u8 sctp_shutdown_event;
601 __u8 sctp_partial_delivery_event;
602 __u8 sctp_adaptation_layer_event;
603 __u8 sctp_authentication_event;
604 __u8 sctp_sender_dry_event;
605 __u8 sctp_stream_reset_event;
606 __u8 sctp_assoc_reset_event;
607 __u8 sctp_stream_change_event;
611 * 5.3.1 SCTP Notification Structure
613 * The notification structure is defined as the union of all
614 * notification types.
617 union sctp_notification {
619 __u16 sn_type; /* Notification type. */
623 struct sctp_assoc_change sn_assoc_change;
624 struct sctp_paddr_change sn_paddr_change;
625 struct sctp_remote_error sn_remote_error;
626 struct sctp_send_failed sn_send_failed;
627 struct sctp_shutdown_event sn_shutdown_event;
628 struct sctp_adaptation_event sn_adaptation_event;
629 struct sctp_pdapi_event sn_pdapi_event;
630 struct sctp_authkey_event sn_authkey_event;
631 struct sctp_sender_dry_event sn_sender_dry_event;
632 struct sctp_stream_reset_event sn_strreset_event;
633 struct sctp_assoc_reset_event sn_assocreset_event;
634 struct sctp_stream_change_event sn_strchange_event;
638 * All standard values for sn_type flags are greater than 2^15.
639 * Values from 2^15 and down are reserved.
643 SCTP_SN_TYPE_BASE = (1<<15),
644 SCTP_DATA_IO_EVENT = SCTP_SN_TYPE_BASE,
645 #define SCTP_DATA_IO_EVENT SCTP_DATA_IO_EVENT
647 #define SCTP_ASSOC_CHANGE SCTP_ASSOC_CHANGE
648 SCTP_PEER_ADDR_CHANGE,
649 #define SCTP_PEER_ADDR_CHANGE SCTP_PEER_ADDR_CHANGE
651 #define SCTP_SEND_FAILED SCTP_SEND_FAILED
653 #define SCTP_REMOTE_ERROR SCTP_REMOTE_ERROR
655 #define SCTP_SHUTDOWN_EVENT SCTP_SHUTDOWN_EVENT
656 SCTP_PARTIAL_DELIVERY_EVENT,
657 #define SCTP_PARTIAL_DELIVERY_EVENT SCTP_PARTIAL_DELIVERY_EVENT
658 SCTP_ADAPTATION_INDICATION,
659 #define SCTP_ADAPTATION_INDICATION SCTP_ADAPTATION_INDICATION
660 SCTP_AUTHENTICATION_EVENT,
661 #define SCTP_AUTHENTICATION_INDICATION SCTP_AUTHENTICATION_EVENT
662 SCTP_SENDER_DRY_EVENT,
663 #define SCTP_SENDER_DRY_EVENT SCTP_SENDER_DRY_EVENT
664 SCTP_STREAM_RESET_EVENT,
665 #define SCTP_STREAM_RESET_EVENT SCTP_STREAM_RESET_EVENT
666 SCTP_ASSOC_RESET_EVENT,
667 #define SCTP_ASSOC_RESET_EVENT SCTP_ASSOC_RESET_EVENT
668 SCTP_STREAM_CHANGE_EVENT,
669 #define SCTP_STREAM_CHANGE_EVENT SCTP_STREAM_CHANGE_EVENT
670 SCTP_SN_TYPE_MAX = SCTP_STREAM_CHANGE_EVENT,
671 #define SCTP_SN_TYPE_MAX SCTP_SN_TYPE_MAX
674 /* Notification error codes used to fill up the error fields in some
676 * SCTP_PEER_ADDRESS_CHAGE : spc_error
677 * SCTP_ASSOC_CHANGE : sac_error
678 * These names should be potentially included in the draft 04 of the SCTP
679 * sockets API specification.
681 typedef enum sctp_sn_error {
682 SCTP_FAILED_THRESHOLD,
684 SCTP_HEARTBEAT_SUCCESS,
685 SCTP_RESPONSE_TO_USER_REQ,
687 SCTP_SHUTDOWN_GUARD_EXPIRES,
692 * 7.1.1 Retransmission Timeout Parameters (SCTP_RTOINFO)
694 * The protocol parameters used to initialize and bound retransmission
695 * timeout (RTO) are tunable. See [SCTP] for more information on how
696 * these parameters are used in RTO calculation.
698 struct sctp_rtoinfo {
699 sctp_assoc_t srto_assoc_id;
706 * 7.1.2 Association Parameters (SCTP_ASSOCINFO)
708 * This option is used to both examine and set various association and
709 * endpoint parameters.
711 struct sctp_assocparams {
712 sctp_assoc_t sasoc_assoc_id;
713 __u16 sasoc_asocmaxrxt;
714 __u16 sasoc_number_peer_destinations;
715 __u32 sasoc_peer_rwnd;
716 __u32 sasoc_local_rwnd;
717 __u32 sasoc_cookie_life;
721 * 7.1.9 Set Peer Primary Address (SCTP_SET_PEER_PRIMARY_ADDR)
723 * Requests that the peer mark the enclosed address as the association
724 * primary. The enclosed address must be one of the association's
725 * locally bound addresses. The following structure is used to make a
726 * set primary request:
728 struct sctp_setpeerprim {
729 sctp_assoc_t sspp_assoc_id;
730 struct sockaddr_storage sspp_addr;
731 } __attribute__((packed, aligned(4)));
734 * 7.1.10 Set Primary Address (SCTP_PRIMARY_ADDR)
736 * Requests that the local SCTP stack use the enclosed peer address as
737 * the association primary. The enclosed address must be one of the
738 * association peer's addresses. The following structure is used to
739 * make a set peer primary request:
742 sctp_assoc_t ssp_assoc_id;
743 struct sockaddr_storage ssp_addr;
744 } __attribute__((packed, aligned(4)));
746 /* For backward compatibility use, define the old name too */
747 #define sctp_setprim sctp_prim
750 * 7.1.11 Set Adaptation Layer Indicator (SCTP_ADAPTATION_LAYER)
752 * Requests that the local endpoint set the specified Adaptation Layer
753 * Indication parameter for all future INIT and INIT-ACK exchanges.
755 struct sctp_setadaptation {
756 __u32 ssb_adaptation_ind;
760 * 7.1.13 Peer Address Parameters (SCTP_PEER_ADDR_PARAMS)
762 * Applications can enable or disable heartbeats for any peer address
763 * of an association, modify an address's heartbeat interval, force a
764 * heartbeat to be sent immediately, and adjust the address's maximum
765 * number of retransmissions sent before an address is considered
766 * unreachable. The following structure is used to access and modify an
767 * address's parameters:
769 enum sctp_spp_flags {
770 SPP_HB_ENABLE = 1<<0, /*Enable heartbeats*/
771 SPP_HB_DISABLE = 1<<1, /*Disable heartbeats*/
772 SPP_HB = SPP_HB_ENABLE | SPP_HB_DISABLE,
773 SPP_HB_DEMAND = 1<<2, /*Send heartbeat immediately*/
774 SPP_PMTUD_ENABLE = 1<<3, /*Enable PMTU discovery*/
775 SPP_PMTUD_DISABLE = 1<<4, /*Disable PMTU discovery*/
776 SPP_PMTUD = SPP_PMTUD_ENABLE | SPP_PMTUD_DISABLE,
777 SPP_SACKDELAY_ENABLE = 1<<5, /*Enable SACK*/
778 SPP_SACKDELAY_DISABLE = 1<<6, /*Disable SACK*/
779 SPP_SACKDELAY = SPP_SACKDELAY_ENABLE | SPP_SACKDELAY_DISABLE,
780 SPP_HB_TIME_IS_ZERO = 1<<7, /* Set HB delay to 0 */
781 SPP_IPV6_FLOWLABEL = 1<<8,
785 struct sctp_paddrparams {
786 sctp_assoc_t spp_assoc_id;
787 struct sockaddr_storage spp_address;
788 __u32 spp_hbinterval;
789 __u16 spp_pathmaxrxt;
793 __u32 spp_ipv6_flowlabel;
795 } __attribute__((packed, aligned(4)));
798 * 7.1.18. Add a chunk that must be authenticated (SCTP_AUTH_CHUNK)
800 * This set option adds a chunk type that the user is requesting to be
801 * received only in an authenticated way. Changes to the list of chunks
802 * will only effect future associations on the socket.
804 struct sctp_authchunk {
809 * 7.1.19. Get or set the list of supported HMAC Identifiers (SCTP_HMAC_IDENT)
811 * This option gets or sets the list of HMAC algorithms that the local
812 * endpoint requires the peer to use.
815 /* This here is only used by user space as is. It might not be a good idea
816 * to export/reveal the whole structure with reserved fields etc.
819 SCTP_AUTH_HMAC_ID_SHA1 = 1,
820 SCTP_AUTH_HMAC_ID_SHA256 = 3,
824 struct sctp_hmacalgo {
825 __u32 shmac_num_idents;
826 __u16 shmac_idents[];
829 /* Sadly, user and kernel space have different names for
830 * this structure member, so this is to not break anything.
832 #define shmac_number_of_idents shmac_num_idents
835 * 7.1.20. Set a shared key (SCTP_AUTH_KEY)
837 * This option will set a shared secret key which is used to build an
838 * association shared key.
840 struct sctp_authkey {
841 sctp_assoc_t sca_assoc_id;
848 * 7.1.21. Get or set the active shared key (SCTP_AUTH_ACTIVE_KEY)
850 * This option will get or set the active shared key to be used to build
851 * the association shared key.
854 struct sctp_authkeyid {
855 sctp_assoc_t scact_assoc_id;
856 __u16 scact_keynumber;
861 * 7.1.23. Get or set delayed ack timer (SCTP_DELAYED_SACK)
863 * This option will effect the way delayed acks are performed. This
864 * option allows you to get or set the delayed ack time, in
865 * milliseconds. It also allows changing the delayed ack frequency.
866 * Changing the frequency to 1 disables the delayed sack algorithm. If
867 * the assoc_id is 0, then this sets or gets the endpoints default
868 * values. If the assoc_id field is non-zero, then the set or get
869 * effects the specified association for the one to many model (the
870 * assoc_id field is ignored by the one to one model). Note that if
871 * sack_delay or sack_freq are 0 when setting this option, then the
872 * current values will remain unchanged.
874 struct sctp_sack_info {
875 sctp_assoc_t sack_assoc_id;
880 struct sctp_assoc_value {
881 sctp_assoc_t assoc_id;
882 uint32_t assoc_value;
885 struct sctp_stream_value {
886 sctp_assoc_t assoc_id;
888 uint16_t stream_value;
892 * 7.2.2 Peer Address Information
894 * Applications can retrieve information about a specific peer address
895 * of an association, including its reachability state, congestion
896 * window, and retransmission timer values. This information is
897 * read-only. The following structure is used to access this
900 struct sctp_paddrinfo {
901 sctp_assoc_t spinfo_assoc_id;
902 struct sockaddr_storage spinfo_address;
908 } __attribute__((packed, aligned(4)));
910 /* Peer addresses's state. */
911 /* UNKNOWN: Peer address passed by the upper layer in sendmsg or connect[x]
913 * UNCONFIRMED: Peer address received in INIT/INIT-ACK address parameters.
914 * Not yet confirmed by a heartbeat and not available for data
916 * ACTIVE : Peer address confirmed, active and available for data transfers.
917 * INACTIVE: Peer address inactive and not available for data transfers.
919 enum sctp_spinfo_state {
924 SCTP_UNKNOWN = 0xffff /* Value used for transport state unknown */
928 * 7.2.1 Association Status (SCTP_STATUS)
930 * Applications can retrieve current status information about an
931 * association, including association state, peer receiver window size,
932 * number of unacked data chunks, and number of data chunks pending
933 * receipt. This information is read-only. The following structure is
934 * used to access this information:
937 sctp_assoc_t sstat_assoc_id;
940 __u16 sstat_unackdata;
941 __u16 sstat_penddata;
943 __u16 sstat_outstrms;
944 __u32 sstat_fragmentation_point;
945 struct sctp_paddrinfo sstat_primary;
949 * 7.2.3. Get the list of chunks the peer requires to be authenticated
950 * (SCTP_PEER_AUTH_CHUNKS)
952 * This option gets a list of chunks for a specified association that
953 * the peer requires to be received authenticated only.
955 struct sctp_authchunks {
956 sctp_assoc_t gauth_assoc_id;
957 __u32 gauth_number_of_chunks;
958 uint8_t gauth_chunks[];
961 /* The broken spelling has been released already in lksctp-tools header,
962 * so don't break anyone, now that it's fixed.
964 #define guth_number_of_chunks gauth_number_of_chunks
966 /* Association states. */
967 enum sctp_sstat_state {
970 SCTP_COOKIE_WAIT = 2,
971 SCTP_COOKIE_ECHOED = 3,
972 SCTP_ESTABLISHED = 4,
973 SCTP_SHUTDOWN_PENDING = 5,
974 SCTP_SHUTDOWN_SENT = 6,
975 SCTP_SHUTDOWN_RECEIVED = 7,
976 SCTP_SHUTDOWN_ACK_SENT = 8,
980 * 8.2.6. Get the Current Identifiers of Associations
981 * (SCTP_GET_ASSOC_ID_LIST)
983 * This option gets the current list of SCTP association identifiers of
984 * the SCTP associations handled by a one-to-many style socket.
986 struct sctp_assoc_ids {
987 __u32 gaids_number_of_ids;
988 sctp_assoc_t gaids_assoc_id[];
992 * 8.3, 8.5 get all peer/local addresses in an association.
993 * This parameter struct is used by SCTP_GET_PEER_ADDRS and
994 * SCTP_GET_LOCAL_ADDRS socket options used internally to implement
995 * sctp_getpaddrs() and sctp_getladdrs() API.
997 struct sctp_getaddrs_old {
998 sctp_assoc_t assoc_id;
1001 struct sockaddr __user *addrs;
1003 struct sockaddr *addrs;
1007 struct sctp_getaddrs {
1008 sctp_assoc_t assoc_id; /*input*/
1009 __u32 addr_num; /*output*/
1010 __u8 addrs[0]; /*output, variable size*/
1013 /* A socket user request obtained via SCTP_GET_ASSOC_STATS that retrieves
1014 * association stats. All stats are counts except sas_maxrto and
1015 * sas_obs_rto_ipaddr. maxrto is the max observed rto + transport since
1016 * the last call. Will return 0 when RTO was not update since last call
1018 struct sctp_assoc_stats {
1019 sctp_assoc_t sas_assoc_id; /* Input */
1020 /* Transport of observed max RTO */
1021 struct sockaddr_storage sas_obs_rto_ipaddr;
1022 __u64 sas_maxrto; /* Maximum Observed RTO for period */
1023 __u64 sas_isacks; /* SACKs received */
1024 __u64 sas_osacks; /* SACKs sent */
1025 __u64 sas_opackets; /* Packets sent */
1026 __u64 sas_ipackets; /* Packets received */
1027 __u64 sas_rtxchunks; /* Retransmitted Chunks */
1028 __u64 sas_outofseqtsns;/* TSN received > next expected */
1029 __u64 sas_idupchunks; /* Dups received (ordered+unordered) */
1030 __u64 sas_gapcnt; /* Gap Acknowledgements Received */
1031 __u64 sas_ouodchunks; /* Unordered data chunks sent */
1032 __u64 sas_iuodchunks; /* Unordered data chunks received */
1033 __u64 sas_oodchunks; /* Ordered data chunks sent */
1034 __u64 sas_iodchunks; /* Ordered data chunks received */
1035 __u64 sas_octrlchunks; /* Control chunks sent */
1036 __u64 sas_ictrlchunks; /* Control chunks received */
1042 * The flags parameter is formed from the bitwise OR of zero or more of the
1043 * following currently defined flags:
1045 #define SCTP_BINDX_ADD_ADDR 0x01
1046 #define SCTP_BINDX_REM_ADDR 0x02
1048 /* This is the structure that is passed as an argument(optval) to
1049 * getsockopt(SCTP_SOCKOPT_PEELOFF).
1052 sctp_assoc_t associd;
1054 } sctp_peeloff_arg_t;
1057 sctp_peeloff_arg_t p_arg;
1059 } sctp_peeloff_flags_arg_t;
1062 * Peer Address Thresholds socket option
1064 struct sctp_paddrthlds {
1065 sctp_assoc_t spt_assoc_id;
1066 struct sockaddr_storage spt_address;
1067 __u16 spt_pathmaxrxt;
1068 __u16 spt_pathpfthld;
1072 * Socket Option for Getting the Association/Stream-Specific PR-SCTP Status
1074 struct sctp_prstatus {
1075 sctp_assoc_t sprstat_assoc_id;
1077 __u16 sprstat_policy;
1078 __u64 sprstat_abandoned_unsent;
1079 __u64 sprstat_abandoned_sent;
1082 struct sctp_default_prinfo {
1083 sctp_assoc_t pr_assoc_id;
1092 __u16 sctpi_unackdata;
1093 __u16 sctpi_penddata;
1094 __u16 sctpi_instrms;
1095 __u16 sctpi_outstrms;
1096 __u32 sctpi_fragmentation_point;
1097 __u32 sctpi_inqueue;
1098 __u32 sctpi_outqueue;
1099 __u32 sctpi_overall_error;
1100 __u32 sctpi_max_burst;
1102 __u32 sctpi_peer_rwnd;
1103 __u32 sctpi_peer_tag;
1104 __u8 sctpi_peer_capable;
1105 __u8 sctpi_peer_sack;
1108 /* assoc status info */
1111 __u64 sctpi_opackets;
1112 __u64 sctpi_ipackets;
1113 __u64 sctpi_rtxchunks;
1114 __u64 sctpi_outofseqtsns;
1115 __u64 sctpi_idupchunks;
1117 __u64 sctpi_ouodchunks;
1118 __u64 sctpi_iuodchunks;
1119 __u64 sctpi_oodchunks;
1120 __u64 sctpi_iodchunks;
1121 __u64 sctpi_octrlchunks;
1122 __u64 sctpi_ictrlchunks;
1124 /* primary transport info */
1125 struct sockaddr_storage sctpi_p_address;
1126 __s32 sctpi_p_state;
1130 __u32 sctpi_p_hbinterval;
1131 __u32 sctpi_p_pathmaxrxt;
1132 __u32 sctpi_p_sackdelay;
1133 __u32 sctpi_p_sackfreq;
1134 __u32 sctpi_p_ssthresh;
1135 __u32 sctpi_p_partial_bytes_acked;
1136 __u32 sctpi_p_flight_size;
1137 __u16 sctpi_p_error;
1140 /* sctp sock info */
1141 __u32 sctpi_s_autoclose;
1142 __u32 sctpi_s_adaptation_ind;
1143 __u32 sctpi_s_pd_point;
1144 __u8 sctpi_s_nodelay;
1145 __u8 sctpi_s_disable_fragments;
1146 __u8 sctpi_s_v4mapped;
1147 __u8 sctpi_s_frag_interleave;
1152 struct sctp_reset_streams {
1153 sctp_assoc_t srs_assoc_id;
1155 uint16_t srs_number_streams; /* 0 == ALL */
1156 uint16_t srs_stream_list[]; /* list if srs_num_streams is not 0 */
1159 struct sctp_add_streams {
1160 sctp_assoc_t sas_assoc_id;
1161 uint16_t sas_instrms;
1162 uint16_t sas_outstrms;
1166 sctp_assoc_t se_assoc_id;
1171 /* SCTP Stream schedulers */
1172 enum sctp_sched_type {
1174 SCTP_SS_DEFAULT = SCTP_SS_FCFS,
1177 SCTP_SS_MAX = SCTP_SS_RR
1180 #endif /* _UAPI_SCTP_H */