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