Include/vos_sctp.h

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