Blame view

include/linux/sctp.h 22 KB
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
1
2
3
4
5
6
7
8
9
10
11
12
  /* SCTP kernel reference Implementation
   * (C) Copyright IBM Corp. 2001, 2004
   * Copyright (c) 1999-2000 Cisco, Inc.
   * Copyright (c) 1999-2001 Motorola, Inc.
   * Copyright (c) 2001 Intel Corp.
   * Copyright (c) 2001 Nokia, Inc.
   * Copyright (c) 2001 La Monte H.P. Yarroll
   *
   * This file is part of the SCTP kernel reference Implementation
   *
   * Various protocol defined structures.
   *
60c778b25   Vlad Yasevich   [SCTP]: Stop clai...
13
   * This SCTP implementation is free software;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
14
15
16
17
18
   * you can redistribute it and/or modify it under the terms of
   * the GNU General Public License as published by
   * the Free Software Foundation; either version 2, or (at your option)
   * any later version.
   *
60c778b25   Vlad Yasevich   [SCTP]: Stop clai...
19
   * This SCTP implementation is distributed in the hope that it
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
   * will be useful, but WITHOUT ANY WARRANTY; without even the implied
   *                 ************************
   * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
   * See the GNU General Public License for more details.
   *
   * You should have received a copy of the GNU General Public License
   * along with GNU CC; see the file COPYING.  If not, write to
   * the Free Software Foundation, 59 Temple Place - Suite 330,
   * Boston, MA 02111-1307, USA.
   *
   * Please send any bug reports or fixes you make to the
   * email address(es):
   *    lksctp developers <lksctp-developerst@lists.sourceforge.net>
   *
   * Or submit a bug report through the following website:
   *    http://www.sf.net/projects/lksctp
   *
   * Written or modified by:
   *    La Monte H.P. Yarroll <piggy@acm.org>
   *    Karl Knutson <karl@athena.chicago.il.us>
   *    Jon Grimm <jgrimm@us.ibm.com>
   *    Xingang Guo <xingang.guo@intel.com>
   *    randall@sctp.chicago.il.us
   *    kmorneau@cisco.com
   *    qxie1@email.mot.com
   *    Sridhar Samudrala <sri@us.ibm.com>
   *    Kevin Gao <kevin.gao@intel.com>
   *
   * Any bugs reported given to us we will try to fix... any fixes shared will
   * be incorporated into the next SCTP release.
   */
  #ifndef __LINUX_SCTP_H__
  #define __LINUX_SCTP_H__
  
  #include <linux/in.h>		/* We need in_addr.  */
  #include <linux/in6.h>		/* We need in6_addr.  */
  
  
  /* Section 3.1.  SCTP Common Header Format */
  typedef struct sctphdr {
f3ffaf146   Al Viro   [SCTP]: Annotate ...
60
61
62
  	__be16 source;
  	__be16 dest;
  	__be32 vtag;
4458f04c0   Vlad Yasevich   sctp: Clean up sc...
63
  	__le32 checksum;
bc10502db   Eric Dumazet   net: use __packed...
64
  } __packed sctp_sctphdr_t;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
65

