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