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