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