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)
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
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>.
65 #define SCTP_RTOINFO SCTP_RTOINFO
67 #define SCTP_ASSOCINFO SCTP_ASSOCINFO
69 #define SCTP_INITMSG SCTP_INITMSG
70 SCTP_NODELAY, /* Get/set nodelay option. */
71 #define SCTP_NODELAY SCTP_NODELAY
73 #define SCTP_AUTOCLOSE SCTP_AUTOCLOSE
74 SCTP_SET_PEER_PRIMARY_ADDR,
75 #define SCTP_SET_PEER_PRIMARY_ADDR SCTP_SET_PEER_PRIMARY_ADDR
77 #define SCTP_PRIMARY_ADDR SCTP_PRIMARY_ADDR
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
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
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, /* Get number of peer addresss. */
107 #define SCTP_GET_PEER_ADDRS_NUM SCTP_GET_PEER_ADDRS_NUM
108 SCTP_GET_PEER_ADDRS, /* Get all peer addresss. */
109 #define SCTP_GET_PEER_ADDRS SCTP_GET_PEER_ADDRS
110 SCTP_GET_LOCAL_ADDRS_NUM, /* Get number of local addresss. */
111 #define SCTP_GET_LOCAL_ADDRS_NUM SCTP_GET_LOCAL_ADDRS_NUM
112 SCTP_GET_LOCAL_ADDRS, /* Get all local addresss. */
113 #define SCTP_GET_LOCAL_ADDRS SCTP_GET_LOCAL_ADDRS
114 SCTP_SOCKOPT_CONNECTX, /* CONNECTX requests. */
115 #define SCTP_SOCKOPT_CONNECTX SCTP_SOCKOPT_CONNECTX
119 * 5.2.1 SCTP Initiation Structure (SCTP_INIT)
121 * This cmsghdr structure provides information for initializing new
122 * SCTP associations with sendmsg(). The SCTP_INITMSG socket option
123 * uses this same data structure. This structure is not used for
126 * cmsg_level cmsg_type cmsg_data[]
127 * ------------ ------------ ----------------------
128 * IPPROTO_SCTP SCTP_INIT struct sctp_initmsg
131 struct sctp_initmsg {
132 __u16 sinit_num_ostreams;
133 __u16 sinit_max_instreams;
134 __u16 sinit_max_attempts;
135 __u16 sinit_max_init_timeo;
139 * 5.2.2 SCTP Header Information Structure (SCTP_SNDRCV)
141 * This cmsghdr structure specifies SCTP options for sendmsg() and
142 * describes SCTP header information about a received message through
145 * cmsg_level cmsg_type cmsg_data[]
146 * ------------ ------------ ----------------------
147 * IPPROTO_SCTP SCTP_SNDRCV struct sctp_sndrcvinfo
150 struct sctp_sndrcvinfo {
156 __u32 sinfo_timetolive;
159 sctp_assoc_t sinfo_assoc_id;
163 * sinfo_flags: 16 bits (unsigned integer)
165 * This field may contain any of the following flags and is composed of
166 * a bitwise OR of these values.
169 enum sctp_sinfo_flags {
170 MSG_UNORDERED = 1, /* Send/receive message unordered. */
171 MSG_ADDR_OVER = 2, /* Override the primary destination. */
172 MSG_ABORT=4, /* Send an ABORT message to the peer. */
173 /* MSG_EOF is already defined per socket.h */
179 struct sctp_initmsg init;
180 struct sctp_sndrcvinfo sndrcv;
183 /* These are cmsg_types. */
184 typedef enum sctp_cmsg_type {
185 SCTP_INIT, /* 5.2.1 SCTP Initiation Structure */
186 SCTP_SNDRCV, /* 5.2.2 SCTP Header Information Structure */
191 * 5.3.1.1 SCTP_ASSOC_CHANGE
193 * Communication notifications inform the ULP that an SCTP association
194 * has either begun or ended. The identifier for a new association is
195 * provided by this notificaion. The notification information has the
199 struct sctp_assoc_change {
205 __u16 sac_outbound_streams;
206 __u16 sac_inbound_streams;
207 sctp_assoc_t sac_assoc_id;
211 * sac_state: 32 bits (signed integer)
213 * This field holds one of a number of values that communicate the
214 * event that happened to the association. They include:
216 * Note: The following state names deviate from the API draft as
217 * the names clash too easily with other kernel symbols.
219 enum sctp_sac_state {
228 * 5.3.1.2 SCTP_PEER_ADDR_CHANGE
230 * When a destination address on a multi-homed peer encounters a change
231 * an interface details event is sent. The information has the
232 * following structure:
234 struct sctp_paddr_change {
238 struct sockaddr_storage spc_aaddr;
241 sctp_assoc_t spc_assoc_id;
245 * spc_state: 32 bits (signed integer)
247 * This field holds one of a number of values that communicate the
248 * event that happened to the address. They include:
250 enum sctp_spc_state {
252 SCTP_ADDR_UNREACHABLE,
260 * 5.3.1.3 SCTP_REMOTE_ERROR
262 * A remote peer may send an Operational Error message to its peer.
263 * This message indicates a variety of error conditions on an
264 * association. The entire error TLV as it appears on the wire is
265 * included in a SCTP_REMOTE_ERROR event. Please refer to the SCTP
266 * specification [SCTP] and any extensions for a list of possible
267 * error formats. SCTP error TLVs have the format:
269 struct sctp_remote_error {
274 sctp_assoc_t sre_assoc_id;
280 * 5.3.1.4 SCTP_SEND_FAILED
282 * If SCTP cannot deliver a message it may return the message as a
285 struct sctp_send_failed {
290 struct sctp_sndrcvinfo ssf_info;
291 sctp_assoc_t ssf_assoc_id;
296 * ssf_flags: 16 bits (unsigned integer)
298 * The flag value will take one of the following values
300 * SCTP_DATA_UNSENT - Indicates that the data was never put on
303 * SCTP_DATA_SENT - Indicates that the data was put on the wire.
304 * Note that this does not necessarily mean that the
305 * data was (or was not) successfully delivered.
307 enum sctp_ssf_flags {
313 * 5.3.1.5 SCTP_SHUTDOWN_EVENT
315 * When a peer sends a SHUTDOWN, SCTP delivers this notification to
316 * inform the application that it should cease sending data.
318 struct sctp_shutdown_event {
322 sctp_assoc_t sse_assoc_id;
326 * 5.3.1.6 SCTP_ADAPTION_INDICATION
328 * When a peer sends a Adaption Layer Indication parameter , SCTP
329 * delivers this notification to inform the application
330 * that of the peers requested adaption layer.
332 struct sctp_adaption_event {
336 __u32 sai_adaption_ind;
337 sctp_assoc_t sai_assoc_id;
341 * 5.3.1.7 SCTP_PARTIAL_DELIVERY_EVENT
343 * When a receiver is engaged in a partial delivery of a
344 * message this notification will be used to indicate
347 struct sctp_pdapi_event {
351 __u32 pdapi_indication;
352 sctp_assoc_t pdapi_assoc_id;
355 enum { SCTP_PARTIAL_DELIVERY_ABORTED=0, };
358 * Described in Section 7.3
359 * Ancillary Data and Notification Interest Options
361 struct sctp_event_subscribe {
362 __u8 sctp_data_io_event;
363 __u8 sctp_association_event;
364 __u8 sctp_address_event;
365 __u8 sctp_send_failure_event;
366 __u8 sctp_peer_error_event;
367 __u8 sctp_shutdown_event;
368 __u8 sctp_partial_delivery_event;
369 __u8 sctp_adaption_layer_event;
373 * 5.3.1 SCTP Notification Structure
375 * The notification structure is defined as the union of all
376 * notification types.
379 union sctp_notification {
381 __u16 sn_type; /* Notification type. */
385 struct sctp_assoc_change sn_assoc_change;
386 struct sctp_paddr_change sn_paddr_change;
387 struct sctp_remote_error sn_remote_error;
388 struct sctp_send_failed sn_send_failed;
389 struct sctp_shutdown_event sn_shutdown_event;
390 struct sctp_adaption_event sn_adaption_event;
391 struct sctp_pdapi_event sn_pdapi_event;
395 * All standard values for sn_type flags are greater than 2^15.
396 * Values from 2^15 and down are reserved.
400 SCTP_SN_TYPE_BASE = (1<<15),
402 SCTP_PEER_ADDR_CHANGE,
406 SCTP_PARTIAL_DELIVERY_EVENT,
407 SCTP_ADAPTION_INDICATION,
410 /* Notification error codes used to fill up the error fields in some
412 * SCTP_PEER_ADDRESS_CHAGE : spc_error
413 * SCTP_ASSOC_CHANGE : sac_error
414 * These names should be potentially included in the draft 04 of the SCTP
415 * sockets API specification.
417 typedef enum sctp_sn_error {
418 SCTP_FAILED_THRESHOLD,
420 SCTP_HEARTBEAT_SUCCESS,
421 SCTP_RESPONSE_TO_USER_REQ,
423 SCTP_SHUTDOWN_GUARD_EXPIRES,
428 * 7.1.1 Retransmission Timeout Parameters (SCTP_RTOINFO)
430 * The protocol parameters used to initialize and bound retransmission
431 * timeout (RTO) are tunable. See [SCTP] for more information on how
432 * these parameters are used in RTO calculation.
434 struct sctp_rtoinfo {
435 sctp_assoc_t srto_assoc_id;
442 * 7.1.2 Association Parameters (SCTP_ASSOCINFO)
444 * This option is used to both examine and set various association and
445 * endpoint parameters.
447 struct sctp_assocparams {
448 sctp_assoc_t sasoc_assoc_id;
449 __u16 sasoc_asocmaxrxt;
450 __u16 sasoc_number_peer_destinations;
451 __u32 sasoc_peer_rwnd;
452 __u32 sasoc_local_rwnd;
453 __u32 sasoc_cookie_life;
457 * 7.1.9 Set Peer Primary Address (SCTP_SET_PEER_PRIMARY_ADDR)
459 * Requests that the peer mark the enclosed address as the association
460 * primary. The enclosed address must be one of the association's
461 * locally bound addresses. The following structure is used to make a
462 * set primary request:
464 struct sctp_setpeerprim {
465 sctp_assoc_t sspp_assoc_id;
466 struct sockaddr_storage sspp_addr;
470 * 7.1.10 Set Primary Address (SCTP_PRIMARY_ADDR)
472 * Requests that the local SCTP stack use the enclosed peer address as
473 * the association primary. The enclosed address must be one of the
474 * association peer's addresses. The following structure is used to
475 * make a set peer primary request:
478 sctp_assoc_t ssp_assoc_id;
479 struct sockaddr_storage ssp_addr;
483 * 7.1.11 Set Adaption Layer Indicator (SCTP_ADAPTION_LAYER)
485 * Requests that the local endpoint set the specified Adaption Layer
486 * Indication parameter for all future INIT and INIT-ACK exchanges.
488 struct sctp_setadaption {
489 __u32 ssb_adaption_ind;
493 * 7.1.13 Peer Address Parameters (SCTP_PEER_ADDR_PARAMS)
495 * Applications can enable or disable heartbeats for any peer address
496 * of an association, modify an address's heartbeat interval, force a
497 * heartbeat to be sent immediately, and adjust the address's maximum
498 * number of retransmissions sent before an address is considered
499 * unreachable. The following structure is used to access and modify an
500 * address's parameters:
502 struct sctp_paddrparams {
503 sctp_assoc_t spp_assoc_id;
504 struct sockaddr_storage spp_address;
505 __u32 spp_hbinterval;
506 __u16 spp_pathmaxrxt;
510 * 7.2.2 Peer Address Information
512 * Applications can retrieve information about a specific peer address
513 * of an association, including its reachability state, congestion
514 * window, and retransmission timer values. This information is
515 * read-only. The following structure is used to access this
518 struct sctp_paddrinfo {
519 sctp_assoc_t spinfo_assoc_id;
520 struct sockaddr_storage spinfo_address;
528 /* Peer addresses's state. */
529 enum sctp_spinfo_state {
532 SCTP_UNKNOWN = 0xffff /* Value used for transport state unknown */
536 * 7.2.1 Association Status (SCTP_STATUS)
538 * Applications can retrieve current status information about an
539 * association, including association state, peer receiver window size,
540 * number of unacked data chunks, and number of data chunks pending
541 * receipt. This information is read-only. The following structure is
542 * used to access this information:
545 sctp_assoc_t sstat_assoc_id;
548 __u16 sstat_unackdata;
549 __u16 sstat_penddata;
551 __u16 sstat_outstrms;
552 __u32 sstat_fragmentation_point;
553 struct sctp_paddrinfo sstat_primary;
557 * 8.3, 8.5 get all peer/local addresses in an association.
558 * This parameter struct is used by SCTP_GET_PEER_ADDRS and
559 * SCTP_GET_LOCAL_ADDRS socket options used internally to implement
560 * sctp_getpaddrs() and sctp_getladdrs() API.
562 struct sctp_getaddrs {
563 sctp_assoc_t assoc_id;
565 struct sockaddr __user *addrs;
568 /* These are bit fields for msghdr->msg_flags. See section 5.1. */
569 /* On user space Linux, these live in <bits/socket.h> as an enum. */
570 enum sctp_msg_flags {
571 MSG_NOTIFICATION = 0x8000,
572 #define MSG_NOTIFICATION MSG_NOTIFICATION
578 * The flags parameter is formed from the bitwise OR of zero or more of the
579 * following currently defined flags:
581 #define SCTP_BINDX_ADD_ADDR 0x01
582 #define SCTP_BINDX_REM_ADDR 0x02
584 /* This is the structure that is passed as an argument(optval) to
585 * getsockopt(SCTP_SOCKOPT_PEELOFF).
588 sctp_assoc_t associd;
590 } sctp_peeloff_arg_t;
592 #endif /* __net_sctp_user_h__ */