Linux Kernel  3.7.1
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
user.h
Go to the documentation of this file.
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 <[email protected]>
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 <[email protected]>
38  * R. Stewart <[email protected]>
39  * K. Morneau <[email protected]>
40  * Q. Xie <[email protected]>
41  * Karl Knutson <[email protected]>
42  * Jon Grimm <[email protected]>
43  * Daisy Chang <[email protected]>
44  * Ryan Layer <[email protected]>
45  * Ardelle Fan <[email protected]>
46  * Sridhar Samudrala <[email protected]>
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 
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 #define SCTP_AUTO_ASCONF 30
96 #define SCTP_PEER_ADDR_THLDS 31
97 
98 /* Internal Socket Options. Some of the sctp library functions are
99  * implemented using these socket options.
100  */
101 #define SCTP_SOCKOPT_BINDX_ADD 100 /* BINDX requests for adding addrs */
102 #define SCTP_SOCKOPT_BINDX_REM 101 /* BINDX requests for removing addrs. */
103 #define SCTP_SOCKOPT_PEELOFF 102 /* peel off association. */
104 /* Options 104-106 are deprecated and removed. Do not use this space */
105 #define SCTP_SOCKOPT_CONNECTX_OLD 107 /* CONNECTX old requests. */
106 #define SCTP_GET_PEER_ADDRS 108 /* Get all peer address. */
107 #define SCTP_GET_LOCAL_ADDRS 109 /* Get all local address. */
108 #define SCTP_SOCKOPT_CONNECTX 110 /* CONNECTX requests. */
109 #define SCTP_SOCKOPT_CONNECTX3 111 /* CONNECTX requests (updated) */
110 
111 /*
112  * 5.2.1 SCTP Initiation Structure (SCTP_INIT)
113  *
114  * This cmsghdr structure provides information for initializing new
115  * SCTP associations with sendmsg(). The SCTP_INITMSG socket option
116  * uses this same data structure. This structure is not used for
117  * recvmsg().
118  *
119  * cmsg_level cmsg_type cmsg_data[]
120  * ------------ ------------ ----------------------
121  * IPPROTO_SCTP SCTP_INIT struct sctp_initmsg
122  *
123  */
124 struct sctp_initmsg {
129 };
130 
131 /*
132  * 5.2.2 SCTP Header Information Structure (SCTP_SNDRCV)
133  *
134  * This cmsghdr structure specifies SCTP options for sendmsg() and
135  * describes SCTP header information about a received message through
136  * recvmsg().
137  *
138  * cmsg_level cmsg_type cmsg_data[]
139  * ------------ ------------ ----------------------
140  * IPPROTO_SCTP SCTP_SNDRCV struct sctp_sndrcvinfo
141  *
142  */
153 };
154 
155 /*
156  * sinfo_flags: 16 bits (unsigned integer)
157  *
158  * This field may contain any of the following flags and is composed of
159  * a bitwise OR of these values.
160  */
161 
163  SCTP_UNORDERED = 1, /* Send/receive message unordered. */
164  SCTP_ADDR_OVER = 2, /* Override the primary destination. */
165  SCTP_ABORT=4, /* Send an ABORT message to the peer. */
166  SCTP_SACK_IMMEDIATELY = 8, /* SACK should be sent without delay */
167  SCTP_EOF=MSG_FIN, /* Initiate graceful shutdown process. */
168 };
169 
170 
171 /* These are cmsg_types. */
172 typedef enum sctp_cmsg_type {
173  SCTP_INIT, /* 5.2.1 SCTP Initiation Structure */
174  SCTP_SNDRCV, /* 5.2.2 SCTP Header Information Structure */
175 } sctp_cmsg_t;
176 
177 
178 /*
179  * 5.3.1.1 SCTP_ASSOC_CHANGE
180  *
181  * Communication notifications inform the ULP that an SCTP association
182  * has either begun or ended. The identifier for a new association is
183  * provided by this notificaion. The notification information has the
184  * following format:
185  *
186  */
197 };
198 
199 /*
200  * sac_state: 32 bits (signed integer)
201  *
202  * This field holds one of a number of values that communicate the
203  * event that happened to the association. They include:
204  *
205  * Note: The following state names deviate from the API draft as
206  * the names clash too easily with other kernel symbols.
207  */
214 };
215 
216 /*
217  * 5.3.1.2 SCTP_PEER_ADDR_CHANGE
218  *
219  * When a destination address on a multi-homed peer encounters a change
220  * an interface details event is sent. The information has the
221  * following structure:
222  */
231 } __attribute__((packed, aligned(4)));
233 /*
234  * spc_state: 32 bits (signed integer)
235  *
236  * This field holds one of a number of values that communicate the
237  * event that happened to the address. They include:
238  */
246 };
247 
248 
249 /*
250  * 5.3.1.3 SCTP_REMOTE_ERROR
251  *
252  * A remote peer may send an Operational Error message to its peer.
253  * This message indicates a variety of error conditions on an
254  * association. The entire error TLV as it appears on the wire is
255  * included in a SCTP_REMOTE_ERROR event. Please refer to the SCTP
256  * specification [SCTP] and any extensions for a list of possible
257  * error formats. SCTP error TLVs have the format:
258  */
266 };
267 
268 
269 /*
270  * 5.3.1.4 SCTP_SEND_FAILED
271  *
272  * If SCTP cannot deliver a message it may return the message as a
273  * notification.
274  */
283 };
284 
285 /*
286  * ssf_flags: 16 bits (unsigned integer)
287  *
288  * The flag value will take one of the following values
289  *
290  * SCTP_DATA_UNSENT - Indicates that the data was never put on
291  * the wire.
292  *
293  * SCTP_DATA_SENT - Indicates that the data was put on the wire.
294  * Note that this does not necessarily mean that the
295  * data was (or was not) successfully delivered.
296  */
300 };
301 
302 /*
303  * 5.3.1.5 SCTP_SHUTDOWN_EVENT
304  *
305  * When a peer sends a SHUTDOWN, SCTP delivers this notification to
306  * inform the application that it should cease sending data.
307  */
313 };
314 
315 /*
316  * 5.3.1.6 SCTP_ADAPTATION_INDICATION
317  *
318  * When a peer sends a Adaptation Layer Indication parameter , SCTP
319  * delivers this notification to inform the application
320  * that of the peers requested adaptation layer.
321  */
328 };
329 
330 /*
331  * 5.3.1.7 SCTP_PARTIAL_DELIVERY_EVENT
332  *
333  * When a receiver is engaged in a partial delivery of a
334  * message this notification will be used to indicate
335  * various events.
336  */
343 };
344 
346 
355 };
356 
357 enum { SCTP_AUTH_NEWKEY = 0, };
358 
359 /*
360  * 6.1.9. SCTP_SENDER_DRY_EVENT
361  *
362  * When the SCTP stack has no more user data to send or retransmit, this
363  * notification is given to the user. Also, at the time when a user app
364  * subscribes to this event, if there is no data to be sent or
365  * retransmit, the stack will immediately send up this notification.
366  */
372 };
373 
374 /*
375  * Described in Section 7.3
376  * Ancillary Data and Notification Interest Options
377  */
389 };
390 
391 /*
392  * 5.3.1 SCTP Notification Structure
393  *
394  * The notification structure is defined as the union of all
395  * notification types.
396  *
397  */
399  struct {
400  __u16 sn_type; /* Notification type. */
403  } sn_header;
413 };
414 
415 /* Section 5.3.1
416  * All standard values for sn_type flags are greater than 2^15.
417  * Values from 2^15 and down are reserved.
418  */
419 
421  SCTP_SN_TYPE_BASE = (1<<15),
432 };
433 
434 /* Notification error codes used to fill up the error fields in some
435  * notifications.
436  * SCTP_PEER_ADDRESS_CHAGE : spc_error
437  * SCTP_ASSOC_CHANGE : sac_error
438  * These names should be potentially included in the draft 04 of the SCTP
439  * sockets API specification.
440  */
441 typedef enum sctp_sn_error {
450 
451 /*
452  * 7.1.1 Retransmission Timeout Parameters (SCTP_RTOINFO)
453  *
454  * The protocol parameters used to initialize and bound retransmission
455  * timeout (RTO) are tunable. See [SCTP] for more information on how
456  * these parameters are used in RTO calculation.
457  */
458 struct sctp_rtoinfo {
463 };
464 
465 /*
466  * 7.1.2 Association Parameters (SCTP_ASSOCINFO)
467  *
468  * This option is used to both examine and set various association and
469  * endpoint parameters.
470  */
478 };
479 
480 /*
481  * 7.1.9 Set Peer Primary Address (SCTP_SET_PEER_PRIMARY_ADDR)
482  *
483  * Requests that the peer mark the enclosed address as the association
484  * primary. The enclosed address must be one of the association's
485  * locally bound addresses. The following structure is used to make a
486  * set primary request:
487  */
491 } __attribute__((packed, aligned(4)));
493 /*
494  * 7.1.10 Set Primary Address (SCTP_PRIMARY_ADDR)
495  *
496  * Requests that the local SCTP stack use the enclosed peer address as
497  * the association primary. The enclosed address must be one of the
498  * association peer's addresses. The following structure is used to
499  * make a set peer primary request:
500  */
501 struct sctp_prim {
504 } __attribute__((packed, aligned(4)));
506 /*
507  * 7.1.11 Set Adaptation Layer Indicator (SCTP_ADAPTATION_LAYER)
508  *
509  * Requests that the local endpoint set the specified Adaptation Layer
510  * Indication parameter for all future INIT and INIT-ACK exchanges.
511  */
514 };
515 
516 /*
517  * 7.1.13 Peer Address Parameters (SCTP_PEER_ADDR_PARAMS)
518  *
519  * Applications can enable or disable heartbeats for any peer address
520  * of an association, modify an address's heartbeat interval, force a
521  * heartbeat to be sent immediately, and adjust the address's maximum
522  * number of retransmissions sent before an address is considered
523  * unreachable. The following structure is used to access and modify an
524  * address's parameters:
525  */
527  SPP_HB_ENABLE = 1<<0, /*Enable heartbeats*/
528  SPP_HB_DISABLE = 1<<1, /*Disable heartbeats*/
530  SPP_HB_DEMAND = 1<<2, /*Send heartbeat immediately*/
531  SPP_PMTUD_ENABLE = 1<<3, /*Enable PMTU discovery*/
532  SPP_PMTUD_DISABLE = 1<<4, /*Disable PMTU discovery*/
534  SPP_SACKDELAY_ENABLE = 1<<5, /*Enable SACK*/
535  SPP_SACKDELAY_DISABLE = 1<<6, /*Disable SACK*/
537  SPP_HB_TIME_IS_ZERO = 1<<7, /* Set HB delay to 0 */
538 };
539 
548 } __attribute__((packed, aligned(4)));
550 /*
551  * 7.1.18. Add a chunk that must be authenticated (SCTP_AUTH_CHUNK)
552  *
553  * This set option adds a chunk type that the user is requesting to be
554  * received only in an authenticated way. Changes to the list of chunks
555  * will only effect future associations on the socket.
556  */
559 };
560 
561 /*
562  * 7.1.19. Get or set the list of supported HMAC Identifiers (SCTP_HMAC_IDENT)
563  *
564  * This option gets or sets the list of HMAC algorithms that the local
565  * endpoint requires the peer to use.
566 */
570 };
571 
572 /*
573  * 7.1.20. Set a shared key (SCTP_AUTH_KEY)
574  *
575  * This option will set a shared secret key which is used to build an
576  * association shared key.
577  */
578 struct sctp_authkey {
583 };
584 
585 /*
586  * 7.1.21. Get or set the active shared key (SCTP_AUTH_ACTIVE_KEY)
587  *
588  * This option will get or set the active shared key to be used to build
589  * the association shared key.
590  */
591 
595 };
596 
597 
598 /*
599  * 7.1.23. Get or set delayed ack timer (SCTP_DELAYED_SACK)
600  *
601  * This option will effect the way delayed acks are performed. This
602  * option allows you to get or set the delayed ack time, in
603  * milliseconds. It also allows changing the delayed ack frequency.
604  * Changing the frequency to 1 disables the delayed sack algorithm. If
605  * the assoc_id is 0, then this sets or gets the endpoints default
606  * values. If the assoc_id field is non-zero, then the set or get
607  * effects the specified association for the one to many model (the
608  * assoc_id field is ignored by the one to one model). Note that if
609  * sack_delay or sack_freq are 0 when setting this option, then the
610  * current values will remain unchanged.
611  */
616 };
617 
621 };
622 
623 /*
624  * 7.2.2 Peer Address Information
625  *
626  * Applications can retrieve information about a specific peer address
627  * of an association, including its reachability state, congestion
628  * window, and retransmission timer values. This information is
629  * read-only. The following structure is used to access this
630  * information:
631  */
640 } __attribute__((packed, aligned(4)));
642 /* Peer addresses's state. */
643 /* UNKNOWN: Peer address passed by the upper layer in sendmsg or connect[x]
644  * calls.
645  * UNCONFIRMED: Peer address received in INIT/INIT-ACK address parameters.
646  * Not yet confirmed by a heartbeat and not available for data
647  * transfers.
648  * ACTIVE : Peer address confirmed, active and available for data transfers.
649  * INACTIVE: Peer address inactive and not available for data transfers.
650  */
656  SCTP_UNKNOWN = 0xffff /* Value used for transport state unknown */
657 };
658 
659 /*
660  * 7.2.1 Association Status (SCTP_STATUS)
661  *
662  * Applications can retrieve current status information about an
663  * association, including association state, peer receiver window size,
664  * number of unacked data chunks, and number of data chunks pending
665  * receipt. This information is read-only. The following structure is
666  * used to access this information:
667  */
668 struct sctp_status {
678 };
679 
680 /*
681  * 7.2.3. Get the list of chunks the peer requires to be authenticated
682  * (SCTP_PEER_AUTH_CHUNKS)
683  *
684  * This option gets a list of chunks for a specified association that
685  * the peer requires to be received authenticated only.
686  */
691 };
692 
693 /*
694  * 8.2.6. Get the Current Identifiers of Associations
695  * (SCTP_GET_ASSOC_ID_LIST)
696  *
697  * This option gets the current list of SCTP association identifiers of
698  * the SCTP associations handled by a one-to-many style socket.
699  */
703 };
704 
705 /*
706  * 8.3, 8.5 get all peer/local addresses in an association.
707  * This parameter struct is used by SCTP_GET_PEER_ADDRS and
708  * SCTP_GET_LOCAL_ADDRS socket options used internally to implement
709  * sctp_getpaddrs() and sctp_getladdrs() API.
710  */
713  int addr_num;
715 };
718  __u32 addr_num; /*output*/
719  __u8 addrs[0]; /*output, variable size*/
720 };
721 
722 /* These are bit fields for msghdr->msg_flags. See section 5.1. */
723 /* On user space Linux, these live in <bits/socket.h> as an enum. */
726 #define MSG_NOTIFICATION MSG_NOTIFICATION
727 };
728 
729 /*
730  * 8.1 sctp_bindx()
731  *
732  * The flags parameter is formed from the bitwise OR of zero or more of the
733  * following currently defined flags:
734  */
735 #define SCTP_BINDX_ADD_ADDR 0x01
736 #define SCTP_BINDX_REM_ADDR 0x02
737 
738 /* This is the structure that is passed as an argument(optval) to
739  * getsockopt(SCTP_SOCKOPT_PEELOFF).
740  */
741 typedef struct {
743  int sd;
745 
746 /*
747  * Peer Address Thresholds socket option
748  */
754 };
755 #endif /* __net_sctp_user_h__ */