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