include/net/sctp/user.h

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