projects / GitHub / mt8127 / android_kernel_alcatel_ttab.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
[SCTP]: Enable the sending of the AUTH chunk.
[GitHub/mt8127/android_kernel_alcatel_ttab.git] / include / net / sctp / constants.h
CommitLineData
1da177e4
LT		 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) 2001 Intel Corp.
6 *
7 * This file is part of the SCTP kernel reference Implementation
8 *
9 * The SCTP reference implementation is free software;
10 * you can redistribute it and/or modify it under the terms of
11 * the GNU General Public License as published by
12 * the Free Software Foundation; either version 2, or (at your option)
13 * any later version.
14 *
15 * The SCTP reference implementation is distributed in the hope that it
16 * will be useful, but WITHOUT ANY WARRANTY; without even the implied
17 * ************************
18 * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
19 * See the GNU General Public License for more details.
20 *
21 * You should have received a copy of the GNU General Public License
22 * along with GNU CC; see the file COPYING. If not, write to
23 * the Free Software Foundation, 59 Temple Place - Suite 330,
24 * Boston, MA 02111-1307, USA.
25 *
26 * Please send any bug reports or fixes you make to the
27 * email address(es):
28 * lksctp developers <lksctp-developers@lists.sourceforge.net>
29 *
30 * Or submit a bug report through the following website:
31 * http://www.sf.net/projects/lksctp
32 *
33 * Written or modified by:
34 * La Monte H.P. Yarroll <piggy@acm.org>
35 * Karl Knutson <karl@athena.chicago.il.us>
36 * Randall Stewart <randall@stewart.chicago.il.us>
37 * Ken Morneau <kmorneau@cisco.com>
38 * Qiaobing Xie <qxie1@motorola.com>
39 * Xingang Guo <xingang.guo@intel.com>
40 * Sridhar Samudrala <samudrala@us.ibm.com>
41 * Daisy Chang <daisyc@us.ibm.com>
42 *
43 * Any bugs reported given to us we will try to fix... any fixes shared will
44 * be incorporated into the next SCTP release.
45 */
46
47#ifndef __sctp_constants_h__
48#define __sctp_constants_h__
49
1da177e4
LT		 50#include <linux/sctp.h>
51#include <linux/ipv6.h> /* For ipv6hdr. */
52#include <net/sctp/user.h>
c752f073 53#include <net/tcp_states.h> /* For TCP states used in sctp_sock_state_t */
1da177e4
LT		 54
55/* Value used for stream negotiation. */
56enum { SCTP_MAX_STREAM = 0xffff };
57enum { SCTP_DEFAULT_OUTSTREAMS = 10 };
58enum { SCTP_DEFAULT_INSTREAMS = SCTP_MAX_STREAM };
59
60/* Since CIDs are sparse, we need all four of the following
61 * symbols. CIDs are dense through SCTP_CID_BASE_MAX.
62 */
63#define SCTP_CID_BASE_MAX SCTP_CID_SHUTDOWN_COMPLETE
64#define SCTP_CID_MAX SCTP_CID_ASCONF_ACK
65
66#define SCTP_NUM_BASE_CHUNK_TYPES (SCTP_CID_BASE_MAX + 1)
1da177e4
LT		 67
68#define SCTP_NUM_ADDIP_CHUNK_TYPES 2
69
70#define SCTP_NUM_PRSCTP_CHUNK_TYPES 1
71
1f485649
VY		 72#define SCTP_NUM_AUTH_CHUNK_TYPES 1
73
74#define SCTP_NUM_CHUNK_TYPES (SCTP_NUM_BASE_CHUNK_TYPES + \
75 SCTP_NUM_ADDIP_CHUNK_TYPES +\
76 SCTP_NUM_PRSCTP_CHUNK_TYPES +\
77 SCTP_NUM_AUTH_CHUNK_TYPES)
78
1da177e4
LT		 79/* These are the different flavours of event. */
80typedef enum {
81
82 SCTP_EVENT_T_CHUNK = 1,
83 SCTP_EVENT_T_TIMEOUT,
84 SCTP_EVENT_T_OTHER,
85 SCTP_EVENT_T_PRIMITIVE
86
87} sctp_event_t;
88
89#define SCTP_EVENT_T_MAX SCTP_EVENT_T_PRIMITIVE
90#define SCTP_EVENT_T_NUM (SCTP_EVENT_T_MAX + 1)
91
92/* As a convenience for the state machine, we append SCTP_EVENT_* and
93 * SCTP_ULP_* to the list of possible chunks.
94 */
95
96typedef enum {
97 SCTP_EVENT_TIMEOUT_NONE = 0,
98 SCTP_EVENT_TIMEOUT_T1_COOKIE,
99 SCTP_EVENT_TIMEOUT_T1_INIT,
100 SCTP_EVENT_TIMEOUT_T2_SHUTDOWN,
101 SCTP_EVENT_TIMEOUT_T3_RTX,
102 SCTP_EVENT_TIMEOUT_T4_RTO,
103 SCTP_EVENT_TIMEOUT_T5_SHUTDOWN_GUARD,
104 SCTP_EVENT_TIMEOUT_HEARTBEAT,
105 SCTP_EVENT_TIMEOUT_SACK,
106 SCTP_EVENT_TIMEOUT_AUTOCLOSE,
107} sctp_event_timeout_t;
108
109#define SCTP_EVENT_TIMEOUT_MAX SCTP_EVENT_TIMEOUT_AUTOCLOSE
110#define SCTP_NUM_TIMEOUT_TYPES (SCTP_EVENT_TIMEOUT_MAX + 1)
111
112typedef enum {
113 SCTP_EVENT_NO_PENDING_TSN = 0,
114 SCTP_EVENT_ICMP_PROTO_UNREACH,
115} sctp_event_other_t;
116
117#define SCTP_EVENT_OTHER_MAX SCTP_EVENT_ICMP_PROTO_UNREACH
118#define SCTP_NUM_OTHER_TYPES (SCTP_EVENT_OTHER_MAX + 1)
119
120/* These are primitive requests from the ULP. */
121typedef enum {
122 SCTP_PRIMITIVE_ASSOCIATE = 0,
123 SCTP_PRIMITIVE_SHUTDOWN,
124 SCTP_PRIMITIVE_ABORT,
125 SCTP_PRIMITIVE_SEND,
126 SCTP_PRIMITIVE_REQUESTHEARTBEAT,
127 SCTP_PRIMITIVE_ASCONF,
128} sctp_event_primitive_t;
129
130#define SCTP_EVENT_PRIMITIVE_MAX SCTP_PRIMITIVE_ASCONF
131#define SCTP_NUM_PRIMITIVE_TYPES (SCTP_EVENT_PRIMITIVE_MAX + 1)
132
133/* We define here a utility type for manipulating subtypes.
134 * The subtype constructors all work like this:
135 *
136 * sctp_subtype_t foo = SCTP_ST_CHUNK(SCTP_CID_INIT);
137 */
138
139typedef union {
140 sctp_cid_t chunk;
141 sctp_event_timeout_t timeout;
142 sctp_event_other_t other;
143 sctp_event_primitive_t primitive;
144} sctp_subtype_t;
145
146#define SCTP_SUBTYPE_CONSTRUCTOR(_name, _type, _elt) \
147static inline sctp_subtype_t \
148SCTP_ST_## _name (_type _arg) \
149{ sctp_subtype_t _retval; _retval._elt = _arg; return _retval; }
150
151SCTP_SUBTYPE_CONSTRUCTOR(CHUNK, sctp_cid_t, chunk)
152SCTP_SUBTYPE_CONSTRUCTOR(TIMEOUT, sctp_event_timeout_t, timeout)
153SCTP_SUBTYPE_CONSTRUCTOR(OTHER, sctp_event_other_t, other)
154SCTP_SUBTYPE_CONSTRUCTOR(PRIMITIVE, sctp_event_primitive_t, primitive)
155
156
157#define sctp_chunk_is_control(a) (a->chunk_hdr->type != SCTP_CID_DATA)
158#define sctp_chunk_is_data(a) (a->chunk_hdr->type == SCTP_CID_DATA)
159
160/* Calculate the actual data size in a data chunk */
161#define SCTP_DATA_SNDSIZE(c) ((int)((unsigned long)(c->chunk_end)\
162 - (unsigned long)(c->chunk_hdr)\
163 - sizeof(sctp_data_chunk_t)))
164
165#define SCTP_MAX_ERROR_CAUSE SCTP_ERROR_NONEXIST_IP
166#define SCTP_NUM_ERROR_CAUSE 10
167
168/* Internal error codes */
169typedef enum {
170
171 SCTP_IERROR_NO_ERROR = 0,
172 SCTP_IERROR_BASE = 1000,
173 SCTP_IERROR_NO_COOKIE,
174 SCTP_IERROR_BAD_SIG,
175 SCTP_IERROR_STALE_COOKIE,
176 SCTP_IERROR_NOMEM,
177 SCTP_IERROR_MALFORMED,
178 SCTP_IERROR_BAD_TAG,
179 SCTP_IERROR_BIG_GAP,
180 SCTP_IERROR_DUP_TSN,
181 SCTP_IERROR_HIGH_TSN,
182 SCTP_IERROR_IGNORE_TSN,
183 SCTP_IERROR_NO_DATA,
184 SCTP_IERROR_BAD_STREAM,
185 SCTP_IERROR_BAD_PORTS,
186
187} sctp_ierror_t;
188
189
190
191/* SCTP state defines for internal state machine */
192typedef enum {
193
194 SCTP_STATE_EMPTY = 0,
195 SCTP_STATE_CLOSED = 1,
196 SCTP_STATE_COOKIE_WAIT = 2,
197 SCTP_STATE_COOKIE_ECHOED = 3,
198 SCTP_STATE_ESTABLISHED = 4,
199 SCTP_STATE_SHUTDOWN_PENDING = 5,
200 SCTP_STATE_SHUTDOWN_SENT = 6,
201 SCTP_STATE_SHUTDOWN_RECEIVED = 7,
202 SCTP_STATE_SHUTDOWN_ACK_SENT = 8,
203
204} sctp_state_t;
205
206#define SCTP_STATE_MAX SCTP_STATE_SHUTDOWN_ACK_SENT
207#define SCTP_STATE_NUM_STATES (SCTP_STATE_MAX + 1)
208
209/* These are values for sk->state.
210 * For a UDP-style SCTP socket, the states are defined as follows
211 * - A socket in SCTP_SS_CLOSED state indicates that it is not willing to
212 * accept new associations, but it can initiate the creation of new ones.
213 * - A socket in SCTP_SS_LISTENING state indicates that it is willing to
214 * accept new associations and can initiate the creation of new ones.
215 * - A socket in SCTP_SS_ESTABLISHED state indicates that it is a peeled off
216 * socket with one association.
217 * For a TCP-style SCTP socket, the states are defined as follows
218 * - A socket in SCTP_SS_CLOSED state indicates that it is not willing to
219 * accept new associations, but it can initiate the creation of new ones.
220 * - A socket in SCTP_SS_LISTENING state indicates that it is willing to
221 * accept new associations, but cannot initiate the creation of new ones.
222 * - A socket in SCTP_SS_ESTABLISHED state indicates that it has a single
223 * association.
224 */
225typedef enum {
226 SCTP_SS_CLOSED = TCP_CLOSE,
227 SCTP_SS_LISTENING = TCP_LISTEN,
228 SCTP_SS_ESTABLISHING = TCP_SYN_SENT,
229 SCTP_SS_ESTABLISHED = TCP_ESTABLISHED,
230 SCTP_SS_DISCONNECTING = TCP_CLOSING,
231} sctp_sock_state_t;
232
233/* These functions map various type to printable names. */
234const char *sctp_cname(const sctp_subtype_t); /* chunk types */
235const char *sctp_oname(const sctp_subtype_t); /* other events */
236const char *sctp_tname(const sctp_subtype_t); /* timeouts */
237const char *sctp_pname(const sctp_subtype_t); /* primitives */
238
239/* This is a table of printable names of sctp_state_t's. */
240extern const char *sctp_state_tbl[], *sctp_evttype_tbl[], *sctp_status_tbl[];
241
242/* Maximum chunk length considering padding requirements. */
243enum { SCTP_MAX_CHUNK_LEN = ((1<<16) - sizeof(__u32)) };
244
245/* Encourage Cookie-Echo bundling by pre-fragmenting chunks a little
246 * harder (until reaching ESTABLISHED state).
247 */
248enum { SCTP_ARBITRARY_COOKIE_ECHO_LEN = 200 };
249
250/* Guess at how big to make the TSN mapping array.
251 * We guarantee that we can handle at least this big a gap between the
252 * cumulative ACK and the highest TSN. In practice, we can often
253 * handle up to twice this value.
254 *
255 * NEVER make this more than 32767 (2^15-1). The Gap Ack Blocks in a
256 * SACK (see section 3.3.4) are only 16 bits, so 2*SCTP_TSN_MAP_SIZE
257 * must be less than 65535 (2^16 - 1), or we will have overflow
258 * problems creating SACK's.
259 */
260#define SCTP_TSN_MAP_SIZE 2048
261#define SCTP_TSN_MAX_GAP 65535
262
263/* We will not record more than this many duplicate TSNs between two
264 * SACKs. The minimum PMTU is 576. Remove all the headers and there
265 * is enough room for 131 duplicate reports. Round down to the
266 * nearest power of 2.
267 */
268enum { SCTP_MIN_PMTU = 576 };
269enum { SCTP_MAX_DUP_TSNS = 16 };
270enum { SCTP_MAX_GABS = 16 };
271
2f85a429 272/* Heartbeat interval - 30 secs */
3fd091e7 273#define SCTP_DEFAULT_TIMEOUT_HEARTBEAT (30*1000)
1da177e4 274
2f85a429 275/* Delayed sack timer - 200ms */
3fd091e7 276#define SCTP_DEFAULT_TIMEOUT_SACK (200)
1da177e4
LT		 277
278/* RTO.Initial - 3 seconds
279 * RTO.Min - 1 second
280 * RTO.Max - 60 seconds
281 * RTO.Alpha - 1/8
282 * RTO.Beta - 1/4
283 */
3fd091e7
VY		 284#define SCTP_RTO_INITIAL (3 * 1000)
285#define SCTP_RTO_MIN (1 * 1000)
286#define SCTP_RTO_MAX (60 * 1000)
1da177e4
LT		 287
288#define SCTP_RTO_ALPHA 3 /* 1/8 when converted to right shifts. */
289#define SCTP_RTO_BETA 2 /* 1/4 when converted to right shifts. */
290
291/* Maximum number of new data packets that can be sent in a burst. */
70331571 292#define SCTP_DEFAULT_MAX_BURST 4
1da177e4
LT		 293
294#define SCTP_CLOCK_GRANULARITY 1 /* 1 jiffy */
295
296#define SCTP_DEF_MAX_INIT 6
297#define SCTP_DEF_MAX_SEND 10
298
3fd091e7 299#define SCTP_DEFAULT_COOKIE_LIFE (60 * 1000) /* 60 seconds */
1da177e4
LT		 300
301#define SCTP_DEFAULT_MINWINDOW 1500 /* default minimum rwnd size */
302#define SCTP_DEFAULT_MAXWINDOW 65535 /* default rwnd size */
303#define SCTP_DEFAULT_MAXSEGMENT 1500 /* MTU size, this is the limit
304 * to which we will raise the P-MTU.
305 */
306#define SCTP_DEFAULT_MINSEGMENT 512 /* MTU size ... if no mtu disc */
307#define SCTP_HOW_MANY_SECRETS 2 /* How many secrets I keep */
308#define SCTP_HOW_LONG_COOKIE_LIVE 3600 /* How many seconds the current
309 * secret will live?
310 */
311#define SCTP_SECRET_SIZE 32 /* Number of octets in a 256 bits. */
312
313#define SCTP_SIGNATURE_SIZE 20 /* size of a SLA-1 signature */
314
315#define SCTP_COOKIE_MULTIPLE 32 /* Pad out our cookie to make our hash
316 * functions simpler to write.
317 */
318
319#if defined (CONFIG_SCTP_HMAC_MD5)
1b489e11 320#define SCTP_COOKIE_HMAC_ALG "hmac(md5)"
1da177e4 321#elif defined (CONFIG_SCTP_HMAC_SHA1)
1b489e11 322#define SCTP_COOKIE_HMAC_ALG "hmac(sha1)"
1da177e4
LT		 323#else
324#define SCTP_COOKIE_HMAC_ALG NULL
325#endif
326
327/* These return values describe the success or failure of a number of
328 * routines which form the lower interface to SCTP_outqueue.
329 */
330typedef enum {
331 SCTP_XMIT_OK,
332 SCTP_XMIT_PMTU_FULL,
333 SCTP_XMIT_RWND_FULL,
334 SCTP_XMIT_NAGLE_DELAY,
335} sctp_xmit_t;
336
337/* These are the commands for manipulating transports. */
338typedef enum {
339 SCTP_TRANSPORT_UP,
340 SCTP_TRANSPORT_DOWN,
341} sctp_transport_cmd_t;
342
343/* These are the address scopes defined mainly for IPv4 addresses
344 * based on draft of SCTP IPv4 scoping <draft-stewart-tsvwg-sctp-ipv4-00.txt>.
345 * These scopes are hopefully generic enough to be used on scoping both
346 * IPv4 and IPv6 addresses in SCTP.
347 * At this point, the IPv6 scopes will be mapped to these internal scopes
348 * as much as possible.
349 */
350typedef enum {
351 SCTP_SCOPE_GLOBAL, /* IPv4 global addresses */
352 SCTP_SCOPE_PRIVATE, /* IPv4 private addresses */
353 SCTP_SCOPE_LINK, /* IPv4 link local address */
354 SCTP_SCOPE_LOOPBACK, /* IPv4 loopback address */
355 SCTP_SCOPE_UNUSABLE, /* IPv4 unusable addresses */
356} sctp_scope_t;
357
358/* Based on IPv4 scoping <draft-stewart-tsvwg-sctp-ipv4-00.txt>,
359 * SCTP IPv4 unusable addresses: 0.0.0.0/8, 224.0.0.0/4, 198.18.0.0/24,
360 * 192.88.99.0/24.
361 * Also, RFC 8.4, non-unicast addresses are not considered valid SCTP
362 * addresses.
363 */
364#define IS_IPV4_UNUSABLE_ADDRESS(a) \
dbc16db1 365 ((htonl(INADDR_BROADCAST) == *a) || \
1da177e4
LT		 366 (MULTICAST(*a)) || \
367 (((unsigned char *)(a))[0] == 0) || \
368 ((((unsigned char *)(a))[0] == 198) && \
369 (((unsigned char *)(a))[1] == 18) && \
370 (((unsigned char *)(a))[2] == 0)) || \
371 ((((unsigned char *)(a))[0] == 192) && \
372 (((unsigned char *)(a))[1] == 88) && \
373 (((unsigned char *)(a))[2] == 99)))
374
375/* IPv4 Link-local addresses: 169.254.0.0/16. */
376#define IS_IPV4_LINK_ADDRESS(a) \
377 ((((unsigned char *)(a))[0] == 169) && \
378 (((unsigned char *)(a))[1] == 254))
379
380/* RFC 1918 "Address Allocation for Private Internets" defines the IPv4
381 * private address space as the following:
382 *
383 * 10.0.0.0 - 10.255.255.255 (10/8 prefix)
384 * 172.16.0.0.0 - 172.31.255.255 (172.16/12 prefix)
385 * 192.168.0.0 - 192.168.255.255 (192.168/16 prefix)
386 */
387#define IS_IPV4_PRIVATE_ADDRESS(a) \
388 ((((unsigned char *)(a))[0] == 10) || \
389 ((((unsigned char *)(a))[0] == 172) && \
390 (((unsigned char *)(a))[1] >= 16) && \
391 (((unsigned char *)(a))[1] < 32)) || \
392 ((((unsigned char *)(a))[0] == 192) && \
393 (((unsigned char *)(a))[1] == 168)))
394
395/* Flags used for the bind address copy functions. */
396#define SCTP_ADDR6_ALLOWED 0x00000001 /* IPv6 address is allowed by
397 local sock family */
398#define SCTP_ADDR4_PEERSUPP 0x00000002 /* IPv4 address is supported by
399 peer */
400#define SCTP_ADDR6_PEERSUPP 0x00000004 /* IPv6 address is supported by
401 peer */
402
403/* Reasons to retransmit. */
404typedef enum {
405 SCTP_RTXR_T3_RTX,
406 SCTP_RTXR_FAST_RTX,
407 SCTP_RTXR_PMTUD,
408} sctp_retransmit_reason_t;
409
410/* Reasons to lower cwnd. */
411typedef enum {
412 SCTP_LOWER_CWND_T3_RTX,
413 SCTP_LOWER_CWND_FAST_RTX,
414 SCTP_LOWER_CWND_ECNE,
415 SCTP_LOWER_CWND_INACTIVE,
416} sctp_lower_cwnd_t;
417
1f485649
VY		 418
419/* SCTP-AUTH Necessary constants */
420
421/* SCTP-AUTH, Section 3.3
422 *
423 * The following Table 2 shows the currently defined values for HMAC
424 * identifiers.
425 *
426 * +-----------------+--------------------------+
427 * | HMAC Identifier | Message Digest Algorithm |
428 * +-----------------+--------------------------+
429 * | 0 | Reserved |
430 * | 1 | SHA-1 defined in [8] |
431 * | 2 | Reserved |
432 * | 3 | SHA-256 defined in [8] |
433 * +-----------------+--------------------------+
434 */
435enum {
436 SCTP_AUTH_HMAC_ID_RESERVED_0,
437 SCTP_AUTH_HMAC_ID_SHA1,
438 SCTP_AUTH_HMAC_ID_RESERVED_2,
439 SCTP_AUTH_HMAC_ID_SHA256
440};
441
442#define SCTP_AUTH_HMAC_ID_MAX SCTP_AUTH_HMAC_ID_SHA256
443#define SCTP_AUTH_NUM_HMACS (SCTP_AUTH_HMAC_ID_SHA256 + 1)
444#define SCTP_SHA1_SIG_SIZE 20
445#define SCTP_SHA256_SIG_SIZE 32
446
447/* SCTP-AUTH, Section 3.2
448 * The chunk types for INIT, INIT-ACK, SHUTDOWN-COMPLETE and AUTH chunks
449 * MUST NOT be listed in the CHUNKS parameter
450 */
451#define SCTP_NUM_NOAUTH_CHUNKS 4
452#define SCTP_AUTH_MAX_CHUNKS (SCTP_NUM_CHUNK_TYPES - SCTP_NUM_NOAUTH_CHUNKS)
453
454/* SCTP-AUTH Section 6.1
455 * The RANDOM parameter MUST contain a 32 byte random number.
456 */
457#define SCTP_AUTH_RANDOM_LENGTH 32
458
1da177e4 459#endif /* __sctp_constants_h__ */
kernel source for telekom puls (alcatel/mediatek)