2c0fd387b   Arnaldo Carvalho de Melo   [SCTP]: Introduce...
66
67
68
69
70
  #ifdef __KERNEL__
  #include <linux/skbuff.h>
  
  static inline struct sctphdr *sctp_hdr(const struct sk_buff *skb)
  {
9c70220b7   Arnaldo Carvalho de Melo   [SK_BUFF]: Introd...
71
  	return (struct sctphdr *)skb_transport_header(skb);
2c0fd387b   Arnaldo Carvalho de Melo   [SCTP]: Introduce...
72
73
  }
  #endif
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
74
75
76
77
  /* Section 3.2.  Chunk Field Descriptions. */
  typedef struct sctp_chunkhdr {
  	__u8 type;
  	__u8 flags;
f3ffaf146   Al Viro   [SCTP]: Annotate ...
78
  	__be16 length;
bc10502db   Eric Dumazet   net: use __packed...
79
  } __packed sctp_chunkhdr_t;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
  
  
  /* Section 3.2.  Chunk Type Values.
   * [Chunk Type] identifies the type of information contained in the Chunk
   * Value field. It takes a value from 0 to 254. The value of 255 is
   * reserved for future use as an extension field.
   */
  typedef enum {
  	SCTP_CID_DATA			= 0,
          SCTP_CID_INIT			= 1,
          SCTP_CID_INIT_ACK		= 2,
          SCTP_CID_SACK			= 3,
          SCTP_CID_HEARTBEAT		= 4,
          SCTP_CID_HEARTBEAT_ACK		= 5,
          SCTP_CID_ABORT			= 6,
          SCTP_CID_SHUTDOWN		= 7,
          SCTP_CID_SHUTDOWN_ACK		= 8,
          SCTP_CID_ERROR			= 9,
          SCTP_CID_COOKIE_ECHO		= 10,
          SCTP_CID_COOKIE_ACK	        = 11,
          SCTP_CID_ECN_ECNE		= 12,
          SCTP_CID_ECN_CWR		= 13,
          SCTP_CID_SHUTDOWN_COMPLETE	= 14,
f7b0e93ba   Vlad Yasevich   [SCTP]: protocol ...
103
104
  	/* AUTH Extension Section 4.1 */
  	SCTP_CID_AUTH			= 0x0F,
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
  	/* PR-SCTP Sec 3.2 */
  	SCTP_CID_FWD_TSN		= 0xC0,
  
  	/* Use hex, as defined in ADDIP sec. 3.1 */
  	SCTP_CID_ASCONF			= 0xC1,
  	SCTP_CID_ASCONF_ACK		= 0x80,
  } sctp_cid_t; /* enum */
  
  
  /* Section 3.2
   *  Chunk Types are encoded such that the highest-order two bits specify
   *  the action that must be taken if the processing endpoint does not
   *  recognize the Chunk Type.
   */
  typedef enum {
  	SCTP_CID_ACTION_DISCARD     = 0x00,
  	SCTP_CID_ACTION_DISCARD_ERR = 0x40,
  	SCTP_CID_ACTION_SKIP        = 0x80,
  	SCTP_CID_ACTION_SKIP_ERR    = 0xc0,
  } sctp_cid_action_t;
  
  enum { SCTP_CID_ACTION_MASK = 0xc0, };
  
  /* This flag is used in Chunk Flags for ABORT and SHUTDOWN COMPLETE.
   *
   * 3.3.7 Abort Association (ABORT) (6):
   *    The T bit is set to 0 if the sender had a TCB that it destroyed.
   *    If the sender did not have a TCB it should set this bit to 1.
   */
  enum { SCTP_CHUNK_FLAG_T = 0x01 };
  
  /*
   *  Set the T bit
   *
   *      0                   1                   2                   3
   *      0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
   *     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
   *     |   Type = 14   |Reserved     |T|      Length = 4               |
   *     +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
   *
   * Chunk Flags: 8 bits
   *
   *   Reserved:  7 bits
   *     Set to 0 on transmit and ignored on receipt.
   *
   *   T bit:  1 bit
   *     The T bit is set to 0 if the sender had a TCB that it destroyed. If
   *     the sender did NOT have a TCB it should set this bit to 1.
   *
   * Note: Special rules apply to this chunk for verification, please
   * see Section 8.5.1 for details.
   */
  
  #define sctp_test_T_bit(c)    ((c)->chunk_hdr->flags & SCTP_CHUNK_FLAG_T)
  
  /* RFC 2960
   * Section 3.2.1 Optional/Variable-length Parmaeter Format.
   */
  
  typedef struct sctp_paramhdr {
f3ffaf146   Al Viro   [SCTP]: Annotate ...
165
166
  	__be16 type;
  	__be16 length;
bc10502db   Eric Dumazet   net: use __packed...
167
  } __packed sctp_paramhdr_t;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
