projects / linux-block.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
Merge tag 'x86_boot_for_v6.2' of git://git.kernel.org/pub/scm/linux/kernel/git/tip/tip
[linux-block.git] / include / uapi / linux / sctp.h
CommitLineData
e2be04c7 1/* SPDX-License-Identifier: GPL-2.0+ WITH Linux-syscall-note */
60c778b2 2/* SCTP kernel implementation
1da177e4
LT		 3 * (C) Copyright IBM Corp. 2001, 2004
4 * Copyright (c) 1999-2000 Cisco, Inc.
5 * Copyright (c) 1999-2001 Motorola, Inc.
6 * Copyright (c) 2002 Intel Corp.
7 *
60c778b2 8 * This file is part of the SCTP kernel implementation
1da177e4
LT		 9 *
10 * This header represents the structures and constants needed to support
11 * the SCTP Extension to the Sockets API.
12 *
60c778b2 13 * This SCTP implementation is free software;
1da177e4
LT		 14 * you can redistribute it and/or modify it under the terms of
15 * the GNU General Public License as published by
16 * the Free Software Foundation; either version 2, or (at your option)
17 * any later version.
18 *
60c778b2 19 * This SCTP implementation is distributed in the hope that it
1da177e4
LT		 20 * will be useful, but WITHOUT ANY WARRANTY; without even the implied
21 * ************************
22 * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
23 * See the GNU General Public License for more details.
24 *
25 * You should have received a copy of the GNU General Public License
4b2f13a2
JK		 26 * along with GNU CC; see the file COPYING. If not, see
27 * <http://www.gnu.org/licenses/>.
1da177e4
LT		 28 *
29 * Please send any bug reports or fixes you make to the
30 * email address(es):
91705c61 31 * lksctp developers <linux-sctp@vger.kernel.org>
1da177e4
LT		 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>
1b866434 45 * Ardelle Fan <ardelle.fan@intel.com>
1da177e4 46 * Sridhar Samudrala <sri@us.ibm.com>
1b866434
DB		 47 * Inaky Perez-Gonzalez <inaky.gonzalez@intel.com>
48 * Vlad Yasevich <vladislav.yasevich@hp.com>
1da177e4
LT		 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
1b866434
DB		 54#ifndef _UAPI_SCTP_H
55#define _UAPI_SCTP_H
1da177e4
LT		 56
57#include <linux/types.h>
58#include <linux/socket.h>
59
60typedef __s32 sctp_assoc_t;
61
80df2704
XL		 62#define SCTP_FUTURE_ASSOC 0
63#define SCTP_CURRENT_ASSOC 1
64#define SCTP_ALL_ASSOC 2
65
1da177e4
LT		 66/* The following symbols come from the Sockets API Extensions for
67 * SCTP <draft-ietf-tsvwg-sctpsocket-07.txt>.
68 */
a5b03ad2
VY		 69#define SCTP_RTOINFO 0
70#define SCTP_ASSOCINFO 1
71#define SCTP_INITMSG 2
72#define SCTP_NODELAY 3 /* Get/set nodelay option. */
73#define SCTP_AUTOCLOSE 4
74#define SCTP_SET_PEER_PRIMARY_ADDR 5
75#define SCTP_PRIMARY_ADDR 6
76#define SCTP_ADAPTATION_LAYER 7
77#define SCTP_DISABLE_FRAGMENTS 8
78#define SCTP_PEER_ADDR_PARAMS 9
79#define SCTP_DEFAULT_SEND_PARAM 10
80#define SCTP_EVENTS 11
81#define SCTP_I_WANT_MAPPED_V4_ADDR 12 /* Turn on/off mapped v4 addresses */
82#define SCTP_MAXSEG 13 /* Get/set maximum fragment. */
83#define SCTP_STATUS 14
84#define SCTP_GET_PEER_ADDR_INFO 15
85#define SCTP_DELAYED_ACK_TIME 16
86#define SCTP_DELAYED_ACK SCTP_DELAYED_ACK_TIME
4580ccc0 87#define SCTP_DELAYED_SACK SCTP_DELAYED_ACK_TIME
a5b03ad2
VY		 88#define SCTP_CONTEXT 17
89#define SCTP_FRAGMENT_INTERLEAVE 18
90#define SCTP_PARTIAL_DELIVERY_POINT 19 /* Set/Get partial delivery point */
91#define SCTP_MAX_BURST 20 /* Set/Get max burst */
92#define SCTP_AUTH_CHUNK 21 /* Set only: add a chunk type to authenticate */
93#define SCTP_HMAC_IDENT 22
94#define SCTP_AUTH_KEY 23
95#define SCTP_AUTH_ACTIVE_KEY 24
96#define SCTP_AUTH_DELETE_KEY 25
97#define SCTP_PEER_AUTH_CHUNKS 26 /* Read only */
98#define SCTP_LOCAL_AUTH_CHUNKS 27 /* Read only */
99#define SCTP_GET_ASSOC_NUMBER 28 /* Read only */
209ba424 100#define SCTP_GET_ASSOC_ID_LIST 29 /* Read only */
7dc04d71 101#define SCTP_AUTO_ASCONF 30
5aa93bcf 102#define SCTP_PEER_ADDR_THLDS 31
0d3a421d 103#define SCTP_RECVRCVINFO 32
2347c80f 104#define SCTP_RECVNXTINFO 33
6b3fd5f3 105#define SCTP_DEFAULT_SNDINFO 34
601590ec 106#define SCTP_AUTH_DEACTIVATE_KEY 35
b0e9a2fe 107#define SCTP_REUSE_PORT 36
d467ac0a 108#define SCTP_PEER_ADDR_THLDS_V2 37
65b07e5d 109
a5b03ad2
VY		 110/* Internal Socket Options. Some of the sctp library functions are
111 * implemented using these socket options.
112 */
113#define SCTP_SOCKOPT_BINDX_ADD 100 /* BINDX requests for adding addrs */
114#define SCTP_SOCKOPT_BINDX_REM 101 /* BINDX requests for removing addrs. */
115#define SCTP_SOCKOPT_PEELOFF 102 /* peel off association. */
116/* Options 104-106 are deprecated and removed. Do not use this space */
117#define SCTP_SOCKOPT_CONNECTX_OLD 107 /* CONNECTX old requests. */
b595076a
UKK		 118#define SCTP_GET_PEER_ADDRS 108 /* Get all peer address. */
119#define SCTP_GET_LOCAL_ADDRS 109 /* Get all local address. */
a5b03ad2
VY		 120#define SCTP_SOCKOPT_CONNECTX 110 /* CONNECTX requests. */
121#define SCTP_SOCKOPT_CONNECTX3 111 /* CONNECTX requests (updated) */
196d6759 122#define SCTP_GET_ASSOC_STATS 112 /* Read only */
28aa4c26 123#define SCTP_PR_SUPPORTED 113
f959fb44 124#define SCTP_DEFAULT_PRINFO 114
826d253d 125#define SCTP_PR_ASSOC_STATUS 115
d229d48d 126#define SCTP_PR_STREAM_STATUS 116
c0d8bab6 127#define SCTP_RECONFIG_SUPPORTED 117
9fb657ae 128#define SCTP_ENABLE_STREAM_RESET 118
7f9d68ac 129#define SCTP_RESET_STREAMS 119
a92ce1a4 130#define SCTP_RESET_ASSOC 120
242bd2d5 131#define SCTP_ADD_STREAMS 121
2cb5c8e3 132#define SCTP_SOCKOPT_PEELOFF_FLAGS 122
13aa8770 133#define SCTP_STREAM_SCHEDULER 123
0ccdf3c7 134#define SCTP_STREAM_SCHEDULER_VALUE 124
772a5869 135#define SCTP_INTERLEAVING_SUPPORTED 125
2277c7cd 136#define SCTP_SENDMSG_CONNECT 126
480ba9c1 137#define SCTP_EVENT 127
df2c71ff 138#define SCTP_ASCONF_SUPPORTED 128
56dd525a 139#define SCTP_AUTH_SUPPORTED 129
d5886b91 140#define SCTP_ECN_SUPPORTED 130
8d2a6935
XL		 141#define SCTP_EXPOSE_POTENTIALLY_FAILED_STATE 131
142#define SCTP_EXPOSE_PF_STATE SCTP_EXPOSE_POTENTIALLY_FAILED_STATE
8dba2960 143#define SCTP_REMOTE_UDP_ENCAPS_PORT 132
3190b649 144#define SCTP_PLPMTUD_PROBE_INTERVAL 133
f959fb44
XL		 145
146/* PR-SCTP policies */
147#define SCTP_PR_SCTP_NONE 0x0000
148#define SCTP_PR_SCTP_TTL 0x0010
149#define SCTP_PR_SCTP_RTX 0x0020
150#define SCTP_PR_SCTP_PRIO 0x0030
151#define SCTP_PR_SCTP_MAX SCTP_PR_SCTP_PRIO
152#define SCTP_PR_SCTP_MASK 0x0030
153
154#define __SCTP_PR_INDEX(x) ((x >> 4) - 1)
155#define SCTP_PR_INDEX(x) __SCTP_PR_INDEX(SCTP_PR_SCTP_ ## x)
156
157#define SCTP_PR_POLICY(x) ((x) & SCTP_PR_SCTP_MASK)
158#define SCTP_PR_SET_POLICY(flags, x) \
159 do { \
160 flags &= ~SCTP_PR_SCTP_MASK; \
161 flags |= x; \
162 } while (0)
163
164#define SCTP_PR_TTL_ENABLED(x) (SCTP_PR_POLICY(x) == SCTP_PR_SCTP_TTL)
165#define SCTP_PR_RTX_ENABLED(x) (SCTP_PR_POLICY(x) == SCTP_PR_SCTP_RTX)
166#define SCTP_PR_PRIO_ENABLED(x) (SCTP_PR_POLICY(x) == SCTP_PR_SCTP_PRIO)
1da177e4 167
9fb657ae
XL		 168/* For enable stream reset */
169#define SCTP_ENABLE_RESET_STREAM_REQ 0x01
170#define SCTP_ENABLE_RESET_ASSOC_REQ 0x02
171#define SCTP_ENABLE_CHANGE_ASSOC_REQ 0x04
172#define SCTP_ENABLE_STRRESET_MASK 0x07
173
7f9d68ac
XL		 174#define SCTP_STREAM_RESET_INCOMING 0x01
175#define SCTP_STREAM_RESET_OUTGOING 0x02
176
2347c80f
GOV		 177/* These are bit fields for msghdr->msg_flags. See section 5.1. */
178/* On user space Linux, these live in <bits/socket.h> as an enum. */
179enum sctp_msg_flags {
180 MSG_NOTIFICATION = 0x8000,
181#define MSG_NOTIFICATION MSG_NOTIFICATION
182};
183
0d3a421d 184/* 5.3.1 SCTP Initiation Structure (SCTP_INIT)
1da177e4
LT		 185 *
186 * This cmsghdr structure provides information for initializing new
187 * SCTP associations with sendmsg(). The SCTP_INITMSG socket option
188 * uses this same data structure. This structure is not used for
189 * recvmsg().
190 *
191 * cmsg_level cmsg_type cmsg_data[]
192 * ------------ ------------ ----------------------
193 * IPPROTO_SCTP SCTP_INIT struct sctp_initmsg
1da177e4
LT		 194 */
195struct sctp_initmsg {
196 __u16 sinit_num_ostreams;
197 __u16 sinit_max_instreams;
198 __u16 sinit_max_attempts;
199 __u16 sinit_max_init_timeo;
200};
201
0d3a421d 202/* 5.3.2 SCTP Header Information Structure (SCTP_SNDRCV)
1da177e4
LT		 203 *
204 * This cmsghdr structure specifies SCTP options for sendmsg() and
205 * describes SCTP header information about a received message through
206 * recvmsg().
207 *
208 * cmsg_level cmsg_type cmsg_data[]
209 * ------------ ------------ ----------------------
210 * IPPROTO_SCTP SCTP_SNDRCV struct sctp_sndrcvinfo
1da177e4
LT		 211 */
212struct sctp_sndrcvinfo {
213 __u16 sinfo_stream;
214 __u16 sinfo_ssn;
215 __u16 sinfo_flags;
216 __u32 sinfo_ppid;
217 __u32 sinfo_context;
218 __u32 sinfo_timetolive;
219 __u32 sinfo_tsn;
220 __u32 sinfo_cumtsn;
221 sctp_assoc_t sinfo_assoc_id;
222};
223
63b94938
GOV		 224/* 5.3.4 SCTP Send Information Structure (SCTP_SNDINFO)
225 *
226 * This cmsghdr structure specifies SCTP options for sendmsg().
227 *
228 * cmsg_level cmsg_type cmsg_data[]
229 * ------------ ------------ -------------------
230 * IPPROTO_SCTP SCTP_SNDINFO struct sctp_sndinfo
231 */
232struct sctp_sndinfo {
233 __u16 snd_sid;
234 __u16 snd_flags;
235 __u32 snd_ppid;
236 __u32 snd_context;
237 sctp_assoc_t snd_assoc_id;
238};
239
0d3a421d
GOV		 240/* 5.3.5 SCTP Receive Information Structure (SCTP_RCVINFO)
241 *
242 * This cmsghdr structure describes SCTP receive information
243 * about a received message through recvmsg().
244 *
245 * cmsg_level cmsg_type cmsg_data[]
246 * ------------ ------------ -------------------
247 * IPPROTO_SCTP SCTP_RCVINFO struct sctp_rcvinfo
248 */
249struct sctp_rcvinfo {
250 __u16 rcv_sid;
251 __u16 rcv_ssn;
252 __u16 rcv_flags;
253 __u32 rcv_ppid;
254 __u32 rcv_tsn;
255 __u32 rcv_cumtsn;
256 __u32 rcv_context;
257 sctp_assoc_t rcv_assoc_id;
258};
259
2347c80f
GOV		 260/* 5.3.6 SCTP Next Receive Information Structure (SCTP_NXTINFO)
261 *
262 * This cmsghdr structure describes SCTP receive information
263 * of the next message that will be delivered through recvmsg()
264 * if this information is already available when delivering
265 * the current message.
266 *
267 * cmsg_level cmsg_type cmsg_data[]
268 * ------------ ------------ -------------------
269 * IPPROTO_SCTP SCTP_NXTINFO struct sctp_nxtinfo
270 */
271struct sctp_nxtinfo {
272 __u16 nxt_sid;
273 __u16 nxt_flags;
274 __u32 nxt_ppid;
275 __u32 nxt_length;
276 sctp_assoc_t nxt_assoc_id;
277};
278
ed63afb8
XL		 279/* 5.3.7 SCTP PR-SCTP Information Structure (SCTP_PRINFO)
280 *
281 * This cmsghdr structure specifies SCTP options for sendmsg().
282 *
283 * cmsg_level cmsg_type cmsg_data[]
284 * ------------ ------------ -------------------
285 * IPPROTO_SCTP SCTP_PRINFO struct sctp_prinfo
286 */
287struct sctp_prinfo {
288 __u16 pr_policy;
289 __u32 pr_value;
290};
291
3ff547c0
XL		 292/* 5.3.8 SCTP AUTH Information Structure (SCTP_AUTHINFO)
293 *
294 * This cmsghdr structure specifies SCTP options for sendmsg().
295 *
296 * cmsg_level cmsg_type cmsg_data[]
297 * ------------ ------------ -------------------
298 * IPPROTO_SCTP SCTP_AUTHINFO struct sctp_authinfo
299 */
300struct sctp_authinfo {
301 __u16 auth_keynumber;
302};
303
1da177e4
LT		 304/*
305 * sinfo_flags: 16 bits (unsigned integer)
306 *
307 * This field may contain any of the following flags and is composed of
308 * a bitwise OR of these values.
309 */
1da177e4 310enum sctp_sinfo_flags {
2347c80f
GOV		 311 SCTP_UNORDERED = (1 << 0), /* Send/receive message unordered. */
312 SCTP_ADDR_OVER = (1 << 1), /* Override the primary destination. */
313 SCTP_ABORT = (1 << 2), /* Send an ABORT message to the peer. */
314 SCTP_SACK_IMMEDIATELY = (1 << 3), /* SACK should be sent without delay. */
49102805
XL		 315 /* 2 bits here have been used by SCTP_PR_SCTP_MASK */
316 SCTP_SENDALL = (1 << 6),
0ac1077e 317 SCTP_PR_SCTP_ALL = (1 << 7),
2347c80f
GOV		 318 SCTP_NOTIFICATION = MSG_NOTIFICATION, /* Next message is not user msg but notification. */
319 SCTP_EOF = MSG_FIN, /* Initiate graceful shutdown process. */
1da177e4
LT		 320};
321
1b866434
DB		 322typedef union {
323 __u8 raw;
324 struct sctp_initmsg init;
325 struct sctp_sndrcvinfo sndrcv;
326} sctp_cmsg_data_t;
1da177e4 327
1da177e4
LT		 328/* These are cmsg_types. */
329typedef enum sctp_cmsg_type {
63b94938 330 SCTP_INIT, /* 5.2.1 SCTP Initiation Structure */
1b866434 331#define SCTP_INIT SCTP_INIT
63b94938 332 SCTP_SNDRCV, /* 5.2.2 SCTP Header Information Structure */
1b866434 333#define SCTP_SNDRCV SCTP_SNDRCV
63b94938
GOV		 334 SCTP_SNDINFO, /* 5.3.4 SCTP Send Information Structure */
335#define SCTP_SNDINFO SCTP_SNDINFO
0d3a421d
GOV		 336 SCTP_RCVINFO, /* 5.3.5 SCTP Receive Information Structure */
337#define SCTP_RCVINFO SCTP_RCVINFO
2347c80f
GOV		 338 SCTP_NXTINFO, /* 5.3.6 SCTP Next Receive Information Structure */
339#define SCTP_NXTINFO SCTP_NXTINFO
ed63afb8
XL		 340 SCTP_PRINFO, /* 5.3.7 SCTP PR-SCTP Information Structure */
341#define SCTP_PRINFO SCTP_PRINFO
3ff547c0 342 SCTP_AUTHINFO, /* 5.3.8 SCTP AUTH Information Structure */
2c0dbaa0
XL		 343#define SCTP_AUTHINFO SCTP_AUTHINFO
344 SCTP_DSTADDRV4, /* 5.3.9 SCTP Destination IPv4 Address Structure */
345#define SCTP_DSTADDRV4 SCTP_DSTADDRV4
346 SCTP_DSTADDRV6, /* 5.3.10 SCTP Destination IPv6 Address Structure */
347#define SCTP_DSTADDRV6 SCTP_DSTADDRV6
1da177e4
LT		 348} sctp_cmsg_t;
349
1da177e4
LT		 350/*
351 * 5.3.1.1 SCTP_ASSOC_CHANGE
352 *
353 * Communication notifications inform the ULP that an SCTP association
354 * has either begun or ended. The identifier for a new association is
355 * provided by this notificaion. The notification information has the
356 * following format:
357 *
358 */
359struct sctp_assoc_change {
360 __u16 sac_type;
361 __u16 sac_flags;
362 __u32 sac_length;
363 __u16 sac_state;
364 __u16 sac_error;
365 __u16 sac_outbound_streams;
366 __u16 sac_inbound_streams;
367 sctp_assoc_t sac_assoc_id;
94dfc73e 368 __u8 sac_info[];
1da177e4
LT		 369};
370
371/*
372 * sac_state: 32 bits (signed integer)
373 *
374 * This field holds one of a number of values that communicate the
375 * event that happened to the association. They include:
376 *
377 * Note: The following state names deviate from the API draft as
378 * the names clash too easily with other kernel symbols.
379 */
380enum sctp_sac_state {
381 SCTP_COMM_UP,
382 SCTP_COMM_LOST,
383 SCTP_RESTART,
384 SCTP_SHUTDOWN_COMP,
385 SCTP_CANT_STR_ASSOC,
386};
387
388/*
389 * 5.3.1.2 SCTP_PEER_ADDR_CHANGE
390 *
391 * When a destination address on a multi-homed peer encounters a change
392 * an interface details event is sent. The information has the
393 * following structure:
394 */
395struct sctp_paddr_change {
396 __u16 spc_type;
397 __u16 spc_flags;
398 __u32 spc_length;
399 struct sockaddr_storage spc_aaddr;
400 int spc_state;
401 int spc_error;
402 sctp_assoc_t spc_assoc_id;
20c9c825 403} __attribute__((packed, aligned(4)));
1da177e4
LT		 404
405/*
406 * spc_state: 32 bits (signed integer)
407 *
408 * This field holds one of a number of values that communicate the
409 * event that happened to the address. They include:
410 */
411enum sctp_spc_state {
412 SCTP_ADDR_AVAILABLE,
413 SCTP_ADDR_UNREACHABLE,
414 SCTP_ADDR_REMOVED,
415 SCTP_ADDR_ADDED,
416 SCTP_ADDR_MADE_PRIM,
1ae4114d 417 SCTP_ADDR_CONFIRMED,
768e1518
XL		 418 SCTP_ADDR_POTENTIALLY_FAILED,
419#define SCTP_ADDR_PF SCTP_ADDR_POTENTIALLY_FAILED
1da177e4
LT		 420};
421
422
423/*
424 * 5.3.1.3 SCTP_REMOTE_ERROR
425 *
426 * A remote peer may send an Operational Error message to its peer.
427 * This message indicates a variety of error conditions on an
428 * association. The entire error TLV as it appears on the wire is
429 * included in a SCTP_REMOTE_ERROR event. Please refer to the SCTP
430 * specification [SCTP] and any extensions for a list of possible
431 * error formats. SCTP error TLVs have the format:
432 */
433struct sctp_remote_error {
434 __u16 sre_type;
435 __u16 sre_flags;
436 __u32 sre_length;
978aa047 437 __be16 sre_error;
1da177e4 438 sctp_assoc_t sre_assoc_id;
94dfc73e 439 __u8 sre_data[];
1da177e4
LT		 440};
441
442
443/*
444 * 5.3.1.4 SCTP_SEND_FAILED
445 *
446 * If SCTP cannot deliver a message it may return the message as a
447 * notification.
448 */
449struct sctp_send_failed {
450 __u16 ssf_type;
451 __u16 ssf_flags;
452 __u32 ssf_length;
453 __u32 ssf_error;
454 struct sctp_sndrcvinfo ssf_info;
455 sctp_assoc_t ssf_assoc_id;
94dfc73e 456 __u8 ssf_data[];
1da177e4
LT		 457};
458
b6e6b5f1
XL		 459struct sctp_send_failed_event {
460 __u16 ssf_type;
461 __u16 ssf_flags;
462 __u32 ssf_length;
463 __u32 ssf_error;
464 struct sctp_sndinfo ssfe_info;
465 sctp_assoc_t ssf_assoc_id;
94dfc73e 466 __u8 ssf_data[];
b6e6b5f1
XL		 467};
468
1da177e4
LT		 469/*
470 * ssf_flags: 16 bits (unsigned integer)
471 *
472 * The flag value will take one of the following values
473 *
474 * SCTP_DATA_UNSENT - Indicates that the data was never put on
475 * the wire.
476 *
477 * SCTP_DATA_SENT - Indicates that the data was put on the wire.
478 * Note that this does not necessarily mean that the
479 * data was (or was not) successfully delivered.
480 */
481enum sctp_ssf_flags {
482 SCTP_DATA_UNSENT,
483 SCTP_DATA_SENT,
484};
485
486/*
487 * 5.3.1.5 SCTP_SHUTDOWN_EVENT
488 *
489 * When a peer sends a SHUTDOWN, SCTP delivers this notification to
490 * inform the application that it should cease sending data.
491 */
492struct sctp_shutdown_event {
493 __u16 sse_type;
494 __u16 sse_flags;
495 __u32 sse_length;
496 sctp_assoc_t sse_assoc_id;
497};
498
499/*
0f3fffd8 500 * 5.3.1.6 SCTP_ADAPTATION_INDICATION
1da177e4 501 *
0f3fffd8 502 * When a peer sends a Adaptation Layer Indication parameter , SCTP
1da177e4 503 * delivers this notification to inform the application
0f3fffd8 504 * that of the peers requested adaptation layer.
1da177e4 505 */
0f3fffd8 506struct sctp_adaptation_event {
1da177e4
LT		 507 __u16 sai_type;
508 __u16 sai_flags;
509 __u32 sai_length;
0f3fffd8 510 __u32 sai_adaptation_ind;
1da177e4
LT		 511 sctp_assoc_t sai_assoc_id;
512};
513
514/*
515 * 5.3.1.7 SCTP_PARTIAL_DELIVERY_EVENT
516 *
517 * When a receiver is engaged in a partial delivery of a
518 * message this notification will be used to indicate
519 * various events.
520 */
521struct sctp_pdapi_event {
522 __u16 pdapi_type;
523 __u16 pdapi_flags;
524 __u32 pdapi_length;
525 __u32 pdapi_indication;
526 sctp_assoc_t pdapi_assoc_id;
65f5e357
XL		 527 __u32 pdapi_stream;
528 __u32 pdapi_seq;
1da177e4
LT		 529};
530
531enum { SCTP_PARTIAL_DELIVERY_ABORTED=0, };
532
1b866434
DB		 533/*
534 * 5.3.1.8. SCTP_AUTHENTICATION_EVENT
535 *
536 * When a receiver is using authentication this message will provide
537 * notifications regarding new keys being made active as well as errors.
538 */
65b07e5d
VY		 539struct sctp_authkey_event {
540 __u16 auth_type;
541 __u16 auth_flags;
542 __u32 auth_length;
543 __u16 auth_keynumber;
544 __u16 auth_altkeynumber;
545 __u32 auth_indication;
546 sctp_assoc_t auth_assoc_id;
547};
548
ec2e506c
XL		 549enum {
550 SCTP_AUTH_NEW_KEY,
551#define SCTP_AUTH_NEWKEY SCTP_AUTH_NEW_KEY /* compatible with before */
552 SCTP_AUTH_FREE_KEY,
30f6ebf6 553 SCTP_AUTH_NO_AUTH,
ec2e506c 554};
65b07e5d 555
e1cdd553
WY		 556/*
557 * 6.1.9. SCTP_SENDER_DRY_EVENT
558 *
559 * When the SCTP stack has no more user data to send or retransmit, this
560 * notification is given to the user. Also, at the time when a user app
561 * subscribes to this event, if there is no data to be sent or
562 * retransmit, the stack will immediately send up this notification.
563 */
564struct sctp_sender_dry_event {
565 __u16 sender_dry_type;
566 __u16 sender_dry_flags;
567 __u32 sender_dry_length;
568 sctp_assoc_t sender_dry_assoc_id;
569};
65b07e5d 570
35ea82d6
XL		 571#define SCTP_STREAM_RESET_INCOMING_SSN 0x0001
572#define SCTP_STREAM_RESET_OUTGOING_SSN 0x0002
573#define SCTP_STREAM_RESET_DENIED 0x0004
574#define SCTP_STREAM_RESET_FAILED 0x0008
575struct sctp_stream_reset_event {
576 __u16 strreset_type;
577 __u16 strreset_flags;
578 __u32 strreset_length;
579 sctp_assoc_t strreset_assoc_id;
580 __u16 strreset_stream_list[];
581};
582
c95129d1
XL		 583#define SCTP_ASSOC_RESET_DENIED 0x0004
584#define SCTP_ASSOC_RESET_FAILED 0x0008
585struct sctp_assoc_reset_event {
586 __u16 assocreset_type;
587 __u16 assocreset_flags;
588 __u32 assocreset_length;
589 sctp_assoc_t assocreset_assoc_id;
590 __u32 assocreset_local_tsn;
591 __u32 assocreset_remote_tsn;
592};
593
b444153f
XL		 594#define SCTP_ASSOC_CHANGE_DENIED 0x0004
595#define SCTP_ASSOC_CHANGE_FAILED 0x0008
fd82d61b
XL		 596#define SCTP_STREAM_CHANGE_DENIED SCTP_ASSOC_CHANGE_DENIED
597#define SCTP_STREAM_CHANGE_FAILED SCTP_ASSOC_CHANGE_FAILED
b444153f
XL		 598struct sctp_stream_change_event {
599 __u16 strchange_type;
600 __u16 strchange_flags;
601 __u32 strchange_length;
602 sctp_assoc_t strchange_assoc_id;
603 __u16 strchange_instrms;
604 __u16 strchange_outstrms;
605};
606
1da177e4
LT		 607/*
608 * Described in Section 7.3
609 * Ancillary Data and Notification Interest Options
610 */
611struct sctp_event_subscribe {
612 __u8 sctp_data_io_event;
613 __u8 sctp_association_event;
614 __u8 sctp_address_event;
615 __u8 sctp_send_failure_event;
616 __u8 sctp_peer_error_event;
617 __u8 sctp_shutdown_event;
618 __u8 sctp_partial_delivery_event;
0f3fffd8 619 __u8 sctp_adaptation_layer_event;
7e8616d8 620 __u8 sctp_authentication_event;
e1cdd553 621 __u8 sctp_sender_dry_event;
35ea82d6 622 __u8 sctp_stream_reset_event;
c95129d1 623 __u8 sctp_assoc_reset_event;
b444153f 624 __u8 sctp_stream_change_event;
b6e6b5f1 625 __u8 sctp_send_failure_event_event;
1da177e4
LT		 626};
627
628/*
629 * 5.3.1 SCTP Notification Structure
630 *
631 * The notification structure is defined as the union of all
632 * notification types.
633 *
634 */
635union sctp_notification {
636 struct {
637 __u16 sn_type; /* Notification type. */
638 __u16 sn_flags;
639 __u32 sn_length;
640 } sn_header;
641 struct sctp_assoc_change sn_assoc_change;
642 struct sctp_paddr_change sn_paddr_change;
643 struct sctp_remote_error sn_remote_error;
644 struct sctp_send_failed sn_send_failed;
645 struct sctp_shutdown_event sn_shutdown_event;
0f3fffd8 646 struct sctp_adaptation_event sn_adaptation_event;
1da177e4 647 struct sctp_pdapi_event sn_pdapi_event;
65b07e5d 648 struct sctp_authkey_event sn_authkey_event;
e1cdd553 649 struct sctp_sender_dry_event sn_sender_dry_event;
35ea82d6 650 struct sctp_stream_reset_event sn_strreset_event;
c95129d1 651 struct sctp_assoc_reset_event sn_assocreset_event;
b444153f 652 struct sctp_stream_change_event sn_strchange_event;
b6e6b5f1 653 struct sctp_send_failed_event sn_send_failed_event;
1da177e4
LT		 654};
655
656/* Section 5.3.1
657 * All standard values for sn_type flags are greater than 2^15.
658 * Values from 2^15 and down are reserved.
659 */
660
661enum sctp_sn_type {
2cc0eeb6
XL		 662 SCTP_SN_TYPE_BASE = (1<<15),
663 SCTP_DATA_IO_EVENT = SCTP_SN_TYPE_BASE,
664#define SCTP_DATA_IO_EVENT SCTP_DATA_IO_EVENT
1da177e4 665 SCTP_ASSOC_CHANGE,
1b866434 666#define SCTP_ASSOC_CHANGE SCTP_ASSOC_CHANGE
1da177e4 667 SCTP_PEER_ADDR_CHANGE,
1b866434 668#define SCTP_PEER_ADDR_CHANGE SCTP_PEER_ADDR_CHANGE
1da177e4 669 SCTP_SEND_FAILED,
1b866434 670#define SCTP_SEND_FAILED SCTP_SEND_FAILED
1da177e4 671 SCTP_REMOTE_ERROR,
1b866434 672#define SCTP_REMOTE_ERROR SCTP_REMOTE_ERROR
1da177e4 673 SCTP_SHUTDOWN_EVENT,
1b866434 674#define SCTP_SHUTDOWN_EVENT SCTP_SHUTDOWN_EVENT
1da177e4 675 SCTP_PARTIAL_DELIVERY_EVENT,
1b866434 676#define SCTP_PARTIAL_DELIVERY_EVENT SCTP_PARTIAL_DELIVERY_EVENT
0f3fffd8 677 SCTP_ADAPTATION_INDICATION,
1b866434 678#define SCTP_ADAPTATION_INDICATION SCTP_ADAPTATION_INDICATION
ee916fd0
WY		 679 SCTP_AUTHENTICATION_EVENT,
680#define SCTP_AUTHENTICATION_INDICATION SCTP_AUTHENTICATION_EVENT
e1cdd553 681 SCTP_SENDER_DRY_EVENT,
1b866434 682#define SCTP_SENDER_DRY_EVENT SCTP_SENDER_DRY_EVENT
35ea82d6
XL		 683 SCTP_STREAM_RESET_EVENT,
684#define SCTP_STREAM_RESET_EVENT SCTP_STREAM_RESET_EVENT
c95129d1
XL		 685 SCTP_ASSOC_RESET_EVENT,
686#define SCTP_ASSOC_RESET_EVENT SCTP_ASSOC_RESET_EVENT
b444153f
XL		 687 SCTP_STREAM_CHANGE_EVENT,
688#define SCTP_STREAM_CHANGE_EVENT SCTP_STREAM_CHANGE_EVENT
b6e6b5f1
XL		 689 SCTP_SEND_FAILED_EVENT,
690#define SCTP_SEND_FAILED_EVENT SCTP_SEND_FAILED_EVENT
691 SCTP_SN_TYPE_MAX = SCTP_SEND_FAILED_EVENT,
2cc0eeb6 692#define SCTP_SN_TYPE_MAX SCTP_SN_TYPE_MAX
1da177e4
LT		 693};
694
695/* Notification error codes used to fill up the error fields in some
696 * notifications.
697 * SCTP_PEER_ADDRESS_CHAGE : spc_error
698 * SCTP_ASSOC_CHANGE : sac_error
699 * These names should be potentially included in the draft 04 of the SCTP
700 * sockets API specification.
701 */
702typedef enum sctp_sn_error {
703 SCTP_FAILED_THRESHOLD,
704 SCTP_RECEIVED_SACK,
705 SCTP_HEARTBEAT_SUCCESS,
706 SCTP_RESPONSE_TO_USER_REQ,
707 SCTP_INTERNAL_ERROR,
708 SCTP_SHUTDOWN_GUARD_EXPIRES,
709 SCTP_PEER_FAULTY,
710} sctp_sn_error_t;
711
712/*
713 * 7.1.1 Retransmission Timeout Parameters (SCTP_RTOINFO)
714 *
715 * The protocol parameters used to initialize and bound retransmission
716 * timeout (RTO) are tunable. See [SCTP] for more information on how
1b866434 717 * these parameters are used in RTO calculation.
1da177e4
LT		 718 */
719struct sctp_rtoinfo {
720 sctp_assoc_t srto_assoc_id;
721 __u32 srto_initial;
722 __u32 srto_max;
723 __u32 srto_min;
724};
725
726/*
727 * 7.1.2 Association Parameters (SCTP_ASSOCINFO)
728 *
729 * This option is used to both examine and set various association and
730 * endpoint parameters.
731 */
732struct sctp_assocparams {
733 sctp_assoc_t sasoc_assoc_id;
734 __u16 sasoc_asocmaxrxt;
735 __u16 sasoc_number_peer_destinations;
736 __u32 sasoc_peer_rwnd;
737 __u32 sasoc_local_rwnd;
738 __u32 sasoc_cookie_life;
739};
740
741/*
742 * 7.1.9 Set Peer Primary Address (SCTP_SET_PEER_PRIMARY_ADDR)
743 *
744 * Requests that the peer mark the enclosed address as the association
745 * primary. The enclosed address must be one of the association's
746 * locally bound addresses. The following structure is used to make a
747 * set primary request:
748 */
749struct sctp_setpeerprim {
750 sctp_assoc_t sspp_assoc_id;
751 struct sockaddr_storage sspp_addr;
20c9c825 752} __attribute__((packed, aligned(4)));
1da177e4
LT		 753
754/*
755 * 7.1.10 Set Primary Address (SCTP_PRIMARY_ADDR)
756 *
757 * Requests that the local SCTP stack use the enclosed peer address as
758 * the association primary. The enclosed address must be one of the
759 * association peer's addresses. The following structure is used to
760 * make a set peer primary request:
761 */
762struct sctp_prim {
763 sctp_assoc_t ssp_assoc_id;
764 struct sockaddr_storage ssp_addr;
20c9c825 765} __attribute__((packed, aligned(4)));
1da177e4 766
1b866434
DB		 767/* For backward compatibility use, define the old name too */
768#define sctp_setprim sctp_prim
769
1da177e4 770/*
0f3fffd8 771 * 7.1.11 Set Adaptation Layer Indicator (SCTP_ADAPTATION_LAYER)
1da177e4 772 *
0f3fffd8 773 * Requests that the local endpoint set the specified Adaptation Layer
1da177e4
LT		 774 * Indication parameter for all future INIT and INIT-ACK exchanges.
775 */
0f3fffd8
ISJ		 776struct sctp_setadaptation {
777 __u32 ssb_adaptation_ind;
1da177e4
LT		 778};
779
780/*
781 * 7.1.13 Peer Address Parameters (SCTP_PEER_ADDR_PARAMS)
782 *
783 * Applications can enable or disable heartbeats for any peer address
784 * of an association, modify an address's heartbeat interval, force a
785 * heartbeat to be sent immediately, and adjust the address's maximum
786 * number of retransmissions sent before an address is considered
787 * unreachable. The following structure is used to access and modify an
788 * address's parameters:
789 */
52ccb8e9 790enum sctp_spp_flags {
bdf3092a
VY		 791 SPP_HB_ENABLE = 1<<0, /*Enable heartbeats*/
792 SPP_HB_DISABLE = 1<<1, /*Disable heartbeats*/
52ccb8e9 793 SPP_HB = SPP_HB_ENABLE | SPP_HB_DISABLE,
bdf3092a
VY		 794 SPP_HB_DEMAND = 1<<2, /*Send heartbeat immediately*/
795 SPP_PMTUD_ENABLE = 1<<3, /*Enable PMTU discovery*/
796 SPP_PMTUD_DISABLE = 1<<4, /*Disable PMTU discovery*/
52ccb8e9 797 SPP_PMTUD = SPP_PMTUD_ENABLE | SPP_PMTUD_DISABLE,
bdf3092a
VY		 798 SPP_SACKDELAY_ENABLE = 1<<5, /*Enable SACK*/
799 SPP_SACKDELAY_DISABLE = 1<<6, /*Disable SACK*/
52ccb8e9 800 SPP_SACKDELAY = SPP_SACKDELAY_ENABLE | SPP_SACKDELAY_DISABLE,
bdf3092a 801 SPP_HB_TIME_IS_ZERO = 1<<7, /* Set HB delay to 0 */
0b0dce7a
XL		 802 SPP_IPV6_FLOWLABEL = 1<<8,
803 SPP_DSCP = 1<<9,
52ccb8e9
FF		 804};
805
1da177e4
LT		 806struct sctp_paddrparams {
807 sctp_assoc_t spp_assoc_id;
808 struct sockaddr_storage spp_address;
809 __u32 spp_hbinterval;
810 __u16 spp_pathmaxrxt;
52ccb8e9
FF		 811 __u32 spp_pathmtu;
812 __u32 spp_sackdelay;
813 __u32 spp_flags;
0b0dce7a
XL		 814 __u32 spp_ipv6_flowlabel;
815 __u8 spp_dscp;
20c9c825 816} __attribute__((packed, aligned(4)));
1da177e4 817
65b07e5d
VY		 818/*
819 * 7.1.18. Add a chunk that must be authenticated (SCTP_AUTH_CHUNK)
820 *
821 * This set option adds a chunk type that the user is requesting to be
822 * received only in an authenticated way. Changes to the list of chunks
823 * will only effect future associations on the socket.
824 */
825struct sctp_authchunk {
826 __u8 sauth_chunk;
827};
828
829/*
830 * 7.1.19. Get or set the list of supported HMAC Identifiers (SCTP_HMAC_IDENT)
831 *
832 * This option gets or sets the list of HMAC algorithms that the local
833 * endpoint requires the peer to use.
1b866434
DB		 834 */
835#ifndef __KERNEL__
836/* This here is only used by user space as is. It might not be a good idea
837 * to export/reveal the whole structure with reserved fields etc.
838 */
839enum {
840 SCTP_AUTH_HMAC_ID_SHA1 = 1,
841 SCTP_AUTH_HMAC_ID_SHA256 = 3,
842};
843#endif
844
65b07e5d 845struct sctp_hmacalgo {
7e8616d8 846 __u32 shmac_num_idents;
65b07e5d
VY		 847 __u16 shmac_idents[];
848};
849
1b866434
DB		 850/* Sadly, user and kernel space have different names for
851 * this structure member, so this is to not break anything.
852 */
853#define shmac_number_of_idents shmac_num_idents
854
65b07e5d
VY		 855/*
856 * 7.1.20. Set a shared key (SCTP_AUTH_KEY)
857 *
858 * This option will set a shared secret key which is used to build an
859 * association shared key.
860 */
861struct sctp_authkey {
862 sctp_assoc_t sca_assoc_id;
863 __u16 sca_keynumber;
7e8616d8 864 __u16 sca_keylength;
65b07e5d
VY		 865 __u8 sca_key[];
866};
867
868/*
869 * 7.1.21. Get or set the active shared key (SCTP_AUTH_ACTIVE_KEY)
870 *
871 * This option will get or set the active shared key to be used to build
872 * the association shared key.
873 */
874
875struct sctp_authkeyid {
876 sctp_assoc_t scact_assoc_id;
877 __u16 scact_keynumber;
878};
879
880
d364d927
WY		 881/*
882 * 7.1.23. Get or set delayed ack timer (SCTP_DELAYED_SACK)
883 *
884 * This option will effect the way delayed acks are performed. This
885 * option allows you to get or set the delayed ack time, in
886 * milliseconds. It also allows changing the delayed ack frequency.
887 * Changing the frequency to 1 disables the delayed sack algorithm. If
888 * the assoc_id is 0, then this sets or gets the endpoints default
889 * values. If the assoc_id field is non-zero, then the set or get
890 * effects the specified association for the one to many model (the
891 * assoc_id field is ignored by the one to one model). Note that if
892 * sack_delay or sack_freq are 0 when setting this option, then the
893 * current values will remain unchanged.
7708610b 894 */
d364d927
WY		 895struct sctp_sack_info {
896 sctp_assoc_t sack_assoc_id;
897 uint32_t sack_delay;
898 uint32_t sack_freq;
899};
900
7708610b
FF		 901struct sctp_assoc_value {
902 sctp_assoc_t assoc_id;
903 uint32_t assoc_value;
904};
905
0ccdf3c7
MRL		 906struct sctp_stream_value {
907 sctp_assoc_t assoc_id;
908 uint16_t stream_id;
909 uint16_t stream_value;
910};
911
1da177e4
LT		 912/*
913 * 7.2.2 Peer Address Information
914 *
915 * Applications can retrieve information about a specific peer address
916 * of an association, including its reachability state, congestion
917 * window, and retransmission timer values. This information is
918 * read-only. The following structure is used to access this
919 * information:
920 */
921struct sctp_paddrinfo {
922 sctp_assoc_t spinfo_assoc_id;
923 struct sockaddr_storage spinfo_address;
924 __s32 spinfo_state;
925 __u32 spinfo_cwnd;
926 __u32 spinfo_srtt;
927 __u32 spinfo_rto;
928 __u32 spinfo_mtu;
20c9c825 929} __attribute__((packed, aligned(4)));
1da177e4
LT		 930
931/* Peer addresses's state. */
ad8fec17
SS		 932/* UNKNOWN: Peer address passed by the upper layer in sendmsg or connect[x]
933 * calls.
934 * UNCONFIRMED: Peer address received in INIT/INIT-ACK address parameters.
935 * Not yet confirmed by a heartbeat and not available for data
936 * transfers.
937 * ACTIVE : Peer address confirmed, active and available for data transfers.
938 * INACTIVE: Peer address inactive and not available for data transfers.
939 */
1da177e4
LT		 940enum sctp_spinfo_state {
941 SCTP_INACTIVE,
5aa93bcf 942 SCTP_PF,
aef587be 943#define SCTP_POTENTIALLY_FAILED SCTP_PF
1da177e4 944 SCTP_ACTIVE,
ad8fec17 945 SCTP_UNCONFIRMED,
3f7a87d2 946 SCTP_UNKNOWN = 0xffff /* Value used for transport state unknown */
1da177e4
LT		 947};
948
949/*
950 * 7.2.1 Association Status (SCTP_STATUS)
951 *
952 * Applications can retrieve current status information about an
953 * association, including association state, peer receiver window size,
954 * number of unacked data chunks, and number of data chunks pending
955 * receipt. This information is read-only. The following structure is
956 * used to access this information:
957 */
958struct sctp_status {
959 sctp_assoc_t sstat_assoc_id;
960 __s32 sstat_state;
961 __u32 sstat_rwnd;
962 __u16 sstat_unackdata;
963 __u16 sstat_penddata;
964 __u16 sstat_instrms;
965 __u16 sstat_outstrms;
966 __u32 sstat_fragmentation_point;
967 struct sctp_paddrinfo sstat_primary;
968};
969
65b07e5d
VY		 970/*
971 * 7.2.3. Get the list of chunks the peer requires to be authenticated
972 * (SCTP_PEER_AUTH_CHUNKS)
973 *
974 * This option gets a list of chunks for a specified association that
975 * the peer requires to be received authenticated only.
976 */
977struct sctp_authchunks {
7e8616d8
VY		 978 sctp_assoc_t gauth_assoc_id;
979 __u32 gauth_number_of_chunks;
980 uint8_t gauth_chunks[];
65b07e5d
VY		 981};
982
1b866434
DB		 983/* The broken spelling has been released already in lksctp-tools header,
984 * so don't break anyone, now that it's fixed.
985 */
986#define guth_number_of_chunks gauth_number_of_chunks
987
988/* Association states. */
989enum sctp_sstat_state {
990 SCTP_EMPTY = 0,
991 SCTP_CLOSED = 1,
992 SCTP_COOKIE_WAIT = 2,
993 SCTP_COOKIE_ECHOED = 3,
994 SCTP_ESTABLISHED = 4,
995 SCTP_SHUTDOWN_PENDING = 5,
996 SCTP_SHUTDOWN_SENT = 6,
997 SCTP_SHUTDOWN_RECEIVED = 7,
998 SCTP_SHUTDOWN_ACK_SENT = 8,
999};
1000
209ba424
WY		 1001/*
1002 * 8.2.6. Get the Current Identifiers of Associations
1003 * (SCTP_GET_ASSOC_ID_LIST)
1004 *
1005 * This option gets the current list of SCTP association identifiers of
1006 * the SCTP associations handled by a one-to-many style socket.
1007 */
1008struct sctp_assoc_ids {
1009 __u32 gaids_number_of_ids;
1010 sctp_assoc_t gaids_assoc_id[];
1011};
1012
1da177e4
LT		 1013/*
1014 * 8.3, 8.5 get all peer/local addresses in an association.
1b866434 1015 * This parameter struct is used by SCTP_GET_PEER_ADDRS and
1da177e4 1016 * SCTP_GET_LOCAL_ADDRS socket options used internally to implement
1b866434 1017 * sctp_getpaddrs() and sctp_getladdrs() API.
1da177e4 1018 */