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