168
169
170
171
  
  typedef enum {
  
  	/* RFC 2960 Section 3.3.5 */
f3a7c66b5   Harvey Harrison   net: replace __co...
172
  	SCTP_PARAM_HEARTBEAT_INFO		= cpu_to_be16(1),
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
173
  	/* RFC 2960 Section 3.3.2.1 */
f3a7c66b5   Harvey Harrison   net: replace __co...
174
175
176
177
178
179
180
181
  	SCTP_PARAM_IPV4_ADDRESS			= cpu_to_be16(5),
  	SCTP_PARAM_IPV6_ADDRESS			= cpu_to_be16(6),
  	SCTP_PARAM_STATE_COOKIE			= cpu_to_be16(7),
  	SCTP_PARAM_UNRECOGNIZED_PARAMETERS	= cpu_to_be16(8),
  	SCTP_PARAM_COOKIE_PRESERVATIVE		= cpu_to_be16(9),
  	SCTP_PARAM_HOST_NAME_ADDRESS		= cpu_to_be16(11),
  	SCTP_PARAM_SUPPORTED_ADDRESS_TYPES	= cpu_to_be16(12),
  	SCTP_PARAM_ECN_CAPABLE			= cpu_to_be16(0x8000),
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
182

f7b0e93ba   Vlad Yasevich   [SCTP]: protocol ...
183
  	/* AUTH Extension Section 3 */
f3a7c66b5   Harvey Harrison   net: replace __co...
184
185
186
  	SCTP_PARAM_RANDOM			= cpu_to_be16(0x8002),
  	SCTP_PARAM_CHUNKS			= cpu_to_be16(0x8003),
  	SCTP_PARAM_HMAC_ALGO			= cpu_to_be16(0x8004),
f7b0e93ba   Vlad Yasevich   [SCTP]: protocol ...
187

131a47e31   Vlad Yasevich   [SCTP]: Implement...
188
  	/* Add-IP: Supported Extensions, Section 4.2 */
f3a7c66b5   Harvey Harrison   net: replace __co...
189
  	SCTP_PARAM_SUPPORTED_EXT	= cpu_to_be16(0x8008),
131a47e31   Vlad Yasevich   [SCTP]: Implement...
190

1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
191
  	/* PR-SCTP Sec 3.1 */
f3a7c66b5   Harvey Harrison   net: replace __co...
192
  	SCTP_PARAM_FWD_TSN_SUPPORT	= cpu_to_be16(0xc000),
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
193
194
  
  	/* Add-IP Extension. Section 3.2 */
f3a7c66b5   Harvey Harrison   net: replace __co...
195
196
197
198
199
200
  	SCTP_PARAM_ADD_IP		= cpu_to_be16(0xc001),
  	SCTP_PARAM_DEL_IP		= cpu_to_be16(0xc002),
  	SCTP_PARAM_ERR_CAUSE		= cpu_to_be16(0xc003),
  	SCTP_PARAM_SET_PRIMARY		= cpu_to_be16(0xc004),
  	SCTP_PARAM_SUCCESS_REPORT	= cpu_to_be16(0xc005),
  	SCTP_PARAM_ADAPTATION_LAYER_IND = cpu_to_be16(0xc006),
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
201
202
203
204
205
206
207
208
209
210
211
  
  } sctp_param_t; /* enum */
  
  
  /* RFC 2960 Section 3.2.1
   *  The Parameter Types are encoded such that the highest-order two bits
   *  specify the action that must be taken if the processing endpoint does
   *  not recognize the Parameter Type.
   *
   */
  typedef enum {
f3a7c66b5   Harvey Harrison   net: replace __co...
212
213
214
215
  	SCTP_PARAM_ACTION_DISCARD     = cpu_to_be16(0x0000),
  	SCTP_PARAM_ACTION_DISCARD_ERR = cpu_to_be16(0x4000),
  	SCTP_PARAM_ACTION_SKIP        = cpu_to_be16(0x8000),
  	SCTP_PARAM_ACTION_SKIP_ERR    = cpu_to_be16(0xc000),
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
216
  } sctp_param_action_t;
f3a7c66b5   Harvey Harrison   net: replace __co...
217
  enum { SCTP_PARAM_ACTION_MASK = cpu_to_be16(0xc000), };
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
218
219
220
221
  
  /* RFC 2960 Section 3.3.1 Payload Data (DATA) (0) */
  
  typedef struct sctp_datahdr {
f3ffaf146   Al Viro   [SCTP]: Annotate ...
222
223
224
225
  	__be32 tsn;
  	__be16 stream;
  	__be16 ssn;
  	__be32 ppid;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
226
  	__u8  payload[0];
bc10502db   Eric Dumazet   net: use __packed...
227
  } __packed sctp_datahdr_t;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
228
229
230
231
  
  typedef struct sctp_data_chunk {
          sctp_chunkhdr_t chunk_hdr;
          sctp_datahdr_t  data_hdr;
bc10502db   Eric Dumazet   net: use __packed...
232
  } __packed sctp_data_chunk_t;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
233
234
235
236
237
238
239
240
  
  /* DATA Chuck Specific Flags */
  enum {
  	SCTP_DATA_MIDDLE_FRAG	= 0x00,
  	SCTP_DATA_LAST_FRAG	= 0x01,
  	SCTP_DATA_FIRST_FRAG	= 0x02,
  	SCTP_DATA_NOT_FRAG	= 0x03,
  	SCTP_DATA_UNORDERED	= 0x04,
475cba4ec   Wei Yongjun   sctp: implement d...
241
  	SCTP_DATA_SACK_IMM	= 0x08,
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
242
243
244
245
246
247
248
249
250
251
  };
  enum { SCTP_DATA_FRAG_MASK = 0x03, };
  
  
  /* RFC 2960 Section 3.3.2 Initiation (INIT) (1)
   *
   *  This chunk is used to initiate a SCTP association between two
   *  endpoints.
   */
  typedef struct sctp_inithdr {
f3ffaf146   Al Viro   [SCTP]: Annotate ...
252
253
254
255
256
  	__be32 init_tag;
  	__be32 a_rwnd;
  	__be16 num_outbound_streams;
  	__be16 num_inbound_streams;
  	__be32 initial_tsn;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
257
  	__u8  params[0];
bc10502db   Eric Dumazet   net: use __packed...
258
  } __packed sctp_inithdr_t;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
