blob: 1b3153c2cdf0d65f0c9fed6bbef4c39abdc78a63 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/* SCTP kernel reference Implementation
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 *
7 * This file is part of the SCTP kernel reference Implementation
8 *
9 * This header represents the structures and constants needed to support
10 * the SCTP Extension to the Sockets API.
11 *
12 * The SCTP reference implementation is free software;
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 *
18 * The SCTP reference implementation is distributed in the hope that it
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
25 * along with GNU CC; see the file COPYING. If not, write to
26 * the Free Software Foundation, 59 Temple Place - Suite 330,
27 * Boston, MA 02111-1307, USA.
28 *
29 * Please send any bug reports or fixes you make to the
30 * email address(es):
31 * lksctp developers <lksctp-developers@lists.sourceforge.net>
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 *
48 * Any bugs reported given to us we will try to fix... any fixes shared will
49 * be incorporated into the next SCTP release.
50 */
51
52#ifndef __net_sctp_user_h__
53#define __net_sctp_user_h__
54
55#include <linux/types.h>
56#include <linux/socket.h>
57
58typedef __s32 sctp_assoc_t;
59
60/* The following symbols come from the Sockets API Extensions for
61 * SCTP <draft-ietf-tsvwg-sctpsocket-07.txt>.
62 */
63enum sctp_optname {
64 SCTP_RTOINFO,
65#define SCTP_RTOINFO SCTP_RTOINFO
66 SCTP_ASSOCINFO,
67#define SCTP_ASSOCINFO SCTP_ASSOCINFO
68 SCTP_INITMSG,
69#define SCTP_INITMSG SCTP_INITMSG
70 SCTP_NODELAY, /* Get/set nodelay option. */
71#define SCTP_NODELAY SCTP_NODELAY
72 SCTP_AUTOCLOSE,
73#define SCTP_AUTOCLOSE SCTP_AUTOCLOSE
74 SCTP_SET_PEER_PRIMARY_ADDR,
75#define SCTP_SET_PEER_PRIMARY_ADDR SCTP_SET_PEER_PRIMARY_ADDR
76 SCTP_PRIMARY_ADDR,
77#define SCTP_PRIMARY_ADDR SCTP_PRIMARY_ADDR
Ivan Skytte Jorgensen0f3fffd2006-12-20 16:07:04 -080078 SCTP_ADAPTATION_LAYER,
79#define SCTP_ADAPTATION_LAYER SCTP_ADAPTATION_LAYER
Linus Torvalds1da177e2005-04-16 15:20:36 -070080 SCTP_DISABLE_FRAGMENTS,
81#define SCTP_DISABLE_FRAGMENTS SCTP_DISABLE_FRAGMENTS
82 SCTP_PEER_ADDR_PARAMS,
83#define SCTP_PEER_ADDR_PARAMS SCTP_PEER_ADDR_PARAMS
84 SCTP_DEFAULT_SEND_PARAM,
85#define SCTP_DEFAULT_SEND_PARAM SCTP_DEFAULT_SEND_PARAM
86 SCTP_EVENTS,
87#define SCTP_EVENTS SCTP_EVENTS
88 SCTP_I_WANT_MAPPED_V4_ADDR, /* Turn on/off mapped v4 addresses */
89#define SCTP_I_WANT_MAPPED_V4_ADDR SCTP_I_WANT_MAPPED_V4_ADDR
90 SCTP_MAXSEG, /* Get/set maximum fragment. */
91#define SCTP_MAXSEG SCTP_MAXSEG
92 SCTP_STATUS,
93#define SCTP_STATUS SCTP_STATUS
94 SCTP_GET_PEER_ADDR_INFO,
95#define SCTP_GET_PEER_ADDR_INFO SCTP_GET_PEER_ADDR_INFO
Frank Filz77086102005-12-22 11:37:30 -080096 SCTP_DELAYED_ACK_TIME,
97#define SCTP_DELAYED_ACK_TIME SCTP_DELAYED_ACK_TIME
Ivan Skytte Jorgensen6ab792f2006-12-13 16:34:22 -080098 SCTP_CONTEXT, /* Receive Context */
99#define SCTP_CONTEXT SCTP_CONTEXT
Vlad Yasevichb6e13312007-04-20 12:23:15 -0700100 SCTP_FRAGMENT_INTERLEAVE,
101#define SCTP_FRAGMENT_INTERLEAVE SCTP_FRAGMENT_INTERLEAVE
Vlad Yasevichd49d91d2007-03-23 11:32:00 -0700102 SCTP_PARTIAL_DELIVERY_POINT, /* Set/Get partial delivery point */
103#define SCTP_PARTIAL_DELIVERY_POINT SCTP_PARTIAL_DELIVERY_POINT
Linus Torvalds1da177e2005-04-16 15:20:36 -0700104
105 /* Internal Socket Options. Some of the sctp library functions are
106 * implemented using these socket options.
107 */
108 SCTP_SOCKOPT_BINDX_ADD = 100,/* BINDX requests for adding addresses. */
109#define SCTP_SOCKOPT_BINDX_ADD SCTP_SOCKOPT_BINDX_ADD
110 SCTP_SOCKOPT_BINDX_REM, /* BINDX requests for removing addresses. */
111#define SCTP_SOCKOPT_BINDX_REM SCTP_SOCKOPT_BINDX_REM
112 SCTP_SOCKOPT_PEELOFF, /* peel off association. */
113#define SCTP_SOCKOPT_PEELOFF SCTP_SOCKOPT_PEELOFF
Ivan Skytte Jørgensen5fe467e2005-10-06 21:36:17 -0700114 SCTP_GET_PEER_ADDRS_NUM_OLD, /* Get number of peer addresss. */
115#define SCTP_GET_PEER_ADDRS_NUM_OLD SCTP_GET_PEER_ADDRS_NUM_OLD
116 SCTP_GET_PEER_ADDRS_OLD, /* Get all peer addresss. */
117#define SCTP_GET_PEER_ADDRS_OLD SCTP_GET_PEER_ADDRS_OLD
118 SCTP_GET_LOCAL_ADDRS_NUM_OLD, /* Get number of local addresss. */
119#define SCTP_GET_LOCAL_ADDRS_NUM_OLD SCTP_GET_LOCAL_ADDRS_NUM_OLD
120 SCTP_GET_LOCAL_ADDRS_OLD, /* Get all local addresss. */
121#define SCTP_GET_LOCAL_ADDRS_OLD SCTP_GET_LOCAL_ADDRS_OLD
Frank Filz3f7a87d2005-06-20 13:14:57 -0700122 SCTP_SOCKOPT_CONNECTX, /* CONNECTX requests. */
123#define SCTP_SOCKOPT_CONNECTX SCTP_SOCKOPT_CONNECTX
Ivan Skytte Jørgensen5fe467e2005-10-06 21:36:17 -0700124 SCTP_GET_PEER_ADDRS, /* Get all peer addresss. */
125#define SCTP_GET_PEER_ADDRS SCTP_GET_PEER_ADDRS
126 SCTP_GET_LOCAL_ADDRS, /* Get all local addresss. */
127#define SCTP_GET_LOCAL_ADDRS SCTP_GET_LOCAL_ADDRS
Linus Torvalds1da177e2005-04-16 15:20:36 -0700128};
129
130/*
131 * 5.2.1 SCTP Initiation Structure (SCTP_INIT)
132 *
133 * This cmsghdr structure provides information for initializing new
134 * SCTP associations with sendmsg(). The SCTP_INITMSG socket option
135 * uses this same data structure. This structure is not used for
136 * recvmsg().
137 *
138 * cmsg_level cmsg_type cmsg_data[]
139 * ------------ ------------ ----------------------
140 * IPPROTO_SCTP SCTP_INIT struct sctp_initmsg
141 *
142 */
143struct sctp_initmsg {
144 __u16 sinit_num_ostreams;
145 __u16 sinit_max_instreams;
146 __u16 sinit_max_attempts;
147 __u16 sinit_max_init_timeo;
148};
149
150/*
151 * 5.2.2 SCTP Header Information Structure (SCTP_SNDRCV)
152 *
153 * This cmsghdr structure specifies SCTP options for sendmsg() and
154 * describes SCTP header information about a received message through
155 * recvmsg().
156 *
157 * cmsg_level cmsg_type cmsg_data[]
158 * ------------ ------------ ----------------------
159 * IPPROTO_SCTP SCTP_SNDRCV struct sctp_sndrcvinfo
160 *
161 */
162struct sctp_sndrcvinfo {
163 __u16 sinfo_stream;
164 __u16 sinfo_ssn;
165 __u16 sinfo_flags;
166 __u32 sinfo_ppid;
167 __u32 sinfo_context;
168 __u32 sinfo_timetolive;
169 __u32 sinfo_tsn;
170 __u32 sinfo_cumtsn;
171 sctp_assoc_t sinfo_assoc_id;
172};
173
174/*
175 * sinfo_flags: 16 bits (unsigned integer)
176 *
177 * This field may contain any of the following flags and is composed of
178 * a bitwise OR of these values.
179 */
180
181enum sctp_sinfo_flags {
Ivan Skytte Jorgenseneaa5c542005-10-28 15:10:00 -0700182 SCTP_UNORDERED = 1, /* Send/receive message unordered. */
183 SCTP_ADDR_OVER = 2, /* Override the primary destination. */
184 SCTP_ABORT=4, /* Send an ABORT message to the peer. */
185 SCTP_EOF=MSG_FIN, /* Initiate graceful shutdown process. */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700186};
187
188
189typedef union {
190 __u8 raw;
191 struct sctp_initmsg init;
192 struct sctp_sndrcvinfo sndrcv;
193} sctp_cmsg_data_t;
194
195/* These are cmsg_types. */
196typedef enum sctp_cmsg_type {
197 SCTP_INIT, /* 5.2.1 SCTP Initiation Structure */
198 SCTP_SNDRCV, /* 5.2.2 SCTP Header Information Structure */
199} sctp_cmsg_t;
200
201
202/*
203 * 5.3.1.1 SCTP_ASSOC_CHANGE
204 *
205 * Communication notifications inform the ULP that an SCTP association
206 * has either begun or ended. The identifier for a new association is
207 * provided by this notificaion. The notification information has the
208 * following format:
209 *
210 */
211struct sctp_assoc_change {
212 __u16 sac_type;
213 __u16 sac_flags;
214 __u32 sac_length;
215 __u16 sac_state;
216 __u16 sac_error;
217 __u16 sac_outbound_streams;
218 __u16 sac_inbound_streams;
219 sctp_assoc_t sac_assoc_id;
Vlad Yasevicha5a35e72007-03-23 11:34:08 -0700220 __u8 sac_info[0];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700221};
222
223/*
224 * sac_state: 32 bits (signed integer)
225 *
226 * This field holds one of a number of values that communicate the
227 * event that happened to the association. They include:
228 *
229 * Note: The following state names deviate from the API draft as
230 * the names clash too easily with other kernel symbols.
231 */
232enum sctp_sac_state {
233 SCTP_COMM_UP,
234 SCTP_COMM_LOST,
235 SCTP_RESTART,
236 SCTP_SHUTDOWN_COMP,
237 SCTP_CANT_STR_ASSOC,
238};
239
240/*
241 * 5.3.1.2 SCTP_PEER_ADDR_CHANGE
242 *
243 * When a destination address on a multi-homed peer encounters a change
244 * an interface details event is sent. The information has the
245 * following structure:
246 */
247struct sctp_paddr_change {
248 __u16 spc_type;
249 __u16 spc_flags;
250 __u32 spc_length;
251 struct sockaddr_storage spc_aaddr;
252 int spc_state;
253 int spc_error;
254 sctp_assoc_t spc_assoc_id;
Sridhar Samudrala20c9c822005-10-06 21:37:01 -0700255} __attribute__((packed, aligned(4)));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700256
257/*
258 * spc_state: 32 bits (signed integer)
259 *
260 * This field holds one of a number of values that communicate the
261 * event that happened to the address. They include:
262 */
263enum sctp_spc_state {
264 SCTP_ADDR_AVAILABLE,
265 SCTP_ADDR_UNREACHABLE,
266 SCTP_ADDR_REMOVED,
267 SCTP_ADDR_ADDED,
268 SCTP_ADDR_MADE_PRIM,
Vlad Yasevich1ae41142007-03-23 11:32:26 -0700269 SCTP_ADDR_CONFIRMED,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700270};
271
272
273/*
274 * 5.3.1.3 SCTP_REMOTE_ERROR
275 *
276 * A remote peer may send an Operational Error message to its peer.
277 * This message indicates a variety of error conditions on an
278 * association. The entire error TLV as it appears on the wire is
279 * included in a SCTP_REMOTE_ERROR event. Please refer to the SCTP
280 * specification [SCTP] and any extensions for a list of possible
281 * error formats. SCTP error TLVs have the format:
282 */
283struct sctp_remote_error {
284 __u16 sre_type;
285 __u16 sre_flags;
286 __u32 sre_length;
287 __u16 sre_error;
288 sctp_assoc_t sre_assoc_id;
289 __u8 sre_data[0];
290};
291
292
293/*
294 * 5.3.1.4 SCTP_SEND_FAILED
295 *
296 * If SCTP cannot deliver a message it may return the message as a
297 * notification.
298 */
299struct sctp_send_failed {
300 __u16 ssf_type;
301 __u16 ssf_flags;
302 __u32 ssf_length;
303 __u32 ssf_error;
304 struct sctp_sndrcvinfo ssf_info;
305 sctp_assoc_t ssf_assoc_id;
306 __u8 ssf_data[0];
307};
308
309/*
310 * ssf_flags: 16 bits (unsigned integer)
311 *
312 * The flag value will take one of the following values
313 *
314 * SCTP_DATA_UNSENT - Indicates that the data was never put on
315 * the wire.
316 *
317 * SCTP_DATA_SENT - Indicates that the data was put on the wire.
318 * Note that this does not necessarily mean that the
319 * data was (or was not) successfully delivered.
320 */
321enum sctp_ssf_flags {
322 SCTP_DATA_UNSENT,
323 SCTP_DATA_SENT,
324};
325
326/*
327 * 5.3.1.5 SCTP_SHUTDOWN_EVENT
328 *
329 * When a peer sends a SHUTDOWN, SCTP delivers this notification to
330 * inform the application that it should cease sending data.
331 */
332struct sctp_shutdown_event {
333 __u16 sse_type;
334 __u16 sse_flags;
335 __u32 sse_length;
336 sctp_assoc_t sse_assoc_id;
337};
338
339/*
Ivan Skytte Jorgensen0f3fffd2006-12-20 16:07:04 -0800340 * 5.3.1.6 SCTP_ADAPTATION_INDICATION
Linus Torvalds1da177e2005-04-16 15:20:36 -0700341 *
Ivan Skytte Jorgensen0f3fffd2006-12-20 16:07:04 -0800342 * When a peer sends a Adaptation Layer Indication parameter , SCTP
Linus Torvalds1da177e2005-04-16 15:20:36 -0700343 * delivers this notification to inform the application
Ivan Skytte Jorgensen0f3fffd2006-12-20 16:07:04 -0800344 * that of the peers requested adaptation layer.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700345 */
Ivan Skytte Jorgensen0f3fffd2006-12-20 16:07:04 -0800346struct sctp_adaptation_event {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700347 __u16 sai_type;
348 __u16 sai_flags;
349 __u32 sai_length;
Ivan Skytte Jorgensen0f3fffd2006-12-20 16:07:04 -0800350 __u32 sai_adaptation_ind;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700351 sctp_assoc_t sai_assoc_id;
352};
353
354/*
355 * 5.3.1.7 SCTP_PARTIAL_DELIVERY_EVENT
356 *
357 * When a receiver is engaged in a partial delivery of a
358 * message this notification will be used to indicate
359 * various events.
360 */
361struct sctp_pdapi_event {
362 __u16 pdapi_type;
363 __u16 pdapi_flags;
364 __u32 pdapi_length;
365 __u32 pdapi_indication;
366 sctp_assoc_t pdapi_assoc_id;
367};
368
369enum { SCTP_PARTIAL_DELIVERY_ABORTED=0, };
370
371/*
372 * Described in Section 7.3
373 * Ancillary Data and Notification Interest Options
374 */
375struct sctp_event_subscribe {
376 __u8 sctp_data_io_event;
377 __u8 sctp_association_event;
378 __u8 sctp_address_event;
379 __u8 sctp_send_failure_event;
380 __u8 sctp_peer_error_event;
381 __u8 sctp_shutdown_event;
382 __u8 sctp_partial_delivery_event;
Ivan Skytte Jorgensen0f3fffd2006-12-20 16:07:04 -0800383 __u8 sctp_adaptation_layer_event;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700384};
385
386/*
387 * 5.3.1 SCTP Notification Structure
388 *
389 * The notification structure is defined as the union of all
390 * notification types.
391 *
392 */
393union sctp_notification {
394 struct {
395 __u16 sn_type; /* Notification type. */
396 __u16 sn_flags;
397 __u32 sn_length;
398 } sn_header;
399 struct sctp_assoc_change sn_assoc_change;
400 struct sctp_paddr_change sn_paddr_change;
401 struct sctp_remote_error sn_remote_error;
402 struct sctp_send_failed sn_send_failed;
403 struct sctp_shutdown_event sn_shutdown_event;
Ivan Skytte Jorgensen0f3fffd2006-12-20 16:07:04 -0800404 struct sctp_adaptation_event sn_adaptation_event;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700405 struct sctp_pdapi_event sn_pdapi_event;
406};
407
408/* Section 5.3.1
409 * All standard values for sn_type flags are greater than 2^15.
410 * Values from 2^15 and down are reserved.
411 */
412
413enum sctp_sn_type {
414 SCTP_SN_TYPE_BASE = (1<<15),
415 SCTP_ASSOC_CHANGE,
416 SCTP_PEER_ADDR_CHANGE,
417 SCTP_SEND_FAILED,
418 SCTP_REMOTE_ERROR,
419 SCTP_SHUTDOWN_EVENT,
420 SCTP_PARTIAL_DELIVERY_EVENT,
Ivan Skytte Jorgensen0f3fffd2006-12-20 16:07:04 -0800421 SCTP_ADAPTATION_INDICATION,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700422};
423
424/* Notification error codes used to fill up the error fields in some
425 * notifications.
426 * SCTP_PEER_ADDRESS_CHAGE : spc_error
427 * SCTP_ASSOC_CHANGE : sac_error
428 * These names should be potentially included in the draft 04 of the SCTP
429 * sockets API specification.
430 */
431typedef enum sctp_sn_error {
432 SCTP_FAILED_THRESHOLD,
433 SCTP_RECEIVED_SACK,
434 SCTP_HEARTBEAT_SUCCESS,
435 SCTP_RESPONSE_TO_USER_REQ,
436 SCTP_INTERNAL_ERROR,
437 SCTP_SHUTDOWN_GUARD_EXPIRES,
438 SCTP_PEER_FAULTY,
439} sctp_sn_error_t;
440
441/*
442 * 7.1.1 Retransmission Timeout Parameters (SCTP_RTOINFO)
443 *
444 * The protocol parameters used to initialize and bound retransmission
445 * timeout (RTO) are tunable. See [SCTP] for more information on how
446 * these parameters are used in RTO calculation.
447 */
448struct sctp_rtoinfo {
449 sctp_assoc_t srto_assoc_id;
450 __u32 srto_initial;
451 __u32 srto_max;
452 __u32 srto_min;
453};
454
455/*
456 * 7.1.2 Association Parameters (SCTP_ASSOCINFO)
457 *
458 * This option is used to both examine and set various association and
459 * endpoint parameters.
460 */
461struct sctp_assocparams {
462 sctp_assoc_t sasoc_assoc_id;
463 __u16 sasoc_asocmaxrxt;
464 __u16 sasoc_number_peer_destinations;
465 __u32 sasoc_peer_rwnd;
466 __u32 sasoc_local_rwnd;
467 __u32 sasoc_cookie_life;
468};
469
470/*
471 * 7.1.9 Set Peer Primary Address (SCTP_SET_PEER_PRIMARY_ADDR)
472 *
473 * Requests that the peer mark the enclosed address as the association
474 * primary. The enclosed address must be one of the association's
475 * locally bound addresses. The following structure is used to make a
476 * set primary request:
477 */
478struct sctp_setpeerprim {
479 sctp_assoc_t sspp_assoc_id;
480 struct sockaddr_storage sspp_addr;
Sridhar Samudrala20c9c822005-10-06 21:37:01 -0700481} __attribute__((packed, aligned(4)));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700482
483/*
484 * 7.1.10 Set Primary Address (SCTP_PRIMARY_ADDR)
485 *
486 * Requests that the local SCTP stack use the enclosed peer address as
487 * the association primary. The enclosed address must be one of the
488 * association peer's addresses. The following structure is used to
489 * make a set peer primary request:
490 */
491struct sctp_prim {
492 sctp_assoc_t ssp_assoc_id;
493 struct sockaddr_storage ssp_addr;
Sridhar Samudrala20c9c822005-10-06 21:37:01 -0700494} __attribute__((packed, aligned(4)));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700495
496/*
Ivan Skytte Jorgensen0f3fffd2006-12-20 16:07:04 -0800497 * 7.1.11 Set Adaptation Layer Indicator (SCTP_ADAPTATION_LAYER)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700498 *
Ivan Skytte Jorgensen0f3fffd2006-12-20 16:07:04 -0800499 * Requests that the local endpoint set the specified Adaptation Layer
Linus Torvalds1da177e2005-04-16 15:20:36 -0700500 * Indication parameter for all future INIT and INIT-ACK exchanges.
501 */
Ivan Skytte Jorgensen0f3fffd2006-12-20 16:07:04 -0800502struct sctp_setadaptation {
503 __u32 ssb_adaptation_ind;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700504};
505
506/*
507 * 7.1.13 Peer Address Parameters (SCTP_PEER_ADDR_PARAMS)
508 *
509 * Applications can enable or disable heartbeats for any peer address
510 * of an association, modify an address's heartbeat interval, force a
511 * heartbeat to be sent immediately, and adjust the address's maximum
512 * number of retransmissions sent before an address is considered
513 * unreachable. The following structure is used to access and modify an
514 * address's parameters:
515 */
Frank Filz52ccb8e2005-12-22 11:36:46 -0800516enum sctp_spp_flags {
Vlad Yasevichbdf30922007-03-23 11:33:12 -0700517 SPP_HB_ENABLE = 1<<0, /*Enable heartbeats*/
518 SPP_HB_DISABLE = 1<<1, /*Disable heartbeats*/
Frank Filz52ccb8e2005-12-22 11:36:46 -0800519 SPP_HB = SPP_HB_ENABLE | SPP_HB_DISABLE,
Vlad Yasevichbdf30922007-03-23 11:33:12 -0700520 SPP_HB_DEMAND = 1<<2, /*Send heartbeat immediately*/
521 SPP_PMTUD_ENABLE = 1<<3, /*Enable PMTU discovery*/
522 SPP_PMTUD_DISABLE = 1<<4, /*Disable PMTU discovery*/
Frank Filz52ccb8e2005-12-22 11:36:46 -0800523 SPP_PMTUD = SPP_PMTUD_ENABLE | SPP_PMTUD_DISABLE,
Vlad Yasevichbdf30922007-03-23 11:33:12 -0700524 SPP_SACKDELAY_ENABLE = 1<<5, /*Enable SACK*/
525 SPP_SACKDELAY_DISABLE = 1<<6, /*Disable SACK*/
Frank Filz52ccb8e2005-12-22 11:36:46 -0800526 SPP_SACKDELAY = SPP_SACKDELAY_ENABLE | SPP_SACKDELAY_DISABLE,
Vlad Yasevichbdf30922007-03-23 11:33:12 -0700527 SPP_HB_TIME_IS_ZERO = 1<<7, /* Set HB delay to 0 */
Frank Filz52ccb8e2005-12-22 11:36:46 -0800528};
529
Linus Torvalds1da177e2005-04-16 15:20:36 -0700530struct sctp_paddrparams {
531 sctp_assoc_t spp_assoc_id;
532 struct sockaddr_storage spp_address;
533 __u32 spp_hbinterval;
534 __u16 spp_pathmaxrxt;
Frank Filz52ccb8e2005-12-22 11:36:46 -0800535 __u32 spp_pathmtu;
536 __u32 spp_sackdelay;
537 __u32 spp_flags;
Sridhar Samudrala20c9c822005-10-06 21:37:01 -0700538} __attribute__((packed, aligned(4)));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700539
Vlad Yasevichb6e13312007-04-20 12:23:15 -0700540/* 7.1.23. Delayed Ack Timer (SCTP_DELAYED_ACK_TIME)
Frank Filz77086102005-12-22 11:37:30 -0800541 *
542 * This options will get or set the delayed ack timer. The time is set
543 * in milliseconds. If the assoc_id is 0, then this sets or gets the
544 * endpoints default delayed ack timer value. If the assoc_id field is
545 * non-zero, then the set or get effects the specified association.
546 */
547struct sctp_assoc_value {
548 sctp_assoc_t assoc_id;
549 uint32_t assoc_value;
550};
551
Linus Torvalds1da177e2005-04-16 15:20:36 -0700552/*
553 * 7.2.2 Peer Address Information
554 *
555 * Applications can retrieve information about a specific peer address
556 * of an association, including its reachability state, congestion
557 * window, and retransmission timer values. This information is
558 * read-only. The following structure is used to access this
559 * information:
560 */
561struct sctp_paddrinfo {
562 sctp_assoc_t spinfo_assoc_id;
563 struct sockaddr_storage spinfo_address;
564 __s32 spinfo_state;
565 __u32 spinfo_cwnd;
566 __u32 spinfo_srtt;
567 __u32 spinfo_rto;
568 __u32 spinfo_mtu;
Sridhar Samudrala20c9c822005-10-06 21:37:01 -0700569} __attribute__((packed, aligned(4)));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700570
571/* Peer addresses's state. */
Sridhar Samudralaad8fec12006-07-21 14:48:50 -0700572/* UNKNOWN: Peer address passed by the upper layer in sendmsg or connect[x]
573 * calls.
574 * UNCONFIRMED: Peer address received in INIT/INIT-ACK address parameters.
575 * Not yet confirmed by a heartbeat and not available for data
576 * transfers.
577 * ACTIVE : Peer address confirmed, active and available for data transfers.
578 * INACTIVE: Peer address inactive and not available for data transfers.
579 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700580enum sctp_spinfo_state {
581 SCTP_INACTIVE,
582 SCTP_ACTIVE,
Sridhar Samudralaad8fec12006-07-21 14:48:50 -0700583 SCTP_UNCONFIRMED,
Frank Filz3f7a87d2005-06-20 13:14:57 -0700584 SCTP_UNKNOWN = 0xffff /* Value used for transport state unknown */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700585};
586
587/*
588 * 7.2.1 Association Status (SCTP_STATUS)
589 *
590 * Applications can retrieve current status information about an
591 * association, including association state, peer receiver window size,
592 * number of unacked data chunks, and number of data chunks pending
593 * receipt. This information is read-only. The following structure is
594 * used to access this information:
595 */
596struct sctp_status {
597 sctp_assoc_t sstat_assoc_id;
598 __s32 sstat_state;
599 __u32 sstat_rwnd;
600 __u16 sstat_unackdata;
601 __u16 sstat_penddata;
602 __u16 sstat_instrms;
603 __u16 sstat_outstrms;
604 __u32 sstat_fragmentation_point;
605 struct sctp_paddrinfo sstat_primary;
606};
607
608/*
609 * 8.3, 8.5 get all peer/local addresses in an association.
610 * This parameter struct is used by SCTP_GET_PEER_ADDRS and
611 * SCTP_GET_LOCAL_ADDRS socket options used internally to implement
612 * sctp_getpaddrs() and sctp_getladdrs() API.
613 */
Ivan Skytte Jørgensen5fe467e2005-10-06 21:36:17 -0700614struct sctp_getaddrs_old {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700615 sctp_assoc_t assoc_id;
616 int addr_num;
617 struct sockaddr __user *addrs;
618};
Ivan Skytte Jørgensen5fe467e2005-10-06 21:36:17 -0700619struct sctp_getaddrs {
620 sctp_assoc_t assoc_id; /*input*/
621 __u32 addr_num; /*output*/
622 __u8 addrs[0]; /*output, variable size*/
623};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700624
625/* These are bit fields for msghdr->msg_flags. See section 5.1. */
626/* On user space Linux, these live in <bits/socket.h> as an enum. */
627enum sctp_msg_flags {
628 MSG_NOTIFICATION = 0x8000,
629#define MSG_NOTIFICATION MSG_NOTIFICATION
630};
631
632/*
633 * 8.1 sctp_bindx()
634 *
635 * The flags parameter is formed from the bitwise OR of zero or more of the
636 * following currently defined flags:
637 */
638#define SCTP_BINDX_ADD_ADDR 0x01
639#define SCTP_BINDX_REM_ADDR 0x02
640
641/* This is the structure that is passed as an argument(optval) to
642 * getsockopt(SCTP_SOCKOPT_PEELOFF).
643 */
644typedef struct {
645 sctp_assoc_t associd;
646 int sd;
647} sctp_peeloff_arg_t;
648
649#endif /* __net_sctp_user_h__ */