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