include/uapi/linux/sctp.h

   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.
   7  *
   8  * This file is part of the SCTP kernel implementation
   9  *
  10  * This header represents the structures and constants needed to support
  11  * the SCTP Extension to the Sockets API.
  12  *
  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)
  17  * any later version.
  18  *
  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.
  24  *
  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/>.
  28  *
  29  * Please send any bug reports or fixes you make to the
  30  * email address(es):
  31  *    lksctp developers <[email protected]>
  32  *
  33  * Or submit a bug report through the following website:
  34  *    http://www.sf.net/projects/lksctp
  35  *
  36  * Written or modified by:
  37  *    La Monte H.P. Yarroll    <[email protected]>
  38  *    R. Stewart               <[email protected]>
  39  *    K. Morneau               <[email protected]>
  40  *    Q. Xie                   <[email protected]>
  41  *    Karl Knutson             <[email protected]>
  42  *    Jon Grimm                <[email protected]>
  43  *    Daisy Chang              <[email protected]>
  44  *    Ryan Layer               <[email protected]>
  45  *    Ardelle Fan              <[email protected]>
  46  *    Sridhar Samudrala        <[email protected]>
  47  *    Inaky Perez-Gonzalez     <[email protected]>
  48  *    Vlad Yasevich            <[email protected]>
  49  *
  50  * Any bugs reported given to us we will try to fix... any fixes shared will
  51  * be incorporated into the next SCTP release.
  52  */
  53
  54 #ifndef _UAPI_SCTP_H
  55 #define _UAPI_SCTP_H
  56
  57 #include <linux/types.h>
  58 #include <linux/socket.h>
  59
  60 typedef __s32 sctp_assoc_t;
  61
  62 /* The following symbols come from the Sockets API Extensions for
  63  * SCTP <draft-ietf-tsvwg-sctpsocket-07.txt>.
  64  */
  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
 103 /* Internal Socket Options. Some of the sctp library functions are
 104  * implemented using these socket options.
 105  */
 106 #define SCTP_SOCKOPT_BINDX_ADD  100     /* BINDX requests for adding addrs */
 107 #define SCTP_SOCKOPT_BINDX_REM  101     /* BINDX requests for removing addrs. */
 108 #define SCTP_SOCKOPT_PEELOFF    102     /* peel off association. */
 109 /* Options 104-106 are deprecated and removed. Do not use this space */
 110 #define SCTP_SOCKOPT_CONNECTX_OLD       107     /* CONNECTX old requests. */
 111 #define SCTP_GET_PEER_ADDRS     108             /* Get all peer address. */
 112 #define SCTP_GET_LOCAL_ADDRS    109             /* Get all local address. */
 113 #define SCTP_SOCKOPT_CONNECTX   110             /* CONNECTX requests. */
 114 #define SCTP_SOCKOPT_CONNECTX3  111     /* CONNECTX requests (updated) */
 115 #define SCTP_GET_ASSOC_STATS    112     /* Read only */
 116 #define SCTP_PR_SUPPORTED       113
 117 #define SCTP_DEFAULT_PRINFO     114
 118 #define SCTP_PR_ASSOC_STATUS    115
 119 #define SCTP_PR_STREAM_STATUS   116
 120 #define SCTP_RECONFIG_SUPPORTED 117
 121 #define SCTP_ENABLE_STREAM_RESET        118
 122 #define SCTP_RESET_STREAMS      119
 123 #define SCTP_RESET_ASSOC        120
 124 #define SCTP_ADD_STREAMS        121
 125 #define SCTP_SOCKOPT_PEELOFF_FLAGS 122
 126 #define SCTP_STREAM_SCHEDULER   123
 127 #define SCTP_STREAM_SCHEDULER_VALUE     124
 128
 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
 136
 137 #define __SCTP_PR_INDEX(x)      ((x >> 4) - 1)
 138 #define SCTP_PR_INDEX(x)        __SCTP_PR_INDEX(SCTP_PR_SCTP_ ## x)
 139
 140 #define SCTP_PR_POLICY(x)       ((x) & SCTP_PR_SCTP_MASK)
 141 #define SCTP_PR_SET_POLICY(flags, x)    \
 142         do {                            \
 143                 flags &= ~SCTP_PR_SCTP_MASK;    \
 144                 flags |= x;             \
 145         } while (0)
 146
 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)
 150
 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
 156
 157 #define SCTP_STREAM_RESET_INCOMING      0x01
 158 #define SCTP_STREAM_RESET_OUTGOING      0x02
 159
 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
 165 };
 166
 167 /* 5.3.1 SCTP Initiation Structure (SCTP_INIT)
 168  *
 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
 172  *   recvmsg().
 173  *
 174  *   cmsg_level    cmsg_type      cmsg_data[]
 175  *   ------------  ------------   ----------------------
 176  *   IPPROTO_SCTP  SCTP_INIT      struct sctp_initmsg
 177  */
 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;
 183 };
 184
 185 /* 5.3.2 SCTP Header Information Structure (SCTP_SNDRCV)
 186  *
 187  *   This cmsghdr structure specifies SCTP options for sendmsg() and
 188  *   describes SCTP header information about a received message through
 189  *   recvmsg().
 190  *
 191  *   cmsg_level    cmsg_type      cmsg_data[]
 192  *   ------------  ------------   ----------------------
 193  *   IPPROTO_SCTP  SCTP_SNDRCV    struct sctp_sndrcvinfo
 194  */
 195 struct sctp_sndrcvinfo {
 196         __u16 sinfo_stream;
 197         __u16 sinfo_ssn;
 198         __u16 sinfo_flags;
 199         __u32 sinfo_ppid;
 200         __u32 sinfo_context;
 201         __u32 sinfo_timetolive;
 202         __u32 sinfo_tsn;
 203         __u32 sinfo_cumtsn;
 204         sctp_assoc_t sinfo_assoc_id;
 205 };
 206
 207 /* 5.3.4 SCTP Send Information Structure (SCTP_SNDINFO)
 208  *
 209  *   This cmsghdr structure specifies SCTP options for sendmsg().
 210  *
 211  *   cmsg_level    cmsg_type      cmsg_data[]
 212  *   ------------  ------------   -------------------
 213  *   IPPROTO_SCTP  SCTP_SNDINFO   struct sctp_sndinfo
 214  */
 215 struct sctp_sndinfo {
 216         __u16 snd_sid;
 217         __u16 snd_flags;
 218         __u32 snd_ppid;
 219         __u32 snd_context;
 220         sctp_assoc_t snd_assoc_id;
 221 };
 222
 223 /* 5.3.5 SCTP Receive Information Structure (SCTP_RCVINFO)
 224  *
 225  *   This cmsghdr structure describes SCTP receive information
 226  *   about a received message through recvmsg().
 227  *
 228  *   cmsg_level    cmsg_type      cmsg_data[]
 229  *   ------------  ------------   -------------------
 230  *   IPPROTO_SCTP  SCTP_RCVINFO   struct sctp_rcvinfo
 231  */
 232 struct sctp_rcvinfo {
 233         __u16 rcv_sid;
 234         __u16 rcv_ssn;
 235         __u16 rcv_flags;
 236         __u32 rcv_ppid;
 237         __u32 rcv_tsn;
 238         __u32 rcv_cumtsn;
 239         __u32 rcv_context;
 240         sctp_assoc_t rcv_assoc_id;
 241 };
 242
 243 /* 5.3.6 SCTP Next Receive Information Structure (SCTP_NXTINFO)
 244  *
 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.
 249  *
 250  *   cmsg_level    cmsg_type      cmsg_data[]
 251  *   ------------  ------------   -------------------
 252  *   IPPROTO_SCTP  SCTP_NXTINFO   struct sctp_nxtinfo
 253  */
 254 struct sctp_nxtinfo {
 255         __u16 nxt_sid;
 256         __u16 nxt_flags;
 257         __u32 nxt_ppid;
 258         __u32 nxt_length;
 259         sctp_assoc_t nxt_assoc_id;
 260 };
 261
 262 /*
 263  *  sinfo_flags: 16 bits (unsigned integer)
 264  *
 265  *   This field may contain any of the following flags and is composed of
 266  *   a bitwise OR of these values.
 267  */
 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. */
 275 };
 276
 277 typedef union {
 278         __u8                    raw;
 279         struct sctp_initmsg     init;
 280         struct sctp_sndrcvinfo  sndrcv;
 281 } sctp_cmsg_data_t;
 282
 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
 295 } sctp_cmsg_t;
 296
 297 /*
 298  * 5.3.1.1 SCTP_ASSOC_CHANGE
 299  *
 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
 303  *   following format:
 304  *
 305  */
 306 struct sctp_assoc_change {
 307         __u16 sac_type;
 308         __u16 sac_flags;
 309         __u32 sac_length;
 310         __u16 sac_state;
 311         __u16 sac_error;
 312         __u16 sac_outbound_streams;
 313         __u16 sac_inbound_streams;
 314         sctp_assoc_t sac_assoc_id;
 315         __u8 sac_info[0];
 316 };
 317
 318 /*
 319  *   sac_state: 32 bits (signed integer)
 320  *
 321  *   This field holds one of a number of values that communicate the
 322  *   event that happened to the association.  They include:
 323  *
 324  *   Note:  The following state names deviate from the API draft as
 325  *   the names clash too easily with other kernel symbols.
 326  */
 327 enum sctp_sac_state {
 328         SCTP_COMM_UP,
 329         SCTP_COMM_LOST,
 330         SCTP_RESTART,
 331         SCTP_SHUTDOWN_COMP,
 332         SCTP_CANT_STR_ASSOC,
 333 };
 334
 335 /*
 336  * 5.3.1.2 SCTP_PEER_ADDR_CHANGE
 337  *
 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:
 341  */
 342 struct sctp_paddr_change {
 343         __u16 spc_type;
 344         __u16 spc_flags;
 345         __u32 spc_length;
 346         struct sockaddr_storage spc_aaddr;
 347         int spc_state;
 348         int spc_error;
 349         sctp_assoc_t spc_assoc_id;
 350 } __attribute__((packed, aligned(4)));
 351
 352 /*
 353  *    spc_state:  32 bits (signed integer)
 354  *
 355  *   This field holds one of a number of values that communicate the
 356  *   event that happened to the address.  They include:
 357  */
 358 enum sctp_spc_state {
 359         SCTP_ADDR_AVAILABLE,
 360         SCTP_ADDR_UNREACHABLE,
 361         SCTP_ADDR_REMOVED,
 362         SCTP_ADDR_ADDED,
 363         SCTP_ADDR_MADE_PRIM,
 364         SCTP_ADDR_CONFIRMED,
 365 };
 366
 367
 368 /*
 369  * 5.3.1.3 SCTP_REMOTE_ERROR
 370  *
 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:
 377  */
 378 struct sctp_remote_error {
 379         __u16 sre_type;
 380         __u16 sre_flags;
 381         __u32 sre_length;
 382         __be16 sre_error;
 383         sctp_assoc_t sre_assoc_id;
 384         __u8 sre_data[0];
 385 };
 386
 387
 388 /*
 389  * 5.3.1.4 SCTP_SEND_FAILED
 390  *
 391  *   If SCTP cannot deliver a message it may return the message as a
 392  *   notification.
 393  */
 394 struct sctp_send_failed {
 395         __u16 ssf_type;
 396         __u16 ssf_flags;
 397         __u32 ssf_length;
 398         __u32 ssf_error;
 399         struct sctp_sndrcvinfo ssf_info;
 400         sctp_assoc_t ssf_assoc_id;
 401         __u8 ssf_data[0];
 402 };
 403
 404 /*
 405  *   ssf_flags: 16 bits (unsigned integer)
 406  *
 407  *   The flag value will take one of the following values
 408  *
 409  *   SCTP_DATA_UNSENT  - Indicates that the data was never put on
 410  *                       the wire.
 411  *
 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.
 415  */
 416 enum sctp_ssf_flags {
 417         SCTP_DATA_UNSENT,
 418         SCTP_DATA_SENT,
 419 };
 420
 421 /*
 422  * 5.3.1.5 SCTP_SHUTDOWN_EVENT
 423  *
 424  *   When a peer sends a SHUTDOWN, SCTP delivers this notification to
 425  *   inform the application that it should cease sending data.
 426  */
 427 struct sctp_shutdown_event {
 428         __u16 sse_type;
 429         __u16 sse_flags;
 430         __u32 sse_length;
 431         sctp_assoc_t sse_assoc_id;
 432 };
 433
 434 /*
 435  * 5.3.1.6 SCTP_ADAPTATION_INDICATION
 436  *
 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.
 440  */
 441 struct sctp_adaptation_event {
 442         __u16 sai_type;
 443         __u16 sai_flags;
 444         __u32 sai_length;
 445         __u32 sai_adaptation_ind;
 446         sctp_assoc_t sai_assoc_id;
 447 };
 448
 449 /*
 450  * 5.3.1.7 SCTP_PARTIAL_DELIVERY_EVENT
 451  *
 452  *   When a receiver is engaged in a partial delivery of a
 453  *   message this notification will be used to indicate
 454  *   various events.
 455  */
 456 struct sctp_pdapi_event {
 457         __u16 pdapi_type;
 458         __u16 pdapi_flags;
 459         __u32 pdapi_length;
 460         __u32 pdapi_indication;
 461         sctp_assoc_t pdapi_assoc_id;
 462 };
 463
 464 enum { SCTP_PARTIAL_DELIVERY_ABORTED=0, };
 465
 466 /*
 467  * 5.3.1.8.  SCTP_AUTHENTICATION_EVENT
 468  *
 469  *  When a receiver is using authentication this message will provide
 470  *  notifications regarding new keys being made active as well as errors.
 471  */
 472 struct sctp_authkey_event {
 473         __u16 auth_type;
 474         __u16 auth_flags;
 475         __u32 auth_length;
 476         __u16 auth_keynumber;
 477         __u16 auth_altkeynumber;
 478         __u32 auth_indication;
 479         sctp_assoc_t auth_assoc_id;
 480 };
 481
 482 enum { SCTP_AUTH_NEWKEY = 0, };
 483
 484 /*
 485  * 6.1.9. SCTP_SENDER_DRY_EVENT
 486  *
 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.
 491  */
 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;
 497 };
 498
 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 {
 504         __u16 strreset_type;
 505         __u16 strreset_flags;
 506         __u32 strreset_length;
 507         sctp_assoc_t strreset_assoc_id;
 508         __u16 strreset_stream_list[];
 509 };
 510
 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;
 520 };
 521
 522 #define SCTP_ASSOC_CHANGE_DENIED        0x0004
 523 #define SCTP_ASSOC_CHANGE_FAILED        0x0008
 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;
 531 };
 532
 533 /*
 534  * Described in Section 7.3
 535  *   Ancillary Data and Notification Interest Options
 536  */
 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;
 551 };
 552
 553 /*
 554  * 5.3.1 SCTP Notification Structure
 555  *
 556  *   The notification structure is defined as the union of all
 557  *   notification types.
 558  *
 559  */
 560 union sctp_notification {
 561         struct {
 562                 __u16 sn_type;             /* Notification type. */
 563                 __u16 sn_flags;
 564                 __u32 sn_length;
 565         } sn_header;
 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;
 578 };
 579
 580 /* Section 5.3.1
 581  * All standard values for sn_type flags are greater than 2^15.
 582  * Values from 2^15 and down are reserved.
 583  */
 584
 585 enum sctp_sn_type {
 586         SCTP_SN_TYPE_BASE     = (1<<15),
 587         SCTP_ASSOC_CHANGE,
 588 #define SCTP_ASSOC_CHANGE               SCTP_ASSOC_CHANGE
 589         SCTP_PEER_ADDR_CHANGE,
 590 #define SCTP_PEER_ADDR_CHANGE           SCTP_PEER_ADDR_CHANGE
 591         SCTP_SEND_FAILED,
 592 #define SCTP_SEND_FAILED                SCTP_SEND_FAILED
 593         SCTP_REMOTE_ERROR,
 594 #define SCTP_REMOTE_ERROR               SCTP_REMOTE_ERROR
 595         SCTP_SHUTDOWN_EVENT,
 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
 611 };
 612
 613 /* Notification error codes used to fill up the error fields in some
 614  * notifications.
 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.
 619  */
 620 typedef enum sctp_sn_error {
 621         SCTP_FAILED_THRESHOLD,
 622         SCTP_RECEIVED_SACK,
 623         SCTP_HEARTBEAT_SUCCESS,
 624         SCTP_RESPONSE_TO_USER_REQ,
 625         SCTP_INTERNAL_ERROR,
 626         SCTP_SHUTDOWN_GUARD_EXPIRES,
 627         SCTP_PEER_FAULTY,
 628 } sctp_sn_error_t;
 629
 630 /*
 631  * 7.1.1 Retransmission Timeout Parameters (SCTP_RTOINFO)
 632  *
 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.
 636  */
 637 struct sctp_rtoinfo {
 638         sctp_assoc_t    srto_assoc_id;
 639         __u32           srto_initial;
 640         __u32           srto_max;
 641         __u32           srto_min;
 642 };
 643
 644 /*
 645  * 7.1.2 Association Parameters (SCTP_ASSOCINFO)
 646  *
 647  *   This option is used to both examine and set various association and
 648  *   endpoint parameters.
 649  */
 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;
 657 };
 658
 659 /*
 660  * 7.1.9 Set Peer Primary Address (SCTP_SET_PEER_PRIMARY_ADDR)
 661  *
 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:
 666  */
 667 struct sctp_setpeerprim {
 668         sctp_assoc_t            sspp_assoc_id;
 669         struct sockaddr_storage sspp_addr;
 670 } __attribute__((packed, aligned(4)));
 671
 672 /*
 673  * 7.1.10 Set Primary Address (SCTP_PRIMARY_ADDR)
 674  *
 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:
 679  */
 680 struct sctp_prim {
 681         sctp_assoc_t            ssp_assoc_id;
 682         struct sockaddr_storage ssp_addr;
 683 } __attribute__((packed, aligned(4)));
 684
 685 /* For backward compatibility use, define the old name too */
 686 #define sctp_setprim    sctp_prim
 687
 688 /*
 689  * 7.1.11 Set Adaptation Layer Indicator (SCTP_ADAPTATION_LAYER)
 690  *
 691  * Requests that the local endpoint set the specified Adaptation Layer
 692  * Indication parameter for all future INIT and INIT-ACK exchanges.
 693  */
 694 struct sctp_setadaptation {
 695         __u32   ssb_adaptation_ind;
 696 };
 697
 698 /*
 699  * 7.1.13 Peer Address Parameters  (SCTP_PEER_ADDR_PARAMS)
 700  *
 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:
 707  */
 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 */
 720 };
 721
 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;
 727         __u32                   spp_pathmtu;
 728         __u32                   spp_sackdelay;
 729         __u32                   spp_flags;
 730 } __attribute__((packed, aligned(4)));
 731
 732 /*
 733  * 7.1.18.  Add a chunk that must be authenticated (SCTP_AUTH_CHUNK)
 734  *
 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.
 738  */
 739 struct sctp_authchunk {
 740         __u8            sauth_chunk;
 741 };
 742
 743 /*
 744  * 7.1.19.  Get or set the list of supported HMAC Identifiers (SCTP_HMAC_IDENT)
 745  *
 746  * This option gets or sets the list of HMAC algorithms that the local
 747  * endpoint requires the peer to use.
 748  */
 749 #ifndef __KERNEL__
 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.
 752  */
 753 enum {
 754         SCTP_AUTH_HMAC_ID_SHA1 = 1,
 755         SCTP_AUTH_HMAC_ID_SHA256 = 3,
 756 };
 757 #endif
 758
 759 struct sctp_hmacalgo {
 760         __u32           shmac_num_idents;
 761         __u16           shmac_idents[];
 762 };
 763
 764 /* Sadly, user and kernel space have different names for
 765  * this structure member, so this is to not break anything.
 766  */
 767 #define shmac_number_of_idents  shmac_num_idents
 768
 769 /*
 770  * 7.1.20.  Set a shared key (SCTP_AUTH_KEY)
 771  *
 772  * This option will set a shared secret key which is used to build an
 773  * association shared key.
 774  */
 775 struct sctp_authkey {
 776         sctp_assoc_t    sca_assoc_id;
 777         __u16           sca_keynumber;
 778         __u16           sca_keylength;
 779         __u8            sca_key[];
 780 };
 781
 782 /*
 783  * 7.1.21.  Get or set the active shared key (SCTP_AUTH_ACTIVE_KEY)
 784  *
 785  * This option will get or set the active shared key to be used to build
 786  * the association shared key.
 787  */
 788
 789 struct sctp_authkeyid {
 790         sctp_assoc_t    scact_assoc_id;
 791         __u16           scact_keynumber;
 792 };
 793
 794
 795 /*
 796  * 7.1.23.  Get or set delayed ack timer (SCTP_DELAYED_SACK)
 797  *
 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.
 808  */
 809 struct sctp_sack_info {
 810         sctp_assoc_t    sack_assoc_id;
 811         uint32_t        sack_delay;
 812         uint32_t        sack_freq;
 813 };
 814
 815 struct sctp_assoc_value {
 816     sctp_assoc_t            assoc_id;
 817     uint32_t                assoc_value;
 818 };
 819
 820 struct sctp_stream_value {
 821         sctp_assoc_t assoc_id;
 822         uint16_t stream_id;
 823         uint16_t stream_value;
 824 };
 825
 826 /*
 827  * 7.2.2 Peer Address Information
 828  *
 829  *   Applications can retrieve information about a specific peer address
 830  *   of an association, including its reachability state, congestion
 831  *   window, and retransmission timer values.  This information is
 832  *   read-only. The following structure is used to access this
 833  *   information:
 834  */
 835 struct sctp_paddrinfo {
 836         sctp_assoc_t            spinfo_assoc_id;
 837         struct sockaddr_storage spinfo_address;
 838         __s32                   spinfo_state;
 839         __u32                   spinfo_cwnd;
 840         __u32                   spinfo_srtt;
 841         __u32                   spinfo_rto;
 842         __u32                   spinfo_mtu;
 843 } __attribute__((packed, aligned(4)));
 844
 845 /* Peer addresses's state. */
 846 /* UNKNOWN: Peer address passed by the upper layer in sendmsg or connect[x]
 847  * calls.
 848  * UNCONFIRMED: Peer address received in INIT/INIT-ACK address parameters.
 849  *              Not yet confirmed by a heartbeat and not available for data
 850  *              transfers.
 851  * ACTIVE : Peer address confirmed, active and available for data transfers.
 852  * INACTIVE: Peer address inactive and not available for data transfers.
 853  */
 854 enum sctp_spinfo_state {
 855         SCTP_INACTIVE,
 856         SCTP_PF,
 857         SCTP_ACTIVE,
 858         SCTP_UNCONFIRMED,
 859         SCTP_UNKNOWN = 0xffff  /* Value used for transport state unknown */
 860 };
 861
 862 /*
 863  * 7.2.1 Association Status (SCTP_STATUS)
 864  *
 865  *   Applications can retrieve current status information about an
 866  *   association, including association state, peer receiver window size,
 867  *   number of unacked data chunks, and number of data chunks pending
 868  *   receipt.  This information is read-only.  The following structure is
 869  *   used to access this information:
 870  */
 871 struct sctp_status {
 872         sctp_assoc_t            sstat_assoc_id;
 873         __s32                   sstat_state;
 874         __u32                   sstat_rwnd;
 875         __u16                   sstat_unackdata;
 876         __u16                   sstat_penddata;
 877         __u16                   sstat_instrms;
 878         __u16                   sstat_outstrms;
 879         __u32                   sstat_fragmentation_point;
 880         struct sctp_paddrinfo   sstat_primary;
 881 };
 882
 883 /*
 884  * 7.2.3.  Get the list of chunks the peer requires to be authenticated
 885  *         (SCTP_PEER_AUTH_CHUNKS)
 886  *
 887  * This option gets a list of chunks for a specified association that
 888  * the peer requires to be received authenticated only.
 889  */
 890 struct sctp_authchunks {
 891         sctp_assoc_t    gauth_assoc_id;
 892         __u32           gauth_number_of_chunks;
 893         uint8_t         gauth_chunks[];
 894 };
 895
 896 /* The broken spelling has been released already in lksctp-tools header,
 897  * so don't break anyone, now that it's fixed.
 898  */
 899 #define guth_number_of_chunks   gauth_number_of_chunks
 900
 901 /* Association states.  */
 902 enum sctp_sstat_state {
 903         SCTP_EMPTY                = 0,
 904         SCTP_CLOSED               = 1,
 905         SCTP_COOKIE_WAIT          = 2,
 906         SCTP_COOKIE_ECHOED        = 3,
 907         SCTP_ESTABLISHED          = 4,
 908         SCTP_SHUTDOWN_PENDING     = 5,
 909         SCTP_SHUTDOWN_SENT        = 6,
 910         SCTP_SHUTDOWN_RECEIVED    = 7,
 911         SCTP_SHUTDOWN_ACK_SENT    = 8,
 912 };
 913
 914 /*
 915  * 8.2.6. Get the Current Identifiers of Associations
 916  *        (SCTP_GET_ASSOC_ID_LIST)
 917  *
 918  * This option gets the current list of SCTP association identifiers of
 919  * the SCTP associations handled by a one-to-many style socket.
 920  */
 921 struct sctp_assoc_ids {
 922         __u32           gaids_number_of_ids;
 923         sctp_assoc_t    gaids_assoc_id[];
 924 };
 925
 926 /*
 927  * 8.3, 8.5 get all peer/local addresses in an association.
 928  * This parameter struct is used by SCTP_GET_PEER_ADDRS and
 929  * SCTP_GET_LOCAL_ADDRS socket options used internally to implement
 930  * sctp_getpaddrs() and sctp_getladdrs() API.
 931  */
 932 struct sctp_getaddrs_old {
 933         sctp_assoc_t            assoc_id;
 934         int                     addr_num;
 935 #ifdef __KERNEL__
 936         struct sockaddr         __user *addrs;
 937 #else
 938         struct sockaddr         *addrs;
 939 #endif
 940 };
 941
 942 struct sctp_getaddrs {
 943         sctp_assoc_t            assoc_id; /*input*/
 944         __u32                   addr_num; /*output*/
 945         __u8                    addrs[0]; /*output, variable size*/
 946 };
 947
 948 /* A socket user request obtained via SCTP_GET_ASSOC_STATS that retrieves
 949  * association stats. All stats are counts except sas_maxrto and
 950  * sas_obs_rto_ipaddr. maxrto is the max observed rto + transport since
 951  * the last call. Will return 0 when RTO was not update since last call
 952  */
 953 struct sctp_assoc_stats {
 954         sctp_assoc_t    sas_assoc_id;    /* Input */
 955                                          /* Transport of observed max RTO */
 956         struct sockaddr_storage sas_obs_rto_ipaddr;
 957         __u64           sas_maxrto;      /* Maximum Observed RTO for period */
 958         __u64           sas_isacks;      /* SACKs received */
 959         __u64           sas_osacks;      /* SACKs sent */
 960         __u64           sas_opackets;    /* Packets sent */
 961         __u64           sas_ipackets;    /* Packets received */
 962         __u64           sas_rtxchunks;   /* Retransmitted Chunks */
 963         __u64           sas_outofseqtsns;/* TSN received > next expected */
 964         __u64           sas_idupchunks;  /* Dups received (ordered+unordered) */
 965         __u64           sas_gapcnt;      /* Gap Acknowledgements Received */
 966         __u64           sas_ouodchunks;  /* Unordered data chunks sent */
 967         __u64           sas_iuodchunks;  /* Unordered data chunks received */
 968         __u64           sas_oodchunks;   /* Ordered data chunks sent */
 969         __u64           sas_iodchunks;   /* Ordered data chunks received */
 970         __u64           sas_octrlchunks; /* Control chunks sent */
 971         __u64           sas_ictrlchunks; /* Control chunks received */
 972 };
 973
 974 /*
 975  * 8.1 sctp_bindx()
 976  *
 977  * The flags parameter is formed from the bitwise OR of zero or more of the
 978  * following currently defined flags:
 979  */
 980 #define SCTP_BINDX_ADD_ADDR 0x01
 981 #define SCTP_BINDX_REM_ADDR 0x02
 982
 983 /* This is the structure that is passed as an argument(optval) to
 984  * getsockopt(SCTP_SOCKOPT_PEELOFF).
 985  */
 986 typedef struct {
 987         sctp_assoc_t associd;
 988         int sd;
 989 } sctp_peeloff_arg_t;
 990
 991 typedef struct {
 992         sctp_peeloff_arg_t p_arg;
 993         unsigned flags;
 994 } sctp_peeloff_flags_arg_t;
 995
 996 /*
 997  *  Peer Address Thresholds socket option
 998  */
 999 struct sctp_paddrthlds {
1000         sctp_assoc_t spt_assoc_id;
1001         struct sockaddr_storage spt_address;
1002         __u16 spt_pathmaxrxt;
1003         __u16 spt_pathpfthld;
1004 };
1005
1006 /*
1007  * Socket Option for Getting the Association/Stream-Specific PR-SCTP Status
1008  */
1009 struct sctp_prstatus {
1010         sctp_assoc_t sprstat_assoc_id;
1011         __u16 sprstat_sid;
1012         __u16 sprstat_policy;
1013         __u64 sprstat_abandoned_unsent;
1014         __u64 sprstat_abandoned_sent;
1015 };
1016
1017 struct sctp_default_prinfo {
1018         sctp_assoc_t pr_assoc_id;
1019         __u32 pr_value;
1020         __u16 pr_policy;
1021 };
1022
1023 struct sctp_info {
1024         __u32   sctpi_tag;
1025         __u32   sctpi_state;
1026         __u32   sctpi_rwnd;
1027         __u16   sctpi_unackdata;
1028         __u16   sctpi_penddata;
1029         __u16   sctpi_instrms;
1030         __u16   sctpi_outstrms;
1031         __u32   sctpi_fragmentation_point;
1032         __u32   sctpi_inqueue;
1033         __u32   sctpi_outqueue;
1034         __u32   sctpi_overall_error;
1035         __u32   sctpi_max_burst;
1036         __u32   sctpi_maxseg;
1037         __u32   sctpi_peer_rwnd;
1038         __u32   sctpi_peer_tag;
1039         __u8    sctpi_peer_capable;
1040         __u8    sctpi_peer_sack;
1041         __u16   __reserved1;
1042
1043         /* assoc status info */
1044         __u64   sctpi_isacks;
1045         __u64   sctpi_osacks;
1046         __u64   sctpi_opackets;
1047         __u64   sctpi_ipackets;
1048         __u64   sctpi_rtxchunks;
1049         __u64   sctpi_outofseqtsns;
1050         __u64   sctpi_idupchunks;
1051         __u64   sctpi_gapcnt;
1052         __u64   sctpi_ouodchunks;
1053         __u64   sctpi_iuodchunks;
1054         __u64   sctpi_oodchunks;
1055         __u64   sctpi_iodchunks;
1056         __u64   sctpi_octrlchunks;
1057         __u64   sctpi_ictrlchunks;
1058
1059         /* primary transport info */
1060         struct sockaddr_storage sctpi_p_address;
1061         __s32   sctpi_p_state;
1062         __u32   sctpi_p_cwnd;
1063         __u32   sctpi_p_srtt;
1064         __u32   sctpi_p_rto;
1065         __u32   sctpi_p_hbinterval;
1066         __u32   sctpi_p_pathmaxrxt;
1067         __u32   sctpi_p_sackdelay;
1068         __u32   sctpi_p_sackfreq;
1069         __u32   sctpi_p_ssthresh;
1070         __u32   sctpi_p_partial_bytes_acked;
1071         __u32   sctpi_p_flight_size;
1072         __u16   sctpi_p_error;
1073         __u16   __reserved2;
1074
1075         /* sctp sock info */
1076         __u32   sctpi_s_autoclose;
1077         __u32   sctpi_s_adaptation_ind;
1078         __u32   sctpi_s_pd_point;
1079         __u8    sctpi_s_nodelay;
1080         __u8    sctpi_s_disable_fragments;
1081         __u8    sctpi_s_v4mapped;
1082         __u8    sctpi_s_frag_interleave;
1083         __u32   sctpi_s_type;
1084         __u32   __reserved3;
1085 };
1086
1087 struct sctp_reset_streams {
1088         sctp_assoc_t srs_assoc_id;
1089         uint16_t srs_flags;
1090         uint16_t srs_number_streams;    /* 0 == ALL */
1091         uint16_t srs_stream_list[];     /* list if srs_num_streams is not 0 */
1092 };
1093
1094 struct sctp_add_streams {
1095         sctp_assoc_t sas_assoc_id;
1096         uint16_t sas_instrms;
1097         uint16_t sas_outstrms;
1098 };
1099
1100 /* SCTP Stream schedulers */
1101 enum sctp_sched_type {
1102         SCTP_SS_FCFS,
1103         SCTP_SS_PRIO,
1104         SCTP_SS_RR,
1105         SCTP_SS_MAX = SCTP_SS_RR
1106 };
1107
1108 #endif /* _UAPI_SCTP_H */