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) 2001 Intel Corp.
7 * This file is part of the SCTP kernel implementation
9 * This SCTP 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)
15 * This SCTP 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.
21 * You should have received a copy of the GNU General Public License
22 * along with GNU CC; see the file COPYING. If not, see
23 * <http://www.gnu.org/licenses/>.
25 * Please send any bug reports or fixes you make to the
27 * lksctp developers <linux-sctp@vger.kernel.org>
29 * Written or modified by:
30 * Randall Stewart <randall@sctp.chicago.il.us>
31 * Ken Morneau <kmorneau@cisco.com>
32 * Qiaobing Xie <qxie1@email.mot.com>
33 * La Monte H.P. Yarroll <piggy@acm.org>
34 * Karl Knutson <karl@athena.chicago.il.us>
35 * Jon Grimm <jgrimm@us.ibm.com>
36 * Xingang Guo <xingang.guo@intel.com>
37 * Hui Huang <hui.huang@nokia.com>
38 * Sridhar Samudrala <sri@us.ibm.com>
39 * Daisy Chang <daisyc@us.ibm.com>
40 * Dajiang Zhang <dajiang.zhang@nokia.com>
41 * Ardelle Fan <ardelle.fan@intel.com>
42 * Ryan Layer <rmlayer@us.ibm.com>
43 * Anup Pemmaiah <pemmaiah@cc.usu.edu>
44 * Kevin Gao <kevin.gao@intel.com>
47 #ifndef __sctp_structs_h__
48 #define __sctp_structs_h__
50 #include <linux/ktime.h>
51 #include <linux/rhashtable.h>
52 #include <linux/socket.h> /* linux/in.h needs this!! */
53 #include <linux/in.h> /* We get struct sockaddr_in. */
54 #include <linux/in6.h> /* We get struct in6_addr */
55 #include <linux/ipv6.h>
56 #include <asm/param.h> /* We get MAXHOSTNAMELEN. */
57 #include <linux/atomic.h> /* This gets us atomic counters. */
58 #include <linux/skbuff.h> /* We need sk_buff_head. */
59 #include <linux/workqueue.h> /* We need tq_struct. */
60 #include <linux/sctp.h> /* We need sctp* header structs. */
61 #include <net/sctp/auth.h> /* We need auth specific structs */
63 /* A convenience structure for handling sockaddr structures.
64 * We should wean ourselves off this.
67 struct sockaddr_in v4
;
68 struct sockaddr_in6 v6
;
72 /* Forward declarations for data structures. */
75 struct sctp_association
;
76 struct sctp_transport
;
81 struct sctp_bind_addr
;
83 struct sctp_ep_common
;
88 #include <net/sctp/tsnmap.h>
89 #include <net/sctp/ulpevent.h>
90 #include <net/sctp/ulpqueue.h>
92 /* Structures useful for managing bind/connect. */
94 struct sctp_bind_bucket
{
96 unsigned short fastreuse
;
97 struct hlist_node node
;
98 struct hlist_head owner
;
102 struct sctp_bind_hashbucket
{
104 struct hlist_head chain
;
107 /* Used for hashing all associations. */
108 struct sctp_hashbucket
{
110 struct hlist_head chain
;
111 } __attribute__((__aligned__(8)));
114 /* The SCTP globals structure. */
115 extern struct sctp_globals
{
116 /* This is a list of groups of functions for each address
117 * family that we support.
119 struct list_head address_families
;
121 /* This is the hash of all endpoints. */
122 struct sctp_hashbucket
*ep_hashtable
;
123 /* This is the sctp port control hash. */
124 struct sctp_bind_hashbucket
*port_hashtable
;
125 /* This is the hash of all transports. */
126 struct rhashtable transport_hashtable
;
128 /* Sizes of above hashtables. */
132 /* Default initialization values to be applied to new associations. */
134 __u16 max_outstreams
;
136 /* Flag to indicate whether computing and verifying checksum
138 bool checksum_disable
;
141 #define sctp_max_instreams (sctp_globals.max_instreams)
142 #define sctp_max_outstreams (sctp_globals.max_outstreams)
143 #define sctp_address_families (sctp_globals.address_families)
144 #define sctp_ep_hashsize (sctp_globals.ep_hashsize)
145 #define sctp_ep_hashtable (sctp_globals.ep_hashtable)
146 #define sctp_port_hashsize (sctp_globals.port_hashsize)
147 #define sctp_port_hashtable (sctp_globals.port_hashtable)
148 #define sctp_transport_hashtable (sctp_globals.transport_hashtable)
149 #define sctp_checksum_disable (sctp_globals.checksum_disable)
151 /* SCTP Socket type: UDP or TCP style. */
154 SCTP_SOCKET_UDP_HIGH_BANDWIDTH
,
156 } sctp_socket_type_t
;
158 /* Per socket SCTP information. */
160 /* inet_sock has to be the first member of sctp_sock */
161 struct inet_sock inet
;
162 /* What kind of a socket is this? */
163 sctp_socket_type_t type
;
165 /* PF_ family specific functions. */
168 /* Access to HMAC transform. */
169 struct crypto_hash
*hmac
;
172 /* What is our base endpointer? */
173 struct sctp_endpoint
*ep
;
175 struct sctp_bind_bucket
*bind_hash
;
176 /* Various Socket Options. */
177 __u16 default_stream
;
180 __u32 default_context
;
181 __u32 default_timetolive
;
182 __u32 default_rcv_context
;
185 /* Heartbeat interval: The endpoint sends out a Heartbeat chunk to
186 * the destination address every heartbeat interval. This value
187 * will be inherited by all new associations.
191 /* This is the max_retrans value for new associations. */
194 /* The initial Path MTU to use for new associations. */
197 /* The default SACK delay timeout for new associations. */
201 /* Flags controlling Heartbeat, SACK delay, and Path MTU Discovery. */
204 struct sctp_initmsg initmsg
;
205 struct sctp_rtoinfo rtoinfo
;
206 struct sctp_paddrparams paddrparam
;
207 struct sctp_event_subscribe subscribe
;
208 struct sctp_assocparams assocparams
;
214 __u8 disable_fragments
;
216 __u8 frag_interleave
;
217 __u32 adaptation_ind
;
223 /* Receive to here while partial delivery is in effect. */
224 struct sk_buff_head pd_lobby
;
226 /* These must be the last fields, as they will skipped on copies,
227 * like on accept and peeloff operations
229 struct list_head auto_asconf_list
;
233 static inline struct sctp_sock
*sctp_sk(const struct sock
*sk
)
235 return (struct sctp_sock
*)sk
;
238 static inline struct sock
*sctp_opt2sk(const struct sctp_sock
*sp
)
240 return (struct sock
*)sp
;
243 #if IS_ENABLED(CONFIG_IPV6)
245 struct sctp_sock sctp
;
246 struct ipv6_pinfo inet6
;
248 #endif /* CONFIG_IPV6 */
251 /* This is our APPLICATION-SPECIFIC state cookie.
252 * THIS IS NOT DICTATED BY THE SPECIFICATION.
254 /* These are the parts of an association which we send in the cookie.
255 * Most of these are straight out of:
256 * RFC2960 12.2 Parameters necessary per association (i.e. the TCB)
262 /* My : Tag expected in every inbound packet and sent
263 * Verification: in the INIT or INIT ACK chunk.
268 /* Peer's : Tag expected in every outbound packet except
269 * Verification: in the INIT chunk.
274 /* The rest of these are not from the spec, but really need to
278 /* My Tie Tag : Assist in discovering a restarting association. */
281 /* Peer's Tie Tag: Assist in discovering a restarting association. */
284 /* When does this cookie expire? */
287 /* Number of inbound/outbound streams which are set
288 * and negotiated during the INIT process.
290 __u16 sinit_num_ostreams
;
291 __u16 sinit_max_instreams
;
293 /* This is the first sequence number I used. */
296 /* This holds the originating address of the INIT packet. */
297 union sctp_addr peer_addr
;
300 * Include the source port of the INIT-ACK
306 /* Padding for future use */
309 __u32 adaptation_ind
;
311 __u8 auth_random
[sizeof(sctp_paramhdr_t
) + SCTP_AUTH_RANDOM_LENGTH
];
312 __u8 auth_hmacs
[SCTP_AUTH_NUM_HMACS
* sizeof(__u16
) + 2];
313 __u8 auth_chunks
[sizeof(sctp_paramhdr_t
) + SCTP_AUTH_MAX_CHUNKS
];
315 /* This is a shim for my peer's INIT packet, followed by
316 * a copy of the raw address list of the association.
317 * The length of the raw address list is saved in the
318 * raw_addr_list_len field, which will be used at the time when
319 * the association TCB is re-constructed from the cookie.
321 __u32 raw_addr_list_len
;
322 struct sctp_init_chunk peer_init
[0];
326 /* The format of our cookie that we send to our peer. */
327 struct sctp_signed_cookie
{
328 __u8 signature
[SCTP_SECRET_SIZE
];
329 __u32 __pad
; /* force sctp_cookie alignment to 64 bits */
330 struct sctp_cookie c
;
333 /* This is another convenience type to allocate memory for address
334 * params for the maximum size and pass such structures around
337 union sctp_addr_param
{
338 struct sctp_paramhdr p
;
339 struct sctp_ipv4addr_param v4
;
340 struct sctp_ipv6addr_param v6
;
343 /* A convenience type to allow walking through the various
344 * parameters and avoid casting all over the place.
348 struct sctp_paramhdr
*p
;
349 struct sctp_cookie_preserve_param
*life
;
350 struct sctp_hostname_param
*dns
;
351 struct sctp_cookie_param
*cookie
;
352 struct sctp_supported_addrs_param
*sat
;
353 struct sctp_ipv4addr_param
*v4
;
354 struct sctp_ipv6addr_param
*v6
;
355 union sctp_addr_param
*addr
;
356 struct sctp_adaptation_ind_param
*aind
;
357 struct sctp_supported_ext_param
*ext
;
358 struct sctp_random_param
*random
;
359 struct sctp_chunks_param
*chunks
;
360 struct sctp_hmac_algo_param
*hmac_algo
;
361 struct sctp_addip_param
*addip
;
364 /* RFC 2960. Section 3.3.5 Heartbeat.
365 * Heartbeat Information: variable length
366 * The Sender-specific Heartbeat Info field should normally include
367 * information about the sender's current time when this HEARTBEAT
368 * chunk is sent and the destination transport address to which this
369 * HEARTBEAT is sent (see Section 8.3).
371 typedef struct sctp_sender_hb_info
{
372 struct sctp_paramhdr param_hdr
;
373 union sctp_addr daddr
;
374 unsigned long sent_at
;
376 } __packed sctp_sender_hb_info_t
;
379 * RFC 2960 1.3.2 Sequenced Delivery within Streams
381 * The term "stream" is used in SCTP to refer to a sequence of user
382 * messages that are to be delivered to the upper-layer protocol in
383 * order with respect to other messages within the same stream. This is
384 * in contrast to its usage in TCP, where it refers to a sequence of
385 * bytes (in this document a byte is assumed to be eight bits).
388 * This is the structure we use to track both our outbound and inbound
389 * SSN, or Stream Sequence Numbers.
398 struct sctp_stream in
;
399 struct sctp_stream out
;
402 struct sctp_ssnmap
*sctp_ssnmap_new(__u16 in
, __u16 out
,
404 void sctp_ssnmap_free(struct sctp_ssnmap
*map
);
405 void sctp_ssnmap_clear(struct sctp_ssnmap
*map
);
407 /* What is the current SSN number for this stream? */
408 static inline __u16
sctp_ssn_peek(struct sctp_stream
*stream
, __u16 id
)
410 return stream
->ssn
[id
];
413 /* Return the next SSN number for this stream. */
414 static inline __u16
sctp_ssn_next(struct sctp_stream
*stream
, __u16 id
)
416 return stream
->ssn
[id
]++;
419 /* Skip over this ssn and all below. */
420 static inline void sctp_ssn_skip(struct sctp_stream
*stream
, __u16 id
,
423 stream
->ssn
[id
] = ssn
+1;
427 * Pointers to address related SCTP functions.
428 * (i.e. things that depend on the address family.)
431 int (*sctp_xmit
) (struct sk_buff
*skb
,
432 struct sctp_transport
*);
433 int (*setsockopt
) (struct sock
*sk
,
437 unsigned int optlen
);
438 int (*getsockopt
) (struct sock
*sk
,
443 int (*compat_setsockopt
) (struct sock
*sk
,
447 unsigned int optlen
);
448 int (*compat_getsockopt
) (struct sock
*sk
,
453 void (*get_dst
) (struct sctp_transport
*t
,
454 union sctp_addr
*saddr
,
457 void (*get_saddr
) (struct sctp_sock
*sk
,
458 struct sctp_transport
*t
,
460 void (*copy_addrlist
) (struct list_head
*,
461 struct net_device
*);
462 int (*cmp_addr
) (const union sctp_addr
*addr1
,
463 const union sctp_addr
*addr2
);
464 void (*addr_copy
) (union sctp_addr
*dst
,
465 union sctp_addr
*src
);
466 void (*from_skb
) (union sctp_addr
*,
469 void (*from_sk
) (union sctp_addr
*,
471 void (*from_addr_param
) (union sctp_addr
*,
472 union sctp_addr_param
*,
473 __be16 port
, int iif
);
474 int (*to_addr_param
) (const union sctp_addr
*,
475 union sctp_addr_param
*);
476 int (*addr_valid
) (union sctp_addr
*,
478 const struct sk_buff
*);
479 sctp_scope_t (*scope
) (union sctp_addr
*);
480 void (*inaddr_any
) (union sctp_addr
*, __be16
);
481 int (*is_any
) (const union sctp_addr
*);
482 int (*available
) (union sctp_addr
*,
484 int (*skb_iif
) (const struct sk_buff
*sk
);
485 int (*is_ce
) (const struct sk_buff
*sk
);
486 void (*seq_dump_addr
)(struct seq_file
*seq
,
487 union sctp_addr
*addr
);
488 void (*ecn_capable
)(struct sock
*sk
);
489 __u16 net_header_len
;
491 sa_family_t sa_family
;
492 struct list_head list
;
495 struct sctp_af
*sctp_get_af_specific(sa_family_t
);
496 int sctp_register_af(struct sctp_af
*);
498 /* Protocol family functions. */
500 void (*event_msgname
)(struct sctp_ulpevent
*, char *, int *);
501 void (*skb_msgname
) (struct sk_buff
*, char *, int *);
502 int (*af_supported
) (sa_family_t
, struct sctp_sock
*);
503 int (*cmp_addr
) (const union sctp_addr
*,
504 const union sctp_addr
*,
506 int (*bind_verify
) (struct sctp_sock
*, union sctp_addr
*);
507 int (*send_verify
) (struct sctp_sock
*, union sctp_addr
*);
508 int (*supported_addrs
)(const struct sctp_sock
*, __be16
*);
509 struct sock
*(*create_accept_sk
) (struct sock
*sk
,
510 struct sctp_association
*asoc
);
511 int (*addr_to_user
)(struct sctp_sock
*sk
, union sctp_addr
*addr
);
512 void (*to_sk_saddr
)(union sctp_addr
*, struct sock
*sk
);
513 void (*to_sk_daddr
)(union sctp_addr
*, struct sock
*sk
);
518 /* Structure to track chunk fragments that have been acked, but peer
519 * fragments of the same message have not.
521 struct sctp_datamsg
{
522 /* Chunks waiting to be submitted to lower layer. */
523 struct list_head chunks
;
524 /* Reference counting. */
526 /* When is this message no longer interesting to the peer? */
527 unsigned long expires_at
;
528 /* Did the messenge fail to send? */
531 can_abandon
:1, /* can chunks from this message can be abandoned. */
532 can_delay
; /* should this message be Nagle delayed */
535 struct sctp_datamsg
*sctp_datamsg_from_user(struct sctp_association
*,
536 struct sctp_sndrcvinfo
*,
538 void sctp_datamsg_free(struct sctp_datamsg
*);
539 void sctp_datamsg_put(struct sctp_datamsg
*);
540 void sctp_chunk_fail(struct sctp_chunk
*, int error
);
541 int sctp_chunk_abandoned(struct sctp_chunk
*);
543 /* RFC2960 1.4 Key Terms
545 * o Chunk: A unit of information within an SCTP packet, consisting of
546 * a chunk header and chunk-specific content.
548 * As a matter of convenience, we remember the SCTP common header for
549 * each chunk as well as a few other header pointers...
552 struct list_head list
;
556 /* This is our link to the per-transport transmitted list. */
557 struct list_head transmitted_list
;
559 /* This field is used by chunks that hold fragmented data.
560 * For the first fragment this is the list that holds the rest of
561 * fragments. For the remaining fragments, this is the link to the
562 * frag_list maintained in the first fragment.
564 struct list_head frag_list
;
566 /* This points to the sk_buff containing the actual data. */
569 /* These are the SCTP headers by reverse order in a packet.
570 * Note that some of these may happen more than once. In that
571 * case, we point at the "current" one, whatever that means
572 * for that level of header.
575 /* We point this at the FIRST TLV parameter to chunk_hdr. */
576 union sctp_params param_hdr
;
579 struct sctp_datahdr
*data_hdr
;
580 struct sctp_inithdr
*init_hdr
;
581 struct sctp_sackhdr
*sack_hdr
;
582 struct sctp_heartbeathdr
*hb_hdr
;
583 struct sctp_sender_hb_info
*hbs_hdr
;
584 struct sctp_shutdownhdr
*shutdown_hdr
;
585 struct sctp_signed_cookie
*cookie_hdr
;
586 struct sctp_ecnehdr
*ecne_hdr
;
587 struct sctp_cwrhdr
*ecn_cwr_hdr
;
588 struct sctp_errhdr
*err_hdr
;
589 struct sctp_addiphdr
*addip_hdr
;
590 struct sctp_fwdtsn_hdr
*fwdtsn_hdr
;
591 struct sctp_authhdr
*auth_hdr
;
596 struct sctp_chunkhdr
*chunk_hdr
;
597 struct sctphdr
*sctp_hdr
;
599 /* This needs to be recoverable for SCTP_SEND_FAILED events. */
600 struct sctp_sndrcvinfo sinfo
;
602 /* Which association does this belong to? */
603 struct sctp_association
*asoc
;
605 /* What endpoint received this chunk? */
606 struct sctp_ep_common
*rcvr
;
608 /* We fill this in if we are calculating RTT. */
609 unsigned long sent_at
;
611 /* What is the origin IP address for this chunk? */
612 union sctp_addr source
;
613 /* Destination address for this chunk. */
614 union sctp_addr dest
;
616 /* For outbound message, track all fragments for SEND_FAILED. */
617 struct sctp_datamsg
*msg
;
619 /* For an inbound chunk, this tells us where it came from.
620 * For an outbound chunk, it tells us where we'd like it to
621 * go. It is NULL if we have no preference.
623 struct sctp_transport
*transport
;
625 /* SCTP-AUTH: For the special case inbound processing of COOKIE-ECHO
626 * we need save a pointer to the AUTH chunk, since the SCTP-AUTH
627 * spec violates the principle premis that all chunks are processed
630 struct sk_buff
*auth_chunk
;
632 #define SCTP_CAN_FRTX 0x0
633 #define SCTP_NEED_FRTX 0x1
634 #define SCTP_DONT_FRTX 0x2
635 __u16 rtt_in_progress
:1, /* This chunk used for RTT calc? */
636 resent
:1, /* Has this chunk ever been resent. */
637 has_tsn
:1, /* Does this chunk have a TSN yet? */
638 has_ssn
:1, /* Does this chunk have a SSN yet? */
639 singleton
:1, /* Only chunk in the packet? */
640 end_of_packet
:1, /* Last chunk in the packet? */
641 ecn_ce_done
:1, /* Have we processed the ECN CE bit? */
642 pdiscard
:1, /* Discard the whole packet now? */
643 tsn_gap_acked
:1, /* Is this chunk acked by a GAP ACK? */
644 data_accepted
:1, /* At least 1 chunk accepted */
645 auth
:1, /* IN: was auth'ed | OUT: needs auth */
646 has_asconf
:1, /* IN: have seen an asconf before */
647 tsn_missing_report
:2, /* Data chunk missing counter. */
648 fast_retransmit
:2; /* Is this chunk fast retransmitted? */
651 void sctp_chunk_hold(struct sctp_chunk
*);
652 void sctp_chunk_put(struct sctp_chunk
*);
653 int sctp_user_addto_chunk(struct sctp_chunk
*chunk
, int len
,
654 struct iov_iter
*from
);
655 void sctp_chunk_free(struct sctp_chunk
*);
656 void *sctp_addto_chunk(struct sctp_chunk
*, int len
, const void *data
);
657 struct sctp_chunk
*sctp_chunkify(struct sk_buff
*,
658 const struct sctp_association
*,
660 void sctp_init_addrs(struct sctp_chunk
*, union sctp_addr
*,
662 const union sctp_addr
*sctp_source(const struct sctp_chunk
*chunk
);
665 SCTP_ADDR_NEW
, /* new address added to assoc/ep */
666 SCTP_ADDR_SRC
, /* address can be used as source */
667 SCTP_ADDR_DEL
, /* address about to be deleted */
670 /* This is a structure for holding either an IPv6 or an IPv4 address. */
671 struct sctp_sockaddr_entry
{
672 struct list_head list
;
679 #define SCTP_ADDRESS_TICK_DELAY 500
681 typedef struct sctp_chunk
*(sctp_packet_phandler_t
)(struct sctp_association
*);
683 /* This structure holds lists of chunks as we are assembling for
687 /* These are the SCTP header values (host order) for the packet. */
689 __u16 destination_port
;
692 /* This contains the payload chunks. */
693 struct list_head chunk_list
;
695 /* This is the overhead of the sctp and ip headers. */
697 /* This is the total size of all chunks INCLUDING padding. */
700 /* The packet is destined for this transport address.
701 * The function we finally use to pass down to the next lower
702 * layer lives in the transport structure.
704 struct sctp_transport
*transport
;
706 /* pointer to the auth chunk for this packet */
707 struct sctp_chunk
*auth
;
709 u8 has_cookie_echo
:1, /* This packet contains a COOKIE-ECHO chunk. */
710 has_sack
:1, /* This packet contains a SACK chunk. */
711 has_auth
:1, /* This packet contains an AUTH chunk */
712 has_data
:1, /* This packet contains at least 1 DATA chunk */
713 ipfragok
:1; /* So let ip fragment this packet */
716 struct sctp_packet
*sctp_packet_init(struct sctp_packet
*,
717 struct sctp_transport
*,
718 __u16 sport
, __u16 dport
);
719 struct sctp_packet
*sctp_packet_config(struct sctp_packet
*, __u32 vtag
, int);
720 sctp_xmit_t
sctp_packet_transmit_chunk(struct sctp_packet
*,
721 struct sctp_chunk
*, int);
722 sctp_xmit_t
sctp_packet_append_chunk(struct sctp_packet
*,
723 struct sctp_chunk
*);
724 int sctp_packet_transmit(struct sctp_packet
*);
725 void sctp_packet_free(struct sctp_packet
*);
727 static inline int sctp_packet_empty(struct sctp_packet
*packet
)
729 return packet
->size
== packet
->overhead
;
732 /* This represents a remote transport address.
733 * For local transport addresses, we just use union sctp_addr.
735 * RFC2960 Section 1.4 Key Terms
737 * o Transport address: A Transport Address is traditionally defined
738 * by Network Layer address, Transport Layer protocol and Transport
739 * Layer port number. In the case of SCTP running over IP, a
740 * transport address is defined by the combination of an IP address
741 * and an SCTP port number (where SCTP is the Transport protocol).
743 * RFC2960 Section 7.1 SCTP Differences from TCP Congestion control
745 * o The sender keeps a separate congestion control parameter set for
746 * each of the destination addresses it can send to (not each
747 * source-destination pair but for each destination). The parameters
748 * should decay if the address is not used for a long enough time
752 struct sctp_transport
{
753 /* A list of transports. */
754 struct list_head transports
;
755 struct rhash_head node
;
757 /* Reference counting. */
759 /* RTO-Pending : A flag used to track if one of the DATA
760 * chunks sent to this address is currently being
761 * used to compute a RTT. If this flag is 0,
762 * the next DATA chunk sent to this destination
763 * should be used to compute a RTT and this flag
764 * should be set. Every time the RTT
765 * calculation completes (i.e. the DATA chunk
766 * is SACK'd) clear this flag.
771 * hb_sent : a flag that signals that we have a pending
776 /* Is the Path MTU update pending on this tranport */
779 /* Has this transport moved the ctsn since we last sacked */
785 /* This is the peer's IP address and port. */
786 union sctp_addr ipaddr
;
788 /* These are the functions we call to handle LLP stuff. */
789 struct sctp_af
*af_specific
;
791 /* Which association do we belong to? */
792 struct sctp_association
*asoc
;
796 * 12.3 Per Transport Address Data
798 * For each destination transport address in the peer's
799 * address list derived from the INIT or INIT ACK chunk, a
800 * number of data elements needs to be maintained including:
802 /* RTO : The current retransmission timeout value. */
805 __u32 rtt
; /* This is the most recent RTT. */
807 /* RTTVAR : The current RTT variation. */
810 /* SRTT : The current smoothed round trip time. */
814 * These are the congestion stats.
816 /* cwnd : The current congestion window. */
817 __u32 cwnd
; /* This is the actual cwnd. */
819 /* ssthresh : The current slow start threshold value. */
822 /* partial : The tracking method for increase of cwnd when in
823 * bytes acked : congestion avoidance mode (see Section 6.2.2)
825 __u32 partial_bytes_acked
;
827 /* Data that has been sent, but not acknowledged. */
830 __u32 burst_limited
; /* Holds old cwnd when max.burst is applied */
833 struct dst_entry
*dst
;
834 /* Source address. */
835 union sctp_addr saddr
;
837 /* Heartbeat interval: The endpoint sends out a Heartbeat chunk to
838 * the destination address every heartbeat interval.
840 unsigned long hbinterval
;
842 /* SACK delay timeout */
843 unsigned long sackdelay
;
846 /* When was the last time that we heard from this transport? We use
847 * this to pick new active and retran paths.
849 ktime_t last_time_heard
;
851 /* Last time(in jiffies) when cwnd is reduced due to the congestion
852 * indication based on ECNE chunk.
854 unsigned long last_time_ecne_reduced
;
856 /* This is the max_retrans value for the transport and will
857 * be initialized from the assocs value. This can be changed
858 * using the SCTP_SET_PEER_ADDR_PARAMS socket option.
862 /* This is the partially failed retrans value for the transport
863 * and will be initialized from the assocs value. This can be changed
864 * using the SCTP_PEER_ADDR_THLDS socket option
867 /* PMTU : The current known path MTU. */
870 /* Flags controlling Heartbeat, SACK delay, and Path MTU Discovery. */
873 /* The number of times INIT has been sent on this transport. */
876 /* state : The current state of this destination,
877 * : i.e. SCTP_ACTIVE, SCTP_INACTIVE, SCTP_UNKNOWN.
881 /* These are the error stats for this destination. */
883 /* Error count : The current error count for this destination. */
884 unsigned short error_count
;
886 /* Per : A timer used by each destination.
890 * [Everywhere else in the text this is called T3-rtx. -ed]
892 struct timer_list T3_rtx_timer
;
894 /* Heartbeat timer is per destination. */
895 struct timer_list hb_timer
;
897 /* Timer to handle ICMP proto unreachable envets */
898 struct timer_list proto_unreach_timer
;
900 /* Since we're using per-destination retransmission timers
901 * (see above), we're also using per-destination "transmitted"
902 * queues. This probably ought to be a private struct
903 * accessible only within the outqueue, but it's not, yet.
905 struct list_head transmitted
;
907 /* We build bundle-able packets for this transport here. */
908 struct sctp_packet packet
;
910 /* This is the list of transports that have chunks to send. */
911 struct list_head send_ready
;
913 /* State information saved for SFR_CACC algorithm. The key
914 * idea in SFR_CACC is to maintain state at the sender on a
915 * per-destination basis when a changeover happens.
916 * char changeover_active;
917 * char cycling_changeover;
918 * __u32 next_tsn_at_change;
919 * char cacc_saw_newack;
922 /* An unsigned integer, which stores the next TSN to be
923 * used by the sender, at the moment of changeover.
925 __u32 next_tsn_at_change
;
927 /* A flag which indicates the occurrence of a changeover */
928 char changeover_active
;
930 /* A flag which indicates whether the change of primary is
931 * the first switch to this destination address during an
934 char cycling_changeover
;
936 /* A temporary flag, which is used during the processing of
937 * a SACK to estimate the causative TSN(s)'s group.
939 char cacc_saw_newack
;
942 /* 64-bit random number sent with heartbeat. */
948 struct sctp_transport
*sctp_transport_new(struct net
*, const union sctp_addr
*,
950 void sctp_transport_set_owner(struct sctp_transport
*,
951 struct sctp_association
*);
952 void sctp_transport_route(struct sctp_transport
*, union sctp_addr
*,
954 void sctp_transport_pmtu(struct sctp_transport
*, struct sock
*sk
);
955 void sctp_transport_free(struct sctp_transport
*);
956 void sctp_transport_reset_timers(struct sctp_transport
*);
957 int sctp_transport_hold(struct sctp_transport
*);
958 void sctp_transport_put(struct sctp_transport
*);
959 void sctp_transport_update_rto(struct sctp_transport
*, __u32
);
960 void sctp_transport_raise_cwnd(struct sctp_transport
*, __u32
, __u32
);
961 void sctp_transport_lower_cwnd(struct sctp_transport
*, sctp_lower_cwnd_t
);
962 void sctp_transport_burst_limited(struct sctp_transport
*);
963 void sctp_transport_burst_reset(struct sctp_transport
*);
964 unsigned long sctp_transport_timeout(struct sctp_transport
*);
965 void sctp_transport_reset(struct sctp_transport
*);
966 void sctp_transport_update_pmtu(struct sock
*, struct sctp_transport
*, u32
);
967 void sctp_transport_immediate_rtx(struct sctp_transport
*);
970 /* This is the structure we use to queue packets as they come into
971 * SCTP. We write packets to it and read chunks from it.
974 /* This is actually a queue of sctp_chunk each
975 * containing a partially decoded packet.
977 struct list_head in_chunk_list
;
978 /* This is the packet which is currently off the in queue and is
979 * being worked on through the inbound chunk processing.
981 struct sctp_chunk
*in_progress
;
983 /* This is the delayed task to finish delivering inbound
986 struct work_struct immediate
;
989 void sctp_inq_init(struct sctp_inq
*);
990 void sctp_inq_free(struct sctp_inq
*);
991 void sctp_inq_push(struct sctp_inq
*, struct sctp_chunk
*packet
);
992 struct sctp_chunk
*sctp_inq_pop(struct sctp_inq
*);
993 struct sctp_chunkhdr
*sctp_inq_peek(struct sctp_inq
*);
994 void sctp_inq_set_th_handler(struct sctp_inq
*, work_func_t
);
996 /* This is the structure we use to hold outbound chunks. You push
997 * chunks in and they automatically pop out the other end as bundled
998 * packets (it calls (*output_handler)()).
1000 * This structure covers sections 6.3, 6.4, 6.7, 6.8, 6.10, 7., 8.1,
1001 * and 8.2 of the v13 draft.
1003 * It handles retransmissions. The connection to the timeout portion
1004 * of the state machine is through sctp_..._timeout() and timeout_handler.
1006 * If you feed it SACKs, it will eat them.
1008 * If you give it big chunks, it will fragment them.
1010 * It assigns TSN's to data chunks. This happens at the last possible
1011 * instant before transmission.
1013 * When free()'d, it empties itself out via output_handler().
1016 struct sctp_association
*asoc
;
1018 /* Data pending that has never been transmitted. */
1019 struct list_head out_chunk_list
;
1021 unsigned int out_qlen
; /* Total length of queued data chunks. */
1023 /* Error of send failed, may used in SCTP_SEND_FAILED event. */
1026 /* These are control chunks we want to send. */
1027 struct list_head control_chunk_list
;
1029 /* These are chunks that have been sacked but are above the
1030 * CTSN, or cumulative tsn ack point.
1032 struct list_head sacked
;
1034 /* Put chunks on this list to schedule them for
1037 struct list_head retransmit
;
1039 /* Put chunks on this list to save them for FWD TSN processing as
1040 * they were abandoned.
1042 struct list_head abandoned
;
1044 /* How many unackd bytes do we have in-flight? */
1045 __u32 outstanding_bytes
;
1047 /* Are we doing fast-rtx on this queue */
1054 void sctp_outq_init(struct sctp_association
*, struct sctp_outq
*);
1055 void sctp_outq_teardown(struct sctp_outq
*);
1056 void sctp_outq_free(struct sctp_outq
*);
1057 int sctp_outq_tail(struct sctp_outq
*, struct sctp_chunk
*chunk
);
1058 int sctp_outq_sack(struct sctp_outq
*, struct sctp_chunk
*);
1059 int sctp_outq_is_empty(const struct sctp_outq
*);
1060 void sctp_outq_restart(struct sctp_outq
*);
1062 void sctp_retransmit(struct sctp_outq
*, struct sctp_transport
*,
1063 sctp_retransmit_reason_t
);
1064 void sctp_retransmit_mark(struct sctp_outq
*, struct sctp_transport
*, __u8
);
1065 int sctp_outq_uncork(struct sctp_outq
*);
1066 /* Uncork and flush an outqueue. */
1067 static inline void sctp_outq_cork(struct sctp_outq
*q
)
1072 /* These bind address data fields common between endpoints and associations */
1073 struct sctp_bind_addr
{
1075 /* RFC 2960 12.1 Parameters necessary for the SCTP instance
1077 * SCTP Port: The local SCTP port number the endpoint is
1082 /* RFC 2960 12.1 Parameters necessary for the SCTP instance
1084 * Address List: The list of IP addresses that this instance
1085 * has bound. This information is passed to one's
1086 * peer(s) in INIT and INIT ACK chunks.
1088 struct list_head address_list
;
1091 void sctp_bind_addr_init(struct sctp_bind_addr
*, __u16 port
);
1092 void sctp_bind_addr_free(struct sctp_bind_addr
*);
1093 int sctp_bind_addr_copy(struct net
*net
, struct sctp_bind_addr
*dest
,
1094 const struct sctp_bind_addr
*src
,
1095 sctp_scope_t scope
, gfp_t gfp
,
1097 int sctp_bind_addr_dup(struct sctp_bind_addr
*dest
,
1098 const struct sctp_bind_addr
*src
,
1100 int sctp_add_bind_addr(struct sctp_bind_addr
*, union sctp_addr
*,
1101 __u8 addr_state
, gfp_t gfp
);
1102 int sctp_del_bind_addr(struct sctp_bind_addr
*, union sctp_addr
*);
1103 int sctp_bind_addr_match(struct sctp_bind_addr
*, const union sctp_addr
*,
1104 struct sctp_sock
*);
1105 int sctp_bind_addr_conflict(struct sctp_bind_addr
*, const union sctp_addr
*,
1106 struct sctp_sock
*, struct sctp_sock
*);
1107 int sctp_bind_addr_state(const struct sctp_bind_addr
*bp
,
1108 const union sctp_addr
*addr
);
1109 union sctp_addr
*sctp_find_unmatch_addr(struct sctp_bind_addr
*bp
,
1110 const union sctp_addr
*addrs
,
1112 struct sctp_sock
*opt
);
1113 union sctp_params
sctp_bind_addrs_to_raw(const struct sctp_bind_addr
*bp
,
1116 int sctp_raw_to_bind_addrs(struct sctp_bind_addr
*bp
, __u8
*raw
, int len
,
1117 __u16 port
, gfp_t gfp
);
1119 sctp_scope_t
sctp_scope(const union sctp_addr
*);
1120 int sctp_in_scope(struct net
*net
, const union sctp_addr
*addr
, const sctp_scope_t scope
);
1121 int sctp_is_any(struct sock
*sk
, const union sctp_addr
*addr
);
1122 int sctp_is_ep_boundall(struct sock
*sk
);
1125 /* What type of endpoint? */
1127 SCTP_EP_TYPE_SOCKET
,
1128 SCTP_EP_TYPE_ASSOCIATION
,
1129 } sctp_endpoint_type_t
;
1132 * A common base class to bridge the implmentation view of a
1133 * socket (usually listening) endpoint versus an association's
1135 * This common structure is useful for several purposes:
1136 * 1) Common interface for lookup routines.
1137 * a) Subfunctions work for either endpoint or association
1138 * b) Single interface to lookup allows hiding the lookup lock rather
1139 * than acquiring it externally.
1140 * 2) Common interface for the inbound chunk handling/state machine.
1141 * 3) Common object handling routines for reference counting, etc.
1142 * 4) Disentangle association lookup from endpoint lookup, where we
1143 * do not have to find our endpoint to find our association.
1147 struct sctp_ep_common
{
1148 /* Fields to help us manage our entries in the hash tables. */
1149 struct hlist_node node
;
1152 /* Runtime type information. What kind of endpoint is this? */
1153 sctp_endpoint_type_t type
;
1155 /* Some fields to help us manage this object.
1156 * refcnt - Reference count access to this object.
1157 * dead - Do not attempt to use this object.
1162 /* What socket does this endpoint belong to? */
1165 /* This is where we receive inbound chunks. */
1166 struct sctp_inq inqueue
;
1168 /* This substructure includes the defining parameters of the
1170 * bind_addr.port is our shared port number.
1171 * bind_addr.address_list is our set of local IP addresses.
1173 struct sctp_bind_addr bind_addr
;
1177 /* RFC Section 1.4 Key Terms
1179 * o SCTP endpoint: The logical sender/receiver of SCTP packets. On a
1180 * multi-homed host, an SCTP endpoint is represented to its peers as a
1181 * combination of a set of eligible destination transport addresses to
1182 * which SCTP packets can be sent and a set of eligible source
1183 * transport addresses from which SCTP packets can be received.
1184 * All transport addresses used by an SCTP endpoint must use the
1185 * same port number, but can use multiple IP addresses. A transport
1186 * address used by an SCTP endpoint must not be used by another
1187 * SCTP endpoint. In other words, a transport address is unique
1188 * to an SCTP endpoint.
1190 * From an implementation perspective, each socket has one of these.
1191 * A TCP-style socket will have exactly one association on one of
1192 * these. An UDP-style socket will have multiple associations hanging
1196 struct sctp_endpoint
{
1197 /* Common substructure for endpoint and association. */
1198 struct sctp_ep_common base
;
1200 /* Associations: A list of current associations and mappings
1201 * to the data consumers for each association. This
1202 * may be in the form of a hash table or other
1203 * implementation dependent structure. The data
1204 * consumers may be process identification
1205 * information such as file descriptors, named pipe
1206 * pointer, or table pointers dependent on how SCTP
1209 /* This is really a list of struct sctp_association entries. */
1210 struct list_head asocs
;
1212 /* Secret Key: A secret key used by this endpoint to compute
1213 * the MAC. This SHOULD be a cryptographic quality
1214 * random number with a sufficient length.
1215 * Discussion in [RFC1750] can be helpful in
1216 * selection of the key.
1218 __u8 secret_key
[SCTP_SECRET_SIZE
];
1220 /* digest: This is a digest of the sctp cookie. This field is
1221 * only used on the receive path when we try to validate
1222 * that the cookie has not been tampered with. We put
1223 * this here so we pre-allocate this once and can re-use
1228 /* sendbuf acct. policy. */
1229 __u32 sndbuf_policy
;
1231 /* rcvbuf acct. policy. */
1232 __u32 rcvbuf_policy
;
1234 /* SCTP AUTH: array of the HMACs that will be allocated
1235 * we need this per association so that we don't serialize
1237 struct crypto_hash
**auth_hmacs
;
1239 /* SCTP-AUTH: hmacs for the endpoint encoded into parameter */
1240 struct sctp_hmac_algo_param
*auth_hmacs_list
;
1242 /* SCTP-AUTH: chunks to authenticate encoded into parameter */
1243 struct sctp_chunks_param
*auth_chunk_list
;
1245 /* SCTP-AUTH: endpoint shared keys */
1246 struct list_head endpoint_shared_keys
;
1247 __u16 active_key_id
;
1251 /* Recover the outter endpoint structure. */
1252 static inline struct sctp_endpoint
*sctp_ep(struct sctp_ep_common
*base
)
1254 struct sctp_endpoint
*ep
;
1256 ep
= container_of(base
, struct sctp_endpoint
, base
);
1260 /* These are function signatures for manipulating endpoints. */
1261 struct sctp_endpoint
*sctp_endpoint_new(struct sock
*, gfp_t
);
1262 void sctp_endpoint_free(struct sctp_endpoint
*);
1263 void sctp_endpoint_put(struct sctp_endpoint
*);
1264 void sctp_endpoint_hold(struct sctp_endpoint
*);
1265 void sctp_endpoint_add_asoc(struct sctp_endpoint
*, struct sctp_association
*);
1266 struct sctp_association
*sctp_endpoint_lookup_assoc(
1267 const struct sctp_endpoint
*ep
,
1268 const union sctp_addr
*paddr
,
1269 struct sctp_transport
**);
1270 int sctp_endpoint_is_peeled_off(struct sctp_endpoint
*,
1271 const union sctp_addr
*);
1272 struct sctp_endpoint
*sctp_endpoint_is_match(struct sctp_endpoint
*,
1273 struct net
*, const union sctp_addr
*);
1274 int sctp_has_association(struct net
*net
, const union sctp_addr
*laddr
,
1275 const union sctp_addr
*paddr
);
1277 int sctp_verify_init(struct net
*net
, const struct sctp_endpoint
*ep
,
1278 const struct sctp_association
*asoc
,
1279 sctp_cid_t
, sctp_init_chunk_t
*peer_init
,
1280 struct sctp_chunk
*chunk
, struct sctp_chunk
**err_chunk
);
1281 int sctp_process_init(struct sctp_association
*, struct sctp_chunk
*chunk
,
1282 const union sctp_addr
*peer
,
1283 sctp_init_chunk_t
*init
, gfp_t gfp
);
1284 __u32
sctp_generate_tag(const struct sctp_endpoint
*);
1285 __u32
sctp_generate_tsn(const struct sctp_endpoint
*);
1287 struct sctp_inithdr_host
{
1290 __u16 num_outbound_streams
;
1291 __u16 num_inbound_streams
;
1295 /* SCTP_GET_ASSOC_STATS counters */
1296 struct sctp_priv_assoc_stats
{
1297 /* Maximum observed rto in the association during subsequent
1298 * observations. Value is set to 0 if no RTO measurement took place
1299 * The transport where the max_rto was observed is returned in
1302 struct sockaddr_storage obs_rto_ipaddr
;
1304 /* Total In and Out SACKs received and sent */
1307 /* Total In and Out packets received and sent */
1310 /* Total retransmitted chunks */
1312 /* TSN received > next expected */
1314 /* Duplicate Chunks received */
1316 /* Gap Ack Blocks received */
1318 /* Unordered data chunks sent and received */
1321 /* Ordered data chunks sent and received */
1324 /* Control chunks sent and received */
1331 * 12. Recommended Transmission Control Block (TCB) Parameters
1333 * This section details a recommended set of parameters that should
1334 * be contained within the TCB for an implementation. This section is
1335 * for illustrative purposes and should not be deemed as requirements
1336 * on an implementation or as an exhaustive list of all parameters
1337 * inside an SCTP TCB. Each implementation may need its own additional
1338 * parameters for optimization.
1342 /* Here we have information about each individual association. */
1343 struct sctp_association
{
1345 /* A base structure common to endpoint and association.
1346 * In this context, it represents the associations's view
1347 * of the local endpoint of the association.
1349 struct sctp_ep_common base
;
1351 /* Associations on the same socket. */
1352 struct list_head asocs
;
1354 /* association id. */
1355 sctp_assoc_t assoc_id
;
1357 /* This is our parent endpoint. */
1358 struct sctp_endpoint
*ep
;
1360 /* These are those association elements needed in the cookie. */
1361 struct sctp_cookie c
;
1363 /* This is all information about our peer. */
1365 /* transport_addr_list
1367 * Peer : A list of SCTP transport addresses that the
1368 * Transport : peer is bound to. This information is derived
1369 * Address : from the INIT or INIT ACK and is used to
1370 * List : associate an inbound packet with a given
1371 * : association. Normally this information is
1372 * : hashed or keyed for quick lookup and access
1374 * : The list is also initialized with the list
1375 * : of addresses passed with the sctp_connectx()
1378 * It is a list of SCTP_transport's.
1380 struct list_head transport_addr_list
;
1384 * Peer Rwnd : Current calculated value of the peer's rwnd.
1390 * Peer : A count of the number of peer addresses
1391 * Transport : in the Peer Transport Address List.
1395 __u16 transport_count
;
1398 * The transport layer port number.
1404 * Primary : This is the current primary destination
1405 * Path : transport address of the peer endpoint. It
1406 * : may also specify a source transport address
1407 * : on this endpoint.
1409 * All of these paths live on transport_addr_list.
1411 * At the bakeoffs, we discovered that the intent of
1412 * primaryPath is that it only changes when the ULP
1413 * asks to have it changed. We add the activePath to
1414 * designate the connection we are currently using to
1415 * transmit new data and most control chunks.
1417 struct sctp_transport
*primary_path
;
1419 /* Cache the primary path address here, when we
1420 * need a an address for msg_name.
1422 union sctp_addr primary_addr
;
1425 * The path that we are currently using to
1426 * transmit new data and most control chunks.
1428 struct sctp_transport
*active_path
;
1432 * RFC2960 6.4 Multi-homed SCTP Endpoints
1434 * Furthermore, when its peer is multi-homed, an
1435 * endpoint SHOULD try to retransmit a chunk to an
1436 * active destination transport address that is
1437 * different from the last destination address to
1438 * which the DATA chunk was sent.
1440 struct sctp_transport
*retran_path
;
1442 /* Pointer to last transport I have sent on. */
1443 struct sctp_transport
*last_sent_to
;
1445 /* This is the last transport I have received DATA on. */
1446 struct sctp_transport
*last_data_from
;
1449 * Mapping An array of bits or bytes indicating which out of
1450 * Array order TSN's have been received (relative to the
1451 * Last Rcvd TSN). If no gaps exist, i.e. no out of
1452 * order packets have been received, this array
1453 * will be set to all zero. This structure may be
1454 * in the form of a circular buffer or bit array.
1456 * Last Rcvd : This is the last TSN received in
1457 * TSN : sequence. This value is set initially by
1458 * : taking the peer's Initial TSN, received in
1459 * : the INIT or INIT ACK chunk, and subtracting
1462 * Throughout most of the specification this is called the
1463 * "Cumulative TSN ACK Point". In this case, we
1464 * ignore the advice in 12.2 in favour of the term
1465 * used in the bulk of the text. This value is hidden
1466 * in tsn_map--we get it by calling sctp_tsnmap_get_ctsn().
1468 struct sctp_tsnmap tsn_map
;
1470 /* This mask is used to disable sending the ASCONF chunk
1471 * with specified parameter to peer.
1473 __be16 addip_disabled_mask
;
1475 /* These are capabilities which our peer advertised. */
1476 __u8 ecn_capable
:1, /* Can peer do ECN? */
1477 ipv4_address
:1, /* Peer understands IPv4 addresses? */
1478 ipv6_address
:1, /* Peer understands IPv6 addresses? */
1479 hostname_address
:1, /* Peer understands DNS addresses? */
1480 asconf_capable
:1, /* Does peer support ADDIP? */
1481 prsctp_capable
:1, /* Can peer do PR-SCTP? */
1482 auth_capable
:1; /* Is peer doing SCTP-AUTH? */
1484 /* sack_needed : This flag indicates if the next received
1485 * : packet is to be responded to with a
1486 * : SACK. This is initialized to 0. When a packet
1487 * : is received sack_cnt is incremented. If this value
1488 * : reaches 2 or more, a SACK is sent and the
1489 * : value is reset to 0. Note: This is used only
1490 * : when no DATA chunks are received out of
1491 * : order. When DATA chunks are out of order,
1492 * : SACK's are not delayed (see Section 6).
1494 __u8 sack_needed
:1, /* Do we need to sack the peer? */
1496 zero_window_announced
:1;
1499 __u32 adaptation_ind
; /* Adaptation Code point. */
1501 struct sctp_inithdr_host i
;
1505 /* ADDIP Section 4.2 Upon reception of an ASCONF Chunk.
1506 * C1) ... "Peer-Serial-Number'. This value MUST be initialized to the
1507 * Initial TSN Value minus 1
1511 /* SCTP-AUTH: We need to know pears random number, hmac list
1512 * and authenticated chunk list. All that is part of the
1513 * cookie and these are just pointers to those locations
1515 sctp_random_param_t
*peer_random
;
1516 sctp_chunks_param_t
*peer_chunks
;
1517 sctp_hmac_algo_param_t
*peer_hmacs
;
1520 /* State : A state variable indicating what state the
1521 * : association is in, i.e. COOKIE-WAIT,
1522 * : COOKIE-ECHOED, ESTABLISHED, SHUTDOWN-PENDING,
1523 * : SHUTDOWN-SENT, SHUTDOWN-RECEIVED, SHUTDOWN-ACK-SENT.
1525 * Note: No "CLOSED" state is illustrated since if a
1526 * association is "CLOSED" its TCB SHOULD be removed.
1528 * In this implementation we DO have a CLOSED
1529 * state which is used during initiation and shutdown.
1531 * State takes values from SCTP_STATE_*.
1535 /* Overall : The overall association error count.
1536 * Error Count : [Clear this any time I get something.]
1538 int overall_error_count
;
1540 /* The cookie life I award for any cookie. */
1541 ktime_t cookie_life
;
1543 /* These are the association's initial, max, and min RTO values.
1544 * These values will be initialized by system defaults, but can
1545 * be modified via the SCTP_RTOINFO socket option.
1547 unsigned long rto_initial
;
1548 unsigned long rto_max
;
1549 unsigned long rto_min
;
1551 /* Maximum number of new data packets that can be sent in a burst. */
1554 /* This is the max_retrans value for the association. This value will
1555 * be initialized initialized from system defaults, but can be
1556 * modified by the SCTP_ASSOCINFO socket option.
1560 /* This is the partially failed retrans value for the transport
1561 * and will be initialized from the assocs value. This can be
1562 * changed using the SCTP_PEER_ADDR_THLDS socket option
1566 /* Maximum number of times the endpoint will retransmit INIT */
1567 __u16 max_init_attempts
;
1569 /* How many times have we resent an INIT? */
1572 /* The largest timeout or RTO value to use in attempting an INIT */
1573 unsigned long max_init_timeo
;
1575 /* Heartbeat interval: The endpoint sends out a Heartbeat chunk to
1576 * the destination address every heartbeat interval. This value
1577 * will be inherited by all new transports.
1579 unsigned long hbinterval
;
1581 /* This is the max_retrans value for new transports in the
1586 /* Flag that path mtu update is pending */
1589 /* Association : The smallest PMTU discovered for all of the
1590 * PMTU : peer's transport addresses.
1594 /* Flags controlling Heartbeat, SACK delay, and Path MTU Discovery. */
1598 /* SACK delay timeout */
1599 unsigned long sackdelay
;
1601 unsigned long timeouts
[SCTP_NUM_TIMEOUT_TYPES
];
1602 struct timer_list timers
[SCTP_NUM_TIMEOUT_TYPES
];
1604 /* Transport to which SHUTDOWN chunk was last sent. */
1605 struct sctp_transport
*shutdown_last_sent_to
;
1607 /* Transport to which INIT chunk was last sent. */
1608 struct sctp_transport
*init_last_sent_to
;
1610 /* How many times have we resent a SHUTDOWN */
1611 int shutdown_retries
;
1613 /* Next TSN : The next TSN number to be assigned to a new
1614 * : DATA chunk. This is sent in the INIT or INIT
1615 * : ACK chunk to the peer and incremented each
1616 * : time a DATA chunk is assigned a TSN
1617 * : (normally just prior to transmit or during
1623 * Last Rcvd : This is the last TSN received in sequence. This value
1624 * TSN : is set initially by taking the peer's Initial TSN,
1625 * : received in the INIT or INIT ACK chunk, and
1626 * : subtracting one from it.
1628 * Most of RFC 2960 refers to this as the Cumulative TSN Ack Point.
1631 __u32 ctsn_ack_point
;
1633 /* PR-SCTP Advanced.Peer.Ack.Point */
1634 __u32 adv_peer_ack_point
;
1636 /* Highest TSN that is acknowledged by incoming SACKs. */
1637 __u32 highest_sacked
;
1639 /* TSN marking the fast recovery exit point */
1640 __u32 fast_recovery_exit
;
1642 /* Flag to track the current fast recovery state */
1645 /* The number of unacknowledged data chunks. Reported through
1646 * the SCTP_STATUS sockopt.
1650 /* The total number of data chunks that we've had to retransmit
1651 * as the result of a T3 timer expiration
1653 __u32 rtx_data_chunks
;
1655 /* This is the association's receive buffer space. This value is used
1656 * to set a_rwnd field in an INIT or a SACK chunk.
1660 /* This is the last advertised value of rwnd over a SACK chunk. */
1663 /* Number of bytes by which the rwnd has slopped. The rwnd is allowed
1664 * to slop over a maximum of the association's frag_point.
1668 /* Keeps treack of rwnd pressure. This happens when we have
1669 * a window, but not recevie buffer (i.e small packets). This one
1670 * is releases slowly (1 PMTU at a time ).
1674 /* This is the sndbuf size in use for the association.
1675 * This corresponds to the sndbuf size for the association,
1676 * as specified in the sk->sndbuf.
1680 /* This is the amount of memory that this association has allocated
1681 * in the receive path at any given time.
1683 atomic_t rmem_alloc
;
1685 /* This is the wait queue head for send requests waiting on
1686 * the association sndbuf space.
1688 wait_queue_head_t wait
;
1690 /* The message size at which SCTP fragmentation will occur. */
1694 /* Counter used to count INIT errors. */
1695 int init_err_counter
;
1697 /* Count the number of INIT cycles (for doubling timeout). */
1700 /* Default send parameters. */
1701 __u16 default_stream
;
1702 __u16 default_flags
;
1704 __u32 default_context
;
1705 __u32 default_timetolive
;
1707 /* Default receive parameters */
1708 __u32 default_rcv_context
;
1710 /* This tracks outbound ssn for a given stream. */
1711 struct sctp_ssnmap
*ssnmap
;
1713 /* All outbound chunks go through this structure. */
1714 struct sctp_outq outqueue
;
1716 /* A smart pipe that will handle reordering and fragmentation,
1717 * as well as handle passing events up to the ULP.
1719 struct sctp_ulpq ulpq
;
1721 /* Last TSN that caused an ECNE Chunk to be sent. */
1722 __u32 last_ecne_tsn
;
1724 /* Last TSN that caused a CWR Chunk to be sent. */
1727 /* How many duplicated TSNs have we seen? */
1730 /* These are to support
1731 * "SCTP Extensions for Dynamic Reconfiguration of IP Addresses
1732 * and Enforcement of Flow and Message Limits"
1733 * <draft-ietf-tsvwg-addip-sctp-02.txt>
1734 * or "ADDIP" for short.
1739 /* ADDIP Section 4.1.1 Congestion Control of ASCONF Chunks
1741 * R1) One and only one ASCONF Chunk MAY be in transit and
1742 * unacknowledged at any one time. If a sender, after sending
1743 * an ASCONF chunk, decides it needs to transfer another
1744 * ASCONF Chunk, it MUST wait until the ASCONF-ACK Chunk
1745 * returns from the previous ASCONF Chunk before sending a
1746 * subsequent ASCONF. Note this restriction binds each side,
1747 * so at any time two ASCONF may be in-transit on any given
1748 * association (one sent from each endpoint).
1750 * [This is our one-and-only-one ASCONF in flight. If we do
1751 * not have an ASCONF in flight, this is NULL.]
1753 struct sctp_chunk
*addip_last_asconf
;
1755 /* ADDIP Section 5.2 Upon reception of an ASCONF Chunk.
1757 * This is needed to implement itmes E1 - E4 of the updated
1758 * spec. Here is the justification:
1760 * Since the peer may bundle multiple ASCONF chunks toward us,
1761 * we now need the ability to cache multiple ACKs. The section
1762 * describes in detail how they are cached and cleaned up.
1764 struct list_head asconf_ack_list
;
1766 /* These ASCONF chunks are waiting to be sent.
1768 * These chunaks can't be pushed to outqueue until receiving
1769 * ASCONF_ACK for the previous ASCONF indicated by
1770 * addip_last_asconf, so as to guarantee that only one ASCONF
1771 * is in flight at any time.
1773 * ADDIP Section 4.1.1 Congestion Control of ASCONF Chunks
1775 * In defining the ASCONF Chunk transfer procedures, it is
1776 * essential that these transfers MUST NOT cause congestion
1777 * within the network. To achieve this, we place these
1778 * restrictions on the transfer of ASCONF Chunks:
1780 * R1) One and only one ASCONF Chunk MAY be in transit and
1781 * unacknowledged at any one time. If a sender, after sending
1782 * an ASCONF chunk, decides it needs to transfer another
1783 * ASCONF Chunk, it MUST wait until the ASCONF-ACK Chunk
1784 * returns from the previous ASCONF Chunk before sending a
1785 * subsequent ASCONF. Note this restriction binds each side,
1786 * so at any time two ASCONF may be in-transit on any given
1787 * association (one sent from each endpoint).
1790 * [I really think this is EXACTLY the sort of intelligence
1791 * which already resides in sctp_outq. Please move this
1792 * queue and its supporting logic down there. --piggy]
1794 struct list_head addip_chunk_list
;
1796 /* ADDIP Section 4.1 ASCONF Chunk Procedures
1798 * A2) A serial number should be assigned to the Chunk. The
1799 * serial number SHOULD be a monotonically increasing
1800 * number. The serial number SHOULD be initialized at
1801 * the start of the association to the same value as the
1802 * Initial TSN and every time a new ASCONF chunk is created
1803 * it is incremented by one after assigning the serial number
1804 * to the newly created chunk.
1807 * 3.1.1 Address/Stream Configuration Change Chunk (ASCONF)
1809 * Serial Number : 32 bits (unsigned integer)
1811 * This value represents a Serial Number for the ASCONF
1812 * Chunk. The valid range of Serial Number is from 0 to
1813 * 4294967295 (2^32 - 1). Serial Numbers wrap back to 0
1814 * after reaching 4294967295.
1817 int src_out_of_asoc_ok
;
1818 union sctp_addr
*asconf_addr_del_pending
;
1819 struct sctp_transport
*new_transport
;
1821 /* SCTP AUTH: list of the endpoint shared keys. These
1822 * keys are provided out of band by the user applicaton
1823 * and can't change during the lifetime of the association
1825 struct list_head endpoint_shared_keys
;
1828 * The current generated assocaition shared key (secret)
1830 struct sctp_auth_bytes
*asoc_shared_key
;
1832 /* SCTP AUTH: hmac id of the first peer requested algorithm
1835 __u16 default_hmac_id
;
1837 __u16 active_key_id
;
1839 __u8 need_ecne
:1, /* Need to send an ECNE Chunk? */
1840 temp
:1; /* Is it a temporary association? */
1842 struct sctp_priv_assoc_stats stats
;
1846 /* An eyecatcher for determining if we are really looking at an
1847 * association data structure.
1850 SCTP_ASSOC_EYECATCHER
= 0xa550c123,
1853 /* Recover the outter association structure. */
1854 static inline struct sctp_association
*sctp_assoc(struct sctp_ep_common
*base
)
1856 struct sctp_association
*asoc
;
1858 asoc
= container_of(base
, struct sctp_association
, base
);
1862 /* These are function signatures for manipulating associations. */
1865 struct sctp_association
*
1866 sctp_association_new(const struct sctp_endpoint
*, const struct sock
*,
1867 sctp_scope_t scope
, gfp_t gfp
);
1868 void sctp_association_free(struct sctp_association
*);
1869 void sctp_association_put(struct sctp_association
*);
1870 void sctp_association_hold(struct sctp_association
*);
1872 struct sctp_transport
*sctp_assoc_choose_alter_transport(
1873 struct sctp_association
*, struct sctp_transport
*);
1874 void sctp_assoc_update_retran_path(struct sctp_association
*);
1875 struct sctp_transport
*sctp_assoc_lookup_paddr(const struct sctp_association
*,
1876 const union sctp_addr
*);
1877 int sctp_assoc_lookup_laddr(struct sctp_association
*asoc
,
1878 const union sctp_addr
*laddr
);
1879 struct sctp_transport
*sctp_assoc_add_peer(struct sctp_association
*,
1880 const union sctp_addr
*address
,
1882 const int peer_state
);
1883 void sctp_assoc_del_peer(struct sctp_association
*asoc
,
1884 const union sctp_addr
*addr
);
1885 void sctp_assoc_rm_peer(struct sctp_association
*asoc
,
1886 struct sctp_transport
*peer
);
1887 void sctp_assoc_control_transport(struct sctp_association
*,
1888 struct sctp_transport
*,
1889 sctp_transport_cmd_t
, sctp_sn_error_t
);
1890 struct sctp_transport
*sctp_assoc_lookup_tsn(struct sctp_association
*, __u32
);
1891 struct sctp_transport
*sctp_assoc_is_match(struct sctp_association
*,
1893 const union sctp_addr
*,
1894 const union sctp_addr
*);
1895 void sctp_assoc_migrate(struct sctp_association
*, struct sock
*);
1896 void sctp_assoc_update(struct sctp_association
*old
,
1897 struct sctp_association
*new);
1899 __u32
sctp_association_get_next_tsn(struct sctp_association
*);
1901 void sctp_assoc_sync_pmtu(struct sock
*, struct sctp_association
*);
1902 void sctp_assoc_rwnd_increase(struct sctp_association
*, unsigned int);
1903 void sctp_assoc_rwnd_decrease(struct sctp_association
*, unsigned int);
1904 void sctp_assoc_set_primary(struct sctp_association
*,
1905 struct sctp_transport
*);
1906 void sctp_assoc_del_nonprimary_peers(struct sctp_association
*,
1907 struct sctp_transport
*);
1908 int sctp_assoc_set_bind_addr_from_ep(struct sctp_association
*,
1909 sctp_scope_t
, gfp_t
);
1910 int sctp_assoc_set_bind_addr_from_cookie(struct sctp_association
*,
1911 struct sctp_cookie
*,
1913 int sctp_assoc_set_id(struct sctp_association
*, gfp_t
);
1914 void sctp_assoc_clean_asconf_ack_cache(const struct sctp_association
*asoc
);
1915 struct sctp_chunk
*sctp_assoc_lookup_asconf_ack(
1916 const struct sctp_association
*asoc
,
1918 void sctp_asconf_queue_teardown(struct sctp_association
*asoc
);
1920 int sctp_cmp_addr_exact(const union sctp_addr
*ss1
,
1921 const union sctp_addr
*ss2
);
1922 struct sctp_chunk
*sctp_get_ecne_prepend(struct sctp_association
*asoc
);
1924 /* A convenience structure to parse out SCTP specific CMSGs. */
1925 typedef struct sctp_cmsgs
{
1926 struct sctp_initmsg
*init
;
1927 struct sctp_sndrcvinfo
*srinfo
;
1928 struct sctp_sndinfo
*sinfo
;
1931 /* Structure for tracking memory objects */
1935 } sctp_dbg_objcnt_entry_t
;
1937 #endif /* __sctp_structs_h__ */