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