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