diff options
Diffstat (limited to 'include/uapi/linux/sctp.h')
| -rw-r--r-- | include/uapi/linux/sctp.h | 846 |
1 files changed, 846 insertions, 0 deletions
diff --git a/include/uapi/linux/sctp.h b/include/uapi/linux/sctp.h new file mode 100644 index 000000000000..66b466e4ca08 --- /dev/null +++ b/include/uapi/linux/sctp.h | |||
| @@ -0,0 +1,846 @@ | |||
| 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, write to | ||
| 26 | * the Free Software Foundation, 59 Temple Place - Suite 330, | ||
| 27 | * Boston, MA 02111-1307, USA. | ||
| 28 | * | ||
| 29 | * Please send any bug reports or fixes you make to the | ||
| 30 | * email address(es): | ||
| 31 | * lksctp developers <lksctp-developers@lists.sourceforge.net> | ||
| 32 | * | ||
| 33 | * Or submit a bug report through the following website: | ||
| 34 | * http://www.sf.net/projects/lksctp | ||
| 35 | * | ||
| 36 | * Written or modified by: | ||
| 37 | * La Monte H.P. Yarroll <piggy@acm.org> | ||
| 38 | * R. Stewart <randall@sctp.chicago.il.us> | ||
| 39 | * K. Morneau <kmorneau@cisco.com> | ||
| 40 | * Q. Xie <qxie1@email.mot.com> | ||
| 41 | * Karl Knutson <karl@athena.chicago.il.us> | ||
| 42 | * Jon Grimm <jgrimm@us.ibm.com> | ||
| 43 | * Daisy Chang <daisyc@us.ibm.com> | ||
| 44 | * Ryan Layer <rmlayer@us.ibm.com> | ||
| 45 | * Ardelle Fan <ardelle.fan@intel.com> | ||
| 46 | * Sridhar Samudrala <sri@us.ibm.com> | ||
| 47 | * Inaky Perez-Gonzalez <inaky.gonzalez@intel.com> | ||
| 48 | * Vlad Yasevich <vladislav.yasevich@hp.com> | ||
| 49 | * | ||
| 50 | * Any bugs reported given to us we will try to fix... any fixes shared will | ||
| 51 | * be incorporated into the next SCTP release. | ||
| 52 | */ | ||
| 53 | |||
| 54 | #ifndef _UAPI_SCTP_H | ||
| 55 | #define _UAPI_SCTP_H | ||
| 56 | |||
| 57 | #include <linux/types.h> | ||
| 58 | #include <linux/socket.h> | ||
| 59 | |||
| 60 | typedef __s32 sctp_assoc_t; | ||
| 61 | |||
| 62 | /* The following symbols come from the Sockets API Extensions for | ||
| 63 | * SCTP <draft-ietf-tsvwg-sctpsocket-07.txt>. | ||
| 64 | */ | ||
| 65 | #define SCTP_RTOINFO 0 | ||
| 66 | #define SCTP_ASSOCINFO 1 | ||
| 67 | #define SCTP_INITMSG 2 | ||
| 68 | #define SCTP_NODELAY 3 /* Get/set nodelay option. */ | ||
| 69 | #define SCTP_AUTOCLOSE 4 | ||
| 70 | #define SCTP_SET_PEER_PRIMARY_ADDR 5 | ||
| 71 | #define SCTP_PRIMARY_ADDR 6 | ||
| 72 | #define SCTP_ADAPTATION_LAYER 7 | ||
| 73 | #define SCTP_DISABLE_FRAGMENTS 8 | ||
| 74 | #define SCTP_PEER_ADDR_PARAMS 9 | ||
| 75 | #define SCTP_DEFAULT_SEND_PARAM 10 | ||
| 76 | #define SCTP_EVENTS 11 | ||
| 77 | #define SCTP_I_WANT_MAPPED_V4_ADDR 12 /* Turn on/off mapped v4 addresses */ | ||
| 78 | #define SCTP_MAXSEG 13 /* Get/set maximum fragment. */ | ||
| 79 | #define SCTP_STATUS 14 | ||
| 80 | #define SCTP_GET_PEER_ADDR_INFO 15 | ||
| 81 | #define SCTP_DELAYED_ACK_TIME 16 | ||
| 82 | #define SCTP_DELAYED_ACK SCTP_DELAYED_ACK_TIME | ||
| 83 | #define SCTP_DELAYED_SACK SCTP_DELAYED_ACK_TIME | ||
| 84 | #define SCTP_CONTEXT 17 | ||
| 85 | #define SCTP_FRAGMENT_INTERLEAVE 18 | ||
| 86 | #define SCTP_PARTIAL_DELIVERY_POINT 19 /* Set/Get partial delivery point */ | ||
| 87 | #define SCTP_MAX_BURST 20 /* Set/Get max burst */ | ||
| 88 | #define SCTP_AUTH_CHUNK 21 /* Set only: add a chunk type to authenticate */ | ||
| 89 | #define SCTP_HMAC_IDENT 22 | ||
| 90 | #define SCTP_AUTH_KEY 23 | ||
| 91 | #define SCTP_AUTH_ACTIVE_KEY 24 | ||
| 92 | #define SCTP_AUTH_DELETE_KEY 25 | ||
| 93 | #define SCTP_PEER_AUTH_CHUNKS 26 /* Read only */ | ||
| 94 | #define SCTP_LOCAL_AUTH_CHUNKS 27 /* Read only */ | ||
| 95 | #define SCTP_GET_ASSOC_NUMBER 28 /* Read only */ | ||
| 96 | #define SCTP_GET_ASSOC_ID_LIST 29 /* Read only */ | ||
| 97 | #define SCTP_AUTO_ASCONF 30 | ||
| 98 | #define SCTP_PEER_ADDR_THLDS 31 | ||
| 99 | |||
| 100 | /* Internal Socket Options. Some of the sctp library functions are | ||
| 101 | * implemented using these socket options. | ||
| 102 | */ | ||
| 103 | #define SCTP_SOCKOPT_BINDX_ADD 100 /* BINDX requests for adding addrs */ | ||
| 104 | #define SCTP_SOCKOPT_BINDX_REM 101 /* BINDX requests for removing addrs. */ | ||
| 105 | #define SCTP_SOCKOPT_PEELOFF 102 /* peel off association. */ | ||
| 106 | /* Options 104-106 are deprecated and removed. Do not use this space */ | ||
| 107 | #define SCTP_SOCKOPT_CONNECTX_OLD 107 /* CONNECTX old requests. */ | ||
| 108 | #define SCTP_GET_PEER_ADDRS 108 /* Get all peer address. */ | ||
| 109 | #define SCTP_GET_LOCAL_ADDRS 109 /* Get all local address. */ | ||
| 110 | #define SCTP_SOCKOPT_CONNECTX 110 /* CONNECTX requests. */ | ||
| 111 | #define SCTP_SOCKOPT_CONNECTX3 111 /* CONNECTX requests (updated) */ | ||
| 112 | #define SCTP_GET_ASSOC_STATS 112 /* Read only */ | ||
| 113 | |||
| 114 | /* | ||
| 115 | * 5.2.1 SCTP Initiation Structure (SCTP_INIT) | ||
| 116 | * | ||
| 117 | * This cmsghdr structure provides information for initializing new | ||
| 118 | * SCTP associations with sendmsg(). The SCTP_INITMSG socket option | ||
| 119 | * uses this same data structure. This structure is not used for | ||
| 120 | * recvmsg(). | ||
| 121 | * | ||
| 122 | * cmsg_level cmsg_type cmsg_data[] | ||
| 123 | * ------------ ------------ ---------------------- | ||
| 124 | * IPPROTO_SCTP SCTP_INIT struct sctp_initmsg | ||
| 125 | * | ||
| 126 | */ | ||
| 127 | struct sctp_initmsg { | ||
| 128 | __u16 sinit_num_ostreams; | ||
| 129 | __u16 sinit_max_instreams; | ||
| 130 | __u16 sinit_max_attempts; | ||
| 131 | __u16 sinit_max_init_timeo; | ||
| 132 | }; | ||
| 133 | |||
| 134 | /* | ||
| 135 | * 5.2.2 SCTP Header Information Structure (SCTP_SNDRCV) | ||
| 136 | * | ||
| 137 | * This cmsghdr structure specifies SCTP options for sendmsg() and | ||
| 138 | * describes SCTP header information about a received message through | ||
| 139 | * recvmsg(). | ||
| 140 | * | ||
| 141 | * cmsg_level cmsg_type cmsg_data[] | ||
| 142 | * ------------ ------------ ---------------------- | ||
| 143 | * IPPROTO_SCTP SCTP_SNDRCV struct sctp_sndrcvinfo | ||
| 144 | * | ||
| 145 | */ | ||
| 146 | struct sctp_sndrcvinfo { | ||
| 147 | __u16 sinfo_stream; | ||
| 148 | __u16 sinfo_ssn; | ||
| 149 | __u16 sinfo_flags; | ||
| 150 | __u32 sinfo_ppid; | ||
| 151 | __u32 sinfo_context; | ||
| 152 | __u32 sinfo_timetolive; | ||
| 153 | __u32 sinfo_tsn; | ||
| 154 | __u32 sinfo_cumtsn; | ||
| 155 | sctp_assoc_t sinfo_assoc_id; | ||
| 156 | }; | ||
| 157 | |||
| 158 | /* | ||
| 159 | * sinfo_flags: 16 bits (unsigned integer) | ||
| 160 | * | ||
| 161 | * This field may contain any of the following flags and is composed of | ||
| 162 | * a bitwise OR of these values. | ||
| 163 | */ | ||
| 164 | |||
| 165 | enum sctp_sinfo_flags { | ||
| 166 | SCTP_UNORDERED = 1, /* Send/receive message unordered. */ | ||
| 167 | SCTP_ADDR_OVER = 2, /* Override the primary destination. */ | ||
| 168 | SCTP_ABORT=4, /* Send an ABORT message to the peer. */ | ||
| 169 | SCTP_SACK_IMMEDIATELY = 8, /* SACK should be sent without delay */ | ||
| 170 | SCTP_EOF=MSG_FIN, /* Initiate graceful shutdown process. */ | ||
| 171 | }; | ||
| 172 | |||
| 173 | typedef union { | ||
| 174 | __u8 raw; | ||
| 175 | struct sctp_initmsg init; | ||
| 176 | struct sctp_sndrcvinfo sndrcv; | ||
| 177 | } sctp_cmsg_data_t; | ||
| 178 | |||
| 179 | /* These are cmsg_types. */ | ||
| 180 | typedef enum sctp_cmsg_type { | ||
| 181 | SCTP_INIT, /* 5.2.1 SCTP Initiation Structure */ | ||
| 182 | #define SCTP_INIT SCTP_INIT | ||
| 183 | SCTP_SNDRCV, /* 5.2.2 SCTP Header Information Structure */ | ||
| 184 | #define SCTP_SNDRCV SCTP_SNDRCV | ||
| 185 | } sctp_cmsg_t; | ||
| 186 | |||
| 187 | /* | ||
| 188 | * 5.3.1.1 SCTP_ASSOC_CHANGE | ||
| 189 | * | ||
| 190 | * Communication notifications inform the ULP that an SCTP association | ||
| 191 | * has either begun or ended. The identifier for a new association is | ||
| 192 | * provided by this notificaion. The notification information has the | ||
| 193 | * following format: | ||
| 194 | * | ||
| 195 | */ | ||
| 196 | struct sctp_assoc_change { | ||
| 197 | __u16 sac_type; | ||
| 198 | __u16 sac_flags; | ||
| 199 | __u32 sac_length; | ||
| 200 | __u16 sac_state; | ||
| 201 | __u16 sac_error; | ||
| 202 | __u16 sac_outbound_streams; | ||
| 203 | __u16 sac_inbound_streams; | ||
| 204 | sctp_assoc_t sac_assoc_id; | ||
| 205 | __u8 sac_info[0]; | ||
| 206 | }; | ||
| 207 | |||
| 208 | /* | ||
| 209 | * sac_state: 32 bits (signed integer) | ||
| 210 | * | ||
| 211 | * This field holds one of a number of values that communicate the | ||
| 212 | * event that happened to the association. They include: | ||
| 213 | * | ||
| 214 | * Note: The following state names deviate from the API draft as | ||
| 215 | * the names clash too easily with other kernel symbols. | ||
| 216 | */ | ||
| 217 | enum sctp_sac_state { | ||
| 218 | SCTP_COMM_UP, | ||
| 219 | SCTP_COMM_LOST, | ||
| 220 | SCTP_RESTART, | ||
| 221 | SCTP_SHUTDOWN_COMP, | ||
| 222 | SCTP_CANT_STR_ASSOC, | ||
| 223 | }; | ||
| 224 | |||
| 225 | /* | ||
| 226 | * 5.3.1.2 SCTP_PEER_ADDR_CHANGE | ||
| 227 | * | ||
| 228 | * When a destination address on a multi-homed peer encounters a change | ||
| 229 | * an interface details event is sent. The information has the | ||
| 230 | * following structure: | ||
| 231 | */ | ||
| 232 | struct sctp_paddr_change { | ||
| 233 | __u16 spc_type; | ||
| 234 | __u16 spc_flags; | ||
| 235 | __u32 spc_length; | ||
| 236 | struct sockaddr_storage spc_aaddr; | ||
| 237 | int spc_state; | ||
| 238 | int spc_error; | ||
| 239 | sctp_assoc_t spc_assoc_id; | ||
| 240 | } __attribute__((packed, aligned(4))); | ||
| 241 | |||
| 242 | /* | ||
| 243 | * spc_state: 32 bits (signed integer) | ||
| 244 | * | ||
| 245 | * This field holds one of a number of values that communicate the | ||
| 246 | * event that happened to the address. They include: | ||
| 247 | */ | ||
| 248 | enum sctp_spc_state { | ||
| 249 | SCTP_ADDR_AVAILABLE, | ||
| 250 | SCTP_ADDR_UNREACHABLE, | ||
| 251 | SCTP_ADDR_REMOVED, | ||
| 252 | SCTP_ADDR_ADDED, | ||
| 253 | SCTP_ADDR_MADE_PRIM, | ||
| 254 | SCTP_ADDR_CONFIRMED, | ||
| 255 | }; | ||
| 256 | |||
| 257 | |||
| 258 | /* | ||
| 259 | * 5.3.1.3 SCTP_REMOTE_ERROR | ||
| 260 | * | ||
| 261 | * A remote peer may send an Operational Error message to its peer. | ||
| 262 | * This message indicates a variety of error conditions on an | ||
| 263 | * association. The entire error TLV as it appears on the wire is | ||
| 264 | * included in a SCTP_REMOTE_ERROR event. Please refer to the SCTP | ||
| 265 | * specification [SCTP] and any extensions for a list of possible | ||
| 266 | * error formats. SCTP error TLVs have the format: | ||
| 267 | */ | ||
| 268 | struct sctp_remote_error { | ||
| 269 | __u16 sre_type; | ||
| 270 | __u16 sre_flags; | ||
| 271 | __u32 sre_length; | ||
| 272 | __u16 sre_error; | ||
| 273 | sctp_assoc_t sre_assoc_id; | ||
| 274 | __u8 sre_data[0]; | ||
| 275 | }; | ||
| 276 | |||
| 277 | |||
| 278 | /* | ||
| 279 | * 5.3.1.4 SCTP_SEND_FAILED | ||
| 280 | * | ||
| 281 | * If SCTP cannot deliver a message it may return the message as a | ||
| 282 | * notification. | ||
| 283 | */ | ||
| 284 | struct sctp_send_failed { | ||
| 285 | __u16 ssf_type; | ||
| 286 | __u16 ssf_flags; | ||
| 287 | __u32 ssf_length; | ||
| 288 | __u32 ssf_error; | ||
| 289 | struct sctp_sndrcvinfo ssf_info; | ||
| 290 | sctp_assoc_t ssf_assoc_id; | ||
| 291 | __u8 ssf_data[0]; | ||
| 292 | }; | ||
| 293 | |||
| 294 | /* | ||
| 295 | * ssf_flags: 16 bits (unsigned integer) | ||
| 296 | * | ||
| 297 | * The flag value will take one of the following values | ||
| 298 | * | ||
| 299 | * SCTP_DATA_UNSENT - Indicates that the data was never put on | ||
| 300 | * the wire. | ||
| 301 | * | ||
| 302 | * SCTP_DATA_SENT - Indicates that the data was put on the wire. | ||
| 303 | * Note that this does not necessarily mean that the | ||
| 304 | * data was (or was not) successfully delivered. | ||
| 305 | */ | ||
| 306 | enum sctp_ssf_flags { | ||
| 307 | SCTP_DATA_UNSENT, | ||
| 308 | SCTP_DATA_SENT, | ||
| 309 | }; | ||
| 310 | |||
| 311 | /* | ||
| 312 | * 5.3.1.5 SCTP_SHUTDOWN_EVENT | ||
| 313 | * | ||
| 314 | * When a peer sends a SHUTDOWN, SCTP delivers this notification to | ||
| 315 | * inform the application that it should cease sending data. | ||
| 316 | */ | ||
| 317 | struct sctp_shutdown_event { | ||
| 318 | __u16 sse_type; | ||
| 319 | __u16 sse_flags; | ||
| 320 | __u32 sse_length; | ||
| 321 | sctp_assoc_t sse_assoc_id; | ||
| 322 | }; | ||
| 323 | |||
| 324 | /* | ||
| 325 | * 5.3.1.6 SCTP_ADAPTATION_INDICATION | ||
| 326 | * | ||
| 327 | * When a peer sends a Adaptation Layer Indication parameter , SCTP | ||
| 328 | * delivers this notification to inform the application | ||
| 329 | * that of the peers requested adaptation layer. | ||
| 330 | */ | ||
| 331 | struct sctp_adaptation_event { | ||
| 332 | __u16 sai_type; | ||
| 333 | __u16 sai_flags; | ||
| 334 | __u32 sai_length; | ||
| 335 | __u32 sai_adaptation_ind; | ||
| 336 | sctp_assoc_t sai_assoc_id; | ||
| 337 | }; | ||
| 338 | |||
| 339 | /* | ||
| 340 | * 5.3.1.7 SCTP_PARTIAL_DELIVERY_EVENT | ||
| 341 | * | ||
| 342 | * When a receiver is engaged in a partial delivery of a | ||
| 343 | * message this notification will be used to indicate | ||
| 344 | * various events. | ||
| 345 | */ | ||
| 346 | struct sctp_pdapi_event { | ||
| 347 | __u16 pdapi_type; | ||
| 348 | __u16 pdapi_flags; | ||
| 349 | __u32 pdapi_length; | ||
| 350 | __u32 pdapi_indication; | ||
| 351 | sctp_assoc_t pdapi_assoc_id; | ||
| 352 | }; | ||
| 353 | |||
| 354 | enum { SCTP_PARTIAL_DELIVERY_ABORTED=0, }; | ||
| 355 | |||
| 356 | /* | ||
| 357 | * 5.3.1.8. SCTP_AUTHENTICATION_EVENT | ||
| 358 | * | ||
| 359 | * When a receiver is using authentication this message will provide | ||
| 360 | * notifications regarding new keys being made active as well as errors. | ||
| 361 | */ | ||
| 362 | struct sctp_authkey_event { | ||
| 363 | __u16 auth_type; | ||
| 364 | __u16 auth_flags; | ||
| 365 | __u32 auth_length; | ||
| 366 | __u16 auth_keynumber; | ||
| 367 | __u16 auth_altkeynumber; | ||
| 368 | __u32 auth_indication; | ||
| 369 | sctp_assoc_t auth_assoc_id; | ||
| 370 | }; | ||
| 371 | |||
| 372 | enum { SCTP_AUTH_NEWKEY = 0, }; | ||
| 373 | |||
| 374 | /* | ||
| 375 | * 6.1.9. SCTP_SENDER_DRY_EVENT | ||
| 376 | * | ||
| 377 | * When the SCTP stack has no more user data to send or retransmit, this | ||
| 378 | * notification is given to the user. Also, at the time when a user app | ||
| 379 | * subscribes to this event, if there is no data to be sent or | ||
| 380 | * retransmit, the stack will immediately send up this notification. | ||
| 381 | */ | ||
| 382 | struct sctp_sender_dry_event { | ||
| 383 | __u16 sender_dry_type; | ||
| 384 | __u16 sender_dry_flags; | ||
| 385 | __u32 sender_dry_length; | ||
| 386 | sctp_assoc_t sender_dry_assoc_id; | ||
| 387 | }; | ||
| 388 | |||
| 389 | /* | ||
| 390 | * Described in Section 7.3 | ||
| 391 | * Ancillary Data and Notification Interest Options | ||
| 392 | */ | ||
| 393 | struct sctp_event_subscribe { | ||
| 394 | __u8 sctp_data_io_event; | ||
| 395 | __u8 sctp_association_event; | ||
| 396 | __u8 sctp_address_event; | ||
| 397 | __u8 sctp_send_failure_event; | ||
| 398 | __u8 sctp_peer_error_event; | ||
| 399 | __u8 sctp_shutdown_event; | ||
| 400 | __u8 sctp_partial_delivery_event; | ||
| 401 | __u8 sctp_adaptation_layer_event; | ||
| 402 | __u8 sctp_authentication_event; | ||
| 403 | __u8 sctp_sender_dry_event; | ||
| 404 | }; | ||
| 405 | |||
| 406 | /* | ||
| 407 | * 5.3.1 SCTP Notification Structure | ||
| 408 | * | ||
| 409 | * The notification structure is defined as the union of all | ||
| 410 | * notification types. | ||
| 411 | * | ||
| 412 | */ | ||
| 413 | union sctp_notification { | ||
| 414 | struct { | ||
| 415 | __u16 sn_type; /* Notification type. */ | ||
| 416 | __u16 sn_flags; | ||
| 417 | __u32 sn_length; | ||
| 418 | } sn_header; | ||
| 419 | struct sctp_assoc_change sn_assoc_change; | ||
| 420 | struct sctp_paddr_change sn_paddr_change; | ||
| 421 | struct sctp_remote_error sn_remote_error; | ||
| 422 | struct sctp_send_failed sn_send_failed; | ||
| 423 | struct sctp_shutdown_event sn_shutdown_event; | ||
| 424 | struct sctp_adaptation_event sn_adaptation_event; | ||
| 425 | struct sctp_pdapi_event sn_pdapi_event; | ||
| 426 | struct sctp_authkey_event sn_authkey_event; | ||
| 427 | struct sctp_sender_dry_event sn_sender_dry_event; | ||
| 428 | }; | ||
| 429 | |||
| 430 | /* Section 5.3.1 | ||
| 431 | * All standard values for sn_type flags are greater than 2^15. | ||
| 432 | * Values from 2^15 and down are reserved. | ||
| 433 | */ | ||
| 434 | |||
| 435 | enum sctp_sn_type { | ||
| 436 | SCTP_SN_TYPE_BASE = (1<<15), | ||
| 437 | SCTP_ASSOC_CHANGE, | ||
| 438 | #define SCTP_ASSOC_CHANGE SCTP_ASSOC_CHANGE | ||
| 439 | SCTP_PEER_ADDR_CHANGE, | ||
| 440 | #define SCTP_PEER_ADDR_CHANGE SCTP_PEER_ADDR_CHANGE | ||
| 441 | SCTP_SEND_FAILED, | ||
| 442 | #define SCTP_SEND_FAILED SCTP_SEND_FAILED | ||
| 443 | SCTP_REMOTE_ERROR, | ||
| 444 | #define SCTP_REMOTE_ERROR SCTP_REMOTE_ERROR | ||
| 445 | SCTP_SHUTDOWN_EVENT, | ||
| 446 | #define SCTP_SHUTDOWN_EVENT SCTP_SHUTDOWN_EVENT | ||
| 447 | SCTP_PARTIAL_DELIVERY_EVENT, | ||
| 448 | #define SCTP_PARTIAL_DELIVERY_EVENT SCTP_PARTIAL_DELIVERY_EVENT | ||
| 449 | SCTP_ADAPTATION_INDICATION, | ||
| 450 | #define SCTP_ADAPTATION_INDICATION SCTP_ADAPTATION_INDICATION | ||
| 451 | SCTP_AUTHENTICATION_EVENT, | ||
| 452 | #define SCTP_AUTHENTICATION_INDICATION SCTP_AUTHENTICATION_EVENT | ||
| 453 | SCTP_SENDER_DRY_EVENT, | ||
| 454 | #define SCTP_SENDER_DRY_EVENT SCTP_SENDER_DRY_EVENT | ||
| 455 | }; | ||
| 456 | |||
| 457 | /* Notification error codes used to fill up the error fields in some | ||
| 458 | * notifications. | ||
| 459 | * SCTP_PEER_ADDRESS_CHAGE : spc_error | ||
| 460 | * SCTP_ASSOC_CHANGE : sac_error | ||
| 461 | * These names should be potentially included in the draft 04 of the SCTP | ||
| 462 | * sockets API specification. | ||
| 463 | */ | ||
| 464 | typedef enum sctp_sn_error { | ||
| 465 | SCTP_FAILED_THRESHOLD, | ||
| 466 | SCTP_RECEIVED_SACK, | ||
| 467 | SCTP_HEARTBEAT_SUCCESS, | ||
| 468 | SCTP_RESPONSE_TO_USER_REQ, | ||
| 469 | SCTP_INTERNAL_ERROR, | ||
| 470 | SCTP_SHUTDOWN_GUARD_EXPIRES, | ||
| 471 | SCTP_PEER_FAULTY, | ||
| 472 | } sctp_sn_error_t; | ||
| 473 | |||
| 474 | /* | ||
| 475 | * 7.1.1 Retransmission Timeout Parameters (SCTP_RTOINFO) | ||
| 476 | * | ||
| 477 | * The protocol parameters used to initialize and bound retransmission | ||
| 478 | * timeout (RTO) are tunable. See [SCTP] for more information on how | ||
| 479 | * these parameters are used in RTO calculation. | ||
| 480 | */ | ||
| 481 | struct sctp_rtoinfo { | ||
| 482 | sctp_assoc_t srto_assoc_id; | ||
| 483 | __u32 srto_initial; | ||
| 484 | __u32 srto_max; | ||
| 485 | __u32 srto_min; | ||
| 486 | }; | ||
| 487 | |||
| 488 | /* | ||
| 489 | * 7.1.2 Association Parameters (SCTP_ASSOCINFO) | ||
| 490 | * | ||
| 491 | * This option is used to both examine and set various association and | ||
| 492 | * endpoint parameters. | ||
| 493 | */ | ||
| 494 | struct sctp_assocparams { | ||
| 495 | sctp_assoc_t sasoc_assoc_id; | ||
| 496 | __u16 sasoc_asocmaxrxt; | ||
| 497 | __u16 sasoc_number_peer_destinations; | ||
| 498 | __u32 sasoc_peer_rwnd; | ||
| 499 | __u32 sasoc_local_rwnd; | ||
| 500 | __u32 sasoc_cookie_life; | ||
| 501 | }; | ||
| 502 | |||
| 503 | /* | ||
| 504 | * 7.1.9 Set Peer Primary Address (SCTP_SET_PEER_PRIMARY_ADDR) | ||
| 505 | * | ||
| 506 | * Requests that the peer mark the enclosed address as the association | ||
| 507 | * primary. The enclosed address must be one of the association's | ||
| 508 | * locally bound addresses. The following structure is used to make a | ||
| 509 | * set primary request: | ||
| 510 | */ | ||
| 511 | struct sctp_setpeerprim { | ||
| 512 | sctp_assoc_t sspp_assoc_id; | ||
| 513 | struct sockaddr_storage sspp_addr; | ||
| 514 | } __attribute__((packed, aligned(4))); | ||
| 515 | |||
| 516 | /* | ||
| 517 | * 7.1.10 Set Primary Address (SCTP_PRIMARY_ADDR) | ||
| 518 | * | ||
| 519 | * Requests that the local SCTP stack use the enclosed peer address as | ||
| 520 | * the association primary. The enclosed address must be one of the | ||
| 521 | * association peer's addresses. The following structure is used to | ||
| 522 | * make a set peer primary request: | ||
| 523 | */ | ||
| 524 | struct sctp_prim { | ||
| 525 | sctp_assoc_t ssp_assoc_id; | ||
| 526 | struct sockaddr_storage ssp_addr; | ||
| 527 | } __attribute__((packed, aligned(4))); | ||
| 528 | |||
| 529 | /* For backward compatibility use, define the old name too */ | ||
| 530 | #define sctp_setprim sctp_prim | ||
| 531 | |||
| 532 | /* | ||
| 533 | * 7.1.11 Set Adaptation Layer Indicator (SCTP_ADAPTATION_LAYER) | ||
| 534 | * | ||
| 535 | * Requests that the local endpoint set the specified Adaptation Layer | ||
| 536 | * Indication parameter for all future INIT and INIT-ACK exchanges. | ||
| 537 | */ | ||
| 538 | struct sctp_setadaptation { | ||
| 539 | __u32 ssb_adaptation_ind; | ||
| 540 | }; | ||
| 541 | |||
| 542 | /* | ||
| 543 | * 7.1.13 Peer Address Parameters (SCTP_PEER_ADDR_PARAMS) | ||
| 544 | * | ||
| 545 | * Applications can enable or disable heartbeats for any peer address | ||
| 546 | * of an association, modify an address's heartbeat interval, force a | ||
| 547 | * heartbeat to be sent immediately, and adjust the address's maximum | ||
| 548 | * number of retransmissions sent before an address is considered | ||
| 549 | * unreachable. The following structure is used to access and modify an | ||
| 550 | * address's parameters: | ||
| 551 | */ | ||
| 552 | enum sctp_spp_flags { | ||
| 553 | SPP_HB_ENABLE = 1<<0, /*Enable heartbeats*/ | ||
| 554 | SPP_HB_DISABLE = 1<<1, /*Disable heartbeats*/ | ||
| 555 | SPP_HB = SPP_HB_ENABLE | SPP_HB_DISABLE, | ||
| 556 | SPP_HB_DEMAND = 1<<2, /*Send heartbeat immediately*/ | ||
| 557 | SPP_PMTUD_ENABLE = 1<<3, /*Enable PMTU discovery*/ | ||
| 558 | SPP_PMTUD_DISABLE = 1<<4, /*Disable PMTU discovery*/ | ||
| 559 | SPP_PMTUD = SPP_PMTUD_ENABLE | SPP_PMTUD_DISABLE, | ||
| 560 | SPP_SACKDELAY_ENABLE = 1<<5, /*Enable SACK*/ | ||
| 561 | SPP_SACKDELAY_DISABLE = 1<<6, /*Disable SACK*/ | ||
| 562 | SPP_SACKDELAY = SPP_SACKDELAY_ENABLE | SPP_SACKDELAY_DISABLE, | ||
| 563 | SPP_HB_TIME_IS_ZERO = 1<<7, /* Set HB delay to 0 */ | ||
| 564 | }; | ||
| 565 | |||
| 566 | struct sctp_paddrparams { | ||
| 567 | sctp_assoc_t spp_assoc_id; | ||
| 568 | struct sockaddr_storage spp_address; | ||
| 569 | __u32 spp_hbinterval; | ||
| 570 | __u16 spp_pathmaxrxt; | ||
| 571 | __u32 spp_pathmtu; | ||
| 572 | __u32 spp_sackdelay; | ||
| 573 | __u32 spp_flags; | ||
| 574 | } __attribute__((packed, aligned(4))); | ||
| 575 | |||
| 576 | /* | ||
| 577 | * 7.1.18. Add a chunk that must be authenticated (SCTP_AUTH_CHUNK) | ||
| 578 | * | ||
| 579 | * This set option adds a chunk type that the user is requesting to be | ||
| 580 | * received only in an authenticated way. Changes to the list of chunks | ||
| 581 | * will only effect future associations on the socket. | ||
| 582 | */ | ||
| 583 | struct sctp_authchunk { | ||
| 584 | __u8 sauth_chunk; | ||
| 585 | }; | ||
| 586 | |||
| 587 | /* | ||
| 588 | * 7.1.19. Get or set the list of supported HMAC Identifiers (SCTP_HMAC_IDENT) | ||
| 589 | * | ||
| 590 | * This option gets or sets the list of HMAC algorithms that the local | ||
| 591 | * endpoint requires the peer to use. | ||
| 592 | */ | ||
| 593 | #ifndef __KERNEL__ | ||
| 594 | /* This here is only used by user space as is. It might not be a good idea | ||
| 595 | * to export/reveal the whole structure with reserved fields etc. | ||
| 596 | */ | ||
| 597 | enum { | ||
| 598 | SCTP_AUTH_HMAC_ID_SHA1 = 1, | ||
| 599 | SCTP_AUTH_HMAC_ID_SHA256 = 3, | ||
| 600 | }; | ||
| 601 | #endif | ||
| 602 | |||
| 603 | struct sctp_hmacalgo { | ||
| 604 | __u32 shmac_num_idents; | ||
| 605 | __u16 shmac_idents[]; | ||
| 606 | }; | ||
| 607 | |||
| 608 | /* Sadly, user and kernel space have different names for | ||
| 609 | * this structure member, so this is to not break anything. | ||
| 610 | */ | ||
| 611 | #define shmac_number_of_idents shmac_num_idents | ||
| 612 | |||
| 613 | /* | ||
| 614 | * 7.1.20. Set a shared key (SCTP_AUTH_KEY) | ||
| 615 | * | ||
| 616 | * This option will set a shared secret key which is used to build an | ||
| 617 | * association shared key. | ||
| 618 | */ | ||
| 619 | struct sctp_authkey { | ||
| 620 | sctp_assoc_t sca_assoc_id; | ||
| 621 | __u16 sca_keynumber; | ||
| 622 | __u16 sca_keylength; | ||
| 623 | __u8 sca_key[]; | ||
| 624 | }; | ||
| 625 | |||
| 626 | /* | ||
| 627 | * 7.1.21. Get or set the active shared key (SCTP_AUTH_ACTIVE_KEY) | ||
| 628 | * | ||
| 629 | * This option will get or set the active shared key to be used to build | ||
| 630 | * the association shared key. | ||
| 631 | */ | ||
| 632 | |||
| 633 | struct sctp_authkeyid { | ||
| 634 | sctp_assoc_t scact_assoc_id; | ||
| 635 | __u16 scact_keynumber; | ||
| 636 | }; | ||
| 637 | |||
| 638 | |||
| 639 | /* | ||
| 640 | * 7.1.23. Get or set delayed ack timer (SCTP_DELAYED_SACK) | ||
| 641 | * | ||
| 642 | * This option will effect the way delayed acks are performed. This | ||
| 643 | * option allows you to get or set the delayed ack time, in | ||
| 644 | * milliseconds. It also allows changing the delayed ack frequency. | ||
| 645 | * Changing the frequency to 1 disables the delayed sack algorithm. If | ||
| 646 | * the assoc_id is 0, then this sets or gets the endpoints default | ||
| 647 | * values. If the assoc_id field is non-zero, then the set or get | ||
| 648 | * effects the specified association for the one to many model (the | ||
| 649 | * assoc_id field is ignored by the one to one model). Note that if | ||
| 650 | * sack_delay or sack_freq are 0 when setting this option, then the | ||
| 651 | * current values will remain unchanged. | ||
| 652 | */ | ||
| 653 | struct sctp_sack_info { | ||
| 654 | sctp_assoc_t sack_assoc_id; | ||
| 655 | uint32_t sack_delay; | ||
| 656 | uint32_t sack_freq; | ||
| 657 | }; | ||
| 658 | |||
| 659 | struct sctp_assoc_value { | ||
| 660 | sctp_assoc_t assoc_id; | ||
| 661 | uint32_t assoc_value; | ||
| 662 | }; | ||
| 663 | |||
| 664 | /* | ||
| 665 | * 7.2.2 Peer Address Information | ||
| 666 | * | ||
| 667 | * Applications can retrieve information about a specific peer address | ||
| 668 | * of an association, including its reachability state, congestion | ||
| 669 | * window, and retransmission timer values. This information is | ||
| 670 | * read-only. The following structure is used to access this | ||
| 671 | * information: | ||
| 672 | */ | ||
| 673 | struct sctp_paddrinfo { | ||
| 674 | sctp_assoc_t spinfo_assoc_id; | ||
| 675 | struct sockaddr_storage spinfo_address; | ||
| 676 | __s32 spinfo_state; | ||
| 677 | __u32 spinfo_cwnd; | ||
| 678 | __u32 spinfo_srtt; | ||
| 679 | __u32 spinfo_rto; | ||
| 680 | __u32 spinfo_mtu; | ||
| 681 | } __attribute__((packed, aligned(4))); | ||
| 682 | |||
| 683 | /* Peer addresses's state. */ | ||
| 684 | /* UNKNOWN: Peer address passed by the upper layer in sendmsg or connect[x] | ||
| 685 | * calls. | ||
| 686 | * UNCONFIRMED: Peer address received in INIT/INIT-ACK address parameters. | ||
| 687 | * Not yet confirmed by a heartbeat and not available for data | ||
| 688 | * transfers. | ||
| 689 | * ACTIVE : Peer address confirmed, active and available for data transfers. | ||
| 690 | * INACTIVE: Peer address inactive and not available for data transfers. | ||
| 691 | */ | ||
| 692 | enum sctp_spinfo_state { | ||
| 693 | SCTP_INACTIVE, | ||
| 694 | SCTP_PF, | ||
| 695 | SCTP_ACTIVE, | ||
| 696 | SCTP_UNCONFIRMED, | ||
| 697 | SCTP_UNKNOWN = 0xffff /* Value used for transport state unknown */ | ||
| 698 | }; | ||
| 699 | |||
| 700 | /* | ||
| 701 | * 7.2.1 Association Status (SCTP_STATUS) | ||
| 702 | * | ||
| 703 | * Applications can retrieve current status information about an | ||
| 704 | * association, including association state, peer receiver window size, | ||
| 705 | * number of unacked data chunks, and number of data chunks pending | ||
| 706 | * receipt. This information is read-only. The following structure is | ||
| 707 | * used to access this information: | ||
| 708 | */ | ||
| 709 | struct sctp_status { | ||
| 710 | sctp_assoc_t sstat_assoc_id; | ||
| 711 | __s32 sstat_state; | ||
| 712 | __u32 sstat_rwnd; | ||
| 713 | __u16 sstat_unackdata; | ||
| 714 | __u16 sstat_penddata; | ||
| 715 | __u16 sstat_instrms; | ||
| 716 | __u16 sstat_outstrms; | ||
| 717 | __u32 sstat_fragmentation_point; | ||
| 718 | struct sctp_paddrinfo sstat_primary; | ||
| 719 | }; | ||
| 720 | |||
| 721 | /* | ||
| 722 | * 7.2.3. Get the list of chunks the peer requires to be authenticated | ||
| 723 | * (SCTP_PEER_AUTH_CHUNKS) | ||
| 724 | * | ||
| 725 | * This option gets a list of chunks for a specified association that | ||
| 726 | * the peer requires to be received authenticated only. | ||
| 727 | */ | ||
| 728 | struct sctp_authchunks { | ||
| 729 | sctp_assoc_t gauth_assoc_id; | ||
| 730 | __u32 gauth_number_of_chunks; | ||
| 731 | uint8_t gauth_chunks[]; | ||
| 732 | }; | ||
| 733 | |||
| 734 | /* The broken spelling has been released already in lksctp-tools header, | ||
| 735 | * so don't break anyone, now that it's fixed. | ||
| 736 | */ | ||
| 737 | #define guth_number_of_chunks gauth_number_of_chunks | ||
| 738 | |||
| 739 | /* Association states. */ | ||
| 740 | enum sctp_sstat_state { | ||
| 741 | SCTP_EMPTY = 0, | ||
| 742 | SCTP_CLOSED = 1, | ||
| 743 | SCTP_COOKIE_WAIT = 2, | ||
| 744 | SCTP_COOKIE_ECHOED = 3, | ||
| 745 | SCTP_ESTABLISHED = 4, | ||
| 746 | SCTP_SHUTDOWN_PENDING = 5, | ||
| 747 | SCTP_SHUTDOWN_SENT = 6, | ||
| 748 | SCTP_SHUTDOWN_RECEIVED = 7, | ||
| 749 | SCTP_SHUTDOWN_ACK_SENT = 8, | ||
| 750 | }; | ||
| 751 | |||
| 752 | /* | ||
| 753 | * 8.2.6. Get the Current Identifiers of Associations | ||
| 754 | * (SCTP_GET_ASSOC_ID_LIST) | ||
| 755 | * | ||
| 756 | * This option gets the current list of SCTP association identifiers of | ||
| 757 | * the SCTP associations handled by a one-to-many style socket. | ||
| 758 | */ | ||
| 759 | struct sctp_assoc_ids { | ||
| 760 | __u32 gaids_number_of_ids; | ||
| 761 | sctp_assoc_t gaids_assoc_id[]; | ||
| 762 | }; | ||
| 763 | |||
| 764 | /* | ||
| 765 | * 8.3, 8.5 get all peer/local addresses in an association. | ||
| 766 | * This parameter struct is used by SCTP_GET_PEER_ADDRS and | ||
| 767 | * SCTP_GET_LOCAL_ADDRS socket options used internally to implement | ||
| 768 | * sctp_getpaddrs() and sctp_getladdrs() API. | ||
| 769 | */ | ||
| 770 | struct sctp_getaddrs_old { | ||
| 771 | sctp_assoc_t assoc_id; | ||
| 772 | int addr_num; | ||
| 773 | #ifdef __KERNEL__ | ||
| 774 | struct sockaddr __user *addrs; | ||
| 775 | #else | ||
| 776 | struct sockaddr *addrs; | ||
| 777 | #endif | ||
| 778 | }; | ||
| 779 | |||
| 780 | struct sctp_getaddrs { | ||
| 781 | sctp_assoc_t assoc_id; /*input*/ | ||
| 782 | __u32 addr_num; /*output*/ | ||
| 783 | __u8 addrs[0]; /*output, variable size*/ | ||
| 784 | }; | ||
| 785 | |||
| 786 | /* A socket user request obtained via SCTP_GET_ASSOC_STATS that retrieves | ||
| 787 | * association stats. All stats are counts except sas_maxrto and | ||
| 788 | * sas_obs_rto_ipaddr. maxrto is the max observed rto + transport since | ||
| 789 | * the last call. Will return 0 when RTO was not update since last call | ||
| 790 | */ | ||
| 791 | struct sctp_assoc_stats { | ||
| 792 | sctp_assoc_t sas_assoc_id; /* Input */ | ||
| 793 | /* Transport of observed max RTO */ | ||
| 794 | struct sockaddr_storage sas_obs_rto_ipaddr; | ||
| 795 | __u64 sas_maxrto; /* Maximum Observed RTO for period */ | ||
| 796 | __u64 sas_isacks; /* SACKs received */ | ||
| 797 | __u64 sas_osacks; /* SACKs sent */ | ||
| 798 | __u64 sas_opackets; /* Packets sent */ | ||
| 799 | __u64 sas_ipackets; /* Packets received */ | ||
| 800 | __u64 sas_rtxchunks; /* Retransmitted Chunks */ | ||
| 801 | __u64 sas_outofseqtsns;/* TSN received > next expected */ | ||
| 802 | __u64 sas_idupchunks; /* Dups received (ordered+unordered) */ | ||
| 803 | __u64 sas_gapcnt; /* Gap Acknowledgements Received */ | ||
| 804 | __u64 sas_ouodchunks; /* Unordered data chunks sent */ | ||
| 805 | __u64 sas_iuodchunks; /* Unordered data chunks received */ | ||
| 806 | __u64 sas_oodchunks; /* Ordered data chunks sent */ | ||
| 807 | __u64 sas_iodchunks; /* Ordered data chunks received */ | ||
| 808 | __u64 sas_octrlchunks; /* Control chunks sent */ | ||
| 809 | __u64 sas_ictrlchunks; /* Control chunks received */ | ||
| 810 | }; | ||
| 811 | |||
| 812 | /* These are bit fields for msghdr->msg_flags. See section 5.1. */ | ||
| 813 | /* On user space Linux, these live in <bits/socket.h> as an enum. */ | ||
| 814 | enum sctp_msg_flags { | ||
| 815 | MSG_NOTIFICATION = 0x8000, | ||
| 816 | #define MSG_NOTIFICATION MSG_NOTIFICATION | ||
| 817 | }; | ||
| 818 | |||
| 819 | /* | ||
| 820 | * 8.1 sctp_bindx() | ||
| 821 | * | ||
| 822 | * The flags parameter is formed from the bitwise OR of zero or more of the | ||
| 823 | * following currently defined flags: | ||
| 824 | */ | ||
| 825 | #define SCTP_BINDX_ADD_ADDR 0x01 | ||
| 826 | #define SCTP_BINDX_REM_ADDR 0x02 | ||
| 827 | |||
| 828 | /* This is the structure that is passed as an argument(optval) to | ||
| 829 | * getsockopt(SCTP_SOCKOPT_PEELOFF). | ||
| 830 | */ | ||
| 831 | typedef struct { | ||
| 832 | sctp_assoc_t associd; | ||
| 833 | int sd; | ||
| 834 | } sctp_peeloff_arg_t; | ||
| 835 | |||
| 836 | /* | ||
| 837 | * Peer Address Thresholds socket option | ||
| 838 | */ | ||
| 839 | struct sctp_paddrthlds { | ||
| 840 | sctp_assoc_t spt_assoc_id; | ||
| 841 | struct sockaddr_storage spt_address; | ||
| 842 | __u16 spt_pathmaxrxt; | ||
| 843 | __u16 spt_pathpfthld; | ||
| 844 | }; | ||
| 845 | |||
| 846 | #endif /* _UAPI_SCTP_H */ | ||
