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 <linux-sctp@vger.kernel.org>
  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    <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>
  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 #define SCTP_INTERLEAVING_SUPPORTED     125
 129
 130 /* PR-SCTP policies */
 131 #define SCTP_PR_SCTP_NONE       0x0000
 132 #define SCTP_PR_SCTP_TTL        0x0010
 133 #define SCTP_PR_SCTP_RTX        0x0020
 134 #define SCTP_PR_SCTP_PRIO       0x0030
 135 #define SCTP_PR_SCTP_MAX        SCTP_PR_SCTP_PRIO
 136 #define SCTP_PR_SCTP_MASK       0x0030
 137
 138 #define __SCTP_PR_INDEX(x)      ((x >> 4) - 1)
 139 #define SCTP_PR_INDEX(x)        __SCTP_PR_INDEX(SCTP_PR_SCTP_ ## x)
 140
 141 #define SCTP_PR_POLICY(x)       ((x) & SCTP_PR_SCTP_MASK)
 142 #define SCTP_PR_SET_POLICY(flags, x)    \
 143         do {                            \
 144                 flags &= ~SCTP_PR_SCTP_MASK;    \
 145                 flags |= x;             \
 146         } while (0)
 147
 148 #define SCTP_PR_TTL_ENABLED(x)  (SCTP_PR_POLICY(x) == SCTP_PR_SCTP_TTL)
 149 #define SCTP_PR_RTX_ENABLED(x)  (SCTP_PR_POLICY(x) == SCTP_PR_SCTP_RTX)
 150 #define SCTP_PR_PRIO_ENABLED(x) (SCTP_PR_POLICY(x) == SCTP_PR_SCTP_PRIO)
 151
 152 /* For enable stream reset */
 153 #define SCTP_ENABLE_RESET_STREAM_REQ    0x01
 154 #define SCTP_ENABLE_RESET_ASSOC_REQ     0x02
 155 #define SCTP_ENABLE_CHANGE_ASSOC_REQ    0x04
 156 #define SCTP_ENABLE_STRRESET_MASK       0x07
 157
 158 #define SCTP_STREAM_RESET_INCOMING      0x01
 159 #define SCTP_STREAM_RESET_OUTGOING      0x02
 160
 161 /* These are bit fields for msghdr->msg_flags.  See section 5.1.  */
 162 /* On user space Linux, these live in <bits/socket.h> as an enum.  */
 163 enum sctp_msg_flags {
 164         MSG_NOTIFICATION = 0x8000,
 165 #define MSG_NOTIFICATION MSG_NOTIFICATION
 166 };
 167
 168 /* 5.3.1 SCTP Initiation Structure (SCTP_INIT)
 169  *
 170  *   This cmsghdr structure provides information for initializing new
 171  *   SCTP associations with sendmsg().  The SCTP_INITMSG socket option
 172  *   uses this same data structure.  This structure is not used for
 173  *   recvmsg().
 174  *
 175  *   cmsg_level    cmsg_type      cmsg_data[]
 176  *   ------------  ------------   ----------------------
 177  *   IPPROTO_SCTP  SCTP_INIT      struct sctp_initmsg
 178  */
 179 struct sctp_initmsg {
 180         __u16 sinit_num_ostreams;
 181         __u16 sinit_max_instreams;
 182         __u16 sinit_max_attempts;
 183         __u16 sinit_max_init_timeo;
 184 };
 185
 186 /* 5.3.2 SCTP Header Information Structure (SCTP_SNDRCV)
 187  *
 188  *   This cmsghdr structure specifies SCTP options for sendmsg() and
 189  *   describes SCTP header information about a received message through
 190  *   recvmsg().
 191  *
 192  *   cmsg_level    cmsg_type      cmsg_data[]
 193  *   ------------  ------------   ----------------------
 194  *   IPPROTO_SCTP  SCTP_SNDRCV    struct sctp_sndrcvinfo
 195  */
 196 struct sctp_sndrcvinfo {
 197         __u16 sinfo_stream;
 198         __u16 sinfo_ssn;
 199         __u16 sinfo_flags;
 200         __u32 sinfo_ppid;
 201         __u32 sinfo_context;
 202         __u32 sinfo_timetolive;
 203         __u32 sinfo_tsn;
 204         __u32 sinfo_cumtsn;
 205         sctp_assoc_t sinfo_assoc_id;
 206 };
 207
 208 /* 5.3.4 SCTP Send Information Structure (SCTP_SNDINFO)
 209  *
 210  *   This cmsghdr structure specifies SCTP options for sendmsg().
 211  *
 212  *   cmsg_level    cmsg_type      cmsg_data[]
 213  *   ------------  ------------   -------------------
 214  *   IPPROTO_SCTP  SCTP_SNDINFO   struct sctp_sndinfo
 215  */
 216 struct sctp_sndinfo {
 217         __u16 snd_sid;
 218         __u16 snd_flags;
 219         __u32 snd_ppid;
 220         __u32 snd_context;
 221         sctp_assoc_t snd_assoc_id;
 222 };
 223
 224 /* 5.3.5 SCTP Receive Information Structure (SCTP_RCVINFO)
 225  *
 226  *   This cmsghdr structure describes SCTP receive information
 227  *   about a received message through recvmsg().
 228  *
 229  *   cmsg_level    cmsg_type      cmsg_data[]
 230  *   ------------  ------------   -------------------
 231  *   IPPROTO_SCTP  SCTP_RCVINFO   struct sctp_rcvinfo
 232  */
 233 struct sctp_rcvinfo {
 234         __u16 rcv_sid;
 235         __u16 rcv_ssn;
 236         __u16 rcv_flags;
 237         __u32 rcv_ppid;
 238         __u32 rcv_tsn;
 239         __u32 rcv_cumtsn;
 240         __u32 rcv_context;
 241         sctp_assoc_t rcv_assoc_id;
 242 };
 243
 244 /* 5.3.6 SCTP Next Receive Information Structure (SCTP_NXTINFO)
 245  *
 246  *   This cmsghdr structure describes SCTP receive information
 247  *   of the next message that will be delivered through recvmsg()
 248  *   if this information is already available when delivering
 249  *   the current message.
 250  *
 251  *   cmsg_level    cmsg_type      cmsg_data[]
 252  *   ------------  ------------   -------------------
 253  *   IPPROTO_SCTP  SCTP_NXTINFO   struct sctp_nxtinfo
 254  */
 255 struct sctp_nxtinfo {
 256         __u16 nxt_sid;
 257         __u16 nxt_flags;
 258         __u32 nxt_ppid;
 259         __u32 nxt_length;
 260         sctp_assoc_t nxt_assoc_id;
 261 };
 262
 263 /*
 264  *  sinfo_flags: 16 bits (unsigned integer)
 265  *
 266  *   This field may contain any of the following flags and is composed of
 267  *   a bitwise OR of these values.
 268  */
 269 enum sctp_sinfo_flags {
 270         SCTP_UNORDERED          = (1 << 0), /* Send/receive message unordered. */
 271         SCTP_ADDR_OVER          = (1 << 1), /* Override the primary destination. */
 272         SCTP_ABORT              = (1 << 2), /* Send an ABORT message to the peer. */
 273         SCTP_SACK_IMMEDIATELY   = (1 << 3), /* SACK should be sent without delay. */
 274         SCTP_NOTIFICATION       = MSG_NOTIFICATION, /* Next message is not user msg but notification. */
 275         SCTP_EOF                = MSG_FIN,  /* Initiate graceful shutdown process. */
 276 };
 277
 278 typedef union {
 279         __u8                    raw;
 280         struct sctp_initmsg     init;
 281         struct sctp_sndrcvinfo  sndrcv;
 282 } sctp_cmsg_data_t;
 283
 284 /* These are cmsg_types.  */
 285 typedef enum sctp_cmsg_type {
 286         SCTP_INIT,              /* 5.2.1 SCTP Initiation Structure */
 287 #define SCTP_INIT       SCTP_INIT
 288         SCTP_SNDRCV,            /* 5.2.2 SCTP Header Information Structure */
 289 #define SCTP_SNDRCV     SCTP_SNDRCV
 290         SCTP_SNDINFO,           /* 5.3.4 SCTP Send Information Structure */
 291 #define SCTP_SNDINFO    SCTP_SNDINFO
 292         SCTP_RCVINFO,           /* 5.3.5 SCTP Receive Information Structure */
 293 #define SCTP_RCVINFO    SCTP_RCVINFO
 294         SCTP_NXTINFO,           /* 5.3.6 SCTP Next Receive Information Structure */
 295 #define SCTP_NXTINFO    SCTP_NXTINFO
 296 } sctp_cmsg_t;
 297
 298 /*
 299  * 5.3.1.1 SCTP_ASSOC_CHANGE
 300  *
 301  *   Communication notifications inform the ULP that an SCTP association
 302  *   has either begun or ended. The identifier for a new association is
 303  *   provided by this notificaion. The notification information has the
 304  *   following format:
 305  *
 306  */
 307 struct sctp_assoc_change {
 308         __u16 sac_type;
 309         __u16 sac_flags;
 310         __u32 sac_length;
 311         __u16 sac_state;
 312         __u16 sac_error;
 313         __u16 sac_outbound_streams;
 314         __u16 sac_inbound_streams;
 315         sctp_assoc_t sac_assoc_id;
 316         __u8 sac_info[0];
 317 };
 318
 319 /*
 320  *   sac_state: 32 bits (signed integer)
 321  *
 322  *   This field holds one of a number of values that communicate the
 323  *   event that happened to the association.  They include:
 324  *
 325  *   Note:  The following state names deviate from the API draft as
 326  *   the names clash too easily with other kernel symbols.
 327  */
 328 enum sctp_sac_state {
 329         SCTP_COMM_UP,
 330         SCTP_COMM_LOST,
 331         SCTP_RESTART,
 332         SCTP_SHUTDOWN_COMP,
 333         SCTP_CANT_STR_ASSOC,
 334 };
 335
 336 /*
 337  * 5.3.1.2 SCTP_PEER_ADDR_CHANGE
 338  *
 339  *   When a destination address on a multi-homed peer encounters a change
 340  *   an interface details event is sent.  The information has the
 341  *   following structure:
 342  */
 343 struct sctp_paddr_change {
 344         __u16 spc_type;
 345         __u16 spc_flags;
 346         __u32 spc_length;
 347         struct sockaddr_storage spc_aaddr;
 348         int spc_state;
 349         int spc_error;
 350         sctp_assoc_t spc_assoc_id;
 351 } __attribute__((packed, aligned(4)));
 352
 353 /*
 354  *    spc_state:  32 bits (signed integer)
 355  *
 356  *   This field holds one of a number of values that communicate the
 357  *   event that happened to the address.  They include:
 358  */
 359 enum sctp_spc_state {
 360         SCTP_ADDR_AVAILABLE,
 361         SCTP_ADDR_UNREACHABLE,
 362         SCTP_ADDR_REMOVED,
 363         SCTP_ADDR_ADDED,
 364         SCTP_ADDR_MADE_PRIM,
 365         SCTP_ADDR_CONFIRMED,
 366 };
 367
 368
 369 /*
 370  * 5.3.1.3 SCTP_REMOTE_ERROR
 371  *
 372  *   A remote peer may send an Operational Error message to its peer.
 373  *   This message indicates a variety of error conditions on an
 374  *   association. The entire error TLV as it appears on the wire is
 375  *   included in a SCTP_REMOTE_ERROR event.  Please refer to the SCTP
 376  *   specification [SCTP] and any extensions for a list of possible
 377  *   error formats. SCTP error TLVs have the format:
 378  */
 379 struct sctp_remote_error {
 380         __u16 sre_type;
 381         __u16 sre_flags;
 382         __u32 sre_length;
 383         __be16 sre_error;
 384         sctp_assoc_t sre_assoc_id;
 385         __u8 sre_data[0];
 386 };
 387
 388
 389 /*
 390  * 5.3.1.4 SCTP_SEND_FAILED
 391  *
 392  *   If SCTP cannot deliver a message it may return the message as a
 393  *   notification.
 394  */
 395 struct sctp_send_failed {
 396         __u16 ssf_type;
 397         __u16 ssf_flags;
 398         __u32 ssf_length;
 399         __u32 ssf_error;
 400         struct sctp_sndrcvinfo ssf_info;
 401         sctp_assoc_t ssf_assoc_id;
 402         __u8 ssf_data[0];
 403 };
 404
 405 /*
 406  *   ssf_flags: 16 bits (unsigned integer)
 407  *
 408  *   The flag value will take one of the following values
 409  *
 410  *   SCTP_DATA_UNSENT  - Indicates that the data was never put on
 411  *                       the wire.
 412  *
 413  *   SCTP_DATA_SENT    - Indicates that the data was put on the wire.
 414  *                       Note that this does not necessarily mean that the
 415  *                       data was (or was not) successfully delivered.
 416  */
 417 enum sctp_ssf_flags {
 418         SCTP_DATA_UNSENT,
 419         SCTP_DATA_SENT,
 420 };
 421
 422 /*
 423  * 5.3.1.5 SCTP_SHUTDOWN_EVENT
 424  *
 425  *   When a peer sends a SHUTDOWN, SCTP delivers this notification to
 426  *   inform the application that it should cease sending data.
 427  */
 428 struct sctp_shutdown_event {
 429         __u16 sse_type;
 430         __u16 sse_flags;
 431         __u32 sse_length;
 432         sctp_assoc_t sse_assoc_id;
 433 };
 434
 435 /*
 436  * 5.3.1.6 SCTP_ADAPTATION_INDICATION
 437  *
 438  *   When a peer sends a Adaptation Layer Indication parameter , SCTP
 439  *   delivers this notification to inform the application
 440  *   that of the peers requested adaptation layer.
 441  */
 442 struct sctp_adaptation_event {
 443         __u16 sai_type;
 444         __u16 sai_flags;
 445         __u32 sai_length;
 446         __u32 sai_adaptation_ind;
 447         sctp_assoc_t sai_assoc_id;
 448 };
 449
 450 /*
 451  * 5.3.1.7 SCTP_PARTIAL_DELIVERY_EVENT
 452  *
 453  *   When a receiver is engaged in a partial delivery of a
 454  *   message this notification will be used to indicate
 455  *   various events.
 456  */
 457 struct sctp_pdapi_event {
 458         __u16 pdapi_type;
 459         __u16 pdapi_flags;
 460         __u32 pdapi_length;
 461         __u32 pdapi_indication;
 462         sctp_assoc_t pdapi_assoc_id;
 463         __u32 pdapi_stream;
 464         __u32 pdapi_seq;
 465 };
 466
 467 enum { SCTP_PARTIAL_DELIVERY_ABORTED=0, };
 468
 469 /*
 470  * 5.3.1.8.  SCTP_AUTHENTICATION_EVENT
 471  *
 472  *  When a receiver is using authentication this message will provide
 473  *  notifications regarding new keys being made active as well as errors.
 474  */
 475 struct sctp_authkey_event {
 476         __u16 auth_type;
 477         __u16 auth_flags;
 478         __u32 auth_length;
 479         __u16 auth_keynumber;
 480         __u16 auth_altkeynumber;
 481         __u32 auth_indication;
 482         sctp_assoc_t auth_assoc_id;
 483 };
 484
 485 enum { SCTP_AUTH_NEWKEY = 0, };
 486
 487 /*
 488  * 6.1.9. SCTP_SENDER_DRY_EVENT
 489  *
 490  * When the SCTP stack has no more user data to send or retransmit, this
 491  * notification is given to the user. Also, at the time when a user app
 492  * subscribes to this event, if there is no data to be sent or
 493  * retransmit, the stack will immediately send up this notification.
 494  */
 495 struct sctp_sender_dry_event {
 496         __u16 sender_dry_type;
 497         __u16 sender_dry_flags;
 498         __u32 sender_dry_length;
 499         sctp_assoc_t sender_dry_assoc_id;
 500 };
 501
 502 #define SCTP_STREAM_RESET_INCOMING_SSN  0x0001
 503 #define SCTP_STREAM_RESET_OUTGOING_SSN  0x0002
 504 #define SCTP_STREAM_RESET_DENIED        0x0004
 505 #define SCTP_STREAM_RESET_FAILED        0x0008
 506 struct sctp_stream_reset_event {
 507         __u16 strreset_type;
 508         __u16 strreset_flags;
 509         __u32 strreset_length;
 510         sctp_assoc_t strreset_assoc_id;
 511         __u16 strreset_stream_list[];
 512 };
 513
 514 #define SCTP_ASSOC_RESET_DENIED         0x0004
 515 #define SCTP_ASSOC_RESET_FAILED         0x0008
 516 struct sctp_assoc_reset_event {
 517         __u16 assocreset_type;
 518         __u16 assocreset_flags;
 519         __u32 assocreset_length;
 520         sctp_assoc_t assocreset_assoc_id;
 521         __u32 assocreset_local_tsn;
 522         __u32 assocreset_remote_tsn;
 523 };
 524
 525 #define SCTP_ASSOC_CHANGE_DENIED        0x0004
 526 #define SCTP_ASSOC_CHANGE_FAILED        0x0008
 527 struct sctp_stream_change_event {
 528         __u16 strchange_type;
 529         __u16 strchange_flags;
 530         __u32 strchange_length;
 531         sctp_assoc_t strchange_assoc_id;
 532         __u16 strchange_instrms;
 533         __u16 strchange_outstrms;
 534 };
 535
 536 /*
 537  * Described in Section 7.3
 538  *   Ancillary Data and Notification Interest Options
 539  */
 540 struct sctp_event_subscribe {
 541         __u8 sctp_data_io_event;
 542         __u8 sctp_association_event;
 543         __u8 sctp_address_event;
 544         __u8 sctp_send_failure_event;
 545         __u8 sctp_peer_error_event;
 546         __u8 sctp_shutdown_event;
 547         __u8 sctp_partial_delivery_event;
 548         __u8 sctp_adaptation_layer_event;
 549         __u8 sctp_authentication_event;
 550         __u8 sctp_sender_dry_event;
 551         __u8 sctp_stream_reset_event;
 552         __u8 sctp_assoc_reset_event;
 553         __u8 sctp_stream_change_event;
 554 };
 555
 556 /*
 557  * 5.3.1 SCTP Notification Structure
 558  *
 559  *   The notification structure is defined as the union of all
 560  *   notification types.
 561  *
 562  */
 563 union sctp_notification {
 564         struct {
 565                 __u16 sn_type;             /* Notification type. */
 566                 __u16 sn_flags;
 567                 __u32 sn_length;
 568         } sn_header;
 569         struct sctp_assoc_change sn_assoc_change;
 570         struct sctp_paddr_change sn_paddr_change;
 571         struct sctp_remote_error sn_remote_error;
 572         struct sctp_send_failed sn_send_failed;
 573         struct sctp_shutdown_event sn_shutdown_event;
 574         struct sctp_adaptation_event sn_adaptation_event;
 575         struct sctp_pdapi_event sn_pdapi_event;
 576         struct sctp_authkey_event sn_authkey_event;
 577         struct sctp_sender_dry_event sn_sender_dry_event;
 578         struct sctp_stream_reset_event sn_strreset_event;
 579         struct sctp_assoc_reset_event sn_assocreset_event;
 580         struct sctp_stream_change_event sn_strchange_event;
 581 };
 582
 583 /* Section 5.3.1
 584  * All standard values for sn_type flags are greater than 2^15.
 585  * Values from 2^15 and down are reserved.
 586  */
 587
 588 enum sctp_sn_type {
 589         SCTP_SN_TYPE_BASE     = (1<<15),
 590         SCTP_ASSOC_CHANGE,
 591 #define SCTP_ASSOC_CHANGE               SCTP_ASSOC_CHANGE
 592         SCTP_PEER_ADDR_CHANGE,
 593 #define SCTP_PEER_ADDR_CHANGE           SCTP_PEER_ADDR_CHANGE
 594         SCTP_SEND_FAILED,
 595 #define SCTP_SEND_FAILED                SCTP_SEND_FAILED
 596         SCTP_REMOTE_ERROR,
 597 #define SCTP_REMOTE_ERROR               SCTP_REMOTE_ERROR
 598         SCTP_SHUTDOWN_EVENT,
 599 #define SCTP_SHUTDOWN_EVENT             SCTP_SHUTDOWN_EVENT
 600         SCTP_PARTIAL_DELIVERY_EVENT,
 601 #define SCTP_PARTIAL_DELIVERY_EVENT     SCTP_PARTIAL_DELIVERY_EVENT
 602         SCTP_ADAPTATION_INDICATION,
 603 #define SCTP_ADAPTATION_INDICATION      SCTP_ADAPTATION_INDICATION
 604         SCTP_AUTHENTICATION_EVENT,
 605 #define SCTP_AUTHENTICATION_INDICATION  SCTP_AUTHENTICATION_EVENT
 606         SCTP_SENDER_DRY_EVENT,
 607 #define SCTP_SENDER_DRY_EVENT           SCTP_SENDER_DRY_EVENT
 608         SCTP_STREAM_RESET_EVENT,
 609 #define SCTP_STREAM_RESET_EVENT         SCTP_STREAM_RESET_EVENT
 610         SCTP_ASSOC_RESET_EVENT,
 611 #define SCTP_ASSOC_RESET_EVENT          SCTP_ASSOC_RESET_EVENT
 612         SCTP_STREAM_CHANGE_EVENT,
 613 #define SCTP_STREAM_CHANGE_EVENT        SCTP_STREAM_CHANGE_EVENT
 614 };
 615
 616 /* Notification error codes used to fill up the error fields in some
 617  * notifications.
 618  * SCTP_PEER_ADDRESS_CHAGE      : spc_error
 619  * SCTP_ASSOC_CHANGE            : sac_error
 620  * These names should be potentially included in the draft 04 of the SCTP
 621  * sockets API specification.
 622  */
 623 typedef enum sctp_sn_error {
 624         SCTP_FAILED_THRESHOLD,
 625         SCTP_RECEIVED_SACK,
 626         SCTP_HEARTBEAT_SUCCESS,
 627         SCTP_RESPONSE_TO_USER_REQ,
 628         SCTP_INTERNAL_ERROR,
 629         SCTP_SHUTDOWN_GUARD_EXPIRES,
 630         SCTP_PEER_FAULTY,
 631 } sctp_sn_error_t;
 632
 633 /*
 634  * 7.1.1 Retransmission Timeout Parameters (SCTP_RTOINFO)
 635  *
 636  *   The protocol parameters used to initialize and bound retransmission
 637  *   timeout (RTO) are tunable.  See [SCTP] for more information on how
 638  *   these parameters are used in RTO calculation.
 639  */
 640 struct sctp_rtoinfo {
 641         sctp_assoc_t    srto_assoc_id;
 642         __u32           srto_initial;
 643         __u32           srto_max;
 644         __u32           srto_min;
 645 };
 646
 647 /*
 648  * 7.1.2 Association Parameters (SCTP_ASSOCINFO)
 649  *
 650  *   This option is used to both examine and set various association and
 651  *   endpoint parameters.
 652  */
 653 struct sctp_assocparams {
 654         sctp_assoc_t    sasoc_assoc_id;
 655         __u16           sasoc_asocmaxrxt;
 656         __u16           sasoc_number_peer_destinations;
 657         __u32           sasoc_peer_rwnd;
 658         __u32           sasoc_local_rwnd;
 659         __u32           sasoc_cookie_life;
 660 };
 661
 662 /*
 663  * 7.1.9 Set Peer Primary Address (SCTP_SET_PEER_PRIMARY_ADDR)
 664  *
 665  *  Requests that the peer mark the enclosed address as the association
 666  *  primary. The enclosed address must be one of the association's
 667  *  locally bound addresses. The following structure is used to make a
 668  *   set primary request:
 669  */
 670 struct sctp_setpeerprim {
 671         sctp_assoc_t            sspp_assoc_id;
 672         struct sockaddr_storage sspp_addr;
 673 } __attribute__((packed, aligned(4)));
 674
 675 /*
 676  * 7.1.10 Set Primary Address (SCTP_PRIMARY_ADDR)
 677  *
 678  *  Requests that the local SCTP stack use the enclosed peer address as
 679  *  the association primary. The enclosed address must be one of the
 680  *  association peer's addresses. The following structure is used to
 681  *  make a set peer primary request:
 682  */
 683 struct sctp_prim {
 684         sctp_assoc_t            ssp_assoc_id;
 685         struct sockaddr_storage ssp_addr;
 686 } __attribute__((packed, aligned(4)));
 687
 688 /* For backward compatibility use, define the old name too */
 689 #define sctp_setprim    sctp_prim
 690
 691 /*
 692  * 7.1.11 Set Adaptation Layer Indicator (SCTP_ADAPTATION_LAYER)
 693  *
 694  * Requests that the local endpoint set the specified Adaptation Layer
 695  * Indication parameter for all future INIT and INIT-ACK exchanges.
 696  */
 697 struct sctp_setadaptation {
 698         __u32   ssb_adaptation_ind;
 699 };
 700
 701 /*
 702  * 7.1.13 Peer Address Parameters  (SCTP_PEER_ADDR_PARAMS)
 703  *
 704  *   Applications can enable or disable heartbeats for any peer address
 705  *   of an association, modify an address's heartbeat interval, force a
 706  *   heartbeat to be sent immediately, and adjust the address's maximum
 707  *   number of retransmissions sent before an address is considered
 708  *   unreachable. The following structure is used to access and modify an
 709  *   address's parameters:
 710  */
 711 enum  sctp_spp_flags {
 712         SPP_HB_ENABLE = 1<<0,           /*Enable heartbeats*/
 713         SPP_HB_DISABLE = 1<<1,          /*Disable heartbeats*/
 714         SPP_HB = SPP_HB_ENABLE | SPP_HB_DISABLE,
 715         SPP_HB_DEMAND = 1<<2,           /*Send heartbeat immediately*/
 716         SPP_PMTUD_ENABLE = 1<<3,        /*Enable PMTU discovery*/
 717         SPP_PMTUD_DISABLE = 1<<4,       /*Disable PMTU discovery*/
 718         SPP_PMTUD = SPP_PMTUD_ENABLE | SPP_PMTUD_DISABLE,
 719         SPP_SACKDELAY_ENABLE = 1<<5,    /*Enable SACK*/
 720         SPP_SACKDELAY_DISABLE = 1<<6,   /*Disable SACK*/
 721         SPP_SACKDELAY = SPP_SACKDELAY_ENABLE | SPP_SACKDELAY_DISABLE,
 722         SPP_HB_TIME_IS_ZERO = 1<<7,     /* Set HB delay to 0 */
 723 };
 724
 725 struct sctp_paddrparams {
 726         sctp_assoc_t            spp_assoc_id;
 727         struct sockaddr_storage spp_address;
 728         __u32                   spp_hbinterval;
 729         __u16                   spp_pathmaxrxt;
 730         __u32                   spp_pathmtu;
 731         __u32                   spp_sackdelay;
 732         __u32                   spp_flags;
 733 } __attribute__((packed, aligned(4)));
 734
 735 /*
 736  * 7.1.18.  Add a chunk that must be authenticated (SCTP_AUTH_CHUNK)
 737  *
 738  * This set option adds a chunk type that the user is requesting to be
 739  * received only in an authenticated way.  Changes to the list of chunks
 740  * will only effect future associations on the socket.
 741  */
 742 struct sctp_authchunk {
 743         __u8            sauth_chunk;
 744 };
 745
 746 /*
 747  * 7.1.19.  Get or set the list of supported HMAC Identifiers (SCTP_HMAC_IDENT)
 748  *
 749  * This option gets or sets the list of HMAC algorithms that the local
 750  * endpoint requires the peer to use.
 751  */
 752 #ifndef __KERNEL__
 753 /* This here is only used by user space as is. It might not be a good idea
 754  * to export/reveal the whole structure with reserved fields etc.
 755  */
 756 enum {
 757         SCTP_AUTH_HMAC_ID_SHA1 = 1,
 758         SCTP_AUTH_HMAC_ID_SHA256 = 3,
 759 };
 760 #endif
 761
 762 struct sctp_hmacalgo {
 763         __u32           shmac_num_idents;
 764         __u16           shmac_idents[];
 765 };
 766
 767 /* Sadly, user and kernel space have different names for
 768  * this structure member, so this is to not break anything.
 769  */
 770 #define shmac_number_of_idents  shmac_num_idents
 771
 772 /*
 773  * 7.1.20.  Set a shared key (SCTP_AUTH_KEY)
 774  *
 775  * This option will set a shared secret key which is used to build an
 776  * association shared key.
 777  */
 778 struct sctp_authkey {
 779         sctp_assoc_t    sca_assoc_id;
 780         __u16           sca_keynumber;
 781         __u16           sca_keylength;
 782         __u8            sca_key[];
 783 };
 784
 785 /*
 786  * 7.1.21.  Get or set the active shared key (SCTP_AUTH_ACTIVE_KEY)
 787  *
 788  * This option will get or set the active shared key to be used to build
 789  * the association shared key.
 790  */
 791
 792 struct sctp_authkeyid {
 793         sctp_assoc_t    scact_assoc_id;
 794         __u16           scact_keynumber;
 795 };
 796
 797
 798 /*
 799  * 7.1.23.  Get or set delayed ack timer (SCTP_DELAYED_SACK)
 800  *
 801  * This option will effect the way delayed acks are performed.  This
 802  * option allows you to get or set the delayed ack time, in
 803  * milliseconds.  It also allows changing the delayed ack frequency.
 804  * Changing the frequency to 1 disables the delayed sack algorithm.  If
 805  * the assoc_id is 0, then this sets or gets the endpoints default
 806  * values.  If the assoc_id field is non-zero, then the set or get
 807  * effects the specified association for the one to many model (the
 808  * assoc_id field is ignored by the one to one model).  Note that if
 809  * sack_delay or sack_freq are 0 when setting this option, then the
 810  * current values will remain unchanged.
 811  */
 812 struct sctp_sack_info {
 813         sctp_assoc_t    sack_assoc_id;
 814         uint32_t        sack_delay;
 815         uint32_t        sack_freq;
 816 };
 817
 818 struct sctp_assoc_value {
 819     sctp_assoc_t            assoc_id;
 820     uint32_t                assoc_value;
 821 };
 822
 823 struct sctp_stream_value {
 824         sctp_assoc_t assoc_id;
 825         uint16_t stream_id;
 826         uint16_t stream_value;
 827 };
 828
 829 /*
 830  * 7.2.2 Peer Address Information
 831  *
 832  *   Applications can retrieve information about a specific peer address
 833  *   of an association, including its reachability state, congestion
 834  *   window, and retransmission timer values.  This information is
 835  *   read-only. The following structure is used to access this
 836  *   information:
 837  */
 838 struct sctp_paddrinfo {
 839         sctp_assoc_t            spinfo_assoc_id;
 840         struct sockaddr_storage spinfo_address;
 841         __s32                   spinfo_state;
 842         __u32                   spinfo_cwnd;
 843         __u32                   spinfo_srtt;
 844         __u32                   spinfo_rto;
 845         __u32                   spinfo_mtu;
 846 } __attribute__((packed, aligned(4)));
 847
 848 /* Peer addresses's state. */
 849 /* UNKNOWN: Peer address passed by the upper layer in sendmsg or connect[x]
 850  * calls.
 851  * UNCONFIRMED: Peer address received in INIT/INIT-ACK address parameters.
 852  *              Not yet confirmed by a heartbeat and not available for data
 853  *              transfers.
 854  * ACTIVE : Peer address confirmed, active and available for data transfers.
 855  * INACTIVE: Peer address inactive and not available for data transfers.
 856  */
 857 enum sctp_spinfo_state {
 858         SCTP_INACTIVE,
 859         SCTP_PF,
 860         SCTP_ACTIVE,
 861         SCTP_UNCONFIRMED,
 862         SCTP_UNKNOWN = 0xffff  /* Value used for transport state unknown */
 863 };
 864
 865 /*
 866  * 7.2.1 Association Status (SCTP_STATUS)
 867  *
 868  *   Applications can retrieve current status information about an
 869  *   association, including association state, peer receiver window size,
 870  *   number of unacked data chunks, and number of data chunks pending
 871  *   receipt.  This information is read-only.  The following structure is
 872  *   used to access this information:
 873  */
 874 struct sctp_status {
 875         sctp_assoc_t            sstat_assoc_id;
 876         __s32                   sstat_state;
 877         __u32                   sstat_rwnd;
 878         __u16                   sstat_unackdata;
 879         __u16                   sstat_penddata;
 880         __u16                   sstat_instrms;
 881         __u16                   sstat_outstrms;
 882         __u32                   sstat_fragmentation_point;
 883         struct sctp_paddrinfo   sstat_primary;
 884 };
 885
 886 /*
 887  * 7.2.3.  Get the list of chunks the peer requires to be authenticated
 888  *         (SCTP_PEER_AUTH_CHUNKS)
 889  *
 890  * This option gets a list of chunks for a specified association that
 891  * the peer requires to be received authenticated only.
 892  */
 893 struct sctp_authchunks {
 894         sctp_assoc_t    gauth_assoc_id;
 895         __u32           gauth_number_of_chunks;
 896         uint8_t         gauth_chunks[];
 897 };
 898
 899 /* The broken spelling has been released already in lksctp-tools header,
 900  * so don't break anyone, now that it's fixed.
 901  */
 902 #define guth_number_of_chunks   gauth_number_of_chunks
 903
 904 /* Association states.  */
 905 enum sctp_sstat_state {
 906         SCTP_EMPTY                = 0,
 907         SCTP_CLOSED               = 1,
 908         SCTP_COOKIE_WAIT          = 2,
 909         SCTP_COOKIE_ECHOED        = 3,
 910         SCTP_ESTABLISHED          = 4,
 911         SCTP_SHUTDOWN_PENDING     = 5,
 912         SCTP_SHUTDOWN_SENT        = 6,
 913         SCTP_SHUTDOWN_RECEIVED    = 7,
 914         SCTP_SHUTDOWN_ACK_SENT    = 8,
 915 };
 916
 917 /*
 918  * 8.2.6. Get the Current Identifiers of Associations
 919  *        (SCTP_GET_ASSOC_ID_LIST)
 920  *
 921  * This option gets the current list of SCTP association identifiers of
 922  * the SCTP associations handled by a one-to-many style socket.
 923  */
 924 struct sctp_assoc_ids {
 925         __u32           gaids_number_of_ids;
 926         sctp_assoc_t    gaids_assoc_id[];
 927 };
 928
 929 /*
 930  * 8.3, 8.5 get all peer/local addresses in an association.
 931  * This parameter struct is used by SCTP_GET_PEER_ADDRS and
 932  * SCTP_GET_LOCAL_ADDRS socket options used internally to implement
 933  * sctp_getpaddrs() and sctp_getladdrs() API.
 934  */
 935 struct sctp_getaddrs_old {
 936         sctp_assoc_t            assoc_id;
 937         int                     addr_num;
 938 #ifdef __KERNEL__
 939         struct sockaddr         __user *addrs;
 940 #else
 941         struct sockaddr         *addrs;
 942 #endif
 943 };
 944
 945 struct sctp_getaddrs {
 946         sctp_assoc_t            assoc_id; /*input*/
 947         __u32                   addr_num; /*output*/
 948         __u8                    addrs[0]; /*output, variable size*/
 949 };
 950
 951 /* A socket user request obtained via SCTP_GET_ASSOC_STATS that retrieves
 952  * association stats. All stats are counts except sas_maxrto and
 953  * sas_obs_rto_ipaddr. maxrto is the max observed rto + transport since
 954  * the last call. Will return 0 when RTO was not update since last call
 955  */
 956 struct sctp_assoc_stats {
 957         sctp_assoc_t    sas_assoc_id;    /* Input */
 958                                          /* Transport of observed max RTO */
 959         struct sockaddr_storage sas_obs_rto_ipaddr;
 960         __u64           sas_maxrto;      /* Maximum Observed RTO for period */
 961         __u64           sas_isacks;      /* SACKs received */
 962         __u64           sas_osacks;      /* SACKs sent */
 963         __u64           sas_opackets;    /* Packets sent */
 964         __u64           sas_ipackets;    /* Packets received */
 965         __u64           sas_rtxchunks;   /* Retransmitted Chunks */
 966         __u64           sas_outofseqtsns;/* TSN received > next expected */
 967         __u64           sas_idupchunks;  /* Dups received (ordered+unordered) */
 968         __u64           sas_gapcnt;      /* Gap Acknowledgements Received */
 969         __u64           sas_ouodchunks;  /* Unordered data chunks sent */
 970         __u64           sas_iuodchunks;  /* Unordered data chunks received */
 971         __u64           sas_oodchunks;   /* Ordered data chunks sent */
 972         __u64           sas_iodchunks;   /* Ordered data chunks received */
 973         __u64           sas_octrlchunks; /* Control chunks sent */
 974         __u64           sas_ictrlchunks; /* Control chunks received */
 975 };
 976
 977 /*
 978  * 8.1 sctp_bindx()
 979  *
 980  * The flags parameter is formed from the bitwise OR of zero or more of the
 981  * following currently defined flags:
 982  */
 983 #define SCTP_BINDX_ADD_ADDR 0x01
 984 #define SCTP_BINDX_REM_ADDR 0x02
 985
 986 /* This is the structure that is passed as an argument(optval) to
 987  * getsockopt(SCTP_SOCKOPT_PEELOFF).
 988  */
 989 typedef struct {
 990         sctp_assoc_t associd;
 991         int sd;
 992 } sctp_peeloff_arg_t;
 993
 994 typedef struct {
 995         sctp_peeloff_arg_t p_arg;
 996         unsigned flags;
 997 } sctp_peeloff_flags_arg_t;
 998
 999 /*
1000  *  Peer Address Thresholds socket option
1001  */
1002 struct sctp_paddrthlds {
1003         sctp_assoc_t spt_assoc_id;
1004         struct sockaddr_storage spt_address;
1005         __u16 spt_pathmaxrxt;
1006         __u16 spt_pathpfthld;
1007 };
1008
1009 /*
1010  * Socket Option for Getting the Association/Stream-Specific PR-SCTP Status
1011  */
1012 struct sctp_prstatus {
1013         sctp_assoc_t sprstat_assoc_id;
1014         __u16 sprstat_sid;
1015         __u16 sprstat_policy;
1016         __u64 sprstat_abandoned_unsent;
1017         __u64 sprstat_abandoned_sent;
1018 };
1019
1020 struct sctp_default_prinfo {
1021         sctp_assoc_t pr_assoc_id;
1022         __u32 pr_value;
1023         __u16 pr_policy;
1024 };
1025
1026 struct sctp_info {
1027         __u32   sctpi_tag;
1028         __u32   sctpi_state;
1029         __u32   sctpi_rwnd;
1030         __u16   sctpi_unackdata;
1031         __u16   sctpi_penddata;
1032         __u16   sctpi_instrms;
1033         __u16   sctpi_outstrms;
1034         __u32   sctpi_fragmentation_point;
1035         __u32   sctpi_inqueue;
1036         __u32   sctpi_outqueue;
1037         __u32   sctpi_overall_error;
1038         __u32   sctpi_max_burst;
1039         __u32   sctpi_maxseg;
1040         __u32   sctpi_peer_rwnd;
1041         __u32   sctpi_peer_tag;
1042         __u8    sctpi_peer_capable;
1043         __u8    sctpi_peer_sack;
1044         __u16   __reserved1;
1045
1046         /* assoc status info */
1047         __u64   sctpi_isacks;
1048         __u64   sctpi_osacks;
1049         __u64   sctpi_opackets;
1050         __u64   sctpi_ipackets;
1051         __u64   sctpi_rtxchunks;
1052         __u64   sctpi_outofseqtsns;
1053         __u64   sctpi_idupchunks;
1054         __u64   sctpi_gapcnt;
1055         __u64   sctpi_ouodchunks;
1056         __u64   sctpi_iuodchunks;
1057         __u64   sctpi_oodchunks;
1058         __u64   sctpi_iodchunks;
1059         __u64   sctpi_octrlchunks;
1060         __u64   sctpi_ictrlchunks;
1061
1062         /* primary transport info */
1063         struct sockaddr_storage sctpi_p_address;
1064         __s32   sctpi_p_state;
1065         __u32   sctpi_p_cwnd;
1066         __u32   sctpi_p_srtt;
1067         __u32   sctpi_p_rto;
1068         __u32   sctpi_p_hbinterval;
1069         __u32   sctpi_p_pathmaxrxt;
1070         __u32   sctpi_p_sackdelay;
1071         __u32   sctpi_p_sackfreq;
1072         __u32   sctpi_p_ssthresh;
1073         __u32   sctpi_p_partial_bytes_acked;
1074         __u32   sctpi_p_flight_size;
1075         __u16   sctpi_p_error;
1076         __u16   __reserved2;
1077
1078         /* sctp sock info */
1079         __u32   sctpi_s_autoclose;
1080         __u32   sctpi_s_adaptation_ind;
1081         __u32   sctpi_s_pd_point;
1082         __u8    sctpi_s_nodelay;
1083         __u8    sctpi_s_disable_fragments;
1084         __u8    sctpi_s_v4mapped;
1085         __u8    sctpi_s_frag_interleave;
1086         __u32   sctpi_s_type;
1087         __u32   __reserved3;
1088 };
1089
1090 struct sctp_reset_streams {
1091         sctp_assoc_t srs_assoc_id;
1092         uint16_t srs_flags;
1093         uint16_t srs_number_streams;    /* 0 == ALL */
1094         uint16_t srs_stream_list[];     /* list if srs_num_streams is not 0 */
1095 };
1096
1097 struct sctp_add_streams {
1098         sctp_assoc_t sas_assoc_id;
1099         uint16_t sas_instrms;
1100         uint16_t sas_outstrms;
1101 };
1102
1103 /* SCTP Stream schedulers */
1104 enum sctp_sched_type {
1105         SCTP_SS_FCFS,
1106         SCTP_SS_PRIO,
1107         SCTP_SS_RR,
1108         SCTP_SS_MAX = SCTP_SS_RR
1109 };
1110
1111 #endif /* _UAPI_SCTP_H */