include/net/sctp/user.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, write to
  26  * the Free Software Foundation, 59 Temple Place - Suite 330,
  27  * Boston, MA 02111-1307, USA.
  28  *
  29  * Please send any bug reports or fixes you make to the
  30  * email address(es):
  31  *    lksctp developers <lksctp-developers@lists.sourceforge.net>
  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  *
  48  * Any bugs reported given to us we will try to fix... any fixes shared will
  49  * be incorporated into the next SCTP release.
  50  */
  51
  52 #ifndef __net_sctp_user_h__
  53 #define __net_sctp_user_h__
  54
  55 #include <linux/types.h>
  56 #include <linux/socket.h>
  57
  58 typedef __s32 sctp_assoc_t;
  59
  60 /* The following symbols come from the Sockets API Extensions for
  61  * SCTP <draft-ietf-tsvwg-sctpsocket-07.txt>.
  62  */
  63 #define SCTP_RTOINFO    0
  64 #define SCTP_ASSOCINFO  1
  65 #define SCTP_INITMSG    2
  66 #define SCTP_NODELAY    3               /* Get/set nodelay option. */
  67 #define SCTP_AUTOCLOSE  4
  68 #define SCTP_SET_PEER_PRIMARY_ADDR 5
  69 #define SCTP_PRIMARY_ADDR       6
  70 #define SCTP_ADAPTATION_LAYER   7
  71 #define SCTP_DISABLE_FRAGMENTS  8
  72 #define SCTP_PEER_ADDR_PARAMS   9
  73 #define SCTP_DEFAULT_SEND_PARAM 10
  74 #define SCTP_EVENTS     11
  75 #define SCTP_I_WANT_MAPPED_V4_ADDR 12   /* Turn on/off mapped v4 addresses  */
  76 #define SCTP_MAXSEG     13              /* Get/set maximum fragment. */
  77 #define SCTP_STATUS     14
  78 #define SCTP_GET_PEER_ADDR_INFO 15
  79 #define SCTP_DELAYED_ACK_TIME   16
  80 #define SCTP_DELAYED_ACK SCTP_DELAYED_ACK_TIME
  81 #define SCTP_DELAYED_SACK SCTP_DELAYED_ACK_TIME
  82 #define SCTP_CONTEXT    17
  83 #define SCTP_FRAGMENT_INTERLEAVE        18
  84 #define SCTP_PARTIAL_DELIVERY_POINT     19 /* Set/Get partial delivery point */
  85 #define SCTP_MAX_BURST  20              /* Set/Get max burst */
  86 #define SCTP_AUTH_CHUNK 21      /* Set only: add a chunk type to authenticate */
  87 #define SCTP_HMAC_IDENT 22
  88 #define SCTP_AUTH_KEY   23
  89 #define SCTP_AUTH_ACTIVE_KEY    24
  90 #define SCTP_AUTH_DELETE_KEY    25
  91 #define SCTP_PEER_AUTH_CHUNKS   26      /* Read only */
  92 #define SCTP_LOCAL_AUTH_CHUNKS  27      /* Read only */
  93 #define SCTP_GET_ASSOC_NUMBER   28      /* Read only */
  94 #define SCTP_GET_ASSOC_ID_LIST  29      /* Read only */
  95 #define SCTP_AUTO_ASCONF       30
  96 #define SCTP_PEER_ADDR_THLDS    31
  97
  98 /* Internal Socket Options. Some of the sctp library functions are
  99  * implemented using these socket options.
 100  */
 101 #define SCTP_SOCKOPT_BINDX_ADD  100     /* BINDX requests for adding addrs */
 102 #define SCTP_SOCKOPT_BINDX_REM  101     /* BINDX requests for removing addrs. */
 103 #define SCTP_SOCKOPT_PEELOFF    102     /* peel off association. */
 104 /* Options 104-106 are deprecated and removed. Do not use this space */
 105 #define SCTP_SOCKOPT_CONNECTX_OLD       107     /* CONNECTX old requests. */
 106 #define SCTP_GET_PEER_ADDRS     108             /* Get all peer address. */
 107 #define SCTP_GET_LOCAL_ADDRS    109             /* Get all local address. */
 108 #define SCTP_SOCKOPT_CONNECTX   110             /* CONNECTX requests. */
 109 #define SCTP_SOCKOPT_CONNECTX3  111     /* CONNECTX requests (updated) */
 110 #define SCTP_GET_ASSOC_STATS    112     /* Read only */
 111
 112 /*
 113  * 5.2.1 SCTP Initiation Structure (SCTP_INIT)
 114  *
 115  *   This cmsghdr structure provides information for initializing new
 116  *   SCTP associations with sendmsg().  The SCTP_INITMSG socket option
 117  *   uses this same data structure.  This structure is not used for
 118  *   recvmsg().
 119  *
 120  *   cmsg_level    cmsg_type      cmsg_data[]
 121  *   ------------  ------------   ----------------------
 122  *   IPPROTO_SCTP  SCTP_INIT      struct sctp_initmsg
 123  *
 124  */
 125 struct sctp_initmsg {
 126         __u16 sinit_num_ostreams;
 127         __u16 sinit_max_instreams;
 128         __u16 sinit_max_attempts;
 129         __u16 sinit_max_init_timeo;
 130 };
 131
 132 /*
 133  * 5.2.2 SCTP Header Information Structure (SCTP_SNDRCV)
 134  *
 135  *   This cmsghdr structure specifies SCTP options for sendmsg() and
 136  *   describes SCTP header information about a received message through
 137  *   recvmsg().
 138  *
 139  *   cmsg_level    cmsg_type      cmsg_data[]
 140  *   ------------  ------------   ----------------------
 141  *   IPPROTO_SCTP  SCTP_SNDRCV    struct sctp_sndrcvinfo
 142  *
 143  */
 144 struct sctp_sndrcvinfo {
 145         __u16 sinfo_stream;
 146         __u16 sinfo_ssn;
 147         __u16 sinfo_flags;
 148         __u32 sinfo_ppid;
 149         __u32 sinfo_context;
 150         __u32 sinfo_timetolive;
 151         __u32 sinfo_tsn;
 152         __u32 sinfo_cumtsn;
 153         sctp_assoc_t sinfo_assoc_id;
 154 };
 155
 156 /*
 157  *  sinfo_flags: 16 bits (unsigned integer)
 158  *
 159  *   This field may contain any of the following flags and is composed of
 160  *   a bitwise OR of these values.
 161  */
 162
 163 enum sctp_sinfo_flags {
 164         SCTP_UNORDERED = 1,  /* Send/receive message unordered. */
 165         SCTP_ADDR_OVER = 2,  /* Override the primary destination. */
 166         SCTP_ABORT=4,        /* Send an ABORT message to the peer. */
 167         SCTP_SACK_IMMEDIATELY = 8,      /* SACK should be sent without delay */
 168         SCTP_EOF=MSG_FIN,    /* Initiate graceful shutdown process. */
 169 };
 170
 171
 172 /* These are cmsg_types.  */
 173 typedef enum sctp_cmsg_type {
 174         SCTP_INIT,              /* 5.2.1 SCTP Initiation Structure */
 175         SCTP_SNDRCV,            /* 5.2.2 SCTP Header Information Structure */
 176 } sctp_cmsg_t;
 177
 178
 179 /*
 180  * 5.3.1.1 SCTP_ASSOC_CHANGE
 181  *
 182  *   Communication notifications inform the ULP that an SCTP association
 183  *   has either begun or ended. The identifier for a new association is
 184  *   provided by this notificaion. The notification information has the
 185  *   following format:
 186  *
 187  */
 188 struct sctp_assoc_change {
 189         __u16 sac_type;
 190         __u16 sac_flags;
 191         __u32 sac_length;
 192         __u16 sac_state;
 193         __u16 sac_error;
 194         __u16 sac_outbound_streams;
 195         __u16 sac_inbound_streams;
 196         sctp_assoc_t sac_assoc_id;
 197         __u8 sac_info[0];
 198 };
 199
 200 /*
 201  *   sac_state: 32 bits (signed integer)
 202  *
 203  *   This field holds one of a number of values that communicate the
 204  *   event that happened to the association.  They include:
 205  *
 206  *   Note:  The following state names deviate from the API draft as
 207  *   the names clash too easily with other kernel symbols.
 208  */
 209 enum sctp_sac_state {
 210         SCTP_COMM_UP,
 211         SCTP_COMM_LOST,
 212         SCTP_RESTART,
 213         SCTP_SHUTDOWN_COMP,
 214         SCTP_CANT_STR_ASSOC,
 215 };
 216
 217 /*
 218  * 5.3.1.2 SCTP_PEER_ADDR_CHANGE
 219  *
 220  *   When a destination address on a multi-homed peer encounters a change
 221  *   an interface details event is sent.  The information has the
 222  *   following structure:
 223  */
 224 struct sctp_paddr_change {
 225         __u16 spc_type;
 226         __u16 spc_flags;
 227         __u32 spc_length;
 228         struct sockaddr_storage spc_aaddr;
 229         int spc_state;
 230         int spc_error;
 231         sctp_assoc_t spc_assoc_id;
 232 } __attribute__((packed, aligned(4)));
 233
 234 /*
 235  *    spc_state:  32 bits (signed integer)
 236  *
 237  *   This field holds one of a number of values that communicate the
 238  *   event that happened to the address.  They include:
 239  */
 240 enum sctp_spc_state {
 241         SCTP_ADDR_AVAILABLE,
 242         SCTP_ADDR_UNREACHABLE,
 243         SCTP_ADDR_REMOVED,
 244         SCTP_ADDR_ADDED,
 245         SCTP_ADDR_MADE_PRIM,
 246         SCTP_ADDR_CONFIRMED,
 247 };
 248
 249
 250 /*
 251  * 5.3.1.3 SCTP_REMOTE_ERROR
 252  *
 253  *   A remote peer may send an Operational Error message to its peer.
 254  *   This message indicates a variety of error conditions on an
 255  *   association. The entire error TLV as it appears on the wire is
 256  *   included in a SCTP_REMOTE_ERROR event.  Please refer to the SCTP
 257  *   specification [SCTP] and any extensions for a list of possible
 258  *   error formats. SCTP error TLVs have the format:
 259  */
 260 struct sctp_remote_error {
 261         __u16 sre_type;
 262         __u16 sre_flags;
 263         __u32 sre_length;
 264         __u16 sre_error;
 265         sctp_assoc_t sre_assoc_id;
 266         __u8 sre_data[0];
 267 };
 268
 269
 270 /*
 271  * 5.3.1.4 SCTP_SEND_FAILED
 272  *
 273  *   If SCTP cannot deliver a message it may return the message as a
 274  *   notification.
 275  */
 276 struct sctp_send_failed {
 277         __u16 ssf_type;
 278         __u16 ssf_flags;
 279         __u32 ssf_length;
 280         __u32 ssf_error;
 281         struct sctp_sndrcvinfo ssf_info;
 282         sctp_assoc_t ssf_assoc_id;
 283         __u8 ssf_data[0];
 284 };
 285
 286 /*
 287  *   ssf_flags: 16 bits (unsigned integer)
 288  *
 289  *   The flag value will take one of the following values
 290  *
 291  *   SCTP_DATA_UNSENT  - Indicates that the data was never put on
 292  *                       the wire.
 293  *
 294  *   SCTP_DATA_SENT    - Indicates that the data was put on the wire.
 295  *                       Note that this does not necessarily mean that the
 296  *                       data was (or was not) successfully delivered.
 297  */
 298 enum sctp_ssf_flags {
 299         SCTP_DATA_UNSENT,
 300         SCTP_DATA_SENT,
 301 };
 302
 303 /*
 304  * 5.3.1.5 SCTP_SHUTDOWN_EVENT
 305  *
 306  *   When a peer sends a SHUTDOWN, SCTP delivers this notification to
 307  *   inform the application that it should cease sending data.
 308  */
 309 struct sctp_shutdown_event {
 310         __u16 sse_type;
 311         __u16 sse_flags;
 312         __u32 sse_length;
 313         sctp_assoc_t sse_assoc_id;
 314 };
 315
 316 /*
 317  * 5.3.1.6 SCTP_ADAPTATION_INDICATION
 318  *
 319  *   When a peer sends a Adaptation Layer Indication parameter , SCTP
 320  *   delivers this notification to inform the application
 321  *   that of the peers requested adaptation layer.
 322  */
 323 struct sctp_adaptation_event {
 324         __u16 sai_type;
 325         __u16 sai_flags;
 326         __u32 sai_length;
 327         __u32 sai_adaptation_ind;
 328         sctp_assoc_t sai_assoc_id;
 329 };
 330
 331 /*
 332  * 5.3.1.7 SCTP_PARTIAL_DELIVERY_EVENT
 333  *
 334  *   When a receiver is engaged in a partial delivery of a
 335  *   message this notification will be used to indicate
 336  *   various events.
 337  */
 338 struct sctp_pdapi_event {
 339         __u16 pdapi_type;
 340         __u16 pdapi_flags;
 341         __u32 pdapi_length;
 342         __u32 pdapi_indication;
 343         sctp_assoc_t pdapi_assoc_id;
 344 };
 345
 346 enum { SCTP_PARTIAL_DELIVERY_ABORTED=0, };
 347
 348 struct sctp_authkey_event {
 349         __u16 auth_type;
 350         __u16 auth_flags;
 351         __u32 auth_length;
 352         __u16 auth_keynumber;
 353         __u16 auth_altkeynumber;
 354         __u32 auth_indication;
 355         sctp_assoc_t auth_assoc_id;
 356 };
 357
 358 enum { SCTP_AUTH_NEWKEY = 0, };
 359
 360 /*
 361  * 6.1.9. SCTP_SENDER_DRY_EVENT
 362  *
 363  * When the SCTP stack has no more user data to send or retransmit, this
 364  * notification is given to the user. Also, at the time when a user app
 365  * subscribes to this event, if there is no data to be sent or
 366  * retransmit, the stack will immediately send up this notification.
 367  */
 368 struct sctp_sender_dry_event {
 369         __u16 sender_dry_type;
 370         __u16 sender_dry_flags;
 371         __u32 sender_dry_length;
 372         sctp_assoc_t sender_dry_assoc_id;
 373 };
 374
 375 /*
 376  * Described in Section 7.3
 377  *   Ancillary Data and Notification Interest Options
 378  */
 379 struct sctp_event_subscribe {
 380         __u8 sctp_data_io_event;
 381         __u8 sctp_association_event;
 382         __u8 sctp_address_event;
 383         __u8 sctp_send_failure_event;
 384         __u8 sctp_peer_error_event;
 385         __u8 sctp_shutdown_event;
 386         __u8 sctp_partial_delivery_event;
 387         __u8 sctp_adaptation_layer_event;
 388         __u8 sctp_authentication_event;
 389         __u8 sctp_sender_dry_event;
 390 };
 391
 392 /*
 393  * 5.3.1 SCTP Notification Structure
 394  *
 395  *   The notification structure is defined as the union of all
 396  *   notification types.
 397  *
 398  */
 399 union sctp_notification {
 400         struct {
 401                 __u16 sn_type;             /* Notification type. */
 402                 __u16 sn_flags;
 403                 __u32 sn_length;
 404         } sn_header;
 405         struct sctp_assoc_change sn_assoc_change;
 406         struct sctp_paddr_change sn_paddr_change;
 407         struct sctp_remote_error sn_remote_error;
 408         struct sctp_send_failed sn_send_failed;
 409         struct sctp_shutdown_event sn_shutdown_event;
 410         struct sctp_adaptation_event sn_adaptation_event;
 411         struct sctp_pdapi_event sn_pdapi_event;
 412         struct sctp_authkey_event sn_authkey_event;
 413         struct sctp_sender_dry_event sn_sender_dry_event;
 414 };
 415
 416 /* Section 5.3.1
 417  * All standard values for sn_type flags are greater than 2^15.
 418  * Values from 2^15 and down are reserved.
 419  */
 420
 421 enum sctp_sn_type {
 422         SCTP_SN_TYPE_BASE     = (1<<15),
 423         SCTP_ASSOC_CHANGE,
 424         SCTP_PEER_ADDR_CHANGE,
 425         SCTP_SEND_FAILED,
 426         SCTP_REMOTE_ERROR,
 427         SCTP_SHUTDOWN_EVENT,
 428         SCTP_PARTIAL_DELIVERY_EVENT,
 429         SCTP_ADAPTATION_INDICATION,
 430         SCTP_AUTHENTICATION_EVENT,
 431 #define SCTP_AUTHENTICATION_INDICATION  SCTP_AUTHENTICATION_EVENT
 432         SCTP_SENDER_DRY_EVENT,
 433 };
 434
 435 /* Notification error codes used to fill up the error fields in some
 436  * notifications.
 437  * SCTP_PEER_ADDRESS_CHAGE      : spc_error
 438  * SCTP_ASSOC_CHANGE            : sac_error
 439  * These names should be potentially included in the draft 04 of the SCTP
 440  * sockets API specification.
 441  */
 442 typedef enum sctp_sn_error {
 443         SCTP_FAILED_THRESHOLD,
 444         SCTP_RECEIVED_SACK,
 445         SCTP_HEARTBEAT_SUCCESS,
 446         SCTP_RESPONSE_TO_USER_REQ,
 447         SCTP_INTERNAL_ERROR,
 448         SCTP_SHUTDOWN_GUARD_EXPIRES,
 449         SCTP_PEER_FAULTY,
 450 } sctp_sn_error_t;
 451
 452 /*
 453  * 7.1.1 Retransmission Timeout Parameters (SCTP_RTOINFO)
 454  *
 455  *   The protocol parameters used to initialize and bound retransmission
 456  *   timeout (RTO) are tunable.  See [SCTP] for more information on how
 457  *   these parameters are used in RTO calculation.
 458  */
 459 struct sctp_rtoinfo {
 460         sctp_assoc_t    srto_assoc_id;
 461         __u32           srto_initial;
 462         __u32           srto_max;
 463         __u32           srto_min;
 464 };
 465
 466 /*
 467  * 7.1.2 Association Parameters (SCTP_ASSOCINFO)
 468  *
 469  *   This option is used to both examine and set various association and
 470  *   endpoint parameters.
 471  */
 472 struct sctp_assocparams {
 473         sctp_assoc_t    sasoc_assoc_id;
 474         __u16           sasoc_asocmaxrxt;
 475         __u16           sasoc_number_peer_destinations;
 476         __u32           sasoc_peer_rwnd;
 477         __u32           sasoc_local_rwnd;
 478         __u32           sasoc_cookie_life;
 479 };
 480
 481 /*
 482  * 7.1.9 Set Peer Primary Address (SCTP_SET_PEER_PRIMARY_ADDR)
 483  *
 484  *  Requests that the peer mark the enclosed address as the association
 485  *  primary. The enclosed address must be one of the association's
 486  *  locally bound addresses. The following structure is used to make a
 487  *   set primary request:
 488  */
 489 struct sctp_setpeerprim {
 490         sctp_assoc_t            sspp_assoc_id;
 491         struct sockaddr_storage sspp_addr;
 492 } __attribute__((packed, aligned(4)));
 493
 494 /*
 495  * 7.1.10 Set Primary Address (SCTP_PRIMARY_ADDR)
 496  *
 497  *  Requests that the local SCTP stack use the enclosed peer address as
 498  *  the association primary. The enclosed address must be one of the
 499  *  association peer's addresses. The following structure is used to
 500  *  make a set peer primary request:
 501  */
 502 struct sctp_prim {
 503         sctp_assoc_t            ssp_assoc_id;
 504         struct sockaddr_storage ssp_addr;
 505 } __attribute__((packed, aligned(4)));
 506
 507 /*
 508  * 7.1.11 Set Adaptation Layer Indicator (SCTP_ADAPTATION_LAYER)
 509  *
 510  * Requests that the local endpoint set the specified Adaptation Layer
 511  * Indication parameter for all future INIT and INIT-ACK exchanges.
 512  */
 513 struct sctp_setadaptation {
 514         __u32   ssb_adaptation_ind;
 515 };
 516
 517 /*
 518  * 7.1.13 Peer Address Parameters  (SCTP_PEER_ADDR_PARAMS)
 519  *
 520  *   Applications can enable or disable heartbeats for any peer address
 521  *   of an association, modify an address's heartbeat interval, force a
 522  *   heartbeat to be sent immediately, and adjust the address's maximum
 523  *   number of retransmissions sent before an address is considered
 524  *   unreachable. The following structure is used to access and modify an
 525  *   address's parameters:
 526  */
 527 enum  sctp_spp_flags {
 528         SPP_HB_ENABLE = 1<<0,           /*Enable heartbeats*/
 529         SPP_HB_DISABLE = 1<<1,          /*Disable heartbeats*/
 530         SPP_HB = SPP_HB_ENABLE | SPP_HB_DISABLE,
 531         SPP_HB_DEMAND = 1<<2,           /*Send heartbeat immediately*/
 532         SPP_PMTUD_ENABLE = 1<<3,        /*Enable PMTU discovery*/
 533         SPP_PMTUD_DISABLE = 1<<4,       /*Disable PMTU discovery*/
 534         SPP_PMTUD = SPP_PMTUD_ENABLE | SPP_PMTUD_DISABLE,
 535         SPP_SACKDELAY_ENABLE = 1<<5,    /*Enable SACK*/
 536         SPP_SACKDELAY_DISABLE = 1<<6,   /*Disable SACK*/
 537         SPP_SACKDELAY = SPP_SACKDELAY_ENABLE | SPP_SACKDELAY_DISABLE,
 538         SPP_HB_TIME_IS_ZERO = 1<<7,     /* Set HB delay to 0 */
 539 };
 540
 541 struct sctp_paddrparams {
 542         sctp_assoc_t            spp_assoc_id;
 543         struct sockaddr_storage spp_address;
 544         __u32                   spp_hbinterval;
 545         __u16                   spp_pathmaxrxt;
 546         __u32                   spp_pathmtu;
 547         __u32                   spp_sackdelay;
 548         __u32                   spp_flags;
 549 } __attribute__((packed, aligned(4)));
 550
 551 /*
 552  * 7.1.18.  Add a chunk that must be authenticated (SCTP_AUTH_CHUNK)
 553  *
 554  * This set option adds a chunk type that the user is requesting to be
 555  * received only in an authenticated way.  Changes to the list of chunks
 556  * will only effect future associations on the socket.
 557  */
 558 struct sctp_authchunk {
 559         __u8            sauth_chunk;
 560 };
 561
 562 /*
 563  * 7.1.19.  Get or set the list of supported HMAC Identifiers (SCTP_HMAC_IDENT)
 564  *
 565  * This option gets or sets the list of HMAC algorithms that the local
 566  * endpoint requires the peer to use.
 567 */
 568 struct sctp_hmacalgo {
 569         __u32           shmac_num_idents;
 570         __u16           shmac_idents[];
 571 };
 572
 573 /*
 574  * 7.1.20.  Set a shared key (SCTP_AUTH_KEY)
 575  *
 576  * This option will set a shared secret key which is used to build an
 577  * association shared key.
 578  */
 579 struct sctp_authkey {
 580         sctp_assoc_t    sca_assoc_id;
 581         __u16           sca_keynumber;
 582         __u16           sca_keylength;
 583         __u8            sca_key[];
 584 };
 585
 586 /*
 587  * 7.1.21.  Get or set the active shared key (SCTP_AUTH_ACTIVE_KEY)
 588  *
 589  * This option will get or set the active shared key to be used to build
 590  * the association shared key.
 591  */
 592
 593 struct sctp_authkeyid {
 594         sctp_assoc_t    scact_assoc_id;
 595         __u16           scact_keynumber;
 596 };
 597
 598
 599 /*
 600  * 7.1.23.  Get or set delayed ack timer (SCTP_DELAYED_SACK)
 601  *
 602  * This option will effect the way delayed acks are performed.  This
 603  * option allows you to get or set the delayed ack time, in
 604  * milliseconds.  It also allows changing the delayed ack frequency.
 605  * Changing the frequency to 1 disables the delayed sack algorithm.  If
 606  * the assoc_id is 0, then this sets or gets the endpoints default
 607  * values.  If the assoc_id field is non-zero, then the set or get
 608  * effects the specified association for the one to many model (the
 609  * assoc_id field is ignored by the one to one model).  Note that if
 610  * sack_delay or sack_freq are 0 when setting this option, then the
 611  * current values will remain unchanged.
 612  */
 613 struct sctp_sack_info {
 614         sctp_assoc_t    sack_assoc_id;
 615         uint32_t        sack_delay;
 616         uint32_t        sack_freq;
 617 };
 618
 619 struct sctp_assoc_value {
 620     sctp_assoc_t            assoc_id;
 621     uint32_t                assoc_value;
 622 };
 623
 624 /*
 625  * 7.2.2 Peer Address Information
 626  *
 627  *   Applications can retrieve information about a specific peer address
 628  *   of an association, including its reachability state, congestion
 629  *   window, and retransmission timer values.  This information is
 630  *   read-only. The following structure is used to access this
 631  *   information:
 632  */
 633 struct sctp_paddrinfo {
 634         sctp_assoc_t            spinfo_assoc_id;
 635         struct sockaddr_storage spinfo_address;
 636         __s32                   spinfo_state;
 637         __u32                   spinfo_cwnd;
 638         __u32                   spinfo_srtt;
 639         __u32                   spinfo_rto;
 640         __u32                   spinfo_mtu;
 641 } __attribute__((packed, aligned(4)));
 642
 643 /* Peer addresses's state. */
 644 /* UNKNOWN: Peer address passed by the upper layer in sendmsg or connect[x]
 645  * calls.
 646  * UNCONFIRMED: Peer address received in INIT/INIT-ACK address parameters.
 647  *              Not yet confirmed by a heartbeat and not available for data
 648  *              transfers.
 649  * ACTIVE : Peer address confirmed, active and available for data transfers.
 650  * INACTIVE: Peer address inactive and not available for data transfers.
 651  */
 652 enum sctp_spinfo_state {
 653         SCTP_INACTIVE,
 654         SCTP_PF,
 655         SCTP_ACTIVE,
 656         SCTP_UNCONFIRMED,
 657         SCTP_UNKNOWN = 0xffff  /* Value used for transport state unknown */
 658 };
 659
 660 /*
 661  * 7.2.1 Association Status (SCTP_STATUS)
 662  *
 663  *   Applications can retrieve current status information about an
 664  *   association, including association state, peer receiver window size,
 665  *   number of unacked data chunks, and number of data chunks pending
 666  *   receipt.  This information is read-only.  The following structure is
 667  *   used to access this information:
 668  */
 669 struct sctp_status {
 670         sctp_assoc_t            sstat_assoc_id;
 671         __s32                   sstat_state;
 672         __u32                   sstat_rwnd;
 673         __u16                   sstat_unackdata;
 674         __u16                   sstat_penddata;
 675         __u16                   sstat_instrms;
 676         __u16                   sstat_outstrms;
 677         __u32                   sstat_fragmentation_point;
 678         struct sctp_paddrinfo   sstat_primary;
 679 };
 680
 681 /*
 682  * 7.2.3.  Get the list of chunks the peer requires to be authenticated
 683  *         (SCTP_PEER_AUTH_CHUNKS)
 684  *
 685  * This option gets a list of chunks for a specified association that
 686  * the peer requires to be received authenticated only.
 687  */
 688 struct sctp_authchunks {
 689         sctp_assoc_t    gauth_assoc_id;
 690         __u32           gauth_number_of_chunks;
 691         uint8_t         gauth_chunks[];
 692 };
 693
 694 /*
 695  * 8.2.6. Get the Current Identifiers of Associations
 696  *        (SCTP_GET_ASSOC_ID_LIST)
 697  *
 698  * This option gets the current list of SCTP association identifiers of
 699  * the SCTP associations handled by a one-to-many style socket.
 700  */
 701 struct sctp_assoc_ids {
 702         __u32           gaids_number_of_ids;
 703         sctp_assoc_t    gaids_assoc_id[];
 704 };
 705
 706 /*
 707  * 8.3, 8.5 get all peer/local addresses in an association.
 708  * This parameter struct is used by SCTP_GET_PEER_ADDRS and
 709  * SCTP_GET_LOCAL_ADDRS socket options used internally to implement
 710  * sctp_getpaddrs() and sctp_getladdrs() API.
 711  */
 712 struct sctp_getaddrs_old {
 713         sctp_assoc_t            assoc_id;
 714         int                     addr_num;
 715         struct sockaddr         __user *addrs;
 716 };
 717 struct sctp_getaddrs {
 718         sctp_assoc_t            assoc_id; /*input*/
 719         __u32                   addr_num; /*output*/
 720         __u8                    addrs[0]; /*output, variable size*/
 721 };
 722
 723 /* A socket user request obtained via SCTP_GET_ASSOC_STATS that retrieves
 724  * association stats. All stats are counts except sas_maxrto and
 725  * sas_obs_rto_ipaddr. maxrto is the max observed rto + transport since
 726  * the last call. Will return 0 when RTO was not update since last call
 727  */
 728 struct sctp_assoc_stats {
 729         sctp_assoc_t    sas_assoc_id;    /* Input */
 730                                          /* Transport of observed max RTO */
 731         struct sockaddr_storage sas_obs_rto_ipaddr;
 732         __u64           sas_maxrto;      /* Maximum Observed RTO for period */
 733         __u64           sas_isacks;      /* SACKs received */
 734         __u64           sas_osacks;      /* SACKs sent */
 735         __u64           sas_opackets;    /* Packets sent */
 736         __u64           sas_ipackets;    /* Packets received */
 737         __u64           sas_rtxchunks;   /* Retransmitted Chunks */
 738         __u64           sas_outofseqtsns;/* TSN received > next expected */
 739         __u64           sas_idupchunks;  /* Dups received (ordered+unordered) */
 740         __u64           sas_gapcnt;      /* Gap Acknowledgements Received */
 741         __u64           sas_ouodchunks;  /* Unordered data chunks sent */
 742         __u64           sas_iuodchunks;  /* Unordered data chunks received */
 743         __u64           sas_oodchunks;   /* Ordered data chunks sent */
 744         __u64           sas_iodchunks;   /* Ordered data chunks received */
 745         __u64           sas_octrlchunks; /* Control chunks sent */
 746         __u64           sas_ictrlchunks; /* Control chunks received */
 747 };
 748
 749 /* These are bit fields for msghdr->msg_flags.  See section 5.1.  */
 750 /* On user space Linux, these live in <bits/socket.h> as an enum.  */
 751 enum sctp_msg_flags {
 752         MSG_NOTIFICATION = 0x8000,
 753 #define MSG_NOTIFICATION MSG_NOTIFICATION
 754 };
 755
 756 /*
 757  * 8.1 sctp_bindx()
 758  *
 759  * The flags parameter is formed from the bitwise OR of zero or more of the
 760  * following currently defined flags:
 761  */
 762 #define SCTP_BINDX_ADD_ADDR 0x01
 763 #define SCTP_BINDX_REM_ADDR 0x02
 764
 765 /* This is the structure that is passed as an argument(optval) to
 766  * getsockopt(SCTP_SOCKOPT_PEELOFF).
 767  */
 768 typedef struct {
 769         sctp_assoc_t associd;
 770         int sd;
 771 } sctp_peeloff_arg_t;
 772
 773 /*
 774  *  Peer Address Thresholds socket option
 775  */
 776 struct sctp_paddrthlds {
 777         sctp_assoc_t spt_assoc_id;
 778         struct sockaddr_storage spt_address;
 779         __u16 spt_pathmaxrxt;
 780         __u16 spt_pathpfthld;
 781 };
 782 #endif /* __net_sctp_user_h__ */