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