1 /* SCTP kernel implementation
2 * (C) Copyright IBM Corp. 2001, 2004
3 * Copyright (c) 1999-2000 Cisco, Inc.
4 * Copyright (c) 1999-2001 Motorola, Inc.
5 * Copyright (c) 2002 Intel Corp.
7 * This file is part of the SCTP kernel implementation
9 * This header represents the structures and constants needed to support
10 * the SCTP Extension to the Sockets API.
12 * This SCTP implementation is free software;
13 * you can redistribute it and/or modify it under the terms of
14 * the GNU General Public License as published by
15 * the Free Software Foundation; either version 2, or (at your option)
18 * This SCTP implementation is distributed in the hope that it
19 * will be useful, but WITHOUT ANY WARRANTY; without even the implied
20 * ************************
21 * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
22 * See the GNU General Public License for more details.
24 * You should have received a copy of the GNU General Public License
25 * along with GNU CC; see the file COPYING. If not, see
26 * <http://www.gnu.org/licenses/>.
28 * Please send any bug reports or fixes you make to the
30 * lksctp developers <linux-sctp@vger.kernel.org>
32 * Or submit a bug report through the following website:
33 * http://www.sf.net/projects/lksctp
35 * Written or modified by:
36 * La Monte H.P. Yarroll <piggy@acm.org>
37 * R. Stewart <randall@sctp.chicago.il.us>
38 * K. Morneau <kmorneau@cisco.com>
39 * Q. Xie <qxie1@email.mot.com>
40 * Karl Knutson <karl@athena.chicago.il.us>
41 * Jon Grimm <jgrimm@us.ibm.com>
42 * Daisy Chang <daisyc@us.ibm.com>
43 * Ryan Layer <rmlayer@us.ibm.com>
44 * Ardelle Fan <ardelle.fan@intel.com>
45 * Sridhar Samudrala <sri@us.ibm.com>
46 * Inaky Perez-Gonzalez <inaky.gonzalez@intel.com>
47 * Vlad Yasevich <vladislav.yasevich@hp.com>
49 * Any bugs reported given to us we will try to fix... any fixes shared will
50 * be incorporated into the next SCTP release.
56 #include <linux/types.h>
57 #include <linux/socket.h>
59 typedef __s32 sctp_assoc_t
;
61 /* The following symbols come from the Sockets API Extensions for
62 * SCTP <draft-ietf-tsvwg-sctpsocket-07.txt>.
64 #define SCTP_RTOINFO 0
65 #define SCTP_ASSOCINFO 1
66 #define SCTP_INITMSG 2
67 #define SCTP_NODELAY 3 /* Get/set nodelay option. */
68 #define SCTP_AUTOCLOSE 4
69 #define SCTP_SET_PEER_PRIMARY_ADDR 5
70 #define SCTP_PRIMARY_ADDR 6
71 #define SCTP_ADAPTATION_LAYER 7
72 #define SCTP_DISABLE_FRAGMENTS 8
73 #define SCTP_PEER_ADDR_PARAMS 9
74 #define SCTP_DEFAULT_SEND_PARAM 10
75 #define SCTP_EVENTS 11
76 #define SCTP_I_WANT_MAPPED_V4_ADDR 12 /* Turn on/off mapped v4 addresses */
77 #define SCTP_MAXSEG 13 /* Get/set maximum fragment. */
78 #define SCTP_STATUS 14
79 #define SCTP_GET_PEER_ADDR_INFO 15
80 #define SCTP_DELAYED_ACK_TIME 16
81 #define SCTP_DELAYED_ACK SCTP_DELAYED_ACK_TIME
82 #define SCTP_DELAYED_SACK SCTP_DELAYED_ACK_TIME
83 #define SCTP_CONTEXT 17
84 #define SCTP_FRAGMENT_INTERLEAVE 18
85 #define SCTP_PARTIAL_DELIVERY_POINT 19 /* Set/Get partial delivery point */
86 #define SCTP_MAX_BURST 20 /* Set/Get max burst */
87 #define SCTP_AUTH_CHUNK 21 /* Set only: add a chunk type to authenticate */
88 #define SCTP_HMAC_IDENT 22
89 #define SCTP_AUTH_KEY 23
90 #define SCTP_AUTH_ACTIVE_KEY 24
91 #define SCTP_AUTH_DELETE_KEY 25
92 #define SCTP_PEER_AUTH_CHUNKS 26 /* Read only */
93 #define SCTP_LOCAL_AUTH_CHUNKS 27 /* Read only */
94 #define SCTP_GET_ASSOC_NUMBER 28 /* Read only */
95 #define SCTP_GET_ASSOC_ID_LIST 29 /* Read only */
96 #define SCTP_AUTO_ASCONF 30
97 #define SCTP_PEER_ADDR_THLDS 31
98 #define SCTP_RECVRCVINFO 32
99 #define SCTP_RECVNXTINFO 33
100 #define SCTP_DEFAULT_SNDINFO 34
102 /* Internal Socket Options. Some of the sctp library functions are
103 * implemented using these socket options.
105 #define SCTP_SOCKOPT_BINDX_ADD 100 /* BINDX requests for adding addrs */
106 #define SCTP_SOCKOPT_BINDX_REM 101 /* BINDX requests for removing addrs. */
107 #define SCTP_SOCKOPT_PEELOFF 102 /* peel off association. */
108 /* Options 104-106 are deprecated and removed. Do not use this space */
109 #define SCTP_SOCKOPT_CONNECTX_OLD 107 /* CONNECTX old requests. */
110 #define SCTP_GET_PEER_ADDRS 108 /* Get all peer address. */
111 #define SCTP_GET_LOCAL_ADDRS 109 /* Get all local address. */
112 #define SCTP_SOCKOPT_CONNECTX 110 /* CONNECTX requests. */
113 #define SCTP_SOCKOPT_CONNECTX3 111 /* CONNECTX requests (updated) */
114 #define SCTP_GET_ASSOC_STATS 112 /* Read only */
115 #define SCTP_PR_SUPPORTED 113
117 /* These are bit fields for msghdr->msg_flags. See section 5.1. */
118 /* On user space Linux, these live in <bits/socket.h> as an enum. */
119 enum sctp_msg_flags
{
120 MSG_NOTIFICATION
= 0x8000,
121 #define MSG_NOTIFICATION MSG_NOTIFICATION
124 /* 5.3.1 SCTP Initiation Structure (SCTP_INIT)
126 * This cmsghdr structure provides information for initializing new
127 * SCTP associations with sendmsg(). The SCTP_INITMSG socket option
128 * uses this same data structure. This structure is not used for
131 * cmsg_level cmsg_type cmsg_data[]
132 * ------------ ------------ ----------------------
133 * IPPROTO_SCTP SCTP_INIT struct sctp_initmsg
135 struct sctp_initmsg
{
136 __u16 sinit_num_ostreams
;
137 __u16 sinit_max_instreams
;
138 __u16 sinit_max_attempts
;
139 __u16 sinit_max_init_timeo
;
142 /* 5.3.2 SCTP Header Information Structure (SCTP_SNDRCV)
144 * This cmsghdr structure specifies SCTP options for sendmsg() and
145 * describes SCTP header information about a received message through
148 * cmsg_level cmsg_type cmsg_data[]
149 * ------------ ------------ ----------------------
150 * IPPROTO_SCTP SCTP_SNDRCV struct sctp_sndrcvinfo
152 struct sctp_sndrcvinfo
{
158 __u32 sinfo_timetolive
;
161 sctp_assoc_t sinfo_assoc_id
;
164 /* 5.3.4 SCTP Send Information Structure (SCTP_SNDINFO)
166 * This cmsghdr structure specifies SCTP options for sendmsg().
168 * cmsg_level cmsg_type cmsg_data[]
169 * ------------ ------------ -------------------
170 * IPPROTO_SCTP SCTP_SNDINFO struct sctp_sndinfo
172 struct sctp_sndinfo
{
177 sctp_assoc_t snd_assoc_id
;
180 /* 5.3.5 SCTP Receive Information Structure (SCTP_RCVINFO)
182 * This cmsghdr structure describes SCTP receive information
183 * about a received message through recvmsg().
185 * cmsg_level cmsg_type cmsg_data[]
186 * ------------ ------------ -------------------
187 * IPPROTO_SCTP SCTP_RCVINFO struct sctp_rcvinfo
189 struct sctp_rcvinfo
{
197 sctp_assoc_t rcv_assoc_id
;
200 /* 5.3.6 SCTP Next Receive Information Structure (SCTP_NXTINFO)
202 * This cmsghdr structure describes SCTP receive information
203 * of the next message that will be delivered through recvmsg()
204 * if this information is already available when delivering
205 * the current message.
207 * cmsg_level cmsg_type cmsg_data[]
208 * ------------ ------------ -------------------
209 * IPPROTO_SCTP SCTP_NXTINFO struct sctp_nxtinfo
211 struct sctp_nxtinfo
{
216 sctp_assoc_t nxt_assoc_id
;
220 * sinfo_flags: 16 bits (unsigned integer)
222 * This field may contain any of the following flags and is composed of
223 * a bitwise OR of these values.
225 enum sctp_sinfo_flags
{
226 SCTP_UNORDERED
= (1 << 0), /* Send/receive message unordered. */
227 SCTP_ADDR_OVER
= (1 << 1), /* Override the primary destination. */
228 SCTP_ABORT
= (1 << 2), /* Send an ABORT message to the peer. */
229 SCTP_SACK_IMMEDIATELY
= (1 << 3), /* SACK should be sent without delay. */
230 SCTP_NOTIFICATION
= MSG_NOTIFICATION
, /* Next message is not user msg but notification. */
231 SCTP_EOF
= MSG_FIN
, /* Initiate graceful shutdown process. */
236 struct sctp_initmsg init
;
237 struct sctp_sndrcvinfo sndrcv
;
240 /* These are cmsg_types. */
241 typedef enum sctp_cmsg_type
{
242 SCTP_INIT
, /* 5.2.1 SCTP Initiation Structure */
243 #define SCTP_INIT SCTP_INIT
244 SCTP_SNDRCV
, /* 5.2.2 SCTP Header Information Structure */
245 #define SCTP_SNDRCV SCTP_SNDRCV
246 SCTP_SNDINFO
, /* 5.3.4 SCTP Send Information Structure */
247 #define SCTP_SNDINFO SCTP_SNDINFO
248 SCTP_RCVINFO
, /* 5.3.5 SCTP Receive Information Structure */
249 #define SCTP_RCVINFO SCTP_RCVINFO
250 SCTP_NXTINFO
, /* 5.3.6 SCTP Next Receive Information Structure */
251 #define SCTP_NXTINFO SCTP_NXTINFO
255 * 5.3.1.1 SCTP_ASSOC_CHANGE
257 * Communication notifications inform the ULP that an SCTP association
258 * has either begun or ended. The identifier for a new association is
259 * provided by this notificaion. The notification information has the
263 struct sctp_assoc_change
{
269 __u16 sac_outbound_streams
;
270 __u16 sac_inbound_streams
;
271 sctp_assoc_t sac_assoc_id
;
276 * sac_state: 32 bits (signed integer)
278 * This field holds one of a number of values that communicate the
279 * event that happened to the association. They include:
281 * Note: The following state names deviate from the API draft as
282 * the names clash too easily with other kernel symbols.
284 enum sctp_sac_state
{
293 * 5.3.1.2 SCTP_PEER_ADDR_CHANGE
295 * When a destination address on a multi-homed peer encounters a change
296 * an interface details event is sent. The information has the
297 * following structure:
299 struct sctp_paddr_change
{
303 struct sockaddr_storage spc_aaddr
;
306 sctp_assoc_t spc_assoc_id
;
307 } __attribute__((packed
, aligned(4)));
310 * spc_state: 32 bits (signed integer)
312 * This field holds one of a number of values that communicate the
313 * event that happened to the address. They include:
315 enum sctp_spc_state
{
317 SCTP_ADDR_UNREACHABLE
,
326 * 5.3.1.3 SCTP_REMOTE_ERROR
328 * A remote peer may send an Operational Error message to its peer.
329 * This message indicates a variety of error conditions on an
330 * association. The entire error TLV as it appears on the wire is
331 * included in a SCTP_REMOTE_ERROR event. Please refer to the SCTP
332 * specification [SCTP] and any extensions for a list of possible
333 * error formats. SCTP error TLVs have the format:
335 struct sctp_remote_error
{
340 sctp_assoc_t sre_assoc_id
;
346 * 5.3.1.4 SCTP_SEND_FAILED
348 * If SCTP cannot deliver a message it may return the message as a
351 struct sctp_send_failed
{
356 struct sctp_sndrcvinfo ssf_info
;
357 sctp_assoc_t ssf_assoc_id
;
362 * ssf_flags: 16 bits (unsigned integer)
364 * The flag value will take one of the following values
366 * SCTP_DATA_UNSENT - Indicates that the data was never put on
369 * SCTP_DATA_SENT - Indicates that the data was put on the wire.
370 * Note that this does not necessarily mean that the
371 * data was (or was not) successfully delivered.
373 enum sctp_ssf_flags
{
379 * 5.3.1.5 SCTP_SHUTDOWN_EVENT
381 * When a peer sends a SHUTDOWN, SCTP delivers this notification to
382 * inform the application that it should cease sending data.
384 struct sctp_shutdown_event
{
388 sctp_assoc_t sse_assoc_id
;
392 * 5.3.1.6 SCTP_ADAPTATION_INDICATION
394 * When a peer sends a Adaptation Layer Indication parameter , SCTP
395 * delivers this notification to inform the application
396 * that of the peers requested adaptation layer.
398 struct sctp_adaptation_event
{
402 __u32 sai_adaptation_ind
;
403 sctp_assoc_t sai_assoc_id
;
407 * 5.3.1.7 SCTP_PARTIAL_DELIVERY_EVENT
409 * When a receiver is engaged in a partial delivery of a
410 * message this notification will be used to indicate
413 struct sctp_pdapi_event
{
417 __u32 pdapi_indication
;
418 sctp_assoc_t pdapi_assoc_id
;
421 enum { SCTP_PARTIAL_DELIVERY_ABORTED
=0, };
424 * 5.3.1.8. SCTP_AUTHENTICATION_EVENT
426 * When a receiver is using authentication this message will provide
427 * notifications regarding new keys being made active as well as errors.
429 struct sctp_authkey_event
{
433 __u16 auth_keynumber
;
434 __u16 auth_altkeynumber
;
435 __u32 auth_indication
;
436 sctp_assoc_t auth_assoc_id
;
439 enum { SCTP_AUTH_NEWKEY
= 0, };
442 * 6.1.9. SCTP_SENDER_DRY_EVENT
444 * When the SCTP stack has no more user data to send or retransmit, this
445 * notification is given to the user. Also, at the time when a user app
446 * subscribes to this event, if there is no data to be sent or
447 * retransmit, the stack will immediately send up this notification.
449 struct sctp_sender_dry_event
{
450 __u16 sender_dry_type
;
451 __u16 sender_dry_flags
;
452 __u32 sender_dry_length
;
453 sctp_assoc_t sender_dry_assoc_id
;
457 * Described in Section 7.3
458 * Ancillary Data and Notification Interest Options
460 struct sctp_event_subscribe
{
461 __u8 sctp_data_io_event
;
462 __u8 sctp_association_event
;
463 __u8 sctp_address_event
;
464 __u8 sctp_send_failure_event
;
465 __u8 sctp_peer_error_event
;
466 __u8 sctp_shutdown_event
;
467 __u8 sctp_partial_delivery_event
;
468 __u8 sctp_adaptation_layer_event
;
469 __u8 sctp_authentication_event
;
470 __u8 sctp_sender_dry_event
;
474 * 5.3.1 SCTP Notification Structure
476 * The notification structure is defined as the union of all
477 * notification types.
480 union sctp_notification
{
482 __u16 sn_type
; /* Notification type. */
486 struct sctp_assoc_change sn_assoc_change
;
487 struct sctp_paddr_change sn_paddr_change
;
488 struct sctp_remote_error sn_remote_error
;
489 struct sctp_send_failed sn_send_failed
;
490 struct sctp_shutdown_event sn_shutdown_event
;
491 struct sctp_adaptation_event sn_adaptation_event
;
492 struct sctp_pdapi_event sn_pdapi_event
;
493 struct sctp_authkey_event sn_authkey_event
;
494 struct sctp_sender_dry_event sn_sender_dry_event
;
498 * All standard values for sn_type flags are greater than 2^15.
499 * Values from 2^15 and down are reserved.
503 SCTP_SN_TYPE_BASE
= (1<<15),
505 #define SCTP_ASSOC_CHANGE SCTP_ASSOC_CHANGE
506 SCTP_PEER_ADDR_CHANGE
,
507 #define SCTP_PEER_ADDR_CHANGE SCTP_PEER_ADDR_CHANGE
509 #define SCTP_SEND_FAILED SCTP_SEND_FAILED
511 #define SCTP_REMOTE_ERROR SCTP_REMOTE_ERROR
513 #define SCTP_SHUTDOWN_EVENT SCTP_SHUTDOWN_EVENT
514 SCTP_PARTIAL_DELIVERY_EVENT
,
515 #define SCTP_PARTIAL_DELIVERY_EVENT SCTP_PARTIAL_DELIVERY_EVENT
516 SCTP_ADAPTATION_INDICATION
,
517 #define SCTP_ADAPTATION_INDICATION SCTP_ADAPTATION_INDICATION
518 SCTP_AUTHENTICATION_EVENT
,
519 #define SCTP_AUTHENTICATION_INDICATION SCTP_AUTHENTICATION_EVENT
520 SCTP_SENDER_DRY_EVENT
,
521 #define SCTP_SENDER_DRY_EVENT SCTP_SENDER_DRY_EVENT
524 /* Notification error codes used to fill up the error fields in some
526 * SCTP_PEER_ADDRESS_CHAGE : spc_error
527 * SCTP_ASSOC_CHANGE : sac_error
528 * These names should be potentially included in the draft 04 of the SCTP
529 * sockets API specification.
531 typedef enum sctp_sn_error
{
532 SCTP_FAILED_THRESHOLD
,
534 SCTP_HEARTBEAT_SUCCESS
,
535 SCTP_RESPONSE_TO_USER_REQ
,
537 SCTP_SHUTDOWN_GUARD_EXPIRES
,
542 * 7.1.1 Retransmission Timeout Parameters (SCTP_RTOINFO)
544 * The protocol parameters used to initialize and bound retransmission
545 * timeout (RTO) are tunable. See [SCTP] for more information on how
546 * these parameters are used in RTO calculation.
548 struct sctp_rtoinfo
{
549 sctp_assoc_t srto_assoc_id
;
556 * 7.1.2 Association Parameters (SCTP_ASSOCINFO)
558 * This option is used to both examine and set various association and
559 * endpoint parameters.
561 struct sctp_assocparams
{
562 sctp_assoc_t sasoc_assoc_id
;
563 __u16 sasoc_asocmaxrxt
;
564 __u16 sasoc_number_peer_destinations
;
565 __u32 sasoc_peer_rwnd
;
566 __u32 sasoc_local_rwnd
;
567 __u32 sasoc_cookie_life
;
571 * 7.1.9 Set Peer Primary Address (SCTP_SET_PEER_PRIMARY_ADDR)
573 * Requests that the peer mark the enclosed address as the association
574 * primary. The enclosed address must be one of the association's
575 * locally bound addresses. The following structure is used to make a
576 * set primary request:
578 struct sctp_setpeerprim
{
579 sctp_assoc_t sspp_assoc_id
;
580 struct sockaddr_storage sspp_addr
;
581 } __attribute__((packed
, aligned(4)));
584 * 7.1.10 Set Primary Address (SCTP_PRIMARY_ADDR)
586 * Requests that the local SCTP stack use the enclosed peer address as
587 * the association primary. The enclosed address must be one of the
588 * association peer's addresses. The following structure is used to
589 * make a set peer primary request:
592 sctp_assoc_t ssp_assoc_id
;
593 struct sockaddr_storage ssp_addr
;
594 } __attribute__((packed
, aligned(4)));
596 /* For backward compatibility use, define the old name too */
597 #define sctp_setprim sctp_prim
600 * 7.1.11 Set Adaptation Layer Indicator (SCTP_ADAPTATION_LAYER)
602 * Requests that the local endpoint set the specified Adaptation Layer
603 * Indication parameter for all future INIT and INIT-ACK exchanges.
605 struct sctp_setadaptation
{
606 __u32 ssb_adaptation_ind
;
610 * 7.1.13 Peer Address Parameters (SCTP_PEER_ADDR_PARAMS)
612 * Applications can enable or disable heartbeats for any peer address
613 * of an association, modify an address's heartbeat interval, force a
614 * heartbeat to be sent immediately, and adjust the address's maximum
615 * number of retransmissions sent before an address is considered
616 * unreachable. The following structure is used to access and modify an
617 * address's parameters:
619 enum sctp_spp_flags
{
620 SPP_HB_ENABLE
= 1<<0, /*Enable heartbeats*/
621 SPP_HB_DISABLE
= 1<<1, /*Disable heartbeats*/
622 SPP_HB
= SPP_HB_ENABLE
| SPP_HB_DISABLE
,
623 SPP_HB_DEMAND
= 1<<2, /*Send heartbeat immediately*/
624 SPP_PMTUD_ENABLE
= 1<<3, /*Enable PMTU discovery*/
625 SPP_PMTUD_DISABLE
= 1<<4, /*Disable PMTU discovery*/
626 SPP_PMTUD
= SPP_PMTUD_ENABLE
| SPP_PMTUD_DISABLE
,
627 SPP_SACKDELAY_ENABLE
= 1<<5, /*Enable SACK*/
628 SPP_SACKDELAY_DISABLE
= 1<<6, /*Disable SACK*/
629 SPP_SACKDELAY
= SPP_SACKDELAY_ENABLE
| SPP_SACKDELAY_DISABLE
,
630 SPP_HB_TIME_IS_ZERO
= 1<<7, /* Set HB delay to 0 */
633 struct sctp_paddrparams
{
634 sctp_assoc_t spp_assoc_id
;
635 struct sockaddr_storage spp_address
;
636 __u32 spp_hbinterval
;
637 __u16 spp_pathmaxrxt
;
641 } __attribute__((packed
, aligned(4)));
644 * 7.1.18. Add a chunk that must be authenticated (SCTP_AUTH_CHUNK)
646 * This set option adds a chunk type that the user is requesting to be
647 * received only in an authenticated way. Changes to the list of chunks
648 * will only effect future associations on the socket.
650 struct sctp_authchunk
{
655 * 7.1.19. Get or set the list of supported HMAC Identifiers (SCTP_HMAC_IDENT)
657 * This option gets or sets the list of HMAC algorithms that the local
658 * endpoint requires the peer to use.
661 /* This here is only used by user space as is. It might not be a good idea
662 * to export/reveal the whole structure with reserved fields etc.
665 SCTP_AUTH_HMAC_ID_SHA1
= 1,
666 SCTP_AUTH_HMAC_ID_SHA256
= 3,
670 struct sctp_hmacalgo
{
671 __u32 shmac_num_idents
;
672 __u16 shmac_idents
[];
675 /* Sadly, user and kernel space have different names for
676 * this structure member, so this is to not break anything.
678 #define shmac_number_of_idents shmac_num_idents
681 * 7.1.20. Set a shared key (SCTP_AUTH_KEY)
683 * This option will set a shared secret key which is used to build an
684 * association shared key.
686 struct sctp_authkey
{
687 sctp_assoc_t sca_assoc_id
;
694 * 7.1.21. Get or set the active shared key (SCTP_AUTH_ACTIVE_KEY)
696 * This option will get or set the active shared key to be used to build
697 * the association shared key.
700 struct sctp_authkeyid
{
701 sctp_assoc_t scact_assoc_id
;
702 __u16 scact_keynumber
;
707 * 7.1.23. Get or set delayed ack timer (SCTP_DELAYED_SACK)
709 * This option will effect the way delayed acks are performed. This
710 * option allows you to get or set the delayed ack time, in
711 * milliseconds. It also allows changing the delayed ack frequency.
712 * Changing the frequency to 1 disables the delayed sack algorithm. If
713 * the assoc_id is 0, then this sets or gets the endpoints default
714 * values. If the assoc_id field is non-zero, then the set or get
715 * effects the specified association for the one to many model (the
716 * assoc_id field is ignored by the one to one model). Note that if
717 * sack_delay or sack_freq are 0 when setting this option, then the
718 * current values will remain unchanged.
720 struct sctp_sack_info
{
721 sctp_assoc_t sack_assoc_id
;
726 struct sctp_assoc_value
{
727 sctp_assoc_t assoc_id
;
728 uint32_t assoc_value
;
732 * 7.2.2 Peer Address Information
734 * Applications can retrieve information about a specific peer address
735 * of an association, including its reachability state, congestion
736 * window, and retransmission timer values. This information is
737 * read-only. The following structure is used to access this
740 struct sctp_paddrinfo
{
741 sctp_assoc_t spinfo_assoc_id
;
742 struct sockaddr_storage spinfo_address
;
748 } __attribute__((packed
, aligned(4)));
750 /* Peer addresses's state. */
751 /* UNKNOWN: Peer address passed by the upper layer in sendmsg or connect[x]
753 * UNCONFIRMED: Peer address received in INIT/INIT-ACK address parameters.
754 * Not yet confirmed by a heartbeat and not available for data
756 * ACTIVE : Peer address confirmed, active and available for data transfers.
757 * INACTIVE: Peer address inactive and not available for data transfers.
759 enum sctp_spinfo_state
{
764 SCTP_UNKNOWN
= 0xffff /* Value used for transport state unknown */
768 * 7.2.1 Association Status (SCTP_STATUS)
770 * Applications can retrieve current status information about an
771 * association, including association state, peer receiver window size,
772 * number of unacked data chunks, and number of data chunks pending
773 * receipt. This information is read-only. The following structure is
774 * used to access this information:
777 sctp_assoc_t sstat_assoc_id
;
780 __u16 sstat_unackdata
;
781 __u16 sstat_penddata
;
783 __u16 sstat_outstrms
;
784 __u32 sstat_fragmentation_point
;
785 struct sctp_paddrinfo sstat_primary
;
789 * 7.2.3. Get the list of chunks the peer requires to be authenticated
790 * (SCTP_PEER_AUTH_CHUNKS)
792 * This option gets a list of chunks for a specified association that
793 * the peer requires to be received authenticated only.
795 struct sctp_authchunks
{
796 sctp_assoc_t gauth_assoc_id
;
797 __u32 gauth_number_of_chunks
;
798 uint8_t gauth_chunks
[];
801 /* The broken spelling has been released already in lksctp-tools header,
802 * so don't break anyone, now that it's fixed.
804 #define guth_number_of_chunks gauth_number_of_chunks
806 /* Association states. */
807 enum sctp_sstat_state
{
810 SCTP_COOKIE_WAIT
= 2,
811 SCTP_COOKIE_ECHOED
= 3,
812 SCTP_ESTABLISHED
= 4,
813 SCTP_SHUTDOWN_PENDING
= 5,
814 SCTP_SHUTDOWN_SENT
= 6,
815 SCTP_SHUTDOWN_RECEIVED
= 7,
816 SCTP_SHUTDOWN_ACK_SENT
= 8,
820 * 8.2.6. Get the Current Identifiers of Associations
821 * (SCTP_GET_ASSOC_ID_LIST)
823 * This option gets the current list of SCTP association identifiers of
824 * the SCTP associations handled by a one-to-many style socket.
826 struct sctp_assoc_ids
{
827 __u32 gaids_number_of_ids
;
828 sctp_assoc_t gaids_assoc_id
[];
832 * 8.3, 8.5 get all peer/local addresses in an association.
833 * This parameter struct is used by SCTP_GET_PEER_ADDRS and
834 * SCTP_GET_LOCAL_ADDRS socket options used internally to implement
835 * sctp_getpaddrs() and sctp_getladdrs() API.
837 struct sctp_getaddrs_old
{
838 sctp_assoc_t assoc_id
;
841 struct sockaddr __user
*addrs
;
843 struct sockaddr
*addrs
;
847 struct sctp_getaddrs
{
848 sctp_assoc_t assoc_id
; /*input*/
849 __u32 addr_num
; /*output*/
850 __u8 addrs
[0]; /*output, variable size*/
853 /* A socket user request obtained via SCTP_GET_ASSOC_STATS that retrieves
854 * association stats. All stats are counts except sas_maxrto and
855 * sas_obs_rto_ipaddr. maxrto is the max observed rto + transport since
856 * the last call. Will return 0 when RTO was not update since last call
858 struct sctp_assoc_stats
{
859 sctp_assoc_t sas_assoc_id
; /* Input */
860 /* Transport of observed max RTO */
861 struct sockaddr_storage sas_obs_rto_ipaddr
;
862 __u64 sas_maxrto
; /* Maximum Observed RTO for period */
863 __u64 sas_isacks
; /* SACKs received */
864 __u64 sas_osacks
; /* SACKs sent */
865 __u64 sas_opackets
; /* Packets sent */
866 __u64 sas_ipackets
; /* Packets received */
867 __u64 sas_rtxchunks
; /* Retransmitted Chunks */
868 __u64 sas_outofseqtsns
;/* TSN received > next expected */
869 __u64 sas_idupchunks
; /* Dups received (ordered+unordered) */
870 __u64 sas_gapcnt
; /* Gap Acknowledgements Received */
871 __u64 sas_ouodchunks
; /* Unordered data chunks sent */
872 __u64 sas_iuodchunks
; /* Unordered data chunks received */
873 __u64 sas_oodchunks
; /* Ordered data chunks sent */
874 __u64 sas_iodchunks
; /* Ordered data chunks received */
875 __u64 sas_octrlchunks
; /* Control chunks sent */
876 __u64 sas_ictrlchunks
; /* Control chunks received */
882 * The flags parameter is formed from the bitwise OR of zero or more of the
883 * following currently defined flags:
885 #define SCTP_BINDX_ADD_ADDR 0x01
886 #define SCTP_BINDX_REM_ADDR 0x02
888 /* This is the structure that is passed as an argument(optval) to
889 * getsockopt(SCTP_SOCKOPT_PEELOFF).
892 sctp_assoc_t associd
;
894 } sctp_peeloff_arg_t
;
897 * Peer Address Thresholds socket option
899 struct sctp_paddrthlds
{
900 sctp_assoc_t spt_assoc_id
;
901 struct sockaddr_storage spt_address
;
902 __u16 spt_pathmaxrxt
;
903 __u16 spt_pathpfthld
;
906 #endif /* _UAPI_SCTP_H */