Include/vos_sctp.h

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