259
260
261
262
  
  typedef struct sctp_init_chunk {
  	sctp_chunkhdr_t chunk_hdr;
  	sctp_inithdr_t init_hdr;
bc10502db   Eric Dumazet   net: use __packed...
263
  } __packed sctp_init_chunk_t;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
264
265
266
267
268
269
  
  
  /* Section 3.3.2.1. IPv4 Address Parameter (5) */
  typedef struct sctp_ipv4addr_param {
  	sctp_paramhdr_t param_hdr;
  	struct in_addr  addr;
bc10502db   Eric Dumazet   net: use __packed...
270
  } __packed sctp_ipv4addr_param_t;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
271
272
273
274
275
  
  /* Section 3.3.2.1. IPv6 Address Parameter (6) */
  typedef struct sctp_ipv6addr_param {
  	sctp_paramhdr_t param_hdr;
  	struct in6_addr addr;
bc10502db   Eric Dumazet   net: use __packed...
276
  } __packed sctp_ipv6addr_param_t;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
277
278
279
280
  
  /* Section 3.3.2.1 Cookie Preservative (9) */
  typedef struct sctp_cookie_preserve_param {
  	sctp_paramhdr_t param_hdr;
f3ffaf146   Al Viro   [SCTP]: Annotate ...
281
  	__be32          lifespan_increment;
bc10502db   Eric Dumazet   net: use __packed...
282
  } __packed sctp_cookie_preserve_param_t;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
283
284
285
286
287
  
  /* Section 3.3.2.1 Host Name Address (11) */
  typedef struct sctp_hostname_param {
  	sctp_paramhdr_t param_hdr;
  	uint8_t hostname[0];
bc10502db   Eric Dumazet   net: use __packed...
288
  } __packed sctp_hostname_param_t;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
289
290
291
292
  
  /* Section 3.3.2.1 Supported Address Types (12) */
  typedef struct sctp_supported_addrs_param {
  	sctp_paramhdr_t param_hdr;
f3ffaf146   Al Viro   [SCTP]: Annotate ...
293
  	__be16 types[0];
bc10502db   Eric Dumazet   net: use __packed...
294
  } __packed sctp_supported_addrs_param_t;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
295
296
297
298
  
  /* Appendix A. ECN Capable (32768) */
  typedef struct sctp_ecn_capable_param {
  	sctp_paramhdr_t param_hdr;
bc10502db   Eric Dumazet   net: use __packed...
299
  } __packed sctp_ecn_capable_param_t;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
300

0f3fffd8a   Ivan Skytte Jorgensen   [SCTP]: Fix typo ...
301
302
  /* ADDIP Section 3.2.6 Adaptation Layer Indication */
  typedef struct sctp_adaptation_ind_param {
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
303
  	struct sctp_paramhdr param_hdr;
0f3fffd8a   Ivan Skytte Jorgensen   [SCTP]: Fix typo ...
304
  	__be32 adaptation_ind;
bc10502db   Eric Dumazet   net: use __packed...
305
  } __packed sctp_adaptation_ind_param_t;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
306

131a47e31   Vlad Yasevich   [SCTP]: Implement...
307
308
309
310
  /* ADDIP Section 4.2.7 Supported Extensions Parameter */
  typedef struct sctp_supported_ext_param {
  	struct sctp_paramhdr param_hdr;
  	__u8 chunks[0];
bc10502db   Eric Dumazet   net: use __packed...
311
  } __packed sctp_supported_ext_param_t;
131a47e31   Vlad Yasevich   [SCTP]: Implement...
312

f7b0e93ba   Vlad Yasevich   [SCTP]: protocol ...
313
314
315
316
  /* AUTH Section 3.1 Random */
  typedef struct sctp_random_param {
  	sctp_paramhdr_t param_hdr;
  	__u8 random_val[0];
bc10502db   Eric Dumazet   net: use __packed...
317
  } __packed sctp_random_param_t;
f7b0e93ba   Vlad Yasevich   [SCTP]: protocol ...
318
319
320
321
322
  
  /* AUTH Section 3.2 Chunk List */
  typedef struct sctp_chunks_param {
  	sctp_paramhdr_t param_hdr;
  	__u8 chunks[0];
bc10502db   Eric Dumazet   net: use __packed...
323
  } __packed sctp_chunks_param_t;
f7b0e93ba   Vlad Yasevich   [SCTP]: protocol ...
324
325
326
327
328
  
  /* AUTH Section 3.3 HMAC Algorithm */
  typedef struct sctp_hmac_algo_param {
  	sctp_paramhdr_t param_hdr;
  	__be16 hmac_ids[0];
bc10502db   Eric Dumazet   net: use __packed...
329
  } __packed sctp_hmac_algo_param_t;
