Commit | Line | Data |
---|---|---|
60c778b2 | 1 | /* SCTP kernel implementation |
1da177e4 LT |
2 | * (C) Copyright IBM Corp. 2001, 2004 |
3 | * Copyright (c) 1999-2000 Cisco, Inc. | |
4 | * Copyright (c) 1999-2001 Motorola, Inc. | |
5 | * Copyright (c) 2002 Intel Corp. | |
6 | * | |
60c778b2 | 7 | * This file is part of the SCTP kernel implementation |
1da177e4 LT |
8 | * |
9 | * This header represents the structures and constants needed to support | |
10 | * the SCTP Extension to the Sockets API. | |
11 | * | |
60c778b2 | 12 | * This SCTP implementation is free software; |
1da177e4 LT |
13 | * you can redistribute it and/or modify it under the terms of |
14 | * the GNU General Public License as published by | |
15 | * the Free Software Foundation; either version 2, or (at your option) | |
16 | * any later version. | |
17 | * | |
60c778b2 | 18 | * This SCTP implementation is distributed in the hope that it |
1da177e4 LT |
19 | * will be useful, but WITHOUT ANY WARRANTY; without even the implied |
20 | * ************************ | |
21 | * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. | |
22 | * See the GNU General Public License for more details. | |
23 | * | |
24 | * You should have received a copy of the GNU General Public License | |
4b2f13a2 JK |
25 | * along with GNU CC; see the file COPYING. If not, see |
26 | * <http://www.gnu.org/licenses/>. | |
1da177e4 LT |
27 | * |
28 | * Please send any bug reports or fixes you make to the | |
29 | * email address(es): | |
91705c61 | 30 | * lksctp developers <linux-sctp@vger.kernel.org> |
1da177e4 LT |
31 | * |
32 | * Or submit a bug report through the following website: | |
33 | * http://www.sf.net/projects/lksctp | |
34 | * | |
35 | * Written or modified by: | |
36 | * La Monte H.P. Yarroll <piggy@acm.org> | |
37 | * R. Stewart <randall@sctp.chicago.il.us> | |
38 | * K. Morneau <kmorneau@cisco.com> | |
39 | * Q. Xie <qxie1@email.mot.com> | |
40 | * Karl Knutson <karl@athena.chicago.il.us> | |
41 | * Jon Grimm <jgrimm@us.ibm.com> | |
42 | * Daisy Chang <daisyc@us.ibm.com> | |
43 | * Ryan Layer <rmlayer@us.ibm.com> | |
1b866434 | 44 | * Ardelle Fan <ardelle.fan@intel.com> |
1da177e4 | 45 | * Sridhar Samudrala <sri@us.ibm.com> |
1b866434 DB |
46 | * Inaky Perez-Gonzalez <inaky.gonzalez@intel.com> |
47 | * Vlad Yasevich <vladislav.yasevich@hp.com> | |
1da177e4 LT |
48 | * |
49 | * Any bugs reported given to us we will try to fix... any fixes shared will | |
50 | * be incorporated into the next SCTP release. | |
51 | */ | |
52 | ||
1b866434 DB |
53 | #ifndef _UAPI_SCTP_H |
54 | #define _UAPI_SCTP_H | |
1da177e4 LT |
55 | |
56 | #include <linux/types.h> | |
57 | #include <linux/socket.h> | |
58 | ||
59 | typedef __s32 sctp_assoc_t; | |
60 | ||
61 | /* The following symbols come from the Sockets API Extensions for | |
62 | * SCTP <draft-ietf-tsvwg-sctpsocket-07.txt>. | |
63 | */ | |
a5b03ad2 VY |
64 | #define SCTP_RTOINFO 0 |
65 | #define SCTP_ASSOCINFO 1 | |
66 | #define SCTP_INITMSG 2 | |
67 | #define SCTP_NODELAY 3 /* Get/set nodelay option. */ | |
68 | #define SCTP_AUTOCLOSE 4 | |
69 | #define SCTP_SET_PEER_PRIMARY_ADDR 5 | |
70 | #define SCTP_PRIMARY_ADDR 6 | |
71 | #define SCTP_ADAPTATION_LAYER 7 | |
72 | #define SCTP_DISABLE_FRAGMENTS 8 | |
73 | #define SCTP_PEER_ADDR_PARAMS 9 | |
74 | #define SCTP_DEFAULT_SEND_PARAM 10 | |
75 | #define SCTP_EVENTS 11 | |
76 | #define SCTP_I_WANT_MAPPED_V4_ADDR 12 /* Turn on/off mapped v4 addresses */ | |
77 | #define SCTP_MAXSEG 13 /* Get/set maximum fragment. */ | |
78 | #define SCTP_STATUS 14 | |
79 | #define SCTP_GET_PEER_ADDR_INFO 15 | |
80 | #define SCTP_DELAYED_ACK_TIME 16 | |
81 | #define SCTP_DELAYED_ACK SCTP_DELAYED_ACK_TIME | |
4580ccc0 | 82 | #define SCTP_DELAYED_SACK SCTP_DELAYED_ACK_TIME |
a5b03ad2 VY |
83 | #define SCTP_CONTEXT 17 |
84 | #define SCTP_FRAGMENT_INTERLEAVE 18 | |
85 | #define SCTP_PARTIAL_DELIVERY_POINT 19 /* Set/Get partial delivery point */ | |
86 | #define SCTP_MAX_BURST 20 /* Set/Get max burst */ | |
87 | #define SCTP_AUTH_CHUNK 21 /* Set only: add a chunk type to authenticate */ | |
88 | #define SCTP_HMAC_IDENT 22 | |
89 | #define SCTP_AUTH_KEY 23 | |
90 | #define SCTP_AUTH_ACTIVE_KEY 24 | |
91 | #define SCTP_AUTH_DELETE_KEY 25 | |
92 | #define SCTP_PEER_AUTH_CHUNKS 26 /* Read only */ | |
93 | #define SCTP_LOCAL_AUTH_CHUNKS 27 /* Read only */ | |
94 | #define SCTP_GET_ASSOC_NUMBER 28 /* Read only */ | |
209ba424 | 95 | #define SCTP_GET_ASSOC_ID_LIST 29 /* Read only */ |
7dc04d71 | 96 | #define SCTP_AUTO_ASCONF 30 |
5aa93bcf | 97 | #define SCTP_PEER_ADDR_THLDS 31 |
0d3a421d | 98 | #define SCTP_RECVRCVINFO 32 |
2347c80f | 99 | #define SCTP_RECVNXTINFO 33 |
6b3fd5f3 | 100 | #define SCTP_DEFAULT_SNDINFO 34 |
65b07e5d | 101 | |
a5b03ad2 VY |
102 | /* Internal Socket Options. Some of the sctp library functions are |
103 | * implemented using these socket options. | |
104 | */ | |
105 | #define SCTP_SOCKOPT_BINDX_ADD 100 /* BINDX requests for adding addrs */ | |
106 | #define SCTP_SOCKOPT_BINDX_REM 101 /* BINDX requests for removing addrs. */ | |
107 | #define SCTP_SOCKOPT_PEELOFF 102 /* peel off association. */ | |
108 | /* Options 104-106 are deprecated and removed. Do not use this space */ | |
109 | #define SCTP_SOCKOPT_CONNECTX_OLD 107 /* CONNECTX old requests. */ | |
b595076a UKK |
110 | #define SCTP_GET_PEER_ADDRS 108 /* Get all peer address. */ |
111 | #define SCTP_GET_LOCAL_ADDRS 109 /* Get all local address. */ | |
a5b03ad2 VY |
112 | #define SCTP_SOCKOPT_CONNECTX 110 /* CONNECTX requests. */ |
113 | #define SCTP_SOCKOPT_CONNECTX3 111 /* CONNECTX requests (updated) */ | |
196d6759 | 114 | #define SCTP_GET_ASSOC_STATS 112 /* Read only */ |
28aa4c26 | 115 | #define SCTP_PR_SUPPORTED 113 |
1da177e4 | 116 | |
2347c80f GOV |
117 | /* These are bit fields for msghdr->msg_flags. See section 5.1. */ |
118 | /* On user space Linux, these live in <bits/socket.h> as an enum. */ | |
119 | enum sctp_msg_flags { | |
120 | MSG_NOTIFICATION = 0x8000, | |
121 | #define MSG_NOTIFICATION MSG_NOTIFICATION | |
122 | }; | |
123 | ||
0d3a421d | 124 | /* 5.3.1 SCTP Initiation Structure (SCTP_INIT) |
1da177e4 LT |
125 | * |
126 | * This cmsghdr structure provides information for initializing new | |
127 | * SCTP associations with sendmsg(). The SCTP_INITMSG socket option | |
128 | * uses this same data structure. This structure is not used for | |
129 | * recvmsg(). | |
130 | * | |
131 | * cmsg_level cmsg_type cmsg_data[] | |
132 | * ------------ ------------ ---------------------- | |
133 | * IPPROTO_SCTP SCTP_INIT struct sctp_initmsg | |
1da177e4 LT |
134 | */ |
135 | struct sctp_initmsg { | |
136 | __u16 sinit_num_ostreams; | |
137 | __u16 sinit_max_instreams; | |
138 | __u16 sinit_max_attempts; | |
139 | __u16 sinit_max_init_timeo; | |
140 | }; | |
141 | ||
0d3a421d | 142 | /* 5.3.2 SCTP Header Information Structure (SCTP_SNDRCV) |
1da177e4 LT |
143 | * |
144 | * This cmsghdr structure specifies SCTP options for sendmsg() and | |
145 | * describes SCTP header information about a received message through | |
146 | * recvmsg(). | |
147 | * | |
148 | * cmsg_level cmsg_type cmsg_data[] | |
149 | * ------------ ------------ ---------------------- | |
150 | * IPPROTO_SCTP SCTP_SNDRCV struct sctp_sndrcvinfo | |
1da177e4 LT |
151 | */ |
152 | struct sctp_sndrcvinfo { | |
153 | __u16 sinfo_stream; | |
154 | __u16 sinfo_ssn; | |
155 | __u16 sinfo_flags; | |
156 | __u32 sinfo_ppid; | |
157 | __u32 sinfo_context; | |
158 | __u32 sinfo_timetolive; | |
159 | __u32 sinfo_tsn; | |
160 | __u32 sinfo_cumtsn; | |
161 | sctp_assoc_t sinfo_assoc_id; | |
162 | }; | |
163 | ||
63b94938 GOV |
164 | /* 5.3.4 SCTP Send Information Structure (SCTP_SNDINFO) |
165 | * | |
166 | * This cmsghdr structure specifies SCTP options for sendmsg(). | |
167 | * | |
168 | * cmsg_level cmsg_type cmsg_data[] | |
169 | * ------------ ------------ ------------------- | |
170 | * IPPROTO_SCTP SCTP_SNDINFO struct sctp_sndinfo | |
171 | */ | |
172 | struct sctp_sndinfo { | |
173 | __u16 snd_sid; | |
174 | __u16 snd_flags; | |
175 | __u32 snd_ppid; | |
176 | __u32 snd_context; | |
177 | sctp_assoc_t snd_assoc_id; | |
178 | }; | |
179 | ||
0d3a421d GOV |
180 | /* 5.3.5 SCTP Receive Information Structure (SCTP_RCVINFO) |
181 | * | |
182 | * This cmsghdr structure describes SCTP receive information | |
183 | * about a received message through recvmsg(). | |
184 | * | |
185 | * cmsg_level cmsg_type cmsg_data[] | |
186 | * ------------ ------------ ------------------- | |
187 | * IPPROTO_SCTP SCTP_RCVINFO struct sctp_rcvinfo | |
188 | */ | |
189 | struct sctp_rcvinfo { | |
190 | __u16 rcv_sid; | |
191 | __u16 rcv_ssn; | |
192 | __u16 rcv_flags; | |
193 | __u32 rcv_ppid; | |
194 | __u32 rcv_tsn; | |
195 | __u32 rcv_cumtsn; | |
196 | __u32 rcv_context; | |
197 | sctp_assoc_t rcv_assoc_id; | |
198 | }; | |
199 | ||
2347c80f GOV |
200 | /* 5.3.6 SCTP Next Receive Information Structure (SCTP_NXTINFO) |
201 | * | |
202 | * This cmsghdr structure describes SCTP receive information | |
203 | * of the next message that will be delivered through recvmsg() | |
204 | * if this information is already available when delivering | |
205 | * the current message. | |
206 | * | |
207 | * cmsg_level cmsg_type cmsg_data[] | |
208 | * ------------ ------------ ------------------- | |
209 | * IPPROTO_SCTP SCTP_NXTINFO struct sctp_nxtinfo | |
210 | */ | |
211 | struct sctp_nxtinfo { | |
212 | __u16 nxt_sid; | |
213 | __u16 nxt_flags; | |
214 | __u32 nxt_ppid; | |
215 | __u32 nxt_length; | |
216 | sctp_assoc_t nxt_assoc_id; | |
217 | }; | |
218 | ||
1da177e4 LT |
219 | /* |
220 | * sinfo_flags: 16 bits (unsigned integer) | |
221 | * | |
222 | * This field may contain any of the following flags and is composed of | |
223 | * a bitwise OR of these values. | |
224 | */ | |
1da177e4 | 225 | enum sctp_sinfo_flags { |
2347c80f GOV |
226 | SCTP_UNORDERED = (1 << 0), /* Send/receive message unordered. */ |
227 | SCTP_ADDR_OVER = (1 << 1), /* Override the primary destination. */ | |
228 | SCTP_ABORT = (1 << 2), /* Send an ABORT message to the peer. */ | |
229 | SCTP_SACK_IMMEDIATELY = (1 << 3), /* SACK should be sent without delay. */ | |
230 | SCTP_NOTIFICATION = MSG_NOTIFICATION, /* Next message is not user msg but notification. */ | |
231 | SCTP_EOF = MSG_FIN, /* Initiate graceful shutdown process. */ | |
1da177e4 LT |
232 | }; |
233 | ||
1b866434 DB |
234 | typedef union { |
235 | __u8 raw; | |
236 | struct sctp_initmsg init; | |
237 | struct sctp_sndrcvinfo sndrcv; | |
238 | } sctp_cmsg_data_t; | |
1da177e4 | 239 | |
1da177e4 LT |
240 | /* These are cmsg_types. */ |
241 | typedef enum sctp_cmsg_type { | |
63b94938 | 242 | SCTP_INIT, /* 5.2.1 SCTP Initiation Structure */ |
1b866434 | 243 | #define SCTP_INIT SCTP_INIT |
63b94938 | 244 | SCTP_SNDRCV, /* 5.2.2 SCTP Header Information Structure */ |
1b866434 | 245 | #define SCTP_SNDRCV SCTP_SNDRCV |
63b94938 GOV |
246 | SCTP_SNDINFO, /* 5.3.4 SCTP Send Information Structure */ |
247 | #define SCTP_SNDINFO SCTP_SNDINFO | |
0d3a421d GOV |
248 | SCTP_RCVINFO, /* 5.3.5 SCTP Receive Information Structure */ |
249 | #define SCTP_RCVINFO SCTP_RCVINFO | |
2347c80f GOV |
250 | SCTP_NXTINFO, /* 5.3.6 SCTP Next Receive Information Structure */ |
251 | #define SCTP_NXTINFO SCTP_NXTINFO | |
1da177e4 LT |
252 | } sctp_cmsg_t; |
253 | ||
1da177e4 LT |
254 | /* |
255 | * 5.3.1.1 SCTP_ASSOC_CHANGE | |
256 | * | |
257 | * Communication notifications inform the ULP that an SCTP association | |
258 | * has either begun or ended. The identifier for a new association is | |
259 | * provided by this notificaion. The notification information has the | |
260 | * following format: | |
261 | * | |
262 | */ | |
263 | struct sctp_assoc_change { | |
264 | __u16 sac_type; | |
265 | __u16 sac_flags; | |
266 | __u32 sac_length; | |
267 | __u16 sac_state; | |
268 | __u16 sac_error; | |
269 | __u16 sac_outbound_streams; | |
270 | __u16 sac_inbound_streams; | |
271 | sctp_assoc_t sac_assoc_id; | |
a5a35e76 | 272 | __u8 sac_info[0]; |
1da177e4 LT |
273 | }; |
274 | ||
275 | /* | |
276 | * sac_state: 32 bits (signed integer) | |
277 | * | |
278 | * This field holds one of a number of values that communicate the | |
279 | * event that happened to the association. They include: | |
280 | * | |
281 | * Note: The following state names deviate from the API draft as | |
282 | * the names clash too easily with other kernel symbols. | |
283 | */ | |
284 | enum sctp_sac_state { | |
285 | SCTP_COMM_UP, | |
286 | SCTP_COMM_LOST, | |
287 | SCTP_RESTART, | |
288 | SCTP_SHUTDOWN_COMP, | |
289 | SCTP_CANT_STR_ASSOC, | |
290 | }; | |
291 | ||
292 | /* | |
293 | * 5.3.1.2 SCTP_PEER_ADDR_CHANGE | |
294 | * | |
295 | * When a destination address on a multi-homed peer encounters a change | |
296 | * an interface details event is sent. The information has the | |
297 | * following structure: | |
298 | */ | |
299 | struct sctp_paddr_change { | |
300 | __u16 spc_type; | |
301 | __u16 spc_flags; | |
302 | __u32 spc_length; | |
303 | struct sockaddr_storage spc_aaddr; | |
304 | int spc_state; | |
305 | int spc_error; | |
306 | sctp_assoc_t spc_assoc_id; | |
20c9c825 | 307 | } __attribute__((packed, aligned(4))); |
1da177e4 LT |
308 | |
309 | /* | |
310 | * spc_state: 32 bits (signed integer) | |
311 | * | |
312 | * This field holds one of a number of values that communicate the | |
313 | * event that happened to the address. They include: | |
314 | */ | |
315 | enum sctp_spc_state { | |
316 | SCTP_ADDR_AVAILABLE, | |
317 | SCTP_ADDR_UNREACHABLE, | |
318 | SCTP_ADDR_REMOVED, | |
319 | SCTP_ADDR_ADDED, | |
320 | SCTP_ADDR_MADE_PRIM, | |
1ae4114d | 321 | SCTP_ADDR_CONFIRMED, |
1da177e4 LT |
322 | }; |
323 | ||
324 | ||
325 | /* | |
326 | * 5.3.1.3 SCTP_REMOTE_ERROR | |
327 | * | |
328 | * A remote peer may send an Operational Error message to its peer. | |
329 | * This message indicates a variety of error conditions on an | |
330 | * association. The entire error TLV as it appears on the wire is | |
331 | * included in a SCTP_REMOTE_ERROR event. Please refer to the SCTP | |
332 | * specification [SCTP] and any extensions for a list of possible | |
333 | * error formats. SCTP error TLVs have the format: | |
334 | */ | |
335 | struct sctp_remote_error { | |
336 | __u16 sre_type; | |
337 | __u16 sre_flags; | |
338 | __u32 sre_length; | |
339 | __u16 sre_error; | |
340 | sctp_assoc_t sre_assoc_id; | |
341 | __u8 sre_data[0]; | |
342 | }; | |
343 | ||
344 | ||
345 | /* | |
346 | * 5.3.1.4 SCTP_SEND_FAILED | |
347 | * | |
348 | * If SCTP cannot deliver a message it may return the message as a | |
349 | * notification. | |
350 | */ | |
351 | struct sctp_send_failed { | |
352 | __u16 ssf_type; | |
353 | __u16 ssf_flags; | |
354 | __u32 ssf_length; | |
355 | __u32 ssf_error; | |
356 | struct sctp_sndrcvinfo ssf_info; | |
357 | sctp_assoc_t ssf_assoc_id; | |
358 | __u8 ssf_data[0]; | |
359 | }; | |
360 | ||
361 | /* | |
362 | * ssf_flags: 16 bits (unsigned integer) | |
363 | * | |
364 | * The flag value will take one of the following values | |
365 | * | |
366 | * SCTP_DATA_UNSENT - Indicates that the data was never put on | |
367 | * the wire. | |
368 | * | |
369 | * SCTP_DATA_SENT - Indicates that the data was put on the wire. | |
370 | * Note that this does not necessarily mean that the | |
371 | * data was (or was not) successfully delivered. | |
372 | */ | |
373 | enum sctp_ssf_flags { | |
374 | SCTP_DATA_UNSENT, | |
375 | SCTP_DATA_SENT, | |
376 | }; | |
377 | ||
378 | /* | |
379 | * 5.3.1.5 SCTP_SHUTDOWN_EVENT | |
380 | * | |
381 | * When a peer sends a SHUTDOWN, SCTP delivers this notification to | |
382 | * inform the application that it should cease sending data. | |
383 | */ | |
384 | struct sctp_shutdown_event { | |
385 | __u16 sse_type; | |
386 | __u16 sse_flags; | |
387 | __u32 sse_length; | |
388 | sctp_assoc_t sse_assoc_id; | |
389 | }; | |
390 | ||
391 | /* | |
0f3fffd8 | 392 | * 5.3.1.6 SCTP_ADAPTATION_INDICATION |
1da177e4 | 393 | * |
0f3fffd8 | 394 | * When a peer sends a Adaptation Layer Indication parameter , SCTP |
1da177e4 | 395 | * delivers this notification to inform the application |
0f3fffd8 | 396 | * that of the peers requested adaptation layer. |
1da177e4 | 397 | */ |
0f3fffd8 | 398 | struct sctp_adaptation_event { |
1da177e4 LT |
399 | __u16 sai_type; |
400 | __u16 sai_flags; | |
401 | __u32 sai_length; | |
0f3fffd8 | 402 | __u32 sai_adaptation_ind; |
1da177e4 LT |
403 | sctp_assoc_t sai_assoc_id; |
404 | }; | |
405 | ||
406 | /* | |
407 | * 5.3.1.7 SCTP_PARTIAL_DELIVERY_EVENT | |
408 | * | |
409 | * When a receiver is engaged in a partial delivery of a | |
410 | * message this notification will be used to indicate | |
411 | * various events. | |
412 | */ | |
413 | struct sctp_pdapi_event { | |
414 | __u16 pdapi_type; | |
415 | __u16 pdapi_flags; | |
416 | __u32 pdapi_length; | |
417 | __u32 pdapi_indication; | |
418 | sctp_assoc_t pdapi_assoc_id; | |
419 | }; | |
420 | ||
421 | enum { SCTP_PARTIAL_DELIVERY_ABORTED=0, }; | |
422 | ||
1b866434 DB |
423 | /* |
424 | * 5.3.1.8. SCTP_AUTHENTICATION_EVENT | |
425 | * | |
426 | * When a receiver is using authentication this message will provide | |
427 | * notifications regarding new keys being made active as well as errors. | |
428 | */ | |
65b07e5d VY |
429 | struct sctp_authkey_event { |
430 | __u16 auth_type; | |
431 | __u16 auth_flags; | |
432 | __u32 auth_length; | |
433 | __u16 auth_keynumber; | |
434 | __u16 auth_altkeynumber; | |
435 | __u32 auth_indication; | |
436 | sctp_assoc_t auth_assoc_id; | |
437 | }; | |
438 | ||
439 | enum { SCTP_AUTH_NEWKEY = 0, }; | |
440 | ||
e1cdd553 WY |
441 | /* |
442 | * 6.1.9. SCTP_SENDER_DRY_EVENT | |
443 | * | |
444 | * When the SCTP stack has no more user data to send or retransmit, this | |
445 | * notification is given to the user. Also, at the time when a user app | |
446 | * subscribes to this event, if there is no data to be sent or | |
447 | * retransmit, the stack will immediately send up this notification. | |
448 | */ | |
449 | struct sctp_sender_dry_event { | |
450 | __u16 sender_dry_type; | |
451 | __u16 sender_dry_flags; | |
452 | __u32 sender_dry_length; | |
453 | sctp_assoc_t sender_dry_assoc_id; | |
454 | }; | |
65b07e5d | 455 | |
1da177e4 LT |
456 | /* |
457 | * Described in Section 7.3 | |
458 | * Ancillary Data and Notification Interest Options | |
459 | */ | |
460 | struct sctp_event_subscribe { | |
461 | __u8 sctp_data_io_event; | |
462 | __u8 sctp_association_event; | |
463 | __u8 sctp_address_event; | |
464 | __u8 sctp_send_failure_event; | |
465 | __u8 sctp_peer_error_event; | |
466 | __u8 sctp_shutdown_event; | |
467 | __u8 sctp_partial_delivery_event; | |
0f3fffd8 | 468 | __u8 sctp_adaptation_layer_event; |
7e8616d8 | 469 | __u8 sctp_authentication_event; |
e1cdd553 | 470 | __u8 sctp_sender_dry_event; |
1da177e4 LT |
471 | }; |
472 | ||
473 | /* | |
474 | * 5.3.1 SCTP Notification Structure | |
475 | * | |
476 | * The notification structure is defined as the union of all | |
477 | * notification types. | |
478 | * | |
479 | */ | |
480 | union sctp_notification { | |
481 | struct { | |
482 | __u16 sn_type; /* Notification type. */ | |
483 | __u16 sn_flags; | |
484 | __u32 sn_length; | |
485 | } sn_header; | |
486 | struct sctp_assoc_change sn_assoc_change; | |
487 | struct sctp_paddr_change sn_paddr_change; | |
488 | struct sctp_remote_error sn_remote_error; | |
489 | struct sctp_send_failed sn_send_failed; | |
490 | struct sctp_shutdown_event sn_shutdown_event; | |
0f3fffd8 | 491 | struct sctp_adaptation_event sn_adaptation_event; |
1da177e4 | 492 | struct sctp_pdapi_event sn_pdapi_event; |
65b07e5d | 493 | struct sctp_authkey_event sn_authkey_event; |
e1cdd553 | 494 | struct sctp_sender_dry_event sn_sender_dry_event; |
1da177e4 LT |
495 | }; |
496 | ||
497 | /* Section 5.3.1 | |
498 | * All standard values for sn_type flags are greater than 2^15. | |
499 | * Values from 2^15 and down are reserved. | |
500 | */ | |
501 | ||
502 | enum sctp_sn_type { | |
503 | SCTP_SN_TYPE_BASE = (1<<15), | |
504 | SCTP_ASSOC_CHANGE, | |
1b866434 | 505 | #define SCTP_ASSOC_CHANGE SCTP_ASSOC_CHANGE |
1da177e4 | 506 | SCTP_PEER_ADDR_CHANGE, |
1b866434 | 507 | #define SCTP_PEER_ADDR_CHANGE SCTP_PEER_ADDR_CHANGE |
1da177e4 | 508 | SCTP_SEND_FAILED, |
1b866434 | 509 | #define SCTP_SEND_FAILED SCTP_SEND_FAILED |
1da177e4 | 510 | SCTP_REMOTE_ERROR, |
1b866434 | 511 | #define SCTP_REMOTE_ERROR SCTP_REMOTE_ERROR |
1da177e4 | 512 | SCTP_SHUTDOWN_EVENT, |
1b866434 | 513 | #define SCTP_SHUTDOWN_EVENT SCTP_SHUTDOWN_EVENT |
1da177e4 | 514 | SCTP_PARTIAL_DELIVERY_EVENT, |
1b866434 | 515 | #define SCTP_PARTIAL_DELIVERY_EVENT SCTP_PARTIAL_DELIVERY_EVENT |
0f3fffd8 | 516 | SCTP_ADAPTATION_INDICATION, |
1b866434 | 517 | #define SCTP_ADAPTATION_INDICATION SCTP_ADAPTATION_INDICATION |
ee916fd0 WY |
518 | SCTP_AUTHENTICATION_EVENT, |
519 | #define SCTP_AUTHENTICATION_INDICATION SCTP_AUTHENTICATION_EVENT | |
e1cdd553 | 520 | SCTP_SENDER_DRY_EVENT, |
1b866434 | 521 | #define SCTP_SENDER_DRY_EVENT SCTP_SENDER_DRY_EVENT |
1da177e4 LT |
522 | }; |
523 | ||
524 | /* Notification error codes used to fill up the error fields in some | |
525 | * notifications. | |
526 | * SCTP_PEER_ADDRESS_CHAGE : spc_error | |
527 | * SCTP_ASSOC_CHANGE : sac_error | |
528 | * These names should be potentially included in the draft 04 of the SCTP | |
529 | * sockets API specification. | |
530 | */ | |
531 | typedef enum sctp_sn_error { | |
532 | SCTP_FAILED_THRESHOLD, | |
533 | SCTP_RECEIVED_SACK, | |
534 | SCTP_HEARTBEAT_SUCCESS, | |
535 | SCTP_RESPONSE_TO_USER_REQ, | |
536 | SCTP_INTERNAL_ERROR, | |
537 | SCTP_SHUTDOWN_GUARD_EXPIRES, | |
538 | SCTP_PEER_FAULTY, | |
539 | } sctp_sn_error_t; | |
540 | ||
541 | /* | |
542 | * 7.1.1 Retransmission Timeout Parameters (SCTP_RTOINFO) | |
543 | * | |
544 | * The protocol parameters used to initialize and bound retransmission | |
545 | * timeout (RTO) are tunable. See [SCTP] for more information on how | |
1b866434 | 546 | * these parameters are used in RTO calculation. |
1da177e4 LT |
547 | */ |
548 | struct sctp_rtoinfo { | |
549 | sctp_assoc_t srto_assoc_id; | |
550 | __u32 srto_initial; | |
551 | __u32 srto_max; | |
552 | __u32 srto_min; | |
553 | }; | |
554 | ||
555 | /* | |
556 | * 7.1.2 Association Parameters (SCTP_ASSOCINFO) | |
557 | * | |
558 | * This option is used to both examine and set various association and | |
559 | * endpoint parameters. | |
560 | */ | |
561 | struct sctp_assocparams { | |
562 | sctp_assoc_t sasoc_assoc_id; | |
563 | __u16 sasoc_asocmaxrxt; | |
564 | __u16 sasoc_number_peer_destinations; | |
565 | __u32 sasoc_peer_rwnd; | |
566 | __u32 sasoc_local_rwnd; | |
567 | __u32 sasoc_cookie_life; | |
568 | }; | |
569 | ||
570 | /* | |
571 | * 7.1.9 Set Peer Primary Address (SCTP_SET_PEER_PRIMARY_ADDR) | |
572 | * | |
573 | * Requests that the peer mark the enclosed address as the association | |
574 | * primary. The enclosed address must be one of the association's | |
575 | * locally bound addresses. The following structure is used to make a | |
576 | * set primary request: | |
577 | */ | |
578 | struct sctp_setpeerprim { | |
579 | sctp_assoc_t sspp_assoc_id; | |
580 | struct sockaddr_storage sspp_addr; | |
20c9c825 | 581 | } __attribute__((packed, aligned(4))); |
1da177e4 LT |
582 | |
583 | /* | |
584 | * 7.1.10 Set Primary Address (SCTP_PRIMARY_ADDR) | |
585 | * | |
586 | * Requests that the local SCTP stack use the enclosed peer address as | |
587 | * the association primary. The enclosed address must be one of the | |
588 | * association peer's addresses. The following structure is used to | |
589 | * make a set peer primary request: | |
590 | */ | |
591 | struct sctp_prim { | |
592 | sctp_assoc_t ssp_assoc_id; | |
593 | struct sockaddr_storage ssp_addr; | |
20c9c825 | 594 | } __attribute__((packed, aligned(4))); |
1da177e4 | 595 | |
1b866434 DB |
596 | /* For backward compatibility use, define the old name too */ |
597 | #define sctp_setprim sctp_prim | |
598 | ||
1da177e4 | 599 | /* |
0f3fffd8 | 600 | * 7.1.11 Set Adaptation Layer Indicator (SCTP_ADAPTATION_LAYER) |
1da177e4 | 601 | * |
0f3fffd8 | 602 | * Requests that the local endpoint set the specified Adaptation Layer |
1da177e4 LT |
603 | * Indication parameter for all future INIT and INIT-ACK exchanges. |
604 | */ | |
0f3fffd8 ISJ |
605 | struct sctp_setadaptation { |
606 | __u32 ssb_adaptation_ind; | |
1da177e4 LT |
607 | }; |
608 | ||
609 | /* | |
610 | * 7.1.13 Peer Address Parameters (SCTP_PEER_ADDR_PARAMS) | |
611 | * | |
612 | * Applications can enable or disable heartbeats for any peer address | |
613 | * of an association, modify an address's heartbeat interval, force a | |
614 | * heartbeat to be sent immediately, and adjust the address's maximum | |
615 | * number of retransmissions sent before an address is considered | |
616 | * unreachable. The following structure is used to access and modify an | |
617 | * address's parameters: | |
618 | */ | |
52ccb8e9 | 619 | enum sctp_spp_flags { |
bdf3092a VY |
620 | SPP_HB_ENABLE = 1<<0, /*Enable heartbeats*/ |
621 | SPP_HB_DISABLE = 1<<1, /*Disable heartbeats*/ | |
52ccb8e9 | 622 | SPP_HB = SPP_HB_ENABLE | SPP_HB_DISABLE, |
bdf3092a VY |
623 | SPP_HB_DEMAND = 1<<2, /*Send heartbeat immediately*/ |
624 | SPP_PMTUD_ENABLE = 1<<3, /*Enable PMTU discovery*/ | |
625 | SPP_PMTUD_DISABLE = 1<<4, /*Disable PMTU discovery*/ | |
52ccb8e9 | 626 | SPP_PMTUD = SPP_PMTUD_ENABLE | SPP_PMTUD_DISABLE, |
bdf3092a VY |
627 | SPP_SACKDELAY_ENABLE = 1<<5, /*Enable SACK*/ |
628 | SPP_SACKDELAY_DISABLE = 1<<6, /*Disable SACK*/ | |
52ccb8e9 | 629 | SPP_SACKDELAY = SPP_SACKDELAY_ENABLE | SPP_SACKDELAY_DISABLE, |
bdf3092a | 630 | SPP_HB_TIME_IS_ZERO = 1<<7, /* Set HB delay to 0 */ |
52ccb8e9 FF |
631 | }; |
632 | ||
1da177e4 LT |
633 | struct sctp_paddrparams { |
634 | sctp_assoc_t spp_assoc_id; | |
635 | struct sockaddr_storage spp_address; | |
636 | __u32 spp_hbinterval; | |
637 | __u16 spp_pathmaxrxt; | |
52ccb8e9 FF |
638 | __u32 spp_pathmtu; |
639 | __u32 spp_sackdelay; | |
640 | __u32 spp_flags; | |
20c9c825 | 641 | } __attribute__((packed, aligned(4))); |
1da177e4 | 642 | |
65b07e5d VY |
643 | /* |
644 | * 7.1.18. Add a chunk that must be authenticated (SCTP_AUTH_CHUNK) | |
645 | * | |
646 | * This set option adds a chunk type that the user is requesting to be | |
647 | * received only in an authenticated way. Changes to the list of chunks | |
648 | * will only effect future associations on the socket. | |
649 | */ | |
650 | struct sctp_authchunk { | |
651 | __u8 sauth_chunk; | |
652 | }; | |
653 | ||
654 | /* | |
655 | * 7.1.19. Get or set the list of supported HMAC Identifiers (SCTP_HMAC_IDENT) | |
656 | * | |
657 | * This option gets or sets the list of HMAC algorithms that the local | |
658 | * endpoint requires the peer to use. | |
1b866434 DB |
659 | */ |
660 | #ifndef __KERNEL__ | |
661 | /* This here is only used by user space as is. It might not be a good idea | |
662 | * to export/reveal the whole structure with reserved fields etc. | |
663 | */ | |
664 | enum { | |
665 | SCTP_AUTH_HMAC_ID_SHA1 = 1, | |
666 | SCTP_AUTH_HMAC_ID_SHA256 = 3, | |
667 | }; | |
668 | #endif | |
669 | ||
65b07e5d | 670 | struct sctp_hmacalgo { |
7e8616d8 | 671 | __u32 shmac_num_idents; |
65b07e5d VY |
672 | __u16 shmac_idents[]; |
673 | }; | |
674 | ||
1b866434 DB |
675 | /* Sadly, user and kernel space have different names for |
676 | * this structure member, so this is to not break anything. | |
677 | */ | |
678 | #define shmac_number_of_idents shmac_num_idents | |
679 | ||
65b07e5d VY |
680 | /* |
681 | * 7.1.20. Set a shared key (SCTP_AUTH_KEY) | |
682 | * | |
683 | * This option will set a shared secret key which is used to build an | |
684 | * association shared key. | |
685 | */ | |
686 | struct sctp_authkey { | |
687 | sctp_assoc_t sca_assoc_id; | |
688 | __u16 sca_keynumber; | |
7e8616d8 | 689 | __u16 sca_keylength; |
65b07e5d VY |
690 | __u8 sca_key[]; |
691 | }; | |
692 | ||
693 | /* | |
694 | * 7.1.21. Get or set the active shared key (SCTP_AUTH_ACTIVE_KEY) | |
695 | * | |
696 | * This option will get or set the active shared key to be used to build | |
697 | * the association shared key. | |
698 | */ | |
699 | ||
700 | struct sctp_authkeyid { | |
701 | sctp_assoc_t scact_assoc_id; | |
702 | __u16 scact_keynumber; | |
703 | }; | |
704 | ||
705 | ||
d364d927 WY |
706 | /* |
707 | * 7.1.23. Get or set delayed ack timer (SCTP_DELAYED_SACK) | |
708 | * | |
709 | * This option will effect the way delayed acks are performed. This | |
710 | * option allows you to get or set the delayed ack time, in | |
711 | * milliseconds. It also allows changing the delayed ack frequency. | |
712 | * Changing the frequency to 1 disables the delayed sack algorithm. If | |
713 | * the assoc_id is 0, then this sets or gets the endpoints default | |
714 | * values. If the assoc_id field is non-zero, then the set or get | |
715 | * effects the specified association for the one to many model (the | |
716 | * assoc_id field is ignored by the one to one model). Note that if | |
717 | * sack_delay or sack_freq are 0 when setting this option, then the | |
718 | * current values will remain unchanged. | |
7708610b | 719 | */ |
d364d927 WY |
720 | struct sctp_sack_info { |
721 | sctp_assoc_t sack_assoc_id; | |
722 | uint32_t sack_delay; | |
723 | uint32_t sack_freq; | |
724 | }; | |
725 | ||
7708610b FF |
726 | struct sctp_assoc_value { |
727 | sctp_assoc_t assoc_id; | |
728 | uint32_t assoc_value; | |
729 | }; | |
730 | ||
1da177e4 LT |
731 | /* |
732 | * 7.2.2 Peer Address Information | |
733 | * | |
734 | * Applications can retrieve information about a specific peer address | |
735 | * of an association, including its reachability state, congestion | |
736 | * window, and retransmission timer values. This information is | |
737 | * read-only. The following structure is used to access this | |
738 | * information: | |
739 | */ | |
740 | struct sctp_paddrinfo { | |
741 | sctp_assoc_t spinfo_assoc_id; | |
742 | struct sockaddr_storage spinfo_address; | |
743 | __s32 spinfo_state; | |
744 | __u32 spinfo_cwnd; | |
745 | __u32 spinfo_srtt; | |
746 | __u32 spinfo_rto; | |
747 | __u32 spinfo_mtu; | |
20c9c825 | 748 | } __attribute__((packed, aligned(4))); |
1da177e4 LT |
749 | |
750 | /* Peer addresses's state. */ | |
ad8fec17 SS |
751 | /* UNKNOWN: Peer address passed by the upper layer in sendmsg or connect[x] |
752 | * calls. | |
753 | * UNCONFIRMED: Peer address received in INIT/INIT-ACK address parameters. | |
754 | * Not yet confirmed by a heartbeat and not available for data | |
755 | * transfers. | |
756 | * ACTIVE : Peer address confirmed, active and available for data transfers. | |
757 | * INACTIVE: Peer address inactive and not available for data transfers. | |
758 | */ | |
1da177e4 LT |
759 | enum sctp_spinfo_state { |
760 | SCTP_INACTIVE, | |
5aa93bcf | 761 | SCTP_PF, |
1da177e4 | 762 | SCTP_ACTIVE, |
ad8fec17 | 763 | SCTP_UNCONFIRMED, |
3f7a87d2 | 764 | SCTP_UNKNOWN = 0xffff /* Value used for transport state unknown */ |
1da177e4 LT |
765 | }; |
766 | ||
767 | /* | |
768 | * 7.2.1 Association Status (SCTP_STATUS) | |
769 | * | |
770 | * Applications can retrieve current status information about an | |
771 | * association, including association state, peer receiver window size, | |
772 | * number of unacked data chunks, and number of data chunks pending | |
773 | * receipt. This information is read-only. The following structure is | |
774 | * used to access this information: | |
775 | */ | |
776 | struct sctp_status { | |
777 | sctp_assoc_t sstat_assoc_id; | |
778 | __s32 sstat_state; | |
779 | __u32 sstat_rwnd; | |
780 | __u16 sstat_unackdata; | |
781 | __u16 sstat_penddata; | |
782 | __u16 sstat_instrms; | |
783 | __u16 sstat_outstrms; | |
784 | __u32 sstat_fragmentation_point; | |
785 | struct sctp_paddrinfo sstat_primary; | |
786 | }; | |
787 | ||
65b07e5d VY |
788 | /* |
789 | * 7.2.3. Get the list of chunks the peer requires to be authenticated | |
790 | * (SCTP_PEER_AUTH_CHUNKS) | |
791 | * | |
792 | * This option gets a list of chunks for a specified association that | |
793 | * the peer requires to be received authenticated only. | |
794 | */ | |
795 | struct sctp_authchunks { | |
7e8616d8 VY |
796 | sctp_assoc_t gauth_assoc_id; |
797 | __u32 gauth_number_of_chunks; | |
798 | uint8_t gauth_chunks[]; | |
65b07e5d VY |
799 | }; |
800 | ||
1b866434 DB |
801 | /* The broken spelling has been released already in lksctp-tools header, |
802 | * so don't break anyone, now that it's fixed. | |
803 | */ | |
804 | #define guth_number_of_chunks gauth_number_of_chunks | |
805 | ||
806 | /* Association states. */ | |
807 | enum sctp_sstat_state { | |
808 | SCTP_EMPTY = 0, | |
809 | SCTP_CLOSED = 1, | |
810 | SCTP_COOKIE_WAIT = 2, | |
811 | SCTP_COOKIE_ECHOED = 3, | |
812 | SCTP_ESTABLISHED = 4, | |
813 | SCTP_SHUTDOWN_PENDING = 5, | |
814 | SCTP_SHUTDOWN_SENT = 6, | |
815 | SCTP_SHUTDOWN_RECEIVED = 7, | |
816 | SCTP_SHUTDOWN_ACK_SENT = 8, | |
817 | }; | |
818 | ||
209ba424 WY |
819 | /* |
820 | * 8.2.6. Get the Current Identifiers of Associations | |
821 | * (SCTP_GET_ASSOC_ID_LIST) | |
822 | * | |
823 | * This option gets the current list of SCTP association identifiers of | |
824 | * the SCTP associations handled by a one-to-many style socket. | |
825 | */ | |
826 | struct sctp_assoc_ids { | |
827 | __u32 gaids_number_of_ids; | |
828 | sctp_assoc_t gaids_assoc_id[]; | |
829 | }; | |
830 | ||
1da177e4 LT |
831 | /* |
832 | * 8.3, 8.5 get all peer/local addresses in an association. | |
1b866434 | 833 | * This parameter struct is used by SCTP_GET_PEER_ADDRS and |
1da177e4 | 834 | * SCTP_GET_LOCAL_ADDRS socket options used internally to implement |
1b866434 | 835 | * sctp_getpaddrs() and sctp_getladdrs() API. |
1da177e4 | 836 | */ |