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
102 #define SCTP_AUTH_DEACTIVATE_KEY 35
103 #define SCTP_REUSE_PORT 36
105 /* Internal Socket Options. Some of the sctp library functions are
106 * implemented using these socket options.
108 #define SCTP_SOCKOPT_BINDX_ADD 100 /* BINDX requests for adding addrs */
109 #define SCTP_SOCKOPT_BINDX_REM 101 /* BINDX requests for removing addrs. */
110 #define SCTP_SOCKOPT_PEELOFF 102 /* peel off association. */
111 /* Options 104-106 are deprecated and removed. Do not use this space */
112 #define SCTP_SOCKOPT_CONNECTX_OLD 107 /* CONNECTX old requests. */
113 #define SCTP_GET_PEER_ADDRS 108 /* Get all peer address. */
114 #define SCTP_GET_LOCAL_ADDRS 109 /* Get all local address. */
115 #define SCTP_SOCKOPT_CONNECTX 110 /* CONNECTX requests. */
116 #define SCTP_SOCKOPT_CONNECTX3 111 /* CONNECTX requests (updated) */
117 #define SCTP_GET_ASSOC_STATS 112 /* Read only */
118 #define SCTP_PR_SUPPORTED 113
119 #define SCTP_DEFAULT_PRINFO 114
120 #define SCTP_PR_ASSOC_STATUS 115
121 #define SCTP_PR_STREAM_STATUS 116
122 #define SCTP_RECONFIG_SUPPORTED 117
123 #define SCTP_ENABLE_STREAM_RESET 118
124 #define SCTP_RESET_STREAMS 119
125 #define SCTP_RESET_ASSOC 120
126 #define SCTP_ADD_STREAMS 121
127 #define SCTP_SOCKOPT_PEELOFF_FLAGS 122
128 #define SCTP_STREAM_SCHEDULER 123
129 #define SCTP_STREAM_SCHEDULER_VALUE 124
130 #define SCTP_INTERLEAVING_SUPPORTED 125
131 #define SCTP_SENDMSG_CONNECT 126
132 #define SCTP_EVENT 127
134 /* PR-SCTP policies */
135 #define SCTP_PR_SCTP_NONE 0x0000
136 #define SCTP_PR_SCTP_TTL 0x0010
137 #define SCTP_PR_SCTP_RTX 0x0020
138 #define SCTP_PR_SCTP_PRIO 0x0030
139 #define SCTP_PR_SCTP_MAX SCTP_PR_SCTP_PRIO
140 #define SCTP_PR_SCTP_MASK 0x0030
142 #define __SCTP_PR_INDEX(x) ((x >> 4) - 1)
143 #define SCTP_PR_INDEX(x) __SCTP_PR_INDEX(SCTP_PR_SCTP_ ## x)
145 #define SCTP_PR_POLICY(x) ((x) & SCTP_PR_SCTP_MASK)
146 #define SCTP_PR_SET_POLICY(flags, x) \
148 flags &= ~SCTP_PR_SCTP_MASK; \
152 #define SCTP_PR_TTL_ENABLED(x) (SCTP_PR_POLICY(x) == SCTP_PR_SCTP_TTL)
153 #define SCTP_PR_RTX_ENABLED(x) (SCTP_PR_POLICY(x) == SCTP_PR_SCTP_RTX)
154 #define SCTP_PR_PRIO_ENABLED(x) (SCTP_PR_POLICY(x) == SCTP_PR_SCTP_PRIO)
156 /* For enable stream reset */
157 #define SCTP_ENABLE_RESET_STREAM_REQ 0x01
158 #define SCTP_ENABLE_RESET_ASSOC_REQ 0x02
159 #define SCTP_ENABLE_CHANGE_ASSOC_REQ 0x04
160 #define SCTP_ENABLE_STRRESET_MASK 0x07
162 #define SCTP_STREAM_RESET_INCOMING 0x01
163 #define SCTP_STREAM_RESET_OUTGOING 0x02
165 /* These are bit fields for msghdr->msg_flags. See section 5.1. */
166 /* On user space Linux, these live in <bits/socket.h> as an enum. */
167 enum sctp_msg_flags {
168 MSG_NOTIFICATION = 0x8000,
169 #define MSG_NOTIFICATION MSG_NOTIFICATION
172 /* 5.3.1 SCTP Initiation Structure (SCTP_INIT)
174 * This cmsghdr structure provides information for initializing new
175 * SCTP associations with sendmsg(). The SCTP_INITMSG socket option
176 * uses this same data structure. This structure is not used for
179 * cmsg_level cmsg_type cmsg_data[]
180 * ------------ ------------ ----------------------
181 * IPPROTO_SCTP SCTP_INIT struct sctp_initmsg
183 struct sctp_initmsg {
184 __u16 sinit_num_ostreams;
185 __u16 sinit_max_instreams;
186 __u16 sinit_max_attempts;
187 __u16 sinit_max_init_timeo;
190 /* 5.3.2 SCTP Header Information Structure (SCTP_SNDRCV)
192 * This cmsghdr structure specifies SCTP options for sendmsg() and
193 * describes SCTP header information about a received message through
196 * cmsg_level cmsg_type cmsg_data[]
197 * ------------ ------------ ----------------------
198 * IPPROTO_SCTP SCTP_SNDRCV struct sctp_sndrcvinfo
200 struct sctp_sndrcvinfo {
206 __u32 sinfo_timetolive;
209 sctp_assoc_t sinfo_assoc_id;
212 /* 5.3.4 SCTP Send Information Structure (SCTP_SNDINFO)
214 * This cmsghdr structure specifies SCTP options for sendmsg().
216 * cmsg_level cmsg_type cmsg_data[]
217 * ------------ ------------ -------------------
218 * IPPROTO_SCTP SCTP_SNDINFO struct sctp_sndinfo
220 struct sctp_sndinfo {
225 sctp_assoc_t snd_assoc_id;
228 /* 5.3.5 SCTP Receive Information Structure (SCTP_RCVINFO)
230 * This cmsghdr structure describes SCTP receive information
231 * about a received message through recvmsg().
233 * cmsg_level cmsg_type cmsg_data[]
234 * ------------ ------------ -------------------
235 * IPPROTO_SCTP SCTP_RCVINFO struct sctp_rcvinfo
237 struct sctp_rcvinfo {
245 sctp_assoc_t rcv_assoc_id;
248 /* 5.3.6 SCTP Next Receive Information Structure (SCTP_NXTINFO)
250 * This cmsghdr structure describes SCTP receive information
251 * of the next message that will be delivered through recvmsg()
252 * if this information is already available when delivering
253 * the current message.
255 * cmsg_level cmsg_type cmsg_data[]
256 * ------------ ------------ -------------------
257 * IPPROTO_SCTP SCTP_NXTINFO struct sctp_nxtinfo
259 struct sctp_nxtinfo {
264 sctp_assoc_t nxt_assoc_id;
267 /* 5.3.7 SCTP PR-SCTP Information Structure (SCTP_PRINFO)
269 * This cmsghdr structure specifies SCTP options for sendmsg().
271 * cmsg_level cmsg_type cmsg_data[]
272 * ------------ ------------ -------------------
273 * IPPROTO_SCTP SCTP_PRINFO struct sctp_prinfo
280 /* 5.3.8 SCTP AUTH Information Structure (SCTP_AUTHINFO)
282 * This cmsghdr structure specifies SCTP options for sendmsg().
284 * cmsg_level cmsg_type cmsg_data[]
285 * ------------ ------------ -------------------
286 * IPPROTO_SCTP SCTP_AUTHINFO struct sctp_authinfo
288 struct sctp_authinfo {
289 __u16 auth_keynumber;
293 * sinfo_flags: 16 bits (unsigned integer)
295 * This field may contain any of the following flags and is composed of
296 * a bitwise OR of these values.
298 enum sctp_sinfo_flags {
299 SCTP_UNORDERED = (1 << 0), /* Send/receive message unordered. */
300 SCTP_ADDR_OVER = (1 << 1), /* Override the primary destination. */
301 SCTP_ABORT = (1 << 2), /* Send an ABORT message to the peer. */
302 SCTP_SACK_IMMEDIATELY = (1 << 3), /* SACK should be sent without delay. */
303 /* 2 bits here have been used by SCTP_PR_SCTP_MASK */
304 SCTP_SENDALL = (1 << 6),
305 SCTP_PR_SCTP_ALL = (1 << 7),
306 SCTP_NOTIFICATION = MSG_NOTIFICATION, /* Next message is not user msg but notification. */
307 SCTP_EOF = MSG_FIN, /* Initiate graceful shutdown process. */
312 struct sctp_initmsg init;
313 struct sctp_sndrcvinfo sndrcv;
316 /* These are cmsg_types. */
317 typedef enum sctp_cmsg_type {
318 SCTP_INIT, /* 5.2.1 SCTP Initiation Structure */
319 #define SCTP_INIT SCTP_INIT
320 SCTP_SNDRCV, /* 5.2.2 SCTP Header Information Structure */
321 #define SCTP_SNDRCV SCTP_SNDRCV
322 SCTP_SNDINFO, /* 5.3.4 SCTP Send Information Structure */
323 #define SCTP_SNDINFO SCTP_SNDINFO
324 SCTP_RCVINFO, /* 5.3.5 SCTP Receive Information Structure */
325 #define SCTP_RCVINFO SCTP_RCVINFO
326 SCTP_NXTINFO, /* 5.3.6 SCTP Next Receive Information Structure */
327 #define SCTP_NXTINFO SCTP_NXTINFO
328 SCTP_PRINFO, /* 5.3.7 SCTP PR-SCTP Information Structure */
329 #define SCTP_PRINFO SCTP_PRINFO
330 SCTP_AUTHINFO, /* 5.3.8 SCTP AUTH Information Structure */
331 #define SCTP_AUTHINFO SCTP_AUTHINFO
332 SCTP_DSTADDRV4, /* 5.3.9 SCTP Destination IPv4 Address Structure */
333 #define SCTP_DSTADDRV4 SCTP_DSTADDRV4
334 SCTP_DSTADDRV6, /* 5.3.10 SCTP Destination IPv6 Address Structure */
335 #define SCTP_DSTADDRV6 SCTP_DSTADDRV6
339 * 5.3.1.1 SCTP_ASSOC_CHANGE
341 * Communication notifications inform the ULP that an SCTP association
342 * has either begun or ended. The identifier for a new association is
343 * provided by this notificaion. The notification information has the
347 struct sctp_assoc_change {
353 __u16 sac_outbound_streams;
354 __u16 sac_inbound_streams;
355 sctp_assoc_t sac_assoc_id;
360 * sac_state: 32 bits (signed integer)
362 * This field holds one of a number of values that communicate the
363 * event that happened to the association. They include:
365 * Note: The following state names deviate from the API draft as
366 * the names clash too easily with other kernel symbols.
368 enum sctp_sac_state {
377 * 5.3.1.2 SCTP_PEER_ADDR_CHANGE
379 * When a destination address on a multi-homed peer encounters a change
380 * an interface details event is sent. The information has the
381 * following structure:
383 struct sctp_paddr_change {
387 struct sockaddr_storage spc_aaddr;
390 sctp_assoc_t spc_assoc_id;
391 } __attribute__((packed, aligned(4)));
394 * spc_state: 32 bits (signed integer)
396 * This field holds one of a number of values that communicate the
397 * event that happened to the address. They include:
399 enum sctp_spc_state {
401 SCTP_ADDR_UNREACHABLE,
410 * 5.3.1.3 SCTP_REMOTE_ERROR
412 * A remote peer may send an Operational Error message to its peer.
413 * This message indicates a variety of error conditions on an
414 * association. The entire error TLV as it appears on the wire is
415 * included in a SCTP_REMOTE_ERROR event. Please refer to the SCTP
416 * specification [SCTP] and any extensions for a list of possible
417 * error formats. SCTP error TLVs have the format:
419 struct sctp_remote_error {
424 sctp_assoc_t sre_assoc_id;
430 * 5.3.1.4 SCTP_SEND_FAILED
432 * If SCTP cannot deliver a message it may return the message as a
435 struct sctp_send_failed {
440 struct sctp_sndrcvinfo ssf_info;
441 sctp_assoc_t ssf_assoc_id;
446 * ssf_flags: 16 bits (unsigned integer)
448 * The flag value will take one of the following values
450 * SCTP_DATA_UNSENT - Indicates that the data was never put on
453 * SCTP_DATA_SENT - Indicates that the data was put on the wire.
454 * Note that this does not necessarily mean that the
455 * data was (or was not) successfully delivered.
457 enum sctp_ssf_flags {
463 * 5.3.1.5 SCTP_SHUTDOWN_EVENT
465 * When a peer sends a SHUTDOWN, SCTP delivers this notification to
466 * inform the application that it should cease sending data.
468 struct sctp_shutdown_event {
472 sctp_assoc_t sse_assoc_id;
476 * 5.3.1.6 SCTP_ADAPTATION_INDICATION
478 * When a peer sends a Adaptation Layer Indication parameter , SCTP
479 * delivers this notification to inform the application
480 * that of the peers requested adaptation layer.
482 struct sctp_adaptation_event {
486 __u32 sai_adaptation_ind;
487 sctp_assoc_t sai_assoc_id;
491 * 5.3.1.7 SCTP_PARTIAL_DELIVERY_EVENT
493 * When a receiver is engaged in a partial delivery of a
494 * message this notification will be used to indicate
497 struct sctp_pdapi_event {
501 __u32 pdapi_indication;
502 sctp_assoc_t pdapi_assoc_id;
507 enum { SCTP_PARTIAL_DELIVERY_ABORTED=0, };
510 * 5.3.1.8. SCTP_AUTHENTICATION_EVENT
512 * When a receiver is using authentication this message will provide
513 * notifications regarding new keys being made active as well as errors.
515 struct sctp_authkey_event {
519 __u16 auth_keynumber;
520 __u16 auth_altkeynumber;
521 __u32 auth_indication;
522 sctp_assoc_t auth_assoc_id;
527 #define SCTP_AUTH_NEWKEY SCTP_AUTH_NEW_KEY /* compatible with before */
533 * 6.1.9. SCTP_SENDER_DRY_EVENT
535 * When the SCTP stack has no more user data to send or retransmit, this
536 * notification is given to the user. Also, at the time when a user app
537 * subscribes to this event, if there is no data to be sent or
538 * retransmit, the stack will immediately send up this notification.
540 struct sctp_sender_dry_event {
541 __u16 sender_dry_type;
542 __u16 sender_dry_flags;
543 __u32 sender_dry_length;
544 sctp_assoc_t sender_dry_assoc_id;
547 #define SCTP_STREAM_RESET_INCOMING_SSN 0x0001
548 #define SCTP_STREAM_RESET_OUTGOING_SSN 0x0002
549 #define SCTP_STREAM_RESET_DENIED 0x0004
550 #define SCTP_STREAM_RESET_FAILED 0x0008
551 struct sctp_stream_reset_event {
553 __u16 strreset_flags;
554 __u32 strreset_length;
555 sctp_assoc_t strreset_assoc_id;
556 __u16 strreset_stream_list[];
559 #define SCTP_ASSOC_RESET_DENIED 0x0004
560 #define SCTP_ASSOC_RESET_FAILED 0x0008
561 struct sctp_assoc_reset_event {
562 __u16 assocreset_type;
563 __u16 assocreset_flags;
564 __u32 assocreset_length;
565 sctp_assoc_t assocreset_assoc_id;
566 __u32 assocreset_local_tsn;
567 __u32 assocreset_remote_tsn;
570 #define SCTP_ASSOC_CHANGE_DENIED 0x0004
571 #define SCTP_ASSOC_CHANGE_FAILED 0x0008
572 #define SCTP_STREAM_CHANGE_DENIED SCTP_ASSOC_CHANGE_DENIED
573 #define SCTP_STREAM_CHANGE_FAILED SCTP_ASSOC_CHANGE_FAILED
574 struct sctp_stream_change_event {
575 __u16 strchange_type;
576 __u16 strchange_flags;
577 __u32 strchange_length;
578 sctp_assoc_t strchange_assoc_id;
579 __u16 strchange_instrms;
580 __u16 strchange_outstrms;
584 * Described in Section 7.3
585 * Ancillary Data and Notification Interest Options
587 struct sctp_event_subscribe {
588 __u8 sctp_data_io_event;
589 __u8 sctp_association_event;
590 __u8 sctp_address_event;
591 __u8 sctp_send_failure_event;
592 __u8 sctp_peer_error_event;
593 __u8 sctp_shutdown_event;
594 __u8 sctp_partial_delivery_event;
595 __u8 sctp_adaptation_layer_event;
596 __u8 sctp_authentication_event;
597 __u8 sctp_sender_dry_event;
598 __u8 sctp_stream_reset_event;
599 __u8 sctp_assoc_reset_event;
600 __u8 sctp_stream_change_event;
604 * 5.3.1 SCTP Notification Structure
606 * The notification structure is defined as the union of all
607 * notification types.
610 union sctp_notification {
612 __u16 sn_type; /* Notification type. */
616 struct sctp_assoc_change sn_assoc_change;
617 struct sctp_paddr_change sn_paddr_change;
618 struct sctp_remote_error sn_remote_error;
619 struct sctp_send_failed sn_send_failed;
620 struct sctp_shutdown_event sn_shutdown_event;
621 struct sctp_adaptation_event sn_adaptation_event;
622 struct sctp_pdapi_event sn_pdapi_event;
623 struct sctp_authkey_event sn_authkey_event;
624 struct sctp_sender_dry_event sn_sender_dry_event;
625 struct sctp_stream_reset_event sn_strreset_event;
626 struct sctp_assoc_reset_event sn_assocreset_event;
627 struct sctp_stream_change_event sn_strchange_event;
631 * All standard values for sn_type flags are greater than 2^15.
632 * Values from 2^15 and down are reserved.
636 SCTP_SN_TYPE_BASE = (1<<15),
637 SCTP_DATA_IO_EVENT = SCTP_SN_TYPE_BASE,
638 #define SCTP_DATA_IO_EVENT SCTP_DATA_IO_EVENT
640 #define SCTP_ASSOC_CHANGE SCTP_ASSOC_CHANGE
641 SCTP_PEER_ADDR_CHANGE,
642 #define SCTP_PEER_ADDR_CHANGE SCTP_PEER_ADDR_CHANGE
644 #define SCTP_SEND_FAILED SCTP_SEND_FAILED
646 #define SCTP_REMOTE_ERROR SCTP_REMOTE_ERROR
648 #define SCTP_SHUTDOWN_EVENT SCTP_SHUTDOWN_EVENT
649 SCTP_PARTIAL_DELIVERY_EVENT,
650 #define SCTP_PARTIAL_DELIVERY_EVENT SCTP_PARTIAL_DELIVERY_EVENT
651 SCTP_ADAPTATION_INDICATION,
652 #define SCTP_ADAPTATION_INDICATION SCTP_ADAPTATION_INDICATION
653 SCTP_AUTHENTICATION_EVENT,
654 #define SCTP_AUTHENTICATION_INDICATION SCTP_AUTHENTICATION_EVENT
655 SCTP_SENDER_DRY_EVENT,
656 #define SCTP_SENDER_DRY_EVENT SCTP_SENDER_DRY_EVENT
657 SCTP_STREAM_RESET_EVENT,
658 #define SCTP_STREAM_RESET_EVENT SCTP_STREAM_RESET_EVENT
659 SCTP_ASSOC_RESET_EVENT,
660 #define SCTP_ASSOC_RESET_EVENT SCTP_ASSOC_RESET_EVENT
661 SCTP_STREAM_CHANGE_EVENT,
662 #define SCTP_STREAM_CHANGE_EVENT SCTP_STREAM_CHANGE_EVENT
663 SCTP_SN_TYPE_MAX = SCTP_STREAM_CHANGE_EVENT,
664 #define SCTP_SN_TYPE_MAX SCTP_SN_TYPE_MAX
667 /* Notification error codes used to fill up the error fields in some
669 * SCTP_PEER_ADDRESS_CHAGE : spc_error
670 * SCTP_ASSOC_CHANGE : sac_error
671 * These names should be potentially included in the draft 04 of the SCTP
672 * sockets API specification.
674 typedef enum sctp_sn_error {
675 SCTP_FAILED_THRESHOLD,
677 SCTP_HEARTBEAT_SUCCESS,
678 SCTP_RESPONSE_TO_USER_REQ,
680 SCTP_SHUTDOWN_GUARD_EXPIRES,
685 * 7.1.1 Retransmission Timeout Parameters (SCTP_RTOINFO)
687 * The protocol parameters used to initialize and bound retransmission
688 * timeout (RTO) are tunable. See [SCTP] for more information on how
689 * these parameters are used in RTO calculation.
691 struct sctp_rtoinfo {
692 sctp_assoc_t srto_assoc_id;
699 * 7.1.2 Association Parameters (SCTP_ASSOCINFO)
701 * This option is used to both examine and set various association and
702 * endpoint parameters.
704 struct sctp_assocparams {
705 sctp_assoc_t sasoc_assoc_id;
706 __u16 sasoc_asocmaxrxt;
707 __u16 sasoc_number_peer_destinations;
708 __u32 sasoc_peer_rwnd;
709 __u32 sasoc_local_rwnd;
710 __u32 sasoc_cookie_life;
714 * 7.1.9 Set Peer Primary Address (SCTP_SET_PEER_PRIMARY_ADDR)
716 * Requests that the peer mark the enclosed address as the association
717 * primary. The enclosed address must be one of the association's
718 * locally bound addresses. The following structure is used to make a
719 * set primary request:
721 struct sctp_setpeerprim {
722 sctp_assoc_t sspp_assoc_id;
723 struct sockaddr_storage sspp_addr;
724 } __attribute__((packed, aligned(4)));
727 * 7.1.10 Set Primary Address (SCTP_PRIMARY_ADDR)
729 * Requests that the local SCTP stack use the enclosed peer address as
730 * the association primary. The enclosed address must be one of the
731 * association peer's addresses. The following structure is used to
732 * make a set peer primary request:
735 sctp_assoc_t ssp_assoc_id;
736 struct sockaddr_storage ssp_addr;
737 } __attribute__((packed, aligned(4)));
739 /* For backward compatibility use, define the old name too */
740 #define sctp_setprim sctp_prim
743 * 7.1.11 Set Adaptation Layer Indicator (SCTP_ADAPTATION_LAYER)
745 * Requests that the local endpoint set the specified Adaptation Layer
746 * Indication parameter for all future INIT and INIT-ACK exchanges.
748 struct sctp_setadaptation {
749 __u32 ssb_adaptation_ind;
753 * 7.1.13 Peer Address Parameters (SCTP_PEER_ADDR_PARAMS)
755 * Applications can enable or disable heartbeats for any peer address
756 * of an association, modify an address's heartbeat interval, force a
757 * heartbeat to be sent immediately, and adjust the address's maximum
758 * number of retransmissions sent before an address is considered
759 * unreachable. The following structure is used to access and modify an
760 * address's parameters:
762 enum sctp_spp_flags {
763 SPP_HB_ENABLE = 1<<0, /*Enable heartbeats*/
764 SPP_HB_DISABLE = 1<<1, /*Disable heartbeats*/
765 SPP_HB = SPP_HB_ENABLE | SPP_HB_DISABLE,
766 SPP_HB_DEMAND = 1<<2, /*Send heartbeat immediately*/
767 SPP_PMTUD_ENABLE = 1<<3, /*Enable PMTU discovery*/
768 SPP_PMTUD_DISABLE = 1<<4, /*Disable PMTU discovery*/
769 SPP_PMTUD = SPP_PMTUD_ENABLE | SPP_PMTUD_DISABLE,
770 SPP_SACKDELAY_ENABLE = 1<<5, /*Enable SACK*/
771 SPP_SACKDELAY_DISABLE = 1<<6, /*Disable SACK*/
772 SPP_SACKDELAY = SPP_SACKDELAY_ENABLE | SPP_SACKDELAY_DISABLE,
773 SPP_HB_TIME_IS_ZERO = 1<<7, /* Set HB delay to 0 */
774 SPP_IPV6_FLOWLABEL = 1<<8,
778 struct sctp_paddrparams {
779 sctp_assoc_t spp_assoc_id;
780 struct sockaddr_storage spp_address;
781 __u32 spp_hbinterval;
782 __u16 spp_pathmaxrxt;
786 __u32 spp_ipv6_flowlabel;
788 } __attribute__((packed, aligned(4)));
791 * 7.1.18. Add a chunk that must be authenticated (SCTP_AUTH_CHUNK)
793 * This set option adds a chunk type that the user is requesting to be
794 * received only in an authenticated way. Changes to the list of chunks
795 * will only effect future associations on the socket.
797 struct sctp_authchunk {
802 * 7.1.19. Get or set the list of supported HMAC Identifiers (SCTP_HMAC_IDENT)
804 * This option gets or sets the list of HMAC algorithms that the local
805 * endpoint requires the peer to use.
808 /* This here is only used by user space as is. It might not be a good idea
809 * to export/reveal the whole structure with reserved fields etc.
812 SCTP_AUTH_HMAC_ID_SHA1 = 1,
813 SCTP_AUTH_HMAC_ID_SHA256 = 3,
817 struct sctp_hmacalgo {
818 __u32 shmac_num_idents;
819 __u16 shmac_idents[];
822 /* Sadly, user and kernel space have different names for
823 * this structure member, so this is to not break anything.
825 #define shmac_number_of_idents shmac_num_idents
828 * 7.1.20. Set a shared key (SCTP_AUTH_KEY)
830 * This option will set a shared secret key which is used to build an
831 * association shared key.
833 struct sctp_authkey {
834 sctp_assoc_t sca_assoc_id;
841 * 7.1.21. Get or set the active shared key (SCTP_AUTH_ACTIVE_KEY)
843 * This option will get or set the active shared key to be used to build
844 * the association shared key.
847 struct sctp_authkeyid {
848 sctp_assoc_t scact_assoc_id;
849 __u16 scact_keynumber;
854 * 7.1.23. Get or set delayed ack timer (SCTP_DELAYED_SACK)
856 * This option will effect the way delayed acks are performed. This
857 * option allows you to get or set the delayed ack time, in
858 * milliseconds. It also allows changing the delayed ack frequency.
859 * Changing the frequency to 1 disables the delayed sack algorithm. If
860 * the assoc_id is 0, then this sets or gets the endpoints default
861 * values. If the assoc_id field is non-zero, then the set or get
862 * effects the specified association for the one to many model (the
863 * assoc_id field is ignored by the one to one model). Note that if
864 * sack_delay or sack_freq are 0 when setting this option, then the
865 * current values will remain unchanged.
867 struct sctp_sack_info {
868 sctp_assoc_t sack_assoc_id;
873 struct sctp_assoc_value {
874 sctp_assoc_t assoc_id;
875 uint32_t assoc_value;
878 struct sctp_stream_value {
879 sctp_assoc_t assoc_id;
881 uint16_t stream_value;
885 * 7.2.2 Peer Address Information
887 * Applications can retrieve information about a specific peer address
888 * of an association, including its reachability state, congestion
889 * window, and retransmission timer values. This information is
890 * read-only. The following structure is used to access this
893 struct sctp_paddrinfo {
894 sctp_assoc_t spinfo_assoc_id;
895 struct sockaddr_storage spinfo_address;
901 } __attribute__((packed, aligned(4)));
903 /* Peer addresses's state. */
904 /* UNKNOWN: Peer address passed by the upper layer in sendmsg or connect[x]
906 * UNCONFIRMED: Peer address received in INIT/INIT-ACK address parameters.
907 * Not yet confirmed by a heartbeat and not available for data
909 * ACTIVE : Peer address confirmed, active and available for data transfers.
910 * INACTIVE: Peer address inactive and not available for data transfers.
912 enum sctp_spinfo_state {
917 SCTP_UNKNOWN = 0xffff /* Value used for transport state unknown */
921 * 7.2.1 Association Status (SCTP_STATUS)
923 * Applications can retrieve current status information about an
924 * association, including association state, peer receiver window size,
925 * number of unacked data chunks, and number of data chunks pending
926 * receipt. This information is read-only. The following structure is
927 * used to access this information:
930 sctp_assoc_t sstat_assoc_id;
933 __u16 sstat_unackdata;
934 __u16 sstat_penddata;
936 __u16 sstat_outstrms;
937 __u32 sstat_fragmentation_point;
938 struct sctp_paddrinfo sstat_primary;
942 * 7.2.3. Get the list of chunks the peer requires to be authenticated
943 * (SCTP_PEER_AUTH_CHUNKS)
945 * This option gets a list of chunks for a specified association that
946 * the peer requires to be received authenticated only.
948 struct sctp_authchunks {
949 sctp_assoc_t gauth_assoc_id;
950 __u32 gauth_number_of_chunks;
951 uint8_t gauth_chunks[];
954 /* The broken spelling has been released already in lksctp-tools header,
955 * so don't break anyone, now that it's fixed.
957 #define guth_number_of_chunks gauth_number_of_chunks
959 /* Association states. */
960 enum sctp_sstat_state {
963 SCTP_COOKIE_WAIT = 2,
964 SCTP_COOKIE_ECHOED = 3,
965 SCTP_ESTABLISHED = 4,
966 SCTP_SHUTDOWN_PENDING = 5,
967 SCTP_SHUTDOWN_SENT = 6,
968 SCTP_SHUTDOWN_RECEIVED = 7,
969 SCTP_SHUTDOWN_ACK_SENT = 8,
973 * 8.2.6. Get the Current Identifiers of Associations
974 * (SCTP_GET_ASSOC_ID_LIST)
976 * This option gets the current list of SCTP association identifiers of
977 * the SCTP associations handled by a one-to-many style socket.
979 struct sctp_assoc_ids {
980 __u32 gaids_number_of_ids;
981 sctp_assoc_t gaids_assoc_id[];
985 * 8.3, 8.5 get all peer/local addresses in an association.
986 * This parameter struct is used by SCTP_GET_PEER_ADDRS and
987 * SCTP_GET_LOCAL_ADDRS socket options used internally to implement
988 * sctp_getpaddrs() and sctp_getladdrs() API.
990 struct sctp_getaddrs_old {
991 sctp_assoc_t assoc_id;
994 struct sockaddr __user *addrs;
996 struct sockaddr *addrs;
1000 struct sctp_getaddrs {
1001 sctp_assoc_t assoc_id; /*input*/
1002 __u32 addr_num; /*output*/
1003 __u8 addrs[0]; /*output, variable size*/
1006 /* A socket user request obtained via SCTP_GET_ASSOC_STATS that retrieves
1007 * association stats. All stats are counts except sas_maxrto and
1008 * sas_obs_rto_ipaddr. maxrto is the max observed rto + transport since
1009 * the last call. Will return 0 when RTO was not update since last call
1011 struct sctp_assoc_stats {
1012 sctp_assoc_t sas_assoc_id; /* Input */
1013 /* Transport of observed max RTO */
1014 struct sockaddr_storage sas_obs_rto_ipaddr;
1015 __u64 sas_maxrto; /* Maximum Observed RTO for period */
1016 __u64 sas_isacks; /* SACKs received */
1017 __u64 sas_osacks; /* SACKs sent */
1018 __u64 sas_opackets; /* Packets sent */
1019 __u64 sas_ipackets; /* Packets received */
1020 __u64 sas_rtxchunks; /* Retransmitted Chunks */
1021 __u64 sas_outofseqtsns;/* TSN received > next expected */
1022 __u64 sas_idupchunks; /* Dups received (ordered+unordered) */
1023 __u64 sas_gapcnt; /* Gap Acknowledgements Received */
1024 __u64 sas_ouodchunks; /* Unordered data chunks sent */
1025 __u64 sas_iuodchunks; /* Unordered data chunks received */
1026 __u64 sas_oodchunks; /* Ordered data chunks sent */
1027 __u64 sas_iodchunks; /* Ordered data chunks received */
1028 __u64 sas_octrlchunks; /* Control chunks sent */
1029 __u64 sas_ictrlchunks; /* Control chunks received */
1035 * The flags parameter is formed from the bitwise OR of zero or more of the
1036 * following currently defined flags:
1038 #define SCTP_BINDX_ADD_ADDR 0x01
1039 #define SCTP_BINDX_REM_ADDR 0x02
1041 /* This is the structure that is passed as an argument(optval) to
1042 * getsockopt(SCTP_SOCKOPT_PEELOFF).
1045 sctp_assoc_t associd;
1047 } sctp_peeloff_arg_t;
1050 sctp_peeloff_arg_t p_arg;
1052 } sctp_peeloff_flags_arg_t;
1055 * Peer Address Thresholds socket option
1057 struct sctp_paddrthlds {
1058 sctp_assoc_t spt_assoc_id;
1059 struct sockaddr_storage spt_address;
1060 __u16 spt_pathmaxrxt;
1061 __u16 spt_pathpfthld;
1065 * Socket Option for Getting the Association/Stream-Specific PR-SCTP Status
1067 struct sctp_prstatus {
1068 sctp_assoc_t sprstat_assoc_id;
1070 __u16 sprstat_policy;
1071 __u64 sprstat_abandoned_unsent;
1072 __u64 sprstat_abandoned_sent;
1075 struct sctp_default_prinfo {
1076 sctp_assoc_t pr_assoc_id;
1085 __u16 sctpi_unackdata;
1086 __u16 sctpi_penddata;
1087 __u16 sctpi_instrms;
1088 __u16 sctpi_outstrms;
1089 __u32 sctpi_fragmentation_point;
1090 __u32 sctpi_inqueue;
1091 __u32 sctpi_outqueue;
1092 __u32 sctpi_overall_error;
1093 __u32 sctpi_max_burst;
1095 __u32 sctpi_peer_rwnd;
1096 __u32 sctpi_peer_tag;
1097 __u8 sctpi_peer_capable;
1098 __u8 sctpi_peer_sack;
1101 /* assoc status info */
1104 __u64 sctpi_opackets;
1105 __u64 sctpi_ipackets;
1106 __u64 sctpi_rtxchunks;
1107 __u64 sctpi_outofseqtsns;
1108 __u64 sctpi_idupchunks;
1110 __u64 sctpi_ouodchunks;
1111 __u64 sctpi_iuodchunks;
1112 __u64 sctpi_oodchunks;
1113 __u64 sctpi_iodchunks;
1114 __u64 sctpi_octrlchunks;
1115 __u64 sctpi_ictrlchunks;
1117 /* primary transport info */
1118 struct sockaddr_storage sctpi_p_address;
1119 __s32 sctpi_p_state;
1123 __u32 sctpi_p_hbinterval;
1124 __u32 sctpi_p_pathmaxrxt;
1125 __u32 sctpi_p_sackdelay;
1126 __u32 sctpi_p_sackfreq;
1127 __u32 sctpi_p_ssthresh;
1128 __u32 sctpi_p_partial_bytes_acked;
1129 __u32 sctpi_p_flight_size;
1130 __u16 sctpi_p_error;
1133 /* sctp sock info */
1134 __u32 sctpi_s_autoclose;
1135 __u32 sctpi_s_adaptation_ind;
1136 __u32 sctpi_s_pd_point;
1137 __u8 sctpi_s_nodelay;
1138 __u8 sctpi_s_disable_fragments;
1139 __u8 sctpi_s_v4mapped;
1140 __u8 sctpi_s_frag_interleave;
1145 struct sctp_reset_streams {
1146 sctp_assoc_t srs_assoc_id;
1148 uint16_t srs_number_streams; /* 0 == ALL */
1149 uint16_t srs_stream_list[]; /* list if srs_num_streams is not 0 */
1152 struct sctp_add_streams {
1153 sctp_assoc_t sas_assoc_id;
1154 uint16_t sas_instrms;
1155 uint16_t sas_outstrms;
1159 sctp_assoc_t se_assoc_id;
1164 /* SCTP Stream schedulers */
1165 enum sctp_sched_type {
1167 SCTP_SS_DEFAULT = SCTP_SS_FCFS,
1170 SCTP_SS_MAX = SCTP_SS_RR
1173 #endif /* _UAPI_SCTP_H */