f7b0e93ba   Vlad Yasevich   [SCTP]: protocol ...
330

1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
331
332
333
334
335
336
337
338
339
340
  /* RFC 2960.  Section 3.3.3 Initiation Acknowledgement (INIT ACK) (2):
   *   The INIT ACK chunk is used to acknowledge the initiation of an SCTP
   *   association.
   */
  typedef sctp_init_chunk_t sctp_initack_chunk_t;
  
  /* Section 3.3.3.1 State Cookie (7) */
  typedef struct sctp_cookie_param {
  	sctp_paramhdr_t p;
  	__u8 body[0];
bc10502db   Eric Dumazet   net: use __packed...
341
  } __packed sctp_cookie_param_t;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
342
343
344
345
346
  
  /* Section 3.3.3.1 Unrecognized Parameters (8) */
  typedef struct sctp_unrecognized_param {
  	sctp_paramhdr_t param_hdr;
  	sctp_paramhdr_t unrecognized;
bc10502db   Eric Dumazet   net: use __packed...
347
  } __packed sctp_unrecognized_param_t;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
348
349
350
351
352
353
354
355
356
357
358
359
  
  
  
  /*
   * 3.3.4 Selective Acknowledgement (SACK) (3):
   *
   *  This chunk is sent to the peer endpoint to acknowledge received DATA
   *  chunks and to inform the peer endpoint of gaps in the received
   *  subsequences of DATA chunks as represented by their TSNs.
   */
  
  typedef struct sctp_gap_ack_block {
f3ffaf146   Al Viro   [SCTP]: Annotate ...
360
361
  	__be16 start;
  	__be16 end;
bc10502db   Eric Dumazet   net: use __packed...
362
  } __packed sctp_gap_ack_block_t;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
363

f3ffaf146   Al Viro   [SCTP]: Annotate ...
364
  typedef __be32 sctp_dup_tsn_t;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
365
366
367
368
369
370
371
  
  typedef union {
  	sctp_gap_ack_block_t	gab;
          sctp_dup_tsn_t		dup;
  } sctp_sack_variable_t;
  
  typedef struct sctp_sackhdr {
f3ffaf146   Al Viro   [SCTP]: Annotate ...
372
373
374
375
  	__be32 cum_tsn_ack;
  	__be32 a_rwnd;
  	__be16 num_gap_ack_blocks;
  	__be16 num_dup_tsns;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
376
  	sctp_sack_variable_t variable[0];
bc10502db   Eric Dumazet   net: use __packed...
377
  } __packed sctp_sackhdr_t;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
378
379
380
381
  
  typedef struct sctp_sack_chunk {
  	sctp_chunkhdr_t chunk_hdr;
  	sctp_sackhdr_t sack_hdr;
bc10502db   Eric Dumazet   net: use __packed...
382
  } __packed sctp_sack_chunk_t;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
383
384
385
386
387
388
389
390
391
392
393
  
  
  /* RFC 2960.  Section 3.3.5 Heartbeat Request (HEARTBEAT) (4):
   *
   *  An endpoint should send this chunk to its peer endpoint to probe the
   *  reachability of a particular destination transport address defined in
   *  the present association.
   */
  
  typedef struct sctp_heartbeathdr {
  	sctp_paramhdr_t info;
bc10502db   Eric Dumazet   net: use __packed...
394
  } __packed sctp_heartbeathdr_t;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
395
396
397
398
  
  typedef struct sctp_heartbeat_chunk {
  	sctp_chunkhdr_t chunk_hdr;
  	sctp_heartbeathdr_t hb_hdr;
bc10502db   Eric Dumazet   net: use __packed...
399
  } __packed sctp_heartbeat_chunk_t;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
400
401
402
403
404
405
406
407
  
  
  /* For the abort and shutdown ACK we must carry the init tag in the
   * common header. Just the common header is all that is needed with a
   * chunk descriptor.
   */
  typedef struct sctp_abort_chunk {
          sctp_chunkhdr_t uh;
bc10502db   Eric Dumazet   net: use __packed...
408
  } __packed sctp_abort_chunk_t;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
409
410
411
412
413
414
  
  
  /* For the graceful shutdown we must carry the tag (in common header)
   * and the highest consecutive acking value.
   */
  typedef struct sctp_shutdownhdr {
f3ffaf146   Al Viro   [SCTP]: Annotate ...
415
  	__be32 cum_tsn_ack;
bc10502db   Eric Dumazet   net: use __packed...
416
  } __packed sctp_shutdownhdr_t;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
417
418
419
420
  
  struct sctp_shutdown_chunk_t {
          sctp_chunkhdr_t    chunk_hdr;
          sctp_shutdownhdr_t shutdown_hdr;
bc10502db   Eric Dumazet   net: use __packed...
421
  } __packed;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
