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 /* The following symbols come from the Sockets API Extensions for
63 * SCTP <draft-ietf-tsvwg-sctpsocket-07.txt>.
65 #define SCTP_RTOINFO 0
66 #define SCTP_ASSOCINFO 1
67 #define SCTP_INITMSG 2
68 #define SCTP_NODELAY 3 /* Get/set nodelay option. */
69 #define SCTP_AUTOCLOSE 4
70 #define SCTP_SET_PEER_PRIMARY_ADDR 5
71 #define SCTP_PRIMARY_ADDR 6
72 #define SCTP_ADAPTATION_LAYER 7
73 #define SCTP_DISABLE_FRAGMENTS 8
74 #define SCTP_PEER_ADDR_PARAMS 9
75 #define SCTP_DEFAULT_SEND_PARAM 10
76 #define SCTP_EVENTS 11
77 #define SCTP_I_WANT_MAPPED_V4_ADDR 12 /* Turn on/off mapped v4 addresses */
78 #define SCTP_MAXSEG 13 /* Get/set maximum fragment. */
79 #define SCTP_STATUS 14
80 #define SCTP_GET_PEER_ADDR_INFO 15
81 #define SCTP_DELAYED_ACK_TIME 16
82 #define SCTP_DELAYED_ACK SCTP_DELAYED_ACK_TIME
83 #define SCTP_DELAYED_SACK SCTP_DELAYED_ACK_TIME
84 #define SCTP_CONTEXT 17
85 #define SCTP_FRAGMENT_INTERLEAVE 18
86 #define SCTP_PARTIAL_DELIVERY_POINT 19 /* Set/Get partial delivery point */
87 #define SCTP_MAX_BURST 20 /* Set/Get max burst */
88 #define SCTP_AUTH_CHUNK 21 /* Set only: add a chunk type to authenticate */
89 #define SCTP_HMAC_IDENT 22
90 #define SCTP_AUTH_KEY 23
91 #define SCTP_AUTH_ACTIVE_KEY 24
92 #define SCTP_AUTH_DELETE_KEY 25
93 #define SCTP_PEER_AUTH_CHUNKS 26 /* Read only */
94 #define SCTP_LOCAL_AUTH_CHUNKS 27 /* Read only */
95 #define SCTP_GET_ASSOC_NUMBER 28 /* Read only */
96 #define SCTP_GET_ASSOC_ID_LIST 29 /* Read only */
97 #define SCTP_AUTO_ASCONF 30
98 #define SCTP_PEER_ADDR_THLDS 31
99 #define SCTP_RECVRCVINFO 32
100 #define SCTP_RECVNXTINFO 33
101 #define SCTP_DEFAULT_SNDINFO 34
103 /* Internal Socket Options. Some of the sctp library functions are
104 * implemented using these socket options.
106 #define SCTP_SOCKOPT_BINDX_ADD 100 /* BINDX requests for adding addrs */
107 #define SCTP_SOCKOPT_BINDX_REM 101 /* BINDX requests for removing addrs. */
108 #define SCTP_SOCKOPT_PEELOFF 102 /* peel off association. */
109 /* Options 104-106 are deprecated and removed. Do not use this space */
110 #define SCTP_SOCKOPT_CONNECTX_OLD 107 /* CONNECTX old requests. */
111 #define SCTP_GET_PEER_ADDRS 108 /* Get all peer address. */
112 #define SCTP_GET_LOCAL_ADDRS 109 /* Get all local address. */
113 #define SCTP_SOCKOPT_CONNECTX 110 /* CONNECTX requests. */
114 #define SCTP_SOCKOPT_CONNECTX3 111 /* CONNECTX requests (updated) */
115 #define SCTP_GET_ASSOC_STATS 112 /* Read only */
116 #define SCTP_PR_SUPPORTED 113
117 #define SCTP_DEFAULT_PRINFO 114
118 #define SCTP_PR_ASSOC_STATUS 115
119 #define SCTP_PR_STREAM_STATUS 116
120 #define SCTP_RECONFIG_SUPPORTED 117
121 #define SCTP_ENABLE_STREAM_RESET 118
122 #define SCTP_RESET_STREAMS 119
123 #define SCTP_RESET_ASSOC 120
124 #define SCTP_ADD_STREAMS 121
125 #define SCTP_SOCKOPT_PEELOFF_FLAGS 122
126 #define SCTP_STREAM_SCHEDULER 123
127 #define SCTP_STREAM_SCHEDULER_VALUE 124
128 #define SCTP_INTERLEAVING_SUPPORTED 125
130 /* PR-SCTP policies */
131 #define SCTP_PR_SCTP_NONE 0x0000
132 #define SCTP_PR_SCTP_TTL 0x0010
133 #define SCTP_PR_SCTP_RTX 0x0020
134 #define SCTP_PR_SCTP_PRIO 0x0030
135 #define SCTP_PR_SCTP_MAX SCTP_PR_SCTP_PRIO
136 #define SCTP_PR_SCTP_MASK 0x0030
138 #define __SCTP_PR_INDEX(x) ((x >> 4) - 1)
139 #define SCTP_PR_INDEX(x) __SCTP_PR_INDEX(SCTP_PR_SCTP_ ## x)
141 #define SCTP_PR_POLICY(x) ((x) & SCTP_PR_SCTP_MASK)
142 #define SCTP_PR_SET_POLICY(flags, x) \
144 flags &= ~SCTP_PR_SCTP_MASK; \
148 #define SCTP_PR_TTL_ENABLED(x) (SCTP_PR_POLICY(x) == SCTP_PR_SCTP_TTL)
149 #define SCTP_PR_RTX_ENABLED(x) (SCTP_PR_POLICY(x) == SCTP_PR_SCTP_RTX)
150 #define SCTP_PR_PRIO_ENABLED(x) (SCTP_PR_POLICY(x) == SCTP_PR_SCTP_PRIO)
152 /* For enable stream reset */
153 #define SCTP_ENABLE_RESET_STREAM_REQ 0x01
154 #define SCTP_ENABLE_RESET_ASSOC_REQ 0x02
155 #define SCTP_ENABLE_CHANGE_ASSOC_REQ 0x04
156 #define SCTP_ENABLE_STRRESET_MASK 0x07
158 #define SCTP_STREAM_RESET_INCOMING 0x01
159 #define SCTP_STREAM_RESET_OUTGOING 0x02
161 /* These are bit fields for msghdr->msg_flags. See section 5.1. */
162 /* On user space Linux, these live in <bits/socket.h> as an enum. */
163 enum sctp_msg_flags {
164 MSG_NOTIFICATION = 0x8000,
165 #define MSG_NOTIFICATION MSG_NOTIFICATION
168 /* 5.3.1 SCTP Initiation Structure (SCTP_INIT)
170 * This cmsghdr structure provides information for initializing new
171 * SCTP associations with sendmsg(). The SCTP_INITMSG socket option
172 * uses this same data structure. This structure is not used for
175 * cmsg_level cmsg_type cmsg_data[]
176 * ------------ ------------ ----------------------
177 * IPPROTO_SCTP SCTP_INIT struct sctp_initmsg
179 struct sctp_initmsg {
180 __u16 sinit_num_ostreams;
181 __u16 sinit_max_instreams;
182 __u16 sinit_max_attempts;
183 __u16 sinit_max_init_timeo;
186 /* 5.3.2 SCTP Header Information Structure (SCTP_SNDRCV)
188 * This cmsghdr structure specifies SCTP options for sendmsg() and
189 * describes SCTP header information about a received message through
192 * cmsg_level cmsg_type cmsg_data[]
193 * ------------ ------------ ----------------------
194 * IPPROTO_SCTP SCTP_SNDRCV struct sctp_sndrcvinfo
196 struct sctp_sndrcvinfo {
202 __u32 sinfo_timetolive;
205 sctp_assoc_t sinfo_assoc_id;
208 /* 5.3.4 SCTP Send Information Structure (SCTP_SNDINFO)
210 * This cmsghdr structure specifies SCTP options for sendmsg().
212 * cmsg_level cmsg_type cmsg_data[]
213 * ------------ ------------ -------------------
214 * IPPROTO_SCTP SCTP_SNDINFO struct sctp_sndinfo
216 struct sctp_sndinfo {
221 sctp_assoc_t snd_assoc_id;
224 /* 5.3.5 SCTP Receive Information Structure (SCTP_RCVINFO)
226 * This cmsghdr structure describes SCTP receive information
227 * about a received message through recvmsg().
229 * cmsg_level cmsg_type cmsg_data[]
230 * ------------ ------------ -------------------
231 * IPPROTO_SCTP SCTP_RCVINFO struct sctp_rcvinfo
233 struct sctp_rcvinfo {
241 sctp_assoc_t rcv_assoc_id;
244 /* 5.3.6 SCTP Next Receive Information Structure (SCTP_NXTINFO)
246 * This cmsghdr structure describes SCTP receive information
247 * of the next message that will be delivered through recvmsg()
248 * if this information is already available when delivering
249 * the current message.
251 * cmsg_level cmsg_type cmsg_data[]
252 * ------------ ------------ -------------------
253 * IPPROTO_SCTP SCTP_NXTINFO struct sctp_nxtinfo
255 struct sctp_nxtinfo {
260 sctp_assoc_t nxt_assoc_id;
263 /* 5.3.7 SCTP PR-SCTP Information Structure (SCTP_PRINFO)
265 * This cmsghdr structure specifies SCTP options for sendmsg().
267 * cmsg_level cmsg_type cmsg_data[]
268 * ------------ ------------ -------------------
269 * IPPROTO_SCTP SCTP_PRINFO struct sctp_prinfo
277 * sinfo_flags: 16 bits (unsigned integer)
279 * This field may contain any of the following flags and is composed of
280 * a bitwise OR of these values.
282 enum sctp_sinfo_flags {
283 SCTP_UNORDERED = (1 << 0), /* Send/receive message unordered. */
284 SCTP_ADDR_OVER = (1 << 1), /* Override the primary destination. */
285 SCTP_ABORT = (1 << 2), /* Send an ABORT message to the peer. */
286 SCTP_SACK_IMMEDIATELY = (1 << 3), /* SACK should be sent without delay. */
287 SCTP_NOTIFICATION = MSG_NOTIFICATION, /* Next message is not user msg but notification. */
288 SCTP_EOF = MSG_FIN, /* Initiate graceful shutdown process. */
293 struct sctp_initmsg init;
294 struct sctp_sndrcvinfo sndrcv;
297 /* These are cmsg_types. */
298 typedef enum sctp_cmsg_type {
299 SCTP_INIT, /* 5.2.1 SCTP Initiation Structure */
300 #define SCTP_INIT SCTP_INIT
301 SCTP_SNDRCV, /* 5.2.2 SCTP Header Information Structure */
302 #define SCTP_SNDRCV SCTP_SNDRCV
303 SCTP_SNDINFO, /* 5.3.4 SCTP Send Information Structure */
304 #define SCTP_SNDINFO SCTP_SNDINFO
305 SCTP_RCVINFO, /* 5.3.5 SCTP Receive Information Structure */
306 #define SCTP_RCVINFO SCTP_RCVINFO
307 SCTP_NXTINFO, /* 5.3.6 SCTP Next Receive Information Structure */
308 #define SCTP_NXTINFO SCTP_NXTINFO
309 SCTP_PRINFO, /* 5.3.7 SCTP PR-SCTP Information Structure */
310 #define SCTP_PRINFO SCTP_PRINFO
311 SCTP_AUTHINFO, /* 5.3.8 SCTP AUTH Information Structure (RESERVED) */
312 #define SCTP_AUTHINFO SCTP_AUTHINFO
313 SCTP_DSTADDRV4, /* 5.3.9 SCTP Destination IPv4 Address Structure */
314 #define SCTP_DSTADDRV4 SCTP_DSTADDRV4
315 SCTP_DSTADDRV6, /* 5.3.10 SCTP Destination IPv6 Address Structure */
316 #define SCTP_DSTADDRV6 SCTP_DSTADDRV6
320 * 5.3.1.1 SCTP_ASSOC_CHANGE
322 * Communication notifications inform the ULP that an SCTP association
323 * has either begun or ended. The identifier for a new association is
324 * provided by this notificaion. The notification information has the
328 struct sctp_assoc_change {
334 __u16 sac_outbound_streams;
335 __u16 sac_inbound_streams;
336 sctp_assoc_t sac_assoc_id;
341 * sac_state: 32 bits (signed integer)
343 * This field holds one of a number of values that communicate the
344 * event that happened to the association. They include:
346 * Note: The following state names deviate from the API draft as
347 * the names clash too easily with other kernel symbols.
349 enum sctp_sac_state {
358 * 5.3.1.2 SCTP_PEER_ADDR_CHANGE
360 * When a destination address on a multi-homed peer encounters a change
361 * an interface details event is sent. The information has the
362 * following structure:
364 struct sctp_paddr_change {
368 struct sockaddr_storage spc_aaddr;
371 sctp_assoc_t spc_assoc_id;
372 } __attribute__((packed, aligned(4)));
375 * spc_state: 32 bits (signed integer)
377 * This field holds one of a number of values that communicate the
378 * event that happened to the address. They include:
380 enum sctp_spc_state {
382 SCTP_ADDR_UNREACHABLE,
391 * 5.3.1.3 SCTP_REMOTE_ERROR
393 * A remote peer may send an Operational Error message to its peer.
394 * This message indicates a variety of error conditions on an
395 * association. The entire error TLV as it appears on the wire is
396 * included in a SCTP_REMOTE_ERROR event. Please refer to the SCTP
397 * specification [SCTP] and any extensions for a list of possible
398 * error formats. SCTP error TLVs have the format:
400 struct sctp_remote_error {
405 sctp_assoc_t sre_assoc_id;
411 * 5.3.1.4 SCTP_SEND_FAILED
413 * If SCTP cannot deliver a message it may return the message as a
416 struct sctp_send_failed {
421 struct sctp_sndrcvinfo ssf_info;
422 sctp_assoc_t ssf_assoc_id;
427 * ssf_flags: 16 bits (unsigned integer)
429 * The flag value will take one of the following values
431 * SCTP_DATA_UNSENT - Indicates that the data was never put on
434 * SCTP_DATA_SENT - Indicates that the data was put on the wire.
435 * Note that this does not necessarily mean that the
436 * data was (or was not) successfully delivered.
438 enum sctp_ssf_flags {
444 * 5.3.1.5 SCTP_SHUTDOWN_EVENT
446 * When a peer sends a SHUTDOWN, SCTP delivers this notification to
447 * inform the application that it should cease sending data.
449 struct sctp_shutdown_event {
453 sctp_assoc_t sse_assoc_id;
457 * 5.3.1.6 SCTP_ADAPTATION_INDICATION
459 * When a peer sends a Adaptation Layer Indication parameter , SCTP
460 * delivers this notification to inform the application
461 * that of the peers requested adaptation layer.
463 struct sctp_adaptation_event {
467 __u32 sai_adaptation_ind;
468 sctp_assoc_t sai_assoc_id;
472 * 5.3.1.7 SCTP_PARTIAL_DELIVERY_EVENT
474 * When a receiver is engaged in a partial delivery of a
475 * message this notification will be used to indicate
478 struct sctp_pdapi_event {
482 __u32 pdapi_indication;
483 sctp_assoc_t pdapi_assoc_id;
488 enum { SCTP_PARTIAL_DELIVERY_ABORTED=0, };
491 * 5.3.1.8. SCTP_AUTHENTICATION_EVENT
493 * When a receiver is using authentication this message will provide
494 * notifications regarding new keys being made active as well as errors.
496 struct sctp_authkey_event {
500 __u16 auth_keynumber;
501 __u16 auth_altkeynumber;
502 __u32 auth_indication;
503 sctp_assoc_t auth_assoc_id;
506 enum { SCTP_AUTH_NEWKEY = 0, };
509 * 6.1.9. SCTP_SENDER_DRY_EVENT
511 * When the SCTP stack has no more user data to send or retransmit, this
512 * notification is given to the user. Also, at the time when a user app
513 * subscribes to this event, if there is no data to be sent or
514 * retransmit, the stack will immediately send up this notification.
516 struct sctp_sender_dry_event {
517 __u16 sender_dry_type;
518 __u16 sender_dry_flags;
519 __u32 sender_dry_length;
520 sctp_assoc_t sender_dry_assoc_id;
523 #define SCTP_STREAM_RESET_INCOMING_SSN 0x0001
524 #define SCTP_STREAM_RESET_OUTGOING_SSN 0x0002
525 #define SCTP_STREAM_RESET_DENIED 0x0004
526 #define SCTP_STREAM_RESET_FAILED 0x0008
527 struct sctp_stream_reset_event {
529 __u16 strreset_flags;
530 __u32 strreset_length;
531 sctp_assoc_t strreset_assoc_id;
532 __u16 strreset_stream_list[];
535 #define SCTP_ASSOC_RESET_DENIED 0x0004
536 #define SCTP_ASSOC_RESET_FAILED 0x0008
537 struct sctp_assoc_reset_event {
538 __u16 assocreset_type;
539 __u16 assocreset_flags;
540 __u32 assocreset_length;
541 sctp_assoc_t assocreset_assoc_id;
542 __u32 assocreset_local_tsn;
543 __u32 assocreset_remote_tsn;
546 #define SCTP_ASSOC_CHANGE_DENIED 0x0004
547 #define SCTP_ASSOC_CHANGE_FAILED 0x0008
548 struct sctp_stream_change_event {
549 __u16 strchange_type;
550 __u16 strchange_flags;
551 __u32 strchange_length;
552 sctp_assoc_t strchange_assoc_id;
553 __u16 strchange_instrms;
554 __u16 strchange_outstrms;
558 * Described in Section 7.3
559 * Ancillary Data and Notification Interest Options
561 struct sctp_event_subscribe {
562 __u8 sctp_data_io_event;
563 __u8 sctp_association_event;
564 __u8 sctp_address_event;
565 __u8 sctp_send_failure_event;
566 __u8 sctp_peer_error_event;
567 __u8 sctp_shutdown_event;
568 __u8 sctp_partial_delivery_event;
569 __u8 sctp_adaptation_layer_event;
570 __u8 sctp_authentication_event;
571 __u8 sctp_sender_dry_event;
572 __u8 sctp_stream_reset_event;
573 __u8 sctp_assoc_reset_event;
574 __u8 sctp_stream_change_event;
578 * 5.3.1 SCTP Notification Structure
580 * The notification structure is defined as the union of all
581 * notification types.
584 union sctp_notification {
586 __u16 sn_type; /* Notification type. */
590 struct sctp_assoc_change sn_assoc_change;
591 struct sctp_paddr_change sn_paddr_change;
592 struct sctp_remote_error sn_remote_error;
593 struct sctp_send_failed sn_send_failed;
594 struct sctp_shutdown_event sn_shutdown_event;
595 struct sctp_adaptation_event sn_adaptation_event;
596 struct sctp_pdapi_event sn_pdapi_event;
597 struct sctp_authkey_event sn_authkey_event;
598 struct sctp_sender_dry_event sn_sender_dry_event;
599 struct sctp_stream_reset_event sn_strreset_event;
600 struct sctp_assoc_reset_event sn_assocreset_event;
601 struct sctp_stream_change_event sn_strchange_event;
605 * All standard values for sn_type flags are greater than 2^15.
606 * Values from 2^15 and down are reserved.
610 SCTP_SN_TYPE_BASE = (1<<15),
612 #define SCTP_ASSOC_CHANGE SCTP_ASSOC_CHANGE
613 SCTP_PEER_ADDR_CHANGE,
614 #define SCTP_PEER_ADDR_CHANGE SCTP_PEER_ADDR_CHANGE
616 #define SCTP_SEND_FAILED SCTP_SEND_FAILED
618 #define SCTP_REMOTE_ERROR SCTP_REMOTE_ERROR
620 #define SCTP_SHUTDOWN_EVENT SCTP_SHUTDOWN_EVENT
621 SCTP_PARTIAL_DELIVERY_EVENT,
622 #define SCTP_PARTIAL_DELIVERY_EVENT SCTP_PARTIAL_DELIVERY_EVENT
623 SCTP_ADAPTATION_INDICATION,
624 #define SCTP_ADAPTATION_INDICATION SCTP_ADAPTATION_INDICATION
625 SCTP_AUTHENTICATION_EVENT,
626 #define SCTP_AUTHENTICATION_INDICATION SCTP_AUTHENTICATION_EVENT
627 SCTP_SENDER_DRY_EVENT,
628 #define SCTP_SENDER_DRY_EVENT SCTP_SENDER_DRY_EVENT
629 SCTP_STREAM_RESET_EVENT,
630 #define SCTP_STREAM_RESET_EVENT SCTP_STREAM_RESET_EVENT
631 SCTP_ASSOC_RESET_EVENT,
632 #define SCTP_ASSOC_RESET_EVENT SCTP_ASSOC_RESET_EVENT
633 SCTP_STREAM_CHANGE_EVENT,
634 #define SCTP_STREAM_CHANGE_EVENT SCTP_STREAM_CHANGE_EVENT
637 /* Notification error codes used to fill up the error fields in some
639 * SCTP_PEER_ADDRESS_CHAGE : spc_error
640 * SCTP_ASSOC_CHANGE : sac_error
641 * These names should be potentially included in the draft 04 of the SCTP
642 * sockets API specification.
644 typedef enum sctp_sn_error {
645 SCTP_FAILED_THRESHOLD,
647 SCTP_HEARTBEAT_SUCCESS,
648 SCTP_RESPONSE_TO_USER_REQ,
650 SCTP_SHUTDOWN_GUARD_EXPIRES,
655 * 7.1.1 Retransmission Timeout Parameters (SCTP_RTOINFO)
657 * The protocol parameters used to initialize and bound retransmission
658 * timeout (RTO) are tunable. See [SCTP] for more information on how
659 * these parameters are used in RTO calculation.
661 struct sctp_rtoinfo {
662 sctp_assoc_t srto_assoc_id;
669 * 7.1.2 Association Parameters (SCTP_ASSOCINFO)
671 * This option is used to both examine and set various association and
672 * endpoint parameters.
674 struct sctp_assocparams {
675 sctp_assoc_t sasoc_assoc_id;
676 __u16 sasoc_asocmaxrxt;
677 __u16 sasoc_number_peer_destinations;
678 __u32 sasoc_peer_rwnd;
679 __u32 sasoc_local_rwnd;
680 __u32 sasoc_cookie_life;
684 * 7.1.9 Set Peer Primary Address (SCTP_SET_PEER_PRIMARY_ADDR)
686 * Requests that the peer mark the enclosed address as the association
687 * primary. The enclosed address must be one of the association's
688 * locally bound addresses. The following structure is used to make a
689 * set primary request:
691 struct sctp_setpeerprim {
692 sctp_assoc_t sspp_assoc_id;
693 struct sockaddr_storage sspp_addr;
694 } __attribute__((packed, aligned(4)));
697 * 7.1.10 Set Primary Address (SCTP_PRIMARY_ADDR)
699 * Requests that the local SCTP stack use the enclosed peer address as
700 * the association primary. The enclosed address must be one of the
701 * association peer's addresses. The following structure is used to
702 * make a set peer primary request:
705 sctp_assoc_t ssp_assoc_id;
706 struct sockaddr_storage ssp_addr;
707 } __attribute__((packed, aligned(4)));
709 /* For backward compatibility use, define the old name too */
710 #define sctp_setprim sctp_prim
713 * 7.1.11 Set Adaptation Layer Indicator (SCTP_ADAPTATION_LAYER)
715 * Requests that the local endpoint set the specified Adaptation Layer
716 * Indication parameter for all future INIT and INIT-ACK exchanges.
718 struct sctp_setadaptation {
719 __u32 ssb_adaptation_ind;
723 * 7.1.13 Peer Address Parameters (SCTP_PEER_ADDR_PARAMS)
725 * Applications can enable or disable heartbeats for any peer address
726 * of an association, modify an address's heartbeat interval, force a
727 * heartbeat to be sent immediately, and adjust the address's maximum
728 * number of retransmissions sent before an address is considered
729 * unreachable. The following structure is used to access and modify an
730 * address's parameters:
732 enum sctp_spp_flags {
733 SPP_HB_ENABLE = 1<<0, /*Enable heartbeats*/
734 SPP_HB_DISABLE = 1<<1, /*Disable heartbeats*/
735 SPP_HB = SPP_HB_ENABLE | SPP_HB_DISABLE,
736 SPP_HB_DEMAND = 1<<2, /*Send heartbeat immediately*/
737 SPP_PMTUD_ENABLE = 1<<3, /*Enable PMTU discovery*/
738 SPP_PMTUD_DISABLE = 1<<4, /*Disable PMTU discovery*/
739 SPP_PMTUD = SPP_PMTUD_ENABLE | SPP_PMTUD_DISABLE,
740 SPP_SACKDELAY_ENABLE = 1<<5, /*Enable SACK*/
741 SPP_SACKDELAY_DISABLE = 1<<6, /*Disable SACK*/
742 SPP_SACKDELAY = SPP_SACKDELAY_ENABLE | SPP_SACKDELAY_DISABLE,
743 SPP_HB_TIME_IS_ZERO = 1<<7, /* Set HB delay to 0 */
746 struct sctp_paddrparams {
747 sctp_assoc_t spp_assoc_id;
748 struct sockaddr_storage spp_address;
749 __u32 spp_hbinterval;
750 __u16 spp_pathmaxrxt;
754 } __attribute__((packed, aligned(4)));
757 * 7.1.18. Add a chunk that must be authenticated (SCTP_AUTH_CHUNK)
759 * This set option adds a chunk type that the user is requesting to be
760 * received only in an authenticated way. Changes to the list of chunks
761 * will only effect future associations on the socket.
763 struct sctp_authchunk {
768 * 7.1.19. Get or set the list of supported HMAC Identifiers (SCTP_HMAC_IDENT)
770 * This option gets or sets the list of HMAC algorithms that the local
771 * endpoint requires the peer to use.
774 /* This here is only used by user space as is. It might not be a good idea
775 * to export/reveal the whole structure with reserved fields etc.
778 SCTP_AUTH_HMAC_ID_SHA1 = 1,
779 SCTP_AUTH_HMAC_ID_SHA256 = 3,
783 struct sctp_hmacalgo {
784 __u32 shmac_num_idents;
785 __u16 shmac_idents[];
788 /* Sadly, user and kernel space have different names for
789 * this structure member, so this is to not break anything.
791 #define shmac_number_of_idents shmac_num_idents
794 * 7.1.20. Set a shared key (SCTP_AUTH_KEY)
796 * This option will set a shared secret key which is used to build an
797 * association shared key.
799 struct sctp_authkey {
800 sctp_assoc_t sca_assoc_id;
807 * 7.1.21. Get or set the active shared key (SCTP_AUTH_ACTIVE_KEY)
809 * This option will get or set the active shared key to be used to build
810 * the association shared key.
813 struct sctp_authkeyid {
814 sctp_assoc_t scact_assoc_id;
815 __u16 scact_keynumber;
820 * 7.1.23. Get or set delayed ack timer (SCTP_DELAYED_SACK)
822 * This option will effect the way delayed acks are performed. This
823 * option allows you to get or set the delayed ack time, in
824 * milliseconds. It also allows changing the delayed ack frequency.
825 * Changing the frequency to 1 disables the delayed sack algorithm. If
826 * the assoc_id is 0, then this sets or gets the endpoints default
827 * values. If the assoc_id field is non-zero, then the set or get
828 * effects the specified association for the one to many model (the
829 * assoc_id field is ignored by the one to one model). Note that if
830 * sack_delay or sack_freq are 0 when setting this option, then the
831 * current values will remain unchanged.
833 struct sctp_sack_info {
834 sctp_assoc_t sack_assoc_id;
839 struct sctp_assoc_value {
840 sctp_assoc_t assoc_id;
841 uint32_t assoc_value;
844 struct sctp_stream_value {
845 sctp_assoc_t assoc_id;
847 uint16_t stream_value;
851 * 7.2.2 Peer Address Information
853 * Applications can retrieve information about a specific peer address
854 * of an association, including its reachability state, congestion
855 * window, and retransmission timer values. This information is
856 * read-only. The following structure is used to access this
859 struct sctp_paddrinfo {
860 sctp_assoc_t spinfo_assoc_id;
861 struct sockaddr_storage spinfo_address;
867 } __attribute__((packed, aligned(4)));
869 /* Peer addresses's state. */
870 /* UNKNOWN: Peer address passed by the upper layer in sendmsg or connect[x]
872 * UNCONFIRMED: Peer address received in INIT/INIT-ACK address parameters.
873 * Not yet confirmed by a heartbeat and not available for data
875 * ACTIVE : Peer address confirmed, active and available for data transfers.
876 * INACTIVE: Peer address inactive and not available for data transfers.
878 enum sctp_spinfo_state {
883 SCTP_UNKNOWN = 0xffff /* Value used for transport state unknown */
887 * 7.2.1 Association Status (SCTP_STATUS)
889 * Applications can retrieve current status information about an
890 * association, including association state, peer receiver window size,
891 * number of unacked data chunks, and number of data chunks pending
892 * receipt. This information is read-only. The following structure is
893 * used to access this information:
896 sctp_assoc_t sstat_assoc_id;
899 __u16 sstat_unackdata;
900 __u16 sstat_penddata;
902 __u16 sstat_outstrms;
903 __u32 sstat_fragmentation_point;
904 struct sctp_paddrinfo sstat_primary;
908 * 7.2.3. Get the list of chunks the peer requires to be authenticated
909 * (SCTP_PEER_AUTH_CHUNKS)
911 * This option gets a list of chunks for a specified association that
912 * the peer requires to be received authenticated only.
914 struct sctp_authchunks {
915 sctp_assoc_t gauth_assoc_id;
916 __u32 gauth_number_of_chunks;
917 uint8_t gauth_chunks[];
920 /* The broken spelling has been released already in lksctp-tools header,
921 * so don't break anyone, now that it's fixed.
923 #define guth_number_of_chunks gauth_number_of_chunks
925 /* Association states. */
926 enum sctp_sstat_state {
929 SCTP_COOKIE_WAIT = 2,
930 SCTP_COOKIE_ECHOED = 3,
931 SCTP_ESTABLISHED = 4,
932 SCTP_SHUTDOWN_PENDING = 5,
933 SCTP_SHUTDOWN_SENT = 6,
934 SCTP_SHUTDOWN_RECEIVED = 7,
935 SCTP_SHUTDOWN_ACK_SENT = 8,
939 * 8.2.6. Get the Current Identifiers of Associations
940 * (SCTP_GET_ASSOC_ID_LIST)
942 * This option gets the current list of SCTP association identifiers of
943 * the SCTP associations handled by a one-to-many style socket.
945 struct sctp_assoc_ids {
946 __u32 gaids_number_of_ids;
947 sctp_assoc_t gaids_assoc_id[];
951 * 8.3, 8.5 get all peer/local addresses in an association.
952 * This parameter struct is used by SCTP_GET_PEER_ADDRS and
953 * SCTP_GET_LOCAL_ADDRS socket options used internally to implement
954 * sctp_getpaddrs() and sctp_getladdrs() API.
956 struct sctp_getaddrs_old {
957 sctp_assoc_t assoc_id;
960 struct sockaddr __user *addrs;
962 struct sockaddr *addrs;
966 struct sctp_getaddrs {
967 sctp_assoc_t assoc_id; /*input*/
968 __u32 addr_num; /*output*/
969 __u8 addrs[0]; /*output, variable size*/
972 /* A socket user request obtained via SCTP_GET_ASSOC_STATS that retrieves
973 * association stats. All stats are counts except sas_maxrto and
974 * sas_obs_rto_ipaddr. maxrto is the max observed rto + transport since
975 * the last call. Will return 0 when RTO was not update since last call
977 struct sctp_assoc_stats {
978 sctp_assoc_t sas_assoc_id; /* Input */
979 /* Transport of observed max RTO */
980 struct sockaddr_storage sas_obs_rto_ipaddr;
981 __u64 sas_maxrto; /* Maximum Observed RTO for period */
982 __u64 sas_isacks; /* SACKs received */
983 __u64 sas_osacks; /* SACKs sent */
984 __u64 sas_opackets; /* Packets sent */
985 __u64 sas_ipackets; /* Packets received */
986 __u64 sas_rtxchunks; /* Retransmitted Chunks */
987 __u64 sas_outofseqtsns;/* TSN received > next expected */
988 __u64 sas_idupchunks; /* Dups received (ordered+unordered) */
989 __u64 sas_gapcnt; /* Gap Acknowledgements Received */
990 __u64 sas_ouodchunks; /* Unordered data chunks sent */
991 __u64 sas_iuodchunks; /* Unordered data chunks received */
992 __u64 sas_oodchunks; /* Ordered data chunks sent */
993 __u64 sas_iodchunks; /* Ordered data chunks received */
994 __u64 sas_octrlchunks; /* Control chunks sent */
995 __u64 sas_ictrlchunks; /* Control chunks received */
1001 * The flags parameter is formed from the bitwise OR of zero or more of the
1002 * following currently defined flags:
1004 #define SCTP_BINDX_ADD_ADDR 0x01
1005 #define SCTP_BINDX_REM_ADDR 0x02
1007 /* This is the structure that is passed as an argument(optval) to
1008 * getsockopt(SCTP_SOCKOPT_PEELOFF).
1011 sctp_assoc_t associd;
1013 } sctp_peeloff_arg_t;
1016 sctp_peeloff_arg_t p_arg;
1018 } sctp_peeloff_flags_arg_t;
1021 * Peer Address Thresholds socket option
1023 struct sctp_paddrthlds {
1024 sctp_assoc_t spt_assoc_id;
1025 struct sockaddr_storage spt_address;
1026 __u16 spt_pathmaxrxt;
1027 __u16 spt_pathpfthld;
1031 * Socket Option for Getting the Association/Stream-Specific PR-SCTP Status
1033 struct sctp_prstatus {
1034 sctp_assoc_t sprstat_assoc_id;
1036 __u16 sprstat_policy;
1037 __u64 sprstat_abandoned_unsent;
1038 __u64 sprstat_abandoned_sent;
1041 struct sctp_default_prinfo {
1042 sctp_assoc_t pr_assoc_id;
1051 __u16 sctpi_unackdata;
1052 __u16 sctpi_penddata;
1053 __u16 sctpi_instrms;
1054 __u16 sctpi_outstrms;
1055 __u32 sctpi_fragmentation_point;
1056 __u32 sctpi_inqueue;
1057 __u32 sctpi_outqueue;
1058 __u32 sctpi_overall_error;
1059 __u32 sctpi_max_burst;
1061 __u32 sctpi_peer_rwnd;
1062 __u32 sctpi_peer_tag;
1063 __u8 sctpi_peer_capable;
1064 __u8 sctpi_peer_sack;
1067 /* assoc status info */
1070 __u64 sctpi_opackets;
1071 __u64 sctpi_ipackets;
1072 __u64 sctpi_rtxchunks;
1073 __u64 sctpi_outofseqtsns;
1074 __u64 sctpi_idupchunks;
1076 __u64 sctpi_ouodchunks;
1077 __u64 sctpi_iuodchunks;
1078 __u64 sctpi_oodchunks;
1079 __u64 sctpi_iodchunks;
1080 __u64 sctpi_octrlchunks;
1081 __u64 sctpi_ictrlchunks;
1083 /* primary transport info */
1084 struct sockaddr_storage sctpi_p_address;
1085 __s32 sctpi_p_state;
1089 __u32 sctpi_p_hbinterval;
1090 __u32 sctpi_p_pathmaxrxt;
1091 __u32 sctpi_p_sackdelay;
1092 __u32 sctpi_p_sackfreq;
1093 __u32 sctpi_p_ssthresh;
1094 __u32 sctpi_p_partial_bytes_acked;
1095 __u32 sctpi_p_flight_size;
1096 __u16 sctpi_p_error;
1099 /* sctp sock info */
1100 __u32 sctpi_s_autoclose;
1101 __u32 sctpi_s_adaptation_ind;
1102 __u32 sctpi_s_pd_point;
1103 __u8 sctpi_s_nodelay;
1104 __u8 sctpi_s_disable_fragments;
1105 __u8 sctpi_s_v4mapped;
1106 __u8 sctpi_s_frag_interleave;
1111 struct sctp_reset_streams {
1112 sctp_assoc_t srs_assoc_id;
1114 uint16_t srs_number_streams; /* 0 == ALL */
1115 uint16_t srs_stream_list[]; /* list if srs_num_streams is not 0 */
1118 struct sctp_add_streams {
1119 sctp_assoc_t sas_assoc_id;
1120 uint16_t sas_instrms;
1121 uint16_t sas_outstrms;
1124 /* SCTP Stream schedulers */
1125 enum sctp_sched_type {
1129 SCTP_SS_MAX = SCTP_SS_RR
1132 #endif /* _UAPI_SCTP_H */