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, see 26 * <http://www.gnu.org/licenses/>. 27 * 28 * Please send any bug reports or fixes you make to the 29 * email address(es): 30 * lksctp developers <[email protected]> 31 * 32 * Or submit a bug report through the following website: 33 * http://www.sf.net/projects/lksctp 34 * 35 * Written or modified by: 36 * La Monte H.P. Yarroll <[email protected]> 37 * R. Stewart <[email protected]> 38 * K. Morneau <[email protected]> 39 * Q. Xie <[email protected]> 40 * Karl Knutson <[email protected]> 41 * Jon Grimm <[email protected]> 42 * Daisy Chang <[email protected]> 43 * Ryan Layer <[email protected]> 44 * Ardelle Fan <[email protected]> 45 * Sridhar Samudrala <[email protected]> 46 * Inaky Perez-Gonzalez <[email protected]> 47 * Vlad Yasevich <[email protected]> 48 * 49 * Any bugs reported given to us we will try to fix... any fixes shared will 50 * be incorporated into the next SCTP release. 51 */ 52 53 #ifndef _UAPI_SCTP_H 54 #define _UAPI_SCTP_H 55 56 #include <linux/types.h> 57 #include <linux/socket.h> 58 59 typedef __s32 sctp_assoc_t; 60 61 /* The following symbols come from the Sockets API Extensions for 62 * SCTP <draft-ietf-tsvwg-sctpsocket-07.txt>. 63 */ 64 #define SCTP_RTOINFO 0 65 #define SCTP_ASSOCINFO 1 66 #define SCTP_INITMSG 2 67 #define SCTP_NODELAY 3 /* Get/set nodelay option. */ 68 #define SCTP_AUTOCLOSE 4 69 #define SCTP_SET_PEER_PRIMARY_ADDR 5 70 #define SCTP_PRIMARY_ADDR 6 71 #define SCTP_ADAPTATION_LAYER 7 72 #define SCTP_DISABLE_FRAGMENTS 8 73 #define SCTP_PEER_ADDR_PARAMS 9 74 #define SCTP_DEFAULT_SEND_PARAM 10 75 #define SCTP_EVENTS 11 76 #define SCTP_I_WANT_MAPPED_V4_ADDR 12 /* Turn on/off mapped v4 addresses */ 77 #define SCTP_MAXSEG 13 /* Get/set maximum fragment. */ 78 #define SCTP_STATUS 14 79 #define SCTP_GET_PEER_ADDR_INFO 15 80 #define SCTP_DELAYED_ACK_TIME 16 81 #define SCTP_DELAYED_ACK SCTP_DELAYED_ACK_TIME 82 #define SCTP_DELAYED_SACK SCTP_DELAYED_ACK_TIME 83 #define SCTP_CONTEXT 17 84 #define SCTP_FRAGMENT_INTERLEAVE 18 85 #define SCTP_PARTIAL_DELIVERY_POINT 19 /* Set/Get partial delivery point */ 86 #define SCTP_MAX_BURST 20 /* Set/Get max burst */ 87 #define SCTP_AUTH_CHUNK 21 /* Set only: add a chunk type to authenticate */ 88 #define SCTP_HMAC_IDENT 22 89 #define SCTP_AUTH_KEY 23 90 #define SCTP_AUTH_ACTIVE_KEY 24 91 #define SCTP_AUTH_DELETE_KEY 25 92 #define SCTP_PEER_AUTH_CHUNKS 26 /* Read only */ 93 #define SCTP_LOCAL_AUTH_CHUNKS 27 /* Read only */ 94 #define SCTP_GET_ASSOC_NUMBER 28 /* Read only */ 95 #define SCTP_GET_ASSOC_ID_LIST 29 /* Read only */ 96 #define SCTP_AUTO_ASCONF 30 97 #define SCTP_PEER_ADDR_THLDS 31 98 #define SCTP_RECVRCVINFO 32 99 #define SCTP_RECVNXTINFO 33 100 #define SCTP_DEFAULT_SNDINFO 34 101 102 /* Internal Socket Options. Some of the sctp library functions are 103 * implemented using these socket options. 104 */ 105 #define SCTP_SOCKOPT_BINDX_ADD 100 /* BINDX requests for adding addrs */ 106 #define SCTP_SOCKOPT_BINDX_REM 101 /* BINDX requests for removing addrs. */ 107 #define SCTP_SOCKOPT_PEELOFF 102 /* peel off association. */ 108 /* Options 104-106 are deprecated and removed. Do not use this space */ 109 #define SCTP_SOCKOPT_CONNECTX_OLD 107 /* CONNECTX old requests. */ 110 #define SCTP_GET_PEER_ADDRS 108 /* Get all peer address. */ 111 #define SCTP_GET_LOCAL_ADDRS 109 /* Get all local address. */ 112 #define SCTP_SOCKOPT_CONNECTX 110 /* CONNECTX requests. */ 113 #define SCTP_SOCKOPT_CONNECTX3 111 /* CONNECTX requests (updated) */ 114 #define SCTP_GET_ASSOC_STATS 112 /* Read only */ 115 #define SCTP_PR_SUPPORTED 113 116 #define SCTP_DEFAULT_PRINFO 114 117 #define SCTP_PR_ASSOC_STATUS 115 118 #define SCTP_ENABLE_STREAM_RESET 118 119 #define SCTP_RESET_STREAMS 119 120 121 /* PR-SCTP policies */ 122 #define SCTP_PR_SCTP_NONE 0x0000 123 #define SCTP_PR_SCTP_TTL 0x0010 124 #define SCTP_PR_SCTP_RTX 0x0020 125 #define SCTP_PR_SCTP_PRIO 0x0030 126 #define SCTP_PR_SCTP_MAX SCTP_PR_SCTP_PRIO 127 #define SCTP_PR_SCTP_MASK 0x0030 128 129 #define __SCTP_PR_INDEX(x) ((x >> 4) - 1) 130 #define SCTP_PR_INDEX(x) __SCTP_PR_INDEX(SCTP_PR_SCTP_ ## x) 131 132 #define SCTP_PR_POLICY(x) ((x) & SCTP_PR_SCTP_MASK) 133 #define SCTP_PR_SET_POLICY(flags, x) \ 134 do { \ 135 flags &= ~SCTP_PR_SCTP_MASK; \ 136 flags |= x; \ 137 } while (0) 138 139 #define SCTP_PR_TTL_ENABLED(x) (SCTP_PR_POLICY(x) == SCTP_PR_SCTP_TTL) 140 #define SCTP_PR_RTX_ENABLED(x) (SCTP_PR_POLICY(x) == SCTP_PR_SCTP_RTX) 141 #define SCTP_PR_PRIO_ENABLED(x) (SCTP_PR_POLICY(x) == SCTP_PR_SCTP_PRIO) 142 143 /* For enable stream reset */ 144 #define SCTP_ENABLE_RESET_STREAM_REQ 0x01 145 #define SCTP_ENABLE_RESET_ASSOC_REQ 0x02 146 #define SCTP_ENABLE_CHANGE_ASSOC_REQ 0x04 147 #define SCTP_ENABLE_STRRESET_MASK 0x07 148 149 #define SCTP_STREAM_RESET_INCOMING 0x01 150 #define SCTP_STREAM_RESET_OUTGOING 0x02 151 152 /* These are bit fields for msghdr->msg_flags. See section 5.1. */ 153 /* On user space Linux, these live in <bits/socket.h> as an enum. */ 154 enum sctp_msg_flags { 155 MSG_NOTIFICATION = 0x8000, 156 #define MSG_NOTIFICATION MSG_NOTIFICATION 157 }; 158 159 /* 5.3.1 SCTP Initiation Structure (SCTP_INIT) 160 * 161 * This cmsghdr structure provides information for initializing new 162 * SCTP associations with sendmsg(). The SCTP_INITMSG socket option 163 * uses this same data structure. This structure is not used for 164 * recvmsg(). 165 * 166 * cmsg_level cmsg_type cmsg_data[] 167 * ------------ ------------ ---------------------- 168 * IPPROTO_SCTP SCTP_INIT struct sctp_initmsg 169 */ 170 struct sctp_initmsg { 171 __u16 sinit_num_ostreams; 172 __u16 sinit_max_instreams; 173 __u16 sinit_max_attempts; 174 __u16 sinit_max_init_timeo; 175 }; 176 177 /* 5.3.2 SCTP Header Information Structure (SCTP_SNDRCV) 178 * 179 * This cmsghdr structure specifies SCTP options for sendmsg() and 180 * describes SCTP header information about a received message through 181 * recvmsg(). 182 * 183 * cmsg_level cmsg_type cmsg_data[] 184 * ------------ ------------ ---------------------- 185 * IPPROTO_SCTP SCTP_SNDRCV struct sctp_sndrcvinfo 186 */ 187 struct sctp_sndrcvinfo { 188 __u16 sinfo_stream; 189 __u16 sinfo_ssn; 190 __u16 sinfo_flags; 191 __u32 sinfo_ppid; 192 __u32 sinfo_context; 193 __u32 sinfo_timetolive; 194 __u32 sinfo_tsn; 195 __u32 sinfo_cumtsn; 196 sctp_assoc_t sinfo_assoc_id; 197 }; 198 199 /* 5.3.4 SCTP Send Information Structure (SCTP_SNDINFO) 200 * 201 * This cmsghdr structure specifies SCTP options for sendmsg(). 202 * 203 * cmsg_level cmsg_type cmsg_data[] 204 * ------------ ------------ ------------------- 205 * IPPROTO_SCTP SCTP_SNDINFO struct sctp_sndinfo 206 */ 207 struct sctp_sndinfo { 208 __u16 snd_sid; 209 __u16 snd_flags; 210 __u32 snd_ppid; 211 __u32 snd_context; 212 sctp_assoc_t snd_assoc_id; 213 }; 214 215 /* 5.3.5 SCTP Receive Information Structure (SCTP_RCVINFO) 216 * 217 * This cmsghdr structure describes SCTP receive information 218 * about a received message through recvmsg(). 219 * 220 * cmsg_level cmsg_type cmsg_data[] 221 * ------------ ------------ ------------------- 222 * IPPROTO_SCTP SCTP_RCVINFO struct sctp_rcvinfo 223 */ 224 struct sctp_rcvinfo { 225 __u16 rcv_sid; 226 __u16 rcv_ssn; 227 __u16 rcv_flags; 228 __u32 rcv_ppid; 229 __u32 rcv_tsn; 230 __u32 rcv_cumtsn; 231 __u32 rcv_context; 232 sctp_assoc_t rcv_assoc_id; 233 }; 234 235 /* 5.3.6 SCTP Next Receive Information Structure (SCTP_NXTINFO) 236 * 237 * This cmsghdr structure describes SCTP receive information 238 * of the next message that will be delivered through recvmsg() 239 * if this information is already available when delivering 240 * the current message. 241 * 242 * cmsg_level cmsg_type cmsg_data[] 243 * ------------ ------------ ------------------- 244 * IPPROTO_SCTP SCTP_NXTINFO struct sctp_nxtinfo 245 */ 246 struct sctp_nxtinfo { 247 __u16 nxt_sid; 248 __u16 nxt_flags; 249 __u32 nxt_ppid; 250 __u32 nxt_length; 251 sctp_assoc_t nxt_assoc_id; 252 }; 253 254 /* 255 * sinfo_flags: 16 bits (unsigned integer) 256 * 257 * This field may contain any of the following flags and is composed of 258 * a bitwise OR of these values. 259 */ 260 enum sctp_sinfo_flags { 261 SCTP_UNORDERED = (1 << 0), /* Send/receive message unordered. */ 262 SCTP_ADDR_OVER = (1 << 1), /* Override the primary destination. */ 263 SCTP_ABORT = (1 << 2), /* Send an ABORT message to the peer. */ 264 SCTP_SACK_IMMEDIATELY = (1 << 3), /* SACK should be sent without delay. */ 265 SCTP_NOTIFICATION = MSG_NOTIFICATION, /* Next message is not user msg but notification. */ 266 SCTP_EOF = MSG_FIN, /* Initiate graceful shutdown process. */ 267 }; 268 269 typedef union { 270 __u8 raw; 271 struct sctp_initmsg init; 272 struct sctp_sndrcvinfo sndrcv; 273 } sctp_cmsg_data_t; 274 275 /* These are cmsg_types. */ 276 typedef enum sctp_cmsg_type { 277 SCTP_INIT, /* 5.2.1 SCTP Initiation Structure */ 278 #define SCTP_INIT SCTP_INIT 279 SCTP_SNDRCV, /* 5.2.2 SCTP Header Information Structure */ 280 #define SCTP_SNDRCV SCTP_SNDRCV 281 SCTP_SNDINFO, /* 5.3.4 SCTP Send Information Structure */ 282 #define SCTP_SNDINFO SCTP_SNDINFO 283 SCTP_RCVINFO, /* 5.3.5 SCTP Receive Information Structure */ 284 #define SCTP_RCVINFO SCTP_RCVINFO 285 SCTP_NXTINFO, /* 5.3.6 SCTP Next Receive Information Structure */ 286 #define SCTP_NXTINFO SCTP_NXTINFO 287 } sctp_cmsg_t; 288 289 /* 290 * 5.3.1.1 SCTP_ASSOC_CHANGE 291 * 292 * Communication notifications inform the ULP that an SCTP association 293 * has either begun or ended. The identifier for a new association is 294 * provided by this notificaion. The notification information has the 295 * following format: 296 * 297 */ 298 struct sctp_assoc_change { 299 __u16 sac_type; 300 __u16 sac_flags; 301 __u32 sac_length; 302 __u16 sac_state; 303 __u16 sac_error; 304 __u16 sac_outbound_streams; 305 __u16 sac_inbound_streams; 306 sctp_assoc_t sac_assoc_id; 307 __u8 sac_info[0]; 308 }; 309 310 /* 311 * sac_state: 32 bits (signed integer) 312 * 313 * This field holds one of a number of values that communicate the 314 * event that happened to the association. They include: 315 * 316 * Note: The following state names deviate from the API draft as 317 * the names clash too easily with other kernel symbols. 318 */ 319 enum sctp_sac_state { 320 SCTP_COMM_UP, 321 SCTP_COMM_LOST, 322 SCTP_RESTART, 323 SCTP_SHUTDOWN_COMP, 324 SCTP_CANT_STR_ASSOC, 325 }; 326 327 /* 328 * 5.3.1.2 SCTP_PEER_ADDR_CHANGE 329 * 330 * When a destination address on a multi-homed peer encounters a change 331 * an interface details event is sent. The information has the 332 * following structure: 333 */ 334 struct sctp_paddr_change { 335 __u16 spc_type; 336 __u16 spc_flags; 337 __u32 spc_length; 338 struct sockaddr_storage spc_aaddr; 339 int spc_state; 340 int spc_error; 341 sctp_assoc_t spc_assoc_id; 342 } __attribute__((packed, aligned(4))); 343 344 /* 345 * spc_state: 32 bits (signed integer) 346 * 347 * This field holds one of a number of values that communicate the 348 * event that happened to the address. They include: 349 */ 350 enum sctp_spc_state { 351 SCTP_ADDR_AVAILABLE, 352 SCTP_ADDR_UNREACHABLE, 353 SCTP_ADDR_REMOVED, 354 SCTP_ADDR_ADDED, 355 SCTP_ADDR_MADE_PRIM, 356 SCTP_ADDR_CONFIRMED, 357 }; 358 359 360 /* 361 * 5.3.1.3 SCTP_REMOTE_ERROR 362 * 363 * A remote peer may send an Operational Error message to its peer. 364 * This message indicates a variety of error conditions on an 365 * association. The entire error TLV as it appears on the wire is 366 * included in a SCTP_REMOTE_ERROR event. Please refer to the SCTP 367 * specification [SCTP] and any extensions for a list of possible 368 * error formats. SCTP error TLVs have the format: 369 */ 370 struct sctp_remote_error { 371 __u16 sre_type; 372 __u16 sre_flags; 373 __u32 sre_length; 374 __u16 sre_error; 375 sctp_assoc_t sre_assoc_id; 376 __u8 sre_data[0]; 377 }; 378 379 380 /* 381 * 5.3.1.4 SCTP_SEND_FAILED 382 * 383 * If SCTP cannot deliver a message it may return the message as a 384 * notification. 385 */ 386 struct sctp_send_failed { 387 __u16 ssf_type; 388 __u16 ssf_flags; 389 __u32 ssf_length; 390 __u32 ssf_error; 391 struct sctp_sndrcvinfo ssf_info; 392 sctp_assoc_t ssf_assoc_id; 393 __u8 ssf_data[0]; 394 }; 395 396 /* 397 * ssf_flags: 16 bits (unsigned integer) 398 * 399 * The flag value will take one of the following values 400 * 401 * SCTP_DATA_UNSENT - Indicates that the data was never put on 402 * the wire. 403 * 404 * SCTP_DATA_SENT - Indicates that the data was put on the wire. 405 * Note that this does not necessarily mean that the 406 * data was (or was not) successfully delivered. 407 */ 408 enum sctp_ssf_flags { 409 SCTP_DATA_UNSENT, 410 SCTP_DATA_SENT, 411 }; 412 413 /* 414 * 5.3.1.5 SCTP_SHUTDOWN_EVENT 415 * 416 * When a peer sends a SHUTDOWN, SCTP delivers this notification to 417 * inform the application that it should cease sending data. 418 */ 419 struct sctp_shutdown_event { 420 __u16 sse_type; 421 __u16 sse_flags; 422 __u32 sse_length; 423 sctp_assoc_t sse_assoc_id; 424 }; 425 426 /* 427 * 5.3.1.6 SCTP_ADAPTATION_INDICATION 428 * 429 * When a peer sends a Adaptation Layer Indication parameter , SCTP 430 * delivers this notification to inform the application 431 * that of the peers requested adaptation layer. 432 */ 433 struct sctp_adaptation_event { 434 __u16 sai_type; 435 __u16 sai_flags; 436 __u32 sai_length; 437 __u32 sai_adaptation_ind; 438 sctp_assoc_t sai_assoc_id; 439 }; 440 441 /* 442 * 5.3.1.7 SCTP_PARTIAL_DELIVERY_EVENT 443 * 444 * When a receiver is engaged in a partial delivery of a 445 * message this notification will be used to indicate 446 * various events. 447 */ 448 struct sctp_pdapi_event { 449 __u16 pdapi_type; 450 __u16 pdapi_flags; 451 __u32 pdapi_length; 452 __u32 pdapi_indication; 453 sctp_assoc_t pdapi_assoc_id; 454 }; 455 456 enum { SCTP_PARTIAL_DELIVERY_ABORTED=0, }; 457 458 /* 459 * 5.3.1.8. SCTP_AUTHENTICATION_EVENT 460 * 461 * When a receiver is using authentication this message will provide 462 * notifications regarding new keys being made active as well as errors. 463 */ 464 struct sctp_authkey_event { 465 __u16 auth_type; 466 __u16 auth_flags; 467 __u32 auth_length; 468 __u16 auth_keynumber; 469 __u16 auth_altkeynumber; 470 __u32 auth_indication; 471 sctp_assoc_t auth_assoc_id; 472 }; 473 474 enum { SCTP_AUTH_NEWKEY = 0, }; 475 476 /* 477 * 6.1.9. SCTP_SENDER_DRY_EVENT 478 * 479 * When the SCTP stack has no more user data to send or retransmit, this 480 * notification is given to the user. Also, at the time when a user app 481 * subscribes to this event, if there is no data to be sent or 482 * retransmit, the stack will immediately send up this notification. 483 */ 484 struct sctp_sender_dry_event { 485 __u16 sender_dry_type; 486 __u16 sender_dry_flags; 487 __u32 sender_dry_length; 488 sctp_assoc_t sender_dry_assoc_id; 489 }; 490 491 /* 492 * Described in Section 7.3 493 * Ancillary Data and Notification Interest Options 494 */ 495 struct sctp_event_subscribe { 496 __u8 sctp_data_io_event; 497 __u8 sctp_association_event; 498 __u8 sctp_address_event; 499 __u8 sctp_send_failure_event; 500 __u8 sctp_peer_error_event; 501 __u8 sctp_shutdown_event; 502 __u8 sctp_partial_delivery_event; 503 __u8 sctp_adaptation_layer_event; 504 __u8 sctp_authentication_event; 505 __u8 sctp_sender_dry_event; 506 }; 507 508 /* 509 * 5.3.1 SCTP Notification Structure 510 * 511 * The notification structure is defined as the union of all 512 * notification types. 513 * 514 */ 515 union sctp_notification { 516 struct { 517 __u16 sn_type; /* Notification type. */ 518 __u16 sn_flags; 519 __u32 sn_length; 520 } sn_header; 521 struct sctp_assoc_change sn_assoc_change; 522 struct sctp_paddr_change sn_paddr_change; 523 struct sctp_remote_error sn_remote_error; 524 struct sctp_send_failed sn_send_failed; 525 struct sctp_shutdown_event sn_shutdown_event; 526 struct sctp_adaptation_event sn_adaptation_event; 527 struct sctp_pdapi_event sn_pdapi_event; 528 struct sctp_authkey_event sn_authkey_event; 529 struct sctp_sender_dry_event sn_sender_dry_event; 530 }; 531 532 /* Section 5.3.1 533 * All standard values for sn_type flags are greater than 2^15. 534 * Values from 2^15 and down are reserved. 535 */ 536 537 enum sctp_sn_type { 538 SCTP_SN_TYPE_BASE = (1<<15), 539 SCTP_ASSOC_CHANGE, 540 #define SCTP_ASSOC_CHANGE SCTP_ASSOC_CHANGE 541 SCTP_PEER_ADDR_CHANGE, 542 #define SCTP_PEER_ADDR_CHANGE SCTP_PEER_ADDR_CHANGE 543 SCTP_SEND_FAILED, 544 #define SCTP_SEND_FAILED SCTP_SEND_FAILED 545 SCTP_REMOTE_ERROR, 546 #define SCTP_REMOTE_ERROR SCTP_REMOTE_ERROR 547 SCTP_SHUTDOWN_EVENT, 548 #define SCTP_SHUTDOWN_EVENT SCTP_SHUTDOWN_EVENT 549 SCTP_PARTIAL_DELIVERY_EVENT, 550 #define SCTP_PARTIAL_DELIVERY_EVENT SCTP_PARTIAL_DELIVERY_EVENT 551 SCTP_ADAPTATION_INDICATION, 552 #define SCTP_ADAPTATION_INDICATION SCTP_ADAPTATION_INDICATION 553 SCTP_AUTHENTICATION_EVENT, 554 #define SCTP_AUTHENTICATION_INDICATION SCTP_AUTHENTICATION_EVENT 555 SCTP_SENDER_DRY_EVENT, 556 #define SCTP_SENDER_DRY_EVENT SCTP_SENDER_DRY_EVENT 557 }; 558 559 /* Notification error codes used to fill up the error fields in some 560 * notifications. 561 * SCTP_PEER_ADDRESS_CHAGE : spc_error 562 * SCTP_ASSOC_CHANGE : sac_error 563 * These names should be potentially included in the draft 04 of the SCTP 564 * sockets API specification. 565 */ 566 typedef enum sctp_sn_error { 567 SCTP_FAILED_THRESHOLD, 568 SCTP_RECEIVED_SACK, 569 SCTP_HEARTBEAT_SUCCESS, 570 SCTP_RESPONSE_TO_USER_REQ, 571 SCTP_INTERNAL_ERROR, 572 SCTP_SHUTDOWN_GUARD_EXPIRES, 573 SCTP_PEER_FAULTY, 574 } sctp_sn_error_t; 575 576 /* 577 * 7.1.1 Retransmission Timeout Parameters (SCTP_RTOINFO) 578 * 579 * The protocol parameters used to initialize and bound retransmission 580 * timeout (RTO) are tunable. See [SCTP] for more information on how 581 * these parameters are used in RTO calculation. 582 */ 583 struct sctp_rtoinfo { 584 sctp_assoc_t srto_assoc_id; 585 __u32 srto_initial; 586 __u32 srto_max; 587 __u32 srto_min; 588 }; 589 590 /* 591 * 7.1.2 Association Parameters (SCTP_ASSOCINFO) 592 * 593 * This option is used to both examine and set various association and 594 * endpoint parameters. 595 */ 596 struct sctp_assocparams { 597 sctp_assoc_t sasoc_assoc_id; 598 __u16 sasoc_asocmaxrxt; 599 __u16 sasoc_number_peer_destinations; 600 __u32 sasoc_peer_rwnd; 601 __u32 sasoc_local_rwnd; 602 __u32 sasoc_cookie_life; 603 }; 604 605 /* 606 * 7.1.9 Set Peer Primary Address (SCTP_SET_PEER_PRIMARY_ADDR) 607 * 608 * Requests that the peer mark the enclosed address as the association 609 * primary. The enclosed address must be one of the association's 610 * locally bound addresses. The following structure is used to make a 611 * set primary request: 612 */ 613 struct sctp_setpeerprim { 614 sctp_assoc_t sspp_assoc_id; 615 struct sockaddr_storage sspp_addr; 616 } __attribute__((packed, aligned(4))); 617 618 /* 619 * 7.1.10 Set Primary Address (SCTP_PRIMARY_ADDR) 620 * 621 * Requests that the local SCTP stack use the enclosed peer address as 622 * the association primary. The enclosed address must be one of the 623 * association peer's addresses. The following structure is used to 624 * make a set peer primary request: 625 */ 626 struct sctp_prim { 627 sctp_assoc_t ssp_assoc_id; 628 struct sockaddr_storage ssp_addr; 629 } __attribute__((packed, aligned(4))); 630 631 /* For backward compatibility use, define the old name too */ 632 #define sctp_setprim sctp_prim 633 634 /* 635 * 7.1.11 Set Adaptation Layer Indicator (SCTP_ADAPTATION_LAYER) 636 * 637 * Requests that the local endpoint set the specified Adaptation Layer 638 * Indication parameter for all future INIT and INIT-ACK exchanges. 639 */ 640 struct sctp_setadaptation { 641 __u32 ssb_adaptation_ind; 642 }; 643 644 /* 645 * 7.1.13 Peer Address Parameters (SCTP_PEER_ADDR_PARAMS) 646 * 647 * Applications can enable or disable heartbeats for any peer address 648 * of an association, modify an address's heartbeat interval, force a 649 * heartbeat to be sent immediately, and adjust the address's maximum 650 * number of retransmissions sent before an address is considered 651 * unreachable. The following structure is used to access and modify an 652 * address's parameters: 653 */ 654 enum sctp_spp_flags { 655 SPP_HB_ENABLE = 1<<0, /*Enable heartbeats*/ 656 SPP_HB_DISABLE = 1<<1, /*Disable heartbeats*/ 657 SPP_HB = SPP_HB_ENABLE | SPP_HB_DISABLE, 658 SPP_HB_DEMAND = 1<<2, /*Send heartbeat immediately*/ 659 SPP_PMTUD_ENABLE = 1<<3, /*Enable PMTU discovery*/ 660 SPP_PMTUD_DISABLE = 1<<4, /*Disable PMTU discovery*/ 661 SPP_PMTUD = SPP_PMTUD_ENABLE | SPP_PMTUD_DISABLE, 662 SPP_SACKDELAY_ENABLE = 1<<5, /*Enable SACK*/ 663 SPP_SACKDELAY_DISABLE = 1<<6, /*Disable SACK*/ 664 SPP_SACKDELAY = SPP_SACKDELAY_ENABLE | SPP_SACKDELAY_DISABLE, 665 SPP_HB_TIME_IS_ZERO = 1<<7, /* Set HB delay to 0 */ 666 }; 667 668 struct sctp_paddrparams { 669 sctp_assoc_t spp_assoc_id; 670 struct sockaddr_storage spp_address; 671 __u32 spp_hbinterval; 672 __u16 spp_pathmaxrxt; 673 __u32 spp_pathmtu; 674 __u32 spp_sackdelay; 675 __u32 spp_flags; 676 } __attribute__((packed, aligned(4))); 677 678 /* 679 * 7.1.18. Add a chunk that must be authenticated (SCTP_AUTH_CHUNK) 680 * 681 * This set option adds a chunk type that the user is requesting to be 682 * received only in an authenticated way. Changes to the list of chunks 683 * will only effect future associations on the socket. 684 */ 685 struct sctp_authchunk { 686 __u8 sauth_chunk; 687 }; 688 689 /* 690 * 7.1.19. Get or set the list of supported HMAC Identifiers (SCTP_HMAC_IDENT) 691 * 692 * This option gets or sets the list of HMAC algorithms that the local 693 * endpoint requires the peer to use. 694 */ 695 #ifndef __KERNEL__ 696 /* This here is only used by user space as is. It might not be a good idea 697 * to export/reveal the whole structure with reserved fields etc. 698 */ 699 enum { 700 SCTP_AUTH_HMAC_ID_SHA1 = 1, 701 SCTP_AUTH_HMAC_ID_SHA256 = 3, 702 }; 703 #endif 704 705 struct sctp_hmacalgo { 706 __u32 shmac_num_idents; 707 __u16 shmac_idents[]; 708 }; 709 710 /* Sadly, user and kernel space have different names for 711 * this structure member, so this is to not break anything. 712 */ 713 #define shmac_number_of_idents shmac_num_idents 714 715 /* 716 * 7.1.20. Set a shared key (SCTP_AUTH_KEY) 717 * 718 * This option will set a shared secret key which is used to build an 719 * association shared key. 720 */ 721 struct sctp_authkey { 722 sctp_assoc_t sca_assoc_id; 723 __u16 sca_keynumber; 724 __u16 sca_keylength; 725 __u8 sca_key[]; 726 }; 727 728 /* 729 * 7.1.21. Get or set the active shared key (SCTP_AUTH_ACTIVE_KEY) 730 * 731 * This option will get or set the active shared key to be used to build 732 * the association shared key. 733 */ 734 735 struct sctp_authkeyid { 736 sctp_assoc_t scact_assoc_id; 737 __u16 scact_keynumber; 738 }; 739 740 741 /* 742 * 7.1.23. Get or set delayed ack timer (SCTP_DELAYED_SACK) 743 * 744 * This option will effect the way delayed acks are performed. This 745 * option allows you to get or set the delayed ack time, in 746 * milliseconds. It also allows changing the delayed ack frequency. 747 * Changing the frequency to 1 disables the delayed sack algorithm. If 748 * the assoc_id is 0, then this sets or gets the endpoints default 749 * values. If the assoc_id field is non-zero, then the set or get 750 * effects the specified association for the one to many model (the 751 * assoc_id field is ignored by the one to one model). Note that if 752 * sack_delay or sack_freq are 0 when setting this option, then the 753 * current values will remain unchanged. 754 */ 755 struct sctp_sack_info { 756 sctp_assoc_t sack_assoc_id; 757 uint32_t sack_delay; 758 uint32_t sack_freq; 759 }; 760 761 struct sctp_assoc_value { 762 sctp_assoc_t assoc_id; 763 uint32_t assoc_value; 764 }; 765 766 /* 767 * 7.2.2 Peer Address Information 768 * 769 * Applications can retrieve information about a specific peer address 770 * of an association, including its reachability state, congestion 771 * window, and retransmission timer values. This information is 772 * read-only. The following structure is used to access this 773 * information: 774 */ 775 struct sctp_paddrinfo { 776 sctp_assoc_t spinfo_assoc_id; 777 struct sockaddr_storage spinfo_address; 778 __s32 spinfo_state; 779 __u32 spinfo_cwnd; 780 __u32 spinfo_srtt; 781 __u32 spinfo_rto; 782 __u32 spinfo_mtu; 783 } __attribute__((packed, aligned(4))); 784 785 /* Peer addresses's state. */ 786 /* UNKNOWN: Peer address passed by the upper layer in sendmsg or connect[x] 787 * calls. 788 * UNCONFIRMED: Peer address received in INIT/INIT-ACK address parameters. 789 * Not yet confirmed by a heartbeat and not available for data 790 * transfers. 791 * ACTIVE : Peer address confirmed, active and available for data transfers. 792 * INACTIVE: Peer address inactive and not available for data transfers. 793 */ 794 enum sctp_spinfo_state { 795 SCTP_INACTIVE, 796 SCTP_PF, 797 SCTP_ACTIVE, 798 SCTP_UNCONFIRMED, 799 SCTP_UNKNOWN = 0xffff /* Value used for transport state unknown */ 800 }; 801 802 /* 803 * 7.2.1 Association Status (SCTP_STATUS) 804 * 805 * Applications can retrieve current status information about an 806 * association, including association state, peer receiver window size, 807 * number of unacked data chunks, and number of data chunks pending 808 * receipt. This information is read-only. The following structure is 809 * used to access this information: 810 */ 811 struct sctp_status { 812 sctp_assoc_t sstat_assoc_id; 813 __s32 sstat_state; 814 __u32 sstat_rwnd; 815 __u16 sstat_unackdata; 816 __u16 sstat_penddata; 817 __u16 sstat_instrms; 818 __u16 sstat_outstrms; 819 __u32 sstat_fragmentation_point; 820 struct sctp_paddrinfo sstat_primary; 821 }; 822 823 /* 824 * 7.2.3. Get the list of chunks the peer requires to be authenticated 825 * (SCTP_PEER_AUTH_CHUNKS) 826 * 827 * This option gets a list of chunks for a specified association that 828 * the peer requires to be received authenticated only. 829 */ 830 struct sctp_authchunks { 831 sctp_assoc_t gauth_assoc_id; 832 __u32 gauth_number_of_chunks; 833 uint8_t gauth_chunks[]; 834 }; 835 836 /* The broken spelling has been released already in lksctp-tools header, 837 * so don't break anyone, now that it's fixed. 838 */ 839 #define guth_number_of_chunks gauth_number_of_chunks 840 841 /* Association states. */ 842 enum sctp_sstat_state { 843 SCTP_EMPTY = 0, 844 SCTP_CLOSED = 1, 845 SCTP_COOKIE_WAIT = 2, 846 SCTP_COOKIE_ECHOED = 3, 847 SCTP_ESTABLISHED = 4, 848 SCTP_SHUTDOWN_PENDING = 5, 849 SCTP_SHUTDOWN_SENT = 6, 850 SCTP_SHUTDOWN_RECEIVED = 7, 851 SCTP_SHUTDOWN_ACK_SENT = 8, 852 }; 853 854 /* 855 * 8.2.6. Get the Current Identifiers of Associations 856 * (SCTP_GET_ASSOC_ID_LIST) 857 * 858 * This option gets the current list of SCTP association identifiers of 859 * the SCTP associations handled by a one-to-many style socket. 860 */ 861 struct sctp_assoc_ids { 862 __u32 gaids_number_of_ids; 863 sctp_assoc_t gaids_assoc_id[]; 864 }; 865 866 /* 867 * 8.3, 8.5 get all peer/local addresses in an association. 868 * This parameter struct is used by SCTP_GET_PEER_ADDRS and 869 * SCTP_GET_LOCAL_ADDRS socket options used internally to implement 870 * sctp_getpaddrs() and sctp_getladdrs() API. 871 */ 872 struct sctp_getaddrs_old { 873 sctp_assoc_t assoc_id; 874 int addr_num; 875 #ifdef __KERNEL__ 876 struct sockaddr __user *addrs; 877 #else 878 struct sockaddr *addrs; 879 #endif 880 }; 881 882 struct sctp_getaddrs { 883 sctp_assoc_t assoc_id; /*input*/ 884 __u32 addr_num; /*output*/ 885 __u8 addrs[0]; /*output, variable size*/ 886 }; 887 888 /* A socket user request obtained via SCTP_GET_ASSOC_STATS that retrieves 889 * association stats. All stats are counts except sas_maxrto and 890 * sas_obs_rto_ipaddr. maxrto is the max observed rto + transport since 891 * the last call. Will return 0 when RTO was not update since last call 892 */ 893 struct sctp_assoc_stats { 894 sctp_assoc_t sas_assoc_id; /* Input */ 895 /* Transport of observed max RTO */ 896 struct sockaddr_storage sas_obs_rto_ipaddr; 897 __u64 sas_maxrto; /* Maximum Observed RTO for period */ 898 __u64 sas_isacks; /* SACKs received */ 899 __u64 sas_osacks; /* SACKs sent */ 900 __u64 sas_opackets; /* Packets sent */ 901 __u64 sas_ipackets; /* Packets received */ 902 __u64 sas_rtxchunks; /* Retransmitted Chunks */ 903 __u64 sas_outofseqtsns;/* TSN received > next expected */ 904 __u64 sas_idupchunks; /* Dups received (ordered+unordered) */ 905 __u64 sas_gapcnt; /* Gap Acknowledgements Received */ 906 __u64 sas_ouodchunks; /* Unordered data chunks sent */ 907 __u64 sas_iuodchunks; /* Unordered data chunks received */ 908 __u64 sas_oodchunks; /* Ordered data chunks sent */ 909 __u64 sas_iodchunks; /* Ordered data chunks received */ 910 __u64 sas_octrlchunks; /* Control chunks sent */ 911 __u64 sas_ictrlchunks; /* Control chunks received */ 912 }; 913 914 /* 915 * 8.1 sctp_bindx() 916 * 917 * The flags parameter is formed from the bitwise OR of zero or more of the 918 * following currently defined flags: 919 */ 920 #define SCTP_BINDX_ADD_ADDR 0x01 921 #define SCTP_BINDX_REM_ADDR 0x02 922 923 /* This is the structure that is passed as an argument(optval) to 924 * getsockopt(SCTP_SOCKOPT_PEELOFF). 925 */ 926 typedef struct { 927 sctp_assoc_t associd; 928 int sd; 929 } sctp_peeloff_arg_t; 930 931 /* 932 * Peer Address Thresholds socket option 933 */ 934 struct sctp_paddrthlds { 935 sctp_assoc_t spt_assoc_id; 936 struct sockaddr_storage spt_address; 937 __u16 spt_pathmaxrxt; 938 __u16 spt_pathpfthld; 939 }; 940 941 /* 942 * Socket Option for Getting the Association/Stream-Specific PR-SCTP Status 943 */ 944 struct sctp_prstatus { 945 sctp_assoc_t sprstat_assoc_id; 946 __u16 sprstat_sid; 947 __u16 sprstat_policy; 948 __u64 sprstat_abandoned_unsent; 949 __u64 sprstat_abandoned_sent; 950 }; 951 952 struct sctp_default_prinfo { 953 sctp_assoc_t pr_assoc_id; 954 __u32 pr_value; 955 __u16 pr_policy; 956 }; 957 958 struct sctp_info { 959 __u32 sctpi_tag; 960 __u32 sctpi_state; 961 __u32 sctpi_rwnd; 962 __u16 sctpi_unackdata; 963 __u16 sctpi_penddata; 964 __u16 sctpi_instrms; 965 __u16 sctpi_outstrms; 966 __u32 sctpi_fragmentation_point; 967 __u32 sctpi_inqueue; 968 __u32 sctpi_outqueue; 969 __u32 sctpi_overall_error; 970 __u32 sctpi_max_burst; 971 __u32 sctpi_maxseg; 972 __u32 sctpi_peer_rwnd; 973 __u32 sctpi_peer_tag; 974 __u8 sctpi_peer_capable; 975 __u8 sctpi_peer_sack; 976 __u16 __reserved1; 977 978 /* assoc status info */ 979 __u64 sctpi_isacks; 980 __u64 sctpi_osacks; 981 __u64 sctpi_opackets; 982 __u64 sctpi_ipackets; 983 __u64 sctpi_rtxchunks; 984 __u64 sctpi_outofseqtsns; 985 __u64 sctpi_idupchunks; 986 __u64 sctpi_gapcnt; 987 __u64 sctpi_ouodchunks; 988 __u64 sctpi_iuodchunks; 989 __u64 sctpi_oodchunks; 990 __u64 sctpi_iodchunks; 991 __u64 sctpi_octrlchunks; 992 __u64 sctpi_ictrlchunks; 993 994 /* primary transport info */ 995 struct sockaddr_storage sctpi_p_address; 996 __s32 sctpi_p_state; 997 __u32 sctpi_p_cwnd; 998 __u32 sctpi_p_srtt; 999 __u32 sctpi_p_rto; 1000 __u32 sctpi_p_hbinterval; 1001 __u32 sctpi_p_pathmaxrxt; 1002 __u32 sctpi_p_sackdelay; 1003 __u32 sctpi_p_sackfreq; 1004 __u32 sctpi_p_ssthresh; 1005 __u32 sctpi_p_partial_bytes_acked; 1006 __u32 sctpi_p_flight_size; 1007 __u16 sctpi_p_error; 1008 __u16 __reserved2; 1009 1010 /* sctp sock info */ 1011 __u32 sctpi_s_autoclose; 1012 __u32 sctpi_s_adaptation_ind; 1013 __u32 sctpi_s_pd_point; 1014 __u8 sctpi_s_nodelay; 1015 __u8 sctpi_s_disable_fragments; 1016 __u8 sctpi_s_v4mapped; 1017 __u8 sctpi_s_frag_interleave; 1018 __u32 sctpi_s_type; 1019 __u32 __reserved3; 1020 }; 1021 1022 struct sctp_reset_streams { 1023 sctp_assoc_t srs_assoc_id; 1024 uint16_t srs_flags; 1025 uint16_t srs_number_streams; /* 0 == ALL */ 1026 uint16_t srs_stream_list[]; /* list if srs_num_streams is not 0 */ 1027 }; 1028 1029 #endif /* _UAPI_SCTP_H */ 1030