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