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