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