422
423
424
425
  
  /* RFC 2960.  Section 3.3.10 Operation Error (ERROR) (9) */
  
  typedef struct sctp_errhdr {
f3ffaf146   Al Viro   [SCTP]: Annotate ...
426
427
  	__be16 cause;
  	__be16 length;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
428
  	__u8  variable[0];
bc10502db   Eric Dumazet   net: use __packed...
429
  } __packed sctp_errhdr_t;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
430
431
432
433
  
  typedef struct sctp_operr_chunk {
          sctp_chunkhdr_t chunk_hdr;
  	sctp_errhdr_t   err_hdr;
bc10502db   Eric Dumazet   net: use __packed...
434
  } __packed sctp_operr_chunk_t;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
  
  /* RFC 2960 3.3.10 - Operation Error
   *
   * Cause Code: 16 bits (unsigned integer)
   *
   *     Defines the type of error conditions being reported.
   *    Cause Code
   *     Value           Cause Code
   *     ---------      ----------------
   *      1              Invalid Stream Identifier
   *      2              Missing Mandatory Parameter
   *      3              Stale Cookie Error
   *      4              Out of Resource
   *      5              Unresolvable Address
   *      6              Unrecognized Chunk Type
   *      7              Invalid Mandatory Parameter
   *      8              Unrecognized Parameters
   *      9              No User Data
   *     10              Cookie Received While Shutting Down
   */
  typedef enum {
f3a7c66b5   Harvey Harrison   net: replace __co...
456
457
458
459
460
461
462
463
464
465
466
  	SCTP_ERROR_NO_ERROR	   = cpu_to_be16(0x00),
  	SCTP_ERROR_INV_STRM	   = cpu_to_be16(0x01),
  	SCTP_ERROR_MISS_PARAM 	   = cpu_to_be16(0x02),
  	SCTP_ERROR_STALE_COOKIE	   = cpu_to_be16(0x03),
  	SCTP_ERROR_NO_RESOURCE 	   = cpu_to_be16(0x04),
  	SCTP_ERROR_DNS_FAILED      = cpu_to_be16(0x05),
  	SCTP_ERROR_UNKNOWN_CHUNK   = cpu_to_be16(0x06),
  	SCTP_ERROR_INV_PARAM       = cpu_to_be16(0x07),
  	SCTP_ERROR_UNKNOWN_PARAM   = cpu_to_be16(0x08),
  	SCTP_ERROR_NO_DATA         = cpu_to_be16(0x09),
  	SCTP_ERROR_COOKIE_IN_SHUTDOWN = cpu_to_be16(0x0a),
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
467
468
469
470
471
472
473
  
  
  	/* SCTP Implementation Guide:
  	 *  11  Restart of an association with new addresses
  	 *  12  User Initiated Abort
  	 *  13  Protocol Violation
  	 */
f3a7c66b5   Harvey Harrison   net: replace __co...
474
475
476
  	SCTP_ERROR_RESTART         = cpu_to_be16(0x0b),
  	SCTP_ERROR_USER_ABORT      = cpu_to_be16(0x0c),
  	SCTP_ERROR_PROTO_VIOLATION = cpu_to_be16(0x0d),
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
477
478
479
480
481
482
483
484
  
  	/* ADDIP Section 3.3  New Error Causes
  	 *
  	 * Four new Error Causes are added to the SCTP Operational Errors,
  	 * primarily for use in the ASCONF-ACK chunk.
  	 *
  	 * Value          Cause Code
  	 * ---------      ----------------
a84db7949   Wei Yongjun   sctp: fix error c...
485
486
487
488
489
  	 * 0x00A0          Request to Delete Last Remaining IP Address.
  	 * 0x00A1          Operation Refused Due to Resource Shortage.
  	 * 0x00A2          Request to Delete Source IP Address.
  	 * 0x00A3          Association Aborted due to illegal ASCONF-ACK
  	 * 0x00A4          Request refused - no authorization.
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
490
  	 */
a84db7949   Wei Yongjun   sctp: fix error c...
491
492
493
494
495
  	SCTP_ERROR_DEL_LAST_IP	= cpu_to_be16(0x00A0),
  	SCTP_ERROR_RSRC_LOW	= cpu_to_be16(0x00A1),
  	SCTP_ERROR_DEL_SRC_IP	= cpu_to_be16(0x00A2),
  	SCTP_ERROR_ASCONF_ACK   = cpu_to_be16(0x00A3),
  	SCTP_ERROR_REQ_REFUSED	= cpu_to_be16(0x00A4),
f7b0e93ba   Vlad Yasevich   [SCTP]: protocol ...
496
497
498
499
500
501
502
503
504
505
506
  
  	/* AUTH Section 4.  New Error Cause
  	 *
  	 * This section defines a new error cause that will be sent if an AUTH
  	 * chunk is received with an unsupported HMAC identifier.
  	 * illustrates the new error cause.
  	 *
  	 * Cause Code      Error Cause Name
  	 * --------------------------------------------------------------
  	 * 0x0105          Unsupported HMAC Identifier
  	 */
f3a7c66b5   Harvey Harrison   net: replace __co...
507
  	 SCTP_ERROR_UNSUP_HMAC	= cpu_to_be16(0x0105)
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
508
509
510
511
512
513
514
515
  } sctp_error_t;
  
  
  
  /* RFC 2960.  Appendix A.  Explicit Congestion Notification.
   *   Explicit Congestion Notification Echo (ECNE) (12)
   */
  typedef struct sctp_ecnehdr {
f3ffaf146   Al Viro   [SCTP]: Annotate ...
516
  	__be32 lowest_tsn;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
517
518
519
520
521
  } sctp_ecnehdr_t;
  
  typedef struct sctp_ecne_chunk {
  	sctp_chunkhdr_t chunk_hdr;
  	sctp_ecnehdr_t ence_hdr;
bc10502db   Eric Dumazet   net: use __packed...
522
  } __packed sctp_ecne_chunk_t;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
