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