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