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