2 * Copyright (c) 2001-2007, by Cisco Systems, Inc. All rights reserved.
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions are met:
7 * a) Redistributions of source code must retain the above copyright notice,
8 * this list of conditions and the following disclaimer.
10 * b) Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in
12 * the documentation and/or other materials provided with the distribution.
14 * c) Neither the name of Cisco Systems, Inc. nor the names of its
15 * contributors may be used to endorse or promote products derived
16 * from this software without specific prior written permission.
18 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
20 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
22 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
28 * THE POSSIBILITY OF SUCH DAMAGE.
31 /* $KAME: sctp_header.h,v 1.14 2005/03/06 16:04:17 itojun Exp $ */
33 #include <sys/cdefs.h>
34 __FBSDID("$FreeBSD$");
36 #ifndef __sctp_header_h__
37 #define __sctp_header_h__
40 #include <netinet/sctp.h>
41 #include <netinet/sctp_constants.h>
45 * Parameter structures
47 struct sctp_ipv4addr_param {
48 struct sctp_paramhdr ph;/* type=SCTP_IPV4_PARAM_TYPE, len=8 */
49 uint32_t addr; /* IPV4 address */
52 #define SCTP_V6_ADDR_BYTES 16
55 struct sctp_ipv6addr_param {
56 struct sctp_paramhdr ph;/* type=SCTP_IPV6_PARAM_TYPE, len=20 */
57 uint8_t addr[SCTP_V6_ADDR_BYTES]; /* IPV6 address */
60 /* Cookie Preservative */
61 struct sctp_cookie_perserve_param {
62 struct sctp_paramhdr ph;/* type=SCTP_COOKIE_PRESERVE, len=8 */
63 uint32_t time; /* time in ms to extend cookie */
66 #define SCTP_ARRAY_MIN_LEN 1
67 /* Host Name Address */
68 struct sctp_host_name_param {
69 struct sctp_paramhdr ph;/* type=SCTP_HOSTNAME_ADDRESS */
70 char name[SCTP_ARRAY_MIN_LEN]; /* host name */
74 * This is the maximum padded size of a s-a-p
75 * so paramheadr + 3 address types (6 bytes) + 2 byte pad = 12
77 #define SCTP_MAX_ADDR_PARAMS_SIZE 12
78 /* supported address type */
79 struct sctp_supported_addr_param {
80 struct sctp_paramhdr ph;/* type=SCTP_SUPPORTED_ADDRTYPE */
81 uint16_t addr_type[SCTP_ARRAY_MIN_LEN]; /* array of supported address
86 struct sctp_ecn_supported_param {
87 struct sctp_paramhdr ph;/* type=SCTP_ECN_CAPABLE */
91 /* heartbeat info parameter */
92 struct sctp_heartbeat_info_param {
93 struct sctp_paramhdr ph;
94 uint32_t time_value_1;
95 uint32_t time_value_2;
96 uint32_t random_value1;
97 uint32_t random_value2;
101 char address[SCTP_ADDRMAX];
105 /* draft-ietf-tsvwg-prsctp */
106 /* PR-SCTP supported parameter */
107 struct sctp_prsctp_supported_param {
108 struct sctp_paramhdr ph;
112 /* draft-ietf-tsvwg-addip-sctp */
113 struct sctp_asconf_paramhdr { /* an ASCONF "parameter" */
114 struct sctp_paramhdr ph;/* a SCTP parameter header */
115 uint32_t correlation_id;/* correlation id for this param */
118 struct sctp_asconf_addr_param { /* an ASCONF address parameter */
119 struct sctp_asconf_paramhdr aph; /* asconf "parameter" */
120 struct sctp_ipv6addr_param addrp; /* max storage size */
123 struct sctp_asconf_addrv4_param { /* an ASCONF address (v4) parameter */
124 struct sctp_asconf_paramhdr aph; /* asconf "parameter" */
125 struct sctp_ipv4addr_param addrp; /* max storage size */
128 #define SCTP_MAX_SUPPORTED_EXT 256
130 struct sctp_supported_chunk_types_param {
131 struct sctp_paramhdr ph;/* type = 0x8008 len = x */
132 uint8_t chunk_types[0];
136 /* ECN Nonce: draft-ladha-sctp-ecn-nonce */
137 struct sctp_ecn_nonce_supported_param {
138 struct sctp_paramhdr ph;/* type = 0x8001 len = 4 */
143 * Structures for DATA chunks
148 uint16_t stream_sequence;
149 uint32_t protocol_id;
150 /* user data follows */
153 struct sctp_data_chunk {
154 struct sctp_chunkhdr ch;
159 * Structures for the control chunks
162 /* Initiate (INIT)/Initiate Ack (INIT ACK) */
164 uint32_t initiate_tag; /* initiate tag */
165 uint32_t a_rwnd; /* a_rwnd */
166 uint16_t num_outbound_streams; /* OS */
167 uint16_t num_inbound_streams; /* MIS */
168 uint32_t initial_tsn; /* I-TSN */
169 /* optional param's follow */
172 #define SCTP_IDENTIFICATION_SIZE 16
173 #define SCTP_ADDRESS_SIZE 4
174 #define SCTP_RESERVE_SPACE 6
175 /* state cookie header */
176 struct sctp_state_cookie { /* this is our definition... */
177 uint8_t identification[SCTP_IDENTIFICATION_SIZE]; /* id of who we are */
178 struct timeval time_entered; /* the time I built cookie */
179 uint32_t cookie_life; /* life I will award this cookie */
180 uint32_t tie_tag_my_vtag; /* my tag in old association */
182 uint32_t tie_tag_peer_vtag; /* peers tag in old association */
183 uint32_t peers_vtag; /* peers tag in INIT (for quick ref) */
185 uint32_t my_vtag; /* my tag in INIT-ACK (for quick ref) */
186 uint32_t address[SCTP_ADDRESS_SIZE]; /* 4 ints/128 bits */
187 uint32_t addr_type; /* address type */
188 uint32_t laddress[SCTP_ADDRESS_SIZE]; /* my local from address */
189 uint32_t laddr_type; /* my local from address type */
190 uint32_t scope_id; /* v6 scope id for link-locals */
192 uint16_t peerport; /* port address of the peer in the INIT */
193 uint16_t myport; /* my port address used in the INIT */
194 uint8_t ipv4_addr_legal;/* Are V4 addr legal? */
195 uint8_t ipv6_addr_legal;/* Are V6 addr legal? */
196 uint8_t local_scope; /* IPv6 local scope flag */
197 uint8_t site_scope; /* IPv6 site scope flag */
199 uint8_t ipv4_scope; /* IPv4 private addr scope */
200 uint8_t loopback_scope; /* loopback scope information */
201 uint8_t reserved[SCTP_RESERVE_SPACE]; /* Align to 64 bits */
203 * at the end is tacked on the INIT chunk and the INIT-ACK chunk
204 * (minus the cookie).
208 struct sctp_inv_mandatory_param {
214 * We include this to 0 it since only a missing cookie will cause
220 struct sctp_unresolv_addr {
224 uint16_t reserved; /* Only one invalid addr type */
227 /* state cookie parameter */
228 struct sctp_state_cookie_param {
229 struct sctp_paramhdr ph;
230 struct sctp_state_cookie cookie;
233 struct sctp_init_chunk {
234 struct sctp_chunkhdr ch;
235 struct sctp_init init;
238 struct sctp_init_msg {
240 struct sctp_init_chunk msg;
243 /* ... used for both INIT and INIT ACK */
244 #define sctp_init_ack sctp_init
245 #define sctp_init_ack_chunk sctp_init_chunk
246 #define sctp_init_ack_msg sctp_init_msg
249 /* Selective Ack (SACK) */
250 struct sctp_gap_ack_block {
251 uint16_t start; /* Gap Ack block start */
252 uint16_t end; /* Gap Ack block end */
256 uint32_t cum_tsn_ack; /* cumulative TSN Ack */
257 uint32_t a_rwnd; /* updated a_rwnd of sender */
258 uint16_t num_gap_ack_blks; /* number of Gap Ack blocks */
259 uint16_t num_dup_tsns; /* number of duplicate TSNs */
260 /* struct sctp_gap_ack_block's follow */
261 /* uint32_t duplicate_tsn's follow */
264 struct sctp_sack_chunk {
265 struct sctp_chunkhdr ch;
266 struct sctp_sack sack;
270 /* Heartbeat Request (HEARTBEAT) */
271 struct sctp_heartbeat {
272 struct sctp_heartbeat_info_param hb_info;
275 struct sctp_heartbeat_chunk {
276 struct sctp_chunkhdr ch;
277 struct sctp_heartbeat heartbeat;
280 /* ... used for Heartbeat Ack (HEARTBEAT ACK) */
281 #define sctp_heartbeat_ack sctp_heartbeat
282 #define sctp_heartbeat_ack_chunk sctp_heartbeat_chunk
285 /* Abort Asssociation (ABORT) */
286 struct sctp_abort_chunk {
287 struct sctp_chunkhdr ch;
288 /* optional error cause may follow */
291 struct sctp_abort_msg {
293 struct sctp_abort_chunk msg;
297 /* Shutdown Association (SHUTDOWN) */
298 struct sctp_shutdown_chunk {
299 struct sctp_chunkhdr ch;
300 uint32_t cumulative_tsn_ack;
304 /* Shutdown Acknowledgment (SHUTDOWN ACK) */
305 struct sctp_shutdown_ack_chunk {
306 struct sctp_chunkhdr ch;
310 /* Operation Error (ERROR) */
311 struct sctp_error_chunk {
312 struct sctp_chunkhdr ch;
313 /* optional error causes follow */
317 /* Cookie Echo (COOKIE ECHO) */
318 struct sctp_cookie_echo_chunk {
319 struct sctp_chunkhdr ch;
320 struct sctp_state_cookie cookie;
323 /* Cookie Acknowledgment (COOKIE ACK) */
324 struct sctp_cookie_ack_chunk {
325 struct sctp_chunkhdr ch;
328 /* Explicit Congestion Notification Echo (ECNE) */
329 struct sctp_ecne_chunk {
330 struct sctp_chunkhdr ch;
334 /* Congestion Window Reduced (CWR) */
335 struct sctp_cwr_chunk {
336 struct sctp_chunkhdr ch;
340 /* Shutdown Complete (SHUTDOWN COMPLETE) */
341 struct sctp_shutdown_complete_chunk {
342 struct sctp_chunkhdr ch;
345 /* Oper error holding a stale cookie */
346 struct sctp_stale_cookie_msg {
347 struct sctp_paramhdr ph;/* really an error cause */
351 struct sctp_adaptation_layer_indication {
352 struct sctp_paramhdr ph;
356 struct sctp_cookie_while_shutting_down {
358 struct sctp_chunkhdr ch;
359 struct sctp_paramhdr ph;/* really an error cause */
362 struct sctp_shutdown_complete_msg {
364 struct sctp_shutdown_complete_chunk shut_cmp;
368 * draft-ietf-tsvwg-addip-sctp
370 /* Address/Stream Configuration Change (ASCONF) */
371 struct sctp_asconf_chunk {
372 struct sctp_chunkhdr ch;
373 uint32_t serial_number;
374 /* lookup address parameter (mandatory) */
375 /* asconf parameters follow */
378 /* Address/Stream Configuration Acknowledge (ASCONF ACK) */
379 struct sctp_asconf_ack_chunk {
380 struct sctp_chunkhdr ch;
381 uint32_t serial_number;
382 /* asconf parameters follow */
385 /* draft-ietf-tsvwg-prsctp */
386 /* Forward Cumulative TSN (FORWARD TSN) */
387 struct sctp_forward_tsn_chunk {
388 struct sctp_chunkhdr ch;
389 uint32_t new_cumulative_tsn;
390 /* stream/sequence pairs (sctp_strseq) follow */
398 struct sctp_forward_tsn_msg {
400 struct sctp_forward_tsn_chunk msg;
403 /* should be a multiple of 4 - 1 aka 3/7/11 etc. */
405 #define SCTP_NUM_DB_TO_VERIFY 31
407 struct sctp_chunk_desc {
409 uint8_t data_bytes[SCTP_NUM_DB_TO_VERIFY];
414 struct sctp_pktdrop_chunk {
415 struct sctp_chunkhdr ch;
417 uint32_t current_onq;
423 /**********STREAM RESET STUFF ******************/
425 struct sctp_stream_reset_out_request {
426 struct sctp_paramhdr ph;
427 uint32_t request_seq; /* monotonically increasing seq no */
428 uint32_t response_seq; /* if a response, the resp seq no */
429 uint32_t send_reset_at_tsn; /* last TSN I assigned outbound */
430 uint16_t list_of_streams[0]; /* if not all list of streams */
433 struct sctp_stream_reset_in_request {
434 struct sctp_paramhdr ph;
435 uint32_t request_seq;
436 uint16_t list_of_streams[0]; /* if not all list of streams */
440 struct sctp_stream_reset_tsn_request {
441 struct sctp_paramhdr ph;
442 uint32_t request_seq;
445 struct sctp_stream_reset_response {
446 struct sctp_paramhdr ph;
447 uint32_t response_seq; /* if a response, the resp seq no */
451 struct sctp_stream_reset_response_tsn {
452 struct sctp_paramhdr ph;
453 uint32_t response_seq; /* if a response, the resp seq no */
455 uint32_t senders_next_tsn;
456 uint32_t receivers_next_tsn;
461 #define SCTP_STREAM_RESET_NOTHING 0x00000000 /* Nothing for me to do */
462 #define SCTP_STREAM_RESET_PERFORMED 0x00000001 /* Did it */
463 #define SCTP_STREAM_RESET_DENIED 0x00000002 /* refused to do it */
464 #define SCTP_STREAM_RESET_ERROR_STR 0x00000003 /* bad Stream no */
465 #define SCTP_STREAM_RESET_TRY_LATER 0x00000004 /* collision, try again */
466 #define SCTP_STREAM_RESET_BAD_SEQNO 0x00000005 /* bad str-reset seq no */
469 * convience structures, note that if you are making a request for specific
470 * streams then the request will need to be an overlay structure.
473 struct sctp_stream_reset_out_req {
474 struct sctp_chunkhdr ch;
475 struct sctp_stream_reset_out_request sr_req;
478 struct sctp_stream_reset_in_req {
479 struct sctp_chunkhdr ch;
480 struct sctp_stream_reset_in_request sr_req;
483 struct sctp_stream_reset_tsn_req {
484 struct sctp_chunkhdr ch;
485 struct sctp_stream_reset_tsn_request sr_req;
488 struct sctp_stream_reset_resp {
489 struct sctp_chunkhdr ch;
490 struct sctp_stream_reset_response sr_resp;
493 /* respone only valid with a TSN request */
494 struct sctp_stream_reset_resp_tsn {
495 struct sctp_chunkhdr ch;
496 struct sctp_stream_reset_response_tsn sr_resp;
499 /****************************************************/
502 * Authenticated chunks support draft-ietf-tsvwg-sctp-auth
505 /* Should we make the max be 32? */
506 #define SCTP_RANDOM_MAX_SIZE 256
507 struct sctp_auth_random {
508 struct sctp_paramhdr ph;/* type = 0x8002 */
509 uint8_t random_data[0];
512 struct sctp_auth_chunk_list {
513 struct sctp_paramhdr ph;/* type = 0x8003 */
514 uint8_t chunk_types[0];
517 struct sctp_auth_hmac_algo {
518 struct sctp_paramhdr ph;/* type = 0x8004 */
519 uint16_t hmac_ids[0];
522 struct sctp_auth_chunk {
523 struct sctp_chunkhdr ch;
524 uint16_t shared_key_id;
529 struct sctp_auth_invalid_hmac {
530 struct sctp_paramhdr ph;
536 * we pre-reserve enough room for a ECNE or CWR AND a SACK with no missing
537 * pieces. If ENCE is missing we could have a couple of blocks. This way we
538 * optimize so we MOST likely can bundle a SACK/ECN with the smallest size
539 * data chunk I will split into. We could increase throughput slightly by
540 * taking out these two but the 24-sack/8-CWR i.e. 32 bytes I pre-reserve I
541 * feel is worth it for now.
543 #ifndef SCTP_MAX_OVERHEAD
545 #define SCTP_MAX_OVERHEAD (sizeof(struct sctp_data_chunk) + \
546 sizeof(struct sctphdr) + \
547 sizeof(struct sctp_ecne_chunk) + \
548 sizeof(struct sctp_sack_chunk) + \
549 sizeof(struct ip6_hdr))
551 #define SCTP_MED_OVERHEAD (sizeof(struct sctp_data_chunk) + \
552 sizeof(struct sctphdr) + \
553 sizeof(struct ip6_hdr))
556 #define SCTP_MIN_OVERHEAD (sizeof(struct ip6_hdr) + \
557 sizeof(struct sctphdr))
560 #define SCTP_MAX_OVERHEAD (sizeof(struct sctp_data_chunk) + \
561 sizeof(struct sctphdr) + \
562 sizeof(struct sctp_ecne_chunk) + \
563 sizeof(struct sctp_sack_chunk) + \
566 #define SCTP_MED_OVERHEAD (sizeof(struct sctp_data_chunk) + \
567 sizeof(struct sctphdr) + \
571 #define SCTP_MIN_OVERHEAD (sizeof(struct ip) + \
572 sizeof(struct sctphdr))
575 #endif /* !SCTP_MAX_OVERHEAD */
577 #define SCTP_MED_V4_OVERHEAD (sizeof(struct sctp_data_chunk) + \
578 sizeof(struct sctphdr) + \
581 #define SCTP_MIN_V4_OVERHEAD (sizeof(struct ip) + \
582 sizeof(struct sctphdr))
584 #endif /* !__sctp_header_h__ */