[CONNECTOR]: Update documentation to match reality.
[linux-2.6/verdex.git] / include / net / sctp / user.h
blob1c5f19f995ad2beb8f0feb8ac04df7f115c99900
1 /* 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.
7 * This file is part of the SCTP kernel reference Implementation
9 * This header represents the structures and constants needed to support
10 * the SCTP Extension to the Sockets API.
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.
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.
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.
29 * Please send any bug reports or fixes you make to the
30 * email address(es):
31 * lksctp developers <lksctp-developers@lists.sourceforge.net>
33 * Or submit a bug report through the following website:
34 * http://www.sf.net/projects/lksctp
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>
48 * Any bugs reported given to us we will try to fix... any fixes shared will
49 * be incorporated into the next SCTP release.
52 #ifndef __net_sctp_user_h__
53 #define __net_sctp_user_h__
55 #include <linux/types.h>
56 #include <linux/socket.h>
58 typedef __s32 sctp_assoc_t;
60 /* The following symbols come from the Sockets API Extensions for
61 * SCTP <draft-ietf-tsvwg-sctpsocket-07.txt>.
63 enum 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
78 SCTP_ADAPTION_LAYER,
79 #define SCTP_ADAPTION_LAYER SCTP_ADAPTION_LAYER
80 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
97 /* Internal Socket Options. Some of the sctp library functions are
98 * implemented using these socket options.
100 SCTP_SOCKOPT_BINDX_ADD = 100,/* BINDX requests for adding addresses. */
101 #define SCTP_SOCKOPT_BINDX_ADD SCTP_SOCKOPT_BINDX_ADD
102 SCTP_SOCKOPT_BINDX_REM, /* BINDX requests for removing addresses. */
103 #define SCTP_SOCKOPT_BINDX_REM SCTP_SOCKOPT_BINDX_REM
104 SCTP_SOCKOPT_PEELOFF, /* peel off association. */
105 #define SCTP_SOCKOPT_PEELOFF SCTP_SOCKOPT_PEELOFF
106 SCTP_GET_PEER_ADDRS_NUM_OLD, /* Get number of peer addresss. */
107 #define SCTP_GET_PEER_ADDRS_NUM_OLD SCTP_GET_PEER_ADDRS_NUM_OLD
108 SCTP_GET_PEER_ADDRS_OLD, /* Get all peer addresss. */
109 #define SCTP_GET_PEER_ADDRS_OLD SCTP_GET_PEER_ADDRS_OLD
110 SCTP_GET_LOCAL_ADDRS_NUM_OLD, /* Get number of local addresss. */
111 #define SCTP_GET_LOCAL_ADDRS_NUM_OLD SCTP_GET_LOCAL_ADDRS_NUM_OLD
112 SCTP_GET_LOCAL_ADDRS_OLD, /* Get all local addresss. */
113 #define SCTP_GET_LOCAL_ADDRS_OLD SCTP_GET_LOCAL_ADDRS_OLD
114 SCTP_SOCKOPT_CONNECTX, /* CONNECTX requests. */
115 #define SCTP_SOCKOPT_CONNECTX SCTP_SOCKOPT_CONNECTX
116 SCTP_GET_PEER_ADDRS, /* Get all peer addresss. */
117 #define SCTP_GET_PEER_ADDRS SCTP_GET_PEER_ADDRS
118 SCTP_GET_LOCAL_ADDRS, /* Get all local addresss. */
119 #define SCTP_GET_LOCAL_ADDRS SCTP_GET_LOCAL_ADDRS
123 * 5.2.1 SCTP Initiation Structure (SCTP_INIT)
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().
130 * cmsg_level cmsg_type cmsg_data[]
131 * ------------ ------------ ----------------------
132 * IPPROTO_SCTP SCTP_INIT struct sctp_initmsg
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;
143 * 5.2.2 SCTP Header Information Structure (SCTP_SNDRCV)
145 * This cmsghdr structure specifies SCTP options for sendmsg() and
146 * describes SCTP header information about a received message through
147 * recvmsg().
149 * cmsg_level cmsg_type cmsg_data[]
150 * ------------ ------------ ----------------------
151 * IPPROTO_SCTP SCTP_SNDRCV struct sctp_sndrcvinfo
154 struct sctp_sndrcvinfo {
155 __u16 sinfo_stream;
156 __u16 sinfo_ssn;
157 __u16 sinfo_flags;
158 __u32 sinfo_ppid;
159 __u32 sinfo_context;
160 __u32 sinfo_timetolive;
161 __u32 sinfo_tsn;
162 __u32 sinfo_cumtsn;
163 sctp_assoc_t sinfo_assoc_id;
167 * sinfo_flags: 16 bits (unsigned integer)
169 * This field may contain any of the following flags and is composed of
170 * a bitwise OR of these values.
173 enum sctp_sinfo_flags {
174 MSG_UNORDERED = 1, /* Send/receive message unordered. */
175 MSG_ADDR_OVER = 2, /* Override the primary destination. */
176 MSG_ABORT=4, /* Send an ABORT message to the peer. */
177 /* MSG_EOF is already defined per socket.h */
181 typedef union {
182 __u8 raw;
183 struct sctp_initmsg init;
184 struct sctp_sndrcvinfo sndrcv;
185 } sctp_cmsg_data_t;
187 /* These are cmsg_types. */
188 typedef enum sctp_cmsg_type {
189 SCTP_INIT, /* 5.2.1 SCTP Initiation Structure */
190 SCTP_SNDRCV, /* 5.2.2 SCTP Header Information Structure */
191 } sctp_cmsg_t;
195 * 5.3.1.1 SCTP_ASSOC_CHANGE
197 * Communication notifications inform the ULP that an SCTP association
198 * has either begun or ended. The identifier for a new association is
199 * provided by this notificaion. The notification information has the
200 * following format:
203 struct sctp_assoc_change {
204 __u16 sac_type;
205 __u16 sac_flags;
206 __u32 sac_length;
207 __u16 sac_state;
208 __u16 sac_error;
209 __u16 sac_outbound_streams;
210 __u16 sac_inbound_streams;
211 sctp_assoc_t sac_assoc_id;
215 * sac_state: 32 bits (signed integer)
217 * This field holds one of a number of values that communicate the
218 * event that happened to the association. They include:
220 * Note: The following state names deviate from the API draft as
221 * the names clash too easily with other kernel symbols.
223 enum sctp_sac_state {
224 SCTP_COMM_UP,
225 SCTP_COMM_LOST,
226 SCTP_RESTART,
227 SCTP_SHUTDOWN_COMP,
228 SCTP_CANT_STR_ASSOC,
232 * 5.3.1.2 SCTP_PEER_ADDR_CHANGE
234 * When a destination address on a multi-homed peer encounters a change
235 * an interface details event is sent. The information has the
236 * following structure:
238 struct sctp_paddr_change {
239 __u16 spc_type;
240 __u16 spc_flags;
241 __u32 spc_length;
242 struct sockaddr_storage spc_aaddr;
243 int spc_state;
244 int spc_error;
245 sctp_assoc_t spc_assoc_id;
246 } __attribute__((packed, aligned(4)));
249 * spc_state: 32 bits (signed integer)
251 * This field holds one of a number of values that communicate the
252 * event that happened to the address. They include:
254 enum sctp_spc_state {
255 SCTP_ADDR_AVAILABLE,
256 SCTP_ADDR_UNREACHABLE,
257 SCTP_ADDR_REMOVED,
258 SCTP_ADDR_ADDED,
259 SCTP_ADDR_MADE_PRIM,
264 * 5.3.1.3 SCTP_REMOTE_ERROR
266 * A remote peer may send an Operational Error message to its peer.
267 * This message indicates a variety of error conditions on an
268 * association. The entire error TLV as it appears on the wire is
269 * included in a SCTP_REMOTE_ERROR event. Please refer to the SCTP
270 * specification [SCTP] and any extensions for a list of possible
271 * error formats. SCTP error TLVs have the format:
273 struct sctp_remote_error {
274 __u16 sre_type;
275 __u16 sre_flags;
276 __u32 sre_length;
277 __u16 sre_error;
278 sctp_assoc_t sre_assoc_id;
279 __u8 sre_data[0];
284 * 5.3.1.4 SCTP_SEND_FAILED
286 * If SCTP cannot deliver a message it may return the message as a
287 * notification.
289 struct sctp_send_failed {
290 __u16 ssf_type;
291 __u16 ssf_flags;
292 __u32 ssf_length;
293 __u32 ssf_error;
294 struct sctp_sndrcvinfo ssf_info;
295 sctp_assoc_t ssf_assoc_id;
296 __u8 ssf_data[0];
300 * ssf_flags: 16 bits (unsigned integer)
302 * The flag value will take one of the following values
304 * SCTP_DATA_UNSENT - Indicates that the data was never put on
305 * the wire.
307 * SCTP_DATA_SENT - Indicates that the data was put on the wire.
308 * Note that this does not necessarily mean that the
309 * data was (or was not) successfully delivered.
311 enum sctp_ssf_flags {
312 SCTP_DATA_UNSENT,
313 SCTP_DATA_SENT,
317 * 5.3.1.5 SCTP_SHUTDOWN_EVENT
319 * When a peer sends a SHUTDOWN, SCTP delivers this notification to
320 * inform the application that it should cease sending data.
322 struct sctp_shutdown_event {
323 __u16 sse_type;
324 __u16 sse_flags;
325 __u32 sse_length;
326 sctp_assoc_t sse_assoc_id;
330 * 5.3.1.6 SCTP_ADAPTION_INDICATION
332 * When a peer sends a Adaption Layer Indication parameter , SCTP
333 * delivers this notification to inform the application
334 * that of the peers requested adaption layer.
336 struct sctp_adaption_event {
337 __u16 sai_type;
338 __u16 sai_flags;
339 __u32 sai_length;
340 __u32 sai_adaption_ind;
341 sctp_assoc_t sai_assoc_id;
345 * 5.3.1.7 SCTP_PARTIAL_DELIVERY_EVENT
347 * When a receiver is engaged in a partial delivery of a
348 * message this notification will be used to indicate
349 * various events.
351 struct sctp_pdapi_event {
352 __u16 pdapi_type;
353 __u16 pdapi_flags;
354 __u32 pdapi_length;
355 __u32 pdapi_indication;
356 sctp_assoc_t pdapi_assoc_id;
359 enum { SCTP_PARTIAL_DELIVERY_ABORTED=0, };
362 * Described in Section 7.3
363 * Ancillary Data and Notification Interest Options
365 struct sctp_event_subscribe {
366 __u8 sctp_data_io_event;
367 __u8 sctp_association_event;
368 __u8 sctp_address_event;
369 __u8 sctp_send_failure_event;
370 __u8 sctp_peer_error_event;
371 __u8 sctp_shutdown_event;
372 __u8 sctp_partial_delivery_event;
373 __u8 sctp_adaption_layer_event;
377 * 5.3.1 SCTP Notification Structure
379 * The notification structure is defined as the union of all
380 * notification types.
383 union sctp_notification {
384 struct {
385 __u16 sn_type; /* Notification type. */
386 __u16 sn_flags;
387 __u32 sn_length;
388 } sn_header;
389 struct sctp_assoc_change sn_assoc_change;
390 struct sctp_paddr_change sn_paddr_change;
391 struct sctp_remote_error sn_remote_error;
392 struct sctp_send_failed sn_send_failed;
393 struct sctp_shutdown_event sn_shutdown_event;
394 struct sctp_adaption_event sn_adaption_event;
395 struct sctp_pdapi_event sn_pdapi_event;
398 /* Section 5.3.1
399 * All standard values for sn_type flags are greater than 2^15.
400 * Values from 2^15 and down are reserved.
403 enum sctp_sn_type {
404 SCTP_SN_TYPE_BASE = (1<<15),
405 SCTP_ASSOC_CHANGE,
406 SCTP_PEER_ADDR_CHANGE,
407 SCTP_SEND_FAILED,
408 SCTP_REMOTE_ERROR,
409 SCTP_SHUTDOWN_EVENT,
410 SCTP_PARTIAL_DELIVERY_EVENT,
411 SCTP_ADAPTION_INDICATION,
414 /* Notification error codes used to fill up the error fields in some
415 * notifications.
416 * SCTP_PEER_ADDRESS_CHAGE : spc_error
417 * SCTP_ASSOC_CHANGE : sac_error
418 * These names should be potentially included in the draft 04 of the SCTP
419 * sockets API specification.
421 typedef enum sctp_sn_error {
422 SCTP_FAILED_THRESHOLD,
423 SCTP_RECEIVED_SACK,
424 SCTP_HEARTBEAT_SUCCESS,
425 SCTP_RESPONSE_TO_USER_REQ,
426 SCTP_INTERNAL_ERROR,
427 SCTP_SHUTDOWN_GUARD_EXPIRES,
428 SCTP_PEER_FAULTY,
429 } sctp_sn_error_t;
432 * 7.1.1 Retransmission Timeout Parameters (SCTP_RTOINFO)
434 * The protocol parameters used to initialize and bound retransmission
435 * timeout (RTO) are tunable. See [SCTP] for more information on how
436 * these parameters are used in RTO calculation.
438 struct sctp_rtoinfo {
439 sctp_assoc_t srto_assoc_id;
440 __u32 srto_initial;
441 __u32 srto_max;
442 __u32 srto_min;
446 * 7.1.2 Association Parameters (SCTP_ASSOCINFO)
448 * This option is used to both examine and set various association and
449 * endpoint parameters.
451 struct sctp_assocparams {
452 sctp_assoc_t sasoc_assoc_id;
453 __u16 sasoc_asocmaxrxt;
454 __u16 sasoc_number_peer_destinations;
455 __u32 sasoc_peer_rwnd;
456 __u32 sasoc_local_rwnd;
457 __u32 sasoc_cookie_life;
461 * 7.1.9 Set Peer Primary Address (SCTP_SET_PEER_PRIMARY_ADDR)
463 * Requests that the peer mark the enclosed address as the association
464 * primary. The enclosed address must be one of the association's
465 * locally bound addresses. The following structure is used to make a
466 * set primary request:
468 struct sctp_setpeerprim {
469 sctp_assoc_t sspp_assoc_id;
470 struct sockaddr_storage sspp_addr;
471 } __attribute__((packed, aligned(4)));
474 * 7.1.10 Set Primary Address (SCTP_PRIMARY_ADDR)
476 * Requests that the local SCTP stack use the enclosed peer address as
477 * the association primary. The enclosed address must be one of the
478 * association peer's addresses. The following structure is used to
479 * make a set peer primary request:
481 struct sctp_prim {
482 sctp_assoc_t ssp_assoc_id;
483 struct sockaddr_storage ssp_addr;
484 } __attribute__((packed, aligned(4)));
487 * 7.1.11 Set Adaption Layer Indicator (SCTP_ADAPTION_LAYER)
489 * Requests that the local endpoint set the specified Adaption Layer
490 * Indication parameter for all future INIT and INIT-ACK exchanges.
492 struct sctp_setadaption {
493 __u32 ssb_adaption_ind;
497 * 7.1.13 Peer Address Parameters (SCTP_PEER_ADDR_PARAMS)
499 * Applications can enable or disable heartbeats for any peer address
500 * of an association, modify an address's heartbeat interval, force a
501 * heartbeat to be sent immediately, and adjust the address's maximum
502 * number of retransmissions sent before an address is considered
503 * unreachable. The following structure is used to access and modify an
504 * address's parameters:
506 struct sctp_paddrparams {
507 sctp_assoc_t spp_assoc_id;
508 struct sockaddr_storage spp_address;
509 __u32 spp_hbinterval;
510 __u16 spp_pathmaxrxt;
511 } __attribute__((packed, aligned(4)));
514 * 7.2.2 Peer Address Information
516 * Applications can retrieve information about a specific peer address
517 * of an association, including its reachability state, congestion
518 * window, and retransmission timer values. This information is
519 * read-only. The following structure is used to access this
520 * information:
522 struct sctp_paddrinfo {
523 sctp_assoc_t spinfo_assoc_id;
524 struct sockaddr_storage spinfo_address;
525 __s32 spinfo_state;
526 __u32 spinfo_cwnd;
527 __u32 spinfo_srtt;
528 __u32 spinfo_rto;
529 __u32 spinfo_mtu;
530 } __attribute__((packed, aligned(4)));
532 /* Peer addresses's state. */
533 enum sctp_spinfo_state {
534 SCTP_INACTIVE,
535 SCTP_ACTIVE,
536 SCTP_UNKNOWN = 0xffff /* Value used for transport state unknown */
540 * 7.2.1 Association Status (SCTP_STATUS)
542 * Applications can retrieve current status information about an
543 * association, including association state, peer receiver window size,
544 * number of unacked data chunks, and number of data chunks pending
545 * receipt. This information is read-only. The following structure is
546 * used to access this information:
548 struct sctp_status {
549 sctp_assoc_t sstat_assoc_id;
550 __s32 sstat_state;
551 __u32 sstat_rwnd;
552 __u16 sstat_unackdata;
553 __u16 sstat_penddata;
554 __u16 sstat_instrms;
555 __u16 sstat_outstrms;
556 __u32 sstat_fragmentation_point;
557 struct sctp_paddrinfo sstat_primary;
561 * 8.3, 8.5 get all peer/local addresses in an association.
562 * This parameter struct is used by SCTP_GET_PEER_ADDRS and
563 * SCTP_GET_LOCAL_ADDRS socket options used internally to implement
564 * sctp_getpaddrs() and sctp_getladdrs() API.
566 struct sctp_getaddrs_old {
567 sctp_assoc_t assoc_id;
568 int addr_num;
569 struct sockaddr __user *addrs;
571 struct sctp_getaddrs {
572 sctp_assoc_t assoc_id; /*input*/
573 __u32 addr_num; /*output*/
574 __u8 addrs[0]; /*output, variable size*/
577 /* These are bit fields for msghdr->msg_flags. See section 5.1. */
578 /* On user space Linux, these live in <bits/socket.h> as an enum. */
579 enum sctp_msg_flags {
580 MSG_NOTIFICATION = 0x8000,
581 #define MSG_NOTIFICATION MSG_NOTIFICATION
585 * 8.1 sctp_bindx()
587 * The flags parameter is formed from the bitwise OR of zero or more of the
588 * following currently defined flags:
590 #define SCTP_BINDX_ADD_ADDR 0x01
591 #define SCTP_BINDX_REM_ADDR 0x02
593 /* This is the structure that is passed as an argument(optval) to
594 * getsockopt(SCTP_SOCKOPT_PEELOFF).
596 typedef struct {
597 sctp_assoc_t associd;
598 int sd;
599 } sctp_peeloff_arg_t;
601 #endif /* __net_sctp_user_h__ */