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