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