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