[SCTP]: Fix typo adaption -> adaptation as per the latest API draft.
[linux-3.10.git] / include / net / sctp / user.h
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.
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
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 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_ADAPTATION_LAYER,
79 #define SCTP_ADAPTATION_LAYER SCTP_ADAPTATION_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
96         SCTP_DELAYED_ACK_TIME,
97 #define SCTP_DELAYED_ACK_TIME SCTP_DELAYED_ACK_TIME
98         SCTP_CONTEXT,   /* Receive Context */
99 #define SCTP_CONTEXT SCTP_CONTEXT
100
101         /* Internal Socket Options. Some of the sctp library functions are 
102          * implemented using these socket options.
103          */
104         SCTP_SOCKOPT_BINDX_ADD = 100,/* BINDX requests for adding addresses. */
105 #define SCTP_SOCKOPT_BINDX_ADD  SCTP_SOCKOPT_BINDX_ADD
106         SCTP_SOCKOPT_BINDX_REM, /* BINDX requests for removing addresses. */
107 #define SCTP_SOCKOPT_BINDX_REM  SCTP_SOCKOPT_BINDX_REM
108         SCTP_SOCKOPT_PEELOFF,   /* peel off association. */
109 #define SCTP_SOCKOPT_PEELOFF    SCTP_SOCKOPT_PEELOFF
110         SCTP_GET_PEER_ADDRS_NUM_OLD,    /* Get number of peer addresss. */
111 #define SCTP_GET_PEER_ADDRS_NUM_OLD     SCTP_GET_PEER_ADDRS_NUM_OLD
112         SCTP_GET_PEER_ADDRS_OLD,        /* Get all peer addresss. */
113 #define SCTP_GET_PEER_ADDRS_OLD SCTP_GET_PEER_ADDRS_OLD
114         SCTP_GET_LOCAL_ADDRS_NUM_OLD,   /* Get number of local addresss. */
115 #define SCTP_GET_LOCAL_ADDRS_NUM_OLD    SCTP_GET_LOCAL_ADDRS_NUM_OLD
116         SCTP_GET_LOCAL_ADDRS_OLD,       /* Get all local addresss. */
117 #define SCTP_GET_LOCAL_ADDRS_OLD        SCTP_GET_LOCAL_ADDRS_OLD
118         SCTP_SOCKOPT_CONNECTX, /* CONNECTX requests. */
119 #define SCTP_SOCKOPT_CONNECTX   SCTP_SOCKOPT_CONNECTX
120         SCTP_GET_PEER_ADDRS,    /* Get all peer addresss. */
121 #define SCTP_GET_PEER_ADDRS     SCTP_GET_PEER_ADDRS
122         SCTP_GET_LOCAL_ADDRS,   /* Get all local addresss. */
123 #define SCTP_GET_LOCAL_ADDRS    SCTP_GET_LOCAL_ADDRS
124 };
125
126 /*
127  * 5.2.1 SCTP Initiation Structure (SCTP_INIT)
128  *
129  *   This cmsghdr structure provides information for initializing new
130  *   SCTP associations with sendmsg().  The SCTP_INITMSG socket option
131  *   uses this same data structure.  This structure is not used for
132  *   recvmsg().
133  *
134  *   cmsg_level    cmsg_type      cmsg_data[]
135  *   ------------  ------------   ----------------------
136  *   IPPROTO_SCTP  SCTP_INIT      struct sctp_initmsg
137  *
138  */
139 struct sctp_initmsg {
140         __u16 sinit_num_ostreams;
141         __u16 sinit_max_instreams;
142         __u16 sinit_max_attempts;
143         __u16 sinit_max_init_timeo;
144 };
145
146 /*
147  * 5.2.2 SCTP Header Information Structure (SCTP_SNDRCV)
148  *
149  *   This cmsghdr structure specifies SCTP options for sendmsg() and
150  *   describes SCTP header information about a received message through
151  *   recvmsg().
152  *
153  *   cmsg_level    cmsg_type      cmsg_data[]
154  *   ------------  ------------   ----------------------
155  *   IPPROTO_SCTP  SCTP_SNDRCV    struct sctp_sndrcvinfo
156  *
157  */
158 struct sctp_sndrcvinfo {
159         __u16 sinfo_stream;
160         __u16 sinfo_ssn;
161         __u16 sinfo_flags;
162         __u32 sinfo_ppid;
163         __u32 sinfo_context;
164         __u32 sinfo_timetolive;
165         __u32 sinfo_tsn;
166         __u32 sinfo_cumtsn;
167         sctp_assoc_t sinfo_assoc_id;
168 };
169
170 /*
171  *  sinfo_flags: 16 bits (unsigned integer)
172  *
173  *   This field may contain any of the following flags and is composed of
174  *   a bitwise OR of these values.
175  */
176
177 enum sctp_sinfo_flags {
178         SCTP_UNORDERED = 1,  /* Send/receive message unordered. */
179         SCTP_ADDR_OVER = 2,  /* Override the primary destination. */
180         SCTP_ABORT=4,        /* Send an ABORT message to the peer. */
181         SCTP_EOF=MSG_FIN,    /* Initiate graceful shutdown process. */  
182 };
183
184
185 typedef union {
186         __u8                    raw;
187         struct sctp_initmsg     init;
188         struct sctp_sndrcvinfo  sndrcv;
189 } sctp_cmsg_data_t;
190
191 /* These are cmsg_types.  */
192 typedef enum sctp_cmsg_type {
193         SCTP_INIT,              /* 5.2.1 SCTP Initiation Structure */
194         SCTP_SNDRCV,            /* 5.2.2 SCTP Header Information Structure */
195 } sctp_cmsg_t;
196
197
198 /*
199  * 5.3.1.1 SCTP_ASSOC_CHANGE
200  *
201  *   Communication notifications inform the ULP that an SCTP association
202  *   has either begun or ended. The identifier for a new association is
203  *   provided by this notificaion. The notification information has the
204  *   following format:
205  *
206  */
207 struct sctp_assoc_change {
208         __u16 sac_type;
209         __u16 sac_flags;
210         __u32 sac_length;
211         __u16 sac_state;
212         __u16 sac_error;
213         __u16 sac_outbound_streams;
214         __u16 sac_inbound_streams;
215         sctp_assoc_t sac_assoc_id;
216 };
217
218 /*
219  *   sac_state: 32 bits (signed integer)
220  *
221  *   This field holds one of a number of values that communicate the
222  *   event that happened to the association.  They include:
223  *
224  *   Note:  The following state names deviate from the API draft as
225  *   the names clash too easily with other kernel symbols.
226  */
227 enum sctp_sac_state {
228         SCTP_COMM_UP,
229         SCTP_COMM_LOST,
230         SCTP_RESTART,
231         SCTP_SHUTDOWN_COMP,
232         SCTP_CANT_STR_ASSOC,
233 };
234
235 /*
236  * 5.3.1.2 SCTP_PEER_ADDR_CHANGE
237  *
238  *   When a destination address on a multi-homed peer encounters a change
239  *   an interface details event is sent.  The information has the
240  *   following structure:
241  */
242 struct sctp_paddr_change {
243         __u16 spc_type;
244         __u16 spc_flags;
245         __u32 spc_length;
246         struct sockaddr_storage spc_aaddr;
247         int spc_state;
248         int spc_error;
249         sctp_assoc_t spc_assoc_id;
250 } __attribute__((packed, aligned(4)));
251
252 /*
253  *    spc_state:  32 bits (signed integer)
254  *
255  *   This field holds one of a number of values that communicate the
256  *   event that happened to the address.  They include:
257  */
258 enum sctp_spc_state {
259         SCTP_ADDR_AVAILABLE,
260         SCTP_ADDR_UNREACHABLE,
261         SCTP_ADDR_REMOVED,
262         SCTP_ADDR_ADDED,
263         SCTP_ADDR_MADE_PRIM,
264 };
265
266
267 /*
268  * 5.3.1.3 SCTP_REMOTE_ERROR
269  *
270  *   A remote peer may send an Operational Error message to its peer.
271  *   This message indicates a variety of error conditions on an
272  *   association. The entire error TLV as it appears on the wire is
273  *   included in a SCTP_REMOTE_ERROR event.  Please refer to the SCTP
274  *   specification [SCTP] and any extensions for a list of possible
275  *   error formats. SCTP error TLVs have the format:
276  */
277 struct sctp_remote_error {
278         __u16 sre_type;
279         __u16 sre_flags;
280         __u32 sre_length;
281         __u16 sre_error;
282         sctp_assoc_t sre_assoc_id;
283         __u8 sre_data[0];
284 };
285
286
287 /*
288  * 5.3.1.4 SCTP_SEND_FAILED
289  *
290  *   If SCTP cannot deliver a message it may return the message as a
291  *   notification.
292  */
293 struct sctp_send_failed {
294         __u16 ssf_type;
295         __u16 ssf_flags;
296         __u32 ssf_length;
297         __u32 ssf_error;
298         struct sctp_sndrcvinfo ssf_info;
299         sctp_assoc_t ssf_assoc_id;
300         __u8 ssf_data[0];
301 };
302
303 /*
304  *   ssf_flags: 16 bits (unsigned integer)
305  *
306  *   The flag value will take one of the following values
307  *
308  *   SCTP_DATA_UNSENT  - Indicates that the data was never put on
309  *                       the wire.
310  *
311  *   SCTP_DATA_SENT    - Indicates that the data was put on the wire.
312  *                       Note that this does not necessarily mean that the
313  *                       data was (or was not) successfully delivered.
314  */
315 enum sctp_ssf_flags {
316         SCTP_DATA_UNSENT,
317         SCTP_DATA_SENT,
318 };
319
320 /*
321  * 5.3.1.5 SCTP_SHUTDOWN_EVENT
322  *
323  *   When a peer sends a SHUTDOWN, SCTP delivers this notification to
324  *   inform the application that it should cease sending data.
325  */
326 struct sctp_shutdown_event {
327         __u16 sse_type;
328         __u16 sse_flags;
329         __u32 sse_length;
330         sctp_assoc_t sse_assoc_id;
331 };
332
333 /*
334  * 5.3.1.6 SCTP_ADAPTATION_INDICATION
335  *
336  *   When a peer sends a Adaptation Layer Indication parameter , SCTP
337  *   delivers this notification to inform the application
338  *   that of the peers requested adaptation layer.
339  */
340 struct sctp_adaptation_event {
341         __u16 sai_type;
342         __u16 sai_flags;
343         __u32 sai_length;
344         __u32 sai_adaptation_ind;
345         sctp_assoc_t sai_assoc_id;
346 };
347
348 /*
349  * 5.3.1.7 SCTP_PARTIAL_DELIVERY_EVENT
350  *
351  *   When a receiver is engaged in a partial delivery of a
352  *   message this notification will be used to indicate
353  *   various events.
354  */
355 struct sctp_pdapi_event {
356         __u16 pdapi_type;
357         __u16 pdapi_flags;
358         __u32 pdapi_length;
359         __u32 pdapi_indication;
360         sctp_assoc_t pdapi_assoc_id;
361 };
362
363 enum { SCTP_PARTIAL_DELIVERY_ABORTED=0, };
364
365 /*
366  * Described in Section 7.3
367  *   Ancillary Data and Notification Interest Options
368  */
369 struct sctp_event_subscribe {
370         __u8 sctp_data_io_event;
371         __u8 sctp_association_event;
372         __u8 sctp_address_event;
373         __u8 sctp_send_failure_event;
374         __u8 sctp_peer_error_event;
375         __u8 sctp_shutdown_event;
376         __u8 sctp_partial_delivery_event;
377         __u8 sctp_adaptation_layer_event;
378 };
379
380 /*
381  * 5.3.1 SCTP Notification Structure
382  *
383  *   The notification structure is defined as the union of all
384  *   notification types.
385  *
386  */
387 union sctp_notification {
388         struct {
389                 __u16 sn_type;             /* Notification type. */
390                 __u16 sn_flags;
391                 __u32 sn_length;
392         } sn_header;
393         struct sctp_assoc_change sn_assoc_change;
394         struct sctp_paddr_change sn_paddr_change;
395         struct sctp_remote_error sn_remote_error;
396         struct sctp_send_failed sn_send_failed;
397         struct sctp_shutdown_event sn_shutdown_event;
398         struct sctp_adaptation_event sn_adaptation_event;
399         struct sctp_pdapi_event sn_pdapi_event;
400 };
401
402 /* Section 5.3.1
403  * All standard values for sn_type flags are greater than 2^15.
404  * Values from 2^15 and down are reserved.
405  */
406
407 enum sctp_sn_type {
408         SCTP_SN_TYPE_BASE     = (1<<15),
409         SCTP_ASSOC_CHANGE,
410         SCTP_PEER_ADDR_CHANGE,
411         SCTP_SEND_FAILED,
412         SCTP_REMOTE_ERROR,
413         SCTP_SHUTDOWN_EVENT,
414         SCTP_PARTIAL_DELIVERY_EVENT,
415         SCTP_ADAPTATION_INDICATION,
416 };
417
418 /* Notification error codes used to fill up the error fields in some
419  * notifications.
420  * SCTP_PEER_ADDRESS_CHAGE      : spc_error
421  * SCTP_ASSOC_CHANGE            : sac_error
422  * These names should be potentially included in the draft 04 of the SCTP
423  * sockets API specification.
424  */
425 typedef enum sctp_sn_error {
426         SCTP_FAILED_THRESHOLD,
427         SCTP_RECEIVED_SACK,
428         SCTP_HEARTBEAT_SUCCESS,
429         SCTP_RESPONSE_TO_USER_REQ,
430         SCTP_INTERNAL_ERROR,
431         SCTP_SHUTDOWN_GUARD_EXPIRES,
432         SCTP_PEER_FAULTY,
433 } sctp_sn_error_t;
434
435 /*
436  * 7.1.1 Retransmission Timeout Parameters (SCTP_RTOINFO)
437  *
438  *   The protocol parameters used to initialize and bound retransmission
439  *   timeout (RTO) are tunable.  See [SCTP] for more information on how
440  *   these parameters are used in RTO calculation. 
441  */
442 struct sctp_rtoinfo {
443         sctp_assoc_t    srto_assoc_id;
444         __u32           srto_initial;
445         __u32           srto_max;
446         __u32           srto_min;
447 };
448
449 /*
450  * 7.1.2 Association Parameters (SCTP_ASSOCINFO)
451  *
452  *   This option is used to both examine and set various association and
453  *   endpoint parameters.
454  */
455 struct sctp_assocparams {
456         sctp_assoc_t    sasoc_assoc_id;
457         __u16           sasoc_asocmaxrxt;
458         __u16           sasoc_number_peer_destinations;
459         __u32           sasoc_peer_rwnd;
460         __u32           sasoc_local_rwnd;
461         __u32           sasoc_cookie_life;
462 };
463
464 /*
465  * 7.1.9 Set Peer Primary Address (SCTP_SET_PEER_PRIMARY_ADDR)
466  *
467  *  Requests that the peer mark the enclosed address as the association
468  *  primary. The enclosed address must be one of the association's
469  *  locally bound addresses. The following structure is used to make a
470  *   set primary request:
471  */
472 struct sctp_setpeerprim {
473         sctp_assoc_t            sspp_assoc_id;
474         struct sockaddr_storage sspp_addr;
475 } __attribute__((packed, aligned(4)));
476
477 /*
478  * 7.1.10 Set Primary Address (SCTP_PRIMARY_ADDR)
479  *
480  *  Requests that the local SCTP stack use the enclosed peer address as
481  *  the association primary. The enclosed address must be one of the
482  *  association peer's addresses. The following structure is used to
483  *  make a set peer primary request:
484  */
485 struct sctp_prim {
486         sctp_assoc_t            ssp_assoc_id;
487         struct sockaddr_storage ssp_addr;
488 } __attribute__((packed, aligned(4)));
489
490 /*
491  * 7.1.11 Set Adaptation Layer Indicator (SCTP_ADAPTATION_LAYER)
492  *
493  * Requests that the local endpoint set the specified Adaptation Layer
494  * Indication parameter for all future INIT and INIT-ACK exchanges.
495  */
496 struct sctp_setadaptation {
497         __u32   ssb_adaptation_ind;
498 };
499
500 /*
501  * 7.1.13 Peer Address Parameters  (SCTP_PEER_ADDR_PARAMS)
502  *
503  *   Applications can enable or disable heartbeats for any peer address
504  *   of an association, modify an address's heartbeat interval, force a
505  *   heartbeat to be sent immediately, and adjust the address's maximum
506  *   number of retransmissions sent before an address is considered
507  *   unreachable. The following structure is used to access and modify an
508  *   address's parameters:
509  */
510 enum  sctp_spp_flags {
511         SPP_HB_ENABLE = 1,              /*Enable heartbeats*/
512         SPP_HB_DISABLE = 2,             /*Disable heartbeats*/
513         SPP_HB = SPP_HB_ENABLE | SPP_HB_DISABLE,
514         SPP_HB_DEMAND = 4,              /*Send heartbeat immediately*/
515         SPP_PMTUD_ENABLE = 8,           /*Enable PMTU discovery*/
516         SPP_PMTUD_DISABLE = 16,         /*Disable PMTU discovery*/
517         SPP_PMTUD = SPP_PMTUD_ENABLE | SPP_PMTUD_DISABLE,
518         SPP_SACKDELAY_ENABLE = 32,      /*Enable SACK*/
519         SPP_SACKDELAY_DISABLE = 64,     /*Disable SACK*/
520         SPP_SACKDELAY = SPP_SACKDELAY_ENABLE | SPP_SACKDELAY_DISABLE,
521 };
522
523 struct sctp_paddrparams {
524         sctp_assoc_t            spp_assoc_id;
525         struct sockaddr_storage spp_address;
526         __u32                   spp_hbinterval;
527         __u16                   spp_pathmaxrxt;
528         __u32                   spp_pathmtu;
529         __u32                   spp_sackdelay;
530         __u32                   spp_flags;
531 } __attribute__((packed, aligned(4)));
532
533 /* 7.1.24. Delayed Ack Timer (SCTP_DELAYED_ACK_TIME)
534  *
535  *   This options will get or set the delayed ack timer.  The time is set
536  *   in milliseconds.  If the assoc_id is 0, then this sets or gets the
537  *   endpoints default delayed ack timer value.  If the assoc_id field is
538  *   non-zero, then the set or get effects the specified association.
539  */
540 struct sctp_assoc_value {
541     sctp_assoc_t            assoc_id;
542     uint32_t                assoc_value;
543 };
544
545 /*
546  * 7.2.2 Peer Address Information
547  *
548  *   Applications can retrieve information about a specific peer address
549  *   of an association, including its reachability state, congestion
550  *   window, and retransmission timer values.  This information is
551  *   read-only. The following structure is used to access this
552  *   information:
553  */
554 struct sctp_paddrinfo {
555         sctp_assoc_t            spinfo_assoc_id;
556         struct sockaddr_storage spinfo_address;
557         __s32                   spinfo_state;
558         __u32                   spinfo_cwnd;
559         __u32                   spinfo_srtt;
560         __u32                   spinfo_rto;
561         __u32                   spinfo_mtu;
562 } __attribute__((packed, aligned(4)));
563
564 /* Peer addresses's state. */
565 /* UNKNOWN: Peer address passed by the upper layer in sendmsg or connect[x]
566  * calls.
567  * UNCONFIRMED: Peer address received in INIT/INIT-ACK address parameters.
568  *              Not yet confirmed by a heartbeat and not available for data
569  *              transfers.
570  * ACTIVE : Peer address confirmed, active and available for data transfers.
571  * INACTIVE: Peer address inactive and not available for data transfers.
572  */
573 enum sctp_spinfo_state {
574         SCTP_INACTIVE,
575         SCTP_ACTIVE,
576         SCTP_UNCONFIRMED,
577         SCTP_UNKNOWN = 0xffff  /* Value used for transport state unknown */
578 };
579
580 /*
581  * 7.2.1 Association Status (SCTP_STATUS)
582  *
583  *   Applications can retrieve current status information about an
584  *   association, including association state, peer receiver window size,
585  *   number of unacked data chunks, and number of data chunks pending
586  *   receipt.  This information is read-only.  The following structure is
587  *   used to access this information:
588  */
589 struct sctp_status {
590         sctp_assoc_t            sstat_assoc_id;
591         __s32                   sstat_state;
592         __u32                   sstat_rwnd;
593         __u16                   sstat_unackdata;
594         __u16                   sstat_penddata;
595         __u16                   sstat_instrms;
596         __u16                   sstat_outstrms;
597         __u32                   sstat_fragmentation_point;
598         struct sctp_paddrinfo   sstat_primary;
599 };
600
601 /*
602  * 8.3, 8.5 get all peer/local addresses in an association.
603  * This parameter struct is used by SCTP_GET_PEER_ADDRS and 
604  * SCTP_GET_LOCAL_ADDRS socket options used internally to implement
605  * sctp_getpaddrs() and sctp_getladdrs() API. 
606  */
607 struct sctp_getaddrs_old {
608         sctp_assoc_t            assoc_id;
609         int                     addr_num;
610         struct sockaddr         __user *addrs;
611 };
612 struct sctp_getaddrs {
613         sctp_assoc_t            assoc_id; /*input*/
614         __u32                   addr_num; /*output*/
615         __u8                    addrs[0]; /*output, variable size*/
616 };
617
618 /* These are bit fields for msghdr->msg_flags.  See section 5.1.  */
619 /* On user space Linux, these live in <bits/socket.h> as an enum.  */
620 enum sctp_msg_flags {
621         MSG_NOTIFICATION = 0x8000,
622 #define MSG_NOTIFICATION MSG_NOTIFICATION
623 };
624
625 /*
626  * 8.1 sctp_bindx()
627  *
628  * The flags parameter is formed from the bitwise OR of zero or more of the
629  * following currently defined flags:
630  */
631 #define SCTP_BINDX_ADD_ADDR 0x01
632 #define SCTP_BINDX_REM_ADDR 0x02
633
634 /* This is the structure that is passed as an argument(optval) to
635  * getsockopt(SCTP_SOCKOPT_PEELOFF).
636  */
637 typedef struct {
638         sctp_assoc_t associd;
639         int sd;
640 } sctp_peeloff_arg_t;
641
642 #endif /* __net_sctp_user_h__ */