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