32fd51274037cebd4aa8731310203c0a97094047
[linux-2.6.git] / include / net / sctp / user.h
1 /* SCTP kernel 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 implementation
8  *
9  * This header represents the structures and constants needed to support
10  * the SCTP Extension to the Sockets API.
11  *
12  * This SCTP 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  * This SCTP 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
58 typedef __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  */
63 #define SCTP_RTOINFO    0
64 #define SCTP_ASSOCINFO  1
65 #define SCTP_INITMSG    2
66 #define SCTP_NODELAY    3               /* Get/set nodelay option. */
67 #define SCTP_AUTOCLOSE  4
68 #define SCTP_SET_PEER_PRIMARY_ADDR 5
69 #define SCTP_PRIMARY_ADDR       6
70 #define SCTP_ADAPTATION_LAYER   7
71 #define SCTP_DISABLE_FRAGMENTS  8
72 #define SCTP_PEER_ADDR_PARAMS   9
73 #define SCTP_DEFAULT_SEND_PARAM 10
74 #define SCTP_EVENTS     11
75 #define SCTP_I_WANT_MAPPED_V4_ADDR 12   /* Turn on/off mapped v4 addresses  */
76 #define SCTP_MAXSEG     13              /* Get/set maximum fragment. */
77 #define SCTP_STATUS     14
78 #define SCTP_GET_PEER_ADDR_INFO 15
79 #define SCTP_DELAYED_ACK_TIME   16
80 #define SCTP_DELAYED_ACK SCTP_DELAYED_ACK_TIME
81 #define SCTP_DELAYED_SACK SCTP_DELAYED_ACK_TIME
82 #define SCTP_CONTEXT    17
83 #define SCTP_FRAGMENT_INTERLEAVE        18
84 #define SCTP_PARTIAL_DELIVERY_POINT     19 /* Set/Get partial delivery point */
85 #define SCTP_MAX_BURST  20              /* Set/Get max burst */
86 #define SCTP_AUTH_CHUNK 21      /* Set only: add a chunk type to authenticate */
87 #define SCTP_HMAC_IDENT 22
88 #define SCTP_AUTH_KEY   23
89 #define SCTP_AUTH_ACTIVE_KEY    24
90 #define SCTP_AUTH_DELETE_KEY    25
91 #define SCTP_PEER_AUTH_CHUNKS   26      /* Read only */
92 #define SCTP_LOCAL_AUTH_CHUNKS  27      /* Read only */
93 #define SCTP_GET_ASSOC_NUMBER   28      /* Read only */
94 #define SCTP_GET_ASSOC_ID_LIST  29      /* Read only */
95
96 /* Internal Socket Options. Some of the sctp library functions are
97  * implemented using these socket options.
98  */
99 #define SCTP_SOCKOPT_BINDX_ADD  100     /* BINDX requests for adding addrs */
100 #define SCTP_SOCKOPT_BINDX_REM  101     /* BINDX requests for removing addrs. */
101 #define SCTP_SOCKOPT_PEELOFF    102     /* peel off association. */
102 /* Options 104-106 are deprecated and removed. Do not use this space */
103 #define SCTP_SOCKOPT_CONNECTX_OLD       107     /* CONNECTX old requests. */
104 #define SCTP_GET_PEER_ADDRS     108             /* Get all peer address. */
105 #define SCTP_GET_LOCAL_ADDRS    109             /* Get all local address. */
106 #define SCTP_SOCKOPT_CONNECTX   110             /* CONNECTX requests. */
107 #define SCTP_SOCKOPT_CONNECTX3  111     /* CONNECTX requests (updated) */
108
109 /*
110  * 5.2.1 SCTP Initiation Structure (SCTP_INIT)
111  *
112  *   This cmsghdr structure provides information for initializing new
113  *   SCTP associations with sendmsg().  The SCTP_INITMSG socket option
114  *   uses this same data structure.  This structure is not used for
115  *   recvmsg().
116  *
117  *   cmsg_level    cmsg_type      cmsg_data[]
118  *   ------------  ------------   ----------------------
119  *   IPPROTO_SCTP  SCTP_INIT      struct sctp_initmsg
120  *
121  */
122 struct sctp_initmsg {
123         __u16 sinit_num_ostreams;
124         __u16 sinit_max_instreams;
125         __u16 sinit_max_attempts;
126         __u16 sinit_max_init_timeo;
127 };
128
129 /*
130  * 5.2.2 SCTP Header Information Structure (SCTP_SNDRCV)
131  *
132  *   This cmsghdr structure specifies SCTP options for sendmsg() and
133  *   describes SCTP header information about a received message through
134  *   recvmsg().
135  *
136  *   cmsg_level    cmsg_type      cmsg_data[]
137  *   ------------  ------------   ----------------------
138  *   IPPROTO_SCTP  SCTP_SNDRCV    struct sctp_sndrcvinfo
139  *
140  */
141 struct sctp_sndrcvinfo {
142         __u16 sinfo_stream;
143         __u16 sinfo_ssn;
144         __u16 sinfo_flags;
145         __u32 sinfo_ppid;
146         __u32 sinfo_context;
147         __u32 sinfo_timetolive;
148         __u32 sinfo_tsn;
149         __u32 sinfo_cumtsn;
150         sctp_assoc_t sinfo_assoc_id;
151 };
152
153 /*
154  *  sinfo_flags: 16 bits (unsigned integer)
155  *
156  *   This field may contain any of the following flags and is composed of
157  *   a bitwise OR of these values.
158  */
159
160 enum sctp_sinfo_flags {
161         SCTP_UNORDERED = 1,  /* Send/receive message unordered. */
162         SCTP_ADDR_OVER = 2,  /* Override the primary destination. */
163         SCTP_ABORT=4,        /* Send an ABORT message to the peer. */
164         SCTP_SACK_IMMEDIATELY = 8,      /* SACK should be sent without delay */
165         SCTP_EOF=MSG_FIN,    /* Initiate graceful shutdown process. */  
166 };
167
168
169 /* These are cmsg_types.  */
170 typedef enum sctp_cmsg_type {
171         SCTP_INIT,              /* 5.2.1 SCTP Initiation Structure */
172         SCTP_SNDRCV,            /* 5.2.2 SCTP Header Information Structure */
173 } sctp_cmsg_t;
174
175
176 /*
177  * 5.3.1.1 SCTP_ASSOC_CHANGE
178  *
179  *   Communication notifications inform the ULP that an SCTP association
180  *   has either begun or ended. The identifier for a new association is
181  *   provided by this notificaion. The notification information has the
182  *   following format:
183  *
184  */
185 struct sctp_assoc_change {
186         __u16 sac_type;
187         __u16 sac_flags;
188         __u32 sac_length;
189         __u16 sac_state;
190         __u16 sac_error;
191         __u16 sac_outbound_streams;
192         __u16 sac_inbound_streams;
193         sctp_assoc_t sac_assoc_id;
194         __u8 sac_info[0];
195 };
196
197 /*
198  *   sac_state: 32 bits (signed integer)
199  *
200  *   This field holds one of a number of values that communicate the
201  *   event that happened to the association.  They include:
202  *
203  *   Note:  The following state names deviate from the API draft as
204  *   the names clash too easily with other kernel symbols.
205  */
206 enum sctp_sac_state {
207         SCTP_COMM_UP,
208         SCTP_COMM_LOST,
209         SCTP_RESTART,
210         SCTP_SHUTDOWN_COMP,
211         SCTP_CANT_STR_ASSOC,
212 };
213
214 /*
215  * 5.3.1.2 SCTP_PEER_ADDR_CHANGE
216  *
217  *   When a destination address on a multi-homed peer encounters a change
218  *   an interface details event is sent.  The information has the
219  *   following structure:
220  */
221 struct sctp_paddr_change {
222         __u16 spc_type;
223         __u16 spc_flags;
224         __u32 spc_length;
225         struct sockaddr_storage spc_aaddr;
226         int spc_state;
227         int spc_error;
228         sctp_assoc_t spc_assoc_id;
229 } __attribute__((packed, aligned(4)));
230
231 /*
232  *    spc_state:  32 bits (signed integer)
233  *
234  *   This field holds one of a number of values that communicate the
235  *   event that happened to the address.  They include:
236  */
237 enum sctp_spc_state {
238         SCTP_ADDR_AVAILABLE,
239         SCTP_ADDR_UNREACHABLE,
240         SCTP_ADDR_REMOVED,
241         SCTP_ADDR_ADDED,
242         SCTP_ADDR_MADE_PRIM,
243         SCTP_ADDR_CONFIRMED,
244 };
245
246
247 /*
248  * 5.3.1.3 SCTP_REMOTE_ERROR
249  *
250  *   A remote peer may send an Operational Error message to its peer.
251  *   This message indicates a variety of error conditions on an
252  *   association. The entire error TLV as it appears on the wire is
253  *   included in a SCTP_REMOTE_ERROR event.  Please refer to the SCTP
254  *   specification [SCTP] and any extensions for a list of possible
255  *   error formats. SCTP error TLVs have the format:
256  */
257 struct sctp_remote_error {
258         __u16 sre_type;
259         __u16 sre_flags;
260         __u32 sre_length;
261         __u16 sre_error;
262         sctp_assoc_t sre_assoc_id;
263         __u8 sre_data[0];
264 };
265
266
267 /*
268  * 5.3.1.4 SCTP_SEND_FAILED
269  *
270  *   If SCTP cannot deliver a message it may return the message as a
271  *   notification.
272  */
273 struct sctp_send_failed {
274         __u16 ssf_type;
275         __u16 ssf_flags;
276         __u32 ssf_length;
277         __u32 ssf_error;
278         struct sctp_sndrcvinfo ssf_info;
279         sctp_assoc_t ssf_assoc_id;
280         __u8 ssf_data[0];
281 };
282
283 /*
284  *   ssf_flags: 16 bits (unsigned integer)
285  *
286  *   The flag value will take one of the following values
287  *
288  *   SCTP_DATA_UNSENT  - Indicates that the data was never put on
289  *                       the wire.
290  *
291  *   SCTP_DATA_SENT    - Indicates that the data was put on the wire.
292  *                       Note that this does not necessarily mean that the
293  *                       data was (or was not) successfully delivered.
294  */
295 enum sctp_ssf_flags {
296         SCTP_DATA_UNSENT,
297         SCTP_DATA_SENT,
298 };
299
300 /*
301  * 5.3.1.5 SCTP_SHUTDOWN_EVENT
302  *
303  *   When a peer sends a SHUTDOWN, SCTP delivers this notification to
304  *   inform the application that it should cease sending data.
305  */
306 struct sctp_shutdown_event {
307         __u16 sse_type;
308         __u16 sse_flags;
309         __u32 sse_length;
310         sctp_assoc_t sse_assoc_id;
311 };
312
313 /*
314  * 5.3.1.6 SCTP_ADAPTATION_INDICATION
315  *
316  *   When a peer sends a Adaptation Layer Indication parameter , SCTP
317  *   delivers this notification to inform the application
318  *   that of the peers requested adaptation layer.
319  */
320 struct sctp_adaptation_event {
321         __u16 sai_type;
322         __u16 sai_flags;
323         __u32 sai_length;
324         __u32 sai_adaptation_ind;
325         sctp_assoc_t sai_assoc_id;
326 };
327
328 /*
329  * 5.3.1.7 SCTP_PARTIAL_DELIVERY_EVENT
330  *
331  *   When a receiver is engaged in a partial delivery of a
332  *   message this notification will be used to indicate
333  *   various events.
334  */
335 struct sctp_pdapi_event {
336         __u16 pdapi_type;
337         __u16 pdapi_flags;
338         __u32 pdapi_length;
339         __u32 pdapi_indication;
340         sctp_assoc_t pdapi_assoc_id;
341 };
342
343 enum { SCTP_PARTIAL_DELIVERY_ABORTED=0, };
344
345 struct sctp_authkey_event {
346         __u16 auth_type;
347         __u16 auth_flags;
348         __u32 auth_length;
349         __u16 auth_keynumber;
350         __u16 auth_altkeynumber;
351         __u32 auth_indication;
352         sctp_assoc_t auth_assoc_id;
353 };
354
355 enum { SCTP_AUTH_NEWKEY = 0, };
356
357 /*
358  * 6.1.9. SCTP_SENDER_DRY_EVENT
359  *
360  * When the SCTP stack has no more user data to send or retransmit, this
361  * notification is given to the user. Also, at the time when a user app
362  * subscribes to this event, if there is no data to be sent or
363  * retransmit, the stack will immediately send up this notification.
364  */
365 struct sctp_sender_dry_event {
366         __u16 sender_dry_type;
367         __u16 sender_dry_flags;
368         __u32 sender_dry_length;
369         sctp_assoc_t sender_dry_assoc_id;
370 };
371
372 /*
373  * Described in Section 7.3
374  *   Ancillary Data and Notification Interest Options
375  */
376 struct sctp_event_subscribe {
377         __u8 sctp_data_io_event;
378         __u8 sctp_association_event;
379         __u8 sctp_address_event;
380         __u8 sctp_send_failure_event;
381         __u8 sctp_peer_error_event;
382         __u8 sctp_shutdown_event;
383         __u8 sctp_partial_delivery_event;
384         __u8 sctp_adaptation_layer_event;
385         __u8 sctp_authentication_event;
386         __u8 sctp_sender_dry_event;
387 };
388
389 /*
390  * 5.3.1 SCTP Notification Structure
391  *
392  *   The notification structure is defined as the union of all
393  *   notification types.
394  *
395  */
396 union sctp_notification {
397         struct {
398                 __u16 sn_type;             /* Notification type. */
399                 __u16 sn_flags;
400                 __u32 sn_length;
401         } sn_header;
402         struct sctp_assoc_change sn_assoc_change;
403         struct sctp_paddr_change sn_paddr_change;
404         struct sctp_remote_error sn_remote_error;
405         struct sctp_send_failed sn_send_failed;
406         struct sctp_shutdown_event sn_shutdown_event;
407         struct sctp_adaptation_event sn_adaptation_event;
408         struct sctp_pdapi_event sn_pdapi_event;
409         struct sctp_authkey_event sn_authkey_event;
410         struct sctp_sender_dry_event sn_sender_dry_event;
411 };
412
413 /* Section 5.3.1
414  * All standard values for sn_type flags are greater than 2^15.
415  * Values from 2^15 and down are reserved.
416  */
417
418 enum sctp_sn_type {
419         SCTP_SN_TYPE_BASE     = (1<<15),
420         SCTP_ASSOC_CHANGE,
421         SCTP_PEER_ADDR_CHANGE,
422         SCTP_SEND_FAILED,
423         SCTP_REMOTE_ERROR,
424         SCTP_SHUTDOWN_EVENT,
425         SCTP_PARTIAL_DELIVERY_EVENT,
426         SCTP_ADAPTATION_INDICATION,
427         SCTP_AUTHENTICATION_EVENT,
428 #define SCTP_AUTHENTICATION_INDICATION  SCTP_AUTHENTICATION_EVENT
429         SCTP_SENDER_DRY_EVENT,
430 };
431
432 /* Notification error codes used to fill up the error fields in some
433  * notifications.
434  * SCTP_PEER_ADDRESS_CHAGE      : spc_error
435  * SCTP_ASSOC_CHANGE            : sac_error
436  * These names should be potentially included in the draft 04 of the SCTP
437  * sockets API specification.
438  */
439 typedef enum sctp_sn_error {
440         SCTP_FAILED_THRESHOLD,
441         SCTP_RECEIVED_SACK,
442         SCTP_HEARTBEAT_SUCCESS,
443         SCTP_RESPONSE_TO_USER_REQ,
444         SCTP_INTERNAL_ERROR,
445         SCTP_SHUTDOWN_GUARD_EXPIRES,
446         SCTP_PEER_FAULTY,
447 } sctp_sn_error_t;
448
449 /*
450  * 7.1.1 Retransmission Timeout Parameters (SCTP_RTOINFO)
451  *
452  *   The protocol parameters used to initialize and bound retransmission
453  *   timeout (RTO) are tunable.  See [SCTP] for more information on how
454  *   these parameters are used in RTO calculation. 
455  */
456 struct sctp_rtoinfo {
457         sctp_assoc_t    srto_assoc_id;
458         __u32           srto_initial;
459         __u32           srto_max;
460         __u32           srto_min;
461 };
462
463 /*
464  * 7.1.2 Association Parameters (SCTP_ASSOCINFO)
465  *
466  *   This option is used to both examine and set various association and
467  *   endpoint parameters.
468  */
469 struct sctp_assocparams {
470         sctp_assoc_t    sasoc_assoc_id;
471         __u16           sasoc_asocmaxrxt;
472         __u16           sasoc_number_peer_destinations;
473         __u32           sasoc_peer_rwnd;
474         __u32           sasoc_local_rwnd;
475         __u32           sasoc_cookie_life;
476 };
477
478 /*
479  * 7.1.9 Set Peer Primary Address (SCTP_SET_PEER_PRIMARY_ADDR)
480  *
481  *  Requests that the peer mark the enclosed address as the association
482  *  primary. The enclosed address must be one of the association's
483  *  locally bound addresses. The following structure is used to make a
484  *   set primary request:
485  */
486 struct sctp_setpeerprim {
487         sctp_assoc_t            sspp_assoc_id;
488         struct sockaddr_storage sspp_addr;
489 } __attribute__((packed, aligned(4)));
490
491 /*
492  * 7.1.10 Set Primary Address (SCTP_PRIMARY_ADDR)
493  *
494  *  Requests that the local SCTP stack use the enclosed peer address as
495  *  the association primary. The enclosed address must be one of the
496  *  association peer's addresses. The following structure is used to
497  *  make a set peer primary request:
498  */
499 struct sctp_prim {
500         sctp_assoc_t            ssp_assoc_id;
501         struct sockaddr_storage ssp_addr;
502 } __attribute__((packed, aligned(4)));
503
504 /*
505  * 7.1.11 Set Adaptation Layer Indicator (SCTP_ADAPTATION_LAYER)
506  *
507  * Requests that the local endpoint set the specified Adaptation Layer
508  * Indication parameter for all future INIT and INIT-ACK exchanges.
509  */
510 struct sctp_setadaptation {
511         __u32   ssb_adaptation_ind;
512 };
513
514 /*
515  * 7.1.13 Peer Address Parameters  (SCTP_PEER_ADDR_PARAMS)
516  *
517  *   Applications can enable or disable heartbeats for any peer address
518  *   of an association, modify an address's heartbeat interval, force a
519  *   heartbeat to be sent immediately, and adjust the address's maximum
520  *   number of retransmissions sent before an address is considered
521  *   unreachable. The following structure is used to access and modify an
522  *   address's parameters:
523  */
524 enum  sctp_spp_flags {
525         SPP_HB_ENABLE = 1<<0,           /*Enable heartbeats*/
526         SPP_HB_DISABLE = 1<<1,          /*Disable heartbeats*/
527         SPP_HB = SPP_HB_ENABLE | SPP_HB_DISABLE,
528         SPP_HB_DEMAND = 1<<2,           /*Send heartbeat immediately*/
529         SPP_PMTUD_ENABLE = 1<<3,        /*Enable PMTU discovery*/
530         SPP_PMTUD_DISABLE = 1<<4,       /*Disable PMTU discovery*/
531         SPP_PMTUD = SPP_PMTUD_ENABLE | SPP_PMTUD_DISABLE,
532         SPP_SACKDELAY_ENABLE = 1<<5,    /*Enable SACK*/
533         SPP_SACKDELAY_DISABLE = 1<<6,   /*Disable SACK*/
534         SPP_SACKDELAY = SPP_SACKDELAY_ENABLE | SPP_SACKDELAY_DISABLE,
535         SPP_HB_TIME_IS_ZERO = 1<<7,     /* Set HB delay to 0 */
536 };
537
538 struct sctp_paddrparams {
539         sctp_assoc_t            spp_assoc_id;
540         struct sockaddr_storage spp_address;
541         __u32                   spp_hbinterval;
542         __u16                   spp_pathmaxrxt;
543         __u32                   spp_pathmtu;
544         __u32                   spp_sackdelay;
545         __u32                   spp_flags;
546 } __attribute__((packed, aligned(4)));
547
548 /*
549  * 7.1.18.  Add a chunk that must be authenticated (SCTP_AUTH_CHUNK)
550  *
551  * This set option adds a chunk type that the user is requesting to be
552  * received only in an authenticated way.  Changes to the list of chunks
553  * will only effect future associations on the socket.
554  */
555 struct sctp_authchunk {
556         __u8            sauth_chunk;
557 };
558
559 /*
560  * 7.1.19.  Get or set the list of supported HMAC Identifiers (SCTP_HMAC_IDENT)
561  *
562  * This option gets or sets the list of HMAC algorithms that the local
563  * endpoint requires the peer to use.
564 */
565 struct sctp_hmacalgo {
566         __u32           shmac_num_idents;
567         __u16           shmac_idents[];
568 };
569
570 /*
571  * 7.1.20.  Set a shared key (SCTP_AUTH_KEY)
572  *
573  * This option will set a shared secret key which is used to build an
574  * association shared key.
575  */
576 struct sctp_authkey {
577         sctp_assoc_t    sca_assoc_id;
578         __u16           sca_keynumber;
579         __u16           sca_keylength;
580         __u8            sca_key[];
581 };
582
583 /*
584  * 7.1.21.  Get or set the active shared key (SCTP_AUTH_ACTIVE_KEY)
585  *
586  * This option will get or set the active shared key to be used to build
587  * the association shared key.
588  */
589
590 struct sctp_authkeyid {
591         sctp_assoc_t    scact_assoc_id;
592         __u16           scact_keynumber;
593 };
594
595
596 /*
597  * 7.1.23.  Get or set delayed ack timer (SCTP_DELAYED_SACK)
598  *
599  * This option will effect the way delayed acks are performed.  This
600  * option allows you to get or set the delayed ack time, in
601  * milliseconds.  It also allows changing the delayed ack frequency.
602  * Changing the frequency to 1 disables the delayed sack algorithm.  If
603  * the assoc_id is 0, then this sets or gets the endpoints default
604  * values.  If the assoc_id field is non-zero, then the set or get
605  * effects the specified association for the one to many model (the
606  * assoc_id field is ignored by the one to one model).  Note that if
607  * sack_delay or sack_freq are 0 when setting this option, then the
608  * current values will remain unchanged.
609  */
610 struct sctp_sack_info {
611         sctp_assoc_t    sack_assoc_id;
612         uint32_t        sack_delay;
613         uint32_t        sack_freq;
614 };
615
616 struct sctp_assoc_value {
617     sctp_assoc_t            assoc_id;
618     uint32_t                assoc_value;
619 };
620
621 /*
622  * 7.2.2 Peer Address Information
623  *
624  *   Applications can retrieve information about a specific peer address
625  *   of an association, including its reachability state, congestion
626  *   window, and retransmission timer values.  This information is
627  *   read-only. The following structure is used to access this
628  *   information:
629  */
630 struct sctp_paddrinfo {
631         sctp_assoc_t            spinfo_assoc_id;
632         struct sockaddr_storage spinfo_address;
633         __s32                   spinfo_state;
634         __u32                   spinfo_cwnd;
635         __u32                   spinfo_srtt;
636         __u32                   spinfo_rto;
637         __u32                   spinfo_mtu;
638 } __attribute__((packed, aligned(4)));
639
640 /* Peer addresses's state. */
641 /* UNKNOWN: Peer address passed by the upper layer in sendmsg or connect[x]
642  * calls.
643  * UNCONFIRMED: Peer address received in INIT/INIT-ACK address parameters.
644  *              Not yet confirmed by a heartbeat and not available for data
645  *              transfers.
646  * ACTIVE : Peer address confirmed, active and available for data transfers.
647  * INACTIVE: Peer address inactive and not available for data transfers.
648  */
649 enum sctp_spinfo_state {
650         SCTP_INACTIVE,
651         SCTP_ACTIVE,
652         SCTP_UNCONFIRMED,
653         SCTP_UNKNOWN = 0xffff  /* Value used for transport state unknown */
654 };
655
656 /*
657  * 7.2.1 Association Status (SCTP_STATUS)
658  *
659  *   Applications can retrieve current status information about an
660  *   association, including association state, peer receiver window size,
661  *   number of unacked data chunks, and number of data chunks pending
662  *   receipt.  This information is read-only.  The following structure is
663  *   used to access this information:
664  */
665 struct sctp_status {
666         sctp_assoc_t            sstat_assoc_id;
667         __s32                   sstat_state;
668         __u32                   sstat_rwnd;
669         __u16                   sstat_unackdata;
670         __u16                   sstat_penddata;
671         __u16                   sstat_instrms;
672         __u16                   sstat_outstrms;
673         __u32                   sstat_fragmentation_point;
674         struct sctp_paddrinfo   sstat_primary;
675 };
676
677 /*
678  * 7.2.3.  Get the list of chunks the peer requires to be authenticated
679  *         (SCTP_PEER_AUTH_CHUNKS)
680  *
681  * This option gets a list of chunks for a specified association that
682  * the peer requires to be received authenticated only.
683  */
684 struct sctp_authchunks {
685         sctp_assoc_t    gauth_assoc_id;
686         __u32           gauth_number_of_chunks;
687         uint8_t         gauth_chunks[];
688 };
689
690 /*
691  * 8.2.6. Get the Current Identifiers of Associations
692  *        (SCTP_GET_ASSOC_ID_LIST)
693  *
694  * This option gets the current list of SCTP association identifiers of
695  * the SCTP associations handled by a one-to-many style socket.
696  */
697 struct sctp_assoc_ids {
698         __u32           gaids_number_of_ids;
699         sctp_assoc_t    gaids_assoc_id[];
700 };
701
702 /*
703  * 8.3, 8.5 get all peer/local addresses in an association.
704  * This parameter struct is used by SCTP_GET_PEER_ADDRS and 
705  * SCTP_GET_LOCAL_ADDRS socket options used internally to implement
706  * sctp_getpaddrs() and sctp_getladdrs() API. 
707  */
708 struct sctp_getaddrs_old {
709         sctp_assoc_t            assoc_id;
710         int                     addr_num;
711         struct sockaddr         __user *addrs;
712 };
713 struct sctp_getaddrs {
714         sctp_assoc_t            assoc_id; /*input*/
715         __u32                   addr_num; /*output*/
716         __u8                    addrs[0]; /*output, variable size*/
717 };
718
719 /* These are bit fields for msghdr->msg_flags.  See section 5.1.  */
720 /* On user space Linux, these live in <bits/socket.h> as an enum.  */
721 enum sctp_msg_flags {
722         MSG_NOTIFICATION = 0x8000,
723 #define MSG_NOTIFICATION MSG_NOTIFICATION
724 };
725
726 /*
727  * 8.1 sctp_bindx()
728  *
729  * The flags parameter is formed from the bitwise OR of zero or more of the
730  * following currently defined flags:
731  */
732 #define SCTP_BINDX_ADD_ADDR 0x01
733 #define SCTP_BINDX_REM_ADDR 0x02
734
735 /* This is the structure that is passed as an argument(optval) to
736  * getsockopt(SCTP_SOCKOPT_PEELOFF).
737  */
738 typedef struct {
739         sctp_assoc_t associd;
740         int sd;
741 } sctp_peeloff_arg_t;
742
743 #endif /* __net_sctp_user_h__ */