523
524
525
526
527
  
  /* RFC 2960.  Appendix A.  Explicit Congestion Notification.
   *   Congestion Window Reduced (CWR) (13)
   */
  typedef struct sctp_cwrhdr {
f3ffaf146   Al Viro   [SCTP]: Annotate ...
528
  	__be32 lowest_tsn;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
529
530
531
532
533
  } sctp_cwrhdr_t;
  
  typedef struct sctp_cwr_chunk {
  	sctp_chunkhdr_t chunk_hdr;
  	sctp_cwrhdr_t cwr_hdr;
bc10502db   Eric Dumazet   net: use __packed...
534
  } __packed sctp_cwr_chunk_t;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
  
  /* PR-SCTP
   * 3.2 Forward Cumulative TSN Chunk Definition (FORWARD TSN)
   *
   * Forward Cumulative TSN chunk has the following format:
   *
   *        0                   1                   2                   3
   *        0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
   *      +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
   *      |   Type = 192  |  Flags = 0x00 |        Length = Variable      |
   *      +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
   *      |                      New Cumulative TSN                       |
   *      +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
   *      |         Stream-1              |       Stream Sequence-1       |
   *      +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
   *      \                                                               /
   *      /                                                               \
   *      +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
   *      |         Stream-N              |       Stream Sequence-N       |
   *      +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
   *
   *      Chunk Flags:
   *
   *        Set to all zeros on transmit and ignored on receipt.
   *
   *      New Cumulative TSN: 32 bit u_int
   *
   *       This indicates the new cumulative TSN to the data receiver. Upon
   *       the reception of this value, the data receiver MUST consider
   *       any missing TSNs earlier than or equal to this value as received
   *       and stop reporting them as gaps in any subsequent SACKs.
   *
   *      Stream-N: 16 bit u_int
   *
   *       This field holds a stream number that was skipped by this
   *       FWD-TSN.
   *
   *      Stream Sequence-N: 16 bit u_int
   *       This field holds the sequence number associated with the stream
   *       that was skipped. The stream sequence field holds the largest stream
   *       sequence number in this stream being skipped.  The receiver of
   *       the FWD-TSN's can use the Stream-N and Stream Sequence-N fields
   *       to enable delivery of any stranded TSN's that remain on the stream
   *       re-ordering queues. This field MUST NOT report TSN's corresponding
   *       to DATA chunk that are marked as unordered. For ordered DATA
   *       chunks this field MUST be filled in.
   */
  struct sctp_fwdtsn_skip {
f3ffaf146   Al Viro   [SCTP]: Annotate ...
583
584
  	__be16 stream;
  	__be16 ssn;
bc10502db   Eric Dumazet   net: use __packed...
585
  } __packed;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
586
587
  
  struct sctp_fwdtsn_hdr {
f3ffaf146   Al Viro   [SCTP]: Annotate ...
588
  	__be32 new_cum_tsn;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
589
  	struct sctp_fwdtsn_skip skip[0];
bc10502db   Eric Dumazet   net: use __packed...
590
  } __packed;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
