include/uapi/linux/sctp.h

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