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 * Copyright (c) 2001 Nokia, Inc.
7 * Copyright (c) 2001 La Monte H.P. Yarroll
9 * This file is part of the SCTP kernel reference Implementation
11 * Various protocol defined structures.
13 * The SCTP reference implementation is free software;
14 * you can redistribute it and/or modify it under the terms of
15 * the GNU General Public License as published by
16 * the Free Software Foundation; either version 2, or (at your option)
19 * The SCTP reference implementation is distributed in the hope that it
20 * will be useful, but WITHOUT ANY WARRANTY; without even the implied
21 * ************************
22 * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
23 * See the GNU General Public License for more details.
25 * You should have received a copy of the GNU General Public License
26 * along with GNU CC; see the file COPYING. If not, write to
27 * the Free Software Foundation, 59 Temple Place - Suite 330,
28 * Boston, MA 02111-1307, USA.
30 * Please send any bug reports or fixes you make to the
32 * lksctp developers <lksctp-developerst@lists.sourceforge.net>
34 * Or submit a bug report through the following website:
35 * http://www.sf.net/projects/lksctp
37 * Written or modified by:
38 * La Monte H.P. Yarroll <piggy@acm.org>
39 * Karl Knutson <karl@athena.chicago.il.us>
40 * Jon Grimm <jgrimm@us.ibm.com>
41 * Xingang Guo <xingang.guo@intel.com>
42 * randall@sctp.chicago.il.us
45 * Sridhar Samudrala <sri@us.ibm.com>
46 * Kevin Gao <kevin.gao@intel.com>
48 * Any bugs reported given to us we will try to fix... any fixes shared will
49 * be incorporated into the next SCTP release.
51 #ifndef __LINUX_SCTP_H__
52 #define __LINUX_SCTP_H__
54 #include <linux/in.h> /* We need in_addr. */
55 #include <linux/in6.h> /* We need in6_addr. */
58 /* Section 3.1. SCTP Common Header Format */
59 typedef struct sctphdr {
64 } __attribute__((packed)) sctp_sctphdr_t;
67 #include <linux/skbuff.h>
69 static inline struct sctphdr *sctp_hdr(const struct sk_buff *skb)
71 return (struct sctphdr *)skb_transport_header(skb);
75 /* Section 3.2. Chunk Field Descriptions. */
76 typedef struct sctp_chunkhdr {
80 } __attribute__((packed)) sctp_chunkhdr_t;
83 /* Section 3.2. Chunk Type Values.
84 * [Chunk Type] identifies the type of information contained in the Chunk
85 * Value field. It takes a value from 0 to 254. The value of 255 is
86 * reserved for future use as an extension field.
91 SCTP_CID_INIT_ACK = 2,
93 SCTP_CID_HEARTBEAT = 4,
94 SCTP_CID_HEARTBEAT_ACK = 5,
96 SCTP_CID_SHUTDOWN = 7,
97 SCTP_CID_SHUTDOWN_ACK = 8,
99 SCTP_CID_COOKIE_ECHO = 10,
100 SCTP_CID_COOKIE_ACK = 11,
101 SCTP_CID_ECN_ECNE = 12,
102 SCTP_CID_ECN_CWR = 13,
103 SCTP_CID_SHUTDOWN_COMPLETE = 14,
105 /* PR-SCTP Sec 3.2 */
106 SCTP_CID_FWD_TSN = 0xC0,
108 /* Use hex, as defined in ADDIP sec. 3.1 */
109 SCTP_CID_ASCONF = 0xC1,
110 SCTP_CID_ASCONF_ACK = 0x80,
111 } sctp_cid_t; /* enum */
115 * Chunk Types are encoded such that the highest-order two bits specify
116 * the action that must be taken if the processing endpoint does not
117 * recognize the Chunk Type.
120 SCTP_CID_ACTION_DISCARD = 0x00,
121 SCTP_CID_ACTION_DISCARD_ERR = 0x40,
122 SCTP_CID_ACTION_SKIP = 0x80,
123 SCTP_CID_ACTION_SKIP_ERR = 0xc0,
126 enum { SCTP_CID_ACTION_MASK = 0xc0, };
128 /* This flag is used in Chunk Flags for ABORT and SHUTDOWN COMPLETE.
130 * 3.3.7 Abort Association (ABORT) (6):
131 * The T bit is set to 0 if the sender had a TCB that it destroyed.
132 * If the sender did not have a TCB it should set this bit to 1.
134 enum { SCTP_CHUNK_FLAG_T = 0x01 };
140 * 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
141 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
142 * | Type = 14 |Reserved |T| Length = 4 |
143 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
145 * Chunk Flags: 8 bits
148 * Set to 0 on transmit and ignored on receipt.
151 * The T bit is set to 0 if the sender had a TCB that it destroyed. If
152 * the sender did NOT have a TCB it should set this bit to 1.
154 * Note: Special rules apply to this chunk for verification, please
155 * see Section 8.5.1 for details.
158 #define sctp_test_T_bit(c) ((c)->chunk_hdr->flags & SCTP_CHUNK_FLAG_T)
161 * Section 3.2.1 Optional/Variable-length Parmaeter Format.
164 typedef struct sctp_paramhdr {
167 } __attribute__((packed)) sctp_paramhdr_t;
171 /* RFC 2960 Section 3.3.5 */
172 SCTP_PARAM_HEARTBEAT_INFO = __constant_htons(1),
173 /* RFC 2960 Section 3.3.2.1 */
174 SCTP_PARAM_IPV4_ADDRESS = __constant_htons(5),
175 SCTP_PARAM_IPV6_ADDRESS = __constant_htons(6),
176 SCTP_PARAM_STATE_COOKIE = __constant_htons(7),
177 SCTP_PARAM_UNRECOGNIZED_PARAMETERS = __constant_htons(8),
178 SCTP_PARAM_COOKIE_PRESERVATIVE = __constant_htons(9),
179 SCTP_PARAM_HOST_NAME_ADDRESS = __constant_htons(11),
180 SCTP_PARAM_SUPPORTED_ADDRESS_TYPES = __constant_htons(12),
181 SCTP_PARAM_ECN_CAPABLE = __constant_htons(0x8000),
183 /* Add-IP: Supported Extensions, Section 4.2 */
184 SCTP_PARAM_SUPPORTED_EXT = __constant_htons(0x8008),
186 /* PR-SCTP Sec 3.1 */
187 SCTP_PARAM_FWD_TSN_SUPPORT = __constant_htons(0xc000),
189 /* Add-IP Extension. Section 3.2 */
190 SCTP_PARAM_ADD_IP = __constant_htons(0xc001),
191 SCTP_PARAM_DEL_IP = __constant_htons(0xc002),
192 SCTP_PARAM_ERR_CAUSE = __constant_htons(0xc003),
193 SCTP_PARAM_SET_PRIMARY = __constant_htons(0xc004),
194 SCTP_PARAM_SUCCESS_REPORT = __constant_htons(0xc005),
195 SCTP_PARAM_ADAPTATION_LAYER_IND = __constant_htons(0xc006),
197 } sctp_param_t; /* enum */
200 /* RFC 2960 Section 3.2.1
201 * The Parameter Types are encoded such that the highest-order two bits
202 * specify the action that must be taken if the processing endpoint does
203 * not recognize the Parameter Type.
207 SCTP_PARAM_ACTION_DISCARD = __constant_htons(0x0000),
208 SCTP_PARAM_ACTION_DISCARD_ERR = __constant_htons(0x4000),
209 SCTP_PARAM_ACTION_SKIP = __constant_htons(0x8000),
210 SCTP_PARAM_ACTION_SKIP_ERR = __constant_htons(0xc000),
211 } sctp_param_action_t;
213 enum { SCTP_PARAM_ACTION_MASK = __constant_htons(0xc000), };
215 /* RFC 2960 Section 3.3.1 Payload Data (DATA) (0) */
217 typedef struct sctp_datahdr {
223 } __attribute__((packed)) sctp_datahdr_t;
225 typedef struct sctp_data_chunk {
226 sctp_chunkhdr_t chunk_hdr;
227 sctp_datahdr_t data_hdr;
228 } __attribute__((packed)) sctp_data_chunk_t;
230 /* DATA Chuck Specific Flags */
232 SCTP_DATA_MIDDLE_FRAG = 0x00,
233 SCTP_DATA_LAST_FRAG = 0x01,
234 SCTP_DATA_FIRST_FRAG = 0x02,
235 SCTP_DATA_NOT_FRAG = 0x03,
236 SCTP_DATA_UNORDERED = 0x04,
238 enum { SCTP_DATA_FRAG_MASK = 0x03, };
241 /* RFC 2960 Section 3.3.2 Initiation (INIT) (1)
243 * This chunk is used to initiate a SCTP association between two
246 typedef struct sctp_inithdr {
249 __be16 num_outbound_streams;
250 __be16 num_inbound_streams;
253 } __attribute__((packed)) sctp_inithdr_t;
255 typedef struct sctp_init_chunk {
256 sctp_chunkhdr_t chunk_hdr;
257 sctp_inithdr_t init_hdr;
258 } __attribute__((packed)) sctp_init_chunk_t;
261 /* Section 3.3.2.1. IPv4 Address Parameter (5) */
262 typedef struct sctp_ipv4addr_param {
263 sctp_paramhdr_t param_hdr;
265 } __attribute__((packed)) sctp_ipv4addr_param_t;
267 /* Section 3.3.2.1. IPv6 Address Parameter (6) */
268 typedef struct sctp_ipv6addr_param {
269 sctp_paramhdr_t param_hdr;
270 struct in6_addr addr;
271 } __attribute__((packed)) sctp_ipv6addr_param_t;
273 /* Section 3.3.2.1 Cookie Preservative (9) */
274 typedef struct sctp_cookie_preserve_param {
275 sctp_paramhdr_t param_hdr;
276 __be32 lifespan_increment;
277 } __attribute__((packed)) sctp_cookie_preserve_param_t;
279 /* Section 3.3.2.1 Host Name Address (11) */
280 typedef struct sctp_hostname_param {
281 sctp_paramhdr_t param_hdr;
283 } __attribute__((packed)) sctp_hostname_param_t;
285 /* Section 3.3.2.1 Supported Address Types (12) */
286 typedef struct sctp_supported_addrs_param {
287 sctp_paramhdr_t param_hdr;
289 } __attribute__((packed)) sctp_supported_addrs_param_t;
291 /* Appendix A. ECN Capable (32768) */
292 typedef struct sctp_ecn_capable_param {
293 sctp_paramhdr_t param_hdr;
294 } __attribute__((packed)) sctp_ecn_capable_param_t;
296 /* ADDIP Section 3.2.6 Adaptation Layer Indication */
297 typedef struct sctp_adaptation_ind_param {
298 struct sctp_paramhdr param_hdr;
299 __be32 adaptation_ind;
300 } __attribute__((packed)) sctp_adaptation_ind_param_t;
302 /* ADDIP Section 4.2.7 Supported Extensions Parameter */
303 typedef struct sctp_supported_ext_param {
304 struct sctp_paramhdr param_hdr;
306 } __attribute__((packed)) sctp_supported_ext_param_t;
308 /* RFC 2960. Section 3.3.3 Initiation Acknowledgement (INIT ACK) (2):
309 * The INIT ACK chunk is used to acknowledge the initiation of an SCTP
312 typedef sctp_init_chunk_t sctp_initack_chunk_t;
314 /* Section 3.3.3.1 State Cookie (7) */
315 typedef struct sctp_cookie_param {
318 } __attribute__((packed)) sctp_cookie_param_t;
320 /* Section 3.3.3.1 Unrecognized Parameters (8) */
321 typedef struct sctp_unrecognized_param {
322 sctp_paramhdr_t param_hdr;
323 sctp_paramhdr_t unrecognized;
324 } __attribute__((packed)) sctp_unrecognized_param_t;
329 * 3.3.4 Selective Acknowledgement (SACK) (3):
331 * This chunk is sent to the peer endpoint to acknowledge received DATA
332 * chunks and to inform the peer endpoint of gaps in the received
333 * subsequences of DATA chunks as represented by their TSNs.
336 typedef struct sctp_gap_ack_block {
339 } __attribute__((packed)) sctp_gap_ack_block_t;
341 typedef __be32 sctp_dup_tsn_t;
344 sctp_gap_ack_block_t gab;
346 } sctp_sack_variable_t;
348 typedef struct sctp_sackhdr {
351 __be16 num_gap_ack_blocks;
353 sctp_sack_variable_t variable[0];
354 } __attribute__((packed)) sctp_sackhdr_t;
356 typedef struct sctp_sack_chunk {
357 sctp_chunkhdr_t chunk_hdr;
358 sctp_sackhdr_t sack_hdr;
359 } __attribute__((packed)) sctp_sack_chunk_t;
362 /* RFC 2960. Section 3.3.5 Heartbeat Request (HEARTBEAT) (4):
364 * An endpoint should send this chunk to its peer endpoint to probe the
365 * reachability of a particular destination transport address defined in
366 * the present association.
369 typedef struct sctp_heartbeathdr {
370 sctp_paramhdr_t info;
371 } __attribute__((packed)) sctp_heartbeathdr_t;
373 typedef struct sctp_heartbeat_chunk {
374 sctp_chunkhdr_t chunk_hdr;
375 sctp_heartbeathdr_t hb_hdr;
376 } __attribute__((packed)) sctp_heartbeat_chunk_t;
379 /* For the abort and shutdown ACK we must carry the init tag in the
380 * common header. Just the common header is all that is needed with a
383 typedef struct sctp_abort_chunk {
385 } __attribute__((packed)) sctp_abort_chunk_t;
388 /* For the graceful shutdown we must carry the tag (in common header)
389 * and the highest consecutive acking value.
391 typedef struct sctp_shutdownhdr {
393 } __attribute__((packed)) sctp_shutdownhdr_t;
395 struct sctp_shutdown_chunk_t {
396 sctp_chunkhdr_t chunk_hdr;
397 sctp_shutdownhdr_t shutdown_hdr;
398 } __attribute__ ((packed));
400 /* RFC 2960. Section 3.3.10 Operation Error (ERROR) (9) */
402 typedef struct sctp_errhdr {
406 } __attribute__((packed)) sctp_errhdr_t;
408 typedef struct sctp_operr_chunk {
409 sctp_chunkhdr_t chunk_hdr;
410 sctp_errhdr_t err_hdr;
411 } __attribute__((packed)) sctp_operr_chunk_t;
413 /* RFC 2960 3.3.10 - Operation Error
415 * Cause Code: 16 bits (unsigned integer)
417 * Defines the type of error conditions being reported.
420 * --------- ----------------
421 * 1 Invalid Stream Identifier
422 * 2 Missing Mandatory Parameter
423 * 3 Stale Cookie Error
425 * 5 Unresolvable Address
426 * 6 Unrecognized Chunk Type
427 * 7 Invalid Mandatory Parameter
428 * 8 Unrecognized Parameters
430 * 10 Cookie Received While Shutting Down
434 SCTP_ERROR_NO_ERROR = __constant_htons(0x00),
435 SCTP_ERROR_INV_STRM = __constant_htons(0x01),
436 SCTP_ERROR_MISS_PARAM = __constant_htons(0x02),
437 SCTP_ERROR_STALE_COOKIE = __constant_htons(0x03),
438 SCTP_ERROR_NO_RESOURCE = __constant_htons(0x04),
439 SCTP_ERROR_DNS_FAILED = __constant_htons(0x05),
440 SCTP_ERROR_UNKNOWN_CHUNK = __constant_htons(0x06),
441 SCTP_ERROR_INV_PARAM = __constant_htons(0x07),
442 SCTP_ERROR_UNKNOWN_PARAM = __constant_htons(0x08),
443 SCTP_ERROR_NO_DATA = __constant_htons(0x09),
444 SCTP_ERROR_COOKIE_IN_SHUTDOWN = __constant_htons(0x0a),
447 /* SCTP Implementation Guide:
448 * 11 Restart of an association with new addresses
449 * 12 User Initiated Abort
450 * 13 Protocol Violation
453 SCTP_ERROR_RESTART = __constant_htons(0x0b),
454 SCTP_ERROR_USER_ABORT = __constant_htons(0x0c),
455 SCTP_ERROR_PROTO_VIOLATION = __constant_htons(0x0d),
457 /* ADDIP Section 3.3 New Error Causes
459 * Four new Error Causes are added to the SCTP Operational Errors,
460 * primarily for use in the ASCONF-ACK chunk.
463 * --------- ----------------
464 * 0x0100 Request to Delete Last Remaining IP Address.
465 * 0x0101 Operation Refused Due to Resource Shortage.
466 * 0x0102 Request to Delete Source IP Address.
467 * 0x0103 Association Aborted due to illegal ASCONF-ACK
468 * 0x0104 Request refused - no authorization.
470 SCTP_ERROR_DEL_LAST_IP = __constant_htons(0x0100),
471 SCTP_ERROR_RSRC_LOW = __constant_htons(0x0101),
472 SCTP_ERROR_DEL_SRC_IP = __constant_htons(0x0102),
473 SCTP_ERROR_ASCONF_ACK = __constant_htons(0x0103),
474 SCTP_ERROR_REQ_REFUSED = __constant_htons(0x0104)
479 /* RFC 2960. Appendix A. Explicit Congestion Notification.
480 * Explicit Congestion Notification Echo (ECNE) (12)
482 typedef struct sctp_ecnehdr {
486 typedef struct sctp_ecne_chunk {
487 sctp_chunkhdr_t chunk_hdr;
488 sctp_ecnehdr_t ence_hdr;
489 } __attribute__((packed)) sctp_ecne_chunk_t;
491 /* RFC 2960. Appendix A. Explicit Congestion Notification.
492 * Congestion Window Reduced (CWR) (13)
494 typedef struct sctp_cwrhdr {
498 typedef struct sctp_cwr_chunk {
499 sctp_chunkhdr_t chunk_hdr;
500 sctp_cwrhdr_t cwr_hdr;
501 } __attribute__((packed)) sctp_cwr_chunk_t;
504 * 3.2 Forward Cumulative TSN Chunk Definition (FORWARD TSN)
506 * Forward Cumulative TSN chunk has the following format:
509 * 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
510 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
511 * | Type = 192 | Flags = 0x00 | Length = Variable |
512 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
513 * | New Cumulative TSN |
514 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
515 * | Stream-1 | Stream Sequence-1 |
516 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
519 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
520 * | Stream-N | Stream Sequence-N |
521 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
525 * Set to all zeros on transmit and ignored on receipt.
527 * New Cumulative TSN: 32 bit u_int
529 * This indicates the new cumulative TSN to the data receiver. Upon
530 * the reception of this value, the data receiver MUST consider
531 * any missing TSNs earlier than or equal to this value as received
532 * and stop reporting them as gaps in any subsequent SACKs.
534 * Stream-N: 16 bit u_int
536 * This field holds a stream number that was skipped by this
539 * Stream Sequence-N: 16 bit u_int
540 * This field holds the sequence number associated with the stream
541 * that was skipped. The stream sequence field holds the largest stream
542 * sequence number in this stream being skipped. The receiver of
543 * the FWD-TSN's can use the Stream-N and Stream Sequence-N fields
544 * to enable delivery of any stranded TSN's that remain on the stream
545 * re-ordering queues. This field MUST NOT report TSN's corresponding
546 * to DATA chunk that are marked as unordered. For ordered DATA
547 * chunks this field MUST be filled in.
549 struct sctp_fwdtsn_skip {
552 } __attribute__((packed));
554 struct sctp_fwdtsn_hdr {
556 struct sctp_fwdtsn_skip skip[0];
557 } __attribute((packed));
559 struct sctp_fwdtsn_chunk {
560 struct sctp_chunkhdr chunk_hdr;
561 struct sctp_fwdtsn_hdr fwdtsn_hdr;
562 } __attribute((packed));
566 * Section 3.1.1 Address Configuration Change Chunk (ASCONF)
568 * Serial Number: 32 bits (unsigned integer)
569 * This value represents a Serial Number for the ASCONF Chunk. The
570 * valid range of Serial Number is from 0 to 2^32-1.
571 * Serial Numbers wrap back to 0 after reaching 2^32 -1.
573 * Address Parameter: 8 or 20 bytes (depending on type)
574 * The address is an address of the sender of the ASCONF chunk,
575 * the address MUST be considered part of the association by the
576 * peer endpoint. This field may be used by the receiver of the
577 * ASCONF to help in finding the association. This parameter MUST
578 * be present in every ASCONF message i.e. it is a mandatory TLV
581 * ASCONF Parameter: TLV format
582 * Each Address configuration change is represented by a TLV
583 * parameter as defined in Section 3.2. One or more requests may
584 * be present in an ASCONF Chunk.
586 * Section 3.1.2 Address Configuration Acknowledgement Chunk (ASCONF-ACK)
588 * Serial Number: 32 bits (unsigned integer)
589 * This value represents the Serial Number for the received ASCONF
590 * Chunk that is acknowledged by this chunk. This value is copied
591 * from the received ASCONF Chunk.
593 * ASCONF Parameter Response: TLV format
594 * The ASCONF Parameter Response is used in the ASCONF-ACK to
595 * report status of ASCONF processing.
597 typedef struct sctp_addip_param {
598 sctp_paramhdr_t param_hdr;
600 } __attribute__((packed)) sctp_addip_param_t;
602 typedef struct sctp_addiphdr {
605 } __attribute__((packed)) sctp_addiphdr_t;
607 typedef struct sctp_addip_chunk {
608 sctp_chunkhdr_t chunk_hdr;
609 sctp_addiphdr_t addip_hdr;
610 } __attribute__((packed)) sctp_addip_chunk_t;
612 #endif /* __LINUX_SCTP_H__ */