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
129 /* PR-SCTP policies */
130 #define SCTP_PR_SCTP_NONE 0x0000
131 #define SCTP_PR_SCTP_TTL 0x0010
132 #define SCTP_PR_SCTP_RTX 0x0020
133 #define SCTP_PR_SCTP_PRIO 0x0030
134 #define SCTP_PR_SCTP_MAX SCTP_PR_SCTP_PRIO
135 #define SCTP_PR_SCTP_MASK 0x0030
137 #define __SCTP_PR_INDEX(x) ((x >> 4) - 1)
138 #define SCTP_PR_INDEX(x) __SCTP_PR_INDEX(SCTP_PR_SCTP_ ## x)
140 #define SCTP_PR_POLICY(x) ((x) & SCTP_PR_SCTP_MASK)
141 #define SCTP_PR_SET_POLICY(flags, x) \
143 flags &= ~SCTP_PR_SCTP_MASK; \
147 #define SCTP_PR_TTL_ENABLED(x) (SCTP_PR_POLICY(x) == SCTP_PR_SCTP_TTL)
148 #define SCTP_PR_RTX_ENABLED(x) (SCTP_PR_POLICY(x) == SCTP_PR_SCTP_RTX)
149 #define SCTP_PR_PRIO_ENABLED(x) (SCTP_PR_POLICY(x) == SCTP_PR_SCTP_PRIO)
151 /* For enable stream reset */
152 #define SCTP_ENABLE_RESET_STREAM_REQ 0x01
153 #define SCTP_ENABLE_RESET_ASSOC_REQ 0x02
154 #define SCTP_ENABLE_CHANGE_ASSOC_REQ 0x04
155 #define SCTP_ENABLE_STRRESET_MASK 0x07
157 #define SCTP_STREAM_RESET_INCOMING 0x01
158 #define SCTP_STREAM_RESET_OUTGOING 0x02
160 /* These are bit fields for msghdr->msg_flags. See section 5.1. */
161 /* On user space Linux, these live in <bits/socket.h> as an enum. */
162 enum sctp_msg_flags
{
163 MSG_NOTIFICATION
= 0x8000,
164 #define MSG_NOTIFICATION MSG_NOTIFICATION
167 /* 5.3.1 SCTP Initiation Structure (SCTP_INIT)
169 * This cmsghdr structure provides information for initializing new
170 * SCTP associations with sendmsg(). The SCTP_INITMSG socket option
171 * uses this same data structure. This structure is not used for
174 * cmsg_level cmsg_type cmsg_data[]
175 * ------------ ------------ ----------------------
176 * IPPROTO_SCTP SCTP_INIT struct sctp_initmsg
178 struct sctp_initmsg
{
179 __u16 sinit_num_ostreams
;
180 __u16 sinit_max_instreams
;
181 __u16 sinit_max_attempts
;
182 __u16 sinit_max_init_timeo
;
185 /* 5.3.2 SCTP Header Information Structure (SCTP_SNDRCV)
187 * This cmsghdr structure specifies SCTP options for sendmsg() and
188 * describes SCTP header information about a received message through
191 * cmsg_level cmsg_type cmsg_data[]
192 * ------------ ------------ ----------------------
193 * IPPROTO_SCTP SCTP_SNDRCV struct sctp_sndrcvinfo
195 struct sctp_sndrcvinfo
{
201 __u32 sinfo_timetolive
;
204 sctp_assoc_t sinfo_assoc_id
;
207 /* 5.3.4 SCTP Send Information Structure (SCTP_SNDINFO)
209 * This cmsghdr structure specifies SCTP options for sendmsg().
211 * cmsg_level cmsg_type cmsg_data[]
212 * ------------ ------------ -------------------
213 * IPPROTO_SCTP SCTP_SNDINFO struct sctp_sndinfo
215 struct sctp_sndinfo
{
220 sctp_assoc_t snd_assoc_id
;
223 /* 5.3.5 SCTP Receive Information Structure (SCTP_RCVINFO)
225 * This cmsghdr structure describes SCTP receive information
226 * about a received message through recvmsg().
228 * cmsg_level cmsg_type cmsg_data[]
229 * ------------ ------------ -------------------
230 * IPPROTO_SCTP SCTP_RCVINFO struct sctp_rcvinfo
232 struct sctp_rcvinfo
{
240 sctp_assoc_t rcv_assoc_id
;
243 /* 5.3.6 SCTP Next Receive Information Structure (SCTP_NXTINFO)
245 * This cmsghdr structure describes SCTP receive information
246 * of the next message that will be delivered through recvmsg()
247 * if this information is already available when delivering
248 * the current message.
250 * cmsg_level cmsg_type cmsg_data[]
251 * ------------ ------------ -------------------
252 * IPPROTO_SCTP SCTP_NXTINFO struct sctp_nxtinfo
254 struct sctp_nxtinfo
{
259 sctp_assoc_t nxt_assoc_id
;
263 * sinfo_flags: 16 bits (unsigned integer)
265 * This field may contain any of the following flags and is composed of
266 * a bitwise OR of these values.
268 enum sctp_sinfo_flags
{
269 SCTP_UNORDERED
= (1 << 0), /* Send/receive message unordered. */
270 SCTP_ADDR_OVER
= (1 << 1), /* Override the primary destination. */
271 SCTP_ABORT
= (1 << 2), /* Send an ABORT message to the peer. */
272 SCTP_SACK_IMMEDIATELY
= (1 << 3), /* SACK should be sent without delay. */
273 SCTP_NOTIFICATION
= MSG_NOTIFICATION
, /* Next message is not user msg but notification. */
274 SCTP_EOF
= MSG_FIN
, /* Initiate graceful shutdown process. */
279 struct sctp_initmsg init
;
280 struct sctp_sndrcvinfo sndrcv
;
283 /* These are cmsg_types. */
284 typedef enum sctp_cmsg_type
{
285 SCTP_INIT
, /* 5.2.1 SCTP Initiation Structure */
286 #define SCTP_INIT SCTP_INIT
287 SCTP_SNDRCV
, /* 5.2.2 SCTP Header Information Structure */
288 #define SCTP_SNDRCV SCTP_SNDRCV
289 SCTP_SNDINFO
, /* 5.3.4 SCTP Send Information Structure */
290 #define SCTP_SNDINFO SCTP_SNDINFO
291 SCTP_RCVINFO
, /* 5.3.5 SCTP Receive Information Structure */
292 #define SCTP_RCVINFO SCTP_RCVINFO
293 SCTP_NXTINFO
, /* 5.3.6 SCTP Next Receive Information Structure */
294 #define SCTP_NXTINFO SCTP_NXTINFO
298 * 5.3.1.1 SCTP_ASSOC_CHANGE
300 * Communication notifications inform the ULP that an SCTP association
301 * has either begun or ended. The identifier for a new association is
302 * provided by this notificaion. The notification information has the
306 struct sctp_assoc_change
{
312 __u16 sac_outbound_streams
;
313 __u16 sac_inbound_streams
;
314 sctp_assoc_t sac_assoc_id
;
319 * sac_state: 32 bits (signed integer)
321 * This field holds one of a number of values that communicate the
322 * event that happened to the association. They include:
324 * Note: The following state names deviate from the API draft as
325 * the names clash too easily with other kernel symbols.
327 enum sctp_sac_state
{
336 * 5.3.1.2 SCTP_PEER_ADDR_CHANGE
338 * When a destination address on a multi-homed peer encounters a change
339 * an interface details event is sent. The information has the
340 * following structure:
342 struct sctp_paddr_change
{
346 struct sockaddr_storage spc_aaddr
;
349 sctp_assoc_t spc_assoc_id
;
350 } __attribute__((packed
, aligned(4)));
353 * spc_state: 32 bits (signed integer)
355 * This field holds one of a number of values that communicate the
356 * event that happened to the address. They include:
358 enum sctp_spc_state
{
360 SCTP_ADDR_UNREACHABLE
,
369 * 5.3.1.3 SCTP_REMOTE_ERROR
371 * A remote peer may send an Operational Error message to its peer.
372 * This message indicates a variety of error conditions on an
373 * association. The entire error TLV as it appears on the wire is
374 * included in a SCTP_REMOTE_ERROR event. Please refer to the SCTP
375 * specification [SCTP] and any extensions for a list of possible
376 * error formats. SCTP error TLVs have the format:
378 struct sctp_remote_error
{
383 sctp_assoc_t sre_assoc_id
;
389 * 5.3.1.4 SCTP_SEND_FAILED
391 * If SCTP cannot deliver a message it may return the message as a
394 struct sctp_send_failed
{
399 struct sctp_sndrcvinfo ssf_info
;
400 sctp_assoc_t ssf_assoc_id
;
405 * ssf_flags: 16 bits (unsigned integer)
407 * The flag value will take one of the following values
409 * SCTP_DATA_UNSENT - Indicates that the data was never put on
412 * SCTP_DATA_SENT - Indicates that the data was put on the wire.
413 * Note that this does not necessarily mean that the
414 * data was (or was not) successfully delivered.
416 enum sctp_ssf_flags
{
422 * 5.3.1.5 SCTP_SHUTDOWN_EVENT
424 * When a peer sends a SHUTDOWN, SCTP delivers this notification to
425 * inform the application that it should cease sending data.
427 struct sctp_shutdown_event
{
431 sctp_assoc_t sse_assoc_id
;
435 * 5.3.1.6 SCTP_ADAPTATION_INDICATION
437 * When a peer sends a Adaptation Layer Indication parameter , SCTP
438 * delivers this notification to inform the application
439 * that of the peers requested adaptation layer.
441 struct sctp_adaptation_event
{
445 __u32 sai_adaptation_ind
;
446 sctp_assoc_t sai_assoc_id
;
450 * 5.3.1.7 SCTP_PARTIAL_DELIVERY_EVENT
452 * When a receiver is engaged in a partial delivery of a
453 * message this notification will be used to indicate
456 struct sctp_pdapi_event
{
460 __u32 pdapi_indication
;
461 sctp_assoc_t pdapi_assoc_id
;
464 enum { SCTP_PARTIAL_DELIVERY_ABORTED
=0, };
467 * 5.3.1.8. SCTP_AUTHENTICATION_EVENT
469 * When a receiver is using authentication this message will provide
470 * notifications regarding new keys being made active as well as errors.
472 struct sctp_authkey_event
{
476 __u16 auth_keynumber
;
477 __u16 auth_altkeynumber
;
478 __u32 auth_indication
;
479 sctp_assoc_t auth_assoc_id
;
482 enum { SCTP_AUTH_NEWKEY
= 0, };
485 * 6.1.9. SCTP_SENDER_DRY_EVENT
487 * When the SCTP stack has no more user data to send or retransmit, this
488 * notification is given to the user. Also, at the time when a user app
489 * subscribes to this event, if there is no data to be sent or
490 * retransmit, the stack will immediately send up this notification.
492 struct sctp_sender_dry_event
{
493 __u16 sender_dry_type
;
494 __u16 sender_dry_flags
;
495 __u32 sender_dry_length
;
496 sctp_assoc_t sender_dry_assoc_id
;
499 #define SCTP_STREAM_RESET_INCOMING_SSN 0x0001
500 #define SCTP_STREAM_RESET_OUTGOING_SSN 0x0002
501 #define SCTP_STREAM_RESET_DENIED 0x0004
502 #define SCTP_STREAM_RESET_FAILED 0x0008
503 struct sctp_stream_reset_event
{
505 __u16 strreset_flags
;
506 __u32 strreset_length
;
507 sctp_assoc_t strreset_assoc_id
;
508 __u16 strreset_stream_list
[];
511 #define SCTP_ASSOC_RESET_DENIED 0x0004
512 #define SCTP_ASSOC_RESET_FAILED 0x0008
513 struct sctp_assoc_reset_event
{
514 __u16 assocreset_type
;
515 __u16 assocreset_flags
;
516 __u32 assocreset_length
;
517 sctp_assoc_t assocreset_assoc_id
;
518 __u32 assocreset_local_tsn
;
519 __u32 assocreset_remote_tsn
;
522 #define SCTP_ASSOC_CHANGE_DENIED 0x0004
523 #define SCTP_ASSOC_CHANGE_FAILED 0x0008
524 #define SCTP_STREAM_CHANGE_DENIED SCTP_ASSOC_CHANGE_DENIED
525 #define SCTP_STREAM_CHANGE_FAILED SCTP_ASSOC_CHANGE_FAILED
526 struct sctp_stream_change_event
{
527 __u16 strchange_type
;
528 __u16 strchange_flags
;
529 __u32 strchange_length
;
530 sctp_assoc_t strchange_assoc_id
;
531 __u16 strchange_instrms
;
532 __u16 strchange_outstrms
;
536 * Described in Section 7.3
537 * Ancillary Data and Notification Interest Options
539 struct sctp_event_subscribe
{
540 __u8 sctp_data_io_event
;
541 __u8 sctp_association_event
;
542 __u8 sctp_address_event
;
543 __u8 sctp_send_failure_event
;
544 __u8 sctp_peer_error_event
;
545 __u8 sctp_shutdown_event
;
546 __u8 sctp_partial_delivery_event
;
547 __u8 sctp_adaptation_layer_event
;
548 __u8 sctp_authentication_event
;
549 __u8 sctp_sender_dry_event
;
550 __u8 sctp_stream_reset_event
;
551 __u8 sctp_assoc_reset_event
;
552 __u8 sctp_stream_change_event
;
556 * 5.3.1 SCTP Notification Structure
558 * The notification structure is defined as the union of all
559 * notification types.
562 union sctp_notification
{
564 __u16 sn_type
; /* Notification type. */
568 struct sctp_assoc_change sn_assoc_change
;
569 struct sctp_paddr_change sn_paddr_change
;
570 struct sctp_remote_error sn_remote_error
;
571 struct sctp_send_failed sn_send_failed
;
572 struct sctp_shutdown_event sn_shutdown_event
;
573 struct sctp_adaptation_event sn_adaptation_event
;
574 struct sctp_pdapi_event sn_pdapi_event
;
575 struct sctp_authkey_event sn_authkey_event
;
576 struct sctp_sender_dry_event sn_sender_dry_event
;
577 struct sctp_stream_reset_event sn_strreset_event
;
578 struct sctp_assoc_reset_event sn_assocreset_event
;
579 struct sctp_stream_change_event sn_strchange_event
;
583 * All standard values for sn_type flags are greater than 2^15.
584 * Values from 2^15 and down are reserved.
588 SCTP_SN_TYPE_BASE
= (1<<15),
590 #define SCTP_ASSOC_CHANGE SCTP_ASSOC_CHANGE
591 SCTP_PEER_ADDR_CHANGE
,
592 #define SCTP_PEER_ADDR_CHANGE SCTP_PEER_ADDR_CHANGE
594 #define SCTP_SEND_FAILED SCTP_SEND_FAILED
596 #define SCTP_REMOTE_ERROR SCTP_REMOTE_ERROR
598 #define SCTP_SHUTDOWN_EVENT SCTP_SHUTDOWN_EVENT
599 SCTP_PARTIAL_DELIVERY_EVENT
,
600 #define SCTP_PARTIAL_DELIVERY_EVENT SCTP_PARTIAL_DELIVERY_EVENT
601 SCTP_ADAPTATION_INDICATION
,
602 #define SCTP_ADAPTATION_INDICATION SCTP_ADAPTATION_INDICATION
603 SCTP_AUTHENTICATION_EVENT
,
604 #define SCTP_AUTHENTICATION_INDICATION SCTP_AUTHENTICATION_EVENT
605 SCTP_SENDER_DRY_EVENT
,
606 #define SCTP_SENDER_DRY_EVENT SCTP_SENDER_DRY_EVENT
607 SCTP_STREAM_RESET_EVENT
,
608 #define SCTP_STREAM_RESET_EVENT SCTP_STREAM_RESET_EVENT
609 SCTP_ASSOC_RESET_EVENT
,
610 #define SCTP_ASSOC_RESET_EVENT SCTP_ASSOC_RESET_EVENT
611 SCTP_STREAM_CHANGE_EVENT
,
612 #define SCTP_STREAM_CHANGE_EVENT SCTP_STREAM_CHANGE_EVENT
615 /* Notification error codes used to fill up the error fields in some
617 * SCTP_PEER_ADDRESS_CHAGE : spc_error
618 * SCTP_ASSOC_CHANGE : sac_error
619 * These names should be potentially included in the draft 04 of the SCTP
620 * sockets API specification.
622 typedef enum sctp_sn_error
{
623 SCTP_FAILED_THRESHOLD
,
625 SCTP_HEARTBEAT_SUCCESS
,
626 SCTP_RESPONSE_TO_USER_REQ
,
628 SCTP_SHUTDOWN_GUARD_EXPIRES
,
633 * 7.1.1 Retransmission Timeout Parameters (SCTP_RTOINFO)
635 * The protocol parameters used to initialize and bound retransmission
636 * timeout (RTO) are tunable. See [SCTP] for more information on how
637 * these parameters are used in RTO calculation.
639 struct sctp_rtoinfo
{
640 sctp_assoc_t srto_assoc_id
;
647 * 7.1.2 Association Parameters (SCTP_ASSOCINFO)
649 * This option is used to both examine and set various association and
650 * endpoint parameters.
652 struct sctp_assocparams
{
653 sctp_assoc_t sasoc_assoc_id
;
654 __u16 sasoc_asocmaxrxt
;
655 __u16 sasoc_number_peer_destinations
;
656 __u32 sasoc_peer_rwnd
;
657 __u32 sasoc_local_rwnd
;
658 __u32 sasoc_cookie_life
;
662 * 7.1.9 Set Peer Primary Address (SCTP_SET_PEER_PRIMARY_ADDR)
664 * Requests that the peer mark the enclosed address as the association
665 * primary. The enclosed address must be one of the association's
666 * locally bound addresses. The following structure is used to make a
667 * set primary request:
669 struct sctp_setpeerprim
{
670 sctp_assoc_t sspp_assoc_id
;
671 struct sockaddr_storage sspp_addr
;
672 } __attribute__((packed
, aligned(4)));
675 * 7.1.10 Set Primary Address (SCTP_PRIMARY_ADDR)
677 * Requests that the local SCTP stack use the enclosed peer address as
678 * the association primary. The enclosed address must be one of the
679 * association peer's addresses. The following structure is used to
680 * make a set peer primary request:
683 sctp_assoc_t ssp_assoc_id
;
684 struct sockaddr_storage ssp_addr
;
685 } __attribute__((packed
, aligned(4)));
687 /* For backward compatibility use, define the old name too */
688 #define sctp_setprim sctp_prim
691 * 7.1.11 Set Adaptation Layer Indicator (SCTP_ADAPTATION_LAYER)
693 * Requests that the local endpoint set the specified Adaptation Layer
694 * Indication parameter for all future INIT and INIT-ACK exchanges.
696 struct sctp_setadaptation
{
697 __u32 ssb_adaptation_ind
;
701 * 7.1.13 Peer Address Parameters (SCTP_PEER_ADDR_PARAMS)
703 * Applications can enable or disable heartbeats for any peer address
704 * of an association, modify an address's heartbeat interval, force a
705 * heartbeat to be sent immediately, and adjust the address's maximum
706 * number of retransmissions sent before an address is considered
707 * unreachable. The following structure is used to access and modify an
708 * address's parameters:
710 enum sctp_spp_flags
{
711 SPP_HB_ENABLE
= 1<<0, /*Enable heartbeats*/
712 SPP_HB_DISABLE
= 1<<1, /*Disable heartbeats*/
713 SPP_HB
= SPP_HB_ENABLE
| SPP_HB_DISABLE
,
714 SPP_HB_DEMAND
= 1<<2, /*Send heartbeat immediately*/
715 SPP_PMTUD_ENABLE
= 1<<3, /*Enable PMTU discovery*/
716 SPP_PMTUD_DISABLE
= 1<<4, /*Disable PMTU discovery*/
717 SPP_PMTUD
= SPP_PMTUD_ENABLE
| SPP_PMTUD_DISABLE
,
718 SPP_SACKDELAY_ENABLE
= 1<<5, /*Enable SACK*/
719 SPP_SACKDELAY_DISABLE
= 1<<6, /*Disable SACK*/
720 SPP_SACKDELAY
= SPP_SACKDELAY_ENABLE
| SPP_SACKDELAY_DISABLE
,
721 SPP_HB_TIME_IS_ZERO
= 1<<7, /* Set HB delay to 0 */
724 struct sctp_paddrparams
{
725 sctp_assoc_t spp_assoc_id
;
726 struct sockaddr_storage spp_address
;
727 __u32 spp_hbinterval
;
728 __u16 spp_pathmaxrxt
;
732 } __attribute__((packed
, aligned(4)));
735 * 7.1.18. Add a chunk that must be authenticated (SCTP_AUTH_CHUNK)
737 * This set option adds a chunk type that the user is requesting to be
738 * received only in an authenticated way. Changes to the list of chunks
739 * will only effect future associations on the socket.
741 struct sctp_authchunk
{
746 * 7.1.19. Get or set the list of supported HMAC Identifiers (SCTP_HMAC_IDENT)
748 * This option gets or sets the list of HMAC algorithms that the local
749 * endpoint requires the peer to use.
752 /* This here is only used by user space as is. It might not be a good idea
753 * to export/reveal the whole structure with reserved fields etc.
756 SCTP_AUTH_HMAC_ID_SHA1
= 1,
757 SCTP_AUTH_HMAC_ID_SHA256
= 3,
761 struct sctp_hmacalgo
{
762 __u32 shmac_num_idents
;
763 __u16 shmac_idents
[];
766 /* Sadly, user and kernel space have different names for
767 * this structure member, so this is to not break anything.
769 #define shmac_number_of_idents shmac_num_idents
772 * 7.1.20. Set a shared key (SCTP_AUTH_KEY)
774 * This option will set a shared secret key which is used to build an
775 * association shared key.
777 struct sctp_authkey
{
778 sctp_assoc_t sca_assoc_id
;
785 * 7.1.21. Get or set the active shared key (SCTP_AUTH_ACTIVE_KEY)
787 * This option will get or set the active shared key to be used to build
788 * the association shared key.
791 struct sctp_authkeyid
{
792 sctp_assoc_t scact_assoc_id
;
793 __u16 scact_keynumber
;
798 * 7.1.23. Get or set delayed ack timer (SCTP_DELAYED_SACK)
800 * This option will effect the way delayed acks are performed. This
801 * option allows you to get or set the delayed ack time, in
802 * milliseconds. It also allows changing the delayed ack frequency.
803 * Changing the frequency to 1 disables the delayed sack algorithm. If
804 * the assoc_id is 0, then this sets or gets the endpoints default
805 * values. If the assoc_id field is non-zero, then the set or get
806 * effects the specified association for the one to many model (the
807 * assoc_id field is ignored by the one to one model). Note that if
808 * sack_delay or sack_freq are 0 when setting this option, then the
809 * current values will remain unchanged.
811 struct sctp_sack_info
{
812 sctp_assoc_t sack_assoc_id
;
817 struct sctp_assoc_value
{
818 sctp_assoc_t assoc_id
;
819 uint32_t assoc_value
;
822 struct sctp_stream_value
{
823 sctp_assoc_t assoc_id
;
825 uint16_t stream_value
;
829 * 7.2.2 Peer Address Information
831 * Applications can retrieve information about a specific peer address
832 * of an association, including its reachability state, congestion
833 * window, and retransmission timer values. This information is
834 * read-only. The following structure is used to access this
837 struct sctp_paddrinfo
{
838 sctp_assoc_t spinfo_assoc_id
;
839 struct sockaddr_storage spinfo_address
;
845 } __attribute__((packed
, aligned(4)));
847 /* Peer addresses's state. */
848 /* UNKNOWN: Peer address passed by the upper layer in sendmsg or connect[x]
850 * UNCONFIRMED: Peer address received in INIT/INIT-ACK address parameters.
851 * Not yet confirmed by a heartbeat and not available for data
853 * ACTIVE : Peer address confirmed, active and available for data transfers.
854 * INACTIVE: Peer address inactive and not available for data transfers.
856 enum sctp_spinfo_state
{
861 SCTP_UNKNOWN
= 0xffff /* Value used for transport state unknown */
865 * 7.2.1 Association Status (SCTP_STATUS)
867 * Applications can retrieve current status information about an
868 * association, including association state, peer receiver window size,
869 * number of unacked data chunks, and number of data chunks pending
870 * receipt. This information is read-only. The following structure is
871 * used to access this information:
874 sctp_assoc_t sstat_assoc_id
;
877 __u16 sstat_unackdata
;
878 __u16 sstat_penddata
;
880 __u16 sstat_outstrms
;
881 __u32 sstat_fragmentation_point
;
882 struct sctp_paddrinfo sstat_primary
;
886 * 7.2.3. Get the list of chunks the peer requires to be authenticated
887 * (SCTP_PEER_AUTH_CHUNKS)
889 * This option gets a list of chunks for a specified association that
890 * the peer requires to be received authenticated only.
892 struct sctp_authchunks
{
893 sctp_assoc_t gauth_assoc_id
;
894 __u32 gauth_number_of_chunks
;
895 uint8_t gauth_chunks
[];
898 /* The broken spelling has been released already in lksctp-tools header,
899 * so don't break anyone, now that it's fixed.
901 #define guth_number_of_chunks gauth_number_of_chunks
903 /* Association states. */
904 enum sctp_sstat_state
{
907 SCTP_COOKIE_WAIT
= 2,
908 SCTP_COOKIE_ECHOED
= 3,
909 SCTP_ESTABLISHED
= 4,
910 SCTP_SHUTDOWN_PENDING
= 5,
911 SCTP_SHUTDOWN_SENT
= 6,
912 SCTP_SHUTDOWN_RECEIVED
= 7,
913 SCTP_SHUTDOWN_ACK_SENT
= 8,
917 * 8.2.6. Get the Current Identifiers of Associations
918 * (SCTP_GET_ASSOC_ID_LIST)
920 * This option gets the current list of SCTP association identifiers of
921 * the SCTP associations handled by a one-to-many style socket.
923 struct sctp_assoc_ids
{
924 __u32 gaids_number_of_ids
;
925 sctp_assoc_t gaids_assoc_id
[];
929 * 8.3, 8.5 get all peer/local addresses in an association.
930 * This parameter struct is used by SCTP_GET_PEER_ADDRS and
931 * SCTP_GET_LOCAL_ADDRS socket options used internally to implement
932 * sctp_getpaddrs() and sctp_getladdrs() API.
934 struct sctp_getaddrs_old
{
935 sctp_assoc_t assoc_id
;
938 struct sockaddr __user
*addrs
;
940 struct sockaddr
*addrs
;
944 struct sctp_getaddrs
{
945 sctp_assoc_t assoc_id
; /*input*/
946 __u32 addr_num
; /*output*/
947 __u8 addrs
[0]; /*output, variable size*/
950 /* A socket user request obtained via SCTP_GET_ASSOC_STATS that retrieves
951 * association stats. All stats are counts except sas_maxrto and
952 * sas_obs_rto_ipaddr. maxrto is the max observed rto + transport since
953 * the last call. Will return 0 when RTO was not update since last call
955 struct sctp_assoc_stats
{
956 sctp_assoc_t sas_assoc_id
; /* Input */
957 /* Transport of observed max RTO */
958 struct sockaddr_storage sas_obs_rto_ipaddr
;
959 __u64 sas_maxrto
; /* Maximum Observed RTO for period */
960 __u64 sas_isacks
; /* SACKs received */
961 __u64 sas_osacks
; /* SACKs sent */
962 __u64 sas_opackets
; /* Packets sent */
963 __u64 sas_ipackets
; /* Packets received */
964 __u64 sas_rtxchunks
; /* Retransmitted Chunks */
965 __u64 sas_outofseqtsns
;/* TSN received > next expected */
966 __u64 sas_idupchunks
; /* Dups received (ordered+unordered) */
967 __u64 sas_gapcnt
; /* Gap Acknowledgements Received */
968 __u64 sas_ouodchunks
; /* Unordered data chunks sent */
969 __u64 sas_iuodchunks
; /* Unordered data chunks received */
970 __u64 sas_oodchunks
; /* Ordered data chunks sent */
971 __u64 sas_iodchunks
; /* Ordered data chunks received */
972 __u64 sas_octrlchunks
; /* Control chunks sent */
973 __u64 sas_ictrlchunks
; /* Control chunks received */
979 * The flags parameter is formed from the bitwise OR of zero or more of the
980 * following currently defined flags:
982 #define SCTP_BINDX_ADD_ADDR 0x01
983 #define SCTP_BINDX_REM_ADDR 0x02
985 /* This is the structure that is passed as an argument(optval) to
986 * getsockopt(SCTP_SOCKOPT_PEELOFF).
989 sctp_assoc_t associd
;
991 } sctp_peeloff_arg_t
;
994 sctp_peeloff_arg_t p_arg
;
996 } sctp_peeloff_flags_arg_t
;
999 * Peer Address Thresholds socket option
1001 struct sctp_paddrthlds
{
1002 sctp_assoc_t spt_assoc_id
;
1003 struct sockaddr_storage spt_address
;
1004 __u16 spt_pathmaxrxt
;
1005 __u16 spt_pathpfthld
;
1009 * Socket Option for Getting the Association/Stream-Specific PR-SCTP Status
1011 struct sctp_prstatus
{
1012 sctp_assoc_t sprstat_assoc_id
;
1014 __u16 sprstat_policy
;
1015 __u64 sprstat_abandoned_unsent
;
1016 __u64 sprstat_abandoned_sent
;
1019 struct sctp_default_prinfo
{
1020 sctp_assoc_t pr_assoc_id
;
1029 __u16 sctpi_unackdata
;
1030 __u16 sctpi_penddata
;
1031 __u16 sctpi_instrms
;
1032 __u16 sctpi_outstrms
;
1033 __u32 sctpi_fragmentation_point
;
1034 __u32 sctpi_inqueue
;
1035 __u32 sctpi_outqueue
;
1036 __u32 sctpi_overall_error
;
1037 __u32 sctpi_max_burst
;
1039 __u32 sctpi_peer_rwnd
;
1040 __u32 sctpi_peer_tag
;
1041 __u8 sctpi_peer_capable
;
1042 __u8 sctpi_peer_sack
;
1045 /* assoc status info */
1048 __u64 sctpi_opackets
;
1049 __u64 sctpi_ipackets
;
1050 __u64 sctpi_rtxchunks
;
1051 __u64 sctpi_outofseqtsns
;
1052 __u64 sctpi_idupchunks
;
1054 __u64 sctpi_ouodchunks
;
1055 __u64 sctpi_iuodchunks
;
1056 __u64 sctpi_oodchunks
;
1057 __u64 sctpi_iodchunks
;
1058 __u64 sctpi_octrlchunks
;
1059 __u64 sctpi_ictrlchunks
;
1061 /* primary transport info */
1062 struct sockaddr_storage sctpi_p_address
;
1063 __s32 sctpi_p_state
;
1067 __u32 sctpi_p_hbinterval
;
1068 __u32 sctpi_p_pathmaxrxt
;
1069 __u32 sctpi_p_sackdelay
;
1070 __u32 sctpi_p_sackfreq
;
1071 __u32 sctpi_p_ssthresh
;
1072 __u32 sctpi_p_partial_bytes_acked
;
1073 __u32 sctpi_p_flight_size
;
1074 __u16 sctpi_p_error
;
1077 /* sctp sock info */
1078 __u32 sctpi_s_autoclose
;
1079 __u32 sctpi_s_adaptation_ind
;
1080 __u32 sctpi_s_pd_point
;
1081 __u8 sctpi_s_nodelay
;
1082 __u8 sctpi_s_disable_fragments
;
1083 __u8 sctpi_s_v4mapped
;
1084 __u8 sctpi_s_frag_interleave
;
1089 struct sctp_reset_streams
{
1090 sctp_assoc_t srs_assoc_id
;
1092 uint16_t srs_number_streams
; /* 0 == ALL */
1093 uint16_t srs_stream_list
[]; /* list if srs_num_streams is not 0 */
1096 struct sctp_add_streams
{
1097 sctp_assoc_t sas_assoc_id
;
1098 uint16_t sas_instrms
;
1099 uint16_t sas_outstrms
;
1102 /* SCTP Stream schedulers */
1103 enum sctp_sched_type
{
1105 SCTP_SS_DEFAULT
= SCTP_SS_FCFS
,
1108 SCTP_SS_MAX
= SCTP_SS_RR
1111 #endif /* _UAPI_SCTP_H */