591
592
593
594
  
  struct sctp_fwdtsn_chunk {
  	struct sctp_chunkhdr chunk_hdr;
  	struct sctp_fwdtsn_hdr fwdtsn_hdr;
bc10502db   Eric Dumazet   net: use __packed...
595
  } __packed;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
  
  
  /* ADDIP
   * Section 3.1.1 Address Configuration Change Chunk (ASCONF)
   *
   * 	Serial Number: 32 bits (unsigned integer)
   *	This value represents a Serial Number for the ASCONF Chunk. The
   *	valid range of Serial Number is from 0 to 2^32-1.
   *	Serial Numbers wrap back to 0 after reaching 2^32 -1.
   *
   *	Address Parameter: 8 or 20 bytes (depending on type)
   *	The address is an address of the sender of the ASCONF chunk,
   *	the address MUST be considered part of the association by the
   *	peer endpoint. This field may be used by the receiver of the 
   *	ASCONF to help in finding the association. This parameter MUST
   *	be present in every ASCONF message i.e. it is a mandatory TLV
   *	parameter.
   *
   *	ASCONF Parameter: TLV format
   *	Each Address configuration change is represented by a TLV
   *	parameter as defined in Section 3.2. One or more requests may
   *	be present in an ASCONF Chunk.
   *
   * Section 3.1.2 Address Configuration Acknowledgement Chunk (ASCONF-ACK)
   * 
   *	Serial Number: 32 bits (unsigned integer)
   *	This value represents the Serial Number for the received ASCONF
   *	Chunk that is acknowledged by this chunk. This value is copied
   *	from the received ASCONF Chunk. 
   *
   *	ASCONF Parameter Response: TLV format
   *	The ASCONF Parameter Response is used in the ASCONF-ACK to
   *	report status of ASCONF processing.
   */
  typedef struct sctp_addip_param {
  	sctp_paramhdr_t	param_hdr;
f3ffaf146   Al Viro   [SCTP]: Annotate ...
632
  	__be32		crr_id;
bc10502db   Eric Dumazet   net: use __packed...
633
  } __packed sctp_addip_param_t;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
634
635
  
  typedef struct sctp_addiphdr {
f3ffaf146   Al Viro   [SCTP]: Annotate ...
636
  	__be32	serial;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
637
  	__u8	params[0];
bc10502db   Eric Dumazet   net: use __packed...
638
  } __packed sctp_addiphdr_t;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
639
640
641
642
  
  typedef struct sctp_addip_chunk {
  	sctp_chunkhdr_t chunk_hdr;
  	sctp_addiphdr_t addip_hdr;
bc10502db   Eric Dumazet   net: use __packed...
643
  } __packed sctp_addip_chunk_t;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
644

f7b0e93ba   Vlad Yasevich   [SCTP]: protocol ...
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
  /* AUTH
   * Section 4.1  Authentication Chunk (AUTH)
   *
   *   This chunk is used to hold the result of the HMAC calculation.
   *
   *    0                   1                   2                   3
   *    0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
   *   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
   *   | Type = 0x0F   |   Flags=0     |             Length            |
   *   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
   *   |     Shared Key Identifier     |   HMAC Identifier             |
   *   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
   *   |                                                               |
   *   \                             HMAC                              /
   *   /                                                               \
   *   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
   *
   *   Type: 1 byte (unsigned integer)
   *   	This value MUST be set to 0x0F for  all AUTH-chunks.
   *
   *   Flags: 1 byte (unsigned integer)
   *	Set to zero on transmit and ignored on receipt.
   *
   *   Length: 2 bytes (unsigned integer)
   *   	This value holds the length of the HMAC in bytes plus 8.
   *
   *  Shared Key Identifier: 2 bytes (unsigned integer)
   *	This value describes which endpoint pair shared key is used.
   *
   *   HMAC Identifier: 2 bytes (unsigned integer)
   *   	This value describes which message digest is being used.  Table 2
   *	shows the currently defined values.
   *
   *    The following Table 2 shows the currently defined values for HMAC
   *       identifiers.
   *
   *	 +-----------------+--------------------------+
   *	 | HMAC Identifier | Message Digest Algorithm |
   *	 +-----------------+--------------------------+
   *	 | 0               | Reserved                 |
   *	 | 1               | SHA-1 defined in [8]     |
   *	 | 2               | Reserved                 |
   *	 | 3               | SHA-256 defined in [8]   |
   *	 +-----------------+--------------------------+
   *
   *
   *   HMAC: n bytes (unsigned integer) This hold the result of the HMAC
   *      calculation.
   */
  typedef struct sctp_authhdr {
  	__be16 shkey_id;
  	__be16 hmac_id;
  	__u8   hmac[0];
bc10502db   Eric Dumazet   net: use __packed...
698
  } __packed sctp_authhdr_t;
f7b0e93ba   Vlad Yasevich   [SCTP]: protocol ...
699
700
701
702
  
  typedef struct sctp_auth_chunk {
  	sctp_chunkhdr_t chunk_hdr;
  	sctp_authhdr_t auth_hdr;
bc10502db   Eric Dumazet   net: use __packed...
703
  } __packed sctp_auth_chunk_t;
f7b0e93ba   Vlad Yasevich   [SCTP]: protocol ...
704

1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
705
  #endif /* __LINUX_SCTP_H__ */