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
127 /* PR-SCTP policies */
128 #define SCTP_PR_SCTP_NONE 0x0000
129 #define SCTP_PR_SCTP_TTL 0x0010
130 #define SCTP_PR_SCTP_RTX 0x0020
131 #define SCTP_PR_SCTP_PRIO 0x0030
132 #define SCTP_PR_SCTP_MAX SCTP_PR_SCTP_PRIO
133 #define SCTP_PR_SCTP_MASK 0x0030
135 #define __SCTP_PR_INDEX(x) ((x >> 4) - 1)
136 #define SCTP_PR_INDEX(x) __SCTP_PR_INDEX(SCTP_PR_SCTP_ ## x)
138 #define SCTP_PR_POLICY(x) ((x) & SCTP_PR_SCTP_MASK)
139 #define SCTP_PR_SET_POLICY(flags, x) \
141 flags &= ~SCTP_PR_SCTP_MASK; \
145 #define SCTP_PR_TTL_ENABLED(x) (SCTP_PR_POLICY(x) == SCTP_PR_SCTP_TTL)
146 #define SCTP_PR_RTX_ENABLED(x) (SCTP_PR_POLICY(x) == SCTP_PR_SCTP_RTX)
147 #define SCTP_PR_PRIO_ENABLED(x) (SCTP_PR_POLICY(x) == SCTP_PR_SCTP_PRIO)
149 /* For enable stream reset */
150 #define SCTP_ENABLE_RESET_STREAM_REQ 0x01
151 #define SCTP_ENABLE_RESET_ASSOC_REQ 0x02
152 #define SCTP_ENABLE_CHANGE_ASSOC_REQ 0x04
153 #define SCTP_ENABLE_STRRESET_MASK 0x07
155 #define SCTP_STREAM_RESET_INCOMING 0x01
156 #define SCTP_STREAM_RESET_OUTGOING 0x02
158 /* These are bit fields for msghdr->msg_flags. See section 5.1. */
159 /* On user space Linux, these live in <bits/socket.h> as an enum. */
160 enum sctp_msg_flags {
161 MSG_NOTIFICATION = 0x8000,
162 #define MSG_NOTIFICATION MSG_NOTIFICATION
165 /* 5.3.1 SCTP Initiation Structure (SCTP_INIT)
167 * This cmsghdr structure provides information for initializing new
168 * SCTP associations with sendmsg(). The SCTP_INITMSG socket option
169 * uses this same data structure. This structure is not used for
172 * cmsg_level cmsg_type cmsg_data[]
173 * ------------ ------------ ----------------------
174 * IPPROTO_SCTP SCTP_INIT struct sctp_initmsg
176 struct sctp_initmsg {
177 __u16 sinit_num_ostreams;
178 __u16 sinit_max_instreams;
179 __u16 sinit_max_attempts;
180 __u16 sinit_max_init_timeo;
183 /* 5.3.2 SCTP Header Information Structure (SCTP_SNDRCV)
185 * This cmsghdr structure specifies SCTP options for sendmsg() and
186 * describes SCTP header information about a received message through
189 * cmsg_level cmsg_type cmsg_data[]
190 * ------------ ------------ ----------------------
191 * IPPROTO_SCTP SCTP_SNDRCV struct sctp_sndrcvinfo
193 struct sctp_sndrcvinfo {
199 __u32 sinfo_timetolive;
202 sctp_assoc_t sinfo_assoc_id;
205 /* 5.3.4 SCTP Send Information Structure (SCTP_SNDINFO)
207 * This cmsghdr structure specifies SCTP options for sendmsg().
209 * cmsg_level cmsg_type cmsg_data[]
210 * ------------ ------------ -------------------
211 * IPPROTO_SCTP SCTP_SNDINFO struct sctp_sndinfo
213 struct sctp_sndinfo {
218 sctp_assoc_t snd_assoc_id;
221 /* 5.3.5 SCTP Receive Information Structure (SCTP_RCVINFO)
223 * This cmsghdr structure describes SCTP receive information
224 * about a received message through recvmsg().
226 * cmsg_level cmsg_type cmsg_data[]
227 * ------------ ------------ -------------------
228 * IPPROTO_SCTP SCTP_RCVINFO struct sctp_rcvinfo
230 struct sctp_rcvinfo {
238 sctp_assoc_t rcv_assoc_id;
241 /* 5.3.6 SCTP Next Receive Information Structure (SCTP_NXTINFO)
243 * This cmsghdr structure describes SCTP receive information
244 * of the next message that will be delivered through recvmsg()
245 * if this information is already available when delivering
246 * the current message.
248 * cmsg_level cmsg_type cmsg_data[]
249 * ------------ ------------ -------------------
250 * IPPROTO_SCTP SCTP_NXTINFO struct sctp_nxtinfo
252 struct sctp_nxtinfo {
257 sctp_assoc_t nxt_assoc_id;
261 * sinfo_flags: 16 bits (unsigned integer)
263 * This field may contain any of the following flags and is composed of
264 * a bitwise OR of these values.
266 enum sctp_sinfo_flags {
267 SCTP_UNORDERED = (1 << 0), /* Send/receive message unordered. */
268 SCTP_ADDR_OVER = (1 << 1), /* Override the primary destination. */
269 SCTP_ABORT = (1 << 2), /* Send an ABORT message to the peer. */
270 SCTP_SACK_IMMEDIATELY = (1 << 3), /* SACK should be sent without delay. */
271 SCTP_NOTIFICATION = MSG_NOTIFICATION, /* Next message is not user msg but notification. */
272 SCTP_EOF = MSG_FIN, /* Initiate graceful shutdown process. */
277 struct sctp_initmsg init;
278 struct sctp_sndrcvinfo sndrcv;
281 /* These are cmsg_types. */
282 typedef enum sctp_cmsg_type {
283 SCTP_INIT, /* 5.2.1 SCTP Initiation Structure */
284 #define SCTP_INIT SCTP_INIT
285 SCTP_SNDRCV, /* 5.2.2 SCTP Header Information Structure */
286 #define SCTP_SNDRCV SCTP_SNDRCV
287 SCTP_SNDINFO, /* 5.3.4 SCTP Send Information Structure */
288 #define SCTP_SNDINFO SCTP_SNDINFO
289 SCTP_RCVINFO, /* 5.3.5 SCTP Receive Information Structure */
290 #define SCTP_RCVINFO SCTP_RCVINFO
291 SCTP_NXTINFO, /* 5.3.6 SCTP Next Receive Information Structure */
292 #define SCTP_NXTINFO SCTP_NXTINFO
296 * 5.3.1.1 SCTP_ASSOC_CHANGE
298 * Communication notifications inform the ULP that an SCTP association
299 * has either begun or ended. The identifier for a new association is
300 * provided by this notificaion. The notification information has the
304 struct sctp_assoc_change {
310 __u16 sac_outbound_streams;
311 __u16 sac_inbound_streams;
312 sctp_assoc_t sac_assoc_id;
317 * sac_state: 32 bits (signed integer)
319 * This field holds one of a number of values that communicate the
320 * event that happened to the association. They include:
322 * Note: The following state names deviate from the API draft as
323 * the names clash too easily with other kernel symbols.
325 enum sctp_sac_state {
334 * 5.3.1.2 SCTP_PEER_ADDR_CHANGE
336 * When a destination address on a multi-homed peer encounters a change
337 * an interface details event is sent. The information has the
338 * following structure:
340 struct sctp_paddr_change {
344 struct sockaddr_storage spc_aaddr;
347 sctp_assoc_t spc_assoc_id;
348 } __attribute__((packed, aligned(4)));
351 * spc_state: 32 bits (signed integer)
353 * This field holds one of a number of values that communicate the
354 * event that happened to the address. They include:
356 enum sctp_spc_state {
358 SCTP_ADDR_UNREACHABLE,
367 * 5.3.1.3 SCTP_REMOTE_ERROR
369 * A remote peer may send an Operational Error message to its peer.
370 * This message indicates a variety of error conditions on an
371 * association. The entire error TLV as it appears on the wire is
372 * included in a SCTP_REMOTE_ERROR event. Please refer to the SCTP
373 * specification [SCTP] and any extensions for a list of possible
374 * error formats. SCTP error TLVs have the format:
376 struct sctp_remote_error {
381 sctp_assoc_t sre_assoc_id;
387 * 5.3.1.4 SCTP_SEND_FAILED
389 * If SCTP cannot deliver a message it may return the message as a
392 struct sctp_send_failed {
397 struct sctp_sndrcvinfo ssf_info;
398 sctp_assoc_t ssf_assoc_id;
403 * ssf_flags: 16 bits (unsigned integer)
405 * The flag value will take one of the following values
407 * SCTP_DATA_UNSENT - Indicates that the data was never put on
410 * SCTP_DATA_SENT - Indicates that the data was put on the wire.
411 * Note that this does not necessarily mean that the
412 * data was (or was not) successfully delivered.
414 enum sctp_ssf_flags {
420 * 5.3.1.5 SCTP_SHUTDOWN_EVENT
422 * When a peer sends a SHUTDOWN, SCTP delivers this notification to
423 * inform the application that it should cease sending data.
425 struct sctp_shutdown_event {
429 sctp_assoc_t sse_assoc_id;
433 * 5.3.1.6 SCTP_ADAPTATION_INDICATION
435 * When a peer sends a Adaptation Layer Indication parameter , SCTP
436 * delivers this notification to inform the application
437 * that of the peers requested adaptation layer.
439 struct sctp_adaptation_event {
443 __u32 sai_adaptation_ind;
444 sctp_assoc_t sai_assoc_id;
448 * 5.3.1.7 SCTP_PARTIAL_DELIVERY_EVENT
450 * When a receiver is engaged in a partial delivery of a
451 * message this notification will be used to indicate
454 struct sctp_pdapi_event {
458 __u32 pdapi_indication;
459 sctp_assoc_t pdapi_assoc_id;
462 enum { SCTP_PARTIAL_DELIVERY_ABORTED=0, };
465 * 5.3.1.8. SCTP_AUTHENTICATION_EVENT
467 * When a receiver is using authentication this message will provide
468 * notifications regarding new keys being made active as well as errors.
470 struct sctp_authkey_event {
474 __u16 auth_keynumber;
475 __u16 auth_altkeynumber;
476 __u32 auth_indication;
477 sctp_assoc_t auth_assoc_id;
480 enum { SCTP_AUTH_NEWKEY = 0, };
483 * 6.1.9. SCTP_SENDER_DRY_EVENT
485 * When the SCTP stack has no more user data to send or retransmit, this
486 * notification is given to the user. Also, at the time when a user app
487 * subscribes to this event, if there is no data to be sent or
488 * retransmit, the stack will immediately send up this notification.
490 struct sctp_sender_dry_event {
491 __u16 sender_dry_type;
492 __u16 sender_dry_flags;
493 __u32 sender_dry_length;
494 sctp_assoc_t sender_dry_assoc_id;
497 #define SCTP_STREAM_RESET_INCOMING_SSN 0x0001
498 #define SCTP_STREAM_RESET_OUTGOING_SSN 0x0002
499 #define SCTP_STREAM_RESET_DENIED 0x0004
500 #define SCTP_STREAM_RESET_FAILED 0x0008
501 struct sctp_stream_reset_event {
503 __u16 strreset_flags;
504 __u32 strreset_length;
505 sctp_assoc_t strreset_assoc_id;
506 __u16 strreset_stream_list[];
509 #define SCTP_ASSOC_RESET_DENIED 0x0004
510 #define SCTP_ASSOC_RESET_FAILED 0x0008
511 struct sctp_assoc_reset_event {
512 __u16 assocreset_type;
513 __u16 assocreset_flags;
514 __u32 assocreset_length;
515 sctp_assoc_t assocreset_assoc_id;
516 __u32 assocreset_local_tsn;
517 __u32 assocreset_remote_tsn;
520 #define SCTP_ASSOC_CHANGE_DENIED 0x0004
521 #define SCTP_ASSOC_CHANGE_FAILED 0x0008
522 #define SCTP_STREAM_CHANGE_DENIED SCTP_ASSOC_CHANGE_DENIED
523 #define SCTP_STREAM_CHANGE_FAILED SCTP_ASSOC_CHANGE_FAILED
524 struct sctp_stream_change_event {
525 __u16 strchange_type;
526 __u16 strchange_flags;
527 __u32 strchange_length;
528 sctp_assoc_t strchange_assoc_id;
529 __u16 strchange_instrms;
530 __u16 strchange_outstrms;
534 * Described in Section 7.3
535 * Ancillary Data and Notification Interest Options
537 struct sctp_event_subscribe {
538 __u8 sctp_data_io_event;
539 __u8 sctp_association_event;
540 __u8 sctp_address_event;
541 __u8 sctp_send_failure_event;
542 __u8 sctp_peer_error_event;
543 __u8 sctp_shutdown_event;
544 __u8 sctp_partial_delivery_event;
545 __u8 sctp_adaptation_layer_event;
546 __u8 sctp_authentication_event;
547 __u8 sctp_sender_dry_event;
548 __u8 sctp_stream_reset_event;
549 __u8 sctp_assoc_reset_event;
550 __u8 sctp_stream_change_event;
554 * 5.3.1 SCTP Notification Structure
556 * The notification structure is defined as the union of all
557 * notification types.
560 union sctp_notification {
562 __u16 sn_type; /* Notification type. */
566 struct sctp_assoc_change sn_assoc_change;
567 struct sctp_paddr_change sn_paddr_change;
568 struct sctp_remote_error sn_remote_error;
569 struct sctp_send_failed sn_send_failed;
570 struct sctp_shutdown_event sn_shutdown_event;
571 struct sctp_adaptation_event sn_adaptation_event;
572 struct sctp_pdapi_event sn_pdapi_event;
573 struct sctp_authkey_event sn_authkey_event;
574 struct sctp_sender_dry_event sn_sender_dry_event;
575 struct sctp_stream_reset_event sn_strreset_event;
576 struct sctp_assoc_reset_event sn_assocreset_event;
577 struct sctp_stream_change_event sn_strchange_event;
581 * All standard values for sn_type flags are greater than 2^15.
582 * Values from 2^15 and down are reserved.
586 SCTP_SN_TYPE_BASE = (1<<15),
588 #define SCTP_ASSOC_CHANGE SCTP_ASSOC_CHANGE
589 SCTP_PEER_ADDR_CHANGE,
590 #define SCTP_PEER_ADDR_CHANGE SCTP_PEER_ADDR_CHANGE
592 #define SCTP_SEND_FAILED SCTP_SEND_FAILED
594 #define SCTP_REMOTE_ERROR SCTP_REMOTE_ERROR
596 #define SCTP_SHUTDOWN_EVENT SCTP_SHUTDOWN_EVENT
597 SCTP_PARTIAL_DELIVERY_EVENT,
598 #define SCTP_PARTIAL_DELIVERY_EVENT SCTP_PARTIAL_DELIVERY_EVENT
599 SCTP_ADAPTATION_INDICATION,
600 #define SCTP_ADAPTATION_INDICATION SCTP_ADAPTATION_INDICATION
601 SCTP_AUTHENTICATION_EVENT,
602 #define SCTP_AUTHENTICATION_INDICATION SCTP_AUTHENTICATION_EVENT
603 SCTP_SENDER_DRY_EVENT,
604 #define SCTP_SENDER_DRY_EVENT SCTP_SENDER_DRY_EVENT
605 SCTP_STREAM_RESET_EVENT,
606 #define SCTP_STREAM_RESET_EVENT SCTP_STREAM_RESET_EVENT
607 SCTP_ASSOC_RESET_EVENT,
608 #define SCTP_ASSOC_RESET_EVENT SCTP_ASSOC_RESET_EVENT
609 SCTP_STREAM_CHANGE_EVENT,
610 #define SCTP_STREAM_CHANGE_EVENT SCTP_STREAM_CHANGE_EVENT
613 /* Notification error codes used to fill up the error fields in some
615 * SCTP_PEER_ADDRESS_CHAGE : spc_error
616 * SCTP_ASSOC_CHANGE : sac_error
617 * These names should be potentially included in the draft 04 of the SCTP
618 * sockets API specification.
620 typedef enum sctp_sn_error {
621 SCTP_FAILED_THRESHOLD,
623 SCTP_HEARTBEAT_SUCCESS,
624 SCTP_RESPONSE_TO_USER_REQ,
626 SCTP_SHUTDOWN_GUARD_EXPIRES,
631 * 7.1.1 Retransmission Timeout Parameters (SCTP_RTOINFO)
633 * The protocol parameters used to initialize and bound retransmission
634 * timeout (RTO) are tunable. See [SCTP] for more information on how
635 * these parameters are used in RTO calculation.
637 struct sctp_rtoinfo {
638 sctp_assoc_t srto_assoc_id;
645 * 7.1.2 Association Parameters (SCTP_ASSOCINFO)
647 * This option is used to both examine and set various association and
648 * endpoint parameters.
650 struct sctp_assocparams {
651 sctp_assoc_t sasoc_assoc_id;
652 __u16 sasoc_asocmaxrxt;
653 __u16 sasoc_number_peer_destinations;
654 __u32 sasoc_peer_rwnd;
655 __u32 sasoc_local_rwnd;
656 __u32 sasoc_cookie_life;
660 * 7.1.9 Set Peer Primary Address (SCTP_SET_PEER_PRIMARY_ADDR)
662 * Requests that the peer mark the enclosed address as the association
663 * primary. The enclosed address must be one of the association's
664 * locally bound addresses. The following structure is used to make a
665 * set primary request:
667 struct sctp_setpeerprim {
668 sctp_assoc_t sspp_assoc_id;
669 struct sockaddr_storage sspp_addr;
670 } __attribute__((packed, aligned(4)));
673 * 7.1.10 Set Primary Address (SCTP_PRIMARY_ADDR)
675 * Requests that the local SCTP stack use the enclosed peer address as
676 * the association primary. The enclosed address must be one of the
677 * association peer's addresses. The following structure is used to
678 * make a set peer primary request:
681 sctp_assoc_t ssp_assoc_id;
682 struct sockaddr_storage ssp_addr;
683 } __attribute__((packed, aligned(4)));
685 /* For backward compatibility use, define the old name too */
686 #define sctp_setprim sctp_prim
689 * 7.1.11 Set Adaptation Layer Indicator (SCTP_ADAPTATION_LAYER)
691 * Requests that the local endpoint set the specified Adaptation Layer
692 * Indication parameter for all future INIT and INIT-ACK exchanges.
694 struct sctp_setadaptation {
695 __u32 ssb_adaptation_ind;
699 * 7.1.13 Peer Address Parameters (SCTP_PEER_ADDR_PARAMS)
701 * Applications can enable or disable heartbeats for any peer address
702 * of an association, modify an address's heartbeat interval, force a
703 * heartbeat to be sent immediately, and adjust the address's maximum
704 * number of retransmissions sent before an address is considered
705 * unreachable. The following structure is used to access and modify an
706 * address's parameters:
708 enum sctp_spp_flags {
709 SPP_HB_ENABLE = 1<<0, /*Enable heartbeats*/
710 SPP_HB_DISABLE = 1<<1, /*Disable heartbeats*/
711 SPP_HB = SPP_HB_ENABLE | SPP_HB_DISABLE,
712 SPP_HB_DEMAND = 1<<2, /*Send heartbeat immediately*/
713 SPP_PMTUD_ENABLE = 1<<3, /*Enable PMTU discovery*/
714 SPP_PMTUD_DISABLE = 1<<4, /*Disable PMTU discovery*/
715 SPP_PMTUD = SPP_PMTUD_ENABLE | SPP_PMTUD_DISABLE,
716 SPP_SACKDELAY_ENABLE = 1<<5, /*Enable SACK*/
717 SPP_SACKDELAY_DISABLE = 1<<6, /*Disable SACK*/
718 SPP_SACKDELAY = SPP_SACKDELAY_ENABLE | SPP_SACKDELAY_DISABLE,
719 SPP_HB_TIME_IS_ZERO = 1<<7, /* Set HB delay to 0 */
722 struct sctp_paddrparams {
723 sctp_assoc_t spp_assoc_id;
724 struct sockaddr_storage spp_address;
725 __u32 spp_hbinterval;
726 __u16 spp_pathmaxrxt;
730 } __attribute__((packed, aligned(4)));
733 * 7.1.18. Add a chunk that must be authenticated (SCTP_AUTH_CHUNK)
735 * This set option adds a chunk type that the user is requesting to be
736 * received only in an authenticated way. Changes to the list of chunks
737 * will only effect future associations on the socket.
739 struct sctp_authchunk {
744 * 7.1.19. Get or set the list of supported HMAC Identifiers (SCTP_HMAC_IDENT)
746 * This option gets or sets the list of HMAC algorithms that the local
747 * endpoint requires the peer to use.
750 /* This here is only used by user space as is. It might not be a good idea
751 * to export/reveal the whole structure with reserved fields etc.
754 SCTP_AUTH_HMAC_ID_SHA1 = 1,
755 SCTP_AUTH_HMAC_ID_SHA256 = 3,
759 struct sctp_hmacalgo {
760 __u32 shmac_num_idents;
761 __u16 shmac_idents[];
764 /* Sadly, user and kernel space have different names for
765 * this structure member, so this is to not break anything.
767 #define shmac_number_of_idents shmac_num_idents
770 * 7.1.20. Set a shared key (SCTP_AUTH_KEY)
772 * This option will set a shared secret key which is used to build an
773 * association shared key.
775 struct sctp_authkey {
776 sctp_assoc_t sca_assoc_id;
783 * 7.1.21. Get or set the active shared key (SCTP_AUTH_ACTIVE_KEY)
785 * This option will get or set the active shared key to be used to build
786 * the association shared key.
789 struct sctp_authkeyid {
790 sctp_assoc_t scact_assoc_id;
791 __u16 scact_keynumber;
796 * 7.1.23. Get or set delayed ack timer (SCTP_DELAYED_SACK)
798 * This option will effect the way delayed acks are performed. This
799 * option allows you to get or set the delayed ack time, in
800 * milliseconds. It also allows changing the delayed ack frequency.
801 * Changing the frequency to 1 disables the delayed sack algorithm. If
802 * the assoc_id is 0, then this sets or gets the endpoints default
803 * values. If the assoc_id field is non-zero, then the set or get
804 * effects the specified association for the one to many model (the
805 * assoc_id field is ignored by the one to one model). Note that if
806 * sack_delay or sack_freq are 0 when setting this option, then the
807 * current values will remain unchanged.
809 struct sctp_sack_info {
810 sctp_assoc_t sack_assoc_id;
815 struct sctp_assoc_value {
816 sctp_assoc_t assoc_id;
817 uint32_t assoc_value;
821 * 7.2.2 Peer Address Information
823 * Applications can retrieve information about a specific peer address
824 * of an association, including its reachability state, congestion
825 * window, and retransmission timer values. This information is
826 * read-only. The following structure is used to access this
829 struct sctp_paddrinfo {
830 sctp_assoc_t spinfo_assoc_id;
831 struct sockaddr_storage spinfo_address;
837 } __attribute__((packed, aligned(4)));
839 /* Peer addresses's state. */
840 /* UNKNOWN: Peer address passed by the upper layer in sendmsg or connect[x]
842 * UNCONFIRMED: Peer address received in INIT/INIT-ACK address parameters.
843 * Not yet confirmed by a heartbeat and not available for data
845 * ACTIVE : Peer address confirmed, active and available for data transfers.
846 * INACTIVE: Peer address inactive and not available for data transfers.
848 enum sctp_spinfo_state {
853 SCTP_UNKNOWN = 0xffff /* Value used for transport state unknown */
857 * 7.2.1 Association Status (SCTP_STATUS)
859 * Applications can retrieve current status information about an
860 * association, including association state, peer receiver window size,
861 * number of unacked data chunks, and number of data chunks pending
862 * receipt. This information is read-only. The following structure is
863 * used to access this information:
866 sctp_assoc_t sstat_assoc_id;
869 __u16 sstat_unackdata;
870 __u16 sstat_penddata;
872 __u16 sstat_outstrms;
873 __u32 sstat_fragmentation_point;
874 struct sctp_paddrinfo sstat_primary;
878 * 7.2.3. Get the list of chunks the peer requires to be authenticated
879 * (SCTP_PEER_AUTH_CHUNKS)
881 * This option gets a list of chunks for a specified association that
882 * the peer requires to be received authenticated only.
884 struct sctp_authchunks {
885 sctp_assoc_t gauth_assoc_id;
886 __u32 gauth_number_of_chunks;
887 uint8_t gauth_chunks[];
890 /* The broken spelling has been released already in lksctp-tools header,
891 * so don't break anyone, now that it's fixed.
893 #define guth_number_of_chunks gauth_number_of_chunks
895 /* Association states. */
896 enum sctp_sstat_state {
899 SCTP_COOKIE_WAIT = 2,
900 SCTP_COOKIE_ECHOED = 3,
901 SCTP_ESTABLISHED = 4,
902 SCTP_SHUTDOWN_PENDING = 5,
903 SCTP_SHUTDOWN_SENT = 6,
904 SCTP_SHUTDOWN_RECEIVED = 7,
905 SCTP_SHUTDOWN_ACK_SENT = 8,
909 * 8.2.6. Get the Current Identifiers of Associations
910 * (SCTP_GET_ASSOC_ID_LIST)
912 * This option gets the current list of SCTP association identifiers of
913 * the SCTP associations handled by a one-to-many style socket.
915 struct sctp_assoc_ids {
916 __u32 gaids_number_of_ids;
917 sctp_assoc_t gaids_assoc_id[];
921 * 8.3, 8.5 get all peer/local addresses in an association.
922 * This parameter struct is used by SCTP_GET_PEER_ADDRS and
923 * SCTP_GET_LOCAL_ADDRS socket options used internally to implement
924 * sctp_getpaddrs() and sctp_getladdrs() API.
926 struct sctp_getaddrs_old {
927 sctp_assoc_t assoc_id;
930 struct sockaddr __user *addrs;
932 struct sockaddr *addrs;
936 struct sctp_getaddrs {
937 sctp_assoc_t assoc_id; /*input*/
938 __u32 addr_num; /*output*/
939 __u8 addrs[0]; /*output, variable size*/
942 /* A socket user request obtained via SCTP_GET_ASSOC_STATS that retrieves
943 * association stats. All stats are counts except sas_maxrto and
944 * sas_obs_rto_ipaddr. maxrto is the max observed rto + transport since
945 * the last call. Will return 0 when RTO was not update since last call
947 struct sctp_assoc_stats {
948 sctp_assoc_t sas_assoc_id; /* Input */
949 /* Transport of observed max RTO */
950 struct sockaddr_storage sas_obs_rto_ipaddr;
951 __u64 sas_maxrto; /* Maximum Observed RTO for period */
952 __u64 sas_isacks; /* SACKs received */
953 __u64 sas_osacks; /* SACKs sent */
954 __u64 sas_opackets; /* Packets sent */
955 __u64 sas_ipackets; /* Packets received */
956 __u64 sas_rtxchunks; /* Retransmitted Chunks */
957 __u64 sas_outofseqtsns;/* TSN received > next expected */
958 __u64 sas_idupchunks; /* Dups received (ordered+unordered) */
959 __u64 sas_gapcnt; /* Gap Acknowledgements Received */
960 __u64 sas_ouodchunks; /* Unordered data chunks sent */
961 __u64 sas_iuodchunks; /* Unordered data chunks received */
962 __u64 sas_oodchunks; /* Ordered data chunks sent */
963 __u64 sas_iodchunks; /* Ordered data chunks received */
964 __u64 sas_octrlchunks; /* Control chunks sent */
965 __u64 sas_ictrlchunks; /* Control chunks received */
971 * The flags parameter is formed from the bitwise OR of zero or more of the
972 * following currently defined flags:
974 #define SCTP_BINDX_ADD_ADDR 0x01
975 #define SCTP_BINDX_REM_ADDR 0x02
977 /* This is the structure that is passed as an argument(optval) to
978 * getsockopt(SCTP_SOCKOPT_PEELOFF).
981 sctp_assoc_t associd;
983 } sctp_peeloff_arg_t;
986 sctp_peeloff_arg_t p_arg;
988 } sctp_peeloff_flags_arg_t;
991 * Peer Address Thresholds socket option
993 struct sctp_paddrthlds {
994 sctp_assoc_t spt_assoc_id;
995 struct sockaddr_storage spt_address;
996 __u16 spt_pathmaxrxt;
997 __u16 spt_pathpfthld;
1001 * Socket Option for Getting the Association/Stream-Specific PR-SCTP Status
1003 struct sctp_prstatus {
1004 sctp_assoc_t sprstat_assoc_id;
1006 __u16 sprstat_policy;
1007 __u64 sprstat_abandoned_unsent;
1008 __u64 sprstat_abandoned_sent;
1011 struct sctp_default_prinfo {
1012 sctp_assoc_t pr_assoc_id;
1021 __u16 sctpi_unackdata;
1022 __u16 sctpi_penddata;
1023 __u16 sctpi_instrms;
1024 __u16 sctpi_outstrms;
1025 __u32 sctpi_fragmentation_point;
1026 __u32 sctpi_inqueue;
1027 __u32 sctpi_outqueue;
1028 __u32 sctpi_overall_error;
1029 __u32 sctpi_max_burst;
1031 __u32 sctpi_peer_rwnd;
1032 __u32 sctpi_peer_tag;
1033 __u8 sctpi_peer_capable;
1034 __u8 sctpi_peer_sack;
1037 /* assoc status info */
1040 __u64 sctpi_opackets;
1041 __u64 sctpi_ipackets;
1042 __u64 sctpi_rtxchunks;
1043 __u64 sctpi_outofseqtsns;
1044 __u64 sctpi_idupchunks;
1046 __u64 sctpi_ouodchunks;
1047 __u64 sctpi_iuodchunks;
1048 __u64 sctpi_oodchunks;
1049 __u64 sctpi_iodchunks;
1050 __u64 sctpi_octrlchunks;
1051 __u64 sctpi_ictrlchunks;
1053 /* primary transport info */
1054 struct sockaddr_storage sctpi_p_address;
1055 __s32 sctpi_p_state;
1059 __u32 sctpi_p_hbinterval;
1060 __u32 sctpi_p_pathmaxrxt;
1061 __u32 sctpi_p_sackdelay;
1062 __u32 sctpi_p_sackfreq;
1063 __u32 sctpi_p_ssthresh;
1064 __u32 sctpi_p_partial_bytes_acked;
1065 __u32 sctpi_p_flight_size;
1066 __u16 sctpi_p_error;
1069 /* sctp sock info */
1070 __u32 sctpi_s_autoclose;
1071 __u32 sctpi_s_adaptation_ind;
1072 __u32 sctpi_s_pd_point;
1073 __u8 sctpi_s_nodelay;
1074 __u8 sctpi_s_disable_fragments;
1075 __u8 sctpi_s_v4mapped;
1076 __u8 sctpi_s_frag_interleave;
1081 struct sctp_reset_streams {
1082 sctp_assoc_t srs_assoc_id;
1084 uint16_t srs_number_streams; /* 0 == ALL */
1085 uint16_t srs_stream_list[]; /* list if srs_num_streams is not 0 */
1088 struct sctp_add_streams {
1089 sctp_assoc_t sas_assoc_id;
1090 uint16_t sas_instrms;
1091 uint16_t sas_outstrms;
1094 #endif /* _UAPI_SCTP_H */