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